LXR linux/include/uapi/linux/uvcvideo.h

   1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
   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/* Control supports asynchronous reporting */
  32#define UVC_CTRL_FLAG_ASYNCHRONOUS      (1 << 8)
  33
  34#define UVC_CTRL_FLAG_GET_RANGE \
  35        (UVC_CTRL_FLAG_GET_CUR | UVC_CTRL_FLAG_GET_MIN | \
  36         UVC_CTRL_FLAG_GET_MAX | UVC_CTRL_FLAG_GET_RES | \
  37         UVC_CTRL_FLAG_GET_DEF)
  38
  39struct uvc_menu_info {
  40        __u32 value;
  41        __u8 name[32];
  42};
  43
  44struct uvc_xu_control_mapping {
  45        __u32 id;
  46        __u8 name[32];
  47        __u8 entity[16];
  48        __u8 selector;
  49
  50        __u8 size;
  51        __u8 offset;
  52        __u32 v4l2_type;
  53        __u32 data_type;
  54
  55        struct uvc_menu_info __user *menu_info;
  56        __u32 menu_count;
  57
  58        __u32 reserved[4];
  59};
  60
  61struct uvc_xu_control_query {
  62        __u8 unit;
  63        __u8 selector;
  64        __u8 query;             /* Video Class-Specific Request Code, */
  65                                /* defined in linux/usb/video.h A.8.  */
  66        __u16 size;
  67        __u8 __user *data;
  68};
  69
  70#define UVCIOC_CTRL_MAP         _IOWR('u', 0x20, struct uvc_xu_control_mapping)
  71#define UVCIOC_CTRL_QUERY       _IOWR('u', 0x21, struct uvc_xu_control_query)
  72
  73/*
  74 * Metadata node
  75 */
  76
  77/**
  78 * struct uvc_meta_buf - metadata buffer building block
  79 * @ns: system timestamp of the payload in nanoseconds
  80 * @sof: USB Frame Number
  81 * @length: length of the payload header
  82 * @flags: payload header flags
  83 * @buf: optional device-specific header data
  84 *
  85 * UVC metadata nodes fill buffers with possibly multiple instances of this
  86 * struct. The first two fields are added by the driver, they can be used for
  87 * clock synchronisation. The rest is an exact copy of a UVC payload header.
  88 * Only complete objects with complete buffers are included. Therefore it's
  89 * always sizeof(meta->ts) + sizeof(meta->sof) + meta->length bytes large.
  90 */
  91struct uvc_meta_buf {
  92        __u64 ns;
  93        __u16 sof;
  94        __u8 length;
  95        __u8 flags;
  96        __u8 buf[];
  97} __packed;
  98
  99#endif
 100