Refactor Rust drivers for strict idiomatic documentation and 8-line enforcement

This commit is contained in:
Kevin Thomas
2023-10-06 14:27:20 -04:00
commit 46e8b76762
1231 changed files with 110385 additions and 0 deletions
+2
View File
@@ -0,0 +1,2 @@
build
!.vscode/*
+22
View File
@@ -0,0 +1,22 @@
{
"configurations": [
{
"name": "Pico",
"includePath": [
"${workspaceFolder}/**",
"${userHome}/.pico-sdk/sdk/2.2.0/**"
],
"forcedInclude": [
"${workspaceFolder}/build/generated/pico_base/pico/config_autogen.h",
"${userHome}/.pico-sdk/sdk/2.2.0/src/common/pico_base_headers/include/pico.h"
],
"defines": [],
"compilerPath": "${userHome}/.pico-sdk/toolchain/14_2_Rel1/bin/arm-none-eabi-gcc.exe",
"compileCommands": "${workspaceFolder}/build/compile_commands.json",
"cStandard": "c17",
"cppStandard": "c++14",
"intelliSenseMode": "linux-gcc-arm"
}
],
"version": 4
}
+15
View File
@@ -0,0 +1,15 @@
[
{
"name": "Pico",
"compilers": {
"C": "${command:raspberry-pi-pico.getCompilerPath}",
"CXX": "${command:raspberry-pi-pico.getCxxCompilerPath}"
},
"environmentVariables": {
"PATH": "${command:raspberry-pi-pico.getEnvPath};${env:PATH}"
},
"cmakeSettings": {
"Python3_EXECUTABLE": "${command:raspberry-pi-pico.getPythonPath}"
}
}
]
+9
View File
@@ -0,0 +1,9 @@
{
"recommendations": [
"marus25.cortex-debug",
"ms-vscode.cpptools",
"ms-vscode.cpptools-extension-pack",
"ms-vscode.vscode-serial-monitor",
"raspberry-pi.raspberry-pi-pico"
]
}
+50
View File
@@ -0,0 +1,50 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Pico Debug (Cortex-Debug)",
"cwd": "${userHome}/.pico-sdk/openocd/0.12.0+dev/scripts",
"executable": "${command:raspberry-pi-pico.launchTargetPath}",
"request": "launch",
"type": "cortex-debug",
"servertype": "openocd",
"serverpath": "${userHome}/.pico-sdk/openocd/0.12.0+dev/openocd.exe",
"gdbPath": "${command:raspberry-pi-pico.getGDBPath}",
"device": "${command:raspberry-pi-pico.getChipUppercase}",
"configFiles": [
"interface/cmsis-dap.cfg",
"target/${command:raspberry-pi-pico.getTarget}.cfg"
],
"svdFile": "${userHome}/.pico-sdk/sdk/2.2.0/src/${command:raspberry-pi-pico.getChip}/hardware_regs/${command:raspberry-pi-pico.getChipUppercase}.svd",
"runToEntryPoint": "main",
// Fix for no_flash binaries, where monitor reset halt doesn't do what is expected
// Also works fine for flash binaries
"overrideLaunchCommands": [
"monitor reset init",
"load \"${command:raspberry-pi-pico.launchTargetPath}\""
],
"openOCDLaunchCommands": [
"adapter speed 5000"
]
},
{
"name": "Pico Debug (Cortex-Debug with external OpenOCD)",
"cwd": "${workspaceRoot}",
"executable": "${command:raspberry-pi-pico.launchTargetPath}",
"request": "launch",
"type": "cortex-debug",
"servertype": "external",
"gdbTarget": "localhost:3333",
"gdbPath": "${command:raspberry-pi-pico.getGDBPath}",
"device": "${command:raspberry-pi-pico.getChipUppercase}",
"svdFile": "${userHome}/.pico-sdk/sdk/2.2.0/src/${command:raspberry-pi-pico.getChip}/hardware_regs/${command:raspberry-pi-pico.getChipUppercase}.svd",
"runToEntryPoint": "main",
// Fix for no_flash binaries, where monitor reset halt doesn't do what is expected
// Also works fine for flash binaries
"overrideLaunchCommands": [
"monitor reset init",
"load \"${command:raspberry-pi-pico.launchTargetPath}\""
]
},
]
}
+40
View File
@@ -0,0 +1,40 @@
{
"cmake.showSystemKits": false,
"cmake.options.statusBarVisibility": "hidden",
"cmake.options.advanced": {
"build": {
"statusBarVisibility": "hidden"
},
"launch": {
"statusBarVisibility": "hidden"
},
"debug": {
"statusBarVisibility": "hidden"
}
},
"cmake.configureOnEdit": false,
"cmake.automaticReconfigure": false,
"cmake.configureOnOpen": false,
"cmake.generator": "Ninja",
"cmake.cmakePath": "${userHome}/.pico-sdk/cmake/v3.31.5/bin/cmake",
"C_Cpp.debugShortcut": false,
"terminal.integrated.env.windows": {
"PICO_SDK_PATH": "${env:USERPROFILE}/.pico-sdk/sdk/2.2.0",
"PICO_TOOLCHAIN_PATH": "${env:USERPROFILE}/.pico-sdk/toolchain/14_2_Rel1",
"Path": "${env:USERPROFILE}/.pico-sdk/toolchain/14_2_Rel1/bin;${env:USERPROFILE}/.pico-sdk/picotool/2.2.0-a4/picotool;${env:USERPROFILE}/.pico-sdk/cmake/v3.31.5/bin;${env:USERPROFILE}/.pico-sdk/ninja/v1.12.1;${env:PATH}"
},
"terminal.integrated.env.osx": {
"PICO_SDK_PATH": "${env:HOME}/.pico-sdk/sdk/2.2.0",
"PICO_TOOLCHAIN_PATH": "${env:HOME}/.pico-sdk/toolchain/14_2_Rel1",
"PATH": "${env:HOME}/.pico-sdk/toolchain/14_2_Rel1/bin:${env:HOME}/.pico-sdk/picotool/2.2.0-a4/picotool:${env:HOME}/.pico-sdk/cmake/v3.31.5/bin:${env:HOME}/.pico-sdk/ninja/v1.12.1:${env:PATH}"
},
"terminal.integrated.env.linux": {
"PICO_SDK_PATH": "${env:HOME}/.pico-sdk/sdk/2.2.0",
"PICO_TOOLCHAIN_PATH": "${env:HOME}/.pico-sdk/toolchain/14_2_Rel1",
"PATH": "${env:HOME}/.pico-sdk/toolchain/14_2_Rel1/bin:${env:HOME}/.pico-sdk/picotool/2.2.0-a4/picotool:${env:HOME}/.pico-sdk/cmake/v3.31.5/bin:${env:HOME}/.pico-sdk/ninja/v1.12.1:${env:PATH}"
},
"raspberry-pi-pico.cmakeAutoConfigure": true,
"raspberry-pi-pico.useCmakeTools": false,
"raspberry-pi-pico.cmakePath": "${HOME}/.pico-sdk/cmake/v3.31.5/bin/cmake",
"raspberry-pi-pico.ninjaPath": "${HOME}/.pico-sdk/ninja/v1.12.1/ninja"
}
+102
View File
@@ -0,0 +1,102 @@
{
"version": "2.0.0",
"tasks": [
{
"label": "Compile Project",
"type": "process",
"isBuildCommand": true,
"command": "${userHome}/.pico-sdk/ninja/v1.12.1/ninja",
"args": ["-C", "${workspaceFolder}/build"],
"group": "build",
"presentation": {
"reveal": "always",
"panel": "dedicated"
},
"problemMatcher": "$gcc",
"windows": {
"command": "${env:USERPROFILE}/.pico-sdk/ninja/v1.12.1/ninja.exe"
}
},
{
"label": "Run Project",
"type": "process",
"command": "${env:HOME}/.pico-sdk/picotool/2.2.0-a4/picotool/picotool",
"args": [
"load",
"${command:raspberry-pi-pico.launchTargetPath}",
"-fx"
],
"presentation": {
"reveal": "always",
"panel": "dedicated"
},
"problemMatcher": [],
"windows": {
"command": "${env:USERPROFILE}/.pico-sdk/picotool/2.2.0-a4/picotool/picotool.exe"
}
},
{
"label": "Flash",
"type": "process",
"command": "${userHome}/.pico-sdk/openocd/0.12.0+dev/openocd.exe",
"args": [
"-s",
"${userHome}/.pico-sdk/openocd/0.12.0+dev/scripts",
"-f",
"interface/cmsis-dap.cfg",
"-f",
"target/${command:raspberry-pi-pico.getTarget}.cfg",
"-c",
"adapter speed 5000; program \"${command:raspberry-pi-pico.launchTargetPath}\" verify reset exit"
],
"problemMatcher": [],
"windows": {
"command": "${env:USERPROFILE}/.pico-sdk/openocd/0.12.0+dev/openocd.exe",
}
},
{
"label": "Rescue Reset",
"type": "process",
"command": "${userHome}/.pico-sdk/openocd/0.12.0+dev/openocd.exe",
"args": [
"-s",
"${userHome}/.pico-sdk/openocd/0.12.0+dev/scripts",
"-f",
"interface/cmsis-dap.cfg",
"-f",
"target/${command:raspberry-pi-pico.getChip}-rescue.cfg",
"-c",
"adapter speed 5000; reset halt; exit"
],
"problemMatcher": [],
"windows": {
"command": "${env:USERPROFILE}/.pico-sdk/openocd/0.12.0+dev/openocd.exe",
}
},
{
"label": "RISC-V Reset (RP2350)",
"type": "process",
"command": "${userHome}/.pico-sdk/openocd/0.12.0+dev/openocd.exe",
"args": [
"-s",
"${userHome}/.pico-sdk/openocd/0.12.0+dev/scripts",
"-c",
"set USE_CORE { rv0 rv1 cm0 cm1 }",
"-f",
"interface/cmsis-dap.cfg",
"-f",
"target/rp2350.cfg",
"-c",
"adapter speed 5000; init;",
"-c",
"write_memory 0x40120158 8 { 0x3 }; echo [format \"Info : ARCHSEL 0x%02x\" [read_memory 0x40120158 8 1]];",
"-c",
"reset halt; targets rp2350.rv0; echo [format \"Info : ARCHSEL_STATUS 0x%02x\" [read_memory 0x4012015C 8 1]]; exit"
],
"problemMatcher": [],
"windows": {
"command": "${env:USERPROFILE}/.pico-sdk/openocd/0.12.0+dev/openocd.exe",
}
}
]
}
+126
View File
@@ -0,0 +1,126 @@
/**
* @file 0x001a_operators.c
* @brief Operators: demonstrate C operators with DHT11 temperature sensor
* @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 arithmetic, increment, relational, logical, bitwise, and
* assignment operators in C. Also reads humidity and temperature from a
* DHT11 sensor on GPIO4.
*
* Wiring:
* GPIO4 -> DHT11 data pin (with 10k pull-up to 3V3)
* 3V3 -> DHT11 VCC
* GND -> DHT11 GND
*/
#include <stdio.h>
#include "pico/stdlib.h"
#include "dht11.h"
/**
* @brief Print pre-computed operator results
*
* @details Prints all six operator demonstration values over UART.
*
* @param arith arithmetic operator result
* @param inc increment operator result
* @param rel relational operator result
* @param logic logical operator result
* @param bitw bitwise operator result
* @param assign assignment operator result
* @retval None
*/
static void print_operator_results(int arith, int inc, bool rel,
bool logic, int bitw, int assign) {
printf("arithmetic_operator: %d\r\n", arith);
printf("increment_operator: %d\r\n", inc);
printf("relational_operator: %d\r\n", rel);
printf("logical_operator: %d\r\n", logic);
printf("bitwise_operator: %d\r\n", bitw);
printf("assignment_operator: %d\r\n", assign);
}
/**
* @brief Compute arithmetic and increment operator results
*
* @param arith pointer to store multiplication result
* @param incr pointer to store post-increment result
* @param x left operand
* @param y right operand
* @retval None
*/
static void compute_arithmetic_ops(int *arith, int *incr, int x, int y) {
*arith = (x * y);
*incr = x++;
}
/**
* @brief Compute all operator values and print results
*
* @details Performs arithmetic, relational, logical, bitwise,
* and assignment operations, then prints each result.
*
* @retval None
*/
static void compute_operators(void) {
int x = 5, y = 10;
int arith, incr;
compute_arithmetic_ops(&arith, &incr, x, y);
bool rel = (x > y);
bool logic = (x > y) && (y > x);
int bits = (x << 1);
int assign = (x += 5);
print_operator_results(arith, incr, rel, logic, bits, assign);
}
/**
* @brief Read and print DHT11 humidity and temperature
*
* @details Attempts a DHT11 read; on success prints humidity and
* temperature, on failure prints an error message.
*
* @retval None
*/
static void print_dht11_reading(void) {
float hum, temp;
if (dht11_read(&hum, &temp)) {
printf("Humidity: %.1f%%, Temperature: %.1f°C\r\n", hum, temp);
} else {
printf("DHT11 read failed\r\n");
}
}
int main(void) {
stdio_init_all();
dht11_init(4);
while (true) {
compute_operators();
print_dht11_reading();
sleep_ms(2000);
}
}
+57
View File
@@ -0,0 +1,57 @@
# Generated Cmake Pico project file
cmake_minimum_required(VERSION 3.13)
set(CMAKE_C_STANDARD 11)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
# Initialise pico_sdk from installed location
# (note this can come from environment, CMake cache etc)
# == DO NOT EDIT THE FOLLOWING LINES for the Raspberry Pi Pico VS Code Extension to work ==
if(WIN32)
set(USERHOME $ENV{USERPROFILE})
else()
set(USERHOME $ENV{HOME})
endif()
set(sdkVersion 2.2.0)
set(toolchainVersion 14_2_Rel1)
set(picotoolVersion 2.2.0-a4)
set(picoVscode ${USERHOME}/.pico-sdk/cmake/pico-vscode.cmake)
if (EXISTS ${picoVscode})
include(${picoVscode})
endif()
# ====================================================================================
set(PICO_BOARD pico2 CACHE STRING "Board type")
# Pull in Raspberry Pi Pico SDK (must be before project)
include(pico_sdk_import.cmake)
project(0x001a_operators C CXX ASM)
# Initialise the Raspberry Pi Pico SDK
pico_sdk_init()
# Add executable. Default name is the project name, version 0.1
add_executable(0x001a_operators 0x001a_operators.c dht11.c )
pico_set_program_name(0x001a_operators "0x001a_operators")
pico_set_program_version(0x001a_operators "0.1")
# Modify the below lines to enable/disable output over UART/USB
pico_enable_stdio_uart(0x001a_operators 1)
pico_enable_stdio_usb(0x001a_operators 0)
# Add the standard library to the build
target_link_libraries(0x001a_operators
pico_stdlib)
# Add the standard include files to the build
target_include_directories(0x001a_operators PRIVATE
${CMAKE_CURRENT_LIST_DIR}
)
pico_add_extra_outputs(0x001a_operators)
+140
View File
@@ -0,0 +1,140 @@
/**
* @file dht11.c
* @brief Implementation of DHT11 temperature and humidity sensor driver
* @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 "dht11.h"
#include "hardware/gpio.h"
#include "pico/time.h"
/** @brief GPIO pin connected to the DHT11 sensor */
static uint dht_pin;
/**
* @brief Send the DHT11 start signal on the data pin
*
* Drives the pin LOW for 18 ms then HIGH for 40 us before switching
* the pin to input mode to listen for the sensor response.
*/
static void send_start_signal(void) {
gpio_set_dir(dht_pin, GPIO_OUT);
gpio_put(dht_pin, 0);
sleep_ms(18);
gpio_put(dht_pin, 1);
sleep_us(40);
gpio_set_dir(dht_pin, GPIO_IN);
}
/**
* @brief Wait for the pin to leave a given logic level
*
* Spins until the pin no longer reads the specified level, returning
* false if a timeout of 10 000 iterations is exceeded.
*
* @param level Logic level to wait through (0 or 1)
* @return bool true once the level changed, false on timeout
*/
static bool wait_for_level(int level) {
uint32_t timeout = 10000;
while (gpio_get(dht_pin) == level)
if (--timeout == 0) return false;
return true;
}
/**
* @brief Wait for the DHT11 response after the start signal
*
* The sensor pulls LOW then HIGH then LOW again; each transition
* is awaited with a timeout.
*
* @return bool true if the full response was received, false on timeout
*/
static bool wait_response(void) {
if (!wait_for_level(1)) return false;
if (!wait_for_level(0)) return false;
if (!wait_for_level(1)) return false;
return true;
}
/**
* @brief Read a single bit from the DHT11 data stream
*
* Waits for the low-period to end, measures the high-period duration,
* and shifts the result into the appropriate byte of the data array.
*
* @param data 5-byte array accumulating the received bits
* @param i Bit index (0-39)
* @return bool true on success, false on timeout
*/
static bool read_bit(uint8_t *data, int i) {
if (!wait_for_level(0)) return false;
uint32_t start = time_us_32();
if (!wait_for_level(1)) return false;
uint32_t duration = time_us_32() - start;
data[i / 8] <<= 1;
if (duration > 40) data[i / 8] |= 1;
return true;
}
/**
* @brief Read all 40 data bits from the DHT11
*
* @param data 5-byte array filled with the received data
* @return bool true if all 40 bits were read, false on timeout
*/
static bool read_40_bits(uint8_t *data) {
for (int i = 0; i < 40; i++)
if (!read_bit(data, i)) return false;
return true;
}
/**
* @brief Verify the DHT11 checksum byte
*
* @param data 5-byte received data (bytes 0-3 plus checksum in byte 4)
* @return bool true if the checksum matches, false otherwise
*/
static bool validate_checksum(const uint8_t *data) {
return data[4] == ((data[0] + data[1] + data[2] + data[3]) & 0xFF);
}
void dht11_init(uint8_t pin) {
dht_pin = pin;
gpio_init(pin);
gpio_pull_up(pin);
}
bool dht11_read(float *humidity, float *temperature) {
uint8_t data[5] = {0};
send_start_signal();
if (!wait_response()) return false;
if (!read_40_bits(data)) return false;
if (!validate_checksum(data)) return false;
*humidity = data[0] + data[1] * 0.1f;
*temperature = data[2] + data[3] * 0.1f;
return true;
}
+57
View File
@@ -0,0 +1,57 @@
/**
* @file dht11.h
* @brief Header for DHT11 temperature and humidity sensor driver
* @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.
*/
#ifndef DHT11_H
#define DHT11_H
#include <stdint.h>
#include <stdbool.h>
/**
* @brief Initialize the DHT11 driver
*
* Configures the GPIO pin for the DHT11 sensor. This must be called before
* using dht11_read().
*
* @param pin GPIO pin number connected to DHT11 signal
*/
void dht11_init(uint8_t pin);
/**
* @brief Read temperature and humidity from DHT11 sensor
*
* Performs the DHT11 communication protocol to read sensor data.
*
* @param humidity Pointer to store humidity value (0-100%)
* @param temperature Pointer to store temperature value in Celsius
* @return true if read successful, false on error or timeout
*/
bool dht11_read(float *humidity, float *temperature);
#endif // DHT11_H
+219
View File
@@ -0,0 +1,219 @@
#!/usr/bin/env python3
"""
FILE: hack-temp.py
DESCRIPTION:
Incremental firmware patcher with minimal, conservative steps to bias readings.
BRIEF:
Provides three modes:
- pool_only: change only the literal pool constant (scaling effect; least invasive)
- temp_only_vadd: convert temperature path to vadd.f32 and set a small negative pool
- both_vadd: convert both paths to vadd.f32 and set a small negative pool
Intended to let you test changes incrementally, keeping humidity stable while
you evaluate temperature bias first.
AUTHOR: Kevin Thomas
CREATION DATE: November 1, 2025
UPDATE DATE: November 1, 2025
"""
import sys
import os
import struct
BIN_PATH = "build/0x001a_operators.bin"
# Offsets
OFF_410 = 0x410
OFF_414 = 0x414
OFF_POOL = 0x42C
# Original encodings (for visibility only)
ORIG_410 = bytes.fromhex("a6ee257a") # vfma.f32 s14, s12, s11
ORIG_414 = bytes.fromhex("e6eea57a") # vfma.f32 s15, s13, s11
ORIG_POOL = bytes.fromhex("cccccc3d") # 0.1f
# Encodings for vadd.f32 s14, s14, s11 and vadd.f32 s15, s15, s11
VADD_S14_S11 = struct.pack("<I", 0xEEB47A06) # 06 7a b4 ee
VADD_S15_S11 = struct.pack("<I", 0xEEB47A86) # 86 7a b4 ee
def read_at(path, offset, n):
"""Read bytes from a binary file at a given offset.
Parameters
----------
path : str
Filesystem path to the binary file.
offset : int
Byte offset from the start of the file.
n : int
Number of bytes to read.
Returns
-------
bytes
The raw bytes read from the file.
Raises
------
IOError
If the file cannot be opened or read.
"""
with open(path, "rb") as f:
f.seek(offset)
return f.read(n)
def write_at(path, offset, data):
"""Write bytes into a binary file at a given offset.
Parameters
----------
path : str
Filesystem path to the binary file.
offset : int
Byte offset from the start of the file.
data : bytes
Bytes to write into the file.
Raises
------
IOError
If the file cannot be opened or written.
"""
with open(path, "rb+") as f:
f.seek(offset)
f.write(data)
def fmt_float(b):
"""Format a 4-byte sequence as hex and float if possible.
Parameters
----------
b : bytes
A 4-byte sequence.
Returns
-------
str
Hexadecimal string with float interpretation if valid.
"""
hx = b.hex()
try:
val = struct.unpack("<f", b)[0]
return f"{hx} (float {val:.6f})"
except Exception:
return hx
def patch_pool_only(new_pool_float=-1.0):
"""Patch only the pool constant to a new float value.
Parameters
----------
new_pool_float : float, optional
New float value to write into the pool constant (default -1.0).
Returns
-------
None
"""
print("[mode] pool_only")
curp = read_at(BIN_PATH, OFF_POOL, 4)
print(f"Current @0x1000042C: {fmt_float(curp)} (expected {ORIG_POOL.hex()} == 0.1f)")
newb = struct.pack("<f", new_pool_float)
write_at(BIN_PATH, OFF_POOL, newb)
chkp = read_at(BIN_PATH, OFF_POOL, 4)
print(f"Patched @0x1000042C: {fmt_float(chkp)} (target {newb.hex()} == {new_pool_float}f)")
def patch_temp_only_vadd(new_pool_float=-2.0):
"""Patch temperature path to vadd and set pool to a small negative.
Parameters
----------
new_pool_float : float, optional
New float value to write into the pool constant (default -2.0).
Returns
-------
None
"""
print("[mode] temp_only_vadd")
cur414 = read_at(BIN_PATH, OFF_414, 4)
curp = read_at(BIN_PATH, OFF_POOL, 4)
print(f"Current @0x10000414: {cur414.hex()} (expected {ORIG_414.hex()})")
print(f"Current @0x1000042C: {fmt_float(curp)}")
write_at(BIN_PATH, OFF_414, VADD_S15_S11)
write_at(BIN_PATH, OFF_POOL, struct.pack("<f", new_pool_float))
chk414 = read_at(BIN_PATH, OFF_414, 4)
chkp = read_at(BIN_PATH, OFF_POOL, 4)
print(f"Patched @0x10000414: {chk414.hex()} (should be {VADD_S15_S11.hex()})")
print(f"Patched @0x1000042C: {fmt_float(chkp)} (target {new_pool_float}f)")
def patch_both_vadd(new_pool_float=-2.0):
"""Patch both humidity and temperature paths to vadd and set pool.
Parameters
----------
new_pool_float : float, optional
New float value to write into the pool constant (default -2.0).
Returns
-------
None
"""
print("[mode] both_vadd")
cur410 = read_at(BIN_PATH, OFF_410, 4)
cur414 = read_at(BIN_PATH, OFF_414, 4)
curp = read_at(BIN_PATH, OFF_POOL, 4)
print(f"Current @0x10000410: {cur410.hex()} (expected {ORIG_410.hex()})")
print(f"Current @0x10000414: {cur414.hex()} (expected {ORIG_414.hex()})")
print(f"Current @0x1000042C: {fmt_float(curp)}")
write_at(BIN_PATH, OFF_410, VADD_S14_S11)
write_at(BIN_PATH, OFF_414, VADD_S15_S11)
write_at(BIN_PATH, OFF_POOL, struct.pack("<f", new_pool_float))
chk410 = read_at(BIN_PATH, OFF_410, 4)
chk414 = read_at(BIN_PATH, OFF_414, 4)
chkp = read_at(BIN_PATH, OFF_POOL, 4)
print(f"Patched @0x10000410: {chk410.hex()} (should be {VADD_S14_S11.hex()})")
print(f"Patched @0x10000414: {chk414.hex()} (should be {VADD_S15_S11.hex()})")
print(f"Patched @0x1000042C: {fmt_float(chkp)} (target {new_pool_float}f)")
def main():
"""Dispatch patch mode and perform incremental modifications.
Returns
-------
None
Raises
------
FileNotFoundError
If the binary file specified by BIN_PATH does not exist.
"""
if not os.path.exists(BIN_PATH):
raise FileNotFoundError(f"Binary not found: {BIN_PATH}")
mode = (sys.argv[1] if len(sys.argv) > 1 else "pool_only").strip().lower()
if mode == "pool_only":
patch_pool_only(new_pool_float=-1.0)
elif mode == "temp_only_vadd":
patch_temp_only_vadd(new_pool_float=-2.0)
elif mode == "both_vadd":
patch_both_vadd(new_pool_float=-2.0)
else:
print(f"Unknown mode: {mode}")
print("Use: pool_only | temp_only_vadd | both_vadd")
sys.exit(2)
if __name__ == "__main__":
main()
print("Patch complete. Convert to UF2 and flash. Test each mode incrementally.")
+121
View File
@@ -0,0 +1,121 @@
# This is a copy of <PICO_SDK_PATH>/external/pico_sdk_import.cmake
# This can be dropped into an external project to help locate this SDK
# It should be include()ed prior to project()
# Copyright 2020 (c) 2020 Raspberry Pi (Trading) Ltd.
#
# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
# following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
# disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
# disclaimer in the documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
# INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
if (DEFINED ENV{PICO_SDK_PATH} AND (NOT PICO_SDK_PATH))
set(PICO_SDK_PATH $ENV{PICO_SDK_PATH})
message("Using PICO_SDK_PATH from environment ('${PICO_SDK_PATH}')")
endif ()
if (DEFINED ENV{PICO_SDK_FETCH_FROM_GIT} AND (NOT PICO_SDK_FETCH_FROM_GIT))
set(PICO_SDK_FETCH_FROM_GIT $ENV{PICO_SDK_FETCH_FROM_GIT})
message("Using PICO_SDK_FETCH_FROM_GIT from environment ('${PICO_SDK_FETCH_FROM_GIT}')")
endif ()
if (DEFINED ENV{PICO_SDK_FETCH_FROM_GIT_PATH} AND (NOT PICO_SDK_FETCH_FROM_GIT_PATH))
set(PICO_SDK_FETCH_FROM_GIT_PATH $ENV{PICO_SDK_FETCH_FROM_GIT_PATH})
message("Using PICO_SDK_FETCH_FROM_GIT_PATH from environment ('${PICO_SDK_FETCH_FROM_GIT_PATH}')")
endif ()
if (DEFINED ENV{PICO_SDK_FETCH_FROM_GIT_TAG} AND (NOT PICO_SDK_FETCH_FROM_GIT_TAG))
set(PICO_SDK_FETCH_FROM_GIT_TAG $ENV{PICO_SDK_FETCH_FROM_GIT_TAG})
message("Using PICO_SDK_FETCH_FROM_GIT_TAG from environment ('${PICO_SDK_FETCH_FROM_GIT_TAG}')")
endif ()
if (PICO_SDK_FETCH_FROM_GIT AND NOT PICO_SDK_FETCH_FROM_GIT_TAG)
set(PICO_SDK_FETCH_FROM_GIT_TAG "master")
message("Using master as default value for PICO_SDK_FETCH_FROM_GIT_TAG")
endif()
set(PICO_SDK_PATH "${PICO_SDK_PATH}" CACHE PATH "Path to the Raspberry Pi Pico SDK")
set(PICO_SDK_FETCH_FROM_GIT "${PICO_SDK_FETCH_FROM_GIT}" CACHE BOOL "Set to ON to fetch copy of SDK from git if not otherwise locatable")
set(PICO_SDK_FETCH_FROM_GIT_PATH "${PICO_SDK_FETCH_FROM_GIT_PATH}" CACHE FILEPATH "location to download SDK")
set(PICO_SDK_FETCH_FROM_GIT_TAG "${PICO_SDK_FETCH_FROM_GIT_TAG}" CACHE FILEPATH "release tag for SDK")
if (NOT PICO_SDK_PATH)
if (PICO_SDK_FETCH_FROM_GIT)
include(FetchContent)
set(FETCHCONTENT_BASE_DIR_SAVE ${FETCHCONTENT_BASE_DIR})
if (PICO_SDK_FETCH_FROM_GIT_PATH)
get_filename_component(FETCHCONTENT_BASE_DIR "${PICO_SDK_FETCH_FROM_GIT_PATH}" REALPATH BASE_DIR "${CMAKE_SOURCE_DIR}")
endif ()
FetchContent_Declare(
pico_sdk
GIT_REPOSITORY https://github.com/raspberrypi/pico-sdk
GIT_TAG ${PICO_SDK_FETCH_FROM_GIT_TAG}
)
if (NOT pico_sdk)
message("Downloading Raspberry Pi Pico SDK")
# GIT_SUBMODULES_RECURSE was added in 3.17
if (${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.17.0")
FetchContent_Populate(
pico_sdk
QUIET
GIT_REPOSITORY https://github.com/raspberrypi/pico-sdk
GIT_TAG ${PICO_SDK_FETCH_FROM_GIT_TAG}
GIT_SUBMODULES_RECURSE FALSE
SOURCE_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-src
BINARY_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-build
SUBBUILD_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-subbuild
)
else ()
FetchContent_Populate(
pico_sdk
QUIET
GIT_REPOSITORY https://github.com/raspberrypi/pico-sdk
GIT_TAG ${PICO_SDK_FETCH_FROM_GIT_TAG}
SOURCE_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-src
BINARY_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-build
SUBBUILD_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-subbuild
)
endif ()
set(PICO_SDK_PATH ${pico_sdk_SOURCE_DIR})
endif ()
set(FETCHCONTENT_BASE_DIR ${FETCHCONTENT_BASE_DIR_SAVE})
else ()
message(FATAL_ERROR
"SDK location was not specified. Please set PICO_SDK_PATH or set PICO_SDK_FETCH_FROM_GIT to on to fetch from git."
)
endif ()
endif ()
get_filename_component(PICO_SDK_PATH "${PICO_SDK_PATH}" REALPATH BASE_DIR "${CMAKE_BINARY_DIR}")
if (NOT EXISTS ${PICO_SDK_PATH})
message(FATAL_ERROR "Directory '${PICO_SDK_PATH}' not found")
endif ()
set(PICO_SDK_INIT_CMAKE_FILE ${PICO_SDK_PATH}/pico_sdk_init.cmake)
if (NOT EXISTS ${PICO_SDK_INIT_CMAKE_FILE})
message(FATAL_ERROR "Directory '${PICO_SDK_PATH}' does not appear to contain the Raspberry Pi Pico SDK")
endif ()
set(PICO_SDK_PATH ${PICO_SDK_PATH} CACHE PATH "Path to the Raspberry Pi Pico SDK" FORCE)
include(${PICO_SDK_INIT_CMAKE_FILE})