AM2432: How to build for a new QSPI flash device

Sung-IL

Part Number: AM2432
Other Parts Discussed in Thread: DP83869, TPIC2810, TCA6424, SYSCONFIG

Dear Champs,

My customer is developed their custom board using AM2432ALX(11x11mm) package and trying to build custom flash driver for their flash memory by referring below.

Their flash memory is w25g32jv.

https://software-dl.ti.com/mcu-plus-sdk/esd/AM243X/latest/exports/docs/api_guide_am243x/CUSTOM_FLASH_SUPPORT_GUIDE.html

They succeed to get below logs.

[OSPI Flash Diagnostic Test] Starting ...
[OSPI Flash Diagnostic Test] Flash Manufacturer ID : 0xEF
[OSPI Flash Diagnostic Test] Flash Device ID : 0x4016
[OSPI Flash Diagnostic Test] Executing Flash Erase on first block...
[OSPI Flash Diagnostic Test] Done !!!
[OSPI Flash Diagnostic Test] Performing Write-Read Test...
[OSPI Flash Diagnostic Test] Write-Read Test Passed!
[OSPI Flash Diagnostic Test] SFDP Information :
================================================
SFDP
================================================
SFDP Major Revision : 0x1
SFDP Minor Revision : 0x5
Number of Parameter Headers in this Table : 1

Types of Additional Parameter Tables in this flash
---------------------------------------------------

Flash_NorXspiDevDefines gFlashNorXspiDeviceDefines_<part-number> = {

.XSPI_NOR_CMD_RSTEN = 0x66,
.XSPI_NOR_CMD_RSTMEM = 0x99,
.XSPI_NOR_CMD_WREN = 0x06,
.XSPI_NOR_CMD_WRREG = 0x00,
.XSPI_NOR_CMD_BULK_ERASE = 0xC7,
.XSPI_NOR_CMD_SECTOR_ERASE_3B = 0x20,
.XSPI_NOR_CMD_SECTOR_ERASE_4B = 0x20,
.XSPI_NOR_CMD_BLOCK_ERASE_3B = 0xD8,
.XSPI_NOR_CMD_BLOCK_ERASE_4B = 0xD8,
.XSPI_NOR_CMD_PAGE_PROG_3B = 0x02,
.XSPI_NOR_CMD_PAGE_PROG_4B = 0x00,
.XSPI_NOR_CMD_RDSR = 0x05,
.XSPI_NOR_CMD_RDREG = 0x00,
.XSPI_NOR_CMD_RDID = 0x9F,
.XSPI_NOR_CMD_READ = 0x03,
.XSPI_NOR_CMD_888_SDR_READ = 0x00,
.XSPI_NOR_CMD_888_DDR_READ = 0x00,
.XSPI_NOR_CMD_444_SDR_READ = 0xEB,
.XSPI_NOR_CMD_444_DDR_READ = 0x00,
.XSPI_NOR_CMD_114_READ = 0x6B,
.XSPI_NOR_SR_WIP = 0,
.XSPI_NOR_SR_WEL = 0,
.XSPI_NOR_RDID_NUM_BYTES = 5,
.XSPI_NOR_MANF_ID = 0xEF,
.XSPI_NOR_DEVICE_ID = 0x4016,
.XSPI_NOR_114_READ_MODE_CLKS = 0,
.XSPI_NOR_114_READ_DUMMY_CYCLES = 8,
.XSPI_NOR_444_READ_MODE_CLKS = 2,
.XSPI_NOR_444_READ_DUMMY_CYCLES = 0,
.XSPI_NOR_444_READ_DUMMY_CYCLES_LC = 0x00,
.XSPI_NOR_QUAD_CMD_READ_DUMMY_CYCLES = 0x00,
.XSPI_NOR_OCTAL_READ_DUMMY_CYCLE = 0,
.XSPI_NOR_OCTAL_READ_DUMMY_CYCLE_LC = 0x00,
.XSPI_NOR_OCTAL_DDR_RDSR_DUMMY_CYCLE = 0,
.XSPI_NOR_OCTAL_DDR_RDREG_ADDR_BYTES = 0,
.XSPI_NOR_OCTAL_DDR_WRREG_ADDR_BYTES = 0,
.XSPI_NOR_OCTAL_DDR_RDVREG_DUMMY_CYCLE = 0,
.XSPI_NOR_OCTAL_DDR_RDNVREG_DUMMY_CYCLE = 0,
.XSPI_NOR_OCTAL_RDSFDP_DUMMY_CYCLE = 0,
.XSPI_NOR_OCTAL_RDSFDP_ADDR_TYPE = 0,
.XSPI_NOR_WRR_WRITE_TIMEOUT = 7040,
.XSPI_NOR_BULK_ERASE_TIMEOUT = 12000000,
.XSPI_NOR_PAGE_PROG_TIMEOUT = 704,
.XSPI_NOR_VREG_OFFSET = 0x0,
.XSPI_NOR_NVREG_OFFSET = 0x0,
.XSPI_NOR_QUAD_MODE_CFG_ADDR = 0x0,
.XSPI_NOR_QUAD_MODE_CFG_BIT_LOCATION = 0x0,
.XSPI_NOR_DDR_OCTAL_MODE_CFG_ADDR = 0x0,
.XSPI_NOR_DDR_OCTAL_MODE_CFG_BIT_LOCATION = 0x0,
.XSPI_NOR_DUMMY_CYCLE_CFG_ADDR = 0x0,
.XSPI_NOR_FLASH_SIZE = 4194304,
.XSPI_NOR_PAGE_SIZE = 256,
.XSPI_NOR_BLOCK_SIZE = 65536,
.XSPI_NOR_SECTOR_SIZE = 4096,
.addrByteSupport = 0,
.dtrSupport = 0,
.qeType = 4,
.seq444Enable = { 1, 0, 0, 0, 1 },
.seq444Disable = { 1, 0, 0, 1 },
.oeType = 0,
.cmdExtType = 0,
.byteOrder = 0,
};

