Use sync-code to manage code

Author: JalonWong

.github/workflows/release.yml

@@ -14,19 +14,18 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: dtolnay/rust-toolchain@stable
         with:
           targets: thumbv7m-none-eabi
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.13"
-      - run: python scripts/sync_code.py --check
       - run: cargo build --release --features=stm32f100,xC
-      - run: python scripts/build.py build --release
-      - run: python scripts/build.py clippy
-      - run: python scripts/build.py test
-      - run: python scripts/build.py build --example=f103c8
+      - run: python3.13 scripts/build.py build --release
+      - run: python3.13 scripts/build.py clippy
+      - run: python3.13 scripts/build.py test
+      - run: python3.13 scripts/build.py build --example=f103c8
 
   publish:
     needs: test
@@ -35,7 +34,7 @@ jobs:
     permissions:
       id-token: write # Required for OIDC token exchange
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: dtolnay/rust-toolchain@stable
         with:
           targets: thumbv7m-none-eabi

Cargo.toml

@@ -9,7 +9,7 @@
     name = "stm32f1-hal"
     readme = "README.md"
     repository = "https://github.com/mcu-rust/stm32f1-hal"
-    version = "0.2.2"
+    version = "0.3.0"
 
     [package.metadata.docs.rs]
         features = ["stm32f103", "xG"]
@@ -49,6 +49,9 @@
     rtic = ["dep:rtic-monotonic"]
     std = []
 
+[build-dependencies]
+    sync-code = "0.1.1"
+
 [dependencies]
     bitflags = "2.9"
     cfg-if = "1.0"

README.md

@@ -11,9 +11,9 @@ Below are the design principles.
 2. Concise is not equal to simple.
     - Fewer lines of code do not necessarily mean easier to read and understand.
 
-Therefore, if a module is quite complex, I would not use a macro + generic approach, as it is too difficult to read.
+Therefore, if a module is quite complex, I would not use a `macro` + `generic` approach, as it is too difficult to read.
 
