NCM services

NCM contains services for internal file path and content management.

lr

This is "nn::lr::ILocationResolverManager".

Cmd	Name
0	OpenLocationResolver
1	OpenRegisteredLocationResolver
2	RefreshLocationResolver
3	[2.0.0+] OpenAddOnContentLocationResolver
4	[15.0.0+] SetEnabled

The only sysmodules which use this service are FS, Loader, and NS. boot2 has access but doesn't use it.

OpenLocationResolver

Takes an input #StorageId. Returns an #ILocationResolver.

OpenRegisteredLocationResolver

No input. Returns an #IRegisteredLocationResolver.

RefreshLocationResolver

Takes an input #StorageId. No output.

OpenAddOnContentLocationResolver

No input. Returns an #IAddOnContentLocationResolver.

SetEnabled

Unofficial name.

Takes a type-0x5 input buffer containing an array of #StorageId. No output.

ILocationResolver

This is "nn::lr::ILocationResolver".

Cmd	Name
0	ResolveProgramPath
1	RedirectProgramPath
2	ResolveApplicationControlPath
3	ResolveApplicationHtmlDocumentPath
4	ResolveDataPath
5	RedirectApplicationControlPath
6	RedirectApplicationHtmlDocumentPath
7	ResolveApplicationLegalInformationPath
8	RedirectApplicationLegalInformationPath
9	Refresh
10	[5.0.0+] RedirectApplicationProgramPath
11	[5.0.0+] ClearApplicationRedirection
12	[5.0.0+] EraseProgramRedirection
13	[5.0.0+] EraseApplicationControlRedirection
14	[5.0.0+] EraseApplicationHtmlDocumentRedirection
15	[5.0.0+] EraseApplicationLegalInformationRedirection
16	[7.0.0+] ResolveProgramPathForDebug
17	[7.0.0+] RedirectProgramPathForDebug
18	[7.0.0+] RedirectApplicationProgramPathForDebug
19	[7.0.0+] EraseProgramRedirectionForDebug
20	[15.0.0+] Disable

If the supplied #StorageId is 1 (Host), a different set of internal functions is used to handle these commands. In this more restricted set of functions, ResolveApplicationControlPath is stubbed and only returns error 0x608.

The Get* commands load the Path from linked-lists' entries in memory using the input #ProgramId. When the command fails to find an entry for the specified #ProgramId, 0x408 is returned for ResolveProgramPath and 0xA08 is returned for the rest.

The Set* commands always return 0 and add a new entry to the list. If a matching entry is found, it's removed first.

ResolveProgramPath

Takes an input #ProgramId and a type-0x1A output buffer. No output.

RedirectProgramPath

Takes an input #ProgramId and a type-0x19 input buffer containing a Path. No output.

Inserts a new entry with flag set to 0.

ResolveApplicationControlPath

Takes an input #ApplicationId and a type-0x1A output buffer. No output.

ResolveApplicationHtmlDocumentPath

Takes an input #ApplicationId and a type-0x1A output buffer. No output.

ResolveDataPath

Takes an input #DataId and a type-0x1A output buffer. No output.

RedirectApplicationControlPath

Takes an input #ApplicationId and a type-0x19 input buffer containing a Path. No output.

[9.0.0+] Now takes an additional 8-bytes of input.

Inserts a new entry with flag set to 1.

RedirectApplicationHtmlDocumentPath

Takes an input #ApplicationId and a type-0x19 input buffer containing a Path. No output.

[9.0.0+] Now takes an additional 8-bytes of input.

Inserts a new entry with flag set to 1.

ResolveApplicationLegalInformationPath

Takes an input #ApplicationId and a type-0x1A output buffer. No output.

RedirectApplicationLegalInformationPath

Takes an input #ApplicationId and a type-0x19 input buffer containing a Path. No output.

[9.0.0+] Now takes an additional 8-bytes of input.

Inserts a new entry with flag set to 1.

Refresh

No input/output.

Frees all linked-lists' entries that have flag set to 0.

RedirectApplicationProgramPath

Same as RedirectProgramPath, but inserts a new entry with flag set to 1.

[9.0.0+] Now takes an additional 8-bytes of input.

ClearApplicationRedirection

No input/output.

Frees all linked-lists' entries that have flag set to 1.

