vitasdk
Documentation of the vitasdk
Data Structures | Enumerations | Enumerator | Functions | Variables
User
Miscellaneous » Compat Library

Exports for User. More...

Data Structures

struct  SceCompatCdram
 
struct  SceCtrlDataPsp
 

Enumerations

enum  SceCompatCacheMode { SCE_COMPAT_CACHE_NONE = 0 , SCE_COMPAT_CACHE_INVALIDATE = 1 , SCE_COMPAT_CACHE_WRITEBACK = 2 }
 
enum  SceCompatPeripheralMode { SCE_COMPAT_PERIPHERAL_POWER_IS_SUSPEND_REQUIRED = 1 , SCE_COMPAT_PERIPHERAL_POWER_GET_BATTERY_LIFETIME = 2 , SCE_COMPAT_PERIPHERAL_POWER_GET_BATTERY_PERCENT = 3 , SCE_COMPAT_PERIPHERAL_HPREMOTE_IS_HEADPHONE_EXIST = 4 }
 

Functions

 VITASDK_BUILD_ASSERT_EQ (8, SceCompatCdram)
 
 VITASDK_BUILD_ASSERT_EQ (0x10, SceCtrlDataPsp)
 
int sceCompatInitEx (int unk)
 Init compat.
 
int sceCompatUninit (void)
 Uninit compat.
 
int sceCompatStart (void)
 Start compat.
 
int sceCompatStop (void)
 Stop compat.
 
int sceCompatAllocCdramWithHole (SceCompatCdram *cdram)
 Allocate cdram with hole.
 
int sceCompatFrameBufferInit (void *framebuffer)
 Framebuffer init.
 
int sceCompatSetSuspendSema (SceUID semaid1, SceUID semaid2)
 Set suspend semaphores.
 
int sceCompatSuspendResume (int unk)
 Suspend/resume compat.
 
int sceCompatCache (int mode, void *addr, SceSize size)
 Cache operation.
 
int sceCompatWaitSpecialRequest (int unk)
 Wait for special request.
 
int sceCompatInterrupt (int intr_code)
 Interrupt code.
 
int sceCompatLCDCSync (void)
 LCDC sync.
 
int sceCompatGetPrimaryHead (void)
 Get primary head.
 
int sceCompatGetPeripheralState (int mode)
 Get peripheral state.
 
int sceCompatGetStatus (void)
 Get compat status.
 
int sceCompatGetUpdateState (void)
 Get update state.
 
int sceCompatSetUpdateState (int state)
 Set update state.
 
int sceCompatSetDisplayConfig (int unk0, int unk1)
 Set display config.
 
int sceCompatSetRif (const char *rif)
 Set RIF name.
 
int sceCompatGetPspSystemSoftwareVersion (void)
 Get PSP system software version.
 
int sceCompatAvailableColorSpaceSetting (void)
 Get color space setting availability.
 
int sceCompatCheckPocketStation (void)
 Check if pocket station application is available.
 
int sceCompatIsPocketStationTitle (void)
 Check if current title is a pocket station game.
 
int sceCompatWaitAndGetRequest (int mode, int id)
 Wait for command and get request.
 
int sceCompatReadShared32 (int location, int *value)
 Read from shared sram.
 
int sceCompatWriteShared32 (int location, int value)
 Write to shared sram.
 
int sceCompatWriteSharedCtrl (SceCtrlDataPsp *pad_data)
 Write shared control.
 
int sceCompatGetTitleList (void *buf, SceSize length)
 Get title list.
 
int sceCompatGetDevInf (SceIoDevInfo *info)
 Get Memory Card device information.
 
int sceCompatGetCurrentSecureTick (SceRtcTick *tick)
 Get current secure tick.
 
int sceCompatDatRead (SceUInt32 index, SceUInt32 offset, void *buffer, SceSize size)
 Read cached PSP activation data.
 
int sceCompatIdStorageLookup (SceUInt16 key, SceUInt32 offset, void *buffer, SceSize size)
 Read a PSP IdStorage leaf.
 

Variables

void * SceCompatCdram::cached_cdram
 
void * SceCompatCdram::uncached_cdram
 
unsigned int SceCtrlDataPsp::TimeStamp
 
unsigned int SceCtrlDataPsp::Buttons
 
unsigned char SceCtrlDataPsp::Lx
 
unsigned char SceCtrlDataPsp::Ly
 
unsigned char SceCtrlDataPsp::Rx
 
unsigned char SceCtrlDataPsp::Ry
 
unsigned char SceCtrlDataPsp::Rsrv [4]
 

Detailed Description

Exports for User.

Using this library in your project

Include the header file in your project:

#include <psp2/compat.h>


Link the library to the executable:

SceCompat_stub


Data Structure Documentation

◆ SceCompatCdram

struct SceCompatCdram
Data Fields
void * cached_cdram
void * uncached_cdram

◆ SceCtrlDataPsp

