From 2c9eb9baba4d99e2a284a34cdc71ef016131161c Mon Sep 17 00:00:00 2001 From: Egahp <57124987+Egahp@users.noreply.github.com> Date: Sat, 30 Aug 2025 11:24:27 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20cherry-e?= =?UTF-8?q?mbedded/CherryUSB@5d5b61a606b1d2ba5512ef3c71fb11975eed5e40=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _sources/api/api_host.rst.txt | 3 ++- _sources/quick_start/demo.rst.txt | 2 +- _sources/quick_start/rtthread.rst.txt | 2 +- _sources/quick_start/transplant.rst.txt | 4 ++-- api/api_host.html | 3 ++- quick_start/demo.html | 2 +- quick_start/rtthread.html | 2 +- quick_start/transplant.html | 4 ++-- searchindex.js | 2 +- 9 files changed, 13 insertions(+), 11 deletions(-) diff --git a/_sources/api/api_host.rst.txt b/_sources/api/api_host.rst.txt index 3368f47f..28287a0b 100644 --- a/_sources/api/api_host.rst.txt +++ b/_sources/api/api_host.rst.txt @@ -126,10 +126,11 @@ usbh_initialize .. code-block:: C - int usbh_initialize(uint8_t busid, uint32_t reg_base); + int usbh_initialize(uint8_t busid, uint32_t reg_base, usbh_event_handler_t event_handler); - **busid** bus id，从 0开始，不能超过 `CONFIG_USBHOST_MAX_BUS` - **reg_base** hcd 寄存器基地址 +- **event_handler** host 事件回调函数，可以为NULL - **return** 0 表示正常其他表示错误 usbh_find_class_instance diff --git a/_sources/quick_start/demo.rst.txt b/_sources/quick_start/demo.rst.txt index 9c5e6569..ebb211a9 100644 --- a/_sources/quick_start/demo.rst.txt +++ b/_sources/quick_start/demo.rst.txt @@ -203,7 +203,7 @@ USB Host 移植要点 - 链接脚本修改参考 :ref:`usbh_link_script` 章节 - 如果芯片带 cache，cache 修改参考 :ref:`usb_cache` 章节 -- 调用 `usbh_initialize` 并填入 `busid` 和 USB IP 的 `reg base`， `busid` 从 0 开始，不能超过 `CONFIG_USBHOST_MAX_BUS` +- 调用 `usbh_initialize` 并填入 `busid` 和 USB IP 的 `reg base` 还有 `event_handler` 可缺省为NULL， `busid` 从 0 开始，不能超过 `CONFIG_USBHOST_MAX_BUS` - 启动线程 .. figure:: img/stm32_18.png diff --git a/_sources/quick_start/rtthread.rst.txt b/_sources/quick_start/rtthread.rst.txt index e9c4df5b..132015d9 100644 --- a/_sources/quick_start/rtthread.rst.txt +++ b/_sources/quick_start/rtthread.rst.txt @@ -56,7 +56,7 @@ * USB IP 相关的 config 需要用户自己根据芯片实际情况修改 * 在代码中实现 `usb_hc_low_level_init` 函数 * 在 USB 中断函数中调用 `USBH_IRQHandler`，并传入 `busid` -* 调用 `usbh_initialize` 并填入 `busid` 和 USB IP 的 `reg base`， `busid` 从 0 开始，不能超过 `CONFIG_USBHOST_MAX_BUS` +* 调用 `usbh_initialize` 并填入 `busid` 和 USB IP 的 `reg base` 还有 `event_handler` 可缺省为NULL， `busid` 从 0 开始，不能超过 `CONFIG_USBHOST_MAX_BUS` * 使用 `scons --target=mdk5` 或者 `scons` 进行编译，如果是mdk，需要使用 AC6 编译器 * 链接脚本修改参考 :ref:`usbh_link_script` 章节 * 如果芯片带 cache，cache 修改参考 :ref:`usb_cache` 章节 diff --git a/_sources/quick_start/transplant.rst.txt b/_sources/quick_start/transplant.rst.txt index a6dcf14e..710497d4 100644 --- a/_sources/quick_start/transplant.rst.txt +++ b/_sources/quick_start/transplant.rst.txt @@ -19,11 +19,11 @@ USB Host 移植要点 - 拷贝 CherryUSB 源码到工程目录下，并按需添加源文件和头文件路径，头文件路径建议全部添加。其中 `usbh_core.c` 、 `usb_hc_xxx.c` 以及 **osal** 目录下源文件（根据不同的 os 选择对应的源文件）为必须添加项。而 `usb_hc_xxx.c` 是芯片所对应的 USB IP hcd 部分驱动，如果不知道自己芯片属于那个 USB IP，参考 **port** 目录下的不同 USB IP 的 readme。如果使用的 USB IP 没有支持，只能自己实现了 - 拷贝 `cherryusb_config_template.h` 文件到自己工程目录下，命名为 `usb_config.h`，并添加相应的目录头文件路径 - 实现 `usb_hc_low_level_init` 函数（该函数主要负责 USB 时钟、引脚、中断的初始化）。该函数可以放在你想要放的任何参与编译的 c 文件中。如何进行 USB 的时钟、引脚、中断等初始化，请自行根据你使用的芯片原厂提供的源码中进行添加。 -- 调用 `usbh_initialize` 并填入 `busid` 和 USB IP 的 `reg base`， `busid` 从 0 开始，不能超过 `CONFIG_USBHOST_MAX_BUS` +- 调用 `usbh_initialize` 并填入 `busid` 和 USB IP 的 `reg base` 还有 `event_handler` 可缺省为NULL， `busid` 从 0 开始，不能超过 `CONFIG_USBHOST_MAX_BUS` - 在中断函数中调用 `USBH_IRQHandler`，并传入 `busid`, 如果你的 SDK 中中断入口已经存在 `USBH_IRQHandler` ，请更改 USB 协议栈中的名称 - 链接脚本修改参考 :ref:`usbh_link_script` 章节 - 如果芯片带 cache，cache 修改参考 :ref:`usb_cache` 章节 -- 调用 `usbh_initialize` ，填入 `busid` 和 USB IP 的 `reg base`， `busid` 从 0 开始，不能超过 `CONFIG_USBHOST_MAX_BUS` 。基础的 cdc + hid + msc 参考 `usb_host.c` 文件，其余参考 **platform** 目录下适配 +- 调用 `usbh_initialize` ，填入 `busid` 和 USB IP 的 `reg base` 还有 `event_handler` 可缺省为NULL， `busid` 从 0 开始，不能超过 `CONFIG_USBHOST_MAX_BUS` 。基础的 cdc + hid + msc 参考 `usb_host.c` 文件，其余参考 **platform** 目录下适配 .. _usbh_link_script: diff --git a/api/api_host.html b/api/api_host.html index 61c8ddc8..feb6cdaf 100644 --- a/api/api_host.html +++ b/api/api_host.html @@ -293,12 +293,13 @@

