sl-firmware
fa75c442a7
Archive STM32 firmware to legacy/stm32/: - src/, include/, lib/USB_CDC/, platformio.ini, test stubs, flash_firmware.py - test/test_battery_adc.c, test_hw_button.c, test_pid_schedule.c, test_vesc_can.c, test_can_watchdog.c - USB_CDC_BUG.md Rename: stm32_protocol → esp32_protocol, mamba_protocol → balance_protocol, stm32_cmd_node → esp32_cmd_node, stm32_cmd_params → esp32_cmd_params, stm32_cmd.launch.py → esp32_cmd.launch.py, test_stm32_protocol → test_esp32_protocol, test_stm32_cmd_node → test_esp32_cmd_node Content cleanup across all files: - Mamba F722S → ESP32-S3 BALANCE - BlackPill → ESP32-S3 IO - STM32F722/F7xx → ESP32-S3 - stm32Mode/Version/Port → esp32Mode/Version/Port - STM32 State/Mode labels → ESP32 State/Mode - Jetson Nano → Jetson Orin Nano Super - /dev/stm32 → /dev/esp32 - stm32_bridge → esp32_bridge - STM32 HAL → ESP-IDF docs/SALTYLAB.md: - Update "Drone FC Details" to describe ESP32-S3 BALANCE board (Waveshare ESP32-S3 Touch LCD 1.28) - Replace verbose "Self-Balancing Control" STM32 section with brief note pointing to SAUL-TEE-SYSTEM-REFERENCE.md TEAM.md: Update Embedded Firmware Engineer role to ESP32-S3 / ESP-IDF No new functionality — cleanup only. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
96 lines
3.6 KiB
C
96 lines
3.6 KiB
C
#ifndef PID_FLASH_H
|
||
#define PID_FLASH_H
|
||
|
||
#include <stdint.h>
|
||
#include <stdbool.h>
|
||
|
||
/*
|
||
* pid_flash — persistent PID storage for Issue #531 (auto-tune).
|
||
*
|
||
* Stores Kp, Ki, Kd in the last 64 bytes of STM32F722 flash sector 7
|
||
* (0x0807FFC0). Magic word validates presence of saved params.
|
||
* Sector 7 is 128KB starting at 0x08060000; firmware never exceeds sector 6.
|
||
*
|
||
* Flash writes require an erase of the full sector (128KB) before re-writing.
|
||
* The store address is the very last 64-byte block so future expansion can
|
||
* grow toward lower addresses within sector 7 without conflict.
|
||
*/
|
||
|
||
#define PID_FLASH_SECTOR FLASH_SECTOR_7
|
||
#define PID_FLASH_SECTOR_VOLTAGE VOLTAGE_RANGE_3 /* 2.7V-3.6V, 32-bit parallelism */
|
||
|
||
/* Sector 7: 128KB at 0x08060000; store in last 64 bytes */
|
||
#define PID_FLASH_STORE_ADDR 0x0807FFC0UL
|
||
#define PID_FLASH_MAGIC 0x534C5401UL /* 'SLT\x01' — version 1 */
|
||
|
||
typedef struct __attribute__((packed)) {
|
||
uint32_t magic; /* PID_FLASH_MAGIC when valid */
|
||
float kp;
|
||
float ki;
|
||
float kd;
|
||
uint8_t _pad[48]; /* padding to 64 bytes */
|
||
} pid_flash_t;
|
||
|
||
/* ---- Gain schedule flash storage (Issue #550) ---- */
|
||
|
||
/* Maximum number of speed-band entries in the gain schedule table */
|
||
#define PID_SCHED_MAX_BANDS 6u
|
||
|
||
/*
|
||
* Sector 7 layout (128KB at 0x08060000):
|
||
* 0x0807FF40 pid_sched_flash_t (128 bytes) — gain schedule record
|
||
* 0x0807FFC0 pid_flash_t ( 64 bytes) — single PID record (existing)
|
||
* Both records are written in a single sector erase via pid_flash_save_all().
|
||
*/
|
||
#define PID_SCHED_FLASH_ADDR 0x0807FF40UL
|
||
#define PID_SCHED_MAGIC 0x534C5402UL /* 'SLT\x02' — version 2 */
|
||
|
||
typedef struct __attribute__((packed)) {
|
||
float speed_mps; /* velocity breakpoint (m/s) */
|
||
float kp;
|
||
float ki;
|
||
float kd;
|
||
} pid_sched_entry_t; /* 16 bytes */
|
||
|
||
typedef struct __attribute__((packed)) {
|
||
uint32_t magic; /* PID_SCHED_MAGIC when valid */
|
||
uint8_t num_bands; /* valid entries (1..PID_SCHED_MAX_BANDS) */
|
||
uint8_t flags; /* reserved, must be 0 */
|
||
uint8_t _pad0[2];
|
||
pid_sched_entry_t bands[PID_SCHED_MAX_BANDS]; /* 6 × 16 = 96 bytes */
|
||
uint8_t _pad1[24]; /* total = 4+1+1+2+96+24 = 128 bytes */
|
||
} pid_sched_flash_t; /* 128 bytes */
|
||
|
||
/*
|
||
* pid_flash_load() — read saved PID from flash.
|
||
* Returns true and fills *kp/*ki/*kd if magic is valid.
|
||
* Returns false if no valid params stored (caller keeps defaults).
|
||
*/
|
||
bool pid_flash_load(float *kp, float *ki, float *kd);
|
||
|
||
/*
|
||
* pid_flash_save() — erase sector 7 and write Kp/Ki/Kd (single-PID only).
|
||
* Use pid_flash_save_all() to save both single-PID and schedule atomically.
|
||
* Must not be called while armed (flash erase takes ~1s and stalls the CPU).
|
||
* Returns true on success.
|
||
*/
|
||
bool pid_flash_save(float kp, float ki, float kd);
|
||
|
||
/*
|
||
* pid_flash_load_schedule() — read gain schedule from flash.
|
||
* Returns true and fills out_entries[0..n-1] and *out_n if magic is valid.
|
||
* Returns false if no valid schedule stored.
|
||
*/
|
||
bool pid_flash_load_schedule(pid_sched_entry_t *out_entries, uint8_t *out_n);
|
||
|
||
/*
|
||
* pid_flash_save_all() — erase sector 7 once and atomically write both:
|
||
* - pid_sched_flash_t at PID_SCHED_FLASH_ADDR (0x0807FF40)
|
||
* - pid_flash_t at PID_FLASH_STORE_ADDR (0x0807FFC0)
|
||
* Must not be called while armed. Returns true on success.
|
||
*/
|
||
bool pid_flash_save_all(float kp_single, float ki_single, float kd_single,
|
||
const pid_sched_entry_t *entries, uint8_t num_bands);
|
||
|
||
#endif /* PID_FLASH_H */
|