chore(lib): version 0.1.0

Author: ckrenslehner

CHANGELOG.md

@@ -2,12 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
-## [unreleased]
+## [0.1.0] - 2025-02-02
 
 ### 🚀 Features
 
 - Add support for the basic commands (including ble stack upgrade)
 - Add cli crate with download-hex command
+- Add cli crate, change overall api and add support for fus and memory r/w
+- Rework cli using bpaf and cleanup code and structure
+- Add json output to cli
+- Add core register read and write functions
+
+### 🐛 Bug Fixes
+
+- Linux support of wrapper
+- Linux not building
+- Add missing update reason to output
+- Wrong symbol names for read and write of cortex register
 
 ### 🚜 Refactor
 
@@ -17,14 +28,26 @@ All notable changes to this project will be documented in this file.
 
 - Fix readme
 - Update readme
+- Fix .env file sample
+- Adjust readme
+- Add readme to sys crate
 
 ### ⚙️ Miscellaneous Tasks
 
-- Add changelog
+- Update changelog
+- Update changelog
+- Add github suggested workflow
+- Add readme files and metadata; fix clippy warnings
+- Add github workflow with checks
+- Fix clippy lints
+- Check docs
+- Do not fail fast to check the build on both os
+- Bump version of sys crate
 
 ### Build
 
 - Add git-cliff config to generate changelogs with conventional commits
 - Add justfile
+- Generate bindings via bindgen cli
 
 <!-- generated by git-cliff -->

Cargo.lock

