The MCUXpresso SDK provides a driver for the FLEXRAM module of MCUXpresso SDK devices.
The FLEXRAM module intergrates the ITCM, DTCM, and OCRAM controller, and supports parameterized RAM array and RAM array portioning.
This example code shows how to allocate RAM using the FLEXRAM driver.
Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/flexram
|
enum | {
kFLEXRAM_BankNotUsed = 0U,
kFLEXRAM_BankOCRAM = 1U,
kFLEXRAM_BankDTCM = 2U,
kFLEXRAM_BankITCM = 3U
} |
| FLEXRAM bank type. More...
|
|
enum | flexram_bank_allocate_src_t {
kFLEXRAM_BankAllocateThroughHardwareFuse = 0U,
kFLEXRAM_BankAllocateThroughBankCfg = 1U
} |
| FLEXRAM bank allocate source. More...
|
|
enum | {
kFLEXRAM_Read = 0U,
kFLEXRAM_Write = 1U
} |
| flexram write read sel More...
|
|
enum | {
kFLEXRAM_OCRAMAccessError = FLEXRAM_INT_STATUS_OCRAM_ERR_STATUS_MASK,
kFLEXRAM_DTCMAccessError = FLEXRAM_INT_STATUS_DTCM_ERR_STATUS_MASK,
kFLEXRAM_ITCMAccessError = FLEXRAM_INT_STATUS_ITCM_ERR_STATUS_MASK,
kFLEXRAM_InterruptStatusAll
} |
| Interrupt status flag mask. More...
|
|
enum | flexram_tcm_access_mode_t {
kFLEXRAM_TCMAccessFastMode = 0U,
kFLEXRAM_TCMAccessWaitMode = 1U
} |
| FLEXRAM TCM access mode Fast access mode expected to be finished in 1-cycle Wait access mode expected to be finished in 2-cycle Wait access mode is a feature of the flexram and it should be used when the cpu clock too fast to finish tcm access in 1-cycle. More...
|
|
enum | {
kFLEXRAM_TCMSize32KB = 32 * 1024U,
kFLEXRAM_TCMSize64KB = 64 * 1024U,
kFLEXRAM_TCMSize128KB = 128 * 1024U,
kFLEXRAM_TCMSize256KB = 256 * 1024U,
kFLEXRAM_TCMSize512KB = 512 * 1024U
} |
| FLEXRAM tcm support size. More...
|
|
struct flexram_allocate_ram_t |
Data Fields |
const uint8_t | ocramBankNum |
| ocram banknumber which the SOC support
|
|
const uint8_t | dtcmBankNum |
| dtcm bank number to allocate, the number should be power of 2
|
|
const uint8_t | itcmBankNum |
| itcm bank number to allocate, the number should be power of 2
|
|
#define FSL_FLEXRAM_DRIVER_VERSION (MAKE_VERSION(2U, 0U, 6U)) |
#define FSL_FLEXRAM_DRIVER_VERSION (MAKE_VERSION(2U, 0U, 6U)) |
Enumerator |
---|
kFLEXRAM_BankNotUsed |
bank is not used
|
kFLEXRAM_BankOCRAM |
bank is OCRAM
|
kFLEXRAM_BankDTCM |
bank is DTCM
|
kFLEXRAM_BankITCM |
bank is ITCM
|
Enumerator |
---|
kFLEXRAM_BankAllocateThroughHardwareFuse |
allocate ram through hardware fuse value
|
kFLEXRAM_BankAllocateThroughBankCfg |
allocate ram through FLEXRAM_BANK_CFG
|
Enumerator |
---|
kFLEXRAM_Read |
read
|
kFLEXRAM_Write |
write
|
Enumerator |
---|
kFLEXRAM_OCRAMAccessError |
ocram access unallocated address
|
kFLEXRAM_DTCMAccessError |
dtcm access unallocated address
|
kFLEXRAM_ITCMAccessError |
itcm access unallocated address
|
kFLEXRAM_InterruptStatusAll |
all the interrupt status mask
|
Normally, fast mode is the default mode, the efficiency of the tcm access will better.
Enumerator |
---|
kFLEXRAM_TCMAccessFastMode |
fast access mode
|
kFLEXRAM_TCMAccessWaitMode |
wait access mode
|
Enumerator |
---|
kFLEXRAM_TCMSize32KB |
TCM total size 32KB.
|
kFLEXRAM_TCMSize64KB |
TCM total size 64KB.
|
kFLEXRAM_TCMSize128KB |
TCM total size 128KB.
|
kFLEXRAM_TCMSize256KB |
TCM total size 256KB.
|
kFLEXRAM_TCMSize512KB |
TCM total size 512KB.
|
- Parameters
-
config | allocate configuration. |
- Return values
-
kStatus_InvalidArgument | the argument is invalid kStatus_Success allocate success |
- Parameters
-
src | bank config source select value. |
void FLEXRAM_SetTCMSize |
( |
uint8_t |
itcmBankNum, |
|
|
uint8_t |
dtcmBankNum |
|
) |
| |
If a odd bank number is used, a new banknumber will be used which is bigger than target value, application can set tcm size to the biggest bank number always, then boundary access error can be captured by flexram only. When access to the TCM memory boundary ,hardfault will raised by core.
- Parameters
-
itcmBankNum | itcm bank number to allocate |
dtcmBankNum | dtcm bank number to allocate |
void FLEXRAM_Init |
( |
FLEXRAM_Type * |
base | ) |
|
- Parameters
-
base | FLEXRAM base address. |
static uint32_t FLEXRAM_GetInterruptStatus |
( |
FLEXRAM_Type * |
base | ) |
|
|
inlinestatic |
- Parameters
-
base | FLEXRAM base address. |
static void FLEXRAM_ClearInterruptStatus |
( |
FLEXRAM_Type * |
base, |
|
|
uint32_t |
status |
|
) |
| |
|
inlinestatic |
- Parameters
-
base | FLEXRAM base address. |
status | status to clear. |
static void FLEXRAM_EnableInterruptStatus |
( |
FLEXRAM_Type * |
base, |
|
|
uint32_t |
status |
|
) |
| |
|
inlinestatic |
- Parameters
-
base | FLEXRAM base address. |
status | status to enable. |
static void FLEXRAM_DisableInterruptStatus |
( |
FLEXRAM_Type * |
base, |
|
|
uint32_t |
status |
|
) |
| |
|
inlinestatic |
- Parameters
-
base | FLEXRAM base address. |
status | status to disable. |
static void FLEXRAM_EnableInterruptSignal |
( |
FLEXRAM_Type * |
base, |
|
|
uint32_t |
status |
|
) |
| |
|
inlinestatic |
- Parameters
-
base | FLEXRAM base address. |
status | status interrupt to enable. |
static void FLEXRAM_DisableInterruptSignal |
( |
FLEXRAM_Type * |
base, |
|
|
uint32_t |
status |
|
) |
| |
|
inlinestatic |
- Parameters
-
base | FLEXRAM base address. |
status | status interrupt to disable. |
- Parameters
-
base | FLEXRAM base address. |
mode | access mode. |
- Parameters
-
base | FLEXRAM base address. |
mode | access mode. |
static void FLEXRAM_EnableForceRamClockOn |
( |
FLEXRAM_Type * |
base, |
|
|
bool |
enable |
|
) |
| |
|
inlinestatic |
- Parameters
-
base | FLEXRAM base address. |
enable | enable or disable clock force on. |