Modules
	SPI External Flash Master (SPIXFM)

	SPI External Flash Controller (SPIXFC)

	SPI External Flash Controller FIFO (SPIXFC_FIFO)

Data Structures
struct	mxc_spixf_cfg_t

struct	mxc_spixf_req_t

Typedefs
typedef void(*	spixr_complete_cb_t) (mxc_spixf_req_t *, int)

Enumerations
enum	mxc_spixf_ssel_t

enum	mxc_spixf_hdr_direction_t

enum	mxc_spixf_sspol_t

enum	mxc_spixf_cmd_t

enum	mxc_spixf_mode_t

enum	mxc_spixf_page_size_t

enum	mxc_spixf_hdr_units_t

enum	mxc_spixf_width_t

enum	mxc_spixf_ssact_t

enum	mxc_spixf_ssiact_t

enum	mxc_spixf_spiwidth_t

enum	mxc_spixf_pup_t

enum	mxc_spixf_ds_t

Functions
int	MXC_SPIXF_Init (uint32_t cmdval, uint32_t frequency)

void	MXC_SPIXF_Shutdown (void)

void	MXC_SPIXF_IOCtrl (mxc_spixf_ds_t sclk_ds, mxc_spixf_ds_t ss_ds, mxc_spixf_ds_t sdio_ds, mxc_spixf_pup_t pupdctrl)

int	MXC_SPIXF_Clocks (uint32_t len, uint8_t deass)

int	MXC_SPIXF_Transaction (mxc_spixf_req_t *req)

int	MXC_SPIXF_TransactionAsync (mxc_spixf_req_t *req)

int	MXC_SPIXF_AbortAsync (mxc_spixf_req_t *req)

void	MXC_SPIXF_Handler (void)

int	MXC_SPIXF_ReadyForSleep (void)

int	MXC_SPIXF_EnableInt (uint32_t mask)

int	MXC_SPIXF_DisableInt (uint32_t mask)

int	MXC_SPIXF_ClearFlags (uint32_t flags)

int	MXC_SPIXF_GetFlags (void)

int	MXC_SPIXF_SetMode (mxc_spixf_mode_t mode)

mxc_spixf_mode_t	MXC_SPIXF_GetMode (void)

int	MXC_SPIXF_SetSSPolActiveHigh (void)

int	MXC_SPIXF_SetSSPolActiveLow (void)

int	MXC_SPIXF_GetSSPolarity (void)

int	MXC_SPIXF_SetSPIFrequency (unsigned int hz)

int	MXC_SPIXF_SetSPIFrequencyRead (unsigned int hz)

int	MXC_SPIXF_SetSPIFrequencyWrite (unsigned int hz)

uint32_t	MXC_SPIXF_GetSPIFrequency (void)

uint32_t	MXC_SPIXF_GetSPIFrequencyRead (void)

uint32_t	MXC_SPIXF_GetSPIFrequencyWrite (void)

int	MXC_SPIXF_SetSSActiveTime (mxc_spixf_ssact_t ssact)

mxc_spixf_ssact_t	MXC_SPIXF_GetSSActiveTime (void)

int	MXC_SPIXF_SetSSInactiveTime (mxc_spixf_ssiact_t ssiact)

mxc_spixf_ssiact_t	MXC_SPIXF_GetSSInactiveTime (void)

int	MXC_SPIXF_SetCmdWidth (mxc_spixf_spiwidth_t width)

mxc_spixf_spiwidth_t	MXC_SPIXF_GetCmdWidth (void)

int	MXC_SPIXF_SetAddrWidth (mxc_spixf_spiwidth_t width)

mxc_spixf_spiwidth_t	MXC_SPIXF_GetAddrWidth (void)

int	MXC_SPIXF_SetDataWidth (mxc_spixf_spiwidth_t width)

mxc_spixf_spiwidth_t	MXC_SPIXF_GetDataWidth (void)

int	MXC_SPIXF_Set4ByteAddr (void)

int	MXC_SPIXF_Set3ByteAddr (void)

unsigned int	MXC_SPIXF_GetBytesPerAddr (void)

int	MXC_SPIXF_SetModeClk (uint8_t mdclk)

uint8_t	MXC_SPIXF_GetModeClk (void)

int	MXC_SPIXF_SetCmdValue (uint8_t cmdval)

