/*
 * ***************************************************************************
 * Copyright (C) 2016 Marvell International Ltd.
 * ***************************************************************************
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * Neither the name of Marvell nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ***************************************************************************
 */

#ifndef __MSS_PM_IPC_H
#define __MSS_PM_IPC_H


#include <mss_ipc_drv.h>
/* Currently MSS does not support Cluster level Power Down */
#define DISABLE_CLUSTER_LEVEL


/*******************************************************************************
 * mss_pm_ipc_msg_send
 *
 * DESCRIPTION: create and transmit IPC message
 ******************************************************************************
 */
int mss_pm_ipc_msg_send(unsigned int channel_id,
			const psci_power_state_t *target_state);

/*******************************************************************************
 * mss_pm_ipc_msg_recv
 *
 * DESCRIPTION: wait from reception of IPC message indication,
 *              once received, read the message from IPC channel,
 *              mark IPC channel as Free, and validate reply
 ******************************************************************************
 */
int mss_pm_ipc_msg_recv(unsigned int channel_id, unsigned int msg_id);

/*******************************************************************************
 * mss_pm_ipc_on_msg_trigger
 *
 * DESCRIPTION: Trigger IPC ON message interrupt to MSS
 ******************************************************************************
 */
int mss_pm_ipc_on_msg_trigger(unsigned int cpu_id);

/*******************************************************************************
 * mss_pm_ipc_on_msg_trigger
 *
 * DESCRIPTION: Trigger IPC OFF message interrupt to MSS
 ******************************************************************************
 */
int mss_pm_ipc_off_msg_trigger(unsigned int cpu_id);

/*******************************************************************************
 * mss_pm_ipc_on_msg_trigger
 *
 * DESCRIPTION: Trigger IPC SUSPEND message interrupt to MSS
 ******************************************************************************
 */
int mss_pm_ipc_suspend_msg_trigger(unsigned int cpu_id);


#endif /* __MSS_PM_IPC_H */