GBDK 2020 Docs  4.2.0
API Documentation for GBDK 2020
msx.h
Go to the documentation of this file.
1 
4 #ifndef _MSX_H
5 #define _MSX_H
6 
7 #include <types.h>
8 #include <stdint.h>
9 #include <gbdk/version.h>
10 #include <msx/hardware.h>
11 
12 #define MSX
13 
14 // Here NINTENDO means Game Boy & related clones
15 #ifdef NINTENDO
16 #undef NINTENDO
17 #endif
18 
19 #ifdef NINTENDO_NES
20 #undef NINTENDO_NES
21 #endif
22 
23 #ifdef SEGA
24 #undef SEGA
25 #endif
26 
27 #if defined(__TARGET_msxdos)
28 #define MSXDOS
29 #endif
30 
31 
32 #define VBK_REG VDP_ATTR_SHIFT
33 
47 #define J_UP 0b00100000
48 #define J_DOWN 0b01000000
49 #define J_LEFT 0b00010000
50 #define J_RIGHT 0b10000000
51 #define J_A 0b00000001
52 #define J_B 0b00000100
53 #define J_SELECT 0b00001000
54 #define J_START 0b00000010
55 
60 #define M_TEXT_OUT 0x02U
61 #define M_TEXT_INOUT 0x03U
67 #define M_NO_SCROLL 0x04U
71 #define M_NO_INTERP 0x08U
72 
75 #define S_FLIPX 0x02U
78 #define S_FLIPY 0x04U
81 #define S_PALETTE 0x08U
84 #define S_PRIORITY 0x10U
88 #define S_PAL(n) n
89 
90 // VDP helper macros
91 #define __WRITE_VDP_REG(REG, v) shadow_##REG=(v);__critical{VDP_CMD=(shadow_##REG),VDP_CMD=REG;}
92 #define __READ_VDP_REG(REG) shadow_##REG
93 
96 
104 
110 
111 /* Interrupt flags */
114 #define EMPTY_IFLAG 0x00U
120 #define VBL_IFLAG 0x01U
124 #define LCD_IFLAG 0x02U
127 #define TIM_IFLAG 0x04U
130 #define SIO_IFLAG 0x08U
133 #define JOY_IFLAG 0x10U
134 
136 
137 /* Limits */
140 #define SCREENWIDTH DEVICE_SCREEN_PX_WIDTH
143 #define SCREENHEIGHT DEVICE_SCREEN_PX_HEIGHT
146 #define MINWNDPOSX 0x00U
149 #define MINWNDPOSY 0x00U
152 #define MAXWNDPOSX 0x00U
155 #define MAXWNDPOSY 0x00U
156 
157 
160 typedef void (*int_handler)(void) NONBANKED;
161 
166 
171 
175 
179 
183 
187 
191 
195 
199  return VDP_STATUS;
200 }
201 
202 inline void move_bkg(uint8_t x, uint8_t y) {
205 }
206 
207 inline void scroll_bkg(int8_t x, int8_t y) {
209  int16_t tmp = __READ_VDP_REG(VDP_RSCY) + y;
210  __WRITE_VDP_REG(VDP_RSCY, (tmp < 0) ? 224 + tmp : tmp % 224u);
211 }
212 
223 void vsync(void) PRESERVES_REGS(b, c, d, e, h, l, iyh, iyl);
224 
227 void wait_vbl_done(void) PRESERVES_REGS(b, c, d, e, h, l, iyh, iyl);
228 
233 inline void display_off(void) {
235 }
236 
240 #define DISPLAY_ON \
241  __WRITE_VDP_REG(VDP_R1, __READ_VDP_REG(VDP_R1) |= R1_DISP_ON)
242 
246 #define DISPLAY_OFF \
247  display_off();
248 
251 void refresh_OAM(void);
252 
256 #define HIDE_LEFT_COLUMN \
257  __WRITE_VDP_REG(VDP_R0, __READ_VDP_REG(VDP_R0) |= R0_LCB)
258 
262 #define SHOW_LEFT_COLUMN \
263  __WRITE_VDP_REG(VDP_R0, __READ_VDP_REG(VDP_R0) &= (~R0_LCB))
264 
268 #define SHOW_BKG
269 
273 #define HIDE_BKG
274 
278 #define SHOW_WIN
279 
283 #define HIDE_WIN
284 
288 #define SHOW_SPRITES
289 
293 #define HIDE_SPRITES
294 
297 #define SPRITES_16x16 \
298  __WRITE_VDP_REG(VDP_R1, __READ_VDP_REG(VDP_R1) |= R1_SPR_16X16)
299 
302 #define SPRITES_8x8 \
303  __WRITE_VDP_REG(VDP_R1, __READ_VDP_REG(VDP_R1) &= (~R1_SPR_16X16))
304 
308 #define DEVICE_SUPPORTS_COLOR (TRUE)
309 
316 extern volatile uint16_t sys_time;
317 
320 extern volatile uint8_t _current_bank;
321 #define CURRENT_BANK _current_bank
322 
332 #ifndef BANK
333 #define BANK(VARNAME) ( (uint8_t) & __bank_ ## VARNAME )
334 #endif
335 
348 #define BANKREF(VARNAME) void __func_ ## VARNAME(void) __banked __naked { \
349 __asm \
350  .local b___func_ ## VARNAME \
351  ___bank_ ## VARNAME = b___func_ ## VARNAME \
352  .globl ___bank_ ## VARNAME \
353 __endasm; \
354 }
355 
365 #define BANKREF_EXTERN(VARNAME) extern const void __bank_ ## VARNAME;
366 
367 
373 #define SWITCH_ROM1 SWITCH_ROM
374 
379 #define SWITCH_ROM2(b) MAP_FRAME2=(b)
380 
385 #define SWITCH_RAM(b) RAM_CONTROL=((b)&1)?RAM_CONTROL|RAMCTL_BANK:RAM_CONTROL&(~RAMCTL_BANK)
386 
390 #define ENABLE_RAM RAM_CONTROL|=RAMCTL_RAM
391 
395 #define DISABLE_RAM RAM_CONTROL&=(~RAMCTL_RAM)
396 
397 
403 
404 
408 
412 
418 void waitpadup(void) PRESERVES_REGS(b, c, d, e, iyh, iyl);
419 
425 typedef struct {
426  uint8_t npads;
427  union {
428  struct {
429  uint8_t joy0, joy1, joy2, joy3;
430  };
431  uint8_t joypads[4];
432  };
433 } joypads_t;
434 
444 
452 
453 
454 #if defined(__TARGET_msxdos)
455 
456 #define RGB(r,g,b) ((r) | ((g) << 2) | ((b) << 4))
457 #define RGB8(r,g,b) (((r) >> 6) | (((g) >> 6) << 2) | (((b) >> 6) << 4))
458 #define RGBHTML(RGB24bit) (((RGB24bit) >> 22) | ((((RGB24bit) & 0xFFFF) >> 14) << 2) | ((((RGB24bit) & 0xFF) >> 6) << 4))
459 
462 #define RGB_RED RGB( 3, 0, 0)
463 #define RGB_DARKRED RGB( 2, 0, 0)
464 #define RGB_GREEN RGB( 0, 3, 0)
465 #define RGB_DARKGREEN RGB( 0, 2, 0)
466 #define RGB_BLUE RGB( 0, 0, 3)
467 #define RGB_DARKBLUE RGB( 0, 0, 2)
468 #define RGB_YELLOW RGB( 3, 3, 0)
469 #define RGB_DARKYELLOW RGB( 2, 2, 0)
470 #define RGB_CYAN RGB( 0, 3, 3)
471 #define RGB_AQUA RGB( 3, 1, 2)
472 #define RGB_PINK RGB( 3, 0, 3)
473 #define RGB_PURPLE RGB( 2, 0, 2)
474 #define RGB_BLACK RGB( 0, 0, 0)
475 #define RGB_DARKGRAY RGB( 1, 1, 1)
476 #define RGB_LIGHTGRAY RGB( 2, 2, 2)
477 #define RGB_WHITE RGB( 3, 3, 3)
478 
479 typedef uint8_t palette_color_t;
480 
481 #else
482 #error Unrecognized port
483 #endif
484 
486 inline void cpu_fast(void) {}
487 
489 #define set_bkg_palette_entry set_palette_entry
490 #define set_sprite_palette_entry(palette,entry,rgb_data) set_palette_entry(1,entry,rgb_data)
491 void set_palette(uint8_t first_palette, uint8_t nb_palettes, const palette_color_t *rgb_data) Z88DK_CALLEE;
492 #define set_bkg_palette set_palette
493 #define set_sprite_palette(first_palette,nb_palettes,rgb_data) set_palette(1,1,rgb_data)
494 
495 void set_native_tile_data(uint16_t start, uint16_t ntiles, const void *src) Z88DK_CALLEE;
496 inline void set_bkg_4bpp_data(uint16_t start, uint16_t ntiles, const void *src) {
497  set_native_tile_data(start, ntiles, src);
498 }
499 void set_sprite_1bpp_data(uint16_t start, uint16_t ntiles, const void *src) Z88DK_CALLEE;
500 inline void set_native_sprite_data(uint16_t start, uint16_t ntiles, const void *src) {
501  set_sprite_1bpp_data(start, ntiles, src);
502 }
503 
504 #define COMPAT_PALETTE(C0,C1,C2,C3) (((uint16_t)(C3) << 12) | ((uint16_t)(C2) << 8) | ((uint16_t)(C1) << 4) | (uint16_t)(C0))
506 inline void set_2bpp_palette(uint16_t palette) {
507  _current_2bpp_palette = palette;
508 }
509 //void set_tile_2bpp_data(uint16_t start, uint16_t ntiles, const void *src, uint16_t palette) Z88DK_CALLEE PRESERVES_REGS(iyh, iyl);
510 inline void set_bkg_data(uint16_t start, uint16_t ntiles, const void *src) {
511  set_native_tile_data(start, ntiles, src);
512 }
513 inline void set_sprite_data(uint16_t start, uint16_t ntiles, const void *src) {
514  set_sprite_1bpp_data(start, ntiles, src);
515 }
516 //inline void set_bkg_2bpp_data(uint16_t start, uint16_t ntiles, const void *src) {
517 // set_tile_2bpp_data(start, ntiles, src, _current_2bpp_palette);
518 //}
519 //inline void set_sprite_2bpp_data(uint16_t start, uint16_t ntiles, const void *src) {
520 // set_tile_2bpp_data((uint8_t)(start) + 0x100u, ntiles, src, _current_2bpp_palette);
521 //}
522 
524 inline void set_1bpp_colors(uint8_t fgcolor, uint8_t bgcolor) {
525  _current_1bpp_colors = ((uint16_t)bgcolor << 8) | fgcolor;
526 }
527 void set_tile_1bpp_data(uint16_t start, uint16_t ntiles, const void *src, uint16_t colors) Z88DK_CALLEE PRESERVES_REGS(iyh, iyl);
528 inline void set_bkg_1bpp_data(uint16_t start, uint16_t ntiles, const void *src) {
529  set_tile_1bpp_data(start, ntiles, src, _current_1bpp_colors);
530 }
531 
532 
541 void set_data(uint16_t dst, const void *src, uint16_t size) Z88DK_CALLEE PRESERVES_REGS(iyh, iyl);
542 void vmemcpy(uint16_t dst, const void *src, uint16_t size) Z88DK_CALLEE PRESERVES_REGS(iyh, iyl);
543 
545 #define set_bkg_tiles set_tile_map
546 #define set_win_tiles set_tile_map
547 
549 inline void set_bkg_based_tiles(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *tiles, uint8_t base_tile) {
550  _map_tile_offset = base_tile;
551  set_tile_map(x, y, w, h, tiles);
552  _map_tile_offset = 0;
553 }
554 inline void set_win_based_tiles(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *tiles, uint8_t base_tile) {
555  _map_tile_offset = base_tile;
556  set_tile_map(x, y, w, h, tiles);
557  _map_tile_offset = 0;
558 }
559 
562 inline void set_bkg_submap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *map, uint8_t map_w) {
563  set_tile_submap_compat(x, y, w, h, map_w, map);
564 }
565 inline void set_win_submap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *map, uint8_t map_w) {
566  set_tile_submap_compat(x, y, w, h, map_w, map);
567 }
568 
570 inline void set_bkg_based_submap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *map, uint8_t map_w, uint8_t base_tile) {
571  _submap_tile_offset = base_tile;
572  set_tile_submap_compat(x, y, w, h, map_w, map);
574 }
575 inline void set_win_based_submap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *map, uint8_t map_w, uint8_t base_tile) {
576  _submap_tile_offset = base_tile;
577  set_tile_submap_compat(x, y, w, h, map_w, map);
579 }
580 
582 #define fill_bkg_rect fill_rect
583 #define fill_win_rect fill_rect
584 
591 typedef struct OAM_item_t {
592  uint8_t y, x; //< X, Y Coordinates of the sprite on screen
593  uint8_t tile; //< Sprite tile number
594  uint8_t prop; //< OAM Property Flags
596 
597 
600 extern volatile struct OAM_item_t shadow_OAM[];
601 
604 extern volatile uint8_t _shadow_OAM_base;
605 
630 extern volatile uint8_t _shadow_OAM_OFF;
631 
634 #define DISABLE_VBL_TRANSFER \
635  _shadow_OAM_base = 0
636 
639 #define ENABLE_VBL_TRANSFER \
640  _shadow_OAM_base = (uint8_t)((uint16_t)&shadow_OAM >> 8)
641 
644 #define MAX_HARDWARE_SPRITES 32
645 
648 #define HARDWARE_SPRITE_CAN_FLIP_X 0
649 
652 #define HARDWARE_SPRITE_CAN_FLIP_Y 0
653 
656 inline void SET_SHADOW_OAM_ADDRESS(void * address) {
657  _shadow_OAM_base = (uint8_t)((uint16_t)address >> 8);
658 }
659 
677  shadow_OAM[nb].tile=tile;
678 }
679 
680 
688  return shadow_OAM[nb].tile;
689 }
690 
692  shadow_OAM[nb].prop = prop;
693 }
694 
696  return shadow_OAM[nb].prop;
697 }
698 
711 inline void move_sprite(uint8_t nb, uint8_t x, uint8_t y) {
712  OAM_item_t * itm = &shadow_OAM[nb];
713  itm->y=y, itm->x=x;
714 }
715 
716 
727 inline void scroll_sprite(uint8_t nb, int8_t x, int8_t y) {
728  OAM_item_t * itm = &shadow_OAM[nb];
729  itm->y+=y, itm->x+=x;
730 }
731 
732 
737 inline void hide_sprite(uint8_t nb) {
738  shadow_OAM[nb].y = 0xC0;
739 }
740 
748 
757 
766 #define set_bkg_tile_xy set_tile_xy
767 #define set_win_tile_xy set_tile_xy
768 
773 #define get_win_xy_addr get_bkg_xy_addr
774 
775 #endif /* _MSX_H */
#define OLDCALL
Definition: types.h:21
#define NONBANKED
Definition: types.h:40
#define PRESERVES_REGS(...)
Definition: types.h:32
#define Z88DK_CALLEE
Definition: types.h:45
#define Z88DK_FASTCALL
Definition: types.h:46
uint16_t palette_color_t
Definition: cgb.h:85
void b
Definition: gb.h:691
#define VDP_RSCY
Definition: hardware.h:133
#define VDP_R1
Definition: hardware.h:73
#define VDP_RSCX
Definition: hardware.h:128
#define R1_DISP_ON
Definition: hardware.h:78
void set_sprite_tile(uint8_t nb, uint8_t tile)
Definition: msx.h:676
volatile uint8_t _current_bank
Definition: gb.h:493
void d
Definition: msx.h:94
void c
Definition: msx.h:94
void set_bkg_submap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *map, uint8_t map_w)
Definition: msx.h:562
void set_tile_map(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *tiles) Z88DK_CALLEE PRESERVES_REGS(iyh
void set_win_based_submap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *map, uint8_t map_w, uint8_t base_tile)
Definition: msx.h:575
void joypad_ex(joypads_t *joypads) Z88DK_FASTCALL PRESERVES_REGS(iyh
void h
Definition: msx.h:223
void scroll_bkg(int8_t x, int8_t y)
Definition: msx.h:207
void set_sprite_data(uint16_t start, uint16_t ntiles, const void *src)
Definition: msx.h:513
void delay(uint16_t d) Z88DK_FASTCALL
uint16_t _current_2bpp_palette
uint16_t _current_1bpp_colors
void set_default_palette(void)
void set_palette_entry(uint8_t palette, uint8_t entry, uint16_t rgb_data) Z88DK_CALLEE PRESERVES_REGS(iyh
void add_SIO(int_handler h) Z88DK_FASTCALL
void vmemcpy(uint16_t dst, const void *src, uint16_t size) Z88DK_CALLEE PRESERVES_REGS(iyh
void remove_JOY(int_handler h) Z88DK_FASTCALL
volatile struct OAM_item_t shadow_OAM[]
volatile uint8_t _shadow_OAM_OFF
void mode(uint8_t m) OLDCALL
void set_native_sprite_data(uint16_t start, uint16_t ntiles, const void *src)
Definition: msx.h:500
uint8_t * set_attributed_tile_xy(uint8_t x, uint8_t y, uint16_t t) Z88DK_CALLEE PRESERVES_REGS(iyh
void add_JOY(int_handler h) Z88DK_FASTCALL
void WRITE_VDP_CMD(uint16_t cmd) Z88DK_FASTCALL PRESERVES_REGS(b
void set_bkg_1bpp_data(uint16_t start, uint16_t ntiles, const void *src)
Definition: msx.h:528
void add_LCD(int_handler h) Z88DK_FASTCALL PRESERVES_REGS(b
volatile uint8_t _shadow_OAM_base
Definition: gb.h:1753
uint8_t * set_tile_xy(uint8_t x, uint8_t y, uint8_t t) Z88DK_CALLEE PRESERVES_REGS(iyh
void set_sprite_1bpp_data(uint16_t start, uint16_t ntiles, const void *src) Z88DK_CALLEE
Definition: sms.h:580
uint8_t joypad(void) OLDCALL PRESERVES_REGS(b
void move_bkg(uint8_t x, uint8_t y)
Definition: msx.h:202
uint8_t * get_bkg_xy_addr(uint8_t x, uint8_t y) Z88DK_CALLEE PRESERVES_REGS(iyh
uint8_t get_sprite_prop(uint8_t nb)
Definition: msx.h:695
void scroll_sprite(uint8_t nb, int8_t x, int8_t y)
Definition: msx.h:727
void add_TIM(int_handler h) Z88DK_FASTCALL
uint8_t get_mode(void) OLDCALL
void set_win_based_tiles(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *tiles, uint8_t base_tile)
Definition: msx.h:554
void set_tile_1bpp_data(uint16_t start, uint16_t ntiles, const void *src, uint16_t colors) Z88DK_CALLEE PRESERVES_REGS(iyh
volatile uint16_t sys_time
uint8_t waitpad(uint8_t mask) Z88DK_FASTCALL PRESERVES_REGS(b
void SET_SHADOW_OAM_ADDRESS(void *address)
Definition: msx.h:656
void set_bkg_based_tiles(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *tiles, uint8_t base_tile)
Definition: msx.h:549
void set_bkg_data(uint16_t start, uint16_t ntiles, const void *src)
Definition: msx.h:510
void wait_vbl_done(void) PRESERVES_REGS(b
void set_tile_submap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, uint8_t map_w, const uint8_t *map) Z88DK_CALLEE PRESERVES_REGS(iyh
void cpu_fast(void)
Definition: msx.h:486
struct OAM_item_t OAM_item_t
void set_data(uint16_t dst, const void *src, uint16_t size) Z88DK_CALLEE PRESERVES_REGS(iyh
void(* int_handler)(void) NONBANKED
Definition: msx.h:160
#define __READ_VDP_REG(REG)
Definition: msx.h:92
void remove_TIM(int_handler h) Z88DK_FASTCALL
void remove_SIO(int_handler h) Z88DK_FASTCALL
void remove_VBL(int_handler h) Z88DK_FASTCALL PRESERVES_REGS(iyh
void set_sprite_prop(uint8_t nb, uint8_t prop)
Definition: msx.h:691
void set_2bpp_palette(uint16_t palette)
Definition: msx.h:506
void WRITE_VDP_DATA(uint16_t data) Z88DK_FASTCALL PRESERVES_REGS(b
#define __WRITE_VDP_REG(REG, v)
Definition: msx.h:91
uint8_t _map_tile_offset
void remove_LCD(int_handler h) Z88DK_FASTCALL PRESERVES_REGS(b
void iyh
Definition: msx.h:94
void move_sprite(uint8_t nb, uint8_t x, uint8_t y)
Definition: msx.h:711
uint8_t _submap_tile_offset
void set_tile_submap_compat(uint8_t x, uint8_t y, uint8_t w, uint8_t h, uint8_t map_w, const uint8_t *map) Z88DK_CALLEE PRESERVES_REGS(iyh
void fill_rect(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint16_t tile) Z88DK_CALLEE PRESERVES_REGS(iyh
void set_win_submap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *map, uint8_t map_w)
Definition: msx.h:565
void set_bkg_based_submap(uint8_t x, uint8_t y, uint8_t w, uint8_t h, const uint8_t *map, uint8_t map_w, uint8_t base_tile)
Definition: msx.h:570
uint8_t joypad_init(uint8_t npads, joypads_t *joypads) Z88DK_CALLEE
void refresh_OAM(void)
void waitpadup(void) PRESERVES_REGS(b
void SWITCH_ROM(uint8_t bank) Z88DK_FASTCALL PRESERVES_REGS(b
void hide_sprite(uint8_t nb)
Definition: msx.h:737
void set_1bpp_colors(uint8_t fgcolor, uint8_t bgcolor)
Definition: msx.h:524
uint8_t cancel_pending_interrupts(void)
Definition: msx.h:198
void add_VBL(int_handler h) Z88DK_FASTCALL PRESERVES_REGS(d
void set_native_tile_data(uint16_t start, uint16_t ntiles, const void *src) Z88DK_CALLEE
void e
Definition: msx.h:94
void set_interrupts(uint8_t flags) Z88DK_FASTCALL
void set_bkg_4bpp_data(uint16_t start, uint16_t ntiles, const void *src)
Definition: msx.h:496
void iyl
Definition: msx.h:94
void set_palette(uint8_t first_palette, uint8_t nb_palettes, const palette_color_t *rgb_data) Z88DK_CALLEE
void vsync(void) PRESERVES_REGS(b
uint8_t get_sprite_tile(uint8_t nb)
Definition: msx.h:687
void l
Definition: msx.h:223
void set_vram_byte(uint8_t *addr, uint8_t v) Z88DK_CALLEE PRESERVES_REGS(iyh
void display_off(void)
Definition: msx.h:233
short int int16_t
Definition: stdint.h:44
unsigned char uint8_t
Definition: stdint.h:51
unsigned short int uint16_t
Definition: stdint.h:52
signed char int8_t
Definition: stdint.h:43
Definition: gb.h:1740
uint8_t x
Definition: gb.h:1741
uint8_t prop
Definition: gb.h:1743
uint8_t tile
Definition: gb.h:1742
uint8_t y
Definition: gb.h:1741
Definition: gb.h:698