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