mbed official / mbed

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

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_SAMR21G18A/TOOLCHAIN_ARM_STD/i2c_master_interrupt.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_SAMD21J18A/TARGET_Atmel/TARGET_SAM_CortexM0P/drivers/sercom/i2c/i2c_master_interrupt.h@111:4336505e4b1c 
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 111:4336505e4b1c 1 /**
Kojto 111:4336505e4b1c 2 * \file
Kojto 111:4336505e4b1c 3 *
Kojto 111:4336505e4b1c 4 * \brief SAM SERCOM I2C Master Interrupt Driver
Kojto 111:4336505e4b1c 5 *
Kojto 111:4336505e4b1c 6 * Copyright (C) 2012-2015 Atmel Corporation. All rights reserved.
Kojto 111:4336505e4b1c 7 *
Kojto 111:4336505e4b1c 8 * \asf_license_start
Kojto 111:4336505e4b1c 9 *
Kojto 111:4336505e4b1c 10 * \page License
Kojto 111:4336505e4b1c 11 *
Kojto 111:4336505e4b1c 12 * Redistribution and use in source and binary forms, with or without
Kojto 111:4336505e4b1c 13 * modification, are permitted provided that the following conditions are met:
Kojto 111:4336505e4b1c 14 *
Kojto 111:4336505e4b1c 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 111:4336505e4b1c 16 * this list of conditions and the following disclaimer.
Kojto 111:4336505e4b1c 17 *
Kojto 111:4336505e4b1c 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 111:4336505e4b1c 19 * this list of conditions and the following disclaimer in the documentation
Kojto 111:4336505e4b1c 20 * and/or other materials provided with the distribution.
Kojto 111:4336505e4b1c 21 *
Kojto 111:4336505e4b1c 22 * 3. The name of Atmel may not be used to endorse or promote products derived
Kojto 111:4336505e4b1c 23 * from this software without specific prior written permission.
Kojto 111:4336505e4b1c 24 *
Kojto 111:4336505e4b1c 25 * 4. This software may only be redistributed and used in connection with an
Kojto 111:4336505e4b1c 26 * Atmel microcontroller product.
Kojto 111:4336505e4b1c 27 *
Kojto 111:4336505e4b1c 28 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
Kojto 111:4336505e4b1c 29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
Kojto 111:4336505e4b1c 30 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
Kojto 111:4336505e4b1c 31 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
Kojto 111:4336505e4b1c 32 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 111:4336505e4b1c 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
Kojto 111:4336505e4b1c 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
Kojto 111:4336505e4b1c 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
Kojto 111:4336505e4b1c 36 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
Kojto 111:4336505e4b1c 37 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
Kojto 111:4336505e4b1c 38 * POSSIBILITY OF SUCH DAMAGE.
Kojto 111:4336505e4b1c 39 *
Kojto 111:4336505e4b1c 40 * \asf_license_stop
Kojto 111:4336505e4b1c 41 *
Kojto 111:4336505e4b1c 42 */
Kojto 111:4336505e4b1c 43 /*
Kojto 111:4336505e4b1c 44 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
Kojto 111:4336505e4b1c 45 */
Kojto 111:4336505e4b1c 46
Kojto 111:4336505e4b1c 47 #ifndef I2C_MASTER_INTERRUPT_H_INCLUDED
Kojto 111:4336505e4b1c 48 #define I2C_MASTER_INTERRUPT_H_INCLUDED
Kojto 111:4336505e4b1c 49
Kojto 111:4336505e4b1c 50 #include "i2c_master.h"
Kojto 111:4336505e4b1c 51
Kojto 111:4336505e4b1c 52 #ifdef __cplusplus
Kojto 111:4336505e4b1c 53 extern "C" {
Kojto 111:4336505e4b1c 54 #endif
Kojto 111:4336505e4b1c 55
Kojto 111:4336505e4b1c 56 /**
Kojto 111:4336505e4b1c 57 * \addtogroup asfdoc_sam0_sercom_i2c_group
Kojto 111:4336505e4b1c 58 * @{
Kojto 111:4336505e4b1c 59 *
Kojto 111:4336505e4b1c 60 */
Kojto 111:4336505e4b1c 61
Kojto 111:4336505e4b1c 62 /**
Kojto 111:4336505e4b1c 63 * \name Callbacks
Kojto 111:4336505e4b1c 64 * @{
Kojto 111:4336505e4b1c 65 */
Kojto 111:4336505e4b1c 66 #if !defined(__DOXYGEN__)
Kojto 111:4336505e4b1c 67 void _i2c_master_interrupt_handler(
Kojto 111:4336505e4b1c 68 uint8_t instance);
Kojto 111:4336505e4b1c 69 #endif
Kojto 111:4336505e4b1c 70
Kojto 111:4336505e4b1c 71 void i2c_master_register_callback(
Kojto 111:4336505e4b1c 72 struct i2c_master_module *const module,
Kojto 111:4336505e4b1c 73 i2c_master_callback_t callback,
Kojto 111:4336505e4b1c 74 enum i2c_master_callback callback_type);
Kojto 111:4336505e4b1c 75
Kojto 111:4336505e4b1c 76 void i2c_master_unregister_callback(
Kojto 111:4336505e4b1c 77 struct i2c_master_module *const module,
Kojto 111:4336505e4b1c 78 enum i2c_master_callback callback_type);
Kojto 111:4336505e4b1c 79
Kojto 111:4336505e4b1c 80 /**
Kojto 111:4336505e4b1c 81 * \brief Enables callback
Kojto 111:4336505e4b1c 82 *
Kojto 111:4336505e4b1c 83 * Enables the callback specified by the callback_type.
Kojto 111:4336505e4b1c 84 *
Kojto 111:4336505e4b1c 85 * \param[in,out] module Pointer to the software module struct
Kojto 111:4336505e4b1c 86 * \param[in] callback_type Callback type to enable
Kojto 111:4336505e4b1c 87 */
Kojto 111:4336505e4b1c 88 static inline void i2c_master_enable_callback(
Kojto 111:4336505e4b1c 89 struct i2c_master_module *const module,
Kojto 111:4336505e4b1c 90 enum i2c_master_callback callback_type)
Kojto 111:4336505e4b1c 91 {
Kojto 111:4336505e4b1c 92 /* Sanity check. */
Kojto 111:4336505e4b1c 93 Assert(module);
Kojto 111:4336505e4b1c 94 Assert(module->hw);
Kojto 111:4336505e4b1c 95
Kojto 111:4336505e4b1c 96 /* Mark callback as enabled. */
Kojto 111:4336505e4b1c 97 module->enabled_callback |= (1 << callback_type);
Kojto 111:4336505e4b1c 98 }
Kojto 111:4336505e4b1c 99
Kojto 111:4336505e4b1c 100 /**
Kojto 111:4336505e4b1c 101 * \brief Disables callback
Kojto 111:4336505e4b1c 102 *
Kojto 111:4336505e4b1c 103 * Disables the callback specified by the callback_type.
Kojto 111:4336505e4b1c 104 *
Kojto 111:4336505e4b1c 105 * \param[in,out] module Pointer to the software module struct
Kojto 111:4336505e4b1c 106 * \param[in] callback_type Callback type to disable
Kojto 111:4336505e4b1c 107 */
Kojto 111:4336505e4b1c 108 static inline void i2c_master_disable_callback(
Kojto 111:4336505e4b1c 109 struct i2c_master_module *const module,
Kojto 111:4336505e4b1c 110 enum i2c_master_callback callback_type)
Kojto 111:4336505e4b1c 111 {
Kojto 111:4336505e4b1c 112 /* Sanity check. */
Kojto 111:4336505e4b1c 113 Assert(module);
Kojto 111:4336505e4b1c 114 Assert(module->hw);
Kojto 111:4336505e4b1c 115
Kojto 111:4336505e4b1c 116 /* Mark callback as disabled. */
Kojto 111:4336505e4b1c 117 module->enabled_callback &= ~(1 << callback_type);
Kojto 111:4336505e4b1c 118 }
Kojto 111:4336505e4b1c 119
Kojto 111:4336505e4b1c 120 /** @} */
Kojto 111:4336505e4b1c 121
Kojto 111:4336505e4b1c 122 /**
Kojto 111:4336505e4b1c 123 * \name Read and Write, Interrupt-Driven
Kojto 111:4336505e4b1c 124 * @{
Kojto 111:4336505e4b1c 125 */
Kojto 111:4336505e4b1c 126
Kojto 111:4336505e4b1c 127 enum status_code i2c_master_read_bytes(
Kojto 111:4336505e4b1c 128 struct i2c_master_module *const module,
Kojto 111:4336505e4b1c 129 struct i2c_master_packet *const packet);
Kojto 111:4336505e4b1c 130
Kojto 111:4336505e4b1c 131 enum status_code i2c_master_read_packet_job(
Kojto 111:4336505e4b1c 132 struct i2c_master_module *const module,
Kojto 111:4336505e4b1c 133 struct i2c_master_packet *const packet);
Kojto 111:4336505e4b1c 134
Kojto 111:4336505e4b1c 135 enum status_code i2c_master_read_packet_job_no_stop(
Kojto 111:4336505e4b1c 136 struct i2c_master_module *const module,
Kojto 111:4336505e4b1c 137 struct i2c_master_packet *const packet);
Kojto 111:4336505e4b1c 138
Kojto 111:4336505e4b1c 139 enum status_code i2c_master_read_packet_job_no_nack(
Kojto 111:4336505e4b1c 140 struct i2c_master_module *const module,
Kojto 111:4336505e4b1c 141 struct i2c_master_packet *const packet);
Kojto 111:4336505e4b1c 142
Kojto 111:4336505e4b1c 143 enum status_code i2c_master_write_bytes(
Kojto 111:4336505e4b1c 144 struct i2c_master_module *const module,
Kojto 111:4336505e4b1c 145 struct i2c_master_packet *const packet);
Kojto 111:4336505e4b1c 146
Kojto 111:4336505e4b1c 147 enum status_code i2c_master_write_packet_job(
Kojto 111:4336505e4b1c 148 struct i2c_master_module *const module,
Kojto 111:4336505e4b1c 149 struct i2c_master_packet *const packet);
Kojto 111:4336505e4b1c 150
Kojto 111:4336505e4b1c 151 enum status_code i2c_master_write_packet_job_no_stop(
Kojto 111:4336505e4b1c 152 struct i2c_master_module *const module,
Kojto 111:4336505e4b1c 153 struct i2c_master_packet *const packet);
Kojto 111:4336505e4b1c 154
Kojto 111:4336505e4b1c 155 /**
Kojto 111:4336505e4b1c 156 * \brief Cancel any currently ongoing operation
Kojto 111:4336505e4b1c 157 *
Kojto 111:4336505e4b1c 158 * Terminates the running transfer operation.
Kojto 111:4336505e4b1c 159 *
Kojto 111:4336505e4b1c 160 * \param[in,out] module Pointer to software module structure
Kojto 111:4336505e4b1c 161 */
Kojto 111:4336505e4b1c 162 static inline void i2c_master_cancel_job(
Kojto 111:4336505e4b1c 163 struct i2c_master_module *const module)
Kojto 111:4336505e4b1c 164 {
Kojto 111:4336505e4b1c 165 /* Sanity check. */
Kojto 111:4336505e4b1c 166 Assert(module);
Kojto 111:4336505e4b1c 167 Assert(module->hw);
Kojto 111:4336505e4b1c 168
Kojto 111:4336505e4b1c 169 /* Set buffer to 0. */
Kojto 111:4336505e4b1c 170 module->buffer_remaining = 0;
Kojto 111:4336505e4b1c 171 /* Update status*/
Kojto 111:4336505e4b1c 172 module->status = STATUS_ABORTED;
Kojto 111:4336505e4b1c 173 }
Kojto 111:4336505e4b1c 174
Kojto 111:4336505e4b1c 175 /**
Kojto 111:4336505e4b1c 176 * \brief Get status from ongoing job
Kojto 111:4336505e4b1c 177 *
Kojto 111:4336505e4b1c 178 * Will return the status of a transfer operation.
Kojto 111:4336505e4b1c 179 *
Kojto 111:4336505e4b1c 180 * \param[in] module Pointer to software module structure
Kojto 111:4336505e4b1c 181 *
Kojto 111:4336505e4b1c 182 * \return Last status code from transfer operation.
Kojto 111:4336505e4b1c 183 * \retval STATUS_OK No error has occurred
Kojto 111:4336505e4b1c 184 * \retval STATUS_BUSY If transfer is in progress
Kojto 111:4336505e4b1c 185 * \retval STATUS_BUSY If master module is busy
Kojto 111:4336505e4b1c 186 * \retval STATUS_ERR_DENIED If error on bus
Kojto 111:4336505e4b1c 187 * \retval STATUS_ERR_PACKET_COLLISION If arbitration is lost
Kojto 111:4336505e4b1c 188 * \retval STATUS_ERR_BAD_ADDRESS If slave is busy, or no slave
Kojto 111:4336505e4b1c 189 * acknowledged the address
Kojto 111:4336505e4b1c 190 * \retval STATUS_ERR_TIMEOUT If timeout occurred
Kojto 111:4336505e4b1c 191 * \retval STATUS_ERR_OVERFLOW If slave did not acknowledge last sent
Kojto 111:4336505e4b1c 192 * data, indicating that slave does not
Kojto 111:4336505e4b1c 193 * want more data and was not able to read
Kojto 111:4336505e4b1c 194 */
Kojto 111:4336505e4b1c 195 static inline enum status_code i2c_master_get_job_status(
Kojto 111:4336505e4b1c 196 struct i2c_master_module *const module)
Kojto 111:4336505e4b1c 197 {
Kojto 111:4336505e4b1c 198 /* Check sanity. */
Kojto 111:4336505e4b1c 199 Assert(module);
Kojto 111:4336505e4b1c 200 Assert(module->hw);
Kojto 111:4336505e4b1c 201
Kojto 111:4336505e4b1c 202 /* Return current status code. */
Kojto 111:4336505e4b1c 203 return module->status;
Kojto 111:4336505e4b1c 204 }
Kojto 111:4336505e4b1c 205
Kojto 111:4336505e4b1c 206 /** @} */
Kojto 111:4336505e4b1c 207
Kojto 111:4336505e4b1c 208 /** @} */
Kojto 111:4336505e4b1c 209
Kojto 111:4336505e4b1c 210 #ifdef __cplusplus
Kojto 111:4336505e4b1c 211 }
Kojto 111:4336505e4b1c 212 #endif
Kojto 111:4336505e4b1c 213
Kojto 111:4336505e4b1c 214 #endif /* I2C_MASTER_INTERRUPT_H_INCLUDED */