SFDP Macros

group group_smif_macros_sfdp

Defines

CY_SMIF_SFDP_ADDRESS_LENGTH

The length of the SFDP address.

CY_SMIF_SFDP_PARAM_HEADER_LENGTH

The length of the Parameter header.

CY_SMIF_SFDP_PARAMETER_TABLE_LENGTH

The length of the Parameter table.

CY_SMIF_SFDP_LENGTH

The length of the SFDP.

CY_SMIF_SFDP_SIGNATURE_BYTE_00

The SFDP Signature byte 0x00.

Should be “S”

CY_SMIF_SFDP_SIGNATURE_BYTE_01

The SFDP Signature byte 0x01.

Should be “F”

CY_SMIF_SFDP_SIGNATURE_BYTE_02

The SFDP Signature byte 0x02.

Should be “D”

CY_SMIF_SFDP_SIGNATURE_BYTE_03

The SFDP Signature byte 0x03.

Should be “P”

CY_SMIF_SFDP_MINOR_REV

The SFDP Header byte 0x04.

Defines the JEDEC JESD216 Revision

CY_SMIF_SFDP_MAJOR_REV

The SFDP Header byte 0x05.

Defines the SFDP Major Revision

CY_SMIF_SFDP_MAJOR_REV_1

The SFDP Major Revision is 1.

CY_SMIF_SFDP_JEDEC_REV_B

The JEDEC JESD216 Revision is B.

CY_SMIF_SFDP_PARAM_TABLE_PTR

Specifies the start of the JEDEC Basic Flash Parameter Table in the SFDP structure.

CY_SMIF_SFDP_THREE_BYTES_ADDR_CODE

Code for the SFDP Address Bytes Number 3.

CY_SMIF_SFDP_THREE_OR_FOUR_BYTES_ADDR_CODE

Code for the SFDP Address Bytes Number 3 or 4.

CY_SMIF_SFDP_FOUR_BYTES_ADDR_CODE

Code for the SFDP Address Bytes Number 4.

CY_SMIF_THREE_BYTES_ADDR

The address Bytes Number is 3.

CY_SMIF_FOUR_BYTES_ADDR

The address Bytes Number is 4.

CY_SMIF_READ_MODE_BYTE

The mode byte for the SMIF read.

CY_SMIF_WRITE_STATUS_REG1_CMD

The write status register 1 command.

CY_SMIF_SINGLE_PROGRAM_CMD

The command for a single SMIF program.

CY_SMIF_SINGLE_READ_CMD

The command for a single SMIF read.

CY_SMIF_WRITE_DISABLE_CMD

The Write Disable command.

CY_SMIF_READ_STATUS_REG1_CMD

The read status register 1 command.

CY_SMIF_WRITE_ENABLE_CMD

The Write Enable command.

CY_SMIF_READ_STATUS_REG2_T1_CMD

The read status register 2 type 1 command.

CY_SMIF_WRITE_STATUS_REG2_CMD

The write status register 2 command.

CY_SMIF_READ_STATUS_REG2_T2_CMD

The read status register 2 type 2 command.

CY_SMIF_CHIP_ERASE_CMD

The Chip Erase command.

CY_SMIF_QE_BIT_STATUS_REG2_T1

The QE bit is in status register 2 type 1.

It should be written as the second byte.

CY_SMIF_FAST_READ_4_BYTES_CMD_1S_1S_1S

The command for a 1S-1S-1S SMIF fast read with 4-byte addressing.

CY_SMIF_FAST_READ_4_BYTES_CMD_1S_1S_2S

The command for a 1S-1S-2S SMIF fast read with 4-byte addressing.

CY_SMIF_FAST_READ_4_BYTES_CMD_1S_2S_2S

The command for a 1S-2S-2S SMIF fast read with 4-byte addressing.

CY_SMIF_FAST_READ_4_BYTES_CMD_1S_1S_4S

The command for a 1S-1S-4S SMIF fast read with 4-byte addressing.

CY_SMIF_FAST_READ_4_BYTES_CMD_1S_4S_4S

The command for a 1S-4S-4S SMIF fast read with 4-byte addressing.

CY_SMIF_FAST_READ_4_BYTES_CMD_1S_4D_4D

The command for a 1S-4D-4D SMIF fast read with 4-byte addressing.

note

This macro is available for CAT1B devices.

CY_SMIF_PAGE_PROGRAM_4_BYTES_CMD_1S_1S_1S

The command for a 1S-1S-1S SMIF page program with 4-byte addressing.

CY_SMIF_PAGE_PROGRAM_4_BYTES_CMD_1S_1S_4S

