V4L/DVB (10757): cx18, v4l2-chip-ident: Finish conversion of AV decoder core to v4l2_...
[safe/jmp/linux-2.6] / drivers / media / video / cx18 / cx18-driver.h
index 316ff33..4b50878 100644 (file)
@@ -48,6 +48,7 @@
 #include <linux/dvb/audio.h>
 #include <media/v4l2-common.h>
 #include <media/v4l2-ioctl.h>
+#include <media/v4l2-device.h>
 #include <media/tuner.h>
 #include "cx18-mailbox.h"
 #include "cx18-av-core.h"
@@ -79,7 +80,7 @@
 #define CX18_CARD_YUAN_MPC718        3 /* Yuan MPC718 */
 #define CX18_CARD_CNXT_RAPTOR_PAL     4        /* Conexant Raptor PAL */
 #define CX18_CARD_TOSHIBA_QOSMIO_DVBT 5 /* Toshiba Qosmio Interal DVB-T/Analog*/
-#define CX18_CARD_LEADTEK_PVR2100     6 /* Leadtek WinFast PVR2100 */
+#define CX18_CARD_LEADTEK_PVR2100     6 /* Leadtek WinFast PVR2100/DVR3100 H */
 #define CX18_CARD_LAST                       6
 
 #define CX18_ENC_STREAM_TYPE_MPG  0
 /* Flag to turn on high volume debugging */
 #define CX18_DBGFLG_HIGHVOL (1 << 8)
 
