blob: cc2c4d78cf41ff421849335922c455f6e3a0798c [file] [log] [blame]
Mike Isely989eb152007-11-26 01:53:12 -03001/*
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>
Mike Isely6a540252007-12-02 23:51:34 -030025#include <linux/videodev2.h>
Michael Krufky04910bd2008-02-03 23:46:16 -030026#include "pvrusb2-dvb.h"
Mike Isely989eb152007-11-26 01:53:12 -030027
28/*
29
30 This header defines structures used to describe attributes of a device.
31
32*/
33
34
35struct pvr2_string_table {
36 const char **lst;
37 unsigned int cnt;
38};
39
Mike Iselyf5174af2007-11-26 02:07:26 -030040#define PVR2_ROUTING_SCHEME_HAUPPAUGE 0
Mike Isely9e2e3ae2007-11-26 02:14:23 -030041#define PVR2_ROUTING_SCHEME_GOTVIEW 1
Mike Isely989eb152007-11-26 01:53:12 -030042
Mike Iselye8f5bac2008-04-22 14:45:40 -030043#define PVR2_DIGITAL_SCHEME_NONE 0
44#define PVR2_DIGITAL_SCHEME_HAUPPAUGE 1
45#define PVR2_DIGITAL_SCHEME_ONAIR 2
46
Mike Isely40381cb2008-04-22 14:45:42 -030047#define PVR2_LED_SCHEME_NONE 0
48#define PVR2_LED_SCHEME_HAUPPAUGE 1
49
Mike Isely989eb152007-11-26 01:53:12 -030050/* This describes a particular hardware type (except for the USB device ID
51 which must live in a separate structure due to environmental
52 constraints). See the top of pvrusb2-hdw.c for where this is
53 instantiated. */
54struct pvr2_device_desc {
55 /* Single line text description of hardware */
56 const char *description;
57
58 /* Single token identifier for hardware */
59 const char *shortname;
60
61 /* List of additional client modules we need to load */
62 struct pvr2_string_table client_modules;
63
64 /* List of FX2 firmware file names we should search; if empty then
65 FX2 firmware check / load is skipped and we assume the device
66 was initialized from internal ROM. */
67 struct pvr2_string_table fx2_firmware;
68
Michael Krufky04910bd2008-02-03 23:46:16 -030069 /* callback functions to handle attachment of digital tuner & demod */
70 struct pvr2_dvb_props *dvb_props;
71
Mike Isely6a540252007-12-02 23:51:34 -030072 /* Initial standard bits to use for this device, if not zero.
73 Anything set here is also implied as an available standard.
74 Note: This is ignored if overridden on the module load line via
75 the video_std module option. */
76 v4l2_std_id default_std_mask;
77
Mike Isely5fd782a2008-04-22 14:45:42 -030078 /* V4L tuner type ID to use with this device (only used if the
79 driver could not discover the type any other way). */
80 int default_tuner_type;
81
82 /* Signal routing scheme used by device, contains one of
83 PVR2_ROUTING_SCHEME_XXX. Schemes have to be defined as we
84 encounter them. This is an arbitrary integer scheme id; its
85 meaning is contained entirely within the driver and is
86 interpreted by logic which must send commands to the chip-level
87 drivers (search for things which touch this field). */
88 unsigned char signal_routing_scheme;
89
90 /* Indicates scheme for controlling device's LED (if any). The
91 driver will turn on the LED when streaming is underway. This
92 contains one of PVR2_LED_SCHEME_XXX. */
93 unsigned char led_scheme;
94
95 /* Control scheme to use if there is a digital tuner. This
96 contains one of PVR2_DIGITAL_SCHEME_XXX. This is an arbitrary
97 integer scheme id; its meaning is contained entirely within the
98 driver and is interpreted by logic which must control the
99 streaming pathway (search for things which touch this field). */
100 unsigned char digital_control_scheme;
101
Mike Isely989eb152007-11-26 01:53:12 -0300102 /* If set, we don't bother trying to load cx23416 firmware. */
Mike Isely5fd782a2008-04-22 14:45:42 -0300103 int flag_skip_cx23416_firmware:1;
Mike Isely989eb152007-11-26 01:53:12 -0300104
Mike Iselyaaf78842007-11-26 02:04:11 -0300105 /* Device has a hauppauge eeprom which we can interrogate. */
Mike Isely5fd782a2008-04-22 14:45:42 -0300106 int flag_has_hauppauge_rom:1;
Mike Iselyaaf78842007-11-26 02:04:11 -0300107
Mike Isely989eb152007-11-26 01:53:12 -0300108 /* Device does not require a powerup command to be issued. */
Mike Isely5fd782a2008-04-22 14:45:42 -0300109 int flag_no_powerup:1;
Mike Isely989eb152007-11-26 01:53:12 -0300110
111 /* Device has a cx25840 - this enables special additional logic to
112 handle it. */
Mike Isely5fd782a2008-04-22 14:45:42 -0300113 int flag_has_cx25840:1;
Mike Isely989eb152007-11-26 01:53:12 -0300114
115 /* Device has a wm8775 - this enables special additional logic to
116 ensure that it is found. */
Mike Isely5fd782a2008-04-22 14:45:42 -0300117 int flag_has_wm8775:1;
Mike Isely056d1a82007-11-26 02:09:42 -0300118
119 /* Device has IR hardware that can be faked into looking like a
Mike Isely4ca7f702007-12-03 01:45:26 -0300120 normal Hauppauge i2c IR receiver. This is currently very
121 specific to the 24xxx device, where Hauppauge had replaced their
122 'standard' I2C IR receiver with a bunch of FPGA logic controlled
123 directly via the FX2. Turning this on tells the pvrusb2 driver
124 to virtualize the presence of the non-existant IR receiver chip and
125 implement the virtual receiver in terms of appropriate FX2
126 commands. */
Mike Isely5fd782a2008-04-22 14:45:42 -0300127 int flag_has_hauppauge_custom_ir:1;
Mike Iselyd068c6e2008-04-22 14:45:36 -0300128
Mike Iselye8f5bac2008-04-22 14:45:40 -0300129 /* These bits define which kinds of sources the device can handle.
130 Note: Digital tuner presence is inferred by the
131 digital_control_scheme enumeration. */
Mike Isely5fd782a2008-04-22 14:45:42 -0300132 int flag_has_fmradio:1; /* Has FM radio receiver */
133 int flag_has_analogtuner:1; /* Has analog tuner */
134 int flag_has_composite:1; /* Has composite input */
135 int flag_has_svideo:1; /* Has s-video input */
Mike Isely989eb152007-11-26 01:53:12 -0300136};
137
Mike Isely989eb152007-11-26 01:53:12 -0300138extern struct usb_device_id pvr2_device_table[];
Mike Isely989eb152007-11-26 01:53:12 -0300139
140#endif /* __PVRUSB2_HDW_INTERNAL_H */
141
142/*
143 Stuff for Emacs to see, in order to encourage consistent editing style:
144 *** Local Variables: ***
145 *** mode: c ***
146 *** fill-column: 75 ***
147 *** tab-width: 8 ***
148 *** c-basic-offset: 8 ***
149 *** End: ***
150 */