Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * uvc_gadget.h -- USB Video Class Gadget driver
3 *
4 * Copyright (C) 2009-2010
5 * Laurent Pinchart (laurent.pinchart@ideasonboard.com)
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 */
12
13#ifndef _UVC_GADGET_H_
14#define _UVC_GADGET_H_
15
16#include <linux/ioctl.h>
17#include <linux/types.h>
18#include <linux/usb/ch9.h>
19
20#define UVC_EVENT_FIRST (V4L2_EVENT_PRIVATE_START + 0)
21#define UVC_EVENT_CONNECT (V4L2_EVENT_PRIVATE_START + 0)
22#define UVC_EVENT_DISCONNECT (V4L2_EVENT_PRIVATE_START + 1)
23#define UVC_EVENT_STREAMON (V4L2_EVENT_PRIVATE_START + 2)
24#define UVC_EVENT_STREAMOFF (V4L2_EVENT_PRIVATE_START + 3)
25#define UVC_EVENT_SETUP (V4L2_EVENT_PRIVATE_START + 4)
26#define UVC_EVENT_DATA (V4L2_EVENT_PRIVATE_START + 5)
27#define UVC_EVENT_LAST (V4L2_EVENT_PRIVATE_START + 5)
28
29struct uvc_request_data
30{
31 __s32 length;
32 __u8 data[60];
33};
34
35struct uvc_event
36{
37 union {
38 enum usb_device_speed speed;
39 struct usb_ctrlrequest req;
40 struct uvc_request_data data;
41 };
42};
43
44#define UVCIOC_SEND_RESPONSE _IOW('U', 1, struct uvc_request_data)
45
46#define UVC_INTF_CONTROL 0
47#define UVC_INTF_STREAMING 1
48
49/* ------------------------------------------------------------------------
50 * Debugging, printing and logging
51 */
52
53#ifdef __KERNEL__
54
55#include <linux/usb.h> /* For usb_endpoint_* */
56#include <linux/usb/gadget.h>
57#include <linux/videodev2.h>
58#include <linux/version.h>
59#include <media/v4l2-fh.h>
60#include <media/v4l2-device.h>
61
62#include "uvc_queue.h"
63
64#define UVC_TRACE_PROBE (1 << 0)
65#define UVC_TRACE_DESCR (1 << 1)
66#define UVC_TRACE_CONTROL (1 << 2)
67#define UVC_TRACE_FORMAT (1 << 3)
68#define UVC_TRACE_CAPTURE (1 << 4)
69#define UVC_TRACE_CALLS (1 << 5)
70#define UVC_TRACE_IOCTL (1 << 6)
71#define UVC_TRACE_FRAME (1 << 7)
72#define UVC_TRACE_SUSPEND (1 << 8)
73#define UVC_TRACE_STATUS (1 << 9)
74
75#define UVC_WARN_MINMAX 0
76#define UVC_WARN_PROBE_DEF 1
77
78extern unsigned int uvc_gadget_trace_param;
79
80#define uvc_trace(flag, msg...) \
81 do { \
82 if (uvc_gadget_trace_param & flag) \
83 printk(KERN_DEBUG "uvcvideo: " msg); \
84 } while (0)
85
86#define uvc_warn_once(dev, warn, msg...) \
87 do { \
88 if (!test_and_set_bit(warn, &dev->warnings)) \
89 printk(KERN_INFO "uvcvideo: " msg); \
90 } while (0)
91
92#define uvc_printk(level, msg...) \
93 printk(level "uvcvideo: " msg)
94
95/* ------------------------------------------------------------------------
96 * Driver specific constants
97 */
98
99#define DRIVER_VERSION "0.1.0"
100#define DRIVER_VERSION_NUMBER KERNEL_VERSION(0, 1, 0)
101
102#define UVC_NUM_REQUESTS 4
103#define UVC_MAX_REQUEST_SIZE 64
104#define UVC_MAX_EVENTS 4
105
106/* ------------------------------------------------------------------------
107 * Structures
108 */
109
110struct uvc_video
111{
112 struct usb_ep *ep;
113
114 /* Frame parameters */
115 u8 bpp;
116 u32 fcc;
117 unsigned int width;
118 unsigned int height;
119 unsigned int imagesize;
120
121 /* Requests */
122 unsigned int req_size;
123 struct usb_request *req[UVC_NUM_REQUESTS];
124 __u8 *req_buffer[UVC_NUM_REQUESTS];
125 struct list_head req_free;
126 spinlock_t req_lock;
127
128 void (*encode) (struct usb_request *req, struct uvc_video *video,
129 struct uvc_buffer *buf);
130
131 /* Context data used by the completion handler */
132 __u32 payload_size;
133 __u32 max_payload_size;
134
135 struct uvc_video_queue queue;
136 unsigned int fid;
137};
138
139enum uvc_state
140{
141 UVC_STATE_DISCONNECTED,
142 UVC_STATE_CONNECTED,
143 UVC_STATE_STREAMING,
144};
145
146struct uvc_device
147{
148 struct video_device *vdev;
149 struct v4l2_device v4l2_dev;
150 enum uvc_state state;
151 struct usb_function func;
152 struct uvc_video video;
153
154 /* Descriptors */
155 struct {
156 const struct uvc_descriptor_header * const *fs_control;
157 const struct uvc_descriptor_header * const *ss_control;
158 const struct uvc_descriptor_header * const *fs_streaming;
159 const struct uvc_descriptor_header * const *hs_streaming;
160 const struct uvc_descriptor_header * const *ss_streaming;
161 } desc;
162
163 unsigned int control_intf;
164 struct usb_ep *control_ep;
165 struct usb_request *control_req;
166 void *control_buf;
167
168 unsigned int streaming_intf;
169
170 /* Events */
171 unsigned int event_length;
172 unsigned int event_setup_out : 1;
173};
174
175static inline struct uvc_device *to_uvc(struct usb_function *f)
176{
177 return container_of(f, struct uvc_device, func);
178}
179
180struct uvc_file_handle
181{
182 struct v4l2_fh vfh;
183 struct uvc_video *device;
184};
185
186#define to_uvc_file_handle(handle) \
187 container_of(handle, struct uvc_file_handle, vfh)
188
189/* ------------------------------------------------------------------------
190 * Functions
191 */
192
193extern void uvc_function_setup_continue(struct uvc_device *uvc);
194extern void uvc_endpoint_stream(struct uvc_device *dev);
195
196extern void uvc_function_connect(struct uvc_device *uvc);
197extern void uvc_function_disconnect(struct uvc_device *uvc);
198
199#endif /* __KERNEL__ */
200
201#endif /* _UVC_GADGET_H_ */
202