Kernel

Exports for Kernel. More...

Macros
#define	SCE_ID_STORAGE_LEAF_SIZE   0x200
#define	SCE_ID_STORAGE_KEY_MAX   0xFFEF
#define	SCE_ID_STORAGE_ATOMIC_LEAVES_MAX   32

Enumerations
enum	SceIdStorageErrorCode {   SCE_ID_STORAGE_ERROR_INVALID_ARGUMENT = 0x80230000 , SCE_ID_STORAGE_ERROR_INVALID_KEY = 0x80230001 , SCE_ID_STORAGE_ERROR_INVALID_LEAF_COUNT = 0x80230002 , SCE_ID_STORAGE_ERROR_NOT_FORMATTED = 0x80230003 ,   SCE_ID_STORAGE_ERROR_NO_SPACE = 0x80230004 , SCE_ID_STORAGE_ERROR_LEAF_NOT_FOUND = 0x80230005 , SCE_ID_STORAGE_ERROR_LEAF_ALREADY_EXISTS = 0x80230006 }
	Module-specific errors returned by SceIdStorage on FW 3.60. More...

Functions
int	ksceIdStorageReadLeaf (SceUInt32 key, void *buf)
	Read one complete IdStorage leaf.
int	ksceIdStorageWriteLeaf (SceUInt32 key, const void *buf)
	Replace one complete IdStorage leaf in the write-back cache.
int	ksceIdStorageCreateAtomicLeaves (const SceUInt16 *keys, SceInt32 num_leaves)
	Create several leaf mappings as one in-memory operation.
int	ksceIdStorageCreateLeaf (SceUInt32 key)
	Create one leaf mapping.
int	ksceIdStorageDeleteLeaf (SceUInt32 key)
	Delete one leaf mapping.
int	ksceIdStorageEnumId (void)
	Acquire and release the IdStorage mutex.
int	ksceIdStorageFlush (void)
	Write modified cached leaves and mapping-table changes to storage.
int	ksceIdStorageFormat (void)
	Initialize a new IdStorage mapping table.
int	ksceIdStorageGetFreeLeaves (void)
	Count unallocated mapping entries, which contain 0xFFFF.
SceSize	ksceIdStorageGetLeafSize (void)
	Get the fixed IdStorage leaf size.
SceBool	ksceIdStorageIsDirty (void)
	Check whether changes still need to be written to storage.
SceBool	ksceIdStorageIsFormatted (void)
	Check whether the mapping table was loaded or formatted successfully.
SceBool	ksceIdStorageIsReadOnly (void)
	Return the cached read-only flag.
int	ksceIdStorageLookup (SceUInt32 key, SceUInt32 offset, void *buf, SceSize size)
	Read a range from an existing leaf.
int	ksceIdStorageRestart (SceBool flush)
	Destroy and reinitialize the IdStorage state on FW 3.60.
int	ksceIdStorageUnformat (void)
	Mark the IdStorage partition unformatted.
int	ksceIdStorageUpdate (SceUInt32 key, SceUInt32 offset, const void *buf, SceSize size)
	Replace a range in an existing leaf through a cached read-modify-write.

Detailed Description

Exports for Kernel.

---

Using this library in your project

Include the header file in your project:

#include <psp2kern/idstorage.h> 

Link the library to the executable:

SceIdStorageForDriver_stub 

---

Macro Definition Documentation

SCE_ID_STORAGE_LEAF_SIZE

#define SCE_ID_STORAGE_LEAF_SIZE   0x200

SCE_ID_STORAGE_KEY_MAX

#define SCE_ID_STORAGE_KEY_MAX   0xFFEF

SCE_ID_STORAGE_ATOMIC_LEAVES_MAX

#define SCE_ID_STORAGE_ATOMIC_LEAVES_MAX   32

Enumeration Type Documentation

SceIdStorageErrorCode

enum SceIdStorageErrorCode

Module-specific errors returned by SceIdStorage on FW 3.60.

Enumerator
SCE_ID_STORAGE_ERROR_INVALID_ARGUMENT	Invalid argument or range, or not in the required manufacturing mode.
SCE_ID_STORAGE_ERROR_INVALID_KEY	The key is greater than SCE_ID_STORAGE_KEY_MAX.
SCE_ID_STORAGE_ERROR_INVALID_LEAF_COUNT	Atomic leaf count is outside 1 through 32.
SCE_ID_STORAGE_ERROR_NOT_FORMATTED	IdStorage is not formatted or initialized.
SCE_ID_STORAGE_ERROR_NO_SPACE	Heap allocation failed or no mapping slots remain.
SCE_ID_STORAGE_ERROR_LEAF_NOT_FOUND	The requested key has no mapping-table entry.
SCE_ID_STORAGE_ERROR_LEAF_ALREADY_EXISTS	The requested key already has a mapping-table entry.