int	MXC_SPIXF_SetCmdModeEveryTrans (void)

int	MXC_SPIXF_SetCmdModeFirstTrans (void)

mxc_spixf_cmd_t	MXC_SPIXF_GetCmdMode (void)

int	MXC_SPIXF_BBDataOutputEnable (uint8_t mask)

int	MXC_SPIXF_BBDataOutputDisable (uint8_t mask)

uint8_t	MXC_SPIXF_BBDataOutputIsEnabled (void)

uint8_t	MXC_SPIXF_GetBBDataOutputValue (void)

uint8_t	MXC_SPIXF_GetBBDataInputValue (void)

int	MXC_SPIXF_SetModeData (uint16_t data)

uint16_t	MXC_SPIXF_GetModeData (void)

int	MXC_SPIXF_SetSCKInverted (void)

int	MXC_SPIXF_SetSCKNonInverted (void)

int	MXC_SPIXF_GetSCKInverted (void)

int	MXC_SPIXF_SCKFeedbackEnable (void)

int	MXC_SPIXF_SCKFeebackDisable (void)

int	MXC_SPIXF_SCKFeebackIsEnabled (void)

int	MXC_SPIXF_SetSCKSampleDelay (uint8_t delay)

uint8_t	MXC_SPIXF_GetSCKSampleDelay (void)

void	MXC_SPIXF_SetPageSize (mxc_spixf_page_size_t size)

mxc_spixf_page_size_t	MXC_SPIXF_GetPageSize (void)

int	MXC_SPIXF_SimpleRXEnabled (void)

int	MXC_SPIXF_SimpleRXDisable (void)

int	MXC_SPIXF_SimpleRXIsEnabled (void)

int	MXC_SPIXF_SimpleModeEnable (void)

int	MXC_SPIXF_SimpleModeDisable (void)

int	MXC_SPIXF_SimpleModeIsEnabled (void)

int	MXC_SPIXF_SampleOutputEnable (uint8_t mask)

int	MXC_SPIXF_SampleOutputDisable (uint8_t mask)

uint8_t	MXC_SPIXF_SampleOutputIsEnabled (void)

uint8_t	MXC_SPIXF_GetSampleOutputValue (void)

void	MXC_SPIXF_SetSCKDriveHigh (void)

void	MXC_SPIXF_SetSCKDriveLow (void)

uint8_t	MXC_SPIXF_GetSCKDrive (void)

void	MXC_SPIXF_SetSSDriveOutputHigh (void)

void	MXC_SPIXF_SetSSDriveOutputLow (void)

uint8_t	MXC_SPIXF_GetSSDriveOutput (void)

int	MXC_SPIXF_BitBangModeEnable (void)

int	MXC_SPIXF_BitBangModeDisable (void)

int	MXC_SPIXF_BitBangModeIsEnabled (void)

int	MXC_SPIXF_RXFIFOEnable (void)

int	MXC_SPIXF_RXFIFODisable (void)

int	MXC_SPIXF_RXFIFOIsEnabled (void)

int	MXC_SPIXF_TXFIFOEnable (void)

int	MXC_SPIXF_TXFIFODisable (void)

int	MXC_SPIXF_TXFIFOIsEnabled (void)

int	MXC_SPIXF_Enable (void)

int	MXC_SPIXF_Disable (void)

int	MXC_SPIXF_IsEnabled (void)

void	MXC_SPIXF_SetIoctrlSDIODriveHigh (void)

void	MXC_SPIXF_SetIoctrlSDIODriveLow (void)

uint8_t	MXC_SPIXF_GetIoctrlSDIODrive (void)

void	MXC_SPIXF_SetIoctrlSCLKDriveHigh (void)

void	MXC_SPIXF_SetIoctrlSCLKDriveLow (void)

uint8_t	MXC_SPIXF_GetIoctrlSCLKDrive (void)

void	MXC_SPIXF_SetIoctrlSSDriveHigh (void)

void	MXC_SPIXF_SetIoctrlSSDriveLow (void)

uint8_t	MXC_SPIXF_GetIoctrlSSDrive (void)

void	MXC_SPIXF_SetPuPdCtrl (mxc_spixf_pup_t pupd)

uint8_t	MXC_SPIXF_GetPuPdCtrl (void)

int	MXC_SPIXF_SetBusIdle (unsigned int busidle)

unsigned int	MXC_SPIXF_GetBusIdle (void)

