xref: /openbmc/linux/include/media/tuner.h (revision b830f94f)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * tuner.h - definition for different tuners
4  *
5  * Copyright (C) 1997 Markus Schroeder (schroedm@uni-duesseldorf.de)
6  * minor modifications by Ralph Metzler (rjkm@thp.uni-koeln.de)
7  */
8 
9 #ifndef _TUNER_H
10 #define _TUNER_H
11 #ifdef __KERNEL__
12 
13 #include <linux/videodev2.h>
14 #include <media/v4l2-mc.h>
15 
16 #define ADDR_UNSET (255)
17 
18 #define TUNER_TEMIC_PAL			0        /* 4002 FH5 (3X 7756, 9483) */
19 #define TUNER_PHILIPS_PAL_I		1
20 #define TUNER_PHILIPS_NTSC		2
21 #define TUNER_PHILIPS_SECAM		3	/* you must actively select B/G, L, L` */
22 
23 #define TUNER_ABSENT			4
24 #define TUNER_PHILIPS_PAL		5
25 #define TUNER_TEMIC_NTSC		6	/* 4032 FY5 (3X 7004, 9498, 9789)  */
26 #define TUNER_TEMIC_PAL_I		7	/* 4062 FY5 (3X 8501, 9957) */
27 
28 #define TUNER_TEMIC_4036FY5_NTSC	8	/* 4036 FY5 (3X 1223, 1981, 7686) */
29 #define TUNER_ALPS_TSBH1_NTSC		9
30 #define TUNER_ALPS_TSBE1_PAL		10
31 #define TUNER_ALPS_TSBB5_PAL_I		11
32 
33 #define TUNER_ALPS_TSBE5_PAL		12
34 #define TUNER_ALPS_TSBC5_PAL		13
35 #define TUNER_TEMIC_4006FH5_PAL		14	/* 4006 FH5 (3X 9500, 9501, 7291) */
36 #define TUNER_ALPS_TSHC6_NTSC		15
37 
38 #define TUNER_TEMIC_PAL_DK		16	/* 4016 FY5 (3X 1392, 1393) */
39 #define TUNER_PHILIPS_NTSC_M		17
40 #define TUNER_TEMIC_4066FY5_PAL_I	18	/* 4066 FY5 (3X 7032, 7035) */
41 #define TUNER_TEMIC_4006FN5_MULTI_PAL	19	/* B/G, I and D/K autodetected (3X 7595, 7606, 7657) */
42 
43 #define TUNER_TEMIC_4009FR5_PAL		20	/* incl. FM radio (3X 7607, 7488, 7711) */
44 #define TUNER_TEMIC_4039FR5_NTSC	21	/* incl. FM radio (3X 7246, 7578, 7732) */
45 #define TUNER_TEMIC_4046FM5		22	/* you must actively select B/G, D/K, I, L, L` !  (3X 7804, 7806, 8103, 8104) */
46 #define TUNER_PHILIPS_PAL_DK		23
47 
48 #define TUNER_PHILIPS_FQ1216ME		24	/* you must actively select B/G/D/K, I, L, L` */
49 #define TUNER_LG_PAL_I_FM		25
50 #define TUNER_LG_PAL_I			26
51 #define TUNER_LG_NTSC_FM		27
52 
53 #define TUNER_LG_PAL_FM			28
54 #define TUNER_LG_PAL			29
55 #define TUNER_TEMIC_4009FN5_MULTI_PAL_FM 30	/* B/G, I and D/K autodetected (3X 8155, 8160, 8163) */
56 #define TUNER_SHARP_2U5JF5540_NTSC	31
57 
58 #define TUNER_Samsung_PAL_TCPM9091PD27	32
59 #define TUNER_MT2032			33
60 #define TUNER_TEMIC_4106FH5		34	/* 4106 FH5 (3X 7808, 7865) */
61 #define TUNER_TEMIC_4012FY5		35	/* 4012 FY5 (3X 0971, 1099) */
62 
63 #define TUNER_TEMIC_4136FY5		36	/* 4136 FY5 (3X 7708, 7746) */
64 #define TUNER_LG_PAL_NEW_TAPC		37
65 #define TUNER_PHILIPS_FM1216ME_MK3	38
66 #define TUNER_LG_NTSC_NEW_TAPC		39
67 
68 #define TUNER_HITACHI_NTSC		40
69 #define TUNER_PHILIPS_PAL_MK		41
70 #define TUNER_PHILIPS_FCV1236D		42
71 #define TUNER_PHILIPS_FM1236_MK3	43
72 
73 #define TUNER_PHILIPS_4IN1		44	/* ATI TV Wonder Pro - Conexant */
74 	/*
75 	 * Microtune merged with Temic 12/31/1999 partially financed by Alps.
76 	 * these may be similar to Temic
77 	 */
78 #define TUNER_MICROTUNE_4049FM5		45
79 #define TUNER_PANASONIC_VP27		46
80 #define TUNER_LG_NTSC_TAPE		47
81 
82 #define TUNER_TNF_8831BGFF		48
83 #define TUNER_MICROTUNE_4042FI5		49	/* DViCO FusionHDTV 3 Gold-Q - 4042 FI5 (3X 8147) */
84 #define TUNER_TCL_2002N			50
85 #define TUNER_PHILIPS_FM1256_IH3	51
86 
87 #define TUNER_THOMSON_DTT7610		52
88 #define TUNER_PHILIPS_FQ1286		53
89 #define TUNER_PHILIPS_TDA8290		54
90 #define TUNER_TCL_2002MB		55	/* Hauppauge PVR-150 PAL */
91 
92 #define TUNER_PHILIPS_FQ1216AME_MK4	56	/* Hauppauge PVR-150 PAL */
93 #define TUNER_PHILIPS_FQ1236A_MK4	57	/* Hauppauge PVR-500MCE NTSC */
94 #define TUNER_YMEC_TVF_8531MF		58
95 #define TUNER_YMEC_TVF_5533MF		59	/* Pixelview Pro Ultra NTSC */
96 
97 #define TUNER_THOMSON_DTT761X		60	/* DTT 7611 7611A 7612 7613 7613A 7614 7615 7615A */
98 #define TUNER_TENA_9533_DI		61
99 #define TUNER_TEA5767			62	/* Only FM Radio Tuner */
100 #define TUNER_PHILIPS_FMD1216ME_MK3	63
101 
102 #define TUNER_LG_TDVS_H06XF		64	/* TDVS H061F, H062F, H064F */
103 #define TUNER_YMEC_TVF66T5_B_DFF	65	/* Acorp Y878F */
104 #define TUNER_LG_TALN			66
105 #define TUNER_PHILIPS_TD1316		67
106 
107 #define TUNER_PHILIPS_TUV1236D		68	/* ATI HDTV Wonder */
108 #define TUNER_TNF_5335MF                69	/* Sabrent Bt848   */
109 #define TUNER_SAMSUNG_TCPN_2121P30A     70	/* Hauppauge PVR-500MCE NTSC */
110 #define TUNER_XC2028			71
111 
112 #define TUNER_THOMSON_FE6600		72	/* DViCO FusionHDTV DVB-T Hybrid */
113 #define TUNER_SAMSUNG_TCPG_6121P30A     73	/* Hauppauge PVR-500 PAL */
114 #define TUNER_TDA9887                   74      /* This tuner should be used only internally */
115 #define TUNER_TEA5761			75	/* Only FM Radio Tuner */
116 #define TUNER_XC5000			76	/* Xceive Silicon Tuner */
117 #define TUNER_TCL_MF02GIP_5N		77	/* TCL MF02GIP_5N */
118 #define TUNER_PHILIPS_FMD1216MEX_MK3	78
119 #define TUNER_PHILIPS_FM1216MK5		79
120 #define TUNER_PHILIPS_FQ1216LME_MK3	80	/* Active loopthrough, no FM */
121 
122 #define TUNER_PARTSNIC_PTI_5NF05	81
123 #define TUNER_PHILIPS_CU1216L           82
124 #define TUNER_NXP_TDA18271		83
125 #define TUNER_SONY_BTF_PXN01Z		84
126 #define TUNER_PHILIPS_FQ1236_MK5	85	/* NTSC, TDA9885, no FM radio */
127 #define TUNER_TENA_TNF_5337		86
128 
129 #define TUNER_XC4000			87	/* Xceive Silicon Tuner */
130 #define TUNER_XC5000C			88	/* Xceive Silicon Tuner */
131 
132 #define TUNER_SONY_BTF_PG472Z		89	/* PAL+SECAM */
133 #define TUNER_SONY_BTF_PK467Z		90	/* NTSC_JP */
134 #define TUNER_SONY_BTF_PB463Z		91	/* NTSC */
135 
136 /* tv card specific */
137 #define TDA9887_PRESENT			(1<<0)
138 #define TDA9887_PORT1_INACTIVE		(1<<1)
139 #define TDA9887_PORT2_INACTIVE		(1<<2)
140 #define TDA9887_QSS			(1<<3)
141 #define TDA9887_INTERCARRIER		(1<<4)
142 #define TDA9887_PORT1_ACTIVE		(1<<5)
143 #define TDA9887_PORT2_ACTIVE		(1<<6)
144 #define TDA9887_INTERCARRIER_NTSC	(1<<7)
145 /* Tuner takeover point adjustment, in dB, -16 <= top <= 15 */
146 #define TDA9887_TOP_MASK		(0x3f << 8)
147 #define TDA9887_TOP_SET			(1 << 13)
148 #define TDA9887_TOP(top)		(TDA9887_TOP_SET | \
149 					 (((16 + (top)) & 0x1f) << 8))
150 
151 /* config options */
152 #define TDA9887_DEEMPHASIS_MASK		(3<<16)
153 #define TDA9887_DEEMPHASIS_NONE		(1<<16)
154 #define TDA9887_DEEMPHASIS_50		(2<<16)
155 #define TDA9887_DEEMPHASIS_75		(3<<16)
156 #define TDA9887_AUTOMUTE		(1<<18)
157 #define TDA9887_GATING_18		(1<<19)
158 #define TDA9887_GAIN_NORMAL		(1<<20)
159 #define TDA9887_RIF_41_3		(1<<21)  /* radio IF1 41.3 vs 33.3 */
160 
161 /**
162  * enum tuner_mode      - Mode of the tuner
163  *
164  * @T_RADIO:        Tuner core will work in radio mode
165  * @T_ANALOG_TV:    Tuner core will work in analog TV mode
166  *
167  * Older boards only had a single tuner device, but some devices have a
168  * separate tuner for radio. In any case, the tuner-core needs to know if
169  * the tuner chip(s) will be used in radio mode or analog TV mode, as, on
170  * radio mode, frequencies are specified on a different range than on TV
171  * mode. This enum is used by the tuner core in order to work with the
172  * proper tuner range and eventually use a different tuner chip while in
173  * radio mode.
174  */
175 enum tuner_mode {
176 	T_RADIO		= 1 << V4L2_TUNER_RADIO,
177 	T_ANALOG_TV     = 1 << V4L2_TUNER_ANALOG_TV,
178 	/* Don't map V4L2_TUNER_DIGITAL_TV, as tuner-core won't use it */
179 };
180 
181 /**
182  * struct tuner_setup   - setup the tuner chipsets
183  *
184  * @addr:		I2C address used to control the tuner device/chipset
185  * @type:		Type of the tuner, as defined at the TUNER_* macros.
186  *			Each different tuner model should have an unique
187  *			identifier.
188  * @mode_mask:		Mask with the allowed tuner modes: V4L2_TUNER_RADIO,
189  *			V4L2_TUNER_ANALOG_TV and/or V4L2_TUNER_DIGITAL_TV,
190  *			describing if the tuner should be used to support
191  *			Radio, analog TV and/or digital TV.
192  * @config:		Used to send tuner-specific configuration for complex
193  *			tuners that require extra parameters to be set.
194  *			Only a very few tuners require it and its usage on
195  *			newer tuners should be avoided.
196  * @tuner_callback:	Some tuners require to call back the bridge driver,
197  *			in order to do some tasks like rising a GPIO at the
198  *			bridge chipset, in order to do things like resetting
199  *			the device.
200  *
201  * Older boards only had a single tuner device. Nowadays multiple tuner
202  * devices may be present on a single board. Using TUNER_SET_TYPE_ADDR
203  * to pass the tuner_setup structure it is possible to setup each tuner
204  * device in turn.
205  *
206  * Since multiple devices may be present it is no longer sufficient to
207  * send a command to a single i2c device. Instead you should broadcast
208  * the command to all i2c devices.
209  *
210  * By setting the mode_mask correctly you can select which commands are
211  * accepted by a specific tuner device. For example, set mode_mask to
212  * T_RADIO if the device is a radio-only tuner. That specific tuner will
213  * only accept commands when the tuner is in radio mode and ignore them
214  * when the tuner is set to TV mode.
215  */
216 
217 struct tuner_setup {
218 	unsigned short	addr;
219 	unsigned int	type;
220 	unsigned int	mode_mask;
221 	void		*config;
222 	int (*tuner_callback)(void *dev, int component, int cmd, int arg);
223 };
224 
225 #endif /* __KERNEL__ */
226 
227 #endif /* _TUNER_H */
228