All tests have passed!!

But, in stet 4, they failed to build caused below error.

~~~~~~~~~

Building file: "syscfg/ti_board_open_close.c"
Invoking: Arm Compiler
"D:/ti/ccs1100/ccs/tools/compiler/ti-cgt-armllvm_1.3.0.LTS/bin/tiarmclang.exe" -c -mcpu=cortex-r5 -mfloat-abi=hard -mfpu=vfpv3-d16 -mlittle-endian -I"D:/ti/ccs1100/ccs/tools/compiler/ti-cgt-armllvm_1.3.0.LTS/include/c" -I"D:/ti/mcu_plus_sdk_am243x_08_01_00_36/source" -DSOC_AM243X -D_DEBUG_=1 -gstrict-dwarf -g -Wall -Wno-gnu-variable-sized-type-not-at-end -Wno-unused-function -MMD -MP -MF"syscfg/ti_board_open_close.d_raw" -MT"syscfg/ti_board_open_close.o" -I"D:/workspace_v11/ospi_flash_io_am243x-lp_r5fss0-0_nortos_ti-arm-clang/Debug/syscfg" -o"syscfg/ti_board_open_close.o" "syscfg/ti_board_open_close.c"
subdir_rules.mk:30: recipe for target 'syscfg/ti_board_open_close.o' failed
syscfg/ti_board_open_close.c:68:19: error: use of undeclared identifier 'gFlashNorQspiAttrs_W25Q32JV'; did you mean 'gFlashNorQspiAttrs_S25HL512T'?
.attrs = &gFlashNorQspiAttrs_W25Q32JV,
^~~~~~~~~~~~~~~~~~~~~~~~~~~
gFlashNorQspiAttrs_S25HL512T

~~~~~~~~~~~~

So, they are trying to build flash driver for their custom flash memory by referring below.

https://software-dl.ti.com/mcu-plus-sdk/esd/AM243X/08_02_00_31/exports/docs/api_guide_am243x/MAKEFILE_BUILD_PAGE.html#autotoc_md179

But, they could not find which files are related with qspi flash in the make file as below.

~~~~~~~~~~

at \mcu_plus_sdk_am243x_08_01_00_36\source\board\makefile.am243x.r5f.ti-arm-clang

FILES_common := \
eeprom.c \
eeprom_at24c.c \
ethphy.c \
ethphy_dp83869.c \
flash.c \
flash_nor_ospi.c \
flash_nor_ospi_device_MX25LM25645G.c \
flash_nor_xspi.c \
flash_nor_xspi_device_S28HS512T.c \
flash_nor_ospi_quad.c \
flash_nor_ospi_quad_device_S25HL512T.c \
led.c \
led_gpio.c \
led_tpic2810.c \
led_ioexp.c \
ioexp_tca6424.c \

~~~~~~~~

They find flash_nor_qspi.c and flash_nor_qspi_device_MX25V1635F.c files in the '\mcu_plus_sdk_am243x_08_01_00_36\source\board\flash\' folder, and they added these files in to makefile.

When they build it again with this new makefile, they faced below error.

~~~~~

FILES_common := \
.....
flash_nor_qspi.c \
# flash_nor_qspi_device_W25Q32JV.c \
flash_nor_qspi_device_MX25V1635F.c \

