tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

device core: Fix kernel-doc warnings in base.h

In preparation for adding new fields to 'struct device_private' fix up
existing kernel-doc warnings in this header file of the form:

Warning: drivers/base/base.h:59 struct member 'subsys' not described in
'subsys_private'
Warning: drivers/base/base.h:59 struct member 'devices_kset' not described
in 'subsys_private'
Warning: drivers/base/base.h:59 struct member 'interfaces' not described in
'subsys_private'
Warning: drivers/base/base.h:59 struct member 'mutex' not described in
'subsys_private'

...which are simple replacements of " - " with ": ".

Add new descriptions for these previously undescribed fields:

Warning: drivers/base/base.h:58 struct member 'drivers_autoprobe' not
described in 'subsys_private'
Warning: drivers/base/base.h:117 struct member 'deferred_probe_reason' not
described in 'device_private'

Signed-off-by: Dan Williams <dan.j.williams@intel.com>
Reviewed-by: Jonathan Cameron <jonathan.cameron@huawei.com>
Link: https://patch.msgid.link/20260303000207.1836586-3-dan.j.williams@intel.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Dan Williams and committed by
Greg Kroah-Hartman f917dc56 9900002f

+41 -38
+41 -38
drivers/base/base.h
··· 13 13 #include <linux/notifier.h> 14 14 15 15 /** 16 - * struct subsys_private - structure to hold the private to the driver core portions of the bus_type/class structure. 17 - * 18 - * @subsys - the struct kset that defines this subsystem 19 - * @devices_kset - the subsystem's 'devices' directory 20 - * @interfaces - list of subsystem interfaces associated 21 - * @mutex - protect the devices, and interfaces lists. 22 - * 23 - * @drivers_kset - the list of drivers associated 24 - * @klist_devices - the klist to iterate over the @devices_kset 25 - * @klist_drivers - the klist to iterate over the @drivers_kset 26 - * @bus_notifier - the bus notifier list for anything that cares about things 27 - * on this bus. 28 - * @bus - pointer back to the struct bus_type that this structure is associated 29 - * with. 16 + * struct subsys_private - structure to hold the private to the driver core 17 + * portions of the bus_type/class structure. 18 + * @subsys: the struct kset that defines this subsystem 19 + * @devices_kset: the subsystem's 'devices' directory 20 + * @interfaces: list of subsystem interfaces associated 21 + * @mutex: protect the devices, and interfaces lists. 22 + * @drivers_kset: the list of drivers associated 23 + * @klist_devices: the klist to iterate over the @devices_kset 24 + * @klist_drivers: the klist to iterate over the @drivers_kset 25 + * @bus_notifier: the bus notifier list for anything that cares about things 26 + * on this bus. 27 + * @drivers_autoprobe: gate whether new devices are automatically attached to 28 + * registered drivers, or new drivers automatically attach 29 + * to existing devices. 30 + * @bus: pointer back to the struct bus_type that this structure is associated 31 + * with. 30 32 * @dev_root: Default device to use as the parent. 31 - * 32 - * @glue_dirs - "glue" directory to put in-between the parent device to 33 - * avoid namespace conflicts 34 - * @class - pointer back to the struct class that this structure is associated 35 - * with. 36 - * @lock_key: Lock class key for use by the lock validator 33 + * @glue_dirs: "glue" directory to put in-between the parent device to 34 + * avoid namespace conflicts 35 + * @class: pointer back to the struct class that this structure is associated 36 + * with. 37 + * @lock_key: Lock class key for use by the lock validator 37 38 * 38 39 * This structure is the one that is the actual kobject allowing struct 39 40 * bus_type/class to be statically allocated safely. Nothing outside of the ··· 99 98 #endif 100 99 101 100 /** 102 - * struct device_private - structure to hold the private to the driver core portions of the device structure. 103 - * 104 - * @klist_children - klist containing all children of this device 105 - * @knode_parent - node in sibling list 106 - * @knode_driver - node in driver list 107 - * @knode_bus - node in bus list 108 - * @knode_class - node in class list 109 - * @deferred_probe - entry in deferred_probe_list which is used to retry the 110 - * binding of drivers which were unable to get all the resources needed by 111 - * the device; typically because it depends on another driver getting 112 - * probed first. 113 - * @async_driver - pointer to device driver awaiting probe via async_probe 114 - * @device - pointer back to the struct device that this structure is 115 - * associated with. 116 - * @driver_type - The type of the bound Rust driver. 117 - * @dead - This device is currently either in the process of or has been 118 - * removed from the system. Any asynchronous events scheduled for this 119 - * device should exit without taking any action. 101 + * struct device_private - structure to hold the private to the driver core 102 + * portions of the device structure. 103 + * @klist_children: klist containing all children of this device 104 + * @knode_parent: node in sibling list 105 + * @knode_driver: node in driver list 106 + * @knode_bus: node in bus list 107 + * @knode_class: node in class list 108 + * @deferred_probe: entry in deferred_probe_list which is used to retry the 109 + * binding of drivers which were unable to get all the 110 + * resources needed by the device; typically because it depends 111 + * on another driver getting probed first. 112 + * @async_driver: pointer to device driver awaiting probe via async_probe 113 + * @deferred_probe_reason: capture the -EPROBE_DEFER message emitted with 114 + * dev_err_probe() for later retrieval via debugfs 115 + * @device: pointer back to the struct device that this structure is 116 + * associated with. 117 + * @driver_type: The type of the bound Rust driver. 118 + * @dead: This device is currently either in the process of or has been 119 + * removed from the system. Any asynchronous events scheduled for this 120 + * device should exit without taking any action. 120 121 * 121 122 * Nothing outside of the driver core should ever touch these fields. 122 123 */