GBDK 2020 Docs
API Documentation for GBDK 2020
Using GBDK

Interrupts

Interrupts allow execution to jump to a different part of your code as soon as an external event occurs - for example the LCD entering the vertical blank period, serial data arriving or the timer reaching its end count. For an example see the irq.c sample project.

Interrupts in GBDK are handled using the functions disable_interrupts(), enable_interrupts(), set_interrupts(uint8_t ier) and the interrupt service routine (ISR) linkers add_VBL(), add_TIM, add_LCD, add_SIO and add_JOY which add interrupt handlers for the vertical blank, timer, LCD, serial link and joypad interrupts respectively.

Since an interrupt can occur at any time an Interrupt Service Request (ISR) cannot take any arguments or return anything. Its only way of communicating with the greater program is through the global variables. When interacting with those shared ISR global variables from main code outside the interrupt, it is a good idea to wrap them in a critical {} section in case the interrupt occurs and modifies the variable while it is being used.

Interrupts should be disabled before adding ISRs. To use multiple interrupts, logical OR the relevant IFLAGs together.

ISRs should be kept as small and short as possible, do not write an ISR so long that the Game Boy hardware spends all of its time servicing interrupts and has no time spare for the main code.

For more detail on the Game Boy interrupts consider reading about them in the Pandocs.

Available Interrupts

The GameBoy hardware can generate 5 types of interrupts. Custom Interrupt Service Routines (ISRs) can be added in addition to the built-in ones available in GBDK.

Adding your own interrupt handler

It is possible to install your own interrupt handlers (in C or in assembly) for any of these interrupts. Up to 4 chained handlers may be added, with the last added being called last. If the remove_VBL() function is to be called, only three may be added for VBL.

Interrupt handlers are called in sequence. To install a new interrupt handler, do the following:

  1. Write a function (say foo()) that takes no parameters, and that returns nothing. Remember that the code executed in an interrupt handler must be short.
  2. Inside a __critical { ... } section, install your interrupt handling routines using the add_XXX() function, where XXX is the interrupt that you want to handle.
  3. Enable interrupts for the IRQ you want to handle, using the set_interrupts() function. Note that the VBL interrupt is already enabled before the main() function is called. If you want to set the interrupts before main() is called, you must install an initialization routine.

See the irq example project for additional details for a complete example.

Using your own Interrupt Dispatcher

If you want to use your own Interrupt Dispatcher instead of the GBDK chained dispatcher (for improved performance), then don't call the add_...() function for the respective interrupt and it's dispatcher won't be installed.

  • Exception: the VBL dispatcher will always be linked in at compile time.
  • For the SIO interrupt, also do not make any standard SIO calls to avoid having it's dispatcher installed.

Then, ISR_VECTOR() or ISR_NESTED_VECTOR() can be used to install a custom ISR handler.

Returning from Interrupts and STAT mode

By default when an Interrupt handler completes and is ready to exit it will check STAT_REG and only return at the BEGINNING of either LCD Mode 0 or Mode 1. This helps prevent graphical glitches caused when an ISR interrupts a graphics operation in one mode but returns in a different mode for which that graphics operation is not allowed.

You can change this behavior using nowait_int_handler() which does not check STAT_REG before returning. Also see wait_int_handler().

What GBDK does automatically and behind the scenes

OAM (VRAM Sprite Attribute Table)

GBDK sets up a Shadow OAM which gets copied automatically to the hardware OAM by the default V-Blank ISR. The Shadow OAM allows updating sprites without worrying about whether it is safe to write to them or not based on the hardware LCD mode.

Font tiles when using stdio.h

Including stdio.h and using functions such as printf() will use a large number of the background tiles for font characters. If stdio.h is not included then that space will be available for use with other tiles instead.

Default Interrupt Service Handlers (ISRs)

  • V-Blank: A default V-Blank ISR is installed on startup which copies the Shadow OAM to the hardware OAM and increments the global sys_time variable once per frame.
  • Serial Link I/O: If any of the GBDK serial link functions are used such as send_byte() and receive_byte(), the default SIO serial link handler will be installed automatically at compile-time.

Copying Functions to RAM and HIRAM

The ram_function example project included with GBDK demonstrates copying functions to RAM and HIRAM.

It is possible to copy functions to RAM and HIRAM (using the memcpy() and hiramcpy() functions), and execute them from C. The compiler automatically generates two symbols for the start and the end of each function, named start_X and end_X (where X is the name of the function). This enables to calculate the length of a function when copying it to RAM. Ensure you have enough free space in RAM or HIRAM for copying a function.

There are basically two ways for calling a function located in RAM, HIRAM, or ROM:

  • Declare a pointer-to-function variable, and set it to the address of the function to call.
  • Declare the function as extern, and set its address at link time using the -Wl-gXXX=# flag (where XXX is the name of the function, and # is its address).

The second approach is slightly more efficient. Both approaches are demonstrated in the ram_function.c example.

Mixing C and Assembly

You can mix C and assembly (ASM) in two ways as described below. For additional detail see the links_sdcc_docs.

Inline ASM within C source files

Example:

   __asm__("nop");

Another Example:

  void some_c_function() 
  {
    // Optionally do something
    __asm
        (ASM code goes here)
    __endasm;
  }

In Separate ASM files

Todo:
This is from GBDK 2.x docs, verify it with GBDK-2020 and modern SDCC

It is possible to assemble and link files written in ASM alongside files written in C.

  • A C identifier i will be called _i in assembly.
  • Results are always returned into the DE register.
  • Parameters are passed on the stack (starting at SP+2 because the return address is also saved on the stack).
  • Assembly identifier are exported using the .globl directive.
  • You can access GameBoy hardware registers using _reg_0xXX where XX is the register number (see sound.c for an example).
  • Registers must be preserved across function calls (you must store them at function begin, and restore them at the end), except HL (and DE when the function returns a result).

Here is an example of how to mix assembly with C:

main.c

main()
{
  int16_t i;
  int16_t add(int16_t, int16_t);

  i = add(1, 3);
}

add.s

.globl _add
_add:         ; int16_t add(int16_t a, int16_t b)
              ; There is no register to save:
              ;  BC is not used
              ;  DE is the return register
              ;  HL needs never to be saved
LDA  HL,2(SP)
LD   E,(HL)   ; Get a in DE
INC  HL
LD   D,(HL)
INC  HL
LD   A,(HL)   ; Get b in HL
INC  HL
LD   H,(HL)
LD   L,A
ADD  HL,DE    ; Add DE to HL
LD   D,H
LD   E,L
              ; There is no register to restore
RET           ; Return result in DE

Including binary files in C source with incbin

Data from binary files can be included in C source files as a const array using the INCBIN() macro.

See the incbin example project for a demo of how to use it.

Known Issues and Limitations

SDCC

  • Const arrays declared with somevar[n] = {x} will NOT get initialized with value x. This may change when the SDCC RLE initializer is fixed. Use memset for now if you need it.
  • SDCC banked calls and far_pointers in GBDK only save one byte for the ROM bank, so for example they are limtied to bank 15 max for MBC1 and bank 255 max for MBC5. See banked_calls for more details.