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