Atmel SAM4 Series User Manual

AT07334: SAM4 TWI Master Mode Driver [APPLICATION NOTE]
42274A-MCU-05/2014
2
Table of Contents
SAM4 TWI Master Mode Driver ......................................................... 1
Software License ................................................................................ 4
1. Prequisites .................................................................................... 5
2. Module Overview .......................................................................... 6
2.1. TWI Bus Topology ...................................................................... 6
3. Examples ...................................................................................... 7
4. API Overview ................................................................................ 8
4.1. Variable and Type Definitions ........................................................ 8
4.1.1. Type twim_transfer_status_t ............................................ 8
4.1.2. Type twim_callback_t ..................................................... 8
4.2. Structure Definitions .................................................................... 8
4.2.1. Struct twim_config .......................................................... 8
4.2.2. Struct twim_package ....................................................... 9
4.3. Macro Definitions ........................................................................ 9
4.3.1. TWI Driver Compatibility .................................................. 9
4.3.2. Macro TWI_FAST_MODE_PLUS_SPEED ......................... 10
4.3.3. Macro TWI_FAST_MODE_SPEED .................................. 10
4.3.4. Macro TWI_HIGH_SPEED_MODE_SPEED ...................... 10
4.3.5. Macro TWI_STD_MODE_SPEED .................................... 10
4.3.6. Macro TWIM_IER_NAK_MASK ....................................... 10
4.3.7. Macro TWIM_IER_STD_MASK ....................................... 10
4.3.8. Macro TWIM_LOW_POWER_ENABLE ............................ 10
4.3.9. Macro TWIM_SCR_NAK_MASK ..................................... 11
4.3.10. Macro TWIM_SR_NAK_MASK ....................................... 11
4.3.11. Macro TWIM_SR_STD_MASK ........................................ 11
4.4. Function Definitions ................................................................... 11
4.4.1. Function twi_master_read() ............................................ 11
4.4.2. Function twi_master_write() ............................................ 11
4.4.3. Function twim_clear_status() .......................................... 12
4.4.4. Function twim_default_callback() ..................................... 12
4.4.5. Function twim_disable() ................................................. 12
4.4.6. Function twim_disable_interrupt() .................................... 13
4.4.7. Function twim_enable() ................................................. 13
4.4.8. Function twim_enable_interrupt() ..................................... 13
4.4.9. Function twim_get_interrupt_mask() ................................. 14
4.4.10. Function twim_get_status() ............................................ 14
4.4.11. Function twim_pdca_transfer_prepare() ............................ 14
4.4.12. Function twim_probe() .................................................. 15
4.4.13. Function twim_set_callback() .......................................... 15
4.4.14. Function twim_set_config() ............................................. 15
4.4.15. Function twim_set_hsmode_speed() ................................ 16
4.4.16. Function twim_set_speed() ............................................ 16
4.5. Enumeration Definitions .............................................................. 17
4.5.1. Enum twim_transfer_status ............................................ 17
5. Special Considerations ............................................................... 18
6. Extra Information ........................................................................ 19
6.1. Acronyms ................................................................................ 19
7. TWIM Master Example ............................................................... 20
7.1. Purpose ................................................................................... 20
7.2. Requirements ........................................................................... 20

Atmel SAM4 Series Specifications

General

Brand	Atmel
Model	SAM4 Series
Category	Control Unit
Language	English