/* Copyright (c) 2024 Freya Murphy */ #ifndef __MIPS_H__ #define __MIPS_H__ #include #include /* all mips registers $0-$31 */ enum mips_register { MIPS_REG_ZERO = 0, MIPS_REG_AT = 1, MIPS_REG_V0 = 2, MIPS_REG_V1 = 3, MIPS_REG_A0 = 4, MIPS_REG_A1 = 5, MIPS_REG_A2 = 6, MIPS_REG_A3 = 7, MIPS_REG_T0 = 8, MIPS_REG_T1 = 9, MIPS_REG_T2 = 10, MIPS_REG_T3 = 11, MIPS_REG_T4 = 12, MIPS_REG_T5 = 13, MIPS_REG_T6 = 14, MIPS_REG_T7 = 15, MIPS_REG_S0 = 16, MIPS_REG_S1 = 17, MIPS_REG_S2 = 18, MIPS_REG_S3 = 19, MIPS_REG_S4 = 20, MIPS_REG_S5 = 21, MIPS_REG_S6 = 22, MIPS_REG_S7 = 23, MIPS_REG_T8 = 24, MIPS_REG_T9 = 25, MIPS_REG_K0 = 26, MIPS_REG_K1 = 27, MIPS_REG_GP = 28, MIPS_REG_SP = 29, MIPS_REG_FP = 30, MIPS_REG_RA = 31, }; /* mips instruction format */ enum mips_instruction_format { MIPS_FORMAT_R, MIPS_FORMAT_I, MIPS_FORMAT_J, MIPS_FORMAT_B, }; /* mips instructions */ enum mips_instruction_type { MIPS_INS_ADD, MIPS_INS_ADDI, MIPS_INS_ADDIU, MIPS_INS_ADDU, MIPS_INS_AND, MIPS_INS_ANDI, MIPS_INS_BAL, MIPS_INS_BALC, MIPS_INS_BC, MIPS_INS_BEQ, MIPS_INS_BEQL, MIPS_INS_BGEZ, MIPS_INS_BGEZAL, MIPS_INS_BGEZALL, MIPS_INS_BGEZL, MIPS_INS_BGTZ, MIPS_INS_BGTZL, MIPS_INS_BLEZ, MIPS_INS_BLEZL, MIPS_INS_BLTZ, MIPS_INS_BLTZAL, MIPS_INS_BLTZALL, MIPS_INS_BLTZL, MIPS_INS_BNE, MIPS_INS_BNEL, MIPS_INS_DDIV, MIPS_INS_DDIVU, MIPS_INS_DIV, MIPS_INS_DIVU, MIPS_INS_J, MIPS_INS_JAL, MIPS_INS_JALR, MIPS_INS_JALX, MIPS_INS_JR, MIPS_INS_LB, MIPS_INS_LBU, MIPS_INS_LH, MIPS_INS_LHU, MIPS_INS_LUI, MIPS_INS_LW, MIPS_INS_LWL, MIPS_INS_LWR, MIPS_INS_MFHI, MIPS_INS_MFLO, MIPS_INS_MTHI, MIPS_INS_MTLO, MIPS_INS_MULT, MIPS_INS_MULTU, MIPS_INS_SB, MIPS_INS_SH, MIPS_INS_SW, MIPS_INS_SWL, MIPS_INS_SWR, MIPS_INS_SLL, MIPS_INS_SLLV, MIPS_INS_SLT, MIPS_INS_SLTI, MIPS_INS_SLTIU, MIPS_INS_SLTU, MIPS_INS_SRA, MIPS_INS_SRAV, MIPS_INS_SRL, MIPS_INS_SRLV, MIPS_INS_SUB, MIPS_INS_SUBU, MIPS_INS_SYSCALL, MIPS_INS_OR, MIPS_INS_ORI, MIPS_INS_NOR, MIPS_INS_XOR, MIPS_INS_XORI, // gets the size of the enum __MIPS_INS_LEN, }; /* mips instruction R TYPE */ struct mips_instruction_r_data { uint32_t funct : 6; uint32_t shamt : 5; uint32_t rd : 5; uint32_t rt : 5; uint32_t rs : 5; uint32_t op : 6; } __attribute__((packed)); /* mips instruction I TYPE */ struct mips_instruction_i_data { uint32_t immd : 16; uint32_t rt : 5; uint32_t rs : 5; uint32_t op : 6; } __attribute__((packed)); /* mips instruction J TYPE */ struct mips_instruction_j_data { uint32_t target : 26; uint32_t op : 6; } __attribute__((packed)); /* mips instruction BRANCH TYPE */ struct mips_instruction_branch_data { int32_t offset : 16; uint32_t funct : 5; uint32_t rs : 5; uint32_t op : 6; } __attribute__((packed)); /* mips instruction information */ struct mips_instruction { // metadata enum mips_instruction_type type; enum mips_instruction_format format; const char *name; // data union { uint32_t data; struct mips_instruction_r_data R_data; struct mips_instruction_i_data I_data; struct mips_instruction_j_data J_data; struct mips_instruction_branch_data B_data; } __attribute__((packed)); }; #define MIPS_INS(ins, format, ...) \ [MIPS_INS_ ##ins] = { \ MIPS_INS_ ##ins, \ MIPS_FORMAT_ ##format, \ #ins, \ .format##_data = { __VA_ARGS__ } \ }, \ static const struct mips_instruction mips_instructions[] = { /* ADD - add */ #define MIPS_OP_SPECIAL 0b000000 #define MIPS_FUNCT_ADD 0b100000 MIPS_INS(ADD, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_ADD) /* ADDI - add immediate */ #define MIPS_OP_ADDI 0b001000 MIPS_INS(ADDI, I, .op = MIPS_OP_ADDI) /* ADDIU - add immediate unsigned */ #define MIPS_OP_ADDIU 0b001001 MIPS_INS(ADDIU, I, .op = MIPS_OP_ADDIU) /* ADDU - add unsigned */ #define MIPS_FUNCT_ADDU 0b100001 MIPS_INS(ADDU, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_ADDU) /* AND - and */ #define MIPS_FUNCT_AND 0b100100 MIPS_INS(AND, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_AND) /* ANDI - and immediate */ #define MIPS_OP_ANDI 0b001100 MIPS_INS(ANDI, I, .op = MIPS_OP_ANDI) /* BAL - branch and link */ #define MIPS_OP_REGIMM 0b000001 #define MIPS_FUNCT_BAL 0b10001 MIPS_INS(BAL, B, .op = MIPS_OP_REGIMM, .funct = MIPS_FUNCT_BAL) /* BALC - branch and link, compact */ #define MIPS_OP_BALC 0b111010 MIPS_INS(BALC, J, .op = MIPS_OP_BALC) /* BC - branch, compact */ #define MIPS_OP_BC 0b110010 MIPS_INS(BC, J, .op = MIPS_OP_BC) /* BEQ - branch on equal */ #define MIPS_OP_BEQ 0b000100 MIPS_INS(BEQ, I, .op = MIPS_OP_BEQ) /* BEQL - branch on equal likely */ #define MIPS_OP_BEQL 0b010100 MIPS_INS(BEQL, I, .op = MIPS_OP_BEQL) /* BGEZ - branch on greater than or equal to zero */ #define MIPS_FUNCT_BGEZ 0b00001 MIPS_INS(BGEZ, B, .op = MIPS_OP_REGIMM, .funct = MIPS_FUNCT_BGEZ) /* BGEZAL - branch on greater than or equal to zero and link */ #define MIPS_FUNCT_BGEZAL 0b10001 MIPS_INS(BGEZAL, B, .op = MIPS_OP_REGIMM, .funct = MIPS_FUNCT_BGEZAL) /* BGEZAL - branch on greater than or equal to zero and link likely */ #define MIPS_FUNCT_BGEZALL 0b10011 MIPS_INS(BGEZALL, B, .op = MIPS_OP_REGIMM, .funct = MIPS_FUNCT_BGEZALL) /* BGEZL - branch on greater than or equal to zero likely */ #define MIPS_FUNCT_BGEZL 0b00011 MIPS_INS(BGEZL, B, .op = MIPS_OP_REGIMM, .funct = MIPS_FUNCT_BGEZL) /* BGTZ - branch on greater than zero */ #define MIPS_OP_BGTZ 0b000111 MIPS_INS(BGTZ, I, .op = MIPS_OP_BGTZ) /* BGTZL - branch on greater than zero likely */ #define MIPS_OP_BGTZL 0b010111 MIPS_INS(BGTZL, I, .op = MIPS_OP_BGTZL) /* BLEZ - branch on less than or equal to zero */ #define MIPS_OP_BLEZ 0b000110 MIPS_INS(BLEZ, I, .op = MIPS_OP_BLEZ) /* BLEZL - branch on less than or equal to zero likely */ #define MIPS_OP_BLEZL 0b010110 MIPS_INS(BLEZL, I, .op = MIPS_OP_BLEZL) /* BLTZ - branch on less than zero */ #define MIPS_FUNCT_BLTZ 0b00000 MIPS_INS(BLTZ, B, .op = MIPS_OP_REGIMM, .funct = MIPS_FUNCT_BLTZ) /* BLTZAL - branch on less than zero and link */ #define MIPS_FUNCT_BLTZAL 0b10000 MIPS_INS(BLTZAL, B, .op = MIPS_OP_REGIMM, .funct = MIPS_FUNCT_BLTZAL) /* BLTZALL - branch on less than zero and link likely */ #define MIPS_FUNCT_BLTZALL 0b10010 MIPS_INS(BLTZALL, B, .op = MIPS_OP_REGIMM, .funct = MIPS_FUNCT_BLTZALL) /* BLTZL - branch on less than zero likely */ #define MIPS_FUNCT_BLTZL 0b00010 MIPS_INS(BLTZL, B, .op = MIPS_OP_REGIMM, .funct = MIPS_FUNCT_BLTZL) /* BNE - branch on not equal */ #define MIPS_OP_BNE 0b000101 MIPS_INS(BNE, I, .op = MIPS_OP_BNE) /* BNEL - branch on not equal likely */ #define MIPS_OP_BNEL 0b010101 MIPS_INS(BNEL, I, .op = MIPS_OP_BNEL) /* DDIV - doubleword divide */ #define MIPS_FUNCT_DDIV 0b011110 MIPS_INS(DDIV, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_DDIV) /* DDIVU - doubleword divide unsigned */ #define MIPS_FUNCT_DDIVU 0b011111 MIPS_INS(DDIVU, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_DDIVU) /* DIV - divide */ #define MIPS_FUNCT_DIV 0b011010 MIPS_INS(DIV, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_DIV) /* DIVU - divide unsigned */ #define MIPS_FUNCT_DIVU 0b011011 MIPS_INS(DIVU, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_DIVU) /* J - jump */ #define MIPS_OP_J 0b000010 MIPS_INS(J, J, .op = MIPS_OP_J) /* JAL - jump and link */ #define MIPS_OP_JAL 0b000011 MIPS_INS(JAL, J, .op = MIPS_OP_JAL) /* JALR - jump and link register */ #define MIPS_FUNCT_JALR 0b001001 MIPS_INS(JALR, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_JALR) /* JALX - jump and link exchange */ #define MIPS_OP_JALX 0b011101 MIPS_INS(JALX, J, .op = MIPS_OP_JALX) /* JR - jump register */ #define MIPS_FUNCT_JR 0b001000 MIPS_INS(JR, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_JR) /* LB - load byte */ #define MIPS_OP_LB 0b100000 MIPS_INS(LB, I, .op = MIPS_OP_LB) /* LBU - load byte unsigned */ #define MIPS_OP_LBU 0b100100 MIPS_INS(LBU, I, .op = MIPS_OP_LBU) /* LH - load half */ #define MIPS_OP_LH 0b100001 MIPS_INS(LH, I, .op = MIPS_OP_LH) /* LHU - load half unsigned */ #define MIPS_OP_LHU 0b100101 MIPS_INS(LHU, I, .op = MIPS_OP_LHU) /* LUI - load upper immediate */ #define MIPS_OP_LUI 0b001111 MIPS_INS(LUI, I, .op = MIPS_OP_LUI) /* LW - load word */ #define MIPS_OP_LW 0b100011 MIPS_INS(LW, I, .op = MIPS_OP_LW) /* LWL - load word left */ #define MIPS_OP_LWL 0b100010 MIPS_INS(LWL, I, .op = MIPS_OP_LWL) /* LWR - load word right */ #define MIPS_OP_LWR 0b100110 MIPS_INS(LWR, I, .op = MIPS_OP_LWR) /* MFHI - move from hi */ #define MIPS_FUNCT_MFHI 0b010000 MIPS_INS(MFHI, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_MFHI) /* MFLO - move from hi */ #define MIPS_FUNCT_MFLO 0b010010 MIPS_INS(MFLO, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_MFLO) /* MTHI - move from hi */ #define MIPS_FUNCT_MTHI 0b010001 MIPS_INS(MTHI, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_MTHI) /* MTLO - move from hi */ #define MIPS_FUNCT_MTLO 0b010011 MIPS_INS(MTLO, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_MTLO) /* MULT - multiply */ #define MIPS_FUNCT_MULT 0b011000 MIPS_INS(MULT, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_MULT) /* MULTU - multiply unsigned */ #define MIPS_FUNCT_MULTU 0b011001 MIPS_INS(MULTU, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_MULTU) /* SB - store byte */ #define MIPS_OP_SB 0b101000 MIPS_INS(SB, I, .op = MIPS_OP_SB) /* SH - store half */ #define MIPS_OP_SH 0b101001 MIPS_INS(SH, I, .op = MIPS_OP_SH) /* SW - store word */ #define MIPS_OP_SW 0b101011 MIPS_INS(SW, I, .op = MIPS_OP_SW) /* SWL - store word left */ #define MIPS_OP_SWL 0b101010 MIPS_INS(SWL, I, .op = MIPS_OP_SWL) /* SWR - store word right */ #define MIPS_OP_SWR 0b101110 MIPS_INS(SWR, I, .op = MIPS_OP_SWR) /* SLL - shift left logical */ #define MIPS_FUNCT_SLL 0b000000 MIPS_INS(SLL, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_SLL) /* SLLV - shift left logical variable */ #define MIPS_FUNCT_SLLV 0b000100 MIPS_INS(SLLV, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_SLLV) /* SLT - set less then */ #define MIPS_FUNCT_SLT 0b101010 MIPS_INS(SLT, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_SLT) /* SLTI - set less then immediate */ #define MIPS_OP_SLTI 0b001010 MIPS_INS(SLTI, I, .op = MIPS_OP_SLTI) /* SLTIU - set less then imemdiate unsigned */ #define MIPS_OP_SLTIU 0b001011 MIPS_INS(SLTIU, I, .op = MIPS_OP_SLTIU) /* SLTU - set less than unsigned */ #define MIPS_FUNCT_SLTU 0b101011 MIPS_INS(SLTU, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_SLTU) /* SRA - shift right arithmetic */ #define MIPS_FUNCT_SRA 0b000011 MIPS_INS(SRA, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_SRA) /* SRAV - shift right arithmetic variable */ #define MIPS_FUNCT_SRAV 0b000111 MIPS_INS(SRAV, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_SRAV) /* SRL - shift right logical */ #define MIPS_FUNCT_SRL 0b000010 MIPS_INS(SRL, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_SRL) /* SRLV - shift right logical variable */ #define MIPS_FUNCT_SRLV 0b000110 MIPS_INS(SRLV, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_SRLV) /* SUB - subtract */ #define MIPS_FUNCT_SUB 0b100010 MIPS_INS(SUB, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_SUB) /* SUBU - subtract unsigned */ #define MIPS_FUNCT_SUBU 0b100011 MIPS_INS(SUBU, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_SUBU) /* SYSCALL - syscall */ #define MIPS_FUNCT_SYSCALL 0b001100 MIPS_INS(SYSCALL, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_SYSCALL) /* OR - or */ #define MIPS_FUNCT_OR 0b100101 MIPS_INS(OR, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_OR) /* ORI - or imemdiate */ #define MIPS_OP_ORI 0b001101 MIPS_INS(ORI, I, .op = MIPS_OP_ORI) /* NOR - not or */ #define MIPS_FUNCT_NOR 0b100111 MIPS_INS(NOR, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_NOR) /* XOR - exclusive or */ #define MIPS_FUNCT_XOR 0b100110 MIPS_INS(XOR, R, .op = MIPS_OP_SPECIAL, .funct = MIPS_FUNCT_XOR) /* XORI - exclusive or immediate */ #define MIPS_OP_XORI 0b001110 MIPS_INS(XORI, I, .op = MIPS_OP_XORI) }; #undef MIPS_INS /* mips directive types */ enum mips_directive_type { MIPS_DIRECTIVE_ALIGN, MIPS_DIRECTIVE_SPACE, MIPS_DIRECTIVE_WORD, MIPS_DIRECTIVE_HALF, MIPS_DIRECTIVE_BYTE, MIPS_DIRECTIVE_SECTION, MIPS_DIRECTIVE_EXTERN, MIPS_DIRECTIVE_GLOBL, }; /* mip32 directive */ struct mips_directive { enum mips_directive_type type; uint32_t len; // used for words, halfs, bytes union { uint16_t align; uint16_t space; uint32_t words[MAX_ARG_LENGTH]; uint16_t halfs[MAX_ARG_LENGTH]; uint8_t bytes[MAX_ARG_LENGTH]; char name[MAX_ARG_LENGTH]; }; }; #endif /* __MIPS_H__ */