system.h

Go to the documentation of this file.

/*-------------------------------------------------------------

system.h -- OS functions and initialization

Copyright (C) 2004
Michael Wiedenbauer (shagkur)
Dave Murphy (WinterMute)

This software is provided 'as-is', without any express or implied
warranty.  In no event will the authors be held liable for any
damages arising from the use of this software.

Permission is granted to anyone to use this software for any
purpose, including commercial applications, and to alter it and
redistribute it freely, subject to the following restrictions:

1.  The origin of this software must not be misrepresented; you
must not claim that you wrote the original software. If you use
this software in a product, an acknowledgment in the product
documentation would be appreciated but is not required.

2.  Altered source versions must be plainly marked as such, and
must not be misrepresented as being the original software.

3.  This notice may not be removed or altered from any source
distribution.


-------------------------------------------------------------*/


#ifndef __SYSTEM_H__
#define __SYSTEM_H__


#include <gctypes.h>
#include <gcutil.h>
#include <time.h>
#include <ogc/lwp_queue.h>
#include "gx_struct.h"

#define SYS_BASE_CACHED                 (0x80000000)
#define SYS_BASE_UNCACHED               (0xC0000000)

#define SYS_WD_NULL                     0xffffffff

#define SYS_RESTART                     0           
#define SYS_HOTRESET                    1           
#define SYS_SHUTDOWN                    2           
#define SYS_RETURNTOMENU                3           
#define SYS_POWEROFF                    4           
#define SYS_POWEROFF_STANDBY            5           
#define SYS_POWEROFF_IDLE               6           
#define SYS_PROTECTCHAN0                0           
#define SYS_PROTECTCHAN1                1           
#define SYS_PROTECTCHAN2                2           
#define SYS_PROTECTCHAN3                3           
#define SYS_PROTECTCHANMAX              4           
#define SYS_PROTECTNONE                 0x00000000      
#define SYS_PROTECTREAD                 0x00000001      
#define SYS_PROTECTWRITE                0x00000002      
#define SYS_PROTECTRDWR                 (SYS_PROTECTREAD|SYS_PROTECTWRITE)  
#define SYS_FONTSIZE_ANSI               (288 + 131072)
#define SYS_FONTSIZE_SJIS               (3840 + 1179648)



#define MEM_VIRTUAL_TO_PHYSICAL(x)      (((u32)(x)) & ~SYS_BASE_UNCACHED)                                   
#define MEM_PHYSICAL_TO_K0(x)           (void*)((u32)(x) + SYS_BASE_CACHED)                                 
#define MEM_PHYSICAL_TO_K1(x)           (void*)((u32)(x) + SYS_BASE_UNCACHED)                               
#define MEM_K0_TO_PHYSICAL(x)           (void*)((u32)(x) - SYS_BASE_CACHED)                                 
#define MEM_K1_TO_PHYSICAL(x)           (void*)((u32)(x) - SYS_BASE_UNCACHED)                               
#define MEM_K0_TO_K1(x)                 (void*)((u32)(x) + (SYS_BASE_UNCACHED - SYS_BASE_CACHED))           
#define MEM_K1_TO_K0(x)                 (void*)((u32)(x) - (SYS_BASE_UNCACHED - SYS_BASE_CACHED))           
#define SYS_GetArenaLo                  SYS_GetArena1Lo
#define SYS_SetArenaLo                  SYS_SetArena1Lo
#define SYS_GetArenaHi                  SYS_GetArena1Hi
#define SYS_SetArenaHi                  SYS_SetArena1Hi
#define SYS_GetArenaSize                SYS_GetArena1Size

