Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

Synchronous SPI Hardware Abstraction Layer
Functions

Synchronous SPI Hardware Abstraction Layer
[Hal]

Functions

int spi_master_write (spi_t *obj, int value)
 Write a byte out in master mode and receive a value.
int spi_master_block_write (spi_t *obj, const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length, char write_fill)
 Write a block 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.
const PinMap * spi_master_mosi_pinmap (void)
 Get the pins that support SPI MOSI.
const PinMap * spi_master_miso_pinmap (void)
 Get the pins that support SPI MISO.
const PinMap * spi_master_clk_pinmap (void)
 Get the pins that support SPI CLK.
const PinMap * spi_master_cs_pinmap (void)
 Get the pins that support SPI CS.
const PinMap * spi_slave_mosi_pinmap (void)
 Get the pins that support SPI MOSI.
const PinMap * spi_slave_miso_pinmap (void)
 Get the pins that support SPI MISO.
const PinMap * spi_slave_clk_pinmap (void)
 Get the pins that support SPI CLK.
const PinMap * spi_slave_cs_pinmap (void)
 Get the pins that support SPI CS.

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_block_write ( spi_t *  obj,
const char *  tx_buffer,
int  tx_length,
char *  rx_buffer,
int  rx_length,
char  write_fill 
)

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

The total number of bytes sent and received will be the maximum of tx_length and rx_length. The bytes written will be padded with the value 0xff.

Parameters:
[in]objThe SPI peripheral to use for sending
[in]tx_bufferPointer to the byte-array of data to write to the device
[in]tx_lengthNumber of bytes to write, may be zero
[in]rx_bufferPointer to the byte-array of data to read from the device
[in]rx_lengthNumber of bytes to read, may be zero
[in]write_fillDefault data transmitted while performing a read
Returns:
The number of bytes written and read from the device. This is maximum of tx_length and rx_length.
const PinMap* spi_master_clk_pinmap ( void   )

Get the pins that support SPI CLK.

Return a PinMap array of pins that support SPI CLK in master mode. The array is terminated with {NC, NC, 0}.

Returns:
PinMap array
const PinMap* spi_master_cs_pinmap ( void   )

Get the pins that support SPI CS.

Return a PinMap array of pins that support SPI CS in master mode. The array is terminated with {NC, NC, 0}.

Returns:
PinMap array
const PinMap* spi_master_miso_pinmap ( void   )

Get the pins that support SPI MISO.

Return a PinMap array of pins that support SPI MISO in master mode. The array is terminated with {NC, NC, 0}.

Returns:
PinMap array
const PinMap* spi_master_mosi_pinmap ( void   )

Get the pins that support SPI MOSI.

Return a PinMap array of pins that support SPI MOSI in master mode. The array is terminated with {NC, NC, 0}.

Returns:
PinMap array
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
const PinMap* spi_slave_clk_pinmap ( void   )

Get the pins that support SPI CLK.

Return a PinMap array of pins that support SPI CLK in slave mode. The array is terminated with {NC, NC, 0}.

Returns:
PinMap array
const PinMap* spi_slave_cs_pinmap ( void   )

Get the pins that support SPI CS.

Return a PinMap array of pins that support SPI CS in slave mode. The array is terminated with {NC, NC, 0}.

Returns:
PinMap array
const PinMap* spi_slave_miso_pinmap ( void   )

Get the pins that support SPI MISO.

Return a PinMap array of pins that support SPI MISO in slave mode. The array is terminated with {NC, NC, 0}.

Returns:
PinMap array
const PinMap* spi_slave_mosi_pinmap ( void   )

Get the pins that support SPI MOSI.

Return a PinMap array of pins that support SPI MOSI in slave mode. The array is terminated with {NC, NC, 0}.

Returns:
PinMap array
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 13:55:25 by  doxygen 1.7.2