Add the rt linux 4.1.3-rt3 as base
[kvmfornfv.git] / kernel / drivers / media / usb / pvrusb2 / pvrusb2-hdw.c
1 /*
2  *
3  *
4  *  Copyright (C) 2005 Mike Isely <isely@pobox.com>
5  *
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
9  *
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.
14  *
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
18  *
19  */
20
21 #include <linux/errno.h>
22 #include <linux/string.h>
23 #include <linux/slab.h>
24 #include <linux/module.h>
25 #include <linux/firmware.h>
26 #include <linux/videodev2.h>
27 #include <media/v4l2-common.h>
28 #include <media/tuner.h>
29 #include "pvrusb2.h"
30 #include "pvrusb2-std.h"
31 #include "pvrusb2-util.h"
32 #include "pvrusb2-hdw.h"
33 #include "pvrusb2-i2c-core.h"
34 #include "pvrusb2-eeprom.h"
35 #include "pvrusb2-hdw-internal.h"
36 #include "pvrusb2-encoder.h"
37 #include "pvrusb2-debug.h"
38 #include "pvrusb2-fx2-cmd.h"
39 #include "pvrusb2-wm8775.h"
40 #include "pvrusb2-video-v4l.h"
41 #include "pvrusb2-cx2584x-v4l.h"
42 #include "pvrusb2-cs53l32a.h"
43 #include "pvrusb2-audio.h"
44
45 #define TV_MIN_FREQ     55250000L
46 #define TV_MAX_FREQ    850000000L
47
48 /* This defines a minimum interval that the decoder must remain quiet
49    before we are allowed to start it running. */
50 #define TIME_MSEC_DECODER_WAIT 50
51
52 /* This defines a minimum interval that the decoder must be allowed to run
53    before we can safely begin using its streaming output. */
54 #define TIME_MSEC_DECODER_STABILIZATION_WAIT 300
55
56 /* This defines a minimum interval that the encoder must remain quiet
57    before we are allowed to configure it. */
58 #define TIME_MSEC_ENCODER_WAIT 50
59
60 /* This defines the minimum interval that the encoder must successfully run
61    before we consider that the encoder has run at least once since its
62    firmware has been loaded.  This measurement is in important for cases
63    where we can't do something until we know that the encoder has been run
64    at least once. */
65 #define TIME_MSEC_ENCODER_OK 250
66
67 static struct pvr2_hdw *unit_pointers[PVR_NUM] = {[ 0 ... PVR_NUM-1 ] = NULL};
68 static DEFINE_MUTEX(pvr2_unit_mtx);
69
70 static int ctlchg;
71 static int procreload;
72 static int tuner[PVR_NUM] = { [0 ... PVR_NUM-1] = -1 };
73 static int tolerance[PVR_NUM] = { [0 ... PVR_NUM-1] = 0 };
74 static int video_std[PVR_NUM] = { [0 ... PVR_NUM-1] = 0 };
75 static int init_pause_msec;
76
77 module_param(ctlchg, int, S_IRUGO|S_IWUSR);
78 MODULE_PARM_DESC(ctlchg, "0=optimize ctl change 1=always accept new ctl value");
79 module_param(init_pause_msec, int, S_IRUGO|S_IWUSR);
80 MODULE_PARM_DESC(init_pause_msec, "hardware initialization settling delay");
81 module_param(procreload, int, S_IRUGO|S_IWUSR);
82 MODULE_PARM_DESC(procreload,
83                  "Attempt init failure recovery with firmware reload");
84 module_param_array(tuner,    int, NULL, 0444);
85 MODULE_PARM_DESC(tuner,"specify installed tuner type");
86 module_param_array(video_std,    int, NULL, 0444);
87 MODULE_PARM_DESC(video_std,"specify initial video standard");
88 module_param_array(tolerance,    int, NULL, 0444);
89 MODULE_PARM_DESC(tolerance,"specify stream error tolerance");
90
91 /* US Broadcast channel 3 (61.25 MHz), to help with testing */
92 static int default_tv_freq    = 61250000L;
93 /* 104.3 MHz, a usable FM station for my area */
94 static int default_radio_freq = 104300000L;
95
96 module_param_named(tv_freq, default_tv_freq, int, 0444);
97 MODULE_PARM_DESC(tv_freq, "specify initial television frequency");
98 module_param_named(radio_freq, default_radio_freq, int, 0444);
99 MODULE_PARM_DESC(radio_freq, "specify initial radio frequency");
100
101 #define PVR2_CTL_WRITE_ENDPOINT  0x01
102 #define PVR2_CTL_READ_ENDPOINT   0x81
103
104 #define PVR2_GPIO_IN 0x9008
105 #define PVR2_GPIO_OUT 0x900c
106 #define PVR2_GPIO_DIR 0x9020
107
108 #define trace_firmware(...) pvr2_trace(PVR2_TRACE_FIRMWARE,__VA_ARGS__)
109
110 #define PVR2_FIRMWARE_ENDPOINT   0x02
111
112 /* size of a firmware chunk */
113 #define FIRMWARE_CHUNK_SIZE 0x2000
114
115 typedef void (*pvr2_subdev_update_func)(struct pvr2_hdw *,
116                                         struct v4l2_subdev *);
117
118 static const pvr2_subdev_update_func pvr2_module_update_functions[] = {
119         [PVR2_CLIENT_ID_WM8775] = pvr2_wm8775_subdev_update,
120         [PVR2_CLIENT_ID_SAA7115] = pvr2_saa7115_subdev_update,
121         [PVR2_CLIENT_ID_MSP3400] = pvr2_msp3400_subdev_update,
122         [PVR2_CLIENT_ID_CX25840] = pvr2_cx25840_subdev_update,
123         [PVR2_CLIENT_ID_CS53L32A] = pvr2_cs53l32a_subdev_update,
124 };
125
126 static const char *module_names[] = {
127         [PVR2_CLIENT_ID_MSP3400] = "msp3400",
128         [PVR2_CLIENT_ID_CX25840] = "cx25840",
129         [PVR2_CLIENT_ID_SAA7115] = "saa7115",
130         [PVR2_CLIENT_ID_TUNER] = "tuner",
131         [PVR2_CLIENT_ID_DEMOD] = "tuner",
132         [PVR2_CLIENT_ID_CS53L32A] = "cs53l32a",
133         [PVR2_CLIENT_ID_WM8775] = "wm8775",
134 };
135
136
137 static const unsigned char *module_i2c_addresses[] = {
138         [PVR2_CLIENT_ID_TUNER] = "\x60\x61\x62\x63",
139         [PVR2_CLIENT_ID_DEMOD] = "\x43",
140         [PVR2_CLIENT_ID_MSP3400] = "\x40",
141         [PVR2_CLIENT_ID_SAA7115] = "\x21",
142         [PVR2_CLIENT_ID_WM8775] = "\x1b",
143         [PVR2_CLIENT_ID_CX25840] = "\x44",
144         [PVR2_CLIENT_ID_CS53L32A] = "\x11",
145 };
146
147
148 static const char *ir_scheme_names[] = {
149         [PVR2_IR_SCHEME_NONE] = "none",
150         [PVR2_IR_SCHEME_29XXX] = "29xxx",
151         [PVR2_IR_SCHEME_24XXX] = "24xxx (29xxx emulation)",
152         [PVR2_IR_SCHEME_24XXX_MCE] = "24xxx (MCE device)",
153         [PVR2_IR_SCHEME_ZILOG] = "Zilog",
154 };
155
156
157 /* Define the list of additional controls we'll dynamically construct based
158    on query of the cx2341x module. */
159 struct pvr2_mpeg_ids {
160         const char *strid;
161         int id;
162 };
163 static const struct pvr2_mpeg_ids mpeg_ids[] = {
164         {
165                 .strid = "audio_layer",
166                 .id = V4L2_CID_MPEG_AUDIO_ENCODING,
167         },{
168                 .strid = "audio_bitrate",
169                 .id = V4L2_CID_MPEG_AUDIO_L2_BITRATE,
170         },{
171                 /* Already using audio_mode elsewhere :-( */
172                 .strid = "mpeg_audio_mode",
173                 .id = V4L2_CID_MPEG_AUDIO_MODE,
174         },{
175                 .strid = "mpeg_audio_mode_extension",
176                 .id = V4L2_CID_MPEG_AUDIO_MODE_EXTENSION,
177         },{
178                 .strid = "audio_emphasis",
179                 .id = V4L2_CID_MPEG_AUDIO_EMPHASIS,
180         },{
181                 .strid = "audio_crc",
182                 .id = V4L2_CID_MPEG_AUDIO_CRC,
183         },{
184                 .strid = "video_aspect",
185                 .id = V4L2_CID_MPEG_VIDEO_ASPECT,
186         },{
187                 .strid = "video_b_frames",
188                 .id = V4L2_CID_MPEG_VIDEO_B_FRAMES,
189         },{
190                 .strid = "video_gop_size",
191                 .id = V4L2_CID_MPEG_VIDEO_GOP_SIZE,
192         },{
193                 .strid = "video_gop_closure",
194                 .id = V4L2_CID_MPEG_VIDEO_GOP_CLOSURE,
195         },{
196                 .strid = "video_bitrate_mode",
197                 .id = V4L2_CID_MPEG_VIDEO_BITRATE_MODE,
198         },{
199                 .strid = "video_bitrate",
200                 .id = V4L2_CID_MPEG_VIDEO_BITRATE,
201         },{
202                 .strid = "video_bitrate_peak",
203                 .id = V4L2_CID_MPEG_VIDEO_BITRATE_PEAK,
204         },{
205                 .strid = "video_temporal_decimation",
206                 .id = V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION,
207         },{
208                 .strid = "stream_type",
209                 .id = V4L2_CID_MPEG_STREAM_TYPE,
210         },{
211                 .strid = "video_spatial_filter_mode",
212                 .id = V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE,
213         },{
214                 .strid = "video_spatial_filter",
215                 .id = V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER,
216         },{
217                 .strid = "video_luma_spatial_filter_type",
218                 .id = V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE,
219         },{
220                 .strid = "video_chroma_spatial_filter_type",
221                 .id = V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE,
222         },{
223                 .strid = "video_temporal_filter_mode",
224                 .id = V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE,
225         },{
226                 .strid = "video_temporal_filter",
227                 .id = V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER,
228         },{
229                 .strid = "video_median_filter_type",
230                 .id = V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE,
231         },{
232                 .strid = "video_luma_median_filter_top",
233                 .id = V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP,
234         },{
235                 .strid = "video_luma_median_filter_bottom",
236                 .id = V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM,
237         },{
238                 .strid = "video_chroma_median_filter_top",
239                 .id = V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP,
240         },{
241                 .strid = "video_chroma_median_filter_bottom",
242                 .id = V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM,
243         }
244 };
245 #define MPEGDEF_COUNT ARRAY_SIZE(mpeg_ids)
246
247
248 static const char *control_values_srate[] = {
249         [V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100]   = "44.1 kHz",
250         [V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000]   = "48 kHz",
251         [V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000]   = "32 kHz",
252 };
253
254
255
256 static const char *control_values_input[] = {
257         [PVR2_CVAL_INPUT_TV]        = "television",  /*xawtv needs this name*/
258         [PVR2_CVAL_INPUT_DTV]       = "dtv",
259         [PVR2_CVAL_INPUT_RADIO]     = "radio",
260         [PVR2_CVAL_INPUT_SVIDEO]    = "s-video",
261         [PVR2_CVAL_INPUT_COMPOSITE] = "composite",
262 };
263
264
265 static const char *control_values_audiomode[] = {
266         [V4L2_TUNER_MODE_MONO]   = "Mono",
267         [V4L2_TUNER_MODE_STEREO] = "Stereo",
268         [V4L2_TUNER_MODE_LANG1]  = "Lang1",
269         [V4L2_TUNER_MODE_LANG2]  = "Lang2",
270         [V4L2_TUNER_MODE_LANG1_LANG2] = "Lang1+Lang2",
271 };
272
273
274 static const char *control_values_hsm[] = {
275         [PVR2_CVAL_HSM_FAIL] = "Fail",
276         [PVR2_CVAL_HSM_HIGH] = "High",
277         [PVR2_CVAL_HSM_FULL] = "Full",
278 };
279
280
281 static const char *pvr2_state_names[] = {
282         [PVR2_STATE_NONE] =    "none",
283         [PVR2_STATE_DEAD] =    "dead",
284         [PVR2_STATE_COLD] =    "cold",
285         [PVR2_STATE_WARM] =    "warm",
286         [PVR2_STATE_ERROR] =   "error",
287         [PVR2_STATE_READY] =   "ready",
288         [PVR2_STATE_RUN] =     "run",
289 };
290
291
292 struct pvr2_fx2cmd_descdef {
293         unsigned char id;
294         unsigned char *desc;
295 };
296
297 static const struct pvr2_fx2cmd_descdef pvr2_fx2cmd_desc[] = {
298         {FX2CMD_MEM_WRITE_DWORD, "write encoder dword"},
299         {FX2CMD_MEM_READ_DWORD, "read encoder dword"},
300         {FX2CMD_HCW_ZILOG_RESET, "zilog IR reset control"},
301         {FX2CMD_MEM_READ_64BYTES, "read encoder 64bytes"},
302         {FX2CMD_REG_WRITE, "write encoder register"},
303         {FX2CMD_REG_READ, "read encoder register"},
304         {FX2CMD_MEMSEL, "encoder memsel"},
305         {FX2CMD_I2C_WRITE, "i2c write"},
306         {FX2CMD_I2C_READ, "i2c read"},
307         {FX2CMD_GET_USB_SPEED, "get USB speed"},
308         {FX2CMD_STREAMING_ON, "stream on"},
309         {FX2CMD_STREAMING_OFF, "stream off"},
310         {FX2CMD_FWPOST1, "fwpost1"},
311         {FX2CMD_POWER_OFF, "power off"},
312         {FX2CMD_POWER_ON, "power on"},
313         {FX2CMD_DEEP_RESET, "deep reset"},
314         {FX2CMD_GET_EEPROM_ADDR, "get rom addr"},
315         {FX2CMD_GET_IR_CODE, "get IR code"},
316         {FX2CMD_HCW_DEMOD_RESETIN, "hcw demod resetin"},
317         {FX2CMD_HCW_DTV_STREAMING_ON, "hcw dtv stream on"},
318         {FX2CMD_HCW_DTV_STREAMING_OFF, "hcw dtv stream off"},
319         {FX2CMD_ONAIR_DTV_STREAMING_ON, "onair dtv stream on"},
320         {FX2CMD_ONAIR_DTV_STREAMING_OFF, "onair dtv stream off"},
321         {FX2CMD_ONAIR_DTV_POWER_ON, "onair dtv power on"},
322         {FX2CMD_ONAIR_DTV_POWER_OFF, "onair dtv power off"},
323 };
324
325
326 static int pvr2_hdw_set_input(struct pvr2_hdw *hdw,int v);
327 static void pvr2_hdw_state_sched(struct pvr2_hdw *);
328 static int pvr2_hdw_state_eval(struct pvr2_hdw *);
329 static void pvr2_hdw_set_cur_freq(struct pvr2_hdw *,unsigned long);
330 static void pvr2_hdw_worker_poll(struct work_struct *work);
331 static int pvr2_hdw_wait(struct pvr2_hdw *,int state);
332 static int pvr2_hdw_untrip_unlocked(struct pvr2_hdw *);
333 static void pvr2_hdw_state_log_state(struct pvr2_hdw *);
334 static int pvr2_hdw_cmd_usbstream(struct pvr2_hdw *hdw,int runFl);
335 static int pvr2_hdw_commit_setup(struct pvr2_hdw *hdw);
336 static int pvr2_hdw_get_eeprom_addr(struct pvr2_hdw *hdw);
337 static void pvr2_hdw_quiescent_timeout(unsigned long);
338 static void pvr2_hdw_decoder_stabilization_timeout(unsigned long);
339 static void pvr2_hdw_encoder_wait_timeout(unsigned long);
340 static void pvr2_hdw_encoder_run_timeout(unsigned long);
341 static int pvr2_issue_simple_cmd(struct pvr2_hdw *,u32);
342 static int pvr2_send_request_ex(struct pvr2_hdw *hdw,
343                                 unsigned int timeout,int probe_fl,
344                                 void *write_data,unsigned int write_len,
345                                 void *read_data,unsigned int read_len);
346 static int pvr2_hdw_check_cropcap(struct pvr2_hdw *hdw);
347 static v4l2_std_id pvr2_hdw_get_detected_std(struct pvr2_hdw *hdw);
348
349 static void trace_stbit(const char *name,int val)
350 {
351         pvr2_trace(PVR2_TRACE_STBITS,
352                    "State bit %s <-- %s",
353                    name,(val ? "true" : "false"));
354 }
355
356 static int ctrl_channelfreq_get(struct pvr2_ctrl *cptr,int *vp)
357 {
358         struct pvr2_hdw *hdw = cptr->hdw;
359         if ((hdw->freqProgSlot > 0) && (hdw->freqProgSlot <= FREQTABLE_SIZE)) {
360                 *vp = hdw->freqTable[hdw->freqProgSlot-1];
361         } else {
362                 *vp = 0;
363         }
364         return 0;
365 }
366
367 static int ctrl_channelfreq_set(struct pvr2_ctrl *cptr,int m,int v)
368 {
369         struct pvr2_hdw *hdw = cptr->hdw;
370         unsigned int slotId = hdw->freqProgSlot;
371         if ((slotId > 0) && (slotId <= FREQTABLE_SIZE)) {
372                 hdw->freqTable[slotId-1] = v;
373                 /* Handle side effects correctly - if we're tuned to this
374                    slot, then forgot the slot id relation since the stored
375                    frequency has been changed. */
376                 if (hdw->freqSelector) {
377                         if (hdw->freqSlotRadio == slotId) {
378                                 hdw->freqSlotRadio = 0;
379                         }
380                 } else {
381                         if (hdw->freqSlotTelevision == slotId) {
382                                 hdw->freqSlotTelevision = 0;
383                         }
384                 }
385         }
386         return 0;
387 }
388
389 static int ctrl_channelprog_get(struct pvr2_ctrl *cptr,int *vp)
390 {
391         *vp = cptr->hdw->freqProgSlot;
392         return 0;
393 }
394
395 static int ctrl_channelprog_set(struct pvr2_ctrl *cptr,int m,int v)
396 {
397         struct pvr2_hdw *hdw = cptr->hdw;
398         if ((v >= 0) && (v <= FREQTABLE_SIZE)) {
399                 hdw->freqProgSlot = v;
400         }
401         return 0;
402 }
403
404 static int ctrl_channel_get(struct pvr2_ctrl *cptr,int *vp)
405 {
406         struct pvr2_hdw *hdw = cptr->hdw;
407         *vp = hdw->freqSelector ? hdw->freqSlotRadio : hdw->freqSlotTelevision;
408         return 0;
409 }
410
411 static int ctrl_channel_set(struct pvr2_ctrl *cptr,int m,int slotId)
412 {
413         unsigned freq = 0;
414         struct pvr2_hdw *hdw = cptr->hdw;
415         if ((slotId < 0) || (slotId > FREQTABLE_SIZE)) return 0;
416         if (slotId > 0) {
417                 freq = hdw->freqTable[slotId-1];
418                 if (!freq) return 0;
419                 pvr2_hdw_set_cur_freq(hdw,freq);
420         }
421         if (hdw->freqSelector) {
422                 hdw->freqSlotRadio = slotId;
423         } else {
424                 hdw->freqSlotTelevision = slotId;
425         }
426         return 0;
427 }
428
429 static int ctrl_freq_get(struct pvr2_ctrl *cptr,int *vp)
430 {
431         *vp = pvr2_hdw_get_cur_freq(cptr->hdw);
432         return 0;
433 }
434
435 static int ctrl_freq_is_dirty(struct pvr2_ctrl *cptr)
436 {
437         return cptr->hdw->freqDirty != 0;
438 }
439
440 static void ctrl_freq_clear_dirty(struct pvr2_ctrl *cptr)
441 {
442         cptr->hdw->freqDirty = 0;
443 }
444
445 static int ctrl_freq_set(struct pvr2_ctrl *cptr,int m,int v)
446 {
447         pvr2_hdw_set_cur_freq(cptr->hdw,v);
448         return 0;
449 }
450
451 static int ctrl_cropl_min_get(struct pvr2_ctrl *cptr, int *left)
452 {
453         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
454         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
455         if (stat != 0) {
456                 return stat;
457         }
458         *left = cap->bounds.left;
459         return 0;
460 }
461
462 static int ctrl_cropl_max_get(struct pvr2_ctrl *cptr, int *left)
463 {
464         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
465         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
466         if (stat != 0) {
467                 return stat;
468         }
469         *left = cap->bounds.left;
470         if (cap->bounds.width > cptr->hdw->cropw_val) {
471                 *left += cap->bounds.width - cptr->hdw->cropw_val;
472         }
473         return 0;
474 }
475
476 static int ctrl_cropt_min_get(struct pvr2_ctrl *cptr, int *top)
477 {
478         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
479         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
480         if (stat != 0) {
481                 return stat;
482         }
483         *top = cap->bounds.top;
484         return 0;
485 }
486
487 static int ctrl_cropt_max_get(struct pvr2_ctrl *cptr, int *top)
488 {
489         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
490         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
491         if (stat != 0) {
492                 return stat;
493         }
494         *top = cap->bounds.top;
495         if (cap->bounds.height > cptr->hdw->croph_val) {
496                 *top += cap->bounds.height - cptr->hdw->croph_val;
497         }
498         return 0;
499 }
500
501 static int ctrl_cropw_max_get(struct pvr2_ctrl *cptr, int *width)
502 {
503         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
504         int stat, bleftend, cleft;
505
506         stat = pvr2_hdw_check_cropcap(cptr->hdw);
507         if (stat != 0) {
508                 return stat;
509         }
510         bleftend = cap->bounds.left+cap->bounds.width;
511         cleft = cptr->hdw->cropl_val;
512
513         *width = cleft < bleftend ? bleftend-cleft : 0;
514         return 0;
515 }
516
517 static int ctrl_croph_max_get(struct pvr2_ctrl *cptr, int *height)
518 {
519         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
520         int stat, btopend, ctop;
521
522         stat = pvr2_hdw_check_cropcap(cptr->hdw);
523         if (stat != 0) {
524                 return stat;
525         }
526         btopend = cap->bounds.top+cap->bounds.height;
527         ctop = cptr->hdw->cropt_val;
528
529         *height = ctop < btopend ? btopend-ctop : 0;
530         return 0;
531 }
532
533 static int ctrl_get_cropcapbl(struct pvr2_ctrl *cptr, int *val)
534 {
535         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
536         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
537         if (stat != 0) {
538                 return stat;
539         }
540         *val = cap->bounds.left;
541         return 0;
542 }
543
544 static int ctrl_get_cropcapbt(struct pvr2_ctrl *cptr, int *val)
545 {
546         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
547         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
548         if (stat != 0) {
549                 return stat;
550         }
551         *val = cap->bounds.top;
552         return 0;
553 }
554
555 static int ctrl_get_cropcapbw(struct pvr2_ctrl *cptr, int *val)
556 {
557         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
558         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
559         if (stat != 0) {
560                 return stat;
561         }
562         *val = cap->bounds.width;
563         return 0;
564 }
565
566 static int ctrl_get_cropcapbh(struct pvr2_ctrl *cptr, int *val)
567 {
568         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
569         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
570         if (stat != 0) {
571                 return stat;
572         }
573         *val = cap->bounds.height;
574         return 0;
575 }
576
577 static int ctrl_get_cropcapdl(struct pvr2_ctrl *cptr, int *val)
578 {
579         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
580         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
581         if (stat != 0) {
582                 return stat;
583         }
584         *val = cap->defrect.left;
585         return 0;
586 }
587
588 static int ctrl_get_cropcapdt(struct pvr2_ctrl *cptr, int *val)
589 {
590         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
591         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
592         if (stat != 0) {
593                 return stat;
594         }
595         *val = cap->defrect.top;
596         return 0;
597 }
598
599 static int ctrl_get_cropcapdw(struct pvr2_ctrl *cptr, int *val)
600 {
601         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
602         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
603         if (stat != 0) {
604                 return stat;
605         }
606         *val = cap->defrect.width;
607         return 0;
608 }
609
610 static int ctrl_get_cropcapdh(struct pvr2_ctrl *cptr, int *val)
611 {
612         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
613         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
614         if (stat != 0) {
615                 return stat;
616         }
617         *val = cap->defrect.height;
618         return 0;
619 }
620
621 static int ctrl_get_cropcappan(struct pvr2_ctrl *cptr, int *val)
622 {
623         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
624         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
625         if (stat != 0) {
626                 return stat;
627         }
628         *val = cap->pixelaspect.numerator;
629         return 0;
630 }
631
632 static int ctrl_get_cropcappad(struct pvr2_ctrl *cptr, int *val)
633 {
634         struct v4l2_cropcap *cap = &cptr->hdw->cropcap_info;
635         int stat = pvr2_hdw_check_cropcap(cptr->hdw);
636         if (stat != 0) {
637                 return stat;
638         }
639         *val = cap->pixelaspect.denominator;
640         return 0;
641 }
642
643 static int ctrl_vres_max_get(struct pvr2_ctrl *cptr,int *vp)
644 {
645         /* Actual maximum depends on the video standard in effect. */
646         if (cptr->hdw->std_mask_cur & V4L2_STD_525_60) {
647                 *vp = 480;
648         } else {
649                 *vp = 576;
650         }
651         return 0;
652 }
653
654 static int ctrl_vres_min_get(struct pvr2_ctrl *cptr,int *vp)
655 {
656         /* Actual minimum depends on device digitizer type. */
657         if (cptr->hdw->hdw_desc->flag_has_cx25840) {
658                 *vp = 75;
659         } else {
660                 *vp = 17;
661         }
662         return 0;
663 }
664
665 static int ctrl_get_input(struct pvr2_ctrl *cptr,int *vp)
666 {
667         *vp = cptr->hdw->input_val;
668         return 0;
669 }
670
671 static int ctrl_check_input(struct pvr2_ctrl *cptr,int v)
672 {
673         return ((1 << v) & cptr->hdw->input_allowed_mask) != 0;
674 }
675
676 static int ctrl_set_input(struct pvr2_ctrl *cptr,int m,int v)
677 {
678         return pvr2_hdw_set_input(cptr->hdw,v);
679 }
680
681 static int ctrl_isdirty_input(struct pvr2_ctrl *cptr)
682 {
683         return cptr->hdw->input_dirty != 0;
684 }
685
686 static void ctrl_cleardirty_input(struct pvr2_ctrl *cptr)
687 {
688         cptr->hdw->input_dirty = 0;
689 }
690
691
692 static int ctrl_freq_max_get(struct pvr2_ctrl *cptr, int *vp)
693 {
694         unsigned long fv;
695         struct pvr2_hdw *hdw = cptr->hdw;
696         if (hdw->tuner_signal_stale) {
697                 pvr2_hdw_status_poll(hdw);
698         }
699         fv = hdw->tuner_signal_info.rangehigh;
700         if (!fv) {
701                 /* Safety fallback */
702                 *vp = TV_MAX_FREQ;
703                 return 0;
704         }
705         if (hdw->tuner_signal_info.capability & V4L2_TUNER_CAP_LOW) {
706                 fv = (fv * 125) / 2;
707         } else {
708                 fv = fv * 62500;
709         }
710         *vp = fv;
711         return 0;
712 }
713
714 static int ctrl_freq_min_get(struct pvr2_ctrl *cptr, int *vp)
715 {
716         unsigned long fv;
717         struct pvr2_hdw *hdw = cptr->hdw;
718         if (hdw->tuner_signal_stale) {
719                 pvr2_hdw_status_poll(hdw);
720         }
721         fv = hdw->tuner_signal_info.rangelow;
722         if (!fv) {
723                 /* Safety fallback */
724                 *vp = TV_MIN_FREQ;
725                 return 0;
726         }
727         if (hdw->tuner_signal_info.capability & V4L2_TUNER_CAP_LOW) {
728                 fv = (fv * 125) / 2;
729         } else {
730                 fv = fv * 62500;
731         }
732         *vp = fv;
733         return 0;
734 }
735
736 static int ctrl_cx2341x_is_dirty(struct pvr2_ctrl *cptr)
737 {
738         return cptr->hdw->enc_stale != 0;
739 }
740
741 static void ctrl_cx2341x_clear_dirty(struct pvr2_ctrl *cptr)
742 {
743         cptr->hdw->enc_stale = 0;
744         cptr->hdw->enc_unsafe_stale = 0;
745 }
746
747 static int ctrl_cx2341x_get(struct pvr2_ctrl *cptr,int *vp)
748 {
749         int ret;
750         struct v4l2_ext_controls cs;
751         struct v4l2_ext_control c1;
752         memset(&cs,0,sizeof(cs));
753         memset(&c1,0,sizeof(c1));
754         cs.controls = &c1;
755         cs.count = 1;
756         c1.id = cptr->info->v4l_id;
757         ret = cx2341x_ext_ctrls(&cptr->hdw->enc_ctl_state, 0, &cs,
758                                 VIDIOC_G_EXT_CTRLS);
759         if (ret) return ret;
760         *vp = c1.value;
761         return 0;
762 }
763
764 static int ctrl_cx2341x_set(struct pvr2_ctrl *cptr,int m,int v)
765 {
766         int ret;
767         struct pvr2_hdw *hdw = cptr->hdw;
768         struct v4l2_ext_controls cs;
769         struct v4l2_ext_control c1;
770         memset(&cs,0,sizeof(cs));
771         memset(&c1,0,sizeof(c1));
772         cs.controls = &c1;
773         cs.count = 1;
774         c1.id = cptr->info->v4l_id;
775         c1.value = v;
776         ret = cx2341x_ext_ctrls(&hdw->enc_ctl_state,
777                                 hdw->state_encoder_run, &cs,
778                                 VIDIOC_S_EXT_CTRLS);
779         if (ret == -EBUSY) {
780                 /* Oops.  cx2341x is telling us it's not safe to change
781                    this control while we're capturing.  Make a note of this
782                    fact so that the pipeline will be stopped the next time
783                    controls are committed.  Then go on ahead and store this
784                    change anyway. */
785                 ret = cx2341x_ext_ctrls(&hdw->enc_ctl_state,
786                                         0, &cs,
787                                         VIDIOC_S_EXT_CTRLS);
788                 if (!ret) hdw->enc_unsafe_stale = !0;
789         }
790         if (ret) return ret;
791         hdw->enc_stale = !0;
792         return 0;
793 }
794
795 static unsigned int ctrl_cx2341x_getv4lflags(struct pvr2_ctrl *cptr)
796 {
797         struct v4l2_queryctrl qctrl;
798         struct pvr2_ctl_info *info;
799         qctrl.id = cptr->info->v4l_id;
800         cx2341x_ctrl_query(&cptr->hdw->enc_ctl_state,&qctrl);
801         /* Strip out the const so we can adjust a function pointer.  It's
802            OK to do this here because we know this is a dynamically created
803            control, so the underlying storage for the info pointer is (a)
804            private to us, and (b) not in read-only storage.  Either we do
805            this or we significantly complicate the underlying control
806            implementation. */
807         info = (struct pvr2_ctl_info *)(cptr->info);
808         if (qctrl.flags & V4L2_CTRL_FLAG_READ_ONLY) {
809                 if (info->set_value) {
810                         info->set_value = NULL;
811                 }
812         } else {
813                 if (!(info->set_value)) {
814                         info->set_value = ctrl_cx2341x_set;
815                 }
816         }
817         return qctrl.flags;
818 }
819
820 static int ctrl_streamingenabled_get(struct pvr2_ctrl *cptr,int *vp)
821 {
822         *vp = cptr->hdw->state_pipeline_req;
823         return 0;
824 }
825
826 static int ctrl_masterstate_get(struct pvr2_ctrl *cptr,int *vp)
827 {
828         *vp = cptr->hdw->master_state;
829         return 0;
830 }
831
832 static int ctrl_hsm_get(struct pvr2_ctrl *cptr,int *vp)
833 {
834         int result = pvr2_hdw_is_hsm(cptr->hdw);
835         *vp = PVR2_CVAL_HSM_FULL;
836         if (result < 0) *vp = PVR2_CVAL_HSM_FAIL;
837         if (result) *vp = PVR2_CVAL_HSM_HIGH;
838         return 0;
839 }
840
841 static int ctrl_stddetect_get(struct pvr2_ctrl *cptr, int *vp)
842 {
843         *vp = pvr2_hdw_get_detected_std(cptr->hdw);
844         return 0;
845 }
846
847 static int ctrl_stdavail_get(struct pvr2_ctrl *cptr,int *vp)
848 {
849         *vp = cptr->hdw->std_mask_avail;
850         return 0;
851 }
852
853 static int ctrl_stdavail_set(struct pvr2_ctrl *cptr,int m,int v)
854 {
855         struct pvr2_hdw *hdw = cptr->hdw;
856         v4l2_std_id ns;
857         ns = hdw->std_mask_avail;
858         ns = (ns & ~m) | (v & m);
859         if (ns == hdw->std_mask_avail) return 0;
860         hdw->std_mask_avail = ns;
861         hdw->std_info_cur.def.type_bitmask.valid_bits = hdw->std_mask_avail;
862         return 0;
863 }
864
865 static int ctrl_std_val_to_sym(struct pvr2_ctrl *cptr,int msk,int val,
866                                char *bufPtr,unsigned int bufSize,
867                                unsigned int *len)
868 {
869         *len = pvr2_std_id_to_str(bufPtr,bufSize,msk & val);
870         return 0;
871 }
872
873 static int ctrl_std_sym_to_val(struct pvr2_ctrl *cptr,
874                                const char *bufPtr,unsigned int bufSize,
875                                int *mskp,int *valp)
876 {
877         int ret;
878         v4l2_std_id id;
879         ret = pvr2_std_str_to_id(&id,bufPtr,bufSize);
880         if (ret < 0) return ret;
881         if (mskp) *mskp = id;
882         if (valp) *valp = id;
883         return 0;
884 }
885
886 static int ctrl_stdcur_get(struct pvr2_ctrl *cptr,int *vp)
887 {
888         *vp = cptr->hdw->std_mask_cur;
889         return 0;
890 }
891
892 static int ctrl_stdcur_set(struct pvr2_ctrl *cptr,int m,int v)
893 {
894         struct pvr2_hdw *hdw = cptr->hdw;
895         v4l2_std_id ns;
896         ns = hdw->std_mask_cur;
897         ns = (ns & ~m) | (v & m);
898         if (ns == hdw->std_mask_cur) return 0;
899         hdw->std_mask_cur = ns;
900         hdw->std_dirty = !0;
901         return 0;
902 }
903
904 static int ctrl_stdcur_is_dirty(struct pvr2_ctrl *cptr)
905 {
906         return cptr->hdw->std_dirty != 0;
907 }
908
909 static void ctrl_stdcur_clear_dirty(struct pvr2_ctrl *cptr)
910 {
911         cptr->hdw->std_dirty = 0;
912 }
913
914 static int ctrl_signal_get(struct pvr2_ctrl *cptr,int *vp)
915 {
916         struct pvr2_hdw *hdw = cptr->hdw;
917         pvr2_hdw_status_poll(hdw);
918         *vp = hdw->tuner_signal_info.signal;
919         return 0;
920 }
921
922 static int ctrl_audio_modes_present_get(struct pvr2_ctrl *cptr,int *vp)
923 {
924         int val = 0;
925         unsigned int subchan;
926         struct pvr2_hdw *hdw = cptr->hdw;
927         pvr2_hdw_status_poll(hdw);
928         subchan = hdw->tuner_signal_info.rxsubchans;
929         if (subchan & V4L2_TUNER_SUB_MONO) {
930                 val |= (1 << V4L2_TUNER_MODE_MONO);
931         }
932         if (subchan & V4L2_TUNER_SUB_STEREO) {
933                 val |= (1 << V4L2_TUNER_MODE_STEREO);
934         }
935         if (subchan & V4L2_TUNER_SUB_LANG1) {
936                 val |= (1 << V4L2_TUNER_MODE_LANG1);
937         }
938         if (subchan & V4L2_TUNER_SUB_LANG2) {
939                 val |= (1 << V4L2_TUNER_MODE_LANG2);
940         }
941         *vp = val;
942         return 0;
943 }
944
945
946 #define DEFINT(vmin,vmax) \
947         .type = pvr2_ctl_int, \
948         .def.type_int.min_value = vmin, \
949         .def.type_int.max_value = vmax
950
951 #define DEFENUM(tab) \
952         .type = pvr2_ctl_enum, \
953         .def.type_enum.count = ARRAY_SIZE(tab), \
954         .def.type_enum.value_names = tab
955
956 #define DEFBOOL \
957         .type = pvr2_ctl_bool
958
959 #define DEFMASK(msk,tab) \
960         .type = pvr2_ctl_bitmask, \
961         .def.type_bitmask.valid_bits = msk, \
962         .def.type_bitmask.bit_names = tab
963
964 #define DEFREF(vname) \
965         .set_value = ctrl_set_##vname, \
966         .get_value = ctrl_get_##vname, \
967         .is_dirty = ctrl_isdirty_##vname, \
968         .clear_dirty = ctrl_cleardirty_##vname
969
970
971 #define VCREATE_FUNCS(vname) \
972 static int ctrl_get_##vname(struct pvr2_ctrl *cptr,int *vp) \
973 {*vp = cptr->hdw->vname##_val; return 0;} \
974 static int ctrl_set_##vname(struct pvr2_ctrl *cptr,int m,int v) \
975 {cptr->hdw->vname##_val = v; cptr->hdw->vname##_dirty = !0; return 0;} \
976 static int ctrl_isdirty_##vname(struct pvr2_ctrl *cptr) \
977 {return cptr->hdw->vname##_dirty != 0;} \
978 static void ctrl_cleardirty_##vname(struct pvr2_ctrl *cptr) \
979 {cptr->hdw->vname##_dirty = 0;}
980
981 VCREATE_FUNCS(brightness)
982 VCREATE_FUNCS(contrast)
983 VCREATE_FUNCS(saturation)
984 VCREATE_FUNCS(hue)
985 VCREATE_FUNCS(volume)
986 VCREATE_FUNCS(balance)
987 VCREATE_FUNCS(bass)
988 VCREATE_FUNCS(treble)
989 VCREATE_FUNCS(mute)
990 VCREATE_FUNCS(cropl)
991 VCREATE_FUNCS(cropt)
992 VCREATE_FUNCS(cropw)
993 VCREATE_FUNCS(croph)
994 VCREATE_FUNCS(audiomode)
995 VCREATE_FUNCS(res_hor)
996 VCREATE_FUNCS(res_ver)
997 VCREATE_FUNCS(srate)
998
999 /* Table definition of all controls which can be manipulated */
1000 static const struct pvr2_ctl_info control_defs[] = {
1001         {
1002                 .v4l_id = V4L2_CID_BRIGHTNESS,
1003                 .desc = "Brightness",
1004                 .name = "brightness",
1005                 .default_value = 128,
1006                 DEFREF(brightness),
1007                 DEFINT(0,255),
1008         },{
1009                 .v4l_id = V4L2_CID_CONTRAST,
1010                 .desc = "Contrast",
1011                 .name = "contrast",
1012                 .default_value = 68,
1013                 DEFREF(contrast),
1014                 DEFINT(0,127),
1015         },{
1016                 .v4l_id = V4L2_CID_SATURATION,
1017                 .desc = "Saturation",
1018                 .name = "saturation",
1019                 .default_value = 64,
1020                 DEFREF(saturation),
1021                 DEFINT(0,127),
1022         },{
1023                 .v4l_id = V4L2_CID_HUE,
1024                 .desc = "Hue",
1025                 .name = "hue",
1026                 .default_value = 0,
1027                 DEFREF(hue),
1028                 DEFINT(-128,127),
1029         },{
1030                 .v4l_id = V4L2_CID_AUDIO_VOLUME,
1031                 .desc = "Volume",
1032                 .name = "volume",
1033                 .default_value = 62000,
1034                 DEFREF(volume),
1035                 DEFINT(0,65535),
1036         },{
1037                 .v4l_id = V4L2_CID_AUDIO_BALANCE,
1038                 .desc = "Balance",
1039                 .name = "balance",
1040                 .default_value = 0,
1041                 DEFREF(balance),
1042                 DEFINT(-32768,32767),
1043         },{
1044                 .v4l_id = V4L2_CID_AUDIO_BASS,
1045                 .desc = "Bass",
1046                 .name = "bass",
1047                 .default_value = 0,
1048                 DEFREF(bass),
1049                 DEFINT(-32768,32767),
1050         },{
1051                 .v4l_id = V4L2_CID_AUDIO_TREBLE,
1052                 .desc = "Treble",
1053                 .name = "treble",
1054                 .default_value = 0,
1055                 DEFREF(treble),
1056                 DEFINT(-32768,32767),
1057         },{
1058                 .v4l_id = V4L2_CID_AUDIO_MUTE,
1059                 .desc = "Mute",
1060                 .name = "mute",
1061                 .default_value = 0,
1062                 DEFREF(mute),
1063                 DEFBOOL,
1064         }, {
1065                 .desc = "Capture crop left margin",
1066                 .name = "crop_left",
1067                 .internal_id = PVR2_CID_CROPL,
1068                 .default_value = 0,
1069                 DEFREF(cropl),
1070                 DEFINT(-129, 340),
1071                 .get_min_value = ctrl_cropl_min_get,
1072                 .get_max_value = ctrl_cropl_max_get,
1073                 .get_def_value = ctrl_get_cropcapdl,
1074         }, {
1075                 .desc = "Capture crop top margin",
1076                 .name = "crop_top",
1077                 .internal_id = PVR2_CID_CROPT,
1078                 .default_value = 0,
1079                 DEFREF(cropt),
1080                 DEFINT(-35, 544),
1081                 .get_min_value = ctrl_cropt_min_get,
1082                 .get_max_value = ctrl_cropt_max_get,
1083                 .get_def_value = ctrl_get_cropcapdt,
1084         }, {
1085                 .desc = "Capture crop width",
1086                 .name = "crop_width",
1087                 .internal_id = PVR2_CID_CROPW,
1088                 .default_value = 720,
1089                 DEFREF(cropw),
1090                 DEFINT(0, 864),
1091                 .get_max_value = ctrl_cropw_max_get,
1092                 .get_def_value = ctrl_get_cropcapdw,
1093         }, {
1094                 .desc = "Capture crop height",
1095                 .name = "crop_height",
1096                 .internal_id = PVR2_CID_CROPH,
1097                 .default_value = 480,
1098                 DEFREF(croph),
1099                 DEFINT(0, 576),
1100                 .get_max_value = ctrl_croph_max_get,
1101                 .get_def_value = ctrl_get_cropcapdh,
1102         }, {
1103                 .desc = "Capture capability pixel aspect numerator",
1104                 .name = "cropcap_pixel_numerator",
1105                 .internal_id = PVR2_CID_CROPCAPPAN,
1106                 .get_value = ctrl_get_cropcappan,
1107         }, {
1108                 .desc = "Capture capability pixel aspect denominator",
1109                 .name = "cropcap_pixel_denominator",
1110                 .internal_id = PVR2_CID_CROPCAPPAD,
1111                 .get_value = ctrl_get_cropcappad,
1112         }, {
1113                 .desc = "Capture capability bounds top",
1114                 .name = "cropcap_bounds_top",
1115                 .internal_id = PVR2_CID_CROPCAPBT,
1116                 .get_value = ctrl_get_cropcapbt,
1117         }, {
1118                 .desc = "Capture capability bounds left",
1119                 .name = "cropcap_bounds_left",
1120                 .internal_id = PVR2_CID_CROPCAPBL,
1121                 .get_value = ctrl_get_cropcapbl,
1122         }, {
1123                 .desc = "Capture capability bounds width",
1124                 .name = "cropcap_bounds_width",
1125                 .internal_id = PVR2_CID_CROPCAPBW,
1126                 .get_value = ctrl_get_cropcapbw,
1127         }, {
1128                 .desc = "Capture capability bounds height",
1129                 .name = "cropcap_bounds_height",
1130                 .internal_id = PVR2_CID_CROPCAPBH,
1131                 .get_value = ctrl_get_cropcapbh,
1132         },{
1133                 .desc = "Video Source",
1134                 .name = "input",
1135                 .internal_id = PVR2_CID_INPUT,
1136                 .default_value = PVR2_CVAL_INPUT_TV,
1137                 .check_value = ctrl_check_input,
1138                 DEFREF(input),
1139                 DEFENUM(control_values_input),
1140         },{
1141                 .desc = "Audio Mode",
1142                 .name = "audio_mode",
1143                 .internal_id = PVR2_CID_AUDIOMODE,
1144                 .default_value = V4L2_TUNER_MODE_STEREO,
1145                 DEFREF(audiomode),
1146                 DEFENUM(control_values_audiomode),
1147         },{
1148                 .desc = "Horizontal capture resolution",
1149                 .name = "resolution_hor",
1150                 .internal_id = PVR2_CID_HRES,
1151                 .default_value = 720,
1152                 DEFREF(res_hor),
1153                 DEFINT(19,720),
1154         },{
1155                 .desc = "Vertical capture resolution",
1156                 .name = "resolution_ver",
1157                 .internal_id = PVR2_CID_VRES,
1158                 .default_value = 480,
1159                 DEFREF(res_ver),
1160                 DEFINT(17,576),
1161                 /* Hook in check for video standard and adjust maximum
1162                    depending on the standard. */
1163                 .get_max_value = ctrl_vres_max_get,
1164                 .get_min_value = ctrl_vres_min_get,
1165         },{
1166                 .v4l_id = V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ,
1167                 .default_value = V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000,
1168                 .desc = "Audio Sampling Frequency",
1169                 .name = "srate",
1170                 DEFREF(srate),
1171                 DEFENUM(control_values_srate),
1172         },{
1173                 .desc = "Tuner Frequency (Hz)",
1174                 .name = "frequency",
1175                 .internal_id = PVR2_CID_FREQUENCY,
1176                 .default_value = 0,
1177                 .set_value = ctrl_freq_set,
1178                 .get_value = ctrl_freq_get,
1179                 .is_dirty = ctrl_freq_is_dirty,
1180                 .clear_dirty = ctrl_freq_clear_dirty,
1181                 DEFINT(0,0),
1182                 /* Hook in check for input value (tv/radio) and adjust
1183                    max/min values accordingly */
1184                 .get_max_value = ctrl_freq_max_get,
1185                 .get_min_value = ctrl_freq_min_get,
1186         },{
1187                 .desc = "Channel",
1188                 .name = "channel",
1189                 .set_value = ctrl_channel_set,
1190                 .get_value = ctrl_channel_get,
1191                 DEFINT(0,FREQTABLE_SIZE),
1192         },{
1193                 .desc = "Channel Program Frequency",
1194                 .name = "freq_table_value",
1195                 .set_value = ctrl_channelfreq_set,
1196                 .get_value = ctrl_channelfreq_get,
1197                 DEFINT(0,0),
1198                 /* Hook in check for input value (tv/radio) and adjust
1199                    max/min values accordingly */
1200                 .get_max_value = ctrl_freq_max_get,
1201                 .get_min_value = ctrl_freq_min_get,
1202         },{
1203                 .desc = "Channel Program ID",
1204                 .name = "freq_table_channel",
1205                 .set_value = ctrl_channelprog_set,
1206                 .get_value = ctrl_channelprog_get,
1207                 DEFINT(0,FREQTABLE_SIZE),
1208         },{
1209                 .desc = "Streaming Enabled",
1210                 .name = "streaming_enabled",
1211                 .get_value = ctrl_streamingenabled_get,
1212                 DEFBOOL,
1213         },{
1214                 .desc = "USB Speed",
1215                 .name = "usb_speed",
1216                 .get_value = ctrl_hsm_get,
1217                 DEFENUM(control_values_hsm),
1218         },{
1219                 .desc = "Master State",
1220                 .name = "master_state",
1221                 .get_value = ctrl_masterstate_get,
1222                 DEFENUM(pvr2_state_names),
1223         },{
1224                 .desc = "Signal Present",
1225                 .name = "signal_present",
1226                 .get_value = ctrl_signal_get,
1227                 DEFINT(0,65535),
1228         },{
1229                 .desc = "Audio Modes Present",
1230                 .name = "audio_modes_present",
1231                 .get_value = ctrl_audio_modes_present_get,
1232                 /* For this type we "borrow" the V4L2_TUNER_MODE enum from
1233                    v4l.  Nothing outside of this module cares about this,
1234                    but I reuse it in order to also reuse the
1235                    control_values_audiomode string table. */
1236                 DEFMASK(((1 << V4L2_TUNER_MODE_MONO)|
1237                          (1 << V4L2_TUNER_MODE_STEREO)|
1238                          (1 << V4L2_TUNER_MODE_LANG1)|
1239                          (1 << V4L2_TUNER_MODE_LANG2)),
1240                         control_values_audiomode),
1241         },{
1242                 .desc = "Video Standards Available Mask",
1243                 .name = "video_standard_mask_available",
1244                 .internal_id = PVR2_CID_STDAVAIL,
1245                 .skip_init = !0,
1246                 .get_value = ctrl_stdavail_get,
1247                 .set_value = ctrl_stdavail_set,
1248                 .val_to_sym = ctrl_std_val_to_sym,
1249                 .sym_to_val = ctrl_std_sym_to_val,
1250                 .type = pvr2_ctl_bitmask,
1251         },{
1252                 .desc = "Video Standards In Use Mask",
1253                 .name = "video_standard_mask_active",
1254                 .internal_id = PVR2_CID_STDCUR,
1255                 .skip_init = !0,
1256                 .get_value = ctrl_stdcur_get,
1257                 .set_value = ctrl_stdcur_set,
1258                 .is_dirty = ctrl_stdcur_is_dirty,
1259                 .clear_dirty = ctrl_stdcur_clear_dirty,
1260                 .val_to_sym = ctrl_std_val_to_sym,
1261                 .sym_to_val = ctrl_std_sym_to_val,
1262                 .type = pvr2_ctl_bitmask,
1263         },{
1264                 .desc = "Video Standards Detected Mask",
1265                 .name = "video_standard_mask_detected",
1266                 .internal_id = PVR2_CID_STDDETECT,
1267                 .skip_init = !0,
1268                 .get_value = ctrl_stddetect_get,
1269                 .val_to_sym = ctrl_std_val_to_sym,
1270                 .sym_to_val = ctrl_std_sym_to_val,
1271                 .type = pvr2_ctl_bitmask,
1272         }
1273 };
1274
1275 #define CTRLDEF_COUNT ARRAY_SIZE(control_defs)
1276
1277
1278 const char *pvr2_config_get_name(enum pvr2_config cfg)
1279 {
1280         switch (cfg) {
1281         case pvr2_config_empty: return "empty";
1282         case pvr2_config_mpeg: return "mpeg";
1283         case pvr2_config_vbi: return "vbi";
1284         case pvr2_config_pcm: return "pcm";
1285         case pvr2_config_rawvideo: return "raw video";
1286         }
1287         return "<unknown>";
1288 }
1289
1290
1291 struct usb_device *pvr2_hdw_get_dev(struct pvr2_hdw *hdw)
1292 {
1293         return hdw->usb_dev;
1294 }
1295
1296
1297 unsigned long pvr2_hdw_get_sn(struct pvr2_hdw *hdw)
1298 {
1299         return hdw->serial_number;
1300 }
1301
1302
1303 const char *pvr2_hdw_get_bus_info(struct pvr2_hdw *hdw)
1304 {
1305         return hdw->bus_info;
1306 }
1307
1308
1309 const char *pvr2_hdw_get_device_identifier(struct pvr2_hdw *hdw)
1310 {
1311         return hdw->identifier;
1312 }
1313
1314
1315 unsigned long pvr2_hdw_get_cur_freq(struct pvr2_hdw *hdw)
1316 {
1317         return hdw->freqSelector ? hdw->freqValTelevision : hdw->freqValRadio;
1318 }
1319
1320 /* Set the currently tuned frequency and account for all possible
1321    driver-core side effects of this action. */
1322 static void pvr2_hdw_set_cur_freq(struct pvr2_hdw *hdw,unsigned long val)
1323 {
1324         if (hdw->input_val == PVR2_CVAL_INPUT_RADIO) {
1325                 if (hdw->freqSelector) {
1326                         /* Swing over to radio frequency selection */
1327                         hdw->freqSelector = 0;
1328                         hdw->freqDirty = !0;
1329                 }
1330                 if (hdw->freqValRadio != val) {
1331                         hdw->freqValRadio = val;
1332                         hdw->freqSlotRadio = 0;
1333                         hdw->freqDirty = !0;
1334                 }
1335         } else {
1336                 if (!(hdw->freqSelector)) {
1337                         /* Swing over to television frequency selection */
1338                         hdw->freqSelector = 1;
1339                         hdw->freqDirty = !0;
1340                 }
1341                 if (hdw->freqValTelevision != val) {
1342                         hdw->freqValTelevision = val;
1343                         hdw->freqSlotTelevision = 0;
1344                         hdw->freqDirty = !0;
1345                 }
1346         }
1347 }
1348
1349 int pvr2_hdw_get_unit_number(struct pvr2_hdw *hdw)
1350 {
1351         return hdw->unit_number;
1352 }
1353
1354
1355 /* Attempt to locate one of the given set of files.  Messages are logged
1356    appropriate to what has been found.  The return value will be 0 or
1357    greater on success (it will be the index of the file name found) and
1358    fw_entry will be filled in.  Otherwise a negative error is returned on
1359    failure.  If the return value is -ENOENT then no viable firmware file
1360    could be located. */
1361 static int pvr2_locate_firmware(struct pvr2_hdw *hdw,
1362                                 const struct firmware **fw_entry,
1363                                 const char *fwtypename,
1364                                 unsigned int fwcount,
1365                                 const char *fwnames[])
1366 {
1367         unsigned int idx;
1368         int ret = -EINVAL;
1369         for (idx = 0; idx < fwcount; idx++) {
1370                 ret = request_firmware(fw_entry,
1371                                        fwnames[idx],
1372                                        &hdw->usb_dev->dev);
1373                 if (!ret) {
1374                         trace_firmware("Located %s firmware: %s;"
1375                                        " uploading...",
1376                                        fwtypename,
1377                                        fwnames[idx]);
1378                         return idx;
1379                 }
1380                 if (ret == -ENOENT) continue;
1381                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1382                            "request_firmware fatal error with code=%d",ret);
1383                 return ret;
1384         }
1385         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1386                    "***WARNING***"
1387                    " Device %s firmware"
1388                    " seems to be missing.",
1389                    fwtypename);
1390         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1391                    "Did you install the pvrusb2 firmware files"
1392                    " in their proper location?");
1393         if (fwcount == 1) {
1394                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1395                            "request_firmware unable to locate %s file %s",
1396                            fwtypename,fwnames[0]);
1397         } else {
1398                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1399                            "request_firmware unable to locate"
1400                            " one of the following %s files:",
1401                            fwtypename);
1402                 for (idx = 0; idx < fwcount; idx++) {
1403                         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1404                                    "request_firmware: Failed to find %s",
1405                                    fwnames[idx]);
1406                 }
1407         }
1408         return ret;
1409 }
1410
1411
1412 /*
1413  * pvr2_upload_firmware1().
1414  *
1415  * Send the 8051 firmware to the device.  After the upload, arrange for
1416  * device to re-enumerate.
1417  *
1418  * NOTE : the pointer to the firmware data given by request_firmware()
1419  * is not suitable for an usb transaction.
1420  *
1421  */
1422 static int pvr2_upload_firmware1(struct pvr2_hdw *hdw)
1423 {
1424         const struct firmware *fw_entry = NULL;
1425         void  *fw_ptr;
1426         unsigned int pipe;
1427         unsigned int fwsize;
1428         int ret;
1429         u16 address;
1430
1431         if (!hdw->hdw_desc->fx2_firmware.cnt) {
1432                 hdw->fw1_state = FW1_STATE_OK;
1433                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1434                            "Connected device type defines"
1435                            " no firmware to upload; ignoring firmware");
1436                 return -ENOTTY;
1437         }
1438
1439         hdw->fw1_state = FW1_STATE_FAILED; // default result
1440
1441         trace_firmware("pvr2_upload_firmware1");
1442
1443         ret = pvr2_locate_firmware(hdw,&fw_entry,"fx2 controller",
1444                                    hdw->hdw_desc->fx2_firmware.cnt,
1445                                    hdw->hdw_desc->fx2_firmware.lst);
1446         if (ret < 0) {
1447                 if (ret == -ENOENT) hdw->fw1_state = FW1_STATE_MISSING;
1448                 return ret;
1449         }
1450
1451         usb_clear_halt(hdw->usb_dev, usb_sndbulkpipe(hdw->usb_dev, 0 & 0x7f));
1452
1453         pipe = usb_sndctrlpipe(hdw->usb_dev, 0);
1454         fwsize = fw_entry->size;
1455
1456         if ((fwsize != 0x2000) &&
1457             (!(hdw->hdw_desc->flag_fx2_16kb && (fwsize == 0x4000)))) {
1458                 if (hdw->hdw_desc->flag_fx2_16kb) {
1459                         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1460                                    "Wrong fx2 firmware size"
1461                                    " (expected 8192 or 16384, got %u)",
1462                                    fwsize);
1463                 } else {
1464                         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1465                                    "Wrong fx2 firmware size"
1466                                    " (expected 8192, got %u)",
1467                                    fwsize);
1468                 }
1469                 release_firmware(fw_entry);
1470                 return -ENOMEM;
1471         }
1472
1473         fw_ptr = kmalloc(0x800, GFP_KERNEL);
1474         if (fw_ptr == NULL){
1475                 release_firmware(fw_entry);
1476                 return -ENOMEM;
1477         }
1478
1479         /* We have to hold the CPU during firmware upload. */
1480         pvr2_hdw_cpureset_assert(hdw,1);
1481
1482         /* upload the firmware to address 0000-1fff in 2048 (=0x800) bytes
1483            chunk. */
1484
1485         ret = 0;
1486         for (address = 0; address < fwsize; address += 0x800) {
1487                 memcpy(fw_ptr, fw_entry->data + address, 0x800);
1488                 ret += usb_control_msg(hdw->usb_dev, pipe, 0xa0, 0x40, address,
1489                                        0, fw_ptr, 0x800, HZ);
1490         }
1491
1492         trace_firmware("Upload done, releasing device's CPU");
1493
1494         /* Now release the CPU.  It will disconnect and reconnect later. */
1495         pvr2_hdw_cpureset_assert(hdw,0);
1496
1497         kfree(fw_ptr);
1498         release_firmware(fw_entry);
1499
1500         trace_firmware("Upload done (%d bytes sent)",ret);
1501
1502         /* We should have written fwsize bytes */
1503         if (ret == fwsize) {
1504                 hdw->fw1_state = FW1_STATE_RELOAD;
1505                 return 0;
1506         }
1507
1508         return -EIO;
1509 }
1510
1511
1512 /*
1513  * pvr2_upload_firmware2()
1514  *
1515  * This uploads encoder firmware on endpoint 2.
1516  *
1517  */
1518
1519 int pvr2_upload_firmware2(struct pvr2_hdw *hdw)
1520 {
1521         const struct firmware *fw_entry = NULL;
1522         void  *fw_ptr;
1523         unsigned int pipe, fw_len, fw_done, bcnt, icnt;
1524         int actual_length;
1525         int ret = 0;
1526         int fwidx;
1527         static const char *fw_files[] = {
1528                 CX2341X_FIRM_ENC_FILENAME,
1529         };
1530
1531         if (hdw->hdw_desc->flag_skip_cx23416_firmware) {
1532                 return 0;
1533         }
1534
1535         trace_firmware("pvr2_upload_firmware2");
1536
1537         ret = pvr2_locate_firmware(hdw,&fw_entry,"encoder",
1538                                    ARRAY_SIZE(fw_files), fw_files);
1539         if (ret < 0) return ret;
1540         fwidx = ret;
1541         ret = 0;
1542         /* Since we're about to completely reinitialize the encoder,
1543            invalidate our cached copy of its configuration state.  Next
1544            time we configure the encoder, then we'll fully configure it. */
1545         hdw->enc_cur_valid = 0;
1546
1547         /* Encoder is about to be reset so note that as far as we're
1548            concerned now, the encoder has never been run. */
1549         del_timer_sync(&hdw->encoder_run_timer);
1550         if (hdw->state_encoder_runok) {
1551                 hdw->state_encoder_runok = 0;
1552                 trace_stbit("state_encoder_runok",hdw->state_encoder_runok);
1553         }
1554
1555         /* First prepare firmware loading */
1556         ret |= pvr2_write_register(hdw, 0x0048, 0xffffffff); /*interrupt mask*/
1557         ret |= pvr2_hdw_gpio_chg_dir(hdw,0xffffffff,0x00000088); /*gpio dir*/
1558         ret |= pvr2_hdw_gpio_chg_out(hdw,0xffffffff,0x00000008); /*gpio output state*/
1559         ret |= pvr2_hdw_cmd_deep_reset(hdw);
1560         ret |= pvr2_write_register(hdw, 0xa064, 0x00000000); /*APU command*/
1561         ret |= pvr2_hdw_gpio_chg_dir(hdw,0xffffffff,0x00000408); /*gpio dir*/
1562         ret |= pvr2_hdw_gpio_chg_out(hdw,0xffffffff,0x00000008); /*gpio output state*/
1563         ret |= pvr2_write_register(hdw, 0x9058, 0xffffffed); /*VPU ctrl*/
1564         ret |= pvr2_write_register(hdw, 0x9054, 0xfffffffd); /*reset hw blocks*/
1565         ret |= pvr2_write_register(hdw, 0x07f8, 0x80000800); /*encoder SDRAM refresh*/
1566         ret |= pvr2_write_register(hdw, 0x07fc, 0x0000001a); /*encoder SDRAM pre-charge*/
1567         ret |= pvr2_write_register(hdw, 0x0700, 0x00000000); /*I2C clock*/
1568         ret |= pvr2_write_register(hdw, 0xaa00, 0x00000000); /*unknown*/
1569         ret |= pvr2_write_register(hdw, 0xaa04, 0x00057810); /*unknown*/
1570         ret |= pvr2_write_register(hdw, 0xaa10, 0x00148500); /*unknown*/
1571         ret |= pvr2_write_register(hdw, 0xaa18, 0x00840000); /*unknown*/
1572         ret |= pvr2_issue_simple_cmd(hdw,FX2CMD_FWPOST1);
1573         ret |= pvr2_issue_simple_cmd(hdw,FX2CMD_MEMSEL | (1 << 8) | (0 << 16));
1574
1575         if (ret) {
1576                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1577                            "firmware2 upload prep failed, ret=%d",ret);
1578                 release_firmware(fw_entry);
1579                 goto done;
1580         }
1581
1582         /* Now send firmware */
1583
1584         fw_len = fw_entry->size;
1585
1586         if (fw_len % sizeof(u32)) {
1587                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1588                            "size of %s firmware"
1589                            " must be a multiple of %zu bytes",
1590                            fw_files[fwidx],sizeof(u32));
1591                 release_firmware(fw_entry);
1592                 ret = -EINVAL;
1593                 goto done;
1594         }
1595
1596         fw_ptr = kmalloc(FIRMWARE_CHUNK_SIZE, GFP_KERNEL);
1597         if (fw_ptr == NULL){
1598                 release_firmware(fw_entry);
1599                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1600                            "failed to allocate memory for firmware2 upload");
1601                 ret = -ENOMEM;
1602                 goto done;
1603         }
1604
1605         pipe = usb_sndbulkpipe(hdw->usb_dev, PVR2_FIRMWARE_ENDPOINT);
1606
1607         fw_done = 0;
1608         for (fw_done = 0; fw_done < fw_len;) {
1609                 bcnt = fw_len - fw_done;
1610                 if (bcnt > FIRMWARE_CHUNK_SIZE) bcnt = FIRMWARE_CHUNK_SIZE;
1611                 memcpy(fw_ptr, fw_entry->data + fw_done, bcnt);
1612                 /* Usbsnoop log shows that we must swap bytes... */
1613                 /* Some background info: The data being swapped here is a
1614                    firmware image destined for the mpeg encoder chip that
1615                    lives at the other end of a USB endpoint.  The encoder
1616                    chip always talks in 32 bit chunks and its storage is
1617                    organized into 32 bit words.  However from the file
1618                    system to the encoder chip everything is purely a byte
1619                    stream.  The firmware file's contents are always 32 bit
1620                    swapped from what the encoder expects.  Thus the need
1621                    always exists to swap the bytes regardless of the endian
1622                    type of the host processor and therefore swab32() makes
1623                    the most sense. */
1624                 for (icnt = 0; icnt < bcnt/4 ; icnt++)
1625                         ((u32 *)fw_ptr)[icnt] = swab32(((u32 *)fw_ptr)[icnt]);
1626
1627                 ret |= usb_bulk_msg(hdw->usb_dev, pipe, fw_ptr,bcnt,
1628                                     &actual_length, HZ);
1629                 ret |= (actual_length != bcnt);
1630                 if (ret) break;
1631                 fw_done += bcnt;
1632         }
1633
1634         trace_firmware("upload of %s : %i / %i ",
1635                        fw_files[fwidx],fw_done,fw_len);
1636
1637         kfree(fw_ptr);
1638         release_firmware(fw_entry);
1639
1640         if (ret) {
1641                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1642                            "firmware2 upload transfer failure");
1643                 goto done;
1644         }
1645
1646         /* Finish upload */
1647
1648         ret |= pvr2_write_register(hdw, 0x9054, 0xffffffff); /*reset hw blocks*/
1649         ret |= pvr2_write_register(hdw, 0x9058, 0xffffffe8); /*VPU ctrl*/
1650         ret |= pvr2_issue_simple_cmd(hdw,FX2CMD_MEMSEL | (1 << 8) | (0 << 16));
1651
1652         if (ret) {
1653                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1654                            "firmware2 upload post-proc failure");
1655         }
1656
1657  done:
1658         if (hdw->hdw_desc->signal_routing_scheme ==
1659             PVR2_ROUTING_SCHEME_GOTVIEW) {
1660                 /* Ensure that GPIO 11 is set to output for GOTVIEW
1661                    hardware. */
1662                 pvr2_hdw_gpio_chg_dir(hdw,(1 << 11),~0);
1663         }
1664         return ret;
1665 }
1666
1667
1668 static const char *pvr2_get_state_name(unsigned int st)
1669 {
1670         if (st < ARRAY_SIZE(pvr2_state_names)) {
1671                 return pvr2_state_names[st];
1672         }
1673         return "???";
1674 }
1675
1676 static int pvr2_decoder_enable(struct pvr2_hdw *hdw,int enablefl)
1677 {
1678         /* Even though we really only care about the video decoder chip at
1679            this point, we'll broadcast stream on/off to all sub-devices
1680            anyway, just in case somebody else wants to hear the
1681            command... */
1682         pvr2_trace(PVR2_TRACE_CHIPS, "subdev v4l2 stream=%s",
1683                    (enablefl ? "on" : "off"));
1684         v4l2_device_call_all(&hdw->v4l2_dev, 0, video, s_stream, enablefl);
1685         v4l2_device_call_all(&hdw->v4l2_dev, 0, audio, s_stream, enablefl);
1686         if (hdw->decoder_client_id) {
1687                 /* We get here if the encoder has been noticed.  Otherwise
1688                    we'll issue a warning to the user (which should
1689                    normally never happen). */
1690                 return 0;
1691         }
1692         if (!hdw->flag_decoder_missed) {
1693                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1694                            "WARNING: No decoder present");
1695                 hdw->flag_decoder_missed = !0;
1696                 trace_stbit("flag_decoder_missed",
1697                             hdw->flag_decoder_missed);
1698         }
1699         return -EIO;
1700 }
1701
1702
1703 int pvr2_hdw_get_state(struct pvr2_hdw *hdw)
1704 {
1705         return hdw->master_state;
1706 }
1707
1708
1709 static int pvr2_hdw_untrip_unlocked(struct pvr2_hdw *hdw)
1710 {
1711         if (!hdw->flag_tripped) return 0;
1712         hdw->flag_tripped = 0;
1713         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
1714                    "Clearing driver error statuss");
1715         return !0;
1716 }
1717
1718
1719 int pvr2_hdw_untrip(struct pvr2_hdw *hdw)
1720 {
1721         int fl;
1722         LOCK_TAKE(hdw->big_lock); do {
1723                 fl = pvr2_hdw_untrip_unlocked(hdw);
1724         } while (0); LOCK_GIVE(hdw->big_lock);
1725         if (fl) pvr2_hdw_state_sched(hdw);
1726         return 0;
1727 }
1728
1729
1730
1731
1732 int pvr2_hdw_get_streaming(struct pvr2_hdw *hdw)
1733 {
1734         return hdw->state_pipeline_req != 0;
1735 }
1736
1737
1738 int pvr2_hdw_set_streaming(struct pvr2_hdw *hdw,int enable_flag)
1739 {
1740         int ret,st;
1741         LOCK_TAKE(hdw->big_lock); do {
1742                 pvr2_hdw_untrip_unlocked(hdw);
1743                 if ((!enable_flag) != !(hdw->state_pipeline_req)) {
1744                         hdw->state_pipeline_req = enable_flag != 0;
1745                         pvr2_trace(PVR2_TRACE_START_STOP,
1746                                    "/*--TRACE_STREAM--*/ %s",
1747                                    enable_flag ? "enable" : "disable");
1748                 }
1749                 pvr2_hdw_state_sched(hdw);
1750         } while (0); LOCK_GIVE(hdw->big_lock);
1751         if ((ret = pvr2_hdw_wait(hdw,0)) < 0) return ret;
1752         if (enable_flag) {
1753                 while ((st = hdw->master_state) != PVR2_STATE_RUN) {
1754                         if (st != PVR2_STATE_READY) return -EIO;
1755                         if ((ret = pvr2_hdw_wait(hdw,st)) < 0) return ret;
1756                 }
1757         }
1758         return 0;
1759 }
1760
1761
1762 int pvr2_hdw_set_stream_type(struct pvr2_hdw *hdw,enum pvr2_config config)
1763 {
1764         int fl;
1765         LOCK_TAKE(hdw->big_lock);
1766         if ((fl = (hdw->desired_stream_type != config)) != 0) {
1767                 hdw->desired_stream_type = config;
1768                 hdw->state_pipeline_config = 0;
1769                 trace_stbit("state_pipeline_config",
1770                             hdw->state_pipeline_config);
1771                 pvr2_hdw_state_sched(hdw);
1772         }
1773         LOCK_GIVE(hdw->big_lock);
1774         if (fl) return 0;
1775         return pvr2_hdw_wait(hdw,0);
1776 }
1777
1778
1779 static int get_default_tuner_type(struct pvr2_hdw *hdw)
1780 {
1781         int unit_number = hdw->unit_number;
1782         int tp = -1;
1783         if ((unit_number >= 0) && (unit_number < PVR_NUM)) {
1784                 tp = tuner[unit_number];
1785         }
1786         if (tp < 0) return -EINVAL;
1787         hdw->tuner_type = tp;
1788         hdw->tuner_updated = !0;
1789         return 0;
1790 }
1791
1792
1793 static v4l2_std_id get_default_standard(struct pvr2_hdw *hdw)
1794 {
1795         int unit_number = hdw->unit_number;
1796         int tp = 0;
1797         if ((unit_number >= 0) && (unit_number < PVR_NUM)) {
1798                 tp = video_std[unit_number];
1799                 if (tp) return tp;
1800         }
1801         return 0;
1802 }
1803
1804
1805 static unsigned int get_default_error_tolerance(struct pvr2_hdw *hdw)
1806 {
1807         int unit_number = hdw->unit_number;
1808         int tp = 0;
1809         if ((unit_number >= 0) && (unit_number < PVR_NUM)) {
1810                 tp = tolerance[unit_number];
1811         }
1812         return tp;
1813 }
1814
1815
1816 static int pvr2_hdw_check_firmware(struct pvr2_hdw *hdw)
1817 {
1818         /* Try a harmless request to fetch the eeprom's address over
1819            endpoint 1.  See what happens.  Only the full FX2 image can
1820            respond to this.  If this probe fails then likely the FX2
1821            firmware needs be loaded. */
1822         int result;
1823         LOCK_TAKE(hdw->ctl_lock); do {
1824                 hdw->cmd_buffer[0] = FX2CMD_GET_EEPROM_ADDR;
1825                 result = pvr2_send_request_ex(hdw,HZ*1,!0,
1826                                            hdw->cmd_buffer,1,
1827                                            hdw->cmd_buffer,1);
1828                 if (result < 0) break;
1829         } while(0); LOCK_GIVE(hdw->ctl_lock);
1830         if (result) {
1831                 pvr2_trace(PVR2_TRACE_INIT,
1832                            "Probe of device endpoint 1 result status %d",
1833                            result);
1834         } else {
1835                 pvr2_trace(PVR2_TRACE_INIT,
1836                            "Probe of device endpoint 1 succeeded");
1837         }
1838         return result == 0;
1839 }
1840
1841 struct pvr2_std_hack {
1842         v4l2_std_id pat;  /* Pattern to match */
1843         v4l2_std_id msk;  /* Which bits we care about */
1844         v4l2_std_id std;  /* What additional standards or default to set */
1845 };
1846
1847 /* This data structure labels specific combinations of standards from
1848    tveeprom that we'll try to recognize.  If we recognize one, then assume
1849    a specified default standard to use.  This is here because tveeprom only
1850    tells us about available standards not the intended default standard (if
1851    any) for the device in question.  We guess the default based on what has
1852    been reported as available.  Note that this is only for guessing a
1853    default - which can always be overridden explicitly - and if the user
1854    has otherwise named a default then that default will always be used in
1855    place of this table. */
1856 static const struct pvr2_std_hack std_eeprom_maps[] = {
1857         {       /* PAL(B/G) */
1858                 .pat = V4L2_STD_B|V4L2_STD_GH,
1859                 .std = V4L2_STD_PAL_B|V4L2_STD_PAL_B1|V4L2_STD_PAL_G,
1860         },
1861         {       /* NTSC(M) */
1862                 .pat = V4L2_STD_MN,
1863                 .std = V4L2_STD_NTSC_M,
1864         },
1865         {       /* PAL(I) */
1866                 .pat = V4L2_STD_PAL_I,
1867                 .std = V4L2_STD_PAL_I,
1868         },
1869         {       /* SECAM(L/L') */
1870                 .pat = V4L2_STD_SECAM_L|V4L2_STD_SECAM_LC,
1871                 .std = V4L2_STD_SECAM_L|V4L2_STD_SECAM_LC,
1872         },
1873         {       /* PAL(D/D1/K) */
1874                 .pat = V4L2_STD_DK,
1875                 .std = V4L2_STD_PAL_D|V4L2_STD_PAL_D1|V4L2_STD_PAL_K,
1876         },
1877 };
1878
1879 static void pvr2_hdw_setup_std(struct pvr2_hdw *hdw)
1880 {
1881         char buf[40];
1882         unsigned int bcnt;
1883         v4l2_std_id std1,std2,std3;
1884
1885         std1 = get_default_standard(hdw);
1886         std3 = std1 ? 0 : hdw->hdw_desc->default_std_mask;
1887
1888         bcnt = pvr2_std_id_to_str(buf,sizeof(buf),hdw->std_mask_eeprom);
1889         pvr2_trace(PVR2_TRACE_STD,
1890                    "Supported video standard(s) reported available"
1891                    " in hardware: %.*s",
1892                    bcnt,buf);
1893
1894         hdw->std_mask_avail = hdw->std_mask_eeprom;
1895
1896         std2 = (std1|std3) & ~hdw->std_mask_avail;
1897         if (std2) {
1898                 bcnt = pvr2_std_id_to_str(buf,sizeof(buf),std2);
1899                 pvr2_trace(PVR2_TRACE_STD,
1900                            "Expanding supported video standards"
1901                            " to include: %.*s",
1902                            bcnt,buf);
1903                 hdw->std_mask_avail |= std2;
1904         }
1905
1906         hdw->std_info_cur.def.type_bitmask.valid_bits = hdw->std_mask_avail;
1907
1908         if (std1) {
1909                 bcnt = pvr2_std_id_to_str(buf,sizeof(buf),std1);
1910                 pvr2_trace(PVR2_TRACE_STD,
1911                            "Initial video standard forced to %.*s",
1912                            bcnt,buf);
1913                 hdw->std_mask_cur = std1;
1914                 hdw->std_dirty = !0;
1915                 return;
1916         }
1917         if (std3) {
1918                 bcnt = pvr2_std_id_to_str(buf,sizeof(buf),std3);
1919                 pvr2_trace(PVR2_TRACE_STD,
1920                            "Initial video standard"
1921                            " (determined by device type): %.*s",bcnt,buf);
1922                 hdw->std_mask_cur = std3;
1923                 hdw->std_dirty = !0;
1924                 return;
1925         }
1926
1927         {
1928                 unsigned int idx;
1929                 for (idx = 0; idx < ARRAY_SIZE(std_eeprom_maps); idx++) {
1930                         if (std_eeprom_maps[idx].msk ?
1931                             ((std_eeprom_maps[idx].pat ^
1932                              hdw->std_mask_eeprom) &
1933                              std_eeprom_maps[idx].msk) :
1934                             (std_eeprom_maps[idx].pat !=
1935                              hdw->std_mask_eeprom)) continue;
1936                         bcnt = pvr2_std_id_to_str(buf,sizeof(buf),
1937                                                   std_eeprom_maps[idx].std);
1938                         pvr2_trace(PVR2_TRACE_STD,
1939                                    "Initial video standard guessed as %.*s",
1940                                    bcnt,buf);
1941                         hdw->std_mask_cur = std_eeprom_maps[idx].std;
1942                         hdw->std_dirty = !0;
1943                         return;
1944                 }
1945         }
1946
1947 }
1948
1949
1950 static unsigned int pvr2_copy_i2c_addr_list(
1951         unsigned short *dst, const unsigned char *src,
1952         unsigned int dst_max)
1953 {
1954         unsigned int cnt = 0;
1955         if (!src) return 0;
1956         while (src[cnt] && (cnt + 1) < dst_max) {
1957                 dst[cnt] = src[cnt];
1958                 cnt++;
1959         }
1960         dst[cnt] = I2C_CLIENT_END;
1961         return cnt;
1962 }
1963
1964
1965 static void pvr2_hdw_cx25840_vbi_hack(struct pvr2_hdw *hdw)
1966 {
1967         /*
1968           Mike Isely <isely@pobox.com> 19-Nov-2006 - This bit of nuttiness
1969           for cx25840 causes that module to correctly set up its video
1970           scaling.  This is really a problem in the cx25840 module itself,
1971           but we work around it here.  The problem has not been seen in
1972           ivtv because there VBI is supported and set up.  We don't do VBI
1973           here (at least not yet) and thus we never attempted to even set
1974           it up.
1975         */
1976         struct v4l2_format fmt;
1977         if (hdw->decoder_client_id != PVR2_CLIENT_ID_CX25840) {
1978                 /* We're not using a cx25840 so don't enable the hack */
1979                 return;
1980         }
1981
1982         pvr2_trace(PVR2_TRACE_INIT,
1983                    "Module ID %u:"
1984                    " Executing cx25840 VBI hack",
1985                    hdw->decoder_client_id);
1986         memset(&fmt, 0, sizeof(fmt));
1987         fmt.type = V4L2_BUF_TYPE_SLICED_VBI_CAPTURE;
1988         fmt.fmt.sliced.service_lines[0][21] = V4L2_SLICED_CAPTION_525;
1989         fmt.fmt.sliced.service_lines[1][21] = V4L2_SLICED_CAPTION_525;
1990         v4l2_device_call_all(&hdw->v4l2_dev, hdw->decoder_client_id,
1991                              vbi, s_sliced_fmt, &fmt.fmt.sliced);
1992 }
1993
1994
1995 static int pvr2_hdw_load_subdev(struct pvr2_hdw *hdw,
1996                                 const struct pvr2_device_client_desc *cd)
1997 {
1998         const char *fname;
1999         unsigned char mid;
2000         struct v4l2_subdev *sd;
2001         unsigned int i2ccnt;
2002         const unsigned char *p;
2003         /* Arbitrary count - max # i2c addresses we will probe */
2004         unsigned short i2caddr[25];
2005
2006         mid = cd->module_id;
2007         fname = (mid < ARRAY_SIZE(module_names)) ? module_names[mid] : NULL;
2008         if (!fname) {
2009                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
2010                            "Module ID %u for device %s has no name?"
2011                            "  The driver might have a configuration problem.",
2012                            mid,
2013                            hdw->hdw_desc->description);
2014                 return -EINVAL;
2015         }
2016         pvr2_trace(PVR2_TRACE_INIT,
2017                    "Module ID %u (%s) for device %s being loaded...",
2018                    mid, fname,
2019                    hdw->hdw_desc->description);
2020
2021         i2ccnt = pvr2_copy_i2c_addr_list(i2caddr, cd->i2c_address_list,
2022                                          ARRAY_SIZE(i2caddr));
2023         if (!i2ccnt && ((p = (mid < ARRAY_SIZE(module_i2c_addresses)) ?
2024                          module_i2c_addresses[mid] : NULL) != NULL)) {
2025                 /* Second chance: Try default i2c address list */
2026                 i2ccnt = pvr2_copy_i2c_addr_list(i2caddr, p,
2027                                                  ARRAY_SIZE(i2caddr));
2028                 if (i2ccnt) {
2029                         pvr2_trace(PVR2_TRACE_INIT,
2030                                    "Module ID %u:"
2031                                    " Using default i2c address list",
2032                                    mid);
2033                 }
2034         }
2035
2036         if (!i2ccnt) {
2037                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
2038                            "Module ID %u (%s) for device %s:"
2039                            " No i2c addresses."
2040                            "  The driver might have a configuration problem.",
2041                            mid, fname, hdw->hdw_desc->description);
2042                 return -EINVAL;
2043         }
2044
2045         if (i2ccnt == 1) {
2046                 pvr2_trace(PVR2_TRACE_INIT,
2047                            "Module ID %u:"
2048                            " Setting up with specified i2c address 0x%x",
2049                            mid, i2caddr[0]);
2050                 sd = v4l2_i2c_new_subdev(&hdw->v4l2_dev, &hdw->i2c_adap,
2051                                          fname, i2caddr[0], NULL);
2052         } else {
2053                 pvr2_trace(PVR2_TRACE_INIT,
2054                            "Module ID %u:"
2055                            " Setting up with address probe list",
2056                            mid);
2057                 sd = v4l2_i2c_new_subdev(&hdw->v4l2_dev, &hdw->i2c_adap,
2058                                          fname, 0, i2caddr);
2059         }
2060
2061         if (!sd) {
2062                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
2063                            "Module ID %u (%s) for device %s failed to load."
2064                            "  Possible missing sub-device kernel module or"
2065                            " initialization failure within module.",
2066                            mid, fname, hdw->hdw_desc->description);
2067                 return -EIO;
2068         }
2069
2070         /* Tag this sub-device instance with the module ID we know about.
2071            In other places we'll use that tag to determine if the instance
2072            requires special handling. */
2073         sd->grp_id = mid;
2074
2075         pvr2_trace(PVR2_TRACE_INFO, "Attached sub-driver %s", fname);
2076
2077
2078         /* client-specific setup... */
2079         switch (mid) {
2080         case PVR2_CLIENT_ID_CX25840:
2081         case PVR2_CLIENT_ID_SAA7115:
2082                 hdw->decoder_client_id = mid;
2083                 break;
2084         default: break;
2085         }
2086
2087         return 0;
2088 }
2089
2090
2091 static void pvr2_hdw_load_modules(struct pvr2_hdw *hdw)
2092 {
2093         unsigned int idx;
2094         const struct pvr2_string_table *cm;
2095         const struct pvr2_device_client_table *ct;
2096         int okFl = !0;
2097
2098         cm = &hdw->hdw_desc->client_modules;
2099         for (idx = 0; idx < cm->cnt; idx++) {
2100                 request_module(cm->lst[idx]);
2101         }
2102
2103         ct = &hdw->hdw_desc->client_table;
2104         for (idx = 0; idx < ct->cnt; idx++) {
2105                 if (pvr2_hdw_load_subdev(hdw, &ct->lst[idx]) < 0) okFl = 0;
2106         }
2107         if (!okFl) {
2108                 hdw->flag_modulefail = !0;
2109                 pvr2_hdw_render_useless(hdw);
2110         }
2111 }
2112
2113
2114 static void pvr2_hdw_setup_low(struct pvr2_hdw *hdw)
2115 {
2116         int ret;
2117         unsigned int idx;
2118         struct pvr2_ctrl *cptr;
2119         int reloadFl = 0;
2120         if (hdw->hdw_desc->fx2_firmware.cnt) {
2121                 if (!reloadFl) {
2122                         reloadFl =
2123                                 (hdw->usb_intf->cur_altsetting->desc.bNumEndpoints
2124                                  == 0);
2125                         if (reloadFl) {
2126                                 pvr2_trace(PVR2_TRACE_INIT,
2127                                            "USB endpoint config looks strange"
2128                                            "; possibly firmware needs to be"
2129                                            " loaded");
2130                         }
2131                 }
2132                 if (!reloadFl) {
2133                         reloadFl = !pvr2_hdw_check_firmware(hdw);
2134                         if (reloadFl) {
2135                                 pvr2_trace(PVR2_TRACE_INIT,
2136                                            "Check for FX2 firmware failed"
2137                                            "; possibly firmware needs to be"
2138                                            " loaded");
2139                         }
2140                 }
2141                 if (reloadFl) {
2142                         if (pvr2_upload_firmware1(hdw) != 0) {
2143                                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
2144                                            "Failure uploading firmware1");
2145                         }
2146                         return;
2147                 }
2148         }
2149         hdw->fw1_state = FW1_STATE_OK;
2150
2151         if (!pvr2_hdw_dev_ok(hdw)) return;
2152
2153         hdw->force_dirty = !0;
2154
2155         if (!hdw->hdw_desc->flag_no_powerup) {
2156                 pvr2_hdw_cmd_powerup(hdw);
2157                 if (!pvr2_hdw_dev_ok(hdw)) return;
2158         }
2159
2160         /* Take the IR chip out of reset, if appropriate */
2161         if (hdw->ir_scheme_active == PVR2_IR_SCHEME_ZILOG) {
2162                 pvr2_issue_simple_cmd(hdw,
2163                                       FX2CMD_HCW_ZILOG_RESET |
2164                                       (1 << 8) |
2165                                       ((0) << 16));
2166         }
2167
2168         // This step MUST happen after the earlier powerup step.
2169         pvr2_i2c_core_init(hdw);
2170         if (!pvr2_hdw_dev_ok(hdw)) return;
2171
2172         pvr2_hdw_load_modules(hdw);
2173         if (!pvr2_hdw_dev_ok(hdw)) return;
2174
2175         v4l2_device_call_all(&hdw->v4l2_dev, 0, core, load_fw);
2176
2177         for (idx = 0; idx < CTRLDEF_COUNT; idx++) {
2178                 cptr = hdw->controls + idx;
2179                 if (cptr->info->skip_init) continue;
2180                 if (!cptr->info->set_value) continue;
2181                 cptr->info->set_value(cptr,~0,cptr->info->default_value);
2182         }
2183
2184         pvr2_hdw_cx25840_vbi_hack(hdw);
2185
2186         /* Set up special default values for the television and radio
2187            frequencies here.  It's not really important what these defaults
2188            are, but I set them to something usable in the Chicago area just
2189            to make driver testing a little easier. */
2190
2191         hdw->freqValTelevision = default_tv_freq;
2192         hdw->freqValRadio = default_radio_freq;
2193
2194         // Do not use pvr2_reset_ctl_endpoints() here.  It is not
2195         // thread-safe against the normal pvr2_send_request() mechanism.
2196         // (We should make it thread safe).
2197
2198         if (hdw->hdw_desc->flag_has_hauppauge_rom) {
2199                 ret = pvr2_hdw_get_eeprom_addr(hdw);
2200                 if (!pvr2_hdw_dev_ok(hdw)) return;
2201                 if (ret < 0) {
2202                         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
2203                                    "Unable to determine location of eeprom,"
2204                                    " skipping");
2205                 } else {
2206                         hdw->eeprom_addr = ret;
2207                         pvr2_eeprom_analyze(hdw);
2208                         if (!pvr2_hdw_dev_ok(hdw)) return;
2209                 }
2210         } else {
2211                 hdw->tuner_type = hdw->hdw_desc->default_tuner_type;
2212                 hdw->tuner_updated = !0;
2213                 hdw->std_mask_eeprom = V4L2_STD_ALL;
2214         }
2215
2216         if (hdw->serial_number) {
2217                 idx = scnprintf(hdw->identifier, sizeof(hdw->identifier) - 1,
2218                                 "sn-%lu", hdw->serial_number);
2219         } else if (hdw->unit_number >= 0) {
2220                 idx = scnprintf(hdw->identifier, sizeof(hdw->identifier) - 1,
2221                                 "unit-%c",
2222                                 hdw->unit_number + 'a');
2223         } else {
2224                 idx = scnprintf(hdw->identifier, sizeof(hdw->identifier) - 1,
2225                                 "unit-??");
2226         }
2227         hdw->identifier[idx] = 0;
2228
2229         pvr2_hdw_setup_std(hdw);
2230
2231         if (!get_default_tuner_type(hdw)) {
2232                 pvr2_trace(PVR2_TRACE_INIT,
2233                            "pvr2_hdw_setup: Tuner type overridden to %d",
2234                            hdw->tuner_type);
2235         }
2236
2237
2238         if (!pvr2_hdw_dev_ok(hdw)) return;
2239
2240         if (hdw->hdw_desc->signal_routing_scheme ==
2241             PVR2_ROUTING_SCHEME_GOTVIEW) {
2242                 /* Ensure that GPIO 11 is set to output for GOTVIEW
2243                    hardware. */
2244                 pvr2_hdw_gpio_chg_dir(hdw,(1 << 11),~0);
2245         }
2246
2247         pvr2_hdw_commit_setup(hdw);
2248
2249         hdw->vid_stream = pvr2_stream_create();
2250         if (!pvr2_hdw_dev_ok(hdw)) return;
2251         pvr2_trace(PVR2_TRACE_INIT,
2252                    "pvr2_hdw_setup: video stream is %p",hdw->vid_stream);
2253         if (hdw->vid_stream) {
2254                 idx = get_default_error_tolerance(hdw);
2255                 if (idx) {
2256                         pvr2_trace(PVR2_TRACE_INIT,
2257                                    "pvr2_hdw_setup: video stream %p"
2258                                    " setting tolerance %u",
2259                                    hdw->vid_stream,idx);
2260                 }
2261                 pvr2_stream_setup(hdw->vid_stream,hdw->usb_dev,
2262                                   PVR2_VID_ENDPOINT,idx);
2263         }
2264
2265         if (!pvr2_hdw_dev_ok(hdw)) return;
2266
2267         hdw->flag_init_ok = !0;
2268
2269         pvr2_hdw_state_sched(hdw);
2270 }
2271
2272
2273 /* Set up the structure and attempt to put the device into a usable state.
2274    This can be a time-consuming operation, which is why it is not done
2275    internally as part of the create() step. */
2276 static void pvr2_hdw_setup(struct pvr2_hdw *hdw)
2277 {
2278         pvr2_trace(PVR2_TRACE_INIT,"pvr2_hdw_setup(hdw=%p) begin",hdw);
2279         do {
2280                 pvr2_hdw_setup_low(hdw);
2281                 pvr2_trace(PVR2_TRACE_INIT,
2282                            "pvr2_hdw_setup(hdw=%p) done, ok=%d init_ok=%d",
2283                            hdw,pvr2_hdw_dev_ok(hdw),hdw->flag_init_ok);
2284                 if (pvr2_hdw_dev_ok(hdw)) {
2285                         if (hdw->flag_init_ok) {
2286                                 pvr2_trace(
2287                                         PVR2_TRACE_INFO,
2288                                         "Device initialization"
2289                                         " completed successfully.");
2290                                 break;
2291                         }
2292                         if (hdw->fw1_state == FW1_STATE_RELOAD) {
2293                                 pvr2_trace(
2294                                         PVR2_TRACE_INFO,
2295                                         "Device microcontroller firmware"
2296                                         " (re)loaded; it should now reset"
2297                                         " and reconnect.");
2298                                 break;
2299                         }
2300                         pvr2_trace(
2301                                 PVR2_TRACE_ERROR_LEGS,
2302                                 "Device initialization was not successful.");
2303                         if (hdw->fw1_state == FW1_STATE_MISSING) {
2304                                 pvr2_trace(
2305                                         PVR2_TRACE_ERROR_LEGS,
2306                                         "Giving up since device"
2307                                         " microcontroller firmware"
2308                                         " appears to be missing.");
2309                                 break;
2310                         }
2311                 }
2312                 if (hdw->flag_modulefail) {
2313                         pvr2_trace(
2314                                 PVR2_TRACE_ERROR_LEGS,
2315                                 "***WARNING*** pvrusb2 driver initialization"
2316                                 " failed due to the failure of one or more"
2317                                 " sub-device kernel modules.");
2318                         pvr2_trace(
2319                                 PVR2_TRACE_ERROR_LEGS,
2320                                 "You need to resolve the failing condition"
2321                                 " before this driver can function.  There"
2322                                 " should be some earlier messages giving more"
2323                                 " information about the problem.");
2324                         break;
2325                 }
2326                 if (procreload) {
2327                         pvr2_trace(
2328                                 PVR2_TRACE_ERROR_LEGS,
2329                                 "Attempting pvrusb2 recovery by reloading"
2330                                 " primary firmware.");
2331                         pvr2_trace(
2332                                 PVR2_TRACE_ERROR_LEGS,
2333                                 "If this works, device should disconnect"
2334                                 " and reconnect in a sane state.");
2335                         hdw->fw1_state = FW1_STATE_UNKNOWN;
2336                         pvr2_upload_firmware1(hdw);
2337                 } else {
2338                         pvr2_trace(
2339                                 PVR2_TRACE_ERROR_LEGS,
2340                                 "***WARNING*** pvrusb2 device hardware"
2341                                 " appears to be jammed"
2342                                 " and I can't clear it.");
2343                         pvr2_trace(
2344                                 PVR2_TRACE_ERROR_LEGS,
2345                                 "You might need to power cycle"
2346                                 " the pvrusb2 device"
2347                                 " in order to recover.");
2348                 }
2349         } while (0);
2350         pvr2_trace(PVR2_TRACE_INIT,"pvr2_hdw_setup(hdw=%p) end",hdw);
2351 }
2352
2353
2354 /* Perform second stage initialization.  Set callback pointer first so that
2355    we can avoid a possible initialization race (if the kernel thread runs
2356    before the callback has been set). */
2357 int pvr2_hdw_initialize(struct pvr2_hdw *hdw,
2358                         void (*callback_func)(void *),
2359                         void *callback_data)
2360 {
2361         LOCK_TAKE(hdw->big_lock); do {
2362                 if (hdw->flag_disconnected) {
2363                         /* Handle a race here: If we're already
2364                            disconnected by this point, then give up.  If we
2365                            get past this then we'll remain connected for
2366                            the duration of initialization since the entire
2367                            initialization sequence is now protected by the
2368                            big_lock. */
2369                         break;
2370                 }
2371                 hdw->state_data = callback_data;
2372                 hdw->state_func = callback_func;
2373                 pvr2_hdw_setup(hdw);
2374         } while (0); LOCK_GIVE(hdw->big_lock);
2375         return hdw->flag_init_ok;
2376 }
2377
2378
2379 /* Create, set up, and return a structure for interacting with the
2380    underlying hardware.  */
2381 struct pvr2_hdw *pvr2_hdw_create(struct usb_interface *intf,
2382                                  const struct usb_device_id *devid)
2383 {
2384         unsigned int idx,cnt1,cnt2,m;
2385         struct pvr2_hdw *hdw = NULL;
2386         int valid_std_mask;
2387         struct pvr2_ctrl *cptr;
2388         struct usb_device *usb_dev;
2389         const struct pvr2_device_desc *hdw_desc;
2390         __u8 ifnum;
2391         struct v4l2_queryctrl qctrl;
2392         struct pvr2_ctl_info *ciptr;
2393
2394         usb_dev = interface_to_usbdev(intf);
2395
2396         hdw_desc = (const struct pvr2_device_desc *)(devid->driver_info);
2397
2398         if (hdw_desc == NULL) {
2399                 pvr2_trace(PVR2_TRACE_INIT, "pvr2_hdw_create:"
2400                            " No device description pointer,"
2401                            " unable to continue.");
2402                 pvr2_trace(PVR2_TRACE_INIT, "If you have a new device type,"
2403                            " please contact Mike Isely <isely@pobox.com>"
2404                            " to get it included in the driver\n");
2405                 goto fail;
2406         }
2407
2408         hdw = kzalloc(sizeof(*hdw),GFP_KERNEL);
2409         pvr2_trace(PVR2_TRACE_INIT,"pvr2_hdw_create: hdw=%p, type \"%s\"",
2410                    hdw,hdw_desc->description);
2411         pvr2_trace(PVR2_TRACE_INFO, "Hardware description: %s",
2412                 hdw_desc->description);
2413         if (hdw_desc->flag_is_experimental) {
2414                 pvr2_trace(PVR2_TRACE_INFO, "**********");
2415                 pvr2_trace(PVR2_TRACE_INFO,
2416                            "WARNING: Support for this device (%s) is"
2417                            " experimental.", hdw_desc->description);
2418                 pvr2_trace(PVR2_TRACE_INFO,
2419                            "Important functionality might not be"
2420                            " entirely working.");
2421                 pvr2_trace(PVR2_TRACE_INFO,
2422                            "Please consider contacting the driver author to"
2423                            " help with further stabilization of the driver.");
2424                 pvr2_trace(PVR2_TRACE_INFO, "**********");
2425         }
2426         if (!hdw) goto fail;
2427
2428         setup_timer(&hdw->quiescent_timer, pvr2_hdw_quiescent_timeout,
2429                     (unsigned long)hdw);
2430
2431         setup_timer(&hdw->decoder_stabilization_timer,
2432                     pvr2_hdw_decoder_stabilization_timeout,
2433                     (unsigned long)hdw);
2434
2435         setup_timer(&hdw->encoder_wait_timer, pvr2_hdw_encoder_wait_timeout,
2436                     (unsigned long)hdw);
2437
2438         setup_timer(&hdw->encoder_run_timer, pvr2_hdw_encoder_run_timeout,
2439                     (unsigned long)hdw);
2440
2441         hdw->master_state = PVR2_STATE_DEAD;
2442
2443         init_waitqueue_head(&hdw->state_wait_data);
2444
2445         hdw->tuner_signal_stale = !0;
2446         cx2341x_fill_defaults(&hdw->enc_ctl_state);
2447
2448         /* Calculate which inputs are OK */
2449         m = 0;
2450         if (hdw_desc->flag_has_analogtuner) m |= 1 << PVR2_CVAL_INPUT_TV;
2451         if (hdw_desc->digital_control_scheme != PVR2_DIGITAL_SCHEME_NONE) {
2452                 m |= 1 << PVR2_CVAL_INPUT_DTV;
2453         }
2454         if (hdw_desc->flag_has_svideo) m |= 1 << PVR2_CVAL_INPUT_SVIDEO;
2455         if (hdw_desc->flag_has_composite) m |= 1 << PVR2_CVAL_INPUT_COMPOSITE;
2456         if (hdw_desc->flag_has_fmradio) m |= 1 << PVR2_CVAL_INPUT_RADIO;
2457         hdw->input_avail_mask = m;
2458         hdw->input_allowed_mask = hdw->input_avail_mask;
2459
2460         /* If not a hybrid device, pathway_state never changes.  So
2461            initialize it here to what it should forever be. */
2462         if (!(hdw->input_avail_mask & (1 << PVR2_CVAL_INPUT_DTV))) {
2463                 hdw->pathway_state = PVR2_PATHWAY_ANALOG;
2464         } else if (!(hdw->input_avail_mask & (1 << PVR2_CVAL_INPUT_TV))) {
2465                 hdw->pathway_state = PVR2_PATHWAY_DIGITAL;
2466         }
2467
2468         hdw->control_cnt = CTRLDEF_COUNT;
2469         hdw->control_cnt += MPEGDEF_COUNT;
2470         hdw->controls = kzalloc(sizeof(struct pvr2_ctrl) * hdw->control_cnt,
2471                                 GFP_KERNEL);
2472         if (!hdw->controls) goto fail;
2473         hdw->hdw_desc = hdw_desc;
2474         hdw->ir_scheme_active = hdw->hdw_desc->ir_scheme;
2475         for (idx = 0; idx < hdw->control_cnt; idx++) {
2476                 cptr = hdw->controls + idx;
2477                 cptr->hdw = hdw;
2478         }
2479         for (idx = 0; idx < 32; idx++) {
2480                 hdw->std_mask_ptrs[idx] = hdw->std_mask_names[idx];
2481         }
2482         for (idx = 0; idx < CTRLDEF_COUNT; idx++) {
2483                 cptr = hdw->controls + idx;
2484                 cptr->info = control_defs+idx;
2485         }
2486
2487         /* Ensure that default input choice is a valid one. */
2488         m = hdw->input_avail_mask;
2489         if (m) for (idx = 0; idx < (sizeof(m) << 3); idx++) {
2490                 if (!((1 << idx) & m)) continue;
2491                 hdw->input_val = idx;
2492                 break;
2493         }
2494
2495         /* Define and configure additional controls from cx2341x module. */
2496         hdw->mpeg_ctrl_info = kcalloc(MPEGDEF_COUNT,
2497                                       sizeof(*(hdw->mpeg_ctrl_info)),
2498                                       GFP_KERNEL);
2499         if (!hdw->mpeg_ctrl_info) goto fail;
2500         for (idx = 0; idx < MPEGDEF_COUNT; idx++) {
2501                 cptr = hdw->controls + idx + CTRLDEF_COUNT;
2502                 ciptr = &(hdw->mpeg_ctrl_info[idx].info);
2503                 ciptr->desc = hdw->mpeg_ctrl_info[idx].desc;
2504                 ciptr->name = mpeg_ids[idx].strid;
2505                 ciptr->v4l_id = mpeg_ids[idx].id;
2506                 ciptr->skip_init = !0;
2507                 ciptr->get_value = ctrl_cx2341x_get;
2508                 ciptr->get_v4lflags = ctrl_cx2341x_getv4lflags;
2509                 ciptr->is_dirty = ctrl_cx2341x_is_dirty;
2510                 if (!idx) ciptr->clear_dirty = ctrl_cx2341x_clear_dirty;
2511                 qctrl.id = ciptr->v4l_id;
2512                 cx2341x_ctrl_query(&hdw->enc_ctl_state,&qctrl);
2513                 if (!(qctrl.flags & V4L2_CTRL_FLAG_READ_ONLY)) {
2514                         ciptr->set_value = ctrl_cx2341x_set;
2515                 }
2516                 strncpy(hdw->mpeg_ctrl_info[idx].desc,qctrl.name,
2517                         PVR2_CTLD_INFO_DESC_SIZE);
2518                 hdw->mpeg_ctrl_info[idx].desc[PVR2_CTLD_INFO_DESC_SIZE-1] = 0;
2519                 ciptr->default_value = qctrl.default_value;
2520                 switch (qctrl.type) {
2521                 default:
2522                 case V4L2_CTRL_TYPE_INTEGER:
2523                         ciptr->type = pvr2_ctl_int;
2524                         ciptr->def.type_int.min_value = qctrl.minimum;
2525                         ciptr->def.type_int.max_value = qctrl.maximum;
2526                         break;
2527                 case V4L2_CTRL_TYPE_BOOLEAN:
2528                         ciptr->type = pvr2_ctl_bool;
2529                         break;
2530                 case V4L2_CTRL_TYPE_MENU:
2531                         ciptr->type = pvr2_ctl_enum;
2532                         ciptr->def.type_enum.value_names =
2533                                 cx2341x_ctrl_get_menu(&hdw->enc_ctl_state,
2534                                                                 ciptr->v4l_id);
2535                         for (cnt1 = 0;
2536                              ciptr->def.type_enum.value_names[cnt1] != NULL;
2537                              cnt1++) { }
2538                         ciptr->def.type_enum.count = cnt1;
2539                         break;
2540                 }
2541                 cptr->info = ciptr;
2542         }
2543
2544         // Initialize control data regarding video standard masks
2545         valid_std_mask = pvr2_std_get_usable();
2546         for (idx = 0; idx < 32; idx++) {
2547                 if (!(valid_std_mask & (1 << idx))) continue;
2548                 cnt1 = pvr2_std_id_to_str(
2549                         hdw->std_mask_names[idx],
2550                         sizeof(hdw->std_mask_names[idx])-1,
2551                         1 << idx);
2552                 hdw->std_mask_names[idx][cnt1] = 0;
2553         }
2554         cptr = pvr2_hdw_get_ctrl_by_id(hdw,PVR2_CID_STDAVAIL);
2555         if (cptr) {
2556                 memcpy(&hdw->std_info_avail,cptr->info,
2557                        sizeof(hdw->std_info_avail));
2558                 cptr->info = &hdw->std_info_avail;
2559                 hdw->std_info_avail.def.type_bitmask.bit_names =
2560                         hdw->std_mask_ptrs;
2561                 hdw->std_info_avail.def.type_bitmask.valid_bits =
2562                         valid_std_mask;
2563         }
2564         cptr = pvr2_hdw_get_ctrl_by_id(hdw,PVR2_CID_STDCUR);
2565         if (cptr) {
2566                 memcpy(&hdw->std_info_cur,cptr->info,
2567                        sizeof(hdw->std_info_cur));
2568                 cptr->info = &hdw->std_info_cur;
2569                 hdw->std_info_cur.def.type_bitmask.bit_names =
2570                         hdw->std_mask_ptrs;
2571                 hdw->std_info_cur.def.type_bitmask.valid_bits =
2572                         valid_std_mask;
2573         }
2574         cptr = pvr2_hdw_get_ctrl_by_id(hdw,PVR2_CID_STDDETECT);
2575         if (cptr) {
2576                 memcpy(&hdw->std_info_detect,cptr->info,
2577                        sizeof(hdw->std_info_detect));
2578                 cptr->info = &hdw->std_info_detect;
2579                 hdw->std_info_detect.def.type_bitmask.bit_names =
2580                         hdw->std_mask_ptrs;
2581                 hdw->std_info_detect.def.type_bitmask.valid_bits =
2582                         valid_std_mask;
2583         }
2584
2585         hdw->cropcap_stale = !0;
2586         hdw->eeprom_addr = -1;
2587         hdw->unit_number = -1;
2588         hdw->v4l_minor_number_video = -1;
2589         hdw->v4l_minor_number_vbi = -1;
2590         hdw->v4l_minor_number_radio = -1;
2591         hdw->ctl_write_buffer = kmalloc(PVR2_CTL_BUFFSIZE,GFP_KERNEL);
2592         if (!hdw->ctl_write_buffer) goto fail;
2593         hdw->ctl_read_buffer = kmalloc(PVR2_CTL_BUFFSIZE,GFP_KERNEL);
2594         if (!hdw->ctl_read_buffer) goto fail;
2595         hdw->ctl_write_urb = usb_alloc_urb(0,GFP_KERNEL);
2596         if (!hdw->ctl_write_urb) goto fail;
2597         hdw->ctl_read_urb = usb_alloc_urb(0,GFP_KERNEL);
2598         if (!hdw->ctl_read_urb) goto fail;
2599
2600         if (v4l2_device_register(&intf->dev, &hdw->v4l2_dev) != 0) {
2601                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
2602                            "Error registering with v4l core, giving up");
2603                 goto fail;
2604         }
2605         mutex_lock(&pvr2_unit_mtx); do {
2606                 for (idx = 0; idx < PVR_NUM; idx++) {
2607                         if (unit_pointers[idx]) continue;
2608                         hdw->unit_number = idx;
2609                         unit_pointers[idx] = hdw;
2610                         break;
2611                 }
2612         } while (0); mutex_unlock(&pvr2_unit_mtx);
2613
2614         cnt1 = 0;
2615         cnt2 = scnprintf(hdw->name+cnt1,sizeof(hdw->name)-cnt1,"pvrusb2");
2616         cnt1 += cnt2;
2617         if (hdw->unit_number >= 0) {
2618                 cnt2 = scnprintf(hdw->name+cnt1,sizeof(hdw->name)-cnt1,"_%c",
2619                                  ('a' + hdw->unit_number));
2620                 cnt1 += cnt2;
2621         }
2622         if (cnt1 >= sizeof(hdw->name)) cnt1 = sizeof(hdw->name)-1;
2623         hdw->name[cnt1] = 0;
2624
2625         hdw->workqueue = create_singlethread_workqueue(hdw->name);
2626         INIT_WORK(&hdw->workpoll,pvr2_hdw_worker_poll);
2627
2628         pvr2_trace(PVR2_TRACE_INIT,"Driver unit number is %d, name is %s",
2629                    hdw->unit_number,hdw->name);
2630
2631         hdw->tuner_type = -1;
2632         hdw->flag_ok = !0;
2633
2634         hdw->usb_intf = intf;
2635         hdw->usb_dev = usb_dev;
2636
2637         usb_make_path(hdw->usb_dev, hdw->bus_info, sizeof(hdw->bus_info));
2638
2639         ifnum = hdw->usb_intf->cur_altsetting->desc.bInterfaceNumber;
2640         usb_set_interface(hdw->usb_dev,ifnum,0);
2641
2642         mutex_init(&hdw->ctl_lock_mutex);
2643         mutex_init(&hdw->big_lock_mutex);
2644
2645         return hdw;
2646  fail:
2647         if (hdw) {
2648                 del_timer_sync(&hdw->quiescent_timer);
2649                 del_timer_sync(&hdw->decoder_stabilization_timer);
2650                 del_timer_sync(&hdw->encoder_run_timer);
2651                 del_timer_sync(&hdw->encoder_wait_timer);
2652                 if (hdw->workqueue) {
2653                         flush_workqueue(hdw->workqueue);
2654                         destroy_workqueue(hdw->workqueue);
2655                         hdw->workqueue = NULL;
2656                 }
2657                 usb_free_urb(hdw->ctl_read_urb);
2658                 usb_free_urb(hdw->ctl_write_urb);
2659                 kfree(hdw->ctl_read_buffer);
2660                 kfree(hdw->ctl_write_buffer);
2661                 kfree(hdw->controls);
2662                 kfree(hdw->mpeg_ctrl_info);
2663                 kfree(hdw);
2664         }
2665         return NULL;
2666 }
2667
2668
2669 /* Remove _all_ associations between this driver and the underlying USB
2670    layer. */
2671 static void pvr2_hdw_remove_usb_stuff(struct pvr2_hdw *hdw)
2672 {
2673         if (hdw->flag_disconnected) return;
2674         pvr2_trace(PVR2_TRACE_INIT,"pvr2_hdw_remove_usb_stuff: hdw=%p",hdw);
2675         if (hdw->ctl_read_urb) {
2676                 usb_kill_urb(hdw->ctl_read_urb);
2677                 usb_free_urb(hdw->ctl_read_urb);
2678                 hdw->ctl_read_urb = NULL;
2679         }
2680         if (hdw->ctl_write_urb) {
2681                 usb_kill_urb(hdw->ctl_write_urb);
2682                 usb_free_urb(hdw->ctl_write_urb);
2683                 hdw->ctl_write_urb = NULL;
2684         }
2685         if (hdw->ctl_read_buffer) {
2686                 kfree(hdw->ctl_read_buffer);
2687                 hdw->ctl_read_buffer = NULL;
2688         }
2689         if (hdw->ctl_write_buffer) {
2690                 kfree(hdw->ctl_write_buffer);
2691                 hdw->ctl_write_buffer = NULL;
2692         }
2693         hdw->flag_disconnected = !0;
2694         /* If we don't do this, then there will be a dangling struct device
2695            reference to our disappearing device persisting inside the V4L
2696            core... */
2697         v4l2_device_disconnect(&hdw->v4l2_dev);
2698         hdw->usb_dev = NULL;
2699         hdw->usb_intf = NULL;
2700         pvr2_hdw_render_useless(hdw);
2701 }
2702
2703 void pvr2_hdw_set_v4l2_dev(struct pvr2_hdw *hdw, struct video_device *vdev)
2704 {
2705         vdev->v4l2_dev = &hdw->v4l2_dev;
2706 }
2707
2708 /* Destroy hardware interaction structure */
2709 void pvr2_hdw_destroy(struct pvr2_hdw *hdw)
2710 {
2711         if (!hdw) return;
2712         pvr2_trace(PVR2_TRACE_INIT,"pvr2_hdw_destroy: hdw=%p",hdw);
2713         if (hdw->workqueue) {
2714                 flush_workqueue(hdw->workqueue);
2715                 destroy_workqueue(hdw->workqueue);
2716                 hdw->workqueue = NULL;
2717         }
2718         del_timer_sync(&hdw->quiescent_timer);
2719         del_timer_sync(&hdw->decoder_stabilization_timer);
2720         del_timer_sync(&hdw->encoder_run_timer);
2721         del_timer_sync(&hdw->encoder_wait_timer);
2722         if (hdw->fw_buffer) {
2723                 kfree(hdw->fw_buffer);
2724                 hdw->fw_buffer = NULL;
2725         }
2726         if (hdw->vid_stream) {
2727                 pvr2_stream_destroy(hdw->vid_stream);
2728                 hdw->vid_stream = NULL;
2729         }
2730         pvr2_i2c_core_done(hdw);
2731         v4l2_device_unregister(&hdw->v4l2_dev);
2732         pvr2_hdw_remove_usb_stuff(hdw);
2733         mutex_lock(&pvr2_unit_mtx); do {
2734                 if ((hdw->unit_number >= 0) &&
2735                     (hdw->unit_number < PVR_NUM) &&
2736                     (unit_pointers[hdw->unit_number] == hdw)) {
2737                         unit_pointers[hdw->unit_number] = NULL;
2738                 }
2739         } while (0); mutex_unlock(&pvr2_unit_mtx);
2740         kfree(hdw->controls);
2741         kfree(hdw->mpeg_ctrl_info);
2742         kfree(hdw);
2743 }
2744
2745
2746 int pvr2_hdw_dev_ok(struct pvr2_hdw *hdw)
2747 {
2748         return (hdw && hdw->flag_ok);
2749 }
2750
2751
2752 /* Called when hardware has been unplugged */
2753 void pvr2_hdw_disconnect(struct pvr2_hdw *hdw)
2754 {
2755         pvr2_trace(PVR2_TRACE_INIT,"pvr2_hdw_disconnect(hdw=%p)",hdw);
2756         LOCK_TAKE(hdw->big_lock);
2757         LOCK_TAKE(hdw->ctl_lock);
2758         pvr2_hdw_remove_usb_stuff(hdw);
2759         LOCK_GIVE(hdw->ctl_lock);
2760         LOCK_GIVE(hdw->big_lock);
2761 }
2762
2763
2764 /* Get the number of defined controls */
2765 unsigned int pvr2_hdw_get_ctrl_count(struct pvr2_hdw *hdw)
2766 {
2767         return hdw->control_cnt;
2768 }
2769
2770
2771 /* Retrieve a control handle given its index (0..count-1) */
2772 struct pvr2_ctrl *pvr2_hdw_get_ctrl_by_index(struct pvr2_hdw *hdw,
2773                                              unsigned int idx)
2774 {
2775         if (idx >= hdw->control_cnt) return NULL;
2776         return hdw->controls + idx;
2777 }
2778
2779
2780 /* Retrieve a control handle given its index (0..count-1) */
2781 struct pvr2_ctrl *pvr2_hdw_get_ctrl_by_id(struct pvr2_hdw *hdw,
2782                                           unsigned int ctl_id)
2783 {
2784         struct pvr2_ctrl *cptr;
2785         unsigned int idx;
2786         int i;
2787
2788         /* This could be made a lot more efficient, but for now... */
2789         for (idx = 0; idx < hdw->control_cnt; idx++) {
2790                 cptr = hdw->controls + idx;
2791                 i = cptr->info->internal_id;
2792                 if (i && (i == ctl_id)) return cptr;
2793         }
2794         return NULL;
2795 }
2796
2797
2798 /* Given a V4L ID, retrieve the control structure associated with it. */
2799 struct pvr2_ctrl *pvr2_hdw_get_ctrl_v4l(struct pvr2_hdw *hdw,unsigned int ctl_id)
2800 {
2801         struct pvr2_ctrl *cptr;
2802         unsigned int idx;
2803         int i;
2804
2805         /* This could be made a lot more efficient, but for now... */
2806         for (idx = 0; idx < hdw->control_cnt; idx++) {
2807                 cptr = hdw->controls + idx;
2808                 i = cptr->info->v4l_id;
2809                 if (i && (i == ctl_id)) return cptr;
2810         }
2811         return NULL;
2812 }
2813
2814
2815 /* Given a V4L ID for its immediate predecessor, retrieve the control
2816    structure associated with it. */
2817 struct pvr2_ctrl *pvr2_hdw_get_ctrl_nextv4l(struct pvr2_hdw *hdw,
2818                                             unsigned int ctl_id)
2819 {
2820         struct pvr2_ctrl *cptr,*cp2;
2821         unsigned int idx;
2822         int i;
2823
2824         /* This could be made a lot more efficient, but for now... */
2825         cp2 = NULL;
2826         for (idx = 0; idx < hdw->control_cnt; idx++) {
2827                 cptr = hdw->controls + idx;
2828                 i = cptr->info->v4l_id;
2829                 if (!i) continue;
2830                 if (i <= ctl_id) continue;
2831                 if (cp2 && (cp2->info->v4l_id < i)) continue;
2832                 cp2 = cptr;
2833         }
2834         return cp2;
2835         return NULL;
2836 }
2837
2838
2839 static const char *get_ctrl_typename(enum pvr2_ctl_type tp)
2840 {
2841         switch (tp) {
2842         case pvr2_ctl_int: return "integer";
2843         case pvr2_ctl_enum: return "enum";
2844         case pvr2_ctl_bool: return "boolean";
2845         case pvr2_ctl_bitmask: return "bitmask";
2846         }
2847         return "";
2848 }
2849
2850
2851 static void pvr2_subdev_set_control(struct pvr2_hdw *hdw, int id,
2852                                     const char *name, int val)
2853 {
2854         struct v4l2_control ctrl;
2855         pvr2_trace(PVR2_TRACE_CHIPS, "subdev v4l2 %s=%d", name, val);
2856         memset(&ctrl, 0, sizeof(ctrl));
2857         ctrl.id = id;
2858         ctrl.value = val;
2859         v4l2_device_call_all(&hdw->v4l2_dev, 0, core, s_ctrl, &ctrl);
2860 }
2861
2862 #define PVR2_SUBDEV_SET_CONTROL(hdw, id, lab) \
2863         if ((hdw)->lab##_dirty || (hdw)->force_dirty) {         \
2864                 pvr2_subdev_set_control(hdw, id, #lab, (hdw)->lab##_val); \
2865         }
2866
2867 static v4l2_std_id pvr2_hdw_get_detected_std(struct pvr2_hdw *hdw)
2868 {
2869         v4l2_std_id std;
2870         std = (v4l2_std_id)hdw->std_mask_avail;
2871         v4l2_device_call_all(&hdw->v4l2_dev, 0,
2872                              video, querystd, &std);
2873         return std;
2874 }
2875
2876 /* Execute whatever commands are required to update the state of all the
2877    sub-devices so that they match our current control values. */
2878 static void pvr2_subdev_update(struct pvr2_hdw *hdw)
2879 {
2880         struct v4l2_subdev *sd;
2881         unsigned int id;
2882         pvr2_subdev_update_func fp;
2883
2884         pvr2_trace(PVR2_TRACE_CHIPS, "subdev update...");
2885
2886         if (hdw->tuner_updated || hdw->force_dirty) {
2887                 struct tuner_setup setup;
2888                 pvr2_trace(PVR2_TRACE_CHIPS, "subdev tuner set_type(%d)",
2889                            hdw->tuner_type);
2890                 if (((int)(hdw->tuner_type)) >= 0) {
2891                         memset(&setup, 0, sizeof(setup));
2892                         setup.addr = ADDR_UNSET;
2893                         setup.type = hdw->tuner_type;
2894                         setup.mode_mask = T_RADIO | T_ANALOG_TV;
2895                         v4l2_device_call_all(&hdw->v4l2_dev, 0,
2896                                              tuner, s_type_addr, &setup);
2897                 }
2898         }
2899
2900         if (hdw->input_dirty || hdw->std_dirty || hdw->force_dirty) {
2901                 pvr2_trace(PVR2_TRACE_CHIPS, "subdev v4l2 set_standard");
2902                 if (hdw->input_val == PVR2_CVAL_INPUT_RADIO) {
2903                         v4l2_device_call_all(&hdw->v4l2_dev, 0,
2904                                              tuner, s_radio);
2905                 } else {
2906                         v4l2_std_id vs;
2907                         vs = hdw->std_mask_cur;
2908                         v4l2_device_call_all(&hdw->v4l2_dev, 0,
2909                                              video, s_std, vs);
2910                         pvr2_hdw_cx25840_vbi_hack(hdw);
2911                 }
2912                 hdw->tuner_signal_stale = !0;
2913                 hdw->cropcap_stale = !0;
2914         }
2915
2916         PVR2_SUBDEV_SET_CONTROL(hdw, V4L2_CID_BRIGHTNESS, brightness);
2917         PVR2_SUBDEV_SET_CONTROL(hdw, V4L2_CID_CONTRAST, contrast);
2918         PVR2_SUBDEV_SET_CONTROL(hdw, V4L2_CID_SATURATION, saturation);
2919         PVR2_SUBDEV_SET_CONTROL(hdw, V4L2_CID_HUE, hue);
2920         PVR2_SUBDEV_SET_CONTROL(hdw, V4L2_CID_AUDIO_MUTE, mute);
2921         PVR2_SUBDEV_SET_CONTROL(hdw, V4L2_CID_AUDIO_VOLUME, volume);
2922         PVR2_SUBDEV_SET_CONTROL(hdw, V4L2_CID_AUDIO_BALANCE, balance);
2923         PVR2_SUBDEV_SET_CONTROL(hdw, V4L2_CID_AUDIO_BASS, bass);
2924         PVR2_SUBDEV_SET_CONTROL(hdw, V4L2_CID_AUDIO_TREBLE, treble);
2925
2926         if (hdw->input_dirty || hdw->audiomode_dirty || hdw->force_dirty) {
2927                 struct v4l2_tuner vt;
2928                 memset(&vt, 0, sizeof(vt));
2929                 vt.type = (hdw->input_val == PVR2_CVAL_INPUT_RADIO) ?
2930                         V4L2_TUNER_RADIO : V4L2_TUNER_ANALOG_TV;
2931                 vt.audmode = hdw->audiomode_val;
2932                 v4l2_device_call_all(&hdw->v4l2_dev, 0, tuner, s_tuner, &vt);
2933         }
2934
2935         if (hdw->freqDirty || hdw->force_dirty) {
2936                 unsigned long fv;
2937                 struct v4l2_frequency freq;
2938                 fv = pvr2_hdw_get_cur_freq(hdw);
2939                 pvr2_trace(PVR2_TRACE_CHIPS, "subdev v4l2 set_freq(%lu)", fv);
2940                 if (hdw->tuner_signal_stale) pvr2_hdw_status_poll(hdw);
2941                 memset(&freq, 0, sizeof(freq));
2942                 if (hdw->tuner_signal_info.capability & V4L2_TUNER_CAP_LOW) {
2943                         /* ((fv * 1000) / 62500) */
2944                         freq.frequency = (fv * 2) / 125;
2945                 } else {
2946                         freq.frequency = fv / 62500;
2947                 }
2948                 /* tuner-core currently doesn't seem to care about this, but
2949                    let's set it anyway for completeness. */
2950                 if (hdw->input_val == PVR2_CVAL_INPUT_RADIO) {
2951                         freq.type = V4L2_TUNER_RADIO;
2952                 } else {
2953                         freq.type = V4L2_TUNER_ANALOG_TV;
2954                 }
2955                 freq.tuner = 0;
2956                 v4l2_device_call_all(&hdw->v4l2_dev, 0, tuner,
2957                                      s_frequency, &freq);
2958         }
2959
2960         if (hdw->res_hor_dirty || hdw->res_ver_dirty || hdw->force_dirty) {
2961                 struct v4l2_mbus_framefmt fmt;
2962                 memset(&fmt, 0, sizeof(fmt));
2963                 fmt.width = hdw->res_hor_val;
2964                 fmt.height = hdw->res_ver_val;
2965                 fmt.code = MEDIA_BUS_FMT_FIXED;
2966                 pvr2_trace(PVR2_TRACE_CHIPS, "subdev v4l2 set_size(%dx%d)",
2967                            fmt.width, fmt.height);
2968                 v4l2_device_call_all(&hdw->v4l2_dev, 0, video, s_mbus_fmt, &fmt);
2969         }
2970
2971         if (hdw->srate_dirty || hdw->force_dirty) {
2972                 u32 val;
2973                 pvr2_trace(PVR2_TRACE_CHIPS, "subdev v4l2 set_audio %d",
2974                            hdw->srate_val);
2975                 switch (hdw->srate_val) {
2976                 default:
2977                 case V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000:
2978                         val = 48000;
2979                         break;
2980                 case V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100:
2981                         val = 44100;
2982                         break;
2983                 case V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000:
2984                         val = 32000;
2985                         break;
2986                 }
2987                 v4l2_device_call_all(&hdw->v4l2_dev, 0,
2988                                      audio, s_clock_freq, val);
2989         }
2990
2991         /* Unable to set crop parameters; there is apparently no equivalent
2992            for VIDIOC_S_CROP */
2993
2994         v4l2_device_for_each_subdev(sd, &hdw->v4l2_dev) {
2995                 id = sd->grp_id;
2996                 if (id >= ARRAY_SIZE(pvr2_module_update_functions)) continue;
2997                 fp = pvr2_module_update_functions[id];
2998                 if (!fp) continue;
2999                 (*fp)(hdw, sd);
3000         }
3001
3002         if (hdw->tuner_signal_stale || hdw->cropcap_stale) {
3003                 pvr2_hdw_status_poll(hdw);
3004         }
3005 }
3006
3007
3008 /* Figure out if we need to commit control changes.  If so, mark internal
3009    state flags to indicate this fact and return true.  Otherwise do nothing
3010    else and return false. */
3011 static int pvr2_hdw_commit_setup(struct pvr2_hdw *hdw)
3012 {
3013         unsigned int idx;
3014         struct pvr2_ctrl *cptr;
3015         int value;
3016         int commit_flag = hdw->force_dirty;
3017         char buf[100];
3018         unsigned int bcnt,ccnt;
3019
3020         for (idx = 0; idx < hdw->control_cnt; idx++) {
3021                 cptr = hdw->controls + idx;
3022                 if (!cptr->info->is_dirty) continue;
3023                 if (!cptr->info->is_dirty(cptr)) continue;
3024                 commit_flag = !0;
3025
3026                 if (!(pvrusb2_debug & PVR2_TRACE_CTL)) continue;
3027                 bcnt = scnprintf(buf,sizeof(buf),"\"%s\" <-- ",
3028                                  cptr->info->name);
3029                 value = 0;
3030                 cptr->info->get_value(cptr,&value);
3031                 pvr2_ctrl_value_to_sym_internal(cptr,~0,value,
3032                                                 buf+bcnt,
3033                                                 sizeof(buf)-bcnt,&ccnt);
3034                 bcnt += ccnt;
3035                 bcnt += scnprintf(buf+bcnt,sizeof(buf)-bcnt," <%s>",
3036                                   get_ctrl_typename(cptr->info->type));
3037                 pvr2_trace(PVR2_TRACE_CTL,
3038                            "/*--TRACE_COMMIT--*/ %.*s",
3039                            bcnt,buf);
3040         }
3041
3042         if (!commit_flag) {
3043                 /* Nothing has changed */
3044                 return 0;
3045         }
3046
3047         hdw->state_pipeline_config = 0;
3048         trace_stbit("state_pipeline_config",hdw->state_pipeline_config);
3049         pvr2_hdw_state_sched(hdw);
3050
3051         return !0;
3052 }
3053
3054
3055 /* Perform all operations needed to commit all control changes.  This must
3056    be performed in synchronization with the pipeline state and is thus
3057    expected to be called as part of the driver's worker thread.  Return
3058    true if commit successful, otherwise return false to indicate that
3059    commit isn't possible at this time. */
3060 static int pvr2_hdw_commit_execute(struct pvr2_hdw *hdw)
3061 {
3062         unsigned int idx;
3063         struct pvr2_ctrl *cptr;
3064         int disruptive_change;
3065
3066         if (hdw->input_dirty && hdw->state_pathway_ok &&
3067             (((hdw->input_val == PVR2_CVAL_INPUT_DTV) ?
3068               PVR2_PATHWAY_DIGITAL : PVR2_PATHWAY_ANALOG) !=
3069              hdw->pathway_state)) {
3070                 /* Change of mode being asked for... */
3071                 hdw->state_pathway_ok = 0;
3072                 trace_stbit("state_pathway_ok", hdw->state_pathway_ok);
3073         }
3074         if (!hdw->state_pathway_ok) {
3075                 /* Can't commit anything until pathway is ok. */
3076                 return 0;
3077         }
3078
3079         /* Handle some required side effects when the video standard is
3080            changed.... */
3081         if (hdw->std_dirty) {
3082                 int nvres;
3083                 int gop_size;
3084                 if (hdw->std_mask_cur & V4L2_STD_525_60) {
3085                         nvres = 480;
3086                         gop_size = 15;
3087                 } else {
3088                         nvres = 576;
3089                         gop_size = 12;
3090                 }
3091                 /* Rewrite the vertical resolution to be appropriate to the
3092                    video standard that has been selected. */
3093                 if (nvres != hdw->res_ver_val) {
3094                         hdw->res_ver_val = nvres;
3095                         hdw->res_ver_dirty = !0;
3096                 }
3097                 /* Rewrite the GOP size to be appropriate to the video
3098                    standard that has been selected. */
3099                 if (gop_size != hdw->enc_ctl_state.video_gop_size) {
3100                         struct v4l2_ext_controls cs;
3101                         struct v4l2_ext_control c1;
3102                         memset(&cs, 0, sizeof(cs));
3103                         memset(&c1, 0, sizeof(c1));
3104                         cs.controls = &c1;
3105                         cs.count = 1;
3106                         c1.id = V4L2_CID_MPEG_VIDEO_GOP_SIZE;
3107                         c1.value = gop_size;
3108                         cx2341x_ext_ctrls(&hdw->enc_ctl_state, 0, &cs,
3109                                           VIDIOC_S_EXT_CTRLS);
3110                 }
3111         }
3112
3113         /* The broadcast decoder can only scale down, so if
3114          * res_*_dirty && crop window < output format ==> enlarge crop.
3115          *
3116          * The mpeg encoder receives fields of res_hor_val dots and
3117          * res_ver_val halflines.  Limits: hor<=720, ver<=576.
3118          */
3119         if (hdw->res_hor_dirty && hdw->cropw_val < hdw->res_hor_val) {
3120                 hdw->cropw_val = hdw->res_hor_val;
3121                 hdw->cropw_dirty = !0;
3122         } else if (hdw->cropw_dirty) {
3123                 hdw->res_hor_dirty = !0;           /* must rescale */
3124                 hdw->res_hor_val = min(720, hdw->cropw_val);
3125         }
3126         if (hdw->res_ver_dirty && hdw->croph_val < hdw->res_ver_val) {
3127                 hdw->croph_val = hdw->res_ver_val;
3128                 hdw->croph_dirty = !0;
3129         } else if (hdw->croph_dirty) {
3130                 int nvres = hdw->std_mask_cur & V4L2_STD_525_60 ? 480 : 576;
3131                 hdw->res_ver_dirty = !0;
3132                 hdw->res_ver_val = min(nvres, hdw->croph_val);
3133         }
3134
3135         /* If any of the below has changed, then we can't do the update
3136            while the pipeline is running.  Pipeline must be paused first
3137            and decoder -> encoder connection be made quiescent before we
3138            can proceed. */
3139         disruptive_change =
3140                 (hdw->std_dirty ||
3141                  hdw->enc_unsafe_stale ||
3142                  hdw->srate_dirty ||
3143                  hdw->res_ver_dirty ||
3144                  hdw->res_hor_dirty ||
3145                  hdw->cropw_dirty ||
3146                  hdw->croph_dirty ||
3147                  hdw->input_dirty ||
3148                  (hdw->active_stream_type != hdw->desired_stream_type));
3149         if (disruptive_change && !hdw->state_pipeline_idle) {
3150                 /* Pipeline is not idle; we can't proceed.  Arrange to
3151                    cause pipeline to stop so that we can try this again
3152                    later.... */
3153                 hdw->state_pipeline_pause = !0;
3154                 return 0;
3155         }
3156
3157         if (hdw->srate_dirty) {
3158                 /* Write new sample rate into control structure since
3159                  * the master copy is stale.  We must track srate
3160                  * separate from the mpeg control structure because
3161                  * other logic also uses this value. */
3162                 struct v4l2_ext_controls cs;
3163                 struct v4l2_ext_control c1;
3164                 memset(&cs,0,sizeof(cs));
3165                 memset(&c1,0,sizeof(c1));
3166                 cs.controls = &c1;
3167                 cs.count = 1;
3168                 c1.id = V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ;
3169                 c1.value = hdw->srate_val;
3170                 cx2341x_ext_ctrls(&hdw->enc_ctl_state, 0, &cs,VIDIOC_S_EXT_CTRLS);
3171         }
3172
3173         if (hdw->active_stream_type != hdw->desired_stream_type) {
3174                 /* Handle any side effects of stream config here */
3175                 hdw->active_stream_type = hdw->desired_stream_type;
3176         }
3177
3178         if (hdw->hdw_desc->signal_routing_scheme ==
3179             PVR2_ROUTING_SCHEME_GOTVIEW) {
3180                 u32 b;
3181                 /* Handle GOTVIEW audio switching */
3182                 pvr2_hdw_gpio_get_out(hdw,&b);
3183                 if (hdw->input_val == PVR2_CVAL_INPUT_RADIO) {
3184                         /* Set GPIO 11 */
3185                         pvr2_hdw_gpio_chg_out(hdw,(1 << 11),~0);
3186                 } else {
3187                         /* Clear GPIO 11 */
3188                         pvr2_hdw_gpio_chg_out(hdw,(1 << 11),0);
3189                 }
3190         }
3191
3192         /* Check and update state for all sub-devices. */
3193         pvr2_subdev_update(hdw);
3194
3195         hdw->tuner_updated = 0;
3196         hdw->force_dirty = 0;
3197         for (idx = 0; idx < hdw->control_cnt; idx++) {
3198                 cptr = hdw->controls + idx;
3199                 if (!cptr->info->clear_dirty) continue;
3200                 cptr->info->clear_dirty(cptr);
3201         }
3202
3203         if ((hdw->pathway_state == PVR2_PATHWAY_ANALOG) &&
3204             hdw->state_encoder_run) {
3205                 /* If encoder isn't running or it can't be touched, then
3206                    this will get worked out later when we start the
3207                    encoder. */
3208                 if (pvr2_encoder_adjust(hdw) < 0) return !0;
3209         }
3210
3211         hdw->state_pipeline_config = !0;
3212         /* Hardware state may have changed in a way to cause the cropping
3213            capabilities to have changed.  So mark it stale, which will
3214            cause a later re-fetch. */
3215         trace_stbit("state_pipeline_config",hdw->state_pipeline_config);
3216         return !0;
3217 }
3218
3219
3220 int pvr2_hdw_commit_ctl(struct pvr2_hdw *hdw)
3221 {
3222         int fl;
3223         LOCK_TAKE(hdw->big_lock);
3224         fl = pvr2_hdw_commit_setup(hdw);
3225         LOCK_GIVE(hdw->big_lock);
3226         if (!fl) return 0;
3227         return pvr2_hdw_wait(hdw,0);
3228 }
3229
3230
3231 static void pvr2_hdw_worker_poll(struct work_struct *work)
3232 {
3233         int fl = 0;
3234         struct pvr2_hdw *hdw = container_of(work,struct pvr2_hdw,workpoll);
3235         LOCK_TAKE(hdw->big_lock); do {
3236                 fl = pvr2_hdw_state_eval(hdw);
3237         } while (0); LOCK_GIVE(hdw->big_lock);
3238         if (fl && hdw->state_func) {
3239                 hdw->state_func(hdw->state_data);
3240         }
3241 }
3242
3243
3244 static int pvr2_hdw_wait(struct pvr2_hdw *hdw,int state)
3245 {
3246         return wait_event_interruptible(
3247                 hdw->state_wait_data,
3248                 (hdw->state_stale == 0) &&
3249                 (!state || (hdw->master_state != state)));
3250 }
3251
3252
3253 /* Return name for this driver instance */
3254 const char *pvr2_hdw_get_driver_name(struct pvr2_hdw *hdw)
3255 {
3256         return hdw->name;
3257 }
3258
3259
3260 const char *pvr2_hdw_get_desc(struct pvr2_hdw *hdw)
3261 {
3262         return hdw->hdw_desc->description;
3263 }
3264
3265
3266 const char *pvr2_hdw_get_type(struct pvr2_hdw *hdw)
3267 {
3268         return hdw->hdw_desc->shortname;
3269 }
3270
3271
3272 int pvr2_hdw_is_hsm(struct pvr2_hdw *hdw)
3273 {
3274         int result;
3275         LOCK_TAKE(hdw->ctl_lock); do {
3276                 hdw->cmd_buffer[0] = FX2CMD_GET_USB_SPEED;
3277                 result = pvr2_send_request(hdw,
3278                                            hdw->cmd_buffer,1,
3279                                            hdw->cmd_buffer,1);
3280                 if (result < 0) break;
3281                 result = (hdw->cmd_buffer[0] != 0);
3282         } while(0); LOCK_GIVE(hdw->ctl_lock);
3283         return result;
3284 }
3285
3286
3287 /* Execute poll of tuner status */
3288 void pvr2_hdw_execute_tuner_poll(struct pvr2_hdw *hdw)
3289 {
3290         LOCK_TAKE(hdw->big_lock); do {
3291                 pvr2_hdw_status_poll(hdw);
3292         } while (0); LOCK_GIVE(hdw->big_lock);
3293 }
3294
3295
3296 static int pvr2_hdw_check_cropcap(struct pvr2_hdw *hdw)
3297 {
3298         if (!hdw->cropcap_stale) {
3299                 return 0;
3300         }
3301         pvr2_hdw_status_poll(hdw);
3302         if (hdw->cropcap_stale) {
3303                 return -EIO;
3304         }
3305         return 0;
3306 }
3307
3308
3309 /* Return information about cropping capabilities */
3310 int pvr2_hdw_get_cropcap(struct pvr2_hdw *hdw, struct v4l2_cropcap *pp)
3311 {
3312         int stat = 0;
3313         LOCK_TAKE(hdw->big_lock);
3314         stat = pvr2_hdw_check_cropcap(hdw);
3315         if (!stat) {
3316                 memcpy(pp, &hdw->cropcap_info, sizeof(hdw->cropcap_info));
3317         }
3318         LOCK_GIVE(hdw->big_lock);
3319         return stat;
3320 }
3321
3322
3323 /* Return information about the tuner */
3324 int pvr2_hdw_get_tuner_status(struct pvr2_hdw *hdw,struct v4l2_tuner *vtp)
3325 {
3326         LOCK_TAKE(hdw->big_lock); do {
3327                 if (hdw->tuner_signal_stale) {
3328                         pvr2_hdw_status_poll(hdw);
3329                 }
3330                 memcpy(vtp,&hdw->tuner_signal_info,sizeof(struct v4l2_tuner));
3331         } while (0); LOCK_GIVE(hdw->big_lock);
3332         return 0;
3333 }
3334
3335
3336 /* Get handle to video output stream */
3337 struct pvr2_stream *pvr2_hdw_get_video_stream(struct pvr2_hdw *hp)
3338 {
3339         return hp->vid_stream;
3340 }
3341
3342
3343 void pvr2_hdw_trigger_module_log(struct pvr2_hdw *hdw)
3344 {
3345         int nr = pvr2_hdw_get_unit_number(hdw);
3346         LOCK_TAKE(hdw->big_lock); do {
3347                 printk(KERN_INFO "pvrusb2: =================  START STATUS CARD #%d  =================\n", nr);
3348                 v4l2_device_call_all(&hdw->v4l2_dev, 0, core, log_status);
3349                 pvr2_trace(PVR2_TRACE_INFO,"cx2341x config:");
3350                 cx2341x_log_status(&hdw->enc_ctl_state, "pvrusb2");
3351                 pvr2_hdw_state_log_state(hdw);
3352                 printk(KERN_INFO "pvrusb2: ==================  END STATUS CARD #%d  ==================\n", nr);
3353         } while (0); LOCK_GIVE(hdw->big_lock);
3354 }
3355
3356
3357 /* Grab EEPROM contents, needed for direct method. */
3358 #define EEPROM_SIZE 8192
3359 #define trace_eeprom(...) pvr2_trace(PVR2_TRACE_EEPROM,__VA_ARGS__)
3360 static u8 *pvr2_full_eeprom_fetch(struct pvr2_hdw *hdw)
3361 {
3362         struct i2c_msg msg[2];
3363         u8 *eeprom;
3364         u8 iadd[2];
3365         u8 addr;
3366         u16 eepromSize;
3367         unsigned int offs;
3368         int ret;
3369         int mode16 = 0;
3370         unsigned pcnt,tcnt;
3371         eeprom = kmalloc(EEPROM_SIZE,GFP_KERNEL);
3372         if (!eeprom) {
3373                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3374                            "Failed to allocate memory"
3375                            " required to read eeprom");
3376                 return NULL;
3377         }
3378
3379         trace_eeprom("Value for eeprom addr from controller was 0x%x",
3380                      hdw->eeprom_addr);
3381         addr = hdw->eeprom_addr;
3382         /* Seems that if the high bit is set, then the *real* eeprom
3383            address is shifted right now bit position (noticed this in
3384            newer PVR USB2 hardware) */
3385         if (addr & 0x80) addr >>= 1;
3386
3387         /* FX2 documentation states that a 16bit-addressed eeprom is
3388            expected if the I2C address is an odd number (yeah, this is
3389            strange but it's what they do) */
3390         mode16 = (addr & 1);
3391         eepromSize = (mode16 ? EEPROM_SIZE : 256);
3392         trace_eeprom("Examining %d byte eeprom at location 0x%x"
3393                      " using %d bit addressing",eepromSize,addr,
3394                      mode16 ? 16 : 8);
3395
3396         msg[0].addr = addr;
3397         msg[0].flags = 0;
3398         msg[0].len = mode16 ? 2 : 1;
3399         msg[0].buf = iadd;
3400         msg[1].addr = addr;
3401         msg[1].flags = I2C_M_RD;
3402
3403         /* We have to do the actual eeprom data fetch ourselves, because
3404            (1) we're only fetching part of the eeprom, and (2) if we were
3405            getting the whole thing our I2C driver can't grab it in one
3406            pass - which is what tveeprom is otherwise going to attempt */
3407         memset(eeprom,0,EEPROM_SIZE);
3408         for (tcnt = 0; tcnt < EEPROM_SIZE; tcnt += pcnt) {
3409                 pcnt = 16;
3410                 if (pcnt + tcnt > EEPROM_SIZE) pcnt = EEPROM_SIZE-tcnt;
3411                 offs = tcnt + (eepromSize - EEPROM_SIZE);
3412                 if (mode16) {
3413                         iadd[0] = offs >> 8;
3414                         iadd[1] = offs;
3415                 } else {
3416                         iadd[0] = offs;
3417                 }
3418                 msg[1].len = pcnt;
3419                 msg[1].buf = eeprom+tcnt;
3420                 if ((ret = i2c_transfer(&hdw->i2c_adap,
3421                                         msg,ARRAY_SIZE(msg))) != 2) {
3422                         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3423                                    "eeprom fetch set offs err=%d",ret);
3424                         kfree(eeprom);
3425                         return NULL;
3426                 }
3427         }
3428         return eeprom;
3429 }
3430
3431
3432 void pvr2_hdw_cpufw_set_enabled(struct pvr2_hdw *hdw,
3433                                 int mode,
3434                                 int enable_flag)
3435 {
3436         int ret;
3437         u16 address;
3438         unsigned int pipe;
3439         LOCK_TAKE(hdw->big_lock); do {
3440                 if ((hdw->fw_buffer == NULL) == !enable_flag) break;
3441
3442                 if (!enable_flag) {
3443                         pvr2_trace(PVR2_TRACE_FIRMWARE,
3444                                    "Cleaning up after CPU firmware fetch");
3445                         kfree(hdw->fw_buffer);
3446                         hdw->fw_buffer = NULL;
3447                         hdw->fw_size = 0;
3448                         if (hdw->fw_cpu_flag) {
3449                                 /* Now release the CPU.  It will disconnect
3450                                    and reconnect later. */
3451                                 pvr2_hdw_cpureset_assert(hdw,0);
3452                         }
3453                         break;
3454                 }
3455
3456                 hdw->fw_cpu_flag = (mode != 2);
3457                 if (hdw->fw_cpu_flag) {
3458                         hdw->fw_size = (mode == 1) ? 0x4000 : 0x2000;
3459                         pvr2_trace(PVR2_TRACE_FIRMWARE,
3460                                    "Preparing to suck out CPU firmware"
3461                                    " (size=%u)", hdw->fw_size);
3462                         hdw->fw_buffer = kzalloc(hdw->fw_size,GFP_KERNEL);
3463                         if (!hdw->fw_buffer) {
3464                                 hdw->fw_size = 0;
3465                                 break;
3466                         }
3467
3468                         /* We have to hold the CPU during firmware upload. */
3469                         pvr2_hdw_cpureset_assert(hdw,1);
3470
3471                         /* download the firmware from address 0000-1fff in 2048
3472                            (=0x800) bytes chunk. */
3473
3474                         pvr2_trace(PVR2_TRACE_FIRMWARE,
3475                                    "Grabbing CPU firmware");
3476                         pipe = usb_rcvctrlpipe(hdw->usb_dev, 0);
3477                         for(address = 0; address < hdw->fw_size;
3478                             address += 0x800) {
3479                                 ret = usb_control_msg(hdw->usb_dev,pipe,
3480                                                       0xa0,0xc0,
3481                                                       address,0,
3482                                                       hdw->fw_buffer+address,
3483                                                       0x800,HZ);
3484                                 if (ret < 0) break;
3485                         }
3486
3487                         pvr2_trace(PVR2_TRACE_FIRMWARE,
3488                                    "Done grabbing CPU firmware");
3489                 } else {
3490                         pvr2_trace(PVR2_TRACE_FIRMWARE,
3491                                    "Sucking down EEPROM contents");
3492                         hdw->fw_buffer = pvr2_full_eeprom_fetch(hdw);
3493                         if (!hdw->fw_buffer) {
3494                                 pvr2_trace(PVR2_TRACE_FIRMWARE,
3495                                            "EEPROM content suck failed.");
3496                                 break;
3497                         }
3498                         hdw->fw_size = EEPROM_SIZE;
3499                         pvr2_trace(PVR2_TRACE_FIRMWARE,
3500                                    "Done sucking down EEPROM contents");
3501                 }
3502
3503         } while (0); LOCK_GIVE(hdw->big_lock);
3504 }
3505
3506
3507 /* Return true if we're in a mode for retrieval CPU firmware */
3508 int pvr2_hdw_cpufw_get_enabled(struct pvr2_hdw *hdw)
3509 {
3510         return hdw->fw_buffer != NULL;
3511 }
3512
3513
3514 int pvr2_hdw_cpufw_get(struct pvr2_hdw *hdw,unsigned int offs,
3515                        char *buf,unsigned int cnt)
3516 {
3517         int ret = -EINVAL;
3518         LOCK_TAKE(hdw->big_lock); do {
3519                 if (!buf) break;
3520                 if (!cnt) break;
3521
3522                 if (!hdw->fw_buffer) {
3523                         ret = -EIO;
3524                         break;
3525                 }
3526
3527                 if (offs >= hdw->fw_size) {
3528                         pvr2_trace(PVR2_TRACE_FIRMWARE,
3529                                    "Read firmware data offs=%d EOF",
3530                                    offs);
3531                         ret = 0;
3532                         break;
3533                 }
3534
3535                 if (offs + cnt > hdw->fw_size) cnt = hdw->fw_size - offs;
3536
3537                 memcpy(buf,hdw->fw_buffer+offs,cnt);
3538
3539                 pvr2_trace(PVR2_TRACE_FIRMWARE,
3540                            "Read firmware data offs=%d cnt=%d",
3541                            offs,cnt);
3542                 ret = cnt;
3543         } while (0); LOCK_GIVE(hdw->big_lock);
3544
3545         return ret;
3546 }
3547
3548
3549 int pvr2_hdw_v4l_get_minor_number(struct pvr2_hdw *hdw,
3550                                   enum pvr2_v4l_type index)
3551 {
3552         switch (index) {
3553         case pvr2_v4l_type_video: return hdw->v4l_minor_number_video;
3554         case pvr2_v4l_type_vbi: return hdw->v4l_minor_number_vbi;
3555         case pvr2_v4l_type_radio: return hdw->v4l_minor_number_radio;
3556         default: return -1;
3557         }
3558 }
3559
3560
3561 /* Store a v4l minor device number */
3562 void pvr2_hdw_v4l_store_minor_number(struct pvr2_hdw *hdw,
3563                                      enum pvr2_v4l_type index,int v)
3564 {
3565         switch (index) {
3566         case pvr2_v4l_type_video: hdw->v4l_minor_number_video = v;break;
3567         case pvr2_v4l_type_vbi: hdw->v4l_minor_number_vbi = v;break;
3568         case pvr2_v4l_type_radio: hdw->v4l_minor_number_radio = v;break;
3569         default: break;
3570         }
3571 }
3572
3573
3574 static void pvr2_ctl_write_complete(struct urb *urb)
3575 {
3576         struct pvr2_hdw *hdw = urb->context;
3577         hdw->ctl_write_pend_flag = 0;
3578         if (hdw->ctl_read_pend_flag) return;
3579         complete(&hdw->ctl_done);
3580 }
3581
3582
3583 static void pvr2_ctl_read_complete(struct urb *urb)
3584 {
3585         struct pvr2_hdw *hdw = urb->context;
3586         hdw->ctl_read_pend_flag = 0;
3587         if (hdw->ctl_write_pend_flag) return;
3588         complete(&hdw->ctl_done);
3589 }
3590
3591
3592 static void pvr2_ctl_timeout(unsigned long data)
3593 {
3594         struct pvr2_hdw *hdw = (struct pvr2_hdw *)data;
3595         if (hdw->ctl_write_pend_flag || hdw->ctl_read_pend_flag) {
3596                 hdw->ctl_timeout_flag = !0;
3597                 if (hdw->ctl_write_pend_flag)
3598                         usb_unlink_urb(hdw->ctl_write_urb);
3599                 if (hdw->ctl_read_pend_flag)
3600                         usb_unlink_urb(hdw->ctl_read_urb);
3601         }
3602 }
3603
3604
3605 /* Issue a command and get a response from the device.  This extended
3606    version includes a probe flag (which if set means that device errors
3607    should not be logged or treated as fatal) and a timeout in jiffies.
3608    This can be used to non-lethally probe the health of endpoint 1. */
3609 static int pvr2_send_request_ex(struct pvr2_hdw *hdw,
3610                                 unsigned int timeout,int probe_fl,
3611                                 void *write_data,unsigned int write_len,
3612                                 void *read_data,unsigned int read_len)
3613 {
3614         unsigned int idx;
3615         int status = 0;
3616         struct timer_list timer;
3617         if (!hdw->ctl_lock_held) {
3618                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3619                            "Attempted to execute control transfer"
3620                            " without lock!!");
3621                 return -EDEADLK;
3622         }
3623         if (!hdw->flag_ok && !probe_fl) {
3624                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3625                            "Attempted to execute control transfer"
3626                            " when device not ok");
3627                 return -EIO;
3628         }
3629         if (!(hdw->ctl_read_urb && hdw->ctl_write_urb)) {
3630                 if (!probe_fl) {
3631                         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3632                                    "Attempted to execute control transfer"
3633                                    " when USB is disconnected");
3634                 }
3635                 return -ENOTTY;
3636         }
3637
3638         /* Ensure that we have sane parameters */
3639         if (!write_data) write_len = 0;
3640         if (!read_data) read_len = 0;
3641         if (write_len > PVR2_CTL_BUFFSIZE) {
3642                 pvr2_trace(
3643                         PVR2_TRACE_ERROR_LEGS,
3644                         "Attempted to execute %d byte"
3645                         " control-write transfer (limit=%d)",
3646                         write_len,PVR2_CTL_BUFFSIZE);
3647                 return -EINVAL;
3648         }
3649         if (read_len > PVR2_CTL_BUFFSIZE) {
3650                 pvr2_trace(
3651                         PVR2_TRACE_ERROR_LEGS,
3652                         "Attempted to execute %d byte"
3653                         " control-read transfer (limit=%d)",
3654                         write_len,PVR2_CTL_BUFFSIZE);
3655                 return -EINVAL;
3656         }
3657         if ((!write_len) && (!read_len)) {
3658                 pvr2_trace(
3659                         PVR2_TRACE_ERROR_LEGS,
3660                         "Attempted to execute null control transfer?");
3661                 return -EINVAL;
3662         }
3663
3664
3665         hdw->cmd_debug_state = 1;
3666         if (write_len) {
3667                 hdw->cmd_debug_code = ((unsigned char *)write_data)[0];
3668         } else {
3669                 hdw->cmd_debug_code = 0;
3670         }
3671         hdw->cmd_debug_write_len = write_len;
3672         hdw->cmd_debug_read_len = read_len;
3673
3674         /* Initialize common stuff */
3675         init_completion(&hdw->ctl_done);
3676         hdw->ctl_timeout_flag = 0;
3677         hdw->ctl_write_pend_flag = 0;
3678         hdw->ctl_read_pend_flag = 0;
3679         setup_timer(&timer, pvr2_ctl_timeout, (unsigned long)hdw);
3680         timer.expires = jiffies + timeout;
3681
3682         if (write_len) {
3683                 hdw->cmd_debug_state = 2;
3684                 /* Transfer write data to internal buffer */
3685                 for (idx = 0; idx < write_len; idx++) {
3686                         hdw->ctl_write_buffer[idx] =
3687                                 ((unsigned char *)write_data)[idx];
3688                 }
3689                 /* Initiate a write request */
3690                 usb_fill_bulk_urb(hdw->ctl_write_urb,
3691                                   hdw->usb_dev,
3692                                   usb_sndbulkpipe(hdw->usb_dev,
3693                                                   PVR2_CTL_WRITE_ENDPOINT),
3694                                   hdw->ctl_write_buffer,
3695                                   write_len,
3696                                   pvr2_ctl_write_complete,
3697                                   hdw);
3698                 hdw->ctl_write_urb->actual_length = 0;
3699                 hdw->ctl_write_pend_flag = !0;
3700                 status = usb_submit_urb(hdw->ctl_write_urb,GFP_KERNEL);
3701                 if (status < 0) {
3702                         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3703                                    "Failed to submit write-control"
3704                                    " URB status=%d",status);
3705                         hdw->ctl_write_pend_flag = 0;
3706                         goto done;
3707                 }
3708         }
3709
3710         if (read_len) {
3711                 hdw->cmd_debug_state = 3;
3712                 memset(hdw->ctl_read_buffer,0x43,read_len);
3713                 /* Initiate a read request */
3714                 usb_fill_bulk_urb(hdw->ctl_read_urb,
3715                                   hdw->usb_dev,
3716                                   usb_rcvbulkpipe(hdw->usb_dev,
3717                                                   PVR2_CTL_READ_ENDPOINT),
3718                                   hdw->ctl_read_buffer,
3719                                   read_len,
3720                                   pvr2_ctl_read_complete,
3721                                   hdw);
3722                 hdw->ctl_read_urb->actual_length = 0;
3723                 hdw->ctl_read_pend_flag = !0;
3724                 status = usb_submit_urb(hdw->ctl_read_urb,GFP_KERNEL);
3725                 if (status < 0) {
3726                         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3727                                    "Failed to submit read-control"
3728                                    " URB status=%d",status);
3729                         hdw->ctl_read_pend_flag = 0;
3730                         goto done;
3731                 }
3732         }
3733
3734         /* Start timer */
3735         add_timer(&timer);
3736
3737         /* Now wait for all I/O to complete */
3738         hdw->cmd_debug_state = 4;
3739         while (hdw->ctl_write_pend_flag || hdw->ctl_read_pend_flag) {
3740                 wait_for_completion(&hdw->ctl_done);
3741         }
3742         hdw->cmd_debug_state = 5;
3743
3744         /* Stop timer */
3745         del_timer_sync(&timer);
3746
3747         hdw->cmd_debug_state = 6;
3748         status = 0;
3749
3750         if (hdw->ctl_timeout_flag) {
3751                 status = -ETIMEDOUT;
3752                 if (!probe_fl) {
3753                         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3754                                    "Timed out control-write");
3755                 }
3756                 goto done;
3757         }
3758
3759         if (write_len) {
3760                 /* Validate results of write request */
3761                 if ((hdw->ctl_write_urb->status != 0) &&
3762                     (hdw->ctl_write_urb->status != -ENOENT) &&
3763                     (hdw->ctl_write_urb->status != -ESHUTDOWN) &&
3764                     (hdw->ctl_write_urb->status != -ECONNRESET)) {
3765                         /* USB subsystem is reporting some kind of failure
3766                            on the write */
3767                         status = hdw->ctl_write_urb->status;
3768                         if (!probe_fl) {
3769                                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3770                                            "control-write URB failure,"
3771                                            " status=%d",
3772                                            status);
3773                         }
3774                         goto done;
3775                 }
3776                 if (hdw->ctl_write_urb->actual_length < write_len) {
3777                         /* Failed to write enough data */
3778                         status = -EIO;
3779                         if (!probe_fl) {
3780                                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3781                                            "control-write URB short,"
3782                                            " expected=%d got=%d",
3783                                            write_len,
3784                                            hdw->ctl_write_urb->actual_length);
3785                         }
3786                         goto done;
3787                 }
3788         }
3789         if (read_len) {
3790                 /* Validate results of read request */
3791                 if ((hdw->ctl_read_urb->status != 0) &&
3792                     (hdw->ctl_read_urb->status != -ENOENT) &&
3793                     (hdw->ctl_read_urb->status != -ESHUTDOWN) &&
3794                     (hdw->ctl_read_urb->status != -ECONNRESET)) {
3795                         /* USB subsystem is reporting some kind of failure
3796                            on the read */
3797                         status = hdw->ctl_read_urb->status;
3798                         if (!probe_fl) {
3799                                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3800                                            "control-read URB failure,"
3801                                            " status=%d",
3802                                            status);
3803                         }
3804                         goto done;
3805                 }
3806                 if (hdw->ctl_read_urb->actual_length < read_len) {
3807                         /* Failed to read enough data */
3808                         status = -EIO;
3809                         if (!probe_fl) {
3810                                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3811                                            "control-read URB short,"
3812                                            " expected=%d got=%d",
3813                                            read_len,
3814                                            hdw->ctl_read_urb->actual_length);
3815                         }
3816                         goto done;
3817                 }
3818                 /* Transfer retrieved data out from internal buffer */
3819                 for (idx = 0; idx < read_len; idx++) {
3820                         ((unsigned char *)read_data)[idx] =
3821                                 hdw->ctl_read_buffer[idx];
3822                 }
3823         }
3824
3825  done:
3826
3827         hdw->cmd_debug_state = 0;
3828         if ((status < 0) && (!probe_fl)) {
3829                 pvr2_hdw_render_useless(hdw);
3830         }
3831         return status;
3832 }
3833
3834
3835 int pvr2_send_request(struct pvr2_hdw *hdw,
3836                       void *write_data,unsigned int write_len,
3837                       void *read_data,unsigned int read_len)
3838 {
3839         return pvr2_send_request_ex(hdw,HZ*4,0,
3840                                     write_data,write_len,
3841                                     read_data,read_len);
3842 }
3843
3844
3845 static int pvr2_issue_simple_cmd(struct pvr2_hdw *hdw,u32 cmdcode)
3846 {
3847         int ret;
3848         unsigned int cnt = 1;
3849         unsigned int args = 0;
3850         LOCK_TAKE(hdw->ctl_lock);
3851         hdw->cmd_buffer[0] = cmdcode & 0xffu;
3852         args = (cmdcode >> 8) & 0xffu;
3853         args = (args > 2) ? 2 : args;
3854         if (args) {
3855                 cnt += args;
3856                 hdw->cmd_buffer[1] = (cmdcode >> 16) & 0xffu;
3857                 if (args > 1) {
3858                         hdw->cmd_buffer[2] = (cmdcode >> 24) & 0xffu;
3859                 }
3860         }
3861         if (pvrusb2_debug & PVR2_TRACE_INIT) {
3862                 unsigned int idx;
3863                 unsigned int ccnt,bcnt;
3864                 char tbuf[50];
3865                 cmdcode &= 0xffu;
3866                 bcnt = 0;
3867                 ccnt = scnprintf(tbuf+bcnt,
3868                                  sizeof(tbuf)-bcnt,
3869                                  "Sending FX2 command 0x%x",cmdcode);
3870                 bcnt += ccnt;
3871                 for (idx = 0; idx < ARRAY_SIZE(pvr2_fx2cmd_desc); idx++) {
3872                         if (pvr2_fx2cmd_desc[idx].id == cmdcode) {
3873                                 ccnt = scnprintf(tbuf+bcnt,
3874                                                  sizeof(tbuf)-bcnt,
3875                                                  " \"%s\"",
3876                                                  pvr2_fx2cmd_desc[idx].desc);
3877                                 bcnt += ccnt;
3878                                 break;
3879                         }
3880                 }
3881                 if (args) {
3882                         ccnt = scnprintf(tbuf+bcnt,
3883                                          sizeof(tbuf)-bcnt,
3884                                          " (%u",hdw->cmd_buffer[1]);
3885                         bcnt += ccnt;
3886                         if (args > 1) {
3887                                 ccnt = scnprintf(tbuf+bcnt,
3888                                                  sizeof(tbuf)-bcnt,
3889                                                  ",%u",hdw->cmd_buffer[2]);
3890                                 bcnt += ccnt;
3891                         }
3892                         ccnt = scnprintf(tbuf+bcnt,
3893                                          sizeof(tbuf)-bcnt,
3894                                          ")");
3895                         bcnt += ccnt;
3896                 }
3897                 pvr2_trace(PVR2_TRACE_INIT,"%.*s",bcnt,tbuf);
3898         }
3899         ret = pvr2_send_request(hdw,hdw->cmd_buffer,cnt,NULL,0);
3900         LOCK_GIVE(hdw->ctl_lock);
3901         return ret;
3902 }
3903
3904
3905 int pvr2_write_register(struct pvr2_hdw *hdw, u16 reg, u32 data)
3906 {
3907         int ret;
3908
3909         LOCK_TAKE(hdw->ctl_lock);
3910
3911         hdw->cmd_buffer[0] = FX2CMD_REG_WRITE;  /* write register prefix */
3912         PVR2_DECOMPOSE_LE(hdw->cmd_buffer,1,data);
3913         hdw->cmd_buffer[5] = 0;
3914         hdw->cmd_buffer[6] = (reg >> 8) & 0xff;
3915         hdw->cmd_buffer[7] = reg & 0xff;
3916
3917
3918         ret = pvr2_send_request(hdw, hdw->cmd_buffer, 8, hdw->cmd_buffer, 0);
3919
3920         LOCK_GIVE(hdw->ctl_lock);
3921
3922         return ret;
3923 }
3924
3925
3926 static int pvr2_read_register(struct pvr2_hdw *hdw, u16 reg, u32 *data)
3927 {
3928         int ret = 0;
3929
3930         LOCK_TAKE(hdw->ctl_lock);
3931
3932         hdw->cmd_buffer[0] = FX2CMD_REG_READ;  /* read register prefix */
3933         hdw->cmd_buffer[1] = 0;
3934         hdw->cmd_buffer[2] = 0;
3935         hdw->cmd_buffer[3] = 0;
3936         hdw->cmd_buffer[4] = 0;
3937         hdw->cmd_buffer[5] = 0;
3938         hdw->cmd_buffer[6] = (reg >> 8) & 0xff;
3939         hdw->cmd_buffer[7] = reg & 0xff;
3940
3941         ret |= pvr2_send_request(hdw, hdw->cmd_buffer, 8, hdw->cmd_buffer, 4);
3942         *data = PVR2_COMPOSE_LE(hdw->cmd_buffer,0);
3943
3944         LOCK_GIVE(hdw->ctl_lock);
3945
3946         return ret;
3947 }
3948
3949
3950 void pvr2_hdw_render_useless(struct pvr2_hdw *hdw)
3951 {
3952         if (!hdw->flag_ok) return;
3953         pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3954                    "Device being rendered inoperable");
3955         if (hdw->vid_stream) {
3956                 pvr2_stream_setup(hdw->vid_stream,NULL,0,0);
3957         }
3958         hdw->flag_ok = 0;
3959         trace_stbit("flag_ok",hdw->flag_ok);
3960         pvr2_hdw_state_sched(hdw);
3961 }
3962
3963
3964 void pvr2_hdw_device_reset(struct pvr2_hdw *hdw)
3965 {
3966         int ret;
3967         pvr2_trace(PVR2_TRACE_INIT,"Performing a device reset...");
3968         ret = usb_lock_device_for_reset(hdw->usb_dev,NULL);
3969         if (ret == 0) {
3970                 ret = usb_reset_device(hdw->usb_dev);
3971                 usb_unlock_device(hdw->usb_dev);
3972         } else {
3973                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3974                            "Failed to lock USB device ret=%d",ret);
3975         }
3976         if (init_pause_msec) {
3977                 pvr2_trace(PVR2_TRACE_INFO,
3978                            "Waiting %u msec for hardware to settle",
3979                            init_pause_msec);
3980                 msleep(init_pause_msec);
3981         }
3982
3983 }
3984
3985
3986 void pvr2_hdw_cpureset_assert(struct pvr2_hdw *hdw,int val)
3987 {
3988         char *da;
3989         unsigned int pipe;
3990         int ret;
3991
3992         if (!hdw->usb_dev) return;
3993
3994         da = kmalloc(16, GFP_KERNEL);
3995
3996         if (da == NULL) {
3997                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
3998                            "Unable to allocate memory to control CPU reset");
3999                 return;
4000         }
4001
4002         pvr2_trace(PVR2_TRACE_INIT,"cpureset_assert(%d)",val);
4003
4004         da[0] = val ? 0x01 : 0x00;
4005
4006         /* Write the CPUCS register on the 8051.  The lsb of the register
4007            is the reset bit; a 1 asserts reset while a 0 clears it. */
4008         pipe = usb_sndctrlpipe(hdw->usb_dev, 0);
4009         ret = usb_control_msg(hdw->usb_dev,pipe,0xa0,0x40,0xe600,0,da,1,HZ);
4010         if (ret < 0) {
4011                 pvr2_trace(PVR2_TRACE_ERROR_LEGS,
4012                            "cpureset_assert(%d) error=%d",val,ret);
4013                 pvr2_hdw_render_useless(hdw);
4014         }
4015
4016         kfree(da);
4017 }
4018
4019
4020 int pvr2_hdw_cmd_deep_reset(struct pvr2_hdw *hdw)
4021 {
4022         return pvr2_issue_simple_cmd(hdw,FX2CMD_DEEP_RESET);
4023 }
4024
4025
4026 int pvr2_hdw_cmd_powerup(struct pvr2_hdw *hdw)
4027 {
4028         return pvr2_issue_simple_cmd(hdw,FX2CMD_POWER_ON);
4029 }
4030
4031
4032
4033 int pvr2_hdw_cmd_decoder_reset(struct pvr2_hdw *hdw)
4034 {
4035         pvr2_trace(PVR2_TRACE_INIT,
4036                    "Requesting decoder reset");
4037         if (hdw->decoder_client_id) {
4038                 v4l2_device_call_all(&hdw->v4l2_dev, hdw->decoder_client_id,
4039                                      core, reset, 0);
4040                 pvr2_hdw_cx25840_vbi_hack(hdw);
4041                 return 0;
4042         }
4043         pvr2_trace(PVR2_TRACE_INIT,
4044                    "Unable to reset decoder: nothing attached");
4045         return -ENOTTY;
4046 }
4047
4048
4049 static int pvr2_hdw_cmd_hcw_demod_reset(struct pvr2_hdw *hdw, int onoff)
4050 {
4051         hdw->flag_ok = !0;
4052         return pvr2_issue_simple_cmd(hdw,
4053                                      FX2CMD_HCW_DEMOD_RESETIN |
4054                                      (1 << 8) |
4055                                      ((onoff ? 1 : 0) << 16));
4056 }
4057
4058
4059 static int pvr2_hdw_cmd_onair_fe_power_ctrl(struct pvr2_hdw *hdw, int onoff)
4060 {
4061         hdw->flag_ok = !0;
4062         return pvr2_issue_simple_cmd(hdw,(onoff ?
4063                                           FX2CMD_ONAIR_DTV_POWER_ON :
4064                                           FX2CMD_ONAIR_DTV_POWER_OFF));
4065 }
4066
4067
4068 static int pvr2_hdw_cmd_onair_digital_path_ctrl(struct pvr2_hdw *hdw,
4069                                                 int onoff)
4070 {
4071         return pvr2_issue_simple_cmd(hdw,(onoff ?
4072                                           FX2CMD_ONAIR_DTV_STREAMING_ON :
4073                                           FX2CMD_ONAIR_DTV_STREAMING_OFF));
4074 }
4075
4076
4077 static void pvr2_hdw_cmd_modeswitch(struct pvr2_hdw *hdw,int digitalFl)
4078 {
4079         int cmode;
4080         /* Compare digital/analog desired setting with current setting.  If
4081            they don't match, fix it... */
4082         cmode = (digitalFl ? PVR2_PATHWAY_DIGITAL : PVR2_PATHWAY_ANALOG);
4083         if (cmode == hdw->pathway_state) {
4084                 /* They match; nothing to do */
4085                 return;
4086         }
4087
4088         switch (hdw->hdw_desc->digital_control_scheme) {
4089         case PVR2_DIGITAL_SCHEME_HAUPPAUGE:
4090                 pvr2_hdw_cmd_hcw_demod_reset(hdw,digitalFl);
4091                 if (cmode == PVR2_PATHWAY_ANALOG) {
4092                         /* If moving to analog mode, also force the decoder
4093                            to reset.  If no decoder is attached, then it's
4094                            ok to ignore this because if/when the decoder
4095                            attaches, it will reset itself at that time. */
4096                         pvr2_hdw_cmd_decoder_reset(hdw);
4097                 }
4098                 break;
4099         case PVR2_DIGITAL_SCHEME_ONAIR:
4100                 /* Supposedly we should always have the power on whether in
4101                    digital or analog mode.  But for now do what appears to
4102                    work... */
4103                 pvr2_hdw_cmd_onair_fe_power_ctrl(hdw,digitalFl);
4104                 break;
4105         default: break;
4106         }
4107
4108         pvr2_hdw_untrip_unlocked(hdw);
4109         hdw->pathway_state = cmode;
4110 }
4111
4112
4113 static void pvr2_led_ctrl_hauppauge(struct pvr2_hdw *hdw, int onoff)
4114 {
4115         /* change some GPIO data
4116          *
4117          * note: bit d7 of dir appears to control the LED,
4118          * so we shut it off here.
4119          *
4120          */
4121         if (onoff) {
4122                 pvr2_hdw_gpio_chg_dir(hdw, 0xffffffff, 0x00000481);
4123         } else {
4124                 pvr2_hdw_gpio_chg_dir(hdw, 0xffffffff, 0x00000401);
4125         }
4126         pvr2_hdw_gpio_chg_out(hdw, 0xffffffff, 0x00000000);
4127 }
4128
4129
4130 typedef void (*led_method_func)(struct pvr2_hdw *,int);
4131
4132 static led_method_func led_methods[] = {
4133         [PVR2_LED_SCHEME_HAUPPAUGE] = pvr2_led_ctrl_hauppauge,
4134 };
4135
4136
4137 /* Toggle LED */
4138 static void pvr2_led_ctrl(struct pvr2_hdw *hdw,int onoff)
4139 {
4140         unsigned int scheme_id;
4141         led_method_func fp;
4142
4143         if ((!onoff) == (!hdw->led_on)) return;
4144
4145         hdw->led_on = onoff != 0;
4146
4147         scheme_id = hdw->hdw_desc->led_scheme;
4148         if (scheme_id < ARRAY_SIZE(led_methods)) {
4149                 fp = led_methods[scheme_id];
4150         } else {
4151                 fp = NULL;
4152         }
4153
4154         if (fp) (*fp)(hdw,onoff);
4155 }
4156
4157
4158 /* Stop / start video stream transport */
4159 static int pvr2_hdw_cmd_usbstream(struct pvr2_hdw *hdw,int runFl)
4160 {
4161         int ret;
4162
4163         /* If we're in analog mode, then just issue the usual analog
4164            command. */
4165         if (hdw->pathway_state == PVR2_PATHWAY_ANALOG) {
4166                 return pvr2_issue_simple_cmd(hdw,
4167                                              (runFl ?
4168                                               FX2CMD_STREAMING_ON :
4169                                               FX2CMD_STREAMING_OFF));
4170                 /*Note: Not reached */
4171         }
4172
4173         if (hdw->pathway_state != PVR2_PATHWAY_DIGITAL) {
4174                 /* Whoops, we don't know what mode we're in... */
4175                 return -EINVAL;
4176         }
4177
4178         /* To get here we have to be in digital mode.  The mechanism here
4179            is unfortunately different for different vendors.  So we switch
4180            on the device's digital scheme attribute in order to figure out
4181            what to do. */
4182         switch (hdw->hdw_desc->digital_control_scheme) {
4183         case PVR2_DIGITAL_SCHEME_HAUPPAUGE:
4184                 return pvr2_issue_simple_cmd(hdw,
4185                                              (runFl ?
4186                                               FX2CMD_HCW_DTV_STREAMING_ON :
4187                                               FX2CMD_HCW_DTV_STREAMING_OFF));
4188         case PVR2_DIGITAL_SCHEME_ONAIR:
4189                 ret = pvr2_issue_simple_cmd(hdw,
4190                                             (runFl ?
4191                                              FX2CMD_STREAMING_ON :
4192                                              FX2CMD_STREAMING_OFF));
4193                 if (ret) return ret;
4194                 return pvr2_hdw_cmd_onair_digital_path_ctrl(hdw,runFl);
4195         default:
4196                 return -EINVAL;
4197         }
4198 }
4199
4200
4201 /* Evaluate whether or not state_pathway_ok can change */
4202 static int state_eval_pathway_ok(struct pvr2_hdw *hdw)
4203 {
4204         if (hdw->state_pathway_ok) {
4205                 /* Nothing to do if pathway is already ok */
4206                 return 0;
4207         }
4208         if (!hdw->state_pipeline_idle) {
4209                 /* Not allowed to change anything if pipeline is not idle */
4210                 return 0;
4211         }
4212         pvr2_hdw_cmd_modeswitch(hdw,hdw->input_val == PVR2_CVAL_INPUT_DTV);
4213         hdw->state_pathway_ok = !0;
4214         trace_stbit("state_pathway_ok",hdw->state_pathway_ok);
4215         return !0;
4216 }
4217
4218
4219 /* Evaluate whether or not state_encoder_ok can change */
4220 static int state_eval_encoder_ok(struct pvr2_hdw *hdw)
4221 {
4222         if (hdw->state_encoder_ok) return 0;
4223         if (hdw->flag_tripped) return 0;
4224         if (hdw->state_encoder_run) return 0;
4225         if (hdw->state_encoder_config) return 0;
4226         if (hdw->state_decoder_run) return 0;
4227         if (hdw->state_usbstream_run) return 0;
4228         if (hdw->pathway_state == PVR2_PATHWAY_DIGITAL) {
4229                 if (!hdw->hdw_desc->flag_digital_requires_cx23416) return 0;
4230         } else if (hdw->pathway_state != PVR2_PATHWAY_ANALOG) {
4231                 return 0;
4232         }
4233
4234         if (pvr2_upload_firmware2(hdw) < 0) {
4235                 hdw->flag_tripped = !0;
4236                 trace_stbit("flag_tripped",hdw->flag_tripped);
4237                 return !0;
4238         }
4239         hdw->state_encoder_ok = !0;
4240         trace_stbit("state_encoder_ok",hdw->state_encoder_ok);
4241         return !0;
4242 }
4243
4244
4245 /* Evaluate whether or not state_encoder_config can change */
4246 static int state_eval_encoder_config(struct pvr2_hdw *hdw)
4247 {
4248         if (hdw->state_encoder_config) {
4249                 if (hdw->state_encoder_ok) {
4250                         if (hdw->state_pipeline_req &&
4251                             !hdw->state_pipeline_pause) return 0;
4252                 }
4253                 hdw->state_encoder_config = 0;
4254                 hdw->state_encoder_waitok = 0;
4255                 trace_stbit("state_encoder_waitok",hdw->state_encoder_waitok);
4256                 /* paranoia - solve race if timer just completed */
4257                 del_timer_sync(&hdw->encoder_wait_timer);
4258         } else {
4259                 if (!hdw->state_pathway_ok ||
4260                     (hdw->pathway_state != PVR2_PATHWAY_ANALOG) ||
4261                     !hdw->state_encoder_ok ||
4262                     !hdw->state_pipeline_idle ||
4263                     hdw->state_pipeline_pause ||
4264                     !hdw->state_pipeline_req ||
4265                     !hdw->state_pipeline_config) {
4266                         /* We must reset the enforced wait interval if
4267                            anything has happened that might have disturbed
4268                            the encoder.  This should be a rare case. */
4269                         if (timer_pending(&hdw->encoder_wait_timer)) {
4270                                 del_timer_sync(&hdw->encoder_wait_timer);
4271                         }
4272                         if (hdw->state_encoder_waitok) {
4273                                 /* Must clear the state - therefore we did
4274                                    something to a state bit and must also
4275                                    return true. */
4276                                 hdw->state_encoder_waitok = 0;
4277                                 trace_stbit("state_encoder_waitok",
4278                                             hdw->state_encoder_waitok);
4279                                 return !0;
4280                         }
4281                         return 0;
4282                 }
4283                 if (!hdw->state_encoder_waitok) {
4284                         if (!timer_pending(&hdw->encoder_wait_timer)) {
4285                                 /* waitok flag wasn't set and timer isn't
4286                                    running.  Check flag once more to avoid
4287                                    a race then start the timer.  This is
4288                                    the point when we measure out a minimal
4289                                    quiet interval before doing something to
4290                                    the encoder. */
4291                                 if (!hdw->state_encoder_waitok) {
4292                                         hdw->encoder_wait_timer.expires =
4293                                                 jiffies + msecs_to_jiffies(
4294                                                 TIME_MSEC_ENCODER_WAIT);
4295                                         add_timer(&hdw->encoder_wait_timer);
4296                                 }
4297                         }
4298                         /* We can't continue until we know we have been
4299                            quiet for the interval measured by this
4300                            timer. */
4301                         return 0;
4302                 }
4303                 pvr2_encoder_configure(hdw);
4304                 if (hdw->state_encoder_ok) hdw->state_encoder_config = !0;
4305         }
4306         trace_stbit("state_encoder_config",hdw->state_encoder_config);
4307         return !0;
4308 }
4309
4310
4311 /* Return true if the encoder should not be running. */
4312 static int state_check_disable_encoder_run(struct pvr2_hdw *hdw)
4313 {
4314         if (!hdw->state_encoder_ok) {
4315                 /* Encoder isn't healthy at the moment, so stop it. */
4316                 return !0;
4317         }
4318         if (!hdw->state_pathway_ok) {
4319                 /* Mode is not understood at the moment (i.e. it wants to
4320                    change), so encoder must be stopped. */
4321                 return !0;
4322         }
4323
4324         switch (hdw->pathway_state) {
4325         case PVR2_PATHWAY_ANALOG:
4326                 if (!hdw->state_decoder_run) {
4327                         /* We're in analog mode and the decoder is not
4328                            running; thus the encoder should be stopped as
4329                            well. */
4330                         return !0;
4331                 }
4332                 break;
4333         case PVR2_PATHWAY_DIGITAL:
4334                 if (hdw->state_encoder_runok) {
4335                         /* This is a funny case.  We're in digital mode so
4336                            really the encoder should be stopped.  However
4337                            if it really is running, only kill it after
4338                            runok has been set.  This gives a chance for the
4339                            onair quirk to function (encoder must run
4340                            briefly first, at least once, before onair
4341                            digital streaming can work). */
4342                         return !0;
4343                 }
4344                 break;
4345         default:
4346                 /* Unknown mode; so encoder should be stopped. */
4347                 return !0;
4348         }
4349
4350         /* If we get here, we haven't found a reason to stop the
4351            encoder. */
4352         return 0;
4353 }
4354
4355
4356 /* Return true if the encoder should be running. */
4357 static int state_check_enable_encoder_run(struct pvr2_hdw *hdw)
4358 {
4359         if (!hdw->state_encoder_ok) {
4360                 /* Don't run the encoder if it isn't healthy... */
4361                 return 0;
4362         }
4363         if (!hdw->state_pathway_ok) {
4364                 /* Don't run the encoder if we don't (yet) know what mode
4365                    we need to be in... */
4366                 return 0;
4367         }
4368
4369         switch (hdw->pathway_state) {
4370         case PVR2_PATHWAY_ANALOG:
4371                 if (hdw->state_decoder_run && hdw->state_decoder_ready) {
4372                         /* In analog mode, if the decoder is running, then
4373                            run the encoder. */
4374                         return !0;
4375                 }
4376                 break;
4377         case PVR2_PATHWAY_DIGITAL:
4378                 if ((hdw->hdw_desc->digital_control_scheme ==
4379                      PVR2_DIGITAL_SCHEME_ONAIR) &&
4380                     !hdw->state_encoder_runok) {
4381                         /* This is a quirk.  OnAir hardware won't stream
4382                            digital until the encoder has been run at least
4383                            once, for a minimal period of time (empiricially
4384                            measured to be 1/4 second).  So if we're on
4385                            OnAir hardware and the encoder has never been
4386                            run at all, then start the encoder.  Normal
4387                            state machine logic in the driver will
4388                            automatically handle the remaining bits. */
4389                         return !0;
4390                 }
4391                 break;
4392         default:
4393                 /* For completeness (unknown mode; encoder won't run ever) */
4394                 break;
4395         }
4396         /* If we get here, then we haven't found any reason to run the
4397            encoder, so don't run it. */
4398         return 0;
4399 }
4400
4401
4402 /* Evaluate whether or not state_encoder_run can change */
4403 static int state_eval_encoder_run(struct pvr2_hdw *hdw)
4404 {
4405         if (hdw->state_encoder_run) {
4406                 if (!state_check_disable_encoder_run(hdw)) return 0;
4407                 if (hdw->state_encoder_ok) {
4408                         del_timer_sync(&hdw->encoder_run_timer);
4409                         if (pvr2_encoder_stop(hdw) < 0) return !0;
4410                 }
4411                 hdw->state_encoder_run = 0;
4412         } else {
4413                 if (!state_check_enable_encoder_run(hdw)) return 0;
4414                 if (pvr2_encoder_start(hdw) < 0) return !0;
4415                 hdw->state_encoder_run = !0;
4416                 if (!hdw->state_encoder_runok) {
4417                         hdw->encoder_run_timer.expires = jiffies +
4418                                  msecs_to_jiffies(TIME_MSEC_ENCODER_OK);
4419                         add_timer(&hdw->encoder_run_timer);
4420                 }
4421         }
4422         trace_stbit("state_encoder_run",hdw->state_encoder_run);
4423         return !0;
4424 }
4425
4426
4427 /* Timeout function for quiescent timer. */
4428 static void pvr2_hdw_quiescent_timeout(unsigned long data)
4429 {
4430         struct pvr2_hdw *hdw = (struct pvr2_hdw *)data;
4431         hdw->state_decoder_quiescent = !0;
4432         trace_stbit("state_decoder_quiescent",hdw->state_decoder_quiescent);
4433         hdw->state_stale = !0;
4434         queue_work(hdw->workqueue,&hdw->workpoll);
4435 }
4436
4437
4438 /* Timeout function for decoder stabilization timer. */
4439 static void pvr2_hdw_decoder_stabilization_timeout(unsigned long data)
4440 {
4441         struct pvr2_hdw *hdw = (struct pvr2_hdw *)data;
4442         hdw->state_decoder_ready = !0;
4443         trace_stbit("state_decoder_ready", hdw->state_decoder_ready);
4444         hdw->state_stale = !0;
4445         queue_work(hdw->workqueue, &hdw->workpoll);
4446 }
4447
4448
4449 /* Timeout function for encoder wait timer. */
4450 static void pvr2_hdw_encoder_wait_timeout(unsigned long data)
4451 {
4452         struct pvr2_hdw *hdw = (struct pvr2_hdw *)data;
4453         hdw->state_encoder_waitok = !0;
4454         trace_stbit("state_encoder_waitok",hdw->state_encoder_waitok);
4455         hdw->state_stale = !0;
4456         queue_work(hdw->workqueue,&hdw->workpoll);
4457 }
4458
4459
4460 /* Timeout function for encoder run timer. */
4461 static void pvr2_hdw_encoder_run_timeout(unsigned long data)
4462 {
4463         struct pvr2_hdw *hdw = (struct pvr2_hdw *)data;
4464         if (!hdw->state_encoder_runok) {
4465                 hdw->state_encoder_runok = !0;
4466                 trace_stbit("state_encoder_runok",hdw->state_encoder_runok);
4467                 hdw->state_stale = !0;
4468                 queue_work(hdw->workqueue,&hdw->workpoll);
4469         }
4470 }
4471
4472
4473 /* Evaluate whether or not state_decoder_run can change */
4474 static int state_eval_decoder_run(struct pvr2_hdw *hdw)
4475 {
4476         if (hdw->state_decoder_run) {
4477                 if (hdw->state_encoder_ok) {
4478                         if (hdw->state_pipeline_req &&
4479                             !hdw->state_pipeline_pause &&
4480                             hdw->state_pathway_ok) return 0;
4481                 }
4482                 if (!hdw->flag_decoder_missed) {
4483                         pvr2_decoder_enable(hdw,0);
4484                 }
4485                 hdw->state_decoder_quiescent = 0;
4486                 hdw->state_decoder_run = 0;
4487                 /* paranoia - solve race if timer(s) just completed */
4488                 del_timer_sync(&hdw->quiescent_timer);
4489                 /* Kill the stabilization timer, in case we're killing the
4490                    encoder before the previous stabilization interval has
4491                    been properly timed. */
4492                 del_timer_sync(&hdw->decoder_stabilization_timer);
4493                 hdw->state_decoder_ready = 0;
4494         } else {
4495                 if (!hdw->state_decoder_quiescent) {
4496                         if (!timer_pending(&hdw->quiescent_timer)) {
4497                                 /* We don't do something about the
4498                                    quiescent timer until right here because
4499                                    we also want to catch cases where the
4500                                    decoder was already not running (like
4501                                    after initialization) as opposed to
4502                                    knowing that we had just stopped it.
4503                                    The second flag check is here to cover a
4504                                    race - the timer could have run and set
4505                                    this flag just after the previous check
4506                                    but before we did the pending check. */
4507                                 if (!hdw->state_decoder_quiescent) {
4508                                         hdw->quiescent_timer.expires =
4509                                                 jiffies + msecs_to_jiffies(
4510                                                 TIME_MSEC_DECODER_WAIT);
4511                                         add_timer(&hdw->quiescent_timer);
4512                                 }
4513                         }
4514                         /* Don't allow decoder to start again until it has
4515                            been quiesced first.  This little detail should
4516                            hopefully further stabilize the encoder. */
4517                         return 0;
4518                 }
4519                 if (!hdw->state_pathway_ok ||
4520                     (hdw->pathway_state != PVR2_PATHWAY_ANALOG) ||
4521                     !hdw->state_pipeline_req ||
4522                     hdw->state_pipeline_pause ||
4523                     !hdw->state_pipeline_config ||
4524                     !hdw->state_encoder_config ||
4525                     !hdw->state_encoder_ok) return 0;
4526                 del_timer_sync(&hdw->quiescent_timer);
4527                 if (hdw->flag_decoder_missed) return 0;
4528                 if (pvr2_decoder_enable(hdw,!0) < 0) return 0;
4529                 hdw->state_decoder_quiescent = 0;
4530                 hdw->state_decoder_ready = 0;
4531                 hdw->state_decoder_run = !0;
4532                 if (hdw->decoder_client_id == PVR2_CLIENT_ID_SAA7115) {
4533                         hdw->decoder_stabilization_timer.expires =
4534                                 jiffies + msecs_to_jiffies(
4535                                 TIME_MSEC_DECODER_STABILIZATION_WAIT);
4536                         add_timer(&hdw->decoder_stabilization_timer);
4537                 } else {
4538                         hdw->state_decoder_ready = !0;
4539                 }
4540         }
4541         trace_stbit("state_decoder_quiescent",hdw->state_decoder_quiescent);
4542         trace_stbit("state_decoder_run",hdw->state_decoder_run);
4543         trace_stbit("state_decoder_ready", hdw->state_decoder_ready);
4544         return !0;
4545 }
4546
4547
4548 /* Evaluate whether or not state_usbstream_run can change */
4549 static int state_eval_usbstream_run(struct pvr2_hdw *hdw)
4550 {
4551         if (hdw->state_usbstream_run) {
4552                 int fl = !0;
4553                 if (hdw->pathway_state == PVR2_PATHWAY_ANALOG) {
4554                         fl = (hdw->state_encoder_ok &&
4555                               hdw->state_encoder_run);
4556                 } else if ((hdw->pathway_state == PVR2_PATHWAY_DIGITAL) &&
4557                            (hdw->hdw_desc->flag_digital_requires_cx23416)) {
4558                         fl = hdw->state_encoder_ok;
4559                 }
4560                 if (fl &&
4561                     hdw->state_pipeline_req &&
4562                     !hdw->state_pipeline_pause &&
4563                     hdw->state_pathway_ok) {
4564                         return 0;
4565                 }
4566                 pvr2_hdw_cmd_usbstream(hdw,0);
4567                 hdw->state_usbstream_run = 0;
4568         } else {
4569                 if (!hdw->state_pipeline_req ||
4570                     hdw->state_pipeline_pause ||
4571                     !hdw->state_pathway_ok) return 0;
4572                 if (hdw->pathway_state == PVR2_PATHWAY_ANALOG) {
4573                         if (!hdw->state_encoder_ok ||
4574                             !hdw->state_encoder_run) return 0;
4575                 } else if ((hdw->pathway_state == PVR2_PATHWAY_DIGITAL) &&
4576                            (hdw->hdw_desc->flag_digital_requires_cx23416)) {
4577                         if (!hdw->state_encoder_ok) return 0;
4578                         if (hdw->state_encoder_run) return 0;
4579                         if (hdw->hdw_desc->digital_control_scheme ==
4580                             PVR2_DIGITAL_SCHEME_ONAIR) {
4581                                 /* OnAir digital receivers won't stream
4582                                    unless the analog encoder has run first.
4583                                    Why?  I have no idea.  But don't even
4584                                    try until we know the analog side is
4585                                    known to have run. */
4586                                 if (!hdw->state_encoder_runok) return 0;
4587                         }
4588                 }
4589                 if (pvr2_hdw_cmd_usbstream(hdw,!0) < 0) return 0;
4590                 hdw->state_usbstream_run = !0;
4591         }
4592         trace_stbit("state_usbstream_run",hdw->state_usbstream_run);
4593         return !0;
4594 }
4595
4596
4597 /* Attempt to configure pipeline, if needed */
4598 static int state_eval_pipeline_config(struct pvr2_hdw *hdw)
4599 {
4600         if (hdw->state_pipeline_config ||
4601             hdw->state_pipeline_pause) return 0;
4602         pvr2_hdw_commit_execute(hdw);
4603         return !0;
4604 }
4605
4606
4607 /* Update pipeline idle and pipeline pause tracking states based on other
4608    inputs.  This must be called whenever the other relevant inputs have
4609    changed. */
4610 static int state_update_pipeline_state(struct pvr2_hdw *hdw)
4611 {
4612         unsigned int st;
4613         int updatedFl = 0;
4614         /* Update pipeline state */
4615         st = !(hdw->state_encoder_run ||
4616                hdw->state_decoder_run ||
4617                hdw->state_usbstream_run ||
4618                (!hdw->state_decoder_quiescent));
4619         if (!st != !hdw->state_pipeline_idle) {
4620                 hdw->state_pipeline_idle = st;
4621                 updatedFl = !0;
4622         }
4623         if (hdw->state_pipeline_idle && hdw->state_pipeline_pause) {
4624                 hdw->state_pipeline_pause = 0;
4625                 updatedFl = !0;
4626         }
4627         return updatedFl;
4628 }
4629
4630
4631 typedef int (*state_eval_func)(struct pvr2_hdw *);
4632
4633 /* Set of functions to be run to evaluate various states in the driver. */
4634 static const state_eval_func eval_funcs[] = {
4635         state_eval_pathway_ok,
4636         state_eval_pipeline_config,
4637         state_eval_encoder_ok,
4638         state_eval_encoder_config,
4639         state_eval_decoder_run,
4640         state_eval_encoder_run,
4641         state_eval_usbstream_run,
4642 };
4643
4644
4645 /* Process various states and return true if we did anything interesting. */
4646 static int pvr2_hdw_state_update(struct pvr2_hdw *hdw)
4647 {
4648         unsigned int i;
4649         int state_updated = 0;
4650         int check_flag;
4651
4652         if (!hdw->state_stale) return 0;
4653         if ((hdw->fw1_state != FW1_STATE_OK) ||
4654             !hdw->flag_ok) {
4655                 hdw->state_stale = 0;
4656                 return !0;
4657         }
4658         /* This loop is the heart of the entire driver.  It keeps trying to
4659            evaluate various bits of driver state until nothing changes for
4660            one full iteration.  Each "bit of state" tracks some global
4661            aspect of the driver, e.g. whether decoder should run, if
4662            pipeline is configured, usb streaming is on, etc.  We separately
4663            evaluate each of those questions based on other driver state to
4664            arrive at the correct running configuration. */
4665         do {
4666                 check_flag = 0;
4667                 state_update_pipeline_state(hdw);
4668                 /* Iterate over each bit of state */
4669                 for (i = 0; (i<ARRAY_SIZE(eval_funcs)) && hdw->flag_ok; i++) {
4670                         if ((*eval_funcs[i])(hdw)) {
4671                                 check_flag = !0;
4672                                 state_updated = !0;
4673                                 state_update_pipeline_state(hdw);
4674                         }
4675                 }
4676         } while (check_flag && hdw->flag_ok);
4677         hdw->state_stale = 0;
4678         trace_stbit("state_stale",hdw->state_stale);
4679         return state_updated;
4680 }
4681
4682
4683 static unsigned int print_input_mask(unsigned int msk,
4684                                      char *buf,unsigned int acnt)
4685 {
4686         unsigned int idx,ccnt;
4687         unsigned int tcnt = 0;
4688         for (idx = 0; idx < ARRAY_SIZE(control_values_input); idx++) {
4689                 if (!((1 << idx) & msk)) continue;
4690                 ccnt = scnprintf(buf+tcnt,
4691                                  acnt-tcnt,
4692                                  "%s%s",
4693                                  (tcnt ? ", " : ""),
4694                                  control_values_input[idx]);
4695                 tcnt += ccnt;
4696         }
4697         return tcnt;
4698 }
4699
4700
4701 static const char *pvr2_pathway_state_name(int id)
4702 {
4703         switch (id) {
4704         case PVR2_PATHWAY_ANALOG: return "analog";
4705         case PVR2_PATHWAY_DIGITAL: return "digital";
4706         default: return "unknown";
4707         }
4708 }
4709
4710
4711 static unsigned int pvr2_hdw_report_unlocked(struct pvr2_hdw *hdw,int which,
4712                                              char *buf,unsigned int acnt)
4713 {
4714         switch (which) {
4715         case 0:
4716                 return scnprintf(
4717                         buf,acnt,
4718                         "driver:%s%s%s%s%s <mode=%s>",
4719                         (hdw->flag_ok ? " <ok>" : " <fail>"),
4720                         (hdw->flag_init_ok ? " <init>" : " <uninitialized>"),
4721                         (hdw->flag_disconnected ? " <disconnected>" :
4722                          " <connected>"),
4723                         (hdw->flag_tripped ? " <tripped>" : ""),
4724                         (hdw->flag_decoder_missed ? " <no decoder>" : ""),
4725                         pvr2_pathway_state_name(hdw->pathway_state));
4726
4727         case 1:
4728                 return scnprintf(
4729                         buf,acnt,
4730                         "pipeline:%s%s%s%s",
4731                         (hdw->state_pipeline_idle ? " <idle>" : ""),
4732                         (hdw->state_pipeline_config ?
4733                          " <configok>" : " <stale>"),
4734                         (hdw->state_pipeline_req ? " <req>" : ""),
4735                         (hdw->state_pipeline_pause ? " <pause>" : ""));
4736         case 2:
4737                 return scnprintf(
4738                         buf,acnt,
4739                         "worker:%s%s%s%s%s%s%s",
4740                         (hdw->state_decoder_run ?
4741                          (hdw->state_decoder_ready ?
4742                           "<decode:run>" : " <decode:start>") :
4743                          (hdw->state_decoder_quiescent ?
4744                           "" : " <decode:stop>")),
4745                         (hdw->state_decoder_quiescent ?
4746                          " <decode:quiescent>" : ""),
4747                         (hdw->state_encoder_ok ?
4748                          "" : " <encode:init>"),
4749                         (hdw->state_encoder_run ?
4750                          (hdw->state_encoder_runok ?
4751                           " <encode:run>" :
4752                           " <encode:firstrun>") :
4753                          (hdw->state_encoder_runok ?
4754                           " <encode:stop>" :
4755                           " <encode:virgin>")),
4756                         (hdw->state_encoder_config ?
4757                          " <encode:configok>" :
4758                          (hdw->state_encoder_waitok ?
4759                           "" : " <encode:waitok>")),
4760                         (hdw->state_usbstream_run ?
4761                          " <usb:run>" : " <usb:stop>"),
4762                         (hdw->state_pathway_ok ?
4763                          " <pathway:ok>" : ""));
4764         case 3:
4765                 return scnprintf(
4766                         buf,acnt,
4767                         "state: %s",
4768                         pvr2_get_state_name(hdw->master_state));
4769         case 4: {
4770                 unsigned int tcnt = 0;
4771                 unsigned int ccnt;
4772
4773                 ccnt = scnprintf(buf,
4774                                  acnt,
4775                                  "Hardware supported inputs: ");
4776                 tcnt += ccnt;
4777                 tcnt += print_input_mask(hdw->input_avail_mask,
4778                                          buf+tcnt,
4779                                          acnt-tcnt);
4780                 if (hdw->input_avail_mask != hdw->input_allowed_mask) {
4781                         ccnt = scnprintf(buf+tcnt,
4782                                          acnt-tcnt,
4783                                          "; allowed inputs: ");
4784                         tcnt += ccnt;
4785                         tcnt += print_input_mask(hdw->input_allowed_mask,
4786                                                  buf+tcnt,
4787                                                  acnt-tcnt);
4788                 }
4789                 return tcnt;
4790         }
4791         case 5: {
4792                 struct pvr2_stream_stats stats;
4793                 if (!hdw->vid_stream) break;
4794                 pvr2_stream_get_stats(hdw->vid_stream,
4795                                       &stats,
4796                                       0);
4797                 return scnprintf(
4798                         buf,acnt,
4799                         "Bytes streamed=%u"
4800                         " URBs: queued=%u idle=%u ready=%u"
4801                         " processed=%u failed=%u",
4802                         stats.bytes_processed,
4803                         stats.buffers_in_queue,
4804                         stats.buffers_in_idle,
4805                         stats.buffers_in_ready,
4806                         stats.buffers_processed,
4807                         stats.buffers_failed);
4808         }
4809         case 6: {
4810                 unsigned int id = hdw->ir_scheme_active;
4811                 return scnprintf(buf, acnt, "ir scheme: id=%d %s", id,
4812                                  (id >= ARRAY_SIZE(ir_scheme_names) ?
4813                                   "?" : ir_scheme_names[id]));
4814         }
4815         default: break;
4816         }
4817         return 0;
4818 }
4819
4820
4821 /* Generate report containing info about attached sub-devices and attached
4822    i2c clients, including an indication of which attached i2c clients are
4823    actually sub-devices. */
4824 static unsigned int pvr2_hdw_report_clients(struct pvr2_hdw *hdw,
4825                                             char *buf, unsigned int acnt)
4826 {
4827         struct v4l2_subdev *sd;
4828         unsigned int tcnt = 0;
4829         unsigned int ccnt;
4830         struct i2c_client *client;
4831         const char *p;
4832         unsigned int id;
4833
4834         ccnt = scnprintf(buf, acnt, "Associated v4l2-subdev drivers and I2C clients:\n");
4835         tcnt += ccnt;
4836         v4l2_device_for_each_subdev(sd, &hdw->v4l2_dev) {
4837                 id = sd->grp_id;
4838                 p = NULL;
4839                 if (id < ARRAY_SIZE(module_names)) p = module_names[id];
4840                 if (p) {
4841                         ccnt = scnprintf(buf + tcnt, acnt - tcnt, "  %s:", p);
4842                         tcnt += ccnt;
4843                 } else {
4844                         ccnt = scnprintf(buf + tcnt, acnt - tcnt,
4845                                          "  (unknown id=%u):", id);
4846                         tcnt += ccnt;
4847                 }
4848                 client = v4l2_get_subdevdata(sd);
4849                 if (client) {
4850                         ccnt = scnprintf(buf + tcnt, acnt - tcnt,
4851                                          " %s @ %02x\n", client->name,
4852                                          client->addr);
4853                         tcnt += ccnt;
4854                 } else {
4855                         ccnt = scnprintf(buf + tcnt, acnt - tcnt,
4856                                          " no i2c client\n");
4857                         tcnt += ccnt;
4858                 }
4859         }
4860         return tcnt;
4861 }
4862
4863
4864 unsigned int pvr2_hdw_state_report(struct pvr2_hdw *hdw,
4865                                    char *buf,unsigned int acnt)
4866 {
4867         unsigned int bcnt,ccnt,idx;
4868         bcnt = 0;
4869         LOCK_TAKE(hdw->big_lock);
4870         for (idx = 0; ; idx++) {
4871                 ccnt = pvr2_hdw_report_unlocked(hdw,idx,buf,acnt);
4872                 if (!ccnt) break;
4873                 bcnt += ccnt; acnt -= ccnt; buf += ccnt;
4874                 if (!acnt) break;
4875                 buf[0] = '\n'; ccnt = 1;
4876                 bcnt += ccnt; acnt -= ccnt; buf += ccnt;
4877         }
4878         ccnt = pvr2_hdw_report_clients(hdw, buf, acnt);
4879         bcnt += ccnt; acnt -= ccnt; buf += ccnt;
4880         LOCK_GIVE(hdw->big_lock);
4881         return bcnt;
4882 }
4883
4884
4885 static void pvr2_hdw_state_log_state(struct pvr2_hdw *hdw)
4886 {
4887         char buf[256];
4888         unsigned int idx, ccnt;
4889         unsigned int lcnt, ucnt;
4890
4891         for (idx = 0; ; idx++) {
4892                 ccnt = pvr2_hdw_report_unlocked(hdw,idx,buf,sizeof(buf));
4893                 if (!ccnt) break;
4894                 printk(KERN_INFO "%s %.*s\n",hdw->name,ccnt,buf);
4895         }
4896         ccnt = pvr2_hdw_report_clients(hdw, buf, sizeof(buf));
4897         ucnt = 0;
4898         while (ucnt < ccnt) {
4899                 lcnt = 0;
4900                 while ((lcnt + ucnt < ccnt) && (buf[lcnt + ucnt] != '\n')) {
4901                         lcnt++;
4902                 }
4903                 printk(KERN_INFO "%s %.*s\n", hdw->name, lcnt, buf + ucnt);
4904                 ucnt += lcnt + 1;
4905         }
4906 }
4907
4908
4909 /* Evaluate and update the driver's current state, taking various actions
4910    as appropriate for the update. */
4911 static int pvr2_hdw_state_eval(struct pvr2_hdw *hdw)
4912 {
4913         unsigned int st;
4914         int state_updated = 0;
4915         int callback_flag = 0;
4916         int analog_mode;
4917
4918         pvr2_trace(PVR2_TRACE_STBITS,
4919                    "Drive state check START");
4920         if (pvrusb2_debug & PVR2_TRACE_STBITS) {
4921                 pvr2_hdw_state_log_state(hdw);
4922         }
4923
4924         /* Process all state and get back over disposition */
4925         state_updated = pvr2_hdw_state_update(hdw);
4926
4927         analog_mode = (hdw->pathway_state != PVR2_PATHWAY_DIGITAL);
4928
4929         /* Update master state based upon all other states. */
4930         if (!hdw->flag_ok) {
4931                 st = PVR2_STATE_DEAD;
4932         } else if (hdw->fw1_state != FW1_STATE_OK) {
4933                 st = PVR2_STATE_COLD;
4934         } else if ((analog_mode ||
4935                     hdw->hdw_desc->flag_digital_requires_cx23416) &&
4936                    !hdw->state_encoder_ok) {
4937                 st = PVR2_STATE_WARM;
4938         } else if (hdw->flag_tripped ||
4939                    (analog_mode && hdw->flag_decoder_missed)) {
4940                 st = PVR2_STATE_ERROR;
4941         } else if (hdw->state_usbstream_run &&
4942                    (!analog_mode ||
4943                     (hdw->state_encoder_run && hdw->state_decoder_run))) {
4944                 st = PVR2_STATE_RUN;
4945         } else {
4946                 st = PVR2_STATE_READY;
4947         }
4948         if (hdw->master_state != st) {
4949                 pvr2_trace(PVR2_TRACE_STATE,
4950                            "Device state change from %s to %s",
4951                            pvr2_get_state_name(hdw->master_state),
4952                            pvr2_get_state_name(st));
4953                 pvr2_led_ctrl(hdw,st == PVR2_STATE_RUN);
4954                 hdw->master_state = st;
4955                 state_updated = !0;
4956                 callback_flag = !0;
4957         }
4958         if (state_updated) {
4959                 /* Trigger anyone waiting on any state changes here. */
4960                 wake_up(&hdw->state_wait_data);
4961         }
4962
4963         if (pvrusb2_debug & PVR2_TRACE_STBITS) {
4964                 pvr2_hdw_state_log_state(hdw);
4965         }
4966         pvr2_trace(PVR2_TRACE_STBITS,
4967                    "Drive state check DONE callback=%d",callback_flag);
4968
4969         return callback_flag;
4970 }
4971
4972
4973 /* Cause kernel thread to check / update driver state */
4974 static void pvr2_hdw_state_sched(struct pvr2_hdw *hdw)
4975 {
4976         if (hdw->state_stale) return;
4977         hdw->state_stale = !0;
4978         trace_stbit("state_stale",hdw->state_stale);
4979         queue_work(hdw->workqueue,&hdw->workpoll);
4980 }
4981
4982
4983 int pvr2_hdw_gpio_get_dir(struct pvr2_hdw *hdw,u32 *dp)
4984 {
4985         return pvr2_read_register(hdw,PVR2_GPIO_DIR,dp);
4986 }
4987
4988
4989 int pvr2_hdw_gpio_get_out(struct pvr2_hdw *hdw,u32 *dp)
4990 {
4991         return pvr2_read_register(hdw,PVR2_GPIO_OUT,dp);
4992 }
4993
4994
4995 int pvr2_hdw_gpio_get_in(struct pvr2_hdw *hdw,u32 *dp)
4996 {
4997         return pvr2_read_register(hdw,PVR2_GPIO_IN,dp);
4998 }
4999
5000
5001 int pvr2_hdw_gpio_chg_dir(struct pvr2_hdw *hdw,u32 msk,u32 val)
5002 {
5003         u32 cval,nval;
5004         int ret;
5005         if (~msk) {
5006                 ret = pvr2_read_register(hdw,PVR2_GPIO_DIR,&cval);
5007                 if (ret) return ret;
5008                 nval = (cval & ~msk) | (val & msk);
5009                 pvr2_trace(PVR2_TRACE_GPIO,
5010                            "GPIO direction changing 0x%x:0x%x"
5011                            " from 0x%x to 0x%x",
5012                            msk,val,cval,nval);
5013         } else {
5014                 nval = val;
5015                 pvr2_trace(PVR2_TRACE_GPIO,
5016                            "GPIO direction changing to 0x%x",nval);
5017         }
5018         return pvr2_write_register(hdw,PVR2_GPIO_DIR,nval);
5019 }
5020
5021
5022 int pvr2_hdw_gpio_chg_out(struct pvr2_hdw *hdw,u32 msk,u32 val)
5023 {
5024         u32 cval,nval;
5025         int ret;
5026         if (~msk) {
5027                 ret = pvr2_read_register(hdw,PVR2_GPIO_OUT,&cval);
5028                 if (ret) return ret;
5029                 nval = (cval & ~msk) | (val & msk);
5030                 pvr2_trace(PVR2_TRACE_GPIO,
5031                            "GPIO output changing 0x%x:0x%x from 0x%x to 0x%x",
5032                            msk,val,cval,nval);
5033         } else {
5034                 nval = val;
5035                 pvr2_trace(PVR2_TRACE_GPIO,
5036                            "GPIO output changing to 0x%x",nval);
5037         }
5038         return pvr2_write_register(hdw,PVR2_GPIO_OUT,nval);
5039 }
5040
5041
5042 void pvr2_hdw_status_poll(struct pvr2_hdw *hdw)
5043 {
5044         struct v4l2_tuner *vtp = &hdw->tuner_signal_info;
5045         memset(vtp, 0, sizeof(*vtp));
5046         vtp->type = (hdw->input_val == PVR2_CVAL_INPUT_RADIO) ?
5047                 V4L2_TUNER_RADIO : V4L2_TUNER_ANALOG_TV;
5048         hdw->tuner_signal_stale = 0;
5049         /* Note: There apparently is no replacement for VIDIOC_CROPCAP
5050            using v4l2-subdev - therefore we can't support that AT ALL right
5051            now.  (Of course, no sub-drivers seem to implement it either.
5052            But now it's a a chicken and egg problem...) */
5053         v4l2_device_call_all(&hdw->v4l2_dev, 0, tuner, g_tuner, vtp);
5054         pvr2_trace(PVR2_TRACE_CHIPS, "subdev status poll"
5055                    " type=%u strength=%u audio=0x%x cap=0x%x"
5056                    " low=%u hi=%u",
5057                    vtp->type,
5058                    vtp->signal, vtp->rxsubchans, vtp->capability,
5059                    vtp->rangelow, vtp->rangehigh);
5060
5061         /* We have to do this to avoid getting into constant polling if
5062            there's nobody to answer a poll of cropcap info. */
5063         hdw->cropcap_stale = 0;
5064 }
5065
5066
5067 unsigned int pvr2_hdw_get_input_available(struct pvr2_hdw *hdw)
5068 {
5069         return hdw->input_avail_mask;
5070 }
5071
5072
5073 unsigned int pvr2_hdw_get_input_allowed(struct pvr2_hdw *hdw)
5074 {
5075         return hdw->input_allowed_mask;
5076 }
5077
5078
5079 static int pvr2_hdw_set_input(struct pvr2_hdw *hdw,int v)
5080 {
5081         if (hdw->input_val != v) {
5082                 hdw->input_val = v;
5083                 hdw->input_dirty = !0;
5084         }
5085
5086         /* Handle side effects - if we switch to a mode that needs the RF
5087            tuner, then select the right frequency choice as well and mark
5088            it dirty. */
5089         if (hdw->input_val == PVR2_CVAL_INPUT_RADIO) {
5090                 hdw->freqSelector = 0;
5091                 hdw->freqDirty = !0;
5092         } else if ((hdw->input_val == PVR2_CVAL_INPUT_TV) ||
5093                    (hdw->input_val == PVR2_CVAL_INPUT_DTV)) {
5094                 hdw->freqSelector = 1;
5095                 hdw->freqDirty = !0;
5096         }
5097         return 0;
5098 }
5099
5100
5101 int pvr2_hdw_set_input_allowed(struct pvr2_hdw *hdw,
5102                                unsigned int change_mask,
5103                                unsigned int change_val)
5104 {
5105         int ret = 0;
5106         unsigned int nv,m,idx;
5107         LOCK_TAKE(hdw->big_lock);
5108         do {
5109                 nv = hdw->input_allowed_mask & ~change_mask;
5110                 nv |= (change_val & change_mask);
5111                 nv &= hdw->input_avail_mask;
5112                 if (!nv) {
5113                         /* No legal modes left; return error instead. */
5114                         ret = -EPERM;
5115                         break;
5116                 }
5117                 hdw->input_allowed_mask = nv;
5118                 if ((1 << hdw->input_val) & hdw->input_allowed_mask) {
5119                         /* Current mode is still in the allowed mask, so
5120                            we're done. */
5121                         break;
5122                 }
5123                 /* Select and switch to a mode that is still in the allowed
5124                    mask */
5125                 if (!hdw->input_allowed_mask) {
5126                         /* Nothing legal; give up */
5127                         break;
5128                 }
5129                 m = hdw->input_allowed_mask;
5130                 for (idx = 0; idx < (sizeof(m) << 3); idx++) {
5131                         if (!((1 << idx) & m)) continue;
5132                         pvr2_hdw_set_input(hdw,idx);
5133                         break;
5134                 }
5135         } while (0);
5136         LOCK_GIVE(hdw->big_lock);
5137         return ret;
5138 }
5139
5140
5141 /* Find I2C address of eeprom */
5142 static int pvr2_hdw_get_eeprom_addr(struct pvr2_hdw *hdw)
5143 {
5144         int result;
5145         LOCK_TAKE(hdw->ctl_lock); do {
5146                 hdw->cmd_buffer[0] = FX2CMD_GET_EEPROM_ADDR;
5147                 result = pvr2_send_request(hdw,
5148                                            hdw->cmd_buffer,1,
5149                                            hdw->cmd_buffer,1);
5150                 if (result < 0) break;
5151                 result = hdw->cmd_buffer[0];
5152         } while(0); LOCK_GIVE(hdw->ctl_lock);
5153         return result;
5154 }