summaryrefslogtreecommitdiff
path: root/docs/source/quick_start/rt-thread
diff options
context:
space:
mode:
authorsakumisu <[email protected]>2024-05-15 12:10:38 +0800
committersakumisu <[email protected]>2024-05-15 12:10:38 +0800
commitf2133f5ca25da15ae306cb1aa30105ed6630f9fa (patch)
treea8a24e242298c9e500056555aa7f92e14bf7319d /docs/source/quick_start/rt-thread
parent9657585f1f3c1f2a52bcb51381488eeebc545ad8 (diff)
update(docs): update rst
Diffstat (limited to 'docs/source/quick_start/rt-thread')
-rw-r--r--docs/source/quick_start/rt-thread/img/config_file.pngbin33065 -> 0 bytes
-rw-r--r--docs/source/quick_start/rt-thread/img/env0.pngbin44794 -> 17041 bytes
-rw-r--r--docs/source/quick_start/rt-thread/img/env1.pngbin8709 -> 42859 bytes
-rw-r--r--docs/source/quick_start/rt-thread/img/env2.pngbin16250 -> 66915 bytes
-rw-r--r--docs/source/quick_start/rt-thread/img/env3.pngbin11482 -> 0 bytes
-rw-r--r--docs/source/quick_start/rt-thread/img/env4.pngbin14165 -> 0 bytes
-rw-r--r--docs/source/quick_start/rt-thread/img/env5.pngbin12754 -> 0 bytes
-rw-r--r--docs/source/quick_start/rt-thread/img/env6.pngbin3551 -> 0 bytes
-rw-r--r--docs/source/quick_start/rt-thread/img/env7.pngbin17562 -> 0 bytes
-rw-r--r--docs/source/quick_start/rt-thread/img/env8.pngbin18580 -> 0 bytes
-rw-r--r--docs/source/quick_start/rt-thread/rtthread.rst51
11 files changed, 28 insertions, 23 deletions
diff --git a/docs/source/quick_start/rt-thread/img/config_file.png b/docs/source/quick_start/rt-thread/img/config_file.png
deleted file mode 100644
index fd369f37..00000000
--- a/docs/source/quick_start/rt-thread/img/config_file.png
+++ /dev/null
Binary files differ
diff --git a/docs/source/quick_start/rt-thread/img/env0.png b/docs/source/quick_start/rt-thread/img/env0.png
index bb9e8e19..c0a8b03f 100644
--- a/docs/source/quick_start/rt-thread/img/env0.png
+++ b/docs/source/quick_start/rt-thread/img/env0.png
Binary files differ
diff --git a/docs/source/quick_start/rt-thread/img/env1.png b/docs/source/quick_start/rt-thread/img/env1.png
index d232a408..2a68e052 100644
--- a/docs/source/quick_start/rt-thread/img/env1.png
+++ b/docs/source/quick_start/rt-thread/img/env1.png
Binary files differ
diff --git a/docs/source/quick_start/rt-thread/img/env2.png b/docs/source/quick_start/rt-thread/img/env2.png
index 48657413..ee37101a 100644
--- a/docs/source/quick_start/rt-thread/img/env2.png
+++ b/docs/source/quick_start/rt-thread/img/env2.png
Binary files differ
diff --git a/docs/source/quick_start/rt-thread/img/env3.png b/docs/source/quick_start/rt-thread/img/env3.png
deleted file mode 100644
index ed55056b..00000000
--- a/docs/source/quick_start/rt-thread/img/env3.png
+++ /dev/null
Binary files differ
diff --git a/docs/source/quick_start/rt-thread/img/env4.png b/docs/source/quick_start/rt-thread/img/env4.png
deleted file mode 100644
index 36c4e53c..00000000
--- a/docs/source/quick_start/rt-thread/img/env4.png
+++ /dev/null
Binary files differ
diff --git a/docs/source/quick_start/rt-thread/img/env5.png b/docs/source/quick_start/rt-thread/img/env5.png
deleted file mode 100644
index 85de879a..00000000
--- a/docs/source/quick_start/rt-thread/img/env5.png
+++ /dev/null
Binary files differ
diff --git a/docs/source/quick_start/rt-thread/img/env6.png b/docs/source/quick_start/rt-thread/img/env6.png
deleted file mode 100644
index 20a57d07..00000000
--- a/docs/source/quick_start/rt-thread/img/env6.png
+++ /dev/null
Binary files differ
diff --git a/docs/source/quick_start/rt-thread/img/env7.png b/docs/source/quick_start/rt-thread/img/env7.png
deleted file mode 100644
index dc63bebd..00000000
--- a/docs/source/quick_start/rt-thread/img/env7.png
+++ /dev/null
Binary files differ
diff --git a/docs/source/quick_start/rt-thread/img/env8.png b/docs/source/quick_start/rt-thread/img/env8.png
deleted file mode 100644
index c2e31f9a..00000000
--- a/docs/source/quick_start/rt-thread/img/env8.png
+++ /dev/null
Binary files differ
diff --git a/docs/source/quick_start/rt-thread/rtthread.rst b/docs/source/quick_start/rt-thread/rtthread.rst
index 69db0db4..b69b95fe 100644
--- a/docs/source/quick_start/rt-thread/rtthread.rst
+++ b/docs/source/quick_start/rt-thread/rtthread.rst
@@ -9,31 +9,28 @@
--------------------------
* 选择 Enable usb device mode 并敲回车进入。
-
-.. figure:: img/env1.png
-.. figure:: img/env2.png
-
-* 首先第一个配置是配置 USB 的速度,分为 **FS、HS**,表示使用全速还是高速功能。
-
-.. figure:: img/env3.png
-
+* 首先第一个配置是配置 USB 的速度,分为 **FS、HS**,表示使用全速还是高速功能。高速功能要求内置高速 PHY 或者外接 PHY
* 其次第二个配置则是选择 USB device ip,不清楚自己芯片是哪个 ip 的可以参考 **port** 目录下对应的 readme。
+* 选择你想使用的 class
+* 选择是否使用 demo 模板
-.. figure:: img/env4.png
+.. figure:: img/env1.png
-* 选择好 USB device ip 以后,还需要选择是哪款芯片,第三个配置则是用来选择芯片,选择以后会配置相应的 ip 的一些信息和 glue 文件
+* 最后退出保存即可。
+* 拷贝 `cherryusb_config_template.h` 文件到自己工程目录下,命名为 `usb_config.h`,并添加相应的目录头文件路径,并修改以下内容:
-.. figure:: img/env5.png
+.. code-block:: C
-* 接下来是 class 的选择,用哪个 class 勾选哪个就可以了,使能 class 以后,双击进入可以选择一个 demo 的模板参与编译,当然也可以不选,自己写。
+ #include "rtthread.h"
-.. figure:: img/env6.png
+ #define CONFIG_USB_PRINTF(...) rt_kprintf(__VA_ARGS__)
-* 最后退出保存即可。
-* 拷贝 `cherryusb_config_template.h` 文件到自己工程目录下,命名为 `usb_config.h`,并添加相应的目录头文件路径,并实现以下内容:
+ #define usb_malloc(size) rt_malloc(size)
+ #define usb_free(ptr) rt_free(ptr)
-.. figure:: img/config_file.png
+ #define memcpy rt_memcpy
+* USB IP 相关的 config 需要用户自己根据芯片实际情况修改
* 退出以后不急着编译,需要在代码中实现 `usb_dc_low_level_init` 函数。
* 调用 `usbd_initialize` 并填入 `busid` 和 USB IP 的 `reg base`, `busid` 从 0 开始,不能超过 `CONFIG_USBDEV_MAX_BUS`
* 以上内容我们推荐放在 **board.c** 中,如下代码:
@@ -60,19 +57,27 @@
--------------------------
* 选择 Enable usb host mode 并敲回车进入。
+* 选择 USB host ip,不清楚自己芯片是哪个 ip 的可以参考 **port** 目录下对应的 readme。
+* 根据需要勾选 class 驱动
+* 选择是否开启模板 demo,请注意, msc 禁止使能,因为默认对接到 dfs。
-.. figure:: img/env7.png
-
-* 选择 USB host ip,不清楚自己芯片是哪个 ip 的可以参考 **port** 目录下对应的 readme。选择好 USB host ip 以后,还需要选择是哪款芯片,第二个箭头则是用来选择芯片,选择以后会帮忙配置相对应的 ip 的一些信息,比如 `USB_BASE` 、 `USBH_Handler` 以及特殊的一些配置等等,如果没找到自己的芯片,可以手动在 `usb_hc_xxx.c` 中修改。
-
-.. figure:: img/env8.png
+.. figure:: img/env2.png
-* 根据需要勾选 class 驱动
* 最后退出保存即可。
* 拷贝 `cherryusb_config_template.h` 文件到自己工程目录下,命名为 `usb_config.h`,并添加相应的目录头文件路径,并实现以下内容:
-.. figure:: img/config_file.png
+.. code-block:: C
+
+ #include "rtthread.h"
+
+ #define CONFIG_USB_PRINTF(...) rt_kprintf(__VA_ARGS__)
+
+ #define usb_malloc(size) rt_malloc(size)
+ #define usb_free(ptr) rt_free(ptr)
+
+ #define memcpy rt_memcpy
+* USB IP 相关的 config 需要用户自己根据芯片实际情况修改
* 在代码中实现 `usb_hc_low_level_init` 函数
* 调用 `usbh_initialize` 并填入 `busid` 和 USB IP 的 `reg base`, `busid` 从 0 开始,不能超过 `CONFIG_USBHOST_MAX_BUS`
* 以上内容我们推荐放在 **board.c** 中,如下代码: