summaryrefslogtreecommitdiff
path: root/docs/source/demo
diff options
context:
space:
mode:
authorsakumisu <[email protected]>2025-06-24 17:57:39 +0800
committersakumisu <[email protected]>2025-06-24 18:05:08 +0800
commit749cd8531fa29cd0b4a82019ac86fc0be3678ff7 (patch)
tree550717f075421169899499ac2a107444a7406cce /docs/source/demo
parent734cacb177e72f8d8fa21fa3b0f95888a2ed2084 (diff)
docs: update rst
Signed-off-by: sakumisu <[email protected]>
Diffstat (limited to 'docs/source/demo')
-rw-r--r--docs/source/demo/img/cherryadb.pngbin0 -> 42508 bytes
-rw-r--r--docs/source/demo/img/rtt_adb_shell1.pngbin0 -> 67618 bytes
-rw-r--r--docs/source/demo/img/rtt_adb_shell2.pngbin0 -> 508959 bytes
-rw-r--r--docs/source/demo/usbd_adb.rst28
-rw-r--r--docs/source/demo/usbh_msc.rst2
-rw-r--r--docs/source/demo/usbh_net.rst2
-rw-r--r--docs/source/demo/usbh_serial.rst2
7 files changed, 33 insertions, 1 deletions
diff --git a/docs/source/demo/img/cherryadb.png b/docs/source/demo/img/cherryadb.png
new file mode 100644
index 00000000..512586b9
--- /dev/null
+++ b/docs/source/demo/img/cherryadb.png
Binary files differ
diff --git a/docs/source/demo/img/rtt_adb_shell1.png b/docs/source/demo/img/rtt_adb_shell1.png
new file mode 100644
index 00000000..df4964a2
--- /dev/null
+++ b/docs/source/demo/img/rtt_adb_shell1.png
Binary files differ
diff --git a/docs/source/demo/img/rtt_adb_shell2.png b/docs/source/demo/img/rtt_adb_shell2.png
new file mode 100644
index 00000000..88d99a6a
--- /dev/null
+++ b/docs/source/demo/img/rtt_adb_shell2.png
Binary files differ
diff --git a/docs/source/demo/usbd_adb.rst b/docs/source/demo/usbd_adb.rst
new file mode 100644
index 00000000..92a3043e
--- /dev/null
+++ b/docs/source/demo/usbd_adb.rst
@@ -0,0 +1,28 @@
+usbd_adb
+===============
+
+本节主要介绍如何使用 adb device。支持 **cherrysh** 和 rt-thread **msh**,只需要在 main 中添加以下初始化即可。
+
+.. code-block:: C
+
+ cherryadb_init(0, xxxxx);
+
+如果使用 rt-thread,还需要在 menuconfig 中使能 adb device。
+
+.. figure:: img/rtt_adb_shell1.png
+
+进入 adb
+--------------
+
+- 使用 **cherrysh** 时枚举完成以后自动进入 adb 模式
+- 使用 **msh** 需要在 **msh** 中输入 ``adb_enter`` 进入 adb 模式
+
+退出 adb
+--------------
+
+- 使用 **cherrysh** 时输入 ``exit`` 退出 adb 模式
+- 使用 **msh** 需要在 **msh** 中输入 ``adb_exit`` 退出 adb 模式
+
+.. figure:: img/cherryadb.png
+
+.. figure:: img/rtt_adb_shell2.png
diff --git a/docs/source/demo/usbh_msc.rst b/docs/source/demo/usbh_msc.rst
index 7df6ed95..83956cc2 100644
--- a/docs/source/demo/usbh_msc.rst
+++ b/docs/source/demo/usbh_msc.rst
@@ -18,7 +18,7 @@ usbh_msc
- 不使用 fatfs,则直接使用 usbh_msc_scsi_read10 或者 usbh_msc_scsi_write10 函数进行读写操作。
-- 如果使用 fatfs,则需要在 usbh_msc_thread 中调用 fatfs 的接口进行读写操作。msc读写适配fatfs 参考 `platform/none/usbh_fatfs.c`
+- 如果使用 fatfs,则需要在 usbh_msc_thread 中调用 fatfs 的接口进行读写操作。msc读写适配fatfs 参考 `platform/fatfs/usbh_fatfs.c`
.. code-block:: C
diff --git a/docs/source/demo/usbh_net.rst b/docs/source/demo/usbh_net.rst
index 9602dec7..b2656dca 100644
--- a/docs/source/demo/usbh_net.rst
+++ b/docs/source/demo/usbh_net.rst
@@ -104,3 +104,5 @@ TCPIP_THREAD_STACKSIZE 推荐大于 1K,防止栈溢出。
#if TCPIP_THREAD_STACKSIZE < 1024
#error TCPIP_THREAD_STACKSIZE must be >= 1024
#endif
+
+- 具体移植文章可以参考 https://club.rt-thread.org/ask/article/5cf3e9e0b2d95800.html \ No newline at end of file
diff --git a/docs/source/demo/usbh_serial.rst b/docs/source/demo/usbh_serial.rst
index 7b914820..58355cfe 100644
--- a/docs/source/demo/usbh_serial.rst
+++ b/docs/source/demo/usbh_serial.rst
@@ -1,2 +1,4 @@
usbh_serial
===============
+
+当前仅支持 rt-thread device 框架,包括 cdc acm, ftdi, cp210x, ch34x, pl2303, 具体使用方式参考 rt-thread device api 即可。 \ No newline at end of file