?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Add linux-next specific files for 20110831
[linux-2.6/next.git] / drivers / media / video / saa7164 / saa7164.h
blob6678bf1e78168bc0401453de3599e4c5ebc2ad7d
1 /*
2 * Driver for the NXP SAA7164 PCIe bridge
3 *
4 * Copyright (c) 2010 Steven Toth <stoth@kernellabs.com>
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>
51 #include <linux/mutex.h>
52 #include <linux/crc32.h>
53 #include <linux/kthread.h>
54 #include <linux/freezer.h>
55
56 #include <media/tuner.h>
57 #include <media/tveeprom.h>
58 #include <media/videobuf-dma-sg.h>
59 #include <media/videobuf-dvb.h>
60 #include <dvb_demux.h>
61 #include <dvb_frontend.h>
62 #include <dvb_net.h>
63 #include <dvbdev.h>
64 #include <dmxdev.h>
65 #include <media/v4l2-common.h>
66 #include <media/v4l2-ioctl.h>
67 #include <media/v4l2-chip-ident.h>
68
69 #include "saa7164-reg.h"
70 #include "saa7164-types.h"
71
72 #define SAA7164_MAXBOARDS 8
73
74 #define UNSET (-1U)
75 #define SAA7164_BOARD_NOAUTO UNSET
76 #define SAA7164_BOARD_UNKNOWN 0
77 #define SAA7164_BOARD_UNKNOWN_REV2 1
78 #define SAA7164_BOARD_UNKNOWN_REV3 2
79 #define SAA7164_BOARD_HAUPPAUGE_HVR2250 3
80 #define SAA7164_BOARD_HAUPPAUGE_HVR2200 4
81 #define SAA7164_BOARD_HAUPPAUGE_HVR2200_2 5
82 #define SAA7164_BOARD_HAUPPAUGE_HVR2200_3 6
83 #define SAA7164_BOARD_HAUPPAUGE_HVR2250_2 7
84 #define SAA7164_BOARD_HAUPPAUGE_HVR2250_3 8
85
86 #define SAA7164_MAX_UNITS 8
87 #define SAA7164_TS_NUMBER_OF_LINES 312
88 #define SAA7164_PS_NUMBER_OF_LINES 256
89 #define SAA7164_PT_ENTRIES 16 /* (312 * 188) / 4096 */
90 #define SAA7164_MAX_ENCODER_BUFFERS 64 /* max 5secs of latency at 6Mbps */
91 #define SAA7164_MAX_VBI_BUFFERS 64
92
93 /* Port related defines */
94 #define SAA7164_PORT_TS1 (0)
95 #define SAA7164_PORT_TS2 (SAA7164_PORT_TS1 + 1)
96 #define SAA7164_PORT_ENC1 (SAA7164_PORT_TS2 + 1)
97 #define SAA7164_PORT_ENC2 (SAA7164_PORT_ENC1 + 1)
98 #define SAA7164_PORT_VBI1 (SAA7164_PORT_ENC2 + 1)
99 #define SAA7164_PORT_VBI2 (SAA7164_PORT_VBI1 + 1)
100 #define SAA7164_MAX_PORTS (SAA7164_PORT_VBI2 + 1)
101
102 #define DBGLVL_FW 4
103 #define DBGLVL_DVB 8
104 #define DBGLVL_I2C 16
105 #define DBGLVL_API 32
106 #define DBGLVL_CMD 64
107 #define DBGLVL_BUS 128
108 #define DBGLVL_IRQ 256
109 #define DBGLVL_BUF 512
110 #define DBGLVL_ENC 1024
111 #define DBGLVL_VBI 2048
112 #define DBGLVL_THR 4096
113 #define DBGLVL_CPU 8192
114
115 #define SAA7164_NORMS \
116 (V4L2_STD_NTSC_M | V4L2_STD_NTSC_M_JP | V4L2_STD_NTSC_443)
117
118 enum port_t {
119 SAA7164_MPEG_UNDEFINED = 0,
120 SAA7164_MPEG_DVB,
121 SAA7164_MPEG_ENCODER,
122 SAA7164_MPEG_VBI,
123 };
124
125 enum saa7164_i2c_bus_nr {
126 SAA7164_I2C_BUS_0 = 0,
127 SAA7164_I2C_BUS_1,
128 SAA7164_I2C_BUS_2,
129 };
130
131 enum saa7164_buffer_flags {
132 SAA7164_BUFFER_UNDEFINED = 0,
133 SAA7164_BUFFER_FREE,
134 SAA7164_BUFFER_BUSY,
135 SAA7164_BUFFER_FULL
136 };
137
138 enum saa7164_unit_type {
139 SAA7164_UNIT_UNDEFINED = 0,
140 SAA7164_UNIT_DIGITAL_DEMODULATOR,
141 SAA7164_UNIT_ANALOG_DEMODULATOR,
142 SAA7164_UNIT_TUNER,
143 SAA7164_UNIT_EEPROM,
144 SAA7164_UNIT_ZILOG_IRBLASTER,
145 SAA7164_UNIT_ENCODER,
146 };
147
148 /* The PCIe bridge doesn't grant direct access to i2c.
149 * Instead, you address i2c devices using a uniqely
150 * allocated 'unitid' value via a messaging API. This
151 * is a problem. The kernel and existing demod/tuner
152 * drivers expect to talk 'i2c', so we have to maintain
153 * a translation layer, and a series of functions to
154 * convert i2c bus + device address into a unit id.
155 */
156 struct saa7164_unit {
157 enum saa7164_unit_type type;
158 u8 id;
159 char *name;
160 enum saa7164_i2c_bus_nr i2c_bus_nr;
161 u8 i2c_bus_addr;
162 u8 i2c_reg_len;
163 };
164
165 struct saa7164_board {
166 char *name;
167 enum port_t porta, portb, portc,
168 portd, porte, portf;
169 enum {
170 SAA7164_CHIP_UNDEFINED = 0,
171 SAA7164_CHIP_REV2,
172 SAA7164_CHIP_REV3,
173 } chiprev;
174 struct saa7164_unit unit[SAA7164_MAX_UNITS];
175 };
176
177 struct saa7164_subid {
178 u16 subvendor;
179 u16 subdevice;
180 u32 card;
181 };
182
183 struct saa7164_encoder_fh {
184 struct saa7164_port *port;
185 atomic_t v4l_reading;
186 };
187
188 struct saa7164_vbi_fh {
189 struct saa7164_port *port;
190 atomic_t v4l_reading;
191 };
192
193 struct saa7164_histogram_bucket {
194 u32 val;
195 u32 count;
196 u64 update_time;
197 };
198
199 struct saa7164_histogram {
200 char name[32];
201 struct saa7164_histogram_bucket counter1[64];
202 };
203
204 struct saa7164_user_buffer {
205 struct list_head list;
206
207 /* Attributes */
208 u8 *data;
209 u32 pos;
210 u32 actual_size;
211
212 u32 crc;
213 };
214
215 struct saa7164_fw_status {
216
217 /* RISC Core details */
218 u32 status;
219 u32 mode;
220 u32 spec;
221 u32 inst;
222 u32 cpuload;
223 u32 remainheap;
224
225 /* Firmware version */
226 u32 version;
227 u32 major;
228 u32 sub;
229 u32 rel;
230 u32 buildnr;
231 };
232
233 struct saa7164_dvb {
234 struct mutex lock;
235 struct dvb_adapter adapter;
236 struct dvb_frontend *frontend;
237 struct dvb_demux demux;
238 struct dmxdev dmxdev;
239 struct dmx_frontend fe_hw;
240 struct dmx_frontend fe_mem;
241 struct dvb_net net;
242 int feeding;
243 };
244
245 struct saa7164_i2c {
246 struct saa7164_dev *dev;
247
248 enum saa7164_i2c_bus_nr nr;
249
250 /* I2C I/O */
251 struct i2c_adapter i2c_adap;
252 struct i2c_algo_bit_data i2c_algo;
253 struct i2c_client i2c_client;
254 u32 i2c_rc;
255 };
256
257 struct saa7164_ctrl {
258 struct v4l2_queryctrl v;
259 };
260
261 struct saa7164_tvnorm {
262 char *name;
263 v4l2_std_id id;
264 };
265
266 struct saa7164_encoder_params {
267 struct saa7164_tvnorm encodernorm;
268 u32 height;
269 u32 width;
270 u32 is_50hz;
271 u32 bitrate; /* bps */
272 u32 bitrate_peak; /* bps */
273 u32 bitrate_mode;
274 u32 stream_type; /* V4L2_MPEG_STREAM_TYPE_MPEG2_TS */
275
276 u32 audio_sampling_freq;
277 u32 ctl_mute;
278 u32 ctl_aspect;
279 u32 refdist;
280 u32 gop_size;
281 };
282
283 struct saa7164_vbi_params {
284 struct saa7164_tvnorm encodernorm;
285 u32 height;
286 u32 width;
287 u32 is_50hz;
288 u32 bitrate; /* bps */
289 u32 bitrate_peak; /* bps */
290 u32 bitrate_mode;
291 u32 stream_type; /* V4L2_MPEG_STREAM_TYPE_MPEG2_TS */
292
293 u32 audio_sampling_freq;
294 u32 ctl_mute;
295 u32 ctl_aspect;
296 u32 refdist;
297 u32 gop_size;
298 };
299
300 struct saa7164_port;
301
302 struct saa7164_buffer {
303 struct list_head list;
304
305 /* Note of which h/w buffer list index position we occupy */
306 int idx;
307
308 struct saa7164_port *port;
309
310 /* Hardware Specific */
311 /* PCI Memory allocations */
312 enum saa7164_buffer_flags flags; /* Free, Busy, Full */
313
314 /* A block of page align PCI memory */
315 u32 pci_size; /* PCI allocation size in bytes */
316 u64 __iomem *cpu; /* Virtual address */
317 dma_addr_t dma; /* Physical address */
318 u32 crc; /* Checksum for the entire buffer data */
319
320 /* A page table that splits the block into a number of entries */
321 u32 pt_size; /* PCI allocation size in bytes */
322 u64 __iomem *pt_cpu; /* Virtual address */
323 dma_addr_t pt_dma; /* Physical address */
324
325 /* Encoder fops */
326 u32 pos;
327 u32 actual_size;
328 };
329
330 struct saa7164_port {
331
332 struct saa7164_dev *dev;
333 enum port_t type;
334 int nr;
335
336 /* --- Generic port attributes --- */
337
338 /* HW stream parameters */
339 struct tmHWStreamParameters hw_streamingparams;
340
341 /* DMA configuration values, is seeded during initialization */
342 struct tmComResDMATermDescrHeader hwcfg;
343
344 /* hardware specific registers */
345 u32 bufcounter;
346 u32 pitch;
347 u32 bufsize;
348 u32 bufoffset;
349 u32 bufptr32l;
350 u32 bufptr32h;
351 u64 bufptr64;
352
353 u32 numpte; /* Number of entries in array, only valid in head */
354
355 struct mutex dmaqueue_lock;
356 struct saa7164_buffer dmaqueue;
357
358 u64 last_irq_msecs, last_svc_msecs;
359 u64 last_irq_msecs_diff, last_svc_msecs_diff;
360 u32 last_svc_wp;
361 u32 last_svc_rp;
362 u64 last_irq_svc_msecs_diff;
363 u64 last_read_msecs, last_read_msecs_diff;
364 u64 last_poll_msecs, last_poll_msecs_diff;
365
366 struct saa7164_histogram irq_interval;
367 struct saa7164_histogram svc_interval;
368 struct saa7164_histogram irq_svc_interval;
369 struct saa7164_histogram read_interval;
370 struct saa7164_histogram poll_interval;
371
372 /* --- DVB Transport Specific --- */
373 struct saa7164_dvb dvb;
374
375 /* --- Encoder/V4L related attributes --- */
376 /* Encoder */
377 /* Defaults established in saa7164-encoder.c */
378 struct saa7164_tvnorm encodernorm;
379 u32 height;
380 u32 width;
381 u32 freq;
382 u32 ts_packet_size;
383 u32 ts_packet_count;
384 u8 mux_input;
385 u8 encoder_profile;
386 u8 video_format;
387 u8 audio_format;
388 u8 video_resolution;
389 u16 ctl_brightness;
390 u16 ctl_contrast;
391 u16 ctl_hue;
392 u16 ctl_saturation;
393 u16 ctl_sharpness;
394 s8 ctl_volume;
395
396 struct tmComResAFeatureDescrHeader audfeat;
397 struct tmComResEncoderDescrHeader encunit;
398 struct tmComResProcDescrHeader vidproc;
399 struct tmComResExtDevDescrHeader ifunit;
400 struct tmComResTunerDescrHeader tunerunit;
401
402 struct work_struct workenc;
403
404 /* V4L Encoder Video */
405 struct saa7164_encoder_params encoder_params;
406 struct video_device *v4l_device;
407 atomic_t v4l_reader_count;
408
409 struct saa7164_buffer list_buf_used;
410 struct saa7164_buffer list_buf_free;
411 wait_queue_head_t wait_read;
412
413 /* V4L VBI */
414 struct tmComResVBIFormatDescrHeader vbi_fmt_ntsc;
415 struct saa7164_vbi_params vbi_params;
416
417 /* Debug */
418 u32 sync_errors;
419 u32 v_cc_errors;
420 u32 a_cc_errors;
421 u8 last_v_cc;
422 u8 last_a_cc;
423 u32 done_first_interrupt;
424 };
425
426 struct saa7164_dev {
427 struct list_head devlist;
428 atomic_t refcount;
429
430 /* pci stuff */
431 struct pci_dev *pci;
432 unsigned char pci_rev, pci_lat;
433 int pci_bus, pci_slot;
434 u32 __iomem *lmmio;
435 u8 __iomem *bmmio;
436 u32 __iomem *lmmio2;
437 u8 __iomem *bmmio2;
438 int pci_irqmask;
439
440 /* board details */
441 int nr;
442 int hwrevision;
443 u32 board;
444 char name[16];
445
446 /* firmware status */
447 struct saa7164_fw_status fw_status;
448 u32 firmwareloaded;
449
450 struct tmComResHWDescr hwdesc;
451 struct tmComResInterfaceDescr intfdesc;
452 struct tmComResBusDescr busdesc;
453
454 struct tmComResBusInfo bus;
455
456 /* Interrupt status and ack registers */
457 u32 int_status;
458 u32 int_ack;
459
460 struct cmd cmds[SAA_CMD_MAX_MSG_UNITS];
461 struct mutex lock;
462
463 /* I2c related */
464 struct saa7164_i2c i2c_bus[3];
465
466 /* Transport related */
467 struct saa7164_port ports[SAA7164_MAX_PORTS];
468
469 /* Deferred command/api interrupts handling */
470 struct work_struct workcmd;
471
472 /* A kernel thread to monitor the firmware log, used
473 * only in debug mode.
474 */
475 struct task_struct *kthread;
476
477 };
478
479 extern struct list_head saa7164_devlist;
480 extern unsigned int waitsecs;
481 extern unsigned int encoder_buffers;
482 extern unsigned int vbi_buffers;
483
484 /* ----------------------------------------------------------- */
485 /* saa7164-core.c */
486 void saa7164_dumpregs(struct saa7164_dev *dev, u32 addr);
487 void saa7164_dumphex16(struct saa7164_dev *dev, u8 *buf, int len);
488 void saa7164_getfirmwarestatus(struct saa7164_dev *dev);
489 u32 saa7164_getcurrentfirmwareversion(struct saa7164_dev *dev);
490 void saa7164_histogram_update(struct saa7164_histogram *hg, u32 val);
491
492 /* ----------------------------------------------------------- */
493 /* saa7164-fw.c */
494 int saa7164_downloadfirmware(struct saa7164_dev *dev);
495
496 /* ----------------------------------------------------------- */
497 /* saa7164-i2c.c */
498 extern int saa7164_i2c_register(struct saa7164_i2c *bus);
499 extern int saa7164_i2c_unregister(struct saa7164_i2c *bus);
500 extern void saa7164_call_i2c_clients(struct saa7164_i2c *bus,
501 unsigned int cmd, void *arg);
502
503 /* ----------------------------------------------------------- */
504 /* saa7164-bus.c */
505 int saa7164_bus_setup(struct saa7164_dev *dev);
506 void saa7164_bus_dump(struct saa7164_dev *dev);
507 int saa7164_bus_set(struct saa7164_dev *dev, struct tmComResInfo* msg,
508 void *buf);
509 int saa7164_bus_get(struct saa7164_dev *dev, struct tmComResInfo* msg,
510 void *buf, int peekonly);
511
512 /* ----------------------------------------------------------- */
513 /* saa7164-cmd.c */
514 int saa7164_cmd_send(struct saa7164_dev *dev,
515 u8 id, enum tmComResCmd command, u16 controlselector,
516 u16 size, void *buf);
517 void saa7164_cmd_signal(struct saa7164_dev *dev, u8 seqno);
518 int saa7164_irq_dequeue(struct saa7164_dev *dev);
519
520 /* ----------------------------------------------------------- */
521 /* saa7164-api.c */
522 int saa7164_api_get_fw_version(struct saa7164_dev *dev, u32 *version);
523 int saa7164_api_enum_subdevs(struct saa7164_dev *dev);
524 int saa7164_api_i2c_read(struct saa7164_i2c *bus, u8 addr, u32 reglen, u8 *reg,
525 u32 datalen, u8 *data);
526 int saa7164_api_i2c_write(struct saa7164_i2c *bus, u8 addr,
527 u32 datalen, u8 *data);
528 int saa7164_api_dif_write(struct saa7164_i2c *bus, u8 addr,
529 u32 datalen, u8 *data);
530 int saa7164_api_read_eeprom(struct saa7164_dev *dev, u8 *buf, int buflen);
531 int saa7164_api_set_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
532 int saa7164_api_clear_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
533 int saa7164_api_transition_port(struct saa7164_port *port, u8 mode);
534 int saa7164_api_initialize_dif(struct saa7164_port *port);
535 int saa7164_api_configure_dif(struct saa7164_port *port, u32 std);
536 int saa7164_api_set_encoder(struct saa7164_port *port);
537 int saa7164_api_get_encoder(struct saa7164_port *port);
538 int saa7164_api_set_aspect_ratio(struct saa7164_port *port);
539 int saa7164_api_set_usercontrol(struct saa7164_port *port, u8 ctl);
540 int saa7164_api_get_usercontrol(struct saa7164_port *port, u8 ctl);
541 int saa7164_api_set_videomux(struct saa7164_port *port);
542 int saa7164_api_audio_mute(struct saa7164_port *port, int mute);
543 int saa7164_api_set_audio_volume(struct saa7164_port *port, s8 level);
544 int saa7164_api_set_audio_std(struct saa7164_port *port);
545 int saa7164_api_set_audio_detection(struct saa7164_port *port, int autodetect);
546 int saa7164_api_get_videomux(struct saa7164_port *port);
547 int saa7164_api_set_vbi_format(struct saa7164_port *port);
548 int saa7164_api_set_debug(struct saa7164_dev *dev, u8 level);
549 int saa7164_api_collect_debug(struct saa7164_dev *dev);
550 int saa7164_api_get_load_info(struct saa7164_dev *dev,
551 struct tmFwInfoStruct *i);
552
553 /* ----------------------------------------------------------- */
554 /* saa7164-cards.c */
555 extern struct saa7164_board saa7164_boards[];
556 extern const unsigned int saa7164_bcount;
557
558 extern struct saa7164_subid saa7164_subids[];
559 extern const unsigned int saa7164_idcount;
560
561 extern void saa7164_card_list(struct saa7164_dev *dev);
562 extern void saa7164_gpio_setup(struct saa7164_dev *dev);
563 extern void saa7164_card_setup(struct saa7164_dev *dev);
564
565 extern int saa7164_i2caddr_to_reglen(struct saa7164_i2c *bus, int addr);
566 extern int saa7164_i2caddr_to_unitid(struct saa7164_i2c *bus, int addr);
567 extern char *saa7164_unitid_name(struct saa7164_dev *dev, u8 unitid);
568
569 /* ----------------------------------------------------------- */
570 /* saa7164-dvb.c */
571 extern int saa7164_dvb_register(struct saa7164_port *port);
572 extern int saa7164_dvb_unregister(struct saa7164_port *port);
573
574 /* ----------------------------------------------------------- */
575 /* saa7164-buffer.c */
576 extern struct saa7164_buffer *saa7164_buffer_alloc(
577 struct saa7164_port *port, u32 len);
578 extern int saa7164_buffer_dealloc(struct saa7164_buffer *buf);
579 extern void saa7164_buffer_display(struct saa7164_buffer *buf);
580 extern int saa7164_buffer_activate(struct saa7164_buffer *buf, int i);
581 extern int saa7164_buffer_cfg_port(struct saa7164_port *port);
582 extern struct saa7164_user_buffer *saa7164_buffer_alloc_user(
583 struct saa7164_dev *dev, u32 len);
584 extern void saa7164_buffer_dealloc_user(struct saa7164_user_buffer *buf);
585 extern int saa7164_buffer_zero_offsets(struct saa7164_port *port, int i);
586
587 /* ----------------------------------------------------------- */
588 /* saa7164-encoder.c */
589 int saa7164_encoder_register(struct saa7164_port *port);
590 void saa7164_encoder_unregister(struct saa7164_port *port);
591
592 /* ----------------------------------------------------------- */
593 /* saa7164-vbi.c */
594 int saa7164_vbi_register(struct saa7164_port *port);
595 void saa7164_vbi_unregister(struct saa7164_port *port);
596
597 /* ----------------------------------------------------------- */
598
599 extern unsigned int crc_checking;
600
601 extern unsigned int saa_debug;
602 #define dprintk(level, fmt, arg...)\
603 do { if (saa_debug & level)\
604 printk(KERN_DEBUG "%s: " fmt, dev->name, ## arg);\
605 } while (0)
606
607 #define log_warn(fmt, arg...)\
608 do { \
609 printk(KERN_WARNING "%s: " fmt, dev->name, ## arg);\
610 } while (0)
611
612 #define log_err(fmt, arg...)\
613 do { \
614 printk(KERN_ERROR "%s: " fmt, dev->name, ## arg);\
615 } while (0)
616
617 #define saa7164_readl(reg) readl(dev->lmmio + ((reg) >> 2))
618 #define saa7164_writel(reg, value) writel((value), dev->lmmio + ((reg) >> 2))
619
620 #define saa7164_readb(reg) readl(dev->bmmio + (reg))
621 #define saa7164_writeb(reg, value) writel((value), dev->bmmio + (reg))
622
linux-next