tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
[media] v4l2-async: document the remaining stuff
There are one enum and 4 functions undocumented there.
Document them. That will fix the broken links at the
v4l2-subdev.rst file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
+39
+39
include/media/v4l2-async.h
+39
include/media/v4l2-async.h
···
23
23
/* A random max subdevice number, used to allocate an array on stack */
24
24
#define V4L2_MAX_SUBDEVS 128U
25
25
26
+
/**
27
+
* enum v4l2_async_match_type - type of asynchronous subdevice logic to be used
28
+
* in order to identify a match
29
+
*
30
+
* @V4L2_ASYNC_MATCH_CUSTOM: Match will use the logic provided by &struct
31
+
* v4l2_async_subdev.match ops
32
+
* @V4L2_ASYNC_MATCH_DEVNAME: Match will use the device name
33
+
* @V4L2_ASYNC_MATCH_I2C: Match will check for I2C adapter ID and address
34
+
* @V4L2_ASYNC_MATCH_OF: Match will use OF node
35
+
*
36
+
* This enum is used by the asyncrhronous sub-device logic to define the
37
+
* algorithm that will be used to match an asynchronous device.
38
+
*/
26
39
enum v4l2_async_match_type {
27
40
V4L2_ASYNC_MATCH_CUSTOM,
28
41
V4L2_ASYNC_MATCH_DEVNAME,
···
104
91
struct v4l2_async_subdev *asd);
105
92
};
106
93
94
+
/**
95
+
* v4l2_async_notifier_register - registers a subdevice asynchronous notifier
96
+
*
97
+
* @v4l2_dev: pointer to &struct v4l2_device
98
+
* @notifier: pointer to &struct v4l2_async_notifier
99
+
*/
107
100
int v4l2_async_notifier_register(struct v4l2_device *v4l2_dev,
108
101
struct v4l2_async_notifier *notifier);
102
+
103
+
/**
104
+
* v4l2_async_notifier_unregister - unregisters a subdevice asynchronous notifier
105
+
*
106
+
* @notifier: pointer to &struct v4l2_async_notifier
107
+
*/
109
108
void v4l2_async_notifier_unregister(struct v4l2_async_notifier *notifier);
109
+
110
+
/**
111
+
* v4l2_async_register_subdev - registers a sub-device to the asynchronous
112
+
* subdevice framework
113
+
*
114
+
* @sd: pointer to &struct v4l2_subdev
115
+
*/
110
116
int v4l2_async_register_subdev(struct v4l2_subdev *sd);
117
+
118
+
/**
119
+
* v4l2_async_unregister_subdev - unregisters a sub-device to the asynchronous
120
+
* subdevice framework
121
+
*
122
+
* @sd: pointer to &struct v4l2_subdev
123
+
*/
111
124
void v4l2_async_unregister_subdev(struct v4l2_subdev *sd);
112
125
#endif