root/arch/riscv/include/asm/insn-def.h
/* SPDX-License-Identifier: GPL-2.0-only */

#ifndef __ASM_INSN_DEF_H
#define __ASM_INSN_DEF_H

#include <asm/asm.h>

#define INSN_R_FUNC7_SHIFT              25
#define INSN_R_RS2_SHIFT                20
#define INSN_R_RS1_SHIFT                15
#define INSN_R_FUNC3_SHIFT              12
#define INSN_R_RD_SHIFT                  7
#define INSN_R_OPCODE_SHIFT              0

#define INSN_I_SIMM12_SHIFT             20
#define INSN_I_RS1_SHIFT                15
#define INSN_I_FUNC3_SHIFT              12
#define INSN_I_RD_SHIFT                  7
#define INSN_I_OPCODE_SHIFT              0

#define INSN_S_SIMM7_SHIFT              25
#define INSN_S_RS2_SHIFT                20
#define INSN_S_RS1_SHIFT                15
#define INSN_S_FUNC3_SHIFT              12
#define INSN_S_SIMM5_SHIFT               7
#define INSN_S_OPCODE_SHIFT              0

#ifdef __ASSEMBLER__

#ifdef CONFIG_AS_HAS_INSN

        .macro insn_r, opcode, func3, func7, rd, rs1, rs2
        .insn   r \opcode, \func3, \func7, \rd, \rs1, \rs2
        .endm

        .macro insn_i, opcode, func3, rd, rs1, simm12
        .insn   i \opcode, \func3, \rd, \rs1, \simm12
        .endm

        .macro insn_s, opcode, func3, rs2, simm12, rs1
        .insn   s \opcode, \func3, \rs2, \simm12(\rs1)
        .endm

#else

#include <asm/gpr-num.h>

        .macro insn_r, opcode, func3, func7, rd, rs1, rs2
        .4byte  ((\opcode << INSN_R_OPCODE_SHIFT) |             \
                 (\func3 << INSN_R_FUNC3_SHIFT) |               \
                 (\func7 << INSN_R_FUNC7_SHIFT) |               \
                 (.L__gpr_num_\rd << INSN_R_RD_SHIFT) |         \
                 (.L__gpr_num_\rs1 << INSN_R_RS1_SHIFT) |       \
                 (.L__gpr_num_\rs2 << INSN_R_RS2_SHIFT))
        .endm

        .macro insn_i, opcode, func3, rd, rs1, simm12
        .4byte  ((\opcode << INSN_I_OPCODE_SHIFT) |             \
                 (\func3 << INSN_I_FUNC3_SHIFT) |               \
                 (.L__gpr_num_\rd << INSN_I_RD_SHIFT) |         \
                 (.L__gpr_num_\rs1 << INSN_I_RS1_SHIFT) |       \
                 (\simm12 << INSN_I_SIMM12_SHIFT))
        .endm

        .macro insn_s, opcode, func3, rs2, simm12, rs1
        .4byte  ((\opcode << INSN_S_OPCODE_SHIFT) |             \
                 (\func3 << INSN_S_FUNC3_SHIFT) |               \
                 (.L__gpr_num_\rs2 << INSN_S_RS2_SHIFT) |       \
                 (.L__gpr_num_\rs1 << INSN_S_RS1_SHIFT) |       \
                 ((\simm12 & 0x1f) << INSN_S_SIMM5_SHIFT) |     \
                 (((\simm12 >> 5) & 0x7f) << INSN_S_SIMM7_SHIFT))
        .endm

#endif

#define __INSN_R(...)   insn_r __VA_ARGS__
#define __INSN_I(...)   insn_i __VA_ARGS__
#define __INSN_S(...)   insn_s __VA_ARGS__

#else /* ! __ASSEMBLER__ */

#ifdef CONFIG_AS_HAS_INSN

#define __INSN_R(opcode, func3, func7, rd, rs1, rs2)    \
        ".insn  r " opcode ", " func3 ", " func7 ", " rd ", " rs1 ", " rs2 "\n"

#define __INSN_I(opcode, func3, rd, rs1, simm12)        \
        ".insn  i " opcode ", " func3 ", " rd ", " rs1 ", " simm12 "\n"

#define __INSN_S(opcode, func3, rs2, simm12, rs1)       \
        ".insn  s " opcode ", " func3 ", " rs2 ", " simm12 "(" rs1 ")\n"

#else

#include <linux/stringify.h>
#include <asm/gpr-num.h>

