add rt-thread userguide

6 files changed, 144 insertions, 0 deletions

diff --git a/docs/img/rtt_cdc_demo.png b/docs/img/rtt_cdc_demo.png
new file mode 100644
index 00000000..861669e1
--- /dev/null
+++ b/docs/img/rtt_cdc_demo.png
diff --git a/docs/img/stm32cubemx.png b/docs/img/stm32cubemx.png
new file mode 100644
index 00000000..a6ca5078
--- /dev/null
+++ b/docs/img/stm32cubemx.png
diff --git a/docs/img/stm32cubemx_clk.png b/docs/img/stm32cubemx_clk.png
new file mode 100644
index 00000000..41a7aae8
--- /dev/null
+++ b/docs/img/stm32cubemx_clk.png
diff --git a/docs/rt-thread.md b/docs/rt-thread.md
new file mode 100644
index 00000000..ce00a0d0
--- /dev/null
+++ b/docs/rt-thread.md
@@ -0,0 +1,72 @@
+# RT-Thread package Userguide with usb stack
+
+[中文版](rt-thread_zh.md)
+
+To use usb stack package, you need to select it in the RT-Thread package manager. The specific path is as follows:
+
+```
+-> RT-Thread online packages
+    -> system packages
+        --- USB Stack: tiny and portable USB stack for embedded system with USB IP
+
+            USB STACK Options  ---->
+                    [ ] Enable usb high speed mode
+                    [*] Enable usb device mode
+                    [*]   Enable usb cdc acm device
+                    [ ]   Enable usb hid device
+                    [ ]   Enable usb dfu device
+                    [ ]   Enable usb msc device
+                    [ ]   Enable usb hub device
+                    [ ]   Enable usb audio device
+                    [ ]   Enable usb video device
+
+            Version (latest)  --->
+```
+
+## How to use
+
+### In STM32
+
+Please note that stm32 series have two usb ip. For usb ip, like stm32f0、stm32f1、stm32f3, for usb otg ip(as we know it is from **DesignWare**),like stm32f4、stm32f7 and so on.
+Currently,if you usb usb device on mcu with usb ip, recommend you to use dcd porting named **usb_dc_nohal.c**,otherwise use **usb_dc_hal.c**.In the future,**usb_dc_hal.c** will be droped.
+
+#### Use USB Device
+
+- Firstly,you should have a bsp project,and then go to `board\CubeMX_Config` directory, open file that suffix name with `.ioc` in **STM32CubeMX**.
+- Enable **USB** or **USB_OTG_FS** or **USB_OTG_HS** in **Connectivity** List,enable USB IRQ in **NVIC Setting**.
+
+![STM32CubeMX USB setting](img/stm32cubemx.png)
+
+- Enable USB Clock for 48Mhz in **Clock configuration**.
+
+![STM32CubeMX USB clock](img/stm32cubemx_clk.png)
+
+- Generate code.
+- Copy **SystemClock_Config** into **board.c**.
+- Copy **MX_USB_OTG_FS_PCD_Init** or **MX_USB_OTG_HS_PCD_Init** into **main.c** if you use **usb_dc_hal.c**.Also, USB Irq from **it.c** needs the same.
+- Implement **printf** or modify with **rt_kprintf** in **usb_utils.h**, usb stack needs.
+- Now we can call some functions provided by **usb_stack**.Your should register descriptors、interfaces and endpoint callback firstly, and then call `usb_dc_init`. Example is as follows:
+
+```
+int main(void)
+{
+    extern void cdc_init(void);
+    cdc_init();
+    extern void usb_dc_init(void);
+    usb_dc_init();
+    while (1)
+    {
+        rt_thread_mdelay(500);
+    }
+}
+```
+
+- How to register class you can go to [stm32 class examples](https://github.com/sakumisu/usb_stack/tree/master/demo/stm32/stm32f103c8t6/example) for a reference.
+
+#### CDC Demo Demonstration
+
+![CDC Demo](img/rtt_cdc_demo.png)
+
+#### Video manual
+
+If you have problem from steps above, you can see this video：[Use USB Stack in RT-Thread package manager](https://www.bilibili.com/video/BV1Ef4y1t73d?p=26)。
\ No newline at end of file
diff --git a/docs/rt-thread_zh.md b/docs/rt-thread_zh.md
new file mode 100644
index 00000000..2b5005b8
--- /dev/null
+++ b/docs/rt-thread_zh.md
@@ -0,0 +1,71 @@
+# USB Stack 在 RT-Thread package 中的使用
+
+[English Version](rt-thread.md)
+
+使用 USB Stack package 需要在 RT-Thread 的包管理器中选择它，具体路径如下：
+
+```
+-> RT-Thread online packages
+    -> system packages
+        ---  USB Stack: tiny and portable USB stack for embedded system with USB IP
+
+            USB STACK Options  ---->
+                    [ ] Enable usb high speed mode
+                    [*] Enable usb device mode
+                    [*]   Enable usb cdc acm device
+                    [ ]   Enable usb hid device
+                    [ ]   Enable usb dfu device
+                    [ ]   Enable usb msc device
+                    [ ]   Enable usb hub device
+                    [ ]   Enable usb audio device
+                    [ ]   Enable usb video device
+
+            Version (latest)  --->
+```
+
+## 使用 USB Stack
+
+### 在 STM32 平台
+
+STM32 系列单片机有两种 USB IP,分别是 USB IP 和 USB OTG IP。其中 USB IP，例如 STM32F0、STM32F1、STM32F3等等，USB OTG IP(我们都知道用的是 **DesignWare** 公司的)的有 STM32F4、STM32F7、STM32H7等等。当前如果你需要使用 USB Device 功能，porting 接口提供了两种，一种是不带 hal 层的 **usb_dc_nohal.c**，一种是带 hal 层的 **usb_dc_hal.c**,如果你使用的是 USB IP系列，推荐用前者，否则用后者，需要注意的是后者在后面会删除，不使用 hal 版本。
+
+#### 使用 USB Device 功能
+
+- 首先，你需要有一个 bsp 工程，之后进入到 `board\CubeMX_Config` 目录下，使用 **STM32CubeMX** 打开后缀名为 `.ioc` 的文件。
+- 进入 **Connectivity** 选项，选择 **USB** 或者 **USB_OTG_FS** 或者 **USB_OTG_HS**，并使能 device 功能，在 **NVIC Setting** 中开启 USB 中断。
+
+![STM32CubeMX USB setting](img/stm32cubemx.png)
+
+- 在 **Clock configuration** 栏配置 USB 时钟为 48Mhz.
+
+![STM32CubeMX USB clock](img/stm32cubemx_clk.png)
+
+- 点击 **Generate code**。
+- 复制 **SystemClock_Config** 函数内容到 **board.c** 中。
+- 如果你使用的是 hal 版本，需要复制 **MX_USB_OTG_FS_PCD_Init** 或者 **MX_USB_OTG_HS_PCD_Init** 到你的应用程序中，比如 **main.c**，并且还需要从 **it.c** 中复制中断函数。
+- 实现 **printf** 函数或者将 **usb_utils.h** 中的 **printf** 改成 **rt_kprintf**，并添加 `#include <rtthread.h>`
+- 现在我们可以调用 USB Stack 中的函数来注册描述符、接口、端点中断，并调用 `usb_dc_init`，示例如下：
+
+```
+int main(void)
+{
+    extern void cdc_init(void);
+    cdc_init();
+    extern void usb_dc_init(void);
+    usb_dc_init();
+    while (1)
+    {
+        rt_thread_mdelay(500);
+    }
+}
+```
+
+- 关于如何注册 class 类可以参考 [stm32 class examples](https://github.com/sakumisu/usb_stack/tree/master/demo/stm32/stm32f103c8t6/example)。
+
+#### CDC demo 演示
+
+![CDC Demo](img/rtt_cdc_demo.png)
+
+#### 视频教程
+
+如果对上述步骤还有问题，可以参考 [协议栈在 RT-Thread 包管理器中的使用](https://www.bilibili.com/video/BV1Ef4y1t73d?p=26)。
\ No newline at end of file
diff --git a/docs/usb_host.md b/docs/usb_host.md
new file mode 100644
index 00000000..2d245c7f
--- /dev/null
+++ b/docs/usb_host.md
@@ -0,0 +1 @@
+# USB STACK API For host
\ No newline at end of file