esphome 2024.12.3__py3-none-any.whl

esphome/components/rp2040/preferences.cpp

@@ -0,0 +1,160 @@
+#ifdef USE_RP2040
+
+#include <Arduino.h>
+
+#include <hardware/flash.h>
+#include <hardware/sync.h>
+
+#include "preferences.h"
+
+#include <cstring>
+#include <vector>
+
+#include "esphome/core/helpers.h"
+#include "esphome/core/log.h"
+#include "esphome/core/preferences.h"
+
+namespace esphome {
+namespace rp2040 {
+
+static const char *const TAG = "rp2040.preferences";
+
+static bool s_prevent_write = false;        // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
+static uint8_t *s_flash_storage = nullptr;  // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
+static bool s_flash_dirty = false;          // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
+
+static const uint32_t RP2040_FLASH_STORAGE_SIZE = 512;
+
+extern "C" uint8_t _EEPROM_start;
+
+template<class It> uint8_t calculate_crc(It first, It last, uint32_t type) {
+  std::array<uint8_t, 4> type_array = decode_value(type);
+  uint8_t crc = type_array[0] ^ type_array[1] ^ type_array[2] ^ type_array[3];
+  while (first != last) {
+    crc ^= (*first++);
+  }
+  return crc;
+}
+
+class RP2040PreferenceBackend : public ESPPreferenceBackend {
+ public:
+  size_t offset = 0;
+  uint32_t type = 0;
+
+  bool save(const uint8_t *data, size_t len) override {
+    std::vector<uint8_t> buffer;
+    buffer.resize(len + 1);
+    memcpy(buffer.data(), data, len);
+    buffer[buffer.size() - 1] = calculate_crc(buffer.begin(), buffer.end() - 1, type);
+
+    for (uint32_t i = 0; i < len + 1; i++) {
+      uint32_t j = offset + i;
+      if (j >= RP2040_FLASH_STORAGE_SIZE)
+        return false;
+      uint8_t v = buffer[i];
+      uint8_t *ptr = &s_flash_storage[j];
+      if (*ptr != v)
+        s_flash_dirty = true;
+      *ptr = v;
+    }
+    return true;
+  }
+  bool load(uint8_t *data, size_t len) override {
+    std::vector<uint8_t> buffer;
+    buffer.resize(len + 1);
+
+    for (size_t i = 0; i < len + 1; i++) {
+      uint32_t j = offset + i;
+      if (j >= RP2040_FLASH_STORAGE_SIZE)
+        return false;
+      buffer[i] = s_flash_storage[j];
+    }
+
+    uint8_t crc = calculate_crc(buffer.begin(), buffer.end() - 1, type);
+    if (buffer[buffer.size() - 1] != crc) {
+      return false;
+    }
+
+    memcpy(data, buffer.data(), len);
+    return true;
+  }
+};
+
+class RP2040Preferences : public ESPPreferences {
+ public:
+  uint32_t current_flash_offset = 0;
+
+  RP2040Preferences() : eeprom_sector_(&_EEPROM_start) {}
+  void setup() {
+    s_flash_storage = new uint8_t[RP2040_FLASH_STORAGE_SIZE];  // NOLINT
+    ESP_LOGVV(TAG, "Loading preferences from flash...");
+    memcpy(s_flash_storage, this->eeprom_sector_, RP2040_FLASH_STORAGE_SIZE);
+  }
+
+  ESPPreferenceObject make_preference(size_t length, uint32_t type, bool in_flash) override {
+    return make_preference(length, type);
+  }
+
+  ESPPreferenceObject make_preference(size_t length, uint32_t type) override {
+    uint32_t start = this->current_flash_offset;
+    uint32_t end = start + length + 1;
+    if (end > RP2040_FLASH_STORAGE_SIZE) {
+      return {};
+    }
+    auto *pref = new RP2040PreferenceBackend();  // NOLINT(cppcoreguidelines-owning-memory)
+    pref->offset = start;
+    pref->type = type;
+    current_flash_offset = end;
+    return {pref};
+  }
+
+  bool sync() override {
+    if (!s_flash_dirty)
+      return true;
+    if (s_prevent_write)
+      return false;
+
+    ESP_LOGD(TAG, "Saving preferences to flash...");
+
+    {
+      InterruptLock lock;
+      ::rp2040.idleOtherCore();
+      flash_range_erase((intptr_t) eeprom_sector_ - (intptr_t) XIP_BASE, 4096);
+      flash_range_program((intptr_t) eeprom_sector_ - (intptr_t) XIP_BASE, s_flash_storage, RP2040_FLASH_STORAGE_SIZE);
+      ::rp2040.resumeOtherCore();
+    }
+
+    s_flash_dirty = false;
+    return true;
+  }
+
+  bool reset() override {
+    ESP_LOGD(TAG, "Cleaning up preferences in flash...");
+    {
+      InterruptLock lock;
+      ::rp2040.idleOtherCore();
+      flash_range_erase((intptr_t) eeprom_sector_ - (intptr_t) XIP_BASE, 4096);
+      ::rp2040.resumeOtherCore();
+    }
+    s_prevent_write = true;
+    return true;
+  }
+
+ protected:
+  uint8_t *eeprom_sector_;
+};
+
+void setup_preferences() {
+  auto *prefs = new RP2040Preferences();  // NOLINT(cppcoreguidelines-owning-memory)
+  prefs->setup();
+  global_preferences = prefs;
+}
+void preferences_prevent_write(bool prevent) { s_prevent_write = prevent; }
+
+}  // namespace rp2040
+
+ESPPreferences *global_preferences;  // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
+
+}  // namespace esphome
+
+#endif  // USE_RP2040

