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  */
16 #ifndef __PVRUSB2_DEVATTR_H
17 #define __PVRUSB2_DEVATTR_H
18 
19 #include <linux/mod_devicetable.h>
20 #include <linux/videodev2.h>
21 #ifdef CONFIG_VIDEO_PVRUSB2_DVB
22 #include "pvrusb2-dvb.h"
23 #endif
24 
25 /*
26 
27   This header defines structures used to describe attributes of a device.
28 
29 */
30 
31 
32 #define PVR2_CLIENT_ID_NULL 0
33 #define PVR2_CLIENT_ID_MSP3400 1
34 #define PVR2_CLIENT_ID_CX25840 2
35 #define PVR2_CLIENT_ID_SAA7115 3
36 #define PVR2_CLIENT_ID_TUNER 4
37 #define PVR2_CLIENT_ID_CS53L32A 5
38 #define PVR2_CLIENT_ID_WM8775 6
39 #define PVR2_CLIENT_ID_DEMOD 7
40 
41 struct pvr2_device_client_desc {
42 	/* One ovr PVR2_CLIENT_ID_xxxx */
43 	unsigned char module_id;
44 
45 	/* Null-terminated array of I2C addresses to try in order
46 	   initialize the module.  It's safe to make this null terminated
47 	   since we're never going to encounter an i2c device with an
48 	   address of zero.  If this is a null pointer or zero-length,
49 	   then no I2C addresses have been specified, in which case we'll
50 	   try some compiled in defaults for now. */
51 	unsigned char *i2c_address_list;
52 };
53 
54 struct pvr2_device_client_table {
55 	const struct pvr2_device_client_desc *lst;
56 	unsigned char cnt;
57 };
58 
59 
60 struct pvr2_string_table {
61 	const char **lst;
62 	unsigned int cnt;
63 };
64 
65 #define PVR2_ROUTING_SCHEME_HAUPPAUGE 0
66 #define PVR2_ROUTING_SCHEME_GOTVIEW 1
67 #define PVR2_ROUTING_SCHEME_ONAIR 2
68 #define PVR2_ROUTING_SCHEME_AV400 3
69 
70 #define PVR2_DIGITAL_SCHEME_NONE 0
71 #define PVR2_DIGITAL_SCHEME_HAUPPAUGE 1
72 #define PVR2_DIGITAL_SCHEME_ONAIR 2
73 
74 #define PVR2_LED_SCHEME_NONE 0
75 #define PVR2_LED_SCHEME_HAUPPAUGE 1
76 
77 #define PVR2_IR_SCHEME_NONE 0
78 #define PVR2_IR_SCHEME_24XXX 1 /* FX2-controlled IR */
79 #define PVR2_IR_SCHEME_ZILOG 2 /* HVR-1950 style (must be taken out of reset) */
80 #define PVR2_IR_SCHEME_24XXX_MCE 3 /* 24xxx MCE device */
81 #define PVR2_IR_SCHEME_29XXX 4 /* Original 29xxx device */
82 
83 /* This describes a particular hardware type (except for the USB device ID
84    which must live in a separate structure due to environmental
85    constraints).  See the top of pvrusb2-hdw.c for where this is
86    instantiated. */
87 struct pvr2_device_desc {
88 	/* Single line text description of hardware */
89 	const char *description;
90 
91 	/* Single token identifier for hardware */
92 	const char *shortname;
93 
94 	/* List of additional client modules we need to load */
95 	struct pvr2_string_table client_modules;
96 
97 	/* List of defined client modules we need to load */
98 	struct pvr2_device_client_table client_table;
99 
100 	/* List of FX2 firmware file names we should search; if empty then
101 	   FX2 firmware check / load is skipped and we assume the device
102 	   was initialized from internal ROM. */
103 	struct pvr2_string_table fx2_firmware;
104 
105 #ifdef CONFIG_VIDEO_PVRUSB2_DVB
106 	/* callback functions to handle attachment of digital tuner & demod */
107 	const struct pvr2_dvb_props *dvb_props;
108 
109 #endif
110 	/* Initial standard bits to use for this device, if not zero.
111 	   Anything set here is also implied as an available standard.
112 	   Note: This is ignored if overridden on the module load line via
113 	   the video_std module option. */
114 	v4l2_std_id default_std_mask;
115 
116 	/* V4L tuner type ID to use with this device (only used if the
117 	   driver could not discover the type any other way). */
118 	int default_tuner_type;
119 
120 	/* Signal routing scheme used by device, contains one of
121 	   PVR2_ROUTING_SCHEME_XXX.  Schemes have to be defined as we
122 	   encounter them.  This is an arbitrary integer scheme id; its
123 	   meaning is contained entirely within the driver and is
124 	   interpreted by logic which must send commands to the chip-level
125 	   drivers (search for things which touch this field). */
126 	unsigned char signal_routing_scheme;
127 
128 	/* Indicates scheme for controlling device's LED (if any).  The
129 	   driver will turn on the LED when streaming is underway.  This
130 	   contains one of PVR2_LED_SCHEME_XXX. */
131 	unsigned char led_scheme;
132 
133 	/* Control scheme to use if there is a digital tuner.  This
134 	   contains one of PVR2_DIGITAL_SCHEME_XXX.  This is an arbitrary
135 	   integer scheme id; its meaning is contained entirely within the
136 	   driver and is interpreted by logic which must control the
137 	   streaming pathway (search for things which touch this field). */
138 	unsigned char digital_control_scheme;
139 
140 	/* If set, we don't bother trying to load cx23416 firmware. */
141 	unsigned int flag_skip_cx23416_firmware:1;
142 
143 	/* If set, the encoder must be healthy in order for digital mode to
144 	   work (otherwise we assume that digital streaming will work even
145 	   if we fail to locate firmware for the encoder).  If the device
146 	   doesn't support digital streaming then this flag has no
147 	   effect. */
148 	unsigned int flag_digital_requires_cx23416:1;
149 
150 	/* Device has a hauppauge eeprom which we can interrogate. */
151 	unsigned int flag_has_hauppauge_rom:1;
152 
153 	/* Device does not require a powerup command to be issued. */
154 	unsigned int flag_no_powerup:1;
155 
156 	/* Device has a cx25840 - this enables special additional logic to
157 	   handle it. */
158 	unsigned int flag_has_cx25840:1;
159 
160 	/* Device has a wm8775 - this enables special additional logic to
161 	   ensure that it is found. */
162 	unsigned int flag_has_wm8775:1;
163 
164 	/* Indicate IR scheme of hardware.  If not set, then it is assumed
165 	   that IR can work without any help from the driver. */
166 	unsigned int ir_scheme:3;
167 
168 	/* These bits define which kinds of sources the device can handle.
169 	   Note: Digital tuner presence is inferred by the
170 	   digital_control_scheme enumeration. */
171 	unsigned int flag_has_fmradio:1;       /* Has FM radio receiver */
172 	unsigned int flag_has_analogtuner:1;   /* Has analog tuner */
173 	unsigned int flag_has_composite:1;     /* Has composite input */
174 	unsigned int flag_has_svideo:1;        /* Has s-video input */
175 	unsigned int flag_fx2_16kb:1;          /* 16KB FX2 firmware OK here */
176 
177 	/* If this driver is considered experimental, i.e. not all aspects
178 	   are working correctly and/or it is untested, mark that fact
179 	   with this flag. */
180 	unsigned int flag_is_experimental:1;
181 };
182 
183 extern struct usb_device_id pvr2_device_table[];
184 
185 #endif /* __PVRUSB2_HDW_INTERNAL_H */
186