Detailed Description

Data Structure Documentation

◆ mxc_spixf_cfg_t

struct mxc_spixf_cfg_t

MXC_SPIXF configuration type.

Data Fields
mxc_spixf_mode_t	mode

mxc_spixf_sspol_t	ssel_pol

uint32_t	hz

◆ mxc_spixf_req

struct mxc_spixf_req

MXC_SPIXF Transaction request.

Data Fields
uint8_t	deass

uint8_t	wait_tx

const uint8_t *	tx_data

uint8_t *	rx_data

mxc_spixf_width_t	width

unsigned	len

unsigned	read_num

unsigned	write_num

spixr_complete_cb_t	callback

Typedef Documentation

◆ spixr_complete_cb_t

typedef void(* spixr_complete_cb_t) (mxc_spixf_req_t *, int)

Callback for asynchronous request.

Parameters

mxc_spixf_req_t*	Pointer to the transaction request.
int	Error code.

Enumeration Type Documentation

◆ mxc_spixf_mode_t

enum mxc_spixf_mode_t

SPIXF mode.

Note: modes 1 and 2 are not supported

◆ mxc_spixf_ssiact_t

enum mxc_spixf_ssiact_t

Slave select Inactive timing.

Enumerator
MXC_SPIXF_SYS_CLOCKS_1	1 system clocks
MXC_SPIXF_SYS_CLOCKS_3	3 system clocks
MXC_SPIXF_SYS_CLOCKS_5	5 system clocks
MXC_SPIXF_SYS_CLOCKS_9	9 system clocks

◆ mxc_spixf_width_t

enum mxc_spixf_width_t

Number of data lines to use.

Enumerator
MXC_SPIXF_WIDTH_1	1 Data Line.
MXC_SPIXF_WIDTH_2	2 Data Lines (x2).
MXC_SPIXF_WIDTH_4	4 Data Lines (x4).

Function Documentation

◆ MXC_SPIXF_AbortAsync()

int MXC_SPIXF_AbortAsync ( mxc_spixf_req_t * req )

Abort asynchronous request.

Parameters

req	Pointer to request for a MXC_SPIXF transaction.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_BBDataOutputDisable()

int MXC_SPIXF_BBDataOutputDisable ( uint8_t mask )

Disable bits to not be in bit bang output mode.

Parameters

[in] mask Disable output bit bang on specific bits so bit 3 set will disable bit 3

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_BBDataOutputEnable()

int MXC_SPIXF_BBDataOutputEnable ( uint8_t mask )

Enable bits to be in bit bang output mode.

Parameters

[in] mask Enable output bit bang on specific bits so bit 3 set will enable bit 3

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_BBDataOutputIsEnabled()

uint8_t MXC_SPIXF_BBDataOutputIsEnabled ( void )

Get if bit bang output mode is enabled or disabled for all bits.

Returns: Returns if Output bit bang is enabled (1) or disabled (0) in bits 0:3 corresponding with sdio0:sdio3

◆ MXC_SPIXF_BitBangModeDisable()

int MXC_SPIXF_BitBangModeDisable ( void )

Disable bit bang mode.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_BitBangModeEnable()

int MXC_SPIXF_BitBangModeEnable ( void )

Enable bit bang mode.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_BitBangModeIsEnabled()

int MXC_SPIXF_BitBangModeIsEnabled ( void )

Is Bit bang mode enabled or disabled.

Returns: Bit bang mode is enabled (1) or disabled (0)

◆ MXC_SPIXF_ClearFlags()

int MXC_SPIXF_ClearFlags ( uint32_t flags )

Clear Flags that have been set.

Parameters

[in] flags The flags to be cleared

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_Clocks()

int MXC_SPIXF_Clocks	(	uint32_t	len,
		uint8_t	deass
	)

Send Clock cycles on SCK without reading or writing.

Parameters

len	Number of clock cycles to send.
deass	De-assert slave select at the end of the transaction.

Returns: Cycles transacted if everything is successful, error if unsuccessful.

◆ MXC_SPIXF_Disable()

int MXC_SPIXF_Disable ( void )

Disables SPIXF but doesnt change any configurations.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_DisableInt()

int MXC_SPIXF_DisableInt ( uint32_t mask )

Disable Interrupts.

Parameters

[in] mask The mask for the interrupts to enable

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_Enable()

