summaryrefslogtreecommitdiff
path: root/docs/user-guide.md
diff options
context:
space:
mode:
authorSoby Mathew <soby.mathew@arm.com>2015-06-08 12:32:50 +0100
committerAchin Gupta <achin.gupta@arm.com>2015-08-13 23:48:07 +0100
commit58523c076a4bd766fccd207c493cf1b918fda9db (patch)
tree1b929799f1a48c5bd5415b78a765bfe77c719cfd /docs/user-guide.md
parentf9e858b1f7b27d8e0b89cc7e12e7a90755d0dd00 (diff)
PSCI: Add documentation and fix plat_is_my_cpu_primary()
This patch adds the necessary documentation updates to porting_guide.md for the changes in the platform interface mandated as a result of the new PSCI Topology and power state management frameworks. It also adds a new document `platform-migration-guide.md` to aid the migration of existing platform ports to the new API. The patch fixes the implementation and callers of plat_is_my_cpu_primary() to use w0 as the return parameter as implied by the function signature rather than x0 which was used previously. Change-Id: Ic11e73019188c8ba2bd64c47e1729ff5acdcdd5b
Diffstat (limited to 'docs/user-guide.md')
-rw-r--r--docs/user-guide.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/user-guide.md b/docs/user-guide.md
index b9b69b36..8f271cf0 100644
--- a/docs/user-guide.md
+++ b/docs/user-guide.md
@@ -351,7 +351,12 @@ performed.
* `PROGRAMMABLE_RESET_ADDRESS`: This option indicates whether the reset
vector address can be programmed or is fixed on the platform. It can take
- either 0 (fixed) or 1 (programmable). Default is 0.
+ either 0 (fixed) or 1 (programmable). Default is 0. If the platform has a
+ programmable reset address, it is expected that a CPU will start executing
+ code directly at the right address, both on a cold and warm reset. In this
+ case, there is no need to identify the entrypoint on boot and this has
+ implication for `plat_get_my_entrypoint()` platform porting interface.
+ (see the [Porting Guide] for details)
* `PSCI_EXTENDED_STATE_ID`: As per PSCI1.0 Specification, there are 2 formats
possible for the PSCI power-state parameter viz original and extended
@@ -1092,4 +1097,5 @@ _Copyright (c) 2013-2015, ARM Limited and Contributors. All rights reserved._
[Juno Software Guide]: http://community.arm.com/docs/DOC-8396
[DS-5]: http://www.arm.com/products/tools/software-tools/ds-5/index.php
[mbedTLS Repository]: https://github.com/ARMmbed/mbedtls.git
+[Porting Guide]: ./porting-guide.md
[Trusted Board Boot]: trusted-board-boot.md