4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This is set of macros used in calculating offsets in the IVT.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// http://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EXCPT_EXTERNAL_INTERRUPT 12
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define MASK_0_4 0x000000000000001F // mask bits 0 through 4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SLOT0 0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SLOT1 1
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SLOT2 2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PSR_DT 17
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PSR_TB 26
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PSR_RT 27
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PSR_IS 34
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PSR_IT 36
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PSR_IC 13
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PSR_I 14
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PSR_SS 40
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PSR_BN 44
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PSR_RI_MASK 0x60000000000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EXCPT_EXTERNAL_INTERRUPT 12
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SCRATCH_REG0 r23
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SCRATCH_REG1 r24
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SCRATCH_REG2 r25
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SCRATCH_REG3 r26
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SCRATCH_REG4 r27
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SCRATCH_REG5 r28
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SCRATCH_REG6 r29
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PR_REG r30
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define B0_REG r31
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EXT_INT_OFFSET is the offset of the external interrupt entry in the IVT
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EXT_INT_ENTRY_OFFSET 0x03000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// PATCH_ENTRY_OFFSET is the offset into the IVT of the entry that is coopted (stolen)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// for use by the handler. The entire entry is restored when the handler is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// unloaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PATCH_ENTRY_OFFSET 0x03400
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// PATCH_CODE_SIZE is the size of patch code
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PATCH_CODE_SIZE (EndPatchCode - PatchCode)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// A hard coded branch back into the external interrupt IVT entry's second bundle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// is put here, just in case the original bundle zero did not have a branch
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// This is the last bundle in the reserved IVT entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define FAILSAFE_BRANCH_OFFSET (PATCH_ENTRY_OFFSET + 0x400 - 0x10)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// the original external interrupt IVT entry bundle zero is copied and relocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// here... also in the reserved IVT entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// This is the second-to-last bundle in the reserved IVT entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define RELOCATED_EXT_INT (PATCH_ENTRY_OFFSET + 0x400 - 0x20)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The patch is actually stored at the end of IVT:PATCH_ENTRY. The PATCH_OFFSET
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// is the offset into IVT where the patch is actually stored. It is carefully
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// located so that when we run out of patch code, the next bundle is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// relocated bundle 0 from the original external interrupt handler
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PATCH_OFFSET (PATCH_ENTRY_OFFSET + 0x400 - ( EndPatchCode - PatchCode ) - 0x20)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PATCH_RETURN_OFFSET (PATCH_ENTRY_OFFSET + 0x400 - ( EndPatchCode - PatchCodeRet ) - 0x20)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// PATCH_BRANCH is used only in the new bundle that is placed at the beginning
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// of the external interrupt IVT entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PATCH_BRANCH (PATCH_OFFSET - EXT_INT_ENTRY_OFFSET)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync