path: root/lib/Target/AArch64/Utils/AArch64BaseInfo.h

//===-- AArch64BaseInfo.h - Top level definitions for AArch64 ---*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file contains small standalone helper functions and enum definitions for
// the AArch64 target useful for the compiler back-end and the MC libraries.
// As such, it deliberately does not include references to LLVM core
// code gen types, passes, etc..
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_LIB_TARGET_AARCH64_UTILS_AARCH64BASEINFO_H
#define LLVM_LIB_TARGET_AARCH64_UTILS_AARCH64BASEINFO_H

// FIXME: Is it easiest to fix this layering violation by moving the .inc
// #includes from AArch64MCTargetDesc.h to here?
#include "MCTargetDesc/AArch64MCTargetDesc.h" // For AArch64::X0 and friends.
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringSwitch.h"
#include "llvm/Support/ErrorHandling.h"

namespace llvm {

inline static unsigned getWRegFromXReg(unsigned Reg) {
  switch (Reg) {
  case AArch64::X0: return AArch64::W0;
  case AArch64::X1: return AArch64::W1;
  case AArch64::X2: return AArch64::W2;
  case AArch64::X3: return AArch64::W3;
  case AArch64::X4: return AArch64::W4;
  case AArch64::X5: return AArch64::W5;
  case AArch64::X6: return AArch64::W6;
  case AArch64::X7: return AArch64::W7;
  case AArch64::X8: return AArch64::W8;
  case AArch64::X9: return AArch64::W9;
  case AArch64::X10: return AArch64::W10;
  case AArch64::X11: return AArch64::W11;
  case AArch64::X12: return AArch64::W12;
  case AArch64::X13: return AArch64::W13;
  case AArch64::X14: return AArch64::W14;
  case AArch64::X15: return AArch64::W15;
  case AArch64::X16: return AArch64::W16;
  case AArch64::X17: return AArch64::W17;
  case AArch64::X18: return AArch64::W18;
  case AArch64::X19: return AArch64::W19;
  case AArch64::X20: return AArch64::W20;
  case AArch64::X21: return AArch64::W21;
  case AArch64::X22: return AArch64::W22;
  case AArch64::X23: return AArch64::W23;
  case AArch64::X24: return AArch64::W24;
  case AArch64::X25: return AArch64::W25;
  case AArch64::X26: return AArch64::W26;
  case AArch64::X27: return AArch64::W27;
  case AArch64::X28: return AArch64::W28;
  case AArch64::FP: return AArch64::W29;
  case AArch64::LR: return AArch64::W30;
  case AArch64::SP: return AArch64::WSP;
  case AArch64::XZR: return AArch64::WZR;
  }
  // For anything else, return it unchanged.
  return Reg;
}

inline static unsigned getXRegFromWReg(unsigned Reg) {
  switch (Reg) {
  case AArch64::W0: return AArch64::X0;
  case AArch64::W1: return AArch64::X1;
  case AArch64::W2: return AArch64::X2;
  case AArch64::W3: return AArch64::X3;
  case AArch64::W4: return AArch64::X4;
  case AArch64::W5: return AArch64::X5;
  case AArch64::W6: return AArch64::X6;
  case AArch64::W7: return AArch64::X7;
  case AArch64::W8: return AArch64::X8;
  case AArch64::W9: return AArch64::X9;
  case AArch64::W10: return AArch64::X10;
  case AArch64::W11: return AArch64::X11;
  case AArch64::W12: return AArch64::X12;
  case AArch64::W13: return AArch64::X13;
  case AArch64::W14: return AArch64::X14;
  case AArch64::W15: return AArch64::X15;
  case AArch64::W16: return AArch64::X16;
  case AArch64::W17: return AArch64::X17;
  case AArch64::W18: return AArch64::X18;
  case AArch64::W19: return AArch64::X19;
  case AArch64::W20: return AArch64::X20;
  case AArch64::W21: return AArch64::X21;
  case AArch64::W22: return AArch64::X22;
  case AArch64::W23: return AArch64::X23;
  case AArch64::W24: return AArch64::X24;
  case AArch64::W25: return AArch64::X25;
  case AArch64::W26: return AArch64::X26;
  case AArch64::W27: return AArch64::X27;
  case AArch64::W28: return AArch64::X28;
  case AArch64::W29: return AArch64::FP;
  case AArch64::W30: return AArch64::LR;
  case AArch64::WSP: return AArch64::SP;
  case AArch64::WZR: return AArch64::XZR;
  }
  // For anything else, return it unchanged.
  return Reg;
}

static inline unsigned getBRegFromDReg(unsigned Reg) {
  switch (Reg) {
  case AArch64::D0:  return AArch64::B0;
  case AArch64::D1:  return AArch64::B1;
  case AArch64::D2:  return AArch64::B2;
  case AArch64::D3:  return AArch64::B3;
  case AArch64::D4:  return AArch64::B4;
  case AArch64::D5:  return AArch64::B5;
  case AArch64::D6:  return AArch64::B6;
  case AArch64::D7:  return AArch64::B7;
  case AArch64::D8:  return AArch64::B8;
  case AArch64::D9:  return AArch64::B9;
  case AArch64::D10: return AArch64::B10;
  case AArch64::D11: return AArch64::B11;
  case AArch64::D12: return AArch64::B12;
  case AArch64::D13: return AArch64::B13;
  case AArch64::D14: return AArch64::B14;
  case AArch64::D15: return AArch64::B15;
  case AArch64::D16: return AArch64::B16;
  case AArch64::D17: return AArch64::B17;
  case AArch64::D18: return AArch64::B18;
  case AArch64::D19: return AArch64::B19;
  case AArch64::D20: return AArch64::B20;
  case AArch64::D21: return AArch64::B21;
  case AArch64::D22: return AArch64::B22;
  case AArch64::D23: return AArch64::B23;
  case AArch64::D24: return AArch64::B24;
  case AArch64::D25: return AArch64::B25;
  case AArch64::D26: return AArch64::B26;
  case AArch64::D27: return AArch64::B27;
  case AArch64::D28: return AArch64::B28;
  case AArch64::D29: return AArch64::B29;
  case AArch64::D30: return AArch64::B30;
  case AArch64::D31: return AArch64::B31;
  }
  // For anything else, return it unchanged.
  return Reg;
}


static inline unsigned getDRegFromBReg(unsigned Reg) {
  switch (Reg) {
  case AArch64::B0:  return AArch64::D0;
  case AArch64::B1:  return AArch64::D1;
  case AArch64::B2:  return AArch64::D2;
  case AArch64::B3:  return AArch64::D3;
  case AArch64::B4:  return AArch64::D4;
  case AArch64::B5:  return AArch64::D5;
  case AArch64::B6:  return AArch64::D6;
  case AArch64::B7:  return AArch64::D7;
  case AArch64::B8:  return AArch64::D8;
  case AArch64::B9:  return AArch64::D9;
  case AArch64::B10: return AArch64::D10;
  case AArch64::B11: return AArch64::D11;
  case AArch64::B12: return AArch64::D12;
  case AArch64::B13: return AArch64::D13;
  case AArch64::B14: return AArch64::D14;
  case AArch64::B15: return AArch64::D15;
  case AArch64::B16: return AArch64::D16;
  case AArch64::B17: return AArch64::D17;
  case AArch64::B18: return AArch64::D18;
  case AArch64::B19: return AArch64::D19;
  case AArch64::B20: return AArch64::D20;
  case AArch64::B21: return AArch64::D21;
  case AArch64::B22: return AArch64::D22;
  case AArch64::B23: return AArch64::D23;
  case AArch64::B24: return AArch64::D24;
  case AArch64::B25: return AArch64::D25;
  case AArch64::B26: return AArch64::D26;
  case AArch64::B27: return AArch64::D27;
  case AArch64::B28: return AArch64::D28;
  case AArch64::B29: return AArch64::D29;
  case AArch64::B30: return AArch64::D30;
  case AArch64::B31: return AArch64::D31;
  }
  // For anything else, return it unchanged.
  return Reg;
}

namespace AArch64CC {

// The CondCodes constants map directly to the 4-bit encoding of the condition
// field for predicated instructions.
enum CondCode {  // Meaning (integer)          Meaning (floating-point)
  EQ = 0x0,      // Equal                      Equal
  NE = 0x1,      // Not equal                  Not equal, or unordered
  HS = 0x2,      // Unsigned higher or same    >, ==, or unordered
  LO = 0x3,      // Unsigned lower             Less than
  MI = 0x4,      // Minus, negative            Less than
  PL = 0x5,      // Plus, positive or zero     >, ==, or unordered
  VS = 0x6,      // Overflow                   Unordered
  VC = 0x7,      // No overflow                Not unordered
  HI = 0x8,      // Unsigned higher            Greater than, or unordered
  LS = 0x9,      // Unsigned lower or same     Less than or equal
  GE = 0xa,      // Greater than or equal      Greater than or equal
  LT = 0xb,      // Less than                  Less than, or unordered
  GT = 0xc,      // Greater than               Greater than
  LE = 0xd,      // Less than or equal         <, ==, or unordered
  AL = 0xe,      // Always (unconditional)     Always (unconditional)
  NV = 0xf,      // Always (unconditional)     Always (unconditional)
  // Note the NV exists purely to disassemble 0b1111. Execution is "always".
  Invalid
};

inline static const char *getCondCodeName(CondCode Code) {
  switch (Code) {
  default: llvm_unreachable("Unknown condition code");
  case EQ:  return "eq";
  case NE:  return "ne";
  case HS:  return "hs";
  case LO:  return "lo";
  case MI:  return "mi";
  case PL:  return "pl";
  case VS:  return "vs";
  case VC:  return "vc";
  case HI:  return "hi";
  case LS:  return "ls";
  case GE:  return "ge";
  case LT:  return "lt";
  case GT:  return "gt";
  case LE:  return "le";
  case AL:  return "al";
  case NV:  return "nv";
  }
}

inline static CondCode getInvertedCondCode(CondCode Code) {
  // To reverse a condition it's necessary to only invert the low bit:

  return static_cast<CondCode>(static_cast<unsigned>(Code) ^ 0x1);
}

/// Given a condition code, return NZCV flags that would satisfy that condition.
/// The flag bits are in the format expected by the ccmp instructions.
/// Note that many different flag settings can satisfy a given condition code,
/// this function just returns one of them.
inline static unsigned getNZCVToSatisfyCondCode(CondCode Code) {
  // NZCV flags encoded as expected by ccmp instructions, ARMv8 ISA 5.5.7.
  enum { N = 8, Z = 4, C = 2, V = 1 };
  switch (Code) {
  default: llvm_unreachable("Unknown condition code");
  case EQ: return Z; // Z == 1
  case NE: return 0; // Z == 0
  case HS: return C; // C == 1
  case LO: return 0; // C == 0
  case MI: return N; // N == 1
  case PL: return 0; // N == 0
  case VS: return V; // V == 1
  case VC: return 0; // V == 0
  case HI: return C; // C == 1 && Z == 0
  case LS: return 0; // C == 0 || Z == 1
  case GE: return 0; // N == V
  case LT: return N; // N != V
  case GT: return 0; // Z == 0 && N == V
  case LE: return Z; // Z == 1 || N != V
  }
}
} // end namespace AArch64CC

/// Instances of this class can perform bidirectional mapping from random
/// identifier strings to operand encodings. For example "MSR" takes a named
/// system-register which must be encoded somehow and decoded for printing. This
/// central location means that the information for those transformations is not
/// duplicated and remains in sync.
///
/// FIXME: currently the algorithm is a completely unoptimised linear
/// search. Obviously this could be improved, but we would probably want to work
/// out just how often these instructions are emitted before working on it. It
/// might even be optimal to just reorder the tables for the common instructions
/// rather than changing the algorithm.
struct AArch64NamedImmMapper {
  struct Mapping {
    const char *Name;
    uint32_t Value;
  };

  template<int N>
  AArch64NamedImmMapper(const Mapping (&Mappings)[N], uint32_t TooBigImm)
    : Mappings(&Mappings[0]), NumMappings(N), TooBigImm(TooBigImm) {}

  StringRef toString(uint32_t Value, bool &Valid) const;
  uint32_t fromString(StringRef Name, bool &Valid) const;

  /// Many of the instructions allow an alternative assembly form consisting of
  /// a simple immediate. Currently the only valid forms are ranges [0, N) where
  /// N being 0 indicates no immediate syntax-form is allowed.
  bool validImm(uint32_t Value) const;
protected:
  const Mapping *Mappings;
  size_t NumMappings;
  uint32_t TooBigImm;
};

namespace AArch64AT {
  enum ATValues {
    Invalid = -1,    // Op0 Op1  CRn   CRm   Op2
    S1E1R = 0x43c0,  // 01  000  0111  1000  000
    S1E2R = 0x63c0,  // 01  100  0111  1000  000
    S1E3R = 0x73c0,  // 01  110  0111  1000  000
    S1E1W = 0x43c1,  // 01  000  0111  1000  001
    S1E2W = 0x63c1,  // 01  100  0111  1000  001
    S1E3W = 0x73c1,  // 01  110  0111  1000  001
    S1E0R = 0x43c2,  // 01  000  0111  1000  010
    S1E0W = 0x43c3,  // 01  000  0111  1000  011
    S12E1R = 0x63c4, // 01  100  0111  1000  100
    S12E1W = 0x63c5, // 01  100  0111  1000  101
    S12E0R = 0x63c6, // 01  100  0111  1000  110
    S12E0W = 0x63c7  // 01  100  0111  1000  111
  };

  struct ATMapper : AArch64NamedImmMapper {
    const static Mapping ATMappings[];

    ATMapper();
  };

}
namespace AArch64DB {
  enum DBValues {
    Invalid = -1,
    OSHLD = 0x1,
    OSHST = 0x2,
    OSH =   0x3,
    NSHLD = 0x5,
    NSHST = 0x6,
    NSH =   0x7,
    ISHLD = 0x9,
    ISHST = 0xa,
    ISH =   0xb,
    LD =    0xd,
    ST =    0xe,
    SY =    0xf
  };

  struct DBarrierMapper : AArch64NamedImmMapper {
    const static Mapping DBarrierMappings[];

    DBarrierMapper();
  };
}

namespace  AArch64DC {
  enum DCValues {
    Invalid = -1,   // Op1  CRn   CRm   Op2
    ZVA   = 0x5ba1, // 01  011  0111  0100  001
    IVAC  = 0x43b1, // 01  000  0111  0110  001
    ISW   = 0x43b2, // 01  000  0111  0110  010
    CVAC  = 0x5bd1, // 01  011  0111  1010  001
    CSW   = 0x43d2, // 01  000  0111  1010  010
    CVAU  = 0x5bd9, // 01  011  0111  1011  001
    CIVAC = 0x5bf1, // 01  011  0111  1110  001
    CISW  = 0x43f2  // 01  000  0111  1110  010
  };

  struct DCMapper : AArch64NamedImmMapper {
    const static Mapping DCMappings[];

    DCMapper();
  };

}

namespace  AArch64IC {
  enum ICValues {
    Invalid = -1,     // Op1  CRn   CRm   Op2
    IALLUIS = 0x0388, // 000  0111  0001  000
    IALLU = 0x03a8,   // 000  0111  0101  000
    IVAU = 0x1ba9     // 011  0111  0101  001
  };


  struct ICMapper : AArch64NamedImmMapper {
    const static Mapping ICMappings[];

    ICMapper();
  };

  static inline bool NeedsRegister(ICValues Val) {
    return Val == IVAU;
  }
}

namespace  AArch64ISB {
  enum ISBValues {
    Invalid = -1,
    SY = 0xf
  };
  struct ISBMapper : AArch64NamedImmMapper {
    const static Mapping ISBMappings[];

    ISBMapper();
  };
}

namespace AArch64PRFM {
  enum PRFMValues {
    Invalid = -1,
    PLDL1KEEP = 0x00,
    PLDL1STRM = 0x01,
    PLDL2KEEP = 0x02,
    PLDL2STRM = 0x03,
    PLDL3KEEP = 0x04,
    PLDL3STRM = 0x05,
    PLIL1KEEP = 0x08,
    PLIL1STRM = 0x09,
    PLIL2KEEP = 0x0a,
    PLIL2STRM = 0x0b,
    PLIL3KEEP = 0x0c,
    PLIL3STRM = 0x0d,
    PSTL1KEEP = 0x10,
    PSTL1STRM = 0x11,
    PSTL2KEEP = 0x12,
    PSTL2STRM = 0x13,
    PSTL3KEEP = 0x14,
    PSTL3STRM = 0x15
  };

  struct PRFMMapper : AArch64NamedImmMapper {
    const static Mapping PRFMMappings[];

    PRFMMapper();
  };
}

namespace AArch64PState {
  enum PStateValues {
    Invalid = -1,
    SPSel = 0x05,
    DAIFSet = 0x1e,
    DAIFClr = 0x1f
  };

  struct PStateMapper : AArch64NamedImmMapper {
    const static Mapping PStateMappings[];

    PStateMapper();
  };

}

namespace AArch64SE {
    enum ShiftExtSpecifiers {
        Invalid = -1,
        LSL,
        MSL,
        LSR,
        ASR,
        ROR,

        UXTB,
        UXTH,
        UXTW,
        UXTX,

        SXTB,
        SXTH,
        SXTW,
        SXTX
    };
}

namespace AArch64Layout {
    enum VectorLayout {
        Invalid = -1,
        VL_8B,
        VL_4H,
        VL_2S,
        VL_1D,

        VL_16B,
        VL_8H,
        VL_4S,
        VL_2D,