.~~~~~~

D:\ti\mcu_plus_sdk_am243x_08_01_00_36>gmake -s libs PROFILE=release
Compiling: board.am243x.r5f.ti-arm-clang.release.lib: eeprom/eeprom.c
Compiling: board.am243x.r5f.ti-arm-clang.release.lib: eeprom/eeprom_at24c.c
Compiling: board.am243x.r5f.ti-arm-clang.release.lib: ethphy/ethphy.c
Compiling: board.am243x.r5f.ti-arm-clang.release.lib: ethphy/ethphy_dp83869.c
Compiling: board.am243x.r5f.ti-arm-clang.release.lib: flash/flash.c
Compiling: board.am243x.r5f.ti-arm-clang.release.lib: flash/flash_nor_ospi.c
Compiling: board.am243x.r5f.ti-arm-clang.release.lib: flash/flash_nor_ospi_device_MX25LM25645G.c
Compiling: board.am243x.r5f.ti-arm-clang.release.lib: flash/flash_nor_qspi.c
flash/flash_nor_qspi.c:58:30: error: unknown type name 'QSPI_Handle'; did you mean 'OSPI_Handle'?
int32_t QSPI_norFlashCmdRead(QSPI_Handle handle, uint8_t cmd, uint32_t cmdAddr, uint8_t *rxBuf, uint32_t rxLen)
^~~~~~~~~~~
OSPI_Handle
D:/ti/mcu_plus_sdk_am243x_08_01_00_36/source\drivers/ospi/v0/ospi.h:73:15: note: 'OSPI_Handle' declared here
typedef void *OSPI_Handle;

~~~~~~~~~~

But, they could not find where 'QSPI_Handle' was defined.

Could you please help them to build flash driver for their custom flash memory?

they found only 4 flash types defined in the "ti\mcu_plus_sdk_am243x_08_01_00_36\source\board\flash" folder as below.

What are XSPI and ospi_quad in below?

- ospi : Octal SPI

- ospi_quad : ?

- qspi : Quad spi

- xspi : ?

Thanks and Best Regards,

SI.

over 3 years ago

0 Frank Livingston over 3 years ago

TI__Mastermind 29198 points

Hi SI,

I can't get to the link you shared for the instructions. Are they same as the instructions here? https://software-dl.ti.com/mcu-plus-sdk/esd/AM243X/08_02_00_31/exports/docs/api_guide_am243x/CUSTOM_FLASH_SUPPORT_GUIDE.html

Sung-IL said:
But, in stet 4, they failed to build caused below error.

Are they failing in Step 4, or Step 2? This is Step 2: https://software-dl.ti.com/mcu-plus-sdk/esd/AM243X/08_02_00_31/exports/docs/api_guide_am243x/CUSTOM_FLASH_SUPPORT_GUIDE.html#autotoc_md259

"Confirm that the files build and the new flash device is selectable in sysconfig. We can now update the files according to the new flash device"

How did they implement file files for the new Winbond device? Did they start by copying an existing set of files in <SDK>\mcu_plus_sdk_am243x_08_02_00_31\source\board\flash? If so, which set of files did they copy?

Regards,
Frank

0 Sung-IL over 3 years ago in reply to Frank Livingston

TI__Mastermind 30190 points

Hi Frank,

Frank Livingston said:
I can't get to the link you shared for the instructions. Are they same as the instructions here? https://software-dl.ti.com/mcu-plus-sdk/esd/AM243X/08_02_00_31/exports/docs/api_guide_am243x/CUSTOM_FLASH_SUPPORT_GUIDE.html

Yes. your link is right.

Frank Livingston said:
Are they failing in Step 4, or Step 2? This is Step 2: https://software-dl.ti.com/mcu-plus-sdk/esd/AM243X/08_02_00_31/exports/docs/api_guide_am243x/CUSTOM_FLASH_SUPPORT_GUIDE.html#autotoc_md259

They are failing in Step4.

Frank Livingston said:
How did they implement file files for the new Winbond device? Did they start by copying an existing set of files in <SDK>\mcu_plus_sdk_am243x_08_02_00_31\source\board\flash? If so, which set of files did they copy?

This is what I'm asking. which files they should modify for QSPI of AM2432ALX package?

They copied 'flash_nor_qspi.c' and 'flash_nor_qspi_device_MX25V1635F.c', and modify it.

But, they faced an error of 'unknown type name 'QSPI_Handle''.

Thanks and Best Regards,

SI.

0 Anand Mahadevan SS over 3 years ago

TI__Expert 8165 points

