vsf_template_pwm.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_PWM_H__
#define __VSF_TEMPLATE_PWM_H__
 
/*============================ INCLUDES ======================================*/
 
#include "./vsf_template_hal_driver.h"
#include "hal/arch/vsf_arch.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
#ifndef VSF_PWM_CFG_MULTI_CLASS
#   define VSF_PWM_CFG_MULTI_CLASS              ENABLED
#endif
 
#if defined(VSF_HW_PWM_COUNT) && !defined(VSF_HW_PWM_MASK)
#   define VSF_HW_PWM_MASK                      VSF_HAL_COUNT_TO_MASK(VSF_HW_PWM_COUNT)
#endif
 
#if defined(VSF_HW_PWM_MASK) && !defined(VSF_HW_PWM_COUNT)
#   define VSF_HW_PWM_COUNT                     VSF_HAL_MASK_TO_COUNT(VSF_HW_PWM_MASK)
#endif
 
#ifndef VSF_PWM_CFG_PREFIX
#   if VSF_PWM_CFG_MULTI_CLASS == ENABLED
#       define VSF_PWM_CFG_PREFIX               vsf
#   elif defined(VSF_HW_PWM_COUNT) && (VSF_HW_PWM_COUNT != 0)
#       define VSF_PWM_CFG_PREFIX               vsf_hw
#   else
#       define VSF_PWM_CFG_PREFIX               vsf
#   endif
#endif
 
#ifndef VSF_PWM_CFG_FUNCTION_RENAME
#   define VSF_PWM_CFG_FUNCTION_RENAME          ENABLED
#endif
 
#ifndef VSF_PWM_CFG_REIMPLEMENT_TYPE_IRQ_MASK
#   define VSF_PWM_CFG_REIMPLEMENT_TYPE_IRQ_MASK      DISABLED
#endif
 
#ifndef VSF_PWM_CFG_REIMPLEMENT_TYPE_CFG
#    define VSF_PWM_CFG_REIMPLEMENT_TYPE_CFG DISABLED
#endif
 
#ifndef VSF_PWM_CFG_REIMPLEMENT_TYPE_CAPABILITY
#    define VSF_PWM_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
#endif
 
#ifndef VSF_PWM_CFG_INHERIT_HAL_CAPABILITY
#   define VSF_PWM_CFG_INHERIT_HAL_CAPABILITY       ENABLED
#endif
 
#ifndef VSF_PWM_CFG_REIMPLEMENT_TYPE_CTRL
#   define VSF_PWM_CFG_REIMPLEMENT_TYPE_CTRL        DISABLED
#endif
 
/*============================ MACROFIED FUNCTIONS ===========================*/
 
#define VSF_PWM_APIS(__prefix_name)                                                                                                                                             \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,             pwm, init,                 VSF_MCONNECT(__prefix_name, _t) *pwm_ptr, vsf_pwm_cfg_t *cfg_ptr)                         \
    __VSF_HAL_TEMPLATE_API(__prefix_name, void,                  pwm, fini,                 VSF_MCONNECT(__prefix_name, _t) *pwm_ptr)                                                 \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,             pwm, get_configuration,    VSF_MCONNECT(__prefix_name, _t) *pwm_ptr, vsf_pwm_cfg_t *cfg_ptr)                     \
    __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t,              pwm, enable,               VSF_MCONNECT(__prefix_name, _t) *pwm_ptr)                                                 \
    __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t,              pwm, disable,              VSF_MCONNECT(__prefix_name, _t) *pwm_ptr)                                                 \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_pwm_capability_t,  pwm, capability,           VSF_MCONNECT(__prefix_name, _t) *pwm_ptr)                                                 \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,             pwm, set,                  VSF_MCONNECT(__prefix_name, _t) *pwm_ptr, uint8_t channel, uint32_t period, uint32_t pulse)\
    __VSF_HAL_TEMPLATE_API(__prefix_name, uint32_t,              pwm, get_freq,             VSF_MCONNECT(__prefix_name, _t) *pwm_ptr)                                                 \
    __VSF_HAL_TEMPLATE_API(__prefix_name, void,                  pwm, irq_enable,           VSF_MCONNECT(__prefix_name, _t) *pwm_ptr, vsf_pwm_irq_mask_t irq_mask)                    \
    __VSF_HAL_TEMPLATE_API(__prefix_name, void,                  pwm, irq_disable,          VSF_MCONNECT(__prefix_name, _t) *pwm_ptr, vsf_pwm_irq_mask_t irq_mask)                    \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_pwm_irq_mask_t,    pwm, irq_clear,            VSF_MCONNECT(__prefix_name, _t) *pwm_ptr, vsf_pwm_irq_mask_t irq_mask)                    \
    __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t,             pwm, ctrl,                  VSF_MCONNECT(__prefix_name, _t) *pwm_ptr, vsf_pwm_ctrl_t ctrl, void* param)
 
/*============================ TYPES =========================================*/
 
#if VSF_PWM_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
typedef struct vsf_pwm_capability_t {
#if VSF_PWM_CFG_INHERIT_HAL_CAPABILITY == ENABLED
    inherit(vsf_peripheral_capability_t)
#endif
 
    uint32_t max_freq;
 
    uint32_t min_freq;
} vsf_pwm_capability_t;
#endif
 
#if VSF_PWM_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
typedef enum vsf_pwm_irq_mask_t {
    VSF_PWM_IRQ_MASK_WRAP = (0x01 << 0),
} vsf_pwm_irq_mask_t;
#endif
 
enum {
    VSF_PWM_IRQ_COUNT         = 1,
    VSF_PWM_IRQ_ALL_BITS_MASK = VSF_PWM_IRQ_MASK_WRAP,
};
 
