Subversion Repositories openrisc

/* spr_defs.h -- Defines OR1K architecture specific special-purpose registers

   Copyright (C) 1999 Damjan Lampret

   Copyright (C) 2008, 2010 Embecosm Limited

   Contributor Damjan Lampret <lampret@opencores.org>

   Contributor Jeremy Bennett <jeremy.bennett@embecosm.com>

   This file is part of Newlib.

   This program is free software; you can redistribute it and/or modify it

   under the terms of the GNU General Public License as published by the Free

   Software Foundation; either version 3 of the License, or (at your option)

   any later version.

   This program is distributed in the hope that it will be useful, but WITHOUT

   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for

   more details.

   You should have received a copy of the GNU General Public License along

   with this program.  If not, see <http://www.gnu.org/licenses/>.            */

/* -------------------------------------------------------------------------- */

/* This program is commented throughout in a fashion suitable for processing

   with Doxygen.                                                              */

/* -------------------------------------------------------------------------- */

/* This file is also used by microkernel test bench. Among others it is also

   used in assembly file(s). */

/* Definition of special-purpose registers (SPRs) */

#ifndef SPR_DEFS__H

#define SPR_DEFS__H

#define MAX_GRPS (32)

#define MAX_SPRS_PER_GRP_BITS (11)

#define MAX_SPRS_PER_GRP (1 << MAX_SPRS_PER_GRP_BITS)

#define MAX_SPRS (0x10000)

/* Base addresses for the groups */

#define SPRGROUP_SYS    (0<< MAX_SPRS_PER_GRP_BITS)

#define SPRGROUP_DMMU   (1<< MAX_SPRS_PER_GRP_BITS)

#define SPRGROUP_IMMU   (2<< MAX_SPRS_PER_GRP_BITS)

#define SPRGROUP_DC     (3<< MAX_SPRS_PER_GRP_BITS)

#define SPRGROUP_IC     (4<< MAX_SPRS_PER_GRP_BITS)

#define SPRGROUP_MAC    (5<< MAX_SPRS_PER_GRP_BITS)

#define SPRGROUP_D      (6<< MAX_SPRS_PER_GRP_BITS)

#define SPRGROUP_PC     (7<< MAX_SPRS_PER_GRP_BITS)

#define SPRGROUP_PM     (8<< MAX_SPRS_PER_GRP_BITS)

#define SPRGROUP_PIC    (9<< MAX_SPRS_PER_GRP_BITS)

#define SPRGROUP_TT     (10<< MAX_SPRS_PER_GRP_BITS)

/* System control and status group */

#define SPR_VR          (SPRGROUP_SYS + 0)

#define SPR_UPR         (SPRGROUP_SYS + 1)

#define SPR_PC          (SPRGROUP_SYS + 16)  /* CZ 21/06/01 */

#define SPR_SR          (SPRGROUP_SYS + 17)  /* CZ 21/06/01 */

#define SPR_EPCR_BASE   (SPRGROUP_SYS + 32)  /* CZ 21/06/01 */

#define SPR_EPCR_LAST   (SPRGROUP_SYS + 47)  /* CZ 21/06/01 */

#define SPR_EEAR_BASE   (SPRGROUP_SYS + 48)

#define SPR_EEAR_LAST   (SPRGROUP_SYS + 63)

#define SPR_ESR_BASE    (SPRGROUP_SYS + 64)

#define SPR_ESR_LAST    (SPRGROUP_SYS + 79)

#if 0

/* Data MMU group */

#define SPR_DMMUCR      (SPRGROUP_DMMU + 0)

#define SPR_DTLBMR_BASE(WAY)    (SPRGROUP_DMMU + 0x200 + (WAY) * 0x200)

#define SPR_DTLBMR_LAST(WAY)    (SPRGROUP_DMMU + 0x2ff + (WAY) * 0x200)

#define SPR_DTLBTR_BASE(WAY)    (SPRGROUP_DMMU + 0x300 + (WAY) * 0x200)

#define SPR_DTLBTR_LAST(WAY)    (SPRGROUP_DMMU + 0x3ff + (WAY) * 0x200)