int MXC_SPIXF_Enable ( void )

Enables SPIXF but doesnt change any configurations.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_EnableInt()

int MXC_SPIXF_EnableInt ( uint32_t mask )

Enable Interrupts.

Parameters

[in] mask The mask for the interrupts to enable

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_GetAddrWidth()

mxc_spixf_spiwidth_t MXC_SPIXF_GetAddrWidth ( void )

Get number of data I/O expected to be used for address.

Returns: Enum that corresponds to single, dual, quad SDIO

◆ MXC_SPIXF_GetBBDataInputValue()

uint8_t MXC_SPIXF_GetBBDataInputValue ( void )

Get Input data value.

Returns: Returns input data value of a 1 or 0 in bits 0:3 corresponding with sdio0:sdio3

◆ MXC_SPIXF_GetBBDataOutputValue()

uint8_t MXC_SPIXF_GetBBDataOutputValue ( void )

Get Output data value.

Returns: Returns output data value of a 1 or 0 in bits 0:3 corresponding with sdio0:sdio3

◆ MXC_SPIXF_GetBusIdle()

unsigned int MXC_SPIXF_GetBusIdle ( void )

Get Bus Idle time.

Returns: the time the bus will idle before deactivating slave select.

◆ MXC_SPIXF_GetBytesPerAddr()

unsigned int MXC_SPIXF_GetBytesPerAddr ( void )

Get number of bytes in address.

Returns: 3-byte address (3) or 4-byte address (4)

◆ MXC_SPIXF_GetCmdMode()

mxc_spixf_cmd_t MXC_SPIXF_GetCmdMode ( void )

Get Command mode.

Returns: When the read command is sent. It will be either every time (0) or First transaction only (1).

◆ MXC_SPIXF_GetCmdWidth()

mxc_spixf_spiwidth_t MXC_SPIXF_GetCmdWidth ( void )

Get number of data I/O expected to be used for commands.

Returns: Enum that corresponds to single, dual, quad SDIO

◆ MXC_SPIXF_GetDataWidth()

mxc_spixf_spiwidth_t MXC_SPIXF_GetDataWidth ( void )

Get number of data I/O expected to be used for data.

Returns: Enum that corresponds to single, dual, quad SDIO

◆ MXC_SPIXF_GetFlags()

int MXC_SPIXF_GetFlags ( void )

Get Flags of Interrupts of Flags that have been set.

Returns: the Flags that are set

◆ MXC_SPIXF_GetIoctrlSCLKDrive()

uint8_t MXC_SPIXF_GetIoctrlSCLKDrive ( void )

Get IOCTRL SCLK Drive.

Returns: 1= high or 0 = low

◆ MXC_SPIXF_GetIoctrlSDIODrive()

uint8_t MXC_SPIXF_GetIoctrlSDIODrive ( void )

Get IOCTRL SDIO Drive.

Returns: 1 = high or 0 = low

◆ MXC_SPIXF_GetIoctrlSSDrive()

uint8_t MXC_SPIXF_GetIoctrlSSDrive ( void )

Get IOCTRL SS Drive.

Returns: 1 = high or 0 = low

◆ MXC_SPIXF_GetMode()

mxc_spixf_mode_t MXC_SPIXF_GetMode ( void )

Get which mode that spixf is currently set for.

Returns: returns the enum for spi 0 or spi3

◆ MXC_SPIXF_GetModeClk()

uint8_t MXC_SPIXF_GetModeClk ( void )

Get number of SPI clocks being used for the mode/dummy phase of fetch.

Returns: the number of clocks mode clock is set at.

◆ MXC_SPIXF_GetModeData()

uint16_t MXC_SPIXF_GetModeData ( void )

Get the data that is supposed to send with the dummy clocks.

Returns: the data being sent with dummy clocks

◆ MXC_SPIXF_GetPageSize()

mxc_spixf_page_size_t MXC_SPIXF_GetPageSize ( void )

Get the current page size for a transaction.

Returns: The enum that corresponds with the current page size.

◆ MXC_SPIXF_GetPuPdCtrl()

uint8_t MXC_SPIXF_GetPuPdCtrl ( void )

Get what setting the pull up pull down is set to.

Returns: the enum value for pull up pull down state

◆ MXC_SPIXF_GetSampleOutputValue()

uint8_t MXC_SPIXF_GetSampleOutputValue ( void )

