diff mbox series

[v9,2/2] Add the similar USD APIs to dbus control interface that other apps can use the functions

Message ID DU0PR04MB93962B4CD5623E575F6666FBA29D2@DU0PR04MB9396.eurprd04.prod.outlook.com
State Accepted
Headers show
Series None | expand

Commit Message

Chin-Ran Lo Sept. 5, 2024, 1:44 p.m. UTC 
From be25edbc959d8e4c152e63382c249b2cd0e039c6 Mon Sep 17 00:00:00 2001
From: "Lo,Chin-Ran" <chin-ran.lo@nxp.com>
Date: Thu, 5 Sep 2024 20:18:17 +0000
Subject: [v9 2/2] Add the description of the NAN-USD dbus API to dbus.doxygen

Signed-off-by: Lo,Chin-Ran <chin-ran.lo@nxp.com>
---
 doc/dbus.doxygen | 175 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 175 insertions(+)
diff mbox series

Patch

diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen
index ae1e6f8cc..6d189f2e4 100644
--- a/doc/dbus.doxygen
+++ b/doc/dbus.doxygen
@@ -412,6 +412,133 @@  fi.w1.wpa_supplicant1.CreateInterface.
 	  <dd>Invalid entries were found in the passed argument.</dd>
 	</dl>
       </li>
+      <li>
+	<h3>NANPublish ( a{sv} : nan_args ) --> i : publish_id</h3>
+	<p>Set the parameters of nan-publish for the interface.</p>
+	<h4>Arguments</h4>
+	<dl>
+	  <dt>a{sv} : nan_args</dt>
+	  <dd>
+	    A dictionary with following parameters:
+	    <table>
+	    <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
+	    <tr><td>srv_name</td><td>s</td><td>service name.</td><td>yes</td></tr>
+	    <tr><td>proto_type</td><td>y</td><td>Service Protocol Types</td><td>yes</td></tr>
+	    <tr><td>solicited</td><td>b</td><td>Solicited Publish</td><td></td></tr>
+	    <tr><td>unsolicited</td><td>b</td><td>Unsolicited Publish</td><td></td></tr>
+	    <tr><td>solicited_mcast</td><td>b</td><td>Solicited transmission type</td><td></td></tr>
+	    <tr><td>ttl</td><td>q</td><td>Time to live (in seconds); 0 = one TX only</td><td>yes</td></tr>
+	    <tr><td>disable_event</td><td>b</td><td>Event conditions</td><td></td></tr>
+	    <tr><td>fsd</td><td>b</td><td>Further Service Discovery flag</td><td></td></tr>
+	    <tr><td>fsd_gas</td><td>b</td><td>Further Service Discovery function</td><td></td></tr>
+	    <tr><td>freq</td><td>q</td><td>Default frequency</td><td>yes</td></tr>
+	    <tr><td>announce_period</td><td>u</td><td>Announcement period in ms</td><td></td></tr>
+	    <tr><td>p2p</td><td>b</td><td>Allow P2P IE to be added into NAN SDFs</td><td></td></tr>
+	    <tr><td>ssi_len</td><td>q</td><td>length of ssi</td><td>yes</td></tr>
+	    <tr><td>freq_list_len</td><td>q</td><td>length of freq_list</td><td>yes</td></tr>
+	    <tr><td>ssi</td><td>v</td><td>ssi field</td><td>yes</td></tr>
+	    <tr><td>freq_list</td><td>v</td><td>frequency list</td><td></td></tr>
+	    </table>
+	  </dd>
+	</dl>
+	<h4>Possible errors</h4>
+	<dl>
+	  <dt>fi.w1.wpa_supplicant1.NoMemory</dt>
+	  <dd>Needed memory was not possible to get allocated.</dd>
+	  <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
+	  <dd>Invalid entries were found in the passed argument.</dd>
+	</dl>
+      </li>
+      <li>
+	<h3>NANCancelPublish ( i : nan_args ) --> nothing</h3>
+	<p>Cancel the previous nan-publish for the interface.</p>
+	<h4>Arguments</h4>
+	<dl>
+	  <dt>i : nan_args</dt>
+	  <dd>publish id.</dd>
+	</dl>
+      </li>
+      <li>
+	<h3>NANUpdatePublish ( a{sv} : nan_args ) --> nothing</h3>
+	<p>Update the SSI of the previous nan-publish for the interface.</p>
+	<h4>Arguments</h4>
+	<dl>
+	  <dt>a{sv} : nan_args</dt>
+	  <dd>
+	    A dictionary with following parameters:
+	    <table>
+	    <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
+	    <tr><td>publish_id</td><td>i</td><td>Publish Id to be updated</td><td>yes</td></tr>
+	    <tr><td>ssi_len</td><td>q</td><td>length of ssi</td><td>yes</td></tr>
+	    <tr><td>ssi</td><td>v</td><td>ssi field</td><td>yes</td></tr>
+	    </table>
+	  </dd>
+	</dl>
+      </li>
+      <li>
+	<h3>NANSubscribe ( a{sv} : nan_args ) --> i : subscribe_id</h3>
+	<p>Set the parameters of the nan-usd subscription for the interface.</p>
+	<h4>Arguments</h4>
+	<dl>
+	  <dt>a{sv} : nan_args</dt>
+	  <dd>
+	    A dictionary with following parameters:
+	    <table>
+	    <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
+	    <tr><td>srv_name</td><td>s</td><td>service name.</td><td>yes</td></tr>
+	    <tr><td>proto_type</td><td>y</td><td>Service Protocol Types</td><td>yes</td></tr>
+	    <tr><td>is_active</td><td>b</td><td>Subscribe type</td><td></td></tr>
+	    <tr><td>ttl</td><td>q</td><td>Time to live (in seconds); 0 = one TX only</td><td>yes</td></tr>
+	    <tr><td>freq</td><td>q</td><td>Default frequency</td><td>yes</td></tr>
+	    <tr><td>query_period</td><td>u</td><td>Query period in ms</td><td></td></tr>
+	    <tr><td>p2p</td><td>b</td><td>Allow P2P IE to be added into NAN SDFs</td><td></td></tr>
+	    <tr><td>ssi_len</td><td>q</td><td>length of ssi</td><td>yes</td></tr>
+	    <tr><td>freq_list_len</td><td>q</td><td>length of freq_list</td><td>yes</td></tr>
+	    <tr><td>ssi</td><td>v</td><td>ssi field</td><td>yes</td></tr>
+	    <tr><td>freq_list</td><td>v</td><td>frequency list</td><td></td></tr>
+	    </table>
+	  </dd>
+	</dl>
+	<h4>Possible errors</h4>
+	<dl>
+	  <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
+	  <dd>Invalid entries were found in the passed argument.</dd>
+	</dl>
+      </li>
+      <li>
+	<h3>NANCancelSubscribe ( i : nan_args ) --> nothing</h3>
+	<p>Cancel the previous subscription for the interface.</p>
+	<h4>Arguments</h4>
+	<dl>
+	  <dt>i : nan_args</dt>
+	  <dd>Subscription id.</dd>
+	</dl>
+      </li>
+      <li>
+	<h3>NANTransmit ( a{sv} : nan_args ) --> nothing</h3>
+	<p>Send the follow-up packet to the interface.</p>
+	<h4>Arguments</h4>
+	<dl>
+	  <dt>a{sv} : nan_args</dt>
+	  <dd>
+	    A dictionary with following parameters:
+	    <table>
+	    <tr><th>Key</th><th>Value type</th><th>Description</th><th>Required</th></tr>
+
+	    <tr><td>handle</td><td>y</td><td>id from NAN_PUBLISH or NAN_SUBSCRIBE.</td><td>yes</td></tr>
+	    <tr><td>req_instance_id</td><td>y</td><td>peer's id</td><td>yes</td></tr>
+	    <tr><td>peer_addr</td><td>s</td><td>peer's MAC address</td><td>yes</td></tr>
+	    <tr><td>ssi_len</td><td>q</td><td>length of ssi</td><td>yes</td></tr>
+	    <tr><td>ssi</td><td>v</td><td>ssi field</td><td>yes</td></tr>
+	    </table>
+	  </dd>
+	</dl>
+	<h4>Possible errors</h4>
+	<dl>
+	  <dt>fi.w1.wpa_supplicant1.InvalidArgs</dt>
+	  <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>
@@ -1385,6 +1512,54 @@  fi.w1.wpa_supplicant1.CreateInterface.
 	  <dd>Determine if the request was successful. If so fields are available in BSS.</dd>
 	</dl>
       </li>
