mbed official
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.
Last commit 20 Feb 2019 by 
mbed official
targets/hal/TARGET_Atmel/TARGET_SAM21/drivers/sercom/i2c/quick_start_master/qs_i2c_master_basic_use.h@579:53297373a894, 2015-07-01 (annotated)
- Committer:
- mbed_official
- Date:
- Wed Jul 01 09:45:11 2015 +0100
- Revision:
- 579:53297373a894
- Child:
- 592:a274ee790e56
Synchronized with git revision d5b4d2ab9c47edb4dc5776e7177b0c2263459081
Full URL: https://github.com/mbedmicro/mbed/commit/d5b4d2ab9c47edb4dc5776e7177b0c2263459081/
Initial version of drivers for SAMR21
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| mbed_official | 579:53297373a894 | 1 | /** |
| mbed_official | 579:53297373a894 | 2 | * \file |
| mbed_official | 579:53297373a894 | 3 | * |
| mbed_official | 579:53297373a894 | 4 | * \brief SAM SERCOM I2C Master Quick Start Guide |
| mbed_official | 579:53297373a894 | 5 | * |
| mbed_official | 579:53297373a894 | 6 | * Copyright (C) 2012-2014 Atmel Corporation. All rights reserved. |
| mbed_official | 579:53297373a894 | 7 | * |
| mbed_official | 579:53297373a894 | 8 | * \asf_license_start |
| mbed_official | 579:53297373a894 | 9 | * |
| mbed_official | 579:53297373a894 | 10 | * \page License |
| mbed_official | 579:53297373a894 | 11 | * |
| mbed_official | 579:53297373a894 | 12 | * Redistribution and use in source and binary forms, with or without |
| mbed_official | 579:53297373a894 | 13 | * modification, are permitted provided that the following conditions are met: |
| mbed_official | 579:53297373a894 | 14 | * |
| mbed_official | 579:53297373a894 | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
| mbed_official | 579:53297373a894 | 16 | * this list of conditions and the following disclaimer. |
| mbed_official | 579:53297373a894 | 17 | * |
| mbed_official | 579:53297373a894 | 18 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| mbed_official | 579:53297373a894 | 19 | * this list of conditions and the following disclaimer in the documentation |
| mbed_official | 579:53297373a894 | 20 | * and/or other materials provided with the distribution. |
| mbed_official | 579:53297373a894 | 21 | * |
| mbed_official | 579:53297373a894 | 22 | * 3. The name of Atmel may not be used to endorse or promote products derived |
| mbed_official | 579:53297373a894 | 23 | * from this software without specific prior written permission. |
| mbed_official | 579:53297373a894 | 24 | * |
| mbed_official | 579:53297373a894 | 25 | * 4. This software may only be redistributed and used in connection with an |
| mbed_official | 579:53297373a894 | 26 | * Atmel microcontroller product. |
| mbed_official | 579:53297373a894 | 27 | * |
| mbed_official | 579:53297373a894 | 28 | * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED |
| mbed_official | 579:53297373a894 | 29 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| mbed_official | 579:53297373a894 | 30 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE |
| mbed_official | 579:53297373a894 | 31 | * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR |
| mbed_official | 579:53297373a894 | 32 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| mbed_official | 579:53297373a894 | 33 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| mbed_official | 579:53297373a894 | 34 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| mbed_official | 579:53297373a894 | 35 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| mbed_official | 579:53297373a894 | 36 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
| mbed_official | 579:53297373a894 | 37 | * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| mbed_official | 579:53297373a894 | 38 | * POSSIBILITY OF SUCH DAMAGE. |
| mbed_official | 579:53297373a894 | 39 | * |
| mbed_official | 579:53297373a894 | 40 | * \asf_license_stop |
| mbed_official | 579:53297373a894 | 41 | * |
| mbed_official | 579:53297373a894 | 42 | */ |
| mbed_official | 579:53297373a894 | 43 | |
| mbed_official | 579:53297373a894 | 44 | /** |
| mbed_official | 579:53297373a894 | 45 | * \page asfdoc_sam0_sercom_i2c_master_basic_use_case Quick Start Guide for SERCOM I2C Master - Basic |
| mbed_official | 579:53297373a894 | 46 | * |
| mbed_official | 579:53297373a894 | 47 | * In this use case, the I<SUP>2</SUP>C will used and set up as follows: |
| mbed_official | 579:53297373a894 | 48 | * - Master mode |
| mbed_official | 579:53297373a894 | 49 | * - 100KHz operation speed |
| mbed_official | 579:53297373a894 | 50 | * - Not operational in standby |
| mbed_official | 579:53297373a894 | 51 | * - 10000 packet timeout value |
| mbed_official | 579:53297373a894 | 52 | * - 65535 unknown bus state timeout value |
| mbed_official | 579:53297373a894 | 53 | * |
| mbed_official | 579:53297373a894 | 54 | * |
| mbed_official | 579:53297373a894 | 55 | * \section asfdoc_sam0_sercom_i2c_master_basic_use_case_prereq Prerequisites |
| mbed_official | 579:53297373a894 | 56 | * The device must be connected to an I<SUP>2</SUP>C slave. |
| mbed_official | 579:53297373a894 | 57 | * |
| mbed_official | 579:53297373a894 | 58 | * \section asfdoc_sam0_sercom_i2c_master_basic_use_setup Setup |
| mbed_official | 579:53297373a894 | 59 | * |
| mbed_official | 579:53297373a894 | 60 | * \subsection asfdoc_sam0_sercom_i2c_master_basic_use_setup_code Code |
| mbed_official | 579:53297373a894 | 61 | * The following must be added to the user application: |
| mbed_official | 579:53297373a894 | 62 | * |
| mbed_official | 579:53297373a894 | 63 | * - A sample buffer to send, a sample buffer to read: |
| mbed_official | 579:53297373a894 | 64 | * \snippet qs_i2c_master_basic_use.c packet_data |
| mbed_official | 579:53297373a894 | 65 | * |
| mbed_official | 579:53297373a894 | 66 | * - Slave address to access: |
| mbed_official | 579:53297373a894 | 67 | * \snippet qs_i2c_master_basic_use.c address |
| mbed_official | 579:53297373a894 | 68 | * |
| mbed_official | 579:53297373a894 | 69 | * - Number of times to try to send packet if it fails: |
| mbed_official | 579:53297373a894 | 70 | * \snippet qs_i2c_master_basic_use.c timeout |
| mbed_official | 579:53297373a894 | 71 | * |
| mbed_official | 579:53297373a894 | 72 | * - Globally accessible module structure: |
| mbed_official | 579:53297373a894 | 73 | * \snippet qs_i2c_master_basic_use.c dev_inst |
| mbed_official | 579:53297373a894 | 74 | * |
| mbed_official | 579:53297373a894 | 75 | * - Function for setting up the module: |
| mbed_official | 579:53297373a894 | 76 | * \snippet qs_i2c_master_basic_use.c initialize_i2c |
| mbed_official | 579:53297373a894 | 77 | * |
| mbed_official | 579:53297373a894 | 78 | * - Add to user application \c main(): |
| mbed_official | 579:53297373a894 | 79 | * \snippet qs_i2c_master_basic_use.c init |
| mbed_official | 579:53297373a894 | 80 | * |
| mbed_official | 579:53297373a894 | 81 | * \subsection asfdoc_sam0_sercom_i2c_master_basic_use_setup_workflow Workflow |
| mbed_official | 579:53297373a894 | 82 | * -# Configure and enable module. |
| mbed_official | 579:53297373a894 | 83 | * \snippet qs_i2c_master_basic_use.c initialize_i2c |
| mbed_official | 579:53297373a894 | 84 | * -# Create and initialize configuration structure. |
| mbed_official | 579:53297373a894 | 85 | * \snippet qs_i2c_master_basic_use.c init_conf |
| mbed_official | 579:53297373a894 | 86 | * -# Change settings in the configuration. |
| mbed_official | 579:53297373a894 | 87 | * \snippet qs_i2c_master_basic_use.c conf_change |
| mbed_official | 579:53297373a894 | 88 | * -# Initialize the module with the set configurations. |
| mbed_official | 579:53297373a894 | 89 | * \snippet qs_i2c_master_basic_use.c init_module |
| mbed_official | 579:53297373a894 | 90 | * -# Enable the module. |
| mbed_official | 579:53297373a894 | 91 | * \snippet qs_i2c_master_basic_use.c enable_module |
| mbed_official | 579:53297373a894 | 92 | * -# Create a variable to see when we should stop trying to send packet. |
| mbed_official | 579:53297373a894 | 93 | * \snippet qs_i2c_master_basic_use.c timeout_counter |
| mbed_official | 579:53297373a894 | 94 | * -# Create a packet to send. |
| mbed_official | 579:53297373a894 | 95 | * \snippet qs_i2c_master_basic_use.c packet |
| mbed_official | 579:53297373a894 | 96 | * |
| mbed_official | 579:53297373a894 | 97 | * \section asfdoc_sam0_sercom_i2c_master_basic_use_implemenation Implementation |
| mbed_official | 579:53297373a894 | 98 | * \subsection asfdoc_sam0_sercom_i2c_master_basic_use_implemenation_code Code |
| mbed_official | 579:53297373a894 | 99 | * Add to user application \c main(): |
| mbed_official | 579:53297373a894 | 100 | * \snippet qs_i2c_master_basic_use.c main |
| mbed_official | 579:53297373a894 | 101 | * |
| mbed_official | 579:53297373a894 | 102 | * \subsection asfdoc_sam0_sercom_i2c_master_basic_use_implemenation_workflow Workflow |
| mbed_official | 579:53297373a894 | 103 | * -# Write packet to slave. |
| mbed_official | 579:53297373a894 | 104 | * \snippet qs_i2c_master_basic_use.c write_packet |
| mbed_official | 579:53297373a894 | 105 | * The module will try to send the packet TIMEOUT number of times or until it is |
| mbed_official | 579:53297373a894 | 106 | * successfully sent. |
| mbed_official | 579:53297373a894 | 107 | * -# Read packet from slave. |
| mbed_official | 579:53297373a894 | 108 | * \snippet qs_i2c_master_basic_use.c read_packet |
| mbed_official | 579:53297373a894 | 109 | * The module will try to read the packet TIMEOUT number of times or until it is |
| mbed_official | 579:53297373a894 | 110 | * successfully read. |
| mbed_official | 579:53297373a894 | 111 | */ |
| mbed_official | 579:53297373a894 | 112 | /** |
| mbed_official | 579:53297373a894 | 113 | * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a> |
| mbed_official | 579:53297373a894 | 114 | */ |
| mbed_official | 579:53297373a894 | 115 | |
| mbed_official | 579:53297373a894 | 116 | #include <asf.h> |
| mbed_official | 579:53297373a894 | 117 | #include <conf_clocks.h> |
| mbed_official | 579:53297373a894 | 118 |