-Instead, I use a synchronization script to manage duplicate code across peripherals and a script to generate code for GPIO alternate function remapping.
+Instead, I use [sync-code](https://crates.io/crates/sync-code) to manage duplicate code across peripherals and a script to generate code for GPIO alternate function remapping.
 
 ## Note
 This project is still in its early stages, with only a few features completed.

build.rs

@@ -0,0 +1,24 @@
+fn main() {
+    sync_code::Builder::new()
+        .add("src/uart/usart2.rs", "src/uart/usart1.rs")
+        .add("src/uart/usart3.rs", "src/uart/usart1.rs")
+        .add("src/uart/uart4.rs", "src/uart/usart1.rs")
+        .add("src/uart/uart5.rs", "src/uart/uart4.rs")
+        .add("src/timer/timer2.rs", "src/timer/timer1.rs")
+        .add("src/timer/timer3.rs", "src/timer/timer2.rs")
+        .add("src/timer/timer4.rs", "src/timer/timer2.rs")
+        .add("src/timer/timer5.rs", "src/timer/timer2.rs")
+        .add("src/timer/timer6.rs", "src/timer/timer1.rs")
+        .add("src/timer/timer7.rs", "src/timer/timer6.rs")
+        .add("src/timer/timer8.rs", "src/timer/timer1.rs")
+        .add("src/timer/timer9.rs", "src/timer/timer1.rs")
+        .add("src/timer/timer10.rs", "src/timer/timer1.rs")
+        .add("src/timer/timer11.rs", "src/timer/timer10.rs")
+        .add("src/timer/timer12.rs", "src/timer/timer9.rs")
+        .add("src/timer/timer13.rs", "src/timer/timer10.rs")
+        .add("src/timer/timer14.rs", "src/timer/timer10.rs")
+        .add("src/timer/timer15.rs", "src/timer/timer9.rs")
+        .add("src/timer/timer16.rs", "src/timer/timer10.rs")
+        .add("src/timer/timer17.rs", "src/timer/timer10.rs")
+        .sync();
+}

scripts/build.py

@@ -4,7 +4,6 @@
 import subprocess
 
 from base import green
-from sync_code import sync_all
 
 
 def run_cmd(cmd: list[str]) -> None:
@@ -20,8 +19,6 @@ def main() -> int:
     parser.add_argument("-e", "--examples", type=str, nargs="*")
     opts = parser.parse_args()
 
-    sync_all()
-
     cmd = ["cargo", opts.cmd]
 
     if opts.examples:

scripts/sync_code.py

@@ -1,7 +1,7 @@
 type TimerX = pac::TIM1;
 type Width = u16;
 
-// sync begin
+// $sync begin
 
 use super::*;
 use crate::{Mcu, pac};
@@ -132,9 +132,9 @@ impl GeneralTimer for TimerX {
     #[inline(always)]
     fn stop_in_debug(&mut self, state: bool) {
         let dbg = unsafe { DBG::steal() };
-        // sync dbg_t1
+        // $sync dbg_t1
         dbg.cr().modify(|_, w| w.dbg_tim1_stop().bit(state));
-        // sync dbg_end
+        // $sync dbg_end
     }
 
     #[inline(always)]
@@ -143,15 +143,15 @@ impl GeneralTimer for TimerX {
     }
 }
 
-// sync pwm
+// $sync pwm
 // PWM ------------------------------------------------------------------------
 
 impl TimerWithPwm for TimerX {
     fn stop_pwm(&mut self) {
         self.disable_counter();
     }
 
-    // sync start_pwm_aoe
+    // $sync start_pwm_aoe
 
     #[inline(always)]
     fn start_pwm(&mut self) {
@@ -161,7 +161,7 @@ impl TimerWithPwm for TimerX {
         self.enable_counter();
     }
 
-    // sync pwm_cfg_4
+    // $sync pwm_cfg_4
 
     #[inline(always)]
     fn preload_output_channel_in_mode(&mut self, channel: Channel, mode: PwmMode) {
@@ -208,7 +208,7 @@ impl TimerWithPwm for TimerX {
     }
 }
 
-// sync pwm_ch1
+// $sync pwm_ch1
 // PWM Channels ---------------------------------------------------------------
 
 impl TimerWithPwm1Ch for TimerX {
@@ -228,7 +228,7 @@ impl TimerWithPwm1Ch for TimerX {
     }
 }
 
-// sync pwm_ch2
+// $sync pwm_ch2
 
 impl TimerWithPwm2Ch for TimerX {
     #[inline(always)]
@@ -247,7 +247,7 @@ impl TimerWithPwm2Ch for TimerX {
     }
 }
 
-// sync pwm_ch4
+// $sync pwm_ch4
 
 impl TimerWithPwm3Ch for TimerX {
     #[inline(always)]
@@ -285,15 +285,15 @@ impl TimerWithPwm4Ch for TimerX {
 
 // Other ----------------------------------------------------------------------
 
-// sync master
+// $sync master
 impl MasterTimer for TimerX {
     #[inline(always)]
     fn master_mode(&mut self, mode: MasterMode) {
         self.cr2().modify(|_, w| w.mms().variant(mode.into()));
     }
 }
 
-// sync dir
+// $sync dir
 
 impl TimerDirection for TimerX {
     #[inline(always)]
@@ -303,7 +303,7 @@ impl TimerDirection for TimerX {
     }
 }
 
-// sync RTIC
+// $sync RTIC
 #[cfg(feature = "rtic")]
 mod timer_rtic {
     use super::*;
@@ -406,7 +406,7 @@ mod timer_rtic {
     }
 }
 
-// sync end
+// $sync end
 
 use pac::tim1::cr2::MMS;
 impl From<MasterMode> for MMS {

src/timer/timer1.rs

@@ -2,7 +2,7 @@
 type TimerX = pac::TIM10;
 type Width = u16;
 
-// sync begin
+// $sync begin
 
 use super::*;
 use crate::{Mcu, pac};
@@ -133,10 +133,10 @@ impl GeneralTimer for TimerX {
     #[inline(always)]
     fn stop_in_debug(&mut self, state: bool) {
         let dbg = unsafe { DBG::steal() };
-        // sync dbg_t10
+        // $sync dbg_t10
         //TODO: restore these timers once stm32-rs has been updated
         // dbg.cr().modify(|_, w| w.dbg_tim10_stop().bit(state));
-        // sync dbg_end
+        // $sync dbg_end
     }
 
     #[inline(always)]
@@ -145,23 +145,23 @@ impl GeneralTimer for TimerX {
     }
 }
 
-// sync pwm
+// $sync pwm
 // PWM ------------------------------------------------------------------------
 
 impl TimerWithPwm for TimerX {
     fn stop_pwm(&mut self) {
         self.disable_counter();
     }
 
-    // sync start_pwm
+    // $sync start_pwm
 
     #[inline(always)]
     fn start_pwm(&mut self) {
         self.reset_counter();
         self.enable_counter();
     }
 
-    // sync pwm_cfg_1
+    // $sync pwm_cfg_1
 
     #[inline(always)]
     fn preload_output_channel_in_mode(&mut self, channel: Channel, mode: PwmMode) {
@@ -180,7 +180,7 @@ impl TimerWithPwm for TimerX {
     }
 }
 
-// sync pwm_ch1
+// $sync pwm_ch1
 // PWM Channels ---------------------------------------------------------------
 
 impl TimerWithPwm1Ch for TimerX {
@@ -200,4 +200,4 @@ impl TimerWithPwm1Ch for TimerX {
     }
 }
 
-// sync end
+// $sync end