#include <sys/device.h>
#include <sys/nutdebug.h>
#include <dev/spibus.h>

Include dependency graph for spibus.c:

Functions
int	NutRegisterSpiDevice (NUTDEVICE dev, NUTSPIBUS bus, int cs)
	Register and initialize an SPI device attached to a specified bus.
int	NutSpiBusWait (NUTSPINODE *node, uint32_t tmo)
	Wait until all SPI bus transfers are done.
uint_fast16_t	NutSpiBusSetMode (NUTSPINODE *node, uint_fast16_t mode)
	Set SPI mode of a specified bus device.
uint_fast32_t	NutSpiBusSetRate (NUTSPINODE *node, uint_fast32_t rate)
	Set clock rate of a specified SPI device.
uint_fast8_t	NutSpiBusSetBits (NUTSPINODE *node, uint_fast8_t bits)
	Set clock rate of a specified SPI device.

Function Documentation

int NutRegisterSpiDevice	(	NUTDEVICE *	dev,
		NUTSPIBUS *	bus,
		int	cs
	)

Register and initialize an SPI device attached to a specified bus.

Calls the bus controller initialization and, if successful, initializes the SPI device and adds it to the system device list.

Applications should call this function during initialization for each SPI device they intend to use.

Parameters:

dev	Pointer to the NUTDEVICE structure, which is provided by the device driver.
bus	Pointer to the NUTSPIBUS structure, which is provided by the bus controller driver.
cs	Zero based chip select number for this device. Must be set to 0, if only one device is attached to the bus and no chip select line is provided.

Returns:: 0 if the device has been registered for the first time and the initialization was successful. The function returns -1, if any device with the same name had been registered previously, if the NUTDEVICE structure or the chip select is invalid or if the device or bus controller initialization failed.

References _NUTSPIBUS::bus_initnode, _NUTSPIBUS::bus_mutex, _NUTDEVICE::dev_icb, _NUTSPINODE::node_bus, _NUTSPINODE::node_cs, NULL, NUTASSERT, NutEventPost(), NutRegisterDevice(), and rc.

Here is the call graph for this function:

int NutSpiBusWait	(	NUTSPINODE *	node,
		uint32_t	tmo
	)

Wait until all SPI bus transfers are done.

This dummy function is used by SPI device drivers, which do not provide asynchronous transfers.

Parameters:

node	Specifies the SPI bus node.
tmo	Timeout in milliseconds. To disable timeout, set this parameter to NUT_WAIT_INFINITE.

Returns:: Always 0.

uint_fast16_t NutSpiBusSetMode	(	NUTSPINODE *	node,
		uint_fast16_t	mode
	)

Set SPI mode of a specified bus device.

The new mode will be used during the next transfer. If its value is SPI_CURRENT_MODE, then the mode is not updated. This can be used to query the current mode.

Otherwise this parameter may be the or'ed combination of the following bits:

SPI_MODE_CPHA: Data updated on leading edge.
SPI_MODE_CPOL: Idle clock is high.
SPI_MODE_FAULT: Enables mode fault detection.
SPI_MODE_LOOPBACK: Loopback mode.
SPI_MODE_SLAVE: Slave mode.
SPI_MODE_CSKEEP: Chip select remains active after transfer.
SPI_MODE_CSDEC: Decoded chip selects.
SPI_MODE_CSHIGH: Chip select is high active.

Be aware, that SPI drivers may have implemented a subset only.

Instead of SPI_MODE_CPHA and SPI_MODE_CPOL one of the following mode numbers may be used:

SPI_MODE_0: Idle clock is low and data is captured on the rising edge.
SPI_MODE_1: Idle clock is low and data is captured on the falling edge.
SPI_MODE_2: Idle clock is high and data is captured on the falling edge.
SPI_MODE_3: Idle clock is high and data is captured on the rising edge.

The return value may additionally contain the bit SPI_MODE_UPDATE, which indicates that here had been no transfer since the last mode update.

Parameters:

node	Specifies the SPI bus node.
mode	New mode.

Returns:: Old mode.

References _NUTSPINODE::node_mode, rc, SPI_CURRENT_MODE, and SPI_MODE_UPDATE.

uint_fast32_t NutSpiBusSetRate	(	NUTSPINODE *	node,
		uint_fast32_t	rate
	)

Set clock rate of a specified SPI device.

The new clock rate will be used for the next transfer. If the given rate is beyond the capabilities of the bus controller, it will automatically adjusted before the transfer starts.

Parameters:

node	Specifies the SPI bus node.
rate	New clock rate, given in bits per second. If the value is SPI_CURRENT_RATE, then the current rate is kept.

Returns:: Previous rate.

References _NUTSPINODE::node_mode, _NUTSPINODE::node_rate, rc, SPI_CURRENT_RATE, and SPI_MODE_UPDATE.

uint_fast8_t NutSpiBusSetBits	(	NUTSPINODE *	node,
		uint_fast8_t	bits
	)

Set clock rate of a specified SPI device.

The new clock rate will be used for the next transfer. If the given rate is beyond the capabilities of the bus controller, it will automatically adjusted before the transfer starts.

Parameters:

node	Specifies the SPI bus node.
rate	New clock rate, given in bits per second. If the value is SPI_CURRENT_RATE, then the current rate is kept.

Returns:: Previous rate.

References _NUTSPINODE::node_bits, _NUTSPINODE::node_mode, rc, SPI_CURRENT_BITS, and SPI_MODE_UPDATE.

Functions

Function Documentation