/******************************************************************************
*
* Copyright (C) 2015 - 2016 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
* XILINX  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.
*
******************************************************************************/
/****************************************************************************/
/**
*
* @file xil_exception.c
*
* This file contains low-level driver functions for the Cortex A53,A9,R5 exception
* Handler.
*
* <pre>
* MODIFICATION HISTORY:
*
* Ver   Who      Date     Changes
* ----- -------- -------- -----------------------------------------------
* 5.2	pkp  	 28/05/15 First release
* 6.0   mus      27/07/16 Consolidated exceptions for a53,a9 and r5
*                         processors and added Xil_UndefinedExceptionHandler
*                         for a53 32 bit and r5 as well.
* 6.4   mus      08/06/17 Updated debug prints to replace %x with the %lx, to
*                         fix the warnings.
* </pre>
*
*****************************************************************************/

/***************************** Include Files ********************************/

#include "xil_types.h"
#include "xil_assert.h"
#include "xil_exception.h"
#include "xpseudo_asm.h"
#include "xdebug.h"
/************************** Constant Definitions ****************************/

/**************************** Type Definitions ******************************/

typedef struct {
	Xil_ExceptionHandler Handler;
	void *Data;
} XExc_VectorTableEntry;

/***************** Macros (Inline Functions) Definitions ********************/

/************************** Function Prototypes *****************************/
static void Xil_ExceptionNullHandler(void *Data);
/************************** Variable Definitions *****************************/
/*
 * Exception vector table to store handlers for each exception vector.
 */
#if defined(__aarch64__)
XExc_VectorTableEntry XExc_VectorTable[XIL_EXCEPTION_ID_LAST + 1] = {
	{ Xil_ExceptionNullHandler, NULL }, { Xil_SyncAbortHandler, NULL },
	{ Xil_ExceptionNullHandler, NULL }, { Xil_ExceptionNullHandler, NULL },
	{ Xil_SErrorAbortHandler, NULL },

};
#else
XExc_VectorTableEntry XExc_VectorTable[XIL_EXCEPTION_ID_LAST + 1] = {
	{ Xil_ExceptionNullHandler, NULL },
	{ Xil_UndefinedExceptionHandler, NULL },
	{ Xil_ExceptionNullHandler, NULL },
	{ Xil_PrefetchAbortHandler, NULL },
	{ Xil_DataAbortHandler, NULL },
	{ Xil_ExceptionNullHandler, NULL },
	{ Xil_ExceptionNullHandler, NULL },
};
#endif
#if !defined(__aarch64__)
u32 DataAbortAddr; /* Address of instruction causing data abort */
u32 PrefetchAbortAddr; /* Address of instruction causing prefetch abort */
u32 UndefinedExceptionAddr; /* Address of instruction causing Undefined
							     exception */
#endif

/*****************************************************************************/

/****************************************************************************/
/**
*
* This function is a stub Handler that is the default Handler that gets called
* if the application has not setup a Handler for a specific  exception. The
* function interface has to match the interface specified for a Handler even
* though none of the arguments are used.
*
* @param	Data is unused by this function.
*
* @return	None.
*
* @note		None.
*
*****************************************************************************/
static void Xil_ExceptionNullHandler(void *Data)
{
	(void)Data;
DieLoop:
	goto DieLoop;
}

/****************************************************************************/
/**
* @brief	The function is a common API used to initialize exception handlers
*			across all supported arm processors. For ARM Cortex-A53, Cortex-R5,
*			and Cortex-A9, the exception handlers are being initialized
*			statically and this function does not do anything.
* 			However, it is still present to take care of backward compatibility
*			issues (in earlier versions of BSPs, this API was being used to
*			initialize exception handlers).
*
* @param	None.
*
* @return	None.
*
* @note		None.
*
*****************************************************************************/
void Xil_ExceptionInit(void)
{
	return;
}

/*****************************************************************************/
/**
* @brief	Register a handler for a specific exception. This handler is being
*			called when the processor encounters the specified exception.
*
* @param	exception_id contains the ID of the exception source and should
*			be in the range of 0 to XIL_EXCEPTION_ID_LAST.
*			See xil_exception.h for further information.
* @param	Handler to the Handler for that exception.
* @param	Data is a reference to Data that will be passed to the
*			Handler when it gets called.
*
* @return	None.
*
* @note		None.
*
****************************************************************************/
void Xil_ExceptionRegisterHandler(u32 Exception_id,
				  Xil_ExceptionHandler Handler, void *Data)
{
	XExc_VectorTable[Exception_id].Handler = Handler;
	XExc_VectorTable[Exception_id].Data = Data;
}

/*****************************************************************************/
/**
*
* @brief	Removes the Handler for a specific exception Id. The stub Handler
*			is then registered for this exception Id.
*
* @param	exception_id contains the ID of the exception source and should
*			be in the range of 0 to XIL_EXCEPTION_ID_LAST.
*			See xil_exception.h for further information.
*
* @return	None.
*
* @note		None.
*
****************************************************************************/
void Xil_ExceptionRemoveHandler(u32 Exception_id)
{
	Xil_ExceptionRegisterHandler(Exception_id, Xil_ExceptionNullHandler,
				     NULL);
}

#if defined(__aarch64__)
/*****************************************************************************/
/**
*
* Default Synchronous abort handler which prints a debug message on console if
* Debug flag is enabled
*
* @param        None
*
* @return       None.
*
* @note         None.
*
****************************************************************************/

void Xil_SyncAbortHandler(void *CallBackRef)
{
	(void)CallBackRef;
	xdbg_printf(XDBG_DEBUG_ERROR, "Synchronous abort \n");
	while (1) {
		;
	}
}

/*****************************************************************************/
/**
*
* Default SError abort handler which prints a debug message on console if
* Debug flag is enabled
*
* @param        None
*
* @return       None.
*
* @note         None.
*
****************************************************************************/
void Xil_SErrorAbortHandler(void *CallBackRef)
{
	(void)CallBackRef;
	xdbg_printf(XDBG_DEBUG_ERROR, "Synchronous abort \n");
	while (1) {
		;
	}
}
#else
/*****************************************************************************/
/*
*
* Default Data abort handler which prints data fault status register through
* which information about data fault can be acquired
*
* @param	None
*
* @return	None.
*
* @note		None.
*
****************************************************************************/

void Xil_DataAbortHandler(void *CallBackRef)
{
	(void)CallBackRef;
#ifdef DEBUG
	u32 FaultStatus;

	xdbg_printf(XDBG_DEBUG_ERROR, "Data abort \n");
#ifdef __GNUC__
	FaultStatus = mfcp(XREG_CP15_DATA_FAULT_STATUS);
#elif defined(__ICCARM__)
	mfcp(XREG_CP15_DATA_FAULT_STATUS, FaultStatus);
#else
	{
		volatile register u32 Reg __asm(XREG_CP15_DATA_FAULT_STATUS);
		FaultStatus = Reg;
	}
#endif
	xdbg_printf(XDBG_DEBUG_GENERAL,
		    "Data abort with Data Fault Status Register  %lx\n",
		    FaultStatus);
	xdbg_printf(XDBG_DEBUG_GENERAL,
		    "Address of Instruction causing Data abort %lx\n",
		    DataAbortAddr);
#endif
	while (1) {
		;
	}
}

