firmware_status - Man Page

Oprom
Enumeration
Ifr

struct igsc_fw_update_flags

#define IGSC_MAX_FW_STATUS_INDEX   5

typedef void(* igsc_log_func_t) (enum igsc_log_level_type log_level, const char *fmt,...)
Callback function template for printing igsc log messages.
typedef void(* igsc_progress_func_t) (uint32_t sent, uint32_t total, void *ctx)
Callback function template for monitor firmware update progress.

IGSC_EXPORT uint32_t igsc_get_last_firmware_status (IN struct igsc_device_handle *handle)
Return the last firmware status code.
IGSC_EXPORT const char * igsc_translate_firmware_status (IN uint32_t firmware_status)
Return the firmware status message corresponding to the code.
IGSC_EXPORT int igsc_read_fw_status_reg (IN struct igsc_device_handle *handle, IN uint32_t fwsts_index, OUT uint32_t *fwsts_value)
Read firmware status register.
IGSC_EXPORT void igsc_set_log_callback_func (IN igsc_log_func_t log_callback_f)
Sets log callback function. This interface is not thread-aware, Changes here may lead to crashes in multi-thread app when the thread setting callback exists without setting this call-back function to NULL while other thread from same app continues to run.
IGSC_EXPORT igsc_log_func_t igsc_get_log_callback_func (void)
Retrieves log callback function pointer.
IGSC_EXPORT int igsc_device_init_by_device (IN OUT struct igsc_device_handle *handle, IN const char *device_path)
Initializes a GSC Firmware Update device.
int igsc_device_init_by_handle (IN OUT struct igsc_device_handle *handle, IN igsc_handle_t dev_handle)
Initializes a GSC Firmware Update device.
IGSC_EXPORT int igsc_device_init_by_device_info (IN OUT struct igsc_device_handle *handle, IN const struct igsc_device_info *dev_info)
Initializes a GSC Firmware Update device.
IGSC_EXPORT int igsc_device_get_device_info (IN struct igsc_device_handle *handle, OUT struct igsc_device_info *dev_info)
Retrieve device information from the system.
IGSC_EXPORT int igsc_device_update_device_info (IN struct igsc_device_handle *handle, OUT struct igsc_device_info *dev_info)
Update device information from the firmware The subsystem device id and the subsystem vendor id, reported by the PCI system, may be different from the ones reported by the firmware and so the device information should be updated by with the values received from the firmware.
IGSC_EXPORT int igsc_device_close (IN OUT struct igsc_device_handle *handle)
Closes a GSC Firmware Update device.
IGSC_EXPORT int igsc_device_fw_version (IN struct igsc_device_handle *handle, OUT struct igsc_fw_version *version)
Retrieves the GSC Firmware Version from the device.
IGSC_EXPORT int igsc_image_fw_version (IN const uint8_t *buffer, IN uint32_t buffer_len, OUT struct igsc_fw_version *version)
Retrieves the Firmware Version from the provided firmware update image.
IGSC_EXPORT int igsc_device_hw_config (IN struct igsc_device_handle *handle, OUT struct igsc_hw_config *hw_config)
Retrieves the hw configuration from the device.
IGSC_EXPORT int igsc_device_subsystem_ids (IN struct igsc_device_handle *handle, OUT struct igsc_subsystem_ids *ssids)
Retrieves the subsystem ids (vid/did) from the device.
IGSC_EXPORT int igsc_image_hw_config (IN const uint8_t *buffer, IN uint32_t buffer_len, OUT struct igsc_hw_config *hw_config)
Retrieves the hw configurations from the provided firmware update image.
IGSC_EXPORT int igsc_hw_config_compatible (IN const struct igsc_hw_config *image_hw_config, IN const struct igsc_hw_config *device_hw_config)
Check whether image hardware configuration compatible with device hardware configuration.
IGSC_EXPORT int igsc_hw_config_to_string (IN const struct igsc_hw_config *hw_config, IN char *buf, IN size_t length)
express hw configuration in a string
IGSC_EXPORT int igsc_device_fw_update (IN struct igsc_device_handle *handle, IN const uint8_t *buffer, IN const uint32_t buffer_len, IN igsc_progress_func_t progress_f, IN void *ctx)
Perform the firmware update from the provided firmware update image.
IGSC_EXPORT int igsc_device_fw_update_ex (IN struct igsc_device_handle *handle, IN const uint8_t *buffer, IN const uint32_t buffer_len, IN igsc_progress_func_t progress_f, IN void *ctx, IN struct igsc_fw_update_flags flags)
Perform the firmware update with flags from the provided firmware update image.
IGSC_EXPORT int igsc_iaf_psc_update (IN struct igsc_device_handle *handle, IN const uint8_t *buffer, IN const uint32_t buffer_len, IN igsc_progress_func_t progress_f, IN void *ctx)
Perform Intel Accelerator Fabric Platform Specific Configuration (PSC) update from the provided update data image.
IGSC_EXPORT int igsc_device_fwdata_update (IN struct igsc_device_handle *handle, IN const uint8_t *buffer, IN const uint32_t buffer_len, IN igsc_progress_func_t progress_f, IN void *ctx)
Perform the GSC firmware in-field data update from the provided firmware update image.
IGSC_EXPORT int igsc_device_fwdata_image_update (IN struct igsc_device_handle *handle, IN struct igsc_fwdata_image *img, IN igsc_progress_func_t progress_f, IN void *ctx)
Perform the GSC firmware in-field data update from the provided firmware update image.
IGSC_EXPORT int igsc_image_fwdata_init (IN OUT struct igsc_fwdata_image **img, IN const uint8_t *buffer, IN uint32_t buffer_len)
initializes firmware data image handle from the supplied firmware data update image.
IGSC_EXPORT int igsc_device_fwdata_version (IN struct igsc_device_handle *handle, OUT struct igsc_fwdata_version *version)
Retrieves the GSC in-field data Firmware Version from the device.
IGSC_EXPORT int igsc_device_fwdata_version2 (IN struct igsc_device_handle *handle, OUT struct igsc_fwdata_version2 *version)
Retrieves the GSC in-field data Firmware Version from the device With ability to return FW Data version in second version format.
IGSC_EXPORT int igsc_image_fwdata_version (IN struct igsc_fwdata_image *img, OUT struct igsc_fwdata_version *version)
Retrieves the GSC in-field data Firmware version from the supplied GSC in-field data Firmware update image.
IGSC_EXPORT int igsc_image_fwdata_version2 (IN struct igsc_fwdata_image *img, OUT struct igsc_fwdata_version2 *version)
Retrieves the GSC in-field data Firmware version from the supplied GSC in-field data Firmware update image. With ability to return FW Data version in second version format.
IGSC_EXPORT uint8_t igsc_fwdata_version_compare (IN struct igsc_fwdata_version *image_ver, IN struct igsc_fwdata_version *device_ver)
Compares input GSC in-field data firmware update version to the flash one With ability to compare FW Data version in second version format.
IGSC_EXPORT uint8_t igsc_fwdata_version_compare2 (IN struct igsc_fwdata_version2 *image_ver, IN struct igsc_fwdata_version2 *device_ver)
Compares input GSC in-field data firmware update version to the flash one.
IGSC_EXPORT int igsc_image_fwdata_count_devices (IN struct igsc_fwdata_image *img, OUT uint32_t *count)
Retrieves a count of of different devices supported by the GSC in-field data firmware update image associated with the handle.
IGSC_EXPORT int igsc_image_fwdata_supported_devices (IN struct igsc_fwdata_image *img, OUT struct igsc_fwdata_device_info *devices, IN OUT uint32_t *count)
Retrieves a list of supported devices by the GSC in-field data firmware update image associated with the handle. The caller supplies allocated buffer devices of count size. The function returns count filled with actually returned devices.
IGSC_EXPORT int igsc_image_fwdata_match_device (IN struct igsc_fwdata_image *img, IN struct igsc_device_info *device)
check if GSC in-field data firmware image can be applied on the device.
IGSC_EXPORT int igsc_image_fwdata_iterator_reset (IN struct igsc_fwdata_image *img)
reset the iterator over supported devices
IGSC_EXPORT int igsc_image_fwdata_iterator_next (IN struct igsc_fwdata_image *img, OUT struct igsc_fwdata_device_info *device)
progress the supported device iterator and return the GSC in-field data firmware device info
IGSC_EXPORT int igsc_image_fwdata_release (IN struct igsc_fwdata_image *img)
release the fwdata image handle
IGSC_EXPORT uint8_t igsc_fw_version_compare (IN struct igsc_fw_version *image_ver, IN struct igsc_fw_version *device_ver)
Compares input fw version to the flash one.
IGSC_EXPORT int igsc_device_oprom_version (IN struct igsc_device_handle *handle, IN uint32_t oprom_type, OUT struct igsc_oprom_version *version)
Retrieves the GSC OPROM version from the device.
IGSC_EXPORT int igsc_device_oprom_update (IN struct igsc_device_handle *handle, IN uint32_t oprom_type, IN struct igsc_oprom_image *img, IN igsc_progress_func_t progress_f, IN void *ctx)
Perform the OPROM update from the provided image.

