docs

va108xx-hal/src/gpio/mod.rs

@@ -1,4 +1,17 @@
 //! GPIO support module.
+//!
+//! Contains abstractions to use the pins provided by the [crate::pins] module as GPIO or
+//! IO peripheral pins.
+//!
+//! The core data structures provided for this are the
+//!
+//! - [Output] for push-pull output pins.
+//! - [Input] for input pins.
+//! - [Flex] for pins with flexible configuration requirements.
+//! - [IoPeriphPin] for IO peripheral pins.
+//!
+//! The [crate::pins] module exposes singletons to access the [Pin]s required by this module
+//! in a type-safe way.
 pub use vorago_shared_periphs::gpio::*;
 
 pub use vorago_shared_periphs::gpio::asynch;

va108xx-hal/src/pins.rs

@@ -1,3 +1,8 @@
+//! Pin resource management singletons.
+//!
+//! This module contains the pin singletons. It allows creating those singletons
+//! to access the [Pin] structures of individual ports in a safe way with checked ownership
+//! rules.
 use vorago_shared_periphs::sysconfig::reset_peripheral_for_cycles;
 
 pub use crate::gpio::{Pin, PinId, PinIdProvider, Port};