Prepare to adding DMA support

.github/workflows/build.yml

@@ -31,4 +31,7 @@ jobs:
           cd ../hpm-data/build/
           git clone https://github.com/hpmicro-rs/hpm-metapac.git
       - name: Build Only
-        run: cargo build --release --examples
+        run:
+          for d in $(ls -1 ./examples); do
+            (cd ./examples/$d && cargo build --release)
+          done

Cargo.toml

@@ -15,12 +15,7 @@ license = "MIT/Apache-2.0"
 [dependencies]
 # path = "../hpm-data/build/hpm-metapac",
 # git = "https://github.com/hpmicro-rs/hpm-metapac.git",
-hpm-metapac = { version = "0.0.3", path = "../hpm-data/build/hpm-metapac", features = [
-    "rt",
-    # temp feature for demo
-    # "memory-x",
-
-] }
+hpm-metapac = { version = "0.0.3", path = "../hpm-data/build/hpm-metapac" }
 
 riscv = { version = "0.11", features = ["critical-section-single-hart"] }
 embedded-hal = { version = "1.0.0" }
@@ -55,12 +50,18 @@ proc-macro2 = "1.0.85"
 quote = "1.0.15"
 
 [features]
-default = ["hpm5361", "rt", "embassy", "defmt", "time"]
-rt = ["dep:riscv-rt"]
+default = ["rt", "embassy", "defmt", "time"]
+
+rt = ["dep:riscv-rt", "hpm-metapac/rt"]
 defmt = ["dep:defmt"]
 time = ["dep:embassy-time"]
 
-embassy = ["dep:embassy-sync", "dep:embassy-futures", "dep:embassy-time-driver", "dep:futures-util"]
+embassy = [
+    "dep:embassy-sync",
+    "dep:embassy-futures",
+    "dep:embassy-time-driver",
+    "dep:futures-util",
+]
 
 hpm5301 = ["hpm-metapac/hpm5301"]
 hpm5321 = ["hpm-metapac/hpm5321"]
@@ -90,27 +91,7 @@ hpm6754 = ["hpm-metapac/hpm6754"]
 hpm6830 = ["hpm-metapac/hpm6830"]
 hpm6850 = ["hpm-metapac/hpm6850"]
 hpm6880 = ["hpm-metapac/hpm6880"]
-futures-util = ["dep:futures-util"]
-
-
-[dev-dependencies]
-panic-halt = "0.2.0"
-riscv-rt = "0.12.2"
-
-embassy-time = { version = "0.3.0", features = ["tick-hz-1_000_000"] }
-embassy-executor = { version = "0.5.0", features = [
-    "nightly",
-    "integrated-timers",
-    "arch-riscv32",
-    "executor-thread",
-] }
-defmt = "0.3.8"
-defmt-rtt = "0.4.1"
-embedded-graphics = "0.8.1"
-
-
-[profile.release]
-strip = false   # symbols are not flashed to the microcontroller, so don't strip them.
-lto = true
-opt-level = "z" # Optimize for size.
-debug = 2
+hpm6e50 = ["hpm-metapac/hpm6e50"]
+hpm6e60 = ["hpm-metapac/hpm6e60"]
+hpm6e70 = ["hpm-metapac/hpm6e70"]
+hpm6e80 = ["hpm-metapac/hpm6e80"]

HPMicro.yaml

@@ -41,7 +41,7 @@ flash_algorithms:
 - name: algorithm-test
   description: A flash algorithm under test
   default: true
