From 9f972b45ca2b455222baafb25f62c0fdbbc29e7c Mon Sep 17 00:00:00 2001
From: Jouni Malinen <j@w1.fi>
Date: Tue, 30 Dec 2014 13:56:42 +0200
Subject: [PATCH] doc: Add D-Bus documentation for Probe Request reporting

Commit 2d43d37ff2c3115da812bec8ea4c72048e1194d8 ('DBus: Add ability to
report probe requests') added this capability, but forgot to document
it.

Signed-off-by: Jouni Malinen <j@w1.fi>
---
 doc/dbus.doxygen | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen
index 797a1600b..51cf1595f 100644
--- a/doc/dbus.doxygen
+++ b/doc/dbus.doxygen
@@ -511,6 +511,30 @@ fi.w1.wpa_supplicant1.CreateInterface.
 	  <dd>Maximum age in seconds for BSS entries to keep in cache (0 = remove all entries).</dd>
 	</dl>
       </li>
+
+      <li>
+	<h3>SubscribeProbeReq ( ) --> nothing</h3>
+	<p>Subscribe to receive Probe Request events. This is needed in addition to registering a signal handler for the ProbeRequest signal to avoid flooding D-Bus with all Probe Request indications when no application is interested in them.</p>
+	<h4>Possible errors</h4>
+	<dl>
+	  <dt>fi.w1.wpa_supplicant1.SubscriptionInUse</dt>
+	  <dd>Another application is already subscribed.</dd>
+	  <dt>fi.w1.wpa_supplicant1.NoMemory</dt>
+	  <dd>Needed memory was not possible to get allocated.</dd>
+	</dl>
+      </li>
+
+      <li>
+	<h3>UnsubscribeProbeReq ( ) --> nothing</h3>
+	<p>Unsubscribe from receiving Probe Request events.</p>
+	<h4>Possible errors</h4>
+	<dl>
+	  <dt>fi.w1.wpa_supplicant1.NoSubscription</dt>
+	  <dd>No subscription in place.</dd>
+	  <dt>fi.w1.wpa_supplicant1.SubscriptionNotYou</dt>
+	  <dd>Subscription in place, but for another process.</dd>
+	</dl>
+      </li>
     </ul>
 
 \subsection dbus_interface_properties Properties
@@ -778,6 +802,16 @@ fi.w1.wpa_supplicant1.CreateInterface.
 	  <dd>Human readable information about the requested information.</dd>
 	</dl>
       </li>
+
+      <li>
+	<h3>ProbeRequest ( a{sv} : args )</h3>
+	<p>Information about a received Probe Request frame. This signal is delivered only to a single application that has subscribed to received the events with SubscribeProbeReq().</p>
+	<h4>Arguments</h4>
+	<dl>
+	  <dt>a{sv} : args</dt>
+	  <dd>A dictionary with pairs of field names and their values. Possible dictionary keys are: "addr", "dst", "bssid", "ies", "signal".</dd>
+	</dl>
+      </li>
     </ul>