blob: 378565049fe2d57c0962de6d2da0ad5b63e76ffa [file] [log] [blame]
Tejas Patel354fe572018-12-14 00:55:37 -08001/*
Tanmay Shahff34daa2021-08-09 11:00:41 -07002 * Copyright (c) 2019-2022, Xilinx, Inc. All rights reserved.
Tejas Patel354fe572018-12-14 00:55:37 -08003 *
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 Patel54d13192019-02-27 18:44:55 +053018/* 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 Patel354fe572018-12-14 00:55:37 -080025/* 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 Patelfcb7c162019-02-27 18:44:56 +053032#define PERIPH_DEVID(IDX) NODEID(XPM_NODECLASS_DEVICE, \
33 XPM_NODESUBCL_DEV_PERIPH, \
34 XPM_NODETYPE_DEV_PERIPH, (IDX))
35
Abhyuday Godhasaraedc38ae2021-08-04 23:58:46 -070036#define PM_GET_CALLBACK_DATA 0xa01U
37#define PM_GET_TRUSTZONE_VERSION 0xa03U
Ravi Patel22b0b492019-03-06 12:34:46 +053038
39/* PM API Versions */
40#define PM_API_BASE_VERSION 1U
Ronak Jain70d1c582022-02-04 00:42:55 -080041#define PM_API_VERSION_2 2U
Ravi Patel22b0b492019-03-06 12:34:46 +053042
Rajan Vaja030620d2020-11-23 04:13:54 -080043#define PM_API_QUERY_DATA_VERSION 2U
44
Tejas Patel9d09ff92019-01-08 01:46:35 -080045/* PM API ids */
Tejas Patel42015552020-11-25 01:56:57 -080046#define PM_REGISTER_NOTIFIER 5U
Tejas Patelfe0e10a2019-12-08 23:29:44 -080047#define PM_REQ_SUSPEND 6U
48#define PM_SELF_SUSPEND 7U
Tejas Patel6b282252019-01-10 03:03:47 -080049#define PM_FORCE_POWERDOWN 8U
Tejas Patelfe0e10a2019-12-08 23:29:44 -080050#define PM_ABORT_SUSPEND 9U
Tejas Patel49cd8712019-01-23 14:18:51 +053051#define PM_REQ_WAKEUP 10U
Tejas Pateldb812052019-01-23 14:18:53 +053052#define PM_SET_WAKEUP_SOURCE 11U
Tejas Patel6b282252019-01-10 03:03:47 -080053#define PM_SYSTEM_SHUTDOWN 12U
Tejas Patel9141f442019-01-10 03:03:48 -080054#define PM_IOCTL 34U
Tejas Patela3e34ad2019-02-01 17:25:19 +053055#define PM_QUERY_DATA 35U
Tejas Patel023116d2019-01-08 01:46:41 -080056#define PM_PLL_SET_PARAMETER 48U
57#define PM_PLL_GET_PARAMETER 49U
58#define PM_PLL_SET_MODE 50U
59#define PM_PLL_GET_MODE 51U
Ravi Patel22b0b492019-03-06 12:34:46 +053060#define PM_FEATURE_CHECK 63U
Tejas Patel9d09ff92019-01-08 01:46:35 -080061
Jolly Shahed05a712019-03-22 05:33:39 +053062/* Loader API ids */
63#define PM_LOAD_PDI 0x701U
64
Tejas Patel9141f442019-01-10 03:03:48 -080065/* IOCTL IDs for clock driver */
Abhyuday Godhasaraedc38ae2021-08-04 23:58:46 -070066#define IOCTL_SET_PLL_FRAC_MODE 8U
67#define IOCTL_GET_PLL_FRAC_MODE 9U
68#define IOCTL_SET_PLL_FRAC_DATA 10U
69#define IOCTL_GET_PLL_FRAC_DATA 11U
70#define IOCTL_SET_SGI 25U
Tejas Patel9141f442019-01-10 03:03:48 -080071
72/* Parameter ID for PLL IOCTLs */
73/* Fractional data portion for PLL */
74#define PM_PLL_PARAM_DATA 2
75
Saeed Nowshadic5a1bda2019-12-08 23:35:35 -080076/* System shutdown macros */
77#define XPM_SHUTDOWN_TYPE_SHUTDOWN 0U
78#define XPM_SHUTDOWN_TYPE_RESET 1U
79#define XPM_SHUTDOWN_TYPE_SETSCOPE_ONLY 2U
80
81#define XPM_SHUTDOWN_SUBTYPE_RST_SUBSYSTEM 0U
82#define XPM_SHUTDOWN_SUBTYPE_RST_PS_ONLY 1U
83#define XPM_SHUTDOWN_SUBTYPE_RST_SYSTEM 2U
84
Tejas Patel354fe572018-12-14 00:55:37 -080085/*********************************************************************
86 * Enum definitions
87 ********************************************************************/
88
Tejas Patelfe0e10a2019-12-08 23:29:44 -080089enum pm_abort_reason {
90 ABORT_REASON_WKUP_EVENT = 100,
91 ABORT_REASON_PU_BUSY,
92 ABORT_REASON_NO_PWRDN,
93 ABORT_REASON_UNKNOWN,
94};
95
Saeed Nowshadi2294b422019-06-03 10:22:35 -070096enum pm_opchar_type {
97 PM_OPCHAR_TYPE_POWER = 1,
98 PM_OPCHAR_TYPE_TEMP,
99 PM_OPCHAR_TYPE_LATENCY,
100};
101
Tejas Patel354fe572018-12-14 00:55:37 -0800102/**
Tejas Patel41f3e0b2019-01-08 01:46:37 -0800103 * Subsystem IDs
104 */
105typedef enum {
106 XPM_SUBSYSID_PMC,
107 XPM_SUBSYSID_PSM,
108 XPM_SUBSYSID_APU,
109 XPM_SUBSYSID_RPU0_LOCK,
110 XPM_SUBSYSID_RPU0_0,
111 XPM_SUBSYSID_RPU0_1,
112 XPM_SUBSYSID_DDR0,
113 XPM_SUBSYSID_ME,
114 XPM_SUBSYSID_PL,
115 XPM_SUBSYSID_MAX,
116} XPm_SubsystemId;
117
118/**
Tejas Patel354fe572018-12-14 00:55:37 -0800119 * @PM_RET_SUCCESS: success
120 * @PM_RET_ERROR_ARGS: illegal arguments provided (deprecated)
121 * @PM_RET_ERROR_NOTSUPPORTED: feature not supported (deprecated)
Ravi Patel22b0b492019-03-06 12:34:46 +0530122 * @PM_RET_ERROR_NOFEATURE: feature is not available
Tejas Patel354fe572018-12-14 00:55:37 -0800123 * @PM_RET_ERROR_INTERNAL: internal error
124 * @PM_RET_ERROR_CONFLICT: conflict
125 * @PM_RET_ERROR_ACCESS: access rights violation
126 * @PM_RET_ERROR_INVALID_NODE: invalid node
127 * @PM_RET_ERROR_DOUBLE_REQ: duplicate request for same node
128 * @PM_RET_ERROR_ABORT_SUSPEND: suspend procedure has been aborted
129 * @PM_RET_ERROR_TIMEOUT: timeout in communication with PMU
130 * @PM_RET_ERROR_NODE_USED: node is already in use
131 */
132enum pm_ret_status {
133 PM_RET_SUCCESS,
134 PM_RET_ERROR_ARGS = 1,
135 PM_RET_ERROR_NOTSUPPORTED = 4,
Ravi Patel22b0b492019-03-06 12:34:46 +0530136 PM_RET_ERROR_NOFEATURE = 19,
Tejas Patel354fe572018-12-14 00:55:37 -0800137 PM_RET_ERROR_INTERNAL = 2000,
138 PM_RET_ERROR_CONFLICT = 2001,
139 PM_RET_ERROR_ACCESS = 2002,
140 PM_RET_ERROR_INVALID_NODE = 2003,
141 PM_RET_ERROR_DOUBLE_REQ = 2004,
142 PM_RET_ERROR_ABORT_SUSPEND = 2005,
143 PM_RET_ERROR_TIMEOUT = 2006,
144 PM_RET_ERROR_NODE_USED = 2007
145};
Rajan Vaja030620d2020-11-23 04:13:54 -0800146
147/**
148 * Qids
149 */
150enum pm_query_id {
151 XPM_QID_INVALID,
152 XPM_QID_CLOCK_GET_NAME,
153 XPM_QID_CLOCK_GET_TOPOLOGY,
154 XPM_QID_CLOCK_GET_FIXEDFACTOR_PARAMS,
155 XPM_QID_CLOCK_GET_MUXSOURCES,
156 XPM_QID_CLOCK_GET_ATTRIBUTES,
157 XPM_QID_PINCTRL_GET_NUM_PINS,
158 XPM_QID_PINCTRL_GET_NUM_FUNCTIONS,
159 XPM_QID_PINCTRL_GET_NUM_FUNCTION_GROUPS,
160 XPM_QID_PINCTRL_GET_FUNCTION_NAME,
161 XPM_QID_PINCTRL_GET_FUNCTION_GROUPS,
162 XPM_QID_PINCTRL_GET_PIN_GROUPS,
163 XPM_QID_CLOCK_GET_NUM_CLOCKS,
164 XPM_QID_CLOCK_GET_MAX_DIVISOR,
165 XPM_QID_PLD_GET_PARENT,
166};
Tejas Patel354fe572018-12-14 00:55:37 -0800167#endif /* PM_DEFS_H */