adc.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  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.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __HAL_DRIVER_${SERIES/ADC_IP}_ADC_H__
#define __HAL_DRIVER_${SERIES/ADC_IP}_ADC_H__
 
/*============================ INCLUDES ======================================*/
 
#include "hal/vsf_hal_cfg.h"
 
#if VSF_HAL_USE_ADC == ENABLED
 
// HW/IPCore
#include "hal/driver/common/template/vsf_template_hal_driver.h"
// HW/IPCore end
 
/*\note Refer to template/README.md for usage cases.
 *      For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
 *      For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
 *      For emulated drivers, **** No reimplementation ****.
 */
 
/*\note Includes CAN ONLY be put here. */
/*\note If current header is for a peripheral driver(hw driver), and inherit from an IPCore driver, include IPCore header here. */
 
// IPCore
#if     defined(__VSF_HAL_${ADC_IP}_ADC_CLASS_IMPLEMENT)
#   define __VSF_CLASS_IMPLEMENT__
#elif   defined(__VSF_HAL_${ADC_IP}_ADC_CLASS_INHERIT__)
#   define __VSF_CLASS_INHERIT__
#endif
 
#include "utilities/ooc_class.h"
// IPCore end
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
/*\note VSF_${ADC_IP}_ADC_CFG_MULTI_CLASS should be implemented for IP drives and open to user,
 *          while VSF_HW_ADC_CFG_MULTI_CLASS should be in adc.c.
 */
 
// IPCore
#ifndef VSF_${ADC_IP}_ADC_CFG_MULTI_CLASS
#   define VSF_${ADC_IP}_ADC_CFG_MULTI_CLASS    VSF_ADC_CFG_MULTI_CLASS
#endif
// IPCore end
 
// HW
/*\note hw ADC driver can reimplement following types:
 *      To enable reimplementation, please enable macro below:
 *          VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE for vsf_adc_mode_t
 *          VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE for vsf_adc_channel_mode_t
 *          VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK for vsf_adc_irq_mask_t
 *          VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG for vsf_adc_channel_cfg_t
 *          VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG for vsf_adc_cfg_t
 *          VSF_ADC_CFG_REIMPLEMENT_TYPE_STATUS for vsf_adc_status_t
 *          VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_adc_capability_t
 *      Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers.
 *      *** DO NOT reimplement these in emulated drivers. ***
 */
 
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE         ENABLED
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE ENABLED
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK     ENABLED
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG  ENABLED
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG          ENABLED
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_STATUS       ENABLED
#define VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED
// HW end
 
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
// IPCore
vsf_class(vsf_${adc_ip}_adc_t) {
#if VSF_${ADC_IP}_CFG_MULTI_CLASS == ENABLED
    public_member(
        vsf_adc_t               vsf_adc;
    )
#endif
 
/*\note You can add more member in vsf_${adc_ip}_adc_t instance.
 *      For members accessible from child, put in protected_member.
 *      Else, put in private_member.
 */
 
    protected_member(
        vsf_${adc_ip}_adc_reg_t *reg;
        vsf_adc_isr_t           isr;
    )
};
// IPCore end
 
// HW/IPCore, not for emulated drivers
 
#if VSF_ADC_CFG_REIMPLEMENT_TYPE_MODE == ENABLED
typedef enum vsf_adc_mode_t {
    VSF_ADC_REF_VDD_1               = (0 << 0),
    VSF_ADC_REF_VDD_1_2             = (1 << 0),
    VSF_ADC_REF_VDD_1_3             = (2 << 0),
    VSF_ADC_REF_VDD_1_4             = (3 << 0),
    VSF_ADC_DATA_ALIGN_RIGHT        = (0 << 2),
    VSF_ADC_DATA_ALIGN_LEFT         = (1 << 2),
    VSF_ADC_SCAN_CONV_SINGLE_MODE   = (0 << 3),
    VSF_ADC_SCAN_CONV_SEQUENCE_MODE = (1 << 3),
    VSF_ADC_EXTERN_TRIGGER_0        = (0 << 4),
    VSF_ADC_EXTERN_TRIGGER_1        = (1 << 4),
    VSF_ADC_EXTERN_TRIGGER_2        = (2 << 4),
} vsf_adc_mode_t;
#endif
 
