[kvm-unit-tests PATCH v4 09/13] arm/arm64: ITS: Commands

[Eric Auger]

Implement main ITS commands. The code is largely inherited from
the ITS driver.

Signed-off-by: Eric Auger <address@hidden>

---

v3 -> v4:
- device's itt now is a VGA
- pass verbose to choose whether we shall print the cmd
- use printf instead of report_info

v2 -> v3:
- do not use report() anymore
- assert if cmd_write exceeds the queue capacity

v1 -> v2:
- removed its_print_cmd_state
---
 arm/Makefile.arm64         |   2 +-
 lib/arm64/asm/gic-v3-its.h |  57 +++++
 lib/arm64/gic-v3-its-cmd.c | 463 +++++++++++++++++++++++++++++++++++++
 3 files changed, 521 insertions(+), 1 deletion(-)
 create mode 100644 lib/arm64/gic-v3-its-cmd.c

diff --git a/arm/Makefile.arm64 b/arm/Makefile.arm64
index 60182ae..dfd0c56 100644
--- a/arm/Makefile.arm64
+++ b/arm/Makefile.arm64
@@ -19,7 +19,7 @@ endef
 cstart.o = $(TEST_DIR)/cstart64.o
 cflatobjs += lib/arm64/processor.o
 cflatobjs += lib/arm64/spinlock.o
-cflatobjs += lib/arm64/gic-v3-its.o
+cflatobjs += lib/arm64/gic-v3-its.o lib/arm64/gic-v3-its-cmd.o
 
 OBJDIRS += lib/arm64
 
diff --git a/lib/arm64/asm/gic-v3-its.h b/lib/arm64/asm/gic-v3-its.h
index 3da548b..889d6ce 100644
--- a/lib/arm64/asm/gic-v3-its.h
+++ b/lib/arm64/asm/gic-v3-its.h
@@ -102,6 +102,28 @@ extern struct its_data its_data;
 #define GITS_BASER_TYPE_DEVICE         1
 #define GITS_BASER_TYPE_COLLECTION     4
 
+/*
+ * ITS commands
+ */
+#define GITS_CMD_MAPD                  0x08
+#define GITS_CMD_MAPC                  0x09
+#define GITS_CMD_MAPTI                 0x0a
+/* older GIC documentation used MAPVI for this command */
+#define GITS_CMD_MAPVI                 GITS_CMD_MAPTI
+#define GITS_CMD_MAPI                  0x0b
+#define GITS_CMD_MOVI                  0x01
+#define GITS_CMD_DISCARD               0x0f
+#define GITS_CMD_INV                   0x0c
+#define GITS_CMD_MOVALL                        0x0e
+#define GITS_CMD_INVALL                        0x0d
+#define GITS_CMD_INT                   0x03
+#define GITS_CMD_CLEAR                 0x04
+#define GITS_CMD_SYNC                  0x05
+
+struct its_cmd_block {
+       u64 raw_cmd[4];
+};
+
 extern void its_parse_typer(void);
 extern void its_init(void);
 extern int its_baser_lookup(int i, struct its_baser *baser);
@@ -109,4 +131,39 @@ extern void its_enable_defaults(void);
 extern struct its_device *its_create_device(u32 dev_id, int nr_ites);
 extern struct its_collection *its_create_collection(u32 col_id, u32 target_pe);
 
