Replace HAL_I2C with I2c and add i2c debug detect

Introduce a new debug i2c detect header (common/include/firmware/debug/debug_i2cdetect.h) and migrate display drivers and related device code from the old HAL_I2C wrapper to the new I2c interface. Changes include: replacing hal_i2c_ members with i2c_, updating includes from hal_i2c.h to i2c.h, adapting I2C read/write/register calls, and switching i2c::IsConnected usage in display detection. SC16IS740 register writes were updated to pass the explicit stop/restart flag (third parameter) where required. Added debug entry/exit logging in several display classes, bumped copyright years to 2026, and removed legacy lib-hal debug i2cdetect and hal_i2c headers/sources. Note: callers relying on the old HAL_I2C API or the previous WriteRegister signature will need to be updated to match the I2c API and the new WriteRegister parameter.

Author: vanvught

common/include/firmware/debug/debug_i2cdetect.h

@@ -0,0 +1,70 @@
+/**
+ * @file debug_i2cdetect.h
+ *
+ */
+/* Copyright (C) 2020-2026 by Arjan van Vught mailto:info@gd32-dmx.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef FIRMWARE_DEBUG_DEBUG_I2CDETECT_H_
+#define FIRMWARE_DEBUG_DEBUG_I2CDETECT_H_
+
+#include <cstdint>
+#include <cstdio>
+
+#include "i2c.h"
+
+namespace debug::i2c {
+#ifndef DEBUG_I2C
+void Detect() {}
+#else
+inline constexpr uint32_t kFirst = 0x03;
+inline constexpr uint32_t kLast = 0x77;
+void Detect() {
+    ::i2c::Begin();
+    ::i2c::SetBaudrate(::i2c::kNormalSpeed);
+
+    puts("\n     0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f");
+
+    for (uint32_t i = 0; i < 128; i = (i + 16)) {
+        printf("%02x: ", i);
+        for (uint32_t j = 0; j < 16; j++) {
+            // Skip unwanted addresses
+            if ((i + j < kFirst) || (i + j > kLast)) {
+                printf("   ");
+                continue;
+            }
+
+            if (::i2c::IsConnected(static_cast<uint8_t>(i + j))) {
+                printf("%02x ", i + j);
+            } else {
+                printf("-- ");
+            }
+        }
+
+        puts("");
+    }
+
+    ::i2c::Begin();
+}
+#endif
+} // namespace debug::i2c
+
+#endif // FIRMWARE_DEBUG_DEBUG_I2CDETECT_H_

lib-device/include/sc16is740.h

@@ -93,7 +93,7 @@ class SC16IS740 : I2c {
         while (!IsWritable()) {
         }
 
-        WriteRegister(SC16IS7X0_THR, static_cast<uint8_t>(value));
+        WriteRegister(SC16IS7X0_THR, static_cast<uint8_t>(value), false);
 
         return value;
     }

lib-device/src/max7219matrix.cpp

@@ -2,7 +2,7 @@
  * @file max7219matrix.cpp
  *
  */
