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_slave_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_slave_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 Slave Interrupt Driver
Kojto 111:4336505e4b1c 5 *
Kojto 111:4336505e4b1c 6 * Copyright (C) 2013-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_SLAVE_INTERRUPT_H_INCLUDED
Kojto 111:4336505e4b1c 48 #define I2C_SLAVE_INTERRUPT_H_INCLUDED
Kojto 111:4336505e4b1c 49
Kojto 111:4336505e4b1c 50 #include "i2c_slave.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 Address Match Functionality
Kojto 111:4336505e4b1c 64 * @{
Kojto 111:4336505e4b1c 65 */
Kojto 111:4336505e4b1c 66
Kojto 111:4336505e4b1c 67 void i2c_slave_enable_nack_on_address(
Kojto 111:4336505e4b1c 68 struct i2c_slave_module *const module);
Kojto 111:4336505e4b1c 69 void i2c_slave_disable_nack_on_address(
Kojto 111:4336505e4b1c 70 struct i2c_slave_module *const module);
Kojto 111:4336505e4b1c 71
Kojto 111:4336505e4b1c 72 /** @} */
Kojto 111:4336505e4b1c 73
Kojto 111:4336505e4b1c 74 /**
Kojto 111:4336505e4b1c 75 * \name Callbacks
Kojto 111:4336505e4b1c 76 * @{
Kojto 111:4336505e4b1c 77 */
Kojto 111:4336505e4b1c 78 #if !defined(__DOXYGEN__)
Kojto 111:4336505e4b1c 79 void _i2c_slave_interrupt_handler(uint8_t instance);
Kojto 111:4336505e4b1c 80 #endif
Kojto 111:4336505e4b1c 81
Kojto 111:4336505e4b1c 82 void i2c_slave_register_callback(
Kojto 111:4336505e4b1c 83 struct i2c_slave_module *const module,
Kojto 111:4336505e4b1c 84 i2c_slave_callback_t callback,
Kojto 111:4336505e4b1c 85 enum i2c_slave_callback callback_type);
Kojto 111:4336505e4b1c 86
Kojto 111:4336505e4b1c 87 void i2c_slave_unregister_callback(
Kojto 111:4336505e4b1c 88 struct i2c_slave_module *const module,
Kojto 111:4336505e4b1c 89 enum i2c_slave_callback callback_type);
Kojto 111:4336505e4b1c 90
Kojto 111:4336505e4b1c 91 /**
Kojto 111:4336505e4b1c 92 * \brief Enables callback
Kojto 111:4336505e4b1c 93 *
Kojto 111:4336505e4b1c 94 * Enables the callback specified by the callback_type.
Kojto 111:4336505e4b1c 95 *
Kojto 111:4336505e4b1c 96 * \param[in,out] module Pointer to the software module struct
Kojto 111:4336505e4b1c 97 * \param[in] callback_type Callback type to enable
Kojto 111:4336505e4b1c 98 */
Kojto 111:4336505e4b1c 99 static inline void i2c_slave_enable_callback(
Kojto 111:4336505e4b1c 100 struct i2c_slave_module *const module,
Kojto 111:4336505e4b1c 101 enum i2c_slave_callback callback_type)
Kojto 111:4336505e4b1c 102 {
Kojto 111:4336505e4b1c 103 /* Sanity check */
Kojto 111:4336505e4b1c 104 Assert(module);
Kojto 111:4336505e4b1c 105 Assert(module->hw);
Kojto 111:4336505e4b1c 106
Kojto 111:4336505e4b1c 107 /* Mark callback as enabled */
Kojto 111:4336505e4b1c 108 module->enabled_callback |= (1 << callback_type);
Kojto 111:4336505e4b1c 109
Kojto 111:4336505e4b1c 110 /* Enable address callback */
Kojto 111:4336505e4b1c 111 SercomI2cs *const i2c_hw = &(module->hw->I2CS);
Kojto 111:4336505e4b1c 112 if (callback_type == I2C_SLAVE_CALLBACK_READ_REQUEST ||
Kojto 111:4336505e4b1c 113 callback_type == I2C_SLAVE_CALLBACK_WRITE_REQUEST) {
Kojto 111:4336505e4b1c 114 i2c_hw->INTENSET.reg = SERCOM_I2CS_INTFLAG_AMATCH;
Kojto 111:4336505e4b1c 115 }
Kojto 111:4336505e4b1c 116 }
Kojto 111:4336505e4b1c 117
Kojto 111:4336505e4b1c 118 /**
Kojto 111:4336505e4b1c 119 * \brief Disables callback
Kojto 111:4336505e4b1c 120 *
Kojto 111:4336505e4b1c 121 * Disables the callback specified by the callback_type.
Kojto 111:4336505e4b1c 122 *
Kojto 111:4336505e4b1c 123 * \param[in,out] module Pointer to the software module struct
Kojto 111:4336505e4b1c 124 * \param[in] callback_type Callback type to disable
Kojto 111:4336505e4b1c 125 */
Kojto 111:4336505e4b1c 126 static inline void i2c_slave_disable_callback(
Kojto 111:4336505e4b1c 127 struct i2c_slave_module *const module,
Kojto 111:4336505e4b1c 128 enum i2c_slave_callback callback_type)
Kojto 111:4336505e4b1c 129 {
Kojto 111:4336505e4b1c 130 /* Sanity check */
Kojto 111:4336505e4b1c 131 Assert(module);
Kojto 111:4336505e4b1c 132 Assert(module->hw);
Kojto 111:4336505e4b1c 133
Kojto 111:4336505e4b1c 134 /* Mark callback as disabled */
Kojto 111:4336505e4b1c 135 module->enabled_callback &= ~(1 << callback_type);
Kojto 111:4336505e4b1c 136 SercomI2cs *const i2c_hw = &(module->hw->I2CS);
Kojto 111:4336505e4b1c 137 if (callback_type == I2C_SLAVE_CALLBACK_READ_REQUEST ||
Kojto 111:4336505e4b1c 138 callback_type == I2C_SLAVE_CALLBACK_WRITE_REQUEST ||
Kojto 111:4336505e4b1c 139 module->status != STATUS_BUSY) {
Kojto 111:4336505e4b1c 140 i2c_hw->INTENCLR.reg = SERCOM_I2CS_INTFLAG_AMATCH;
Kojto 111:4336505e4b1c 141 }
Kojto 111:4336505e4b1c 142 }
Kojto 111:4336505e4b1c 143
Kojto 111:4336505e4b1c 144 /** @} */
Kojto 111:4336505e4b1c 145
Kojto 111:4336505e4b1c 146 /**
Kojto 111:4336505e4b1c 147 * \name Read and Write, Interrupt-Driven
Kojto 111:4336505e4b1c 148 * @{
Kojto 111:4336505e4b1c 149 */
Kojto 111:4336505e4b1c 150
Kojto 111:4336505e4b1c 151
Kojto 111:4336505e4b1c 152 enum status_code i2c_slave_read_packet_job(
Kojto 111:4336505e4b1c 153 struct i2c_slave_module *const module,
Kojto 111:4336505e4b1c 154 struct i2c_slave_packet *const packet);
Kojto 111:4336505e4b1c 155
Kojto 111:4336505e4b1c 156 enum status_code i2c_slave_write_packet_job(
Kojto 111:4336505e4b1c 157 struct i2c_slave_module *const module,
Kojto 111:4336505e4b1c 158 struct i2c_slave_packet *const packet);
Kojto 111:4336505e4b1c 159
Kojto 111:4336505e4b1c 160 /**
Kojto 111:4336505e4b1c 161 * \brief Cancels any currently ongoing operation
Kojto 111:4336505e4b1c 162 *
Kojto 111:4336505e4b1c 163 * Terminates the running transfer operation.
Kojto 111:4336505e4b1c 164 *
Kojto 111:4336505e4b1c 165 * \param[in,out] module Pointer to software module structure
Kojto 111:4336505e4b1c 166 */
Kojto 111:4336505e4b1c 167 static inline void i2c_slave_cancel_job(
Kojto 111:4336505e4b1c 168 struct i2c_slave_module *const module)
Kojto 111:4336505e4b1c 169 {
Kojto 111:4336505e4b1c 170 /* Sanity check. */
Kojto 111:4336505e4b1c 171 Assert(module);
Kojto 111:4336505e4b1c 172 Assert(module->hw);
Kojto 111:4336505e4b1c 173
Kojto 111:4336505e4b1c 174 /* Set buffer to 0. */
Kojto 111:4336505e4b1c 175 module->buffer_remaining = 0;
Kojto 111:4336505e4b1c 176 module->buffer_length = 0;
Kojto 111:4336505e4b1c 177 }
Kojto 111:4336505e4b1c 178
Kojto 111:4336505e4b1c 179 /**
Kojto 111:4336505e4b1c 180 * \brief Gets status of ongoing job
Kojto 111:4336505e4b1c 181 *
Kojto 111:4336505e4b1c 182 * Will return the status of the ongoing job, or the error that occurred
Kojto 111:4336505e4b1c 183 * in the last transfer operation.
Kojto 111:4336505e4b1c 184 * The status will be cleared when starting a new job.
Kojto 111:4336505e4b1c 185 *
Kojto 111:4336505e4b1c 186 * \param[in,out] module Pointer to software module structure
Kojto 111:4336505e4b1c 187 *
Kojto 111:4336505e4b1c 188 * \return Status of job.
Kojto 111:4336505e4b1c 189 * \retval STATUS_OK No error has occurred
Kojto 111:4336505e4b1c 190 * \retval STATUS_BUSY Transfer is in progress
Kojto 111:4336505e4b1c 191 * \retval STATUS_ERR_IO A collision, timeout or bus error happened in
Kojto 111:4336505e4b1c 192 * the last transfer
Kojto 111:4336505e4b1c 193 * \retval STATUS_ERR_TIMEOUT A timeout occurred
Kojto 111:4336505e4b1c 194 * \retval STATUS_ERR_OVERFLOW Data from master overflows receive buffer
Kojto 111:4336505e4b1c 195 */
Kojto 111:4336505e4b1c 196 static inline enum status_code i2c_slave_get_job_status(
Kojto 111:4336505e4b1c 197 struct i2c_slave_module *const module)
Kojto 111:4336505e4b1c 198 {
Kojto 111:4336505e4b1c 199 /* Check sanity. */
Kojto 111:4336505e4b1c 200 Assert(module);
Kojto 111:4336505e4b1c 201 Assert(module->hw);
Kojto 111:4336505e4b1c 202
Kojto 111:4336505e4b1c 203 /* Return current status code. */
Kojto 111:4336505e4b1c 204 return module->status;
Kojto 111:4336505e4b1c 205 }
Kojto 111:4336505e4b1c 206
Kojto 111:4336505e4b1c 207 /** @} */
Kojto 111:4336505e4b1c 208
Kojto 111:4336505e4b1c 209 /** @} */
Kojto 111:4336505e4b1c 210
Kojto 111:4336505e4b1c 211 #ifdef __cplusplus
Kojto 111:4336505e4b1c 212 }
Kojto 111:4336505e4b1c 213 #endif
Kojto 111:4336505e4b1c 214
Kojto 111:4336505e4b1c 215 #endif /* I2C_SLAVE_INTERRUPT_H_INCLUDED */