Two Wire-interface High Speed(TWIHS)

This is the common API for TWIHS.

Additional features are available in the documentation of the specific modules.

See Quickstart guide for Common service TWIHS.

Platform Dependencies

The TWIHS API is partially chip- or platform-specific. While all platforms provide mostly the same functionality, there are some variations around how different bus types and clock tree structures are handled.

The following functions are available on all platforms, but there may be variations in the function signature (i.e. parameters) and behaviour. These functions are typically called by platform-specific parts of drivers, and applications that aren't intended to be portable:

• Master TWIHS Module initialization

  status_code_t twihs_master_setup(*twihs_module_pointer, twihs_master_options_t *opt) 

• Enables TWIHS Module

  void twihs_master_enable(*twihs_module_pointer) 

• Disables TWIHS Module

  void twihs_master_disable(*twihs_module_pointer) 

• Read data from a slave device

  status_code_t twihs_master_read(*twihs_module_pointer, twihs_package_t *package) 

• Write data from to a slave device

  status_code_t twihs_master_write(*twihs_module_pointer, twihs_package_t *package) 

Additional features are available in the documentation of the specific modules.

Platform Dependencies

The twihs API is partially chip- or platform-specific. While all platforms provide mostly the same functionality, there are some variations around how different bus types and clock tree structures are handled.

The following functions are available on all platforms, but there may be variations in the function signature (i.e. parameters) and behaviour. These functions are typically called by platform-specific parts of drivers, and applications that aren't intended to be portable:

• twihs_slave_setup()
• twihs_slave_enable()
• twihs_slave_disable()
• twihs_slave_read()
• twihs_slave_write()

Typedefs
typedef Twihs *	twihs_master_t
	This type can be used independently to refer to TWIHS master module for the architecture used. More...
typedef Twihs *	twihs_slave_t
	This type can be used independently to refer to TWIHS slave module for the architecture used. More...

twihs_master_t

This type can be used independently to refer to TWIHS master module for the architecture used.

It refers to the correct type definition for the architecture.

twihs_slave_t

This type can be used independently to refer to TWIHS slave module for the architecture used.