Add documentation for k230 virt reference platform. Signed-off-by: Chao Liu <[email protected]> Reviewed-by: Daniel Henrique Barboza <[email protected]> --- MAINTAINERS | 1 + docs/system/riscv/k230.rst | 48 ++++++++++++++++++++++++++++++++++++ docs/system/target-riscv.rst | 1 + 3 files changed, 50 insertions(+) create mode 100644 docs/system/riscv/k230.rst
diff --git a/MAINTAINERS b/MAINTAINERS index 8bdab8fb8a..bfa63f832e 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1713,6 +1713,7 @@ F: include/hw/riscv/xiangshan_kmh.h K230 Machines M: Chao Liu <[email protected]> S: Maintained +F: docs/system/riscv/k230.rst F: hw/riscv/k230.c F: hw/watchdog/k230_wdt.c F: include/hw/riscv/k230.h diff --git a/docs/system/riscv/k230.rst b/docs/system/riscv/k230.rst new file mode 100644 index 0000000000..3e6ca295df --- /dev/null +++ b/docs/system/riscv/k230.rst @@ -0,0 +1,48 @@ +Kendryte K230 virt reference platform (``k230``) +========================================================================== +The ``k230`` machine is compatible with with Kendryte K230 SDK. + +The K230 is a chip from the AIoT SoC series made by Kendryte ® — a part of +Canaan Inc. It uses a brand-new multi-heterogeneous unit accelerated computing +structure. + +This chip has 2 RISC-V computing cores and a new-generation KPU (Knowledge +Process Unit) smart computing unit. + +It has multi-precision AI computing ability, works with many common AI computing +frameworks, and for some typical networks, its usage rate is over 70%. Besides, +the K230 chip supports many peripheral connections and has several special +hardware acceleration units (like 2D and 2.5D accelerators). It can speed up +different tasks (such as image processing, video processing, audio processing +and AI computing). It also has many good features: low delay, high performance, +low power use and fast start-up. + +For more information, see <https://www.kendryte.com/en/proDetail/230> + +Supported devices +----------------- +The ``k230`` machine supports the following devices: + +* 1 c908 cores +* Core Local Interruptor (CLINT) +* Incoming MSI Controller (IMSIC) +* 2 K230 Watchdog Timer +* 4 UART + +Boot options +------------ +The ``k230`` machine can start using the standard ``-bios`` +functionality for loading the boot image. You need to compile and link +the firmware, kernel, and Device Tree (FDT) into a single binary file with +K230 SDK(k230_canmv_defconfig), such as ``uboot``. + +Running +------- +Below is an example command line for running the ``k230`` +machine: + +.. code-block:: bash + + $ qemu-system-riscv64 -machine k230 \ + -bios k230_sdk/output/k230_canmv_defconfig/little/uboot/u-boot \ + -nographic diff --git a/docs/system/target-riscv.rst b/docs/system/target-riscv.rst index 89b2cb732c..2103ff6173 100644 --- a/docs/system/target-riscv.rst +++ b/docs/system/target-riscv.rst @@ -66,6 +66,7 @@ undocumented; you can get a complete list by running .. toctree:: :maxdepth: 1 + riscv/k230 riscv/microblaze-v-generic riscv/microchip-icicle-kit riscv/shakti-c -- 2.51.0