/* Instruction MMU group */

#define SPR_IMMUCR      (SPRGROUP_IMMU + 0)

#define SPR_ITLBMR_BASE(WAY)    (SPRGROUP_IMMU + 0x200 + (WAY) * 0x200)

#define SPR_ITLBMR_LAST(WAY)    (SPRGROUP_IMMU + 0x2ff + (WAY) * 0x200)

#define SPR_ITLBTR_BASE(WAY)    (SPRGROUP_IMMU + 0x300 + (WAY) * 0x200)

#define SPR_ITLBTR_LAST(WAY)    (SPRGROUP_IMMU + 0x3ff + (WAY) * 0x200)

#else

/* Data MMU group */

#define SPR_DMMUCR      (SPRGROUP_DMMU + 0)

#define SPR_DTLBMR_BASE(WAY)    (SPRGROUP_DMMU + 0x200 + (WAY) * 0x100)

#define SPR_DTLBMR_LAST(WAY)    (SPRGROUP_DMMU + 0x27f + (WAY) * 0x100)

#define SPR_DTLBTR_BASE(WAY)    (SPRGROUP_DMMU + 0x280 + (WAY) * 0x100)

#define SPR_DTLBTR_LAST(WAY)    (SPRGROUP_DMMU + 0x2ff + (WAY) * 0x100)

/* Instruction MMU group */

#define SPR_IMMUCR      (SPRGROUP_IMMU + 0)

#define SPR_ITLBMR_BASE(WAY)    (SPRGROUP_IMMU + 0x200 + (WAY) * 0x100)

#define SPR_ITLBMR_LAST(WAY)    (SPRGROUP_IMMU + 0x27f + (WAY) * 0x100)

#define SPR_ITLBTR_BASE(WAY)    (SPRGROUP_IMMU + 0x280 + (WAY) * 0x100)

#define SPR_ITLBTR_LAST(WAY)    (SPRGROUP_IMMU + 0x2ff + (WAY) * 0x100)

#endif

/* Data cache group */

#define SPR_DCCR        (SPRGROUP_DC + 0)

#define SPR_DCBPR       (SPRGROUP_DC + 1)

#define SPR_DCBFR       (SPRGROUP_DC + 2)

#define SPR_DCBIR       (SPRGROUP_DC + 3)

#define SPR_DCBWR       (SPRGROUP_DC + 4)

#define SPR_DCBLR       (SPRGROUP_DC + 5)

#define SPR_DCR_BASE(WAY)       (SPRGROUP_DC + 0x200 + (WAY) * 0x200)

#define SPR_DCR_LAST(WAY)       (SPRGROUP_DC + 0x3ff + (WAY) * 0x200)

/* Instruction cache group */

#define SPR_ICCR        (SPRGROUP_IC + 0)

#define SPR_ICBPR       (SPRGROUP_IC + 1)

#define SPR_ICBIR       (SPRGROUP_IC + 2)

#define SPR_ICBLR       (SPRGROUP_IC + 3)

#define SPR_ICR_BASE(WAY)       (SPRGROUP_IC + 0x200 + (WAY) * 0x200)

#define SPR_ICR_LAST(WAY)       (SPRGROUP_IC + 0x3ff + (WAY) * 0x200)

/* MAC group */

#define SPR_MACLO       (SPRGROUP_MAC + 1)

#define SPR_MACHI       (SPRGROUP_MAC + 2)

/* Debug group */

#define SPR_DVR(N)      (SPRGROUP_D + (N))

#define SPR_DCR(N)      (SPRGROUP_D + 8 + (N))

#define SPR_DMR1        (SPRGROUP_D + 16)

#define SPR_DMR2        (SPRGROUP_D + 17)

#define SPR_DWCR0       (SPRGROUP_D + 18)

#define SPR_DWCR1       (SPRGROUP_D + 19)

#define SPR_DSR         (SPRGROUP_D + 20)

#define SPR_DRR         (SPRGROUP_D + 21)

#define SPR_DIR         (SPRGROUP_D + 22)

/* Performance counters group */

#define SPR_PCCR(N)     (SPRGROUP_PC + (N))

