ComparatorLPF3LP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2023, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/* !****************************************************************************
 *  @file       ComparatorLPF3LP.h
 *  @brief      Comparator driver implementation for the Low-Power Comparator on
 *              the Low Power F3 family devices
 *
 *  This Comparator driver is meant to operate the Low-Power Comparator
 *  peripheral for Low Power F3 devices.
 *
 *  Refer to @ref Comparator.h for a complete description of APIs & example use.
 *
 *******************************************************************************
 */

#ifndef ti_drivers_comparator_ComparatorLPF3LP__include
#define ti_drivers_comparator_ComparatorLPF3LP__include

#include <stdint.h>
#include <stdbool.h>

#include <ti/drivers/Comparator.h>
#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>

/* Driverlib header files */
#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/lpcmp.h)

#ifdef __cplusplus
extern "C" {
#endif

typedef enum
{
    ComparatorLPF3LP_NEG_INPUT_VDDD = LPCMP_NEG_INPUT_VDDD,
    ComparatorLPF3LP_NEG_INPUT_VDDA = LPCMP_NEG_INPUT_VDDA,
    ComparatorLPF3LP_NEG_INPUT_A2   = LPCMP_NEG_INPUT_A2,
    ComparatorLPF3LP_NEG_INPUT_A3   = LPCMP_NEG_INPUT_A3
} ComparatorLPF3LP_NegativeInputChannel;

typedef enum
{
    ComparatorLPF3LP_POS_INPUT_A1   = LPCMP_POS_INPUT_A1,
    ComparatorLPF3LP_POS_INPUT_A2   = LPCMP_POS_INPUT_A2,
    ComparatorLPF3LP_POS_INPUT_A3   = LPCMP_POS_INPUT_A3,
    ComparatorLPF3LP_POS_INPUT_VDDA = LPCMP_POS_INPUT_VDDA
} ComparatorLPF3LP_PositiveInputChannel;

typedef enum
{
    ComparatorLPF3LP_V_DIV_PATH_NEG = LPCMP_DIVISION_PATH_N,
    ComparatorLPF3LP_V_DIV_PATH_POS = LPCMP_DIVISION_PATH_P
} ComparatorLPF3LP_VoltageDividerPath;

typedef enum
{
    ComparatorLPF3LP_V_DIV_FACTOR_1_1 = LPCMP_DIVISION_FACTOR_1_1,
    ComparatorLPF3LP_V_DIV_FACTOR_3_4 = LPCMP_DIVISION_FACTOR_3_4,
    ComparatorLPF3LP_V_DIV_FACTOR_1_2 = LPCMP_DIVISION_FACTOR_1_2,
    ComparatorLPF3LP_V_DIV_FACTOR_1_3 = LPCMP_DIVISION_FACTOR_1_3,
    ComparatorLPF3LP_V_DIV_FACTOR_1_4 = LPCMP_DIVISION_FACTOR_1_4
} ComparatorLPF3LP_VoltageDividerFactor;

typedef struct
{
    uint32_t intNum;                                            
    uint32_t intPriority;                                       
    uint32_t intMux;                                            
    ComparatorLPF3LP_PositiveInputChannel positiveInputChannel; 
    ComparatorLPF3LP_NegativeInputChannel negativeInputChannel; 
    ComparatorLPF3LP_VoltageDividerPath voltageDividerPath;     
    ComparatorLPF3LP_VoltageDividerFactor voltageDividerFactor; 
    uint8_t positiveInputPin;                                   
    uint8_t positiveInputPinMux;                                
    uint8_t negativeInputPin;                                   
    uint8_t negativeInputPinMux;                                
} ComparatorLPF3LP_HWAttrs;

typedef struct
{
    HwiP_Struct hwi;                    
    Comparator_CallBackFxn callbackFxn; 
    Comparator_Trigger trigger;         
    bool isOpen;                        
    bool isRunning;                     
} ComparatorLPF3LP_Object;

extern const Comparator_FxnTable ComparatorLPF3LP_fxnTable;

#ifdef __cplusplus
}
#endif

#endif /* COMPARATORLPF3LP_H_ */