From 1bd423cef9a0183c601c3e30a9676c52abe9518d Mon Sep 17 00:00:00 2001 From: sakimisu <1203593632@qq.com> Date: Sun, 4 Dec 2022 14:25:59 +0800 Subject: update rst --- docs/source/quick_start/bl702.rst | 4 ++-- docs/source/quick_start/hpm.rst | 6 ++++++ docs/source/quick_start/other_chip.rst | 8 ++++---- docs/source/quick_start/rt-thread/rtthread.rst | 6 +----- docs/source/quick_start/stm32.rst | 2 +- 5 files changed, 14 insertions(+), 12 deletions(-) create mode 100644 docs/source/quick_start/hpm.rst (limited to 'docs/source/quick_start') diff --git a/docs/source/quick_start/bl702.rst b/docs/source/quick_start/bl702.rst index c7f11bbc..1ae1f8fa 100644 --- a/docs/source/quick_start/bl702.rst +++ b/docs/source/quick_start/bl702.rst @@ -1,6 +1,6 @@ 基于 BL 系列开发指南 ========================= -BL 系列 USB 的开发主要使用 bl_mcu_sdk，关于 bl_mcu_sdk 的环境搭建，参考 `bl_mcu_sdk 环境搭建 `_。 +BL 系列 USB 的开发主要使用 bl_mcu_sdk，参考 `bl_mcu_sdk `_。 -USB 的相关应用位于 `examples/usb` 目录下，环境搭建完成后，即可编译使用。 \ No newline at end of file +USB 的相关应用位于 `examples/usbdev` 和 `examples/usbhost` 目录下，环境搭建完成后，即可编译使用。 \ No newline at end of file diff --git a/docs/source/quick_start/hpm.rst b/docs/source/quick_start/hpm.rst new file mode 100644 index 00000000..21c41278 --- /dev/null +++ b/docs/source/quick_start/hpm.rst @@ -0,0 +1,6 @@ +基于 HPM 系列开发指南 +========================= + +HPM 系列 USB 的开发主要使用 hpm_sdk ，参考 `hpm sdk `_。 + +USB 的相关应用位于 `samples/cherryusb` 目录下，环境搭建完成后，即可编译使用。 \ No newline at end of file diff --git a/docs/source/quick_start/other_chip.rst b/docs/source/quick_start/other_chip.rst index e76ce36d..79075c85 100644 --- a/docs/source/quick_start/other_chip.rst +++ b/docs/source/quick_start/other_chip.rst @@ -38,12 +38,12 @@ USB Host 移植要点 .. code-block:: C - define region CHERRYUSB_RAM = [from 0x1080000 + 700k size 68k]; /* reserve for cherryusb region */ + define block cherryusb_usbh_class_info { section .usbh_class_info }; - define exported symbol __usbh_class_info_start__ = start of region CHERRYUSB_RAM; - define exported symbol __usbh_class_info_end__ = end of region CHERRYUSB_RAM + 1; + 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 CHERRYUSB_RAM { section .usbh_class_info }; + place in AXI_SRAM { block cherryusb_usbh_class_info }; keep { section .usbh_class_info}; - 编译使用。各个 class 如何使用，参考 demo 下的 `usb_host.c` 文件 diff --git a/docs/source/quick_start/rt-thread/rtthread.rst b/docs/source/quick_start/rt-thread/rtthread.rst index 784611b5..cf0546e0 100644 --- a/docs/source/quick_start/rt-thread/rtthread.rst +++ b/docs/source/quick_start/rt-thread/rtthread.rst @@ -84,8 +84,4 @@ 其次将 `main.c` 中的 `SystemClock_Config` 替换掉 `board.c` 中的配置 -.. figure:: img/stm32_init2.png - -其他小伙伴的移植笔记 -------------------------- -- @kylongmu `stm32h743-st-nucleo移植CherryUSB- CDC串口 `_。 +.. figure:: img/stm32_init2.png \ No newline at end of file diff --git a/docs/source/quick_start/stm32.rst b/docs/source/quick_start/stm32.rst index 56fb13f4..7e5caf6d 100644 --- a/docs/source/quick_start/stm32.rst +++ b/docs/source/quick_start/stm32.rst @@ -34,7 +34,7 @@ } -.. note :: 如果使用 STM32F7 或者 STM32H7, 请在 CFLAG 中添加 STM32F7 或者 STM32H7 宏定义，否则无法枚举 +.. caution :: 如果使用 STM32F7 或者 STM32H7, 请在 CFLAG 中添加 STM32F7 或者 STM32H7 宏定义，否则无法枚举 工程样例试用 ----------------------- -- cgit v1.3.1