diff options
| author | Ira Weiny <ira.weiny@intel.com> | 2021-12-01 20:43:02 -0800 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2021-12-03 16:41:50 +0100 |
| commit | 05021dca787be566886875dc0c683552e1c67e5e (patch) | |
| tree | 53a30a78de32155c42c36bac2df381c932969a98 /drivers/base | |
| parent | cb2ba75935558e65f2c4fe411a78c375b2c64cb4 (diff) | |
Documentation/auxiliary_bus: Clarify __auxiliary_driver_register
__auxiliary_driver_register is not intended to be called directly unless
a custom name is required. Add documentation for this fact.
Signed-off-by: Ira Weiny <ira.weiny@intel.com>
Link: https://lore.kernel.org/r/20211202044305.4006853-5-ira.weiny@intel.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'drivers/base')
| -rw-r--r-- | drivers/base/auxiliary.c | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/drivers/base/auxiliary.c b/drivers/base/auxiliary.c index 70a8dbcd31b7..7192f7d03a05 100644 --- a/drivers/base/auxiliary.c +++ b/drivers/base/auxiliary.c @@ -225,6 +225,11 @@ EXPORT_SYMBOL_GPL(auxiliary_find_device); * @auxdrv: auxiliary_driver structure * @owner: owning module/driver * @modname: KBUILD_MODNAME for parent driver + * + * The expectation is that users will call the "auxiliary_driver_register" + * macro so that the caller's KBUILD_MODNAME is automatically inserted for the + * modname parameter. Only if a user requires a custom name would this version + * be called directly. */ int __auxiliary_driver_register(struct auxiliary_driver *auxdrv, struct module *owner, const char *modname) |