tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
[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>
+26
-23
+1
-1
Documentation/DocBook/device-drivers.tmpl
+1
-1
Documentation/DocBook/device-drivers.tmpl
···
232
232
!Idrivers/media/dvb-core/dvb_math.h
233
233
!Idrivers/media/dvb-core/dvb_ringbuffer.h
234
234
!Iinclude/media/v4l2-ctrls.h
235
+
!Iinclude/media/v4l2-event.h
235
236
<!-- FIXME: Removed for now due to document generation inconsistency
236
237
X!Iinclude/media/v4l2-dv-timings.h
237
-
X!Iinclude/media/v4l2-event.h
238
238
X!Iinclude/media/v4l2-mediabus.h
239
239
X!Iinclude/media/videobuf2-memops.h
240
240
X!Iinclude/media/videobuf2-core.h
+25
-22
include/media/v4l2-event.h
+25
-22
include/media/v4l2-event.h
···
68
68
struct v4l2_subscribed_event;
69
69
struct video_device;
70
70
71
-
/** struct v4l2_kevent - Internal kernel event struct.
72
-
* @list: List node for the v4l2_fh->available list.
73
-
* @sev: Pointer to parent v4l2_subscribed_event.
74
-
* @event: The event itself.
71
+
/**
72
+
* struct v4l2_kevent - Internal kernel event struct.
73
+
* @list: List node for the v4l2_fh->available list.
74
+
* @sev: Pointer to parent v4l2_subscribed_event.
75
+
* @event: The event itself.
75
76
*/
76
77
struct v4l2_kevent {
77
78
struct list_head list;
···
81
80
};
82
81
83
82
/** struct v4l2_subscribed_event_ops - Subscribed event operations.
84
-
* @add: Optional callback, called when a new listener is added
85
-
* @del: Optional callback, called when a listener stops listening
86
-
* @replace: Optional callback that can replace event 'old' with event 'new'.
87
-
* @merge: Optional callback that can merge event 'old' into event 'new'.
88
-
*/
83
+
*
84
+
* @add: Optional callback, called when a new listener is added
85
+
* @del: Optional callback, called when a listener stops listening
86
+
* @replace: Optional callback that can replace event 'old' with event 'new'.
87
+
* @merge: Optional callback that can merge event 'old' into event 'new'.
88
+
*/
89
89
struct v4l2_subscribed_event_ops {
90
90
int (*add)(struct v4l2_subscribed_event *sev, unsigned elems);
91
91
void (*del)(struct v4l2_subscribed_event *sev);
···
94
92
void (*merge)(const struct v4l2_event *old, struct v4l2_event *new);
95
93
};
96
94
97
-
/** struct v4l2_subscribed_event - Internal struct representing a subscribed event.
98
-
* @list: List node for the v4l2_fh->subscribed list.
99
-
* @type: Event type.
100
-
* @id: Associated object ID (e.g. control ID). 0 if there isn't any.
101
-
* @flags: Copy of v4l2_event_subscription->flags.
102
-
* @fh: Filehandle that subscribed to this event.
103
-
* @node: List node that hooks into the object's event list (if there is one).
104
-
* @ops: v4l2_subscribed_event_ops
105
-
* @elems: The number of elements in the events array.
106
-
* @first: The index of the events containing the oldest available event.
107
-
* @in_use: The number of queued events.
108
-
* @events: An array of @elems events.
109
-
*/
95
+
/**
96
+
* struct v4l2_subscribed_event - Internal struct representing a subscribed event.
97
+
* @list: List node for the v4l2_fh->subscribed list.
98
+
* @type: Event type.
99
+
* @id: Associated object ID (e.g. control ID). 0 if there isn't any.
100
+
* @flags: Copy of v4l2_event_subscription->flags.
101
+
* @fh: Filehandle that subscribed to this event.
102
+
* @node: List node that hooks into the object's event list (if there is one).
103
+
* @ops: v4l2_subscribed_event_ops
104
+
* @elems: The number of elements in the events array.
105
+
* @first: The index of the events containing the oldest available event.
106
+
* @in_use: The number of queued events.
107
+
* @events: An array of @elems events.
108
+
*/
110
109
struct v4l2_subscribed_event {
111
110
struct list_head list;
112
111
u32 type;