Enumerated Types

group group_smif_enums

Enums

enum cy_en_smif_txfr_width_t

cy_en_smif_txfr_width_t: The Transfer width options for the command, data, the address and the mode.

Values:

enumerator CY_SMIF_WIDTH_SINGLE

Single SPI mode.

enumerator CY_SMIF_WIDTH_DUAL

Dual SPI mode.

enumerator CY_SMIF_WIDTH_QUAD

Quad SPI mode.

enumerator CY_SMIF_WIDTH_OCTAL

Octal SPI mode.

enumerator CY_SMIF_WIDTH_NA

The specific width parameter is not applicable for this memory command.

enum cy_en_smif_error_event_t

cy_en_smif_error_event_t: The SMIF error-event selection.

Values:

enumerator CY_SMIF_BUS_ERROR

Generates a bus error.

enumerator CY_SMIF_WAIT_STATES

Stalls the bus with the wait states.

This option will increase the interrupt latency.

enum cy_en_smif_data_select_t

cy_en_smif_data_select_t: The data line-selection options for a slave device.

Values:

enumerator CY_SMIF_DATA_SEL0

smif.spi_data[0] = DATA0, smif.spi_data[1] = DATA1, …, smif.spi_data[7] = DATA7.

This value is allowed for the SPI, DSPI, QSPI, dual QSPI, and octal SPI modes.

enumerator CY_SMIF_DATA_SEL1

smif.spi_data[2] = DATA0, smif.spi_data[3] = DATA1.

This value is only allowed for the SPI and DSPI modes.

enumerator CY_SMIF_DATA_SEL2

smif.spi_data[4] = DATA0, smif.spi_data[5] = DATA1, …, smif.spi_data[7] = DATA3.

This value is only allowed for the SPI, DSPI, QSPI and dual QSPI modes.

enumerator CY_SMIF_DATA_SEL3

smif.spi_data[6] = DATA0, smif.spi_data[7] = DATA1.

This value is only allowed for the SPI and DSPI modes.

enum cy_en_smif_mode_t

cy_en_smif_mode_t: The SMIF modes to work with an external memory.

Values:

enumerator CY_SMIF_NORMAL

Command mode (MMIO mode).

enumerator CY_SMIF_MEMORY

XIP (eXecute In Place) mode.

enum cy_en_smif_txfr_status_t

cy_en_smif_txfr_status_t: The SMIF transfer status return values.

Values:

enumerator CY_SMIF_STARTED

The SMIF started.

enumerator CY_SMIF_SEND_COMPLETE

The data transmission is complete.

enumerator CY_SMIF_SEND_BUSY

The data transmission is in progress.

enumerator CY_SMIF_RX_COMPLETE

The data reception is completed.

enumerator CY_SMIF_RX_BUSY

The data reception is in progress.

enumerator CY_SMIF_XIP_ERROR

An XIP alignment error.

enumerator CY_SMIF_CMD_ERROR

A TX CMD FIFO overflow.

enumerator CY_SMIF_TX_ERROR

A TX DATA FIFO overflow.

enumerator CY_SMIF_RX_ERROR

An RX DATA FIFO underflow.

enum cy_en_smif_status_t

cy_en_smif_status_t: The SMIF API return values.

Values:

enumerator CY_SMIF_SUCCESS

Successful SMIF operation.

enumerator CY_SMIF_CMD_FIFO_FULL

The command is cancelled.

The command FIFO is full.

enumerator CY_SMIF_EXCEED_TIMEOUT

The SMIF operation timeout exceeded.

enumerator CY_SMIF_NO_QE_BIT

The device does not have a QE bit.

The device detects 1-1-4 and 1-4-4 Reads based on the instruction.

enumerator CY_SMIF_BAD_PARAM

The SMIF API received the wrong parameter.

enumerator CY_SMIF_NO_SFDP_SUPPORT

The external memory does not support SFDP (JESD216B).

enumerator CY_SMIF_NOT_HYBRID_MEM

The external memory is not hybrid.

enumerator CY_SMIF_SFDP_CORRUPTED_TABLE

The SFDP table is corrupted.

enumerator CY_SMIF_SFDP_SS0_FAILED

Failed to initialize the slave select 0 external memory by auto detection (SFDP).

enumerator CY_SMIF_SFDP_SS1_FAILED

Failed to initialize the slave select 1 external memory by auto detection (SFDP).

enumerator CY_SMIF_SFDP_SS2_FAILED

