test/dm/scmi.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) 2020, Linaro Limited
   4  *
   5  * Tests scmi_agent uclass and the SCMI drivers implemented in other
   6  * uclass devices probe when a SCMI server exposes resources.
   7  *
   8  * Note in test.dts the protocol@10 node in scmi node. Protocol 0x10 is not
   9  * implemented in U-Boot SCMI components but the implementation is expected
  10  * to not complain on unknown protocol IDs, as long as it is not used. Note
  11  * in test.dts tests that SCMI drivers probing does not fail for such an
  12  * unknown SCMI protocol ID.
  13  */
  14
  15 #include <common.h>
  16 #include <clk.h>
  17 #include <dm.h>
  18 #include <reset.h>
  19 #include <scmi_agent.h>
  20 #include <scmi_agent-uclass.h>
  21 #include <scmi_protocols.h>
  22 #include <asm/scmi_test.h>
  23 #include <dm/device-internal.h>
  24 #include <dm/test.h>
  25 #include <linux/kconfig.h>
  26 #include <power/regulator.h>
  27 #include <test/ut.h>
  28
  29 static int ut_assert_scmi_state_postprobe(struct unit_test_state *uts,
  30                                           struct sandbox_scmi_agent *agent,
  31                                           struct udevice *dev)
  32 {
  33         struct sandbox_scmi_devices *scmi_devices;
  34
  35         /* Device references to check context against test sequence */
  36         scmi_devices = sandbox_scmi_devices_ctx(dev);
  37         ut_assertnonnull(scmi_devices);
  38         ut_asserteq(2, scmi_devices->clk_count);
  39         ut_asserteq(1, scmi_devices->reset_count);
  40         ut_asserteq(2, scmi_devices->regul_count);
  41
  42         /* State of the simulated SCMI server exposed */
  43         ut_asserteq(3, agent->clk_count);
  44         ut_assertnonnull(agent->clk);
  45         ut_asserteq(1, agent->reset_count);
  46         ut_assertnonnull(agent->reset);
  47         ut_asserteq(2, agent->voltd_count);
  48         ut_assertnonnull(agent->voltd);
  49
  50         return 0;
  51 }
  52
  53 static int load_sandbox_scmi_test_devices(struct unit_test_state *uts,
  54                                           struct sandbox_scmi_agent **ctx,
  55                                           struct udevice **dev)
  56 {
  57         struct udevice *agent_dev;
  58
  59         ut_assertok(uclass_get_device_by_name(UCLASS_SCMI_AGENT, "scmi",
  60                                               &agent_dev));
  61         ut_assertnonnull(agent_dev);
  62
  63         *ctx = sandbox_scmi_agent_ctx(agent_dev);
  64         ut_assertnonnull(*ctx);
  65
  66         /* probe */
  67         ut_assertok(uclass_get_device_by_name(UCLASS_MISC, "sandbox_scmi",
  68                                               dev));
  69         ut_assertnonnull(*dev);
  70
  71         return ut_assert_scmi_state_postprobe(uts, *ctx, *dev);
  72 }
  73
  74 static int release_sandbox_scmi_test_devices(struct unit_test_state *uts,
  75                                              struct udevice *dev)
  76 {
  77         /* un-probe */
  78         ut_assertok(device_remove(dev, DM_REMOVE_NORMAL));
  79
  80         return 0;
  81 }
  82
  83 /*
  84  * Test SCMI states when loading and releasing resources
  85  * related to SCMI drivers.
  86  */
  87 static int dm_test_scmi_sandbox_agent(struct unit_test_state *uts)
  88 {
  89         struct sandbox_scmi_agent *ctx;
  90         struct udevice *dev = NULL;
  91         int ret;
  92
  93         ret = load_sandbox_scmi_test_devices(uts, &ctx, &dev);
  94         if (!ret)
  95                 ret = release_sandbox_scmi_test_devices(uts, dev);
  96
  97         return ret;
  98 }
  99 DM_TEST(dm_test_scmi_sandbox_agent, UT_TESTF_SCAN_FDT);
 100
 101 static int dm_test_scmi_base(struct unit_test_state *uts)
 102 {
 103         struct udevice *agent_dev, *base;
 104         struct scmi_agent_priv *priv;
 105         u32 version, num_agents, num_protocols, impl_version;
 106         u32 attributes, agent_id;
 107         u8 *vendor, *agent_name, *protocols;
 108         int ret;
 109
 110         /* preparation */
 111         ut_assertok(uclass_get_device_by_name(UCLASS_SCMI_AGENT, "scmi",
 112                                               &agent_dev));
 113         ut_assertnonnull(agent_dev);
 114         ut_assertnonnull(priv = dev_get_uclass_plat(agent_dev));
 115         ut_assertnonnull(base = scmi_get_protocol(agent_dev,
 116                                                   SCMI_PROTOCOL_ID_BASE));
 117
 118         /* version */
 119         ret = scmi_base_protocol_version(base, &version);
 120         ut_assertok(ret);
 121         ut_asserteq(priv->version, version);
 122
 123         /* protocol attributes */
 124         ret = scmi_base_protocol_attrs(base, &num_agents, &num_protocols);
 125         ut_assertok(ret);
 126         ut_asserteq(priv->num_agents, num_agents);
 127         ut_asserteq(priv->num_protocols, num_protocols);
 128
 129         /* discover vendor */
 130         ret = scmi_base_discover_vendor(base, &vendor);
 131         ut_assertok(ret);
 132         ut_asserteq_str(priv->vendor, vendor);
 133         free(vendor);
 134
 135         /* message attributes */
 136         ret = scmi_base_protocol_message_attrs(base,
 137                                                SCMI_BASE_DISCOVER_SUB_VENDOR,
 138                                                &attributes);
 139         ut_assertok(ret);
 140         ut_assertok(attributes);
 141
 142         /* discover sub vendor */
 143         ret = scmi_base_discover_sub_vendor(base, &vendor);
 144         ut_assertok(ret);
 145         ut_asserteq_str(priv->sub_vendor, vendor);
 146         free(vendor);
 147
 148         /* impl version */
 149         ret = scmi_base_discover_impl_version(base, &impl_version);
 150         ut_assertok(ret);
 151         ut_asserteq(priv->impl_version, impl_version);
 152
 153         /* discover agent (my self) */
 154         ret = scmi_base_discover_agent(base, 0xffffffff, &agent_id,
 155                                        &agent_name);
 156         ut_assertok(ret);
 157         ut_asserteq(priv->agent_id, agent_id);
 158         ut_asserteq_str(priv->agent_name, agent_name);
 159         free(agent_name);
 160
 161         /* discover protocols */
 162         ret = scmi_base_discover_list_protocols(base, &protocols);
 163         ut_asserteq(num_protocols, ret);
 164         ut_asserteq_mem(priv->protocols, protocols, sizeof(u8) * num_protocols);
 165         free(protocols);
 166
 167         /*
 168          * NOTE: Sandbox SCMI driver handles device-0 only. It supports setting
 169          * access and protocol permissions, but doesn't allow unsetting them nor
 170          * resetting the configurations.
 171          */
 172         /* set device permissions */
 173         ret = scmi_base_set_device_permissions(base, agent_id, 0,
 174                                                SCMI_BASE_SET_DEVICE_PERMISSIONS_ACCESS);
 175         ut_assertok(ret); /* SCMI_SUCCESS */
 176         ret = scmi_base_set_device_permissions(base, agent_id, 1,
 177                                                SCMI_BASE_SET_DEVICE_PERMISSIONS_ACCESS);
 178         ut_asserteq(-ENOENT, ret); /* SCMI_NOT_FOUND */
 179         ret = scmi_base_set_device_permissions(base, agent_id, 0, 0);
 180         ut_asserteq(-EACCES, ret); /* SCMI_DENIED */
 181
 182         /* set protocol permissions */
 183         ret = scmi_base_set_protocol_permissions(base, agent_id, 0,
 184                                                  SCMI_PROTOCOL_ID_CLOCK,
 185                                                  SCMI_BASE_SET_PROTOCOL_PERMISSIONS_ACCESS);
 186         ut_assertok(ret); /* SCMI_SUCCESS */
 187         ret = scmi_base_set_protocol_permissions(base, agent_id, 1,
 188                                                  SCMI_PROTOCOL_ID_CLOCK,
 189                                                  SCMI_BASE_SET_PROTOCOL_PERMISSIONS_ACCESS);
 190         ut_asserteq(-ENOENT, ret); /* SCMI_NOT_FOUND */
 191         ret = scmi_base_set_protocol_permissions(base, agent_id, 0,
 192                                                  SCMI_PROTOCOL_ID_CLOCK, 0);
 193         ut_asserteq(-EACCES, ret); /* SCMI_DENIED */
 194
 195         /* reset agent configuration */
 196         ret = scmi_base_reset_agent_configuration(base, agent_id, 0);
 197         ut_asserteq(-EACCES, ret); /* SCMI_DENIED */
 198         ret = scmi_base_reset_agent_configuration(base, agent_id,
 199                                                   SCMI_BASE_RESET_ALL_ACCESS_PERMISSIONS);
 200         ut_asserteq(-EACCES, ret); /* SCMI_DENIED */
 201         ret = scmi_base_reset_agent_configuration(base, agent_id, 0);
 202         ut_asserteq(-EACCES, ret); /* SCMI_DENIED */
 203
 204         return 0;
 205 }
 206
 207 DM_TEST(dm_test_scmi_base, UT_TESTF_SCAN_FDT);
 208
 209 static int dm_test_scmi_power_domains(struct unit_test_state *uts)
 210 {
 211         struct sandbox_scmi_agent *agent;
 212         struct sandbox_scmi_devices *scmi_devices;
 213         struct udevice *agent_dev, *pwd, *dev;
 214         u32 version, count, attributes, pstate;
 215         u64 stats_addr;
 216         size_t stats_len;
 217         u8 *name;
 218         int ret;
 219
 220         if (!CONFIG_IS_ENABLED(SCMI_POWER_DOMAIN))
 221                 return -EAGAIN;
 222
 223         /* preparation */
 224         ut_assertok(load_sandbox_scmi_test_devices(uts, &agent, &dev));
 225         ut_assertnonnull(agent);
 226         scmi_devices = sandbox_scmi_devices_ctx(dev);
 227         ut_assertnonnull(scmi_devices);
 228         ut_asserteq(2, scmi_devices->pwdom->id); /* in test.dts */
 229
 230         ut_assertok(uclass_get_device_by_name(UCLASS_SCMI_AGENT, "scmi",
 231                                               &agent_dev));
 232         ut_assertnonnull(agent_dev);
 233         pwd = scmi_get_protocol(agent_dev, SCMI_PROTOCOL_ID_POWER_DOMAIN);
 234         ut_assertnonnull(pwd);
 235
 236         /*
 237          * SCMI Power domain management protocol interfaces
 238          */
 239         /* version */
 240         ret = scmi_generic_protocol_version(pwd, SCMI_PROTOCOL_ID_POWER_DOMAIN,
 241                                             &version);
 242         ut_assertok(ret);
 243         ut_asserteq(agent->pwdom_version, version);
 244
 245         /* protocol attributes */
 246         ret = scmi_pwd_protocol_attrs(pwd, &count, &stats_addr, &stats_len);
 247         ut_assertok(ret);
 248         ut_asserteq(agent->pwdom_count, count);
 249         ut_asserteq(0, stats_len);
 250
 251         /* protocol message attributes */
 252         ret = scmi_pwd_protocol_message_attrs(pwd, SCMI_PWD_STATE_SET,
 253                                               &attributes);
 254         ut_assertok(ret);
 255         ret = scmi_pwd_protocol_message_attrs(pwd, SCMI_PWD_STATE_NOTIFY,
 256                                               &attributes);
 257         ut_asserteq(-ENOENT, ret); /* the protocol not supported */
 258
 259         /* power domain attributes */
 260         ret = scmi_pwd_attrs(pwd, 0, &attributes, &name);
 261         ut_assertok(ret);
 262         ut_asserteq_str("power-domain--0", name);
 263         free(name);
 264
 265         ret = scmi_pwd_attrs(pwd, 10, &attributes, &name);
 266         ut_asserteq(-ENOENT, ret); /* domain-10 doesn't exist */
 267
 268         /* power domain state set/get */
 269         ret = scmi_pwd_state_set(pwd, 0, 0, 0);
 270         ut_assertok(ret);
 271         ret = scmi_pwd_state_get(pwd, 0, &pstate);
 272         ut_assertok(ret);
 273         ut_asserteq(0, pstate); /* ON */
 274
 275         ret = scmi_pwd_state_set(pwd, 0, 0, SCMI_PWD_PSTATE_TYPE_LOST);
 276         ut_assertok(ret);
 277         ret = scmi_pwd_state_get(pwd, 0, &pstate);
 278         ut_assertok(ret);
 279         ut_asserteq(SCMI_PWD_PSTATE_TYPE_LOST, pstate); /* OFF */
 280
 281         ret = scmi_pwd_state_set(pwd, 0, 10, 0);
 282         ut_asserteq(-ENOENT, ret);
 283
 284         /* power domain name get */
 285         ret = scmi_pwd_name_get(pwd, 0, &name);
 286         ut_assertok(ret);
 287         ut_asserteq_str("power-domain--0-extended", name);
 288         free(name);
 289
 290         ret = scmi_pwd_name_get(pwd, 10, &name);
 291         ut_asserteq(-ENOENT, ret); /* domain-10 doesn't exist */
 292
 293         /*
 294          * U-Boot driver model interfaces
 295          */
 296         /* power_domain_on */
 297         ret = power_domain_on(scmi_devices->pwdom);
 298         ut_assertok(ret);
 299         ret = scmi_pwd_state_get(pwd, scmi_devices->pwdom->id, &pstate);
 300         ut_assertok(ret);
 301         ut_asserteq(0, pstate); /* ON */
 302
 303         /* power_domain_off */
 304         ret = power_domain_off(scmi_devices->pwdom);
 305         ut_assertok(ret);
 306         ret = scmi_pwd_state_get(pwd, scmi_devices->pwdom->id, &pstate);
 307         ut_assertok(ret);
 308         ut_asserteq(SCMI_PWD_PSTATE_TYPE_LOST, pstate); /* OFF */
 309
 310         return release_sandbox_scmi_test_devices(uts, dev);
 311 }
 312
 313 DM_TEST(dm_test_scmi_power_domains, UT_TESTF_SCAN_FDT);
 314
 315 static int dm_test_scmi_clocks(struct unit_test_state *uts)
 316 {
 317         struct sandbox_scmi_agent *agent;
 318         struct sandbox_scmi_devices *scmi_devices;
 319         struct udevice *agent_dev, *clock_dev, *dev;
 320         int ret_dev;
 321         int ret;
 322
 323         if (!CONFIG_IS_ENABLED(CLK_SCMI))
 324                 return -EAGAIN;
 325
 326         ret = load_sandbox_scmi_test_devices(uts, &agent, &dev);
 327         if (ret)
 328                 return ret;
 329
 330         scmi_devices = sandbox_scmi_devices_ctx(dev);
 331         ut_assertnonnull(scmi_devices);
 332
 333         /* Sandbox SCMI clock protocol has its own channel */
 334         ut_assertok(uclass_get_device_by_name(UCLASS_SCMI_AGENT, "scmi",
 335                                               &agent_dev));
 336         ut_assertnonnull(agent_dev);
 337         clock_dev = scmi_get_protocol(agent_dev, SCMI_PROTOCOL_ID_CLOCK);
 338         ut_assertnonnull(clock_dev);
 339         ut_asserteq(0x14, sandbox_scmi_channel_id(clock_dev));
 340
 341         /* Test SCMI clocks rate manipulation */
 342         ut_asserteq(333, agent->clk[0].rate);
 343         ut_asserteq(200, agent->clk[1].rate);
 344         ut_asserteq(1000, agent->clk[2].rate);
 345
 346         ut_asserteq(1000, clk_get_rate(&scmi_devices->clk[0]));
 347         ut_asserteq(333, clk_get_rate(&scmi_devices->clk[1]));
 348
 349         ret_dev = clk_set_rate(&scmi_devices->clk[1], 1088);
 350         ut_assert(!ret_dev || ret_dev == 1088);
 351
 352         ut_asserteq(1088, agent->clk[0].rate);
 353         ut_asserteq(200, agent->clk[1].rate);
 354         ut_asserteq(1000, agent->clk[2].rate);
 355
 356         ut_asserteq(1000, clk_get_rate(&scmi_devices->clk[0]));
 357         ut_asserteq(1088, clk_get_rate(&scmi_devices->clk[1]));
 358
 359         /* restore original rate for further tests */
 360         ret_dev = clk_set_rate(&scmi_devices->clk[1], 333);
 361         ut_assert(!ret_dev || ret_dev == 333);
 362
 363         /* Test SCMI clocks gating manipulation */
 364         ut_assert(!agent->clk[0].enabled);
 365         ut_assert(!agent->clk[1].enabled);
 366         ut_assert(!agent->clk[2].enabled);
 367
 368         ut_asserteq(0, clk_enable(&scmi_devices->clk[1]));
 369
 370         ut_assert(agent->clk[0].enabled);
 371         ut_assert(!agent->clk[1].enabled);
 372         ut_assert(!agent->clk[2].enabled);
 373
 374         ut_assertok(clk_disable(&scmi_devices->clk[1]));
 375
 376         ut_assert(!agent->clk[0].enabled);
 377         ut_assert(!agent->clk[1].enabled);
 378         ut_assert(!agent->clk[2].enabled);
 379
 380         return release_sandbox_scmi_test_devices(uts, dev);
 381 }
 382 DM_TEST(dm_test_scmi_clocks, UT_TESTF_SCAN_FDT);
 383
 384 static int dm_test_scmi_resets(struct unit_test_state *uts)
 385 {
 386         struct sandbox_scmi_agent *agent;
 387         struct sandbox_scmi_devices *scmi_devices;
 388         struct udevice *agent_dev, *reset_dev, *dev = NULL;
 389         int ret;
 390
 391         if (!CONFIG_IS_ENABLED(RESET_SCMI))
 392                 return -EAGAIN;
 393
 394         ret = load_sandbox_scmi_test_devices(uts, &agent, &dev);
 395         if (ret)
 396                 return ret;
 397
 398         scmi_devices = sandbox_scmi_devices_ctx(dev);
 399         ut_assertnonnull(scmi_devices);
 400
 401         /* Sandbox SCMI reset protocol doesn't have its own channel */
 402         ut_assertok(uclass_get_device_by_name(UCLASS_SCMI_AGENT, "scmi",
 403                                               &agent_dev));
 404         ut_assertnonnull(agent_dev);
 405         reset_dev = scmi_get_protocol(agent_dev, SCMI_PROTOCOL_ID_RESET_DOMAIN);
 406         ut_assertnonnull(reset_dev);
 407         ut_asserteq(0x0, sandbox_scmi_channel_id(reset_dev));
 408
 409         /* Test SCMI resect controller manipulation */
 410         ut_assert(!agent->reset[0].asserted);
 411
 412         ut_assertok(reset_assert(&scmi_devices->reset[0]));
 413         ut_assert(agent->reset[0].asserted);
 414
 415         ut_assertok(reset_deassert(&scmi_devices->reset[0]));
 416         ut_assert(!agent->reset[0].asserted);
 417
 418         return release_sandbox_scmi_test_devices(uts, dev);
 419 }
 420 DM_TEST(dm_test_scmi_resets, UT_TESTF_SCAN_FDT);
 421
 422 static int dm_test_scmi_voltage_domains(struct unit_test_state *uts)
 423 {
 424         struct sandbox_scmi_agent *agent;
 425         struct sandbox_scmi_devices *scmi_devices;
 426         struct dm_regulator_uclass_plat *uc_pdata;
 427         struct udevice *dev;
 428         struct udevice *regul0_dev;
 429
 430         if (!CONFIG_IS_ENABLED(DM_REGULATOR_SCMI))
 431                 return -EAGAIN;
 432
 433         ut_assertok(load_sandbox_scmi_test_devices(uts, &agent, &dev));
 434
 435         scmi_devices = sandbox_scmi_devices_ctx(dev);
 436         ut_assertnonnull(scmi_devices);
 437
 438         /* Set/Get an SCMI voltage domain level */
 439         regul0_dev = scmi_devices->regul[0];
 440         ut_assert(regul0_dev);
 441
 442         uc_pdata = dev_get_uclass_plat(regul0_dev);
 443         ut_assert(uc_pdata);
 444
 445         ut_assertok(regulator_set_value(regul0_dev, uc_pdata->min_uV));
 446         ut_asserteq(agent->voltd[0].voltage_uv, uc_pdata->min_uV);
 447
 448         ut_assert(regulator_get_value(regul0_dev) == uc_pdata->min_uV);
 449
 450         ut_assertok(regulator_set_value(regul0_dev, uc_pdata->max_uV));
 451         ut_asserteq(agent->voltd[0].voltage_uv, uc_pdata->max_uV);
 452
 453         ut_assert(regulator_get_value(regul0_dev) == uc_pdata->max_uV);
 454
 455         /* Enable/disable SCMI voltage domains */
 456         ut_assertok(regulator_set_enable(scmi_devices->regul[0], false));
 457         ut_assertok(regulator_set_enable(scmi_devices->regul[1], false));
 458         ut_assert(!agent->voltd[0].enabled);
 459         ut_assert(!agent->voltd[1].enabled);
 460
 461         ut_assertok(regulator_set_enable(scmi_devices->regul[0], true));
 462         ut_assert(agent->voltd[0].enabled);
 463         ut_assert(!agent->voltd[1].enabled);
 464
 465         ut_assertok(regulator_set_enable(scmi_devices->regul[1], true));
 466         ut_assert(agent->voltd[0].enabled);
 467         ut_assert(agent->voltd[1].enabled);
 468
 469         ut_assertok(regulator_set_enable(scmi_devices->regul[0], false));
 470         ut_assert(!agent->voltd[0].enabled);
 471         ut_assert(agent->voltd[1].enabled);
 472
 473         return release_sandbox_scmi_test_devices(uts, dev);
 474 }
 475 DM_TEST(dm_test_scmi_voltage_domains, UT_TESTF_SCAN_FDT);