Skip to main content

Programming Tool for WCH RISC-V Microcontrollers using WCH-Link

Description

With this open-source platform-independant command-line tool, WCH RISC-V microcontrollers can be programmed using a RISC-V compatible WCH-Link via their serial debug interface.

The tool currently supports the following microcontrollers:

  • CH32V002, CH32V003, CH32V004, CH32V005, CH32V006, CH32V007,
  • CH32V103, CH32V203, CH32V208, CH32V303, CH32V305, CH32V307,
  • CH32X033, CH32X035,
  • CH32L103,
  • CH571, CH573, CH581, CH582, CH583, CH591, CH592.

The tool currently supports the following programmers:

  • WCH-LinkB,
  • WCH-LinkE,
  • WCH-LinkW,
  • other compatible programmers.

Preparations

To use the WCH-Link on Linux, you need to grant access permissions beforehand by executing the following commands:

echo 'SUBSYSTEM=="usb", ATTR{idVendor}=="1a86", ATTR{idProduct}=="8010", MODE="666"' | sudo tee /etc/udev/rules.d/99-WCH-LinkE.rules
echo 'SUBSYSTEM=="usb", ATTR{idVendor}=="1a86", ATTR{idProduct}=="8012", MODE="666"' | sudo tee -a /etc/udev/rules.d/99-WCH-LinkE.rules
sudo udevadm control --reload-rules

On Windows, if you need to you can install the WinUSB driver over the WCH interface 1 using the Zadig tool.

Installation

Ensure that the prerequisites for installing Python packages are met. Then execute the following command in the command line:

pip install rvprog

Usage

To upload firmware, you should make the following connections to the WCH-Link (SWCLK is not present on CH32V00x and therefore does not need to be connected):

WCH-Link      RISC-V MCU
+------+      +--------+
| SWCLK| ---> |SWCLK   |
| SWDIO| <--> |SWDIO   |
|   GND| ---> |GND     |
|   3V3| ---> |VDD     |
+------+      +--------+

If the blue LED on the WCH-Link remains illuminated once it is connected to the USB port, it means that the device is currently in ARM mode and must be switched to RISC-V mode initially. There are a few ways to accomplish this:

  • You can utilize the rvprog tool with the -v option (see below).
  • Alternatively, you can select "WCH-LinkRV" in the software provided by WCH, such as MounRiver Studio or WCH-LinkUtility.
  • Another option is to hold down the ModeS button on the device while plugging it into the USB port.

More information can be found in the WCH-Link User Manual.

Usage: rvprog [-h] [-a] [-v] [-b] [-u] [-l] [-e] [-G] [-R] [-f FLASH]

Optional arguments:
  -h, --help                show help message and exit
  -a, --armmode             switch WCH-Link to ARM mode
  -v, --rvmode              switch WCH-Link to RISC-V mode
  -b, --unbrick             unbrick chip (power cycle erase)
  -u, --unlock              unlock chip (remove read protection)
  -l, --lock                lock chip (set read protection)
  -e, --erase               perform a whole chip erase
  -G, --pingpio             make PD7 a GPIO pin (CH32V00x only)
  -R, --pinreset            make PD7 a reset pin (CH32V00x only)
  -f FLASH, --flash FLASH   write BIN file to flash

Example:
rvprog -f firmware.bin

Links

Metadata

Release files for rvprog 1.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rvprog 1.10.0
File Size Uploaded
rvprog-1.10.0.tar.gz 16.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for rvprog 1.10.0
File Interpreter ABI Platform
rvprog-1.10.0-py3-none-any.whl Python 3 none any Details

Total release size: 30.8 kB

Release files / rvprog-1.10.0.tar.gz

Download URL rvprog-1.10.0.tar.gz
Size 16.3 kB
Tags Source
SHA-256 checksum
How to use checksums
936348bcc34d6d8d680d2eafae22d963c379854bcd5e83c17041cff33fa482cc
BLAKE2b-256 checksum
How to use checksums
0fc89ed6a359451b8df0d21cbfba68244d387ddf60f38f70f2cf594c41b0f8dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.12

Release files / rvprog-1.10.0-py3-none-any.whl

Download URL rvprog-1.10.0-py3-none-any.whl
Size 14.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
561d356bfdf50f9c84c73c3e5ca8646c746d0dbf5e90382a0b2990ead072b44b
BLAKE2b-256 checksum
How to use checksums
f21fb165671c8cd56322ef8f2014c5fade9820f60836fe7c42df10b57faba3fe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.10.12

Release history Release notifications | RSS feed

This release

1.10.0 This release

2 release files

1.9.0

2 release files

1.8.0

2 release files

1.7.1

2 release files

1.7.0

2 release files

1.6.0

2 release files

1.5.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page