boards: arm: nxp: add documentation to RT series about external memories

Add documentation to NXP i.MX RT series SOCs about external memories
present on the board. This is intended to help highlight how the SOC
enables external memory using configuration blocks exposed to the
bootrom.

Addtionally, add a check to these boards to warn a user if they are
attempting to utilize SDRAM as their RAM bank without a DCD present.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
This commit is contained in:
Daniel DeGrasse 2023-07-26 16:05:53 -05:00 committed by Mahesh Mahadevan
commit 136195f32f
18 changed files with 198 additions and 0 deletions

View file

@ -51,6 +51,19 @@ these references:
- `MIMXRT1010-EVK User Guide`_
- `MIMXRT1010-EVK Design Files`_
External Memory
===============
This platform has the following external memories:
+--------------------+------------+-------------------------------------+
| Device | Controller | Status |
+====================+============+=====================================+
| AT25SF128A | FLEXSPI | Enabled via flash configurationn |
| | | block, which sets up FLEXSPI at |
| | | boot time. |
+--------------------+------------+-------------------------------------+
Supported Features
==================

View file

@ -51,6 +51,19 @@ these references:
- `MIMXRT1015-EVK Quick Reference Guide`_
- `MIMXRT1015-EVK Design Files`_
External Memory
===============
This platform has the following external memories:
+--------------------+------------+-------------------------------------+
| Device | Controller | Status |
+====================+============+=====================================+
| AT25SF128A | FLEXSPI | Enabled via flash configurationn |
| | | block, which sets up FLEXSPI at |
| | | boot time. |
+--------------------+------------+-------------------------------------+
Supported Features
==================

View file

@ -29,6 +29,11 @@ if(CONFIG_NXP_IMX_RT_BOOT_HEADER)
# is used on your custom board.
zephyr_compile_definitions(XIP_BOOT_HEADER_DCD_ENABLE=1)
zephyr_library_sources(${RT1020_BOARD_DIR}/dcd.c)
else()
if(CONFIG_SRAM_BASE_ADDRESS EQUAL 0x80000000)
message(WARNING "You are using SDRAM as RAM but no device "
"configuration data (DCD) is included. This configuration may not boot")
endif()
endif()
endif()

View file

@ -59,6 +59,23 @@ these references:
- `MIMXRT1020-EVK User Guide`_
- `MIMXRT1020-EVK Design Files`_
External Memory
===============
This platform has the following external memories:
+----------------+------------+-------------------------------------+
| Device | Controller | Status |
+================+============+=====================================+
| MT48LC16M16A2P | SEMC | Enabled via device configuration |
| | | data block, which sets up SEMC at |
| | | boot time |
+----------------+------------+-------------------------------------+
| IS25LP064A | FLEXSPI | Enabled via flash configurationn |
| | | block, which sets up FLEXSPI at |
| | | boot time |
+----------------+------------+-------------------------------------+
Supported Features
==================

View file

@ -29,6 +29,11 @@ if(CONFIG_NXP_IMX_RT_BOOT_HEADER)
# is used on your custom board.
zephyr_compile_definitions(XIP_BOOT_HEADER_DCD_ENABLE=1)
zephyr_library_sources(${RT1024_BOARD_DIR}/dcd.c)
else()
if(CONFIG_SRAM_BASE_ADDRESS EQUAL 0x80000000)
message(WARNING "You are using SDRAM as RAM but no device "
"configuration data (DCD) is included. This configuration may not boot")
endif()
endif()
endif()

View file

@ -64,6 +64,19 @@ these references:
- `MIMXRT1024-EVK User Guide`_
- `MIMXRT1024-EVK Design Files`_
External Memory
===============
This platform has the following external memories:
+----------------+------------+-------------------------------------+
| Device | Controller | Status |
+================+============+=====================================+
| MT48LC16M16A2P | SEMC | Enabled via device configuration |
| | | data block, which sets up SEMC at |
| | | boot time |
+----------------+------------+-------------------------------------+
Supported Features
==================

