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