yemai/CherryUSB
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update quick start rst

Browse Source
This commit is contained in:
sakumisu
2022-04-16 21:17:56 +08:00
parent ba2f36848d
commit b104749c8c
29 changed files with 113 additions and 257 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/source/quick_start/other_chip.rst
View File

@@ -6,12 +6,13 @@
USB Device 移植要点
-----------------------
- 拷贝 CherryUSB 源码到工程里
- 添加 `usbd_core.c`
- 添加 `usb_dc_xxx.c`，它是芯片所对应的 USB IP dcd 部分驱动，如果不知道自己芯片属于那个 USB IP，参考 **port** 目录下的不同 USB IP 的 readme。如果使用的 USB IP 没有支持，只能自己实现了
- 添加 `USBD_IRQHandler=xxxx` 和 `USB_NUM_BIDIR_ENDPOINTS=x` 的 CFLAG，如果没有添加则使用 `usb_dc_xxx.c` 默认配置
- 添加 CherryUSB 源码中使用到的源文件的对应头文件路径，不要添加CherryUSB 根目录路径
- 根据自己的需求添加 对应 **class** 目录下的文件，并且添加的文件形似 `usbd_xxx.c`
- 拷贝 CherryUSB 源码到工程目录下
- 添加 `usbd_core.c` 参与编译
- 根据自己的需求添加对应 **class** 目录下的文件参与编译，并且添加的文件形似 `usbd_xxx.c`
- 添加 `usb_dc_xxx.c` 参与编译，它是芯片所对应的 USB IP dcd 部分驱动，如果不知道自己芯片属于那个 USB IP，参考 **port** 目录下的不同 USB IP 的 readme。如果使用的 USB IP 没有支持，只能自己实现了
- 添加 `USBD_IRQHandler=xxxx` 、 `USB_NUM_BIDIR_ENDPOINTS=x` 以及 `USB_BASE=0xxxxx` 的 CFLAG，如果没有添加则使用 `usb_dc_xxx.c` 中默认配置
- 添加 CherryUSB 源码中使用到的头文件路径
- 拷贝 `usb_config.h` 文件到自己工程目录下，并添加相应的目录头文件路径。所以根目录下的文件仅作为参考，不要添加根目录下的头文件
- 实现 `usb_dc_low_level_init` 函数，该函数主要负责 USB 时钟、引脚、中断的初始化（此函数在对应的 `usb_dc_xxx.c` 中为弱定义）。该函数可以放在你想要放的任何参与编译的 c 文件中。如何进行 USB 的时钟、引脚、中断等初始化，请自行根据你使用的芯片原厂提供的源码中进行添加。
- 描述符的注册、class的注册、接口的注册、端点中断的注册。不会的参考 demo 下的 template
- 调用 `usbd_initialize` 初始化 usb 硬件
@@ -23,12 +24,12 @@ USB Host 移植要点
- 拷贝 CherryUSB 源码到工程里
- 添加 `usbh_core.c`
- 根据自己的需求添加对应 **class** 目录下的文件参与编译，并且添加的文件形似 `usbh_xxx.c`。推荐全部添加，这样可以支持很多 class
- 添加 `usb_hc_xxx.c`，它是芯片所对应的 USB IP hcd 部分驱动，如果不知道自己芯片属于那个 USB IP，参考 **port** 目录下的不同 USB IP 的 readme。如果使用的 USB IP 没有支持，只能自己实现了
- 添加 `USBH_IRQHandler=xxxx` 的 CFLAG，如果没有添加则使用 `usb_hc_xxx.c` 默认配置
- 拷贝一份 `usb_config.h` 文件到自己的工程中，根据实际情况修改主机相关的 CONFIG 宏。CherryUSB 根目录下的为 template，不要使用
- 添加 **osal** 目录下文件，不同 os 只能选择一个
- 添加 CherryUSB 源码中使用到的源文件的对应头文件路径，不要添加CherryUSB 根目录路径
- 根据自己的需求添加 对应 **class** 目录下的文件，并且添加的文件形似 `usbh_xxx.c`。推荐全部添加。
- 添加 `USBH_IRQHandler=xxxx` 、 `USB_BASE=0xxxxx` 的 CFLAG，如果没有添加则使用 `usb_hc_xxx.c` 中默认配置
- 添加 **osal** 目录下文件，根据不同的 os 选择对应的源文件
- 添加 CherryUSB 源码中使用到的头文件路径
- 拷贝 `usb_config.h` 文件到自己工程目录下，并添加相应的目录头文件路径。所以根目录下的文件仅作为参考，不要添加根目录下的头文件
- 实现 `usb_hc_low_level_init` 函数，该函数主要负责 USB 时钟、引脚、中断的初始化（此函数在对应的 `usb_hc_xxx.c` 中为弱定义）。该函数可以放在你想要放的任何参与编译的 c 文件中。如何进行 USB 的时钟、引脚、中断等初始化，请自行根据你使用的芯片原厂提供的源码中进行添加。
- 调用 `usbh_initialize` 初始化 usb 硬件
- 如果使用的是 GCC，需要在链接脚本中添加如下代码：