spi: bcm2835aux: fix CPOL/CPHA setting
[cascardo/linux.git] / Documentation / DocBook / media / v4l / media-types.xml
1 <section id="media-controller-types">
2 <title>Types and flags used to represent the media graph elements</title>
3
4     <table frame="none" pgwide="1" id="media-entity-type">
5       <title>Media entity types</title>
6       <tgroup cols="2">
7         <colspec colname="c1"/>
8         <colspec colname="c2"/>
9         <tbody valign="top">
10           <row>
11             <entry><constant>MEDIA_ENT_F_UNKNOWN</constant> and <constant>MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN</constant></entry>
12             <entry>Unknown entity. That generally indicates that
13             a driver didn't initialize properly the entity, with is a Kernel bug</entry>
14           </row>
15           <row>
16             <entry><constant>MEDIA_ENT_F_IO_V4L</constant></entry>
17             <entry>Data streaming input and/or output entity.</entry>
18           </row>
19           <row>
20             <entry><constant>MEDIA_ENT_F_IO_VBI</constant></entry>
21             <entry>V4L VBI streaming input or output entity</entry>
22           </row>
23           <row>
24             <entry><constant>MEDIA_ENT_F_IO_SWRADIO</constant></entry>
25             <entry>V4L Software Digital Radio (SDR) streaming input or output entity</entry>
26           </row>
27           <row>
28             <entry><constant>MEDIA_ENT_F_IO_DTV</constant></entry>
29             <entry>DVB Digital TV streaming input or output entity</entry>
30           </row>
31           <row>
32             <entry><constant>MEDIA_ENT_F_DTV_DEMOD</constant></entry>
33             <entry>Digital TV demodulator entity.</entry>
34           </row>
35           <row>
36             <entry><constant>MEDIA_ENT_F_TS_DEMUX</constant></entry>
37             <entry>MPEG Transport stream demux entity. Could be implemented on hardware or in Kernelspace by the Linux DVB subsystem.</entry>
38           </row>
39           <row>
40             <entry><constant>MEDIA_ENT_F_DTV_CA</constant></entry>
41             <entry>Digital TV Conditional Access module (CAM) entity</entry>
42           </row>
43           <row>
44             <entry><constant>MEDIA_ENT_F_DTV_NET_DECAP</constant></entry>
45             <entry>Digital TV network ULE/MLE desencapsulation entity. Could be implemented on hardware or in Kernelspace</entry>
46           </row>
47           <row>
48             <entry><constant>MEDIA_ENT_F_CONN_RF</constant></entry>
49             <entry>Connector for a Radio Frequency (RF) signal.</entry>
50           </row>
51           <row>
52             <entry><constant>MEDIA_ENT_F_CONN_SVIDEO</constant></entry>
53             <entry>Connector for a S-Video signal.</entry>
54           </row>
55           <row>
56             <entry><constant>MEDIA_ENT_F_CONN_COMPOSITE</constant></entry>
57             <entry>Connector for a RGB composite signal.</entry>
58           </row>
59           <row>
60             <entry><constant>MEDIA_ENT_F_CONN_TEST</constant></entry>
61             <entry>Connector for a test generator.</entry>
62           </row>
63           <row>
64             <entry><constant>MEDIA_ENT_F_CAM_SENSOR</constant></entry>
65             <entry>Camera video sensor entity.</entry>
66           </row>
67           <row>
68             <entry><constant>MEDIA_ENT_F_FLASH</constant></entry>
69             <entry>Flash controller entity.</entry>
70           </row>
71           <row>
72             <entry><constant>MEDIA_ENT_F_LENS</constant></entry>
73             <entry>Lens controller entity.</entry>
74           </row>
75           <row>
76             <entry><constant>MEDIA_ENT_F_ATV_DECODER</constant></entry>
77             <entry>Analog video decoder, the basic function of the video decoder
78             is to accept analogue video from a wide variety of sources such as
79             broadcast, DVD players, cameras and video cassette recorders, in
80             either NTSC, PAL, SECAM or HD format, separating the stream
81             into its component parts, luminance and chrominance, and output
82             it in some digital video standard, with appropriate timing
83             signals.</entry>
84           </row>
85           <row>
86             <entry><constant>MEDIA_ENT_F_TUNER</constant></entry>
87             <entry>Digital TV, analog TV, radio and/or software radio tuner.</entry>
88           </row>
89         </tbody>
90       </tgroup>
91     </table>
92
93     <table frame="none" pgwide="1" id="media-entity-flag">
94       <title>Media entity flags</title>
95       <tgroup cols="2">
96         <colspec colname="c1"/>
97         <colspec colname="c2"/>
98         <tbody valign="top">
99           <row>
100             <entry><constant>MEDIA_ENT_FL_DEFAULT</constant></entry>
101             <entry>Default entity for its type. Used to discover the default
102             audio, VBI and video devices, the default camera sensor, ...</entry>
103           </row>
104           <row>
105             <entry><constant>MEDIA_ENT_FL_CONNECTOR</constant></entry>
106             <entry>The entity represents a data conector</entry>
107           </row>
108         </tbody>
109       </tgroup>
110     </table>
111
112     <table frame="none" pgwide="1" id="media-intf-type">
113       <title>Media interface types</title>
114       <tgroup cols="3">
115         <colspec colname="c1"/>
116         <colspec colname="c2"/>
117         <colspec colname="c3"/>
118         <tbody valign="top">
119           <row>
120             <entry><constant>MEDIA_INTF_T_DVB_FE</constant></entry>
121             <entry>Device node interface for the Digital TV frontend</entry>
122             <entry>typically, /dev/dvb/adapter?/frontend?</entry>
123           </row>
124           <row>
125             <entry><constant>MEDIA_INTF_T_DVB_DEMUX</constant></entry>
126             <entry>Device node interface for the Digital TV demux</entry>
127             <entry>typically, /dev/dvb/adapter?/demux?</entry>
128           </row>
129           <row>
130             <entry><constant>MEDIA_INTF_T_DVB_DVR</constant></entry>
131             <entry>Device node interface for the Digital TV DVR</entry>
132             <entry>typically, /dev/dvb/adapter?/dvr?</entry>
133           </row>
134           <row>
135             <entry><constant>MEDIA_INTF_T_DVB_CA</constant></entry>
136             <entry>Device node interface for the Digital TV Conditional Access</entry>
137             <entry>typically, /dev/dvb/adapter?/ca?</entry>
138           </row>
139           <row>
140             <entry><constant>MEDIA_INTF_T_DVB_FE</constant></entry>
141             <entry>Device node interface for the Digital TV network control</entry>
142             <entry>typically, /dev/dvb/adapter?/net?</entry>
143           </row>
144           <row>
145             <entry><constant>MEDIA_INTF_T_V4L_VIDEO</constant></entry>
146             <entry>Device node interface for video (V4L)</entry>
147             <entry>typically, /dev/video?</entry>
148           </row>
149           <row>
150             <entry><constant>MEDIA_INTF_T_V4L_VBI</constant></entry>
151             <entry>Device node interface for VBI (V4L)</entry>
152             <entry>typically, /dev/vbi?</entry>
153           </row>
154           <row>
155             <entry><constant>MEDIA_INTF_T_V4L_RADIO</constant></entry>
156             <entry>Device node interface for radio (V4L)</entry>
157             <entry>typically, /dev/vbi?</entry>
158           </row>
159           <row>
160             <entry><constant>MEDIA_INTF_T_V4L_SUBDEV</constant></entry>
161             <entry>Device node interface for a V4L subdevice</entry>
162             <entry>typically, /dev/v4l-subdev?</entry>
163           </row>
164           <row>
165             <entry><constant>MEDIA_INTF_T_V4L_SWRADIO</constant></entry>
166             <entry>Device node interface for Software Defined Radio (V4L)</entry>
167             <entry>typically, /dev/swradio?</entry>
168           </row>
169         </tbody>
170       </tgroup>
171     </table>
172
173     <table frame="none" pgwide="1" id="media-pad-flag">
174       <title>Media pad flags</title>
175       <tgroup cols="2">
176         <colspec colname="c1"/>
177         <colspec colname="c2"/>
178         <tbody valign="top">
179           <row>
180             <entry><constant>MEDIA_PAD_FL_SINK</constant></entry>
181             <entry>Input pad, relative to the entity. Input pads sink data and
182             are targets of links.</entry>
183           </row>
184           <row>
185             <entry><constant>MEDIA_PAD_FL_SOURCE</constant></entry>
186             <entry>Output pad, relative to the entity. Output pads source data
187             and are origins of links.</entry>
188           </row>
189           <row>
190             <entry><constant>MEDIA_PAD_FL_MUST_CONNECT</constant></entry>
191             <entry>If this flag is set and the pad is linked to any other
192             pad, then at least one of those links must be enabled for the
193             entity to be able to stream. There could be temporary reasons
194             (e.g. device configuration dependent) for the pad to need
195             enabled links even when this flag isn't set; the absence of the
196             flag doesn't imply there is none.</entry>
197           </row>
198         </tbody>
199       </tgroup>
200     </table>
201
202     <para>One and only one of <constant>MEDIA_PAD_FL_SINK</constant> and
203     <constant>MEDIA_PAD_FL_SOURCE</constant> must be set for every pad.</para>
204
205     <table frame="none" pgwide="1" id="media-link-flag">
206       <title>Media link flags</title>
207       <tgroup cols="2">
208         <colspec colname="c1"/>
209         <colspec colname="c2"/>
210         <tbody valign="top">
211           <row>
212             <entry><constant>MEDIA_LNK_FL_ENABLED</constant></entry>
213             <entry>The link is enabled and can be used to transfer media data.
214             When two or more links target a sink pad, only one of them can be
215             enabled at a time.</entry>
216           </row>
217           <row>
218             <entry><constant>MEDIA_LNK_FL_IMMUTABLE</constant></entry>
219             <entry>The link enabled state can't be modified at runtime. An
220             immutable link is always enabled.</entry>
221           </row>
222           <row>
223             <entry><constant>MEDIA_LNK_FL_DYNAMIC</constant></entry>
224             <entry>The link enabled state can be modified during streaming. This
225             flag is set by drivers and is read-only for applications.</entry>
226           </row>
227           <row>
228             <entry><constant>MEDIA_LNK_FL_LINK_TYPE</constant></entry>
229             <entry><para>This is a bitmask that defines the type of the link.
230                    Currently, two types of links are supported:</para>
231             <para><constant>MEDIA_LNK_FL_DATA_LINK</constant>
232             if the link is between two pads</para>
233             <para><constant>MEDIA_LNK_FL_INTERFACE_LINK</constant>
234             if the link is between an interface and an entity</para></entry>
235           </row>
236         </tbody>
237       </tgroup>
238     </table>
239
240 </section>