usbvision.h revision 2a9f8b5d25beacd034369fca416b548cbf931561
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#define USBVISION_MAX_ISOC_PACKET_SIZE 959 // NT1003 Specs Document says 1023 150 151#define USBVISION_NUM_HEADERMARKER 20 152#define USBVISION_NUMFRAMES 3 /* Maximum number of frames an application can get */ 153#define USBVISION_NUMSBUF 2 /* Dimensioning the USB S buffering */ 154 155#define USBVISION_POWEROFF_TIME 3 * (HZ) // 3 seconds 156 157 158#define FRAMERATE_MIN 0 159#define FRAMERATE_MAX 31 160 161enum { 162 ISOC_MODE_YUV422 = 0x03, 163 ISOC_MODE_YUV420 = 0x14, 164 ISOC_MODE_COMPRESS = 0x60, 165}; 166 167/* This macro restricts an int variable to an inclusive range */ 168#define RESTRICT_TO_RANGE(v,mi,ma) { if ((v) < (mi)) (v) = (mi); else if ((v) > (ma)) (v) = (ma); } 169 170/* 171 * We use macros to do YUV -> RGB conversion because this is 172 * very important for speed and totally unimportant for size. 173 * 174 * YUV -> RGB Conversion 175 * --------------------- 176 * 177 * B = 1.164*(Y-16) + 2.018*(V-128) 178 * G = 1.164*(Y-16) - 0.813*(U-128) - 0.391*(V-128) 179 * R = 1.164*(Y-16) + 1.596*(U-128) 180 * 181 * If you fancy integer arithmetics (as you should), hear this: 182 * 183 * 65536*B = 76284*(Y-16) + 132252*(V-128) 184 * 65536*G = 76284*(Y-16) - 53281*(U-128) - 25625*(V-128) 185 * 65536*R = 76284*(Y-16) + 104595*(U-128) 186 * 187 * Make sure the output values are within [0..255] range. 188 */ 189#define LIMIT_RGB(x) (((x) < 0) ? 0 : (((x) > 255) ? 255 : (x))) 190#define YUV_TO_RGB_BY_THE_BOOK(my,mu,mv,mr,mg,mb) { \ 191 int mm_y, mm_yc, mm_u, mm_v, mm_r, mm_g, mm_b; \ 192 mm_y = (my) - 16; \ 193 mm_u = (mu) - 128; \ 194 mm_v = (mv) - 128; \ 195 mm_yc= mm_y * 76284; \ 196 mm_b = (mm_yc + 132252*mm_v ) >> 16; \ 197 mm_g = (mm_yc - 53281*mm_u - 25625*mm_v ) >> 16; \ 198 mm_r = (mm_yc + 104595*mm_u ) >> 16; \ 199 mb = LIMIT_RGB(mm_b); \ 200 mg = LIMIT_RGB(mm_g); \ 201 mr = LIMIT_RGB(mm_r); \ 202} 203 204/* Debugging aid */ 205#define USBVISION_SAY_AND_WAIT(what) { \ 206 wait_queue_head_t wq; \ 207 init_waitqueue_head(&wq); \ 208 printk(KERN_INFO "Say: %s\n", what); \ 209 interruptible_sleep_on_timeout (&wq, HZ*3); \ 210} 211 212/* 213 * This macro checks if usbvision is still operational. The 'usbvision' 214 * pointer must be valid, usbvision->dev must be valid, we are not 215 * removing the device and the device has not erred on us. 216 */ 217#define USBVISION_IS_OPERATIONAL(udevice) (\ 218 (udevice != NULL) && \ 219 ((udevice)->dev != NULL) && \ 220 ((udevice)->last_error == 0) && \ 221 (!(udevice)->remove_pending)) 222 223#define I2C_USB_ADAP_MAX 16 224 225/* ----------------------------------------------------------------- */ 226/* usbvision video structures */ 227/* ----------------------------------------------------------------- */ 228enum ScanState { 229 ScanState_Scanning, /* Scanning for header */ 230 ScanState_Lines /* Parsing lines */ 231}; 232 233/* Completion states of the data parser */ 234enum ParseState { 235 ParseState_Continue, /* Just parse next item */ 236 ParseState_NextFrame, /* Frame done, send it to V4L */ 237 ParseState_Out, /* Not enough data for frame */ 238 ParseState_EndParse /* End parsing */ 239}; 240 241enum FrameState { 242 FrameState_Unused, /* Unused (no MCAPTURE) */ 243 FrameState_Ready, /* Ready to start grabbing */ 244 FrameState_Grabbing, /* In the process of being grabbed into */ 245 FrameState_Done, /* Finished grabbing, but not been synced yet */ 246 FrameState_DoneHold, /* Are syncing or reading */ 247 FrameState_Error, /* Something bad happened while processing */ 248}; 249 250/* stream states */ 251enum StreamState { 252 Stream_Off, /* Driver streaming is completely OFF */ 253 Stream_Idle, /* Driver streaming is ready to be put ON by the application */ 254 Stream_Interrupt, /* Driver streaming must be interrupted */ 255 Stream_On, /* Driver streaming is put ON by the application */ 256}; 257 258enum IsocState { 259 IsocState_InFrame, /* Isoc packet is member of frame */ 260 IsocState_NoFrame, /* Isoc packet is not member of any frame */ 261}; 262 263struct usb_device; 264 265struct usbvision_sbuf { 266 char *data; 267 struct urb *urb; 268}; 269 270#define USBVISION_MAGIC_1 0x55 271#define USBVISION_MAGIC_2 0xAA 272#define USBVISION_HEADER_LENGTH 0x0c 273#define USBVISION_SAA7111_ADDR 0x48 274#define USBVISION_SAA7113_ADDR 0x4a 275#define USBVISION_IIC_LRACK 0x20 276#define USBVISION_IIC_LRNACK 0x30 277#define USBVISION_FRAME_FORMAT_PARAM_INTRA (1<<7) 278 279struct usbvision_v4l2_format_st { 280 int supported; 281 int bytes_per_pixel; 282 int depth; 283 int format; 284 char *desc; 285}; 286#define USBVISION_SUPPORTED_PALETTES ARRAY_SIZE(usbvision_v4l2_format) 287 288struct usbvision_frame_header { 289 unsigned char magic_1; /* 0 magic */ 290 unsigned char magic_2; /* 1 magic */ 291 unsigned char headerLength; /* 2 */ 292 unsigned char frameNum; /* 3 */ 293 unsigned char framePhase; /* 4 */ 294 unsigned char frameLatency; /* 5 */ 295 unsigned char dataFormat; /* 6 */ 296 unsigned char formatParam; /* 7 */ 297 unsigned char frameWidthLo; /* 8 */ 298 unsigned char frameWidthHi; /* 9 */ 299 unsigned char frameHeightLo; /* 10 */ 300 unsigned char frameHeightHi; /* 11 */ 301 __u16 frameWidth; /* 8 - 9 after endian correction*/ 302 __u16 frameHeight; /* 10 - 11 after endian correction*/ 303}; 304 305/* tvnorms */ 306struct usbvision_tvnorm { 307 char *name; 308 v4l2_std_id id; 309 /* mode for saa7113h */ 310 int mode; 311}; 312 313struct usbvision_frame { 314 char *data; /* Frame buffer */ 315 struct usbvision_frame_header isocHeader; /* Header from stream */ 316 317 int width; /* Width application is expecting */ 318 int height; /* Height */ 319 int index; /* Frame index */ 320 int frmwidth; /* Width the frame actually is */ 321 int frmheight; /* Height */ 322 323 volatile int grabstate; /* State of grabbing */ 324 int scanstate; /* State of scanning */ 325 326 struct list_head frame; 327 328 int curline; /* Line of frame we're working on */ 329 330 long scanlength; /* uncompressed, raw data length of frame */ 331 long bytes_read; /* amount of scanlength that has been read from data */ 332 struct usbvision_v4l2_format_st v4l2_format; /* format the user needs*/ 333 int v4l2_linesize; /* bytes for one videoline*/ 334 struct timeval timestamp; 335 int sequence; // How many video frames we send to user 336}; 337 338#define CODEC_SAA7113 7113 339#define CODEC_SAA7111 7111 340#define BRIDGE_NT1003 1003 341#define BRIDGE_NT1004 1004 342#define BRIDGE_NT1005 1005 343 344struct usbvision_device_data_st { 345 int idVendor; 346 int idProduct; 347 int Interface; /* to handle special interface number like BELKIN and Hauppauge WinTV-USB II */ 348 int Codec; 349 int VideoChannels; 350 __u64 VideoNorm; 351 int AudioChannels; 352 int Radio; 353 int vbi; 354 int Tuner; 355 int TunerType; 356 int Vin_Reg1; 357 int Vin_Reg2; 358 int X_Offset; 359 int Y_Offset; 360 int Dvi_yuv; 361 char *ModelString; 362}; 363 364/* Declared on usbvision-cards.c */ 365extern struct usbvision_device_data_st usbvision_device_data[]; 366extern struct usb_device_id usbvision_table[]; 367 368struct usb_usbvision { 369 struct video_device *vdev; /* Video Device */ 370 struct video_device *rdev; /* Radio Device */ 371 struct video_device *vbi; /* VBI Device */ 372 373 /* i2c Declaration Section*/ 374 struct i2c_adapter i2c_adap; 375 struct i2c_client i2c_client; 376 377 struct urb *ctrlUrb; 378 unsigned char ctrlUrbBuffer[8]; 379 int ctrlUrbBusy; 380 struct usb_ctrlrequest ctrlUrbSetup; 381 wait_queue_head_t ctrlUrb_wq; // Processes waiting 382 struct semaphore ctrlUrbLock; 383 384 /* configuration part */ 385 int have_tuner; 386 int tuner_type; 387 int tuner_addr; 388 int bridgeType; // NT1003, NT1004, NT1005 389 int channel; 390 int radio; 391 int video_inputs; // # of inputs 392 unsigned long freq; 393 int AudioMute; 394 int AudioChannel; 395 int isocMode; // format of video data for the usb isoc-transfer 396 unsigned int nr; // Number of the device 397 398 /* Device structure */ 399 struct usb_device *dev; 400 /* usb transfer */ 401 int num_alt; /* Number of alternative settings */ 402 unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */ 403 unsigned char iface; /* Video interface number */ 404 unsigned char ifaceAlt; /* Alt settings */ 405 unsigned char Vin_Reg2_Preset; 406 struct semaphore lock; 407 struct timer_list powerOffTimer; 408 struct work_struct powerOffWork; 409 int power; /* is the device powered on? */ 410 int user; /* user count for exclusive use */ 411 int initialized; /* Had we already sent init sequence? */ 412 int DevModel; /* What type of USBVISION device we got? */ 413 enum StreamState streaming; /* Are we streaming Isochronous? */ 414 int last_error; /* What calamity struck us? */ 415 int curwidth; /* width of the frame the device is currently set to*/ 416 int curheight; /* height of the frame the device is currently set to*/ 417 int stretch_width; /* stretch-factor for frame width (from usb to screen)*/ 418 int stretch_height; /* stretch-factor for frame height (from usb to screen)*/ 419 char *fbuf; /* Videodev buffer area for mmap*/ 420 int max_frame_size; /* Bytes in one video frame */ 421 int fbuf_size; /* Videodev buffer size */ 422 spinlock_t queue_lock; /* spinlock for protecting mods on inqueue and outqueue */ 423 struct list_head inqueue, outqueue; /* queued frame list and ready to dequeue frame list */ 424 wait_queue_head_t wait_frame; /* Processes waiting */ 425 wait_queue_head_t wait_stream; /* Processes waiting */ 426 struct usbvision_frame *curFrame; // pointer to current frame, set by usbvision_find_header 427 struct usbvision_frame frame[USBVISION_NUMFRAMES]; // frame buffer 428 int num_frames; // number of frames allocated 429 struct usbvision_sbuf sbuf[USBVISION_NUMSBUF]; // S buffering 430 volatile int remove_pending; /* If set then about to exit */ 431 432 /* Scratch space from the Isochronous Pipe.*/ 433 unsigned char *scratch; 434 int scratch_read_ptr; 435 int scratch_write_ptr; 436 int scratch_headermarker[USBVISION_NUM_HEADERMARKER]; 437 int scratch_headermarker_read_ptr; 438 int scratch_headermarker_write_ptr; 439 enum IsocState isocstate; 440 struct usbvision_v4l2_format_st palette; 441 442 struct v4l2_capability vcap; /* Video capabilities */ 443 unsigned int ctl_input; /* selected input */ 444 struct usbvision_tvnorm *tvnorm; /* selected tv norm */ 445 unsigned char video_endp; /* 0x82 for USBVISION devices based */ 446 447 // Decompression stuff: 448 unsigned char *IntraFrameBuffer; /* Buffer for reference frame */ 449 int BlockPos; //for test only 450 int requestIntra; // 0 = normal; 1 = intra frame is requested; 451 int lastIsocFrameNum; // check for lost isoc frames 452 int isocPacketSize; // need to calculate usedBandwidth 453 int usedBandwidth; // used bandwidth 0-100%, need to set comprLevel 454 int comprLevel; // How strong (100) or weak (0) is compression 455 int lastComprLevel; // How strong (100) or weak (0) was compression 456 int usb_bandwidth; /* Mbit/s */ 457 458 /* Statistics that can be overlayed on the screen */ 459 unsigned long isocUrbCount; // How many URBs we received so far 460 unsigned long urb_length; /* Length of last URB */ 461 unsigned long isocDataCount; /* How many bytes we received */ 462 unsigned long header_count; /* How many frame headers we found */ 463 unsigned long scratch_ovf_count; /* How many times we overflowed scratch */ 464 unsigned long isocSkipCount; /* How many empty ISO packets received */ 465 unsigned long isocErrCount; /* How many bad ISO packets received */ 466 unsigned long isocPacketCount; // How many packets we totally got 467 unsigned long timeInIrq; // How long do we need for interrupt 468 int isocMeasureBandwidthCount; 469 int frame_num; // How many video frames we send to user 470 int maxStripLen; // How big is the biggest strip 471 int comprBlockPos; 472 int stripLenErrors; // How many times was BlockPos greater than StripLen 473 int stripMagicErrors; 474 int stripLineNumberErrors; 475 int ComprBlockTypes[4]; 476}; 477 478 479/* --------------------------------------------------------------- */ 480/* defined in usbvision-i2c.c */ 481/* i2c-algo-usb declaration */ 482/* --------------------------------------------------------------- */ 483 484int usbvision_i2c_usb_del_bus(struct i2c_adapter *); 485 486 487/* ----------------------------------------------------------------------- */ 488/* usbvision specific I2C functions */ 489/* ----------------------------------------------------------------------- */ 490int usbvision_init_i2c(struct usb_usbvision *usbvision); 491void call_i2c_clients(struct usb_usbvision *usbvision, unsigned int cmd,void *arg); 492 493/* defined in usbvision-core.c */ 494int usbvision_read_reg(struct usb_usbvision *usbvision, unsigned char reg); 495int usbvision_write_reg(struct usb_usbvision *usbvision, unsigned char reg, 496 unsigned char value); 497 498int usbvision_frames_alloc(struct usb_usbvision *usbvision, int number_of_frames); 499void usbvision_frames_free(struct usb_usbvision *usbvision); 500int usbvision_scratch_alloc(struct usb_usbvision *usbvision); 501void usbvision_scratch_free(struct usb_usbvision *usbvision); 502int usbvision_decompress_alloc(struct usb_usbvision *usbvision); 503void usbvision_decompress_free(struct usb_usbvision *usbvision); 504 505int usbvision_setup(struct usb_usbvision *usbvision,int format); 506int usbvision_init_isoc(struct usb_usbvision *usbvision); 507int usbvision_restart_isoc(struct usb_usbvision *usbvision); 508void usbvision_stop_isoc(struct usb_usbvision *usbvision); 509int usbvision_set_alternate(struct usb_usbvision *dev); 510 511int usbvision_set_audio(struct usb_usbvision *usbvision, int AudioChannel); 512int usbvision_audio_off(struct usb_usbvision *usbvision); 513 514int usbvision_begin_streaming(struct usb_usbvision *usbvision); 515void usbvision_empty_framequeues(struct usb_usbvision *dev); 516int usbvision_stream_interrupt(struct usb_usbvision *dev); 517 518int usbvision_muxsel(struct usb_usbvision *usbvision, int channel); 519int usbvision_set_input(struct usb_usbvision *usbvision); 520int usbvision_set_output(struct usb_usbvision *usbvision, int width, int height); 521 522void usbvision_init_powerOffTimer(struct usb_usbvision *usbvision); 523void usbvision_set_powerOffTimer(struct usb_usbvision *usbvision); 524void usbvision_reset_powerOffTimer(struct usb_usbvision *usbvision); 525int usbvision_power_off(struct usb_usbvision *usbvision); 526int usbvision_power_on(struct usb_usbvision *usbvision); 527 528#endif /* __LINUX_USBVISION_H */ 529 530/* 531 * Overrides for Emacs so that we follow Linus's tabbing style. 532 * --------------------------------------------------------------------------- 533 * Local variables: 534 * c-basic-offset: 8 535 * End: 536 */ 537