hollalinux
/
linux-sg2042
mirror of https://github.com/sophgo/linux-riscv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[media] v4l2-event.h: fix comments and add to DocBook 

The comments there are good enough for DocBook, however they're
using a wrong format. Fix and add to device-drivers.xml.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2015-08-22 08:28:39 -03:00
parent 7dc879190f
commit b6fce850d9
2 changed files with 26 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/DocBook/device-drivers.tmpl
View File

@ -232,9 +232,9 @@ X!Isound/sound_firmware.c
!Idrivers/media/dvb-core/dvb_math.h !Idrivers/media/dvb-core/dvb_math.h
!Idrivers/media/dvb-core/dvb_ringbuffer.h !Idrivers/media/dvb-core/dvb_ringbuffer.h
!Iinclude/media/v4l2-ctrls.h !Iinclude/media/v4l2-ctrls.h
!Iinclude/media/v4l2-event.h
<!-- FIXME: Removed for now due to document generation inconsistency <!-- FIXME: Removed for now due to document generation inconsistency
X!Iinclude/media/v4l2-dv-timings.h X!Iinclude/media/v4l2-dv-timings.h
X!Iinclude/media/v4l2-event.h
X!Iinclude/media/v4l2-mediabus.h X!Iinclude/media/v4l2-mediabus.h
X!Iinclude/media/videobuf2-memops.h X!Iinclude/media/videobuf2-memops.h
X!Iinclude/media/videobuf2-core.h X!Iinclude/media/videobuf2-core.h

47
include/media/v4l2-event.h
View File

@ -68,10 +68,11 @@ struct v4l2_subdev;
struct v4l2_subscribed_event; struct v4l2_subscribed_event;
struct video_device; struct video_device;
/** struct v4l2_kevent - Internal kernel event struct. /**
* @list: List node for the v4l2_fh->available list. * struct v4l2_kevent - Internal kernel event struct.
* @sev: Pointer to parent v4l2_subscribed_event. * @list: List node for the v4l2_fh->available list.
* @event: The event itself. * @sev: Pointer to parent v4l2_subscribed_event.
* @event: The event itself.
*/ */
struct v4l2_kevent { struct v4l2_kevent {
struct list_head list; struct list_head list;
@ -80,11 +81,12 @@ struct v4l2_kevent {
}; };
/** struct v4l2_subscribed_event_ops - Subscribed event operations. /** struct v4l2_subscribed_event_ops - Subscribed event operations.
* @add: Optional callback, called when a new listener is added *
* @del: Optional callback, called when a listener stops listening * @add: Optional callback, called when a new listener is added
* @replace: Optional callback that can replace event 'old' with event 'new'. * @del: Optional callback, called when a listener stops listening
* @merge: Optional callback that can merge event 'old' into event 'new'. * @replace: Optional callback that can replace event 'old' with event 'new'.
*/ * @merge: Optional callback that can merge event 'old' into event 'new'.
*/
struct v4l2_subscribed_event_ops { struct v4l2_subscribed_event_ops {
int (*add)(struct v4l2_subscribed_event *sev, unsigned elems); int (*add)(struct v4l2_subscribed_event *sev, unsigned elems);
void (*del)(struct v4l2_subscribed_event *sev); void (*del)(struct v4l2_subscribed_event *sev);
@ -92,19 +94,20 @@ struct v4l2_subscribed_event_ops {
void (*merge)(const struct v4l2_event *old, struct v4l2_event *new); void (*merge)(const struct v4l2_event *old, struct v4l2_event *new);
}; };
/** struct v4l2_subscribed_event - Internal struct representing a subscribed event. /**
* @list: List node for the v4l2_fh->subscribed list. * struct v4l2_subscribed_event - Internal struct representing a subscribed event.
* @type: Event type. * @list: List node for the v4l2_fh->subscribed list.
* @id: Associated object ID (e.g. control ID). 0 if there isn't any. * @type: Event type.
* @flags: Copy of v4l2_event_subscription->flags. * @id: Associated object ID (e.g. control ID). 0 if there isn't any.
* @fh: Filehandle that subscribed to this event. * @flags: Copy of v4l2_event_subscription->flags.
* @node: List node that hooks into the object's event list (if there is one). * @fh: Filehandle that subscribed to this event.
* @ops: v4l2_subscribed_event_ops * @node: List node that hooks into the object's event list (if there is one).
* @elems: The number of elements in the events array. * @ops: v4l2_subscribed_event_ops
* @first: The index of the events containing the oldest available event. * @elems: The number of elements in the events array.
* @in_use: The number of queued events. * @first: The index of the events containing the oldest available event.
* @events: An array of @elems events. * @in_use: The number of queued events.
*/ * @events: An array of @elems events.
*/
struct v4l2_subscribed_event { struct v4l2_subscribed_event {
struct list_head list; struct list_head list;
u32 type; u32 type;