summaryrefslogtreecommitdiffstats
path: root/Documentation/vme_api.txt
diff options
context:
space:
mode:
authorMartyn Welch <martyn@welchs.me.uk>2016-06-05 16:35:45 -0400
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2016-08-31 07:20:16 -0400
commit76deefa3b797cc2014581cb0337dc207e9ab3a3d (patch)
treeb2cd55a0bf776c688a923d453761bfec13bb2e5c /Documentation/vme_api.txt
parentfa54b326803d91b04705a6adf0ff963593a9fe5c (diff)
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>
Diffstat (limited to 'Documentation/vme_api.txt')
-rw-r--r--Documentation/vme_api.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/vme_api.txt b/Documentation/vme_api.txt
index 4ca63a6eca24..90006550f485 100644
--- a/Documentation/vme_api.txt
+++ b/Documentation/vme_api.txt
@@ -8,13 +8,14 @@ As with other subsystems within the Linux kernel, VME device drivers register
8with the VME subsystem, typically called from the devices init routine. This is 8with the VME subsystem, typically called from the devices init routine. This is
9achieved via a call to the following function: 9achieved 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
13If driver registration is successful this function returns zero, if an error 13If driver registration is successful this function returns zero, if an error
14occurred a negative error code will be returned. 14occurred a negative error code will be returned.
15 15
16A pointer to a structure of type 'vme_driver' must be provided to the 16A pointer to a structure of type 'vme_driver' must be provided to the
17registration function. The structure is as follows: 17registration function. Along with ndevs, which is the number of devices your
18driver is able to support. The structure is as follows:
18 19
19 struct vme_driver { 20 struct vme_driver {
20 struct list_head node; 21 struct list_head node;
@@ -32,8 +33,8 @@ At the minimum, the '.name', '.match' and '.probe' elements of this structure
32should be correctly set. The '.name' element is a pointer to a string holding 33should be correctly set. The '.name' element is a pointer to a string holding
33the device driver's name. 34the device driver's name.
34 35
35The '.match' function allows controlling the number of devices that need to 36The '.match' function allows control over which VME devices should be registered
36be registered. The match function should return 1 if a device should be 37with the driver. The match function should return 1 if a device should be
37probed and 0 otherwise. This example match function (from vme_user.c) limits 38probed and 0 otherwise. This example match function (from vme_user.c) limits
38the number of devices probed to one: 39the number of devices probed to one:
39 40