Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
usbvision.h
Go to the documentation of this file.
1 /*
2  * USBVISION.H
3  * usbvision header file
4  *
5  * Copyright (c) 1999-2005 Joerg Heckenbach <[email protected]>
6  * Dwaine Garden <[email protected]>
7  *
8  *
9  * Report problems to v4l MailingList: [email protected]
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 <[email protected]>
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 
162 enum {
166 };
167 
168 /* This macro restricts an int variable to an inclusive range */
169 #define RESTRICT_TO_RANGE(v, mi, ma) \
170  { if ((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 /* Debugging aid */
207 #define USBVISION_SAY_AND_WAIT(what) { \
208  wait_queue_head_t wq; \
209  init_waitqueue_head(&wq); \
210  printk(KERN_INFO "Say: %s\n", what); \
211  interruptible_sleep_on_timeout(&wq, HZ * 3); \
212 }
213 
214 /*
215  * This macro checks if usbvision is still operational. The 'usbvision'
216  * pointer must be valid, usbvision->dev must be valid, we are not
217  * removing the device and the device has not erred on us.
218  */
219 #define USBVISION_IS_OPERATIONAL(udevice) (\
220  (udevice != NULL) && \
221  ((udevice)->dev != NULL) && \
222  ((udevice)->last_error == 0) && \
223  (!(udevice)->remove_pending))
224 
225 #define I2C_USB_ADAP_MAX 16
226 
227 #define USBVISION_NORMS (V4L2_STD_PAL | V4L2_STD_NTSC | V4L2_STD_SECAM | V4L2_STD_PAL_M)
228 
229 /* ----------------------------------------------------------------- */
230 /* usbvision video structures */
231 /* ----------------------------------------------------------------- */
233  scan_state_scanning, /* Scanning for header */
234  scan_state_lines /* Parsing lines */
235 };
236 
237 /* Completion states of the data parser */
239  parse_state_continue, /* Just parse next item */
240  parse_state_next_frame, /* Frame done, send it to V4L */
241  parse_state_out, /* Not enough data for frame */
242  parse_state_end_parse /* End parsing */
243 };
244 
246  frame_state_unused, /* Unused (no MCAPTURE) */
247  frame_state_ready, /* Ready to start grabbing */
248  frame_state_grabbing, /* In the process of being grabbed into */
249  frame_state_done, /* Finished grabbing, but not been synced yet */
250  frame_state_done_hold, /* Are syncing or reading */
251  frame_state_error, /* Something bad happened while processing */
252 };
253 
254 /* stream states */
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 */
260 };
261 
263  isoc_state_in_frame, /* Isoc packet is member of frame */
264  isoc_state_no_frame, /* Isoc packet is not member of any frame */
265 };
266 
267 struct usb_device;
268 
270  char *data;
271  struct urb *urb;
272 };
273 
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)
282 
286  int depth;
287  int format;
288  char *desc;
289 };
290 #define USBVISION_SUPPORTED_PALETTES ARRAY_SIZE(usbvision_v4l2_format)
291 
293  unsigned char magic_1; /* 0 magic */
294  unsigned char magic_2; /* 1 magic */
295  unsigned char header_length; /* 2 */
296  unsigned char frame_num; /* 3 */
297  unsigned char frame_phase; /* 4 */
298  unsigned char frame_latency; /* 5 */
299  unsigned char data_format; /* 6 */
300  unsigned char format_param; /* 7 */
301  unsigned char frame_width_lo; /* 8 */
302  unsigned char frame_width_hi; /* 9 */
303  unsigned char frame_height_lo; /* 10 */
304  unsigned char frame_height_hi; /* 11 */
305  __u16 frame_width; /* 8 - 9 after endian correction*/
306  __u16 frame_height; /* 10 - 11 after endian correction*/
307 };
308 
310  char *data; /* Frame buffer */
311  struct usbvision_frame_header isoc_header; /* Header from stream */
312 
313  int width; /* Width application is expecting */
314  int height; /* Height */
315  int index; /* Frame index */
316  int frmwidth; /* Width the frame actually is */
317  int frmheight; /* Height */
318 
319  volatile int grabstate; /* State of grabbing */
320  int scanstate; /* State of scanning */
321 
322  struct list_head frame;
323 
324  int curline; /* Line of frame we're working on */
325 
326  long scanlength; /* uncompressed, raw data length of frame */
327  long bytes_read; /* amount of scanlength that has been read from data */
328  struct usbvision_v4l2_format_st v4l2_format; /* format the user needs*/
329  int v4l2_linesize; /* bytes for one videoline*/
331  int sequence; /* How many video frames we send to user */
332 };
333 
334 #define CODEC_SAA7113 7113
335 #define CODEC_SAA7111 7111
336 #define CODEC_WEBCAM 3000
337 #define BRIDGE_NT1003 1003
338 #define BRIDGE_NT1004 1004
339 #define BRIDGE_NT1005 1005
340 
343  const char *model_string;
344  int interface; /* to handle special interface number like BELKIN and Hauppauge WinTV-USB II */
346  unsigned video_channels:3;
347  unsigned audio_channels:2;
348  unsigned radio:1;
349  unsigned vbi:1;
350  unsigned tuner:1;
351  unsigned vin_reg1_override:1; /* Override default value with */
352  unsigned vin_reg2_override:1; /* vin_reg1, vin_reg2, etc. */
353  unsigned dvi_yuv_override:1;
360 };
361 
362 /* Declared on usbvision-cards.c */
364 extern struct usb_device_id usbvision_table[];
365 
368  struct video_device *vdev; /* Video Device */
369  struct video_device *rdev; /* Radio Device */
370 
371  /* i2c Declaration Section*/
374 
375  struct urb *ctrl_urb;
376  unsigned char ctrl_urb_buffer[8];
379  wait_queue_head_t ctrl_urb_wq; /* Processes waiting */
380 
381  /* configuration part */
384  int bridge_type; /* NT1003, NT1004, NT1005 */
385  int radio;
386  int video_inputs; /* # of inputs */
387  unsigned long freq;
390  int isoc_mode; /* format of video data for the usb isoc-transfer */
391  unsigned int nr; /* Number of the device */
392 
393  /* Device structure */
394  struct usb_device *dev;
395  /* usb transfer */
396  int num_alt; /* Number of alternative settings */
397  unsigned int *alt_max_pkt_size; /* array of max_packet_size */
398  unsigned char iface; /* Video interface number */
399  unsigned char iface_alt; /* Alt settings */
400  unsigned char vin_reg2_preset;
401  struct mutex v4l2_lock;
404  int power; /* is the device powered on? */
405  int user; /* user count for exclusive use */
406  int initialized; /* Had we already sent init sequence? */
407  int dev_model; /* What type of USBVISION device we got? */
408  enum stream_state streaming; /* Are we streaming Isochronous? */
409  int last_error; /* What calamity struck us? */
410  int curwidth; /* width of the frame the device is currently set to*/
411  int curheight; /* height of the frame the device is currently set to*/
412  int stretch_width; /* stretch-factor for frame width (from usb to screen)*/
413  int stretch_height; /* stretch-factor for frame height (from usb to screen)*/
414  char *fbuf; /* Videodev buffer area for mmap*/
415  int max_frame_size; /* Bytes in one video frame */
416  int fbuf_size; /* Videodev buffer size */
417  spinlock_t queue_lock; /* spinlock for protecting mods on inqueue and outqueue */
418  struct list_head inqueue, outqueue; /* queued frame list and ready to dequeue frame list */
419  wait_queue_head_t wait_frame; /* Processes waiting */
420  wait_queue_head_t wait_stream; /* Processes waiting */
421  struct usbvision_frame *cur_frame; /* pointer to current frame, set by usbvision_find_header */
422  struct usbvision_frame frame[USBVISION_NUMFRAMES]; /* frame buffer */
423  int num_frames; /* number of frames allocated */
424  struct usbvision_sbuf sbuf[USBVISION_NUMSBUF]; /* S buffering */
425  volatile int remove_pending; /* If set then about to exit */
426 
427  /* Scratch space from the Isochronous Pipe.*/
428  unsigned char *scratch;
436 
437  struct v4l2_capability vcap; /* Video capabilities */
438  unsigned int ctl_input; /* selected input */
439  v4l2_std_id tvnorm_id; /* selected tv norm */
440  unsigned char video_endp; /* 0x82 for USBVISION devices based */
441 
442  /* Decompression stuff: */
443  unsigned char *intra_frame_buffer; /* Buffer for reference frame */
444  int block_pos; /* for test only */
445  int request_intra; /* 0 = normal; 1 = intra frame is requested; */
446  int last_isoc_frame_num; /* check for lost isoc frames */
447  int isoc_packet_size; /* need to calculate used_bandwidth */
448  int used_bandwidth; /* used bandwidth 0-100%, need to set compr_level */
449  int compr_level; /* How strong (100) or weak (0) is compression */
450  int last_compr_level; /* How strong (100) or weak (0) was compression */
451  int usb_bandwidth; /* Mbit/s */
452 
453  /* Statistics that can be overlayed on the screen */
454  unsigned long isoc_urb_count; /* How many URBs we received so far */
455  unsigned long urb_length; /* Length of last URB */
456  unsigned long isoc_data_count; /* How many bytes we received */
457  unsigned long header_count; /* How many frame headers we found */
458  unsigned long scratch_ovf_count; /* How many times we overflowed scratch */
459  unsigned long isoc_skip_count; /* How many empty ISO packets received */
460  unsigned long isoc_err_count; /* How many bad ISO packets received */
461  unsigned long isoc_packet_count; /* How many packets we totally got */
462  unsigned long time_in_irq; /* How long do we need for interrupt */
464  int frame_num; /* How many video frames we send to user */
465  int max_strip_len; /* How big is the biggest strip */
467  int strip_len_errors; /* How many times was block_pos greater than strip_len */
471 };
472 
473 static inline struct usb_usbvision *to_usbvision(struct v4l2_device *v4l2_dev)
474 {
475  return container_of(v4l2_dev, struct usb_usbvision, v4l2_dev);
476 }
477 
478 #define call_all(usbvision, o, f, args...) \
479  v4l2_device_call_all(&usbvision->v4l2_dev, 0, o, f, ##args)
480 
481 /* --------------------------------------------------------------- */
482 /* defined in usbvision-i2c.c */
483 /* i2c-algo-usb declaration */
484 /* --------------------------------------------------------------- */
485 
486 /* ----------------------------------------------------------------------- */
487 /* usbvision specific I2C functions */
488 /* ----------------------------------------------------------------------- */
489 int usbvision_i2c_register(struct usb_usbvision *usbvision);
490 int usbvision_i2c_unregister(struct usb_usbvision *usbvision);
491 
492 /* defined in usbvision-core.c */
493 int usbvision_read_reg(struct usb_usbvision *usbvision, unsigned char reg);
494 int usbvision_write_reg(struct usb_usbvision *usbvision, unsigned char reg,
495  unsigned char value);
496 
497 int usbvision_frames_alloc(struct usb_usbvision *usbvision, int number_of_frames);
498 void usbvision_frames_free(struct usb_usbvision *usbvision);
499 int usbvision_scratch_alloc(struct usb_usbvision *usbvision);
500 void usbvision_scratch_free(struct usb_usbvision *usbvision);
501 int usbvision_decompress_alloc(struct usb_usbvision *usbvision);
502 void usbvision_decompress_free(struct usb_usbvision *usbvision);
503 
504 int usbvision_setup(struct usb_usbvision *usbvision, int format);
505 int usbvision_init_isoc(struct usb_usbvision *usbvision);
506 int usbvision_restart_isoc(struct usb_usbvision *usbvision);
507 void usbvision_stop_isoc(struct usb_usbvision *usbvision);
509 
510 int usbvision_set_audio(struct usb_usbvision *usbvision, int audio_channel);
511 int usbvision_audio_off(struct usb_usbvision *usbvision);
512 
513 int usbvision_begin_streaming(struct usb_usbvision *usbvision);
516 
517 int usbvision_muxsel(struct usb_usbvision *usbvision, int channel);
518 int usbvision_set_input(struct usb_usbvision *usbvision);
519 int usbvision_set_output(struct usb_usbvision *usbvision, int width, int height);
520 
521 void usbvision_init_power_off_timer(struct usb_usbvision *usbvision);
522 void usbvision_set_power_off_timer(struct usb_usbvision *usbvision);
523 void usbvision_reset_power_off_timer(struct usb_usbvision *usbvision);
524 int usbvision_power_off(struct usb_usbvision *usbvision);
525 int usbvision_power_on(struct usb_usbvision *usbvision);
526 
527 #endif /* __LINUX_USBVISION_H */
528 
529 /*
530  * Overrides for Emacs so that we follow Linus's tabbing style.
531  * ---------------------------------------------------------------------------
532  * Local variables:
533  * c-basic-offset: 8
534  * End:
535  */