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 18 #include <media/v4l2-device.h> 19 #include <media/v4l2-dev.h> 20 #include <media/v4l2-fh.h> 21 22 #include "uvc_queue.h" 23 24 struct usb_ep; 25 struct usb_request; 26 struct uvc_descriptor_header; 27 struct uvc_device; 28 29 /* ------------------------------------------------------------------------ 30 * Debugging, printing and logging 31 */ 32 33 #define UVC_TRACE_PROBE (1 << 0) 34 #define UVC_TRACE_DESCR (1 << 1) 35 #define UVC_TRACE_CONTROL (1 << 2) 36 #define UVC_TRACE_FORMAT (1 << 3) 37 #define UVC_TRACE_CAPTURE (1 << 4) 38 #define UVC_TRACE_CALLS (1 << 5) 39 #define UVC_TRACE_IOCTL (1 << 6) 40 #define UVC_TRACE_FRAME (1 << 7) 41 #define UVC_TRACE_SUSPEND (1 << 8) 42 #define UVC_TRACE_STATUS (1 << 9) 43 44 #define UVC_WARN_MINMAX 0 45 #define UVC_WARN_PROBE_DEF 1 46 47 extern unsigned int uvc_gadget_trace_param; 48 49 #define uvc_trace(flag, msg...) \ 50 do { \ 51 if (uvc_gadget_trace_param & flag) \ 52 printk(KERN_DEBUG "uvcvideo: " msg); \ 53 } while (0) 54 55 #define uvcg_dbg(f, fmt, args...) \ 56 dev_dbg(&(f)->config->cdev->gadget->dev, "%s: " fmt, (f)->name, ##args) 57 #define uvcg_info(f, fmt, args...) \ 58 dev_info(&(f)->config->cdev->gadget->dev, "%s: " fmt, (f)->name, ##args) 59 #define uvcg_warn(f, fmt, args...) \ 60 dev_warn(&(f)->config->cdev->gadget->dev, "%s: " fmt, (f)->name, ##args) 61 #define uvcg_err(f, fmt, args...) \ 62 dev_err(&(f)->config->cdev->gadget->dev, "%s: " fmt, (f)->name, ##args) 63 64 /* ------------------------------------------------------------------------ 65 * Driver specific constants 66 */ 67 68 #define UVC_MAX_REQUEST_SIZE 64 69 #define UVC_MAX_EVENTS 4 70 71 #define UVCG_REQUEST_HEADER_LEN 12 72 73 /* ------------------------------------------------------------------------ 74 * Structures 75 */ 76 struct uvc_request { 77 struct usb_request *req; 78 u8 *req_buffer; 79 struct uvc_video *video; 80 struct sg_table sgt; 81 u8 header[UVCG_REQUEST_HEADER_LEN]; 82 struct uvc_buffer *last_buf; 83 }; 84 85 struct 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 120 enum uvc_state { 121 UVC_STATE_DISCONNECTED, 122 UVC_STATE_CONNECTED, 123 UVC_STATE_STREAMING, 124 }; 125 126 struct 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 134 /* Descriptors */ 135 struct { 136 const struct uvc_descriptor_header * const *fs_control; 137 const struct uvc_descriptor_header * const *ss_control; 138 const struct uvc_descriptor_header * const *fs_streaming; 139 const struct uvc_descriptor_header * const *hs_streaming; 140 const struct uvc_descriptor_header * const *ss_streaming; 141 } desc; 142 143 unsigned int control_intf; 144 struct usb_ep *control_ep; 145 struct usb_request *control_req; 146 void *control_buf; 147 148 unsigned int streaming_intf; 149 150 /* Events */ 151 unsigned int event_length; 152 unsigned int event_setup_out : 1; 153 }; 154 155 static inline struct uvc_device *to_uvc(struct usb_function *f) 156 { 157 return container_of(f, struct uvc_device, func); 158 } 159 160 struct uvc_file_handle { 161 struct v4l2_fh vfh; 162 struct uvc_video *device; 163 bool is_uvc_app_handle; 164 }; 165 166 #define to_uvc_file_handle(handle) \ 167 container_of(handle, struct uvc_file_handle, vfh) 168 169 /* ------------------------------------------------------------------------ 170 * Functions 171 */ 172 173 extern void uvc_function_setup_continue(struct uvc_device *uvc); 174 extern void uvc_endpoint_stream(struct uvc_device *dev); 175 176 extern void uvc_function_connect(struct uvc_device *uvc); 177 extern void uvc_function_disconnect(struct uvc_device *uvc); 178 179 #endif /* _UVC_GADGET_H_ */ 180