        // Bare layout for the 128-bit vector
        // (only show ".b", ".h", ".s", ".d" without vector number)
        VL_B,
        VL_H,
        VL_S,
        VL_D
    };
}

inline static const char *
AArch64VectorLayoutToString(AArch64Layout::VectorLayout Layout) {
  switch (Layout) {
  case AArch64Layout::VL_8B:  return ".8b";
  case AArch64Layout::VL_4H:  return ".4h";
  case AArch64Layout::VL_2S:  return ".2s";
  case AArch64Layout::VL_1D:  return ".1d";
  case AArch64Layout::VL_16B:  return ".16b";
  case AArch64Layout::VL_8H:  return ".8h";
  case AArch64Layout::VL_4S:  return ".4s";
  case AArch64Layout::VL_2D:  return ".2d";
  case AArch64Layout::VL_B:  return ".b";
  case AArch64Layout::VL_H:  return ".h";
  case AArch64Layout::VL_S:  return ".s";
  case AArch64Layout::VL_D:  return ".d";
  default: llvm_unreachable("Unknown Vector Layout");
  }
}

inline static AArch64Layout::VectorLayout
AArch64StringToVectorLayout(StringRef LayoutStr) {
  return StringSwitch<AArch64Layout::VectorLayout>(LayoutStr)
             .Case(".8b", AArch64Layout::VL_8B)
             .Case(".4h", AArch64Layout::VL_4H)
             .Case(".2s", AArch64Layout::VL_2S)
             .Case(".1d", AArch64Layout::VL_1D)
             .Case(".16b", AArch64Layout::VL_16B)
             .Case(".8h", AArch64Layout::VL_8H)
             .Case(".4s", AArch64Layout::VL_4S)
             .Case(".2d", AArch64Layout::VL_2D)
             .Case(".b", AArch64Layout::VL_B)
             .Case(".h", AArch64Layout::VL_H)
             .Case(".s", AArch64Layout::VL_S)
             .Case(".d", AArch64Layout::VL_D)
             .Default(AArch64Layout::Invalid);
}

namespace AArch64SysReg {
  enum SysRegROValues {
    MDCCSR_EL0        = 0x9808, // 10  011  0000  0001  000
    DBGDTRRX_EL0      = 0x9828, // 10  011  0000  0101  000
    MDRAR_EL1         = 0x8080, // 10  000  0001  0000  000
    OSLSR_EL1         = 0x808c, // 10  000  0001  0001  100
    DBGAUTHSTATUS_EL1 = 0x83f6, // 10  000  0111  1110  110
    PMCEID0_EL0       = 0xdce6, // 11  011  1001  1100  110
    PMCEID1_EL0       = 0xdce7, // 11  011  1001  1100  111
    MIDR_EL1          = 0xc000, // 11  000  0000  0000  000
    CCSIDR_EL1        = 0xc800, // 11  001  0000  0000  000
    CLIDR_EL1         = 0xc801, // 11  001  0000  0000  001
    CTR_EL0           = 0xd801, // 11  011  0000  0000  001
    MPIDR_EL1         = 0xc005, // 11  000  0000  0000  101
    REVIDR_EL1        = 0xc006, // 11  000  0000  0000  110
    AIDR_EL1          = 0xc807, // 11  001  0000  0000  111
    DCZID_EL0         = 0xd807, // 11  011  0000  0000  111
    ID_PFR0_EL1       = 0xc008, // 11  000  0000  0001  000
    ID_PFR1_EL1       = 0xc009, // 11  000  0000  0001  001
    ID_DFR0_EL1       = 0xc00a, // 11  000  0000  0001  010
    ID_AFR0_EL1       = 0xc00b, // 11  000  0000  0001  011
    ID_MMFR0_EL1      = 0xc00c, // 11  000  0000  0001  100
    ID_MMFR1_EL1      = 0xc00d, // 11  000  0000  0001  101
    ID_MMFR2_EL1      = 0xc00e, // 11  000  0000  0001  110
    ID_MMFR3_EL1      = 0xc00f, // 11  000  0000  0001  111
    ID_ISAR0_EL1      = 0xc010, // 11  000  0000  0010  000
    ID_ISAR1_EL1      = 0xc011, // 11  000  0000  0010  001
    ID_ISAR2_EL1      = 0xc012, // 11  000  0000  0010  010
    ID_ISAR3_EL1      = 0xc013, // 11  000  0000  0010  011
    ID_ISAR4_EL1      = 0xc014, // 11  000  0000  0010  100
    ID_ISAR5_EL1      = 0xc015, // 11  000  0000  0010  101
    ID_A64PFR0_EL1    = 0xc020, // 11  000  0000  0100  000
    ID_A64PFR1_EL1    = 0xc021, // 11  000  0000  0100  001
    ID_A64DFR0_EL1    = 0xc028, // 11  000  0000  0101  000
    ID_A64DFR1_EL1    = 0xc029, // 11  000  0000  0101  001
    ID_A64AFR0_EL1    = 0xc02c, // 11  000  0000  0101  100
    ID_A64AFR1_EL1    = 0xc02d, // 11  000  0000  0101  101
    ID_A64ISAR0_EL1   = 0xc030, // 11  000  0000  0110  000
    ID_A64ISAR1_EL1   = 0xc031, // 11  000  0000  0110  001
    ID_A64MMFR0_EL1   = 0xc038, // 11  000  0000  0111  000
    ID_A64MMFR1_EL1   = 0xc039, // 11  000  0000  0111  001
    MVFR0_EL1         = 0xc018, // 11  000  0000  0011  000
    MVFR1_EL1         = 0xc019, // 11  000  0000  0011  001
    MVFR2_EL1         = 0xc01a, // 11  000  0000  0011  010
    RVBAR_EL1         = 0xc601, // 11  000  1100  0000  001
    RVBAR_EL2         = 0xe601, // 11  100  1100  0000  001
    RVBAR_EL3         = 0xf601, // 11  110  1100  0000  001
    ISR_EL1           = 0xc608, // 11  000  1100  0001  000
    CNTPCT_EL0        = 0xdf01, // 11  011  1110  0000  001
    CNTVCT_EL0        = 0xdf02,  // 11  011  1110  0000  010

    // Trace registers
    TRCSTATR          = 0x8818, // 10  001  0000  0011  000
    TRCIDR8           = 0x8806, // 10  001  0000  0000  110
    TRCIDR9           = 0x880e, // 10  001  0000  0001  110
    TRCIDR10          = 0x8816, // 10  001  0000  0010  110
    TRCIDR11          = 0x881e, // 10  001  0000  0011  110
    TRCIDR12          = 0x8826, // 10  001  0000  0100  110
    TRCIDR13          = 0x882e, // 10  001  0000  0101  110
    TRCIDR0           = 0x8847, // 10  001  0000  1000  111
    TRCIDR1           = 0x884f, // 10  001  0000  1001  111
    TRCIDR2           = 0x8857, // 10  001  0000  1010  111
    TRCIDR3           = 0x885f, // 10  001  0000  1011  111
    TRCIDR4           = 0x8867, // 10  001  0000  1100  111
    TRCIDR5           = 0x886f, // 10  001  0000  1101  111
    TRCIDR6           = 0x8877, // 10  001  0000  1110  111
    TRCIDR7           = 0x887f, // 10  001  0000  1111  111
    TRCOSLSR          = 0x888c, // 10  001  0001  0001  100
    TRCPDSR           = 0x88ac, // 10  001  0001  0101  100
    TRCDEVAFF0        = 0x8bd6, // 10  001  0111  1010  110
    TRCDEVAFF1        = 0x8bde, // 10  001  0111  1011  110
    TRCLSR            = 0x8bee, // 10  001  0111  1101  110
    TRCAUTHSTATUS     = 0x8bf6, // 10  001  0111  1110  110
    TRCDEVARCH        = 0x8bfe, // 10  001  0111  1111  110
    TRCDEVID          = 0x8b97, // 10  001  0111  0010  111
    TRCDEVTYPE        = 0x8b9f, // 10  001  0111  0011  111
    TRCPIDR4          = 0x8ba7, // 10  001  0111  0100  111
    TRCPIDR5          = 0x8baf, // 10  001  0111  0101  111
    TRCPIDR6          = 0x8bb7, // 10  001  0111  0110  111
    TRCPIDR7          = 0x8bbf, // 10  001  0111  0111  111
    TRCPIDR0          = 0x8bc7, // 10  001  0111  1000  111
    TRCPIDR1          = 0x8bcf, // 10  001  0111  1001  111
    TRCPIDR2          = 0x8bd7, // 10  001  0111  1010  111
    TRCPIDR3          = 0x8bdf, // 10  001  0111  1011  111
    TRCCIDR0          = 0x8be7, // 10  001  0111  1100  111
    TRCCIDR1          = 0x8bef, // 10  001  0111  1101  111
    TRCCIDR2          = 0x8bf7, // 10  001  0111  1110  111
    TRCCIDR3          = 0x8bff, // 10  001  0111  1111  111

    // GICv3 registers
    ICC_IAR1_EL1      = 0xc660, // 11  000  1100  1100  000
    ICC_IAR0_EL1      = 0xc640, // 11  000  1100  1000  000
    ICC_HPPIR1_EL1    = 0xc662, // 11  000  1100  1100  010
    ICC_HPPIR0_EL1    = 0xc642, // 11  000  1100  1000  010
    ICC_RPR_EL1       = 0xc65b, // 11  000  1100  1011  011
    ICH_VTR_EL2       = 0xe659, // 11  100  1100  1011  001
    ICH_EISR_EL2      = 0xe65b, // 11  100  1100  1011  011
    ICH_ELSR_EL2      = 0xe65d  // 11  100  1100  1011  101
  };

  enum SysRegWOValues {
    DBGDTRTX_EL0      = 0x9828, // 10  011  0000  0101  000
    OSLAR_EL1         = 0x8084, // 10  000  0001  0000  100
    PMSWINC_EL0       = 0xdce4,  // 11  011  1001  1100  100

    // Trace Registers
    TRCOSLAR          = 0x8884, // 10  001  0001  0000  100
    TRCLAR            = 0x8be6, // 10  001  0111  1100  110

