PSPSDK 2024-10-31
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Functions
Module Manager Library

This module contains the imports for the kernel's module management routines. More...

Data Structures

struct  SceKernelLMOption
 
struct  SceKernelSMOption
 
struct  SceKernelModuleInfo
 

Macros

#define PSP_MEMORY_PARTITION_KERNEL   1
 
#define PSP_MEMORY_PARTITION_USER   2
 

Typedefs

typedef struct SceKernelLMOption SceKernelLMOption
 
typedef struct SceKernelSMOption SceKernelSMOption
 
typedef struct SceKernelModuleInfo SceKernelModuleInfo
 

Functions

SceUID sceKernelLoadModule (const char *path, int flags, SceKernelLMOption *option)
 Load a module.
 
SceUID sceKernelLoadModuleMs (const char *path, int flags, SceKernelLMOption *option)
 Load a module from MS.
 
SceUID sceKernelLoadModuleByID (SceUID fid, int flags, SceKernelLMOption *option)
 Load a module from the given file UID.
 
SceUID sceKernelLoadModuleBufferUsbWlan (SceSize bufsize, void *buf, int flags, SceKernelLMOption *option)
 Load a module from a buffer using the USB/WLAN API.
 
int sceKernelStartModule (SceUID modid, SceSize argsize, void *argp, int *status, SceKernelSMOption *option)
 Start a loaded module.
 
int sceKernelStopModule (SceUID modid, SceSize argsize, void *argp, int *status, SceKernelSMOption *option)
 Stop a running module.
 
int sceKernelUnloadModule (SceUID modid)
 Unload a stopped module.
 
int sceKernelSelfStopUnloadModule (int unknown, SceSize argsize, void *argp)
 Stop and unload the current module.
 
int sceKernelStopUnloadSelfModule (SceSize argsize, void *argp, int *status, SceKernelSMOption *option)
 Stop and unload the current module.
 
int sceKernelQueryModuleInfo (SceUID modid, SceKernelModuleInfo *info)
 Query the information about a loaded module from its UID.
 
int sceKernelGetModuleIdList (SceUID *readbuf, int readbufsize, int *idcount)
 Get a list of module IDs.
 
int sceKernelGetModuleIdByAddress (const void *moduleAddr)
 Get the ID of the module occupying the address.
 

Detailed Description

This module contains the imports for the kernel's module management routines.

Macro Definition Documentation

◆ PSP_MEMORY_PARTITION_KERNEL

#define PSP_MEMORY_PARTITION_KERNEL   1

◆ PSP_MEMORY_PARTITION_USER

#define PSP_MEMORY_PARTITION_USER   2

Typedef Documentation

◆ SceKernelLMOption

typedef struct SceKernelLMOption SceKernelLMOption

◆ SceKernelModuleInfo

typedef struct SceKernelModuleInfo SceKernelModuleInfo

◆ SceKernelSMOption

typedef struct SceKernelSMOption SceKernelSMOption

Function Documentation

◆ sceKernelGetModuleIdByAddress()

int sceKernelGetModuleIdByAddress ( const void *  moduleAddr)

Get the ID of the module occupying the address.

Parameters
moduleAddr- A pointer to the module
Returns
>= 0 on success, otherwise one of PspKernelErrorCodes

◆ sceKernelGetModuleIdList()

int sceKernelGetModuleIdList ( SceUID *  readbuf,
int  readbufsize,
int *  idcount 
)

Get a list of module IDs.

NOTE: This is only available on 1.5 firmware and above. For V1 use pspSdkGetModuleIdList.

Parameters
readbuf- Buffer to store the module list.
readbufsize- Number of elements in the readbuffer.
idcount- Returns the number of module ids
Returns
>= 0 on success

◆ sceKernelLoadModule()

SceUID sceKernelLoadModule ( const char *  path,
int  flags,
SceKernelLMOption *  option 
)

Load a module.

Note
This function restricts where it can load from (such as from flash0) unless you call it in kernel mode. It also must be called from a thread.
Parameters
path- The path to the module to load.
flags- Unused, always 0 .
option- Pointer to a mod_param_t structure. Can be NULL.
Returns
The UID of the loaded module on success, otherwise one of PspKernelErrorCodes.

Referenced by pspSdkLoadStartModuleWithArgs().

◆ sceKernelLoadModuleBufferUsbWlan()

SceUID sceKernelLoadModuleBufferUsbWlan ( SceSize  bufsize,
void *  buf,
int  flags,
SceKernelLMOption *  option 
)

