1 // SPDX-License-Identifier: GPL-2.0+
3  *	uvc_queue.c  --  USB Video Class driver - Buffers management
5  *	Copyright (C) 2005-2010
17 #include <linux/wait.h>
19 #include <media/v4l2-common.h>
20 #include <media/videobuf2-dma-sg.h>
21 #include <media/videobuf2-vmalloc.h>
26 /* ------------------------------------------------------------------------
27  * Video buffers queue management.
33  * the videobuf2 queue operations by serializing calls to videobuf2 and a
34  * spinlock to protect the IRQ queue that holds the buffers to be processed by
38 /* -----------------------------------------------------------------------------
39  * videobuf2 queue operations
46 	struct uvc_video_queue *queue = vb2_get_drv_priv(vq);  in uvc_queue_setup()  local
47 	struct uvc_video *video = container_of(queue, struct uvc_video, queue);  in uvc_queue_setup()
56 	sizes[0] = video->imagesize;  in uvc_queue_setup()
63 	struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue);  in uvc_buffer_prepare()  local
64 	struct uvc_video *video = container_of(queue, struct uvc_video, queue);  in uvc_buffer_prepare()
68 	if (vb->type == V4L2_BUF_TYPE_VIDEO_OUTPUT &&  in uvc_buffer_prepare()
71 		return -EINVAL;  in uvc_buffer_prepare()
74 	if (unlikely(queue->flags & UVC_QUEUE_DISCONNECTED))  in uvc_buffer_prepare()
75 		return -ENODEV;  in uvc_buffer_prepare()
77 	buf->state = UVC_BUF_STATE_QUEUED;  in uvc_buffer_prepare()
78 	if (queue->use_sg) {  in uvc_buffer_prepare()
79 		buf->sgt = vb2_dma_sg_plane_desc(vb, 0);  in uvc_buffer_prepare()
80 		buf->sg = buf->sgt->sgl;  in uvc_buffer_prepare()
82 		buf->mem = vb2_plane_vaddr(vb, 0);  in uvc_buffer_prepare()
84 	buf->length = vb2_plane_size(vb, 0);  in uvc_buffer_prepare()
85 	if (vb->type == V4L2_BUF_TYPE_VIDEO_CAPTURE) {  in uvc_buffer_prepare()
86 		buf->bytesused = 0;  in uvc_buffer_prepare()
88 		buf->bytesused = vb2_get_plane_payload(vb, 0);  in uvc_buffer_prepare()
89 		buf->req_payload_size =  in uvc_buffer_prepare()
90 			  DIV_ROUND_UP(buf->bytesused +  in uvc_buffer_prepare()
91 				       (video->reqs_per_frame * UVCG_REQUEST_HEADER_LEN),  in uvc_buffer_prepare()
92 				       video->reqs_per_frame);  in uvc_buffer_prepare()
100 	struct uvc_video_queue *queue = vb2_get_drv_priv(vb->vb2_queue);  in uvc_buffer_queue()  local
105 	spin_lock_irqsave(&queue->irqlock, flags);  in uvc_buffer_queue()
107 	if (likely(!(queue->flags & UVC_QUEUE_DISCONNECTED))) {  in uvc_buffer_queue()
108 		list_add_tail(&buf->queue, &queue->irqqueue);  in uvc_buffer_queue()
112 		 * directly. The next QBUF call will fail with -ENODEV.  in uvc_buffer_queue()
114 		buf->state = UVC_BUF_STATE_ERROR;  in uvc_buffer_queue()
118 	spin_unlock_irqrestore(&queue->irqlock, flags);  in uvc_buffer_queue()
129 int uvcg_queue_init(struct uvc_video_queue *queue, struct device *dev, enum v4l2_buf_type type,  in uvcg_queue_init()  argument
132 	struct uvc_video *video = container_of(queue, struct uvc_video, queue);  in uvcg_queue_init()
133 	struct usb_composite_dev *cdev = video->uvc->func.config->cdev;  in uvcg_queue_init()
136 	queue->queue.type = type;  in uvcg_queue_init()
137 	queue->queue.io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF;  in uvcg_queue_init()
138 	queue->queue.drv_priv = queue;  in uvcg_queue_init()
139 	queue->queue.buf_struct_size = sizeof(struct uvc_buffer);  in uvcg_queue_init()
140 	queue->queue.ops = &uvc_queue_qops;  in uvcg_queue_init()
141 	queue->queue.lock = lock;  in uvcg_queue_init()
142 	if (cdev->gadget->sg_supported) {  in uvcg_queue_init()
143 		queue->queue.mem_ops = &vb2_dma_sg_memops;  in uvcg_queue_init()
144 		queue->use_sg = 1;  in uvcg_queue_init()
146 		queue->queue.mem_ops = &vb2_vmalloc_memops;  in uvcg_queue_init()
149 	queue->queue.timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_COPY  in uvcg_queue_init()
151 	queue->queue.dev = dev;  in uvcg_queue_init()
153 	ret = vb2_queue_init(&queue->queue);  in uvcg_queue_init()
157 	spin_lock_init(&queue->irqlock);  in uvcg_queue_init()
158 	INIT_LIST_HEAD(&queue->irqqueue);  in uvcg_queue_init()
159 	queue->flags = 0;  in uvcg_queue_init()
167 void uvcg_free_buffers(struct uvc_video_queue *queue)  in uvcg_free_buffers()  argument
169 	vb2_queue_release(&queue->queue);  in uvcg_free_buffers()
175 int uvcg_alloc_buffers(struct uvc_video_queue *queue,  in uvcg_alloc_buffers()  argument
180 	ret = vb2_reqbufs(&queue->queue, rb);  in uvcg_alloc_buffers()
182 	return ret ? ret : rb->count;  in uvcg_alloc_buffers()
185 int uvcg_query_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf)  in uvcg_query_buffer()  argument
187 	return vb2_querybuf(&queue->queue, buf);  in uvcg_query_buffer()
190 int uvcg_queue_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf)  in uvcg_queue_buffer()  argument
192 	return vb2_qbuf(&queue->queue, NULL, buf);  in uvcg_queue_buffer()
199 int uvcg_dequeue_buffer(struct uvc_video_queue *queue, struct v4l2_buffer *buf,  in uvcg_dequeue_buffer()  argument
202 	return vb2_dqbuf(&queue->queue, buf, nonblocking);  in uvcg_dequeue_buffer()
206  * Poll the video queue.
208  * This function implements video queue polling and is intended to be used by
211 __poll_t uvcg_queue_poll(struct uvc_video_queue *queue, struct file *file,  in uvcg_queue_poll()  argument
212 			     poll_table *wait)  in uvcg_queue_poll()  argument
214 	return vb2_poll(&queue->queue, file, wait);  in uvcg_queue_poll()
217 int uvcg_queue_mmap(struct uvc_video_queue *queue, struct vm_area_struct *vma)  in uvcg_queue_mmap()  argument
219 	return vb2_mmap(&queue->queue, vma);  in uvcg_queue_mmap()
226  * NO-MMU arch need this function to make mmap() work correctly.
228 unsigned long uvcg_queue_get_unmapped_area(struct uvc_video_queue *queue,  in uvcg_queue_get_unmapped_area()  argument
231 	return vb2_get_unmapped_area(&queue->queue, 0, 0, pgoff, 0);  in uvcg_queue_get_unmapped_area()
236  * Cancel the video buffers queue.
238  * Cancelling the queue marks all buffers on the irq queue as erroneous,
239  * wakes them up and removes them from the queue.
242  * fail with -ENODEV.
247 void uvcg_queue_cancel(struct uvc_video_queue *queue, int disconnect)  in uvcg_queue_cancel()  argument
252 	spin_lock_irqsave(&queue->irqlock, flags);  in uvcg_queue_cancel()
253 	while (!list_empty(&queue->irqqueue)) {  in uvcg_queue_cancel()
254 		buf = list_first_entry(&queue->irqqueue, struct uvc_buffer,  in uvcg_queue_cancel()
255 				       queue);  in uvcg_queue_cancel()
256 		list_del(&buf->queue);  in uvcg_queue_cancel()
257 		buf->state = UVC_BUF_STATE_ERROR;  in uvcg_queue_cancel()
258 		vb2_buffer_done(&buf->buf.vb2_buf, VB2_BUF_STATE_ERROR);  in uvcg_queue_cancel()
260 	queue->buf_used = 0;  in uvcg_queue_cancel()
265 	 * could result in an interruptible wait in uvc_dequeue_buffer. Do not  in uvcg_queue_cancel()
267 	 * state outside the queue code.  in uvcg_queue_cancel()
270 		queue->flags |= UVC_QUEUE_DISCONNECTED;  in uvcg_queue_cancel()
271 	spin_unlock_irqrestore(&queue->irqlock, flags);  in uvcg_queue_cancel()
275  * Enable or disable the video buffers queue.
277  * The queue must be enabled before starting video acquisition and must be
278  * disabled after stopping it. This ensures that the video buffers queue
282  * Enabling the video queue initializes parameters (such as sequence number,
283  * sync pattern, ...). If the queue is already enabled, return -EBUSY.
285  * Disabling the video queue cancels the queue and removes all buffers from
286  * the main queue.
291 int uvcg_queue_enable(struct uvc_video_queue *queue, int enable)  in uvcg_queue_enable()  argument
297 		ret = vb2_streamon(&queue->queue, queue->queue.type);  in uvcg_queue_enable()
301 		queue->sequence = 0;  in uvcg_queue_enable()
302 		queue->buf_used = 0;  in uvcg_queue_enable()
303 		queue->flags &= ~UVC_QUEUE_DROP_INCOMPLETE;  in uvcg_queue_enable()
305 		ret = vb2_streamoff(&queue->queue, queue->queue.type);  in uvcg_queue_enable()
309 		spin_lock_irqsave(&queue->irqlock, flags);  in uvcg_queue_enable()
310 		INIT_LIST_HEAD(&queue->irqqueue);  in uvcg_queue_enable()
314 		 * applications will be able to queue buffers for the next  in uvcg_queue_enable()
318 		queue->flags &= ~UVC_QUEUE_DISCONNECTED;  in uvcg_queue_enable()
319 		spin_unlock_irqrestore(&queue->irqlock, flags);  in uvcg_queue_enable()
326 void uvcg_complete_buffer(struct uvc_video_queue *queue,  in uvcg_complete_buffer()  argument
329 	if (queue->flags & UVC_QUEUE_DROP_INCOMPLETE) {  in uvcg_complete_buffer()
330 		queue->flags &= ~UVC_QUEUE_DROP_INCOMPLETE;  in uvcg_complete_buffer()
331 		buf->state = UVC_BUF_STATE_ERROR;  in uvcg_complete_buffer()
332 		vb2_set_plane_payload(&buf->buf.vb2_buf, 0, 0);  in uvcg_complete_buffer()
333 		vb2_buffer_done(&buf->buf.vb2_buf, VB2_BUF_STATE_ERROR);  in uvcg_complete_buffer()
337 	buf->buf.field = V4L2_FIELD_NONE;  in uvcg_complete_buffer()
338 	buf->buf.sequence = queue->sequence++;  in uvcg_complete_buffer()
339 	buf->buf.vb2_buf.timestamp = ktime_get_ns();  in uvcg_complete_buffer()
341 	vb2_set_plane_payload(&buf->buf.vb2_buf, 0, buf->bytesused);  in uvcg_complete_buffer()
342 	vb2_buffer_done(&buf->buf.vb2_buf, VB2_BUF_STATE_DONE);  in uvcg_complete_buffer()
345 struct uvc_buffer *uvcg_queue_head(struct uvc_video_queue *queue)  in uvcg_queue_head()  argument
349 	if (!list_empty(&queue->irqqueue))  in uvcg_queue_head()
350 		buf = list_first_entry(&queue->irqqueue, struct uvc_buffer,  in uvcg_queue_head()
351 				       queue);  in uvcg_queue_head()