mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
cf8227204e
Add AllocateSmbiosRecord() to SmbiosStringTableLib to encapsulate the SMBIOS spec Section 6.1.3 string-area termination rule. Callers pass the fixed structure size and an optional string table; the function appends the correct string area (two-byte double-NULL when no strings are present, or the full string set size from StringTableGetStringSetSize() when strings exist). This removes the need for each generator to open-code the double-NULL or manually compute the string area size. Signed-off-by: Girish Mahadevan <gmahadevan@nvidia.com> Signed-off-by: Varshit Pandya <varshit.pandya@arm.com>
140 lines
4.5 KiB
C
140 lines
4.5 KiB
C
/** @file
|
|
SMBIOS String Table Helper library.
|
|
|
|
Copyright (c) 2022, Arm Limited. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/** A structure representing a string in the string table.
|
|
*/
|
|
typedef struct StringElement {
|
|
/// Length of the string (does not include the NULL termination)
|
|
UINTN StringLen;
|
|
|
|
/// Reference to the string
|
|
CONST CHAR8 *String;
|
|
} STRING_ELEMENT;
|
|
|
|
/** A structure representing a string table.
|
|
*/
|
|
typedef struct StringTable {
|
|
/// Count of strings in the table
|
|
UINT8 StrCount;
|
|
|
|
/// Total length of all strings in the table (does not include
|
|
// the NULL termination for each string)
|
|
UINTN TotalStrLen;
|
|
|
|
/// Maximum string count
|
|
UINT8 MaxStringElements;
|
|
|
|
/// Pointer to the string table elements
|
|
STRING_ELEMENT *Elements;
|
|
} STRING_TABLE;
|
|
|
|
/** Add a string to the string table
|
|
|
|
@param[in] StrTable Pointer to the string table
|
|
@param[in] Str Pointer to the string
|
|
@param[out] StrRef Optional pointer to retrieve the string field
|
|
reference of the string in the string table
|
|
|
|
@return EFI_SUCCESS Success
|
|
@return EFI_INVALID_PARAMETER Invalid string table pointer
|
|
@return EFI_BUFFER_TOO_SMALL Insufficient space to add string
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
StringTableAddString (
|
|
IN STRING_TABLE *CONST StrTable,
|
|
IN CONST CHAR8 *Str,
|
|
OUT UINT8 *StrRef OPTIONAL
|
|
);
|
|
|
|
/** Returns the total size required to publish the strings to the SMBIOS
|
|
string area.
|
|
|
|
@param[in] StrTable Pointer to the string table
|
|
|
|
@return Total size required to publish the strings in the SMBIOS string area.
|
|
**/
|
|
UINTN
|
|
EFIAPI
|
|
StringTableGetStringSetSize (
|
|
IN STRING_TABLE *CONST StrTable
|
|
);
|
|
|
|
/** Iterate through the string table and publish the strings in the SMBIOS
|
|
string area.
|
|
|
|
@param[in] StrTable Pointer to the string table
|
|
@param[in] SmbiosStringAreaStart Start address of the SMBIOS string area.
|
|
@param[in] SmbiosStringAreaSize Size of the SMBIOS string area.
|
|
|
|
@return EFI_SUCCESS Success
|
|
@return EFI_INVALID_PARAMETER Invalid string table pointer
|
|
@return EFI_BUFFER_TOO_SMALL Insufficient space to publish strings
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
StringTablePublishStringSet (
|
|
IN STRING_TABLE *CONST StrTable,
|
|
IN CHAR8 *CONST SmbiosStringAreaStart,
|
|
IN CONST UINTN SmbiosStringAreaSize
|
|
);
|
|
|
|
/** Initialise the string table and allocate memory for the string elements.
|
|
|
|
@param[in] StrTable Pointer to the string table
|
|
@param[in] MaxStringElements Maximum number of strings that the string
|
|
table can hold.
|
|
|
|
@return EFI_SUCCESS Success
|
|
@return EFI_INVALID_PARAMETER Invalid string table pointer
|
|
@return EFI_OUT_OF_RESOURCES Failed to allocate memory for string elements
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
StringTableInitialize (
|
|
IN STRING_TABLE *CONST StrTable,
|
|
IN UINTN MaxStringElements
|
|
);
|
|
|
|
/** Free memory allocated for the string elements in the string table.
|
|
|
|
@param[in] StrTable Pointer to the string table
|
|
|
|
@return EFI_SUCCESS Success
|
|
@return EFI_INVALID_PARAMETER Invalid string table pointer or string elements
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
StringTableFree (
|
|
IN STRING_TABLE *CONST StrTable
|
|
);
|
|
|
|
/** Allocate a zeroed buffer for a SMBIOS record, including the string area.
|
|
|
|
Per SMBIOS Specification Section 6.1.3, if the structure has no strings the
|
|
formatted section is followed by two null (00h) bytes. If strings are
|
|
present each string is null-terminated and the set is terminated by an
|
|
additional null byte. This function encapsulates that rule so callers do
|
|
not need to account for the terminator explicitly.
|
|
|
|
@param[in] StructSize Size of the fixed-size part of the SMBIOS structure.
|
|
@param[in] StrTable Optional pointer to a populated string table.
|
|
If NULL, the allocation includes only the two-byte
|
|
double-NULL terminator.
|
|
If non-NULL, the allocation includes the full string
|
|
area as returned by StringTableGetStringSetSize().
|
|
|
|
@return Pointer to the allocated SMBIOS record buffer, or NULL on failure.
|
|
**/
|
|
VOID *
|
|
EFIAPI
|
|
AllocateSmbiosRecord (
|
|
IN UINTN StructSize,
|
|
IN STRING_TABLE *StrTable OPTIONAL
|
|
);
|