Ch32v support (#59)

* Add support for function pointers in UART configuration and implement ChannelUart class

* Implement ChannelCh32Uart class and update ChannelUart for buffer handling; add tests for sendBuffer functionality

* Add unit tests for CRC16 calculation and UART configuration; update CMakeLists for test integration

* Refactor UART configuration and implementation for STM8 support; update related structures and tests

* Reorder CRC16 sending in v2styxlib_uart_send function; update tests for expected CRC16 frame

* Fix comments

* Fix STM8 build issues

* Add filter_src.py for STM8 source filtering in build process

* Add filter_src.py and library.json for CH32V support in build process

* Implement CH32V support: add UART configuration and send functions, update README, and modify source filtering

* Enhance CH32V UART support: update V2styxlibUartConfigBase structure, modify setup function, and adjust send logic for SOF markers

* Refactor ChannelUartConfig: remove sofMarkers member and update constructor to use baseConfig for SOF markers

* Refactor CH32V UART setup and send functions: streamline GPIO and USART initialization using direct register manipulation

* Fix comments

Author: vshcryabets

c/l4/CMakeLists.txt

@@ -2,12 +2,32 @@ CMAKE_MINIMUM_REQUIRED(VERSION 3.22)
 
 add_library(module_l4_c STATIC)
 
+set(MODULE_L4C_SRC
+    src/arch.c
+    src/Channel_c.c
+)
+
 target_sources(module_l4_c
     PRIVATE
-        src/Channel_c.c
+        ${MODULE_L4C_SRC}
     )
 
 target_include_directories(module_l4_c PUBLIC
     $<INSTALL_INTERFACE:include>
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
     )
+
+
+if (ENABLE_CATCH2)
+    add_executable(module_l4_c_tests
+        test/test_Channel_c.cpp
+        ${MODULE_L4C_SRC}
+        )
+    target_compile_definitions(module_l4_c_tests PRIVATE TARGET_CATCH2)
+    target_link_libraries(module_l4_c_tests PUBLIC Catch2::Catch2WithMain)
+    target_include_directories(module_l4_c_tests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include)
+
+    catch_discover_tests(module_l4_c_tests 
+        PROPERTIES 
+        TIMEOUT 10)
+endif()

c/l4/README.md

@@ -32,4 +32,12 @@ Enables the use of Software UART for TX on STM8. This is particularly useful whe
 you need additional ADC channels and want to free up the **UART1_TX / AIN5 / (HS) PD5** pin for analog input.
 
 **Note:** This implementation covers TX only, as software-based RX is generally 
-unstable on this architecture due to timing constraints.
+unstable on this architecture due to timing constraints.
+
+## `V2STYXLIB_TARGET_STM8`
+
+Target build for STM8.
+
+## `V2STYXLIB_TARGET_CH32V`
+
+Target build for CH32V.

c/l4/filter_src.py

@@ -0,0 +1,14 @@
+Import("env")
+from os.path import join, realpath
+
+is_stm8 = env.get("PIOPLATFORM") == "ststm8" or "stm8" in env.get("BOARD_MCU", "").lower()
+is_ch32v = env.get("PIOPLATFORM") == "ch32v" or "ch32v" in env.get("BOARD_MCU", "").lower()
+
+sources = ["+<arch.c>", "+<Channel_c.c>"]
+
+if is_stm8:
+    sources.append("+<ChannelUartStm8.c>")
+if is_ch32v:
+    sources.append("+<ChannelUartCh32v.c>")
+
+env.Replace(SRC_FILTER=sources)

c/l4/include/ChannelUartCh32v.h

@@ -0,0 +1,31 @@
+#pragma once
+
+#include "defines.h"
+#include "structs.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct {
+    V2styxlibUartConfigBase baseConfig;
+    uint32_t baudrate;
+} V2styxlibUartCh32vConfig;
+
+/**
+ * Configure USART1 peripheral (PD5 TX, PD6 RX) with the given baud rate.
+ * Must be called once before sending data.
+ */
+void v2styxlib_uart_ch32v_setup(const V2styxlibUartCh32vConfig* config);
+
+/**
+ * Send multiple bytes over USART1.
+ */
+void v2styxlib_uart_ch32v_send_bytes(
+    const V2styxlibUartCh32vConfig* config,
+    const uint8_t* buffer,
+    BufferSize_t length);
+
+#ifdef __cplusplus
+}
+#endif

c/l4/include/ChannelUartStm8.h

@@ -1,13 +1,11 @@
 #pragma once
 
