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 /* Private V4L2-compatible controls available in this driver, look these up
  30    with pvr2_hdw_get_ctrl_v4l(). */
  31 #define V4L2_CID_PVR_SRATE          (V4L2_CID_PRIVATE_BASE)
  32 #define V4L2_CID_PVR_AUDIOBITRATE   (V4L2_CID_PRIVATE_BASE+1)
  33 #define V4L2_CID_PVR_AUDIOCRC       (V4L2_CID_PRIVATE_BASE+2)
  34 #define V4L2_CID_PVR_AUDIOEMPHASIS  (V4L2_CID_PRIVATE_BASE+3)
  35 #define V4L2_CID_PVR_VBR            (V4L2_CID_PRIVATE_BASE+4)
  36 #define V4L2_CID_PVR_VIDEOBITRATE   (V4L2_CID_PRIVATE_BASE+5)
  37 #define V4L2_CID_PVR_VIDEOPEAK      (V4L2_CID_PRIVATE_BASE+6)
  38 #define V4L2_CID_PVR_VIDEOSTANDARD  (V4L2_CID_PRIVATE_BASE+7)
  39
  40 /* Private internal control ids, look these up with
  41    pvr2_hdw_get_ctrl_by_id() - these are NOT visible in V4L */
  42 #define PVR2_CID_STDENUM 1
  43 #define PVR2_CID_STDCUR 2
  44 #define PVR2_CID_STDAVAIL 3
  45 #define PVR2_CID_INPUT 4
  46 #define PVR2_CID_AUDIOMODE 5
  47 #define PVR2_CID_FREQUENCY 6
  48 #define PVR2_CID_HRES 7
  49 #define PVR2_CID_VRES 8
  50 #define PVR2_CID_INTERLACE 9
  51
  52 /* Legal values for the INPUT state variable */
  53 #define PVR2_CVAL_INPUT_TV 0
  54 #define PVR2_CVAL_INPUT_SVIDEO 1
  55 #define PVR2_CVAL_INPUT_COMPOSITE 2
  56 #define PVR2_CVAL_INPUT_RADIO 3
  57
  58 /* Values that pvr2_hdw_get_signal_status() returns */
  59 #define PVR2_SIGNAL_OK     0x0001
  60 #define PVR2_SIGNAL_STEREO 0x0002
  61 #define PVR2_SIGNAL_SAP    0x0004
  62
  63
  64 /* Subsystem definitions - these are various pieces that can be
  65    independently stopped / started.  Usually you don't want to mess with
  66    this directly (let the driver handle things itself), but it is useful
  67    for debugging. */
  68 #define PVR2_SUBSYS_B_ENC_FIRMWARE        0
  69 #define PVR2_SUBSYS_B_ENC_CFG             1
  70 #define PVR2_SUBSYS_B_DIGITIZER_RUN       2
  71 #define PVR2_SUBSYS_B_USBSTREAM_RUN       3
  72 #define PVR2_SUBSYS_B_ENC_RUN             4
  73
  74 #define PVR2_SUBSYS_CFG_ALL ( \
  75         (1 << PVR2_SUBSYS_B_ENC_FIRMWARE) | \
  76         (1 << PVR2_SUBSYS_B_ENC_CFG) )
  77 #define PVR2_SUBSYS_RUN_ALL ( \
  78         (1 << PVR2_SUBSYS_B_DIGITIZER_RUN) | \
  79         (1 << PVR2_SUBSYS_B_USBSTREAM_RUN) | \
  80         (1 << PVR2_SUBSYS_B_ENC_RUN) )
  81 #define PVR2_SUBSYS_ALL ( \
  82         PVR2_SUBSYS_CFG_ALL | \
  83         PVR2_SUBSYS_RUN_ALL )
  84
  85 enum pvr2_config {
  86         pvr2_config_empty,
  87         pvr2_config_mpeg,
  88         pvr2_config_vbi,
  89         pvr2_config_radio,
  90 };
  91
  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 /* Poll for background activity (if any) */
 102 void pvr2_hdw_poll(struct pvr2_hdw *);
 103
 104 /* Trigger a poll to take place later at a convenient time */
 105 void pvr2_hdw_poll_trigger(struct pvr2_hdw *);
 106 void pvr2_hdw_poll_trigger_unlocked(struct pvr2_hdw *);
 107
 108 /* Register a callback used to trigger a future poll */
 109 void pvr2_hdw_setup_poll_trigger(struct pvr2_hdw *,
 110                                  void (*func)(void *),
 111                                  void *data);
 112
 113 /* Get pointer to structure given unit number */
 114 struct pvr2_hdw *pvr2_hdw_find(int unit_number);
 115
 116 /* Destroy hardware interaction structure */
 117 void pvr2_hdw_destroy(struct pvr2_hdw *);
 118
 119 /* Set up the structure and attempt to put the device into a usable state.
 120    This can be a time-consuming operation, which is why it is not done
 121    internally as part of the create() step.  Return value is exactly the
 122    same as pvr2_hdw_init_ok(). */
 123 int pvr2_hdw_setup(struct pvr2_hdw *);
 124
 125 /* Initialization succeeded */
 126 int pvr2_hdw_init_ok(struct pvr2_hdw *);
 127
 128 /* Return true if in the ready (normal) state */
 129 int pvr2_hdw_dev_ok(struct pvr2_hdw *);
 130
 131 /* Return small integer number [1..N] for logical instance number of this
 132    device.  This is useful for indexing array-valued module parameters. */
 133 int pvr2_hdw_get_unit_number(struct pvr2_hdw *);
 134
 135 /* Get pointer to underlying USB device */
 136 struct usb_device *pvr2_hdw_get_dev(struct pvr2_hdw *);
 137
 138 /* Retrieve serial number of device */
 139 unsigned long pvr2_hdw_get_sn(struct pvr2_hdw *);
 140
 141 /* Called when hardware has been unplugged */
 142 void pvr2_hdw_disconnect(struct pvr2_hdw *);
 143
 144 /* Get the number of defined controls */
 145 unsigned int pvr2_hdw_get_ctrl_count(struct pvr2_hdw *);
 146
 147 /* Retrieve a control handle given its index (0..count-1) */
 148 struct pvr2_ctrl *pvr2_hdw_get_ctrl_by_index(struct pvr2_hdw *,unsigned int);
 149
 150 /* Retrieve a control handle given its internal ID (if any) */
 151 struct pvr2_ctrl *pvr2_hdw_get_ctrl_by_id(struct pvr2_hdw *,unsigned int);
 152
 153 /* Retrieve a control handle given its V4L ID (if any) */
 154 struct pvr2_ctrl *pvr2_hdw_get_ctrl_v4l(struct pvr2_hdw *,unsigned int ctl_id);
 155
 156 /* Commit all control changes made up to this point */
 157 int pvr2_hdw_commit_ctl(struct pvr2_hdw *);
 158
 159 /* Return name for this driver instance */
 160 const char *pvr2_hdw_get_driver_name(struct pvr2_hdw *);
 161
 162 /* Return PVR2_SIGNAL_XXXX bit mask indicating signal status */
 163 unsigned int pvr2_hdw_get_signal_status(struct pvr2_hdw *);
 164
 165 /* Query device and see if it thinks it is on a high-speed USB link */
 166 int pvr2_hdw_is_hsm(struct pvr2_hdw *);
 167
 168 /* Turn streaming on/off */
 169 int pvr2_hdw_set_streaming(struct pvr2_hdw *,int);
 170
 171 /* Find out if streaming is on */
 172 int pvr2_hdw_get_streaming(struct pvr2_hdw *);
 173
 174 /* Configure the type of stream to generate */
 175 int pvr2_hdw_set_stream_type(struct pvr2_hdw *, enum pvr2_config);
 176
 177 /* Get handle to video output stream */
 178 struct pvr2_stream *pvr2_hdw_get_video_stream(struct pvr2_hdw *);
 179
 180 /* Emit a video standard struct */
 181 int pvr2_hdw_get_stdenum_value(struct pvr2_hdw *hdw,struct v4l2_standard *std,
 182                                unsigned int idx);
 183
 184 /* Enable / disable various pieces of hardware.  Items to change are
 185    identified by bit positions within msk, and new state for each item is
 186    identified by corresponding bit positions within val. */
 187 void pvr2_hdw_subsys_bit_chg(struct pvr2_hdw *hdw,
 188                              unsigned long msk,unsigned long val);
 189
 190 /* Shortcut for pvr2_hdw_subsys_bit_chg(hdw,msk,msk) */
 191 void pvr2_hdw_subsys_bit_set(struct pvr2_hdw *hdw,unsigned long msk);
 192
 193 /* Shortcut for pvr2_hdw_subsys_bit_chg(hdw,msk,0) */
 194 void pvr2_hdw_subsys_bit_clr(struct pvr2_hdw *hdw,unsigned long msk);
 195
 196 /* Retrieve mask indicating which pieces of hardware are currently enabled
 197    / configured. */
 198 unsigned long pvr2_hdw_subsys_get(struct pvr2_hdw *);
 199
 200 /* Adjust mask of what get shut down when streaming is stopped.  This is a
 201    debugging aid. */
 202 void pvr2_hdw_subsys_stream_bit_chg(struct pvr2_hdw *hdw,
 203                                     unsigned long msk,unsigned long val);
 204
 205 /* Retrieve mask indicating which pieces of hardware are disabled when
 206    streaming is turned off. */
 207 unsigned long pvr2_hdw_subsys_stream_get(struct pvr2_hdw *);
 208
 209
 210 /* Enable / disable retrieval of CPU firmware.  This must be enabled before
 211    pvr2_hdw_cpufw_get() will function.  Note that doing this may prevent
 212    the device from running (and leaving this mode may imply a device
 213    reset). */
 214 void pvr2_hdw_cpufw_set_enabled(struct pvr2_hdw *, int enable_flag);
 215
 216 /* Return true if we're in a mode for retrieval CPU firmware */
 217 int pvr2_hdw_cpufw_get_enabled(struct pvr2_hdw *);
 218
 219 /* Retrieve a piece of the CPU's firmware at the given offset.  Return
 220    value is the number of bytes retrieved or zero if we're past the end or
 221    an error otherwise (e.g. if firmware retrieval is not enabled). */
 222 int pvr2_hdw_cpufw_get(struct pvr2_hdw *,unsigned int offs,
 223                        char *buf,unsigned int cnt);
 224
 225 /* Retrieve previously stored v4l minor device number */
 226 int pvr2_hdw_v4l_get_minor_number(struct pvr2_hdw *);
 227
 228 /* Store the v4l minor device number */
 229 void pvr2_hdw_v4l_store_minor_number(struct pvr2_hdw *,int);
 230
 231
 232 /* The following entry points are all lower level things you normally don't
 233    want to worry about. */
 234
 235 /* Attempt to recover from a USB foul-up (in practice I find that if you
 236    have to do this, then it's already too late). */
 237 void pvr2_reset_ctl_endpoints(struct pvr2_hdw *hdw);
 238
 239 /* Issue a command and get a response from the device.  LOTS of higher
 240    level stuff is built on this. */
 241 int pvr2_send_request(struct pvr2_hdw *,
 242                       void *write_ptr,unsigned int write_len,
 243                       void *read_ptr,unsigned int read_len);
 244
 245 /* Issue a command and get a response from the device.  This extended
 246    version includes a probe flag (which if set means that device errors
 247    should not be logged or treated as fatal) and a timeout in jiffies.
 248    This can be used to non-lethally probe the health of endpoint 1. */
 249 int pvr2_send_request_ex(struct pvr2_hdw *,unsigned int timeout,int probe_fl,
 250                          void *write_ptr,unsigned int write_len,
 251                          void *read_ptr,unsigned int read_len);
 252
 253 /* Slightly higher level device communication functions. */
 254 int pvr2_write_register(struct pvr2_hdw *, u16, u32);
 255 int pvr2_read_register(struct pvr2_hdw *, u16, u32 *);
 256 int pvr2_write_u16(struct pvr2_hdw *, u16, int);
 257 int pvr2_write_u8(struct pvr2_hdw *, u8, int);
 258
 259 /* Call if for any reason we can't talk to the hardware anymore - this will
 260    cause the driver to stop flailing on the device. */
 261 void pvr2_hdw_render_useless(struct pvr2_hdw *);
 262 void pvr2_hdw_render_useless_unlocked(struct pvr2_hdw *);
 263
 264 /* Set / clear 8051's reset bit */
 265 void pvr2_hdw_cpureset_assert(struct pvr2_hdw *,int);
 266
 267 /* Execute a USB-commanded device reset */
 268 void pvr2_hdw_device_reset(struct pvr2_hdw *);
 269
 270 /* Execute hard reset command (after this point it's likely that the
 271    encoder will have to be reconfigured).  This also clears the "useless"
 272    state. */
 273 int pvr2_hdw_cmd_deep_reset(struct pvr2_hdw *);
 274
 275 /* Execute simple reset command */
 276 int pvr2_hdw_cmd_powerup(struct pvr2_hdw *);
 277
 278 /* Order decoder to reset */
 279 int pvr2_hdw_cmd_decoder_reset(struct pvr2_hdw *);
 280
 281 /* Stop / start video stream transport */
 282 int pvr2_hdw_cmd_usbstream(struct pvr2_hdw *hdw,int runFl);
 283
 284 /* Find I2C address of eeprom */
 285 int pvr2_hdw_get_eeprom_addr(struct pvr2_hdw *);
 286
 287 /* Direct manipulation of GPIO bits */
 288 int pvr2_hdw_gpio_get_dir(struct pvr2_hdw *hdw,u32 *);
 289 int pvr2_hdw_gpio_get_out(struct pvr2_hdw *hdw,u32 *);
 290 int pvr2_hdw_gpio_get_in(struct pvr2_hdw *hdw,u32 *);
 291 int pvr2_hdw_gpio_chg_dir(struct pvr2_hdw *hdw,u32 msk,u32 val);
 292 int pvr2_hdw_gpio_chg_out(struct pvr2_hdw *hdw,u32 msk,u32 val);
 293
 294 /* This data structure is specifically for the next function... */
 295 struct pvr2_hdw_debug_info {
 296         int big_lock_held;
 297         int ctl_lock_held;
 298         int flag_ok;
 299         int flag_disconnected;
 300         int flag_init_ok;
 301         int flag_streaming_enabled;
 302         unsigned long subsys_flags;
 303         int cmd_debug_state;
 304         int cmd_debug_write_len;
 305         int cmd_debug_read_len;
 306         int cmd_debug_write_pend;
 307         int cmd_debug_read_pend;
 308         int cmd_debug_timeout;
 309         int cmd_debug_rstatus;
 310         int cmd_debug_wstatus;
 311         unsigned char cmd_code;
 312 };
 313
 314 /* Non-intrusively retrieve internal state info - this is useful for
 315    diagnosing lockups.  Note that this operation is completed without any
 316    kind of locking and so it is not atomic and may yield inconsistent
 317    results.  This is *purely* a debugging aid. */
 318 void pvr2_hdw_get_debug_info(const struct pvr2_hdw *hdw,
 319                              struct pvr2_hdw_debug_info *);
 320
 321 /* Cause modules to log their state once */
 322 void pvr2_hdw_trigger_module_log(struct pvr2_hdw *hdw);
 323
 324 /* Cause encoder firmware to be uploaded into the device.  This is normally
 325    done autonomously, but the interface is exported here because it is also
 326    a debugging aid. */
 327 int pvr2_upload_firmware2(struct pvr2_hdw *hdw);
 328
 329 /* List of device types that we can match */
 330 extern struct usb_device_id pvr2_device_table[];
 331
 332 #endif /* __PVRUSB2_HDW_H */
 333
 334 /*
 335   Stuff for Emacs to see, in order to encourage consistent editing style:
 336   *** Local Variables: ***
 337   *** mode: c ***
 338   *** fill-column: 75 ***
 339   *** tab-width: 8 ***
 340   *** c-basic-offset: 8 ***
 341   *** End: ***
 342   */