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 | |
6998b6fb LP |
51 | if (*nbuffers > UVC_MAX_VIDEO_BUFFERS) |
52 | *nbuffers = UVC_MAX_VIDEO_BUFFERS; | |
8e815e17 | 53 | |
6998b6fb LP |
54 | *nplanes = 1; |
55 | ||
56 | sizes[0] = stream->ctrl.dwMaxVideoFrameSize; | |
8e815e17 LP |
57 | |
58 | return 0; | |
59 | } | |
60 | ||
6998b6fb | 61 | static int uvc_buffer_prepare(struct vb2_buffer *vb) |
8e815e17 | 62 | { |
6998b6fb LP |
63 | struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue); |
64 | struct uvc_buffer *buf = container_of(vb, struct uvc_buffer, buf); | |
8e815e17 | 65 | |
6998b6fb LP |
66 | if (vb->v4l2_buf.type == V4L2_BUF_TYPE_VIDEO_OUTPUT && |
67 | vb2_get_plane_payload(vb, 0) > vb2_plane_size(vb, 0)) { | |
68 | uvc_trace(UVC_TRACE_CAPTURE, "[E] Bytes used out of bounds.\n"); | |
69 | return -EINVAL; | |
70 | } | |
c0efd232 | 71 | |
6998b6fb LP |
72 | if (unlikely(queue->flags & UVC_QUEUE_DISCONNECTED)) |
73 | return -ENODEV; | |
c0efd232 | 74 | |
6998b6fb LP |
75 | buf->state = UVC_BUF_STATE_QUEUED; |
76 | buf->error = 0; | |
77 | buf->mem = vb2_plane_vaddr(vb, 0); | |
78 | buf->length = vb2_plane_size(vb, 0); | |
79 | if (vb->v4l2_buf.type == V4L2_BUF_TYPE_VIDEO_CAPTURE) | |
80 | buf->bytesused = 0; | |
81 | else | |
82 | buf->bytesused = vb2_get_plane_payload(vb, 0); | |
c0efd232 | 83 | |
6998b6fb LP |
84 | return 0; |
85 | } | |
c0efd232 | 86 | |
6998b6fb LP |
87 | static void uvc_buffer_queue(struct vb2_buffer *vb) |
88 | { | |
89 | struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue); | |
90 | struct uvc_buffer *buf = container_of(vb, struct uvc_buffer, buf); | |
91 | unsigned long flags; | |
c0efd232 | 92 | |
6998b6fb LP |
93 | spin_lock_irqsave(&queue->irqlock, flags); |
94 | if (likely(!(queue->flags & UVC_QUEUE_DISCONNECTED))) { | |
95 | list_add_tail(&buf->queue, &queue->irqqueue); | |
96 | } else { | |
97 | /* If the device is disconnected return the buffer to userspace | |
98 | * directly. The next QBUF call will fail with -ENODEV. | |
99 | */ | |
100 | buf->state = UVC_BUF_STATE_ERROR; | |
101 | vb2_buffer_done(&buf->buf, VB2_BUF_STATE_ERROR); | |
c0efd232 LP |
102 | } |
103 | ||
6998b6fb LP |
104 | spin_unlock_irqrestore(&queue->irqlock, flags); |
105 | } | |
c0efd232 | 106 | |
6998b6fb LP |
107 | static struct vb2_ops uvc_queue_qops = { |
108 | .queue_setup = uvc_queue_setup, | |
109 | .buf_prepare = uvc_buffer_prepare, | |
110 | .buf_queue = uvc_buffer_queue, | |
111 | }; | |
c0efd232 | 112 | |
6998b6fb LP |
113 | void uvc_queue_init(struct uvc_video_queue *queue, enum v4l2_buf_type type, |
114 | int drop_corrupted) | |
115 | { | |
116 | queue->queue.type = type; | |
117 | queue->queue.io_modes = VB2_MMAP; | |
118 | queue->queue.drv_priv = queue; | |
119 | queue->queue.buf_struct_size = sizeof(struct uvc_buffer); | |
120 | queue->queue.ops = &uvc_queue_qops; | |
121 | queue->queue.mem_ops = &vb2_vmalloc_memops; | |
122 | vb2_queue_init(&queue->queue); | |
c0efd232 | 123 | |
6998b6fb LP |
124 | mutex_init(&queue->mutex); |
125 | spin_lock_init(&queue->irqlock); | |
126 | INIT_LIST_HEAD(&queue->irqqueue); | |
127 | queue->flags = drop_corrupted ? UVC_QUEUE_DROP_CORRUPTED : 0; | |
c0efd232 LP |
128 | } |
129 | ||
6998b6fb LP |
130 | /* ----------------------------------------------------------------------------- |
131 | * V4L2 queue operations | |
23ff6043 | 132 | */ |
6998b6fb LP |
133 | |
134 | int uvc_alloc_buffers(struct uvc_video_queue *queue, | |
135 | struct v4l2_requestbuffers *rb) | |
23ff6043 | 136 | { |
6998b6fb | 137 | int ret; |
23ff6043 LP |
138 | |
139 | mutex_lock(&queue->mutex); | |
6998b6fb | 140 | ret = vb2_reqbufs(&queue->queue, rb); |
23ff6043 LP |
141 | mutex_unlock(&queue->mutex); |
142 | ||
6998b6fb | 143 | return ret ? ret : rb->count; |
23ff6043 LP |
144 | } |
145 | ||
6998b6fb | 146 | void uvc_free_buffers(struct uvc_video_queue *queue) |
c0efd232 | 147 | { |
6998b6fb LP |
148 | mutex_lock(&queue->mutex); |
149 | vb2_queue_release(&queue->queue); | |
150 | mutex_unlock(&queue->mutex); | |
c0efd232 LP |
151 | } |
152 | ||
6998b6fb | 153 | int uvc_query_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf) |
c0efd232 | 154 | { |
6998b6fb | 155 | int ret; |
c0efd232 LP |
156 | |
157 | mutex_lock(&queue->mutex); | |
6998b6fb | 158 | ret = vb2_querybuf(&queue->queue, buf); |
2c2d264b | 159 | mutex_unlock(&queue->mutex); |
6998b6fb | 160 | |
2c2d264b | 161 | return ret; |
c0efd232 LP |
162 | } |
163 | ||
6998b6fb | 164 | int uvc_queue_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf) |
c0efd232 | 165 | { |
6998b6fb | 166 | int ret; |
c0efd232 LP |
167 | |
168 | mutex_lock(&queue->mutex); | |
6998b6fb | 169 | ret = vb2_qbuf(&queue->queue, buf); |
c0efd232 | 170 | mutex_unlock(&queue->mutex); |
c0efd232 | 171 | |
6998b6fb | 172 | return ret; |
c0efd232 LP |
173 | } |
174 | ||
6998b6fb LP |
175 | int uvc_dequeue_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf, |
176 | int nonblocking) | |
c0efd232 | 177 | { |
6998b6fb | 178 | int ret; |
c0efd232 LP |
179 | |
180 | mutex_lock(&queue->mutex); | |
6998b6fb | 181 | ret = vb2_dqbuf(&queue->queue, buf, nonblocking); |
c0efd232 | 182 | mutex_unlock(&queue->mutex); |
c0efd232 | 183 | |
6998b6fb | 184 | return ret; |
4aa27597 LP |
185 | } |
186 | ||
4aa27597 LP |
187 | int uvc_queue_mmap(struct uvc_video_queue *queue, struct vm_area_struct *vma) |
188 | { | |
6998b6fb | 189 | int ret; |
4aa27597 LP |
190 | |
191 | mutex_lock(&queue->mutex); | |
6998b6fb LP |
192 | ret = vb2_mmap(&queue->queue, vma); |
193 | mutex_unlock(&queue->mutex); | |
4aa27597 | 194 | |
6998b6fb LP |
195 | return ret; |
196 | } | |
4aa27597 | 197 | |
6998b6fb LP |
198 | unsigned int uvc_queue_poll(struct uvc_video_queue *queue, struct file *file, |
199 | poll_table *wait) | |
200 | { | |
201 | unsigned int ret; | |
4aa27597 | 202 | |
6998b6fb LP |
203 | mutex_lock(&queue->mutex); |
204 | ret = vb2_poll(&queue->queue, file, wait); | |
4aa27597 | 205 | mutex_unlock(&queue->mutex); |
6998b6fb | 206 | |
4aa27597 LP |
207 | return ret; |
208 | } | |
209 | ||
6998b6fb | 210 | /* ----------------------------------------------------------------------------- |
c0efd232 | 211 | * |
c0efd232 | 212 | */ |
6998b6fb LP |
213 | |
214 | /* | |
215 | * Check if buffers have been allocated. | |
216 | */ | |
217 | int uvc_queue_allocated(struct uvc_video_queue *queue) | |
c0efd232 | 218 | { |
6998b6fb | 219 | int allocated; |
c0efd232 LP |
220 | |
221 | mutex_lock(&queue->mutex); | |
6998b6fb | 222 | allocated = vb2_is_busy(&queue->queue); |
c0efd232 | 223 | mutex_unlock(&queue->mutex); |
6998b6fb LP |
224 | |
225 | return allocated; | |
c0efd232 LP |
226 | } |
227 | ||
72969447 BL |
228 | #ifndef CONFIG_MMU |
229 | /* | |
230 | * Get unmapped area. | |
231 | * | |
232 | * NO-MMU arch need this function to make mmap() work correctly. | |
233 | */ | |
234 | unsigned long uvc_queue_get_unmapped_area(struct uvc_video_queue *queue, | |
235 | unsigned long pgoff) | |
236 | { | |
237 | struct uvc_buffer *buffer; | |
238 | unsigned int i; | |
239 | unsigned long ret; | |
240 | ||
241 | mutex_lock(&queue->mutex); | |
242 | for (i = 0; i < queue->count; ++i) { | |
243 | buffer = &queue->buffer[i]; | |
244 | if ((buffer->buf.m.offset >> PAGE_SHIFT) == pgoff) | |
245 | break; | |
246 | } | |
247 | if (i == queue->count) { | |
248 | ret = -EINVAL; | |
249 | goto done; | |
250 | } | |
3d95e932 | 251 | ret = (unsigned long)buf->mem; |
72969447 BL |
252 | done: |
253 | mutex_unlock(&queue->mutex); | |
254 | return ret; | |
255 | } | |
256 | #endif | |
257 | ||
c0efd232 LP |
258 | /* |
259 | * Enable or disable the video buffers queue. | |
260 | * | |
261 | * The queue must be enabled before starting video acquisition and must be | |
262 | * disabled after stopping it. This ensures that the video buffers queue | |
263 | * state can be properly initialized before buffers are accessed from the | |
264 | * interrupt handler. | |
265 | * | |
650b95fe | 266 | * Enabling the video queue returns -EBUSY if the queue is already enabled. |
c0efd232 LP |
267 | * |
268 | * Disabling the video queue cancels the queue and removes all buffers from | |
269 | * the main queue. | |
270 | * | |
271 | * This function can't be called from interrupt context. Use | |
272 | * uvc_queue_cancel() instead. | |
273 | */ | |
274 | int uvc_queue_enable(struct uvc_video_queue *queue, int enable) | |
275 | { | |
6998b6fb LP |
276 | unsigned long flags; |
277 | int ret; | |
c0efd232 LP |
278 | |
279 | mutex_lock(&queue->mutex); | |
280 | if (enable) { | |
6998b6fb LP |
281 | ret = vb2_streamon(&queue->queue, queue->queue.type); |
282 | if (ret < 0) | |
c0efd232 | 283 | goto done; |
6998b6fb | 284 | |
ff924203 | 285 | queue->buf_used = 0; |
c0efd232 | 286 | } else { |
6998b6fb LP |
287 | ret = vb2_streamoff(&queue->queue, queue->queue.type); |
288 | if (ret < 0) | |
289 | goto done; | |
c0efd232 | 290 | |
6998b6fb LP |
291 | spin_lock_irqsave(&queue->irqlock, flags); |
292 | INIT_LIST_HEAD(&queue->irqqueue); | |
293 | spin_unlock_irqrestore(&queue->irqlock, flags); | |
c0efd232 LP |
294 | } |
295 | ||
296 | done: | |
297 | mutex_unlock(&queue->mutex); | |
298 | return ret; | |
299 | } | |
300 | ||
301 | /* | |
302 | * Cancel the video buffers queue. | |
303 | * | |
304 | * Cancelling the queue marks all buffers on the irq queue as erroneous, | |
2c2d264b | 305 | * wakes them up and removes them from the queue. |
c0efd232 LP |
306 | * |
307 | * If the disconnect parameter is set, further calls to uvc_queue_buffer will | |
308 | * fail with -ENODEV. | |
309 | * | |
310 | * This function acquires the irq spinlock and can be called from interrupt | |
311 | * context. | |
312 | */ | |
313 | void uvc_queue_cancel(struct uvc_video_queue *queue, int disconnect) | |
314 | { | |
315 | struct uvc_buffer *buf; | |
316 | unsigned long flags; | |
317 | ||
318 | spin_lock_irqsave(&queue->irqlock, flags); | |
319 | while (!list_empty(&queue->irqqueue)) { | |
320 | buf = list_first_entry(&queue->irqqueue, struct uvc_buffer, | |
321 | queue); | |
322 | list_del(&buf->queue); | |
323 | buf->state = UVC_BUF_STATE_ERROR; | |
6998b6fb | 324 | vb2_buffer_done(&buf->buf, VB2_BUF_STATE_ERROR); |
c0efd232 LP |
325 | } |
326 | /* This must be protected by the irqlock spinlock to avoid race | |
6998b6fb | 327 | * conditions between uvc_buffer_queue and the disconnection event that |
c0efd232 | 328 | * could result in an interruptible wait in uvc_dequeue_buffer. Do not |
6998b6fb | 329 | * blindly replace this logic by checking for the UVC_QUEUE_DISCONNECTED |
c0efd232 LP |
330 | * state outside the queue code. |
331 | */ | |
332 | if (disconnect) | |
333 | queue->flags |= UVC_QUEUE_DISCONNECTED; | |
334 | spin_unlock_irqrestore(&queue->irqlock, flags); | |
335 | } | |
336 | ||
337 | struct uvc_buffer *uvc_queue_next_buffer(struct uvc_video_queue *queue, | |
338 | struct uvc_buffer *buf) | |
339 | { | |
340 | struct uvc_buffer *nextbuf; | |
341 | unsigned long flags; | |
342 | ||
9bde9f26 LP |
343 | if ((queue->flags & UVC_QUEUE_DROP_CORRUPTED) && buf->error) { |
344 | buf->error = 0; | |
c0efd232 | 345 | buf->state = UVC_BUF_STATE_QUEUED; |
6998b6fb | 346 | vb2_set_plane_payload(&buf->buf, 0, 0); |
c0efd232 LP |
347 | return buf; |
348 | } | |
349 | ||
350 | spin_lock_irqsave(&queue->irqlock, flags); | |
351 | list_del(&buf->queue); | |
352 | if (!list_empty(&queue->irqqueue)) | |
353 | nextbuf = list_first_entry(&queue->irqqueue, struct uvc_buffer, | |
354 | queue); | |
355 | else | |
356 | nextbuf = NULL; | |
357 | spin_unlock_irqrestore(&queue->irqlock, flags); | |
358 | ||
6998b6fb LP |
359 | buf->state = buf->error ? VB2_BUF_STATE_ERROR : UVC_BUF_STATE_DONE; |
360 | vb2_set_plane_payload(&buf->buf, 0, buf->bytesused); | |
361 | vb2_buffer_done(&buf->buf, VB2_BUF_STATE_DONE); | |
362 | ||
c0efd232 LP |
363 | return nextbuf; |
364 | } |