#define SPR_PCMR(N)     (SPRGROUP_PC + 8 + (N))

/* Power management group */

#define SPR_PMR (SPRGROUP_PM + 0)

/* PIC group */

#define SPR_PICMR (SPRGROUP_PIC + 0)

#define SPR_PICPR (SPRGROUP_PIC + 1)

#define SPR_PICSR (SPRGROUP_PIC + 2)

/* Tick Timer group */

#define SPR_TTMR (SPRGROUP_TT + 0)

#define SPR_TTCR (SPRGROUP_TT + 1)

/*

 * Bit definitions for the Version Register

 *

 */

#define SPR_VR_VER      0xffff0000  /* Processor version */

#define SPR_VR_REV      0x0000003f  /* Processor revision */

/*

 * Bit definitions for the Unit Present Register

 *

 */

#define SPR_UPR_UP      0x00000001  /* UPR present */

#define SPR_UPR_DCP     0x00000002  /* Data cache present */

#define SPR_UPR_ICP     0x00000004  /* Instruction cache present */

#define SPR_UPR_DMP     0x00000008  /* Data MMU present */

#define SPR_UPR_IMP     0x00000010  /* Instruction MMU present */

#define SPR_UPR_OB32P   0x00000020  /* ORBIS32 present */

#define SPR_UPR_OB64P   0x00000040  /* ORBIS64 present */

#define SPR_UPR_OF32P   0x00000080  /* ORFPX32 present */

#define SPR_UPR_OF64P   0x00000100  /* ORFPX64 present */

#define SPR_UPR_OV32P   0x00000200  /* ORVDX32 present */

#define SPR_UPR_OV64P   0x00000400  /* ORVDX64 present */

#define SPR_UPR_DUP     0x00000800  /* Debug unit present */

#define SPR_UPR_PCUP    0x00001000  /* Performance counters unit present */

#define SPR_UPR_PMP     0x00002000  /* Power management present */

#define SPR_UPR_PICP    0x00004000  /* PIC present */

#define SPR_UPR_TTP     0x00008000  /* Tick timer present */

#define SPR_UPR_SRP     0x00010000  /* Shadow registers present */

#define SPR_UPR_RES     0x00fe0000  /* ORVDX32 present */

#define SPR_UPR_CUST    0xff000000  /* Custom units */

/*

 * Bit definitions for the Supervision Register

 *

 */

#define SPR_SR_CID      0xf0000000  /* Context ID */

#define SPR_SR_FO       0x00008000  /* Fixed one */

#define SPR_SR_EPH      0x00004000  /* Exception Prefixi High */

#define SPR_SR_DSX      0x00002000  /* Delay Slot Exception */

#define SPR_SR_OVE      0x00001000  /* Overflow flag Exception */

#define SPR_SR_OV       0x00000800  /* Overflow flag */

#define SPR_SR_CY       0x00000400  /* Carry flag */

#define SPR_SR_F        0x00000200  /* Condition Flag */

#define SPR_SR_CE       0x00000100  /* CID Enable */

#define SPR_SR_LEE      0x00000080  /* Little Endian Enable */

#define SPR_SR_IME      0x00000040  /* Instruction MMU Enable */

#define SPR_SR_DME      0x00000020  /* Data MMU Enable */

#define SPR_SR_ICE      0x00000010  /* Instruction Cache Enable */

#define SPR_SR_DCE      0x00000008  /* Data Cache Enable */

#define SPR_SR_IEE      0x00000004  /* Interrupt Exception Enable */

#define SPR_SR_TEE      0x00000002  /* Tick timer Exception Enable */

#define SPR_SR_SM       0x00000001  /* Supervisor Mode */

#define SPR_SR_FO_BIT    15

#define SPR_SR_EPH_BIT   14

#define SPR_SR_DSX_BIT   13

#define SPR_SR_OVE_BIT   12

#define SPR_SR_OV_BIT    11

#define SPR_SR_CY_BIT    10

#define SPR_SR_F_BIT     9

#define SPR_SR_CE_BIT    8

#define SPR_SR_LEE_BIT   7

#define SPR_SR_IME_BIT   6