@@ -1,3 +1,8 @@
+
+[default.extend-identifiers]
+# Typo in CubeProgrammer API symbol
+writeCortexRegistres = "writeCortexRegistres"
+
 [files]
 extend-exclude = [
     "stm32cubeprogrammer-sys/include",

_typos.toml

@@ -28,7 +28,7 @@ hardware_tests = []
 serde = ["dep:serde"]
 
 [dependencies]
-stm32cubeprogrammer-sys = { path = "../stm32cubeprogrammer-sys" }
+stm32cubeprogrammer-sys = { version = "0.1.1" }
 derive_more = { version = "1", features = [
     "from",
     "deref",
@@ -48,6 +48,9 @@ serde = { version = "1", optional = true, features = ["derive"] }
 
 ihex = { optional = true, version = "3.0" }
 
+# # [patch.crates-io]
+# stm32cubeprogrammer-sys = { path = "../stm32cubeprogrammer-sys" }
+
 [dev-dependencies]
 dotenvy.workspace = true
 test-log.workspace = true

stm32cubeprogrammer/Cargo.toml

@@ -6,7 +6,7 @@ This crate provides a high-level rust API for the STM32CubeProgrammer DLL.
 ```rust
 use stm32cubeprogrammer::{
     probe::{ConnectionParameters, Protocol, ResetMode},
-    CubeProgrammer,
+    CubeProgrammer, CoreRegister
 };
 
 // You need to supply the path to the root directory of the STM32CubeProgrammer installation
@@ -31,6 +31,16 @@ let connected = programmer
 
 println!("Target information: {}", connected.general_information());
 
+// Write and read core register R0
+let value = 0x12345678;
+connected
+    .write_core_register(CoreRegister::R0, value)
+    .expect("Failed to write core register");
+let r0 = connected
+    .read_core_register(CoreRegister::R0)
+    .expect("Failed to read core register");
+println!("R0: 0x{:08X}", r0);
+
 // If there are multiple connected probes with a target, you can establish multiple connections simultaneously
 let connected_other = programmer
     .connect_to_target(&probes[1], &Protocol::Swd, &ConnectionParameters::default())
@@ -58,6 +68,7 @@ More examples can be found in the `tests` directory.
 - Downloading files as hex or bin
 - Reading and writing memory
     - Uses the [`bytemuck::Pod`](https://docs.rs/bytemuck/1.21.0/bytemuck/trait.Pod.html) trait for reading and writing data from/to memory
+- Reading and writing of core registers
 - Resetting the target
 - Enabling and disabling readout protection (Level B)
 - Reset target

stm32cubeprogrammer/README.md

@@ -1,21 +1,32 @@
-use std::{
-    cell::RefCell,
-    collections::HashMap,
-    sync::{Arc, Mutex},
-};
-
 use crate::{
     api_log, api_types, display,
     error::{CubeProgrammerError, CubeProgrammerResult},
     utility,
 };
-
 use bon::bon;
 use derive_more::Into;
 use log::{debug, error};
+use std::{
+    cell::RefCell,
+    collections::HashMap,
+    sync::{Arc, Mutex},
+};
+use stm32cubeprogrammer_sys::libloading;
 use stm32cubeprogrammer_sys::SRAM_BASE_ADDRESS;
 
-use stm32cubeprogrammer_sys::libloading;
+macro_rules! verify_api_struct {
+    ($api:expr, $($field:ident),*) => {{
+        $(
+            match &$api.$field {
+                Ok(_) => (), // Symbol exists, continue
+                Err(err) => return Err(CubeProgrammerError::MissingDllSymbol{message: format!(
+                    "Missing symbol '{}': {}", stringify!($field), err
+                )}),
+            }
+        )*
+        Ok(())
+    }};
+}
 
 /// HashMap to store connected probes.
 /// The key is the serial number of the probe.
@@ -87,6 +98,34 @@ impl CubeProgrammer {
                 .map_err(CubeProgrammerError::LibLoading)?
         };
 
+        // Verify if all API functions are available before proceeding
+        verify_api_struct!(
+            api,
+            setVerbosityLevel,
+            setDisplayCallbacks,
+            setLoadersPath,
+            getStLinkList,
+            deleteInterfaceList,
+            connectStLink,
+            getDeviceGeneralInf,
+            disconnect,
+            startFus,
+            reset,
+            downloadFile,
+            massErase,
+            saveMemoryToFile,
+            sendOptionBytesCmd,
+            readUnprotect,
+            checkDeviceConnection,
+            readMemory,
+            freeLibraryMemory,
+            startWirelessStack,
+            writeCortexRegistres,
+            readCortexReg,
+            firmwareDelete,
+            firmwareUpgrade
+        )?;
+
         if let Some(display_callback) = display_callback {
             debug!("Set display callback handler");
             display::set_display_callback_handler(display_callback);
@@ -674,6 +713,10 @@ impl ConnectedProgrammer<'_> {
 
         let pod_data = pod_data.to_vec();
 
+        unsafe {
+            self.api().freeLibraryMemory(data as *mut std::ffi::c_void);
+        }
+
         if pod_data.len() != count {
             return Err(CubeProgrammerError::ActionOutputUnexpected {
                 action: crate::error::Action::ReadMemory,
@@ -735,7 +778,7 @@ impl ConnectedProgrammer<'_> {
         self.check_connection()?;
 
         api_types::ReturnCode::<0>::from(unsafe {
-            self.api().writeCoreRegister(register.into(), value)
+            self.api().writeCortexRegistres(register.into(), value)
         })
         .check(crate::error::Action::WriteCoreRegister)
     }
@@ -750,7 +793,7 @@ impl ConnectedProgrammer<'_> {
         let mut value = 0;
 
         api_types::ReturnCode::<0>::from(unsafe {
-            self.api().readCoreRegister(register.into(), &mut value)
+            self.api().readCortexReg(register.into(), &mut value)
         })
         .check(crate::error::Action::ReadCoreRegister)?;
 

stm32cubeprogrammer/src/cube_programmer.rs

@@ -79,4 +79,8 @@ pub enum CubeProgrammerError {
     FileIo(std::io::Error),
 
     LibLoading(stm32cubeprogrammer_sys::libloading::Error),
+
+    MissingDllSymbol {
+        message: String,
+    },
 }

stm32cubeprogrammer/src/error.rs

@@ -29,9 +29,14 @@
 //!
 //! println!("Target information: {}", connected.general_information());
 //!
-//! connected.write_core_register(CoreRegister::R0, 0x12345678).expect("Failed to write core register");
-//!
-//! let r0 = connected.read_core_register(CoreRegister::R0).expect("Failed to read core register");
+//! // Write and read core register R0
+//! let value = 0x12345678;
+//! connected
+//!     .write_core_register(CoreRegister::R0, value)
+//!     .expect("Failed to write core register");
+//! let r0 = connected
+//!     .read_core_register(CoreRegister::R0)
+//!     .expect("Failed to read core register");
 //! println!("R0: 0x{:08X}", r0);
 //!
 //! // If there are multiple connected probes with a target, you can establish multiple connections simultaneously

stm32cubeprogrammer/src/lib.rs

@@ -0,0 +1,36 @@
+#![cfg(feature = "hardware_tests")]
+
+use std::assert_eq;
+use stm32cubeprogrammer::CoreRegister;
+
+#[path = "./test_common.rs"]
+mod test_common;
+
+#[test_log::test]
+/// Test reading and writing memory on the target using a custom data structure which implements [`bytemuck::Pod`] and [`bytemuck::Zeroable`]
+fn read_and_write_core_register() {
+    let programmer = test_common::init_programmer();
+    let target_programmer = test_common::connect_to_target(
+        &programmer,
+        &stm32cubeprogrammer::probe::Protocol::Swd,
+        &stm32cubeprogrammer::probe::ConnectionParameters {
+            // Use under reset mode to halt the target before running any instructions
+            // to avoid the RAM being overwritten by the target firmware
+            connection_mode: stm32cubeprogrammer::probe::ConnectionMode::UnderReset,
+            ..Default::default()
+        },
+    );
+
+    let value = 0x12345678;
+    target_programmer
+        .write_core_register(CoreRegister::R0, value)
+        .expect("Failed to write core register");
+    let r0 = target_programmer
+        .read_core_register(CoreRegister::R0)
+        .expect("Failed to read core register");
+    println!("R0: 0x{:08X}", r0);
+
+    assert_eq!(r0, value);
+
+    // Drop also handles the disconnect
+}