libmc.c File Reference

#include <tamtypes.h>
#include <kernel.h>
#include <sifrpc.h>
#include <string.h>
#include <iopcontrol.h>
#include "libmc.h"

Go to the source code of this file.

Classes
struct	libmc_name_param_stru
union	libmc_name_desc_param_unio
union	libmc_rdata_param_unio
struct	libmc_page_read_align_data_stru
union	libmc_extra_send_recv_unio
struct	mcExtraEndParam_
struct	libmc_interface_data_stru
struct	libmc_internal_data_
struct	libmc_target_desc_

Macros
#define	LIBMC_PRE_CHECK_FLAG_ONLY_TYPE   1
#define	LIBMC_PRE_RPC(target, flags, only_type)

Typedefs
typedef struct mcExtraEndParam_	mcExtraEndParam_t
typedef struct libmc_internal_data_	libmc_internal_data_t
typedef struct libmc_target_desc_	libmc_target_desc_t

Enumerations
enum	MC_RPCCMD_NUMBERS {   MC_RPCCMD_INIT = 0x00 , MC_RPCCMD_GET_INFO , MC_RPCCMD_OPEN , MC_RPCCMD_CLOSE ,   MC_RPCCMD_SEEK , MC_RPCCMD_READ , MC_RPCCMD_WRITE , MC_RPCCMD_FLUSH ,   MC_RPCCMD_CH_DIR , MC_RPCCMD_GET_DIR , MC_RPCCMD_SET_INFO , MC_RPCCMD_DELETE ,   MC_RPCCMD_FORMAT , MC_RPCCMD_UNFORMAT , MC_RPCCMD_GET_ENT , MC_RPCCMD_CHG_PRITY ,   MC_RPCCMD_CHECK_BLOCK , MC_RPCCMD_ERASE_BLOCK = 0x0E , MC_RPCCMD_READ_PAGE , MC_RPCCMD_WRITE_PAGE }
enum	MC_INTERFACE { MC_INTERFACE_SIO2 = 0 , MC_INTERFACE_DEV9 , MC_INTERFACE_MAX }

Functions
int	mcInit (int type)
int	mcGetInfo (int port, int slot, int *type, int *free, int *format)
int	mcOpen (int port, int slot, const char *name, int mode)
int	mcClose (int fd)
int	mcSeek (int fd, int offset, int origin)
int	mcRead (int fd, void *buffer, int size)
int	mcWrite (int fd, const void *buffer, int size)
int	mcFlush (int fd)
int	mcMkDir (int port, int slot, const char *name)
int	mcChdir (int port, int slot, const char *newDir, char *currentDir)
int	mcGetDir (int port, int slot, const char *name, unsigned mode, int maxent, sceMcTblGetDir *table)
int	mcSetFileInfo (int port, int slot, const char *name, const sceMcTblGetDir *info, unsigned flags)
int	mcDelete (int port, int slot, const char *name)
int	mcFormat (int port, int slot)
int	mcUnformat (int port, int slot)
int	mcGetEntSpace (int port, int slot, const char *path)
int	mcRename (int port, int slot, const char *oldName, const char *newName)
int	mcEraseBlock (int port, int slot, int block, int mode)
int	mcReadPage (int port, int slot, unsigned int page, void *buffer)
int	mcWritePage (int port, int slot, int page, const void *buffer)
int	mcChangeThreadPriority (int level)
int	mcSync (int mode, int *cmd, int *result)
int	mcReset (void)
int	xfromInit (int type)
int	xfromGetInfo (int port, int slot, int *type, int *free, int *format)
int	xfromOpen (int port, int slot, const char *name, int mode)
int	xfromClose (int fd)
int	xfromSeek (int fd, int offset, int origin)
int	xfromRead (int fd, void *buffer, int size)
int	xfromWrite (int fd, const void *buffer, int size)
int	xfromFlush (int fd)
int	xfromMkDir (int port, int slot, const char *name)
int	xfromChdir (int port, int slot, const char *newDir, char *currentDir)
int	xfromGetDir (int port, int slot, const char *name, unsigned mode, int maxent, sceMcTblGetDir *table)
int	xfromSetFileInfo (int port, int slot, const char *name, const sceMcTblGetDir *info, unsigned flags)
int	xfromDelete (int port, int slot, const char *name)
int	xfromFormat (int port, int slot)
int	xfromUnformat (int port, int slot)
int	xfromGetEntSpace (int port, int slot, const char *path)
int	xfromRename (int port, int slot, const char *oldName, const char *newName)
int	xfromEraseBlock (int port, int slot, int block, int mode)
int	xfromReadPage (int port, int slot, unsigned int page, void *buffer)
int	xfromWritePage (int port, int slot, int page, const void *buffer)
int	xfromChangeThreadPriority (int level)
int	xfromSync (int mode, int *cmd, int *result)
int	xfromReset (void)