Definition at line 389 of file igsc_lib.h.

Callback function template for printing igsc log messages.

Parameters

log_level log level of the error message.
fmt log message format
... variadic parameters

Definition at line 412 of file igsc_lib.h.

Callback function template for monitor firmware update progress.

Parameters

sent Number of bytes sent to the firmware.
total Total number of bytes in firmware update image.
ctx Context provided by caller.

Definition at line 610 of file igsc_lib.h.

Closes a GSC Firmware Update device.

Parameters

handle A handle to the device.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Perform the firmware update from the provided firmware update image.

Parameters

handle A handle to the device.
buffer A pointer to the buffer with the firmware update image.
buffer_len Length of the buffer with the firmware update image.
progress_f Pointer to the callback function for firmware update progress monitor.
ctx Context passed to progress_f function.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Perform the firmware update with flags from the provided firmware update image.

Parameters

handle A handle to the device.
buffer A pointer to the buffer with the firmware update image.
buffer_len Length of the buffer with the firmware update image.
progress_f Pointer to the callback function for firmware update progress monitor.
ctx Context passed to progress_f function.
flags flags with which the update should be performed

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieves the GSC Firmware Version from the device.

Parameters

handle A handle to the device.
version The memory to store obtained firmware version.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Perform the GSC firmware in-field data update from the provided firmware update image.

