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

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /*
AnnaBridge 171:3a7713b1edbc 2 * The Clear BSD License
AnnaBridge 171:3a7713b1edbc 3 * Copyright (c) 2016, Freescale Semiconductor, Inc.
AnnaBridge 171:3a7713b1edbc 4 * Copyright 2016-2017 NXP
AnnaBridge 171:3a7713b1edbc 5 * All rights reserved.
AnnaBridge 171:3a7713b1edbc 6 *
AnnaBridge 171:3a7713b1edbc 7 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 171:3a7713b1edbc 8 * are permitted (subject to the limitations in the disclaimer below) provided
AnnaBridge 171:3a7713b1edbc 9 * that the following conditions are met:
AnnaBridge 171:3a7713b1edbc 10 *
AnnaBridge 171:3a7713b1edbc 11 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 171:3a7713b1edbc 12 * of conditions and the following disclaimer.
AnnaBridge 171:3a7713b1edbc 13 *
AnnaBridge 171:3a7713b1edbc 14 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 171:3a7713b1edbc 15 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 171:3a7713b1edbc 16 * other materials provided with the distribution.
AnnaBridge 171:3a7713b1edbc 17 *
AnnaBridge 171:3a7713b1edbc 18 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 171:3a7713b1edbc 19 * contributors may be used to endorse or promote products derived from this
AnnaBridge 171:3a7713b1edbc 20 * software without specific prior written permission.
AnnaBridge 171:3a7713b1edbc 21 *
AnnaBridge 171:3a7713b1edbc 22 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
AnnaBridge 171:3a7713b1edbc 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 171:3a7713b1edbc 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 171:3a7713b1edbc 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 171:3a7713b1edbc 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 171:3a7713b1edbc 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 171:3a7713b1edbc 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 171:3a7713b1edbc 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 171:3a7713b1edbc 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 171:3a7713b1edbc 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 171:3a7713b1edbc 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 171:3a7713b1edbc 33 */
AnnaBridge 171:3a7713b1edbc 34
AnnaBridge 171:3a7713b1edbc 35 #ifndef _FSL_GINT_H_
AnnaBridge 171:3a7713b1edbc 36 #define _FSL_GINT_H_
AnnaBridge 171:3a7713b1edbc 37
AnnaBridge 171:3a7713b1edbc 38 #include "fsl_common.h"
AnnaBridge 171:3a7713b1edbc 39
AnnaBridge 171:3a7713b1edbc 40 /*!
AnnaBridge 171:3a7713b1edbc 41 * @addtogroup gint_driver
AnnaBridge 171:3a7713b1edbc 42 * @{
AnnaBridge 171:3a7713b1edbc 43 */
AnnaBridge 171:3a7713b1edbc 44
AnnaBridge 171:3a7713b1edbc 45 /*! @file */
AnnaBridge 171:3a7713b1edbc 46
AnnaBridge 171:3a7713b1edbc 47 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 48 * Definitions
AnnaBridge 171:3a7713b1edbc 49 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 50
AnnaBridge 171:3a7713b1edbc 51 /*! @name Driver version */
AnnaBridge 171:3a7713b1edbc 52 /*@{*/
AnnaBridge 171:3a7713b1edbc 53 #define FSL_GINT_DRIVER_VERSION (MAKE_VERSION(2, 0, 0)) /*!< Version 2.0.0. */
AnnaBridge 171:3a7713b1edbc 54 /*@}*/
AnnaBridge 171:3a7713b1edbc 55
AnnaBridge 171:3a7713b1edbc 56 /*! @brief GINT combine inputs type */
AnnaBridge 171:3a7713b1edbc 57 typedef enum _gint_comb
AnnaBridge 171:3a7713b1edbc 58 {
AnnaBridge 171:3a7713b1edbc 59 kGINT_CombineOr = 0U, /*!< A grouped interrupt is generated when any one of the enabled inputs is active */
AnnaBridge 171:3a7713b1edbc 60 kGINT_CombineAnd = 1U /*!< A grouped interrupt is generated when all enabled inputs are active */
AnnaBridge 171:3a7713b1edbc 61 } gint_comb_t;
AnnaBridge 171:3a7713b1edbc 62
AnnaBridge 171:3a7713b1edbc 63 /*! @brief GINT trigger type */
AnnaBridge 171:3a7713b1edbc 64 typedef enum _gint_trig
AnnaBridge 171:3a7713b1edbc 65 {
AnnaBridge 171:3a7713b1edbc 66 kGINT_TrigEdge = 0U, /*!< Edge triggered based on polarity */
AnnaBridge 171:3a7713b1edbc 67 kGINT_TrigLevel = 1U /*!< Level triggered based on polarity */
AnnaBridge 171:3a7713b1edbc 68 } gint_trig_t;
AnnaBridge 171:3a7713b1edbc 69
AnnaBridge 171:3a7713b1edbc 70 /* @brief GINT port type */
AnnaBridge 171:3a7713b1edbc 71 typedef enum _gint_port
AnnaBridge 171:3a7713b1edbc 72 {
AnnaBridge 171:3a7713b1edbc 73 kGINT_Port0 = 0U,
AnnaBridge 171:3a7713b1edbc 74 kGINT_Port1 = 1U,
AnnaBridge 171:3a7713b1edbc 75 #if defined(FSL_FEATURE_GINT_PORT_COUNT) && (FSL_FEATURE_GINT_PORT_COUNT > 2U)
AnnaBridge 171:3a7713b1edbc 76 kGINT_Port2 = 2U,
AnnaBridge 171:3a7713b1edbc 77 #endif
AnnaBridge 171:3a7713b1edbc 78 #if defined(FSL_FEATURE_GINT_PORT_COUNT) && (FSL_FEATURE_GINT_PORT_COUNT > 3U)
AnnaBridge 171:3a7713b1edbc 79 kGINT_Port3 = 3U,
AnnaBridge 171:3a7713b1edbc 80 #endif
AnnaBridge 171:3a7713b1edbc 81 #if defined(FSL_FEATURE_GINT_PORT_COUNT) && (FSL_FEATURE_GINT_PORT_COUNT > 4U)
AnnaBridge 171:3a7713b1edbc 82 kGINT_Port4 = 4U,
AnnaBridge 171:3a7713b1edbc 83 #endif
AnnaBridge 171:3a7713b1edbc 84 #if defined(FSL_FEATURE_GINT_PORT_COUNT) && (FSL_FEATURE_GINT_PORT_COUNT > 5U)
AnnaBridge 171:3a7713b1edbc 85 kGINT_Port5 = 5U,
AnnaBridge 171:3a7713b1edbc 86 #endif
AnnaBridge 171:3a7713b1edbc 87 #if defined(FSL_FEATURE_GINT_PORT_COUNT) && (FSL_FEATURE_GINT_PORT_COUNT > 6U)
AnnaBridge 171:3a7713b1edbc 88 kGINT_Port6 = 6U,
AnnaBridge 171:3a7713b1edbc 89 #endif
AnnaBridge 171:3a7713b1edbc 90 #if defined(FSL_FEATURE_GINT_PORT_COUNT) && (FSL_FEATURE_GINT_PORT_COUNT > 7U)
AnnaBridge 171:3a7713b1edbc 91 kGINT_Port7 = 7U,
AnnaBridge 171:3a7713b1edbc 92 #endif
AnnaBridge 171:3a7713b1edbc 93 } gint_port_t;
AnnaBridge 171:3a7713b1edbc 94
AnnaBridge 171:3a7713b1edbc 95 /*! @brief GINT Callback function. */
AnnaBridge 171:3a7713b1edbc 96 typedef void (*gint_cb_t)(void);
AnnaBridge 171:3a7713b1edbc 97
AnnaBridge 171:3a7713b1edbc 98 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 99 * API
AnnaBridge 171:3a7713b1edbc 100 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 101
AnnaBridge 171:3a7713b1edbc 102 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 103 extern "C" {
AnnaBridge 171:3a7713b1edbc 104 #endif
AnnaBridge 171:3a7713b1edbc 105
AnnaBridge 171:3a7713b1edbc 106 /*!
AnnaBridge 171:3a7713b1edbc 107 * @brief Initialize GINT peripheral.
AnnaBridge 171:3a7713b1edbc 108
AnnaBridge 171:3a7713b1edbc 109 * This function initializes the GINT peripheral and enables the clock.
AnnaBridge 171:3a7713b1edbc 110 *
AnnaBridge 171:3a7713b1edbc 111 * @param base Base address of the GINT peripheral.
AnnaBridge 171:3a7713b1edbc 112 *
AnnaBridge 171:3a7713b1edbc 113 * @retval None.
AnnaBridge 171:3a7713b1edbc 114 */
AnnaBridge 171:3a7713b1edbc 115 void GINT_Init(GINT_Type *base);
AnnaBridge 171:3a7713b1edbc 116
AnnaBridge 171:3a7713b1edbc 117 /*!
AnnaBridge 171:3a7713b1edbc 118 * @brief Setup GINT peripheral control parameters.
AnnaBridge 171:3a7713b1edbc 119
AnnaBridge 171:3a7713b1edbc 120 * This function sets the control parameters of GINT peripheral.
AnnaBridge 171:3a7713b1edbc 121 *
AnnaBridge 171:3a7713b1edbc 122 * @param base Base address of the GINT peripheral.
AnnaBridge 171:3a7713b1edbc 123 * @param comb Controls if the enabled inputs are logically ORed or ANDed for interrupt generation.
AnnaBridge 171:3a7713b1edbc 124 * @param trig Controls if the enabled inputs are level or edge sensitive based on polarity.
AnnaBridge 171:3a7713b1edbc 125 * @param callback This function is called when configured group interrupt is generated.
AnnaBridge 171:3a7713b1edbc 126 *
AnnaBridge 171:3a7713b1edbc 127 * @retval None.
AnnaBridge 171:3a7713b1edbc 128 */
AnnaBridge 171:3a7713b1edbc 129 void GINT_SetCtrl(GINT_Type *base, gint_comb_t comb, gint_trig_t trig, gint_cb_t callback);
AnnaBridge 171:3a7713b1edbc 130
AnnaBridge 171:3a7713b1edbc 131 /*!
AnnaBridge 171:3a7713b1edbc 132 * @brief Get GINT peripheral control parameters.
AnnaBridge 171:3a7713b1edbc 133
AnnaBridge 171:3a7713b1edbc 134 * This function returns the control parameters of GINT peripheral.
AnnaBridge 171:3a7713b1edbc 135 *
AnnaBridge 171:3a7713b1edbc 136 * @param base Base address of the GINT peripheral.
AnnaBridge 171:3a7713b1edbc 137 * @param comb Pointer to store combine input value.
AnnaBridge 171:3a7713b1edbc 138 * @param trig Pointer to store trigger value.
AnnaBridge 171:3a7713b1edbc 139 * @param callback Pointer to store callback function.
AnnaBridge 171:3a7713b1edbc 140 *
AnnaBridge 171:3a7713b1edbc 141 * @retval None.
AnnaBridge 171:3a7713b1edbc 142 */
AnnaBridge 171:3a7713b1edbc 143 void GINT_GetCtrl(GINT_Type *base, gint_comb_t *comb, gint_trig_t *trig, gint_cb_t *callback);
AnnaBridge 171:3a7713b1edbc 144
AnnaBridge 171:3a7713b1edbc 145 /*!
AnnaBridge 171:3a7713b1edbc 146 * @brief Configure GINT peripheral pins.
AnnaBridge 171:3a7713b1edbc 147
AnnaBridge 171:3a7713b1edbc 148 * This function enables and controls the polarity of enabled pin(s) of a given port.
AnnaBridge 171:3a7713b1edbc 149 *
AnnaBridge 171:3a7713b1edbc 150 * @param base Base address of the GINT peripheral.
AnnaBridge 171:3a7713b1edbc 151 * @param port Port number.
AnnaBridge 171:3a7713b1edbc 152 * @param polarityMask Each bit position selects the polarity of the corresponding enabled pin.
AnnaBridge 171:3a7713b1edbc 153 * 0 = The pin is active LOW. 1 = The pin is active HIGH.
AnnaBridge 171:3a7713b1edbc 154 * @param enableMask Each bit position selects if the corresponding pin is enabled or not.
AnnaBridge 171:3a7713b1edbc 155 * 0 = The pin is disabled. 1 = The pin is enabled.
AnnaBridge 171:3a7713b1edbc 156 *
AnnaBridge 171:3a7713b1edbc 157 * @retval None.
AnnaBridge 171:3a7713b1edbc 158 */
AnnaBridge 171:3a7713b1edbc 159 void GINT_ConfigPins(GINT_Type *base, gint_port_t port, uint32_t polarityMask, uint32_t enableMask);
AnnaBridge 171:3a7713b1edbc 160
AnnaBridge 171:3a7713b1edbc 161 /*!
AnnaBridge 171:3a7713b1edbc 162 * @brief Get GINT peripheral pin configuration.
AnnaBridge 171:3a7713b1edbc 163
AnnaBridge 171:3a7713b1edbc 164 * This function returns the pin configuration of a given port.
AnnaBridge 171:3a7713b1edbc 165 *
AnnaBridge 171:3a7713b1edbc 166 * @param base Base address of the GINT peripheral.
AnnaBridge 171:3a7713b1edbc 167 * @param port Port number.
AnnaBridge 171:3a7713b1edbc 168 * @param polarityMask Pointer to store the polarity mask Each bit position indicates the polarity of the corresponding
AnnaBridge 171:3a7713b1edbc 169 enabled pin.
AnnaBridge 171:3a7713b1edbc 170 * 0 = The pin is active LOW. 1 = The pin is active HIGH.
AnnaBridge 171:3a7713b1edbc 171 * @param enableMask Pointer to store the enable mask. Each bit position indicates if the corresponding pin is enabled
AnnaBridge 171:3a7713b1edbc 172 or not.
AnnaBridge 171:3a7713b1edbc 173 * 0 = The pin is disabled. 1 = The pin is enabled.
AnnaBridge 171:3a7713b1edbc 174 *
AnnaBridge 171:3a7713b1edbc 175 * @retval None.
AnnaBridge 171:3a7713b1edbc 176 */
AnnaBridge 171:3a7713b1edbc 177 void GINT_GetConfigPins(GINT_Type *base, gint_port_t port, uint32_t *polarityMask, uint32_t *enableMask);
AnnaBridge 171:3a7713b1edbc 178
AnnaBridge 171:3a7713b1edbc 179 /*!
AnnaBridge 171:3a7713b1edbc 180 * @brief Enable callback.
AnnaBridge 171:3a7713b1edbc 181
AnnaBridge 171:3a7713b1edbc 182 * This function enables the interrupt for the selected GINT peripheral. Although the pin(s) are monitored
AnnaBridge 171:3a7713b1edbc 183 * as soon as they are enabled, the callback function is not enabled until this function is called.
AnnaBridge 171:3a7713b1edbc 184 *
AnnaBridge 171:3a7713b1edbc 185 * @param base Base address of the GINT peripheral.
AnnaBridge 171:3a7713b1edbc 186 *
AnnaBridge 171:3a7713b1edbc 187 * @retval None.
AnnaBridge 171:3a7713b1edbc 188 */
AnnaBridge 171:3a7713b1edbc 189 void GINT_EnableCallback(GINT_Type *base);
AnnaBridge 171:3a7713b1edbc 190
AnnaBridge 171:3a7713b1edbc 191 /*!
AnnaBridge 171:3a7713b1edbc 192 * @brief Disable callback.
AnnaBridge 171:3a7713b1edbc 193
AnnaBridge 171:3a7713b1edbc 194 * This function disables the interrupt for the selected GINT peripheral. Although the pins are still
AnnaBridge 171:3a7713b1edbc 195 * being monitored but the callback function is not called.
AnnaBridge 171:3a7713b1edbc 196 *
AnnaBridge 171:3a7713b1edbc 197 * @param base Base address of the peripheral.
AnnaBridge 171:3a7713b1edbc 198 *
AnnaBridge 171:3a7713b1edbc 199 * @retval None.
AnnaBridge 171:3a7713b1edbc 200 */
AnnaBridge 171:3a7713b1edbc 201 void GINT_DisableCallback(GINT_Type *base);
AnnaBridge 171:3a7713b1edbc 202
AnnaBridge 171:3a7713b1edbc 203 /*!
AnnaBridge 171:3a7713b1edbc 204 * @brief Clear GINT status.
AnnaBridge 171:3a7713b1edbc 205
AnnaBridge 171:3a7713b1edbc 206 * This function clears the GINT status bit.
AnnaBridge 171:3a7713b1edbc 207 *
AnnaBridge 171:3a7713b1edbc 208 * @param base Base address of the GINT peripheral.
AnnaBridge 171:3a7713b1edbc 209 *
AnnaBridge 171:3a7713b1edbc 210 * @retval None.
AnnaBridge 171:3a7713b1edbc 211 */
AnnaBridge 171:3a7713b1edbc 212 static inline void GINT_ClrStatus(GINT_Type *base)
AnnaBridge 171:3a7713b1edbc 213 {
AnnaBridge 171:3a7713b1edbc 214 base->CTRL |= GINT_CTRL_INT_MASK;
AnnaBridge 171:3a7713b1edbc 215 }
AnnaBridge 171:3a7713b1edbc 216
AnnaBridge 171:3a7713b1edbc 217 /*!
AnnaBridge 171:3a7713b1edbc 218 * @brief Get GINT status.
AnnaBridge 171:3a7713b1edbc 219
AnnaBridge 171:3a7713b1edbc 220 * This function returns the GINT status.
AnnaBridge 171:3a7713b1edbc 221 *
AnnaBridge 171:3a7713b1edbc 222 * @param base Base address of the GINT peripheral.
AnnaBridge 171:3a7713b1edbc 223 *
AnnaBridge 171:3a7713b1edbc 224 * @retval status = 0 No group interrupt request. = 1 Group interrupt request active.
AnnaBridge 171:3a7713b1edbc 225 */
AnnaBridge 171:3a7713b1edbc 226 static inline uint32_t GINT_GetStatus(GINT_Type *base)
AnnaBridge 171:3a7713b1edbc 227 {
AnnaBridge 171:3a7713b1edbc 228 return (base->CTRL & GINT_CTRL_INT_MASK);
AnnaBridge 171:3a7713b1edbc 229 }
AnnaBridge 171:3a7713b1edbc 230
AnnaBridge 171:3a7713b1edbc 231 /*!
AnnaBridge 171:3a7713b1edbc 232 * @brief Deinitialize GINT peripheral.
AnnaBridge 171:3a7713b1edbc 233
AnnaBridge 171:3a7713b1edbc 234 * This function disables the GINT clock.
AnnaBridge 171:3a7713b1edbc 235 *
AnnaBridge 171:3a7713b1edbc 236 * @param base Base address of the GINT peripheral.
AnnaBridge 171:3a7713b1edbc 237 *
AnnaBridge 171:3a7713b1edbc 238 * @retval None.
AnnaBridge 171:3a7713b1edbc 239 */
AnnaBridge 171:3a7713b1edbc 240 void GINT_Deinit(GINT_Type *base);
AnnaBridge 171:3a7713b1edbc 241
AnnaBridge 171:3a7713b1edbc 242 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 243 }
AnnaBridge 171:3a7713b1edbc 244 #endif
AnnaBridge 171:3a7713b1edbc 245
AnnaBridge 171:3a7713b1edbc 246 /*@}*/
AnnaBridge 171:3a7713b1edbc 247
AnnaBridge 171:3a7713b1edbc 248 #endif /* _FSL_GINT_H_ */