drivers/media/video/pvrusb2/pvrusb2-devattr.h

   1 /*
   2  *
   3  *
   4  *  Copyright (C) 2005 Mike Isely <isely@pobox.com>
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with this program; if not, write to the Free Software
  17  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  *
  19  */
  20 #ifndef __PVRUSB2_DEVATTR_H
  21 #define __PVRUSB2_DEVATTR_H
  22
  23 #include <linux/mod_devicetable.h>
  24 #include <linux/videodev2.h>
  25 #ifdef CONFIG_VIDEO_PVRUSB2_DVB
  26 #include "pvrusb2-dvb.h"
  27 #endif
  28
  29 /*
  30
  31   This header defines structures used to describe attributes of a device.
  32
  33 */
  34
  35
  36 #define PVR2_CLIENT_ID_NULL 0
  37 #define PVR2_CLIENT_ID_MSP3400 1
  38 #define PVR2_CLIENT_ID_CX25840 2
  39 #define PVR2_CLIENT_ID_SAA7115 3
  40 #define PVR2_CLIENT_ID_TUNER 4
  41 #define PVR2_CLIENT_ID_CS53L32A 5
  42 #define PVR2_CLIENT_ID_WM8775 6
  43 #define PVR2_CLIENT_ID_DEMOD 7
  44
  45 struct pvr2_device_client_desc {
  46         /* One ovr PVR2_CLIENT_ID_xxxx */
  47         unsigned char module_id;
  48
  49         /* Null-terminated array of I2C addresses to try in order
  50            initialize the module.  It's safe to make this null terminated
  51            since we're never going to encounter an i2c device with an
  52            address of zero.  If this is a null pointer or zero-length,
  53            then no I2C addresses have been specified, in which case we'll
  54            try some compiled in defaults for now. */
  55         unsigned char *i2c_address_list;
  56 };
  57
  58 struct pvr2_device_client_table {
  59         const struct pvr2_device_client_desc *lst;
  60         unsigned char cnt;
  61 };
  62
  63
  64 struct pvr2_string_table {
  65         const char **lst;
  66         unsigned int cnt;
  67 };
  68
  69 #define PVR2_ROUTING_SCHEME_HAUPPAUGE 0
  70 #define PVR2_ROUTING_SCHEME_GOTVIEW 1
  71 #define PVR2_ROUTING_SCHEME_ONAIR 2
  72
  73 #define PVR2_DIGITAL_SCHEME_NONE 0
  74 #define PVR2_DIGITAL_SCHEME_HAUPPAUGE 1
  75 #define PVR2_DIGITAL_SCHEME_ONAIR 2
  76
  77 #define PVR2_LED_SCHEME_NONE 0
  78 #define PVR2_LED_SCHEME_HAUPPAUGE 1
  79
  80 #define PVR2_IR_SCHEME_NONE 0
  81 #define PVR2_IR_SCHEME_24XXX 1
  82 #define PVR2_IR_SCHEME_ZILOG 2
  83
  84 /* This describes a particular hardware type (except for the USB device ID
  85    which must live in a separate structure due to environmental
  86    constraints).  See the top of pvrusb2-hdw.c for where this is
  87    instantiated. */
  88 struct pvr2_device_desc {
  89         /* Single line text description of hardware */
  90         const char *description;
  91
  92         /* Single token identifier for hardware */
  93         const char *shortname;
  94
  95         /* List of additional client modules we need to load */
  96         struct pvr2_string_table client_modules;
  97
  98         /* List of defined client modules we need to load */
  99         struct pvr2_device_client_table client_table;
 100
 101         /* List of FX2 firmware file names we should search; if empty then
 102            FX2 firmware check / load is skipped and we assume the device
 103            was initialized from internal ROM. */
 104         struct pvr2_string_table fx2_firmware;
 105
 106 #ifdef CONFIG_VIDEO_PVRUSB2_DVB
 107         /* callback functions to handle attachment of digital tuner & demod */
 108         const struct pvr2_dvb_props *dvb_props;
 109
 110 #endif
 111         /* Initial standard bits to use for this device, if not zero.
 112            Anything set here is also implied as an available standard.
 113            Note: This is ignored if overridden on the module load line via
 114            the video_std module option. */
 115         v4l2_std_id default_std_mask;
 116
 117         /* V4L tuner type ID to use with this device (only used if the
 118            driver could not discover the type any other way). */
 119         int default_tuner_type;
 120
 121         /* Signal routing scheme used by device, contains one of
 122            PVR2_ROUTING_SCHEME_XXX.  Schemes have to be defined as we
 123            encounter them.  This is an arbitrary integer scheme id; its
 124            meaning is contained entirely within the driver and is
 125            interpreted by logic which must send commands to the chip-level
 126            drivers (search for things which touch this field). */
 127         unsigned char signal_routing_scheme;
 128
 129         /* Indicates scheme for controlling device's LED (if any).  The
 130            driver will turn on the LED when streaming is underway.  This
 131            contains one of PVR2_LED_SCHEME_XXX. */
 132         unsigned char led_scheme;
 133
 134         /* Control scheme to use if there is a digital tuner.  This
 135            contains one of PVR2_DIGITAL_SCHEME_XXX.  This is an arbitrary
 136            integer scheme id; its meaning is contained entirely within the
 137            driver and is interpreted by logic which must control the
 138            streaming pathway (search for things which touch this field). */
 139         unsigned char digital_control_scheme;
 140
 141         /* If set, we don't bother trying to load cx23416 firmware. */
 142         unsigned int flag_skip_cx23416_firmware:1;
 143
 144         /* If set, the encoder must be healthy in order for digital mode to
 145            work (otherwise we assume that digital streaming will work even
 146            if we fail to locate firmware for the encoder).  If the device
 147            doesn't support digital streaming then this flag has no
 148            effect. */
 149         unsigned int flag_digital_requires_cx23416:1;
 150
 151         /* Device has a hauppauge eeprom which we can interrogate. */
 152         unsigned int flag_has_hauppauge_rom:1;
 153
 154         /* Device does not require a powerup command to be issued. */
 155         unsigned int flag_no_powerup:1;
 156
 157         /* Device has a cx25840 - this enables special additional logic to
 158            handle it. */
 159         unsigned int flag_has_cx25840:1;
 160
 161         /* Device has a wm8775 - this enables special additional logic to
 162            ensure that it is found. */
 163         unsigned int flag_has_wm8775:1;
 164
 165         /* Indicate any specialized IR scheme that might need to be
 166            supported by this driver.  If not set, then it is assumed that
 167            IR can work without help from the driver (which is frequently
 168            the case).  This is otherwise set to one of
 169            PVR2_IR_SCHEME_xxxx.  For "xxxx", the value "24XXX" indicates a
 170            Hauppauge 24xxx class device which has an FPGA-hosted IR
 171            receiver that can only be reached via FX2 command codes.  In
 172            that case the pvrusb2 driver will emulate the behavior of the
 173            older 29xxx device's IR receiver (a "virtual" I2C chip) in terms
 174            of those command codes.  For the value "ZILOG", we're dealing
 175            with an IR chip that must be taken out of reset via another FX2
 176            command code (which is the case for HVR-1950 devices). */
 177         unsigned int ir_scheme:2;
 178
 179         /* These bits define which kinds of sources the device can handle.
 180            Note: Digital tuner presence is inferred by the
 181            digital_control_scheme enumeration. */
 182         unsigned int flag_has_fmradio:1;       /* Has FM radio receiver */
 183         unsigned int flag_has_analogtuner:1;   /* Has analog tuner */
 184         unsigned int flag_has_composite:1;     /* Has composite input */
 185         unsigned int flag_has_svideo:1;        /* Has s-video input */
 186 };
 187
 188 extern struct usb_device_id pvr2_device_table[];
 189
 190 #endif /* __PVRUSB2_HDW_INTERNAL_H */
 191
 192 /*
 193   Stuff for Emacs to see, in order to encourage consistent editing style:
 194   *** Local Variables: ***
 195   *** mode: c ***
 196   *** fill-column: 75 ***
 197   *** tab-width: 8 ***
 198   *** c-basic-offset: 8 ***
 199   *** End: ***
 200   */