tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * uvc_gadget.h -- USB Video Class Gadget driver
4 *
5 * Copyright (C) 2009-2010
6 * Laurent Pinchart (laurent.pinchart@ideasonboard.com)
7 */
8
9#ifndef _UVC_GADGET_H_
10#define _UVC_GADGET_H_
11
12#include <linux/list.h>
13#include <linux/mutex.h>
14#include <linux/spinlock.h>
15#include <linux/usb/composite.h>
16#include <linux/videodev2.h>
17#include <linux/wait.h>
18
19#include <media/v4l2-device.h>
20#include <media/v4l2-dev.h>
21#include <media/v4l2-fh.h>
22
23#include "uvc_queue.h"
24
25struct usb_ep;
26struct usb_request;
27struct uvc_descriptor_header;
28struct uvc_device;
29
30/* ------------------------------------------------------------------------
31 * Debugging, printing and logging
32 */
33
34#define UVC_TRACE_PROBE (1 << 0)
35#define UVC_TRACE_DESCR (1 << 1)
36#define UVC_TRACE_CONTROL (1 << 2)
37#define UVC_TRACE_FORMAT (1 << 3)
38#define UVC_TRACE_CAPTURE (1 << 4)
39#define UVC_TRACE_CALLS (1 << 5)
40#define UVC_TRACE_IOCTL (1 << 6)
41#define UVC_TRACE_FRAME (1 << 7)
42#define UVC_TRACE_SUSPEND (1 << 8)
43#define UVC_TRACE_STATUS (1 << 9)
44
45#define UVC_WARN_MINMAX 0
46#define UVC_WARN_PROBE_DEF 1
47
48extern unsigned int uvc_gadget_trace_param;
49
50#define uvc_trace(flag, msg...) \
51 do { \
52 if (uvc_gadget_trace_param & flag) \
53 printk(KERN_DEBUG "uvcvideo: " msg); \
54 } while (0)
55
56#define uvcg_dbg(f, fmt, args...) \
57 dev_dbg(&(f)->config->cdev->gadget->dev, "%s: " fmt, (f)->name, ##args)
58#define uvcg_info(f, fmt, args...) \
59 dev_info(&(f)->config->cdev->gadget->dev, "%s: " fmt, (f)->name, ##args)
60#define uvcg_warn(f, fmt, args...) \
61 dev_warn(&(f)->config->cdev->gadget->dev, "%s: " fmt, (f)->name, ##args)
62#define uvcg_err(f, fmt, args...) \
63 dev_err(&(f)->config->cdev->gadget->dev, "%s: " fmt, (f)->name, ##args)
64
65/* ------------------------------------------------------------------------
66 * Driver specific constants
67 */
68
69#define UVC_MAX_REQUEST_SIZE 64
70#define UVC_MAX_EVENTS 4
71
72#define UVCG_REQUEST_HEADER_LEN 12
73
74/* ------------------------------------------------------------------------
75 * Structures
76 */
77struct uvc_request {
78 struct usb_request *req;
79 u8 *req_buffer;
80 struct uvc_video *video;
81 struct sg_table sgt;
82 u8 header[UVCG_REQUEST_HEADER_LEN];
83};
84
85struct uvc_video {
86 struct uvc_device *uvc;
87 struct usb_ep *ep;
88
89 struct work_struct pump;
90
91 /* Frame parameters */
92 u8 bpp;
93 u32 fcc;
94 unsigned int width;
95 unsigned int height;
96 unsigned int imagesize;
97 struct mutex mutex; /* protects frame parameters */
98
99 unsigned int uvc_num_requests;
100
101 /* Requests */
102 unsigned int req_size;
103 struct uvc_request *ureq;
104 struct list_head req_free;
105 spinlock_t req_lock;
106
107 unsigned int req_int_count;
108
109 void (*encode) (struct usb_request *req, struct uvc_video *video,
110 struct uvc_buffer *buf);
111
112 /* Context data used by the completion handler */
113 __u32 payload_size;
114 __u32 max_payload_size;
115
116 struct uvc_video_queue queue;
117 unsigned int fid;
118};
119
120enum uvc_state {
121 UVC_STATE_DISCONNECTED,
122 UVC_STATE_CONNECTED,
123 UVC_STATE_STREAMING,
124};
125
126struct uvc_device {
127 struct video_device vdev;
128 struct v4l2_device v4l2_dev;
129 enum uvc_state state;
130 struct usb_function func;
131 struct uvc_video video;
132 bool func_connected;
133 wait_queue_head_t func_connected_queue;
134
135 /* Descriptors */
136 struct {
137 const struct uvc_descriptor_header * const *fs_control;
138 const struct uvc_descriptor_header * const *ss_control;
139 const struct uvc_descriptor_header * const *fs_streaming;
140 const struct uvc_descriptor_header * const *hs_streaming;
141 const struct uvc_descriptor_header * const *ss_streaming;
142 } desc;
143
144 unsigned int control_intf;
145 struct usb_ep *control_ep;
146 struct usb_request *control_req;
147 void *control_buf;
148
149 unsigned int streaming_intf;
150
151 /* Events */
152 unsigned int event_length;
153 unsigned int event_setup_out : 1;
154};
155
156static inline struct uvc_device *to_uvc(struct usb_function *f)
157{
158 return container_of(f, struct uvc_device, func);
159}
160
161struct uvc_file_handle {
162 struct v4l2_fh vfh;
163 struct uvc_video *device;
164 bool is_uvc_app_handle;
165};
166
167#define to_uvc_file_handle(handle) \
168 container_of(handle, struct uvc_file_handle, vfh)
169
170/* ------------------------------------------------------------------------
171 * Functions
172 */
173
174extern void uvc_function_setup_continue(struct uvc_device *uvc);
175extern void uvc_endpoint_stream(struct uvc_device *dev);
176
177extern void uvc_function_connect(struct uvc_device *uvc);
178extern void uvc_function_disconnect(struct uvc_device *uvc);
179
180#endif /* _UVC_GADGET_H_ */