aboutsummaryrefslogtreecommitdiff
path: root/doc/arch
diff options
context:
space:
mode:
authorAbdellatif El Khlifi <abdellatif.elkhlifi@arm.com>2023-08-04 14:33:43 +0100
committerTom Rini <trini@konsulko.com>2023-08-08 10:22:03 -0400
commitf16a48fec933829cfa3a81eb1dd531b924e3cde8 (patch)
treec18202de451e327827405f9a334209133439e3f6 /doc/arch
parenta2f5c91cda9215d9abf042fc778b7a471994cf6b (diff)
downloadu-boot-f16a48fec933829cfa3a81eb1dd531b924e3cde8.zip
u-boot-f16a48fec933829cfa3a81eb1dd531b924e3cde8.tar.gz
u-boot-f16a48fec933829cfa3a81eb1dd531b924e3cde8.tar.bz2
arm_ffa: introduce armffa command
Provide armffa command showcasing the use of the U-Boot FF-A support armffa is a command showcasing how to invoke FF-A operations. This provides a guidance to the client developers on how to call the FF-A bus interfaces. The command also allows to gather secure partitions information and ping these partitions. The command is also helpful in testing the communication with secure partitions. For more details please refer to the command documentation [1]. A Sandbox test is provided for the armffa command. [1]: doc/usage/cmd/armffa.rst Signed-off-by: Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com> Reviewed-by: Simon Glass <sjg@chromium.org> Cc: Tom Rini <trini@konsulko.com> Cc: Ilias Apalodimas <ilias.apalodimas@linaro.org> Cc: Jens Wiklander <jens.wiklander@linaro.org> Cc: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'doc/arch')
-rw-r--r--doc/arch/arm64.ffa.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/arch/arm64.ffa.rst b/doc/arch/arm64.ffa.rst
index 7160637..325fb80 100644
--- a/doc/arch/arm64.ffa.rst
+++ b/doc/arch/arm64.ffa.rst
@@ -120,6 +120,8 @@ At this stage the FF-A bus is registered with the DM and can be interacted with
the DM APIs.
Clients are able to probe then use the FF-A bus by calling uclass_first_device().
+Please refer to the armffa command implementation as an example of how to probe
+and interact with the FF-A bus.
When calling uclass_first_device(), the FF-A driver is probed and ends up calling
ffa_do_probe() provided by the Uclass which does the following:
@@ -219,6 +221,13 @@ Relationship between the sandbox emulator and the FF-A device
ffa_emul 0 [ + ] sandbox_ffa_emul `-- arm-ffa-emul
ffa 0 [ ] sandbox_arm_ffa `-- sandbox-arm-ffa
+The armffa command
+-----------------------------------
+
+armffa is a command showcasing how to use the FF-A bus and how to invoke the driver operations.
+
+Please refer the command documentation at :doc:`../usage/cmd/armffa`
+
Example of boot logs with FF-A enabled
--------------------------------------