View file

@ -29,6 +29,11 @@ if(CONFIG_NXP_IMX_RT_BOOT_HEADER)
# is used on your custom board.
zephyr_compile_definitions(XIP_BOOT_HEADER_DCD_ENABLE=1)
zephyr_library_sources(${RT1040_BOARD_DIR}/dcd.c)
else()
if(CONFIG_SRAM_BASE_ADDRESS EQUAL 0x80000000)
message(WARNING "You are using SDRAM as RAM but no device "
"configuration data (DCD) is included. This configuration may not boot")
endif()
endif()
endif()

View file

@ -69,6 +69,23 @@ these references:
- `MIMXRT1040-EVK User Guide`_
- `MIMXRT1040-EVK Design Files`_
External Memory
===============
This platform has the following external memories:
+----------------+------------+-------------------------------------+
| Device | Controller | Status |
+================+============+=====================================+
| W9825G6KH | SEMC | Enabled via device configuration |
| | | data block, which sets up SEMC at |
| | | boot time |
+----------------+------------+-------------------------------------+
| W25Q64JVSSIQ | FLEXSPI | Enabled via flash configurationn |
| | | block, which sets up FLEXSPI at |
| | | boot time. Supported for XIP only. |
+----------------+------------+-------------------------------------+
Supported Features
==================

View file

@ -40,6 +40,11 @@ if(CONFIG_NXP_IMX_RT_BOOT_HEADER)
# is used on your custom board.
zephyr_compile_definitions(XIP_BOOT_HEADER_DCD_ENABLE=1)
zephyr_library_sources(${RT1050_BOARD_DIR}/dcd.c)
else()
if(CONFIG_SRAM_BASE_ADDRESS EQUAL 0x80000000)
message(WARNING "You are using SDRAM as RAM but no device "
"configuration data (DCD) is included. This configuration may not boot")
endif()
endif()
endif()

View file

@ -85,6 +85,23 @@ these references:
- `MIMXRT1050-EVK User Guide`_
- `MIMXRT1050-EVK Schematics`_
External Memory
===============
This platform has the following external memories:
+--------------------+------------+-------------------------------------+
| Device | Controller | Status |
+====================+============+=====================================+
| IS42S16160J | SEMC | Enabled via device configuration |
| | | data block, which sets up SEMC at |
| | | boot time |
+--------------------+------------+-------------------------------------+
| S26KS512SDPBHI020 | FLEXSPI | Enabled via flash configurationn |
| | | block, which sets up FLEXSPI at |
| | | boot time. |
+--------------------+------------+-------------------------------------+
Supported Features
==================

View file

@ -49,6 +49,11 @@ if(CONFIG_NXP_IMX_RT_BOOT_HEADER)
# is used on your custom board.
zephyr_compile_definitions(XIP_BOOT_HEADER_DCD_ENABLE=1)
zephyr_library_sources(${RT1060_BOARD_DIR}/dcd.c)
else()
if(CONFIG_SRAM_BASE_ADDRESS EQUAL 0x80000000)
message(WARNING "You are using SDRAM as RAM but no device "
"configuration data (DCD) is included. This configuration may not boot")
endif()
endif()
endif()

View file

@ -81,6 +81,23 @@ these references:
- `MIMXRT1060-EVK Schematics`_
- `MIMXRT1060-EVK Debug Firmware`_
External Memory
===============
This platform has the following external memories:
+--------------------+------------+-------------------------------------+
| Device | Controller | Status |
+====================+============+=====================================+
| IS25WP064AJBLE | SEMC | Enabled via device configuration |
| | | data block, which sets up SEMC at |
| | | boot time |
+--------------------+------------+-------------------------------------+
| IS42S16160J | FLEXSPI | Enabled via flash configurationn |
| | | block, which sets up FLEXSPI at |
| | | boot time. |
+--------------------+------------+-------------------------------------+
Supported Features
==================

View file

