xref: /dragonfly/share/man/man4/bktr.4 (revision 3f625015)
1.\"
2.\" $FreeBSD: src/share/man/man4/bktr.4,v 1.9.2.9 2002/03/29 09:55:39 schweikh Exp $
3.\" $DragonFly: src/share/man/man4/bktr.4,v 1.7 2007/05/12 23:22:36 swildner Exp $
4.\"
5.Dd March 30, 2006
6.Dt BKTR 4
7.Os
8.Sh NAME
9.Nm bktr
10.Nd Brooktree Bt848/849/878/879 video capture driver
11.Sh SYNOPSIS
12.Cd device bktr
13.Pp
14.Cd device iicbus
15.Cd device iicbb
16.Cd device smbus
17.Sh DESCRIPTION
18The
19.Nm
20driver provides support for PCI
21.Em video
22capture and
23.Em VBI
24capture on low cost, high performance boards.
25The driver is based on the Matrox Meteor driver and uses the same API.
26The
27.Nm
28driver should support most video cards
29based on the
30.Em "Brooktree Bt848/849/878/879 Video Capture Chip" .
31The driver also supports
32.Em FM Radio
33if the tuner supports it.
34.Pp
35The driver currently supports the following features:
36.Bd -unfilled -offset indent
37PCI to PCI dma transfer
38clipping
39yuv
40rgb16
41rgb24
42rgb32
43.Ed
44.Pp
45On the supported cards, tuners and other components are interconnected
46with an I2C bus.
47The Brooktree848 chips act as a master device on the bus to control them.
48Therefore,
49.Xr iicbus 4 ,
50.Xr iicbb 4
51and
52.Xr smbus 4
53controller declarations are mandatory to activate
54.Nm
55support.
56.Pp
57The following kernel parameters may be used to further configure the driver:
58.Pp
59.Cd options "BROOKTREE_ALLOC_PAGES=xxx"
60specifies the number of contiguous pages to allocate when successfully
61probed.
62The default number of pages allocated by the kernel is 216.
63This means that there are (216*4096) bytes available for use.
64.Bd -unfilled
65.Cd options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
66.Cd options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
67.Ed
68One of these options can be used to set the default video format for the driver.
69This fixed random hangs and lockups with the VideoLogic Captivator PCI card.
70.Pp
71The following sysctls may be used to further configure the driver:
72.Pp
73.Em sysctl hw.bt848.card=nnnn
74This can be used to override the card make which was detected at boot time.
75.Ql nnnn
76is set to an integer from 1 to 13 taken from the following table:
77.Pp
78.Bl -tag -compact -width 22n
79.It MIRO
801
81.It HAUPPAUGE
822
83.It STB
843
85.It INTEL
864
87.It IMS_TURBO
885
89.It AVER_MEDIA
906
91.It OSPREY
927
93.It NEC_PK
948
95.It IO_GV
969
97.It FLYVIDEO
9810
99.It ZOLTRIX
10011
101.It KISS
10212
103.It VIDEO_HIGHWAY_XTREME
10413
105.El
106.Pp
107.Em sysctl hw.bt848.tuner=nnnn
108This can be used to override the tuner make which was detected at boot time.
109.Ql nnnn
110is set to an integer from 1 to 13 taken from the following table:
111.Pp
112.Bl -tag -compact -width 22n
113.It NO_TUNER
1140
115.It TEMIC_NTSC
1161
117.It TEMIC_PAL
1182
119.It TEMIC_SECAM
1203
121.It PHILIPS_NTSC
1224
123.It PHILIPS_PAL
1245
125.It PHILIPS_SECAM
1266
127.It TEMIC_PALI
1287
129.It PHILIPS_PALI
1308
131.It PHILIPS_FR1236_NTSC
1329       /* These have FM Radio support */
133.It PHILIPS_FR1216_PAL
13410      /* These have FM Radio support */
135.It PHILIPS_FR1236_SECAM
13611      /* These have FM Radio support */
137.It ALPS_TSCH5
13812
139.It ALPS_TSBH1
14013
141.El
142.Sh HARDWARE
143The
144.Nm
145driver supports video capture cards based on the
146Brooktree Bt848/849/878/879 chips, including:
147.Pp
148.Bl -bullet -compact
149.It
150Hauppauge Wincast TV and WinTV/PCI
151.It
152STB TV PCI Television Tuner
153.It
154Miro PC TV
155.It
156Intel Smart Video Recorder III
157.It
158AverMedia cards
159.It
160Video Highway XTreme
161.It
162VideoLogic Captivator PCI
163.El
164.Sh FILES
165.Bl -tag -width /usr/share/examples/meteor -compact
166.It Pa /usr/share/examples/meteor
167Examples of what you can do with the (similarly designed) Meteor driver.
168.It Pa /usr/pkgsrc/multimedia/fxtv
169A TV and Camera display program utilizing the
170.Nm
171driver - requires that
172.Em The X Window System
173and
174.Em The pkgsrc Collection
175also be installed.
176.It Pa /usr/pkgsrc/multimedia/alevt
177A program to capture and display Teletext (VideoText) pages - requires that
178.Em The X Window System
179and
180.Em The pkgsrc Collection
181also be installed.
182.It Pa /usr/pkgsrc/audio/xmradio
183An FM Radio Tuner for cards which have an FM Radio tuner fitted - requires that
184.Em The X Window System
185and
186.Em The pkgsrc Collection
187also be installed.
188It also requires
189.Em Motif
190or the
191.Em lesstif
192port.
193.El
194.Sh SEE ALSO
195.Xr meteor 4
196.Sh HISTORY
197The
198.Nm
199driver first appeared in
200.Fx 2.2 .
201.Sh AUTHORS
202.An -nosplit
203This driver is based on the work of
204.An Jim Lowe Aq james@miller.cs.uwm.edu ,
205.An Mark Tinguely Aq tinguely@plains.nodak.edu ,
206.An Amancio Hasty Aq hasty@star-gate.com ,
207.An Roger Hardiman Aq roger@FreeBSD.org
208and a bunch of other people.
209