LM
/
u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: add include/dm/lists.h to the HTML documentation 

Correct Sphinx style comments in include/dm/lists.h
and add the list API to the HTML documentation.

Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Patrick Delaunay 2022-01-12 10:53:44 +01:00 committed by Heinrich Schuchardt
parent 0cdd7ded88
commit cbb14ac92c
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/api/dm.rst
View File

@ -8,3 +8,4 @@ Uclass and Driver
.. kernel-doc:: include/dm/uclass.h .. kernel-doc:: include/dm/uclass.h
.. kernel-doc:: include/dm/root.h .. kernel-doc:: include/dm/root.h
.. kernel-doc:: include/dm/lists.h

8
include/dm/lists.h
View File

@ -19,13 +19,14 @@
* for binding a driver given its name and plat. * for binding a driver given its name and plat.
* *
* @name: Name of driver to look up * @name: Name of driver to look up
* @return pointer to driver, or NULL if not found * Return: pointer to driver, or NULL if not found
*/ */
struct driver *lists_driver_lookup_name(const char *name); struct driver *lists_driver_lookup_name(const char *name);
/** /**
* lists_uclass_lookup() - Return uclass_driver based on ID of the class * lists_uclass_lookup() - Return uclass_driver based on ID of the class
* id: ID of the class *
* @id: ID of the class
* *
* This function returns the pointer to uclass_driver, which is the class's * This function returns the pointer to uclass_driver, which is the class's
* base structure based on the ID of the class. Returns NULL on error. * base structure based on the ID of the class. Returns NULL on error.
@ -56,7 +57,8 @@ int lists_bind_drivers(struct udevice *parent, bool pre_reloc_only);
* @drv: if non-NULL, force this driver to be bound * @drv: if non-NULL, force this driver to be bound
* @pre_reloc_only: If true, bind only nodes with special devicetree properties, * @pre_reloc_only: If true, bind only nodes with special devicetree properties,
* or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers. * or drivers with the DM_FLAG_PRE_RELOC flag. If false bind all drivers.
* @return 0 if device was bound, -EINVAL if the device tree is invalid, *
* Return: 0 if device was bound, -EINVAL if the device tree is invalid,
* other -ve value on error * other -ve value on error
*/ */
int lists_bind_fdt(struct udevice *parent, ofnode node, struct udevice **devp, int lists_bind_fdt(struct udevice *parent, ofnode node, struct udevice **devp,