docs(spm): add new ff-a abi
This patch adds documentation for FFA_PARTITION_INFO_GET_REGS.
Signed-off-by: Raghu Krishnamurthy <raghu.ncstate@gmail.com>
Change-Id: Ida21e67d8947c8acaff353f6c89ed5c4285d434e
diff --git a/docs/design/secure-partition-manager.rst b/docs/design/secure-partition-manager.rst
index 40d69de..ee9fa7b 100644
--- a/docs/design/secure-partition-manager.rst
+++ b/docs/design/secure-partition-manager.rst
@@ -803,6 +803,9 @@
- ``FFA_MSG_SEND2``
- ``FFA_RX_ACQUIRE``
+As part of the FF-A v1.2 support, the following interfaces were added:
+- ``FFA_PARTITION_INFO_GET_REGS``
+
FFA_VERSION
~~~~~~~~~~~
@@ -853,6 +856,19 @@
- from SP to SPMC
- from Hypervisor or OS kernel to SPMC. The request is relayed by the SPMD.
+FFA_PARTITION_INFO_GET_REGS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This call can originate:
+
+- from SP to SPMC
+- from SPMC to SPMD
+- from Hypervsior or OS kernel to SPMC. The request is relayed by the SPMD.
+
+The primary use of this ABI is to return partition information via registers
+as opposed to via RX/TX buffers and is useful in cases where sharing memory is
+difficult.
+
FFA_ID_GET
~~~~~~~~~~