Kernel

Exports for Kernel. More...

Data Structures
struct	SceSblSmCommPair
struct	SceSmInvokeDataBlockInput
	Startup data whose meaning is defined by the secure module. More...
struct	SceSblSmCommContext130
	Identity and media context used to start a secure module. More...

Typedefs
typedef SceUInt32	SceSmSchedRequestId
	Secure-module scheduler request ID.
typedef int	SceSblSmCommId
	Signed VitaSDK type for SceSmSchedRequestId; -1 means no active request.

Functions
	VITASDK_BUILD_ASSERT_EQ (8, SceSblSmCommPair)
	VITASDK_BUILD_ASSERT_EQ (0x10, SceSmInvokeDataBlockInput)
	VITASDK_BUILD_ASSERT_EQ (0x130, SceSblSmCommContext130)
int	ksceSblSmCommStartSmFromFile (SceUInt32 priority, const char *sm_self_path, SceUInt32 invoke_input, SceAuthInfo *ctx_130, SceSblSmCommId *req_id)
	Starts a secure module from a file.
int	ksceSblSmCommStartSmFromData (SceBool priority, const void *sm_self, SceSize sm_self_size, const SceSmInvokeDataBlockInput *invoke_input, const SceSblSmCommContext130 *ctx_130, SceSmSchedRequestId *req_id)
	Starts a secure module from a memory image.
int	ksceSblSmCommCallFunc (SceSblSmCommId req_id, SceUInt32 func_id, SceUInt32 *response, void *data, SceSize data_size)
	Executes a function in a running secure module.
int	ksceSblSmCommStopSm (SceSblSmCommId req_id, SceSblSmCommPair *result)
	Stops a running secure module and releases its communication slot.

Variables
int	SceSblSmCommPair::data_00
int	SceSblSmCommPair::data_04
SceUInt32	SceSmInvokeDataBlockInput::words [4]
SceUInt32	SceSblSmCommContext130::reserved0
	Ignored on FW 3.60.
SceUInt32	SceSblSmCommContext130::self_type
	SELF type and scheduler invocation tag.
SceSelfAuthInfo	SceSblSmCommContext130::spawner_self_auth_info
	The program authority ID and capability are forwarded.
SceSelfAuthInfo	SceSblSmCommContext130::reserved_self_auth_info
	Ignored on FW 3.60.
SceUInt32	SceSblSmCommContext130::media_type
	Media type of the secure-module SELF.
SceUInt32	SceSblSmCommContext130::reserved1
	Ignored on FW 3.60.

Detailed Description

Exports for Kernel.

---

Using this library in your project

Include the header file in your project:

#include <psp2kern/kernel/sm_comm.h> 

Link the library to the executable:

SceSblSmCommForKernel_stub 

---

---

Data Structure Documentation

SceSblSmCommPair

struct SceSblSmCommPair

Data Fields
int	data_00
int	data_04

SceSmInvokeDataBlockInput

struct SceSmInvokeDataBlockInput

Startup data whose meaning is defined by the secure module.

The FW 3.60 scheduler copies all four words unchanged into the secure-module startup command. It does not interpret the words; their meanings are defined by the secure module being started. QAF supplies { 0xFF, 0, 0, 0 }, while every other reviewed FW 3.60 caller passes NULL and therefore supplies four zeros.

Data Fields
SceUInt32	words[4]

SceSblSmCommContext130

struct SceSblSmCommContext130

Identity and media context used to start a secure module.

FW 3.60 forwards only self_type, media_type, and the program authority ID and capability from spawner_self_auth_info. The remaining fields are not forwarded or modified. All reviewed SceSblSmComm callers initialize the structure to zero, set bits 0-3 of self_type to 2, and obtain media_type from ACMgr or use value 2 for an embedded image. Because both SceSblSmComm start exports supply physical image ranges, the scheduler invocation tag in bits 12 through 15 of self_type must be zero on FW 3.60.

