armffa.rst 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. .. SPDX-License-Identifier: GPL-2.0+
  2. .. Copyright 2022-2023 Arm Limited and/or its affiliates <open-source-office@arm.com>
  3. armffa command
  4. ==============
  5. Synopsis
  6. --------
  7. ::
  8. armffa [sub-command] [arguments]
  9. sub-commands:
  10. getpart [partition UUID]
  11. lists the partition(s) info
  12. ping [partition ID]
  13. sends a data pattern to the specified partition
  14. devlist
  15. displays information about the FF-A device/driver
  16. Description
  17. -----------
  18. armffa is a command showcasing how to use the FF-A bus and how to invoke its operations.
  19. This provides a guidance to the client developers on how to call the FF-A bus interfaces.
  20. The command also allows to gather secure partitions information and ping these partitions.
  21. The command is also helpful in testing the communication with secure partitions.
  22. Example
  23. -------
  24. The following examples are run on Corstone-1000 platform.
  25. * ping
  26. ::
  27. corstone1000# armffa ping 0x8003
  28. SP response:
  29. [LSB]
  30. fffffffe
  31. 0
  32. 0
  33. 0
  34. 0
  35. * ping (failure case)
  36. ::
  37. corstone1000# armffa ping 0
  38. Sending direct request error (-22)
  39. * getpart
  40. ::
  41. corstone1000# armffa getpart 33d532ed-e699-0942-c09c-a798d9cd722d
  42. Partition: id = 8003 , exec_ctxt 1 , properties 3
  43. * getpart (failure case)
  44. ::
  45. corstone1000# armffa getpart 33d532ed-e699-0942-c09c-a798d9cd7221
  46. INVALID_PARAMETERS: Unrecognized UUID
  47. Failure in querying partitions count (error code: -22)
  48. * devlist
  49. ::
  50. corstone1000# armffa devlist
  51. device name arm_ffa, dev 00000000fdf41c30, driver name arm_ffa, ops 00000000fffc0e98
  52. Configuration
  53. -------------
  54. The command is available if CONFIG_CMD_ARMFFA=y and CONFIG_ARM_FFA_TRANSPORT=y.
  55. Return value
  56. ------------
  57. The return value $? is 0 (true) on success, 1 (false) on failure.