feat: Implement modular workspace structure with HAL and platform abstractions

rusty1968 · rusty1968 · commit 128cc6611441 · 2025-07-25T08:49:52.000-07:00
- Add HAL layers with strict safety guarantees:
  * hal/blocking - Blocking/synchronous HAL traits
  * hal/async - Async HAL traits
  * hal/nb - Non-blocking HAL traits
  * All HAL crates forbid unsafe code and require documentation

- Add platform abstraction layer:
  * platform/traits - Core OS abstraction traits (empty, ready for future traits)
  * platform/impls/{linux,tock,hubris} - Platform-specific implementations
  * Enforces strict safety and documentation requirements

- Add service layer scaffolding:
  * services/telemetry - Telemetry and monitoring service
  * services/storage - Persistent storage service

- Add comprehensive build automation via cargo-xtask with precheckin validation
- Remove git submodules in favor of direct dependencies when needed

The workspace follows Rust best practices with clear separation of concerns between
hardware abstraction, platform abstraction, and service layers.
diff --git a/.gitmodules b/.gitmodules
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -4,5 +4,14 @@
 members = [
     "openprot",
     "xtask",
+    "hal/blocking",
+    "hal/async", 
+    "hal/nb",
+    "platform/traits",
+    "platform/impls/linux",
+    "platform/impls/tock",
+    "platform/impls/hubris",
+    "services/telemetry",
+    "services/storage",
 ]
 resolver = "2"
