Skip to content

Commit

Permalink
MdePkg: add various additional functions to BaseFdtLib
Browse files Browse the repository at this point in the history 
- FdtOffsetPointer
- FdtParentOffset
- FdtNodeOffsetByPhandle
- FdtStringListContains
- FdtGetAliasNameLen
- FdtPathOffsetNameLen
- FdtPathOffset

Signed-off-by: Leif Lindholm <[email protected]>
  • Loading branch information
@leiflindholm @mergify
leiflindholm authored and mergify[bot] committed Oct 2, 2024
1 parent 450a001 commit 9a1d546
Show file tree
Hide file tree
Showing 2 changed files with 272 additions and 0 deletions.
115 changes: 115 additions & 0 deletions MdePkg/Include/Library/FdtLib.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,23 @@ FdtCreateEmptyTree (
IN UINT32 BufferSize
);

/**
Returns a pointer to the node at a given offset.
@param[in] Fdt The pointer to FDT blob.
@param[in] Offset The offset to node.
@param[in] Length Maximum length of node.
@return pointer to node.
**/
CONST VOID *
EFIAPI
FdtOffsetPointer (
IN CONST VOID *Fdt,
IN INT32 Offset,
IN UINT32 Length
);

/**
Returns a offset of next node from the given node.
Expand Down Expand Up @@ -437,6 +454,21 @@ FdtGetReserveMapEntry (
OUT UINT64 *Size
);

/**
Find the parent of a given node.
@param[in] Fdt The pointer to FDT blob.
@param[in] NodeOffset The offset to the node to find the parent for.
@return Structure block offset, or negative return value.
**/
INT32
EFIAPI
FdtParentOffset (
IN CONST VOID *Fdt,
IN INT32 NodeOffset
);

/**
Returns a offset of first node which includes the given property name and value.
Expand All @@ -459,6 +491,38 @@ FdtNodeOffsetByPropertyValue (
IN INT32 PropertyLength
);

/**
Returns a offset of first node which includes the given property name and value.
@param[in] Fdt The pointer to FDT blob.
@param[in] Phandle Phandle value to search for.
@return The offset to node with matching Phandle value.
**/
INT32
EFIAPI
FdtNodeOffsetByPhandle (
IN CONST VOID *Fdt,
IN UINT32 Phandle
);

/**
Look for a string in a stringlist
@param[in] StringList Pointer to stringlist to search.
@param[in] ListLength Length of StringList.
@param[in] String Pointer to string to search for.
@return 1 if found.
**/
INT32
EFIAPI
FdtStringListContains (
IN CONST CHAR8 *StringList,
IN INT32 ListLength,
IN CONST CHAR8 *String
);

/**
Returns a property with the given name from the given node.
Expand All @@ -480,6 +544,25 @@ FdtGetProperty (
IN INT32 *Length
);

/**
Returns a pointer to a node mapped to an alias matching a substring.
@param[in] Fdt The pointer to FDT blob.
@param[in] Name The alias name string.
@param[in] Length The length to the size of the property found.
@return A pointer to the expansion of the alias matching the substring,
or NULL if alias not found.
**/
CONST CHAR8 *
EFIAPI
FdtGetAliasNameLen (
IN CONST VOID *Fdt,
IN CONST CHAR8 *Name,
IN INT32 Length
);

/**
Returns a offset of first property in the given node.
Expand Down Expand Up @@ -650,6 +733,38 @@ FdtDelProp (
IN CONST CHAR8 *Name
);

/**
Finds a tree node by substring
@param[in] Fdt The pointer to FDT blob.
@param[in] Path Full path of the node to locate.
@param[in] NameLength The length of the name to check only.
@return structure block offset of the node with the requested path (>=0), on success
**/
INT32
EFIAPI
FdtPathOffsetNameLen (
IN CONST VOID *Fdt,
IN CONST CHAR8 *Path,
IN INT32 NameLength
);

/**
Finds a tree node by its full path.
@param[in] Fdt The pointer to FDT blob.
@param[in] Path Full path of the node to locate.
@return structure block offset of the node with the requested path (>=0), on success
**/
INT32
EFIAPI
FdtPathOffset (
IN CONST VOID *Fdt,
IN CONST CHAR8 *Path
);

/**
Returns the name of a given node.
Expand Down
157 changes: 157 additions & 0 deletions MdePkg/Library/BaseFdtLib/FdtLib.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,26 @@ FdtPack (
return fdt_pack (Fdt);
}

/**
Returns a pointer to the node at a given offset.
@param[in] Fdt The pointer to FDT blob.
@param[in] Offset The offset to node.
@param[in] Length Maximum length of node.
@return pointer to node.
**/
CONST VOID *
EFIAPI
FdtOffsetPointer (
IN CONST VOID *Fdt,
IN INT32 Offset,
IN UINT32 Length
)
{
return fdt_offset_ptr (Fdt, Offset, Length);
}

