document the RF killswitch namespace and interface

2 files changed, 100 insertions, 0 deletions

diff --git a/doc/spec/hal-spec-interfaces.xml b/doc/spec/hal-spec-interfaces.xml
index 1ad525b0..a4746ca1 100644
--- a/doc/spec/hal-spec-interfaces.xml
+++ b/doc/spec/hal-spec-interfaces.xml
@@ -1140,6 +1140,55 @@ $ dbus-send --system --print-reply --dest=org.freedesktop.Hal \
 
   </sect1>
 
+  <sect1 id="interface-device-killswitch">
+    <title>org.freedesktop.Hal.Device.KillSwitch interface</title>
+    <para>
+      This interface provides a mechanism for both querying whether a
+      radio is on as well as turning it on and off.  The following
+      methods are available:
+    </para>
+
+    <informaltable>
+      <tgroup cols="2">
+        <thead>
+          <row>
+            <entry>Method</entry>
+            <entry>Returns</entry>
+            <entry>Parameters</entry>
+            <entry>Throws</entry>
+            <entry>Description</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry>GetPower</entry>
+            <entry>Int</entry>
+            <entry></entry>
+            <entry></entry>
+            <entry>
+              Returns 1 if, and only if, the power is on.
+            </entry>
+          </row>
+          <row>
+            <entry>SetPower</entry>
+            <entry></entry>
+            <entry>Bool</entry>
+            <entry></entry>
+            <entry>
+              Set the power of the radio.
+            </entry>
+          </row>
+
+        </tbody>
+      </tgroup>
+    </informaltable>
+
+    <para>
+      This interface does not emit any signals.
+    </para>
+
+  </sect1>
+
 <!--
   <sect1 id="interface-device-foo">
     <title>org.freedesktop.Hal.Device.Foo interface</title>
diff --git a/doc/spec/hal-spec-properties.xml b/doc/spec/hal-spec-properties.xml
index e4e58f84..0965971a 100644
--- a/doc/spec/hal-spec-properties.xml
+++ b/doc/spec/hal-spec-properties.xml
@@ -6109,6 +6109,57 @@ org.freedesktop.Hal.Device.Volume.method_signatures = {'ssas', 'as', 'as'}
         </tgroup>
       </informaltable>
     </sect2>
+    <sect2 id="device-properties-killswitch">
+      <title>
+        killswitch namespace
+      </title>
+      <para>
+        Device objects with the capability <literal>killswitch</literal>
+        represent switches to turn a radio on and off. See also <xref linkend="interface-device-killswitch"/>.
+      </para>
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Key (type)</entry>
+              <entry>Values</entry>
+              <entry>Mandatory</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry>
+                <literal>killswitch.type</literal> (string)
+              </entry>
+              <entry></entry>
+              <entry>Yes</entry>
+              <entry>Type of the kill switch</entry>
+            </row>
+            <row>
+              <entry></entry>
+              <entry>wlan</entry>
+              <entry></entry>
+              <entry>Kill switch is for turning Wireless networking on/off</entry>
+            </row>
+            <row>
+              <entry></entry>
+              <entry>bluetooth</entry>
+              <entry></entry>
+              <entry>Kill switch is for turning Bluetooth on/off</entry>
+            </row>
+            <row>
+              <entry>
+                <literal>killswitch.access_method</literal> (string)
+              </entry>
+              <entry></entry>
+              <entry>Yes</entry>
+              <entry>How HAL should program the switch</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </sect2>
   </sect1>
 
   <sect1 id="properties-misc">