[mirror_ubuntu-bionic-kernel.git] / include / uapi / linux / uvcvideo.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
#ifndef __LINUX_UVCVIDEO_H_
#define __LINUX_UVCVIDEO_H_

#include <linux/ioctl.h>
#include <linux/types.h>

/*
 * Dynamic controls
 */

/* Data types for UVC control data */
#define UVC_CTRL_DATA_TYPE_RAW		0
#define UVC_CTRL_DATA_TYPE_SIGNED	1
#define UVC_CTRL_DATA_TYPE_UNSIGNED	2
#define UVC_CTRL_DATA_TYPE_BOOLEAN	3
#define UVC_CTRL_DATA_TYPE_ENUM		4
#define UVC_CTRL_DATA_TYPE_BITMASK	5

/* Control flags */
#define UVC_CTRL_FLAG_SET_CUR		(1 << 0)
#define UVC_CTRL_FLAG_GET_CUR		(1 << 1)
#define UVC_CTRL_FLAG_GET_MIN		(1 << 2)
#define UVC_CTRL_FLAG_GET_MAX		(1 << 3)
#define UVC_CTRL_FLAG_GET_RES		(1 << 4)
#define UVC_CTRL_FLAG_GET_DEF		(1 << 5)
/* Control should be saved at suspend and restored at resume. */
#define UVC_CTRL_FLAG_RESTORE		(1 << 6)
/* Control can be updated by the camera. */
#define UVC_CTRL_FLAG_AUTO_UPDATE	(1 << 7)

#define UVC_CTRL_FLAG_GET_RANGE \
	(UVC_CTRL_FLAG_GET_CUR | UVC_CTRL_FLAG_GET_MIN | \
	 UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES | \
	 UVC_CTRL_FLAG_GET_DEF)

struct uvc_menu_info {
	__u32 value;
	__u8 name[32];
};

struct uvc_xu_control_mapping {
	__u32 id;
	__u8 name[32];
	__u8 entity[16];
	__u8 selector;

	__u8 size;
	__u8 offset;
	__u32 v4l2_type;
	__u32 data_type;

	struct uvc_menu_info __user *menu_info;
	__u32 menu_count;

	__u32 reserved[4];
};

struct uvc_xu_control_query {
	__u8 unit;
	__u8 selector;
	__u8 query;		/* Video Class-Specific Request Code, */
				/* defined in linux/usb/video.h A.8.  */
	__u16 size;
	__u8 __user *data;
};

#define UVCIOC_CTRL_MAP		_IOWR('u', 0x20, struct uvc_xu_control_mapping)
#define UVCIOC_CTRL_QUERY	_IOWR('u', 0x21, struct uvc_xu_control_query)

#endif
Commit	Line	Data
6f52b16c	1	/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
5f708812 LP	2	#ifndef __LINUX_UVCVIDEO_H_
	3	#define __LINUX_UVCVIDEO_H_
	4
	5	#include <linux/ioctl.h>
	6	#include <linux/types.h>
	7
	8	/*
	9	* Dynamic controls
	10	*/
	11
	12	/* Data types for UVC control data */
	13	#define UVC_CTRL_DATA_TYPE_RAW 0
	14	#define UVC_CTRL_DATA_TYPE_SIGNED 1
	15	#define UVC_CTRL_DATA_TYPE_UNSIGNED 2
	16	#define UVC_CTRL_DATA_TYPE_BOOLEAN 3
	17	#define UVC_CTRL_DATA_TYPE_ENUM 4
	18	#define UVC_CTRL_DATA_TYPE_BITMASK 5
	19
	20	/* Control flags */
	21	#define UVC_CTRL_FLAG_SET_CUR (1 << 0)
	22	#define UVC_CTRL_FLAG_GET_CUR (1 << 1)
	23	#define UVC_CTRL_FLAG_GET_MIN (1 << 2)
	24	#define UVC_CTRL_FLAG_GET_MAX (1 << 3)
	25	#define UVC_CTRL_FLAG_GET_RES (1 << 4)
	26	#define UVC_CTRL_FLAG_GET_DEF (1 << 5)
	27	/* Control should be saved at suspend and restored at resume. */
	28	#define UVC_CTRL_FLAG_RESTORE (1 << 6)
	29	/* Control can be updated by the camera. */
	30	#define UVC_CTRL_FLAG_AUTO_UPDATE (1 << 7)
	31
	32	#define UVC_CTRL_FLAG_GET_RANGE \
	33	(UVC_CTRL_FLAG_GET_CUR \| UVC_CTRL_FLAG_GET_MIN \| \
	34	UVC_CTRL_FLAG_GET_MAX \| UVC_CTRL_FLAG_GET_RES \| \
	35	UVC_CTRL_FLAG_GET_DEF)
	36
	37	struct uvc_menu_info {
	38	__u32 value;
	39	__u8 name[32];
	40	};
	41
	42	struct uvc_xu_control_mapping {
	43	__u32 id;
	44	__u8 name[32];
	45	__u8 entity[16];
	46	__u8 selector;
	47
	48	__u8 size;
	49	__u8 offset;
	50	__u32 v4l2_type;
	51	__u32 data_type;
	52
	53	struct uvc_menu_info __user *menu_info;
	54	__u32 menu_count;
	55
	56	__u32 reserved[4];
	57	};
	58
	59	struct uvc_xu_control_query {
	60	__u8 unit;
	61	__u8 selector;
7078daa0 LP	62	__u8 query; /* Video Class-Specific Request Code, */
7078daa0 LP	63	/* defined in linux/usb/video.h A.8. */
5f708812 LP	64	__u16 size;
	65	__u8 __user *data;
	66	};
	67
	68	#define UVCIOC_CTRL_MAP _IOWR('u', 0x20, struct uvc_xu_control_mapping)
	69	#define UVCIOC_CTRL_QUERY _IOWR('u', 0x21, struct uvc_xu_control_query)
	70
	71	#endif