/**
Returns a offset of next node from the given node.
Expand Down Expand Up @@ -307,6 +327,45 @@ FdtSubnodeOffsetNameLen (
return fdt_subnode_offset_namelen (Fdt, ParentOffset, Name, NameLength);
}

/**
Returns a offset of first node which matches the given name.
@param[in] Fdt The pointer to FDT blob.
@param[in] ParentOffset The offset to the node which start find under.
@param[in] Name The name to search the node with the name.
@return The offset to node offset with given node name.
**/
INT32
EFIAPI
FdtSubnodeOffset (
IN CONST VOID *Fdt,
IN INT32 ParentOffset,
IN CONST CHAR8 *Name
)
{
return fdt_subnode_offset (Fdt, ParentOffset, Name);
}

/**
Find the parent of a given node.
@param[in] Fdt The pointer to FDT blob.
@param[in] NodeOffset The offset to the node to find the parent for.
@return Structure block offset, or negative return value.
**/
INT32
EFIAPI
FdtParentOffset (
IN CONST VOID *Fdt,
IN INT32 NodeOffset
)
{
return fdt_parent_offset (Fdt, NodeOffset);
}

/**
Returns a offset of first node which includes the given property name and value.
Expand All @@ -332,6 +391,44 @@ FdtNodeOffsetByPropertyValue (
return fdt_node_offset_by_prop_value (Fdt, StartOffset, PropertyName, PropertyValue, PropertyLength);
}

/**
Returns a offset of first node which includes the given property name and value.
@param[in] Fdt The pointer to FDT blob.
@param[in] Phandle Phandle value to search for.
@return The offset to node with matching Phandle value.
**/
INT32
EFIAPI
FdtNodeOffsetByPhandle (
IN CONST VOID *Fdt,
IN UINT32 Phandle
)
{
return fdt_node_offset_by_phandle (Fdt, Phandle);
}

/**
Look for a string in a stringlist
@param[in] StringList Pointer to stringlist to search.
@param[in] ListLength Length of StringList.
@param[in] String Pointer to string to search for.
@return 1 if found.
**/
INT32
EFIAPI
FdtStringListContains (
IN CONST CHAR8 *StringList,
IN INT32 ListLength,
IN CONST CHAR8 *String
)
{
return fdt_stringlist_contains (StringList, ListLength, String);
}

/**
Returns a property with the given name from the given node.
Expand All @@ -356,6 +453,28 @@ FdtGetProperty (
return (FDT_PROPERTY *)fdt_get_property (Fdt, NodeOffset, Name, Length);
}

/**
Returns a pointer to a node mapped to an alias matching a substring.
@param[in] Fdt The pointer to FDT blob.
@param[in] Name The alias name string.
@param[in] Length The length to the size of the property found.
@return A pointer to the expansion of the alias matching the substring,
or NULL if alias not found.
**/
CONST CHAR8 *
EFIAPI
FdtGetAliasNameLen (
IN CONST VOID *Fdt,
IN CONST CHAR8 *Name,
IN INT32 Length
)
{
return fdt_get_alias_namelen (Fdt, Name, Length);
}

/**
Returns a offset of first property in the given node.
Expand Down Expand Up @@ -557,6 +676,44 @@ FdtDelProp (
return fdt_delprop (Fdt, NodeOffset, Name);
}

/**
Finds a tree node by substring
@param[in] Fdt The pointer to FDT blob.
@param[in] Path Full path of the node to locate.
@param[in] NameLength The length of the name to check only.
@return structure block offset of the node with the requested path (>=0), on success
**/
INT32
EFIAPI
FdtPathOffsetNameLen (
IN CONST VOID *Fdt,
IN CONST CHAR8 *Path,
IN INT32 NameLength
)
{
return fdt_path_offset_namelen (Fdt, Path, NameLength);
}

/**
Finds a tree node by its full path.
@param[in] Fdt The pointer to FDT blob.
@param[in] Path Full path of the node to locate.
@return structure block offset of the node with the requested path (>=0), on success
**/
INT32
EFIAPI
FdtPathOffset (
IN CONST VOID *Fdt,
IN CONST CHAR8 *Path
)
{
return fdt_path_offset (Fdt, Path);
}

/**
Returns the name of a given node.
Expand Down

0 comments on commit 9a1d546

Please sign in to comment.