summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorsakumisu <[email protected]>2024-05-17 17:03:50 +0800
committersakumisu <[email protected]>2024-05-17 17:03:50 +0800
commit1d9a36b61c1bc5d4b5b7086e6e61e99b8d1beb66 (patch)
treee0d3c161d912ecfed97c2dcd056b5f98bb49c74b /docs
parentb1c81a92f56ab5a0444384a8b3103de97a76daa6 (diff)
update(docs): update rst
Diffstat (limited to 'docs')
-rw-r--r--docs/source/api/api_port.rst2
-rw-r--r--docs/source/conf.py4
-rw-r--r--docs/source/index.rst8
-rw-r--r--docs/source/q&a.rst26
-rw-r--r--docs/source/support.rst10
5 files changed, 37 insertions, 13 deletions
diff --git a/docs/source/api/api_port.rst b/docs/source/api/api_port.rst
index 74a4ecb5..a11a8b6c 100644
--- a/docs/source/api/api_port.rst
+++ b/docs/source/api/api_port.rst
@@ -210,6 +210,8 @@ usbh_submit_urb
- **arg** 传输完成时携带的参数
- **iso_packet** iso 数据包
+.. note:: timeout 如何没有特别对时间的要求,必须设置成 0xffffffff,原则上不允许超时,如果超时了,一般不能再继续工作
+
`errorcode` 可以返回以下值:
.. code-block:: C
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 6b35bd40..1c57c52b 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -6,8 +6,8 @@ project = 'CherryUSB'
copyright = '2024, sakumisu'
author = 'sakumisu'
-release = '1.2.0'
-version = '1.2.0'
+release = '1.3.0'
+version = '1.3.0'
# -- General configuration
diff --git a/docs/source/index.rst b/docs/source/index.rst
index cd82bd7c..801a5db7 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -108,4 +108,10 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
:maxdepth: 1
:caption: 工具使用
- tools/index \ No newline at end of file
+ tools/index
+
+.. toctree::
+ :maxdepth: 1
+ :caption: 商业支持
+
+ support \ No newline at end of file
diff --git a/docs/source/q&a.rst b/docs/source/q&a.rst
index d3bc84af..b55d5a05 100644
--- a/docs/source/q&a.rst
+++ b/docs/source/q&a.rst
@@ -15,7 +15,7 @@ Q & A
其余问题提问模板
------------------
-具体说明现象,复现方式,并提供完整 log
+具体说明现象,复现方式,使用我提供的 demo 再测试,以及提供完整 log
CherryUSB 版本推荐
@@ -30,21 +30,22 @@ CherryUSB 版本推荐
- v1.0.0 过度版本
-支持动态使用硬件 pipe,不再固定
+**支持动态使用硬件 pipe,不再固定**
- v1.1.0 过度版本
-主从机支持多 USB IP 且要相同 IP, 主机增加 bluetooth, chh340, ftdi, cp210x, asix 驱动
+**主从机支持多 USB IP 且要相同 IP**;主机增加 bluetooth, chh340, ftdi, cp210x, asix 驱动
- v1.2.0
-主机增加 rtl8152,cdc ncm 主机驱动,增加 esp ,aic 驱动,DWC2 优化代码阅读,并增加一些配置宏给用户
+主机增加 rtl8152,cdc ncm 主机驱动;增加 esp ,aic 主机驱动;DWC2 优化代码方便阅读,并增加一些 FIFO 配置宏给用户,并增加 fifo check(这个很重要也很坑)
- v1.3.0
-增加一些 宏的 check;
-主机增加 pl2303 驱动,支持多个 vid,pid,支持 user_data 给用户使用,优化网络性能;
-从机增加一些获取端点信息的 api,并统一 ep0 buffer 的使用,支持多速度描述符自动选择功能
+增加一些宏的 check;
+主机增加 pl2303 驱动;使用 id table 来支持多个 vid,pid;增加 user_data 给用户使用;优化网络相关的 class 配置和性能;
+从机增加一些获取端点信息的 api,并 **统一 ep0 buffer 的使用,美化代码**;**支持多种速度描述符自动选择功能**;
+port 中 urb->timeout 清0 的处理有点问题(大数据量传输时会出现 no pipe alloc 异常,主要原因是刚启动传输就完成了,还没判断 timeout就被修改为0了,没有进入 take sem 流程),此版本已修复
CherryUSB 性能能到多少
----------------------------------------------------------------
@@ -56,20 +57,25 @@ ST IP 命名问题
ST 命名为 USB_OTG_FS, USB_OTG_HS,并不是说明本身是高速或者全速,只是代表可以支持到高速,但是本身都是全速,需要外挂高速phy。因此,提问禁止说这两个词,请使用 USB0(PA11/PA12),USB1(PB14/PB15) 代替。其余国产厂家同理。
+GD IP 问题
+------------------
+
+GD IP 采用 DWC2,但是读取的硬件参数都是 0(我也不懂为什么不给人知道),因此需要用户自行知道硬件信息,并修改代码下面 check 的内容,然后删除 while1。
+
dwc2 has less endpoints than config, please check
---------------------------------------------------------------
-该 IP 硬件上没有这么多端点,请修改 `CONFIG_USBDEV_EP_NUM`.如果是 GD 芯片,由于 GD 的 dwc2 读出来的硬件配置都是0,所以需要自行 check 并删除 while1
+该 IP 硬件上没有这么多端点,请修改 `CONFIG_USBDEV_EP_NUM`
Ep addr XXX overflow
------------------------------
-该 IP 硬件上没有这么多端点, 请更换 IP or 减少端点使用
+该 IP 硬件上没有这么多端点, 请更换 IP or 减少端点使用。
This dwc2 version does not support dma mode, so stop working
----------------------------------------------------------------
-该 DWC2 版本不支持 dma 模式,禁止使用. 如果是 GD 芯片,由于 GD 的 dwc2 读出来的硬件配置都是0,所以需要自行 check 并删除 while1
+该 DWC2 版本不支持 dma 模式,禁止使用。
__has_include 报错
------------------------------------------------------------------
diff --git a/docs/source/support.rst b/docs/source/support.rst
new file mode 100644
index 00000000..dd323c11
--- /dev/null
+++ b/docs/source/support.rst
@@ -0,0 +1,10 @@
+商业支持
+==============================
+
+以下内容为商业收费类,如需支持,请邮件到 [email protected]
+
+- 主机 UVC & UAC 类 IP 驱动(ISO 传输驱动,其余已经开源)和框架
+- 主从机 MTP 类驱动
+- USB 网卡类驱动优化
+- 定制化 class 驱动或者 IP 驱动
+- 技术支持相关 \ No newline at end of file