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 | ||
bc75d5a0 LP |
39 | static inline struct uvc_streaming * |
40 | uvc_queue_to_stream(struct uvc_video_queue *queue) | |
41 | { | |
42 | return container_of(queue, struct uvc_streaming, queue); | |
43 | } | |
44 | ||
ef33d901 LP |
45 | /* |
46 | * Return all queued buffers to videobuf2 in the requested state. | |
47 | * | |
48 | * This function must be called with the queue spinlock held. | |
49 | */ | |
50 | static void uvc_queue_return_buffers(struct uvc_video_queue *queue, | |
51 | enum uvc_buffer_state state) | |
52 | { | |
53 | enum vb2_buffer_state vb2_state = state == UVC_BUF_STATE_ERROR | |
54 | ? VB2_BUF_STATE_ERROR | |
55 | : VB2_BUF_STATE_QUEUED; | |
56 | ||
57 | while (!list_empty(&queue->irqqueue)) { | |
58 | struct uvc_buffer *buf = list_first_entry(&queue->irqqueue, | |
59 | struct uvc_buffer, | |
60 | queue); | |
61 | list_del(&buf->queue); | |
62 | buf->state = state; | |
63 | vb2_buffer_done(&buf->buf, vb2_state); | |
64 | } | |
65 | } | |
66 | ||
6998b6fb LP |
67 | /* ----------------------------------------------------------------------------- |
68 | * videobuf2 queue operations | |
8e815e17 | 69 | */ |
6998b6fb LP |
70 | |
71 | static int uvc_queue_setup(struct vb2_queue *vq, const struct v4l2_format *fmt, | |
72 | unsigned int *nbuffers, unsigned int *nplanes, | |
73 | unsigned int sizes[], void *alloc_ctxs[]) | |
8e815e17 | 74 | { |
6998b6fb | 75 | struct uvc_video_queue *queue = vb2_get_drv_priv(vq); |
bc75d5a0 | 76 | struct uvc_streaming *stream = uvc_queue_to_stream(queue); |
8e815e17 | 77 | |
bddb9d0e LP |
78 | /* Make sure the image size is large enough. */ |
79 | if (fmt && fmt->fmt.pix.sizeimage < stream->ctrl.dwMaxVideoFrameSize) | |
80 | return -EINVAL; | |
81 | ||
6998b6fb LP |
82 | *nplanes = 1; |
83 | ||
bddb9d0e LP |
84 | sizes[0] = fmt ? fmt->fmt.pix.sizeimage |
85 | : stream->ctrl.dwMaxVideoFrameSize; | |
8e815e17 LP |
86 | |
87 | return 0; | |
88 | } | |
89 | ||
6998b6fb | 90 | static int uvc_buffer_prepare(struct vb2_buffer *vb) |
8e815e17 | 91 | { |
6998b6fb LP |
92 | struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue); |
93 | struct uvc_buffer *buf = container_of(vb, struct uvc_buffer, buf); | |
8e815e17 | 94 | |
6998b6fb LP |
95 | if (vb->v4l2_buf.type == V4L2_BUF_TYPE_VIDEO_OUTPUT && |
96 | vb2_get_plane_payload(vb, 0) > vb2_plane_size(vb, 0)) { | |
97 | uvc_trace(UVC_TRACE_CAPTURE, "[E] Bytes used out of bounds.\n"); | |
98 | return -EINVAL; | |
99 | } | |
c0efd232 | 100 | |
6998b6fb LP |
101 | if (unlikely(queue->flags & UVC_QUEUE_DISCONNECTED)) |
102 | return -ENODEV; | |
c0efd232 | 103 | |
6998b6fb LP |
104 | buf->state = UVC_BUF_STATE_QUEUED; |
105 | buf->error = 0; | |
106 | buf->mem = vb2_plane_vaddr(vb, 0); | |
107 | buf->length = vb2_plane_size(vb, 0); | |
108 | if (vb->v4l2_buf.type == V4L2_BUF_TYPE_VIDEO_CAPTURE) | |
109 | buf->bytesused = 0; | |
110 | else | |
111 | buf->bytesused = vb2_get_plane_payload(vb, 0); | |
c0efd232 | 112 | |
6998b6fb LP |
113 | return 0; |
114 | } | |
c0efd232 | 115 | |
6998b6fb LP |
116 | static void uvc_buffer_queue(struct vb2_buffer *vb) |
117 | { | |
118 | struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue); | |
119 | struct uvc_buffer *buf = container_of(vb, struct uvc_buffer, buf); | |
120 | unsigned long flags; | |
c0efd232 | 121 | |
6998b6fb LP |
122 | spin_lock_irqsave(&queue->irqlock, flags); |
123 | if (likely(!(queue->flags & UVC_QUEUE_DISCONNECTED))) { | |
124 | list_add_tail(&buf->queue, &queue->irqqueue); | |
125 | } else { | |
126 | /* If the device is disconnected return the buffer to userspace | |
127 | * directly. The next QBUF call will fail with -ENODEV. | |
128 | */ | |
129 | buf->state = UVC_BUF_STATE_ERROR; | |
130 | vb2_buffer_done(&buf->buf, VB2_BUF_STATE_ERROR); | |
c0efd232 LP |
131 | } |
132 | ||
6998b6fb LP |
133 | spin_unlock_irqrestore(&queue->irqlock, flags); |
134 | } | |
c0efd232 | 135 | |
06470642 | 136 | static void uvc_buffer_finish(struct vb2_buffer *vb) |
66847ef0 LP |
137 | { |
138 | struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue); | |
bc75d5a0 | 139 | struct uvc_streaming *stream = uvc_queue_to_stream(queue); |
66847ef0 LP |
140 | struct uvc_buffer *buf = container_of(vb, struct uvc_buffer, buf); |
141 | ||
9c0863b1 HV |
142 | if (vb->state == VB2_BUF_STATE_DONE) |
143 | uvc_video_clock_update(stream, &vb->v4l2_buf, buf); | |
66847ef0 LP |
144 | } |
145 | ||
05c79d0d LP |
146 | static void uvc_wait_prepare(struct vb2_queue *vq) |
147 | { | |
148 | struct uvc_video_queue *queue = vb2_get_drv_priv(vq); | |
149 | ||
150 | mutex_unlock(&queue->mutex); | |
151 | } | |
152 | ||
153 | static void uvc_wait_finish(struct vb2_queue *vq) | |
154 | { | |
155 | struct uvc_video_queue *queue = vb2_get_drv_priv(vq); | |
156 | ||
157 | mutex_lock(&queue->mutex); | |
158 | } | |
159 | ||
a11a03e5 LP |
160 | static int uvc_start_streaming(struct vb2_queue *vq, unsigned int count) |
161 | { | |
162 | struct uvc_video_queue *queue = vb2_get_drv_priv(vq); | |
163 | struct uvc_streaming *stream = uvc_queue_to_stream(queue); | |
ef33d901 LP |
164 | unsigned long flags; |
165 | int ret; | |
a11a03e5 LP |
166 | |
167 | queue->buf_used = 0; | |
168 | ||
ef33d901 LP |
169 | ret = uvc_video_enable(stream, 1); |
170 | if (ret == 0) | |
171 | return 0; | |
172 | ||
173 | spin_lock_irqsave(&queue->irqlock, flags); | |
174 | uvc_queue_return_buffers(queue, UVC_BUF_STATE_QUEUED); | |
175 | spin_unlock_irqrestore(&queue->irqlock, flags); | |
176 | ||
177 | return ret; | |
a11a03e5 LP |
178 | } |
179 | ||
180 | static void uvc_stop_streaming(struct vb2_queue *vq) | |
181 | { | |
182 | struct uvc_video_queue *queue = vb2_get_drv_priv(vq); | |
183 | struct uvc_streaming *stream = uvc_queue_to_stream(queue); | |
184 | unsigned long flags; | |
185 | ||
186 | uvc_video_enable(stream, 0); | |
187 | ||
188 | spin_lock_irqsave(&queue->irqlock, flags); | |
ef33d901 | 189 | uvc_queue_return_buffers(queue, UVC_BUF_STATE_ERROR); |
a11a03e5 LP |
190 | spin_unlock_irqrestore(&queue->irqlock, flags); |
191 | } | |
192 | ||
6998b6fb LP |
193 | static struct vb2_ops uvc_queue_qops = { |
194 | .queue_setup = uvc_queue_setup, | |
195 | .buf_prepare = uvc_buffer_prepare, | |
196 | .buf_queue = uvc_buffer_queue, | |
66847ef0 | 197 | .buf_finish = uvc_buffer_finish, |
05c79d0d LP |
198 | .wait_prepare = uvc_wait_prepare, |
199 | .wait_finish = uvc_wait_finish, | |
a11a03e5 LP |
200 | .start_streaming = uvc_start_streaming, |
201 | .stop_streaming = uvc_stop_streaming, | |
6998b6fb | 202 | }; |
c0efd232 | 203 | |
5712661d | 204 | int uvc_queue_init(struct uvc_video_queue *queue, enum v4l2_buf_type type, |
6998b6fb LP |
205 | int drop_corrupted) |
206 | { | |
5712661d EG |
207 | int ret; |
208 | ||
6998b6fb | 209 | queue->queue.type = type; |
ccc4c539 | 210 | queue->queue.io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF; |
6998b6fb LP |
211 | queue->queue.drv_priv = queue; |
212 | queue->queue.buf_struct_size = sizeof(struct uvc_buffer); | |
213 | queue->queue.ops = &uvc_queue_qops; | |
214 | queue->queue.mem_ops = &vb2_vmalloc_memops; | |
c767492a SA |
215 | queue->queue.timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC |
216 | | V4L2_BUF_FLAG_TSTAMP_SRC_SOE; | |
5712661d EG |
217 | ret = vb2_queue_init(&queue->queue); |
218 | if (ret) | |
219 | return ret; | |
c0efd232 | 220 | |
6998b6fb LP |
221 | mutex_init(&queue->mutex); |
222 | spin_lock_init(&queue->irqlock); | |
223 | INIT_LIST_HEAD(&queue->irqqueue); | |
224 | queue->flags = drop_corrupted ? UVC_QUEUE_DROP_CORRUPTED : 0; | |
5712661d EG |
225 | |
226 | return 0; | |
c0efd232 LP |
227 | } |
228 | ||
3f02de27 LP |
229 | void uvc_queue_release(struct uvc_video_queue *queue) |
230 | { | |
231 | mutex_lock(&queue->mutex); | |
232 | vb2_queue_release(&queue->queue); | |
233 | mutex_unlock(&queue->mutex); | |
234 | } | |
235 | ||
6998b6fb LP |
236 | /* ----------------------------------------------------------------------------- |
237 | * V4L2 queue operations | |
23ff6043 | 238 | */ |
6998b6fb | 239 | |
1b7f9c98 LP |
240 | int uvc_request_buffers(struct uvc_video_queue *queue, |
241 | struct v4l2_requestbuffers *rb) | |
23ff6043 | 242 | { |
6998b6fb | 243 | int ret; |
23ff6043 LP |
244 | |
245 | mutex_lock(&queue->mutex); | |
6998b6fb | 246 | ret = vb2_reqbufs(&queue->queue, rb); |
23ff6043 LP |
247 | mutex_unlock(&queue->mutex); |
248 | ||
6998b6fb | 249 | return ret ? ret : rb->count; |
23ff6043 LP |
250 | } |
251 | ||
6998b6fb | 252 | int uvc_query_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf) |
c0efd232 | 253 | { |
6998b6fb | 254 | int ret; |
c0efd232 LP |
255 | |
256 | mutex_lock(&queue->mutex); | |
6998b6fb | 257 | ret = vb2_querybuf(&queue->queue, buf); |
2c2d264b | 258 | mutex_unlock(&queue->mutex); |
6998b6fb | 259 | |
2c2d264b | 260 | return ret; |
c0efd232 LP |
261 | } |
262 | ||
6e9179e2 PZ |
263 | int uvc_create_buffers(struct uvc_video_queue *queue, |
264 | struct v4l2_create_buffers *cb) | |
265 | { | |
266 | int ret; | |
267 | ||
268 | mutex_lock(&queue->mutex); | |
269 | ret = vb2_create_bufs(&queue->queue, cb); | |
270 | mutex_unlock(&queue->mutex); | |
271 | ||
272 | return ret; | |
273 | } | |
274 | ||
6998b6fb | 275 | int uvc_queue_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf) |
c0efd232 | 276 | { |
6998b6fb | 277 | int ret; |
c0efd232 LP |
278 | |
279 | mutex_lock(&queue->mutex); | |
6998b6fb | 280 | ret = vb2_qbuf(&queue->queue, buf); |
c0efd232 | 281 | mutex_unlock(&queue->mutex); |
c0efd232 | 282 | |
6998b6fb | 283 | return ret; |
c0efd232 LP |
284 | } |
285 | ||
6998b6fb LP |
286 | int uvc_dequeue_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf, |
287 | int nonblocking) | |
c0efd232 | 288 | { |
6998b6fb | 289 | int ret; |
c0efd232 LP |
290 | |
291 | mutex_lock(&queue->mutex); | |
6998b6fb | 292 | ret = vb2_dqbuf(&queue->queue, buf, nonblocking); |
c0efd232 | 293 | mutex_unlock(&queue->mutex); |
c0efd232 | 294 | |
6998b6fb | 295 | return ret; |
4aa27597 LP |
296 | } |
297 | ||
0da4ab98 LP |
298 | int uvc_queue_streamon(struct uvc_video_queue *queue, enum v4l2_buf_type type) |
299 | { | |
300 | int ret; | |
301 | ||
302 | mutex_lock(&queue->mutex); | |
303 | ret = vb2_streamon(&queue->queue, type); | |
304 | mutex_unlock(&queue->mutex); | |
305 | ||
306 | return ret; | |
307 | } | |
308 | ||
309 | int uvc_queue_streamoff(struct uvc_video_queue *queue, enum v4l2_buf_type type) | |
310 | { | |
311 | int ret; | |
312 | ||
313 | mutex_lock(&queue->mutex); | |
314 | ret = vb2_streamoff(&queue->queue, type); | |
315 | mutex_unlock(&queue->mutex); | |
316 | ||
317 | return ret; | |
318 | } | |
319 | ||
4aa27597 LP |
320 | int uvc_queue_mmap(struct uvc_video_queue *queue, struct vm_area_struct *vma) |
321 | { | |
6998b6fb | 322 | int ret; |
4aa27597 LP |
323 | |
324 | mutex_lock(&queue->mutex); | |
6998b6fb LP |
325 | ret = vb2_mmap(&queue->queue, vma); |
326 | mutex_unlock(&queue->mutex); | |
4aa27597 | 327 | |
6998b6fb LP |
328 | return ret; |
329 | } | |
4aa27597 | 330 | |
4742c82e LP |
331 | #ifndef CONFIG_MMU |
332 | unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue, | |
333 | unsigned long pgoff) | |
334 | { | |
335 | unsigned long ret; | |
336 | ||
337 | mutex_lock(&queue->mutex); | |
338 | ret = vb2_get_unmapped_area(&queue->queue, 0, 0, pgoff, 0); | |
339 | mutex_unlock(&queue->mutex); | |
340 | return ret; | |
341 | } | |
342 | #endif | |
343 | ||
6998b6fb LP |
344 | unsigned int uvc_queue_poll(struct uvc_video_queue *queue, struct file *file, |
345 | poll_table *wait) | |
346 | { | |
347 | unsigned int ret; | |
4aa27597 | 348 | |
6998b6fb LP |
349 | mutex_lock(&queue->mutex); |
350 | ret = vb2_poll(&queue->queue, file, wait); | |
4aa27597 | 351 | mutex_unlock(&queue->mutex); |
6998b6fb | 352 | |
4aa27597 LP |
353 | return ret; |
354 | } | |
355 | ||
6998b6fb | 356 | /* ----------------------------------------------------------------------------- |
c0efd232 | 357 | * |
c0efd232 | 358 | */ |
6998b6fb LP |
359 | |
360 | /* | |
361 | * Check if buffers have been allocated. | |
362 | */ | |
363 | int uvc_queue_allocated(struct uvc_video_queue *queue) | |
c0efd232 | 364 | { |
6998b6fb | 365 | int allocated; |
c0efd232 LP |
366 | |
367 | mutex_lock(&queue->mutex); | |
6998b6fb | 368 | allocated = vb2_is_busy(&queue->queue); |
c0efd232 | 369 | mutex_unlock(&queue->mutex); |
6998b6fb LP |
370 | |
371 | return allocated; | |
c0efd232 LP |
372 | } |
373 | ||
c0efd232 LP |
374 | /* |
375 | * Cancel the video buffers queue. | |
376 | * | |
377 | * Cancelling the queue marks all buffers on the irq queue as erroneous, | |
2c2d264b | 378 | * wakes them up and removes them from the queue. |
c0efd232 LP |
379 | * |
380 | * If the disconnect parameter is set, further calls to uvc_queue_buffer will | |
381 | * fail with -ENODEV. | |
382 | * | |
383 | * This function acquires the irq spinlock and can be called from interrupt | |
384 | * context. | |
385 | */ | |
386 | void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect) | |
387 | { | |
c0efd232 LP |
388 | unsigned long flags; |
389 | ||
390 | spin_lock_irqsave(&queue->irqlock, flags); | |
ef33d901 | 391 | uvc_queue_return_buffers(queue, UVC_BUF_STATE_ERROR); |
c0efd232 | 392 | /* This must be protected by the irqlock spinlock to avoid race |
6998b6fb | 393 | * conditions between uvc_buffer_queue and the disconnection event that |
c0efd232 | 394 | * could result in an interruptible wait in uvc_dequeue_buffer. Do not |
6998b6fb | 395 | * blindly replace this logic by checking for the UVC_QUEUE_DISCONNECTED |
c0efd232 LP |
396 | * state outside the queue code. |
397 | */ | |
398 | if (disconnect) | |
399 | queue->flags |= UVC_QUEUE_DISCONNECTED; | |
400 | spin_unlock_irqrestore(&queue->irqlock, flags); | |
401 | } | |
402 | ||
403 | struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue, | |
404 | struct uvc_buffer *buf) | |
405 | { | |
406 | struct uvc_buffer *nextbuf; | |
407 | unsigned long flags; | |
408 | ||
9bde9f26 LP |
409 | if ((queue->flags & UVC_QUEUE_DROP_CORRUPTED) && buf->error) { |
410 | buf->error = 0; | |
c0efd232 | 411 | buf->state = UVC_BUF_STATE_QUEUED; |
8a3f0ede | 412 | buf->bytesused = 0; |
6998b6fb | 413 | vb2_set_plane_payload(&buf->buf, 0, 0); |
c0efd232 LP |
414 | return buf; |
415 | } | |
416 | ||
417 | spin_lock_irqsave(&queue->irqlock, flags); | |
418 | list_del(&buf->queue); | |
419 | if (!list_empty(&queue->irqqueue)) | |
420 | nextbuf = list_first_entry(&queue->irqqueue, struct uvc_buffer, | |
421 | queue); | |
422 | else | |
423 | nextbuf = NULL; | |
424 | spin_unlock_irqrestore(&queue->irqlock, flags); | |
425 | ||
6998b6fb LP |
426 | buf->state = buf->error ? VB2_BUF_STATE_ERROR : UVC_BUF_STATE_DONE; |
427 | vb2_set_plane_payload(&buf->buf, 0, buf->bytesused); | |
428 | vb2_buffer_done(&buf->buf, VB2_BUF_STATE_DONE); | |
429 | ||
c0efd232 LP |
430 | return nextbuf; |
431 | } |