[9.0.0+] Now takes a type-0x5 input buffer.

EraseProgramRedirection

Takes an input #ProgramId. No output.

Removes the entry that matches the input #ProgramId.

EraseApplicationControlRedirection

Takes an input #ApplicationId. No output.

Removes the entry that matches the input #ApplicationId.

EraseApplicationHtmlDocumentRedirection

Takes an input #ApplicationId. No output.

Removes the entry that matches the input #ApplicationId.

EraseApplicationLegalInformationRedirection

Takes an input #ApplicationId. No output.

Removes the entry that matches the input #ApplicationId.

ResolveProgramPathForDebug

Unofficial name.

Same as ResolveProgramPath, but uses a redirection shim on top of the real program path.

NS uses this command if ns.application!redirected_rom_storage_id_for_debug is different than 0x00.

RedirectProgramPathForDebug

Unofficial name.

Same as RedirectProgramPath, but uses a redirection shim on top of the real program path.

NS uses this command if ns.application!redirected_rom_storage_id_for_debug is different than 0x00.

RedirectApplicationProgramPathForDebug

Unofficial name.

Same as RedirectApplicationProgramPath, but uses a redirection shim on top of the real program path.

[9.0.0+] Like #RedirectApplicationProgramPath this now takes an additional 8-bytes of input.

NS uses this command if ns.application!redirected_rom_storage_id_for_debug is different than 0x00.

EraseProgramRedirectionForDebug

Unofficial name.

Same as EraseProgramRedirection, but uses a redirection shim on top of the real program path.

NS uses this command if ns.application!redirected_rom_storage_id_for_debug is different than 0x00.

Disable

Unofficial name.

No input/output.

IRegisteredLocationResolver

This is "nn::lr::IRegisteredLocationResolver".

Cmd	Name
0	ResolveProgramPath
1	RegisterProgramPath
2	UnregisterProgramPath
3	RedirectProgramPath
4	[2.0.0+] ResolveHtmlDocumentPath
5	[2.0.0+] RegisterHtmlDocumentPath
6	[2.0.0+] UnregisterHtmlDocumentPath
7	[2.0.0+] RedirectHtmlDocumentPath
8	[7.0.0+] Refresh
9	[9.0.0+] RefreshExcluding

This works like #ILocationResolver, but only two types of NCA paths can be gotten/set. In addition, each type has a fallback path that can be set for a single #ProgramId at a time.

ResolveProgramPath

Takes an input #ProgramId and a type-0x1A output buffer. No output.

RegisterProgramPath

Takes an input #ProgramId and a type-0x19 input buffer containing a Path. No output.

[9.0.0+] Now takes an additional 8-bytes of input.

UnregisterProgramPath

Takes an input #ProgramId. No output.

RedirectProgramPath

Takes an input #ProgramId and a type-0x19 input buffer containing a Path. No output.

[9.0.0+] Now takes an additional 8-bytes of input.

ResolveHtmlDocumentPath

Takes an input #ApplicationId and a type-0x1A output buffer. No output.

RegisterHtmlDocumentPath

Takes an input #ApplicationId and a type-0x19 input buffer containing a Path. No output.

[9.0.0+] Now takes an additional 8-bytes of input.

UnregisterHtmlDocumentPath

Takes an input #ApplicationId. No output.

RedirectHtmlDocumentPath

Takes an input #ApplicationId and a type-0x19 input buffer containing a Path. No output.

[9.0.0+] Now takes an additional 8-bytes of input.

Refresh

No input/output.

RefreshExcluding

Unofficial name.

Takes a type-0x5 input buffer containing an array of #ProgramId. No output.

IAddOnContentLocationResolver

This is "nn::lr::IAddOnContentLocationResolver".

Cmd	Name
0	ResolveAddOnContentPath
1	RegisterAddOnContentStorage
2	UnregisterAllAddOnContentPath
3	[9.0.0+] RefreshApplicationAddOnContent
4	[9.0.0+] UnregisterApplicationAddOnContent
5	[15.0.0+] GetRegisteredAddOnContentPaths
6	[15.0.0+] RegisterAddOnContentPath
7	[15.0.0+] RegisterAddOnContentPaths

ResolveAddOnContentPath

