periph_gba.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2023-2026 HAW Hamburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "assert.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define REG32(ADDR)            (*(uint32_t volatile(*))(ADDR))

#define REG16(ADDR)            (*(uint16_t volatile(*))(ADDR))

#define MEM16(ADDR)            ((uint16_t(*))(ADDR))

#define GBA_PTR_TO_IRQ_HANDLER REG32(0x3007ffc)

#define GBA_IE                 REG16(0x4000200)

#define GBA_IE_TIMERS          (0x0F << 3)

#define GBA_IF                 REG16(0x4000202)

#define GBA_IF_CLEAR_ALL       (0x3FFF)

#define GBA_IF_TIMERS          (0x0F << 3)

#define GBA_IME                REG16(0x4000208) /* Technically 32 bit reg, but only bit 0 is used */

#define GBA_TM0_CNT_L          REG16(0x4000100) 
#define GBA_TM0_CNT_H          REG16(0x4000102) 
#define GBA_TM1_CNT_L          REG16(0x4000104) 
#define GBA_TM1_CNT_H          REG16(0x4000106) 
#define GBA_TM2_CNT_L          REG16(0x4000108) 
#define GBA_TM2_CNT_H          REG16(0x400010A) 
#define GBA_TM3_CNT_L          REG16(0x400010C) 
#define GBA_TM3_CNT_H          REG16(0x400010E) 

#define GBA_TIMER_MAX_TICKS    (0xFFFF)

#define GBA_TIMER_FRQ_16K      (16400lu)    
#define GBA_TIMER_FRQ_65K      (65500lu)    
#define GBA_TIMER_FRQ_262K     (262200lu)   
#define GBA_TIMER_FRQ_16M      (16780000lu) 

typedef struct {
    uint16_t current_value; 
    uint16_t prescaler : 2; 
    uint16_t count_up_on_neighbour_overflow : 1; 
    uint16_t unused_3_5 : 3;                     
    uint16_t irq_enable : 1;  
    uint16_t run : 1;         
    uint16_t unused_8_15 : 8; 
} gba_timer;
/* I don't trust bit-fields over all compilers & toolchains */
static_assert(sizeof(gba_timer) == 4, "2 x Timer register should be 4 bytes");

typedef volatile gba_timer gba_timer_t;

#define GBA_TIMER_0          ((gba_timer_t *)0x4000100) 
#define GBA_TIMER_1          ((gba_timer_t *)0x4000104) 
#define GBA_TIMER_2          ((gba_timer_t *)0x4000108) 
#define GBA_TIMER_3          ((gba_timer_t *)0x400010C) 

#define GBA_SCREEN_WIDTH     (240) 
#define GBA_SCREEN_HEIGHT    (160) 

#define GBA_DISPCNT          REG16(0x4000000)

#define GBA_DISPCNT_BGMODE_0 0x0000 
#define GBA_DISPCNT_BGMODE_1 0x0001 
#define GBA_DISPCNT_BGMODE_2 0x0002 
#define GBA_DISPCNT_BGMODE_3 0x0003 
#define GBA_DISPCNT_BGMODE_4 0x0004 
#define GBA_DISPCNT_BGMODE_5 0x0005 
 
#define GBA_DISPCNT_SDBG_0   0x0100 
#define GBA_DISPCNT_SDBG_1   0x0200 
#define GBA_DISPCNT_SDBG_2   0x0400 
#define GBA_DISPCNT_SDBG_3   0x0800 
 
#define GBA_DISPCNT_SDOBJ    0x1000 

#define GBA_DISPSTAT         REG16(0x4000004)

#define GBA_BG0CNT           REG16(0x4000008) 
#define GBA_BG1CNT           REG16(0x400000a) 
#define GBA_BG2CNT           REG16(0x400000c) 
#define GBA_BG3CNT           REG16(0x400000e) 

#define GBA_VRAM_PALETTE     MEM16(0x5000000)

#define GBA_VRAM             MEM16(0x6000000)
 
#ifdef __cplusplus
}
#endif