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_unlocked(struct pvr2_hdw *);
  95
  96 /* Register a callback used to trigger a future poll */
  97 void pvr2_hdw_setup_poll_trigger(struct pvr2_hdw *,
  98                                  void (*func)(void *),
  99                                  void *data);
 100
 101 /* Destroy hardware interaction structure */
 102 void pvr2_hdw_destroy(struct pvr2_hdw *);
 103
 104 /* Set up the structure and attempt to put the device into a usable state.
 105    This can be a time-consuming operation, which is why it is not done
 106    internally as part of the create() step.  Return value is exactly the
 107    same as pvr2_hdw_init_ok(). */
 108 int pvr2_hdw_setup(struct pvr2_hdw *);
 109
 110 /* Initialization succeeded */
 111 int pvr2_hdw_init_ok(struct pvr2_hdw *);
 112
 113 /* Return true if in the ready (normal) state */
 114 int pvr2_hdw_dev_ok(struct pvr2_hdw *);
 115
 116 /* Return small integer number [1..N] for logical instance number of this
 117    device.  This is useful for indexing array-valued module parameters. */
 118 int pvr2_hdw_get_unit_number(struct pvr2_hdw *);
 119
 120 /* Get pointer to underlying USB device */
 121 struct usb_device *pvr2_hdw_get_dev(struct pvr2_hdw *);
 122
 123 /* Retrieve serial number of device */
 124 unsigned long pvr2_hdw_get_sn(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 name for this driver instance */
 149 const char *pvr2_hdw_get_driver_name(struct pvr2_hdw *);
 150
 151 /* Return PVR2_SIGNAL_XXXX bit mask indicating signal status */
 152 unsigned int pvr2_hdw_get_signal_status(struct pvr2_hdw *);
 153
 154 /* Query device and see if it thinks it is on a high-speed USB link */
 155 int pvr2_hdw_is_hsm(struct pvr2_hdw *);
 156
 157 /* Turn streaming on/off */
 158 int pvr2_hdw_set_streaming(struct pvr2_hdw *,int);
 159
 160 /* Find out if streaming is on */
 161 int pvr2_hdw_get_streaming(struct pvr2_hdw *);
 162
 163 /* Configure the type of stream to generate */
 164 int pvr2_hdw_set_stream_type(struct pvr2_hdw *, enum pvr2_config);
 165
 166 /* Get handle to video output stream */
 167 struct pvr2_stream *pvr2_hdw_get_video_stream(struct pvr2_hdw *);
 168
 169 /* Emit a video standard struct */
 170 int pvr2_hdw_get_stdenum_value(struct pvr2_hdw *hdw,struct v4l2_standard *std,
 171                                unsigned int idx);
 172
 173 /* Enable / disable various pieces of hardware.  Items to change are
 174    identified by bit positions within msk, and new state for each item is
 175    identified by corresponding bit positions within val. */
 176 void pvr2_hdw_subsys_bit_chg(struct pvr2_hdw *hdw,
 177                              unsigned long msk,unsigned long val);
 178
 179 /* Retrieve mask indicating which pieces of hardware are currently enabled
 180    / configured. */
 181 unsigned long pvr2_hdw_subsys_get(struct pvr2_hdw *);
 182
 183 /* Adjust mask of what get shut down when streaming is stopped.  This is a
 184    debugging aid. */
 185 void pvr2_hdw_subsys_stream_bit_chg(struct pvr2_hdw *hdw,
 186                                     unsigned long msk,unsigned long val);
 187
 188 /* Retrieve mask indicating which pieces of hardware are disabled when
 189    streaming is turned off. */
 190 unsigned long pvr2_hdw_subsys_stream_get(struct pvr2_hdw *);
 191
 192
 193 /* Enable / disable retrieval of CPU firmware.  This must be enabled before
 194    pvr2_hdw_cpufw_get() will function.  Note that doing this may prevent
 195    the device from running (and leaving this mode may imply a device
 196    reset). */
 197 void pvr2_hdw_cpufw_set_enabled(struct pvr2_hdw *, int enable_flag);
 198
 199 /* Return true if we're in a mode for retrieval CPU firmware */
 200 int pvr2_hdw_cpufw_get_enabled(struct pvr2_hdw *);
 201
 202 /* Retrieve a piece of the CPU's firmware at the given offset.  Return
 203    value is the number of bytes retrieved or zero if we're past the end or
 204    an error otherwise (e.g. if firmware retrieval is not enabled). */
 205 int pvr2_hdw_cpufw_get(struct pvr2_hdw *,unsigned int offs,
 206                        char *buf,unsigned int cnt);
 207
 208 /* Retrieve previously stored v4l minor device number */
 209 int pvr2_hdw_v4l_get_minor_number(struct pvr2_hdw *);
 210
 211 /* Store the v4l minor device number */
 212 void pvr2_hdw_v4l_store_minor_number(struct pvr2_hdw *,int);
 213
 214
 215 /* The following entry points are all lower level things you normally don't
 216    want to worry about. */
 217
 218 /* Issue a command and get a response from the device.  LOTS of higher
 219    level stuff is built on this. */
 220 int pvr2_send_request(struct pvr2_hdw *,
 221                       void *write_ptr,unsigned int write_len,
 222                       void *read_ptr,unsigned int read_len);
 223
 224 /* Slightly higher level device communication functions. */
 225 int pvr2_write_register(struct pvr2_hdw *, u16, u32);
 226
 227 /* Call if for any reason we can't talk to the hardware anymore - this will
 228    cause the driver to stop flailing on the device. */
 229 void pvr2_hdw_render_useless(struct pvr2_hdw *);
 230
 231 /* Set / clear 8051's reset bit */
 232 void pvr2_hdw_cpureset_assert(struct pvr2_hdw *,int);
 233
 234 /* Execute a USB-commanded device reset */
 235 void pvr2_hdw_device_reset(struct pvr2_hdw *);
 236
 237 /* Execute hard reset command (after this point it's likely that the
 238    encoder will have to be reconfigured).  This also clears the "useless"
 239    state. */
 240 int pvr2_hdw_cmd_deep_reset(struct pvr2_hdw *);
 241
 242 /* Execute simple reset command */
 243 int pvr2_hdw_cmd_powerup(struct pvr2_hdw *);
 244
 245 /* Order decoder to reset */
 246 int pvr2_hdw_cmd_decoder_reset(struct pvr2_hdw *);
 247
 248 /* Direct manipulation of GPIO bits */
 249 int pvr2_hdw_gpio_get_dir(struct pvr2_hdw *hdw,u32 *);
 250 int pvr2_hdw_gpio_get_out(struct pvr2_hdw *hdw,u32 *);
 251 int pvr2_hdw_gpio_get_in(struct pvr2_hdw *hdw,u32 *);
 252 int pvr2_hdw_gpio_chg_dir(struct pvr2_hdw *hdw,u32 msk,u32 val);
 253 int pvr2_hdw_gpio_chg_out(struct pvr2_hdw *hdw,u32 msk,u32 val);
 254
 255 /* This data structure is specifically for the next function... */
 256 struct pvr2_hdw_debug_info {
 257         int big_lock_held;
 258         int ctl_lock_held;
 259         int flag_ok;
 260         int flag_disconnected;
 261         int flag_init_ok;
 262         int flag_streaming_enabled;
 263         unsigned long subsys_flags;
 264         int cmd_debug_state;
 265         int cmd_debug_write_len;
 266         int cmd_debug_read_len;
 267         int cmd_debug_write_pend;
 268         int cmd_debug_read_pend;
 269         int cmd_debug_timeout;
 270         int cmd_debug_rstatus;
 271         int cmd_debug_wstatus;
 272         unsigned char cmd_code;
 273 };
 274
 275 /* Non-intrusively retrieve internal state info - this is useful for
 276    diagnosing lockups.  Note that this operation is completed without any
 277    kind of locking and so it is not atomic and may yield inconsistent
 278    results.  This is *purely* a debugging aid. */
 279 void pvr2_hdw_get_debug_info(const struct pvr2_hdw *hdw,
 280                              struct pvr2_hdw_debug_info *);
 281
 282 /* Cause modules to log their state once */
 283 void pvr2_hdw_trigger_module_log(struct pvr2_hdw *hdw);
 284
 285 /* Cause encoder firmware to be uploaded into the device.  This is normally
 286    done autonomously, but the interface is exported here because it is also
 287    a debugging aid. */
 288 int pvr2_upload_firmware2(struct pvr2_hdw *hdw);
 289
 290 /* List of device types that we can match */
 291 extern struct usb_device_id pvr2_device_table[];
 292
 293 #endif /* __PVRUSB2_HDW_H */
 294
 295 /*
 296   Stuff for Emacs to see, in order to encourage consistent editing style:
 297   *** Local Variables: ***
 298   *** mode: c ***
 299   *** fill-column: 75 ***
 300   *** tab-width: 8 ***
 301   *** c-basic-offset: 8 ***
 302   *** End: ***
 303   */