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: linux-media@vger.kernel.org 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-device.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_CLK_OUT (1 << 0) 63 #define USBVISION_DAT_IO (1 << 1) 64 #define USBVISION_SENS_OUT (1 << 2) 65 #define USBVISION_SER_MODE_SOFT (0 << 4) 66 #define USBVISION_SER_MODE_SIO (1 << 4) 67#define USBVISION_SER_ADRS 0x08 68#define USBVISION_SER_CONT 0x09 69#define USBVISION_SER_DAT1 0x0A 70#define USBVISION_SER_DAT2 0x0B 71#define USBVISION_SER_DAT3 0x0C 72#define USBVISION_SER_DAT4 0x0D 73#define USBVISION_EE_DATA 0x0E 74#define USBVISION_EE_LSBAD 0x0F 75#define USBVISION_EE_CONT 0x10 76#define USBVISION_DRM_CONT 0x12 77 #define USBVISION_REF (1 << 0) 78 #define USBVISION_RES_UR (1 << 2) 79 #define USBVISION_RES_FDL (1 << 3) 80 #define USBVISION_RES_VDW (1 << 4) 81#define USBVISION_DRM_PRM1 0x13 82#define USBVISION_DRM_PRM2 0x14 83#define USBVISION_DRM_PRM3 0x15 84#define USBVISION_DRM_PRM4 0x16 85#define USBVISION_DRM_PRM5 0x17 86#define USBVISION_DRM_PRM6 0x18 87#define USBVISION_DRM_PRM7 0x19 88#define USBVISION_DRM_PRM8 0x1A 89#define USBVISION_VIN_REG1 0x1B 90 #define USBVISION_8_422_SYNC 0x01 91 #define USBVISION_16_422_SYNC 0x02 92 #define USBVISION_VSNC_POL (1 << 3) 93 #define USBVISION_HSNC_POL (1 << 4) 94 #define USBVISION_FID_POL (1 << 5) 95 #define USBVISION_HVALID_PO (1 << 6) 96 #define USBVISION_VCLK_POL (1 << 7) 97#define USBVISION_VIN_REG2 0x1C 98 #define USBVISION_AUTO_FID (1 << 0) 99 #define USBVISION_NONE_INTER (1 << 1) 100 #define USBVISION_NOHVALID (1 << 2) 101 #define USBVISION_UV_ID (1 << 3) 102 #define USBVISION_FIX_2C (1 << 4) 103 #define USBVISION_SEND_FID (1 << 5) 104 #define USBVISION_KEEP_BLANK (1 << 7) 105#define USBVISION_LXSIZE_I 0x1D 106#define USBVISION_MXSIZE_I 0x1E 107#define USBVISION_LYSIZE_I 0x1F 108#define USBVISION_MYSIZE_I 0x20 109#define USBVISION_LX_OFFST 0x21 110#define USBVISION_MX_OFFST 0x22 111#define USBVISION_LY_OFFST 0x23 112#define USBVISION_MY_OFFST 0x24 113#define USBVISION_FRM_RATE 0x25 114#define USBVISION_LXSIZE_O 0x26 115#define USBVISION_MXSIZE_O 0x27 116#define USBVISION_LYSIZE_O 0x28 117#define USBVISION_MYSIZE_O 0x29 118#define USBVISION_FILT_CONT 0x2A 119#define USBVISION_VO_MODE 0x2B 120#define USBVISION_INTRA_CYC 0x2C 121#define USBVISION_STRIP_SZ 0x2D 122#define USBVISION_FORCE_INTRA 0x2E 123#define USBVISION_FORCE_UP 0x2F 124#define USBVISION_BUF_THR 0x30 125#define USBVISION_DVI_YUV 0x31 126#define USBVISION_AUDIO_CONT 0x32 127#define USBVISION_AUD_PK_LEN 0x33 128#define USBVISION_BLK_PK_LEN 0x34 129#define USBVISION_PCM_THR1 0x38 130#define USBVISION_PCM_THR2 0x39 131#define USBVISION_DIST_THR_L 0x3A 132#define USBVISION_DIST_THR_H 0x3B 133#define USBVISION_MAX_DIST_L 0x3C 134#define USBVISION_MAX_DIST_H 0x3D 135#define USBVISION_OP_CODE 0x33 136 137#define MAX_BYTES_PER_PIXEL 4 138 139#define MIN_FRAME_WIDTH 64 140#define MAX_USB_WIDTH 320 /* 384 */ 141#define MAX_FRAME_WIDTH 320 /* 384 */ /* streching sometimes causes crashes*/ 142 143#define MIN_FRAME_HEIGHT 48 144#define MAX_USB_HEIGHT 240 /* 288 */ 145#define MAX_FRAME_HEIGHT 240 /* 288 */ /* Streching sometimes causes crashes*/ 146 147#define MAX_FRAME_SIZE (MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT * MAX_BYTES_PER_PIXEL) 148#define USBVISION_CLIPMASK_SIZE (MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT / 8) /* bytesize of clipmask */ 149 150#define USBVISION_URB_FRAMES 32 151 152#define USBVISION_NUM_HEADERMARKER 20 153#define USBVISION_NUMFRAMES 3 /* Maximum number of frames an application can get */ 154#define USBVISION_NUMSBUF 2 /* Dimensioning the USB S buffering */ 155 156#define USBVISION_POWEROFF_TIME (3 * HZ) /* 3 seconds */ 157 158 159#define FRAMERATE_MIN 0 160#define FRAMERATE_MAX 31 161 162enum { 163 ISOC_MODE_YUV422 = 0x03, 164 ISOC_MODE_YUV420 = 0x14, 165 ISOC_MODE_COMPRESS = 0x60, 166}; 167 168/* This macro restricts an int variable to an inclusive range */ 169#define RESTRICT_TO_RANGE(v, mi, ma) \ 170 { if (((int)v) < (mi)) (v) = (mi); else if ((v) > (ma)) (v) = (ma); } 171 172/* 173 * We use macros to do YUV -> RGB conversion because this is 174 * very important for speed and totally unimportant for size. 175 * 176 * YUV -> RGB Conversion 177 * --------------------- 178 * 179 * B = 1.164*(Y-16) + 2.018*(V-128) 180 * G = 1.164*(Y-16) - 0.813*(U-128) - 0.391*(V-128) 181 * R = 1.164*(Y-16) + 1.596*(U-128) 182 * 183 * If you fancy integer arithmetics (as you should), hear this: 184 * 185 * 65536*B = 76284*(Y-16) + 132252*(V-128) 186 * 65536*G = 76284*(Y-16) - 53281*(U-128) - 25625*(V-128) 187 * 65536*R = 76284*(Y-16) + 104595*(U-128) 188 * 189 * Make sure the output values are within [0..255] range. 190 */ 191#define LIMIT_RGB(x) (((x) < 0) ? 0 : (((x) > 255) ? 255 : (x))) 192#define YUV_TO_RGB_BY_THE_BOOK(my, mu, mv, mr, mg, mb) { \ 193 int mm_y, mm_yc, mm_u, mm_v, mm_r, mm_g, mm_b; \ 194 mm_y = (my) - 16; \ 195 mm_u = (mu) - 128; \ 196 mm_v = (mv) - 128; \ 197 mm_yc = mm_y * 76284; \ 198 mm_b = (mm_yc + 132252 * mm_v) >> 16; \ 199 mm_g = (mm_yc - 53281 * mm_u - 25625 * mm_v) >> 16; \ 200 mm_r = (mm_yc + 104595 * mm_u) >> 16; \ 201 mb = LIMIT_RGB(mm_b); \ 202 mg = LIMIT_RGB(mm_g); \ 203 mr = LIMIT_RGB(mm_r); \ 204} 205 206/* 207 * This macro checks if usbvision is still operational. The 'usbvision' 208 * pointer must be valid, usbvision->dev must be valid, we are not 209 * removing the device and the device has not erred on us. 210 */ 211#define USBVISION_IS_OPERATIONAL(udevice) (\ 212 (udevice != NULL) && \ 213 ((udevice)->dev != NULL) && \ 214 ((udevice)->last_error == 0) && \ 215 (!(udevice)->remove_pending)) 216 217#define I2C_USB_ADAP_MAX 16 218 219#define USBVISION_NORMS (V4L2_STD_PAL | V4L2_STD_NTSC | V4L2_STD_SECAM | V4L2_STD_PAL_M) 220 221/* ----------------------------------------------------------------- */ 222/* usbvision video structures */ 223/* ----------------------------------------------------------------- */ 224enum scan_state { 225 scan_state_scanning, /* Scanning for header */ 226 scan_state_lines /* Parsing lines */ 227}; 228 229/* Completion states of the data parser */ 230enum parse_state { 231 parse_state_continue, /* Just parse next item */ 232 parse_state_next_frame, /* Frame done, send it to V4L */ 233 parse_state_out, /* Not enough data for frame */ 234 parse_state_end_parse /* End parsing */ 235}; 236 237enum frame_state { 238 frame_state_unused, /* Unused (no MCAPTURE) */ 239 frame_state_ready, /* Ready to start grabbing */ 240 frame_state_grabbing, /* In the process of being grabbed into */ 241 frame_state_done, /* Finished grabbing, but not been synced yet */ 242 frame_state_done_hold, /* Are syncing or reading */ 243 frame_state_error, /* Something bad happened while processing */ 244}; 245 246/* stream states */ 247enum stream_state { 248 stream_off, /* Driver streaming is completely OFF */ 249 stream_idle, /* Driver streaming is ready to be put ON by the application */ 250 stream_interrupt, /* Driver streaming must be interrupted */ 251 stream_on, /* Driver streaming is put ON by the application */ 252}; 253 254enum isoc_state { 255 isoc_state_in_frame, /* Isoc packet is member of frame */ 256 isoc_state_no_frame, /* Isoc packet is not member of any frame */ 257}; 258 259struct usb_device; 260 261struct usbvision_sbuf { 262 char *data; 263 struct urb *urb; 264}; 265 266#define USBVISION_MAGIC_1 0x55 267#define USBVISION_MAGIC_2 0xAA 268#define USBVISION_HEADER_LENGTH 0x0c 269#define USBVISION_SAA7111_ADDR 0x48 270#define USBVISION_SAA7113_ADDR 0x4a 271#define USBVISION_IIC_LRACK 0x20 272#define USBVISION_IIC_LRNACK 0x30 273#define USBVISION_FRAME_FORMAT_PARAM_INTRA (1<<7) 274 275struct usbvision_v4l2_format_st { 276 int supported; 277 int bytes_per_pixel; 278 int depth; 279 int format; 280 char *desc; 281}; 282#define USBVISION_SUPPORTED_PALETTES ARRAY_SIZE(usbvision_v4l2_format) 283 284struct usbvision_frame_header { 285 unsigned char magic_1; /* 0 magic */ 286 unsigned char magic_2; /* 1 magic */ 287 unsigned char header_length; /* 2 */ 288 unsigned char frame_num; /* 3 */ 289 unsigned char frame_phase; /* 4 */ 290 unsigned char frame_latency; /* 5 */ 291 unsigned char data_format; /* 6 */ 292 unsigned char format_param; /* 7 */ 293 unsigned char frame_width_lo; /* 8 */ 294 unsigned char frame_width_hi; /* 9 */ 295 unsigned char frame_height_lo; /* 10 */ 296 unsigned char frame_height_hi; /* 11 */ 297 __u16 frame_width; /* 8 - 9 after endian correction*/ 298 __u16 frame_height; /* 10 - 11 after endian correction*/ 299}; 300 301struct usbvision_frame { 302 char *data; /* Frame buffer */ 303 struct usbvision_frame_header isoc_header; /* Header from stream */ 304 305 int width; /* Width application is expecting */ 306 int height; /* Height */ 307 int index; /* Frame index */ 308 int frmwidth; /* Width the frame actually is */ 309 int frmheight; /* Height */ 310 311 volatile int grabstate; /* State of grabbing */ 312 int scanstate; /* State of scanning */ 313 314 struct list_head frame; 315 316 int curline; /* Line of frame we're working on */ 317 318 long scanlength; /* uncompressed, raw data length of frame */ 319 long bytes_read; /* amount of scanlength that has been read from data */ 320 struct usbvision_v4l2_format_st v4l2_format; /* format the user needs*/ 321 int v4l2_linesize; /* bytes for one videoline*/ 322 struct timeval timestamp; 323 int sequence; /* How many video frames we send to user */ 324}; 325 326#define CODEC_SAA7113 7113 327#define CODEC_SAA7111 7111 328#define CODEC_WEBCAM 3000 329#define BRIDGE_NT1003 1003 330#define BRIDGE_NT1004 1004 331#define BRIDGE_NT1005 1005 332 333struct usbvision_device_data_st { 334 __u64 video_norm; 335 const char *model_string; 336 int interface; /* to handle special interface number like BELKIN and Hauppauge WinTV-USB II */ 337 __u16 codec; 338 unsigned video_channels:3; 339 unsigned audio_channels:2; 340 unsigned radio:1; 341 unsigned vbi:1; 342 unsigned tuner:1; 343 unsigned vin_reg1_override:1; /* Override default value with */ 344 unsigned vin_reg2_override:1; /* vin_reg1, vin_reg2, etc. */ 345 unsigned dvi_yuv_override:1; 346 __u8 vin_reg1; 347 __u8 vin_reg2; 348 __u8 dvi_yuv; 349 __u8 tuner_type; 350 __s16 x_offset; 351 __s16 y_offset; 352}; 353 354/* Declared on usbvision-cards.c */ 355extern struct usbvision_device_data_st usbvision_device_data[]; 356extern struct usb_device_id usbvision_table[]; 357 358struct usb_usbvision { 359 struct v4l2_device v4l2_dev; 360 struct video_device vdev; /* Video Device */ 361 struct video_device rdev; /* Radio Device */ 362 363 /* i2c Declaration Section*/ 364 struct i2c_adapter i2c_adap; 365 int registered_i2c; 366 367 struct urb *ctrl_urb; 368 unsigned char ctrl_urb_buffer[8]; 369 int ctrl_urb_busy; 370 struct usb_ctrlrequest ctrl_urb_setup; 371 wait_queue_head_t ctrl_urb_wq; /* Processes waiting */ 372 373 /* configuration part */ 374 int have_tuner; 375 int tuner_type; 376 int bridge_type; /* NT1003, NT1004, NT1005 */ 377 int radio; 378 int video_inputs; /* # of inputs */ 379 unsigned long freq; 380 int audio_mute; 381 int audio_channel; 382 int isoc_mode; /* format of video data for the usb isoc-transfer */ 383 unsigned int nr; /* Number of the device */ 384 385 /* Device structure */ 386 struct usb_device *dev; 387 /* usb transfer */ 388 int num_alt; /* Number of alternative settings */ 389 unsigned int *alt_max_pkt_size; /* array of max_packet_size */ 390 unsigned char iface; /* Video interface number */ 391 unsigned char iface_alt; /* Alt settings */ 392 unsigned char vin_reg2_preset; 393 struct mutex v4l2_lock; 394 struct timer_list power_off_timer; 395 struct work_struct power_off_work; 396 int power; /* is the device powered on? */ 397 int user; /* user count for exclusive use */ 398 int initialized; /* Had we already sent init sequence? */ 399 int dev_model; /* What type of USBVISION device we got? */ 400 enum stream_state streaming; /* Are we streaming Isochronous? */ 401 int last_error; /* What calamity struck us? */ 402 int curwidth; /* width of the frame the device is currently set to*/ 403 int curheight; /* height of the frame the device is currently set to*/ 404 int stretch_width; /* stretch-factor for frame width (from usb to screen)*/ 405 int stretch_height; /* stretch-factor for frame height (from usb to screen)*/ 406 char *fbuf; /* Videodev buffer area for mmap*/ 407 int max_frame_size; /* Bytes in one video frame */ 408 int fbuf_size; /* Videodev buffer size */ 409 spinlock_t queue_lock; /* spinlock for protecting mods on inqueue and outqueue */ 410 struct list_head inqueue, outqueue; /* queued frame list and ready to dequeue frame list */ 411 wait_queue_head_t wait_frame; /* Processes waiting */ 412 wait_queue_head_t wait_stream; /* Processes waiting */ 413 struct usbvision_frame *cur_frame; /* pointer to current frame, set by usbvision_find_header */ 414 struct usbvision_frame frame[USBVISION_NUMFRAMES]; /* frame buffer */ 415 int num_frames; /* number of frames allocated */ 416 struct usbvision_sbuf sbuf[USBVISION_NUMSBUF]; /* S buffering */ 417 volatile int remove_pending; /* If set then about to exit */ 418 419 /* Scratch space from the Isochronous Pipe.*/ 420 unsigned char *scratch; 421 int scratch_read_ptr; 422 int scratch_write_ptr; 423 int scratch_headermarker[USBVISION_NUM_HEADERMARKER]; 424 int scratch_headermarker_read_ptr; 425 int scratch_headermarker_write_ptr; 426 enum isoc_state isocstate; 427 struct usbvision_v4l2_format_st palette; 428 429 struct v4l2_capability vcap; /* Video capabilities */ 430 unsigned int ctl_input; /* selected input */ 431 v4l2_std_id tvnorm_id; /* selected tv norm */ 432 unsigned char video_endp; /* 0x82 for USBVISION devices based */ 433 434 /* Decompression stuff: */ 435 unsigned char *intra_frame_buffer; /* Buffer for reference frame */ 436 int block_pos; /* for test only */ 437 int request_intra; /* 0 = normal; 1 = intra frame is requested; */ 438 int last_isoc_frame_num; /* check for lost isoc frames */ 439 int isoc_packet_size; /* need to calculate used_bandwidth */ 440 int used_bandwidth; /* used bandwidth 0-100%, need to set compr_level */ 441 int compr_level; /* How strong (100) or weak (0) is compression */ 442 int last_compr_level; /* How strong (100) or weak (0) was compression */ 443 int usb_bandwidth; /* Mbit/s */ 444 445 /* Statistics that can be overlayed on the screen */ 446 unsigned long isoc_urb_count; /* How many URBs we received so far */ 447 unsigned long urb_length; /* Length of last URB */ 448 unsigned long isoc_data_count; /* How many bytes we received */ 449 unsigned long header_count; /* How many frame headers we found */ 450 unsigned long scratch_ovf_count; /* How many times we overflowed scratch */ 451 unsigned long isoc_skip_count; /* How many empty ISO packets received */ 452 unsigned long isoc_err_count; /* How many bad ISO packets received */ 453 unsigned long isoc_packet_count; /* How many packets we totally got */ 454 unsigned long time_in_irq; /* How long do we need for interrupt */ 455 int isoc_measure_bandwidth_count; 456 int frame_num; /* How many video frames we send to user */ 457 int max_strip_len; /* How big is the biggest strip */ 458 int comprblock_pos; 459 int strip_len_errors; /* How many times was block_pos greater than strip_len */ 460 int strip_magic_errors; 461 int strip_line_number_errors; 462 int compr_block_types[4]; 463}; 464 465static inline struct usb_usbvision *to_usbvision(struct v4l2_device *v4l2_dev) 466{ 467 return container_of(v4l2_dev, struct usb_usbvision, v4l2_dev); 468} 469 470#define call_all(usbvision, o, f, args...) \ 471 v4l2_device_call_all(&usbvision->v4l2_dev, 0, o, f, ##args) 472 473/* --------------------------------------------------------------- */ 474/* defined in usbvision-i2c.c */ 475/* i2c-algo-usb declaration */ 476/* --------------------------------------------------------------- */ 477 478/* ----------------------------------------------------------------------- */ 479/* usbvision specific I2C functions */ 480/* ----------------------------------------------------------------------- */ 481int usbvision_i2c_register(struct usb_usbvision *usbvision); 482int usbvision_i2c_unregister(struct usb_usbvision *usbvision); 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 audio_channel); 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_power_off_timer(struct usb_usbvision *usbvision); 514void usbvision_set_power_off_timer(struct usb_usbvision *usbvision); 515void usbvision_reset_power_off_timer(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