fix: Update BSP components to have proper sizing for the max transfer size of their SPI buses (#515)

* fix: Update BSP components to have proper sizing for the max transfer size of their SPI buses

* fix display driver example missing include

Author: finger563

components/byte90/include/byte90.hpp

@@ -6,6 +6,7 @@
 
 #include <driver/gpio.h>
 #include <driver/spi_master.h>
+#include <hal/spi_ll.h>
 #include <hal/spi_types.h>
 
 #include "adxl345.hpp"
@@ -60,6 +61,10 @@ class Byte90 : public BaseComponent {
   /// Alias for the pixel type used by the Byte90 display
   using Pixel = lv_color16_t;
 
+  /// Maximum number of bytes that can be transferred in a single SPI
+  /// transaction to the Display. 32k on the ESP32-S3.
+  static constexpr size_t SPI_MAX_TRANSFER_BYTES = SPI_LL_DMA_MAX_BIT_LEN / 8;
+
   /// Alias for the display driver used by the Byte90 display
   using DisplayDriver = espp::Ssd1351;
 

components/byte90/src/byte90.cpp

@@ -21,7 +21,7 @@ bool Byte90::init_spi_bus() {
   bus_cfg.sclk_io_num = spi_sclk_io;
   bus_cfg.quadwp_io_num = -1;
   bus_cfg.quadhd_io_num = -1;
-  bus_cfg.max_transfer_sz = frame_buffer_size * sizeof(lv_color_t) + 100;
+  bus_cfg.max_transfer_sz = SPI_MAX_TRANSFER_BYTES;
   auto ret = spi_bus_initialize(spi_num, &bus_cfg, SPI_DMA_CH_AUTO);
   if (ret != ESP_OK) {
     logger_.error("Failed to initialize bus.");

components/display_drivers/example/main/display_drivers_example.cpp

@@ -2,9 +2,11 @@
 #include <memory>
 #include <vector>
 
+#include <driver/spi_master.h>
+#include <hal/spi_ll.h>
+#include <hal/spi_types.h>
+
 #include "display.hpp"
-#include "driver/spi_master.h"
-#include "hal/spi_types.h"
 
 // default, most displays use 16-bit coordinates
 #define DISPLAY_COORDINATES_16BIT 1
@@ -506,6 +508,11 @@ extern "C" void app_main(void) {
   //! [byte90_config example]
 #endif
 
+  /// Maximum number of bytes that can be transferred in a single SPI
+  /// transaction to the Display. 2MB on ESP32, 1MB on ESP32-S2, 32k on the
+  /// ESP32-S3.
+  static constexpr size_t SPI_MAX_TRANSFER_BYTES = SPI_LL_DMA_MAX_BIT_LEN / 8;
+
   fmt::print("Starting display_drivers example for {}\n", dev_kit);
   {
 #ifdef CONFIG_T_ENCODER_PRO
@@ -534,7 +541,7 @@ extern "C" void app_main(void) {
     buscfg.quadhd_io_num = -1;
 #endif
     buscfg.sclk_io_num = sclk;
-    buscfg.max_transfer_sz = (int)(pixel_buffer_size * sizeof(lv_color_t));
+    buscfg.max_transfer_sz = SPI_MAX_TRANSFER_BYTES;
     // create the spi device
     spi_device_interface_config_t devcfg;
     memset(&devcfg, 0, sizeof(devcfg));

components/esp-box/include/esp-box.hpp

@@ -7,6 +7,7 @@
 #include <driver/gpio.h>
 #include <driver/i2s_std.h>
 #include <driver/spi_master.h>
+#include <hal/spi_ll.h>
 #include <hal/spi_types.h>
 
 #include <freertos/FreeRTOS.h>
@@ -62,6 +63,10 @@ class EspBox : public BaseComponent {
   /// Alias for the touch callback when touch events are received
   using touch_callback_t = std::function<void(const TouchpadData &)>;
 
+  /// Maximum number of bytes that can be transferred in a single SPI
+  /// transaction to the Display. 32k on the ESP32-S3.
+  static constexpr size_t SPI_MAX_TRANSFER_BYTES = SPI_LL_DMA_MAX_BIT_LEN / 8;
+
   /// The type of the box
   enum class BoxType {
     UNKNOWN, ///< unknown box

components/esp-box/src/video.cpp

@@ -65,7 +65,8 @@ bool EspBox::initialize_lcd() {
   lcd_spi_bus_config_.sclk_io_num = lcd_sclk_io;
   lcd_spi_bus_config_.quadwp_io_num = -1;
   lcd_spi_bus_config_.quadhd_io_num = -1;
-  lcd_spi_bus_config_.max_transfer_sz = frame_buffer_size * sizeof(lv_color_t) + 100;
+  // 32k on s3; we can use this because we enable DMA below
+  lcd_spi_bus_config_.max_transfer_sz = SPI_MAX_TRANSFER_BYTES;
 
   memset(&lcd_config_, 0, sizeof(lcd_config_));
   lcd_config_.mode = 0;

components/matouch-rotary-display/include/matouch-rotary-display.hpp

@@ -6,6 +6,7 @@
 
 #include <driver/gpio.h>
 #include <driver/spi_master.h>
+#include <hal/spi_ll.h>
 #include <hal/spi_types.h>
 
 #include "abi_encoder.hpp"
@@ -38,11 +39,23 @@ class MatouchRotaryDisplay : public BaseComponent {
   /// Alias for the pixel type used by the Matouch display
   using Pixel = lv_color16_t;
 
+  /// Maximum number of bytes that can be transferred in a single SPI
+  /// transaction to the Display. 32k on the ESP32-S3.
+  static constexpr size_t SPI_MAX_TRANSFER_BYTES = SPI_LL_DMA_MAX_BIT_LEN / 8;
+
   /// Alias for the display driver used by the Matouch display
   using DisplayDriver = espp::Gc9a01;
+
+  /// Alias for the touchpad driver used by the Matouch display
   using TouchpadData = espp::TouchpadData;
+
+  /// Alias for the Encoder used by the Matouch display
   using Encoder = espp::AbiEncoder<espp::EncoderType::ROTATIONAL>;
+
+  /// Alias for the button callback function type
   using button_callback_t = espp::Interrupt::event_callback_fn;
+
+  /// Alias for the touch callback function type
   using touch_callback_t = std::function<void(const TouchpadData &)>;
 
   /// @brief Access the singleton instance of the MatouchRotaryDisplay class

components/matouch-rotary-display/src/matouch-rotary-display.cpp

@@ -236,7 +236,7 @@ bool MatouchRotaryDisplay::initialize_lcd() {
   lcd_spi_bus_config_.sclk_io_num = lcd_sclk_io;
   lcd_spi_bus_config_.quadwp_io_num = -1;
   lcd_spi_bus_config_.quadhd_io_num = -1;
-  lcd_spi_bus_config_.max_transfer_sz = frame_buffer_size * sizeof(lv_color_t) + 100;
+  lcd_spi_bus_config_.max_transfer_sz = SPI_MAX_TRANSFER_BYTES;
 
   memset(&lcd_config_, 0, sizeof(lcd_config_));
   lcd_config_.mode = 0;

components/seeed-studio-round-display/include/seeed-studio-round-display.hpp

@@ -4,6 +4,7 @@
 
 #include <driver/gpio.h>
 #include <driver/spi_master.h>
+#include <hal/spi_ll.h>
 #include <hal/spi_types.h>
 
 #include "chsc6x.hpp"
@@ -37,6 +38,10 @@ class SsRoundDisplay : public espp::BaseComponent {
   using TouchDriver = espp::Chsc6x;        ///< Alias for the touch driver.
   using TouchpadData = espp::TouchpadData; ///< Alias for the touchpad data.
 
+  /// Maximum number of bytes that can be transferred in a single SPI
+  /// transaction to the Display. 32k on the ESP32-S3.
+  static constexpr size_t SPI_MAX_TRANSFER_BYTES = SPI_LL_DMA_MAX_BIT_LEN / 8;
+
   /// The touch callback function type
   /// \param data The touchpad data
   using touch_callback_t = std::function<void(const TouchpadData &)>;

components/seeed-studio-round-display/src/seeed-studio-round-display.cpp

@@ -195,7 +195,7 @@ bool SsRoundDisplay::initialize_lcd() {
   lcd_spi_bus_config_.sclk_io_num = pin_config_.sck;
   lcd_spi_bus_config_.quadwp_io_num = -1;
   lcd_spi_bus_config_.quadhd_io_num = -1;
-  lcd_spi_bus_config_.max_transfer_sz = frame_buffer_size * sizeof(lv_color_t) + 100;
+  lcd_spi_bus_config_.max_transfer_sz = SPI_MAX_TRANSFER_BYTES;
 
   memset(&lcd_config_, 0, sizeof(lcd_config_));
   lcd_config_.mode = 0;

components/t-deck/include/t-deck.hpp

@@ -12,6 +12,7 @@
 #include <driver/gpio.h>
 #include <driver/i2s_std.h>
 #include <driver/spi_master.h>
+#include <hal/spi_ll.h>
 #include <hal/spi_types.h>
 
 #include <freertos/FreeRTOS.h>
@@ -61,6 +62,10 @@ class TDeck : public BaseComponent {
   /// Alias for the pixel type used by the TDeck display
   using Pixel = lv_color16_t;
 
+  /// Maximum number of bytes that can be transferred in a single SPI
+  /// transaction to the Display. 32k on the ESP32-S3.
+  static constexpr size_t SPI_MAX_TRANSFER_BYTES = SPI_LL_DMA_MAX_BIT_LEN / 8;
+
   /// Alias for the keypress callback for keyboard keypresses.
   using keypress_callback_t = TKeyboard::key_cb_fn;