Merge pull request probe-rs#3 from vccnfitingh/optional-functions-as-features

Yatekii · web-flow · commit 0b24c514add9 · 2023-02-23T22:32:58.000+01:00
Make EraseChip optional
diff --git a/Cargo.toml b/Cargo.toml
@@ -9,3 +9,7 @@ repository = "https://github.com/probe-rs/flash-algorithm"
 description = "A crate to write CMSIS-DAP flash algorithms for flashing embedded targets."
 
 [dependencies]
+
+[features]
+default = ["erase-chip"]
+erase-chip = []
diff --git a/src/lib.rs b/src/lib.rs
@@ -32,6 +32,7 @@ pub trait FlashAlgorithm: Sized + 'static {
     fn new(address: u32, clock: u32, function: Function) -> Result<Self, ErrorCode>;
 
     /// Erase entire chip. Will only be called after [`FlashAlgorithm::new()`] with [`Function::Erase`].
+    #[cfg(feature = "erase-chip")]
     fn erase_all(&mut self) -> Result<(), ErrorCode>;
 
     /// Erase sector. Will only be called after [`FlashAlgorithm::new()`] with [`Function::Erase`].
@@ -110,18 +111,6 @@ macro_rules! algorithm {
         }
         #[no_mangle]
         #[link_section = ".entry"]
-        pub unsafe extern "C" fn EraseChip() -> u32 {
-            if !_IS_INIT {
-                return 1;
-            }
-            let this = &mut *_ALGO_INSTANCE.as_mut_ptr();
-            match <$type as FlashAlgorithm>::erase_all(this) {
-                Ok(()) => 0,
-                Err(e) => e.get(),
-            }
-        }
-        #[no_mangle]
-        #[link_section = ".entry"]
         pub unsafe extern "C" fn EraseSector(addr: u32) -> u32 {
             if !_IS_INIT {
                 return 1;
@@ -145,6 +134,7 @@ macro_rules! algorithm {
                 Err(e) => e.get(),
             }
         }
+        $crate::erase_chip!($type);
 
         #[allow(non_upper_case_globals)]
         #[no_mangle]
@@ -210,6 +200,32 @@ macro_rules! algorithm {
     };
 }
 
+#[doc(hidden)]
+#[macro_export]
+#[cfg(not(feature = "erase-chip"))]
+macro_rules! erase_chip {
+    ($type:ty) => {}
+}
+#[doc(hidden)]
+#[macro_export]
+#[cfg(feature = "erase-chip")]
+macro_rules! erase_chip {
+    ($type:ty) => {
+        #[no_mangle]
+        #[link_section = ".entry"]
+        pub unsafe extern "C" fn EraseChip() -> u32 {
+            if !_IS_INIT {
+                return 1;
+            }
+            let this = &mut *_ALGO_INSTANCE.as_mut_ptr();
+            match <$type as FlashAlgorithm>::erase_all(this) {
+                Ok(()) => 0,
+                Err(e) => e.get(),
+            }
+        }
+    }
+}
+
 #[doc(hidden)]
 #[macro_export]
 macro_rules! count {
