ps_pwm.h

Go to the documentation of this file.

 
#ifndef PS_PWM_H__
#define PS_PWM_H__
 
#include <stdbool.h> 
#include "driver/mcpwm.h"
 
// Set log level to ESP_LOG_INFO for production!
#define PS_PWM_LOG_LEVEL ESP_LOG_INFO
 
//#define GPIO_SYNC0_IN   2   //Set GPIO 02 as SYNC0
 
// Unscaled input clock frequency
#define MCPWM_INPUT_CLK 160000000 // 160 MHz
// Hardware prescaler factor for input clock.
// Dead time generators are configured to run on this scaled clock signal
// Valid values are 1...255
#define BASE_CLK_PRESCALE_DEFAULT 1
// Hardware prescaler factor for timer operator sub-modules
// Valid values are 1...255
#define TIMER_CLK_PRESCALE_DEFAULT 1
// Minimum timer counter TOP value / timer resolution. Used for calculation of
// frequency_min value and subsequent range checking of frequency setpoint
static const uint16_t period_min = 4;
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
    // Frequency setpoint
    float frequency;
    // Phase shift setpoint
    float ps_duty;
    // Lead leg, dead time for rising edge (up_ctr_mode)
    // or both edges (up_down_ctr_mode)
    float lead_red;
    // Falling edge dead time for up_ctr_mode, not defined for up_down_ctr_mode
    float lead_fed;
    // All the same for lagging leg
    float lag_red;
    float lag_fed;
    // true if output is enabled
    bool output_enabled;
} pspwm_setpoint_t;
 
typedef struct {
    uint8_t base_clk_prescale;
    uint8_t timer_clk_prescale;
    float base_clk;
    float timer_clk;
} pspwm_clk_conf_t;
 
typedef struct {
    // Minimum and maximum allowed frequency setpoints
    float frequency_min;
    float frequency_max;
    // Dead time for each bridge leg must be smaller than this value,
    // both in sum and also both individually. (Minimum is zero.)
    float dt_sum_max;
} pspwm_setpoint_limits_t;
 
/********************************************************************/
esp_err_t pspwm_init(mcpwm_unit_t mcpwm_num,
                     int gpio_lead_a,
                     int gpio_lead_b,
                     int gpio_lag_a,
                     int gpio_lag_b,
                     float frequency,
                     float ps_duty,
                     float lead_red, float lead_fed,
                     float lag_red, float lag_fed,
                     bool output_enabled,
                     mcpwm_action_on_pwmxa_t disable_action_lead_leg,
                     mcpwm_action_on_pwmxa_t disable_action_lag_leg);
 
esp_err_t pspwm_init_symmetrical(mcpwm_unit_t mcpwm_num,
                                 int gpio_lead_a,
                                 int gpio_lead_b,
                                 int gpio_lag_a,
                                 int gpio_lag_b,
                                 float frequency,
                                 float ps_duty,
                                 float lead_dt,
                                 float lag_dt,
                                 bool output_enabled,
                                 mcpwm_action_on_pwmxa_t disable_action_lead_leg,
                                 mcpwm_action_on_pwmxa_t disable_action_lag_leg);
 
esp_err_t pspwm_set_frequency(mcpwm_unit_t mcpwm_num,
                              float frequency);
 
esp_err_t pspwm_set_deadtimes(mcpwm_unit_t mcpwm_num,
                              float lead_red,
                              float lead_fed,
                              float lag_red,
                              float lag_fed);
 
esp_err_t pspwm_set_deadtimes_symmetrical(mcpwm_unit_t mcpwm_num,
                                          float lead_dt,
                                          float lag_dt);
 
esp_err_t pspwm_set_ps_duty(mcpwm_unit_t mcpwm_num,
                            float ps_duty);
 
 
/*****************************************************************
 *                         COMMON SETUP
 *****************************************************************/
bool pspwm_get_hw_fault_shutdown_present(mcpwm_unit_t mcpwm_num);
 
bool pspwm_get_hw_fault_shutdown_occurred(mcpwm_unit_t mcpwm_num);
 
void pspwm_clear_hw_fault_shutdown_occurred(mcpwm_unit_t mcpwm_num);
 
esp_err_t pspwm_disable_output(mcpwm_unit_t mcpwm_num);
 
esp_err_t pspwm_resync_enable_output(mcpwm_unit_t mcpwm_num);
 
esp_err_t pspwm_enable_hw_fault_shutdown(mcpwm_unit_t mcpwm_num,
                                         int gpio_fault_shutdown,
                                         mcpwm_fault_input_level_t fault_pin_active_level);
 
esp_err_t pspwm_disable_hw_fault_shutdown(mcpwm_unit_t mcpwm_num,
                                          int gpio_fault_shutdown);
 
esp_err_t pspwm_get_setpoint_ptr(mcpwm_unit_t mcpwm_num,
                                 pspwm_setpoint_t** setpoint);
 
esp_err_t pspwm_get_setpoint_limits_ptr(mcpwm_unit_t mcpwm_num,
                                        pspwm_setpoint_limits_t** setpoint_limits);
 
esp_err_t pspwm_get_clk_conf_ptr(mcpwm_unit_t mcpwm_num,
                                 pspwm_clk_conf_t** clk_conf);
 
 
// Disabled by default, included as reference or to be enabled on demand
#ifdef PSPWM_USE_UP_DOWN_CTR_MODE_API
/*************************************************************/
esp_err_t pspwm_up_down_ctr_mode_init(mcpwm_unit_t mcpwm_num,
                                      int gpio_lead_a,
                                      int gpio_lead_b,
                                      int gpio_lag_a,
                                      int gpio_lag_b,
                                      float frequency,
                                      float ps_duty,
                                      float lead_dt,
                                      float lag_dt,
                                      bool output_enabled,
                                      mcpwm_action_on_pwmxa_t disable_action_lead_leg,
                                      mcpwm_action_on_pwmxa_t disable_action_lag_leg);
 
esp_err_t pspwm_up_down_ctr_mode_set_frequency(mcpwm_unit_t mcpwm_num,
                                               float frequency);
 
esp_err_t pspwm_up_down_ctr_mode_set_deadtimes(mcpwm_unit_t mcpwm_num,
                                               float lead_dt,
                                               float lag_dt);
 
esp_err_t pspwm_up_down_ctr_mode_set_ps_duty(mcpwm_unit_t mcpwm_num,
                                             float ps_duty);
 
#endif // PSPWM_USE_UP_DOWN_CTR_MODE_API
 
#ifdef __cplusplus
}
#endif
 
#endif  /* PS_PWM_H__ */