vsf_template_dac.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 __VSF_TEMPLATE_DAC_H__
#define __VSF_TEMPLATE_DAC_H__
 
/*============================ INCLUDES ======================================*/
 
#include "./vsf_template_hal_driver.h"
#include "hal/arch/vsf_arch.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
#ifndef VSF_DAC_CFG_MULTI_CLASS
#   define VSF_DAC_CFG_MULTI_CLASS                      ENABLED
#endif
 
#if defined(VSF_HW_DAC_COUNT) && !defined(VSF_HW_DAC_MASK)
#   define VSF_HW_DAC_MASK                              VSF_HAL_COUNT_TO_MASK(VSF_HW_DAC_COUNT)
#endif
 
#if defined(VSF_HW_DAC_MASK) && !defined(VSF_HW_DAC_COUNT)
#   define VSF_HW_DAC_COUNT                             VSF_HAL_MASK_TO_COUNT(VSF_HW_DAC_MASK)
#endif
 
#ifndef VSF_DAC_CFG_PREFIX
#   if VSF_DAC_CFG_MULTI_CLASS == ENABLED
#       define VSF_DAC_CFG_PREFIX                       vsf
#   elif defined(VSF_HW_DAC_COUNT) && (VSF_HW_DAC_COUNT != 0)
#       define VSF_DAC_CFG_PREFIX                       vsf_hw
#   else
#       define VSF_DAC_CFG_PREFIX                       vsf
#   endif
#endif
 
#ifndef VSF_DAC_CFG_FUNCTION_RENAME
#   define VSF_DAC_CFG_FUNCTION_RENAME                  ENABLED
#endif
 
#ifndef VSF_DAC_CFG_REIMPLEMENT_TYPE_IRQ_MASK
#   define VSF_DAC_CFG_REIMPLEMENT_TYPE_IRQ_MASK        DISABLED
#endif
 
#ifndef VSF_DAC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG
#   define VSF_DAC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG     DISABLED
#endif
 
#ifndef VSF_DAC_CFG_REIMPLEMENT_TYPE_CFG
#   define VSF_DAC_CFG_REIMPLEMENT_TYPE_CFG             DISABLED
#endif
 
#ifndef VSF_DAC_CFG_REIMPLEMENT_TYPE_CAPABILITY
#   define VSF_DAC_CFG_REIMPLEMENT_TYPE_CAPABILITY     DISABLED
#endif
 
#ifndef VSF_DAC_CFG_REIMPLEMENT_TYPE_STATUS
#   define VSF_DAC_CFG_REIMPLEMENT_TYPE_STATUS        DISABLED
#endif
 
#ifndef VSF_DAC_CFG_INHERIT_HAL_CAPABILITY
#   define VSF_DAC_CFG_INHERIT_HAL_CAPABILITY            ENABLED
#endif
 
#ifndef VSF_DAC_CFG_REIMPLEMENT_TYPE_CTRL
#   define VSF_DAC_CFG_REIMPLEMENT_TYPE_CTRL        DISABLED
#endif
 
/*============================ MACROFIED FUNCTIONS ===========================*/
 
#define VSF_DAC_APIS(__prefix_name) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,            dac, init,                 VSF_MCONNECT(__prefix_name, _t) *dac_ptr, vsf_dac_cfg_t *cfg_ptr) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, void,                 dac, fini,                 VSF_MCONNECT(__prefix_name, _t) *dac_ptr) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,            dac, get_configuration,    VSF_MCONNECT(__prefix_name, _t) *dac_ptr, vsf_dac_cfg_t *cfg_ptr) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t,             dac, enable,               VSF_MCONNECT(__prefix_name, _t) *dac_ptr) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t,             dac, disable,              VSF_MCONNECT(__prefix_name, _t) *dac_ptr) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_dac_status_t,     dac, status,               VSF_MCONNECT(__prefix_name, _t) *dac_ptr) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_dac_capability_t, dac, capability,           VSF_MCONNECT(__prefix_name, _t) *dac_ptr) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, void,                 dac, irq_enable,           VSF_MCONNECT(__prefix_name, _t) *dac_ptr, vsf_dac_irq_mask_t irq_mask) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, void,                 dac, irq_disable,          VSF_MCONNECT(__prefix_name, _t) *dac_ptr, vsf_dac_irq_mask_t irq_mask) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_dac_irq_mask_t,   dac, irq_clear,            VSF_MCONNECT(__prefix_name, _t) *dac_ptr, vsf_dac_irq_mask_t irq_mask) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,            dac, channel_request_once, VSF_MCONNECT(__prefix_name, _t) *dac_ptr, vsf_dac_channel_cfg_t *cfg, uint_fast16_t value) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,            dac, channel_config,       VSF_MCONNECT(__prefix_name, _t) *dac_ptr, vsf_dac_channel_cfg_t *cfgs_ptr, uint_fast8_t cnt) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,            dac, channel_request,      VSF_MCONNECT(__prefix_name, _t) *dac_ptr, void *values_ptr, uint_fast32_t cnt) \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,            dac, ctrl,                 VSF_MCONNECT(__prefix_name, _t) *dac_ptr, vsf_dac_ctrl_t ctrl, void* param)
 