-/* Copyright (C) 2020-2023 by Arjan van Vught mailto:info@orangepi-dmx.nl
+/* Copyright (C) 2020-2026 by Arjan van Vught mailto:info@gd32-dmx.org
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

lib-device/src/sc16is740.cpp

@@ -44,7 +44,7 @@ SC16IS740::SC16IS740(uint8_t address, uint32_t on_board_crystal) : I2c(address,
     SetBaud(SC16IS7X0_DEFAULT_BAUDRATE);
 
     const uint8_t kTestCharacter = 'A';
-    WriteRegister(SC16IS7X0_SPR, kTestCharacter);
+    WriteRegister(SC16IS7X0_SPR, kTestCharacter, true);
 
     if ((ReadRegister(SC16IS7X0_SPR, false) != kTestCharacter)) {
         DEBUG_PUTS("Test character failed");
@@ -54,18 +54,18 @@ SC16IS740::SC16IS740(uint8_t address, uint32_t on_board_crystal) : I2c(address,
 
     auto register_mcr = ReadRegister(SC16IS7X0_MCR, false);
     register_mcr |= MCR_ENABLE_TCR_TLR;
-    WriteRegister(SC16IS7X0_MCR, register_mcr);
+    WriteRegister(SC16IS7X0_MCR, register_mcr, false);
 
     auto register_efr = ReadRegister(SC16IS7X0_EFR, false);
-    WriteRegister(SC16IS7X0_EFR, static_cast<uint8_t>(register_efr | EFR_ENABLE_ENHANCED_FUNCTIONS));
+    WriteRegister(SC16IS7X0_EFR, static_cast<uint8_t>(register_efr | EFR_ENABLE_ENHANCED_FUNCTIONS), false);
 
-    WriteRegister(SC16IS7X0_TLR, static_cast<uint8_t>(0x10));
+    WriteRegister(SC16IS7X0_TLR, static_cast<uint8_t>(0x10), false);
 
-    WriteRegister(SC16IS7X0_EFR, register_efr);
+    WriteRegister(SC16IS7X0_EFR, register_efr, false);
 
-    WriteRegister(SC16IS7X0_FCR, static_cast<uint8_t>(FCR_RX_FIFO_RST | FCR_TX_FIFO_RST));
-    WriteRegister(SC16IS7X0_FCR, FCR_ENABLE_FIFO);
-    WriteRegister(SC16IS7X0_IER, static_cast<uint8_t>(IER_ELSI | IER_ERHRI));
+    WriteRegister(SC16IS7X0_FCR, static_cast<uint8_t>(FCR_RX_FIFO_RST | FCR_TX_FIFO_RST), false);
+    WriteRegister(SC16IS7X0_FCR, FCR_ENABLE_FIFO, false);
+    WriteRegister(SC16IS7X0_IER, static_cast<uint8_t>(IER_ELSI | IER_ERHRI), false);
 
     DEBUG_PRINTF("TLR=%.2x", ReadRegister(SC16IS7X0_TLR, false));
     debug::PrintBits(ReadRegister(SC16IS7X0_TLR, false));
@@ -145,10 +145,10 @@ void SC16IS740::SetBaud(uint32_t baud) {
     const uint32_t kDivisor = ((on_board_crystal_hz_ / prescaler) / (baud * 16U));
     const auto kRegisterLcr = ReadRegister(SC16IS7X0_LCR, false);
 
-    WriteRegister(SC16IS7X0_LCR, static_cast<uint8_t>(kRegisterLcr | LCR_ENABLE_DIV));
-    WriteRegister(SC16IS7X0_DLL, static_cast<uint8_t>(kDivisor & 0xFF));
-    WriteRegister(SC16IS7X0_DLH, static_cast<uint8_t>((kDivisor >> 8) & 0xFF));
-    WriteRegister(SC16IS7X0_LCR, kRegisterLcr);
+    WriteRegister(SC16IS7X0_LCR, static_cast<uint8_t>(kRegisterLcr | LCR_ENABLE_DIV), false);
+    WriteRegister(SC16IS7X0_DLL, static_cast<uint8_t>(kDivisor & 0xFF), false);
+    WriteRegister(SC16IS7X0_DLH, static_cast<uint8_t>((kDivisor >> 8) & 0xFF), false);
+    WriteRegister(SC16IS7X0_LCR, kRegisterLcr, false);
 
     DEBUG_PRINTF("prescaler=%u", prescaler);
     DEBUG_PRINTF("kDivisor=%u", kDivisor);
@@ -170,7 +170,7 @@ void SC16IS740::WriteBytes(const uint8_t* bytes, uint32_t size) {
         uint32_t available = ReadRegister(SC16IS7X0_TXLVL, false);
 
         while ((size > 0) && (available > 0)) {
-            WriteRegister(SC16IS7X0_THR, *p);
+            WriteRegister(SC16IS7X0_THR, *p, false);
             size--;
             available--;
             p++;

lib-device/src/si5351a.cpp

@@ -79,7 +79,6 @@ void SI5351A::ClockBuilder() {
 void SI5351A::Pre() {
     // Disable Outputs. Set CLKx_DIS high; Reg. 3 = 0xFF
     WriteRegister(3, static_cast<uint8_t>(0xFF), false);
-
     // Powerdown all output drivers Reg. 16, 17, 18, 19, 20, 21, 22, 23 = 0x80
     for (uint32_t i = 16; i <= 23; i++) {
         WriteRegister(static_cast<uint8_t>(i), static_cast<uint8_t>(0x80), false);

lib-display/include/i2c/hd44780.h

@@ -2,7 +2,7 @@
  * @file hd44780.h
  *
  */
