161 lines
3.7 KiB
C++
161 lines
3.7 KiB
C++
/**
|
|
* @file pwm_generator_logic.h
|
|
*
|
|
* @date Mar 2, 2014
|
|
* @author Andrey Belomutskiy, (c) 2012-2020
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "state_sequence.h"
|
|
#include "global.h"
|
|
#include "scheduler.h"
|
|
#include "efi_gpio.h"
|
|
|
|
#define PERCENT_TO_DUTY(x) (x) * 0.01
|
|
|
|
#define NAN_FREQUENCY_SLEEP_PERIOD_MS 100
|
|
|
|
// 99% duty cycle
|
|
#define FULL_PWM_THRESHOLD 0.99
|
|
|
|
typedef struct {
|
|
/**
|
|
* a copy so that all phases are executed on the same period, even if another thread
|
|
* would be adjusting PWM parameters
|
|
*/
|
|
float periodNt;
|
|
/**
|
|
* Iteration counter
|
|
*/
|
|
int iteration;
|
|
/**
|
|
* Start time of current iteration
|
|
*/
|
|
efitick_t startNt;
|
|
int phaseIndex;
|
|
} pwm_config_safe_state_s;
|
|
|
|
class PwmConfig;
|
|
|
|
typedef void (pwm_cycle_callback)(PwmConfig *state);
|
|
typedef void (pwm_gen_callback)(int stateIndex, void *arg);
|
|
|
|
typedef enum {
|
|
PM_ZERO,
|
|
PM_NORMAL,
|
|
PM_FULL
|
|
} pwm_mode_e;
|
|
|
|
/**
|
|
* @brief Multi-channel software PWM output configuration
|
|
*/
|
|
class PwmConfig {
|
|
public:
|
|
PwmConfig();
|
|
void *arg = nullptr;
|
|
|
|
void weComplexInit(const char *msg,
|
|
ExecutorInterface *executor,
|
|
MultiChannelStateSequence const * seq,
|
|
pwm_cycle_callback *pwmCycleCallback,
|
|
pwm_gen_callback *callback);
|
|
|
|
ExecutorInterface *executor;
|
|
|
|
/**
|
|
* We need to handle zero duty cycle and 100% duty cycle in a special way
|
|
*/
|
|
pwm_mode_e mode;
|
|
bool isStopRequested = false;
|
|
|
|
/**
|
|
* @param use NAN frequency to pause PWM
|
|
*/
|
|
void setFrequency(float frequency);
|
|
|
|
void handleCycleStart();
|
|
const char *name;
|
|
|
|
// todo: 'outputPins' should be extracted away from here since technically one can want PWM scheduler without actual pin output
|
|
OutputPin *outputPins[PWM_PHASE_MAX_WAVE_PER_PWM];
|
|
MultiChannelStateSequence const * multiChannelStateSequence = nullptr;
|
|
efitick_t togglePwmState();
|
|
void stop();
|
|
|
|
int dbgNestingLevel;
|
|
|
|
scheduling_s scheduling;
|
|
|
|
pwm_config_safe_state_s safe;
|
|
|
|
/**
|
|
* this callback is invoked before each wave generation cycle
|
|
*/
|
|
pwm_cycle_callback *pwmCycleCallback;
|
|
|
|
/**
|
|
* this main callback is invoked when it's time to switch level on any of the output channels
|
|
*/
|
|
pwm_gen_callback *stateChangeCallback = nullptr;
|
|
private:
|
|
/**
|
|
* float value of PWM period
|
|
* PWM generation is not happening while this value is NAN
|
|
*/
|
|
float periodNt;
|
|
|
|
// Set if we are very far behind schedule and need to reset back to the beginning of a cycle to find our way
|
|
bool forceCycleStart = true;
|
|
};
|
|
|
|
struct hardware_pwm;
|
|
|
|
struct IPwm {
|
|
virtual void setSimplePwmDutyCycle(float dutyCycle) = 0;
|
|
};
|
|
|
|
class SimplePwm : public PwmConfig, public IPwm {
|
|
public:
|
|
SimplePwm();
|
|
explicit SimplePwm(const char *name);
|
|
void setSimplePwmDutyCycle(float dutyCycle) override;
|
|
MultiChannelStateSequenceWithData<2> seq;
|
|
hardware_pwm* hardPwm = nullptr;
|
|
};
|
|
|
|
/**
|
|
* default implementation of pwm_gen_callback which simply toggles the pins
|
|
*
|
|
*/
|
|
void applyPinState(int stateIndex, PwmConfig* state) /* pwm_gen_callback */;
|
|
|
|
/**
|
|
* Start a one-channel software PWM driver.
|
|
*
|
|
* This method should be called after scheduling layer is started by initSignalExecutor()
|
|
*/
|
|
void startSimplePwm(SimplePwm *state, const char *msg,
|
|
ExecutorInterface *executor,
|
|
OutputPin *output,
|
|
float frequency, float dutyCycle);
|
|
|
|
/**
|
|
* initialize GPIO pin and start a one-channel software PWM driver.
|
|
*
|
|
* This method should be called after scheduling layer is started by initSignalExecutor()
|
|
*/
|
|
void startSimplePwmExt(SimplePwm *state,
|
|
const char *msg,
|
|
ExecutorInterface *executor,
|
|
brain_pin_e brainPin, OutputPin *output,
|
|
float frequency, float dutyCycle);
|
|
|
|
void startSimplePwmHard(SimplePwm *state, const char *msg,
|
|
ExecutorInterface *executor,
|
|
brain_pin_e brainPin, OutputPin *output, float frequency,
|
|
float dutyCycle);
|
|
|
|
void copyPwmParameters(PwmConfig *state, MultiChannelStateSequence const * seq);
|
|
|