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