diff options
author | Hans Verkuil <hans.verkuil@cisco.com> | 2014-02-28 10:25:28 -0500 |
---|---|---|
committer | Mauro Carvalho Chehab <m.chehab@samsung.com> | 2014-03-11 05:56:39 -0400 |
commit | 3f12e6b0d91a68f977f803ed03757a2fa9ba6b9f (patch) | |
tree | 8facc3378f801ecbbd29a733672653f4ba591b53 | |
parent | 9c0863b1cc485f2bacac0675c68b73e5341cfd26 (diff) |
[media] vb2: consistent usage of periods in videobuf2-core.h
Sometimes sentences in comments ended with a period, and sometimes they
didn't. Add periods. No other changes.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
-rw-r--r-- | include/media/videobuf2-core.h | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/include/media/videobuf2-core.h b/include/media/videobuf2-core.h index 2ffcb81aee9c..b852b39cc6dc 100644 --- a/include/media/videobuf2-core.h +++ b/include/media/videobuf2-core.h | |||
@@ -34,49 +34,49 @@ struct vb2_fileio_data; | |||
34 | * usually will result in the allocator freeing the buffer (if | 34 | * usually will result in the allocator freeing the buffer (if |
35 | * no other users of this buffer are present); the buf_priv | 35 | * no other users of this buffer are present); the buf_priv |
36 | * argument is the allocator private per-buffer structure | 36 | * argument is the allocator private per-buffer structure |
37 | * previously returned from the alloc callback | 37 | * previously returned from the alloc callback. |
38 | * @get_userptr: acquire userspace memory for a hardware operation; used for | 38 | * @get_userptr: acquire userspace memory for a hardware operation; used for |
39 | * USERPTR memory types; vaddr is the address passed to the | 39 | * USERPTR memory types; vaddr is the address passed to the |
40 | * videobuf layer when queuing a video buffer of USERPTR type; | 40 | * videobuf layer when queuing a video buffer of USERPTR type; |
41 | * should return an allocator private per-buffer structure | 41 | * should return an allocator private per-buffer structure |
42 | * associated with the buffer on success, NULL on failure; | 42 | * associated with the buffer on success, NULL on failure; |
43 | * the returned private structure will then be passed as buf_priv | 43 | * the returned private structure will then be passed as buf_priv |
44 | * argument to other ops in this structure | 44 | * argument to other ops in this structure. |
45 | * @put_userptr: inform the allocator that a USERPTR buffer will no longer | 45 | * @put_userptr: inform the allocator that a USERPTR buffer will no longer |
46 | * be used | 46 | * be used. |
47 | * @attach_dmabuf: attach a shared struct dma_buf for a hardware operation; | 47 | * @attach_dmabuf: attach a shared struct dma_buf for a hardware operation; |
48 | * used for DMABUF memory types; alloc_ctx is the alloc context | 48 | * used for DMABUF memory types; alloc_ctx is the alloc context |
49 | * dbuf is the shared dma_buf; returns NULL on failure; | 49 | * dbuf is the shared dma_buf; returns NULL on failure; |
50 | * allocator private per-buffer structure on success; | 50 | * allocator private per-buffer structure on success; |
51 | * this needs to be used for further accesses to the buffer | 51 | * this needs to be used for further accesses to the buffer. |
52 | * @detach_dmabuf: inform the exporter of the buffer that the current DMABUF | 52 | * @detach_dmabuf: inform the exporter of the buffer that the current DMABUF |
53 | * buffer is no longer used; the buf_priv argument is the | 53 | * buffer is no longer used; the buf_priv argument is the |
54 | * allocator private per-buffer structure previously returned | 54 | * allocator private per-buffer structure previously returned |
55 | * from the attach_dmabuf callback | 55 | * from the attach_dmabuf callback. |
56 | * @map_dmabuf: request for access to the dmabuf from allocator; the allocator | 56 | * @map_dmabuf: request for access to the dmabuf from allocator; the allocator |
57 | * of dmabuf is informed that this driver is going to use the | 57 | * of dmabuf is informed that this driver is going to use the |
58 | * dmabuf | 58 | * dmabuf. |
59 | * @unmap_dmabuf: releases access control to the dmabuf - allocator is notified | 59 | * @unmap_dmabuf: releases access control to the dmabuf - allocator is notified |
60 | * that this driver is done using the dmabuf for now | 60 | * that this driver is done using the dmabuf for now. |
61 | * @prepare: called every time the buffer is passed from userspace to the | 61 | * @prepare: called every time the buffer is passed from userspace to the |
62 | * driver, useful for cache synchronisation, optional | 62 | * driver, useful for cache synchronisation, optional. |
63 | * @finish: called every time the buffer is passed back from the driver | 63 | * @finish: called every time the buffer is passed back from the driver |
64 | * to the userspace, also optional | 64 | * to the userspace, also optional. |
65 | * @vaddr: return a kernel virtual address to a given memory buffer | 65 | * @vaddr: return a kernel virtual address to a given memory buffer |
66 | * associated with the passed private structure or NULL if no | 66 | * associated with the passed private structure or NULL if no |
67 | * such mapping exists | 67 | * such mapping exists. |
68 | * @cookie: return allocator specific cookie for a given memory buffer | 68 | * @cookie: return allocator specific cookie for a given memory buffer |
69 | * associated with the passed private structure or NULL if not | 69 | * associated with the passed private structure or NULL if not |
70 | * available | 70 | * available. |
71 | * @num_users: return the current number of users of a memory buffer; | 71 | * @num_users: return the current number of users of a memory buffer; |
72 | * return 1 if the videobuf layer (or actually the driver using | 72 | * return 1 if the videobuf layer (or actually the driver using |
73 | * it) is the only user | 73 | * it) is the only user. |
74 | * @mmap: setup a userspace mapping for a given memory buffer under | 74 | * @mmap: setup a userspace mapping for a given memory buffer under |
75 | * the provided virtual memory region | 75 | * the provided virtual memory region. |
76 | * | 76 | * |
77 | * Required ops for USERPTR types: get_userptr, put_userptr. | 77 | * Required ops for USERPTR types: get_userptr, put_userptr. |
78 | * Required ops for MMAP types: alloc, put, num_users, mmap. | 78 | * Required ops for MMAP types: alloc, put, num_users, mmap. |
79 | * Required ops for read/write access types: alloc, put, num_users, vaddr | 79 | * Required ops for read/write access types: alloc, put, num_users, vaddr. |
80 | * Required ops for DMABUF types: attach_dmabuf, detach_dmabuf, map_dmabuf, | 80 | * Required ops for DMABUF types: attach_dmabuf, detach_dmabuf, map_dmabuf, |
81 | * unmap_dmabuf. | 81 | * unmap_dmabuf. |
82 | */ | 82 | */ |
@@ -258,22 +258,22 @@ struct vb2_buffer { | |||
258 | * @wait_prepare: release any locks taken while calling vb2 functions; | 258 | * @wait_prepare: release any locks taken while calling vb2 functions; |
259 | * it is called before an ioctl needs to wait for a new | 259 | * it is called before an ioctl needs to wait for a new |
260 | * buffer to arrive; required to avoid a deadlock in | 260 | * buffer to arrive; required to avoid a deadlock in |
261 | * blocking access type | 261 | * blocking access type. |
262 | * @wait_finish: reacquire all locks released in the previous callback; | 262 | * @wait_finish: reacquire all locks released in the previous callback; |
263 | * required to continue operation after sleeping while | 263 | * required to continue operation after sleeping while |
264 | * waiting for a new buffer to arrive | 264 | * waiting for a new buffer to arrive. |
265 | * @buf_init: called once after allocating a buffer (in MMAP case) | 265 | * @buf_init: called once after allocating a buffer (in MMAP case) |
266 | * or after acquiring a new USERPTR buffer; drivers may | 266 | * or after acquiring a new USERPTR buffer; drivers may |
267 | * perform additional buffer-related initialization; | 267 | * perform additional buffer-related initialization; |
268 | * initialization failure (return != 0) will prevent | 268 | * initialization failure (return != 0) will prevent |
269 | * queue setup from completing successfully; optional | 269 | * queue setup from completing successfully; optional. |
270 | * @buf_prepare: called every time the buffer is queued from userspace | 270 | * @buf_prepare: called every time the buffer is queued from userspace |
271 | * and from the VIDIOC_PREPARE_BUF ioctl; drivers may | 271 | * and from the VIDIOC_PREPARE_BUF ioctl; drivers may |
272 | * perform any initialization required before each hardware | 272 | * perform any initialization required before each hardware |
273 | * operation in this callback; drivers that support | 273 | * operation in this callback; drivers that support |
274 | * VIDIOC_CREATE_BUFS must also validate the buffer size; | 274 | * VIDIOC_CREATE_BUFS must also validate the buffer size; |
275 | * if an error is returned, the buffer will not be queued | 275 | * if an error is returned, the buffer will not be queued |
276 | * in driver; optional | 276 | * in driver; optional. |
277 | * @buf_finish: called before every dequeue of the buffer back to | 277 | * @buf_finish: called before every dequeue of the buffer back to |
278 | * userspace; drivers may perform any operations required | 278 | * userspace; drivers may perform any operations required |
279 | * before userspace accesses the buffer; optional. The | 279 | * before userspace accesses the buffer; optional. The |
@@ -286,7 +286,7 @@ struct vb2_buffer { | |||
286 | * all other cases the buffer contents will be ignored | 286 | * all other cases the buffer contents will be ignored |
287 | * anyway. | 287 | * anyway. |
288 | * @buf_cleanup: called once before the buffer is freed; drivers may | 288 | * @buf_cleanup: called once before the buffer is freed; drivers may |
289 | * perform any additional cleanup; optional | 289 | * perform any additional cleanup; optional. |
290 | * @start_streaming: called once to enter 'streaming' state; the driver may | 290 | * @start_streaming: called once to enter 'streaming' state; the driver may |
291 | * receive buffers with @buf_queue callback before | 291 | * receive buffers with @buf_queue callback before |
292 | * @start_streaming is called; the driver gets the number | 292 | * @start_streaming is called; the driver gets the number |
@@ -307,7 +307,7 @@ struct vb2_buffer { | |||
307 | * the buffer back by calling vb2_buffer_done() function; | 307 | * the buffer back by calling vb2_buffer_done() function; |
308 | * it is allways called after calling STREAMON ioctl; | 308 | * it is allways called after calling STREAMON ioctl; |
309 | * might be called before start_streaming callback if user | 309 | * might be called before start_streaming callback if user |
310 | * pre-queued buffers before calling STREAMON | 310 | * pre-queued buffers before calling STREAMON. |
311 | */ | 311 | */ |
312 | struct vb2_ops { | 312 | struct vb2_ops { |
313 | int (*queue_setup)(struct vb2_queue *q, const struct v4l2_format *fmt, | 313 | int (*queue_setup)(struct vb2_queue *q, const struct v4l2_format *fmt, |