Atmel SAM4 Series User Manual

AT07334: SAM4 TWI Master Mode Driver [APPLICATION NOTE]
42274A-MCU-05/2014
14
Data direction Parameter name Description
[in] interrupt_source The TWI interrupt to be enabled
4.4.9 Function twim_get_interrupt_mask()
Return the current content of the Interrupt Mask Register.
uint32_t twim_get_interrupt_mask(
Twim * twim)
Table 4-13. Parameters
Data direction Parameter name Description
[in] twim Base address of the TWIM
Returns
TWIM interrupt mask.
4.4.10 Function twim_get_status()
Return the contents of Status Register.
uint32_t twim_get_status(
Twim * twim)
Table 4-14. Parameters
Data direction Parameter name Description
[in] twim Base address of the TWIM
Returns
Contents of TWI Status Register.
4.4.11 Function twim_pdca_transfer_prepare()
Setup the TWI master for a PDCA (Peripheral DMA Controler) transfer.
void twim_pdca_transfer_prepare(
Twim * twim,
twi_package_t * package,
bool read)
Setup a DMA transfer. See twim_package
Table 4-15. Parameters
Data direction Parameter name Description
[in] twim Base address of the TWIM
[in] package Package information and data, see
twim_package

Atmel SAM4 Series Specifications

General

Architecture	ARM Cortex-M4
DAC	12-bit, up to 2 channels
Communication Interfaces	USB, USART, SPI, I2C, CAN
Operating Voltage	1.62V to 3.6V
Package Types	BGA, QFN
Operating Temperature	-40°C to +85°C

Summary

Prerequisites

Module Overview

TWI Bus Topology

Describes the physical layout and components of the TWI bus, including pull-up resistors.

Examples

API Overview

Variable and Type Definitions

Details the variable and type definitions used within the TWIM driver API, including transfer status and callback types.

Structure Definitions

Describes the structure definitions for configuring the TWIM module, such as twim_config and twim_package.

Macro Definitions

Lists and explains the macro definitions used for TWI driver compatibility and configuration settings.

Function Definitions

Details the available functions for controlling the TWIM module, including read, write, and configuration operations.

Enumeration Definitions

Explains the enumerated type definitions, such as twim_transfer_status, for driver status reporting.

Special Considerations

Extra Information

Acronyms

Provides a list of acronyms and their definitions used throughout the TWIM driver documentation.

TWIM Master Example

Purpose

States the objective of the TWIM Master Example, which is to demonstrate driver usage for EEPROM access.

Requirements

Lists the necessary hardware and software requirements for running the TWIM Master Example.

Connections for Board: SAM4L Xplained Pro

Details the specific pin connections required for the SAM4L Xplained Pro board to interface with an EEPROM.

Connections for Board: SAM4L-EK

Details the specific pin connections required for the SAM4L-EK board to interface with an EEPROM.

Description

Outlines the steps involved in the TWIM Master Example: writing data, reading data, and comparing results.

Usage

Provides instructions on how to build, download, and run the TWIM Master Example on the evaluation board.

Quick Start Guide

Use Cases

Presents different use cases for the SAM4 TWI Master Mode Driver, highlighting TWIM Basic Usage.

TWIM Basic Usage

Demonstrates the basic steps required to initialize the TWIM module for fundamental operation.

Setup Steps

Guides the user through the essential setup steps, including prerequisites and workflow for configuring the TWIM module.

Usage Steps

Details the practical steps for sending and receiving data using the TWIM driver, including code examples.