dbus_new: Add documentation for D-Bus TDLS methods

Signed-hostap: Paul Stewart <pstew@chromium.org>

diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen
index 7e4c7c9d1f480a0124d816cec9bbce296d45145a..87093ed2ddb59648f4346171f70cdace362e0986 100644 (file)
--- a/doc/dbus.doxygen
+++ b/doc/dbus.doxygen
@@ -333,6 +333,73 @@ fi.w1.wpa_supplicant1.CreateInterface.
          <dd>Invalid entries were found in the passed argument.</dd>
        </dl>
       </li>
+      <li>
+       <h3>TDLSDiscover ( s : peer_address ) --> nothing</h3>
+       <p>Initiate a TDLS discovery for a peer.</p>
+       <h4>Arguments</h4>
+       <dl>
+         <dt>s : peer_address</dt>
+         <dd>MAC address for the peer to perform TDLS discovery.</dd>
+       </dl>
+       <h4>Possible errors</h4>
+       <dl>
+         <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
+         <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
+         <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
+         <dd>Initiating the TDLS operation failed for an unknown reason.</dd>
+       </dl>
+      </li>
+      <li>
+       <h3>TDLSSetup ( s : peer_address ) --> nothing</h3>
+       <p>Setup a TDLS session for a peer.</p>
+       <h4>Arguments</h4>
+       <dl>
+         <dt>s : peer_address</dt>
+         <dd>MAC address for the peer to perform TDLS setup.</dd>
+       </dl>
+       <h4>Possible errors</h4>
+       <dl>
+         <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
+         <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
+         <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
+         <dd>Initiating the TDLS operation failed for an unknown reason.</dd>
+       </dl>
+      </li>
+      <li>
+       <h3>TDLSStatus ( s : peer_address ) --> s</h3>
+       <p>Return TDLS status with respect to a peer.</p>
+       <h4>Arguments</h4>
+       <dl>
+         <dt>s : peer_address</dt>
+         <dd>MAC address for the peer for which status is requested.</dd>
+       </dl>
+       <h4>Returns</h4>
+       <dl>
+         <dt>s : status</dt>
+         <dd>Current status of the TDLS link with the selected peer.</dd>
+       </dl>
+       <h4>Possible errors</h4>
+       <dl>
+         <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
+         <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
+       </dl>
+      </li>
+      <li>
+       <h3>TDLSTeardown ( s : peer_address ) --> nothing</h3>
+       <p>Tear down a TDLS session with a peer.</p>
+       <h4>Arguments</h4>
+       <dl>
+         <dt>s : peer_address</dt>
+         <dd>MAC address for the peer to tear down TDLS connectivity with.</dd>
+       </dl>
+       <h4>Possible errors</h4>
+       <dl>
+         <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
+         <dd>The "peer_address" argument is not a properly formatted MAC.</dd>
+         <dt>fi.w1.wpa_supplicant1.UnknownError</dt>
+         <dd>Initiating the TDLS operation failed for an unknown reason.</dd>
+       </dl>
+      </li>
       <li>
        <h3>EAPLogoff ( ) --> nothing</h3>
        <p>IEEE 802.1X EAPOL state machine logoff.</p>