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