xref: /openbsd/share/man/man4/bktr.4 (revision db3296cf)
1.\"
2.\" Copyright (c) 1998 Amancio Hasty and Roger Hardiman
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\"
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by Amancio Hasty and
17.\"	Roger Hardiman.
18.\" 4. The name of the author may not be used to endorse or promote products
19.\"    derived from this software without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31.\"
32.\" $OpenBSD: bktr.4,v 1.6 2003/07/09 13:26:20 jmc Exp $
33.\" $FreeBSD: /c/ncvs/src/share/man/man4/bktr.4,v 1.9.2.5 2001/03/06 19:08:09 ru Exp $
34.\"
35.Dd January 28, 1998
36.Dt BKTR 4
37.Os
38.Sh NAME
39.Nm bktr
40.Nd video capture driver
41.Sh SYNOPSIS
42.Cd "bktr* at pci? dev ? function ?"
43.Cd "radio* at bktr?"
44.Pp
45.Cd "option BROOKTREE_ALLOC_PAGES=nnn"
46.Cd "option BROOKTREE_SYSTEM_DEFAULT=XXX"
47.Sh DESCRIPTION
48The
49.Nm
50driver provides support for PCI video capture and VBI capture on low cost,
51high performance boards.
52This should support most video cards based on the
53Brooktree Bt848/849/878/879 Video Capture Chip.
54The driver also supports FM Radio if the Tuner supports it.
55.Pp
56Specifically, the following cards are known to work:
57.Bd -unfilled -offset indent
58Hauppage Wincast TV and WinTV/PCI
59STB TV PCI Television Tuner
60Miro PC TV
61Intel Smart Video Recorder III
62AverMedia cards
63Video Highway XTreme
64VideoLogic Captivator PCI
65.Ed
66.Pp
67The driver currently supports the following features:
68.Bd -unfilled -offset indent
69PCI to PCI DMA transfer
70clipping
71yuv
72rgb16
73rgb24
74rgb32
75.Ed
76.Pp
77On these cards, tuners and other components are interconnected with an I2C bus.
78The Brooktree848 chips act as a master device on the bus to control them.
79.Pp
80The following kernel configuration options are available:
81.Pp
82.Bl -tag -width xxxxxxxx
83.It Cd option BROOKTREE_ALLOC_PAGES=nnn
84Specifies the number of contiguous pages to allocate when successfully
85probed.
86The default number of pages allocated by the kernel is 216.
87This means that there are (216*4096) bytes available for use.
88.It Cd option BROOKTREE_SYSTEM_DEFAULT="(BROOKTREE_PAL | BROOKTREE_NTSC)"
89One of these options can be used to set the default video format for the driver.
90This fixed random hangs and lockups with the VideoLogic Captivator PCI card.
91.El
92.Sh SEE ALSO
93.Xr intro 4 ,
94.Xr pci 4 ,
95.Xr radio 4
96.Sh HISTORY
97The
98.Nm
99driver first appeared in
100.Fx 2.2 .
101.Sh AUTHORS
102The
103.Nm
104driver is based on the work of
105.An Jim Lowe Aq james@miller.cs.uwm.edu ,
106.An Mark Tinguely Aq tinguely@plains.nodak.edu ,
107.An Amancio Hasty Aq hasty@star\-gate.com ,
108.An Roger Hardiman Aq roger@FreeBSD.org
109and a bunch of other people.
110.Sh CAVEATS
111On big-endian architectures it is not possible to program the
112card to perform proper byte swapping in 24 bit modes,
113therefore only 16 and 32 bit modes are supported.
114