drivers/media/video/usbvision/usbvision.h

   1 /*
   2  * USBVISION.H
   3  *  usbvision header file
   4  *
   5  * Copyright (c) 1999-2005 Joerg Heckenbach <joerg@heckenbach-aw.de>
   6  *
   7  * This module is part of usbvision driver project.
   8  * Updates to driver completed by Dwaine P. Garden
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23  */
  24
  25
  26 #ifndef __LINUX_USBVISION_H
  27 #define __LINUX_USBVISION_H
  28
  29 #include <linux/list.h>
  30 #include <linux/usb.h>
  31 #include "usbvision-i2c.h"
  32
  33 #ifndef VID_HARDWARE_USBVISION
  34         #define VID_HARDWARE_USBVISION 34   /* USBVision Video Grabber */
  35 #endif
  36
  37 #define USBVISION_PWR_REG               0x00
  38         #define USBVISION_SSPND_EN              (1 << 1)
  39         #define USBVISION_RES2                  (1 << 2)
  40         #define USBVISION_PWR_VID               (1 << 5)
  41         #define USBVISION_E2_EN                 (1 << 7)
  42 #define USBVISION_CONFIG_REG            0x01
  43 #define USBVISION_ADRS_REG              0x02
  44 #define USBVISION_ALTER_REG             0x03
  45 #define USBVISION_FORCE_ALTER_REG       0x04
  46 #define USBVISION_STATUS_REG            0x05
  47 #define USBVISION_IOPIN_REG             0x06
  48         #define USBVISION_IO_1                  (1 << 0)
  49         #define USBVISION_IO_2                  (1 << 1)
  50         #define USBVISION_AUDIO_IN              0
  51         #define USBVISION_AUDIO_TV              1
  52         #define USBVISION_AUDIO_RADIO           2
  53         #define USBVISION_AUDIO_MUTE            3
  54 #define USBVISION_SER_MODE              0x07
  55 #define USBVISION_SER_ADRS              0x08
  56 #define USBVISION_SER_CONT              0x09
  57 #define USBVISION_SER_DAT1              0x0A
  58 #define USBVISION_SER_DAT2              0x0B
  59 #define USBVISION_SER_DAT3              0x0C
  60 #define USBVISION_SER_DAT4              0x0D
  61 #define USBVISION_EE_DATA               0x0E
  62 #define USBVISION_EE_LSBAD              0x0F
  63 #define USBVISION_EE_CONT               0x10
  64 #define USBVISION_DRM_CONT                      0x12
  65         #define USBVISION_REF                   (1 << 0)
  66         #define USBVISION_RES_UR                (1 << 2)
  67         #define USBVISION_RES_FDL               (1 << 3)
  68         #define USBVISION_RES_VDW               (1 << 4)
  69 #define USBVISION_DRM_PRM1              0x13
  70 #define USBVISION_DRM_PRM2              0x14
  71 #define USBVISION_DRM_PRM3              0x15
  72 #define USBVISION_DRM_PRM4              0x16
  73 #define USBVISION_DRM_PRM5              0x17
  74 #define USBVISION_DRM_PRM6              0x18
  75 #define USBVISION_DRM_PRM7              0x19
  76 #define USBVISION_DRM_PRM8              0x1A
  77 #define USBVISION_VIN_REG1              0x1B
  78         #define USBVISION_8_422_SYNC            0x01
  79         #define USBVISION_16_422_SYNC           0x02
  80         #define USBVISION_VSNC_POL              (1 << 3)
  81         #define USBVISION_HSNC_POL              (1 << 4)
  82         #define USBVISION_FID_POL               (1 << 5)
  83         #define USBVISION_HVALID_PO             (1 << 6)
  84         #define USBVISION_VCLK_POL              (1 << 7)
  85 #define USBVISION_VIN_REG2              0x1C
  86         #define USBVISION_AUTO_FID              (1 << 0)
  87         #define USBVISION_NONE_INTER            (1 << 1)
  88         #define USBVISION_NOHVALID              (1 << 2)
  89         #define USBVISION_UV_ID                 (1 << 3)
  90         #define USBVISION_FIX_2C                (1 << 4)
  91         #define USBVISION_SEND_FID              (1 << 5)
  92         #define USBVISION_KEEP_BLANK            (1 << 7)
  93 #define USBVISION_LXSIZE_I              0x1D
  94 #define USBVISION_MXSIZE_I              0x1E
  95 #define USBVISION_LYSIZE_I              0x1F
  96 #define USBVISION_MYSIZE_I              0x20
  97 #define USBVISION_LX_OFFST              0x21
  98 #define USBVISION_MX_OFFST              0x22
  99 #define USBVISION_LY_OFFST              0x23
 100 #define USBVISION_MY_OFFST              0x24
 101 #define USBVISION_FRM_RATE              0x25
 102 #define USBVISION_LXSIZE_O              0x26
 103 #define USBVISION_MXSIZE_O              0x27
 104 #define USBVISION_LYSIZE_O              0x28
 105 #define USBVISION_MYSIZE_O              0x29
 106 #define USBVISION_FILT_CONT             0x2A
 107 #define USBVISION_VO_MODE               0x2B
 108 #define USBVISION_INTRA_CYC             0x2C
 109 #define USBVISION_STRIP_SZ              0x2D
 110 #define USBVISION_FORCE_INTRA           0x2E
 111 #define USBVISION_FORCE_UP              0x2F
 112 #define USBVISION_BUF_THR               0x30
 113 #define USBVISION_DVI_YUV               0x31
 114 #define USBVISION_AUDIO_CONT            0x32
 115 #define USBVISION_AUD_PK_LEN            0x33
 116 #define USBVISION_BLK_PK_LEN            0x34
 117 #define USBVISION_PCM_THR1              0x38
 118 #define USBVISION_PCM_THR2              0x39
 119 #define USBVISION_DIST_THR_L            0x3A
 120 #define USBVISION_DIST_THR_H            0x3B
 121 #define USBVISION_MAX_DIST_L            0x3C
 122 #define USBVISION_MAX_DIST_H            0x3D
 123 #define USBVISION_OP_CODE               0x33
 124
 125 #define MAX_BYTES_PER_PIXEL             4
 126
 127 #define MIN_FRAME_WIDTH                 64
 128 #define MAX_USB_WIDTH                   320  //384
 129 #define MAX_FRAME_WIDTH                 320  //384                      /*streching sometimes causes crashes*/
 130
 131 #define MIN_FRAME_HEIGHT                48
 132 #define MAX_USB_HEIGHT                  240  //288
 133 #define MAX_FRAME_HEIGHT                240  //288                      /*Streching sometimes causes crashes*/
 134
 135 #define MAX_FRAME_SIZE                  (MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT * MAX_BYTES_PER_PIXEL)
 136 #define USBVISION_CLIPMASK_SIZE         (MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT / 8) //bytesize of clipmask
 137
 138 #define USBVISION_URB_FRAMES            32
 139 #define USBVISION_MAX_ISOC_PACKET_SIZE  959                     // NT1003 Specs Document says 1023
 140
 141 #define USBVISION_NUM_HEADERMARKER      20
 142 #define USBVISION_NUMFRAMES             3
 143 #define USBVISION_NUMSBUF               2
 144
 145 #define USBVISION_POWEROFF_TIME         3 * (HZ)                // 3 seconds
 146
 147 /* This macro restricts an int variable to an inclusive range */
 148 #define RESTRICT_TO_RANGE(v,mi,ma) { if ((v) < (mi)) (v) = (mi); else if ((v) > (ma)) (v) = (ma); }
 149
 150 /*
 151  * We use macros to do YUV -> RGB conversion because this is
 152  * very important for speed and totally unimportant for size.
 153  *
 154  * YUV -> RGB Conversion
 155  * ---------------------
 156  *
 157  * B = 1.164*(Y-16)                 + 2.018*(V-128)
 158  * G = 1.164*(Y-16) - 0.813*(U-128) - 0.391*(V-128)
 159  * R = 1.164*(Y-16) + 1.596*(U-128)
 160  *
 161  * If you fancy integer arithmetics (as you should), hear this:
 162  *
 163  * 65536*B = 76284*(Y-16)                 + 132252*(V-128)
 164  * 65536*G = 76284*(Y-16) -  53281*(U-128) -  25625*(V-128)
 165  * 65536*R = 76284*(Y-16) + 104595*(U-128)
 166  *
 167  * Make sure the output values are within [0..255] range.
 168  */
 169 #define LIMIT_RGB(x) (((x) < 0) ? 0 : (((x) > 255) ? 255 : (x)))
 170 #define YUV_TO_RGB_BY_THE_BOOK(my,mu,mv,mr,mg,mb) { \
 171     int mm_y, mm_yc, mm_u, mm_v, mm_r, mm_g, mm_b; \
 172     mm_y = (my) - 16;  \
 173     mm_u = (mu) - 128; \
 174     mm_v = (mv) - 128; \
 175     mm_yc= mm_y * 76284; \
 176     mm_b = (mm_yc               + 132252*mm_v   ) >> 16; \
 177     mm_g = (mm_yc -  53281*mm_u -  25625*mm_v   ) >> 16; \
 178     mm_r = (mm_yc + 104595*mm_u                 ) >> 16; \
 179     mb = LIMIT_RGB(mm_b); \
 180     mg = LIMIT_RGB(mm_g); \
 181     mr = LIMIT_RGB(mm_r); \
 182 }
 183
 184
 185
 186 /* Debugging aid */
 187 #define USBVISION_SAY_AND_WAIT(what) { \
 188         wait_queue_head_t wq; \
 189         init_waitqueue_head(&wq); \
 190         printk(KERN_INFO "Say: %s\n", what); \
 191         interruptible_sleep_on_timeout (&wq, HZ*3); \
 192 }
 193
 194 /*
 195  * This macro checks if usbvision is still operational. The 'usbvision'
 196  * pointer must be valid, usbvision->dev must be valid, we are not
 197  * removing the device and the device has not erred on us.
 198  */
 199 #define USBVISION_IS_OPERATIONAL(udevice) (\
 200         (udevice != NULL) && \
 201         ((udevice)->dev != NULL) && \
 202         ((udevice)->last_error == 0) && \
 203         (!(udevice)->remove_pending))
 204
 205
 206 enum ScanState {
 207         ScanState_Scanning,     /* Scanning for header */
 208         ScanState_Lines         /* Parsing lines */
 209 };
 210
 211 /* Completion states of the data parser */
 212 enum ParseState {
 213         ParseState_Continue,    /* Just parse next item */
 214         ParseState_NextFrame,   /* Frame done, send it to V4L */
 215         ParseState_Out,         /* Not enough data for frame */
 216         ParseState_EndParse     /* End parsing */
 217 };
 218
 219 enum FrameState {
 220         FrameState_Unused,      /* Unused (no MCAPTURE) */
 221         FrameState_Ready,       /* Ready to start grabbing */
 222         FrameState_Grabbing,    /* In the process of being grabbed into */
 223         FrameState_Done,        /* Finished grabbing, but not been synced yet */
 224         FrameState_DoneHold,    /* Are syncing or reading */
 225         FrameState_Error,       /* Something bad happened while processing */
 226 };
 227
 228 /* stream states */
 229 enum StreamState {
 230         Stream_Off,             /* Driver streaming is completely OFF */
 231         Stream_Idle,            /* Driver streaming is ready to be put ON by the application */
 232         Stream_Interrupt,       /* Driver streaming must be interrupted */
 233         Stream_On,              /* Driver streaming is put ON by the application */
 234 };
 235
 236 enum IsocState {
 237         IsocState_InFrame,      /* Isoc packet is member of frame */
 238         IsocState_NoFrame,      /* Isoc packet is not member of any frame */
 239 };
 240
 241 struct usb_device;
 242
 243 struct usbvision_sbuf {
 244         char *data;
 245         struct urb *urb;
 246 };
 247
 248 #define USBVISION_MAGIC_1                       0x55
 249 #define USBVISION_MAGIC_2                       0xAA
 250 #define USBVISION_HEADER_LENGTH                 0x0c
 251 #define USBVISION_SAA7111_ADDR                  0x48
 252 #define USBVISION_SAA7113_ADDR                  0x4a
 253 #define USBVISION_IIC_LRACK                     0x20
 254 #define USBVISION_IIC_LRNACK                    0x30
 255 #define USBVISION_FRAME_FORMAT_PARAM_INTRA      (1<<7)
 256
 257 struct usbvision_v4l2_format_st {
 258         int             supported;
 259         int             bytes_per_pixel;
 260         int             depth;
 261         int             format;
 262         char            *desc;
 263 };
 264 #define USBVISION_SUPPORTED_PALETTES ARRAY_SIZE(usbvision_v4l2_format)
 265
 266 struct usbvision_frame_header {
 267         unsigned char magic_1;                          /* 0 magic */
 268         unsigned char magic_2;                          /* 1  magic */
 269         unsigned char headerLength;                     /* 2 */
 270         unsigned char frameNum;                         /* 3 */
 271         unsigned char framePhase;                       /* 4 */
 272         unsigned char frameLatency;                     /* 5 */
 273         unsigned char dataFormat;                       /* 6 */
 274         unsigned char formatParam;                      /* 7 */
 275         unsigned char frameWidthLo;                     /* 8 */
 276         unsigned char frameWidthHi;                     /* 9 */
 277         unsigned char frameHeightLo;                    /* 10 */
 278         unsigned char frameHeightHi;                    /* 11 */
 279         __u16 frameWidth;                               /* 8 - 9 after endian correction*/
 280         __u16 frameHeight;                              /* 10 - 11 after endian correction*/
 281 };
 282
 283 /* tvnorms */
 284 struct usbvision_tvnorm {
 285         char *name;
 286         v4l2_std_id id;
 287         /* mode for saa7113h */
 288         int mode;
 289 };
 290
 291 struct usbvision_frame {
 292         char *data;                                     /* Frame buffer */
 293         struct usbvision_frame_header isocHeader;       /* Header from stream */
 294
 295         int width;                                      /* Width application is expecting */
 296         int height;                                     /* Height */
 297         int index;                                      /* Frame index */
 298         int frmwidth;                                   /* Width the frame actually is */
 299         int frmheight;                                  /* Height */
 300
 301         volatile int grabstate;                         /* State of grabbing */
 302         int scanstate;                                  /* State of scanning */
 303
 304         struct list_head frame;
 305
 306         int curline;                                    /* Line of frame we're working on */
 307
 308         long scanlength;                                /* uncompressed, raw data length of frame */
 309         long bytes_read;                                /* amount of scanlength that has been read from data */
 310         struct usbvision_v4l2_format_st v4l2_format;    /* format the user needs*/
 311         int v4l2_linesize;                              /* bytes for one videoline*/
 312         struct timeval timestamp;
 313         int sequence;                                   // How many video frames we send to user
 314 };
 315
 316 #define CODEC_SAA7113   7113
 317 #define CODEC_SAA7111   7111
 318 #define BRIDGE_NT1003   1003
 319 #define BRIDGE_NT1004   1004
 320 #define BRIDGE_NT1005   1005
 321
 322 #define USBVISION_I2C_CLIENTS_MAX               8
 323
 324 struct usbvision_device_data_st {
 325         int idVendor;
 326         int idProduct;
 327         int Interface; /* to handle special interface number like BELKIN and Hauppauge WinTV-USB II */
 328         int Codec;
 329         int VideoChannels;
 330         __u64 VideoNorm;
 331         int AudioChannels;
 332         int Radio;
 333         int vbi;
 334         int Tuner;
 335         int TunerType;
 336         int Vin_Reg1;
 337         int Vin_Reg2;
 338         int X_Offset;
 339         int Y_Offset;
 340         int Dvi_yuv;
 341         char *ModelString;
 342 };
 343
 344 /* Declared on usbvision-cards.c */
 345 extern struct usbvision_device_data_st usbvision_device_data[];
 346 extern struct usb_device_id usbvision_table[];
 347
 348 struct usb_usbvision {
 349         struct video_device *vdev;                                      /* Video Device */
 350         struct video_device *rdev;                                      /* Radio Device */
 351         struct video_device *vbi;                                       /* VBI Device   */
 352         struct video_audio audio_dev;                                   /* Current audio params */
 353
 354         /* i2c Declaration Section*/
 355         struct i2c_adapter i2c_adap;
 356         struct i2c_algo_usb_data i2c_algo;
 357         struct i2c_client i2c_client;
 358         int i2c_state, i2c_ok;
 359         struct i2c_client *i2c_clients[USBVISION_I2C_CLIENTS_MAX];
 360
 361         struct urb *ctrlUrb;
 362         unsigned char ctrlUrbBuffer[8];
 363         int ctrlUrbBusy;
 364         struct usb_ctrlrequest ctrlUrbSetup;
 365         wait_queue_head_t ctrlUrb_wq;                                   // Processes waiting
 366         struct semaphore ctrlUrbLock;
 367
 368         int have_tuner;
 369         int tuner_type;
 370         int bridgeType;                                                 // NT1003, NT1004, NT1005
 371         int channel;
 372         int radio;
 373         int video_inputs;                                               // # of inputs
 374         unsigned long freq;
 375         int AudioMute;
 376         int AudioChannel;
 377         int isocMode;                                                   // format of video data for the usb isoc-transfer
 378         unsigned int nr;                                                // Number of the device < MAX_USBVISION
 379
 380         /* Device structure */
 381         struct usb_device *dev;
 382         unsigned char iface;                                            /* Video interface number */
 383         unsigned char ifaceAltActive, ifaceAltInactive;                 /* Alt settings */
 384         unsigned char Vin_Reg2_Preset;
 385         struct semaphore lock;
 386         struct timer_list powerOffTimer;
 387         struct work_struct powerOffWork;
 388         int power;                                                      /* is the device powered on? */
 389         int user;                                                       /* user count for exclusive use */
 390         int usbvision_used;                                             /* Is this structure in use? */
 391         int initialized;                                                /* Had we already sent init sequence? */
 392         int DevModel;                                                   /* What type of USBVISION device we got? */
 393         enum StreamState streaming;                                     /* Are we streaming Isochronous? */
 394         int last_error;                                                 /* What calamity struck us? */
 395         int curwidth;                                                   /* width of the frame the device is currently set to*/
 396         int curheight;                                                  /* height of the frame the device is currently set to*/
 397         int stretch_width;                                              /* stretch-factor for frame width (from usb to screen)*/
 398         int stretch_height;                                             /* stretch-factor for frame height (from usb to screen)*/
 399         char *fbuf;                                                     /* Videodev buffer area for mmap*/
 400         int max_frame_size;                                             /* Bytes in one video frame */
 401         int fbuf_size;                                                  /* Videodev buffer size */
 402         spinlock_t queue_lock;                                          /* spinlock for protecting mods on inqueue and outqueue */
 403         struct list_head inqueue, outqueue;                             /* queued frame list and ready to dequeue frame list */
 404         wait_queue_head_t wait_frame;                                   /* Processes waiting */
 405         wait_queue_head_t wait_stream;                                  /* Processes waiting */
 406         struct usbvision_frame *curFrame;                               // pointer to current frame, set by usbvision_find_header
 407         struct usbvision_frame frame[USBVISION_NUMFRAMES];              // frame buffer
 408         int curSbufNum;                                                 // number of current receiving sbuf
 409         struct usbvision_sbuf sbuf[USBVISION_NUMSBUF];                  // S buffering
 410         volatile int remove_pending;                                    /* If set then about to exit */
 411
 412         /* Scratch space from the Isochronous Pipe.*/
 413         unsigned char *scratch;
 414         int scratch_read_ptr;
 415         int scratch_write_ptr;
 416         int scratch_headermarker[USBVISION_NUM_HEADERMARKER];
 417         int scratch_headermarker_read_ptr;
 418         int scratch_headermarker_write_ptr;
 419         int isocstate;
 420         /* color controls */
 421         int saturation;
 422         int hue;
 423         int brightness;
 424         int contrast;
 425         int depth;
 426         struct usbvision_v4l2_format_st palette;
 427
 428         struct v4l2_capability vcap;                                    /* Video capabilities */
 429         unsigned int ctl_input;                                         /* selected input */
 430         struct usbvision_tvnorm *tvnorm;                                /* selected tv norm */
 431         unsigned char video_endp;                                       /* 0x82 for USBVISION devices based */
 432
 433         // Overlay stuff:
 434         struct v4l2_framebuffer vid_buf;
 435         struct v4l2_format vid_win;
 436         int vid_buf_valid;                                              // Status: video buffer is valid (set)
 437         int vid_win_valid;                                              // Status: video window is valid (set)
 438         int     overlay;                                                /*Status: Are we overlaying? */
 439         unsigned int    clipmask[USBVISION_CLIPMASK_SIZE / 4];
 440         unsigned char   *overlay_base;                                  /* Virtual base address of video buffer */
 441         unsigned char   *overlay_win;                                   /* virt start address of overlay window */
 442         struct usbvision_frame overlay_frame;
 443
 444         // Decompression stuff:
 445         unsigned char *IntraFrameBuffer;                                /* Buffer for reference frame */
 446         int BlockPos;                                                   //for test only
 447         int requestIntra;                                               // 0 = normal; 1 = intra frame is requested;
 448         int lastIsocFrameNum;                                           // check for lost isoc frames
 449         int isocPacketSize;                                             // need to calculate usedBandwidth
 450         int usedBandwidth;                                              // used bandwidth 0-100%, need to set comprLevel
 451         int comprLevel;                                                 // How strong (100) or weak (0) is compression
 452         int lastComprLevel;                                             // How strong (100) or weak (0) was compression
 453         int usb_bandwidth;                                              /* Mbit/s */
 454
 455         /* /proc entries, relative to /proc/video/usbvision/ */
 456         struct proc_dir_entry *proc_devdir;             /* Per-device proc directory */
 457         struct proc_dir_entry *proc_info;               /* <minor#>/info entry */
 458         struct proc_dir_entry *proc_register;           /* <minor#>/register entry */
 459         struct proc_dir_entry *proc_freq;               /* <minor#>/freq entry */
 460         struct proc_dir_entry *proc_input;              /* <minor#>/input entry */
 461         struct proc_dir_entry *proc_frame;              /* <minor#>/frame entry */
 462         struct proc_dir_entry *proc_button;             /* <minor#>/button entry */
 463         struct proc_dir_entry *proc_control;            /* <minor#>/control entry */
 464
 465         /* Statistics that can be overlayed on the screen */
 466         unsigned long isocUrbCount;                     // How many URBs we received so far
 467         unsigned long urb_length;                       /* Length of last URB */
 468         unsigned long isocDataCount;                    /* How many bytes we received */
 469         unsigned long header_count;                     /* How many frame headers we found */
 470         unsigned long scratch_ovf_count;                /* How many times we overflowed scratch */
 471         unsigned long isocSkipCount;                    /* How many empty ISO packets received */
 472         unsigned long isocErrCount;                     /* How many bad ISO packets received */
 473         unsigned long isocPacketCount;                  // How many packets we totally got
 474         unsigned long timeInIrq;                        // How long do we need for interrupt
 475         int isocMeasureBandwidthCount;
 476         int frame_num;                                  // How many video frames we send to user
 477         int maxStripLen;                                // How big is the biggest strip
 478         int comprBlockPos;
 479         int stripLenErrors;                             // How many times was BlockPos greater than StripLen
 480         int stripMagicErrors;
 481         int stripLineNumberErrors;
 482         int ComprBlockTypes[4];
 483 };
 484
 485 #endif                                                                  /* __LINUX_USBVISION_H */
 486
 487 /*
 488  * Overrides for Emacs so that we follow Linus's tabbing style.
 489  * ---------------------------------------------------------------------------
 490  * Local variables:
 491  * c-basic-offset: 8
 492  * End:
 493  */