Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 76deefa3 authored by Martyn Welch's avatar Martyn Welch Committed by Greg Kroah-Hartman
Browse files

vme: Update documentation to match api 



The vme_register_driver() api changed in commit 5d6abf37 ("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: default avatarMartyn Welch <martyn@welchs.me.uk>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent fa54b326

Documentation/vme_api.txt

+5 −4
Original line number Diff line number Diff line
@@ -8,13 +8,14 @@ As with other subsystems within the Linux kernel, VME device drivers register 
with the VME subsystem, typically called from the devices init routine.  This is

achieved via a call to the following function:



	int vme_register_driver (struct vme_driver *driver);

	int vme_register_driver (struct vme_driver *driver, unsigned int ndevs);



If driver registration is successful this function returns zero, if an error

occurred a negative error code will be returned.



A pointer to a structure of type 'vme_driver' must be provided to the

registration function. The structure is as follows:

registration function. Along with ndevs, which is the number of devices your

driver is able to support. The structure is as follows:



	struct vme_driver {

		struct list_head node;
@@ -32,8 +33,8 @@ At the minimum, the '.name', '.match' and '.probe' elements of this structure 
should be correctly set. The '.name' element is a pointer to a string holding

the device driver's name.



The '.match' function allows controlling the number of devices that need to

be registered. The match function should return 1 if a device should be

The '.match' function allows control over which VME devices should be registered

with the driver. The match function should return 1 if a device should be

probed and 0 otherwise. This example match function (from vme_user.c) limits

the number of devices probed to one: