3 * usbvision header file
5 * Copyright (c) 1999-2005 Joerg Heckenbach <joerg@heckenbach-aw.de>
7 * This module is part of usbvision driver project.
8 * Updates to driver completed by Dwaine P. Garden
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.
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.
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.
26 #ifndef __LINUX_USBVISION_H
27 #define __LINUX_USBVISION_H
29 #include <linux/list.h>
30 #include <linux/usb.h>
31 #include <media/v4l2-common.h>
32 #include <media/tuner.h>
33 #include <linux/videodev2.h>
35 #ifndef VID_HARDWARE_USBVISION
36 #define VID_HARDWARE_USBVISION 34 /* USBVision Video Grabber */
39 #define USBVISION_PWR_REG 0x00
40 #define USBVISION_SSPND_EN (1 << 1)
41 #define USBVISION_RES2 (1 << 2)
42 #define USBVISION_PWR_VID (1 << 5)
43 #define USBVISION_E2_EN (1 << 7)
44 #define USBVISION_CONFIG_REG 0x01
45 #define USBVISION_ADRS_REG 0x02
46 #define USBVISION_ALTER_REG 0x03
47 #define USBVISION_FORCE_ALTER_REG 0x04
48 #define USBVISION_STATUS_REG 0x05
49 #define USBVISION_IOPIN_REG 0x06
50 #define USBVISION_IO_1 (1 << 0)
51 #define USBVISION_IO_2 (1 << 1)
52 #define USBVISION_AUDIO_IN 0
53 #define USBVISION_AUDIO_TV 1
54 #define USBVISION_AUDIO_RADIO 2
55 #define USBVISION_AUDIO_MUTE 3
56 #define USBVISION_SER_MODE 0x07
57 #define USBVISION_SER_ADRS 0x08
58 #define USBVISION_SER_CONT 0x09
59 #define USBVISION_SER_DAT1 0x0A
60 #define USBVISION_SER_DAT2 0x0B
61 #define USBVISION_SER_DAT3 0x0C
62 #define USBVISION_SER_DAT4 0x0D
63 #define USBVISION_EE_DATA 0x0E
64 #define USBVISION_EE_LSBAD 0x0F
65 #define USBVISION_EE_CONT 0x10
66 #define USBVISION_DRM_CONT 0x12
67 #define USBVISION_REF (1 << 0)
68 #define USBVISION_RES_UR (1 << 2)
69 #define USBVISION_RES_FDL (1 << 3)
70 #define USBVISION_RES_VDW (1 << 4)
71 #define USBVISION_DRM_PRM1 0x13
72 #define USBVISION_DRM_PRM2 0x14
73 #define USBVISION_DRM_PRM3 0x15
74 #define USBVISION_DRM_PRM4 0x16
75 #define USBVISION_DRM_PRM5 0x17
76 #define USBVISION_DRM_PRM6 0x18
77 #define USBVISION_DRM_PRM7 0x19
78 #define USBVISION_DRM_PRM8 0x1A
79 #define USBVISION_VIN_REG1 0x1B
80 #define USBVISION_8_422_SYNC 0x01
81 #define USBVISION_16_422_SYNC 0x02
82 #define USBVISION_VSNC_POL (1 << 3)
83 #define USBVISION_HSNC_POL (1 << 4)
84 #define USBVISION_FID_POL (1 << 5)
85 #define USBVISION_HVALID_PO (1 << 6)
86 #define USBVISION_VCLK_POL (1 << 7)
87 #define USBVISION_VIN_REG2 0x1C
88 #define USBVISION_AUTO_FID (1 << 0)
89 #define USBVISION_NONE_INTER (1 << 1)
90 #define USBVISION_NOHVALID (1 << 2)
91 #define USBVISION_UV_ID (1 << 3)
92 #define USBVISION_FIX_2C (1 << 4)
93 #define USBVISION_SEND_FID (1 << 5)
94 #define USBVISION_KEEP_BLANK (1 << 7)
95 #define USBVISION_LXSIZE_I 0x1D
96 #define USBVISION_MXSIZE_I 0x1E
97 #define USBVISION_LYSIZE_I 0x1F
98 #define USBVISION_MYSIZE_I 0x20
99 #define USBVISION_LX_OFFST 0x21
100 #define USBVISION_MX_OFFST 0x22
101 #define USBVISION_LY_OFFST 0x23
102 #define USBVISION_MY_OFFST 0x24
103 #define USBVISION_FRM_RATE 0x25
104 #define USBVISION_LXSIZE_O 0x26
105 #define USBVISION_MXSIZE_O 0x27
106 #define USBVISION_LYSIZE_O 0x28
107 #define USBVISION_MYSIZE_O 0x29
108 #define USBVISION_FILT_CONT 0x2A
109 #define USBVISION_VO_MODE 0x2B
110 #define USBVISION_INTRA_CYC 0x2C
111 #define USBVISION_STRIP_SZ 0x2D
112 #define USBVISION_FORCE_INTRA 0x2E
113 #define USBVISION_FORCE_UP 0x2F
114 #define USBVISION_BUF_THR 0x30
115 #define USBVISION_DVI_YUV 0x31
116 #define USBVISION_AUDIO_CONT 0x32
117 #define USBVISION_AUD_PK_LEN 0x33
118 #define USBVISION_BLK_PK_LEN 0x34
119 #define USBVISION_PCM_THR1 0x38
120 #define USBVISION_PCM_THR2 0x39
121 #define USBVISION_DIST_THR_L 0x3A
122 #define USBVISION_DIST_THR_H 0x3B
123 #define USBVISION_MAX_DIST_L 0x3C
124 #define USBVISION_MAX_DIST_H 0x3D
125 #define USBVISION_OP_CODE 0x33
127 #define MAX_BYTES_PER_PIXEL 4
129 #define MIN_FRAME_WIDTH 64
130 #define MAX_USB_WIDTH 320 //384
131 #define MAX_FRAME_WIDTH 320 //384 /*streching sometimes causes crashes*/
133 #define MIN_FRAME_HEIGHT 48
134 #define MAX_USB_HEIGHT 240 //288
135 #define MAX_FRAME_HEIGHT 240 //288 /*Streching sometimes causes crashes*/
137 #define MAX_FRAME_SIZE (MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT * MAX_BYTES_PER_PIXEL)
138 #define USBVISION_CLIPMASK_SIZE (MAX_FRAME_WIDTH * MAX_FRAME_HEIGHT / 8) //bytesize of clipmask
140 #define USBVISION_URB_FRAMES 32
141 #define USBVISION_MAX_ISOC_PACKET_SIZE 959 // NT1003 Specs Document says 1023
143 #define USBVISION_NUM_HEADERMARKER 20
144 #define USBVISION_NUMFRAMES 3 /* Maximum number of frames an application can get */
145 #define USBVISION_NUMSBUF 2 /* Dimensioning the USB S buffering */
147 #define USBVISION_POWEROFF_TIME 3 * (HZ) // 3 seconds
150 #define FRAMERATE_MIN 0
151 #define FRAMERATE_MAX 31
154 ISOC_MODE_YUV422
= 0x03,
155 ISOC_MODE_YUV420
= 0x14,
156 ISOC_MODE_COMPRESS
= 0x60,
159 /* This macro restricts an int variable to an inclusive range */
160 #define RESTRICT_TO_RANGE(v,mi,ma) { if ((v) < (mi)) (v) = (mi); else if ((v) > (ma)) (v) = (ma); }
163 * We use macros to do YUV -> RGB conversion because this is
164 * very important for speed and totally unimportant for size.
166 * YUV -> RGB Conversion
167 * ---------------------
169 * B = 1.164*(Y-16) + 2.018*(V-128)
170 * G = 1.164*(Y-16) - 0.813*(U-128) - 0.391*(V-128)
171 * R = 1.164*(Y-16) + 1.596*(U-128)
173 * If you fancy integer arithmetics (as you should), hear this:
175 * 65536*B = 76284*(Y-16) + 132252*(V-128)
176 * 65536*G = 76284*(Y-16) - 53281*(U-128) - 25625*(V-128)
177 * 65536*R = 76284*(Y-16) + 104595*(U-128)
179 * Make sure the output values are within [0..255] range.
181 #define LIMIT_RGB(x) (((x) < 0) ? 0 : (((x) > 255) ? 255 : (x)))
182 #define YUV_TO_RGB_BY_THE_BOOK(my,mu,mv,mr,mg,mb) { \
183 int mm_y, mm_yc, mm_u, mm_v, mm_r, mm_g, mm_b; \
187 mm_yc= mm_y * 76284; \
188 mm_b = (mm_yc + 132252*mm_v ) >> 16; \
189 mm_g = (mm_yc - 53281*mm_u - 25625*mm_v ) >> 16; \
190 mm_r = (mm_yc + 104595*mm_u ) >> 16; \
191 mb = LIMIT_RGB(mm_b); \
192 mg = LIMIT_RGB(mm_g); \
193 mr = LIMIT_RGB(mm_r); \
197 #define USBVISION_SAY_AND_WAIT(what) { \
198 wait_queue_head_t wq; \
199 init_waitqueue_head(&wq); \
200 printk(KERN_INFO "Say: %s\n", what); \
201 interruptible_sleep_on_timeout (&wq, HZ*3); \
205 * This macro checks if usbvision is still operational. The 'usbvision'
206 * pointer must be valid, usbvision->dev must be valid, we are not
207 * removing the device and the device has not erred on us.
209 #define USBVISION_IS_OPERATIONAL(udevice) (\
210 (udevice != NULL) && \
211 ((udevice)->dev != NULL) && \
212 ((udevice)->last_error == 0) && \
213 (!(udevice)->remove_pending))
216 struct i2c_algo_usb_data
{
217 void *data
; /* private data for lowlevel routines */
218 int (*inb
) (void *data
, unsigned char addr
, char *buf
, short len
);
219 int (*outb
) (void *data
, unsigned char addr
, char *buf
, short len
);
227 #define I2C_USB_ADAP_MAX 16
229 /* ----------------------------------------------------------------- */
230 /* usbvision video structures */
231 /* ----------------------------------------------------------------- */
233 ScanState_Scanning
, /* Scanning for header */
234 ScanState_Lines
/* Parsing lines */
237 /* Completion states of the data parser */
239 ParseState_Continue
, /* Just parse next item */
240 ParseState_NextFrame
, /* Frame done, send it to V4L */
241 ParseState_Out
, /* Not enough data for frame */
242 ParseState_EndParse
/* End parsing */
246 FrameState_Unused
, /* Unused (no MCAPTURE) */
247 FrameState_Ready
, /* Ready to start grabbing */
248 FrameState_Grabbing
, /* In the process of being grabbed into */
249 FrameState_Done
, /* Finished grabbing, but not been synced yet */
250 FrameState_DoneHold
, /* Are syncing or reading */
251 FrameState_Error
, /* Something bad happened while processing */
256 Stream_Off
, /* Driver streaming is completely OFF */
257 Stream_Idle
, /* Driver streaming is ready to be put ON by the application */
258 Stream_Interrupt
, /* Driver streaming must be interrupted */
259 Stream_On
, /* Driver streaming is put ON by the application */
263 IsocState_InFrame
, /* Isoc packet is member of frame */
264 IsocState_NoFrame
, /* Isoc packet is not member of any frame */
269 struct usbvision_sbuf
{
274 #define USBVISION_MAGIC_1 0x55
275 #define USBVISION_MAGIC_2 0xAA
276 #define USBVISION_HEADER_LENGTH 0x0c
277 #define USBVISION_SAA7111_ADDR 0x48
278 #define USBVISION_SAA7113_ADDR 0x4a
279 #define USBVISION_IIC_LRACK 0x20
280 #define USBVISION_IIC_LRNACK 0x30
281 #define USBVISION_FRAME_FORMAT_PARAM_INTRA (1<<7)
283 struct usbvision_v4l2_format_st
{
290 #define USBVISION_SUPPORTED_PALETTES ARRAY_SIZE(usbvision_v4l2_format)
292 struct usbvision_frame_header
{
293 unsigned char magic_1
; /* 0 magic */
294 unsigned char magic_2
; /* 1 magic */
295 unsigned char headerLength
; /* 2 */
296 unsigned char frameNum
; /* 3 */
297 unsigned char framePhase
; /* 4 */
298 unsigned char frameLatency
; /* 5 */
299 unsigned char dataFormat
; /* 6 */
300 unsigned char formatParam
; /* 7 */
301 unsigned char frameWidthLo
; /* 8 */
302 unsigned char frameWidthHi
; /* 9 */
303 unsigned char frameHeightLo
; /* 10 */
304 unsigned char frameHeightHi
; /* 11 */
305 __u16 frameWidth
; /* 8 - 9 after endian correction*/
306 __u16 frameHeight
; /* 10 - 11 after endian correction*/
310 struct usbvision_tvnorm
{
313 /* mode for saa7113h */
317 struct usbvision_frame
{
318 char *data
; /* Frame buffer */
319 struct usbvision_frame_header isocHeader
; /* Header from stream */
321 int width
; /* Width application is expecting */
322 int height
; /* Height */
323 int index
; /* Frame index */
324 int frmwidth
; /* Width the frame actually is */
325 int frmheight
; /* Height */
327 volatile int grabstate
; /* State of grabbing */
328 int scanstate
; /* State of scanning */
330 struct list_head frame
;
332 int curline
; /* Line of frame we're working on */
334 long scanlength
; /* uncompressed, raw data length of frame */
335 long bytes_read
; /* amount of scanlength that has been read from data */
336 struct usbvision_v4l2_format_st v4l2_format
; /* format the user needs*/
337 int v4l2_linesize
; /* bytes for one videoline*/
338 struct timeval timestamp
;
339 int sequence
; // How many video frames we send to user
342 #define CODEC_SAA7113 7113
343 #define CODEC_SAA7111 7111
344 #define BRIDGE_NT1003 1003
345 #define BRIDGE_NT1004 1004
346 #define BRIDGE_NT1005 1005
348 struct usbvision_device_data_st
{
351 int Interface
; /* to handle special interface number like BELKIN and Hauppauge WinTV-USB II */
368 /* Declared on usbvision-cards.c */
369 extern struct usbvision_device_data_st usbvision_device_data
[];
370 extern struct usb_device_id usbvision_table
[];
372 struct usb_usbvision
{
373 struct video_device
*vdev
; /* Video Device */
374 struct video_device
*rdev
; /* Radio Device */
375 struct video_device
*vbi
; /* VBI Device */
377 /* i2c Declaration Section*/
378 struct i2c_adapter i2c_adap
;
379 struct i2c_algo_usb_data i2c_algo
;
380 struct i2c_client i2c_client
;
383 unsigned char ctrlUrbBuffer
[8];
385 struct usb_ctrlrequest ctrlUrbSetup
;
386 wait_queue_head_t ctrlUrb_wq
; // Processes waiting
387 struct semaphore ctrlUrbLock
;
389 /* configuration part */
393 int bridgeType
; // NT1003, NT1004, NT1005
396 int video_inputs
; // # of inputs
400 int isocMode
; // format of video data for the usb isoc-transfer
401 unsigned int nr
; // Number of the device
403 /* Device structure */
404 struct usb_device
*dev
;
405 unsigned char iface
; /* Video interface number */
406 unsigned char ifaceAltActive
, ifaceAltInactive
; /* Alt settings */
407 unsigned char Vin_Reg2_Preset
;
408 struct semaphore lock
;
409 struct timer_list powerOffTimer
;
410 struct work_struct powerOffWork
;
411 int power
; /* is the device powered on? */
412 int user
; /* user count for exclusive use */
413 int initialized
; /* Had we already sent init sequence? */
414 int DevModel
; /* What type of USBVISION device we got? */
415 enum StreamState streaming
; /* Are we streaming Isochronous? */
416 int last_error
; /* What calamity struck us? */
417 int curwidth
; /* width of the frame the device is currently set to*/
418 int curheight
; /* height of the frame the device is currently set to*/
419 int stretch_width
; /* stretch-factor for frame width (from usb to screen)*/
420 int stretch_height
; /* stretch-factor for frame height (from usb to screen)*/
421 char *fbuf
; /* Videodev buffer area for mmap*/
422 int max_frame_size
; /* Bytes in one video frame */
423 int fbuf_size
; /* Videodev buffer size */
424 spinlock_t queue_lock
; /* spinlock for protecting mods on inqueue and outqueue */
425 struct list_head inqueue
, outqueue
; /* queued frame list and ready to dequeue frame list */
426 wait_queue_head_t wait_frame
; /* Processes waiting */
427 wait_queue_head_t wait_stream
; /* Processes waiting */
428 struct usbvision_frame
*curFrame
; // pointer to current frame, set by usbvision_find_header
429 struct usbvision_frame frame
[USBVISION_NUMFRAMES
]; // frame buffer
430 struct usbvision_sbuf sbuf
[USBVISION_NUMSBUF
]; // S buffering
431 volatile int remove_pending
; /* If set then about to exit */
433 /* Scratch space from the Isochronous Pipe.*/
434 unsigned char *scratch
;
435 int scratch_read_ptr
;
436 int scratch_write_ptr
;
437 int scratch_headermarker
[USBVISION_NUM_HEADERMARKER
];
438 int scratch_headermarker_read_ptr
;
439 int scratch_headermarker_write_ptr
;
440 enum IsocState isocstate
;
441 struct usbvision_v4l2_format_st palette
;
443 struct v4l2_capability vcap
; /* Video capabilities */
444 unsigned int ctl_input
; /* selected input */
445 struct usbvision_tvnorm
*tvnorm
; /* selected tv norm */
446 unsigned char video_endp
; /* 0x82 for USBVISION devices based */
448 // Decompression stuff:
449 unsigned char *IntraFrameBuffer
; /* Buffer for reference frame */
450 int BlockPos
; //for test only
451 int requestIntra
; // 0 = normal; 1 = intra frame is requested;
452 int lastIsocFrameNum
; // check for lost isoc frames
453 int isocPacketSize
; // need to calculate usedBandwidth
454 int usedBandwidth
; // used bandwidth 0-100%, need to set comprLevel
455 int comprLevel
; // How strong (100) or weak (0) is compression
456 int lastComprLevel
; // How strong (100) or weak (0) was compression
457 int usb_bandwidth
; /* Mbit/s */
459 /* Statistics that can be overlayed on the screen */
460 unsigned long isocUrbCount
; // How many URBs we received so far
461 unsigned long urb_length
; /* Length of last URB */
462 unsigned long isocDataCount
; /* How many bytes we received */
463 unsigned long header_count
; /* How many frame headers we found */
464 unsigned long scratch_ovf_count
; /* How many times we overflowed scratch */
465 unsigned long isocSkipCount
; /* How many empty ISO packets received */
466 unsigned long isocErrCount
; /* How many bad ISO packets received */
467 unsigned long isocPacketCount
; // How many packets we totally got
468 unsigned long timeInIrq
; // How long do we need for interrupt
469 int isocMeasureBandwidthCount
;
470 int frame_num
; // How many video frames we send to user
471 int maxStripLen
; // How big is the biggest strip
473 int stripLenErrors
; // How many times was BlockPos greater than StripLen
474 int stripMagicErrors
;
475 int stripLineNumberErrors
;
476 int ComprBlockTypes
[4];
480 /* --------------------------------------------------------------- */
481 /* defined in usbvision-i2c.c */
482 /* i2c-algo-usb declaration */
483 /* --------------------------------------------------------------- */
485 int usbvision_i2c_usb_add_bus(struct i2c_adapter
*);
486 int usbvision_i2c_usb_del_bus(struct i2c_adapter
*);
488 static inline void *i2c_get_algo_usb_data (struct i2c_algo_usb_data
*dev
)
493 static inline void i2c_set_algo_usb_data (struct i2c_algo_usb_data
*dev
, void *data
)
499 /* ----------------------------------------------------------------------- */
500 /* usbvision specific I2C functions */
501 /* ----------------------------------------------------------------------- */
502 int usbvision_init_i2c(struct usb_usbvision
*usbvision
);
503 void call_i2c_clients(struct usb_usbvision
*usbvision
, unsigned int cmd
,void *arg
);
505 /* defined in usbvision-core.c */
506 void *usbvision_rvmalloc(unsigned long size
);
507 void usbvision_rvfree(void *mem
, unsigned long size
);
508 int usbvision_read_reg(struct usb_usbvision
*usbvision
, unsigned char reg
);
509 int usbvision_write_reg(struct usb_usbvision
*usbvision
, unsigned char reg
,
510 unsigned char value
);
512 int usbvision_frames_alloc(struct usb_usbvision
*usbvision
);
513 void usbvision_frames_free(struct usb_usbvision
*usbvision
);
514 int usbvision_scratch_alloc(struct usb_usbvision
*usbvision
);
515 void usbvision_scratch_free(struct usb_usbvision
*usbvision
);
516 int usbvision_sbuf_alloc(struct usb_usbvision
*usbvision
);
517 void usbvision_sbuf_free(struct usb_usbvision
*usbvision
);
518 int usbvision_decompress_alloc(struct usb_usbvision
*usbvision
);
519 void usbvision_decompress_free(struct usb_usbvision
*usbvision
);
521 int usbvision_setup(struct usb_usbvision
*usbvision
,int format
);
522 int usbvision_init_isoc(struct usb_usbvision
*usbvision
);
523 int usbvision_restart_isoc(struct usb_usbvision
*usbvision
);
524 void usbvision_stop_isoc(struct usb_usbvision
*usbvision
);
526 int usbvision_set_audio(struct usb_usbvision
*usbvision
, int AudioChannel
);
527 int usbvision_audio_off(struct usb_usbvision
*usbvision
);
529 int usbvision_begin_streaming(struct usb_usbvision
*usbvision
);
530 void usbvision_empty_framequeues(struct usb_usbvision
*dev
);
531 int usbvision_stream_interrupt(struct usb_usbvision
*dev
);
533 int usbvision_muxsel(struct usb_usbvision
*usbvision
, int channel
);
534 int usbvision_set_input(struct usb_usbvision
*usbvision
);
535 int usbvision_set_output(struct usb_usbvision
*usbvision
, int width
, int height
);
537 void usbvision_init_powerOffTimer(struct usb_usbvision
*usbvision
);
538 void usbvision_set_powerOffTimer(struct usb_usbvision
*usbvision
);
539 void usbvision_reset_powerOffTimer(struct usb_usbvision
*usbvision
);
540 int usbvision_power_off(struct usb_usbvision
*usbvision
);
541 int usbvision_power_on(struct usb_usbvision
*usbvision
);
543 #endif /* __LINUX_USBVISION_H */
546 * Overrides for Emacs so that we follow Linus's tabbing style.
547 * ---------------------------------------------------------------------------