share/man/man4/bktr.4

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