1``` mermaid 2gantt 3 title HPM SDK Release Plan 4 dateFormat YYYY-MM-DD 5 section Mainline Release 6 v1.1.0 :a1, 2023-01-01, 2023-03-31 7 v1.2.0 :a2, 2023-04-01, 2023-06-30 8 v1.3.0 :a3, 2023-07-01, 2023-09-30 9 v1.4.0 :a4, 2023-10-01, 2023-12-31 10``` 11 12[中文](README_zh.md) 13 14# HPM SDK Overview 15The HPM SDK Project is a software development kit based on HPMicro's MCUs, which supports a wide range of MCUs, based on the BSD license, including drivers, middleware and RTOS, such as littlevgl/ lwIP/ TinyUSB/ FreeRTOS, etc. It supports a large number of Boards. 16 17## SDK Directory Structure 18 19| Name | Description | 20|--------|--------| 21| <HPM_SDK_BASE>/arch | cpu architecture | 22| <HPM_SDK_BASE>/boards | board support files | 23| <HPM_SDK_BASE>/cmake | cmake extensions | 24| <HPM_SDK_BASE>/components | software components | 25| <HPM_SDK_BASE>/docs | documentation | 26| <HPM_SDK_BASE>/drivers | low level driver files | 27| <HPM_SDK_BASE>/middleware | middleware files | 28| <HPM_SDK_BASE>/samples | sample source for drivers, middleware, components | 29| <HPM_SDK_BASE>/scripts | util scripts | 30| <HPM_SDK_BASE>/soc | SoC specific source | 31| <HPM_SDK_BASE>/utils | util source | 32 33## SDK Documentation 34- Local: 35 SDK documentation can be built locally, once it's done, it can be accessed with the following entries: 36 - <HPM_SDK_BASE>>/docs/index.html 37 - <HPM_SDK_BASE>>/docs/index_zh.html 38 > Please refer to <HPM_SDK_BASE>/docs/README.md for more details about documentation building. 39- Online: 40 - http://hpm-sdk.readthedocs.io/ 41 - http://hpm-sdk-zh.readthedocs.io/ 42 43## Repositories 44- hpm_sdk: https://github.com/hpmicro/hpm_sdk 45- sdk_env: https://github.com/hpmicro/sdk_env 46- sdk extra demo: https://github.com/hpmicro/hpm_sdk_extra 47- openocd (hpmicro patched): https://github.com/hpmicro/riscv-openocd 48- gnu gcc toolchain: https://github.com/hpmicro/riscv-gnu-toolchain 49 50> Note: repositories are mirrored on gitee. 51