Linux USB
 help / color / mirror / Atom feed
From: Akshay Gujar <Akshay.Gujar@harman.com>
To: <gregkh@linuxfoundation.org>
Cc: <Akshay.Gujar@harman.com>, <linux-kernel@vger.kernel.org>,
	<linux-usb@vger.kernel.org>, <naveen.v@harman.com>,
	<oneukum@suse.com>, <stern@rowland.harvard.edu>
Subject: [PATCH v6 2/3] Documentation: ABI: document DEVICE_ENUMERATION_FAILURE uevent
Date: Sun, 2 Aug 2026 23:31:07 +0000	[thread overview]
Message-ID: <20260802233108.70950-3-Akshay.Gujar@harman.com> (raw)
In-Reply-To: <20260802233108.70950-1-Akshay.Gujar@harman.com>

Document the DEVICE_ENUMERATION_FAILURE environment variable emitted
in KOBJ_CHANGE uevents when device enumeration fails.

Signed-off-by: Akshay Gujar <Akshay.Gujar@harman.com>
---
 Documentation/ABI/testing/sysfs-uevent | 37 ++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-uevent b/Documentation/ABI/testing/sysfs-uevent
index 0b6227706b35e..6ace99f99daa3 100644
--- a/Documentation/ABI/testing/sysfs-uevent
+++ b/Documentation/ABI/testing/sysfs-uevent
@@ -49,3 +49,40 @@ Description:
 
 Users:
                 udev, userspace tools generating synthetic uevents
+
+What:           DEVICE_ENUMERATION_FAILURE
+Date:           August 2026
+KernelVersion:  7.3
+Description:
+                Some devices are detected as physically present but fail
+                to enumerate, for example due to protocol-level errors or
+                invalid responses.
+
+                When this happens, a bus driver may emit a KOBJ_CHANGE
+                uevent containing:
+
+                  DEVICE_ENUMERATION_FAILURE=<identifier>
+
+		 The value is a bus-specific identifier of the port or slot
+		 on which enumeration failed, not the name of the device
+		 that emitted the event. For USB this is the port device
+		 name, e.g. "usb1-port1".
+
+                 Example (USB):
+
+                  ACTION=change
+                  SUBSYSTEM=usb
+                  DEVTYPE=usb_interface
+                  DEVPATH=/devices/.../usb1/1-0:1.0
+                  DEVICE_ENUMERATION_FAILURE=usb1-port1
+
+                The event is emitted from the hub interface that owns the
+                port, so DEVPATH refers to the interface. Appending the
+                identifier to DEVPATH gives the failing port:
+
+                  /sys/devices/.../usb1/1-0:1.0/usb1-port1/
+
+Users:
+		udev, userspace tools monitoring device enumeration
+		failures
+
-- 
2.19.0


  parent reply	other threads:[~2026-08-02 23:32 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-02 23:31 [PATCH v6 0/3] driver core: add enumeration failure uevent helper Akshay Gujar
2026-08-02 23:31 ` [PATCH v6 1/3] driver core: add device_enumeration_failure_notify() helper Akshay Gujar
2026-08-02 23:31 ` Akshay Gujar [this message]
2026-08-02 23:31 ` [PATCH v6 3/3] usb: hub: send enumeration failure uevent Akshay Gujar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260802233108.70950-3-Akshay.Gujar@harman.com \
    --to=akshay.gujar@harman.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=naveen.v@harman.com \
    --cc=oneukum@suse.com \
    --cc=stern@rowland.harvard.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox