update doc

1 files changed, 116 insertions, 0 deletions

diff --git a/docs/source/api/api_config.rst b/docs/source/api/api_config.rst
new file mode 100644
index 00000000..d7754fd0
--- /dev/null
+++ b/docs/source/api/api_config.rst
@@ -0,0 +1,116 @@
+USB CONFIG 宏
+=========================
+
+
+设备相关 CONFIG  宏
+---------------------
+
+.. code-block:: C
+
+    /* USB DEVICE Configuration */
+    /* core */
+    #ifndef CONFIG_USBDEV_REQUEST_BUFFER_LEN
+    #define CONFIG_USBDEV_REQUEST_BUFFER_LEN 256
+    #endif
+
+    #ifndef CONFIG_USBDEV_DESC_CHECK
+    #define CONFIG_USBDEV_DESC_CHECK 0
+    #endif
+
+    #ifndef CONFIG_USBDEV_TEST_MODE
+    #define CONFIG_USBDEV_TEST_MODE 0
+    #endif
+
+    /* msc class */
+    #ifndef CONFIG_USBDEV_MSC_MANUFACTURER_STRING
+    #define CONFIG_USBDEV_MSC_MANUFACTURER_STRING ""
+    #endif
+
+    #ifndef CONFIG_USBDEV_MSC_PRODUCT_STRING
+    #define CONFIG_USBDEV_MSC_PRODUCT_STRING ""
+    #endif
+
+    #ifndef CONFIG_USBDEV_MSC_VERSION_STRING
+    #define CONFIG_USBDEV_MSC_VERSION_STRING "0.01"
+    #endif
+
+    /* audio class */
+    #ifndef CONFIG_USBDEV_AUDIO_VERSION
+    #define CONFIG_USBDEV_AUDIO_VERSION 0x0100
+    #endif
+
+    #ifndef CONFIG_USBDEV_AUDIO_MAX_CHANNEL
+    #define CONFIG_USBDEV_AUDIO_MAX_CHANNEL 2
+    #endif
+
+
+主机相关 CONFIG  宏
+---------------------
+
+.. code-block:: C
+
+    /* USB HOST Configuration */
+    #ifndef CONFIG_USBHOST_RHPORTS
+    #define CONFIG_USBHOST_RHPORTS 1
+    #endif
+
+    #ifndef CONFIG_USBHOST_EHPORTS
+    #define CONFIG_USBHOST_EHPORTS 4
+    #endif
+
+    #ifndef CONFIG_USBHOST_PIPE_NUM
+    #define CONFIG_USBHOST_PIPE_NUM 10
+    #endif
+
+    #ifndef CONFIG_USBHOST_INTF_NUM
+    #define CONFIG_USBHOST_INTF_NUM 6
+    #endif
+
+    #ifndef CONFIG_USBHOST_EP_NUM
+    #define CONFIG_USBHOST_EP_NUM 4
+    #endif
+
+    #ifndef CONFIG_USBHOST_CONTROL_TRANSFER_TIMEOUT
+    #define CONFIG_USBHOST_CONTROL_TRANSFER_TIMEOUT 5000
+    #endif
+
+    #ifndef CONFIG_USBHOST_MSC_TIMEOUT
+    #define CONFIG_USBHOST_MSC_TIMEOUT 5000
+    #endif
+
+    #ifndef CONFIG_USBHOST_HPWORKQ_PRIO
+    #define CONFIG_USBHOST_HPWORKQ_PRIO 5
+    #endif
+    #ifndef CONFIG_USBHOST_HPWORKQ_STACKSIZE
+    #define CONFIG_USBHOST_HPWORKQ_STACKSIZE 2048
+    #endif
+
+    #ifndef CONFIG_USBHOST_LPWORKQ_PRIO
+    #define CONFIG_USBHOST_LPWORKQ_PRIO 1
+    #endif
+    #ifndef CONFIG_USBHOST_LPWORKQ_STACKSIZE
+    #define CONFIG_USBHOST_LPWORKQ_STACKSIZE 2048
+    #endif
+
+    #ifndef CONFIG_USBHOST_PSC_PRIO
+    #define CONFIG_USBHOST_PSC_PRIO 4
+    #endif
+    #ifndef CONFIG_USBHOST_PSC_STACKSIZE
+    #define CONFIG_USBHOST_PSC_STACKSIZE 4096
+    #endif
+
+    #ifndef CONFIG_USBHOST_DEV_NAMELEN
+    #define CONFIG_USBHOST_DEV_NAMELEN 16
+    #endif
+
+    #define CONFIG_USBHOST_ASYNCH
+    //#define CONFIG_USBHOST_GET_STRING_DESC
+
+    /* EHCI Configuration */
+    #define CONFIG_USB_EHCI_HCCR_BASE (0x20072000)
+    #define CONFIG_USB_EHCI_HCOR_BASE (0x20072000 + 0x10)
+    #define CONFIG_USB_EHCI_QH_NUM    (10)
+    #define CONFIG_USB_EHCI_QTD_NUM   (10)
+    // #define CONFIG_USB_EHCI_INFO_ENABLE
+    #define CONFIG_USB_ECHI_HCOR_RESERVED_DISABLE
+    // #define CONFIG_USB_EHCI_CONFIGFLAG
\ No newline at end of file