adc.h

 
/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
/* Define to prevent redundant inclusion */
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX78002_ADC_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX78002_ADC_H_
 
/* **** Includes **** */
#include <stdint.h>
#include "adc_regs.h"
#include "mcr_regs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* MAX78002 Specific TODO */
#define MAX_ADC_SLOT_NUM 20
#define MAX_ADC_FIFO_LEN 16
#define MAX_ADC_RES_DIV_CH 8
 
/***************************************************************************************************************
                                    DATA STRUCTURES FOR ADC INITIALIZATION
***************************************************************************************************************/
 
typedef enum {
    MXC_ADC_CH_0, 
    MXC_ADC_CH_1, 
    MXC_ADC_CH_2, 
    MXC_ADC_CH_3, 
    MXC_ADC_CH_4, 
    MXC_ADC_CH_5, 
    MXC_ADC_CH_6, 
    MXC_ADC_CH_7, 
    MXC_ADC_CH_VCOREA, 
    MXC_ADC_CH_VCOREB, 
    MXC_ADC_CH_VLDO_2P5_DIV4, 
    MXC_ADC_CH_VLDO_0P9, 
    MXC_ADC_CH_VDDA_DIV2, 
    MXC_ADC_CH_TEMP_SENSOR, 
    MXC_ADC_CH_VBB_DIV4, 
    MXC_ADC_CH_VDDB_DIV4, 
    MXC_ADC_CH_VSS, 
} mxc_adc_chsel_t;
 
// AI87-TODO: Github comment the below enum out - ?
typedef enum {
    MXC_ADC_AVG_1 = MXC_S_ADC_CTRL1_AVG_AVG1, 
    MXC_ADC_AVG_2 = MXC_S_ADC_CTRL1_AVG_AVG2, 
    MXC_ADC_AVG_4 = MXC_S_ADC_CTRL1_AVG_AVG4, 
    MXC_ADC_AVG_8 = MXC_S_ADC_CTRL1_AVG_AVG8, 
    MXC_ADC_AVG_16 = MXC_S_ADC_CTRL1_AVG_AVG16, 
    MXC_ADC_AVG_32 = MXC_S_ADC_CTRL1_AVG_AVG32, 
} mxc_adc_avg_t;
 
typedef enum {
    MXC_ADC_COMP_0 = 1,
    MXC_ADC_COMP_1 = 2,
    // MXC_ADC_COMP_HYST_0  = 1 << MXC_F_MCR_AINCOMP_AINCOMPHYST_POS,    //Refer to the V HYST specification in the data sheet electrical characteristics
    // // for the values corresponding to this field value.
    // MXC_ADC_COMP_HYST_1     = 2 << MXC_F_MCR_AINCOMP_AINCOMPHYST_POS,   //Refer to the V HYST specification in the data sheet electrical characteristics
    // for the values corresponding to this field value.
} mxc_adc_comp_t;
 
typedef enum {
    MXC_ADC_CLKDIV_2, 
    MXC_ADC_CLKDIV_4, 
    MXC_ADC_CLKDIV_8, 
    MXC_ADC_CLKDIV_16, 
    MXC_ADC_CLKDIV_1, 
} mxc_adc_clkdiv_t;
 
typedef enum {
    MXC_ADC_CLK_HCLK, 
    MXC_ADC_CLK_EXT, 
    MXC_ADC_CLK_IBRO, 
    MXC_ADC_CLK_ERFO, 
} mxc_adc_clock_t;
 
typedef enum {
    MXC_ADC_SKIP_CAL, 
    MXC_ADC_EN_CAL, 
} mxc_adc_calibration_t;
 
typedef enum {
    MXC_ADC_TRIG_SOFTWARE, 
    MXC_ADC_TRIG_HARDWARE, 
} mxc_adc_trig_mode_t;
 
typedef enum {
    MXC_ADC_TRIG_SEL_TMR0, 
    MXC_ADC_TRIG_SEL_TMR1, 
    MXC_ADC_TRIG_SEL_TMR2, 
    MXC_ADC_TRIG_SEL_TMR3, 
    MXC_ADC_TRIG_SEL_P1_12, 
    MXC_ADC_TRIG_SEL_P1_13, 
    MXC_ADC_TRIG_SEL_P1_14, 
    MXC_ADC_TRIG_SEL_TEMP_SENS, 
} mxc_adc_trig_sel_t;
 
typedef enum {
    MXC_ADC_ATOMIC_CONV, 
    MXC_ADC_CONTINUOUS_CONV, 
} mxc_adc_conversion_mode_t;
 
typedef enum {
    MXC_ADC_DIV1 = MXC_V_MCR_ADCCFG2_CH0_DIV1, 
    MXC_ADC_DIV2_5K =
        MXC_V_MCR_ADCCFG2_CH0_DIV2_5K, 
    MXC_ADC_DIV2_50K =
        MXC_V_MCR_ADCCFG2_CH0_DIV2_50K, 
} mxc_adc_divsel_t;
 
typedef enum {
    MXC_ADC_REF_EXT, 
    MXC_ADC_REF_INT_1V25, 
    MXC_ADC_REF_INT_2V048, 
} mxc_adc_refsel_t;
 
