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