Takes an input #DataId and a type-0x1A output buffer. No output.

RegisterAddOnContentStorage

Takes an input #StorageId and an input #DataId. No output.

[9.0.0+] Now takes an additional input #ApplicationId for the owner application.

UnregisterAllAddOnContentPath

No input/output.

RefreshApplicationAddOnContent

Unofficial name.

Takes a type-0x5 input buffer containing an array of #ApplicationId. No output.

Unregisters entries with IDs absent from the input buffer.

UnregisterApplicationAddOnContent

Unofficial name.

Takes an input #ApplicationId. No output.

Unregisters add on content entries for the input #ApplicationId.

GetRegisteredAddOnContentPaths

Unofficial name.

Takes an input #DataId and two type-0x16 output buffers. No output.

RegisterAddOnContentPath

Unofficial name.

Takes an input #DataId, an input #ApplicationId and a type-0x15 input buffer. No output.

RegisterAddOnContentPaths

Unofficial name.

Takes an input #DataId, an input #ApplicationId and two type-0x15 input buffers. No output.

ncm

This is "nn::ncm::IContentManager".

Cmd	Name
0	CreateContentStorage
1	CreateContentMetaDatabase
2	VerifyContentStorage
3	VerifyContentMetaDatabase
4	OpenContentStorage
5	OpenContentMetaDatabase
6	[1.0.0] CloseContentStorageForcibly
7	[1.0.0] CloseContentMetaDatabaseForcibly
8	CleanupContentMetaDatabase
9	[2.0.0+] ActivateContentStorage
10	[2.0.0+] InactivateContentStorage
11	[2.0.0+] ActivateContentMetaDatabase
12	[2.0.0+] InactivateContentMetaDatabase
13	[9.0.0+] InvalidateRightsIdCache
14	[10.0.0+] GetMemoryReport
15	[16.0.0+] ActivateFsContentStorage

CreateContentStorage

Takes an input #StorageId. No output.

CreateContentMetaDatabase

Takes an input #StorageId. No output.

VerifyContentStorage

Takes an input #StorageId. No output.

VerifyContentMetaDatabase

Takes an input #StorageId. No output.

OpenContentStorage

Takes an input #StorageId. Returns an #IContentStorage.

[2.0.0+] Only returns a storage if one has previously been opened globally via CreateContentStorage.

OpenContentMetaDatabase

Takes an input #StorageId. Returns an #IContentMetaDatabase.

[2.0.0+] Only returns a storage if one has previously been opened globally via CreateContentStorage.

CloseContentStorageForcibly

Takes an input #StorageId. No output.

CloseContentMetaDatabaseForcibly

Takes an input #StorageId. No output.

CleanupContentMetaDatabase

Takes an input #StorageId. No output.

ActivateContentStorage

Takes an input #StorageId. No output.

InactivateContentStorage

Takes an input #StorageId. No output.

ActivateContentMetaDatabase

Takes an input #StorageId. No output.

InactivateContentMetaDatabase

Takes an input #StorageId. No output.

InvalidateRightsIdCache

No input/output.

GetMemoryReport

No input. Returns an output #MemoryReport.

ActivateFsContentStorage

Takes an input ContentStorageId. No output.

IContentStorage

This is "nn::ncm::IContentStorage".

Cmd	Name
0	GeneratePlaceHolderId
1	CreatePlaceHolder
2	DeletePlaceHolder
3	HasPlaceHolder
4	WritePlaceHolder
5	Register
6	Delete
7	Has
8	GetPath
9	GetPlaceHolderPath
10	CleanupAllPlaceHolder
11	ListPlaceHolder
12	GetContentCount
13	ListContentId
14	GetSizeFromContentId
15	DisableForcibly
16	[2.0.0+] RevertToPlaceHolder
17	[2.0.0+] SetPlaceHolderSize
18	[2.0.0+] ReadContentIdFile
19	[2.0.0+] GetRightsIdFromPlaceHolderId
20	[2.0.0+] GetRightsIdFromContentId
21	[2.0.0+] WriteContentForDebug
22	[2.0.0+] GetFreeSpaceSize
23	[2.0.0+] GetTotalSpaceSize
24	[3.0.0+] FlushPlaceHolder
25	[4.0.0+] GetSizeFromPlaceHolderId
26	[4.0.0+] RepairInvalidFileAttribute
27	[8.0.0+] GetRightsIdFromPlaceHolderIdWithCache
28	[13.0.0+] RegisterPath
29	[13.0.0+] ClearRegisteredPath
30	[17.0.0+] GetProgramId