+extern void __its_send_mapd(struct its_device *dev, int valid, bool verbose);
+extern void __its_send_mapc(struct its_collection *col, int valid, bool 
verbose);
+extern void __its_send_mapti(struct its_device *dev, u32 irq_id, u32 event_id,
+                            struct its_collection *col, bool verbose);
+extern void __its_send_int(struct its_device *dev, u32 event_id, bool verbose);
+extern void __its_send_inv(struct its_device *dev, u32 event_id, bool verbose);
+extern void __its_send_discard(struct its_device *dev, u32 event_id, bool 
verbose);
+extern void __its_send_clear(struct its_device *dev, u32 event_id, bool 
verbose);
+extern void __its_send_invall(struct its_collection *col, bool verbose);
+extern void __its_send_movi(struct its_device *dev, struct its_collection *col,
+                           u32 id, bool verbose);
+extern void __its_send_sync(struct its_collection *col, bool verbose);
+
+#define its_send_mapd(dev, valid)                      __its_send_mapd(dev, 
valid, true)
+#define its_send_mapc(col, valid)                      __its_send_mapc(col, 
valid, true)
+#define its_send_mapti(dev, irqid, eventid, col)       __its_send_mapti(dev, 
irqid, eventid, col, true)
+#define its_send_int(dev, eventid)                     __its_send_int(dev, 
eventid, true)
+#define its_send_inv(dev, eventid)                     __its_send_inv(dev, 
eventid, true)
+#define its_send_discard(dev, eventid)                 __its_send_discard(dev, 
eventid, true)
+#define its_send_clear(dev, eventid)                   __its_send_clear(dev, 
eventid, true)
+#define its_send_invall(col)                           __its_send_invall(col, 
true)
+#define its_send_movi(dev, col, id)                    __its_send_movi(dev, 
col, id, true)
+#define its_send_sync(col)                             __its_send_sync(col, 
true)
+
+#define its_send_mapd_nv(dev, valid)                   __its_send_mapd(dev, 
valid, false)
+#define its_send_mapc_nv(col, valid)                   __its_send_mapc(col, 
valid, false)
+#define its_send_mapti_nv(dev, irqid, eventid, col)    __its_send_mapti(dev, 
irqid, eventid, col, false)
+#define its_send_int_nv(dev, eventid)                  __its_send_int(dev, 
eventid, false)
+#define its_send_inv_nv(dev, eventid)                  __its_send_inv(dev, 
eventid, false)
+#define its_send_discard_nv(dev, eventid)              __its_send_discard(dev, 
eventid, false)
+#define its_send_clear_nv(dev, eventid)                        
__its_send_clear(dev, eventidn false)
+#define its_send_invall_nv(col)                                
__its_send_invall(col, false)
+#define its_send_movi_nv(dev, col, id)                 __its_send_movi(dev, 
col, id, false)
+#define its_send_sync_nv(col)                          __its_send_sync(col, 
false)
+
 #endif /* _ASMARM64_GIC_V3_ITS_H_ */
