adds spi3wire as a user c module/

Author: kdschlosser

api_drivers/common_api_drivers/frozen/other/spi3wire.py

@@ -1,3 +1,8 @@
+
+#  ******* NOTICE ********
+# This module is no longer used.
+
+
 from micropython import const  # NOQA
 import machine  # NOQA
 

builder/esp32.py

@@ -682,8 +682,8 @@ def build_manifest(
 
     set_displays.extend(generate_manifest(
         script_dir, lvgl_api, manifest_path,
-        displays, indevs, expanders, frozen_manifest,
-        f'{script_dir}/api_drivers/common_api_drivers/frozen/other/spi3wire.py'
+        displays, indevs, expanders, frozen_manifest
+        # f'{script_dir}/api_drivers/common_api_drivers/frozen/other/spi3wire.py'
     ))
 
 
@@ -1213,7 +1213,8 @@ def update_main():
         '',
         '#include "../../../../ext_mod/lcd_bus/esp32_include/spi_bus.h"',
         '#include "../../../../ext_mod/lcd_bus/esp32_include/i2c_bus.h"',
-        '#include "../../../../micropy_updates/common/mp_spi_common.h"'
+        '#include "../../../../ext_mod/spi3wire/include/spi3wire.h"',
+        '#include "../../../../micropy_updates/common/mp_spi_common.h"',
         '',
         '#if MICROPY_BLUETOOTH_NIMBLE'
     ]
@@ -1239,6 +1240,8 @@ def update_main():
         '    ',
         '    mp_lcd_i2c_bus_deinit_all();',
         '    ',
+        '    mp_spi3wire_deinit_all();',
+        '    ',
         '    machine_hw_spi_bus_deinit_all();'
     ]
 

ext_mod/micropython.cmake

@@ -1,5 +1,6 @@
 if(ESP_PLATFORM)
     include(${CMAKE_CURRENT_LIST_DIR}/esp32_components.cmake)
+    include(${CMAKE_CURRENT_LIST_DIR}/spi3wire/micropython.cmake)
 endif(ESP_PLATFORM)
 
 include(${CMAKE_CURRENT_LIST_DIR}/lcd_bus/micropython.cmake)

ext_mod/spi3wire/include/esp_lcd_panel_io_additions.h

@@ -0,0 +1,68 @@
+/*
+ * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include <stdint.h>
+
+#include "esp_lcd_types.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Maximum SPI clock speed
+#define PANEL_IO_3WIRE_SPI_CLK_MAX      (500 * 1000UL)
+
+/**
+ * @brief SPI line configuration structure
+ */
+typedef struct {
+    int cs_gpio_num;                            /*!< GPIO used for CS line */
+    int scl_gpio_num;                           /*!< GPIO used for SCL line */
+    int sda_gpio_num;                           /*!< GPIO used for SDA line */
+} spi_line_config_t;
+
+/**
+ * @brief Panel IO configuration structure
+ */
+
+typedef struct {
+    spi_line_config_t line_config;  /*!< SPI line configuration */
+    uint32_t expect_clk_speed;      /*!< Expected SPI clock speed, in Hz (1 ~ 500000
+                                     *   If this value is 0, it will be set to `PANEL_IO_3WIRE_SPI_CLK_MAX` by default
+                                     *   The actual frequency may be very different due to the limitation of the software delay */
+    uint32_t spi_mode: 2;           /*!< Traditional SPI mode (0 ~ 3) */
+    uint32_t lcd_cmd_bytes: 3;      /*!< Bytes of LCD command (1 ~ 4) */
+    uint32_t lcd_param_bytes: 3;    /*!< Bytes of LCD parameter (1 ~ 4) */
+    struct {
+        uint32_t use_dc_bit: 1;             /*!< If this flag is enabled, transmit DC bit at the beginning of every command and data */
+        uint32_t dc_zero_on_data: 1;        /*!< If this flag is enabled, DC bit = 0 means transfer data, DC bit = 1 means transfer command */
+        uint32_t lsb_first: 1;              /*!< If this flag is enabled, transmit LSB bit first */
+        uint32_t cs_high_active: 1;         /*!< If this flag is enabled, CS line is high active */
+        uint32_t del_keep_cs_inactive: 1;   /*!< If this flag is enabled, keep CS line inactive even if panel_io is deleted */
+    } flags;
+} esp_lcd_panel_io_3wire_spi_config_t;
+
+/**
+ * @brief Create a new panel IO instance for 3-wire SPI interface (simulate by software)
+ *
+ * @note  This function uses GPIO or IO expander to simulate SPI interface by software and just supports to write data.
+ *        It is only suitable for some applications with low speed SPI interface. (Such as initializing RGB panel)
+ *
+ * @param[in]  io_config Panel IO configuration
+ * @param[out] ret_io    Pointer to return the created panel IO instance
+ * @return
+ *      - ESP_OK:              Success
+ *      - ESP_ERR_INVALID_ARG: Invalid argument
+ *      - ESP_ERR_NO_MEM:      Failed to allocate memory for panel IO instance
+ *      - Others:              Fail
+ */
+esp_err_t esp_lcd_new_panel_io_3wire_spi(const esp_lcd_panel_io_3wire_spi_config_t *io_config, esp_lcd_panel_io_handle_t *ret_io);
+
+#ifdef __cplusplus
+}
+#endif

ext_mod/spi3wire/include/spi3wire.h

@@ -0,0 +1,25 @@
+
+
+#ifndef __SPI3WIRE_H__
+    #define __SPI3WIRE_H__
+
+    // micropython includes
+    #include "mphalport.h"
+    #include "py/obj.h"
+
+    #include "esp_lcd_panel_io_additions.h"
+    #include "esp_lcd_panel_io.h"
+
+
+    typedef struct {
+        mp_obj_base_t base;
+
+        esp_lcd_panel_io_handle_t panel_io_handle;
+        esp_lcd_panel_io_3wire_spi_config_t *io_config;
+    } mp_spi3wire_obj_t;
+
+    extern const mp_obj_type_t mp_spi3wire_type;
+
+    extern void mp_spi3wire_deinit_all(void);
+
+#endif

ext_mod/spi3wire/micropython.cmake

@@ -0,0 +1,22 @@
+# Create an INTERFACE library for our C module.
+add_library(usermod_spi3wire INTERFACE)
+
+set(SPI3WIRE_INCLUDES
+    ${CMAKE_CURRENT_LIST_DIR}
+    ${CMAKE_CURRENT_LIST_DIR}/include
+)
+
+set(SPI3WIRE_SOURCES
+    ${CMAKE_CURRENT_LIST_DIR}/src/spi3wire.c
+    ${CMAKE_CURRENT_LIST_DIR}/src/esp_lcd_panel_io_3wire_spi.c
+)
+
+
+# Add our source files to the lib
+target_sources(usermod_spi3wire INTERFACE ${SPI3WIRE_SOURCES})
+
+# Add include directories.
+target_include_directories(usermod_spi3wire INTERFACE ${SPI3WIRE_INCLUDES})
+
+# Link our INTERFACE library to the usermod target.
+target_link_libraries(usermod INTERFACE usermod_spi3wire)