Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 1 | /* |
Ronak Jain | 52de594 | 2022-01-20 23:11:18 -0800 | [diff] [blame] | 2 | * Copyright (c) 2013-2022, ARM Limited and Contributors. All rights reserved. |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 3 | * |
dp-arm | fa3cf0b | 2017-05-03 09:38:09 +0100 | [diff] [blame] | 4 | * SPDX-License-Identifier: BSD-3-Clause |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 5 | */ |
| 6 | |
Antonio Nino Diaz | 5eb8837 | 2018-11-08 10:20:19 +0000 | [diff] [blame] | 7 | #ifndef PM_API_SYS_H |
| 8 | #define PM_API_SYS_H |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 9 | |
| 10 | #include <stdint.h> |
Antonio Nino Diaz | e0f9063 | 2018-12-14 00:18:21 +0000 | [diff] [blame] | 11 | |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 12 | #include "pm_defs.h" |
| 13 | |
Rajan Vaja | 3511613 | 2018-01-17 02:39:25 -0800 | [diff] [blame] | 14 | enum pm_query_id { |
| 15 | PM_QID_INVALID, |
| 16 | PM_QID_CLOCK_GET_NAME, |
| 17 | PM_QID_CLOCK_GET_TOPOLOGY, |
| 18 | PM_QID_CLOCK_GET_FIXEDFACTOR_PARAMS, |
| 19 | PM_QID_CLOCK_GET_PARENTS, |
| 20 | PM_QID_CLOCK_GET_ATTRIBUTES, |
Rajan Vaja | d5dd836 | 2018-01-30 04:16:31 -0800 | [diff] [blame] | 21 | PM_QID_PINCTRL_GET_NUM_PINS, |
| 22 | PM_QID_PINCTRL_GET_NUM_FUNCTIONS, |
| 23 | PM_QID_PINCTRL_GET_NUM_FUNCTION_GROUPS, |
| 24 | PM_QID_PINCTRL_GET_FUNCTION_NAME, |
| 25 | PM_QID_PINCTRL_GET_FUNCTION_GROUPS, |
| 26 | PM_QID_PINCTRL_GET_PIN_GROUPS, |
Rajan Vaja | da95940 | 2018-07-20 03:16:27 -0700 | [diff] [blame] | 27 | PM_QID_CLOCK_GET_NUM_CLOCKS, |
Rajan Vaja | b34deca | 2019-03-20 01:13:21 +0530 | [diff] [blame] | 28 | PM_QID_CLOCK_GET_MAX_DIVISOR, |
Rajan Vaja | 3511613 | 2018-01-17 02:39:25 -0800 | [diff] [blame] | 29 | }; |
| 30 | |
Kalyani Akula | 6ebe483 | 2020-11-22 22:42:10 -0800 | [diff] [blame] | 31 | enum pm_register_access_id { |
| 32 | CONFIG_REG_WRITE, |
| 33 | CONFIG_REG_READ, |
| 34 | }; |
| 35 | |
Rajan Vaja | 0c0615a | 2021-10-12 03:30:09 -0700 | [diff] [blame] | 36 | /** |
| 37 | * Assigning of argument values into array elements. |
| 38 | */ |
| 39 | #define PM_PACK_PAYLOAD1(pl, arg0) { \ |
| 40 | pl[0] = (uint32_t)(arg0); \ |
| 41 | } |
| 42 | |
| 43 | #define PM_PACK_PAYLOAD2(pl, arg0, arg1) { \ |
| 44 | pl[1] = (uint32_t)(arg1); \ |
| 45 | PM_PACK_PAYLOAD1(pl, arg0); \ |
| 46 | } |
| 47 | |
| 48 | #define PM_PACK_PAYLOAD3(pl, arg0, arg1, arg2) { \ |
| 49 | pl[2] = (uint32_t)(arg2); \ |
| 50 | PM_PACK_PAYLOAD2(pl, arg0, arg1); \ |
| 51 | } |
| 52 | |
| 53 | #define PM_PACK_PAYLOAD4(pl, arg0, arg1, arg2, arg3) { \ |
| 54 | pl[3] = (uint32_t)(arg3); \ |
| 55 | PM_PACK_PAYLOAD3(pl, arg0, arg1, arg2); \ |
| 56 | } |
| 57 | |
| 58 | #define PM_PACK_PAYLOAD5(pl, arg0, arg1, arg2, arg3, arg4) { \ |
| 59 | pl[4] = (uint32_t)(arg4); \ |
| 60 | PM_PACK_PAYLOAD4(pl, arg0, arg1, arg2, arg3); \ |
| 61 | } |
| 62 | |
| 63 | #define PM_PACK_PAYLOAD6(pl, arg0, arg1, arg2, arg3, arg4, arg5) { \ |
| 64 | pl[5] = (uint32_t)(arg5); \ |
| 65 | PM_PACK_PAYLOAD5(pl, arg0, arg1, arg2, arg3, arg4); \ |
| 66 | } |
| 67 | |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 68 | /********************************************************** |
| 69 | * System-level API function declarations |
| 70 | **********************************************************/ |
| 71 | enum pm_ret_status pm_req_suspend(enum pm_node_id nid, |
| 72 | enum pm_request_ack ack, |
| 73 | unsigned int latency, |
| 74 | unsigned int state); |
| 75 | |
| 76 | enum pm_ret_status pm_self_suspend(enum pm_node_id nid, |
| 77 | unsigned int latency, |
| 78 | unsigned int state, |
| 79 | uintptr_t address); |
| 80 | |
| 81 | enum pm_ret_status pm_force_powerdown(enum pm_node_id nid, |
| 82 | enum pm_request_ack ack); |
| 83 | |
| 84 | enum pm_ret_status pm_abort_suspend(enum pm_abort_reason reason); |
| 85 | |
| 86 | enum pm_ret_status pm_req_wakeup(enum pm_node_id nid, |
| 87 | unsigned int set_address, |
| 88 | uintptr_t address, |
| 89 | enum pm_request_ack ack); |
| 90 | |
| 91 | enum pm_ret_status pm_set_wakeup_source(enum pm_node_id target, |
| 92 | enum pm_node_id wkup_node, |
| 93 | unsigned int enable); |
| 94 | |
Soren Brinkmann | 58fbb9b | 2016-09-02 09:50:54 -0700 | [diff] [blame] | 95 | enum pm_ret_status pm_system_shutdown(unsigned int type, unsigned int subtype); |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 96 | |
| 97 | enum pm_ret_status pm_init_suspend_cb(enum pm_suspend_reason reason, |
| 98 | unsigned int latency, |
| 99 | unsigned int state, |
| 100 | unsigned int timeout); |
| 101 | |
| 102 | /* API functions for managing PM Slaves */ |
| 103 | enum pm_ret_status pm_req_node(enum pm_node_id nid, |
| 104 | unsigned int capabilities, |
| 105 | unsigned int qos, |
| 106 | enum pm_request_ack ack); |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 107 | |
| 108 | enum pm_ret_status pm_set_requirement(enum pm_node_id nid, |
| 109 | unsigned int capabilities, |
| 110 | unsigned int qos, |
| 111 | enum pm_request_ack ack); |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 112 | |
| 113 | /* Miscellaneous API functions */ |
| 114 | enum pm_ret_status pm_get_api_version(unsigned int *version); |
Anes Hadziahmetagic | 1caf88e | 2017-01-27 18:42:44 +0100 | [diff] [blame] | 115 | enum pm_ret_status pm_get_node_status(enum pm_node_id node, |
| 116 | uint32_t *ret_buff); |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 117 | enum pm_ret_status pm_acknowledge_cb(enum pm_node_id nid, |
| 118 | enum pm_ret_status status, |
| 119 | unsigned int oppoint); |
| 120 | enum pm_ret_status pm_notify_cb(enum pm_node_id nid, |
| 121 | unsigned int event, |
| 122 | unsigned int oppoint); |
| 123 | |
| 124 | /* Direct-Control API functions */ |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 125 | enum pm_ret_status pm_mmio_write(uintptr_t address, |
| 126 | unsigned int mask, |
| 127 | unsigned int value); |
| 128 | enum pm_ret_status pm_mmio_read(uintptr_t address, unsigned int *value); |
Soren Brinkmann | 881788d | 2017-09-18 09:13:17 -0700 | [diff] [blame] | 129 | enum pm_ret_status pm_fpga_load(uint32_t address_low, |
| 130 | uint32_t address_high, |
Nava kishore Manne | 68d460c | 2016-08-20 23:18:09 +0530 | [diff] [blame] | 131 | uint32_t size, |
| 132 | uint32_t flags); |
| 133 | enum pm_ret_status pm_fpga_get_status(unsigned int *value); |
| 134 | |
Soren Brinkmann | cb36681 | 2016-09-22 12:21:11 -0700 | [diff] [blame] | 135 | enum pm_ret_status pm_get_chipid(uint32_t *value); |
Siva Durga Prasad Paladugu | de93d98 | 2018-04-30 15:49:27 +0530 | [diff] [blame] | 136 | enum pm_ret_status pm_secure_rsaaes(uint32_t address_high, |
| 137 | uint32_t address_low, |
| 138 | uint32_t size, |
| 139 | uint32_t flags); |
Siva Durga Prasad Paladugu | 1f80d3f | 2018-04-30 15:56:10 +0530 | [diff] [blame] | 140 | unsigned int pm_get_shutdown_scope(void); |
Rajan Vaja | 02d1842 | 2019-03-04 11:09:39 +0530 | [diff] [blame] | 141 | void pm_get_callbackdata(uint32_t *data, size_t count); |
Rajan Vaja | 5529a01 | 2018-01-17 02:39:23 -0800 | [diff] [blame] | 142 | enum pm_ret_status pm_ioctl(enum pm_node_id nid, |
| 143 | unsigned int ioctl_id, |
| 144 | unsigned int arg1, |
| 145 | unsigned int arg2, |
| 146 | unsigned int *value); |
Rajan Vaja | 3511613 | 2018-01-17 02:39:25 -0800 | [diff] [blame] | 147 | enum pm_ret_status pm_clock_enable(unsigned int clock_id); |
| 148 | enum pm_ret_status pm_clock_disable(unsigned int clock_id); |
| 149 | enum pm_ret_status pm_clock_getstate(unsigned int clock_id, |
| 150 | unsigned int *state); |
| 151 | enum pm_ret_status pm_clock_setdivider(unsigned int clock_id, |
| 152 | unsigned int divider); |
| 153 | enum pm_ret_status pm_clock_getdivider(unsigned int clock_id, |
| 154 | unsigned int *divider); |
| 155 | enum pm_ret_status pm_clock_setrate(unsigned int clock_id, |
| 156 | uint64_t rate); |
| 157 | enum pm_ret_status pm_clock_getrate(unsigned int clock_id, |
| 158 | uint64_t *rate); |
| 159 | enum pm_ret_status pm_clock_setparent(unsigned int clock_id, |
| 160 | unsigned int parent_id); |
| 161 | enum pm_ret_status pm_clock_getparent(unsigned int clock_id, |
| 162 | unsigned int *parent_id); |
Rajan Vaja | cd82568 | 2020-11-23 21:33:39 -0800 | [diff] [blame] | 163 | void pm_query_data(enum pm_query_id qid, unsigned int arg1, unsigned int arg2, |
| 164 | unsigned int arg3, unsigned int *data); |
Siva Durga Prasad Paladugu | f3994cc | 2018-05-01 11:12:55 +0530 | [diff] [blame] | 165 | enum pm_ret_status pm_sha_hash(uint32_t address_high, |
| 166 | uint32_t address_low, |
| 167 | uint32_t size, |
| 168 | uint32_t flags); |
| 169 | enum pm_ret_status pm_rsa_core(uint32_t address_high, |
| 170 | uint32_t address_low, |
| 171 | uint32_t size, |
| 172 | uint32_t flags); |
Siva Durga Prasad Paladugu | a4ed4b2 | 2018-04-30 20:06:58 +0530 | [diff] [blame] | 173 | enum pm_ret_status pm_secure_image(uint32_t address_low, |
| 174 | uint32_t address_high, |
| 175 | uint32_t key_lo, |
| 176 | uint32_t key_hi, |
| 177 | uint32_t *value); |
Siva Durga Prasad Paladugu | 7c6516a | 2018-09-04 17:41:34 +0530 | [diff] [blame] | 178 | enum pm_ret_status pm_fpga_read(uint32_t reg_numframes, |
| 179 | uint32_t address_low, |
| 180 | uint32_t address_high, |
| 181 | uint32_t readback_type, |
| 182 | uint32_t *value); |
Siva Durga Prasad Paladugu | 8bd905b | 2018-09-04 18:05:50 +0530 | [diff] [blame] | 183 | enum pm_ret_status pm_aes_engine(uint32_t address_high, |
| 184 | uint32_t address_low, |
| 185 | uint32_t *value); |
Kalyani Akula | 6ebe483 | 2020-11-22 22:42:10 -0800 | [diff] [blame] | 186 | enum pm_ret_status pm_register_access(unsigned int register_access_id, |
| 187 | unsigned int address, |
| 188 | unsigned int mask, |
| 189 | unsigned int value, |
| 190 | unsigned int *out); |
Jolly Shah | a7cc5ee | 2019-01-02 12:27:00 -0800 | [diff] [blame] | 191 | enum pm_ret_status pm_pll_set_parameter(enum pm_node_id nid, |
Michal Simek | 08341b7 | 2022-03-09 08:53:20 +0100 | [diff] [blame] | 192 | enum pm_pll_param param_id, |
| 193 | unsigned int value); |
Jolly Shah | cb2f45d | 2019-01-04 11:28:38 -0800 | [diff] [blame] | 194 | enum pm_ret_status pm_pll_get_parameter(enum pm_node_id nid, |
Michal Simek | 08341b7 | 2022-03-09 08:53:20 +0100 | [diff] [blame] | 195 | enum pm_pll_param param_id, |
| 196 | unsigned int *value); |
Jolly Shah | 1f0d585 | 2019-01-04 11:32:31 -0800 | [diff] [blame] | 197 | enum pm_ret_status pm_pll_set_mode(enum pm_node_id nid, enum pm_pll_mode mode); |
Jolly Shah | 141421e | 2019-01-04 11:35:48 -0800 | [diff] [blame] | 198 | enum pm_ret_status pm_pll_get_mode(enum pm_node_id nid, enum pm_pll_mode *mode); |
VNSL Durga | deb1a36 | 2020-11-23 04:46:04 -0800 | [diff] [blame] | 199 | enum pm_ret_status pm_efuse_access(uint32_t address_high, |
| 200 | uint32_t address_low, uint32_t *value); |
Venkatesh Yadav Abbarapu | 7ace4af | 2020-11-23 04:26:54 -0800 | [diff] [blame] | 201 | enum pm_ret_status em_set_action(unsigned int *value); |
| 202 | enum pm_ret_status em_remove_action(unsigned int *value); |
| 203 | enum pm_ret_status em_send_errors(unsigned int *value); |
Ronak Jain | 42d6f39 | 2021-08-11 00:26:28 -0700 | [diff] [blame] | 204 | enum pm_ret_status pm_feature_config(unsigned int ioctl_id, |
| 205 | unsigned int config_id, |
| 206 | unsigned int value, |
| 207 | unsigned int *response); |
Ronak Jain | 325bad1 | 2021-12-21 01:39:59 -0800 | [diff] [blame] | 208 | enum pm_ret_status pm_feature_check(uint32_t api_id, uint32_t *version, |
| 209 | uint32_t *bit_mask, uint8_t len); |
| 210 | enum pm_ret_status check_api_dependency(uint8_t id); |
Ronak Jain | 42d6f39 | 2021-08-11 00:26:28 -0700 | [diff] [blame] | 211 | |
Antonio Nino Diaz | 5eb8837 | 2018-11-08 10:20:19 +0000 | [diff] [blame] | 212 | #endif /* PM_API_SYS_H */ |