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 struct pvr2_string_table {
  37         const char **lst;
  38         unsigned int cnt;
  39 };
  40
  41 #define PVR2_ROUTING_SCHEME_HAUPPAUGE 0
  42 #define PVR2_ROUTING_SCHEME_GOTVIEW 1
  43
  44 #define PVR2_DIGITAL_SCHEME_NONE 0
  45 #define PVR2_DIGITAL_SCHEME_HAUPPAUGE 1
  46 #define PVR2_DIGITAL_SCHEME_ONAIR 2
  47
  48 #define PVR2_LED_SCHEME_NONE 0
  49 #define PVR2_LED_SCHEME_HAUPPAUGE 1
  50
  51 /* This describes a particular hardware type (except for the USB device ID
  52    which must live in a separate structure due to environmental
  53    constraints).  See the top of pvrusb2-hdw.c for where this is
  54    instantiated. */
  55 struct pvr2_device_desc {
  56         /* Single line text description of hardware */
  57         const char *description;
  58
  59         /* Single token identifier for hardware */
  60         const char *shortname;
  61
  62         /* List of additional client modules we need to load */
  63         struct pvr2_string_table client_modules;
  64
  65         /* List of FX2 firmware file names we should search; if empty then
  66            FX2 firmware check / load is skipped and we assume the device
  67            was initialized from internal ROM. */
  68         struct pvr2_string_table fx2_firmware;
  69
  70 #ifdef CONFIG_VIDEO_PVRUSB2_DVB
  71         /* callback functions to handle attachment of digital tuner & demod */
  72         struct pvr2_dvb_props *dvb_props;
  73
  74 #endif
  75         /* Initial standard bits to use for this device, if not zero.
  76            Anything set here is also implied as an available standard.
  77            Note: This is ignored if overridden on the module load line via
  78            the video_std module option. */
  79         v4l2_std_id default_std_mask;
  80
  81         /* V4L tuner type ID to use with this device (only used if the
  82            driver could not discover the type any other way). */
  83         int default_tuner_type;
  84
  85         /* Signal routing scheme used by device, contains one of
  86            PVR2_ROUTING_SCHEME_XXX.  Schemes have to be defined as we
  87            encounter them.  This is an arbitrary integer scheme id; its
  88            meaning is contained entirely within the driver and is
  89            interpreted by logic which must send commands to the chip-level
  90            drivers (search for things which touch this field). */
  91         unsigned char signal_routing_scheme;
  92
  93         /* Indicates scheme for controlling device's LED (if any).  The
  94            driver will turn on the LED when streaming is underway.  This
  95            contains one of PVR2_LED_SCHEME_XXX. */
  96         unsigned char led_scheme;
  97
  98         /* Control scheme to use if there is a digital tuner.  This
  99            contains one of PVR2_DIGITAL_SCHEME_XXX.  This is an arbitrary
 100            integer scheme id; its meaning is contained entirely within the
 101            driver and is interpreted by logic which must control the
 102            streaming pathway (search for things which touch this field). */
 103         unsigned char digital_control_scheme;
 104
 105         /* If set, we don't bother trying to load cx23416 firmware. */
 106         unsigned int flag_skip_cx23416_firmware:1;
 107
 108         /* If set, the encoder must be healthy in order for digital mode to
 109            work (otherwise we assume that digital streaming will work even
 110            if we fail to locate firmware for the encoder).  If the device
 111            doesn't support digital streaming then this flag has no
 112            effect. */
 113         unsigned int flag_digital_requires_cx23416:1;
 114
 115         /* Device has a hauppauge eeprom which we can interrogate. */
 116         unsigned int flag_has_hauppauge_rom:1;
 117
 118         /* Device does not require a powerup command to be issued. */
 119         unsigned int flag_no_powerup:1;
 120
 121         /* Device has a cx25840 - this enables special additional logic to
 122            handle it. */
 123         unsigned int flag_has_cx25840:1;
 124
 125         /* Device has a wm8775 - this enables special additional logic to
 126            ensure that it is found. */
 127         unsigned int flag_has_wm8775:1;
 128
 129         /* Device has IR hardware that can be faked into looking like a
 130            normal Hauppauge i2c IR receiver.  This is currently very
 131            specific to the 24xxx device, where Hauppauge had replaced their
 132            'standard' I2C IR receiver with a bunch of FPGA logic controlled
 133            directly via the FX2.  Turning this on tells the pvrusb2 driver
 134            to virtualize the presence of the non-existant IR receiver chip and
 135            implement the virtual receiver in terms of appropriate FX2
 136            commands. */
 137         unsigned int flag_has_hauppauge_custom_ir:1;
 138
 139         /* These bits define which kinds of sources the device can handle.
 140            Note: Digital tuner presence is inferred by the
 141            digital_control_scheme enumeration. */
 142         unsigned int flag_has_fmradio:1;       /* Has FM radio receiver */
 143         unsigned int flag_has_analogtuner:1;   /* Has analog tuner */
 144         unsigned int flag_has_composite:1;     /* Has composite input */
 145         unsigned int flag_has_svideo:1;        /* Has s-video input */
 146 };
 147
 148 extern struct usb_device_id pvr2_device_table[];
 149
 150 #endif /* __PVRUSB2_HDW_INTERNAL_H */
 151
 152 /*
 153   Stuff for Emacs to see, in order to encourage consistent editing style:
 154   *** Local Variables: ***
 155   *** mode: c ***
 156   *** fill-column: 75 ***
 157   *** tab-width: 8 ***
 158   *** c-basic-offset: 8 ***
 159   *** End: ***
 160   */