Просмотр исходного кода

docs: update rst

Signed-off-by: sakumisu <1203593632@qq.com>
sakumisu 8 месяцев назад
Родитель
Сommit
10e7fb60b4
4 измененных файлов с 39 добавлено и 20 удалено
  1. 25 8
      docs/source/opensource.rst
  2. 10 10
      docs/source/q&a.rst
  3. 2 1
      docs/source/show/index.rst
  4. 2 1
      docs/source/version.rst

+ 25 - 8
docs/source/opensource.rst

@@ -1,13 +1,18 @@
 官方开源项目分享
 ====================
 
-除了基本的厂家 SDK 支持以外,我们还对一些火热的开源项目进行了支持,以便于开发者更好的使用这些项目。
+除了基本的厂家 SDK 支持以外,我们还对一些火热的开源项目进行了支持,以便于开发者更好的使用这些项目。下面列举适配的 demo 工程链接,具体适配层参考 https://github.com/cherry-embedded/CherryUSB/tree/master/platform 。
 
 DAPLINK
 --------------
 
 适配链接:https://github.com/cherry-embedded/CherryDAP
 
+Blackmagic
+--------------
+
+适配链接:https://github.com/zhangjiance/bmp-hpm-port
+
 RT-Thread
 --------------
 
@@ -16,7 +21,25 @@ RT-Thread
 NUTTX/VELA
 --------------
 
-适配链接:待开放
+适配链接:https://github.com/CherryUSB/cherryusb_nuttx
+
+Zephyr
+--------------
+
+适配链接:https://github.com/hpmicro/zephyr_sdk_glue
+
+Cangaroo
+--------------
+
+Cangaroo is an open source can bus analyzer software. We provide four-channel CANFD analyzer based on hpmicro hpm5361
+
+适配上位机链接:https://github.com/RCSN/cangaroo_hpmicro_canfd_analyzer
+适配下位机链接:https://github.com/RCSN/hpm_sdk_extra/tree/main/demos/cangaroo_hpmicro
+
+LVGL
+--------------
+
+适配链接:https://github.com/cherry-embedded/CherryUSB/tree/master/platform/lvgl
 
 QMK
 --------------
@@ -32,10 +55,4 @@ Klipper is a 3d-printer firmware.
 
 适配链接:待开放
 
-Cangaroo
---------------
-
-Cangaroo is an open source can bus analyzer software. We provide four-channel CANFD analyzer based on hpmicro hpm5361
-
-适配链接:https://github.com/RCSN/cangaroo_hpmicro_canfd_analyzer
 

+ 10 - 10
docs/source/q&a.rst

@@ -15,7 +15,7 @@ Q & A
 - 是否能进 USB 中断
 - 芯片是否带有 cache功能,是否做了 no cache 处理,截图
 - 硬件是否正常,是否使用杜邦线连接,如果正常,请说明正常原因
-- 打开 CONFGI_USBDEV_SETUP_LOG_PRINT,并提供 log
+- 打开 CONFIG_USBDEV_SETUP_LOG_PRINT,并提供 log
 - 是否流片并销售
 
 其余问题提问模板
@@ -26,14 +26,7 @@ Q & A
 CherryUSB 性能能到多少
 ----------------------------------------------------------------
 
-可以达到硬件极限性能,当然需要硬件理论支持到这速度,CherryUSB 就支持到这速度,举例如下:
-
-- HPM 系列(从机可以到 42MB/S, 主机 44MB/S, 已经达到硬件极限)
-- BL 系列(从机 32MB/S, 主机 25MB/S, 已经达到硬件极限)
-- STM32F4 全速(从机 900KB/S, 主机 1.12MB/S, 已经达到硬件极限)
-
-从机测速demo: cdc_acm_template.c 并且关闭 log,脚本使用 `tools/test_srcipts/test_cdc_speed.py`
-主机测速demo: usb_host.c 中 TEST_USBH_CDC_SPEED=1
+参考 :ref:`performace_show`
 
 ST IP 命名问题
 ------------------
@@ -86,4 +79,11 @@ CONFIG_USB_HS 何时使用
 Failed to enable port
 ----------------------------------------------------------------
 
-供电不足或者硬件 USB 电路问题
+供电不足或者硬件 USB 电路问题
+
+移植 usb host 出现 urb  返回 -12/-14
+----------------------------------------------------------------
+
+-12 就检查 phy 配置,通信不良
+
+-14 就检查 phy 配置,cache 配置(如果有),fifo配置,寄存器地址, IP 是否真的标准等等

+ 2 - 1
docs/source/show/index.rst

@@ -1,3 +1,5 @@
+.. _performace_show:
+
 性能展示
 ==============================
 
@@ -15,7 +17,6 @@ CDC ACM 通信
 从机测速demo: cdc_acm_template.c 并且关闭 log,脚本使用 `tools/test_srcipts/test_cdc_speed.py`
 主机测速demo: usb_host.c 中 TEST_USBH_CDC_SPEED=1
 
-
 USB Device MSC
 -----------------
 

+ 2 - 1
docs/source/version.rst

@@ -117,4 +117,5 @@ v1.5.0
 - **memcpy 全部使用 usb_memcpy 替换,arm 库存在非对其访问问题**
 - ch32 device iso 更新
 - cmake,kconfig 更新
-- 使用 USB_ASSERT_MSG 对部分代码检查
+- 使用 USB_ASSERT_MSG 对部分代码检查
+- N32H4,mm32f5 支持