![]() |
RA Flexible Software Package Documentation
Release v5.7.0
|
|
Functions | |
fsp_err_t | RM_BLOCK_MEDIA_RAM_Open (rm_block_media_ctrl_t *const p_ctrl, rm_block_media_cfg_t const *const p_cfg) |
fsp_err_t | RM_BLOCK_MEDIA_RAM_MediaInit (rm_block_media_ctrl_t *const p_ctrl) |
fsp_err_t | RM_BLOCK_MEDIA_RAM_Read (rm_block_media_ctrl_t *const p_ctrl, uint8_t *const p_dest_address, uint32_t const block_address, uint32_t const num_blocks) |
fsp_err_t | RM_BLOCK_MEDIA_RAM_Write (rm_block_media_ctrl_t *const p_ctrl, uint8_t const *const p_src_address, uint32_t const block_address, uint32_t const num_blocks) |
fsp_err_t | RM_BLOCK_MEDIA_RAM_Erase (rm_block_media_ctrl_t *const p_ctrl, uint32_t const block_address, uint32_t const num_blocks) |
fsp_err_t | RM_BLOCK_MEDIA_RAM_StatusGet (rm_block_media_ctrl_t *const p_api_ctrl, rm_block_media_status_t *const p_status) |
fsp_err_t | RM_BLOCK_MEDIA_RAM_InfoGet (rm_block_media_ctrl_t *const p_ctrl, rm_block_media_info_t *const p_info) |
fsp_err_t | RM_BLOCK_MEDIA_RAM_Close (rm_block_media_ctrl_t *const p_ctrl) |
Middleware that implements a block media interface on RAM. This module implements the Block Media Interface.
Configuration | Options | Default | Description |
---|---|---|---|
Parameter Checking |
| Default (BSP) | If selected code for parameter checking is included in the build. |
RAM Media Size | Please enter the RAM media size. | 65536 | Enter a RAM media size of 20K bytes or more. |
Memory Storage Section | Manual Entry | .bss | This is the section of memory that will be used for the backing storage. Must be a valid Linker section. ('.bss', '.sdram', '.OSPI_DEVICE_0_RAM', etc). For AC6 preface any section with '.bss' e.g. '.bss.sdram' |
Configuration | Options | Default | Description |
---|---|---|---|
Name | Name must be a valid C symbol | g_rm_block_media0 | Module name. |
Callback | Name must be a valid C symbol | NULL | A user callback function can be provided. If this callback function is provided, it will be called when a card is inserted or removed. |
This module has no required clock configurations.
This module does not use I/O pins.
fsp_err_t RM_BLOCK_MEDIA_RAM_Open | ( | rm_block_media_ctrl_t *const | p_ctrl, |
rm_block_media_cfg_t const *const | p_cfg | ||
) |
Opens the module.
Implements rm_block_media_api_t::open().
FSP_SUCCESS | Module is available and is now open. |
FSP_ERR_ASSERTION | An input parameter is invalid. |
FSP_ERR_ALREADY_OPEN | Module has already been opened with this instance of the control structure. |
fsp_err_t RM_BLOCK_MEDIA_RAM_MediaInit | ( | rm_block_media_ctrl_t *const | p_ctrl | ) |
Initializes the RAM media area.
Implements rm_block_media_api_t::mediaInit().
FSP_SUCCESS | Module is initialized and ready to access the memory device. |
FSP_ERR_ASSERTION | An input parameter is invalid. |
FSP_ERR_NOT_OPEN | Module is not open. |
fsp_err_t RM_BLOCK_MEDIA_RAM_Read | ( | rm_block_media_ctrl_t *const | p_ctrl, |
uint8_t *const | p_dest_address, | ||
uint32_t const | block_address, | ||
uint32_t const | num_blocks | ||
) |
Reads data from RAM media.
Implements rm_block_media_api_t::read().
This function blocks until the data is read into the destination buffer.
FSP_SUCCESS | Data read successfully. |
FSP_ERR_ASSERTION | An input parameter is invalid. |
FSP_ERR_NOT_OPEN | Module is not open. |
FSP_ERR_NOT_INITIALIZED | Module has not been initialized. |
fsp_err_t RM_BLOCK_MEDIA_RAM_Write | ( | rm_block_media_ctrl_t *const | p_ctrl, |
uint8_t const *const | p_src_address, | ||
uint32_t const | block_address, | ||
uint32_t const | num_blocks | ||
) |
Writes data to RAM media.
Implements rm_block_media_api_t::write().
This function blocks until the write operation completes.
FSP_SUCCESS | Write finished successfully. |
FSP_ERR_ASSERTION | An input parameter is invalid. |
FSP_ERR_NOT_OPEN | Module is not open. |
FSP_ERR_NOT_INITIALIZED | Module has not been initialized. |
fsp_err_t RM_BLOCK_MEDIA_RAM_Erase | ( | rm_block_media_ctrl_t *const | p_ctrl, |
uint32_t const | block_address, | ||
uint32_t const | num_blocks | ||
) |
Erases sectors of RAM media.
Implements rm_block_media_api_t::erase().
This function blocks until erase is complete.
FSP_SUCCESS | Erase operation requested. |
FSP_ERR_ASSERTION | An input parameter is invalid. |
FSP_ERR_NOT_OPEN | Module is not open. |
FSP_ERR_NOT_INITIALIZED | Module has not been initialized. |
fsp_err_t RM_BLOCK_MEDIA_RAM_StatusGet | ( | rm_block_media_ctrl_t *const | p_api_ctrl, |
rm_block_media_status_t *const | p_status | ||
) |
Provides driver status.
Implements rm_block_media_api_t::statusGet().
FSP_SUCCESS | Status stored in p_status. |
FSP_ERR_ASSERTION | An input parameter is invalid. |
FSP_ERR_NOT_OPEN | Module is not open. |
fsp_err_t RM_BLOCK_MEDIA_RAM_InfoGet | ( | rm_block_media_ctrl_t *const | p_ctrl, |
rm_block_media_info_t *const | p_info | ||
) |
Retrieves module information.
Implements rm_block_media_api_t::infoGet().
FSP_SUCCESS | Erase operation requested. |
FSP_ERR_ASSERTION | An input parameter is invalid. |
FSP_ERR_NOT_OPEN | Module is not open. |
fsp_err_t RM_BLOCK_MEDIA_RAM_Close | ( | rm_block_media_ctrl_t *const | p_ctrl | ) |
Closes the module.
Implements rm_block_media_api_t::close().
FSP_SUCCESS | Successful close. |
FSP_ERR_ASSERTION | An input parameter is invalid. |
FSP_ERR_NOT_OPEN | Module is not open. |