summaryrefslogtreecommitdiff
path: root/docs/porting-guide.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/porting-guide.md')
-rw-r--r--docs/porting-guide.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/porting-guide.md b/docs/porting-guide.md
index 9ba18ba..5fe6acd 100644
--- a/docs/porting-guide.md
+++ b/docs/porting-guide.md
@@ -108,6 +108,13 @@ file is found in [plat/fvp/include/platform_def.h].
GIC IRQ ID.
E.g. `PLAT_MAX_SPI_OFFSET_ID` = 10 means that IRQ #42 is the last SPI.
+* **#define : PLAT_LOCAL_PSTATE_WIDTH**
+
+ Defines the bit-field width of the local state in State-ID field of
+ the power-state parameter. This macro will be used by the TFTF framework
+ to compose the State-ID field given the local power state at different
+ affinity levels.
+
* **#define : TFTF_BASE**
Defines the base address of the TFTF binary in DRAM. Used by the linker
@@ -237,6 +244,17 @@ API is used by the topology framework in TFTF to query the presence of a CPU
and ,if present, returns the corresponding MPIDR for it. If the CPU referred
to by the 'core_pos' is absent, then this function returns INVALID_MPID.
+### Function : plat_get_state_prop() [mandatory]
+
+ Argument : unsigned int
+ Return : const plat_state_prop_t *
+
+This functions returns the `plat_state_prop_t` array for all the valid low
+power states from platform for a specified `affinity level` and returns NULL
+for an invalid `affinity level`. The array is expected to be NULL terminated.
+This function is expected to be used by tests that need to compose the power
+state parameter for use in PSCI_CPU_SUSPEND API or PSCI_STAT/RESIDENCY API.
+
4. Optional modifications
--------------------------