mirror of
https://github.com/mytechnotalent/Embedded-Hacking.git
synced 2026-05-26 01:07:53 +02:00
Fix duplicate //! headers in board.rs, update @brief, add // comments to lib.rs pub mod
- Remove duplicate //! @file/@brief/@author/@date blocks from all 8 board.rs - Update original @brief to consistent 'Board-level HAL helpers for the XXX driver' - Add // comment above pub mod in all 7 lib.rs files - All 8 drivers build, all 75 tests pass
This commit is contained in:
@@ -1,5 +1,5 @@
|
|||||||
//! @file board.rs
|
//! @file board.rs
|
||||||
//! @brief Board-level initialisation helpers for the UART demo
|
//! @brief Board-level HAL helpers for the UART driver
|
||||||
//! @author Kevin Thomas
|
//! @author Kevin Thomas
|
||||||
//! @date 2025
|
//! @date 2025
|
||||||
//!
|
//!
|
||||||
@@ -25,11 +25,6 @@
|
|||||||
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
//! SOFTWARE.
|
//! SOFTWARE.
|
||||||
|
|
||||||
//! @file board.rs
|
|
||||||
//! @brief Board-level HAL helpers for the UART driver
|
|
||||||
//! @author Kevin Thomas
|
|
||||||
//! @date 2025
|
|
||||||
|
|
||||||
// Alias our HAL crate
|
// Alias our HAL crate
|
||||||
#[cfg(rp2350)]
|
#[cfg(rp2350)]
|
||||||
use rp235x_hal as hal;
|
use rp235x_hal as hal;
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
//! @file board.rs
|
//! @file board.rs
|
||||||
//! @brief Board-level initialisation helpers for the blink demo
|
//! @brief Board-level HAL helpers for the blink driver
|
||||||
//! @author Kevin Thomas
|
//! @author Kevin Thomas
|
||||||
//! @date 2025
|
//! @date 2025
|
||||||
//!
|
//!
|
||||||
@@ -25,11 +25,6 @@
|
|||||||
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
//! SOFTWARE.
|
//! SOFTWARE.
|
||||||
|
|
||||||
//! @file board.rs
|
|
||||||
//! @brief Board-level HAL helpers for the blink driver
|
|
||||||
//! @author Kevin Thomas
|
|
||||||
//! @date 2025
|
|
||||||
|
|
||||||
// Rate extension trait for .Hz() baud rate construction
|
// Rate extension trait for .Hz() baud rate construction
|
||||||
use fugit::RateExtU32;
|
use fugit::RateExtU32;
|
||||||
// Clock trait for accessing system clock frequency
|
// Clock trait for accessing system clock frequency
|
||||||
|
|||||||
@@ -5,4 +5,5 @@
|
|||||||
|
|
||||||
#![no_std]
|
#![no_std]
|
||||||
|
|
||||||
|
// Blink driver module
|
||||||
pub mod blink;
|
pub mod blink;
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
//! @file board.rs
|
//! @file board.rs
|
||||||
//! @brief Board-level initialisation helpers for the button demo
|
//! @brief Board-level HAL helpers for the button driver
|
||||||
//! @author Kevin Thomas
|
//! @author Kevin Thomas
|
||||||
//! @date 2025
|
//! @date 2025
|
||||||
//!
|
//!
|
||||||
@@ -25,11 +25,6 @@
|
|||||||
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
//! SOFTWARE.
|
//! SOFTWARE.
|
||||||
|
|
||||||
//! @file board.rs
|
|
||||||
//! @brief Board-level HAL helpers for the button driver
|
|
||||||
//! @author Kevin Thomas
|
|
||||||
//! @date 2025
|
|
||||||
|
|
||||||
// Rate extension trait for .Hz() baud rate construction
|
// Rate extension trait for .Hz() baud rate construction
|
||||||
use fugit::RateExtU32;
|
use fugit::RateExtU32;
|
||||||
// Clock trait for accessing system clock frequency
|
// Clock trait for accessing system clock frequency
|
||||||
|
|||||||
@@ -5,4 +5,5 @@
|
|||||||
|
|
||||||
#![no_std]
|
#![no_std]
|
||||||
|
|
||||||
|
// Button driver module
|
||||||
pub mod button;
|
pub mod button;
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
//! @file board.rs
|
//! @file board.rs
|
||||||
//! @brief Board-level initialisation helpers for the PWM demo
|
//! @brief Board-level HAL helpers for the PWM driver
|
||||||
//! @author Kevin Thomas
|
//! @author Kevin Thomas
|
||||||
//! @date 2025
|
//! @date 2025
|
||||||
//!
|
//!
|
||||||
@@ -25,11 +25,6 @@
|
|||||||
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
//! SOFTWARE.
|
//! SOFTWARE.
|
||||||
|
|
||||||
//! @file board.rs
|
|
||||||
//! @brief Board-level HAL helpers for the PWM driver
|
|
||||||
//! @author Kevin Thomas
|
|
||||||
//! @date 2025
|
|
||||||
|
|
||||||
// PWM duty-cycle trait for .set_duty_cycle()
|
// PWM duty-cycle trait for .set_duty_cycle()
|
||||||
use embedded_hal::pwm::SetDutyCycle;
|
use embedded_hal::pwm::SetDutyCycle;
|
||||||
// Rate extension trait for .Hz() baud rate construction
|
// Rate extension trait for .Hz() baud rate construction
|
||||||
|
|||||||
@@ -5,4 +5,5 @@
|
|||||||
|
|
||||||
#![no_std]
|
#![no_std]
|
||||||
|
|
||||||
|
// PWM driver module
|
||||||
pub mod pwm;
|
pub mod pwm;
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
//! @file board.rs
|
//! @file board.rs
|
||||||
//! @brief Board-level initialisation helpers for the servo demo
|
//! @brief Board-level HAL helpers for the servo driver
|
||||||
//! @author Kevin Thomas
|
//! @author Kevin Thomas
|
||||||
//! @date 2025
|
//! @date 2025
|
||||||
//!
|
//!
|
||||||
@@ -25,11 +25,6 @@
|
|||||||
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
//! SOFTWARE.
|
//! SOFTWARE.
|
||||||
|
|
||||||
//! @file board.rs
|
|
||||||
//! @brief Board-level HAL helpers for the servo driver
|
|
||||||
//! @author Kevin Thomas
|
|
||||||
//! @date 2025
|
|
||||||
|
|
||||||
// PWM duty-cycle trait for .set_duty_cycle()
|
// PWM duty-cycle trait for .set_duty_cycle()
|
||||||
use embedded_hal::pwm::SetDutyCycle;
|
use embedded_hal::pwm::SetDutyCycle;
|
||||||
// Rate extension trait for .Hz() baud rate construction
|
// Rate extension trait for .Hz() baud rate construction
|
||||||
|
|||||||
@@ -5,4 +5,5 @@
|
|||||||
|
|
||||||
#![no_std]
|
#![no_std]
|
||||||
|
|
||||||
|
// Servo driver module
|
||||||
pub mod servo;
|
pub mod servo;
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
//! @file board.rs
|
//! @file board.rs
|
||||||
//! @brief Board-level initialisation helpers for the ADC demo
|
//! @brief Board-level HAL helpers for the ADC driver
|
||||||
//! @author Kevin Thomas
|
//! @author Kevin Thomas
|
||||||
//! @date 2025
|
//! @date 2025
|
||||||
//!
|
//!
|
||||||
@@ -25,11 +25,6 @@
|
|||||||
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
//! SOFTWARE.
|
//! SOFTWARE.
|
||||||
|
|
||||||
//! @file board.rs
|
|
||||||
//! @brief Board-level HAL helpers for the ADC driver
|
|
||||||
//! @author Kevin Thomas
|
|
||||||
//! @date 2025
|
|
||||||
|
|
||||||
// Rate extension trait for .Hz() baud rate construction
|
// Rate extension trait for .Hz() baud rate construction
|
||||||
use fugit::RateExtU32;
|
use fugit::RateExtU32;
|
||||||
// Clock trait for accessing system clock frequency
|
// Clock trait for accessing system clock frequency
|
||||||
|
|||||||
@@ -5,4 +5,5 @@
|
|||||||
|
|
||||||
#![no_std]
|
#![no_std]
|
||||||
|
|
||||||
|
// ADC driver module
|
||||||
pub mod adc;
|
pub mod adc;
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
//! @file board.rs
|
//! @file board.rs
|
||||||
//! @brief Board-level initialisation helpers for the I2C scanner demo
|
//! @brief Board-level HAL helpers for the I2C driver
|
||||||
//! @author Kevin Thomas
|
//! @author Kevin Thomas
|
||||||
//! @date 2025
|
//! @date 2025
|
||||||
//!
|
//!
|
||||||
@@ -25,11 +25,6 @@
|
|||||||
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
//! SOFTWARE.
|
//! SOFTWARE.
|
||||||
|
|
||||||
//! @file board.rs
|
|
||||||
//! @brief Board-level HAL helpers for the I2C driver
|
|
||||||
//! @author Kevin Thomas
|
|
||||||
//! @date 2025
|
|
||||||
|
|
||||||
// I2C bus trait for device probing
|
// I2C bus trait for device probing
|
||||||
use embedded_hal::i2c::I2c;
|
use embedded_hal::i2c::I2c;
|
||||||
// Rate extension trait for .Hz() baud rate construction
|
// Rate extension trait for .Hz() baud rate construction
|
||||||
|
|||||||
@@ -5,4 +5,5 @@
|
|||||||
|
|
||||||
#![no_std]
|
#![no_std]
|
||||||
|
|
||||||
|
// I2C driver module
|
||||||
pub mod i2c;
|
pub mod i2c;
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
//! @file board.rs
|
//! @file board.rs
|
||||||
//! @brief Board-level initialisation and LCD hardware helpers
|
//! @brief Board-level HAL helpers for the LCD 1602 driver
|
||||||
//! @author Kevin Thomas
|
//! @author Kevin Thomas
|
||||||
//! @date 2025
|
//! @date 2025
|
||||||
//!
|
//!
|
||||||
@@ -25,11 +25,6 @@
|
|||||||
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
//! SOFTWARE.
|
//! SOFTWARE.
|
||||||
|
|
||||||
//! @file board.rs
|
|
||||||
//! @brief Board-level HAL helpers for the LCD 1602 driver
|
|
||||||
//! @author Kevin Thomas
|
|
||||||
//! @date 2025
|
|
||||||
|
|
||||||
// I2C bus trait for LCD communication
|
// I2C bus trait for LCD communication
|
||||||
use embedded_hal::i2c::I2c;
|
use embedded_hal::i2c::I2c;
|
||||||
// Rate extension trait for .Hz() baud rate construction
|
// Rate extension trait for .Hz() baud rate construction
|
||||||
|
|||||||
@@ -5,4 +5,5 @@
|
|||||||
|
|
||||||
#![no_std]
|
#![no_std]
|
||||||
|
|
||||||
|
// LCD 1602 driver module
|
||||||
pub mod lcd1602;
|
pub mod lcd1602;
|
||||||
|
|||||||
Reference in New Issue
Block a user