esphome/components/rp2040/preferences.h

@@ -0,0 +1,14 @@
+#pragma once
+
+#ifdef USE_RP2040
+
+namespace esphome {
+namespace rp2040 {
+
+void setup_preferences();
+void preferences_prevent_write(bool prevent);
+
+}  // namespace rp2040
+}  // namespace esphome
+
+#endif  // USE_RP2040

esphome/components/rp2040_pio/__init__.py

@@ -0,0 +1,40 @@
+import platform
+
+import esphome.codegen as cg
+
+
+DEPENDENCIES = ["rp2040"]
+
+
+PIOASM_REPO_VERSION = "1.5.0-b"
+PIOASM_REPO_BASE = f"https://github.com/earlephilhower/pico-quick-toolchain/releases/download/{PIOASM_REPO_VERSION}"
+PIOASM_VERSION = "pioasm-2e6142b.230216"
+PIOASM_DOWNLOADS = {
+    "linux": {
+        "aarch64": f"aarch64-linux-gnu.{PIOASM_VERSION}.tar.gz",
+        "armv7l": f"arm-linux-gnueabihf.{PIOASM_VERSION}.tar.gz",
+        "x86_64": f"x86_64-linux-gnu.{PIOASM_VERSION}.tar.gz",
+    },
+    "windows": {
+        "amd64": f"x86_64-w64-mingw32.{PIOASM_VERSION}.zip",
+    },
+    "darwin": {
+        "x86_64": f"x86_64-apple-darwin14.{PIOASM_VERSION}.tar.gz",
+        "arm64": f"x86_64-apple-darwin14.{PIOASM_VERSION}.tar.gz",
+    },
+}
+
+
+async def to_code(config):
+    # cg.add_platformio_option(
+    #     "platform_packages",
+    #     [
+    #         "earlephilhower/tool-pioasm-rp2040-earlephilhower",
+    #     ],
+    # )
+    file = PIOASM_DOWNLOADS[platform.system().lower()][platform.machine().lower()]
+    cg.add_platformio_option(
+        "platform_packages",
+        [f"earlephilhower/tool-pioasm-rp2040-earlephilhower@{PIOASM_REPO_BASE}/{file}"],
+    )
+    cg.add_platformio_option("extra_scripts", ["pre:build_pio.py"])

esphome/components/rp2040_pio_led_strip/__init__.py

@@ -0,0 +1 @@
+CODEOWNERS = ["@Papa-DMan"]

esphome/components/rp2040_pio_led_strip/led_strip.cpp