Parameters

handle A handle to the device.
img A pointer to the parsed firmware data image structure.
progress_f Pointer to the callback function for firmware update progress monitor.
ctx Context passed to progress_f function.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Perform the GSC firmware in-field data update from the provided firmware update image.

Parameters

handle A handle to the device.
buffer A pointer to the buffer with the firmware in-field data update image.
buffer_len Length of the buffer with the firmware in-field data update image.
progress_f Pointer to the callback function for firmware update progress monitor.
ctx Context passed to progress_f function.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieves the GSC in-field data Firmware Version from the device.

Parameters

handle A handle to the device.
version The memory to store obtained firmware version.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieves the GSC in-field data Firmware Version from the device With ability to return FW Data version in second version format.

Parameters

handle A handle to the device.
version The memory to store obtained firmware version.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieve device information from the system.

Parameters

handle An initialized handle to the device.
dev_info A device info structure

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieves the hw configuration from the device.

Parameters

handle A handle to the device.
hw_config The memory to store obtained the hardware configuration

Returns

IGSC_SUCCESS if successful, otherwise error code.

IGSC_ERROR_NOT_SUPPORTED if feature is not supported

Initializes a GSC Firmware Update device.

Parameters

handle A handle to the device. All subsequent calls to the lib's functions must be with this handle.
device_path A path to the device

Returns

IGSC_SUCCESS if successful, otherwise error code.

Initializes a GSC Firmware Update device.

Parameters

handle A handle to the device. All subsequent calls to the lib's functions must be with this handle.
dev_info A device info structure

