summaryrefslogtreecommitdiff
path: root/docs/source/quick_start
diff options
context:
space:
mode:
authorsakumisu <[email protected]>2024-02-18 19:36:20 +0800
committersakumisu <[email protected]>2024-02-18 21:15:04 +0800
commite0551b3e7b49cf80902683b0d1af34967cd3f0bd (patch)
treed226968598369106a8d53adf78413633d922b1fe /docs/source/quick_start
parent31fa2b99c5639741aadaddb19ae77539e718034a (diff)
config busid and regbase in usbh_initialize and usbd_initialize
Diffstat (limited to 'docs/source/quick_start')
-rw-r--r--docs/source/quick_start/img/stm32_13.pngbin38590 -> 42394 bytes
-rw-r--r--docs/source/quick_start/img/stm32_18.pngbin54057 -> 36595 bytes
-rw-r--r--docs/source/quick_start/img/stm32_19.pngbin52543 -> 44186 bytes
-rw-r--r--docs/source/quick_start/index.rst18
-rw-r--r--docs/source/quick_start/other_chip.rst13
5 files changed, 12 insertions, 19 deletions
diff --git a/docs/source/quick_start/img/stm32_13.png b/docs/source/quick_start/img/stm32_13.png
index d350a776..f12fad75 100644
--- a/docs/source/quick_start/img/stm32_13.png
+++ b/docs/source/quick_start/img/stm32_13.png
Binary files differ
diff --git a/docs/source/quick_start/img/stm32_18.png b/docs/source/quick_start/img/stm32_18.png
index 3c3800c1..456df189 100644
--- a/docs/source/quick_start/img/stm32_18.png
+++ b/docs/source/quick_start/img/stm32_18.png
Binary files differ
diff --git a/docs/source/quick_start/img/stm32_19.png b/docs/source/quick_start/img/stm32_19.png
index 625b9504..a796dc75 100644
--- a/docs/source/quick_start/img/stm32_19.png
+++ b/docs/source/quick_start/img/stm32_19.png
Binary files differ
diff --git a/docs/source/quick_start/index.rst b/docs/source/quick_start/index.rst
index c6315cb5..28dd4fc2 100644
--- a/docs/source/quick_start/index.rst
+++ b/docs/source/quick_start/index.rst
@@ -99,8 +99,6 @@ USB Device 移植要点
.. code-block:: C
// 以下细节如有出入,请对照 stm32xxx.h 文件修改
- #define USBD_IRQHandler OTG_HS_IRQHandler // pa11/pa12 引脚使用 OTG_FS_IRQHandler
- #define USBD_BASE (0x40040000UL) // pa11/pa12 引脚一般使用 50000000UL,STM32F7/H7 使用 0x40080000UL
#define CONFIG_USBDEV_EP_NUM 6 // pa11/pa12 引脚使用 4
#define CONFIG_USB_DWC2_RAM_SIZE 4096 // pa11/pa12 引脚使用 1280
@@ -108,8 +106,6 @@ USB Device 移植要点
.. code-block:: C
- #define USBD_IRQHandler USB_LP_CAN1_RX0_IRQHandler
- #define USBD_BASE (0x40005C00UL)
#define CONFIG_USBDEV_EP_NUM 8
#define CONFIG_USBDEV_FSDEV_PMA_ACCESS 2
@@ -118,13 +114,16 @@ USB Device 移植要点
.. figure:: img/stm32_10.png
.. figure:: img/stm32_11.png
-- 拷贝 **xxx_msp.c** 中的 **HAL_PCD_MspInit** 函数中的内容到 **usb_dc_low_level_init** 函数中,屏蔽 st 生成的 usb 中断函数和 usb 初始化
+- 拷贝 **xxx_msp.c** 中的 **HAL_PCD_MspInit** 函数中的内容到 **usb_dc_low_level_init** 函数中,屏蔽 st 生成的 usb 初始化
.. figure:: img/stm32_12.png
-.. figure:: img/stm32_13.png
.. figure:: img/stm32_14.png
-- 调用 template 的内容初始化,就可以使用了
+- 在中断函数中调用 `USBH_IRQHandler`,并传入 `busid`
+
+.. figure:: img/stm32_13.png
+
+- 调用 template 的内容初始化,并填入 `busid` 和 USB IP 的 `reg base`, `busid` 从 0 开始,不能超过 `CONFIG_USBDEV_MAX_BUS`
.. figure:: img/stm32_15.png
@@ -152,9 +151,8 @@ USB Host 移植要点
#define CONFIG_USBHOST_PIPE_NUM 12
- 拷贝 **xxx_msp.c** 中的 `HAL_HCD_MspInit` 函数中的内容到 `usb_hc_low_level_init` 函数中,屏蔽 st 生成的 usb 初始化
-- 在中断函数中调用 `USBH_IRQHandler`,并传入 bus 句柄
-- 调用 `usbh_alloc_bus` 创建 bus, `busid` 从 0 开始,不能超过 `CONFIG_USBHOST_MAX_BUS`
-- 调用 `usbh_initialize` 即可
+- 在中断函数中调用 `USBH_IRQHandler`,并传入 `busid`
+- 调用 `usbh_initialize` 并填入 `busid` 和 USB IP 的 `reg base`, `busid` 从 0 开始,不能超过 `CONFIG_USBHOST_MAX_BUS`
- 启动线程
.. figure:: img/stm32_18.png
diff --git a/docs/source/quick_start/other_chip.rst b/docs/source/quick_start/other_chip.rst
index f17602df..1c28b6c1 100644
--- a/docs/source/quick_start/other_chip.rst
+++ b/docs/source/quick_start/other_chip.rst
@@ -8,15 +8,11 @@ USB Device 移植要点
- 拷贝 CherryUSB 源码到工程目录下,并按需添加源文件和头文件路径,其中 `usbd_core.c` 和 `usb_dc_xxx.c` 为必须添加项。而 `usb_dc_xxx.c` 是芯片所对应的 USB IP dcd 部分驱动,如果不知道自己芯片属于那个 USB IP,参考 **port** 目录下的不同 USB IP 的 readme。如果使用的 USB IP 没有支持,只能自己实现了
- 拷贝 `cherryusb_config_template.h` 文件到自己工程目录下,命名为 `usb_config.h`,并添加相应的目录头文件路径
-- 在 `usb_config.h` 中添加 `USBD_IRQHandler=xxxx` 、 `CONFIG_USBDEV_EP_NUM=x` 以及 `USBD_BASE=0xxxxx` 三个常规 porting 需要的宏
-
-.. note:: 上述三个宏仅对 fsdev、musb、dwc2 有效,因为这 3 个是通用 IP
-
-.. note:: 为了适配后续多 port,建议中断名称不要使用宏来替换,自行在真实的中断中调用 `USBD_IRQHandler`
- 实现 `usb_dc_low_level_init` 函数(该函数主要负责 USB 时钟、引脚、中断的初始化)。该函数可以放在你想要放的任何参与编译的 c 文件中。如何进行 USB 的时钟、引脚、中断等初始化,请自行根据你使用的芯片原厂提供的源码中进行添加。
- 描述符的注册、class的注册、接口的注册、端点中断的注册。不会的参考 demo 下的 template
-- 调用 `usbd_initialize` 初始化 usb 硬件
+- 调用 `usbd_initialize` 并填入 `busid` 和 USB IP 的 `reg base`, `busid` 从 0 开始,不能超过 `CONFIG_USBDEV_MAX_BUS`
+- 在中断函数中调用 `USBD_IRQHandler`,并传入 `busid`, 如果你的 SDK 中中断入口已经存在 `USBD_IRQHandler` ,请更改 USB 协议栈中的名称
- 编译使用。各个 class 如何使用,参考 demo 下的 template
USB Host 移植要点
@@ -27,9 +23,8 @@ USB Host 移植要点
- 拷贝 CherryUSB 源码到工程目录下,并按需添加源文件和头文件路径,其中 `usbh_core.c` 、 `usb_hc_xxx.c` 以及 **osal** 目录下源文件(根据不同的 os 选择对应的源文件)为必须添加项。而 `usb_hc_xxx.c` 是芯片所对应的 USB IP dcd 部分驱动,如果不知道自己芯片属于那个 USB IP,参考 **port** 目录下的不同 USB IP 的 readme。如果使用的 USB IP 没有支持,只能自己实现了
- 拷贝 `cherryusb_config_template.h` 文件到自己工程目录下,命名为 `usb_config.h`,并添加相应的目录头文件路径
- 实现 `usb_hc_low_level_init` 函数(该函数主要负责 USB 时钟、引脚、中断的初始化)。该函数可以放在你想要放的任何参与编译的 c 文件中。如何进行 USB 的时钟、引脚、中断等初始化,请自行根据你使用的芯片原厂提供的源码中进行添加。
-- 调用 `usbh_alloc_bus` 创建 bus,填入 USB IP 的基地址, `busid` 从 0 开始,不能超过 `CONFIG_USBHOST_MAX_BUS`
-- 在中断函数中调用 `USBH_IRQHandler`,并传入 bus 句柄, 如果你的 SDK 中中断入口已经存在 `USBH_IRQHandler` ,请更改 USB 协议栈中的名称
-- 调用 `usbh_initialize`
+- 调用 `usbh_initialize` 并填入 `busid` 和 USB IP 的 `reg base`, `busid` 从 0 开始,不能超过 `CONFIG_USBHOST_MAX_BUS`
+- 在中断函数中调用 `USBH_IRQHandler`,并传入 `busid`, 如果你的 SDK 中中断入口已经存在 `USBH_IRQHandler` ,请更改 USB 协议栈中的名称
- 如果使用的是 GCC ,需要在链接脚本(ld)中添加如下代码:
.. code-block:: C