GeneratePlaceHolderId

No input. Returns an output #PlaceHolderId.

Calls nn::util::GenerateUuid(), which internally calls nn::os::GenerateRandomBytes(16);

CreatePlaceHolder

Takes an input #ContentId, an input #PlaceHolderId and an input s64 FileSize. No output.

DeletePlaceHolder

Takes an input #PlaceHolderId. No output.

HasPlaceHolder

Takes an input #PlaceHolderId. Returns an output bool.

WritePlaceHolder

Takes an input #PlaceHolderId, an input u64 Offset and a type-0x5 input buffer. No output.

Writes the buffer to the file for the placeholder path at the specified offset.

Register

Takes a #ContentId and a #PlaceHolderId, no output. Moves the Placeholder NCA content to the registered NCA path.

Delete

Takes a #ContentId.

Has

Takes a #ContentId.

GetPath

Takes a #ContentId and a type-0x1A output buffer containing a Path.

GetPlaceHolderPath

Takes a #PlaceHolderId and a type-0x1A output buffer containing a Path.

CleanupAllPlaceHolder

No input/output.

Deletes and re-creates the "Placeholder" directory.

ListPlaceHolder

This is like GetNumberOfRegisteredEntries, but for the "Placeholder" directory.

GetContentCount

No input. Returns an output u32 Count.

ListContentId

Takes an output buffer, s32 offset and gets all entries starting at that offset. Returns number of entries read.

Each entry is a #ContentId.

The total read entries is exactly the same as the number of "<hex>.nca" directories in the storage FS(or at least under the "registered" directory?).

GetSizeFromContentId

Takes a #ContentId as input.

Returns the total size readable by #ReadContentIdFile. This is the same as the size-field in the NAX0 "<ContentId>.nca/00" file.

DisableForcibly

No input/output.

Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.

RevertToPlaceHolder

Takes two #ContentId and a #PlaceHolderId, no output.

Creates the registered directory NCA path, and renames the placeholder path to the registered NCA path.

SetPlaceHolderSize

Takes a #PlaceHolderId, and a s64 size, no output.

ReadContentIdFile

Takes a type-0x6 output buffer, a #ContentId as input, and a s64 file offset.

Reads plaintext NCA file contents from the "Registered" path for the ContentId.

GetRightsIdFromPlaceHolderId

Takes a #PlaceHolderId, returns a #RightsId.

Gets the Rights ID for the #PlaceHolderId's placeholder path.

GetRightsIdFromContentId

Takes a #ContentId, returns a #RightsId.

Gets the Rights ID for the #ContentId's registered path

WriteContentForDebug

Takes a #ContentId, a u64 offset, and a type-0x5 input buffer.

On debug units, writes the buffer to the NCA's registered path. On retail units, this just aborts.

IContentMetaDatabase

This is "nn::ncm::IContentMetaDatabase".

Cmd	Name
0	Set
1	Get
2	Remove
3	GetContentIdByType
4	ListContentInfo
5	List
6	GetLatestContentMetaKey
7	ListApplication
8	Has
9	HasAll
10	GetSize
11	GetRequiredSystemVersion
12	GetPatchId
13	DisableForcibly
14	LookupOrphanContent
15	Commit
16	HasContent
17	ListContentMetaInfo
18	GetAttributes
19	[2.0.0+] GetRequiredApplicationVersion
20	[5.0.0+] GetContentIdByTypeAndIdOffset
21	[10.0.0+] GetCount
22	[10.0.0+] GetOwnerApplicationId
23	[15.0.0+] GetContentAccessibilities
24	[15.0.0+] GetContentInfoByType
25	[15.0.0+] GetContentInfoByTypeAndIdOffset
26	[17.0.0+] GetPlatform

Set

Takes a #ContentMetaKey, a type-5 PackagedContentInfo buffer and a u64 size.

Get

Takes a #ContentMetaKey, a type-6 buffer to write PackagedContentInfo to and a u64 size. Returns the actual number of bytes read into the buffer.

