36633187368d3e47a529ceea063f8a62715aaea5
[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 April 19, 2009
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
65 .Xr meteor 4
66 ioctls.
67 .Pp
68 Note that in order for the
69 .Xr cxm 4
70 driver to work properly, the necessary firmware files have to be extracted
71 from the driver CD-ROM prior to compiling the kernel.
72 The tool necessary to do this can be found in
73 .Pa /usr/src/tools/multimedia/cxm/extract_fw .
74 .Sh HARDWARE
75 The following cards are known to work:
76 .Pp
77 .Bl -bullet -compact
78 .It
79 Hauppauge PVR-250
80 .It
81 Hauppauge PVR-350
82 .El
83 .Pp
84 The following tuners are known to work:
85 .Pp
86 .Bl -bullet -compact
87 .It
88 Philips FI1216 MK2
89 .It
90 Philips FI1236 MK2
91 .It
92 Philips FI1246 MK2
93 .It
94 Philips FM1216
95 .It
96 Philips FM1216ME MK3
97 .It
98 Philips FM1236
99 .It
100 Philips FM1246
101 .It
102 Philips FQ1216ME
103 .It
104 Philips FQ1216ME MK3
105 .It
106 Temic 4006 FH5
107 .It
108 Temic 4009 FR5
109 .It
110 Temic 4036 FY5
111 .It
112 Temic 4039 FR5
113 .It
114 Temic 4066 FY5
115 .It
116 LG Innotek TPI8PSB11D
117 .It
118 LG Innotek TPI8PSB01N
119 .It
120 LG Innotek TAPC-H701F
121 .It
122 LG Innotek TAPC-H001F
123 .It
124 LG Innotek TAPE-H001F
125 .It
126 Microtune 4049 FM5
127 .It
128 TCL 2002N-6A
129 .It
130 TCL M2523-5N-E
131 .El
132 .Sh FILES
133 .Bl -tag -width ".Pa /usr/src/tools/multimedia/cxm/extract_fw" -compact
134 .It Pa /boot/modules/cxm.ko
135 Kernel module
136 .It Pa /boot/modules/cxm_iic.ko
137 Kernel module
138 .It Pa /dev/cxm0
139 Device
140 .It Pa /usr/src/tools/multimedia/cxm/extract_fw
141 Firmware extraction tool
142 .It Pa /usr/src/tools/multimedia/cxm/setchannel
143 Channel switching tool
144 .\".It Pa /usr/local/bin/pvr250-setsize
145 .\"Set size of capture windows
146 .El
147 .Sh EXAMPLES
148 To access the video card, use
149 .Pa /dev/cxm0 .
150 For example:
151 .Pp
152 .Dl "cat /dev/cxm0 > filename.mpg"
153 .Sh SEE ALSO
154 .Xr cxm_setchannel 1 ,
155 .Xr bktr 4 ,
156 .Xr meteor 4 ,
157 .Xr cxm_extract_fw 8
158 .Sh HISTORY
159 The
160 .Nm
161 driver first appeared in the
162 .Pa FreeBSD-multimedia@
163 mailing list in January 2004 and in the
164 .Fx
165 Ports collection in October 2004.
166 .Pp
167 It was ported to
168 .Dx 2.3
169 by
170 .An Sascha Wildner .
171 .Sh AUTHORS
172 .An -nosplit
173 This driver was made by
174 .An John Wehle Aq john@feith.com
175 and this manual page was made by
176 .An Edwin Groothuis Aq edwin@FreeBSD.org .