ch32v003fun

An open source development environment (tooling, headers, examples) for the CH32V003 (and many other chips within the CH32V family) with gcc-riscv64 that can be used in Windows (Native), Linux and/or WSL. The CH32V003 is 10-cent part with a RISC-V EC core that runs at 48MHz, has 16kB of flash and 2kB of RAM and a bunch of peripherals. It also comes in SOP-8, QFN-20 and SOIC packages. You can get the datasheet here.

The goal of this project is to develop the tooling and environment for efficient use of the CH32V003. Avoid complicated HALs, and unleash the hardware! The existing EVT is massive, and dev environment weighty. This project specifically avoids the HAL and makes it so you can just use the TRM. In contrast, blinky is only 500 bytes with ch32v003fun, boots faster, and significantly simpler overall.

ch32v003fun contains:

Examples using ch32v003fun, but not as many as using the HAL.
"minichlink" which uses the WCH CH-Link with libusb, for cross-platform use.

An STM32F042 Programmer, the NHC-Link042
An ESP32S2 Programmer, the esp32s2-funprog
The official WCH Link-E Programmer.
An Arduino-based interface, Ardulink.
Supports gdbserver-style-debugging for use with Visual Studio.
Supports printf-over-single-wire. (At about 400kBaud)

An extra copy of libgcc so you can use unusual risc-v build chains, located in the misc/libgcc.a.
A folder named "ch32v003fun" containing a single self-contained source file and header file for compling apps for the ch32v003.
On some systems ability to "printf" back through
A demo bootloader.

Other family support

Currently, there is experimental support for the ch32v103, ch32v203, ch32v208, ch32v303 and ch32v307. Note: GDB will only workon the 003 at this time.

Getting Started

For installation / setup instructions, see the wiki page here

Features!

A fast "printf" debug over the programming interface.

And by fast I mean very fast. Typically around 36kBytes/sec.

./minichlink -T | pv > /dev/null
Found ESP32S2 Programmer
 536KiB 0:00:15 [36.7KiB/s] [        <=>                     ]

You can just try out the debugprintf project, or call SetupDebugPrintf(); and printf() away.

Debugging support!

Via gdbserver built into minichlink! It works with gdb-multiarch as well as in Visual Studio Code

Building and Flashing

cd examples/blink
make

text = code, data = constants and initialization values, bss = uninitialized values.
dec is the sum of the 3 and reflects the number of bytes in flash that will get taken up by the program.

The generated .bin is used by minichlink and the .hex file is compatible with the official WCH flash tool.

VSCode +/- PlatformIO

Note: With PlatformIO is genearlly used for CI on this repo. However, note that this is not the path that allows for debugging on Windows (For that see template project)

This project can also be built, uploaded and debugged with VSCode and the PlatformIO extension. Simply clone and open this project in VSCode and have the PlatformIO extension installed.

See here for further details.

clangd

If the C/C++ language server clangd is unable to find ch32v003fun.h, the example will have to be wiped make clean and built once with bear -- make build, which will generate a compile_commands.json, which clangd uses to find the include paths specified in the makefiles.
make clangd does this in one step. build_all_clangd.sh does in build scripts does this for all examples.

Quick Reference

REQUIRED for programming/debugging: SWIO is on PD1. Do not re-use PD1 for multiple functions.
OPTIONAL NRST is on PD7. Not needed, defaults as GPIO in some configurations.
OPTIONAL UART TX is on: PD5. We recommend using SWIO for printf debugging.

More examples / projects?

Other third party tools are adding lots of examples, etc. See the following repos, for extra libraries, etc.

Support

You can open a github ticket or join my Discord in the #ch32v003fun channel. Right now invites are private, so just ping me @cnlohr for an invite link. My PMs are open.

General notes about the CH32V003.

CPI/Processor Speed:

Ignoring branches and load/stores, compressed instructions run at 1 CPI. Non-compressed instructions run at 1 CPI for the first 2 instructions, then further ones take 2 CPI regardless of how many more you have. Running from RAM and running from FLASH have slightly different performance characteristics depending on wait states that should be measured in-situation.

Footnotes/links

https://raw.githubusercontent.com/openwch/ch32v003/main/RISC-V%20QingKeV2%20Microprocessor%20Debug%20Manual.pdf Debugging Manual
http://www.wch-ic.com/downloads/QingKeV2_Processor_Manual_PDF.html Processor Manual
http://www.wch-ic.com/downloads/CH32V003RM_PDF.html Technical Reference Manual
http://www.wch-ic.com/downloads/CH32V003DS0_PDF.html Datasheet
https://github.com/CaiB/CH32V003-Architecture-Exploration/blob/main/InstructionTypes.md Details for the compressed ISA on this chip.
The CH32V003 has xv extensions, you can use this customized version of rvcodec.js to work with its opcodes: https://xw.macyler.moe/

cnlohr / ch32v003fun