First 8 bytes of the data is header (u16 numExtraDataBytes, numContentRecords, numMetaRecords, padding). After the header is numExtraDataBytes of additional data, after which follow content records and content meta keys. Set takes this same data as input.

Remove

Takes a #ContentMetaKey, and removes the associated record.

GetContentIdByType

Takes a #ContentMetaKey and a u8 #ContentType. Returns a #ContentId.

ListContentInfo

Takes a type-6 buffer to write PackagedContentInfo entries to, a #ContentMetaKey, and a s32 index into the entries to start copying from. Returns a s32 entries_read.

List

Takes a type-6 buffer to write #ContentMetaKeys to, a u32 #ContentMetaType, a #ProgramId, a u64 ProgramId_Low, and u64 ProgramId_High. Returns s32 numEntriesTotal, numEntriesWritten.

Writes into the buffer all Content Meta Keys with low <= record->title_id <= high, and record->type == type. Additionally requires record->title_id == TID, if record->type is Application, Patch, Add-On, or Delta, otherwise, you can pass 0 for type to ignore the type and list them all in the range.

GetLatestContentMetaKey

Takes a #ProgramId, and returns the #ContentMetaKey with the highest version field for that #ProgramId.

ListApplication

This function takes in a type 6 buffer to write ApplicationContentMetaKey entries to, and a u8 "filter". If filter is zero, all update records will be copied to to the output buffer (space permitting). Otherwise, only titles with type == filter_type will be copied to the output buffer.

This func returns a s32 num_entries_total, and a s32 num_entries_written.

Has

Takes a #ContentMetaKey and returns an output u8 bool indicating whether that record is present in the database.

HasAll

Takes a type-0x5 input buffer containing an array of #ContentMetaKey, and returns whether all of those records are present in the database.

GetSize

Takes a #ContentMetaKey, and returns the size of the associated PackagedContentInfo.

GetRequiredSystemVersion

Takes an input #ContentMetaKey. Returns an output u32 RequiredSystemVersion.

GetPatchId

Takes a #ContentMetaKey, and returns the update #ProgramId for that record.

DisableForcibly

Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.

LookupOrphanContent

Takes a type-6 byte buffer, and a type-0x5 buffer containing an array of #ContentId.

This function was stubbed to return 0xDC05 in 2.0.0.

On 1.0.0: Initialized the output buffer to all 1s. Then, for each #ContentId in the input buffer, it checks if that ContentId is present anywhere in the database, and if so writes 0 to the corresponding output byte.

In pseudocode, the function basically does the following:

for i in range(len(out_buf)):
    out_buf[i] = 1

for i, ContentId in ContentId:
    if is_present_in_database(ContentId):
        out_buf[i] = 0

Commit

Flushes the in-memory database to savedata.

HasContent

Takes a #ContentMetaKey and an #ContentId. Returns whether the content records for that content meta key contain the #ContentId.

ListContentMetaInfo

Takes a type-6 #ContentMetaKey output buffer, a s32 offset into that buffer, and an input #ContentMetaKey.

GetAttributes

Takes an input #ContentMetaKey. Returns an output u8 Attributes.

GetRequiredApplicationVersion

Does the same thing as GetRequiredSystemVersion, but for AddOnContents.

GetContentIdByTypeAndIdOffset

Takes a #ContentMetaKey, a u8 #ContentType and a u8 id_offset. Returns a #ContentId.

GetCount

Returns a u32 count.

GetOwnerApplicationId

Takes a #ContentMetaKey. Returns a #ApplicationId.

ncm:v

This is "nn::ncm::ISystemVersionManager".

This service doesn't exist on retail.

Cmd	Name
0	GetSystemVersion

GetSystemVersion

No input. Returns an output u32 SystemVersion.

LocationListEntry

Total size is 0x320 bytes.

Offset	Size	Description
0x0	0x8	Pointer to previous entry
0x8	0x8	Pointer to next entry
0x10	0x8	#ProgramId
0x18	0x300	Path
0x318	0x4	Flag
0x31C	0x4	Padding

ContentId

This is "nn::ncm::ContentId".

This is a 0x10-byte entry. This is originally from the hex portion of "<hex>.nca" directory-names from this storage FS(like SD).

