4 * Copyright (C) 2005 Mike Isely <isely@pobox.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
16 #ifndef __PVRUSB2_HDW_H
17 #define __PVRUSB2_HDW_H
19 #include <linux/usb.h>
20 #include <linux/videodev2.h>
21 #include <media/v4l2-dev.h>
22 #include "pvrusb2-io.h"
23 #include "pvrusb2-ctrl.h"
26 /* Private internal control ids, look these up with
27 pvr2_hdw_get_ctrl_by_id() - these are NOT visible in V4L */
28 #define PVR2_CID_STDCUR 2
29 #define PVR2_CID_STDAVAIL 3
30 #define PVR2_CID_INPUT 4
31 #define PVR2_CID_AUDIOMODE 5
32 #define PVR2_CID_FREQUENCY 6
33 #define PVR2_CID_HRES 7
34 #define PVR2_CID_VRES 8
35 #define PVR2_CID_CROPL 9
36 #define PVR2_CID_CROPT 10
37 #define PVR2_CID_CROPW 11
38 #define PVR2_CID_CROPH 12
39 #define PVR2_CID_CROPCAPPAN 13
40 #define PVR2_CID_CROPCAPPAD 14
41 #define PVR2_CID_CROPCAPBL 15
42 #define PVR2_CID_CROPCAPBT 16
43 #define PVR2_CID_CROPCAPBW 17
44 #define PVR2_CID_CROPCAPBH 18
45 #define PVR2_CID_STDDETECT 19
47 /* Legal values for the INPUT state variable */
48 #define PVR2_CVAL_INPUT_TV 0
49 #define PVR2_CVAL_INPUT_DTV 1
50 #define PVR2_CVAL_INPUT_COMPOSITE 2
51 #define PVR2_CVAL_INPUT_SVIDEO 3
52 #define PVR2_CVAL_INPUT_RADIO 4
53 #define PVR2_CVAL_INPUT_MAX PVR2_CVAL_INPUT_RADIO
56 pvr2_config_empty, /* No configuration */
57 pvr2_config_mpeg, /* Encoded / compressed video */
58 pvr2_config_vbi, /* Standard vbi info */
59 pvr2_config_pcm, /* Audio raw pcm stream */
60 pvr2_config_rawvideo, /* Video raw frames */
69 /* Major states that we can be in:
71 * DEAD - Device is in an unusable state and cannot be recovered. This
72 * can happen if we completely lose the ability to communicate with it
73 * (but it might still on the bus). In this state there's nothing we can
74 * do; it must be replugged in order to recover.
76 * COLD - Device is in an unusable state, needs microcontroller firmware.
78 * WARM - We can communicate with the device and the proper
79 * microcontroller firmware is running, but other device initialization is
80 * still needed (e.g. encoder firmware).
82 * ERROR - A problem prevents capture operation (e.g. encoder firmware
85 * READY - Device is operational, but not streaming.
87 * RUN - Device is streaming.
90 #define PVR2_STATE_NONE 0
91 #define PVR2_STATE_DEAD 1
92 #define PVR2_STATE_COLD 2
93 #define PVR2_STATE_WARM 3
94 #define PVR2_STATE_ERROR 4
95 #define PVR2_STATE_READY 5
96 #define PVR2_STATE_RUN 6
98 /* Translate configuration enum to a string label */
99 const char *pvr2_config_get_name(enum pvr2_config);
103 /* Create and return a structure for interacting with the underlying
105 struct pvr2_hdw *pvr2_hdw_create(struct usb_interface *intf,
106 const struct usb_device_id *devid);
108 /* Perform second stage initialization, passing in a notification callback
109 for when the master state changes. */
110 int pvr2_hdw_initialize(struct pvr2_hdw *,
111 void (*callback_func)(void *),
112 void *callback_data);
114 /* Destroy hardware interaction structure */
115 void pvr2_hdw_destroy(struct pvr2_hdw *);
117 /* Return true if in the ready (normal) state */
118 int pvr2_hdw_dev_ok(struct pvr2_hdw *);
120 /* Return small integer number [1..N] for logical instance number of this
121 device. This is useful for indexing array-valued module parameters. */
122 int pvr2_hdw_get_unit_number(struct pvr2_hdw *);
124 /* Get pointer to underlying USB device */
125 struct usb_device *pvr2_hdw_get_dev(struct pvr2_hdw *);
127 /* Retrieve serial number of device */
128 unsigned long pvr2_hdw_get_sn(struct pvr2_hdw *);
130 /* Retrieve bus location info of device */
131 const char *pvr2_hdw_get_bus_info(struct pvr2_hdw *);
133 /* Retrieve per-instance string identifier for this specific device */
134 const char *pvr2_hdw_get_device_identifier(struct pvr2_hdw *);
136 /* Called when hardware has been unplugged */
137 void pvr2_hdw_disconnect(struct pvr2_hdw *);
139 /* Sets v4l2_dev of a video_device struct */
140 void pvr2_hdw_set_v4l2_dev(struct pvr2_hdw *, struct video_device *);
142 /* Get the number of defined controls */
143 unsigned int pvr2_hdw_get_ctrl_count(struct pvr2_hdw *);
145 /* Retrieve a control handle given its index (0..count-1) */
146 struct pvr2_ctrl *pvr2_hdw_get_ctrl_by_index(struct pvr2_hdw *,unsigned int);
148 /* Retrieve a control handle given its internal ID (if any) */
149 struct pvr2_ctrl *pvr2_hdw_get_ctrl_by_id(struct pvr2_hdw *,unsigned int);
151 /* Retrieve a control handle given its V4L ID (if any) */
152 struct pvr2_ctrl *pvr2_hdw_get_ctrl_v4l(struct pvr2_hdw *,unsigned int ctl_id);
154 /* Retrieve a control handle given its immediate predecessor V4L ID (if any) */
155 struct pvr2_ctrl *pvr2_hdw_get_ctrl_nextv4l(struct pvr2_hdw *,
156 unsigned int ctl_id);
158 /* Commit all control changes made up to this point */
159 int pvr2_hdw_commit_ctl(struct pvr2_hdw *);
161 /* Return a bit mask of valid input selections for this device. Mask bits
162 * will be according to PVR_CVAL_INPUT_xxxx definitions. */
163 unsigned int pvr2_hdw_get_input_available(struct pvr2_hdw *);
165 /* Return a bit mask of allowed input selections for this device. Mask bits
166 * will be according to PVR_CVAL_INPUT_xxxx definitions. */
167 unsigned int pvr2_hdw_get_input_allowed(struct pvr2_hdw *);
169 /* Change the set of allowed input selections for this device. Both
170 change_mask and change_valu are mask bits according to
171 PVR_CVAL_INPUT_xxxx definitions. The change_mask parameter indicate
172 which settings are being changed and the change_val parameter indicates
173 whether corresponding settings are being set or cleared. */
174 int pvr2_hdw_set_input_allowed(struct pvr2_hdw *,
175 unsigned int change_mask,
176 unsigned int change_val);
178 /* Return name for this driver instance */
179 const char *pvr2_hdw_get_driver_name(struct pvr2_hdw *);
181 /* Mark tuner status stale so that it will be re-fetched */
182 void pvr2_hdw_execute_tuner_poll(struct pvr2_hdw *);
184 /* Return information about the tuner */
185 int pvr2_hdw_get_tuner_status(struct pvr2_hdw *,struct v4l2_tuner *);
187 /* Return information about cropping capabilities */
188 int pvr2_hdw_get_cropcap(struct pvr2_hdw *, struct v4l2_cropcap *);
190 /* Query device and see if it thinks it is on a high-speed USB link */
191 int pvr2_hdw_is_hsm(struct pvr2_hdw *);
193 /* Return a string token representative of the hardware type */
194 const char *pvr2_hdw_get_type(struct pvr2_hdw *);
196 /* Return a single line description of the hardware type */
197 const char *pvr2_hdw_get_desc(struct pvr2_hdw *);
199 /* Turn streaming on/off */
200 int pvr2_hdw_set_streaming(struct pvr2_hdw *,int);
202 /* Find out if streaming is on */
203 int pvr2_hdw_get_streaming(struct pvr2_hdw *);
205 /* Retrieve driver overall state */
206 int pvr2_hdw_get_state(struct pvr2_hdw *);
208 /* Configure the type of stream to generate */
209 int pvr2_hdw_set_stream_type(struct pvr2_hdw *, enum pvr2_config);
211 /* Get handle to video output stream */
212 struct pvr2_stream *pvr2_hdw_get_video_stream(struct pvr2_hdw *);
214 /* Enable / disable retrieval of CPU firmware or prom contents. This must
215 be enabled before pvr2_hdw_cpufw_get() will function. Note that doing
216 this may prevent the device from running (and leaving this mode may
217 imply a device reset). */
218 void pvr2_hdw_cpufw_set_enabled(struct pvr2_hdw *,
219 int mode, /* 0=8KB FX2, 1=16KB FX2, 2=PROM */
222 /* Return true if we're in a mode for retrieval CPU firmware */
223 int pvr2_hdw_cpufw_get_enabled(struct pvr2_hdw *);
225 /* Retrieve a piece of the CPU's firmware at the given offset. Return
226 value is the number of bytes retrieved or zero if we're past the end or
227 an error otherwise (e.g. if firmware retrieval is not enabled). */
228 int pvr2_hdw_cpufw_get(struct pvr2_hdw *,unsigned int offs,
229 char *buf,unsigned int cnt);
231 /* Retrieve a previously stored v4l minor device number */
232 int pvr2_hdw_v4l_get_minor_number(struct pvr2_hdw *,enum pvr2_v4l_type index);
234 /* Store a v4l minor device number */
235 void pvr2_hdw_v4l_store_minor_number(struct pvr2_hdw *,
236 enum pvr2_v4l_type index,int);
238 /* The following entry points are all lower level things you normally don't
239 want to worry about. */
241 /* Issue a command and get a response from the device. LOTS of higher
242 level stuff is built on this. */
243 int pvr2_send_request(struct pvr2_hdw *,
244 void *write_ptr,unsigned int write_len,
245 void *read_ptr,unsigned int read_len);
247 /* Slightly higher level device communication functions. */
248 int pvr2_write_register(struct pvr2_hdw *, u16, u32);
250 /* Call if for any reason we can't talk to the hardware anymore - this will
251 cause the driver to stop flailing on the device. */
252 void pvr2_hdw_render_useless(struct pvr2_hdw *);
254 /* Set / clear 8051's reset bit */
255 void pvr2_hdw_cpureset_assert(struct pvr2_hdw *,int);
257 /* Execute a USB-commanded device reset */
258 void pvr2_hdw_device_reset(struct pvr2_hdw *);
260 /* Reset worker's error trapping circuit breaker */
261 int pvr2_hdw_untrip(struct pvr2_hdw *);
263 /* Execute hard reset command (after this point it's likely that the
264 encoder will have to be reconfigured). This also clears the "useless"
266 int pvr2_hdw_cmd_deep_reset(struct pvr2_hdw *);
268 /* Execute simple reset command */
269 int pvr2_hdw_cmd_powerup(struct pvr2_hdw *);
271 /* Order decoder to reset */
272 int pvr2_hdw_cmd_decoder_reset(struct pvr2_hdw *);
274 /* Direct manipulation of GPIO bits */
275 int pvr2_hdw_gpio_get_dir(struct pvr2_hdw *hdw,u32 *);
276 int pvr2_hdw_gpio_get_out(struct pvr2_hdw *hdw,u32 *);
277 int pvr2_hdw_gpio_get_in(struct pvr2_hdw *hdw,u32 *);
278 int pvr2_hdw_gpio_chg_dir(struct pvr2_hdw *hdw,u32 msk,u32 val);
279 int pvr2_hdw_gpio_chg_out(struct pvr2_hdw *hdw,u32 msk,u32 val);
281 /* This data structure is specifically for the next function... */
282 struct pvr2_hdw_debug_info {
285 int flag_disconnected;
289 int flag_decoder_missed;
291 int state_encoder_ok;
292 int state_encoder_run;
293 int state_decoder_run;
294 int state_decoder_ready;
295 int state_usbstream_run;
296 int state_decoder_quiescent;
297 int state_pipeline_config;
298 int state_pipeline_req;
299 int state_pipeline_pause;
300 int state_pipeline_idle;
302 int cmd_debug_write_len;
303 int cmd_debug_read_len;
304 int cmd_debug_write_pend;
305 int cmd_debug_read_pend;
306 int cmd_debug_timeout;
307 int cmd_debug_rstatus;
308 int cmd_debug_wstatus;
309 unsigned char cmd_code;
312 /* Non-intrusively retrieve internal state info - this is useful for
313 diagnosing lockups. Note that this operation is completed without any
314 kind of locking and so it is not atomic and may yield inconsistent
315 results. This is *purely* a debugging aid. */
316 void pvr2_hdw_get_debug_info_unlocked(const struct pvr2_hdw *hdw,
317 struct pvr2_hdw_debug_info *);
319 /* Intrusively retrieve internal state info - this is useful for
320 diagnosing overall driver state. This operation synchronizes against
321 the overall driver mutex - so if there are locking problems this will
322 likely hang! This is *purely* a debugging aid. */
323 void pvr2_hdw_get_debug_info_locked(struct pvr2_hdw *hdw,
324 struct pvr2_hdw_debug_info *);
326 /* Report out several lines of text that describes driver internal state.
327 Results are written into the passed-in buffer. */
328 unsigned int pvr2_hdw_state_report(struct pvr2_hdw *hdw,
329 char *buf_ptr,unsigned int buf_size);
331 /* Cause modules to log their state once */
332 void pvr2_hdw_trigger_module_log(struct pvr2_hdw *hdw);
334 /* Cause encoder firmware to be uploaded into the device. This is normally
335 done autonomously, but the interface is exported here because it is also
337 int pvr2_upload_firmware2(struct pvr2_hdw *hdw);
339 #endif /* __PVRUSB2_HDW_H */