Detailed Description

Function defenitions for mclib.

Definition in file libmc.c.

Macro Definition Documentation

LIBMC_PRE_CHECK_FLAG_ONLY_TYPE

#define LIBMC_PRE_CHECK_FLAG_ONLY_TYPE   1

Definition at line 187 of file libmc.c.

LIBMC_PRE_RPC

#define LIBMC_PRE_RPC	(		target,
			flags,
			only_type )

Value:

{ \
    int cur_ret; \
    cur_ret = libmc_pre_rpc_impl(target, flags, only_type); \
    if (cur_ret) \
        return cur_ret; \
}

Definition at line 203 of file libmc.c.

Enumeration Type Documentation

MC_INTERFACE

enum MC_INTERFACE

Definition at line 164 of file libmc.c.

MC_RPCCMD_NUMBERS

enum MC_RPCCMD_NUMBERS

Definition at line 29 of file libmc.c.

Function Documentation

mcChangeThreadPriority()

int mcChangeThreadPriority

(

int

level

)

change mcserv thread priority (I don't think this is implemented properly) Note: rom0:MCSERV does not support this. mcSync returns: 0 if ok < 0 if error

Parameters

level

thread priority

Returns

0 = success; -1 = error

Definition at line 1009 of file libmc.c.

mcChdir()

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

change current dir (can also get current dir) mcSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
newDir	new dir to change to
currentDir	buffer to get current dir (use 0 if not needed)

Returns

0 = successful; < 0 = error

Definition at line 921 of file libmc.c.

mcClose()

int mcClose

(

int

fd

)

close an open file on memcard mcSync returns: 0 if closed successfully < 0 = error

Parameters

fd	file descriptor of open file

Returns

0 successful; < 0 = error

Definition at line 873 of file libmc.c.

mcDelete()

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

delete file mcSync returns: 0 if deleted successfully < 0 if error

Parameters

port	port number to delete from
slot	slot number to delete from
name	filename to delete

Returns

0 = successful; < 0 = error

Definition at line 945 of file libmc.c.

mcEraseBlock()

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

Erases a block on the memory card. Note: rom0:XMCSERV does not support this. mcSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
block	Block number of the block to be erased.
mode	Mode: -1 to inhibit ECC recalculation of the erased block's pages (useful if sceMcWritePage is used to fill in its contents later on), 0 for normal operation.

Returns

0 = success; -1 = error

Definition at line 985 of file libmc.c.

mcFlush()

int mcFlush

(

int

fd

)

flush file cache to memcard mcSync returns: 0 if ok < 0 if error

Parameters

fd	file descriptor

Returns

0 = successful; < 0 = error

Definition at line 905 of file libmc.c.

mcFormat()

int mcFormat	(	int	port,
		int	slot )

format memory card mcSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number

Returns

0 = success; -1 = error

Definition at line 953 of file libmc.c.

mcGetDir()

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

get memcard filelist mcSync result: 0 or more = number of file entries obtained (success) -2 = unformatted card -4 = dirname error

Parameters

port	port number of memcard
slot	slot number of memcard
name	filename to search for (can use wildcard and relative dirs)
mode	mode: 0 = first call, otherwise = followup call
maxext	maximum number of entries to be written to filetable in 1 call
table	mc table array

Returns

0 = successful; < 0 = error

Definition at line 929 of file libmc.c.

mcGetEntSpace()

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

get free space info mcSync returns: 0 or more = number of free entries (success) < 0 if error

Parameters

port	port number
slot	slot number
path	path to be checked

Returns

0 or more = number of empty entries; -1 = error

Definition at line 969 of file libmc.c.

mcGetInfo()

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

get memcard state mcSync result: 0 = same card as last getInfo call -1 = formatted card inserted since last getInfo call -2 = unformatted card inserted since last getInfo call < -2 = memcard access error (could be due to accessing psx memcard)

Parameters

port	port number
slot	slot number
type	pointer to get memcard type
free	pointer to get number of free clusters
format	pointer to get whether or not the card is formatted (Note: Originally, sceMcGetInfo didn't have a 5th argument for returning the format status. As this is emulated based on the return value of sceMcSync() when rom0:MCSERV is used, please keep track of the return value from sceMcSync instead!)

Returns

0 = successful; < 0 = error

Definition at line 857 of file libmc.c.

mcInit()

int mcInit

(

int

type

)

init memcard lib

Parameters

type	Retained for backwards compatibility. Nominally specify MC_TYPE_MC.

Returns

0 = successful; < 0 = error

Definition at line 848 of file libmc.c.

mcMkDir()

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

create a dir mcSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
name	directory name

Returns

0 = successful; < 0 = error

Definition at line 913 of file libmc.c.

mcOpen()

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

open a file on memcard mcSync returns: 0 or more = file descriptor (success) < 0 = error

Parameters

port	port number
slot	slot number
name	filename to open
mode	open file mode (O_RDWR, O_CREAT, etc)

Returns

0 = successful; < 0 = error

Definition at line 865 of file libmc.c.

mcRead()

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

read from file on memcard mcSync returns: 0 or more = number of bytes read from memcard < 0 = error

Parameters

fd	file descriptor
buffer	buffer to read to
size	number of bytes to read

Returns

0 = successful; < 0 = error

Definition at line 889 of file libmc.c.

mcReadPage()

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

Reads a page from the memory card. Note: rom0:XMCSERV does not support this. mcSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
page	Page number of the page to be read.
buffer	Pointer to buffer that will contain the read data.

Returns

0 = success; -1 = error

Definition at line 993 of file libmc.c.

mcRename()

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

rename file or dir on memcard Note: rom0:MCSERV does not support this. mcSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
oldName	name of file/dir to rename
newName	new name to give to file/dir

Returns

1 = success; < 0 = error

Definition at line 977 of file libmc.c.

mcReset()

int mcReset

(

void

)

Reset (force deinit) of library

Returns

0 = success

Definition at line 1025 of file libmc.c.

mcSeek()

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

move memcard file pointer mcSync returns: 0 or more = offset of file pointer from start of file < 0 = error

Parameters

fd	file descriptor
offset	number of bytes from origin
origin	initial position for offset

Returns

0 = successful; < 0 = error

Definition at line 881 of file libmc.c.

mcSetFileInfo()

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

change file information mcSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
name	filename to access
info	data to be changed
flags	flags to show which data is valid

Returns

0 = successful; < 0 = error

Definition at line 937 of file libmc.c.

mcSync()

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

wait for mc functions to finish or check if they have finished yet

Parameters

mode	mode 0=wait till function finishes, 1=check function status
cmd	pointer for storing the number of the currenlty processing function
result	pointer for storing result of function if it finishes

Returns

0 = function is still executing (mode=1); 1 = function has finished executing; -1 = no function registered

Definition at line 1017 of file libmc.c.

mcUnformat()

int mcUnformat	(	int	port,
		int	slot )

unformat memory card mcSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number

Returns

0 = success; -1 = error

Definition at line 961 of file libmc.c.

mcWrite()

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

write to file on memcard mcSync returns: 0 or more = number of bytes written to memcard < 0 = error

Parameters

fd	file descriptor
buffer	to write from write
size	number of bytes to read

Returns

0 = successful; < 0 = error

Definition at line 897 of file libmc.c.

mcWritePage()

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

Writes a page to the memory card. (The block which the page resides on must be erased first!) Note: rom0:XMCSERV does not support this. mcSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
page	Page number of the page to be written.
buffer	Pointer to buffer containing data to be written.

Returns

0 = success; -1 = error

Definition at line 1001 of file libmc.c.

xfromChangeThreadPriority()

int xfromChangeThreadPriority

(

int

level

)

change xfromserv thread priority (I don't think this is implemented properly) xfromSync returns: 0 if ok < 0 if error

Parameters

level

thread priority

Returns

0 = success; -1 = error

Definition at line 1194 of file libmc.c.

xfromChdir()

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

change current dir (can also get current dir) xfromSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
newDir	new dir to change to
currentDir	buffer to get current dir (use 0 if not needed)

Returns

0 = successful; < 0 = error

Definition at line 1106 of file libmc.c.

xfromClose()

int xfromClose

(

int

fd

)

close an open file on external flash ROM xfromSync returns: 0 if closed successfully < 0 = error

Parameters

fd	file descriptor of open file

Returns

0 successful; < 0 = error

Definition at line 1058 of file libmc.c.

xfromDelete()

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

delete file xfromSync returns: 0 if deleted successfully < 0 if error

Parameters

port	port number to delete from
slot	slot number to delete from
name	filename to delete

Returns

0 = successful; < 0 = error

Definition at line 1130 of file libmc.c.

xfromEraseBlock()

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

Erases a block on the external flash ROM. Note: The current implementation of xfromserv does not support this. xfromSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
block	Block number of the block to be erased.
mode	Mode: -1 to inhibit ECC recalculation of the erased block's pages (useful if xfromWritePage is used to fill in its contents later on), 0 for normal operation.

Returns

0 = success; -1 = error

Definition at line 1170 of file libmc.c.

xfromFlush()

int xfromFlush

(

int

fd

)

flush file cache to external flash ROM xfromSync returns: 0 if ok < 0 if error

Parameters

fd	file descriptor

Returns

0 = successful; < 0 = error

Definition at line 1090 of file libmc.c.

xfromFormat()

int xfromFormat	(	int	port,
		int	slot )

format external flash ROM xfromSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number

Returns

0 = success; -1 = error

Definition at line 1138 of file libmc.c.

xfromGetDir()

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

get external flash ROM filelist xfromSync result: 0 or more = number of file entries obtained (success) -2 = unformatted external flash ROM -4 = dirname error

Parameters

port	port number of external flash ROM
slot	slot number of external flash ROM
name	filename to search for (can use wildcard and relative dirs)
mode	mode: 0 = first call, otherwise = followup call
maxext	maximum number of entries to be written to filetable in 1 call
table	external flash ROM table array

Returns

0 = successful; < 0 = error

Definition at line 1114 of file libmc.c.

xfromGetEntSpace()

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

get free space info xfromSync returns: 0 or more = number of free entries (success) < 0 if error

Parameters

port	port number
slot	slot number
path	path to be checked

Returns

0 or more = number of empty entries; -1 = error

Definition at line 1154 of file libmc.c.

xfromGetInfo()

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

get external flash ROM state xfromSync result: 0 = same external flash ROM as last getInfo call -1 = formatted external flash ROM inserted since last getInfo call -2 = unformatted external flash ROM inserted since last getInfo call < -2 = external flash ROM access error (could be due to accessing psx external flash ROM)

Parameters

port	port number
slot	slot number
type	pointer to get external flash ROM type
free	pointer to get number of free clusters
format	pointer to get whether or not the external flash ROM is formatted

Returns

0 = successful; < 0 = error

Definition at line 1042 of file libmc.c.

xfromInit()

int xfromInit

(

int

type

)

init external flash ROM lib

Returns

0 = successful; < 0 = error

Definition at line 1033 of file libmc.c.

xfromMkDir()

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

create a dir xfromSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
name	directory name

Returns

0 = successful; < 0 = error

Definition at line 1098 of file libmc.c.

xfromOpen()

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

open a file on external flash ROM xfromSync returns: 0 or more = file descriptor (success) < 0 = error

Parameters

port	port number
slot	slot number
name	filename to open
mode	open file mode (O_RDWR, O_CREAT, etc)

Returns

0 = successful; < 0 = error

Definition at line 1050 of file libmc.c.

xfromRead()

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

read from file on external flash ROM xfromSync returns: 0 or more = number of bytes read from external flash ROM < 0 = error

Parameters

fd	file descriptor
buffer	buffer to read to
size	number of bytes to read

Returns

0 = successful; < 0 = error

Definition at line 1074 of file libmc.c.

xfromReadPage()

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

Reads a page from the external flash ROM. Note: The current implementation of xfromserv does not support this. xfromSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
page	Page number of the page to be read.
buffer	Pointer to buffer that will contain the read data.

Returns

0 = success; -1 = error

Definition at line 1178 of file libmc.c.

xfromRename()

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

rename file or dir on external flash ROM xfromSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
oldName	name of file/dir to rename
newName	new name to give to file/dir

Returns

1 = success; < 0 = error

Definition at line 1162 of file libmc.c.

xfromReset()

int xfromReset

(

void

)

Reset (force deinit) of library

Returns

0 = success

Definition at line 1210 of file libmc.c.

xfromSeek()

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

move external flash ROM file pointer xfromSync returns: 0 or more = offset of file pointer from start of file < 0 = error

Parameters

fd	file descriptor
offset	number of bytes from origin
origin	initial position for offset

Returns

0 = successful; < 0 = error

Definition at line 1066 of file libmc.c.

xfromSetFileInfo()

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

change file information xfromSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
name	filename to access
info	data to be changed
flags	flags to show which data is valid

Returns

0 = successful; < 0 = error

Definition at line 1122 of file libmc.c.

xfromSync()

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

wait for external flash ROM functions to finish or check if they have finished yet

Parameters

mode	mode 0=wait till function finishes, 1=check function status
cmd	pointer for storing the number of the currenlty processing function
result	pointer for storing result of function if it finishes

Returns

0 = function is still executing (mode=1); 1 = function has finished executing; -1 = no function registered

Definition at line 1202 of file libmc.c.

xfromUnformat()

int xfromUnformat	(	int	port,
		int	slot )

unformat external flash ROM xfromSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number

Returns

0 = success; -1 = error

Definition at line 1146 of file libmc.c.

xfromWrite()

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

write to file on external flash ROM xfromSync returns: 0 or more = number of bytes written to external flash ROM < 0 = error

Parameters

fd	file descriptor
buffer	to write from write
size	number of bytes to read

Returns

0 = successful; < 0 = error

Definition at line 1082 of file libmc.c.

xfromWritePage()

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

Writes a page to the external flash ROM. (The block which the page resides on must be erased first!) Note: The current implementation of xfromserv does not support this. xfromSync returns: 0 if ok < 0 if error

Parameters

port	port number
slot	slot number
page	Page number of the page to be written.
buffer	Pointer to buffer containing data to be written.

Returns

0 = success; -1 = error

Definition at line 1186 of file libmc.c.