The command for a 1S-1S-4S SMIF page program with 4-byte addressing.

CY_SMIF_PAGE_PROGRAM_4_BYTES_CMD_1S_4S_4S

The command for a 1S-4S-4S SMIF page program with 4-byte addressing.

CY_SMIF_BRWR_EXTADD_MASK

The Extended Address Enable (EXTADD) mask.

CY_SMIF_SFDP_ERASE_TIME_1MS

Units of Erase Typical Time in ms.

CY_SMIF_SFDP_ERASE_TIME_16MS

Units of Erase Typical Time in ms.

CY_SMIF_SFDP_ERASE_TIME_128MS

Units of Erase Typical Time in ms.

CY_SMIF_SFDP_ERASE_TIME_1S

Units of Erase Typical Time in ms.

CY_SMIF_SFDP_CHIP_ERASE_TIME_16MS

Units of Chip Erase Typical Time in ms.

CY_SMIF_SFDP_CHIP_ERASE_TIME_256MS

Units of Chip Erase Typical Time in ms.

CY_SMIF_SFDP_CHIP_ERASE_TIME_4S

Units of Chip Erase Typical Time in ms.

CY_SMIF_SFDP_CHIP_ERASE_TIME_64S

Units of Chip Erase Typical Time in ms.

CY_SMIF_SFDP_PROG_TIME_8US

Units of Page Program Typical Time in us.

CY_SMIF_SFDP_PROG_TIME_64US

Units of Page Program Typical Time in us.

CY_SMIF_SFDP_UNIT_0

Units of Basic Flash Parameter Table Time Parameters.

CY_SMIF_SFDP_UNIT_1

Units of Basic Flash Parameter Table Time Parameters.

CY_SMIF_SFDP_UNIT_2

Units of Basic Flash Parameter Table Time Parameters.

CY_SMIF_SFDP_UNIT_3

Units of Basic Flash Parameter Table Time Parameters.

CY_SMIF_STATUS_REG_BUSY_MASK

The busy mask for the status registers.

CY_SMIF_NO_COMMAND_OR_MODE

No command or mode present.

CY_SMIF_SFDP_QER_0

The quad Enable Requirements case 0.

CY_SMIF_SFDP_QER_1

The quad Enable Requirements case 1.

CY_SMIF_SFDP_QER_2

The quad Enable Requirements case 2.

CY_SMIF_SFDP_QER_3

The quad Enable Requirements case 3.

CY_SMIF_SFDP_QER_4

The quad Enable Requirements case 4.

CY_SMIF_SFDP_QER_5

The quad Enable Requirements case 5.

CY_SMIF_SFDP_QE_BIT_1_OF_SR_2

The QE is bit 1 of the status register 2.

CY_SMIF_SFDP_QE_BIT_6_OF_SR_1

The QE is bit 6 of the status register 1.

CY_SMIF_SFDP_QE_BIT_7_OF_SR_2

The QE is bit 7 of the status register 2.

CY_SMIF_SFDP_BFPT_BYTE_02

The byte 0x02 of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_04

The byte 0x04 of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_05

The byte 0x05 of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_06

The byte 0x06 of the JEDEC Basic Flash Parameter Table: number of Parameter Headers (zero based, 05h = 6 parameters)

CY_SMIF_SFDP_BFPT_BYTE_08

The byte 0x08 of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_09

The byte 0x09 of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_0A

The byte 0x0A of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_0B

The byte 0x0B of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_0C

The byte 0x0C of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_0D

The byte 0x0D of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_0E

The byte 0x0E of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_0F

The byte 0x0F of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_1C

The byte 0x1C of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_1D

The byte 0x1D of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_23

The byte 0x23 of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_28

The byte 0x28 of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_3A

The byte 0x3A of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_BYTE_3C

The byte 0x3C of the JEDEC Basic Flash Parameter Table.

CY_SMIF_SFDP_BFPT_ERASE_BYTE

The byte 36 of the JEDEC Basic Flash Parameter Table.

CY_SMIF_JEDEC_BFPT_10TH_DWORD

Offset to JEDEC Basic Flash Parameter Table: 10th DWORD.

CY_SMIF_JEDEC_BFPT_11TH_DWORD

Offset to JEDEC Basic Flash Parameter Table: 11th DWORD.

CY_SMIF_SFDP_SECTOR_MAP_CMD_OFFSET

The offset for the detection command instruction in the Sector Map command descriptor.

CY_SMIF_SFDP_SECTOR_MAP_ADDR_CODE_OFFSET

The offset for the detection command address length in the Sector Map command descriptor.

CY_SMIF_SFDP_SECTOR_MAP_REG_MSK_OFFSET

