drivers/media/usb/hdpvr/hdpvr.h

   1 /*
   2  * Hauppauge HD PVR USB driver
   3  *
   4  * Copyright (C) 2008      Janne Grunau (j@jannau.net)
   5  *
   6  *      This program is free software; you can redistribute it and/or
   7  *      modify it under the terms of the GNU General Public License as
   8  *      published by the Free Software Foundation, version 2.
   9  *
  10  */
  11
  12 #include <linux/usb.h>
  13 #include <linux/i2c.h>
  14 #include <linux/mutex.h>
  15 #include <linux/workqueue.h>
  16 #include <linux/videodev2.h>
  17
  18 #include <media/v4l2-device.h>
  19 #include <media/v4l2-ctrls.h>
  20 #include <media/ir-kbd-i2c.h>
  21
  22 #define HDPVR_MAX 8
  23 #define HDPVR_I2C_MAX_SIZE 128
  24
  25 /* Define these values to match your devices */
  26 #define HD_PVR_VENDOR_ID        0x2040
  27 #define HD_PVR_PRODUCT_ID       0x4900
  28 #define HD_PVR_PRODUCT_ID1      0x4901
  29 #define HD_PVR_PRODUCT_ID2      0x4902
  30 #define HD_PVR_PRODUCT_ID4      0x4903
  31 #define HD_PVR_PRODUCT_ID3      0x4982
  32
  33 #define UNSET    (-1U)
  34
  35 #define NUM_BUFFERS 64
  36
  37 #define HDPVR_FIRMWARE_VERSION          0x08
  38 #define HDPVR_FIRMWARE_VERSION_AC3      0x0d
  39 #define HDPVR_FIRMWARE_VERSION_0X12     0x12
  40 #define HDPVR_FIRMWARE_VERSION_0X15     0x15
  41 #define HDPVR_FIRMWARE_VERSION_0X1E     0x1e
  42
  43 /* #define HDPVR_DEBUG */
  44
  45 extern int hdpvr_debug;
  46
  47 #define MSG_INFO        1
  48 #define MSG_BUFFER      2
  49
  50 struct hdpvr_options {
  51         u8      video_std;
  52         u8      video_input;
  53         u8      audio_input;
  54         u8      bitrate;        /* in 100kbps */
  55         u8      peak_bitrate;   /* in 100kbps */
  56         u8      bitrate_mode;
  57         u8      gop_mode;
  58         enum v4l2_mpeg_audio_encoding   audio_codec;
  59         u8      brightness;
  60         u8      contrast;
  61         u8      hue;
  62         u8      saturation;
  63         u8      sharpness;
  64 };
  65
  66 /* Structure to hold all of our device specific stuff */
  67 struct hdpvr_device {
  68         /* the v4l device for this device */
  69         struct video_device     *video_dev;
  70         /* the control handler for this device */
  71         struct v4l2_ctrl_handler hdl;
  72         /* the usb device for this device */
  73         struct usb_device       *udev;
  74         /* v4l2-device unused */
  75         struct v4l2_device      v4l2_dev;
  76         struct { /* video mode/bitrate control cluster */
  77                 struct v4l2_ctrl *video_mode;
  78                 struct v4l2_ctrl *video_bitrate;
  79                 struct v4l2_ctrl *video_bitrate_peak;
  80         };
  81         /* v4l2 format */
  82         uint width, height;
  83
  84         /* the max packet size of the bulk endpoint */
  85         size_t                  bulk_in_size;
  86         /* the address of the bulk in endpoint */
  87         __u8                    bulk_in_endpointAddr;
  88
  89         /* holds the current device status */
  90         __u8                    status;
  91
  92         /* holds the current set options */
  93         struct hdpvr_options    options;
  94         v4l2_std_id             cur_std;
  95         struct v4l2_dv_timings  cur_dv_timings;
  96
  97         uint                    flags;
  98
  99         /* synchronize I/O */
 100         struct mutex            io_mutex;
 101         /* available buffers */
 102         struct list_head        free_buff_list;
 103         /* in progress buffers */
 104         struct list_head        rec_buff_list;
 105         /* waitqueue for buffers */
 106         wait_queue_head_t       wait_buffer;
 107         /* waitqueue for data */
 108         wait_queue_head_t       wait_data;
 109         /**/
 110         struct workqueue_struct *workqueue;
 111         /**/
 112         struct work_struct      worker;
 113         /* current stream owner */
 114         struct v4l2_fh          *owner;
 115
 116         /* I2C adapter */
 117         struct i2c_adapter      i2c_adapter;
 118         /* I2C lock */
 119         struct mutex            i2c_mutex;
 120         /* I2C message buffer space */
 121         char                    i2c_buf[HDPVR_I2C_MAX_SIZE];
 122
 123         /* For passing data to ir-kbd-i2c */
 124         struct IR_i2c_init_data ir_i2c_init_data;
 125
 126         /* usb control transfer buffer and lock */
 127         struct mutex            usbc_mutex;
 128         u8                      *usbc_buf;
 129         u8                      fw_ver;
 130 };
 131
 132 static inline struct hdpvr_device *to_hdpvr_dev(struct v4l2_device *v4l2_dev)
 133 {
 134         return container_of(v4l2_dev, struct hdpvr_device, v4l2_dev);
 135 }
 136
 137
 138 /* buffer one bulk urb of data */
 139 struct hdpvr_buffer {
 140         struct list_head        buff_list;
 141
 142         struct urb              *urb;
 143
 144         struct hdpvr_device     *dev;
 145
 146         uint                    pos;
 147
 148         __u8                    status;
 149 };
 150
 151 /* */
 152
 153 struct hdpvr_video_info {
 154         u16     width;
 155         u16     height;
 156         u8      fps;
 157         bool    valid;
 158 };
 159
 160 enum {
 161         STATUS_UNINITIALIZED    = 0,
 162         STATUS_IDLE,
 163         STATUS_STARTING,
 164         STATUS_SHUTTING_DOWN,
 165         STATUS_STREAMING,
 166         STATUS_ERROR,
 167         STATUS_DISCONNECTED,
 168 };
 169
 170 enum {
 171         HDPVR_FLAG_AC3_CAP = 1,
 172 };
 173
 174 enum {
 175         BUFSTAT_UNINITIALIZED = 0,
 176         BUFSTAT_AVAILABLE,
 177         BUFSTAT_INPROGRESS,
 178         BUFSTAT_READY,
 179 };
 180
 181 #define CTRL_START_STREAMING_VALUE      0x0700
 182 #define CTRL_STOP_STREAMING_VALUE       0x0800
 183 #define CTRL_BITRATE_VALUE              0x1000
 184 #define CTRL_BITRATE_MODE_VALUE         0x1200
 185 #define CTRL_GOP_MODE_VALUE             0x1300
 186 #define CTRL_VIDEO_INPUT_VALUE          0x1500
 187 #define CTRL_VIDEO_STD_TYPE             0x1700
 188 #define CTRL_AUDIO_INPUT_VALUE          0x2500
 189 #define CTRL_BRIGHTNESS                 0x2900
 190 #define CTRL_CONTRAST                   0x2a00
 191 #define CTRL_HUE                        0x2b00
 192 #define CTRL_SATURATION                 0x2c00
 193 #define CTRL_SHARPNESS                  0x2d00
 194 #define CTRL_LOW_PASS_FILTER_VALUE      0x3100
 195
 196 #define CTRL_DEFAULT_INDEX              0x0003
 197
 198
 199         /* :0 s 38 01 1000 0003 0004 4 = 0a00ca00
 200          * BITRATE SETTING
 201          *   1st and 2nd byte (little endian): average bitrate in 100 000 bit/s
 202          *                                     min: 1 mbit/s, max: 13.5 mbit/s
 203          *   3rd and 4th byte (little endian): peak bitrate in 100 000 bit/s
 204          *                                     min: average + 100kbit/s,
 205          *                                      max: 20.2 mbit/s
 206          */
 207
 208         /* :0 s 38 01 1200 0003 0001 1 = 02
 209          * BIT RATE MODE
 210          *  constant = 1, variable (peak) = 2, variable (average) = 3
 211          */
 212
 213         /* :0 s 38 01 1300 0003 0001 1 = 03
 214          * GOP MODE (2 bit)
 215          *    low bit 0/1: advanced/simple GOP
 216          *   high bit 0/1: IDR(4/32/128) / no IDR (4/32/0)
 217          */
 218
 219         /* :0 s 38 01 1700 0003 0001 1 = 00
 220          * VIDEO STANDARD or FREQUNCY 0 = 60hz, 1 = 50hz
 221          */
 222
 223         /* :0 s 38 01 3100 0003 0004 4 = 03030000
 224          * FILTER CONTROL
 225          *   1st byte luma low pass filter strength,
 226          *   2nd byte chroma low pass filter strength,
 227          *   3rd byte MF enable chroma, min=0, max=1
 228          *   4th byte n
 229          */
 230
 231
 232         /* :0 s 38 b9 0001 0000 0000 0 */
 233
 234
 235
 236 /* :0 s 38 d3 0000 0000 0001 1 = 00 */
 237 /*              ret = usb_control_msg(dev->udev, */
 238 /*                                    usb_sndctrlpipe(dev->udev, 0), */
 239 /*                                    0xd3, 0x38, */
 240 /*                                    0, 0, */
 241 /*                                    "\0", 1, */
 242 /*                                    1000); */
 243
 244 /*              info("control request returned %d", ret); */
 245 /*              msleep(5000); */
 246
 247
 248         /* :0 s b8 81 1400 0003 0005 5 <
 249          * :0 0 5 = d0024002 19
 250          * QUERY FRAME SIZE AND RATE
 251          *   1st and 2nd byte (little endian): horizontal resolution
 252          *   3rd and 4th byte (little endian): vertical resolution
 253          *   5th byte: frame rate
 254          */
 255
 256         /* :0 s b8 81 1800 0003 0003 3 <
 257          * :0 0 3 = 030104
 258          * QUERY SIGNAL AND DETECTED LINES, maybe INPUT
 259          */
 260
 261 enum hdpvr_video_std {
 262         HDPVR_60HZ = 0,
 263         HDPVR_50HZ,
 264 };
 265
 266 enum hdpvr_video_input {
 267         HDPVR_COMPONENT = 0,
 268         HDPVR_SVIDEO,
 269         HDPVR_COMPOSITE,
 270         HDPVR_VIDEO_INPUTS
 271 };
 272
 273 enum hdpvr_audio_inputs {
 274         HDPVR_RCA_BACK = 0,
 275         HDPVR_RCA_FRONT,
 276         HDPVR_SPDIF,
 277         HDPVR_AUDIO_INPUTS
 278 };
 279
 280 enum hdpvr_bitrate_mode {
 281         HDPVR_CONSTANT = 1,
 282         HDPVR_VARIABLE_PEAK,
 283         HDPVR_VARIABLE_AVERAGE,
 284 };
 285
 286 enum hdpvr_gop_mode {
 287         HDPVR_ADVANCED_IDR_GOP = 0,
 288         HDPVR_SIMPLE_IDR_GOP,
 289         HDPVR_ADVANCED_NOIDR_GOP,
 290         HDPVR_SIMPLE_NOIDR_GOP,
 291 };
 292
 293 void hdpvr_delete(struct hdpvr_device *dev);
 294
 295 /*========================================================================*/
 296 /* hardware control functions */
 297 int hdpvr_set_options(struct hdpvr_device *dev);
 298
 299 int hdpvr_set_bitrate(struct hdpvr_device *dev);
 300
 301 int hdpvr_set_audio(struct hdpvr_device *dev, u8 input,
 302                     enum v4l2_mpeg_audio_encoding codec);
 303
 304 int hdpvr_config_call(struct hdpvr_device *dev, uint value,
 305                       unsigned char valbuf);
 306
 307 int get_video_info(struct hdpvr_device *dev, struct hdpvr_video_info *vid_info);
 308
 309 /* :0 s b8 81 1800 0003 0003 3 < */
 310 /* :0 0 3 = 0301ff */
 311 int get_input_lines_info(struct hdpvr_device *dev);
 312
 313
 314 /*========================================================================*/
 315 /* v4l2 registration */
 316 int hdpvr_register_videodev(struct hdpvr_device *dev, struct device *parent,
 317                             int devnumber);
 318
 319 int hdpvr_cancel_queue(struct hdpvr_device *dev);
 320
 321 /*========================================================================*/
 322 /* i2c adapter registration */
 323 int hdpvr_register_i2c_adapter(struct hdpvr_device *dev);
 324
 325 struct i2c_client *hdpvr_register_ir_rx_i2c(struct hdpvr_device *dev);
 326 struct i2c_client *hdpvr_register_ir_tx_i2c(struct hdpvr_device *dev);
 327
 328 /*========================================================================*/
 329 /* buffer management */
 330 int hdpvr_free_buffers(struct hdpvr_device *dev);
 331 int hdpvr_alloc_buffers(struct hdpvr_device *dev, uint count);