Returns

IGSC_SUCCESS if successful, otherwise error code.

Initializes a GSC Firmware Update device.

Parameters

handle A handle to the device. All subsequent calls to the lib's functions must be with this handle.
dev_handle An open device handle

Returns

IGSC_SUCCESS if successful, otherwise error code.

Perform the OPROM update from the provided image.

Parameters

handle A handle to the device.
oprom_type OPROM part to update

See also

igsc_oprom_type

Parameters

img A pointer to the parsed oprom image structure.
progress_f Pointer to the callback function for OPROM update progress monitor.
ctx Context passed to progress_f function.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieves the GSC OPROM version from the device.

Parameters

handle A handle to the device.
oprom_type An OPROM type requested

See also

enum igsc_oprom_type

Parameters

version The memory to store obtained OPROM version.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieves the subsystem ids (vid/did) from the device.

Parameters

handle A handle to the device.
ssids The memory to store obtained subsystem ids

Returns

IGSC_SUCCESS if successful, otherwise error code.

IGSC_ERROR_NOT_SUPPORTED if feature is not supported

Update device information from the firmware The subsystem device id and the subsystem vendor id, reported by the PCI system, may be different from the ones reported by the firmware and so the device information should be updated by with the values received from the firmware.

Parameters

handle An initialized handle to the device.
dev_info A device info structure

Returns

IGSC_SUCCESS if successful, otherwise error code.

Compares input fw version to the flash one.

Parameters

image_ver pointer to the update image version
device_ver pointer to the device version

Returns

• IGSC_VERSION_NOT_COMPATIBLE if update image is for a different platform
• IGSC_VERSION_NEWER if update image version is newer than the one on the device
• IGSC_VERSION_EQUAL if update image version is equal to the one on the device
• IGSC_VERSION_OLDER if update image version is older than the one on the device
• IGSC_VERSION_ERROR if NULL parameters were provided

Compares input GSC in-field data firmware update version to the flash one With ability to compare FW Data version in second version format.

Parameters

image_ver pointer to the GSC in-field data firmware update image version
device_ver pointer to the device GSC data firmware version

Returns

• IGSC_FWDATA_VERSION_REJECT_VCN if image VCN version is bigger than device VCN
• IGSC_FWDATA_VERSION_REJECT_OEM_MANUF_DATA_VERSION if OEM manufacturing data version is not bigger than device OEM version
• IGSC_FWDATA_VERSION_REJECT_DIFFERENT_PROJECT if major version is different from device major version
• IGSC_FWDATA_VERSION_ACCEPT if VCN version is equal to the device's one, and OEM is bigger
• IGSC_FWDATA_VERSION_OLDER_VCN if VCN version is smaller than the one on the device

Compares input GSC in-field data firmware update version to the flash one.

Parameters

image_ver pointer to the GSC in-field data firmware update image version
device_ver pointer to the device GSC data firmware version

Returns

• IGSC_FWDATA_VERSION_REJECT_VCN if image VCN version is bigger than device VCN
• IGSC_FWDATA_VERSION_REJECT_OEM_MANUF_DATA_VERSION if OEM manufacturing data version is not bigger than device OEM version or equal in ver2 comparison
• IGSC_FWDATA_VERSION_REJECT_DIFFERENT_PROJECT if major version is different from device major version
• IGSC_FWDATA_VERSION_ACCEPT if VCN version is equal to the device's one, and OEM is bigger
• IGSC_FWDATA_VERSION_OLDER_VCN if VCN version is smaller than the one on the device
• IGSC_FWDATA_VERSION_REJECT_WRONG_FORMAT if version format is the wrong one or incompatible
• IGSC_FWDATA_VERSION_REJECT_ARB_SVN if update image SVN version is smaller than the one on the device

Return the last firmware status code.

Parameters

handle A handle to the device.

Returns

last firmware status code.

Retrieves log callback function pointer.

Returns

log callback function pointer

Check whether image hardware configuration compatible with device hardware configuration.

Parameters

