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_MIMXRT1050_EVK/TOOLCHAIN_IAR/fsl_aoi.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 161:aa5281ff4a02 1 /*
AnnaBridge 170:e95d10626187 2 * The Clear BSD License
AnnaBridge 161:aa5281ff4a02 3 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 161:aa5281ff4a02 4 * Copyright 2016-2017 NXP
AnnaBridge 170:e95d10626187 5 * All rights reserved.
AnnaBridge 170:e95d10626187 6 *
AnnaBridge 161:aa5281ff4a02 7 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 170:e95d10626187 8 * are permitted (subject to the limitations in the disclaimer below) provided
AnnaBridge 170:e95d10626187 9 * that the following conditions are met:
AnnaBridge 161:aa5281ff4a02 10 *
AnnaBridge 161:aa5281ff4a02 11 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 161:aa5281ff4a02 12 * of conditions and the following disclaimer.
AnnaBridge 161:aa5281ff4a02 13 *
AnnaBridge 161:aa5281ff4a02 14 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 161:aa5281ff4a02 15 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 161:aa5281ff4a02 16 * other materials provided with the distribution.
AnnaBridge 161:aa5281ff4a02 17 *
AnnaBridge 161:aa5281ff4a02 18 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 161:aa5281ff4a02 19 * contributors may be used to endorse or promote products derived from this
AnnaBridge 161:aa5281ff4a02 20 * software without specific prior written permission.
AnnaBridge 161:aa5281ff4a02 21 *
AnnaBridge 170:e95d10626187 22 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
AnnaBridge 161:aa5281ff4a02 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 161:aa5281ff4a02 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 161:aa5281ff4a02 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 161:aa5281ff4a02 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 161:aa5281ff4a02 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 161:aa5281ff4a02 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 161:aa5281ff4a02 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 161:aa5281ff4a02 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 161:aa5281ff4a02 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 161:aa5281ff4a02 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 161:aa5281ff4a02 33 */
AnnaBridge 161:aa5281ff4a02 34 #ifndef _FSL_AOI_H_
AnnaBridge 161:aa5281ff4a02 35 #define _FSL_AOI_H_
AnnaBridge 161:aa5281ff4a02 36
AnnaBridge 161:aa5281ff4a02 37 #include "fsl_common.h"
AnnaBridge 161:aa5281ff4a02 38
AnnaBridge 161:aa5281ff4a02 39 /*!
AnnaBridge 161:aa5281ff4a02 40 * @addtogroup aoi
AnnaBridge 161:aa5281ff4a02 41 * @{
AnnaBridge 161:aa5281ff4a02 42 */
AnnaBridge 161:aa5281ff4a02 43
AnnaBridge 161:aa5281ff4a02 44
AnnaBridge 161:aa5281ff4a02 45 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 46 * Definitions
AnnaBridge 161:aa5281ff4a02 47 ******************************************************************************/
AnnaBridge 161:aa5281ff4a02 48 #ifndef AOI
AnnaBridge 161:aa5281ff4a02 49 #define AOI AOI0 /*!< AOI peripheral address */
AnnaBridge 161:aa5281ff4a02 50 #endif
AnnaBridge 161:aa5281ff4a02 51
AnnaBridge 161:aa5281ff4a02 52 /*! @name Driver version */
AnnaBridge 161:aa5281ff4a02 53 /*@{*/
AnnaBridge 161:aa5281ff4a02 54 #define FSL_AOI_DRIVER_VERSION (MAKE_VERSION(2, 0, 0)) /*!< Version 2.0.0. */
AnnaBridge 161:aa5281ff4a02 55 /*@}*/
AnnaBridge 161:aa5281ff4a02 56
AnnaBridge 161:aa5281ff4a02 57 /*!
AnnaBridge 161:aa5281ff4a02 58 * @brief AOI input configurations.
AnnaBridge 161:aa5281ff4a02 59 *
AnnaBridge 161:aa5281ff4a02 60 * The selection item represents the Boolean evaluations.
AnnaBridge 161:aa5281ff4a02 61 */
AnnaBridge 161:aa5281ff4a02 62 typedef enum _aoi_input_config
AnnaBridge 161:aa5281ff4a02 63 {
AnnaBridge 161:aa5281ff4a02 64 kAOI_LogicZero = 0x0U, /*!< Forces the input to logical zero. */
AnnaBridge 161:aa5281ff4a02 65 kAOI_InputSignal = 0x1U, /*!< Passes the input signal. */
AnnaBridge 161:aa5281ff4a02 66 kAOI_InvInputSignal = 0x2U, /*!< Inverts the input signal. */
AnnaBridge 161:aa5281ff4a02 67 kAOI_LogicOne = 0x3U /*!< Forces the input to logical one. */
AnnaBridge 161:aa5281ff4a02 68 } aoi_input_config_t;
AnnaBridge 161:aa5281ff4a02 69
AnnaBridge 161:aa5281ff4a02 70 /*!
AnnaBridge 161:aa5281ff4a02 71 * @brief AOI event indexes, where an event is the collection of the four product
AnnaBridge 161:aa5281ff4a02 72 * terms (0, 1, 2, and 3) and the four signal inputs (A, B, C, and D).
AnnaBridge 161:aa5281ff4a02 73 */
AnnaBridge 161:aa5281ff4a02 74 typedef enum _aoi_event
AnnaBridge 161:aa5281ff4a02 75 {
AnnaBridge 161:aa5281ff4a02 76 kAOI_Event0 = 0x0U, /*!< Event 0 index */
AnnaBridge 161:aa5281ff4a02 77 kAOI_Event1 = 0x1U, /*!< Event 1 index */
AnnaBridge 161:aa5281ff4a02 78 kAOI_Event2 = 0x2U, /*!< Event 2 index */
AnnaBridge 161:aa5281ff4a02 79 kAOI_Event3 = 0x3U /*!< Event 3 index */
AnnaBridge 161:aa5281ff4a02 80 } aoi_event_t;
AnnaBridge 161:aa5281ff4a02 81
AnnaBridge 161:aa5281ff4a02 82 /*!
AnnaBridge 161:aa5281ff4a02 83 * @brief AOI event configuration structure
AnnaBridge 161:aa5281ff4a02 84 *
AnnaBridge 161:aa5281ff4a02 85 * Defines structure _aoi_event_config and use the AOI_SetEventLogicConfig() function to make
AnnaBridge 161:aa5281ff4a02 86 * whole event configuration.
AnnaBridge 161:aa5281ff4a02 87 */
AnnaBridge 161:aa5281ff4a02 88 typedef struct _aoi_event_config
AnnaBridge 161:aa5281ff4a02 89 {
AnnaBridge 161:aa5281ff4a02 90 aoi_input_config_t PT0AC; /*!< Product term 0 input A */
AnnaBridge 161:aa5281ff4a02 91 aoi_input_config_t PT0BC; /*!< Product term 0 input B */
AnnaBridge 161:aa5281ff4a02 92 aoi_input_config_t PT0CC; /*!< Product term 0 input C */
AnnaBridge 161:aa5281ff4a02 93 aoi_input_config_t PT0DC; /*!< Product term 0 input D */
AnnaBridge 161:aa5281ff4a02 94 aoi_input_config_t PT1AC; /*!< Product term 1 input A */
AnnaBridge 161:aa5281ff4a02 95 aoi_input_config_t PT1BC; /*!< Product term 1 input B */
AnnaBridge 161:aa5281ff4a02 96 aoi_input_config_t PT1CC; /*!< Product term 1 input C */
AnnaBridge 161:aa5281ff4a02 97 aoi_input_config_t PT1DC; /*!< Product term 1 input D */
AnnaBridge 161:aa5281ff4a02 98 aoi_input_config_t PT2AC; /*!< Product term 2 input A */
AnnaBridge 161:aa5281ff4a02 99 aoi_input_config_t PT2BC; /*!< Product term 2 input B */
AnnaBridge 161:aa5281ff4a02 100 aoi_input_config_t PT2CC; /*!< Product term 2 input C */
AnnaBridge 161:aa5281ff4a02 101 aoi_input_config_t PT2DC; /*!< Product term 2 input D */
AnnaBridge 161:aa5281ff4a02 102 aoi_input_config_t PT3AC; /*!< Product term 3 input A */
AnnaBridge 161:aa5281ff4a02 103 aoi_input_config_t PT3BC; /*!< Product term 3 input B */
AnnaBridge 161:aa5281ff4a02 104 aoi_input_config_t PT3CC; /*!< Product term 3 input C */
AnnaBridge 161:aa5281ff4a02 105 aoi_input_config_t PT3DC; /*!< Product term 3 input D */
AnnaBridge 161:aa5281ff4a02 106 } aoi_event_config_t;
AnnaBridge 161:aa5281ff4a02 107
AnnaBridge 161:aa5281ff4a02 108 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 109 * API
AnnaBridge 161:aa5281ff4a02 110 ******************************************************************************/
AnnaBridge 161:aa5281ff4a02 111
AnnaBridge 161:aa5281ff4a02 112 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 113 extern "C" {
AnnaBridge 161:aa5281ff4a02 114 #endif /* __cplusplus*/
AnnaBridge 161:aa5281ff4a02 115
AnnaBridge 161:aa5281ff4a02 116 /*!
AnnaBridge 161:aa5281ff4a02 117 * @name AOI Initialization
AnnaBridge 161:aa5281ff4a02 118 * @{
AnnaBridge 161:aa5281ff4a02 119 */
AnnaBridge 161:aa5281ff4a02 120
AnnaBridge 161:aa5281ff4a02 121 /*!
AnnaBridge 161:aa5281ff4a02 122 * @brief Initializes an AOI instance for operation.
AnnaBridge 161:aa5281ff4a02 123 *
AnnaBridge 161:aa5281ff4a02 124 * This function un-gates the AOI clock.
AnnaBridge 161:aa5281ff4a02 125 *
AnnaBridge 161:aa5281ff4a02 126 * @param base AOI peripheral address.
AnnaBridge 161:aa5281ff4a02 127 */
AnnaBridge 161:aa5281ff4a02 128 void AOI_Init(AOI_Type *base);
AnnaBridge 161:aa5281ff4a02 129
AnnaBridge 161:aa5281ff4a02 130 /*!
AnnaBridge 161:aa5281ff4a02 131 * @brief Deinitializes an AOI instance for operation.
AnnaBridge 161:aa5281ff4a02 132 *
AnnaBridge 161:aa5281ff4a02 133 * This function shutdowns AOI module.
AnnaBridge 161:aa5281ff4a02 134 *
AnnaBridge 161:aa5281ff4a02 135 * @param base AOI peripheral address.
AnnaBridge 161:aa5281ff4a02 136 */
AnnaBridge 161:aa5281ff4a02 137 void AOI_Deinit(AOI_Type *base);
AnnaBridge 161:aa5281ff4a02 138
AnnaBridge 161:aa5281ff4a02 139 /*@}*/
AnnaBridge 161:aa5281ff4a02 140
AnnaBridge 161:aa5281ff4a02 141 /*!
AnnaBridge 161:aa5281ff4a02 142 * @name AOI Get Set Operation
AnnaBridge 161:aa5281ff4a02 143 * @{
AnnaBridge 161:aa5281ff4a02 144 */
AnnaBridge 161:aa5281ff4a02 145
AnnaBridge 161:aa5281ff4a02 146 /*!
AnnaBridge 161:aa5281ff4a02 147 * @brief Gets the Boolean evaluation associated.
AnnaBridge 161:aa5281ff4a02 148 *
AnnaBridge 161:aa5281ff4a02 149 * This function returns the Boolean evaluation associated.
AnnaBridge 161:aa5281ff4a02 150 *
AnnaBridge 161:aa5281ff4a02 151 * Example:
AnnaBridge 161:aa5281ff4a02 152 @code
AnnaBridge 161:aa5281ff4a02 153 aoi_event_config_t demoEventLogicStruct;
AnnaBridge 161:aa5281ff4a02 154
AnnaBridge 161:aa5281ff4a02 155 AOI_GetEventLogicConfig(AOI, kAOI_Event0, &demoEventLogicStruct);
AnnaBridge 161:aa5281ff4a02 156 @endcode
AnnaBridge 161:aa5281ff4a02 157 *
AnnaBridge 161:aa5281ff4a02 158 * @param base AOI peripheral address.
AnnaBridge 161:aa5281ff4a02 159 * @param event Index of the event which will be set of type aoi_event_t.
AnnaBridge 161:aa5281ff4a02 160 * @param config Selected input configuration .
AnnaBridge 161:aa5281ff4a02 161 */
AnnaBridge 161:aa5281ff4a02 162 void AOI_GetEventLogicConfig(AOI_Type *base, aoi_event_t event, aoi_event_config_t *config);
AnnaBridge 161:aa5281ff4a02 163
AnnaBridge 161:aa5281ff4a02 164 /*!
AnnaBridge 161:aa5281ff4a02 165 * @brief Configures an AOI event.
AnnaBridge 161:aa5281ff4a02 166 *
AnnaBridge 161:aa5281ff4a02 167 * This function configures an AOI event according
AnnaBridge 161:aa5281ff4a02 168 * to the aoiEventConfig structure. This function configures all inputs (A, B, C, and D)
AnnaBridge 161:aa5281ff4a02 169 * of all product terms (0, 1, 2, and 3) of a desired event.
AnnaBridge 161:aa5281ff4a02 170 *
AnnaBridge 161:aa5281ff4a02 171 * Example:
AnnaBridge 161:aa5281ff4a02 172 @code
AnnaBridge 161:aa5281ff4a02 173 aoi_event_config_t demoEventLogicStruct;
AnnaBridge 161:aa5281ff4a02 174
AnnaBridge 161:aa5281ff4a02 175 demoEventLogicStruct.PT0AC = kAOI_InvInputSignal;
AnnaBridge 161:aa5281ff4a02 176 demoEventLogicStruct.PT0BC = kAOI_InputSignal;
AnnaBridge 161:aa5281ff4a02 177 demoEventLogicStruct.PT0CC = kAOI_LogicOne;
AnnaBridge 161:aa5281ff4a02 178 demoEventLogicStruct.PT0DC = kAOI_LogicOne;
AnnaBridge 161:aa5281ff4a02 179
AnnaBridge 161:aa5281ff4a02 180 demoEventLogicStruct.PT1AC = kAOI_LogicZero;
AnnaBridge 161:aa5281ff4a02 181 demoEventLogicStruct.PT1BC = kAOI_LogicOne;
AnnaBridge 161:aa5281ff4a02 182 demoEventLogicStruct.PT1CC = kAOI_LogicOne;
AnnaBridge 161:aa5281ff4a02 183 demoEventLogicStruct.PT1DC = kAOI_LogicOne;
AnnaBridge 161:aa5281ff4a02 184
AnnaBridge 161:aa5281ff4a02 185 demoEventLogicStruct.PT2AC = kAOI_LogicZero;
AnnaBridge 161:aa5281ff4a02 186 demoEventLogicStruct.PT2BC = kAOI_LogicOne;
AnnaBridge 161:aa5281ff4a02 187 demoEventLogicStruct.PT2CC = kAOI_LogicOne;
AnnaBridge 161:aa5281ff4a02 188 demoEventLogicStruct.PT2DC = kAOI_LogicOne;
AnnaBridge 161:aa5281ff4a02 189
AnnaBridge 161:aa5281ff4a02 190 demoEventLogicStruct.PT3AC = kAOI_LogicZero;
AnnaBridge 161:aa5281ff4a02 191 demoEventLogicStruct.PT3BC = kAOI_LogicOne;
AnnaBridge 161:aa5281ff4a02 192 demoEventLogicStruct.PT3CC = kAOI_LogicOne;
AnnaBridge 161:aa5281ff4a02 193 demoEventLogicStruct.PT3DC = kAOI_LogicOne;
AnnaBridge 161:aa5281ff4a02 194
AnnaBridge 161:aa5281ff4a02 195 AOI_SetEventLogicConfig(AOI, kAOI_Event0, demoEventLogicStruct);
AnnaBridge 161:aa5281ff4a02 196 @endcode
AnnaBridge 161:aa5281ff4a02 197 *
AnnaBridge 161:aa5281ff4a02 198 * @param base AOI peripheral address.
AnnaBridge 161:aa5281ff4a02 199 * @param event Event which will be configured of type aoi_event_t.
AnnaBridge 161:aa5281ff4a02 200 * @param eventConfig Pointer to type aoi_event_config_t structure. The user is responsible for
AnnaBridge 161:aa5281ff4a02 201 * filling out the members of this structure and passing the pointer to this function.
AnnaBridge 161:aa5281ff4a02 202 */
AnnaBridge 161:aa5281ff4a02 203 void AOI_SetEventLogicConfig(AOI_Type *base, aoi_event_t event, const aoi_event_config_t *eventConfig);
AnnaBridge 161:aa5281ff4a02 204
AnnaBridge 161:aa5281ff4a02 205 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 206 }
AnnaBridge 161:aa5281ff4a02 207 #endif /* __cplusplus*/
AnnaBridge 161:aa5281ff4a02 208
AnnaBridge 161:aa5281ff4a02 209 /*@}*/
AnnaBridge 161:aa5281ff4a02 210
AnnaBridge 161:aa5281ff4a02 211 /*!* @} */
AnnaBridge 161:aa5281ff4a02 212
AnnaBridge 161:aa5281ff4a02 213 #endif /* _FSL_AOI_H_*/