Hi SI,

I can clear the confusion here. The terminology we have used here arose from the fact that we had to support Quad flashes and Octal flashes using the OSPI driver in AM243x.

flash_nor_ospi - tailor made flash driver only for the MXxx flash device to support the macronix flash out of box
flash_nor_ospi_quad - flash driver based on OSPI driver but designed to support Quad flashes (From your use case, I think you'll have to make the changes here)
flash_nor_xspi - flash driver designed to support Octal flashes which obey the JEDEC xSPI protocol

I recommend that you can create a file flash_nor_ospi_quad_device_W25Q32JV.c similar to flash_nor_ospi_quad_device_S25HL512T.c file and change the parameters depending on the SFDP output. Any functional changes you can make in the flash_nor_ospi_quad.c file. Do not use the flash_nor_qspi.c files in the AM243x makefile. They're based on a different QSPI driver which is not part of AM243x, that's why it is excluded from the makefile.

Let me know any more help is required.

Regards,
Anand Mahadevan SS

0 Sung-IL over 3 years ago in reply to Anand Mahadevan SS

TI__Mastermind 30190 points

Hi Anand,

Thanks for the clarification.

Their serial qspi flash memory is W25Q32JV and failed to build it with osp_quad file because they can not find some fields like NOR_CMD_WRREG and NOR_CMD_RDREG as below.

When they added these values to '00', they failed to run Flash_Open() and it was hang at this function.

~~~~

.NOR_CMD_SRSTE = 0x66U, // Enable Reset
.NOR_CMD_SFRST = 0x99U, // Reset Device
.NOR_CMD_WREN = 0x06U, // write enable
.NOR_CMD_WRREG = 0x00U, // 0x71 -> 00, not exist

...

.NOR_CMD_RDREG = 0x00U, // 0x65 -> 00, ?

~~~~

Could you please help where these values -NOR_CMD_WRREG, NOR_CMD_RDREG - can be extracted from Winbond serial flash memory datasheet in below?

https://www.winbond.com/resource-files/W25Q32JV%20RevI%2005042021%20Plus.pdf

Thanks and Best Regards,

SI.

0 Frank Livingston over 2 years ago in reply to Sung-IL

TI__Mastermind 29198 points

Hi SI,

I'm not familiar with the SFDP spec, or the S25HL512T / W25Q32JV flash memories.

In the W25Q32JV datasheet, I notice there are three status/configuration registers, see 6.1 Status Registers.

Each status/config register has a separate read/write command, see:

7.2.4 Read Status Register-1 (05h), Status Register-2 (35h) & Status Register-3 (15h)
7.2.5 Write Status Register-1 (01h), Status Register-2 (31h) & Status Register-3 (11h)

The NOR_CMD_RDSR command (0x05) output by the Diagostics program seems to map to the Read Status Register-1 (05h) command on the W25Q32JV.

Looking through source/board/flash/flash_nor_ospi_quad.c, I see only a single read register command is used:

<SDK>/source/board/flash/flash_nor_ospi_quad.c:141: cmd = devDefines->NOR_CMD_RDREG;

Similarly, only a single write register command is used:

<SDK>/source/board/flash/flash_nor_ospi_quad.c:165:        cmd    = devDefines->NOR_CMD_WRREG;
<SDK>/source/board/flash/flash_nor_ospi_quad.c:218:        cmd    = devDefines->NOR_CMD_WRREG;
<SDK>/source/board/flash/flash_nor_ospi_quad.c:287:            cmd    = devDefines->NOR_CMD_WRREG;

Thus, I don't know how the driver can read/write all status/config registers.

I assume the hang occurs somewhere in the driver code. Where does the hang occur? Is it on a read register or write register command? Which register is the driver attempting to read or write?

Anand, can you please comment?

Regards,
Frank

0 Anand Mahadevan SS over 2 years ago in reply to Frank Livingston

TI__Expert 8165 points

Hi SI, Frank,

The confusion is probably because of the fundamental differences in the config register structures between the cypress and winbond flash. Cypress flash has several configuration registers, and are read using specific register read and write commands (0x71, 0x65 etc) and could be changed accordingly. This is not the case with winbond flash. It uses multiple status registers to achieve similar functionality. So in this case some of the helper functions need to be omitted from the flash driver code. I can provide a step by step solution to enable the winbond flash, if you let me know which QSPI mode do you plan to operate:
1-1-4 or 4-4-4

Also, like Frank asked, which exact function did it hang?

Regards,
Anand Mahadevan SS

Arm-based microcontrollers

Arm-based microcontrollers forum

AM2432: How to build for a new QSPI flash device