RUI3 (RAK Unified Interface 3) - RAK4631
udrv_twimst.h File Reference

Provide a hardware independent TWI master driver layer for API layer to use. More...

Go to the source code of this file.

Data Structures

struct  udrv_twimst_api
 

Enumerations

enum  udrv_twimst_port {
  UDRV_TWIMST_0 = 0x0,
  UDRV_TWIMST_1 = 0x1,
  UDRV_TWIMST_2 = 0x2,
  UDRV_TWIMST_3 = 0x3,
  UDRV_TWIMST_MAX = 0x4
}
 

Functions

void udrv_twimst_init (udrv_twimst_port port)
 
void udrv_twimst_deinit (udrv_twimst_port port)
 
void udrv_twimst_setup_freq (udrv_twimst_port port, uint32_t clk_Hz)
 
int32_t udrv_twimst_write (udrv_twimst_port port, uint8_t address, uint8_t *data, uint16_t length, bool send_stop)
 
int32_t udrv_twimst_read (udrv_twimst_port port, uint8_t address, uint8_t *data, uint16_t length)
 
void udrv_twimst_suspend (void)
 
void udrv_twimst_resume (void)
 

Detailed Description

Provide a hardware independent TWI master driver layer for API layer to use.

Author
Rakwireless
Version
0.0.0
Date
2021.2

Enumeration Type Documentation

◆ udrv_twimst_port

Enumerator
UDRV_TWIMST_0 
UDRV_TWIMST_1 
UDRV_TWIMST_2 
UDRV_TWIMST_3 
UDRV_TWIMST_MAX 

Function Documentation

◆ udrv_twimst_init()

void udrv_twimst_init ( udrv_twimst_port  port)

◆ udrv_twimst_deinit()

void udrv_twimst_deinit ( udrv_twimst_port  port)

◆ udrv_twimst_setup_freq()

void udrv_twimst_setup_freq ( udrv_twimst_port  port,
uint32_t  clk_Hz 
)

◆ udrv_twimst_write()

int32_t udrv_twimst_write ( udrv_twimst_port  port,
uint8_t  address,
uint8_t *  data,
uint16_t  length,
bool  send_stop 
)

◆ udrv_twimst_read()

int32_t udrv_twimst_read ( udrv_twimst_port  port,
uint8_t  address,
uint8_t *  data,
uint16_t  length 
)

◆ udrv_twimst_suspend()

void udrv_twimst_suspend ( void  )

◆ udrv_twimst_resume()

void udrv_twimst_resume ( void  )