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