tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
vme: Update documentation to match api
The vme_register_driver() api changed in commit 5d6abf379d73 ("staging:
vme: make match() driver specific to improve non-VME64x support") but the
documentation wasn't updated. Update the documentation to match the API.
Signed-off-by: Martyn Welch <martyn@welchs.me.uk>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
authored by
Martyn Welch
and committed by
Greg Kroah-Hartman
76deefa3
fa54b326
+5
-4
+5
-4
Documentation/vme_api.txt
+5
-4
Documentation/vme_api.txt
···
8
8
with the VME subsystem, typically called from the devices init routine. This is
9
9
achieved via a call to the following function:
10
10
11
-
int vme_register_driver (struct vme_driver *driver);
11
+
int vme_register_driver (struct vme_driver *driver, unsigned int ndevs);
12
12
13
13
If driver registration is successful this function returns zero, if an error
14
14
occurred a negative error code will be returned.
15
15
16
16
A pointer to a structure of type 'vme_driver' must be provided to the
17
-
registration function. The structure is as follows:
17
+
registration function. Along with ndevs, which is the number of devices your
18
+
driver is able to support. The structure is as follows:
18
19
19
20
struct vme_driver {
20
21
struct list_head node;
···
33
32
should be correctly set. The '.name' element is a pointer to a string holding
34
33
the device driver's name.
35
34
36
-
The '.match' function allows controlling the number of devices that need to
37
-
be registered. The match function should return 1 if a device should be
35
+
The '.match' function allows control over which VME devices should be registered
36
+
with the driver. The match function should return 1 if a device should be
38
37
probed and 0 otherwise. This example match function (from vme_user.c) limits
39
38
the number of devices probed to one:
40
39