-  instructions: EwEB3CMuESIjLIEiIyqRIiMoISO3BQAABUV9Fo1GI4SlSGN51gy3FQD0A6AFgH1WI6DFgAOgBYEjqMWAI6KlkGgAEwYAEIFFlwAAAOeAIBsjLgEQIywBEDcF+fwJBSMmoRAZRSMooRAFZSMqoRA3BQIgAyVF8XRF0cI3BQDzbABwAjcJAPOCliqEKemyRCMAAQQMCAgSEwbAD5cAAADngOApaAxsAlFGlwAAAOeAACk3BQAAIyiVNpMEBTcThUQADBITBgARlwAAAOeAICcjqiQRNwUAAIVFIwS1SCKFgyDBIwMkgSODJEEjAykBIxMBASSCgJcAAADngEANlwAAAOeAwA63BQAAA8aFSAVFAcYBRSOEBUiCgLcFAACDxYVIncG3BQIgg6VF8ZxRmc+3BQAAE4YFNwMnRhG3BgCAqY6RRTqFgocFRYKAlwAAAOeA4Am3BgAAA8eGSAXLLoi3BQIgg6VF8QOjhQJjAgMCsoa3BQAAE4YFN4MnRhE3BwCAKY+RRT6FwocCgwVFgoCXAAAA54CgBTcFAAADRYVIGc03BQIgAyVF8VxNmcs3BQAAEwYFNwMlRhGRRYKHBUWCgJcAAADngIACQREGxiLEAAiXAAAA54CAAkERBsYixAAIlwAAAOeAgP5BEQbGIsQACJcAAADngID+AaBBEQbGIsQACLJAIkRBARcDAABnAGMMQREGxiLEAAjBRmNr1gazBqBAE/g2ALMDBQFjDAgAqoeuhgPHBgAjgOcAhQeFBuPqd/6ziAUBMwgGQZNyyP+T9TgAs4ZTAKHBY1lQBJOVOAAT84UBk/fI/5BDswWwQBP+hQGRB5hDM1ZmALMVxwHRjSOgswCRA5EHOobj5dP+Maiqhg3iDahjWlAAxoWQQSOgwwCRA5EF4+vT/rOFWAATdjgAEco2lgPHBQAjgOYAhQaFBePqxv6yQCJEQQGCgEERBsYixAAIwUZjZNYEswagQI2KMwfVAJnGqocjgLcAhQfj7ef+FY6Td8b/swb3AGNe8AAT+PUPtwcBAZOHFxCzB/gCHMMRB+Nu1/4NigHmCaiqhhnGNpYjgLYAhQbj7cb+skAiREEBgoBBEQbGIsQACLJAIkRBARcDAABnAKPsAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
+  instructions: EwEB3CMuESIjLIEiIyqRIiMoISO3BQAABUV9Fo1GI4SlSGN51gy3FQD0A6AFgH1WI6DFgAOgBYEjqMWAI6KlkGgAEwYAEIFFlwAAAOeAAC8jLgEQIywBEDcF+fwJBSMmoRAZRSMooRAFZSMqoRA3BQIgAyVF8XRF0cI3BQDzbABwAjcJAPOCliqEKemyRCMAAQQMCAgSEwbAD5cAAADngAAWaAxsAlFGlwAAAOeAIBU3BQAAIyiVNpMEBTcThUQADBITBgARlwAAAOeAQBMjqiQRNwUAAIVFIwS1SCKFgyDBIwMkgSODJEEjAykBIxMBASSCgJcAAADngEANlwAAAOeAwA63BQAAA8aFSAVFAcYBRSOEBUiCgLcFAACDxYVIncG3BQIgg6VF8ZxRmc+3BQAAE4YFNwMnRhG3BgCAqY6RRTqFgocFRYKAlwAAAOeA4Am3BgAAA8eGSAXLLoi3BQIgg6VF8QOjhQJjAgMCsoa3BQAAE4YFN4MnRhE3BwCAKY+RRT6FwocCgwVFgoCXAAAA54CgBTcFAAADRYVIGc03BQIgAyVF8VxNmcs3BQAAEwYFNwMlRhGRRYKHBUWCgJcAAADngIACQREGxiLEAAiXAAAA54CAAkERBsYixAAIlwAAAOeAgP5BEQbGIsQACJcAAADngID+AaBBEQbGIsQACLJAIkRBARcDAABnAIMAQREGxiLEAAjBRmNr1gazBqBAE/g2ALMDBQFjDAgAqoeuhgPHBgAjgOcAhQeFBuPqd/6ziAUBMwgGQZNyyP+T9TgAs4ZTAKHBY1lQBJOVOAAT84UBk/fI/5BDswWwQBP+hQGRB5hDM1ZmALMVxwHRjSOgswCRA5EHOobj5dP+Maiqhg3iDahjWlAAxoWQQSOgwwCRA5EF4+vT/rOFWAATdjgAEco2lgPHBQAjgOYAhQaFBePqxv6yQCJEQQGCgEERBsYixAAIwUZjZNYEswagQI2KMwfVAJnGqocjgLcAhQfj7ef+FY6Td8b/swb3AGNe8AAT+PUPtwcBAZOHFxCzB/gCHMMRB+Nu1/4NigHmCaiqhhnGNpYjgLYAhQbj7cb+skAiREEBgoBBEQbGIsQACLJAIkRBARcDAABnAIP4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
   load_address: 0x20
   pc_init: 0x0
   pc_uninit: 0x104
@@ -53,7 +53,7 @@ flash_algorithms:
     address_range:
       start: 0x80000000
       end: 0x80100000
