mbed library sources. Supersedes mbed-src.
Fork of mbed-dev by
targets/hal/TARGET_Atmel/TARGET_SAM_CortexM0P/drivers/sercom/i2c/i2c_slave_interrupt.h@15:a81a8d6c1dfe, 2015-11-04 (annotated)
- Committer:
- mbed_official
- Date:
- Wed Nov 04 16:30:11 2015 +0000
- Revision:
- 15:a81a8d6c1dfe
Synchronized with git revision 46af745ef4405614c3fa49abbd9a706a362ea514
Full URL: https://github.com/mbedmicro/mbed/commit/46af745ef4405614c3fa49abbd9a706a362ea514/
Renamed TARGET_SAM_CortexM0+ to TARGET_SAM_CortexM0P for compatiblity with online compiler
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
mbed_official | 15:a81a8d6c1dfe | 1 | /** |
mbed_official | 15:a81a8d6c1dfe | 2 | * \file |
mbed_official | 15:a81a8d6c1dfe | 3 | * |
mbed_official | 15:a81a8d6c1dfe | 4 | * \brief SAM SERCOM I2C Slave Interrupt Driver |
mbed_official | 15:a81a8d6c1dfe | 5 | * |
mbed_official | 15:a81a8d6c1dfe | 6 | * Copyright (C) 2013-2015 Atmel Corporation. All rights reserved. |
mbed_official | 15:a81a8d6c1dfe | 7 | * |
mbed_official | 15:a81a8d6c1dfe | 8 | * \asf_license_start |
mbed_official | 15:a81a8d6c1dfe | 9 | * |
mbed_official | 15:a81a8d6c1dfe | 10 | * \page License |
mbed_official | 15:a81a8d6c1dfe | 11 | * |
mbed_official | 15:a81a8d6c1dfe | 12 | * Redistribution and use in source and binary forms, with or without |
mbed_official | 15:a81a8d6c1dfe | 13 | * modification, are permitted provided that the following conditions are met: |
mbed_official | 15:a81a8d6c1dfe | 14 | * |
mbed_official | 15:a81a8d6c1dfe | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
mbed_official | 15:a81a8d6c1dfe | 16 | * this list of conditions and the following disclaimer. |
mbed_official | 15:a81a8d6c1dfe | 17 | * |
mbed_official | 15:a81a8d6c1dfe | 18 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
mbed_official | 15:a81a8d6c1dfe | 19 | * this list of conditions and the following disclaimer in the documentation |
mbed_official | 15:a81a8d6c1dfe | 20 | * and/or other materials provided with the distribution. |
mbed_official | 15:a81a8d6c1dfe | 21 | * |
mbed_official | 15:a81a8d6c1dfe | 22 | * 3. The name of Atmel may not be used to endorse or promote products derived |
mbed_official | 15:a81a8d6c1dfe | 23 | * from this software without specific prior written permission. |
mbed_official | 15:a81a8d6c1dfe | 24 | * |
mbed_official | 15:a81a8d6c1dfe | 25 | * 4. This software may only be redistributed and used in connection with an |
mbed_official | 15:a81a8d6c1dfe | 26 | * Atmel microcontroller product. |
mbed_official | 15:a81a8d6c1dfe | 27 | * |
mbed_official | 15:a81a8d6c1dfe | 28 | * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED |
mbed_official | 15:a81a8d6c1dfe | 29 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
mbed_official | 15:a81a8d6c1dfe | 30 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE |
mbed_official | 15:a81a8d6c1dfe | 31 | * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR |
mbed_official | 15:a81a8d6c1dfe | 32 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
mbed_official | 15:a81a8d6c1dfe | 33 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
mbed_official | 15:a81a8d6c1dfe | 34 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
mbed_official | 15:a81a8d6c1dfe | 35 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
mbed_official | 15:a81a8d6c1dfe | 36 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
mbed_official | 15:a81a8d6c1dfe | 37 | * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
mbed_official | 15:a81a8d6c1dfe | 38 | * POSSIBILITY OF SUCH DAMAGE. |
mbed_official | 15:a81a8d6c1dfe | 39 | * |
mbed_official | 15:a81a8d6c1dfe | 40 | * \asf_license_stop |
mbed_official | 15:a81a8d6c1dfe | 41 | * |
mbed_official | 15:a81a8d6c1dfe | 42 | */ |
mbed_official | 15:a81a8d6c1dfe | 43 | /* |
mbed_official | 15:a81a8d6c1dfe | 44 | * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a> |
mbed_official | 15:a81a8d6c1dfe | 45 | */ |
mbed_official | 15:a81a8d6c1dfe | 46 | |
mbed_official | 15:a81a8d6c1dfe | 47 | #ifndef I2C_SLAVE_INTERRUPT_H_INCLUDED |
mbed_official | 15:a81a8d6c1dfe | 48 | #define I2C_SLAVE_INTERRUPT_H_INCLUDED |
mbed_official | 15:a81a8d6c1dfe | 49 | |
mbed_official | 15:a81a8d6c1dfe | 50 | #include "i2c_slave.h" |
mbed_official | 15:a81a8d6c1dfe | 51 | |
mbed_official | 15:a81a8d6c1dfe | 52 | #ifdef __cplusplus |
mbed_official | 15:a81a8d6c1dfe | 53 | extern "C" { |
mbed_official | 15:a81a8d6c1dfe | 54 | #endif |
mbed_official | 15:a81a8d6c1dfe | 55 | |
mbed_official | 15:a81a8d6c1dfe | 56 | /** |
mbed_official | 15:a81a8d6c1dfe | 57 | * \addtogroup asfdoc_sam0_sercom_i2c_group |
mbed_official | 15:a81a8d6c1dfe | 58 | * @{ |
mbed_official | 15:a81a8d6c1dfe | 59 | * |
mbed_official | 15:a81a8d6c1dfe | 60 | */ |
mbed_official | 15:a81a8d6c1dfe | 61 | |
mbed_official | 15:a81a8d6c1dfe | 62 | /** |
mbed_official | 15:a81a8d6c1dfe | 63 | * \name Address Match Functionality |
mbed_official | 15:a81a8d6c1dfe | 64 | * @{ |
mbed_official | 15:a81a8d6c1dfe | 65 | */ |
mbed_official | 15:a81a8d6c1dfe | 66 | |
mbed_official | 15:a81a8d6c1dfe | 67 | void i2c_slave_enable_nack_on_address( |
mbed_official | 15:a81a8d6c1dfe | 68 | struct i2c_slave_module *const module); |
mbed_official | 15:a81a8d6c1dfe | 69 | void i2c_slave_disable_nack_on_address( |
mbed_official | 15:a81a8d6c1dfe | 70 | struct i2c_slave_module *const module); |
mbed_official | 15:a81a8d6c1dfe | 71 | |
mbed_official | 15:a81a8d6c1dfe | 72 | /** @} */ |
mbed_official | 15:a81a8d6c1dfe | 73 | |
mbed_official | 15:a81a8d6c1dfe | 74 | /** |
mbed_official | 15:a81a8d6c1dfe | 75 | * \name Callbacks |
mbed_official | 15:a81a8d6c1dfe | 76 | * @{ |
mbed_official | 15:a81a8d6c1dfe | 77 | */ |
mbed_official | 15:a81a8d6c1dfe | 78 | #if !defined(__DOXYGEN__) |
mbed_official | 15:a81a8d6c1dfe | 79 | void _i2c_slave_interrupt_handler(uint8_t instance); |
mbed_official | 15:a81a8d6c1dfe | 80 | #endif |
mbed_official | 15:a81a8d6c1dfe | 81 | |
mbed_official | 15:a81a8d6c1dfe | 82 | void i2c_slave_register_callback( |
mbed_official | 15:a81a8d6c1dfe | 83 | struct i2c_slave_module *const module, |
mbed_official | 15:a81a8d6c1dfe | 84 | i2c_slave_callback_t callback, |
mbed_official | 15:a81a8d6c1dfe | 85 | enum i2c_slave_callback callback_type); |
mbed_official | 15:a81a8d6c1dfe | 86 | |
mbed_official | 15:a81a8d6c1dfe | 87 | void i2c_slave_unregister_callback( |
mbed_official | 15:a81a8d6c1dfe | 88 | struct i2c_slave_module *const module, |
mbed_official | 15:a81a8d6c1dfe | 89 | enum i2c_slave_callback callback_type); |
mbed_official | 15:a81a8d6c1dfe | 90 | |
mbed_official | 15:a81a8d6c1dfe | 91 | /** |
mbed_official | 15:a81a8d6c1dfe | 92 | * \brief Enables callback |
mbed_official | 15:a81a8d6c1dfe | 93 | * |
mbed_official | 15:a81a8d6c1dfe | 94 | * Enables the callback specified by the callback_type. |
mbed_official | 15:a81a8d6c1dfe | 95 | * |
mbed_official | 15:a81a8d6c1dfe | 96 | * \param[in,out] module Pointer to the software module struct |
mbed_official | 15:a81a8d6c1dfe | 97 | * \param[in] callback_type Callback type to enable |
mbed_official | 15:a81a8d6c1dfe | 98 | */ |
mbed_official | 15:a81a8d6c1dfe | 99 | static inline void i2c_slave_enable_callback( |
mbed_official | 15:a81a8d6c1dfe | 100 | struct i2c_slave_module *const module, |
mbed_official | 15:a81a8d6c1dfe | 101 | enum i2c_slave_callback callback_type) |
mbed_official | 15:a81a8d6c1dfe | 102 | { |
mbed_official | 15:a81a8d6c1dfe | 103 | /* Sanity check */ |
mbed_official | 15:a81a8d6c1dfe | 104 | Assert(module); |
mbed_official | 15:a81a8d6c1dfe | 105 | Assert(module->hw); |
mbed_official | 15:a81a8d6c1dfe | 106 | |
mbed_official | 15:a81a8d6c1dfe | 107 | /* Mark callback as enabled */ |
mbed_official | 15:a81a8d6c1dfe | 108 | module->enabled_callback |= (1 << callback_type); |
mbed_official | 15:a81a8d6c1dfe | 109 | |
mbed_official | 15:a81a8d6c1dfe | 110 | /* Enable address callback */ |
mbed_official | 15:a81a8d6c1dfe | 111 | SercomI2cs *const i2c_hw = &(module->hw->I2CS); |
mbed_official | 15:a81a8d6c1dfe | 112 | if (callback_type == I2C_SLAVE_CALLBACK_READ_REQUEST || |
mbed_official | 15:a81a8d6c1dfe | 113 | callback_type == I2C_SLAVE_CALLBACK_WRITE_REQUEST) { |
mbed_official | 15:a81a8d6c1dfe | 114 | i2c_hw->INTENSET.reg = SERCOM_I2CS_INTFLAG_AMATCH; |
mbed_official | 15:a81a8d6c1dfe | 115 | } |
mbed_official | 15:a81a8d6c1dfe | 116 | } |
mbed_official | 15:a81a8d6c1dfe | 117 | |
mbed_official | 15:a81a8d6c1dfe | 118 | /** |
mbed_official | 15:a81a8d6c1dfe | 119 | * \brief Disables callback |
mbed_official | 15:a81a8d6c1dfe | 120 | * |
mbed_official | 15:a81a8d6c1dfe | 121 | * Disables the callback specified by the callback_type. |
mbed_official | 15:a81a8d6c1dfe | 122 | * |
mbed_official | 15:a81a8d6c1dfe | 123 | * \param[in,out] module Pointer to the software module struct |
mbed_official | 15:a81a8d6c1dfe | 124 | * \param[in] callback_type Callback type to disable |
mbed_official | 15:a81a8d6c1dfe | 125 | */ |
mbed_official | 15:a81a8d6c1dfe | 126 | static inline void i2c_slave_disable_callback( |
mbed_official | 15:a81a8d6c1dfe | 127 | struct i2c_slave_module *const module, |
mbed_official | 15:a81a8d6c1dfe | 128 | enum i2c_slave_callback callback_type) |
mbed_official | 15:a81a8d6c1dfe | 129 | { |
mbed_official | 15:a81a8d6c1dfe | 130 | /* Sanity check */ |
mbed_official | 15:a81a8d6c1dfe | 131 | Assert(module); |
mbed_official | 15:a81a8d6c1dfe | 132 | Assert(module->hw); |
mbed_official | 15:a81a8d6c1dfe | 133 | |
mbed_official | 15:a81a8d6c1dfe | 134 | /* Mark callback as disabled */ |
mbed_official | 15:a81a8d6c1dfe | 135 | module->enabled_callback &= ~(1 << callback_type); |
mbed_official | 15:a81a8d6c1dfe | 136 | SercomI2cs *const i2c_hw = &(module->hw->I2CS); |
mbed_official | 15:a81a8d6c1dfe | 137 | if (callback_type == I2C_SLAVE_CALLBACK_READ_REQUEST || |
mbed_official | 15:a81a8d6c1dfe | 138 | callback_type == I2C_SLAVE_CALLBACK_WRITE_REQUEST || |
mbed_official | 15:a81a8d6c1dfe | 139 | module->status != STATUS_BUSY) { |
mbed_official | 15:a81a8d6c1dfe | 140 | i2c_hw->INTENCLR.reg = SERCOM_I2CS_INTFLAG_AMATCH; |
mbed_official | 15:a81a8d6c1dfe | 141 | } |
mbed_official | 15:a81a8d6c1dfe | 142 | } |
mbed_official | 15:a81a8d6c1dfe | 143 | |
mbed_official | 15:a81a8d6c1dfe | 144 | /** @} */ |
mbed_official | 15:a81a8d6c1dfe | 145 | |
mbed_official | 15:a81a8d6c1dfe | 146 | /** |
mbed_official | 15:a81a8d6c1dfe | 147 | * \name Read and Write, Interrupt-Driven |
mbed_official | 15:a81a8d6c1dfe | 148 | * @{ |
mbed_official | 15:a81a8d6c1dfe | 149 | */ |
mbed_official | 15:a81a8d6c1dfe | 150 | |
mbed_official | 15:a81a8d6c1dfe | 151 | |
mbed_official | 15:a81a8d6c1dfe | 152 | enum status_code i2c_slave_read_packet_job( |
mbed_official | 15:a81a8d6c1dfe | 153 | struct i2c_slave_module *const module, |
mbed_official | 15:a81a8d6c1dfe | 154 | struct i2c_slave_packet *const packet); |
mbed_official | 15:a81a8d6c1dfe | 155 | |
mbed_official | 15:a81a8d6c1dfe | 156 | enum status_code i2c_slave_write_packet_job( |
mbed_official | 15:a81a8d6c1dfe | 157 | struct i2c_slave_module *const module, |
mbed_official | 15:a81a8d6c1dfe | 158 | struct i2c_slave_packet *const packet); |
mbed_official | 15:a81a8d6c1dfe | 159 | |
mbed_official | 15:a81a8d6c1dfe | 160 | /** |
mbed_official | 15:a81a8d6c1dfe | 161 | * \brief Cancels any currently ongoing operation |
mbed_official | 15:a81a8d6c1dfe | 162 | * |
mbed_official | 15:a81a8d6c1dfe | 163 | * Terminates the running transfer operation. |
mbed_official | 15:a81a8d6c1dfe | 164 | * |
mbed_official | 15:a81a8d6c1dfe | 165 | * \param[in,out] module Pointer to software module structure |
mbed_official | 15:a81a8d6c1dfe | 166 | */ |
mbed_official | 15:a81a8d6c1dfe | 167 | static inline void i2c_slave_cancel_job( |
mbed_official | 15:a81a8d6c1dfe | 168 | struct i2c_slave_module *const module) |
mbed_official | 15:a81a8d6c1dfe | 169 | { |
mbed_official | 15:a81a8d6c1dfe | 170 | /* Sanity check. */ |
mbed_official | 15:a81a8d6c1dfe | 171 | Assert(module); |
mbed_official | 15:a81a8d6c1dfe | 172 | Assert(module->hw); |
mbed_official | 15:a81a8d6c1dfe | 173 | |
mbed_official | 15:a81a8d6c1dfe | 174 | /* Set buffer to 0. */ |
mbed_official | 15:a81a8d6c1dfe | 175 | module->buffer_remaining = 0; |
mbed_official | 15:a81a8d6c1dfe | 176 | module->buffer_length = 0; |
mbed_official | 15:a81a8d6c1dfe | 177 | } |
mbed_official | 15:a81a8d6c1dfe | 178 | |
mbed_official | 15:a81a8d6c1dfe | 179 | /** |
mbed_official | 15:a81a8d6c1dfe | 180 | * \brief Gets status of ongoing job |
mbed_official | 15:a81a8d6c1dfe | 181 | * |
mbed_official | 15:a81a8d6c1dfe | 182 | * Will return the status of the ongoing job, or the error that occurred |
mbed_official | 15:a81a8d6c1dfe | 183 | * in the last transfer operation. |
mbed_official | 15:a81a8d6c1dfe | 184 | * The status will be cleared when starting a new job. |
mbed_official | 15:a81a8d6c1dfe | 185 | * |
mbed_official | 15:a81a8d6c1dfe | 186 | * \param[in,out] module Pointer to software module structure |
mbed_official | 15:a81a8d6c1dfe | 187 | * |
mbed_official | 15:a81a8d6c1dfe | 188 | * \return Status of job. |
mbed_official | 15:a81a8d6c1dfe | 189 | * \retval STATUS_OK No error has occurred |
mbed_official | 15:a81a8d6c1dfe | 190 | * \retval STATUS_BUSY Transfer is in progress |
mbed_official | 15:a81a8d6c1dfe | 191 | * \retval STATUS_ERR_IO A collision, timeout or bus error happened in |
mbed_official | 15:a81a8d6c1dfe | 192 | * the last transfer |
mbed_official | 15:a81a8d6c1dfe | 193 | * \retval STATUS_ERR_TIMEOUT A timeout occurred |
mbed_official | 15:a81a8d6c1dfe | 194 | * \retval STATUS_ERR_OVERFLOW Data from master overflows receive buffer |
mbed_official | 15:a81a8d6c1dfe | 195 | */ |
mbed_official | 15:a81a8d6c1dfe | 196 | static inline enum status_code i2c_slave_get_job_status( |
mbed_official | 15:a81a8d6c1dfe | 197 | struct i2c_slave_module *const module) |
mbed_official | 15:a81a8d6c1dfe | 198 | { |
mbed_official | 15:a81a8d6c1dfe | 199 | /* Check sanity. */ |
mbed_official | 15:a81a8d6c1dfe | 200 | Assert(module); |
mbed_official | 15:a81a8d6c1dfe | 201 | Assert(module->hw); |
mbed_official | 15:a81a8d6c1dfe | 202 | |
mbed_official | 15:a81a8d6c1dfe | 203 | /* Return current status code. */ |
mbed_official | 15:a81a8d6c1dfe | 204 | return module->status; |
mbed_official | 15:a81a8d6c1dfe | 205 | } |
mbed_official | 15:a81a8d6c1dfe | 206 | |
mbed_official | 15:a81a8d6c1dfe | 207 | /** @} */ |
mbed_official | 15:a81a8d6c1dfe | 208 | |
mbed_official | 15:a81a8d6c1dfe | 209 | /** @} */ |
mbed_official | 15:a81a8d6c1dfe | 210 | |
mbed_official | 15:a81a8d6c1dfe | 211 | #ifdef __cplusplus |
mbed_official | 15:a81a8d6c1dfe | 212 | } |
mbed_official | 15:a81a8d6c1dfe | 213 | #endif |
mbed_official | 15:a81a8d6c1dfe | 214 | |
mbed_official | 15:a81a8d6c1dfe | 215 | #endif /* I2C_SLAVE_INTERRUPT_H_INCLUDED */ |