firmware: scmi: sandbox test for SCMI clocks
authorEtienne Carriere <etienne.carriere@linaro.org>
Wed, 9 Sep 2020 16:44:05 +0000 (18:44 +0200)
committerTom Rini <trini@konsulko.com>
Wed, 30 Sep 2020 15:55:23 +0000 (11:55 -0400)
Add tests for SCMI clocks. A test device driver sandbox-scmi_devices.c
is used to get clock resources, allowing further clock manipulation.

Change sandbox-smci_agent to emulate 3 clocks exposed through 2 agents.
Add DM test scmi_clocks to test these 3 clocks.
Update DM test sandbox_scmi_agent with load/remove test sequences
factorized by {load|remove}_sandbox_scmi_test_devices() helper functions.

Signed-off-by: Etienne Carriere <etienne.carriere@linaro.org>
Cc: Simon Glass <sjg@chromium.org>
Cc: Peng Fan <peng.fan@nxp.com>
Cc: Sudeep Holla <sudeep.holla@arm.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
arch/sandbox/dts/test.dts
arch/sandbox/include/asm/scmi_test.h
configs/sandbox_defconfig
drivers/firmware/scmi/Makefile
drivers/firmware/scmi/sandbox-scmi_agent.c
drivers/firmware/scmi/sandbox-scmi_devices.c [new file with mode: 0644]
test/dm/scmi.c

index 4769ec0..5ed364f 100644 (file)
                        compatible = "sandbox,scmi-agent";
                        #address-cells = <1>;
                        #size-cells = <0>;
+
+                       clk_scmi0: protocol@14 {
+                               reg = <0x14>;
+                               #clock-cells = <1>;
+                       };
                };
 
                sandbox-scmi-agent@1 {
                        #address-cells = <1>;
                        #size-cells = <0>;
 
+                       clk_scmi1: protocol@14 {
+                               reg = <0x14>;
+                               #clock-cells = <1>;
+                       };
+
                        protocol@10 {
                                reg = <0x10>;
                        };
                compatible = "sandbox,virtio2";
        };
 
