Merge pull request #16 from Neotron-Compute/api_fixes

API fixes

Author: thejpster

README.md

@@ -47,6 +47,8 @@ dual licensed as above, without any additional terms or conditions.
 * Add `bus_interrupt_status`
 * Remove `delay`
 * Add back in the `block_XXX` API for reading/writing Block Devices.
+* Add idle function.
+* `memory_get_region` returns `Option`, not `Result`
 
 ### v0.6.1
 

src/lib.rs

@@ -301,7 +301,7 @@ pub struct Api {
 	/// (if any), or from the top of Region 0 (although this reduces the maximum
 	/// application space available). The OS will prefer lower numbered regions
 	/// (other than Region 0), so faster memory should be listed first.
-	pub memory_get_region: extern "C" fn(region_index: u8) -> crate::Result<types::MemoryRegion>,
+	pub memory_get_region: extern "C" fn(region_index: u8) -> crate::Option<types::MemoryRegion>,
 
 	// ========================================================================
 	// Human Interface Device Support
@@ -579,6 +579,15 @@ pub struct Api {
 		num_blocks: u8,
 		data: ApiByteSlice,
 	) -> crate::Result<()>,
+
+	// ========================================================================
+	// Power management functions
+	// ========================================================================
+	/// The OS will call this function when it's idle.
+	///
+	/// On a microcontroller, this will wait for interrupts. Running in an
+	/// emulator, this will sleep the thread for a while.
+	pub power_idle: extern "C" fn(),
 }
 
 // ============================================================================