blob: bc78c606c12bbe5726f077832c3dff1897918134 [file] [log] [blame]
Laurent Pinchartcdda4792010-05-02 20:57:41 +02001/*
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.
Laurent Pinchartcdda4792010-05-02 20:57:41 +020011 */
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 unsigned int 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/* ------------------------------------------------------------------------
Laurent Pinchartcdda4792010-05-02 20:57:41 +020050 * 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>
Jesper Juhl255f5e02011-08-01 23:33:29 +020058#include <linux/version.h>
Laurent Pinchartcdda4792010-05-02 20:57:41 +020059#include <media/v4l2-fh.h>
60
61#include "uvc_queue.h"
62
63#define UVC_TRACE_PROBE (1 << 0)
64#define UVC_TRACE_DESCR (1 << 1)
65#define UVC_TRACE_CONTROL (1 << 2)
66#define UVC_TRACE_FORMAT (1 << 3)
67#define UVC_TRACE_CAPTURE (1 << 4)
68#define UVC_TRACE_CALLS (1 << 5)
69#define UVC_TRACE_IOCTL (1 << 6)
70#define UVC_TRACE_FRAME (1 << 7)
71#define UVC_TRACE_SUSPEND (1 << 8)
72#define UVC_TRACE_STATUS (1 << 9)
73
74#define UVC_WARN_MINMAX 0
75#define UVC_WARN_PROBE_DEF 1
76
Laurent Pinchart5d9955f2010-07-10 16:13:05 -030077extern unsigned int uvc_gadget_trace_param;
Laurent Pinchartcdda4792010-05-02 20:57:41 +020078
79#define uvc_trace(flag, msg...) \
80 do { \
Laurent Pinchart5d9955f2010-07-10 16:13:05 -030081 if (uvc_gadget_trace_param & flag) \
Laurent Pinchartcdda4792010-05-02 20:57:41 +020082 printk(KERN_DEBUG "uvcvideo: " msg); \
83 } while (0)
84
85#define uvc_warn_once(dev, warn, msg...) \
86 do { \
87 if (!test_and_set_bit(warn, &dev->warnings)) \
88 printk(KERN_INFO "uvcvideo: " msg); \
89 } while (0)
90
91#define uvc_printk(level, msg...) \
92 printk(level "uvcvideo: " msg)
93
94/* ------------------------------------------------------------------------
95 * Driver specific constants
96 */
97
98#define DRIVER_VERSION "0.1.0"
99#define DRIVER_VERSION_NUMBER KERNEL_VERSION(0, 1, 0)
100
101#define DMA_ADDR_INVALID (~(dma_addr_t)0)
102
103#define UVC_NUM_REQUESTS 4
104#define UVC_MAX_REQUEST_SIZE 64
105#define UVC_MAX_EVENTS 4
106
Laurent Pinchartcdda4792010-05-02 20:57:41 +0200107/* ------------------------------------------------------------------------
108 * Structures
109 */
110
111struct uvc_video
112{
113 struct usb_ep *ep;
114
115 /* Frame parameters */
116 u8 bpp;
117 u32 fcc;
118 unsigned int width;
119 unsigned int height;
120 unsigned int imagesize;
121
122 /* Requests */
123 unsigned int req_size;
124 struct usb_request *req[UVC_NUM_REQUESTS];
125 __u8 *req_buffer[UVC_NUM_REQUESTS];
126 struct list_head req_free;
127 spinlock_t req_lock;
128
129 void (*encode) (struct usb_request *req, struct uvc_video *video,
130 struct uvc_buffer *buf);
131
132 /* Context data used by the completion handler */
133 __u32 payload_size;
134 __u32 max_payload_size;
135
136 struct uvc_video_queue queue;
137 unsigned int fid;
138};
139
140enum uvc_state
141{
142 UVC_STATE_DISCONNECTED,
143 UVC_STATE_CONNECTED,
144 UVC_STATE_STREAMING,
145};
146
147struct uvc_device
148{
149 struct video_device *vdev;
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 *control;
157 const struct uvc_descriptor_header * const *fs_streaming;
158 const struct uvc_descriptor_header * const *hs_streaming;
159 } desc;
160
161 unsigned int control_intf;
162 struct usb_ep *control_ep;
163 struct usb_request *control_req;
164 void *control_buf;
165
166 unsigned int streaming_intf;
167
168 /* Events */
169 unsigned int event_length;
170 unsigned int event_setup_out : 1;
171};
172
173static inline struct uvc_device *to_uvc(struct usb_function *f)
174{
175 return container_of(f, struct uvc_device, func);
176}
177
178struct uvc_file_handle
179{
180 struct v4l2_fh vfh;
181 struct uvc_video *device;
182};
183
184#define to_uvc_file_handle(handle) \
185 container_of(handle, struct uvc_file_handle, vfh)
186
Laurent Pinchartcdda4792010-05-02 20:57:41 +0200187/* ------------------------------------------------------------------------
188 * Functions
189 */
190
Laurent Pinchartcdda4792010-05-02 20:57:41 +0200191extern void uvc_endpoint_stream(struct uvc_device *dev);
192
193extern void uvc_function_connect(struct uvc_device *uvc);
194extern void uvc_function_disconnect(struct uvc_device *uvc);
195
196#endif /* __KERNEL__ */
197
198#endif /* _UVC_GADGET_H_ */
199