summaryrefslogtreecommitdiffstats
path: root/hal/gonk/nsIRecoveryService.idl
diff options
context:
space:
mode:
Diffstat (limited to 'hal/gonk/nsIRecoveryService.idl')
-rw-r--r--hal/gonk/nsIRecoveryService.idl39
1 files changed, 39 insertions, 0 deletions
diff --git a/hal/gonk/nsIRecoveryService.idl b/hal/gonk/nsIRecoveryService.idl
new file mode 100644
index 000000000..ecbb39c0e
--- /dev/null
+++ b/hal/gonk/nsIRecoveryService.idl
@@ -0,0 +1,39 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "nsISupports.idl"
+
+[scriptable, uuid(bc24fb33-a0c1-49ca-aa43-05f167e02fb6)]
+interface nsIRecoveryService : nsISupports
+{
+ /**
+ * Possible values of fotaStatus.result. These should stay in sync with
+ * librecovery/librecovery.h
+ */
+ const long FOTA_UPDATE_UNKNOWN = 0;
+ const long FOTA_UPDATE_FAIL = 1;
+ const long FOTA_UPDATE_SUCCESS = 2;
+
+ /**
+ * Uses recovery to wipe the data and cache partitions. If this call is
+ * successful, the device should reboot before the function call ever returns.
+ *
+ * @throws NS_ERROR_FAILURE when rebooting into recovery fails for some reason.
+ */
+ void factoryReset(in string reason);
+
+ /**
+ * Use recovery to install an OTA update.zip. If this call is
+ * successful, the device should reboot before the function call ever returns.
+ *
+ * @throws NS_ERROR_FAILURE when rebooting into recovery fails for some reason.
+ */
+ void installFotaUpdate(in string updatePath);
+
+ /**
+ * @return The status of the last FOTA update. One of FOTA_UPDATE_UNKNOWN,
+ * FOTA_UPDATE_FAIL, FOTA_UPDATE_SUCCESS.
+ */
+ long getFotaUpdateStatus();
+};