-/* Copyright (C) 2017-2025 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2017-2026 by Arjan van Vught mailto:info@gd32-dmx.org
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -29,17 +29,15 @@
 #include <cstdint>
 
 #include "displayset.h"
-#include "hal_i2c.h"
+#include "i2c.h"
 
-namespace hd44780::pcf8574t
-{
+namespace hd44780::pcf8574t {
 inline constexpr uint8_t kDefaultAddress = 0x27;
 inline constexpr uint8_t kTC2004Address = kDefaultAddress;
 inline constexpr uint8_t kTC1602Address = 0x26;
 } // namespace hd44780::pcf8574t
 
-class Hd44780 final : public DisplaySet
-{
+class Hd44780 final : public DisplaySet {
    public:
     Hd44780();
     Hd44780(uint8_t cols, uint8_t rows);
@@ -67,7 +65,7 @@ class Hd44780 final : public DisplaySet
     void WriteReg(uint8_t reg);
 
    private:
-    HAL_I2C hal_i2c_;
+    I2c i2c_;
 };
 
-#endif  // I2C_HD44780_H_
+#endif // I2C_HD44780_H_

lib-display/include/i2c/ssd1306.h

@@ -2,7 +2,7 @@
  * @file ssd1306.h
  *
  */
-/* Copyright (C) 2017-2025 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2017-2026 by Arjan van Vught mailto:info@gd32-dmx.org
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -29,25 +29,22 @@
 #include <cstdint>
 
 #include "displayset.h"
-#include "hal_i2c.h"
+#include "i2c.h"
 
 #define OLED_I2C_ADDRESS_DEFAULT 0x3C
 
-enum class OledPanel
-{
+enum class OledPanel {
     k128x648Rows, ///< Default
     k128x644Rows,
     k128x324Rows
 };
 
-class Ssd1306 final : public DisplaySet
-{
+class Ssd1306 final : public DisplaySet {
    public:
     Ssd1306();
     explicit Ssd1306(OledPanel);
     Ssd1306(uint8_t, OledPanel);
-    ~Ssd1306() override
-    {
+    ~Ssd1306() override {
 #if defined(CONFIG_DISPLAY_ENABLE_CURSOR_MODE)
         delete[] shadow_ram_;
         shadow_ram_ = nullptr;
@@ -93,7 +90,7 @@ class Ssd1306 final : public DisplaySet
     void DumpShadowRam();
 
    private:
-    HAL_I2C hal_i2c_;
+    I2c i2c_;
     OledPanel oled_panel_{OledPanel::k128x648Rows};
     bool have_sh1106_{false};
     uint32_t pages_;
@@ -111,4 +108,4 @@ class Ssd1306 final : public DisplaySet
     static inline Ssd1306* s_this;
 };
 
-#endif  // I2C_SSD1306_H_
+#endif // I2C_SSD1306_H_

lib-display/include/i2c/ssd1311.h

@@ -2,7 +2,7 @@
  * @file ssd1311.h
  *
  */
-/* Copyright (C) 2020-2025 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2020-2026 by Arjan van Vught mailto:info@gd32-dmx.org
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -29,10 +29,9 @@
 #include <cstdint>
 
 #include "displayset.h"
-#include "hal_i2c.h"
+#include "i2c.h"
 
-class Ssd1311 final : public DisplaySet
-{
+class Ssd1311 final : public DisplaySet {
    public:
     Ssd1311();
     ~Ssd1311() override = default;
@@ -63,27 +62,19 @@ class Ssd1311 final : public DisplaySet
     void SelectRamRom(uint32_t ram, uint32_t rom);
     void SetDDRAM(uint8_t address);
     void SetCGRAM(uint8_t address);
-    enum class FunctionSet
-    {
-        kReZero = (0 << 1),
-        kReOne = (1 << 1)
-    };
+    enum class FunctionSet { kReZero = (0 << 1), kReOne = (1 << 1) };
     void SetRE(FunctionSet re);
-    enum class CommandSet
-    {
-        kDisabled = 0,
-        kEnabled = 1
-    };
+    enum class CommandSet { kDisabled = 0, kEnabled = 1 };
     void SetSD(CommandSet sd);
     void SendCommand(uint8_t command);
     void SendData(uint8_t data);
     void SendData(const uint8_t* data, uint32_t length);
 
    private:
-    HAL_I2C hal_i2_c_;
+    I2c i2c_;
     uint8_t display_control_{1U << 3}; // Section 9.1.4 Display ON/OFF Control
 
     static inline Ssd1311* s_this;
 };
 
-#endif  // I2C_SSD1311_H_
+#endif // I2C_SSD1311_H_