module.h

/* Copyright (C) 2011 - 2015 The uOFW team
   See the file COPYING for copying permission.
*/
 
#ifndef COMMON_INCLUDED
# error "Only include common_imp.h or common_header.h!"
#endif
 
#include "../pspmoduleexport.h"
 
#define SCE_MODULE_NAME_LEN                     (27)
 
#define MODULE_VERSION_MINOR                    (0)
#define MODULE_VERSION_MAJOR                    (1)
#define MODULE_VERSION_NUMBER_CATEGORY_SIZE     (2) /* current number category size */
 
typedef struct  {
    u16 modAttribute;
    u8 modVersion[MODULE_VERSION_NUMBER_CATEGORY_SIZE];
    char modName[SCE_MODULE_NAME_LEN];
    s8 terminal;
    void *gpValue;
    void *entTop;
    void *entEnd;
    void *stubTop;
    void *stubEnd;
} SceModuleInfo;
 
/* 
 * Entry thread structure - an entry thread is used for executing the 
 * module entry functions. 
 */
typedef struct {
    /* The number of entry thread parameters, typically 3. */
    u32 numParams;
    /* The initial priority of the entry thread. */
    u32 initPriority;
    /* The stack size of the entry thread. */
    u32 stackSize;
    /* The attributes of the entry thread. */
    u32 attr;  
} SceModuleEntryThread;
 
extern char _gp[];
 
enum SceModuleAttribute {
    SCE_MODULE_ATTR_NONE             = 0x0000,
    SCE_MODULE_ATTR_CANT_STOP        = 0x0001,
    SCE_MODULE_ATTR_EXCLUSIVE_LOAD   = 0x0002,
    SCE_MODULE_ATTR_EXCLUSIVE_START  = 0x0004,
};
 
enum SceModulePrivilegeLevel {
    SCE_MODULE_USER                 = 0x0000,
    SCE_MODULE_MS                   = 0x0200,
    SCE_MODULE_USB_WLAN             = 0x0400,
    SCE_MODULE_APP                  = 0x0600,
    SCE_MODULE_VSH                  = 0x0800,
    SCE_MODULE_KERNEL               = 0x1000,
    SCE_MODULE_KIRK_MEMLMD_LIB      = 0x2000,
    SCE_MODULE_KIRK_SEMAPHORE_LIB   = 0x4000,
};
 
#define SCE_MODULE_PRIVILEGE_LEVELS     (SCE_MODULE_MS | SCE_MODULE_USB_WLAN | SCE_MODULE_APP | SCE_MODULE_VSH | SCE_MODULE_KERNEL)
 
#define SCE_MODINFO_SECTION_NAME        ".rodata.sceModuleInfo"
 
#define SDK_VERSION                     0x06060010 
#define SCE_SDK_VERSION(ver)            const int module_sdk_version = ver
 
#define SCE_KERNEL_START_SUCCESS        (0) 
#define SCE_KERNEL_START_FAIL           (1) 
#define SCE_KERNEL_RESIDENT             (SCE_KERNEL_START_SUCCESS) 
#define SCE_KERNEL_NO_RESIDENT          (SCE_KERNEL_START_FAIL) 
#define SCE_KERNEL_STOP_SUCCESS         (0) 
#define SCE_KERNEL_STOP_FAIL            (1) 
#define SCE_MODULE_BOOTSTART(name)      int module_start(SceSize argSize, const void *argBlock) __attribute__((alias(name))); \
                                        int module_bootstart(SceSize argSize, const void *argBlock) __attribute__((alias(name)))
 
#define SCE_MODULE_REBOOT_BEFORE(name)  int module_reboot_before(void *arg0, s32 arg1, s32 arg2, s32 arg3) __attribute__((alias(name)))
#define SCE_MODULE_REBOOT_BEFORE_FOR_USER(name)  int module_reboot_before(SceSize arglen, void *argp) __attribute__((alias(name)))
#define SCE_MODULE_REBOOT_PHASE(name)   int module_reboot_phase(s32 arg1, void *arg2, s32 arg3, s32 arg4) __attribute__((alias(name)))
#define SCE_MODULE_STOP(name)           int module_stop(SceSize argSize, const void *argBlock) __attribute__((alias(name)))
 
#define SCE_MODULE_INFO(name, attributes, majorVersion, minorVersion) \
    __asm__ (                                                       \
    "    .set push\n"                                               \
    "    .section .lib.ent.top, \"a\", @progbits\n"                 \
    "    .align 2\n"                                                \
    "    .word 0\n"                                                 \
    "__lib_ent_top:\n"                                              \
    "    .section .lib.ent.btm, \"a\", @progbits\n"                 \
    "    .align 2\n"                                                \
    "__lib_ent_bottom:\n"                                           \
    "    .word 0\n"                                                 \
    "    .section .lib.stub.top, \"a\", @progbits\n"                \
    "    .align 2\n"                                                \
    "    .word 0\n"                                                 \
    "__lib_stub_top:\n"                                             \
    "    .section .lib.stub.btm, \"a\", @progbits\n"                \
    "    .align 2\n"                                                \
    "__lib_stub_bottom:\n"                                          \
    "    .word 0\n"                                                 \
    "    .set pop\n"                                                \
    "    .text\n"                                                   \
    );                                                              \
    extern char __lib_ent_top[], __lib_ent_bottom[];                \
    extern char __lib_stub_top[], __lib_stub_bottom[];              \
    const SceModuleInfo module_info                                 \
        __attribute__((section(SCE_MODINFO_SECTION_NAME),            \
                   aligned(16), unused)) = {                        \
      attributes, { minorVersion, majorVersion }, name, 0, _gp,   \
      __lib_ent_top, __lib_ent_bottom,                              \
      __lib_stub_top, __lib_stub_bottom                             \
    }
 
#define SCE_MODULE_START_THREAD_PARAMETER(numParams, initPriority, stackSize, attr) \
    const SceModuleEntryThread module_start_thread_parameter = { numParams, initPriority, stackSize, attr };
 
#define SCE_MODULE_STOP_THREAD_PARAMETER(numParams, initPriority, stackSize, attr) \
    const SceModuleEntryThread module_stop_thread_parameter = { numParams, initPriority, stackSize, attr };