M-Labs/kirdy
3
0
Fork 1
Code Issues 11 Pull Requests Projects Releases Wiki Activity
Firmware for the Sinara 1550 Kirdy laser diode driver
117 Commits 1 Branch 0 Tags 1 MiB
Rust 53.2%
Python 45.9%
Nix 0.9%
86a9fb039e
Go to file
linuswck 86a9fb039e boot: Correct PCLK1, PCLK2 freq value 
- PCLK is divided from HCLK in power of two
- abs max pclk1 = 42MHz
- abs max pclk2 = 84MHz
2024-02-28 12:23:09 +08:00
.cargo rm unused cargo config target definition 2024-01-26 16:56:55 +08:00
src boot: Correct PCLK1, PCLK2 freq value 2024-02-28 12:23:09 +08:00
.gitignore current source working 2022-10-22 01:58:18 +08:00
BSD.md add BSD build instructions 2024-02-12 18:33:06 +08:00
build.rs project init 2022-10-20 15:17:43 +08:00
Cargo.lock hw_rev: Generate random mac address on rev0_3 2024-02-16 17:23:39 +08:00
Cargo.toml hw_rev: Generate random mac address on rev0_3 2024-02-16 17:23:39 +08:00
eth_cmd_test.py dfu: Add eth cmd, fns to put stm32 into dfu mode 2024-02-16 17:23:47 +08:00
flake.lock Update stm32-eth cargo crate to 0.15.2 2023-12-15 16:40:55 +08:00
flake.nix Update stm32-eth cargo crate to 0.15.2 2023-12-15 16:40:55 +08:00
LICENSE project init 2022-10-20 15:17:43 +08:00
memory.x memory.x: Add comment on the reserved flash sector 2024-01-16 15:27:43 +08:00
openocd.gdb project init 2022-10-20 15:17:43 +08:00
pid_autotune.py pid_autotune: Add pid autotune script 2024-02-15 12:14:14 +08:00
README.md dfu: Add eth cmd, fns to put stm32 into dfu mode 2024-02-16 17:23:47 +08:00

README.md

Testing Firmware for the Sinara 1550 Kirdy

  • This repo is for testing only. Not intended for production use.

Building

Reproducible build with Nix

kirdy firmware is packaged using the Nix Flakes system. Install Nix 2.4+ and enable flakes by adding experimental-features = nix-command flakes to nix.conf (e.g. ~/.config/nix/nix.conf).

Once you have Flakes enabled, you can use nix build to build the firmware.

Development environment

Clone this repository and with Nix Flakes enabled, use the following commands:

nix develop
cargo build

The resulting ELF file will be located under target/thumbv7em-none-eabihf/release/kirdy.

Alternatively, you can install the Rust toolchain without Nix using rustup; see the Rust manifest file pulled in flake.nix to determine which Rust version to use.

For building on FreeBSD or OpenBSD, see BSD.md.

Debugging

Connect SWDIO/SWCLK/RST/GND to a programmer such as ST-Link v2.1. Run OpenOCD:

openocd -f interface/stlink.cfg -f target/stm32f4x.cfg

You may need to power up the programmer before powering the device. Leave OpenOCD running. Run the GNU debugger:

gdb target/thumbv7em-none-eabihf/release/kirdy

(gdb) source openocd.gdb

Flashing

There are several options for flashing kirdy. DFU requires only a USB-C cable or RJ45 cable, whereas OpenOCD needs a JTAG/SWD adapter.

dfu-util on Linux

  • Install the DFU USB tool (dfu-util).
  • Convert firmware from ELF to BIN: arm-none-eabi-objcopy -O binary kirdy kirdy.bin (you can skip this step if using the BIN from Hydra)
  • Put STM32 into DFU Mode. You can either
    • Connect to the USB Type C cable to kirdy next to the RJ45 Jack. After that, add BOOT0 jumper to kirdy near programming headers and then cycle board power to put it in DFU mode. OR
    • Plug in RJ45 cable, which connect to a network that is accessible by your computer and send the corresponding dfu json command via TCP Socket to kirdy. Please see the python test script for the command.
  • Push firmware to flash: dfu-util -a 0 -s 0x08000000:leave -D kirdy.bin
  • If you plugged in the BOOT0 jumper, you will need to
    1. Remove BOOT0 jumper
    2. Cycle power to leave DFU update mode
  • If you plugged in the RJ45 cable, the MCU would start its application code automatically. No power cycle is needed.

st.com DfuSe tool on Windows

On a Windows machine install st.com DfuSe USB device firmware upgrade (DFU) software. link.

  • add jumper to kirdy across 2-pin jumper adjacent to JTAG connector
  • cycle board power to put it in DFU update mode
  • connect USB Type C to PC
  • use st.com software to upload firmware
  • remove jumper
  • cycle power to leave DFU update mode

OpenOCD

openocd -f interface/stlink.cfg -f target/stm32f4x.cfg -c "program target/thumbv7em-none-eabihf/debug/kirdy verify reset; exit"