blob: b1a7f5174c0a29eadbb4109fc12ef11704fe8fd4 [file] [log] [blame]
#ifndef BIOS_TABLE_H__
#define BIOS_TABLE_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "bios.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
/** @struct pldm_bios_table_iter
* structure representing bios table iterator
*/
struct pldm_bios_table_iter;
/** @brief Create a bios table iterator
* @param[in] table - Pointer to table data
* @param[in] length - Length of table data
* @param[in] type - Type of pldm bios table
* @return Iterator to the beginning
*/
struct pldm_bios_table_iter *
pldm_bios_table_iter_create(const void *table, size_t length,
enum pldm_bios_table_types type);
/** @brief Release a bios table iterator
* @param[in] iter - Pointer to bios table iterator
*/
void pldm_bios_table_iter_free(struct pldm_bios_table_iter *iter);
/** @brief Check if the iterator reaches the end of the bios table
* @param[in] iter - Pointer to the bios table iterator
* @return true if iterator reaches the end
* @note *end* is a position after the last entry.
*/
bool pldm_bios_table_iter_is_end(const struct pldm_bios_table_iter *iter);
/** @brief Get iterator to next entry
* @param[in] iter - Pointer the bios table iterator
*/
void pldm_bios_table_iter_next(struct pldm_bios_table_iter *iter);
/** @brief Get the bios table entry that the iterator points to
* @param[in] iter - Pointer to the bios table iterator
* @return Pointer to an entry in bios table
*/
const void *pldm_bios_table_iter_value(struct pldm_bios_table_iter *iter);
/** @brief Get the bios attribute table entry that the iterator points to
* @param[in] iter - Pointer the bios attribute table iterator
* @return Pointer to an entry in bios attribute table
*/
static inline const struct pldm_bios_attr_table_entry *
pldm_bios_table_iter_attr_entry_value(struct pldm_bios_table_iter *iter)
{
return (const struct pldm_bios_attr_table_entry *)
pldm_bios_table_iter_value(iter);
}
/** @brief Get the bios string table entry that the iterator ponit to
* @param[in] iter - Pointer the bios string table iterator
* @return Pointer to an entry in bios string table
*/
static inline const struct pldm_bios_string_table_entry *
pldm_bios_table_iter_string_entry_value(struct pldm_bios_table_iter *iter)
{
return (const struct pldm_bios_string_table_entry *)
pldm_bios_table_iter_value(iter);
}
/** @brief Get the bios attribute value table entry that the iterator ponit to
* @param[in] iter - Pointer the bios attribute value table iterator
* @return Pointer to an entry in bios attribute value table
*/
static inline const struct pldm_bios_attr_val_table_entry *
pldm_bios_table_iter_attr_value_entry_value(struct pldm_bios_table_iter *iter)
{
return (const struct pldm_bios_attr_val_table_entry *)
pldm_bios_table_iter_value(iter);
}
/** @brief Get the length of an entry in the BIOS String Table
* @param[in] string_length - Length of string
* @return Length of an entry in bytes
*/
size_t pldm_bios_table_string_entry_encode_length(uint16_t string_length);
/** @brief Create an entry of BIOS String Table
* @param[out] entry - Pointer to a buffer to create an entry
* @param[in] entry_length - Length of the buffer to create an entry
* @param[in] str - String itself
* @param[in] str_length - Length of the string
*/
void pldm_bios_table_string_entry_encode(void *entry, size_t entry_length,
const char *str, uint16_t str_length);
/** @brief Create an entry of BIOS String Table and check the validity of the
* parameters
* @param[out] entry - Pointer to a buffer to create an entry
* @param[in] entry_length - Length of the buffer to create an entry
* @param[in] str - String itself
* @param[in] str_length - Length of the string
* @return pldm_completion_codes
*/
int pldm_bios_table_string_entry_encode_check(void *entry, size_t entry_length,
const char *str,
uint16_t str_length);
/** @brief Get the string handle for the entry
* @param[in] entry - Pointer to a bios string table entry
* @return Handle to identify a string in the bios string table
*/
uint16_t pldm_bios_table_string_entry_decode_handle(
const struct pldm_bios_string_table_entry *entry);
/** @brief Get the string length for the entry
* @param[in] entry - Pointer to a bios string table entry
* @return Length of string in bytes
*/
uint16_t pldm_bios_table_string_entry_decode_string_length(
const struct pldm_bios_string_table_entry *entry);
/** @brief Get the string(at most one less than *size* characters) from the
* entry
* @param[in] entry - Pointer to a bios string table entry
* @param[out] buffer - Pointer to a buffer to store the string
* @param[in] size - Size of the buffer to store the string
* @return Length of the string decoded
*/
uint16_t pldm_bios_table_string_entry_decode_string(
const struct pldm_bios_string_table_entry *entry, char *buffer,
size_t size);
/** @brief Get the string from the entry and check the validity of the
* parameters
* @param[in] entry - Pointer to a bios string table entry
* @param[out] buffer - Pointer to a buffer to store the string
* @param[in] size - Size of the buffer to store the string
* @return pldm_completion_codes
*/
int pldm_bios_table_string_entry_decode_string_check(
const struct pldm_bios_string_table_entry *entry, char *buffer,
size_t size);
/** @brief Find an entry in bios string table by string
* @param[in] table - The BIOS String Table
* @param[in] length - Length of the BIOS String Table
* @param[in] str - String itself
* @return Pointer to an entry in the bios string table
*/
const struct pldm_bios_string_table_entry *
pldm_bios_table_string_find_by_string(const void *table, size_t length,
const char *str);
/** @brief Find an entry in bios string table by handle
* @param[in] table - The BIOS String Table
* @param[in] length - Length of the BIOS String Table
* @param[in] handle - Handle to identify a string in the bios string table
* @return Pointer to an entry in the bios string table
*/
const struct pldm_bios_string_table_entry *
pldm_bios_table_string_find_by_handle(const void *table, size_t length,
uint16_t handle);
/** @struct pldm_bios_table_attr_entry_enum_info
*
* An auxiliary structure for passing parameters to @ref
* pldm_bios_table_attr_entry_enum_encode
*
*/
struct pldm_bios_table_attr_entry_enum_info {
uint16_t name_handle; //!< attribute name handle
bool read_only; //!< indicate whether the attribute is read-only
uint8_t pv_num; //!< number of possible values
const uint16_t *pv_handle; //!< handles of possible values
uint8_t def_num; //!< nnumber of default values
const uint8_t *def_index; //!< indices of default values.
};
/** @brief Get length that an attribute entry(type: enum) will take
* @param[in] pv_num - Number of possible values
* @param[in] def_num - Number of default values
* @return The length that an entry(type: enum) will take
*/
size_t pldm_bios_table_attr_entry_enum_encode_length(uint8_t pv_num,
uint8_t def_num);
/** @brief Create an entry of BIOS Attribute Table (type: enum)
* @param[out] entry - Pointer to a buffer to create an entry
* @param[in] entry_length - Length of the buffer to create an entry
* @param[in] info - Pointer to an auxiliary structure @ref
* pldm_bios_table_attr_entry_enum_info
*/
void pldm_bios_table_attr_entry_enum_encode(
void *entry, size_t entry_length,
const struct pldm_bios_table_attr_entry_enum_info *info);
/** @brief Create an entry of BIOS Attribute Table (type: enum) and check the
* validity of the parameters
* @param[out] entry - Pointer to a buffer to create an entry
* @param[in] entry_length - Length of the buffer to create an entry
* @param[in] info - Pointer to an auxiliary structure @ref
* pldm_bios_table_attr_entry_enum_info
* @return pldm_completion_codes
*/
int pldm_bios_table_attr_entry_enum_encode_check(
void *entry, size_t entry_length,
const struct pldm_bios_table_attr_entry_enum_info *info);
/** @brief Get the total number of possible values for the entry
* @param[in] entry - Pointer to bios attribute table entry
* @return total number of possible values
*/
uint8_t pldm_bios_table_attr_entry_enum_decode_pv_num(
const struct pldm_bios_attr_table_entry *entry);
/** @brief Get the total number of possible values for the entry and check the
* validity of the parameters
* @param[in] entry - Pointer to bios attribute table entry
* @param[out] pv_num - Pointer to total number of possible values
* @return pldm_completion_codes
*/
int pldm_bios_table_attr_entry_enum_decode_pv_num_check(
const struct pldm_bios_attr_table_entry *entry, uint8_t *pv_num);
/** @brief Get the total number of default values for the entry
* @param[in] entry - Pointer to bios attribute table entry
* @return total number of default values
*/
uint8_t pldm_bios_table_attr_entry_enum_decode_def_num(
const struct pldm_bios_attr_table_entry *entry);
/** @brief Get the total number of default values for the entry and check the
* validity of the parameters
* @param[in] entry - Pointer to bios attribute table entry
* @param[out] def_num - Pointer to total number of default values
* @return pldm_completion_codes
*/
int pldm_bios_table_attr_entry_enum_decode_def_num_check(
const struct pldm_bios_attr_table_entry *entry, uint8_t *def_num);
/** @brief Get possible values string handles
* @param[in] entry - Pointer to bios attribute table entry
* @param[out] pv_hdls - Pointer to a buffer to stroe
* PossibleValuesStringHandles
* @param[in] pv_num - Number of PossibleValuesStringHandles expected
* @return pldm_completion_codes
*/
uint8_t pldm_bios_table_attr_entry_enum_decode_pv_hdls(
const struct pldm_bios_attr_table_entry *entry, uint16_t *pv_hdls,
uint8_t pv_num);
/** @brief Get possible values string handles and check the validity of the
* parameters
* @param[in] entry - Pointer to bios attribute table entry
* @param[out] pv_hdls - Pointer to a buffer to stroe
* PossibleValuesStringHandles
* @param[in] pv_num - Number of PossibleValuesStringHandles the buffer can
* stroe
* @return Number of PossibleValuesStringHandles decoded
*/
int pldm_bios_table_attr_entry_enum_decode_pv_hdls_check(
const struct pldm_bios_attr_table_entry *entry, uint16_t *pv_hdls,
uint8_t pv_num);
/** @struct pldm_bios_table_attr_entry_string_info
*
* An auxiliary structure for passing parameters to @ref
* pldm_bios_table_attr_entry_string_encode
*
*/
struct pldm_bios_table_attr_entry_string_info {
uint16_t name_handle; //!< attribute name handle
bool read_only; //!< indicate whether the attribute is read-only
uint8_t string_type; //!< The type of the string
uint16_t min_length; //!< The minimum length of the string in bytes
uint16_t max_length; //!< The maximum length of the string in bytes
uint16_t def_length; //!< The length of the defaut string in bytes
const char *def_string; //!< The default string itself
};
/** @brief Check fields in @ref pldm_bios_table_attr_entry_string_info
* @param[in] info - Pointer to the pldm_bios_table_attr_entry_string_info
* @param[out] errmsg - Pointer to an errmsg stored in the statically allocated
* memory
* @return pldm_completion_codes
*/
int pldm_bios_table_attr_entry_string_info_check(
const struct pldm_bios_table_attr_entry_string_info *info,
const char **errmsg);
/** @brief Get length that an attribute entry(type: string) will take
* @param[in] def_str_len - Length of default string
* @return The length that an entry(type: string) will take
*/
size_t pldm_bios_table_attr_entry_string_encode_length(uint16_t def_str_len);
/** @brief Create an entry of BIOS Attribute Table (type: string)
* @param[out] entry - Pointer to a buffer to create an entry
* @param[in] entry_length - Length of the buffer to create an entry
* @param[in] info - Pointer to an auxiliary structure @ref
* pldm_bios_table_attr_entry_string_info
*/
void pldm_bios_table_attr_entry_string_encode(
void *entry, size_t entry_length,
const struct pldm_bios_table_attr_entry_string_info *info);
/** @brief Create an entry of BIOS Attribute Table (type: string) and check the
* validity of the parameters
* @param[out] entry - Pointer to a buffer to create an entry
* @param[in] entry_length - Length of the buffer to create an entry
* @param[in] info - Pointer to an auxiliary structure @ref
* pldm_bios_table_attr_entry_string_info
* @return pldm_completion_codes
*/
int pldm_bios_table_attr_entry_string_encode_check(
void *entry, size_t entry_length,
const struct pldm_bios_table_attr_entry_string_info *info);
/** @brief Get the length of default string in bytes for the entry
* @param[in] entry - Pointer to bios attribute table entry
* @return length of default string in bytes
*/
uint16_t pldm_bios_table_attr_entry_string_decode_def_string_length(
const struct pldm_bios_attr_table_entry *entry);
/** @brief Get the length of default string in bytes for the entry and check the
* validity of the parameters
* @param[in] entry - Pointer to bios attribute table entry
* @param[out] def_string_length Pointer to length of default string in bytes
* @return pldm_completion_codes
*/
int pldm_bios_table_attr_entry_string_decode_def_string_length_check(
const struct pldm_bios_attr_table_entry *entry,
uint16_t *def_string_length);
/** @struct pldm_bios_table_attr_entry_integer_info
*
* An auxiliary structure for passing parameters to @ref
* pldm_bios_table_attr_entry_integer_encode
*
*/
struct pldm_bios_table_attr_entry_integer_info {
uint16_t name_handle; //!< attribute name handle
bool read_only; //!< indicate whether the attribute is read-only
uint64_t lower_bound; //!< The lower bound on the integer value
uint64_t upper_bound; //!< The upper bound on the integer value
uint32_t scalar_increment; //!< The scalar value that is used for the
//!< increments to this integer
uint64_t default_value; //!< The default value of the integer
};
/** @brief Check fields in @ref pldm_bios_table_attr_entry_integer_info
* @param[in] info - Pointer to the pldm_bios_table_attr_entry_integer_info
* @param[out] errmsg - Pointer to an errmsg stored in the statically allocated
* memory
* @return pldm_completion_codes
*/
int pldm_bios_table_attr_entry_integer_info_check(
const struct pldm_bios_table_attr_entry_integer_info *info,
const char **errmsg);
/** @brief Get length that an attribute entry(type: integer) will take
* @return The length that an entry(type: integer) will take
*/
size_t pldm_bios_table_attr_entry_integer_encode_length();
/** @brief Create an entry of BIOS Attribute Table (type: integer)
* @param[out] entry - Pointer to a buffer to create an entry
* @param[in] entry_length - Length of the buffer to create an entry
* @param[in] info - Pointer to an auxiliary structure @ref
* pldm_bios_table_attr_entry_integer_info
*/
void pldm_bios_table_attr_entry_integer_encode(
void *entry, size_t entry_length,
const struct pldm_bios_table_attr_entry_integer_info *info);
/** @brief Create an entry of BIOS Attribute Table (type: integer) and check the
* validity of the parameters
* @param[out] entry - Pointer to a buffer to create an entry
* @param[in] entry_length - Length of the buffer to create an entry
* @param[in] info - Pointer to an auxiliary structure @ref
* pldm_bios_table_attr_entry_integer_info
* @return pldm_completion_codes
*/
int pldm_bios_table_attr_entry_integer_encode_check(
void *entry, size_t entry_length,
const struct pldm_bios_table_attr_entry_integer_info *info);
/** @brief Get length that an attribute value entry(type: enum) will take
* @param[in] count - Total number of current values for this enumeration
* @return The length that an entry(type: enum) will take
*/
size_t pldm_bios_table_attr_value_entry_encode_enum_length(uint8_t count);
/** @brief Create an attribute value entry(type: enum)
* @param[out] entry - Pointer to bios attribute value entry
* @param[in] entry_length - Length of attribute value entry
* @param[in] attr_handle - This handle points to an attribute in the
* BIOS Attribute Vlaue Table.
* @param[in] attr_type - Type of this attribute in the BIOS Attribute Value
* Table
* @param[in] count - Total number of current values for this enum attribute
* @param[in] handle_indexes - Index into the array(provided in the BIOS
* Attribute Table) of the possible values of string handles for this attribute.
*/
void pldm_bios_table_attr_value_entry_encode_enum(
void *entry, size_t entry_length, uint16_t attr_handle, uint8_t attr_type,
uint8_t count, uint8_t *handle_indexes);
/** @brief Get number of current values for the enum entry
* @param[in] entry - Pointer to bios attribute value table entry
* @return Total number of current values for this enumeration
*/
uint8_t pldm_bios_table_attr_value_entry_enum_decode_number(
const struct pldm_bios_attr_val_table_entry *entry);
/** @brief Create an attribute value entry(type: enum) and check the validity of
* the parameters
* @param[out] entry - Pointer to bios attribute value entry
* @param[in] entry_length - Length of attribute value entry
* @param[in] attr_handle - This handle points to an attribute in the
* BIOS Attribute Vlaue Table.
* @param[in] attr_type - Type of this attribute in the BIOS Attribute Value
* Table
* @param[in] count - Total number of current values for this enum attribute
* @param[in] handle_indexes - Index into the array(provided in the BIOS
* Attribute Table) of the possible values of string handles for this attribute.
* @return pldm_completion_codes
*/
int pldm_bios_table_attr_value_entry_encode_enum_check(
void *entry, size_t entry_length, uint16_t attr_handle, uint8_t attr_type,
uint8_t count, uint8_t *handle_indexes);
/** @brief Get length that an attribute value entry(type: string) will take
* @param[in] string_length - Length of the current string in byte, 0 indicates
* that the current string value is not set.
* @return The length that an entry(type: string) will take
*/
size_t
pldm_bios_table_attr_value_entry_encode_string_length(uint16_t string_length);
/** @brief Create an attribute value entry(type: string)
* @param[out] entry - Pointer to bios attribute value entry
* @param[in] entry_length - Length of attribute value entry
* @param[in] attr_handle - This handle points to an attribute in the
* BIOS Attribute Vlaue Table.
* @param[in] attr_type - Type of this attribute in the BIOS Attribute Value
* Table
* @param[in] string_length - Length of current string in bytes. 0 indicates
* that the current string value is not set.
* @param[in] string - The current string itsel
*/
void pldm_bios_table_attr_value_entry_encode_string(
void *entry, size_t entry_length, uint16_t attr_handle, uint8_t attr_type,
uint16_t string_length, const char *string);
/** @brief Get length of the current string in bytes
* @param [in] entry - Pointer to bios attribute value table entry
* @return The length of the current string in bytes
*/
uint16_t pldm_bios_table_attr_value_entry_string_decode_length(
const struct pldm_bios_attr_val_table_entry *entry);
/** @brief Create an attribute value entry(type: string) and check the validity
* of the parameters
* @param[out] entry - Pointer to bios attribute value entry
* @param[in] entry_length - Length of attribute value entry
* @param[in] attr_handle - This handle points to an attribute in the
* BIOS Attribute Vlaue Table.
* @param[in] attr_type - Type of this attribute in the BIOS Attribute Value
* Table
* @param[in] string_length - Length of current string in bytes. 0 indicates
* that the current string value is not set.
* @param[in] string - The current string itsel
* @return pldm_completion_codes
*/
int pldm_bios_table_attr_value_entry_encode_string_check(
void *entry, size_t entry_length, uint16_t attr_handle, uint8_t attr_type,
uint16_t string_length, const char *string);
/** @brief Get length that an attribute value entry(type: integer) will take
* @return The length that an entry(type: integer) will take
*/
size_t pldm_bios_table_attr_value_entry_encode_integer_length();
/** @brief Create an attribute value entry(type: integer)
* @param[out] entry - Pointer to bios attribute value entry
* @param[in] entry_length - Length of attribute value entry
* @param[in] attr_handle - This handle points to an attribute in the
* BIOS Attribute Vlaue Table.
* @param[in] attr_type - Type of this attribute in the BIOS Attribute Value
* Table
* @param[in] cv - Current Value
*/
void pldm_bios_table_attr_value_entry_encode_integer(void *entry,
size_t entry_length,
uint16_t attr_handle,
uint8_t attr_type,
uint64_t cv);
/** @brief Create an attribute value entry(type: integer) and check the validity
* of the parameters
* @param[out] entry - Pointer to bios attribute value entry
* @param[in] entry_length - Length of attribute value entry
* @param[in] attr_handle - This handle points to an attribute in the
* BIOS Attribute Vlaue Table.
* @param[in] attr_type - Type of this attribute in the BIOS Attribute Value
* Table
* @param[in] cv - Current Value
* @return pldm_completion_codes
*/
int pldm_bios_table_attr_value_entry_encode_integer_check(void *entry,
size_t entry_length,
uint16_t attr_handle,
uint8_t attr_type,
uint64_t cv);
/** @brief Get the handle from the attribute value entry
* @param[in] entry - Pointer to bios attribute value entry
* @return handle to identify the attribute in the attribute value table
*/
uint16_t pldm_bios_table_attr_value_entry_decode_handle(
const struct pldm_bios_attr_val_table_entry *entry);
/** @brief Get the value field length from the attribute value entry
* @param[in] entry - Pointer to bios attribute value entry
* @return Length of the value filed
*/
size_t pldm_bios_table_attr_value_entry_value_length(
const struct pldm_bios_attr_val_table_entry *entry);
/** @brief Get the value field address from the attribute value entry
* @param[in] entry - Pointer to bios attribute value entry
* @return Pointer to the value field in the attribute value entry;
*/
const uint8_t *pldm_bios_table_attr_value_entry_value(
const struct pldm_bios_attr_val_table_entry *entry);
/** @brief Find an entry in attribute value table by handle
* @param[in] table - The BIOS Attribute Value Table
* @param[in] length - Length of the BIOS Attribute Value Table
* @param[in] handle - handle to identify the attribute in the attribute value
* table
* @return Pointer to the entry
*/
const struct pldm_bios_attr_val_table_entry *
pldm_bios_table_attr_value_find_by_handle(const void *table, size_t length,
uint16_t handle);
/** @brief Get the size of pad and checksum
* @param[in] size_without_pad - Table size without pad
* @return The size of pad and checksum
*/
size_t pldm_bios_table_pad_checksum_size(size_t size_without_pad);
/** @brief Append pad and checksum at the end of the table
* @param[in,out] table - Pointer to a buffer of a bios table
* @param[in] size - Size of the buffer of a bios table
* @param[in] size_without_pad - Table size without pad and checksum
*/
void pldm_bios_table_append_pad_checksum(void *table, size_t size,
size_t size_without_pad);
#ifdef __cplusplus
}
#endif
#endif