share/man/man4/bktr.4

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