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 .\" $DragonFly: src/share/man/man4/bktr.4,v 1.2 2003/06/17 04:36:58 dillon Exp $
   4 .\"
   5 .Dd January 28, 1998
   6 .Dt BKTR 4
   7 .Os
   8 .Sh NAME
   9 .Nm brooktree
  10 .Nd video capture driver
  11 .Sh SYNOPSIS
  12 .Cd device bktr
  13 .Pp
  14 .Cd device iicbus
  15 .Cd device iicbb
  16 .Cd device smbus
  17 .Sh DESCRIPTION
  18 The
  19 .Nm bktr
  20 driver provides support for PCI
  21 .Em video
  22 capture and
  23 .Em VBI
  24 capture on low cost, high performance boards.  The driver is based on
  25 the Matrox Meteor driver and uses the same API.  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.  The default number of pages allocated by the kernel is 216.
  67 This means that there are (216*4096) bytes available for use.
  68 .Bd -unfilled
  69 .Em options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_PAL
  70 .Em options BROOKTREE_SYSTEM_DEFAULT=BROOKTREE_NTSC
  71 .Ed
  72 One of these options can be used to set the default video format for the driver.
  73 This fixed random hangs and lockups with the VideoLogic Captivator PCI card.
  74 .Pp
  75 The following sysctls may be used to further configure the driver:
  76 .Pp
  77 .Em sysctl hw.bt848.card=nnnn
  78 This can be used to override the card make which was detected at boot time.
  79 .Ql nnnn
  80 is set to an integer from 1 to 13 taken from the following table:
  81 .Pp
  82 .Bl -tag -compact -width 22n
  83 .It MIRO
  84 1
  85 .It HAUPPAUGE
  86 2
  87 .It STB
  88 3
  89 .It INTEL
  90 4
  91 .It IMS_TURBO
  92 5
  93 .It AVER_MEDIA
  94 6
  95 .It OSPREY
  96 7
  97 .It NEC_PK
  98 8
  99 .It IO_GV
 100 9
 101 .It FLYVIDEO
 102 10
 103 .It ZOLTRIX
 104 11
 105 .It KISS
 106 12
 107 .It VIDEO_HIGHWAY_XTREME
 108 13
 109 .El
 110 .Pp
 111 .Em sysctl hw.bt848.tuner=nnnn
 112 This can be used to override the tuner make which was detected at boot time.
 113 .Ql nnnn
 114 is set to an integer from 1 to 13 taken from the following table:
 115 .Pp
 116 .Bl -tag -compact -width 22n
 117 .It NO_TUNER
 118 0
 119 .It TEMIC_NTSC
 120 1
 121 .It TEMIC_PAL
 122 2
 123 .It TEMIC_SECAM
 124 3
 125 .It PHILIPS_NTSC
 126 4
 127 .It PHILIPS_PAL
 128 5
 129 .It PHILIPS_SECAM
 130 6
 131 .It TEMIC_PALI
 132 7
 133 .It PHILIPS_PALI
 134 8
 135 .It PHILIPS_FR1236_NTSC
 136 9       /* These have FM Radio support */
 137 .It PHILIPS_FR1216_PAL
 138 10      /* These have FM Radio support */
 139 .It PHILIPS_FR1236_SECAM
 140 11      /* These have FM Radio support */
 141 .It ALPS_TSCH5
 142 12
 143 .It ALPS_TSBH1
 144 13
 145 .El
 146 .Sh AUTHORS
 147 .An -nosplit
 148 This driver is based on the work of
 149 .An Jim Lowe Aq james@miller.cs.uwm.edu ,
 150 .An Mark Tinguely Aq tinguely@plains.nodak.edu ,
 151 .An Amancio Hasty Aq hasty@star\-gate.com ,
 152 .An Roger Hardiman Aq roger@FreeBSD.org
 153 and a bunch of other people.
 154 .Sh FILES
 155 .Bl -tag -width /usr/share/examples/meteor -compact
 156 .It Pa /usr/share/examples/meteor
 157 Examples of what you can do with the (similarly designed) Meteor driver.
 158 .It Pa /usr/ports/graphics/fxtv
 159 A TV and Camera display program utilizing the bktr driver - requires that
 160 .Em The X Window System
 161 and
 162 .Em The Ports Collection
 163 also be installed.
 164 .It Pa /usr/ports/misc/alevt
 165 A program to capture and display Teletext (VideoText) pages - requires that
 166 .Em The X Window System
 167 and
 168 .Em The Ports Collection
 169 also be installed.
 170 .It Pa /usr/ports/audio/xmradio
 171 An FM Radio Tuner for cards which have an FM Radio tuner fitted. - requires that
 172 .Em The X Window System
 173 and
 174 .Em The Ports Collection
 175 also be installed.
 176 It also requires
 177 .Em Motif
 178 or the
 179 .Em lesstif
 180 port.
 181 .El
 182 .Sh SEE ALSO
 183 .Xr meteor 4
 184 .Sh HISTORY
 185 The
 186 .Nm
 187 driver first appeared in
 188 .Fx 2.2 .