-/* NOTE: extra space before comma in 'cx->num , ## args' is required for
+/* NOTE: extra space before comma in 'fmt , ## args' is required for
    gcc-2.95, otherwise it won't compile. */
 #define CX18_DEBUG(x, type, fmt, args...) \
        do { \
                if ((x) & cx18_debug) \
-                       printk(KERN_INFO "cx18-%d " type ": " fmt, cx->num , ## args); \
+                       v4l2_info(&cx->v4l2_dev, " " type ": " fmt , ## args); \
        } while (0)
 #define CX18_DEBUG_WARN(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_WARN, "warning", fmt , ## args)
 #define CX18_DEBUG_INFO(fmt, args...)  CX18_DEBUG(CX18_DBGFLG_INFO, "info", fmt , ## args)
 #define CX18_DEBUG_HIGH_VOL(x, type, fmt, args...) \
        do { \
                if (((x) & cx18_debug) && (cx18_debug & CX18_DBGFLG_HIGHVOL)) \
-                       printk(KERN_INFO "cx18%d " type ": " fmt, cx->num , ## args); \
+                       v4l2_info(&cx->v4l2_dev, " " type ": " fmt , ## args); \
        } while (0)
 #define CX18_DEBUG_HI_WARN(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_WARN, "warning", fmt , ## args)
 #define CX18_DEBUG_HI_INFO(fmt, args...)  CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_INFO, "info", fmt , ## args)
 #define CX18_DEBUG_HI_IRQ(fmt, args...)   CX18_DEBUG_HIGH_VOL(CX18_DBGFLG_IRQ, "irq", fmt , ## args)
 
 /* Standard kernel messages */
-#define CX18_ERR(fmt, args...)      printk(KERN_ERR  "cx18-%d: " fmt, cx->num , ## args)
-#define CX18_WARN(fmt, args...)     printk(KERN_WARNING "cx18-%d: " fmt, cx->num , ## args)
-#define CX18_INFO(fmt, args...)     printk(KERN_INFO "cx18-%d: " fmt, cx->num , ## args)
+#define CX18_ERR(fmt, args...)      v4l2_err(&cx->v4l2_dev, fmt , ## args)
+#define CX18_WARN(fmt, args...)     v4l2_warn(&cx->v4l2_dev, fmt , ## args)
+#define CX18_INFO(fmt, args...)     v4l2_info(&cx->v4l2_dev, fmt , ## args)
 
 /* Values for CX18_API_DEC_PLAYBACK_SPEED mpeg_frame_type_mask parameter: */
 #define MPEG_FRAME_TYPE_IFRAME 1
@@ -292,7 +293,6 @@ struct cx18_stream {
        int dma;                /* can be PCI_DMA_TODEVICE,
                                   PCI_DMA_FROMDEVICE or
                                   PCI_DMA_NONE */
-       u64 dma_pts;
        wait_queue_head_t waitq;
 
        /* Buffer Stats */
@@ -318,59 +318,121 @@ struct cx18_open_id {
 /* forward declaration of struct defined in cx18-cards.h */
 struct cx18_card;
 
+/*
+ * A note about "sliced" VBI data as implemented in this driver:
+ *
+ * Currently we collect the sliced VBI in the form of Ancillary Data
+ * packets, inserted by the AV core decoder/digitizer/slicer in the
+ * horizontal blanking region of the VBI lines, in "raw" mode as far as
+ * the Encoder is concerned.  We don't ever tell the Encoder itself
+ * to provide sliced VBI. (AV Core: sliced mode - Encoder: raw mode)
+ *
+ * We then process the ancillary data ourselves to send the sliced data
+ * to the user application directly or build up MPEG-2 private stream 1
+ * packets to splice into (only!) MPEG-2 PS streams for the user app.
+ *
+ * (That's how ivtv essentially does it.)
+ *
+ * The Encoder should be able to extract certain sliced VBI data for
+ * us and provide it in a separate stream or splice it into any type of
+ * MPEG PS or TS stream, but this isn't implemented yet.
+ */
+
+/*
+ * Number of "raw" VBI samples per horizontal line we tell the Encoder to
+ * grab from the decoder/digitizer/slicer output for raw or sliced VBI.
+ * It depends on the pixel clock and the horiz rate:
+ *
+ * (1/Fh)*(2*Fp) = Samples/line
+ *     = 4 bytes EAV + Anc data in hblank + 4 bytes SAV + active samples
+ *
+ *  Sliced VBI data is sent as ancillary data during horizontal blanking
+ *  Raw VBI is sent as active video samples during vertcal blanking
+ *
+ *  We use a  BT.656 pxiel clock of 13.5 MHz and a BT.656 active line
+ *  length of 720 pixels @ 4:2:2 sampling.  Thus...
+ *
+ *  For systems that use a 15.734 kHz horizontal rate, such as
+ *  NTSC-M, PAL-M, PAL-60, and other 60 Hz/525 line systems, we have:
+ *
+ *  (1/15.734 kHz) * 2 * 13.5 MHz = 1716 samples/line =
+ *  4 bytes SAV + 268 bytes anc data + 4 bytes SAV + 1440 active samples
+ *
+ *  For systems that use a 15.625 kHz horizontal rate, such as
+ *  PAL-B/G/H, PAL-I, SECAM-L and other 50 Hz/625 line systems, we have:
+ *
+ *  (1/15.625 kHz) * 2 * 13.5 MHz = 1728 samples/line =
+ *  4 bytes SAV + 280 bytes anc data + 4 bytes SAV + 1440 active samples
+ */
+static const u32 vbi_active_samples = 1444; /* 4 byte SAV + 720 Y + 720 U/V */
+static const u32 vbi_hblank_samples_60Hz = 272; /* 4 byte EAV + 268 anc/fill */
+static const u32 vbi_hblank_samples_50Hz = 284; /* 4 byte EAV + 280 anc/fill */
 
 #define CX18_VBI_FRAMES 32
 
-/* VBI data */
 struct vbi_info {
-       u32 enc_size;
-       u32 frame;
-       u8 cc_data_odd[256];
-       u8 cc_data_even[256];
-       int cc_pos;
-       u8 cc_no_update;
-       u8 vps[5];
-       u8 vps_found;
-       int wss;
-       u8 wss_found;
-       u8 wss_no_update;
-       u32 raw_decoder_line_size;
-       u8 raw_decoder_sav_odd_field;
-       u8 raw_decoder_sav_even_field;
-       u32 sliced_decoder_line_size;
-       u8 sliced_decoder_sav_odd_field;
-       u8 sliced_decoder_sav_even_field;
+       /* Current state of v4l2 VBI settings for this device */
        struct v4l2_format in;
-       /* convenience pointer to sliced struct in vbi_in union */
-       struct v4l2_sliced_vbi_format *sliced_in;
-       u32 service_set_in;
-       int insert_mpeg;
+       struct v4l2_sliced_vbi_format *sliced_in; /* pointer to in.fmt.sliced */
+       u32 count;    /* Count of VBI data lines: 60 Hz: 12 or 50 Hz: 18 */
+       u32 start[2]; /* First VBI data line per field: 10 & 273 or 6 & 318 */
 
-       /* Buffer for the maximum of 2 * 18 * packet_size sliced VBI lines.
-          One for /dev/vbi0 and one for /dev/vbi8 */
-       struct v4l2_sliced_vbi_data sliced_data[36];
+       u32 frame; /* Count of VBI buffers/frames received from Encoder */
 
-       /* Buffer for VBI data inserted into MPEG stream.
-          The first byte is a dummy byte that's never used.
-          The next 16 bytes contain the MPEG header for the VBI data,
-          the remainder is the actual VBI data.
-          The max size accepted by the MPEG VBI reinsertion turns out
-          to be 1552 bytes, which happens to be 4 + (1 + 42) * (2 * 18) bytes,
-          where 4 is a four byte header, 42 is the max sliced VBI payload, 1 is
-          a single line header byte and 2 * 18 is the number of VBI lines per frame.
+       /*
+        * Vars for creation and insertion of MPEG Private Stream 1 packets
+        * of sliced VBI data into an MPEG PS
+        */
 
-          However, it seems that the data must be 1K aligned, so we have to
-          pad the data until the 1 or 2 K boundary.
+       /* Boolean: create and insert Private Stream 1 packets into the PS */
+       int insert_mpeg;
 
-          This pointer array will allocate 2049 bytes to store each VBI frame. */
+       /*
+        * Buffer for the maximum of 2 * 18 * packet_size sliced VBI lines.
+        * Used in cx18-vbi.c only for collecting sliced data, and as a source
+        * during conversion of sliced VBI data into MPEG Priv Stream 1 packets.
+        * We don't need to save state here, but the array may have been a bit
+        * too big (2304 bytes) to alloc from the stack.
+        */
+       struct v4l2_sliced_vbi_data sliced_data[36];
+
+       /*
+        * A ring buffer of driver-generated MPEG-2 PS
+        * Program Pack/Private Stream 1 packets for sliced VBI data insertion
+        * into the MPEG PS stream.
+        *
+        * In each sliced_mpeg_data[] buffer is:
+        *      16 byte MPEG-2 PS Program Pack Header
+        *      16 byte MPEG-2 Private Stream 1 PES Header
+        *       4 byte magic number: "itv0" or "ITV0"
+        *       4 byte first  field line mask, if "itv0"
+        *       4 byte second field line mask, if "itv0"
+        *      36 lines, if "ITV0"; or <36 lines, if "itv0"; of sliced VBI data
+        *
+        *      Each line in the payload is
+        *       1 byte line header derived from the SDID (WSS, CC, VPS, etc.)
+        *      42 bytes of line data
+        *
+        * That's a maximum 1552 bytes of payload in the Private Stream 1 packet
+        * which is the payload size a PVR-350 (CX23415) MPEG decoder will
+        * accept for VBI data. So, including the headers, it's a maximum 1584
+        * bytes total.
+        */
+#define CX18_SLICED_MPEG_DATA_MAXSZ    1584
+       /* copy_vbi_buf() needs 8 temp bytes on the end for the worst case */
+#define CX18_SLICED_MPEG_DATA_BUFSZ    (CX18_SLICED_MPEG_DATA_MAXSZ+8)
        u8 *sliced_mpeg_data[CX18_VBI_FRAMES];
        u32 sliced_mpeg_size[CX18_VBI_FRAMES];
-       struct cx18_buffer sliced_mpeg_buf;
+
+       /* Count of Program Pack/Program Stream 1 packets inserted into PS */
        u32 inserted_frame;
 
-       u32 start[2], count;
-       u32 raw_size;
-       u32 sliced_size;
+       /*
+        * A dummy driver stream transfer buffer with a copy of the next
+        * sliced_mpeg_data[] buffer for output to userland apps.
+        * Only used in cx18-fileops.c, but its state needs to persist at times.
+        */
+       struct cx18_buffer sliced_mpeg_buf;
 };
 
 /* Per cx23418, per I2C bus private algo callback data */
@@ -383,16 +445,18 @@ struct cx18_i2c_algo_callback_data {
 
 /* Struct to hold info about cx18 cards */
 struct cx18 {
-       int num;                /* board number, -1 during init! */
-       char name[8];           /* board name for printk and interrupts (e.g. 'cx180') */
+       int instance;
        struct pci_dev *pci_dev;
+       struct v4l2_device v4l2_dev;
+       struct v4l2_subdev *sd_av;
+
        const struct cx18_card *card;   /* card information */
        const char *card_name;  /* full name of the card */
        const struct cx18_card_tuner_i2c *card_i2c; /* i2c addresses to probe for tuner */
        u8 is_50hz;
        u8 is_60hz;
-       u8 is_out_50hz;
-       u8 is_out_60hz;
+       u8 is_out_50hz; /* FIXME - remove, we don't have an output decoder */
+       u8 is_out_60hz; /* FIXME - remove, we don't have an output decoder */
        u8 nof_inputs;          /* number of video inputs */
        u8 nof_audio_inputs;    /* number of audio inputs */
        u16 buffer_id;          /* buffer ID counter */
@@ -415,9 +479,6 @@ struct cx18 {
        unsigned long dualwatch_jiffies;
        u32 dualwatch_stereo_mode;
 
-       /* Digitizer type */
-       int digitizer;          /* 0x00EF = saa7114 0x00FO = saa7115 0x0106 = mic */
-
        struct mutex serialize_lock;    /* mutex used to serialize open/close/start/stop/ioctl operations */
        struct cx18_options options;    /* User options */
        int stream_buffers[CX18_MAX_STREAMS]; /* # of buffers for each stream */
@@ -426,7 +487,6 @@ struct cx18 {
        unsigned long i_flags;  /* global cx18 flags */
        atomic_t ana_capturing; /* count number of active analog capture streams */
        atomic_t tot_capturing; /* total count number of active capture streams */
-       spinlock_t lock;        /* lock access to this struct */
        int search_pack_header;
 
        int open_id;            /* incremented each time an open occurs, used as
@@ -487,11 +547,13 @@ struct cx18 {
        v4l2_std_id tuner_std;  /* The norm of the tuner (fixed) */
 };
 
+static inline struct cx18 *to_cx18(struct v4l2_device *v4l2_dev)
+{
+       return container_of(v4l2_dev, struct cx18, v4l2_dev);
+}
+
 /* Globals */
-extern struct cx18 *cx18_cards[];
-extern int cx18_cards_active;
 extern int cx18_first_minor;
-extern spinlock_t cx18_cards_lock;
 
 /*==============Prototypes==================*/