MdePkg,UefiPayloadPkg: improve BaseFdtLib memreserve helper style

FdtNumRsv and FdtGetMemRsv were added for the benefit of UefiPayloadPkg,
but their naming matches neither upstream libfdt nor tianocore coding
style rules. And there was scope for improvement of the doxygen
descriptions as well.

These functions currently have only one in-tree user, UefiPayloadPkg
FdtParserLib. So rename them more conformant
FdtGetNumberOfReserveMapEntries
and
FdtGetReserveMapEntry
and update the description comment blocks, at the same time as
updating the existing user.

Continuous-integration-options: PatchCheck.ignore-multi-package
Signed-off-by: Leif Lindholm <quic_llindhol@quicinc.com>
This commit is contained in:
Leif Lindholm 2024-09-30 12:32:20 +01:00 committed by mergify[bot]
parent 4f4673846f
commit bf7dbf6380
3 changed files with 21 additions and 21 deletions

View File

@ -248,33 +248,33 @@ FdtSubnodeOffsetNameLen (
);
/**
Returns number of reserved ranges.
Returns the number of memory reserve map entries.
@param[in] Fdt The pointer to FDT blob.
@return The number of reserved ranges.
@return The number of entries in the reserve map.
**/
INTN
EFIAPI
FdtNumRsv (
FdtGetNumberOfReserveMapEntries (
IN CONST VOID *Fdt
);
/**
Returns reserved ranges.
Returns a memory reserve map entry.
@param[in] *Fdt The pointer to FDT blob.
@param[in] Index Reserved entry index in the table.
@param[out] Addr Address returned
@param[out] *Size Pointer to size of the address range
@param[in] Index Index of reserve map entry.
@param[out] Addr Pointer to 64-bit variable to hold the start address
@param[out] *Size Pointer to 64-bit variable to hold size of reservation
@return Returns reserved range.
@return 0 on success, or negative error code.
**/
INTN
EFIAPI
FdtGetMemRsv (
FdtGetReserveMapEntry (
IN CONST VOID *Fdt,
IN INTN Index,
OUT UINT64 *Addr,

View File

@ -207,16 +207,16 @@ FdtNextSubnode (
}
/**
Returns number of reserved mem nodes
Returns the number of memory reserve map entries.
@param[in] Fdt The pointer to FDT blob.
@param[in] Fdt The pointer to FDT blob.
@return total reserved mem nodes
@return The number of entries in the reserve map.
**/
INTN
EFIAPI
FdtNumRsv (
FdtGetNumberOfReserveMapEntries (
IN CONST VOID *Fdt
)
{
@ -224,19 +224,19 @@ FdtNumRsv (
}
/**
Returns reserved ranges.
Returns a memory reserve map entry.
@param[in] *Fdt The pointer to FDT blob.
@param[in] Index Reserved entry index in the table.
@param[out] Addr Address returned
@param[out] *Size Pointer to size of the address range
@param[in] Index Index of reserve map entry.
@param[out] Addr Pointer to 64-bit variable to hold the start address
@param[out] *Size Pointer to 64-bit variable to hold size of reservation
@return Returns reserved range.
@return 0 on success, or negative error code.
**/
INTN
EFIAPI
FdtGetMemRsv (
FdtGetReserveMapEntry (
IN CONST VOID *Fdt,
IN INTN Index,
OUT EFI_PHYSICAL_ADDRESS *Addr,

View File

@ -889,10 +889,10 @@ ParseDtb (
}
}
NumRsv = FdtNumRsv (Fdt);
NumRsv = FdtGetNumberOfReserveMapEntries (Fdt);
/* Look for an existing entry and add it to the efi mem map. */
for (index = 0; index < NumRsv; index++) {
if (FdtGetMemRsv (Fdt, index, &Addr, &Size) != 0) {
if (FdtGetReserveMapEntry (Fdt, index, &Addr, &Size) != 0) {
continue;
}