The ContentId is the same as the first 0x10-bytes from the calculated SHA256 hash, from hashing the entire output from #ReadContentIdFile.

PlaceHolderId

This is "nn::ncm::PlaceHolderId".

This is the same as #ContentId, except this is for placeholder content and originates from #GeneratePlaceHolderId.

ProgramId

This is "nn::ncm::ProgramId" or "nn::ncm::SystemProgramId".

This is an u64 ID bound to a program.

DataId

This is "nn::ncm::DataId" or "nn::ncm::SystemDataId".

This is an u64 ID bound to a data archive.

ApplicationId

This is "nn::ncm::ApplicationId" or "nn::ncm::SystemApplicationId".

This is an u64 ID bound to an application.

Value 0 is invalid.

PatchId

This is "nn::ncm::PatchId".

This is an u64 ID bound to a program patch.

DeltaId

This is "nn::ncm::DeltaId".

This is an u64 ID bound to a program delta fragment.

AddOnContentId

This is "nn::ncm::AddOnContentId".

This is an u64 ID bound to add-on content data.

SystemUpdateId

This is "nn::ncm::SystemUpdateId".

This is an u64 ID bound to system update data.

DataPatchId

This is "nn::ncm::DataPatchId".

This was added with [15.0.0+].

This is an u64 ID bound to a data patch.

StorageId

This is "nn::ncm::StorageId".

Value	Name
0	None
1	Host
2	GameCard
3	BuiltInSystem
4	BuiltInUser
5	SdCard
6	Any

"None" and "Any" are meta storages.

nn::ncm::IsInstallableStorage returns true for BuiltInSystem, BuiltInUser, SdCard, and Any.

nn::ncm::IsUniqueStorage returns true for != None && != Any.

RightsId

This is "nn::ncm::RightsId".

This is a 0x10-byte struct. [3.0.0+] This is a 0x18-byte struct.

Offset	Size	Description
0x0	0x10	FS Rights ID
0x10	0x1	[3.0.0+] KeyGeneration
0x11	0x7	[3.0.0+] Padding

ProgramLocation

This is "nn::ncm::ProgramLocation".

Offset	Size	Description
0x0	0x8	#ProgramId
0x8	0x1	#StorageId
0x9	0x7	Padding

Path

This is "nn::ncm::Path". This is a 0x300-byte string.

ContentInstallType

This is "nn::ncm::ContentInstallType".

Value	Description
0x0	Full
0x1	FragmentOnly
0x7	Invalid

ContentMetaType

This is "nn::ncm::ContentMetaType".

Value	Description
0x00	Invalid
0x01	SystemProgram (System Modules or System Applets)
0x02	SystemData (System Data Archives)
0x03	SystemUpdate
0x04	BootImagePackage (Firmware package A or C)
0x05	BootImagePackageSafe (Firmware package B or D)
0x80	Application
0x81	Patch
0x82	AddOnContent
0x83	Delta
0x84	[15.0.0+] DataPatch

ContentMetaPlatform

This is "nn::ncm::ContentMetaPlatform".

Value	Description
0	Nx

ContentType

This is "nn::ncm::ContentType".

Value	Description
0	Meta
1	Program
2	Data
3	Control
4	HtmlDocument
5	LegalInformation
6	DeltaFragment

ContentMetaKey

This is "nn::ncm::ContentMetaKey".

Offset	Size	Description
0x0	0x8	#ProgramId
0x8	0x4	Version
0xC	0x1	#ContentMetaType
0xD	0x1	#ContentInstallType
0xE	0x2	Padding

ApplicationContentMetaKey

This is "nn::ncm::ApplicationContentMetaKey".

Offset	Size	Description
0x0	0x10	ContentMetaKey
0x10	0x8	ApplicationId

MemoryReport

This is "nn::ncm::MemoryReport".

Offset	Size	Description
0x0	0x20	SystemContentMetaResourceState
0x20	0x20	SdAndUserContentMetaResourceState
0x40	0x20	GamecardContentMetaResourceState
0x60	0x20	HeapResourceState

MemoryResourceState

Offset	Size	Description
0x0	0x8	PeakTotalAllocSize
0x8	0x8	PeakAllocSize
0x10	0x8	AllocatableSize
0x18	0x8	TotalFreeSize