Data Fields
SceUInt32	reserved0	Ignored on FW 3.60.
SceUInt32	self_type	SELF type and scheduler invocation tag.
SceSelfAuthInfo	spawner_self_auth_info	The program authority ID and capability are forwarded.
SceSelfAuthInfo	reserved_self_auth_info	Ignored on FW 3.60.
SceUInt32	media_type	Media type of the secure-module SELF.
SceUInt32	reserved1	Ignored on FW 3.60.

Typedef Documentation

SceSmSchedRequestId

typedef SceUInt32 SceSmSchedRequestId

Secure-module scheduler request ID.

SceSblSmCommId

typedef int SceSblSmCommId

Signed VitaSDK type for SceSmSchedRequestId; -1 means no active request.

Function Documentation

VITASDK_BUILD_ASSERT_EQ() [1/3]

VITASDK_BUILD_ASSERT_EQ	(	8	,
		SceSblSmCommPair
	)

VITASDK_BUILD_ASSERT_EQ() [2/3]

VITASDK_BUILD_ASSERT_EQ	(	0x10	,
		SceSmInvokeDataBlockInput
	)

VITASDK_BUILD_ASSERT_EQ() [3/3]

VITASDK_BUILD_ASSERT_EQ	(	0x130	,
		SceSblSmCommContext130
	)

ksceSblSmCommStartSmFromFile()

int ksceSblSmCommStartSmFromFile	(	SceUInt32	priority,
		const char *	sm_self_path,
		SceUInt32	invoke_input,
		SceAuthInfo *	ctx_130,
		SceSblSmCommId *	req_id
	)

Starts a secure module from a file.

This function reads at most 0x20000 bytes, copies the SELF into private kernel memory, converts that image to physical ranges, and starts a scheduler request. You may reuse or free the path, startup data, and context after this function returns. A successful request remains active until ksceSblSmCommStopSm is called.

This function blocks and must be called from a kernel thread, not interrupt context. FW 3.60 supports at most 32 SceSblSmComm requests. It reserves a slot before validating or loading the image and does not restore the slot semaphore after a failed start. Repeated failures can therefore prevent further starts until the module is reloaded.

Parameters

priority	- 0 for high priority, 1 for low priority. Other values are rejected with 0x800F0416 on FW 3.60.
sm_self_path	- Path to the secure module SELF.
invoke_input	- Optional data forwarded to the scheduler proxy. Passing NULL forwards four zero words.
ctx_130	- Required pointer to a structure with a layout equivalent to SceSblSmCommContext130. Still declared as SceAuthInfo for backwards compatibility.
req_id	- Required request-ID output. Still declared as SceSblSmCommId for backwards compatibility. Only use the value when the function succeeds.

Returns

0 on success. Returns 0x800F0016 when the file exceeds 0x20000 bytes, 0x800F0005 after a short read, 0x800F000C after an image allocation failure, or another negative scheduler, I/O, or kernel error.

ksceSblSmCommStartSmFromData()

int ksceSblSmCommStartSmFromData	(	SceBool	priority,
		const void *	sm_self,
		SceSize	sm_self_size,
		const SceSmInvokeDataBlockInput *	invoke_input,
		const SceSblSmCommContext130 *	ctx_130,
		SceSmSchedRequestId *	req_id
	)

Starts a secure module from a memory image.

The supplied image is copied into private kernel memory before the scheduler request is created. You may reuse or free the image, startup data, and context after this function returns. A successful request remains active until ksceSblSmCommStopSm is called.

Like ksceSblSmCommStartSmFromFile, this function blocks and must be called from a kernel thread, not interrupt context. It shares the same 32-request limit and failure to restore the slot semaphore after a failed start.

Parameters