#define SPR_SR_DME_BIT   5

#define SPR_SR_ICE_BIT   4

#define SPR_SR_DCE_BIT   3

#define SPR_SR_IEE_BIT   2

#define SPR_SR_TEE_BIT   1

#define SPR_SR_SM_BIT    0

/*

 * Bit definitions for the Data MMU Control Register

 *

 */

#define SPR_DMMUCR_P2S  0x0000003e  /* Level 2 Page Size */

#define SPR_DMMUCR_P1S  0x000007c0  /* Level 1 Page Size */

#define SPR_DMMUCR_VADDR_WIDTH  0x0000f800  /* Virtual ADDR Width */

#define SPR_DMMUCR_PADDR_WIDTH  0x000f0000  /* Physical ADDR Width */

/*

 * Bit definitions for the Instruction MMU Control Register

 *

 */

#define SPR_IMMUCR_P2S  0x0000003e  /* Level 2 Page Size */

#define SPR_IMMUCR_P1S  0x000007c0  /* Level 1 Page Size */

#define SPR_IMMUCR_VADDR_WIDTH  0x0000f800  /* Virtual ADDR Width */

#define SPR_IMMUCR_PADDR_WIDTH  0x000f0000  /* Physical ADDR Width */

/*

 * Bit definitions for the Data TLB Match Register

 *

 */

#define SPR_DTLBMR_V    0x00000001  /* Valid */

#define SPR_DTLBMR_PL1  0x00000002  /* Page Level 1 (if 0 then PL2) */

#define SPR_DTLBMR_CID  0x0000003c  /* Context ID */

#define SPR_DTLBMR_LRU  0x000000c0  /* Least Recently Used */

#define SPR_DTLBMR_VPN  0xfffff000  /* Virtual Page Number */

/*

 * Bit definitions for the Data TLB Translate Register

 *

 */

#define SPR_DTLBTR_CC   0x00000001  /* Cache Coherency */

#define SPR_DTLBTR_CI   0x00000002  /* Cache Inhibit */

#define SPR_DTLBTR_WBC  0x00000004  /* Write-Back Cache */

#define SPR_DTLBTR_WOM  0x00000008  /* Weakly-Ordered Memory */

#define SPR_DTLBTR_A    0x00000010  /* Accessed */

#define SPR_DTLBTR_D    0x00000020  /* Dirty */

#define SPR_DTLBTR_URE  0x00000040  /* User Read Enable */

#define SPR_DTLBTR_UWE  0x00000080  /* User Write Enable */

#define SPR_DTLBTR_SRE  0x00000100  /* Supervisor Read Enable */

#define SPR_DTLBTR_SWE  0x00000200  /* Supervisor Write Enable */

#define SPR_DTLBTR_PPN  0xfffff000  /* Physical Page Number */

#define DTLBTR_NO_LIMIT ( SPR_DTLBTR_URE |  \

                          SPR_DTLBTR_UWE |  \

                          SPR_DTLBTR_SRE |  \

                          SPR_DTLBTR_SWE )

/*

 * Bit definitions for the Instruction TLB Match Register

 *

 */

#define SPR_ITLBMR_V    0x00000001  /* Valid */

#define SPR_ITLBMR_PL1  0x00000002  /* Page Level 1 (if 0 then PL2) */

#define SPR_ITLBMR_CID  0x0000003c  /* Context ID */

#define SPR_ITLBMR_LRU  0x000000c0  /* Least Recently Used */

#define SPR_ITLBMR_VPN  0xfffff000  /* Virtual Page Number */

/*

 * Bit definitions for the Instruction TLB Translate Register

 *

 */

#define SPR_ITLBTR_CC   0x00000001  /* Cache Coherency */

#define SPR_ITLBTR_CI   0x00000002  /* Cache Inhibit */

#define SPR_ITLBTR_WBC  0x00000004  /* Write-Back Cache */

#define SPR_ITLBTR_WOM  0x00000008  /* Weakly-Ordered Memory */

#define SPR_ITLBTR_A    0x00000010  /* Accessed */

#define SPR_ITLBTR_D    0x00000020  /* Dirty */

