ch32-data

ch32-data is a project that aims to provide structured, machine-readable data for WCH's 32-bit microcontrollers.

This project is highly inspired by the stm32-data project. With the following modifications:

• WCH's documentation and tools are not as good as ST's, so the data is not as clean and complete as ST's.
• This project does't have much auto-generated data, most of the chip definitions are manually written.
• A "include" mechanism is used to reduce the amount of duplicated data, spliting device families into separate files.

All Issues/PRs are accepted at https://github.com/ch32-rs/ch32-data, not the nightly metapac repo.

Data sources

• Datasheets are provided by wch.cn and wch-ic.com
• SVD files are provided by MounRiver Studio
  • SVD files are post-processed by ch32-rs project, adding fixes and patches
• Misc info is retrieved from https://github.com/openwch

Families

• CH32V0, Low price (V2A/V2C)
• CH32V1, General purpose (V3A)
• CH32V203/CH32V303, General purpose (V4B)
• CH32V305/CH32V307/CH32V317, High speed interconnect (V4F)
• CH32V208, BLE 5.3 (V4C)
• CH32X0, PDUSB (V4C)
• CH32L1, Low power, PDUSB (V4C)
• CH643, RGB driver (V4C)
• CH641, USB PD, (V2A)

Families that not implemented yet(planing to implement using another crate, as they are using different peripherals and features):

• CH57x, BLE 4.2 (V3A)
• CH58x, BLE 5.3 (V4A)
• CH59x, BLE 5.4 (V4C)
• CH569/CH565, USBSS, SerDes (V3A)

For CH58X, you might want to check out my experimental project ch58x-hal, which is a HAL for CH58X series chips, with BLE support.

Families that are not yet released(require more info):

• CH564, USBHS, 100M Ethernet (V4J)
• CH645, USB HUB, SerDes (V4C)
• CH32M, Motor control (V2C)

IP Cores

The CH32 RISC-V series chips are using the Qingke(青稞) IP Core.

Common features:

• Hardware Push Enable (HPE)
• Vector Table Free (VTF)
• 2-wire or single-wire debug interface

Cores:

• V2 (no pmp, no user mode)
  • V2A: rv32ec, +xw
  • V2C: rv32ec, +xw, +Zmmul
• V3 (no pmp)
  • V3A: rv32imac
• V4
  • V4A: rv32imac
  • V4B: rv32imac (no pmp)
  • V4C: rv32imac, +xw
  • V4F: rv32imafc, +xw
  • V4J: rv32imac, I-cache, +xw

Minimum supported Rust version(MSRV)

This project is developed with a recent nightly version of Rust compiler. And is expected to work with beta versions of Rust.

Feel free to change this if you did some testing with some version of Rust.

Contributing

All kinds of contributions are welcome.

• Bug fixes are welcomed: wrong naming, missing register, typo, translations, etc
• Adding new peripherals requires the following:
  • Use fixed SVD files from ch32-rs project
  • Use the script d to extract the peripheral yaml file from the SVD file (chiptool from embassy project)
  • Editing the yaml file to match the chip's peripherals
  • "transforms" for chiptool are also useful, you can check the stm32-data project for examples
  • Better not writing raw yaml from scratch, copy from existing peripherals and modify it
  • Peripheral files from stm32-data is also acceptable, but make sure to modify it to match the chip's peripherals, and register names
• Editing existing peripherals requires the following:
  • Refer both EVT demo code and datasheet to make sure the data is correct, ref: openwch project
    • Use the newest version of the datasheet! (and Chinese version might be newer than English version)
  • Make sure the editing does not breaks ch32-hal

License

This project is licensed under the MIT or Apache-2.0 license, at your option.