summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorsakumisu <[email protected]>2024-07-21 17:44:57 +0800
committersakumisu <[email protected]>2024-07-21 17:44:57 +0800
commit1927566dfccbcae370af6cf892026c5c955e8f0f (patch)
tree97e5ff882f3a6feb006995a2af8ccd52f4697853 /docs/source
parentb7556b2ddc906ae5b83d5b7f00fcfe8fb9b2257a (diff)
chore(docs): update rst
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/index.rst1
-rw-r--r--docs/source/q&a.rst39
-rw-r--r--docs/source/version.rst56
3 files changed, 65 insertions, 31 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index e9fdfdbd..c3ceb10f 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -57,6 +57,7 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
quick_start/rt-thread/rtthread
quick_start/other_chip
q&a
+ version
.. toctree::
:maxdepth: 1
diff --git a/docs/source/q&a.rst b/docs/source/q&a.rst
index 438919d7..52a63c27 100644
--- a/docs/source/q&a.rst
+++ b/docs/source/q&a.rst
@@ -17,36 +17,6 @@ Q & A
具体说明现象,复现方式,使用我提供的 demo 再测试,以及提供完整 log
-
-CherryUSB 版本推荐
----------------------
-
-如果没有特别情况,请使用最新版本.详细版本更新说明请参考 https://github.com/cherry-embedded/CherryUSB/releases。
-
-- <= v0.10.2 初代版本
-
-用于定基本的框架,仅支持单 USB IP, 并且无法动态使用硬件 pipe.
-使用 XHCI 需要切到这个版本,高版本后续重构. 部分 IP 只能使用此版本,后续版本删除不再使用
-
-- v1.0.0 过度版本
-
-**支持动态使用硬件 pipe,不再固定**
-
-- v1.1.0 过度版本
-
-**主从机支持多 USB IP 且要相同 IP**;主机增加 bluetooth, chh340, ftdi, cp210x, asix 驱动
-
-- v1.2.0
-
-主机增加 rtl8152,cdc ncm 主机驱动;增加 esp ,aic 主机驱动;DWC2 优化代码方便阅读,并增加一些 FIFO 配置宏给用户,并增加 fifo check(这个很重要也很坑)
-
-- v1.3.0
-
-增加一些宏的 check;
-主机增加 pl2303 驱动;使用 id table 来支持多个 vid,pid;增加 user_data 给用户使用;优化网络相关的 class 配置和性能;
-从机增加一些获取端点信息的 api,并 **统一 ep0 buffer 的使用,美化代码**;**支持多种速度描述符自动选择功能**;
-port 中 urb->timeout 清0 的处理有点问题(大数据量传输时会出现 no pipe alloc 异常,主要原因是刚启动传输就完成了,还没判断 timeout就被修改为0了,没有进入 take sem 流程),此版本已修复
-
CherryUSB 性能能到多少
----------------------------------------------------------------
@@ -77,7 +47,8 @@ dwc2 has less endpoints than config, please check
Ep addr XXX overflow
------------------------------
-该 IP 硬件上没有这么多端点, 请更换 IP or 减少端点使用。
+该 IP 硬件上没有这么多端点, 请更换 IP or 减少端点使用。并且默认 demo 不做双向功能,考虑到不是所有的 IP 都支持,因此默认是 81 02 这样的而不是 81 01,
+如果支持,自行修改。某些 IP 双向端点可能会占用相同的硬件信息,不一定能同时使用,自行检查。
This dwc2 version does not support dma mode, so stop working
----------------------------------------------------------------
@@ -92,3 +63,9 @@ CONFIG_USB_HS 何时使用
----------------------------------------------------------------
当你的芯片硬件支持高速,并想初始化成高速模式时开启,相关 IP 会根据该宏配置内部或者外部 高速 PHY。
+
+
+Failed to enable port
+----------------------------------------------------------------
+
+供电不足或者硬件 USB 电路问题 \ No newline at end of file
diff --git a/docs/source/version.rst b/docs/source/version.rst
new file mode 100644
index 00000000..95a5d08c
--- /dev/null
+++ b/docs/source/version.rst
@@ -0,0 +1,56 @@
+版本说明
+==============================
+
+如果没有特别情况,请使用最新版本.详细版本更新说明请参考 https://github.com/cherry-embedded/CherryUSB/releases。
+
+<= v0.10.2 初代版本
+----------------------
+
+- **用于定基本的框架,仅支持单 USB IP**。
+- **host 驱动每个 ep占用一个 硬件 pipe,不支持动态使用硬件 pipe**。
+- 相关 porting 需要使用此版本,后续不再支持(比如 ch32,rp2040),以及旧版本pusb2 和 xhci(新版本不再提供源码)。
+
+v1.0.0 过度版本
+----------------------
+
+- **host 支持动态使用硬件 pipe,不再固定**
+
+v1.1.0 过度版本
+----------------------
+
+- **主从机支持多 USB IP 且要相同 IP**
+- host 增加 bluetooth, chh340, ftdi, cp210x, asix 驱动
+- device msc 支持多 lun,并且 CONFIG_USBDEV_MSC_BLOCK_SIZE 修改为 CONFIG_USBDEV_MSC_MAX_BUFSIZE
+
+v1.2.0
+----------------------
+
+- host 增加 rtl8152,cdc ncm 驱动
+- host 增加 timer 去控制中断传输(hub修改为 timer 控制)
+- porting 增加 esp,aic 主机驱动
+- 优化 DWC2 优化代码方便阅读,并增加一些 FIFO 配置宏给用户(因为 dwc2 fifo 大小有限,以及配置方式很多,所以导出给用户配置,方便合理控制性能)
+- 优化 ehci 驱动(qtd不再使用动态申请,绑定 qh),方便代码运行的更快
+
+v1.3.0
+----------------------
+
+- device 支持多种速度描述符自动选择功能(开启 CONFIG_USBDEV_ADVANCE_DESC)
+- device core 代码统一 ep0 buffer 的使用,用于美化代码
+- host 增加 pl2303 驱动,使用 id table 来支持多个 vid,pid,增加 user_data 给用户使用
+- host 网络 class 驱动增加 tx、rx buffer的宏,增加 LWIP_TCPIP_CORE_LOCKING_INPUT 的使用,以便实现数据的零拷贝
+- host hid 增加report api
+- porting 导入 bouffalo,aic,stm32f723 device驱动
+- porting 中主机部分 urb->timeout 清0 的处理有点问题(大数据量传输时会出现 no pipe alloc 异常,主要原因是刚启动传输就完成了,还没判断 timeout就被修改为0了,没有进入 take sem 流程),此版本已修复
+- ehci enable iaad in usbh_kill_urb,read ehci hcor offset from hccr caplength,enable ohci for ehci
+- 适配 nuttx os
+
+v1.3.1
+----------------------
+
+- bugfix(audio,video,cdc ecm 相关宏,结构体,api)
+- host hub 枚举线程删除,使用 psc 线程,枚举方式更改为队列模式,取消同时枚举多个设备的功能
+- host 扫描驱动信息和 instance 采用递归模式,删除链表扫描
+- host 网络 class 驱动优化,支持接收 16K 以上的数据(cdc ecm 不支持)
+- 增加高级 memcpy api
+- device 枚举相关删除打印(中断中不再做打印)
+- porting 中 musb fifo配置修改为从 fifo table 获取(此代码参考 linux),适配 es32,sunxi,beken \ No newline at end of file