diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-23 06:12:03 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-23 07:05:02 -0400 |
commit | 564aaf69208d6f9e37cd82c06b889e5d9c59bfb6 (patch) | |
tree | 7373637b4624d4372f158ee8172a4180257d01e0 /include/media | |
parent | 7b998bae0546d7b1d9bcf0e23c4b3294c4027e4c (diff) |
[media] doc-rst: add some needed escape codes
Some extra escape codes are needed to avoid Sphinx to not
identify the tags.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'include/media')
-rw-r--r-- | include/media/media-entity.h | 2 | ||||
-rw-r--r-- | include/media/v4l2-dev.h | 4 | ||||
-rw-r--r-- | include/media/videobuf2-core.h | 50 |
3 files changed, 28 insertions, 28 deletions
diff --git a/include/media/media-entity.h b/include/media/media-entity.h index 17390cc7b538..09b03c17784d 100644 --- a/include/media/media-entity.h +++ b/include/media/media-entity.h | |||
@@ -540,7 +540,7 @@ static inline bool media_entity_enum_intersects( | |||
540 | * @gobj: Pointer to the graph object | 540 | * @gobj: Pointer to the graph object |
541 | * | 541 | * |
542 | * This routine initializes the embedded struct media_gobj inside a | 542 | * This routine initializes the embedded struct media_gobj inside a |
543 | * media graph object. It is called automatically if media_*_create() | 543 | * media graph object. It is called automatically if media_*_create\(\) |
544 | * calls are used. However, if the object (entity, link, pad, interface) | 544 | * calls are used. However, if the object (entity, link, pad, interface) |
545 | * is embedded on some other object, this function should be called before | 545 | * is embedded on some other object, this function should be called before |
546 | * registering the object at the media controller. | 546 | * registering the object at the media controller. |
diff --git a/include/media/v4l2-dev.h b/include/media/v4l2-dev.h index 5921c24565cf..a122b1bd40f9 100644 --- a/include/media/v4l2-dev.h +++ b/include/media/v4l2-dev.h | |||
@@ -374,13 +374,13 @@ struct video_device * __must_check video_device_alloc(void); | |||
374 | * | 374 | * |
375 | * @vdev: pointer to &struct video_device | 375 | * @vdev: pointer to &struct video_device |
376 | * | 376 | * |
377 | * Can also be used for video_device->release(). | 377 | * Can also be used for video_device->release\(\). |
378 | */ | 378 | */ |
379 | void video_device_release(struct video_device *vdev); | 379 | void video_device_release(struct video_device *vdev); |
380 | 380 | ||
381 | /** | 381 | /** |
382 | * video_device_release_empty - helper function to implement the | 382 | * video_device_release_empty - helper function to implement the |
383 | * video_device->release() callback. | 383 | * video_device->release\(\) callback. |
384 | * | 384 | * |
385 | * @vdev: pointer to &struct video_device | 385 | * @vdev: pointer to &struct video_device |
386 | * | 386 | * |
diff --git a/include/media/videobuf2-core.h b/include/media/videobuf2-core.h index c346beaaeae6..946340ce7701 100644 --- a/include/media/videobuf2-core.h +++ b/include/media/videobuf2-core.h | |||
@@ -277,7 +277,7 @@ struct vb2_buffer { | |||
277 | /** | 277 | /** |
278 | * struct vb2_ops - driver-specific callbacks | 278 | * struct vb2_ops - driver-specific callbacks |
279 | * | 279 | * |
280 | * @queue_setup: called from VIDIOC_REQBUFS and VIDIOC_CREATE_BUFS | 280 | * @queue_setup: called from %VIDIOC_REQBUFS and %VIDIOC_CREATE_BUFS |
281 | * handlers before memory allocation. It can be called | 281 | * handlers before memory allocation. It can be called |
282 | * twice: if the original number of requested buffers | 282 | * twice: if the original number of requested buffers |
283 | * could not be allocated, then it will be called a | 283 | * could not be allocated, then it will be called a |
@@ -286,17 +286,17 @@ struct vb2_buffer { | |||
286 | * The driver should return the required number of buffers | 286 | * The driver should return the required number of buffers |
287 | * in \*num_buffers, the required number of planes per | 287 | * in \*num_buffers, the required number of planes per |
288 | * buffer in \*num_planes, the size of each plane should be | 288 | * buffer in \*num_planes, the size of each plane should be |
289 | * set in the sizes[] array and optional per-plane | 289 | * set in the sizes\[\] array and optional per-plane |
290 | * allocator specific device in the alloc_devs[] array. | 290 | * allocator specific device in the alloc_devs\[\] array. |
291 | * When called from VIDIOC_REQBUFS, *num_planes == 0, the | 291 | * When called from %VIDIOC_REQBUFS, \*num_planes == 0, the |
292 | * driver has to use the currently configured format to | 292 | * driver has to use the currently configured format to |
293 | * determine the plane sizes and \*num_buffers is the total | 293 | * determine the plane sizes and \*num_buffers is the total |
294 | * number of buffers that are being allocated. When called | 294 | * number of buffers that are being allocated. When called |
295 | * from VIDIOC_CREATE_BUFS, \*num_planes != 0 and it | 295 | * from %VIDIOC_CREATE_BUFS, \*num_planes != 0 and it |
296 | * describes the requested number of planes and sizes[] | 296 | * describes the requested number of planes and sizes\[\] |
297 | * contains the requested plane sizes. If either | 297 | * contains the requested plane sizes. If either |
298 | * \*num_planes or the requested sizes are invalid callback | 298 | * \*num_planes or the requested sizes are invalid callback |
299 | * must return -EINVAL. In this case \*num_buffers are | 299 | * must return %-EINVAL. In this case \*num_buffers are |
300 | * being allocated additionally to q->num_buffers. | 300 | * being allocated additionally to q->num_buffers. |
301 | * @wait_prepare: release any locks taken while calling vb2 functions; | 301 | * @wait_prepare: release any locks taken while calling vb2 functions; |
302 | * it is called before an ioctl needs to wait for a new | 302 | * it is called before an ioctl needs to wait for a new |
@@ -311,11 +311,11 @@ struct vb2_buffer { | |||
311 | * initialization failure (return != 0) will prevent | 311 | * initialization failure (return != 0) will prevent |
312 | * queue setup from completing successfully; optional. | 312 | * queue setup from completing successfully; optional. |
313 | * @buf_prepare: called every time the buffer is queued from userspace | 313 | * @buf_prepare: called every time the buffer is queued from userspace |
314 | * and from the VIDIOC_PREPARE_BUF ioctl; drivers may | 314 | * and from the %VIDIOC_PREPARE_BUF ioctl; drivers may |
315 | * perform any initialization required before each | 315 | * perform any initialization required before each |
316 | * hardware operation in this callback; drivers can | 316 | * hardware operation in this callback; drivers can |
317 | * access/modify the buffer here as it is still synced for | 317 | * access/modify the buffer here as it is still synced for |
318 | * the CPU; drivers that support VIDIOC_CREATE_BUFS must | 318 | * the CPU; drivers that support %VIDIOC_CREATE_BUFS must |
319 | * also validate the buffer size; if an error is returned, | 319 | * also validate the buffer size; if an error is returned, |
320 | * the buffer will not be queued in driver; optional. | 320 | * the buffer will not be queued in driver; optional. |
321 | * @buf_finish: called before every dequeue of the buffer back to | 321 | * @buf_finish: called before every dequeue of the buffer back to |
@@ -323,23 +323,23 @@ struct vb2_buffer { | |||
323 | * can access/modify the buffer contents; drivers may | 323 | * can access/modify the buffer contents; drivers may |
324 | * perform any operations required before userspace | 324 | * perform any operations required before userspace |
325 | * accesses the buffer; optional. The buffer state can be | 325 | * accesses the buffer; optional. The buffer state can be |
326 | * one of the following: DONE and ERROR occur while | 326 | * one of the following: %DONE and %ERROR occur while |
327 | * streaming is in progress, and the PREPARED state occurs | 327 | * streaming is in progress, and the %PREPARED state occurs |
328 | * when the queue has been canceled and all pending | 328 | * when the queue has been canceled and all pending |
329 | * buffers are being returned to their default DEQUEUED | 329 | * buffers are being returned to their default %DEQUEUED |
330 | * state. Typically you only have to do something if the | 330 | * state. Typically you only have to do something if the |
331 | * state is VB2_BUF_STATE_DONE, since in all other cases | 331 | * state is %VB2_BUF_STATE_DONE, since in all other cases |
332 | * the buffer contents will be ignored anyway. | 332 | * the buffer contents will be ignored anyway. |
333 | * @buf_cleanup: called once before the buffer is freed; drivers may | 333 | * @buf_cleanup: called once before the buffer is freed; drivers may |
334 | * perform any additional cleanup; optional. | 334 | * perform any additional cleanup; optional. |
335 | * @start_streaming: called once to enter 'streaming' state; the driver may | 335 | * @start_streaming: called once to enter 'streaming' state; the driver may |
336 | * receive buffers with @buf_queue callback before | 336 | * receive buffers with @buf_queue callback |
337 | * @start_streaming is called; the driver gets the number | 337 | * before @start_streaming is called; the driver gets the |
338 | * of already queued buffers in count parameter; driver | 338 | * number of already queued buffers in count parameter; |
339 | * can return an error if hardware fails, in that case all | 339 | * driver can return an error if hardware fails, in that |
340 | * buffers that have been already given by the @buf_queue | 340 | * case all buffers that have been already given by |
341 | * callback are to be returned by the driver by calling | 341 | * the @buf_queue callback are to be returned by the driver |
342 | * @vb2_buffer_done(VB2_BUF_STATE_QUEUED). | 342 | * by calling @vb2_buffer_done\(%VB2_BUF_STATE_QUEUED\). |
343 | * If you need a minimum number of buffers before you can | 343 | * If you need a minimum number of buffers before you can |
344 | * start streaming, then set @min_buffers_needed in the | 344 | * start streaming, then set @min_buffers_needed in the |
345 | * vb2_queue structure. If that is non-zero then | 345 | * vb2_queue structure. If that is non-zero then |
@@ -347,16 +347,16 @@ struct vb2_buffer { | |||
347 | * many buffers have been queued up by userspace. | 347 | * many buffers have been queued up by userspace. |
348 | * @stop_streaming: called when 'streaming' state must be disabled; driver | 348 | * @stop_streaming: called when 'streaming' state must be disabled; driver |
349 | * should stop any DMA transactions or wait until they | 349 | * should stop any DMA transactions or wait until they |
350 | * finish and give back all buffers it got from buf_queue() | 350 | * finish and give back all buffers it got from &buf_queue |
351 | * callback by calling @vb2_buffer_done() with either | 351 | * callback by calling @vb2_buffer_done\(\) with either |
352 | * VB2_BUF_STATE_DONE or VB2_BUF_STATE_ERROR; may use | 352 | * %VB2_BUF_STATE_DONE or %VB2_BUF_STATE_ERROR; may use |
353 | * vb2_wait_for_all_buffers() function | 353 | * vb2_wait_for_all_buffers() function |
354 | * @buf_queue: passes buffer vb to the driver; driver may start | 354 | * @buf_queue: passes buffer vb to the driver; driver may start |
355 | * hardware operation on this buffer; driver should give | 355 | * hardware operation on this buffer; driver should give |
356 | * the buffer back by calling vb2_buffer_done() function; | 356 | * the buffer back by calling vb2_buffer_done() function; |
357 | * it is allways called after calling STREAMON ioctl; | 357 | * it is allways called after calling %VIDIOC_STREAMON ioctl; |
358 | * might be called before start_streaming callback if user | 358 | * might be called before start_streaming callback if user |
359 | * pre-queued buffers before calling STREAMON. | 359 | * pre-queued buffers before calling %VIDIOC_STREAMON. |
360 | */ | 360 | */ |
361 | struct vb2_ops { | 361 | struct vb2_ops { |
362 | int (*queue_setup)(struct vb2_queue *q, | 362 | int (*queue_setup)(struct vb2_queue *q, |