drivers/media/usb/pvrusb2/pvrusb2-hdw.h

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