Get bit bang sample output value.

Returns: Returns sample output bit bang value of a 1 or 0 in bits 0:3 corresponding with sdio0:sdio3

◆ MXC_SPIXF_GetSCKDrive()

uint8_t MXC_SPIXF_GetSCKDrive ( void )

Get if SCK is high or low.

Returns: returns 1 if High, 0 if Low

◆ MXC_SPIXF_GetSCKInverted()

int MXC_SPIXF_GetSCKInverted ( void )

Get weather SCK is inverted or non-inverted.

Returns: Enum that corresponds to Inverted (1) or non-inverted (0)

◆ MXC_SPIXF_GetSCKSampleDelay()

uint8_t MXC_SPIXF_GetSCKSampleDelay ( void )

Get the Number of clocks being delayed before sampling SDIO.

Returns: get number of clocks between 0-15.

◆ MXC_SPIXF_GetSPIFrequency()

uint32_t MXC_SPIXF_GetSPIFrequency ( void )

Get the current SPI clock frequency. If the read and write clock frequencies have been set to different values, this function will return the read frequency.

Returns: The current frequency that the SPI is communicating at.

◆ MXC_SPIXF_GetSPIFrequencyRead()

uint32_t MXC_SPIXF_GetSPIFrequencyRead ( void )

Get the current SPI clock frequency for read operations.

Returns: The current frequency that the SPI is communicating at.

◆ MXC_SPIXF_GetSPIFrequencyWrite()

uint32_t MXC_SPIXF_GetSPIFrequencyWrite ( void )

Get the current SPI clock frequency for write operations.

Returns: The current frequency that the SPI is communicating at.

◆ MXC_SPIXF_GetSSActiveTime()

mxc_spixf_ssact_t MXC_SPIXF_GetSSActiveTime ( void )

Get the slave select active timing setting.

Returns: gives the enum value that corresponds to 0,2,4,8 clocks of delay that ss is currently set at.

◆ MXC_SPIXF_GetSSDriveOutput()

uint8_t MXC_SPIXF_GetSSDriveOutput ( void )

Get current slave select output.

Returns: 0 or 1 based on output of line.

◆ MXC_SPIXF_GetSSInactiveTime()

mxc_spixf_ssiact_t MXC_SPIXF_GetSSInactiveTime ( void )

Get slave select inactive timing to delay from de-assertion of slave select to re-assertion of slave select for another spi transaction.

Returns: The enum that corresponds to a 1,3,5,9 clock delay

◆ MXC_SPIXF_GetSSPolarity()

int MXC_SPIXF_GetSSPolarity ( void )

Get the current slave select polarity.

Returns: Active High is (0), Active Low is (1)

◆ MXC_SPIXF_Handler()

void MXC_SPIXF_Handler ( void )

MXC_SPIXF interrupt handler.

This function should be called by the application from the interrupt handler if MXC_SPIXF interrupts are enabled. Alternately, this function can be periodically called by the application if MXC_SPIXF interrupts are disabled.

◆ MXC_SPIXF_Init()

int MXC_SPIXF_Init	(	uint32_t	cmdval,
		uint32_t	frequency
	)

Setup MXC_SPIXF for Execute in Place.

Parameters

cmdval	command for the external flash chip.
frequency	Frequency of transmission

Returns: None

◆ MXC_SPIXF_IOCtrl()

void MXC_SPIXF_IOCtrl	(	mxc_spixf_ds_t	sclk_ds,
		mxc_spixf_ds_t	ss_ds,
		mxc_spixf_ds_t	sdio_ds,
		mxc_spixf_pup_t	pupdctrl
	)

Setup Drive Strength on the I/O pins.

Parameters

sclk_ds	SCLK drive strength
ss_ds	Slave Select Drive Strength
sdio_ds	SDIO Drive Strength
pupdctrl	IO Pullup/Pulldown Control

◆ MXC_SPIXF_IsEnabled()

int MXC_SPIXF_IsEnabled ( void )

Is SPIXF Enabled or Disabled.

Returns: SPIXF is enabled (1) or disabled (0)

◆ MXC_SPIXF_ReadyForSleep()

int MXC_SPIXF_ReadyForSleep ( void )

Attempt to prepare the MXC_SPIXF for sleep.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_RXFIFODisable()

int MXC_SPIXF_RXFIFODisable ( void )

