ald_acmp.h

/**
  *********************************************************************************
  *
  * @file    ald_acmp.h
  * @brief   Header file of ACMP module driver.
  *
  * @version V1.0
  * @date    13 Dec 2017
  * @author  AE Team
  * @note
  *
  * Copyright (C) Shanghai Eastsoft Microelectronics Co. Ltd. All rights reserved.
  *
  *********************************************************************************
  */

#ifndef __ALD_ACMP_H__
#define __ALD_ACMP_H__

#ifdef __cplusplus
extern "C" {
#endif

#include "utils.h"

/** @addtogroup ES32FXXX_ALD
  * @{
  */

/** @addtogroup ACMP
  * @{
  */

/** @defgroup ACMP_Public_Types ACMP Public Types
  * @{
  */

/**
  * @brief Acmp interrupt
  */
typedef enum
{
    ACMP_IT_EDGE   = (1U << 0), /**< Edge interrupt bit */
    ACMP_IT_WARMUP = (1U << 1), /**< Warm up interrupt bit */
} acmp_it_t;

/**
  * @brief Acmp interrupt
  */
typedef enum
{
    ACMP_FLAG_EDGE   = (1U << 0),   /**< Edge interrupt flag */
    ACMP_FLAG_WARMUP = (1U << 1),   /**< Warm up interrupt flag */
} acmp_flag_t;

/**
  * @brief Acmp interrupt flag
  */
typedef enum
{
    ACMP_STATUS_EDGE    = (1U << 0),    /**< Edge interrupt flag */
    ACMP_STATUS_WARMUP  = (1U << 1),    /**< Warm up interrupt flag */
} acmp_status_t;

/**
  * @brief Acmp positive input
  */
typedef enum
{
    ACMP_POS_CH0 = 0,   /**< Channel 0 as positive input */
    ACMP_POS_CH1 = 1,   /**< Channel 1 as positive input */
    ACMP_POS_CH2 = 2,   /**< Channel 2 as positive input */
    ACMP_POS_CH3 = 3,   /**< Channel 3 as positive input */
    ACMP_POS_CH4 = 4,   /**< Channel 4 as positive input */
    ACMP_POS_CH5 = 5,   /**< Channel 5 as positive input */
    ACMP_POS_CH6 = 6,   /**< Channel 6 as positive input */
    ACMP_POS_CH7 = 7,   /**< Channel 7 as positive input */
} acmp_pos_input_t;

/**
  * @brief Acmp negative input
  */
typedef enum
{
    ACMP_NEG_CH0      = 0,  /**< Channel 0 as negative input */
    ACMP_NEG_CH1      = 1,  /**< Channel 1 as negative input */
    ACMP_NEG_CH2      = 2,  /**< Channel 2 as negative input */
    ACMP_NEG_CH3      = 3,  /**< Channel 3 as negative input */
    ACMP_NEG_CH4      = 4,  /**< Channel 4 as negative input */
    ACMP_NEG_CH5      = 5,  /**< Channel 5 as negative input */
    ACMP_NEG_CH6      = 6,  /**< Channel 6 as negative input */
    ACMP_NEG_CH7      = 7,  /**< Channel 7 as negative input */
    ACMP_NEG_1V25     = 8,  /**< 1.25v as negative input */
    ACMP_NEG_2V5      = 9,  /**< 2.5v as negative input */
    ACMP_NEG_VDD      = 10, /**< VDD as negative input */
    ACMP_NEG_CAP      = 11, /**< Capacitive as negative input */
    ACMP_NEG_DAC0_CH0 = 12, /**< DAC0 channel 0 as negative input */
    ACMP_NEG_DAC0_CH1 = 13, /**< DAC0 channel 1 as negative input */
} acmp_neg_input_t;

/**
  * @brief Acmp mode
  */
typedef enum
{
    ACMP_ULTRA_LOW_POWER = 0,   /**< Ultra low power mode */
    ACMP_LOW_POWER       = 1,   /**< Low power mode */
    ACMP_MIDDLE_POWER    = 2,   /**< Middle power mode */
    ACMP_HIGH_POWER      = 3,   /**< High power mode */
} acmp_mode_t;

/**
  * @brief Acmp warm-up time
  */
typedef enum
{
    ACMP_4_PCLK   = 0,  /**< 4 hfperclk cycles */
    ACMP_8_PCLK   = 1,  /**< 4 hfperclk cycles */
    ACMP_16_PCLK  = 2,  /**< 4 hfperclk cycles */
    ACMP_32_PCLK  = 3,  /**< 4 hfperclk cycles */
    ACMP_64_PCLK  = 4,  /**< 4 hfperclk cycles */
    ACMP_128_PCLK = 5,  /**< 4 hfperclk cycles */
    ACMP_256_PCLK = 6,  /**< 4 hfperclk cycles */
    ACMP_512_PCLK = 7,  /**< 4 hfperclk cycles */
} acmp_warm_time_t;

/**
  * @brief Acmp hysteresis level
  */
typedef enum
{
    ACMP_HYST_0  = 0,   /**< No hysteresis */
    ACMP_HYST_15 = 1,   /**< 15mV hysteresis */
    ACMP_HYST_22 = 2,   /**< 22mV hysteresis */
    ACMP_HYST_29 = 3,   /**< 29mV hysteresis */
    ACMP_HYST_36 = 4,   /**< 36mV hysteresis */
    ACMP_HYST_43 = 5,   /**< 43mV hysteresis */
    ACMP_HYST_50 = 6,   /**< 50mV hysteresis */
    ACMP_HYST_57 = 7,   /**< 57mV hysteresis */
} acmp_hystsel_t;

/**
  * @brief Acmp inactive state
  */
typedef enum
{
    ACMP_INACTVAL_LOW  = 0, /**< The inactive value is 0 */
    ACMP_INACTVAL_HIGH = 1, /**< The inactive value is 1 */
} acmp_inactval_t;

/**
  * @brief which edges set up interrupt
  */
typedef enum
{
    ACMP_EDGE_NONE = 0, /**< Disable EDGE interrupt */
    ACMP_EDGE_FALL = 1, /**< Falling edges set EDGE interrupt */
    ACMP_EDGE_RISE = 2, /**< rise edges set EDGE interrupt */
    ACMP_EDGE_ALL  = 3, /**< Falling edges and rise edges set EDGE interrupt */
} acmp_edge_t;

/**
  * @brief Acmp output function
  */
typedef enum
{
    ACMP_OUT_DISABLE = 0,   /**< Disable acmp output */
    ACMP_OUT_ENABLE  = 1,   /**< Enable acmp output */
} acmp_out_func_t;

/**
  * @brief Acmp warm-up interrupt function
  */
typedef enum
{
    ACMP_WARM_DISABLE = 0,  /**< Disable acmp warm-up interrupt */
    ACMP_WARM_ENABLE  = 1,  /**< Enable acmp warm-up interrupt */
} acmp_warm_it_func;

/**
  * @brief Acmp gpio output invert
  */
typedef enum
{
    ACMP_GPIO_NO_INV = 0,   /**< Acmp output to gpio is not inverted */
    ACMP_GPIO_INV    = 1,   /**< Acmp output to gpio is inverted */
} acmp_invert_t;

/**
  * @brief The location of the acmp i/o pin
  */
typedef enum
{
    ACMP_LOCATION_O = 0,    /**< Location 0 */
    ACMP_LOCATION_1 = 1,    /**< Location 1 */
    ACMP_LOCATION_2 = 2,    /**< Location 2 */
} acmp_location_t;

/**
  * @brief Acmp output config structure definition
  */
typedef struct
{
    acmp_out_func_t out_func;   /**< Acmp output function */
    acmp_invert_t gpio_inv;     /**< If invert gpio output */
    acmp_location_t location;   /**< The location of acmp I/0 pin */
} acmp_output_config_t;

/**
  * @brief Acmp init structure definition
  */
typedef struct
{
    acmp_mode_t mode;               /**< Acmp operation mode */
    acmp_warm_time_t warm_time;     /**< Acmp warm up time */
    acmp_hystsel_t hystsel;         /**< Acmp hysteresis level */
    acmp_warm_it_func warm_func;    /**< Acmp warm-up interrupt enable/disable */
    acmp_pos_input_t pos_port;      /**< Acmp positive port select */
    acmp_neg_input_t neg_port;      /**< Acmp negative port select */
    acmp_inactval_t inactval;       /**< Acmp inavtive output value */
    acmp_edge_t edge;               /** Select edges to set interrupt flag */
    uint8_t vdd_level;              /** Select scaling factor for CDD reference level, MAX is 63 */
} acmp_init_t;

/**
  * @brief  ACMP Handle Structure definition
  */
typedef struct acmp_handle_s
{
    ACMP_TypeDef *perh; /**< Register base address */
    acmp_init_t init;   /**< ACMP required parameters */
    lock_state_t lock;  /**< Locking object */

    void (*acmp_warmup_cplt_cbk)(struct acmp_handle_s *arg);    /**< Acmp warm-up complete callback */
    void (*acmp_edge_cplt_cbk)(struct acmp_handle_s *arg);      /**< Acmp edge trigger callback */
} acmp_handle_t;
/**
  * @}
  */

/** @defgroup ACMP_Public_Macros ACMP Public Macros
  * @{
  */
#define ACMP_ENABLE(handle)     (SET_BIT((handle)->perh->CON, ACMP_CON_EN_MSK))
#define ACMP_DISABLE(handle)    (CLEAR_BIT((handle)->perh->CON, ACMP_CON_EN_MSK))
/**
  * @}
  */

/** @defgroup ACMP_Private_Macros   ACMP Private Macros
  * @{
  */
#define IS_ACMP_TYPE(x)         (((x) == ACMP0) || \
                         ((x) == ACMP1))
