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