uvcvideo.h 21 KB

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