public inbox for iwd@lists.linux.dev
 help / color / mirror / Atom feed
From: James Prestwood <prestwoj at gmail.com>
To: iwd at lists.01.org
Subject: [PATCH v3 11/11] doc: document DPP interface
Date: Wed, 15 Dec 2021 09:58:14 -0800	[thread overview]
Message-ID: <20211215175814.2467124-11-prestwoj@gmail.com> (raw)
In-Reply-To: 20211215175814.2467124-1-prestwoj@gmail.com

[-- Attachment #1: Type: text/plain, Size: 1014 bytes --]

---
 doc/device-provisioning.txt | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 doc/device-provisioning.txt

diff --git a/doc/device-provisioning.txt b/doc/device-provisioning.txt
new file mode 100644
index 00000000..3ac2d934
--- /dev/null
+++ b/doc/device-provisioning.txt
@@ -0,0 +1,25 @@
+Device Provisioning hierarchy
+=============================
+
+Service		net.connman.iwd
+Interface	net.connman.iwd.DeviceProvisioning [Experimental]
+Object path	/net/connman/iwd/{phy0,phy1,...}/{1,2,...}
+
+Methods		string StartEnrollee()
+
+			Start a DPP enrollee. Currently only station devices are
+			supported.
+
+			Returns the enrollees URI
+
+			Possible errors:	net.connman.iwd.InvalidArguments
+						net.connman.iwd.AlreadyExists
+						net.connman.iwd.NotAvailable
+
+		void Stop()
+
+			Stop an enrollee.
+
+			Possible errors:	net.connman.iwd.Busy
+						net.connman.iwd.Failed
+						net.connman.iwd.InvalidArguments
-- 
2.31.1

                 reply	other threads:[~2021-12-15 17:58 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211215175814.2467124-11-prestwoj@gmail.com \
    --to=iwd@lists.linux.dev \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox