xref: /dragonfly/share/man/man4/bktr.4 (revision 40f79625)
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.4 2006/02/17 19:37:09 swildner Exp $
4.\"
5.Dd January 28, 1998
6.Dt BKTR 4
7.Os
8.Sh NAME
9.Nm brooktree
10.Nd 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 bktr
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 bktr driver should support most video cards
27based on the
28.Em "Brooktree Bt848/849/878/879 Video Capture Chip" .
29The driver also supports
30.Em FM Radio
31if the tuner supports it.
32.Pp
33Specifically, the following cards are known to work:
34.Bd -unfilled -offset indent
35.Em Hauppauge Wincast TV and WinTV/PCI
36.Em STB TV PCI Television Tuner
37.Em Miro PC TV
38.Em Intel Smart Video Recorder III
39.Em AverMedia cards
40.Em Video Highway XTreme
41.Em VideoLogic Captivator PCI
42.Ed
43.Pp
44The driver currently supports the following features:
45.Bd -unfilled -offset indent
46PCI to PCI dma transfer
47clipping
48yuv
49rgb16
50rgb24
51rgb32
52.Ed
53.Pp
54On these cards, tuners and other components are interconnected with an I2C bus.
55The Brooktree848 chips act as a master device on the bus to control them.
56Therefore,
57.Xr iicbus 4 ,
58.Xr iicbb 4
59and
60.Xr smbus 4
61controller declarations are mandatory to activate bktr support.
62.Pp
63The following kernel parameters may be used to further configure the driver:
64.Pp
65.Em options "BROOKTREE_ALLOC_PAGES=xxx"
66specifies the number of contiguous pages to allocate when successfully
67probed.
68The default number of pages allocated by the kernel is 216.
69This means that there are (216*4096) bytes available for use.
70.Bd -unfilled
71.Em options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
72.Em options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
73.Ed
74One of these options can be used to set the default video format for the driver.
75This fixed random hangs and lockups with the VideoLogic Captivator PCI card.
76.Pp
77The following sysctls may be used to further configure the driver:
78.Pp
79.Em sysctl hw.bt848.card=nnnn
80This can be used to override the card make which was detected at boot time.
81.Ql nnnn
82is set to an integer from 1 to 13 taken from the following table:
83.Pp
84.Bl -tag -compact -width 22n
85.It MIRO
861
87.It HAUPPAUGE
882
89.It STB
903
91.It INTEL
924
93.It IMS_TURBO
945
95.It AVER_MEDIA
966
97.It OSPREY
987
99.It NEC_PK
1008
101.It IO_GV
1029
103.It FLYVIDEO
10410
105.It ZOLTRIX
10611
107.It KISS
10812
109.It VIDEO_HIGHWAY_XTREME
11013
111.El
112.Pp
113.Em sysctl hw.bt848.tuner=nnnn
114This can be used to override the tuner make which was detected at boot time.
115.Ql nnnn
116is set to an integer from 1 to 13 taken from the following table:
117.Pp
118.Bl -tag -compact -width 22n
119.It NO_TUNER
1200
121.It TEMIC_NTSC
1221
123.It TEMIC_PAL
1242
125.It TEMIC_SECAM
1263
127.It PHILIPS_NTSC
1284
129.It PHILIPS_PAL
1305
131.It PHILIPS_SECAM
1326
133.It TEMIC_PALI
1347
135.It PHILIPS_PALI
1368
137.It PHILIPS_FR1236_NTSC
1389       /* These have FM Radio support */
139.It PHILIPS_FR1216_PAL
14010      /* These have FM Radio support */
141.It PHILIPS_FR1236_SECAM
14211      /* These have FM Radio support */
143.It ALPS_TSCH5
14412
145.It ALPS_TSBH1
14613
147.El
148.Sh FILES
149.Bl -tag -width /usr/share/examples/meteor -compact
150.It Pa /usr/share/examples/meteor
151Examples of what you can do with the (similarly designed) Meteor driver.
152.It Pa /usr/ports/graphics/fxtv
153A TV and Camera display program utilizing the bktr driver - requires that
154.Em The X Window System
155and
156.Em The Ports Collection
157also be installed.
158.It Pa /usr/ports/misc/alevt
159A program to capture and display Teletext (VideoText) pages - requires that
160.Em The X Window System
161and
162.Em The Ports Collection
163also be installed.
164.It Pa /usr/ports/audio/xmradio
165An FM Radio Tuner for cards which have an FM Radio tuner fitted. - requires that
166.Em The X Window System
167and
168.Em The Ports Collection
169also be installed.
170It also requires
171.Em Motif
172or the
173.Em lesstif
174port.
175.El
176.Sh SEE ALSO
177.Xr meteor 4
178.Sh HISTORY
179The
180.Nm
181driver first appeared in
182.Fx 2.2 .
183.Sh AUTHORS
184.An -nosplit
185This driver is based on the work of
186.An Jim Lowe Aq james@miller.cs.uwm.edu ,
187.An Mark Tinguely Aq tinguely@plains.nodak.edu ,
188.An Amancio Hasty Aq hasty@star\-gate.com ,
189.An Roger Hardiman Aq roger@FreeBSD.org
190and a bunch of other people.
191