    // GICv3 registers
    ICC_EOIR1_EL1     = 0xc661, // 11  000  1100  1100  001
    ICC_EOIR0_EL1     = 0xc641, // 11  000  1100  1000  001
    ICC_DIR_EL1       = 0xc659, // 11  000  1100  1011  001
    ICC_SGI1R_EL1     = 0xc65d, // 11  000  1100  1011  101
    ICC_ASGI1R_EL1    = 0xc65e, // 11  000  1100  1011  110
    ICC_SGI0R_EL1     = 0xc65f  // 11  000  1100  1011  111
  };

  enum SysRegValues {
    Invalid = -1,               // Op0 Op1  CRn   CRm   Op2
    OSDTRRX_EL1       = 0x8002, // 10  000  0000  0000  010
    OSDTRTX_EL1       = 0x801a, // 10  000  0000  0011  010
    TEECR32_EL1       = 0x9000, // 10  010  0000  0000  000
    MDCCINT_EL1       = 0x8010, // 10  000  0000  0010  000
    MDSCR_EL1         = 0x8012, // 10  000  0000  0010  010
    DBGDTR_EL0        = 0x9820, // 10  011  0000  0100  000
    OSECCR_EL1        = 0x8032, // 10  000  0000  0110  010
    DBGVCR32_EL2      = 0xa038, // 10  100  0000  0111  000
    DBGBVR0_EL1       = 0x8004, // 10  000  0000  0000  100
    DBGBVR1_EL1       = 0x800c, // 10  000  0000  0001  100
    DBGBVR2_EL1       = 0x8014, // 10  000  0000  0010  100
    DBGBVR3_EL1       = 0x801c, // 10  000  0000  0011  100
    DBGBVR4_EL1       = 0x8024, // 10  000  0000  0100  100
    DBGBVR5_EL1       = 0x802c, // 10  000  0000  0101  100
    DBGBVR6_EL1       = 0x8034, // 10  000  0000  0110  100
    DBGBVR7_EL1       = 0x803c, // 10  000  0000  0111  100
    DBGBVR8_EL1       = 0x8044, // 10  000  0000  1000  100
    DBGBVR9_EL1       = 0x804c, // 10  000  0000  1001  100
    DBGBVR10_EL1      = 0x8054, // 10  000  0000  1010  100
    DBGBVR11_EL1      = 0x805c, // 10  000  0000  1011  100
    DBGBVR12_EL1      = 0x8064, // 10  000  0000  1100  100
    DBGBVR13_EL1      = 0x806c, // 10  000  0000  1101  100
    DBGBVR14_EL1      = 0x8074, // 10  000  0000  1110  100
    DBGBVR15_EL1      = 0x807c, // 10  000  0000  1111  100
    DBGBCR0_EL1       = 0x8005, // 10  000  0000  0000  101
    DBGBCR1_EL1       = 0x800d, // 10  000  0000  0001  101
    DBGBCR2_EL1       = 0x8015, // 10  000  0000  0010  101
    DBGBCR3_EL1       = 0x801d, // 10  000  0000  0011  101
    DBGBCR4_EL1       = 0x8025, // 10  000  0000  0100  101
    DBGBCR5_EL1       = 0x802d, // 10  000  0000  0101  101
    DBGBCR6_EL1       = 0x8035, // 10  000  0000  0110  101
    DBGBCR7_EL1       = 0x803d, // 10  000  0000  0111  101
    DBGBCR8_EL1       = 0x8045, // 10  000  0000  1000  101
    DBGBCR9_EL1       = 0x804d, // 10  000  0000  1001  101
    DBGBCR10_EL1      = 0x8055, // 10  000  0000  1010  101
    DBGBCR11_EL1      = 0x805d, // 10  000  0000  1011  101
    DBGBCR12_EL1      = 0x8065, // 10  000  0000  1100  101
    DBGBCR13_EL1      = 0x806d, // 10  000  0000  1101  101
    DBGBCR14_EL1      = 0x8075, // 10  000  0000  1110  101
    DBGBCR15_EL1      = 0x807d, // 10  000  0000  1111  101
    DBGWVR0_EL1       = 0x8006, // 10  000  0000  0000  110
    DBGWVR1_EL1       = 0x800e, // 10  000  0000  0001  110
    DBGWVR2_EL1       = 0x8016, // 10  000  0000  0010  110
    DBGWVR3_EL1       = 0x801e, // 10  000  0000  0011  110
    DBGWVR4_EL1       = 0x8026, // 10  000  0000  0100  110
    DBGWVR5_EL1       = 0x802e, // 10  000  0000  0101  110
    DBGWVR6_EL1       = 0x8036, // 10  000  0000  0110  110
    DBGWVR7_EL1       = 0x803e, // 10  000  0000  0111  110
    DBGWVR8_EL1       = 0x8046, // 10  000  0000  1000  110
    DBGWVR9_EL1       = 0x804e, // 10  000  0000  1001  110
    DBGWVR10_EL1      = 0x8056, // 10  000  0000  1010  110
    DBGWVR11_EL1      = 0x805e, // 10  000  0000  1011  110
    DBGWVR12_EL1      = 0x8066, // 10  000  0000  1100  110
    DBGWVR13_EL1      = 0x806e, // 10  000  0000  1101  110
    DBGWVR14_EL1      = 0x8076, // 10  000  0000  1110  110
    DBGWVR15_EL1      = 0x807e, // 10  000  0000  1111  110
    DBGWCR0_EL1       = 0x8007, // 10  000  0000  0000  111
    DBGWCR1_EL1       = 0x800f, // 10  000  0000  0001  111
    DBGWCR2_EL1       = 0x8017, // 10  000  0000  0010  111
    DBGWCR3_EL1       = 0x801f, // 10  000  0000  0011  111
    DBGWCR4_EL1       = 0x8027, // 10  000  0000  0100  111
    DBGWCR5_EL1       = 0x802f, // 10  000  0000  0101  111
    DBGWCR6_EL1       = 0x8037, // 10  000  0000  0110  111
    DBGWCR7_EL1       = 0x803f, // 10  000  0000  0111  111
    DBGWCR8_EL1       = 0x8047, // 10  000  0000  1000  111
    DBGWCR9_EL1       = 0x804f, // 10  000  0000  1001  111
    DBGWCR10_EL1      = 0x8057, // 10  000  0000  1010  111
    DBGWCR11_EL1      = 0x805f, // 10  000  0000  1011  111
    DBGWCR12_EL1      = 0x8067, // 10  000  0000  1100  111
    DBGWCR13_EL1      = 0x806f, // 10  000  0000  1101  111
    DBGWCR14_EL1      = 0x8077, // 10  000  0000  1110  111
    DBGWCR15_EL1      = 0x807f, // 10  000  0000  1111  111
    TEEHBR32_EL1      = 0x9080, // 10  010  0001  0000  000
    OSDLR_EL1         = 0x809c, // 10  000  0001  0011  100
    DBGPRCR_EL1       = 0x80a4, // 10  000  0001  0100  100
    DBGCLAIMSET_EL1   = 0x83c6, // 10  000  0111  1000  110
    DBGCLAIMCLR_EL1   = 0x83ce, // 10  000  0111  1001  110
    CSSELR_EL1        = 0xd000, // 11  010  0000  0000  000
    VPIDR_EL2         = 0xe000, // 11  100  0000  0000  000
    VMPIDR_EL2        = 0xe005, // 11  100  0000  0000  101
    CPACR_EL1         = 0xc082, // 11  000  0001  0000  010
    SCTLR_EL1         = 0xc080, // 11  000  0001  0000  000
    SCTLR_EL2         = 0xe080, // 11  100  0001  0000  000
    SCTLR_EL3         = 0xf080, // 11  110  0001  0000  000
    ACTLR_EL1         = 0xc081, // 11  000  0001  0000  001
    ACTLR_EL2         = 0xe081, // 11  100  0001  0000  001
    ACTLR_EL3         = 0xf081, // 11  110  0001  0000  001
    HCR_EL2           = 0xe088, // 11  100  0001  0001  000
    SCR_EL3           = 0xf088, // 11  110  0001  0001  000
    MDCR_EL2          = 0xe089, // 11  100  0001  0001  001
    SDER32_EL3        = 0xf089, // 11  110  0001  0001  001
    CPTR_EL2          = 0xe08a, // 11  100  0001  0001  010
    CPTR_EL3          = 0xf08a, // 11  110  0001  0001  010
    HSTR_EL2          = 0xe08b, // 11  100  0001  0001  011
    HACR_EL2          = 0xe08f, // 11  100  0001  0001  111
    MDCR_EL3          = 0xf099, // 11  110  0001  0011  001
    TTBR0_EL1         = 0xc100, // 11  000  0010  0000  000
    TTBR0_EL2         = 0xe100, // 11  100  0010  0000  000
    TTBR0_EL3         = 0xf100, // 11  110  0010  0000  000
    TTBR1_EL1         = 0xc101, // 11  000  0010  0000  001
    TCR_EL1           = 0xc102, // 11  000  0010  0000  010
    TCR_EL2           = 0xe102, // 11  100  0010  0000  010
    TCR_EL3           = 0xf102, // 11  110  0010  0000  010
    VTTBR_EL2         = 0xe108, // 11  100  0010  0001  000
    VTCR_EL2          = 0xe10a, // 11  100  0010  0001  010
    DACR32_EL2        = 0xe180, // 11  100  0011  0000  000
    SPSR_EL1          = 0xc200, // 11  000  0100  0000  000
    SPSR_EL2          = 0xe200, // 11  100  0100  0000  000
    SPSR_EL3          = 0xf200, // 11  110  0100  0000  000
    ELR_EL1           = 0xc201, // 11  000  0100  0000  001
    ELR_EL2           = 0xe201, // 11  100  0100  0000  001
    ELR_EL3           = 0xf201, // 11  110  0100  0000  001
    SP_EL0            = 0xc208, // 11  000  0100  0001  000
    SP_EL1            = 0xe208, // 11  100  0100  0001  000
    SP_EL2            = 0xf208, // 11  110  0100  0001  000
    SPSel             = 0xc210, // 11  000  0100  0010  000
    NZCV              = 0xda10, // 11  011  0100  0010  000
    DAIF              = 0xda11, // 11  011  0100  0010  001
    CurrentEL         = 0xc212, // 11  000  0100  0010  010
    SPSR_irq          = 0xe218, // 11  100  0100  0011  000
    SPSR_abt          = 0xe219, // 11  100  0100  0011  001
    SPSR_und          = 0xe21a, // 11  100  0100  0011  010
    SPSR_fiq          = 0xe21b, // 11  100  0100  0011  011
    FPCR              = 0xda20, // 11  011  0100  0100  000
    FPSR              = 0xda21, // 11  011  0100  0100  001
    DSPSR_EL0         = 0xda28, // 11  011  0100  0101  000
    DLR_EL0           = 0xda29, // 11  011  0100  0101  001
    IFSR32_EL2        = 0xe281, // 11  100  0101  0000  001
    AFSR0_EL1         = 0xc288, // 11  000  0101  0001  000
    AFSR0_EL2         = 0xe288, // 11  100  0101  0001  000
    AFSR0_EL3         = 0xf288, // 11  110  0101  0001  000
    AFSR1_EL1         = 0xc289, // 11  000  0101  0001  001
    AFSR1_EL2         = 0xe289, // 11  100  0101  0001  001
    AFSR1_EL3         = 0xf289, // 11  110  0101  0001  001
    ESR_EL1           = 0xc290, // 11  000  0101  0010  000
    ESR_EL2           = 0xe290, // 11  100  0101  0010  000
    ESR_EL3           = 0xf290, // 11  110  0101  0010  000
    FPEXC32_EL2       = 0xe298, // 11  100  0101  0011  000
    FAR_EL1           = 0xc300, // 11  000  0110  0000  000
    FAR_EL2           = 0xe300, // 11  100  0110  0000  000
    FAR_EL3           = 0xf300, // 11  110  0110  0000  000
    HPFAR_EL2         = 0xe304, // 11  100  0110  0000  100
    PAR_EL1           = 0xc3a0, // 11  000  0111  0100  000
    PMCR_EL0          = 0xdce0, // 11  011  1001  1100  000
    PMCNTENSET_EL0    = 0xdce1, // 11  011  1001  1100  001
    PMCNTENCLR_EL0    = 0xdce2, // 11  011  1001  1100  010
    PMOVSCLR_EL0      = 0xdce3, // 11  011  1001  1100  011
    PMSELR_EL0        = 0xdce5, // 11  011  1001  1100  101
    PMCCNTR_EL0       = 0xdce8, // 11  011  1001  1101  000
    PMXEVTYPER_EL0    = 0xdce9, // 11  011  1001  1101  001
    PMXEVCNTR_EL0     = 0xdcea, // 11  011  1001  1101  010
    PMUSERENR_EL0     = 0xdcf0, // 11  011  1001  1110  000
    PMINTENSET_EL1    = 0xc4f1, // 11  000  1001  1110  001
    PMINTENCLR_EL1    = 0xc4f2, // 11  000  1001  1110  010
    PMOVSSET_EL0      = 0xdcf3, // 11  011  1001  1110  011
    MAIR_EL1          = 0xc510, // 11  000  1010  0010  000
    MAIR_EL2          = 0xe510, // 11  100  1010  0010  000
    MAIR_EL3          = 0xf510, // 11  110  1010  0010  000
    AMAIR_EL1         = 0xc518, // 11  000  1010  0011  000
    AMAIR_EL2         = 0xe518, // 11  100  1010  0011  000
    AMAIR_EL3         = 0xf518, // 11  110  1010  0011  000
    VBAR_EL1          = 0xc600, // 11  000  1100  0000  000
    VBAR_EL2          = 0xe600, // 11  100  1100  0000  000
    VBAR_EL3          = 0xf600, // 11  110  1100  0000  000
    RMR_EL1           = 0xc602, // 11  000  1100  0000  010
    RMR_EL2           = 0xe602, // 11  100  1100  0000  010
    RMR_EL3           = 0xf602, // 11  110  1100  0000  010
    CONTEXTIDR_EL1    = 0xc681, // 11  000  1101  0000  001
    TPIDR_EL0         = 0xde82, // 11  011  1101  0000  010
    TPIDR_EL2         = 0xe682, // 11  100  1101  0000  010
    TPIDR_EL3         = 0xf682, // 11  110  1101  0000  010
    TPIDRRO_EL0       = 0xde83, // 11  011  1101  0000  011
    TPIDR_EL1         = 0xc684, // 11  000  1101  0000  100
    CNTFRQ_EL0        = 0xdf00, // 11  011  1110  0000  000
    CNTVOFF_EL2       = 0xe703, // 11  100  1110  0000  011
    CNTKCTL_EL1       = 0xc708, // 11  000  1110  0001  000
    CNTHCTL_EL2       = 0xe708, // 11  100  1110  0001  000
    CNTP_TVAL_EL0     = 0xdf10, // 11  011  1110  0010  000
    CNTHP_TVAL_EL2    = 0xe710, // 11  100  1110  0010  000
    CNTPS_TVAL_EL1    = 0xff10, // 11  111  1110  0010  000
    CNTP_CTL_EL0      = 0xdf11, // 11  011  1110  0010  001
    CNTHP_CTL_EL2     = 0xe711, // 11  100  1110  0010  001
    CNTPS_CTL_EL1     = 0xff11, // 11  111  1110  0010  001
    CNTP_CVAL_EL0     = 0xdf12, // 11  011  1110  0010  010
    CNTHP_CVAL_EL2    = 0xe712, // 11  100  1110  0010  010
    CNTPS_CVAL_EL1    = 0xff12, // 11  111  1110  0010  010
    CNTV_TVAL_EL0     = 0xdf18, // 11  011  1110  0011  000
    CNTV_CTL_EL0      = 0xdf19, // 11  011  1110  0011  001
    CNTV_CVAL_EL0     = 0xdf1a, // 11  011  1110  0011  010
    PMEVCNTR0_EL0     = 0xdf40, // 11  011  1110  1000  000
    PMEVCNTR1_EL0     = 0xdf41, // 11  011  1110  1000  001
    PMEVCNTR2_EL0     = 0xdf42, // 11  011  1110  1000  010
    PMEVCNTR3_EL0     = 0xdf43, // 11  011  1110  1000  011
    PMEVCNTR4_EL0     = 0xdf44, // 11  011  1110  1000  100
    PMEVCNTR5_EL0     = 0xdf45, // 11  011  1110  1000  101
    PMEVCNTR6_EL0     = 0xdf46, // 11  011  1110  1000  110
    PMEVCNTR7_EL0     = 0xdf47, // 11  011  1110  1000  111
    PMEVCNTR8_EL0     = 0xdf48, // 11  011  1110  1001  000
    PMEVCNTR9_EL0     = 0xdf49, // 11  011  1110  1001  001
    PMEVCNTR10_EL0    = 0xdf4a, // 11  011  1110  1001  010
    PMEVCNTR11_EL0    = 0xdf4b, // 11  011  1110  1001  011
    PMEVCNTR12_EL0    = 0xdf4c, // 11  011  1110  1001  100
    PMEVCNTR13_EL0    = 0xdf4d, // 11  011  1110  1001  101
    PMEVCNTR14_EL0    = 0xdf4e, // 11  011  1110  1001  110
    PMEVCNTR15_EL0    = 0xdf4f, // 11  011  1110  1001  111
    PMEVCNTR16_EL0    = 0xdf50, // 11  011  1110  1010  000
    PMEVCNTR17_EL0    = 0xdf51, // 11  011  1110  1010  001
    PMEVCNTR18_EL0    = 0xdf52, // 11  011  1110  1010  010
    PMEVCNTR19_EL0    = 0xdf53, // 11  011  1110  1010  011
    PMEVCNTR20_EL0    = 0xdf54, // 11  011  1110  1010  100
    PMEVCNTR21_EL0    = 0xdf55, // 11  011  1110  1010  101
    PMEVCNTR22_EL0    = 0xdf56, // 11  011  1110  1010  110
    PMEVCNTR23_EL0    = 0xdf57, // 11  011  1110  1010  111
    PMEVCNTR24_EL0    = 0xdf58, // 11  011  1110  1011  000
    PMEVCNTR25_EL0    = 0xdf59, // 11  011  1110  1011  001
    PMEVCNTR26_EL0    = 0xdf5a, // 11  011  1110  1011  010
    PMEVCNTR27_EL0    = 0xdf5b, // 11  011  1110  1011  011
    PMEVCNTR28_EL0    = 0xdf5c, // 11  011  1110  1011  100
    PMEVCNTR29_EL0    = 0xdf5d, // 11  011  1110  1011  101
    PMEVCNTR30_EL0    = 0xdf5e, // 11  011  1110  1011  110
    PMCCFILTR_EL0     = 0xdf7f, // 11  011  1110  1111  111
    PMEVTYPER0_EL0    = 0xdf60, // 11  011  1110  1100  000
    PMEVTYPER1_EL0    = 0xdf61, // 11  011  1110  1100  001
    PMEVTYPER2_EL0    = 0xdf62, // 11  011  1110  1100  010
    PMEVTYPER3_EL0    = 0xdf63, // 11  011  1110  1100  011
    PMEVTYPER4_EL0    = 0xdf64, // 11  011  1110  1100  100
    PMEVTYPER5_EL0    = 0xdf65, // 11  011  1110  1100  101
    PMEVTYPER6_EL0    = 0xdf66, // 11  011  1110  1100  110
    PMEVTYPER7_EL0    = 0xdf67, // 11  011  1110  1100  111
    PMEVTYPER8_EL0    = 0xdf68, // 11  011  1110  1101  000
    PMEVTYPER9_EL0    = 0xdf69, // 11  011  1110  1101  001
    PMEVTYPER10_EL0   = 0xdf6a, // 11  011  1110  1101  010
    PMEVTYPER11_EL0   = 0xdf6b, // 11  011  1110  1101  011
    PMEVTYPER12_EL0   = 0xdf6c, // 11  011  1110  1101  100
    PMEVTYPER13_EL0   = 0xdf6d, // 11  011  1110  1101  101
    PMEVTYPER14_EL0   = 0xdf6e, // 11  011  1110  1101  110
    PMEVTYPER15_EL0   = 0xdf6f, // 11  011  1110  1101  111
    PMEVTYPER16_EL0   = 0xdf70, // 11  011  1110  1110  000
    PMEVTYPER17_EL0   = 0xdf71, // 11  011  1110  1110  001
    PMEVTYPER18_EL0   = 0xdf72, // 11  011  1110  1110  010
    PMEVTYPER19_EL0   = 0xdf73, // 11  011  1110  1110  011
    PMEVTYPER20_EL0   = 0xdf74, // 11  011  1110  1110  100
    PMEVTYPER21_EL0   = 0xdf75, // 11  011  1110  1110  101
    PMEVTYPER22_EL0   = 0xdf76, // 11  011  1110  1110  110
    PMEVTYPER23_EL0   = 0xdf77, // 11  011  1110  1110  111
    PMEVTYPER24_EL0   = 0xdf78, // 11  011  1110  1111  000
    PMEVTYPER25_EL0   = 0xdf79, // 11  011  1110  1111  001
    PMEVTYPER26_EL0   = 0xdf7a, // 11  011  1110  1111  010
    PMEVTYPER27_EL0   = 0xdf7b, // 11  011  1110  1111  011
    PMEVTYPER28_EL0   = 0xdf7c, // 11  011  1110  1111  100
    PMEVTYPER29_EL0   = 0xdf7d, // 11  011  1110  1111  101
    PMEVTYPER30_EL0   = 0xdf7e, // 11  011  1110  1111  110

