TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / TF-A / trusted-firmware-a / cf1e56a4e74752f3ee7e2953ebd2ebb4ed8f9e20 / . / plat / xilinx / versal / pm_service / pm_defs.h
blob: feaeee120794ffa424700f7988fabf29774dac93 [file] [log] [blame]
Tejas Patelc73a90e2018-12-14 00:55:37 -0800[diff] [blame]1/*
2 * Copyright (c) 2019, Xilinx, Inc. All rights reserved.
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
18/* Processor core device IDs */
19#define APU_DEVID(IDX) NODEID(XPM_NODECLASS_DEVICE, XPM_NODESUBCL_DEV_CORE, \
20 XPM_NODETYPE_DEV_CORE_APU, (IDX))
21
22#define XPM_DEVID_ACPU_0 APU_DEVID(XPM_NODEIDX_DEV_ACPU_0)
23#define XPM_DEVID_ACPU_1 APU_DEVID(XPM_NODEIDX_DEV_ACPU_1)
24
Tejas Patel95794c72019-01-08 01:46:35 -0800[diff] [blame]25/* PM API ids */
26#define PM_GET_API_VERSION 1U
Tejas Patelcf1e56a2019-01-08 01:46:37 -0800[diff] [blame^]27#define PM_GET_DEVICE_STATUS 3U
Tejas Patelfbb32692019-12-08 23:29:44 -0800[diff] [blame]28#define PM_REQ_SUSPEND 6U
29#define PM_SELF_SUSPEND 7U
30#define PM_ABORT_SUSPEND 9U
Tejas Patelcf1e56a2019-01-08 01:46:37 -0800[diff] [blame^]31#define PM_REQUEST_DEVICE 13U
32#define PM_RELEASE_DEVICE 14U
33#define PM_SET_REQUIREMENT 15U
Tejas Patel95794c72019-01-08 01:46:35 -0800[diff] [blame]34
Tejas Patelc73a90e2018-12-14 00:55:37 -0800[diff] [blame]35/*********************************************************************
36 * Enum definitions
37 ********************************************************************/
38
Tejas Patelfbb32692019-12-08 23:29:44 -0800[diff] [blame]39enum pm_abort_reason {
40 ABORT_REASON_WKUP_EVENT = 100,
41 ABORT_REASON_PU_BUSY,
42 ABORT_REASON_NO_PWRDN,
43 ABORT_REASON_UNKNOWN,
44};
45
Tejas Patelc73a90e2018-12-14 00:55:37 -0800[diff] [blame]46/**
Tejas Patelcf1e56a2019-01-08 01:46:37 -0800[diff] [blame^]47 * Subsystem IDs
48 */
49typedef enum {
50 XPM_SUBSYSID_PMC,
51 XPM_SUBSYSID_PSM,
52 XPM_SUBSYSID_APU,
53 XPM_SUBSYSID_RPU0_LOCK,
54 XPM_SUBSYSID_RPU0_0,
55 XPM_SUBSYSID_RPU0_1,
56 XPM_SUBSYSID_DDR0,
57 XPM_SUBSYSID_ME,
58 XPM_SUBSYSID_PL,
59 XPM_SUBSYSID_MAX,
60} XPm_SubsystemId;
61
62/**
Tejas Patelc73a90e2018-12-14 00:55:37 -0800[diff] [blame]63 * @PM_RET_SUCCESS: success
64 * @PM_RET_ERROR_ARGS: illegal arguments provided (deprecated)
65 * @PM_RET_ERROR_NOTSUPPORTED: feature not supported (deprecated)
66 * @PM_RET_ERROR_INTERNAL: internal error
67 * @PM_RET_ERROR_CONFLICT: conflict
68 * @PM_RET_ERROR_ACCESS: access rights violation
69 * @PM_RET_ERROR_INVALID_NODE: invalid node
70 * @PM_RET_ERROR_DOUBLE_REQ: duplicate request for same node
71 * @PM_RET_ERROR_ABORT_SUSPEND: suspend procedure has been aborted
72 * @PM_RET_ERROR_TIMEOUT: timeout in communication with PMU
73 * @PM_RET_ERROR_NODE_USED: node is already in use
74 */
75enum pm_ret_status {
76 PM_RET_SUCCESS,
77 PM_RET_ERROR_ARGS = 1,
78 PM_RET_ERROR_NOTSUPPORTED = 4,
79 PM_RET_ERROR_INTERNAL = 2000,
80 PM_RET_ERROR_CONFLICT = 2001,
81 PM_RET_ERROR_ACCESS = 2002,
82 PM_RET_ERROR_INVALID_NODE = 2003,
83 PM_RET_ERROR_DOUBLE_REQ = 2004,
84 PM_RET_ERROR_ABORT_SUSPEND = 2005,
85 PM_RET_ERROR_TIMEOUT = 2006,
86 PM_RET_ERROR_NODE_USED = 2007
87};
88#endif /* PM_DEFS_H */