芯片通用移植指南

本节主要介绍所有带 USB IP 的芯片，移植 CherryUSB 主从协议栈时的通用步骤和注意事项。在移植之前，需要 你准备好一个可以打印 helloworld 的基本工程 ，默认打印使用 printf, 如果是主机模式， 则需要准备好可以正常执行 os 调度的基本工程。

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_dc_low_level_init 函数（该函数主要负责 USB 时钟、引脚、中断的初始化）。该函数可以放在你想要放的任何参与编译的 c 文件中。如何进行 USB 的时钟、引脚、中断等初始化，请自行根据你使用的芯片原厂提供的源码中进行添加。
描述符的注册、class的注册、接口的注册、端点中断的注册。不会的参考 demo 下的 template
调用 usbd_initialize 并填入 busid 和 USB IP 的 reg base， busid 从 0 开始，不能超过 CONFIG_USBDEV_MAX_BUS
在中断函数中调用 USBD_IRQHandler，并传入 busid, 如果你的 SDK 中中断入口已经存在 USBD_IRQHandler ，请更改 USB 协议栈中的名称
如果芯片带 cache，cache 修改参考 cache 配置修改章节
编译使用。各个 class 如何使用，参考 demo 下的 template

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_IRQHandler，并传入 busid, 如果你的 SDK 中中断入口已经存在 USBH_IRQHandler ，请更改 USB 协议栈中的名称
链接脚本修改参考主机链接脚本修改章节
如果芯片带 cache，cache 修改参考 cache 配置修改章节
编译使用。基础的 cdc + hid + msc 参考 usb_host.c 文件，其余参考 platform 目录下适配

主机链接脚本修改

在使用主机时，如果没有修改链接脚本，会报 __usbh_class_info_start__ 和 __usbh_class_info_end__ 未定义的错误。因为主机协议栈需要在链接脚本中添加一个 section 来存储 class 信息。

如果使用的是 KEIL 无需修改
如果使用的是 GCC ，需要在链接脚本中添加如下代码（需要放在 flash 位置，建议放最后）：

// 在 ld 文件中添加如下代码
. = ALIGN(4);
__usbh_class_info_start__ = .;
KEEP(*(.usbh_class_info))
__usbh_class_info_end__ = .;

GCC 举例如下：

/* The program code and other data into "FLASH" Rom type memory */
.text :
{
. = ALIGN(4);
*(.text)           /* .text sections (code) */
*(.text*)          /* .text* sections (code) */
*(.glue_7)         /* glue arm to thumb code */
*(.glue_7t)        /* glue thumb to arm code */
*(.eh_frame)

KEEP (*(.init))
KEEP (*(.fini))
. = ALIGN(4);
__usbh_class_info_start__ = .;
KEEP(*(.usbh_class_info))
__usbh_class_info_end__ = .;
. = ALIGN(4);
_etext = .;        /* define a global symbols at end of code */
} > FLASH

Segger Embedded Studio 举例如下：

define block cherryusb_usbh_class_info { section .usbh_class_info };

define exported symbol __usbh_class_info_start__  = start of block cherryusb_usbh_class_info;
define exported symbol __usbh_class_info_end__  = end of block cherryusb_usbh_class_info + 1;

place in AXI_SRAM                         { block cherryusb_usbh_class_info };
keep { section .usbh_class_info};

cache 配置修改

对于带 cache 的芯片，协议栈以及 port 中不会对 cache 区域的 ram 进行 clean 或者 invalid，所以需要使用一块非 cache 区域的 ram 来维护。 USB_NOCACHE_RAM_SECTION 宏表示将变量指定到非 cache ram上，默认 USB_NOCACHE_RAM_SECTION 定义为 __attribute__((section(“.noncacheable”)))。因此，用户需要在对应的链接脚本中添加 no cache ram 的 section，并且 section 段包含 .noncacheable。

Note

需要注意，光修改链接脚本中的 nocache section 是不够的，还需要配置该 section 中的 ram 是真的 nocache，一般需要配置 mpu 属性（arm 的参考 stm32h7 demo）。

GCC:

MEMORY
{
RAM    (xrw)    : ORIGIN = 0x20000000,   LENGTH = 256K - 64K
RAM_nocache    (xrw)    : ORIGIN = 0x20030000,   LENGTH = 64K
FLASH    (rx)    : ORIGIN = 0x8000000,   LENGTH = 512K
}

._nocache_ram :
{
. = ALIGN(4);
*(.noncacheable)
} >RAM_nocache

SCT:

LR_IROM1 0x08000000 0x00200000  {    ; load region size_region
ER_IROM1 0x08000000 0x00200000  {  ; load address = execution address
*.o (RESET, +First)
*(InRoot$$Sections)
.ANY (+RO)
.ANY (+XO)
}
RW_IRAM2 0x24000000 0x00070000  {  ; RW data
.ANY (+RW +ZI)
}
USB_NOCACHERAM 0x24070000 0x00010000  {  ; RW data
*(.noncacheable)
}
}

ICF:

define region NONCACHEABLE_RAM = [from 0x1140000 size 256K];
place in NONCACHEABLE_RAM                   { section .noncacheable, section .noncacheable.init, section .noncacheable.bss };  // Noncacheable