    // Trace registers
    TRCPRGCTLR        = 0x8808, // 10  001  0000  0001  000
    TRCPROCSELR       = 0x8810, // 10  001  0000  0010  000
    TRCCONFIGR        = 0x8820, // 10  001  0000  0100  000
    TRCAUXCTLR        = 0x8830, // 10  001  0000  0110  000
    TRCEVENTCTL0R     = 0x8840, // 10  001  0000  1000  000
    TRCEVENTCTL1R     = 0x8848, // 10  001  0000  1001  000
    TRCSTALLCTLR      = 0x8858, // 10  001  0000  1011  000
    TRCTSCTLR         = 0x8860, // 10  001  0000  1100  000
    TRCSYNCPR         = 0x8868, // 10  001  0000  1101  000
    TRCCCCTLR         = 0x8870, // 10  001  0000  1110  000
    TRCBBCTLR         = 0x8878, // 10  001  0000  1111  000
    TRCTRACEIDR       = 0x8801, // 10  001  0000  0000  001
    TRCQCTLR          = 0x8809, // 10  001  0000  0001  001
    TRCVICTLR         = 0x8802, // 10  001  0000  0000  010
    TRCVIIECTLR       = 0x880a, // 10  001  0000  0001  010
    TRCVISSCTLR       = 0x8812, // 10  001  0000  0010  010
    TRCVIPCSSCTLR     = 0x881a, // 10  001  0000  0011  010
    TRCVDCTLR         = 0x8842, // 10  001  0000  1000  010
    TRCVDSACCTLR      = 0x884a, // 10  001  0000  1001  010
    TRCVDARCCTLR      = 0x8852, // 10  001  0000  1010  010
    TRCSEQEVR0        = 0x8804, // 10  001  0000  0000  100
    TRCSEQEVR1        = 0x880c, // 10  001  0000  0001  100
    TRCSEQEVR2        = 0x8814, // 10  001  0000  0010  100
    TRCSEQRSTEVR      = 0x8834, // 10  001  0000  0110  100
    TRCSEQSTR         = 0x883c, // 10  001  0000  0111  100
    TRCEXTINSELR      = 0x8844, // 10  001  0000  1000  100
    TRCCNTRLDVR0      = 0x8805, // 10  001  0000  0000  101
    TRCCNTRLDVR1      = 0x880d, // 10  001  0000  0001  101
    TRCCNTRLDVR2      = 0x8815, // 10  001  0000  0010  101
    TRCCNTRLDVR3      = 0x881d, // 10  001  0000  0011  101
    TRCCNTCTLR0       = 0x8825, // 10  001  0000  0100  101
    TRCCNTCTLR1       = 0x882d, // 10  001  0000  0101  101
    TRCCNTCTLR2       = 0x8835, // 10  001  0000  0110  101
    TRCCNTCTLR3       = 0x883d, // 10  001  0000  0111  101
    TRCCNTVR0         = 0x8845, // 10  001  0000  1000  101
    TRCCNTVR1         = 0x884d, // 10  001  0000  1001  101
    TRCCNTVR2         = 0x8855, // 10  001  0000  1010  101
    TRCCNTVR3         = 0x885d, // 10  001  0000  1011  101
    TRCIMSPEC0        = 0x8807, // 10  001  0000  0000  111
    TRCIMSPEC1        = 0x880f, // 10  001  0000  0001  111
    TRCIMSPEC2        = 0x8817, // 10  001  0000  0010  111
    TRCIMSPEC3        = 0x881f, // 10  001  0000  0011  111
    TRCIMSPEC4        = 0x8827, // 10  001  0000  0100  111
    TRCIMSPEC5        = 0x882f, // 10  001  0000  0101  111
    TRCIMSPEC6        = 0x8837, // 10  001  0000  0110  111
    TRCIMSPEC7        = 0x883f, // 10  001  0000  0111  111
    TRCRSCTLR2        = 0x8890, // 10  001  0001  0010  000
    TRCRSCTLR3        = 0x8898, // 10  001  0001  0011  000
    TRCRSCTLR4        = 0x88a0, // 10  001  0001  0100  000
    TRCRSCTLR5        = 0x88a8, // 10  001  0001  0101  000
    TRCRSCTLR6        = 0x88b0, // 10  001  0001  0110  000
    TRCRSCTLR7        = 0x88b8, // 10  001  0001  0111  000
    TRCRSCTLR8        = 0x88c0, // 10  001  0001  1000  000
    TRCRSCTLR9        = 0x88c8, // 10  001  0001  1001  000
    TRCRSCTLR10       = 0x88d0, // 10  001  0001  1010  000
    TRCRSCTLR11       = 0x88d8, // 10  001  0001  1011  000
    TRCRSCTLR12       = 0x88e0, // 10  001  0001  1100  000
    TRCRSCTLR13       = 0x88e8, // 10  001  0001  1101  000
    TRCRSCTLR14       = 0x88f0, // 10  001  0001  1110  000
    TRCRSCTLR15       = 0x88f8, // 10  001  0001  1111  000
    TRCRSCTLR16       = 0x8881, // 10  001  0001  0000  001
    TRCRSCTLR17       = 0x8889, // 10  001  0001  0001  001
    TRCRSCTLR18       = 0x8891, // 10  001  0001  0010  001
    TRCRSCTLR19       = 0x8899, // 10  001  0001  0011  001
    TRCRSCTLR20       = 0x88a1, // 10  001  0001  0100  001
    TRCRSCTLR21       = 0x88a9, // 10  001  0001  0101  001
    TRCRSCTLR22       = 0x88b1, // 10  001  0001  0110  001
    TRCRSCTLR23       = 0x88b9, // 10  001  0001  0111  001
    TRCRSCTLR24       = 0x88c1, // 10  001  0001  1000  001
    TRCRSCTLR25       = 0x88c9, // 10  001  0001  1001  001
    TRCRSCTLR26       = 0x88d1, // 10  001  0001  1010  001
    TRCRSCTLR27       = 0x88d9, // 10  001  0001  1011  001
    TRCRSCTLR28       = 0x88e1, // 10  001  0001  1100  001
    TRCRSCTLR29       = 0x88e9, // 10  001  0001  1101  001
    TRCRSCTLR30       = 0x88f1, // 10  001  0001  1110  001
    TRCRSCTLR31       = 0x88f9, // 10  001  0001  1111  001
    TRCSSCCR0         = 0x8882, // 10  001  0001  0000  010
    TRCSSCCR1         = 0x888a, // 10  001  0001  0001  010
    TRCSSCCR2         = 0x8892, // 10  001  0001  0010  010
    TRCSSCCR3         = 0x889a, // 10  001  0001  0011  010
    TRCSSCCR4         = 0x88a2, // 10  001  0001  0100  010
    TRCSSCCR5         = 0x88aa, // 10  001  0001  0101  010
    TRCSSCCR6         = 0x88b2, // 10  001  0001  0110  010
    TRCSSCCR7         = 0x88ba, // 10  001  0001  0111  010
    TRCSSCSR0         = 0x88c2, // 10  001  0001  1000  010
    TRCSSCSR1         = 0x88ca, // 10  001  0001  1001  010
    TRCSSCSR2         = 0x88d2, // 10  001  0001  1010  010
    TRCSSCSR3         = 0x88da, // 10  001  0001  1011  010
    TRCSSCSR4         = 0x88e2, // 10  001  0001  1100  010
    TRCSSCSR5         = 0x88ea, // 10  001  0001  1101  010
    TRCSSCSR6         = 0x88f2, // 10  001  0001  1110  010
    TRCSSCSR7         = 0x88fa, // 10  001  0001  1111  010
    TRCSSPCICR0       = 0x8883, // 10  001  0001  0000  011
    TRCSSPCICR1       = 0x888b, // 10  001  0001  0001  011
    TRCSSPCICR2       = 0x8893, // 10  001  0001  0010  011
    TRCSSPCICR3       = 0x889b, // 10  001  0001  0011  011
    TRCSSPCICR4       = 0x88a3, // 10  001  0001  0100  011
    TRCSSPCICR5       = 0x88ab, // 10  001  0001  0101  011
    TRCSSPCICR6       = 0x88b3, // 10  001  0001  0110  011
    TRCSSPCICR7       = 0x88bb, // 10  001  0001  0111  011
    TRCPDCR           = 0x88a4, // 10  001  0001  0100  100
    TRCACVR0          = 0x8900, // 10  001  0010  0000  000
    TRCACVR1          = 0x8910, // 10  001  0010  0010  000
    TRCACVR2          = 0x8920, // 10  001  0010  0100  000
    TRCACVR3          = 0x8930, // 10  001  0010  0110  000
    TRCACVR4          = 0x8940, // 10  001  0010  1000  000
    TRCACVR5          = 0x8950, // 10  001  0010  1010  000
    TRCACVR6          = 0x8960, // 10  001  0010  1100  000
    TRCACVR7          = 0x8970, // 10  001  0010  1110  000
    TRCACVR8          = 0x8901, // 10  001  0010  0000  001
    TRCACVR9          = 0x8911, // 10  001  0010  0010  001
    TRCACVR10         = 0x8921, // 10  001  0010  0100  001
    TRCACVR11         = 0x8931, // 10  001  0010  0110  001
    TRCACVR12         = 0x8941, // 10  001  0010  1000  001
    TRCACVR13         = 0x8951, // 10  001  0010  1010  001
    TRCACVR14         = 0x8961, // 10  001  0010  1100  001
    TRCACVR15         = 0x8971, // 10  001  0010  1110  001
    TRCACATR0         = 0x8902, // 10  001  0010  0000  010
    TRCACATR1         = 0x8912, // 10  001  0010  0010  010
    TRCACATR2         = 0x8922, // 10  001  0010  0100  010
    TRCACATR3         = 0x8932, // 10  001  0010  0110  010
    TRCACATR4         = 0x8942, // 10  001  0010  1000  010
    TRCACATR5         = 0x8952, // 10  001  0010  1010  010
    TRCACATR6         = 0x8962, // 10  001  0010  1100  010
    TRCACATR7         = 0x8972, // 10  001  0010  1110  010
    TRCACATR8         = 0x8903, // 10  001  0010  0000  011
    TRCACATR9         = 0x8913, // 10  001  0010  0010  011
    TRCACATR10        = 0x8923, // 10  001  0010  0100  011
    TRCACATR11        = 0x8933, // 10  001  0010  0110  011
    TRCACATR12        = 0x8943, // 10  001  0010  1000  011
    TRCACATR13        = 0x8953, // 10  001  0010  1010  011
    TRCACATR14        = 0x8963, // 10  001  0010  1100  011
    TRCACATR15        = 0x8973, // 10  001  0010  1110  011
    TRCDVCVR0         = 0x8904, // 10  001  0010  0000  100
    TRCDVCVR1         = 0x8924, // 10  001  0010  0100  100
    TRCDVCVR2         = 0x8944, // 10  001  0010  1000  100
    TRCDVCVR3         = 0x8964, // 10  001  0010  1100  100
    TRCDVCVR4         = 0x8905, // 10  001  0010  0000  101
    TRCDVCVR5         = 0x8925, // 10  001  0010  0100  101
    TRCDVCVR6         = 0x8945, // 10  001  0010  1000  101
    TRCDVCVR7         = 0x8965, // 10  001  0010  1100  101
    TRCDVCMR0         = 0x8906, // 10  001  0010  0000  110
    TRCDVCMR1         = 0x8926, // 10  001  0010  0100  110
    TRCDVCMR2         = 0x8946, // 10  001  0010  1000  110
    TRCDVCMR3         = 0x8966, // 10  001  0010  1100  110
    TRCDVCMR4         = 0x8907, // 10  001  0010  0000  111
    TRCDVCMR5         = 0x8927, // 10  001  0010  0100  111
    TRCDVCMR6         = 0x8947, // 10  001  0010  1000  111
    TRCDVCMR7         = 0x8967, // 10  001  0010  1100  111
    TRCCIDCVR0        = 0x8980, // 10  001  0011  0000  000
    TRCCIDCVR1        = 0x8990, // 10  001  0011  0010  000
    TRCCIDCVR2        = 0x89a0, // 10  001  0011  0100  000
    TRCCIDCVR3        = 0x89b0, // 10  001  0011  0110  000
    TRCCIDCVR4        = 0x89c0, // 10  001  0011  1000  000
    TRCCIDCVR5        = 0x89d0, // 10  001  0011  1010  000
    TRCCIDCVR6        = 0x89e0, // 10  001  0011  1100  000
    TRCCIDCVR7        = 0x89f0, // 10  001  0011  1110  000
    TRCVMIDCVR0       = 0x8981, // 10  001  0011  0000  001
    TRCVMIDCVR1       = 0x8991, // 10  001  0011  0010  001
    TRCVMIDCVR2       = 0x89a1, // 10  001  0011  0100  001
    TRCVMIDCVR3       = 0x89b1, // 10  001  0011  0110  001
    TRCVMIDCVR4       = 0x89c1, // 10  001  0011  1000  001
    TRCVMIDCVR5       = 0x89d1, // 10  001  0011  1010  001
    TRCVMIDCVR6       = 0x89e1, // 10  001  0011  1100  001
    TRCVMIDCVR7       = 0x89f1, // 10  001  0011  1110  001
    TRCCIDCCTLR0      = 0x8982, // 10  001  0011  0000  010
    TRCCIDCCTLR1      = 0x898a, // 10  001  0011  0001  010
    TRCVMIDCCTLR0     = 0x8992, // 10  001  0011  0010  010
    TRCVMIDCCTLR1     = 0x899a, // 10  001  0011  0011  010
    TRCITCTRL         = 0x8b84, // 10  001  0111  0000  100
    TRCCLAIMSET       = 0x8bc6, // 10  001  0111  1000  110
    TRCCLAIMCLR       = 0x8bce, // 10  001  0111  1001  110