struct SceCtrlDataPsp
Data Fields
unsigned int TimeStamp
unsigned int Buttons
unsigned char Lx
unsigned char Ly
unsigned char Rx
unsigned char Ry
unsigned char Rsrv[4]

Enumeration Type Documentation

◆ SceCompatCacheMode

enum SceCompatCacheMode
Enumerator
SCE_COMPAT_CACHE_NONE 
SCE_COMPAT_CACHE_INVALIDATE 
SCE_COMPAT_CACHE_WRITEBACK 

◆ SceCompatPeripheralMode

enum SceCompatPeripheralMode
Enumerator
SCE_COMPAT_PERIPHERAL_POWER_IS_SUSPEND_REQUIRED 
SCE_COMPAT_PERIPHERAL_POWER_GET_BATTERY_LIFETIME 
SCE_COMPAT_PERIPHERAL_POWER_GET_BATTERY_PERCENT 
SCE_COMPAT_PERIPHERAL_HPREMOTE_IS_HEADPHONE_EXIST 

Function Documentation

◆ VITASDK_BUILD_ASSERT_EQ() [1/2]

VITASDK_BUILD_ASSERT_EQ ( 8  ,
SceCompatCdram   
)

◆ VITASDK_BUILD_ASSERT_EQ() [2/2]

VITASDK_BUILD_ASSERT_EQ ( 0x10  ,
SceCtrlDataPsp   
)

◆ sceCompatInitEx()

int sceCompatInitEx ( int  unk)

Init compat.

Parameters
[in]unk- Unknown, pass 0
Returns
0 on success, < 0 on error.

◆ sceCompatUninit()

int sceCompatUninit ( void  )

Uninit compat.

Returns
0 on success, < 0 on error.

◆ sceCompatStart()

int sceCompatStart ( void  )

Start compat.

Returns
0 on success, < 0 on error.

◆ sceCompatStop()

int sceCompatStop ( void  )

Stop compat.

Returns
0 on success, < 0 on error.

◆ sceCompatAllocCdramWithHole()

int sceCompatAllocCdramWithHole ( SceCompatCdram *  cdram)

Allocate cdram with hole.

Parameters
[out]cdram- A pointer to a SceCompatCdram structure.
Returns
0 on success, < 0 on error.

◆ sceCompatFrameBufferInit()

int sceCompatFrameBufferInit ( void *  framebuffer)

Framebuffer init.

Parameters
[in]framebuffer- Pointer to framebuffer
Returns
0 on success, < 0 on error.

◆ sceCompatSetSuspendSema()

int sceCompatSetSuspendSema ( SceUID  semaid1,
SceUID  semaid2 
)

Set suspend semaphores.

Parameters
[in]semaid1- Semaphore id 1
[in]semaid2- Semaphore id 2
Returns
0 on success, < 0 on error.

◆ sceCompatSuspendResume()

int sceCompatSuspendResume ( int  unk)

Suspend/resume compat.

Parameters
[in]unk- Unknown, pass 1
Returns
0 on success, < 0 on error.

◆ sceCompatCache()

int sceCompatCache ( int  mode,
void *  addr,
SceSize  size 
)

Cache operation.

Parameters
[in]mode- One of SceCompatCacheMode
[in]addr- Address
[in]size- Size
Returns
0 on success, < 0 on error.

◆ sceCompatWaitSpecialRequest()

int sceCompatWaitSpecialRequest ( int  unk)

Wait for special request.

Parameters
[in]unk- Unknown, pass 1
Returns
0 on success, < 0 on error.

◆ sceCompatInterrupt()

int sceCompatInterrupt ( int  intr_code)

Interrupt code.

Parameters
[in]intr_code- Interrupt code
Returns
0 on success, < 0 on error.

◆ sceCompatLCDCSync()

int sceCompatLCDCSync ( void  )

LCDC sync.

Returns
0 on success, < 0 on error.

◆ sceCompatGetPrimaryHead()

int sceCompatGetPrimaryHead ( void  )

Get primary head.

Returns
0 on success, < 0 on error.

◆ sceCompatGetPeripheralState()

int sceCompatGetPeripheralState ( int  mode)

Get peripheral state.

Parameters
[in]mode- One of SceCompatPeripheralMode
Returns
state on success, < 0 on error.

◆ sceCompatGetStatus()

int sceCompatGetStatus ( void  )

Get compat status.

Returns
status on success, < 0 on error.

◆ sceCompatGetUpdateState()

int sceCompatGetUpdateState ( void  )

Get update state.

Returns
state on success, < 0 on error.

◆ sceCompatSetUpdateState()

int sceCompatSetUpdateState ( int  state)

Set update state.

Parameters
[in]state- State
Returns
0 on success, < 0 on error.

◆ sceCompatSetDisplayConfig()

int sceCompatSetDisplayConfig ( int  unk0,
int  unk1 
)

Set display config.

Parameters
[in]unk0- Unknown
[in]unk1- Unknown
Returns
0 on success, < 0 on error.

◆ sceCompatSetRif()

int sceCompatSetRif ( const char *  rif)

Set RIF name.