#if VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_MODE == ENABLED
typedef enum vsf_adc_channel_mode_t {
    VSF_ADC_CHANNEL_GAIN_1_6        = (0 << 0),
    VSF_ADC_CHANNEL_GAIN_1_5        = (1 << 0),
    VSF_ADC_CHANNEL_GAIN_1_4        = (2 << 0),
    VSF_ADC_CHANNEL_GAIN_1_3        = (3 << 0),
    VSF_ADC_CHANNEL_GAIN_1_2        = (4 << 0),
    VSF_ADC_CHANNEL_GAIN_1          = (5 << 0),
    VSF_ADC_CHANNEL_REF_VDD_1       = (0 << 4),
    VSF_ADC_CHANNEL_REF_VDD_1_2     = (1 << 4),
    VSF_ADC_CHANNEL_REF_VDD_1_3     = (2 << 4),
    VSF_ADC_CHANNEL_REF_VDD_1_4     = (3 << 4),
    // more vendor specified channel mode can be added here
} vsf_adc_channel_mode_t;
#endif
 
#if VSF_ADC_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
typedef enum vsf_adc_irq_mask_t {
    VSF_ADC_IRQ_MASK_CPL = (0x1ul << 0),
} vsf_adc_irq_mask_t;
#endif
 
#if VSF_ADC_CFG_REIMPLEMENT_TYPE_STATUS == ENABLED
typedef struct vsf_adc_status_t {
    union {
        inherit(vsf_peripheral_status_t)
        struct {
            uint32_t is_busy : 1;
        };
        uint32_t value;
    };
 
    // more vendor specified status can be added here
} vsf_adc_status_t;
#endif
 
#if VSF_ADC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG == ENABLED
typedef struct vsf_adc_channel_cfg_t {
    uint32_t channel;
    vsf_adc_channel_mode_t mode;
    uint32_t sample_cycles;
    // more vendor specified channel cfg can be added here
} vsf_adc_channel_cfg_t;
#endif
 
#if VSF_ADC_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
typedef struct vsf_adc_t vsf_adc_t;
typedef void vsf_adc_isr_handler_t(void *target_ptr,
                                   vsf_adc_t *adc_ptr,
                                   vsf_adc_irq_mask_t irq_mask);
typedef struct vsf_adc_isr_t {
    vsf_adc_isr_handler_t  *handler_fn;
    void                   *target_ptr;
    vsf_arch_prio_t         prio;
} vsf_adc_isr_t;
typedef struct vsf_adc_cfg_t {
    vsf_adc_mode_t  mode;
    vsf_adc_isr_t   isr;
    uint32_t        clock_hz;
} vsf_adc_cfg_t;
#endif
 
#if VSF_ADC_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
typedef struct vsf_adc_capability_t {
#if VSF_ADC_CFG_INHERIT_HAL_CAPABILITY == ENABLED
    inherit(vsf_peripheral_capability_t)
#endif
    vsf_adc_irq_mask_t irq_mask;
    uint8_t max_data_bits;
    uint8_t channel_count;
} vsf_adc_capability_t;
#endif
// HW/IPCore end
 
/*============================ INCLUDES ======================================*/
 
// IPCore
/*\note Extern APIs for ip core diriver.
 *      There is no requirement about how APIs of IPCore drivers should be implemented.
 *      Just consider the simplicity for actual peripheral drivers.
 */
// IPCore end
 
#ifdef __cplusplus
}
#endif
 
// IPCore
#undef __VSF_HAL_${ADC_IP}_ADC_CLASS_IMPLEMENT
#undef __VSF_HAL_${ADC_IP}_ADC_CLASS_INHERIT__
// IPCore end
 
#endif      // VSF_HAL_USE_ADC
#endif      // __HAL_DRIVER_${SERIES/ADC_IP}_ADC_H__
/* EOF */