#define SPR_ITLBTR_SXE  0x00000040  /* User Read Enable */

#define SPR_ITLBTR_UXE  0x00000080  /* User Write Enable */

#define SPR_ITLBTR_PPN  0xfffff000  /* Physical Page Number */

#define ITLBTR_NO_LIMIT (SPR_ITLBTR_SXE | SPR_ITLBTR_UXE)

/*

 * Bit definitions for Data Cache Control register

 *

 */

#define SPR_DCCR_EW     0x000000ff  /* Enable ways */

/*

 * Bit definitions for Insn Cache Control register

 *

 */

#define SPR_ICCR_EW     0x000000ff  /* Enable ways */

/*

 * Bit definitions for Debug Control registers

 *

 */

#define SPR_DCR_DP      0x00000001  /* DVR/DCR present */

#define SPR_DCR_CC      0x0000000e  /* Compare condition */

#define SPR_DCR_SC      0x00000010  /* Signed compare */

#define SPR_DCR_CT      0x000000e0  /* Compare to */

/*

 * Bit definitions for Debug Mode 1 register

 *

 */

#define SPR_DMR1_CW0    0x00000003  /* Chain watchpoint 0 */

#define SPR_DMR1_CW1    0x0000000c  /* Chain watchpoint 1 */

#define SPR_DMR1_CW2    0x00000030  /* Chain watchpoint 2 */

#define SPR_DMR1_CW3    0x000000c0  /* Chain watchpoint 3 */

#define SPR_DMR1_CW4    0x00000300  /* Chain watchpoint 4 */

#define SPR_DMR1_CW5    0x00000c00  /* Chain watchpoint 5 */

#define SPR_DMR1_CW6    0x00003000  /* Chain watchpoint 6 */

#define SPR_DMR1_CW7    0x0000c000  /* Chain watchpoint 7 */

#define SPR_DMR1_CW8    0x00030000  /* Chain watchpoint 8 */

#define SPR_DMR1_CW9    0x000c0000  /* Chain watchpoint 9 */

#define SPR_DMR1_CW10   0x00300000  /* Chain watchpoint 10 */

#define SPR_DMR1_ST     0x00400000  /* Single-step trace*/

#define SPR_DMR1_BT     0x00800000  /* Branch trace */

#define SPR_DMR1_DXFW   0x01000000  /* Disable external force watchpoint */

/*

 * Bit definitions for Debug Mode 2 register

 *

 */

#define SPR_DMR2_WCE0   0x00000001  /* Watchpoint counter 0 enable */

#define SPR_DMR2_WCE1   0x00000002  /* Watchpoint counter 0 enable */

#define SPR_DMR2_AWTC   0x00001ffc  /* Assign watchpoints to counters */

#define SPR_DMR2_WGB    0x00ffe000  /* Watchpoints generating breakpoint */

/*

 * Bit definitions for Debug watchpoint counter registers

 *

 */

#define SPR_DWCR_COUNT  0x0000ffff  /* Count */

#define SPR_DWCR_MATCH  0xffff0000  /* Match */

/*

 * Bit definitions for Debug stop register

 *

 */

#define SPR_DSR_RSTE    0x00000001  /* Reset exception */

#define SPR_DSR_BUSEE   0x00000002  /* Bus error exception */

#define SPR_DSR_DPFE    0x00000004  /* Data Page Fault exception */

#define SPR_DSR_IPFE    0x00000008  /* Insn Page Fault exception */

#define SPR_DSR_LPINTE  0x00000010  /* Low priority interrupt exception */

#define SPR_DSR_AE      0x00000020  /* Alignment exception */

#define SPR_DSR_IIE     0x00000040  /* Illegal Instruction exception */

#define SPR_DSR_HPINTE  0x00000080  /* High priority interrupt exception */

#define SPR_DSR_DME     0x00000100  /* DTLB miss exception */

#define SPR_DSR_IME     0x00000200  /* ITLB miss exception */

#define SPR_DSR_RE      0x00000400  /* Range exception */

#define SPR_DSR_SCE     0x00000800  /* System call exception */

#define SPR_DSR_BE      0x00001000  /* Breakpoint exception */

