Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pavelrevak/pystlink
Python tool for flashing and debugging STM32 devices using ST-LINK/V2
https://github.com/pavelrevak/pystlink
debugger flash linux macos python python3 stlink stm32 swd windows
Last synced: about 17 hours ago
JSON representation
Python tool for flashing and debugging STM32 devices using ST-LINK/V2
- Host: GitHub
- URL: https://github.com/pavelrevak/pystlink
- Owner: pavelrevak
- License: mit
- Created: 2015-07-25T21:30:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-10-10T06:40:30.000Z (about 2 years ago)
- Last Synced: 2023-11-07T18:26:59.502Z (about 1 year ago)
- Topics: debugger, flash, linux, macos, python, python3, stlink, stm32, swd, windows
- Language: Python
- Homepage:
- Size: 212 KB
- Stars: 203
- Watchers: 18
- Forks: 57
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PYSTLINK
Python tool for manipulating with STM32 MCUs using **ST-Link** in-system programmer and debugger.
## Goal
Goal of this project is to bring more flexible support for different MCUs, very simple command line interface, easier integration into Makefile for direct flashing or uploading program into SRAM and many more, simplest way to add support for new MCUs. Also any suggestions are welcome.
## Features
- running on **Linux**, **Mac OS/X** and **Windows**
- simple command line interface
- detect MCU
- dump registers and memory
- write registers
- download memory to binary file
- upload binary or SREC file into memory
- FLASH binary or SREC file to all **STM32**
- basic runtime control: reset, halt, step, run
- support **ST-Link/V2**, **ST-Link/V2-1** and **ST-Link/V3**
### Planed features
- FLASH support for other MCU types (STM32L)
- FLASH information block (system memory, option bytes and OTP area)
- connecting under RESET
- stop Watchdog in debug mode to prevent device restart
- allow to control breakpoints or watchpoints
- support for more ST-Link devices connected at once
- other file formats (SREC, HEX, ELF, ...)
- pip installer
- proxy to GDB
- and maybe GUI
- support for ST-Link/V1 is NOT planed, use ST-Link/V2 or V2-1 instead
## Install
### Requirements
- **Python v3.7+** (tested with 3.8)
- [**pyusb**](https://github.com/walac/pyusb)
- [**libusb**](https://github.com/libusb/libusb) or any other libusb driver
- for Windows download [latest windows binaries](https://github.com/libusb/libusb) and copy libusb-1.0.dll into Windows/System32 directory
### pystlink
- [Download](https://github.com/pavelrevak/pystlink/archive/master.zip) and unpack or `git clone https://github.com/pavelrevak/pystlink.git`
- Connect ST-LINK
- Run `./pystlink.py --help` (or `python3 pystlink.py ...` - depend on python installation and architecture)
## Help
```
usage: pystlink [-h] [-q | -i | -v | -d] [-V] [-c CPU] [-r] [-u]
[action [action ...]]
pystlink v0.0.0 (ST-LinkV2)
(c)2015 by [email protected]
https://github.com/pavelrevak/pystlink
optional arguments:
-h, --help show this help message and exit
-V, --version show program's version number and exit
-c CPU, --cpu CPU set expected CPU type [eg: STM32F051, STM32L4]
-r, --no-run do not run core when program end (if core was halted)
-u, --no-unmount do not unmount DISCOVERY from ST-Link/V2-1 on OS/X platform
set verbosity level:
-q, --quiet
-i, --info default
-v, --verbose
-d, --debug
actions:
action actions will be processed sequentially
list of available actions:
dump:core print all core registers (halt core)
dump:{reg} print core register (halt core)
dump:{addr}:{size} print content of memory
dump:sram[:{size}] print content of SRAM memory
dump:flash[:{size}] print content of FLASH memory
dump:{addr} print content of 32 bit memory register
dump16:{addr} print content of 16 bit memory register
dump8:{addr} print content of 8 bit memory register
set:{reg}:{data} set register (halt core)
set:{addr}:{data} set 32 bit memory register
read:{addr}:{size}:{file} read memory with size into file
read:sram[:{size}]:{file} read SRAM into file
read:flash[:{size}]:{file} read FLASH into file
fill:{addr}:{size}:{pattern} fill memory with a pattern
fill:sram[:{size}]:{pattern} fill SRAM memory with a pattern
write:{file.srec} write SREC file into memory
write:{addr}:{file} write binary file into memory
write:sram:{file} write binary file into SRAM memory
flash:erase complete erase FLASH memory aka mass erase
flash[:erase][:verify]:{file.srec} erase + flash SREC file + verify
flash[:erase][:verify][:{addr}]:{file} erase + flash binary file + verify
reset reset core
reset:halt reset and halt core
halt halt core
step step core
run run core
sleep:{seconds} sleep (float) - insert delay between commands
(numerical values can be in different formats, like: 42, 0x2a, 0o52, 0b101010)
examples:
pystlink.py --help
pystlink.py -v --cpu STM32F051R8
pystlink.py -q --cpu STM32F03 dump:flash dump:sram
pystlink.py dump:0x08000000:256
pystlink.py set:0x48000018:0x00000100 dump:0x48000014
pystlink.py read:sram:256:aaa.bin read:flash:bbb.bin
pystlink.py -r reset:halt set:pc:0x20000010 dump:pc core:step dump:all
pystlink.py flash:erase:verify:app.bin
pystlink.py flash:erase flash:verify:0x08010000:boot.bin
````
## Supported programmers
From ST exists actually three different SWD programmers:
Full support:
- **ST-Link/V2**
- **ST-Link/V2-1**
- **ST-Link/V3**
Not supported:
- ST-Link/V1
Minimum recommended firmware version of ST-Link is **V2J32xx** or newer. Otherwise is recommended upgrade using [ST-LINK firmware upgrade tool](https://www.st.com/en/development-tools/stsw-link007.html).
## Supported MCUs
Currently almost all **ST32** MCUs. There is script `list_new_stm32.py` which compare supported MCUs with all listed on st.com.
**Not all MCUs are tested**. Please report any problems to [Issues tracker](https://github.com/pavelrevak/pystlink/issues).
In WiKi is some basic info about STM32 naming: [STM32 coding matrix](https://github.com/pavelrevak/pystlink/wiki/STM32-coding-matrix)
## Legal
Code is under [MIT license](https://github.com/pavelrevak/pystlink/blob/master/LICENSE).
In general, this program is allowed to copy, share, change, use in commercial and without any limitations, but if you make some changes or updates then will be nice to share it.
Support is only by [Issues tracker](https://github.com/pavelrevak/pystlink/issues)
**PYSTLINK** is inspired by [OpenOCD](http://openocd.org/), [STLINK](https://github.com/texane/stlink) and lot of info is from sniffed USB communication with [original ST-LINK](http://www.st.com/web/en/catalog/tools/PF258168) program.
## TAGS
ST-Link/V2, ST-Link/V3, stlink, SWD, Python, ARM, CortexM, STM32, debug, FLASH, USB