priority	- 0 for high priority, 1 for low priority. Other values are rejected with 0x800F0416 on FW 3.60.
sm_self	- Required secure-module SELF image when sm_self_size is nonzero.
sm_self_size	- Size of the secure module SELF image.
invoke_input	- Optional startup data. Passing NULL forwards four zero words.
ctx_130	- Required secure-module launch context.
req_id	- Required request-ID output. Only use the value when the function succeeds.

Returns

0 on success. Returns 0x800F0016 when sm_self_size exceeds 0x20000, 0x800F000C after an image allocation failure, or another negative scheduler or kernel error.

ksceSblSmCommCallFunc()

int ksceSblSmCommCallFunc	(	SceSblSmCommId	req_id,
		SceUInt32	func_id,
		SceUInt32 *	response,
		void *	data,
		SceSize	data_size
	)

Executes a function in a running secure module.

FW 3.60 copies exactly data_size bytes into the request's private 0x1000-byte command buffer, sends func_id through scheduler mailbox 1, waits for completion, and copies the same number of bytes back. You may reuse or free the data and response buffers after this function returns. The return value reports transport success or failure, not the secure module's result.

A request has only one command buffer and completion event flag, with no per-request lock. Do not run calls using the same req_id concurrently; this includes calls to ksceSblSmCommStopSm. Callers must also enforce the 0xFC0 limit themselves: the FW 3.60 size check adds 0x40 before comparing against 0x1000 and does not guard that addition against unsigned overflow.

Function ID 0xFFFFFFFF is reserved for the asynchronous stop protocol. That value makes the function return after sending the mailbox command, without waiting for a reply or copying data back. Use ksceSblSmCommStopSm instead. For an ordinary command, FW 3.60 maps mailbox completion values 2, 4, and 8 to 0x800F0002, 0x800F0001, and 0x800F0005 respectively; another nonzero completion value is mapped to 0x800F0016.

Parameters

req_id	- Secure-module scheduler request ID.
func_id	- Function ID sent to the secure module.
response	- Optional output for the secure-module response value.
data	- In/out payload buffer. Required when data_size is nonzero.
data_size	- Payload size in bytes, which may not exceed 0xFC0.

Returns

0 on transport success. Returns 0x800F0026 if req_id does not identify an active communication slot, 0x800F000C when the checked command size is too large, or another negative scheduler or kernel error. On transport success the secure-module result is returned separately through response.

ksceSblSmCommStopSm()

int ksceSblSmCommStopSm	(	SceSblSmCommId	req_id,
		SceSblSmCommPair *	result
	)

Stops a running secure module and releases its communication slot.

FW 3.60 sends the asynchronous function ID 0xFFFFFFFF, frees the command buffer and completion event, releases the SceSblSmComm slot, and waits for the scheduler's final result. Scheduler error 0x800F0429 means the request is treated as already stopped; cleanup and the wait still proceed. Once this cleanup begins, req_id must not be reused even if the final wait returns an error.

Parameters

req_id	- Secure-module scheduler request ID.
result	- Required output. Its first word receives the secure-module result and its second word receives the final scheduler state.

Returns

0 on transport and cleanup success, or a negative command, scheduler, semaphore, or kernel error.

Variable Documentation

data_00

int SceSblSmCommPair::data_00

data_04

int SceSblSmCommPair::data_04

words

SceUInt32 SceSmInvokeDataBlockInput::words[4]

reserved0

SceUInt32 SceSblSmCommContext130::reserved0

Ignored on FW 3.60.

self_type

SceUInt32 SceSblSmCommContext130::self_type

SELF type and scheduler invocation tag.

spawner_self_auth_info

SceSelfAuthInfo SceSblSmCommContext130::spawner_self_auth_info

The program authority ID and capability are forwarded.

reserved_self_auth_info

SceSelfAuthInfo SceSblSmCommContext130::reserved_self_auth_info

Ignored on FW 3.60.

media_type

SceUInt32 SceSblSmCommContext130::media_type

Media type of the secure-module SELF.

reserved1

SceUInt32 SceSblSmCommContext130::reserved1

Ignored on FW 3.60.