Function Documentation

ksceIdStorageReadLeaf()

int ksceIdStorageReadLeaf	(	SceUInt32	key,
		void *	buf
	)

Read one complete IdStorage leaf.

The caller must pass the IdStorage read-access check. The destination is a kernel buffer and is written directly by SceIdStorage. The operation runs under the internal IdStorage mutex.

Parameters

[in]	key	- Leaf key from 0 through SCE_ID_STORAGE_KEY_MAX.
[out]	buf	- Destination for exactly SCE_ID_STORAGE_LEAF_SIZE bytes.

Returns

0 on success, or a negative error code.

ksceIdStorageWriteLeaf()

int ksceIdStorageWriteLeaf	(	SceUInt32	key,
		const void *	buf
	)

Replace one complete IdStorage leaf in the write-back cache.

The key must already exist. Manufacturing mode and writable storage are required, and the caller must pass the IdStorage write-access check. The operation runs under the internal mutex and marks the cached leaf as modified. Changes are not guaranteed to reach storage until ksceIdStorageFlush succeeds.

Parameters

[in]	key	- Leaf key from 0 through SCE_ID_STORAGE_KEY_MAX.
[in]	buf	- Source containing exactly SCE_ID_STORAGE_LEAF_SIZE bytes.

Returns

0 on success, -1 when IdStorage is read-only, or a negative error code.

ksceIdStorageCreateAtomicLeaves()

int ksceIdStorageCreateAtomicLeaves	(	const SceUInt16 *	keys,
		SceInt32	num_leaves
	)

Create several leaf mappings as one in-memory operation.

Every key is validated before the mapping table is changed, and all new mappings are allocated within one 32-entry block. The function does not initialize leaf contents and does not reject duplicate keys within the input array. Call ksceIdStorageFlush to write the changes to storage.

Manufacturing mode and formatted, writable storage are required, and the caller must pass the IdStorage write-access check. The operation holds the IdStorage mutex and suspends interrupts while changing the mapping table.

Parameters

[in]	keys	- Kernel array containing num_leaves 16-bit keys.
[in]	num_leaves	- Number of keys, from 1 through SCE_ID_STORAGE_ATOMIC_LEAVES_MAX.

Returns

0 on success, -1 when IdStorage is read-only, or a negative error code.

ksceIdStorageCreateLeaf()

int ksceIdStorageCreateLeaf

(

SceUInt32

key

)

Create one leaf mapping.

Manufacturing mode and formatted, writable storage are required, and the caller must pass the IdStorage write-access check. The function holds the IdStorage mutex and suspends interrupts while changing only the in-memory mapping table. It does not initialize leaf contents. Call ksceIdStorageFlush to write the mapping changes to storage.

Parameters

[in]

key

- Leaf key from 0 through SCE_ID_STORAGE_KEY_MAX.

Returns

0 on success, -1 when IdStorage is read-only, or a negative error code.

ksceIdStorageDeleteLeaf()

int ksceIdStorageDeleteLeaf

(

SceUInt32

key

)

Delete one leaf mapping.

The underlying leaf sector is not erased. Manufacturing mode and formatted, writable storage are required, and the caller must pass the IdStorage write-access check. The operation holds the IdStorage mutex and suspends interrupts while changing the mapping table. Call ksceIdStorageFlush to write the changes to storage.

Parameters

[in]

key

- Leaf key from 0 through SCE_ID_STORAGE_KEY_MAX.

Returns

0 on success, -1 when IdStorage is read-only, or a negative error code.

ksceIdStorageEnumId()

int ksceIdStorageEnumId

(

void

)

Acquire and release the IdStorage mutex.

Despite its name, this function does not enumerate or return a key on FW 3.60. It only acts as a synchronization barrier.

Returns

0 on success, or the mutex-lock error.

ksceIdStorageFlush()

int ksceIdStorageFlush

(

void

)

Write modified cached leaves and mapping-table changes to storage.

FW 3.60 also calls this function during the process-suspend system event and when the 32-leaf cache must be reused. It writes the changes under the internal IdStorage mutex.

Returns

0 when there is nothing to flush or all writes succeed, otherwise a negative formatting, allocation, mutex, seek, or write error.

ksceIdStorageFormat()

int ksceIdStorageFormat

(

void

)

Initialize a new IdStorage mapping table.

