Jonathan Piat / mbed-src

mbed library sources

Fork of mbed-src by mbed official

Embed: (wiki syntax)

« Back to documentation index

Synchronous SPI Hardware Abstraction Layer
Functions

Synchronous SPI Hardware Abstraction Layer

Functions

int spi_master_write (spi_t *obj, int value)
 Write a byte out in master mode and receive a value.
int spi_slave_receive (spi_t *obj)
 Check if a value is available to read.
int spi_slave_read (spi_t *obj)
 Get a received value out of the SPI receive buffer in slave mode.
void spi_slave_write (spi_t *obj, int value)
 Write a value to the SPI peripheral in slave mode.
int spi_busy (spi_t *obj)
 Checks if the specified SPI peripheral is in use.
uint8_t spi_get_module (spi_t *obj)
 Get the module number.

Function Documentation

int spi_busy ( spi_t *  obj )

Checks if the specified SPI peripheral is in use.

Parameters:
[in]objThe SPI peripheral to check
Returns:
non-zero if the peripheral is currently transmitting
uint8_t spi_get_module ( spi_t *  obj )

Get the module number.

Parameters:
[in]objThe SPI peripheral to check
Returns:
The module number
int spi_master_write ( spi_t *  obj,
int  value 
)

Write a byte out in master mode and receive a value.

Parameters:
[in]objThe SPI peripheral to use for sending
[in]valueThe value to send
Returns:
Returns the value received during send
int spi_slave_read ( spi_t *  obj )

Get a received value out of the SPI receive buffer in slave mode.

Blocks until a value is available

Parameters:
[in]objThe SPI peripheral to read
Returns:
The value received
int spi_slave_receive ( spi_t *  obj )

Check if a value is available to read.

Parameters:
[in]objThe SPI peripheral to check
Returns:
non-zero if a value is available
void spi_slave_write ( spi_t *  obj,
int  value 
)

Write a value to the SPI peripheral in slave mode.

Blocks until the SPI peripheral can be written to

Parameters:
[in]objThe SPI peripheral to write
[in]valueThe value to write
Generated on Tue Jul 12 2022 18:17:28 by  doxygen 1.7.2