* Fix incorrect usage of \- (mathematical minus).
[dragonfly.git] / share / man / man4 / bktr.4
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.5 2006/03/30 09:52:48 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
18 The
19 .Nm
20 driver provides support for PCI
21 .Em video
22 capture and
23 .Em VBI
24 capture on low cost, high performance boards.
25 The driver is based on the Matrox Meteor driver and uses the same API.
26 The
27 .Nm
28 driver should support most video cards
29 based on the
30 .Em "Brooktree Bt848/849/878/879 Video Capture Chip" .
31 The driver also supports
32 .Em FM Radio
33 if the tuner supports it.
34 .Pp
35 The driver currently supports the following features:
36 .Bd -unfilled -offset indent
37 PCI to PCI dma transfer
38 clipping
39 yuv
40 rgb16
41 rgb24
42 rgb32
43 .Ed
44 .Pp
45 On the supported cards, tuners and other components are interconnected
46 with an I2C bus.
47 The Brooktree848 chips act as a master device on the bus to control them.
48 Therefore,
49 .Xr iicbus 4 ,
50 .Xr iicbb 4
51 and
52 .Xr smbus 4
53 controller declarations are mandatory to activate
54 .Nm
55 support.
56 .Pp
57 The following kernel parameters may be used to further configure the driver:
58 .Pp
59 .Em options "BROOKTREE_ALLOC_PAGES=xxx"
60 specifies the number of contiguous pages to allocate when successfully
61 probed.
62 The default number of pages allocated by the kernel is 216.
63 This 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
68 One of these options can be used to set the default video format for the driver.
69 This fixed random hangs and lockups with the VideoLogic Captivator PCI card.
70 .Pp
71 The following sysctls may be used to further configure the driver:
72 .Pp
73 .Em sysctl hw.bt848.card=nnnn
74 This can be used to override the card make which was detected at boot time.
75 .Ql nnnn
76 is set to an integer from 1 to 13 taken from the following table:
77 .Pp
78 .Bl -tag -compact -width 22n
79 .It MIRO
80 1
81 .It HAUPPAUGE
82 2
83 .It STB
84 3
85 .It INTEL
86 4
87 .It IMS_TURBO
88 5
89 .It AVER_MEDIA
90 6
91 .It OSPREY
92 7
93 .It NEC_PK
94 8
95 .It IO_GV
96 9
97 .It FLYVIDEO
98 10
99 .It ZOLTRIX
100 11
101 .It KISS
102 12
103 .It VIDEO_HIGHWAY_XTREME
104 13
105 .El
106 .Pp
107 .Em sysctl hw.bt848.tuner=nnnn
108 This can be used to override the tuner make which was detected at boot time.
109 .Ql nnnn
110 is 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
114 0
115 .It TEMIC_NTSC
116 1
117 .It TEMIC_PAL
118 2
119 .It TEMIC_SECAM
120 3
121 .It PHILIPS_NTSC
122 4
123 .It PHILIPS_PAL
124 5
125 .It PHILIPS_SECAM
126 6
127 .It TEMIC_PALI
128 7
129 .It PHILIPS_PALI
130 8
131 .It PHILIPS_FR1236_NTSC
132 9       /* These have FM Radio support */
133 .It PHILIPS_FR1216_PAL
134 10      /* These have FM Radio support */
135 .It PHILIPS_FR1236_SECAM
136 11      /* These have FM Radio support */
137 .It ALPS_TSCH5
138 12
139 .It ALPS_TSBH1
140 13
141 .El
142 .Sh HARDWARE
143 The
144 .Nm
145 driver supports video capture cards based on the
146 Brooktree Bt848/849/878/879 chips, including:
147 .Pp
148 .Bl -bullet -compact
149 .It
150 Hauppauge Wincast TV and WinTV/PCI
151 .It
152 STB TV PCI Television Tuner
153 .It
154 Miro PC TV
155 .It
156 Intel Smart Video Recorder III
157 .It
158 AverMedia cards
159 .It
160 Video Highway XTreme
161 .It
162 VideoLogic Captivator PCI
163 .El
164 .Sh FILES
165 .Bl -tag -width /usr/share/examples/meteor -compact
166 .It Pa /usr/share/examples/meteor
167 Examples of what you can do with the (similarly designed) Meteor driver.
168 .It Pa /usr/pkgsrc/multimedia/fxtv
169 A TV and Camera display program utilizing the bktr driver - requires that
170 .Em The X Window System
171 and
172 .Em The pkgsrc Collection
173 also be installed.
174 .It Pa /usr/pkgsrc/multimedia/alevt
175 A program to capture and display Teletext (VideoText) pages - requires that
176 .Em The X Window System
177 and
178 .Em The pkgsrc Collection
179 also be installed.
180 .It Pa /usr/pkgsrc/audio/xmradio
181 An FM Radio Tuner for cards which have an FM Radio tuner fitted - requires that
182 .Em The X Window System
183 and
184 .Em The pkgsrc Collection
185 also be installed.
186 It also requires
187 .Em Motif
188 or the
189 .Em lesstif
190 port.
191 .El
192 .Sh SEE ALSO
193 .Xr meteor 4
194 .Sh HISTORY
195 The
196 .Nm
197 driver first appeared in
198 .Fx 2.2 .
199 .Sh AUTHORS
200 .An -nosplit
201 This driver is based on the work of
202 .An Jim Lowe Aq james@miller.cs.uwm.edu ,
203 .An Mark Tinguely Aq tinguely@plains.nodak.edu ,
204 .An Amancio Hasty Aq hasty@star-gate.com ,
205 .An Roger Hardiman Aq roger@FreeBSD.org
206 and a bunch of other people.