xref: /openbmc/linux/drivers/media/usb/hdpvr/hdpvr.h (revision ee89bd6b)
1 /*
2  * Hauppauge HD PVR USB driver
3  *
4  * Copyright (C) 2008      Janne Grunau (j@jannau.net)
5  *
6  *	This program is free software; you can redistribute it and/or
7  *	modify it under the terms of the GNU General Public License as
8  *	published by the Free Software Foundation, version 2.
9  *
10  */
11 
12 #include <linux/usb.h>
13 #include <linux/i2c.h>
14 #include <linux/mutex.h>
15 #include <linux/workqueue.h>
16 #include <linux/videodev2.h>
17 
18 #include <media/v4l2-device.h>
19 #include <media/v4l2-ctrls.h>
20 #include <media/ir-kbd-i2c.h>
21 
22 #define HDPVR_MAX 8
23 #define HDPVR_I2C_MAX_SIZE 128
24 
25 /* Define these values to match your devices */
26 #define HD_PVR_VENDOR_ID	0x2040
27 #define HD_PVR_PRODUCT_ID	0x4900
28 #define HD_PVR_PRODUCT_ID1	0x4901
29 #define HD_PVR_PRODUCT_ID2	0x4902
30 #define HD_PVR_PRODUCT_ID4	0x4903
31 #define HD_PVR_PRODUCT_ID3	0x4982
32 
33 #define UNSET    (-1U)
34 
35 #define NUM_BUFFERS 64
36 
37 #define HDPVR_FIRMWARE_VERSION		0x08
38 #define HDPVR_FIRMWARE_VERSION_AC3	0x0d
39 #define HDPVR_FIRMWARE_VERSION_0X12	0x12
40 #define HDPVR_FIRMWARE_VERSION_0X15	0x15
41 #define HDPVR_FIRMWARE_VERSION_0X1E	0x1e
42 
43 /* #define HDPVR_DEBUG */
44 
45 extern int hdpvr_debug;
46 
47 #define MSG_INFO	1
48 #define MSG_BUFFER	2
49 
50 struct hdpvr_options {
51 	u8	video_std;
52 	u8	video_input;
53 	u8	audio_input;
54 	u8	bitrate;	/* in 100kbps */
55 	u8	peak_bitrate;	/* in 100kbps */
56 	u8	bitrate_mode;
57 	u8	gop_mode;
58 	enum v4l2_mpeg_audio_encoding	audio_codec;
59 	u8	brightness;
60 	u8	contrast;
61 	u8	hue;
62 	u8	saturation;
63 	u8	sharpness;
64 };
65 
66 /* Structure to hold all of our device specific stuff */
67 struct hdpvr_device {
68 	/* the v4l device for this device */
69 	struct video_device	*video_dev;
70 	/* the control handler for this device */
71 	struct v4l2_ctrl_handler hdl;
72 	/* the usb device for this device */
73 	struct usb_device	*udev;
74 	/* v4l2-device unused */
75 	struct v4l2_device	v4l2_dev;
76 	struct { /* video mode/bitrate control cluster */
77 		struct v4l2_ctrl *video_mode;
78 		struct v4l2_ctrl *video_bitrate;
79 		struct v4l2_ctrl *video_bitrate_peak;
80 	};
81 	/* v4l2 format */
82 	uint width, height;
83 
84 	/* the max packet size of the bulk endpoint */
85 	size_t			bulk_in_size;
86 	/* the address of the bulk in endpoint */
87 	__u8			bulk_in_endpointAddr;
88 
89 	/* holds the current device status */
90 	__u8			status;
91 
92 	/* holds the current set options */
93 	struct hdpvr_options	options;
94 	v4l2_std_id		cur_std;
95 	struct v4l2_dv_timings	cur_dv_timings;
96 
97 	uint			flags;
98 
99 	/* synchronize I/O */
100 	struct mutex		io_mutex;
101 	/* available buffers */
102 	struct list_head	free_buff_list;
103 	/* in progress buffers */
104 	struct list_head	rec_buff_list;
105 	/* waitqueue for buffers */
106 	wait_queue_head_t	wait_buffer;
107 	/* waitqueue for data */
108 	wait_queue_head_t	wait_data;
109 	/**/
110 	struct workqueue_struct	*workqueue;
111 	/**/
112 	struct work_struct	worker;
113 	/* current stream owner */
114 	struct v4l2_fh		*owner;
115 
116 	/* I2C adapter */
117 	struct i2c_adapter	i2c_adapter;
118 	/* I2C lock */
119 	struct mutex		i2c_mutex;
120 	/* I2C message buffer space */
121 	char			i2c_buf[HDPVR_I2C_MAX_SIZE];
122 
123 	/* For passing data to ir-kbd-i2c */
124 	struct IR_i2c_init_data	ir_i2c_init_data;
125 
126 	/* usb control transfer buffer and lock */
127 	struct mutex		usbc_mutex;
128 	u8			*usbc_buf;
129 	u8			fw_ver;
130 };
131 
132 static inline struct hdpvr_device *to_hdpvr_dev(struct v4l2_device *v4l2_dev)
133 {
134 	return container_of(v4l2_dev, struct hdpvr_device, v4l2_dev);
135 }
136 
137 
138 /* buffer one bulk urb of data */
139 struct hdpvr_buffer {
140 	struct list_head	buff_list;
141 
142 	struct urb		*urb;
143 
144 	struct hdpvr_device	*dev;
145 
146 	uint			pos;
147 
148 	__u8			status;
149 };
150 
151 /* */
152 
153 struct hdpvr_video_info {
154 	u16	width;
155 	u16	height;
156 	u8	fps;
157 };
158 
159 enum {
160 	STATUS_UNINITIALIZED	= 0,
161 	STATUS_IDLE,
162 	STATUS_STARTING,
163 	STATUS_SHUTTING_DOWN,
164 	STATUS_STREAMING,
165 	STATUS_ERROR,
166 	STATUS_DISCONNECTED,
167 };
168 
169 enum {
170 	HDPVR_FLAG_AC3_CAP = 1,
171 };
172 
173 enum {
174 	BUFSTAT_UNINITIALIZED = 0,
175 	BUFSTAT_AVAILABLE,
176 	BUFSTAT_INPROGRESS,
177 	BUFSTAT_READY,
178 };
179 
180 #define CTRL_START_STREAMING_VALUE	0x0700
181 #define CTRL_STOP_STREAMING_VALUE	0x0800
182 #define CTRL_BITRATE_VALUE		0x1000
183 #define CTRL_BITRATE_MODE_VALUE		0x1200
184 #define CTRL_GOP_MODE_VALUE		0x1300
185 #define CTRL_VIDEO_INPUT_VALUE		0x1500
186 #define CTRL_VIDEO_STD_TYPE		0x1700
187 #define CTRL_AUDIO_INPUT_VALUE		0x2500
188 #define CTRL_BRIGHTNESS			0x2900
189 #define CTRL_CONTRAST			0x2a00
190 #define CTRL_HUE			0x2b00
191 #define CTRL_SATURATION			0x2c00
192 #define CTRL_SHARPNESS			0x2d00
193 #define CTRL_LOW_PASS_FILTER_VALUE	0x3100
194 
195 #define CTRL_DEFAULT_INDEX		0x0003
196 
197 
198 	/* :0 s 38 01 1000 0003 0004 4 = 0a00ca00
199 	 * BITRATE SETTING
200 	 *   1st and 2nd byte (little endian): average bitrate in 100 000 bit/s
201 	 *                                     min: 1 mbit/s, max: 13.5 mbit/s
202 	 *   3rd and 4th byte (little endian): peak bitrate in 100 000 bit/s
203 	 *                                     min: average + 100kbit/s,
204 	 *                                      max: 20.2 mbit/s
205 	 */
206 
207 	/* :0 s 38 01 1200 0003 0001 1 = 02
208 	 * BIT RATE MODE
209 	 *  constant = 1, variable (peak) = 2, variable (average) = 3
210 	 */
211 
212 	/* :0 s 38 01 1300 0003 0001 1 = 03
213 	 * GOP MODE (2 bit)
214 	 *    low bit 0/1: advanced/simple GOP
215 	 *   high bit 0/1: IDR(4/32/128) / no IDR (4/32/0)
216 	 */
217 
218 	/* :0 s 38 01 1700 0003 0001 1 = 00
219 	 * VIDEO STANDARD or FREQUNCY 0 = 60hz, 1 = 50hz
220 	 */
221 
222 	/* :0 s 38 01 3100 0003 0004 4 = 03030000
223 	 * FILTER CONTROL
224 	 *   1st byte luma low pass filter strength,
225 	 *   2nd byte chroma low pass filter strength,
226 	 *   3rd byte MF enable chroma, min=0, max=1
227 	 *   4th byte n
228 	 */
229 
230 
231 	/* :0 s 38 b9 0001 0000 0000 0 */
232 
233 
234 
235 /* :0 s 38 d3 0000 0000 0001 1 = 00 */
236 /* 		ret = usb_control_msg(dev->udev, */
237 /* 				      usb_sndctrlpipe(dev->udev, 0), */
238 /* 				      0xd3, 0x38, */
239 /* 				      0, 0, */
240 /* 				      "\0", 1, */
241 /* 				      1000); */
242 
243 /* 		info("control request returned %d", ret); */
244 /* 		msleep(5000); */
245 
246 
247 	/* :0 s b8 81 1400 0003 0005 5 <
248 	 * :0 0 5 = d0024002 19
249 	 * QUERY FRAME SIZE AND RATE
250 	 *   1st and 2nd byte (little endian): horizontal resolution
251 	 *   3rd and 4th byte (little endian): vertical resolution
252 	 *   5th byte: frame rate
253 	 */
254 
255 	/* :0 s b8 81 1800 0003 0003 3 <
256 	 * :0 0 3 = 030104
257 	 * QUERY SIGNAL AND DETECTED LINES, maybe INPUT
258 	 */
259 
260 enum hdpvr_video_std {
261 	HDPVR_60HZ = 0,
262 	HDPVR_50HZ,
263 };
264 
265 enum hdpvr_video_input {
266 	HDPVR_COMPONENT = 0,
267 	HDPVR_SVIDEO,
268 	HDPVR_COMPOSITE,
269 	HDPVR_VIDEO_INPUTS
270 };
271 
272 enum hdpvr_audio_inputs {
273 	HDPVR_RCA_BACK = 0,
274 	HDPVR_RCA_FRONT,
275 	HDPVR_SPDIF,
276 	HDPVR_AUDIO_INPUTS
277 };
278 
279 enum hdpvr_bitrate_mode {
280 	HDPVR_CONSTANT = 1,
281 	HDPVR_VARIABLE_PEAK,
282 	HDPVR_VARIABLE_AVERAGE,
283 };
284 
285 enum hdpvr_gop_mode {
286 	HDPVR_ADVANCED_IDR_GOP = 0,
287 	HDPVR_SIMPLE_IDR_GOP,
288 	HDPVR_ADVANCED_NOIDR_GOP,
289 	HDPVR_SIMPLE_NOIDR_GOP,
290 };
291 
292 void hdpvr_delete(struct hdpvr_device *dev);
293 
294 /*========================================================================*/
295 /* hardware control functions */
296 int hdpvr_set_options(struct hdpvr_device *dev);
297 
298 int hdpvr_set_bitrate(struct hdpvr_device *dev);
299 
300 int hdpvr_set_audio(struct hdpvr_device *dev, u8 input,
301 		    enum v4l2_mpeg_audio_encoding codec);
302 
303 int hdpvr_config_call(struct hdpvr_device *dev, uint value,
304 		      unsigned char valbuf);
305 
306 struct hdpvr_video_info *get_video_info(struct hdpvr_device *dev);
307 
308 /* :0 s b8 81 1800 0003 0003 3 < */
309 /* :0 0 3 = 0301ff */
310 int get_input_lines_info(struct hdpvr_device *dev);
311 
312 
313 /*========================================================================*/
314 /* v4l2 registration */
315 int hdpvr_register_videodev(struct hdpvr_device *dev, struct device *parent,
316 			    int devnumber);
317 
318 int hdpvr_cancel_queue(struct hdpvr_device *dev);
319 
320 /*========================================================================*/
321 /* i2c adapter registration */
322 int hdpvr_register_i2c_adapter(struct hdpvr_device *dev);
323 
324 struct i2c_client *hdpvr_register_ir_rx_i2c(struct hdpvr_device *dev);
325 struct i2c_client *hdpvr_register_ir_tx_i2c(struct hdpvr_device *dev);
326 
327 /*========================================================================*/
328 /* buffer management */
329 int hdpvr_free_buffers(struct hdpvr_device *dev);
330 int hdpvr_alloc_buffers(struct hdpvr_device *dev, uint count);
331