diff options
author | Soby Mathew <soby.mathew@arm.com> | 2015-03-11 15:48:50 +0000 |
---|---|---|
committer | Vikram Kanigiri <vikram.kanigiri@arm.com> | 2015-07-23 10:12:24 +0100 |
commit | c8cfec0a1b959f6a0d868f66157879727907a3a9 (patch) | |
tree | 9abd44aa57af918a3cb9e55d55b42dccdd9428a4 /docs/porting-guide.md | |
parent | 6c6a48a9b7fefbb48d7242c19971c2274ab0bfdc (diff) |
Add TFTF framework and platform support for extended State-id
This patch adds the necessary platform and framework support for
extended state-id power state format. Also the existing suspend
tests have been reworked to use the new framework. The framework
detects the correct power state format during cold boot and
implements helper functions to create the power state function
in the detected format.
Change-Id: Ie729d947a0f2693aa7e943544a2c4c006e526c63
Diffstat (limited to 'docs/porting-guide.md')
-rw-r--r-- | docs/porting-guide.md | 18 |
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 -------------------------- |