+      <li>
+	<h3>NANDiscoveryResult ( b : success, a{sv} : args )</h3>
+	<p>Result of an NANSubscribe.</p>
+	<dl>
+	  <dt>b : success</dt>
+	  <dd>Success or not.</dd>
+	  <dt>a{sv} : args</dt>
+	  <dd>A dictionary with pairs of field names and their values.Possible dictionary keys are: "discov_info", "ssi"</dd>
+	</dl>
+      </li>
+      <li>
+	<h3>NANReplied ( b : success, a{sv} : args )</h3>
+	<p>The Replied_Event in the NAN Discovery engine.</p>
+	<dl>
+	  <dt>b : success</dt>
+	  <dd>Success or not.</dd>
+	  <dt>a{sv} : args</dt>
+	  <dd>A dictionary with pairs of field names and their values.Possible dictionary keys are: "reply_info", "ssi"</dd>
+	</dl>
+      </li>
+      <li>
+	<h3>NANReceive ( a{sv} : nanrx )</h3>
+	<p>The Receive_Event in the NAN Discovery engine.</p>
+	<dl>
+	  <dt>a{sv} : nanrx</dt>
+	  <dd>A dictionary with pairs of field names and their values.Possible dictionary keys are: "nanrx_info", "ssi"</dd>
+	</dl>
+      </li>
+      <li>
+	<h3>NANPublishTerminated ( i : publish_id, i : reason )</h3>
+	<p>The PublishTerminated_Event in the NAN Discovery engine.</p>
+	<dl>
+	  <dt>i : publish_id</dt>
+	  <dd>The terminated publish_id</dd>
+	  <dt>i : reason</dt>
+	  <dd>The reason of termination</dd>
+	</dl>
+      </li>
+      <li>
+	<h3>NANSubscribeTerminated ( i : subscribe_id, i : reason )</h3>
+	<p>The SubscribeTerminate_Event in the NAN Discovery engine.</p>
+	<dl>
+	  <dt>i : subscribe_id</dt>
+	  <dd>The terminated subscribe_id</dd>
+	  <dt>i : reason</dt>
+	  <dd>The reason of termination</dd>
+	</dl>
+      </li>
     </ul>