Tizen RT Public API  v1.1 D4

Provides APIs for SPI (Serial Peripheral Interface) More...

Collaboration diagram for SPI:

Files

file  iotbus_spi.h
 Iotbus APIs for SPI.
 

Data Structures

struct  iotbus_spi_config_s
 Structure of SPI configuration. More...
 

Typedefs

typedef struct _iotbus_spi_s * iotbus_spi_context_h
 Pointer definition to the internal struct _iotbus_spi_s. More...
 

Enumerations

enum  iotbus_spi_mode_e
 Enumeration of SPI mode. More...
 

Functions

iotbus_spi_context_h iotbus_spi_open (unsigned int bus, const struct iotbus_spi_config_s *config)
 initializes spi_context. More...
 
int iotbus_spi_write (iotbus_spi_context_h hnd, uint8_t *txbuf, size_t length)
 writes data over spi bus. More...
 
int iotbus_spi_recv (iotbus_spi_context_h hnd, uint8_t *rxbuf, size_t length)
 reads data over spi bus. More...
 
int iotbus_spi_transfer_buf (iotbus_spi_context_h hnd, uint8_t *txbuf, uint8_t *rxbuf, size_t length)
 transfers rx and tx data over spi bus. More...
 
int iotbus_spi_close (iotbus_spi_context_h hnd)
 closes spi_context. More...
 

Detailed Description

Provides APIs for SPI (Serial Peripheral Interface)

Typedef Documentation

◆ iotbus_spi_context_h

typedef struct _iotbus_spi_s* iotbus_spi_context_h

Pointer definition to the internal struct _iotbus_spi_s.

Definition at line 68 of file iotbus_spi.h.

Enumeration Type Documentation

◆ iotbus_spi_mode_e

Enumeration of SPI mode.

Enumeration Details:
IOTBUS_SPI_MODE0
IOTBUS_SPI_MODE1
IOTBUS_SPI_MODE2
IOTBUS_SPI_MODE3

Definition at line 46 of file iotbus_spi.h.

Function Documentation

◆ iotbus_spi_close()

int iotbus_spi_close ( iotbus_spi_context_h  hnd)

closes spi_context.

#include <iotbus/iotbus_spi.h>

Parameters
[in]hndhandle of spi_context
Returns
On success, 0 is returned. On failure, a negative value is returned.
Since
Tizen RT v1.0

◆ iotbus_spi_open()

iotbus_spi_context_h iotbus_spi_open ( unsigned int  bus,
const struct iotbus_spi_config_s config 
)

initializes spi_context.

#include <iotbus/iotbus_spi.h>

Parameters
[in]busspi bus number
[in]configspi config
  • config->bits_per_word : bits per word
  • config->chip_select : chip select number
  • config->frequency : frequency in Hz
  • config->mode : spi mode
Returns
On success, handle of spi_context is returned. On failure, NULL is returned.
Since
Tizen RT v1.0

◆ iotbus_spi_recv()

int iotbus_spi_recv ( iotbus_spi_context_h  hnd,
uint8_t *  rxbuf,
size_t  length 
)

reads data over spi bus.

#include <iotbus/iotbus_spi.h>

Parameters
[in]hndhandle of spi_context
[in]rxbufthe pointer of rx data buffer
[in]lengthsize to read
Returns
On success, 0 is returned. On failure, a negative value is returned.
Since
Tizen RT v1.0

◆ iotbus_spi_transfer_buf()

int iotbus_spi_transfer_buf ( iotbus_spi_context_h  hnd,
uint8_t *  txbuf,
uint8_t *  rxbuf,
size_t  length 
)

transfers rx and tx data over spi bus.

#include <iotbus/iotbus_spi.h>

Parameters
[in]hndhandle of spi_context
[in]txbufthe pointer of tx data buffer
[in]rxbufthe pointer of rx data buffer
[in]lengthsize to transfer
Returns
On success, 0 is returned. On failure, a negative value is returned.
Since
Tizen RT v1.0

◆ iotbus_spi_write()

int iotbus_spi_write ( iotbus_spi_context_h  hnd,
uint8_t *  txbuf,
size_t  length 
)

writes data over spi bus.

#include <iotbus/iotbus_spi.h>

Parameters
[in]hndhandle of spi_context
[in]txbufthe pointer of tx data buffer
[in]lengthsize to write
Returns
On success, 0 is returned. On failure, a negative value is returned.
Since
Tizen RT v1.0