/*============================ TYPES =========================================*/
 
#if VSF_DAC_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
typedef enum vsf_dac_irq_mask_t {
    VSF_DAC_IRQ_MASK_IDLE = (0x01ul << 0),    
    VSF_DAC_IRQ_MASK_CPL  = (0x01ul << 1),    
} vsf_dac_irq_mask_t;
#endif
 
enum {
    VSF_DAC_IRQ_COUNT               = 2,
    VSF_DAC_IRQ_ALL_BITS_MASK       = VSF_DAC_IRQ_MASK_IDLE | VSF_DAC_IRQ_MASK_CPL,
};
 
#if VSF_DAC_CFG_REIMPLEMENT_TYPE_CHANNEL_CFG == DISABLED
typedef struct vsf_dac_channel_cfg_t {
    uint8_t channel;      
    uint8_t resolution;   
} vsf_dac_channel_cfg_t;
#endif
 
#if VSF_DAC_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
typedef struct vsf_dac_t vsf_dac_t;
 
typedef void vsf_dac_isr_handler_t(void *target_ptr, vsf_dac_t *dac_ptr, vsf_dac_irq_mask_t irq_mask);
 
typedef struct vsf_dac_isr_t {
    vsf_dac_isr_handler_t  *handler_fn;    
    void                   *target_ptr;    
    vsf_arch_prio_t         prio;          
} vsf_dac_isr_t;
 
typedef struct vsf_dac_cfg_t {
    vsf_dac_isr_t   isr;    
} vsf_dac_cfg_t;
#endif
 
#if VSF_DAC_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED
typedef struct vsf_dac_status_t {
    union {
        inherit(vsf_peripheral_status_t)
        struct {
            uint32_t is_busy : 1;    
        };
    };
} vsf_dac_status_t;
#endif
 
#if VSF_DAC_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
typedef struct vsf_dac_capability_t {
#if VSF_DAC_CFG_INHERIT_HAL_CAPABILITY == ENABLED
    inherit(vsf_peripheral_capability_t)
#endif
    vsf_dac_irq_mask_t irq_mask;           
    uint8_t max_resolution_bits;           
    uint8_t min_resolution_bits;           
    uint8_t channel_count;                 
} vsf_dac_capability_t;
#endif
 
#if VSF_DAC_CFG_REIMPLEMENT_TYPE_CTRL == DISABLED
typedef enum vsf_dac_ctrl_t {
    __VSF_DAC_CTRL_DUMMY = 0,
} vsf_dac_ctrl_t;
#endif
 
typedef struct vsf_dac_op_t {
#undef  __VSF_HAL_TEMPLATE_API
#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
 
    VSF_DAC_APIS(vsf_dac)
} vsf_dac_op_t;
 
#if VSF_DAC_CFG_MULTI_CLASS == ENABLED
struct vsf_dac_t  {
    const vsf_dac_op_t * op;
};
#endif
 
/*============================ PROTOTYPES ====================================*/
 
extern vsf_err_t vsf_dac_init(vsf_dac_t *dac_ptr, vsf_dac_cfg_t *cfg_ptr);
 
extern void vsf_dac_fini(vsf_dac_t *dac_ptr);
 
