Difuse/u-boot
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

doc: add include/lmb.h to the HTML documentation

Browse source 
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>
This commit is contained in:
Heinrich Schuchardt 2021-11-14 08:43:07 +01:00 committed by Heinrich Schuchardt
parent 5a515132d9
commit 4ad4c2daeb
3 changed files with 20 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/api/index.rst
View file

@ -10,6 +10,7 @@ U-Boot API documentation
efi efi
getopt getopt
linker_lists linker_lists
lmb
logging logging
pinctrl pinctrl
rng rng

7
doc/api/lmb.rst Normal file
View file

@ -0,0 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+
Logical memory blocks
=====================
.. kernel-doc:: include/lmb.h
:internal:

23
include/lmb.h
View file

@ -25,8 +25,9 @@ enum lmb_flags {
/** /**
* struct lmb_property - Description of one region. * struct lmb_property - Description of one region.
* *
* @base: Base address of the region. * @base: Base address of the region.
* @size: Size of the region * @size: Size of the region
* @flags: memory region attributes
*/ */
struct lmb_property { struct lmb_property {
phys_addr_t base; 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_reserve_flags - Reserve one region with a specific flags bitfield.
* *
* @lmb the logical memory block struct * @lmb: the logical memory block struct
* @base base address of the memory region * @base: base address of the memory region
* @size size of the memory region * @size: size of the memory region
* @flags flags for the memory region * @flags: flags for the memory region
* @return 0 if OK, > 0 for coalesced region or a negative error code. * Return: 0 if OK, > 0 for coalesced region or a negative error code.
*/ */
long lmb_reserve_flags(struct lmb *lmb, phys_addr_t base, long lmb_reserve_flags(struct lmb *lmb, phys_addr_t base,
phys_size_t size, enum lmb_flags flags); 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_is_reserved_flags - test if tha address is in reserved region with a bitfield flag
* *
* @lmb the logical memory block struct * @lmb: the logical memory block struct
* @addr address to be tested * @addr: address to be tested
* @flags flags bitfied to be tested * @flags: flags bitfied to be tested
* @return 0 if not reserved or reserved without the requested flag else 1 * 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); 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); extern long lmb_free(struct lmb *lmb, phys_addr_t base, phys_size_t size);