#if VSF_PWM_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
typedef struct vsf_pwm_t vsf_pwm_t;
 
typedef void vsf_pwm_isr_handler_t(void *target_ptr,
                                   vsf_pwm_t *pwm_ptr,
                                   vsf_pwm_irq_mask_t irq_mask);
 
typedef struct vsf_pwm_isr_t {
    vsf_pwm_isr_handler_t *handler_fn;
    void *target_ptr;
    vsf_arch_prio_t prio;
} vsf_pwm_isr_t;
 
typedef struct vsf_pwm_cfg_t {
    union {
        uint32_t freq;
        uint32_t min_freq;
    };
    vsf_pwm_isr_t isr;
} vsf_pwm_cfg_t;
#endif
 
#if VSF_PWM_CFG_REIMPLEMENT_TYPE_CTRL == DISABLED
typedef enum vsf_pwm_ctrl_t {
    __VSF_PWM_CTRL_DUMMY = 0,
} vsf_pwm_ctrl_t;
#endif
 
typedef struct vsf_pwm_t vsf_pwm_t;
 
typedef struct vsf_pwm_op_t {
#undef __VSF_HAL_TEMPLATE_API
#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
 
    VSF_PWM_APIS(vsf_pwm)
} vsf_pwm_op_t;
 
#if VSF_PWM_CFG_MULTI_CLASS == ENABLED
struct vsf_pwm_t  {
    const vsf_pwm_op_t * op;
};
#endif
 
/*============================ PROTOTYPES ====================================*/
 
extern vsf_err_t vsf_pwm_init(vsf_pwm_t *pwm_ptr, vsf_pwm_cfg_t *cfg_ptr);
 
extern void vsf_pwm_fini(vsf_pwm_t *pwm_ptr);
 
extern vsf_err_t vsf_pwm_get_configuration(vsf_pwm_t *pwm_ptr, vsf_pwm_cfg_t *cfg_ptr);
 
extern fsm_rt_t vsf_pwm_enable(vsf_pwm_t *pwm_ptr);
 
extern fsm_rt_t vsf_pwm_disable(vsf_pwm_t *pwm_ptr);
 
extern vsf_pwm_capability_t vsf_pwm_capability(vsf_pwm_t *pwm_ptr);
 
extern vsf_err_t vsf_pwm_set(vsf_pwm_t *pwm_ptr, uint8_t channel,
                             uint32_t period, uint32_t pulse);
 
extern uint32_t vsf_pwm_get_freq(vsf_pwm_t *pwm_ptr);
 
extern void vsf_pwm_irq_enable(vsf_pwm_t *pwm_ptr, vsf_pwm_irq_mask_t irq_mask);
 
extern void vsf_pwm_irq_disable(vsf_pwm_t *pwm_ptr, vsf_pwm_irq_mask_t irq_mask);
 
extern vsf_pwm_irq_mask_t vsf_pwm_irq_clear(vsf_pwm_t *pwm_ptr, vsf_pwm_irq_mask_t irq_mask);
 
extern vsf_err_t vsf_pwm_ctrl(vsf_pwm_t *pwm_ptr, vsf_pwm_ctrl_t ctrl, void * param);
 
extern vsf_err_t vsf_pwm_set_ms(vsf_pwm_t *pwm_ptr,
                                uint8_t    channel,
                                uint32_t   period,
                                uint32_t   pulse);
 
extern vsf_err_t vsf_pwm_set_us(vsf_pwm_t *pwm_ptr,
                                uint8_t    channel,
                                uint32_t   period,
                                uint32_t   pulse);
 
extern vsf_err_t vsf_pwm_set_ns(vsf_pwm_t *pwm_ptr,
                                uint8_t    channel,
                                uint32_t   period,
                                uint32_t   pulse);
 
/*============================ MACROFIED FUNCTIONS ===========================*/
 
#if VSF_PWM_CFG_FUNCTION_RENAME == ENABLED
#   define __vsf_pwm_t                      VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_t)
#   define vsf_pwm_init(__PM, ...)          VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_init)             ((__vsf_pwm_t *)(__PM), ##__VA_ARGS__)
#   define vsf_pwm_fini(__PM)               VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_fini)             ((__vsf_pwm_t *)(__PM))
#   define vsf_pwm_get_configuration(__PM, ...) VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_get_configuration) ((__vsf_pwm_t *)(__PM), ##__VA_ARGS__)
#   define vsf_pwm_enable(__PM)             VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_enable)           ((__vsf_pwm_t *)(__PM))
#   define vsf_pwm_disable(__PM)            VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_disable)          ((__vsf_pwm_t *)(__PM))
#   define vsf_pwm_capability(__PM)         VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_capability)       ((__vsf_pwm_t *)(__PM))
#   define vsf_pwm_set(__PM, ...)           VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_set)              ((__vsf_pwm_t *)(__PM), ##__VA_ARGS__)
#   define vsf_pwm_get_freq(__PM)           VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_get_freq)         ((__vsf_pwm_t *)(__PM))
#   define vsf_pwm_irq_enable(__PM, ...)   VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_irq_enable)       ((__vsf_pwm_t *)(__PM), ##__VA_ARGS__)
#   define vsf_pwm_irq_disable(__PM, ...)  VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_irq_disable)      ((__vsf_pwm_t *)(__PM), ##__VA_ARGS__)
#   define vsf_pwm_irq_clear(__PM, ...)    VSF_MCONNECT(VSF_PWM_CFG_PREFIX, _pwm_irq_clear)        ((__vsf_pwm_t *)(__PM), ##__VA_ARGS__)
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif  /*__VSF_TEMPLATE_PWM_H__ */