Defines an SPI driver to facilitate communication with other devices on an SPI bus (such as a temperature sensor, etc). More...

Macros
#define	wiced_hal_pspi_init wiced_hal_pspi_init_patch
	Initialize the SPI driver with the given parameters. More...

Enumerations
enum	{ SPI_MASTER_ROLE = 1, SPI_SLAVE_ROLE = 2 }
	SPI Device Role.

Functions
void	wiced_hal_pspi_init_patch (UINT8 devRole, UINT8 spiPinPullConfig, UINT32 spiGpioCfg, UINT32 clkSpeed, SPI_ENDIAN endian, SPI_SS_POLARITY polarity, SPI_MODE mode, UINT8 csPin)

static INLINE void	wiced_hal_pspi_tx_data (UINT32 txLen, const UINT8 *txBuf)
	Send/transmit data over SPI as the master. More...

static INLINE void	wiced_hal_pspi_rx_data (UINT32 rxLen, UINT8 *rxBuf)
	Receive data over SPI as the master. More...

static INLINE void	wiced_hal_pspi_reset (void)
	Reset and bring the SPI driver to a known good state with default configuration. More...

static INLINE void	wiced_hal_pspi_exchange_data (UINT32 len, const UINT8 txBuf, UINT8 rxBuf)
	Transmit one buffer of data while simultaneously receiving data (as the master). More...

static INLINE void	wiced_hal_pspi_slave_enable_tx (void)
	Enable the tx fifo so any data in it will be transmitted when the SPI master clocks it out. More...

static INLINE void	wiced_hal_pspi_slave_disable_tx (void)
	Disable the tx fifo. More...

static INLINE void	wiced_hal_pspi_slave_enable_rx (void)
	Enable the rx fifo for incoming data when the SPI master clocks it in. More...

static INLINE void	wiced_hal_pspi_slave_disable_rx (void)
	Disable the rx fifo. More...

static INLINE void	wiced_hal_pspi_slave_tx_data (UINT32 txLen, const UINT8 *txBuf)
	Send/transmit data over SPI as a slave. More...

static INLINE SPIFFY_STATUS	wiced_hal_pspi_slave_rx_data (UINT32 rxLen, UINT8 *rxBuf)
	Receive data over SPI as a slave. More...

static INLINE UINT32	wiced_hal_pspi_slave_get_tx_fifo_count (void)
	Get the number of bytes in the slave tx fifo. More...

static INLINE UINT32	wiced_hal_pspi_slave_get_rx_fifo_count (void)
	Get the number of bytes in the slave rx fifo. More...

Detailed Description

Defines an SPI driver to facilitate communication with other devices on an SPI bus (such as a temperature sensor, etc).