    // GICv3 registers
    ICC_BPR1_EL1      = 0xc663, // 11  000  1100  1100  011
    ICC_BPR0_EL1      = 0xc643, // 11  000  1100  1000  011
    ICC_PMR_EL1       = 0xc230, // 11  000  0100  0110  000
    ICC_CTLR_EL1      = 0xc664, // 11  000  1100  1100  100
    ICC_CTLR_EL3      = 0xf664, // 11  110  1100  1100  100
    ICC_SRE_EL1       = 0xc665, // 11  000  1100  1100  101
    ICC_SRE_EL2       = 0xe64d, // 11  100  1100  1001  101
    ICC_SRE_EL3       = 0xf665, // 11  110  1100  1100  101
    ICC_IGRPEN0_EL1   = 0xc666, // 11  000  1100  1100  110
    ICC_IGRPEN1_EL1   = 0xc667, // 11  000  1100  1100  111
    ICC_IGRPEN1_EL3   = 0xf667, // 11  110  1100  1100  111
    ICC_SEIEN_EL1     = 0xc668, // 11  000  1100  1101  000
    ICC_AP0R0_EL1     = 0xc644, // 11  000  1100  1000  100
    ICC_AP0R1_EL1     = 0xc645, // 11  000  1100  1000  101
    ICC_AP0R2_EL1     = 0xc646, // 11  000  1100  1000  110
    ICC_AP0R3_EL1     = 0xc647, // 11  000  1100  1000  111
    ICC_AP1R0_EL1     = 0xc648, // 11  000  1100  1001  000
    ICC_AP1R1_EL1     = 0xc649, // 11  000  1100  1001  001
    ICC_AP1R2_EL1     = 0xc64a, // 11  000  1100  1001  010
    ICC_AP1R3_EL1     = 0xc64b, // 11  000  1100  1001  011
    ICH_AP0R0_EL2     = 0xe640, // 11  100  1100  1000  000
    ICH_AP0R1_EL2     = 0xe641, // 11  100  1100  1000  001
    ICH_AP0R2_EL2     = 0xe642, // 11  100  1100  1000  010
    ICH_AP0R3_EL2     = 0xe643, // 11  100  1100  1000  011
    ICH_AP1R0_EL2     = 0xe648, // 11  100  1100  1001  000
    ICH_AP1R1_EL2     = 0xe649, // 11  100  1100  1001  001
    ICH_AP1R2_EL2     = 0xe64a, // 11  100  1100  1001  010
    ICH_AP1R3_EL2     = 0xe64b, // 11  100  1100  1001  011
    ICH_HCR_EL2       = 0xe658, // 11  100  1100  1011  000
    ICH_MISR_EL2      = 0xe65a, // 11  100  1100  1011  010
    ICH_VMCR_EL2      = 0xe65f, // 11  100  1100  1011  111
    ICH_VSEIR_EL2     = 0xe64c, // 11  100  1100  1001  100
    ICH_LR0_EL2       = 0xe660, // 11  100  1100  1100  000
    ICH_LR1_EL2       = 0xe661, // 11  100  1100  1100  001
    ICH_LR2_EL2       = 0xe662, // 11  100  1100  1100  010
    ICH_LR3_EL2       = 0xe663, // 11  100  1100  1100  011
    ICH_LR4_EL2       = 0xe664, // 11  100  1100  1100  100
    ICH_LR5_EL2       = 0xe665, // 11  100  1100  1100  101
    ICH_LR6_EL2       = 0xe666, // 11  100  1100  1100  110
    ICH_LR7_EL2       = 0xe667, // 11  100  1100  1100  111
    ICH_LR8_EL2       = 0xe668, // 11  100  1100  1101  000
    ICH_LR9_EL2       = 0xe669, // 11  100  1100  1101  001
    ICH_LR10_EL2      = 0xe66a, // 11  100  1100  1101  010
    ICH_LR11_EL2      = 0xe66b, // 11  100  1100  1101  011
    ICH_LR12_EL2      = 0xe66c, // 11  100  1100  1101  100
    ICH_LR13_EL2      = 0xe66d, // 11  100  1100  1101  101
    ICH_LR14_EL2      = 0xe66e, // 11  100  1100  1101  110
    ICH_LR15_EL2      = 0xe66f, // 11  100  1100  1101  111
  };

