From 75c4b1f0bcfff8689bed16b7eb4bef9d9e5e958f Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Wed, 28 Jun 2023 16:15:28 +0800 Subject: [PATCH] usb: fixed docs linking to deleted examples --- docs/en/api-reference/peripherals/usb_host.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/en/api-reference/peripherals/usb_host.rst b/docs/en/api-reference/peripherals/usb_host.rst index 076203c239..519a3e8fb8 100644 --- a/docs/en/api-reference/peripherals/usb_host.rst +++ b/docs/en/api-reference/peripherals/usb_host.rst @@ -169,7 +169,7 @@ With reference the graph above, the typical lifecycle involves the following key 2. Once the Host Library is installed, the clients can be registered by calling :cpp:func:`usb_host_client_register`. - This is typically called from the client task (where the client task waits for a signal from the Daemon Task). - This can be called elsewhere if necessary as long it is called after :cpp:func:`usb_host_install`. -3. Device 1 connects and is then enumerated. +3. Device 1 connects and is then enumerated. - Each registered client (in this case Client 1 and Client 2) are notified of the new device by way of the :cpp:enumerator:`USB_HOST_CLIENT_EVENT_NEW_DEV` event. - Client 1 opens Device 1 and begins communication with it. 4. Similarly Device 2 connects and is enumerated. @@ -365,9 +365,10 @@ The USB Host Stack provides a number examples that implement host class drivers CDC-ACM """"""" -* A host class driver for the Communication Device Class (Abstract Control Model) is currently implemented as an example component (found via :example:`peripherals/usb/host/cdc/common/cdc_acm_host`). +* A host class driver for the Communication Device Class (Abstract Control Model) is deployed to `IDF component registry `__. * The :example:`peripherals/usb/host/cdc/cdc_acm_host` example uses the CDC-ACM host driver component to communicate with CDC-ACM devices -* The :example:`peripherals/usb/host/cdc/cdc_acm_bg96` example uses the CDC-ACM host driver component to communicate with non-compliant CDC-ACM devices (i.e., vendor-specific classes that support a subset of CDC-ACM features) such as the Quectel BG96 modem. +* The :example:`peripherals/usb/host/cdc/cdc_acm_vcp` example shows how can you extend the CDC-ACM host driver to interface Virtual COM Port devices. +* The CDC-ACM driver is also used in `esp_modem examples `__, where it is used for communication with cellular modems. MSC """