1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  * Multimedia device API
4  *
5  * Copyright (C) 2010 Nokia Corporation
6  *
7  * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
8  *	     Sakari Ailus <sakari.ailus@iki.fi>
9  *
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.
13  *
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.
18  */
19 
20 #ifndef __LINUX_MEDIA_H
21 #define __LINUX_MEDIA_H
22 
23 #ifndef __KERNEL__
24 #include <stdint.h>
25 #endif
26 #include <linux/ioctl.h>
27 #include <linux/types.h>
28 
29 struct media_device_info {
30 	char driver[16];
31 	char model[32];
32 	char serial[40];
33 	char bus_info[32];
34 	__u32 media_version;
35 	__u32 hw_revision;
36 	__u32 driver_version;
37 	__u32 reserved[31];
38 };
39 
40 /*
41  * Base number ranges for entity functions
42  *
43  * NOTE: Userspace should not rely on these ranges to identify a group
44  * of function types, as newer functions can be added with any name within
45  * the full u32 range.
46  *
47  * Some older functions use the MEDIA_ENT_F_OLD_*_BASE range. Do not
48  * change this, this is for backwards compatibility. When adding new
49  * functions always use MEDIA_ENT_F_BASE.
50  */
51 #define MEDIA_ENT_F_BASE			0x00000000
52 #define MEDIA_ENT_F_OLD_BASE			0x00010000
53 #define MEDIA_ENT_F_OLD_SUBDEV_BASE		0x00020000
54 
55 /*
56  * Initial value to be used when a new entity is created
57  * Drivers should change it to something useful.
58  */
59 #define MEDIA_ENT_F_UNKNOWN			MEDIA_ENT_F_BASE
60 
61 /*
62  * Subdevs are initialized with MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN in order
63  * to preserve backward compatibility. Drivers must change to the proper
64  * subdev type before registering the entity.
65  */
66 #define MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN		MEDIA_ENT_F_OLD_SUBDEV_BASE
67 
68 /*
69  * DVB entity functions
70  */
71 #define MEDIA_ENT_F_DTV_DEMOD			(MEDIA_ENT_F_BASE + 0x00001)
72 #define MEDIA_ENT_F_TS_DEMUX			(MEDIA_ENT_F_BASE + 0x00002)
73 #define MEDIA_ENT_F_DTV_CA			(MEDIA_ENT_F_BASE + 0x00003)
74 #define MEDIA_ENT_F_DTV_NET_DECAP		(MEDIA_ENT_F_BASE + 0x00004)
75 
76 /*
77  * I/O entity functions
78  */
79 #define MEDIA_ENT_F_IO_V4L			(MEDIA_ENT_F_OLD_BASE + 1)
80 #define MEDIA_ENT_F_IO_DTV			(MEDIA_ENT_F_BASE + 0x01001)
81 #define MEDIA_ENT_F_IO_VBI			(MEDIA_ENT_F_BASE + 0x01002)
82 #define MEDIA_ENT_F_IO_SWRADIO			(MEDIA_ENT_F_BASE + 0x01003)
83 
84 /*
85  * Sensor functions
86  */
87 #define MEDIA_ENT_F_CAM_SENSOR			(MEDIA_ENT_F_OLD_SUBDEV_BASE + 1)
88 #define MEDIA_ENT_F_FLASH			(MEDIA_ENT_F_OLD_SUBDEV_BASE + 2)
89 #define MEDIA_ENT_F_LENS			(MEDIA_ENT_F_OLD_SUBDEV_BASE + 3)
90 
91 /*
92  * Digital TV, analog TV, radio and/or software defined radio tuner functions.
93  *
94  * It is a responsibility of the master/bridge drivers to add connectors
95  * and links for MEDIA_ENT_F_TUNER. Please notice that some old tuners
96  * may require the usage of separate I2C chips to decode analog TV signals,
97  * when the master/bridge chipset doesn't have its own TV standard decoder.
98  * On such cases, the IF-PLL staging is mapped via one or two entities:
99  * MEDIA_ENT_F_IF_VID_DECODER and/or MEDIA_ENT_F_IF_AUD_DECODER.
100  */
101 #define MEDIA_ENT_F_TUNER			(MEDIA_ENT_F_OLD_SUBDEV_BASE + 5)
102 
103 /*
104  * Analog TV IF-PLL decoder functions
105  *
106  * It is a responsibility of the master/bridge drivers to create links
107  * for MEDIA_ENT_F_IF_VID_DECODER and MEDIA_ENT_F_IF_AUD_DECODER.
108  */
109 #define MEDIA_ENT_F_IF_VID_DECODER		(MEDIA_ENT_F_BASE + 0x02001)
110 #define MEDIA_ENT_F_IF_AUD_DECODER		(MEDIA_ENT_F_BASE + 0x02002)
111 
112 /*
113  * Audio entity functions
114  */
115 #define MEDIA_ENT_F_AUDIO_CAPTURE		(MEDIA_ENT_F_BASE + 0x03001)
116 #define MEDIA_ENT_F_AUDIO_PLAYBACK		(MEDIA_ENT_F_BASE + 0x03002)
117 #define MEDIA_ENT_F_AUDIO_MIXER			(MEDIA_ENT_F_BASE + 0x03003)
118 
119 /*
120  * Processing entity functions
121  */
122 #define MEDIA_ENT_F_PROC_VIDEO_COMPOSER		(MEDIA_ENT_F_BASE + 0x4001)
123 #define MEDIA_ENT_F_PROC_VIDEO_PIXEL_FORMATTER	(MEDIA_ENT_F_BASE + 0x4002)
124 #define MEDIA_ENT_F_PROC_VIDEO_PIXEL_ENC_CONV	(MEDIA_ENT_F_BASE + 0x4003)
125 #define MEDIA_ENT_F_PROC_VIDEO_LUT		(MEDIA_ENT_F_BASE + 0x4004)
126 #define MEDIA_ENT_F_PROC_VIDEO_SCALER		(MEDIA_ENT_F_BASE + 0x4005)
127 #define MEDIA_ENT_F_PROC_VIDEO_STATISTICS	(MEDIA_ENT_F_BASE + 0x4006)
128 #define MEDIA_ENT_F_PROC_VIDEO_ENCODER		(MEDIA_ENT_F_BASE + 0x4007)
129 #define MEDIA_ENT_F_PROC_VIDEO_DECODER		(MEDIA_ENT_F_BASE + 0x4008)
130 
131 /*
132  * Switch and bridge entity functions
133  */
134 #define MEDIA_ENT_F_VID_MUX			(MEDIA_ENT_F_BASE + 0x5001)
135 #define MEDIA_ENT_F_VID_IF_BRIDGE		(MEDIA_ENT_F_BASE + 0x5002)
136 
137 /*
138  * Video decoder/encoder functions
139  */
140 #define MEDIA_ENT_F_ATV_DECODER			(MEDIA_ENT_F_OLD_SUBDEV_BASE + 4)
141 #define MEDIA_ENT_F_DV_DECODER			(MEDIA_ENT_F_BASE + 0x6001)
142 #define MEDIA_ENT_F_DV_ENCODER			(MEDIA_ENT_F_BASE + 0x6002)
143 
144 /* Entity flags */
145 #define MEDIA_ENT_FL_DEFAULT			(1 << 0)
146 #define MEDIA_ENT_FL_CONNECTOR			(1 << 1)
147 
148 /* OR with the entity id value to find the next entity */
149 #define MEDIA_ENT_ID_FLAG_NEXT			(1 << 31)
150 
151 struct media_entity_desc {
152 	__u32 id;
153 	char name[32];
154 	__u32 type;
155 	__u32 revision;
156 	__u32 flags;
157 	__u32 group_id;
158 	__u16 pads;
159 	__u16 links;
160 
161 	__u32 reserved[4];
162 
163 	union {
164 		/* Node specifications */
165 		struct {
166 			__u32 major;
167 			__u32 minor;
168 		} dev;
169 
170 #if !defined(__KERNEL__)
171 		/*
172 		 * TODO: this shouldn't have been added without
173 		 * actual drivers that use this. When the first real driver
174 		 * appears that sets this information, special attention
175 		 * should be given whether this information is 1) enough, and
176 		 * 2) can deal with udev rules that rename devices. The struct
177 		 * dev would not be sufficient for this since that does not
178 		 * contain the subdevice information. In addition, struct dev
179 		 * can only refer to a single device, and not to multiple (e.g.
180 		 * pcm and mixer devices).
181 		 */
182 		struct {
183 			__u32 card;
184 			__u32 device;
185 			__u32 subdevice;
186 		} alsa;
187 
188 		/*
189 		 * DEPRECATED: previous node specifications. Kept just to
190 		 * avoid breaking compilation. Use media_entity_desc.dev
191 		 * instead.
192 		 */
193 		struct {
194 			__u32 major;
195 			__u32 minor;
196 		} v4l;
197 		struct {
198 			__u32 major;
199 			__u32 minor;
200 		} fb;
201 		int dvb;
202 #endif
203 
204 		/* Sub-device specifications */
205 		/* Nothing needed yet */
206 		__u8 raw[184];
207 	};
208 };
209 
210 #define MEDIA_PAD_FL_SINK			(1 << 0)
211 #define MEDIA_PAD_FL_SOURCE			(1 << 1)
212 #define MEDIA_PAD_FL_MUST_CONNECT		(1 << 2)
213 
214 struct media_pad_desc {
215 	__u32 entity;		/* entity ID */
216 	__u16 index;		/* pad index */
217 	__u32 flags;		/* pad flags */
218 	__u32 reserved[2];
219 };
220 
221 #define MEDIA_LNK_FL_ENABLED			(1 << 0)
222 #define MEDIA_LNK_FL_IMMUTABLE			(1 << 1)
223 #define MEDIA_LNK_FL_DYNAMIC			(1 << 2)
224 
225 #define MEDIA_LNK_FL_LINK_TYPE			(0xf << 28)
226 #  define MEDIA_LNK_FL_DATA_LINK		(0 << 28)
227 #  define MEDIA_LNK_FL_INTERFACE_LINK		(1 << 28)
228 
229 struct media_link_desc {
230 	struct media_pad_desc source;
231 	struct media_pad_desc sink;
232 	__u32 flags;
233 	__u32 reserved[2];
234 };
235 
236 struct media_links_enum {
237 	__u32 entity;
238 	/* Should have enough room for pads elements */
239 	struct media_pad_desc __user *pads;
240 	/* Should have enough room for links elements */
241 	struct media_link_desc __user *links;
242 	__u32 reserved[4];
243 };
244 
245 /* Interface type ranges */
246 
247 #define MEDIA_INTF_T_DVB_BASE			0x00000100
248 #define MEDIA_INTF_T_V4L_BASE			0x00000200
249 
250 /* Interface types */
251 
252 #define MEDIA_INTF_T_DVB_FE			(MEDIA_INTF_T_DVB_BASE)
253 #define MEDIA_INTF_T_DVB_DEMUX			(MEDIA_INTF_T_DVB_BASE + 1)
254 #define MEDIA_INTF_T_DVB_DVR			(MEDIA_INTF_T_DVB_BASE + 2)
255 #define MEDIA_INTF_T_DVB_CA			(MEDIA_INTF_T_DVB_BASE + 3)
256 #define MEDIA_INTF_T_DVB_NET			(MEDIA_INTF_T_DVB_BASE + 4)
257 
258 #define MEDIA_INTF_T_V4L_VIDEO			(MEDIA_INTF_T_V4L_BASE)
259 #define MEDIA_INTF_T_V4L_VBI			(MEDIA_INTF_T_V4L_BASE + 1)
260 #define MEDIA_INTF_T_V4L_RADIO			(MEDIA_INTF_T_V4L_BASE + 2)
261 #define MEDIA_INTF_T_V4L_SUBDEV			(MEDIA_INTF_T_V4L_BASE + 3)
262 #define MEDIA_INTF_T_V4L_SWRADIO		(MEDIA_INTF_T_V4L_BASE + 4)
263 #define MEDIA_INTF_T_V4L_TOUCH			(MEDIA_INTF_T_V4L_BASE + 5)
264 
265 #if defined(__KERNEL__)
266 
267 /*
268  * Connector functions
269  *
270  * For now these should not be used in userspace, as some definitions may
271  * change.
272  *
273  * It is the responsibility of the entity drivers to add connectors and links.
274  */
275 #define MEDIA_ENT_F_CONN_RF			(MEDIA_ENT_F_BASE + 0x30001)
276 #define MEDIA_ENT_F_CONN_SVIDEO			(MEDIA_ENT_F_BASE + 0x30002)
277 #define MEDIA_ENT_F_CONN_COMPOSITE		(MEDIA_ENT_F_BASE + 0x30003)
278 
279 #endif
280 
281 /*
282  * MC next gen API definitions
283  */
284 
285 /*
286  * Appeared in 4.19.0.
287  *
288  * The media_version argument comes from the media_version field in
289  * struct media_device_info.
290  */
291 #define MEDIA_V2_ENTITY_HAS_FLAGS(media_version) \
292 	((media_version) >= ((4 << 16) | (19 << 8) | 0))
293 
294 struct media_v2_entity {
295 	__u32 id;
296 	char name[64];
297 	__u32 function;		/* Main function of the entity */
298 	__u32 flags;
299 	__u32 reserved[5];
300 } __attribute__ ((packed));
301 
302 /* Should match the specific fields at media_intf_devnode */
303 struct media_v2_intf_devnode {
304 	__u32 major;
305 	__u32 minor;
306 } __attribute__ ((packed));
307 
308 struct media_v2_interface {
309 	__u32 id;
310 	__u32 intf_type;
311 	__u32 flags;
312 	__u32 reserved[9];
313 
314 	union {
315 		struct media_v2_intf_devnode devnode;
316 		__u32 raw[16];
317 	};
318 } __attribute__ ((packed));
319 
320 /*
321  * Appeared in 4.19.0.
322  *
323  * The media_version argument comes from the media_version field in
324  * struct media_device_info.
325  */
326 #define MEDIA_V2_PAD_HAS_INDEX(media_version) \
327 	((media_version) >= ((4 << 16) | (19 << 8) | 0))
328 
329 struct media_v2_pad {
330 	__u32 id;
331 	__u32 entity_id;
332 	__u32 flags;
333 	__u32 index;
334 	__u32 reserved[4];
335 } __attribute__ ((packed));
336 
337 struct media_v2_link {
338 	__u32 id;
339 	__u32 source_id;
340 	__u32 sink_id;
341 	__u32 flags;
342 	__u32 reserved[6];
343 } __attribute__ ((packed));
344 
345 struct media_v2_topology {
346 	__u64 topology_version;
347 
348 	__u32 num_entities;
349 	__u32 reserved1;
350 	__u64 ptr_entities;
351 
352 	__u32 num_interfaces;
353 	__u32 reserved2;
354 	__u64 ptr_interfaces;
355 
356 	__u32 num_pads;
357 	__u32 reserved3;
358 	__u64 ptr_pads;
359 
360 	__u32 num_links;
361 	__u32 reserved4;
362 	__u64 ptr_links;
363 } __attribute__ ((packed));
364 
365 /* ioctls */
366 
367 #define MEDIA_IOC_DEVICE_INFO	_IOWR('|', 0x00, struct media_device_info)
368 #define MEDIA_IOC_ENUM_ENTITIES	_IOWR('|', 0x01, struct media_entity_desc)
369 #define MEDIA_IOC_ENUM_LINKS	_IOWR('|', 0x02, struct media_links_enum)
370 #define MEDIA_IOC_SETUP_LINK	_IOWR('|', 0x03, struct media_link_desc)
371 #define MEDIA_IOC_G_TOPOLOGY	_IOWR('|', 0x04, struct media_v2_topology)
372 
373 #ifndef __KERNEL__
374 
375 /*
376  * Legacy symbols used to avoid userspace compilation breakages.
377  * Do not use any of this in new applications!
378  *
379  * Those symbols map the entity function into types and should be
380  * used only on legacy programs for legacy hardware. Don't rely
381  * on those for MEDIA_IOC_G_TOPOLOGY.
382  */
383 #define MEDIA_ENT_TYPE_SHIFT			16
384 #define MEDIA_ENT_TYPE_MASK			0x00ff0000
385 #define MEDIA_ENT_SUBTYPE_MASK			0x0000ffff
386 
387 #define MEDIA_ENT_T_DEVNODE_UNKNOWN		(MEDIA_ENT_F_OLD_BASE | \
388 						 MEDIA_ENT_SUBTYPE_MASK)
389 
390 #define MEDIA_ENT_T_DEVNODE			MEDIA_ENT_F_OLD_BASE
391 #define MEDIA_ENT_T_DEVNODE_V4L			MEDIA_ENT_F_IO_V4L
392 #define MEDIA_ENT_T_DEVNODE_FB			(MEDIA_ENT_F_OLD_BASE + 2)
393 #define MEDIA_ENT_T_DEVNODE_ALSA		(MEDIA_ENT_F_OLD_BASE + 3)
394 #define MEDIA_ENT_T_DEVNODE_DVB			(MEDIA_ENT_F_OLD_BASE + 4)
395 
396 #define MEDIA_ENT_T_UNKNOWN			MEDIA_ENT_F_UNKNOWN
397 #define MEDIA_ENT_T_V4L2_VIDEO			MEDIA_ENT_F_IO_V4L
398 #define MEDIA_ENT_T_V4L2_SUBDEV			MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN
399 #define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR		MEDIA_ENT_F_CAM_SENSOR
400 #define MEDIA_ENT_T_V4L2_SUBDEV_FLASH		MEDIA_ENT_F_FLASH
401 #define MEDIA_ENT_T_V4L2_SUBDEV_LENS		MEDIA_ENT_F_LENS
402 #define MEDIA_ENT_T_V4L2_SUBDEV_DECODER		MEDIA_ENT_F_ATV_DECODER
403 #define MEDIA_ENT_T_V4L2_SUBDEV_TUNER		MEDIA_ENT_F_TUNER
404 
405 #define MEDIA_ENT_F_DTV_DECODER			MEDIA_ENT_F_DV_DECODER
406 
407 /*
408  * There is still no ALSA support in the media controller. These
409  * defines should not have been added and we leave them here only
410  * in case some application tries to use these defines.
411  */
412 #define MEDIA_INTF_T_ALSA_BASE			0x00000300
413 #define MEDIA_INTF_T_ALSA_PCM_CAPTURE		(MEDIA_INTF_T_ALSA_BASE)
414 #define MEDIA_INTF_T_ALSA_PCM_PLAYBACK		(MEDIA_INTF_T_ALSA_BASE + 1)
415 #define MEDIA_INTF_T_ALSA_CONTROL		(MEDIA_INTF_T_ALSA_BASE + 2)
416 #define MEDIA_INTF_T_ALSA_COMPRESS		(MEDIA_INTF_T_ALSA_BASE + 3)
417 #define MEDIA_INTF_T_ALSA_RAWMIDI		(MEDIA_INTF_T_ALSA_BASE + 4)
418 #define MEDIA_INTF_T_ALSA_HWDEP			(MEDIA_INTF_T_ALSA_BASE + 5)
419 #define MEDIA_INTF_T_ALSA_SEQUENCER		(MEDIA_INTF_T_ALSA_BASE + 6)
420 #define MEDIA_INTF_T_ALSA_TIMER			(MEDIA_INTF_T_ALSA_BASE + 7)
421 
422 /* Obsolete symbol for media_version, no longer used in the kernel */
423 #define MEDIA_API_VERSION			((0 << 16) | (1 << 8) | 0)
424 
425 #endif
426 
427 #endif /* __LINUX_MEDIA_H */
428