@ -34,6 +34,11 @@ if(CONFIG_NXP_IMX_RT_BOOT_HEADER)
# is used on your custom board.
zephyr_compile_definitions(XIP_BOOT_HEADER_DCD_ENABLE=1)
zephyr_library_sources(${RT1064_BOARD_DIR}/dcd.c)
else()
if(CONFIG_SRAM_BASE_ADDRESS EQUAL 0x80000000)
message(WARNING "You are using SDRAM as RAM but no device "
"configuration data (DCD) is included. This configuration may not boot")
endif()
endif()
endif()

View file

@ -82,6 +82,19 @@ these references:
- `MIMXRT1064-EVK Schematics`_
- `MIMXRT1064-EVK Debug Firmware`_
External Memory
===============
This platform has the following external memories:
+--------------------+------------+-------------------------------------+
| Device | Controller | Status |
+====================+============+=====================================+
| MT48LC16M16A2 | SEMC | Enabled via device configuration |
| | | data block, which sets up SEMC at |
| | | boot time |
+--------------------+------------+-------------------------------------+
Supported Features
==================

View file

@ -29,6 +29,11 @@ if(CONFIG_NXP_IMX_RT_BOOT_HEADER)
# is used on your custom board.
zephyr_compile_definitions(XIP_BOOT_HEADER_DCD_ENABLE=1)
zephyr_library_sources(${RT1160_BOARD_DIR}/dcd.c)
else()
if(CONFIG_SRAM_BASE_ADDRESS EQUAL 0x80000000)
message(WARNING "You are using SDRAM as RAM but no device "
"configuration data (DCD) is included. This configuration may not boot")
endif()
endif()
endif()

View file

@ -78,6 +78,23 @@ these references:
- `MIMXRT1160-EVK Website`_
- `MIMXRT1160-EVK Board Hardware User's Guide`_
External Memory
===============
This platform has the following external memories:
+--------------------+------------+-------------------------------------+
| Device | Controller | Status |
+====================+============+=====================================+
| W9825G6KH | SEMC | Enabled via device configuration |
| | | data block, which sets up SEMC at |
| | | boot time |
+--------------------+------------+-------------------------------------+
| IS25WP128 | FLEXSPI | Enabled via flash configurationn |
| | | block, which sets up FLEXSPI at |
| | | boot time. |
+--------------------+------------+-------------------------------------+
Supported Features
==================

View file

@ -38,6 +38,11 @@ if(CONFIG_NXP_IMX_RT_BOOT_HEADER)
# is used on your custom board.
zephyr_compile_definitions(XIP_BOOT_HEADER_DCD_ENABLE=1)
zephyr_library_sources(${RT1170_BOARD_DIR}/dcd.c)
else()
if(CONFIG_SRAM_BASE_ADDRESS EQUAL 0x80000000)
message(WARNING "You are using SDRAM as RAM but no device "
"configuration data (DCD) is included. This configuration may not boot")
endif()
endif()
endif()

View file

@ -81,6 +81,27 @@ these references:
- `MIMXRT1170-EVK Website`_
- `MIMXRT1170-EVK Board Hardware User's Guide`_
External Memory
===============
This platform has the following external memories:
+--------------------+------------+-------------------------------------+
| Device | Controller | Status |
+====================+============+=====================================+
| W9825G6KH | SEMC | Enabled via device configuration |
| | | data block, which sets up SEMC at |
| | | boot time |
+--------------------+------------+-------------------------------------+
| IS25WP128 | FLEXSPI | Enabled via flash configurationn |
| (RT1170 EVK) | | block, which sets up FLEXSPI at |
| | | boot time. |
+--------------------+------------+-------------------------------------+
| W25Q512NWEIQ | FLEXSPI | Enabled via flash configurationn |
| (RT1170 EVKB) | | block, which sets up FLEXSPI at |
| | | boot time. Supported for XIP only. |
+--------------------+------------+-------------------------------------+
Supported Features
==================