1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Xilinx Zynq MPSoC Firmware layer 4 * 5 * Copyright (C) 2014-2020 Xilinx, Inc. 6 * 7 * Michal Simek <michal.simek@xilinx.com> 8 * Davorin Mista <davorin.mista@aggios.com> 9 * Jolly Shah <jollys@xilinx.com> 10 * Rajan Vaja <rajanv@xilinx.com> 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 "zynqmp-debug.h" 27 28 /* Max HashMap Order for PM API feature check (1<<7 = 128) */ 29 #define PM_API_FEATURE_CHECK_MAX_ORDER 7 30 31 static bool feature_check_enabled; 32 static DEFINE_HASHTABLE(pm_api_features_map, PM_API_FEATURE_CHECK_MAX_ORDER); 33 34 /** 35 * struct pm_api_feature_data - PM API Feature data 36 * @pm_api_id: PM API Id, used as key to index into hashmap 37 * @feature_status: status of PM API feature: valid, invalid 38 * @hentry: hlist_node that hooks this entry into hashtable 39 */ 40 struct pm_api_feature_data { 41 u32 pm_api_id; 42 int feature_status; 43 struct hlist_node hentry; 44 }; 45 46 static const struct mfd_cell firmware_devs[] = { 47 { 48 .name = "zynqmp_power_controller", 49 }, 50 }; 51 52 /** 53 * zynqmp_pm_ret_code() - Convert PMU-FW error codes to Linux error codes 54 * @ret_status: PMUFW return code 55 * 56 * Return: corresponding Linux error code 57 */ 58 static int zynqmp_pm_ret_code(u32 ret_status) 59 { 60 switch (ret_status) { 61 case XST_PM_SUCCESS: 62 case XST_PM_DOUBLE_REQ: 63 return 0; 64 case XST_PM_NO_FEATURE: 65 return -ENOTSUPP; 66 case XST_PM_NO_ACCESS: 67 return -EACCES; 68 case XST_PM_ABORT_SUSPEND: 69 return -ECANCELED; 70 case XST_PM_MULT_USER: 71 return -EUSERS; 72 case XST_PM_INTERNAL: 73 case XST_PM_CONFLICT: 74 case XST_PM_INVALID_NODE: 75 default: 76 return -EINVAL; 77 } 78 } 79 80 static noinline int do_fw_call_fail(u64 arg0, u64 arg1, u64 arg2, 81 u32 *ret_payload) 82 { 83 return -ENODEV; 84 } 85 86 /* 87 * PM function call wrapper 88 * Invoke do_fw_call_smc or do_fw_call_hvc, depending on the configuration 89 */ 90 static int (*do_fw_call)(u64, u64, u64, u32 *ret_payload) = do_fw_call_fail; 91 92 /** 93 * do_fw_call_smc() - Call system-level platform management layer (SMC) 94 * @arg0: Argument 0 to SMC call 95 * @arg1: Argument 1 to SMC call 96 * @arg2: Argument 2 to SMC call 97 * @ret_payload: Returned value array 98 * 99 * Invoke platform management function via SMC call (no hypervisor present). 100 * 101 * Return: Returns status, either success or error+reason 102 */ 103 static noinline int do_fw_call_smc(u64 arg0, u64 arg1, u64 arg2, 104 u32 *ret_payload) 105 { 106 struct arm_smccc_res res; 107 108 arm_smccc_smc(arg0, arg1, arg2, 0, 0, 0, 0, 0, &res); 109 110 if (ret_payload) { 111 ret_payload[0] = lower_32_bits(res.a0); 112 ret_payload[1] = upper_32_bits(res.a0); 113 ret_payload[2] = lower_32_bits(res.a1); 114 ret_payload[3] = upper_32_bits(res.a1); 115 } 116 117 return zynqmp_pm_ret_code((enum pm_ret_status)res.a0); 118 } 119 120 /** 121 * do_fw_call_hvc() - Call system-level platform management layer (HVC) 122 * @arg0: Argument 0 to HVC call 123 * @arg1: Argument 1 to HVC call 124 * @arg2: Argument 2 to HVC call 125 * @ret_payload: Returned value array 126 * 127 * Invoke platform management function via HVC 128 * HVC-based for communication through hypervisor 129 * (no direct communication with ATF). 130 * 131 * Return: Returns status, either success or error+reason 132 */ 133 static noinline int do_fw_call_hvc(u64 arg0, u64 arg1, u64 arg2, 134 u32 *ret_payload) 135 { 136 struct arm_smccc_res res; 137 138 arm_smccc_hvc(arg0, arg1, arg2, 0, 0, 0, 0, 0, &res); 139 140 if (ret_payload) { 141 ret_payload[0] = lower_32_bits(res.a0); 142 ret_payload[1] = upper_32_bits(res.a0); 143 ret_payload[2] = lower_32_bits(res.a1); 144 ret_payload[3] = upper_32_bits(res.a1); 145 } 146 147 return zynqmp_pm_ret_code((enum pm_ret_status)res.a0); 148 } 149 150 /** 151 * zynqmp_pm_feature() - Check weather given feature is supported or not 152 * @api_id: API ID to check 153 * 154 * Return: Returns status, either success or error+reason 155 */ 156 static int zynqmp_pm_feature(u32 api_id) 157 { 158 int ret; 159 u32 ret_payload[PAYLOAD_ARG_CNT]; 160 u64 smc_arg[2]; 161 struct pm_api_feature_data *feature_data; 162 163 if (!feature_check_enabled) 164 return 0; 165 166 /* Check for existing entry in hash table for given api */ 167 hash_for_each_possible(pm_api_features_map, feature_data, hentry, 168 api_id) { 169 if (feature_data->pm_api_id == api_id) 170 return feature_data->feature_status; 171 } 172 173 /* Add new entry if not present */ 174 feature_data = kmalloc(sizeof(*feature_data), GFP_KERNEL); 175 if (!feature_data) 176 return -ENOMEM; 177 178 feature_data->pm_api_id = api_id; 179 smc_arg[0] = PM_SIP_SVC | PM_FEATURE_CHECK; 180 smc_arg[1] = api_id; 181 182 ret = do_fw_call(smc_arg[0], smc_arg[1], 0, ret_payload); 183 if (ret) 184 ret = -EOPNOTSUPP; 185 else 186 ret = ret_payload[1]; 187 188 feature_data->feature_status = ret; 189 hash_add(pm_api_features_map, &feature_data->hentry, api_id); 190 191 return ret; 192 } 193 194 /** 195 * zynqmp_pm_invoke_fn() - Invoke the system-level platform management layer 196 * caller function depending on the configuration 197 * @pm_api_id: Requested PM-API call 198 * @arg0: Argument 0 to requested PM-API call 199 * @arg1: Argument 1 to requested PM-API call 200 * @arg2: Argument 2 to requested PM-API call 201 * @arg3: Argument 3 to requested PM-API call 202 * @ret_payload: Returned value array 203 * 204 * Invoke platform management function for SMC or HVC call, depending on 205 * configuration. 206 * Following SMC Calling Convention (SMCCC) for SMC64: 207 * Pm Function Identifier, 208 * PM_SIP_SVC + PM_API_ID = 209 * ((SMC_TYPE_FAST << FUNCID_TYPE_SHIFT) 210 * ((SMC_64) << FUNCID_CC_SHIFT) 211 * ((SIP_START) << FUNCID_OEN_SHIFT) 212 * ((PM_API_ID) & FUNCID_NUM_MASK)) 213 * 214 * PM_SIP_SVC - Registered ZynqMP SIP Service Call. 215 * PM_API_ID - Platform Management API ID. 216 * 217 * Return: Returns status, either success or error+reason 218 */ 219 int zynqmp_pm_invoke_fn(u32 pm_api_id, u32 arg0, u32 arg1, 220 u32 arg2, u32 arg3, u32 *ret_payload) 221 { 222 /* 223 * Added SIP service call Function Identifier 224 * Make sure to stay in x0 register 225 */ 226 u64 smc_arg[4]; 227 int ret; 228 229 /* Check if feature is supported or not */ 230 ret = zynqmp_pm_feature(pm_api_id); 231 if (ret < 0) 232 return ret; 233 234 smc_arg[0] = PM_SIP_SVC | pm_api_id; 235 smc_arg[1] = ((u64)arg1 << 32) | arg0; 236 smc_arg[2] = ((u64)arg3 << 32) | arg2; 237 238 return do_fw_call(smc_arg[0], smc_arg[1], smc_arg[2], ret_payload); 239 } 240 241 static u32 pm_api_version; 242 static u32 pm_tz_version; 243 244 /** 245 * zynqmp_pm_get_api_version() - Get version number of PMU PM firmware 246 * @version: Returned version value 247 * 248 * Return: Returns status, either success or error+reason 249 */ 250 int zynqmp_pm_get_api_version(u32 *version) 251 { 252 u32 ret_payload[PAYLOAD_ARG_CNT]; 253 int ret; 254 255 if (!version) 256 return -EINVAL; 257 258 /* Check is PM API version already verified */ 259 if (pm_api_version > 0) { 260 *version = pm_api_version; 261 return 0; 262 } 263 ret = zynqmp_pm_invoke_fn(PM_GET_API_VERSION, 0, 0, 0, 0, ret_payload); 264 *version = ret_payload[1]; 265 266 return ret; 267 } 268 EXPORT_SYMBOL_GPL(zynqmp_pm_get_api_version); 269 270 /** 271 * zynqmp_pm_get_chipid - Get silicon ID registers 272 * @idcode: IDCODE register 273 * @version: version register 274 * 275 * Return: Returns the status of the operation and the idcode and version 276 * registers in @idcode and @version. 277 */ 278 int zynqmp_pm_get_chipid(u32 *idcode, u32 *version) 279 { 280 u32 ret_payload[PAYLOAD_ARG_CNT]; 281 int ret; 282 283 if (!idcode || !version) 284 return -EINVAL; 285 286 ret = zynqmp_pm_invoke_fn(PM_GET_CHIPID, 0, 0, 0, 0, ret_payload); 287 *idcode = ret_payload[1]; 288 *version = ret_payload[2]; 289 290 return ret; 291 } 292 EXPORT_SYMBOL_GPL(zynqmp_pm_get_chipid); 293 294 /** 295 * zynqmp_pm_get_trustzone_version() - Get secure trustzone firmware version 296 * @version: Returned version value 297 * 298 * Return: Returns status, either success or error+reason 299 */ 300 static int zynqmp_pm_get_trustzone_version(u32 *version) 301 { 302 u32 ret_payload[PAYLOAD_ARG_CNT]; 303 int ret; 304 305 if (!version) 306 return -EINVAL; 307 308 /* Check is PM trustzone version already verified */ 309 if (pm_tz_version > 0) { 310 *version = pm_tz_version; 311 return 0; 312 } 313 ret = zynqmp_pm_invoke_fn(PM_GET_TRUSTZONE_VERSION, 0, 0, 314 0, 0, ret_payload); 315 *version = ret_payload[1]; 316 317 return ret; 318 } 319 320 /** 321 * get_set_conduit_method() - Choose SMC or HVC based communication 322 * @np: Pointer to the device_node structure 323 * 324 * Use SMC or HVC-based functions to communicate with EL2/EL3. 325 * 326 * Return: Returns 0 on success or error code 327 */ 328 static int get_set_conduit_method(struct device_node *np) 329 { 330 const char *method; 331 332 if (of_property_read_string(np, "method", &method)) { 333 pr_warn("%s missing \"method\" property\n", __func__); 334 return -ENXIO; 335 } 336 337 if (!strcmp("hvc", method)) { 338 do_fw_call = do_fw_call_hvc; 339 } else if (!strcmp("smc", method)) { 340 do_fw_call = do_fw_call_smc; 341 } else { 342 pr_warn("%s Invalid \"method\" property: %s\n", 343 __func__, method); 344 return -EINVAL; 345 } 346 347 return 0; 348 } 349 350 /** 351 * zynqmp_pm_query_data() - Get query data from firmware 352 * @qdata: Variable to the zynqmp_pm_query_data structure 353 * @out: Returned output value 354 * 355 * Return: Returns status, either success or error+reason 356 */ 357 int zynqmp_pm_query_data(struct zynqmp_pm_query_data qdata, u32 *out) 358 { 359 int ret; 360 361 ret = zynqmp_pm_invoke_fn(PM_QUERY_DATA, qdata.qid, qdata.arg1, 362 qdata.arg2, qdata.arg3, out); 363 364 /* 365 * For clock name query, all bytes in SMC response are clock name 366 * characters and return code is always success. For invalid clocks, 367 * clock name bytes would be zeros. 368 */ 369 return qdata.qid == PM_QID_CLOCK_GET_NAME ? 0 : ret; 370 } 371 EXPORT_SYMBOL_GPL(zynqmp_pm_query_data); 372 373 /** 374 * zynqmp_pm_clock_enable() - Enable the clock for given id 375 * @clock_id: ID of the clock to be enabled 376 * 377 * This function is used by master to enable the clock 378 * including peripherals and PLL clocks. 379 * 380 * Return: Returns status, either success or error+reason 381 */ 382 int zynqmp_pm_clock_enable(u32 clock_id) 383 { 384 return zynqmp_pm_invoke_fn(PM_CLOCK_ENABLE, clock_id, 0, 0, 0, NULL); 385 } 386 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_enable); 387 388 /** 389 * zynqmp_pm_clock_disable() - Disable the clock for given id 390 * @clock_id: ID of the clock to be disable 391 * 392 * This function is used by master to disable the clock 393 * including peripherals and PLL clocks. 394 * 395 * Return: Returns status, either success or error+reason 396 */ 397 int zynqmp_pm_clock_disable(u32 clock_id) 398 { 399 return zynqmp_pm_invoke_fn(PM_CLOCK_DISABLE, clock_id, 0, 0, 0, NULL); 400 } 401 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_disable); 402 403 /** 404 * zynqmp_pm_clock_getstate() - Get the clock state for given id 405 * @clock_id: ID of the clock to be queried 406 * @state: 1/0 (Enabled/Disabled) 407 * 408 * This function is used by master to get the state of clock 409 * including peripherals and PLL clocks. 410 * 411 * Return: Returns status, either success or error+reason 412 */ 413 int zynqmp_pm_clock_getstate(u32 clock_id, u32 *state) 414 { 415 u32 ret_payload[PAYLOAD_ARG_CNT]; 416 int ret; 417 418 ret = zynqmp_pm_invoke_fn(PM_CLOCK_GETSTATE, clock_id, 0, 419 0, 0, ret_payload); 420 *state = ret_payload[1]; 421 422 return ret; 423 } 424 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_getstate); 425 426 /** 427 * zynqmp_pm_clock_setdivider() - Set the clock divider for given id 428 * @clock_id: ID of the clock 429 * @divider: divider value 430 * 431 * This function is used by master to set divider for any clock 432 * to achieve desired rate. 433 * 434 * Return: Returns status, either success or error+reason 435 */ 436 int zynqmp_pm_clock_setdivider(u32 clock_id, u32 divider) 437 { 438 return zynqmp_pm_invoke_fn(PM_CLOCK_SETDIVIDER, clock_id, divider, 439 0, 0, NULL); 440 } 441 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_setdivider); 442 443 /** 444 * zynqmp_pm_clock_getdivider() - Get the clock divider for given id 445 * @clock_id: ID of the clock 446 * @divider: divider value 447 * 448 * This function is used by master to get divider values 449 * for any clock. 450 * 451 * Return: Returns status, either success or error+reason 452 */ 453 int zynqmp_pm_clock_getdivider(u32 clock_id, u32 *divider) 454 { 455 u32 ret_payload[PAYLOAD_ARG_CNT]; 456 int ret; 457 458 ret = zynqmp_pm_invoke_fn(PM_CLOCK_GETDIVIDER, clock_id, 0, 459 0, 0, ret_payload); 460 *divider = ret_payload[1]; 461 462 return ret; 463 } 464 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_getdivider); 465 466 /** 467 * zynqmp_pm_clock_setrate() - Set the clock rate for given id 468 * @clock_id: ID of the clock 469 * @rate: rate value in hz 470 * 471 * This function is used by master to set rate for any clock. 472 * 473 * Return: Returns status, either success or error+reason 474 */ 475 int zynqmp_pm_clock_setrate(u32 clock_id, u64 rate) 476 { 477 return zynqmp_pm_invoke_fn(PM_CLOCK_SETRATE, clock_id, 478 lower_32_bits(rate), 479 upper_32_bits(rate), 480 0, NULL); 481 } 482 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_setrate); 483 484 /** 485 * zynqmp_pm_clock_getrate() - Get the clock rate for given id 486 * @clock_id: ID of the clock 487 * @rate: rate value in hz 488 * 489 * This function is used by master to get rate 490 * for any clock. 491 * 492 * Return: Returns status, either success or error+reason 493 */ 494 int zynqmp_pm_clock_getrate(u32 clock_id, u64 *rate) 495 { 496 u32 ret_payload[PAYLOAD_ARG_CNT]; 497 int ret; 498 499 ret = zynqmp_pm_invoke_fn(PM_CLOCK_GETRATE, clock_id, 0, 500 0, 0, ret_payload); 501 *rate = ((u64)ret_payload[2] << 32) | ret_payload[1]; 502 503 return ret; 504 } 505 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_getrate); 506 507 /** 508 * zynqmp_pm_clock_setparent() - Set the clock parent for given id 509 * @clock_id: ID of the clock 510 * @parent_id: parent id 511 * 512 * This function is used by master to set parent for any clock. 513 * 514 * Return: Returns status, either success or error+reason 515 */ 516 int zynqmp_pm_clock_setparent(u32 clock_id, u32 parent_id) 517 { 518 return zynqmp_pm_invoke_fn(PM_CLOCK_SETPARENT, clock_id, 519 parent_id, 0, 0, NULL); 520 } 521 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_setparent); 522 523 /** 524 * zynqmp_pm_clock_getparent() - Get the clock parent for given id 525 * @clock_id: ID of the clock 526 * @parent_id: parent id 527 * 528 * This function is used by master to get parent index 529 * for any clock. 530 * 531 * Return: Returns status, either success or error+reason 532 */ 533 int zynqmp_pm_clock_getparent(u32 clock_id, u32 *parent_id) 534 { 535 u32 ret_payload[PAYLOAD_ARG_CNT]; 536 int ret; 537 538 ret = zynqmp_pm_invoke_fn(PM_CLOCK_GETPARENT, clock_id, 0, 539 0, 0, ret_payload); 540 *parent_id = ret_payload[1]; 541 542 return ret; 543 } 544 EXPORT_SYMBOL_GPL(zynqmp_pm_clock_getparent); 545 546 /** 547 * zynqmp_pm_set_pll_frac_mode() - PM API for set PLL mode 548 * 549 * @clk_id: PLL clock ID 550 * @mode: PLL mode (PLL_MODE_FRAC/PLL_MODE_INT) 551 * 552 * This function sets PLL mode 553 * 554 * Return: Returns status, either success or error+reason 555 */ 556 int zynqmp_pm_set_pll_frac_mode(u32 clk_id, u32 mode) 557 { 558 return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_SET_PLL_FRAC_MODE, 559 clk_id, mode, NULL); 560 } 561 EXPORT_SYMBOL_GPL(zynqmp_pm_set_pll_frac_mode); 562 563 /** 564 * zynqmp_pm_get_pll_frac_mode() - PM API for get PLL mode 565 * 566 * @clk_id: PLL clock ID 567 * @mode: PLL mode 568 * 569 * This function return current PLL mode 570 * 571 * Return: Returns status, either success or error+reason 572 */ 573 int zynqmp_pm_get_pll_frac_mode(u32 clk_id, u32 *mode) 574 { 575 return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_GET_PLL_FRAC_MODE, 576 clk_id, 0, mode); 577 } 578 EXPORT_SYMBOL_GPL(zynqmp_pm_get_pll_frac_mode); 579 580 /** 581 * zynqmp_pm_set_pll_frac_data() - PM API for setting pll fraction data 582 * 583 * @clk_id: PLL clock ID 584 * @data: fraction data 585 * 586 * This function sets fraction data. 587 * It is valid for fraction mode only. 588 * 589 * Return: Returns status, either success or error+reason 590 */ 591 int zynqmp_pm_set_pll_frac_data(u32 clk_id, u32 data) 592 { 593 return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_SET_PLL_FRAC_DATA, 594 clk_id, data, NULL); 595 } 596 EXPORT_SYMBOL_GPL(zynqmp_pm_set_pll_frac_data); 597 598 /** 599 * zynqmp_pm_get_pll_frac_data() - PM API for getting pll fraction data 600 * 601 * @clk_id: PLL clock ID 602 * @data: fraction data 603 * 604 * This function returns fraction data value. 605 * 606 * Return: Returns status, either success or error+reason 607 */ 608 int zynqmp_pm_get_pll_frac_data(u32 clk_id, u32 *data) 609 { 610 return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_GET_PLL_FRAC_DATA, 611 clk_id, 0, data); 612 } 613 EXPORT_SYMBOL_GPL(zynqmp_pm_get_pll_frac_data); 614 615 /** 616 * zynqmp_pm_set_sd_tapdelay() - Set tap delay for the SD device 617 * 618 * @node_id: Node ID of the device 619 * @type: Type of tap delay to set (input/output) 620 * @value: Value to set fot the tap delay 621 * 622 * This function sets input/output tap delay for the SD device. 623 * 624 * Return: Returns status, either success or error+reason 625 */ 626 int zynqmp_pm_set_sd_tapdelay(u32 node_id, u32 type, u32 value) 627 { 628 return zynqmp_pm_invoke_fn(PM_IOCTL, node_id, IOCTL_SET_SD_TAPDELAY, 629 type, value, NULL); 630 } 631 EXPORT_SYMBOL_GPL(zynqmp_pm_set_sd_tapdelay); 632 633 /** 634 * zynqmp_pm_sd_dll_reset() - Reset DLL logic 635 * 636 * @node_id: Node ID of the device 637 * @type: Reset type 638 * 639 * This function resets DLL logic for the SD device. 640 * 641 * Return: Returns status, either success or error+reason 642 */ 643 int zynqmp_pm_sd_dll_reset(u32 node_id, u32 type) 644 { 645 return zynqmp_pm_invoke_fn(PM_IOCTL, node_id, IOCTL_SD_DLL_RESET, 646 type, 0, NULL); 647 } 648 EXPORT_SYMBOL_GPL(zynqmp_pm_sd_dll_reset); 649 650 /** 651 * zynqmp_pm_write_ggs() - PM API for writing global general storage (ggs) 652 * @index: GGS register index 653 * @value: Register value to be written 654 * 655 * This function writes value to GGS register. 656 * 657 * Return: Returns status, either success or error+reason 658 */ 659 int zynqmp_pm_write_ggs(u32 index, u32 value) 660 { 661 return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_WRITE_GGS, 662 index, value, NULL); 663 } 664 EXPORT_SYMBOL_GPL(zynqmp_pm_write_ggs); 665 666 /** 667 * zynqmp_pm_write_ggs() - PM API for reading global general storage (ggs) 668 * @index: GGS register index 669 * @value: Register value to be written 670 * 671 * This function returns GGS register value. 672 * 673 * Return: Returns status, either success or error+reason 674 */ 675 int zynqmp_pm_read_ggs(u32 index, u32 *value) 676 { 677 return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_READ_GGS, 678 index, 0, value); 679 } 680 EXPORT_SYMBOL_GPL(zynqmp_pm_read_ggs); 681 682 /** 683 * zynqmp_pm_write_pggs() - PM API for writing persistent global general 684 * storage (pggs) 685 * @index: PGGS register index 686 * @value: Register value to be written 687 * 688 * This function writes value to PGGS register. 689 * 690 * Return: Returns status, either success or error+reason 691 */ 692 int zynqmp_pm_write_pggs(u32 index, u32 value) 693 { 694 return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_WRITE_PGGS, index, value, 695 NULL); 696 } 697 EXPORT_SYMBOL_GPL(zynqmp_pm_write_pggs); 698 699 /** 700 * zynqmp_pm_write_pggs() - PM API for reading persistent global general 701 * storage (pggs) 702 * @index: PGGS register index 703 * @value: Register value to be written 704 * 705 * This function returns PGGS register value. 706 * 707 * Return: Returns status, either success or error+reason 708 */ 709 int zynqmp_pm_read_pggs(u32 index, u32 *value) 710 { 711 return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_READ_PGGS, index, 0, 712 value); 713 } 714 EXPORT_SYMBOL_GPL(zynqmp_pm_read_pggs); 715 716 /** 717 * zynqmp_pm_set_boot_health_status() - PM API for setting healthy boot status 718 * @value: Status value to be written 719 * 720 * This function sets healthy bit value to indicate boot health status 721 * to firmware. 722 * 723 * Return: Returns status, either success or error+reason 724 */ 725 int zynqmp_pm_set_boot_health_status(u32 value) 726 { 727 return zynqmp_pm_invoke_fn(PM_IOCTL, 0, IOCTL_SET_BOOT_HEALTH_STATUS, 728 value, 0, NULL); 729 } 730 731 /** 732 * zynqmp_pm_reset_assert - Request setting of reset (1 - assert, 0 - release) 733 * @reset: Reset to be configured 734 * @assert_flag: Flag stating should reset be asserted (1) or 735 * released (0) 736 * 737 * Return: Returns status, either success or error+reason 738 */ 739 int zynqmp_pm_reset_assert(const enum zynqmp_pm_reset reset, 740 const enum zynqmp_pm_reset_action assert_flag) 741 { 742 return zynqmp_pm_invoke_fn(PM_RESET_ASSERT, reset, assert_flag, 743 0, 0, NULL); 744 } 745 EXPORT_SYMBOL_GPL(zynqmp_pm_reset_assert); 746 747 /** 748 * zynqmp_pm_reset_get_status - Get status of the reset 749 * @reset: Reset whose status should be returned 750 * @status: Returned status 751 * 752 * Return: Returns status, either success or error+reason 753 */ 754 int zynqmp_pm_reset_get_status(const enum zynqmp_pm_reset reset, u32 *status) 755 { 756 u32 ret_payload[PAYLOAD_ARG_CNT]; 757 int ret; 758 759 if (!status) 760 return -EINVAL; 761 762 ret = zynqmp_pm_invoke_fn(PM_RESET_GET_STATUS, reset, 0, 763 0, 0, ret_payload); 764 *status = ret_payload[1]; 765 766 return ret; 767 } 768 EXPORT_SYMBOL_GPL(zynqmp_pm_reset_get_status); 769 770 /** 771 * zynqmp_pm_fpga_load - Perform the fpga load 772 * @address: Address to write to 773 * @size: pl bitstream size 774 * @flags: Bitstream type 775 * -XILINX_ZYNQMP_PM_FPGA_FULL: FPGA full reconfiguration 776 * -XILINX_ZYNQMP_PM_FPGA_PARTIAL: FPGA partial reconfiguration 777 * 778 * This function provides access to pmufw. To transfer 779 * the required bitstream into PL. 780 * 781 * Return: Returns status, either success or error+reason 782 */ 783 int zynqmp_pm_fpga_load(const u64 address, const u32 size, const u32 flags) 784 { 785 return zynqmp_pm_invoke_fn(PM_FPGA_LOAD, lower_32_bits(address), 786 upper_32_bits(address), size, flags, NULL); 787 } 788 EXPORT_SYMBOL_GPL(zynqmp_pm_fpga_load); 789 790 /** 791 * zynqmp_pm_fpga_get_status - Read value from PCAP status register 792 * @value: Value to read 793 * 794 * This function provides access to the pmufw to get the PCAP 795 * status 796 * 797 * Return: Returns status, either success or error+reason 798 */ 799 int zynqmp_pm_fpga_get_status(u32 *value) 800 { 801 u32 ret_payload[PAYLOAD_ARG_CNT]; 802 int ret; 803 804 if (!value) 805 return -EINVAL; 806 807 ret = zynqmp_pm_invoke_fn(PM_FPGA_GET_STATUS, 0, 0, 0, 0, ret_payload); 808 *value = ret_payload[1]; 809 810 return ret; 811 } 812 EXPORT_SYMBOL_GPL(zynqmp_pm_fpga_get_status); 813 814 /** 815 * zynqmp_pm_init_finalize() - PM call to inform firmware that the caller 816 * master has initialized its own power management 817 * 818 * Return: Returns status, either success or error+reason 819 * 820 * This API function is to be used for notify the power management controller 821 * about the completed power management initialization. 822 */ 823 int zynqmp_pm_init_finalize(void) 824 { 825 return zynqmp_pm_invoke_fn(PM_PM_INIT_FINALIZE, 0, 0, 0, 0, NULL); 826 } 827 EXPORT_SYMBOL_GPL(zynqmp_pm_init_finalize); 828 829 /** 830 * zynqmp_pm_set_suspend_mode() - Set system suspend mode 831 * @mode: Mode to set for system suspend 832 * 833 * This API function is used to set mode of system suspend. 834 * 835 * Return: Returns status, either success or error+reason 836 */ 837 int zynqmp_pm_set_suspend_mode(u32 mode) 838 { 839 return zynqmp_pm_invoke_fn(PM_SET_SUSPEND_MODE, mode, 0, 0, 0, NULL); 840 } 841 EXPORT_SYMBOL_GPL(zynqmp_pm_set_suspend_mode); 842 843 /** 844 * zynqmp_pm_request_node() - Request a node with specific capabilities 845 * @node: Node ID of the slave 846 * @capabilities: Requested capabilities of the slave 847 * @qos: Quality of service (not supported) 848 * @ack: Flag to specify whether acknowledge is requested 849 * 850 * This function is used by master to request particular node from firmware. 851 * Every master must request node before using it. 852 * 853 * Return: Returns status, either success or error+reason 854 */ 855 int zynqmp_pm_request_node(const u32 node, const u32 capabilities, 856 const u32 qos, const enum zynqmp_pm_request_ack ack) 857 { 858 return zynqmp_pm_invoke_fn(PM_REQUEST_NODE, node, capabilities, 859 qos, ack, NULL); 860 } 861 EXPORT_SYMBOL_GPL(zynqmp_pm_request_node); 862 863 /** 864 * zynqmp_pm_release_node() - Release a node 865 * @node: Node ID of the slave 866 * 867 * This function is used by master to inform firmware that master 868 * has released node. Once released, master must not use that node 869 * without re-request. 870 * 871 * Return: Returns status, either success or error+reason 872 */ 873 int zynqmp_pm_release_node(const u32 node) 874 { 875 return zynqmp_pm_invoke_fn(PM_RELEASE_NODE, node, 0, 0, 0, NULL); 876 } 877 EXPORT_SYMBOL_GPL(zynqmp_pm_release_node); 878 879 /** 880 * zynqmp_pm_set_requirement() - PM call to set requirement for PM slaves 881 * @node: Node ID of the slave 882 * @capabilities: Requested capabilities of the slave 883 * @qos: Quality of service (not supported) 884 * @ack: Flag to specify whether acknowledge is requested 885 * 886 * This API function is to be used for slaves a PU already has requested 887 * to change its capabilities. 888 * 889 * Return: Returns status, either success or error+reason 890 */ 891 int zynqmp_pm_set_requirement(const u32 node, const u32 capabilities, 892 const u32 qos, 893 const enum zynqmp_pm_request_ack ack) 894 { 895 return zynqmp_pm_invoke_fn(PM_SET_REQUIREMENT, node, capabilities, 896 qos, ack, NULL); 897 } 898 EXPORT_SYMBOL_GPL(zynqmp_pm_set_requirement); 899 900 /** 901 * zynqmp_pm_aes - Access AES hardware to encrypt/decrypt the data using 902 * AES-GCM core. 903 * @address: Address of the AesParams structure. 904 * @out: Returned output value 905 * 906 * Return: Returns status, either success or error code. 907 */ 908 int zynqmp_pm_aes_engine(const u64 address, u32 *out) 909 { 910 u32 ret_payload[PAYLOAD_ARG_CNT]; 911 int ret; 912 913 if (!out) 914 return -EINVAL; 915 916 ret = zynqmp_pm_invoke_fn(PM_SECURE_AES, upper_32_bits(address), 917 lower_32_bits(address), 918 0, 0, ret_payload); 919 *out = ret_payload[1]; 920 921 return ret; 922 } 923 EXPORT_SYMBOL_GPL(zynqmp_pm_aes_engine); 924 925 /** 926 * zynqmp_pm_system_shutdown - PM call to request a system shutdown or restart 927 * @type: Shutdown or restart? 0 for shutdown, 1 for restart 928 * @subtype: Specifies which system should be restarted or shut down 929 * 930 * Return: Returns status, either success or error+reason 931 */ 932 int zynqmp_pm_system_shutdown(const u32 type, const u32 subtype) 933 { 934 return zynqmp_pm_invoke_fn(PM_SYSTEM_SHUTDOWN, type, subtype, 935 0, 0, NULL); 936 } 937 938 /** 939 * struct zynqmp_pm_shutdown_scope - Struct for shutdown scope 940 * @subtype: Shutdown subtype 941 * @name: Matching string for scope argument 942 * 943 * This struct encapsulates mapping between shutdown scope ID and string. 944 */ 945 struct zynqmp_pm_shutdown_scope { 946 const enum zynqmp_pm_shutdown_subtype subtype; 947 const char *name; 948 }; 949 950 static struct zynqmp_pm_shutdown_scope shutdown_scopes[] = { 951 [ZYNQMP_PM_SHUTDOWN_SUBTYPE_SUBSYSTEM] = { 952 .subtype = ZYNQMP_PM_SHUTDOWN_SUBTYPE_SUBSYSTEM, 953 .name = "subsystem", 954 }, 955 [ZYNQMP_PM_SHUTDOWN_SUBTYPE_PS_ONLY] = { 956 .subtype = ZYNQMP_PM_SHUTDOWN_SUBTYPE_PS_ONLY, 957 .name = "ps_only", 958 }, 959 [ZYNQMP_PM_SHUTDOWN_SUBTYPE_SYSTEM] = { 960 .subtype = ZYNQMP_PM_SHUTDOWN_SUBTYPE_SYSTEM, 961 .name = "system", 962 }, 963 }; 964 965 static struct zynqmp_pm_shutdown_scope *selected_scope = 966 &shutdown_scopes[ZYNQMP_PM_SHUTDOWN_SUBTYPE_SYSTEM]; 967 968 /** 969 * zynqmp_pm_is_shutdown_scope_valid - Check if shutdown scope string is valid 970 * @scope_string: Shutdown scope string 971 * 972 * Return: Return pointer to matching shutdown scope struct from 973 * array of available options in system if string is valid, 974 * otherwise returns NULL. 975 */ 976 static struct zynqmp_pm_shutdown_scope* 977 zynqmp_pm_is_shutdown_scope_valid(const char *scope_string) 978 { 979 int count; 980 981 for (count = 0; count < ARRAY_SIZE(shutdown_scopes); count++) 982 if (sysfs_streq(scope_string, shutdown_scopes[count].name)) 983 return &shutdown_scopes[count]; 984 985 return NULL; 986 } 987 988 static ssize_t shutdown_scope_show(struct device *device, 989 struct device_attribute *attr, 990 char *buf) 991 { 992 int i; 993 994 for (i = 0; i < ARRAY_SIZE(shutdown_scopes); i++) { 995 if (&shutdown_scopes[i] == selected_scope) { 996 strcat(buf, "["); 997 strcat(buf, shutdown_scopes[i].name); 998 strcat(buf, "]"); 999 } else { 1000 strcat(buf, shutdown_scopes[i].name); 1001 } 1002 strcat(buf, " "); 1003 } 1004 strcat(buf, "\n"); 1005 1006 return strlen(buf); 1007 } 1008 1009 static ssize_t shutdown_scope_store(struct device *device, 1010 struct device_attribute *attr, 1011 const char *buf, size_t count) 1012 { 1013 int ret; 1014 struct zynqmp_pm_shutdown_scope *scope; 1015 1016 scope = zynqmp_pm_is_shutdown_scope_valid(buf); 1017 if (!scope) 1018 return -EINVAL; 1019 1020 ret = zynqmp_pm_system_shutdown(ZYNQMP_PM_SHUTDOWN_TYPE_SETSCOPE_ONLY, 1021 scope->subtype); 1022 if (ret) { 1023 pr_err("unable to set shutdown scope %s\n", buf); 1024 return ret; 1025 } 1026 1027 selected_scope = scope; 1028 1029 return count; 1030 } 1031 1032 static DEVICE_ATTR_RW(shutdown_scope); 1033 1034 static ssize_t health_status_store(struct device *device, 1035 struct device_attribute *attr, 1036 const char *buf, size_t count) 1037 { 1038 int ret; 1039 unsigned int value; 1040 1041 ret = kstrtouint(buf, 10, &value); 1042 if (ret) 1043 return ret; 1044 1045 ret = zynqmp_pm_set_boot_health_status(value); 1046 if (ret) { 1047 dev_err(device, "unable to set healthy bit value to %u\n", 1048 value); 1049 return ret; 1050 } 1051 1052 return count; 1053 } 1054 1055 static DEVICE_ATTR_WO(health_status); 1056 1057 static ssize_t ggs_show(struct device *device, 1058 struct device_attribute *attr, 1059 char *buf, 1060 u32 reg) 1061 { 1062 int ret; 1063 u32 ret_payload[PAYLOAD_ARG_CNT]; 1064 1065 ret = zynqmp_pm_read_ggs(reg, ret_payload); 1066 if (ret) 1067 return ret; 1068 1069 return sprintf(buf, "0x%x\n", ret_payload[1]); 1070 } 1071 1072 static ssize_t ggs_store(struct device *device, 1073 struct device_attribute *attr, 1074 const char *buf, size_t count, 1075 u32 reg) 1076 { 1077 long value; 1078 int ret; 1079 1080 if (reg >= GSS_NUM_REGS) 1081 return -EINVAL; 1082 1083 ret = kstrtol(buf, 16, &value); 1084 if (ret) { 1085 count = -EFAULT; 1086 goto err; 1087 } 1088 1089 ret = zynqmp_pm_write_ggs(reg, value); 1090 if (ret) 1091 count = -EFAULT; 1092 err: 1093 return count; 1094 } 1095 1096 /* GGS register show functions */ 1097 #define GGS0_SHOW(N) \ 1098 ssize_t ggs##N##_show(struct device *device, \ 1099 struct device_attribute *attr, \ 1100 char *buf) \ 1101 { \ 1102 return ggs_show(device, attr, buf, N); \ 1103 } 1104 1105 static GGS0_SHOW(0); 1106 static GGS0_SHOW(1); 1107 static GGS0_SHOW(2); 1108 static GGS0_SHOW(3); 1109 1110 /* GGS register store function */ 1111 #define GGS0_STORE(N) \ 1112 ssize_t ggs##N##_store(struct device *device, \ 1113 struct device_attribute *attr, \ 1114 const char *buf, \ 1115 size_t count) \ 1116 { \ 1117 return ggs_store(device, attr, buf, count, N); \ 1118 } 1119 1120 static GGS0_STORE(0); 1121 static GGS0_STORE(1); 1122 static GGS0_STORE(2); 1123 static GGS0_STORE(3); 1124 1125 static ssize_t pggs_show(struct device *device, 1126 struct device_attribute *attr, 1127 char *buf, 1128 u32 reg) 1129 { 1130 int ret; 1131 u32 ret_payload[PAYLOAD_ARG_CNT]; 1132 1133 ret = zynqmp_pm_read_pggs(reg, ret_payload); 1134 if (ret) 1135 return ret; 1136 1137 return sprintf(buf, "0x%x\n", ret_payload[1]); 1138 } 1139 1140 static ssize_t pggs_store(struct device *device, 1141 struct device_attribute *attr, 1142 const char *buf, size_t count, 1143 u32 reg) 1144 { 1145 long value; 1146 int ret; 1147 1148 if (reg >= GSS_NUM_REGS) 1149 return -EINVAL; 1150 1151 ret = kstrtol(buf, 16, &value); 1152 if (ret) { 1153 count = -EFAULT; 1154 goto err; 1155 } 1156 1157 ret = zynqmp_pm_write_pggs(reg, value); 1158 if (ret) 1159 count = -EFAULT; 1160 1161 err: 1162 return count; 1163 } 1164 1165 #define PGGS0_SHOW(N) \ 1166 ssize_t pggs##N##_show(struct device *device, \ 1167 struct device_attribute *attr, \ 1168 char *buf) \ 1169 { \ 1170 return pggs_show(device, attr, buf, N); \ 1171 } 1172 1173 #define PGGS0_STORE(N) \ 1174 ssize_t pggs##N##_store(struct device *device, \ 1175 struct device_attribute *attr, \ 1176 const char *buf, \ 1177 size_t count) \ 1178 { \ 1179 return pggs_store(device, attr, buf, count, N); \ 1180 } 1181 1182 /* PGGS register show functions */ 1183 static PGGS0_SHOW(0); 1184 static PGGS0_SHOW(1); 1185 static PGGS0_SHOW(2); 1186 static PGGS0_SHOW(3); 1187 1188 /* PGGS register store functions */ 1189 static PGGS0_STORE(0); 1190 static PGGS0_STORE(1); 1191 static PGGS0_STORE(2); 1192 static PGGS0_STORE(3); 1193 1194 /* GGS register attributes */ 1195 static DEVICE_ATTR_RW(ggs0); 1196 static DEVICE_ATTR_RW(ggs1); 1197 static DEVICE_ATTR_RW(ggs2); 1198 static DEVICE_ATTR_RW(ggs3); 1199 1200 /* PGGS register attributes */ 1201 static DEVICE_ATTR_RW(pggs0); 1202 static DEVICE_ATTR_RW(pggs1); 1203 static DEVICE_ATTR_RW(pggs2); 1204 static DEVICE_ATTR_RW(pggs3); 1205 1206 static struct attribute *zynqmp_firmware_attrs[] = { 1207 &dev_attr_ggs0.attr, 1208 &dev_attr_ggs1.attr, 1209 &dev_attr_ggs2.attr, 1210 &dev_attr_ggs3.attr, 1211 &dev_attr_pggs0.attr, 1212 &dev_attr_pggs1.attr, 1213 &dev_attr_pggs2.attr, 1214 &dev_attr_pggs3.attr, 1215 &dev_attr_shutdown_scope.attr, 1216 &dev_attr_health_status.attr, 1217 NULL, 1218 }; 1219 1220 ATTRIBUTE_GROUPS(zynqmp_firmware); 1221 1222 static int zynqmp_firmware_probe(struct platform_device *pdev) 1223 { 1224 struct device *dev = &pdev->dev; 1225 struct device_node *np; 1226 int ret; 1227 1228 np = of_find_compatible_node(NULL, NULL, "xlnx,zynqmp"); 1229 if (!np) { 1230 np = of_find_compatible_node(NULL, NULL, "xlnx,versal"); 1231 if (!np) 1232 return 0; 1233 1234 feature_check_enabled = true; 1235 } 1236 of_node_put(np); 1237 1238 ret = get_set_conduit_method(dev->of_node); 1239 if (ret) 1240 return ret; 1241 1242 /* Check PM API version number */ 1243 zynqmp_pm_get_api_version(&pm_api_version); 1244 if (pm_api_version < ZYNQMP_PM_VERSION) { 1245 panic("%s Platform Management API version error. Expected: v%d.%d - Found: v%d.%d\n", 1246 __func__, 1247 ZYNQMP_PM_VERSION_MAJOR, ZYNQMP_PM_VERSION_MINOR, 1248 pm_api_version >> 16, pm_api_version & 0xFFFF); 1249 } 1250 1251 pr_info("%s Platform Management API v%d.%d\n", __func__, 1252 pm_api_version >> 16, pm_api_version & 0xFFFF); 1253 1254 /* Check trustzone version number */ 1255 ret = zynqmp_pm_get_trustzone_version(&pm_tz_version); 1256 if (ret) 1257 panic("Legacy trustzone found without version support\n"); 1258 1259 if (pm_tz_version < ZYNQMP_TZ_VERSION) 1260 panic("%s Trustzone version error. Expected: v%d.%d - Found: v%d.%d\n", 1261 __func__, 1262 ZYNQMP_TZ_VERSION_MAJOR, ZYNQMP_TZ_VERSION_MINOR, 1263 pm_tz_version >> 16, pm_tz_version & 0xFFFF); 1264 1265 pr_info("%s Trustzone version v%d.%d\n", __func__, 1266 pm_tz_version >> 16, pm_tz_version & 0xFFFF); 1267 1268 ret = mfd_add_devices(&pdev->dev, PLATFORM_DEVID_NONE, firmware_devs, 1269 ARRAY_SIZE(firmware_devs), NULL, 0, NULL); 1270 if (ret) { 1271 dev_err(&pdev->dev, "failed to add MFD devices %d\n", ret); 1272 return ret; 1273 } 1274 1275 zynqmp_pm_api_debugfs_init(); 1276 1277 return of_platform_populate(dev->of_node, NULL, NULL, dev); 1278 } 1279 1280 static int zynqmp_firmware_remove(struct platform_device *pdev) 1281 { 1282 struct pm_api_feature_data *feature_data; 1283 int i; 1284 1285 mfd_remove_devices(&pdev->dev); 1286 zynqmp_pm_api_debugfs_exit(); 1287 1288 hash_for_each(pm_api_features_map, i, feature_data, hentry) { 1289 hash_del(&feature_data->hentry); 1290 kfree(feature_data); 1291 } 1292 1293 return 0; 1294 } 1295 1296 static const struct of_device_id zynqmp_firmware_of_match[] = { 1297 {.compatible = "xlnx,zynqmp-firmware"}, 1298 {.compatible = "xlnx,versal-firmware"}, 1299 {}, 1300 }; 1301 MODULE_DEVICE_TABLE(of, zynqmp_firmware_of_match); 1302 1303 static struct platform_driver zynqmp_firmware_driver = { 1304 .driver = { 1305 .name = "zynqmp_firmware", 1306 .of_match_table = zynqmp_firmware_of_match, 1307 .dev_groups = zynqmp_firmware_groups, 1308 }, 1309 .probe = zynqmp_firmware_probe, 1310 .remove = zynqmp_firmware_remove, 1311 }; 1312 module_platform_driver(zynqmp_firmware_driver); 1313