FW 3.60 fills the mapping table with 0xFFFF, marks the first 32 entries with reserved value 0xFFF5, and writes the table immediately. Existing leaf data sectors are not erased. Manufacturing mode is required, and formatting runs under the internal IdStorage mutex.

Returns

0 on success, or a negative error code.

ksceIdStorageGetFreeLeaves()

int ksceIdStorageGetFreeLeaves

(

void

)

Count unallocated mapping entries, which contain 0xFFFF.

The mapping table is scanned under the internal mutex.

Returns

The number of free mapping entries, or a negative error code when IdStorage is not formatted or the mutex cannot be acquired.

ksceIdStorageGetLeafSize()

SceSize ksceIdStorageGetLeafSize

(

void

)

Get the fixed IdStorage leaf size.

Returns

SCE_ID_STORAGE_LEAF_SIZE.

ksceIdStorageIsDirty()

SceBool ksceIdStorageIsDirty

(

void

)

Check whether changes still need to be written to storage.

This check does not acquire a lock; concurrent writes can change the state while it is read.

Returns

SCE_TRUE when the mapping table or a cached leaf has changes to write, otherwise SCE_FALSE.

ksceIdStorageIsFormatted()

SceBool ksceIdStorageIsFormatted

(

void

)

Check whether the mapping table was loaded or formatted successfully.

The state is read without acquiring a lock.

Returns

SCE_TRUE when formatted, otherwise SCE_FALSE.

ksceIdStorageIsReadOnly()

SceBool ksceIdStorageIsReadOnly

(

void

)

Return the cached read-only flag.

The FW 3.60 module never sets this flag internally and clears it after a successful format. The flag is read without acquiring a lock.

Returns

SCE_TRUE when read-only, otherwise SCE_FALSE.

ksceIdStorageLookup()

int ksceIdStorageLookup	(	SceUInt32	key,
		SceUInt32	offset,
		void *	buf,
		SceSize	size
	)

Read a range from an existing leaf.

The caller must pass the IdStorage read-access check. The destination is a kernel buffer. A zero-byte lookup still validates and loads the requested key but does not access buf, so it can check whether the key exists. The operation runs under the internal IdStorage mutex.

Parameters

[in]	key	- Leaf key from 0 through SCE_ID_STORAGE_KEY_MAX.
[in]	offset	- Byte offset below SCE_ID_STORAGE_LEAF_SIZE.
[out]	buf	- Destination for size bytes; not accessed when size is zero.
[in]	size	- Number of bytes. offset + size must not exceed SCE_ID_STORAGE_LEAF_SIZE.

Returns

0 on success, or a negative error code.

ksceIdStorageRestart()

int ksceIdStorageRestart

(

SceBool

flush

)

Destroy and reinitialize the IdStorage state on FW 3.60.

Manufacturing mode is required. When flush is nonzero the function calls ksceIdStorageFlush first, but ignores its return value before destroying and rebuilding the heap, cache, mutex, and partition state. The caller must ensure no other IdStorage operation runs at the same time, because the mutex itself is destroyed and recreated.

Parameters

[in]

flush

- Nonzero to attempt a flush before restarting.

Returns

0 on success, or a negative product-mode or initialization error.

ksceIdStorageUnformat()

int ksceIdStorageUnformat

(

void

)

Mark the IdStorage partition unformatted.

FW 3.60 writes a zero-filled sector at each 32-leaf group boundary and then clears the formatted flag. Individual seek and write failures in that loop are ignored. Manufacturing mode is required, and the loop runs under the internal IdStorage mutex.

Returns

0 after the loop, or a negative product-mode or mutex error before it begins.

ksceIdStorageUpdate()

int ksceIdStorageUpdate	(	SceUInt32	key,
		SceUInt32	offset,
		const void *	buf,
		SceSize	size
	)

Replace a range in an existing leaf through a cached read-modify-write.

Manufacturing mode and formatted, writable storage are required, and the caller must pass the IdStorage write-access check. A zero-byte update still loads the leaf and marks it as modified. The operation runs under the internal IdStorage mutex. Call ksceIdStorageFlush to write the changes to storage.

Parameters

[in]	key	- Leaf key from 0 through SCE_ID_STORAGE_KEY_MAX.
[in]	offset	- Byte offset below SCE_ID_STORAGE_LEAF_SIZE.
[in]	buf	- Source for size bytes; not accessed when size is zero.
[in]	size	- Number of bytes. offset + size must not exceed SCE_ID_STORAGE_LEAF_SIZE.

Returns

0 on success, -1 when IdStorage is read-only, or a negative error code.