diff --git a/external/mctp-lib b/external/mctp-lib
diff --git a/external/pldm-lib b/external/pldm-lib
diff --git a/external/spdm-lib b/external/spdm-lib
diff --git a/hal/async/Cargo.toml b/hal/async/Cargo.toml
@@ -0,0 +1,11 @@
+# Licensed under the Apache-2.0 license
+
+[package]
+name = "openprot-hal-async"
+version = "0.1.0"
+edition = "2021"
+description = "Async HAL traits for OpenPRoT"
+license = "Apache-2.0"
+
+[dependencies]
+embedded-hal-async = "1.0"
diff --git a/hal/async/src/lib.rs b/hal/async/src/lib.rs
@@ -0,0 +1,13 @@
+// Licensed under the Apache-2.0 license
+
+//! Async HAL traits for OpenPRoT
+//!
+//! This crate re-exports embedded-hal-async 1.0 traits for async/await-based
+//! hardware abstraction layer operations compatible with modern async runtimes.
+
+#![no_std]
+#![forbid(unsafe_code)]
+#![deny(missing_docs)]
+
+// Re-export embedded-hal-async 1.0 traits
+pub use embedded_hal_async::*;
diff --git a/hal/blocking/Cargo.toml b/hal/blocking/Cargo.toml
@@ -0,0 +1,11 @@
+# Licensed under the Apache-2.0 license
+
+[package]
+name = "openprot-hal-blocking"
+version = "0.1.0"
+edition = "2021"
+description = "Blocking/synchronous HAL traits for OpenPRoT"
+license = "Apache-2.0"
+
+[dependencies]
+embedded-hal = "1.0"
diff --git a/hal/blocking/src/lib.rs b/hal/blocking/src/lib.rs
@@ -0,0 +1,16 @@
+// Licensed under the Apache-2.0 license
+
+//! Blocking/synchronous HAL traits for OpenPRoT
+//!
+//! This crate re-exports embedded-hal 1.0 traits for blocking hardware abstraction
+//! layer operations such as SPI, I2C, GPIO, and other hardware interfaces.
+
+#![no_std]
+#![forbid(unsafe_code)]
+#![deny(missing_docs)]
+
+// Re-export embedded-hal 1.0 traits
+pub use embedded_hal::delay::DelayNs;
+pub use embedded_hal::digital::{InputPin, OutputPin, StatefulOutputPin};
+pub use embedded_hal::i2c::{I2c, SevenBitAddress, TenBitAddress};
+pub use embedded_hal::spi::{SpiBus, SpiDevice};
diff --git a/hal/nb/Cargo.toml b/hal/nb/Cargo.toml
@@ -0,0 +1,12 @@
+# Licensed under the Apache-2.0 license
+
+[package]
+name = "openprot-hal-nb"
+version = "0.1.0"
+edition = "2021"
+description = "Non-blocking HAL traits for OpenPRoT"
+license = "Apache-2.0"
+
+[dependencies]
+embedded-hal-nb = "1.0"
+nb = "1.0"
diff --git a/hal/nb/src/lib.rs b/hal/nb/src/lib.rs
@@ -0,0 +1,14 @@
+// Licensed under the Apache-2.0 license
+
+//! Non-blocking HAL traits for OpenPRoT
+//!
+//! This crate re-exports embedded-hal-nb 1.0 traits for non-blocking, polling-based
+//! hardware abstraction layer operations using the `nb` crate for error handling.
+
+#![no_std]
+#![forbid(unsafe_code)]
+#![deny(missing_docs)]
+
+// Re-export nb and embedded-hal-nb 1.0 traits
+pub use embedded_hal_nb::*;
+pub use nb;
diff --git a/platform/impls/hubris/Cargo.toml b/platform/impls/hubris/Cargo.toml
@@ -0,0 +1,11 @@
+# Licensed under the Apache-2.0 license
+
+[package]
+name = "openprot-platform-hubris"
+version = "0.1.0"
+edition = "2021"
+description = "Hubris OS platform implementation for OpenPRoT"
+license = "Apache-2.0"
+
+[dependencies]
+openprot-platform-traits = { path = "../../traits" }
diff --git a/platform/impls/hubris/src/lib.rs b/platform/impls/hubris/src/lib.rs
@@ -0,0 +1,7 @@
+// Licensed under the Apache-2.0 license
+
+//! Hubris OS platform implementation for OpenPRoT
+//!
+//! This crate provides Hubris OS-specific implementations of platform abstraction traits.
+
+#![no_std]
diff --git a/platform/impls/linux/Cargo.toml b/platform/impls/linux/Cargo.toml
@@ -0,0 +1,11 @@
+# Licensed under the Apache-2.0 license
+
+[package]
+name = "openprot-platform-linux"
+version = "0.1.0"
+edition = "2021"
+description = "Linux platform implementation for OpenPRoT"
+license = "Apache-2.0"
+
+[dependencies]
+openprot-platform-traits = { path = "../../traits" }
diff --git a/platform/impls/linux/src/lib.rs b/platform/impls/linux/src/lib.rs
@@ -0,0 +1,5 @@
+// Licensed under the Apache-2.0 license
+
+//! Linux platform implementation for OpenPRoT
+//!
+//! This crate provides Linux-specific implementations of platform abstraction traits.
diff --git a/platform/impls/tock/Cargo.toml b/platform/impls/tock/Cargo.toml
@@ -0,0 +1,11 @@
+# Licensed under the Apache-2.0 license
+
+[package]
+name = "openprot-platform-tock"
+version = "0.1.0"
+edition = "2021"
+description = "Tock OS platform implementation for OpenPRoT"
+license = "Apache-2.0"
+
+[dependencies]
+openprot-platform-traits = { path = "../../traits" }
diff --git a/platform/impls/tock/src/lib.rs b/platform/impls/tock/src/lib.rs
@@ -0,0 +1,7 @@
+// Licensed under the Apache-2.0 license
+
+//! Tock OS platform implementation for OpenPRoT
+//!
+//! This crate provides Tock OS-specific implementations of platform abstraction traits.
+
+#![no_std]
diff --git a/platform/traits/Cargo.toml b/platform/traits/Cargo.toml
@@ -0,0 +1,10 @@
+# Licensed under the Apache-2.0 license
+
+[package]
+name = "openprot-platform-traits"
+version = "0.1.0"
+edition = "2021"
+description = "OS abstraction traits for OpenPRoT"
+license = "Apache-2.0"
+
+[dependencies]
diff --git a/platform/traits/src/lib.rs b/platform/traits/src/lib.rs
@@ -0,0 +1,12 @@
+// Licensed under the Apache-2.0 license
+
+//! OS abstraction traits for OpenPRoT
+//!
+//! This crate defines the core OS abstraction traits that provide a uniform interface
+//! for cross-platform compatibility across different operating systems and embedded platforms.
+
+#![no_std]
+#![forbid(unsafe_code)]
+#![deny(missing_docs)]
+
+// Platform abstraction traits will be defined here
diff --git a/services/storage/Cargo.toml b/services/storage/Cargo.toml
@@ -0,0 +1,10 @@
+# Licensed under the Apache-2.0 license
+
+[package]
+name = "openprot-services-storage"
+version = "0.1.0"
+edition = "2021"
+description = "Persistent storage service and abstractions for OpenPRoT"
+license = "Apache-2.0"
+
+[dependencies]
diff --git a/services/storage/src/lib.rs b/services/storage/src/lib.rs
@@ -0,0 +1,7 @@
+// Licensed under the Apache-2.0 license
+
+//! Persistent storage service and abstractions for OpenPRoT
+//!
+//! This crate provides storage abstractions and persistence capabilities.
+
+#![no_std]
diff --git a/services/telemetry/Cargo.toml b/services/telemetry/Cargo.toml
@@ -0,0 +1,10 @@
+# Licensed under the Apache-2.0 license
+
+[package]
+name = "openprot-services-telemetry"
+version = "0.1.0"
+edition = "2021"
+description = "Telemetry, monitoring, and logging service for OpenPRoT"
+license = "Apache-2.0"
+
+[dependencies]
diff --git a/services/telemetry/src/lib.rs b/services/telemetry/src/lib.rs
@@ -0,0 +1,7 @@
+// Licensed under the Apache-2.0 license
+
+//! Telemetry, monitoring, and logging service for OpenPRoT
+//!
+//! This crate provides telemetry collection and monitoring capabilities.
+
+#![no_std]
