3 * usbvision header file
5 * Copyright (c) 1999-2005 Joerg Heckenbach <joerg@heckenbach-aw.de>
6 * Dwaine Garden <dwainegarden@rogers.com>
9 * Report problems to v4l MailingList: linux-media@vger.kernel.org
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>
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.
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.
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.
31 #ifndef __LINUX_USBVISION_H
32 #define __LINUX_USBVISION_H
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>
42 #define USBVISION_DEBUG /* Turn on debug messages */
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
132 #define MAX_BYTES_PER_PIXEL 4
134 #define MIN_FRAME_WIDTH 64
135 #define MAX_USB_WIDTH 320 /* 384 */
136 #define MAX_FRAME_WIDTH 320 /* 384 */ /* streching sometimes causes crashes*/
138 #define MIN_FRAME_HEIGHT 48
139 #define MAX_USB_HEIGHT 240 /* 288 */
140 #define MAX_FRAME_HEIGHT 240 /* 288 */ /* Streching sometimes causes crashes*/
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 */
145 #define USBVISION_URB_FRAMES 32
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 */
151 #define USBVISION_POWEROFF_TIME (3 * HZ) /* 3 seconds */
154 #define FRAMERATE_MIN 0
155 #define FRAMERATE_MAX 31
158 ISOC_MODE_YUV422
= 0x03,
159 ISOC_MODE_YUV420
= 0x14,
160 ISOC_MODE_COMPRESS
= 0x60,
163 /* This macro restricts an int variable to an inclusive range */
164 #define RESTRICT_TO_RANGE(v, mi, ma) \
165 { if ((v) < (mi)) (v) = (mi); else if ((v) > (ma)) (v) = (ma); }
168 * We use macros to do YUV -> RGB conversion because this is
169 * very important for speed and totally unimportant for size.
171 * YUV -> RGB Conversion
172 * ---------------------
174 * B = 1.164*(Y-16) + 2.018*(V-128)
175 * G = 1.164*(Y-16) - 0.813*(U-128) - 0.391*(V-128)
176 * R = 1.164*(Y-16) + 1.596*(U-128)
178 * If you fancy integer arithmetics (as you should), hear this:
180 * 65536*B = 76284*(Y-16) + 132252*(V-128)
181 * 65536*G = 76284*(Y-16) - 53281*(U-128) - 25625*(V-128)
182 * 65536*R = 76284*(Y-16) + 104595*(U-128)
184 * Make sure the output values are within [0..255] range.
186 #define LIMIT_RGB(x) (((x) < 0) ? 0 : (((x) > 255) ? 255 : (x)))
187 #define YUV_TO_RGB_BY_THE_BOOK(my, mu, mv, mr, mg, mb) { \
188 int mm_y, mm_yc, mm_u, mm_v, mm_r, mm_g, mm_b; \
192 mm_yc = mm_y * 76284; \
193 mm_b = (mm_yc + 132252 * mm_v) >> 16; \
194 mm_g = (mm_yc - 53281 * mm_u - 25625 * mm_v) >> 16; \
195 mm_r = (mm_yc + 104595 * mm_u) >> 16; \
196 mb = LIMIT_RGB(mm_b); \
197 mg = LIMIT_RGB(mm_g); \
198 mr = LIMIT_RGB(mm_r); \
202 #define USBVISION_SAY_AND_WAIT(what) { \
203 wait_queue_head_t wq; \
204 init_waitqueue_head(&wq); \
205 printk(KERN_INFO "Say: %s\n", what); \
206 interruptible_sleep_on_timeout(&wq, HZ * 3); \
210 * This macro checks if usbvision is still operational. The 'usbvision'
211 * pointer must be valid, usbvision->dev must be valid, we are not
212 * removing the device and the device has not erred on us.
214 #define USBVISION_IS_OPERATIONAL(udevice) (\
215 (udevice != NULL) && \
216 ((udevice)->dev != NULL) && \
217 ((udevice)->last_error == 0) && \
218 (!(udevice)->remove_pending))
220 #define I2C_USB_ADAP_MAX 16
222 #define USBVISION_NORMS (V4L2_STD_PAL | V4L2_STD_NTSC | V4L2_STD_SECAM | V4L2_STD_PAL_M)
224 /* ----------------------------------------------------------------- */
225 /* usbvision video structures */
226 /* ----------------------------------------------------------------- */
228 scan_state_scanning
, /* Scanning for header */
229 scan_state_lines
/* Parsing lines */
232 /* Completion states of the data parser */
234 parse_state_continue
, /* Just parse next item */
235 parse_state_next_frame
, /* Frame done, send it to V4L */
236 parse_state_out
, /* Not enough data for frame */
237 parse_state_end_parse
/* End parsing */
241 frame_state_unused
, /* Unused (no MCAPTURE) */
242 frame_state_ready
, /* Ready to start grabbing */
243 frame_state_grabbing
, /* In the process of being grabbed into */
244 frame_state_done
, /* Finished grabbing, but not been synced yet */
245 frame_state_done_hold
, /* Are syncing or reading */
246 frame_state_error
, /* Something bad happened while processing */
251 stream_off
, /* Driver streaming is completely OFF */
252 stream_idle
, /* Driver streaming is ready to be put ON by the application */
253 stream_interrupt
, /* Driver streaming must be interrupted */
254 stream_on
, /* Driver streaming is put ON by the application */
258 isoc_state_in_frame
, /* Isoc packet is member of frame */
259 isoc_state_no_frame
, /* Isoc packet is not member of any frame */
264 struct usbvision_sbuf
{
269 #define USBVISION_MAGIC_1 0x55
270 #define USBVISION_MAGIC_2 0xAA
271 #define USBVISION_HEADER_LENGTH 0x0c
272 #define USBVISION_SAA7111_ADDR 0x48
273 #define USBVISION_SAA7113_ADDR 0x4a
274 #define USBVISION_IIC_LRACK 0x20
275 #define USBVISION_IIC_LRNACK 0x30
276 #define USBVISION_FRAME_FORMAT_PARAM_INTRA (1<<7)
278 struct usbvision_v4l2_format_st
{
285 #define USBVISION_SUPPORTED_PALETTES ARRAY_SIZE(usbvision_v4l2_format)
287 struct usbvision_frame_header
{
288 unsigned char magic_1
; /* 0 magic */
289 unsigned char magic_2
; /* 1 magic */
290 unsigned char header_length
; /* 2 */
291 unsigned char frame_num
; /* 3 */
292 unsigned char frame_phase
; /* 4 */
293 unsigned char frame_latency
; /* 5 */
294 unsigned char data_format
; /* 6 */
295 unsigned char format_param
; /* 7 */
296 unsigned char frame_width_lo
; /* 8 */
297 unsigned char frame_width_hi
; /* 9 */
298 unsigned char frame_height_lo
; /* 10 */
299 unsigned char frame_height_hi
; /* 11 */
300 __u16 frame_width
; /* 8 - 9 after endian correction*/
301 __u16 frame_height
; /* 10 - 11 after endian correction*/
304 struct usbvision_frame
{
305 char *data
; /* Frame buffer */
306 struct usbvision_frame_header isoc_header
; /* Header from stream */
308 int width
; /* Width application is expecting */
309 int height
; /* Height */
310 int index
; /* Frame index */
311 int frmwidth
; /* Width the frame actually is */
312 int frmheight
; /* Height */
314 volatile int grabstate
; /* State of grabbing */
315 int scanstate
; /* State of scanning */
317 struct list_head frame
;
319 int curline
; /* Line of frame we're working on */
321 long scanlength
; /* uncompressed, raw data length of frame */
322 long bytes_read
; /* amount of scanlength that has been read from data */
323 struct usbvision_v4l2_format_st v4l2_format
; /* format the user needs*/
324 int v4l2_linesize
; /* bytes for one videoline*/
325 struct timeval timestamp
;
326 int sequence
; /* How many video frames we send to user */
329 #define CODEC_SAA7113 7113
330 #define CODEC_SAA7111 7111
331 #define BRIDGE_NT1003 1003
332 #define BRIDGE_NT1004 1004
333 #define BRIDGE_NT1005 1005
335 struct usbvision_device_data_st
{
337 const char *model_string
;
338 int interface
; /* to handle special interface number like BELKIN and Hauppauge WinTV-USB II */
340 unsigned video_channels
:3;
341 unsigned audio_channels
:2;
345 unsigned vin_reg1_override
:1; /* Override default value with */
346 unsigned vin_reg2_override
:1; /* vin_reg1, vin_reg2, etc. */
347 unsigned dvi_yuv_override
:1;
356 /* Declared on usbvision-cards.c */
357 extern struct usbvision_device_data_st usbvision_device_data
[];
358 extern struct usb_device_id usbvision_table
[];
360 struct usb_usbvision
{
361 struct v4l2_device v4l2_dev
;
362 struct video_device
*vdev
; /* Video Device */
363 struct video_device
*rdev
; /* Radio Device */
365 /* i2c Declaration Section*/
366 struct i2c_adapter i2c_adap
;
369 struct urb
*ctrl_urb
;
370 unsigned char ctrl_urb_buffer
[8];
372 struct usb_ctrlrequest ctrl_urb_setup
;
373 wait_queue_head_t ctrl_urb_wq
; /* Processes waiting */
375 /* configuration part */
378 int bridge_type
; /* NT1003, NT1004, NT1005 */
380 int video_inputs
; /* # of inputs */
384 int isoc_mode
; /* format of video data for the usb isoc-transfer */
385 unsigned int nr
; /* Number of the device */
387 /* Device structure */
388 struct usb_device
*dev
;
390 int num_alt
; /* Number of alternative settings */
391 unsigned int *alt_max_pkt_size
; /* array of max_packet_size */
392 unsigned char iface
; /* Video interface number */
393 unsigned char iface_alt
; /* Alt settings */
394 unsigned char vin_reg2_preset
;
395 struct mutex v4l2_lock
;
396 struct timer_list power_off_timer
;
397 struct work_struct power_off_work
;
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 dev_model
; /* What type of USBVISION device we got? */
402 enum stream_state 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
*cur_frame
; /* 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 */
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 isoc_state isocstate
;
429 struct usbvision_v4l2_format_st palette
;
431 struct v4l2_capability vcap
; /* Video capabilities */
432 unsigned int ctl_input
; /* selected input */
433 v4l2_std_id tvnorm_id
; /* selected tv norm */
434 unsigned char video_endp
; /* 0x82 for USBVISION devices based */
436 /* Decompression stuff: */
437 unsigned char *intra_frame_buffer
; /* Buffer for reference frame */
438 int block_pos
; /* for test only */
439 int request_intra
; /* 0 = normal; 1 = intra frame is requested; */
440 int last_isoc_frame_num
; /* check for lost isoc frames */
441 int isoc_packet_size
; /* need to calculate used_bandwidth */
442 int used_bandwidth
; /* used bandwidth 0-100%, need to set compr_level */
443 int compr_level
; /* How strong (100) or weak (0) is compression */
444 int last_compr_level
; /* How strong (100) or weak (0) was compression */
445 int usb_bandwidth
; /* Mbit/s */
447 /* Statistics that can be overlayed on the screen */
448 unsigned long isoc_urb_count
; /* How many URBs we received so far */
449 unsigned long urb_length
; /* Length of last URB */
450 unsigned long isoc_data_count
; /* 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 isoc_skip_count
; /* How many empty ISO packets received */
454 unsigned long isoc_err_count
; /* How many bad ISO packets received */
455 unsigned long isoc_packet_count
; /* How many packets we totally got */
456 unsigned long time_in_irq
; /* How long do we need for interrupt */
457 int isoc_measure_bandwidth_count
;
458 int frame_num
; /* How many video frames we send to user */
459 int max_strip_len
; /* How big is the biggest strip */
461 int strip_len_errors
; /* How many times was block_pos greater than strip_len */
462 int strip_magic_errors
;
463 int strip_line_number_errors
;
464 int compr_block_types
[4];
467 static inline struct usb_usbvision
*to_usbvision(struct v4l2_device
*v4l2_dev
)
469 return container_of(v4l2_dev
, struct usb_usbvision
, v4l2_dev
);
472 #define call_all(usbvision, o, f, args...) \
473 v4l2_device_call_all(&usbvision->v4l2_dev, 0, o, f, ##args)
475 /* --------------------------------------------------------------- */
476 /* defined in usbvision-i2c.c */
477 /* i2c-algo-usb declaration */
478 /* --------------------------------------------------------------- */
480 /* ----------------------------------------------------------------------- */
481 /* usbvision specific I2C functions */
482 /* ----------------------------------------------------------------------- */
483 int usbvision_i2c_register(struct usb_usbvision
*usbvision
);
484 int usbvision_i2c_unregister(struct usb_usbvision
*usbvision
);
486 /* defined in usbvision-core.c */
487 int usbvision_read_reg(struct usb_usbvision
*usbvision
, unsigned char reg
);
488 int usbvision_write_reg(struct usb_usbvision
*usbvision
, unsigned char reg
,
489 unsigned char value
);
491 int usbvision_frames_alloc(struct usb_usbvision
*usbvision
, int number_of_frames
);
492 void usbvision_frames_free(struct usb_usbvision
*usbvision
);
493 int usbvision_scratch_alloc(struct usb_usbvision
*usbvision
);
494 void usbvision_scratch_free(struct usb_usbvision
*usbvision
);
495 int usbvision_decompress_alloc(struct usb_usbvision
*usbvision
);
496 void usbvision_decompress_free(struct usb_usbvision
*usbvision
);
498 int usbvision_setup(struct usb_usbvision
*usbvision
, int format
);
499 int usbvision_init_isoc(struct usb_usbvision
*usbvision
);
500 int usbvision_restart_isoc(struct usb_usbvision
*usbvision
);
501 void usbvision_stop_isoc(struct usb_usbvision
*usbvision
);
502 int usbvision_set_alternate(struct usb_usbvision
*dev
);
504 int usbvision_set_audio(struct usb_usbvision
*usbvision
, int audio_channel
);
505 int usbvision_audio_off(struct usb_usbvision
*usbvision
);
507 int usbvision_begin_streaming(struct usb_usbvision
*usbvision
);
508 void usbvision_empty_framequeues(struct usb_usbvision
*dev
);
509 int usbvision_stream_interrupt(struct usb_usbvision
*dev
);
511 int usbvision_muxsel(struct usb_usbvision
*usbvision
, int channel
);
512 int usbvision_set_input(struct usb_usbvision
*usbvision
);
513 int usbvision_set_output(struct usb_usbvision
*usbvision
, int width
, int height
);
515 void usbvision_init_power_off_timer(struct usb_usbvision
*usbvision
);
516 void usbvision_set_power_off_timer(struct usb_usbvision
*usbvision
);
517 void usbvision_reset_power_off_timer(struct usb_usbvision
*usbvision
);
518 int usbvision_power_off(struct usb_usbvision
*usbvision
);
519 int usbvision_power_on(struct usb_usbvision
*usbvision
);
521 #endif /* __LINUX_USBVISION_H */
524 * Overrides for Emacs so that we follow Linus's tabbing style.
525 * ---------------------------------------------------------------------------