1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2*4882a593Smuzhiyun #ifndef __LINUX_UVCVIDEO_H_ 3*4882a593Smuzhiyun #define __LINUX_UVCVIDEO_H_ 4*4882a593Smuzhiyun 5*4882a593Smuzhiyun #include <linux/ioctl.h> 6*4882a593Smuzhiyun #include <linux/types.h> 7*4882a593Smuzhiyun 8*4882a593Smuzhiyun /* 9*4882a593Smuzhiyun * Dynamic controls 10*4882a593Smuzhiyun */ 11*4882a593Smuzhiyun 12*4882a593Smuzhiyun /* Data types for UVC control data */ 13*4882a593Smuzhiyun #define UVC_CTRL_DATA_TYPE_RAW 0 14*4882a593Smuzhiyun #define UVC_CTRL_DATA_TYPE_SIGNED 1 15*4882a593Smuzhiyun #define UVC_CTRL_DATA_TYPE_UNSIGNED 2 16*4882a593Smuzhiyun #define UVC_CTRL_DATA_TYPE_BOOLEAN 3 17*4882a593Smuzhiyun #define UVC_CTRL_DATA_TYPE_ENUM 4 18*4882a593Smuzhiyun #define UVC_CTRL_DATA_TYPE_BITMASK 5 19*4882a593Smuzhiyun 20*4882a593Smuzhiyun /* Control flags */ 21*4882a593Smuzhiyun #define UVC_CTRL_FLAG_SET_CUR (1 << 0) 22*4882a593Smuzhiyun #define UVC_CTRL_FLAG_GET_CUR (1 << 1) 23*4882a593Smuzhiyun #define UVC_CTRL_FLAG_GET_MIN (1 << 2) 24*4882a593Smuzhiyun #define UVC_CTRL_FLAG_GET_MAX (1 << 3) 25*4882a593Smuzhiyun #define UVC_CTRL_FLAG_GET_RES (1 << 4) 26*4882a593Smuzhiyun #define UVC_CTRL_FLAG_GET_DEF (1 << 5) 27*4882a593Smuzhiyun /* Control should be saved at suspend and restored at resume. */ 28*4882a593Smuzhiyun #define UVC_CTRL_FLAG_RESTORE (1 << 6) 29*4882a593Smuzhiyun /* Control can be updated by the camera. */ 30*4882a593Smuzhiyun #define UVC_CTRL_FLAG_AUTO_UPDATE (1 << 7) 31*4882a593Smuzhiyun /* Control supports asynchronous reporting */ 32*4882a593Smuzhiyun #define UVC_CTRL_FLAG_ASYNCHRONOUS (1 << 8) 33*4882a593Smuzhiyun 34*4882a593Smuzhiyun #define UVC_CTRL_FLAG_GET_RANGE \ 35*4882a593Smuzhiyun (UVC_CTRL_FLAG_GET_CUR | UVC_CTRL_FLAG_GET_MIN | \ 36*4882a593Smuzhiyun UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES | \ 37*4882a593Smuzhiyun UVC_CTRL_FLAG_GET_DEF) 38*4882a593Smuzhiyun 39*4882a593Smuzhiyun struct uvc_menu_info { 40*4882a593Smuzhiyun __u32 value; 41*4882a593Smuzhiyun __u8 name[32]; 42*4882a593Smuzhiyun }; 43*4882a593Smuzhiyun 44*4882a593Smuzhiyun struct uvc_xu_control_mapping { 45*4882a593Smuzhiyun __u32 id; 46*4882a593Smuzhiyun __u8 name[32]; 47*4882a593Smuzhiyun __u8 entity[16]; 48*4882a593Smuzhiyun __u8 selector; 49*4882a593Smuzhiyun 50*4882a593Smuzhiyun __u8 size; 51*4882a593Smuzhiyun __u8 offset; 52*4882a593Smuzhiyun __u32 v4l2_type; 53*4882a593Smuzhiyun __u32 data_type; 54*4882a593Smuzhiyun 55*4882a593Smuzhiyun struct uvc_menu_info __user *menu_info; 56*4882a593Smuzhiyun __u32 menu_count; 57*4882a593Smuzhiyun 58*4882a593Smuzhiyun __u32 reserved[4]; 59*4882a593Smuzhiyun }; 60*4882a593Smuzhiyun 61*4882a593Smuzhiyun struct uvc_xu_control_query { 62*4882a593Smuzhiyun __u8 unit; 63*4882a593Smuzhiyun __u8 selector; 64*4882a593Smuzhiyun __u8 query; /* Video Class-Specific Request Code, */ 65*4882a593Smuzhiyun /* defined in linux/usb/video.h A.8. */ 66*4882a593Smuzhiyun __u16 size; 67*4882a593Smuzhiyun __u8 __user *data; 68*4882a593Smuzhiyun }; 69*4882a593Smuzhiyun 70*4882a593Smuzhiyun #define UVCIOC_CTRL_MAP _IOWR('u', 0x20, struct uvc_xu_control_mapping) 71*4882a593Smuzhiyun #define UVCIOC_CTRL_QUERY _IOWR('u', 0x21, struct uvc_xu_control_query) 72*4882a593Smuzhiyun 73*4882a593Smuzhiyun /* 74*4882a593Smuzhiyun * Metadata node 75*4882a593Smuzhiyun */ 76*4882a593Smuzhiyun 77*4882a593Smuzhiyun /** 78*4882a593Smuzhiyun * struct uvc_meta_buf - metadata buffer building block 79*4882a593Smuzhiyun * @ns - system timestamp of the payload in nanoseconds 80*4882a593Smuzhiyun * @sof - USB Frame Number 81*4882a593Smuzhiyun * @length - length of the payload header 82*4882a593Smuzhiyun * @flags - payload header flags 83*4882a593Smuzhiyun * @buf - optional device-specific header data 84*4882a593Smuzhiyun * 85*4882a593Smuzhiyun * UVC metadata nodes fill buffers with possibly multiple instances of this 86*4882a593Smuzhiyun * struct. The first two fields are added by the driver, they can be used for 87*4882a593Smuzhiyun * clock synchronisation. The rest is an exact copy of a UVC payload header. 88*4882a593Smuzhiyun * Only complete objects with complete buffers are included. Therefore it's 89*4882a593Smuzhiyun * always sizeof(meta->ts) + sizeof(meta->sof) + meta->length bytes large. 90*4882a593Smuzhiyun */ 91*4882a593Smuzhiyun struct uvc_meta_buf { 92*4882a593Smuzhiyun __u64 ns; 93*4882a593Smuzhiyun __u16 sof; 94*4882a593Smuzhiyun __u8 length; 95*4882a593Smuzhiyun __u8 flags; 96*4882a593Smuzhiyun __u8 buf[]; 97*4882a593Smuzhiyun } __packed; 98*4882a593Smuzhiyun 99*4882a593Smuzhiyun #endif 100