blob: f84b8c762c6d9e1e28534ee31a6c27aa8c2f836f [file] [log] [blame]
#ifndef FW_UPDATE_H
#define FW_UPDATE_H
#ifdef __cplusplus
extern "C" {
#endif
#include "base.h"
#include "utils.h"
#define PLDM_FWUP_COMPONENT_BITMAP_MULTIPLE 8
#define PLDM_QUERY_DEVICE_IDENTIFIERS_REQ_BYTES 0
/** @brief Minimum length of device descriptor, 2 bytes for descriptor type,
* 2 bytes for descriptor length and atleast 1 byte of descriptor data
*/
#define PLDM_FWUP_DEVICE_DESCRIPTOR_MIN_LEN 5
#define PLDM_GET_FIRMWARE_PARAMETERS_REQ_BYTES 0
/** @brief PLDM Firmware update commands
*/
enum pldm_firmware_update_commands {
PLDM_QUERY_DEVICE_IDENTIFIERS = 0x01,
PLDM_GET_FIRMWARE_PARAMETERS = 0x02
};
/** @brief String type values defined in the PLDM firmware update specification
*/
enum pldm_firmware_update_string_type {
PLDM_STR_TYPE_UNKNOWN = 0,
PLDM_STR_TYPE_ASCII = 1,
PLDM_STR_TYPE_UTF_8 = 2,
PLDM_STR_TYPE_UTF_16 = 3,
PLDM_STR_TYPE_UTF_16LE = 4,
PLDM_STR_TYPE_UTF_16BE = 5
};
/** @brief Descriptor types defined in PLDM firmware update specification
*/
enum pldm_firmware_update_descriptor_types {
PLDM_FWUP_PCI_VENDOR_ID = 0x0000,
PLDM_FWUP_IANA_ENTERPRISE_ID = 0x0001,
PLDM_FWUP_UUID = 0x0002,
PLDM_FWUP_PNP_VENDOR_ID = 0x0003,
PLDM_FWUP_ACPI_VENDOR_ID = 0x0004,
PLDM_FWUP_IEEE_ASSIGNED_COMPANY_ID = 0x0005,
PLDM_FWUP_SCSI_VENDOR_ID = 0x0006,
PLDM_FWUP_PCI_DEVICE_ID = 0x0100,
PLDM_FWUP_PCI_SUBSYSTEM_VENDOR_ID = 0x0101,
PLDM_FWUP_PCI_SUBSYSTEM_ID = 0x0102,
PLDM_FWUP_PCI_REVISION_ID = 0x0103,
PLDM_FWUP_PNP_PRODUCT_IDENTIFIER = 0x0104,
PLDM_FWUP_ACPI_PRODUCT_IDENTIFIER = 0x0105,
PLDM_FWUP_ASCII_MODEL_NUMBER_LONG_STRING = 0x0106,
PLDM_FWUP_ASCII_MODEL_NUMBER_SHORT_STRING = 0x0107,
PLDM_FWUP_SCSI_PRODUCT_ID = 0x0108,
PLDM_FWUP_UBM_CONTROLLER_DEVICE_CODE = 0x0109,
PLDM_FWUP_VENDOR_DEFINED = 0xFFFF
};
/** @brief Descriptor types length defined in PLDM firmware update specification
*/
enum pldm_firmware_update_descriptor_types_length {
PLDM_FWUP_PCI_VENDOR_ID_LENGTH = 2,
PLDM_FWUP_IANA_ENTERPRISE_ID_LENGTH = 4,
PLDM_FWUP_UUID_LENGTH = 16,
PLDM_FWUP_PNP_VENDOR_ID_LENGTH = 3,
PLDM_FWUP_ACPI_VENDOR_ID_LENGTH = 4,
PLDM_FWUP_IEEE_ASSIGNED_COMPANY_ID_LENGTH = 3,
PLDM_FWUP_SCSI_VENDOR_ID_LENGTH = 8,
PLDM_FWUP_PCI_DEVICE_ID_LENGTH = 2,
PLDM_FWUP_PCI_SUBSYSTEM_VENDOR_ID_LENGTH = 2,
PLDM_FWUP_PCI_SUBSYSTEM_ID_LENGTH = 2,
PLDM_FWUP_PCI_REVISION_ID_LENGTH = 1,
PLDM_FWUP_PNP_PRODUCT_IDENTIFIER_LENGTH = 4,
PLDM_FWUP_ACPI_PRODUCT_IDENTIFIER_LENGTH = 4,
PLDM_FWUP_ASCII_MODEL_NUMBER_LONG_STRING_LENGTH = 40,
PLDM_FWUP_ASCII_MODEL_NUMBER_SHORT_STRING_LENGTH = 10,
PLDM_FWUP_SCSI_PRODUCT_ID_LENGTH = 16,
PLDM_FWUP_UBM_CONTROLLER_DEVICE_CODE_LENGTH = 4
};
/** @struct pldm_package_header_information
*
* Structure representing fixed part of package header information
*/
struct pldm_package_header_information {
uint8_t uuid[PLDM_FWUP_UUID_LENGTH];
uint8_t package_header_format_version;
uint16_t package_header_size;
uint8_t timestamp104[PLDM_TIMESTAMP104_SIZE];
uint16_t component_bitmap_bit_length;
uint8_t package_version_string_type;
uint8_t package_version_string_length;
} __attribute__((packed));
/** @struct pldm_firmware_device_id_record
*
* Structure representing firmware device ID record
*/
struct pldm_firmware_device_id_record {
uint16_t record_length;
uint8_t descriptor_count;
bitfield32_t device_update_option_flags;
uint8_t comp_image_set_version_string_type;
uint8_t comp_image_set_version_string_length;
uint16_t fw_device_pkg_data_length;
} __attribute__((packed));
/** @struct pldm_descriptor_tlv
*
* Structure representing descriptor type, length and value
*/
struct pldm_descriptor_tlv {
uint16_t descriptor_type;
uint16_t descriptor_length;
uint8_t descriptor_data[1];
} __attribute__((packed));
/** @struct pldm_vendor_defined_descriptor_title_data
*
* Structure representing vendor defined descriptor title sections
*/
struct pldm_vendor_defined_descriptor_title_data {
uint8_t vendor_defined_descriptor_title_str_type;
uint8_t vendor_defined_descriptor_title_str_len;
uint8_t vendor_defined_descriptor_title_str[1];
} __attribute__((packed));
/** @struct pldm_query_device_identifiers_resp
*
* Structure representing query device identifiers response.
*/
struct pldm_query_device_identifiers_resp {
uint8_t completion_code;
uint32_t device_identifiers_len;
uint8_t descriptor_count;
} __attribute__((packed));
/** @struct pldm_get_firmware_parameters_resp
*
* Structure representing the fixed part of GetFirmwareParameters response
*/
struct pldm_get_firmware_parameters_resp {
uint8_t completion_code;
bitfield32_t capabilities_during_update;
uint16_t comp_count;
uint8_t active_comp_image_set_ver_str_type;
uint8_t active_comp_image_set_ver_str_len;
uint8_t pending_comp_image_set_ver_str_type;
uint8_t pending_comp_image_set_ver_str_len;
} __attribute__((packed));
/** @struct pldm_component_parameter_entry
*
* Structure representing component parameter table entry.
*/
struct pldm_component_parameter_entry {
uint16_t comp_classification;
uint16_t comp_identifier;
uint8_t comp_classification_index;
uint32_t active_comp_comparison_stamp;
uint8_t active_comp_ver_str_type;
uint8_t active_comp_ver_str_len;
uint8_t active_comp_release_date[8];
uint32_t pending_comp_comparison_stamp;
uint8_t pending_comp_ver_str_type;
uint8_t pending_comp_ver_str_len;
uint8_t pending_comp_release_date[8];
bitfield16_t comp_activation_methods;
bitfield32_t capabilities_during_update;
} __attribute__((packed));
/** @brief Decode the PLDM package header information
*
* @param[in] data - pointer to package header information
* @param[in] length - available length in the firmware update package
* @param[out] package_header_info - pointer to fixed part of PLDM package
* header information
* @param[out] package_version_str - pointer to package version string
*
* @return pldm_completion_codes
*/
int decode_pldm_package_header_info(
const uint8_t *data, size_t length,
struct pldm_package_header_information *package_header_info,
struct variable_field *package_version_str);
/** @brief Decode individual firmware device ID record
*
* @param[in] data - pointer to firmware device ID record
* @param[in] length - available length in the firmware update package
* @param[in] component_bitmap_bit_length - ComponentBitmapBitLengthfield
* parsed from the package header info
* @param[out] fw_device_id_record - pointer to fixed part of firmware device
* id record
* @param[out] applicable_components - pointer to ApplicableComponents
* @param[out] comp_image_set_version_str - pointer to
* ComponentImageSetVersionString
* @param[out] record_descriptors - pointer to RecordDescriptors
* @param[out] fw_device_pkg_data - pointer to FirmwareDevicePackageData
*
* @return pldm_completion_codes
*/
int decode_firmware_device_id_record(
const uint8_t *data, size_t length, uint16_t component_bitmap_bit_length,
struct pldm_firmware_device_id_record *fw_device_id_record,
struct variable_field *applicable_components,
struct variable_field *comp_image_set_version_str,
struct variable_field *record_descriptors,
struct variable_field *fw_device_pkg_data);
/** @brief Decode the record descriptor entries in the firmware update package
* and the Descriptors in the QueryDeviceIDentifiers command
*
* @param[in] data - pointer to descriptor entry
* @param[in] length - remaining length of the descriptor data
* @param[out] descriptor_type - pointer to descriptor type
* @param[out] descriptor_data - pointer to descriptor data
*
* @return pldm_completion_codes
*/
int decode_descriptor_type_length_value(const uint8_t *data, size_t length,
uint16_t *descriptor_type,
struct variable_field *descriptor_data);
/** @brief Decode the vendor defined descriptor value
*
* @param[in] data - pointer to vendor defined descriptor value
* @param[in] length - length of the vendor defined descriptor value
* @param[out] descriptor_title_str_type - pointer to vendor defined descriptor
* title string type
* @param[out] descriptor_title_str - pointer to vendor defined descriptor
* title string
* @param[out] descriptor_data - pointer to vendor defined descriptor data
*
* @return pldm_completion_codes
*/
int decode_vendor_defined_descriptor_value(
const uint8_t *data, size_t length, uint8_t *descriptor_title_str_type,
struct variable_field *descriptor_title_str,
struct variable_field *descriptor_data);
/** @brief Create a PLDM request message for QueryDeviceIdentifiers
*
* @param[in] instance_id - Message's instance id
* @param[in] payload_length - Length of the request message payload
* @param[in,out] msg - Message will be written to this
*
* @return pldm_completion_codes
*
* @note Caller is responsible for memory alloc and dealloc of param
* 'msg.payload'
*/
int encode_query_device_identifiers_req(uint8_t instance_id,
size_t payload_length,
struct pldm_msg *msg);
/** @brief Decode QueryDeviceIdentifiers response message
*
* @param[in] msg - Response message
* @param[in] payload_length - Length of response message payload
* @param[out] completion_code - Pointer to response msg's PLDM completion code
* @param[out] device_identifiers_len - Pointer to device identifiers length
* @param[out] descriptor_count - Pointer to descriptor count
* @param[out] descriptor_data - Pointer to descriptor data
*
* @return pldm_completion_codes
*/
int decode_query_device_identifiers_resp(const struct pldm_msg *msg,
size_t payload_length,
uint8_t *completion_code,
uint32_t *device_identifiers_len,
uint8_t *descriptor_count,
uint8_t **descriptor_data);
/** @brief Create a PLDM request message for GetFirmwareParameters
*
* @param[in] instance_id - Message's instance id
* @param[in] payload_length - Length of the request message payload
* @param[in,out] msg - Message will be written to this
*
* @return pldm_completion_codes
*
* @note Caller is responsible for memory alloc and dealloc of param
* 'msg.payload'
*/
int encode_get_firmware_parameters_req(uint8_t instance_id,
size_t payload_length,
struct pldm_msg *msg);
/** @brief Decode GetFirmwareParameters response
*
* @param[in] msg - Response message
* @param[in] payload_length - Length of response message payload
* @param[out] resp_data - Pointer to get firmware parameters response
* @param[out] active_comp_image_set_ver_str - Pointer to active component
* image set version string
* @param[out] pending_comp_image_set_ver_str - Pointer to pending component
* image set version string
* @param[out] comp_parameter_table - Pointer to component parameter table
*
* @return pldm_completion_codes
*/
int decode_get_firmware_parameters_resp(
const struct pldm_msg *msg, size_t payload_length,
struct pldm_get_firmware_parameters_resp *resp_data,
struct variable_field *active_comp_image_set_ver_str,
struct variable_field *pending_comp_image_set_ver_str,
struct variable_field *comp_parameter_table);
/** @brief Decode component entries in the component parameter table which is
* part of the response of GetFirmwareParameters command
*
* @param[in] data - Component entry
* @param[in] length - Length of component entry
* @param[out] component_data - Pointer to component parameter table
* @param[out] active_comp_ver_str - Pointer to active component version string
* @param[out] pending_comp_ver_str - Pointer to pending component version
* string
*
* @return pldm_completion_codes
*/
int decode_get_firmware_parameters_resp_comp_entry(
const uint8_t *data, size_t length,
struct pldm_component_parameter_entry *component_data,
struct variable_field *active_comp_ver_str,
struct variable_field *pending_comp_ver_str);
#ifdef __cplusplus
}
#endif
#endif // End of FW_UPDATE_H