loadcore.h

Go to the documentation of this file.

/*
# _____     ___ ____     ___ ____
#  ____|   |    ____|   |        | |____|
# |     ___|   |____ ___|    ____| |    \    PS2DEV Open Source Project.
#-----------------------------------------------------------------------
# Copyright (c) 2003 Marcus R. Brown <mrbrown@0xd6.org>
# Licenced under Academic Free License version 2.0
# Review ps2sdk README & LICENSE files for further details.
*/

 
#ifndef __LOADCORE_H__
#define __LOADCORE_H__
 
#include <types.h>
#include <irx.h>
 
#define MODULE_RESIDENT_END     0
#define MODULE_NO_RESIDENT_END  1
#define MODULE_REMOVABLE_END    2 // Only for 'modload' > v1.2
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct _ModuleInfo {
    struct _ModuleInfo *next;
    char    *name;
    u16 version;
    u16 newflags;
    u16 id;
    u16 flags;
    u32 entry;
    u32 gp;
    u32 text_start;
    u32 text_size;
    u32 data_size;
    u32 bss_size;
    u32 unused1;
    u32 unused2;
} ModuleInfo_t;
 
typedef struct _IopModuleID {
    const char *name;
    unsigned short int version;
} IopModuleID_t;
 
typedef struct _FileInfo {
    u32 ModuleType;
    void *EntryPoint;
    void *gp;
    void *text_start;
    u32 text_size;
    u32 data_size;
    u32 bss_size;
    u32 MemSize;
    IopModuleID_t *mod_id;
} FileInfo_t;
 
typedef struct _iop_library {
    struct  _iop_library *prev;
    struct  irx_import_table *caller;
    u16 version;
    u16 flags;
    char    name[8];
    void    *exports[];
} iop_library_t;

typedef struct tag_LC_internals {
    iop_library_t* let_next, *let_prev; //let_next = tail, let_prev = head. I don't know what "let" and "mda" stand for.
    iop_library_t* mda_next, *mda_prev;
    ModuleInfo_t *image_info;
    int module_count;
    int module_index;
    /* The following members may change depending on the version of the module. */
    void *reboot_handlers;
    void *intr_suspend_tbl;
    int bootmodes[16];
    int bootmodes_size;
} lc_internals_t;
 
typedef struct {
    u16 value;
    u8  id;
    u8  len;
    u32 data[];
} iop_bootmode_t;
 
 
typedef struct{ //FIXME: Incomplete structure definition. Provided only for compatibility, as I don't know what the full structure is like.
    void *callback;
}iop_init_entry_t;
 
typedef int (*BootupCallback_t)(iop_init_entry_t* next, int delayed);

typedef struct {
    struct  _iop_library *tail;
    struct  _iop_library *head;
} iop_library_table_t __attribute__ ((deprecated));

extern iop_library_table_t *GetLibraryEntryTable(void) __attribute__ ((deprecated));
extern lc_internals_t *GetLoadcoreInternalData(void);
 
extern void FlushIcache(void);
extern void FlushDcache(void);
 
extern int RegisterLibraryEntries(struct irx_export_table *exports);
extern int ReleaseLibraryEntries(struct irx_export_table *exports);
 
// In liberx, the following is LinkLibraryClients
extern int LinkLibraryEntries(void* addr, int size);
// In liberx, the following is UnLinkLibraryClients
extern int UnLinkLibraryEntries(void* addr, int size);
 
extern int RegisterNonAutoLinkEntries(struct irx_export_table *exports);
 
// In liberx, the following is SearchLibraryEntries
extern void *QueryLibraryEntryTable(iop_library_t *library);
extern int * QueryBootMode(int mode);
extern void RegisterBootMode(iop_bootmode_t *b);
 
extern void LockLibraryClient(struct irx_export_table *export);
extern void UnLockLibraryClient(struct irx_export_table *export);
 
extern void RegisterModule(ModuleInfo_t *mi);
extern void ReleaseModule(ModuleInfo_t *mi);
 
extern int AddRebootNotifyHandler(BootupCallback_t func, int priority, int *stat);
 
extern void SetCacheCtrl(u32 val);
 
extern int ProbeExecutableObject(void* image, FileInfo_t *result);
extern int LoadExecutableObject(void* image, FileInfo_t *fi);
extern ModuleInfo_t *SearchModuleCBByAddr(void* addr);
 
