Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 1 | /* |
Rajan Vaja | 02d1842 | 2019-03-04 11:09:39 +0530 | [diff] [blame] | 2 | * Copyright (c) 2013-2020, 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 | |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 36 | /********************************************************** |
| 37 | * System-level API function declarations |
| 38 | **********************************************************/ |
| 39 | enum pm_ret_status pm_req_suspend(enum pm_node_id nid, |
| 40 | enum pm_request_ack ack, |
| 41 | unsigned int latency, |
| 42 | unsigned int state); |
| 43 | |
| 44 | enum pm_ret_status pm_self_suspend(enum pm_node_id nid, |
| 45 | unsigned int latency, |
| 46 | unsigned int state, |
| 47 | uintptr_t address); |
| 48 | |
| 49 | enum pm_ret_status pm_force_powerdown(enum pm_node_id nid, |
| 50 | enum pm_request_ack ack); |
| 51 | |
| 52 | enum pm_ret_status pm_abort_suspend(enum pm_abort_reason reason); |
| 53 | |
| 54 | enum pm_ret_status pm_req_wakeup(enum pm_node_id nid, |
| 55 | unsigned int set_address, |
| 56 | uintptr_t address, |
| 57 | enum pm_request_ack ack); |
| 58 | |
| 59 | enum pm_ret_status pm_set_wakeup_source(enum pm_node_id target, |
| 60 | enum pm_node_id wkup_node, |
| 61 | unsigned int enable); |
| 62 | |
Soren Brinkmann | 58fbb9b | 2016-09-02 09:50:54 -0700 | [diff] [blame] | 63 | 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] | 64 | |
| 65 | enum pm_ret_status pm_init_suspend_cb(enum pm_suspend_reason reason, |
| 66 | unsigned int latency, |
| 67 | unsigned int state, |
| 68 | unsigned int timeout); |
| 69 | |
| 70 | /* API functions for managing PM Slaves */ |
| 71 | enum pm_ret_status pm_req_node(enum pm_node_id nid, |
| 72 | unsigned int capabilities, |
| 73 | unsigned int qos, |
| 74 | enum pm_request_ack ack); |
| 75 | enum pm_ret_status pm_release_node(enum pm_node_id nid); |
| 76 | |
| 77 | enum pm_ret_status pm_set_requirement(enum pm_node_id nid, |
| 78 | unsigned int capabilities, |
| 79 | unsigned int qos, |
| 80 | enum pm_request_ack ack); |
| 81 | enum pm_ret_status pm_set_max_latency(enum pm_node_id nid, |
| 82 | unsigned int latency); |
| 83 | |
| 84 | /* Miscellaneous API functions */ |
| 85 | enum pm_ret_status pm_get_api_version(unsigned int *version); |
| 86 | enum pm_ret_status pm_set_configuration(unsigned int phys_addr); |
Filip Drazic | f2ddd91 | 2017-03-15 11:50:47 +0100 | [diff] [blame] | 87 | enum pm_ret_status pm_init_finalize(void); |
Anes Hadziahmetagic | 1caf88e | 2017-01-27 18:42:44 +0100 | [diff] [blame] | 88 | enum pm_ret_status pm_get_node_status(enum pm_node_id node, |
| 89 | uint32_t *ret_buff); |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 90 | enum pm_ret_status pm_register_notifier(enum pm_node_id nid, |
| 91 | unsigned int event, |
| 92 | unsigned int wake, |
| 93 | unsigned int enable); |
| 94 | enum pm_ret_status pm_get_op_characteristic(enum pm_node_id nid, |
Anes Hadziahmetagic | 92aee01 | 2016-05-12 16:17:30 +0200 | [diff] [blame] | 95 | enum pm_opchar_type type, |
| 96 | uint32_t *result); |
Soren Brinkmann | 76fcae3 | 2016-03-06 20:16:27 -0800 | [diff] [blame] | 97 | enum pm_ret_status pm_acknowledge_cb(enum pm_node_id nid, |
| 98 | enum pm_ret_status status, |
| 99 | unsigned int oppoint); |
| 100 | enum pm_ret_status pm_notify_cb(enum pm_node_id nid, |
| 101 | unsigned int event, |
| 102 | unsigned int oppoint); |
| 103 | |
| 104 | /* Direct-Control API functions */ |
| 105 | enum pm_ret_status pm_reset_assert(unsigned int reset_id, |
| 106 | unsigned int assert); |
| 107 | enum pm_ret_status pm_reset_get_status(unsigned int reset_id, |
| 108 | unsigned int *reset_status); |
| 109 | enum pm_ret_status pm_mmio_write(uintptr_t address, |
| 110 | unsigned int mask, |
| 111 | unsigned int value); |
| 112 | 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] | 113 | enum pm_ret_status pm_fpga_load(uint32_t address_low, |
| 114 | uint32_t address_high, |
Nava kishore Manne | 68d460c | 2016-08-20 23:18:09 +0530 | [diff] [blame] | 115 | uint32_t size, |
| 116 | uint32_t flags); |
| 117 | enum pm_ret_status pm_fpga_get_status(unsigned int *value); |
| 118 | |
Soren Brinkmann | cb36681 | 2016-09-22 12:21:11 -0700 | [diff] [blame] | 119 | enum pm_ret_status pm_get_chipid(uint32_t *value); |
Siva Durga Prasad Paladugu | de93d98 | 2018-04-30 15:49:27 +0530 | [diff] [blame] | 120 | enum pm_ret_status pm_secure_rsaaes(uint32_t address_high, |
| 121 | uint32_t address_low, |
| 122 | uint32_t size, |
| 123 | uint32_t flags); |
Siva Durga Prasad Paladugu | 1f80d3f | 2018-04-30 15:56:10 +0530 | [diff] [blame] | 124 | unsigned int pm_get_shutdown_scope(void); |
Rajan Vaja | 02d1842 | 2019-03-04 11:09:39 +0530 | [diff] [blame] | 125 | void pm_get_callbackdata(uint32_t *data, size_t count); |
Rajan Vaja | 8368761 | 2018-01-17 02:39:20 -0800 | [diff] [blame] | 126 | enum pm_ret_status pm_pinctrl_request(unsigned int pin); |
| 127 | enum pm_ret_status pm_pinctrl_release(unsigned int pin); |
| 128 | enum pm_ret_status pm_pinctrl_get_function(unsigned int pin, |
Jolly Shah | 69fb5bf | 2018-02-07 16:25:41 -0800 | [diff] [blame] | 129 | enum pm_node_id *nid); |
Rajan Vaja | 8368761 | 2018-01-17 02:39:20 -0800 | [diff] [blame] | 130 | enum pm_ret_status pm_pinctrl_set_function(unsigned int pin, |
Jolly Shah | 69fb5bf | 2018-02-07 16:25:41 -0800 | [diff] [blame] | 131 | enum pm_node_id nid); |
Rajan Vaja | 8368761 | 2018-01-17 02:39:20 -0800 | [diff] [blame] | 132 | enum pm_ret_status pm_pinctrl_get_config(unsigned int pin, |
| 133 | unsigned int param, |
| 134 | unsigned int *value); |
| 135 | enum pm_ret_status pm_pinctrl_set_config(unsigned int pin, |
| 136 | unsigned int param, |
| 137 | unsigned int value); |
Rajan Vaja | 5529a01 | 2018-01-17 02:39:23 -0800 | [diff] [blame] | 138 | enum pm_ret_status pm_ioctl(enum pm_node_id nid, |
| 139 | unsigned int ioctl_id, |
| 140 | unsigned int arg1, |
| 141 | unsigned int arg2, |
| 142 | unsigned int *value); |
Rajan Vaja | 3511613 | 2018-01-17 02:39:25 -0800 | [diff] [blame] | 143 | enum pm_ret_status pm_clock_enable(unsigned int clock_id); |
| 144 | enum pm_ret_status pm_clock_disable(unsigned int clock_id); |
| 145 | enum pm_ret_status pm_clock_getstate(unsigned int clock_id, |
| 146 | unsigned int *state); |
| 147 | enum pm_ret_status pm_clock_setdivider(unsigned int clock_id, |
| 148 | unsigned int divider); |
| 149 | enum pm_ret_status pm_clock_getdivider(unsigned int clock_id, |
| 150 | unsigned int *divider); |
| 151 | enum pm_ret_status pm_clock_setrate(unsigned int clock_id, |
| 152 | uint64_t rate); |
| 153 | enum pm_ret_status pm_clock_getrate(unsigned int clock_id, |
| 154 | uint64_t *rate); |
| 155 | enum pm_ret_status pm_clock_setparent(unsigned int clock_id, |
| 156 | unsigned int parent_id); |
| 157 | enum pm_ret_status pm_clock_getparent(unsigned int clock_id, |
| 158 | unsigned int *parent_id); |
Rajan Vaja | cd82568 | 2020-11-23 21:33:39 -0800 | [diff] [blame] | 159 | void pm_query_data(enum pm_query_id qid, unsigned int arg1, unsigned int arg2, |
| 160 | unsigned int arg3, unsigned int *data); |
Siva Durga Prasad Paladugu | f3994cc | 2018-05-01 11:12:55 +0530 | [diff] [blame] | 161 | enum pm_ret_status pm_sha_hash(uint32_t address_high, |
| 162 | uint32_t address_low, |
| 163 | uint32_t size, |
| 164 | uint32_t flags); |
| 165 | enum pm_ret_status pm_rsa_core(uint32_t address_high, |
| 166 | uint32_t address_low, |
| 167 | uint32_t size, |
| 168 | uint32_t flags); |
Siva Durga Prasad Paladugu | a4ed4b2 | 2018-04-30 20:06:58 +0530 | [diff] [blame] | 169 | enum pm_ret_status pm_secure_image(uint32_t address_low, |
| 170 | uint32_t address_high, |
| 171 | uint32_t key_lo, |
| 172 | uint32_t key_hi, |
| 173 | uint32_t *value); |
Siva Durga Prasad Paladugu | 7c6516a | 2018-09-04 17:41:34 +0530 | [diff] [blame] | 174 | |
| 175 | enum pm_ret_status pm_fpga_read(uint32_t reg_numframes, |
| 176 | uint32_t address_low, |
| 177 | uint32_t address_high, |
| 178 | uint32_t readback_type, |
| 179 | uint32_t *value); |
Siva Durga Prasad Paladugu | 8bd905b | 2018-09-04 18:05:50 +0530 | [diff] [blame] | 180 | enum pm_ret_status pm_aes_engine(uint32_t address_high, |
| 181 | uint32_t address_low, |
| 182 | uint32_t *value); |
Kalyani Akula | 6ebe483 | 2020-11-22 22:42:10 -0800 | [diff] [blame] | 183 | enum pm_ret_status pm_register_access(unsigned int register_access_id, |
| 184 | unsigned int address, |
| 185 | unsigned int mask, |
| 186 | unsigned int value, |
| 187 | unsigned int *out); |
Siva Durga Prasad Paladugu | 7c6516a | 2018-09-04 17:41:34 +0530 | [diff] [blame] | 188 | |
Jolly Shah | a7cc5ee | 2019-01-02 12:27:00 -0800 | [diff] [blame] | 189 | enum pm_ret_status pm_pll_set_parameter(enum pm_node_id nid, |
| 190 | enum pm_pll_param param_id, |
| 191 | unsigned int value); |
| 192 | |
Jolly Shah | cb2f45d | 2019-01-04 11:28:38 -0800 | [diff] [blame] | 193 | enum pm_ret_status pm_pll_get_parameter(enum pm_node_id nid, |
| 194 | enum pm_pll_param param_id, |
| 195 | unsigned int *value); |
| 196 | |
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); |
Jolly Shah | 1f0d585 | 2019-01-04 11:32:31 -0800 | [diff] [blame] | 204 | |
Antonio Nino Diaz | 5eb8837 | 2018-11-08 10:20:19 +0000 | [diff] [blame] | 205 | #endif /* PM_API_SYS_H */ |