#define IS_ACMP_MODE_TYPE(x)        (((x) == ACMP_ULTRA_LOW_POWER) || \
                     ((x) == ACMP_LOW_POWER)       || \
                     ((x) == ACMP_MIDDLE_POWER)    || \
                     ((x) == ACMP_HIGH_POWER))
#define IS_ACMP_IT_TYPE(x)      (((x) == ACMP_IT_EDGE)  || \
                         ((x) == ACMP_IT_WARMUP))
#define IS_ACMP_FLAG_TYPE(x)        (((x) == ACMP_FLAG_EDGE)  || \
                         ((x) == ACMP_FLAG_WARMUP))
#define IS_ACMP_STATUS_TYPE(x)          (((x) == ACMP_STATUS_EDGE)  || \
                         ((x) == ACMP_STATUS_WARMUP))
#define IS_ACMP_POS_INPUT_TYPE(x)   (((x) == ACMP_POS_CH0) || \
                         ((x) == ACMP_POS_CH1) || \
                         ((x) == ACMP_POS_CH2) || \
                         ((x) == ACMP_POS_CH3) || \
                         ((x) == ACMP_POS_CH4) || \
                         ((x) == ACMP_POS_CH5) || \
                         ((x) == ACMP_POS_CH6) || \
                         ((x) == ACMP_POS_CH7))