-    page_size: 0x100
+    page_size: 0x1000
     erased_byte_value: 0xff
     program_page_timeout: 1000
     erase_sector_timeout: 2000

README.md

@@ -17,6 +17,7 @@ This crate is a working-in-progress and not ready for use.
   - [x] RTT support (defmt, defmt-rtt)
   - [x] UART blocking TX, RX
   - [x] I2C blocking
+  - [x] MBX, blocking and async
 - MCUs
   - HPM5300 - currently it's the only supported series
 

build.rs

@@ -1,4 +1,4 @@
-use std::collections::HashMap;
+use std::collections::{HashMap, HashSet};
 use std::ffi::OsString;
 use std::fmt::Write as _;
 use std::io::Write as _;
@@ -166,6 +166,44 @@ fn main() {
         }
     }
 
+    // ========
+    // Generate dma_trait_impl!
+    let signals: HashMap<_, _> = [
+        // (kind, signal) => trait
+        (("uart", "RX"), quote!(crate::uart::RxDma)),
+        (("uart", "TX"), quote!(crate::uart::TxDma)),
+        (("i2c", "GLOBAL"), quote!(crate::i2c::I2cDma)),
+    ]
+    .into();
+
+    for p in METADATA.peripherals {
+        if let Some(regs) = &p.registers {
+            let mut dupe = HashSet::new();
+            for ch in p.dma_channels {
+                if let Some(tr) = signals.get(&(regs.kind, ch.signal)) {
+                    let peri = format_ident!("{}", p.name);
+
+                    let key = (ch.signal, ch.request.unwrap().to_string());
+                    if !dupe.insert(key) {
+                        continue;
+                    }
+
+                    // request number for peripheral DMA
+                    let request = ch.request.expect("DMA request must be specified") as u8;
+
+                    // let channel = format_ident!("{}", ch.name);
+
+                    for channel in METADATA.dma_channels {
+                        let channel_ident = format_ident!("{}", channel.name);
+                        g.extend(quote! {
+                            dma_trait_impl!(#tr, #peri, #channel_ident, #request);
+                        });
+                    }
+                }
+            }
+        }
+    }
+
     // ========
     // Write foreach_foo! macrotables
 
@@ -178,6 +216,32 @@ fn main() {
         pins_table.push(vec![p.name.to_string(), p.index.to_string()]);
     }
 
+    let mut dmas = TokenStream::new();
+    for ch in METADATA.dma_channels.iter() {
+        let name = format_ident!("{}", ch.name);
+        let idx = ch.channel as u8;
+
+        let ch_num = ch.channel as usize;
+        let mux_num = ch.dmamux_channel as usize;
+
+        // HDMA or XDMA
+        let dma_name = format_ident!("{}", ch.name.split_once('_').expect("DMA channel name format").0);
+
+        g.extend(quote!(dma_channel_impl!(#name, #idx);));
+
+        dmas.extend(quote! {
+            crate::dma::ChannelInfo {
+                dma: crate::dma::DmaInfo::#dma_name(crate::pac::#dma_name),
+                num: #ch_num,
+                mux_num: #mux_num,
+            },
+        });
+    }
+
+    g.extend(quote! {
+        pub(crate) const DMA_CHANNELS: &[crate::dma::ChannelInfo] = &[#dmas];
+    });
+
     for p in METADATA.peripherals {
         let Some(regs) = &p.registers else {
             continue;

examples/hpm5300evk/.cargo/config.toml

@@ -0,0 +1,34 @@
+[build]
+target = "riscv32imafc-unknown-none-elf"
+
+[target.riscv32imafc-unknown-none-elf]
+# runner = 'riscv64-unknown-elf-gdb -x ../../openocd.gdb'
+runner = "probe-rs run --chip HPM5361 --protocol jtag --chip-description-path ../../HPMicro.yaml"
+# runner = "probe-rs run --chip HPM5361 --protocol jtag"
+
+rustflags = [
+    # Target features:
+    # The default for imacf is is "+m,+a,+c,+f"
+    "-C",
+    "target-feature=+d,+zba,+zbb,+zbc,+zbs",
+    # Linker scripts:
+    "-C",
+    "link-arg=-Tmemory.x",
+    "-C",
+    "link-arg=-Tdevice.x", # __VECTORED_INTERRUPTS
+    "-C",
+    "link-arg=-Tlink-fixed.x",
+    "-C",
+    "link-arg=-Tdefmt.x",
+    "-C",
+    "link-arg=-nmagic",
+
+    # "--emit", "obj",
+    # "--emit", "asm",
+]
+
+[unstable]
+build-std = ["core"]
+
+[env]
+DEFMT_LOG = "info"

examples/hpm5300evk/Cargo.toml

@@ -0,0 +1,32 @@
+[package]
+name = "hpm5300evk"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+hpm-hal = { path = "../..", features = ["rt", "embassy", "hpm5361"] }
+
+panic-halt = "0.2.0"
+riscv-rt = "0.12.2"
+
+embassy-time = { version = "0.3.0", features = ["tick-hz-1_000_000"] }
+embassy-executor = { version = "0.5.0", features = [
+    "nightly",
+    "integrated-timers",
+    "arch-riscv32",
+    "executor-thread",
+] }
+defmt = "0.3.8"
+defmt-rtt = "0.4.1"
+embedded-graphics = "0.8.1"
+riscv = { version = "0.11.1", features = ["critical-section-single-hart"] }
+embedded-hal = "1.0.0"
+embedded-io = "0.6.1"
+futures-util = { version = "0.3.30", default-features = false }
+
+
+[profile.release]
+strip = false   # symbols are not flashed to the microcontroller, so don't strip them.
+lto = true
+opt-level = "z" # Optimize for size.
+debug = 2

examples/hpm5300evk/src/bin/blinky.rs

@@ -0,0 +1,34 @@
+#![no_main]
+#![no_std]
+
+use embedded_hal::delay::DelayNs;
+use hal::gpio::{Level, Output, Speed};
+use riscv::delay::McycleDelay;
+use {defmt_rtt as _, hpm_hal as hal, riscv_rt as _};
+
+#[hal::entry]
+fn main() -> ! {
+    let p = hal::init(Default::default());
+
+    let mut delay = McycleDelay::new(hal::sysctl::clocks().cpu0.0);
+
+    defmt::info!("Board init!");
+
+    defmt::info!("CPU0 clock: {}Hz", hal::sysctl::clocks().cpu0.0);
+
+    // let mut led = Output::new(p.PA10, Level::Low, Speed::default());
+    let mut led = Output::new(p.PA23, Level::Low, Speed::default());
+
+    loop {
+        defmt::info!("tick");
+
+        led.toggle();
+        delay.delay_ms(1000);
+    }
+}
+
+#[panic_handler]
+fn panic(_info: &core::panic::PanicInfo) -> ! {
+    defmt::info!("panic");
+    loop {}
+}

examples/blocking_uart_tx.rs → examples/hpm5300evk/src/bin/blocking_uart_tx.rs

@@ -8,16 +8,20 @@ use hpm_hal::uart::UartTx;
 use riscv::delay::McycleDelay;
 use {defmt_rtt as _, hpm_hal as hal, panic_halt as _, riscv_rt as _};
 
+const BANNER: &str = include_str!("./BANNER");
+
 #[hal::entry]
 fn main() -> ! {
     let p = hal::init(Default::default());
 
-    let mut delay = McycleDelay::new(hal::sysctl::clocks().hart0.0);
+    let mut delay = McycleDelay::new(hal::sysctl::clocks().cpu0.0);
 
     defmt::info!("Board init!");
 
     let mut tx = UartTx::new_blocking(p.UART0, p.PA00, Default::default()).unwrap();
 
+    writeln!(tx, "{}", BANNER).unwrap();
+
     tx.blocking_write(b"Hello, board!\r\n").unwrap();
 
     writeln!(tx, "Clocks {:#?}", hal::sysctl::clocks()).unwrap();

examples/button.rs → examples/hpm5300evk/src/bin/button.rs

@@ -10,7 +10,7 @@ use {defmt_rtt as _, hpm_hal as hal, panic_halt as _, riscv_rt as _};
 fn main() -> ! {
     let p = hal::init(Default::default());
 
-    let mut delay = McycleDelay::new(hal::sysctl::clocks().hart0.0);
+    let mut delay = McycleDelay::new(hal::sysctl::clocks().cpu0.0);
 
     defmt::info!("Board init!");
 

examples/embassy_blinky.rs → examples/hpm5300evk/src/bin/embassy_blinky.rs

@@ -35,7 +35,7 @@ async fn main(spawner: Spawner) -> ! {
     println!("==============================");
     println!(" {} clock summary", BOARD_NAME);
     println!("==============================");
-    println!("cpu0:\t\t {}Hz", hal::sysctl::clocks().hart0.0);
+    println!("cpu0:\t\t {}Hz", hal::sysctl::clocks().cpu0.0);
     println!("ahb:\t\t {}Hz", hal::sysctl::clocks().ahb.0);
     println!("==============================");