forked from Qortal/Brooklyn
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
925 lines
27 KiB
925 lines
27 KiB
/* SPDX-License-Identifier: GPL-2.0 */ |
|
#ifndef _USB_VIDEO_H_ |
|
#define _USB_VIDEO_H_ |
|
|
|
#ifndef __KERNEL__ |
|
#error "The uvcvideo.h header is deprecated, use linux/uvcvideo.h instead." |
|
#endif /* __KERNEL__ */ |
|
|
|
#include <linux/atomic.h> |
|
#include <linux/kernel.h> |
|
#include <linux/poll.h> |
|
#include <linux/usb.h> |
|
#include <linux/usb/video.h> |
|
#include <linux/uvcvideo.h> |
|
#include <linux/videodev2.h> |
|
#include <linux/workqueue.h> |
|
#include <media/media-device.h> |
|
#include <media/v4l2-device.h> |
|
#include <media/v4l2-event.h> |
|
#include <media/v4l2-fh.h> |
|
#include <media/videobuf2-v4l2.h> |
|
|
|
/* -------------------------------------------------------------------------- |
|
* UVC constants |
|
*/ |
|
|
|
#define UVC_TERM_INPUT 0x0000 |
|
#define UVC_TERM_OUTPUT 0x8000 |
|
#define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000) |
|
|
|
#define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff) |
|
#define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0) |
|
#define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0) |
|
#define UVC_ENTITY_IS_ITERM(entity) \ |
|
(UVC_ENTITY_IS_TERM(entity) && \ |
|
((entity)->type & 0x8000) == UVC_TERM_INPUT) |
|
#define UVC_ENTITY_IS_OTERM(entity) \ |
|
(UVC_ENTITY_IS_TERM(entity) && \ |
|
((entity)->type & 0x8000) == UVC_TERM_OUTPUT) |
|
|
|
#define UVC_EXT_GPIO_UNIT 0x7ffe |
|
#define UVC_EXT_GPIO_UNIT_ID 0x100 |
|
|
|
/* ------------------------------------------------------------------------ |
|
* GUIDs |
|
*/ |
|
#define UVC_GUID_UVC_CAMERA \ |
|
{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \ |
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01} |
|
#define UVC_GUID_UVC_OUTPUT \ |
|
{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \ |
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02} |
|
#define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \ |
|
{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \ |
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03} |
|
#define UVC_GUID_UVC_PROCESSING \ |
|
{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \ |
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01} |
|
#define UVC_GUID_UVC_SELECTOR \ |
|
{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \ |
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02} |
|
#define UVC_GUID_EXT_GPIO_CONTROLLER \ |
|
{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \ |
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x03} |
|
|
|
#define UVC_GUID_FORMAT_MJPEG \ |
|
{ 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_YUY2 \ |
|
{ 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_YUY2_ISIGHT \ |
|
{ 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_NV12 \ |
|
{ 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_YV12 \ |
|
{ 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_I420 \ |
|
{ 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_UYVY \ |
|
{ 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_Y800 \ |
|
{ 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_Y8 \ |
|
{ 'Y', '8', ' ', ' ', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_Y10 \ |
|
{ 'Y', '1', '0', ' ', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_Y12 \ |
|
{ 'Y', '1', '2', ' ', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_Y16 \ |
|
{ 'Y', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_BY8 \ |
|
{ 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_BA81 \ |
|
{ 'B', 'A', '8', '1', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_GBRG \ |
|
{ 'G', 'B', 'R', 'G', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_GRBG \ |
|
{ 'G', 'R', 'B', 'G', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_RGGB \ |
|
{ 'R', 'G', 'G', 'B', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_BG16 \ |
|
{ 'B', 'G', '1', '6', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_GB16 \ |
|
{ 'G', 'B', '1', '6', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_RG16 \ |
|
{ 'R', 'G', '1', '6', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_GR16 \ |
|
{ 'G', 'R', '1', '6', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_RGBP \ |
|
{ 'R', 'G', 'B', 'P', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_BGR3 \ |
|
{ 0x7d, 0xeb, 0x36, 0xe4, 0x4f, 0x52, 0xce, 0x11, \ |
|
0x9f, 0x53, 0x00, 0x20, 0xaf, 0x0b, 0xa7, 0x70} |
|
#define UVC_GUID_FORMAT_M420 \ |
|
{ 'M', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
|
|
#define UVC_GUID_FORMAT_H264 \ |
|
{ 'H', '2', '6', '4', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_Y8I \ |
|
{ 'Y', '8', 'I', ' ', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_Y12I \ |
|
{ 'Y', '1', '2', 'I', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_Z16 \ |
|
{ 'Z', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_RW10 \ |
|
{ 'R', 'W', '1', '0', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_INVZ \ |
|
{ 'I', 'N', 'V', 'Z', 0x90, 0x2d, 0x58, 0x4a, \ |
|
0x92, 0x0b, 0x77, 0x3f, 0x1f, 0x2c, 0x55, 0x6b} |
|
#define UVC_GUID_FORMAT_INZI \ |
|
{ 'I', 'N', 'Z', 'I', 0x66, 0x1a, 0x42, 0xa2, \ |
|
0x90, 0x65, 0xd0, 0x18, 0x14, 0xa8, 0xef, 0x8a} |
|
#define UVC_GUID_FORMAT_INVI \ |
|
{ 'I', 'N', 'V', 'I', 0xdb, 0x57, 0x49, 0x5e, \ |
|
0x8e, 0x3f, 0xf4, 0x79, 0x53, 0x2b, 0x94, 0x6f} |
|
#define UVC_GUID_FORMAT_CNF4 \ |
|
{ 'C', ' ', ' ', ' ', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
|
|
#define UVC_GUID_FORMAT_D3DFMT_L8 \ |
|
{0x32, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
#define UVC_GUID_FORMAT_KSMEDIA_L8_IR \ |
|
{0x32, 0x00, 0x00, 0x00, 0x02, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
|
|
#define UVC_GUID_FORMAT_HEVC \ |
|
{ 'H', 'E', 'V', 'C', 0x00, 0x00, 0x10, 0x00, \ |
|
0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71} |
|
|
|
|
|
/* ------------------------------------------------------------------------ |
|
* Driver specific constants. |
|
*/ |
|
|
|
#define DRIVER_VERSION "1.1.1" |
|
|
|
/* Number of isochronous URBs. */ |
|
#define UVC_URBS 5 |
|
/* Maximum number of packets per URB. */ |
|
#define UVC_MAX_PACKETS 32 |
|
/* Maximum status buffer size in bytes of interrupt URB. */ |
|
#define UVC_MAX_STATUS_SIZE 16 |
|
|
|
#define UVC_CTRL_CONTROL_TIMEOUT 500 |
|
#define UVC_CTRL_STREAMING_TIMEOUT 5000 |
|
|
|
/* Maximum allowed number of control mappings per device */ |
|
#define UVC_MAX_CONTROL_MAPPINGS 1024 |
|
#define UVC_MAX_CONTROL_MENU_ENTRIES 32 |
|
|
|
/* Devices quirks */ |
|
#define UVC_QUIRK_STATUS_INTERVAL 0x00000001 |
|
#define UVC_QUIRK_PROBE_MINMAX 0x00000002 |
|
#define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004 |
|
#define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008 |
|
#define UVC_QUIRK_STREAM_NO_FID 0x00000010 |
|
#define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020 |
|
#define UVC_QUIRK_FIX_BANDWIDTH 0x00000080 |
|
#define UVC_QUIRK_PROBE_DEF 0x00000100 |
|
#define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200 |
|
#define UVC_QUIRK_RESTORE_CTRLS_ON_INIT 0x00000400 |
|
#define UVC_QUIRK_FORCE_Y8 0x00000800 |
|
#define UVC_QUIRK_FORCE_BPP 0x00001000 |
|
|
|
/* Format flags */ |
|
#define UVC_FMT_FLAG_COMPRESSED 0x00000001 |
|
#define UVC_FMT_FLAG_STREAM 0x00000002 |
|
|
|
/* ------------------------------------------------------------------------ |
|
* Structures. |
|
*/ |
|
|
|
struct gpio_desc; |
|
struct uvc_device; |
|
|
|
/* TODO: Put the most frequently accessed fields at the beginning of |
|
* structures to maximize cache efficiency. |
|
*/ |
|
struct uvc_control_info { |
|
struct list_head mappings; |
|
|
|
u8 entity[16]; |
|
u8 index; /* Bit index in bmControls */ |
|
u8 selector; |
|
|
|
u16 size; |
|
u32 flags; |
|
}; |
|
|
|
struct uvc_control_mapping { |
|
struct list_head list; |
|
struct list_head ev_subs; |
|
|
|
u32 id; |
|
u8 name[32]; |
|
u8 entity[16]; |
|
u8 selector; |
|
|
|
u8 size; |
|
u8 offset; |
|
enum v4l2_ctrl_type v4l2_type; |
|
u32 data_type; |
|
|
|
const struct uvc_menu_info *menu_info; |
|
u32 menu_count; |
|
|
|
u32 master_id; |
|
s32 master_manual; |
|
u32 slave_ids[2]; |
|
|
|
s32 (*get)(struct uvc_control_mapping *mapping, u8 query, |
|
const u8 *data); |
|
void (*set)(struct uvc_control_mapping *mapping, s32 value, |
|
u8 *data); |
|
}; |
|
|
|
struct uvc_control { |
|
struct uvc_entity *entity; |
|
struct uvc_control_info info; |
|
|
|
u8 index; /* Used to match the uvc_control entry with a |
|
uvc_control_info. */ |
|
u8 dirty:1, |
|
loaded:1, |
|
modified:1, |
|
cached:1, |
|
initialized:1; |
|
|
|
u8 *uvc_data; |
|
|
|
struct uvc_fh *handle; /* File handle that last changed the control. */ |
|
}; |
|
|
|
struct uvc_format_desc { |
|
char *name; |
|
u8 guid[16]; |
|
u32 fcc; |
|
}; |
|
|
|
/* The term 'entity' refers to both UVC units and UVC terminals. |
|
* |
|
* The type field is either the terminal type (wTerminalType in the terminal |
|
* descriptor), or the unit type (bDescriptorSubtype in the unit descriptor). |
|
* As the bDescriptorSubtype field is one byte long, the type value will |
|
* always have a null MSB for units. All terminal types defined by the UVC |
|
* specification have a non-null MSB, so it is safe to use the MSB to |
|
* differentiate between units and terminals as long as the descriptor parsing |
|
* code makes sure terminal types have a non-null MSB. |
|
* |
|
* For terminals, the type's most significant bit stores the terminal |
|
* direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should |
|
* always be accessed with the UVC_ENTITY_* macros and never directly. |
|
*/ |
|
|
|
#define UVC_ENTITY_FLAG_DEFAULT (1 << 0) |
|
|
|
struct uvc_entity { |
|
struct list_head list; /* Entity as part of a UVC device. */ |
|
struct list_head chain; /* Entity as part of a video device |
|
* chain. */ |
|
unsigned int flags; |
|
|
|
/* |
|
* Entities exposed by the UVC device use IDs 0-255, extra entities |
|
* implemented by the driver (such as the GPIO entity) use IDs 256 and |
|
* up. |
|
*/ |
|
u16 id; |
|
u16 type; |
|
char name[64]; |
|
u8 guid[16]; |
|
|
|
/* Media controller-related fields. */ |
|
struct video_device *vdev; |
|
struct v4l2_subdev subdev; |
|
unsigned int num_pads; |
|
unsigned int num_links; |
|
struct media_pad *pads; |
|
|
|
union { |
|
struct { |
|
u16 wObjectiveFocalLengthMin; |
|
u16 wObjectiveFocalLengthMax; |
|
u16 wOcularFocalLength; |
|
u8 bControlSize; |
|
u8 *bmControls; |
|
} camera; |
|
|
|
struct { |
|
u8 bControlSize; |
|
u8 *bmControls; |
|
u8 bTransportModeSize; |
|
u8 *bmTransportModes; |
|
} media; |
|
|
|
struct { |
|
} output; |
|
|
|
struct { |
|
u16 wMaxMultiplier; |
|
u8 bControlSize; |
|
u8 *bmControls; |
|
u8 bmVideoStandards; |
|
} processing; |
|
|
|
struct { |
|
} selector; |
|
|
|
struct { |
|
u8 bNumControls; |
|
u8 bControlSize; |
|
u8 *bmControls; |
|
u8 *bmControlsType; |
|
} extension; |
|
|
|
struct { |
|
u8 bControlSize; |
|
u8 *bmControls; |
|
struct gpio_desc *gpio_privacy; |
|
int irq; |
|
} gpio; |
|
}; |
|
|
|
u8 bNrInPins; |
|
u8 *baSourceID; |
|
|
|
int (*get_info)(struct uvc_device *dev, struct uvc_entity *entity, |
|
u8 cs, u8 *caps); |
|
int (*get_cur)(struct uvc_device *dev, struct uvc_entity *entity, |
|
u8 cs, void *data, u16 size); |
|
|
|
unsigned int ncontrols; |
|
struct uvc_control *controls; |
|
}; |
|
|
|
struct uvc_frame { |
|
u8 bFrameIndex; |
|
u8 bmCapabilities; |
|
u16 wWidth; |
|
u16 wHeight; |
|
u32 dwMinBitRate; |
|
u32 dwMaxBitRate; |
|
u32 dwMaxVideoFrameBufferSize; |
|
u8 bFrameIntervalType; |
|
u32 dwDefaultFrameInterval; |
|
u32 *dwFrameInterval; |
|
}; |
|
|
|
struct uvc_format { |
|
u8 type; |
|
u8 index; |
|
u8 bpp; |
|
enum v4l2_colorspace colorspace; |
|
enum v4l2_xfer_func xfer_func; |
|
enum v4l2_ycbcr_encoding ycbcr_enc; |
|
u32 fcc; |
|
u32 flags; |
|
|
|
char name[32]; |
|
|
|
unsigned int nframes; |
|
struct uvc_frame *frame; |
|
}; |
|
|
|
struct uvc_streaming_header { |
|
u8 bNumFormats; |
|
u8 bEndpointAddress; |
|
u8 bTerminalLink; |
|
u8 bControlSize; |
|
u8 *bmaControls; |
|
/* The following fields are used by input headers only. */ |
|
u8 bmInfo; |
|
u8 bStillCaptureMethod; |
|
u8 bTriggerSupport; |
|
u8 bTriggerUsage; |
|
}; |
|
|
|
enum uvc_buffer_state { |
|
UVC_BUF_STATE_IDLE = 0, |
|
UVC_BUF_STATE_QUEUED = 1, |
|
UVC_BUF_STATE_ACTIVE = 2, |
|
UVC_BUF_STATE_READY = 3, |
|
UVC_BUF_STATE_DONE = 4, |
|
UVC_BUF_STATE_ERROR = 5, |
|
}; |
|
|
|
struct uvc_buffer { |
|
struct vb2_v4l2_buffer buf; |
|
struct list_head queue; |
|
|
|
enum uvc_buffer_state state; |
|
unsigned int error; |
|
|
|
void *mem; |
|
unsigned int length; |
|
unsigned int bytesused; |
|
|
|
u32 pts; |
|
|
|
/* Asynchronous buffer handling. */ |
|
struct kref ref; |
|
}; |
|
|
|
#define UVC_QUEUE_DISCONNECTED (1 << 0) |
|
#define UVC_QUEUE_DROP_CORRUPTED (1 << 1) |
|
|
|
struct uvc_video_queue { |
|
struct vb2_queue queue; |
|
struct mutex mutex; /* Protects queue */ |
|
|
|
unsigned int flags; |
|
unsigned int buf_used; |
|
|
|
spinlock_t irqlock; /* Protects irqqueue */ |
|
struct list_head irqqueue; |
|
}; |
|
|
|
struct uvc_video_chain { |
|
struct uvc_device *dev; |
|
struct list_head list; |
|
|
|
struct list_head entities; /* All entities */ |
|
struct uvc_entity *processing; /* Processing unit */ |
|
struct uvc_entity *selector; /* Selector unit */ |
|
|
|
struct mutex ctrl_mutex; /* Protects ctrl.info */ |
|
|
|
struct v4l2_prio_state prio; /* V4L2 priority state */ |
|
u32 caps; /* V4L2 chain-wide caps */ |
|
}; |
|
|
|
struct uvc_stats_frame { |
|
unsigned int size; /* Number of bytes captured */ |
|
unsigned int first_data; /* Index of the first non-empty packet */ |
|
|
|
unsigned int nb_packets; /* Number of packets */ |
|
unsigned int nb_empty; /* Number of empty packets */ |
|
unsigned int nb_invalid; /* Number of packets with an invalid header */ |
|
unsigned int nb_errors; /* Number of packets with the error bit set */ |
|
|
|
unsigned int nb_pts; /* Number of packets with a PTS timestamp */ |
|
unsigned int nb_pts_diffs; /* Number of PTS differences inside a frame */ |
|
unsigned int last_pts_diff; /* Index of the last PTS difference */ |
|
bool has_initial_pts; /* Whether the first non-empty packet has a PTS */ |
|
bool has_early_pts; /* Whether a PTS is present before the first non-empty packet */ |
|
u32 pts; /* PTS of the last packet */ |
|
|
|
unsigned int nb_scr; /* Number of packets with a SCR timestamp */ |
|
unsigned int nb_scr_diffs; /* Number of SCR.STC differences inside a frame */ |
|
u16 scr_sof; /* SCR.SOF of the last packet */ |
|
u32 scr_stc; /* SCR.STC of the last packet */ |
|
}; |
|
|
|
struct uvc_stats_stream { |
|
ktime_t start_ts; /* Stream start timestamp */ |
|
ktime_t stop_ts; /* Stream stop timestamp */ |
|
|
|
unsigned int nb_frames; /* Number of frames */ |
|
|
|
unsigned int nb_packets; /* Number of packets */ |
|
unsigned int nb_empty; /* Number of empty packets */ |
|
unsigned int nb_invalid; /* Number of packets with an invalid header */ |
|
unsigned int nb_errors; /* Number of packets with the error bit set */ |
|
|
|
unsigned int nb_pts_constant; /* Number of frames with constant PTS */ |
|
unsigned int nb_pts_early; /* Number of frames with early PTS */ |
|
unsigned int nb_pts_initial; /* Number of frames with initial PTS */ |
|
|
|
unsigned int nb_scr_count_ok; /* Number of frames with at least one SCR per non empty packet */ |
|
unsigned int nb_scr_diffs_ok; /* Number of frames with varying SCR.STC */ |
|
unsigned int scr_sof_count; /* STC.SOF counter accumulated since stream start */ |
|
unsigned int scr_sof; /* STC.SOF of the last packet */ |
|
unsigned int min_sof; /* Minimum STC.SOF value */ |
|
unsigned int max_sof; /* Maximum STC.SOF value */ |
|
}; |
|
|
|
#define UVC_METADATA_BUF_SIZE 1024 |
|
|
|
/** |
|
* struct uvc_copy_op: Context structure to schedule asynchronous memcpy |
|
* |
|
* @buf: active buf object for this operation |
|
* @dst: copy destination address |
|
* @src: copy source address |
|
* @len: copy length |
|
*/ |
|
struct uvc_copy_op { |
|
struct uvc_buffer *buf; |
|
void *dst; |
|
const __u8 *src; |
|
size_t len; |
|
}; |
|
|
|
/** |
|
* struct uvc_urb - URB context management structure |
|
* |
|
* @urb: the URB described by this context structure |
|
* @stream: UVC streaming context |
|
* @buffer: memory storage for the URB |
|
* @dma: DMA coherent addressing for the urb_buffer |
|
* @async_operations: counter to indicate the number of copy operations |
|
* @copy_operations: work descriptors for asynchronous copy operations |
|
* @work: work queue entry for asynchronous decode |
|
*/ |
|
struct uvc_urb { |
|
struct urb *urb; |
|
struct uvc_streaming *stream; |
|
|
|
char *buffer; |
|
dma_addr_t dma; |
|
|
|
unsigned int async_operations; |
|
struct uvc_copy_op copy_operations[UVC_MAX_PACKETS]; |
|
struct work_struct work; |
|
}; |
|
|
|
struct uvc_streaming { |
|
struct list_head list; |
|
struct uvc_device *dev; |
|
struct video_device vdev; |
|
struct uvc_video_chain *chain; |
|
atomic_t active; |
|
|
|
struct usb_interface *intf; |
|
int intfnum; |
|
u16 maxpsize; |
|
|
|
struct uvc_streaming_header header; |
|
enum v4l2_buf_type type; |
|
|
|
unsigned int nformats; |
|
struct uvc_format *format; |
|
|
|
struct uvc_streaming_control ctrl; |
|
struct uvc_format *def_format; |
|
struct uvc_format *cur_format; |
|
struct uvc_frame *cur_frame; |
|
|
|
/* Protect access to ctrl, cur_format, cur_frame and hardware video |
|
* probe control. |
|
*/ |
|
struct mutex mutex; |
|
|
|
/* Buffers queue. */ |
|
unsigned int frozen : 1; |
|
struct uvc_video_queue queue; |
|
struct workqueue_struct *async_wq; |
|
void (*decode)(struct uvc_urb *uvc_urb, struct uvc_buffer *buf, |
|
struct uvc_buffer *meta_buf); |
|
|
|
struct { |
|
struct video_device vdev; |
|
struct uvc_video_queue queue; |
|
u32 format; |
|
} meta; |
|
|
|
/* Context data used by the bulk completion handler. */ |
|
struct { |
|
u8 header[256]; |
|
unsigned int header_size; |
|
int skip_payload; |
|
u32 payload_size; |
|
u32 max_payload_size; |
|
} bulk; |
|
|
|
struct uvc_urb uvc_urb[UVC_URBS]; |
|
unsigned int urb_size; |
|
|
|
u32 sequence; |
|
u8 last_fid; |
|
|
|
/* debugfs */ |
|
struct dentry *debugfs_dir; |
|
struct { |
|
struct uvc_stats_frame frame; |
|
struct uvc_stats_stream stream; |
|
} stats; |
|
|
|
/* Timestamps support. */ |
|
struct uvc_clock { |
|
struct uvc_clock_sample { |
|
u32 dev_stc; |
|
u16 dev_sof; |
|
u16 host_sof; |
|
ktime_t host_time; |
|
} *samples; |
|
|
|
unsigned int head; |
|
unsigned int count; |
|
unsigned int size; |
|
|
|
u16 last_sof; |
|
u16 sof_offset; |
|
|
|
u8 last_scr[6]; |
|
|
|
spinlock_t lock; |
|
} clock; |
|
}; |
|
|
|
#define for_each_uvc_urb(uvc_urb, uvc_streaming) \ |
|
for ((uvc_urb) = &(uvc_streaming)->uvc_urb[0]; \ |
|
(uvc_urb) < &(uvc_streaming)->uvc_urb[UVC_URBS]; \ |
|
++(uvc_urb)) |
|
|
|
static inline u32 uvc_urb_index(const struct uvc_urb *uvc_urb) |
|
{ |
|
return uvc_urb - &uvc_urb->stream->uvc_urb[0]; |
|
} |
|
|
|
struct uvc_device_info { |
|
u32 quirks; |
|
u32 meta_format; |
|
u16 uvc_version; |
|
}; |
|
|
|
struct uvc_device { |
|
struct usb_device *udev; |
|
struct usb_interface *intf; |
|
unsigned long warnings; |
|
u32 quirks; |
|
int intfnum; |
|
char name[32]; |
|
|
|
const struct uvc_device_info *info; |
|
|
|
struct mutex lock; /* Protects users */ |
|
unsigned int users; |
|
atomic_t nmappings; |
|
|
|
/* Video control interface */ |
|
#ifdef CONFIG_MEDIA_CONTROLLER |
|
struct media_device mdev; |
|
#endif |
|
struct v4l2_device vdev; |
|
u16 uvc_version; |
|
u32 clock_frequency; |
|
|
|
struct list_head entities; |
|
struct list_head chains; |
|
|
|
/* Video Streaming interfaces */ |
|
struct list_head streams; |
|
struct kref ref; |
|
|
|
/* Status Interrupt Endpoint */ |
|
struct usb_host_endpoint *int_ep; |
|
struct urb *int_urb; |
|
u8 *status; |
|
struct input_dev *input; |
|
char input_phys[64]; |
|
|
|
struct uvc_ctrl_work { |
|
struct work_struct work; |
|
struct urb *urb; |
|
struct uvc_video_chain *chain; |
|
struct uvc_control *ctrl; |
|
const void *data; |
|
} async_ctrl; |
|
|
|
struct uvc_entity *gpio_unit; |
|
}; |
|
|
|
enum uvc_handle_state { |
|
UVC_HANDLE_PASSIVE = 0, |
|
UVC_HANDLE_ACTIVE = 1, |
|
}; |
|
|
|
struct uvc_fh { |
|
struct v4l2_fh vfh; |
|
struct uvc_video_chain *chain; |
|
struct uvc_streaming *stream; |
|
enum uvc_handle_state state; |
|
}; |
|
|
|
struct uvc_driver { |
|
struct usb_driver driver; |
|
}; |
|
|
|
/* ------------------------------------------------------------------------ |
|
* Debugging, printing and logging |
|
*/ |
|
|
|
#define UVC_DBG_PROBE (1 << 0) |
|
#define UVC_DBG_DESCR (1 << 1) |
|
#define UVC_DBG_CONTROL (1 << 2) |
|
#define UVC_DBG_FORMAT (1 << 3) |
|
#define UVC_DBG_CAPTURE (1 << 4) |
|
#define UVC_DBG_CALLS (1 << 5) |
|
#define UVC_DBG_FRAME (1 << 7) |
|
#define UVC_DBG_SUSPEND (1 << 8) |
|
#define UVC_DBG_STATUS (1 << 9) |
|
#define UVC_DBG_VIDEO (1 << 10) |
|
#define UVC_DBG_STATS (1 << 11) |
|
#define UVC_DBG_CLOCK (1 << 12) |
|
|
|
#define UVC_WARN_MINMAX 0 |
|
#define UVC_WARN_PROBE_DEF 1 |
|
#define UVC_WARN_XU_GET_RES 2 |
|
|
|
extern unsigned int uvc_clock_param; |
|
extern unsigned int uvc_no_drop_param; |
|
extern unsigned int uvc_dbg_param; |
|
extern unsigned int uvc_timeout_param; |
|
extern unsigned int uvc_hw_timestamps_param; |
|
|
|
#define uvc_dbg(_dev, flag, fmt, ...) \ |
|
do { \ |
|
if (uvc_dbg_param & UVC_DBG_##flag) \ |
|
dev_printk(KERN_DEBUG, &(_dev)->udev->dev, fmt, \ |
|
##__VA_ARGS__); \ |
|
} while (0) |
|
|
|
#define uvc_dbg_cont(flag, fmt, ...) \ |
|
do { \ |
|
if (uvc_dbg_param & UVC_DBG_##flag) \ |
|
pr_cont(fmt, ##__VA_ARGS__); \ |
|
} while (0) |
|
|
|
#define uvc_warn_once(_dev, warn, fmt, ...) \ |
|
do { \ |
|
if (!test_and_set_bit(warn, &(_dev)->warnings)) \ |
|
dev_info(&(_dev)->udev->dev, fmt, ##__VA_ARGS__); \ |
|
} while (0) |
|
|
|
/* -------------------------------------------------------------------------- |
|
* Internal functions. |
|
*/ |
|
|
|
/* Core driver */ |
|
extern struct uvc_driver uvc_driver; |
|
|
|
struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id); |
|
|
|
/* Video buffers queue management. */ |
|
int uvc_queue_init(struct uvc_video_queue *queue, enum v4l2_buf_type type, |
|
int drop_corrupted); |
|
void uvc_queue_release(struct uvc_video_queue *queue); |
|
int uvc_request_buffers(struct uvc_video_queue *queue, |
|
struct v4l2_requestbuffers *rb); |
|
int uvc_query_buffer(struct uvc_video_queue *queue, |
|
struct v4l2_buffer *v4l2_buf); |
|
int uvc_create_buffers(struct uvc_video_queue *queue, |
|
struct v4l2_create_buffers *v4l2_cb); |
|
int uvc_queue_buffer(struct uvc_video_queue *queue, |
|
struct media_device *mdev, |
|
struct v4l2_buffer *v4l2_buf); |
|
int uvc_export_buffer(struct uvc_video_queue *queue, |
|
struct v4l2_exportbuffer *exp); |
|
int uvc_dequeue_buffer(struct uvc_video_queue *queue, |
|
struct v4l2_buffer *v4l2_buf, int nonblocking); |
|
int uvc_queue_streamon(struct uvc_video_queue *queue, enum v4l2_buf_type type); |
|
int uvc_queue_streamoff(struct uvc_video_queue *queue, enum v4l2_buf_type type); |
|
void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect); |
|
struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue, |
|
struct uvc_buffer *buf); |
|
struct uvc_buffer *uvc_queue_get_current_buffer(struct uvc_video_queue *queue); |
|
void uvc_queue_buffer_release(struct uvc_buffer *buf); |
|
int uvc_queue_mmap(struct uvc_video_queue *queue, |
|
struct vm_area_struct *vma); |
|
__poll_t uvc_queue_poll(struct uvc_video_queue *queue, struct file *file, |
|
poll_table *wait); |
|
#ifndef CONFIG_MMU |
|
unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue, |
|
unsigned long pgoff); |
|
#endif |
|
int uvc_queue_allocated(struct uvc_video_queue *queue); |
|
static inline int uvc_queue_streaming(struct uvc_video_queue *queue) |
|
{ |
|
return vb2_is_streaming(&queue->queue); |
|
} |
|
|
|
static inline struct uvc_streaming * |
|
uvc_queue_to_stream(struct uvc_video_queue *queue) |
|
{ |
|
return container_of(queue, struct uvc_streaming, queue); |
|
} |
|
|
|
/* V4L2 interface */ |
|
extern const struct v4l2_ioctl_ops uvc_ioctl_ops; |
|
extern const struct v4l2_file_operations uvc_fops; |
|
|
|
/* Media controller */ |
|
int uvc_mc_register_entities(struct uvc_video_chain *chain); |
|
void uvc_mc_cleanup_entity(struct uvc_entity *entity); |
|
|
|
/* Video */ |
|
int uvc_video_init(struct uvc_streaming *stream); |
|
int uvc_video_suspend(struct uvc_streaming *stream); |
|
int uvc_video_resume(struct uvc_streaming *stream, int reset); |
|
int uvc_video_start_streaming(struct uvc_streaming *stream); |
|
void uvc_video_stop_streaming(struct uvc_streaming *stream); |
|
int uvc_probe_video(struct uvc_streaming *stream, |
|
struct uvc_streaming_control *probe); |
|
int uvc_query_ctrl(struct uvc_device *dev, u8 query, u8 unit, |
|
u8 intfnum, u8 cs, void *data, u16 size); |
|
void uvc_video_clock_update(struct uvc_streaming *stream, |
|
struct vb2_v4l2_buffer *vbuf, |
|
struct uvc_buffer *buf); |
|
int uvc_meta_register(struct uvc_streaming *stream); |
|
|
|
int uvc_register_video_device(struct uvc_device *dev, |
|
struct uvc_streaming *stream, |
|
struct video_device *vdev, |
|
struct uvc_video_queue *queue, |
|
enum v4l2_buf_type type, |
|
const struct v4l2_file_operations *fops, |
|
const struct v4l2_ioctl_ops *ioctl_ops); |
|
|
|
/* Status */ |
|
int uvc_status_init(struct uvc_device *dev); |
|
void uvc_status_unregister(struct uvc_device *dev); |
|
void uvc_status_cleanup(struct uvc_device *dev); |
|
int uvc_status_start(struct uvc_device *dev, gfp_t flags); |
|
void uvc_status_stop(struct uvc_device *dev); |
|
|
|
/* Controls */ |
|
extern const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops; |
|
|
|
int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain, |
|
struct v4l2_queryctrl *v4l2_ctrl); |
|
int uvc_query_v4l2_menu(struct uvc_video_chain *chain, |
|
struct v4l2_querymenu *query_menu); |
|
|
|
int uvc_ctrl_add_mapping(struct uvc_video_chain *chain, |
|
const struct uvc_control_mapping *mapping); |
|
int uvc_ctrl_init_device(struct uvc_device *dev); |
|
void uvc_ctrl_cleanup_device(struct uvc_device *dev); |
|
int uvc_ctrl_restore_values(struct uvc_device *dev); |
|
bool uvc_ctrl_status_event_async(struct urb *urb, struct uvc_video_chain *chain, |
|
struct uvc_control *ctrl, const u8 *data); |
|
void uvc_ctrl_status_event(struct uvc_video_chain *chain, |
|
struct uvc_control *ctrl, const u8 *data); |
|
|
|
int uvc_ctrl_begin(struct uvc_video_chain *chain); |
|
int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback, |
|
const struct v4l2_ext_control *xctrls, |
|
unsigned int xctrls_count); |
|
static inline int uvc_ctrl_commit(struct uvc_fh *handle, |
|
const struct v4l2_ext_control *xctrls, |
|
unsigned int xctrls_count) |
|
{ |
|
return __uvc_ctrl_commit(handle, 0, xctrls, xctrls_count); |
|
} |
|
static inline int uvc_ctrl_rollback(struct uvc_fh *handle) |
|
{ |
|
return __uvc_ctrl_commit(handle, 1, NULL, 0); |
|
} |
|
|
|
int uvc_ctrl_get(struct uvc_video_chain *chain, struct v4l2_ext_control *xctrl); |
|
int uvc_ctrl_set(struct uvc_fh *handle, struct v4l2_ext_control *xctrl); |
|
|
|
int uvc_xu_ctrl_query(struct uvc_video_chain *chain, |
|
struct uvc_xu_control_query *xqry); |
|
|
|
/* Utility functions */ |
|
void uvc_simplify_fraction(u32 *numerator, u32 *denominator, |
|
unsigned int n_terms, unsigned int threshold); |
|
u32 uvc_fraction_to_interval(u32 numerator, u32 denominator); |
|
struct usb_host_endpoint *uvc_find_endpoint(struct usb_host_interface *alts, |
|
u8 epaddr); |
|
|
|
/* Quirks support */ |
|
void uvc_video_decode_isight(struct uvc_urb *uvc_urb, |
|
struct uvc_buffer *buf, |
|
struct uvc_buffer *meta_buf); |
|
|
|
/* debugfs and statistics */ |
|
void uvc_debugfs_init(void); |
|
void uvc_debugfs_cleanup(void); |
|
void uvc_debugfs_init_stream(struct uvc_streaming *stream); |
|
void uvc_debugfs_cleanup_stream(struct uvc_streaming *stream); |
|
|
|
size_t uvc_video_stats_dump(struct uvc_streaming *stream, char *buf, |
|
size_t size); |
|
|
|
#endif
|
|
|