Files
Embedded-Hacking/drivers/0x0c_multicore/multicore.c
T
Kevin Thomas e54c756423 refactor: enforce max 8 code lines, add docstrings, fix warnings across all Rust and C SDK projects
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
2026-04-06 08:33:17 -04:00

69 lines
2.3 KiB
C

/**
* @file multicore.c
* @brief Implementation of multicore FIFO driver for RP2350
* @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.
*/
#include "multicore.h"
#include "pico/multicore.h"
/**
* @brief Start the provided function on core 1
*
* Launches the given entry function on the second RP2350 core using the
* Pico SDK multicore_launch_core1() API. The function will run
* concurrently with core 0 from the moment this call returns.
*
* @param core1_entry Pointer to the void(void) function to run on core 1
*/
void multicore_driver_launch(void (*core1_entry)(void)) {
multicore_launch_core1(core1_entry);
}
/**
* @brief Push a 32-bit value into the inter-core FIFO (blocking)
*
* Writes data to the FIFO that core 1 reads from. Blocks until
* there is space in the hardware FIFO.
*
* @param data 32-bit value to send to core 1
*/
void multicore_driver_push(uint32_t data) {
multicore_fifo_push_blocking(data);
}
/**
* @brief Pop a 32-bit value from the inter-core FIFO (blocking)
*
* Reads one entry from the FIFO that core 1 writes into. Blocks until
* a value is available.
*
* @return uint32_t Value received from core 1
*/
uint32_t multicore_driver_pop(void) {
return multicore_fifo_pop_blocking();
}