The offset for the read data mask in the Sector Map command descriptor.

CY_SMIF_SFDP_SECTOR_MAP_REG_ADDR_OFFSET

The offset for the detection command address in the Sector Map command descriptor.

CY_SMIF_SFDP_SECTOR_MAP_REGION_COUNT_OFFSET

The offset for the regions count in the Sector Map descriptor.

CY_SMIF_SFDP_SECTOR_MAP_CONFIG_ID_OFFSET

The offset for the configuration ID in the Sector Map descriptor.

CY_SMIF_SFDP_SECTOR_MAP_SUPPORTED_ET_MASK

The mask for the supported erase type code in the Sector Map descriptor.

CY_SMIF_SFDP_SECTOR_MAP_ADDR_BYTES_Msk

The mask for the configuration detection command address bytes in the Sector Map descriptor.

CY_SMIF_SFDP_SECTOR_MAP_ADDR_BYTES_Pos

The position of the configuration detection command address bytes in the Sector Map descriptor.

CY_SMIF_SFDP_FAST_READ_1_1_4_Pos

The SFDP 1-1-4 fast read support (Bit 6)

CY_SMIF_SFDP_FAST_READ_1_1_4_Msk

The SFDP 1-1-4 fast read support (Bitfield-Mask: 0x01)

CY_SMIF_SFDP_FAST_READ_1_4_4_Pos

The SFDP 1-4-4 fast read support (Bit 5)

CY_SMIF_SFDP_FAST_READ_1_4_4_Msk

The SFDP 1-4-4 fast read support (Bitfield-Mask: 0x01)

CY_SMIF_SFDP_FAST_READ_1_2_2_Pos

The SFDP 1-2-2 fast read support (Bit 4)

CY_SMIF_SFDP_FAST_READ_1_2_2_Msk

The SFDP 1-2-2 fast read support (Bitfield-Mask: 0x01)

CY_SMIF_SFDP_DTR_SUPPORT_Pos

The SFDP DTR support (Bit 3)

note

This macro is available for CAT1B devices.

CY_SMIF_SFDP_DTR_SUPPORT_Msk

The SFDP DTR support (Bitfield-Mask: 0x08)

note

This macro is available for CAT1B devices.

CY_SMIF_SFDP_ADDRESS_BYTES_Pos

The SFDP number of address bytes (Bit 1)

CY_SMIF_SFDP_ADDRESS_BYTES_Msk

The SFDP number of address bytes (Bitfield-Mask: 0x03)

CY_SMIF_SFDP_FAST_READ_1_1_2_Pos

The SFDP 1-1-2 fast read support (Bit 0)

CY_SMIF_SFDP_FAST_READ_1_1_2_Msk

The SFDP 1-1-2 fast read support (Bitfield-Mask: 0x01)

CY_SMIF_SFDP_SIZE_ABOVE_4GB_Msk

Flash memory density bit define if it >= 4 Gbit or <= 2Gbit.

CY_SMIF_SFDP_1_4_4_DUMMY_CYCLES_Pos

The SFDP number of 1-4-4 fast read dummy cycles (Bit 0)

CY_SMIF_SFDP_1_4_4_DUMMY_CYCLES_Msk

The SFDP number of 1-4-4 fast read dummy cycles (Bitfield-Mask: 0x1F)

CY_SMIF_SFDP_1_4_4_MODE_CYCLES_Pos

The SFDP number of 1-4-4 fast read mode cycles (Bit 5)

CY_SMIF_SFDP_1_4_4_MODE_CYCLES_Msk

The SFDP number of 1-4-4 fast read mode cycles (Bitfield-Mask: 0x07)

CY_SMIF_SFDP_1_1_4_DUMMY_CYCLES_Pos

The SFDP number of 1-1-4 fast read dummy cycles (Bit 0)

CY_SMIF_SFDP_1_1_4_DUMMY_CYCLES_Msk

The SFDP number of 1-1-4 fast read dummy cycles (Bitfield-Mask: 0x1F)

CY_SMIF_SFDP_1_1_4_MODE_CYCLES_Pos

The SFDP number of 1-1-4 fast read mode cycles (Bit 5)

CY_SMIF_SFDP_1_1_4_MODE_CYCLES_Msk

The SFDP number of 1-1-4 fast read mode cycles (Bitfield-Mask: 0x07)

CY_SMIF_SFDP_1_1_2_DUMMY_CYCLES_Pos

The SFDP number of 1_1_2 fast read dummy cycles (Bit 0)

CY_SMIF_SFDP_1_1_2_DUMMY_CYCLES_Msk

