SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/media/video/pvrusb2/pvrusb2-hdw.h

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