Tejas Patel | 9d09ff9 | 2019-01-08 01:46:35 -0800 | [diff] [blame] | 1 | /* |
Tanmay Shah | ff34daa | 2021-08-09 11:00:41 -0700 | [diff] [blame] | 2 | * Copyright (c) 2019-2022, Xilinx, Inc. All rights reserved. |
Tanmay Shah | fdae9e8 | 2022-08-26 15:06:00 -0700 | [diff] [blame] | 3 | * Copyright (c) 2022, Advanced Micro Devices, Inc. All rights reserved. |
Tejas Patel | 9d09ff9 | 2019-01-08 01:46:35 -0800 | [diff] [blame] | 4 | * |
| 5 | * SPDX-License-Identifier: BSD-3-Clause |
| 6 | */ |
| 7 | |
| 8 | #ifndef PM_API_SYS_H |
| 9 | #define PM_API_SYS_H |
| 10 | |
| 11 | #include <stdint.h> |
Tejas Patel | fe0e10a | 2019-12-08 23:29:44 -0800 | [diff] [blame] | 12 | #include "pm_defs.h" |
Tejas Patel | 9d09ff9 | 2019-01-08 01:46:35 -0800 | [diff] [blame] | 13 | |
Venkatesh Yadav Abbarapu | 94cf1a7 | 2022-07-12 09:06:01 +0530 | [diff] [blame] | 14 | /********************************************************************* |
| 15 | * Target module IDs macros |
| 16 | ********************************************************************/ |
| 17 | #define LIBPM_MODULE_ID 0x2U |
| 18 | #define LOADER_MODULE_ID 0x7U |
| 19 | |
Michal Simek | 47fd75a | 2022-07-27 14:17:30 +0200 | [diff] [blame] | 20 | #define MODULE_ID_MASK 0x0000ff00U |
Tejas Patel | 9d09ff9 | 2019-01-08 01:46:35 -0800 | [diff] [blame] | 21 | /********************************************************** |
| 22 | * PM API function declarations |
| 23 | **********************************************************/ |
| 24 | |
Tanmay Shah | ff34daa | 2021-08-09 11:00:41 -0700 | [diff] [blame] | 25 | enum pm_ret_status pm_handle_eemi_call(uint32_t flag, uint32_t x0, uint32_t x1, |
| 26 | uint32_t x2, uint32_t x3, uint32_t x4, |
| 27 | uint32_t x5, uint64_t *result); |
Tejas Patel | fe0e10a | 2019-12-08 23:29:44 -0800 | [diff] [blame] | 28 | enum pm_ret_status pm_self_suspend(uint32_t nid, |
Venkatesh Yadav Abbarapu | bde8759 | 2022-05-24 11:11:12 +0530 | [diff] [blame] | 29 | uint32_t latency, |
| 30 | uint32_t state, |
Tejas Patel | 18072da | 2021-02-25 20:16:56 -0800 | [diff] [blame] | 31 | uintptr_t address, uint32_t flag); |
| 32 | enum pm_ret_status pm_abort_suspend(enum pm_abort_reason reason, uint32_t flag); |
Tejas Patel | fe0e10a | 2019-12-08 23:29:44 -0800 | [diff] [blame] | 33 | enum pm_ret_status pm_req_suspend(uint32_t target, |
| 34 | uint8_t ack, |
Venkatesh Yadav Abbarapu | bde8759 | 2022-05-24 11:11:12 +0530 | [diff] [blame] | 35 | uint32_t latency, |
| 36 | uint32_t state, uint32_t flag); |
Tejas Patel | 49cd871 | 2019-01-23 14:18:51 +0530 | [diff] [blame] | 37 | enum pm_ret_status pm_req_wakeup(uint32_t target, uint32_t set_address, |
Tejas Patel | 18072da | 2021-02-25 20:16:56 -0800 | [diff] [blame] | 38 | uintptr_t address, uint8_t ack, uint32_t flag); |
Tejas Patel | db81205 | 2019-01-23 14:18:53 +0530 | [diff] [blame] | 39 | enum pm_ret_status pm_set_wakeup_source(uint32_t target, uint32_t device_id, |
Tejas Patel | 18072da | 2021-02-25 20:16:56 -0800 | [diff] [blame] | 40 | uint8_t enable, uint32_t flag); |
Naman Trivedi Manojbhai | beec83f | 2023-03-07 12:41:12 +0530 | [diff] [blame] | 41 | enum pm_ret_status pm_get_callbackdata(uint32_t *data, size_t count, uint32_t flag, |
Tanmay Shah | fdae9e8 | 2022-08-26 15:06:00 -0700 | [diff] [blame] | 42 | uint32_t ack); |
Tejas Patel | 023116d | 2019-01-08 01:46:41 -0800 | [diff] [blame] | 43 | enum pm_ret_status pm_pll_set_param(uint32_t clk_id, uint32_t param, |
Tejas Patel | 18072da | 2021-02-25 20:16:56 -0800 | [diff] [blame] | 44 | uint32_t value, uint32_t flag); |
Tejas Patel | 023116d | 2019-01-08 01:46:41 -0800 | [diff] [blame] | 45 | enum pm_ret_status pm_pll_get_param(uint32_t clk_id, uint32_t param, |
Tejas Patel | 18072da | 2021-02-25 20:16:56 -0800 | [diff] [blame] | 46 | uint32_t *value, uint32_t flag); |
| 47 | enum pm_ret_status pm_pll_set_mode(uint32_t clk_id, uint32_t mode, |
| 48 | uint32_t flag); |
| 49 | enum pm_ret_status pm_pll_get_mode(uint32_t clk_id, uint32_t *mode, |
| 50 | uint32_t flag); |
| 51 | enum pm_ret_status pm_force_powerdown(uint32_t target, uint8_t ack, |
| 52 | uint32_t flag); |
| 53 | enum pm_ret_status pm_system_shutdown(uint32_t type, uint32_t subtype, |
| 54 | uint32_t flag); |
Tejas Patel | 9141f44 | 2019-01-10 03:03:48 -0800 | [diff] [blame] | 55 | enum pm_ret_status pm_api_ioctl(uint32_t device_id, uint32_t ioctl_id, |
Venkatesh Yadav Abbarapu | 4b23339 | 2021-10-20 22:11:53 -0600 | [diff] [blame] | 56 | uint32_t arg1, uint32_t arg2, uint32_t arg3, |
| 57 | uint32_t *value, uint32_t flag); |
Tejas Patel | a3e34ad | 2019-02-01 17:25:19 +0530 | [diff] [blame] | 58 | enum pm_ret_status pm_query_data(uint32_t qid, uint32_t arg1, uint32_t arg2, |
Tejas Patel | 18072da | 2021-02-25 20:16:56 -0800 | [diff] [blame] | 59 | uint32_t arg3, uint32_t *data, uint32_t flag); |
Venkatesh Yadav Abbarapu | bde8759 | 2022-05-24 11:11:12 +0530 | [diff] [blame] | 60 | uint32_t pm_get_shutdown_scope(void); |
Ronak Jain | 70d1c58 | 2022-02-04 00:42:55 -0800 | [diff] [blame] | 61 | enum pm_ret_status pm_feature_check(uint32_t api_id, uint32_t *ret_payload, |
Tejas Patel | 18072da | 2021-02-25 20:16:56 -0800 | [diff] [blame] | 62 | uint32_t flag); |
Jolly Shah | ed05a71 | 2019-03-22 05:33:39 +0530 | [diff] [blame] | 63 | enum pm_ret_status pm_load_pdi(uint32_t src, uint32_t address_low, |
Tejas Patel | 18072da | 2021-02-25 20:16:56 -0800 | [diff] [blame] | 64 | uint32_t address_high, uint32_t flag); |
Tejas Patel | 4201555 | 2020-11-25 01:56:57 -0800 | [diff] [blame] | 65 | enum pm_ret_status pm_register_notifier(uint32_t device_id, uint32_t event, |
Tejas Patel | 18072da | 2021-02-25 20:16:56 -0800 | [diff] [blame] | 66 | uint32_t wake, uint32_t enable, |
| 67 | uint32_t flag); |
Venkatesh Yadav Abbarapu | 94cf1a7 | 2022-07-12 09:06:01 +0530 | [diff] [blame] | 68 | |
| 69 | /** |
| 70 | * Assigning of argument values into array elements. |
| 71 | */ |
| 72 | #define PM_PACK_PAYLOAD1(pl, mid, flag, arg0) { \ |
| 73 | pl[0] = (uint32_t)(((uint32_t)(arg0) & 0xFFU) | ((mid) << 8U) | ((flag) << 24U)); \ |
| 74 | } |
| 75 | |
| 76 | #define PM_PACK_PAYLOAD2(pl, mid, flag, arg0, arg1) { \ |
| 77 | pl[1] = (uint32_t)(arg1); \ |
| 78 | PM_PACK_PAYLOAD1(pl, (mid), (flag), (arg0)); \ |
| 79 | } |
| 80 | |
| 81 | #define PM_PACK_PAYLOAD3(pl, mid, flag, arg0, arg1, arg2) { \ |
| 82 | pl[2] = (uint32_t)(arg2); \ |
| 83 | PM_PACK_PAYLOAD2(pl, (mid), (flag), (arg0), (arg1)); \ |
| 84 | } |
| 85 | |
| 86 | #define PM_PACK_PAYLOAD4(pl, mid, flag, arg0, arg1, arg2, arg3) { \ |
| 87 | pl[3] = (uint32_t)(arg3); \ |
| 88 | PM_PACK_PAYLOAD3(pl, (mid), (flag), (arg0), (arg1), (arg2)); \ |
| 89 | } |
| 90 | |
| 91 | #define PM_PACK_PAYLOAD5(pl, mid, flag, arg0, arg1, arg2, arg3, arg4) { \ |
| 92 | pl[4] = (uint32_t)(arg4); \ |
| 93 | PM_PACK_PAYLOAD4(pl, (mid), (flag), (arg0), (arg1), (arg2), (arg3)); \ |
| 94 | } |
| 95 | |
| 96 | #define PM_PACK_PAYLOAD6(pl, mid, flag, arg0, arg1, arg2, arg3, arg4, arg5) { \ |
| 97 | pl[5] = (uint32_t)(arg5); \ |
| 98 | PM_PACK_PAYLOAD5(pl, (mid), (flag), (arg0), (arg1), (arg2), (arg3), (arg4)); \ |
| 99 | } |
| 100 | |
Tejas Patel | 9d09ff9 | 2019-01-08 01:46:35 -0800 | [diff] [blame] | 101 | #endif /* PM_API_SYS_H */ |