/*****************************************************************************/
/*
*
* Default Prefetch abort handler which prints prefetch fault status register through
* which information about instruction prefetch fault can be acquired
*
* @param	None
*
* @return	None.
*
* @note		None.
*
****************************************************************************/
void Xil_PrefetchAbortHandler(void *CallBackRef)
{
	(void)CallBackRef;
#ifdef DEBUG
	u32 FaultStatus;

	xdbg_printf(XDBG_DEBUG_ERROR, "Prefetch abort \n");
#ifdef __GNUC__
	FaultStatus = mfcp(XREG_CP15_INST_FAULT_STATUS);
#elif defined(__ICCARM__)
	mfcp(XREG_CP15_INST_FAULT_STATUS, FaultStatus);
#else
	{
		volatile register u32 Reg __asm(XREG_CP15_INST_FAULT_STATUS);
		FaultStatus = Reg;
	}
#endif
	xdbg_printf(
		XDBG_DEBUG_GENERAL,
		"Prefetch abort with Instruction Fault Status Register  %lx\n",
		FaultStatus);
	xdbg_printf(XDBG_DEBUG_GENERAL,
		    "Address of Instruction causing Prefetch abort %lx\n",
		    PrefetchAbortAddr);
#endif
	while (1) {
		;
	}
}
/*****************************************************************************/
/*
*
* Default undefined exception handler which prints address of the undefined
* instruction if debug prints are enabled
*
* @param	None
*
* @return	None.
*
* @note		None.
*
****************************************************************************/
void Xil_UndefinedExceptionHandler(void *CallBackRef)
{
	(void)CallBackRef;
	xdbg_printf(XDBG_DEBUG_GENERAL,
		    "Address of the undefined instruction %lx\n",
		    UndefinedExceptionAddr);
	while (1) {
		;
	}
}
#endif

/*****************************************************************************/
/*
* @brief Dump the register value in FreeRTOS abort.
*
* STP Xt1, Xt2, [Xn|SP, #imm]! ; 64-bit general registers, Pre-index.
* portASM.S use pre-index STP to save all the registers.
* In pre-index, STP Xt1, Xt2, [SP, #imm]! would have following action.
* a. SP = SP + #imm
* b. save Xt1 to MEM[SP]
* c. save Xt2 to MEM[SP+8]
*
* All the register is needed to save by STP instructions in portASM.S.
* 1. 8x32 bytes X0~X31
* 2. 8x2  bytes ELR_EL1 and SPSR_EL1
* 3. 8x2  bytes FPU context and critical section nesting depth
*
* @param[in] pt_regs A pointer point to SP for all the register value in stack.
* @param[in] len Frame size including above 1. 2. 3. .
*
* @return   None.
*
* @note     Need to check the register order in memory.
* For example, SP is 0x2b0
*     STP     X0, X1, [SP, #-0x10]!
*     STP     X2, X3, [SP, #-0x10]!
*     STP     X4, X5, [SP, #-0x10]!
* => memory layout:
*      offset 0x0    0x8
*      ====================
* 0x280       X4      X5
* 0x290       X2      X3
* 0x2a0       X0      X1
* 0x2b0
*
* From high address to low address, register order is
*  X1-> X0-> X3-> X2-> X5-> X4....
*
****************************************************************************/
void vApplicationPrintRegister(size_t *pt_regs, int len)
{
	int i;
	/* One time for 16 bytes from STP in portASM.S */
	for (i = 0; i < len / 8; i = i + 2) {
		pt_regs = pt_regs - 2;

		switch (i) {
		case 0 ... 9:
			printf("x%2d:   ", i);
			printf("%lx  ", *(pt_regs));
			printf("x%2d:   ", i + 1);
			printf("%lx  \n", *(pt_regs + 1));
			break;
		case 10 ... 31:
			printf("x%2d:  ", i);
			printf("%lx  ", *(pt_regs));
			printf("x%2d:  ", i + 1);
			printf("%lx  \n", *(pt_regs + 1));
			break;
		case 32:
			printf("ELR_EL1: ");
			printf("%lx  \n", *(pt_regs));
			printf("SPSR_EL1: ");
			printf("%lx  \n", *(pt_regs + 1));
			break;
		case 34:
			printf("FPU context: ");
			printf("%lx  \n", *(pt_regs));
			printf("critical section nesting depth: ");
			printf("%lx  \n", *(pt_regs + 1));
			break;
		}
	}
}