usbh_initialize

usbh_initialize 用来初始化 usb 主机协议栈，包括：初始化 usb 主机控制器，创建 roothub 设备，创建 hub 检测线程。

-
int usbh_initialize(uint8_t busid, uint32_t reg_base);
+
int usbh_initialize(uint8_t busid, uint32_t reg_base, usbh_event_handler_t event_handler);
 

 

 
    
 
  • busid  bus id，从 0开始，不能超过 CONFIG_USBHOST_MAX_BUS
    • 
 
  • reg_base  hcd 寄存器基地址
    • 
+
  • event_handler  host 事件回调函数，可以为NULL
    • 
 
  • return  0 表示正常其他表示错误
    •
diff --git a/quick_start/demo.html b/quick_start/demo.html index f1df45d8..b2af6868 100644 --- a/quick_start/demo.html +++ b/quick_start/demo.html @@ -413,7 +413,7 @@
diff --git a/quick_start/rtthread.html b/quick_start/rtthread.html index 28cea1de..8a4d2ff5 100644 --- a/quick_start/rtthread.html +++ b/quick_start/rtthread.html @@ -225,7 +225,7 @@

  • USB IP 相关的 config 需要用户自己根据芯片实际情况修改

  • 在代码中实现 usb_hc_low_level_init 函数

  • 在 USB 中断函数中调用 USBH_IRQHandler，并传入 busid

    • -

  • 调用 usbh_initialize 并填入 busid 和 USB IP 的 reg base， busid 从 0 开始，不能超过 CONFIG_USBHOST_MAX_BUS

    • +

  • 调用 usbh_initialize 并填入 busid 和 USB IP 的 reg base 还有 event_handler 可缺省为NULL， busid 从 0 开始，不能超过 CONFIG_USBHOST_MAX_BUS

  • 使用 scons –target=mdk5 或者 scons 进行编译，如果是mdk，需要使用 AC6 编译器

  • 链接脚本修改参考 主机链接脚本修改 章节

  • 如果芯片带 cache，cache 修改参考 cache 配置修改 章节

    • diff --git a/quick_start/transplant.html b/quick_start/transplant.html index 7c591b36..f9f07c20 100644 --- a/quick_start/transplant.html +++ b/quick_start/transplant.html @@ -183,11 +183,11 @@

  • 拷贝 CherryUSB 源码到工程目录下，并按需添加源文件和头文件路径，头文件路径建议全部添加。其中 usbh_core.c 、 usb_hc_xxx.c 以及 osal 目录下源文件（根据不同的 os 选择对应的源文件）为必须添加项。而 usb_hc_xxx.c 是芯片所对应的 USB IP hcd 部分驱动，如果不知道自己芯片属于那个 USB IP，参考 port 目录下的不同 USB IP 的 readme。如果使用的 USB IP 没有支持，只能自己实现了

  • 拷贝 cherryusb_config_template.h 文件到自己工程目录下，命名为 usb_config.h，并添加相应的目录头文件路径

  • 实现 usb_hc_low_level_init 函数（该函数主要负责 USB 时钟、引脚、中断的初始化）。该函数可以放在你想要放的任何参与编译的 c 文件中。如何进行 USB 的时钟、引脚、中断等初始化，请自行根据你使用的芯片原厂提供的源码中进行添加。

    • -

  • 调用 usbh_initialize 并填入 busid 和 USB IP 的 reg base， busid 从 0 开始，不能超过 CONFIG_USBHOST_MAX_BUS

    • +

  • 调用 usbh_initialize 并填入 busid 和 USB IP 的 reg base 还有 event_handler 可缺省为NULL， busid 从 0 开始，不能超过 CONFIG_USBHOST_MAX_BUS

  • 在中断函数中调用 USBH_IRQHandler，并传入 busid, 如果你的 SDK 中中断入口已经存在 USBH_IRQHandler ，请更改 USB 协议栈中的名称

  • 链接脚本修改参考 主机链接脚本修改 章节

  • 如果芯片带 cache，cache 修改参考 cache 配置修改 章节

    • -

  • 调用 usbh_initialize ，填入 busid 和 USB IP 的 reg base， busid 从 0 开始，不能超过 CONFIG_USBHOST_MAX_BUS 。基础的 cdc + hid + msc 参考 usb_host.c 文件，其余参考 platform 目录下适配

    • +

  • 调用 usbh_initialize ，填入 busid 和 USB IP 的 reg base 还有 event_handler 可缺省为NULL， busid 从 0 开始，不能超过 CONFIG_USBHOST_MAX_BUS 。基础的 cdc + hid + msc 参考 usb_host.c 文件，其余参考 platform 目录下适配