MCUXpresso SDK Documentation

fsl_romapi

fsl_romapi#

Overview#

The fsl_romapi example shows how to use flexspi rom api In this example, rom api will send data and operate the external Nor flash connected with FLEXSPI. Some simple flash command willbe executed, such as Write Enable, Erase sector, Program page.Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Supported Boards#

MIMXRT1060-EVKB
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init, Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Mini/micro USB cable

  • MIMXRT1060-EVKB board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully get FLEXSPI NOR configuration block

Successfully init FLEXSPI serial NOR flash

Serial NOR flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!
MIMXRT1170-EVKB
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init, Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Mini/micro USB cable

  • MIMXRT1170-EVKB board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully get FLEXSPI NOR configuration block

Successfully init FLEXSPI serial NOR flash

Serial NOR flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!
MIMXRT1060-EVKC
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init, Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Mini/micro USB cable

  • MIMXRT1060-EVKC board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully get FLEXSPI NOR configuration block

Successfully init FLEXSPI serial NOR flash

Serial NOR flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!
FRDM-IMXRT1152
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init, Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Type-C USB cable

  • FRDM-IMXRT1152 board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully get FLEXSPI NOR configuration block

Successfully init FLEXSPI serial NOR flash

Serial NOR flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!
EVK-MIMXRT1015
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init, Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Mini/micro USB cable

  • EVK-MIMXRT1015 board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully init FLEXSPI serial NOR flash

Serial flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!
EVK-MIMXRT1020
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init, Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Mini/micro USB cable

  • EVK-MIMXRT1020 board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully init FLEXSPI serial NOR flash

serial flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!
MIMXRT1024-EVK
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init, Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Mini/micro USB cable

  • MIMXRT1024-EVK board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully init FLEXSPI serial NOR flash

Serial flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!
MIMXRT1040-EVK
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init, Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Mini/micro USB cable

  • MIMXRT1040-EVK board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully get FLEXSPI NOR configuration block

Successfully init FLEXSPI serial NOR flash

Serial NOR flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!
EVK-MIMXRT1064
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI2 controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init,Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Mini/micro USB cable

  • EVK-MIMXRT1064 board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully get FLEXSPI NOR configuration block

Successfully init FLEXSPI serial NOR flash

Serial flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!
MIMXRT1160-EVK
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init, Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Mini/micro USB cable

  • MIMXRT1160-EVK board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully get FLEXSPI NOR configuration block

Successfully init FLEXSPI serial NOR flash

Serial NOR flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!
MIMXRT1180-EVK
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init, Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Mini/micro USB cable

  • MIMXRT1180-EVK board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully get FLEXSPI NOR configuration block

Successfully init FLEXSPI serial NOR flash

Serial NOR flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!
FRDM-IMXRT1186
Overview

The fsl_romapi example shows how to use ROM API:

In this example, fsl_romapi driver will call the API and operate the external Nor flash connected to the FLEXSPI controller. Some simple flash command will be executed, such as FLEXSPI NOR get config, FLEXSPI NOR Flash init, Erase sector, Program page. Example will first erase the sector and program a page into the flash, at last check if the data in flash is correct.

Hardware requirements
  • Type-C USB cable

  • FRDM-IMXRT1186 board

  • Personal Computer

Board settings
Prepare the Demo
  1. Connect a USB cable between the host PC and the OpenSDA USB port on the target board.

  2. Open a serial terminal with the following settings:

    • 115200 baud rate

    • 8 data bits

    • No parity

    • One stop bit

    • No flow control

  3. Download the program to the target board.

  4. Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo

When the example runs successfully, you can see the similar information from the terminal as below.

For FLEXSPI NOR targets, the result is:

FLEXSPI NOR example started!

Successfully get FLEXSPI NOR configuration block

Successfully init FLEXSPI serial NOR flash

Serial NOR flash has been found successfully

Vendor ID: xx

Serial NOR flash Information:

Total program flash size: xx KB, Hex: (xx)

Program flash sector size: xx KB, Hex: (xx)

Program flash page size: xx B, Hex: (xx)

Erasing serial NOR flash over FLEXSPI

Successfully erased one sector of NOR flash device xx -> xx

Program a buffer to a page of NOR flash

Successfully programmed and verified location FLEXSPI memory xx -> xx

End of FLEXSPI NOR Example!