Rename Boards/ to Devices/ (#414)

Devices/m5stack-core2/CMakeLists.txt

@@ -0,0 +1,7 @@
+file(GLOB_RECURSE SOURCE_FILES Source/*.c*)
+
+idf_component_register(
+    SRCS ${SOURCE_FILES}
+    INCLUDE_DIRS "Source"
+    REQUIRES Tactility esp_lvgl_port esp_lcd AXP192 ILI934x FT6x36 driver vfs fatfs
+)

Devices/m5stack-core2/Source/Configuration.cpp

@@ -0,0 +1,111 @@
+#include "devices/Display.h"
+#include "devices/SdCard.h"
+#include "devices/Power.h"
+
+#include <Tactility/hal/Configuration.h>
+#include <Tactility/lvgl/LvglSync.h>
+
+using namespace tt::hal;
+
+bool initBoot() {
+    return initAxp();
+}
+
+static DeviceVector createDevices() {
+    return {
+        getAxp192(),
+        createSdCard(),
+        createDisplay()
+    };
+}
+
+extern const Configuration hardwareConfiguration = {
+    .initBoot = initBoot,
+    .createDevices = createDevices,
+    .i2c = {
+        i2c::Configuration {
+            .name = "Internal",
+            .port = I2C_NUM_0,
+            .initMode = i2c::InitMode::ByTactility,
+            .isMutable = false,
+            .config = (i2c_config_t) {
+                .mode = I2C_MODE_MASTER,
+                .sda_io_num = GPIO_NUM_21,
+                .scl_io_num = GPIO_NUM_22,
+                .sda_pullup_en = true,
+                .scl_pullup_en = true,
+                .master = {
+                    .clk_speed = 400000
+                },
+                .clk_flags = 0
+            }
+        },
+        i2c::Configuration {
+            .name = "Port A", // Grove
+            .port = I2C_NUM_1,
+            .initMode = i2c::InitMode::ByTactility,
+            .isMutable = true,
+            .config = (i2c_config_t) {
+                .mode = I2C_MODE_MASTER,
+                .sda_io_num = GPIO_NUM_32,
+                .scl_io_num = GPIO_NUM_33,
+                .sda_pullup_en = true,
+                .scl_pullup_en = true,
+                .master = {
+                    .clk_speed = 400000
+                },
+                .clk_flags = 0
+            }
+        }
+    },
+    .spi {
+        spi::Configuration {
+            .device = SPI2_HOST,
+            .dma = SPI_DMA_CH_AUTO,
+            .config = {
+                .mosi_io_num = GPIO_NUM_23,
+                .miso_io_num = GPIO_NUM_38,
+                .sclk_io_num = GPIO_NUM_18,
+                .quadwp_io_num = GPIO_NUM_NC, // Quad SPI LCD driver is not yet supported
+                .quadhd_io_num = GPIO_NUM_NC, // Quad SPI LCD driver is not yet supported
+                .data4_io_num = GPIO_NUM_NC,
+                .data5_io_num = GPIO_NUM_NC,
+                .data6_io_num = GPIO_NUM_NC,
+                .data7_io_num = GPIO_NUM_NC,
+                .data_io_default_level = false,
+                .max_transfer_sz = LCD_SPI_TRANSFER_SIZE_LIMIT,
+                .flags = 0,
+                .isr_cpu_id = ESP_INTR_CPU_AFFINITY_AUTO,
+                .intr_flags = 0
+            },
+            .initMode = spi::InitMode::ByTactility,
+            .isMutable = false,
+            .lock = tt::lvgl::getSyncLock() // esp_lvgl_port owns the lock for the display
+        }
+    },
+    .uart {
+        uart::Configuration {
+            .name = "Port A", // Grove
+            .port = UART_NUM_1,
+            .rxPin = GPIO_NUM_32,
+            .txPin = GPIO_NUM_33,
+            .rtsPin = GPIO_NUM_NC,
+            .ctsPin = GPIO_NUM_NC,
+            .rxBufferSize = 1024,
+            .txBufferSize = 1024,
+            .config = {
+                .baud_rate = 115200,
+                .data_bits = UART_DATA_8_BITS,
+                .parity    = UART_PARITY_DISABLE,
+                .stop_bits = UART_STOP_BITS_1,
+                .flow_ctrl = UART_HW_FLOWCTRL_DISABLE,
+                .rx_flow_ctrl_thresh = 0,
+                .source_clk = UART_SCLK_DEFAULT,
+                .flags = {
+                    .allow_pd = 0,
+                    .backup_before_sleep = 0,
+                }
+            }
+        },
+    }
+};

Devices/m5stack-core2/Source/devices/Display.cpp

@@ -0,0 +1,45 @@
+#include "Display.h"
+
+#include <Ft6x36Touch.h>
+#include <Ili934xDisplay.h>
+
+std::shared_ptr<tt::hal::touch::TouchDevice> createTouch() {
+    auto configuration = std::make_unique<Ft6x36Touch::Configuration>(
+        I2C_NUM_0,
+        GPIO_NUM_39,
+        LCD_HORIZONTAL_RESOLUTION,
+        LCD_VERTICAL_RESOLUTION
+    );
+
+    auto touch = std::make_shared<Ft6x36Touch>(std::move(configuration));
+    return std::reinterpret_pointer_cast<tt::hal::touch::TouchDevice>(touch);
+}
+
+std::shared_ptr<tt::hal::display::DisplayDevice> createDisplay() {
+    Ili934xDisplay::Configuration panel_configuration = {
+        .horizontalResolution = LCD_HORIZONTAL_RESOLUTION,
+        .verticalResolution = LCD_VERTICAL_RESOLUTION,
+        .gapX = 0,
+        .gapY = 0,
+        .swapXY = false,
+        .mirrorX = false,
+        .mirrorY = false,
+        .invertColor = true,
+        .swapBytes = true,
+        .bufferSize = LCD_BUFFER_SIZE,
+        .touch = createTouch(),
+        .backlightDutyFunction = nullptr,
+        .resetPin = GPIO_NUM_NC,
+        .rgbElementOrder = LCD_RGB_ELEMENT_ORDER_BGR
+    };
+
+    auto spi_configuration = std::make_shared<Ili934xDisplay::SpiConfiguration>(Ili934xDisplay::SpiConfiguration {
+        .spiHostDevice = LCD_SPI_HOST,
+        .csPin = LCD_PIN_CS,
+        .dcPin = LCD_PIN_DC,
+        .pixelClockFrequency = 40'000'000,
+        .transactionQueueDepth = 10
+    });
+
+    return std::make_shared<Ili934xDisplay>(panel_configuration, spi_configuration, true);
+}

Devices/m5stack-core2/Source/devices/Display.h

@@ -0,0 +1,17 @@
+#pragma once
+
+#include <Tactility/hal/display/DisplayDevice.h>
+#include <driver/gpio.h>
+#include <driver/spi_common.h>
+#include <memory>
+
+constexpr auto LCD_SPI_HOST = SPI2_HOST;
+constexpr auto LCD_PIN_CS = GPIO_NUM_5;
+constexpr auto LCD_PIN_DC = GPIO_NUM_15;
+constexpr auto LCD_HORIZONTAL_RESOLUTION = 320;
+constexpr auto LCD_VERTICAL_RESOLUTION = 240;
+constexpr auto LCD_BUFFER_HEIGHT = LCD_VERTICAL_RESOLUTION / 10;
+constexpr auto LCD_BUFFER_SIZE = LCD_HORIZONTAL_RESOLUTION * LCD_BUFFER_HEIGHT;
+constexpr auto LCD_SPI_TRANSFER_SIZE_LIMIT = LCD_BUFFER_SIZE * LV_COLOR_DEPTH / 8;
+
+std::shared_ptr<tt::hal::display::DisplayDevice> createDisplay();

Devices/m5stack-core2/Source/devices/Power.cpp

@@ -0,0 +1,35 @@
+#include <Axp192.h>
+
+static std::shared_ptr<Axp192> axp192 = nullptr;
+
+std::shared_ptr<Axp192> createAxp192() {
+    assert(axp192 == nullptr);
+    auto configuration = std::make_unique<Axp192::Configuration>(I2C_NUM_0);
+    axp192 = std::make_shared<Axp192>(std::move(configuration));
+    return axp192;
+}
+
+std::shared_ptr<Axp192> getAxp192() {
+    assert(axp192 != nullptr);
+    return axp192;
+}
+
+bool initAxp() {
+    const auto axp = createAxp192();
+    return axp->init([](auto* driver) {
+        axp192_ioctl(driver, AXP192_LDO2_SET_VOLTAGE, 3300); // LCD + SD
+        axp192_ioctl(driver, AXP192_LDO3_SET_VOLTAGE, 0); // VIB_MOTOR STOP
+        axp192_ioctl(driver, AXP192_DCDC3_SET_VOLTAGE, 3300);
+
+        axp192_ioctl(driver, AXP192_LDO2_ENABLE);
+        axp192_ioctl(driver, AXP192_LDO3_DISABLE);
+        axp192_ioctl(driver, AXP192_DCDC3_ENABLE);
+
+        axp192_write(driver, AXP192_PWM1_DUTY_CYCLE_2, 255); // PWM 255 (LED OFF)
+        axp192_write(driver, AXP192_GPIO1_CONTROL, 0x02); // GPIO1 PWM
+
+        // TODO: We could charge at 390mA according to the M5Unified code, but the AXP driver in M5Unified limits to 132mA, so it's unclear what the AXP supports.
+        return true;
+    });
+
+}

Devices/m5stack-core2/Source/devices/Power.h

@@ -0,0 +1,9 @@
+#pragma once
+
+#include <Axp192.h>
+
+bool initAxp();
+
+// Must call initAxp() first before this returns a non-nullptr response
+std::shared_ptr<Axp192> getAxp192();
+

Devices/m5stack-core2/Source/devices/SdCard.cpp

@@ -0,0 +1,27 @@
+#include "SdCard.h"
+
+#include <Tactility/hal/sdcard/SpiSdCardDevice.h>
+#include <Tactility/lvgl/LvglSync.h>
+
+constexpr auto CORE2_SDCARD_PIN_CS = GPIO_NUM_4;
+constexpr auto CORE2_LCD_PIN_CS = GPIO_NUM_5;
+
+using tt::hal::sdcard::SpiSdCardDevice;
+
+std::shared_ptr<SdCardDevice> createSdCard() {
+    auto configuration = std::make_unique<SpiSdCardDevice::Config>(
+        CORE2_SDCARD_PIN_CS,
+        GPIO_NUM_NC,
+        GPIO_NUM_NC,
+        GPIO_NUM_NC,
+        SdCardDevice::MountBehaviour::AtBoot,
+        tt::lvgl::getSyncLock(),
+        std::vector {
+            CORE2_LCD_PIN_CS
+        }
+    );
+
+    return std::make_shared<SpiSdCardDevice>(
+        std::move(configuration)
+    );
+}

Devices/m5stack-core2/Source/devices/SdCard.h

@@ -0,0 +1,7 @@
+#pragma once
+
+#include <Tactility/hal/sdcard/SdCardDevice.h>
+
+using tt::hal::sdcard::SdCardDevice;
+
+std::shared_ptr<SdCardDevice> createSdCard();

Devices/m5stack-core2/device.properties

@@ -0,0 +1,22 @@
+[general]
+vendor=M5Stack
+name=Core2
+
+[hardware]
+target=ESP32
+flashSize=16MB
+spiRam=true
+spiRamMode=QUAD
+spiRamSpeed=80M
+esptoolFlashFreq=80M
+
+[display]
+size=2"
+shape=rectangle
+dpi=200
+
+[cdn]
+warningMessage=This board implementation concerns the original Core2 hardware and **not** the v1.1 variant
+
+[lvgl]
+colorDepth=16