1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
3 * Multimedia device API
5 * Copyright (C) 2010 Nokia Corporation
7 * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
8 * Sakari Ailus <sakari.ailus@iki.fi>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
20 #ifndef __LINUX_MEDIA_H
21 #define __LINUX_MEDIA_H
24 #include <linux/ioctl.h>
25 #include <linux/types.h>
27 struct media_device_info {
39 * Base number ranges for entity functions
41 * NOTE: Userspace should not rely on these ranges to identify a group
42 * of function types, as newer functions can be added with any name within
45 * Some older functions use the MEDIA_ENT_F_OLD_*_BASE range. Do not
46 * change this, this is for backwards compatibility. When adding new
47 * functions always use MEDIA_ENT_F_BASE.
49 #define MEDIA_ENT_F_BASE 0x00000000
50 #define MEDIA_ENT_F_OLD_BASE 0x00010000
51 #define MEDIA_ENT_F_OLD_SUBDEV_BASE 0x00020000
54 * Initial value to be used when a new entity is created
55 * Drivers should change it to something useful.
57 #define MEDIA_ENT_F_UNKNOWN MEDIA_ENT_F_BASE
60 * Subdevs are initialized with MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN in order
61 * to preserve backward compatibility. Drivers must change to the proper
62 * subdev type before registering the entity.
64 #define MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN MEDIA_ENT_F_OLD_SUBDEV_BASE
67 * DVB entity functions
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)
75 * I/O entity functions
77 #define MEDIA_ENT_F_IO_V4L (MEDIA_ENT_F_OLD_BASE + 1)
78 #define MEDIA_ENT_F_IO_DTV (MEDIA_ENT_F_BASE + 0x01001)
79 #define MEDIA_ENT_F_IO_VBI (MEDIA_ENT_F_BASE + 0x01002)
80 #define MEDIA_ENT_F_IO_SWRADIO (MEDIA_ENT_F_BASE + 0x01003)
85 #define MEDIA_ENT_F_CAM_SENSOR (MEDIA_ENT_F_OLD_SUBDEV_BASE + 1)
86 #define MEDIA_ENT_F_FLASH (MEDIA_ENT_F_OLD_SUBDEV_BASE + 2)
87 #define MEDIA_ENT_F_LENS (MEDIA_ENT_F_OLD_SUBDEV_BASE + 3)
90 * Digital TV, analog TV, radio and/or software defined radio tuner functions.
92 * It is a responsibility of the master/bridge drivers to add connectors
93 * and links for MEDIA_ENT_F_TUNER. Please notice that some old tuners
94 * may require the usage of separate I2C chips to decode analog TV signals,
95 * when the master/bridge chipset doesn't have its own TV standard decoder.
96 * On such cases, the IF-PLL staging is mapped via one or two entities:
97 * MEDIA_ENT_F_IF_VID_DECODER and/or MEDIA_ENT_F_IF_AUD_DECODER.
99 #define MEDIA_ENT_F_TUNER (MEDIA_ENT_F_OLD_SUBDEV_BASE + 5)
102 * Analog TV IF-PLL decoder functions
104 * It is a responsibility of the master/bridge drivers to create links
105 * for MEDIA_ENT_F_IF_VID_DECODER and MEDIA_ENT_F_IF_AUD_DECODER.
107 #define MEDIA_ENT_F_IF_VID_DECODER (MEDIA_ENT_F_BASE + 0x02001)
108 #define MEDIA_ENT_F_IF_AUD_DECODER (MEDIA_ENT_F_BASE + 0x02002)
111 * Audio entity functions
113 #define MEDIA_ENT_F_AUDIO_CAPTURE (MEDIA_ENT_F_BASE + 0x03001)
114 #define MEDIA_ENT_F_AUDIO_PLAYBACK (MEDIA_ENT_F_BASE + 0x03002)
115 #define MEDIA_ENT_F_AUDIO_MIXER (MEDIA_ENT_F_BASE + 0x03003)
118 * Processing entity functions
120 #define MEDIA_ENT_F_PROC_VIDEO_COMPOSER (MEDIA_ENT_F_BASE + 0x4001)
121 #define MEDIA_ENT_F_PROC_VIDEO_PIXEL_FORMATTER (MEDIA_ENT_F_BASE + 0x4002)
122 #define MEDIA_ENT_F_PROC_VIDEO_PIXEL_ENC_CONV (MEDIA_ENT_F_BASE + 0x4003)
123 #define MEDIA_ENT_F_PROC_VIDEO_LUT (MEDIA_ENT_F_BASE + 0x4004)
124 #define MEDIA_ENT_F_PROC_VIDEO_SCALER (MEDIA_ENT_F_BASE + 0x4005)
125 #define MEDIA_ENT_F_PROC_VIDEO_STATISTICS (MEDIA_ENT_F_BASE + 0x4006)
126 #define MEDIA_ENT_F_PROC_VIDEO_ENCODER (MEDIA_ENT_F_BASE + 0x4007)
127 #define MEDIA_ENT_F_PROC_VIDEO_DECODER (MEDIA_ENT_F_BASE + 0x4008)
130 * Switch and bridge entity functions
132 #define MEDIA_ENT_F_VID_MUX (MEDIA_ENT_F_BASE + 0x5001)
133 #define MEDIA_ENT_F_VID_IF_BRIDGE (MEDIA_ENT_F_BASE + 0x5002)
136 * Video decoder/encoder functions
138 #define MEDIA_ENT_F_ATV_DECODER (MEDIA_ENT_F_OLD_SUBDEV_BASE + 4)
139 #define MEDIA_ENT_F_DV_DECODER (MEDIA_ENT_F_BASE + 0x6001)
140 #define MEDIA_ENT_F_DV_ENCODER (MEDIA_ENT_F_BASE + 0x6002)
143 #define MEDIA_ENT_FL_DEFAULT (1 << 0)
144 #define MEDIA_ENT_FL_CONNECTOR (1 << 1)
146 /* OR with the entity id value to find the next entity */
147 #define MEDIA_ENT_ID_FLAG_NEXT (1 << 31)
149 struct media_entity_desc {
162 /* Node specifications */
169 * TODO: this shouldn't have been added without
170 * actual drivers that use this. When the first real driver
171 * appears that sets this information, special attention
172 * should be given whether this information is 1) enough, and
173 * 2) can deal with udev rules that rename devices. The struct
174 * dev would not be sufficient for this since that does not
175 * contain the subdevice information. In addition, struct dev
176 * can only refer to a single device, and not to multiple (e.g.
177 * pcm and mixer devices).
186 * DEPRECATED: previous node specifications. Kept just to
187 * avoid breaking compilation. Use media_entity_desc.dev
200 /* Sub-device specifications */
201 /* Nothing needed yet */
206 #define MEDIA_PAD_FL_SINK (1 << 0)
207 #define MEDIA_PAD_FL_SOURCE (1 << 1)
208 #define MEDIA_PAD_FL_MUST_CONNECT (1 << 2)
210 struct media_pad_desc {
211 __u32 entity; /* entity ID */
212 __u16 index; /* pad index */
213 __u32 flags; /* pad flags */
217 #define MEDIA_LNK_FL_ENABLED (1 << 0)
218 #define MEDIA_LNK_FL_IMMUTABLE (1 << 1)
219 #define MEDIA_LNK_FL_DYNAMIC (1 << 2)
221 #define MEDIA_LNK_FL_LINK_TYPE (0xf << 28)
222 # define MEDIA_LNK_FL_DATA_LINK (0 << 28)
223 # define MEDIA_LNK_FL_INTERFACE_LINK (1 << 28)
225 struct media_link_desc {
226 struct media_pad_desc source;
227 struct media_pad_desc sink;
232 struct media_links_enum {
234 /* Should have enough room for pads elements */
235 struct media_pad_desc *pads;
236 /* Should have enough room for links elements */
237 struct media_link_desc *links;
241 /* Interface type ranges */
243 #define MEDIA_INTF_T_DVB_BASE 0x00000100
244 #define MEDIA_INTF_T_V4L_BASE 0x00000200
246 /* Interface types */
248 #define MEDIA_INTF_T_DVB_FE (MEDIA_INTF_T_DVB_BASE)
249 #define MEDIA_INTF_T_DVB_DEMUX (MEDIA_INTF_T_DVB_BASE + 1)
250 #define MEDIA_INTF_T_DVB_DVR (MEDIA_INTF_T_DVB_BASE + 2)
251 #define MEDIA_INTF_T_DVB_CA (MEDIA_INTF_T_DVB_BASE + 3)
252 #define MEDIA_INTF_T_DVB_NET (MEDIA_INTF_T_DVB_BASE + 4)
254 #define MEDIA_INTF_T_V4L_VIDEO (MEDIA_INTF_T_V4L_BASE)
255 #define MEDIA_INTF_T_V4L_VBI (MEDIA_INTF_T_V4L_BASE + 1)
256 #define MEDIA_INTF_T_V4L_RADIO (MEDIA_INTF_T_V4L_BASE + 2)
257 #define MEDIA_INTF_T_V4L_SUBDEV (MEDIA_INTF_T_V4L_BASE + 3)
258 #define MEDIA_INTF_T_V4L_SWRADIO (MEDIA_INTF_T_V4L_BASE + 4)
259 #define MEDIA_INTF_T_V4L_TOUCH (MEDIA_INTF_T_V4L_BASE + 5)
263 * MC next gen API definitions
267 * Appeared in 4.19.0.
269 * The media_version argument comes from the media_version field in
270 * struct media_device_info.
272 #define MEDIA_V2_ENTITY_HAS_FLAGS(media_version) \
273 ((media_version) >= ((4 << 16) | (19 << 8) | 0))
275 struct media_v2_entity {
278 __u32 function; /* Main function of the entity */
281 } __attribute__ ((packed));
283 /* Should match the specific fields at media_intf_devnode */
284 struct media_v2_intf_devnode {
287 } __attribute__ ((packed));
289 struct media_v2_interface {
296 struct media_v2_intf_devnode devnode;
299 } __attribute__ ((packed));
302 * Appeared in 4.19.0.
304 * The media_version argument comes from the media_version field in
305 * struct media_device_info.
307 #define MEDIA_V2_PAD_HAS_INDEX(media_version) \
308 ((media_version) >= ((4 << 16) | (19 << 8) | 0))
310 struct media_v2_pad {
316 } __attribute__ ((packed));
318 struct media_v2_link {
324 } __attribute__ ((packed));
326 struct media_v2_topology {
327 __u64 topology_version;
333 __u32 num_interfaces;
335 __u64 ptr_interfaces;
344 } __attribute__ ((packed));
348 #define MEDIA_IOC_DEVICE_INFO _IOWR('|', 0x00, struct media_device_info)
349 #define MEDIA_IOC_ENUM_ENTITIES _IOWR('|', 0x01, struct media_entity_desc)
350 #define MEDIA_IOC_ENUM_LINKS _IOWR('|', 0x02, struct media_links_enum)
351 #define MEDIA_IOC_SETUP_LINK _IOWR('|', 0x03, struct media_link_desc)
352 #define MEDIA_IOC_G_TOPOLOGY _IOWR('|', 0x04, struct media_v2_topology)
356 * Legacy symbols used to avoid userspace compilation breakages.
357 * Do not use any of this in new applications!
359 * Those symbols map the entity function into types and should be
360 * used only on legacy programs for legacy hardware. Don't rely
361 * on those for MEDIA_IOC_G_TOPOLOGY.
363 #define MEDIA_ENT_TYPE_SHIFT 16
364 #define MEDIA_ENT_TYPE_MASK 0x00ff0000
365 #define MEDIA_ENT_SUBTYPE_MASK 0x0000ffff
367 #define MEDIA_ENT_T_DEVNODE_UNKNOWN (MEDIA_ENT_F_OLD_BASE | \
368 MEDIA_ENT_SUBTYPE_MASK)
370 #define MEDIA_ENT_T_DEVNODE MEDIA_ENT_F_OLD_BASE
371 #define MEDIA_ENT_T_DEVNODE_V4L MEDIA_ENT_F_IO_V4L
372 #define MEDIA_ENT_T_DEVNODE_FB (MEDIA_ENT_F_OLD_BASE + 2)
373 #define MEDIA_ENT_T_DEVNODE_ALSA (MEDIA_ENT_F_OLD_BASE + 3)
374 #define MEDIA_ENT_T_DEVNODE_DVB (MEDIA_ENT_F_OLD_BASE + 4)
376 #define MEDIA_ENT_T_UNKNOWN MEDIA_ENT_F_UNKNOWN
377 #define MEDIA_ENT_T_V4L2_VIDEO MEDIA_ENT_F_IO_V4L
378 #define MEDIA_ENT_T_V4L2_SUBDEV MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN
379 #define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR MEDIA_ENT_F_CAM_SENSOR
380 #define MEDIA_ENT_T_V4L2_SUBDEV_FLASH MEDIA_ENT_F_FLASH
381 #define MEDIA_ENT_T_V4L2_SUBDEV_LENS MEDIA_ENT_F_LENS
382 #define MEDIA_ENT_T_V4L2_SUBDEV_DECODER MEDIA_ENT_F_ATV_DECODER
383 #define MEDIA_ENT_T_V4L2_SUBDEV_TUNER MEDIA_ENT_F_TUNER
385 #define MEDIA_ENT_F_DTV_DECODER MEDIA_ENT_F_DV_DECODER
388 * There is still no ALSA support in the media controller. These
389 * defines should not have been added and we leave them here only
390 * in case some application tries to use these defines.
392 #define MEDIA_INTF_T_ALSA_BASE 0x00000300
393 #define MEDIA_INTF_T_ALSA_PCM_CAPTURE (MEDIA_INTF_T_ALSA_BASE)
394 #define MEDIA_INTF_T_ALSA_PCM_PLAYBACK (MEDIA_INTF_T_ALSA_BASE + 1)
395 #define MEDIA_INTF_T_ALSA_CONTROL (MEDIA_INTF_T_ALSA_BASE + 2)
396 #define MEDIA_INTF_T_ALSA_COMPRESS (MEDIA_INTF_T_ALSA_BASE + 3)
397 #define MEDIA_INTF_T_ALSA_RAWMIDI (MEDIA_INTF_T_ALSA_BASE + 4)
398 #define MEDIA_INTF_T_ALSA_HWDEP (MEDIA_INTF_T_ALSA_BASE + 5)
399 #define MEDIA_INTF_T_ALSA_SEQUENCER (MEDIA_INTF_T_ALSA_BASE + 6)
400 #define MEDIA_INTF_T_ALSA_TIMER (MEDIA_INTF_T_ALSA_BASE + 7)
402 /* Obsolete symbol for media_version, no longer used in the kernel */
403 #define MEDIA_API_VERSION ((0 << 16) | (1 << 8) | 0)
406 #endif /* __LINUX_MEDIA_H */