1 /* 2 * Copyright (c) 2019-2022, Xilinx, Inc. All rights reserved. 3 * Copyright (c) 2022-2025, Advanced Micro Devices, Inc. All rights reserved. 4 * 5 * SPDX-License-Identifier: BSD-3-Clause 6 */ 7 8 /* Versal power management enums and defines */ 9 10 #ifndef PM_DEFS_H 11 #define PM_DEFS_H 12 13 #include "pm_node.h" 14 15 /********************************************************************* 16 * Macro definitions 17 ********************************************************************/ 18 19 /* State arguments of the self suspend */ 20 #define PM_STATE_CPU_IDLE 0x0U 21 #define PM_STATE_CPU_OFF 0x1U 22 #define PM_STATE_SUSPEND_TO_RAM 0xFU 23 24 #define MAX_LATENCY (~0U) 25 26 /* Processor core device IDs */ 27 #define APU_DEVID(IDX) NODEID(XPM_NODECLASS_DEVICE, XPM_NODESUBCL_DEV_CORE, \ 28 XPM_NODETYPE_DEV_CORE_APU, (IDX)) 29 30 #define XPM_DEVID_ACPU_0 APU_DEVID(XPM_NODEIDX_DEV_ACPU_0) 31 #define XPM_DEVID_ACPU_1 APU_DEVID(XPM_NODEIDX_DEV_ACPU_1) 32 33 #define PERIPH_DEVID(IDX) NODEID((uint32_t)XPM_NODECLASS_DEVICE, \ 34 (uint32_t)XPM_NODESUBCL_DEV_PERIPH, \ 35 (uint32_t)XPM_NODETYPE_DEV_PERIPH, (IDX)) 36 37 #define TF_A_FEATURE_CHECK 0xa00U 38 #define PM_GET_CALLBACK_DATA 0xa01U 39 #define PM_GET_TRUSTZONE_VERSION 0xa03U 40 #define TF_A_PM_REGISTER_SGI 0xa04U 41 42 /* PM API Versions */ 43 #define PM_API_BASE_VERSION 1U 44 #define PM_API_VERSION_2 2U 45 46 /* Loader API ids */ 47 #define PM_LOAD_PDI 0x701U 48 #define PM_LOAD_GET_HANDOFF_PARAMS 0x70BU 49 50 /* Boot mode id */ 51 #define CRP_BOOT_MODE_REG_NODE 0x30000001U 52 #define CRP_BOOT_MODE_REG_OFFSET 0x200U 53 54 /* System shutdown macros */ 55 #define XPM_SHUTDOWN_TYPE_SHUTDOWN 0U 56 #define XPM_SHUTDOWN_TYPE_RESET 1U 57 #define XPM_SHUTDOWN_TYPE_SETSCOPE_ONLY 2U 58 59 #define XPM_SHUTDOWN_SUBTYPE_RST_SUBSYSTEM 0U 60 #define XPM_SHUTDOWN_SUBTYPE_RST_PS_ONLY 1U 61 #define XPM_SHUTDOWN_SUBTYPE_RST_SYSTEM 2U 62 63 /********************************************************************* 64 * Enum definitions 65 ********************************************************************/ 66 67 /* 68 * ioctl id 69 */ 70 enum { 71 IOCTL_GET_RPU_OPER_MODE = 0, 72 IOCTL_SET_RPU_OPER_MODE = 1, 73 IOCTL_RPU_BOOT_ADDR_CONFIG = 2, 74 IOCTL_TCM_COMB_CONFIG = 3, 75 IOCTL_SET_TAPDELAY_BYPASS = 4, 76 IOCTL_SD_DLL_RESET = 6, 77 IOCTL_SET_SD_TAPDELAY = 7, 78 /* Ioctl for clock driver */ 79 IOCTL_SET_PLL_FRAC_MODE = 8, 80 IOCTL_GET_PLL_FRAC_MODE = 9, 81 IOCTL_SET_PLL_FRAC_DATA = 10, 82 IOCTL_GET_PLL_FRAC_DATA = 11, 83 IOCTL_WRITE_GGS = 12, 84 IOCTL_READ_GGS = 13, 85 IOCTL_WRITE_PGGS = 14, 86 IOCTL_READ_PGGS = 15, 87 /* IOCTL for ULPI reset */ 88 IOCTL_ULPI_RESET = 16, 89 /* Set healthy bit value */ 90 IOCTL_SET_BOOT_HEALTH_STATUS = 17, 91 IOCTL_AFI = 18, 92 /* Probe counter read/write */ 93 IOCTL_PROBE_COUNTER_READ = 19, 94 IOCTL_PROBE_COUNTER_WRITE = 20, 95 IOCTL_OSPI_MUX_SELECT = 21, 96 /* IOCTL for USB power request */ 97 IOCTL_USB_SET_STATE = 22, 98 /* IOCTL to get last reset reason */ 99 IOCTL_GET_LAST_RESET_REASON = 23, 100 /* AI engine NPI ISR clear */ 101 IOCTL_AIE_ISR_CLEAR = 24, 102 IOCTL_READ_REG = 28U, 103 IOCTL_UFS_TXRX_CFGRDY_GET = 40, 104 IOCTL_UFS_SRAM_CSR_SEL = 41, 105 }; 106 107 /** 108 * enum pm_pll_param - enum represents the parameters for a phase-locked loop. 109 * @PM_PLL_PARAM_DIV2: Enable for divide by 2 function inside the PLL. 110 * @PM_PLL_PARAM_FBDIV: Feedback divisor integer portion for the PLL. 111 * @PM_PLL_PARAM_DATA: Feedback divisor fractional portion for the PLL. 112 * @PM_PLL_PARAM_PRE_SRC: Clock source for PLL input. 113 * @PM_PLL_PARAM_POST_SRC: Clock source for PLL Bypass mode. 114 * @PM_PLL_PARAM_LOCK_DLY: Lock circuit config settings for lock windowsize. 115 * @PM_PLL_PARAM_LOCK_CNT: Lock circuit counter setting. 116 * @PM_PLL_PARAM_LFHF: PLL loop filter high frequency capacitor control. 117 * @PM_PLL_PARAM_CP: PLL charge pump control. 118 * @PM_PLL_PARAM_RES: PLL loop filter resistor control. 119 * @PM_PLL_PARAM_MAX: Represents the maximum parameter value for the PLL 120 */ 121 enum pm_pll_param { 122 PM_PLL_PARAM_DIV2, 123 PM_PLL_PARAM_FBDIV, 124 PM_PLL_PARAM_DATA, 125 PM_PLL_PARAM_PRE_SRC, 126 PM_PLL_PARAM_POST_SRC, 127 PM_PLL_PARAM_LOCK_DLY, 128 PM_PLL_PARAM_LOCK_CNT, 129 PM_PLL_PARAM_LFHF, 130 PM_PLL_PARAM_CP, 131 PM_PLL_PARAM_RES, 132 PM_PLL_PARAM_MAX, 133 }; 134 135 enum pm_api_id { 136 /* Miscellaneous API functions: */ 137 PM_GET_API_VERSION = 1, /* Do not change or move */ 138 PM_SET_CONFIGURATION, 139 PM_GET_NODE_STATUS, 140 PM_GET_OP_CHARACTERISTIC, 141 PM_REGISTER_NOTIFIER, 142 /* API for suspending of PUs: */ 143 PM_REQ_SUSPEND, 144 PM_SELF_SUSPEND, 145 PM_FORCE_POWERDOWN, 146 PM_ABORT_SUSPEND, 147 PM_REQ_WAKEUP, 148 PM_SET_WAKEUP_SOURCE, 149 PM_SYSTEM_SHUTDOWN, 150 /* API for managing PM slaves: */ 151 PM_REQ_NODE, 152 PM_RELEASE_NODE, 153 PM_SET_REQUIREMENT, 154 PM_SET_MAX_LATENCY, 155 /* Direct control API functions: */ 156 PM_RESET_ASSERT, 157 PM_RESET_GET_STATUS, 158 PM_MMIO_WRITE, 159 PM_MMIO_READ, 160 PM_INIT_FINALIZE, 161 PM_FPGA_LOAD, 162 PM_FPGA_GET_STATUS, 163 PM_GET_CHIPID, 164 PM_SECURE_RSA_AES, 165 PM_SECURE_SHA, 166 PM_SECURE_RSA, 167 PM_PINCTRL_REQUEST, 168 PM_PINCTRL_RELEASE, 169 PM_PINCTRL_GET_FUNCTION, 170 PM_PINCTRL_SET_FUNCTION, 171 PM_PINCTRL_CONFIG_PARAM_GET, 172 PM_PINCTRL_CONFIG_PARAM_SET, 173 PM_IOCTL, 174 /* API to query information from firmware */ 175 PM_QUERY_DATA, 176 /* Clock control API functions */ 177 PM_CLOCK_ENABLE, 178 PM_CLOCK_DISABLE, 179 PM_CLOCK_GETSTATE, 180 PM_CLOCK_SETDIVIDER, 181 PM_CLOCK_GETDIVIDER, 182 PM_CLOCK_SETPARENT = 43, 183 PM_CLOCK_GETPARENT, 184 PM_SECURE_IMAGE, 185 /* FPGA PL Readback */ 186 PM_FPGA_READ, 187 PM_SECURE_AES, 188 /* PLL control API functions */ 189 PM_PLL_SET_PARAMETER, 190 PM_PLL_GET_PARAMETER, 191 PM_PLL_SET_MODE, 192 PM_PLL_GET_MODE, 193 /* PM Register Access API */ 194 PM_REGISTER_ACCESS, 195 PM_EFUSE_ACCESS, 196 PM_FPGA_GET_VERSION, 197 PM_FPGA_GET_FEATURE_LIST, 198 PM_FEATURE_CHECK = 63, 199 PM_API_MAX = 74 200 }; 201 202 enum pm_abort_reason { 203 ABORT_REASON_WKUP_EVENT = 100, 204 ABORT_REASON_PU_BUSY, 205 ABORT_REASON_NO_PWRDN, 206 ABORT_REASON_UNKNOWN, 207 }; 208 209 /* TODO: move pm_ret_status from device specific location to common location */ 210 /** 211 * enum pm_ret_status - enum represents the return status codes for a PM 212 * operation. 213 * @PM_RET_SUCCESS: success. 214 * @PM_RET_ERROR_ARGS: illegal arguments provided (deprecated). 215 * @PM_RET_ERROR_NOTSUPPORTED: feature not supported (deprecated). 216 * @PM_RET_ERROR_IOCTL_NOT_SUPPORTED: IOCTL is not supported. 217 * @PM_RET_ERROR_INVALID_CRC: invalid crc in IPI communication. 218 * @PM_RET_ERROR_NOT_ENABLED: feature is not enabled. 219 * @PM_RET_ERROR_INTERNAL: internal error. 220 * @PM_RET_ERROR_CONFLICT: conflict. 221 * @PM_RET_ERROR_ACCESS: access rights violation. 222 * @PM_RET_ERROR_INVALID_NODE: invalid node. 223 * @PM_RET_ERROR_DOUBLE_REQ: duplicate request for same node. 224 * @PM_RET_ERROR_ABORT_SUSPEND: suspend procedure has been aborted. 225 * @PM_RET_ERROR_TIMEOUT: timeout in communication with PMU. 226 * @PM_RET_ERROR_NODE_USED: node is already in use. 227 * @PM_RET_ERROR_NO_FEATURE: indicates that the requested feature is not 228 * supported. 229 */ 230 enum pm_ret_status { 231 PM_RET_SUCCESS = 0U, 232 PM_RET_ERROR_ARGS = 1U, 233 PM_RET_ERROR_NOTSUPPORTED = 4U, 234 PM_RET_ERROR_IOCTL_NOT_SUPPORTED = 19U, 235 PM_RET_ERROR_NOT_ENABLED = 29U, 236 PM_RET_ERROR_INVALID_CRC = 301U, 237 PM_RET_ERROR_INTERNAL = 2000U, 238 PM_RET_ERROR_CONFLICT = 2001U, 239 PM_RET_ERROR_ACCESS = 2002U, 240 PM_RET_ERROR_INVALID_NODE = 2003U, 241 PM_RET_ERROR_DOUBLE_REQ = 2004U, 242 PM_RET_ERROR_ABORT_SUSPEND = 2005U, 243 PM_RET_ERROR_TIMEOUT = 2006U, 244 PM_RET_ERROR_NODE_USED = 2007U, 245 PM_RET_ERROR_NO_FEATURE = 2008U 246 }; 247 248 /* 249 * Qids 250 */ 251 enum pm_query_id { 252 XPM_QID_INVALID, 253 XPM_QID_CLOCK_GET_NAME, 254 XPM_QID_CLOCK_GET_TOPOLOGY, 255 XPM_QID_CLOCK_GET_FIXEDFACTOR_PARAMS, 256 XPM_QID_CLOCK_GET_MUXSOURCES, 257 XPM_QID_CLOCK_GET_ATTRIBUTES, 258 XPM_QID_PINCTRL_GET_NUM_PINS, 259 XPM_QID_PINCTRL_GET_NUM_FUNCTIONS, 260 XPM_QID_PINCTRL_GET_NUM_FUNCTION_GROUPS, 261 XPM_QID_PINCTRL_GET_FUNCTION_NAME, 262 XPM_QID_PINCTRL_GET_FUNCTION_GROUPS, 263 XPM_QID_PINCTRL_GET_PIN_GROUPS, 264 XPM_QID_CLOCK_GET_NUM_CLOCKS, 265 XPM_QID_CLOCK_GET_MAX_DIVISOR, 266 XPM_QID_PLD_GET_PARENT, 267 }; 268 269 enum pm_boot_mode_ids { 270 BOOT_MODE_INVALID = 0x000000FFU, 271 BOOT_MODES_MASK = 0x0000000FU, 272 QSPI_MODE_24BIT = 0x00000001U, 273 QSPI_MODE_32BIT = 0x00000002U, 274 SD_MODE = 0x00000003U, /* sd 0 */ 275 SD_MODE1 = 0x00000005U, /* sd 1 */ 276 EMMC_MODE = 0x00000006U, 277 USB_MODE = 0x00000007U, 278 OSPI_MODE = 0x00000008U, 279 SELECTMAP_MODE = 0x0000000AU, 280 SD1_LSHFT_MODE = 0x0000000EU, /* SD1 Level shifter */ 281 JTAG_MODE = 0x00000000U, 282 }; 283 #endif /* PM_DEFS_H */ 284