summaryrefslogtreecommitdiff
path: root/docs/source/index.rst
diff options
context:
space:
mode:
authorsakumisu <[email protected]>2022-05-14 22:50:27 +0800
committersakumisu <[email protected]>2022-05-14 23:20:13 +0800
commit5c64b99fddbfe5eb16dba5ea08800cba10023027 (patch)
treeab32a95bbc093b8b943df59a605146f36a2a57be /docs/source/index.rst
parent2ecde84a4ece1859f7d9e6c26f5c2001680b71e2 (diff)
update doc
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r--docs/source/index.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index b259a58e..88cd66c7 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -14,6 +14,7 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
- 标准化的 porting 接口
- 设备协议栈的使用简化到类如 uart 、dma 的使用,主机协议栈的使用简化到文件的使用
- 协议栈实现代码简短,并且从上往下看完就能理清 usb 枚举过程和 class 加载机制
+- Api 少,并且分为三类:dcd/hcd api、注册 api、命令回调 api
其他相关链接:
@@ -39,13 +40,16 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
usb/usb_desc
usb/usb_request
usb/usb_enum
+
.. toctree::
:maxdepth: 1
:caption: API 手册
api/api_device
api/api_host
+ api/api_port
api/api_common
+ api/api_config
.. toctree::
:maxdepth: 1