+       sandbox_scmi {
+               compatible = "sandbox,scmi-devices";
+               clocks = <&clk_scmi0 7>, <&clk_scmi0 3>, <&clk_scmi1 1>;
+       };
+
        pinctrl {
                compatible = "sandbox,pinctrl";
 
index a811fe1..63093fd 100644 (file)
@@ -10,12 +10,28 @@ struct udevice;
 struct sandbox_scmi_agent;
 struct sandbox_scmi_service;
 
+/**
+ * struct sandbox_scmi_clk - Simulated clock exposed by SCMI
+ * @id:                Identifier of the clock used in the SCMI protocol
+ * @enabled:   Clock state: true if enabled, false if disabled
+ * @rate:      Clock rate in Hertz
+ */
+struct sandbox_scmi_clk {
+       uint id;
+       bool enabled;
+       ulong rate;
+};
+
 /**
  * struct sandbox_scmi_agent - Simulated SCMI service seen by SCMI agent
  * @idx:       Identifier for the SCMI agent, its index
+ * @clk:       Simulated clocks
+ * @clk_count: Simulated clocks array size
  */
 struct sandbox_scmi_agent {
        uint idx;
+       struct sandbox_scmi_clk *clk;
+       size_t clk_count;
 };
 
 /**
@@ -28,16 +44,39 @@ struct sandbox_scmi_service {
        size_t agent_count;
 };
 
+/**
+ * struct sandbox_scmi_devices - Reference to devices probed through SCMI
+ * @clk:               Array the clock devices
+ * @clk_count:         Number of clock devices probed
+ */
+struct sandbox_scmi_devices {
+       struct clk *clk;
+       size_t clk_count;
+};
+
 #ifdef CONFIG_SCMI_FIRMWARE
 /**
  * sandbox_scmi_service_context - Get the simulated SCMI services context
  * @return:    Reference to backend simulated resources state
  */
 struct sandbox_scmi_service *sandbox_scmi_service_ctx(void);
+
+/**
+ * sandbox_scmi_devices_get_ref - Get references to devices accessed through SCMI
+ * @dev:       Reference to the test device used get test resources
+ * @return:    Reference to the devices probed by the SCMI test
+ */
+struct sandbox_scmi_devices *sandbox_scmi_devices_ctx(struct udevice *dev);
 #else
 static inline struct sandbox_scmi_service *sandbox_scmi_service_ctx(void)
 {
        return NULL;
 }
+
+static inline
+struct sandbox_scmi_devices *sandbox_scmi_devices_ctx(struct udevice *dev)
+{
+       return NULL;
+}
 #endif /* CONFIG_SCMI_FIRMWARE */
 #endif /* __SANDBOX_SCMI_TEST_H */
index 2c130c0..7d71c80 100644 (file)
@@ -122,6 +122,7 @@ CONFIG_BUTTON=y
 CONFIG_BUTTON_GPIO=y
 CONFIG_CLK=y
 CONFIG_CLK_COMPOSITE_CCF=y
+CONFIG_CLK_SCMI=y
 CONFIG_SANDBOX_CLK_CCF=y
 CONFIG_CPU=y
 CONFIG_DM_DEMO=y
index 2f782bb..e1e0224 100644 (file)
@@ -2,4 +2,4 @@ obj-y   += scmi_agent-uclass.o
 obj-y  += smt.o
 obj-$(CONFIG_ARM_SMCCC)        += smccc_agent.o
 obj-$(CONFIG_DM_MAILBOX)       += mailbox_agent.o
-obj-$(CONFIG_SANDBOX)          += sandbox-scmi_agent.o
+obj-$(CONFIG_SANDBOX)          += sandbox-scmi_agent.o sandbox-scmi_devices.o
index 3179438..ff59098 100644 (file)
 /*
  * The sandbox SCMI agent driver simulates to some extend a SCMI message
  * processing. It simulates few of the SCMI services for some of the
- * SCMI protocols embedded in U-Boot. Currently none.
+ * SCMI protocols embedded in U-Boot. Currently:
+ * - SCMI clock protocol: emulate 2 agents each exposing few clocks
  *
- * This driver simulates 2 SCMI agents for test purpose.
+ * Agent #0 simulates 2 clocks.
+ * See IDs in scmi0_clk[] and "sandbox-scmi-agent@0" in test.dts.
+ *
+ * Agent #1 simulates 1 clock.
+ * See IDs in scmi1_clk[] and "sandbox-scmi-agent@1" in test.dts.
+ *
+ * All clocks are default disabled.
  *
  * This Driver exports sandbox_scmi_service_ct() for the test sequence to
  * get the state of the simulated services (clock state, rate, ...) and
  * check back-end device state reflects the request send through the
- * various uclass devices, currently nothing.
+ * various uclass devices, currently only clock controllers.
  */
 
 #define SANDBOX_SCMI_AGENT_COUNT       2
 
+static struct sandbox_scmi_clk scmi0_clk[] = {
+       { .id = 7, .rate = 1000 },
+       { .id = 3, .rate = 333 },
+};
+
+static struct sandbox_scmi_clk scmi1_clk[] = {
+       { .id = 1, .rate = 44 },
+};
+
 /* The list saves to simulted end devices references for test purpose */
 struct sandbox_scmi_agent *sandbox_scmi_agent_list[SANDBOX_SCMI_AGENT_COUNT];
 
@@ -46,17 +62,158 @@ static void debug_print_agent_state(struct udevice *dev, char *str)
        struct sandbox_scmi_agent *agent = dev_get_priv(dev);
 
        dev_dbg(dev, "Dump sandbox_scmi_agent %u: %s\n", agent->idx, str);
+       dev_dbg(dev, " scmi%u_clk   (%zu): %d/%ld, %d/%ld, %d/%ld, ...\n",
+               agent->idx,
+               agent->clk_count,
+               agent->clk_count ? agent->clk[0].enabled : -1,
+               agent->clk_count ? agent->clk[0].rate : -1,
+               agent->clk_count > 1 ? agent->clk[1].enabled : -1,
+               agent->clk_count > 1 ? agent->clk[1].rate : -1,
+               agent->clk_count > 2 ? agent->clk[2].enabled : -1,
+               agent->clk_count > 2 ? agent->clk[2].rate : -1);
 };
 