  // Cyclone specific system registers
  enum CycloneSysRegValues {
    CPM_IOACC_CTL_EL3 = 0xff90
  };

  // Note that these do not inherit from AArch64NamedImmMapper. This class is
  // sufficiently different in its behaviour that I don't believe it's worth
  // burdening the common AArch64NamedImmMapper with abstractions only needed in
  // this one case.
  struct SysRegMapper {
    static const AArch64NamedImmMapper::Mapping SysRegMappings[];
    static const AArch64NamedImmMapper::Mapping CycloneSysRegMappings[];

    const AArch64NamedImmMapper::Mapping *InstMappings;
    size_t NumInstMappings;
    uint64_t FeatureBits;

    SysRegMapper(uint64_t FeatureBits) : FeatureBits(FeatureBits) { }
    uint32_t fromString(StringRef Name, bool &Valid) const;
    std::string toString(uint32_t Bits) const;
  };

  struct MSRMapper : SysRegMapper {
    static const AArch64NamedImmMapper::Mapping MSRMappings[];
    MSRMapper(uint64_t FeatureBits);
  };

  struct MRSMapper : SysRegMapper {
    static const AArch64NamedImmMapper::Mapping MRSMappings[];
    MRSMapper(uint64_t FeatureBits);
  };

  uint32_t ParseGenericRegister(StringRef Name, bool &Valid);
}

namespace AArch64TLBI {
  enum TLBIValues {
    Invalid = -1,          // Op0 Op1  CRn   CRm   Op2
    IPAS2E1IS    = 0x6401, // 01  100  1000  0000  001
    IPAS2LE1IS   = 0x6405, // 01  100  1000  0000  101
    VMALLE1IS    = 0x4418, // 01  000  1000  0011  000
    ALLE2IS      = 0x6418, // 01  100  1000  0011  000
    ALLE3IS      = 0x7418, // 01  110  1000  0011  000
    VAE1IS       = 0x4419, // 01  000  1000  0011  001
    VAE2IS       = 0x6419, // 01  100  1000  0011  001
    VAE3IS       = 0x7419, // 01  110  1000  0011  001
    ASIDE1IS     = 0x441a, // 01  000  1000  0011  010
    VAAE1IS      = 0x441b, // 01  000  1000  0011  011
    ALLE1IS      = 0x641c, // 01  100  1000  0011  100
    VALE1IS      = 0x441d, // 01  000  1000  0011  101
    VALE2IS      = 0x641d, // 01  100  1000  0011  101
    VALE3IS      = 0x741d, // 01  110  1000  0011  101
    VMALLS12E1IS = 0x641e, // 01  100  1000  0011  110
    VAALE1IS     = 0x441f, // 01  000  1000  0011  111
    IPAS2E1      = 0x6421, // 01  100  1000  0100  001
    IPAS2LE1     = 0x6425, // 01  100  1000  0100  101
    VMALLE1      = 0x4438, // 01  000  1000  0111  000
    ALLE2        = 0x6438, // 01  100  1000  0111  000
    ALLE3        = 0x7438, // 01  110  1000  0111  000
    VAE1         = 0x4439, // 01  000  1000  0111  001
    VAE2         = 0x6439, // 01  100  1000  0111  001
    VAE3         = 0x7439, // 01  110  1000  0111  001
    ASIDE1       = 0x443a, // 01  000  1000  0111  010
    VAAE1        = 0x443b, // 01  000  1000  0111  011
    ALLE1        = 0x643c, // 01  100  1000  0111  100
    VALE1        = 0x443d, // 01  000  1000  0111  101
    VALE2        = 0x643d, // 01  100  1000  0111  101
    VALE3        = 0x743d, // 01  110  1000  0111  101
    VMALLS12E1   = 0x643e, // 01  100  1000  0111  110
    VAALE1       = 0x443f  // 01  000  1000  0111  111
  };

