From 466d241c31106c538f80548475f33639899b6b28 Mon Sep 17 00:00:00 2001 From: sakumisu <1203593632@qq.com> Date: Fri, 9 Feb 2024 12:21:40 +0800 Subject: [PATCH] update doc --- docs/source/api/api_device.rst | 2 ++ docs/source/api/api_port.rst | 2 ++ docs/source/quick_start/other_chip.rst | 2 ++ docs/source/quick_start/rt-thread/rtthread.rst | 2 ++ 4 files changed, 8 insertions(+) diff --git a/docs/source/api/api_device.rst b/docs/source/api/api_device.rst index adb579b1..b473e61c 100644 --- a/docs/source/api/api_device.rst +++ b/docs/source/api/api_device.rst @@ -10,6 +10,8 @@ CORE ----------------- +.. note:: 请注意，v1.1 版本开始增加 busid 形参，其余保持不变，所以 API 说明不做更新 + 端点结构体 """""""""""""""""""""""""""""""""""" diff --git a/docs/source/api/api_port.rst b/docs/source/api/api_port.rst index 8611ef24..74a4ecb5 100644 --- a/docs/source/api/api_port.rst +++ b/docs/source/api/api_port.rst @@ -1,6 +1,8 @@ Porting ========================= +.. note:: 请注意，v1.1 版本开始增加 busid 形参，其余保持不变，所以 API 说明不做更新 + device controller(dcd) ------------------------- diff --git a/docs/source/quick_start/other_chip.rst b/docs/source/quick_start/other_chip.rst index bddd5375..f17602df 100644 --- a/docs/source/quick_start/other_chip.rst +++ b/docs/source/quick_start/other_chip.rst @@ -12,6 +12,8 @@ USB Device 移植要点 .. note:: 上述三个宏仅对 fsdev、musb、dwc2 有效，因为这 3 个是通用 IP +.. note:: 为了适配后续多 port，建议中断名称不要使用宏来替换，自行在真实的中断中调用 `USBD_IRQHandler` + - 实现 `usb_dc_low_level_init` 函数（该函数主要负责 USB 时钟、引脚、中断的初始化）。该函数可以放在你想要放的任何参与编译的 c 文件中。如何进行 USB 的时钟、引脚、中断等初始化，请自行根据你使用的芯片原厂提供的源码中进行添加。 - 描述符的注册、class的注册、接口的注册、端点中断的注册。不会的参考 demo 下的 template - 调用 `usbd_initialize` 初始化 usb 硬件 diff --git a/docs/source/quick_start/rt-thread/rtthread.rst b/docs/source/quick_start/rt-thread/rtthread.rst index 28a4631f..30fa6e01 100644 --- a/docs/source/quick_start/rt-thread/rtthread.rst +++ b/docs/source/quick_start/rt-thread/rtthread.rst @@ -35,6 +35,8 @@ .. figure:: img/config_file.png +- 在 `usb_config.h` 中添加 `USBD_IRQHandler=xxxx` 、 `CONFIG_USBDEV_EP_NUM=x` 以及 `USBD_BASE=0xxxxx` 三个常规 porting 需要的宏 + * 使用 `scons --target=mdk5` 或者 `scons` 进行编译 主机配置