core.h

Go to the documentation of this file.

/*
** Jo Sega Saturn Engine
** Copyright (c) 2012-2026, Johannes Fetz (johannesfetz@gmail.com)
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are met:
**     * Redistributions of source code must retain the above copyright
**       notice, this list of conditions and the following disclaimer.
**     * Redistributions in binary form must reproduce the above copyright
**       notice, this list of conditions and the following disclaimer in the
**       documentation and/or other materials provided with the distribution.
**     * Neither the name of the Johannes Fetz nor the
**       names of its contributors may be used to endorse or promote products
**       derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
** DISCLAIMED. IN NO EVENT SHALL Johannes Fetz BE LIABLE FOR ANY
** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef __JO_CORE_H__
# define __JO_CORE_H__
 
#ifdef JO_DEBUG

extern char     __jo_last_error[JO_PRINTF_BUF_SIZE];
void    __jo_core_error(char *message, const char *function);
void    __jo_core_errorf(const char *function, const char *format, ...) __attribute__((cold, noinline));
# define jo_core_error(...)     __jo_core_errorf(__FUNCTION__, __VA_ARGS__)
 
#endif

# define JO_ENGINE_VERSION  (2025.1)
 
/*
** TYPEDEFS
*/
typedef void    (*jo_event_callback)(void);

typedef void    (*jo_interrupt_handler)(void);
 
#ifdef JO_COMPILE_WITH_DUAL_CPU_SUPPORT

typedef void    (*jo_slave_callback)(void);
 
#endif

void    jo_core_init(const jo_color back_color);

void    jo_core_run(void);

int     jo_core_add_vblank_callback(const jo_event_callback callback);

void    jo_core_remove_vblank_callback(const int vblank_event_id);

int     jo_core_add_callback(const jo_event_callback callback);

void    jo_core_remove_callback(const int event_id);
 
#ifdef JO_COMPILE_WITH_DUAL_CPU_SUPPORT

int     jo_core_add_slave_callback(const jo_event_callback callback);

void    jo_core_remove_slave_callback(const int event_id);
 
#endif

void    jo_core_set_restart_game_callback(const jo_event_callback callback);

void    jo_goto_boot_menu(void);
 
#ifdef JO_COMPILE_WITH_DUAL_CPU_SUPPORT

void    jo_core_exec_on_slave(jo_slave_callback callback);

void    jo_core_wait_for_slave(void);

int     jo_core_slave_idle_time(void);

typedef void    (*jo_slave_job_function)(void *argument);

bool    __jo_core_is_slave_running(void);

void    __jo_core_add_slave_job(const jo_slave_job_function function, void *argument);
 
#endif

static  __jo_force_inline void jo_core_disable_reset(void)
{
    jo_smpc_begin_command();
    jo_smpc_end_command(DisableReset);
}

static  __jo_force_inline void jo_core_enable_reset(void)
{
    jo_smpc_begin_command();
    jo_smpc_end_command(EnableReset);
}

void    jo_core_tv_off(void);

void    jo_core_tv_on(void);

static  __jo_force_inline int      jo_core_get_refresh_rate(void)
{
    return ((JO_VDP2_TVSTAT & JO_VDP2_TVSTAT_PAL) ? 50 : 60);
}

static  __jo_force_inline void jo_core_exit_to_multiplayer(void)
{
 
    (**(void(**)(void))0x600026C)();
}

static  __jo_force_inline void jo_core_restart_saturn(void)
{
    jo_smpc_begin_command();
    jo_smpc_end_command(SystemReset);
}

#define                             jo_core_set_screens_order(screen1, args...) __jo_core_set_screens_order(screen1, ## args, ~0);
 
#ifdef JO_DEBUG

void    jo_core_suspend(void);

static  __jo_force_inline char * jo_get_last_error(void)
{
    return (__jo_last_error);
}

void                jo_dump_vdp1_registers(void);

void                jo_dump_vdp2_registers(void);
 
#endif

void                                __jo_core_set_screens_order(jo_scroll_screen screen1, ...);
 
/*
** Internal usage
*/

extern volatile unsigned int        __jo_core_vblank_count;

static  __jo_force_inline unsigned int  jo_core_get_vblank_count(void)
{
    return (__jo_core_vblank_count);
}

void                                __jo_core_synch(void);

void                                __jo_core_set_interrupt_handler(const unsigned int vector, jo_interrupt_handler handler);

void                                __jo_core_enable_scu_interrupts(const unsigned int mask);

void                                __jo_core_restore_scu_mask(void);

static  __jo_force_inline unsigned int  __jo_core_get_sr(void)
{
    unsigned int                    sr;
 
    __asm__ volatile ("stc sr, %0" : "=r" (sr));
    return (sr);
}

static  __jo_force_inline void      __jo_core_set_sr(const unsigned int sr)
{
    __asm__ volatile ("ldc %0, sr" : : "r" (sr) : "memory");
}

static  __jo_force_inline unsigned int  __jo_core_disable_interrupts(void)
{
    unsigned int                    sr;
 
    sr = __jo_core_get_sr();
    __jo_core_set_sr(sr | JO_SH2_SR_INTERRUPT_MASK);
    return (sr);
}

static  __jo_force_inline void      __jo_core_restore_interrupts(const unsigned int sr)
{
    __jo_core_set_sr(sr);
}
 
#endif /* !__JO_CORE_H__ */
 
/*
** END OF FILE
*/