-#include <stdint.h>
-#include "stm8s.h"
-
-#include "Channel_c.h"
+#include "defines.h"
+#include "structs.h"
 
 typedef struct {
-    V2styxlibUartConfig baseConfig;
-#ifdef V2STYXLIB_SOFTUART    
+    V2styxlibUartConfigBase baseConfig;
+#ifdef V2STYXLIB_SOFTUART_TX
     GPIO_TypeDef * softUartPort;
     uint8_t softUartTxPinMask;
 #endif    
@@ -22,18 +20,12 @@ typedef struct {
  * baudRateDivider = 16000000 / 115200 ≈ 138.89
  * In this case, baudRateDivider will be approximately 139 (rounded to the nearest integer).
  */
-void v2styxlib_uart_setup(
+void v2styxlib_uart_stm8_setup(
     const V2styxlibUartStm8Config* config,
     uint16_t baudRateDivider
     );
 
-/**
- * buffer - is a pointer to the data buffer that contains the data to be sent over UART.
- * length - is the number of bytes to be sent from the buffer.
- * This function is responsible for sending a specified number of bytes from the provided buffer over UART.
- */
-void v2styxlib_uart_send(
-    const V2styxlibUartStm8Config* config, 
-    const uint8_t *buffer, 
-    BufferSize_t length
-);
+void v2styxlib_uart_stm8_send_bytes(
+    const V2styxlibUartStm8Config* config,
+    const uint8_t* buffer,
+    BufferSize_t length);

c/l4/include/Channel_c.h

@@ -1,36 +1,12 @@
 #pragma once
 
-#include <stdint.h>
-#include <stdbool.h>
-
-#ifndef BufferSize_t
-    #define BufferSize_t uint8_t
-#endif
-
-#ifndef V2STYXLIB_CRC16_POLY
-    #define V2STYXLIB_CRC16_POLY 0x1021
-#endif
-#ifndef V2STYXLIB_CRC16_INITIAL_VALUE
-    #define V2STYXLIB_CRC16_INITIAL_VALUE 0xFFFF
-#endif
-
-#define V2STYXLIB_CONFIG_STREAMING_MODE 0x01
-#define V2STYXLIB_CONFIG_SEND_CRC16 0x02
-#define V2STYXLIB_CONFIG_SOFT_UART_TX 0x04
-
-#ifndef V2STYXLIB_SOF_MARKER_1
-    #define V2STYXLIB_SOF_MARKER_1 0x55
-    #define V2STYXLIB_SOF_MARKER_2 0xAA
-#endif
+#include "defines.h"
+#include "arch.h"
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-typedef struct {
-    uint8_t config;
-} V2styxlibUartConfig;
-
 /**
  * useStreamingMode - is a boolean flag that indicates whether to
  * use streaming mode for UART communication.
@@ -59,7 +35,20 @@ void v2styxlib_uart_configure_proto(
  *
  * Returns the calculated CRC16 checksum.
  */
-uint16_t v2styxlib_crc16_calculate(const uint8_t *data, BufferSize_t length);
+uint16_t v2styxlib_crc16_calculate(
+    const uint8_t *data, 
+    BufferSize_t length
+);
+
+/**
+ * buffer - is a pointer to the data buffer that contains the data to be sent over UART.
+ * length - is the number of bytes to be sent from the buffer.
+ * This function is responsible for sending a specified number of bytes from the provided buffer over UART.
+ */
+void v2styxlib_uart_send(
+    const V2styxlibUartConfig* config,
+    const uint8_t *buffer,
+    BufferSize_t length);
 
 #ifdef __cplusplus
 }

c/l4/include/arch.h

@@ -0,0 +1,29 @@
+#ifndef ARCH_H
+#define ARCH_H
+
+#include "structs.h"
+
+#ifdef V2STYXLIB_TARGET_STM8
+    #include "ChannelUartStm8.h"
+
+    typedef V2styxlibUartStm8Config V2styxlibUartConfig;
+    #define v2styxlib_uart_send_bytes v2styxlib_uart_stm8_send_bytes
+#elif defined(V2STYXLIB_TARGET_CH32V)
+    #include "ChannelUartCh32v.h"
+
+    typedef V2styxlibUartCh32vConfig V2styxlibUartConfig;
+    #define v2styxlib_uart_send_bytes v2styxlib_uart_ch32v_send_bytes
+#else
+    // target to host system, use generic config
+    typedef struct {
+        struct V2styxlibUartConfigBase baseConfig; 
+    } V2styxlibUartConfig;
+
+    void v2styxlib_uart_send_bytes(
+        const V2styxlibUartConfig* config,
+        const uint8_t* buffer,
+        BufferSize_t length
+    );
+#endif
+
+#endif // ARCH_H

c/l4/include/defines.h

@@ -0,0 +1,31 @@
+#ifndef DEFINES_H
+#define DEFINES_H
+
+#ifdef V2STYXLIB_TARGET_STM8
+    #include "stm8s.h"
+#else
+    #include <stdint.h>
+    #include <stdbool.h>
+#endif
+
+#ifndef BufferSize_t
+    #define BufferSize_t uint8_t
+#endif
+
+#ifndef V2STYXLIB_CRC16_POLY
+    #define V2STYXLIB_CRC16_POLY 0x1021
+#endif
+#ifndef V2STYXLIB_CRC16_INITIAL_VALUE
+    #define V2STYXLIB_CRC16_INITIAL_VALUE 0xFFFF
+#endif
+
+#define V2STYXLIB_CONFIG_STREAMING_MODE 0x01
+#define V2STYXLIB_CONFIG_SEND_CRC16 0x02
+#define V2STYXLIB_CONFIG_SOFT_UART_TX 0x04
+
+#ifndef V2STYXLIB_SOF_MARKER_1
+    #define V2STYXLIB_SOF_MARKER_1 0x55
+    #define V2STYXLIB_SOF_MARKER_2 0xAA
+#endif
+
+#endif // DEFINES_H

c/l4/include/structs.h

@@ -0,0 +1,16 @@
+#ifndef STRUCTS_H
+#define STRUCTS_H
+
+#include "defines.h"
+
+/**
+ * V2styxlibUartConfigBase - is a structure that holds the 
+ * configuration for UART communication. And hardware layer 
+ * specific send function.
+ */
+typedef struct V2styxlibUartConfigBase {
+    uint8_t config;
+    uint8_t sof[2];
+} V2styxlibUartConfigBase;
+
+#endif // STRUCTS_H

c/l4/library.json

@@ -2,9 +2,6 @@
   "name": "V2StyxLibL4_C",
   "version": "1.0.0",
   "build": {
-    "srcFilter": [
-      "+<Channel_c.c>",
-      "+<ChannelUartStm8.c>"
-    ]
+    "extraScript": "filter_src.py"
   }
 }