extern vsf_err_t vsf_dac_get_configuration(vsf_dac_t *dac_ptr, vsf_dac_cfg_t *cfg_ptr);
 
extern fsm_rt_t vsf_dac_enable(vsf_dac_t *dac_ptr);
 
extern fsm_rt_t vsf_dac_disable(vsf_dac_t *dac_ptr);
 
extern void vsf_dac_irq_enable(vsf_dac_t *dac_ptr, vsf_dac_irq_mask_t irq_mask);
 
extern void vsf_dac_irq_disable(vsf_dac_t *dac_ptr, vsf_dac_irq_mask_t irq_mask);
 
extern vsf_dac_irq_mask_t vsf_dac_irq_clear(vsf_dac_t *dac_ptr, vsf_dac_irq_mask_t irq_mask);
 
extern vsf_dac_status_t vsf_dac_status(vsf_dac_t *dac_ptr);
 
extern vsf_dac_capability_t vsf_dac_capability(vsf_dac_t *dac_ptr);
 
 
extern vsf_err_t vsf_dac_channel_request_once(vsf_dac_t *dac_ptr,
                                              vsf_dac_channel_cfg_t *channel_cfg,
                                              uint_fast16_t value);
 
extern vsf_err_t vsf_dac_channel_config(vsf_dac_t *dac_ptr,
                                        vsf_dac_channel_cfg_t *cfgs_ptr,
                                        uint_fast8_t cnt);
 
extern vsf_err_t vsf_dac_channel_request(vsf_dac_t *dac_ptr,
                                         void *buffer_ptr,
                                         uint_fast32_t count);
 
extern vsf_err_t vsf_dac_ctrl(vsf_dac_t *dac_ptr, vsf_dac_ctrl_t ctrl, void * param);
 
/*============================ MACROFIED FUNCTIONS ===========================*/
 
#if VSF_DAC_CFG_FUNCTION_RENAME == ENABLED
#   define __vsf_dac_t                              VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_t)
#   define vsf_dac_init(__DAC, ...)                 VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_init)                 ((__vsf_dac_t *)(__DAC), ##__VA_ARGS__)
#   define vsf_dac_fini(__DAC)                      VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_fini)                 ((__vsf_dac_t *)(__DAC))
#   define vsf_dac_get_configuration(__DAC, ...)    VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_get_configuration)    ((__vsf_dac_t *)(__DAC), ##__VA_ARGS__)
#   define vsf_dac_enable(__DAC)                    VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_enable)               ((__vsf_dac_t *)(__DAC))
#   define vsf_dac_disable(__DAC)                   VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_disable)              ((__vsf_dac_t *)(__DAC))
#   define vsf_dac_status(__DAC)                    VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_status)               ((__vsf_dac_t *)(__DAC))
#   define vsf_dac_capability(__DAC)                VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_capability)           ((__vsf_dac_t *)(__DAC))
#   define vsf_dac_irq_enable(__DAC, ...)           VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_irq_enable)           ((__vsf_dac_t *)(__DAC), ##__VA_ARGS__)
#   define vsf_dac_irq_disable(__DAC, ...)          VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_irq_disable)          ((__vsf_dac_t *)(__DAC), ##__VA_ARGS__)
#   define vsf_dac_irq_clear(__DAC, ...)            VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_irq_clear)             ((__vsf_dac_t *)(__DAC), ##__VA_ARGS__)
#   define vsf_dac_channel_request_once(__DAC, ...) VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_channel_request_once) ((__vsf_dac_t *)(__DAC), ##__VA_ARGS__)
#   define vsf_dac_channel_config(__DAC, ...)       VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_channel_config)       ((__vsf_dac_t *)(__DAC), ##__VA_ARGS__)
#   define vsf_dac_channel_request(__DAC, ...)      VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_channel_request)      ((__vsf_dac_t *)(__DAC), ##__VA_ARGS__)
#   define vsf_dac_ctrl(__DAC, ...)                 VSF_MCONNECT(VSF_DAC_CFG_PREFIX, _dac_ctrl)                 ((__vsf_dac_t *)(__DAC), ##__VA_ARGS__)
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif  /*__VSF_TEMPLATE_DAC_H__*/