diff options
| author | Martyn Welch <martyn.welch@collabora.co.uk> | 2017-03-04 03:34:29 +0300 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2017-03-17 09:10:49 +0300 |
| commit | b5bc980a4929bb2a449fef3e0b7131466815d0b1 (patch) | |
| tree | 2b6b142ef84dc2293526dc18bf406bf41f02125c /include/linux/vme.h | |
| parent | 5cd5e6ad0ede862432e1e766bfe02a9ad447533e (diff) | |
| download | linux-b5bc980a4929bb2a449fef3e0b7131466815d0b1.tar.xz | |
docs: Add kernel-doc comments to VME driver API
Add kernel-doc comments to the VME driver API and structures. This
documentation will be integrated into the RST documentation in a later
patch.
Signed-off-by: Martyn Welch <martyn.welch@collabora.co.uk>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'include/linux/vme.h')
| -rw-r--r-- | include/linux/vme.h | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/include/linux/vme.h b/include/linux/vme.h index ec5e8bf6118e..25874da3f2e1 100644 --- a/include/linux/vme.h +++ b/include/linux/vme.h @@ -92,7 +92,7 @@ extern struct bus_type vme_bus_type; #define VME_SLOT_ALL -2 /** - * Structure representing a VME device + * struct vme_dev - Structure representing a VME device * @num: The device number * @bridge: Pointer to the bridge device this device is on * @dev: Internal device structure @@ -107,6 +107,16 @@ struct vme_dev { struct list_head bridge_list; }; +/** + * struct vme_driver - Structure representing a VME driver + * @name: Driver name, should be unique among VME drivers and usually the same + * as the module name. + * @match: Callback used to determine whether probe should be run. + * @probe: Callback for device binding, called when new device is detected. + * @remove: Callback, called on device removal. + * @driver: Underlying generic device driver structure. + * @devices: List of VME devices (struct vme_dev) associated with this driver. + */ struct vme_driver { const char *name; int (*match)(struct vme_dev *); |