RX FIFO (results fifo) disable.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_RXFIFOEnable()

int MXC_SPIXF_RXFIFOEnable ( void )

RX FIFO (results fifo) enable.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_RXFIFOIsEnabled()

int MXC_SPIXF_RXFIFOIsEnabled ( void )

Is RX FIFO (results fifo) enabled or disabled.

Returns: RX FIFO is enabled (1) or disabled (0)

◆ MXC_SPIXF_SampleOutputDisable()

int MXC_SPIXF_SampleOutputDisable ( uint8_t mask )

Disable bit bang sample output mode on spefic bits.

Parameters

[in] mask Disable sample output bit bang mode. so bit 3 set will disable bit 3

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SampleOutputEnable()

int MXC_SPIXF_SampleOutputEnable ( uint8_t mask )

Enable bit bang sample output mode on spefic bits.

Parameters

[in] mask Enable sample output bit bang mode. so bit 3 set will enable bit 3

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SampleOutputIsEnabled()

uint8_t MXC_SPIXF_SampleOutputIsEnabled ( void )

Get if sample output bit bang is enabled or disabled.

Returns: Returns sample output bit bang mode if a 1 (enabled) or 0 (disabled) in bits 0:3 corresponding with sdio0:sdio3

◆ MXC_SPIXF_SCKFeebackDisable()

int MXC_SPIXF_SCKFeebackDisable ( void )

Disable SCK Feedback.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SCKFeebackIsEnabled()

int MXC_SPIXF_SCKFeebackIsEnabled ( void )

Get if SCK Feedback is enabled or disabled.

Returns: Returns if feedback mode is Enabled (1) or disabled (0).

◆ MXC_SPIXF_SCKFeedbackEnable()

int MXC_SPIXF_SCKFeedbackEnable ( void )

Enable SCK Feedback.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_Set3ByteAddr()

int MXC_SPIXF_Set3ByteAddr ( void )

Set address mode to be 3 byte address.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_Set4ByteAddr()

int MXC_SPIXF_Set4ByteAddr ( void )

Set address mode to be 4 byte address.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetAddrWidth()

int MXC_SPIXF_SetAddrWidth ( mxc_spixf_spiwidth_t width )

Set Number of data I/O used to send address.

Parameters

[in] width Enum that corresponds to single, dual, quad SDIO.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetBusIdle()

int MXC_SPIXF_SetBusIdle ( unsigned int busidle )

Set bus idle to a time where ss will be deactivated if timer runs out.

Parameters

[in] busidle The time before the timer runs out

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetCmdModeEveryTrans()

int MXC_SPIXF_SetCmdModeEveryTrans ( void )

Set command mode to send read a command every time a spi transaction is initiated.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetCmdValue()

int MXC_SPIXF_SetCmdValue ( uint8_t cmdval )

Set command value for spi transaction.

Parameters

[in] cmdval

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetCmdWidth()

int MXC_SPIXF_SetCmdWidth ( mxc_spixf_spiwidth_t width )

Set Number of data I/O used to send commands.

Parameters

[in] width Enum that corresponds to single, dual, quad SDIO.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetDataWidth()

int MXC_SPIXF_SetDataWidth ( mxc_spixf_spiwidth_t width )

Set Number of data I/O used to send data.

Parameters

[in] width Enum that corresponds to single, dual, quad SDIO.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetMode()

int MXC_SPIXF_SetMode ( mxc_spixf_mode_t mode )

Sets the SPI Mode.

Parameters

[in] mode The enum that corresponds to the SPI Mode

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetModeClk()

int MXC_SPIXF_SetModeClk ( uint8_t mdclk )

Set number of SPI clocks needed during the mode/dummy phase of fetch.

Parameters

[in] mdclk The number of clocks from 0-15

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetModeData()

int MXC_SPIXF_SetModeData ( uint16_t data )

Set the data to send with the dummy clocks.

Parameters

[in] data The data to send

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetPageSize()

void MXC_SPIXF_SetPageSize ( mxc_spixf_page_size_t size )

Set Page Size for transactions.

Parameters

[in] size The size of a transaction in bytes

◆ MXC_SPIXF_SetPuPdCtrl()

void MXC_SPIXF_SetPuPdCtrl ( mxc_spixf_pup_t pupd )

Set pull up pull down.

Parameters

