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

bloblist: Tidy up a few API comments

Browse Source 
Some comments for struct bloblist_hdr are a bit ambiguous. Update them to
clarify the meaning more precisely. Also document bloblist_get_stats()
properly.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass 2021-07-05 16:32:54 -06:00
parent 1fe5937549
commit faff554292
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/bloblist.h
View File

@ -64,10 +64,10 @@ enum bloblist_tag_t {
* first bloblist_rec starts at this offset from the start of the header * first bloblist_rec starts at this offset from the start of the header
* @flags: Space for BLOBLISTF_... flags (none yet) * @flags: Space for BLOBLISTF_... flags (none yet)
* @magic: BLOBLIST_MAGIC * @magic: BLOBLIST_MAGIC
* @size: Total size of all records (non-zero if valid) including this header. * @size: Total size of the bloblist (non-zero if valid) including this header.
* The bloblist extends for this many bytes from the start of this header. * The bloblist extends for this many bytes from the start of this header.
* @alloced: Total size allocated for this bloblist. When adding new records, * When adding new records, the bloblist can grow up to this size.
* the bloblist can grow up to this size. This starts out as * @alloced: Total size allocated so far for this bloblist. This starts out as
* sizeof(bloblist_hdr) since we need at least that much space to store a * sizeof(bloblist_hdr) since we need at least that much space to store a
* valid bloblist * valid bloblist
* @spare: Spare space (for future use) * @spare: Spare space (for future use)
@ -230,6 +230,10 @@ int bloblist_finish(void);
* bloblist_get_stats() - Get information about the bloblist * bloblist_get_stats() - Get information about the bloblist
* *
* This returns useful information about the bloblist * This returns useful information about the bloblist
*
* @basep: Returns base address of bloblist
* @sizep: Returns the number of bytes used in the bloblist
* @allocedp: Returns the total space allocated to the bloblist
*/ */
void bloblist_get_stats(ulong *basep, ulong *sizep, ulong *allocedp); void bloblist_get_stats(ulong *basep, ulong *sizep, ulong *allocedp);