Load a module from a buffer using the USB/WLAN API.

Can only be called from kernel mode, or from a thread that has attributes of 0xa0000000.

Parameters
bufsize- Size (in bytes) of the buffer pointed to by buf.
buf- Pointer to a buffer containing the module to load. The buffer must reside at an address that is a multiple to 64 bytes.
flags- Unused, always 0.
option- Pointer to an optional SceKernelLMOption structure.
Returns
The UID of the loaded module on success, otherwise one of PspKernelErrorCodes.

◆ sceKernelLoadModuleByID()

SceUID sceKernelLoadModuleByID ( SceUID  fid,
int  flags,
SceKernelLMOption *  option 
)

Load a module from the given file UID.

Parameters
fid- The module's file UID.
flags- Unused, always 0.
option- Pointer to an optional SceKernelLMOption structure.
Returns
The UID of the loaded module on success, otherwise one of PspKernelErrorCodes.

◆ sceKernelLoadModuleMs()

SceUID sceKernelLoadModuleMs ( const char *  path,
int  flags,
SceKernelLMOption *  option 
)

Load a module from MS.

Note
This function restricts what it can load, e.g. it wont load plain executables.
Parameters
path- The path to the module to load.
flags- Unused, set to 0.
option- Pointer to a mod_param_t structure. Can be NULL.
Returns
The UID of the loaded module on success, otherwise one of PspKernelErrorCodes.

◆ sceKernelQueryModuleInfo()

int sceKernelQueryModuleInfo ( SceUID  modid,
SceKernelModuleInfo *  info 
)

Query the information about a loaded module from its UID.

Note
This fails on v1.0 firmware (and even it worked has a limited structure) so if you want to be compatible with both 1.5 and 1.0 (and you are running in kernel mode) then call this function first then pspSdkQueryModuleInfoV1 if it fails, or make separate v1 and v1.5+ builds.
Parameters
modid- The UID of the loaded module.
info- Pointer to a SceKernelModuleInfo structure.
Returns
0 on success, otherwise one of PspKernelErrorCodes.

◆ sceKernelSelfStopUnloadModule()

int sceKernelSelfStopUnloadModule ( int  unknown,
SceSize  argsize,
void *  argp 
)

Stop and unload the current module.

Parameters
unknown- Unknown (I've seen 1 passed).
argsize- Size (in bytes) of the arguments that will be passed to module_stop().
argp- Pointer to arguments that will be passed to module_stop().
Returns
??? on success, otherwise one of PspKernelErrorCodes.

Referenced by __attribute__().

◆ sceKernelStartModule()

int sceKernelStartModule ( SceUID  modid,
SceSize  argsize,
void *  argp,
int *  status,
SceKernelSMOption *  option 
)

Start a loaded module.

Parameters
modid- The ID of the module returned from LoadModule.
argsize- Length of the args.
argp- A pointer to the arguments to the module.
status- Returns the status of the start.
option- Pointer to an optional SceKernelSMOption structure.
Returns
??? on success, otherwise one of PspKernelErrorCodes.

Referenced by pspSdkLoadStartModuleWithArgs().

◆ sceKernelStopModule()

int sceKernelStopModule ( SceUID  modid,
SceSize  argsize,
void *  argp,
int *  status,
SceKernelSMOption *  option 
)

Stop a running module.

Parameters
modid- The UID of the module to stop.
argsize- The length of the arguments pointed to by argp.
argp- Pointer to arguments to pass to the module's module_stop() routine.
status- Return value of the module's module_stop() routine.
option- Pointer to an optional SceKernelSMOption structure.
Returns
??? on success, otherwise one of PspKernelErrorCodes.

◆ sceKernelStopUnloadSelfModule()

int sceKernelStopUnloadSelfModule ( SceSize  argsize,
void *  argp,
int *  status,
SceKernelSMOption *  option 
)

Stop and unload the current module.

Parameters
argsize- Size (in bytes) of the arguments that will be passed to module_stop().
argp- Poitner to arguments that will be passed to module_stop().
status- Return value from module_stop().
option- Pointer to an optional SceKernelSMOption structure.
Returns
??? on success, otherwise one of PspKernelErrorCodes.

◆ sceKernelUnloadModule()

int sceKernelUnloadModule ( SceUID  modid)

Unload a stopped module.

Parameters
modid- The UID of the module to unload.
Returns
??? on success, otherwise one of PspKernelErrorCodes.