i3c: document hotjoin sysfs entry
authorAlexandre Belloni <alexandre.belloni@bootlin.com>
Sun, 14 Jan 2024 22:52:25 +0000 (23:52 +0100)
committerAlexandre Belloni <alexandre.belloni@bootlin.com>
Sun, 14 Jan 2024 23:21:14 +0000 (00:21 +0100)
The hotjoin syfs entry allows to enable or disable Hot-Join on the Current
Controller of the I3C Bus.

Link: https://lore.kernel.org/r/20240114225232.140860-1-alexandre.belloni@bootlin.com
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Documentation/ABI/testing/sysfs-bus-i3c

index e5248fd67a563b489d8c4a65a7b32ddd2605d952..c812ab180ff40cc7f3b3453d266d7425fcdfbc19 100644 (file)
@@ -88,6 +88,21 @@ Description:
                This entry describes the HDRCAP of the master controller
                driving the bus.
 
+What:          /sys/bus/i3c/devices/i3c-<bus-id>/hotjoin
+KernelVersion:  6.8
+Contact:       linux-i3c@vger.kernel.org
+Description:
+               I3C’s Hot-Join mechanism allows an I3C Device to inform the
+               Active Controller that a newly-joined Target is present on the
+               I3C Bus and is ready to receive a Dynamic Address, in order to
+               become fully functional on the Bus. Hot-Join is used when the
+               Target is mounted on the same I3C bus and remains depowered
+               until needed or until the Target is physically inserted into the
+               I3C bus
+
+               This entry allows to enable or disable Hot-join of the Current
+               Controller driving the bus.
+
 What:          /sys/bus/i3c/devices/i3c-<bus-id>/<bus-id>-<device-pid>
 KernelVersion:  5.0
 Contact:       linux-i3c@vger.kernel.org