kevin/linux
1
Fork 0
Code

driver core: auxiliary bus: Fix documentation of auxiliary_device

Browse Source 
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: a808878308 ("driver core: auxiliary bus: show auxiliary device IRQs")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Shay Drory <shayd@nvidia.com>
Signed-off-by: Saeed Mahameed <saeedm@nvidia.com>
Link: https://patch.msgid.link/20240717172916.595808-1-saeed@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Shay Drory 2024-07-17 10:29:16 -07:00 committed by Jakub Kicinski
parent 1f038d5897
commit c14112a557
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
include/linux/auxiliary_bus.h
View File

@ -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