The driver is capable of assuming either a master or a slave role on said bus. Applications use this driver to obtain the status from and control the behavior of the SPI hardware. This driver only offers services for clock control, mode control and data transfer operations. The application is responsible for generating the slave/chip select signals (if it's in a master role). This could be done by mapping a GPIO pin for each slave the application wants to control (See wiced_hal_gpio.h for more information on driving a GPIO pin).

All master data transfer operations (half/full duplex) provided by this driver assume that the desired slave has already been selected and will remain selected throughout the duration of the transaction.

Please note that this driver cannot access supplied off-chip memory (if installed; serial flash, etc). Please use the drivers found in wiced_hal_sflash.h or wiced_hal_seeprom.h to access those modules, as those drivers deal with a separate SPI bus and include checks to ensure safe data handling operations. This driver is intended only to interface with other devices on the peripheral SPI bus, such as a motion sensor. Of course, this restriction does not preclude the user from adding their own memory module to the peripheral bus, and using this driver with it.

Parameters.

The following parameters are used to configure the SPI driver or define
return status. They are not modifiable.

For all the available GPIO config combinations (spiGpioCfg) for master and slave modes, please reference the Kit Guide, since the values vary by hardware platform.

SPI Endian: Direction of bit data flow (MSB or LSB first).

typedef enum SPI_ENDIAN
{
    /// Transmit most significant bit first
    SPI_MSB_FIRST,
    /// Transmit least significant bit first
    SPI_LSB_FIRST
} SPI_ENDIAN;

Slave Select mode (output from master)

typedef enum SPI_SS_MODE
{
    /// Slave select normal
    SPI_SS_NORMAL,
    /// Slave select goes inactive between bytes
    SPI_SS_INACTIVE_BTW_BYTES
} SPI_SS_MODE;

Slave select polarity (output from master)

typedef enum SPI_SS_POLARITY
{
    /// Slave select active low
    SPI_SS_ACTIVE_LOW,
    /// Slave select active high
    SPI_SS_ACTIVE_HIGH,
} SPI_SS_POLARITY;

Clock polarity and phase If CPOL=0, base value of the clock is zero If CPOL=1, base value of the clock is one If CPHA=0, sample on leading (first) clock edge If CPHA=1, sample on trailing (second) clock edge

typedef enum SPI_MODE
{
    /// CPOL = 0, CPHA = 0
    /// Data read on clock's rising edge, data changed on a falling edge
    SPI_MODE_0,
    /// CPOL = 0, CPHA = 1
    /// Data read on clock's falling edge, data changed on a rising edge
    SPI_MODE_1,
    /// CPOL = 1, CPHA = 0
    /// Data read on clock's falling edge, data changed on a rising edge
    SPI_MODE_2,
    /// CPOL = 1, CPHA = 1
    /// Data read on clock's rising edge, data changed on a falling edge
    SPI_MODE_3
} SPI_MODE;

Pull configure for input-pin

Master input pin – MISO

Slave input pin – CLOCK – MOSI – CS

enum
{
    // pull up for MISO if master mode, for MOSI if Slave mode
    INPUT_PIN_PULL_UP   = 0x0400,
    // pull DOWN for MISO if master mode, for MOSI if Slave mode
    INPUT_PIN_PULL_DOWN = 0x0200,
    // FLOAT for MISO if master mode, for MOSI if Slave mode
    INPUT_PIN_FLOATING  = 0x0,
};

Return values.

typedef enum
{
    SPIFFY_SUCCESS,
    SPIFFY_SLAVE_NOT_ENOUGH_RX_FIFO_BYTES
} SPIFFY_STATUS;

Macro Definition Documentation

#define wiced_hal_pspi_init wiced_hal_pspi_init_patch

Initialize the SPI driver with the given parameters.

Please reference the various parameters above.

In this function, the hardware block will be reset. The driver will be configured before the first transaction with a device.

For the chip select (CS) line, define the Port/Pin you want to use. There could be up to 40 GPIO pins on a board so the numbering is P0 - P39.

Remember that P# is the physical pin number on the board minus 1. Ex: Board Pin 4 = P3.

Parameters

devRole	- SPI HW to play either master (1) or slave (2).
spiPinPullConfig	- Pin pull-up or pull-down.
spiGpioCfg	- Pins to use for the data and clk lines (see Kit Guide for specific values which vary by platform).
clkSpeed	- Clock speed (non-zero for master, zero for slave).
endian	- Direction of bit data flow (MSB or LSB first).
polarity	- Active high or active low for chip select line.
mode,-	SPI mode (0-3).
csPin	- GPIO pin of chip select line (see above).

Returns: none

Function Documentation

static INLINE void wiced_hal_pspi_exchange_data	(	UINT32	len,
		const UINT8 *	txBuf,
		UINT8 *	rxBuf
	)

static

Transmit one buffer of data while simultaneously receiving data (as the master).

Assumes that the slave/chip select line will be active throughout this transaction.

Parameters

len	- The number of bytes to transmit and receive.
txBuf	- Pointer to the data buffer to transmit.
rxBuf	- Pointer to the buffer where the read data will be stored.

Returns: none

static INLINE void wiced_hal_pspi_reset ( void )

static

Reset and bring the SPI driver to a known good state with default configuration.

Note that the hardware block will be reset.

Parameters

none

Returns: none

static INLINE void wiced_hal_pspi_rx_data	(	UINT32	rxLen,
		UINT8 *	rxBuf
	)

static

Receive data over SPI as the master.

Assumes that the slave/chip select line will be active throughout the transaction.

Parameters

txLen	- Length of the data buffer to receive.
txBuf	- Pointer to the data buffer which will receive data.

Returns: none

static INLINE void wiced_hal_pspi_slave_disable_rx ( void )

static

Disable the rx fifo.

Parameters

none

Returns: none

static INLINE void wiced_hal_pspi_slave_disable_tx ( void )

static

Disable the tx fifo.

Parameters

none

Returns: none

static INLINE void wiced_hal_pspi_slave_enable_rx ( void )

static

Enable the rx fifo for incoming data when the SPI master clocks it in.

Parameters

none

Returns: none

static INLINE void wiced_hal_pspi_slave_enable_tx ( void )

static

Enable the tx fifo so any data in it will be transmitted when the SPI master clocks it out.

Parameters

none

Returns: none

static INLINE UINT32 wiced_hal_pspi_slave_get_rx_fifo_count ( void )

static

Get the number of bytes in the slave rx fifo.

Parameters

none

Returns: Number of bytes in the rx fifo.

static INLINE UINT32 wiced_hal_pspi_slave_get_tx_fifo_count ( void )

static

Get the number of bytes in the slave tx fifo.

Parameters

none

Returns: Number of bytes in the tx fifo.

static INLINE SPIFFY_STATUS wiced_hal_pspi_slave_rx_data	(	UINT32	rxLen,
		UINT8 *	rxBuf
	)

static

Receive data over SPI as a slave.

If the rx fifo is enabled, pull data from the rx fifo if there are at least rxLen bytes in the rx fifo.

Parameters

txLen	- Length of the data buffer to receive.
txBuf	- Pointer to the data buffer which will receive data.

Returns: SUCCESS if bytes were received or NOT_ENOUGH_RX_FIFO_BYTES if fail.

static INLINE void wiced_hal_pspi_slave_tx_data	(	UINT32	txLen,
		const UINT8 *	txBuf
	)

static

Send/transmit data over SPI as a slave.

If the tx fifo is enabled, the data in the tx fifo will be transmitted when the SPI master clocks it out.

Parameters

txLen	- The number of bytes-to-send that this buffer contains.
txBuf	- Pointer to the data buffer to transmit.

Returns: none

static INLINE void wiced_hal_pspi_tx_data	(	UINT32	txLen,
		const UINT8 *	txBuf
	)

static

Send/transmit data over SPI as the master.

Assumes that the slave/chip select line will be active throughout the transaction.

Parameters

txLen	- The number of bytes-to-send that this buffer contains.
txBuf	- Pointer to the data buffer to transmit.

Returns: none


			AIROC^™ BTSDK v4.9 - Documentation

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Function Documentation