This is the list of instructions supported by rgbasm(1), including a short description, the number of bytes needed to encode them and the number of CPU cycles at 1MHz (or 2MHz in GBC double speed mode) needed to complete them.
Instructons are documented according to the syntax accepted by rgbasm(1), which does not always match one-to-one with the way instructions are encoded.
Note: All arithmetic and logic instructions that use register A as a destination can omit the destination, since it is assumed to be register A by default. So the following two lines have the same effect:
OR A,B
OR B
Furthermore, the CPL instruction can take an optional A destination, since it can only be register A. So the following two lines have the same effect:
CPL
CPL A
List of abbreviations used in this document.
Add the value in r8 plus the carry flag to A.
Cycles: 1
Bytes: 1
Flags:
Add the byte pointed to by HL plus the carry flag to A.
Cycles: 2
Bytes: 1
Flags: See ADC A,r8
Add the value n8 plus the carry flag to A.
Cycles: 2
Bytes: 2
Flags: See ADC A,r8
Add the value in r8 to A.
Cycles: 1
Bytes: 1
Flags:
Add the byte pointed to by HL to A.
Cycles: 2
Bytes: 1
Flags: See ADD A,r8
Add the value n8 to A.
Cycles: 2
Bytes: 2
Flags: See ADD A,r8
Add the value in r16 to HL.
Cycles: 2
Bytes: 1
Flags:
Add the value in SP to HL.
Cycles: 2
Bytes: 1
Flags: See ADD HL,r16
Add the signed value e8 to SP.
Cycles: 4
Bytes: 2
Flags:
Set A to the bitwise AND between the value in r8 and A.
Cycles: 1
Bytes: 1
Flags:
Set A to the bitwise AND between the byte pointed to by HL and A.
Cycles: 2
Bytes: 1
Flags: See AND A,r8
Set A to the bitwise AND between the value n8 and A.
Cycles: 2
Bytes: 2
Flags: See AND A,r8
Test bit u3 in register r8, set the zero flag if bit not set.
Cycles: 2
Bytes: 2
Flags:
Test bit u3 in the byte pointed by HL, set the zero flag if bit not set.
Cycles: 3
Bytes: 2
Flags: See BIT u3,r8
Call address n16.
This pushes the address of the instruction after the CALL on the stack, such that RET can pop it later; then, it executes an implicit JP n16.
Cycles: 6
Bytes: 3
Flags: None affected.
Call address n16 if condition cc is met.
Cycles: 6 taken / 3 untaken
Bytes: 3
Flags: None affected.
Complement Carry Flag.
Cycles: 1
Bytes: 1
Flags:
ComPare the value in A with the value in r8.
This subtracts the value in r8 from A and sets flags accordingly, but discards the result.
Cycles: 1
Bytes: 1
Flags:
ComPare the value in A with the byte pointed to by HL.
This subtracts the byte pointed to by HL from A and sets flags accordingly, but discards the result.
Cycles: 2
Bytes: 1
Flags: See CP A,r8
ComPare the value in A with the value n8.
This subtracts the value n8 from A and sets flags accordingly, but discards the result.
Cycles: 2
Bytes: 2
Flags: See CP A,r8
ComPLement accumulator (A = ~A); also called bitwise NOT.
Cycles: 1
Bytes: 1
Flags:
Decimal Adjust Accumulator.
Designed to be used after performing an arithmetic instruction (ADD, ADC, SUB, SBC) whose inputs were in Binary-Coded Decimal (BCD), adjusting the result to likewise be in BCD.
The exact behavior of this instruction depends on the state of the subtract flag N:
Cycles: 1
Bytes: 1
Flags:
Decrement the value in register r8 by 1.
Cycles: 1
Bytes: 1
Flags:
Decrement the byte pointed to by HL by 1.
Cycles: 3
Bytes: 1
Flags: See DEC r8
Decrement the value in register r16 by 1.
Cycles: 2
Bytes: 1
Flags: None affected.
Decrement the value in register SP by 1.
Cycles: 2
Bytes: 1
Flags: None affected.
Disable Interrupts by clearing the IME flag.
Cycles: 1
Bytes: 1
Flags: None affected.
Enable Interrupts by setting the IME flag.
The flag is only set after the instruction following EI.
Cycles: 1
Bytes: 1
Flags: None affected.
Enter CPU low-power consumption mode until an interrupt occurs.
The exact behavior of this instruction depends on the state of the
IME flag, and whether interrupts are pending (i.e. whether
‘[IE] & [IF]’ is non-zero):
HALT when that
returns.HALT, but
the byte after it is read twice in a row (PC is not
incremented, due to a hardware bug).Cycles: -
Bytes: 1
Flags: None affected.
Increment the value in register r8 by 1.
Cycles: 1
Bytes: 1
Flags:
Increment the byte pointed to by HL by 1.
Cycles: 3
Bytes: 1
Flags: See INC r8
Increment the value in register r16 by 1.
Cycles: 2
Bytes: 1
Flags: None affected.
Increment the value in register SP by 1.
Cycles: 2
Bytes: 1
Flags: None affected.
Jump to address n16; effectively, copy n16 into PC.
Cycles: 4
Bytes: 3
Flags: None affected.
Jump to address n16 if condition cc is met.
Cycles: 4 taken / 3 untaken
Bytes: 3
Flags: None affected.
Jump to address in HL; effectively, copy the value in register HL into PC.
Cycles: 1
Bytes: 1
Flags: None affected.
Relative Jump to address n16.
The target address n16 is
encoded as a signed 8-bit offset from the address
immediately following the JR instruction, so it must
be between -128 and 127 bytes away. For
example:
JR Label ; no-op; encoded offset of 0
Label:
JR Label ; infinite loop; encoded offset of -2
Cycles: 3
Bytes: 2
Flags: None affected.
Relative Jump to address n16 if condition cc is met.
The target address n16 is
encoded as a signed 8-bit offset from the address
immediately following the JR instruction, so it must
be between -128 and 127 bytes away.
Cycles: 3 taken / 2 untaken
Bytes: 2
Flags: None affected.
Copy (aka Load) the value in register on the right into the register on the left.
Storing a register into itself is a no-op; however, some Game Boy emulators interpret LD B,B as a breakpoint, or LD D,D as a debug message (such as BGB).
Cycles: 1
Bytes: 1
Flags: None affected.
Copy the value n8 into register r8.
Cycles: 2
Bytes: 2
Flags: None affected.
Copy the value n16 into register r16.
Cycles: 3
Bytes: 3
Flags: None affected.
Copy the value in register r8 into the byte pointed to by HL.
Cycles: 2
Bytes: 1
Flags: None affected.
Copy the value n8 into the byte pointed to by HL.
Cycles: 3
Bytes: 2
Flags: None affected.
Copy the value pointed to by HL into register r8.
Cycles: 2
Bytes: 1
Flags: None affected.
Copy the value in register A into the byte pointed to by r16.
Cycles: 2
Bytes: 1
Flags: None affected.
Copy the value in register A into the byte at address n16.
Cycles: 4
Bytes: 3
Flags: None affected.
Copy the value in register A into the byte at address n16.
The destination address n16 is encoded as its 8-bit low byte and assumes a high byte of $FF, so it must be between $FF00 and $FFFF.
Cycles: 3
Bytes: 2
Flags: None affected.
Copy the value in register A into the byte at address $FF00+C.
Cycles: 2
Bytes: 1
Flags: None affected.
This is sometimes written as ‘LD
[$FF00+C],A’.
Copy the byte pointed to by r16 into register A.
Cycles: 2
Bytes: 1
Flags: None affected.
Copy the byte at address n16 into register A.
Cycles: 4
Bytes: 3
Flags: None affected.
Copy the byte at address n16 into register A.
The source address n16 is encoded as its 8-bit low byte and assumes a high byte of $FF, so it must be between $FF00 and $FFFF.
Cycles: 3
Bytes: 2
Flags: None affected.
Copy the byte at address $FF00+C into register A.
Cycles: 2
Bytes: 1
Flags: None affected.
This is sometimes written as ‘LD
A,[$FF00+C]’.
Copy the value in register A into the byte pointed by HL and increment HL afterwards.
Cycles: 2
Bytes: 1
Flags: None affected.
This is sometimes written as ‘LD
[HL+],A’, or ‘LDI
[HL],A’.
Copy the value in register A into the byte pointed by HL and decrement HL afterwards.
Cycles: 2
Bytes: 1
Flags: None affected.
This is sometimes written as ‘LD
[HL-],A’, or ‘LDD
[HL],A’.
Copy the byte pointed to by HL into register A, and decrement HL afterwards.
Cycles: 2
Bytes: 1
Flags: None affected.
This is sometimes written as ‘LD
A,[HL-]’, or ‘LDD
A,[HL]’.
Copy the byte pointed to by HL into register A, and increment HL afterwards.
Cycles: 2
Bytes: 1
Flags: None affected.
This is sometimes written as ‘LD
A,[HL+]’, or ‘LDI
A,[HL]’.
Copy the value n16 into register SP.
Cycles: 3
Bytes: 3
Flags: None affected.
Copy SP & $FF at address n16 and SP >> 8 at address n16 + 1.
Cycles: 5
Bytes: 3
Flags: None affected.
Add the signed value e8 to SP and copy the result in HL.
Cycles: 3
Bytes: 2
Flags:
Copy register HL into register SP.
Cycles: 2
Bytes: 1
Flags: None affected.
No OPeration.
Cycles: 1
Bytes: 1
Flags: None affected.
Set A to the bitwise OR between the value in r8 and A.
Cycles: 1
Bytes: 1
Flags:
Set A to the bitwise OR between the byte pointed to by HL and A.
Cycles: 2
Bytes: 1
Flags: See OR A,r8
Set A to the bitwise OR between the value n8 and A.
Cycles: 2
Bytes: 2
Flags: See OR A,r8
Pop register AF from the stack. This is roughly equivalent to the following imaginary instructions:
LD F, [SP] ; See below for individual flags
INC SP
LD A, [SP]
INC SP
Cycles: 3
Bytes: 1
Flags:
Pop register r16 from the stack. This is roughly equivalent to the following imaginary instructions:
LD LOW(r16), [SP] ; C, E or L
INC SP
LD HIGH(r16), [SP] ; B, D or H
INC SP
Cycles: 3
Bytes: 1
Flags: None affected.
Push register AF into the stack. This is roughly equivalent to the following imaginary instructions:
DEC SP
LD [SP], A
DEC SP
LD [SP], F.Z << 7 | F.N << 6 | F.H << 5 | F.C << 4
Cycles: 4
Bytes: 1
Flags: None affected.
Push register r16 into the stack. This is roughly equivalent to the following imaginary instructions:
DEC SP
LD [SP], HIGH(r16) ; B, D or H
DEC SP
LD [SP], LOW(r16) ; C, E or L
Cycles: 4
Bytes: 1
Flags: None affected.
Set bit u3 in register r8 to 0. Bit 0 is the rightmost one, bit 7 the leftmost one.
Cycles: 2
Bytes: 2
Flags: None affected.
Set bit u3 in the byte pointed by HL to 0. Bit 0 is the rightmost one, bit 7 the leftmost one.
Cycles: 4
Bytes: 2
Flags: None affected.
Return from subroutine. This is basically a POP PC (if such an instruction existed). See POP r16 for an explanation of how POP works.
Cycles: 4
Bytes: 1
Flags: None affected.
Return from subroutine if condition cc is met.
Cycles: 5 taken / 2 untaken
Bytes: 1
Flags: None affected.
Return from subroutine and enable interrupts. This is basically equivalent to executing EI then RET, meaning that IME is set right after this instruction.
Cycles: 4
Bytes: 1
Flags: None affected.
Rotate bits in register r8 left, through the carry flag.
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓ ┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐ │ ┗━━━━━━━━━┛ ┗━━━━━━━━━━━━━━━━━┛ │ └─────────────────────────────────┘
Cycles: 2
Bytes: 2
Flags:
Rotate the byte pointed to by HL left, through the carry flag.
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓ ┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐ │ ┗━━━━━━━━━┛ ┗━━━━━━━━━━━━━━━━━┛ │ └─────────────────────────────────┘
Cycles: 4
Bytes: 2
Flags: See RL r8
Rotate register A left, through the carry flag.
┏━ Flags ━┓ ┏━━━━━━━ A ━━━━━━━┓ ┌─╂─ C ←╂─╂─ b7 ← ... ← b0 ←╂─┐ │ ┗━━━━━━━━━┛ ┗━━━━━━━━━━━━━━━━━┛ │ └─────────────────────────────────┘
Cycles: 1
Bytes: 1
Flags:
Rotate register r8 left.
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
┗━━━━━━━━━┛ │ ┗━━━━━━━━━━━━━━━━━┛ │
└─────────────────────┘
Cycles: 2
Bytes: 2
Flags:
Rotate the byte pointed to by HL left.
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
┗━━━━━━━━━┛ │ ┗━━━━━━━━━━━━━━━━━┛ │
└─────────────────────┘
Cycles: 4
Bytes: 2
Flags: See RLC r8
Rotate register A left.
┏━ Flags ━┓ ┏━━━━━━━ A ━━━━━━━┓
┃ C ←╂─┬─╂─ b7 ← ... ← b0 ←╂─┐
┗━━━━━━━━━┛ │ ┗━━━━━━━━━━━━━━━━━┛ │
└─────────────────────┘
Cycles: 1
Bytes: 1
Flags:
Rotate register r8 right, through the carry flag.
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓ ┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐ │ ┗━━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━┛ │ └─────────────────────────────────┘
Cycles: 2
Bytes: 2
Flags:
Rotate the byte pointed to by HL right, through the carry flag.
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓ ┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐ │ ┗━━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━┛ │ └─────────────────────────────────┘
Cycles: 4
Bytes: 2
Flags: See RR r8
Rotate register A right, through the carry flag.
┏━━━━━━━ A ━━━━━━━┓ ┏━ Flags ━┓ ┌─╂→ b7 → ... → b0 ─╂─╂→ C ─╂─┐ │ ┗━━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━┛ │ └─────────────────────────────────┘
Cycles: 1
Bytes: 1
Flags:
Rotate register r8 right.
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓ ┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃ │ ┗━━━━━━━━━━━━━━━━━┛ │ ┗━━━━━━━━━┛ └─────────────────────┘
Cycles: 2
Bytes: 2
Flags:
Rotate the byte pointed to by HL right.
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓ ┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃ │ ┗━━━━━━━━━━━━━━━━━┛ │ ┗━━━━━━━━━┛ └─────────────────────┘
Cycles: 4
Bytes: 2
Flags: See RRC r8
Rotate register A right.
┏━━━━━━━ A ━━━━━━━┓ ┏━ Flags ━┓ ┌─╂→ b7 → ... → b0 ─╂─┬─╂→ C ┃ │ ┗━━━━━━━━━━━━━━━━━┛ │ ┗━━━━━━━━━┛ └─────────────────────┘
Cycles: 1
Bytes: 1
Flags:
Call address vec. This is a shorter and faster equivalent to CALL for suitable values of vec.
Cycles: 4
Bytes: 1
Flags: None affected.
Subtract the value in r8 and the carry flag from A.
Cycles: 1
Bytes: 1
Flags:
Subtract the byte pointed to by HL and the carry flag from A.
Cycles: 2
Bytes: 1
Flags: See SBC A,r8
Subtract the value n8 and the carry flag from A.
Cycles: 2
Bytes: 2
Flags: See SBC A,r8
Set Carry Flag.
Cycles: 1
Bytes: 1
Flags:
Set bit u3 in register r8 to 1. Bit 0 is the rightmost one, bit 7 the leftmost one.
Cycles: 2
Bytes: 2
Flags: None affected.
Set bit u3 in the byte pointed by HL to 1. Bit 0 is the rightmost one, bit 7 the leftmost one.
Cycles: 4
Bytes: 2
Flags: None affected.
Shift Left Arithmetically register r8.
┏━ Flags ━┓ ┏━━━━━━━ r8 ━━━━━━┓ ┃ C ←╂─╂─ b7 ← ... ← b0 ←╂─ 0 ┗━━━━━━━━━┛ ┗━━━━━━━━━━━━━━━━━┛
Cycles: 2
Bytes: 2
Flags:
Shift Left Arithmetically the byte pointed to by HL.
┏━ Flags ━┓ ┏━━━━━━ [HL] ━━━━━┓ ┃ C ←╂─╂─ b7 ← ... ← b0 ←╂─ 0 ┗━━━━━━━━━┛ ┗━━━━━━━━━━━━━━━━━┛
Cycles: 4
Bytes: 2
Flags: See SLA r8
Shift Right Arithmetically register r8 (bit 7 of r8 is unchanged).
┏━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓ ┃ b7 → ... → b0 ─╂─╂→ C ┃ ┗━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━┛
Cycles: 2
Bytes: 2
Flags:
Shift Right Arithmetically the byte pointed to by HL (bit 7 of the byte pointed to by HL is unchanged).
┏━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓ ┃ b7 → ... → b0 ─╂─╂→ C ┃ ┗━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━┛
Cycles: 4
Bytes: 2
Flags: See SRA r8
Shift Right Logically register r8.
┏━━━━━━━ r8 ━━━━━━┓ ┏━ Flags ━┓ 0 ─╂→ b7 → ... → b0 ─╂─╂→ C ┃ ┗━━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━┛
Cycles: 2
Bytes: 2
Flags:
Shift Right Logically the byte pointed to by HL.
┏━━━━━━ [HL] ━━━━━┓ ┏━ Flags ━┓ 0 ─╂→ b7 → ... → b0 ─╂─╂→ C ┃ ┗━━━━━━━━━━━━━━━━━┛ ┗━━━━━━━━━┛
Cycles: 4
Bytes: 2
Flags: See SRL r8
Enter CPU very low power mode. Also used to switch between GBC double speed and normal speed CPU modes.
The exact behavior of this instruction is fragile and may interpret its second byte as a separate instruction (see the Pan Docs), which is why rgbasm(1) allows explicitly specifying the second byte (STOP n8) to override the default of $00 (a NOP instruction).
Cycles: -
Bytes: 2
Flags: None affected.
Subtract the value in r8 from A.
Cycles: 1
Bytes: 1
Flags:
Subtract the byte pointed to by HL from A.
Cycles: 2
Bytes: 1
Flags: See SUB A,r8
Subtract the value n8 from A.
Cycles: 2
Bytes: 2
Flags: See SUB A,r8
Swap the upper 4 bits in register r8 and the lower 4 ones.
Cycles: 2
Bytes: 2
Flags:
Swap the upper 4 bits in the byte pointed by HL and the lower 4 ones.
Cycles: 4
Bytes: 2
Flags: See SWAP r8
Set A to the bitwise XOR between the value in r8 and A.
Cycles: 1
Bytes: 1
Flags:
Set A to the bitwise XOR between the byte pointed to by HL and A.
Cycles: 2
Bytes: 1
Flags: See XOR A,r8
Set A to the bitwise XOR between the value n8 and A.
Cycles: 2
Bytes: 2
Flags: See XOR A,r8
rgbasm(1), rgblink(1), rgbfix(1), rgbgfx(1), rgbasm-old(5), rgbds(7)
rgbasm(1) was originally written by Carsten Sørensen as part of the ASMotor package, and was later repackaged in RGBDS by Justin Lloyd. It is now maintained by a number of contributors at https://github.com/gbdev/rgbds.