• Home
  • Annotate
  • current directory
Name Date Size #Lines LOC

..21-Aug-2025-

arch/riscv/21-Aug-2025-

components/21-Aug-2025-

drivers/21-Aug-2025-

soc/21-Aug-2025-

utils/21-Aug-2025-

CHANGELOG.md A D21-Aug-202575.7 KiB1,5201,420

LICENSE A D21-Aug-20251.6 KiB3224

README.md A D21-Aug-20252 KiB5143

README_zh.md A D21-Aug-20251.9 KiB5143

SConscript A D21-Aug-20253.6 KiB12989

VERSION A D21-Aug-202591 65

README.md

1``` mermaid
2gantt
3    title HPM SDK Release Plan
4    dateFormat  YYYY-MM-DD
5    section Mainline Release
6    v1.5.0           :a1, 2024-01-01, 2024-03-31
7    v1.6.0           :a2, 2024-04-01, 2024-06-30
8    v1.7.0           :a3, 2024-07-01, 2024-09-30
9    v1.8.0           :a4, 2024-10-01, 2024-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 for [hpm_sdk Getting Started](docs/en/get_started.md) 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

README_zh.md

1``` mermaid
2gantt
3    title HPM SDK Release Plan
4    dateFormat  YYYY-MM-DD
5    section Mainline Release
6    v1.5.0           :a1, 2024-01-01, 2024-03-31
7    v1.6.0           :a2, 2024-04-01, 2024-06-30
8    v1.7.0           :a3, 2024-07-01, 2024-09-30
9    v1.8.0           :a4, 2024-10-01, 2024-12-31
10```
11
12[English](README.md)
13
14# HPM SDK 概述
15HPM SDK项目是基于HPMicro 公司的MCU编写的软件开发包，支持多种MCU。基于BSD许可证，包含了底层驱动，中间件和RTOS，例如littlevgl/ lwIP/ TinyUSB/ FreeRTOS等，支持大量评估板。
16
17## HPM SDK 目录结构
18
19| 目录名称 | 描述 |
20|--------|--------|
21| <HPM_SDK_BASE>/arch | cpu架构相关文件 |
22| <HPM_SDK_BASE>/boards | 板级文件 |
23| <HPM_SDK_BASE>/cmake | cmake扩展 |
24| <HPM_SDK_BASE>/components | 软件组件 |
25| <HPM_SDK_BASE>/docs | 文档 |
26| <HPM_SDK_BASE>/drivers | 底层驱动文件|
27| <HPM_SDK_BASE>/middleware | 中间件 |
28| <HPM_SDK_BASE>/samples | 驱动、中间件以及软件组件示例代码 |
29| <HPM_SDK_BASE>/scripts | 辅助脚本 |
30| <HPM_SDK_BASE>/soc | SoC相关文件 |
31| <HPM_SDK_BASE>/utils | 辅助文件 |
32
33## SDK文档
34- 本地文档:
35  SDK文档可以进行本地编译，成功编译之后可以通过以下入口访问本地文档:
36  - <HPM_SDK_BASE>>/docs/index.html
37  - <HPM_SDK_BASE>>/docs/index_zh.html
38  > 文档编译方式请参考[hpm_sdk Getting Started](docs/zh/get_started.md)
39- 在线文档：
40  - http://hpm-sdk.readthedocs.io/
41  - http://hpm-sdk-zh.readthedocs.io/
42
43## 代码仓库
44- hpm_sdk github: https://github.com/hpmicro/hpm_sdk
45- sdk_env github: 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> 仓库在gitee上有对应的镜像。
51