Tejas Patel | 354fe57 | 2018-12-14 00:55:37 -0800 | [diff] [blame] | 1 | /* |
Rajan Vaja | 030620d | 2020-11-23 04:13:54 -0800 | [diff] [blame] | 2 | * Copyright (c) 2019-2020, Xilinx, Inc. All rights reserved. |
Tejas Patel | 354fe57 | 2018-12-14 00:55:37 -0800 | [diff] [blame] | 3 | * |
| 4 | * SPDX-License-Identifier: BSD-3-Clause |
| 5 | */ |
| 6 | |
| 7 | /* Versal power management enums and defines */ |
| 8 | |
| 9 | #ifndef PM_DEFS_H |
| 10 | #define PM_DEFS_H |
| 11 | |
| 12 | #include "pm_node.h" |
| 13 | |
| 14 | /********************************************************************* |
| 15 | * Macro definitions |
| 16 | ********************************************************************/ |
| 17 | |
Tejas Patel | 54d1319 | 2019-02-27 18:44:55 +0530 | [diff] [blame] | 18 | /* State arguments of the self suspend */ |
| 19 | #define PM_STATE_CPU_IDLE 0x0U |
| 20 | #define PM_STATE_SUSPEND_TO_RAM 0xFU |
| 21 | |
| 22 | #define MAX_LATENCY (~0U) |
| 23 | #define MAX_QOS 100U |
| 24 | |
Tejas Patel | 354fe57 | 2018-12-14 00:55:37 -0800 | [diff] [blame] | 25 | /* Processor core device IDs */ |
| 26 | #define APU_DEVID(IDX) NODEID(XPM_NODECLASS_DEVICE, XPM_NODESUBCL_DEV_CORE, \ |
| 27 | XPM_NODETYPE_DEV_CORE_APU, (IDX)) |
| 28 | |
| 29 | #define XPM_DEVID_ACPU_0 APU_DEVID(XPM_NODEIDX_DEV_ACPU_0) |
| 30 | #define XPM_DEVID_ACPU_1 APU_DEVID(XPM_NODEIDX_DEV_ACPU_1) |
| 31 | |
Tejas Patel | fcb7c16 | 2019-02-27 18:44:56 +0530 | [diff] [blame] | 32 | #define PERIPH_DEVID(IDX) NODEID(XPM_NODECLASS_DEVICE, \ |
| 33 | XPM_NODESUBCL_DEV_PERIPH, \ |
| 34 | XPM_NODETYPE_DEV_PERIPH, (IDX)) |
| 35 | |
Ravi Patel | 22b0b49 | 2019-03-06 12:34:46 +0530 | [diff] [blame] | 36 | #define PM_GET_CALLBACK_DATA 0xa01 |
| 37 | #define PM_GET_TRUSTZONE_VERSION 0xa03 |
| 38 | |
| 39 | /* PM API Versions */ |
| 40 | #define PM_API_BASE_VERSION 1U |
| 41 | |
Rajan Vaja | 030620d | 2020-11-23 04:13:54 -0800 | [diff] [blame] | 42 | #define PM_API_QUERY_DATA_VERSION 2U |
| 43 | |
Tejas Patel | 9d09ff9 | 2019-01-08 01:46:35 -0800 | [diff] [blame] | 44 | /* PM API ids */ |
| 45 | #define PM_GET_API_VERSION 1U |
Tejas Patel | 41f3e0b | 2019-01-08 01:46:37 -0800 | [diff] [blame] | 46 | #define PM_GET_DEVICE_STATUS 3U |
Saeed Nowshadi | 2294b42 | 2019-06-03 10:22:35 -0700 | [diff] [blame] | 47 | #define PM_GET_OP_CHARACTERISTIC 4U |
Tejas Patel | fe0e10a | 2019-12-08 23:29:44 -0800 | [diff] [blame] | 48 | #define PM_REQ_SUSPEND 6U |
| 49 | #define PM_SELF_SUSPEND 7U |
Tejas Patel | 6b28225 | 2019-01-10 03:03:47 -0800 | [diff] [blame] | 50 | #define PM_FORCE_POWERDOWN 8U |
Tejas Patel | fe0e10a | 2019-12-08 23:29:44 -0800 | [diff] [blame] | 51 | #define PM_ABORT_SUSPEND 9U |
Tejas Patel | 49cd871 | 2019-01-23 14:18:51 +0530 | [diff] [blame] | 52 | #define PM_REQ_WAKEUP 10U |
Tejas Patel | db81205 | 2019-01-23 14:18:53 +0530 | [diff] [blame] | 53 | #define PM_SET_WAKEUP_SOURCE 11U |
Tejas Patel | 6b28225 | 2019-01-10 03:03:47 -0800 | [diff] [blame] | 54 | #define PM_SYSTEM_SHUTDOWN 12U |
Tejas Patel | 41f3e0b | 2019-01-08 01:46:37 -0800 | [diff] [blame] | 55 | #define PM_REQUEST_DEVICE 13U |
| 56 | #define PM_RELEASE_DEVICE 14U |
| 57 | #define PM_SET_REQUIREMENT 15U |
Tejas Patel | 5c154e1 | 2020-11-25 01:53:12 -0800 | [diff] [blame] | 58 | #define PM_SET_MAX_LATENCY 16U |
Tejas Patel | 87c4f3a | 2019-01-08 01:46:38 -0800 | [diff] [blame] | 59 | #define PM_RESET_ASSERT 17U |
| 60 | #define PM_RESET_GET_STATUS 18U |
Tejas Patel | 0266202 | 2019-01-21 17:56:49 +0530 | [diff] [blame] | 61 | #define PM_INIT_FINALIZE 21U |
Ravi Patel | bd4aa5a | 2019-08-12 03:17:54 -0700 | [diff] [blame] | 62 | #define PM_GET_CHIPID 24U |
Tejas Patel | 20e9202 | 2019-01-08 01:46:39 -0800 | [diff] [blame] | 63 | #define PM_PINCTRL_REQUEST 28U |
| 64 | #define PM_PINCTRL_RELEASE 29U |
| 65 | #define PM_PINCTRL_GET_FUNCTION 30U |
| 66 | #define PM_PINCTRL_SET_FUNCTION 31U |
| 67 | #define PM_PINCTRL_CONFIG_PARAM_GET 32U |
| 68 | #define PM_PINCTRL_CONFIG_PARAM_SET 33U |
Tejas Patel | 9141f44 | 2019-01-10 03:03:48 -0800 | [diff] [blame] | 69 | #define PM_IOCTL 34U |
Tejas Patel | a3e34ad | 2019-02-01 17:25:19 +0530 | [diff] [blame] | 70 | #define PM_QUERY_DATA 35U |
Tejas Patel | 1f56fb1 | 2019-01-08 01:46:40 -0800 | [diff] [blame] | 71 | #define PM_CLOCK_ENABLE 36U |
| 72 | #define PM_CLOCK_DISABLE 37U |
| 73 | #define PM_CLOCK_GETSTATE 38U |
| 74 | #define PM_CLOCK_SETDIVIDER 39U |
| 75 | #define PM_CLOCK_GETDIVIDER 40U |
| 76 | #define PM_CLOCK_SETRATE 41U |
| 77 | #define PM_CLOCK_GETRATE 42U |
| 78 | #define PM_CLOCK_SETPARENT 43U |
| 79 | #define PM_CLOCK_GETPARENT 44U |
Tejas Patel | 023116d | 2019-01-08 01:46:41 -0800 | [diff] [blame] | 80 | #define PM_PLL_SET_PARAMETER 48U |
| 81 | #define PM_PLL_GET_PARAMETER 49U |
| 82 | #define PM_PLL_SET_MODE 50U |
| 83 | #define PM_PLL_GET_MODE 51U |
Ravi Patel | 22b0b49 | 2019-03-06 12:34:46 +0530 | [diff] [blame] | 84 | #define PM_FEATURE_CHECK 63U |
Tejas Patel | 9d09ff9 | 2019-01-08 01:46:35 -0800 | [diff] [blame] | 85 | |
Jolly Shah | ed05a71 | 2019-03-22 05:33:39 +0530 | [diff] [blame] | 86 | /* Loader API ids */ |
| 87 | #define PM_LOAD_PDI 0x701U |
| 88 | |
Tejas Patel | 9141f44 | 2019-01-10 03:03:48 -0800 | [diff] [blame] | 89 | /* IOCTL IDs for clock driver */ |
| 90 | #define IOCTL_SET_PLL_FRAC_MODE 8 |
| 91 | #define IOCTL_GET_PLL_FRAC_MODE 9 |
| 92 | #define IOCTL_SET_PLL_FRAC_DATA 10 |
| 93 | #define IOCTL_GET_PLL_FRAC_DATA 11 |
| 94 | |
| 95 | /* Parameter ID for PLL IOCTLs */ |
| 96 | /* Fractional data portion for PLL */ |
| 97 | #define PM_PLL_PARAM_DATA 2 |
| 98 | |
Saeed Nowshadi | c5a1bda | 2019-12-08 23:35:35 -0800 | [diff] [blame] | 99 | /* System shutdown macros */ |
| 100 | #define XPM_SHUTDOWN_TYPE_SHUTDOWN 0U |
| 101 | #define XPM_SHUTDOWN_TYPE_RESET 1U |
| 102 | #define XPM_SHUTDOWN_TYPE_SETSCOPE_ONLY 2U |
| 103 | |
| 104 | #define XPM_SHUTDOWN_SUBTYPE_RST_SUBSYSTEM 0U |
| 105 | #define XPM_SHUTDOWN_SUBTYPE_RST_PS_ONLY 1U |
| 106 | #define XPM_SHUTDOWN_SUBTYPE_RST_SYSTEM 2U |
| 107 | |
Tejas Patel | 354fe57 | 2018-12-14 00:55:37 -0800 | [diff] [blame] | 108 | /********************************************************************* |
| 109 | * Enum definitions |
| 110 | ********************************************************************/ |
| 111 | |
Tejas Patel | fe0e10a | 2019-12-08 23:29:44 -0800 | [diff] [blame] | 112 | enum pm_abort_reason { |
| 113 | ABORT_REASON_WKUP_EVENT = 100, |
| 114 | ABORT_REASON_PU_BUSY, |
| 115 | ABORT_REASON_NO_PWRDN, |
| 116 | ABORT_REASON_UNKNOWN, |
| 117 | }; |
| 118 | |
Saeed Nowshadi | 2294b42 | 2019-06-03 10:22:35 -0700 | [diff] [blame] | 119 | enum pm_opchar_type { |
| 120 | PM_OPCHAR_TYPE_POWER = 1, |
| 121 | PM_OPCHAR_TYPE_TEMP, |
| 122 | PM_OPCHAR_TYPE_LATENCY, |
| 123 | }; |
| 124 | |
Tejas Patel | 354fe57 | 2018-12-14 00:55:37 -0800 | [diff] [blame] | 125 | /** |
Tejas Patel | 41f3e0b | 2019-01-08 01:46:37 -0800 | [diff] [blame] | 126 | * Subsystem IDs |
| 127 | */ |
| 128 | typedef enum { |
| 129 | XPM_SUBSYSID_PMC, |
| 130 | XPM_SUBSYSID_PSM, |
| 131 | XPM_SUBSYSID_APU, |
| 132 | XPM_SUBSYSID_RPU0_LOCK, |
| 133 | XPM_SUBSYSID_RPU0_0, |
| 134 | XPM_SUBSYSID_RPU0_1, |
| 135 | XPM_SUBSYSID_DDR0, |
| 136 | XPM_SUBSYSID_ME, |
| 137 | XPM_SUBSYSID_PL, |
| 138 | XPM_SUBSYSID_MAX, |
| 139 | } XPm_SubsystemId; |
| 140 | |
| 141 | /** |
Tejas Patel | 354fe57 | 2018-12-14 00:55:37 -0800 | [diff] [blame] | 142 | * @PM_RET_SUCCESS: success |
| 143 | * @PM_RET_ERROR_ARGS: illegal arguments provided (deprecated) |
| 144 | * @PM_RET_ERROR_NOTSUPPORTED: feature not supported (deprecated) |
Ravi Patel | 22b0b49 | 2019-03-06 12:34:46 +0530 | [diff] [blame] | 145 | * @PM_RET_ERROR_NOFEATURE: feature is not available |
Tejas Patel | 354fe57 | 2018-12-14 00:55:37 -0800 | [diff] [blame] | 146 | * @PM_RET_ERROR_INTERNAL: internal error |
| 147 | * @PM_RET_ERROR_CONFLICT: conflict |
| 148 | * @PM_RET_ERROR_ACCESS: access rights violation |
| 149 | * @PM_RET_ERROR_INVALID_NODE: invalid node |
| 150 | * @PM_RET_ERROR_DOUBLE_REQ: duplicate request for same node |
| 151 | * @PM_RET_ERROR_ABORT_SUSPEND: suspend procedure has been aborted |
| 152 | * @PM_RET_ERROR_TIMEOUT: timeout in communication with PMU |
| 153 | * @PM_RET_ERROR_NODE_USED: node is already in use |
| 154 | */ |
| 155 | enum pm_ret_status { |
| 156 | PM_RET_SUCCESS, |
| 157 | PM_RET_ERROR_ARGS = 1, |
| 158 | PM_RET_ERROR_NOTSUPPORTED = 4, |
Ravi Patel | 22b0b49 | 2019-03-06 12:34:46 +0530 | [diff] [blame] | 159 | PM_RET_ERROR_NOFEATURE = 19, |
Tejas Patel | 354fe57 | 2018-12-14 00:55:37 -0800 | [diff] [blame] | 160 | PM_RET_ERROR_INTERNAL = 2000, |
| 161 | PM_RET_ERROR_CONFLICT = 2001, |
| 162 | PM_RET_ERROR_ACCESS = 2002, |
| 163 | PM_RET_ERROR_INVALID_NODE = 2003, |
| 164 | PM_RET_ERROR_DOUBLE_REQ = 2004, |
| 165 | PM_RET_ERROR_ABORT_SUSPEND = 2005, |
| 166 | PM_RET_ERROR_TIMEOUT = 2006, |
| 167 | PM_RET_ERROR_NODE_USED = 2007 |
| 168 | }; |
Rajan Vaja | 030620d | 2020-11-23 04:13:54 -0800 | [diff] [blame] | 169 | |
| 170 | /** |
| 171 | * Qids |
| 172 | */ |
| 173 | enum pm_query_id { |
| 174 | XPM_QID_INVALID, |
| 175 | XPM_QID_CLOCK_GET_NAME, |
| 176 | XPM_QID_CLOCK_GET_TOPOLOGY, |
| 177 | XPM_QID_CLOCK_GET_FIXEDFACTOR_PARAMS, |
| 178 | XPM_QID_CLOCK_GET_MUXSOURCES, |
| 179 | XPM_QID_CLOCK_GET_ATTRIBUTES, |
| 180 | XPM_QID_PINCTRL_GET_NUM_PINS, |
| 181 | XPM_QID_PINCTRL_GET_NUM_FUNCTIONS, |
| 182 | XPM_QID_PINCTRL_GET_NUM_FUNCTION_GROUPS, |
| 183 | XPM_QID_PINCTRL_GET_FUNCTION_NAME, |
| 184 | XPM_QID_PINCTRL_GET_FUNCTION_GROUPS, |
| 185 | XPM_QID_PINCTRL_GET_PIN_GROUPS, |
| 186 | XPM_QID_CLOCK_GET_NUM_CLOCKS, |
| 187 | XPM_QID_CLOCK_GET_MAX_DIVISOR, |
| 188 | XPM_QID_PLD_GET_PARENT, |
| 189 | }; |
Tejas Patel | 354fe57 | 2018-12-14 00:55:37 -0800 | [diff] [blame] | 190 | #endif /* PM_DEFS_H */ |