xref: /freebsd-12.1/sys/dev/bktr/bktr_reg.h (revision b7841bd0)
1 /*-
2  * $FreeBSD$
3  *
4  * SPDX-License-Identifier: BSD-4-Clause
5  *
6  * Copyright (c) 1999 Roger Hardiman
7  * Copyright (c) 1998 Amancio Hasty
8  * Copyright (c) 1995 Mark Tinguely and Jim Lowe
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by Mark Tinguely and Jim Lowe
22  * 4. The name of the author may not be used to endorse or promote products
23  *    derived from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
27  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
29  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
31  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
33  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  *
37  */
38 
39 #ifdef __NetBSD__
40 #include <machine/bus.h>		/* device_t */
41 #include <sys/device.h>
42 #include <sys/select.h>			/* struct selinfo */
43 # ifdef DEBUG
44 #  define	bootverbose 1
45 # else
46 #  define	bootverbose 0
47 # endif
48 #endif
49 
50 /*
51  * The kernel options for the driver now all begin with BKTR.
52  * Support the older kernel options on FreeBSD and OpenBSD.
53  *
54  */
55 #if defined(__FreeBSD__) || defined(__OpenBSD__)
56 #if defined(BROOKTREE_ALLOC_PAGES)
57 #define BKTR_ALLOC_PAGES BROOKTREE_ALLOC_PAGES
58 #endif
59 
60 #if defined(BROOKTREE_SYSTEM_DEFAULT)
61 #define BKTR_SYSTEM_DEFAULT BROOKTREE_SYSTEM_DEFAULT
62 #endif
63 
64 #if defined(OVERRIDE_CARD)
65 #define BKTR_OVERRIDE_CARD OVERRIDE_CARD
66 #endif
67 
68 #if defined(OVERRIDE_TUNER)
69 #define BKTR_OVERRIDE_TUNER OVERRIDE_TUNER
70 #endif
71 
72 #if defined(OVERRIDE_DBX)
73 #define BKTR_OVERRIDE_DBX OVERRIDE_DBX
74 #endif
75 
76 #if defined(OVERRIDE_MSP)
77 #define BKTR_OVERRIDE_MSP OVERRIDE_MSP
78 #endif
79 
80 #endif
81 
82 
83 #ifndef PCI_LATENCY_TIMER
84 #define	PCI_LATENCY_TIMER		0x0c	/* pci timer register */
85 #endif
86 
87 /*
88  * Definitions for the Brooktree 848/878 video capture to pci interface.
89  */
90 #ifndef __NetBSD__
91 #define BKTR_PCI_VENDOR_SHIFT                        0
92 #define BKTR_PCI_VENDOR_MASK                         0xffff
93 #define BKTR_PCI_VENDOR(id) \
94             (((id) >> BKTR_PCI_VENDOR_SHIFT) & BKTR_PCI_VENDOR_MASK)
95 
96 #define BKTR_PCI_PRODUCT_SHIFT                       16
97 #define BKTR_PCI_PRODUCT_MASK                        0xffff
98 #define BKTR_PCI_PRODUCT(id) \
99             (((id) >> BKTR_PCI_PRODUCT_SHIFT) & BKTR_PCI_PRODUCT_MASK)
100 
101 /* PCI vendor ID */
102 #define PCI_VENDOR_BROOKTREE    0x109e                /* Brooktree */
103 /* Brooktree products */
104 #define PCI_PRODUCT_BROOKTREE_BT848     0x0350        /* Bt848 Video Capture */
105 #define PCI_PRODUCT_BROOKTREE_BT849     0x0351        /* Bt849 Video Capture */
106 #define PCI_PRODUCT_BROOKTREE_BT878     0x036e        /* Bt878 Video Capture */
107 #define PCI_PRODUCT_BROOKTREE_BT879     0x036f        /* Bt879 Video Capture */
108 #endif
109 
110 #define BROOKTREE_848                   1
111 #define BROOKTREE_848A                  2
112 #define BROOKTREE_849A                  3
113 #define BROOKTREE_878                   4
114 #define BROOKTREE_879                   5
115 
116 typedef volatile u_int 	bregister_t;
117 /*
118  * if other persuasion endian, then compiler will probably require that
119  * these next
120  * macros be reversed
121  */
122 #define	BTBYTE(what)	bregister_t  what:8; int :24
123 #define	BTWORD(what)	bregister_t  what:16; int: 16
124 #define BTLONG(what)	bregister_t  what:32
125 
126 struct bt848_registers {
127     BTBYTE (dstatus);		/* 0, 1,2,3 */
128 #define BT848_DSTATUS_PRES		(1<<7)
129 #define BT848_DSTATUS_HLOC		(1<<6)
130 #define BT848_DSTATUS_FIELD		(1<<5)
131 #define BT848_DSTATUS_NUML		(1<<4)
132 #define BT848_DSTATUS_CSEL		(1<<3)
133 #define BT848_DSTATUS_PLOCK		(1<<2)
134 #define BT848_DSTATUS_LOF		(1<<1)
135 #define BT848_DSTATUS_COF		(1<<0)
136     BTBYTE (iform);		/* 4, 5,6,7 */
137 #define BT848_IFORM_MUXSEL		(0x3<<5)
138 # define BT848_IFORM_M_MUX1		(0x03<<5)
139 # define BT848_IFORM_M_MUX0		(0x02<<5)
140 # define BT848_IFORM_M_MUX2		(0x01<<5)
141 # define BT848_IFORM_M_MUX3		(0x0)
142 # define BT848_IFORM_M_RSVD		(0x00<<5)
143 #define BT848_IFORM_XTSEL		(0x3<<3)
144 # define BT848_IFORM_X_AUTO		(0x03<<3)
145 # define BT848_IFORM_X_XT1		(0x02<<3)
146 # define BT848_IFORM_X_XT0		(0x01<<3)
147 # define BT848_IFORM_X_RSVD		(0x00<<3)
148     BTBYTE (tdec);		/* 8, 9,a,b */
149     BTBYTE (e_crop);		/* c, d,e,f */
150     BTBYTE (e_vdelay_lo);	/* 10, 11,12,13 */
151     BTBYTE (e_vactive_lo);	/* 14, 15,16,17 */
152     BTBYTE (e_delay_lo);	/* 18, 19,1a,1b */
153     BTBYTE (e_hactive_lo);	/* 1c, 1d,1e,1f */
154     BTBYTE (e_hscale_hi);	/* 20, 21,22,23 */
155     BTBYTE (e_hscale_lo);	/* 24, 25,26,27 */
156     BTBYTE (bright);		/* 28, 29,2a,2b */
157     BTBYTE (e_control);		/* 2c, 2d,2e,2f */
158 #define BT848_E_CONTROL_LNOTCH		(1<<7)
159 #define BT848_E_CONTROL_COMP		(1<<6)
160 #define BT848_E_CONTROL_LDEC		(1<<5)
161 #define BT848_E_CONTROL_CBSENSE		(1<<4)
162 #define BT848_E_CONTROL_RSVD		(1<<3)
163 #define BT848_E_CONTROL_CON_MSB		(1<<2)
164 #define BT848_E_CONTROL_SAT_U_MSB	(1<<1)
165 #define BT848_E_CONTROL_SAT_V_MSB	(1<<0)
166     BTBYTE (contrast_lo);	/* 30, 31,32,33 */
167     BTBYTE (sat_u_lo);		/* 34, 35,36,37 */
168     BTBYTE (sat_v_lo);		/* 38, 39,3a,3b */
169     BTBYTE (hue);		/* 3c, 3d,3e,3f */
170     BTBYTE (e_scloop);		/* 40, 41,42,43 */
171 #define BT848_E_SCLOOP_RSVD1		(1<<7)
172 #define BT848_E_SCLOOP_CAGC		(1<<6)
173 #define BT848_E_SCLOOP_CKILL		(1<<5)
174 #define BT848_E_SCLOOP_HFILT		(0x3<<3)
175 # define BT848_E_SCLOOP_HFILT_ICON	(0x3<<3)
176 # define BT848_E_SCLOOP_HFILT_QCIF	(0x2<<3)
177 # define BT848_E_SCLOOP_HFILT_CIF	(0x1<<3)
178 # define BT848_E_SCLOOP_HFILT_AUTO	(0x0<<3)
179 #define BT848_E_SCLOOP_RSVD0		(0x7<<0)
180     int		:32;		/* 44, 45,46,47 */
181     BTBYTE (oform);		/* 48, 49,4a,4b */
182     BTBYTE (e_vscale_hi);	/* 4c, 4d,4e,4f */
183     BTBYTE (e_vscale_lo);	/* 50, 51,52,53 */
184     BTBYTE (test);		/* 54, 55,56,57 */
185     int		:32;		/* 58, 59,5a,5b */
186     int		:32;		/* 5c, 5d,5e,5f */
187     BTLONG (adelay);		/* 60, 61,62,63 */
188     BTBYTE (bdelay);		/* 64, 65,66,67 */
189     BTBYTE (adc);		/* 68, 69,6a,6b */
190 #define BT848_ADC_RESERVED		(0x80)	/* required pattern */
191 #define BT848_ADC_SYNC_T		(1<<5)
192 #define BT848_ADC_AGC_EN		(1<<4)
193 #define BT848_ADC_CLK_SLEEP		(1<<3)
194 #define BT848_ADC_Y_SLEEP		(1<<2)
195 #define BT848_ADC_C_SLEEP		(1<<1)
196 #define BT848_ADC_CRUSH			(1<<0)
197     BTBYTE (e_vtc);		/* 6c, 6d,6e,6f */
198     int		:32;		/* 70, 71,72,73 */
199     int 	:32;		/* 74, 75,76,77 */
200     int		:32;		/* 78, 79,7a,7b */
201     BTLONG (sreset);		/* 7c, 7d,7e,7f */
202     u_char 	filler1[0x84-0x80];
203     BTBYTE (tgctrl);		/* 84, 85,86,87 */
204 #define BT848_TGCTRL_TGCKI		(3<<3)
205 #define BT848_TGCTRL_TGCKI_XTAL		(0<<3)
206 #define BT848_TGCTRL_TGCKI_PLL		(1<<3)
207 #define BT848_TGCTRL_TGCKI_GPCLK	(2<<3)
208 #define BT848_TGCTRL_TGCKI_GPCLK_I	(3<<3)
209     u_char 	filler[0x8c-0x88];
210     BTBYTE (o_crop);		/* 8c, 8d,8e,8f */
211     BTBYTE (o_vdelay_lo);	/* 90, 91,92,93 */
212     BTBYTE (o_vactive_lo);	/* 94, 95,96,97 */
213     BTBYTE (o_delay_lo);	/* 98, 99,9a,9b */
214     BTBYTE (o_hactive_lo);	/* 9c, 9d,9e,9f */
215     BTBYTE (o_hscale_hi);	/* a0, a1,a2,a3 */
216     BTBYTE (o_hscale_lo);	/* a4, a5,a6,a7 */
217     int		:32;		/* a8, a9,aa,ab */
218     BTBYTE (o_control);		/* ac, ad,ae,af */
219 #define BT848_O_CONTROL_LNOTCH		(1<<7)
220 #define BT848_O_CONTROL_COMP		(1<<6)
221 #define BT848_O_CONTROL_LDEC		(1<<5)
222 #define BT848_O_CONTROL_CBSENSE		(1<<4)
223 #define BT848_O_CONTROL_RSVD		(1<<3)
224 #define BT848_O_CONTROL_CON_MSB		(1<<2)
225 #define BT848_O_CONTROL_SAT_U_MSB	(1<<1)
226 #define BT848_O_CONTROL_SAT_V_MSB	(1<<0)
227     u_char	fillter4[16];
228     BTBYTE (o_scloop);		/* c0, c1,c2,c3 */
229 #define BT848_O_SCLOOP_RSVD1		(1<<7)
230 #define BT848_O_SCLOOP_CAGC		(1<<6)
231 #define BT848_O_SCLOOP_CKILL		(1<<5)
232 #define BT848_O_SCLOOP_HFILT		(0x3<<3)
233 #define BT848_O_SCLOOP_HFILT_ICON	(0x3<<3)
234 #define BT848_O_SCLOOP_HFILT_QCIF	(0x2<<3)
235 #define BT848_O_SCLOOP_HFILT_CIF	(0x1<<3)
236 #define BT848_O_SCLOOP_HFILT_AUTO	(0x0<<3)
237 #define BT848_O_SCLOOP_RSVD0		(0x7<<0)
238     int		:32;		/* c4, c5,c6,c7 */
239     int		:32;		/* c8, c9,ca,cb */
240     BTBYTE (o_vscale_hi);	/* cc, cd,ce,cf */
241     BTBYTE (o_vscale_lo);	/* d0, d1,d2,d3 */
242     BTBYTE (color_fmt);		/* d4, d5,d6,d7 */
243     bregister_t color_ctl_swap		:4; /* d8 */
244 #define BT848_COLOR_CTL_WSWAP_ODD	(1<<3)
245 #define BT848_COLOR_CTL_WSWAP_EVEN	(1<<2)
246 #define BT848_COLOR_CTL_BSWAP_ODD	(1<<1)
247 #define BT848_COLOR_CTL_BSWAP_EVEN	(1<<0)
248     bregister_t color_ctl_gamma		:1;
249     bregister_t color_ctl_rgb_ded	:1;
250     bregister_t color_ctl_color_bars	:1;
251     bregister_t color_ctl_ext_frmrate	:1;
252 #define BT848_COLOR_CTL_GAMMA		(1<<4)
253 #define BT848_COLOR_CTL_RGB_DED		(1<<5)
254 #define BT848_COLOR_CTL_COLOR_BARS	(1<<6)
255 #define BT848_COLOR_CTL_EXT_FRMRATE     (1<<7)
256     int		:24;		/* d9,da,db */
257     BTBYTE (cap_ctl);		/* dc, dd,de,df */
258 #define BT848_CAP_CTL_DITH_FRAME	(1<<4)
259 #define BT848_CAP_CTL_VBI_ODD		(1<<3)
260 #define BT848_CAP_CTL_VBI_EVEN		(1<<2)
261 #define BT848_CAP_CTL_ODD		(1<<1)
262 #define BT848_CAP_CTL_EVEN		(1<<0)
263     BTBYTE (vbi_pack_size);	/* e0, e1,e2,e3 */
264     BTBYTE (vbi_pack_del);	/* e4, e5,e6,e7 */
265     int		:32;		/* e8, e9,ea,eb */
266     BTBYTE (o_vtc);		/* ec, ed,ee,ef */
267     BTBYTE (pll_f_lo);		/* f0, f1,f2,f3 */
268     BTBYTE (pll_f_hi);		/* f4, f5,f6,f7 */
269     BTBYTE (pll_f_xci);		/* f8, f9,fa,fb */
270 #define BT848_PLL_F_C			(1<<6)
271 #define BT848_PLL_F_X			(1<<7)
272     u_char	filler2[0x100-0xfc];
273     BTLONG (int_stat);		/* 100, 101,102,103 */
274     BTLONG (int_mask);		/* 104, 105,106,107 */
275 #define BT848_INT_RISCS			(0xf<<28)
276 #define BT848_INT_RISC_EN		(1<<27)
277 #define BT848_INT_RACK			(1<<25)
278 #define BT848_INT_FIELD			(1<<24)
279 #define BT848_INT_MYSTERYBIT		(1<<23)
280 #define BT848_INT_SCERR			(1<<19)
281 #define BT848_INT_OCERR			(1<<18)
282 #define BT848_INT_PABORT		(1<<17)
283 #define BT848_INT_RIPERR		(1<<16)
284 #define BT848_INT_PPERR			(1<<15)
285 #define BT848_INT_FDSR			(1<<14)
286 #define BT848_INT_FTRGT			(1<<13)
287 #define BT848_INT_FBUS			(1<<12)
288 #define BT848_INT_RISCI			(1<<11)
289 #define BT848_INT_GPINT			(1<<9)
290 #define BT848_INT_I2CDONE		(1<<8)
291 #define BT848_INT_RSV1			(1<<7)
292 #define BT848_INT_RSV0			(1<<6)
293 #define BT848_INT_VPRES			(1<<5)
294 #define BT848_INT_HLOCK			(1<<4)
295 #define BT848_INT_OFLOW			(1<<3)
296 #define BT848_INT_HSYNC			(1<<2)
297 #define BT848_INT_VSYNC			(1<<1)
298 #define BT848_INT_FMTCHG		(1<<0)
299     int		:32;		/* 108, 109,10a,10b */
300     BTWORD (gpio_dma_ctl);	/* 10c, 10d,10e,10f */
301 #define BT848_DMA_CTL_PL23TP4		(0<<6)	/* planar1 trigger 4 */
302 #define BT848_DMA_CTL_PL23TP8		(1<<6)	/* planar1 trigger 8 */
303 #define BT848_DMA_CTL_PL23TP16		(2<<6)	/* planar1 trigger 16 */
304 #define BT848_DMA_CTL_PL23TP32		(3<<6)	/* planar1 trigger 32 */
305 #define BT848_DMA_CTL_PL1TP4		(0<<4)	/* planar1 trigger 4 */
306 #define BT848_DMA_CTL_PL1TP8		(1<<4)	/* planar1 trigger 8 */
307 #define BT848_DMA_CTL_PL1TP16		(2<<4)	/* planar1 trigger 16 */
308 #define BT848_DMA_CTL_PL1TP32		(3<<4)	/* planar1 trigger 32 */
309 #define BT848_DMA_CTL_PKTP4		(0<<2)	/* packed trigger 4 */
310 #define BT848_DMA_CTL_PKTP8		(1<<2)	/* packed trigger 8 */
311 #define BT848_DMA_CTL_PKTP16		(2<<2)	/* packed trigger 16 */
312 #define BT848_DMA_CTL_PKTP32		(3<<2)	/* packed trigger 32 */
313 #define BT848_DMA_CTL_RISC_EN		(1<<1)
314 #define BT848_DMA_CTL_FIFO_EN		(1<<0)
315     BTLONG (i2c_data_ctl);	/* 110, 111,112,113 */
316 #define BT848_DATA_CTL_I2CDIV		(0xf<<4)
317 #define BT848_DATA_CTL_I2CSYNC		(1<<3)
318 #define BT848_DATA_CTL_I2CW3B		(1<<2)
319 #define BT848_DATA_CTL_I2CSCL		(1<<1)
320 #define BT848_DATA_CTL_I2CSDA		(1<<0)
321     BTLONG (risc_strt_add);	/* 114, 115,116,117 */
322     BTLONG (gpio_out_en);	/* 118, 119,11a,11b */	/* really 24 bits */
323     BTLONG (gpio_reg_inp);	/* 11c, 11d,11e,11f */	/* really 24 bits */
324     BTLONG (risc_count);	/* 120, 121,122,123 */
325     u_char	filler3[0x200-0x124];
326     BTLONG (gpio_data);		/* 200, 201,202,203 */	/* really 24 bits */
327 };
328 
329 
330 #define BKTR_DSTATUS			0x000
331 #define BKTR_IFORM			0x004
332 #define BKTR_TDEC			0x008
333 #define BKTR_E_CROP			0x00C
334 #define BKTR_O_CROP			0x08C
335 #define BKTR_E_VDELAY_LO		0x010
336 #define BKTR_O_VDELAY_LO		0x090
337 #define BKTR_E_VACTIVE_LO		0x014
338 #define BKTR_O_VACTIVE_LO		0x094
339 #define BKTR_E_DELAY_LO			0x018
340 #define BKTR_O_DELAY_LO			0x098
341 #define BKTR_E_HACTIVE_LO		0x01C
342 #define BKTR_O_HACTIVE_LO		0x09C
343 #define BKTR_E_HSCALE_HI		0x020
344 #define BKTR_O_HSCALE_HI		0x0A0
345 #define BKTR_E_HSCALE_LO		0x024
346 #define BKTR_O_HSCALE_LO		0x0A4
347 #define BKTR_BRIGHT			0x028
348 #define BKTR_E_CONTROL			0x02C
349 #define BKTR_O_CONTROL			0x0AC
350 #define BKTR_CONTRAST_LO		0x030
351 #define BKTR_SAT_U_LO			0x034
352 #define BKTR_SAT_V_LO			0x038
353 #define BKTR_HUE			0x03C
354 #define BKTR_E_SCLOOP			0x040
355 #define BKTR_O_SCLOOP			0x0C0
356 #define BKTR_OFORM			0x048
357 #define BKTR_E_VSCALE_HI		0x04C
358 #define BKTR_O_VSCALE_HI		0x0CC
359 #define BKTR_E_VSCALE_LO		0x050
360 #define BKTR_O_VSCALE_LO		0x0D0
361 #define BKTR_TEST			0x054
362 #define BKTR_ADELAY			0x060
363 #define BKTR_BDELAY			0x064
364 #define BKTR_ADC			0x068
365 #define BKTR_E_VTC			0x06C
366 #define BKTR_O_VTC			0x0EC
367 #define BKTR_SRESET			0x07C
368 #define BKTR_COLOR_FMT			0x0D4
369 #define BKTR_COLOR_CTL			0x0D8
370 #define BKTR_CAP_CTL			0x0DC
371 #define BKTR_VBI_PACK_SIZE		0x0E0
372 #define BKTR_VBI_PACK_DEL		0x0E4
373 #define BKTR_INT_STAT			0x100
374 #define BKTR_INT_MASK			0x104
375 #define BKTR_RISC_COUNT			0x120
376 #define BKTR_RISC_STRT_ADD		0x114
377 #define BKTR_GPIO_DMA_CTL		0x10C
378 #define BKTR_GPIO_OUT_EN		0x118
379 #define BKTR_GPIO_REG_INP		0x11C
380 #define BKTR_GPIO_DATA			0x200
381 #define BKTR_I2C_DATA_CTL		0x110
382 #define BKTR_TGCTRL			0x084
383 #define BKTR_PLL_F_LO			0x0F0
384 #define BKTR_PLL_F_HI			0x0F4
385 #define BKTR_PLL_F_XCI			0x0F8
386 
387 /*
388  * device support for onboard tv tuners
389  */
390 
391 /* description of the LOGICAL tuner */
392 struct TVTUNER {
393 	int		frequency;
394 	u_char		chnlset;
395 	u_char		channel;
396 	u_char		band;
397 	u_char		afc;
398  	u_char		radio_mode;	/* current mode of the radio mode */
399 };
400 
401 /* description of the PHYSICAL tuner */
402 struct TUNER {
403 	char*		name;
404 	u_char		type;
405 	u_char		pllControl[4];
406 	u_char		bandLimits[ 2 ];
407 	u_char		bandAddrs[ 4 ];        /* 3 first for the 3 TV
408 					       ** bands. Last for radio
409 					       ** band (0x00=NoRadio).
410 					       */
411 
412 };
413 
414 /* description of the card */
415 #define EEPROMBLOCKSIZE		32
416 struct CARDTYPE {
417 	unsigned int		card_id;	/* card id (from #define's) */
418 	char*			name;
419 	const struct TUNER*	tuner;		/* Tuner details */
420 	u_char			tuner_pllAddr;	/* Tuner i2c address */
421 	u_char			dbx;		/* Has DBX chip? */
422 	u_char			msp3400c;	/* Has msp3400c chip? */
423 	u_char			dpl3518a;	/* Has dpl3518a chip? */
424 	u_char			eepromAddr;
425 	u_char			eepromSize;	/* bytes / EEPROMBLOCKSIZE */
426 	u_int			audiomuxs[ 5 ];	/* tuner, ext (line-in) */
427 						/* int/unused (radio) */
428 						/* mute, present */
429 	u_int			gpio_mux_bits;	/* GPIO mask for audio mux */
430 };
431 
432 struct format_params {
433   /* Total lines, lines before image, image lines */
434   int vtotal, vdelay, vactive;
435   /* Total unscaled horizontal pixels, pixels before image, image pixels */
436   int htotal, hdelay, hactive;
437   /* Scaled horizontal image pixels, Total Scaled horizontal pixels */
438   int  scaled_hactive, scaled_htotal;
439   /* frame rate . for ntsc is 30 frames per second */
440   int frame_rate;
441   /* A-delay and B-delay */
442   u_char adelay, bdelay;
443   /* Iform XTSEL value */
444   int iform_xtsel;
445   /* VBI number of lines per field, and number of samples per line */
446   int vbi_num_lines, vbi_num_samples;
447 };
448 
449 #if defined(BKTR_USE_FREEBSD_SMBUS)
450 struct bktr_i2c_softc {
451 	int bus_owned;
452 
453 	device_t iicbb;
454 	device_t smbus;
455 };
456 #endif
457 
458 
459 /* Bt848/878 register access
460  * The registers can either be access via a memory mapped structure
461  * or accessed via bus_space.
462  * bus_0pace access allows cross platform support, where as the
463  * memory mapped structure method only works on 32 bit processors
464  * with the right type of endianness.
465  */
466 #if defined(__NetBSD__) || defined(__FreeBSD__)
467 #define INB(bktr,offset)	bus_space_read_1((bktr)->memt,(bktr)->memh,(offset))
468 #define INW(bktr,offset)	bus_space_read_2((bktr)->memt,(bktr)->memh,(offset))
469 #define INL(bktr,offset)	bus_space_read_4((bktr)->memt,(bktr)->memh,(offset))
470 #define OUTB(bktr,offset,value) bus_space_write_1((bktr)->memt,(bktr)->memh,(offset),(value))
471 #define OUTW(bktr,offset,value) bus_space_write_2((bktr)->memt,(bktr)->memh,(offset),(value))
472 #define OUTL(bktr,offset,value) bus_space_write_4((bktr)->memt,(bktr)->memh,(offset),(value))
473 #else
474 #define INB(bktr,offset)	*(volatile unsigned char*) ((int)((bktr)->memh)+(offset))
475 #define INW(bktr,offset)	*(volatile unsigned short*)((int)((bktr)->memh)+(offset))
476 #define INL(bktr,offset)	*(volatile unsigned int*)  ((int)((bktr)->memh)+(offset))
477 #define OUTB(bktr,offset,value)	*(volatile unsigned char*) ((int)((bktr)->memh)+(offset)) = (value)
478 #define OUTW(bktr,offset,value)	*(volatile unsigned short*)((int)((bktr)->memh)+(offset)) = (value)
479 #define OUTL(bktr,offset,value)	*(volatile unsigned int*)  ((int)((bktr)->memh)+(offset)) = (value)
480 #endif
481 
482 
483 typedef struct bktr_clip bktr_clip_t;
484 
485 /*
486  * BrookTree 848  info structure, one per bt848 card installed.
487  */
488 struct bktr_softc {
489 
490 #if defined (__bsdi__)
491     struct device bktr_dev;	/* base device */
492     struct isadev bktr_id;	/* ISA device */
493     struct intrhand bktr_ih;	/* interrupt vectoring */
494     #define pcici_t pci_devaddr_t
495 #endif
496 
497 #if defined(__NetBSD__)
498     struct device bktr_dev;     /* base device */
499     bus_dma_tag_t	dmat;   /* DMA tag */
500     bus_space_tag_t	memt;
501     bus_space_handle_t	memh;
502     bus_size_t		obmemsz;        /* size of en card (bytes) */
503     void		*ih;
504     bus_dmamap_t	dm_prog;
505     bus_dmamap_t	dm_oprog;
506     bus_dmamap_t	dm_mem;
507     bus_dmamap_t	dm_vbidata;
508     bus_dmamap_t	dm_vbibuffer;
509 #endif
510 
511 #if defined(__OpenBSD__)
512     struct device bktr_dev;     /* base device */
513     bus_dma_tag_t	dmat;   /* DMA tag */
514     bus_space_tag_t	memt;
515     bus_space_handle_t	memh;
516     bus_size_t		obmemsz;        /* size of en card (bytes) */
517     void		*ih;
518     bus_dmamap_t	dm_prog;
519     bus_dmamap_t	dm_oprog;
520     bus_dmamap_t	dm_mem;
521     bus_dmamap_t	dm_vbidata;
522     bus_dmamap_t	dm_vbibuffer;
523     size_t		dm_mapsize;
524     pci_chipset_tag_t	pc;	/* Opaque PCI chipset tag */
525     pcitag_t		tag;	/* PCI tag, for doing PCI commands */
526     vm_offset_t		phys_base;	/* Bt848 register physical address */
527 #endif
528 
529 #if defined (__FreeBSD__)
530     int             mem_rid;	/* 4.x resource id */
531     struct resource *res_mem;	/* 4.x resource descriptor for registers */
532     int             irq_rid;	/* 4.x resource id */
533     struct resource *res_irq;	/* 4.x resource descriptor for interrupt */
534     void            *res_ih;	/* 4.x newbus interrupt handler cookie */
535     struct cdev     *bktrdev;	/* 4.x device entry for /dev/bktrN */
536     struct cdev     *tunerdev;	/* 4.x device entry for /dev/tunerN */
537     struct cdev     *vbidev;	/* 4.x device entry for /dev/vbiN */
538     struct cdev     *bktrdev_alias;	/* alias /dev/bktr to /dev/bktr0 */
539     struct cdev     *tunerdev_alias;	/* alias /dev/tuner to /dev/tuner0 */
540     struct cdev     *vbidev_alias;	/* alias /dev/vbi to /dev/vbi0 */
541     #if (__FreeBSD_version >= 500000)
542     struct mtx      vbimutex;  /* Mutex protecting vbi buffer */
543     #endif
544     bus_space_tag_t	memt;	/* Bus space register access functions */
545     bus_space_handle_t	memh;	/* Bus space register access functions */
546     bus_size_t		obmemsz;/* Size of card (bytes) */
547 #if defined(BKTR_USE_FREEBSD_SMBUS)
548       struct bktr_i2c_softc i2c_sc;	/* bt848_i2c device */
549 #endif
550     char	bktr_xname[7];	/* device name and unit number */
551 #endif
552 
553 
554     /* The following definitions are for the contiguous memory */
555 #ifdef __NetBSD__
556     vaddr_t bigbuf;          /* buffer that holds the captured image */
557     vaddr_t vbidata;         /* RISC program puts VBI data from the current frame here */
558     vaddr_t vbibuffer;       /* Circular buffer holding VBI data for the user */
559     vaddr_t dma_prog;        /* RISC prog for single and/or even field capture*/
560     vaddr_t odd_dma_prog;    /* RISC program for Odd field capture */
561 #else
562     vm_offset_t bigbuf;	     /* buffer that holds the captured image */
563     vm_offset_t vbidata;     /* RISC program puts VBI data from the current frame here */
564     vm_offset_t vbibuffer;   /* Circular buffer holding VBI data for the user */
565     vm_offset_t dma_prog;    /* RISC prog for single and/or even field capture*/
566     vm_offset_t odd_dma_prog;/* RISC program for Odd field capture */
567 #endif
568 
569 
570     /* the following definitions are common over all platforms */
571     int		alloc_pages;	/* number of pages in bigbuf */
572     int         vbiinsert;      /* Position for next write into circular buffer */
573     int         vbistart;       /* Position of last read from circular buffer */
574     int         vbisize;        /* Number of bytes in the circular buffer */
575     uint32_t	vbi_sequence_number;	/* sequence number for VBI */
576     int		vbi_read_blocked;	/* user process blocked on read() from /dev/vbi */
577     struct selinfo vbi_select;	/* Data used by select() on /dev/vbi */
578 
579 
580     struct proc	*proc;		/* process to receive raised signal */
581     int		signal;		/* signal to send to process */
582     int		clr_on_start;	/* clear cap buf on capture start? */
583 #define	METEOR_SIG_MODE_MASK	0xffff0000
584 #define	METEOR_SIG_FIELD_MODE	0x00010000
585 #define	METEOR_SIG_FRAME_MODE	0x00000000
586     char         dma_prog_loaded;
587     struct meteor_mem *mem;	/* used to control sync. multi-frame output */
588     u_long	synch_wait;	/* wait for free buffer before continuing */
589     short	current;	/* frame number in buffer (1-frames) */
590     short	rows;		/* number of rows in a frame */
591     short	cols;		/* number of columns in a frame */
592     int		capture_area_x_offset; /* Usually the full 640x480(NTSC) image is */
593     int		capture_area_y_offset; /* captured. The capture area allows for */
594     int		capture_area_x_size;   /* example 320x200 pixels from the centre */
595     int		capture_area_y_size;   /* of the video image to be captured. */
596     char	capture_area_enabled;  /* When TRUE use user's capture area. */
597     int		pixfmt;         /* active pixel format (idx into fmt tbl) */
598     int		pixfmt_compat;  /* Y/N - in meteor pix fmt compat mode */
599     u_long	format;		/* frame format rgb, yuv, etc.. */
600     short	frames;		/* number of frames allocated */
601     int		frame_size;	/* number of bytes in a frame */
602     u_long	fifo_errors;	/* number of fifo capture errors since open */
603     u_long	dma_errors;	/* number of DMA capture errors since open */
604     u_long	frames_captured;/* number of frames captured since open */
605     u_long	even_fields_captured; /* number of even fields captured */
606     u_long	odd_fields_captured; /* number of odd fields captured */
607     u_long	range_enable;	/* enable range checking ?? */
608     u_short     capcontrol;     /* reg 0xdc capture control */
609     u_short     bktr_cap_ctl;
610     volatile u_int	flags;
611 #define	METEOR_INITALIZED	0x00000001
612 #define	METEOR_OPEN		0x00000002
613 #define	METEOR_MMAP		0x00000004
614 #define	METEOR_INTR		0x00000008
615 #define	METEOR_READ		0x00000010	/* XXX never gets referenced */
616 #define	METEOR_SINGLE		0x00000020	/* get single frame */
617 #define	METEOR_CONTIN		0x00000040	/* continuously get frames */
618 #define	METEOR_SYNCAP		0x00000080	/* synchronously get frames */
619 #define	METEOR_CAP_MASK		0x000000f0
620 #define	METEOR_NTSC		0x00000100
621 #define	METEOR_PAL		0x00000200
622 #define	METEOR_SECAM		0x00000400
623 #define	BROOKTREE_NTSC		0x00000100	/* used in video open() and */
624 #define	BROOKTREE_PAL		0x00000200	/* in the kernel config */
625 #define	BROOKTREE_SECAM		0x00000400	/* file */
626 #define	METEOR_AUTOMODE		0x00000800
627 #define	METEOR_FORM_MASK	0x00000f00
628 #define	METEOR_DEV0		0x00001000
629 #define	METEOR_DEV1		0x00002000
630 #define	METEOR_DEV2		0x00004000
631 #define	METEOR_DEV3		0x00008000
632 #define METEOR_DEV_SVIDEO	0x00006000
633 #define METEOR_DEV_RGB		0x0000a000
634 #define	METEOR_DEV_MASK		0x0000f000
635 #define	METEOR_RGB16		0x00010000
636 #define	METEOR_RGB24		0x00020000
637 #define	METEOR_YUV_PACKED	0x00040000
638 #define	METEOR_YUV_PLANAR	0x00080000
639 #define	METEOR_WANT_EVEN	0x00100000	/* want even frame */
640 #define	METEOR_WANT_ODD		0x00200000	/* want odd frame */
641 #define	METEOR_WANT_MASK	0x00300000
642 #define METEOR_ONLY_EVEN_FIELDS	0x01000000
643 #define METEOR_ONLY_ODD_FIELDS	0x02000000
644 #define METEOR_ONLY_FIELDS_MASK 0x03000000
645 #define METEOR_YUV_422		0x04000000
646 #define	METEOR_OUTPUT_FMT_MASK	0x040f0000
647 #define	METEOR_WANT_TS		0x08000000	/* time-stamp a frame */
648 #define METEOR_RGB		0x20000000	/* meteor rgb unit */
649 #define METEOR_FIELD_MODE	0x80000000
650     u_char	tflags;				/* Tuner flags (/dev/tuner) */
651 #define	TUNER_INITALIZED	0x00000001
652 #define	TUNER_OPEN		0x00000002
653     u_char      vbiflags;			/* VBI flags (/dev/vbi) */
654 #define VBI_INITALIZED          0x00000001
655 #define VBI_OPEN                0x00000002
656 #define VBI_CAPTURE             0x00000004
657     u_short	fps;		/* frames per second */
658     struct meteor_video video;
659     struct TVTUNER	tuner;
660     struct CARDTYPE	card;
661     u_char		audio_mux_select;	/* current mode of the audio */
662     u_char		audio_mute_state;	/* mute state of the audio */
663     u_char		format_params;
664     u_long              current_sol;
665     u_long              current_col;
666     int                 clip_start;
667     int                 line_length;
668     int                 last_y;
669     int                 y;
670     int                 y2;
671     int                 yclip;
672     int                 yclip2;
673     int                 max_clip_node;
674     bktr_clip_t		clip_list[100];
675     int                 reverse_mute;		/* Swap the GPIO values for Mute and TV Audio */
676     int                 bt848_tuner;
677     int                 bt848_card;
678     u_long              id;
679 #define BT848_USE_XTALS 0
680 #define BT848_USE_PLL   1
681     int			xtal_pll_mode;	/* Use XTAL or PLL mode for PAL/SECAM */
682     int			remote_control;      /* remote control detected */
683     int			remote_control_addr;   /* remote control i2c address */
684     char		msp_version_string[9]; /* MSP version string 34xxx-xx */
685     int			msp_addr;	       /* MSP i2c address */
686     char		dpl_version_string[9]; /* DPL version string 35xxx-xx */
687     int			dpl_addr;	       /* DPL i2c address */
688     int                 slow_msp_audio;	       /* 0 = use fast MSP3410/3415 programming sequence */
689 					       /* 1 = use slow MSP3410/3415 programming sequence */
690 					       /* 2 = use Tuner's Mono audio output via the MSP chip */
691     int                 msp_use_mono_source;   /* use Tuner's Mono audio output via the MSP chip */
692     int                 audio_mux_present;     /* 1 = has audio mux on GPIO lines, 0 = no audio mux */
693     int                 msp_source_selected;   /* 0 = TV source, 1 = Line In source, 2 = FM Radio Source */
694 
695 #ifdef BKTR_NEW_MSP34XX_DRIVER
696     /* msp3400c related data */
697     void *		msp3400c_info;
698     int			stereo_once;
699     int			amsound;
700     int			mspsimple;
701     int			dolby;
702 #endif
703 
704 };
705 
706 typedef struct bktr_softc bktr_reg_t;
707 typedef struct bktr_softc* bktr_ptr_t;
708 
709 #define Bt848_MAX_SIGN 16
710 
711 struct bt848_card_sig {
712   int card;
713   int tuner;
714   u_char signature[Bt848_MAX_SIGN];
715 };
716 
717 
718 /***********************************************************/
719 /* ioctl_cmd_t int on old versions, u_long on new versions */
720 /***********************************************************/
721 
722 #if defined(__FreeBSD__)
723 typedef u_long ioctl_cmd_t;
724 #endif
725 
726 #if defined(__NetBSD__) || defined(__OpenBSD__)
727 typedef u_long ioctl_cmd_t;
728 #endif
729 
730 
731