#define IS_ACMP_NEG_INPUT_TYPE(x)   (((x) == ACMP_NEG_CH0)      || \
                         ((x) == ACMP_NEG_CH1)      || \
                         ((x) == ACMP_NEG_CH2)      || \
                         ((x) == ACMP_NEG_CH3)      || \
                         ((x) == ACMP_NEG_CH4)      || \
                         ((x) == ACMP_NEG_CH5)      || \
                         ((x) == ACMP_NEG_CH6)      || \
                         ((x) == ACMP_NEG_CH7)      || \
                         ((x) == ACMP_NEG_1V25)     || \
                         ((x) == ACMP_NEG_2V5)      || \
                         ((x) == ACMP_NEG_VDD)      || \
                         ((x) == ACMP_NEG_CAP)      || \
                         ((x) == ACMP_NEG_DAC0_CH0) || \
                         ((x) == ACMP_NEG_DAC0_CH1))
#define IS_ACMP_WARM_UP_TIME_TYPE(x)    (((x) == ACMP_4_PCLK)   || \
                         ((x) == ACMP_8_PCLK)   || \
                         ((x) == ACMP_16_PCLK)  || \
                         ((x) == ACMP_32_PCLK)  || \
                         ((x) == ACMP_64_PCLK)  || \
                         ((x) == ACMP_128_PCLK) || \
                         ((x) == ACMP_256_PCLK) || \
                         ((x) == ACMP_512_PCLK))
