diff options
| author | Heinrich Schuchardt <xypron.glpk@gmx.de> | 2021-11-14 08:43:07 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2021-11-20 10:53:00 +0100 |
| commit | 4ad4c2daeb44a1761e944e819213ceb3c3bd1340 (patch) | |
| tree | c294b5e6a334dc54be85dc317f16ca7d42f914b3 | |
| parent | 5a515132d9f25b1ff2c15e2013de9be33bf71067 (diff) | |
| download | u-boot-4ad4c2daeb44a1761e944e819213ceb3c3bd1340.tar.gz u-boot-4ad4c2daeb44a1761e944e819213ceb3c3bd1340.tar.bz2 u-boot-4ad4c2daeb44a1761e944e819213ceb3c3bd1340.zip | |
doc: add include/lmb.h to the HTML documentation
Correct Sphinx style comments in include/lmb.h
Add the logical memory block API to the HTML documentation.
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
| -rw-r--r-- | doc/api/index.rst | 1 | ||||
| -rw-r--r-- | doc/api/lmb.rst | 7 | ||||
| -rw-r--r-- | include/lmb.h | 23 |
3 files changed, 20 insertions, 11 deletions
diff --git a/doc/api/index.rst b/doc/api/index.rst index 281d1dca96..806c7385a6 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -10,6 +10,7 @@ U-Boot API documentation efi getopt linker_lists + lmb logging pinctrl rng diff --git a/doc/api/lmb.rst b/doc/api/lmb.rst new file mode 100644 index 0000000000..2095bfa161 --- /dev/null +++ b/doc/api/lmb.rst @@ -0,0 +1,7 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Logical memory blocks +===================== + +.. kernel-doc:: include/lmb.h + :internal: diff --git a/include/lmb.h b/include/lmb.h index ee5b938e19..5efdf9d2e8 100644 --- a/include/lmb.h +++ b/include/lmb.h @@ -25,8 +25,9 @@ enum lmb_flags { /** * struct lmb_property - Description of one region. * - * @base: Base address of the region. - * @size: Size of the region + * @base: Base address of the region. + * @size: Size of the region + * @flags: memory region attributes */ struct lmb_property { phys_addr_t base; @@ -83,11 +84,11 @@ extern long lmb_reserve(struct lmb *lmb, phys_addr_t base, phys_size_t size); /** * lmb_reserve_flags - Reserve one region with a specific flags bitfield. * - * @lmb the logical memory block struct - * @base base address of the memory region - * @size size of the memory region - * @flags flags for the memory region - * @return 0 if OK, > 0 for coalesced region or a negative error code. + * @lmb: the logical memory block struct + * @base: base address of the memory region + * @size: size of the memory region + * @flags: flags for the memory region + * Return: 0 if OK, > 0 for coalesced region or a negative error code. */ long lmb_reserve_flags(struct lmb *lmb, phys_addr_t base, phys_size_t size, enum lmb_flags flags); @@ -103,10 +104,10 @@ extern int lmb_is_reserved(struct lmb *lmb, phys_addr_t addr); /** * lmb_is_reserved_flags - test if tha address is in reserved region with a bitfield flag * - * @lmb the logical memory block struct - * @addr address to be tested - * @flags flags bitfied to be tested - * @return 0 if not reserved or reserved without the requested flag else 1 + * @lmb: the logical memory block struct + * @addr: address to be tested + * @flags: flags bitfied to be tested + * Return: if not reserved or reserved without the requested flag else 1 */ int lmb_is_reserved_flags(struct lmb *lmb, phys_addr_t addr, int flags); extern long lmb_free(struct lmb *lmb, phys_addr_t base, phys_size_t size); |