Failed to initialize the slave select 2 external memory by auto detection (SFDP).

enumerator CY_SMIF_SFDP_SS3_FAILED

Failed to initialize the slave select 3 external memory by auto detection (SFDP).

enumerator CY_SMIF_CMD_NOT_FOUND

The command API is not supported for this memory device.

enum cy_en_smif_slave_select_t

cy_en_smif_slave_select_t: The SMIF slave select definitions for the driver API.

Each slave select is represented by an enumeration that has the bit corresponding to the slave select number set.

Values:

enumerator CY_SMIF_SLAVE_SELECT_0

The SMIF slave select 0.

enumerator CY_SMIF_SLAVE_SELECT_1

The SMIF slave select 1.

enumerator CY_SMIF_SLAVE_SELECT_2

The SMIF slave select 2.

enumerator CY_SMIF_SLAVE_SELECT_3

The SMIF slave select 3.

enum cy_en_smif_clk_select_t

cy_en_smif_clk_select_t: Specifies the clock source for the receiver clock.

note

This enum is available for CAT1B devices.

Values:

enumerator CY_SMIF_SEL_OUTPUT_CLK

The SMIF output clock.

enumerator CY_SMIF_SEL_INVERTED_OUTPUT_CLK

The SMIF inverted output clock.

enumerator CY_SMIF_SEL_FEEDBACK_CLK

The SMIF feedback clock.

enumerator CY_SMIF_SEL_INVERTED_FEEDBACK_CLK

The SMIF feedback inverted clock.

enumerator CY_SMIF_SEL_INTERNAL_CLK

The SMIF internal clock.

enumerator CY_SMIF_SEL_INVERTED_INTERNAL_CLK

The SMIF internal inverted clock.

enumerator CY_SMIF_SEL_INTERNAL_CLK

The SMIF internal clock.

enumerator CY_SMIF_SEL_INVERTED_INTERNAL_CLK

The SMIF internal inverted clock.

enumerator CY_SMIF_SEL_FEEDBACK_CLK

The SMIF feedback clock.

enumerator CY_SMIF_SEL_INVERTED_FEEDBACK_CLK

The SMIF feedback inverted clock.

enum cy_en_smif_clk_select_t

note

This enum is available for CAT1A devices.

Values:

enumerator CY_SMIF_SEL_OUTPUT_CLK

The SMIF output clock.

enumerator CY_SMIF_SEL_INVERTED_OUTPUT_CLK

The SMIF inverted output clock.

enumerator CY_SMIF_SEL_FEEDBACK_CLK

The SMIF feedback clock.

enumerator CY_SMIF_SEL_INVERTED_FEEDBACK_CLK

The SMIF feedback inverted clock.

enumerator CY_SMIF_SEL_INTERNAL_CLK

The SMIF internal clock.

enumerator CY_SMIF_SEL_INVERTED_INTERNAL_CLK

The SMIF internal inverted clock.

enumerator CY_SMIF_SEL_INTERNAL_CLK

The SMIF internal clock.

enumerator CY_SMIF_SEL_INVERTED_INTERNAL_CLK

The SMIF internal inverted clock.

enumerator CY_SMIF_SEL_FEEDBACK_CLK

The SMIF feedback clock.

enumerator CY_SMIF_SEL_INVERTED_FEEDBACK_CLK

The SMIF feedback inverted clock.

enum cy_en_smif_cache_t

cy_en_smif_cache_t: Specifies enabled type of SMIF cache.

Values:

enumerator CY_SMIF_CACHE_SLOW

The SMIF slow cache (in the clk_slow domain) see TRM for details.

enumerator CY_SMIF_CACHE_FAST

The SMIF fast cache (in the clk_fast domain) see TRM for details.

enumerator CY_SMIF_CACHE_BOTH

The SMIF both caches.

enum cy_en_smif_data_rate_t

cy_en_smif_data_rate_t: Specifies the data rate.

note

This enum is available for CAT1B devices.

Values:

enumerator CY_SMIF_SDR

The SMIF Single Data Rate (SDR)

enumerator CY_SMIF_DDR

The SMIF Double Data Rate (DDR)

enum cy_en_smif_field_presence_t

cy_en_smif_field_presence_t: Specifies the presence of the field.

note

This enum is available for CAT1B devices.

Values:

enumerator CY_SMIF_NOT_PRESENT

enumerator CY_SMIF_PRESENT_1BYTE

enumerator CY_SMIF_PRESENT_2BYTE