Commit | Line | Data |
---|---|---|
c0efd232 LP |
1 | /* |
2 | * uvc_queue.c -- USB Video Class driver - Buffers management | |
3 | * | |
11fc5baf LP |
4 | * Copyright (C) 2005-2010 |
5 | * Laurent Pinchart (laurent.pinchart@ideasonboard.com) | |
c0efd232 LP |
6 | * |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | */ | |
13 | ||
6998b6fb | 14 | #include <linux/atomic.h> |
c0efd232 | 15 | #include <linux/kernel.h> |
27ac792c | 16 | #include <linux/mm.h> |
c0efd232 LP |
17 | #include <linux/list.h> |
18 | #include <linux/module.h> | |
19 | #include <linux/usb.h> | |
20 | #include <linux/videodev2.h> | |
21 | #include <linux/vmalloc.h> | |
22 | #include <linux/wait.h> | |
6998b6fb | 23 | #include <media/videobuf2-vmalloc.h> |
c0efd232 LP |
24 | |
25 | #include "uvcvideo.h" | |
26 | ||
27 | /* ------------------------------------------------------------------------ | |
28 | * Video buffers queue management. | |
29 | * | |
30 | * Video queues is initialized by uvc_queue_init(). The function performs | |
31 | * basic initialization of the uvc_video_queue struct and never fails. | |
32 | * | |
6998b6fb LP |
33 | * Video buffers are managed by videobuf2. The driver uses a mutex to protect |
34 | * the videobuf2 queue operations by serializing calls to videobuf2 and a | |
35 | * spinlock to protect the IRQ queue that holds the buffers to be processed by | |
36 | * the driver. | |
c0efd232 LP |
37 | */ |
38 | ||
6998b6fb LP |
39 | /* ----------------------------------------------------------------------------- |
40 | * videobuf2 queue operations | |
8e815e17 | 41 | */ |
6998b6fb LP |
42 | |
43 | static int uvc_queue_setup(struct vb2_queue *vq, const struct v4l2_format *fmt, | |
44 | unsigned int *nbuffers, unsigned int *nplanes, | |
45 | unsigned int sizes[], void *alloc_ctxs[]) | |
8e815e17 | 46 | { |
6998b6fb LP |
47 | struct uvc_video_queue *queue = vb2_get_drv_priv(vq); |
48 | struct uvc_streaming *stream = | |
49 | container_of(queue, struct uvc_streaming, queue); | |
8e815e17 | 50 | |
bddb9d0e LP |
51 | /* Make sure the image size is large enough. */ |
52 | if (fmt && fmt->fmt.pix.sizeimage < stream->ctrl.dwMaxVideoFrameSize) | |
53 | return -EINVAL; | |
54 | ||
6998b6fb LP |
55 | *nplanes = 1; |
56 | ||
bddb9d0e LP |
57 | sizes[0] = fmt ? fmt->fmt.pix.sizeimage |
58 | : stream->ctrl.dwMaxVideoFrameSize; | |
8e815e17 LP |
59 | |
60 | return 0; | |
61 | } | |
62 | ||
6998b6fb | 63 | static int uvc_buffer_prepare(struct vb2_buffer *vb) |
8e815e17 | 64 | { |
6998b6fb LP |
65 | struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue); |
66 | struct uvc_buffer *buf = container_of(vb, struct uvc_buffer, buf); | |
8e815e17 | 67 | |
6998b6fb LP |
68 | if (vb->v4l2_buf.type == V4L2_BUF_TYPE_VIDEO_OUTPUT && |
69 | vb2_get_plane_payload(vb, 0) > vb2_plane_size(vb, 0)) { | |
70 | uvc_trace(UVC_TRACE_CAPTURE, "[E] Bytes used out of bounds.\n"); | |
71 | return -EINVAL; | |
72 | } | |
c0efd232 | 73 | |
6998b6fb LP |
74 | if (unlikely(queue->flags & UVC_QUEUE_DISCONNECTED)) |
75 | return -ENODEV; | |
c0efd232 | 76 | |
6998b6fb LP |
77 | buf->state = UVC_BUF_STATE_QUEUED; |
78 | buf->error = 0; | |
79 | buf->mem = vb2_plane_vaddr(vb, 0); | |
80 | buf->length = vb2_plane_size(vb, 0); | |
81 | if (vb->v4l2_buf.type == V4L2_BUF_TYPE_VIDEO_CAPTURE) | |
82 | buf->bytesused = 0; | |
83 | else | |
84 | buf->bytesused = vb2_get_plane_payload(vb, 0); | |
c0efd232 | 85 | |
6998b6fb LP |
86 | return 0; |
87 | } | |
c0efd232 | 88 | |
6998b6fb LP |
89 | static void uvc_buffer_queue(struct vb2_buffer *vb) |
90 | { | |
91 | struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue); | |
92 | struct uvc_buffer *buf = container_of(vb, struct uvc_buffer, buf); | |
93 | unsigned long flags; | |
c0efd232 | 94 | |
6998b6fb LP |
95 | spin_lock_irqsave(&queue->irqlock, flags); |
96 | if (likely(!(queue->flags & UVC_QUEUE_DISCONNECTED))) { | |
97 | list_add_tail(&buf->queue, &queue->irqqueue); | |
98 | } else { | |
99 | /* If the device is disconnected return the buffer to userspace | |
100 | * directly. The next QBUF call will fail with -ENODEV. | |
101 | */ | |
102 | buf->state = UVC_BUF_STATE_ERROR; | |
103 | vb2_buffer_done(&buf->buf, VB2_BUF_STATE_ERROR); | |
c0efd232 LP |
104 | } |
105 | ||
6998b6fb LP |
106 | spin_unlock_irqrestore(&queue->irqlock, flags); |
107 | } | |
c0efd232 | 108 | |
06470642 | 109 | static void uvc_buffer_finish(struct vb2_buffer *vb) |
66847ef0 LP |
110 | { |
111 | struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue); | |
112 | struct uvc_streaming *stream = | |
113 | container_of(queue, struct uvc_streaming, queue); | |
114 | struct uvc_buffer *buf = container_of(vb, struct uvc_buffer, buf); | |
115 | ||
9c0863b1 HV |
116 | if (vb->state == VB2_BUF_STATE_DONE) |
117 | uvc_video_clock_update(stream, &vb->v4l2_buf, buf); | |
66847ef0 LP |
118 | } |
119 | ||
05c79d0d LP |
120 | static void uvc_wait_prepare(struct vb2_queue *vq) |
121 | { | |
122 | struct uvc_video_queue *queue = vb2_get_drv_priv(vq); | |
123 | ||
124 | mutex_unlock(&queue->mutex); | |
125 | } | |
126 | ||
127 | static void uvc_wait_finish(struct vb2_queue *vq) | |
128 | { | |
129 | struct uvc_video_queue *queue = vb2_get_drv_priv(vq); | |
130 | ||
131 | mutex_lock(&queue->mutex); | |
132 | } | |
133 | ||
6998b6fb LP |
134 | static struct vb2_ops uvc_queue_qops = { |
135 | .queue_setup = uvc_queue_setup, | |
136 | .buf_prepare = uvc_buffer_prepare, | |
137 | .buf_queue = uvc_buffer_queue, | |
66847ef0 | 138 | .buf_finish = uvc_buffer_finish, |
05c79d0d LP |
139 | .wait_prepare = uvc_wait_prepare, |
140 | .wait_finish = uvc_wait_finish, | |
6998b6fb | 141 | }; |
c0efd232 | 142 | |
5712661d | 143 | int uvc_queue_init(struct uvc_video_queue *queue, enum v4l2_buf_type type, |
6998b6fb LP |
144 | int drop_corrupted) |
145 | { | |
5712661d EG |
146 | int ret; |
147 | ||
6998b6fb | 148 | queue->queue.type = type; |
ccc4c539 | 149 | queue->queue.io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF; |
6998b6fb LP |
150 | queue->queue.drv_priv = queue; |
151 | queue->queue.buf_struct_size = sizeof(struct uvc_buffer); | |
152 | queue->queue.ops = &uvc_queue_qops; | |
153 | queue->queue.mem_ops = &vb2_vmalloc_memops; | |
c767492a SA |
154 | queue->queue.timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC |
155 | | V4L2_BUF_FLAG_TSTAMP_SRC_SOE; | |
5712661d EG |
156 | ret = vb2_queue_init(&queue->queue); |
157 | if (ret) | |
158 | return ret; | |
c0efd232 | 159 | |
6998b6fb LP |
160 | mutex_init(&queue->mutex); |
161 | spin_lock_init(&queue->irqlock); | |
162 | INIT_LIST_HEAD(&queue->irqqueue); | |
163 | queue->flags = drop_corrupted ? UVC_QUEUE_DROP_CORRUPTED : 0; | |
5712661d EG |
164 | |
165 | return 0; | |
c0efd232 LP |
166 | } |
167 | ||
6998b6fb LP |
168 | /* ----------------------------------------------------------------------------- |
169 | * V4L2 queue operations | |
23ff6043 | 170 | */ |
6998b6fb LP |
171 | |
172 | int uvc_alloc_buffers(struct uvc_video_queue *queue, | |
173 | struct v4l2_requestbuffers *rb) | |
23ff6043 | 174 | { |
6998b6fb | 175 | int ret; |
23ff6043 LP |
176 | |
177 | mutex_lock(&queue->mutex); | |
6998b6fb | 178 | ret = vb2_reqbufs(&queue->queue, rb); |
23ff6043 LP |
179 | mutex_unlock(&queue->mutex); |
180 | ||
6998b6fb | 181 | return ret ? ret : rb->count; |
23ff6043 LP |
182 | } |
183 | ||
6998b6fb | 184 | void uvc_free_buffers(struct uvc_video_queue *queue) |
c0efd232 | 185 | { |
6998b6fb LP |
186 | mutex_lock(&queue->mutex); |
187 | vb2_queue_release(&queue->queue); | |
188 | mutex_unlock(&queue->mutex); | |
c0efd232 LP |
189 | } |
190 | ||
6998b6fb | 191 | int uvc_query_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf) |
c0efd232 | 192 | { |
6998b6fb | 193 | int ret; |
c0efd232 LP |
194 | |
195 | mutex_lock(&queue->mutex); | |
6998b6fb | 196 | ret = vb2_querybuf(&queue->queue, buf); |
2c2d264b | 197 | mutex_unlock(&queue->mutex); |
6998b6fb | 198 | |
2c2d264b | 199 | return ret; |
c0efd232 LP |
200 | } |
201 | ||
6e9179e2 PZ |
202 | int uvc_create_buffers(struct uvc_video_queue *queue, |
203 | struct v4l2_create_buffers *cb) | |
204 | { | |
205 | int ret; | |
206 | ||
207 | mutex_lock(&queue->mutex); | |
208 | ret = vb2_create_bufs(&queue->queue, cb); | |
209 | mutex_unlock(&queue->mutex); | |
210 | ||
211 | return ret; | |
212 | } | |
213 | ||
6998b6fb | 214 | int uvc_queue_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf) |
c0efd232 | 215 | { |
6998b6fb | 216 | int ret; |
c0efd232 LP |
217 | |
218 | mutex_lock(&queue->mutex); | |
6998b6fb | 219 | ret = vb2_qbuf(&queue->queue, buf); |
c0efd232 | 220 | mutex_unlock(&queue->mutex); |
c0efd232 | 221 | |
6998b6fb | 222 | return ret; |
c0efd232 LP |
223 | } |
224 | ||
6998b6fb LP |
225 | int uvc_dequeue_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf, |
226 | int nonblocking) | |
c0efd232 | 227 | { |
6998b6fb | 228 | int ret; |
c0efd232 LP |
229 | |
230 | mutex_lock(&queue->mutex); | |
6998b6fb | 231 | ret = vb2_dqbuf(&queue->queue, buf, nonblocking); |
c0efd232 | 232 | mutex_unlock(&queue->mutex); |
c0efd232 | 233 | |
6998b6fb | 234 | return ret; |
4aa27597 LP |
235 | } |
236 | ||
4aa27597 LP |
237 | int uvc_queue_mmap(struct uvc_video_queue *queue, struct vm_area_struct *vma) |
238 | { | |
6998b6fb | 239 | int ret; |
4aa27597 LP |
240 | |
241 | mutex_lock(&queue->mutex); | |
6998b6fb LP |
242 | ret = vb2_mmap(&queue->queue, vma); |
243 | mutex_unlock(&queue->mutex); | |
4aa27597 | 244 | |
6998b6fb LP |
245 | return ret; |
246 | } | |
4aa27597 | 247 | |
4742c82e LP |
248 | #ifndef CONFIG_MMU |
249 | unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue, | |
250 | unsigned long pgoff) | |
251 | { | |
252 | unsigned long ret; | |
253 | ||
254 | mutex_lock(&queue->mutex); | |
255 | ret = vb2_get_unmapped_area(&queue->queue, 0, 0, pgoff, 0); | |
256 | mutex_unlock(&queue->mutex); | |
257 | return ret; | |
258 | } | |
259 | #endif | |
260 | ||
6998b6fb LP |
261 | unsigned int uvc_queue_poll(struct uvc_video_queue *queue, struct file *file, |
262 | poll_table *wait) | |
263 | { | |
264 | unsigned int ret; | |
4aa27597 | 265 | |
6998b6fb LP |
266 | mutex_lock(&queue->mutex); |
267 | ret = vb2_poll(&queue->queue, file, wait); | |
4aa27597 | 268 | mutex_unlock(&queue->mutex); |
6998b6fb | 269 | |
4aa27597 LP |
270 | return ret; |
271 | } | |
272 | ||
6998b6fb | 273 | /* ----------------------------------------------------------------------------- |
c0efd232 | 274 | * |
c0efd232 | 275 | */ |
6998b6fb LP |
276 | |
277 | /* | |
278 | * Check if buffers have been allocated. | |
279 | */ | |
280 | int uvc_queue_allocated(struct uvc_video_queue *queue) | |
c0efd232 | 281 | { |
6998b6fb | 282 | int allocated; |
c0efd232 LP |
283 | |
284 | mutex_lock(&queue->mutex); | |
6998b6fb | 285 | allocated = vb2_is_busy(&queue->queue); |
c0efd232 | 286 | mutex_unlock(&queue->mutex); |
6998b6fb LP |
287 | |
288 | return allocated; | |
c0efd232 LP |
289 | } |
290 | ||
291 | /* | |
292 | * Enable or disable the video buffers queue. | |
293 | * | |
294 | * The queue must be enabled before starting video acquisition and must be | |
295 | * disabled after stopping it. This ensures that the video buffers queue | |
296 | * state can be properly initialized before buffers are accessed from the | |
297 | * interrupt handler. | |
298 | * | |
650b95fe | 299 | * Enabling the video queue returns -EBUSY if the queue is already enabled. |
c0efd232 LP |
300 | * |
301 | * Disabling the video queue cancels the queue and removes all buffers from | |
302 | * the main queue. | |
303 | * | |
304 | * This function can't be called from interrupt context. Use | |
305 | * uvc_queue_cancel() instead. | |
306 | */ | |
307 | int uvc_queue_enable(struct uvc_video_queue *queue, int enable) | |
308 | { | |
6998b6fb LP |
309 | unsigned long flags; |
310 | int ret; | |
c0efd232 LP |
311 | |
312 | mutex_lock(&queue->mutex); | |
313 | if (enable) { | |
6998b6fb LP |
314 | ret = vb2_streamon(&queue->queue, queue->queue.type); |
315 | if (ret < 0) | |
c0efd232 | 316 | goto done; |
6998b6fb | 317 | |
ff924203 | 318 | queue->buf_used = 0; |
c0efd232 | 319 | } else { |
6998b6fb LP |
320 | ret = vb2_streamoff(&queue->queue, queue->queue.type); |
321 | if (ret < 0) | |
322 | goto done; | |
c0efd232 | 323 | |
6998b6fb LP |
324 | spin_lock_irqsave(&queue->irqlock, flags); |
325 | INIT_LIST_HEAD(&queue->irqqueue); | |
326 | spin_unlock_irqrestore(&queue->irqlock, flags); | |
c0efd232 LP |
327 | } |
328 | ||
329 | done: | |
330 | mutex_unlock(&queue->mutex); | |
331 | return ret; | |
332 | } | |
333 | ||
334 | /* | |
335 | * Cancel the video buffers queue. | |
336 | * | |
337 | * Cancelling the queue marks all buffers on the irq queue as erroneous, | |
2c2d264b | 338 | * wakes them up and removes them from the queue. |
c0efd232 LP |
339 | * |
340 | * If the disconnect parameter is set, further calls to uvc_queue_buffer will | |
341 | * fail with -ENODEV. | |
342 | * | |
343 | * This function acquires the irq spinlock and can be called from interrupt | |
344 | * context. | |
345 | */ | |
346 | void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect) | |
347 | { | |
348 | struct uvc_buffer *buf; | |
349 | unsigned long flags; | |
350 | ||
351 | spin_lock_irqsave(&queue->irqlock, flags); | |
352 | while (!list_empty(&queue->irqqueue)) { | |
353 | buf = list_first_entry(&queue->irqqueue, struct uvc_buffer, | |
354 | queue); | |
355 | list_del(&buf->queue); | |
356 | buf->state = UVC_BUF_STATE_ERROR; | |
6998b6fb | 357 | vb2_buffer_done(&buf->buf, VB2_BUF_STATE_ERROR); |
c0efd232 LP |
358 | } |
359 | /* This must be protected by the irqlock spinlock to avoid race | |
6998b6fb | 360 | * conditions between uvc_buffer_queue and the disconnection event that |
c0efd232 | 361 | * could result in an interruptible wait in uvc_dequeue_buffer. Do not |
6998b6fb | 362 | * blindly replace this logic by checking for the UVC_QUEUE_DISCONNECTED |
c0efd232 LP |
363 | * state outside the queue code. |
364 | */ | |
365 | if (disconnect) | |
366 | queue->flags |= UVC_QUEUE_DISCONNECTED; | |
367 | spin_unlock_irqrestore(&queue->irqlock, flags); | |
368 | } | |
369 | ||
370 | struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue, | |
371 | struct uvc_buffer *buf) | |
372 | { | |
373 | struct uvc_buffer *nextbuf; | |
374 | unsigned long flags; | |
375 | ||
9bde9f26 LP |
376 | if ((queue->flags & UVC_QUEUE_DROP_CORRUPTED) && buf->error) { |
377 | buf->error = 0; | |
c0efd232 | 378 | buf->state = UVC_BUF_STATE_QUEUED; |
8a3f0ede | 379 | buf->bytesused = 0; |
6998b6fb | 380 | vb2_set_plane_payload(&buf->buf, 0, 0); |
c0efd232 LP |
381 | return buf; |
382 | } | |
383 | ||
384 | spin_lock_irqsave(&queue->irqlock, flags); | |
385 | list_del(&buf->queue); | |
386 | if (!list_empty(&queue->irqqueue)) | |
387 | nextbuf = list_first_entry(&queue->irqqueue, struct uvc_buffer, | |
388 | queue); | |
389 | else | |
390 | nextbuf = NULL; | |
391 | spin_unlock_irqrestore(&queue->irqlock, flags); | |
392 | ||
6998b6fb LP |
393 | buf->state = buf->error ? VB2_BUF_STATE_ERROR : UVC_BUF_STATE_DONE; |
394 | vb2_set_plane_payload(&buf->buf, 0, buf->bytesused); | |
395 | vb2_buffer_done(&buf->buf, VB2_BUF_STATE_DONE); | |
396 | ||
c0efd232 LP |
397 | return nextbuf; |
398 | } |