pwm.h

Go to the documentation of this file.

#pragma once
#include <stdbool.h>
#include <stdint.h>

// TYPES

typedef struct {
  uint32_t wrap; 
  float divider; 
} hw_pwm_config_t;

typedef struct hw_pwm_t {
  uint8_t unit;  
  uint32_t wrap; 
  bool enabled;  
} hw_pwm_t;

typedef void (*hw_pwm_callback_t)(uint8_t unit, void *userdata);

// LIFECYCLE

hw_pwm_t hw_pwm_init(uint8_t unit, hw_pwm_config_t *config);

uint8_t hw_pwm_count();

static inline bool hw_pwm_valid(hw_pwm_t *pwm) {
  if (pwm == NULL) {
    return false;
  }
  if (pwm->unit == 0xFF) {
    return false;
  }
  if (pwm->unit >= hw_pwm_count()) {
    return false;
  }
  return true;
}

void hw_pwm_finalize(hw_pwm_t *pwm);

// CONFIGURATION

uint8_t hw_pwm_gpio_unit(uint8_t gpio);

hw_pwm_config_t hw_pwm_get_config(float freq);

float hw_pwm_get_freq(hw_pwm_config_t *config);

void hw_pwm_set_config(hw_pwm_t *pwm, const hw_pwm_config_t *config);

// CONTROL

bool hw_pwm_start(hw_pwm_t *pwm, uint8_t gpio, float duty_percent);

void hw_pwm_stop(hw_pwm_t *pwm);

// INTERRUPT HANDLING

void hw_pwm_set_callback(hw_pwm_callback_t callback, void *userdata);

void hw_pwm_set_irq_enabled(hw_pwm_t *pwm, bool enabled);