#define IS_ACMP_HYSTSEL_TYPE(x)         (((x) == ACMP_HYST_0)  || \
                         ((x) == ACMP_HYST_15) || \
                         ((x) == ACMP_HYST_22) || \
                         ((x) == ACMP_HYST_29) || \
                         ((x) == ACMP_HYST_36) || \
                         ((x) == ACMP_HYST_43) || \
                         ((x) == ACMP_HYST_50) || \
                         ((x) == ACMP_HYST_57))
#define IS_ACMP_INACTVAL_TYPE(x)    (((x) == ACMP_INACTVAL_LOW) || \
                         ((x) == ACMP_INACTVAL_HIGH))
#define IS_ACMP_EDGE_TYPE(x)            (((x) == ACMP_EDGE_NONE) || \
                     ((x) == ACMP_EDGE_FALL) || \
                         ((x) == ACMP_EDGE_RISE) || \
                     ((x) == ACMP_EDGE_ALL))
#define IS_ACMP_OUT_FUNC_TYPE(x)    (((x) == ACMP_OUT_DISABLE) || \
                     ((x) == ACMP_OUT_ENABLE))
#define IS_ACMP_INVERT_TYPE(x)      (((x) == ACMP_GPIO_NO_INV) || \
                     ((x) == ACMP_GPIO_INV))
#define IS_ACMP_LOCATION_TYPE(x)    (((x) == ACMP_LOCATION_O) || \
                     ((x) == ACMP_LOCATION_1) || \
                     ((x) == ACMP_LOCATION_2))
#define IS_ACMP_WARM_FUNC_TYPE(x)   (((x) == ACMP_WARM_DISABLE) || \
                     ((x) == ACMP_WARM_ENABLE))
/**
  * @}
  */

/** @addtogroup ACMP_Public_Functions
  * @{
  */

/** @addtogroup ACMP_Public_Functions_Group1
  * @{
  */
ald_status_t acmp_init(acmp_handle_t *hperh);

/**
  * @}
  */

/** @addtogroup ACMP_Public_Functions_Group2
  * @{
  */
ald_status_t acmp_interrupt_config(acmp_handle_t *hperh, acmp_it_t it, type_func_t state);
ald_status_t acmp_set_interrupt_mask(acmp_handle_t *hperh, acmp_it_t it);
it_status_t acmp_get_flag_status(acmp_handle_t *hperh, acmp_flag_t it);
ald_status_t acmp_clear_flag_status(acmp_handle_t *hperh, acmp_flag_t it);
flag_status_t acmp_get_status(acmp_handle_t *hperh, acmp_status_t flag);

/**
  * @}
  */

/** @addtogroup ACMP_Public_Functions_Group3
  * @{
  */
void acmp_irq_handle(acmp_handle_t *hperh);
ald_status_t acmp_out_config(acmp_handle_t *hperh, acmp_output_config_t *config);
uint8_t acmp_out_result(acmp_handle_t *hperh);
/**
  * @}
  */

/**
  * @}
  */

/**
  * @}
  */

/**
  * @}
  */
#ifdef __cplusplus
extern "C"
}
#endif

#endif