On 3/29/22 17:16, abdellatif.elkhl...@arm.com wrote:
From: Abdellatif El Khlifi <abdellatif.elkhl...@arm.com>

Provide armffa command showcasing the use of the FF-A driver

The armffa command allows to query secure partitions data from
the secure world and exchanging messages with the partitions.

Signed-off-by: Abdellatif El Khlifi <abdellatif.elkhl...@arm.com>
Cc: Tom Rini <tr...@konsulko.com>
---
  MAINTAINERS             |   1 +
  cmd/Kconfig             |  10 ++
  cmd/Makefile            |   2 +
  cmd/armffa.c            | 266 ++++++++++++++++++++++++++++++++++++++++
  drivers/arm-ffa/Kconfig |   1 +

We want to have all commands to be documented in /doc/usage/cmd/.

Could you, please, provide the missing /doc/usage/cmd/armffa.rst file.

Best regards

Heinrich

  5 files changed, 280 insertions(+)
  create mode 100644 cmd/armffa.c

diff --git a/MAINTAINERS b/MAINTAINERS
index c5b608eb60..50ccd6a7ba 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -235,6 +235,7 @@ F:  include/configs/turris_*.h
  ARM FF-A
  M:    Abdellatif El Khlifi <abdellatif.elkhl...@arm.com>
  S:    Maintained
+F:     cmd/armffa.c
  F:    drivers/arm-ffa/
  F:    include/arm_ffa.h
  F:    include/arm_ffa_helper.h
diff --git a/cmd/Kconfig b/cmd/Kconfig
index 79219bcb74..de5bea1404 100644
--- a/cmd/Kconfig
+++ b/cmd/Kconfig
@@ -813,6 +813,16 @@ endmenu

  menu "Device access commands"

+config CMD_ARMFFA
+       bool "Arm FF-A test command"
+       depends on ARM_FFA_TRANSPORT
+       help
+         Provides a test command for the Arm FF-A driver
+         supported options:
+               - Listing the partition(s) info
+               - Sending a data pattern to the specified partition
+               - Displaying the arm_ffa device info
+
  config CMD_ARMFLASH
        #depends on FLASH_CFI_DRIVER
        bool "armflash"
diff --git a/cmd/Makefile b/cmd/Makefile
index ede634d731..2905ce63cf 100644
--- a/cmd/Makefile
+++ b/cmd/Makefile
@@ -12,6 +12,8 @@ obj-y += panic.o
  obj-y += version.o

  # command
+
+obj-$(CONFIG_CMD_ARMFFA) += armffa.o
  obj-$(CONFIG_CMD_ACPI) += acpi.o
  obj-$(CONFIG_CMD_ADDRMAP) += addrmap.o
  obj-$(CONFIG_CMD_AES) += aes.o
