share/man/man4/bktr.4

   1 .\"
   2 .\" $FreeBSD$
   3 .\"
   4 .Dd January 18, 2006
   5 .Dt BKTR 4
   6 .Os
   7 .Sh NAME
   8 .Nm bktr
   9 .Nd Brooktree Bt848/849/878/879 and Pinnacle PCTV 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.
  24 The driver is based on the Matrox Meteor driver and uses the same API.
  25 The
  26 .Nm
  27 driver should support most video cards based on the
  28 .Em "Brooktree Bt848/849/878/879 Video Capture Chip" .
  29 Also supported are most
  30 .Em "Pinnacle PCTV"
  31 video cards.
  32 Furthermore, the driver supports
  33 .Em FM Radio
  34 if the tuner supports it.
  35 .Pp
  36 The driver currently supports the following features:
  37 .Bd -unfilled -offset indent
  38 PCI to PCI dma transfer
  39 clipping
  40 yuv
  41 rgb16
  42 rgb24
  43 rgb32
  44 .Ed
  45 .Pp
  46 On the supported cards, tuners and other components are interconnected
  47 with an I2C bus.
  48 The Brooktree848 chips act as a master device on the bus to control them.
  49 Therefore,
  50 .Xr iicbus 4 ,
  51 .Xr iicbb 4
  52 and
  53 .Xr smbus 4
  54 controller declarations are mandatory to activate
  55 .Nm
  56 support.
  57 .Pp
  58 The following kernel parameters may be used to further configure the driver:
  59 .Pp
  60 .Em options "BROOKTREE_ALLOC_PAGES=xxx"
  61 specifies the number of contiguous pages to allocate when successfully
  62 probed.
  63 The default number of pages allocated by the kernel is 216.
  64 This means that there are (216*4096) bytes available for use.
  65 .Bd -unfilled
  66 .Cd options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
  67 .Cd options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
  68 .Ed
  69 One of these options can be used to set the default video format for the driver.
  70 This fixed random hangs and lockups with the VideoLogic Captivator PCI card.
  71 .Pp
  72 The following sysctls may be used to further configure the driver:
  73 .Pp
  74 .Em sysctl hw.bt848.card=nnnn
  75 This can be used to override the card make which was detected at boot time.
  76 .Ql nnnn
  77 is set to an integer from 1 to 23 taken from the following table:
  78 .Pp
  79 .Bl -tag -compact -width 30n
  80 .It MIRO
  81 1
  82 .It HAUPPAUGE
  83 2
  84 .It STB
  85 3
  86 .It INTEL
  87 4
  88 .It IMS_TURBO
  89 5
  90 .It AVER_MEDIA
  91 6
  92 .It OSPREY
  93 7
  94 .It NEC_PK
  95 8
  96 .It IO_GV
  97 9
  98 .It FLYVIDEO
  99 10
 100 .It ZOLTRIX
 101 11
 102 .It KISS
 103 12
 104 .It VIDEO_HIGHWAY_XTREME
 105 13
 106 .It ASKEY_DYNALINK_MAGIC_TVIEW
 107 14
 108 .It LEADTEK
 109 15
 110 .It TERRATVPLUS
 111 16
 112 .It IO_BCTV3
 113 17
 114 .It AOPEN_VA1000
 115 18
 116 .It PINNACLE_PCTV_RAVE
 117 19
 118 .It PIXELVIEW_PLAYTV_PAK
 119 20
 120 .It TERRATVALUE
 121 21
 122 .It PIXELVIEW_PLAYTV_PRO_REV_4C
 123 22
 124 .It Bt848_MAX
 125 23
 126 .El
 127 .Pp
 128 .Em sysctl hw.bt848.tuner=nnnn
 129 This can be used to override the tuner make which was detected at boot time.
 130 .Ql nnnn
 131 is set to an integer from 0 to 16 taken from the following table:
 132 .Pp
 133 .Bl -tag -compact -width 22n
 134 .It NO_TUNER
 135 0
 136 .It TEMIC_NTSC
 137 1
 138 .It TEMIC_PAL
 139 2
 140 .It TEMIC_SECAM
 141 3
 142 .It PHILIPS_NTSC
 143 4
 144 .It PHILIPS_PAL
 145 5
 146 .It PHILIPS_SECAM
 147 6
 148 .It TEMIC_PALI
 149 7
 150 .It PHILIPS_PALI
 151 8
 152 .It PHILIPS_FR1236_NTSC
 153 9       /* These have FM Radio support */
 154 .It PHILIPS_FR1216_PAL
 155 10      /* These have FM Radio support */
 156 .It PHILIPS_FR1236_SECAM
 157 11      /* These have FM Radio support */
 158 .It ALPS_TSCH5
 159 12
 160 .It ALPS_TSBH1
 161 13
 162 .It MT2032
 163 14
 164 .It LG_TPI8PSB12P_PAL
 165 15
 166 .It Bt848_MAX
 167 16
 168 .El
 169 .Sh HARDWARE
 170 The
 171 .Nm
 172 driver supports video capture cards based on the
 173 Brooktree Bt848/849/878/879 chips, as well as
 174 Pinnacle PCTV cards, including:
 175 .Pp
 176 .Bl -bullet -compact
 177 .It
 178 AOpen VA1000
 179 .It
 180 AVerMedia AVerTV Studio
 181 .It
 182 AVerMedia TF/FM-98
 183 .It
 184 ATI TV Wonder VE
 185 .It
 186 Hauppauge WinCast/TV
 187 .It
 188 Hauppauge WinTV-Go-FM
 189 .It
 190 Hauppauge WinTV-pci
 191 .It
 192 Hauppauge WinTV-radio
 193 .It
 194 Intel Smart Video Recorder III
 195 .It
 196 KWORLD PCI TV Tuner
 197 .It
 198 Miro PC TV
 199 .It
 200 Pinnacle PCTV Pro
 201 .It
 202 Pinnacle PCTV Rave
 203 .It
 204 PixelView PlayTV PAK
 205 .It
 206 PixelView PlayTV Pro (rev 4C, 9D)
 207 .It
 208 SIGMA TV II
 209 .It
 210 STB TV PCI Television Tuner
 211 .It
 212 Super TV Tuner
 213 .It
 214 TerraTec TValue
 215 .It
 216 V-Stream XPERT TV-PVR 878
 217 .It
 218 Video Highway XTreme
 219 .It
 220 VideoLogic Captivator PCI
 221 .El
 222 .Sh FILES
 223 .Bl -tag -width /usr/share/examples/meteor -compact
 224 .It Pa /usr/share/examples/meteor
 225 Examples of what you can do with the (similarly designed) Meteor driver.
 226 .It Pa /usr/ports/multimedia/fxtv
 227 A TV and Camera display program utilizing the bktr driver - requires that
 228 .Em The X Window System
 229 and
 230 .Em The Ports Collection
 231 also be installed.
 232 .It Pa /usr/ports/misc/alevt
 233 A program to capture and display Teletext (VideoText) pages - requires that
 234 .Em The X Window System
 235 and
 236 .Em The Ports Collection
 237 also be installed.
 238 .It Pa /usr/ports/audio/xmradio
 239 An FM Radio Tuner for cards which have an FM Radio tuner fitted - requires that
 240 .Em The X Window System
 241 and
 242 .Em The Ports Collection
 243 also be installed.
 244 It also requires
 245 .Em Motif
 246 or the
 247 .Em lesstif
 248 port.
 249 .El
 250 .Sh SEE ALSO
 251 .Xr meteor 4
 252 .Sh HISTORY
 253 The
 254 .Nm
 255 driver first appeared in
 256 .Fx 2.2 .
 257 .Sh AUTHORS
 258 .An -nosplit
 259 This driver is based on the work of
 260 .An Jim Lowe Aq james@miller.cs.uwm.edu ,
 261 .An Mark Tinguely Aq tinguely@plains.nodak.edu ,
 262 .An Amancio Hasty Aq hasty@star-gate.com ,
 263 .An Roger Hardiman Aq roger@FreeBSD.org
 264 and a bunch of other people.
 265 Support for Pinnacle PCTV Rave cards was added by
 266 .An Branko Lankester Aq branko@euro.net .