/*
 * Copyright (c) 2005 Jakub Jermar
 * All rights reserved.
 *
 * 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.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */

/** @addtogroup sparc64interrupt
 * @{
 */
/** 
 * @file
 * @brief This file contains interrupt vector trap handler.
 */

#ifndef KERN_sparc64_TRAP_INTERRUPT_H_
#define KERN_sparc64_TRAP_INTERRUPT_H_

#include <arch/trap/trap_table.h>
#include <arch/stack.h>

/* IMAP register bits */
#define IGN_MASK	0x7c0
#define INO_MASK	0x1f
#define IMAP_V_MASK	(1ULL << 31)

#define IGN_SHIFT	6


/* Interrupt ASI registers. */
#define ASI_INTR_W			0x77
#define ASI_INTR_DISPATCH_STATUS	0x48
#define ASI_INTR_R			0x7f
#define ASI_INTR_RECEIVE		0x49

/* VA's used with ASI_INTR_W register. */
#if defined (US)
#define ASI_UDB_INTR_W_DATA_0	0x40
#define ASI_UDB_INTR_W_DATA_1	0x50
#define ASI_UDB_INTR_W_DATA_2	0x60
#elif defined (US3)
#define VA_INTR_W_DATA_0	0x40
#define VA_INTR_W_DATA_1	0x48
#define VA_INTR_W_DATA_2	0x50
#define VA_INTR_W_DATA_3	0x58
#define VA_INTR_W_DATA_4	0x60
#define VA_INTR_W_DATA_5	0x68
#define VA_INTR_W_DATA_6	0x80
#define VA_INTR_W_DATA_7	0x88
#endif
#define VA_INTR_W_DISPATCH	0x70

/* VA's used with ASI_INTR_R register. */
#if defined(US)
#define ASI_UDB_INTR_R_DATA_0	0x40
#define ASI_UDB_INTR_R_DATA_1	0x50
#define ASI_UDB_INTR_R_DATA_2	0x60
#elif defined (US3)
#define VA_INTR_R_DATA_0	0x40
#define VA_INTR_R_DATA_1	0x48
#define VA_INTR_R_DATA_2	0x50
#define VA_INTR_R_DATA_3	0x58
#define VA_INTR_R_DATA_4	0x60
#define VA_INTR_R_DATA_5	0x68
#define VA_INTR_R_DATA_6	0x80
#define VA_INTR_R_DATA_7	0x88
#endif

/* Shifts in the Interrupt Vector Dispatch virtual address. */
#define INTR_VEC_DISPATCH_MID_SHIFT	14

/* Bits in the Interrupt Dispatch Status register. */
#define INTR_DISPATCH_STATUS_NACK	0x2
#define INTR_DISPATCH_STATUS_BUSY	0x1

#define TT_INTERRUPT_LEVEL_1			0x41
#define TT_INTERRUPT_LEVEL_2			0x42
#define TT_INTERRUPT_LEVEL_3			0x43
#define TT_INTERRUPT_LEVEL_4			0x44
#define TT_INTERRUPT_LEVEL_5			0x45
#define TT_INTERRUPT_LEVEL_6			0x46
#define TT_INTERRUPT_LEVEL_7			0x47
#define TT_INTERRUPT_LEVEL_8			0x48
#define TT_INTERRUPT_LEVEL_9			0x49
#define TT_INTERRUPT_LEVEL_10			0x4a
#define TT_INTERRUPT_LEVEL_11			0x4b
#define TT_INTERRUPT_LEVEL_12			0x4c
#define TT_INTERRUPT_LEVEL_13			0x4d
#define TT_INTERRUPT_LEVEL_14			0x4e
#define TT_INTERRUPT_LEVEL_15			0x4f

#define TT_INTERRUPT_VECTOR_TRAP		0x60

#define INTERRUPT_LEVEL_N_HANDLER_SIZE		TRAP_TABLE_ENTRY_SIZE
#define INTERRUPT_VECTOR_TRAP_HANDLER_SIZE	TRAP_TABLE_ENTRY_SIZE

#ifdef __ASM__
.macro INTERRUPT_LEVEL_N_HANDLER n
	mov \n - 1, %g2
	PREEMPTIBLE_HANDLER exc_dispatch
.endm

.macro INTERRUPT_VECTOR_TRAP_HANDLER
	PREEMPTIBLE_HANDLER interrupt
.endm
#endif /* __ASM__ */

#ifndef __ASM__

#include <arch/interrupt.h>

extern void interrupt(int n, istate_t *istate);
#endif /* !def __ASM__ */

#endif

/** @}
 */