[in] pupd The enum corresponding to Pull up pull down states

◆ MXC_SPIXF_SetSCKDriveHigh()

void MXC_SPIXF_SetSCKDriveHigh ( void )

Drive SCK High.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetSCKDriveLow()

void MXC_SPIXF_SetSCKDriveLow ( void )

Drive SCK Low.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetSCKInverted()

int MXC_SPIXF_SetSCKInverted ( void )

Set SCK to be inverted.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetSCKNonInverted()

int MXC_SPIXF_SetSCKNonInverted ( void )

Set SCK to be non-inverted.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetSCKSampleDelay()

int MXC_SPIXF_SetSCKSampleDelay ( uint8_t delay )

Set SPI clock periods to delay before sampling SDIO input. This value must be less than or equal to HICLK.

Parameters

[in] delay The number of clocks to delay between 0-15

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetSPIFrequency()

int MXC_SPIXF_SetSPIFrequency ( unsigned int hz )

Sets both the read and write SPI clock frequency to the given value.

Parameters

[in] hz The frequency the spi will communicating at.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetSPIFrequencyRead()

int MXC_SPIXF_SetSPIFrequencyRead ( unsigned int hz )

Sets the SPI clock frequency for read operations.

Parameters

[in] hz The frequency the spi will communicating at.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetSPIFrequencyWrite()

int MXC_SPIXF_SetSPIFrequencyWrite ( unsigned int hz )

Sets the SPI clock frequency for write operations.

Parameters

[in] hz The frequency the spi will communicating at.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetSSActiveTime()

int MXC_SPIXF_SetSSActiveTime ( mxc_spixf_ssact_t ssact )

Set the slave select active timing. This will control the delay from assertion of slave select to start of the SCK pulse and delay from the end of SCK pulse to de-assertion of slave select.

Parameters

[in] ssact The enum that corresponds with 0,2,4,8 clocks of delay

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetSSInactiveTime()

int MXC_SPIXF_SetSSInactiveTime ( mxc_spixf_ssiact_t ssiact )

Set slave select inactive timing to delay from de-assertion of slave select to re-assertion of slave select for another spi transaction.

Parameters

[in] ssiact The enum that corresponds to a 1,3,5,9 clock delay

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetSSPolActiveHigh()

int MXC_SPIXF_SetSSPolActiveHigh ( void )

Set the slave select polarity to high or low.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SetSSPolActiveLow()

int MXC_SPIXF_SetSSPolActiveLow ( void )

Set the slave select polarity to high or low.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SimpleModeDisable()

int MXC_SPIXF_SimpleModeDisable ( void )

Disable Simple Mode.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SimpleModeEnable()

int MXC_SPIXF_SimpleModeEnable ( void )

Enable Simple Mode.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SimpleModeIsEnabled()

int MXC_SPIXF_SimpleModeIsEnabled ( void )

Get if Simple mode is enabled or disabled.

Returns: Returns if simple mode is enabled or disabled

◆ MXC_SPIXF_SimpleRXDisable()

int MXC_SPIXF_SimpleRXDisable ( void )

Set to Receive only in simple mode.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SimpleRXEnabled()

int MXC_SPIXF_SimpleRXEnabled ( void )

Set to Receive only in simple mode.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_SimpleRXIsEnabled()

int MXC_SPIXF_SimpleRXIsEnabled ( void )

Get Receive only mode setting.

Returns: Returns if simple receive is enabled or disabled

◆ MXC_SPIXF_Transaction()

int MXC_SPIXF_Transaction ( mxc_spixf_req_t * req )

Read/write MXC_SPIXF data. Will block until transaction is complete.

Parameters

req	Request for a MXC_SPIXF transaction.

Note: Callback is ignored.

Returns: Bytes transacted if everything is successful, error if unsuccessful.

◆ MXC_SPIXF_TransactionAsync()

int MXC_SPIXF_TransactionAsync ( mxc_spixf_req_t * req )

Asynchronously read/write MXC_SPIXF data.

Parameters

req	Request for a MXC_SPIXF transaction.

Note: Request structure must remain allocated until callback.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_TXFIFODisable()

int MXC_SPIXF_TXFIFODisable ( void )

TX FIFO (Transaction FIFO) disable.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_TXFIFOEnable()

int MXC_SPIXF_TXFIFOEnable ( void )

TX FIFO (Transaction FIFO) enable.

