mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

targets/hal/TARGET_Atmel/TARGET_SAM21/drivers/sercom/i2c/quick_start_slave/qs_i2c_slave_basic_use.h

Committer:
mbed_official
Date:
2015-07-01
Revision:
579:53297373a894
Child:
592:a274ee790e56

File content as of revision 579:53297373a894:

/**
 * \file
 *
 * \brief SAM SERCOM I2C Slave Quick Start Guide with Callbacks
 *
 * Copyright (C) 2013-2014 Atmel Corporation. All rights reserved.
 *
 * \asf_license_start
 *
 * \page License
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. The name of Atmel may not be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * 4. This software may only be redistributed and used in connection with an
 *    Atmel microcontroller product.
 *
 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * \asf_license_stop
 *
 */

/**
 * \page asfdoc_sam0_sercom_i2c_slave_basic_use_case Quick Start Guide for SERCOM I2C Slave - Basic
 *
 * In this use case, the I<SUP>2</SUP>C will used and set up as follows:
 *  - Slave mode
 *  - 100KHz operation speed
 *  - Not operational in standby
 *  - 10000 packet timeout value
 *
 * \section asfdoc_sam0_sercom_i2c_slave_basic_use_case_prereq Prerequisites
 * The device must be connected to an I<SUP>2</SUP>C master.
 *
 * \section asfdoc_sam0_sercom_i2c_slave_basic_use_case_setup_code Setup
 *
 * \subsection asfdoc_sam0_sercom_i2c_slave_basic_use_setup_code Code
 * The following must be added to the user application:
 *
 * A sample buffer to write from, a sample buffer to read to and length of buffers:
 * \snippet qs_i2c_slave_basic_use.c packet_data
 *
 * Address to respond to:
 * \snippet qs_i2c_slave_basic_use.c address
 *
 * Globally accessible module structure:
 * \snippet qs_i2c_slave_basic_use.c module
 *
 * Function for setting up the module:
 * \snippet qs_i2c_slave_basic_use.c initialize_i2c
 *
 * Add to user application \c main():
 * \snippet qs_i2c_slave_basic_use.c run_initialize_i2c
 *
 * \subsection asfdoc_sam0_sercom_i2c_slave_basic_use_setup_workflow Workflow
 * -# Configure and enable module.
 *    \snippet qs_i2c_slave_basic_use.c config
 *   -# Create and initialize configuration structure.
 *      \snippet qs_i2c_slave_basic_use.c init_conf
 *   -# Change address and address mode settings in the configuration.
 *      \snippet qs_i2c_slave_basic_use.c conf_changes
 *   -# Initialize the module with the set configurations.
 *      \snippet qs_i2c_slave_basic_use.c init_module
 *   -# Enable the module.
 *      \snippet qs_i2c_slave_basic_use.c enable_module
 * -# Create variable to hold transfer direction.
 *    \snippet qs_i2c_slave_basic_use.c dir
 * -# Create packet variable to transfer.
 *    \snippet qs_i2c_slave_basic_use.c pack
 *
 * \section asfdoc_sam0_sercom_i2c_slave_basic_use_implementation Implementation
 * \subsection asfdoc_sam0_sercom_i2c_slave_basic_use_implementation_code Code
 * Add to user application \c main():
 * \snippet qs_i2c_slave_basic_use.c while
 * \subsection i2c_slave_basic_use_implementation_workflow Workflow
 * -# Wait for start condition from master and get transfer direction.
 *    \snippet qs_i2c_slave_basic_use.c get_dir
 * -# Depending on transfer direction, set up buffer to read to or write from,
 *    and write or read from master.
 *    \snippet qs_i2c_slave_basic_use.c transfer
 */
/**
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
*/

#include <asf.h>
#include <conf_clocks.h>