diff --git a/cmd/armffa.c b/cmd/armffa.c
new file mode 100644
index 0000000000..fcfc3a06bd
--- /dev/null
+++ b/cmd/armffa.c
@@ -0,0 +1,266 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * (C) Copyright 2022 ARM Limited
+ * Abdellatif El Khlifi <abdellatif.elkhl...@arm.com>
+ */
+
+#include <arm_ffa_helper.h>
+#include <asm/io.h>
+#include <common.h>
+#include <command.h>
+#include <dm.h>
+#include <mapmem.h>
+#include <stdlib.h>
+
+/**
+ * do_ffa_get_singular_partition_info - implementation of the getpart 
subcommand
+ * @cmdtp:             Command Table
+ * @flag:              flags
+ * @argc:              number of arguments
+ * @argv:              arguments
+ *
+ * This function queries the secure partition information which the UUID is 
provided
+ * as an argument. The function uses the arm_ffa driver helper function
+ * to retrieve the data.
+ * The input UUID string is expected to be in big endian format.
+ *
+ * Return:
+ *
+ * CMD_RET_SUCCESS: on success, otherwise failure
+ */
+static int do_ffa_get_singular_partition_info(struct cmd_tbl *cmdtp, int flag, 
int argc,
+                                             char *const argv[])
+{
+       struct ffa_interface_data func_data = {0};
+       u32 count = 0;
+       int ret;
+       union ffa_partition_uuid service_uuid = {0};
+       struct ffa_partition_info *parts_info;
+       u32 info_idx;
+
+       if (argc != 1)
+               return -EINVAL;
+
+       if (ffa_uuid_str_to_bin(argv[0], (unsigned char *)&service_uuid)) {
+               ffa_err("Invalid UUID");
+               return -EINVAL;
+       }
+
+       /*
+        * get from the driver the count of the SPs matching the UUID
+        */
+       func_data.data0_size = sizeof(service_uuid);
+       func_data.data0 = &service_uuid;
+       func_data.data1_size = sizeof(count);
+       func_data.data1 = &count;
+
+       ret = ffa_helper_get_partitions_info(&func_data);
+       if (ret != FFA_ERR_STAT_SUCCESS) {
+               ffa_err("Failure in querying partitions count (error code: 
%d)", ret);
+               return ret;
+       }
+
+       if (!count) {
+               ffa_info("No secure partition found");
+               return ret;
+       }
+
+       /*
+        * pre-allocate a buffer to be filled by the driver
+        * with  ffa_partition_info structs
+        */
+
+       parts_info = calloc(count, sizeof(struct ffa_partition_info));
+       if (!parts_info)
+               return -EINVAL;
+
+       ffa_info("Pre-allocating %d partition(s) info structures", count);
+
+       func_data.data1_size = count * sizeof(struct ffa_partition_info);
+       func_data.data1 = parts_info;
+
+       /*
+        * ask the driver to fill the buffer with the SPs info
+        */
+       ret = ffa_helper_get_partitions_info(&func_data);
+       if (ret != FFA_ERR_STAT_SUCCESS) {
+               ffa_err("Failure in querying partition(s) info (error code: 
%d)", ret);
+               free(parts_info);
+               return ret;
+       }
+
+       /*
+        * SPs found , show the partition information
+        */
+       for (info_idx = 0; info_idx < count ; info_idx++) {
+               ffa_info("Partition: id = 0x%x , exec_ctxt 0x%x , properties 
0x%x",
+                        parts_info[info_idx].id,
+                        parts_info[info_idx].exec_ctxt,
+                        parts_info[info_idx].properties);
+       }
+
+       free(parts_info);
+
+       return 0;
+}
+
+/**
+ * do_ffa_msg_send_direct_req - implementation of the ping subcommand
+ * @cmdtp:             Command Table
+ * @flag:              flags
+ * @argc:              number of arguments
+ * @argv:              arguments
+ *
+ * This function sends data to the secure partition which the ID is provided
+ * as an argument. The function uses the arm_ffa driver helper function
+ * to send data.
+ *
+ * Return:
+ *
+ * CMD_RET_SUCCESS: on success, otherwise failure
+ */
+int  do_ffa_msg_send_direct_req(struct cmd_tbl *cmdtp, int flag, int argc,
+                               char *const argv[])
+{
+       struct ffa_interface_data func_data = {0};
+       struct ffa_send_direct_data msg = {0};
+       u32 pattern = 0xaabbccd0;
+       u16 part_id;
+       int ret;
+
+       if (argc != 1)
+               return -EINVAL;
+
+       errno = 0;
+       part_id = strtoul(argv[0], NULL, 16);
+
+       if (errno) {
+               ffa_err("Invalid partition ID");
+               return -EINVAL;
+       }
+
+       /*
+        * telling the driver which partition to use
+        */
+       func_data.data0_size = sizeof(part_id);
+       func_data.data0 = &part_id;
+
+       /*
+        * filling the message data
+        */
+       msg.a3 = ++pattern;
+       msg.a4 = ++pattern;
+       msg.a5 = ++pattern;
+       msg.a6 = ++pattern;
+       msg.a7 = ++pattern;
+       func_data.data1_size = sizeof(msg);
+       func_data.data1 = &msg;
+
+       ret = ffa_helper_msg_send_direct_req(&func_data);
+       if (ret == FFA_ERR_STAT_SUCCESS) {
+               u8 cnt;
+
+               ffa_info("SP response:\n[LSB]");
+               for (cnt = 0;
+                    cnt < sizeof(struct ffa_send_direct_data) / sizeof(u32);
+                    cnt++)
+                       ffa_info("0x%x", ((u32 *)&msg)[cnt]);
+       } else {
+               ffa_err("Sending direct request error (%d)", ret);
+       }
+
+       return ret;
+}
+
+/**
+ *do_ffa_dev_list - implementation of the devlist subcommand
+ * @cmdtp: [in]                Command Table
+ * @flag:              flags
+ * @argc:              number of arguments
+ * @argv:              arguments
+ *
+ * This function queries the devices belonging to the UCLASS_FFA
+ * class. Currently, one device is expected to show up: the arm_ffa device
+ *
+ * Return:
+ *
+ * CMD_RET_SUCCESS: on success, otherwise failure
+ */
+int do_ffa_dev_list(struct cmd_tbl *cmdtp, int flag, int argc, char *const 
argv[])
+{
+       struct udevice *dev = NULL;
+       int i, ret;
+
+       ffa_info("arm_ffa uclass entries:");
+
+       for (i = 0, ret = uclass_first_device(UCLASS_FFA, &dev);
+            dev;
+            ret = uclass_next_device(&dev), i++) {
+               if (ret)
+                       break;
+
+               ffa_info("entry %d - instance %08x, ops %08x, plat %08x",
+                        i,
+                        (u32)map_to_sysmem(dev),
+                        (u32)map_to_sysmem(dev->driver->ops),
+                        (u32)map_to_sysmem(dev_get_plat(dev)));
+       }
+
+       return cmd_process_error(cmdtp, ret);
+}
+
+static struct cmd_tbl armffa_commands[] = {
+       U_BOOT_CMD_MKENT(getpart, 1, 1, do_ffa_get_singular_partition_info, "", 
""),
+       U_BOOT_CMD_MKENT(ping, 1, 1, do_ffa_msg_send_direct_req, "", ""),
+       U_BOOT_CMD_MKENT(devlist, 0, 1, do_ffa_dev_list, "", ""),
+};
+
+/**
+ * do_armffa - the armffa command main function
+ * @cmdtp:     Command Table
+ * @flag:              flags
+ * @argc:              number of arguments
+ * @argv:              arguments
+ *
+ * This function identifies which armffa subcommand to run.
+ * Then, it makes sure the arm_ffa device is probed and
+ * ready for use.
+ * Then, it runs the subcommand.
+ *
+ * Return:
+ *
+ * CMD_RET_SUCCESS: on success, otherwise failure
+ */
+static int do_armffa(struct cmd_tbl *cmdtp, int flag, int argc, char *const 
argv[])
+{
+       struct cmd_tbl *armffa_cmd;
+       int ret;
+
+       if (argc < 2)
+               return CMD_RET_USAGE;
+
+       armffa_cmd = find_cmd_tbl(argv[1], armffa_commands, 
ARRAY_SIZE(armffa_commands));
+
+       argc -= 2;
+       argv += 2;
+
+       if (!armffa_cmd || argc > armffa_cmd->maxargs)
+               return CMD_RET_USAGE;
+
+       ret = ffa_helper_init_device();
+       if (ret != FFA_ERR_STAT_SUCCESS)
+               return cmd_process_error(cmdtp, ret);
+
+       ret = armffa_cmd->cmd(armffa_cmd, flag, argc, argv);
+
+       return cmd_process_error(armffa_cmd, ret);
+}
+
+U_BOOT_CMD(armffa, 4, 1, do_armffa,
+          "Arm FF-A operations test command",
+          "getpart <partition UUID>\n"
+          "        - lists the partition(s) info\n"
+          "ping <partition ID>\n"
+          "        - sends a data pattern to the specified partition\n"
+          "devlist\n"
+          "        - displays the arm_ffa device info\n");
diff --git a/drivers/arm-ffa/Kconfig b/drivers/arm-ffa/Kconfig
index e503dfaebf..7b7cfe26b1 100644
--- a/drivers/arm-ffa/Kconfig
+++ b/drivers/arm-ffa/Kconfig
@@ -4,6 +4,7 @@ config ARM_FFA_TRANSPORT
        bool "Enable Arm Firmware Framework for Armv8-A driver"
        depends on DM && ARM64
        select ARM_SMCCC if ARM64
+       select CMD_ARMFFA
        select LIB_UUID
        select ARM_FFA_TRANSPORT_HELPERS
        help

Reply via email to