spi.h File Reference

Go to the source code of this file.

Macros
#define	SPI_GP_RXBUF_SIZE   20

Functions
BOOL	SPI_initialize ()
BOOL	SPI_acquirePort ()
BOOL	SPI_releasePort ()
BOOL	SPI_transaction (uint8_t *rxBuf, uint8_t *txBuf, uint16_t size)

Variables
uint8_t	gpRxBuf [SPI_GP_RXBUF_SIZE]

Macro Definition Documentation

SPI_GP_RXBUF_SIZE

#define SPI_GP_RXBUF_SIZE   20

sensor_spi.h

Author

Aaron Parks

Date

Aug 2013

Function Documentation

SPI_acquirePort()

BOOL SPI_acquirePort

(

)

Returns

Success - you were able to get the port. Fail - you don't have the port, so don't use it.

SPI_initialize()

BOOL SPI_initialize

(

)

Returns

success or failure

Todo:

Implement this function

SPI_releasePort()

BOOL SPI_releasePort

(

)

Returns

success or fail

Todo:

Make this more robust (don't allow release of port if we don't have it)

SPI_transaction()

BOOL SPI_transaction	(	uint8_t *	rxBuf,
		uint8_t *	txBuf,
		uint16_t	size
	)

Engage in a synchronous serial transaction of the specified length. This function blocks until transaction is complete.

Parameters

txBuf
size

Returns

success or fail

Variable Documentation

gpRxBuf

uint8_t gpRxBuf[SPI_GP_RXBUF_SIZE]

sensor_spi.c

Author

Aaron Parks

Date

Aug 2013