#define DEFINE_INSN_R                                                   \
        __DEFINE_ASM_GPR_NUMS                                           \
"       .macro insn_r, opcode, func3, func7, rd, rs1, rs2\n"            \
"       .4byte  ((\\opcode << " __stringify(INSN_R_OPCODE_SHIFT) ") |"  \
"                (\\func3 << " __stringify(INSN_R_FUNC3_SHIFT) ") |"    \
"                (\\func7 << " __stringify(INSN_R_FUNC7_SHIFT) ") |"    \
"                (.L__gpr_num_\\rd << " __stringify(INSN_R_RD_SHIFT) ") |"    \
"                (.L__gpr_num_\\rs1 << " __stringify(INSN_R_RS1_SHIFT) ") |"  \
"                (.L__gpr_num_\\rs2 << " __stringify(INSN_R_RS2_SHIFT) "))\n" \
"       .endm\n"

#define DEFINE_INSN_I                                                   \
        __DEFINE_ASM_GPR_NUMS                                           \
"       .macro insn_i, opcode, func3, rd, rs1, simm12\n"                \
"       .4byte  ((\\opcode << " __stringify(INSN_I_OPCODE_SHIFT) ") |"  \
"                (\\func3 << " __stringify(INSN_I_FUNC3_SHIFT) ") |"    \
"                (.L__gpr_num_\\rd << " __stringify(INSN_I_RD_SHIFT) ") |"   \
"                (.L__gpr_num_\\rs1 << " __stringify(INSN_I_RS1_SHIFT) ") |" \
"                (\\simm12 << " __stringify(INSN_I_SIMM12_SHIFT) "))\n" \
"       .endm\n"

#define DEFINE_INSN_S                                                   \
        __DEFINE_ASM_GPR_NUMS                                           \
"       .macro insn_s, opcode, func3, rs2, simm12, rs1\n"               \
"       .4byte  ((\\opcode << " __stringify(INSN_S_OPCODE_SHIFT) ") |"  \
"                (\\func3 << " __stringify(INSN_S_FUNC3_SHIFT) ") |"    \
"                (.L__gpr_num_\\rs2 << " __stringify(INSN_S_RS2_SHIFT) ") |" \
"                (.L__gpr_num_\\rs1 << " __stringify(INSN_S_RS1_SHIFT) ") |" \
"                ((\\simm12 & 0x1f) << " __stringify(INSN_S_SIMM5_SHIFT) ") |" \
"                (((\\simm12 >> 5) & 0x7f) << " __stringify(INSN_S_SIMM7_SHIFT) "))\n" \
"       .endm\n"

#define UNDEFINE_INSN_R                                                 \
"       .purgem insn_r\n"

#define UNDEFINE_INSN_I                                                 \
"       .purgem insn_i\n"

#define UNDEFINE_INSN_S                                                 \
"       .purgem insn_s\n"

#define __INSN_R(opcode, func3, func7, rd, rs1, rs2)                    \
        DEFINE_INSN_R                                                   \
        "insn_r " opcode ", " func3 ", " func7 ", " rd ", " rs1 ", " rs2 "\n" \
        UNDEFINE_INSN_R

#define __INSN_I(opcode, func3, rd, rs1, simm12)                        \
        DEFINE_INSN_I                                                   \
        "insn_i " opcode ", " func3 ", " rd ", " rs1 ", " simm12 "\n" \
        UNDEFINE_INSN_I

#define __INSN_S(opcode, func3, rs2, simm12, rs1)                       \
        DEFINE_INSN_S                                                   \
        "insn_s " opcode ", " func3 ", " rs2 ", " simm12 ", " rs1 "\n"  \
        UNDEFINE_INSN_S

#endif

#endif /* ! __ASSEMBLER__ */

