diff mbox series

[4/4] Docs: usb: update explanation for device_present to disconnected

Message ID c4e0a964d0dbd34c13d3a8ff4df6dbb231de6de4.1638152984.git.philipp.g.hortmann@gmail.com (mailing list archive)
State Superseded
Headers show
Series Docs: usb: Code and text updates from usb-skeleton | expand

Commit Message

Philipp Hortmann Nov. 29, 2021, 8:21 p.m. UTC
Update text for `device_present` flag to `disconnected` flag

Signed-off-by: Philipp Hortmann <philipp.g.hortmann@gmail.com>
---
 .../driver-api/usb/writing_usb_driver.rst          | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/driver-api/usb/writing_usb_driver.rst b/Documentation/driver-api/usb/writing_usb_driver.rst
index 74bb72a2f0ac..d398d2155cd3 100644
--- a/Documentation/driver-api/usb/writing_usb_driver.rst
+++ b/Documentation/driver-api/usb/writing_usb_driver.rst
@@ -277,15 +277,13 @@  notify the user-space programs that the device is no longer there. The
     }
 
 
-If a program currently has an open handle to the device, we reset the
-flag ``device_present``. For every read, write, release and other
+If the driver probed the device successfully, the flag ``disconnected``
+is initialized and set to false. For every read, write and other
 functions that expect a device to be present, the driver first checks
-this flag to see if the device is still present. If not, it releases
-that the device has disappeared, and a ``-ENODEV`` error is returned to the
-user-space program. When the release function is eventually called, it
-determines if there is no device and if not, it does the cleanup that
-the ``skel_disconnect`` function normally does if there are no open files
-on the device (see Listing 5).
+this flag to see if the device is still present. If not, a ``-ENODEV``
+error is returned to the user-space program. When the device is
+disconnected, `skel_disconnected` function is called. It sets ``disconnected``
+to true and cleans up.
 
 Isochronous Data
 ================