Parameters
[in]rif- RIF name (max. 36 chars)
Returns
0 on success, < 0 on error.

◆ sceCompatGetPspSystemSoftwareVersion()

int sceCompatGetPspSystemSoftwareVersion ( void  )

Get PSP system software version.

Returns
version on success, < 0 on error.

◆ sceCompatAvailableColorSpaceSetting()

int sceCompatAvailableColorSpaceSetting ( void  )

Get color space setting availability.

Returns
1 if true, 0 if false, < 0 on error.

◆ sceCompatCheckPocketStation()

int sceCompatCheckPocketStation ( void  )

Check if pocket station application is available.

Returns
1 if true, 0 if false, < 0 on error.

◆ sceCompatIsPocketStationTitle()

int sceCompatIsPocketStationTitle ( void  )

Check if current title is a pocket station game.

Returns
1 if true, 0 if false, < 0 on error.

◆ sceCompatWaitAndGetRequest()

int sceCompatWaitAndGetRequest ( int  mode,
int  id 
)

Wait for command and get request.

Parameters
[in]mode- Mode
[in]id- ID
Returns
pointer to request in PspEmu RAM on success, < 0 on error.

◆ sceCompatReadShared32()

int sceCompatReadShared32 ( int  location,
int *  value 
)

Read from shared sram.

Parameters
[in]location- Location
[out]value- Pointer to a int buffer to hold the value
Returns
0 on success, < 0 on error.

◆ sceCompatWriteShared32()

int sceCompatWriteShared32 ( int  location,
int  value 
)

Write to shared sram.

Parameters
[in]location- Location
[in]value- Value
Returns
0 on success, < 0 on error.

◆ sceCompatWriteSharedCtrl()

int sceCompatWriteSharedCtrl ( SceCtrlDataPsp *  pad_data)

Write shared control.

Parameters
[in]pad_data- Pointer to a SceCtrlDataPsp structure.
Returns
0 on success, < 0 on error.

◆ sceCompatGetTitleList()

int sceCompatGetTitleList ( void *  buf,
SceSize  length 
)

Get title list.

Parameters
[out]buf- A 100 bytes buffer for the title list
[in]length- Must be 100
Returns
0 on success, < 0 on error.

◆ sceCompatGetDevInf()

int sceCompatGetDevInf ( SceIoDevInfo *  info)

Get Memory Card device information.

Parameters
[out]info- A pointer to a SceIoDevInfo structure.
Returns
0 on success, < 0 on error.

◆ sceCompatGetCurrentSecureTick()

int sceCompatGetCurrentSecureTick ( SceRtcTick *  tick)

Get current secure tick.

Parameters
[out]tick- A pointer to a SceRtcTick structure.
Returns
0 on success, < 0 on error.

◆ sceCompatDatRead()

int sceCompatDatRead ( SceUInt32  index,
SceUInt32  offset,
void *  buffer,
SceSize  size 
)

Read cached PSP activation data.

FW 3.60 exposes the 0x1038-byte activation data cached by sceCompatStart to PSPEmu as flash2:/act.dat. This function only succeeds for the PSPEmu process associated with the active SceCompat instance.

Parameters
[in]index- Data selector. Must be 0 on FW 3.60.
[in]offset- Byte offset in the cached activation data. Must be less than 0x1038.
[out]buffer- Buffer that receives the requested bytes.
[in]size- Number of bytes to read. The requested range must fit within the 0x1038-byte activation data.
Returns
0 on success, < 0 on error.

◆ sceCompatIdStorageLookup()

int sceCompatIdStorageLookup ( SceUInt16  key,
SceUInt32  offset,
void *  buffer,
SceSize  size 
)

Read a PSP IdStorage leaf.

FW 3.60 accepts PSP keys from 0x100 through 0x13F and maps them to Vita IdStorage keys 0x0000 through 0x003F. The offset is within the resulting 0x200-byte leaf. A size of 0x200 or greater is treated as 0x200 before the requested range is checked. This function only succeeds for the PSPEmu process associated with the active SceCompat instance.

Parameters
[in]key- PSP IdStorage key from 0x100 through 0x13F.
[in]offset- Byte offset within the 0x200-byte leaf.
[out]buffer- Buffer that receives the requested bytes.
[in]size- Number of bytes to read.
Returns
0 on success, < 0 on error.

Variable Documentation

◆ cached_cdram

void* SceCompatCdram::cached_cdram

◆ uncached_cdram

void* SceCompatCdram::uncached_cdram

◆ TimeStamp

unsigned int SceCtrlDataPsp::TimeStamp

◆ Buttons

unsigned int SceCtrlDataPsp::Buttons

◆ Lx

unsigned char SceCtrlDataPsp::Lx

◆ Ly

unsigned char SceCtrlDataPsp::Ly

◆ Rx

unsigned char SceCtrlDataPsp::Rx

◆ Ry

unsigned char SceCtrlDataPsp::Ry

◆ Rsrv

unsigned char SceCtrlDataPsp::Rsrv[4]