[media] saa7164: allow variable length GOP sizes and switch encoder default to CBR
[linux-2.6-block.git] / drivers / media / video / saa7164 / saa7164.h
CommitLineData
443c1228
ST
1/*
2 * Driver for the NXP SAA7164 PCIe bridge
3 *
9b8b0199 4 * Copyright (c) 2010 Steven Toth <stoth@kernellabs.com>
443c1228
ST
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 *
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22/*
23 Driver architecture
24 *******************
25
26 saa7164_core.c/buffer.c/cards.c/i2c.c/dvb.c
27 | : Standard Linux driver framework for creating
28 | : exposing and managing interfaces to the rest
29 | : of the kernel or userland. Also uses _fw.c to load
30 | : firmware direct into the PCIe bus, bypassing layers.
31 V
32 saa7164_api..() : Translate kernel specific functions/features
33 | : into command buffers.
34 V
35 saa7164_cmd..() : Manages the flow of command packets on/off,
36 | : the bus. Deal with bus errors, timeouts etc.
37 V
38 saa7164_bus..() : Manage a read/write memory ring buffer in the
39 | : PCIe Address space.
40 |
41 | saa7164_fw...() : Load any frimware
42 | | : direct into the device
43 V V
44 <- ----------------- PCIe address space -------------------- ->
45*/
46
47#include <linux/pci.h>
48#include <linux/i2c.h>
49#include <linux/i2c-algo-bit.h>
50#include <linux/kdev_t.h>
7615e434
ST
51#include <linux/version.h>
52#include <linux/mutex.h>
443c1228
ST
53
54#include <media/tuner.h>
55#include <media/tveeprom.h>
56#include <media/videobuf-dma-sg.h>
57#include <media/videobuf-dvb.h>
7615e434
ST
58#include <linux/smp_lock.h>
59#include <dvb_demux.h>
60#include <dvb_frontend.h>
61#include <dvb_net.h>
62#include <dvbdev.h>
63#include <dmxdev.h>
64#include <media/v4l2-common.h>
65#include <media/v4l2-ioctl.h>
66#include <media/v4l2-chip-ident.h>
443c1228
ST
67
68#include "saa7164-reg.h"
69#include "saa7164-types.h"
70
443c1228
ST
71#define SAA7164_MAXBOARDS 8
72
73#define UNSET (-1U)
74#define SAA7164_BOARD_NOAUTO UNSET
75#define SAA7164_BOARD_UNKNOWN 0
76#define SAA7164_BOARD_UNKNOWN_REV2 1
77#define SAA7164_BOARD_UNKNOWN_REV3 2
78#define SAA7164_BOARD_HAUPPAUGE_HVR2250 3
79#define SAA7164_BOARD_HAUPPAUGE_HVR2200 4
80#define SAA7164_BOARD_HAUPPAUGE_HVR2200_2 5
81#define SAA7164_BOARD_HAUPPAUGE_HVR2200_3 6
82#define SAA7164_BOARD_HAUPPAUGE_HVR2250_2 7
e3335222 83#define SAA7164_BOARD_HAUPPAUGE_HVR2250_3 8
443c1228
ST
84
85#define SAA7164_MAX_UNITS 8
86#define SAA7164_TS_NUMBER_OF_LINES 312
87#define SAA7164_PT_ENTRIES 16 /* (312 * 188) / 4096 */
7615e434
ST
88#define SAA7164_MAX_ENCODER_BUFFERS 16
89
90/* Port related defines */
91#define SAA7164_PORT_TS1 (0)
92#define SAA7164_PORT_TS2 (SAA7164_PORT_TS1 + 1)
93#define SAA7164_PORT_ENC1 (SAA7164_PORT_TS2 + 1)
94#define SAA7164_PORT_ENC2 (SAA7164_PORT_ENC1 + 1)
95#define SAA7164_MAX_PORTS (SAA7164_PORT_ENC2 + 1)
443c1228
ST
96
97#define DBGLVL_FW 4
98#define DBGLVL_DVB 8
99#define DBGLVL_I2C 16
100#define DBGLVL_API 32
101#define DBGLVL_CMD 64
102#define DBGLVL_BUS 128
103#define DBGLVL_IRQ 256
104#define DBGLVL_BUF 512
9b8b0199 105#define DBGLVL_ENC 1024
443c1228 106
7615e434
ST
107#define SAA7164_NORMS ( V4L2_STD_NTSC_M | V4L2_STD_NTSC_M_JP | V4L2_STD_NTSC_443 )
108
443c1228
ST
109enum port_t {
110 SAA7164_MPEG_UNDEFINED = 0,
111 SAA7164_MPEG_DVB,
add3f580 112 SAA7164_MPEG_ENCODER,
443c1228
ST
113};
114
115enum saa7164_i2c_bus_nr {
116 SAA7164_I2C_BUS_0 = 0,
117 SAA7164_I2C_BUS_1,
118 SAA7164_I2C_BUS_2,
119};
120
121enum saa7164_buffer_flags {
122 SAA7164_BUFFER_UNDEFINED = 0,
123 SAA7164_BUFFER_FREE,
124 SAA7164_BUFFER_BUSY,
125 SAA7164_BUFFER_FULL
126};
127
128enum saa7164_unit_type {
129 SAA7164_UNIT_UNDEFINED = 0,
130 SAA7164_UNIT_DIGITAL_DEMODULATOR,
131 SAA7164_UNIT_ANALOG_DEMODULATOR,
132 SAA7164_UNIT_TUNER,
133 SAA7164_UNIT_EEPROM,
134 SAA7164_UNIT_ZILOG_IRBLASTER,
135 SAA7164_UNIT_ENCODER,
136};
137
138/* The PCIe bridge doesn't grant direct access to i2c.
139 * Instead, you address i2c devices using a uniqely
140 * allocated 'unitid' value via a messaging API. This
141 * is a problem. The kernel and existing demod/tuner
142 * drivers expect to talk 'i2c', so we have to maintain
143 * a translation layer, and a series of functions to
144 * convert i2c bus + device address into a unit id.
145 */
146struct saa7164_unit {
147 enum saa7164_unit_type type;
148 u8 id;
149 char *name;
150 enum saa7164_i2c_bus_nr i2c_bus_nr;
151 u8 i2c_bus_addr;
152 u8 i2c_reg_len;
153};
154
155struct saa7164_board {
156 char *name;
7615e434 157 enum port_t porta, portb, portc, portd;
443c1228
ST
158 enum {
159 SAA7164_CHIP_UNDEFINED = 0,
160 SAA7164_CHIP_REV2,
161 SAA7164_CHIP_REV3,
162 } chiprev;
163 struct saa7164_unit unit[SAA7164_MAX_UNITS];
164};
165
166struct saa7164_subid {
167 u16 subvendor;
168 u16 subdevice;
169 u32 card;
170};
171
7615e434
ST
172struct saa7164_fh {
173 struct saa7164_port *port;
174 u32 freq;
175 u32 tuner_type;
176 atomic_t v4l_reading;
177};
178
91d80189
ST
179struct saa7164_histogram_bucket {
180 u32 val;
181 u32 count;
182 u64 update_time;
183};
184
185struct saa7164_histogram {
186 char name[32];
187 struct saa7164_histogram_bucket counter1[64];
188};
189
7615e434
ST
190struct saa7164_user_buffer {
191 struct list_head list;
192
193 /* Attributes */
194 u8 *data;
195 u32 pos;
196 u32 actual_size;
197};
198
443c1228
ST
199struct saa7164_fw_status {
200
201 /* RISC Core details */
202 u32 status;
203 u32 mode;
204 u32 spec;
205 u32 inst;
206 u32 cpuload;
207 u32 remainheap;
208
209 /* Firmware version */
210 u32 version;
211 u32 major;
212 u32 sub;
213 u32 rel;
214 u32 buildnr;
215};
216
217struct saa7164_dvb {
218 struct mutex lock;
219 struct dvb_adapter adapter;
220 struct dvb_frontend *frontend;
221 struct dvb_demux demux;
222 struct dmxdev dmxdev;
223 struct dmx_frontend fe_hw;
224 struct dmx_frontend fe_mem;
225 struct dvb_net net;
226 int feeding;
227};
228
229struct saa7164_i2c {
230 struct saa7164_dev *dev;
231
232 enum saa7164_i2c_bus_nr nr;
233
234 /* I2C I/O */
235 struct i2c_adapter i2c_adap;
236 struct i2c_algo_bit_data i2c_algo;
237 struct i2c_client i2c_client;
238 u32 i2c_rc;
239};
240
7615e434
ST
241struct saa7164_ctrl {
242 struct v4l2_queryctrl v;
243};
244
245struct saa7164_tvnorm {
246 char *name;
247 v4l2_std_id id;
248// u32 cxiformat;
249// u32 cxoformat;
250};
251
252struct saa7164_encoder_params {
253 struct saa7164_tvnorm encodernorm;
254 u32 height;
255 u32 width;
256 u32 is_50hz;
257 u32 bitrate; /* bps */
968b11b2 258 u32 bitrate_peak; /* bps */
2600d71c 259 u32 bitrate_mode;
7615e434
ST
260 u32 stream_type; /* V4L2_MPEG_STREAM_TYPE_MPEG2_TS */
261
262 u32 audio_sampling_freq;
263 u32 ctl_mute;
264 u32 ctl_aspect;
3ed43cf9 265 u32 refdist;
5fa56ccd 266 u32 gop_size;
7615e434
ST
267};
268
add3f580 269struct saa7164_port;
443c1228
ST
270
271struct saa7164_buffer {
272 struct list_head list;
273
add3f580
ST
274 /* Note of which h/w buffer list index position we occupy */
275 int idx;
443c1228 276
add3f580 277 struct saa7164_port *port;
443c1228
ST
278
279 /* Hardware Specific */
280 /* PCI Memory allocations */
281 enum saa7164_buffer_flags flags; /* Free, Busy, Full */
282
283 /* A block of page align PCI memory */
284 u32 pci_size; /* PCI allocation size in bytes */
285 u64 *cpu; /* Virtual address */
286 dma_addr_t dma; /* Physical address */
287
288 /* A page table that splits the block into a number of entries */
289 u32 pt_size; /* PCI allocation size in bytes */
290 u64 *pt_cpu; /* Virtual address */
291 dma_addr_t pt_dma; /* Physical address */
add3f580
ST
292
293 /* Encoder fops */
294 u32 pos;
295 u32 actual_size;
443c1228
ST
296};
297
add3f580 298struct saa7164_port {
443c1228
ST
299
300 struct saa7164_dev *dev;
443c1228 301 enum port_t type;
add3f580 302 int nr;
443c1228 303
add3f580 304 /* --- Generic port attributes --- */
443c1228 305
add3f580 306 /* HW stream parameters */
443c1228
ST
307 tmHWStreamParameters_t hw_streamingparams;
308
309 /* DMA configuration values, is seeded during initialization */
310 tmComResDMATermDescrHeader_t hwcfg;
311
312 /* hardware specific registers */
313 u32 bufcounter;
314 u32 pitch;
315 u32 bufsize;
316 u32 bufoffset;
317 u32 bufptr32l;
318 u32 bufptr32h;
319 u64 bufptr64;
320
321 u32 numpte; /* Number of entries in array, only valid in head */
add3f580 322
443c1228 323 struct mutex dmaqueue_lock;
443c1228 324 struct saa7164_buffer dmaqueue;
add3f580 325
91d80189
ST
326 u64 last_irq_msecs, last_svc_msecs;
327 u64 last_irq_msecs_diff, last_svc_msecs_diff;
328 u32 last_irq_wp, last_svc_wp;
329 u32 last_irq_rp, last_svc_rp;
330 u64 last_irq_svc_msecs_diff;
331
332 struct saa7164_histogram irq_interval;
333 struct saa7164_histogram svc_interval;
334 struct saa7164_histogram irq_svc_interval;
335
add3f580
ST
336 /* --- DVB Transport Specific --- */
337 struct saa7164_dvb dvb;
338
339 /* --- Encoder/V4L related attributes --- */
7615e434
ST
340 /* Encoder */
341 /* Defaults established in saa7164-encoder.c */
342 struct saa7164_tvnorm encodernorm;
343 u32 height;
344 u32 width;
345 u32 freq;
346 u32 ts_packet_size;
347 u32 ts_packet_count;
348 u8 mux_input;
349 u8 encoder_profile;
350 u8 video_format;
351 u8 audio_format;
352 u8 video_resolution;
353 u16 ctl_brightness;
354 u16 ctl_contrast;
355 u16 ctl_hue;
356 u16 ctl_saturation;
357 u16 ctl_sharpness;
358 s8 ctl_volume;
359
360 tmComResAFeatureDescrHeader_t audfeat;
361 tmComResEncoderDescrHeader_t encunit;
362 tmComResProcDescrHeader_t vidproc;
363 tmComResExtDevDescrHeader_t ifunit;
364 tmComResTunerDescrHeader_t tunerunit;
365
91d80189
ST
366 struct work_struct workenc;
367
7615e434
ST
368 /* V4L */
369 struct saa7164_encoder_params encoder_params;
370 struct video_device *v4l_device;
371 atomic_t v4l_reader_count;
372// spinlock_t slock;
373// struct mutex fops_lock;
374
375 struct saa7164_buffer list_buf_used;
376 struct saa7164_buffer list_buf_free;
377 wait_queue_head_t wait_read;
443c1228
ST
378};
379
380struct saa7164_dev {
381 struct list_head devlist;
382 atomic_t refcount;
383
384 /* pci stuff */
385 struct pci_dev *pci;
386 unsigned char pci_rev, pci_lat;
387 int pci_bus, pci_slot;
388 u32 __iomem *lmmio;
389 u8 __iomem *bmmio;
390 u32 __iomem *lmmio2;
391 u8 __iomem *bmmio2;
392 int pci_irqmask;
393
394 /* board details */
395 int nr;
396 int hwrevision;
397 u32 board;
398 char name[32];
399
400 /* firmware status */
401 struct saa7164_fw_status fw_status;
402
403 tmComResHWDescr_t hwdesc;
404 tmComResInterfaceDescr_t intfdesc;
405 tmComResBusDescr_t busdesc;
406
407 tmComResBusInfo_t bus;
408
1a6450d4
ST
409 /* Interrupt status and ack registers */
410 u32 int_status;
411 u32 int_ack;
443c1228
ST
412
413 struct cmd cmds[SAA_CMD_MAX_MSG_UNITS];
414 struct mutex lock;
415
416 /* I2c related */
417 struct saa7164_i2c i2c_bus[3];
418
419 /* Transport related */
7615e434 420 struct saa7164_port ports[ SAA7164_MAX_PORTS ];
443c1228
ST
421
422 /* Deferred command/api interrupts handling */
423 struct work_struct workcmd;
424
425};
426
427extern struct list_head saa7164_devlist;
dd1ee444 428extern unsigned int waitsecs;
443c1228
ST
429
430/* ----------------------------------------------------------- */
431/* saa7164-core.c */
432void saa7164_dumpregs(struct saa7164_dev *dev, u32 addr);
433void saa7164_dumphex16(struct saa7164_dev *dev, u8 *buf, int len);
434void saa7164_getfirmwarestatus(struct saa7164_dev *dev);
435u32 saa7164_getcurrentfirmwareversion(struct saa7164_dev *dev);
436
437/* ----------------------------------------------------------- */
438/* saa7164-fw.c */
439int saa7164_downloadfirmware(struct saa7164_dev *dev);
440
441/* ----------------------------------------------------------- */
442/* saa7164-i2c.c */
443extern int saa7164_i2c_register(struct saa7164_i2c *bus);
444extern int saa7164_i2c_unregister(struct saa7164_i2c *bus);
445extern void saa7164_call_i2c_clients(struct saa7164_i2c *bus,
446 unsigned int cmd, void *arg);
447
448/* ----------------------------------------------------------- */
449/* saa7164-bus.c */
450int saa7164_bus_setup(struct saa7164_dev *dev);
451void saa7164_bus_dump(struct saa7164_dev *dev);
452int saa7164_bus_set(struct saa7164_dev *dev, tmComResInfo_t* msg, void *buf);
453int saa7164_bus_get(struct saa7164_dev *dev, tmComResInfo_t* msg,
454 void *buf, int peekonly);
455
456/* ----------------------------------------------------------- */
457/* saa7164-cmd.c */
458int saa7164_cmd_send(struct saa7164_dev *dev,
459 u8 id, tmComResCmd_t command, u16 controlselector,
460 u16 size, void *buf);
461void saa7164_cmd_signal(struct saa7164_dev *dev, u8 seqno);
39e469ab 462int saa7164_irq_dequeue(struct saa7164_dev *dev);
443c1228
ST
463
464/* ----------------------------------------------------------- */
465/* saa7164-api.c */
443c1228
ST
466int saa7164_api_get_fw_version(struct saa7164_dev *dev, u32 *version);
467int saa7164_api_enum_subdevs(struct saa7164_dev *dev);
468int saa7164_api_i2c_read(struct saa7164_i2c *bus, u8 addr, u32 reglen, u8 *reg,
469 u32 datalen, u8 *data);
470int saa7164_api_i2c_write(struct saa7164_i2c *bus, u8 addr,
471 u32 datalen, u8 *data);
472int saa7164_api_dif_write(struct saa7164_i2c *bus, u8 addr,
473 u32 datalen, u8 *data);
474int saa7164_api_read_eeprom(struct saa7164_dev *dev, u8 *buf, int buflen);
475int saa7164_api_set_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
476int saa7164_api_clear_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
add3f580 477int saa7164_api_transition_port(struct saa7164_port *port, u8 mode);
7615e434
ST
478int saa7164_api_initialize_dif(struct saa7164_port *port);
479int saa7164_api_configure_dif(struct saa7164_port *port, u32 std);
480int saa7164_api_set_encoder(struct saa7164_port *port);
481int saa7164_api_get_encoder(struct saa7164_port *port);
482int saa7164_api_set_aspect_ratio(struct saa7164_port *port);
483int saa7164_api_set_usercontrol(struct saa7164_port *port, u8 ctl);
484int saa7164_api_get_usercontrol(struct saa7164_port *port, u8 ctl);
485int saa7164_api_set_videomux(struct saa7164_port *port);
486int saa7164_api_audio_mute(struct saa7164_port *port, int mute);
487int saa7164_api_set_audio_volume(struct saa7164_port *port, s8 level);
488int saa7164_api_set_audio_std(struct saa7164_port *port);
489int saa7164_api_set_audio_detection(struct saa7164_port *port, int autodetect);
490int saa7164_api_get_videomux(struct saa7164_port *port);
443c1228
ST
491
492/* ----------------------------------------------------------- */
493/* saa7164-cards.c */
494extern struct saa7164_board saa7164_boards[];
495extern const unsigned int saa7164_bcount;
496
497extern struct saa7164_subid saa7164_subids[];
498extern const unsigned int saa7164_idcount;
499
500extern void saa7164_card_list(struct saa7164_dev *dev);
501extern void saa7164_gpio_setup(struct saa7164_dev *dev);
502extern void saa7164_card_setup(struct saa7164_dev *dev);
503
504extern int saa7164_i2caddr_to_reglen(struct saa7164_i2c *bus, int addr);
505extern int saa7164_i2caddr_to_unitid(struct saa7164_i2c *bus, int addr);
506extern char *saa7164_unitid_name(struct saa7164_dev *dev, u8 unitid);
507
508/* ----------------------------------------------------------- */
509/* saa7164-dvb.c */
add3f580
ST
510extern int saa7164_dvb_register(struct saa7164_port *port);
511extern int saa7164_dvb_unregister(struct saa7164_port *port);
443c1228
ST
512
513/* ----------------------------------------------------------- */
514/* saa7164-buffer.c */
add3f580
ST
515extern struct saa7164_buffer *saa7164_buffer_alloc(
516 struct saa7164_port *port, u32 len);
517extern int saa7164_buffer_dealloc(struct saa7164_buffer *buf);
518extern void saa7164_buffer_display(struct saa7164_buffer *buf);
519extern int saa7164_buffer_activate(struct saa7164_buffer *buf, int i);
520extern int saa7164_buffer_cfg_port(struct saa7164_port *port);
7615e434
ST
521extern struct saa7164_user_buffer *saa7164_buffer_alloc_user(
522 struct saa7164_dev *dev, u32 len);
523extern void saa7164_buffer_dealloc_user(struct saa7164_user_buffer *buf);
524
525
526/* ----------------------------------------------------------- */
527/* saa7164-encoder.c */
528int saa7164_encoder_register(struct saa7164_port *port);
529void saa7164_encoder_unregister(struct saa7164_port *port);
443c1228
ST
530
531/* ----------------------------------------------------------- */
532
b1912a85 533extern unsigned int saa_debug;
443c1228 534#define dprintk(level, fmt, arg...)\
b1912a85 535 do { if (saa_debug & level)\
443c1228
ST
536 printk(KERN_DEBUG "%s: " fmt, dev->name, ## arg);\
537 } while (0)
538
539#define log_warn(fmt, arg...)\
540 do { \
541 printk(KERN_WARNING "%s: " fmt, dev->name, ## arg);\
542 } while (0)
543
544#define log_err(fmt, arg...)\
545 do { \
546 printk(KERN_ERROR "%s: " fmt, dev->name, ## arg);\
547 } while (0)
548
549#define saa7164_readl(reg) readl(dev->lmmio + ((reg) >> 2))
207b42c4
ST
550#define saa7164_writel(reg, value) writel((value), dev->lmmio + ((reg) >> 2))
551
443c1228
ST
552
553#define saa7164_readb(reg) readl(dev->bmmio + (reg))
554#define saa7164_writeb(reg, value) writel((value), dev->bmmio + (reg))
555