The SFDP number of 1_1_2 fast read dummy cycles (Bitfield-Mask: 0x1F)

CY_SMIF_SFDP_1_1_2_MODE_CYCLES_Pos

The SFDP number of 1_1_2 fast read mode cycles (Bit 5)

CY_SMIF_SFDP_1_1_2_MODE_CYCLES_Msk

The SFDP number of 1_1_2 fast read mode cycles (Bitfield-Mask: 0x07)

CY_SMIF_SFDP_1_2_2_DUMMY_CYCLES_Pos

The SFDP number of 1_2_2 fast read dummy cycles (Bit 0)

CY_SMIF_SFDP_1_2_2_DUMMY_CYCLES_Msk

The SFDP number of 1_2_2 fast read dummy cycles (Bitfield-Mask: 0x1F)

CY_SMIF_SFDP_1_2_2_MODE_CYCLES_Pos

The SFDP number of 1_2_2 fast read mode cycles (Bit 5)

CY_SMIF_SFDP_1_2_2_MODE_CYCLES_Msk

The SFDP number of 1_2_2 fast read mode cycles (Bitfield-Mask: 0x07)

CY_SMIF_SFDP_ERASE_T1_COUNT_Pos

Erase Type 1 Erase, Typical time: count (Bits 8:4)

CY_SMIF_SFDP_ERASE_T1_COUNT_Msk

Erase Type 1 Erase, Typical time: count (Bitfield-Mask )

CY_SMIF_SFDP_ERASE_T1_UNITS_Pos

Erase Type 1 Erase, Typical time: units (Bits 10:9)

CY_SMIF_SFDP_ERASE_T1_UNITS_Msk

Erase Type 1 Erase, Typical time: units (Bitfield-Mask )

CY_SMIF_SFDP_ERASE_MUL_COUNT_Pos

Multiplier from typical erase time to maximum erase time (Bits 3:0)

CY_SMIF_SFDP_ERASE_MUL_COUNT_Msk

Multiplier from typical erase time to maximum erase time (Bitfield-Mask )

CY_SMIF_SFDP_PAGE_SIZE_Pos

The SFDP page size (Bit 4)

CY_SMIF_SFDP_PAGE_SIZE_Msk

The SFDP page size (Bitfield-Mask: 0x0F)

CY_SMIF_SFDP_PAGE_PROG_COUNT_Pos

The SFDP Chip Page Program Typical time: count (Bits 12:8)

CY_SMIF_SFDP_PAGE_PROG_COUNT_Msk

The SFDP Chip Page Program Typical time: count (Bitfield-Mask)

CY_SMIF_SFDP_PAGE_PROG_UNITS_Pos

The SFDP Chip Page Program Typical time: units (Bit 13)

CY_SMIF_SFDP_PAGE_PROG_UNITS_Msk

The SFDP Chip Page Program Typical time: units (Bitfield-Mask)

CY_SMIF_SFDP_CHIP_ERASE_COUNT_Pos

The SFDP Chip Erase Typical time: count (Bits 28:24)

CY_SMIF_SFDP_CHIP_ERASE_COUNT_Msk

The SFDP Chip Erase Typical time: count (Bitfield-Mask)

CY_SMIF_SFDP_CHIP_ERASE_UNITS_Pos

The SFDP Chip Erase Typical time: units (Bits 29:30)

CY_SMIF_SFDP_CHIP_ERASE_UNITS_Msk

The SFDP Chip Erase Typical time: units (Bitfield-Mask)

CY_SMIF_SFDP_PROG_MUL_COUNT_Pos

Multiplier from typical time to max time for Page or byte program (Bits 3:0)

CY_SMIF_SFDP_PROG_MUL_COUNT_Msk

Multiplier from typical time to max time for Page or byte program (Bitfield-Mask)

CY_SMIF_SFDP_QE_REQUIREMENTS_Pos

The SFDP quad enable requirements field (Bit 4)

CY_SMIF_SFDP_QE_REQUIREMENTS_Msk

The SFDP quad enable requirements field (Bitfield-Mask: 0x07)

CY_SMIF_SFDP_ENTER_4_BYTE_METHOD_B7

Issue 0xB7 instruction.

CY_SMIF_SFDP_ENTER_4_BYTE_METHOD_WR_EN_B7

Issue write enable instruction followed with 0xB7.

CY_SMIF_SFDP_ENTER_4_BYTE_METHOD_ALWAYS_4_BYTE

Memory always operates in 4-byte mode.

CY_SMIF_SFDP_ENTER_4_BYTE_METHOD_B7_CMD

The instruction required to enter 4-byte addressing mode.