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