MCUXpresso SDK API Reference Manual  Rev. 0
NXP Semiconductors
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Flexspi Nand Flash

Overview

Data Structures

struct  flexspi_mem_config_t
 Serial NOR configuration block. More...
 
struct  flexspi_mem_nand_handle_t
 NAND Flash handle info. More...
 

Macros

#define NAND_CMD_LUT_SEQ_IDX_READCACHE   0
 LUT sequence index for READ cache sequence.
 
#define NAND_CMD_LUT_SEQ_IDX_READSTATUS   1
 LUT sequence index for Read Status sequence.
 
#define NAND_CMD_LUT_SEQ_IDX_READJEDECID   2
 LUT sequence index for Read ID sequence.
 
#define NAND_CMD_LUT_SEQ_IDX_WRITEENABLE   3
 LUT sequence index for write enable sequence.
 
#define NAND_CMD_LUT_SEQ_IDX_READCACHE_ODD   4
 LUT sequence index for Read cache for odd blocks.
 
#define NAND_CMD_LUT_SEQ_IDX_ERASEBLOCK   5
 LUT sequence index for erase block.
 
#define NAND_CMD_LUT_SEQ_IDX_PROGRAMLOAD   6
 LUT sequence index for program load.
 
#define NAND_CMD_LUT_SEQ_IDX_PROGRAMLOAD_ODD   7
 LUT sequence index for program load for odd blocks.
 
#define NAND_CMD_LUT_SEQ_IDX_READPAGE   8
 LUT sequence index for program load for read page.
 
#define NAND_CMD_LUT_SEQ_IDX_READECCSTAT   9
 LUT sequence index for read ecc status.
 
#define NAND_CMD_LUT_SEQ_IDX_PROGRAMEXECUTE   10
 LUT sequence index for program execute.
 
#define NAND_CMD_LUT_SEQ_IDX_SETFEATURE   11
 LUT sequence index for get parameter table.
 
#define NAND_CMD_LUT_SEQ_IDX_UNLOCKALL   12
 Unlock all blocks.
 

Data Structure Documentation

struct flexspi_mem_config_t

Data Fields

flexspi_device_config_t deviceConfig
 Device configuration structure.
 
flexspi_port_t devicePort
 Device connected to which port, SS0_A means port A1, SS0_B means port B1.
 
uint32_t dataBytesPerPage
 Data Size in one page, usually it is 2048 or 4096.
 
uint32_t bytesInPageSpareArea
 Total size in one page, usually, it equals 2 ^ width of column address.
 
uint32_t pagesPerBlock
 Pages per block.
 
uint16_t busyOffset
 Busy offset, valid value: 0-31, only need for check option kNandReadyCheckOption_RB.
 
uint16_t busyBitPolarity
 Busy flag polarity, 0 - busy flag is 1 when flash device is busy, 1 -busy flag is 0 when flash device is busy, only need for check option kNandReadyCheckOption_RB.
 
uint32_t eccStatusMask
 ECC status mask.
 
uint32_t eccFailureMask
 ECC failure mask.
 
uint32_t lookupTable [64]
 Lookup table holds Flash command sequences.
 
serial_nor_device_type_t deviceType
 Serial nor flash device type.
 
serial_nor_command_mode_t CurrentCommandMode
 Serial nor flash corrent command mode.
 
serial_nor_transfer_mode_t transferMode
 Transfer rate is SDR or DDR mode.
 
serial_nor_quad_mode_t quadMode
 Serial nor flash quad mode setting. More...
 
serial_nor_enhance_mode_t enhanceMode
 Serial nor flash performance enhance mode setting. More...
 
flexspi_pad_t commandPads
 Command padS setting. More...
 
flexspi_pad_t queryPads
 SFDP read pads setting. More...
 
uint8_t statusOverride
 Override status register value during device mode configuration. More...
 
uint32_t controllerMiscOption
 Controller Misc Options, see Misc feature bit definitions for more.
 
uint32_t bytesInPageSize
 Page size in byte of Serial NOR.
 
uint32_t bytesInSectorSize
 Minimun Sector size in byte supported by Serial NOR.
 
uint32_t bytesInMemorySize
 Memory size in byte of Serial NOR.
 
uint8_t ipcmdSerialClkFreq
 Clock frequency for IP command.
 
uint8_t serialNorType
 Serial NOR Flash type: 0/1/2/3.
 
uint8_t needExitNoCmdMode
 Need to exit NoCmd mode before other IP command.
 
bool halfClkForNonReadCmd
 Half the Serial Clock for non-read command: true/false.
 
uint8_t needRestoreNoCmdMode
 Need to Restore NoCmd mode after IP commmand execution.
 
bool deviceModeCfgEnable
 Device Mode Configure enable flag, true - Enable, false - Disable.
 
uint32_t manufacturerId
 Manufacturer ID that each vendor has a unique ID depend on JESD216 spec.
 

Field Documentation

serial_nor_quad_mode_t flexspi_mem_config_t::quadMode
serial_nor_enhance_mode_t flexspi_mem_config_t::enhanceMode
flexspi_pad_t flexspi_mem_config_t::commandPads
flexspi_pad_t flexspi_mem_config_t::queryPads
uint8_t flexspi_mem_config_t::statusOverride
struct flexspi_mem_nand_handle_t

Data Fields

flexspi_port_t port
 Device connected to which port, SS0_A means port A1, SS0_B means port B1.
 
uint16_t busyOffset
 Busy offset, valid value: 0-31, only need for check option kNandReadyCheckOption_RB.
 
uint16_t busyBitPolarity
 Busy flag polarity, 0 - busy flag is 1 when flash device is busy, 1 -busy flag is 0 when flash device is busy, only need for check option kNandReadyCheckOption_RB.
 
uint32_t eccStatusMask
 ECC status mask.
 
uint32_t eccFailureMask
 ECC failure mask.