+static struct sandbox_scmi_clk *get_scmi_clk_state(uint agent_id, uint clock_id)
+{
+       struct sandbox_scmi_clk *target = NULL;
+       size_t target_count = 0;
+       size_t n;
+
+       switch (agent_id) {
+       case 0:
+               target = scmi0_clk;
+               target_count = ARRAY_SIZE(scmi0_clk);
+               break;
+       case 1:
+               target = scmi1_clk;
+               target_count = ARRAY_SIZE(scmi1_clk);
+               break;
+       default:
+               return NULL;
+       }
+
+       for (n = 0; n < target_count; n++)
+               if (target[n].id == clock_id)
+                       return target + n;
+
+       return NULL;
+}
+
+/*
+ * Sandbox SCMI agent ops
+ */
+
+static int sandbox_scmi_clock_rate_set(struct udevice *dev,
+                                      struct scmi_msg *msg)
+{
+       struct sandbox_scmi_agent *agent = dev_get_priv(dev);
+       struct scmi_clk_rate_set_in *in = NULL;
+       struct scmi_clk_rate_set_out *out = NULL;
+       struct sandbox_scmi_clk *clk_state = NULL;
+
+       if (!msg->in_msg || msg->in_msg_sz < sizeof(*in) ||
+           !msg->out_msg || msg->out_msg_sz < sizeof(*out))
+               return -EINVAL;
+
+       in = (struct scmi_clk_rate_set_in *)msg->in_msg;
+       out = (struct scmi_clk_rate_set_out *)msg->out_msg;
+
+       clk_state = get_scmi_clk_state(agent->idx, in->clock_id);
+       if (!clk_state) {
+               dev_err(dev, "Unexpected clock ID %u\n", in->clock_id);
+
+               out->status = SCMI_NOT_FOUND;
+       } else {
+               u64 rate = ((u64)in->rate_msb << 32) + in->rate_lsb;
+
+               clk_state->rate = (ulong)rate;
+
+               out->status = SCMI_SUCCESS;
+       }
+
+       return 0;
+}
+
+static int sandbox_scmi_clock_rate_get(struct udevice *dev,
+                                      struct scmi_msg *msg)
+{
+       struct sandbox_scmi_agent *agent = dev_get_priv(dev);
+       struct scmi_clk_rate_get_in *in = NULL;
+       struct scmi_clk_rate_get_out *out = NULL;
+       struct sandbox_scmi_clk *clk_state = NULL;
+
+       if (!msg->in_msg || msg->in_msg_sz < sizeof(*in) ||
+           !msg->out_msg || msg->out_msg_sz < sizeof(*out))
+               return -EINVAL;
+
+       in = (struct scmi_clk_rate_get_in *)msg->in_msg;
+       out = (struct scmi_clk_rate_get_out *)msg->out_msg;
+
+       clk_state = get_scmi_clk_state(agent->idx, in->clock_id);
+       if (!clk_state) {
+               dev_err(dev, "Unexpected clock ID %u\n", in->clock_id);
+
+               out->status = SCMI_NOT_FOUND;
+       } else {
+               out->rate_msb = (u32)((u64)clk_state->rate >> 32);
+               out->rate_lsb = (u32)clk_state->rate;
+
+               out->status = SCMI_SUCCESS;
+       }
+
+       return 0;
+}
+
+static int sandbox_scmi_clock_gate(struct udevice *dev, struct scmi_msg *msg)
+{
+       struct sandbox_scmi_agent *agent = dev_get_priv(dev);
+       struct scmi_clk_state_in *in = NULL;
+       struct scmi_clk_state_out *out = NULL;
+       struct sandbox_scmi_clk *clk_state = NULL;
+
+       if (!msg->in_msg || msg->in_msg_sz < sizeof(*in) ||
+           !msg->out_msg || msg->out_msg_sz < sizeof(*out))
+               return -EINVAL;
+
+       in = (struct scmi_clk_state_in *)msg->in_msg;
+       out = (struct scmi_clk_state_out *)msg->out_msg;
+
+       clk_state = get_scmi_clk_state(agent->idx, in->clock_id);
+       if (!clk_state) {
+               dev_err(dev, "Unexpected clock ID %u\n", in->clock_id);
+
+               out->status = SCMI_NOT_FOUND;
+       } else if (in->attributes > 1) {
+               out->status = SCMI_PROTOCOL_ERROR;
+       } else {
+               clk_state->enabled = in->attributes;
+
+               out->status = SCMI_SUCCESS;
+       }
+
+       return 0;
+}
+
 static int sandbox_scmi_test_process_msg(struct udevice *dev,
                                         struct scmi_msg *msg)
 {
        switch (msg->protocol_id) {
+       case SCMI_PROTOCOL_ID_CLOCK:
+               switch (msg->message_id) {
+               case SCMI_CLOCK_RATE_SET:
+                       return sandbox_scmi_clock_rate_set(dev, msg);
+               case SCMI_CLOCK_RATE_GET:
+                       return sandbox_scmi_clock_rate_get(dev, msg);
+               case SCMI_CLOCK_CONFIG_SET:
+                       return sandbox_scmi_clock_gate(dev, msg);
+               default:
+                       break;
+               }
+               break;
        case SCMI_PROTOCOL_ID_BASE:
        case SCMI_PROTOCOL_ID_POWER_DOMAIN:
        case SCMI_PROTOCOL_ID_SYSTEM:
        case SCMI_PROTOCOL_ID_PERF:
-       case SCMI_PROTOCOL_ID_CLOCK:
        case SCMI_PROTOCOL_ID_SENSOR:
        case SCMI_PROTOCOL_ID_RESET_DOMAIN:
                *(u32 *)msg->out_msg = SCMI_NOT_SUPPORTED;
@@ -101,11 +258,15 @@ static int sandbox_scmi_test_probe(struct udevice *dev)
        case '0':
                *agent = (struct sandbox_scmi_agent){
                        .idx = 0,
+                       .clk = scmi0_clk,
+                       .clk_count = ARRAY_SIZE(scmi0_clk),
                };
                break;
        case '1':
                *agent = (struct sandbox_scmi_agent){
                        .idx = 1,
+                       .clk = scmi1_clk,
+                       .clk_count = ARRAY_SIZE(scmi1_clk),
                };
                break;
        default:
diff --git a/drivers/firmware/scmi/sandbox-scmi_devices.c b/drivers/firmware/scmi/sandbox-scmi_devices.c
new file mode 100644 (file)
index 0000000..b3e411c
--- /dev/null
@@ -0,0 +1,75 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Copyright (C) 2020, Linaro Limited
+ */
+
+#include <common.h>
+#include <clk.h>
+#include <dm.h>
+#include <malloc.h>
+#include <asm/io.h>
+#include <asm/scmi_test.h>
+#include <dm/device_compat.h>
+
+/*
+ * Simulate to some extent a SCMI exchange.
+ * This drivers gets SCMI resources and offers API function to the
+ * SCMI test sequence manipulate the resources, currently clocks.
+ */
+
+#define SCMI_TEST_DEVICES_CLK_COUNT            3
+
+/*
+ * struct sandbox_scmi_device_priv - Storage for device handles used by test
+ * @clk:               Array of clock instances used by tests
+ * @devices:           Resources exposed by sandbox_scmi_devices_ctx()
+ */
+struct sandbox_scmi_device_priv {
+       struct clk clk[SCMI_TEST_DEVICES_CLK_COUNT];
+       struct sandbox_scmi_devices devices;
+};
+
+struct sandbox_scmi_devices *sandbox_scmi_devices_ctx(struct udevice *dev)
+{
+       struct sandbox_scmi_device_priv *priv = dev_get_priv(dev);
+
+       if (priv)
+               return &priv->devices;
+
+       return NULL;
+}
+
+static int sandbox_scmi_devices_probe(struct udevice *dev)
+{
+       struct sandbox_scmi_device_priv *priv = dev_get_priv(dev);
+       int ret;
+       size_t n;
+
+       priv->devices = (struct sandbox_scmi_devices){
+               .clk = priv->clk,
+               .clk_count = SCMI_TEST_DEVICES_CLK_COUNT,
+       };
+
+       for (n = 0; n < SCMI_TEST_DEVICES_CLK_COUNT; n++) {
+               ret = clk_get_by_index(dev, n, priv->devices.clk + n);
+               if (ret) {
+                       dev_err(dev, "%s: Failed on clk %zu\n", __func__, n);
+                       return ret;
+               }
+       }
+
+       return 0;
+}
+
+static const struct udevice_id sandbox_scmi_devices_ids[] = {
+       { .compatible = "sandbox,scmi-devices" },
+       { }
+};
+
+U_BOOT_DRIVER(sandbox_scmi_devices) = {
+       .name = "sandbox-scmi_devices",
+       .id = UCLASS_MISC,
+       .of_match = sandbox_scmi_devices_ids,
+       .priv_auto_alloc_size = sizeof(struct sandbox_scmi_device_priv),
+       .probe = sandbox_scmi_devices_probe,
+};
index d8c1e71..aa46f31 100644 (file)
  */
 
 #include <common.h>
+#include <clk.h>
 #include <dm.h>
 #include <asm/scmi_test.h>
 #include <dm/device-internal.h>
 #include <dm/test.h>
+#include <linux/kconfig.h>
 #include <test/ut.h>
 
+static int ut_assert_scmi_state_preprobe(struct unit_test_state *uts)
+{
+       struct sandbox_scmi_service *scmi_ctx = sandbox_scmi_service_ctx();
+
+       ut_assertnonnull(scmi_ctx);
+       if (scmi_ctx->agent_count)
+               ut_asserteq(2, scmi_ctx->agent_count);
+
+       return 0;
+}
+
+static int ut_assert_scmi_state_postprobe(struct unit_test_state *uts,
+                                         struct udevice *dev)
+{
+       struct sandbox_scmi_devices *scmi_devices;
+       struct sandbox_scmi_service *scmi_ctx;
+
+       /* Device references to check context against test sequence */
+       scmi_devices = sandbox_scmi_devices_ctx(dev);
+
+       ut_assertnonnull(scmi_devices);
+       if (IS_ENABLED(CONFIG_CLK_SCMI))
+               ut_asserteq(3, scmi_devices->clk_count);
+
+       /* State of the simulated SCMI server exposed */
+       scmi_ctx = sandbox_scmi_service_ctx();
+
+       ut_asserteq(2, scmi_ctx->agent_count);
+
+       ut_assertnonnull(scmi_ctx->agent[0]);
+       ut_asserteq(2, scmi_ctx->agent[0]->clk_count);
+       ut_assertnonnull(scmi_ctx->agent[0]->clk);
+
+       ut_assertnonnull(scmi_ctx->agent[1]);
+       ut_assertnonnull(scmi_ctx->agent[1]->clk);
+       ut_asserteq(1, scmi_ctx->agent[1]->clk_count);
+
+       return 0;
+}
+
+static int load_sandbox_scmi_test_devices(struct unit_test_state *uts,
+                                         struct udevice **dev)
+{
+       int ret;
+
+       ret = ut_assert_scmi_state_preprobe(uts);
+       if (ret)
+               return ret;
+
+       ut_assertok(uclass_get_device_by_name(UCLASS_MISC, "sandbox_scmi",
+                                             dev));
+       ut_assertnonnull(*dev);
+
+       return ut_assert_scmi_state_postprobe(uts, *dev);
+}
+
+static int release_sandbox_scmi_test_devices(struct unit_test_state *uts,
+                                            struct udevice *dev)
+{
+       ut_assertok(device_remove(dev, DM_REMOVE_NORMAL));
+
+       /* Not sure test devices are fully removed, agent may not be visible */
+       return 0;
+}
+
 /*
  * Test SCMI states when loading and releasing resources
  * related to SCMI drivers.
  */
 static int dm_test_scmi_sandbox_agent(struct unit_test_state *uts)
 {
-       struct sandbox_scmi_service *scmi_ctx = sandbox_scmi_service_ctx();
+       struct udevice *dev = NULL;
+       int ret;
 
-       ut_assertnonnull(scmi_ctx);
-       ut_asserteq(2, scmi_ctx->agent_count);
-       ut_assertnull(scmi_ctx->agent[0]);
-       ut_assertnull(scmi_ctx->agent[1]);
+       ret = load_sandbox_scmi_test_devices(uts, &dev);
+       if (!ret)
+               ret = release_sandbox_scmi_test_devices(uts, dev);
 
-       return 0;
+       return ret;
 }
 
 DM_TEST(dm_test_scmi_sandbox_agent, UT_TESTF_SCAN_FDT);
+
+static int dm_test_scmi_clocks(struct unit_test_state *uts)
+{
+       struct sandbox_scmi_devices *scmi_devices;
+       struct sandbox_scmi_service *scmi_ctx;
+       struct udevice *dev = NULL;
+       int ret_dev;
+       int ret;
+
+       if (!IS_ENABLED(CONFIG_CLK_SCMI))
+               return 0;
+
+       ret = load_sandbox_scmi_test_devices(uts, &dev);
+       if (ret)
+               return ret;
+
+       scmi_devices = sandbox_scmi_devices_ctx(dev);
+       scmi_ctx = sandbox_scmi_service_ctx();
+
+       /* Test SCMI clocks rate manipulation */
+       ut_asserteq(1000, clk_get_rate(&scmi_devices->clk[0]));
+       ut_asserteq(333, clk_get_rate(&scmi_devices->clk[1]));
+       ut_asserteq(44, clk_get_rate(&scmi_devices->clk[2]));
+
+       ret_dev = clk_set_rate(&scmi_devices->clk[1], 1088);
+       ut_assert(!ret_dev || ret_dev == 1088);
+
+       ut_asserteq(1000, scmi_ctx->agent[0]->clk[0].rate);
+       ut_asserteq(1088, scmi_ctx->agent[0]->clk[1].rate);
+       ut_asserteq(44, scmi_ctx->agent[1]->clk[0].rate);
+
+       ut_asserteq(1000, clk_get_rate(&scmi_devices->clk[0]));
+       ut_asserteq(1088, clk_get_rate(&scmi_devices->clk[1]));
+       ut_asserteq(44, clk_get_rate(&scmi_devices->clk[2]));
+
+       /* restore original rate for further tests */
+       ret_dev = clk_set_rate(&scmi_devices->clk[1], 333);
+       ut_assert(!ret_dev || ret_dev == 333);
+
+       /* Test SCMI clocks gating manipulation */
+       ut_assert(!scmi_ctx->agent[0]->clk[0].enabled);
+       ut_assert(!scmi_ctx->agent[0]->clk[1].enabled);
+       ut_assert(!scmi_ctx->agent[1]->clk[0].enabled);
+
+       ut_asserteq(0, clk_enable(&scmi_devices->clk[1]));
+       ut_asserteq(0, clk_enable(&scmi_devices->clk[2]));
+
+       ut_assert(!scmi_ctx->agent[0]->clk[0].enabled);
+       ut_assert(scmi_ctx->agent[0]->clk[1].enabled);
+       ut_assert(scmi_ctx->agent[1]->clk[0].enabled);
+
+       ut_assertok(clk_disable(&scmi_devices->clk[1]));
+       ut_assertok(clk_disable(&scmi_devices->clk[2]));
+
+       ut_assert(!scmi_ctx->agent[0]->clk[0].enabled);
+       ut_assert(!scmi_ctx->agent[0]->clk[1].enabled);
+       ut_assert(!scmi_ctx->agent[1]->clk[0].enabled);
+
+       return release_sandbox_scmi_test_devices(uts, dev);
+}
+
+DM_TEST(dm_test_scmi_clocks, UT_TESTF_SCAN_FDT);