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