mbed official / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_NXP/TARGET_MCUXpresso_MCUS/TARGET_MIMXRT1050/drivers/fsl_aoi.h@187:0387e8f68319, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:40:20 2018 +0100
Revision:
187:0387e8f68319
Parent:
181:57724642e740 
mbed-dev library. Release version 163

Who changed what in which revision?

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