#ifdef __cplusplus
   extern "C" {
#endif /* __cplusplus */


typedef u32 syswd_t;


typedef struct _syssram syssram;

struct _syssram {
    u16 checksum;
    u16 checksum_inv;
    u32 ead0;
    u32 ead1;
    u32 counter_bias;
    s8 display_offsetH;
    u8 ntd;
    u8 lang;
    u8 flags;
} ATTRIBUTE_PACKED;


typedef struct _syssramex syssramex;

struct _syssramex {
    u8 flash_id[2][12];
    u32 wirelessKbd_id;
    u16 wirelessPad_id[4];
    u8 dvderr_code;
    u8 __padding0;
    u16 flashID_chksum[2];
    u8 __padding1[4];
} ATTRIBUTE_PACKED;

typedef void (*alarmcallback)(syswd_t alarm,void *cb_arg);

typedef struct _sys_fontheader sys_fontheader;

struct _sys_fontheader {
    u16 font_type;
    u16 first_char;
    u16 last_char;
    u16 inval_char;
    u16 asc;
    u16 desc;
    u16 width;
    u16 leading;
    u16 cell_width;
    u16 cell_height;
    u32 sheet_size;
    u16 sheet_format;
    u16 sheet_column;
    u16 sheet_row;
    u16 sheet_width;
    u16 sheet_height;
    u16 width_table;
    u32 sheet_image;
    u32 sheet_fullsize;
    u8  c0;
    u8  c1;
    u8  c2;
    u8  c3;
} ATTRIBUTE_PACKED;

typedef void (*resetcallback)(void);
typedef void (*powercallback)(void);
typedef s32 (*resetfunction)(s32 final);
typedef struct _sys_resetinfo sys_resetinfo;

struct _sys_resetinfo {
    lwp_node node;
    resetfunction func;
    u32 prio;
};

void SYS_Init();


void* SYS_AllocateFramebuffer(GXRModeObj *rmode);


void SYS_ProtectRange(u32 chan,void *addr,u32 bytes,u32 cntrl);
void SYS_StartPMC(u32 mcr0val,u32 mcr1val);
void SYS_DumpPMC();
void SYS_StopPMC();


s32 SYS_CreateAlarm(syswd_t *thealarm);


s32 SYS_SetAlarm(syswd_t thealarm,const struct timespec *tp,alarmcallback cb,void *cbarg);


s32 SYS_SetPeriodicAlarm(syswd_t thealarm,const struct timespec *tp_start,const struct timespec *tp_period,alarmcallback cb,void *cbarg);


s32 SYS_RemoveAlarm(syswd_t thealarm);


s32 SYS_CancelAlarm(syswd_t thealarm);


void SYS_SetWirelessID(u32 chan,u32 id);
u32 SYS_GetWirelessID(u32 chan);
u32 SYS_GetFontEncoding();
u32 SYS_InitFont(sys_fontheader *font_data);
void SYS_GetFontTexture(s32 c,void **image,s32 *xpos,s32 *ypos,s32 *width);
void SYS_GetFontTexel(s32 c,void *image,s32 pos,s32 stride,s32 *width);
void SYS_ResetSystem(s32 reset,u32 reset_code,s32 force_menu);
void SYS_RegisterResetFunc(sys_resetinfo *info);
void SYS_UnregisterResetFunc(sys_resetinfo *info);
void SYS_SwitchFiber(u32 arg0,u32 arg1,u32 arg2,u32 arg3,u32 pc,u32 newsp);

void* SYS_GetArena1Lo();
void SYS_SetArena1Lo(void *newLo);
void* SYS_GetArena1Hi();
void SYS_SetArena1Hi(void *newHi);
u32 SYS_GetArena1Size();

resetcallback SYS_SetResetCallback(resetcallback cb);

u32 SYS_ResetButtonDown();

#if defined(HW_RVL)
u32 SYS_GetHollywoodRevision();
void* SYS_GetArena2Lo();
void SYS_SetArena2Lo(void *newLo);
void* SYS_GetArena2Hi();
void SYS_SetArena2Hi(void *newHi);
u32 SYS_GetArena2Size();
powercallback SYS_SetPowerCallback(powercallback cb);
#endif

/* \fn u64 SYS_Time()
\brief Returns the current time in ticks since 2000 (proper Dolphin/Wii time)
\return ticks since 2000
*/
u64 SYS_Time();

void kprintf(const char *str, ...);

#ifdef __cplusplus
   }
#endif /* __cplusplus */

#endif