image_hw_config Stores the image hardware configuration.
device_hw_config Stores the device hardware configuration.

Returns

IGSC_SUCCESS if image hardware configuration compatible with device.

express hw configuration in a string

Parameters

hw_config Stores the hardware configuration.
buf to store the hw configuration in a printable null terminated string
length length of supplied buffer

Returns

number of bytes in buffer excluding null terminator or < 0 on error

Perform Intel Accelerator Fabric Platform Specific Configuration (PSC) update from the provided update data image.

Parameters

handle A handle to the device.
buffer A pointer to the buffer with the PSC data update image.
buffer_len Length of the buffer with the PSC data update image.
progress_f Pointer to the callback function for data update progress monitor.
ctx Context passed to progress_f function.

Returns

• IGSC_SUCCESS if successful
• otherwise error code.

Retrieves the Firmware Version from the provided firmware update image.

Parameters

buffer A pointer to the buffer with the firmware update image.
buffer_len Length of the buffer with the firmware update image.
version The memory to store the obtained firmware version.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieves a count of of different devices supported by the GSC in-field data firmware update image associated with the handle.

Parameters

img GSC in-field data firmware image handle
count the number of devices

Returns

IGSC_SUCCESS if successful, otherwise error code.

initializes firmware data image handle from the supplied firmware data update image.

Parameters

img firmware data image handle allocated by the function.
buffer A pointer to the buffer with the firmware data update image.
buffer_len Length of the buffer with the firmware data update image.

Returns

IGSC_SUCCESS if successful, otherwise error code.

progress the supported device iterator and return the GSC in-field data firmware device info

Parameters

img GSC in-field data firmware image handle
device GSC in-field data firmware device information.

Returns

IGSC_SUCCESS if successful, otherwise error code.

reset the iterator over supported devices

Parameters

img GSC in-field data firmware image handle

Returns

IGSC_SUCCESS if successful, otherwise error code.

check if GSC in-field data firmware image can be applied on the device.

Parameters

img GSC in-field data firmware image handle
device physical device info

Returns

• IGSC_SUCCESS if device is on the list of supported devices.
• IGSC_ERROR_DEVICE_NOT_FOUND otherwise.

release the fwdata image handle

Parameters

img fwdata image handle

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieves a list of supported devices by the GSC in-field data firmware update image associated with the handle. The caller supplies allocated buffer devices of count size. The function returns count filled with actually returned devices.

Parameters

img GSC in-field data firmware image handle
devices list of devices supported by the GSC in-field data firmware image
count in the number of devices allocated

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieves the GSC in-field data Firmware version from the supplied GSC in-field data Firmware update image.

Parameters

img GSC in-field data Firmware image handle
version The memory to store the obtained GSC in-field data Firmware version.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieves the GSC in-field data Firmware version from the supplied GSC in-field data Firmware update image. With ability to return FW Data version in second version format.

Parameters

img GSC in-field data Firmware image handle
version The memory to store the obtained GSC in-field data Firmware version.

Returns

IGSC_SUCCESS if successful, otherwise error code.

Retrieves the hw configurations from the provided firmware update image.

Parameters

buffer A pointer to the buffer with the firmware update image.
buffer_len Length of the buffer with the firmware update image.
hw_config The memory to store obtained the hardware configuration

Returns

IGSC_SUCCESS if successful, otherwise error code.

Read firmware status register.

Parameters

handle A handle to the device.
fwsts_index index of the firmware status register (0..IGSC_MAX_FW_STATUS_INDEX)
fwsts_value returned firmware status values

Returns

IGSC_SUCCESS if successful, otherwise error code.

Sets log callback function. This interface is not thread-aware, Changes here may lead to crashes in multi-thread app when the thread setting callback exists without setting this call-back function to NULL while other thread from same app continues to run.

Parameters

log_callback_f pointer to the callback function for igsc library log messages. passing NULL to this will disable logging callback function.

Returns

void.

Return the firmware status message corresponding to the code.

Parameters

firmware_status code of firmware status

Returns

firmware status message corresponding to the code.