LXR linux/arch/mips/include/asm/uasm.h

   1/*
   2 * This file is subject to the terms and conditions of the GNU General Public
   3 * License.  See the file "COPYING" in the main directory of this archive
   4 * for more details.
   5 *
   6 * Copyright (C) 2004, 2005, 2006, 2008  Thiemo Seufer
   7 * Copyright (C) 2005  Maciej W. Rozycki
   8 * Copyright (C) 2006  Ralf Baechle (ralf@linux-mips.org)
   9 * Copyright (C) 2012, 2013  MIPS Technologies, Inc.  All rights reserved.
  10 */
  11
  12#include <linux/types.h>
  13
  14#ifdef CONFIG_EXPORT_UASM
  15#include <linux/export.h>
  16#define UASM_EXPORT_SYMBOL(sym) EXPORT_SYMBOL(sym)
  17#else
  18#define UASM_EXPORT_SYMBOL(sym)
  19#endif
  20
  21#define _UASM_ISA_CLASSIC       0
  22#define _UASM_ISA_MICROMIPS     1
  23
  24#ifndef UASM_ISA
  25#ifdef CONFIG_CPU_MICROMIPS
  26#define UASM_ISA        _UASM_ISA_MICROMIPS
  27#else
  28#define UASM_ISA        _UASM_ISA_CLASSIC
  29#endif
  30#endif
  31
  32#if (UASM_ISA == _UASM_ISA_CLASSIC)
  33#ifdef CONFIG_CPU_MICROMIPS
  34#define ISAOPC(op)      CL_uasm_i##op
  35#define ISAFUNC(x)      CL_##x
  36#else
  37#define ISAOPC(op)      uasm_i##op
  38#define ISAFUNC(x)      x
  39#endif
  40#elif (UASM_ISA == _UASM_ISA_MICROMIPS)
  41#ifdef CONFIG_CPU_MICROMIPS
  42#define ISAOPC(op)      uasm_i##op
  43#define ISAFUNC(x)      x
  44#else
  45#define ISAOPC(op)      MM_uasm_i##op
  46#define ISAFUNC(x)      MM_##x
  47#endif
  48#else
  49#error Unsupported micro-assembler ISA!!!
  50#endif
  51
  52#define Ip_u1u2u3(op)                                                   \
  53void ISAOPC(op)(u32 **buf, unsigned int a, unsigned int b, unsigned int c)
  54
  55#define Ip_u2u1u3(op)                                                   \
  56void ISAOPC(op)(u32 **buf, unsigned int a, unsigned int b, unsigned int c)
  57
  58#define Ip_u3u2u1(op)                                                   \
  59void ISAOPC(op)(u32 **buf, unsigned int a, unsigned int b, unsigned int c)
  60
  61#define Ip_u3u1u2(op)                                                   \
  62void ISAOPC(op)(u32 **buf, unsigned int a, unsigned int b, unsigned int c)
  63
  64#define Ip_u1u2s3(op)                                                   \
  65void ISAOPC(op)(u32 **buf, unsigned int a, unsigned int b, signed int c)
  66
  67#define Ip_u2s3u1(op)                                                   \
  68void ISAOPC(op)(u32 **buf, unsigned int a, signed int b, unsigned int c)
  69
  70#define Ip_s3s1s2(op)                                                   \
  71void ISAOPC(op)(u32 **buf, int a, int b, int c)
  72
  73#define Ip_u2u1s3(op)                                                   \
  74void ISAOPC(op)(u32 **buf, unsigned int a, unsigned int b, signed int c)
  75
  76#define Ip_u2u1msbu3(op)                                                \
  77void ISAOPC(op)(u32 **buf, unsigned int a, unsigned int b, unsigned int c, \
  78           unsigned int d)
  79
  80#define Ip_u1u2(op)                                                     \
  81void ISAOPC(op)(u32 **buf, unsigned int a, unsigned int b)
  82
  83#define Ip_u2u1(op)                                                     \
  84void ISAOPC(op)(u32 **buf, unsigned int a, unsigned int b)
  85
  86#define Ip_u1s2(op)                                                     \
  87void ISAOPC(op)(u32 **buf, unsigned int a, signed int b)
  88
  89#define Ip_u1(op) void ISAOPC(op)(u32 **buf, unsigned int a)
  90
  91#define Ip_0(op) void ISAOPC(op)(u32 **buf)
  92
  93Ip_u2u1s3(_addiu);
  94Ip_u3u1u2(_addu);
  95Ip_u3u1u2(_and);
  96Ip_u2u1u3(_andi);
  97Ip_u1u2s3(_bbit0);
  98Ip_u1u2s3(_bbit1);
  99Ip_u1u2s3(_beq);
 100Ip_u1u2s3(_beql);
 101Ip_u1s2(_bgez);
 102Ip_u1s2(_bgezl);
 103Ip_u1s2(_bltz);
 104Ip_u1s2(_bltzl);
 105Ip_u1u2s3(_bne);
 106Ip_u2s3u1(_cache);
 107Ip_u1u2(_cfc1);
 108Ip_u2u1(_cfcmsa);
 109Ip_u1u2(_ctc1);
 110Ip_u2u1(_ctcmsa);
 111Ip_u2u1s3(_daddiu);
 112Ip_u3u1u2(_daddu);
 113Ip_u1(_di);
 114Ip_u2u1msbu3(_dins);
 115Ip_u2u1msbu3(_dinsm);
 116Ip_u1u2(_divu);
 117Ip_u1u2u3(_dmfc0);
 118Ip_u1u2u3(_dmtc0);
 119Ip_u2u1u3(_drotr);
 120Ip_u2u1u3(_drotr32);
 121Ip_u2u1u3(_dsll);
 122Ip_u2u1u3(_dsll32);
 123Ip_u2u1u3(_dsra);
 124Ip_u2u1u3(_dsrl);
 125Ip_u2u1u3(_dsrl32);
 126Ip_u3u1u2(_dsubu);
 127Ip_0(_eret);
 128Ip_u2u1msbu3(_ext);
 129Ip_u2u1msbu3(_ins);
 130Ip_u1(_j);
 131Ip_u1(_jal);
 132Ip_u2u1(_jalr);
 133Ip_u1(_jr);
 134Ip_u2s3u1(_lb);
 135Ip_u2s3u1(_ld);
 136Ip_u3u1u2(_ldx);
 137Ip_u2s3u1(_lh);
 138Ip_u2s3u1(_ll);
 139Ip_u2s3u1(_lld);
 140Ip_u1s2(_lui);
 141Ip_u2s3u1(_lw);
 142Ip_u3u1u2(_lwx);
 143Ip_u1u2u3(_mfc0);
 144Ip_u1u2u3(_mfhc0);
 145Ip_u1(_mfhi);
 146Ip_u1(_mflo);
 147Ip_u1u2u3(_mtc0);
 148Ip_u1u2u3(_mthc0);
 149Ip_u1(_mthi);
 150Ip_u1(_mtlo);
 151Ip_u3u1u2(_mul);
 152Ip_u3u1u2(_or);
 153Ip_u2u1u3(_ori);
 154Ip_u2s3u1(_pref);
 155Ip_0(_rfe);
 156Ip_u2u1u3(_rotr);
 157Ip_u2s3u1(_sc);
 158Ip_u2s3u1(_scd);
 159Ip_u2s3u1(_sd);
 160Ip_u2u1u3(_sll);
 161Ip_u3u2u1(_sllv);
 162Ip_s3s1s2(_slt);
 163Ip_u2u1s3(_sltiu);
 164Ip_u3u1u2(_sltu);
 165Ip_u2u1u3(_sra);
 166Ip_u2u1u3(_srl);
 167Ip_u3u2u1(_srlv);
 168Ip_u3u1u2(_subu);
 169Ip_u2s3u1(_sw);
 170Ip_u1(_sync);
 171Ip_u1(_syscall);
 172Ip_0(_tlbp);
 173Ip_0(_tlbr);
 174Ip_0(_tlbwi);
 175Ip_0(_tlbwr);
 176Ip_u1(_wait);
 177Ip_u2u1(_wsbh);
 178Ip_u3u1u2(_xor);
 179Ip_u2u1u3(_xori);
 180Ip_u2u1(_yield);
 181Ip_u1u2(_ldpte);
 182Ip_u2u1u3(_lddir);
 183
 184/* Handle labels. */
 185struct uasm_label {
 186        u32 *addr;
 187        int lab;
 188};
 189
 190void ISAFUNC(uasm_build_label)(struct uasm_label **lab, u32 *addr,
 191                        int lid);
 192#ifdef CONFIG_64BIT
 193int ISAFUNC(uasm_in_compat_space_p)(long addr);
 194#endif
 195int ISAFUNC(uasm_rel_hi)(long val);
 196int ISAFUNC(uasm_rel_lo)(long val);
 197void ISAFUNC(UASM_i_LA_mostly)(u32 **buf, unsigned int rs, long addr);
 198void ISAFUNC(UASM_i_LA)(u32 **buf, unsigned int rs, long addr);
 199
 200#define UASM_L_LA(lb)                                                   \
 201static inline void ISAFUNC(uasm_l##lb)(struct uasm_label **lab, u32 *addr) \
 202{                                                                       \
 203        ISAFUNC(uasm_build_label)(lab, addr, label##lb);                \
 204}
 205
 206/* convenience macros for instructions */
 207#ifdef CONFIG_64BIT
 208# define UASM_i_ADDIU(buf, rs, rt, val) uasm_i_daddiu(buf, rs, rt, val)
 209# define UASM_i_ADDU(buf, rs, rt, rd) uasm_i_daddu(buf, rs, rt, rd)
 210# define UASM_i_LL(buf, rs, rt, off) uasm_i_lld(buf, rs, rt, off)
 211# define UASM_i_LW(buf, rs, rt, off) uasm_i_ld(buf, rs, rt, off)
 212# define UASM_i_LWX(buf, rs, rt, rd) uasm_i_ldx(buf, rs, rt, rd)
 213# define UASM_i_MFC0(buf, rt, rd...) uasm_i_dmfc0(buf, rt, rd)
 214# define UASM_i_MTC0(buf, rt, rd...) uasm_i_dmtc0(buf, rt, rd)
 215# define UASM_i_ROTR(buf, rs, rt, sh) uasm_i_drotr(buf, rs, rt, sh)
 216# define UASM_i_SC(buf, rs, rt, off) uasm_i_scd(buf, rs, rt, off)
 217# define UASM_i_SLL(buf, rs, rt, sh) uasm_i_dsll(buf, rs, rt, sh)
 218# define UASM_i_SRA(buf, rs, rt, sh) uasm_i_dsra(buf, rs, rt, sh)
 219# define UASM_i_SRL(buf, rs, rt, sh) uasm_i_dsrl(buf, rs, rt, sh)
 220# define UASM_i_SRL_SAFE(buf, rs, rt, sh) uasm_i_dsrl_safe(buf, rs, rt, sh)
 221# define UASM_i_SUBU(buf, rs, rt, rd) uasm_i_dsubu(buf, rs, rt, rd)
 222# define UASM_i_SW(buf, rs, rt, off) uasm_i_sd(buf, rs, rt, off)
 223#else
 224# define UASM_i_ADDIU(buf, rs, rt, val) uasm_i_addiu(buf, rs, rt, val)
 225# define UASM_i_ADDU(buf, rs, rt, rd) uasm_i_addu(buf, rs, rt, rd)
 226# define UASM_i_LL(buf, rs, rt, off) uasm_i_ll(buf, rs, rt, off)
 227# define UASM_i_LW(buf, rs, rt, off) uasm_i_lw(buf, rs, rt, off)
 228# define UASM_i_LWX(buf, rs, rt, rd) uasm_i_lwx(buf, rs, rt, rd)
 229# define UASM_i_MFC0(buf, rt, rd...) uasm_i_mfc0(buf, rt, rd)
 230# define UASM_i_MTC0(buf, rt, rd...) uasm_i_mtc0(buf, rt, rd)
 231# define UASM_i_ROTR(buf, rs, rt, sh) uasm_i_rotr(buf, rs, rt, sh)
 232# define UASM_i_SC(buf, rs, rt, off) uasm_i_sc(buf, rs, rt, off)
 233# define UASM_i_SLL(buf, rs, rt, sh) uasm_i_sll(buf, rs, rt, sh)
 234# define UASM_i_SRA(buf, rs, rt, sh) uasm_i_sra(buf, rs, rt, sh)
 235# define UASM_i_SRL(buf, rs, rt, sh) uasm_i_srl(buf, rs, rt, sh)
 236# define UASM_i_SRL_SAFE(buf, rs, rt, sh) uasm_i_srl(buf, rs, rt, sh)
 237# define UASM_i_SUBU(buf, rs, rt, rd) uasm_i_subu(buf, rs, rt, rd)
 238# define UASM_i_SW(buf, rs, rt, off) uasm_i_sw(buf, rs, rt, off)
 239#endif
 240
 241#define uasm_i_b(buf, off) uasm_i_beq(buf, 0, 0, off)
 242#define uasm_i_beqz(buf, rs, off) uasm_i_beq(buf, rs, 0, off)
 243#define uasm_i_beqzl(buf, rs, off) uasm_i_beql(buf, rs, 0, off)
 244#define uasm_i_bnez(buf, rs, off) uasm_i_bne(buf, rs, 0, off)
 245#define uasm_i_bnezl(buf, rs, off) uasm_i_bnel(buf, rs, 0, off)
 246#define uasm_i_ehb(buf) uasm_i_sll(buf, 0, 0, 3)
 247#define uasm_i_move(buf, a, b) UASM_i_ADDU(buf, a, 0, b)
 248#define uasm_i_nop(buf) uasm_i_sll(buf, 0, 0, 0)
 249#define uasm_i_ssnop(buf) uasm_i_sll(buf, 0, 0, 1)
 250
 251static inline void uasm_i_drotr_safe(u32 **p, unsigned int a1,
 252                                     unsigned int a2, unsigned int a3)
 253{
 254        if (a3 < 32)
 255                ISAOPC(_drotr)(p, a1, a2, a3);
 256        else
 257                ISAOPC(_drotr32)(p, a1, a2, a3 - 32);
 258}
 259
 260static inline void uasm_i_dsll_safe(u32 **p, unsigned int a1,
 261                                    unsigned int a2, unsigned int a3)
 262{
 263        if (a3 < 32)
 264                ISAOPC(_dsll)(p, a1, a2, a3);
 265        else
 266                ISAOPC(_dsll32)(p, a1, a2, a3 - 32);
 267}
 268
 269static inline void uasm_i_dsrl_safe(u32 **p, unsigned int a1,
 270                                    unsigned int a2, unsigned int a3)
 271{
 272        if (a3 < 32)
 273                ISAOPC(_dsrl)(p, a1, a2, a3);
 274        else
 275                ISAOPC(_dsrl32)(p, a1, a2, a3 - 32);
 276}
 277
 278/* Handle relocations. */
 279struct uasm_reloc {
 280        u32 *addr;
 281        unsigned int type;
 282        int lab;
 283};
 284
 285/* This is zero so we can use zeroed label arrays. */
 286#define UASM_LABEL_INVALID 0
 287
 288void uasm_r_mips_pc16(struct uasm_reloc **rel, u32 *addr, int lid);
 289void uasm_resolve_relocs(struct uasm_reloc *rel, struct uasm_label *lab);
 290void uasm_move_relocs(struct uasm_reloc *rel, u32 *first, u32 *end, long off);
 291void uasm_move_labels(struct uasm_label *lab, u32 *first, u32 *end, long off);
 292void uasm_copy_handler(struct uasm_reloc *rel, struct uasm_label *lab,
 293        u32 *first, u32 *end, u32 *target);
 294int uasm_insn_has_bdelay(struct uasm_reloc *rel, u32 *addr);
 295
 296/* Convenience functions for labeled branches. */
 297void uasm_il_b(u32 **p, struct uasm_reloc **r, int lid);
 298void uasm_il_bbit0(u32 **p, struct uasm_reloc **r, unsigned int reg,
 299                   unsigned int bit, int lid);
 300void uasm_il_bbit1(u32 **p, struct uasm_reloc **r, unsigned int reg,
 301                   unsigned int bit, int lid);
 302void uasm_il_beq(u32 **p, struct uasm_reloc **r, unsigned int r1,
 303                 unsigned int r2, int lid);
 304void uasm_il_beqz(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
 305void uasm_il_beqzl(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
 306void uasm_il_bgezl(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
 307void uasm_il_bgez(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
 308void uasm_il_bltz(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
 309void uasm_il_bne(u32 **p, struct uasm_reloc **r, unsigned int reg1,
 310                 unsigned int reg2, int lid);
 311void uasm_il_bnez(u32 **p, struct uasm_reloc **r, unsigned int reg, int lid);
 312