typedef enum {
    MXC_ADC_DIV_2_5K_50K_ENABLE, 
    MXC_ADC_DIV_2_5K_DISABLE, 
    MXC_ADC_DIV_50K_DISABLE, 
    MXC_ADC_DIV_2_5K_50K_DISABLE, 
} mxc_adc_div_lpmode_t;
 
typedef enum {
    MXC_ADC_DATA_STATUS, 
    MXC_ADC_DATA, 
    MXC_ADC_RAW_DATA, 
} mxc_adc_fifodataformat_t;
 
typedef enum {
    MXC_ADC_PY_DN_DISABLE, 
    MXC_ADC_PY_DN_ENABLE, 
} mxc_adc_dynamic_pullup_t;
 
typedef void (*mxc_adc_complete_cb_t)(void *req, int error);
 
typedef struct {
    mxc_adc_clock_t clock; 
    mxc_adc_clkdiv_t clkdiv; 
    mxc_adc_calibration_t cal; 
    mxc_adc_refsel_t ref; 
    uint32_t trackCount; 
    uint32_t idleCount; 
} mxc_adc_req_t;
 
typedef struct {
    mxc_adc_chsel_t channel; 
    mxc_adc_divsel_t div; 
    mxc_adc_dynamic_pullup_t pullup_dyn; 
} mxc_adc_slot_req_t;
 
typedef struct {
    mxc_adc_conversion_mode_t mode; 
    mxc_adc_trig_mode_t trig; 
    mxc_adc_trig_sel_t hwTrig; 
    mxc_adc_fifodataformat_t fifo_format; 
    uint8_t fifo_threshold; 
    mxc_adc_avg_t avg_number; 
    mxc_adc_div_lpmode_t lpmode_divder; 
    uint8_t num_slots; 
    int8_t dma_channel; 
} mxc_adc_conversion_req_t;
 
int MXC_ADC_Init(mxc_adc_req_t *req);
 
int MXC_ADC_Shutdown(void);
 
void MXC_ADC_EnableInt(uint32_t flags);
 
void MXC_ADC_DisableInt(uint32_t flags);
 
int MXC_ADC_GetFlags(void);
 
void MXC_ADC_ClearFlags(uint32_t flags);
 
int MXC_ADC_StartConversion(void);
 
int MXC_ADC_StartConversionAsync(mxc_adc_complete_cb_t callback);
 
int MXC_ADC_StartConversionDMA(mxc_adc_conversion_req_t *req, int *data,
                               void (*callback)(int, int));
 
int MXC_ADC_Handler(void);
 
int MXC_ADC_ComparatorHysteresisEn(mxc_adc_comp_t comp);
 
int MXC_ADC_ComparatorHysteresisDis(mxc_adc_comp_t comp);
 
int MXC_ADC_InputDividerSelect(mxc_adc_chsel_t ch, mxc_adc_divsel_t div,
                               mxc_adc_dynamic_pullup_t lpEn);
 
int MXC_ADC_ReferenceSelect(mxc_adc_refsel_t ref);
 
int MXC_ADC_DynamicModeEn(mxc_adc_chsel_t ch);
 
int MXC_ADC_DynamicModeDis(mxc_adc_chsel_t ch);
 
int MXC_ADC_GetData(int *outdata);
 
int MXC_ADC_Configuration(mxc_adc_conversion_req_t *req);
 
int MXC_ADC_SlotConfiguration(mxc_adc_slot_req_t *req, uint32_t slot_length);
 
void MXC_ADC_TS_SelectEnable(void);
 
void MXC_ADC_TS_SelectDisable(void);
 
void MXC_ADC_EnableConversion(void);
 
void MXC_ADC_DisableConversion(void);
 
uint16_t MXC_ADC_FIFO_Level(void);
 
void MAX_ADC_Flush_FIFO(void);
 
int MXC_ADC_FIFO_Threshold_Config(uint32_t fifo_threshold);
 
int MXC_ADC_AverageConfig(mxc_adc_avg_t avg_number);
 
void MXC_ADC_Clear_ChannelSelect(void);
 
void MXC_ADC_TriggerConfig(mxc_adc_conversion_req_t *req);
 
void MXC_ADC_ConversionModeConfig(mxc_adc_conversion_req_t *req);
 
void MXC_ADC_SetConversionDelay(int delay);
 
int MXC_ADC_SlotsConfig(mxc_adc_conversion_req_t *req);
 
int MXC_ConvertTemperature_ToK(uint16_t tempSensor_Readout, mxc_adc_refsel_t ref, float ext_ref,
                               float *temp_k);
 
int MXC_ConvertTemperature_ToC(uint16_t tempSensor_Readout, mxc_adc_refsel_t ref, float ext_ref,
                               float *temp);
 
int MXC_ConvertTemperature_ToF(uint16_t tempSensor_Readout, mxc_adc_refsel_t ref, float ext_ref,
                               float *temp);
 
int MXC_ADC_LowPowerModeDividerSelect(mxc_adc_div_lpmode_t div_lpmode);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX78002_ADC_H_