MTB CAT1 Peripheral driver library
cy_stc_smif_context_t Struct Reference

Description

The SMIF internal context data.

The user must not modify it.

Data Fields

uint8_t const volatile *volatile txBufferAddress
 The pointer to the data to transfer.
 
uint32_t txBufferSize
 The size of the data to transmit in bytes.
 
uint32_t volatile txBufferCounter
 The transfer counter. More...
 
uint8_t volatile *volatile rxBufferAddress
 The pointer to the variable where the received data is stored.
 
uint32_t rxBufferSize
 The size of the data to be received in bytes.
 
uint32_t volatile rxBufferCounter
 The transfer counter. More...
 
uint32_t volatile transferStatus
 The status of the transfer. More...
 
cy_smif_event_cb_t volatile txCompleteCb
 The user-defined callback executed at the completion of a transmission.
 
cy_smif_event_cb_t volatile rxCompleteCb
 The user-defined callback executed at the completion of a reception.
 
uint32_t timeout
 The timeout in microseconds for the blocking functions. More...
 
uint16_t memReadyPollDealy
 The timeout in microseconds for polling memory device on its readiness.
 
cy_en_smif_data_rate_t preCmdDataRate
 preferred command data rate More...
 
cy_en_smif_txfr_width_t preCmdWidth
 preferred command data rate More...
 
cy_en_smif_data_rate_t preXIPDataRate
 preferred XIP data rate More...
 
uint32_t dummyCycles
 preferred dummy cycles per transaction More...
 
uint32_t flags
 Determines if the device is memory-mapped, enables the Autodetect using the SFDP, enables the write capability, or enables the crypto support for this memory slave.
 

Field Documentation

◆ txBufferCounter

uint32_t volatile cy_stc_smif_context_t::txBufferCounter

The transfer counter.

The number of the transmitted bytes = txBufferSize - txBufferCounter

◆ rxBufferCounter

uint32_t volatile cy_stc_smif_context_t::rxBufferCounter

The transfer counter.

The number of the received bytes = rxBufferSize - rxBufferCounter

◆ transferStatus

uint32_t volatile cy_stc_smif_context_t::transferStatus

The status of the transfer.

The transmitting / receiving is completed / in progress

◆ timeout

uint32_t cy_stc_smif_context_t::timeout

The timeout in microseconds for the blocking functions.

This timeout value applies to all blocking APIs.

◆ preCmdDataRate

cy_en_smif_data_rate_t cy_stc_smif_context_t::preCmdDataRate

preferred command data rate

Note
This parameter is available for CAT1B, CAT1C and CAT1D devices.

◆ preCmdWidth

cy_en_smif_txfr_width_t cy_stc_smif_context_t::preCmdWidth

preferred command data rate

Note
This parameter is available for CAT1B, CAT1C and CAT1D devices.

◆ preXIPDataRate

cy_en_smif_data_rate_t cy_stc_smif_context_t::preXIPDataRate

preferred XIP data rate

Note
This parameter is available for CAT1B, CAT1C and CAT1D devices.

◆ dummyCycles

uint32_t cy_stc_smif_context_t::dummyCycles

preferred dummy cycles per transaction

Note
This parameter is available for CAT1B, CAT1C and CAT1D devices for Hyperflash/HyperRAM.