/*

 * Bit definitions for Debug reason register

 *

 */

#define SPR_DRR_RSTE    0x00000001  /* Reset exception */

#define SPR_DRR_BUSEE   0x00000002  /* Bus error exception */

#define SPR_DRR_DPFE    0x00000004  /* Data Page Fault exception */

#define SPR_DRR_IPFE    0x00000008  /* Insn Page Fault exception */

#define SPR_DRR_LPINTE  0x00000010  /* Low priority interrupt exception */

#define SPR_DRR_AE      0x00000020  /* Alignment exception */

#define SPR_DRR_IIE     0x00000040  /* Illegal Instruction exception */

#define SPR_DRR_HPINTE  0x00000080  /* High priority interrupt exception */

#define SPR_DRR_DME     0x00000100  /* DTLB miss exception */

#define SPR_DRR_IME     0x00000200  /* ITLB miss exception */

#define SPR_DRR_RE      0x00000400  /* Range exception */

#define SPR_DRR_SCE     0x00000800  /* System call exception */

#define SPR_DRR_BE      0x00001000  /* Breakpoint exception */

/*

 * Bit definitions for Performance counters mode registers

 *

 */

#define SPR_PCMR_CP     0x00000001  /* Counter present */

#define SPR_PCMR_UMRA   0x00000002  /* User mode read access */

#define SPR_PCMR_CISM   0x00000004  /* Count in supervisor mode */

#define SPR_PCMR_CIUM   0x00000008  /* Count in user mode */

#define SPR_PCMR_LA     0x00000010  /* Load access event */

#define SPR_PCMR_SA     0x00000020  /* Store access event */

#define SPR_PCMR_IF     0x00000040  /* Instruction fetch event*/

#define SPR_PCMR_DCM    0x00000080  /* Data cache miss event */

#define SPR_PCMR_ICM    0x00000100  /* Insn cache miss event */

#define SPR_PCMR_IFS    0x00000200  /* Insn fetch stall event */

#define SPR_PCMR_LSUS   0x00000400  /* LSU stall event */

#define SPR_PCMR_BS     0x00000800  /* Branch stall event */

#define SPR_PCMR_DTLBM  0x00001000  /* DTLB miss event */

#define SPR_PCMR_ITLBM  0x00002000  /* ITLB miss event */

#define SPR_PCMR_DDS    0x00004000  /* Data dependency stall event */

#define SPR_PCMR_WPE    0x03ff8000  /* Watchpoint events */

/*

 * Bit definitions for the Power management register

 *

 */

#define SPR_PMR_SDF     0x00000001  /* Slow down factor */

#define SPR_PMR_DME     0x00000002  /* Doze mode enable */

#define SPR_PMR_SME     0x00000004  /* Sleep mode enable */

#define SPR_PMR_DCGE    0x00000008  /* Dynamic clock gating enable */

#define SPR_PMR_SUME    0x00000010  /* Suspend mode enable */

/*

 * Bit definitions for PICMR

 *

 */

#define SPR_PICMR_IUM   0xfffffffc  /* Interrupt unmask */

/*

 * Bit definitions for PICPR

 *

 */

#define SPR_PICPR_IPRIO 0xfffffffc  /* Interrupt priority */

/*

 * Bit definitions for PICSR

 *

 */

#define SPR_PICSR_IS    0xffffffff  /* Interrupt status */

/*

 * Bit definitions for Tick Timer Control Register

 *

 */

#define SPR_TTCR_PERIOD 0x0fffffff  /* Time Period */

#define SPR_TTMR_PERIOD SPR_TTCR_PERIOD

#define SPR_TTMR_IP 0x10000000  /* Interrupt Pending */

#define SPR_TTMR_IE 0x20000000  /* Interrupt Enable */

#define SPR_TTMR_RT 0x40000000  /* Restart tick */

#define SPR_TTMR_SR     0x80000000  /* Single run */

#define SPR_TTMR_CR     0xc0000000  /* Continuous run */

#define SPR_TTMR_M      0xc0000000  /* Tick mode */

#endif  /* SPR_DEFS__H */