libmc.h

Go to the documentation of this file.

/*
# _____     ___ ____     ___ ____
#  ____|   |    ____|   |        | |____|
# |     ___|   |____ ___|    ____| |    \    PS2DEV Open Source Project.
#-----------------------------------------------------------------------
# Copyright 2001-2004, ps2dev - http://www.ps2dev.org
# Licenced under Academic Free License version 2.0
# Review ps2sdk README & LICENSE files for further details.
*/

 
/*
    NOTE: These functions will work with the MCMAN/MCSERV or XMCMAN/XMCSERV
    modules stored in rom0. The library will automatically detect which
    module is used and will use the appropriate RPC commands accordingly.
 
        NOTE: These functions seem to work for both psx and ps2 memcards
 
        to use memcards:
        1) first load modules (sio2man then mcman/mcserv)
        2) call mcInit(MC_TYPE)
        3) use mcGetInfo() to see if memcards are connected
        4) use mcSync to check that the function has finished
 
        all mc* functions except mcInit() are asynchronous and require mcSync()
        usage to test when they are done
*/
 
#ifndef __LIBMC_H__
#define __LIBMC_H__
 
#include <libmc-common.h>
#include <sifrpc.h>
 
#define MC_WAIT                 0
#define MC_NOWAIT               1
 
#define MC_TYPE_PSX             sceMcTypePS1
#define MC_TYPE_PS2             sceMcTypePS2
#define MC_TYPE_POCKET          sceMcTypePDA
#define MC_TYPE_NONE        sceMcTypeNoCard
 
#define MC_FORMATTED        1
#define MC_UNFORMATTED      0
 
// Valid bits in memcard file attributes (mctable.AttrFile)
#define MC_ATTR_READABLE        sceMcFileAttrReadable
#define MC_ATTR_WRITEABLE       sceMcFileAttrWriteable
#define MC_ATTR_EXECUTABLE      sceMcFileAttrExecutable
#define MC_ATTR_PROTECTED       sceMcFileAttrDupProhibit
#define MC_ATTR_FILE            sceMcFileAttrFile
#define MC_ATTR_SUBDIR          sceMcFileAttrSubdir
#define MC_ATTR_OBJECT          (sceMcFileAttrFile|sceMcFileAttrSubdir)
#define MC_ATTR_CLOSED          sceMcFileAttrClosed
#define MC_ATTR_PDAEXEC         sceMcFileAttrPDAExec
#define MC_ATTR_PSX             sceMcFileAttrPS1
#define MC_ATTR_HIDDEN          sceMcFileAttrHidden

enum MC_FUNC_NUMBERS{
    MC_FUNC_NONE        = 0x00,
    MC_FUNC_GET_INFO,
    MC_FUNC_OPEN,
    MC_FUNC_CLOSE,
    MC_FUNC_SEEK,
    MC_FUNC_READ,
    MC_FUNC_WRITE,
    MC_FUNC_FLUSH       = 0x0A,
    MC_FUNC_MK_DIR,
    MC_FUNC_CH_DIR,
    MC_FUNC_GET_DIR,
    MC_FUNC_SET_INFO,
    MC_FUNC_DELETE,
    MC_FUNC_FORMAT,
    MC_FUNC_UNFORMAT,
    MC_FUNC_GET_ENT,
    MC_FUNC_RENAME,
    MC_FUNC_CHG_PRITY,
    MC_FUNC_ERASE_BLOCK = 0x5A,
    MC_FUNC_READ_PAGE,
    MC_FUNC_WRITE_PAGE,
};

enum MCICON_TYPES{
    MCICON_TYPE_SAVED_DATA      = 0,    // "Saved Data (PlayStation(r)2)"
    MCICON_TYPE_SOFTWARE_PS2,       // "Software (PlayStation(r)2)"
    MCICON_TYPE_SOFTWARE_PKT,       // "Software (PocketStation(r))"
    MCICON_TYPE_SETTINGS_DATA,      // "Settings File (PlayStation(r)2)"
    MCICON_TYPE_SYSTEM_DRIVER       // "System driver"; Implemented on SCPH-5XXXX, previous models can't recognize it unless HDD-OSD is active
};
 
typedef int iconIVECTOR[4];
typedef float iconFVECTOR[4];
 
typedef struct
{
    unsigned char  head[4];
    unsigned short type;
    unsigned short nlOffset;
    unsigned unknown2;
    unsigned trans;
    iconIVECTOR bgCol[4];
    iconFVECTOR lightDir[3];
    iconFVECTOR lightCol[3];
    iconFVECTOR lightAmbient;
    unsigned short title[34];
    unsigned char view[64];
    unsigned char copy[64];
    unsigned char del[64];
    unsigned char unknown3[512];
} mcIcon;
 
