uvcvideo.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756
  1. #ifndef _USB_VIDEO_H_
  2. #define _USB_VIDEO_H_
  3. #ifndef __KERNEL__
  4. #error "The uvcvideo.h header is deprecated, use linux/uvcvideo.h instead."
  5. #endif /* __KERNEL__ */
  6. #include <linux/kernel.h>
  7. #include <linux/poll.h>
  8. #include <linux/usb.h>
  9. #include <linux/usb/video.h>
  10. #include <linux/uvcvideo.h>
  11. #include <linux/videodev2.h>
  12. #include <media/media-device.h>
  13. #include <media/v4l2-device.h>
  14. #include <media/v4l2-event.h>
  15. #include <media/v4l2-fh.h>
  16. #include <media/videobuf2-v4l2.h>
  17. /* --------------------------------------------------------------------------
  18. * UVC constants
  19. */
  20. #define UVC_TERM_INPUT 0x0000
  21. #define UVC_TERM_OUTPUT 0x8000
  22. #define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000)
  23. #define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
  24. #define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
  25. #define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
  26. #define UVC_ENTITY_IS_ITERM(entity) \
  27. (UVC_ENTITY_IS_TERM(entity) && \
  28. ((entity)->type & 0x8000) == UVC_TERM_INPUT)
  29. #define UVC_ENTITY_IS_OTERM(entity) \
  30. (UVC_ENTITY_IS_TERM(entity) && \
  31. ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
  32. /* ------------------------------------------------------------------------
  33. * GUIDs
  34. */
  35. #define UVC_GUID_UVC_CAMERA \
  36. {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  37. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
  38. #define UVC_GUID_UVC_OUTPUT \
  39. {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  40. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
  41. #define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
  42. {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  43. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
  44. #define UVC_GUID_UVC_PROCESSING \
  45. {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  46. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
  47. #define UVC_GUID_UVC_SELECTOR \
  48. {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  49. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
  50. #define UVC_GUID_FORMAT_MJPEG \
  51. { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
  52. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  53. #define UVC_GUID_FORMAT_YUY2 \
  54. { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
  55. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  56. #define UVC_GUID_FORMAT_YUY2_ISIGHT \
  57. { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
  58. 0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
  59. #define UVC_GUID_FORMAT_NV12 \
  60. { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
  61. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  62. #define UVC_GUID_FORMAT_YV12 \
  63. { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
  64. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  65. #define UVC_GUID_FORMAT_I420 \
  66. { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
  67. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  68. #define UVC_GUID_FORMAT_UYVY \
  69. { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
  70. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  71. #define UVC_GUID_FORMAT_Y800 \
  72. { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
  73. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  74. #define UVC_GUID_FORMAT_Y8 \
  75. { 'Y', '8', ' ', ' ', 0x00, 0x00, 0x10, 0x00, \
  76. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  77. #define UVC_GUID_FORMAT_Y10 \
  78. { 'Y', '1', '0', ' ', 0x00, 0x00, 0x10, 0x00, \
  79. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  80. #define UVC_GUID_FORMAT_Y12 \
  81. { 'Y', '1', '2', ' ', 0x00, 0x00, 0x10, 0x00, \
  82. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  83. #define UVC_GUID_FORMAT_Y16 \
  84. { 'Y', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
  85. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  86. #define UVC_GUID_FORMAT_BY8 \
  87. { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
  88. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  89. #define UVC_GUID_FORMAT_BA81 \
  90. { 'B', 'A', '8', '1', 0x00, 0x00, 0x10, 0x00, \
  91. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  92. #define UVC_GUID_FORMAT_GBRG \
  93. { 'G', 'B', 'R', 'G', 0x00, 0x00, 0x10, 0x00, \
  94. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  95. #define UVC_GUID_FORMAT_GRBG \
  96. { 'G', 'R', 'B', 'G', 0x00, 0x00, 0x10, 0x00, \
  97. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  98. #define UVC_GUID_FORMAT_RGGB \
  99. { 'R', 'G', 'G', 'B', 0x00, 0x00, 0x10, 0x00, \
  100. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  101. #define UVC_GUID_FORMAT_RGBP \
  102. { 'R', 'G', 'B', 'P', 0x00, 0x00, 0x10, 0x00, \
  103. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  104. #define UVC_GUID_FORMAT_BGR3 \
  105. { 0x7d, 0xeb, 0x36, 0xe4, 0x4f, 0x52, 0xce, 0x11, \
  106. 0x9f, 0x53, 0x00, 0x20, 0xaf, 0x0b, 0xa7, 0x70}
  107. #define UVC_GUID_FORMAT_M420 \
  108. { 'M', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
  109. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  110. #define UVC_GUID_FORMAT_H264 \
  111. { 'H', '2', '6', '4', 0x00, 0x00, 0x10, 0x00, \
  112. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  113. #define UVC_GUID_FORMAT_Y8I \
  114. { 'Y', '8', 'I', ' ', 0x00, 0x00, 0x10, 0x00, \
  115. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  116. #define UVC_GUID_FORMAT_Y12I \
  117. { 'Y', '1', '2', 'I', 0x00, 0x00, 0x10, 0x00, \
  118. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  119. #define UVC_GUID_FORMAT_Z16 \
  120. { 'Z', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
  121. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  122. #define UVC_GUID_FORMAT_RW10 \
  123. { 'R', 'W', '1', '0', 0x00, 0x00, 0x10, 0x00, \
  124. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  125. /* ------------------------------------------------------------------------
  126. * Driver specific constants.
  127. */
  128. #define DRIVER_VERSION "1.1.1"
  129. /* Number of isochronous URBs. */
  130. #define UVC_URBS 5
  131. /* Maximum number of packets per URB. */
  132. #define UVC_MAX_PACKETS 32
  133. /* Maximum status buffer size in bytes of interrupt URB. */
  134. #define UVC_MAX_STATUS_SIZE 16
  135. #define UVC_CTRL_CONTROL_TIMEOUT 300
  136. #define UVC_CTRL_STREAMING_TIMEOUT 5000
  137. /* Maximum allowed number of control mappings per device */
  138. #define UVC_MAX_CONTROL_MAPPINGS 1024
  139. #define UVC_MAX_CONTROL_MENU_ENTRIES 32
  140. /* Devices quirks */
  141. #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
  142. #define UVC_QUIRK_PROBE_MINMAX 0x00000002
  143. #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
  144. #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
  145. #define UVC_QUIRK_STREAM_NO_FID 0x00000010
  146. #define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
  147. #define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
  148. #define UVC_QUIRK_PROBE_DEF 0x00000100
  149. #define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200
  150. #define UVC_QUIRK_RESTORE_CTRLS_ON_INIT 0x00000400
  151. #define UVC_QUIRK_FORCE_Y8 0x00000800
  152. /* Format flags */
  153. #define UVC_FMT_FLAG_COMPRESSED 0x00000001
  154. #define UVC_FMT_FLAG_STREAM 0x00000002
  155. /* ------------------------------------------------------------------------
  156. * Structures.
  157. */
  158. struct uvc_device;
  159. /* TODO: Put the most frequently accessed fields at the beginning of
  160. * structures to maximize cache efficiency.
  161. */
  162. struct uvc_control_info {
  163. struct list_head mappings;
  164. __u8 entity[16];
  165. __u8 index; /* Bit index in bmControls */
  166. __u8 selector;
  167. __u16 size;
  168. __u32 flags;
  169. };
  170. struct uvc_control_mapping {
  171. struct list_head list;
  172. struct list_head ev_subs;
  173. __u32 id;
  174. __u8 name[32];
  175. __u8 entity[16];
  176. __u8 selector;
  177. __u8 size;
  178. __u8 offset;
  179. enum v4l2_ctrl_type v4l2_type;
  180. __u32 data_type;
  181. struct uvc_menu_info *menu_info;
  182. __u32 menu_count;
  183. __u32 master_id;
  184. __s32 master_manual;
  185. __u32 slave_ids[2];
  186. __s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
  187. const __u8 *data);
  188. void (*set) (struct uvc_control_mapping *mapping, __s32 value,
  189. __u8 *data);
  190. };
  191. struct uvc_control {
  192. struct uvc_entity *entity;
  193. struct uvc_control_info info;
  194. __u8 index; /* Used to match the uvc_control entry with a
  195. uvc_control_info. */
  196. __u8 dirty:1,
  197. loaded:1,
  198. modified:1,
  199. cached:1,
  200. initialized:1;
  201. __u8 *uvc_data;
  202. };
  203. struct uvc_format_desc {
  204. char *name;
  205. __u8 guid[16];
  206. __u32 fcc;
  207. };
  208. /* The term 'entity' refers to both UVC units and UVC terminals.
  209. *
  210. * The type field is either the terminal type (wTerminalType in the terminal
  211. * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
  212. * As the bDescriptorSubtype field is one byte long, the type value will
  213. * always have a null MSB for units. All terminal types defined by the UVC
  214. * specification have a non-null MSB, so it is safe to use the MSB to
  215. * differentiate between units and terminals as long as the descriptor parsing
  216. * code makes sure terminal types have a non-null MSB.
  217. *
  218. * For terminals, the type's most significant bit stores the terminal
  219. * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
  220. * always be accessed with the UVC_ENTITY_* macros and never directly.
  221. */
  222. #define UVC_ENTITY_FLAG_DEFAULT (1 << 0)
  223. struct uvc_entity {
  224. struct list_head list; /* Entity as part of a UVC device. */
  225. struct list_head chain; /* Entity as part of a video device
  226. * chain. */
  227. unsigned int flags;
  228. __u8 id;
  229. __u16 type;
  230. char name[64];
  231. /* Media controller-related fields. */
  232. struct video_device *vdev;
  233. struct v4l2_subdev subdev;
  234. unsigned int num_pads;
  235. unsigned int num_links;
  236. struct media_pad *pads;
  237. union {
  238. struct {
  239. __u16 wObjectiveFocalLengthMin;
  240. __u16 wObjectiveFocalLengthMax;
  241. __u16 wOcularFocalLength;
  242. __u8 bControlSize;
  243. __u8 *bmControls;
  244. } camera;
  245. struct {
  246. __u8 bControlSize;
  247. __u8 *bmControls;
  248. __u8 bTransportModeSize;
  249. __u8 *bmTransportModes;
  250. } media;
  251. struct {
  252. } output;
  253. struct {
  254. __u16 wMaxMultiplier;
  255. __u8 bControlSize;
  256. __u8 *bmControls;
  257. __u8 bmVideoStandards;
  258. } processing;
  259. struct {
  260. } selector;
  261. struct {
  262. __u8 guidExtensionCode[16];
  263. __u8 bNumControls;
  264. __u8 bControlSize;
  265. __u8 *bmControls;
  266. __u8 *bmControlsType;
  267. } extension;
  268. };
  269. __u8 bNrInPins;
  270. __u8 *baSourceID;
  271. unsigned int ncontrols;
  272. struct uvc_control *controls;
  273. };
  274. struct uvc_frame {
  275. __u8 bFrameIndex;
  276. __u8 bmCapabilities;
  277. __u16 wWidth;
  278. __u16 wHeight;
  279. __u32 dwMinBitRate;
  280. __u32 dwMaxBitRate;
  281. __u32 dwMaxVideoFrameBufferSize;
  282. __u8 bFrameIntervalType;
  283. __u32 dwDefaultFrameInterval;
  284. __u32 *dwFrameInterval;
  285. };
  286. struct uvc_format {
  287. __u8 type;
  288. __u8 index;
  289. __u8 bpp;
  290. __u8 colorspace;
  291. __u32 fcc;
  292. __u32 flags;
  293. char name[32];
  294. unsigned int nframes;
  295. struct uvc_frame *frame;
  296. };
  297. struct uvc_streaming_header {
  298. __u8 bNumFormats;
  299. __u8 bEndpointAddress;
  300. __u8 bTerminalLink;
  301. __u8 bControlSize;
  302. __u8 *bmaControls;
  303. /* The following fields are used by input headers only. */
  304. __u8 bmInfo;
  305. __u8 bStillCaptureMethod;
  306. __u8 bTriggerSupport;
  307. __u8 bTriggerUsage;
  308. };
  309. enum uvc_buffer_state {
  310. UVC_BUF_STATE_IDLE = 0,
  311. UVC_BUF_STATE_QUEUED = 1,
  312. UVC_BUF_STATE_ACTIVE = 2,
  313. UVC_BUF_STATE_READY = 3,
  314. UVC_BUF_STATE_DONE = 4,
  315. UVC_BUF_STATE_ERROR = 5,
  316. };
  317. struct uvc_buffer {
  318. struct vb2_v4l2_buffer buf;
  319. struct list_head queue;
  320. enum uvc_buffer_state state;
  321. unsigned int error;
  322. void *mem;
  323. unsigned int length;
  324. unsigned int bytesused;
  325. u32 pts;
  326. };
  327. #define UVC_QUEUE_DISCONNECTED (1 << 0)
  328. #define UVC_QUEUE_DROP_CORRUPTED (1 << 1)
  329. struct uvc_video_queue {
  330. struct vb2_queue queue;
  331. struct mutex mutex; /* Protects queue */
  332. unsigned int flags;
  333. unsigned int buf_used;
  334. spinlock_t irqlock; /* Protects irqqueue */
  335. struct list_head irqqueue;
  336. };
  337. struct uvc_video_chain {
  338. struct uvc_device *dev;
  339. struct list_head list;
  340. struct list_head entities; /* All entities */
  341. struct uvc_entity *processing; /* Processing unit */
  342. struct uvc_entity *selector; /* Selector unit */
  343. struct mutex ctrl_mutex; /* Protects ctrl.info */
  344. struct v4l2_prio_state prio; /* V4L2 priority state */
  345. u32 caps; /* V4L2 chain-wide caps */
  346. };
  347. struct uvc_stats_frame {
  348. unsigned int size; /* Number of bytes captured */
  349. unsigned int first_data; /* Index of the first non-empty packet */
  350. unsigned int nb_packets; /* Number of packets */
  351. unsigned int nb_empty; /* Number of empty packets */
  352. unsigned int nb_invalid; /* Number of packets with an invalid header */
  353. unsigned int nb_errors; /* Number of packets with the error bit set */
  354. unsigned int nb_pts; /* Number of packets with a PTS timestamp */
  355. unsigned int nb_pts_diffs; /* Number of PTS differences inside a frame */
  356. unsigned int last_pts_diff; /* Index of the last PTS difference */
  357. bool has_initial_pts; /* Whether the first non-empty packet has a PTS */
  358. bool has_early_pts; /* Whether a PTS is present before the first non-empty packet */
  359. u32 pts; /* PTS of the last packet */
  360. unsigned int nb_scr; /* Number of packets with a SCR timestamp */
  361. unsigned int nb_scr_diffs; /* Number of SCR.STC differences inside a frame */
  362. u16 scr_sof; /* SCR.SOF of the last packet */
  363. u32 scr_stc; /* SCR.STC of the last packet */
  364. };
  365. struct uvc_stats_stream {
  366. struct timespec start_ts; /* Stream start timestamp */
  367. struct timespec stop_ts; /* Stream stop timestamp */
  368. unsigned int nb_frames; /* Number of frames */
  369. unsigned int nb_packets; /* Number of packets */
  370. unsigned int nb_empty; /* Number of empty packets */
  371. unsigned int nb_invalid; /* Number of packets with an invalid header */
  372. unsigned int nb_errors; /* Number of packets with the error bit set */
  373. unsigned int nb_pts_constant; /* Number of frames with constant PTS */
  374. unsigned int nb_pts_early; /* Number of frames with early PTS */
  375. unsigned int nb_pts_initial; /* Number of frames with initial PTS */
  376. unsigned int nb_scr_count_ok; /* Number of frames with at least one SCR per non empty packet */
  377. unsigned int nb_scr_diffs_ok; /* Number of frames with varying SCR.STC */
  378. unsigned int scr_sof_count; /* STC.SOF counter accumulated since stream start */
  379. unsigned int scr_sof; /* STC.SOF of the last packet */
  380. unsigned int min_sof; /* Minimum STC.SOF value */
  381. unsigned int max_sof; /* Maximum STC.SOF value */
  382. };
  383. struct uvc_streaming {
  384. struct list_head list;
  385. struct uvc_device *dev;
  386. struct video_device vdev;
  387. struct uvc_video_chain *chain;
  388. atomic_t active;
  389. struct usb_interface *intf;
  390. int intfnum;
  391. __u16 maxpsize;
  392. struct uvc_streaming_header header;
  393. enum v4l2_buf_type type;
  394. unsigned int nformats;
  395. struct uvc_format *format;
  396. struct uvc_streaming_control ctrl;
  397. struct uvc_format *def_format;
  398. struct uvc_format *cur_format;
  399. struct uvc_frame *cur_frame;
  400. /* Protect access to ctrl, cur_format, cur_frame and hardware video
  401. * probe control.
  402. */
  403. struct mutex mutex;
  404. /* Buffers queue. */
  405. unsigned int frozen : 1;
  406. struct uvc_video_queue queue;
  407. void (*decode) (struct urb *urb, struct uvc_streaming *video,
  408. struct uvc_buffer *buf);
  409. /* Context data used by the bulk completion handler. */
  410. struct {
  411. __u8 header[256];
  412. unsigned int header_size;
  413. int skip_payload;
  414. __u32 payload_size;
  415. __u32 max_payload_size;
  416. } bulk;
  417. struct urb *urb[UVC_URBS];
  418. char *urb_buffer[UVC_URBS];
  419. dma_addr_t urb_dma[UVC_URBS];
  420. unsigned int urb_size;
  421. __u32 sequence;
  422. __u8 last_fid;
  423. /* debugfs */
  424. struct dentry *debugfs_dir;
  425. struct {
  426. struct uvc_stats_frame frame;
  427. struct uvc_stats_stream stream;
  428. } stats;
  429. /* Timestamps support. */
  430. struct uvc_clock {
  431. struct uvc_clock_sample {
  432. u32 dev_stc;
  433. u16 dev_sof;
  434. struct timespec host_ts;
  435. u16 host_sof;
  436. } *samples;
  437. unsigned int head;
  438. unsigned int count;
  439. unsigned int size;
  440. u16 last_sof;
  441. u16 sof_offset;
  442. spinlock_t lock;
  443. } clock;
  444. };
  445. struct uvc_device {
  446. struct usb_device *udev;
  447. struct usb_interface *intf;
  448. unsigned long warnings;
  449. __u32 quirks;
  450. int intfnum;
  451. char name[32];
  452. struct mutex lock; /* Protects users */
  453. unsigned int users;
  454. atomic_t nmappings;
  455. /* Video control interface */
  456. #ifdef CONFIG_MEDIA_CONTROLLER
  457. struct media_device mdev;
  458. #endif
  459. struct v4l2_device vdev;
  460. __u16 uvc_version;
  461. __u32 clock_frequency;
  462. struct list_head entities;
  463. struct list_head chains;
  464. /* Video Streaming interfaces */
  465. struct list_head streams;
  466. atomic_t nstreams;
  467. /* Status Interrupt Endpoint */
  468. struct usb_host_endpoint *int_ep;
  469. struct urb *int_urb;
  470. __u8 *status;
  471. struct input_dev *input;
  472. char input_phys[64];
  473. };
  474. enum uvc_handle_state {
  475. UVC_HANDLE_PASSIVE = 0,
  476. UVC_HANDLE_ACTIVE = 1,
  477. };
  478. struct uvc_fh {
  479. struct v4l2_fh vfh;
  480. struct uvc_video_chain *chain;
  481. struct uvc_streaming *stream;
  482. enum uvc_handle_state state;
  483. };
  484. struct uvc_driver {
  485. struct usb_driver driver;
  486. };
  487. /* ------------------------------------------------------------------------
  488. * Debugging, printing and logging
  489. */
  490. #define UVC_TRACE_PROBE (1 << 0)
  491. #define UVC_TRACE_DESCR (1 << 1)
  492. #define UVC_TRACE_CONTROL (1 << 2)
  493. #define UVC_TRACE_FORMAT (1 << 3)
  494. #define UVC_TRACE_CAPTURE (1 << 4)
  495. #define UVC_TRACE_CALLS (1 << 5)
  496. #define UVC_TRACE_FRAME (1 << 7)
  497. #define UVC_TRACE_SUSPEND (1 << 8)
  498. #define UVC_TRACE_STATUS (1 << 9)
  499. #define UVC_TRACE_VIDEO (1 << 10)
  500. #define UVC_TRACE_STATS (1 << 11)
  501. #define UVC_TRACE_CLOCK (1 << 12)
  502. #define UVC_WARN_MINMAX 0
  503. #define UVC_WARN_PROBE_DEF 1
  504. #define UVC_WARN_XU_GET_RES 2
  505. extern unsigned int uvc_clock_param;
  506. extern unsigned int uvc_no_drop_param;
  507. extern unsigned int uvc_trace_param;
  508. extern unsigned int uvc_timeout_param;
  509. extern unsigned int uvc_hw_timestamps_param;
  510. #define uvc_trace(flag, msg...) \
  511. do { \
  512. if (uvc_trace_param & flag) \
  513. printk(KERN_DEBUG "uvcvideo: " msg); \
  514. } while (0)
  515. #define uvc_warn_once(dev, warn, msg...) \
  516. do { \
  517. if (!test_and_set_bit(warn, &dev->warnings)) \
  518. printk(KERN_INFO "uvcvideo: " msg); \
  519. } while (0)
  520. #define uvc_printk(level, msg...) \
  521. printk(level "uvcvideo: " msg)
  522. /* --------------------------------------------------------------------------
  523. * Internal functions.
  524. */
  525. /* Core driver */
  526. extern struct uvc_driver uvc_driver;
  527. extern struct uvc_entity *uvc_entity_by_id(struct uvc_device *dev, int id);
  528. /* Video buffers queue management. */
  529. extern int uvc_queue_init(struct uvc_video_queue *queue,
  530. enum v4l2_buf_type type, int drop_corrupted);
  531. extern void uvc_queue_release(struct uvc_video_queue *queue);
  532. extern int uvc_request_buffers(struct uvc_video_queue *queue,
  533. struct v4l2_requestbuffers *rb);
  534. extern int uvc_query_buffer(struct uvc_video_queue *queue,
  535. struct v4l2_buffer *v4l2_buf);
  536. extern int uvc_create_buffers(struct uvc_video_queue *queue,
  537. struct v4l2_create_buffers *v4l2_cb);
  538. extern int uvc_queue_buffer(struct uvc_video_queue *queue,
  539. struct v4l2_buffer *v4l2_buf);
  540. extern int uvc_export_buffer(struct uvc_video_queue *queue,
  541. struct v4l2_exportbuffer *exp);
  542. extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
  543. struct v4l2_buffer *v4l2_buf, int nonblocking);
  544. extern int uvc_queue_streamon(struct uvc_video_queue *queue,
  545. enum v4l2_buf_type type);
  546. extern int uvc_queue_streamoff(struct uvc_video_queue *queue,
  547. enum v4l2_buf_type type);
  548. extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
  549. extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
  550. struct uvc_buffer *buf);
  551. extern int uvc_queue_mmap(struct uvc_video_queue *queue,
  552. struct vm_area_struct *vma);
  553. extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
  554. struct file *file, poll_table *wait);
  555. #ifndef CONFIG_MMU
  556. extern unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
  557. unsigned long pgoff);
  558. #endif
  559. extern int uvc_queue_allocated(struct uvc_video_queue *queue);
  560. static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
  561. {
  562. return vb2_is_streaming(&queue->queue);
  563. }
  564. /* V4L2 interface */
  565. extern const struct v4l2_ioctl_ops uvc_ioctl_ops;
  566. extern const struct v4l2_file_operations uvc_fops;
  567. /* Media controller */
  568. extern int uvc_mc_register_entities(struct uvc_video_chain *chain);
  569. extern void uvc_mc_cleanup_entity(struct uvc_entity *entity);
  570. /* Video */
  571. extern int uvc_video_init(struct uvc_streaming *stream);
  572. extern int uvc_video_suspend(struct uvc_streaming *stream);
  573. extern int uvc_video_resume(struct uvc_streaming *stream, int reset);
  574. extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
  575. extern int uvc_probe_video(struct uvc_streaming *stream,
  576. struct uvc_streaming_control *probe);
  577. extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
  578. __u8 intfnum, __u8 cs, void *data, __u16 size);
  579. void uvc_video_clock_update(struct uvc_streaming *stream,
  580. struct vb2_v4l2_buffer *vbuf,
  581. struct uvc_buffer *buf);
  582. /* Status */
  583. extern int uvc_status_init(struct uvc_device *dev);
  584. extern void uvc_status_cleanup(struct uvc_device *dev);
  585. extern int uvc_status_start(struct uvc_device *dev, gfp_t flags);
  586. extern void uvc_status_stop(struct uvc_device *dev);
  587. /* Controls */
  588. extern const struct v4l2_subscribed_event_ops uvc_ctrl_sub_ev_ops;
  589. extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
  590. struct v4l2_queryctrl *v4l2_ctrl);
  591. extern int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
  592. struct v4l2_querymenu *query_menu);
  593. extern int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
  594. const struct uvc_control_mapping *mapping);
  595. extern int uvc_ctrl_init_device(struct uvc_device *dev);
  596. extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
  597. extern int uvc_ctrl_restore_values(struct uvc_device *dev);
  598. extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
  599. extern int __uvc_ctrl_commit(struct uvc_fh *handle, int rollback,
  600. const struct v4l2_ext_control *xctrls,
  601. unsigned int xctrls_count);
  602. static inline int uvc_ctrl_commit(struct uvc_fh *handle,
  603. const struct v4l2_ext_control *xctrls,
  604. unsigned int xctrls_count)
  605. {
  606. return __uvc_ctrl_commit(handle, 0, xctrls, xctrls_count);
  607. }
  608. static inline int uvc_ctrl_rollback(struct uvc_fh *handle)
  609. {
  610. return __uvc_ctrl_commit(handle, 1, NULL, 0);
  611. }
  612. extern int uvc_ctrl_get(struct uvc_video_chain *chain,
  613. struct v4l2_ext_control *xctrl);
  614. extern int uvc_ctrl_set(struct uvc_video_chain *chain,
  615. struct v4l2_ext_control *xctrl);
  616. extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
  617. struct uvc_xu_control_query *xqry);
  618. /* Utility functions */
  619. extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
  620. unsigned int n_terms, unsigned int threshold);
  621. extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
  622. uint32_t denominator);
  623. extern struct usb_host_endpoint *uvc_find_endpoint(
  624. struct usb_host_interface *alts, __u8 epaddr);
  625. /* Quirks support */
  626. void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
  627. struct uvc_buffer *buf);
  628. /* debugfs and statistics */
  629. int uvc_debugfs_init(void);
  630. void uvc_debugfs_cleanup(void);
  631. int uvc_debugfs_init_stream(struct uvc_streaming *stream);
  632. void uvc_debugfs_cleanup_stream(struct uvc_streaming *stream);
  633. size_t uvc_video_stats_dump(struct uvc_streaming *stream, char *buf,
  634. size_t size);
  635. #endif