mirror of
https://github.com/mytechnotalent/Embedded-Hacking.git
synced 2026-04-30 23:08:19 +02:00
Kevin Thomas
3604b3c921
Rust (all 15 projects):
- Refactored overlength functions: format_counter, format_u8, format_f32_1,
format_u32_minimal, gpio_drive, read_sensor, poll_sensor, format_round_trip,
format_u32, prepare_write_buf, write_min_digits, write_temp, UartDriver::init,
init_spi, angle_to_pulse_us, compute_servo_level
- Added 200+ docstrings to test functions, mock structs, impl blocks
- Fixed pub static comments (//) to doc comments (///) in all main.rs files
- Fixed helper function ordering (helpers above callers)
- Fixed Fn(u32) -> FnMut(u32) bound in button poll_button
- Moved OneShot trait import from main.rs to board.rs in adc project
- Added unsafe {} blocks in flash unsafe fn bodies (Rust 2024 edition)
- Removed unused hal::Clock imports from pwm/servo main.rs
- All 15 projects build with zero errors and zero warnings
C Pico SDK (all 15 projects):
- Added docstrings to all public functions, macros, and static variables
- All 15 projects rebuilt with zero errors
Cleanup:
- Removed build/ and target/ directories from git tracking
- Added target/ to .gitignore
- Deleted temporary fix_rust_docs.py script
94 lines
3.0 KiB
Rust
94 lines
3.0 KiB
Rust
//! @file main.rs
|
|
//! @brief Repeating timer demo using timer.rs
|
|
//! @author Kevin Thomas
|
|
//! @date 2025
|
|
//!
|
|
//! MIT License
|
|
//!
|
|
//! Copyright (c) 2025 Kevin Thomas
|
|
//!
|
|
//! Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
//! of this software and associated documentation files (the "Software"), to deal
|
|
//! in the Software without restriction, including without limitation the rights
|
|
//! to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
//! copies of the Software, and to permit persons to whom the Software is
|
|
//! furnished to do so, subject to the following conditions:
|
|
//!
|
|
//! The above copyright notice and this permission notice shall be included in
|
|
//! all copies or substantial portions of the Software.
|
|
//!
|
|
//! THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
//! IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
//! FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
//! AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
//! LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
//! SOFTWARE.
|
|
//!
|
|
//! -----------------------------------------------------------------------------
|
|
//!
|
|
//! Demonstrates repeating timer callbacks using the timer driver
|
|
//! (timer.rs). A one-second heartbeat timer prints a message
|
|
//! over UART to confirm the timer is firing.
|
|
//!
|
|
//! Wiring:
|
|
//! No external wiring required
|
|
|
|
#![no_std]
|
|
#![no_main]
|
|
|
|
// Board-level helpers: constants, type aliases, and init functions
|
|
mod board;
|
|
// Timer driver module — suppress warnings for unused public API functions
|
|
#[allow(dead_code)]
|
|
mod timer;
|
|
|
|
// Debugging output over RTT
|
|
use defmt_rtt as _;
|
|
// Panic handler for RISC-V targets
|
|
#[cfg(target_arch = "riscv32")]
|
|
use panic_halt as _;
|
|
// Panic handler for ARM targets
|
|
#[cfg(target_arch = "arm")]
|
|
use panic_probe as _;
|
|
|
|
// HAL entry-point macro
|
|
use hal::entry;
|
|
|
|
// Alias our HAL crate
|
|
#[cfg(rp2350)]
|
|
use rp235x_hal as hal;
|
|
#[cfg(rp2040)]
|
|
use rp2040_hal as hal;
|
|
|
|
/// Second-stage boot loader for RP2040
|
|
#[unsafe(link_section = ".boot2")]
|
|
#[used]
|
|
#[cfg(rp2040)]
|
|
pub static BOOT2: [u8; 256] = rp2040_boot2::BOOT_LOADER_W25Q080;
|
|
|
|
/// Boot metadata for the RP2350 Boot ROM
|
|
#[unsafe(link_section = ".start_block")]
|
|
#[used]
|
|
#[cfg(rp2350)]
|
|
pub static IMAGE_DEF: hal::block::ImageDef = hal::block::ImageDef::secure_exe();
|
|
|
|
/// Application entry point for the repeating timer demo.
|
|
#[entry]
|
|
fn main() -> ! {
|
|
board::run(hal::pac::Peripherals::take().unwrap())
|
|
}
|
|
|
|
/// Picotool binary info metadata
|
|
#[unsafe(link_section = ".bi_entries")]
|
|
#[used]
|
|
pub static PICOTOOL_ENTRIES: [hal::binary_info::EntryAddr; 5] = [
|
|
hal::binary_info::rp_cargo_bin_name!(),
|
|
hal::binary_info::rp_cargo_version!(),
|
|
hal::binary_info::rp_program_description!(c"Repeating Timer Demo"),
|
|
hal::binary_info::rp_cargo_homepage_url!(),
|
|
hal::binary_info::rp_program_build_attribute!(),
|
|
];
|
|
|
|
// End of file
|