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_INTERNAL_H
21 #define __PVRUSB2_HDW_INTERNAL_H
25 This header sets up all the internal structures and definitions needed to
26 track and coordinate the driver's interaction with the hardware. ONLY
27 source files which actually implement part of that whole circus should be
28 including this header. Higher levels, like the external layers to the
29 various public APIs (V4L, sysfs, etc) should NOT ever include this
30 private, internal header. This means that pvrusb2-hdw, pvrusb2-encoder,
31 etc will include this, but pvrusb2-v4l should not.
35 #include <linux/videodev2.h>
36 #include <linux/i2c.h>
37 #include <linux/workqueue.h>
38 #include <linux/mutex.h>
39 #include "pvrusb2-hdw.h"
40 #include "pvrusb2-io.h"
41 #include <media/v4l2-device.h>
42 #include <media/cx2341x.h>
43 #include "pvrusb2-devattr.h"
45 /* Legal values for PVR2_CID_HSM */
46 #define PVR2_CVAL_HSM_FAIL 0
47 #define PVR2_CVAL_HSM_FULL 1
48 #define PVR2_CVAL_HSM_HIGH 2
50 #define PVR2_VID_ENDPOINT 0x84
51 #define PVR2_UNK_ENDPOINT 0x86 /* maybe raw yuv ? */
52 #define PVR2_VBI_ENDPOINT 0x88
54 #define PVR2_CTL_BUFFSIZE 64
56 #define FREQTABLE_SIZE 500
58 #define LOCK_TAKE(x) do { mutex_lock(&x##_mutex); x##_held = !0; } while (0)
59 #define LOCK_GIVE(x) do { x##_held = 0; mutex_unlock(&x##_mutex); } while (0)
61 typedef int (*pvr2_ctlf_is_dirty)(struct pvr2_ctrl *);
62 typedef void (*pvr2_ctlf_clear_dirty)(struct pvr2_ctrl *);
63 typedef int (*pvr2_ctlf_check_value)(struct pvr2_ctrl *,int);
64 typedef int (*pvr2_ctlf_get_value)(struct pvr2_ctrl *,int *);
65 typedef int (*pvr2_ctlf_set_value)(struct pvr2_ctrl *,int msk,int val);
66 typedef int (*pvr2_ctlf_val_to_sym)(struct pvr2_ctrl *,int msk,int val,
67 char *,unsigned int,unsigned int *);
68 typedef int (*pvr2_ctlf_sym_to_val)(struct pvr2_ctrl *,
69 const char *,unsigned int,
71 typedef unsigned int (*pvr2_ctlf_get_v4lflags)(struct pvr2_ctrl *);
73 /* This structure describes a specific control. A table of these is set up
75 struct pvr2_ctl_info {
76 /* Control's name suitable for use as an identifier */
79 /* Short description of control */
82 /* Control's implementation */
83 pvr2_ctlf_get_value get_value; /* Get its value */
84 pvr2_ctlf_get_value get_def_value; /* Get its default value */
85 pvr2_ctlf_get_value get_min_value; /* Get minimum allowed value */
86 pvr2_ctlf_get_value get_max_value; /* Get maximum allowed value */
87 pvr2_ctlf_set_value set_value; /* Set its value */
88 pvr2_ctlf_check_value check_value; /* Check that value is valid */
89 pvr2_ctlf_val_to_sym val_to_sym; /* Custom convert value->symbol */
90 pvr2_ctlf_sym_to_val sym_to_val; /* Custom convert symbol->value */
91 pvr2_ctlf_is_dirty is_dirty; /* Return true if dirty */
92 pvr2_ctlf_clear_dirty clear_dirty; /* Clear dirty state */
93 pvr2_ctlf_get_v4lflags get_v4lflags;/* Retrieve v4l flags */
95 /* Control's type (int, enum, bitmask) */
96 enum pvr2_ctl_type type;
98 /* Associated V4L control ID, if any */
101 /* Associated driver internal ID, if any */
104 /* Don't implicitly initialize this control's value */
107 /* Starting value for this control */
110 /* Type-specific control information */
112 struct { /* Integer control */
113 long min_value; /* lower limit */
114 long max_value; /* upper limit */
116 struct { /* enumerated control */
117 unsigned int count; /* enum value count */
118 const char **value_names; /* symbol names */
120 struct { /* bitmask control */
121 unsigned int valid_bits; /* bits in use */
122 const char **bit_names; /* symbol name/bit */
128 /* Same as pvr2_ctl_info, but includes storage for the control description */
129 #define PVR2_CTLD_INFO_DESC_SIZE 32
130 struct pvr2_ctld_info {
131 struct pvr2_ctl_info info;
132 char desc[PVR2_CTLD_INFO_DESC_SIZE];
136 const struct pvr2_ctl_info *info;
137 struct pvr2_hdw *hdw;
142 /* Disposition of firmware1 loading situation */
143 #define FW1_STATE_UNKNOWN 0
144 #define FW1_STATE_MISSING 1
145 #define FW1_STATE_FAILED 2
146 #define FW1_STATE_RELOAD 3
147 #define FW1_STATE_OK 4
149 /* What state the device is in if it is a hybrid */
150 #define PVR2_PATHWAY_UNKNOWN 0
151 #define PVR2_PATHWAY_ANALOG 1
152 #define PVR2_PATHWAY_DIGITAL 2
154 typedef int (*pvr2_i2c_func)(struct pvr2_hdw *,u8,u8 *,u16,u8 *, u16);
155 #define PVR2_I2C_FUNC_CNT 128
157 /* This structure contains all state data directly needed to
158 manipulate the hardware (as opposed to complying with a kernel
161 /* Underlying USB device handle */
162 struct usb_device *usb_dev;
163 struct usb_interface *usb_intf;
165 /* Our handle into the v4l2 sub-device architecture */
166 struct v4l2_device v4l2_dev;
167 /* Device description, anything that must adjust behavior based on
168 device specific info will use information held here. */
169 const struct pvr2_device_desc *hdw_desc;
171 /* Kernel worker thread handling */
172 struct workqueue_struct *workqueue;
173 struct work_struct workpoll; /* Update driver state */
176 struct pvr2_stream *vid_stream;
178 /* Mutex for all hardware state control */
179 struct mutex big_lock_mutex;
180 int big_lock_held; /* For debugging */
182 /* This is a simple string which identifies the instance of this
183 driver. It is unique within the set of existing devices, but
184 there is no attempt to keep the name consistent with the same
185 physical device each time. */
188 /* This is a simple string which identifies the physical device
189 instance itself - if possible. (If not possible, then it is
190 based on the specific driver instance, similar to name above.)
191 The idea here is that userspace might hopefully be able to use
192 this recognize specific tuners. It will encode a serial number,
197 struct i2c_adapter i2c_adap;
198 struct i2c_algorithm i2c_algo;
199 pvr2_i2c_func i2c_func[PVR2_I2C_FUNC_CNT];
200 int i2c_cx25840_hack_state;
203 /* Frequency table */
204 unsigned int freqTable[FREQTABLE_SIZE];
205 unsigned int freqProgSlot;
207 /* Stuff for handling low level control interaction with device */
208 struct mutex ctl_lock_mutex;
209 int ctl_lock_held; /* For debugging */
210 struct urb *ctl_write_urb;
211 struct urb *ctl_read_urb;
212 unsigned char *ctl_write_buffer;
213 unsigned char *ctl_read_buffer;
214 int ctl_write_pend_flag;
215 int ctl_read_pend_flag;
216 int ctl_timeout_flag;
217 struct completion ctl_done;
218 unsigned char cmd_buffer[PVR2_CTL_BUFFSIZE];
219 int cmd_debug_state; // Low level command debugging info
220 unsigned char cmd_debug_code; //
221 unsigned int cmd_debug_write_len; //
222 unsigned int cmd_debug_read_len; //
224 /* Bits of state that describe what is going on with various parts
226 int state_pathway_ok; /* Pathway config is ok */
227 int state_encoder_ok; /* Encoder is operational */
228 int state_encoder_run; /* Encoder is running */
229 int state_encoder_config; /* Encoder is configured */
230 int state_encoder_waitok; /* Encoder pre-wait done */
231 int state_encoder_runok; /* Encoder has run for >= .25 sec */
232 int state_decoder_run; /* Decoder is running */
233 int state_usbstream_run; /* FX2 is streaming */
234 int state_decoder_quiescent; /* Decoder idle for > 50msec */
235 int state_pipeline_config; /* Pipeline is configured */
236 int state_pipeline_req; /* Somebody wants to stream */
237 int state_pipeline_pause; /* Pipeline must be paused */
238 int state_pipeline_idle; /* Pipeline not running */
240 /* This is the master state of the driver. It is the combined
241 result of other bits of state. Examining this will indicate the
242 overall state of the driver. Values here are one of
244 unsigned int master_state;
246 /* True if device led is currently on */
249 /* True if states must be re-evaluated */
252 void (*state_func)(void *);
255 /* Timer for measuring decoder settling time */
256 struct timer_list quiescent_timer;
258 /* Timer for measuring encoder pre-wait time */
259 struct timer_list encoder_wait_timer;
261 /* Timer for measuring encoder minimum run time */
262 struct timer_list encoder_run_timer;
264 /* Place to block while waiting for state changes */
265 wait_queue_head_t state_wait_data;
268 int force_dirty; /* consider all controls dirty if true */
269 int flag_ok; /* device in known good state */
270 int flag_disconnected; /* flag_ok == 0 due to disconnect */
271 int flag_init_ok; /* true if structure is fully initialized */
272 int fw1_state; /* current situation with fw1 */
273 int pathway_state; /* one of PVR2_PATHWAY_xxx */
274 int flag_decoder_missed;/* We've noticed missing decoder */
275 int flag_tripped; /* Indicates overall failure to start */
277 unsigned int decoder_client_id;
279 // CPU firmware info (used to help find / save firmware data)
281 unsigned int fw_size;
282 int fw_cpu_flag; /* True if we are dealing with the CPU */
284 /* Tuner / frequency control stuff */
285 unsigned int tuner_type;
287 unsigned int freqValTelevision; /* Current freq for tv mode */
288 unsigned int freqValRadio; /* Current freq for radio mode */
289 unsigned int freqSlotTelevision; /* Current slot for tv mode */
290 unsigned int freqSlotRadio; /* Current slot for radio mode */
291 unsigned int freqSelector; /* 0=radio 1=television */
294 /* Current tuner info - this information is polled from the I2C bus */
295 struct v4l2_tuner tuner_signal_info;
296 int tuner_signal_stale;
298 /* Cropping capability info */
299 struct v4l2_cropcap cropcap_info;
302 /* Video standard handling */
303 v4l2_std_id std_mask_eeprom; // Hardware supported selections
304 v4l2_std_id std_mask_avail; // Which standards we may select from
305 v4l2_std_id std_mask_cur; // Currently selected standard(s)
306 unsigned int std_enum_cnt; // # of enumerated standards
307 int std_enum_cur; // selected standard enumeration value
308 int std_dirty; // True if std_mask_cur has changed
309 struct pvr2_ctl_info std_info_enum;
310 struct pvr2_ctl_info std_info_avail;
311 struct pvr2_ctl_info std_info_cur;
312 struct v4l2_standard *std_defs;
313 const char **std_enum_names;
315 // Generated string names, one per actual V4L2 standard
316 const char *std_mask_ptrs[32];
317 char std_mask_names[32][10];
319 int unit_number; /* ID for driver instance */
320 unsigned long serial_number; /* ID for hardware itself */
322 char bus_info[32]; /* Bus location info */
324 /* Minor numbers used by v4l logic (yes, this is a hack, as there
325 should be no v4l junk here). Probably a better way to do this. */
326 int v4l_minor_number_video;
327 int v4l_minor_number_vbi;
328 int v4l_minor_number_radio;
330 /* Bit mask of PVR2_CVAL_INPUT choices which are valid for the hardware */
331 unsigned int input_avail_mask;
332 /* Bit mask of PVR2_CVAL_INPUT choices which are currenly allowed */
333 unsigned int input_allowed_mask;
335 /* Location of eeprom or a negative number if none */
338 enum pvr2_config active_stream_type;
339 enum pvr2_config desired_stream_type;
341 /* Control state needed for cx2341x module */
342 struct cx2341x_mpeg_params enc_cur_state;
343 struct cx2341x_mpeg_params enc_ctl_state;
344 /* True if an encoder attribute has changed */
346 /* True if an unsafe encoder attribute has changed */
347 int enc_unsafe_stale;
348 /* True if enc_cur_state is valid */
352 #define VCREATE_DATA(lab) int lab##_val; int lab##_dirty
353 VCREATE_DATA(brightness);
354 VCREATE_DATA(contrast);
355 VCREATE_DATA(saturation);
357 VCREATE_DATA(volume);
358 VCREATE_DATA(balance);
360 VCREATE_DATA(treble);
367 VCREATE_DATA(audiomode);
368 VCREATE_DATA(res_hor);
369 VCREATE_DATA(res_ver);
373 struct pvr2_ctld_info *mpeg_ctrl_info;
375 struct pvr2_ctrl *controls;
376 unsigned int control_cnt;
379 /* This function gets the current frequency */
380 unsigned long pvr2_hdw_get_cur_freq(struct pvr2_hdw *);
382 void pvr2_hdw_status_poll(struct pvr2_hdw *);
384 #endif /* __PVRUSB2_HDW_INTERNAL_H */
387 Stuff for Emacs to see, in order to encourage consistent editing style:
388 *** Local Variables: ***
390 *** fill-column: 75 ***
392 *** c-basic-offset: 8 ***