@@ -0,0 +1,215 @@
+#include "led_strip.h"
+
+#ifdef USE_RP2040
+
+#include "esphome/core/helpers.h"
+#include "esphome/core/log.h"
+
+#include <hardware/clocks.h>
+#include <hardware/dma.h>
+#include <hardware/irq.h>
+#include <hardware/pio.h>
+#include <pico/stdlib.h>
+#include <pico/sem.h>
+
+namespace esphome {
+namespace rp2040_pio_led_strip {
+
+static const char *TAG = "rp2040_pio_led_strip";
+
+static uint8_t num_instance_[2] = {0, 0};
+static std::map<Chipset, uint> chipset_offsets_ = {
+    {CHIPSET_WS2812, 0}, {CHIPSET_WS2812B, 0}, {CHIPSET_SK6812, 0}, {CHIPSET_SM16703, 0}, {CHIPSET_CUSTOM, 0},
+};
+static std::map<Chipset, bool> conf_count_ = {
+    {CHIPSET_WS2812, false},  {CHIPSET_WS2812B, false}, {CHIPSET_SK6812, false},
+    {CHIPSET_SM16703, false}, {CHIPSET_CUSTOM, false},
+};
+static bool dma_chan_active_[12];
+static struct semaphore dma_write_complete_sem_[12];
+
+// DMA interrupt service routine
+void RP2040PIOLEDStripLightOutput::dma_write_complete_handler_() {
+  uint32_t channel = dma_hw->ints0;
+  for (uint dma_chan = 0; dma_chan < 12; ++dma_chan) {
+    if (RP2040PIOLEDStripLightOutput::dma_chan_active_[dma_chan] && (channel & (1u << dma_chan))) {
+      dma_hw->ints0 = (1u << dma_chan);                                               // Clear the interrupt
+      sem_release(&RP2040PIOLEDStripLightOutput::dma_write_complete_sem_[dma_chan]);  // Handle the interrupt
+    }
+  }
+}
+
+void RP2040PIOLEDStripLightOutput::setup() {
+  ESP_LOGCONFIG(TAG, "Setting up RP2040 LED Strip...");
+
+  size_t buffer_size = this->get_buffer_size_();
+
+  ExternalRAMAllocator<uint8_t> allocator(ExternalRAMAllocator<uint8_t>::ALLOW_FAILURE);
+  this->buf_ = allocator.allocate(buffer_size);
+  if (this->buf_ == nullptr) {
+    ESP_LOGE(TAG, "Failed to allocate buffer of size %u", buffer_size);
+    this->mark_failed();
+    return;
+  }
+
+  this->effect_data_ = allocator.allocate(this->num_leds_);
+  if (this->effect_data_ == nullptr) {
+    ESP_LOGE(TAG, "Failed to allocate effect data of size %u", this->num_leds_);
+    this->mark_failed();
+    return;
+  }
+
+  // Initialize the PIO program
+
+  // Select PIO instance to use (0 or 1)
+  if (this->pio_ == nullptr) {
+    ESP_LOGE(TAG, "Failed to claim PIO instance");
+    this->mark_failed();
+    return;
+  }
+
+  // if there are multiple strips, we can reuse the same PIO program and save space
+  // but there are only 4 state machines on each PIO so we can only have 4 strips per PIO
+  uint offset = 0;
+
+  if (RP2040PIOLEDStripLightOutput::num_instance_[this->pio_ == pio0 ? 0 : 1] > 4) {
+    ESP_LOGE(TAG, "Too many instances of PIO program");
+    this->mark_failed();
+    return;
+  }
+  // keep track of how many instances of the PIO program are running on each PIO
+  RP2040PIOLEDStripLightOutput::num_instance_[this->pio_ == pio0 ? 0 : 1]++;
+
+  // if there are multiple strips of the same chipset, we can reuse the same PIO program and save space
+  if (this->conf_count_[this->chipset_]) {
+    offset = RP2040PIOLEDStripLightOutput::chipset_offsets_[this->chipset_];
+  } else {
+    // Load the assembled program into the PIO and get its location in the PIO's instruction memory and save it
+    offset = pio_add_program(this->pio_, this->program_);
+    RP2040PIOLEDStripLightOutput::chipset_offsets_[this->chipset_] = offset;
+    RP2040PIOLEDStripLightOutput::conf_count_[this->chipset_] = true;
+  }
+
+  // Configure the state machine's PIO, and start it
+  this->sm_ = pio_claim_unused_sm(this->pio_, true);
+  if (this->sm_ < 0) {
+    // in theory this code should never be reached
+    ESP_LOGE(TAG, "Failed to claim PIO state machine");
+    this->mark_failed();
+    return;
+  }
+
+  // Initalize the DMA channel (Note: There are 12 DMA channels and 8 state machines so we won't run out)
+
+  this->dma_chan_ = dma_claim_unused_channel(true);
+  if (this->dma_chan_ < 0) {
+    ESP_LOGE(TAG, "Failed to claim DMA channel");
+    this->mark_failed();
+    return;
+  }
+
+  // Mark the DMA channel as active
+  RP2040PIOLEDStripLightOutput::dma_chan_active_[this->dma_chan_] = true;
+
+  this->dma_config_ = dma_channel_get_default_config(this->dma_chan_);
+  channel_config_set_transfer_data_size(
+      &this->dma_config_,
+      DMA_SIZE_8);  // 8 bit transfers (could be 32 but the pio program would need to be changed to handle junk data)
+  channel_config_set_read_increment(&this->dma_config_, true);    // increment the read address
+  channel_config_set_write_increment(&this->dma_config_, false);  // don't increment the write address
+  channel_config_set_dreq(&this->dma_config_,
+                          pio_get_dreq(this->pio_, this->sm_, true));  // set the DREQ to the state machine's TX FIFO
+
+  dma_channel_configure(this->dma_chan_, &this->dma_config_,
+                        &this->pio_->txf[this->sm_],                     // write to the state machine's TX FIFO
+                        this->buf_,                                      // read from memory
+                        this->is_rgbw_ ? num_leds_ * 4 : num_leds_ * 3,  // number of bytes to transfer
+                        false                                            // don't start yet
+  );
+
+  // Initialize the semaphore for this DMA channel
+  sem_init(&RP2040PIOLEDStripLightOutput::dma_write_complete_sem_[this->dma_chan_], 1, 1);
+
+  irq_set_exclusive_handler(DMA_IRQ_0, dma_write_complete_handler_);  // after DMA all data, raise an interrupt
+  dma_channel_set_irq0_enabled(this->dma_chan_, true);                // map DMA channel to interrupt
+  irq_set_enabled(DMA_IRQ_0, true);                                   // enable interrupt
+
+  this->init_(this->pio_, this->sm_, offset, this->pin_, this->max_refresh_rate_);
+}
+
+void RP2040PIOLEDStripLightOutput::write_state(light::LightState *state) {
+  ESP_LOGVV(TAG, "Writing state...");
+
+  if (this->is_failed()) {
+    ESP_LOGW(TAG, "Light is in failed state, not writing state.");
+    return;
+  }
+
+  if (this->buf_ == nullptr) {
+    ESP_LOGW(TAG, "Buffer is null, not writing state.");
+    return;
+  }
+
+  // the bits are already in the correct order for the pio program so we can just copy the buffer using DMA
+  sem_acquire_blocking(&RP2040PIOLEDStripLightOutput::dma_write_complete_sem_[this->dma_chan_]);
+  dma_channel_transfer_from_buffer_now(this->dma_chan_, this->buf_, this->get_buffer_size_());
+}
+
+light::ESPColorView RP2040PIOLEDStripLightOutput::get_view_internal(int32_t index) const {
+  int32_t r = 0, g = 0, b = 0, w = 0;
+  switch (this->rgb_order_) {
+    case ORDER_RGB:
+      r = 0;
+      g = 1;
+      b = 2;
+      break;
+    case ORDER_RBG:
+      r = 0;
+      g = 2;
+      b = 1;
+      break;
+    case ORDER_GRB:
+      r = 1;
+      g = 0;
+      b = 2;
+      break;
+    case ORDER_GBR:
+      r = 2;
+      g = 0;
+      b = 1;
+      break;
+    case ORDER_BGR:
+      r = 2;
+      g = 1;
+      b = 0;
+      break;
+    case ORDER_BRG:
+      r = 1;
+      g = 2;
+      b = 0;
+      break;
+  }
+  uint8_t multiplier = this->is_rgbw_ ? 4 : 3;
+  return {this->buf_ + (index * multiplier) + r,
+          this->buf_ + (index * multiplier) + g,
+          this->buf_ + (index * multiplier) + b,
+          this->is_rgbw_ ? this->buf_ + (index * multiplier) + 3 : nullptr,
+          &this->effect_data_[index],
+          &this->correction_};
+}
+
+void RP2040PIOLEDStripLightOutput::dump_config() {
+  ESP_LOGCONFIG(TAG, "RP2040 PIO LED Strip Light Output:");
+  ESP_LOGCONFIG(TAG, "  Pin: GPIO%d", this->pin_);
+  ESP_LOGCONFIG(TAG, "  Number of LEDs: %d", this->num_leds_);
+  ESP_LOGCONFIG(TAG, "  RGBW: %s", YESNO(this->is_rgbw_));
+  ESP_LOGCONFIG(TAG, "  RGB Order: %s", rgb_order_to_string(this->rgb_order_));
+  ESP_LOGCONFIG(TAG, "  Max Refresh Rate: %f Hz", this->max_refresh_rate_);
+}
+
+float RP2040PIOLEDStripLightOutput::get_setup_priority() const { return setup_priority::HARDWARE; }
+
+}  // namespace rp2040_pio_led_strip
+}  // namespace esphome
+
+#endif

