Increment the PSCI VERSION to 1.0
authorSoby Mathew <soby.mathew@arm.com>
Thu, 15 Jan 2015 11:49:58 +0000 (11:49 +0000)
committerDan Handley <dan.handley@arm.com>
Mon, 26 Jan 2015 12:49:32 +0000 (12:49 +0000)
This patch:

   * Bumps the PSCI VERSION to 1.0. This means that
     the PSCI_VERSION API will now return the value 0x00010000
     to indicate the version as 1.0. The firmware remains
     compatible with PSCI v0.2 clients.

   * The firmware design guide is updated to document the
     APIs supported by the Trusted Firmware generic code.

   * The FVP Device Tree Sources (dts) and Blobs(dtb) are also
     updated to add "psci-1.0" and "psci-0.2" to the list of
     compatible PSCI versions.

Change-Id: Iafc2f549c92651dcd65d7e24a8aae35790d00f8a

14 files changed:
docs/firmware-design.md
fdts/fvp-base-gicv2-psci.dtb
fdts/fvp-base-gicv2-psci.dts
fdts/fvp-base-gicv2legacy-psci.dtb
fdts/fvp-base-gicv2legacy-psci.dts
fdts/fvp-base-gicv3-psci.dtb
fdts/fvp-base-gicv3-psci.dts
fdts/fvp-foundation-gicv2-psci.dtb
fdts/fvp-foundation-gicv2-psci.dts
fdts/fvp-foundation-gicv2legacy-psci.dtb
fdts/fvp-foundation-gicv2legacy-psci.dts
fdts/fvp-foundation-gicv3-psci.dtb
fdts/fvp-foundation-gicv3-psci.dts
include/bl31/services/psci.h

index 774ea436cf566ba8eb2cbd52b645ec130da4ae7e..ee76d5c891c920f529dfe8e2c28d2ef5e59f0089 100644 (file)
@@ -734,32 +734,43 @@ restoring the stack and CPU state and returning from the original SMC.
 
 TODO: Provide design walkthrough of PSCI implementation.
 
-The complete PSCI API is not yet implemented. The following functions are
-currently implemented:
-
--   `PSCI_VERSION`
--   `CPU_OFF`
--   `CPU_ON`
--   `CPU_SUSPEND`
--   `AFFINITY_INFO`
--   `SYSTEM_OFF`
--   `SYSTEM_RESET`
-
-The `CPU_ON`, `CPU_OFF` and `CPU_SUSPEND` functions implement the warm boot
-path in ARM Trusted Firmware. `CPU_ON` and `CPU_OFF` have undergone testing
-on all the supported FVPs. `CPU_SUSPEND` & `AFFINITY_INFO` have undergone
-testing only on the AEM v8 Base FVP. Support for `AFFINITY_INFO` is still
-experimental. Support for `CPU_SUSPEND` is stable for entry into power down
-states. Standby states are currently not supported. `PSCI_VERSION` is
-present but completely untested in this version of the software.
-
-The following unsupported functions return with a error code as documented in
-the [Power State Coordination Interface PDD] [PSCI].
-
--   `MIGRATE` : -1 (NOT_SUPPORTED)
--   `MIGRATE_INFO_TYPE` : 2 (Trusted OS is either not present or does not
-     require migration)
--   `MIGRATE_INFO_UP_CPU` : 0 (Return value is UNDEFINED)
+The PSCI v1.0 specification categorizes APIs as optional and mandatory. All the
+mandatory APIs in PSCI v1.0 and all the APIs in PSCI v0.2 draft specification
+[Power State Coordination Interface PDD] [PSCI] are implemented. The table lists
+the PSCI v1.0 APIs and their support in generic code.
+
+An API implementation might have a dependency on platform code e.g. CPU_SUSPEND
+requires the platform to export a part of the implementation. Hence the level
+of support of the mandatory APIs depends upon the support exported by the
+platform port as well. The Juno and FVP (all variants) platforms export all the
+required support.
+
+| PSCI v1.0 API         |Supported| Comments                                  |
+|:----------------------|:--------|:------------------------------------------|
+|`PSCI_VERSION`         | Yes     | The version returned is 1.0               |
+|`CPU_SUSPEND`          | Yes*    | The original `power_state` format is used |
+|`CPU_OFF`              | Yes*    |                                           |
+|`CPU_ON`               | Yes*    |                                           |
+|`AFFINITY_INFO`        | Yes     |                                           |
+|`MIGRATE`              | Yes**   |                                           |
+|`MIGRATE_INFO_TYPE`    | Yes**   |                                           |
+|`MIGRATE_INFO_CPU`     | Yes**   |                                           |
+|`SYSTEM_OFF`           | Yes*    |                                           |
+|`SYSTEM_RESET`         | Yes*    |                                           |
+|`PSCI_FEATURES`        | Yes     |                                           |
+|`CPU_FREEZE`           | No      |                                           |
+|`CPU_DEFAULT_SUSPEND`  | No      |                                           |
+|`CPU_HW_STATE`         | No      |                                           |
+|`SYSTEM_SUSPEND`       | No      |                                           |
+|`PSCI_SET_SUSPEND_MODE`| No      |                                           |
+|`PSCI_STAT_RESIDENCY`  | No      |                                           |
+|`PSCI_STAT_COUNT`      | No      |                                           |
+
+*Note : These PSCI APIs require platform power management hooks to be
+registered with the generic PSCI code to be supported.
+
+**Note : These PSCI APIs require appropriate Secure Payload Dispatcher
+hooks to be registered with the generic PSCI code to be supported.
 
 
 5.  Secure-EL1 Payloads and Dispatchers
