V4L/DVB (9722): cx18: Convert per stream queue spinlocks into mutexes
[safe/jmp/linux-2.6] / drivers / media / video / cx18 / cx18-driver.h
1 /*
2  *  cx18 driver internal defines and structures
3  *
4  *  Derived from ivtv-driver.h
5  *
6  *  Copyright (C) 2007  Hans Verkuil <hverkuil@xs4all.nl>
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21  *  02111-1307  USA
22  */
23
24 #ifndef CX18_DRIVER_H
25 #define CX18_DRIVER_H
26
27 #include <linux/version.h>
28 #include <linux/module.h>
29 #include <linux/moduleparam.h>
30 #include <linux/init.h>
31 #include <linux/delay.h>
32 #include <linux/sched.h>
33 #include <linux/fs.h>
34 #include <linux/pci.h>
35 #include <linux/interrupt.h>
36 #include <linux/spinlock.h>
37 #include <linux/i2c.h>
38 #include <linux/i2c-algo-bit.h>
39 #include <linux/list.h>
40 #include <linux/unistd.h>
41 #include <linux/pagemap.h>
42 #include <linux/workqueue.h>
43 #include <linux/mutex.h>
44 #include <asm/byteorder.h>
45
46 #include <linux/dvb/video.h>
47 #include <linux/dvb/audio.h>
48 #include <media/v4l2-common.h>
49 #include <media/v4l2-ioctl.h>
50 #include <media/tuner.h>
51 #include "cx18-mailbox.h"
52 #include "cx18-av-core.h"
53 #include "cx23418.h"
54
55 /* DVB */
56 #include "demux.h"
57 #include "dmxdev.h"
58 #include "dvb_demux.h"
59 #include "dvb_frontend.h"
60 #include "dvb_net.h"
61 #include "dvbdev.h"
62
63 #ifndef CONFIG_PCI
64 #  error "This driver requires kernel PCI support."
65 #endif
66
67 /* Default delay to throttle mmio access to the CX23418 */
68 #define CX18_DEFAULT_MMIO_NDELAY 0 /* 0 ns = 0 PCI clock(s) / 33 MHz */
69
70 #define CX18_MEM_OFFSET 0x00000000
71 #define CX18_MEM_SIZE   0x04000000
72 #define CX18_REG_OFFSET 0x02000000
73
74 /* Maximum cx18 driver instances. */
75 #define CX18_MAX_CARDS 32
76
77 /* Supported cards */
78 #define CX18_CARD_HVR_1600_ESMT       0 /* Hauppauge HVR 1600 (ESMT memory) */
79 #define CX18_CARD_HVR_1600_SAMSUNG    1 /* Hauppauge HVR 1600 (Samsung memory) */
80 #define CX18_CARD_COMPRO_H900         2 /* Compro VideoMate H900 */
81 #define CX18_CARD_YUAN_MPC718         3 /* Yuan MPC718 */
82 #define CX18_CARD_CNXT_RAPTOR_PAL     4 /* Conexant Raptor PAL */
83 #define CX18_CARD_TOSHIBA_QOSMIO_DVBT 5 /* Toshiba Qosmio Interal DVB-T/Analog*/
84 #define CX18_CARD_LEADTEK_PVR2100     6 /* Leadtek WinFast PVR2100 */
85 #define CX18_CARD_LAST                6
86
87 #define CX18_ENC_STREAM_TYPE_MPG  0
88 #define CX18_ENC_STREAM_TYPE_TS   1
89 #define CX18_ENC_STREAM_TYPE_YUV  2
90 #define CX18_ENC_STREAM_TYPE_VBI  3
91 #define CX18_ENC_STREAM_TYPE_PCM  4
92 #define CX18_ENC_STREAM_TYPE_IDX  5
93 #define CX18_ENC_STREAM_TYPE_RAD  6
94 #define CX18_MAX_STREAMS          7
95
96 /* system vendor and device IDs */
97 #define PCI_VENDOR_ID_CX      0x14f1
98 #define PCI_DEVICE_ID_CX23418 0x5b7a
99
100 /* subsystem vendor ID */
101 #define CX18_PCI_ID_HAUPPAUGE           0x0070
102 #define CX18_PCI_ID_COMPRO              0x185b
103 #define CX18_PCI_ID_YUAN                0x12ab
104 #define CX18_PCI_ID_CONEXANT            0x14f1
105 #define CX18_PCI_ID_TOSHIBA             0x1179
106 #define CX18_PCI_ID_LEADTEK             0x107D
107
108 /* ======================================================================== */
109 /* ========================== START USER SETTABLE DMA VARIABLES =========== */
110 /* ======================================================================== */
111
112 /* DMA Buffers, Default size in MB allocated */
113 #define CX18_DEFAULT_ENC_TS_BUFFERS  1
114 #define CX18_DEFAULT_ENC_MPG_BUFFERS 2
115 #define CX18_DEFAULT_ENC_IDX_BUFFERS 1
116 #define CX18_DEFAULT_ENC_YUV_BUFFERS 2
117 #define CX18_DEFAULT_ENC_VBI_BUFFERS 1
118 #define CX18_DEFAULT_ENC_PCM_BUFFERS 1
119
120 /* i2c stuff */
121 #define I2C_CLIENTS_MAX 16
122
123 /* debugging */
124
125 /* Flag to turn on high volume debugging */
126 #define CX18_DBGFLG_WARN  (1 << 0)
127 #define CX18_DBGFLG_INFO  (1 << 1)
128 #define CX18_DBGFLG_API   (1 << 2)
129 #define CX18_DBGFLG_DMA   (1 << 3)
130 #define CX18_DBGFLG_IOCTL (1 << 4)
131 #define CX18_DBGFLG_FILE  (1 << 5)
132 #define CX18_DBGFLG_I2C   (1 << 6)
133 #define CX18_DBGFLG_IRQ   (1 << 7)
134 /* Flag to turn on high volume debugging */
135 #define CX18_DBGFLG_HIGHVOL (1 << 8)
136
137 /* NOTE: extra space before comma in 'cx->num , ## args' is required for
138    gcc-2.95, otherwise it won't compile. */
139 #define CX18_DEBUG(x, type, fmt, args...) \
140         do { \
141                 if ((x) & cx18_debug) \
142                         printk(KERN_INFO "cx18-%d " type ": " fmt, cx->num , ## args); \
143         } while (0)
144 #define CX18_DEBUG_WARN(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_WARN, "warning", fmt , ## args)
145 #define CX18_DEBUG_INFO(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_INFO, "info", fmt , ## args)
146 #define CX18_DEBUG_API(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_API, "api", fmt , ## args)
147 #define CX18_DEBUG_DMA(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_DMA, "dma", fmt , ## args)
148 #define CX18_DEBUG_IOCTL(fmt, args...) CX18_DEBUG(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
149 #define CX18_DEBUG_FILE(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_FILE, "file", fmt , ## args)
150 #define CX18_DEBUG_I2C(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
151 #define CX18_DEBUG_IRQ(fmt, args...)   CX18_DEBUG(CX18_DBGFLG_IRQ, "irq", fmt , ## args)
152
153 #define CX18_DEBUG_HIGH_VOL(x, type, fmt, args...) \
154         do { \
155                 if (((x) & cx18_debug) && (cx18_debug & CX18_DBGFLG_HIGHVOL)) \
156                         printk(KERN_INFO "cx18%d " type ": " fmt, cx->num , ## args); \
157         } while (0)
158 #define CX18_DEBUG_HI_WARN(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_WARN, "warning", fmt , ## args)
159 #define CX18_DEBUG_HI_INFO(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_INFO, "info", fmt , ## args)
160 #define CX18_DEBUG_HI_API(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_API, "api", fmt , ## args)
161 #define CX18_DEBUG_HI_DMA(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_DMA, "dma", fmt , ## args)
162 #define CX18_DEBUG_HI_IOCTL(fmt, args...) CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IOCTL, "ioctl", fmt , ## args)
163 #define CX18_DEBUG_HI_FILE(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_FILE, "file", fmt , ## args)
164 #define CX18_DEBUG_HI_I2C(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_I2C, "i2c", fmt , ## args)
165 #define CX18_DEBUG_HI_IRQ(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IRQ, "irq", fmt , ## args)
166
167 /* Standard kernel messages */
168 #define CX18_ERR(fmt, args...)      printk(KERN_ERR  "cx18-%d: " fmt, cx->num , ## args)
169 #define CX18_WARN(fmt, args...)     printk(KERN_WARNING "cx18-%d: " fmt, cx->num , ## args)
170 #define CX18_INFO(fmt, args...)     printk(KERN_INFO "cx18-%d: " fmt, cx->num , ## args)
171
172 /* Values for CX18_API_DEC_PLAYBACK_SPEED mpeg_frame_type_mask parameter: */
173 #define MPEG_FRAME_TYPE_IFRAME 1
174 #define MPEG_FRAME_TYPE_IFRAME_PFRAME 3
175 #define MPEG_FRAME_TYPE_ALL 7
176
177 #define CX18_MAX_PGM_INDEX (400)
178
179 extern int cx18_retry_mmio;     /* enable check & retry of mmio accesses */
180 extern int cx18_debug;
181
182
183 struct cx18_options {
184         int megabytes[CX18_MAX_STREAMS]; /* Size in megabytes of each stream */
185         int cardtype;           /* force card type on load */
186         int tuner;              /* set tuner on load */
187         int radio;              /* enable/disable radio */
188         unsigned long mmio_ndelay; /* delay in ns after every PCI mmio access */
189 };
190
191 /* per-buffer bit flags */
192 #define CX18_F_B_NEED_BUF_SWAP  0       /* this buffer should be byte swapped */
193
194 /* per-stream, s_flags */
195 #define CX18_F_S_CLAIMED        3       /* this stream is claimed */
196 #define CX18_F_S_STREAMING      4       /* the fw is decoding/encoding this stream */
197 #define CX18_F_S_INTERNAL_USE   5       /* this stream is used internally (sliced VBI processing) */
198 #define CX18_F_S_STREAMOFF      7       /* signal end of stream EOS */
199 #define CX18_F_S_APPL_IO        8       /* this stream is used read/written by an application */
200
201 /* per-cx18, i_flags */
202 #define CX18_F_I_LOADED_FW              0       /* Loaded firmware 1st time */
203 #define CX18_F_I_EOS                    4       /* End of encoder stream */
204 #define CX18_F_I_RADIO_USER             5       /* radio tuner is selected */
205 #define CX18_F_I_ENC_PAUSED             13      /* the encoder is paused */
206 #define CX18_F_I_INITED                 21      /* set after first open */
207 #define CX18_F_I_FAILED                 22      /* set if first open failed */
208
209 /* These are the VBI types as they appear in the embedded VBI private packets. */
210 #define CX18_SLICED_TYPE_TELETEXT_B     (1)
211 #define CX18_SLICED_TYPE_CAPTION_525    (4)
212 #define CX18_SLICED_TYPE_WSS_625        (5)
213 #define CX18_SLICED_TYPE_VPS            (7)
214
215 struct cx18_buffer {
216         struct list_head list;
217         dma_addr_t dma_handle;
218         u32 id;
219         unsigned long b_flags;
220         char *buf;
221
222         u32 bytesused;
223         u32 readpos;
224 };
225
226 struct cx18_queue {
227         struct list_head list;
228         atomic_t buffers;
229         u32 bytesused;
230 };
231
232 struct cx18_dvb {
233         struct dmx_frontend hw_frontend;
234         struct dmx_frontend mem_frontend;
235         struct dmxdev dmxdev;
236         struct dvb_adapter dvb_adapter;
237         struct dvb_demux demux;
238         struct dvb_frontend *fe;
239         struct dvb_net dvbnet;
240         int enabled;
241         int feeding;
242         struct mutex feedlock;
243 };
244
245 struct cx18;     /* forward reference */
246 struct cx18_scb; /* forward reference */
247
248 #define CX18_MAX_MDL_ACKS 2
249 #define CX18_MAX_EPU_WORK_ORDERS 70 /* CPU_DE_RELEASE_MDL bursts 63 commands */
250
251 struct cx18_epu_work_order {
252         struct work_struct work;
253         atomic_t pending;
254         struct cx18 *cx;
255         int rpu;
256         struct cx18_mailbox mb;
257         struct cx18_mdl_ack mdl_ack[CX18_MAX_MDL_ACKS];
258         char *str;
259 };
260
261 #define CX18_INVALID_TASK_HANDLE 0xffffffff
262
263 struct cx18_stream {
264         /* These first four fields are always set, even if the stream
265            is not actually created. */
266         struct video_device *v4l2dev;   /* NULL when stream not created */
267         struct cx18 *cx;                /* for ease of use */
268         const char *name;               /* name of the stream */
269         int type;                       /* stream type */
270         u32 handle;                     /* task handle */
271         unsigned mdl_offset;
272
273         u32 id;
274         struct mutex qlock;     /* locks access to the queues */
275         unsigned long s_flags;  /* status flags, see above */
276         int dma;                /* can be PCI_DMA_TODEVICE,
277                                    PCI_DMA_FROMDEVICE or
278                                    PCI_DMA_NONE */
279         u64 dma_pts;
280         wait_queue_head_t waitq;
281
282         /* Buffer Stats */
283         u32 buffers;
284         u32 buf_size;
285
286         /* Buffer Queues */
287         struct cx18_queue q_free;       /* free buffers */
288         struct cx18_queue q_full;       /* full buffers */
289         struct cx18_queue q_io;         /* waiting for I/O */
290
291         /* DVB / Digital Transport */
292         struct cx18_dvb dvb;
293 };
294
295 struct cx18_open_id {
296         u32 open_id;
297         int type;
298         enum v4l2_priority prio;
299         struct cx18 *cx;
300 };
301
302 /* forward declaration of struct defined in cx18-cards.h */
303 struct cx18_card;
304
305
306 #define CX18_VBI_FRAMES 32
307
308 /* VBI data */
309 struct vbi_info {
310         u32 enc_size;
311         u32 frame;
312         u8 cc_data_odd[256];
313         u8 cc_data_even[256];
314         int cc_pos;
315         u8 cc_no_update;
316         u8 vps[5];
317         u8 vps_found;
318         int wss;
319         u8 wss_found;
320         u8 wss_no_update;
321         u32 raw_decoder_line_size;
322         u8 raw_decoder_sav_odd_field;
323         u8 raw_decoder_sav_even_field;
324         u32 sliced_decoder_line_size;
325         u8 sliced_decoder_sav_odd_field;
326         u8 sliced_decoder_sav_even_field;
327         struct v4l2_format in;
328         /* convenience pointer to sliced struct in vbi_in union */
329         struct v4l2_sliced_vbi_format *sliced_in;
330         u32 service_set_in;
331         int insert_mpeg;
332
333         /* Buffer for the maximum of 2 * 18 * packet_size sliced VBI lines.
334            One for /dev/vbi0 and one for /dev/vbi8 */
335         struct v4l2_sliced_vbi_data sliced_data[36];
336
337         /* Buffer for VBI data inserted into MPEG stream.
338            The first byte is a dummy byte that's never used.
339            The next 16 bytes contain the MPEG header for the VBI data,
340            the remainder is the actual VBI data.
341            The max size accepted by the MPEG VBI reinsertion turns out
342            to be 1552 bytes, which happens to be 4 + (1 + 42) * (2 * 18) bytes,
343            where 4 is a four byte header, 42 is the max sliced VBI payload, 1 is
344            a single line header byte and 2 * 18 is the number of VBI lines per frame.
345
346            However, it seems that the data must be 1K aligned, so we have to
347            pad the data until the 1 or 2 K boundary.
348
349            This pointer array will allocate 2049 bytes to store each VBI frame. */
350         u8 *sliced_mpeg_data[CX18_VBI_FRAMES];
351         u32 sliced_mpeg_size[CX18_VBI_FRAMES];
352         struct cx18_buffer sliced_mpeg_buf;
353         u32 inserted_frame;
354
355         u32 start[2], count;
356         u32 raw_size;
357         u32 sliced_size;
358 };
359
360 /* Per cx23418, per I2C bus private algo callback data */
361 struct cx18_i2c_algo_callback_data {
362         struct cx18 *cx;
363         int bus_index;   /* 0 or 1 for the cx23418's 1st or 2nd I2C bus */
364 };
365
366 #define CX18_MAX_MMIO_WR_RETRIES 10
367 #define CX18_MAX_MMIO_RD_RETRIES  2
368
369 struct cx18_mmio_stats {
370         atomic_t retried_write[CX18_MAX_MMIO_WR_RETRIES+1];
371         atomic_t retried_read[CX18_MAX_MMIO_RD_RETRIES+1];
372 };
373
374 #define CX18_MAX_MB_ACK_DELAY 100
375
376 struct cx18_mbox_stats {
377         atomic_t mb_ack_delay[CX18_MAX_MB_ACK_DELAY+1];
378 };
379
380 /* Struct to hold info about cx18 cards */
381 struct cx18 {
382         int num;                /* board number, -1 during init! */
383         char name[8];           /* board name for printk and interrupts (e.g. 'cx180') */
384         struct pci_dev *dev;    /* PCI device */
385         const struct cx18_card *card;   /* card information */
386         const char *card_name;  /* full name of the card */
387         const struct cx18_card_tuner_i2c *card_i2c; /* i2c addresses to probe for tuner */
388         u8 is_50hz;
389         u8 is_60hz;
390         u8 is_out_50hz;
391         u8 is_out_60hz;
392         u8 nof_inputs;          /* number of video inputs */
393         u8 nof_audio_inputs;    /* number of audio inputs */
394         u16 buffer_id;          /* buffer ID counter */
395         u32 v4l2_cap;           /* V4L2 capabilities of card */
396         u32 hw_flags;           /* Hardware description of the board */
397         unsigned mdl_offset;
398         struct cx18_scb __iomem *scb; /* pointer to SCB */
399         struct mutex epu2apu_mb_lock; /* protect driver to chip mailbox in SCB*/
400         struct mutex epu2cpu_mb_lock; /* protect driver to chip mailbox in SCB*/
401
402         struct cx18_av_state av_state;
403
404         /* codec settings */
405         struct cx2341x_mpeg_params params;
406         u32 filter_mode;
407         u32 temporal_strength;
408         u32 spatial_strength;
409
410         /* dualwatch */
411         unsigned long dualwatch_jiffies;
412         u16 dualwatch_stereo_mode;
413
414         /* Digitizer type */
415         int digitizer;          /* 0x00EF = saa7114 0x00FO = saa7115 0x0106 = mic */
416
417         struct mutex serialize_lock;    /* mutex used to serialize open/close/start/stop/ioctl operations */
418         struct cx18_options options;    /* User options */
419         int stream_buf_size[CX18_MAX_STREAMS]; /* Stream buffer size */
420         struct cx18_stream streams[CX18_MAX_STREAMS];   /* Stream data */
421         unsigned long i_flags;  /* global cx18 flags */
422         atomic_t ana_capturing; /* count number of active analog capture streams */
423         atomic_t tot_capturing; /* total count number of active capture streams */
424         spinlock_t lock;        /* lock access to this struct */
425         int search_pack_header;
426
427         int open_id;            /* incremented each time an open occurs, used as
428                                    unique ID. Starts at 1, so 0 can be used as
429                                    uninitialized value in the stream->id. */
430
431         u32 base_addr;
432         struct v4l2_prio_state prio;
433
434         u8 card_rev;
435         void __iomem *enc_mem, *reg_mem;
436
437         struct vbi_info vbi;
438
439         u32 pgm_info_offset;
440         u32 pgm_info_num;
441         u32 pgm_info_write_idx;
442         u32 pgm_info_read_idx;
443         struct v4l2_enc_idx_entry pgm_info[CX18_MAX_PGM_INDEX];
444
445         u64 mpg_data_received;
446         u64 vbi_data_inserted;
447
448         wait_queue_head_t mb_apu_waitq;
449         wait_queue_head_t mb_cpu_waitq;
450         wait_queue_head_t cap_w;
451         /* when the current DMA is finished this queue is woken up */
452         wait_queue_head_t dma_waitq;
453
454         struct cx18_epu_work_order epu_work_order[CX18_MAX_EPU_WORK_ORDERS];
455         char epu_debug_str[256]; /* CX18_EPU_DEBUG is rare: use shared space */
456
457         /* i2c */
458         struct i2c_adapter i2c_adap[2];
459         struct i2c_algo_bit_data i2c_algo[2];
460         struct cx18_i2c_algo_callback_data i2c_algo_cb_data[2];
461         struct i2c_client i2c_client[2];
462         struct mutex i2c_bus_lock[2];
463         struct i2c_client *i2c_clients[I2C_CLIENTS_MAX];
464
465         /* gpio */
466         u32 gpio_dir;
467         u32 gpio_val;
468         struct mutex gpio_lock;
469
470         /* Statistics */
471         struct cx18_mmio_stats mmio_stats;
472         struct cx18_mbox_stats mbox_stats;
473
474         /* v4l2 and User settings */
475
476         /* codec settings */
477         u32 audio_input;
478         u32 active_input;
479         u32 active_output;
480         v4l2_std_id std;
481         v4l2_std_id tuner_std;  /* The norm of the tuner (fixed) */
482 };
483
484 /* Globals */
485 extern struct cx18 *cx18_cards[];
486 extern int cx18_cards_active;
487 extern int cx18_first_minor;
488 extern spinlock_t cx18_cards_lock;
489 extern struct workqueue_struct *cx18_work_queue;
490
491 /*==============Prototypes==================*/
492
493 /* Return non-zero if a signal is pending */
494 int cx18_msleep_timeout(unsigned int msecs, int intr);
495
496 /* Read Hauppauge eeprom */
497 struct tveeprom; /* forward reference */
498 void cx18_read_eeprom(struct cx18 *cx, struct tveeprom *tv);
499
500 /* First-open initialization: load firmware, etc. */
501 int cx18_init_on_first_open(struct cx18 *cx);
502
503 #endif /* CX18_DRIVER_H */