mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-04-16 09:34:18 +00:00
caae497dfc
These are empty functions with no logic right now. Code will be added in subsequent commits. Signed-off-by: Rajan Vaja <rajanv@xilinx.com> Signed-off-by: Jolly Shah <jollys@xilinx.com>
253 lines
4.7 KiB
C
253 lines
4.7 KiB
C
/*
|
|
* Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
/* ZynqMP power management enums and defines */
|
|
|
|
#ifndef _PM_DEFS_H_
|
|
#define _PM_DEFS_H_
|
|
|
|
/*********************************************************************
|
|
* Macro definitions
|
|
********************************************************************/
|
|
|
|
/*
|
|
* Version number is a 32bit value, like:
|
|
* (PM_VERSION_MAJOR << 16) | PM_VERSION_MINOR
|
|
*/
|
|
#define PM_VERSION_MAJOR 0
|
|
#define PM_VERSION_MINOR 2
|
|
|
|
#define PM_VERSION ((PM_VERSION_MAJOR << 16) | PM_VERSION_MINOR)
|
|
|
|
/* Capabilities for RAM */
|
|
#define PM_CAP_ACCESS 0x1U
|
|
#define PM_CAP_CONTEXT 0x2U
|
|
|
|
#define MAX_LATENCY (~0U)
|
|
#define MAX_QOS 100U
|
|
|
|
/* State arguments of the self suspend */
|
|
#define PM_STATE_CPU_IDLE 0x0U
|
|
#define PM_STATE_SUSPEND_TO_RAM 0xFU
|
|
|
|
/*********************************************************************
|
|
* Enum definitions
|
|
********************************************************************/
|
|
|
|
enum pm_api_id {
|
|
/* Miscellaneous API functions: */
|
|
PM_GET_API_VERSION = 1, /* Do not change or move */
|
|
PM_SET_CONFIGURATION,
|
|
PM_GET_NODE_STATUS,
|
|
PM_GET_OP_CHARACTERISTIC,
|
|
PM_REGISTER_NOTIFIER,
|
|
/* API for suspending of PUs: */
|
|
PM_REQ_SUSPEND,
|
|
PM_SELF_SUSPEND,
|
|
PM_FORCE_POWERDOWN,
|
|
PM_ABORT_SUSPEND,
|
|
PM_REQ_WAKEUP,
|
|
PM_SET_WAKEUP_SOURCE,
|
|
PM_SYSTEM_SHUTDOWN,
|
|
/* API for managing PM slaves: */
|
|
PM_REQ_NODE,
|
|
PM_RELEASE_NODE,
|
|
PM_SET_REQUIREMENT,
|
|
PM_SET_MAX_LATENCY,
|
|
/* Direct control API functions: */
|
|
PM_RESET_ASSERT,
|
|
PM_RESET_GET_STATUS,
|
|
PM_MMIO_WRITE,
|
|
PM_MMIO_READ,
|
|
PM_INIT,
|
|
PM_FPGA_LOAD,
|
|
PM_FPGA_GET_STATUS,
|
|
PM_GET_CHIPID,
|
|
PM_SECURE_RSA_AES,
|
|
PM_SECURE_SHA,
|
|
PM_SECURE_RSA,
|
|
PM_PINCTRL_REQUEST,
|
|
PM_PINCTRL_RELEASE,
|
|
PM_PINCTRL_GET_FUNCTION,
|
|
PM_PINCTRL_SET_FUNCTION,
|
|
PM_PINCTRL_CONFIG_PARAM_GET,
|
|
PM_PINCTRL_CONFIG_PARAM_SET,
|
|
PM_IOCTL,
|
|
/* API to query information from firmware */
|
|
PM_QUERY_DATA,
|
|
/* Clock control API functions */
|
|
PM_CLOCK_ENABLE,
|
|
PM_CLOCK_DISABLE,
|
|
PM_CLOCK_GETSTATE,
|
|
PM_CLOCK_SETDIVIDER,
|
|
PM_CLOCK_GETDIVIDER,
|
|
PM_CLOCK_SETRATE,
|
|
PM_CLOCK_GETRATE,
|
|
PM_CLOCK_SETPARENT,
|
|
PM_CLOCK_GETPARENT,
|
|
PM_API_MAX
|
|
};
|
|
|
|
enum pm_node_id {
|
|
NODE_UNKNOWN = 0,
|
|
NODE_APU,
|
|
NODE_APU_0,
|
|
NODE_APU_1,
|
|
NODE_APU_2,
|
|
NODE_APU_3,
|
|
NODE_RPU,
|
|
NODE_RPU_0,
|
|
NODE_RPU_1,
|
|
NODE_PLD,
|
|
NODE_FPD,
|
|
NODE_OCM_BANK_0,
|
|
NODE_OCM_BANK_1,
|
|
NODE_OCM_BANK_2,
|
|
NODE_OCM_BANK_3,
|
|
NODE_TCM_0_A,
|
|
NODE_TCM_0_B,
|
|
NODE_TCM_1_A,
|
|
NODE_TCM_1_B,
|
|
NODE_L2,
|
|
NODE_GPU_PP_0,
|
|
NODE_GPU_PP_1,
|
|
NODE_USB_0,
|
|
NODE_USB_1,
|
|
NODE_TTC_0,
|
|
NODE_TTC_1,
|
|
NODE_TTC_2,
|
|
NODE_TTC_3,
|
|
NODE_SATA,
|
|
NODE_ETH_0,
|
|
NODE_ETH_1,
|
|
NODE_ETH_2,
|
|
NODE_ETH_3,
|
|
NODE_UART_0,
|
|
NODE_UART_1,
|
|
NODE_SPI_0,
|
|
NODE_SPI_1,
|
|
NODE_I2C_0,
|
|
NODE_I2C_1,
|
|
NODE_SD_0,
|
|
NODE_SD_1,
|
|
NODE_DP,
|
|
NODE_GDMA,
|
|
NODE_ADMA,
|
|
NODE_NAND,
|
|
NODE_QSPI,
|
|
NODE_GPIO,
|
|
NODE_CAN_0,
|
|
NODE_CAN_1,
|
|
NODE_AFI,
|
|
NODE_APLL,
|
|
NODE_VPLL,
|
|
NODE_DPLL,
|
|
NODE_RPLL,
|
|
NODE_IOPLL,
|
|
NODE_DDR,
|
|
NODE_IPI_APU,
|
|
NODE_IPI_RPU_0,
|
|
NODE_GPU,
|
|
NODE_PCIE,
|
|
NODE_PCAP,
|
|
NODE_RTC,
|
|
NODE_LPD,
|
|
NODE_VCU,
|
|
NODE_IPI_RPU_1,
|
|
NODE_IPI_PL_0,
|
|
NODE_IPI_PL_1,
|
|
NODE_IPI_PL_2,
|
|
NODE_IPI_PL_3,
|
|
NODE_PL,
|
|
NODE_GEM_TSU,
|
|
NODE_SWDT_0,
|
|
NODE_SWDT_1,
|
|
NODE_CSU,
|
|
NODE_PJTAG,
|
|
NODE_TRACE,
|
|
NODE_TESTSCAN,
|
|
NODE_PMU,
|
|
NODE_MAX,
|
|
};
|
|
|
|
enum pm_request_ack {
|
|
REQ_ACK_NO = 1,
|
|
REQ_ACK_BLOCKING,
|
|
REQ_ACK_NON_BLOCKING,
|
|
};
|
|
|
|
enum pm_abort_reason {
|
|
ABORT_REASON_WKUP_EVENT = 100,
|
|
ABORT_REASON_PU_BUSY,
|
|
ABORT_REASON_NO_PWRDN,
|
|
ABORT_REASON_UNKNOWN,
|
|
};
|
|
|
|
enum pm_suspend_reason {
|
|
SUSPEND_REASON_PU_REQ = 201,
|
|
SUSPEND_REASON_ALERT,
|
|
SUSPEND_REASON_SYS_SHUTDOWN,
|
|
};
|
|
|
|
enum pm_ram_state {
|
|
PM_RAM_STATE_OFF = 1,
|
|
PM_RAM_STATE_RETENTION,
|
|
PM_RAM_STATE_ON,
|
|
};
|
|
|
|
enum pm_opchar_type {
|
|
PM_OPCHAR_TYPE_POWER = 1,
|
|
PM_OPCHAR_TYPE_TEMP,
|
|
PM_OPCHAR_TYPE_LATENCY,
|
|
};
|
|
|
|
/**
|
|
* @PM_RET_SUCCESS: success
|
|
* @PM_RET_ERROR_ARGS: illegal arguments provided
|
|
* @PM_RET_ERROR_ACCESS: access rights violation
|
|
* @PM_RET_ERROR_TIMEOUT: timeout in communication with PMU
|
|
* @PM_RET_ERROR_NOTSUPPORTED: feature not supported
|
|
* @PM_RET_ERROR_PROC: node is not a processor node
|
|
* @PM_RET_ERROR_API_ID: illegal API ID
|
|
* @PM_RET_ERROR_OTHER: other error
|
|
*/
|
|
enum pm_ret_status {
|
|
PM_RET_SUCCESS,
|
|
PM_RET_ERROR_ARGS,
|
|
PM_RET_ERROR_ACCESS,
|
|
PM_RET_ERROR_TIMEOUT,
|
|
PM_RET_ERROR_NOTSUPPORTED,
|
|
PM_RET_ERROR_PROC,
|
|
PM_RET_ERROR_API_ID,
|
|
PM_RET_ERROR_FAILURE,
|
|
PM_RET_ERROR_COMMUNIC,
|
|
PM_RET_ERROR_DOUBLEREQ,
|
|
PM_RET_ERROR_OTHER,
|
|
};
|
|
|
|
/**
|
|
* @PM_INITIAL_BOOT: boot is a fresh system startup
|
|
* @PM_RESUME: boot is a resume
|
|
* @PM_BOOT_ERROR: error, boot cause cannot be identified
|
|
*/
|
|
enum pm_boot_status {
|
|
PM_INITIAL_BOOT,
|
|
PM_RESUME,
|
|
PM_BOOT_ERROR,
|
|
};
|
|
|
|
enum pm_shutdown_type {
|
|
PMF_SHUTDOWN_TYPE_SHUTDOWN,
|
|
PMF_SHUTDOWN_TYPE_RESET,
|
|
};
|
|
|
|
enum pm_shutdown_subtype {
|
|
PMF_SHUTDOWN_SUBTYPE_SUBSYSTEM,
|
|
PMF_SHUTDOWN_SUBTYPE_PS_ONLY,
|
|
PMF_SHUTDOWN_SUBTYPE_SYSTEM,
|
|
};
|
|
|
|
#endif /* _PM_DEFS_H_ */
|