Add support for storage setup callbacks

[connman] / doc / device-api.txt

diff --git a/doc/device-api.txt b/doc/device-api.txt
index 7df3791..b0cf440 100644 (file)
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -52,7 +52,45 @@ Properties   string Name [readonly]
 
                string Type [readonly]
 
-                       The device type (for example ethernet, wifi etc.)
+                       The device type (for example "ethernet", "wifi" etc.)
+
+               string Interface [readonly]
+
+                       The device interface (for example "eth0" etc.)
+
+                       This value is for pure informational purposes. It
+                       is not guaranteed that it is always present.
+
+               string Policy [readwrite]
+
+                       Setting of the device power and connection policy.
+                       Possible values are "ignore", "off", "auto"
+                       and "manual".
+
+                       The policy defines on how the device is initialized
+                       when brought up and how it connects. The actual
+                       device power state can be changed independently to
+                       this value.
+
+                       If a device is switched off and the policy is changed
+                       to "auto" or "manual", the device will be switched
+                       on. For a current active device changing the policy
+                       to "off" results in powering down the device.
+
+                       The "ignore" policy can be set for devices that are
+                       detected, but managed by a different entity on the
+                       system. For example for complex network setups.
+
+                       Devices that can connect to various networks, the
+                       difference between "auto" or "manual" defines if
+                       known networks are connected automatically or not.
+                       For simple devices like Ethernet cards, setting
+                       the "manual" policy might fail.
+
+               uint8 Priority [readwrite]
+
+                       The device priority. Higher values indicate the
+                       preference for this device.
 
                boolean Powered [readwrite]
 
@@ -60,6 +98,14 @@ Properties   string Name [readonly]
                        the list of networks in range. All known networks
                        will be still available via the Networks property.
 
+                       Changing this value doesn't change the value of the
+                       Policy property.
+
+                       The value of this property can be changed by other
+                       parts of the system (including the kernel). An
+                       example would be modifications via the "ifconfig"
+                       command line utility.
+
                boolean Scanning [readonly]
 
                        Indicates if a device is scanning. Not all device