mirror of
https://github.com/mytechnotalent/Embedded-Hacking.git
synced 2026-05-30 11:09:30 +02:00
Kevin Thomas
e54c756423
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
87 lines
3.0 KiB
C
87 lines
3.0 KiB
C
/**
|
|
* @file 0x0f_flash.c
|
|
* @brief On-chip flash write/read demo using flash.c/flash.h
|
|
* @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 on-chip flash read/write using the flash driver
|
|
* (flash.h / flash.c). A string is written to the last sector of flash
|
|
* and then read back to verify. The result is printed over UART.
|
|
*
|
|
* Wiring:
|
|
* No external wiring required
|
|
*/
|
|
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
#include "pico/stdlib.h"
|
|
#include "flash.h"
|
|
|
|
/** @brief Byte offset from flash start for demo write target */
|
|
#define FLASH_TARGET_OFFSET (FLASH_DRIVER_SIZE_BYTES - FLASH_DRIVER_SECTOR_SIZE)
|
|
/** @brief Number of bytes to write in the flash demo */
|
|
#define FLASH_WRITE_LEN FLASH_DRIVER_PAGE_SIZE
|
|
|
|
/**
|
|
* @brief Fill a write buffer with 0xFF and copy the demo string into it
|
|
*
|
|
* @param buf Destination buffer
|
|
* @param buf_size Size of the buffer in bytes
|
|
*/
|
|
static void _prepare_write_buf(uint8_t *buf, size_t buf_size) {
|
|
memset(buf, 0xFF, buf_size);
|
|
const char *msg = "Embedded Hacking flash driver demo";
|
|
memcpy(buf, msg, strlen(msg) + 1);
|
|
}
|
|
|
|
/**
|
|
* @brief Write the demo string to flash and print the read-back result
|
|
*/
|
|
static void _write_and_verify(void) {
|
|
static uint8_t write_buf[FLASH_WRITE_LEN];
|
|
static uint8_t read_buf[FLASH_WRITE_LEN];
|
|
_prepare_write_buf(write_buf, sizeof(write_buf));
|
|
flash_driver_write(FLASH_TARGET_OFFSET, write_buf, FLASH_WRITE_LEN);
|
|
flash_driver_read(FLASH_TARGET_OFFSET, read_buf, FLASH_WRITE_LEN);
|
|
printf("Flash readback: %s\r\n", read_buf);
|
|
}
|
|
|
|
/**
|
|
* @brief Application entry point for the on-chip flash demo
|
|
*
|
|
* Writes a demo string to the last flash sector, reads it back,
|
|
* and prints the result over UART.
|
|
*
|
|
* @return int Does not return
|
|
*/
|
|
int main(void) {
|
|
stdio_init_all();
|
|
_write_and_verify();
|
|
while (true)
|
|
tight_loop_contents();
|
|
}
|