diff options
author | Heinrich Schuchardt <xypron.glpk@gmx.de> | 2021-01-24 23:48:00 +0300 |
---|---|---|
committer | Heinrich Schuchardt <xypron.glpk@gmx.de> | 2021-01-25 03:15:34 +0300 |
commit | a03185a3ecbc5a51fbae9c1790b6148f8c68b1be (patch) | |
tree | 2e02c5a7629e1d38f6b98f8c023b99eea876f236 /include/asm-generic/global_data.h | |
parent | 9d4445bc6dd314cc34aaeeac1c03d5bdb6761cca (diff) | |
download | u-boot-a03185a3ecbc5a51fbae9c1790b6148f8c68b1be.tar.xz |
dm: core: describe uclass_root_s
'make htmldocs' creates a warning:
./include/asm-generic/global_data.h:443:
warning: Function parameter or member 'uclass_root_s'
not described in 'global_data'
Correct the member descriptions.
Cc: Simon Glass <sjg@chromium.org>
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'include/asm-generic/global_data.h')
-rw-r--r-- | include/asm-generic/global_data.h | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/include/asm-generic/global_data.h b/include/asm-generic/global_data.h index 19f70393b4..b6f707e97e 100644 --- a/include/asm-generic/global_data.h +++ b/include/asm-generic/global_data.h @@ -198,13 +198,21 @@ struct global_data { */ struct udevice *dm_root_f; /** - * @uclass_root: head of core tree + * @uclass_root_s: + * head of core tree when uclasses are not in read-only memory. + * + * When uclasses are in read-only memory, @uclass_root_s is not used and + * @uclass_root points to the root node generated by dtoc. */ struct list_head uclass_root_s; /** - * @uclass_root: pointer to head of core tree, if uclasses are in - * read-only memory and cannot be adjusted to use @uclass_root as a - * list head. + * @uclass_root: + * pointer to head of core tree, if uclasses are in read-only memory and + * cannot be adjusted to use @uclass_root as a list head. + * + * When not in read-only memory, @uclass_root_s is used to hold the + * uclass root, and @uclass_root points to the address of + * @uclass_root_s. */ struct list_head *uclass_root; # if CONFIG_IS_ENABLED(OF_PLATDATA) |