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.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #ifndef __PVRUSB2_HDW_H
21 #define __PVRUSB2_HDW_H
23 #include <linux/usb.h>
24 #include <linux/videodev2.h>
25 #include "pvrusb2-io.h"
26 #include "pvrusb2-ctrl.h"
29 /* Private internal control ids, look these up with
30 pvr2_hdw_get_ctrl_by_id() - these are NOT visible in V4L */
31 #define PVR2_CID_STDENUM 1
32 #define PVR2_CID_STDCUR 2
33 #define PVR2_CID_STDAVAIL 3
34 #define PVR2_CID_INPUT 4
35 #define PVR2_CID_AUDIOMODE 5
36 #define PVR2_CID_FREQUENCY 6
37 #define PVR2_CID_HRES 7
38 #define PVR2_CID_VRES 8
40 /* Legal values for the INPUT state variable */
41 #define PVR2_CVAL_INPUT_TV 0
42 #define PVR2_CVAL_INPUT_DTV 1
43 #define PVR2_CVAL_INPUT_COMPOSITE 2
44 #define PVR2_CVAL_INPUT_SVIDEO 3
45 #define PVR2_CVAL_INPUT_RADIO 4
48 pvr2_config_empty, /* No configuration */
49 pvr2_config_mpeg, /* Encoded / compressed video */
50 pvr2_config_vbi, /* Standard vbi info */
51 pvr2_config_pcm, /* Audio raw pcm stream */
52 pvr2_config_rawvideo, /* Video raw frames */
61 /* Major states that we can be in:
63 * DEAD - Device is in an unusable state and cannot be recovered. This
64 * can happen if we completely lose the ability to communicate with it
65 * (but it might still on the bus). In this state there's nothing we can
66 * do; it must be replugged in order to recover.
68 * COLD - Device is in an unusuable state, needs microcontroller firmware.
70 * WARM - We can communicate with the device and the proper
71 * microcontroller firmware is running, but other device initialization is
72 * still needed (e.g. encoder firmware).
74 * ERROR - A problem prevents capture operation (e.g. encoder firmware
77 * READY - Device is operational, but not streaming.
79 * RUN - Device is streaming.
82 #define PVR2_STATE_NONE 0
83 #define PVR2_STATE_DEAD 1
84 #define PVR2_STATE_COLD 2
85 #define PVR2_STATE_WARM 3
86 #define PVR2_STATE_ERROR 4
87 #define PVR2_STATE_READY 5
88 #define PVR2_STATE_RUN 6
90 /* Translate configuration enum to a string label */
91 const char *pvr2_config_get_name(enum pvr2_config);
95 /* Create and return a structure for interacting with the underlying
97 struct pvr2_hdw *pvr2_hdw_create(struct usb_interface *intf,
98 const struct usb_device_id *devid);
100 /* Perform second stage initialization, passing in a notification callback
101 for when the master state changes. */
102 int pvr2_hdw_initialize(struct pvr2_hdw *,
103 void (*callback_func)(void *),
104 void *callback_data);
106 /* Destroy hardware interaction structure */
107 void pvr2_hdw_destroy(struct pvr2_hdw *);
109 /* Return true if in the ready (normal) state */
110 int pvr2_hdw_dev_ok(struct pvr2_hdw *);
112 /* Return small integer number [1..N] for logical instance number of this
113 device. This is useful for indexing array-valued module parameters. */
114 int pvr2_hdw_get_unit_number(struct pvr2_hdw *);
116 /* Get pointer to underlying USB device */
117 struct usb_device *pvr2_hdw_get_dev(struct pvr2_hdw *);
119 /* Retrieve serial number of device */
120 unsigned long pvr2_hdw_get_sn(struct pvr2_hdw *);
122 /* Retrieve bus location info of device */
123 const char *pvr2_hdw_get_bus_info(struct pvr2_hdw *);
125 /* Called when hardware has been unplugged */
126 void pvr2_hdw_disconnect(struct pvr2_hdw *);
128 /* Get the number of defined controls */
129 unsigned int pvr2_hdw_get_ctrl_count(struct pvr2_hdw *);
131 /* Retrieve a control handle given its index (0..count-1) */
132 struct pvr2_ctrl *pvr2_hdw_get_ctrl_by_index(struct pvr2_hdw *,unsigned int);
134 /* Retrieve a control handle given its internal ID (if any) */
135 struct pvr2_ctrl *pvr2_hdw_get_ctrl_by_id(struct pvr2_hdw *,unsigned int);
137 /* Retrieve a control handle given its V4L ID (if any) */
138 struct pvr2_ctrl *pvr2_hdw_get_ctrl_v4l(struct pvr2_hdw *,unsigned int ctl_id);
140 /* Retrieve a control handle given its immediate predecessor V4L ID (if any) */
141 struct pvr2_ctrl *pvr2_hdw_get_ctrl_nextv4l(struct pvr2_hdw *,
142 unsigned int ctl_id);
144 /* Commit all control changes made up to this point */
145 int pvr2_hdw_commit_ctl(struct pvr2_hdw *);
147 /* Return a bit mask of valid input selections for this device. Mask bits
148 * will be according to PVR_CVAL_INPUT_xxxx definitions. */
149 unsigned int pvr2_hdw_get_input_available(struct pvr2_hdw *);
151 /* Return a bit mask of allowed input selections for this device. Mask bits
152 * will be according to PVR_CVAL_INPUT_xxxx definitions. */
153 unsigned int pvr2_hdw_get_input_allowed(struct pvr2_hdw *);
155 /* Change the set of allowed input selections for this device. Both
156 change_mask and change_valu are mask bits according to
157 PVR_CVAL_INPUT_xxxx definitions. The change_mask parameter indicate
158 which settings are being changed and the change_val parameter indicates
159 whether corresponding settings are being set or cleared. */
160 int pvr2_hdw_set_input_allowed(struct pvr2_hdw *,
161 unsigned int change_mask,
162 unsigned int change_val);
164 /* Return name for this driver instance */
165 const char *pvr2_hdw_get_driver_name(struct pvr2_hdw *);
167 /* Mark tuner status stale so that it will be re-fetched */
168 void pvr2_hdw_execute_tuner_poll(struct pvr2_hdw *);
170 /* Return information about the tuner */
171 int pvr2_hdw_get_tuner_status(struct pvr2_hdw *,struct v4l2_tuner *);
173 /* Query device and see if it thinks it is on a high-speed USB link */
174 int pvr2_hdw_is_hsm(struct pvr2_hdw *);
176 /* Return a string token representative of the hardware type */
177 const char *pvr2_hdw_get_type(struct pvr2_hdw *);
179 /* Return a single line description of the hardware type */
180 const char *pvr2_hdw_get_desc(struct pvr2_hdw *);
182 /* Turn streaming on/off */
183 int pvr2_hdw_set_streaming(struct pvr2_hdw *,int);
185 /* Find out if streaming is on */
186 int pvr2_hdw_get_streaming(struct pvr2_hdw *);
188 /* Retrieve driver overall state */
189 int pvr2_hdw_get_state(struct pvr2_hdw *);
191 /* Configure the type of stream to generate */
192 int pvr2_hdw_set_stream_type(struct pvr2_hdw *, enum pvr2_config);
194 /* Get handle to video output stream */
195 struct pvr2_stream *pvr2_hdw_get_video_stream(struct pvr2_hdw *);
197 /* Emit a video standard struct */
198 int pvr2_hdw_get_stdenum_value(struct pvr2_hdw *hdw,struct v4l2_standard *std,
201 /* Enable / disable retrieval of CPU firmware or prom contents. This must
202 be enabled before pvr2_hdw_cpufw_get() will function. Note that doing
203 this may prevent the device from running (and leaving this mode may
204 imply a device reset). */
205 void pvr2_hdw_cpufw_set_enabled(struct pvr2_hdw *,
209 /* Return true if we're in a mode for retrieval CPU firmware */
210 int pvr2_hdw_cpufw_get_enabled(struct pvr2_hdw *);
212 /* Retrieve a piece of the CPU's firmware at the given offset. Return
213 value is the number of bytes retrieved or zero if we're past the end or
214 an error otherwise (e.g. if firmware retrieval is not enabled). */
215 int pvr2_hdw_cpufw_get(struct pvr2_hdw *,unsigned int offs,
216 char *buf,unsigned int cnt);
218 /* Retrieve a previously stored v4l minor device number */
219 int pvr2_hdw_v4l_get_minor_number(struct pvr2_hdw *,enum pvr2_v4l_type index);
221 /* Store a v4l minor device number */
222 void pvr2_hdw_v4l_store_minor_number(struct pvr2_hdw *,
223 enum pvr2_v4l_type index,int);
225 /* Direct read/write access to chip's registers:
226 match_type - how to interpret match_chip (e.g. driver ID, i2c address)
227 match_chip - chip match value (e.g. I2C_DRIVERD_xxxx)
228 reg_id - register number to access
229 setFl - true to set the register, false to read it
230 val_ptr - storage location for source / result. */
231 int pvr2_hdw_register_access(struct pvr2_hdw *,
232 u32 match_type, u32 match_chip,u64 reg_id,
233 int setFl,u64 *val_ptr);
235 /* The following entry points are all lower level things you normally don't
236 want to worry about. */
238 /* Issue a command and get a response from the device. LOTS of higher
239 level stuff is built on this. */
240 int pvr2_send_request(struct pvr2_hdw *,
241 void *write_ptr,unsigned int write_len,
242 void *read_ptr,unsigned int read_len);
244 /* Slightly higher level device communication functions. */
245 int pvr2_write_register(struct pvr2_hdw *, u16, u32);
247 /* Call if for any reason we can't talk to the hardware anymore - this will
248 cause the driver to stop flailing on the device. */
249 void pvr2_hdw_render_useless(struct pvr2_hdw *);
251 /* Set / clear 8051's reset bit */
252 void pvr2_hdw_cpureset_assert(struct pvr2_hdw *,int);
254 /* Execute a USB-commanded device reset */
255 void pvr2_hdw_device_reset(struct pvr2_hdw *);
257 /* Reset worker's error trapping circuit breaker */
258 int pvr2_hdw_untrip(struct pvr2_hdw *);
260 /* Execute hard reset command (after this point it's likely that the
261 encoder will have to be reconfigured). This also clears the "useless"
263 int pvr2_hdw_cmd_deep_reset(struct pvr2_hdw *);
265 /* Execute simple reset command */
266 int pvr2_hdw_cmd_powerup(struct pvr2_hdw *);
269 int pvr2_hdw_cmd_powerdown(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_usbstream_run;
295 int state_decoder_quiescent;
296 int state_pipeline_config;
297 int state_pipeline_req;
298 int state_pipeline_pause;
299 int state_pipeline_idle;
301 int cmd_debug_write_len;
302 int cmd_debug_read_len;
303 int cmd_debug_write_pend;
304 int cmd_debug_read_pend;
305 int cmd_debug_timeout;
306 int cmd_debug_rstatus;
307 int cmd_debug_wstatus;
308 unsigned char cmd_code;
311 /* Non-intrusively retrieve internal state info - this is useful for
312 diagnosing lockups. Note that this operation is completed without any
313 kind of locking and so it is not atomic and may yield inconsistent
314 results. This is *purely* a debugging aid. */
315 void pvr2_hdw_get_debug_info_unlocked(const struct pvr2_hdw *hdw,
316 struct pvr2_hdw_debug_info *);
318 /* Intrusively retrieve internal state info - this is useful for
319 diagnosing overall driver state. This operation synchronizes against
320 the overall driver mutex - so if there are locking problems this will
321 likely hang! This is *purely* a debugging aid. */
322 void pvr2_hdw_get_debug_info_locked(struct pvr2_hdw *hdw,
323 struct pvr2_hdw_debug_info *);
325 /* Report out several lines of text that describes driver internal state.
326 Results are written into the passed-in buffer. */
327 unsigned int pvr2_hdw_state_report(struct pvr2_hdw *hdw,
328 char *buf_ptr,unsigned int buf_size);
330 /* Cause modules to log their state once */
331 void pvr2_hdw_trigger_module_log(struct pvr2_hdw *hdw);
333 /* Cause encoder firmware to be uploaded into the device. This is normally
334 done autonomously, but the interface is exported here because it is also
336 int pvr2_upload_firmware2(struct pvr2_hdw *hdw);
338 #endif /* __PVRUSB2_HDW_H */
341 Stuff for Emacs to see, in order to encourage consistent editing style:
342 *** Local Variables: ***
344 *** fill-column: 75 ***
346 *** c-basic-offset: 8 ***