drivers/firmware/xilinx/zynqmp.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Xilinx Zynq MPSoC Firmware layer
   4  *
   5  *  Copyright (C) 2014-2022 Xilinx, Inc.
   6  *
   7  *  Michal Simek <[email protected]>
   8  *  Davorin Mista <[email protected]>
   9  *  Jolly Shah <[email protected]>
  10  *  Rajan Vaja <[email protected]>
  11  */
  12
  13 #include <linux/arm-smccc.h>
  14 #include <linux/compiler.h>
  15 #include <linux/device.h>
  16 #include <linux/init.h>
  17 #include <linux/mfd/core.h>
  18 #include <linux/module.h>
  19 #include <linux/of.h>
  20 #include <linux/of_platform.h>
  21 #include <linux/slab.h>
  22 #include <linux/uaccess.h>
  23 #include <linux/hashtable.h>
  24
  25 #include <linux/firmware/xlnx-zynqmp.h>
  26 #include <linux/firmware/xlnx-event-manager.h>
  27 #include "zynqmp-debug.h"
  28
  29 /* Max HashMap Order for PM API feature check (1<<7 = 128) */
  30 #define PM_API_FEATURE_CHECK_MAX_ORDER  7
  31
  32 /* CRL registers and bitfields */
  33 #define CRL_APB_BASE                    0xFF5E0000U
  34 /* BOOT_PIN_CTRL- Used to control the mode pins after boot */
  35 #define CRL_APB_BOOT_PIN_CTRL           (CRL_APB_BASE + (0x250U))
  36 /* BOOT_PIN_CTRL_MASK- out_val[11:8], out_en[3:0] */
  37 #define CRL_APB_BOOTPIN_CTRL_MASK       0xF0FU
  38
  39 /* IOCTL/QUERY feature payload size */
  40 #define FEATURE_PAYLOAD_SIZE            2
  41
  42 /* Firmware feature check version mask */
  43 #define FIRMWARE_VERSION_MASK           GENMASK(15, 0)
  44
  45 static bool feature_check_enabled;
  46 static DEFINE_HASHTABLE(pm_api_features_map, PM_API_FEATURE_CHECK_MAX_ORDER);
  47 static u32 ioctl_features[FEATURE_PAYLOAD_SIZE];
  48 static u32 query_features[FEATURE_PAYLOAD_SIZE];
  49
  50 static struct platform_device *em_dev;
  51
  52 /**
  53  * struct zynqmp_devinfo - Structure for Zynqmp device instance
  54  * @dev:                Device Pointer
  55  * @feature_conf_id:    Feature conf id
  56  */
  57 struct zynqmp_devinfo {
  58         struct device *dev;
  59         u32 feature_conf_id;
  60 };
  61
  62 /**
  63  * struct pm_api_feature_data - PM API Feature data
  64  * @pm_api_id:          PM API Id, used as key to index into hashmap
  65  * @feature_status:     status of PM API feature: valid, invalid
  66  * @hentry:             hlist_node that hooks this entry into hashtable
  67  */
  68 struct pm_api_feature_data {
  69         u32 pm_api_id;
  70         int feature_status;
  71         struct hlist_node hentry;
  72 };
  73
  74 static const struct mfd_cell firmware_devs[] = {
  75         {
  76                 .name = "zynqmp_power_controller",
  77         },
  78 };
  79
  80 /**
  81  * zynqmp_pm_ret_code() - Convert PMU-FW error codes to Linux error codes
  82  * @ret_status:         PMUFW return code
  83  *
  84  * Return: corresponding Linux error code
  85  */
  86 static int zynqmp_pm_ret_code(u32 ret_status)
  87 {
  88         switch (ret_status) {
  89         case XST_PM_SUCCESS:
  90         case XST_PM_DOUBLE_REQ:
  91                 return 0;
  92         case XST_PM_NO_FEATURE:
  93                 return -ENOTSUPP;
  94         case XST_PM_NO_ACCESS:
  95                 return -EACCES;
  96         case XST_PM_ABORT_SUSPEND:
  97                 return -ECANCELED;
  98         case XST_PM_MULT_USER:
  99                 return -EUSERS;
 100         case XST_PM_INTERNAL:
 101         case XST_PM_CONFLICT:
 102         case XST_PM_INVALID_NODE:
 103         default:
 104                 return -EINVAL;
 105         }
 106 }
 107
 108 static noinline int do_fw_call_fail(u64 arg0, u64 arg1, u64 arg2,
 109                                     u32 *ret_payload)
 110 {
 111         return -ENODEV;
 112 }
 113
 114 /*
 115  * PM function call wrapper
 116  * Invoke do_fw_call_smc or do_fw_call_hvc, depending on the configuration
 117  */
 118 static int (*do_fw_call)(u64, u64, u64, u32 *ret_payload) = do_fw_call_fail;
 119
 120 /**
 121  * do_fw_call_smc() - Call system-level platform management layer (SMC)
 122  * @arg0:               Argument 0 to SMC call
 123  * @arg1:               Argument 1 to SMC call
 124  * @arg2:               Argument 2 to SMC call
 125  * @ret_payload:        Returned value array
 126  *
 127  * Invoke platform management function via SMC call (no hypervisor present).
 128  *
 129  * Return: Returns status, either success or error+reason
 130  */
 131 static noinline int do_fw_call_smc(u64 arg0, u64 arg1, u64 arg2,
 132                                    u32 *ret_payload)
 133 {
 134         struct arm_smccc_res res;
 135
 136         arm_smccc_smc(arg0, arg1, arg2, 0, 0, 0, 0, 0, &res);
 137
 138         if (ret_payload) {
 139                 ret_payload[0] = lower_32_bits(res.a0);
 140                 ret_payload[1] = upper_32_bits(res.a0);
 141                 ret_payload[2] = lower_32_bits(res.a1);
 142                 ret_payload[3] = upper_32_bits(res.a1);
 143         }
 144
 145         return zynqmp_pm_ret_code((enum pm_ret_status)res.a0);
 146 }
 147
 148 /**
 149  * do_fw_call_hvc() - Call system-level platform management layer (HVC)
 150  * @arg0:               Argument 0 to HVC call
 151  * @arg1:               Argument 1 to HVC call
 152  * @arg2:               Argument 2 to HVC call
 153  * @ret_payload:        Returned value array
 154  *
 155  * Invoke platform management function via HVC
 156  * HVC-based for communication through hypervisor
 157  * (no direct communication with ATF).
 158  *
 159  * Return: Returns status, either success or error+reason
 160  */
 161 static noinline int do_fw_call_hvc(u64 arg0, u64 arg1, u64 arg2,
 162                                    u32 *ret_payload)
 163 {
 164         struct arm_smccc_res res;
 165
 166         arm_smccc_hvc(arg0, arg1, arg2, 0, 0, 0, 0, 0, &res);
 167
 168         if (ret_payload) {
 169                 ret_payload[0] = lower_32_bits(res.a0);
 170                 ret_payload[1] = upper_32_bits(res.a0);
 171                 ret_payload[2] = lower_32_bits(res.a1);
 172                 ret_payload[3] = upper_32_bits(res.a1);
 173         }
 174
 175         return zynqmp_pm_ret_code((enum pm_ret_status)res.a0);
 176 }
 177
 178 static int __do_feature_check_call(const u32 api_id, u32 *ret_payload)
 179 {
 180         int ret;
 181         u64 smc_arg[2];
 182
 183         smc_arg[0] = PM_SIP_SVC | PM_FEATURE_CHECK;
 184         smc_arg[1] = api_id;
 185
 186         ret = do_fw_call(smc_arg[0], smc_arg[1], 0, ret_payload);
 187         if (ret)
 188                 ret = -EOPNOTSUPP;
 189         else
 190                 ret = ret_payload[1];
 191
 192         return ret;
 193 }
 194
 195 static int do_feature_check_call(const u32 api_id)
 196 {
 197         int ret;
 198         u32 ret_payload[PAYLOAD_ARG_CNT];
 199         struct pm_api_feature_data *feature_data;
 200
 201         /* Check for existing entry in hash table for given api */
 202         hash_for_each_possible(pm_api_features_map, feature_data, hentry,
 203                                api_id) {
 204                 if (feature_data->pm_api_id == api_id)
 205                         return feature_data->feature_status;
 206         }
 207
 208         /* Add new entry if not present */
 209         feature_data = kmalloc(sizeof(*feature_data), GFP_KERNEL);
 210         if (!feature_data)
 211                 return -ENOMEM;
 212
 213         feature_data->pm_api_id = api_id;
 214         ret = __do_feature_check_call(api_id, ret_payload);
 215
 216         feature_data->feature_status = ret;
 217         hash_add(pm_api_features_map, &feature_data->hentry, api_id);
 218
 219         if (api_id == PM_IOCTL)
 220                 /* Store supported IOCTL IDs mask */
 221                 memcpy(ioctl_features, &ret_payload[2], FEATURE_PAYLOAD_SIZE * 4);
 222         else if (api_id == PM_QUERY_DATA)
 223                 /* Store supported QUERY IDs mask */
 224                 memcpy(query_features, &ret_payload[2], FEATURE_PAYLOAD_SIZE * 4);
 225
 226         return ret;
 227 }
 228 EXPORT_SYMBOL_GPL(zynqmp_pm_feature);
 229
 230 /**
 231  * zynqmp_pm_feature() - Check whether given feature is supported or not and
 232  *                       store supported IOCTL/QUERY ID mask
 233  * @api_id:             API ID to check
 234  *
 235  * Return: Returns status, either success or error+reason
 236  */
 237 int zynqmp_pm_feature(const u32 api_id)
 238 {
 239         int ret;
 240
 241         if (!feature_check_enabled)
 242                 return 0;
 243
 244         ret = do_feature_check_call(api_id);
 245
 246         return ret;
 247 }
 248
 249 /**
 250  * zynqmp_pm_is_function_supported() - Check whether given IOCTL/QUERY function
 251  *                                     is supported or not
 252  * @api_id:             PM_IOCTL or PM_QUERY_DATA
 253  * @id:                 IOCTL or QUERY function IDs
 254  *
 255  * Return: Returns status, either success or error+reason
 256  */
 257 int zynqmp_pm_is_function_supported(const u32 api_id, const u32 id)
 258 {
 259         int ret;
 260         u32 *bit_mask;
 261
 262         /* Input arguments validation */
 263         if (id >= 64 || (api_id != PM_IOCTL && api_id != PM_QUERY_DATA))
 264                 return -EINVAL;
 265
 266         /* Check feature check API version */
 267         ret = do_feature_check_call(PM_FEATURE_CHECK);
 268         if (ret < 0)
 269                 return ret;
 270
 271         /* Check if feature check version 2 is supported or not */
 272         if ((ret & FIRMWARE_VERSION_MASK) == PM_API_VERSION_2) {
 273                 /*
 274                  * Call feature check for IOCTL/QUERY API to get IOCTL ID or
 275                  * QUERY ID feature status.
 276                  */
 277                 ret = do_feature_check_call(api_id);
 278                 if (ret < 0)
 279                         return ret;
 280
 281                 bit_mask = (api_id == PM_IOCTL) ? ioctl_features : query_features;
 282
 283                 if ((bit_mask[(id / 32)] & BIT((id % 32))) == 0U)
 284                         return -EOPNOTSUPP;
 285         } else {
 286                 return -ENODATA;
 287         }
 288
 289         return 0;
 290 }
 291 EXPORT_SYMBOL_GPL(zynqmp_pm_is_function_supported);
 292
 293 /**
 294  * zynqmp_pm_invoke_fn() - Invoke the system-level platform management layer
 295  *                         caller function depending on the configuration
 296  * @pm_api_id:          Requested PM-API call
 297  * @arg0:               Argument 0 to requested PM-API call
 298  * @arg1:               Argument 1 to requested PM-API call
 299  * @arg2:               Argument 2 to requested PM-API call
 300  * @arg3:               Argument 3 to requested PM-API call
 301  * @ret_payload:        Returned value array
 302  *
 303  * Invoke platform management function for SMC or HVC call, depending on
 304  * configuration.
 305  * Following SMC Calling Convention (SMCCC) for SMC64:
 306  * Pm Function Identifier,
 307  * PM_SIP_SVC + PM_API_ID =
 308  *      ((SMC_TYPE_FAST << FUNCID_TYPE_SHIFT)
 309  *      ((SMC_64) << FUNCID_CC_SHIFT)
 310  *      ((SIP_START) << FUNCID_OEN_SHIFT)
 311  *      ((PM_API_ID) & FUNCID_NUM_MASK))
 312  *
 313  * PM_SIP_SVC   - Registered ZynqMP SIP Service Call.
 314  * PM_API_ID    - Platform Management API ID.
 315  *
 316  * Return: Returns status, either success or error+reason
 317  */
 318 int zynqmp_pm_invoke_fn(u32 pm_api_id, u32 arg0, u32 arg1,
 319                         u32 arg2, u32 arg3, u32 *ret_payload)
 320 {
 321         /*
 322          * Added SIP service call Function Identifier
 323          * Make sure to stay in x0 register
 324          */
 325         u64 smc_arg[4];
 326         int ret;
 327
 328         /* Check if feature is supported or not */
 329         ret = zynqmp_pm_feature(pm_api_id);
 330         if (ret < 0)
 331                 return ret;
 332
 333         smc_arg[0] = PM_SIP_SVC | pm_api_id;
 334         smc_arg[1] = ((u64)arg1 << 32) | arg0;
 335         smc_arg[2] = ((u64)arg3 << 32) | arg2;
 336
 337         return do_fw_call(smc_arg[0], smc_arg[1], smc_arg[2], ret_payload);
 338 }
 339
 340 static u32 pm_api_version;
 341 static u32 pm_tz_version;
 342
 343 int zynqmp_pm_register_sgi(u32 sgi_num, u32 reset)
 344 {
 345         int ret;
 346
 347         ret = zynqmp_pm_invoke_fn(TF_A_PM_REGISTER_SGI, sgi_num, reset, 0, 0,
 348                                   NULL);
 349         if (!ret)
 350                 return ret;
 351
 352         /* try old implementation as fallback strategy if above fails */
 353         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_REGISTER_SGI, sgi_num,
 354                                    reset, NULL);
 355 }
 356
 357 /**
 358  * zynqmp_pm_get_api_version() - Get version number of PMU PM firmware
 359  * @version:    Returned version value
 360  *
 361  * Return: Returns status, either success or error+reason
 362  */
 363 int zynqmp_pm_get_api_version(u32 *version)
 364 {
 365         u32 ret_payload[PAYLOAD_ARG_CNT];
 366         int ret;
 367
 368         if (!version)
 369                 return -EINVAL;
 370
 371         /* Check is PM API version already verified */
 372         if (pm_api_version > 0) {
 373                 *version = pm_api_version;
 374                 return 0;
 375         }
 376         ret = zynqmp_pm_invoke_fn(PM_GET_API_VERSION, 0, 0, 0, 0, ret_payload);
 377         *version = ret_payload[1];
 378
 379         return ret;
 380 }
 381 EXPORT_SYMBOL_GPL(zynqmp_pm_get_api_version);
 382
 383 /**
 384  * zynqmp_pm_get_chipid - Get silicon ID registers
 385  * @idcode:     IDCODE register
 386  * @version:    version register
 387  *
 388  * Return:      Returns the status of the operation and the idcode and version
 389  *              registers in @idcode and @version.
 390  */
 391 int zynqmp_pm_get_chipid(u32 *idcode, u32 *version)
 392 {
 393         u32 ret_payload[PAYLOAD_ARG_CNT];
 394         int ret;
 395
 396         if (!idcode || !version)
 397                 return -EINVAL;
 398
 399         ret = zynqmp_pm_invoke_fn(PM_GET_CHIPID, 0, 0, 0, 0, ret_payload);
 400         *idcode = ret_payload[1];
 401         *version = ret_payload[2];
 402
 403         return ret;
 404 }
 405 EXPORT_SYMBOL_GPL(zynqmp_pm_get_chipid);
 406
 407 /**
 408  * zynqmp_pm_get_trustzone_version() - Get secure trustzone firmware version
 409  * @version:    Returned version value
 410  *
 411  * Return: Returns status, either success or error+reason
 412  */
 413 static int zynqmp_pm_get_trustzone_version(u32 *version)
 414 {
 415         u32 ret_payload[PAYLOAD_ARG_CNT];
 416         int ret;
 417
 418         if (!version)
 419                 return -EINVAL;
 420
 421         /* Check is PM trustzone version already verified */
 422         if (pm_tz_version > 0) {
 423                 *version = pm_tz_version;
 424                 return 0;
 425         }
 426         ret = zynqmp_pm_invoke_fn(PM_GET_TRUSTZONE_VERSION, 0, 0,
 427                                   0, 0, ret_payload);
 428         *version = ret_payload[1];
 429
 430         return ret;
 431 }
 432
 433 /**
 434  * get_set_conduit_method() - Choose SMC or HVC based communication
 435  * @np:         Pointer to the device_node structure
 436  *
 437  * Use SMC or HVC-based functions to communicate with EL2/EL3.
 438  *
 439  * Return: Returns 0 on success or error code
 440  */
 441 static int get_set_conduit_method(struct device_node *np)
 442 {
 443         const char *method;
 444
 445         if (of_property_read_string(np, "method", &method)) {
 446                 pr_warn("%s missing \"method\" property\n", __func__);
 447                 return -ENXIO;
 448         }
 449
 450         if (!strcmp("hvc", method)) {
 451                 do_fw_call = do_fw_call_hvc;
 452         } else if (!strcmp("smc", method)) {
 453                 do_fw_call = do_fw_call_smc;
 454         } else {
 455                 pr_warn("%s Invalid \"method\" property: %s\n",
 456                         __func__, method);
 457                 return -EINVAL;
 458         }
 459
 460         return 0;
 461 }
 462
 463 /**
 464  * zynqmp_pm_query_data() - Get query data from firmware
 465  * @qdata:      Variable to the zynqmp_pm_query_data structure
 466  * @out:        Returned output value
 467  *
 468  * Return: Returns status, either success or error+reason
 469  */
 470 int zynqmp_pm_query_data(struct zynqmp_pm_query_data qdata, u32 *out)
 471 {
 472         int ret;
 473
 474         ret = zynqmp_pm_invoke_fn(PM_QUERY_DATA, qdata.qid, qdata.arg1,
 475                                   qdata.arg2, qdata.arg3, out);
 476
 477         /*
 478          * For clock name query, all bytes in SMC response are clock name
 479          * characters and return code is always success. For invalid clocks,
 480          * clock name bytes would be zeros.
 481          */
 482         return qdata.qid == PM_QID_CLOCK_GET_NAME ? 0 : ret;
 483 }
 484 EXPORT_SYMBOL_GPL(zynqmp_pm_query_data);
 485
 486 /**
 487  * zynqmp_pm_clock_enable() - Enable the clock for given id
 488  * @clock_id:   ID of the clock to be enabled
 489  *
 490  * This function is used by master to enable the clock
 491  * including peripherals and PLL clocks.
 492  *
 493  * Return: Returns status, either success or error+reason
 494  */
 495 int zynqmp_pm_clock_enable(u32 clock_id)
 496 {
 497         return zynqmp_pm_invoke_fn(PM_CLOCK_ENABLE, clock_id, 0, 0, 0, NULL);
 498 }
 499 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_enable);
 500
 501 /**
 502  * zynqmp_pm_clock_disable() - Disable the clock for given id
 503  * @clock_id:   ID of the clock to be disable
 504  *
 505  * This function is used by master to disable the clock
 506  * including peripherals and PLL clocks.
 507  *
 508  * Return: Returns status, either success or error+reason
 509  */
 510 int zynqmp_pm_clock_disable(u32 clock_id)
 511 {
 512         return zynqmp_pm_invoke_fn(PM_CLOCK_DISABLE, clock_id, 0, 0, 0, NULL);
 513 }
 514 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_disable);
 515
 516 /**
 517  * zynqmp_pm_clock_getstate() - Get the clock state for given id
 518  * @clock_id:   ID of the clock to be queried
 519  * @state:      1/0 (Enabled/Disabled)
 520  *
 521  * This function is used by master to get the state of clock
 522  * including peripherals and PLL clocks.
 523  *
 524  * Return: Returns status, either success or error+reason
 525  */
 526 int zynqmp_pm_clock_getstate(u32 clock_id, u32 *state)
 527 {
 528         u32 ret_payload[PAYLOAD_ARG_CNT];
 529         int ret;
 530
 531         ret = zynqmp_pm_invoke_fn(PM_CLOCK_GETSTATE, clock_id, 0,
 532                                   0, 0, ret_payload);
 533         *state = ret_payload[1];
 534
 535         return ret;
 536 }
 537 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_getstate);
 538
 539 /**
 540  * zynqmp_pm_clock_setdivider() - Set the clock divider for given id
 541  * @clock_id:   ID of the clock
 542  * @divider:    divider value
 543  *
 544  * This function is used by master to set divider for any clock
 545  * to achieve desired rate.
 546  *
 547  * Return: Returns status, either success or error+reason
 548  */
 549 int zynqmp_pm_clock_setdivider(u32 clock_id, u32 divider)
 550 {
 551         return zynqmp_pm_invoke_fn(PM_CLOCK_SETDIVIDER, clock_id, divider,
 552                                    0, 0, NULL);
 553 }
 554 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_setdivider);
 555
 556 /**
 557  * zynqmp_pm_clock_getdivider() - Get the clock divider for given id
 558  * @clock_id:   ID of the clock
 559  * @divider:    divider value
 560  *
 561  * This function is used by master to get divider values
 562  * for any clock.
 563  *
 564  * Return: Returns status, either success or error+reason
 565  */
 566 int zynqmp_pm_clock_getdivider(u32 clock_id, u32 *divider)
 567 {
 568         u32 ret_payload[PAYLOAD_ARG_CNT];
 569         int ret;
 570
 571         ret = zynqmp_pm_invoke_fn(PM_CLOCK_GETDIVIDER, clock_id, 0,
 572                                   0, 0, ret_payload);
 573         *divider = ret_payload[1];
 574
 575         return ret;
 576 }
 577 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_getdivider);
 578
 579 /**
 580  * zynqmp_pm_clock_setrate() - Set the clock rate for given id
 581  * @clock_id:   ID of the clock
 582  * @rate:       rate value in hz
 583  *
 584  * This function is used by master to set rate for any clock.
 585  *
 586  * Return: Returns status, either success or error+reason
 587  */
 588 int zynqmp_pm_clock_setrate(u32 clock_id, u64 rate)
 589 {
 590         return zynqmp_pm_invoke_fn(PM_CLOCK_SETRATE, clock_id,
 591                                    lower_32_bits(rate),
 592                                    upper_32_bits(rate),
 593                                    0, NULL);
 594 }
 595 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_setrate);
 596
 597 /**
 598  * zynqmp_pm_clock_getrate() - Get the clock rate for given id
 599  * @clock_id:   ID of the clock
 600  * @rate:       rate value in hz
 601  *
 602  * This function is used by master to get rate
 603  * for any clock.
 604  *
 605  * Return: Returns status, either success or error+reason
 606  */
 607 int zynqmp_pm_clock_getrate(u32 clock_id, u64 *rate)
 608 {
 609         u32 ret_payload[PAYLOAD_ARG_CNT];
 610         int ret;
 611
 612         ret = zynqmp_pm_invoke_fn(PM_CLOCK_GETRATE, clock_id, 0,
 613                                   0, 0, ret_payload);
 614         *rate = ((u64)ret_payload[2] << 32) | ret_payload[1];
 615
 616         return ret;
 617 }
 618 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_getrate);
 619
 620 /**
 621  * zynqmp_pm_clock_setparent() - Set the clock parent for given id
 622  * @clock_id:   ID of the clock
 623  * @parent_id:  parent id
 624  *
 625  * This function is used by master to set parent for any clock.
 626  *
 627  * Return: Returns status, either success or error+reason
 628  */
 629 int zynqmp_pm_clock_setparent(u32 clock_id, u32 parent_id)
 630 {
 631         return zynqmp_pm_invoke_fn(PM_CLOCK_SETPARENT, clock_id,
 632                                    parent_id, 0, 0, NULL);
 633 }
 634 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_setparent);
 635
 636 /**
 637  * zynqmp_pm_clock_getparent() - Get the clock parent for given id
 638  * @clock_id:   ID of the clock
 639  * @parent_id:  parent id
 640  *
 641  * This function is used by master to get parent index
 642  * for any clock.
 643  *
 644  * Return: Returns status, either success or error+reason
 645  */
 646 int zynqmp_pm_clock_getparent(u32 clock_id, u32 *parent_id)
 647 {
 648         u32 ret_payload[PAYLOAD_ARG_CNT];
 649         int ret;
 650
 651         ret = zynqmp_pm_invoke_fn(PM_CLOCK_GETPARENT, clock_id, 0,
 652                                   0, 0, ret_payload);
 653         *parent_id = ret_payload[1];
 654
 655         return ret;
 656 }
 657 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_getparent);
 658
 659 /**
 660  * zynqmp_pm_set_pll_frac_mode() - PM API for set PLL mode
 661  *
 662  * @clk_id:     PLL clock ID
 663  * @mode:       PLL mode (PLL_MODE_FRAC/PLL_MODE_INT)
 664  *
 665  * This function sets PLL mode
 666  *
 667  * Return: Returns status, either success or error+reason
 668  */
 669 int zynqmp_pm_set_pll_frac_mode(u32 clk_id, u32 mode)
 670 {
 671         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_SET_PLL_FRAC_MODE,
 672                                    clk_id, mode, NULL);
 673 }
 674 EXPORT_SYMBOL_GPL(zynqmp_pm_set_pll_frac_mode);
 675
 676 /**
 677  * zynqmp_pm_get_pll_frac_mode() - PM API for get PLL mode
 678  *
 679  * @clk_id:     PLL clock ID
 680  * @mode:       PLL mode
 681  *
 682  * This function return current PLL mode
 683  *
 684  * Return: Returns status, either success or error+reason
 685  */
 686 int zynqmp_pm_get_pll_frac_mode(u32 clk_id, u32 *mode)
 687 {
 688         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_GET_PLL_FRAC_MODE,
 689                                    clk_id, 0, mode);
 690 }
 691 EXPORT_SYMBOL_GPL(zynqmp_pm_get_pll_frac_mode);
 692
 693 /**
 694  * zynqmp_pm_set_pll_frac_data() - PM API for setting pll fraction data
 695  *
 696  * @clk_id:     PLL clock ID
 697  * @data:       fraction data
 698  *
 699  * This function sets fraction data.
 700  * It is valid for fraction mode only.
 701  *
 702  * Return: Returns status, either success or error+reason
 703  */
 704 int zynqmp_pm_set_pll_frac_data(u32 clk_id, u32 data)
 705 {
 706         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_SET_PLL_FRAC_DATA,
 707                                    clk_id, data, NULL);
 708 }
 709 EXPORT_SYMBOL_GPL(zynqmp_pm_set_pll_frac_data);
 710
 711 /**
 712  * zynqmp_pm_get_pll_frac_data() - PM API for getting pll fraction data
 713  *
 714  * @clk_id:     PLL clock ID
 715  * @data:       fraction data
 716  *
 717  * This function returns fraction data value.
 718  *
 719  * Return: Returns status, either success or error+reason
 720  */
 721 int zynqmp_pm_get_pll_frac_data(u32 clk_id, u32 *data)
 722 {
 723         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_GET_PLL_FRAC_DATA,
 724                                    clk_id, 0, data);
 725 }
 726 EXPORT_SYMBOL_GPL(zynqmp_pm_get_pll_frac_data);
 727
 728 /**
 729  * zynqmp_pm_set_sd_tapdelay() -  Set tap delay for the SD device
 730  *
 731  * @node_id:    Node ID of the device
 732  * @type:       Type of tap delay to set (input/output)
 733  * @value:      Value to set fot the tap delay
 734  *
 735  * This function sets input/output tap delay for the SD device.
 736  *
 737  * Return:      Returns status, either success or error+reason
 738  */
 739 int zynqmp_pm_set_sd_tapdelay(u32 node_id, u32 type, u32 value)
 740 {
 741         return zynqmp_pm_invoke_fn(PM_IOCTL, node_id, IOCTL_SET_SD_TAPDELAY,
 742                                    type, value, NULL);
 743 }
 744 EXPORT_SYMBOL_GPL(zynqmp_pm_set_sd_tapdelay);
 745
 746 /**
 747  * zynqmp_pm_sd_dll_reset() - Reset DLL logic
 748  *
 749  * @node_id:    Node ID of the device
 750  * @type:       Reset type
 751  *
 752  * This function resets DLL logic for the SD device.
 753  *
 754  * Return:      Returns status, either success or error+reason
 755  */
 756 int zynqmp_pm_sd_dll_reset(u32 node_id, u32 type)
 757 {
 758         return zynqmp_pm_invoke_fn(PM_IOCTL, node_id, IOCTL_SD_DLL_RESET,
 759                                    type, 0, NULL);
 760 }
 761 EXPORT_SYMBOL_GPL(zynqmp_pm_sd_dll_reset);
 762
 763 /**
 764  * zynqmp_pm_ospi_mux_select() - OSPI Mux selection
 765  *
 766  * @dev_id:     Device Id of the OSPI device.
 767  * @select:     OSPI Mux select value.
 768  *
 769  * This function select the OSPI Mux.
 770  *
 771  * Return:      Returns status, either success or error+reason
 772  */
 773 int zynqmp_pm_ospi_mux_select(u32 dev_id, u32 select)
 774 {
 775         return zynqmp_pm_invoke_fn(PM_IOCTL, dev_id, IOCTL_OSPI_MUX_SELECT,
 776                                    select, 0, NULL);
 777 }
 778 EXPORT_SYMBOL_GPL(zynqmp_pm_ospi_mux_select);
 779
 780 /**
 781  * zynqmp_pm_write_ggs() - PM API for writing global general storage (ggs)
 782  * @index:      GGS register index
 783  * @value:      Register value to be written
 784  *
 785  * This function writes value to GGS register.
 786  *
 787  * Return:      Returns status, either success or error+reason
 788  */
 789 int zynqmp_pm_write_ggs(u32 index, u32 value)
 790 {
 791         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_WRITE_GGS,
 792                                    index, value, NULL);
 793 }
 794 EXPORT_SYMBOL_GPL(zynqmp_pm_write_ggs);
 795
 796 /**
 797  * zynqmp_pm_read_ggs() - PM API for reading global general storage (ggs)
 798  * @index:      GGS register index
 799  * @value:      Register value to be written
 800  *
 801  * This function returns GGS register value.
 802  *
 803  * Return:      Returns status, either success or error+reason
 804  */
 805 int zynqmp_pm_read_ggs(u32 index, u32 *value)
 806 {
 807         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_READ_GGS,
 808                                    index, 0, value);
 809 }
 810 EXPORT_SYMBOL_GPL(zynqmp_pm_read_ggs);
 811
 812 /**
 813  * zynqmp_pm_write_pggs() - PM API for writing persistent global general
 814  *                           storage (pggs)
 815  * @index:      PGGS register index
 816  * @value:      Register value to be written
 817  *
 818  * This function writes value to PGGS register.
 819  *
 820  * Return:      Returns status, either success or error+reason
 821  */
 822 int zynqmp_pm_write_pggs(u32 index, u32 value)
 823 {
 824         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_WRITE_PGGS, index, value,
 825                                    NULL);
 826 }
 827 EXPORT_SYMBOL_GPL(zynqmp_pm_write_pggs);
 828
 829 /**
 830  * zynqmp_pm_read_pggs() - PM API for reading persistent global general
 831  *                           storage (pggs)
 832  * @index:      PGGS register index
 833  * @value:      Register value to be written
 834  *
 835  * This function returns PGGS register value.
 836  *
 837  * Return:      Returns status, either success or error+reason
 838  */
 839 int zynqmp_pm_read_pggs(u32 index, u32 *value)
 840 {
 841         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_READ_PGGS, index, 0,
 842                                    value);
 843 }
 844 EXPORT_SYMBOL_GPL(zynqmp_pm_read_pggs);
 845
 846 /**
 847  * zynqmp_pm_set_boot_health_status() - PM API for setting healthy boot status
 848  * @value:      Status value to be written
 849  *
 850  * This function sets healthy bit value to indicate boot health status
 851  * to firmware.
 852  *
 853  * Return:      Returns status, either success or error+reason
 854  */
 855 int zynqmp_pm_set_boot_health_status(u32 value)
 856 {
 857         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_SET_BOOT_HEALTH_STATUS,
 858                                    value, 0, NULL);
 859 }
 860
 861 /**
 862  * zynqmp_pm_reset_assert - Request setting of reset (1 - assert, 0 - release)
 863  * @reset:              Reset to be configured
 864  * @assert_flag:        Flag stating should reset be asserted (1) or
 865  *                      released (0)
 866  *
 867  * Return: Returns status, either success or error+reason
 868  */
 869 int zynqmp_pm_reset_assert(const enum zynqmp_pm_reset reset,
 870                            const enum zynqmp_pm_reset_action assert_flag)
 871 {
 872         return zynqmp_pm_invoke_fn(PM_RESET_ASSERT, reset, assert_flag,
 873                                    0, 0, NULL);
 874 }
 875 EXPORT_SYMBOL_GPL(zynqmp_pm_reset_assert);
 876
 877 /**
 878  * zynqmp_pm_reset_get_status - Get status of the reset
 879  * @reset:      Reset whose status should be returned
 880  * @status:     Returned status
 881  *
 882  * Return: Returns status, either success or error+reason
 883  */
 884 int zynqmp_pm_reset_get_status(const enum zynqmp_pm_reset reset, u32 *status)
 885 {
 886         u32 ret_payload[PAYLOAD_ARG_CNT];
 887         int ret;
 888
 889         if (!status)
 890                 return -EINVAL;
 891
 892         ret = zynqmp_pm_invoke_fn(PM_RESET_GET_STATUS, reset, 0,
 893                                   0, 0, ret_payload);
 894         *status = ret_payload[1];
 895
 896         return ret;
 897 }
 898 EXPORT_SYMBOL_GPL(zynqmp_pm_reset_get_status);
 899
 900 /**
 901  * zynqmp_pm_fpga_load - Perform the fpga load
 902  * @address:    Address to write to
 903  * @size:       pl bitstream size
 904  * @flags:      Bitstream type
 905  *      -XILINX_ZYNQMP_PM_FPGA_FULL:  FPGA full reconfiguration
 906  *      -XILINX_ZYNQMP_PM_FPGA_PARTIAL: FPGA partial reconfiguration
 907  *
 908  * This function provides access to pmufw. To transfer
 909  * the required bitstream into PL.
 910  *
 911  * Return: Returns status, either success or error+reason
 912  */
 913 int zynqmp_pm_fpga_load(const u64 address, const u32 size, const u32 flags)
 914 {
 915         return zynqmp_pm_invoke_fn(PM_FPGA_LOAD, lower_32_bits(address),
 916                                    upper_32_bits(address), size, flags, NULL);
 917 }
 918 EXPORT_SYMBOL_GPL(zynqmp_pm_fpga_load);
 919
 920 /**
 921  * zynqmp_pm_fpga_get_status - Read value from PCAP status register
 922  * @value: Value to read
 923  *
 924  * This function provides access to the pmufw to get the PCAP
 925  * status
 926  *
 927  * Return: Returns status, either success or error+reason
 928  */
 929 int zynqmp_pm_fpga_get_status(u32 *value)
 930 {
 931         u32 ret_payload[PAYLOAD_ARG_CNT];
 932         int ret;
 933
 934         if (!value)
 935                 return -EINVAL;
 936
 937         ret = zynqmp_pm_invoke_fn(PM_FPGA_GET_STATUS, 0, 0, 0, 0, ret_payload);
 938         *value = ret_payload[1];
 939
 940         return ret;
 941 }
 942 EXPORT_SYMBOL_GPL(zynqmp_pm_fpga_get_status);
 943
 944 /**
 945  * zynqmp_pm_pinctrl_request - Request Pin from firmware
 946  * @pin: Pin number to request
 947  *
 948  * This function requests pin from firmware.
 949  *
 950  * Return: Returns status, either success or error+reason.
 951  */
 952 int zynqmp_pm_pinctrl_request(const u32 pin)
 953 {
 954         return zynqmp_pm_invoke_fn(PM_PINCTRL_REQUEST, pin, 0, 0, 0, NULL);
 955 }
 956 EXPORT_SYMBOL_GPL(zynqmp_pm_pinctrl_request);
 957
 958 /**
 959  * zynqmp_pm_pinctrl_release - Inform firmware that Pin control is released
 960  * @pin: Pin number to release
 961  *
 962  * This function release pin from firmware.
 963  *
 964  * Return: Returns status, either success or error+reason.
 965  */
 966 int zynqmp_pm_pinctrl_release(const u32 pin)
 967 {
 968         return zynqmp_pm_invoke_fn(PM_PINCTRL_RELEASE, pin, 0, 0, 0, NULL);
 969 }
 970 EXPORT_SYMBOL_GPL(zynqmp_pm_pinctrl_release);
 971
 972 /**
 973  * zynqmp_pm_pinctrl_get_function - Read function id set for the given pin
 974  * @pin: Pin number
 975  * @id: Buffer to store function ID
 976  *
 977  * This function provides the function currently set for the given pin.
 978  *
 979  * Return: Returns status, either success or error+reason
 980  */
 981 int zynqmp_pm_pinctrl_get_function(const u32 pin, u32 *id)
 982 {
 983         u32 ret_payload[PAYLOAD_ARG_CNT];
 984         int ret;
 985
 986         if (!id)
 987                 return -EINVAL;
 988
 989         ret = zynqmp_pm_invoke_fn(PM_PINCTRL_GET_FUNCTION, pin, 0,
 990                                   0, 0, ret_payload);
 991         *id = ret_payload[1];
 992
 993         return ret;
 994 }
 995 EXPORT_SYMBOL_GPL(zynqmp_pm_pinctrl_get_function);
 996
 997 /**
 998  * zynqmp_pm_pinctrl_set_function - Set requested function for the pin
 999  * @pin: Pin number
1000  * @id: Function ID to set
1001  *
1002  * This function sets requested function for the given pin.
1003  *
1004  * Return: Returns status, either success or error+reason.
1005  */
1006 int zynqmp_pm_pinctrl_set_function(const u32 pin, const u32 id)
1007 {
1008         return zynqmp_pm_invoke_fn(PM_PINCTRL_SET_FUNCTION, pin, id,
1009                                    0, 0, NULL);
1010 }
1011 EXPORT_SYMBOL_GPL(zynqmp_pm_pinctrl_set_function);
1012
1013 /**
1014  * zynqmp_pm_pinctrl_get_config - Get configuration parameter for the pin
1015  * @pin: Pin number
1016  * @param: Parameter to get
1017  * @value: Buffer to store parameter value
1018  *
1019  * This function gets requested configuration parameter for the given pin.
1020  *
1021  * Return: Returns status, either success or error+reason.
1022  */
1023 int zynqmp_pm_pinctrl_get_config(const u32 pin, const u32 param,
1024                                  u32 *value)
1025 {
1026         u32 ret_payload[PAYLOAD_ARG_CNT];
1027         int ret;
1028
1029         if (!value)
1030                 return -EINVAL;
1031
1032         ret = zynqmp_pm_invoke_fn(PM_PINCTRL_CONFIG_PARAM_GET, pin, param,
1033                                   0, 0, ret_payload);
1034         *value = ret_payload[1];
1035
1036         return ret;
1037 }
1038 EXPORT_SYMBOL_GPL(zynqmp_pm_pinctrl_get_config);
1039
1040 /**
1041  * zynqmp_pm_pinctrl_set_config - Set configuration parameter for the pin
1042  * @pin: Pin number
1043  * @param: Parameter to set
1044  * @value: Parameter value to set
1045  *
1046  * This function sets requested configuration parameter for the given pin.
1047  *
1048  * Return: Returns status, either success or error+reason.
1049  */
1050 int zynqmp_pm_pinctrl_set_config(const u32 pin, const u32 param,
1051                                  u32 value)
1052 {
1053         return zynqmp_pm_invoke_fn(PM_PINCTRL_CONFIG_PARAM_SET, pin,
1054                                    param, value, 0, NULL);
1055 }
1056 EXPORT_SYMBOL_GPL(zynqmp_pm_pinctrl_set_config);
1057
1058 /**
1059  * zynqmp_pm_bootmode_read() - PM Config API for read bootpin status
1060  * @ps_mode: Returned output value of ps_mode
1061  *
1062  * This API function is to be used for notify the power management controller
1063  * to read bootpin status.
1064  *
1065  * Return: status, either success or error+reason
1066  */
1067 unsigned int zynqmp_pm_bootmode_read(u32 *ps_mode)
1068 {
1069         unsigned int ret;
1070         u32 ret_payload[PAYLOAD_ARG_CNT];
1071
1072         ret = zynqmp_pm_invoke_fn(PM_MMIO_READ, CRL_APB_BOOT_PIN_CTRL, 0,
1073                                   0, 0, ret_payload);
1074
1075         *ps_mode = ret_payload[1];
1076
1077         return ret;
1078 }
1079 EXPORT_SYMBOL_GPL(zynqmp_pm_bootmode_read);
1080
1081 /**
1082  * zynqmp_pm_bootmode_write() - PM Config API for Configure bootpin
1083  * @ps_mode: Value to be written to the bootpin ctrl register
1084  *
1085  * This API function is to be used for notify the power management controller
1086  * to configure bootpin.
1087  *
1088  * Return: Returns status, either success or error+reason
1089  */
1090 int zynqmp_pm_bootmode_write(u32 ps_mode)
1091 {
1092         return zynqmp_pm_invoke_fn(PM_MMIO_WRITE, CRL_APB_BOOT_PIN_CTRL,
1093                                    CRL_APB_BOOTPIN_CTRL_MASK, ps_mode, 0, NULL);
1094 }
1095 EXPORT_SYMBOL_GPL(zynqmp_pm_bootmode_write);
1096
1097 /**
1098  * zynqmp_pm_init_finalize() - PM call to inform firmware that the caller
1099  *                             master has initialized its own power management
1100  *
1101  * Return: Returns status, either success or error+reason
1102  *
1103  * This API function is to be used for notify the power management controller
1104  * about the completed power management initialization.
1105  */
1106 int zynqmp_pm_init_finalize(void)
1107 {
1108         return zynqmp_pm_invoke_fn(PM_PM_INIT_FINALIZE, 0, 0, 0, 0, NULL);
1109 }
1110 EXPORT_SYMBOL_GPL(zynqmp_pm_init_finalize);
1111
1112 /**
1113  * zynqmp_pm_set_suspend_mode() - Set system suspend mode
1114  * @mode:       Mode to set for system suspend
1115  *
1116  * This API function is used to set mode of system suspend.
1117  *
1118  * Return: Returns status, either success or error+reason
1119  */
1120 int zynqmp_pm_set_suspend_mode(u32 mode)
1121 {
1122         return zynqmp_pm_invoke_fn(PM_SET_SUSPEND_MODE, mode, 0, 0, 0, NULL);
1123 }
1124 EXPORT_SYMBOL_GPL(zynqmp_pm_set_suspend_mode);
1125
1126 /**
1127  * zynqmp_pm_request_node() - Request a node with specific capabilities
1128  * @node:               Node ID of the slave
1129  * @capabilities:       Requested capabilities of the slave
1130  * @qos:                Quality of service (not supported)
1131  * @ack:                Flag to specify whether acknowledge is requested
1132  *
1133  * This function is used by master to request particular node from firmware.
1134  * Every master must request node before using it.
1135  *
1136  * Return: Returns status, either success or error+reason
1137  */
1138 int zynqmp_pm_request_node(const u32 node, const u32 capabilities,
1139                            const u32 qos, const enum zynqmp_pm_request_ack ack)
1140 {
1141         return zynqmp_pm_invoke_fn(PM_REQUEST_NODE, node, capabilities,
1142                                    qos, ack, NULL);
1143 }
1144 EXPORT_SYMBOL_GPL(zynqmp_pm_request_node);
1145
1146 /**
1147  * zynqmp_pm_release_node() - Release a node
1148  * @node:       Node ID of the slave
1149  *
1150  * This function is used by master to inform firmware that master
1151  * has released node. Once released, master must not use that node
1152  * without re-request.
1153  *
1154  * Return: Returns status, either success or error+reason
1155  */
1156 int zynqmp_pm_release_node(const u32 node)
1157 {
1158         return zynqmp_pm_invoke_fn(PM_RELEASE_NODE, node, 0, 0, 0, NULL);
1159 }
1160 EXPORT_SYMBOL_GPL(zynqmp_pm_release_node);
1161
1162 /**
1163  * zynqmp_pm_set_requirement() - PM call to set requirement for PM slaves
1164  * @node:               Node ID of the slave
1165  * @capabilities:       Requested capabilities of the slave
1166  * @qos:                Quality of service (not supported)
1167  * @ack:                Flag to specify whether acknowledge is requested
1168  *
1169  * This API function is to be used for slaves a PU already has requested
1170  * to change its capabilities.
1171  *
1172  * Return: Returns status, either success or error+reason
1173  */
1174 int zynqmp_pm_set_requirement(const u32 node, const u32 capabilities,
1175                               const u32 qos,
1176                               const enum zynqmp_pm_request_ack ack)
1177 {
1178         return zynqmp_pm_invoke_fn(PM_SET_REQUIREMENT, node, capabilities,
1179                                    qos, ack, NULL);
1180 }
1181 EXPORT_SYMBOL_GPL(zynqmp_pm_set_requirement);
1182
1183 /**
1184  * zynqmp_pm_load_pdi - Load and process PDI
1185  * @src:       Source device where PDI is located
1186  * @address:   PDI src address
1187  *
1188  * This function provides support to load PDI from linux
1189  *
1190  * Return: Returns status, either success or error+reason
1191  */
1192 int zynqmp_pm_load_pdi(const u32 src, const u64 address)
1193 {
1194         return zynqmp_pm_invoke_fn(PM_LOAD_PDI, src,
1195                                    lower_32_bits(address),
1196                                    upper_32_bits(address), 0, NULL);
1197 }
1198 EXPORT_SYMBOL_GPL(zynqmp_pm_load_pdi);
1199
1200 /**
1201  * zynqmp_pm_aes_engine - Access AES hardware to encrypt/decrypt the data using
1202  * AES-GCM core.
1203  * @address:    Address of the AesParams structure.
1204  * @out:        Returned output value
1205  *
1206  * Return:      Returns status, either success or error code.
1207  */
1208 int zynqmp_pm_aes_engine(const u64 address, u32 *out)
1209 {
1210         u32 ret_payload[PAYLOAD_ARG_CNT];
1211         int ret;
1212
1213         if (!out)
1214                 return -EINVAL;
1215
1216         ret = zynqmp_pm_invoke_fn(PM_SECURE_AES, upper_32_bits(address),
1217                                   lower_32_bits(address),
1218                                   0, 0, ret_payload);
1219         *out = ret_payload[1];
1220
1221         return ret;
1222 }
1223 EXPORT_SYMBOL_GPL(zynqmp_pm_aes_engine);
1224
1225 /**
1226  * zynqmp_pm_sha_hash - Access the SHA engine to calculate the hash
1227  * @address:    Address of the data/ Address of output buffer where
1228  *              hash should be stored.
1229  * @size:       Size of the data.
1230  * @flags:
1231  *      BIT(0) - for initializing csudma driver and SHA3(Here address
1232  *               and size inputs can be NULL).
1233  *      BIT(1) - to call Sha3_Update API which can be called multiple
1234  *               times when data is not contiguous.
1235  *      BIT(2) - to get final hash of the whole updated data.
1236  *               Hash will be overwritten at provided address with
1237  *               48 bytes.
1238  *
1239  * Return:      Returns status, either success or error code.
1240  */
1241 int zynqmp_pm_sha_hash(const u64 address, const u32 size, const u32 flags)
1242 {
1243         u32 lower_addr = lower_32_bits(address);
1244         u32 upper_addr = upper_32_bits(address);
1245
1246         return zynqmp_pm_invoke_fn(PM_SECURE_SHA, upper_addr, lower_addr,
1247                                    size, flags, NULL);
1248 }
1249 EXPORT_SYMBOL_GPL(zynqmp_pm_sha_hash);
1250
1251 /**
1252  * zynqmp_pm_register_notifier() - PM API for register a subsystem
1253  *                                to be notified about specific
1254  *                                event/error.
1255  * @node:       Node ID to which the event is related.
1256  * @event:      Event Mask of Error events for which wants to get notified.
1257  * @wake:       Wake subsystem upon capturing the event if value 1
1258  * @enable:     Enable the registration for value 1, disable for value 0
1259  *
1260  * This function is used to register/un-register for particular node-event
1261  * combination in firmware.
1262  *
1263  * Return: Returns status, either success or error+reason
1264  */
1265
1266 int zynqmp_pm_register_notifier(const u32 node, const u32 event,
1267                                 const u32 wake, const u32 enable)
1268 {
1269         return zynqmp_pm_invoke_fn(PM_REGISTER_NOTIFIER, node, event,
1270                                    wake, enable, NULL);
1271 }
1272 EXPORT_SYMBOL_GPL(zynqmp_pm_register_notifier);
1273
1274 /**
1275  * zynqmp_pm_system_shutdown - PM call to request a system shutdown or restart
1276  * @type:       Shutdown or restart? 0 for shutdown, 1 for restart
1277  * @subtype:    Specifies which system should be restarted or shut down
1278  *
1279  * Return:      Returns status, either success or error+reason
1280  */
1281 int zynqmp_pm_system_shutdown(const u32 type, const u32 subtype)
1282 {
1283         return zynqmp_pm_invoke_fn(PM_SYSTEM_SHUTDOWN, type, subtype,
1284                                    0, 0, NULL);
1285 }
1286
1287 /**
1288  * zynqmp_pm_set_feature_config - PM call to request IOCTL for feature config
1289  * @id:         The config ID of the feature to be configured
1290  * @value:      The config value of the feature to be configured
1291  *
1292  * Return:      Returns 0 on success or error value on failure.
1293  */
1294 int zynqmp_pm_set_feature_config(enum pm_feature_config_id id, u32 value)
1295 {
1296         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_SET_FEATURE_CONFIG,
1297                                    id, value, NULL);
1298 }
1299
1300 /**
1301  * zynqmp_pm_get_feature_config - PM call to get value of configured feature
1302  * @id:         The config id of the feature to be queried
1303  * @payload:    Returned value array
1304  *
1305  * Return:      Returns 0 on success or error value on failure.
1306  */
1307 int zynqmp_pm_get_feature_config(enum pm_feature_config_id id,
1308                                  u32 *payload)
1309 {
1310         return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_GET_FEATURE_CONFIG,
1311                                    id, 0, payload);
1312 }
1313
1314 /**
1315  * zynqmp_pm_set_sd_config - PM call to set value of SD config registers
1316  * @node:       SD node ID
1317  * @config:     The config type of SD registers
1318  * @value:      Value to be set
1319  *
1320  * Return:      Returns 0 on success or error value on failure.
1321  */
1322 int zynqmp_pm_set_sd_config(u32 node, enum pm_sd_config_type config, u32 value)
1323 {
1324         return zynqmp_pm_invoke_fn(PM_IOCTL, node, IOCTL_SET_SD_CONFIG,
1325                                    config, value, NULL);
1326 }
1327 EXPORT_SYMBOL_GPL(zynqmp_pm_set_sd_config);
1328
1329 /**
1330  * zynqmp_pm_set_gem_config - PM call to set value of GEM config registers
1331  * @node:       GEM node ID
1332  * @config:     The config type of GEM registers
1333  * @value:      Value to be set
1334  *
1335  * Return:      Returns 0 on success or error value on failure.
1336  */
1337 int zynqmp_pm_set_gem_config(u32 node, enum pm_gem_config_type config,
1338                              u32 value)
1339 {
1340         return zynqmp_pm_invoke_fn(PM_IOCTL, node, IOCTL_SET_GEM_CONFIG,
1341                                    config, value, NULL);
1342 }
1343 EXPORT_SYMBOL_GPL(zynqmp_pm_set_gem_config);
1344
1345 /**
1346  * struct zynqmp_pm_shutdown_scope - Struct for shutdown scope
1347  * @subtype:    Shutdown subtype
1348  * @name:       Matching string for scope argument
1349  *
1350  * This struct encapsulates mapping between shutdown scope ID and string.
1351  */
1352 struct zynqmp_pm_shutdown_scope {
1353         const enum zynqmp_pm_shutdown_subtype subtype;
1354         const char *name;
1355 };
1356
1357 static struct zynqmp_pm_shutdown_scope shutdown_scopes[] = {
1358         [ZYNQMP_PM_SHUTDOWN_SUBTYPE_SUBSYSTEM] = {
1359                 .subtype = ZYNQMP_PM_SHUTDOWN_SUBTYPE_SUBSYSTEM,
1360                 .name = "subsystem",
1361         },
1362         [ZYNQMP_PM_SHUTDOWN_SUBTYPE_PS_ONLY] = {
1363                 .subtype = ZYNQMP_PM_SHUTDOWN_SUBTYPE_PS_ONLY,
1364                 .name = "ps_only",
1365         },
1366         [ZYNQMP_PM_SHUTDOWN_SUBTYPE_SYSTEM] = {
1367                 .subtype = ZYNQMP_PM_SHUTDOWN_SUBTYPE_SYSTEM,
1368                 .name = "system",
1369         },
1370 };
1371
1372 static struct zynqmp_pm_shutdown_scope *selected_scope =
1373                 &shutdown_scopes[ZYNQMP_PM_SHUTDOWN_SUBTYPE_SYSTEM];
1374
1375 /**
1376  * zynqmp_pm_is_shutdown_scope_valid - Check if shutdown scope string is valid
1377  * @scope_string:       Shutdown scope string
1378  *
1379  * Return:              Return pointer to matching shutdown scope struct from
1380  *                      array of available options in system if string is valid,
1381  *                      otherwise returns NULL.
1382  */
1383 static struct zynqmp_pm_shutdown_scope*
1384                 zynqmp_pm_is_shutdown_scope_valid(const char *scope_string)
1385 {
1386         int count;
1387
1388         for (count = 0; count < ARRAY_SIZE(shutdown_scopes); count++)
1389                 if (sysfs_streq(scope_string, shutdown_scopes[count].name))
1390                         return &shutdown_scopes[count];
1391
1392         return NULL;
1393 }
1394
1395 static ssize_t shutdown_scope_show(struct device *device,
1396                                    struct device_attribute *attr,
1397                                    char *buf)
1398 {
1399         int i;
1400
1401         for (i = 0; i < ARRAY_SIZE(shutdown_scopes); i++) {
1402                 if (&shutdown_scopes[i] == selected_scope) {
1403                         strcat(buf, "[");
1404                         strcat(buf, shutdown_scopes[i].name);
1405                         strcat(buf, "]");
1406                 } else {
1407                         strcat(buf, shutdown_scopes[i].name);
1408                 }
1409                 strcat(buf, " ");
1410         }
1411         strcat(buf, "\n");
1412
1413         return strlen(buf);
1414 }
1415
1416 static ssize_t shutdown_scope_store(struct device *device,
1417                                     struct device_attribute *attr,
1418                                     const char *buf, size_t count)
1419 {
1420         int ret;
1421         struct zynqmp_pm_shutdown_scope *scope;
1422
1423         scope = zynqmp_pm_is_shutdown_scope_valid(buf);
1424         if (!scope)
1425                 return -EINVAL;
1426
1427         ret = zynqmp_pm_system_shutdown(ZYNQMP_PM_SHUTDOWN_TYPE_SETSCOPE_ONLY,
1428                                         scope->subtype);
1429         if (ret) {
1430                 pr_err("unable to set shutdown scope %s\n", buf);
1431                 return ret;
1432         }
1433
1434         selected_scope = scope;
1435
1436         return count;
1437 }
1438
1439 static DEVICE_ATTR_RW(shutdown_scope);
1440
1441 static ssize_t health_status_store(struct device *device,
1442                                    struct device_attribute *attr,
1443                                    const char *buf, size_t count)
1444 {
1445         int ret;
1446         unsigned int value;
1447
1448         ret = kstrtouint(buf, 10, &value);
1449         if (ret)
1450                 return ret;
1451
1452         ret = zynqmp_pm_set_boot_health_status(value);
1453         if (ret) {
1454                 dev_err(device, "unable to set healthy bit value to %u\n",
1455                         value);
1456                 return ret;
1457         }
1458
1459         return count;
1460 }
1461
1462 static DEVICE_ATTR_WO(health_status);
1463
1464 static ssize_t ggs_show(struct device *device,
1465                         struct device_attribute *attr,
1466                         char *buf,
1467                         u32 reg)
1468 {
1469         int ret;
1470         u32 ret_payload[PAYLOAD_ARG_CNT];
1471
1472         ret = zynqmp_pm_read_ggs(reg, ret_payload);
1473         if (ret)
1474                 return ret;
1475
1476         return sprintf(buf, "0x%x\n", ret_payload[1]);
1477 }
1478
1479 static ssize_t ggs_store(struct device *device,
1480                          struct device_attribute *attr,
1481                          const char *buf, size_t count,
1482                          u32 reg)
1483 {
1484         long value;
1485         int ret;
1486
1487         if (reg >= GSS_NUM_REGS)
1488                 return -EINVAL;
1489
1490         ret = kstrtol(buf, 16, &value);
1491         if (ret) {
1492                 count = -EFAULT;
1493                 goto err;
1494         }
1495
1496         ret = zynqmp_pm_write_ggs(reg, value);
1497         if (ret)
1498                 count = -EFAULT;
1499 err:
1500         return count;
1501 }
1502
1503 /* GGS register show functions */
1504 #define GGS0_SHOW(N)                                            \
1505         ssize_t ggs##N##_show(struct device *device,            \
1506                               struct device_attribute *attr,    \
1507                               char *buf)                        \
1508         {                                                       \
1509                 return ggs_show(device, attr, buf, N);          \
1510         }
1511
1512 static GGS0_SHOW(0);
1513 static GGS0_SHOW(1);
1514 static GGS0_SHOW(2);
1515 static GGS0_SHOW(3);
1516
1517 /* GGS register store function */
1518 #define GGS0_STORE(N)                                           \
1519         ssize_t ggs##N##_store(struct device *device,           \
1520                                struct device_attribute *attr,   \
1521                                const char *buf,                 \
1522                                size_t count)                    \
1523         {                                                       \
1524                 return ggs_store(device, attr, buf, count, N);  \
1525         }
1526
1527 static GGS0_STORE(0);
1528 static GGS0_STORE(1);
1529 static GGS0_STORE(2);
1530 static GGS0_STORE(3);
1531
1532 static ssize_t pggs_show(struct device *device,
1533                          struct device_attribute *attr,
1534                          char *buf,
1535                          u32 reg)
1536 {
1537         int ret;
1538         u32 ret_payload[PAYLOAD_ARG_CNT];
1539
1540         ret = zynqmp_pm_read_pggs(reg, ret_payload);
1541         if (ret)
1542                 return ret;
1543
1544         return sprintf(buf, "0x%x\n", ret_payload[1]);
1545 }
1546
1547 static ssize_t pggs_store(struct device *device,
1548                           struct device_attribute *attr,
1549                           const char *buf, size_t count,
1550                           u32 reg)
1551 {
1552         long value;
1553         int ret;
1554
1555         if (reg >= GSS_NUM_REGS)
1556                 return -EINVAL;
1557
1558         ret = kstrtol(buf, 16, &value);
1559         if (ret) {
1560                 count = -EFAULT;
1561                 goto err;
1562         }
1563
1564         ret = zynqmp_pm_write_pggs(reg, value);
1565         if (ret)
1566                 count = -EFAULT;
1567
1568 err:
1569         return count;
1570 }
1571
1572 #define PGGS0_SHOW(N)                                           \
1573         ssize_t pggs##N##_show(struct device *device,           \
1574                                struct device_attribute *attr,   \
1575                                char *buf)                       \
1576         {                                                       \
1577                 return pggs_show(device, attr, buf, N);         \
1578         }
1579
1580 #define PGGS0_STORE(N)                                          \
1581         ssize_t pggs##N##_store(struct device *device,          \
1582                                 struct device_attribute *attr,  \
1583                                 const char *buf,                \
1584                                 size_t count)                   \
1585         {                                                       \
1586                 return pggs_store(device, attr, buf, count, N); \
1587         }
1588
1589 /* PGGS register show functions */
1590 static PGGS0_SHOW(0);
1591 static PGGS0_SHOW(1);
1592 static PGGS0_SHOW(2);
1593 static PGGS0_SHOW(3);
1594
1595 /* PGGS register store functions */
1596 static PGGS0_STORE(0);
1597 static PGGS0_STORE(1);
1598 static PGGS0_STORE(2);
1599 static PGGS0_STORE(3);
1600
1601 /* GGS register attributes */
1602 static DEVICE_ATTR_RW(ggs0);
1603 static DEVICE_ATTR_RW(ggs1);
1604 static DEVICE_ATTR_RW(ggs2);
1605 static DEVICE_ATTR_RW(ggs3);
1606
1607 /* PGGS register attributes */
1608 static DEVICE_ATTR_RW(pggs0);
1609 static DEVICE_ATTR_RW(pggs1);
1610 static DEVICE_ATTR_RW(pggs2);
1611 static DEVICE_ATTR_RW(pggs3);
1612
1613 static ssize_t feature_config_id_show(struct device *device,
1614                                       struct device_attribute *attr,
1615                                       char *buf)
1616 {
1617         struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
1618
1619         return sysfs_emit(buf, "%d\n", devinfo->feature_conf_id);
1620 }
1621
1622 static ssize_t feature_config_id_store(struct device *device,
1623                                        struct device_attribute *attr,
1624                                        const char *buf, size_t count)
1625 {
1626         u32 config_id;
1627         int ret;
1628         struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
1629
1630         if (!buf)
1631                 return -EINVAL;
1632
1633         ret = kstrtou32(buf, 10, &config_id);
1634         if (ret)
1635                 return ret;
1636
1637         devinfo->feature_conf_id = config_id;
1638
1639         return count;
1640 }
1641
1642 static DEVICE_ATTR_RW(feature_config_id);
1643
1644 static ssize_t feature_config_value_show(struct device *device,
1645                                          struct device_attribute *attr,
1646                                          char *buf)
1647 {
1648         int ret;
1649         u32 ret_payload[PAYLOAD_ARG_CNT];
1650         struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
1651
1652         ret = zynqmp_pm_get_feature_config(devinfo->feature_conf_id,
1653                                            ret_payload);
1654         if (ret)
1655                 return ret;
1656
1657         return sysfs_emit(buf, "%d\n", ret_payload[1]);
1658 }
1659
1660 static ssize_t feature_config_value_store(struct device *device,
1661                                           struct device_attribute *attr,
1662                                           const char *buf, size_t count)
1663 {
1664         u32 value;
1665         int ret;
1666         struct zynqmp_devinfo *devinfo = dev_get_drvdata(device);
1667
1668         if (!buf)
1669                 return -EINVAL;
1670
1671         ret = kstrtou32(buf, 10, &value);
1672         if (ret)
1673                 return ret;
1674
1675         ret = zynqmp_pm_set_feature_config(devinfo->feature_conf_id,
1676                                            value);
1677         if (ret)
1678                 return ret;
1679
1680         return count;
1681 }
1682
1683 static DEVICE_ATTR_RW(feature_config_value);
1684
1685 static struct attribute *zynqmp_firmware_attrs[] = {
1686         &dev_attr_ggs0.attr,
1687         &dev_attr_ggs1.attr,
1688         &dev_attr_ggs2.attr,
1689         &dev_attr_ggs3.attr,
1690         &dev_attr_pggs0.attr,
1691         &dev_attr_pggs1.attr,
1692         &dev_attr_pggs2.attr,
1693         &dev_attr_pggs3.attr,
1694         &dev_attr_shutdown_scope.attr,
1695         &dev_attr_health_status.attr,
1696         &dev_attr_feature_config_id.attr,
1697         &dev_attr_feature_config_value.attr,
1698         NULL,
1699 };
1700
1701 ATTRIBUTE_GROUPS(zynqmp_firmware);
1702
1703 static int zynqmp_firmware_probe(struct platform_device *pdev)
1704 {
1705         struct device *dev = &pdev->dev;
1706         struct device_node *np;
1707         struct zynqmp_devinfo *devinfo;
1708         int ret;
1709
1710         ret = get_set_conduit_method(dev->of_node);
1711         if (ret)
1712                 return ret;
1713
1714         np = of_find_compatible_node(NULL, NULL, "xlnx,zynqmp");
1715         if (!np) {
1716                 np = of_find_compatible_node(NULL, NULL, "xlnx,versal");
1717                 if (!np)
1718                         return 0;
1719
1720                 feature_check_enabled = true;
1721         }
1722
1723         if (!feature_check_enabled) {
1724                 ret = do_feature_check_call(PM_FEATURE_CHECK);
1725                 if (ret >= 0)
1726                         feature_check_enabled = true;
1727         }
1728
1729         of_node_put(np);
1730
1731         devinfo = devm_kzalloc(dev, sizeof(*devinfo), GFP_KERNEL);
1732         if (!devinfo)
1733                 return -ENOMEM;
1734
1735         devinfo->dev = dev;
1736
1737         platform_set_drvdata(pdev, devinfo);
1738
1739         /* Check PM API version number */
1740         ret = zynqmp_pm_get_api_version(&pm_api_version);
1741         if (ret)
1742                 return ret;
1743
1744         if (pm_api_version < ZYNQMP_PM_VERSION) {
1745                 panic("%s Platform Management API version error. Expected: v%d.%d - Found: v%d.%d\n",
1746                       __func__,
1747                       ZYNQMP_PM_VERSION_MAJOR, ZYNQMP_PM_VERSION_MINOR,
1748                       pm_api_version >> 16, pm_api_version & 0xFFFF);
1749         }
1750
1751         pr_info("%s Platform Management API v%d.%d\n", __func__,
1752                 pm_api_version >> 16, pm_api_version & 0xFFFF);
1753
1754         /* Check trustzone version number */
1755         ret = zynqmp_pm_get_trustzone_version(&pm_tz_version);
1756         if (ret)
1757                 panic("Legacy trustzone found without version support\n");
1758
1759         if (pm_tz_version < ZYNQMP_TZ_VERSION)
1760                 panic("%s Trustzone version error. Expected: v%d.%d - Found: v%d.%d\n",
1761                       __func__,
1762                       ZYNQMP_TZ_VERSION_MAJOR, ZYNQMP_TZ_VERSION_MINOR,
1763                       pm_tz_version >> 16, pm_tz_version & 0xFFFF);
1764
1765         pr_info("%s Trustzone version v%d.%d\n", __func__,
1766                 pm_tz_version >> 16, pm_tz_version & 0xFFFF);
1767
1768         ret = mfd_add_devices(&pdev->dev, PLATFORM_DEVID_NONE, firmware_devs,
1769                               ARRAY_SIZE(firmware_devs), NULL, 0, NULL);
1770         if (ret) {
1771                 dev_err(&pdev->dev, "failed to add MFD devices %d\n", ret);
1772                 return ret;
1773         }
1774
1775         zynqmp_pm_api_debugfs_init();
1776
1777         np = of_find_compatible_node(NULL, NULL, "xlnx,versal");
1778         if (np) {
1779                 em_dev = platform_device_register_data(&pdev->dev, "xlnx_event_manager",
1780                                                        -1, NULL, 0);
1781                 if (IS_ERR(em_dev))
1782                         dev_err_probe(&pdev->dev, PTR_ERR(em_dev), "EM register fail with error\n");
1783         }
1784         of_node_put(np);
1785
1786         return of_platform_populate(dev->of_node, NULL, NULL, dev);
1787 }
1788
1789 static int zynqmp_firmware_remove(struct platform_device *pdev)
1790 {
1791         struct pm_api_feature_data *feature_data;
1792         struct hlist_node *tmp;
1793         int i;
1794
1795         mfd_remove_devices(&pdev->dev);
1796         zynqmp_pm_api_debugfs_exit();
1797
1798         hash_for_each_safe(pm_api_features_map, i, tmp, feature_data, hentry) {
1799                 hash_del(&feature_data->hentry);
1800                 kfree(feature_data);
1801         }
1802
1803         platform_device_unregister(em_dev);
1804
1805         return 0;
1806 }
1807
1808 static const struct of_device_id zynqmp_firmware_of_match[] = {
1809         {.compatible = "xlnx,zynqmp-firmware"},
1810         {.compatible = "xlnx,versal-firmware"},
1811         {},
1812 };
1813 MODULE_DEVICE_TABLE(of, zynqmp_firmware_of_match);
1814
1815 static struct platform_driver zynqmp_firmware_driver = {
1816         .driver = {
1817                 .name = "zynqmp_firmware",
1818                 .of_match_table = zynqmp_firmware_of_match,
1819                 .dev_groups = zynqmp_firmware_groups,
1820         },
1821         .probe = zynqmp_firmware_probe,
1822         .remove = zynqmp_firmware_remove,
1823 };
1824 module_platform_driver(zynqmp_firmware_driver);