#define INSN_R(opcode, func3, func7, rd, rs1, rs2)              \
        __INSN_R(RV_##opcode, RV_##func3, RV_##func7,           \
                 RV_##rd, RV_##rs1, RV_##rs2)

#define INSN_I(opcode, func3, rd, rs1, simm12)                  \
        __INSN_I(RV_##opcode, RV_##func3, RV_##rd,              \
                 RV_##rs1, RV_##simm12)

#define INSN_S(opcode, func3, rs2, simm12, rs1)                 \
        __INSN_S(RV_##opcode, RV_##func3, RV_##rs2,             \
                 RV_##simm12, RV_##rs1)

#define RV_OPCODE(v)            __ASM_STR(v)
#define RV_FUNC3(v)             __ASM_STR(v)
#define RV_FUNC7(v)             __ASM_STR(v)
#define RV_SIMM12(v)            __ASM_STR(v)
#define RV_RD(v)                __ASM_STR(v)
#define RV_RS1(v)               __ASM_STR(v)
#define RV_RS2(v)               __ASM_STR(v)
#define __RV_REG(v)             __ASM_STR(x ## v)
#define RV___RD(v)              __RV_REG(v)
#define RV___RS1(v)             __RV_REG(v)
#define RV___RS2(v)             __RV_REG(v)

#define RV_OPCODE_AMO           RV_OPCODE(47)
#define RV_OPCODE_MISC_MEM      RV_OPCODE(15)
#define RV_OPCODE_OP_IMM        RV_OPCODE(19)
#define RV_OPCODE_SYSTEM        RV_OPCODE(115)

#define HFENCE_VVMA(vaddr, asid)                                \
        INSN_R(OPCODE_SYSTEM, FUNC3(0), FUNC7(17),              \
               __RD(0), RS1(vaddr), RS2(asid))

#define HFENCE_GVMA(gaddr, vmid)                                \
        INSN_R(OPCODE_SYSTEM, FUNC3(0), FUNC7(49),              \
               __RD(0), RS1(gaddr), RS2(vmid))

#define HLVX_HU(dest, addr)                                     \
        INSN_R(OPCODE_SYSTEM, FUNC3(4), FUNC7(50),              \
               RD(dest), RS1(addr), __RS2(3))

#define HLV_W(dest, addr)                                       \
        INSN_R(OPCODE_SYSTEM, FUNC3(4), FUNC7(52),              \
               RD(dest), RS1(addr), __RS2(0))

#ifdef CONFIG_64BIT
#define HLV_D(dest, addr)                                       \
        INSN_R(OPCODE_SYSTEM, FUNC3(4), FUNC7(54),              \
               RD(dest), RS1(addr), __RS2(0))
#else
#define HLV_D(dest, addr)                                       \
        __ASM_STR(.error "hlv.d requires 64-bit support")
#endif

#define LB_AQ(dest, addr)                                       \
        INSN_R(OPCODE_AMO, FUNC3(0), FUNC7(26),                 \
               RD(dest), RS1(addr), __RS2(0))

#define LB_AQRL(dest, addr)                                     \
        INSN_R(OPCODE_AMO, FUNC3(0), FUNC7(27),                 \
               RD(dest), RS1(addr), __RS2(0))

#define LH_AQ(dest, addr)                                       \
        INSN_R(OPCODE_AMO, FUNC3(1), FUNC7(26),                 \
               RD(dest), RS1(addr), __RS2(0))

#define LH_AQRL(dest, addr)                                     \
        INSN_R(OPCODE_AMO, FUNC3(1), FUNC7(27),                 \
               RD(dest), RS1(addr), __RS2(0))

#define LW_AQ(dest, addr)                                       \
        INSN_R(OPCODE_AMO, FUNC3(2), FUNC7(26),                 \
               RD(dest), RS1(addr), __RS2(0))

#define LW_AQRL(dest, addr)                                     \
        INSN_R(OPCODE_AMO, FUNC3(2), FUNC7(27),                 \
               RD(dest), RS1(addr), __RS2(0))

#define SB_RL(src, addr)                                        \
        INSN_R(OPCODE_AMO, FUNC3(0), FUNC7(29),                 \
               __RD(0), RS1(addr), RS2(src))

#define SB_AQRL(src, addr)                                      \
        INSN_R(OPCODE_AMO, FUNC3(0), FUNC7(31),                 \
               __RD(0), RS1(addr), RS2(src))

#define SH_RL(src, addr)                                        \
        INSN_R(OPCODE_AMO, FUNC3(1), FUNC7(29),                 \
               __RD(0), RS1(addr), RS2(src))

#define SH_AQRL(src, addr)                                      \
        INSN_R(OPCODE_AMO, FUNC3(1), FUNC7(31),                 \
               __RD(0), RS1(addr), RS2(src))

#define SW_RL(src, addr)                                        \
        INSN_R(OPCODE_AMO, FUNC3(2), FUNC7(29),                 \
               __RD(0), RS1(addr), RS2(src))

#define SW_AQRL(src, addr)                                      \
        INSN_R(OPCODE_AMO, FUNC3(2), FUNC7(31),                 \
               __RD(0), RS1(addr), RS2(src))

#ifdef CONFIG_64BIT
#define LD_AQ(dest, addr)                                       \
        INSN_R(OPCODE_AMO, FUNC3(3), FUNC7(26),                 \
               RD(dest), RS1(addr), __RS2(0))

#define LD_AQRL(dest, addr)                                     \
        INSN_R(OPCODE_AMO, FUNC3(3), FUNC7(27),                 \
               RD(dest), RS1(addr), __RS2(0))

#define SD_RL(src, addr)                                        \
        INSN_R(OPCODE_AMO, FUNC3(3), FUNC7(29),                 \
               __RD(0), RS1(addr), RS2(src))

#define SD_AQRL(src, addr)                                      \
        INSN_R(OPCODE_AMO, FUNC3(3), FUNC7(31),                 \
               __RD(0), RS1(addr), RS2(src))
#else
#define LD_AQ(dest, addr)                                       \
        __ASM_STR(.error "ld.aq requires 64-bit support")

#define LD_AQRL(dest, addr)                                     \
        __ASM_STR(.error "ld.aqrl requires 64-bit support")

#define SD_RL(dest, addr)                                       \
        __ASM_STR(.error "sd.rl requires 64-bit support")

#define SD_AQRL(dest, addr)                                     \
        __ASM_STR(.error "sd.aqrl requires 64-bit support")
#endif

#define SINVAL_VMA(vaddr, asid)                                 \
        INSN_R(OPCODE_SYSTEM, FUNC3(0), FUNC7(11),              \
               __RD(0), RS1(vaddr), RS2(asid))

#define SFENCE_W_INVAL()                                        \
        INSN_R(OPCODE_SYSTEM, FUNC3(0), FUNC7(12),              \
               __RD(0), __RS1(0), __RS2(0))

#define SFENCE_INVAL_IR()                                       \
        INSN_R(OPCODE_SYSTEM, FUNC3(0), FUNC7(12),              \
               __RD(0), __RS1(0), __RS2(1))

#define HINVAL_VVMA(vaddr, asid)                                \
        INSN_R(OPCODE_SYSTEM, FUNC3(0), FUNC7(19),              \
               __RD(0), RS1(vaddr), RS2(asid))

#define HINVAL_GVMA(gaddr, vmid)                                \
        INSN_R(OPCODE_SYSTEM, FUNC3(0), FUNC7(51),              \
               __RD(0), RS1(gaddr), RS2(vmid))

#define CBO_INVAL(base)                                         \
        INSN_I(OPCODE_MISC_MEM, FUNC3(2), __RD(0),              \
               RS1(base), SIMM12(0))

#define CBO_CLEAN(base)                                         \
        INSN_I(OPCODE_MISC_MEM, FUNC3(2), __RD(0),              \
               RS1(base), SIMM12(1))

#define CBO_FLUSH(base)                                         \
        INSN_I(OPCODE_MISC_MEM, FUNC3(2), __RD(0),              \
               RS1(base), SIMM12(2))

#define CBO_ZERO(base)                                          \
        INSN_I(OPCODE_MISC_MEM, FUNC3(2), __RD(0),              \
               RS1(base), SIMM12(4))

#define PREFETCH_I(base, offset)                                \
        INSN_S(OPCODE_OP_IMM, FUNC3(6), __RS2(0),               \
               SIMM12((offset) & 0xfe0), RS1(base))

#define PREFETCH_R(base, offset)                                \
        INSN_S(OPCODE_OP_IMM, FUNC3(6), __RS2(1),               \
               SIMM12((offset) & 0xfe0), RS1(base))

#define PREFETCH_W(base, offset)                                \
        INSN_S(OPCODE_OP_IMM, FUNC3(6), __RS2(3),               \
               SIMM12((offset) & 0xfe0), RS1(base))

#define RISCV_PAUSE     ASM_INSN_I("0x100000f")
#define ZAWRS_WRS_NTO   ASM_INSN_I("0x00d00073")
#define ZAWRS_WRS_STO   ASM_INSN_I("0x01d00073")
#define RISCV_NOP4      ASM_INSN_I("0x00000013")

#define RISCV_INSN_NOP4 _AC(0x00000013, U)

#ifndef __ASSEMBLER__
#define nop()           __asm__ __volatile__ ("nop")
#define __nops(n)       ".rept  " #n "\nnop\n.endr\n"
#define nops(n)         __asm__ __volatile__ (__nops(n))
#endif

#endif /* __ASM_INSN_DEF_H */