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 #define MEDIA_API_VERSION KERNEL_VERSION(0, 1, 0)
35 struct media_device_info {
46 #define MEDIA_ENT_ID_FLAG_NEXT (1 << 31)
49 * Initial value to be used when a new entity is created
50 * Drivers should change it to something useful
52 #define MEDIA_ENT_F_UNKNOWN 0x00000000
55 * Base number ranges for entity functions
57 * NOTE: those ranges and entity function number are phased just to
58 * make it easier to maintain this file. Userspace should not rely on
59 * the ranges to identify a group of function types, as newer
60 * functions can be added with any name within the full u32 range.
62 #define MEDIA_ENT_F_BASE 0x00000000
63 #define MEDIA_ENT_F_OLD_BASE 0x00010000
64 #define MEDIA_ENT_F_OLD_SUBDEV_BASE 0x00020000
69 #define MEDIA_ENT_F_DTV_DEMOD (MEDIA_ENT_F_BASE + 0x00001)
70 #define MEDIA_ENT_F_TS_DEMUX (MEDIA_ENT_F_BASE + 0x00002)
71 #define MEDIA_ENT_F_DTV_CA (MEDIA_ENT_F_BASE + 0x00003)
72 #define MEDIA_ENT_F_DTV_NET_DECAP (MEDIA_ENT_F_BASE + 0x00004)
77 #define MEDIA_ENT_F_IO_DTV (MEDIA_ENT_F_BASE + 0x01001)
78 #define MEDIA_ENT_F_IO_VBI (MEDIA_ENT_F_BASE + 0x01002)
79 #define MEDIA_ENT_F_IO_SWRADIO (MEDIA_ENT_F_BASE + 0x01003)
84 /* It is a responsibility of the entity drivers to add connectors and links */
87 * For now, it should not be used in userspace, as some
88 * definitions may change
91 #define MEDIA_ENT_F_CONN_RF (MEDIA_ENT_F_BASE + 0x30001)
92 #define MEDIA_ENT_F_CONN_SVIDEO (MEDIA_ENT_F_BASE + 0x30002)
93 #define MEDIA_ENT_F_CONN_COMPOSITE (MEDIA_ENT_F_BASE + 0x30003)
98 * Don't touch on those. The ranges MEDIA_ENT_F_OLD_BASE and
99 * MEDIA_ENT_F_OLD_SUBDEV_BASE are kept to keep backward compatibility
100 * with the legacy v1 API.The number range is out of range by purpose:
101 * several previously reserved numbers got excluded from this range.
103 * Subdevs are initialized with MEDIA_ENT_T_V4L2_SUBDEV_UNKNOWN,
104 * in order to preserve backward compatibility.
105 * Drivers must change to the proper subdev type before
106 * registering the entity.
109 #define MEDIA_ENT_F_IO_V4L (MEDIA_ENT_F_OLD_BASE + 1)
111 #define MEDIA_ENT_F_CAM_SENSOR (MEDIA_ENT_F_OLD_SUBDEV_BASE + 1)
112 #define MEDIA_ENT_F_FLASH (MEDIA_ENT_F_OLD_SUBDEV_BASE + 2)
113 #define MEDIA_ENT_F_LENS (MEDIA_ENT_F_OLD_SUBDEV_BASE + 3)
114 #define MEDIA_ENT_F_ATV_DECODER (MEDIA_ENT_F_OLD_SUBDEV_BASE + 4)
116 * It is a responsibility of the entity drivers to add connectors and links
117 * for the tuner entities.
119 #define MEDIA_ENT_F_TUNER (MEDIA_ENT_F_OLD_SUBDEV_BASE + 5)
121 #define MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN MEDIA_ENT_F_OLD_SUBDEV_BASE
123 #if !defined(__KERNEL__) || defined(__NEED_MEDIA_LEGACY_API)
126 * Legacy symbols used to avoid userspace compilation breakages
128 * Those symbols map the entity function into types and should be
129 * used only on legacy programs for legacy hardware. Don't rely
130 * on those for MEDIA_IOC_G_TOPOLOGY.
132 #define MEDIA_ENT_TYPE_SHIFT 16
133 #define MEDIA_ENT_TYPE_MASK 0x00ff0000
134 #define MEDIA_ENT_SUBTYPE_MASK 0x0000ffff
136 /* End of the old subdev reserved numberspace */
137 #define MEDIA_ENT_T_DEVNODE_UNKNOWN (MEDIA_ENT_T_DEVNODE | \
138 MEDIA_ENT_SUBTYPE_MASK)
140 #define MEDIA_ENT_T_DEVNODE MEDIA_ENT_F_OLD_BASE
141 #define MEDIA_ENT_T_DEVNODE_V4L MEDIA_ENT_F_IO_V4L
142 #define MEDIA_ENT_T_DEVNODE_FB (MEDIA_ENT_T_DEVNODE + 2)
143 #define MEDIA_ENT_T_DEVNODE_ALSA (MEDIA_ENT_T_DEVNODE + 3)
144 #define MEDIA_ENT_T_DEVNODE_DVB (MEDIA_ENT_T_DEVNODE + 4)
146 #define MEDIA_ENT_T_UNKNOWN MEDIA_ENT_F_UNKNOWN
147 #define MEDIA_ENT_T_V4L2_VIDEO MEDIA_ENT_F_IO_V4L
148 #define MEDIA_ENT_T_V4L2_SUBDEV MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN
149 #define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR MEDIA_ENT_F_CAM_SENSOR
150 #define MEDIA_ENT_T_V4L2_SUBDEV_FLASH MEDIA_ENT_F_FLASH
151 #define MEDIA_ENT_T_V4L2_SUBDEV_LENS MEDIA_ENT_F_LENS
152 #define MEDIA_ENT_T_V4L2_SUBDEV_DECODER MEDIA_ENT_F_ATV_DECODER
153 #define MEDIA_ENT_T_V4L2_SUBDEV_TUNER MEDIA_ENT_F_TUNER
157 #define MEDIA_ENT_FL_DEFAULT (1 << 0)
158 #define MEDIA_ENT_FL_CONNECTOR (1 << 1)
160 struct media_entity_desc {
173 /* Node specifications */
181 * TODO: this shouldn't have been added without
182 * actual drivers that use this. When the first real driver
183 * appears that sets this information, special attention
184 * should be given whether this information is 1) enough, and
185 * 2) can deal with udev rules that rename devices. The struct
186 * dev would not be sufficient for this since that does not
187 * contain the subdevice information. In addition, struct dev
188 * can only refer to a single device, and not to multiple (e.g.
189 * pcm and mixer devices).
191 * So for now mark this as a to do.
202 * DEPRECATED: previous node specifications. Kept just to
203 * avoid breaking compilation, but media_entity_desc.dev
204 * should be used instead. In particular, alsa and dvb
205 * fields below are wrong: for all devnodes, there should
206 * be just major/minor inside the struct, as this is enough
207 * to represent any devnode, no matter what type.
220 /* Sub-device specifications */
221 /* Nothing needed yet */
226 #define MEDIA_PAD_FL_SINK (1 << 0)
227 #define MEDIA_PAD_FL_SOURCE (1 << 1)
228 #define MEDIA_PAD_FL_MUST_CONNECT (1 << 2)
230 struct media_pad_desc {
231 __u32 entity; /* entity ID */
232 __u16 index; /* pad index */
233 __u32 flags; /* pad flags */
237 #define MEDIA_LNK_FL_ENABLED (1 << 0)
238 #define MEDIA_LNK_FL_IMMUTABLE (1 << 1)
239 #define MEDIA_LNK_FL_DYNAMIC (1 << 2)
241 #define MEDIA_LNK_FL_LINK_TYPE (0xf << 28)
242 # define MEDIA_LNK_FL_DATA_LINK (0 << 28)
243 # define MEDIA_LNK_FL_INTERFACE_LINK (1 << 28)
245 struct media_link_desc {
246 struct media_pad_desc source;
247 struct media_pad_desc sink;
252 struct media_links_enum {
254 /* Should have enough room for pads elements */
255 struct media_pad_desc __user *pads;
256 /* Should have enough room for links elements */
257 struct media_link_desc __user *links;
261 /* Interface type ranges */
263 #define MEDIA_INTF_T_DVB_BASE 0x00000100
264 #define MEDIA_INTF_T_V4L_BASE 0x00000200
266 /* Interface types */
268 #define MEDIA_INTF_T_DVB_FE (MEDIA_INTF_T_DVB_BASE)
269 #define MEDIA_INTF_T_DVB_DEMUX (MEDIA_INTF_T_DVB_BASE + 1)
270 #define MEDIA_INTF_T_DVB_DVR (MEDIA_INTF_T_DVB_BASE + 2)
271 #define MEDIA_INTF_T_DVB_CA (MEDIA_INTF_T_DVB_BASE + 3)
272 #define MEDIA_INTF_T_DVB_NET (MEDIA_INTF_T_DVB_BASE + 4)
274 #define MEDIA_INTF_T_V4L_VIDEO (MEDIA_INTF_T_V4L_BASE)
275 #define MEDIA_INTF_T_V4L_VBI (MEDIA_INTF_T_V4L_BASE + 1)
276 #define MEDIA_INTF_T_V4L_RADIO (MEDIA_INTF_T_V4L_BASE + 2)
277 #define MEDIA_INTF_T_V4L_SUBDEV (MEDIA_INTF_T_V4L_BASE + 3)
278 #define MEDIA_INTF_T_V4L_SWRADIO (MEDIA_INTF_T_V4L_BASE + 4)
281 * MC next gen API definitions
283 * NOTE: The declarations below are close to the MC RFC for the Media
284 * Controller, the next generation. Yet, there are a few adjustments
285 * to do, as we want to be able to have a functional API before
286 * the MC properties change. Those will be properly marked below.
287 * Please also notice that I removed "num_pads", "num_links",
288 * from the proposal, as a proper userspace application will likely
289 * use lists for pads/links, just as we intend to do in Kernelspace.
290 * The API definition should be freed from fields that are bound to
291 * some specific data structure.
293 * FIXME: Currently, I opted to name the new types as "media_v2", as this
294 * won't cause any conflict with the Kernelspace namespace, nor with
295 * the previous kAPI media_*_desc namespace. This can be changed
296 * later, before the adding this API upstream.
299 #if 0 /* Let's postpone it to Kernel 4.6 */
300 struct media_v2_entity {
302 char name[64]; /* FIXME: move to a property? (RFC says so) */
303 __u32 function; /* Main function of the entity */
305 } __attribute__ ((packed));
307 /* Should match the specific fields at media_intf_devnode */
308 struct media_v2_intf_devnode {
311 } __attribute__ ((packed));
313 struct media_v2_interface {
320 struct media_v2_intf_devnode devnode;
323 } __attribute__ ((packed));
325 struct media_v2_pad {
330 } __attribute__ ((packed));
332 struct media_v2_link {
338 } __attribute__ ((packed));
340 struct media_v2_topology {
341 __u64 topology_version;
347 __u32 num_interfaces;
349 __u64 ptr_interfaces;
358 } __attribute__ ((packed));
360 static inline void __user *media_get_uptr(__u64 arg)
362 return (void __user *)(uintptr_t)arg;
368 #define MEDIA_IOC_DEVICE_INFO _IOWR('|', 0x00, struct media_device_info)
369 #define MEDIA_IOC_ENUM_ENTITIES _IOWR('|', 0x01, struct media_entity_desc)
370 #define MEDIA_IOC_ENUM_LINKS _IOWR('|', 0x02, struct media_links_enum)
371 #define MEDIA_IOC_SETUP_LINK _IOWR('|', 0x03, struct media_link_desc)
373 #if 0 /* Let's postpone it to Kernel 4.6 */
374 #define MEDIA_IOC_G_TOPOLOGY _IOWR('|', 0x04, struct media_v2_topology)
377 #endif /* __LINUX_MEDIA_H */