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