summaryrefslogtreecommitdiff
path: root/docs/source/api
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/api
parent734cacb177e72f8d8fa21fa3b0f95888a2ed2084 (diff)
docs: update rst
Signed-off-by: sakumisu <[email protected]>
Diffstat (limited to 'docs/source/api')
-rw-r--r--docs/source/api/api_device.rst4
-rw-r--r--docs/source/api/api_host.rst11
2 files changed, 9 insertions, 6 deletions
diff --git a/docs/source/api/api_device.rst b/docs/source/api/api_device.rst
index 49502c15..29c2b438 100644
--- a/docs/source/api/api_device.rst
+++ b/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
-----------------
diff --git a/docs/source/api/api_host.rst b/docs/source/api/api_host.rst
index 9d77441c..3368f47f 100644
--- a/docs/source/api/api_host.rst
+++ b/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;
};