uvcvideo.h 20 KB

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