Returns: See Error Codes for the list of error return codes.

◆ MXC_SPIXF_TXFIFOIsEnabled()

int MXC_SPIXF_TXFIFOIsEnabled ( void )

Is TX FIFO (Transaction FIFO) Enabled or Disabled.

Returns: TX FIFO is enabled (1) or disabled (0)

Modules

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ mxc_spixf_cfg_t

Data Fields

◆ mxc_spixf_req

Data Fields

Typedef Documentation

◆ spixr_complete_cb_t

Enumeration Type Documentation

◆ mxc_spixf_mode_t

◆ mxc_spixf_ssiact_t

◆ mxc_spixf_width_t

Function Documentation

◆ MXC_SPIXF_AbortAsync()

◆ MXC_SPIXF_BBDataOutputDisable()

◆ MXC_SPIXF_BBDataOutputEnable()

◆ MXC_SPIXF_BBDataOutputIsEnabled()

◆ MXC_SPIXF_BitBangModeDisable()

◆ MXC_SPIXF_BitBangModeEnable()

◆ MXC_SPIXF_BitBangModeIsEnabled()

◆ MXC_SPIXF_ClearFlags()

◆ MXC_SPIXF_Clocks()

◆ MXC_SPIXF_Disable()

◆ MXC_SPIXF_DisableInt()

◆ MXC_SPIXF_Enable()

◆ MXC_SPIXF_EnableInt()

◆ MXC_SPIXF_GetAddrWidth()

◆ MXC_SPIXF_GetBBDataInputValue()

◆ MXC_SPIXF_GetBBDataOutputValue()

◆ MXC_SPIXF_GetBusIdle()

◆ MXC_SPIXF_GetBytesPerAddr()

◆ MXC_SPIXF_GetCmdMode()

◆ MXC_SPIXF_GetCmdWidth()

◆ MXC_SPIXF_GetDataWidth()

◆ MXC_SPIXF_GetFlags()

◆ MXC_SPIXF_GetIoctrlSCLKDrive()

◆ MXC_SPIXF_GetIoctrlSDIODrive()

◆ MXC_SPIXF_GetIoctrlSSDrive()

◆ MXC_SPIXF_GetMode()

◆ MXC_SPIXF_GetModeClk()

◆ MXC_SPIXF_GetModeData()

◆ MXC_SPIXF_GetPageSize()

◆ MXC_SPIXF_GetPuPdCtrl()

◆ MXC_SPIXF_GetSampleOutputValue()

◆ MXC_SPIXF_GetSCKDrive()

◆ MXC_SPIXF_GetSCKInverted()

◆ MXC_SPIXF_GetSCKSampleDelay()

◆ MXC_SPIXF_GetSPIFrequency()

◆ MXC_SPIXF_GetSPIFrequencyRead()

◆ MXC_SPIXF_GetSPIFrequencyWrite()

◆ MXC_SPIXF_GetSSActiveTime()

◆ MXC_SPIXF_GetSSDriveOutput()

◆ MXC_SPIXF_GetSSInactiveTime()

◆ MXC_SPIXF_GetSSPolarity()

◆ MXC_SPIXF_Handler()

◆ MXC_SPIXF_Init()

◆ MXC_SPIXF_IOCtrl()

◆ MXC_SPIXF_IsEnabled()

◆ MXC_SPIXF_ReadyForSleep()

◆ MXC_SPIXF_RXFIFODisable()

◆ MXC_SPIXF_RXFIFOEnable()

◆ MXC_SPIXF_RXFIFOIsEnabled()

◆ MXC_SPIXF_SampleOutputDisable()

◆ MXC_SPIXF_SampleOutputEnable()

◆ MXC_SPIXF_SampleOutputIsEnabled()

◆ MXC_SPIXF_SCKFeebackDisable()

◆ MXC_SPIXF_SCKFeebackIsEnabled()

◆ MXC_SPIXF_SCKFeedbackEnable()

◆ MXC_SPIXF_Set3ByteAddr()

◆ MXC_SPIXF_Set4ByteAddr()

◆ MXC_SPIXF_SetAddrWidth()

◆ MXC_SPIXF_SetBusIdle()

◆ MXC_SPIXF_SetCmdModeEveryTrans()

◆ MXC_SPIXF_SetCmdValue()

◆ MXC_SPIXF_SetCmdWidth()