SGDK
A free and open development kit for the Sega Mega Drive
Loading...
Searching...
No Matches
sys.h
Go to the documentation of this file.
1
9
10#ifndef _SYS_H_
11#define _SYS_H_
12
13
14#define PROCESS_PALETTE_FADING (1 << 0)
15#define PROCESS_BITMAP_TASK (1 << 1)
16#define PROCESS_DMA_TASK (1 << 2)
17#define PROCESS_VDP_SCROLL_TASK (1 << 3)
18
19
20#define ROM_ALIGN_BIT 17
21#define ROM_ALIGN (1 << ROM_ALIGN_BIT)
22#define ROM_ALIGN_MASK (ROM_ALIGN - 1)
23
24#define ROM_START ROM
25#define ROM_END (((u32) &_stext) + ((u32) &_sdata))
26#define ROM_SIZE ((ROM_END + ROM_ALIGN_MASK) & (~ROM_ALIGN_MASK))
27
32#define FORCE_INLINE inline __attribute__((always_inline))
33
38#define NO_INLINE __attribute__((noinline))
39
44#define RAM_SECT __attribute__((section(".ramprog")))
45
50#define HINTERRUPT_CALLBACK __attribute__((interrupt)) void
51
56#define PACKED __attribute__((__packed__))
57
58
59// exist through rom_head.c
60typedef struct
61{
62 char console[16]; /* Console Name (16) */
63 char copyright[16]; /* Copyright Information (16) */
64 char title_local[48]; /* Domestic Name (48) */
65 char title_int[48]; /* Overseas Name (48) */
66 char serial[14]; /* Serial Number (2, 12) */
67 u16 checksum; /* Checksum (2) */
68 char IOSupport[16]; /* I/O Support (16) */
69 u32 rom_start; /* ROM Start Address (4) */
70 u32 rom_end; /* ROM End Address (4) */
71 u32 ram_start; /* Start of Backup RAM (4) */
72 u32 ram_end; /* End of Backup RAM (4) */
73 char sram_sig[2]; /* "RA" for save ram (2) */
74 u16 sram_type; /* 0xF820 for save ram on odd bytes (2) */
75 u32 sram_start; /* SRAM start address - normally 0x200001 (4) */
76 u32 sram_end; /* SRAM end address - start + 2*sram_size (4) */
77 char modem_support[12]; /* Modem Support (24) */
78 char notes[40]; /* Memo (40) */
79 char region[16]; /* Country Support (16) */
80} ROMHeader;
81
82extern const ROMHeader rom_header;
83
84// size of text segment --> start of initialized data (RO)
85extern u32 _stext;
86// size of initialized data segment
87extern u32 _sdata;
88
93typedef enum
94{
95 IMMEDIATELY,
99
100#if LEGACY_ERROR_HANDLER
107extern VoidCallback *busErrorCB;
114extern VoidCallback *addressErrorCB;
121extern VoidCallback *illegalInstCB;
128extern VoidCallback *zeroDivideCB;
135extern VoidCallback *chkInstCB;
142extern VoidCallback *trapvInstCB;
149extern VoidCallback *privilegeViolationCB;
156extern VoidCallback *traceCB;
163extern VoidCallback *line1x1xCB;
170extern VoidCallback *errorExceptionCB;
171#endif
172
179extern VoidCallback *intCB;
180
181
196void SYS_reset(void);
203void SYS_hardReset(void);
204
222bool SYS_doVBlankProcess(void);
254
263bool SYS_nextFrame(void);
264
270
297
317
331void SYS_disableInts(void);
341void SYS_enableInts(void);
342
358void SYS_setVBlankCallback(VoidCallback *CB);
359
378void SYS_setVIntCallback(VoidCallback *CB);
397void SYS_setHIntCallback(VoidCallback *CB);
408void SYS_setExtIntCallback(VoidCallback *CB);
409
416bool SYS_isInVInt(void);
417
424u16 SYS_isNTSC(void);
431u16 SYS_isPAL(void);
432
440u32 SYS_getFPS(void);
459u16 SYS_getCPULoad(void);
480void SYS_showFrameLoad(bool mean);
487void SYS_hideFrameLoad(void);
488
499bool SYS_isChecksumOk(void);
500
509void SYS_die(char *err, ...);
510
511#endif // _SYS_H_
Definition sys.h:61
u16 SYS_getAndSetInterruptMaskLevel(u16 value)
Set the interrupt mask level to given value and return previous level.
u32 SYS_getStackPointer()
Returns the current value of the stack pointer register (A7)
void SYS_enableInts(void)
Re-enable interrupts (Vertical, Horizontal and External).
Definition sys.c:802
void SYS_disableInts(void)
Disable interrupts (Vertical, Horizontal and External).
Definition sys.c:774
VoidCallback * intCB
Level interrupt callback.
void SYS_hardReset(void)
Hard reset.
void SYS_assertReset(void)
Assert reset.
void SYS_setHIntCallback(VoidCallback *CB)
Set 'Horizontal Interrupt' callback method (need to be prefixed by HINTERRUPT_CALLBACK).
Definition sys.c:842
bool SYS_doVBlankProcess(void)
Wait for start of VBlank and do all the VBlank processing (DMA transfers, XGM driver tempo,...
Definition sys.c:634
void SYS_showFrameLoad(bool mean)
Show a cursor indicating current frame load level in scanline (top = 0% load, bottom = 100% load)
Definition sys.c:860
u16 SYS_isPAL(void)
Return != 0 if we are on a PAL system.
Definition sys.c:900
void SYS_setInterruptMaskLevel(u16 value)
Set interrupt mask level.
u16 SYS_computeChecksum(void)
Computes full ROM checksum and return it. The checksum is a custom fast 32 bit checksum converted to...
Definition sys.c:985
u32 SYS_getFPS(void)
Returns number of Frame Per Second.
Definition sys.c:906
u16 SYS_getCPULoad(void)
Return an estimation of CPU frame load (in %)
Definition sys.c:979
fix32 SYS_getFPSAsFloat(void)
Returns number of Frame Per Second (fix32 form).
Definition sys.c:924
void SYS_setExtIntCallback(VoidCallback *CB)
Set External interrupt callback method.
Definition sys.c:848
void SYS_reset(void)
Soft reset.
void SYS_setVBlankCallback(VoidCallback *CB)
Set user 'Vertical Blank' callback method.
Definition sys.c:830
bool SYS_nextFrame(void)
End the current frame (alias for SYS_doVBlankProcess(void)).
Definition sys.c:769
void SYS_hideFrameLoad(void)
Hide the frame load cursor previously enabled using SYS_showFrameLoad() method.
Definition sys.c:877
VBlankProcessTime
Define at which period to do VBlank process (see SYS_doVBlankProcess() method)
Definition sys.h:94
@ ON_VBLANK
Definition sys.h:96
@ ON_VBLANK_START
Definition sys.h:97
bool SYS_doVBlankProcessEx(VBlankProcessTime processTime)
Do all the VBlank processing (DMA transfers, XGM driver tempo, Joypad pooling..)
Definition sys.c:639
void SYS_setVIntCallback(VoidCallback *CB)
Set 'Vertical Interrupt' callback method, prefer SYS_setVBlankCallback(..) when possible.
Definition sys.c:836
bool SYS_getShowFrameLoad()
Returns TRUE if frame load is currently displayed, FALSE otherwise.
Definition sys.c:855
void SYS_die(char *err,...)
Die with the specified error message. Program execution is interrupted. Accepts a list of strings....
Definition sys.c:1024
bool SYS_isInVInt(void)
Return TRUE if we are in the V-Interrupt process.
Definition sys.c:890
u16 SYS_getInterruptMaskLevel(void)
Return current interrupt mask level.
bool SYS_isChecksumOk(void)
Returns TRUE if ROM checksum is ok (correspond to rom_head.checksum field)
Definition sys.c:1015
u16 SYS_isNTSC(void)
Return != 0 if we are on a NTSC system.
Definition sys.c:895
unsigned long u32
Definition types.h:105
unsigned short u16
Definition types.h:100
s32 fix32
Definition types.h:215