  struct TLBIMapper : AArch64NamedImmMapper {
    const static Mapping TLBIMappings[];

    TLBIMapper();
  };

  static inline bool NeedsRegister(TLBIValues Val) {
    switch (Val) {
    case VMALLE1IS:
    case ALLE2IS:
    case ALLE3IS:
    case ALLE1IS:
    case VMALLS12E1IS:
    case VMALLE1:
    case ALLE2:
    case ALLE3:
    case ALLE1:
    case VMALLS12E1:
      return false;
    default:
      return true;
    }
  }
} 

namespace AArch64II {
  /// Target Operand Flag enum.
  enum TOF {
    //===------------------------------------------------------------------===//
    // AArch64 Specific MachineOperand flags.

    MO_NO_FLAG,

    MO_FRAGMENT = 0xf,

    /// MO_PAGE - A symbol operand with this flag represents the pc-relative
    /// offset of the 4K page containing the symbol.  This is used with the
    /// ADRP instruction.
    MO_PAGE = 1,

    /// MO_PAGEOFF - A symbol operand with this flag represents the offset of
    /// that symbol within a 4K page.  This offset is added to the page address
    /// to produce the complete address.
    MO_PAGEOFF = 2,

    /// MO_G3 - A symbol operand with this flag (granule 3) represents the high
    /// 16-bits of a 64-bit address, used in a MOVZ or MOVK instruction
    MO_G3 = 3,

    /// MO_G2 - A symbol operand with this flag (granule 2) represents the bits
    /// 32-47 of a 64-bit address, used in a MOVZ or MOVK instruction
    MO_G2 = 4,

    /// MO_G1 - A symbol operand with this flag (granule 1) represents the bits
    /// 16-31 of a 64-bit address, used in a MOVZ or MOVK instruction
    MO_G1 = 5,

    /// MO_G0 - A symbol operand with this flag (granule 0) represents the bits
    /// 0-15 of a 64-bit address, used in a MOVZ or MOVK instruction
    MO_G0 = 6,

    /// MO_HI12 - This flag indicates that a symbol operand represents the bits
    /// 13-24 of a 64-bit address, used in a arithmetic immediate-shifted-left-
    /// by-12-bits instruction.
    MO_HI12 = 7,

    /// MO_GOT - This flag indicates that a symbol operand represents the
    /// address of the GOT entry for the symbol, rather than the address of
    /// the symbol itself.
    MO_GOT = 0x10,

    /// MO_NC - Indicates whether the linker is expected to check the symbol
    /// reference for overflow. For example in an ADRP/ADD pair of relocations
    /// the ADRP usually does check, but not the ADD.
    MO_NC = 0x20,

    /// MO_TLS - Indicates that the operand being accessed is some kind of
    /// thread-local symbol. On Darwin, only one type of thread-local access
    /// exists (pre linker-relaxation), but on ELF the TLSModel used for the
    /// referee will affect interpretation.
    MO_TLS = 0x40,

    /// MO_CONSTPOOL - This flag indicates that a symbol operand represents
    /// the address of a constant pool entry for the symbol, rather than the
    /// address of the symbol itself.
    MO_CONSTPOOL = 0x80
  };
} // end namespace AArch64II

} // end namespace llvm

#endif