Remove the meteor(4) driver.
[dragonfly.git] / share / man / man4 / cxm.4
1 .\"
2 .\" Copyright (c) 2009
3 .\"     The DragonFly Project.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in
13 .\"    the documentation and/or other materials provided with the
14 .\"    distribution.
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\"    contributors may be used to endorse or promote products derived
17 .\"    from this software without specific, prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" $Id: cxm.4,v 1.1 2004/10/16 00:12:35 mavetju Exp $
33 .\"
34 .Dd February 24, 2011
35 .Dt CXM 4
36 .Os
37 .Sh NAME
38 .Nm cxm
39 .Nd Conexant iTVC MPEG Coder
40 .Sh SYNOPSIS
41 To compile this driver into the kernel, place the following lines in
42 your kernel configuration file:
43 .Bd -ragged -offset indent
44 .Cd "device iicbus"
45 .Cd "device iic"
46 .Cd "device iicbb"
47 .Cd "device cxm"
48 .Ed
49 .\".Pp
50 .\"Alternatively, to load the driver as a module at boot time, place the
51 .\"following line in
52 .\".Pa /boot/loader.conf :
53 .\".Bd -literal -offset indent
54 .\"cxm_load="YES"
55 .\".Ed
56 .Sh DESCRIPTION
57 The
58 .Nm
59 driver provides support for the PCI
60 .Em video
61 capture on the Hauppauge PVR-250/350.
62 It uses the
63 .Xr bktr 4
64 and Meteor driver ioctls.
65 .Pp
66 Note that in order for the
67 .Xr cxm 4
68 driver to work properly, the necessary firmware files have to be extracted
69 from the driver CD-ROM prior to compiling the kernel.
70 The tool necessary to do this can be found in
71 .Pa /usr/src/tools/multimedia/cxm/extract_fw .
72 .Sh HARDWARE
73 The following cards are known to work:
74 .Pp
75 .Bl -bullet -compact
76 .It
77 Hauppauge PVR-250
78 .It
79 Hauppauge PVR-350
80 .El
81 .Pp
82 The following tuners are known to work:
83 .Pp
84 .Bl -bullet -compact
85 .It
86 Philips FI1216 MK2
87 .It
88 Philips FI1236 MK2
89 .It
90 Philips FI1246 MK2
91 .It
92 Philips FM1216
93 .It
94 Philips FM1216ME MK3
95 .It
96 Philips FM1236
97 .It
98 Philips FM1246
99 .It
100 Philips FQ1216ME
101 .It
102 Philips FQ1216ME MK3
103 .It
104 Temic 4006 FH5
105 .It
106 Temic 4009 FR5
107 .It
108 Temic 4036 FY5
109 .It
110 Temic 4039 FR5
111 .It
112 Temic 4066 FY5
113 .It
114 LG Innotek TPI8PSB11D
115 .It
116 LG Innotek TPI8PSB01N
117 .It
118 LG Innotek TAPC-H701F
119 .It
120 LG Innotek TAPC-H001F
121 .It
122 LG Innotek TAPE-H001F
123 .It
124 Microtune 4049 FM5
125 .It
126 TCL 2002N-6A
127 .It
128 TCL M2523-5N-E
129 .El
130 .Sh FILES
131 .Bl -tag -width ".Pa /usr/src/tools/multimedia/cxm/extract_fw" -compact
132 .\".It Pa /boot/modules/cxm.ko
133 .\"Kernel module
134 .\".It Pa /boot/modules/cxm_iic.ko
135 .\"Kernel module
136 .It Pa /dev/cxm0
137 Device
138 .It Pa /usr/src/tools/multimedia/cxm/extract_fw
139 Firmware extraction tool
140 .It Pa /usr/src/tools/multimedia/cxm/setchannel
141 Channel switching tool
142 .\".It Pa /usr/local/bin/pvr250-setsize
143 .\"Set size of capture windows
144 .El
145 .Sh EXAMPLES
146 To access the video card, use
147 .Pa /dev/cxm0 .
148 For example:
149 .Pp
150 .Dl "cat /dev/cxm0 > filename.mpg"
151 .Sh SEE ALSO
152 .Xr cxm_setchannel 1 ,
153 .Xr bktr 4 ,
154 .Xr cxm_extract_fw 8
155 .Sh HISTORY
156 The
157 .Nm
158 driver first appeared in the
159 .Pa FreeBSD-multimedia@
160 mailing list in January 2004 and in the
161 .Fx
162 Ports collection in October 2004.
163 .Pp
164 It was ported to
165 .Dx 2.3
166 by
167 .An Sascha Wildner .
168 .Sh AUTHORS
169 .An -nosplit
170 This driver was made by
171 .An John Wehle Aq john@feith.com
172 and this manual page was made by
173 .An Edwin Groothuis Aq edwin@FreeBSD.org .