2 * Multimedia device API
4 * Copyright (C) 2010 Nokia Corporation
6 * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
7 * Sakari Ailus <sakari.ailus@iki.fi>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #ifndef __LINUX_MEDIA_H
24 #define __LINUX_MEDIA_H
29 #include <linux/ioctl.h>
30 #include <linux/types.h>
31 #include <linux/version.h>
33 struct media_device_info {
44 #define MEDIA_ENT_ID_FLAG_NEXT (1 << 31)
47 * Initial value to be used when a new entity is created
48 * Drivers should change it to something useful
50 #define MEDIA_ENT_F_UNKNOWN 0x00000000
53 * Base number ranges for entity functions
55 * NOTE: those ranges and entity function number are phased just to
56 * make it easier to maintain this file. Userspace should not rely on
57 * the ranges to identify a group of function types, as newer
58 * functions can be added with any name within the full u32 range.
60 #define MEDIA_ENT_F_BASE 0x00000000
61 #define MEDIA_ENT_F_OLD_BASE 0x00010000
62 #define MEDIA_ENT_F_OLD_SUBDEV_BASE 0x00020000
67 #define MEDIA_ENT_F_DTV_DEMOD (MEDIA_ENT_F_BASE + 0x00001)
68 #define MEDIA_ENT_F_TS_DEMUX (MEDIA_ENT_F_BASE + 0x00002)
69 #define MEDIA_ENT_F_DTV_CA (MEDIA_ENT_F_BASE + 0x00003)
70 #define MEDIA_ENT_F_DTV_NET_DECAP (MEDIA_ENT_F_BASE + 0x00004)
75 #define MEDIA_ENT_F_IO_DTV (MEDIA_ENT_F_BASE + 0x01001)
76 #define MEDIA_ENT_F_IO_VBI (MEDIA_ENT_F_BASE + 0x01002)
77 #define MEDIA_ENT_F_IO_SWRADIO (MEDIA_ENT_F_BASE + 0x01003)
80 * Analog TV IF-PLL decoders
82 * It is a responsibility of the master/bridge drivers to create links
83 * for MEDIA_ENT_F_IF_VID_DECODER and MEDIA_ENT_F_IF_AUD_DECODER.
85 #define MEDIA_ENT_F_IF_VID_DECODER (MEDIA_ENT_F_BASE + 0x02001)
86 #define MEDIA_ENT_F_IF_AUD_DECODER (MEDIA_ENT_F_BASE + 0x02002)
89 * Audio Entity Functions
91 #define MEDIA_ENT_F_AUDIO_CAPTURE (MEDIA_ENT_F_BASE + 0x03001)
92 #define MEDIA_ENT_F_AUDIO_PLAYBACK (MEDIA_ENT_F_BASE + 0x03002)
93 #define MEDIA_ENT_F_AUDIO_MIXER (MEDIA_ENT_F_BASE + 0x03003)
98 #define MEDIA_ENT_F_PROC_VIDEO_COMPOSER (MEDIA_ENT_F_BASE + 0x4001)
99 #define MEDIA_ENT_F_PROC_VIDEO_PIXEL_FORMATTER (MEDIA_ENT_F_BASE + 0x4002)
100 #define MEDIA_ENT_F_PROC_VIDEO_PIXEL_ENC_CONV (MEDIA_ENT_F_BASE + 0x4003)
101 #define MEDIA_ENT_F_PROC_VIDEO_LUT (MEDIA_ENT_F_BASE + 0x4004)
102 #define MEDIA_ENT_F_PROC_VIDEO_SCALER (MEDIA_ENT_F_BASE + 0x4005)
103 #define MEDIA_ENT_F_PROC_VIDEO_STATISTICS (MEDIA_ENT_F_BASE + 0x4006)
106 * Switch and bridge entitites
108 #define MEDIA_ENT_F_VID_MUX (MEDIA_ENT_F_BASE + 0x5001)
109 #define MEDIA_ENT_F_VID_IF_BRIDGE (MEDIA_ENT_F_BASE + 0x5002)
114 /* It is a responsibility of the entity drivers to add connectors and links */
117 * For now, it should not be used in userspace, as some
118 * definitions may change
121 #define MEDIA_ENT_F_CONN_RF (MEDIA_ENT_F_BASE + 0x30001)
122 #define MEDIA_ENT_F_CONN_SVIDEO (MEDIA_ENT_F_BASE + 0x30002)
123 #define MEDIA_ENT_F_CONN_COMPOSITE (MEDIA_ENT_F_BASE + 0x30003)
128 * Don't touch on those. The ranges MEDIA_ENT_F_OLD_BASE and
129 * MEDIA_ENT_F_OLD_SUBDEV_BASE are kept to keep backward compatibility
130 * with the legacy v1 API.The number range is out of range by purpose:
131 * several previously reserved numbers got excluded from this range.
133 * Subdevs are initialized with MEDIA_ENT_T_V4L2_SUBDEV_UNKNOWN,
134 * in order to preserve backward compatibility.
135 * Drivers must change to the proper subdev type before
136 * registering the entity.
139 #define MEDIA_ENT_F_IO_V4L (MEDIA_ENT_F_OLD_BASE + 1)
141 #define MEDIA_ENT_F_CAM_SENSOR (MEDIA_ENT_F_OLD_SUBDEV_BASE + 1)
142 #define MEDIA_ENT_F_FLASH (MEDIA_ENT_F_OLD_SUBDEV_BASE + 2)
143 #define MEDIA_ENT_F_LENS (MEDIA_ENT_F_OLD_SUBDEV_BASE + 3)
144 #define MEDIA_ENT_F_ATV_DECODER (MEDIA_ENT_F_OLD_SUBDEV_BASE + 4)
146 * It is a responsibility of the master/bridge drivers to add connectors
147 * and links for MEDIA_ENT_F_TUNER. Please notice that some old tuners
148 * may require the usage of separate I2C chips to decode analog TV signals,
149 * when the master/bridge chipset doesn't have its own TV standard decoder.
150 * On such cases, the IF-PLL staging is mapped via one or two entities:
151 * MEDIA_ENT_F_IF_VID_DECODER and/or MEDIA_ENT_F_IF_AUD_DECODER.
153 #define MEDIA_ENT_F_TUNER (MEDIA_ENT_F_OLD_SUBDEV_BASE + 5)
155 #define MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN MEDIA_ENT_F_OLD_SUBDEV_BASE
157 #if !defined(__KERNEL__) || defined(__NEED_MEDIA_LEGACY_API)
160 * Legacy symbols used to avoid userspace compilation breakages
162 * Those symbols map the entity function into types and should be
163 * used only on legacy programs for legacy hardware. Don't rely
164 * on those for MEDIA_IOC_G_TOPOLOGY.
166 #define MEDIA_ENT_TYPE_SHIFT 16
167 #define MEDIA_ENT_TYPE_MASK 0x00ff0000
168 #define MEDIA_ENT_SUBTYPE_MASK 0x0000ffff
170 /* End of the old subdev reserved numberspace */
171 #define MEDIA_ENT_T_DEVNODE_UNKNOWN (MEDIA_ENT_T_DEVNODE | \
172 MEDIA_ENT_SUBTYPE_MASK)
174 #define MEDIA_ENT_T_DEVNODE MEDIA_ENT_F_OLD_BASE
175 #define MEDIA_ENT_T_DEVNODE_V4L MEDIA_ENT_F_IO_V4L
176 #define MEDIA_ENT_T_DEVNODE_FB (MEDIA_ENT_T_DEVNODE + 2)
177 #define MEDIA_ENT_T_DEVNODE_ALSA (MEDIA_ENT_T_DEVNODE + 3)
178 #define MEDIA_ENT_T_DEVNODE_DVB (MEDIA_ENT_T_DEVNODE + 4)
180 #define MEDIA_ENT_T_UNKNOWN MEDIA_ENT_F_UNKNOWN
181 #define MEDIA_ENT_T_V4L2_VIDEO MEDIA_ENT_F_IO_V4L
182 #define MEDIA_ENT_T_V4L2_SUBDEV MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN
183 #define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR MEDIA_ENT_F_CAM_SENSOR
184 #define MEDIA_ENT_T_V4L2_SUBDEV_FLASH MEDIA_ENT_F_FLASH
185 #define MEDIA_ENT_T_V4L2_SUBDEV_LENS MEDIA_ENT_F_LENS
186 #define MEDIA_ENT_T_V4L2_SUBDEV_DECODER MEDIA_ENT_F_ATV_DECODER
187 #define MEDIA_ENT_T_V4L2_SUBDEV_TUNER MEDIA_ENT_F_TUNER
189 /* Obsolete symbol for media_version, no longer used in the kernel */
190 #define MEDIA_API_VERSION KERNEL_VERSION(0, 1, 0)
194 #define MEDIA_ENT_FL_DEFAULT (1 << 0)
195 #define MEDIA_ENT_FL_CONNECTOR (1 << 1)
197 struct media_entity_desc {
210 /* Node specifications */
218 * TODO: this shouldn't have been added without
219 * actual drivers that use this. When the first real driver
220 * appears that sets this information, special attention
221 * should be given whether this information is 1) enough, and
222 * 2) can deal with udev rules that rename devices. The struct
223 * dev would not be sufficient for this since that does not
224 * contain the subdevice information. In addition, struct dev
225 * can only refer to a single device, and not to multiple (e.g.
226 * pcm and mixer devices).
228 * So for now mark this as a to do.
239 * DEPRECATED: previous node specifications. Kept just to
240 * avoid breaking compilation, but media_entity_desc.dev
241 * should be used instead. In particular, alsa and dvb
242 * fields below are wrong: for all devnodes, there should
243 * be just major/minor inside the struct, as this is enough
244 * to represent any devnode, no matter what type.
257 /* Sub-device specifications */
258 /* Nothing needed yet */
263 #define MEDIA_PAD_FL_SINK (1 << 0)
264 #define MEDIA_PAD_FL_SOURCE (1 << 1)
265 #define MEDIA_PAD_FL_MUST_CONNECT (1 << 2)
267 struct media_pad_desc {
268 __u32 entity; /* entity ID */
269 __u16 index; /* pad index */
270 __u32 flags; /* pad flags */
274 #define MEDIA_LNK_FL_ENABLED (1 << 0)
275 #define MEDIA_LNK_FL_IMMUTABLE (1 << 1)
276 #define MEDIA_LNK_FL_DYNAMIC (1 << 2)
278 #define MEDIA_LNK_FL_LINK_TYPE (0xf << 28)
279 # define MEDIA_LNK_FL_DATA_LINK (0 << 28)
280 # define MEDIA_LNK_FL_INTERFACE_LINK (1 << 28)
282 struct media_link_desc {
283 struct media_pad_desc source;
284 struct media_pad_desc sink;
289 struct media_links_enum {
291 /* Should have enough room for pads elements */
292 struct media_pad_desc __user *pads;
293 /* Should have enough room for links elements */
294 struct media_link_desc __user *links;
298 /* Interface type ranges */
300 #define MEDIA_INTF_T_DVB_BASE 0x00000100
301 #define MEDIA_INTF_T_V4L_BASE 0x00000200
302 #define MEDIA_INTF_T_ALSA_BASE 0x00000300
304 /* Interface types */
306 #define MEDIA_INTF_T_DVB_FE (MEDIA_INTF_T_DVB_BASE)
307 #define MEDIA_INTF_T_DVB_DEMUX (MEDIA_INTF_T_DVB_BASE + 1)
308 #define MEDIA_INTF_T_DVB_DVR (MEDIA_INTF_T_DVB_BASE + 2)
309 #define MEDIA_INTF_T_DVB_CA (MEDIA_INTF_T_DVB_BASE + 3)
310 #define MEDIA_INTF_T_DVB_NET (MEDIA_INTF_T_DVB_BASE + 4)
312 #define MEDIA_INTF_T_V4L_VIDEO (MEDIA_INTF_T_V4L_BASE)
313 #define MEDIA_INTF_T_V4L_VBI (MEDIA_INTF_T_V4L_BASE + 1)
314 #define MEDIA_INTF_T_V4L_RADIO (MEDIA_INTF_T_V4L_BASE + 2)
315 #define MEDIA_INTF_T_V4L_SUBDEV (MEDIA_INTF_T_V4L_BASE + 3)
316 #define MEDIA_INTF_T_V4L_SWRADIO (MEDIA_INTF_T_V4L_BASE + 4)
317 #define MEDIA_INTF_T_V4L_TOUCH (MEDIA_INTF_T_V4L_BASE + 5)
319 #define MEDIA_INTF_T_ALSA_PCM_CAPTURE (MEDIA_INTF_T_ALSA_BASE)
320 #define MEDIA_INTF_T_ALSA_PCM_PLAYBACK (MEDIA_INTF_T_ALSA_BASE + 1)
321 #define MEDIA_INTF_T_ALSA_CONTROL (MEDIA_INTF_T_ALSA_BASE + 2)
322 #define MEDIA_INTF_T_ALSA_COMPRESS (MEDIA_INTF_T_ALSA_BASE + 3)
323 #define MEDIA_INTF_T_ALSA_RAWMIDI (MEDIA_INTF_T_ALSA_BASE + 4)
324 #define MEDIA_INTF_T_ALSA_HWDEP (MEDIA_INTF_T_ALSA_BASE + 5)
325 #define MEDIA_INTF_T_ALSA_SEQUENCER (MEDIA_INTF_T_ALSA_BASE + 6)
326 #define MEDIA_INTF_T_ALSA_TIMER (MEDIA_INTF_T_ALSA_BASE + 7)
329 * MC next gen API definitions
331 * NOTE: The declarations below are close to the MC RFC for the Media
332 * Controller, the next generation. Yet, there are a few adjustments
333 * to do, as we want to be able to have a functional API before
334 * the MC properties change. Those will be properly marked below.
335 * Please also notice that I removed "num_pads", "num_links",
336 * from the proposal, as a proper userspace application will likely
337 * use lists for pads/links, just as we intend to do in Kernelspace.
338 * The API definition should be freed from fields that are bound to
339 * some specific data structure.
341 * FIXME: Currently, I opted to name the new types as "media_v2", as this
342 * won't cause any conflict with the Kernelspace namespace, nor with
343 * the previous kAPI media_*_desc namespace. This can be changed
344 * later, before the adding this API upstream.
348 struct media_v2_entity {
350 char name[64]; /* FIXME: move to a property? (RFC says so) */
351 __u32 function; /* Main function of the entity */
353 } __attribute__ ((packed));
355 /* Should match the specific fields at media_intf_devnode */
356 struct media_v2_intf_devnode {
359 } __attribute__ ((packed));
361 struct media_v2_interface {
368 struct media_v2_intf_devnode devnode;
371 } __attribute__ ((packed));
373 struct media_v2_pad {
378 } __attribute__ ((packed));
380 struct media_v2_link {
386 } __attribute__ ((packed));
388 struct media_v2_topology {
389 __u64 topology_version;
395 __u32 num_interfaces;
397 __u64 ptr_interfaces;
406 } __attribute__ ((packed));
410 #define MEDIA_IOC_DEVICE_INFO _IOWR('|', 0x00, struct media_device_info)
411 #define MEDIA_IOC_ENUM_ENTITIES _IOWR('|', 0x01, struct media_entity_desc)
412 #define MEDIA_IOC_ENUM_LINKS _IOWR('|', 0x02, struct media_links_enum)
413 #define MEDIA_IOC_SETUP_LINK _IOWR('|', 0x03, struct media_link_desc)
414 #define MEDIA_IOC_G_TOPOLOGY _IOWR('|', 0x04, struct media_v2_topology)
416 #endif /* __LINUX_MEDIA_H */