#define loadcore_IMPORTS \
    loadcore_IMPORTS_start \
 \
    I_GetLibraryEntryTable \
 \
    I_FlushIcache \
    I_FlushDcache \
 \
    I_RegisterLibraryEntries \
    I_ReleaseLibraryEntries \
 \
    I_QueryLibraryEntryTable \
    I_QueryBootMode \
 \
    loadcore_IMPORTS_end
 
#define loadcore_IMPORTS_start DECLARE_IMPORT_TABLE(loadcore, 1, 1)
#define loadcore_IMPORTS_end END_IMPORT_TABLE
 
#define I_GetLibraryEntryTable DECLARE_IMPORT(3, GetLibraryEntryTable)
#define I_GetLoadcoreInternalData DECLARE_IMPORT(3, GetLoadcoreInternalData)
#define I_FlushIcache DECLARE_IMPORT(4, FlushIcache)
#define I_FlushDcache DECLARE_IMPORT(5, FlushDcache)
#define I_RegisterLibraryEntries DECLARE_IMPORT(6, RegisterLibraryEntries)
#define I_ReleaseLibraryEntries DECLARE_IMPORT(7, ReleaseLibraryEntries)
#define I_LinkLibraryEntries DECLARE_IMPORT(8, LinkLibraryEntries)
#define I_UnLinkLibraryEntries DECLARE_IMPORT(9, UnLinkLibraryEntries)
#define I_RegisterNonAutoLinkEntries DECLARE_IMPORT(10, RegisterNonAutoLinkEntries)
#define I_QueryLibraryEntryTable DECLARE_IMPORT(11, QueryLibraryEntryTable)
#define I_QueryBootMode DECLARE_IMPORT(12, QueryBootMode)
#define I_RegisterBootMode DECLARE_IMPORT(13, RegisterBootMode)
#define I_LockLibraryClient DECLARE_IMPORT(14, LockLibraryClient)
#define I_UnLockLibraryClient DECLARE_IMPORT(15, UnLockLibraryClient)
#define I_RegisterModule DECLARE_IMPORT(16, RegisterModule)
#define I_ReleaseModule DECLARE_IMPORT(17, ReleaseModule)
#define I_AddRebootNotifyHandler DECLARE_IMPORT(20, AddRebootNotifyHandler)
#define I_SetCacheCtrl DECLARE_IMPORT(21, SetCacheCtrl)
#define I_ProbeExecutableObject DECLARE_IMPORT(22, ProbeExecutableObject)
#define I_LoadExecutableObject DECLARE_IMPORT(23, LoadExecutableObject)
#define I_SearchModuleCBByAddr DECLARE_IMPORT(24, SearchModuleCBByAddr)
 
// For backwards compatibility
#define LinkImports(...) LinkLibraryEntries(__VA_ARGS__)
#define UnlinkImports(...) UnLinkLibraryEntries(__VA_ARGS__)
#define SetNonAutoLinkFlag(...) LockLibraryClient(__VA_ARGS__)
#define UnsetNonAutoLinkFlag(...) UnLockLibraryClient(__VA_ARGS__)
#define LinkModule(...) RegisterModule(__VA_ARGS__)
#define UnlinkModule(...) ReleaseModule(__VA_ARGS__)
#define RegisterPostBootCallback(...) AddRebootNotifyHandler(__VA_ARGS__)
#define ReadModuleHeader(...) ProbeExecutableObject(__VA_ARGS__)
#define LoadModuleImage(...) LoadExecutableObject(__VA_ARGS__)
#define FindImageInfo(...) SearchModuleCBByAddr(__VA_ARGS__)
#define I_LinkImports I_LinkLibraryEntries
#define I_UnlinkImports I_UnLinkLibraryEntries
#define I_SetNonAutoLinkFlag I_LockLibraryClient
#define I_UnsetNonAutoLinkFlag I_UnLockLibraryClient
#define I_LinkModule I_RegisterModule
#define I_UnlinkModule I_ReleaseModule
#define I_RegisterPostBootCallback I_AddRebootNotifyHandler
#define I_ReadModuleHeader I_ProbeExecutableObject
#define I_LoadModuleImage I_LoadExecutableObject
#define I_FindImageInfo I_SearchModuleCBByAddr
 
#ifdef __cplusplus
}
#endif
 
#endif /* __LOADCORE_H__ */