[PATCH BlueZ v2 2/3] doc: Add org.bluez.CSDistanceProvider documentation

Naga Bhavani Akella <[email protected]> Fri, 31 Jul 2026 12:31:58 +0530
Newsgroups org.kernel.vger.linux-bluetooth
Message-ID <[email protected]>
Document the org.bluez.CSDistanceProvider interface,
implemented by external clients to expose per-device Channel Sounding
distance estimates that BlueZ reflects onto the corresponding device
object.
---
 Makefile.am                          |  9 +++++---
 doc/org.bluez.CSDistanceProvider.rst | 32 ++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 3 deletions(-)
 create mode 100644 doc/org.bluez.CSDistanceProvider.rst

diff --git a/Makefile.am b/Makefile.am
index 00b4ac2b1..53bbfd0d2 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -406,7 +406,8 @@ man_MANS += doc/org.bluez.ThermometerManager.5 \
 		doc/org.bluez.Thermometer.5 \
 		doc/org.bluez.ThermometerWatcher.5
 man_MANS += doc/org.bluez.ChannelSounding1.5 \
-	    doc/org.bluez.CSDistance1.5
+	    doc/org.bluez.CSDistance1.5 \
+	    doc/org.bluez.CSDistanceProvider.5
 endif
 manual_pages += doc/bluetoothd.8
 manual_pages += doc/hci.7 doc/mgmt.7 doc/l2cap.7 doc/rfcomm.7 doc/sco.7 \
@@ -448,7 +449,8 @@ manual_pages += doc/org.bluez.ThermometerManager.5 \
 		doc/org.bluez.Thermometer.5 \
 		doc/org.bluez.ThermometerWatcher.5
 manual_pages += doc/org.bluez.ChannelSounding1.5 \
-	        doc/org.bluez.CSDistance1.5
+	        doc/org.bluez.CSDistance1.5 \
+	        doc/org.bluez.CSDistanceProvider.5
 
 EXTRA_DIST += src/genbuiltin src/bluetooth.conf \
 			src/main.conf profiles/network/network.conf \
@@ -538,7 +540,8 @@ EXTRA_DIST += doc/org.bluez.ThermometerManager.rst \
 	      doc/org.bluez.ThermometerWatcher.rst
 
 EXTRA_DIST += doc/org.bluez.ChannelSounding1.rst \
-	      doc/org.bluez.CSDistance1.rst
+	      doc/org.bluez.CSDistance1.rst \
+	      doc/org.bluez.CSDistanceProvider.rst
 
 EXTRA_DIST += doc/pics-opp.txt doc/pixit-opp.txt \
 		doc/pts-opp.txt
diff --git a/doc/org.bluez.CSDistanceProvider.rst b/doc/org.bluez.CSDistanceProvider.rst
new file mode 100644
index 000000000..2d57dc8bd
--- /dev/null
+++ b/doc/org.bluez.CSDistanceProvider.rst
@@ -0,0 +1,32 @@
+============================
+org.bluez.CSDistanceProvider
+============================
+
+------------------------------------------------
+BlueZ D-Bus CSDistanceProvider API documentation
+------------------------------------------------
+
+:Version: BlueZ
+:Date: July 2026
+:Manual section: 5
+:Manual group: Linux System Administration
+
+Interface
+=========
+
+:Service:	<client D-Bus address>
+:Interface:	org.bluez.CSDistanceProvider1
+:Object path:	{provider_root}/{unique distance object path}
+
+Properties
+----------
+
+Objects provided on this interface contain the same properties as
+**org.bluez.ChannelSounding1(5)** interface. Additionally, this interface
+needs to have the Device property indicating the object path of the
+device this distance estimate provides.
+
+object Device [readonly]
+````````````````````````
+
+The object path of the device that this distance estimate applies to.
--