osal_firmware.h

Overview

Related Modules:

OSAL

Description:

Declares firmware structures and interfaces.

This file provides operations such as requesting and reading a firmware file, setting the offset for reading a firmware file, and releasing a firmware file. The firmware file can be read in split mode. The size of the firmware block to read each time is defined by the macro HDF_FW_BLOCK_SIZE. The firmware file is requested by calling OsalRequestFirmware, the firmware block is read from the firmware file by calling OsalReadFirmware, and the firmware block can also be randomly read at a specified position by calling OsalSeekFirmware.

Since:

1.0

Version:

1.0

Summary

Data Structures

Data Structure Name

Description

OsalFirmware

Defines the data structure for operating a firmware file.

OsalFwBlock

Defines the data structure for reading a firmware file.

Functions

Function Name

Description

OsalRequestFirmware (struct OsalFirmware fw, const char fwName, void device)

int32_t 

Requests a firmware file based on its name and device information.

OsalSeekFirmware (struct OsalFirmware fw, uint32_t offset)

int32_t 

Reads a firmware file.

OsalReadFirmware (struct OsalFirmware fw, struct OsalFwBlock block)

int32_t 

Releases a firmware file.

OsalReleaseFirmware (struct OsalFirmware *fw)

int32_t