esphome/components/rp2040_pio_led_strip/led_strip.h

@@ -0,0 +1,133 @@
+#pragma once
+
+#ifdef USE_RP2040
+
+#include "esphome/core/color.h"
+#include "esphome/core/component.h"
+#include "esphome/core/helpers.h"
+
+#include "esphome/components/light/addressable_light.h"
+#include "esphome/components/light/light_output.h"
+
+#include <hardware/dma.h>
+#include <hardware/pio.h>
+#include <hardware/structs/pio.h>
+#include <pico/stdio.h>
+#include <pico/sem.h>
+#include <map>
+
+namespace esphome {
+namespace rp2040_pio_led_strip {
+
+enum RGBOrder : uint8_t {
+  ORDER_RGB,
+  ORDER_RBG,
+  ORDER_GRB,
+  ORDER_GBR,
+  ORDER_BGR,
+  ORDER_BRG,
+};
+
+enum Chipset : uint8_t {
+  CHIPSET_WS2812,
+  CHIPSET_WS2812B,
+  CHIPSET_SK6812,
+  CHIPSET_SM16703,
+  CHIPSET_APA102,
+  CHIPSET_CUSTOM = 0xFF,
+};
+
+inline const char *rgb_order_to_string(RGBOrder order) {
+  switch (order) {
+    case ORDER_RGB:
+      return "RGB";
+    case ORDER_RBG:
+      return "RBG";
+    case ORDER_GRB:
+      return "GRB";
+    case ORDER_GBR:
+      return "GBR";
+    case ORDER_BGR:
+      return "BGR";
+    case ORDER_BRG:
+      return "BRG";
+    default:
+      return "UNKNOWN";
+  }
+}
+
+using init_fn = void (*)(PIO pio, uint sm, uint offset, uint pin, float freq);
+
+class RP2040PIOLEDStripLightOutput : public light::AddressableLight {
+ public:
+  void setup() override;
+  void write_state(light::LightState *state) override;
+  float get_setup_priority() const override;
+
+  int32_t size() const override { return this->num_leds_; }
+  light::LightTraits get_traits() override {
+    auto traits = light::LightTraits();
+    this->is_rgbw_ ? traits.set_supported_color_modes({light::ColorMode::RGB_WHITE, light::ColorMode::WHITE})
+                   : traits.set_supported_color_modes({light::ColorMode::RGB});
+    return traits;
+  }
+  void set_pin(uint8_t pin) { this->pin_ = pin; }
+  void set_num_leds(uint32_t num_leds) { this->num_leds_ = num_leds; }
+  void set_is_rgbw(bool is_rgbw) { this->is_rgbw_ = is_rgbw; }
+
+  void set_max_refresh_rate(float interval_us) { this->max_refresh_rate_ = interval_us; }
+
+  void set_pio(int pio_num) { pio_num ? this->pio_ = pio1 : this->pio_ = pio0; }
+  void set_program(const pio_program_t *program) { this->program_ = program; }
+  void set_init_function(init_fn init) { this->init_ = init; }
+
+  void set_chipset(Chipset chipset) { this->chipset_ = chipset; };
+  void set_rgb_order(RGBOrder rgb_order) { this->rgb_order_ = rgb_order; }
+  void clear_effect_data() override {
+    for (int i = 0; i < this->size(); i++) {
+      this->effect_data_[i] = 0;
+    }
+  }
+
+  void dump_config() override;
+
+ protected:
+  light::ESPColorView get_view_internal(int32_t index) const override;
+
+  size_t get_buffer_size_() const { return this->num_leds_ * (3 + this->is_rgbw_); }
+
+  static void dma_write_complete_handler_();
+
+  uint8_t *buf_{nullptr};
+  uint8_t *effect_data_{nullptr};
+
+  uint8_t pin_;
+  uint32_t num_leds_;
+  bool is_rgbw_;
+
+  pio_hw_t *pio_;
+  uint sm_;
+  uint dma_chan_;
+  dma_channel_config dma_config_;
+
+  RGBOrder rgb_order_{ORDER_RGB};
+  Chipset chipset_{CHIPSET_CUSTOM};
+
+  uint32_t last_refresh_{0};
+  float max_refresh_rate_;
+
+  const pio_program_t *program_;
+  init_fn init_;
+
+ private:
+  inline static int num_instance_[2];
+  inline static std::map<Chipset, bool> conf_count_;
+  inline static std::map<Chipset, int> chipset_offsets_;
+  inline static bool dma_chan_active_[12];
+  inline static struct semaphore dma_write_complete_sem_[12];
+};
+
+}  // namespace rp2040_pio_led_strip
+}  // namespace esphome
+
+#endif  // USE_RP2040