feature: add a wakeups interface so we can get powertop-type data from the system over DBus

1 files changed, 121 insertions, 0 deletions

diff --git a/src/org.freedesktop.DeviceKit.Power.Wakeups.xml b/src/org.freedesktop.DeviceKit.Power.Wakeups.xml
new file mode 100644
index 0000000..7f77d60
--- /dev/null
+++ b/src/org.freedesktop.DeviceKit.Power.Wakeups.xml
@@ -0,0 +1,121 @@
+<!DOCTYPE node PUBLIC
+"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
+  <!ENTITY ERROR_GENERAL "org.freedesktop.DeviceKit.Power.GeneralError">
+]>
+<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
+  <interface name="org.freedesktop.DeviceKit.Power.Wakeup">
+    <doc:doc>
+      <doc:description>
+        <doc:para>
+          org.freedesktop.DeviceKit.Power.Wakeup is a DBus interface implimented
+          by DeviceKit-power.
+          It allows applications to watch what applications and drivers are
+          causing the wakeups on the system.
+        </doc:para>
+      </doc:description>
+    </doc:doc>
+
+    <!-- ************************************************************ -->
+    <method name="GetTotal">
+      <arg name="value" direction="out" type="i">
+        <doc:doc>
+          <doc:summary>
+            The number of wakeups per second.
+          </doc:summary>
+        </doc:doc>
+      </arg>
+      <doc:doc>
+        <doc:description>
+          <doc:para>
+            Get the number of wakeups per second.
+          </doc:para>
+        </doc:description>
+        <doc:errors>
+          <doc:error name="&ERROR_GENERAL;">if an error occured while getting the latency</doc:error>
+        </doc:errors>
+      </doc:doc>
+    </method>
+
+    <!-- ************************************************************ -->
+    <signal name="TotalChanged">
+      <arg name="value" direction="out" type="u">
+        <doc:doc>
+          <doc:summary>
+            The number of wakeups per second.
+          </doc:summary>
+        </doc:doc>
+      </arg>
+      <doc:doc>
+        <doc:description>
+          <doc:para>
+            The number of wakeups per second has changed.
+          </doc:para>
+        </doc:description>
+      </doc:doc>
+    </signal>
+
+    <!-- ************************************************************ -->
+    <method name="GetData">
+      <arg name="data" direction="out" type="a(buuss)">
+        <doc:doc>
+          <doc:summary>
+            The data of all the processes and drivers which contribute to the
+            wakeups on the system.
+            <doc:list>
+              <doc:item>
+                <doc:term>is_userspace</doc:term>
+                <doc:definition>
+                  If the wakeup is from userspace.
+                </doc:definition>
+              </doc:item>
+              <doc:item>
+                <doc:term>value</doc:term>
+                <doc:definition>
+                  The number of wakeups per minute.
+                </doc:definition>
+              </doc:item>
+              <doc:item>
+                <doc:term>id</doc:term>
+                <doc:definition>
+                  The process ID of the application, or the IRQ for kernel drivers.
+                </doc:definition>
+              </doc:item>
+              <doc:item>
+                <doc:term>cmdline</doc:term>
+                <doc:definition>
+                  The command line for the application, or NULL for kernel drivers.
+                </doc:definition>
+              </doc:item>
+              <doc:item>
+                <doc:term>details</doc:term>
+                <doc:definition>
+                  The details about the wakeup.
+                </doc:definition>
+              </doc:item>
+            </doc:list>
+        </doc:summary></doc:doc>
+      </arg>
+      <doc:doc>
+        <doc:description>
+          <doc:para>
+            Gets all the wakeups from drivers and applications.
+          </doc:para>
+        </doc:description>
+      </doc:doc>
+    </method>
+
+    <!-- ************************************************************ -->
+    <signal name="DataChanged">
+      <doc:doc>
+        <doc:description>
+          <doc:para>
+            The wakeup data has changed.
+          </doc:para>
+        </doc:description>
+      </doc:doc>
+    </signal>
+
+  </interface>
+
+</node>