docs: update rst

Signed-off-by: sakumisu <[email protected]>

Author: sakumisu

docs/source/api/api_device.rst

@@ -7,6 +7,10 @@
 - 有多少个接口就调用多少次 `usbd_add_interface`，参数填相关 `xxx_init_intf`, 如果没有支持的，手动创建一个 intf 填入
 - 有多少个端点就调用多少次 `usbd_add_endpoint`，当中断完成时，会调用到注册的端点回调中。
 
+参考下面这张图：
+
+.. figure:: img/api_device1.png
+
 CORE
 -----------------
 

docs/source/api/api_host.rst

@@ -15,12 +15,11 @@ CLASS 驱动信息结构体
 .. code-block:: C
 
     struct usbh_class_info {
-        uint8_t match_flags; /* Used for product specific matches; range is inclusive */
-        uint8_t class;       /* Base device class code */
-        uint8_t subclass;    /* Sub-class, depends on base class. Eg. */
-        uint8_t protocol;    /* Protocol, depends on base class. Eg. */
-        uint16_t vid;        /* Vendor ID (for vendor/product specific devices) */
-        uint16_t pid;        /* Product ID (for vendor/product specific devices) */
+        uint8_t match_flags;           /* Used for product specific matches; range is inclusive */
+        uint8_t bInterfaceClass;       /* Base device class code */
+        uint8_t bInterfaceSubClass;    /* Sub-class, depends on base class. Eg. */
+        uint8_t bInterfaceProtocol;    /* Protocol, depends on base class. Eg. */
+        const uint16_t (*id_table)[2]; /* List of Vendor/Product ID pairs */
         const struct usbh_class_driver *class_driver;
     };
 

demo/adb/cherryadb.png renamed to docs/source/demo/img/cherryadb.png

@@ -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

docs/source/demo/img/rtt_adb_shell1.png

@@ -107,6 +107,7 @@ CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统的
    demo/usbd_video
    demo/usbd_winusb
    demo/usbd_webusb
+   demo/usbd_adb
    demo/usbh_serial
    demo/usbh_hid
    demo/usbh_msc

docs/source/demo/img/rtt_adb_shell2.png

@@ -53,10 +53,10 @@
 主机配置
 --------------------------
 
-* 选择 Enable usb host mode 并敲回车进入。
-* 选择 USB host ip，不清楚自己芯片是哪个 ip 的可以参考 **port** 目录下对应的 readme。
+* 选择 Enable usb host mode 并敲回车进入
+* 选择 USB host ip，不清楚自己芯片是哪个 ip 的可以参考 **port** 目录下对应的 readme
 * 根据需要勾选 class 驱动
-* 选择是否开启模板 demo，请注意， msc 禁止使能，因为默认对接到 dfs。
+* 选择是否开启模板 demo，推荐不用
 
 .. figure:: img/env2.png
 
@@ -71,25 +71,8 @@
 
 * USB IP 相关的 config 需要用户自己根据芯片实际情况修改
 * 在代码中实现 `usb_hc_low_level_init` 函数
+* 在中断函数中调用 `USBH_IRQHandler`，并传入 `busid`
 * 调用 `usbh_initialize` 并填入 `busid` 和 USB IP 的 `reg base`， `busid` 从 0 开始，不能超过 `CONFIG_USBHOST_MAX_BUS`
-* 以上内容我们推荐放在 **board.c** 中，如下代码：
-
-.. code-block:: C
-
-        void OTG_HS_IRQHandler(void)
-        {
-        extern void USBH_IRQHandler(uint8_t busid);
-        USBH_IRQHandler(0);
-        }
-
-        int usbh_init(void)
-        {
-        usbh_initialize(0, USB_OTG_HS_PERIPH_BASE);
-        return 0;
-        }
-
-        INIT_APP_EXPORT(usbh_init);
-
 * 使用 `scons --target=mdk5` 或者 `scons` 进行编译，如果是mdk，需要使用 AC6 编译器
 * 如果使用的是 GCC ，需要在链接脚本(需要放在 flash 位置)中添加如下代码：
 
@@ -124,24 +107,4 @@
         __usbh_class_info_end__ = .;
         . = ALIGN(4);
         _etext = .;        /* define a global symbols at end of code */
-        } > FLASH
-
-借助 STM32CubeMX 生成 USB 初始化
-----------------------------------
-
-使用 STM32CubeMX 主要是用来生成 usb 时钟、引脚、中断的配置。我们需要点击如图所示文件，并配置好 USB 的时钟、中断，点击 `Generate Code`。
-
-.. figure:: img/stm32cubemx0.png
-.. figure:: img/stm32cubemx1.png
-.. figure:: img/stm32cubemx2.png
-.. figure:: img/stm32cubemx_clk.png
-
-- 将 `main.c` 中的 `SystemClock_Config` 替换掉 `board.c` 中的配置
-
-.. figure:: img/stm32_init2.png
-
-.. note :: 下面步骤从 V1.5.0 开始不再需要，**fsdev/usb_glue_st.c**, **dwc2/usb_glue_st.c** 文件中已经实现
-
-- 将 `stm32xxxx_hal_msp.c` 中的 `HAL_PCD_MspInit` 或者是 `HAL_HCD_MspInit` 中的内容复制到 `usb_dc_low_level_init` 和 `usb_hc_low_level_init` 函数中，举例如下：
-
-.. figure:: img/stm32_init.png
+        } > FLASH