diff --git a/lib/arm64/gic-v3-its-cmd.c b/lib/arm64/gic-v3-its-cmd.c
new file mode 100644
index 0000000..f3cbe46
--- /dev/null
+++ b/lib/arm64/gic-v3-its-cmd.c
@@ -0,0 +1,463 @@
+/*
+ * Copyright (C) 2020, Red Hat Inc, Eric Auger <address@hidden>
+ *
+ * Most of the code is copy-pasted from:
+ * drivers/irqchip/irq-gic-v3-its.c
+ * This work is licensed under the terms of the GNU LGPL, version 2.
+ */
+#include <asm/io.h>
+#include <asm/gic.h>
+#include <asm/gic-v3-its.h>
+
+#define ITS_ITT_ALIGN          SZ_256
+
+static const char * const its_cmd_string[] = {
+       [GITS_CMD_MAPD]         = "MAPD",
+       [GITS_CMD_MAPC]         = "MAPC",
+       [GITS_CMD_MAPTI]        = "MAPTI",
+       [GITS_CMD_MAPI]         = "MAPI",
+       [GITS_CMD_MOVI]         = "MOVI",
+       [GITS_CMD_DISCARD]      = "DISCARD",
+       [GITS_CMD_INV]          = "INV",
+       [GITS_CMD_MOVALL]       = "MOVALL",
+       [GITS_CMD_INVALL]       = "INVALL",
+       [GITS_CMD_INT]          = "INT",
+       [GITS_CMD_CLEAR]        = "CLEAR",
+       [GITS_CMD_SYNC]         = "SYNC",
+};
+
+struct its_cmd_desc {
+       union {
+               struct {
+                       struct its_device *dev;
+                       u32 event_id;
+               } its_inv_cmd;
+
+               struct {
+                       struct its_device *dev;
+                       u32 event_id;
+               } its_int_cmd;
+
+               struct {
+                       struct its_device *dev;
+                       bool valid;
+               } its_mapd_cmd;
+
+               struct {
+                       struct its_collection *col;
+                       bool valid;
+               } its_mapc_cmd;
+
+               struct {
+                       struct its_device *dev;
+                       u32 phys_id;
+                       u32 event_id;
+                       u32 col_id;
+               } its_mapti_cmd;
+
+               struct {
+                       struct its_device *dev;
+                       struct its_collection *col;
+                       u32 event_id;
+               } its_movi_cmd;
+
+               struct {
+                       struct its_device *dev;
+                       u32 event_id;
+               } its_discard_cmd;
+
+               struct {
+                       struct its_device *dev;
+                       u32 event_id;
+               } its_clear_cmd;
+
+               struct {
+                       struct its_collection *col;
+               } its_invall_cmd;
+
+               struct {
+                       struct its_collection *col;
+               } its_sync_cmd;
+       };
+       bool verbose;
+};
+
+typedef void (*its_cmd_builder_t)(struct its_cmd_block *,
+                                 struct its_cmd_desc *);
+
+/* ITS COMMANDS */
+
+static void its_encode_cmd(struct its_cmd_block *cmd, u8 cmd_nr)
+{
+       cmd->raw_cmd[0] &= ~0xffUL;
+       cmd->raw_cmd[0] |= cmd_nr;
+}
+
+static void its_encode_devid(struct its_cmd_block *cmd, u32 devid)
+{
+       cmd->raw_cmd[0] &= BIT_ULL(32) - 1;
+       cmd->raw_cmd[0] |= ((u64)devid) << 32;
+}
+
+static void its_encode_event_id(struct its_cmd_block *cmd, u32 id)
+{
+       cmd->raw_cmd[1] &= ~0xffffffffUL;
+       cmd->raw_cmd[1] |= id;
+}
+
+static void its_encode_phys_id(struct its_cmd_block *cmd, u32 phys_id)
+{
+       cmd->raw_cmd[1] &= 0xffffffffUL;
+       cmd->raw_cmd[1] |= ((u64)phys_id) << 32;
+}
+
+static void its_encode_size(struct its_cmd_block *cmd, u8 size)
+{
+       cmd->raw_cmd[1] &= ~0x1fUL;
+       cmd->raw_cmd[1] |= size & 0x1f;
+}
+
+static void its_encode_itt(struct its_cmd_block *cmd, u64 itt_addr)
+{
+       cmd->raw_cmd[2] &= ~0xffffffffffffUL;
+       cmd->raw_cmd[2] |= itt_addr & 0xffffffffff00UL;
+}
+
+static void its_encode_valid(struct its_cmd_block *cmd, int valid)
+{
+       cmd->raw_cmd[2] &= ~(1UL << 63);
+       cmd->raw_cmd[2] |= ((u64)!!valid) << 63;
+}
+
+static void its_encode_target(struct its_cmd_block *cmd, u64 target_addr)
+{
+       cmd->raw_cmd[2] &= ~(0xfffffffffUL << 16);
+       cmd->raw_cmd[2] |= (target_addr & (0xffffffffUL << 16));
+}
+
+static void its_encode_collection(struct its_cmd_block *cmd, u16 col)
+{
+       cmd->raw_cmd[2] &= ~0xffffUL;
+       cmd->raw_cmd[2] |= col;
+}
+
+static inline void its_fixup_cmd(struct its_cmd_block *cmd)
+{
+       /* Let's fixup BE commands */
+       cmd->raw_cmd[0] = cpu_to_le64(cmd->raw_cmd[0]);
+       cmd->raw_cmd[1] = cpu_to_le64(cmd->raw_cmd[1]);
+       cmd->raw_cmd[2] = cpu_to_le64(cmd->raw_cmd[2]);
+       cmd->raw_cmd[3] = cpu_to_le64(cmd->raw_cmd[3]);
+}
+
+static u64 its_cmd_ptr_to_offset(struct its_cmd_block *ptr)
+{
+       return (ptr - its_data.cmd_base) * sizeof(*ptr);
+}
+
+static struct its_cmd_block *its_post_commands(void)
+{
+       u64 wr = its_cmd_ptr_to_offset(its_data.cmd_write);
+
+       writeq(wr, its_data.base + GITS_CWRITER);
+       return its_data.cmd_write;
+}
+
+static struct its_cmd_block *its_allocate_entry(void)
+{
+       struct its_cmd_block *cmd;
+
+       assert((u64)its_data.cmd_write < (u64)its_data.cmd_base + SZ_64K);
+       cmd = its_data.cmd_write++;
+       return cmd;
+}
+
+static void its_wait_for_range_completion(struct its_cmd_block *from,
+                                         struct its_cmd_block *to)
+{
+       u64 rd_idx, from_idx, to_idx;
+       u32 count = 1000000;    /* 1s! */
+
+       from_idx = its_cmd_ptr_to_offset(from);
+       to_idx = its_cmd_ptr_to_offset(to);
+       while (1) {
+               rd_idx = readq(its_data.base + GITS_CREADR);
+               if (rd_idx >= to_idx || rd_idx < from_idx)
+                       break;
+
+               count--;
+               if (!count) {
+                       unsigned int cmd_id = from->raw_cmd[0] & 0xFF;
+
+                       assert_msg(false, "%s timeout!",
+                              cmd_id <= 0xF ? its_cmd_string[cmd_id] :
+                              "Unexpected");
+               }
+               udelay(1);
+       }
+}
+
+static void its_send_single_command(its_cmd_builder_t builder,
+                                   struct its_cmd_desc *desc)
+{
+       struct its_cmd_block *cmd, *next_cmd;
+
+       cmd = its_allocate_entry();
+       builder(cmd, desc);
+       next_cmd = its_post_commands();
+
+       its_wait_for_range_completion(cmd, next_cmd);
+}
+
+
+static void its_build_mapd_cmd(struct its_cmd_block *cmd,
+                              struct its_cmd_desc *desc)
+{
+       unsigned long itt_addr;
+       u8 size = 12; /* 4096 eventids */
+
+       itt_addr = (unsigned long)(virt_to_phys(desc->its_mapd_cmd.dev->itt));
+       itt_addr = ALIGN(itt_addr, ITS_ITT_ALIGN);
+
+       its_encode_cmd(cmd, GITS_CMD_MAPD);
+       its_encode_devid(cmd, desc->its_mapd_cmd.dev->device_id);
+       its_encode_size(cmd, size - 1);
+       its_encode_itt(cmd, itt_addr);
+       its_encode_valid(cmd, desc->its_mapd_cmd.valid);
+       its_fixup_cmd(cmd);
+       if (desc->verbose)
+               printf("ITS: MAPD devid=%d size = 0x%x itt=0x%lx valid=%d\n",
+                       desc->its_mapd_cmd.dev->device_id,
+                       size, itt_addr, desc->its_mapd_cmd.valid);
+
+}
+
+static void its_build_mapc_cmd(struct its_cmd_block *cmd,
+                              struct its_cmd_desc *desc)
+{
+       its_encode_cmd(cmd, GITS_CMD_MAPC);
+       its_encode_collection(cmd, desc->its_mapc_cmd.col->col_id);
+       its_encode_target(cmd, desc->its_mapc_cmd.col->target_address);
+       its_encode_valid(cmd, desc->its_mapc_cmd.valid);
+       its_fixup_cmd(cmd);
+       if (desc->verbose)
+               printf("MAPC col_id=%d target_addr = 0x%lx valid=%d\n",
+                      desc->its_mapc_cmd.col->col_id,
+                      desc->its_mapc_cmd.col->target_address,
+                      desc->its_mapc_cmd.valid);
+}
+
+static void its_build_mapti_cmd(struct its_cmd_block *cmd,
+                               struct its_cmd_desc *desc)
+{
+       its_encode_cmd(cmd, GITS_CMD_MAPTI);
+       its_encode_devid(cmd, desc->its_mapti_cmd.dev->device_id);
+       its_encode_event_id(cmd, desc->its_mapti_cmd.event_id);
+       its_encode_phys_id(cmd, desc->its_mapti_cmd.phys_id);
+       its_encode_collection(cmd, desc->its_mapti_cmd.col_id);
+       its_fixup_cmd(cmd);
+       if (desc->verbose)
+               printf("MAPTI dev_id=%d event_id=%d -> phys_id=%d, col_id=%d\n",
+                      desc->its_mapti_cmd.dev->device_id,
+                      desc->its_mapti_cmd.event_id,
+                      desc->its_mapti_cmd.phys_id,
+                      desc->its_mapti_cmd.col_id);
+}
+
+static void its_build_invall_cmd(struct its_cmd_block *cmd,
+                             struct its_cmd_desc *desc)
+{
+       its_encode_cmd(cmd, GITS_CMD_INVALL);
+       its_encode_collection(cmd, desc->its_invall_cmd.col->col_id);
+       its_fixup_cmd(cmd);
+       if (desc->verbose)
+               printf("INVALL col_id=%d\n", desc->its_invall_cmd.col->col_id);
+}
+
+static void its_build_clear_cmd(struct its_cmd_block *cmd,
+                               struct its_cmd_desc *desc)
+{
+       its_encode_cmd(cmd, GITS_CMD_CLEAR);
+       its_encode_devid(cmd, desc->its_clear_cmd.dev->device_id);
+       its_encode_event_id(cmd, desc->its_clear_cmd.event_id);
+       its_fixup_cmd(cmd);
+       if (desc->verbose)
+               printf("CLEAR col_id=%d\n", desc->its_invall_cmd.col->col_id);
+}
+
+static void its_build_discard_cmd(struct its_cmd_block *cmd,
+                                 struct its_cmd_desc *desc)
+{
+       its_encode_cmd(cmd, GITS_CMD_DISCARD);
+       its_encode_devid(cmd, desc->its_discard_cmd.dev->device_id);
+       its_encode_event_id(cmd, desc->its_discard_cmd.event_id);
+       its_fixup_cmd(cmd);
+       if (desc->verbose)
+               printf("DISCARD col_id=%d\n", desc->its_invall_cmd.col->col_id);
+}
+
+static void its_build_inv_cmd(struct its_cmd_block *cmd,
+                             struct its_cmd_desc *desc)
+{
+       its_encode_cmd(cmd, GITS_CMD_INV);
+       its_encode_devid(cmd, desc->its_inv_cmd.dev->device_id);
+       its_encode_event_id(cmd, desc->its_inv_cmd.event_id);
+       its_fixup_cmd(cmd);
+       if (desc->verbose)
+               printf("INV dev_id=%d event_id=%d\n",
+                      desc->its_inv_cmd.dev->device_id,
+                      desc->its_inv_cmd.event_id);
+}
+
+static void its_build_int_cmd(struct its_cmd_block *cmd,
+                             struct its_cmd_desc *desc)
+{
+       its_encode_cmd(cmd, GITS_CMD_INT);
+       its_encode_devid(cmd, desc->its_int_cmd.dev->device_id);
+       its_encode_event_id(cmd, desc->its_int_cmd.event_id);
+       its_fixup_cmd(cmd);
+       if (desc->verbose)
+               printf("INT dev_id=%d event_id=%d\n",
+                      desc->its_int_cmd.dev->device_id,
+                      desc->its_int_cmd.event_id);
+}
+
+static void its_build_sync_cmd(struct its_cmd_block *cmd,
+                              struct its_cmd_desc *desc)
+{
+       its_encode_cmd(cmd, GITS_CMD_SYNC);
+       its_encode_target(cmd, desc->its_sync_cmd.col->target_address);
+       its_fixup_cmd(cmd);
+       if (desc->verbose)
+               printf("SYNC target_addr = 0x%lx\n",
+                      desc->its_sync_cmd.col->target_address);
+}
+
+static void its_build_movi_cmd(struct its_cmd_block *cmd,
+                              struct its_cmd_desc *desc)
+{
+       its_encode_cmd(cmd, GITS_CMD_MOVI);
+       its_encode_devid(cmd, desc->its_movi_cmd.dev->device_id);
+       its_encode_event_id(cmd, desc->its_movi_cmd.event_id);
+       its_encode_collection(cmd, desc->its_movi_cmd.col->col_id);
+       its_fixup_cmd(cmd);
+       if (desc->verbose)
+               printf("MOVI dev_id=%d event_id = %d col_id=%d\n",
+                      desc->its_movi_cmd.dev->device_id,
+                      desc->its_movi_cmd.event_id,
+                      desc->its_movi_cmd.col->col_id);
+}
+
+void __its_send_mapd(struct its_device *dev, int valid, bool verbose)
+{
+       struct its_cmd_desc desc;
+
+       desc.its_mapd_cmd.dev = dev;
+       desc.its_mapd_cmd.valid = !!valid;
+       desc.verbose = verbose;
+
+       its_send_single_command(its_build_mapd_cmd, &desc);
+}
+
+void __its_send_mapc(struct its_collection *col, int valid, bool verbose)
+{
+       struct its_cmd_desc desc;
+
+       desc.its_mapc_cmd.col = col;
+       desc.its_mapc_cmd.valid = !!valid;
+       desc.verbose = verbose;
+
+       its_send_single_command(its_build_mapc_cmd, &desc);
+}
+
+void __its_send_mapti(struct its_device *dev, u32 irq_id,
+                     u32 event_id, struct its_collection *col, bool verbose)
+{
+       struct its_cmd_desc desc;
+
+       desc.its_mapti_cmd.dev = dev;
+       desc.its_mapti_cmd.phys_id = irq_id;
+       desc.its_mapti_cmd.event_id = event_id;
+       desc.its_mapti_cmd.col_id = col->col_id;
+       desc.verbose = verbose;
+
+       its_send_single_command(its_build_mapti_cmd, &desc);
+}
+
+void __its_send_int(struct its_device *dev, u32 event_id, bool verbose)
+{
+       struct its_cmd_desc desc;
+
+       desc.its_int_cmd.dev = dev;
+       desc.its_int_cmd.event_id = event_id;
+       desc.verbose = verbose;
+
+       its_send_single_command(its_build_int_cmd, &desc);
+}
+
+void __its_send_movi(struct its_device *dev, struct its_collection *col,
+                    u32 id, bool verbose)
+{
+       struct its_cmd_desc desc;
+
+       desc.its_movi_cmd.dev = dev;
+       desc.its_movi_cmd.col = col;
+       desc.its_movi_cmd.event_id = id;
+       desc.verbose = verbose;
+
+       its_send_single_command(its_build_movi_cmd, &desc);
+}
+
+void __its_send_invall(struct its_collection *col, bool verbose)
+{
+       struct its_cmd_desc desc;
+
+       desc.its_invall_cmd.col = col;
+       desc.verbose = verbose;
+
+       its_send_single_command(its_build_invall_cmd, &desc);
+}
+
+void __its_send_inv(struct its_device *dev, u32 event_id, bool verbose)
+{
+       struct its_cmd_desc desc;
+
+       desc.its_inv_cmd.dev = dev;
+       desc.its_inv_cmd.event_id = event_id;
+       desc.verbose = verbose;
+
+       its_send_single_command(its_build_inv_cmd, &desc);
+}
+
+void __its_send_discard(struct its_device *dev, u32 event_id, bool verbose)
+{
+       struct its_cmd_desc desc;
+
+       desc.its_discard_cmd.dev = dev;
+       desc.its_discard_cmd.event_id = event_id;
+       desc.verbose = verbose;
+
+       its_send_single_command(its_build_discard_cmd, &desc);
+}
+
+void __its_send_clear(struct its_device *dev, u32 event_id, bool verbose)
+{
+       struct its_cmd_desc desc;
+
+       desc.its_clear_cmd.dev = dev;
+       desc.its_clear_cmd.event_id = event_id;
+       desc.verbose = verbose;
+
+       its_send_single_command(its_build_clear_cmd, &desc);
+}
+
+void __its_send_sync(struct its_collection *col, bool verbose)
+{
+       struct its_cmd_desc desc;
+
+       desc.its_sync_cmd.col = col;
+       desc.verbose = verbose;
+
+       its_send_single_command(its_build_sync_cmd, &desc);
+}
+
-- 
2.20.1