index ae3b4c55c041da0a7a85b3cf7d2ebee450d97b6a..b8a31ce33beabb6165c45eaa796d1de07131986f 100644 (file)
Binary files a/fdts/fvp-base-gicv2-psci.dtb and b/fdts/fvp-base-gicv2-psci.dtb differ
index 43518a3f477d5ea99c268d1ef0ea27e048ad7220..c1c9efbf15d0c3399b5ef4300b77b55a385609aa 100644 (file)
@@ -52,7 +52,7 @@
        };
 
        psci {
-               compatible = "arm,psci";
+               compatible = "arm,psci-1.0", "arm,psci-0.2", "arm,psci";
                method = "smc";
                cpu_suspend = <0xc4000001>;
                cpu_off = <0x84000002>;
index 2d23968f3e445a853b91144728d84f6676ee7f8f..4270623b56a3c3eaf132bea4ea3cb5b91af71465 100644 (file)
Binary files a/fdts/fvp-base-gicv2legacy-psci.dtb and b/fdts/fvp-base-gicv2legacy-psci.dtb differ
index 06d33e749848ce9d8109275c27f71657bedc5e16..7bd5ea268199aaa16849e0e1ca480026ed3c22a4 100644 (file)
@@ -52,7 +52,7 @@
        };
 
        psci {
-               compatible = "arm,psci";
+               compatible = "arm,psci-1.0", "arm,psci-0.2", "arm,psci";
                method = "smc";
                cpu_suspend = <0xc4000001>;
                cpu_off = <0x84000002>;
index c2f63ebebee24231f71f3eb0c9d6a839e3314d6f..27c3f9353ba97a34e087cb1a299ceaf62501b84b 100644 (file)
Binary files a/fdts/fvp-base-gicv3-psci.dtb and b/fdts/fvp-base-gicv3-psci.dtb differ
index 6afa44c72d77176e22cf9af247e75465f2eb2f52..32e577ada7c8fb3a9a5360034b57d3285437c8dd 100644 (file)
@@ -52,7 +52,7 @@
        };
 
        psci {
-               compatible = "arm,psci";
+               compatible = "arm,psci-1.0", "arm,psci-0.2", "arm,psci";
                method = "smc";
                cpu_suspend = <0xc4000001>;
                cpu_off = <0x84000002>;
index df8e629ffafe1746e42d3c84997e68873b28c493..5b92e5ee8288926bd72503e35def261ed4b3f189 100644 (file)
Binary files a/fdts/fvp-foundation-gicv2-psci.dtb and b/fdts/fvp-foundation-gicv2-psci.dtb differ
index 15ff47182f9cdb727fac90626311f68036d1c3d4..c04d535f29c3c142178d9fe9e14ca64a4a4beda7 100644 (file)
@@ -52,7 +52,7 @@
        };
 
        psci {
-               compatible = "arm,psci";
+               compatible = "arm,psci-1.0", "arm,psci-0.2", "arm,psci";
                method = "smc";
                cpu_suspend = <0xc4000001>;
                cpu_off = <0x84000002>;
index ed43254131d0d94a1466270f1b39dff12b214420..71f6ae2c9cfc907e6fd60d715ca0e7c6d5533213 100644 (file)
Binary files a/fdts/fvp-foundation-gicv2legacy-psci.dtb and b/fdts/fvp-foundation-gicv2legacy-psci.dtb differ
index a923c34899dd7e73f27e89828ac8bb7e001727f1..8dba04c1e2b0b38082c94db2b77284c8a2711fc0 100644 (file)
@@ -83,7 +83,7 @@
                };
 
                idle-states {
-                       entry-method = "arm,psci";
+                       entry-method = "arm,psci-1.0", "arm,psci-0.2", "arm,psci";
 
                        CPU_SLEEP_0: cpu-sleep-0 {
                                compatible = "arm,idle-state";
index 724847c3c9a2e0db86ba826683e59ce456d9d9f5..d7d9e1412ca6ef9c100db1682a1999a1309c9ec2 100644 (file)
Binary files a/fdts/fvp-foundation-gicv3-psci.dtb and b/fdts/fvp-foundation-gicv3-psci.dtb differ
index 49290e4e10501581a2a84782c3a4b13a6911f7d5..48a1afc061410f7c1aec14d62cc66c959e803566 100644 (file)
@@ -52,7 +52,7 @@
        };
 
        psci {
-               compatible = "arm,psci";
+               compatible = "arm,psci-1.0", "arm,psci-0.2", "arm,psci";
                method = "smc";
                cpu_suspend = <0xc4000001>;
                cpu_off = <0x84000002>;
index 59675810bc4c52d5181afa982aeee59d0ccd8e51..80bc53b83506868082df521d53949881f3408e16 100644 (file)
 /*******************************************************************************
  * PSCI version
  ******************************************************************************/
-#define PSCI_MAJOR_VER         (0 << 16)
-#define PSCI_MINOR_VER         0x2
+#define PSCI_MAJOR_VER         (1 << 16)
+#define PSCI_MINOR_VER         0x0
 
 /*******************************************************************************
  * PSCI error codes