DEPRECATED

I have moved from this. I no longer use it. Instead I use GDB directly from the terminal I will no longer maintain it

STM32 neovim integration

WHY

I used the STM32CubeIDE for a while but I hated it. First I tried to use OpenOCD but that was a complete failure (probably a skill issue). So I checked how it programmed and debug the boards and decided to integrate it with neovim

WIP

This is very very new. I use it for my personal projects. If you find any issue, or have some idea about how to improve it, feel free to open an issue or clone the repo and open a pull request

External Dependencies

cpptools (which can also be installed via mason)

you need to configure nvim-dap to use cpptools

STM32CubeProgrammerCLI
ST-LINK_gdbserver (I think it comes bundled with STM32CubeProgrammerCLI, it definetly comes with STM32CubeIDE)

Installation

Once you have the dependencies installed

only tested with neovim 0.9.2, use at your own peril
With Lazy

{
    'fmaggi/stm32.nvim',
    dependencies = {
        'nvim-lua/plenary.nvim',
        'mfussenegger/nvim-dap'
    },
    opts = {}
}

Usage

Debugging

you can flash, start the server and start gdb all together

:lua require("stm32.debugger").debug(config)

config is optional to override current setup

or just the server

:lua require("stm32.debugger").start_server(on_ready, on_success, config)

on_ready callback when server is waiting for debugger connection (optional)

on_success callback when server exits correctly (optional)

config override current setup (optional)

Flashing

:lua require('stm32.programmer').flash(on_success, config)

on_success callback when programmer exits correctly (optional)

config override current setup (optional)

Configuration

if using lazy as your package manager you can pass your configs to opts otherwise you can call

require('stm32').setup({
    ...
})

(ST-LINK_gdbserver documentation)

it comes with the following default config

local default_config = {
    -- configurations for ST-LINK_gdbserver
    stlink_gdb_server = {
        -- Server Path
        -- I've put the tools I need in my .local dir
        server = vim.fn.expand('~') .. '/.local/stm32/STLINKgdbServer/ST-LINK_gdbserver',
        halt = false,
        config_file = nil, -- custom config file, instead of using flags
        log_level = 1,
        log_file = nil,
        port = 61234, -- port for gdb client
        verbose = false,
        refresh_delay = nil,
        verify = true,

        -- whether server should exit when gdb server exits
        -- this is useful if you want to start the server once
        -- and then debug multiple times with your normal dap mappings
        persistant = true,

        -- options: 
        --     false (use JTAG instead)
        --     table: 
        --          port (port where server dumps info)
        --          cpu_clock
        --          swo_clock_divider
        --
        swd = {
            port = 61235,
            cpu_clock = nil,
            swo_clock_divider = nil
        },
        init_under_reset = true,
        st_serial_number = nil,
        max_frequency = nil,
        core = 0,
        attach_to_running_target = false,
        shared = false,
        erase_all_memories = false,
        memory_map = nil,
        external_memory_loader = nil,
        external_init = false, -- requires external_memory_loader

        -- ST-LINK_gdbserver needs STM32CubeProgrammerCLI
        -- by default it looks for it in ../STM32CubeProgrammer/bin
        -- or you can tell it where to look
        cube_programmer_path = nil,
        max_time_to_halt = nil,
        temp_path = nil,
        preserve_temps = false,
    },
    -- options:
    --      false (do not configure dap)
    --      table:
    --          name (dap name)
    --          gdb_path (path to gdb)
    --          server_url (in case connecting remotely)
    --          program (program to debug. get_exe is a function that asks for a path first time, but then it remembers)
    --          stopAtEntry (whether to stop debugger at entry)
    --          languages (languages to configure dap for)
    -- It handles all the configuration in order to connect server and client
    dap = {
        name = 'Debug STM32',
        gdb_path = 'arm-none-eabi-gdb',
        server_url = 'localhost', -- it uses the stlink_gdb_server port
        program = get_exe,
        stopAtEntry = false,
        languages = { 'c', 'cpp', 'rust', 'zig' }
    },
    stm32_programmer = {
        programmer = vim.fn.expand('~') .. '/.local/stm32/STM32CubeProgrammer/bin/STM32_Programmer_CLI',

        -- for now only SWD is supported
        connect = { 
            port = 'SWD',
            mode = 'UR',
            reset = 'HWrst'
        },
        write = {
            file = M.get_exe,
            address = nil,
            reset = true,
            verify = true,
        },
    }
}

TODO

Handle just flashing to the board
Support more ports when flashing
Better logging
Maybe include STM32CubeMX to generate config code