Commit c14112a5 authored by Shay Drory's avatar Shay Drory Committed by Jakub Kicinski

driver core: auxiliary bus: Fix documentation of auxiliary_device

Fix the documentation of the below field of struct auxiliary_device

include/linux/auxiliary_bus.h:150: warning: Function parameter or struct member 'sysfs' not described in 'auxiliary_device'
include/linux/auxiliary_bus.h:150: warning: Excess struct member 'irqs' description in 'auxiliary_device'
include/linux/auxiliary_bus.h:150: warning: Excess struct member 'lock' description in 'auxiliary_device'
include/linux/auxiliary_bus.h:150: warning: Excess struct member 'irq_dir_exists' description in 'auxiliary_device'

Fixes: a8088783 ("driver core: auxiliary bus: show auxiliary device IRQs")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: default avatarShay Drory <shayd@nvidia.com>
Signed-off-by: default avatarSaeed Mahameed <saeedm@nvidia.com>
Link: https://patch.msgid.link/20240717172916.595808-1-saeed@kernel.orgSigned-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 1f038d58
...@@ -58,9 +58,10 @@ ...@@ -58,9 +58,10 @@
* in * in
* @name: Match name found by the auxiliary device driver, * @name: Match name found by the auxiliary device driver,
* @id: unique identitier if multiple devices of the same name are exported, * @id: unique identitier if multiple devices of the same name are exported,
* @irqs: irqs xarray contains irq indices which are used by the device, * @sysfs: embedded struct which hold all sysfs related fields,
* @lock: Synchronize irq sysfs creation, * @sysfs.irqs: irqs xarray contains irq indices which are used by the device,
* @irq_dir_exists: whether "irqs" directory exists, * @sysfs.lock: Synchronize irq sysfs creation,
* @sysfs.irq_dir_exists: whether "irqs" directory exists,
* *
* An auxiliary_device represents a part of its parent device's functionality. * An auxiliary_device represents a part of its parent device's functionality.
* It is given a name that, combined with the registering drivers * It is given a name that, combined with the registering drivers
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment