uvcvideo.h 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684
  1. #ifndef _USB_VIDEO_H_
  2. #define _USB_VIDEO_H_
  3. #include <linux/kernel.h>
  4. #include <linux/videodev2.h>
  5. #ifndef __KERNEL__
  6. /*
  7. * This header provides binary compatibility with applications using the private
  8. * uvcvideo API. This API is deprecated and will be removed in 2.6.42.
  9. * Applications should be recompiled against the public linux/uvcvideo.h header.
  10. */
  11. #warn "The uvcvideo.h header is deprecated, use linux/uvcvideo.h instead."
  12. /*
  13. * Dynamic controls
  14. */
  15. /* Data types for UVC control data */
  16. #define UVC_CTRL_DATA_TYPE_RAW 0
  17. #define UVC_CTRL_DATA_TYPE_SIGNED 1
  18. #define UVC_CTRL_DATA_TYPE_UNSIGNED 2
  19. #define UVC_CTRL_DATA_TYPE_BOOLEAN 3
  20. #define UVC_CTRL_DATA_TYPE_ENUM 4
  21. #define UVC_CTRL_DATA_TYPE_BITMASK 5
  22. /* Control flags */
  23. #define UVC_CONTROL_SET_CUR (1 << 0)
  24. #define UVC_CONTROL_GET_CUR (1 << 1)
  25. #define UVC_CONTROL_GET_MIN (1 << 2)
  26. #define UVC_CONTROL_GET_MAX (1 << 3)
  27. #define UVC_CONTROL_GET_RES (1 << 4)
  28. #define UVC_CONTROL_GET_DEF (1 << 5)
  29. #define UVC_CONTROL_RESTORE (1 << 6)
  30. #define UVC_CONTROL_AUTO_UPDATE (1 << 7)
  31. #define UVC_CONTROL_GET_RANGE (UVC_CONTROL_GET_CUR | UVC_CONTROL_GET_MIN | \
  32. UVC_CONTROL_GET_MAX | UVC_CONTROL_GET_RES | \
  33. UVC_CONTROL_GET_DEF)
  34. struct uvc_menu_info {
  35. __u32 value;
  36. __u8 name[32];
  37. };
  38. struct uvc_xu_control_mapping {
  39. __u32 id;
  40. __u8 name[32];
  41. __u8 entity[16];
  42. __u8 selector;
  43. __u8 size;
  44. __u8 offset;
  45. __u32 v4l2_type;
  46. __u32 data_type;
  47. struct uvc_menu_info __user *menu_info;
  48. __u32 menu_count;
  49. __u32 reserved[4];
  50. };
  51. #endif
  52. struct uvc_xu_control_info {
  53. __u8 entity[16];
  54. __u8 index;
  55. __u8 selector;
  56. __u16 size;
  57. __u32 flags;
  58. };
  59. struct uvc_xu_control_mapping_old {
  60. __u8 reserved[64];
  61. };
  62. struct uvc_xu_control {
  63. __u8 unit;
  64. __u8 selector;
  65. __u16 size;
  66. __u8 __user *data;
  67. };
  68. #ifndef __KERNEL__
  69. #define UVCIOC_CTRL_ADD _IOW('U', 1, struct uvc_xu_control_info)
  70. #define UVCIOC_CTRL_MAP_OLD _IOWR('U', 2, struct uvc_xu_control_mapping_old)
  71. #define UVCIOC_CTRL_MAP _IOWR('U', 2, struct uvc_xu_control_mapping)
  72. #define UVCIOC_CTRL_GET _IOWR('U', 3, struct uvc_xu_control)
  73. #define UVCIOC_CTRL_SET _IOW('U', 4, struct uvc_xu_control)
  74. #else
  75. #define __UVCIOC_CTRL_ADD _IOW('U', 1, struct uvc_xu_control_info)
  76. #define __UVCIOC_CTRL_MAP_OLD _IOWR('U', 2, struct uvc_xu_control_mapping_old)
  77. #define __UVCIOC_CTRL_MAP _IOWR('U', 2, struct uvc_xu_control_mapping)
  78. #define __UVCIOC_CTRL_GET _IOWR('U', 3, struct uvc_xu_control)
  79. #define __UVCIOC_CTRL_SET _IOW('U', 4, struct uvc_xu_control)
  80. #endif
  81. #ifdef __KERNEL__
  82. #include <linux/poll.h>
  83. #include <linux/usb/video.h>
  84. #include <linux/uvcvideo.h>
  85. /* --------------------------------------------------------------------------
  86. * UVC constants
  87. */
  88. #define UVC_TERM_INPUT 0x0000
  89. #define UVC_TERM_OUTPUT 0x8000
  90. #define UVC_TERM_DIRECTION(term) ((term)->type & 0x8000)
  91. #define UVC_ENTITY_TYPE(entity) ((entity)->type & 0x7fff)
  92. #define UVC_ENTITY_IS_UNIT(entity) (((entity)->type & 0xff00) == 0)
  93. #define UVC_ENTITY_IS_TERM(entity) (((entity)->type & 0xff00) != 0)
  94. #define UVC_ENTITY_IS_ITERM(entity) \
  95. (UVC_ENTITY_IS_TERM(entity) && \
  96. ((entity)->type & 0x8000) == UVC_TERM_INPUT)
  97. #define UVC_ENTITY_IS_OTERM(entity) \
  98. (UVC_ENTITY_IS_TERM(entity) && \
  99. ((entity)->type & 0x8000) == UVC_TERM_OUTPUT)
  100. /* ------------------------------------------------------------------------
  101. * GUIDs
  102. */
  103. #define UVC_GUID_UVC_CAMERA \
  104. {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  105. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}
  106. #define UVC_GUID_UVC_OUTPUT \
  107. {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  108. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02}
  109. #define UVC_GUID_UVC_MEDIA_TRANSPORT_INPUT \
  110. {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  111. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03}
  112. #define UVC_GUID_UVC_PROCESSING \
  113. {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  114. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x01}
  115. #define UVC_GUID_UVC_SELECTOR \
  116. {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
  117. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x02}
  118. #define UVC_GUID_FORMAT_MJPEG \
  119. { 'M', 'J', 'P', 'G', 0x00, 0x00, 0x10, 0x00, \
  120. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  121. #define UVC_GUID_FORMAT_YUY2 \
  122. { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
  123. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  124. #define UVC_GUID_FORMAT_YUY2_ISIGHT \
  125. { 'Y', 'U', 'Y', '2', 0x00, 0x00, 0x10, 0x00, \
  126. 0x80, 0x00, 0x00, 0x00, 0x00, 0x38, 0x9b, 0x71}
  127. #define UVC_GUID_FORMAT_NV12 \
  128. { 'N', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
  129. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  130. #define UVC_GUID_FORMAT_YV12 \
  131. { 'Y', 'V', '1', '2', 0x00, 0x00, 0x10, 0x00, \
  132. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  133. #define UVC_GUID_FORMAT_I420 \
  134. { 'I', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
  135. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  136. #define UVC_GUID_FORMAT_UYVY \
  137. { 'U', 'Y', 'V', 'Y', 0x00, 0x00, 0x10, 0x00, \
  138. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  139. #define UVC_GUID_FORMAT_Y800 \
  140. { 'Y', '8', '0', '0', 0x00, 0x00, 0x10, 0x00, \
  141. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  142. #define UVC_GUID_FORMAT_Y16 \
  143. { 'Y', '1', '6', ' ', 0x00, 0x00, 0x10, 0x00, \
  144. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  145. #define UVC_GUID_FORMAT_BY8 \
  146. { 'B', 'Y', '8', ' ', 0x00, 0x00, 0x10, 0x00, \
  147. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  148. #define UVC_GUID_FORMAT_RGBP \
  149. { 'R', 'G', 'B', 'P', 0x00, 0x00, 0x10, 0x00, \
  150. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  151. #define UVC_GUID_FORMAT_M420 \
  152. { 'M', '4', '2', '0', 0x00, 0x00, 0x10, 0x00, \
  153. 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71}
  154. /* ------------------------------------------------------------------------
  155. * Driver specific constants.
  156. */
  157. #define DRIVER_VERSION_NUMBER KERNEL_VERSION(1, 1, 0)
  158. #define DRIVER_VERSION "v1.1.0"
  159. /* Number of isochronous URBs. */
  160. #define UVC_URBS 5
  161. /* Maximum number of packets per URB. */
  162. #define UVC_MAX_PACKETS 32
  163. /* Maximum number of video buffers. */
  164. #define UVC_MAX_VIDEO_BUFFERS 32
  165. /* Maximum status buffer size in bytes of interrupt URB. */
  166. #define UVC_MAX_STATUS_SIZE 16
  167. #define UVC_CTRL_CONTROL_TIMEOUT 300
  168. #define UVC_CTRL_STREAMING_TIMEOUT 5000
  169. /* Maximum allowed number of control mappings per device */
  170. #define UVC_MAX_CONTROL_MAPPINGS 1024
  171. /* Devices quirks */
  172. #define UVC_QUIRK_STATUS_INTERVAL 0x00000001
  173. #define UVC_QUIRK_PROBE_MINMAX 0x00000002
  174. #define UVC_QUIRK_PROBE_EXTRAFIELDS 0x00000004
  175. #define UVC_QUIRK_BUILTIN_ISIGHT 0x00000008
  176. #define UVC_QUIRK_STREAM_NO_FID 0x00000010
  177. #define UVC_QUIRK_IGNORE_SELECTOR_UNIT 0x00000020
  178. #define UVC_QUIRK_FIX_BANDWIDTH 0x00000080
  179. #define UVC_QUIRK_PROBE_DEF 0x00000100
  180. #define UVC_QUIRK_RESTRICT_FRAME_RATE 0x00000200
  181. /* Format flags */
  182. #define UVC_FMT_FLAG_COMPRESSED 0x00000001
  183. #define UVC_FMT_FLAG_STREAM 0x00000002
  184. /* ------------------------------------------------------------------------
  185. * Structures.
  186. */
  187. struct uvc_device;
  188. /* TODO: Put the most frequently accessed fields at the beginning of
  189. * structures to maximize cache efficiency.
  190. */
  191. struct uvc_control_info {
  192. struct list_head mappings;
  193. __u8 entity[16];
  194. __u8 index; /* Bit index in bmControls */
  195. __u8 selector;
  196. __u16 size;
  197. __u32 flags;
  198. };
  199. struct uvc_control_mapping {
  200. struct list_head list;
  201. struct uvc_control_info *ctrl;
  202. __u32 id;
  203. __u8 name[32];
  204. __u8 entity[16];
  205. __u8 selector;
  206. __u8 size;
  207. __u8 offset;
  208. enum v4l2_ctrl_type v4l2_type;
  209. __u32 data_type;
  210. struct uvc_menu_info *menu_info;
  211. __u32 menu_count;
  212. __s32 (*get) (struct uvc_control_mapping *mapping, __u8 query,
  213. const __u8 *data);
  214. void (*set) (struct uvc_control_mapping *mapping, __s32 value,
  215. __u8 *data);
  216. };
  217. struct uvc_control {
  218. struct uvc_entity *entity;
  219. struct uvc_control_info info;
  220. __u8 index; /* Used to match the uvc_control entry with a
  221. uvc_control_info. */
  222. __u8 dirty:1,
  223. loaded:1,
  224. modified:1,
  225. cached:1,
  226. initialized:1;
  227. __u8 *uvc_data;
  228. };
  229. struct uvc_format_desc {
  230. char *name;
  231. __u8 guid[16];
  232. __u32 fcc;
  233. };
  234. /* The term 'entity' refers to both UVC units and UVC terminals.
  235. *
  236. * The type field is either the terminal type (wTerminalType in the terminal
  237. * descriptor), or the unit type (bDescriptorSubtype in the unit descriptor).
  238. * As the bDescriptorSubtype field is one byte long, the type value will
  239. * always have a null MSB for units. All terminal types defined by the UVC
  240. * specification have a non-null MSB, so it is safe to use the MSB to
  241. * differentiate between units and terminals as long as the descriptor parsing
  242. * code makes sure terminal types have a non-null MSB.
  243. *
  244. * For terminals, the type's most significant bit stores the terminal
  245. * direction (either UVC_TERM_INPUT or UVC_TERM_OUTPUT). The type field should
  246. * always be accessed with the UVC_ENTITY_* macros and never directly.
  247. */
  248. struct uvc_entity {
  249. struct list_head list; /* Entity as part of a UVC device. */
  250. struct list_head chain; /* Entity as part of a video device
  251. * chain. */
  252. __u8 id;
  253. __u16 type;
  254. char name[64];
  255. union {
  256. struct {
  257. __u16 wObjectiveFocalLengthMin;
  258. __u16 wObjectiveFocalLengthMax;
  259. __u16 wOcularFocalLength;
  260. __u8 bControlSize;
  261. __u8 *bmControls;
  262. } camera;
  263. struct {
  264. __u8 bControlSize;
  265. __u8 *bmControls;
  266. __u8 bTransportModeSize;
  267. __u8 *bmTransportModes;
  268. } media;
  269. struct {
  270. } output;
  271. struct {
  272. __u16 wMaxMultiplier;
  273. __u8 bControlSize;
  274. __u8 *bmControls;
  275. __u8 bmVideoStandards;
  276. } processing;
  277. struct {
  278. } selector;
  279. struct {
  280. __u8 guidExtensionCode[16];
  281. __u8 bNumControls;
  282. __u8 bControlSize;
  283. __u8 *bmControls;
  284. __u8 *bmControlsType;
  285. } extension;
  286. };
  287. __u8 bNrInPins;
  288. __u8 *baSourceID;
  289. unsigned int ncontrols;
  290. struct uvc_control *controls;
  291. };
  292. struct uvc_frame {
  293. __u8 bFrameIndex;
  294. __u8 bmCapabilities;
  295. __u16 wWidth;
  296. __u16 wHeight;
  297. __u32 dwMinBitRate;
  298. __u32 dwMaxBitRate;
  299. __u32 dwMaxVideoFrameBufferSize;
  300. __u8 bFrameIntervalType;
  301. __u32 dwDefaultFrameInterval;
  302. __u32 *dwFrameInterval;
  303. };
  304. struct uvc_format {
  305. __u8 type;
  306. __u8 index;
  307. __u8 bpp;
  308. __u8 colorspace;
  309. __u32 fcc;
  310. __u32 flags;
  311. char name[32];
  312. unsigned int nframes;
  313. struct uvc_frame *frame;
  314. };
  315. struct uvc_streaming_header {
  316. __u8 bNumFormats;
  317. __u8 bEndpointAddress;
  318. __u8 bTerminalLink;
  319. __u8 bControlSize;
  320. __u8 *bmaControls;
  321. /* The following fields are used by input headers only. */
  322. __u8 bmInfo;
  323. __u8 bStillCaptureMethod;
  324. __u8 bTriggerSupport;
  325. __u8 bTriggerUsage;
  326. };
  327. enum uvc_buffer_state {
  328. UVC_BUF_STATE_IDLE = 0,
  329. UVC_BUF_STATE_QUEUED = 1,
  330. UVC_BUF_STATE_ACTIVE = 2,
  331. UVC_BUF_STATE_READY = 3,
  332. UVC_BUF_STATE_DONE = 4,
  333. UVC_BUF_STATE_ERROR = 5,
  334. };
  335. struct uvc_buffer {
  336. unsigned long vma_use_count;
  337. struct list_head stream;
  338. /* Touched by interrupt handler. */
  339. struct v4l2_buffer buf;
  340. struct list_head queue;
  341. wait_queue_head_t wait;
  342. enum uvc_buffer_state state;
  343. unsigned int error;
  344. };
  345. #define UVC_QUEUE_STREAMING (1 << 0)
  346. #define UVC_QUEUE_DISCONNECTED (1 << 1)
  347. #define UVC_QUEUE_DROP_CORRUPTED (1 << 2)
  348. struct uvc_video_queue {
  349. enum v4l2_buf_type type;
  350. void *mem;
  351. unsigned int flags;
  352. unsigned int count;
  353. unsigned int buf_size;
  354. unsigned int buf_used;
  355. struct uvc_buffer buffer[UVC_MAX_VIDEO_BUFFERS];
  356. struct mutex mutex; /* protects buffers and mainqueue */
  357. spinlock_t irqlock; /* protects irqqueue */
  358. struct list_head mainqueue;
  359. struct list_head irqqueue;
  360. };
  361. struct uvc_video_chain {
  362. struct uvc_device *dev;
  363. struct list_head list;
  364. struct list_head entities; /* All entities */
  365. struct uvc_entity *processing; /* Processing unit */
  366. struct uvc_entity *selector; /* Selector unit */
  367. struct mutex ctrl_mutex; /* Protects ctrl.info */
  368. };
  369. struct uvc_streaming {
  370. struct list_head list;
  371. struct uvc_device *dev;
  372. struct video_device *vdev;
  373. struct uvc_video_chain *chain;
  374. atomic_t active;
  375. struct usb_interface *intf;
  376. int intfnum;
  377. __u16 maxpsize;
  378. struct uvc_streaming_header header;
  379. enum v4l2_buf_type type;
  380. unsigned int nformats;
  381. struct uvc_format *format;
  382. struct uvc_streaming_control ctrl;
  383. struct uvc_format *cur_format;
  384. struct uvc_frame *cur_frame;
  385. /* Protect access to ctrl, cur_format, cur_frame and hardware video
  386. * probe control.
  387. */
  388. struct mutex mutex;
  389. unsigned int frozen : 1;
  390. struct uvc_video_queue queue;
  391. void (*decode) (struct urb *urb, struct uvc_streaming *video,
  392. struct uvc_buffer *buf);
  393. /* Context data used by the bulk completion handler. */
  394. struct {
  395. __u8 header[256];
  396. unsigned int header_size;
  397. int skip_payload;
  398. __u32 payload_size;
  399. __u32 max_payload_size;
  400. } bulk;
  401. struct urb *urb[UVC_URBS];
  402. char *urb_buffer[UVC_URBS];
  403. dma_addr_t urb_dma[UVC_URBS];
  404. unsigned int urb_size;
  405. __u32 sequence;
  406. __u8 last_fid;
  407. };
  408. enum uvc_device_state {
  409. UVC_DEV_DISCONNECTED = 1,
  410. };
  411. struct uvc_device {
  412. struct usb_device *udev;
  413. struct usb_interface *intf;
  414. unsigned long warnings;
  415. __u32 quirks;
  416. int intfnum;
  417. char name[32];
  418. enum uvc_device_state state;
  419. atomic_t users;
  420. atomic_t nmappings;
  421. /* Video control interface */
  422. __u16 uvc_version;
  423. __u32 clock_frequency;
  424. struct list_head entities;
  425. struct list_head chains;
  426. /* Video Streaming interfaces */
  427. struct list_head streams;
  428. atomic_t nstreams;
  429. /* Status Interrupt Endpoint */
  430. struct usb_host_endpoint *int_ep;
  431. struct urb *int_urb;
  432. __u8 *status;
  433. struct input_dev *input;
  434. char input_phys[64];
  435. };
  436. enum uvc_handle_state {
  437. UVC_HANDLE_PASSIVE = 0,
  438. UVC_HANDLE_ACTIVE = 1,
  439. };
  440. struct uvc_fh {
  441. struct uvc_video_chain *chain;
  442. struct uvc_streaming *stream;
  443. enum uvc_handle_state state;
  444. };
  445. struct uvc_driver {
  446. struct usb_driver driver;
  447. };
  448. /* ------------------------------------------------------------------------
  449. * Debugging, printing and logging
  450. */
  451. #define UVC_TRACE_PROBE (1 << 0)
  452. #define UVC_TRACE_DESCR (1 << 1)
  453. #define UVC_TRACE_CONTROL (1 << 2)
  454. #define UVC_TRACE_FORMAT (1 << 3)
  455. #define UVC_TRACE_CAPTURE (1 << 4)
  456. #define UVC_TRACE_CALLS (1 << 5)
  457. #define UVC_TRACE_IOCTL (1 << 6)
  458. #define UVC_TRACE_FRAME (1 << 7)
  459. #define UVC_TRACE_SUSPEND (1 << 8)
  460. #define UVC_TRACE_STATUS (1 << 9)
  461. #define UVC_TRACE_VIDEO (1 << 10)
  462. #define UVC_WARN_MINMAX 0
  463. #define UVC_WARN_PROBE_DEF 1
  464. extern unsigned int uvc_clock_param;
  465. extern unsigned int uvc_no_drop_param;
  466. extern unsigned int uvc_trace_param;
  467. extern unsigned int uvc_timeout_param;
  468. #define uvc_trace(flag, msg...) \
  469. do { \
  470. if (uvc_trace_param & flag) \
  471. printk(KERN_DEBUG "uvcvideo: " msg); \
  472. } while (0)
  473. #define uvc_warn_once(dev, warn, msg...) \
  474. do { \
  475. if (!test_and_set_bit(warn, &dev->warnings)) \
  476. printk(KERN_INFO "uvcvideo: " msg); \
  477. } while (0)
  478. #define uvc_printk(level, msg...) \
  479. printk(level "uvcvideo: " msg)
  480. /* --------------------------------------------------------------------------
  481. * Internal functions.
  482. */
  483. /* Core driver */
  484. extern struct uvc_driver uvc_driver;
  485. /* Video buffers queue management. */
  486. extern void uvc_queue_init(struct uvc_video_queue *queue,
  487. enum v4l2_buf_type type, int drop_corrupted);
  488. extern int uvc_alloc_buffers(struct uvc_video_queue *queue,
  489. unsigned int nbuffers, unsigned int buflength);
  490. extern int uvc_free_buffers(struct uvc_video_queue *queue);
  491. extern int uvc_query_buffer(struct uvc_video_queue *queue,
  492. struct v4l2_buffer *v4l2_buf);
  493. extern int uvc_queue_buffer(struct uvc_video_queue *queue,
  494. struct v4l2_buffer *v4l2_buf);
  495. extern int uvc_dequeue_buffer(struct uvc_video_queue *queue,
  496. struct v4l2_buffer *v4l2_buf, int nonblocking);
  497. extern int uvc_queue_enable(struct uvc_video_queue *queue, int enable);
  498. extern void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect);
  499. extern struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue,
  500. struct uvc_buffer *buf);
  501. extern int uvc_queue_mmap(struct uvc_video_queue *queue,
  502. struct vm_area_struct *vma);
  503. extern unsigned int uvc_queue_poll(struct uvc_video_queue *queue,
  504. struct file *file, poll_table *wait);
  505. #ifndef CONFIG_MMU
  506. extern unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue,
  507. unsigned long pgoff);
  508. #endif
  509. extern int uvc_queue_allocated(struct uvc_video_queue *queue);
  510. static inline int uvc_queue_streaming(struct uvc_video_queue *queue)
  511. {
  512. return queue->flags & UVC_QUEUE_STREAMING;
  513. }
  514. /* V4L2 interface */
  515. extern const struct v4l2_file_operations uvc_fops;
  516. /* Video */
  517. extern int uvc_video_init(struct uvc_streaming *stream);
  518. extern int uvc_video_suspend(struct uvc_streaming *stream);
  519. extern int uvc_video_resume(struct uvc_streaming *stream);
  520. extern int uvc_video_enable(struct uvc_streaming *stream, int enable);
  521. extern int uvc_probe_video(struct uvc_streaming *stream,
  522. struct uvc_streaming_control *probe);
  523. extern int uvc_commit_video(struct uvc_streaming *stream,
  524. struct uvc_streaming_control *ctrl);
  525. extern int uvc_query_ctrl(struct uvc_device *dev, __u8 query, __u8 unit,
  526. __u8 intfnum, __u8 cs, void *data, __u16 size);
  527. /* Status */
  528. extern int uvc_status_init(struct uvc_device *dev);
  529. extern void uvc_status_cleanup(struct uvc_device *dev);
  530. extern int uvc_status_start(struct uvc_device *dev);
  531. extern void uvc_status_stop(struct uvc_device *dev);
  532. extern int uvc_status_suspend(struct uvc_device *dev);
  533. extern int uvc_status_resume(struct uvc_device *dev);
  534. /* Controls */
  535. extern int uvc_query_v4l2_ctrl(struct uvc_video_chain *chain,
  536. struct v4l2_queryctrl *v4l2_ctrl);
  537. extern int uvc_query_v4l2_menu(struct uvc_video_chain *chain,
  538. struct v4l2_querymenu *query_menu);
  539. extern int uvc_ctrl_add_mapping(struct uvc_video_chain *chain,
  540. const struct uvc_control_mapping *mapping);
  541. extern int uvc_ctrl_init_device(struct uvc_device *dev);
  542. extern void uvc_ctrl_cleanup_device(struct uvc_device *dev);
  543. extern int uvc_ctrl_resume_device(struct uvc_device *dev);
  544. extern int uvc_ctrl_begin(struct uvc_video_chain *chain);
  545. extern int __uvc_ctrl_commit(struct uvc_video_chain *chain, int rollback);
  546. static inline int uvc_ctrl_commit(struct uvc_video_chain *chain)
  547. {
  548. return __uvc_ctrl_commit(chain, 0);
  549. }
  550. static inline int uvc_ctrl_rollback(struct uvc_video_chain *chain)
  551. {
  552. return __uvc_ctrl_commit(chain, 1);
  553. }
  554. extern int uvc_ctrl_get(struct uvc_video_chain *chain,
  555. struct v4l2_ext_control *xctrl);
  556. extern int uvc_ctrl_set(struct uvc_video_chain *chain,
  557. struct v4l2_ext_control *xctrl);
  558. extern int uvc_xu_ctrl_query(struct uvc_video_chain *chain,
  559. struct uvc_xu_control_query *xqry);
  560. /* Utility functions */
  561. extern void uvc_simplify_fraction(uint32_t *numerator, uint32_t *denominator,
  562. unsigned int n_terms, unsigned int threshold);
  563. extern uint32_t uvc_fraction_to_interval(uint32_t numerator,
  564. uint32_t denominator);
  565. extern struct usb_host_endpoint *uvc_find_endpoint(
  566. struct usb_host_interface *alts, __u8 epaddr);
  567. /* Quirks support */
  568. void uvc_video_decode_isight(struct urb *urb, struct uvc_streaming *stream,
  569. struct uvc_buffer *buf);
  570. #endif /* __KERNEL__ */
  571. #endif