Sergey Solodunov / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

targets/hal/TARGET_Atmel/TARGET_SAM_CortexM0P/drivers/sercom/i2c/i2c_master_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?

UserRevisionLine numberNew 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 Master Interrupt Driver
mbed_official 15:a81a8d6c1dfe 5 *
mbed_official 15:a81a8d6c1dfe 6 * Copyright (C) 2012-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_MASTER_INTERRUPT_H_INCLUDED
mbed_official 15:a81a8d6c1dfe 48 #define I2C_MASTER_INTERRUPT_H_INCLUDED
mbed_official 15:a81a8d6c1dfe 49
mbed_official 15:a81a8d6c1dfe 50 #include "i2c_master.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 Callbacks
mbed_official 15:a81a8d6c1dfe 64 * @{
mbed_official 15:a81a8d6c1dfe 65 */
mbed_official 15:a81a8d6c1dfe 66 #if !defined(__DOXYGEN__)
mbed_official 15:a81a8d6c1dfe 67 void _i2c_master_interrupt_handler(
mbed_official 15:a81a8d6c1dfe 68 uint8_t instance);
mbed_official 15:a81a8d6c1dfe 69 #endif
mbed_official 15:a81a8d6c1dfe 70
mbed_official 15:a81a8d6c1dfe 71 void i2c_master_register_callback(
mbed_official 15:a81a8d6c1dfe 72 struct i2c_master_module *const module,
mbed_official 15:a81a8d6c1dfe 73 i2c_master_callback_t callback,
mbed_official 15:a81a8d6c1dfe 74 enum i2c_master_callback callback_type);
mbed_official 15:a81a8d6c1dfe 75
mbed_official 15:a81a8d6c1dfe 76 void i2c_master_unregister_callback(
mbed_official 15:a81a8d6c1dfe 77 struct i2c_master_module *const module,
mbed_official 15:a81a8d6c1dfe 78 enum i2c_master_callback callback_type);
mbed_official 15:a81a8d6c1dfe 79
mbed_official 15:a81a8d6c1dfe 80 /**
mbed_official 15:a81a8d6c1dfe 81 * \brief Enables callback
mbed_official 15:a81a8d6c1dfe 82 *
mbed_official 15:a81a8d6c1dfe 83 * Enables the callback specified by the callback_type.
mbed_official 15:a81a8d6c1dfe 84 *
mbed_official 15:a81a8d6c1dfe 85 * \param[in,out] module Pointer to the software module struct
mbed_official 15:a81a8d6c1dfe 86 * \param[in] callback_type Callback type to enable
mbed_official 15:a81a8d6c1dfe 87 */
mbed_official 15:a81a8d6c1dfe 88 static inline void i2c_master_enable_callback(
mbed_official 15:a81a8d6c1dfe 89 struct i2c_master_module *const module,
mbed_official 15:a81a8d6c1dfe 90 enum i2c_master_callback callback_type)
mbed_official 15:a81a8d6c1dfe 91 {
mbed_official 15:a81a8d6c1dfe 92 /* Sanity check. */
mbed_official 15:a81a8d6c1dfe 93 Assert(module);
mbed_official 15:a81a8d6c1dfe 94 Assert(module->hw);
mbed_official 15:a81a8d6c1dfe 95
mbed_official 15:a81a8d6c1dfe 96 /* Mark callback as enabled. */
mbed_official 15:a81a8d6c1dfe 97 module->enabled_callback |= (1 << callback_type);
mbed_official 15:a81a8d6c1dfe 98 }
mbed_official 15:a81a8d6c1dfe 99
mbed_official 15:a81a8d6c1dfe 100 /**
mbed_official 15:a81a8d6c1dfe 101 * \brief Disables callback
mbed_official 15:a81a8d6c1dfe 102 *
mbed_official 15:a81a8d6c1dfe 103 * Disables the callback specified by the callback_type.
mbed_official 15:a81a8d6c1dfe 104 *
mbed_official 15:a81a8d6c1dfe 105 * \param[in,out] module Pointer to the software module struct
mbed_official 15:a81a8d6c1dfe 106 * \param[in] callback_type Callback type to disable
mbed_official 15:a81a8d6c1dfe 107 */
mbed_official 15:a81a8d6c1dfe 108 static inline void i2c_master_disable_callback(
mbed_official 15:a81a8d6c1dfe 109 struct i2c_master_module *const module,
mbed_official 15:a81a8d6c1dfe 110 enum i2c_master_callback callback_type)
mbed_official 15:a81a8d6c1dfe 111 {
mbed_official 15:a81a8d6c1dfe 112 /* Sanity check. */
mbed_official 15:a81a8d6c1dfe 113 Assert(module);
mbed_official 15:a81a8d6c1dfe 114 Assert(module->hw);
mbed_official 15:a81a8d6c1dfe 115
mbed_official 15:a81a8d6c1dfe 116 /* Mark callback as disabled. */
mbed_official 15:a81a8d6c1dfe 117 module->enabled_callback &= ~(1 << callback_type);
mbed_official 15:a81a8d6c1dfe 118 }
mbed_official 15:a81a8d6c1dfe 119
mbed_official 15:a81a8d6c1dfe 120 /** @} */
mbed_official 15:a81a8d6c1dfe 121
mbed_official 15:a81a8d6c1dfe 122 /**
mbed_official 15:a81a8d6c1dfe 123 * \name Read and Write, Interrupt-Driven
mbed_official 15:a81a8d6c1dfe 124 * @{
mbed_official 15:a81a8d6c1dfe 125 */
mbed_official 15:a81a8d6c1dfe 126
mbed_official 15:a81a8d6c1dfe 127 enum status_code i2c_master_read_bytes(
mbed_official 15:a81a8d6c1dfe 128 struct i2c_master_module *const module,
mbed_official 15:a81a8d6c1dfe 129 struct i2c_master_packet *const packet);
mbed_official 15:a81a8d6c1dfe 130
mbed_official 15:a81a8d6c1dfe 131 enum status_code i2c_master_read_packet_job(
mbed_official 15:a81a8d6c1dfe 132 struct i2c_master_module *const module,
mbed_official 15:a81a8d6c1dfe 133 struct i2c_master_packet *const packet);
mbed_official 15:a81a8d6c1dfe 134
mbed_official 15:a81a8d6c1dfe 135 enum status_code i2c_master_read_packet_job_no_stop(
mbed_official 15:a81a8d6c1dfe 136 struct i2c_master_module *const module,
mbed_official 15:a81a8d6c1dfe 137 struct i2c_master_packet *const packet);
mbed_official 15:a81a8d6c1dfe 138
mbed_official 15:a81a8d6c1dfe 139 enum status_code i2c_master_read_packet_job_no_nack(
mbed_official 15:a81a8d6c1dfe 140 struct i2c_master_module *const module,
mbed_official 15:a81a8d6c1dfe 141 struct i2c_master_packet *const packet);
mbed_official 15:a81a8d6c1dfe 142
mbed_official 15:a81a8d6c1dfe 143 enum status_code i2c_master_write_bytes(
mbed_official 15:a81a8d6c1dfe 144 struct i2c_master_module *const module,
mbed_official 15:a81a8d6c1dfe 145 struct i2c_master_packet *const packet);
mbed_official 15:a81a8d6c1dfe 146
mbed_official 15:a81a8d6c1dfe 147 enum status_code i2c_master_write_packet_job(
mbed_official 15:a81a8d6c1dfe 148 struct i2c_master_module *const module,
mbed_official 15:a81a8d6c1dfe 149 struct i2c_master_packet *const packet);
mbed_official 15:a81a8d6c1dfe 150
mbed_official 15:a81a8d6c1dfe 151 enum status_code i2c_master_write_packet_job_no_stop(
mbed_official 15:a81a8d6c1dfe 152 struct i2c_master_module *const module,
mbed_official 15:a81a8d6c1dfe 153 struct i2c_master_packet *const packet);
mbed_official 15:a81a8d6c1dfe 154
mbed_official 15:a81a8d6c1dfe 155 /**
mbed_official 15:a81a8d6c1dfe 156 * \brief Cancel any currently ongoing operation
mbed_official 15:a81a8d6c1dfe 157 *
mbed_official 15:a81a8d6c1dfe 158 * Terminates the running transfer operation.
mbed_official 15:a81a8d6c1dfe 159 *
mbed_official 15:a81a8d6c1dfe 160 * \param[in,out] module Pointer to software module structure
mbed_official 15:a81a8d6c1dfe 161 */
mbed_official 15:a81a8d6c1dfe 162 static inline void i2c_master_cancel_job(
mbed_official 15:a81a8d6c1dfe 163 struct i2c_master_module *const module)
mbed_official 15:a81a8d6c1dfe 164 {
mbed_official 15:a81a8d6c1dfe 165 /* Sanity check. */
mbed_official 15:a81a8d6c1dfe 166 Assert(module);
mbed_official 15:a81a8d6c1dfe 167 Assert(module->hw);
mbed_official 15:a81a8d6c1dfe 168
mbed_official 15:a81a8d6c1dfe 169 /* Set buffer to 0. */
mbed_official 15:a81a8d6c1dfe 170 module->buffer_remaining = 0;
mbed_official 15:a81a8d6c1dfe 171 /* Update status*/
mbed_official 15:a81a8d6c1dfe 172 module->status = STATUS_ABORTED;
mbed_official 15:a81a8d6c1dfe 173 }
mbed_official 15:a81a8d6c1dfe 174
mbed_official 15:a81a8d6c1dfe 175 /**
mbed_official 15:a81a8d6c1dfe 176 * \brief Get status from ongoing job
mbed_official 15:a81a8d6c1dfe 177 *
mbed_official 15:a81a8d6c1dfe 178 * Will return the status of a transfer operation.
mbed_official 15:a81a8d6c1dfe 179 *
mbed_official 15:a81a8d6c1dfe 180 * \param[in] module Pointer to software module structure
mbed_official 15:a81a8d6c1dfe 181 *
mbed_official 15:a81a8d6c1dfe 182 * \return Last status code from transfer operation.
mbed_official 15:a81a8d6c1dfe 183 * \retval STATUS_OK No error has occurred
mbed_official 15:a81a8d6c1dfe 184 * \retval STATUS_BUSY If transfer is in progress
mbed_official 15:a81a8d6c1dfe 185 * \retval STATUS_BUSY If master module is busy
mbed_official 15:a81a8d6c1dfe 186 * \retval STATUS_ERR_DENIED If error on bus
mbed_official 15:a81a8d6c1dfe 187 * \retval STATUS_ERR_PACKET_COLLISION If arbitration is lost
mbed_official 15:a81a8d6c1dfe 188 * \retval STATUS_ERR_BAD_ADDRESS If slave is busy, or no slave
mbed_official 15:a81a8d6c1dfe 189 * acknowledged the address
mbed_official 15:a81a8d6c1dfe 190 * \retval STATUS_ERR_TIMEOUT If timeout occurred
mbed_official 15:a81a8d6c1dfe 191 * \retval STATUS_ERR_OVERFLOW If slave did not acknowledge last sent
mbed_official 15:a81a8d6c1dfe 192 * data, indicating that slave does not
mbed_official 15:a81a8d6c1dfe 193 * want more data and was not able to read
mbed_official 15:a81a8d6c1dfe 194 */
mbed_official 15:a81a8d6c1dfe 195 static inline enum status_code i2c_master_get_job_status(
mbed_official 15:a81a8d6c1dfe 196 struct i2c_master_module *const module)
mbed_official 15:a81a8d6c1dfe 197 {
mbed_official 15:a81a8d6c1dfe 198 /* Check sanity. */
mbed_official 15:a81a8d6c1dfe 199 Assert(module);
mbed_official 15:a81a8d6c1dfe 200 Assert(module->hw);
mbed_official 15:a81a8d6c1dfe 201
mbed_official 15:a81a8d6c1dfe 202 /* Return current status code. */
mbed_official 15:a81a8d6c1dfe 203 return module->status;
mbed_official 15:a81a8d6c1dfe 204 }
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 #ifdef __cplusplus
mbed_official 15:a81a8d6c1dfe 211 }
mbed_official 15:a81a8d6c1dfe 212 #endif
mbed_official 15:a81a8d6c1dfe 213
mbed_official 15:a81a8d6c1dfe 214 #endif /* I2C_MASTER_INTERRUPT_H_INCLUDED */