1 /* 2 * videobuf2-core.h - V4L2 driver helper framework 3 * 4 * Copyright (C) 2010 Samsung Electronics 5 * 6 * Author: Pawel Osciak <pawel@osciak.com> 7 * 8 * This program is free software; you can redistribute it and/or modify 9 * it under the terms of the GNU General Public License as published by 10 * the Free Software Foundation. 11 */ 12 #ifndef _MEDIA_VIDEOBUF2_CORE_H 13 #define _MEDIA_VIDEOBUF2_CORE_H 14 15 #include <linux/mm_types.h> 16 #include <linux/mutex.h> 17 #include <linux/poll.h> 18 #include <linux/videodev2.h> 19 #include <linux/dma-buf.h> 20 21 struct vb2_alloc_ctx; 22 struct vb2_fileio_data; 23 struct vb2_threadio_data; 24 25 /** 26 * struct vb2_mem_ops - memory handling/memory allocator operations 27 * @alloc: allocate video memory and, optionally, allocator private data, 28 * return NULL on failure or a pointer to allocator private, 29 * per-buffer data on success; the returned private structure 30 * will then be passed as buf_priv argument to other ops in this 31 * structure. Additional gfp_flags to use when allocating the 32 * are also passed to this operation. These flags are from the 33 * gfp_flags field of vb2_queue. 34 * @put: inform the allocator that the buffer will no longer be used; 35 * usually will result in the allocator freeing the buffer (if 36 * no other users of this buffer are present); the buf_priv 37 * argument is the allocator private per-buffer structure 38 * previously returned from the alloc callback. 39 * @get_userptr: acquire userspace memory for a hardware operation; used for 40 * USERPTR memory types; vaddr is the address passed to the 41 * videobuf layer when queuing a video buffer of USERPTR type; 42 * should return an allocator private per-buffer structure 43 * associated with the buffer on success, NULL on failure; 44 * the returned private structure will then be passed as buf_priv 45 * argument to other ops in this structure. 46 * @put_userptr: inform the allocator that a USERPTR buffer will no longer 47 * be used. 48 * @attach_dmabuf: attach a shared struct dma_buf for a hardware operation; 49 * used for DMABUF memory types; alloc_ctx is the alloc context 50 * dbuf is the shared dma_buf; returns NULL on failure; 51 * allocator private per-buffer structure on success; 52 * this needs to be used for further accesses to the buffer. 53 * @detach_dmabuf: inform the exporter of the buffer that the current DMABUF 54 * buffer is no longer used; the buf_priv argument is the 55 * allocator private per-buffer structure previously returned 56 * from the attach_dmabuf callback. 57 * @map_dmabuf: request for access to the dmabuf from allocator; the allocator 58 * of dmabuf is informed that this driver is going to use the 59 * dmabuf. 60 * @unmap_dmabuf: releases access control to the dmabuf - allocator is notified 61 * that this driver is done using the dmabuf for now. 62 * @prepare: called every time the buffer is passed from userspace to the 63 * driver, useful for cache synchronisation, optional. 64 * @finish: called every time the buffer is passed back from the driver 65 * to the userspace, also optional. 66 * @vaddr: return a kernel virtual address to a given memory buffer 67 * associated with the passed private structure or NULL if no 68 * such mapping exists. 69 * @cookie: return allocator specific cookie for a given memory buffer 70 * associated with the passed private structure or NULL if not 71 * available. 72 * @num_users: return the current number of users of a memory buffer; 73 * return 1 if the videobuf layer (or actually the driver using 74 * it) is the only user. 75 * @mmap: setup a userspace mapping for a given memory buffer under 76 * the provided virtual memory region. 77 * 78 * Required ops for USERPTR types: get_userptr, put_userptr. 79 * Required ops for MMAP types: alloc, put, num_users, mmap. 80 * Required ops for read/write access types: alloc, put, num_users, vaddr. 81 * Required ops for DMABUF types: attach_dmabuf, detach_dmabuf, map_dmabuf, 82 * unmap_dmabuf. 83 */ 84 struct vb2_mem_ops { 85 void *(*alloc)(void *alloc_ctx, unsigned long size, 86 enum dma_data_direction dma_dir, 87 gfp_t gfp_flags); 88 void (*put)(void *buf_priv); 89 struct dma_buf *(*get_dmabuf)(void *buf_priv, unsigned long flags); 90 91 void *(*get_userptr)(void *alloc_ctx, unsigned long vaddr, 92 unsigned long size, 93 enum dma_data_direction dma_dir); 94 void (*put_userptr)(void *buf_priv); 95 96 void (*prepare)(void *buf_priv); 97 void (*finish)(void *buf_priv); 98 99 void *(*attach_dmabuf)(void *alloc_ctx, struct dma_buf *dbuf, 100 unsigned long size, 101 enum dma_data_direction dma_dir); 102 void (*detach_dmabuf)(void *buf_priv); 103 int (*map_dmabuf)(void *buf_priv); 104 void (*unmap_dmabuf)(void *buf_priv); 105 106 void *(*vaddr)(void *buf_priv); 107 void *(*cookie)(void *buf_priv); 108 109 unsigned int (*num_users)(void *buf_priv); 110 111 int (*mmap)(void *buf_priv, struct vm_area_struct *vma); 112 }; 113 114 struct vb2_plane { 115 void *mem_priv; 116 struct dma_buf *dbuf; 117 unsigned int dbuf_mapped; 118 }; 119 120 /** 121 * enum vb2_io_modes - queue access methods 122 * @VB2_MMAP: driver supports MMAP with streaming API 123 * @VB2_USERPTR: driver supports USERPTR with streaming API 124 * @VB2_READ: driver supports read() style access 125 * @VB2_WRITE: driver supports write() style access 126 * @VB2_DMABUF: driver supports DMABUF with streaming API 127 */ 128 enum vb2_io_modes { 129 VB2_MMAP = (1 << 0), 130 VB2_USERPTR = (1 << 1), 131 VB2_READ = (1 << 2), 132 VB2_WRITE = (1 << 3), 133 VB2_DMABUF = (1 << 4), 134 }; 135 136 /** 137 * enum vb2_buffer_state - current video buffer state 138 * @VB2_BUF_STATE_DEQUEUED: buffer under userspace control 139 * @VB2_BUF_STATE_PREPARING: buffer is being prepared in videobuf 140 * @VB2_BUF_STATE_PREPARED: buffer prepared in videobuf and by the driver 141 * @VB2_BUF_STATE_QUEUED: buffer queued in videobuf, but not in driver 142 * @VB2_BUF_STATE_ACTIVE: buffer queued in driver and possibly used 143 * in a hardware operation 144 * @VB2_BUF_STATE_DONE: buffer returned from driver to videobuf, but 145 * not yet dequeued to userspace 146 * @VB2_BUF_STATE_ERROR: same as above, but the operation on the buffer 147 * has ended with an error, which will be reported 148 * to the userspace when it is dequeued 149 */ 150 enum vb2_buffer_state { 151 VB2_BUF_STATE_DEQUEUED, 152 VB2_BUF_STATE_PREPARING, 153 VB2_BUF_STATE_PREPARED, 154 VB2_BUF_STATE_QUEUED, 155 VB2_BUF_STATE_ACTIVE, 156 VB2_BUF_STATE_DONE, 157 VB2_BUF_STATE_ERROR, 158 }; 159 160 struct vb2_queue; 161 162 /** 163 * struct vb2_buffer - represents a video buffer 164 * @v4l2_buf: struct v4l2_buffer associated with this buffer; can 165 * be read by the driver and relevant entries can be 166 * changed by the driver in case of CAPTURE types 167 * (such as timestamp) 168 * @v4l2_planes: struct v4l2_planes associated with this buffer; can 169 * be read by the driver and relevant entries can be 170 * changed by the driver in case of CAPTURE types 171 * (such as bytesused); NOTE that even for single-planar 172 * types, the v4l2_planes[0] struct should be used 173 * instead of v4l2_buf for filling bytesused - drivers 174 * should use the vb2_set_plane_payload() function for that 175 * @vb2_queue: the queue to which this driver belongs 176 * @num_planes: number of planes in the buffer 177 * on an internal driver queue 178 * @state: current buffer state; do not change 179 * @queued_entry: entry on the queued buffers list, which holds all 180 * buffers queued from userspace 181 * @done_entry: entry on the list that stores all buffers ready to 182 * be dequeued to userspace 183 * @planes: private per-plane information; do not change 184 */ 185 struct vb2_buffer { 186 struct v4l2_buffer v4l2_buf; 187 struct v4l2_plane v4l2_planes[VIDEO_MAX_PLANES]; 188 189 struct vb2_queue *vb2_queue; 190 191 unsigned int num_planes; 192 193 /* Private: internal use only */ 194 enum vb2_buffer_state state; 195 196 struct list_head queued_entry; 197 struct list_head done_entry; 198 199 struct vb2_plane planes[VIDEO_MAX_PLANES]; 200 201 #ifdef CONFIG_VIDEO_ADV_DEBUG 202 /* 203 * Counters for how often these buffer-related ops are 204 * called. Used to check for unbalanced ops. 205 */ 206 u32 cnt_mem_alloc; 207 u32 cnt_mem_put; 208 u32 cnt_mem_get_dmabuf; 209 u32 cnt_mem_get_userptr; 210 u32 cnt_mem_put_userptr; 211 u32 cnt_mem_prepare; 212 u32 cnt_mem_finish; 213 u32 cnt_mem_attach_dmabuf; 214 u32 cnt_mem_detach_dmabuf; 215 u32 cnt_mem_map_dmabuf; 216 u32 cnt_mem_unmap_dmabuf; 217 u32 cnt_mem_vaddr; 218 u32 cnt_mem_cookie; 219 u32 cnt_mem_num_users; 220 u32 cnt_mem_mmap; 221 222 u32 cnt_buf_init; 223 u32 cnt_buf_prepare; 224 u32 cnt_buf_finish; 225 u32 cnt_buf_cleanup; 226 u32 cnt_buf_queue; 227 228 /* This counts the number of calls to vb2_buffer_done() */ 229 u32 cnt_buf_done; 230 #endif 231 }; 232 233 /** 234 * struct vb2_ops - driver-specific callbacks 235 * 236 * @queue_setup: called from VIDIOC_REQBUFS and VIDIOC_CREATE_BUFS 237 * handlers before memory allocation, or, if 238 * *num_planes != 0, after the allocation to verify a 239 * smaller number of buffers. Driver should return 240 * the required number of buffers in *num_buffers, the 241 * required number of planes per buffer in *num_planes; the 242 * size of each plane should be set in the sizes[] array 243 * and optional per-plane allocator specific context in the 244 * alloc_ctxs[] array. When called from VIDIOC_REQBUFS, 245 * fmt == NULL, the driver has to use the currently 246 * configured format and *num_buffers is the total number 247 * of buffers, that are being allocated. When called from 248 * VIDIOC_CREATE_BUFS, fmt != NULL and it describes the 249 * target frame format (if the format isn't valid the 250 * callback must return -EINVAL). In this case *num_buffers 251 * are being allocated additionally to q->num_buffers. 252 * @wait_prepare: release any locks taken while calling vb2 functions; 253 * it is called before an ioctl needs to wait for a new 254 * buffer to arrive; required to avoid a deadlock in 255 * blocking access type. 256 * @wait_finish: reacquire all locks released in the previous callback; 257 * required to continue operation after sleeping while 258 * waiting for a new buffer to arrive. 259 * @buf_init: called once after allocating a buffer (in MMAP case) 260 * or after acquiring a new USERPTR buffer; drivers may 261 * perform additional buffer-related initialization; 262 * initialization failure (return != 0) will prevent 263 * queue setup from completing successfully; optional. 264 * @buf_prepare: called every time the buffer is queued from userspace 265 * and from the VIDIOC_PREPARE_BUF ioctl; drivers may 266 * perform any initialization required before each 267 * hardware operation in this callback; drivers can 268 * access/modify the buffer here as it is still synced for 269 * the CPU; drivers that support VIDIOC_CREATE_BUFS must 270 * also validate the buffer size; if an error is returned, 271 * the buffer will not be queued in driver; optional. 272 * @buf_finish: called before every dequeue of the buffer back to 273 * userspace; the buffer is synced for the CPU, so drivers 274 * can access/modify the buffer contents; drivers may 275 * perform any operations required before userspace 276 * accesses the buffer; optional. The buffer state can be 277 * one of the following: DONE and ERROR occur while 278 * streaming is in progress, and the PREPARED state occurs 279 * when the queue has been canceled and all pending 280 * buffers are being returned to their default DEQUEUED 281 * state. Typically you only have to do something if the 282 * state is VB2_BUF_STATE_DONE, since in all other cases 283 * the buffer contents will be ignored anyway. 284 * @buf_cleanup: called once before the buffer is freed; drivers may 285 * perform any additional cleanup; optional. 286 * @start_streaming: called once to enter 'streaming' state; the driver may 287 * receive buffers with @buf_queue callback before 288 * @start_streaming is called; the driver gets the number 289 * of already queued buffers in count parameter; driver 290 * can return an error if hardware fails, in that case all 291 * buffers that have been already given by the @buf_queue 292 * callback are to be returned by the driver by calling 293 * @vb2_buffer_done(VB2_BUF_STATE_QUEUED). 294 * If you need a minimum number of buffers before you can 295 * start streaming, then set @min_buffers_needed in the 296 * vb2_queue structure. If that is non-zero then 297 * start_streaming won't be called until at least that 298 * many buffers have been queued up by userspace. 299 * @stop_streaming: called when 'streaming' state must be disabled; driver 300 * should stop any DMA transactions or wait until they 301 * finish and give back all buffers it got from buf_queue() 302 * callback by calling @vb2_buffer_done() with either 303 * VB2_BUF_STATE_DONE or VB2_BUF_STATE_ERROR; may use 304 * vb2_wait_for_all_buffers() function 305 * @buf_queue: passes buffer vb to the driver; driver may start 306 * hardware operation on this buffer; driver should give 307 * the buffer back by calling vb2_buffer_done() function; 308 * it is allways called after calling STREAMON ioctl; 309 * might be called before start_streaming callback if user 310 * pre-queued buffers before calling STREAMON. 311 */ 312 struct vb2_ops { 313 int (*queue_setup)(struct vb2_queue *q, const struct v4l2_format *fmt, 314 unsigned int *num_buffers, unsigned int *num_planes, 315 unsigned int sizes[], void *alloc_ctxs[]); 316 317 void (*wait_prepare)(struct vb2_queue *q); 318 void (*wait_finish)(struct vb2_queue *q); 319 320 int (*buf_init)(struct vb2_buffer *vb); 321 int (*buf_prepare)(struct vb2_buffer *vb); 322 void (*buf_finish)(struct vb2_buffer *vb); 323 void (*buf_cleanup)(struct vb2_buffer *vb); 324 325 int (*start_streaming)(struct vb2_queue *q, unsigned int count); 326 void (*stop_streaming)(struct vb2_queue *q); 327 328 void (*buf_queue)(struct vb2_buffer *vb); 329 }; 330 331 struct v4l2_fh; 332 333 /** 334 * struct vb2_queue - a videobuf queue 335 * 336 * @type: queue type (see V4L2_BUF_TYPE_* in linux/videodev2.h 337 * @io_modes: supported io methods (see vb2_io_modes enum) 338 * @fileio_read_once: report EOF after reading the first buffer 339 * @fileio_write_immediately: queue buffer after each write() call 340 * @allow_zero_bytesused: allow bytesused == 0 to be passed to the driver 341 * @lock: pointer to a mutex that protects the vb2_queue struct. The 342 * driver can set this to a mutex to let the v4l2 core serialize 343 * the queuing ioctls. If the driver wants to handle locking 344 * itself, then this should be set to NULL. This lock is not used 345 * by the videobuf2 core API. 346 * @owner: The filehandle that 'owns' the buffers, i.e. the filehandle 347 * that called reqbufs, create_buffers or started fileio. 348 * This field is not used by the videobuf2 core API, but it allows 349 * drivers to easily associate an owner filehandle with the queue. 350 * @ops: driver-specific callbacks 351 * @mem_ops: memory allocator specific callbacks 352 * @drv_priv: driver private data 353 * @buf_struct_size: size of the driver-specific buffer structure; 354 * "0" indicates the driver doesn't want to use a custom buffer 355 * structure type, so sizeof(struct vb2_buffer) will is used 356 * @timestamp_flags: Timestamp flags; V4L2_BUF_FLAG_TIMESTAMP_* and 357 * V4L2_BUF_FLAG_TSTAMP_SRC_* 358 * @gfp_flags: additional gfp flags used when allocating the buffers. 359 * Typically this is 0, but it may be e.g. GFP_DMA or __GFP_DMA32 360 * to force the buffer allocation to a specific memory zone. 361 * @min_buffers_needed: the minimum number of buffers needed before 362 * start_streaming() can be called. Used when a DMA engine 363 * cannot be started unless at least this number of buffers 364 * have been queued into the driver. 365 * 366 * @mmap_lock: private mutex used when buffers are allocated/freed/mmapped 367 * @memory: current memory type used 368 * @bufs: videobuf buffer structures 369 * @num_buffers: number of allocated/used buffers 370 * @queued_list: list of buffers currently queued from userspace 371 * @queued_count: number of buffers queued and ready for streaming. 372 * @owned_by_drv_count: number of buffers owned by the driver 373 * @done_list: list of buffers ready to be dequeued to userspace 374 * @done_lock: lock to protect done_list list 375 * @done_wq: waitqueue for processes waiting for buffers ready to be dequeued 376 * @alloc_ctx: memory type/allocator-specific contexts for each plane 377 * @streaming: current streaming state 378 * @start_streaming_called: start_streaming() was called successfully and we 379 * started streaming. 380 * @error: a fatal error occurred on the queue 381 * @waiting_for_buffers: used in poll() to check if vb2 is still waiting for 382 * buffers. Only set for capture queues if qbuf has not yet been 383 * called since poll() needs to return POLLERR in that situation. 384 * @last_buffer_dequeued: used in poll() and DQBUF to immediately return if the 385 * last decoded buffer was already dequeued. Set for capture queues 386 * when a buffer with the V4L2_BUF_FLAG_LAST is dequeued. 387 * @fileio: file io emulator internal data, used only if emulator is active 388 * @threadio: thread io internal data, used only if thread is active 389 */ 390 struct vb2_queue { 391 enum v4l2_buf_type type; 392 unsigned int io_modes; 393 unsigned fileio_read_once:1; 394 unsigned fileio_write_immediately:1; 395 unsigned allow_zero_bytesused:1; 396 397 struct mutex *lock; 398 struct v4l2_fh *owner; 399 400 const struct vb2_ops *ops; 401 const struct vb2_mem_ops *mem_ops; 402 void *drv_priv; 403 unsigned int buf_struct_size; 404 u32 timestamp_flags; 405 gfp_t gfp_flags; 406 u32 min_buffers_needed; 407 408 /* private: internal use only */ 409 struct mutex mmap_lock; 410 enum v4l2_memory memory; 411 struct vb2_buffer *bufs[VIDEO_MAX_FRAME]; 412 unsigned int num_buffers; 413 414 struct list_head queued_list; 415 unsigned int queued_count; 416 417 atomic_t owned_by_drv_count; 418 struct list_head done_list; 419 spinlock_t done_lock; 420 wait_queue_head_t done_wq; 421 422 void *alloc_ctx[VIDEO_MAX_PLANES]; 423 unsigned int plane_sizes[VIDEO_MAX_PLANES]; 424 425 unsigned int streaming:1; 426 unsigned int start_streaming_called:1; 427 unsigned int error:1; 428 unsigned int waiting_for_buffers:1; 429 unsigned int last_buffer_dequeued:1; 430 431 struct vb2_fileio_data *fileio; 432 struct vb2_threadio_data *threadio; 433 434 #ifdef CONFIG_VIDEO_ADV_DEBUG 435 /* 436 * Counters for how often these queue-related ops are 437 * called. Used to check for unbalanced ops. 438 */ 439 u32 cnt_queue_setup; 440 u32 cnt_wait_prepare; 441 u32 cnt_wait_finish; 442 u32 cnt_start_streaming; 443 u32 cnt_stop_streaming; 444 #endif 445 }; 446 447 void *vb2_plane_vaddr(struct vb2_buffer *vb, unsigned int plane_no); 448 void *vb2_plane_cookie(struct vb2_buffer *vb, unsigned int plane_no); 449 450 void vb2_buffer_done(struct vb2_buffer *vb, enum vb2_buffer_state state); 451 void vb2_discard_done(struct vb2_queue *q); 452 int vb2_wait_for_all_buffers(struct vb2_queue *q); 453 454 int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b); 455 int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req); 456 457 int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create); 458 int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b); 459 460 int __must_check vb2_queue_init(struct vb2_queue *q); 461 462 void vb2_queue_release(struct vb2_queue *q); 463 void vb2_queue_error(struct vb2_queue *q); 464 465 int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b); 466 int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb); 467 int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking); 468 469 int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type); 470 int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type); 471 472 int vb2_mmap(struct vb2_queue *q, struct vm_area_struct *vma); 473 #ifndef CONFIG_MMU 474 unsigned long vb2_get_unmapped_area(struct vb2_queue *q, 475 unsigned long addr, 476 unsigned long len, 477 unsigned long pgoff, 478 unsigned long flags); 479 #endif 480 unsigned int vb2_poll(struct vb2_queue *q, struct file *file, poll_table *wait); 481 size_t vb2_read(struct vb2_queue *q, char __user *data, size_t count, 482 loff_t *ppos, int nonblock); 483 size_t vb2_write(struct vb2_queue *q, const char __user *data, size_t count, 484 loff_t *ppos, int nonblock); 485 /** 486 * vb2_thread_fnc - callback function for use with vb2_thread 487 * 488 * This is called whenever a buffer is dequeued in the thread. 489 */ 490 typedef int (*vb2_thread_fnc)(struct vb2_buffer *vb, void *priv); 491 492 /** 493 * vb2_thread_start() - start a thread for the given queue. 494 * @q: videobuf queue 495 * @fnc: callback function 496 * @priv: priv pointer passed to the callback function 497 * @thread_name:the name of the thread. This will be prefixed with "vb2-". 498 * 499 * This starts a thread that will queue and dequeue until an error occurs 500 * or @vb2_thread_stop is called. 501 * 502 * This function should not be used for anything else but the videobuf2-dvb 503 * support. If you think you have another good use-case for this, then please 504 * contact the linux-media mailinglist first. 505 */ 506 int vb2_thread_start(struct vb2_queue *q, vb2_thread_fnc fnc, void *priv, 507 const char *thread_name); 508 509 /** 510 * vb2_thread_stop() - stop the thread for the given queue. 511 * @q: videobuf queue 512 */ 513 int vb2_thread_stop(struct vb2_queue *q); 514 515 /** 516 * vb2_is_streaming() - return streaming status of the queue 517 * @q: videobuf queue 518 */ 519 static inline bool vb2_is_streaming(struct vb2_queue *q) 520 { 521 return q->streaming; 522 } 523 524 /** 525 * vb2_fileio_is_active() - return true if fileio is active. 526 * @q: videobuf queue 527 * 528 * This returns true if read() or write() is used to stream the data 529 * as opposed to stream I/O. This is almost never an important distinction, 530 * except in rare cases. One such case is that using read() or write() to 531 * stream a format using V4L2_FIELD_ALTERNATE is not allowed since there 532 * is no way you can pass the field information of each buffer to/from 533 * userspace. A driver that supports this field format should check for 534 * this in the queue_setup op and reject it if this function returns true. 535 */ 536 static inline bool vb2_fileio_is_active(struct vb2_queue *q) 537 { 538 return q->fileio; 539 } 540 541 /** 542 * vb2_is_busy() - return busy status of the queue 543 * @q: videobuf queue 544 * 545 * This function checks if queue has any buffers allocated. 546 */ 547 static inline bool vb2_is_busy(struct vb2_queue *q) 548 { 549 return (q->num_buffers > 0); 550 } 551 552 /** 553 * vb2_get_drv_priv() - return driver private data associated with the queue 554 * @q: videobuf queue 555 */ 556 static inline void *vb2_get_drv_priv(struct vb2_queue *q) 557 { 558 return q->drv_priv; 559 } 560 561 /** 562 * vb2_set_plane_payload() - set bytesused for the plane plane_no 563 * @vb: buffer for which plane payload should be set 564 * @plane_no: plane number for which payload should be set 565 * @size: payload in bytes 566 */ 567 static inline void vb2_set_plane_payload(struct vb2_buffer *vb, 568 unsigned int plane_no, unsigned long size) 569 { 570 if (plane_no < vb->num_planes) 571 vb->v4l2_planes[plane_no].bytesused = size; 572 } 573 574 /** 575 * vb2_get_plane_payload() - get bytesused for the plane plane_no 576 * @vb: buffer for which plane payload should be set 577 * @plane_no: plane number for which payload should be set 578 * @size: payload in bytes 579 */ 580 static inline unsigned long vb2_get_plane_payload(struct vb2_buffer *vb, 581 unsigned int plane_no) 582 { 583 if (plane_no < vb->num_planes) 584 return vb->v4l2_planes[plane_no].bytesused; 585 return 0; 586 } 587 588 /** 589 * vb2_plane_size() - return plane size in bytes 590 * @vb: buffer for which plane size should be returned 591 * @plane_no: plane number for which size should be returned 592 */ 593 static inline unsigned long 594 vb2_plane_size(struct vb2_buffer *vb, unsigned int plane_no) 595 { 596 if (plane_no < vb->num_planes) 597 return vb->v4l2_planes[plane_no].length; 598 return 0; 599 } 600 601 /** 602 * vb2_start_streaming_called() - return streaming status of driver 603 * @q: videobuf queue 604 */ 605 static inline bool vb2_start_streaming_called(struct vb2_queue *q) 606 { 607 return q->start_streaming_called; 608 } 609 610 /** 611 * vb2_clear_last_buffer_dequeued() - clear last buffer dequeued flag of queue 612 * @q: videobuf queue 613 */ 614 static inline void vb2_clear_last_buffer_dequeued(struct vb2_queue *q) 615 { 616 q->last_buffer_dequeued = false; 617 } 618 619 /* 620 * The following functions are not part of the vb2 core API, but are simple 621 * helper functions that you can use in your struct v4l2_file_operations, 622 * struct v4l2_ioctl_ops and struct vb2_ops. They will serialize if vb2_queue->lock 623 * or video_device->lock is set, and they will set and test vb2_queue->owner 624 * to check if the calling filehandle is permitted to do the queuing operation. 625 */ 626 627 /* struct v4l2_ioctl_ops helpers */ 628 629 int vb2_ioctl_reqbufs(struct file *file, void *priv, 630 struct v4l2_requestbuffers *p); 631 int vb2_ioctl_create_bufs(struct file *file, void *priv, 632 struct v4l2_create_buffers *p); 633 int vb2_ioctl_prepare_buf(struct file *file, void *priv, 634 struct v4l2_buffer *p); 635 int vb2_ioctl_querybuf(struct file *file, void *priv, struct v4l2_buffer *p); 636 int vb2_ioctl_qbuf(struct file *file, void *priv, struct v4l2_buffer *p); 637 int vb2_ioctl_dqbuf(struct file *file, void *priv, struct v4l2_buffer *p); 638 int vb2_ioctl_streamon(struct file *file, void *priv, enum v4l2_buf_type i); 639 int vb2_ioctl_streamoff(struct file *file, void *priv, enum v4l2_buf_type i); 640 int vb2_ioctl_expbuf(struct file *file, void *priv, 641 struct v4l2_exportbuffer *p); 642 643 /* struct v4l2_file_operations helpers */ 644 645 int vb2_fop_mmap(struct file *file, struct vm_area_struct *vma); 646 int vb2_fop_release(struct file *file); 647 int _vb2_fop_release(struct file *file, struct mutex *lock); 648 ssize_t vb2_fop_write(struct file *file, const char __user *buf, 649 size_t count, loff_t *ppos); 650 ssize_t vb2_fop_read(struct file *file, char __user *buf, 651 size_t count, loff_t *ppos); 652 unsigned int vb2_fop_poll(struct file *file, poll_table *wait); 653 #ifndef CONFIG_MMU 654 unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr, 655 unsigned long len, unsigned long pgoff, unsigned long flags); 656 #endif 657 658 /* struct vb2_ops helpers, only use if vq->lock is non-NULL. */ 659 660 void vb2_ops_wait_prepare(struct vb2_queue *vq); 661 void vb2_ops_wait_finish(struct vb2_queue *vq); 662 663 #endif /* _MEDIA_VIDEOBUF2_CORE_H */ 664