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/tc_interrupt.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_SAMD21G18A/TARGET_Atmel/TARGET_SAM_CortexM0P/drivers/tc/tc_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 TC - Timer Counter Callback 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 /*
Kojto 111:4336505e4b1c 45 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
Kojto 111:4336505e4b1c 46 */
Kojto 111:4336505e4b1c 47
Kojto 111:4336505e4b1c 48 #ifndef TC_INTERRUPT_H_INCLUDED
Kojto 111:4336505e4b1c 49 #define TC_INTERRUPT_H_INCLUDED
Kojto 111:4336505e4b1c 50
Kojto 111:4336505e4b1c 51 #include "tc.h"
Kojto 111:4336505e4b1c 52 #include <system_interrupt.h>
Kojto 111:4336505e4b1c 53
Kojto 111:4336505e4b1c 54 #ifdef __cplusplus
Kojto 111:4336505e4b1c 55 extern "C" {
Kojto 111:4336505e4b1c 56 #endif
Kojto 111:4336505e4b1c 57
Kojto 111:4336505e4b1c 58 #if !defined(__DOXYGEN__)
Kojto 111:4336505e4b1c 59 extern void *_tc_instances[TC_INST_NUM];
Kojto 111:4336505e4b1c 60
Kojto 111:4336505e4b1c 61 # define _TC_INTERRUPT_VECT_NUM(n, unused) \
Kojto 111:4336505e4b1c 62 SYSTEM_INTERRUPT_MODULE_TC##n,
Kojto 111:4336505e4b1c 63 /**
Kojto 111:4336505e4b1c 64 * \internal Get the interrupt vector for the given device instance
Kojto 111:4336505e4b1c 65 *
Kojto 111:4336505e4b1c 66 * \param[in] TC module instance number.
Kojto 111:4336505e4b1c 67 *
Kojto 111:4336505e4b1c 68 * \return Interrupt vector for of the given TC module instance.
Kojto 111:4336505e4b1c 69 */
Kojto 111:4336505e4b1c 70 static enum system_interrupt_vector _tc_interrupt_get_interrupt_vector(
Kojto 111:4336505e4b1c 71 uint32_t inst_num)
Kojto 111:4336505e4b1c 72 {
Kojto 111:4336505e4b1c 73 static uint8_t tc_interrupt_vectors[TC_INST_NUM] = {
Kojto 111:4336505e4b1c 74 #if (SAML21E) || (SAML21G)
Kojto 111:4336505e4b1c 75 SYSTEM_INTERRUPT_MODULE_TC0,
Kojto 111:4336505e4b1c 76 SYSTEM_INTERRUPT_MODULE_TC1,
Kojto 111:4336505e4b1c 77 SYSTEM_INTERRUPT_MODULE_TC4
Kojto 111:4336505e4b1c 78 #else
Kojto 111:4336505e4b1c 79 MRECURSION(TC_INST_NUM, _TC_INTERRUPT_VECT_NUM, TC_INST_MAX_ID)
Kojto 111:4336505e4b1c 80 #endif
Kojto 111:4336505e4b1c 81 };
Kojto 111:4336505e4b1c 82
Kojto 111:4336505e4b1c 83 return (enum system_interrupt_vector)tc_interrupt_vectors[inst_num];
Kojto 111:4336505e4b1c 84 }
Kojto 111:4336505e4b1c 85 #endif /* !defined(__DOXYGEN__) */
Kojto 111:4336505e4b1c 86
Kojto 111:4336505e4b1c 87 /**
Kojto 111:4336505e4b1c 88 * \name Callback Management
Kojto 111:4336505e4b1c 89 * {@
Kojto 111:4336505e4b1c 90 */
Kojto 111:4336505e4b1c 91
Kojto 111:4336505e4b1c 92 enum status_code tc_register_callback(
Kojto 111:4336505e4b1c 93 struct tc_module *const module,
Kojto 111:4336505e4b1c 94 tc_callback_t callback_func,
Kojto 111:4336505e4b1c 95 const enum tc_callback callback_type);
Kojto 111:4336505e4b1c 96
Kojto 111:4336505e4b1c 97 enum status_code tc_unregister_callback(
Kojto 111:4336505e4b1c 98 struct tc_module *const module,
Kojto 111:4336505e4b1c 99 const enum tc_callback callback_type);
Kojto 111:4336505e4b1c 100
Kojto 111:4336505e4b1c 101 /**
Kojto 111:4336505e4b1c 102 * \brief Enables callback.
Kojto 111:4336505e4b1c 103 *
Kojto 111:4336505e4b1c 104 * Enables the callback function registered by the \ref
Kojto 111:4336505e4b1c 105 * tc_register_callback. The callback function will be called from the
Kojto 111:4336505e4b1c 106 * interrupt handler when the conditions for the callback type are
Kojto 111:4336505e4b1c 107 * met. This function will also enable the appropriate interrupts.
Kojto 111:4336505e4b1c 108 *
Kojto 111:4336505e4b1c 109 * \param[in] module Pointer to TC software instance struct
Kojto 111:4336505e4b1c 110 * \param[in] callback_type Callback type given by an enum
Kojto 111:4336505e4b1c 111 */
Kojto 111:4336505e4b1c 112 static inline void tc_enable_callback(
Kojto 111:4336505e4b1c 113 struct tc_module *const module,
Kojto 111:4336505e4b1c 114 const enum tc_callback callback_type)
Kojto 111:4336505e4b1c 115 {
Kojto 111:4336505e4b1c 116 /* Sanity check arguments */
Kojto 111:4336505e4b1c 117 Assert(module);
Kojto 111:4336505e4b1c 118
Kojto 111:4336505e4b1c 119
Kojto 111:4336505e4b1c 120 /* Enable interrupts for this TC module */
Kojto 111:4336505e4b1c 121 system_interrupt_enable(_tc_interrupt_get_interrupt_vector(_tc_get_inst_index(module->hw)));
Kojto 111:4336505e4b1c 122
Kojto 111:4336505e4b1c 123 /* Enable callback */
Kojto 111:4336505e4b1c 124 if (callback_type == TC_CALLBACK_CC_CHANNEL0) {
Kojto 111:4336505e4b1c 125 module->enable_callback_mask |= TC_INTFLAG_MC(1);
Kojto 111:4336505e4b1c 126 module->hw->COUNT8.INTENSET.reg = TC_INTFLAG_MC(1);
Kojto 111:4336505e4b1c 127 } else if (callback_type == TC_CALLBACK_CC_CHANNEL1) {
Kojto 111:4336505e4b1c 128 module->enable_callback_mask |= TC_INTFLAG_MC(2);
Kojto 111:4336505e4b1c 129 module->hw->COUNT8.INTENSET.reg = TC_INTFLAG_MC(2);
Kojto 111:4336505e4b1c 130 } else {
Kojto 111:4336505e4b1c 131 module->enable_callback_mask |= (1 << callback_type);
Kojto 111:4336505e4b1c 132 module->hw->COUNT8.INTENSET.reg = (1 << callback_type);
Kojto 111:4336505e4b1c 133 }
Kojto 111:4336505e4b1c 134 }
Kojto 111:4336505e4b1c 135
Kojto 111:4336505e4b1c 136 /**
Kojto 111:4336505e4b1c 137 * \brief Disables callback.
Kojto 111:4336505e4b1c 138 *
Kojto 111:4336505e4b1c 139 * Disables the callback function registered by the \ref
Kojto 111:4336505e4b1c 140 * tc_register_callback, and the callback will not be called from the
Kojto 111:4336505e4b1c 141 * interrupt routine. The function will also disable the appropriate
Kojto 111:4336505e4b1c 142 * interrupts.
Kojto 111:4336505e4b1c 143 *
Kojto 111:4336505e4b1c 144 * \param[in] module Pointer to TC software instance struct
Kojto 111:4336505e4b1c 145 * \param[in] callback_type Callback type given by an enum
Kojto 111:4336505e4b1c 146 */
Kojto 111:4336505e4b1c 147 static inline void tc_disable_callback(
Kojto 111:4336505e4b1c 148 struct tc_module *const module,
Kojto 111:4336505e4b1c 149 const enum tc_callback callback_type)
Kojto 111:4336505e4b1c 150 {
Kojto 111:4336505e4b1c 151 /* Sanity check arguments */
Kojto 111:4336505e4b1c 152 Assert(module);
Kojto 111:4336505e4b1c 153
Kojto 111:4336505e4b1c 154 /* Disable callback */
Kojto 111:4336505e4b1c 155 if (callback_type == TC_CALLBACK_CC_CHANNEL0) {
Kojto 111:4336505e4b1c 156 module->hw->COUNT8.INTENCLR.reg = TC_INTFLAG_MC(1);
Kojto 111:4336505e4b1c 157 module->enable_callback_mask &= ~TC_INTFLAG_MC(1);
Kojto 111:4336505e4b1c 158 } else if (callback_type == TC_CALLBACK_CC_CHANNEL1) {
Kojto 111:4336505e4b1c 159 module->hw->COUNT8.INTENCLR.reg = TC_INTFLAG_MC(2);
Kojto 111:4336505e4b1c 160 module->enable_callback_mask &= ~TC_INTFLAG_MC(2);
Kojto 111:4336505e4b1c 161 } else {
Kojto 111:4336505e4b1c 162 module->hw->COUNT8.INTENCLR.reg = (1 << callback_type);
Kojto 111:4336505e4b1c 163 module->enable_callback_mask &= ~(1 << callback_type);
Kojto 111:4336505e4b1c 164 }
Kojto 111:4336505e4b1c 165 }
Kojto 111:4336505e4b1c 166
Kojto 111:4336505e4b1c 167 /**
Kojto 111:4336505e4b1c 168 * @}
Kojto 111:4336505e4b1c 169 */
Kojto 111:4336505e4b1c 170
Kojto 111:4336505e4b1c 171 #ifdef __cplusplus
Kojto 111:4336505e4b1c 172 }
Kojto 111:4336505e4b1c 173 #endif
Kojto 111:4336505e4b1c 174
Kojto 111:4336505e4b1c 175 #endif /* TC_INTERRUPT_H_INCLUDED */