ADCCC26XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2024, 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       ADCCC26XX.h
 *  @brief      ADC driver implementation for the ADC peripheral on CC26XX
 *
 *  This ADC driver implementation is designed to operate on a ADC peripheral
 *  for CC26XX.
 *
 *  Refer to @ref ADC.h for a complete description of APIs & example of use.
 *
 ******************************************************************************
 */
#ifndef ti_drivers_adc_ADCCC26XX__include
#define ti_drivers_adc_ADCCC26XX__include

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

#include <ti/drivers/ADC.h>
#include <ti/drivers/Power.h>
#include <ti/drivers/power/PowerCC26XX.h>

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/aux_adc.h)

#ifdef __cplusplus
extern "C" {
#endif

typedef enum
{
    ADCCC26XX_SAMPLING_DURATION_2P7_US  = AUXADC_SAMPLE_TIME_2P7_US,
    ADCCC26XX_SAMPLING_DURATION_5P3_US  = AUXADC_SAMPLE_TIME_5P3_US,
    ADCCC26XX_SAMPLING_DURATION_10P6_US = AUXADC_SAMPLE_TIME_10P6_US,
    ADCCC26XX_SAMPLING_DURATION_21P3_US = AUXADC_SAMPLE_TIME_21P3_US,
    ADCCC26XX_SAMPLING_DURATION_42P6_US = AUXADC_SAMPLE_TIME_42P6_US,
    ADCCC26XX_SAMPLING_DURATION_85P3_US = AUXADC_SAMPLE_TIME_85P3_US,
    ADCCC26XX_SAMPLING_DURATION_170_US  = AUXADC_SAMPLE_TIME_170_US,
    ADCCC26XX_SAMPLING_DURATION_341_US  = AUXADC_SAMPLE_TIME_341_US,
    ADCCC26XX_SAMPLING_DURATION_682_US  = AUXADC_SAMPLE_TIME_682_US,
    ADCCC26XX_SAMPLING_DURATION_1P37_MS = AUXADC_SAMPLE_TIME_1P37_MS,
    ADCCC26XX_SAMPLING_DURATION_2P73_MS = AUXADC_SAMPLE_TIME_2P73_MS,
    ADCCC26XX_SAMPLING_DURATION_5P46_MS = AUXADC_SAMPLE_TIME_5P46_MS,
    ADCCC26XX_SAMPLING_DURATION_10P9_MS = AUXADC_SAMPLE_TIME_10P9_MS
} ADCCC26XX_Sampling_Duration;

typedef enum
{
    ADCCC26XX_FIXED_REFERENCE = AUXADC_REF_FIXED,
    ADCCC26XX_VDDS_REFERENCE  = AUXADC_REF_VDDS_REL
} ADCCC26XX_Reference_Source;

typedef enum
{
    ADCCC26XX_TRIGGER_MANUAL = AUXADC_TRIGGER_MANUAL,
} ADCCC26XX_Trigger_Source;

/* ADC function table pointer */
extern const ADC_FxnTable ADCCC26XX_fxnTable;

typedef struct
{
    uint8_t adcDIO;
    uint8_t adcCompBInput;
    bool returnAdjustedVal;
    bool inputScalingEnabled;
    uint_fast32_t refVoltage;
    ADCCC26XX_Reference_Source refSource;
    ADCCC26XX_Sampling_Duration samplingDuration;
    ADCCC26XX_Trigger_Source triggerSource;
} ADCCC26XX_HWAttrs;

typedef struct
{
    bool isOpen;
    bool isProtected;
} ADCCC26XX_Object;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_adc_ADCCC26XX__include */