dtoc: Document the return value of scan_structs()

Add documentation to this function as well as generate_structs(), where
the return value is ultimately passed in.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass 2020-10-03 11:31:24 -06:00
parent c147329847
commit e4fb5faa04

View file

@ -466,6 +466,13 @@ class DtbPlatdata(object):
Once the widest property is determined, all other properties are Once the widest property is determined, all other properties are
updated to match that width. updated to match that width.
Returns:
dict containing structures:
key (str): Node name, as a C identifier
value: dict containing structure fields:
key (str): Field name
value: Prop object with field information
""" """
structs = {} structs = {}
for node in self._valid_nodes: for node in self._valid_nodes:
@ -536,6 +543,14 @@ class DtbPlatdata(object):
This writes out the body of a header file consisting of structure This writes out the body of a header file consisting of structure
definitions for node in self._valid_nodes. See the documentation in definitions for node in self._valid_nodes. See the documentation in
doc/driver-model/of-plat.rst for more information. doc/driver-model/of-plat.rst for more information.
Args:
structs: dict containing structures:
key (str): Node name, as a C identifier
value: dict containing structure fields:
key (str): Field name
value: Prop object with field information
""" """
self.out_header() self.out_header()
self.out('#include <stdbool.h>\n') self.out('#include <stdbool.h>\n')