16f52b16cSGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2607ca46eSDavid Howells #ifndef __LINUX_UVCVIDEO_H_ 3607ca46eSDavid Howells #define __LINUX_UVCVIDEO_H_ 4607ca46eSDavid Howells 5607ca46eSDavid Howells #include <linux/ioctl.h> 6607ca46eSDavid Howells #include <linux/types.h> 7607ca46eSDavid Howells 8607ca46eSDavid Howells /* 9607ca46eSDavid Howells * Dynamic controls 10607ca46eSDavid Howells */ 11607ca46eSDavid Howells 12607ca46eSDavid Howells /* Data types for UVC control data */ 13607ca46eSDavid Howells #define UVC_CTRL_DATA_TYPE_RAW 0 14607ca46eSDavid Howells #define UVC_CTRL_DATA_TYPE_SIGNED 1 15607ca46eSDavid Howells #define UVC_CTRL_DATA_TYPE_UNSIGNED 2 16607ca46eSDavid Howells #define UVC_CTRL_DATA_TYPE_BOOLEAN 3 17607ca46eSDavid Howells #define UVC_CTRL_DATA_TYPE_ENUM 4 18607ca46eSDavid Howells #define UVC_CTRL_DATA_TYPE_BITMASK 5 19607ca46eSDavid Howells 20607ca46eSDavid Howells /* Control flags */ 21607ca46eSDavid Howells #define UVC_CTRL_FLAG_SET_CUR (1 << 0) 22607ca46eSDavid Howells #define UVC_CTRL_FLAG_GET_CUR (1 << 1) 23607ca46eSDavid Howells #define UVC_CTRL_FLAG_GET_MIN (1 << 2) 24607ca46eSDavid Howells #define UVC_CTRL_FLAG_GET_MAX (1 << 3) 25607ca46eSDavid Howells #define UVC_CTRL_FLAG_GET_RES (1 << 4) 26607ca46eSDavid Howells #define UVC_CTRL_FLAG_GET_DEF (1 << 5) 27607ca46eSDavid Howells /* Control should be saved at suspend and restored at resume. */ 28607ca46eSDavid Howells #define UVC_CTRL_FLAG_RESTORE (1 << 6) 29607ca46eSDavid Howells /* Control can be updated by the camera. */ 30607ca46eSDavid Howells #define UVC_CTRL_FLAG_AUTO_UPDATE (1 << 7) 31e5225c82SGuennadi Liakhovetski /* Control supports asynchronous reporting */ 32e5225c82SGuennadi Liakhovetski #define UVC_CTRL_FLAG_ASYNCHRONOUS (1 << 8) 33607ca46eSDavid Howells 34607ca46eSDavid Howells #define UVC_CTRL_FLAG_GET_RANGE \ 35607ca46eSDavid Howells (UVC_CTRL_FLAG_GET_CUR | UVC_CTRL_FLAG_GET_MIN | \ 36607ca46eSDavid Howells UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES | \ 37607ca46eSDavid Howells UVC_CTRL_FLAG_GET_DEF) 38607ca46eSDavid Howells 39716c3304SRicardo Ribalda #define UVC_MENU_NAME_LEN 32 40716c3304SRicardo Ribalda 41607ca46eSDavid Howells struct uvc_menu_info { 42607ca46eSDavid Howells __u32 value; 43716c3304SRicardo Ribalda __u8 name[UVC_MENU_NAME_LEN]; 44607ca46eSDavid Howells }; 45607ca46eSDavid Howells 46607ca46eSDavid Howells struct uvc_xu_control_mapping { 47607ca46eSDavid Howells __u32 id; 48607ca46eSDavid Howells __u8 name[32]; 49607ca46eSDavid Howells __u8 entity[16]; 50607ca46eSDavid Howells __u8 selector; 51607ca46eSDavid Howells 52607ca46eSDavid Howells __u8 size; 53607ca46eSDavid Howells __u8 offset; 54607ca46eSDavid Howells __u32 v4l2_type; 55607ca46eSDavid Howells __u32 data_type; 56607ca46eSDavid Howells 57607ca46eSDavid Howells struct uvc_menu_info __user *menu_info; 58607ca46eSDavid Howells __u32 menu_count; 59607ca46eSDavid Howells 60607ca46eSDavid Howells __u32 reserved[4]; 61607ca46eSDavid Howells }; 62607ca46eSDavid Howells 63607ca46eSDavid Howells struct uvc_xu_control_query { 64607ca46eSDavid Howells __u8 unit; 65607ca46eSDavid Howells __u8 selector; 66607ca46eSDavid Howells __u8 query; /* Video Class-Specific Request Code, */ 67607ca46eSDavid Howells /* defined in linux/usb/video.h A.8. */ 68607ca46eSDavid Howells __u16 size; 69607ca46eSDavid Howells __u8 __user *data; 70607ca46eSDavid Howells }; 71607ca46eSDavid Howells 72607ca46eSDavid Howells #define UVCIOC_CTRL_MAP _IOWR('u', 0x20, struct uvc_xu_control_mapping) 73607ca46eSDavid Howells #define UVCIOC_CTRL_QUERY _IOWR('u', 0x21, struct uvc_xu_control_query) 74607ca46eSDavid Howells 75088ead25SGuennadi Liakhovetski /* 76088ead25SGuennadi Liakhovetski * Metadata node 77088ead25SGuennadi Liakhovetski */ 78088ead25SGuennadi Liakhovetski 79088ead25SGuennadi Liakhovetski /** 80088ead25SGuennadi Liakhovetski * struct uvc_meta_buf - metadata buffer building block 81c214e6ddSHans Verkuil * @ns: system timestamp of the payload in nanoseconds 82c214e6ddSHans Verkuil * @sof: USB Frame Number 83c214e6ddSHans Verkuil * @length: length of the payload header 84c214e6ddSHans Verkuil * @flags: payload header flags 85c214e6ddSHans Verkuil * @buf: optional device-specific header data 86088ead25SGuennadi Liakhovetski * 87088ead25SGuennadi Liakhovetski * UVC metadata nodes fill buffers with possibly multiple instances of this 88088ead25SGuennadi Liakhovetski * struct. The first two fields are added by the driver, they can be used for 89088ead25SGuennadi Liakhovetski * clock synchronisation. The rest is an exact copy of a UVC payload header. 90088ead25SGuennadi Liakhovetski * Only complete objects with complete buffers are included. Therefore it's 91*b8392129SKees Cook * always sizeof(meta->ns) + sizeof(meta->sof) + meta->length bytes large. 92088ead25SGuennadi Liakhovetski */ 93088ead25SGuennadi Liakhovetski struct uvc_meta_buf { 94088ead25SGuennadi Liakhovetski __u64 ns; 95088ead25SGuennadi Liakhovetski __u16 sof; 96088ead25SGuennadi Liakhovetski __u8 length; 97088ead25SGuennadi Liakhovetski __u8 flags; 98088ead25SGuennadi Liakhovetski __u8 buf[]; 99088ead25SGuennadi Liakhovetski } __packed; 100088ead25SGuennadi Liakhovetski 101607ca46eSDavid Howells #endif 102