✨ Initial support for HC32 U8G LCD (MarlinFirmware#26568)

Co-authored-by: Chris <52449218+shadow578@users.noreply.github.com>
smiksky · Dec 27, 2023 · d903a5e · d903a5e
1 parent 15f26b4
commit d903a5e
Show file tree

Hide file tree

Showing 4 changed files with 177 additions and 8 deletions.
diff --git a/Marlin/src/HAL/HC32/inc/Conditionals_LCD.h b/Marlin/src/HAL/HC32/inc/Conditionals_LCD.h
@@ -20,3 +20,7 @@
  *
  */
 #pragma once
+
+#if ALL(HAS_MARLINUI_U8GLIB, FORCE_SOFT_SPI)
+  #define U8G_SW_SPI_HC32 1
+#endif
diff --git a/Marlin/src/HAL/HC32/u8g/LCD_defines.h b/Marlin/src/HAL/HC32/u8g/LCD_defines.h
@@ -24,3 +24,6 @@
 /**
  * HC32 LCD-specific defines
  */
+
+uint8_t u8g_com_HAL_HC32_sw_spi_fn(u8g_t *u8g, uint8_t msg, uint8_t arg_val, void *arg_ptr);
+#define U8G_COM_HAL_SW_SPI_FN     u8g_com_HAL_HC32_sw_spi_fn
diff --git a/Marlin/src/HAL/HC32/u8g/u8g_com_HAL_HC32_sw_spi.cpp b/Marlin/src/HAL/HC32/u8g/u8g_com_HAL_HC32_sw_spi.cpp
@@ -0,0 +1,163 @@
+/**
+ * Marlin 3D Printer Firmware
+ * Copyright (c) 2023 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
+ *
+ * Based on Sprinter and grbl.
+ * Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifdef ARDUINO_ARCH_HC32
+
+#include "../../../inc/MarlinConfig.h"
+
+#if U8G_SW_SPI_HC32
+
+#warning "Software SPI for U8Glib is experimental on HC32F460. Please share your experiences at https://github.com/shadow578/Marlin-H32/issues/35"
+
+#include <U8glib-HAL.h>
+#include "../../shared/HAL_SPI.h"
+
+#ifndef LCD_SPI_SPEED
+  #define LCD_SPI_SPEED SPI_FULL_SPEED      // Fastest
+  //#define LCD_SPI_SPEED SPI_QUARTER_SPEED // Slower
+#endif
+
+static uint8_t SPI_speed = LCD_SPI_SPEED;
+
+static inline uint8_t swSpiTransfer_mode_0(uint8_t b, const uint8_t spi_speed, const pin_t miso_pin=-1) {
+  for (i = 0; i < 8; ++i) {
+    if (spi_speed == 0) {
+      WRITE(DOGLCD_MOSI, !!(b & 0x80));
+      WRITE(DOGLCD_SCK, HIGH);
+      b <<= 1;
+      if (miso_pin >= 0 && READ(miso_pin)) b |= 1;
+      WRITE(DOGLCD_SCK, LOW);
+    }
+    else {
+      const uint8_t state = (b & 0x80) ? HIGH : LOW;
+      for (j = 0; j < spi_speed; ++j) WRITE(DOGLCD_MOSI, state);
+      for (j = 0; j < spi_speed + (miso_pin >= 0 ? 0 : 1; ++j)) WRITE(DOGLCD_SCK, HIGH);
+
+      b <<= 1;
+      if (miso_pin >= 0 && READ(miso_pin)) b |= 1;
+
+      for (j = 0; j < spi_speed; ++j) WRITE(DOGLCD_SCK, LOW);
+    }
+  }
+  return b;
+}
+
+static inline uint8_t swSpiTransfer_mode_3(uint8_t b, const uint8_t spi_speed, const pin_t miso_pin=-1) {
+  for (i = 0; i < 8; ++i) {
+    const uint8_t state = (b & 0x80) ? HIGH : LOW;
+    if (spi_speed == 0) {
+      WRITE(DOGLCD_SCK, LOW);
+      WRITE(DOGLCD_MOSI, state);
+      WRITE(DOGLCD_MOSI, state);  // need some setup time
+      WRITE(DOGLCD_SCK, HIGH);
+    }
+    else {
+      for (j = 0; j < spi_speed + (miso_pin >= 0 ? 0 : 1); ++j) WRITE(DOGLCD_SCK, LOW);
+      for (j = 0; j < spi_speed; ++j) WRITE(DOGLCD_MOSI, state);
+      for (j = 0; j < spi_speed; ++j) WRITE(DOGLCD_SCK, HIGH);
+    }
+    b <<= 1;
+    if (miso_pin >= 0 && READ(miso_pin)) b |= 1;
+  }
+  return b;
+}
+
+static void u8g_sw_spi_shift_out(uint8_t val) {
+  #if ANY(FYSETC_MINI_12864, MKS_MINI_12864)
+    swSpiTransfer_mode_3(val, SPI_speed);
+  #else
+    swSpiTransfer_mode_0(val, SPI_speed);
+  #endif
+}
+
+static uint8_t swSpiInit(const uint8_t spi_speed) {
+  #if PIN_EXISTS(LCD_RESET)
+    SET_OUTPUT(LCD_RESET_PIN);
+  #endif
+  SET_OUTPUT(DOGLCD_A0);
+  OUT_WRITE(DOGLCD_SCK, LOW);
+  OUT_WRITE(DOGLCD_MOSI, LOW);
+  OUT_WRITE(DOGLCD_CS, HIGH);
+  return spi_speed;
+}
+
+uint8_t u8g_com_HAL_HC32_sw_spi_fn(u8g_t *u8g, uint8_t msg, uint8_t arg_val, void *arg_ptr) {
+  switch (msg) {
+    case U8G_COM_MSG_INIT:
+      SPI_speed = swSpiInit(LCD_SPI_SPEED);
+      break;
+
+    case U8G_COM_MSG_STOP:
+      break;
+
+    case U8G_COM_MSG_RESET:
+      #if PIN_EXISTS(LCD_RESET)
+        WRITE(LCD_RESET_PIN, arg_val);
+      #endif
+      break;
+
+    case U8G_COM_MSG_CHIP_SELECT:
+      #if ANY(FYSETC_MINI_12864, MKS_MINI_12864) // This LCD SPI is running mode 3 while SD card is running mode 0
+        if (arg_val) {                           // SCK idle state needs to be set to the proper idle state before
+                                                 // the next chip select goes active
+          WRITE(DOGLCD_SCK, HIGH);               // Set SCK to mode 3 idle state before CS goes active
+          WRITE(DOGLCD_CS, LOW);
+        }
+        else {
+          WRITE(DOGLCD_CS, HIGH);
+          WRITE(DOGLCD_SCK, LOW);  // Set SCK to mode 0 idle state after CS goes inactive
+        }
+      #else
+        WRITE(DOGLCD_CS, !arg_val);
+      #endif
+      break;
+
+    case U8G_COM_MSG_WRITE_BYTE:
+      u8g_sw_spi_shift_out(arg_val);
+      break;
+
+    case U8G_COM_MSG_WRITE_SEQ: {
+      uint8_t *ptr = (uint8_t *)arg_ptr;
+      while (arg_val > 0) {
+        u8g_sw_spi_shift_out(*ptr++);
+        arg_val--;
+      }
+    } break;
+
+    case U8G_COM_MSG_WRITE_SEQ_P: {
+      uint8_t *ptr = (uint8_t *)arg_ptr;
+      while (arg_val > 0) {
+        u8g_sw_spi_shift_out(u8g_pgm_read(ptr));
+        ptr++;
+        arg_val--;
+      }
+    } break;
+
+    case U8G_COM_MSG_ADDRESS: /* define cmd (arg_val = 0) or data mode (arg_val = 1) */
+      WRITE(DOGLCD_A0, arg_val);
+      break;
+  }
+  return 1;
+}
+
+#endif // U8G_SW_SPI_HC32
+#endif // ARDUINO_ARCH_HC32
diff --git a/Marlin/src/pins/hc32f4/pins_AQUILA_101.h b/Marlin/src/pins/hc32f4/pins_AQUILA_101.h
@@ -153,22 +153,21 @@
 #define EXP1_08_PIN                         PB15  // EN1
 
 #if ENABLED(CR10_STOCKDISPLAY)                    // LCD used for C2
-#undef LCD_SERIAL_PORT
-#define LCD_SERIAL_PORT                        1
 
-  #define LCD_PINS_RS                EXP1_07_PIN
-  #define LCD_PINS_EN                EXP1_08_PIN
-  #define LCD_PINS_D4                EXP1_06_PIN
+  #ifndef HAS_PIN_27_BOARD
+    #define BEEPER_PIN               EXP1_01_PIN
+  #endif
 
   #define BTN_ENC                    EXP1_02_PIN
   #define BTN_EN1                    EXP1_03_PIN
   #define BTN_EN2                    EXP1_05_PIN
 
-  #ifndef HAS_PIN_27_BOARD
-    #define BEEPER_PIN               EXP1_01_PIN
-  #endif
+  #define LCD_PINS_RS                EXP1_07_PIN
+  #define LCD_PINS_EN                EXP1_08_PIN
+  #define LCD_PINS_D4                EXP1_06_PIN
 
 #elif ANY(HAS_DWIN_E3V2, IS_DWIN_MARLINUI)        // LCD used for X2
+
   /**
    * Display pinout (display side, so RX/TX are swapped)
    *