embeddedsw/lib/sw_services/xilpm/src/rpu/pm_client.h
Jyotheeswar Reddy ef6ec50aa5 libs:xilpm_v1_0: Adding Power Management Library for ZynqMP
swbeta2 commit 8e824dfe3b169461916c0190194a3eb5a7810b1a

xilpm provides a set of APIs which can be used by standalone applications
to call in PMUFW power management APIs via IPI. Self-suspend example is
provided to demonstrate the usage of this library.

Signed-off-by: Jyotheeswar Reddy <jyothee@xilinx.com>
2015-04-24 11:57:08 +05:30

90 lines
3.1 KiB
C

/******************************************************************************
*
* Copyright (C) 2015 Xilinx, Inc. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* Use of the Software is limited solely to applications:
* (a) running on a Xilinx device, or
* (b) that interact with a Xilinx device through a bus or interconnect.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* XILINX CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
* OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Except as contained in this notice, the name of the Xilinx shall not be used
* in advertising or otherwise to promote the sale, use or other dealings in
* this Software without prior written authorization from Xilinx.
*
******************************************************************************/
/*********************************************************************
* CONTENT
* File is specific for each PU instance and must exist in order to
* port Power Management code for some new PU.
* Contains PU specific macros and macros to be defined depending on
* the execution environment.
*********************************************************************/
#ifndef _PM_CLIENT_H_
#define _PM_CLIENT_H_
#include <xil_exception.h>
#include <xil_io.h>
#include "pm_rpu.h"
#include "pm_defs.h"
#include "pm_common.h"
#define MASTER_PWRCTL RPU_RPU_0_PWRDWN
#define IPI_RPU_MASK 0x00000100U
#define IPI_TRIG_OFFSET 0x00010000
#define IPI_OBS_OFFSET 0x00010004
#define UNDEFINED_CPUID (~0)
#define pm_read(addr) Xil_In32(addr)
#define pm_write(addr, value) Xil_Out32(addr, value)
#define pm_enable_int() Xil_ExceptionEnable()
#define pm_disable_int() Xil_ExceptionDisable()
#define pm_print(MSG, ...) xil_printf("RPU: "MSG,##__VA_ARGS__)
#define pm_this_cpuid() 0U
/* Conditional debugging prints */
#ifdef DEBUG_MODE
#define pm_dbg(MSG, ...) \
do { \
pm_print(MSG,##__VA_ARGS__); \
} while (0)
#else
#define pm_dbg(MSG, ...) {}
#endif
#ifndef bool
#define bool uint8_t
#define true 1U
#define false 0U
#endif
void XPm_ClientSuspend(const struct XPm_Master *const master);
void XPm_ClientAbortSuspend();
void XPm_ClientWakeup(const struct XPm_Master *const master);
/* Do not modify below this line */
extern const enum XPmNodeId subsystem_node;
extern const struct XPm_Master *primary_master;
#endif /* _PM_CLIENT_H_ */