?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
PM / sleep: Asynchronous threads for suspend_noirq
[linux/fpc-iii.git] / drivers / media / pci / saa7164 / saa7164.h
blob8b29e89903014b4fbf4b0ab9a0f76f90f416280c
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/kdev_t.h>
50 #include <linux/mutex.h>
51 #include <linux/crc32.h>
52 #include <linux/kthread.h>
53 #include <linux/freezer.h>
54
55 #include <media/tuner.h>
56 #include <media/tveeprom.h>
57 #include <media/videobuf-dma-sg.h>
58 #include <media/videobuf-dvb.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-device.h>
67
68 #include "saa7164-reg.h"
69 #include "saa7164-types.h"
70
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
83 #define SAA7164_BOARD_HAUPPAUGE_HVR2250_3 8
84 #define SAA7164_BOARD_HAUPPAUGE_HVR2200_4 9
85 #define SAA7164_BOARD_HAUPPAUGE_HVR2200_5 10
86
87 #define SAA7164_MAX_UNITS 8
88 #define SAA7164_TS_NUMBER_OF_LINES 312
89 #define SAA7164_PS_NUMBER_OF_LINES 256
90 #define SAA7164_PT_ENTRIES 16 /* (312 * 188) / 4096 */
91 #define SAA7164_MAX_ENCODER_BUFFERS 64 /* max 5secs of latency at 6Mbps */
92 #define SAA7164_MAX_VBI_BUFFERS 64
93
94 /* Port related defines */
95 #define SAA7164_PORT_TS1 (0)
96 #define SAA7164_PORT_TS2 (SAA7164_PORT_TS1 + 1)
97 #define SAA7164_PORT_ENC1 (SAA7164_PORT_TS2 + 1)
98 #define SAA7164_PORT_ENC2 (SAA7164_PORT_ENC1 + 1)
99 #define SAA7164_PORT_VBI1 (SAA7164_PORT_ENC2 + 1)
100 #define SAA7164_PORT_VBI2 (SAA7164_PORT_VBI1 + 1)
101 #define SAA7164_MAX_PORTS (SAA7164_PORT_VBI2 + 1)
102
103 #define DBGLVL_FW 4
104 #define DBGLVL_DVB 8
105 #define DBGLVL_I2C 16
106 #define DBGLVL_API 32
107 #define DBGLVL_CMD 64
108 #define DBGLVL_BUS 128
109 #define DBGLVL_IRQ 256
110 #define DBGLVL_BUF 512
111 #define DBGLVL_ENC 1024
112 #define DBGLVL_VBI 2048
113 #define DBGLVL_THR 4096
114 #define DBGLVL_CPU 8192
115
116 #define SAA7164_NORMS \
117 (V4L2_STD_NTSC_M | V4L2_STD_NTSC_M_JP | V4L2_STD_NTSC_443)
118
119 enum port_t {
120 SAA7164_MPEG_UNDEFINED = 0,
121 SAA7164_MPEG_DVB,
122 SAA7164_MPEG_ENCODER,
123 SAA7164_MPEG_VBI,
124 };
125
126 enum saa7164_i2c_bus_nr {
127 SAA7164_I2C_BUS_0 = 0,
128 SAA7164_I2C_BUS_1,
129 SAA7164_I2C_BUS_2,
130 };
131
132 enum saa7164_buffer_flags {
133 SAA7164_BUFFER_UNDEFINED = 0,
134 SAA7164_BUFFER_FREE,
135 SAA7164_BUFFER_BUSY,
136 SAA7164_BUFFER_FULL
137 };
138
139 enum saa7164_unit_type {
140 SAA7164_UNIT_UNDEFINED = 0,
141 SAA7164_UNIT_DIGITAL_DEMODULATOR,
142 SAA7164_UNIT_ANALOG_DEMODULATOR,
143 SAA7164_UNIT_TUNER,
144 SAA7164_UNIT_EEPROM,
145 SAA7164_UNIT_ZILOG_IRBLASTER,
146 SAA7164_UNIT_ENCODER,
147 };
148
149 /* The PCIe bridge doesn't grant direct access to i2c.
150 * Instead, you address i2c devices using a uniqely
151 * allocated 'unitid' value via a messaging API. This
152 * is a problem. The kernel and existing demod/tuner
153 * drivers expect to talk 'i2c', so we have to maintain
154 * a translation layer, and a series of functions to
155 * convert i2c bus + device address into a unit id.
156 */
157 struct saa7164_unit {
158 enum saa7164_unit_type type;
159 u8 id;
160 char *name;
161 enum saa7164_i2c_bus_nr i2c_bus_nr;
162 u8 i2c_bus_addr;
163 u8 i2c_reg_len;
164 };
165
166 struct saa7164_board {
167 char *name;
168 enum port_t porta, portb, portc,
169 portd, porte, portf;
170 enum {
171 SAA7164_CHIP_UNDEFINED = 0,
172 SAA7164_CHIP_REV2,
173 SAA7164_CHIP_REV3,
174 } chiprev;
175 struct saa7164_unit unit[SAA7164_MAX_UNITS];
176 };
177
178 struct saa7164_subid {
179 u16 subvendor;
180 u16 subdevice;
181 u32 card;
182 };
183
184 struct saa7164_encoder_fh {
185 struct saa7164_port *port;
186 atomic_t v4l_reading;
187 };
188
189 struct saa7164_vbi_fh {
190 struct saa7164_port *port;
191 atomic_t v4l_reading;
192 };
193
194 struct saa7164_histogram_bucket {
195 u32 val;
196 u32 count;
197 u64 update_time;
198 };
199
200 struct saa7164_histogram {
201 char name[32];
202 struct saa7164_histogram_bucket counter1[64];
203 };
204
205 struct saa7164_user_buffer {
206 struct list_head list;
207
208 /* Attributes */
209 u8 *data;
210 u32 pos;
211 u32 actual_size;
212
213 u32 crc;
214 };
215
216 struct saa7164_fw_status {
217
218 /* RISC Core details */
219 u32 status;
220 u32 mode;
221 u32 spec;
222 u32 inst;
223 u32 cpuload;
224 u32 remainheap;
225
226 /* Firmware version */
227 u32 version;
228 u32 major;
229 u32 sub;
230 u32 rel;
231 u32 buildnr;
232 };
233
234 struct saa7164_dvb {
235 struct mutex lock;
236 struct dvb_adapter adapter;
237 struct dvb_frontend *frontend;
238 struct dvb_demux demux;
239 struct dmxdev dmxdev;
240 struct dmx_frontend fe_hw;
241 struct dmx_frontend fe_mem;
242 struct dvb_net net;
243 int feeding;
244 };
245
246 struct saa7164_i2c {
247 struct saa7164_dev *dev;
248
249 enum saa7164_i2c_bus_nr nr;
250
251 /* I2C I/O */
252 struct i2c_adapter i2c_adap;
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 v4l2_std_id std;
380 u32 height;
381 u32 width;
382 u32 freq;
383 u32 ts_packet_size;
384 u32 ts_packet_count;
385 u8 mux_input;
386 u8 encoder_profile;
387 u8 video_format;
388 u8 audio_format;
389 u8 video_resolution;
390 u16 ctl_brightness;
391 u16 ctl_contrast;
392 u16 ctl_hue;
393 u16 ctl_saturation;
394 u16 ctl_sharpness;
395 s8 ctl_volume;
396
397 struct tmComResAFeatureDescrHeader audfeat;
398 struct tmComResEncoderDescrHeader encunit;
399 struct tmComResProcDescrHeader vidproc;
400 struct tmComResExtDevDescrHeader ifunit;
401 struct tmComResTunerDescrHeader tunerunit;
402
403 struct work_struct workenc;
404
405 /* V4L Encoder Video */
406 struct saa7164_encoder_params encoder_params;
407 struct video_device *v4l_device;
408 atomic_t v4l_reader_count;
409
410 struct saa7164_buffer list_buf_used;
411 struct saa7164_buffer list_buf_free;
412 wait_queue_head_t wait_read;
413
414 /* V4L VBI */
415 struct tmComResVBIFormatDescrHeader vbi_fmt_ntsc;
416 struct saa7164_vbi_params vbi_params;
417
418 /* Debug */
419 u32 sync_errors;
420 u32 v_cc_errors;
421 u32 a_cc_errors;
422 u8 last_v_cc;
423 u8 last_a_cc;
424 u32 done_first_interrupt;
425 };
426
427 struct saa7164_dev {
428 struct list_head devlist;
429 atomic_t refcount;
430
431 struct v4l2_device v4l2_dev;
432
433 /* pci stuff */
434 struct pci_dev *pci;
435 unsigned char pci_rev, pci_lat;
436 int pci_bus, pci_slot;
437 u32 __iomem *lmmio;
438 u8 __iomem *bmmio;
439 u32 __iomem *lmmio2;
440 u8 __iomem *bmmio2;
441 int pci_irqmask;
442
443 /* board details */
444 int nr;
445 int hwrevision;
446 u32 board;
447 char name[16];
448
449 /* firmware status */
450 struct saa7164_fw_status fw_status;
451 u32 firmwareloaded;
452
453 struct tmComResHWDescr hwdesc;
454 struct tmComResInterfaceDescr intfdesc;
455 struct tmComResBusDescr busdesc;
456
457 struct tmComResBusInfo bus;
458
459 /* Interrupt status and ack registers */
460 u32 int_status;
461 u32 int_ack;
462
463 struct cmd cmds[SAA_CMD_MAX_MSG_UNITS];
464 struct mutex lock;
465
466 /* I2c related */
467 struct saa7164_i2c i2c_bus[3];
468
469 /* Transport related */
470 struct saa7164_port ports[SAA7164_MAX_PORTS];
471
472 /* Deferred command/api interrupts handling */
473 struct work_struct workcmd;
474
475 /* A kernel thread to monitor the firmware log, used
476 * only in debug mode.
477 */
478 struct task_struct *kthread;
479
480 };
481
482 extern struct list_head saa7164_devlist;
483 extern unsigned int waitsecs;
484 extern unsigned int encoder_buffers;
485 extern unsigned int vbi_buffers;
486
487 /* ----------------------------------------------------------- */
488 /* saa7164-core.c */
489 void saa7164_dumpregs(struct saa7164_dev *dev, u32 addr);
490 void saa7164_getfirmwarestatus(struct saa7164_dev *dev);
491 u32 saa7164_getcurrentfirmwareversion(struct saa7164_dev *dev);
492 void saa7164_histogram_update(struct saa7164_histogram *hg, u32 val);
493
494 /* ----------------------------------------------------------- */
495 /* saa7164-fw.c */
496 int saa7164_downloadfirmware(struct saa7164_dev *dev);
497
498 /* ----------------------------------------------------------- */
499 /* saa7164-i2c.c */
500 extern int saa7164_i2c_register(struct saa7164_i2c *bus);
501 extern int saa7164_i2c_unregister(struct saa7164_i2c *bus);
502 extern void saa7164_call_i2c_clients(struct saa7164_i2c *bus,
503 unsigned int cmd, void *arg);
504
505 /* ----------------------------------------------------------- */
506 /* saa7164-bus.c */
507 int saa7164_bus_setup(struct saa7164_dev *dev);
508 void saa7164_bus_dump(struct saa7164_dev *dev);
509 int saa7164_bus_set(struct saa7164_dev *dev, struct tmComResInfo* msg,
510 void *buf);
511 int saa7164_bus_get(struct saa7164_dev *dev, struct tmComResInfo* msg,
512 void *buf, int peekonly);
513
514 /* ----------------------------------------------------------- */
515 /* saa7164-cmd.c */
516 int saa7164_cmd_send(struct saa7164_dev *dev,
517 u8 id, enum tmComResCmd command, u16 controlselector,
518 u16 size, void *buf);
519 void saa7164_cmd_signal(struct saa7164_dev *dev, u8 seqno);
520 int saa7164_irq_dequeue(struct saa7164_dev *dev);
521
522 /* ----------------------------------------------------------- */
523 /* saa7164-api.c */
524 int saa7164_api_get_fw_version(struct saa7164_dev *dev, u32 *version);
525 int saa7164_api_enum_subdevs(struct saa7164_dev *dev);
526 int saa7164_api_i2c_read(struct saa7164_i2c *bus, u8 addr, u32 reglen, u8 *reg,
527 u32 datalen, u8 *data);
528 int saa7164_api_i2c_write(struct saa7164_i2c *bus, u8 addr,
529 u32 datalen, u8 *data);
530 int saa7164_api_dif_write(struct saa7164_i2c *bus, u8 addr,
531 u32 datalen, u8 *data);
532 int saa7164_api_read_eeprom(struct saa7164_dev *dev, u8 *buf, int buflen);
533 int saa7164_api_set_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
534 int saa7164_api_clear_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
535 int saa7164_api_transition_port(struct saa7164_port *port, u8 mode);
536 int saa7164_api_initialize_dif(struct saa7164_port *port);
537 int saa7164_api_configure_dif(struct saa7164_port *port, u32 std);
538 int saa7164_api_set_encoder(struct saa7164_port *port);
539 int saa7164_api_get_encoder(struct saa7164_port *port);
540 int saa7164_api_set_aspect_ratio(struct saa7164_port *port);
541 int saa7164_api_set_usercontrol(struct saa7164_port *port, u8 ctl);
542 int saa7164_api_get_usercontrol(struct saa7164_port *port, u8 ctl);
543 int saa7164_api_set_videomux(struct saa7164_port *port);
544 int saa7164_api_audio_mute(struct saa7164_port *port, int mute);
545 int saa7164_api_set_audio_volume(struct saa7164_port *port, s8 level);
546 int saa7164_api_set_audio_std(struct saa7164_port *port);
547 int saa7164_api_set_audio_detection(struct saa7164_port *port, int autodetect);
548 int saa7164_api_get_videomux(struct saa7164_port *port);
549 int saa7164_api_set_vbi_format(struct saa7164_port *port);
550 int saa7164_api_set_debug(struct saa7164_dev *dev, u8 level);
551 int saa7164_api_collect_debug(struct saa7164_dev *dev);
552 int saa7164_api_get_load_info(struct saa7164_dev *dev,
553 struct tmFwInfoStruct *i);
554
555 /* ----------------------------------------------------------- */
556 /* saa7164-cards.c */
557 extern struct saa7164_board saa7164_boards[];
558 extern const unsigned int saa7164_bcount;
559
560 extern struct saa7164_subid saa7164_subids[];
561 extern const unsigned int saa7164_idcount;
562
563 extern void saa7164_card_list(struct saa7164_dev *dev);
564 extern void saa7164_gpio_setup(struct saa7164_dev *dev);
565 extern void saa7164_card_setup(struct saa7164_dev *dev);
566
567 extern int saa7164_i2caddr_to_reglen(struct saa7164_i2c *bus, int addr);
568 extern int saa7164_i2caddr_to_unitid(struct saa7164_i2c *bus, int addr);
569 extern char *saa7164_unitid_name(struct saa7164_dev *dev, u8 unitid);
570
571 /* ----------------------------------------------------------- */
572 /* saa7164-dvb.c */
573 extern int saa7164_dvb_register(struct saa7164_port *port);
574 extern int saa7164_dvb_unregister(struct saa7164_port *port);
575
576 /* ----------------------------------------------------------- */
577 /* saa7164-buffer.c */
578 extern struct saa7164_buffer *saa7164_buffer_alloc(
579 struct saa7164_port *port, u32 len);
580 extern int saa7164_buffer_dealloc(struct saa7164_buffer *buf);
581 extern void saa7164_buffer_display(struct saa7164_buffer *buf);
582 extern int saa7164_buffer_activate(struct saa7164_buffer *buf, int i);
583 extern int saa7164_buffer_cfg_port(struct saa7164_port *port);
584 extern struct saa7164_user_buffer *saa7164_buffer_alloc_user(
585 struct saa7164_dev *dev, u32 len);
586 extern void saa7164_buffer_dealloc_user(struct saa7164_user_buffer *buf);
587 extern int saa7164_buffer_zero_offsets(struct saa7164_port *port, int i);
588
589 /* ----------------------------------------------------------- */
590 /* saa7164-encoder.c */
591 int saa7164_encoder_register(struct saa7164_port *port);
592 void saa7164_encoder_unregister(struct saa7164_port *port);
593
594 /* ----------------------------------------------------------- */
595 /* saa7164-vbi.c */
596 int saa7164_vbi_register(struct saa7164_port *port);
597 void saa7164_vbi_unregister(struct saa7164_port *port);
598
599 /* ----------------------------------------------------------- */
600
601 extern unsigned int crc_checking;
602
603 extern unsigned int saa_debug;
604 #define dprintk(level, fmt, arg...)\
605 do { if (saa_debug & level)\
606 printk(KERN_DEBUG "%s: " fmt, dev->name, ## arg);\
607 } while (0)
608
609 #define log_warn(fmt, arg...)\
610 do { \
611 printk(KERN_WARNING "%s: " fmt, dev->name, ## arg);\
612 } while (0)
613
614 #define saa7164_readl(reg) readl(dev->lmmio + ((reg) >> 2))
615 #define saa7164_writel(reg, value) writel((value), dev->lmmio + ((reg) >> 2))
616
617 #define saa7164_readb(reg) readl(dev->bmmio + (reg))
618 #define saa7164_writeb(reg, value) writel((value), dev->bmmio + (reg))
619
Linux with added FPC-III support