typedef struct _sceMcTblGetDir {    // size = 64
    sceMcStDateTime _Create;    // 0
    sceMcStDateTime _Modify;    // 8
    u32 FileSizeByte;       // 16
    u16 AttrFile;           // 20
    u16 Reserve1;           // 22
    u32 Reserve2;           // 24
    u32 PdaAplNo;           // 28
    unsigned char EntryName[32];    // 32
} sceMcTblGetDir __attribute__((aligned(64)));
 
typedef struct
{
    struct
    {
        unsigned char unknown1;        
        unsigned char sec;
        unsigned char min;
        unsigned char hour;
        unsigned char day;
        unsigned char month;
        unsigned short year;
    } _create;
 
    struct
    {
        unsigned char unknown2;        
        unsigned char sec;
        unsigned char min;
        unsigned char hour;
        unsigned char day;
        unsigned char month;
        unsigned short year;
    } _modify;

    unsigned fileSizeByte;
    unsigned short attrFile;
    unsigned short unknown3;
    unsigned unknown4[2];
    unsigned char name[32];
} mcTable __attribute__((deprecated, aligned (64)));
 
// values to send to mcInit() to use either mcserv or xmcserv
// These definitions are retained for backwards compatibility
#define MC_TYPE_MC  0
#define MC_TYPE_XMC 1
 
#ifdef __cplusplus
extern "C" {
#endif

extern int mcInit(int type);

extern int mcGetInfo(int port, int slot, int* type, int* free, int* format);

extern int mcOpen(int port, int slot, const char *name, int mode);

extern int mcClose(int fd);

extern int mcSeek(int fd, int offset, int origin);
 

extern int mcRead(int fd, void *buffer, int size);

extern int mcWrite(int fd, const void *buffer, int size);

extern int mcFlush(int fd);

extern int mcMkDir(int port, int slot, const char* name);

extern int mcChdir(int port, int slot, const char* newDir, char* currentDir);

extern int mcGetDir(int port, int slot, const char *name, unsigned mode, int maxent, sceMcTblGetDir* table);

extern int mcSetFileInfo(int port, int slot, const char* name, const sceMcTblGetDir* info, unsigned flags);

extern int mcDelete(int port, int slot, const char *name);

extern int mcFormat(int port, int slot);

extern int mcUnformat(int port, int slot);

extern int mcGetEntSpace(int port, int slot, const char* path);

extern int mcRename(int port, int slot, const char* oldName, const char* newName);

extern int mcEraseBlock(int port, int slot, int block, int mode);

extern int mcReadPage(int port, int slot, unsigned int page, void *buffer);

extern int mcWritePage(int port, int slot, int page, const void *buffer);

extern int mcChangeThreadPriority(int level);

extern int mcSync(int mode, int *cmd, int *result);

extern int mcReset(void);

extern int xfromInit(int type);

extern int xfromGetInfo(int port, int slot, int* type, int* free, int* format);

extern int xfromOpen(int port, int slot, const char *name, int mode);

extern int xfromClose(int fd);

extern int xfromSeek(int fd, int offset, int origin);
 

extern int xfromRead(int fd, void *buffer, int size);

extern int xfromWrite(int fd, const void *buffer, int size);

extern int xfromFlush(int fd);

extern int xfromMkDir(int port, int slot, const char* name);

extern int xfromChdir(int port, int slot, const char* newDir, char* currentDir);

extern int xfromGetDir(int port, int slot, const char *name, unsigned mode, int maxent, sceMcTblGetDir* table);

extern int xfromSetFileInfo(int port, int slot, const char* name, const sceMcTblGetDir* info, unsigned flags);

extern int xfromDelete(int port, int slot, const char *name);

extern int xfromFormat(int port, int slot);

extern int xfromUnformat(int port, int slot);

extern int xfromGetEntSpace(int port, int slot, const char* path);

extern int xfromRename(int port, int slot, const char* oldName, const char* newName);

extern int xfromEraseBlock(int port, int slot, int block, int mode);

extern int xfromReadPage(int port, int slot, unsigned int page, void *buffer);

extern int xfromWritePage(int port, int slot, int page, const void *buffer);

extern int xfromChangeThreadPriority(int level);

extern int xfromSync(int mode, int *cmd, int *result);

extern int xfromReset(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __LIBMC_H__ */