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