summaryrefslogtreecommitdiff
path: root/docs/source/demo
diff options
context:
space:
mode:
authorsakumisu <[email protected]>2026-01-27 19:51:29 +0800
committersakumisu <[email protected]>2026-01-28 13:15:53 +0800
commit76b3720445f5b2396f3cd7dfdbecc277cafc76e7 (patch)
tree5b733185d1602f054b48463d803200a68cc03bb2 /docs/source/demo
parentbad94dfc670f5215c1a9abb80af5970fe592af39 (diff)
docs: release v1.6.0v1.6.0
Signed-off-by: sakumisu <[email protected]>
Diffstat (limited to 'docs/source/demo')
-rw-r--r--docs/source/demo/usbh_serial.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/source/demo/usbh_serial.rst b/docs/source/demo/usbh_serial.rst
index 3e06561a..619545c6 100644
--- a/docs/source/demo/usbh_serial.rst
+++ b/docs/source/demo/usbh_serial.rst
@@ -87,15 +87,17 @@ Serial 框架当前支持 cdc acm, ftdi, cp210x, ch34x, pl2303,gsm 驱动。
usbh_serial_close(serial);
-.. note:: 需要注意,例程中使用的是比较简单的先发送后读取的方式,因此发送的总长度不可以超过 CONFIG_USBHOST_SERIAL_RX_SIZE,正常使用 TX/RX 请分开进行。
+.. caution:: 需要注意,例程中使用的是比较简单的先发送后读取的方式,因此发送的总长度不可以超过 CONFIG_USBHOST_SERIAL_RX_SIZE,正常使用 TX/RX 请分开进行。
用户需要考虑以下三种场景:
-- USB2TTL 设备 + 启用了波特率,这种情况下需要使用 `usbh_serial_write` 和 `usbh_serial_read` 进行收发数据, **并且 read 操作需要及时,防止 ringbuf 数据溢出而丢包**;
+- USB2TTL 设备 + 启用了波特率(USB2TTL设备必须启用波特率),这种情况下需要使用 `usbh_serial_write` 和 `usbh_serial_read` 进行收发数据, **并且 read 操作需要及时,防止 ringbuf 数据溢出而丢包**。不可以使用 `usbh_serial_cdc_write_async` 和 `usbh_serial_cdc_read_async`
- 纯 USB 设备 + 未启动波特率,这种情况下可以使用 `usbh_serial_cdc_write_async` 和 `usbh_serial_cdc_read_async` 进行异步收发数据。阻塞则可以用 `usbh_serial_write` ,不可以使用 `usbh_serial_read`。
-- 纯 USB 设备 + 启动波特率,同 1,但是速率打折扣(因为多了一层 ringbuf)。此时也不可以使用 `usbh_serial_cdc_write_async` 和 `usbh_serial_cdc_read_async`。 **如果是 GSM 设备请使用第一种场景**。
+- 纯 USB 设备 + 启动波特率,同 1,但是接收速率会打折扣(因为多了一层 ringbuf)。此时也不可以使用 `usbh_serial_cdc_write_async` 和 `usbh_serial_cdc_read_async`。 **如果是 GSM 设备请使用第一种场景**。
+
+.. note:: 简单来说就是,如果接收数据需要用到ringbuf转一层的,请使用第一种场景。
.. code-block:: C