Nintendo Switch Brew - User contributions [en]

NCM services

2019-10-01T09:55:34Z

Adubbz: RefreshExcluding

NCM contains services for internal file path and content management.

= Location Resolver services =
== lr ==
This is "nn::lr::ILocationResolverManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || OpenLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 1 || OpenRegisteredLocationResolver || None ||
|-
| 2 || RefreshLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 3 || [2.0.0+] OpenAddOnContentLocationResolver || None ||
|}

The only sysmodules which use this service are [[Filesystem_services|FS]], [[Loader_services|Loader]], and [[NS_Services|NS]]. [[boot2]] has access but doesn't use it.

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 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]] || Unofficial name
|-
| 17 || [7.0.0+] [[#RedirectProgramPathForDebug]] || Unofficial name
|-
| 18 || [7.0.0+] [[#RedirectApplicationProgramPathForDebug]] || Unofficial name
|-
| 19 || [7.0.0+] [[#EraseProgramRedirectionForDebug]] || Unofficial name
|}

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

The Get* commands load the [[Filesystem_services|ContentPath]] from linked-lists' [[#Location_List_Entry|entries]] in memory using the input TitleID. When the command fails to find an entry for the specified TitleID, 0x408 is returned for GetProgramNcaPath 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 u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

==== RedirectProgramPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 0.

==== ResolveApplicationControlPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== ResolveApplicationHtmlDocumentPath====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

==== ResolveDataPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== RedirectApplicationControlPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

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

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== RedirectApplicationHtmlDocumentPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

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

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ResolveApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

==== RedirectApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

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

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== Refresh ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 0.

==== RedirectApplicationProgramPath ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

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

==== ClearApplicationRedirection ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 1.

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

==== EraseProgramRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationControlRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationHtmlDocumentRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationLegalInformationRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== ResolveProgramPathForDebug ====
Same as [[#ResolveProgramPath|ResolveProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectProgramPathForDebug ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectApplicationProgramPathForDebug ====
Same as [[#RedirectApplicationProgramPath |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_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== EraseProgramRedirectionForDebug ====
Same as [[#EraseProgramRedirection |EraseProgramRedirection ]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

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

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 title ID at a time.

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveProgramPath || u64 TitleID + C descriptor || Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
|-
| 1 || RegisterProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. || Sets the Type 0 fallback TID and path to the provided arguments.
|-
| 2 || UnregisterProgramPath || u64 TitleID || If the Type 0 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 3 || RedirectProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. ||
|-
| 4 || [2.0.0+] ResolveHtmlDocumentPath || u64 TitleID + C descriptor ||
|-
| 5 || [2.0.0+] RegisterHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. || Sets the Type 1 fallback TID and path to the provided arguments.
|-
| 6 || [2.0.0+] UnregisterHtmlDocumentPath || u64 TitleID || If the Type 1 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 7 || [2.0.0+] RedirectHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. ||
|-
| 8 || [7.0.0+] Refresh || No input/output. ||
|-
| 9 || [9.0.0+] RefreshExcluding || Type-5 buffer || Unofficial name. Refreshes entries excluding those with application title ids contained in the buffer.
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveAddOnContentPath || u64 TitleID + C descriptor ||
|-
| 1 || RegisterAddOnContentStorage || [[Filesystem_services#StorageId|StorageID]] + u64 TitleID [9.0.0+] Now takes an additional u64 TitleID for the owner application. ||
|-
| 2 || UnregisterAllAddOnContentPath || None || Clears all registered titles here.
|-
| 3 || [9.0.0+] [[#RefreshApplicationAddOnContent]] || Type-5 buffer || Unofficial name
|-
| 4 || [9.0.0+] [[#UnregisterApplicationAddOnContent]] || u64 TitleID || Unofficial name
|}

==== RefreshApplicationAddOnContent ====
Takes an type-5 buffer containing application title ids. Unregisters entries with application ids absent from the input buffer.

==== UnregisterApplicationAddOnContent====
Takes an u64 '''TitleID''' for the application to unregister add on content entries for.

=== Location List Entry ===
Total size is 0x320 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8|| Pointer to previous entry
|-
| 0x8 || 0x8|| Pointer to next entry
|-
| 0x10 || 0x8|| TitleID
|-
| 0x18 || 0x300 || [[Filesystem_services|ContentPath]]
|-
| 0x318 || 0x4 || Flag
|-
| 0x31C || 0x4 || Padding
|}

= Content Manager services =
== ncm ==
This is "nn::ncm::IContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || CreateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 1 || CreateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 2 || VerifyContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 3 || VerifyContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 4 || OpenContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 5 || OpenContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 6 || [1.0.0] CloseContentStorageForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentStorage->CloseAndFlushStorage().
|-
| 7 || [1.0.0] CloseContentMetaDatabaseForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentMetaDatabase->CloseMetaDatabase().
|-
| 8 || CleanupContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and deletes the associated savedata.
|-
| 9 || [2.0.0+] ActivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentStorage for the StorageID to be gotten with GetIContentStorage. Note: Name is not official.
|-
| 10 || [2.0.0+] InactivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentStorage. Note: Name is not official.
|-
| 11 || [2.0.0+] ActivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentMetaDatabase for the StorageID to be gotten with GetIContentMetaDatabase. Note: Name is not official.
|-
| 12 || [2.0.0+] InactivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentMetaDatabase. Note: Name is not official.
|-
| 13 || [9.0.0+] InvalidateRightsIdCache ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GeneratePlaceHolderId]] || Returns a random UUID for the Content Storage.
|-
| 1 || CreatePlaceHolder || Takes two [[#NcaID]]s, and a u64 filesize.
|-
| 2 || DeletePlaceHolder || Takes a [[#NcaID]].
|-
| 3 || HasPlaceHolder || Takes a [[#NcaID]].
|-
| 4 || WritePlaceHolder || Takes a [[#NcaID]], a u64-offset, and type 5 buffer. Writes the buffer to the file for the NcaID's placeholder path at the specified offset.
|-
| 5 || Register || Takes two [[#NcaID]]s, moves the Placeholder NCA content to the registered NCA path.
|-
| 6 || Delete || Takes a [[#NcaID]].
|-
| 7 || Has || Takes a [[#NcaID]].
|-
| 8 || GetPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 9 || GetPlaceHolderPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 10 || CleanupAllPlaceHolder || Deletes and re-creates the Placeholder directory.
|-
| 11 || ListPlaceHolder || This is like [[#GetNumberOfRegisteredEntries]], but for the Placeholder directory.
|-
| 12 || [[#GetContentCount]] ||
|-
| 13 || [[#ListContentId]] ||
|-
| 14 || [[#GetSizeFromContentId]] ||
|-
| 15 || DisableForcibly || Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.
|-
| 16 || [2.0.0+] RevertToPlaceHolder || Takes three 0x10-sized [[#NcaID]]s. Creates the registered directory NCA path, and renames the placeholder path to the registered NCA path.
|-
| 17 || [2.0.0+] SetPlaceHolderSize || Takes a [[#NcaID]], and a u64 size
|-
| 18 || [2.0.0+] [[#ReadContentIdFile]] ||
|-
| 19 || [2.0.0+] [[#GetRightsIdFromPlaceHolderId]] ||
|-
| 20 || [2.0.0+] [[#GetRightsIdFromContentId]] ||
|-
| 21 || [2.0.0+] WriteContentForDebug || Takes a [[#NcaID]], a u64 offset, and a type 5 buffer. On debug units, writes the buffer to the NCA's registered path. On retail units, this just aborts.
|-
| 22 || [2.0.0+] GetFreeSpaceSize || Gets free space for the storage.
|-
| 23 || [2.0.0+] GetTotalSpaceSize || Gets total space for the storage.
|-
| 24 || [3.0.0+] FlushPlaceHolder || Flushes resources for the storage without closing it.
|-
| 25 || [4.0.0+] GetSizeFromPlaceHolderId ||
|-
| 26 || [4.0.0+] RepairInvalidFileAttribute ||
|-
| 27 || [8.0.0+] GetRightsIdFromPlaceHolderIdWithCache ||
|}

==== GeneratePlaceHolderId ====
Generates a random [[#NcaID]] for use as a placeholder.

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

==== GetContentCount ====
Writes the total number of entries which can be read by GetEntries, to cmdreply <SFCO_offset>+0x10.

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

Each entry is a [[#NcaID]].

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 [[#NcaID]] as input.

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

==== ReadContentIdFile ====
Takes an output buffer, a [[#NcaID]] as input, and a u64 file offset.

Reads plaintext NCA file contents from the Registered path for the NcaID.

==== GetRightsIdFromPlaceHolderId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s placeholder path.

==== GetRightsIdFromContentId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s registered path

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Set || Takes a [[#ContentMetaKey|Content Meta Key]], a type-5 [[CNMT#Content_records|Content Records]] buffer and a u64 size.
|-
| 1 || Get || Takes a [[#ContentMetaKey|Content Meta Key]], a type-6 buffer to write [[CNMT#Content_records|Content Records]] 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.
|-
| 2 || Remove || Takes a [[#ContentMetaKey|Content Meta Key]], and removes the associated record.
|-
| 3 || GetContentIdByType || Takes a [[#ContentMetaKey|Content Meta Key]] and a u8 [[#ContentMetaType|Content Meta Type]]. Returns a [[#NcaID]].
|-
| 4 || ListContentInfo || Takes a type-6 buffer to write [[CNMT#Content_records|Content Record]] entries to, a [[#ContentMetaKey|Content Meta Key]], and a u32 index into the Content Record entries to start copying from. Returns a u32 entries_read.
|-
| 5 || List || Takes a type-6 buffer to write [[#ContentMetaKey|Content Meta Key]]s to, a u32 [[#ContentMetaType|Content Meta Type]], a u64 TID, a u64 TID_LOW, and u64 TID_HIGH. Writes into the buffer all Content Meta Keys with low <= record->title_id <= high, and record->type == type. Returns u32 numEntriesTotal, numEntriesWritten. 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.
|-
| 6 || GetLatestContentMetaKey || Takes a u64 title id, and returns the [[#ContentMetaKey|Content Meta Key]] with the highest version field for that title id.
|-
| 7 || [[#ListApplication]] ||
|-
| 8 || Has || Takes a [[#ContentMetaKey|Content Meta Key]] and returns whether that record is present in the database.
|-
| 9 || HasAll || Takes a type-5 buffer containing [[#ContentMetaKey|Content Meta Key]] (code assumes there are size/sizeof(meta_record) records in the buffer), and returns whether all of those records are present in the database.
|-
| 10 || GetSize || Takes a [[#ContentMetaKey|Content Meta Key]], and returns the size of the associated [[CNMT#Content_records|Content Records]].
|-
| 11 || GetRequiredSystemVersion || Takes a [[#ContentMetaKey|Content Meta Key]], and returns u32 from ContentRecords + 16 (only if the content meta key has type Application or Patch).
|-
| 12 || GetPatchId || Takes a [[#ContentMetaKey|Content Meta Key]], and returns the update title id for that record.
|-
| 13 || DisableForcibly || Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.
|-
| 14 || [[#LookupOrphanContent]] || Takes a type-6 byte buffer, and a type-5 buffer of [[#NcaID]]s.
|-
| 15 || Commit || Flushes the in-memory database to savedata.
|-
| 16 || HasContent || Takes a [[#ContentMetaKey|Content Meta Key]] and an [[#NcaID]]. Returns whether the content records for that content meta key contain the NcaID.
|-
| 17 || ListContentMetaInfo || Takes a type-6 [[#ContentMetaKey|Content Meta Key]] output buffer, a u32 offset into that buffer, and an input [[#ContentMetaKey|Content Meta Key]].
|-
| 18 || GetAttributes || Takes a [[#ContentMetaKey|Content Meta Key]], and returns u8 from ContentRecords + 6.
|-
| 19 || [2.0.0+] GetRequiredApplicationVersion || Does the same thing as GetEntryUnknownRecordSize, but for AddOnContents.
|-
| 20 || [5.0.0+] GetContentIdByTypeAndIdOffset ||
|}

==== ListApplication ====
Each 24-byte entry (officially "ApplicationContentMetaKey") is as follows:
[[CNMT#Meta_records|meta_record]] meta_record;
u64 base_title_id;

This function takes in a type 6 buffer to write entries to, and a u8 "filter" [[#Title_Types|type]]. 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 u32 num_entries_total, and a u32 num_entries_written.

==== ReadEntryMetaRecords ====
Takes a type-6 [[#ContentMetaKey|Content Meta Key]] output buffer, a u32 offset into that buffer, and an input [[#ContentMetaKey|Content Meta Key]] entry. Returns a u32 for total_read_entries.

Reads the content meta keys stored in the entry's content records into the output buffer.

This is used, for example, with System Update title 0100000000000816, which contains content meta keys for all other systitles in its Content Records.

==== LookupOrphanContent ====
Takes a type-6 byte buffer, and a type-5 buffer containing [[#NcaID]]s.

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 [[#NcaID]] in the input buffer, it checks if that NcaID 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, NcaID in NcaIDs:
if is_present_in_database(NcaID):
out_buf[i] = 0

=== NcaID ===
This is a 0x10-byte entry. This is originally from the hex portion of "<hex>.nca" directory-names from this storage FS(like [[SD_Filesystem|SD]]). This is also referred to as "ContentId" in the official SDK.

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

== ContentInstallType ==
This is "nn::ncm::ContentInstallType"

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| Full
|-
| 0x1
| FragmentOnly
|-
| 0x7
| Unknown (Invalid Content Install Type)
|}

== ContentMetaType ==
This is "nn::ncm::ContentMetaType"

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x00
| Unknown (Invalid Content Meta Type)
|-
| 0x01
| SystemProgram ([[Title_list#System_Modules|System Modules]] or [[Title_list#System_Applets|System Applets]])
|-
| 0x02
| SystemData ([[Title_list#System_Data_Archives|System Data Archives]])
|-
| 0x03
| SystemUpdate
|-
| 0x04
| BootImagePackage ([[Title_list|Firmware package A or C]])
|-
| 0x05
| BootImagePackageSafe ([[Title_list|Firmware package B or D]])
|-
| 0x80
| Application
|-
| 0x81
| Patch
|-
| 0x82
| AddOnContent
|-
| 0x83
| Delta
|}

== ContentMetaKey ==
This is "nn::ncm::ContentMetaKey"

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Title id
|-
| 0x8
| 0x4
| Version
|-
| 0xC
| 0x1
| [[#ContentMetaType|Content Meta Type]]
|-
| 0xD
| 0x1
| [[#ContentInstallType|Content Install Type]]
|-
| 0xE
| 0x2
| Padding
|}

== ncm:v ==
This service doesn't normally exist on retail.

[[Category:Services]]

NCM services

2019-09-12T12:47:11Z

Adubbz:

NCM contains services for internal file path and content management.

= Location Resolver services =
== lr ==
This is "nn::lr::ILocationResolverManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || OpenLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 1 || OpenRegisteredLocationResolver || None ||
|-
| 2 || RefreshLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 3 || [2.0.0+] OpenAddOnContentLocationResolver || None ||
|}

The only sysmodules which use this service are [[Filesystem_services|FS]], [[Loader_services|Loader]], and [[NS_Services|NS]]. [[boot2]] has access but doesn't use it.

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 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]] || Unofficial name
|-
| 17 || [7.0.0+] [[#RedirectProgramPathForDebug]] || Unofficial name
|-
| 18 || [7.0.0+] [[#RedirectApplicationProgramPathForDebug]] || Unofficial name
|-
| 19 || [7.0.0+] [[#EraseProgramRedirectionForDebug]] || Unofficial name
|}

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

The Get* commands load the [[Filesystem_services|ContentPath]] from linked-lists' [[#Location_List_Entry|entries]] in memory using the input TitleID. When the command fails to find an entry for the specified TitleID, 0x408 is returned for GetProgramNcaPath 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 u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

==== RedirectProgramPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 0.

==== ResolveApplicationControlPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== ResolveApplicationHtmlDocumentPath====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

==== ResolveDataPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== RedirectApplicationControlPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

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

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== RedirectApplicationHtmlDocumentPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

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

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ResolveApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

==== RedirectApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

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

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== Refresh ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 0.

==== RedirectApplicationProgramPath ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

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

==== ClearApplicationRedirection ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 1.

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

==== EraseProgramRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationControlRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationHtmlDocumentRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationLegalInformationRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== ResolveProgramPathForDebug ====
Same as [[#ResolveProgramPath|ResolveProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectProgramPathForDebug ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectApplicationProgramPathForDebug ====
Same as [[#RedirectApplicationProgramPath |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_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== EraseProgramRedirectionForDebug ====
Same as [[#EraseProgramRedirection |EraseProgramRedirection ]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

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

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 title ID at a time.

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveProgramPath || u64 TitleID + C descriptor || Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
|-
| 1 || RegisterProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. || Sets the Type 0 fallback TID and path to the provided arguments.
|-
| 2 || UnregisterProgramPath || u64 TitleID || If the Type 0 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 3 || RedirectProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. ||
|-
| 4 || [2.0.0+] ResolveHtmlDocumentPath || u64 TitleID + C descriptor ||
|-
| 5 || [2.0.0+] RegisterHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. || Sets the Type 1 fallback TID and path to the provided arguments.
|-
| 6 || [2.0.0+] UnregisterHtmlDocumentPath || u64 TitleID || If the Type 1 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 7 || [2.0.0+] RedirectHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. ||
|-
| 8 || [7.0.0+] Refresh || No input/output. ||
|-
| 9 || [9.0.0+] || ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveAddOnContentPath || u64 TitleID + C descriptor ||
|-
| 1 || RegisterAddOnContentStorage || [[Filesystem_services#StorageId|StorageID]] + u64 TitleID [9.0.0+] Now takes an additional u64 TitleID for the owner application. ||
|-
| 2 || UnregisterAllAddOnContentPath || None || Clears all registered titles here.
|-
| 3 || [9.0.0+] [[#RefreshApplicationAddOnContent]] || Type-5 buffer || Unofficial name
|-
| 4 || [9.0.0+] [[#UnregisterApplicationAddOnContent]] || u64 TitleID || Unofficial name
|}

==== RefreshApplicationAddOnContent ====
Takes an type-5 buffer containing application title ids. Unregisters entries with application ids absent from the input buffer.

==== UnregisterApplicationAddOnContent====
Takes an u64 '''TitleID''' for the application to unregister add on content entries for.

=== Location List Entry ===
Total size is 0x320 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8|| Pointer to previous entry
|-
| 0x8 || 0x8|| Pointer to next entry
|-
| 0x10 || 0x8|| TitleID
|-
| 0x18 || 0x300 || [[Filesystem_services|ContentPath]]
|-
| 0x318 || 0x4 || Flag
|-
| 0x31C || 0x4 || Padding
|}

= Content Manager services =
== ncm ==
This is "nn::ncm::IContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || CreateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 1 || CreateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 2 || VerifyContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 3 || VerifyContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 4 || OpenContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 5 || OpenContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 6 || [1.0.0] CloseContentStorageForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentStorage->CloseAndFlushStorage().
|-
| 7 || [1.0.0] CloseContentMetaDatabaseForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentMetaDatabase->CloseMetaDatabase().
|-
| 8 || CleanupContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and deletes the associated savedata.
|-
| 9 || [2.0.0+] ActivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentStorage for the StorageID to be gotten with GetIContentStorage. Note: Name is not official.
|-
| 10 || [2.0.0+] InactivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentStorage. Note: Name is not official.
|-
| 11 || [2.0.0+] ActivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentMetaDatabase for the StorageID to be gotten with GetIContentMetaDatabase. Note: Name is not official.
|-
| 12 || [2.0.0+] InactivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentMetaDatabase. Note: Name is not official.
|-
| 13 || [9.0.0+] InvalidateRightsIdCache ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GeneratePlaceHolderId]] || Returns a random UUID for the Content Storage.
|-
| 1 || CreatePlaceHolder || Takes two [[#NcaID]]s, and a u64 filesize.
|-
| 2 || DeletePlaceHolder || Takes a [[#NcaID]].
|-
| 3 || HasPlaceHolder || Takes a [[#NcaID]].
|-
| 4 || WritePlaceHolder || Takes a [[#NcaID]], a u64-offset, and type 5 buffer. Writes the buffer to the file for the NcaID's placeholder path at the specified offset.
|-
| 5 || Register || Takes two [[#NcaID]]s, moves the Placeholder NCA content to the registered NCA path.
|-
| 6 || Delete || Takes a [[#NcaID]].
|-
| 7 || Has || Takes a [[#NcaID]].
|-
| 8 || GetPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 9 || GetPlaceHolderPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 10 || CleanupAllPlaceHolder || Deletes and re-creates the Placeholder directory.
|-
| 11 || ListPlaceHolder || This is like [[#GetNumberOfRegisteredEntries]], but for the Placeholder directory.
|-
| 12 || [[#GetContentCount]] ||
|-
| 13 || [[#ListContentId]] ||
|-
| 14 || [[#GetSizeFromContentId]] ||
|-
| 15 || DisableForcibly || Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.
|-
| 16 || [2.0.0+] RevertToPlaceHolder || Takes three 0x10-sized [[#NcaID]]s. Creates the registered directory NCA path, and renames the placeholder path to the registered NCA path.
|-
| 17 || [2.0.0+] SetPlaceHolderSize || Takes a [[#NcaID]], and a u64 size
|-
| 18 || [2.0.0+] [[#ReadContentIdFile]] ||
|-
| 19 || [2.0.0+] [[#GetRightsIdFromPlaceHolderId]] ||
|-
| 20 || [2.0.0+] [[#GetRightsIdFromContentId]] ||
|-
| 21 || [2.0.0+] WriteContentForDebug || Takes a [[#NcaID]], a u64 offset, and a type 5 buffer. On debug units, writes the buffer to the NCA's registered path. On retail units, this just aborts.
|-
| 22 || [2.0.0+] GetFreeSpaceSize || Gets free space for the storage.
|-
| 23 || [2.0.0+] GetTotalSpaceSize || Gets total space for the storage.
|-
| 24 || [3.0.0+] FlushPlaceHolder || Flushes resources for the storage without closing it.
|-
| 25 || [4.0.0+] GetSizeFromPlaceHolderId ||
|-
| 26 || [4.0.0+] RepairInvalidFileAttribute ||
|-
| 27 || [8.0.0+] GetRightsIdFromPlaceHolderIdWithCache ||
|}

==== GeneratePlaceHolderId ====
Generates a random [[#NcaID]] for use as a placeholder.

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

==== GetContentCount ====
Writes the total number of entries which can be read by GetEntries, to cmdreply <SFCO_offset>+0x10.

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

Each entry is a [[#NcaID]].

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 [[#NcaID]] as input.

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

==== ReadContentIdFile ====
Takes an output buffer, a [[#NcaID]] as input, and a u64 file offset.

Reads plaintext NCA file contents from the Registered path for the NcaID.

==== GetRightsIdFromPlaceHolderId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s placeholder path.

==== GetRightsIdFromContentId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s registered path

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Set || Takes a [[#ContentMetaKey|Content Meta Key]], a type-5 [[CNMT#Content_records|Content Records]] buffer and a u64 size.
|-
| 1 || Get || Takes a [[#ContentMetaKey|Content Meta Key]], a type-6 buffer to write [[CNMT#Content_records|Content Records]] 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.
|-
| 2 || Remove || Takes a [[#ContentMetaKey|Content Meta Key]], and removes the associated record.
|-
| 3 || GetContentIdByType || Takes a [[#ContentMetaKey|Content Meta Key]] and a u8 [[#ContentMetaType|Content Meta Type]]. Returns a [[#NcaID]].
|-
| 4 || ListContentInfo || Takes a type-6 buffer to write [[CNMT#Content_records|Content Record]] entries to, a [[#ContentMetaKey|Content Meta Key]], and a u32 index into the Content Record entries to start copying from. Returns a u32 entries_read.
|-
| 5 || List || Takes a type-6 buffer to write [[#ContentMetaKey|Content Meta Key]]s to, a u32 [[#ContentMetaType|Content Meta Type]], a u64 TID, a u64 TID_LOW, and u64 TID_HIGH. Writes into the buffer all Content Meta Keys with low <= record->title_id <= high, and record->type == type. Returns u32 numEntriesTotal, numEntriesWritten. 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.
|-
| 6 || GetLatestContentMetaKey || Takes a u64 title id, and returns the [[#ContentMetaKey|Content Meta Key]] with the highest version field for that title id.
|-
| 7 || [[#ListApplication]] ||
|-
| 8 || Has || Takes a [[#ContentMetaKey|Content Meta Key]] and returns whether that record is present in the database.
|-
| 9 || HasAll || Takes a type-5 buffer containing [[#ContentMetaKey|Content Meta Key]] (code assumes there are size/sizeof(meta_record) records in the buffer), and returns whether all of those records are present in the database.
|-
| 10 || GetSize || Takes a [[#ContentMetaKey|Content Meta Key]], and returns the size of the associated [[CNMT#Content_records|Content Records]].
|-
| 11 || GetRequiredSystemVersion || Takes a [[#ContentMetaKey|Content Meta Key]], and returns u32 from ContentRecords + 16 (only if the content meta key has type Application or Patch).
|-
| 12 || GetPatchId || Takes a [[#ContentMetaKey|Content Meta Key]], and returns the update title id for that record.
|-
| 13 || DisableForcibly || Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.
|-
| 14 || [[#LookupOrphanContent]] || Takes a type-6 byte buffer, and a type-5 buffer of [[#NcaID]]s.
|-
| 15 || Commit || Flushes the in-memory database to savedata.
|-
| 16 || HasContent || Takes a [[#ContentMetaKey|Content Meta Key]] and an [[#NcaID]]. Returns whether the content records for that content meta key contain the NcaID.
|-
| 17 || ListContentMetaInfo || Takes a type-6 [[#ContentMetaKey|Content Meta Key]] output buffer, a u32 offset into that buffer, and an input [[#ContentMetaKey|Content Meta Key]].
|-
| 18 || GetAttributes || Takes a [[#ContentMetaKey|Content Meta Key]], and returns u8 from ContentRecords + 6.
|-
| 19 || [2.0.0+] GetRequiredApplicationVersion || Does the same thing as GetEntryUnknownRecordSize, but for AddOnContents.
|-
| 20 || [5.0.0+] GetContentIdByTypeAndIdOffset ||
|}

==== ListApplication ====
Each 24-byte entry (officially "ApplicationContentMetaKey") is as follows:
[[CNMT#Meta_records|meta_record]] meta_record;
u64 base_title_id;

This function takes in a type 6 buffer to write entries to, and a u8 "filter" [[#Title_Types|type]]. 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 u32 num_entries_total, and a u32 num_entries_written.

==== ReadEntryMetaRecords ====
Takes a type-6 [[#ContentMetaKey|Content Meta Key]] output buffer, a u32 offset into that buffer, and an input [[#ContentMetaKey|Content Meta Key]] entry. Returns a u32 for total_read_entries.

Reads the content meta keys stored in the entry's content records into the output buffer.

This is used, for example, with System Update title 0100000000000816, which contains content meta keys for all other systitles in its Content Records.

==== LookupOrphanContent ====
Takes a type-6 byte buffer, and a type-5 buffer containing [[#NcaID]]s.

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 [[#NcaID]] in the input buffer, it checks if that NcaID 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, NcaID in NcaIDs:
if is_present_in_database(NcaID):
out_buf[i] = 0

=== NcaID ===
This is a 0x10-byte entry. This is originally from the hex portion of "<hex>.nca" directory-names from this storage FS(like [[SD_Filesystem|SD]]). This is also referred to as "ContentId" in the official SDK.

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

== ContentInstallType ==
This is "nn::ncm::ContentInstallType"

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| Full
|-
| 0x1
| FragmentOnly
|-
| 0x7
| Unknown (Invalid Content Install Type)
|}

== ContentMetaType ==
This is "nn::ncm::ContentMetaType"

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x00
| Unknown (Invalid Content Meta Type)
|-
| 0x01
| SystemProgram ([[Title_list#System_Modules|System Modules]] or [[Title_list#System_Applets|System Applets]])
|-
| 0x02
| SystemData ([[Title_list#System_Data_Archives|System Data Archives]])
|-
| 0x03
| SystemUpdate
|-
| 0x04
| BootImagePackage ([[Title_list|Firmware package A or C]])
|-
| 0x05
| BootImagePackageSafe ([[Title_list|Firmware package B or D]])
|-
| 0x80
| Application
|-
| 0x81
| Patch
|-
| 0x82
| AddOnContent
|-
| 0x83
| Delta
|}

== ContentMetaKey ==
This is "nn::ncm::ContentMetaKey"

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Title id
|-
| 0x8
| 0x4
| Version
|-
| 0xC
| 0x1
| [[#ContentMetaType|Content Meta Type]]
|-
| 0xD
| 0x1
| [[#ContentInstallType|Content Install Type]]
|-
| 0xE
| 0x2
| Padding
|}

== ncm:v ==
This service doesn't normally exist on retail.

[[Category:Services]]

NCM services

2019-09-12T12:46:06Z

Adubbz: IAddOnContentLocationResolver 9.0.0

NCM contains services for internal file path and content management.

= Location Resolver services =
== lr ==
This is "nn::lr::ILocationResolverManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || OpenLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 1 || OpenRegisteredLocationResolver || None ||
|-
| 2 || RefreshLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 3 || [2.0.0+] OpenAddOnContentLocationResolver || None ||
|}

The only sysmodules which use this service are [[Filesystem_services|FS]], [[Loader_services|Loader]], and [[NS_Services|NS]]. [[boot2]] has access but doesn't use it.

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 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]] || Unofficial name
|-
| 17 || [7.0.0+] [[#RedirectProgramPathForDebug]] || Unofficial name
|-
| 18 || [7.0.0+] [[#RedirectApplicationProgramPathForDebug]] || Unofficial name
|-
| 19 || [7.0.0+] [[#EraseProgramRedirectionForDebug]] || Unofficial name
|}

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

The Get* commands load the [[Filesystem_services|ContentPath]] from linked-lists' [[#Location_List_Entry|entries]] in memory using the input TitleID. When the command fails to find an entry for the specified TitleID, 0x408 is returned for GetProgramNcaPath 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 u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

==== RedirectProgramPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 0.

==== ResolveApplicationControlPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== ResolveApplicationHtmlDocumentPath====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

==== ResolveDataPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== RedirectApplicationControlPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

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

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== RedirectApplicationHtmlDocumentPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

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

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ResolveApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

==== RedirectApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

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

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== Refresh ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 0.

==== RedirectApplicationProgramPath ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

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

==== ClearApplicationRedirection ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 1.

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

==== EraseProgramRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationControlRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationHtmlDocumentRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationLegalInformationRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== ResolveProgramPathForDebug ====
Same as [[#ResolveProgramPath|ResolveProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectProgramPathForDebug ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectApplicationProgramPathForDebug ====
Same as [[#RedirectApplicationProgramPath |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_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== EraseProgramRedirectionForDebug ====
Same as [[#EraseProgramRedirection |EraseProgramRedirection ]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

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

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 title ID at a time.

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveProgramPath || u64 TitleID + C descriptor || Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
|-
| 1 || RegisterProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. || Sets the Type 0 fallback TID and path to the provided arguments.
|-
| 2 || UnregisterProgramPath || u64 TitleID || If the Type 0 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 3 || RedirectProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. ||
|-
| 4 || [2.0.0+] ResolveHtmlDocumentPath || u64 TitleID + C descriptor ||
|-
| 5 || [2.0.0+] RegisterHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. || Sets the Type 1 fallback TID and path to the provided arguments.
|-
| 6 || [2.0.0+] UnregisterHtmlDocumentPath || u64 TitleID || If the Type 1 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 7 || [2.0.0+] RedirectHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] [9.0.0+] Now takes an additional 8-bytes of input. ||
|-
| 8 || [7.0.0+] Refresh || No input/output. ||
|-
| 9 || [9.0.0+] || ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveAddOnContentPath || u64 TitleID + C descriptor ||
|-
| 1 || RegisterAddOnContentStorage || [[Filesystem_services#StorageId|StorageID]] + u64 TitleID [9.0.0+] Now takes an additional u64 TitleID for the owner application. ||
|-
| 2 || UnregisterAllAddOnContentPath || None || Clears all registered titles here.
|-
| 3 || [9.0.0+] [[#RefreshApplicationAddOnContent]] || Type-5 buffer || Unofficial name
|-
| 4 || [9.0.0+] [[#UnregisterApplicationAddOnContent]] || u64 TitleID || Unofficial name
|}

==== RefreshApplicationAddOnContent ====
Takes an type-5 buffer containing application title ids. Unregisters entries with application ids absent from the input buffer.

==== UnregisterApplicationAddOnContent====
Takes an u64 '''TitleID''' for the application to unregister add on content entries for.

=== Location List Entry ===
Total size is 0x320 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8|| Pointer to previous entry
|-
| 0x8 || 0x8|| Pointer to next entry
|-
| 0x10 || 0x8|| TitleID
|-
| 0x18 || 0x300 || [[Filesystem_services|ContentPath]]
|-
| 0x318 || 0x4 || Flag
|-
| 0x31C || 0x4 || Padding
|}

= Content Manager services =
== ncm ==
This is "nn::ncm::IContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || CreateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 1 || CreateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 2 || VerifyContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 3 || VerifyContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 4 || OpenContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 5 || OpenContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 6 || [1.0.0] CloseContentStorageForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentStorage->CloseAndFlushStorage().
|-
| 7 || [1.0.0] CloseContentMetaDatabaseForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentMetaDatabase->CloseMetaDatabase().
|-
| 8 || CleanupContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and deletes the associated savedata.
|-
| 9 || [2.0.0+] ActivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentStorage for the StorageID to be gotten with GetIContentStorage. Note: Name is not official.
|-
| 10 || [2.0.0+] InactivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentStorage. Note: Name is not official.
|-
| 11 || [2.0.0+] ActivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentMetaDatabase for the StorageID to be gotten with GetIContentMetaDatabase. Note: Name is not official.
|-
| 12 || [2.0.0+] InactivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentMetaDatabase. Note: Name is not official.
|-
| 13 || [9.0.0+] InvalidateRightsIdCache ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GeneratePlaceHolderId]] || Returns a random UUID for the Content Storage.
|-
| 1 || CreatePlaceHolder || Takes two [[#NcaID]]s, and a u64 filesize.
|-
| 2 || DeletePlaceHolder || Takes a [[#NcaID]].
|-
| 3 || HasPlaceHolder || Takes a [[#NcaID]].
|-
| 4 || WritePlaceHolder || Takes a [[#NcaID]], a u64-offset, and type 5 buffer. Writes the buffer to the file for the NcaID's placeholder path at the specified offset.
|-
| 5 || Register || Takes two [[#NcaID]]s, moves the Placeholder NCA content to the registered NCA path.
|-
| 6 || Delete || Takes a [[#NcaID]].
|-
| 7 || Has || Takes a [[#NcaID]].
|-
| 8 || GetPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 9 || GetPlaceHolderPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 10 || CleanupAllPlaceHolder || Deletes and re-creates the Placeholder directory.
|-
| 11 || ListPlaceHolder || This is like [[#GetNumberOfRegisteredEntries]], but for the Placeholder directory.
|-
| 12 || [[#GetContentCount]] ||
|-
| 13 || [[#ListContentId]] ||
|-
| 14 || [[#GetSizeFromContentId]] ||
|-
| 15 || DisableForcibly || Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.
|-
| 16 || [2.0.0+] RevertToPlaceHolder || Takes three 0x10-sized [[#NcaID]]s. Creates the registered directory NCA path, and renames the placeholder path to the registered NCA path.
|-
| 17 || [2.0.0+] SetPlaceHolderSize || Takes a [[#NcaID]], and a u64 size
|-
| 18 || [2.0.0+] [[#ReadContentIdFile]] ||
|-
| 19 || [2.0.0+] [[#GetRightsIdFromPlaceHolderId]] ||
|-
| 20 || [2.0.0+] [[#GetRightsIdFromContentId]] ||
|-
| 21 || [2.0.0+] WriteContentForDebug || Takes a [[#NcaID]], a u64 offset, and a type 5 buffer. On debug units, writes the buffer to the NCA's registered path. On retail units, this just aborts.
|-
| 22 || [2.0.0+] GetFreeSpaceSize || Gets free space for the storage.
|-
| 23 || [2.0.0+] GetTotalSpaceSize || Gets total space for the storage.
|-
| 24 || [3.0.0+] FlushPlaceHolder || Flushes resources for the storage without closing it.
|-
| 25 || [4.0.0+] GetSizeFromPlaceHolderId ||
|-
| 26 || [4.0.0+] RepairInvalidFileAttribute ||
|-
| 27 || [8.0.0+] GetRightsIdFromPlaceHolderIdWithCache ||
|}

==== GeneratePlaceHolderId ====
Generates a random [[#NcaID]] for use as a placeholder.

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

==== GetContentCount ====
Writes the total number of entries which can be read by GetEntries, to cmdreply <SFCO_offset>+0x10.

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

Each entry is a [[#NcaID]].

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 [[#NcaID]] as input.

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

==== ReadContentIdFile ====
Takes an output buffer, a [[#NcaID]] as input, and a u64 file offset.

Reads plaintext NCA file contents from the Registered path for the NcaID.

==== GetRightsIdFromPlaceHolderId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s placeholder path.

==== GetRightsIdFromContentId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s registered path

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Set || Takes a [[#ContentMetaKey|Content Meta Key]], a type-5 [[CNMT#Content_records|Content Records]] buffer and a u64 size.
|-
| 1 || Get || Takes a [[#ContentMetaKey|Content Meta Key]], a type-6 buffer to write [[CNMT#Content_records|Content Records]] 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.
|-
| 2 || Remove || Takes a [[#ContentMetaKey|Content Meta Key]], and removes the associated record.
|-
| 3 || GetContentIdByType || Takes a [[#ContentMetaKey|Content Meta Key]] and a u8 [[#ContentMetaType|Content Meta Type]]. Returns a [[#NcaID]].
|-
| 4 || ListContentInfo || Takes a type-6 buffer to write [[CNMT#Content_records|Content Record]] entries to, a [[#ContentMetaKey|Content Meta Key]], and a u32 index into the Content Record entries to start copying from. Returns a u32 entries_read.
|-
| 5 || List || Takes a type-6 buffer to write [[#ContentMetaKey|Content Meta Key]]s to, a u32 [[#ContentMetaType|Content Meta Type]], a u64 TID, a u64 TID_LOW, and u64 TID_HIGH. Writes into the buffer all Content Meta Keys with low <= record->title_id <= high, and record->type == type. Returns u32 numEntriesTotal, numEntriesWritten. 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.
|-
| 6 || GetLatestContentMetaKey || Takes a u64 title id, and returns the [[#ContentMetaKey|Content Meta Key]] with the highest version field for that title id.
|-
| 7 || [[#ListApplication]] ||
|-
| 8 || Has || Takes a [[#ContentMetaKey|Content Meta Key]] and returns whether that record is present in the database.
|-
| 9 || HasAll || Takes a type-5 buffer containing [[#ContentMetaKey|Content Meta Key]] (code assumes there are size/sizeof(meta_record) records in the buffer), and returns whether all of those records are present in the database.
|-
| 10 || GetSize || Takes a [[#ContentMetaKey|Content Meta Key]], and returns the size of the associated [[CNMT#Content_records|Content Records]].
|-
| 11 || GetRequiredSystemVersion || Takes a [[#ContentMetaKey|Content Meta Key]], and returns u32 from ContentRecords + 16 (only if the content meta key has type Application or Patch).
|-
| 12 || GetPatchId || Takes a [[#ContentMetaKey|Content Meta Key]], and returns the update title id for that record.
|-
| 13 || DisableForcibly || Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.
|-
| 14 || [[#LookupOrphanContent]] || Takes a type-6 byte buffer, and a type-5 buffer of [[#NcaID]]s.
|-
| 15 || Commit || Flushes the in-memory database to savedata.
|-
| 16 || HasContent || Takes a [[#ContentMetaKey|Content Meta Key]] and an [[#NcaID]]. Returns whether the content records for that content meta key contain the NcaID.
|-
| 17 || ListContentMetaInfo || Takes a type-6 [[#ContentMetaKey|Content Meta Key]] output buffer, a u32 offset into that buffer, and an input [[#ContentMetaKey|Content Meta Key]].
|-
| 18 || GetAttributes || Takes a [[#ContentMetaKey|Content Meta Key]], and returns u8 from ContentRecords + 6.
|-
| 19 || [2.0.0+] GetRequiredApplicationVersion || Does the same thing as GetEntryUnknownRecordSize, but for AddOnContents.
|-
| 20 || [5.0.0+] GetContentIdByTypeAndIdOffset ||
|}

==== ListApplication ====
Each 24-byte entry (officially "ApplicationContentMetaKey") is as follows:
[[CNMT#Meta_records|meta_record]] meta_record;
u64 base_title_id;

This function takes in a type 6 buffer to write entries to, and a u8 "filter" [[#Title_Types|type]]. 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 u32 num_entries_total, and a u32 num_entries_written.

==== ReadEntryMetaRecords ====
Takes a type-6 [[#ContentMetaKey|Content Meta Key]] output buffer, a u32 offset into that buffer, and an input [[#ContentMetaKey|Content Meta Key]] entry. Returns a u32 for total_read_entries.

Reads the content meta keys stored in the entry's content records into the output buffer.

This is used, for example, with System Update title 0100000000000816, which contains content meta keys for all other systitles in its Content Records.

==== LookupOrphanContent ====
Takes a type-6 byte buffer, and a type-5 buffer containing [[#NcaID]]s.

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 [[#NcaID]] in the input buffer, it checks if that NcaID 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, NcaID in NcaIDs:
if is_present_in_database(NcaID):
out_buf[i] = 0

=== NcaID ===
This is a 0x10-byte entry. This is originally from the hex portion of "<hex>.nca" directory-names from this storage FS(like [[SD_Filesystem|SD]]). This is also referred to as "ContentId" in the official SDK.

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

== ContentInstallType ==
This is "nn::ncm::ContentInstallType"

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| Full
|-
| 0x1
| FragmentOnly
|-
| 0x7
| Unknown (Invalid Content Install Type)
|}

== ContentMetaType ==
This is "nn::ncm::ContentMetaType"

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x00
| Unknown (Invalid Content Meta Type)
|-
| 0x01
| SystemProgram ([[Title_list#System_Modules|System Modules]] or [[Title_list#System_Applets|System Applets]])
|-
| 0x02
| SystemData ([[Title_list#System_Data_Archives|System Data Archives]])
|-
| 0x03
| SystemUpdate
|-
| 0x04
| BootImagePackage ([[Title_list|Firmware package A or C]])
|-
| 0x05
| BootImagePackageSafe ([[Title_list|Firmware package B or D]])
|-
| 0x80
| Application
|-
| 0x81
| Patch
|-
| 0x82
| AddOnContent
|-
| 0x83
| Delta
|}

== ContentMetaKey ==
This is "nn::ncm::ContentMetaKey"

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Title id
|-
| 0x8
| 0x4
| Version
|-
| 0xC
| 0x1
| [[#ContentMetaType|Content Meta Type]]
|-
| 0xD
| 0x1
| [[#ContentInstallType|Content Install Type]]
|-
| 0xE
| 0x2
| Padding
|}

== ncm:v ==
This service doesn't normally exist on retail.

[[Category:Services]]

NCM services

2019-09-09T23:50:20Z

Adubbz: 9.0.0

NCM contains services for internal file path and content management.

= Location Resolver services =
== lr ==
This is "nn::lr::ILocationResolverManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || OpenLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 1 || OpenRegisteredLocationResolver || None ||
|-
| 2 || RefreshLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 3 || [2.0.0+] OpenAddOnContentLocationResolver || None ||
|}

The only sysmodules which use this service are [[Filesystem_services|FS]], [[Loader_services|Loader]], and [[NS_Services|NS]]. [[boot2]] has access but doesn't use it.

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 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]] || Unofficial name
|-
| 17 || [7.0.0+] [[#RedirectProgramPathForDebug]] || Unofficial name
|-
| 18 || [7.0.0+] [[#RedirectApplicationProgramPathForDebug]] || Unofficial name
|-
| 19 || [7.0.0+] [[#EraseProgramRedirectionForDebug]] || Unofficial name
|}

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

The Get* commands load the [[Filesystem_services|ContentPath]] from linked-lists' [[#Location_List_Entry|entries]] in memory using the input TitleID. When the command fails to find an entry for the specified TitleID, 0x408 is returned for GetProgramNcaPath 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 u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

==== RedirectProgramPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 0.

==== ResolveApplicationControlPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== ResolveApplicationHtmlDocumentPath====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

==== ResolveDataPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== RedirectApplicationControlPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== RedirectApplicationHtmlDocumentPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ResolveApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

==== RedirectApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== Refresh ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 0.

==== RedirectApplicationProgramPath ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ClearApplicationRedirection ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 1.

==== EraseProgramRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationControlRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationHtmlDocumentRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationLegalInformationRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== ResolveProgramPathForDebug ====
Same as [[#ResolveProgramPath|ResolveProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectProgramPathForDebug ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectApplicationProgramPathForDebug ====
Same as [[#RedirectApplicationProgramPath |RedirectApplicationProgramPath ]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== EraseProgramRedirectionForDebug ====
Same as [[#EraseProgramRedirection |EraseProgramRedirection ]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

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

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 title ID at a time.

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveProgramPath || u64 TitleID + C descriptor || Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
|-
| 1 || RegisterProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 0 fallback TID and path to the provided arguments.
|-
| 2 || UnregisterProgramPath || u64 TitleID || If the Type 0 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 3 || RedirectProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|-
| 4 || [2.0.0+] ResolveHtmlDocumentPath || u64 TitleID + C descriptor ||
|-
| 5 || [2.0.0+] RegisterHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 1 fallback TID and path to the provided arguments.
|-
| 6 || [2.0.0+] UnregisterHtmlDocumentPath || u64 TitleID || If the Type 1 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 7 || [2.0.0+] RedirectHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|-
| 8 || [7.0.0+] Refresh || No input/output. ||
|-
| 9 || [9.0.0+] || ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveAddOnContentPath || u64 TitleID + C descriptor ||
|-
| 1 || RegisterAddOnContentStorage || [[Filesystem_services#StorageId|StorageID]] + u64 TitleID ||
|-
| 2 || UnregisterAllAddOnContentPath || None || Clears all registered titles here.
|-
| 3 || [9.0.0+] || ||
|-
| 4 || [9.0.0+] || ||
|}

=== Location List Entry ===
Total size is 0x320 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8|| Pointer to previous entry
|-
| 0x8 || 0x8|| Pointer to next entry
|-
| 0x10 || 0x8|| TitleID
|-
| 0x18 || 0x300 || [[Filesystem_services|ContentPath]]
|-
| 0x318 || 0x4 || Flag
|-
| 0x31C || 0x4 || Padding
|}

= Content Manager services =
== ncm ==
This is "nn::ncm::IContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || CreateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 1 || CreateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 2 || VerifyContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 3 || VerifyContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 4 || OpenContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 5 || OpenContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 6 || [1.0.0] CloseContentStorageForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentStorage->CloseAndFlushStorage().
|-
| 7 || [1.0.0] CloseContentMetaDatabaseForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentMetaDatabase->CloseMetaDatabase().
|-
| 8 || CleanupContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and deletes the associated savedata.
|-
| 9 || [2.0.0+] ActivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentStorage for the StorageID to be gotten with GetIContentStorage. Note: Name is not official.
|-
| 10 || [2.0.0+] InactivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentStorage. Note: Name is not official.
|-
| 11 || [2.0.0+] ActivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentMetaDatabase for the StorageID to be gotten with GetIContentMetaDatabase. Note: Name is not official.
|-
| 12 || [2.0.0+] InactivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentMetaDatabase. Note: Name is not official.
|-
| 13 || [9.0.0+] ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GeneratePlaceHolderId]] || Returns a random UUID for the Content Storage.
|-
| 1 || CreatePlaceHolder || Takes two [[#NcaID]]s, and a u64 filesize.
|-
| 2 || DeletePlaceHolder || Takes a [[#NcaID]].
|-
| 3 || HasPlaceHolder || Takes a [[#NcaID]].
|-
| 4 || WritePlaceHolder || Takes a [[#NcaID]], a u64-offset, and type 5 buffer. Writes the buffer to the file for the NcaID's placeholder path at the specified offset.
|-
| 5 || Register || Takes two [[#NcaID]]s, moves the Placeholder NCA content to the registered NCA path.
|-
| 6 || Delete || Takes a [[#NcaID]].
|-
| 7 || Has || Takes a [[#NcaID]].
|-
| 8 || GetPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 9 || GetPlaceHolderPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 10 || CleanupAllPlaceHolder || Deletes and re-creates the Placeholder directory.
|-
| 11 || ListPlaceHolder || This is like [[#GetNumberOfRegisteredEntries]], but for the Placeholder directory.
|-
| 12 || [[#GetContentCount]] ||
|-
| 13 || [[#ListContentId]] ||
|-
| 14 || [[#GetSizeFromContentId]] ||
|-
| 15 || DisableForcibly || Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.
|-
| 16 || [2.0.0+] RevertToPlaceHolder || Takes three 0x10-sized [[#NcaID]]s. Creates the registered directory NCA path, and renames the placeholder path to the registered NCA path.
|-
| 17 || [2.0.0+] SetPlaceHolderSize || Takes a [[#NcaID]], and a u64 size
|-
| 18 || [2.0.0+] [[#ReadContentIdFile]] ||
|-
| 19 || [2.0.0+] [[#GetRightsIdFromPlaceHolderId]] ||
|-
| 20 || [2.0.0+] [[#GetRightsIdFromContentId]] ||
|-
| 21 || [2.0.0+] WriteContentForDebug || Takes a [[#NcaID]], a u64 offset, and a type 5 buffer. On debug units, writes the buffer to the NCA's registered path. On retail units, this just aborts.
|-
| 22 || [2.0.0+] GetFreeSpaceSize || Gets free space for the storage.
|-
| 23 || [2.0.0+] GetTotalSpaceSize || Gets total space for the storage.
|-
| 24 || [3.0.0+] FlushPlaceHolder || Flushes resources for the storage without closing it.
|-
| 25 || [4.0.0+] GetSizeFromPlaceHolderId ||
|-
| 26 || [4.0.0+] RepairInvalidFileAttribute ||
|-
| 27 || [8.0.0+] GetRightsIdFromPlaceHolderIdWithCache ||
|}

==== GeneratePlaceHolderId ====
Generates a random [[#NcaID]] for use as a placeholder.

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

==== GetContentCount ====
Writes the total number of entries which can be read by GetEntries, to cmdreply <SFCO_offset>+0x10.

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

Each entry is a [[#NcaID]].

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 [[#NcaID]] as input.

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

==== ReadContentIdFile ====
Takes an output buffer, a [[#NcaID]] as input, and a u64 file offset.

Reads plaintext NCA file contents from the Registered path for the NcaID.

==== GetRightsIdFromPlaceHolderId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s placeholder path.

==== GetRightsIdFromContentId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s registered path

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Set || Takes a [[#ContentMetaKey|Content Meta Key]], a type-5 [[CNMT#Content_records|Content Records]] buffer and a u64 size.
|-
| 1 || Get || Takes a [[#ContentMetaKey|Content Meta Key]], a type-6 buffer to write [[CNMT#Content_records|Content Records]] 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.
|-
| 2 || Remove || Takes a [[#ContentMetaKey|Content Meta Key]], and removes the associated record.
|-
| 3 || GetContentIdByType || Takes a [[#ContentMetaKey|Content Meta Key]] and a u8 [[#ContentMetaType|Content Meta Type]]. Returns a [[#NcaID]].
|-
| 4 || ListContentInfo || Takes a type-6 buffer to write [[CNMT#Content_records|Content Record]] entries to, a [[#ContentMetaKey|Content Meta Key]], and a u32 index into the Content Record entries to start copying from. Returns a u32 entries_read.
|-
| 5 || List || Takes a type-6 buffer to write [[#ContentMetaKey|Content Meta Key]]s to, a u32 [[#ContentMetaType|Content Meta Type]], a u64 TID, a u64 TID_LOW, and u64 TID_HIGH. Writes into the buffer all Content Meta Keys with low <= record->title_id <= high, and record->type == type. Returns u32 numEntriesTotal, numEntriesWritten. 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.
|-
| 6 || GetLatestContentMetaKey || Takes a u64 title id, and returns the [[#ContentMetaKey|Content Meta Key]] with the highest version field for that title id.
|-
| 7 || [[#ListApplication]] ||
|-
| 8 || Has || Takes a [[#ContentMetaKey|Content Meta Key]] and returns whether that record is present in the database.
|-
| 9 || HasAll || Takes a type-5 buffer containing [[#ContentMetaKey|Content Meta Key]] (code assumes there are size/sizeof(meta_record) records in the buffer), and returns whether all of those records are present in the database.
|-
| 10 || GetSize || Takes a [[#ContentMetaKey|Content Meta Key]], and returns the size of the associated [[CNMT#Content_records|Content Records]].
|-
| 11 || GetRequiredSystemVersion || Takes a [[#ContentMetaKey|Content Meta Key]], and returns u32 from ContentRecords + 16 (only if the content meta key has type Application or Patch).
|-
| 12 || GetPatchId || Takes a [[#ContentMetaKey|Content Meta Key]], and returns the update title id for that record.
|-
| 13 || DisableForcibly || Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.
|-
| 14 || [[#LookupOrphanContent]] || Takes a type-6 byte buffer, and a type-5 buffer of [[#NcaID]]s.
|-
| 15 || Commit || Flushes the in-memory database to savedata.
|-
| 16 || HasContent || Takes a [[#ContentMetaKey|Content Meta Key]] and an [[#NcaID]]. Returns whether the content records for that content meta key contain the NcaID.
|-
| 17 || ListContentMetaInfo || Takes a type-6 [[#ContentMetaKey|Content Meta Key]] output buffer, a u32 offset into that buffer, and an input [[#ContentMetaKey|Content Meta Key]].
|-
| 18 || GetAttributes || Takes a [[#ContentMetaKey|Content Meta Key]], and returns u8 from ContentRecords + 6.
|-
| 19 || [2.0.0+] GetRequiredApplicationVersion || Does the same thing as GetEntryUnknownRecordSize, but for AddOnContents.
|-
| 20 || [5.0.0+] GetContentIdByTypeAndIdOffset ||
|}

==== ListApplication ====
Each 24-byte entry (officially "ApplicationContentMetaKey") is as follows:
[[CNMT#Meta_records|meta_record]] meta_record;
u64 base_title_id;

This function takes in a type 6 buffer to write entries to, and a u8 "filter" [[#Title_Types|type]]. 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 u32 num_entries_total, and a u32 num_entries_written.

==== ReadEntryMetaRecords ====
Takes a type-6 [[#ContentMetaKey|Content Meta Key]] output buffer, a u32 offset into that buffer, and an input [[#ContentMetaKey|Content Meta Key]] entry. Returns a u32 for total_read_entries.

Reads the content meta keys stored in the entry's content records into the output buffer.

This is used, for example, with System Update title 0100000000000816, which contains content meta keys for all other systitles in its Content Records.

==== LookupOrphanContent ====
Takes a type-6 byte buffer, and a type-5 buffer containing [[#NcaID]]s.

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 [[#NcaID]] in the input buffer, it checks if that NcaID 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, NcaID in NcaIDs:
if is_present_in_database(NcaID):
out_buf[i] = 0

=== NcaID ===
This is a 0x10-byte entry. This is originally from the hex portion of "<hex>.nca" directory-names from this storage FS(like [[SD_Filesystem|SD]]). This is also referred to as "ContentId" in the official SDK.

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

== ContentInstallType ==
This is "nn::ncm::ContentInstallType"

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| Full
|-
| 0x1
| FragmentOnly
|-
| 0x7
| Unknown (Invalid Content Install Type)
|}

== ContentMetaType ==
This is "nn::ncm::ContentMetaType"

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x00
| Unknown (Invalid Content Meta Type)
|-
| 0x01
| SystemProgram ([[Title_list#System_Modules|System Modules]] or [[Title_list#System_Applets|System Applets]])
|-
| 0x02
| SystemData ([[Title_list#System_Data_Archives|System Data Archives]])
|-
| 0x03
| SystemUpdate
|-
| 0x04
| BootImagePackage ([[Title_list|Firmware package A or C]])
|-
| 0x05
| BootImagePackageSafe ([[Title_list|Firmware package B or D]])
|-
| 0x80
| Application
|-
| 0x81
| Patch
|-
| 0x82
| AddOnContent
|-
| 0x83
| Delta
|}

== ContentMetaKey ==
This is "nn::ncm::ContentMetaKey"

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Title id
|-
| 0x8
| 0x4
| Version
|-
| 0xC
| 0x1
| [[#ContentMetaType|Content Meta Type]]
|-
| 0xD
| 0x1
| [[#ContentInstallType|Content Install Type]]
|-
| 0xE
| 0x2
| Padding
|}

== ncm:v ==
This service doesn't normally exist on retail.

[[Category:Services]]

NCM services

2019-08-31T08:05:26Z

Adubbz: Use official struct names

NCM contains services for internal file path and content management.

= Location Resolver services =
== lr ==
This is "nn::lr::ILocationResolverManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || OpenLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 1 || OpenRegisteredLocationResolver || None ||
|-
| 2 || RefreshLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 3 || [2.0.0+] OpenAddOnContentLocationResolver || None ||
|}

The only sysmodules which use this service are [[Filesystem_services|FS]], [[Loader_services|Loader]], and [[NS_Services|NS]]. [[boot2]] has access but doesn't use it.

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 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]] || Unofficial name
|-
| 17 || [7.0.0+] [[#RedirectProgramPathForDebug]] || Unofficial name
|-
| 18 || [7.0.0+] [[#RedirectApplicationProgramPathForDebug]] || Unofficial name
|-
| 19 || [7.0.0+] [[#EraseProgramRedirectionForDebug]] || Unofficial name
|}

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

The Get* commands load the [[Filesystem_services|ContentPath]] from linked-lists' [[#Location_List_Entry|entries]] in memory using the input TitleID. When the command fails to find an entry for the specified TitleID, 0x408 is returned for GetProgramNcaPath 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 u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

==== RedirectProgramPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 0.

==== ResolveApplicationControlPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== ResolveApplicationHtmlDocumentPath====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

==== ResolveDataPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== RedirectApplicationControlPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== RedirectApplicationHtmlDocumentPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ResolveApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

==== RedirectApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== Refresh ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 0.

==== RedirectApplicationProgramPath ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ClearApplicationRedirection ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 1.

==== EraseProgramRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationControlRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationHtmlDocumentRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationLegalInformationRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== ResolveProgramPathForDebug ====
Same as [[#ResolveProgramPath|ResolveProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectProgramPathForDebug ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectApplicationProgramPathForDebug ====
Same as [[#RedirectApplicationProgramPath |RedirectApplicationProgramPath ]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== EraseProgramRedirectionForDebug ====
Same as [[#EraseProgramRedirection |EraseProgramRedirection ]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

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

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 title ID at a time.

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveProgramPath || u64 TitleID + C descriptor || Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
|-
| 1 || RegisterProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 0 fallback TID and path to the provided arguments.
|-
| 2 || UnregisterProgramPath || u64 TitleID || If the Type 0 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 3 || RedirectProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|-
| 4 || [2.0.0+] ResolveHtmlDocumentPath || u64 TitleID + C descriptor ||
|-
| 5 || [2.0.0+] RegisterHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 1 fallback TID and path to the provided arguments.
|-
| 6 || [2.0.0+] UnregisterHtmlDocumentPath || u64 TitleID || If the Type 1 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 7 || [2.0.0+] RedirectHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|-
| 8 || [7.0.0+] Refresh || No input/output. ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveAddOnContentPath || u64 TitleID + C descriptor ||
|-
| 1 || RegisterAddOnContentStorage || [[Filesystem_services#StorageId|StorageID]] + u64 TitleID ||
|-
| 2 || UnregisterAllAddOnContentPath || None || Clears all registered titles here.
|}

=== Location List Entry ===
Total size is 0x320 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8|| Pointer to previous entry
|-
| 0x8 || 0x8|| Pointer to next entry
|-
| 0x10 || 0x8|| TitleID
|-
| 0x18 || 0x300 || [[Filesystem_services|ContentPath]]
|-
| 0x318 || 0x4 || Flag
|-
| 0x31C || 0x4 || Padding
|}

= Content Manager services =
== ncm ==
This is "nn::ncm::IContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || CreateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 1 || CreateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 2 || VerifyContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 3 || VerifyContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 4 || OpenContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 5 || OpenContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 6 || [1.0.0] CloseContentStorageForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentStorage->CloseAndFlushStorage().
|-
| 7 || [1.0.0] CloseContentMetaDatabaseForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentMetaDatabase->CloseMetaDatabase().
|-
| 8 || CleanupContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and deletes the associated savedata.
|-
| 9 || [2.0.0+] ActivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentStorage for the StorageID to be gotten with GetIContentStorage. Note: Name is not official.
|-
| 10 || [2.0.0+] InactivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentStorage. Note: Name is not official.
|-
| 11 || [2.0.0+] ActivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentMetaDatabase for the StorageID to be gotten with GetIContentMetaDatabase. Note: Name is not official.
|-
| 12 || [2.0.0+] InactivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentMetaDatabase. Note: Name is not official.
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GeneratePlaceHolderId]] || Returns a random UUID for the Content Storage.
|-
| 1 || CreatePlaceHolder || Takes two [[#NcaID]]s, and a u64 filesize.
|-
| 2 || DeletePlaceHolder || Takes a [[#NcaID]].
|-
| 3 || HasPlaceHolder || Takes a [[#NcaID]].
|-
| 4 || WritePlaceHolder || Takes a [[#NcaID]], a u64-offset, and type 5 buffer. Writes the buffer to the file for the NcaID's placeholder path at the specified offset.
|-
| 5 || Register || Takes two [[#NcaID]]s, moves the Placeholder NCA content to the registered NCA path.
|-
| 6 || Delete || Takes a [[#NcaID]].
|-
| 7 || Has || Takes a [[#NcaID]].
|-
| 8 || GetPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 9 || GetPlaceHolderPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 10 || CleanupAllPlaceHolder || Deletes and re-creates the Placeholder directory.
|-
| 11 || ListPlaceHolder || This is like [[#GetNumberOfRegisteredEntries]], but for the Placeholder directory.
|-
| 12 || [[#GetContentCount]] ||
|-
| 13 || [[#ListContentId]] ||
|-
| 14 || [[#GetSizeFromContentId]] ||
|-
| 15 || DisableForcibly || Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.
|-
| 16 || [2.0.0+] RevertToPlaceHolder || Takes three 0x10-sized [[#NcaID]]s. Creates the registered directory NCA path, and renames the placeholder path to the registered NCA path.
|-
| 17 || [2.0.0+] SetPlaceHolderSize || Takes a [[#NcaID]], and a u64 size
|-
| 18 || [2.0.0+] [[#ReadContentIdFile]] ||
|-
| 19 || [2.0.0+] [[#GetRightsIdFromPlaceHolderId]] ||
|-
| 20 || [2.0.0+] [[#GetRightsIdFromContentId]] ||
|-
| 21 || [2.0.0+] WriteContentForDebug || Takes a [[#NcaID]], a u64 offset, and a type 5 buffer. On debug units, writes the buffer to the NCA's registered path. On retail units, this just aborts.
|-
| 22 || [2.0.0+] GetFreeSpaceSize || Gets free space for the storage.
|-
| 23 || [2.0.0+] GetTotalSpaceSize || Gets total space for the storage.
|-
| 24 || [3.0.0+] FlushPlaceHolder || Flushes resources for the storage without closing it.
|-
| 25 || [4.0.0+] GetSizeFromPlaceHolderId ||
|-
| 26 || [4.0.0+] RepairInvalidFileAttribute ||
|-
| 27 || [8.0.0+] GetRightsIdFromPlaceHolderIdWithCache ||
|}

==== GeneratePlaceHolderId ====
Generates a random [[#NcaID]] for use as a placeholder.

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

==== GetContentCount ====
Writes the total number of entries which can be read by GetEntries, to cmdreply <SFCO_offset>+0x10.

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

Each entry is a [[#NcaID]].

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 [[#NcaID]] as input.

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

==== ReadContentIdFile ====
Takes an output buffer, a [[#NcaID]] as input, and a u64 file offset.

Reads plaintext NCA file contents from the Registered path for the NcaID.

==== GetRightsIdFromPlaceHolderId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s placeholder path.

==== GetRightsIdFromContentId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s registered path

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Set || Takes a [[#ContentMetaKey|Content Meta Key]], a type-5 [[CNMT#Content_records|Content Records]] buffer and a u64 size.
|-
| 1 || Get || Takes a [[#ContentMetaKey|Content Meta Key]], a type-6 buffer to write [[CNMT#Content_records|Content Records]] 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.
|-
| 2 || Remove || Takes a [[#ContentMetaKey|Content Meta Key]], and removes the associated record.
|-
| 3 || GetContentIdByType || Takes a [[#ContentMetaKey|Content Meta Key]] and a u8 [[#ContentMetaType|Content Meta Type]]. Returns a [[#NcaID]].
|-
| 4 || ListContentInfo || Takes a type-6 buffer to write [[CNMT#Content_records|Content Record]] entries to, a [[#ContentMetaKey|Content Meta Key]], and a u32 index into the Content Record entries to start copying from. Returns a u32 entries_read.
|-
| 5 || List || Takes a type-6 buffer to write [[#ContentMetaKey|Content Meta Key]]s to, a u32 [[#ContentMetaType|Content Meta Type]], a u64 TID, a u64 TID_LOW, and u64 TID_HIGH. Writes into the buffer all Content Meta Keys with low <= record->title_id <= high, and record->type == type. Returns u32 numEntriesTotal, numEntriesWritten. 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.
|-
| 6 || GetLatestContentMetaKey || Takes a u64 title id, and returns the [[#ContentMetaKey|Content Meta Key]] with the highest version field for that title id.
|-
| 7 || [[#ListApplication]] ||
|-
| 8 || Has || Takes a [[#ContentMetaKey|Content Meta Key]] and returns whether that record is present in the database.
|-
| 9 || HasAll || Takes a type-5 buffer containing [[#ContentMetaKey|Content Meta Key]] (code assumes there are size/sizeof(meta_record) records in the buffer), and returns whether all of those records are present in the database.
|-
| 10 || GetSize || Takes a [[#ContentMetaKey|Content Meta Key]], and returns the size of the associated [[CNMT#Content_records|Content Records]].
|-
| 11 || GetRequiredSystemVersion || Takes a [[#ContentMetaKey|Content Meta Key]], and returns u32 from ContentRecords + 16 (only if the content meta key has type Application or Patch).
|-
| 12 || GetPatchId || Takes a [[#ContentMetaKey|Content Meta Key]], and returns the update title id for that record.
|-
| 13 || DisableForcibly || Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.
|-
| 14 || [[#LookupOrphanContent]] || Takes a type-6 byte buffer, and a type-5 buffer of [[#NcaID]]s.
|-
| 15 || Commit || Flushes the in-memory database to savedata.
|-
| 16 || HasContent || Takes a [[#ContentMetaKey|Content Meta Key]] and an [[#NcaID]]. Returns whether the content records for that content meta key contain the NcaID.
|-
| 17 || ListContentMetaInfo || Takes a type-6 [[#ContentMetaKey|Content Meta Key]] output buffer, a u32 offset into that buffer, and an input [[#ContentMetaKey|Content Meta Key]].
|-
| 18 || GetAttributes || Takes a [[#ContentMetaKey|Content Meta Key]], and returns u8 from ContentRecords + 6.
|-
| 19 || [2.0.0+] GetRequiredApplicationVersion || Does the same thing as GetEntryUnknownRecordSize, but for AddOnContents.
|-
| 20 || [5.0.0+] GetContentIdByTypeAndIdOffset ||
|}

==== ListApplication ====
Each 24-byte entry (officially "ApplicationContentMetaKey") is as follows:
[[CNMT#Meta_records|meta_record]] meta_record;
u64 base_title_id;

This function takes in a type 6 buffer to write entries to, and a u8 "filter" [[#Title_Types|type]]. 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 u32 num_entries_total, and a u32 num_entries_written.

==== ReadEntryMetaRecords ====
Takes a type-6 [[#ContentMetaKey|Content Meta Key]] output buffer, a u32 offset into that buffer, and an input [[#ContentMetaKey|Content Meta Key]] entry. Returns a u32 for total_read_entries.

Reads the content meta keys stored in the entry's content records into the output buffer.

This is used, for example, with System Update title 0100000000000816, which contains content meta keys for all other systitles in its Content Records.

==== LookupOrphanContent ====
Takes a type-6 byte buffer, and a type-5 buffer containing [[#NcaID]]s.

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 [[#NcaID]] in the input buffer, it checks if that NcaID 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, NcaID in NcaIDs:
if is_present_in_database(NcaID):
out_buf[i] = 0

=== NcaID ===
This is a 0x10-byte entry. This is originally from the hex portion of "<hex>.nca" directory-names from this storage FS(like [[SD_Filesystem|SD]]). This is also referred to as "ContentId" in the official SDK.

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

== ContentInstallType ==
This is "nn::ncm::ContentInstallType"

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| Full
|-
| 0x1
| FragmentOnly
|-
| 0x7
| Unknown (Invalid Content Install Type)
|}

== ContentMetaType ==
This is "nn::ncm::ContentMetaType"

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x00
| Unknown (Invalid Content Meta Type)
|-
| 0x01
| SystemProgram ([[Title_list#System_Modules|System Modules]] or [[Title_list#System_Applets|System Applets]])
|-
| 0x02
| SystemData ([[Title_list#System_Data_Archives|System Data Archives]])
|-
| 0x03
| SystemUpdate
|-
| 0x04
| BootImagePackage ([[Title_list|Firmware package A or C]])
|-
| 0x05
| BootImagePackageSafe ([[Title_list|Firmware package B or D]])
|-
| 0x80
| Application
|-
| 0x81
| Patch
|-
| 0x82
| AddOnContent
|-
| 0x83
| Delta
|}

== ContentMetaKey ==
This is "nn::ncm::ContentMetaKey"

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Title id
|-
| 0x8
| 0x4
| Version
|-
| 0xC
| 0x1
| [[#ContentMetaType|Content Meta Type]]
|-
| 0xD
| 0x1
| [[#ContentInstallType|Content Install Type]]
|-
| 0xE
| 0x2
| Padding
|}

== ncm:v ==
This service doesn't normally exist on retail.

[[Category:Services]]

NCM services

2019-08-31T07:27:58Z

Adubbz: Namez

NCM contains services for internal file path and content management.

= Location Resolver services =
== lr ==
This is "nn::lr::ILocationResolverManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || OpenLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 1 || OpenRegisteredLocationResolver || None ||
|-
| 2 || RefreshLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 3 || [2.0.0+] OpenAddOnContentLocationResolver || None ||
|}

The only sysmodules which use this service are [[Filesystem_services|FS]], [[Loader_services|Loader]], and [[NS_Services|NS]]. [[boot2]] has access but doesn't use it.

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 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]] || Unofficial name
|-
| 17 || [7.0.0+] [[#RedirectProgramPathForDebug]] || Unofficial name
|-
| 18 || [7.0.0+] [[#RedirectApplicationProgramPathForDebug]] || Unofficial name
|-
| 19 || [7.0.0+] [[#EraseProgramRedirectionForDebug]] || Unofficial name
|}

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

The Get* commands load the [[Filesystem_services|ContentPath]] from linked-lists' [[#Location_List_Entry|entries]] in memory using the input TitleID. When the command fails to find an entry for the specified TitleID, 0x408 is returned for GetProgramNcaPath 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 u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

==== RedirectProgramPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 0.

==== ResolveApplicationControlPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== ResolveApplicationHtmlDocumentPath====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

==== ResolveDataPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== RedirectApplicationControlPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== RedirectApplicationHtmlDocumentPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ResolveApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

==== RedirectApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== Refresh ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 0.

==== RedirectApplicationProgramPath ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ClearApplicationRedirection ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 1.

==== EraseProgramRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationControlRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationHtmlDocumentRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== EraseApplicationLegalInformationRedirection ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== ResolveProgramPathForDebug ====
Same as [[#ResolveProgramPath|ResolveProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectProgramPathForDebug ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectApplicationProgramPathForDebug ====
Same as [[#RedirectApplicationProgramPath |RedirectApplicationProgramPath ]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== EraseProgramRedirectionForDebug ====
Same as [[#EraseProgramRedirection |EraseProgramRedirection ]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

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

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 title ID at a time.

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveProgramPath || u64 TitleID + C descriptor || Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
|-
| 1 || RegisterProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 0 fallback TID and path to the provided arguments.
|-
| 2 || UnregisterProgramPath || u64 TitleID || If the Type 0 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 3 || RedirectProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|-
| 4 || [2.0.0+] ResolveHtmlDocumentPath || u64 TitleID + C descriptor ||
|-
| 5 || [2.0.0+] RegisterHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 1 fallback TID and path to the provided arguments.
|-
| 6 || [2.0.0+] UnregisterHtmlDocumentPath || u64 TitleID || If the Type 1 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 7 || [2.0.0+] RedirectHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|-
| 8 || [7.0.0+] Refresh || No input/output. ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveAddOnContentPath || u64 TitleID + C descriptor ||
|-
| 1 || RegisterAddOnContentStorage || [[Filesystem_services#StorageId|StorageID]] + u64 TitleID ||
|-
| 2 || UnregisterAllAddOnContentPath || None || Clears all registered titles here.
|}

=== Location List Entry ===
Total size is 0x320 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8|| Pointer to previous entry
|-
| 0x8 || 0x8|| Pointer to next entry
|-
| 0x10 || 0x8|| TitleID
|-
| 0x18 || 0x300 || [[Filesystem_services|ContentPath]]
|-
| 0x318 || 0x4 || Flag
|-
| 0x31C || 0x4 || Padding
|}

= Content Manager services =
== ncm ==
This is "nn::ncm::IContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || CreateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 1 || CreateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 2 || VerifyContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 3 || VerifyContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 4 || OpenContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 5 || OpenContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 6 || [1.0.0] CloseContentStorageForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentStorage->CloseAndFlushStorage().
|-
| 7 || [1.0.0] CloseContentMetaDatabaseForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentMetaDatabase->CloseMetaDatabase().
|-
| 8 || CleanupContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and deletes the associated savedata.
|-
| 9 || [2.0.0+] ActivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentStorage for the StorageID to be gotten with GetIContentStorage. Note: Name is not official.
|-
| 10 || [2.0.0+] InactivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentStorage. Note: Name is not official.
|-
| 11 || [2.0.0+] ActivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentMetaDatabase for the StorageID to be gotten with GetIContentMetaDatabase. Note: Name is not official.
|-
| 12 || [2.0.0+] InactivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentMetaDatabase. Note: Name is not official.
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GeneratePlaceHolderId]] || Returns a random UUID for the Content Storage.
|-
| 1 || CreatePlaceHolder || Takes two [[#NcaID]]s, and a u64 filesize.
|-
| 2 || DeletePlaceHolder || Takes a [[#NcaID]].
|-
| 3 || HasPlaceHolder || Takes a [[#NcaID]].
|-
| 4 || WritePlaceHolder || Takes a [[#NcaID]], a u64-offset, and type 5 buffer. Writes the buffer to the file for the NcaID's placeholder path at the specified offset.
|-
| 5 || Register || Takes two [[#NcaID]]s, moves the Placeholder NCA content to the registered NCA path.
|-
| 6 || Delete || Takes a [[#NcaID]].
|-
| 7 || Has || Takes a [[#NcaID]].
|-
| 8 || GetPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 9 || GetPlaceHolderPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 10 || CleanupAllPlaceHolder || Deletes and re-creates the Placeholder directory.
|-
| 11 || ListPlaceHolder || This is like [[#GetNumberOfRegisteredEntries]], but for the Placeholder directory.
|-
| 12 || [[#GetContentCount]] ||
|-
| 13 || [[#ListContentId]] ||
|-
| 14 || [[#GetSizeFromContentId]] ||
|-
| 15 || DisableForcibly || Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.
|-
| 16 || [2.0.0+] RevertToPlaceHolder || Takes three 0x10-sized [[#NcaID]]s. Creates the registered directory NCA path, and renames the placeholder path to the registered NCA path.
|-
| 17 || [2.0.0+] SetPlaceHolderSize || Takes a [[#NcaID]], and a u64 size
|-
| 18 || [2.0.0+] [[#ReadContentIdFile]] ||
|-
| 19 || [2.0.0+] [[#GetRightsIdFromPlaceHolderId]] ||
|-
| 20 || [2.0.0+] [[#GetRightsIdFromContentId]] ||
|-
| 21 || [2.0.0+] WriteContentForDebug || Takes a [[#NcaID]], a u64 offset, and a type 5 buffer. On debug units, writes the buffer to the NCA's registered path. On retail units, this just aborts.
|-
| 22 || [2.0.0+] GetFreeSpaceSize || Gets free space for the storage.
|-
| 23 || [2.0.0+] GetTotalSpaceSize || Gets total space for the storage.
|-
| 24 || [3.0.0+] FlushPlaceHolder || Flushes resources for the storage without closing it.
|-
| 25 || [4.0.0+] GetSizeFromPlaceHolderId ||
|-
| 26 || [4.0.0+] RepairInvalidFileAttribute ||
|-
| 27 || [8.0.0+] GetRightsIdFromPlaceHolderIdWithCache ||
|}

==== GeneratePlaceHolderId ====
Generates a random [[#NcaID]] for use as a placeholder.

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

==== GetContentCount ====
Writes the total number of entries which can be read by GetEntries, to cmdreply <SFCO_offset>+0x10.

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

Each entry is a [[#NcaID]].

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 [[#NcaID]] as input.

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

==== ReadContentIdFile ====
Takes an output buffer, a [[#NcaID]] as input, and a u64 file offset.

Reads plaintext NCA file contents from the Registered path for the NcaID.

==== GetRightsIdFromPlaceHolderId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s placeholder path.

==== GetRightsIdFromContentId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s registered path

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

Note the official name for Meta Record is "ContentMetaKey".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Set || Takes a [[CNMT#Meta_records|Meta Record]], a type-5 [[CNMT#Content_records|Content Records]] buffer and a u64 size.
|-
| 1 || Get || Takes a [[CNMT#Meta_records|Meta Record]], a type-6 buffer to write [[CNMT#Content_records|Content Records]] 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 meta records. Set takes this same data as input.
|-
| 2 || Remove || Takes a [[CNMT#Meta_records|Meta Record]], and removes the associated record.
|-
| 3 || GetContentIdByType || Takes a [[CNMT#Meta_records|Meta Record]] and a u8 [[#Title_Types|Title Type]]. Returns a [[#NcaID]].
|-
| 4 || ListContentInfo || Takes a type-6 buffer to write [[CNMT#Content_records|Content Record]] entries to, a [[CNMT#Meta_records|Meta Record]], and a u32 index into the Content Record entries to start copying from. Returns a u32 entries_read.
|-
| 5 || List || Takes a type-6 buffer to write [[CNMT#Meta_records|Meta Record]]s to, a u32 [[#Title_Types|Title Type]], a u64 TID, a u64 TID_LOW, and u64 TID_HIGH. Writes into the buffer all Meta Records with low <= record->title_id <= high, and record->type == type. Returns u32 numEntriesTotal, numEntriesWritten. 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.
|-
| 6 || GetLatestContentMetaKey || Takes a u64 title id, and returns the [[CNMT#Meta_records|Meta Record]] with the highest version field for that title id.
|-
| 7 || [[#ListApplication]] ||
|-
| 8 || Has || Takes a [[CNMT#Meta_records|Meta Record]] and returns whether that record is present in the database.
|-
| 9 || HasAll || Takes a type-5 buffer containing [[CNMT#Meta_records|Meta Records]] (code assumes there are size/sizeof(meta_record) records in the buffer), and returns whether all of those records are present in the database.
|-
| 10 || GetSize || Takes a [[CNMT#Meta_records|Meta Record]], and returns the size of the associated [[CNMT#Content_records|Content Records]].
|-
| 11 || GetRequiredSystemVersion || Takes a [[CNMT#Meta_records|Meta Record]], and returns u32 from ContentRecords + 16 (only if the Meta record has type Application or Patch).
|-
| 12 || GetPatchId || Takes a [[CNMT#Meta_records|Meta Record]], and returns the update title id for that record.
|-
| 13 || DisableForcibly || Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.
|-
| 14 || [[#LookupOrphanContent]] || Takes a type-6 byte buffer, and a type-5 buffer of [[#NcaID]]s.
|-
| 15 || Commit || Flushes the in-memory database to savedata.
|-
| 16 || HasContent || Takes a [[CNMT#Meta_records|Meta Record]] and an [[#NcaID]]. Returns whether the content records for that meta record contain the NcaID.
|-
| 17 || ListContentMetaInfo || Takes a type-6 [[CNMT#Meta_records|Meta Record]] output buffer, a u32 offset into that buffer, and an input [[CNMT#Meta_records|Meta Record]].
|-
| 18 || GetAttributes || Takes a [[CNMT#Meta_records|Meta Record]], and returns u8 from ContentRecords + 6.
|-
| 19 || [2.0.0+] GetRequiredApplicationVersion || Does the same thing as GetEntryUnknownRecordSize, but for AddOnContents.
|-
| 20 || [5.0.0+] GetContentIdByTypeAndIdOffset ||
|}

==== ListApplication ====
Each 24-byte entry (officially "ApplicationContentMetaKey") is as follows:
[[CNMT#Meta_records|meta_record]] meta_record;
u64 base_title_id;

This function takes in a type 6 buffer to write entries to, and a u8 "filter" [[#Title_Types|type]]. 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 u32 num_entries_total, and a u32 num_entries_written.

==== ReadEntryMetaRecords ====
Takes a type-6 [[CNMT#Meta_records|Meta Record]] output buffer, a u32 offset into that buffer, and an input [[CNMT#Meta_records|Meta Record]] entry. Returns a u32 for total_read_entries.

Reads the meta records stored in the entry's content records into the output buffer.

This is used, for example, with System Update title 0100000000000816, which contains Meta Records for all other systitles in its Content Records.

==== LookupOrphanContent ====
Takes a type-6 byte buffer, and a type-5 buffer containing [[#NcaID]]s.

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 [[#NcaID]] in the input buffer, it checks if that NcaID 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, NcaID in NcaIDs:
if is_present_in_database(NcaID):
out_buf[i] = 0

=== NcaID ===
This is a 0x10-byte entry. This is originally from the hex portion of "<hex>.nca" directory-names from this storage FS(like [[SD_Filesystem|SD]]). This is also referred to as "ContentId" in the official SDK.

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

=== Enums ===
==== Title Types ====

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x01
| SystemProgram ([[Title_list#System_Modules|System Modules]] or [[Title_list#System_Applets|System Applets]])
|-
| 0x02
| SystemData ([[Title_list#System_Data_Archives|System Data Archives]])
|-
| 0x03
| SystemUpdate
|-
| 0x04
| BootImagePackage ([[Title_list|Firmware package A or C]])
|-
| 0x05
| BootImagePackageSafe ([[Title_list|Firmware package B or D]])
|-
| 0x80
| Application
|-
| 0x81
| Patch
|-
| 0x82
| AddOnContent
|-
| 0x83
| Delta
|}

== ncm:v ==
This service doesn't normally exist on retail.

[[Category:Services]]

NS services

2019-08-18T04:06:26Z

Adubbz: IAsyncValue/Result

= aoc:u =
This is "nn::aocsrv::detail::IAddOnContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [1.0.0-6.2.0] CountAddOnContentByApplicationId
|-
| 1 || [1.0.0-6.2.0] ListAddOnContentByApplicationId
|-
| 2 || CountAddOnContent
|-
| 3 || ListAddOnContent
|-
| 4 || [1.0.0-6.2.0] GetAddOnContentBaseIdByApplicationId
|-
| 5 || GetAddOnContentBaseId
|-
| 6 || [1.0.0-6.2.0] PrepareAddOnContentByApplicationId
|-
| 7 || PrepareAddOnContent
|-
| 8 || [4.0.0+] GetAddOnContentListChangedEvent
|-
| 100 || [7.0.0+] [[#IPurchaseEventManager|CreateEcPurchasedEventManager]]
|}

== IPurchaseEventManager ==
This is "nn::ec::IPurchaseEventManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetDefaultDeliveryTarget
|-
| 1 || SetDeliveryTarget
|-
| 2 || GetPurchasedEventReadableHandle
|-
| 3 || PopPurchasedProductInfo
|}

= ns:am =
This is "nn::ns::detail::IApplicationManagerInterface".

[3.0.0+] This service was replaced by [[#ns:am2, ns:ec, ns:rid, ns:rt, ns:web|ns:am2]].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#ListApplicationRecord]]
|-
| 1 || GenerateApplicationRecordCount
|-
| 2 || GetApplicationRecordUpdateSystemEvent
|-
| 3 || GetApplicationViewDeprecated
|-
| 4 || DeleteApplicationEntity
|-
| 5 || DeleteApplicationCompletely
|-
| 6 || IsAnyApplicationEntityRedundant
|-
| 7 || DeleteRedundantApplicationEntity
|-
| 8 || IsApplicationEntityMovable
|-
| 9 || MoveApplicationEntity
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 16 || PushApplicationRecord
|-
| 17 || ListApplicationRecordContentMeta
|-
| 18 ||
|-
| 19 || [[#LaunchApplication]]
|-
| 21 || [[#GetApplicationContentPath]]
|-
| 22 || TerminateApplication
|-
| 23 || [2.0.0+] ResolveApplicationContentPath
|-
| 26 || BeginInstallApplication
|-
| 27 || DeleteApplicationRecord
|-
| 30 || RequestApplicationUpdateInfo
|-
| 31 || RequestUpdateApplication
|-
| 32 || CancelApplicationDownload
|-
| 33 || ResumeApplicationDownload
|-
| 34 ||
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 38 || CheckApplicationLaunchVersion
|-
| 39 || CheckApplicationLaunchRights
|-
| 40 || GetApplicationLogoData
|-
| 41 || CalculateApplicationDownloadRequiredSize
|-
| 42 || CleanupSdCard
|-
| 43 || CheckSdCardMountStatus
|-
| 44 || GetSdCardMountStatusChangedEvent
|-
| 45 || GetGameCardAttachmentEvent
|-
| 46 || GetGameCardAttachmentInfo
|-
| 47 || [[#GetTotalSpaceSize]]
|-
| 48 || [[#GetFreeSpaceSize]]
|-
| 49 || GetSdCardRemovedEvent
|-
| 52 || GetGameCardUpdateDetectionEvent
|-
| 53 || DisableApplicationAutoDelete
|-
| 54 || EnableApplicationAutoDelete
|-
| 55 || [[#GetApplicationDesiredLanguage]]
|-
| 56 || SetApplicationTerminateResult
|-
| 57 || ClearApplicationTerminateResult
|-
| 58 || GetLastSdCardMountUnexpectedResult
|-
| 59 || ConvertApplicationLanguageToLanguageCode
|-
| 60 || [[#ConvertLanguageCodeToApplicationLanguage]]
|-
| 61 || GetBackgroundDownloadStressTaskInfo
|-
| 62 || GetGameCardStopper
|-
| 63 || IsSystemProgramInstalled
|-
| 64 || [2.0.0+] StartApplyDeltaTask
|-
| 65 || [2.0.0+] GetRequestServerStopper
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || [2.0.0+] ResetToFactorySettingsForRefurbishment
|-
| 200 || CalculateUserSaveDataStatistics
|-
| 201 || DeleteUserSaveDataAll
|-
| 210 || DeleteUserSystemSaveData
|-
| 220 || UnregisterNetworkServiceAccount
|-
| 300 || GetApplicationShellEvent
|-
| 301 || PopApplicationShellEventInfo
|-
| 302 || LaunchLibraryApplet
|-
| 303 || TerminateLibraryApplet
|-
| 304 || LaunchSystemApplet
|-
| 305 || TerminateSystemApplet
|-
| 306 || LaunchOverlayApplet
|-
| 307 || TerminateOverlayApplet
|-
| 400 || [[#GetApplicationControlData]]
|-
| 401 || InvalidateAllApplicationControlCache
|-
| 402 || RequestDownloadApplicationControlData
|-
| 403 || GetMaxApplicationControlCacheCount
|-
| 404 || [2.0.0+] InvalidateApplicationControlCache
|-
| 405 || [2.0.0+] ListApplicationControlCacheEntryInfo
|-
| 502 || [2.0.0+] RequestCheckGameCardRegistration
|-
| 503 || [2.0.0+] RequestGameCardRegistrationGoldPoint
|-
| 504 || [2.0.0+] RequestRegisterGameCard
|-
| 600 || [2.0.0+] CountApplicationContentMeta
|-
| 601 || [2.0.0+] [[#ListApplicationContentMetaStatus]]
|-
| 602 || [2.0.0+] ListAvailableAddOnContent
|-
| 603 || [2.0.0+] GetOwnedApplicationContentMetaStatus
|-
| 604 || [2.0.0+] RegisterContentsExternalKey
|-
| 605 || [2.0.0+] ListApplicationContentMetaStatusWithRightsCheck
|-
| 700 || [2.0.0+] PushDownloadTaskList
|-
| 701 || [2.0.0+] ClearTaskStatusList
|-
| 702 || [2.0.0+] RequestDownloadTaskList
|-
| 703 || [2.0.0+] RequestEnsureDownloadTask
|-
| 704 || [2.0.0+] ListDownloadTaskStatus
|-
| 705 || [2.0.0+] RequestDownloadTaskListData
|-
| 800 || [2.0.0+] RequestVersionList
|-
| 801 || [2.0.0+] ListVersionList
|-
| 900 || [2.0.0+] GetApplicationRecord
|-
| 901 || [2.0.0+] GetApplicationRecordProperty
|-
| 902 || [2.0.0+] EnableApplicationAutoUpdate
|-
| 903 || [2.0.0+] DisableApplicationAutoUpdate
|-
| 904 || [2.0.0+] TouchApplication
|-
| 905 || [2.0.0+] RequestApplicationUpdate
|-
| 906 || [2.0.0+] IsApplicationUpdateRequested
|-
| 907 || [2.0.0+] WithdrawApplicationUpdateRequest
|-
| 908 || [2.0.0+] ListApplicationRecordInstalledContentMeta
|-
| 1000 || [2.0.0+] RequestVerifyApplicationDeprecated
|-
| 1001 || [2.0.0+] CorruptApplicationForDebug
|-
| 1200 || [2.0.0+] [[#NeedsUpdateVulnerability]]
|-
| 1300 || [2.0.0+] IsAnyApplicationEntityInstalled
|-
| 1301 || [2.0.0+] DeleteApplicationContentEntities
|-
| 1302 || [2.0.0+] CleanupUnrecordedApplicationEntity
|-
| 1400 || [2.0.0+] PrepareShutdown
|-
| 1500 || [2.0.0+] FormatSdCard
|-
| 1501 || [2.0.0+] NeedsSystemUpdateToFormatSdCard
|-
| 1502 || [2.0.0+] GetLastSdCardFormatUnexpectedResult
|-
| 1503 || [2.0.0+]
|-
| 1600 || [2.0.0+] GetSystemSeedForPseudoDeviceId
|-
| 1700 || [2.0.0+] ListApplicationDownloadingContentMeta
|-
| 1800 || [2.0.0+] IsNotificationSetupCompleted
|-
| 1801 || [2.0.0+] GetLastNotificationInfoCount
|-
| 1802 || [2.0.0+] ListLastNotificationInfo
|}

== ListApplicationRecord ==
Takes a type-6 output buffer and an u32 entry_offset.

Returns an array of title-info entries using the specified offset and size. No input titleID is passed to this.

=== Application Record Format ===

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Title ID
|-
| 0x8
| 0x1
| Type? (Known values: 2=Installing?, 3=Gamecard?, 4=Installed?)
|-
| 0x9
| 0x1
| Unknown, usually 0x02
|-
| 0xA
| 0x6
| Unknown, usually zeros?
|-
| 0x10
| 0x1
| Unknown, seems to change between reboots and removing/reinserting gamecards
|-
| 0x11
| 0x7
| Unknown, usually zeros?
|}

== LaunchApplication ==
Takes an input u64 titleID, returns an output u64 PID.

Launches an application title which is registered with NS.

== GetApplicationContentPath ==
Takes a 0x16-type output buffer, an u8 [[NCM_services#Title_Types|title type]], and an u64 titleID.

The input titleID is used with the application-title table like various other cmds, anything not in that table can't be used with this.

Returns a string path for the specified type of patch content with this titleID, otherwise returns regular-application paths when update-title not installed. Returns an error when the specified type of content doesn't exist for this title. Starts with "@{SdCardContent,UserContent}://" and ends in ".nca".

For gamecard content, the output path is: "@GcSXXXXXXXX:/<NcaId>.nca". NCA-type0 with gamecard returns 0 with an empty output string.

The output string is then used by the user-process with [[Filesystem_services|FS]] to mount the content.

== GetTotalSpaceSize ==
Takes an input media-id that must be 5.

Returns the u64 from [[Content_Manager_services#IContentStorage]] cmd22.

== GetFreeSpaceSize ==
Takes an input media-id that must be 5.

Returns the u64 from [[Content_Manager_services#IContentStorage]] cmd23.

== GetApplicationDesiredLanguage ==
Takes an input u8 language-bitmask, returns an output u8 [[control.nacp]] langentry index.

User-processes generate the language-bitmask with the following for all 16 lang-entries: <code>if(<either string in langentry[i] is non-empty>)bitmask |= 1<<i</code>

== ConvertLanguageCodeToApplicationLanguage ==
Takes an input u8 pointer for the resulting Id to be written to and a string represented as a u64 (i.e 0x53552D6E65 for 'en-US').

Returns 0 if an ID was successfully found, otherwise returns 0x25810.

== GetApplicationControlData ==
Takes an input u8 flag, an u64 titleID, and a type-0x6 output buffer. Returns an output u32 for actual_size. Official user-processes use buffer size 0x24000. [[qlaunch]] only uses flag value 0x1.

Loads cached [[control.nacp]] to buf+0 and the cached icon to buf+0x4000. Returns an error if the buffer is too small.

== ListApplicationContentMetaStatus ==
Returns 0x10-byte entries using the specified titleID starting at the specified u32 entryindex. Can only return game titles. The second entry if any is the update-title usually. When the input entryindex is >= totalentries, this will return 0 with out_entrycount=0.

Entry structure:
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| u8 "type". [[Content_Manager_services|Title type]] (String is from web-applet)
|-
| 0x1
| 0x1
| u8 "installedStorage" / [[Filesystem_services|StorageId]] (String is from web-applet)
|-
| 0x2
| 0x1
| Unknown. Non-zero with output from cmd 605, differs for app/update titles.
|-
| 0x3
| 0x1
| Padding
|-
| 0x4
| 0x4
| u32 Title-version
|-
| 0x8
| 0x8
| u64 titleID
|}

= ns:am2, ns:ec, ns:rid, ns:rt, ns:web =
These services are all, at the top level, "nn::ns::detail::IServiceGetterInterface". These commands check a state field for a command-specific bit and returns an error if not set, this is likely a permissions check for service+command.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 7988 || [6.0.0+] Returns an output [[#IDynamicRightsInterface]].
|-
| 7989 || [5.1.0+] Returns an output [[#IReadOnlyApplicationControlDataInterface]].
|-
| 7991 || [5.0.0+] Returns an output [[#IReadOnlyApplicationRecordInterface]].
|-
| 7992 || [4.0.0+] [[#IECommerceInterface|GetECommerceInterface]]
|-
| 7993 || [4.0.0+] [[#IApplicationVersionInterface|GetApplicationVersionInterface]]
|-
| 7994 || [[#IFactoryResetInterface|GetFactoryResetInterface]]
|-
| 7995 || [[#IAccountProxyInterface|GetAccountProxyInterface]]
|-
| 7996 || [[#IApplicationManagerInterface|GetApplicationManagerInterface]]
|-
| 7997 || [[#IDownloadTaskInterface|GetDownloadTaskInterface]]
|-
| 7998 || [[#IContentManagementInterface|GetContentManagementInterface]]
|-
| 7999 || [[#IDocumentInterface|GetDocumentInterface]]
|-
|}

=== IAccountProxyInterface ===
This is "nn::ns::detail::IAccountProxyInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CreateUserAccount
|-
|}

=== IApplicationManagerInterface ===
This is "nn::ns::detail::IApplicationManagerInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#ListApplicationRecord]]
|-
| 1 || GenerateApplicationRecordCount
|-
| 2 || GetApplicationRecordUpdateSystemEvent
|-
| 3 || GetApplicationViewDeprecated
|-
| 4 || DeleteApplicationEntity
|-
| 5 || DeleteApplicationCompletely
|-
| 6 || IsAnyApplicationEntityRedundant
|-
| 7 || DeleteRedundantApplicationEntity
|-
| 8 || IsApplicationEntityMovable
|-
| 9 || MoveApplicationEntity
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 16 || PushApplicationRecord
|-
| 17 || ListApplicationRecordContentMeta
|-
| 19 || [1.0.0-5.1.0] LaunchApplicationOld
|-
| 21 || [[#GetApplicationContentPath]]
|-
| 22 || TerminateApplication
|-
| 23 || ResolveApplicationContentPath
|-
| 26 || BeginInstallApplication
|-
| 27 || DeleteApplicationRecord
|-
| 30 || RequestApplicationUpdateInfo
|-
| [1.0.0-3.0.2] 31 ||
|-
| 32 || CancelApplicationDownload
|-
| 33 || ResumeApplicationDownload
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 38 || CheckApplicationLaunchVersion
|-
| [1.0.0-6.2.0] 39 || CheckApplicationLaunchRights
|-
| 40 || GetApplicationLogoData
|-
| 41 || CalculateApplicationDownloadRequiredSize
|-
| 42 || CleanupSdCard
|-
| 43 || CheckSdCardMountStatus
|-
| 44 || GetSdCardMountStatusChangedEvent
|-
| 45 || GetGameCardAttachmentEvent
|-
| 46 || GetGameCardAttachmentInfo
|-
| 47 || [[#GetTotalSpaceSize]]
|-
| 48 || [[#GetFreeSpaceSize]]
|-
| 49 || GetSdCardRemovedEvent
|-
| 52 || GetGameCardUpdateDetectionEvent
|-
| 53 || DisableApplicationAutoDelete
|-
| 54 || EnableApplicationAutoDelete
|-
| 55 || GetApplicationDesiredLanguage
|-
| 56 || SetApplicationTerminateResult
|-
| 57 || ClearApplicationTerminateResult
|-
| 58 || GetLastSdCardMountUnexpectedResult
|-
| 59 || ConvertApplicationLanguageToLanguageCode
|-
| 60 || [[#ConvertLanguageCodeToApplicationLanguage]]
|-
| 61 || GetBackgroundDownloadStressTaskInfo
|-
| 62 || GetGameCardStopper
|-
| 63 || IsSystemProgramInstalled
|-
| 64 || StartApplyDeltaTask
|-
| 65 || GetRequestServerStopper
|-
| 66 || [3.0.0+] GetBackgroundApplyDeltaStressTaskInfo
|-
| 67 || [3.0.0+] CancelApplicationApplyDelta
|-
| 68 || [3.0.0+] ResumeApplicationApplyDelta
|-
| 69 || [3.0.0+] CalculateApplicationApplyDeltaRequiredSize
|-
| 70 || [3.0.0+] ResumeAll
|-
| 71 || [3.0.0+] GetStorageSize
|-
| 80 || [3.0.0+] RequestDownloadApplication
|-
| 81 || [3.0.0+] RequestDownloadAddOnContent
|-
| 82 || [3.0.0+] DownloadApplication
|-
| [4.0.0-6.2.0] 83 || CheckApplicationResumeRights
|-
| 84 || [4.0.0+] GetDynamicCommitEvent
|-
| 85 || [4.0.0+] RequestUpdateApplication2
|-
| 86 || [4.0.0+] EnableApplicationCrashReport
|-
| 87 || [4.0.0+] IsApplicationCrashReportEnabled
|-
| 90 || [4.0.0+] BoostSystemMemoryResourceLimit
|-
| 91 || [5.0.0+] DeprecatedLaunchApplication
|-
| 92 || [5.0.0+] GetRunningApplicationProgramId
|-
| 93 || [5.0.0+] GetMainApplicationProgramIndex
|-
| 94 || [6.0.0+] LaunchApplication
|-
| 95 || [6.0.0+] GetApplicationLaunchInfo
|-
| 96 || [6.0.0+] AcquireApplicationLaunchInfo
|-
| 97 || [6.0.0+] GetMainApplicationProgramIndexByApplicationLaunchInfo
|-
| 98 || [6.0.0+] EnableApplicationAllThreadDumpOnCrash
|-
| 99 || [8.0.0+]
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || ResetToFactorySettingsForRefurbishment
|-
| 200 || CalculateUserSaveDataStatistics
|-
| 201 || DeleteUserSaveDataAll
|-
| 210 || DeleteUserSystemSaveData
|-
| 211 || [6.0.0+] DeleteSaveData
|-
| 220 || UnregisterNetworkServiceAccount
|-
| 221 || [6.0.0+] UnregisterNetworkServiceAccountWithUserSaveDataDeletion
|-
| 300 || GetApplicationShellEvent
|-
| 301 || PopApplicationShellEventInfo
|-
| 302 || LaunchLibraryApplet
|-
| 303 || TerminateLibraryApplet
|-
| 304 || LaunchSystemApplet
|-
| 305 || TerminateSystemApplet
|-
| 306 || LaunchOverlayApplet
|-
| 307 || TerminateOverlayApplet
|-
| 400 || GetApplicationControlData
|-
| 401 || InvalidateAllApplicationControlCache
|-
| 402 || RequestDownloadApplicationControlData
|-
| 403 || GetMaxApplicationControlCacheCount
|-
| 404 || InvalidateApplicationControlCache
|-
| 405 || ListApplicationControlCacheEntryInfo
|-
| 406 || [6.0.0+] GetApplicationControlProperty
|-
| 407 || [8.0.0+]
|-
| 408 || [8.0.0+]
|-
| 502 || RequestCheckGameCardRegistration
|-
| 503 || RequestGameCardRegistrationGoldPoint
|-
| 504 || RequestRegisterGameCard
|-
| 505 || [3.0.0+] GetGameCardMountFailureEvent
|-
| 506 || [3.0.0+] IsGameCardInserted
|-
| 507 || [3.0.0+] EnsureGameCardAccess
|-
| 508 || [3.0.0+] GetLastGameCardMountFailureResult
|-
| 509 || [5.0.0+] ListApplicationIdOnGameCard
|-
| 600 || CountApplicationContentMeta
|-
| 601 || [[#ListApplicationContentMetaStatus]]
|-
| 602 || [2.0.0-5.1.0] ListAvailableAddOnContent
|-
| 603 || GetOwnedApplicationContentMetaStatus
|-
| 604 || RegisterContentsExternalKey
|-
| 605 || ListApplicationContentMetaStatusWithRightsCheck
|-
| 606 || [3.0.0+] GetContentMetaStorage
|-
| 607 || [6.0.0+] ListAvailableAddOnContent
|-
| 700 || PushDownloadTaskList
|-
| 701 || ClearTaskStatusList
|-
| 702 || RequestDownloadTaskList
|-
| 703 || RequestEnsureDownloadTask
|-
| 704 || ListDownloadTaskStatus
|-
| 705 || RequestDownloadTaskListData
|-
| 800 || RequestVersionList
|-
| 801 || ListVersionList
|-
| 802 || [3.0.0+] RequestVersionListData
|-
| 900 || GetApplicationRecord
|-
| 901 || GetApplicationRecordProperty
|-
| 902 || EnableApplicationAutoUpdate
|-
| 903 || DisableApplicationAutoUpdate
|-
| 904 || TouchApplication
|-
| 905 || RequestApplicationUpdate
|-
| 906 || IsApplicationUpdateRequested
|-
| 907 || WithdrawApplicationUpdateRequest
|-
| 908 || ListApplicationRecordInstalledContentMeta
|-
| 909 || [3.0.0+] WithdrawCleanupAddOnContentsWithNoRightsRecommendation
|-
| 910 || [5.0.0+] HasApplicationRecord
|-
| 911 || [5.1.0+] SetPreInstalledApplication
|-
| 912 || [5.1.0+] ClearPreInstalledApplicationFlag
|-
| 1000 || RequestVerifyApplicationDeprecated
|-
| 1001 || CorruptApplicationForDebug
|-
| 1002 || [3.0.0+] RequestVerifyAddOnContentsRights
|-
| 1003 || [5.0.0+] RequestVerifyApplication
|-
| 1004 || [5.0.0+] CorruptContentForDebug
|-
| 1200 || [[#NeedsUpdateVulnerability]]
|-
| 1300 || IsAnyApplicationEntityInstalled
|-
| 1301 || DeleteApplicationContentEntities
|-
| 1302 || CleanupUnrecordedApplicationEntity
|-
| 1303 || [3.0.0+] CleanupAddOnContentsWithNoRights
|-
| 1304 || [3.0.0+] DeleteApplicationContentEntity
|-
| 1308 || [5.0.0+] DeleteApplicationCompletelyForDebug
|-
| 1309 || [6.0.0+] CleanupUnavailableAddOnContents
|-
| 1400 || PrepareShutdown
|-
| 1500 || FormatSdCard
|-
| 1501 || NeedsSystemUpdateToFormatSdCard
|-
| 1502 || GetLastSdCardFormatUnexpectedResult
|-
| 1504 || [3.0.0+] InsertSdCard
|-
| 1505 || [3.0.0+] RemoveSdCard
|-
| 1600 || GetSystemSeedForPseudoDeviceId
|-
| 1601 || [3.0.0+] ResetSystemSeedForPseudoDeviceId
|-
| 1700 || ListApplicationDownloadingContentMeta
|-
| 1701 || [3.0.0+] GetApplicationView
|-
| 1702 || [3.0.0+] GetApplicationDownloadTaskStatus
|-
| 1703 || [4.0.0+] GetApplicationViewDownloadErrorContext
|-
| 1704 || [8.0.0+]
|-
| 1800 || IsNotificationSetupCompleted
|-
| 1801 || GetLastNotificationInfoCount
|-
| 1802 || ListLastNotificationInfo
|-
| 1803 || [3.0.0+] ListNotificationTask
|-
| 1900 || [3.0.0+] IsActiveAccount
|-
| 1901 || [4.0.0+] RequestDownloadApplicationPrepurchasedRights
|-
| 1902 || [5.0.0+] GetApplicationTicketInfo
|-
| 2000 || [4.0.0+] GetSystemDeliveryInfo
|-
| 2001 || [4.0.0+] SelectLatestSystemDeliveryInfo
|-
| 2002 || [4.0.0+] VerifyDeliveryProtocolVersion
|-
| 2003 || [4.0.0+] GetApplicationDeliveryInfo
|-
| 2004 || [4.0.0+] HasAllContentsToDeliver
|-
| 2005 || [4.0.0+] CompareApplicationDeliveryInfo
|-
| 2006 || [4.0.0+] CanDeliverApplication
|-
| 2007 || [4.0.0+] ListContentMetaKeyToDeliverApplication
|-
| 2008 || [4.0.0+] NeedsSystemUpdateToDeliverApplication
|-
| 2009 || [4.0.0+] EstimateRequiredSize
|-
| 2010 || [4.0.0+] RequestReceiveApplication
|-
| 2011 || [4.0.0+] CommitReceiveApplication
|-
| 2012 || [4.0.0+] GetReceiveApplicationProgress
|-
| 2013 || [4.0.0+] RequestSendApplication
|-
| 2014 || [4.0.0+] GetSendApplicationProgress
|-
| 2015 || [4.0.0+] CompareSystemDeliveryInfo
|-
| 2016 || [4.0.0+] ListNotCommittedContentMeta
|-
| 2017 || [4.0.0+] RecoverDownloadTask
|-
| 2018 || [5.0.0+] GetApplicationDeliveryInfoHash
|-
| 2050 || [6.0.0+] GetApplicationRightsOnClient
|-
| 2100 || [6.0.0+] GetApplicationTerminateResult
|-
| 2101 || [6.0.0+] GetRawApplicationTerminateResult
|-
| 2150 || [6.0.0+] CreateRightsEnvironment
|-
| 2151 || [6.0.0+] DestroyRightsEnvironment
|-
| 2152 || [6.0.0+] ActivateRightsEnvironment
|-
| 2153 || [6.0.0+] DeactivateRightsEnvironment
|-
| 2154 || [6.0.0+] ForceActivateRightsContextForExit
|-
| 2155 || [7.0.0+] UpdateRightsEnvironmentStatus
|-
| 2160 || [6.0.0+] AddTargetApplicationToRightsEnvironment
|-
| 2161 || [6.0.0+] SetUsersToRightsEnvironment
|-
| 2170 || [6.0.0+] GetRightsEnvironmentStatus
|-
| 2171 || [6.0.0+] GetRightsEnvironmentStatusChangedEvent
|-
| 2180 || [6.0.0+] RequestExtendExpirationInRightsEnvironment
|-
| 2181 || [6.0.0+] GetResultOfExtendExpirationInRightsEnvironment
|-
| 2182 || [6.0.0+] SetActiveRightsContextUsingStateToRightsEnvironment
|-
| 2190 || [6.0.0+] GetRightsEnvironmentHandleForApplication
|-
| 2199 || [6.0.0+] GetRightsEnvironmentCountForDebug
|-
| 2200 || [6.0.0+] GetGameCardApplicationCopyIdentifier
|-
| 2201 || [6.0.0+] GetInstalledApplicationCopyIdentifier
|-
| [6.0.0-6.2.0] 2250 || RequestReportActiveELicence
|-
| 2300 || [6.0.0+] ListEventLog
|-
| 2350 || [7.0.0+]
|-
| 2400 || [8.0.0+]
|-
| 2401 || [8.0.0+]
|-
| 2402 || [8.0.0+]
|-
| 2403 || [8.0.0+]
|-
| 2404 || [8.0.0+]
|-
| 2500 || [8.0.0+]
|-
|}

[4.0.0+] RequestDownloadAddOnContent now takes an additional 8-bytes of input.

==== Cmd99 ====
No input/output.

This is used by AM cmd [[Applet_Manager_services#LaunchDevMenu|LaunchDevMenu]].

This uses [[System_Settings|system-settings]] <code>ns.applet!devmenu_id</code> and <code>ns.applet!devoverlaydisp_id</code>, which only exists on devunits.

=== IApplicationVersionInterface ===
This is "nn::ns::detail::IApplicationVersionInterface".

This was added with [4.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetLaunchRequiredVersion
|-
| 1 || UpgradeLaunchRequiredVersion
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 800 || RequestVersionList
|-
| 801 || ListVersionList
|-
| 802 || RequestVersionListData
|-
| 1000 || PerformAutoUpdate
|-
|}

=== IContentManagerInterface ===
This is "nn::ns::detail::IContentManagementInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 43 || CheckSdCardMountStatus
|-
| 47 || GetTotalSpaceSize
|-
| 48 || GetFreeSpaceSize
|-
| 600 || CountApplicationContentMeta
|-
| 601 || ListApplicationContentMetaStatus
|-
| 605 || ListApplicationContentMetaStatusWithRightsCheck
|-
| 607 || IsAnyApplicationRunning
|-
|}

=== IDocumentInterface ===
This is "nn::ns::detail::IDocumentInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 21 || GetApplicationContentPath
|-
| 23 || ResolveApplicationContentPath
|-
| 92 || [5.0.0+] GetRunningApplicationProgramId
|-
|}

=== IDownloadTaskInterface ===
This is "nn::ns::detail::IDownloadTaskInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 701 || ClearTaskStatusList
|-
| 702 || RequestDownloadTaskList
|-
| 703 || RequestEnsureDownloadTask
|-
| 704 || ListDownloadTaskStatus
|-
| 705 || RequestDownloadTaskListData
|-
| 706 || [4.0.0+] TryCommitCurrentApplicationDownloadTask
|-
| 707 || [4.0.0+] EnableAutoCommit
|-
| 708 || [4.0.0+] DisableAutoCommit
|-
| 709 || [4.0.0+] TriggerDynamicCommitEvent
|-
|}

=== IReadOnlyApplicationRecordInterface ===
This is "nn::ns::detail::IReadOnlyApplicationRecordInterface".

This was added with [5.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || HasApplicationRecord || Same as [[#IApplicationManagerInterface]] cmd 910
|}

=== IReadOnlyApplicationControlDataInterface ===
This is "nn::ns::detail::IReadOnlyApplicationControlDataInterface".

This was added with [5.1.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetApplicationControlData]] || Same as [[#IApplicationManagerInterface]] cmd 400
|-
| 1 || [[#GetApplicationDesiredLanguage]] || Same as [[#IApplicationManagerInterface]] cmd 55
|-
| 2 || ConvertApplicationLanguageToLanguageCode || Same as [[#IApplicationManagerInterface]] cmd 59
|-
| 3 || [[#ConvertLanguageCodeToApplicationLanguage]] || Same as [[#IApplicationManagerInterface]] cmd 60
|}

=== IDynamicRightsInterface ===
This is "nn::ns::detail::IDynamicRightsInterface".

This was added with [6.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || ||
|-
| 1 || ||
|-
| 4 || ||
|-
| 5 || ||
|-
| 6 || ||
|-
| 7 || ||
|-
| 8 || ||
|-
| 9 || [7.0.0+] ||
|-
| 10 || [7.0.0+] ||
|-
| 11 || [7.0.0+] ||
|-
| 12 || [8.0.0+]
|-
| 13 || [8.0.0+]
|-
|}

=== IECommerceInterface===
This is "nn::ns::detail::IECommerceInterface".

This was added with [4.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || RequestLinkDevice || Takes a total of 0x10-bytes of input, returns an [[#IAsyncResult]].
|-
| 1 || [6.0.0+] RequestCleanupAllPreInstalledApplications || No input, returns an [[#IAsyncResult]].
|-
| 2 || [6.0.0+] RequestCleanupPreInstalledApplication || Takes a total of 0x8-bytes of input, returns an [[#IAsyncResult]].
|-
| 3 || [6.0.0+] RequestSyncRights || No input, returns an [[#IAsyncResult]].
|-
| 4 || [6.0.0+] RequestUnlinkDevice || Takes a total of 0x10-bytes of input, returns an [[#IAsyncResult]].
|-
| 5 || [6.1.0+] RequestRevokeAllELicense || Takes a total of 0x10-bytes of input, returns an [[#IAsyncResult]].
|}

=== IFactoryResetInterface ===
This is "nn::ns::detail::IFactoryResetInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || ResetToFactorySettingsForRefurbishment
|-
|}

= ns:vm =
This is "nn::ns::detail::IVulnerabilityManagerInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1200 || [3.0.0+] [[#NeedsUpdateVulnerability]]
|-
| 1201 || [4.0.0+] [[#UpdateSafeSystemVersionForDebug]]
|-
| 1202 || [4.0.0+] [[#GetSafeSystemVersion]]
|-
|}

== NeedsUpdateVulnerability ==
No input, returns an output u8 bool flag.

Web-applets use this command to check if the system needs an update.

== UpdateSafeSystemVersionForDebug ==
Takes an input u64 '''titleID''' and an u32 '''version'''.

This command is not available for retail units. On a debug unit, if the [[System_Settings|system setting]] <code>vulnerability!enable_debug</code> is set, this mounts the system savegame [[Flash_Filesystem#System_Savegames|0x8000000000000049]] as "ns_ssversion:/", opens the file "ns_ssversion:/entry" and writes the supplied '''titleID''' and '''version''' in it.

Finally, it calls [[NCM_services#ncm|OpenContentMetaDatabase]] with [[Filesystem_services#StorageId|StorageID]] 3, then calls [[NCM_services#IContentMetaDatabase|GetLatestContentMetaKey]] with the supplied '''titleID''' and compares the version field from the returned [[CNMT#Content_Meta_Records|Content Meta Record]] with the supplied '''version'''.

If the supplied '''version''' is higher than the one in NCM's database, the value returned by [[NS_Services#NeedsUpdateVulnerability|NeedsUpdateVulnerability]] is set to "true".

== GetSafeSystemVersion ==
No input, returns a 0x10 byte array with the cached contents of "ns_ssversion:/entry" (u64 '''titleID''', u32 '''version''' and u32 '''policy''' from <code>vulnerability!needs_update_vulnerability_policy</code>).

= ns:su =
This is "nn::ns::detail::ISystemUpdateInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetBackgroundNetworkUpdateState
|-
| 1 || [[#ISystemUpdateControl|OpenSystemUpdateControl]]
|-
| 2 || NotifyExFatDriverRequired
|-
| 3 || ClearExFatDriverStatusForDebug
|-
| 4 || RequestBackgroundNetworkUpdate
|-
| 5 || NotifyBackgroundNetworkUpdate
|-
| 6 || NotifyExFatDriverDownloadedForDebug
|-
| 9 || GetSystemUpdateNotificationEventForContentDelivery
|-
| 10 || NotifySystemUpdateForContentDelivery
|-
| 11 || [3.0.0+] PrepareShutdown
|-
| [3.0.0-3.0.2] 12 ||
|-
| [3.0.0-3.0.2] 13 ||
|-
| [3.0.0-3.0.2] 14 ||
|-
| [3.0.0-3.0.2] 15 ||
|-
| 16 || [4.0.0+] DestroySystemUpdateTask
|-
| 17 || [4.0.0+] RequestSendSystemUpdate
|-
| 18 || [4.0.0+] GetSendSystemUpdateProgress
|-
|}

== ISystemUpdateControl ==
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#HasDownloaded]]
|-
| 1 || RequestCheckLatestUpdate
|-
| 2 || RequestDownloadLatestUpdate
|-
| 3 || [[#GetDownloadProgress]]
|-
| 4 || [[#ApplyDownloadedUpdate]]
|-
| 5 || RequestPrepareCardUpdate
|-
| 6 || GetPrepareCardUpdateProgress
|-
| 7 || HasPreparedCardUpdate
|-
| 8 || ApplyCardUpdate
|-
| 9 || [[#GetDownloadedEulaDataSize]]
|-
| 10 || [[#GetDownloadedEulaData]]
|-
| 11 || SetupCardUpdate
|-
| 12 || GetPreparedCardUpdateEulaDataSize
|-
| 13 || GetPreparedCardUpdateEulaData
|-
| 14 || [4.0.0+] SetupCardUpdateViaSystemUpdater
|-
| 15 || [4.0.0+] HasReceived
|-
| 16 || [4.0.0+] RequestReceiveSystemUpdate
|-
| 17 || [4.0.0+] GetReceiveProgress
|-
| 18 || [4.0.0+] ApplyReceivedUpdate
|-
| 19 || [4.0.0+] GetReceivedEulaDataSize
|-
| 20 || [4.0.0+] GetReceivedEulaData
|-
| 21 || [4.0.0+] SetupToReceiveSystemUpdate
|-
| 22 || [6.0.0+] RequestCheckLatestUpdateIncludesRebootlessUpdate
|}

=== HasDownloaded ===
No input, returns an output u8 bool flag.

Gets whether a network sysupdate was downloaded, with install pending.

Uses [[NIM_services|nim]] ListSystemUpdateTask and [[NIM_services|nim]] GetSystemUpdateTaskInfo. When ListSystemUpdateTask successfully returns a task and GetSystemUpdateTaskInfo is successful, the output flag is set to: <code>*((u8*)(taskinfo+0) == 0x3</code>. Otherwise, flag=0.

This always returns 0, however this will assert if GetSystemUpdateTaskInfo fails with ret!=0x3C89.

=== GetDownloadProgress ===
No input, returns a 0x10-byte output struct.

Similar to [[#HasDownloaded]] except instead of a flag, this returns the 0x10-bytes from taskinfo+8. The output struct is cleared when the task(info) isn't available.

=== ApplyDownloadedUpdate ===
No input/output.

Runs code similar to [[#HasDownloaded]], throwing an error if a network sysupdate isn't ready for install. Then the sysupdate is installed:

* Uses ListSystemUpdateTask again, then [[NIM_services|nim]] IsExFatDriverIncluded. Runs ExFat handling when the output flag is set.
* The two flags in [[Flash_Filesystem#System_Update_Control]] are set to 1.
* Uses [[NIM_services|nim]] CommitSystemUpdateTask and [[NIM_services|nim]] DestroySystemUpdateTask.
* Installs FIRM.

=== GetDownloadedEulaDataSize ===
Takes a type-0x15 input buffer '''path''', returns an output u64 '''filesize'''.

Runs code similar to [[#HasDownloaded]], throwing an error if a network sysupdate isn't ready for install.

Uses ListSystemUpdateTask again. Then [[NIM_services|nim]] GetDownloadedSystemDataPath, with the output ContentPath being used to mount the EULA title with FS.

Then "<mountname>:/<'''path'''>" is opened, gets the '''filesize''', then runs cleanup.

=== GetDownloadedEulaData ===
Takes a type-0x15 input buffer '''path''' and a type-0x6 output buffer, returns an output u64 '''filesize'''.

Similar to [[#GetDownloadedEulaDataSize]] except this reads the file instead, using the specified output buffer with size=filesize. This will throw an error if the filesize is larger than the buffer size.

= IAsyncValue =
This is "nn::ns::detail::IAsyncValue".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetSize
|-
| 1 || Get
|-
| 2 || Cancel
|-
| 3 || [4.0.0+] GetErrorContext
|}

Cmd3: No input/output, takes a type-0x16 output buffer.

= IAsyncResult =
This is "nn::ns::detail::IAsyncResult".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Get
|-
| 1 || Cancel
|-
| 2 || [4.0.0+] GetErrorContext
|}

Cmd2: No input/output, takes a type-0x16 output buffer.

= ns:dev =
This is "nn::ns::detail::IDevelopInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#LaunchProgram]]
|-
| 1 || [[#TerminateProcess]]
|-
| 2 || [[#TerminateProgram]]
|-
| 4 || [[#GetShellEvent]]
|-
| 5 || [[#GetShellEventInfo]]
|-
| 6 || [[#TerminateApplication]]
|-
| 7 || [[#PrepareLaunchProgramFromHost]]
|-
| 8 || [[#LaunchApplicationForDevelop]]
|-
| 9 || [[#LaunchApplicationWithStorageIdForDevelop]]
|-
| 10 || [6.0.0+] TerminateApplication2
|-
| 11 || [6.0.0+] GetRunningApplicationProcessIdForDevelop
|-
| 12 || [6.0.0+] SetCurrentApplicationRightsEnvironmentCanBeActiveForDevelop
|}

== LaunchProgram ==
Wrapper for "pm:shell" [[Process_Manager_services#LaunchProcess|LaunchProcess]].

== TerminateProcess ==
Wrapper for "pm:shell" [[Process_Manager_services#TerminateTitleByPid|TerminateTitleByPid]].

== TerminateProgram ==
Wrapper for "pm:shell" [[Process_Manager_services#TerminateTitleByTitleId|TerminateTitleByTitleId]].

== GetShellEvent ==
Wrapper for "pm:shell" [[Process_Manager_services#GetProcessEventWaiter|GetProcessEventWaiter]].

== GetShellEventInfo ==
Wrapper for "pm:shell" [[Process_Manager_services#GetProcessEventType|GetProcessEventType]].

== TerminateApplication ==
Calls "pm:shell" [[Process_Manager_services#GetCrashingProcessPid|GetCrashingProcessPid]] and sends PID to [[Process_Manager_services#TerminateTitleByPid|TerminateTitleByPid]].

== PrepareLaunchProgramFromHost ==
Takes a type-0x5 input buffer containing the [[Filesystem_services|ContentPath]], returns an output 0x10-byte struct.

Calls [[NCM_services#IPathResolverForStorage|IPathResolverForStorage]] Set...NcaPath functions.

== LaunchApplicationForDevelop ==
Takes an input u32 [[Process_Manager_services#LaunchFlags|LaunchFlags]] and u64 titleID, returns an output u64 PID.

Same as LaunchApplicationWithStorageId except the last two params passed to the internal vtable funcptr call are value 0x6, instead of from the command input.

== LaunchApplicationWithStorageIdForDevelop ==
Takes 2 input u8s, an u32 [[Process_Manager_services#LaunchFlags|LaunchFlags]], and an u64 titleID. Returns an output u64 PID.

Launches an application title which is registered with NS.

[[Category:Services]]

Filesystem services

2019-07-04T03:19:20Z

Adubbz: Update SaveCreate Struct

= fsp-ldr =
This is "nn::fssrv::sf::IFileSystemProxyForLoader".

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || OpenCodeFileSystem || u64 TitleId + X descriptor [[#ContentPath]] || Returns an [[#IFileSystem]].
|-
| 1 || IsArchivedProgram || u64 ProcessId || Returns a bool (1 if the process id's [[#ContentPath]] ends in ".nca").
|-
| 2 || [4.0.0+] SetCurrentProcess || PID descriptor ||
|}

= fsp-pr =
This is "nn::fssrv::sf::IProgramRegistry".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#RegisterProgram]] ||
|-
| 1 || [[#UnregisterProgram]] ||
|-
| 2 || [4.0.0+] SetCurrentProcess ||
|-
| 256 || [[#SetEnabledProgramVerification]] ||
|}

== RegisterProgram ==
Takes a storageID, a pid, a titleID, a 0x1C type-A buffer for the [[NPDM#FS_Access_Header| FS Access Header]], and a 0x2C type-A buffer for the [[NPDM#FS_Access_Control| FS Access Control]]

Final FS permissions are stored as (ACI0_perms & ACID_perms). Will panic(svcBreak) when buffer sizes from ipc-rawdata are invalid.

== UnregisterProgram ==
Takes a pid. Removes registered FS permissions for that PID.

== SetEnabledProgramVerification ==
Seems to sets a global flag to inputval & 1.

When the flag is zero, it will set ret=0 instead of ret={error} when verifying the fixed-key [[NPDM]] ACID signature fails. This also skips verifying the [[NCA_Format|NCA Header]] signature using the ACID key. Note that if verifying the fixed-key ACID signature is successful, and verifying the ACID-key NCA header signature fails, it will throw an error and abort.

= fsp-srv =
This is "nn::fssrv::sf::IFileSystemProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [1.0.0] [[#OpenFileSystem]]
|-
| 1 || [[#SetCurrentProcess]]
|-
| 2 || OpenDataFileSystemByCurrentProcess
|-
| 7 || [2.0.0+] [[#OpenFileSystemWithPatch]]
|-
| 8 || [2.0.0+] [[#OpenFileSystemWithId]]
|-
| 9 || [3.0.0+] OpenDataFileSystemByApplicationId
|-
| 11 || [[#OpenBisFileSystem]]
|-
| 12 || [[#OpenBisStorage]]
|-
| 13 || InvalidateBisCache
|-
| 17 || OpenHostFileSystem
|-
| 18 || OpenSdCardFileSystem
|-
| 19 || [2.0.0+] FormatSdCardFileSystem
|-
| 21 || [[#DeleteSaveDataFileSystem]]
|-
| 22 || [[#CreateSaveDataFileSystem]]
|-
| 23 || [[#CreateSaveDataFileSystemBySystemSaveDataId]]
|-
| 24 || RegisterSaveDataFileSystemAtomicDeletion
|-
| 25 || [2.0.0+] DeleteSaveDataFileSystemBySaveDataSpaceId
|-
| 26 || [2.0.0+] FormatSdCardDryRun
|-
| 27 || [2.0.0+] IsExFatSupported
|-
| 28 || [4.0.0+] DeleteSaveDataFileSystemBySaveDataAttribute
|-
| 30 || [[#OpenGameCardStorage]]
|-
| 31 || [[#OpenGameCardFileSystem]]
|-
| 32 || [3.0.0+] ExtendSaveDataFileSystem
|-
| 33 || [5.0.0+] DeleteCacheStorage
|-
| 34 || [5.0.0+] GetCacheStorageSize
|-
| 35 || [6.0.0+] CreateSaveDataFileSystemByHashSalt (Unofficial name, takes a total of 0xB0-bytes of input, no output)
|-
| 51 || [[#OpenSaveDataFileSystem]]
|-
| 52 || [[#OpenSaveDataFileSystemBySystemSaveDataId]]
|-
| 53 || [2.0.0+] OpenReadOnlySaveDataFileSystem
|-
| 57 || [3.0.0+] [[#ReadSaveDataFileSystemExtraDataBySaveDataSpaceId]]
|-
| 58 || [[#ReadSaveDataFileSystemExtraData]]
|-
| 59 || [2.0.0+] WriteSaveDataFileSystemExtraData
|-
| 60 || [[#OpenSaveDataInfoReader]]
|-
| 61 || [[#OpenSaveDataInfoReaderBySaveDataSpaceId]]
|-
| 62 || [5.0.0+] OpenCacheStorageList
|-
| 64 || [5.0.0+] OpenSaveDataInternalStorageFileSystem
|-
| 65 || [5.0.0+] UpdateSaveDataMacForDebug
|-
| 66 || [5.0.0+] WriteSaveDataFileSystemExtraData2
|-
| 67 || [6.0.0+] FindSaveDataWithFilter (Takes a total of 0x50-bytes of input, returns 8-bytes of output, and a type-0x6 output buffer)
|-
| 68 || [6.0.0+] OpenSaveDataIterator (Takes a total of 0x50-bytes of input, returns an #ISaveDataInfoReader)
|-
| 69 || [8.0.0+] ReadSaveDataFileSystemExtraDataBySaveDataAttribute
|-
| 70 || [8.0.0+] WriteSaveDataFileSystemExtraDataBySaveDataAttribute
|-
| 80 || OpenSaveDataMetaFile
|-
| 81 || [4.0.0+] OpenSaveDataTransferManager (No input, returns an [[#ISaveDataTransferManager]])
|-
| 82 || [5.0.0+] OpenSaveDataTransferManagerVersion2 (No input, returns an [[#ISaveDataTransferManagerWithDivision]])
|-
| 83 || [6.0.0+] OpenSaveDataTransferProhibiterForCloudBackUp (Takes an input u64, returns an [[#ISaveDataTransferProhibiter]])
|-
| 84 || [6.0.0+] ListApplicationAccessibleSaveDataOwnerId (Takes a total of 0x10-bytes of input, returns 4-bytes of output, and a type-0x6 output buffer)
|-
| 100 || OpenImageDirectoryFileSystem
|-
| 110 || [[#OpenContentStorageFileSystem]]
|-
| 120 || [6.0.0+] OpenCloudBackupWorkStorageFileSystem (Takes 4-bytes of input, returns an [[#IFileSystem]])
|-
| 130 || [7.0.0+] OpenCustomStorageFileSystem (Takes 4-bytes of input, returns an [[#IFileSystem]])
|-
| 200 || OpenDataStorageByCurrentProcess
|-
| 201 || [3.0.0+] OpenDataStorageByProgramId
|-
| 202 || [[#OpenDataStorageByDataId]]
|-
| 203 || OpenPatchDataStorageByCurrentProcess
|-
| 204 || [7.0.0+] OpenDataFileSystemByProgramIndex (Takes an input u8, returns an [[#IFileSystem]])
|-
| 205 || [7.0.0+] OpenDataStorageByProgramIndex (Takes an input u8, returns an [[#IStorage]])
|-
| 400 || [[#OpenDeviceOperator]]
|-
| 500 || [[#OpenSdCardDetectionEventNotifier]]
|-
| 501 || [[#OpenGameCardDetectionEventNotifier]]
|-
| 510 || [5.0.0+] OpenSystemDataUpdateEventNotifier
|-
| 511 || [5.0.0+] NotifySystemDataUpdateEvent
|-
| 520 || [6.0.0+] SimulateGameCardDetectionEvent (Takes a total of 0xC-bytes of input, no output)
|-
| 600 || [1.0.0-3.0.2] SetCurrentPosixTime
|-
| 601 || QuerySaveDataTotalSize
|-
| 602 || [[#VerifySaveDataFileSystem]]
|-
| 603 || CorruptSaveDataFileSystem
|-
| 604 || CreatePaddingFile
|-
| 605 || DeleteAllPaddingFiles
|-
| 606 || [2.0.0+] GetRightsId
|-
| 607 || [2.0.0+] RegisterExternalKey
|-
| 608 || [2.0.0+] UnregisterAllExternalKey
|-
| 609 || [2.0.0+] GetRightsIdByPath
|-
| 610 || [3.0.0+] GetRightsIdAndKeyGenerationByPath
|-
| 611 || [4.0.0+] SetCurrentPosixTimeWithTimeDifference
|-
| 612 || [4.0.0+] GetFreeSpaceSizeForSaveData
|-
| 613 || [4.0.0+] VerifySaveDataFileSystemBySaveDataSpaceId
|-
| 614 || [4.0.0+] CorruptSaveDataFileSystemBySaveDataSpaceId
|-
| 615 || [5.0.0+] QuerySaveDataInternalStorageTotalSize
|-
| 616 || [6.0.0+] [[#GetSaveDataCommitId]]
|-
| 617 || [7.0.0+] UnregisterExternalKey
|-
| 620 || [2.0.0+] [[#SetSdCardEncryptionSeed]]
|-
| 630 || [4.0.0+] SetSdCardAccessibility
|-
| 631 || [4.0.0+] IsSdCardAccessible
|-
| 640 || [4.0.0-7.0.1] IsSignedSystemPartitionOnSdCardValid
|-
| 700 || [5.0.0+] [[#OpenAccessFailureResolver]]
|-
| 701 || [5.0.0+] GetAccessFailureDetectionEvent
|-
| 702 || [5.0.0+] IsAccessFailureDetected
|-
| 710 || [5.0.0+] ResolveAccessFailure
|-
| 720 || [5.0.0+] AbandonAccessFailure
|-
| 800 || [2.0.0+] GetAndClearFileSystemProxyErrorInfo
|-
| 810 || [7.0.0+] RegisterProgramIndexMapInfo
|-
| 1000 || SetBisRootForHost
|-
| 1001 || [[#SetSaveDataSize]]
|-
| 1002 || [[#SetSaveDataRootPath]]
|-
| 1003 || DisableAutoSaveDataCreation
|-
| 1004 || [[#SetGlobalAccessLogMode]]
|-
| 1005 || [[#GetGlobalAccessLogMode]]
|-
| 1006 || [[#OutputAccessLogToSdCard]]
|-
| 1007 || [4.0.0+] RegisterUpdatePartition
|-
| 1008 || [4.0.0+] OpenRegisteredUpdatePartition
|-
| 1009 || [4.0.0+] GetAndClearMemoryReportInfo
|-
| 1010 || [5.1.0-6.2.0] SetDataStorageRedirectTarget
|-
| 1011 || [7.0.0+] GetAccessLogVersionInfo (Unofficial name, no input, returns two 32-bit values "version" and "program_index")
|-
| 1100 || [4.0.0+] OverrideSaveDataTransferTokenSignVerificationKey
|-
| 1110 || [6.0.0+] CorruptSaveDataFileSystemBySaveDataSpaceId2
|-
| 1200 || [6.0.0+] OpenMultiCommitManager (No input, returns an output #IMultiCommitManager)
|}

== Permissions ==
Every time permissions are checked, the process registration [[#fsp-pr]] is loaded using the session processID. The permission data is populated with data from the [[NPDM]].

If the processID is <= 6 (which happens only for built-in sysmodules), it will use a hardcoded registration data. The default mask in this case is 0x8000000000000000.

Note that the functions check whether or not at least one bit is set in the mask. This means that, you don't need to set 0xFFFFFFFFFFFFFFFF to get all permissions: it suffices to set 0x8000000000000000.

If the code were to request an invalid input type, panic. But this never happens.

=== RwPermissions ===
{| class="wikitable" border="1"
|-
! Type(s) || Mask || Name || Value || Used by
|-
| 0x0 || 0x8000000000000801 || CanMountLogo || 1 || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]
|-
| 0x1 || 0x8000000000000801 || CanMountContentMeta || 1 || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]
|-
| 0x2 || 0x8000000000000801 || CanMountContentControl || 1 || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]
|-
| 0x3 || 0x8000000000000801 || CanMountContentManual || 1 || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]
|-
| 0x4 || 0x8000000000000801 || CanMountContentData || 1 || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]
|-
| 0x5 || 0x8000000000000801 || CanMountApplicationPackage || 1 || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]
|-
| 0x6 || 0x8000000000000000 || CanMountSaveDataStorage || 3 ||
|-
| 0x7 || 0x8000000000000800 || CanMountContentStorage || 3 || [[#OpenContentStorageFileSystem]]
|-
| 0x8 || 0x8000000000001000 || CanMountImageAndVideoStorage || 3 || [[#OpenImageDirectoryFileSystem]]
|-
| 0x9 || 0x8000000200000000<br/>([1.0.0-5.1.0] 0x8000000000000084) || CanMountCloudBackupWorkStorage || 3 || OpenCloudBackupWorkStorageFileSystem
|-
| 0xA || 0x8000000000000000<br/>([7.0.0-7.0.1] 0x4000000000000000)<br/>([6.0.0-6.2.0] 0x8000000000000084)<br/>([1.0.0-5.1.0] 0x8000000000000080) || CanMountCustomStorage || 3 || OpenCustomStorageFileSystem
|-
| 0xB || 0x8000000000000084<br/>([6.0.0-6.2.0] 0x8000000000000080)<br/>([1.0.0-5.1.0] 0x8000000000008080) || CanMountBisCalibrationFile || 3 || [[#OpenBisFileSystem]]
|-
| 0xC || 0x8000000000000080<br/>([1.0.0-6.2.0] 0x8000000000008080) || CanMountBisSafeMode || 3 || [[#OpenBisFileSystem]]
|-
| 0xD || 0x8000000000008080<br/>([1.0.0-5.1.0] 0x8000000000000080) || CanMountBisUser || 3 || [[#OpenBisFileSystem]]
|-
| 0xE || 0x8000000000008080<br/>([3.0.0-6.2.0] 0x8000000000000080)<br/>([1.0.0-2.3.0] 0xC000000000200000) || CanMountBisSystem || 3 || [[#OpenBisFileSystem]]
|-
| 0xF || 0x8000000000000080<br/>([3.0.0-5.1.0] 0xC000000000200000)<br/>([1.0.0-2.3.0] 0x8000000000000010) || CanMountBisSystemProperEncryption || 3 || [[#OpenBisFileSystem]]
|-
| 0x10 || 0x8000000000000080<br/>([6.0.0-6.2.0] 0xC000000000200000<br/>([3.0.0-5.1.0] 0x8000000000000010)<br/>([1.0.0-2.3.0] 0x8000000000040020) || CanMountBisSystemProperPartition || 3 || [[#OpenBisFileSystem]]
|-
| 0x11 || 0xC000000000200000<br/>([6.0.0-6.2.0] 0x8000000000000010)<br/>([3.0.0-5.1.0] 0x8000000000040020)<br/>([1.0.0-2.3.0] 0x8000000000000028) || CanMountSdCard || 3 || [[#OpenSdCardFileSystem]]
|-
| 0x12 || 0x8000000000000010<br/>([6.0.0-6.2.0] 0x8000000000040020)<br/>([3.0.0-5.1.0] 0x8000000000000028)<br/>([1.0.0-2.3.0] 0x8000000000000020) || CanMountGameCard || 3 || [[#OpenGameCardFileSystem]]
|-
| 0x13 || 0x8000000000040020<br/>([6.0.0-6.2.0] 0x8000000000000028)<br/>([1.0.0-5.1.0] 0x8000000000000020) || CanMountDeviceSaveData || 3 || [[#OpenSaveDataFileSystem]]
|-
| 0x14 || 0x8000000000000028<br/>([3.0.0-6.2.0] 0x8000000000000020)<br/>([1.0.0-2.3.0] 0x8000000000010082) || CanMountSystemSaveData || 3 || [[#OpenSaveDataFileSystemBySystemSaveDataId]]
|-
| 0x15 || 0x8000000000000020<br/>([3.0.0-5.1.0] 0x8000000000010082)<br/>([1.0.0-2.3.0] 0x8000000000010080) || CanMountOthersSaveData || 3 || [[#OpenSaveDataFileSystem]]
|-
| 0x16 || 0x8000000000000020<br/>([6.0.0-6.2.0] 0x8000000000010082)<br/>([1.0.0-5.1.0] 0x8000000000010080) || CanMountOthersSystemSaveData || 3 || [[#OpenSaveDataFileSystemBySystemSaveDataId]]
|-
| 0x17 || 0x8000000000010082<br/>([6.0.0-6.2.0] 0x8000000000010080)<br/>([3.0.0-5.1.0] 0x8000000000000080)<br/>([1.0.0-2.3.0] 0x8000000000010080) || CanOpenBisPartitionBootPartition1Root || 3 || [[#OpenBisStorage]]
|-
| 0x18 || 0x8000000000010080<br/>([6.0.0-6.2.0] 0x8000000000000080)<br/>([1.0.0-5.1.0] 0x8000000000010080) || CanOpenBisPartitionBootPartition2Root || 3 || [[#OpenBisStorage]]
|-
| 0x19 || 0x8000000000000080<br/>([6.0.0-6.2.0] 0x8000000000010080) || CanOpenBisPartitionUserDataRoot || 3 || [[#OpenBisStorage]]
|-
| 0x1A || 0x8000000000010080 || CanOpenBisPartitionBootConfigAndPackage2Part1 || 3 || [[#OpenBisStorage]]
|-
| 0x1B || 0x8000000000010080 || CanOpenBisPartitionBootConfigAndPackage2Part2 || 3 || [[#OpenBisStorage]]
|-
| 0x1C || 0x8000000000010080 || CanOpenBisPartitionBootConfigAndPackage2Part3 || 3 || [[#OpenBisStorage]]
|-
| 0x1D || 0x8000000000010080<br/>([1.0.0-2.3.0] 0x8000000000000084) || CanOpenBisPartitionBootConfigAndPackage2Part4 || 3 || [[#OpenBisStorage]]
|-
| 0x1E || 0x8000000000010080<br/>([1.0.0-5.1.0] 0x8000000000000084) || CanOpenBisPartitionBootConfigAndPackage2Part5 || 3 || [[#OpenBisStorage]]
|-
| 0x1F || 0x8000000000010080<br/>([6.0.0-6.2.0] 0x8000000000000084)<br/>([1.0.0-2.3.0] 0x8000000000000080) || CanOpenBisPartitionBootConfigAndPackage2Part6 || 3 || [[#OpenBisStorage]]
|-
| 0x20 || 0x8000000000000084<br/>([1.0.0-5.1.0] 0x8000000000000080) || CanOpenBisPartitionCalibrationBinary || 3 || [[#OpenBisStorage]]
|-
| 0x21 || 0x8000000000000084<br/>([6.0.0-6.2.0] 0x8000000000000080) || CanOpenBisPartitionCalibrationFile || 3 || [[#OpenBisStorage]]
|-
| 0x22 || 0x8000000000000080 || CanOpenBisPartitionSafeMode || 3 || [[#OpenBisStorage]]
|-
| 0x23 || 0x8000000000000080<br/>([1.0.0-2.3.0] 0xC000000000200000) || CanOpenBisPartitionUser || 3 || [[#OpenBisStorage]]
|-
| 0x24 || 0x8000000000000080<br/>([1.0.0-2.3.0] 0x8000000000000100) || CanOpenBisPartitionSystem || 3 || [[#OpenBisStorage]]
|-
| 0x25 || 0x8000000000000080<br/>([3.0.0-5.1.0] 0xC000000000200000)<br/>([1.0.0-2.3.0] 0x8000000000100008) || CanOpenBisPartitionSystemProperEncryption || 3 || [[#OpenBisStorage]]
|-
| 0x26 || 0x8000000000000080<br/>([6.0.0-6.2.0] 0xC000000000200000)<br/>([3.0.0-5.1.0] 0x8000000000000100)<br/>([1.0.0-2.3.0] 0xC000000000400000) || CanOpenBisPartitionSystemProperPartition || 3 || [[#OpenBisStorage]]
|-
| [3.0.0+] 0x27 || 0xC000000000200000<br/>([6.0.0-6.2.0] 0x8000000000000100)<br/>([1.0.0-5.1.0] 0x8000000000100008) || CanOpenSdCardStorage || ||
|-
| [3.0.0+] 0x28 || 0x8000000000000100<br/>([6.0.0-6.2.0] 0x8000000000100008)<br/>([1.0.0-5.1.0] 0xC000000000400000) || CanOpenGameCardStorage || 3 || [[#OpenGameCardStorage]], [[#EraseGameCard]] (bit1), [[#WriteToGameCard]] (bit1), [[#GetGameCardErrorInfo]] (bit1), [[#EraseAndWriteParamDirectly]] (bit1), [[#ReadParamDirectly]] (bit1), [[#ForceEraseGameCard]] (bit1)
|-
| [4.0.0+] 0x29 || 0x8000000000100008<br/>([6.0.0-6.2.0] 0xC000000000400000)<br/>([1.0.0-5.1.0] 0x8000000000010000) || CanMountSystemDataPrivate || 1 || [[#OpenFileSystem]], [[#OpenDataStorageByDataId]]
|-
| [5.0.0+] 0x2A || 0xC000000000400000<br/>([6.0.0-6.2.0] 0x8000000000010000)<br/>([1.0.0-5.1.0] 0x8000000000000000) || CanMountHost || 3 || [[#OpenHostFileSystem]]
|-
| [6.0.0+] 0x2B || 0x8000000000010000<br/>([1.0.0-6.2.0]0x8000000000000000) || CanMountRegisteredUpdatePartition || 1 || [[#OpenRegisteredUpdatePartition]]
|-
| [7.0.0+] 0x2C || 0x8000000000000000 || CanOpenSaveDataInternalStorage || 3 || [[#OpenSaveDataInternalStorageFileSystem]]
|-
| [7.0.0+] 0x2D || 0x0000000000000000 || CanNotMountCustomStorage || 3 || OpenCustomStorageFileSystem
|}

=== BoolPermissions ===
{| class="wikitable" border="1"
|-
! Type(s) || Mask || Name || Used by
|-
| 0x0 || 0x8000000000000080 || CanInvalidateBisCache || [[#InvalidateBisCache]]
|-
| 0x1 || 0x8000000000000080 || CanEraseMmc || [[#EraseMmc]]
|-
| 0x2 || 0x8000000000000010 || CanGetGameCardDeviceCertificate || [[#GetGameCardDeviceCertificate]]
|-
| 0x3 || 0x8000000000000010 || CanGetGameCardIdSet || [[#GetGameCardIdSet]]
|-
| 0x4 || 0x8000000000000200 || CanFinalizeGameCardDriver || [[#FinalizeGameCardDriver]]
|-
| 0x5 || 0x8000000000000200 || CanGetGameCardAsicInfo || [[#GetGameCardAsicInfo]]
|-
| 0x6 || 0x8000000000002020 || CanCreateSaveData || [[#CreateSaveDataFileSystem]]
|-
| 0x7 || 0x8000000000000060 || CanDeleteSaveData || [[#DeleteSaveDataFileSystem]], [[#RegisterSaveDataFileSystemAtomicDeletion]]
|-
| 0x8 || 0x8000000000000028 || CanCreateSystemSaveData || [[#CreateSaveDataFileSystemBySystemSaveDataId]]
|-
| 0x9 || 0x8000000000000020 || CanCreateOthersSystemSaveData || [[#CreateSaveDataFileSystemBySystemSaveDataId]]
|-
| 0xA || 0x8000000000004028 || CanDeleteSystemSaveData || [[#DeleteSaveDataFileSystem]], [[#RegisterSaveDataFileSystemAtomicDeletion]]
|-
| 0xB || 0x8000000000000060 || CanOpenSaveDataInfoReader || [[#OpenSaveDataInfoReaderBySaveDataSpaceId]], [[#OpenSaveDataInfoReader]]
|-
| 0xC || 0x8000000000004020 || CanOpenSaveDataInfoReaderForSystem || [[#OpenSaveDataInfoReaderBySaveDataSpaceId]], [[#OpenSaveDataInfoReader]]
|-
| 0xD || 0x8000000000000040<br/>([1.0.0-5.1.0] 0x8000000000020000) || CanOpenSaveDataIterator || OpenSaveDataIterator
|-
| 0xE || 0x8000000000020000<br/>([1.0.0-5.1.0] 0x8000000000000400) || CanOpenSaveDataMetaFile || [[#OpenSaveDataMetaFile]]
|-
| 0xF || 0x8000000000000400<br/>([1.0.0-5.1.0] 0x8000000000004060) || CanSetCurrentPosixTime || [[#SetCurrentPosixTime]], [[#SetCurrentPosixTimeWithTimeDifference]]
|-
| 0x10 || 0x8000000000004060<br/>([1.0.0-5.1.0] 0x8000000000080000) || CanReadSaveDataFileSystemExtraData || [[#ReadSaveDataFileSystemExtraData]]
|-
| 0x11 || 0x8000000000080000 || CanSetGlobalAccessLogMode || [[#SetGlobalAccessMode]]
|-
| 0x12 || 0x8000000000080000<br/>([1.0.0-5.1.0] Invalid) || CanSetSpeedEmulationMode || [[#SetSpeedEmulationMode]]
|-
| 0x13 || Invalid<br/>([1.0.0-5.1.0] 0xC000000000800000) || ||
|-
| 0x14 || 0xC000000000800000<br/>([1.0.0-5.1.0] 0xC000000001000000) || CanFillBis || [[#CreatePaddingFile]], [[#DeleteAllPaddingFiles]]
|-
| 0x15 || 0xC000000001000000<br/>([5.0.0-5.1.0] 0x8000000001000060)<br/>([1.0.0-4.1.0] 0xC000000002000000) || CanCorruptSaveData || [[#CorruptSaveDataFileSystem]], [[#CorruptSaveDataFileSystemBySaveDataSpaceId]]
|-
| [2.0.0+] 0x16 || 0x8000000001000060<br/>([5.0.0-5.1.0] 0x8000000000000060)<br/>([1.0.0-4.1.0] 0x8000000004000000) || CanCorruptSystemSaveData || [[#CorruptSaveDataFileSystem]], [[#CorruptSaveDataFileSystemBySaveDataSpaceId]]
|-
| [2.0.0+] 0x17 || 0x8000000000000060<br/>([5.0.0-5.1.0] 0xC000000002000000)<br/>([1.0.0-4.1.0] 0x8000000008000000) || CanVerifySaveData || [[#VerifySaveDataFileSystem]], [[#VerifySaveDataFileSystemBySaveDataSpaceId]]
|-
| [2.0.0+] 0x18 || 0xC000000002000000<br/>([5.0.0-5.1.0] 0x8000000004000000)<br/>([1.0.0-4.1.0] 0x8000000010000000) || CanDebugSaveData || [[#CreateSaveDataFileSystem]], [[#OpenSaveDataFileSystem]], [[#SetSaveDataRootPath]]
|-
| [2.0.0+] 0x19 || 0x8000000004000000<br/>([5.0.0-5.1.0] 0x8000000008000000)<br/>([1.0.0-4.1.0] 0x8000000000000800) || CanFormatSdCard || [[#FormatSdCardFileSystem]]
|-
| [2.0.0+] 0x1A || 0x8000000008000000<br/>([5.0.0-5.1.0] 0x8000000010000000)<br/>([1.0.0-4.1.0] 0x8000000000004020) || CanGetRightsId || [[#GetRightsId]], [[#GetRightsIdAndKeyGenerationByPath]], [[#GetRightsIdByPath]]
|-
| [3.0.0+] 0x1B || 0x8000000010000000<br/>([5.0.0-5.1.0] 0x8000000000000800)<br/>([1.0.0-4.1.0] 0x8000000000002020) || CanRegisterExternalKey || [[#RegisterExternalKey]], [[#UnregisterAllExternalKey]]
|-
| [3.0.0+] 0x1C || 0x8000000000000800<br/>([5.0.0-5.1.0] 0x8000000000004020)<br/>([1.0.0-4.1.0] 0x8000000000000028) || CanSetEncryptionSeed || [[#SetSdCardEncryptionSeed]]
|-
| [4.0.0+] 0x1D || 0x8000000000000020<br/>([5.0.0-5.1.0] 0x8000000000000000)<br/>([1.0.0-4.1.0] 0x8000000020000000) || SaveDataExtraData_Write0 || [[#WriteSaveDataFileSystemExtraData]], [[#WriteSaveDataFileSystemExtraData2]]
|-
| [4.0.0+] 0x1E || 0x8000000000004020<br/>([5.0.0-5.1.0] 0x8000000000002020)<br/>([1.0.0-4.1.0] 0x8000000040000000) || CanWriteSaveDataFileSystemExtraDataFlags || [[#WriteSaveDataFileSystemExtraData]], [[#WriteSaveDataFileSystemExtraData2]]
|-
| [4.0.0+] 0x1F || 0x8000000000000020<br/>([5.0.0-5.1.0] 0x8000000000000028)<br/>([1.0.0-4.1.0] 0x8000000000000000) || SaveDataExtraData_Write1 || [[#WriteSaveDataFileSystemExtraData]], [[#WriteSaveDataFileSystemExtraData2]]
|-
| [4.0.0+] 0x20 || 0x8000000000000000<br/>([5.0.0-5.1.0] 0x8000000020000000)<br/>([1.0.0-4.1.0] 0x8000000000000000) || CanWriteSaveDataFileSystemExtraDataAll || [[#WriteSaveDataFileSystemExtraData]], [[#WriteSaveDataFileSystemExtraData2]]
|-
| [5.0.0+] 0x21 || 0x8000000000002020<br/>([1.0.0-5.1.0] 0x8000000040000000) || CanExtendSaveData || [[#ExtendSaveDataFileSystem]]
|-
| [5.0.0+] 0x22 || 0x8000000000000028<br/>([1.0.0-5.1.0] 0x0000000080000002) || CanExtendSystemSaveData || [[#ExtendSaveDataFileSystem]]
|-
| [5.0.0+] 0x23 || 0x8000000020000000<br/>([1.0.0-5.1.0] 0x8000000000000000) || CanRegisterUpdatePartition || [[#RegisterUpdatePartition]]
|-
| [5.0.0+] 0x24 || 0x8000000040000000<br/>([1.0.0-5.1.0] 0x8000000000000000) || CanOpenSaveDataTransferManager || [[#OpenSaveDataTransferManager]]
|-
| [5.0.0+] 0x25 || 0x8000000200000000<br/>([1.0.0-5.1.0] 0x8000000080200000) || CanOpenSaveDataTransferManagerVersion2 || [[#OpenSaveDataTransferManagerVersion2]]
|-
| [5.0.0+] 0x26 || 0x8000000200002000<br/>([1.0.0-5.1.0] 0x8000000080000110) || CanOpenSaveDataTransferProhibiterForCloudBackUp || [[#OpenSaveDataTransferProhibiterForCloudBackUp]]
|-
| [5.0.0+] 0x27 || 0x8000000240002000 <br/>([6.0.0-7.0.1] 0x8000000200002000)<br/>([1.0.0-5.1.0] 0x8000000000100008) || CanListApplicationAccessibleSaveDataOwnerId || ListApplicationAccessibleSaveDataOwnerId
|-
| [5.0.0+] 0x28 || 0x8000000000000000<br/>([1.0.0-5.1.0] 0x8000000080010000) || CanControlMmcPatrol || [[#SuspendMmcPatrol]], [[#ResumeMmcPatrol]]
|-
| [5.0.0+] 0x29 || 0x8000000000000000<br/>([1.0.0-5.1.0] 0x0000000080000001) || CanOverrideSaveDataTransferTokenSignVerificationKey || [[#OverrideSaveDataTransferTokenSignVerificationKey]]
|-
| [5.0.0+] 0x2A || 0x8000000080200000<br/>([1.0.0-5.1.0] 0x0000000080000001) || CanOpenSdCardDetectionEventNotifier || [[#OpenSdCardDetectionEventNotifier]]
|-
| [5.0.0+] 0x2B || 0x8000000080000110<br/>([1.0.0-5.1.0] 0x0000000080000001) || CanOpenGameCardDetectionEventNotifier || [[#OpenGameCardDetectionEventNotifier]]
|-
| [5.0.0+] 0x2C || 0x8000000000100008<br/>([1.0.0-5.1.0] 0x0000000080000001) || CanOpenSystemDataUpdateEventNotifier || [[#OpenSystemDataUpdateEventNotifier]]
|-
| [5.0.0+] 0x2D || 0x8000000000010000<br/>([1.0.0-5.1.0] 0x0000000080000001) || CanNotifySystemDataUpdateEvent || [[#NotifySystemDataUpdateEvent]]
|-
| [5.0.0+] 0x2E || 0x8000000100000000<br/>([1.0.0-5.1.0] 0x8000000040000000) || CanOpenAccessFailureDetectionEventNotifier || [[#OpenAccessFailureResolver]]
|-
| [5.0.0+] 0x2F || 0x8000000100000000<br/>([1.0.0-5.1.0] 0x8000000080200000) || CanGetAccessFailureDetectionEvent || [[#GetAccessFailureDetectionEvent]]
|-
| [5.1.0+] 0x30 || 0x8000000100000000<br/>([1.0.0-5.1.0] 0x8000000080080000) || CanIsAccessFailureDetected || [[#IsAccessFailureDetected]]
|-
| [6.0.0+] 0x31 || 0x8000000100000000 || CanResolveAccessFailure || [[#ResolveAccessFailure]]
|-
| [6.0.0+] 0x32 || 0x8000000100000000 || CanAbandonAccessFailure || [[#AbandonAccessFailure]]
|-
| [6.0.0+] 0x33 || 0x8000000040000000 || CanQuerySaveDataInternalStorageTotalSize || [[#QuerySaveDataInternalStorageTotalSize]]
|-
| [6.0.0+] 0x34 || 0x8000000200000020 || CanGetSaveDataCommitId || [[#GetSaveDataCommitId]]
|-
| [6.0.0+] 0x35 || 0x8000000000200000 || CanSetSdCardAccessibility || [[#SetSdCardAccessibility]]
|-
| [6.0.0+] 0x36 || 0x4000000000000000 || CanSimulateGameCardDetectionEvent || SimulateGameCardDetectionEvent, SetSimulationEvent, ClearSimulationEvent
|-
| [6.0.0+] 0x37 || 0x8000000000000000<br/>([6.0.0-6.2.0] 0x8000000000080000) || CanSetDataStorageRedirectTarget || SetDataStorageRedirectTarget
|-
| [6.0.0+] 0x38 || 0x8000000400000000<br/>([6.0.0-6.2.0] 0x8000000000000000) || || [[#CreateSaveDataFileSystem]], CreateSaveDataFileSystemByHashSalt
|-
| [8.0.0+] 0x39 || 0x8000000000000010 || CanChallengeCardExistence || ChallengeCardExistence
|}

== OpenFileSystem ==
Takes a type-0x19 input buffer (ContentPath) and a [[#FileSystemType]] as parameters. Returns an [[#IFileSystem]].

[2.0.0+] This function was removed.

== SetCurrentProcess ==
Takes a pid-descriptor.

== OpenFileSystemWithPatch ==
Takes an input [[#FileSystemType]] and an u64 title-id. Returns an [[#IFileSystem]].

Web-applet loads the [[#FileSystemType]] (which must be '''ContentManual''') from u32_table[inparam].

Note: web-applet strings refer to both this cmd and [[#OpenFileSystemWithId]] as "MountContent", but official nn_sf_sync symbols use "OpenXX" names.

== OpenFileSystemWithId ==
Takes a type-0x19 input buffer, an [[#FileSystemType]] and an u64 title-id. Returns an [[#IFileSystem]].

The [[#IFileSystem]] must be '''ContentMeta''' if the NCA type is 0 (control).

The input buffer is the output string path from [[NS_Services#GetApplicationContentPath|GetApplicationContentPath]].

May return errors when attempting to access NCA-paths for an update-title with a gamecard, when the gamecard isn't inserted. May return error 0x7D402 in some cases with update-titles. Non-val2 in32 values with NCA-type1 are unusable, even for normal titles.

The official "MountApplicationPackage" func uses this with in64=0 and [[#FileSystemType]] '''ApplicationPackage'''.

After the [[#FileSystemType]] specific permissions are checked, it then gets the func retval for permissions-type 0x25 and func0.

When [[#FileSystemType]] is '''ContentMeta''', it uses in64=0xffffffffffffffff internally, otherwise it checks if in64 is set to 0xffffffffffffffff then throws an error if so. When the in64 used internally is not 0xffffffffffffffff, it's compared with the NCA titleID, then an error is thrown on mismatch.

== OpenBisFileSystem ==
Takes a type-0x19 input buffer string and a u32 [[Flash_Filesystem|Bis partitionID]]. Official user-process code sets instr[0] = 0 normally. Returns an [[#IFileSystem]].

Only partitionIDs for FAT partitions are usable with this, otherwise error 0x2EE202 is returned. Seems to be about the same as [[#OpenBisStorage]] except this mounts the partition filesystem instead of allowing direct access to the partition sectors.

== OpenBisStorage ==
Takes a u32 partition ID, returns 0x2EE202 for partitions which do not exist, 0x320002 for partitions which cannot be opened and a valid [[#IStorage]] handle otherwise.

== InvalidateBisCache ==
Seems to invalidate the Bis cache for MBR/GPT after overwriting that data via the OpenBisStorage IStorage. Used by [[SystemInitializer]].

== DeleteSaveDataFileSystem ==
Takes an input u64.

== CreateSaveDataFileSystem ==
Takes a 0x40-byte Save-struct entry, a 0x40-byte SaveCreate-struct entry, and a 0x10-byte input struct.

Only the first 0x5-bytes in the 0x10-byte struct are initialized: all-zero when automatically creating savedata during savecommon mount by official user-processes. In the dedicated save-creation code in official user-processes: +0 u32 = 0x40060, +4 u8 = 1.

Creates regular savedata.

== CreateSaveDataFileSystemBySystemSaveDataId ==
Takes a 0x40-byte Save-struct entry and a 0x40-byte SaveCreate-struct entry.

Creates savedata in the SYSTEM [[Flash_Filesystem|NAND]] partition.

== OpenGameCardStorage ==
Takes two input u32s (gamecard handle, partition ID), and returns an [[#IStorage]] for the [[Gamecard_Format|partition]].

== OpenGameCardFileSystem ==
Takes two input u32s, with the second u32 located at +4 in rawdata after the first u32. Returns an [[#IFileSystem]].

Mounts a [[Gamecard_Partition|gamecard partition]].

== OpenSaveDataFileSystem ==
Takes an input u8 [[#SaveDataSpaceId]] and a 0x40-byte Save-struct entry. Official user-process code is only known to use value 1 for the u8.

Returns an [[#IFileSystem]].

Permissions aren't checked until the specified save is successfully found.

Only one process (specifically only one [[#IFileSystem]] session) can mount a given savedata at any given time (this includes SystemSaveData).

== OpenSaveDataFileSystemBySystemSaveDataId ==
Takes an input u8 [[#SaveDataSpaceId]] and a 0x40-byte Save-struct entry. Web-applet only uses value0 for the input u8.

Returns an [[#IFileSystem]].

Mounts savedata in the SYSTEM [[Flash_Filesystem|NAND]] partition.

== ReadSaveDataFileSystemExtraDataBySaveDataSpaceId ==
Takes an input u8 [[#SaveDataSpaceId]], an input u64 saveID, and a type-0x6 output buffer containing the [[#SaveDataFileSystemExtraData]].

== ReadSaveDataFileSystemExtraData ==
Takes an input u64 saveID and a type-0x6 output buffer containing the [[#SaveDataFileSystemExtraData]].

== OpenSaveDataInfoReader ==
No input, returns an output [[#ISaveDataInfoReader]].

== OpenSaveDataInfoReaderBySaveDataSpaceId ==
Takes an input u8 [[#SaveDataSpaceId]], returns an output [[#ISaveDataInfoReader]].

== OpenContentStorageFileSystem ==
Takes a [[#ContentStorageId]]. Invalid values return 0x2EE202.

Returns an [[#IFileSystem]] with NCA files. The read data from these files is identical to the data read by [[NCM_services#ReadContentIdFile]].

== OpenDataStorageByDataId ==
Takes a [[#StorageId]] and a TitleID.

Returns a [[IPC_Marshalling#Domain_message|domain object ID]] implementing the [[#IStorage]] interface for data archives.

== OpenDeviceOperator ==
This command returns a session to a port implementing the [[#IDeviceOperator]] interface.

== OpenSdCardDetectionEventNotifier ==
This command returns a session to a port implementing the [[#IEventNotifier]] interface.

== OpenGameCardDetectionEventNotifier ==
This command returns a session to a port implementing the [[#IEventNotifier]] interface.

== VerifySaveDataFileSystem ==
Takes an unknown input u64 and a type-0x6 output buffer.

The input u64 high-byte must be non-zero, otherwise an [[Error_codes|error]] is returned(0xE02).

== GetSaveDataCommitId ==
Takes an input u8 and u64, returns an output u64.

== SetSdCardEncryptionSeed ==
Takes in the 0x10 byte SD card encryption seed, and loads it into FS-module state.

[[NS_Services|NS]]-module reads the 0x10 bytes from SdCard:/Nintendo/Contents/private, and compares them to the first 0x10 bytes of the ns_appman:/private (in [[Flash_Filesystem#System_Savegames|system savedata]] 0x8000000000000043). If they match, NS calls this command using bytes 0x10-0x20 from ns_appman:/private. The rest of this file (0x1F0 bytes total) is (usually/always?) all-zero (however in some cases the byte at offset 0x20 is value 0x1).

== OpenAccessFailureResolver ==
Takes 8-bytes of input and returns an [[#IEventNotifier]].

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

== SetSaveDataSize ==
Takes two input u64s "size" and "journal_size", and writes them to fsp-srv object member variables.

These variables are normally initialized with 32 MiB (0x2000000) and 16 MiB (0x1000000), respectively.

These variables don't seem to be actually used anywhere else (?)

== SetSaveDataRootPath ==
Takes an input path, and does snprintf(<fsp-srv object>->m_save_data_root_path, FS_MAX_PATH-1, "/%s", input_path);

This path is normally all-zero. When this path is non-zero, the internal OpenSaveDataFileSystem function will create a DirectorySaveDataFileSystem if the target save is a user-save + a directory exists, instead of the normal savedata filesystem object.

== SetGlobalAccessLogMode ==
Takes an input u32.

== SetGlobalAccessLogMode ==
Takes an input u32.

== GetGlobalAccessLogMode ==
Returns an output u32.

GlobalAccessLogMode is normally 0.

== OutputAccessLogToSdCard ==
Takes a type-0x5 input buffer.

The input buffer is the string to output to the log. User-processes normally include a newline at the end.

User-processes only use this when the value previously loaded from [[#GetGlobalAccessLogMode]] has bit1 set.

When bit1 in GlobalAccessLogMode is clear, FS-module will just return 0 for OutputAccessLogToSdCard. However even with that set the log doesn't show up SD, unknown why.

The input buffer is written to the "$FsAccessLog:/FsAccessLog.txt" file, where "$FsAccessLog" is the SD-card mount-name. It's written to the current end of the file(appended).

= IStorage =
This is "nn::fssrv::sf::IStorage".

This is the interface for a raw device, usually a block device.

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments
|-
| 0 || Read || Takes a type-0x46 buffer, an offset and length
|-
| 1 || Write || Takes a type-0x45 buffer, an offset and length
|-
| 2 || Flush || None
|-
| 3 || SetSize || Takes a size
|-
| 4 || GetSize || None
|-
| 5 || [4.0.0+] OperateRange ||
|}

= IFileSystem =
This is "nn::fssrv::sf::IFileSystem".

There are two main implementations of this interface:

* '''RomFS''': Filesystem implementation statically linked in the binary. Uses an [[#IStorage]] interface as underlying raw device.
* '''IPC proxy''': Used for all non-RomFS filesystems. In this case, actual filesystem implementation is in the FS process.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CreateFile
|-
| 1 || DeleteFile
|-
| 2 || CreateDirectory
|-
| 3 || DeleteDirectory
|-
| 4 || DeleteDirectoryRecursively
|-
| 5 || RenameFile
|-
| 6 || RenameDirectory
|-
| 7 || [[#GetEntryType]]
|-
| 8 || [[#OpenFile]]
|-
| 9 || [[#OpenDirectory]]
|-
| 10 || [[#Commit]]
|-
| 11 || [[#GetFreeSpaceSize]]
|-
| 12 || [[#GetTotalSpaceSize]]
|-
| 13 || [3.0.0+] [[#CleanDirectoryRecursively]]
|-
| 14 || [3.0.0+] [[#GetFileTimeStampRaw]]
|-
| 15 || [4.0.0+] QueryEntry
|}

== GetEntryType ==
Takes a type-0x9 input buffer for the path and returns [[#DirectoryEntryType]] as an output u32.

== OpenFile ==
Takes a type-0x19 input buffer for the path, and an u32 '''mode'''. '''mode''' controls how the file is opened, based on which bits are set:

* When bit 0 is set, the file is Readable: you can use the Read operation.
* When bit 1 is set, the file is Writable: you can use the Write operation.
* When bit 2 is set, the file is Appendable: unless this bit is set, you will not be able to write beyond the end of a file (such writes will result in an error 0x307202)

== OpenDirectory ==
Takes a type-0x9 input buffer for the path and an u64 '''filter_flags'''. '''filter_flags''' controls what type of entries are read by the [[#IDirectory]]: bitmask 0x1 = directories, bitmask 0x2 = files.

== Commit ==
Like [https://3dbrew.org/wiki/FS:ControlArchive 3DS], this has to be used after writing to savedata for the changes to take affect.

== GetFreeSpaceSize ==
Takes a type-0x9 input buffer for the path and returns an output byte-size u64 for the total free space with this FS.

== GetTotalSpaceSize ==
Takes a type-0x9 input buffer for the path and returns an output byte-size u64 for the total space available with this FS(free+used).

== CleanDirectoryRecursively ==
Takes a type-0x9 input buffer for the path and clears the contents of the directory specified in the path.

== GetFileTimeStampRaw ==
Takes a type-0x19 input buffer for the path and returns a 0x20-byte struct. This contains 3 u64s and an u8.

= IDirectory =
This is "nn::fssrv::sf::IDirectory".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#Read]]
|-
| 1 || [[#GetEntryCount]]
|}

== Read ==
Takes a type-0x6 output buffer. Returns an output u64(?) for the total number of read entries, this is 0 when no more entries are available.

The output buffer contains the read array of [[#DirectoryEntry]]. This doesn't include entries for "." and "..".

== GetEntryCount ==
Returns an u64 for the total number of readable entries.

= DirectoryEntry =
This is "nn::fs::DirectoryEntry".

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x301 || Path
|-
| 0x301 || 0x1 || File attributes (bit 0 = is directory; bit 1 = archive bit)
|-
| 0x302 || 0x2 || Padding?
|-
| 0x304 || 0x1 || [[#DirectoryEntryType]]
|-
| 0x305 || 0x3 || Padding?
|-
| 0x308 || 0x8 || Filesize, 0 for directories.
|}

= DirectoryEntryType =
This is "nn::fs::DirectoryEntryType".

An s8 value indicating a directory entry type. The current values are:

{| class="wikitable" border="1"
|-
! Value || Description
|-
| 0 || Directory
|-
| 1 || File
|}

= IFile =
This is "nn::fssrv::sf::IFile".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Read
|-
| 1 || Write
|-
| 2 || Flush
|-
| 3 || SetSize
|-
| 4 || GetSize
|-
| 5 || [4.0.0+] OperateRange
|}

= ISaveDataInfoReader =
This is "nn::fssrv::sf::ISaveDataInfoReader".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#ReadSaveDataInfo]]
|}

== ReadSaveDataInfo ==
Takes a type-0x6 output buffer. Returns an output u64 for total output entries. This buffer contains an array of [[#SaveDataInfo]].

This is used to get [[#SaveDataInfo]] for all savedata on the system (or all savedata for the current [[#SaveDataSpaceId]]). When used multiple times, it will resume reading where it left off, until no more entries are available (in that case the out u64 is value 0).

= IDeviceOperator =
This is "nn::fssrv::sf::IDeviceOperator".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || IsSdCardInserted
|-
| 1 || GetSdCardSpeedMode
|-
| 2 || [2.0.0+] GetSdCardCid
|-
| 3 || [2.0.0+] GetSdCardUserAreaSize
|-
| 4 || [2.0.0+] GetSdCardProtectedAreaSize
|-
| 5 || [2.0.0+] GetAndClearSdCardErrorInfo
|-
| 100 || GetMmcCid
|-
| 101 || GetMmcSpeedMode
|-
| 110 || EraseMmc
|-
| 111 || GetMmcPartitionSize
|-
| 112 || [2.0.0+] GetMmcPatrolCount
|-
| 113 || [2.0.0+] GetAndClearMmcErrorInfo
|-
| 114 || [2.0.0+] GetMmcExtendedCsd
|-
| 115 || [4.0.0+] SuspendMmcPatrol
|-
| 116 || [4.0.0+] ResumeMmcPatrol
|-
| 200 || IsGameCardInserted
|-
| 201 || EraseGameCard
|-
| 202 || GetGameCardHandle
|-
| 203 || [[#GetGameCardUpdatePartitionInfo]]
|-
| 204 || FinalizeGameCardDriver
|-
| 205 || GetGameCardAttribute
|-
| 206 || GetGameCardDeviceCertificate
|-
| 207 || GetGameCardAsicInfo
|-
| 208 || GetGameCardIdSet
|-
| 209 || WriteToGameCard
|-
| 210 || SetVerifyWriteEnalbleFlag
|-
| 211 || GetGameCardImageHash
|-
| 212 || [2.0.0+] GetGameCardDeviceIdForProdCard
|-
| 213 || [2.0.0+] EraseAndWriteParamDirectly
|-
| 214 || [2.0.0+] ReadParamDirectly
|-
| 215 || [2.0.0+] ForceEraseGameCard
|-
| 216 || [2.0.0+] GetGameCardErrorInfo
|-
| 217 || [2.1.0+] GetGameCardErrorReportInfo
|-
| 218 || [3.0.0+] GetGameCardDeviceId
|-
| 219 || [8.0.0+] ChallengeCardExistence
|-
| 300 || SetSpeedEmulationMode
|-
| 301 || GetSpeedEmulationMode
|-
| 400 || [5.0.0+] SuspendSdmmcControl
|-
| 401 || [5.0.0+] ResumeSdmmcControl
|-
| 402 || [6.0.0+] GetSdmmcConnectionStatus (Takes a total of 4-bytes of input, returns a total of 8-bytes of output)
|-
| 500 || [6.0.0+] SetSimulationEvent (Takes a total of 0x14-bytes of input, no output)
|-
| 501 || [6.0.0+] ClearSimulationEvent (Takes a total of 4-bytes of input, no output)
|}

== GetGameCardUpdatePartitionInfo ==
Returns a titleID and the title-version for it.

* Output u32 with ARMS-gamecard: title-version v131162. This is the title-version for [[2.1.0]], which is the sysupdate included with this gamecard. Launch-day gamecards return title-version v450.
* Output u64 with ARMS-gamecard: titleID 0100000000000816.

[[NS_Services|NS]] appears to only use this with [[Content_Manager_services#GetTitleIdInfo]] and [[Content_Manager_services#GetUpdateTitleList]] with storageid=nandsys, for checking whether a sysupdate is required.

= IEventNotifier =
This is "nn::fssrv::sf::IEventNotifier".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetEventHandle
|}

= ISaveDataTransferManager =
This is "nn::fssrv::sf::ISaveDataTransferManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetChallenge]]
|-
| 16 || [[#SetToken]]
|-
| 32 || [[#OpenSaveDataExporter]]
|-
| 64 || [[#OpenSaveDataImporter]]
|}

This was added with [[4.0.0]].

== GetChallenge ==
No input/output, takes a type-0x6 output buffer.

== SetToken ==
No input/output, takes a type-0x5 input buffer.

== OpenSaveDataExporter ==
Takes an input u8 [[#SaveDataSpaceId]] and u64, returns an [[#ISaveDataExporter]].

== OpenSaveDataImporter ==
Takes an input u8 [[#SaveDataSpaceId]] and a 0x10-byte userID, and a type-0x5 input buffer. Returns an output u64 and an [[#ISaveDataImporter]].

= ISaveDataExporter =
This is "nn::fssrv::sf::ISaveDataExporter".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#Initialize]]
|-
| 1 || [[#GetRestSize]]
|-
| 16 || [[#Pull]]
|-
| 17 || [[#PullInitialData]]
|}

This was added with [[4.0.0]].

== Initialize ==
No input/output, takes a type-0x1A [[#SaveDataInfo]] output buffer.

The actual name for this is the SaveDataExporter constructor. This is used automatically after [[#OpenSaveDataExporter]] by official sw.

== GetRestSize ==
No input, returns an output u64.

== Pull ==
Takes a type-0x6 output buffer, returns an output u64.

== PullInitialData ==
No input/output, takes a type-0x6 output buffer.

= ISaveDataImporter =
This is "nn::fssrv::sf::ISaveDataImporter".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#Initialize]]
|-
| 1 || [[#GetRestSize]]
|-
| 16 || [[#Push]]
|-
| 17 || [[#Finalize]]
|}

This was added with [[4.0.0]].

== Initialize ==
No input/output, takes a type-0x1A [[#SaveDataInfo]] output buffer.

The actual name for this is the SaveDataImporter constructor. This is used automatically after [[#OpenSaveDataImporter]] by official sw.

== GetRestSize ==
No input, returns an output u64.

== Push ==
No input/output, takes a type-0x5 input buffer.

== Finalize ==
No input/output.

= ISaveDataTransferManagerWithDivision =
This is "nn::fssrv::sf::ISaveDataTransferManagerWithDivision".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetChallenge]]
|-
| 16 || [[#SetKeySeedPackage]]
|-
| 32 || [[#OpenSaveDataFullExporter]]
|-
| 33 || [[#OpenSaveDataDiffExporter]]
|-
| 34 || [6.0.0+] [[#OpenSaveDataExporterByContext]]
|-
| 64 || [[#OpenSaveDataFullImporter]]
|-
| 65 || [[#OpenSaveDataDiffImporter]]
|-
| 66 || [6.0.0+] [[#OpenSaveDataDuplicateDiffImporter]]
|-
| 67 || [6.0.0+] [[#OpenSaveDataImporter]]
|-
| 68 || [6.0.0+] [[#OpenSaveDataImporterByContext]]
|-
| 69 || [6.0.0+] [[#CancelSuspendingImport]]
|}

This was added with [[5.0.0]].

== GetChallenge ==
No input/output, takes a type-0x6 output buffer containing the '''Challenge'''.

== SetKeySeedPackage ==
No input/output, takes a type-0x5 input buffer containing the '''KeySeedPackage'''.

== OpenSaveDataFullExporter ==
Takes an input u8 [[#SaveDataSpaceId]] and u64. Returns an [[#ISaveDataDivisionExporter]].

== OpenSaveDataDiffExporter ==
Takes an input u8 [[#SaveDataSpaceId]], an u64, and a type-0x5 input buffer [[#InitialDataVersion2]]. Returns an [[#ISaveDataDivisionExporter]].

== OpenSaveDataExporterByContext ==
No input/output, takes a type-0x5 input buffer, returns an [[#ISaveDataDivisionExporter]].

== OpenSaveDataFullImporter ==
Takes an input u8 [[#SaveDataSpaceId]], a 0x10-byte userID, and a type-0x5 input buffer [[#InitialDataVersion2]]. Returns an [[#ISaveDataDivisionImporter]].

== OpenSaveDataDiffImporter ==
Takes an input u8 [[#SaveDataSpaceId]], an u64, and a type-0x5 input buffer [[#InitialDataVersion2]], returns an [[#ISaveDataDivisionImporter]].

== OpenSaveDataDuplicateDiffImporter ==
Takes an input u8 and an u64, and a type-0x5 input buffer, returns an [[#ISaveDataDivisionImporter]].

== OpenSaveDataImporter ==
Takes an input u8, an u8(bool), a 0x10-byte struct, and a type-0x5 input buffer, returns an [[#ISaveDataDivisionImporter]].

== OpenSaveDataImporterByContext ==
No input/output, takes a type-0x5 input buffer, returns an [[#ISaveDataDivisionImporter]].

== CancelSuspendingImport ==
Takes an input u64 and a 0x10-byte struct, no output.

= ISaveDataDivisionExporter =
This is "nn::fssrv::sf::ISaveDataDivisionExporter".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetDivisionCount (Takes an input u32, no output)
|-
| 1 || [6.0.0+] GetSaveDataInfo (No input/output, takes a type-0x6 output buffer)
|-
| 16 || OpenSaveDataDiffChunkIterator (No input, returns an [[#ISaveDataChunkIterator]])
|-
| 48 || OpenSaveDataChunkExporter (Takes an input u32, returns an [[#ISaveDataChunkExporter]])
|-
| 64 || [6.0.0+] FinalizeFullExport (No input, returns two 0x10-byte output structs)
|-
| 65 || [6.0.0+] FinalizeDiffExport (No input, returns an output 0x10-byte struct)
|-
| 66 || [6.0.0+] CancelExport (No input/output)
|-
| 67 || [6.0.0+] SuspendExport (No input/output, takes a type-0x6 output buffer)
|-
| 70 || [6.0.0+] GetKeySeed (No input, returns an output 0x10-byte struct)
|-
| 71 || [6.0.0+] GetInitialDataMac (No input, returns an output 0x10-byte struct)
|-
| 72 || [6.0.0+] FinalizeExport (No input/output)
|-
| 80 || [6.0.0+] GetImportInitialDataAad (No input, returns an output 0x20-byte struct)
|-
| 81 || [6.0.0+] SetExportInitialDataAad (Takes an input 0x20-byte struct, no output)
|-
| 96 || [6.0.0+] GetReportInfo (No input, returns an output 0x20-byte struct)
|}

This was added with [[5.0.0]].

= ISaveDataDivisionImporter =
This is "nn::fssrv::sf::ISaveDataDivisionImporter".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [6.0.0+] GetSaveDataInfo (No input/output, takes a type-0x6 output buffer)
|-
| 16 || OpenSaveDataDiffChunkIterator (No input, returns an [[#ISaveDataChunkIterator]])
|-
| 32 || InitializeImport (No input, returns an output u64)
|-
| 33 || FinalizeImport (No input/output)
|-
| 34 || [6.0.0+] CancelImport (No input/output)
|-
| 35 || [6.0.0+] GetImportContext (No input/output, takes a type-0x6 output buffer)
|-
| 36 || [6.0.0+] SuspendImport (No input/output)
|-
| 48 || OpenSaveDataChunkImporter (Takes an input u32, returns an [[#ISaveDataChunkImporter]])
|-
| 64 || [6.0.0+] GetImportInitialDataAad (No input, returns an output 0x20-byte struct)
|-
| 80 || [6.0.0+] GetReportInfo (No input, returns an output 0x20-byte struct)
|}

This was added with [[5.0.0]].

= ISaveDataChunkIterator =
This is "nn::fssrv::sf::ISaveDataChunkIterator".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Next (No input/output)
|-
| 1 || IsEnd (No input, returns an output u8)
|-
| 16 || GetId (No input, returns an output u32)
|}

This was added with [[5.0.0]].

= ISaveDataChunkExporter =
This is "nn::fssrv::sf::ISaveDataChunkExporter".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Pull (Takes an input u64 and a type-0x6 output buffer, returns an output u64)
|-
| 16 || [6.0.0+] GetRestRawDataSize (No input, returns an output u64)
|-
|}

This was added with [[5.0.0]].

= ISaveDataChunkImporter =
This is "nn::fssrv::sf::ISaveDataChunkImporter".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Push (Takes an input u64 and a type-0x5 input buffer, no output)
|}

This was added with [[5.0.0]].

= ISaveDataTransferProhibiter =
This was added with [[6.0.0]].

This doesn't seem to handle any commands (?).

= IMultiCommitManager =
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || ? (Takes an input [[#IFilesystem]], no output)
|-
| 2 || ? (No input/output)
|}

This was added with [[6.0.0]].

= FileSystemType =
{| class="wikitable" border="1"
|-
! Value || Name
|-
| 0 || Code
|-
| 1 || Data
|-
| 2 || Logo
|-
| 3 || ContentControl
|-
| 4 || ContentManual
|-
| 5 || ContentMeta
|-
| 6 || ContentData
|-
| 7 || ApplicationPackage
|}

= StorageId =
{| class="wikitable" border="1"
|-
! Value || Name
|-
| 0 || None
|-
| 1 || Host
|-
| 2 || GameCard
|-
| 3 || NandSystem
|-
| 4 || NandUser
|-
| 5 || SdCard
|}

= ContentStorageId =
This is "nn::fs::ContentStorageId".

{| class="wikitable" border="1"
|-
! Value || Name
|-
| 0 || System
|-
| 1 || User
|-
| 2 || SdCard
|}

= SaveDataSpaceId =
This is "nn::fs::SaveDataSpaceId".

{| class="wikitable" border="1"
|-
! Value || Name
|-
| 0 || System
|-
| 1 || User
|-
| 2 || SdSystem
|-
| 100 || [3.0.0+] ProperSystem
|}

Determines the storage where the savedata is stored.

= SaveDataType =
{| class="wikitable" border="1"
|-
! Value || Name
|-
| 0 || SystemSaveData
|-
| 1 || SaveData
|-
| 2 || BcatDeliveryCacheStorage
|-
| 3 || DeviceSaveData
|-
| 4 || [3.0.0+] TemporaryStorage
|-
| 5 || [3.0.0+] CacheStorage
|}

= ImageDirectoryId =
This is "nn::fs::ImageDirectoryId".

{| class="wikitable" border="1"
|-
! Value || Name
|-
| 0 || Nand
|-
| 1 || SdCard
|}

= CloudBackupWorkStorageId =
{| class="wikitable" border="1"
|-
! Value || Name
|-
| 0 || Nand
|-
| 1 || SdCard
|}

= ContentPath =
These are the 0x300 paths to NCA files for the various filesystems FS can access, beginning with @. They're passed via X descriptors, and returned via various [[Location Resolver services|ncm/lr]] commands.

{| class="wikitable" border="1"
|-
! Path || Notes
|-
| @SystemContent ||
|-
| @UserContent ||
|-
| @SdCardContent ||
|-
| @CalibFile ||
|-
| @Safe ||
|-
| @User ||
|-
| @System ||
|-
| @Sdcard ||
|-
| @Host ||
|-
| @GcApp || Gamecard App partition (Partition 2)
|-
| @GcS00000001 || Gamecard Contents.
|-
| @upp || Gamecard update partition (Partition 0)
|-
| [4.0.0+] @RegUpdate || Registered update partition
|}

= Save Struct =
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| 0 for SystemSaveData. SaveData: 0 can be used for accessing the savedata associated with the current FS session titleID, otherwise when set this is the titleID associated with the savedata to access.
|-
| 0x8
| 0x10
| userID for user-specific savedata(saveuser) when set, otherwise when zero this indicates the common savedata(savecommon). This is loaded from [[Account_services]].
|-
| 0x18
| 0x8
| u64 [[Flash_Filesystem|saveID]]. 0 for SaveData.
|-
| 0x20
| 0x1
| [[#SaveDataType]]
|-
| 0x21
| 0x1
| Save data 'rank' or 'precedence'. 0 if this save data is considered the primary save data. 1 if it's considered the secondary save data.
|-
| 0x22
| 0x2
| Save data index
|-
| 0x24
| 0x4
| Padding
|-
| 0x28
| 0x8
| 0 for SystemSaveData/SaveData.
|-
| 0x30
| 0x8
| 0 for SystemSaveData/SaveData.
|-
| 0x38
| 0x8
| 0 for SystemSaveData/SaveData.
|}

Total size is 0x40-bytes.

For DeviceSaveData, this struct is all-zero except for the [[#SaveDataType]] field.

= SaveCreate Struct =
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Save data size.
|-
| 0x8
| 0x8
| Save data journal size.
|-
| 0x10
| 0x8
| Save data block size. 0x4000 for SystemSaveData/SaveData/DeviceSaveData/BcatSaveData.
|-
| 0x18
| 0x8
| Save data owner id. Official user-processes only uses 0 here for SystemSaveData/SaveData. For the dedicated save-creation code with SaveData/DeviceSaveData, this value comes from an input param with official user-processes. For BcatSaveData, this is the hard-coded [[Title_list|titleID]] of the bcat-sysmodule.
|-
| 0x20
| 0x4
| Save data flags. Written using an input param for official user-processes. Hard-coded 0 for BcatSaveData.
|-
| 0x24
| 0x1
| [[#SaveDataSpaceId]]. Official user-processes only uses 0 here for SystemSaveData, 1 for SaveData/DeviceSaveData/BcatSaveData.
|-
| 0x25
| 0x1
| Unknown. 0 for SystemSaveData/SaveData.
|-
| 0x26
| 0x1A
| Not initialized for SystemSaveData/SaveData.
|}

Total size is 0x40-bytes.

= DeviceSaveData =
This is accessed using the same commands for SaveData with the same input u8, the only difference compared to SaveData is the Save-struct.

= BcatSaveData =
This is accessed using the same commands for SaveData with the same input u8. The Save-struct is the same as DeviceSaveData, except that the titleID field is set to <input titleID>. See above regarding SaveCreate-struct.

The 0x10-byte struct passed to [[#CreateSaveDataFileSystem]] has the first 0x5-bytes set to all-zero.

= SaveDataInfo =
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Unknown saveID
|-
| 0x8
| 0x1
| [[#SaveDataSpaceId]]
|-
| 0x9
| 0x1
| [[#SaveDataType]]
|-
| 0xA
| 0x6
| Padding?
|-
| 0x10
| 0x10
| userID
|-
| 0x20
| 0x8
| saveID, 0 for regular SaveData.
|-
| 0x28
| 0x8
| Application titleID, for regular SaveData.
|-
| 0x30
| 0x8
| Raw saveimage size
|-
| 0x38
| 0x2
| Save data index
|-
| 0x3A
| 0x1
| Save data 'rank' or 'precedence'. 0 if this save data is considered the primary save data. 1 if it's considered the secondary save data.
|-
| 0x3B
| 0x25
| Unknown. Usually zeros?
|}

This is a 0x60-byte struct.

= SaveDataFileSystemExtraData =
This is a 0x200-byte struct. Appears to match [[Savegames#Extra_data]].

= InitialDataVersion2 =
This is a 0x8210-byte struct used by [[#ISaveDataTransferManagerWithDivision]].

[[Category:Services]]

NCM services

2019-05-07T03:06:57Z

Adubbz: 8.0.0

NCM contains services for internal file path and content management.

= Location Resolver services =
== lr ==
This is "nn::lr::ILocationResolverManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || OpenLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 1 || OpenRegisteredLocationResolver || None ||
|-
| 2 || RefreshLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 3 || [2.0.0+] OpenAddOnContentLocationResolver || None ||
|}

The only sysmodules which use this service are [[Filesystem_services|FS]], [[Loader_services|Loader]], and [[NS_Services|NS]]. [[boot2]] has access but doesn't use it.

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

{| class="wikitable" border="1"
|-
! 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+] [[#RedirectProgramPath2]]
|-
| 11 || [5.0.0+] [[#Refresh2]]
|-
| 12 || [5.0.0+] [[#DeleteProgramPath]]
|-
| 13 || [5.0.0+] [[#DeleteApplicationControlPath]]
|-
| 14 || [5.0.0+] [[#DeleteApplicationHtmlDocumentPath]]
|-
| 15 || [5.0.0+] [[#DeleteApplicationLegalInformationPath]]
|-
| 16 || [7.0.0+] [[#ResolveProgramPathForDebug]]
|-
| 17 || [7.0.0+] [[#RedirectProgramPathForDebug]]
|-
| 18 || [7.0.0+] [[#RedirectProgramPath2ForDebug]]
|-
| 19 || [7.0.0+] [[#DeleteProgramPathForDebug]]
|}

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

The Get* commands load the [[Filesystem_services|ContentPath]] from linked-lists' [[#Location_List_Entry|entries]] in memory using the input TitleID. When the command fails to find an entry for the specified TitleID, 0x408 is returned for GetProgramNcaPath 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 u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

==== RedirectProgramPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 0.

==== ResolveApplicationControlPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== ResolveApplicationHtmlDocumentPath====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

==== ResolveDataPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== RedirectApplicationControlPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== RedirectApplicationHtmlDocumentPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ResolveApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

==== RedirectApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== Refresh ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 0.

==== RedirectProgramPath2 ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== Refresh2 ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 1.

==== DeleteProgramPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== DeleteApplicationControlPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== DeleteApplicationHtmlDocumentPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== DeleteApplicationLegalInformationPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== ResolveProgramPathForDebug ====
Same as [[#ResolveProgramPath|ResolveProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectProgramPathForDebug ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== RedirectProgramPath2ForDebug ====
Same as [[#RedirectProgramPath2|RedirectProgramPath2]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

==== DeleteProgramPathForDebug ====
Same as [[#DeleteProgramPath|DeleteProgramPath]], but uses a redirection shim on top of the real program path.

[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.

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

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 title ID at a time.

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveProgramPath || u64 TitleID + C descriptor || Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
|-
| 1 || RegisterProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 0 fallback TID and path to the provided arguments.
|-
| 2 || UnregisterProgramPath || u64 TitleID || If the Type 0 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 3 || RedirectProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|-
| 4 || [2.0.0+] ResolveHtmlDocumentPath || u64 TitleID + C descriptor ||
|-
| 5 || [2.0.0+] RegisterHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 1 fallback TID and path to the provided arguments.
|-
| 6 || [2.0.0+] UnregisterHtmlDocumentPath || u64 TitleID || If the Type 1 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 7 || [2.0.0+] RedirectHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|-
| 8 || [7.0.0+] Refresh || No input/output. ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveAddOnContentPath || u64 TitleID + C descriptor ||
|-
| 1 || RegisterAddOnContentStorage || [[Filesystem_services#StorageId|StorageID]] + u64 TitleID ||
|-
| 2 || UnregisterAllAddOnContentPath || None || Clears all registered titles here.
|}

=== Location List Entry ===
Total size is 0x320 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8|| Pointer to previous entry
|-
| 0x8 || 0x8|| Pointer to next entry
|-
| 0x10 || 0x8|| TitleID
|-
| 0x18 || 0x300 || [[Filesystem_services|ContentPath]]
|-
| 0x318 || 0x4 || Flag
|-
| 0x31C || 0x4 || Padding
|}

= Content Manager services =
== ncm ==
This is "nn::ncm::IContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || CreateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 1 || CreateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 2 || VerifyContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 3 || VerifyContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 4 || OpenContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 5 || OpenContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 6 || [1.0.0] CloseContentStorageForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentStorage->CloseAndFlushStorage().
|-
| 7 || [1.0.0] CloseContentMetaDatabaseForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentMetaDatabase->CloseMetaDatabase().
|-
| 8 || CleanupContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and deletes the associated savedata.
|-
| 9 || [2.0.0+] ActivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentStorage for the StorageID to be gotten with GetIContentStorage. Note: Name is not official.
|-
| 10 || [2.0.0+] InactivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentStorage. Note: Name is not official.
|-
| 11 || [2.0.0+] ActivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentMetaDatabase for the StorageID to be gotten with GetIContentMetaDatabase. Note: Name is not official.
|-
| 12 || [2.0.0+] InactivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentMetaDatabase. Note: Name is not official.
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GeneratePlaceHolderId]] || Returns a random UUID for the Content Storage.
|-
| 1 || CreatePlaceHolder || Takes two [[#NcaID]]s, and a u64 filesize.
|-
| 2 || DeletePlaceHolder || Takes a [[#NcaID]].
|-
| 3 || HasPlaceHolder || Takes a [[#NcaID]].
|-
| 4 || WritePlaceHolder || Takes a [[#NcaID]], a u64-offset, and type 5 buffer. Writes the buffer to the file for the NcaID's placeholder path at the specified offset.
|-
| 5 || Register || Takes two [[#NcaID]]s, moves the Placeholder NCA content to the registered NCA path.
|-
| 6 || Delete || Takes a [[#NcaID]].
|-
| 7 || Has || Takes a [[#NcaID]].
|-
| 8 || GetPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 9 || GetPlaceHolderPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 10 || CleanupAllPlaceHolder || Deletes and re-creates the Placeholder directory.
|-
| 11 || ListPlaceHolder || This is like [[#GetNumberOfRegisteredEntries]], but for the Placeholder directory.
|-
| 12 || [[#GetContentCount]] ||
|-
| 13 || [[#ListContentId]] ||
|-
| 14 || [[#GetSizeFromContentId]] ||
|-
| 15 || DisableForcibly || Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.
|-
| 16 || [2.0.0+] RevertToPlaceHolder || Takes three 0x10-sized [[#NcaID]]s. Creates the registered directory NCA path, and renames the placeholder path to the registered NCA path.
|-
| 17 || [2.0.0+] SetPlaceHolderSize || Takes a [[#NcaID]], and a u64 size
|-
| 18 || [2.0.0+] [[#ReadContentIdFile]] ||
|-
| 19 || [2.0.0+] [[#GetRightsIdFromPlaceHolderId]] ||
|-
| 20 || [2.0.0+] [[#GetRightsIdFromContentId]] ||
|-
| 21 || [2.0.0+] WriteContentForDebug || Takes a [[#NcaID]], a u64 offset, and a type 5 buffer. On debug units, writes the buffer to the NCA's registered path. On retail units, this just aborts.
|-
| 22 || [2.0.0+] GetFreeSpaceSize || Gets free space for the storage.
|-
| 23 || [2.0.0+] GetTotalSpaceSize || Gets total space for the storage.
|-
| 24 || [3.0.0+] FlushPlaceHolder || Flushes resources for the storage without closing it.
|-
| 25 || [4.0.0+] GetSizeFromPlaceHolderId ||
|-
| 26 || [4.0.0+] RepairInvalidFileAttribute ||
|-
| 27 || [8.0.0+] GetRightsIdFromPlaceHolderIdWithCache ||
|}

==== GeneratePlaceHolderId ====
Generates a random [[#NcaID]] for use as a placeholder.

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

==== GetContentCount ====
Writes the total number of entries which can be read by GetEntries, to cmdreply <SFCO_offset>+0x10.

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

Each entry is a [[#NcaID]].

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 [[#NcaID]] as input.

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

==== ReadContentIdFile ====
Takes an output buffer, a [[#NcaID]] as input, and a u64 file offset.

Reads plaintext NCA file contents from the Registered path for the NcaID.

==== GetRightsIdFromPlaceHolderId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s placeholder path.

==== GetRightsIdFromContentId ====
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.

[3.0.0+] Returns an additional 8-bytes of output.

Gets the Rights ID for the [[#NcaID]]'s registered path

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

Note the official name for Meta Record is "ContentMetaKey".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Set || Takes a [[CNMT#Meta_records|Meta Record]], a type-5 [[CNMT#Content_records|Content Records]] buffer and a u64 size.
|-
| 1 || Get || Takes a [[CNMT#Meta_records|Meta Record]], a type-6 buffer to write [[CNMT#Content_records|Content Records]] 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 meta records. Set takes this same data as input.
|-
| 2 || Remove || Takes a [[CNMT#Meta_records|Meta Record]], and removes the associated record.
|-
| 3 || GetContentIdByType || Takes a [[CNMT#Meta_records|Meta Record]] and a u8 [[#Title_Types|Title Type]]. Returns a [[#NcaID]].
|-
| 4 || ListContentInfo || Takes a type-6 buffer to write [[CNMT#Content_records|Content Record]] entries to, a [[CNMT#Meta_records|Meta Record]], and a u32 index into the Content Record entries to start copying from. Returns a u32 entries_read.
|-
| 5 || List || Takes a type-6 buffer to write [[CNMT#Meta_records|Meta Record]]s to, a u32 [[#Title_Types|Title Type]], a u64 TID, a u64 TID_LOW, and u64 TID_HIGH. Writes into the buffer all Meta Records with low <= record->title_id <= high, and record->type == type. Returns u32 numEntriesTotal, numEntriesWritten. 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.
|-
| 6 || GetLatestContentMetaKey || Takes a u64 title id, and returns the [[CNMT#Meta_records|Meta Record]] with the highest version field for that title id.
|-
| 7 || [[#ListApplication]] ||
|-
| 8 || Has || Takes a [[CNMT#Meta_records|Meta Record]] and returns whether that record is present in the database.
|-
| 9 || HasAll || Takes a type-5 buffer containing [[CNMT#Meta_records|Meta Records]] (code assumes there are size/sizeof(meta_record) records in the buffer), and returns whether all of those records are present in the database.
|-
| 10 || GetSize || Takes a [[CNMT#Meta_records|Meta Record]], and returns the size of the associated [[CNMT#Content_records|Content Records]].
|-
| 11 || GetRequiredSystemVersion || Takes a [[CNMT#Meta_records|Meta Record]], and returns u32 from ContentRecords + 16 (only if the Meta record has type Application or Patch).
|-
| 12 || GetPatchId || Takes a [[CNMT#Meta_records|Meta Record]], and returns the update title id for that record.
|-
| 13 || DisableForcibly || Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.
|-
| 14 || [[#LookupOrphanContent]] || Takes a type-6 byte buffer, and a type-5 buffer of [[#NcaID]]s.
|-
| 15 || Commit || Flushes the in-memory database to savedata.
|-
| 16 || HasContent || Takes a [[CNMT#Meta_records|Meta Record]] and an [[#NcaID]]. Returns whether the content records for that meta record contain the NcaID.
|-
| 17 || ListContentMetaInfo || Takes a type-6 [[CNMT#Meta_records|Meta Record]] output buffer, a u32 offset into that buffer, and an input [[CNMT#Meta_records|Meta Record]].
|-
| 18 || GetAttributes || Takes a [[CNMT#Meta_records|Meta Record]], and returns u8 from ContentRecords + 6.
|-
| 19 || [2.0.0+] GetRequiredApplicationVersion || Does the same thing as GetEntryUnknownRecordSize, but for AddOnContents.
|-
| 20 || [5.0.0+] GetContentIdByTypeAndIdOffset ||
|}

==== ListApplication ====
Each 24-byte entry (officially "ApplicationContentMetaKey") is as follows:
[[CNMT#Meta_records|meta_record]] meta_record;
u64 base_title_id;

This function takes in a type 6 buffer to write entries to, and a u8 "filter" [[#Title_Types|type]]. 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 u32 num_entries_total, and a u32 num_entries_written.

==== ReadEntryMetaRecords ====
Takes a type-6 [[CNMT#Meta_records|Meta Record]] output buffer, a u32 offset into that buffer, and an input [[CNMT#Meta_records|Meta Record]] entry. Returns a u32 for total_read_entries.

Reads the meta records stored in the entry's content records into the output buffer.

This is used, for example, with System Update title 0100000000000816, which contains Meta Records for all other systitles in its Content Records.

==== LookupOrphanContent ====
Takes a type-6 byte buffer, and a type-5 buffer containing [[#NcaID]]s.

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 [[#NcaID]] in the input buffer, it checks if that NcaID 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, NcaID in NcaIDs:
if is_present_in_database(NcaID):
out_buf[i] = 0

=== NcaID ===
This is a 0x10-byte entry. This is originally from the hex portion of "<hex>.nca" directory-names from this storage FS(like [[SD_Filesystem|SD]]). This is also referred to as "ContentId" in the official SDK.

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

=== Enums ===
==== Title Types ====

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x01
| SystemProgram ([[Title_list#System_Modules|System Modules]] or [[Title_list#System_Applets|System Applets]])
|-
| 0x02
| SystemData ([[Title_list#System_Data_Archives|System Data Archives]])
|-
| 0x03
| SystemUpdate
|-
| 0x04
| BootImagePackage ([[Title_list|Firmware package A or C]])
|-
| 0x05
| BootImagePackageSafe ([[Title_list|Firmware package B or D]])
|-
| 0x80
| Application
|-
| 0x81
| Patch
|-
| 0x82
| AddOnContent
|-
| 0x83
| Delta
|}

== ncm:v ==
This service doesn't normally exist on retail.

[[Category:Services]]

RO services

2019-04-22T07:17:00Z

Adubbz: Fixed capitalisation

Prior to 3.0.0, ro was included as part of [[Loader services]]. Despite the separation, the service name ldr:ro is retained to maintain compatibility with old games.

= ldr:ro, ro:1 =
[1.0.0-2.3.0] This is "nn::ldr::detail::IRoInterface"

[3.0.0+] This is "nn::ro::detail::IRoInterface".

[7.0.0+] ro:1 was added, and also creates nn::ro::detail::IRoInterface objects.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#LoadNro]]
|-
| 1 || UnloadNro
|-
| 2 || [[#LoadNrr]]
|-
| 3 || UnloadNrr
|-
| 4 || [[#Initialize]]
|-
| 10 || [7.0.0+] [[#LoadNrrEx]]
|}

== LoadNro ==
{| class="wikitable" border="1"
|-
! Word || Value
|-
| 0 || 0x00000004
|-
| 1 || 0x80000012
|-
| 2 || 0x00000001
|- style="border-top: double"
| 0-1 || Pid
|- style="border-top: double"
| 0 || "SCFI"
|-
| 1 || 0x00000000
|-
| 2 || Always 0.
|-
| 3 || Nro heap address
|-
| 4 || Nro size
|-
| 5 || Bss backing heap address
|-
| 6 || Bss size
|}

== LoadNrr ==
[7.0.0+] A new 8-bit field at NRR + 0x33C (previously padding) must be 0 for this function to succeed.

{| class="wikitable" border="1"
|-
! Word || Value
|-
| 0 || 0x00000004
|-
| 1 || 0x8000000E
|-
| 2 || 0x00000001
|-
|- style="border-top: double"
| 0-1 || Pid
|- style="border-top: double"
| 0 || "SFCI"
|-
| 1 || 0x00000002
|-
| 2 || Always 0.
|-
| 3 || Nrr address
|-
| 4 || Nrr size
|}

== Initialize ==
{| class="wikitable" border="1"
|-
! Word || Value
|-
| 0 || 0x00000004
|-
| 1 || 0x8000000A
|-
| 2 || 0x00000003
|- style="border-top: double"
| 0-1 || Pid
|-
| 2 || Process handle (0xFFFF8001)
|- style="border-top: double"
| 0 || "SFCI"
|-
| 1 || 0x00000004
|-
| 2 || Always 0.
|}

== LoadNrrEx ==
Takes in a u64 nrr_address, a u64 nrr_size, a pid descriptor, and a process handle.

First, this validates that the pid descriptor matches the pid for the process handle sent to this->Initialize() earlier.

Then, this calls the same function as LoadNrr, except using the passed process handle instead of the one sent to Initialize.

When called from an ro:1 session, the field at NRR header + 0x33C must be 0x1. When called from ldr:ro session, the field at NRR header + 0x33C must be 0x0.

[[Category:Services]]

Services API

2019-04-22T07:13:24Z

Adubbz: Update

Services are system processes running in the background which wait for incoming requests. When a process wants to communicate with a service, it first needs to get a handle to the named service, and then it can communicate with the service via inter-process communication (each service has a name up to 8 characters).

Handles for services are retrieved from the service manager port, "sm:", and are released via svcCloseHandle or when a process is terminated or crashes. Manager service "sm:m" also exists. Services are an abstraction of ports, they operate the same way except regular ports can have their handles retrieved directly from a SVC. Services are also able to limit the number of handles given to other processes.

= sm: =
This is "nn::sm::detail::IUserInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#Initialize]]
|-
| 1 || [[#GetService]]
|-
| 2 || [[#RegisterService]]
|-
| 3 || [[#UnregisterService]]
|}

== Initialize ==
Takes a pid descriptor and a reserved input u64.

== GetService ==
Takes a zero-padded service name encoded as an u64 integer. Returns a handle.

== RegisterService ==
Takes a zero-padded service name encoded as an u64 integer, an u8 bool, and an u32 (session count) at the next word. Returns a handle.

== UnregisterService ==
Takes a zero-padded service name encoded as an u64 integer.

= sm:m =
This is "nn::sm::detail::IManagerInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#RegisterProcess]]
|-
| 1 || [[#UnregisterProcess]]
|}

== RegisterProcess ==
Takes a pid and two A descriptors with the ACID and ACI0 service lists. That data originates from [[NPDM]].

== UnregisterProcess ==
Takes a pid.

= Service List =
{| class="wikitable" border="1"
|-
! Service names
! scope="col" width="200" | Description
! scope="col" width="200" | Notes
|-
| acc:u0, acc:u1, acc:aa, acc:su, [5.0.0+] dauth:0
| [[Account services]]
| u0: System, u1: User, su: Admin, aa: Baas
|-
| ahid:cd, ahid:hdr, hid, hid:dbg, hid:sys, irs, irs:sys, xcd:sys, [4.0.0-7.0.1] hid:tmp, [5.0.0+] hidbus
| [[HID services]]
|
|-
| appletAE, appletOE, idle:sys, omm, spsm, [5.0.0+] tcap, [6.0.0+] caps:su, [8.0.0+] apm
| [[AM services]]
|
|-
| [1.0.0-2.3.0] aoc:u, mii:u, mii:e, ns:am, ns:su, ns:dev, pl:u, ovln:rcv, ovln:snd, pdm:ntfy, pdm:qry

[3.0.0+] aoc:u, ns:am2, ns:dev, ns:ec, ns:rid, ns:rt, ns:su, ns:vm, ns:web, [1.0.0-7.0.1] ovln:rcv, [1.0.0-7.0.1] ovln:snd
| [[NS Services]]
| am: Application Manager, su: System Update
|-
| apm:dbg, apm:sys, fgm, fgm:0, fgm:9, fgm:dbg, [1.0.0-7.0.1] apm, [1.0.0-7.0.1] apm:p, [8.0.0+] apm:am
| [[PPC services]]
| fgm:1, fgm:2, fgm:3, fgm:4, fgm:5, fgm:6 and fgm:7 used to exist, but are now deprecated.
|-
| arp:r, arp:w, [2.0.0+] bgtc:t, [2.0.0+] bgtc:sc
| [[Glue services]]
|
|-
| audin:a, audin:d, audin:u, audout:a, audout:d, audout:u, audren:a, audren:d, audren:u, audrec:a, audrec:d, audrec:u, audctl, codecctl, hwopus, auddebug, [6.0.0+] auddev
| [[Audio services]]
|
|-
| <nowiki>banana</nowiki>
| [[Profiler services]]
| Not currently available on retail units.
|-
| <nowiki>bcat:a, bcat:u, bcat:m, bcat:s, news:a, news:c, news:m, news:p, news:v, prepo:u, prepo:s, prepo:m, [1.0.0-5.1.0] prepo:a, [6.0.0+] prepo:a2</nowiki>
| [[BCAT services]]
|
|-
| [1.0.0] bpc:c, bpc:b, bpc:r, bpc:w, pcv, pcv:arb, pcv:imm, time:u, time:a, time:s
[2.0.0+] bpc, bpc:r, pcv, time:u, time:a, time:s, [1.0.0-7.0.1] pcv:arb, [1.0.0-7.0.1] pcv:imm, [8.0.0+] clkrst, [8.0.0+] clkrst:a, [8.0.0+] clkrst:i, [8.0.0+] rgltr, [8.0.0+] rtc
| [[PCV services]]
|
|-
| bsd:u, bsd:s, bsdcfg, ethc:c, ethc:i, nsd:u, nsd:a, sfdnsres
| [[Sockets services]]
|
|-
| btdrv, [5.0.0+] bt
| [[Bluetooth Driver services]]
|
|-
| btm, btm:dbg, btm:sys, [5.0.0+] btm:u
| [[BTM services]]
|
|-
| caps:a, caps:c, [1.0.0] mm:u, [5.0.0+] caps:u
| [[Capture services]]
| a: AlbumAccessor, c: AlbumControl
|-
| [2.0.0+] caps:sc, [2.0.0+] caps:ss, vi:m, vi:s, vi:u, cec-mgr, [2.0.0+] mm:u, [4.0.0-5.1.0] caps:su
| [[Display services]]
|
|-
| dispdrv
| [[Nvnflinger services]]
|
|-
| dmnt:-
| [[Debug Monitor services]]
| Not currently available on retail units.
|-
| erpt:c, erpt:r
| [[Error Report services]]
|
|-
| eupld:c, eupld:r
| [[Error Upload services]]
|
|-
| es
| [[ETicket services]]
|
|-
| fan, psm, tc, ts, <nowiki>pcm</nowiki>
| [[PTM services]]
| pcm is not available on retail units.
|-
| fatal:u, fatal:p
| [[Fatal services]]
|
|-
| friend:u, friend:v, friend:m, friend:s, friend:a, [5.0.0+] nd:app, nd:sys
| [[Friend services]]
|
|-
| fsp-srv, fsp-ldr, fsp-pr
| [[Filesystem services]]
| srv: Main, ldr: Loader, pr: Program Registry
|-
| gpio, i2c, i2c:pcv, pinmux, pwm, uart, [3.0.0+] sasbus
| [[Bus services]]
|
|-
| htc, htcs, htc:tenv, file_io, gds, tma_log, tmagent
| [[TMA services]]
|
|-
| jit:u
| [[JIT services]]
| Not currently available on retail units.
|-
| lbl
| [[Backlight services]]
|
|-
| ldn:m, ldn:s, ldn:u, [5.0.0+] ndd
| [[LDN services]]
|
|-
| [1.0.0+] ldr:pm, ldr:ro, ldr:shel, ldr:dmnt

[3.0.0+] ldr:pm, ldr:shel, ldr:dmnt
| [[Loader services]]
|
|-
| lm, lm:get
| [[Log services]]
|
|-
| manu
| [[Manu Services]]
| "Manufacturing", present in factory firmware but not installed on retail systems.
|-
| lr, ncm, ncm:v
| [[NCM services]]
|
|-
| nfc:am, nfc:mf:u, nfc:user, nfc:sys, nfp:user, nfp:dbg, nfp:sys
| [[NFC services]]
|
|-
| nifm:u, nifm:a, nifm:s
| [[Network Interface services]]
|
|-
| nim, nim:shp, ntc, [5.0.0+] nim:eca, [7.0.0+] nim:ecas
| [[NIM services]]
|
|-
| npns:u, npns:s
| [[NPNS services]]
|
|-
| nvdrv:a, nvdrv:s, nvdrv:t, nvdrv, nvdrvdbg, nvgem:c, nvgem:cd, nvmemp
| [[NV services]]
|
|-
| pcie, [6.0.0+] pcie:log
| [[PCIe services]]
|
|-
| pctl, pctl:a, pctl:s, pctl:r
| [[Parental Control services]]
|
|-
| pm:bm, pm:info, pm:shell
| [[Process Manager services]]
|
|-
| psc:c, psc:m, [5.0.0+] srepo:u, srepo:a, [8.0.0+] ovln:rcv, [8.0.0+] ovln:snd
| [[PSC services]]
|
|-
| [3.0.0+] ldr:ro, ro:dmnt, [7.0.0+] ro:1
| [[RO services]]
|
|-
| set, set:fd, set:cal, set:sys
| [[Settings services]]
| cal: calibration, sys: System Settings
|-
| [3.0.0+] mii:u, mii:e, pdm:ntfy, pdm:qry, pl:u, [5.0.0+] miiimg, [6.0.0+] avm
| [[Shared Database services]]
|
|-
| ssl
| [[SSL services]]
|
|-
| csrng, spl:, [4.0.0+] spl:mig, spl:fs, spl:ssl, spl:es, [5.0.0+] spl:manu
| [[SPL services]]
|
|-
| sf-uds
| ?
| System debug applet "recovery" has access to this service, but it doesn't appear to exist.
|-
| tspm
| ?
| Applications on [1.0.0] used to have access to this service, but it doesn't appear to be present on retail devices.
|-
| usb:ds, usb:hs, usb:pd, usb:pd:c, [1.0.0] usb:pd:m, usb:pm, [7.0.0+] usb:hs:a, [7.0.0+] usb:qdb, [8.0.0+] usb:obsv
| [[USB services]]
|
|-
| wlan:inf, wlan:lcl, wlan:lg, wlan:lga, wlan:sg, wlan:soc, [6.0.0+] wlan:dtc
| [[WLAN services]]
|
|-
| [4.0.0+] grc:c, [6.0.0+] grc:d
| [[GRC services]]
|
|-
| [4.0.0+] mig:usr
| [[Migration services]]
|
|-
| [4.0.0+] caps:dc
| [[Jpegdec services]]
|
|-
| [6.0.0+] olsc:s
| [[OLSC services]]
|
|}

[[Category:Services]]

Loader services

2019-04-22T07:11:45Z

Adubbz: Removed ro info as it is now on its own page.

= ldr:dmnt =
This is "nn::ldr::detail::IDebugMonitorInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[Loader_services#AddProcessToDebugLaunchQueue|AddProcessToDebugLaunchQueue]]
|-
| 1 || [[Loader_services#ClearDebugLaunchQueue|ClearDebugLaunchQueue]]
|-
| 2 || [[Loader_services#GetNsoInfos|GetNsoInfos]]
|}

== AddProcessToDebugLaunchQueue ==
Same as [[Loader_services#AddProcessToLaunchQueue|AddProcessToLaunchQueue]] but for processes marked as debug.

== ClearDebugLaunchQueue ==
Same as [[Loader_services#ClearLaunchQueue|ClearLaunchQueue]].

== GetNsoInfos ==
Takes in a u64 ProcessID, and a C descriptor. Returns the number of NsoInfos copied to output.

NsoInfo has the following layout:

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x20
| "Build ID", from NSO header+0x40.
|-
| 0x20
| 0x8
| Mapped address for this NSO
|-
| 0x28
| 0x8
| Mapped size for this NSO
|-
|}

= ldr:pm =
This is "nn::ldr::detail::IProcessManagerInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CreateProcess
|-
| 1 || [[#GetProgramInfo]]
|-
| 2 || [[#RegisterTitle]]
|-
| 3 || [[#UnregisterTitle]]
|}

== GetProgramInfo ==
Takes a TitleId + StorageId, parses the NPDM, and writes output to a C descriptor buffer as follows:

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| MainThreadPrio. Arg1 to svcStartProcess
|-
| 0x1
| 0x1
| DefaultCpuId. Arg2 to svcStartProcess
|-
| 0x2
| 0x1
| ApplicationType, see [[Process Manager services|here]].
|-
| 0x3
| 0x1
| Padding
|-
| 0x4
| 0x4
| MainThreadStackSize. Arg3 to svcStartProcess
|-
| 0x8
| 0x8
| TitleIdRange_Min
|-
| 0x10
| 0x4
| ACID [[NPDM#Service Access Control|Service Access Control]] list size
|-
| 0x14
| 0x4
| ACI0 [[NPDM#Service Access Control|Service Access Control]] list size
|-
| 0x18
| 0x4
| ACID [[NPDM#FS Access Control|FS Access Control]] buffer size
|-
| 0x1C
| 0x4
| ACI0 [[NPDM#FS Access Control|FS Access Control]] buffer size
|-
| 0x20
| <Varies>
| ACID [[NPDM#Service Access Control|Service Access Control]] list
|-
| <Varies>
| <Varies>
| ACI0 [[NPDM#Service Access Control|Service Access Control]] list
|-
| <Varies>
| <Varies>
| ACID [[NPDM#FS Access Control|FS Access Control]] buffer
|-
| <Varies>
| <Varies>
| ACI0 [[NPDM#FS Access Control|FS Access Control]]
|}

== RegisterTitle ==
Takes a TitleId + StorageId, returns an index.

== UnregisterTitle ==
Takes the index from [[#RegisterTitle]].

= ldr:shel =
This is "nn::ldr::detail::IShellInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#AddProcessToLaunchQueue]]
|-
| 1 || [[#ClearLaunchQueue]]
|}

== AddProcessToLaunchQueue ==
Takes a type-0x19 input buffer with launch arguments (as string), an u32 (size of arguments string), and an input title-id.

Loads a process for the specified title-id and passes along the supplied arguments.
Loaded processes are kept in a queue waiting for PM to launch them. The maximum number of waiting processes in this list is 10.

== ClearLaunchQueue ==
Clears the loaded processes waiting queue.

[[Category:Services]]

Fuses

2019-02-19T00:19:37Z

Adubbz: Updated for 7.0.1

The Nintendo Switch makes use of Tegra's fuse driver for a number of operations. This driver is mapped to physical address 0x7000F800 with a total size of 0x400 bytes and exposes several registers for fuse programming.

Registers from 0x7000F800 to 0x7000F800 + 0xFF can be used to directly program the hardware fuse array, while registers from 0x7000F800 + 0x100 (FUSE_CHIP_REG_START_OFFSET) to 0x7000F800 + 0x3FC (FUSE_CHIP_REG_END_OFFSET) represent cached values read from certain fuses.

== Registers ==
Below is a list of fuse driver registers used by the Switch's bootloaders.

=== Driver registers ===
{| class="wikitable" border="1"
! Name
! Address
|-
| [[#FUSE_CTRL|FUSE_CTRL]]
| 0x7000F800
|-
| [[#FUSE_REG_ADDR|FUSE_REG_ADDR]]
| 0x7000F804
|-
| [[#FUSE_REG_READ|FUSE_REG_READ]]
| 0x7000F808
|-
| [[#FUSE_REG_WRITE|FUSE_REG_WRITE]]
| 0x7000F80C
|-
| FUSE_TIME_RD1
| 0x7000F810
|-
| FUSE_TIME_RD2
| 0x7000F814
|-
| FUSE_TIME_PGM1
| 0x7000F818
|-
| [[#FUSE_TIME_PGM2|FUSE_TIME_PGM2]]
| 0x7000F81C
|-
| [[#FUSE_PRIV2INTFC|FUSE_PRIV2INTFC]]
| 0x7000F820
|-
| FUSE_FUSEBYPASS
| 0x7000F824
|-
| FUSE_PRIVATEKEYDISABLE
| 0x7000F828
|-
| [[#FUSE_DIS_PGM|FUSE_DIS_PGM]]
| 0x7000F82C
|-
| [[#FUSE_WRITE_ACCESS|FUSE_WRITE_ACCESS]]
| 0x7000F830
|-
| FUSE_PWR_GOOD_SW
| 0x7000F834
|-
| FUSE_PRIVATE_KEY0_NONZERO
| 0x7000F880
|-
| FUSE_PRIVATE_KEY1_NONZERO
| 0x7000F884
|-
| FUSE_PRIVATE_KEY2_NONZERO
| 0x7000F888
|-
| FUSE_PRIVATE_KEY3_NONZERO
| 0x7000F88C
|-
| FUSE_PRIVATE_KEY4_NONZERO
| 0x7000F890
|}

==== FUSE_CTRL ====
{| class="wikitable" border="1"
! Bits
! Description
|-
| 0-1
| Fuse command (1 = FUSE_READ; 2 = FUSE_WRITE; 3 = FUSE_SENSE)
|-
| 16-20
| Fuse state (4 = STATE_IDLE)
|-
| 26
| Fuse power down mode flag (FUSE_CTRL_PD)
|-
| 30
| Fuse sense status (FUSE_CTRL_SENSE_DONE)
|}

Before fuse reading/writing the power down mode must be disabled.
FUSE_SENSE mode flushes programmed values into the [[Fuses#Cache_registers|cache registers]].

==== FUSE_REG_ADDR ====
This register takes the address of the fuse to be read/written/sensed.

==== FUSE_REG_READ ====
This register receives the value read from the fuse.

==== FUSE_REG_WRITE ====
This register takes the value to be written to the fuse.

==== FUSE_TIME_PGM2 ====
This register takes the fuse programming pulse (0xC0 == 19200 kHz).

==== FUSE_PRIV2INTFC ====
{| class="wikitable" border="1"
! Bits
! Description
|-
| 0
| FUSE_PRIV2INTFC_SDATA
|-
| 1
| FUSE_PRIV2INTFC_SKIP_RECORDS
|}

==== FUSE_DIS_PGM ====
If set to 0x01, this register disables fuse programming.

==== FUSE_WRITE_ACCESS ====
If set to 0x01, this register disables software writes to the fuse driver registers.

=== Cache registers ===
{| class="wikitable" border="1"
! Name
! Address
|-
| FUSE_PRODUCTION_MODE
| 0x7000F900
|-
| FUSE_JTAG_SECUREID_VALID
| 0x7000F904
|-
| FUSE_ODM_LOCK
| 0x7000F908
|-
| [[#FUSE_SKU_INFO|FUSE_SKU_INFO]]
| 0x7000F910
|-
| FUSE_CPU_SPEEDO_0
| 0x7000F914
|-
| FUSE_CPU_IDDQ
| 0x7000F918
|-
| FUSE_DAC_CRT_CALIB
| 0x7000F91C
|-
| FUSE_DAC_HDTV_CALIB
| 0x7000F920
|-
| FUSE_DAC_SDTV_CALIB
| 0x7000F924
|-
| FUSE_FT_REV
| 0x7000F928
|-
| FUSE_CPU_SPEEDO_1
| 0x7000F92C
|-
| FUSE_CPU_SPEEDO_2
| 0x7000F930
|-
| FUSE_SOC_SPEEDO_0
| 0x7000F934
|-
| [[#FUSE_SOC_SPEEDO_1|FUSE_SOC_SPEEDO_1]]
| 0x7000F938
|-
| FUSE_SOC_SPEEDO_2
| 0x7000F93C
|-
| FUSE_SOC_IDDQ
| 0x7000F940
|-
| FUSE_RESERVED_PRODUCTION_WP
| 0x7000F944
|-
| [[#FUSE_FA|FUSE_FA]]
| 0x7000F948
|-
| FUSE_RESERVED_PRODUCTION
| 0x7000F94C
|-
| FUSE_HDMI_LANE0_CALIB
| 0x7000F950
|-
| FUSE_HDMI_LANE1_CALIB
| 0x7000F954
|-
| FUSE_HDMI_LANE2_CALIB
| 0x7000F958
|-
| FUSE_HDMI_LANE3_CALIB
| 0x7000F95C
|-
| FUSE_ENCRYPTION_RATE
| 0x7000F960
|-
| [[#FUSE_PUBLIC_KEY|FUSE_PUBLIC_KEY0]]
| 0x7000F964
|-
| [[#FUSE_PUBLIC_KEY|FUSE_PUBLIC_KEY1]]
| 0x7000F968
|-
| [[#FUSE_PUBLIC_KEY|FUSE_PUBLIC_KEY2]]
| 0x7000F96C
|-
| [[#FUSE_PUBLIC_KEY|FUSE_PUBLIC_KEY3]]
| 0x7000F970
|-
| [[#FUSE_PUBLIC_KEY|FUSE_PUBLIC_KEY4]]
| 0x7000F974
|-
| [[#FUSE_PUBLIC_KEY|FUSE_PUBLIC_KEY5]]
| 0x7000F978
|-
| [[#FUSE_PUBLIC_KEY|FUSE_PUBLIC_KEY6]]
| 0x7000F97C
|-
| [[#FUSE_PUBLIC_KEY|FUSE_PUBLIC_KEY7]]
| 0x7000F980
|-
| FUSE_TSENSOR_1
| 0x7000F984
|-
| FUSE_TSENSOR_2
| 0x7000F988
|-
| FUSE_VSENSOR_CALIB
| 0x7000F98C
|-
| FUSE_CP_REV
| 0x7000F990
|-
| FUSE_OPT_PFG
| 0x7000F994
|-
| FUSE_TSENSOR_0
| 0x7000F998
|-
| FUSE_FIRST_BOOTROM_PATCH_SIZE_REG
| 0x7000F99C
|-
| FUSE_SECURITY_MODE
| 0x7000F9A0
|-
| [[#FUSE_PRIVATE_KEY|FUSE_PRIVATE_KEY0]]
| 0x7000F9A4
|-
| [[#FUSE_PRIVATE_KEY|FUSE_PRIVATE_KEY1]]
| 0x7000F9A8
|-
| [[#FUSE_PRIVATE_KEY|FUSE_PRIVATE_KEY2]]
| 0x7000F9AC
|-
| [[#FUSE_PRIVATE_KEY|FUSE_PRIVATE_KEY3]]
| 0x7000F9B0
|-
| [[#FUSE_PRIVATE_KEY|FUSE_PRIVATE_KEY4]]
| 0x7000F9B4
|-
| FUSE_ARM_JTAG_DISABLE
| 0x7000F9B8
|-
| FUSE_BOOT_DEVICE_INFO
| 0x7000F9BC
|-
| [[#FUSE_RESERVED_SW|FUSE_RESERVED_SW]]
| 0x7000F9C0
|-
| FUSE_VP8_ENABLE
| 0x7000F9C4
|-
| [[#FUSE_RESERVED_ODM0|FUSE_RESERVED_ODM0]]
| 0x7000F9C8
|-
| [[#FUSE_RESERVED_ODM1|FUSE_RESERVED_ODM1]]
| 0x7000F9CC
|-
| [[#FUSE_RESERVED_ODM2|FUSE_RESERVED_ODM2]]
| 0x7000F9D0
|-
| [[#FUSE_RESERVED_ODM3|FUSE_RESERVED_ODM3]]
| 0x7000F9D4
|-
| [[#FUSE_RESERVED_ODM4|FUSE_RESERVED_ODM4]]
| 0x7000F9D8
|-
| FUSE_RESERVED_ODM5
| 0x7000F9DC
|-
| [[#FUSE_RESERVED_ODM6|FUSE_RESERVED_ODM6]]
| 0x7000F9E0
|-
| [[#FUSE_RESERVED_ODM7|FUSE_RESERVED_ODM7]]
| 0x7000F9E4
|-
| FUSE_OBS_DIS
| 0x7000F9E8
|-
| FUSE_NOR_INFO
| 0x7000F9EC
|-
| FUSE_SKU_USB_CALIB
| 0x7000F9F0
|-
| FUSE_SKU_DIRECT_CONFIG
| 0x7000F9F4
|-
| FUSE_KFUSE_PRIVKEY_CTRL
| 0x7000F9F8
|-
| FUSE_PACKAGE_INFO
| 0x7000F9FC
|-
| FUSE_VENDOR_CODE
| 0x7000FA00
|-
| FUSE_FAB_CODE
| 0x7000FA04
|-
| FUSE_LOT_CODE_0
| 0x7000FA08
|-
| FUSE_LOT_CODE_1
| 0x7000FA0C
|-
| FUSE_WAFER_ID
| 0x7000FA10
|-
| FUSE_X_COORDINATE
| 0x7000FA14
|-
| FUSE_Y_COORDINATE
| 0x7000FA18
|-
| FUSE_OPS_RESERVED
| 0x7000FA20
|-
| FUSE_SATA_CALIB
| 0x7000FA24
|-
| FUSE_GPU_IDDQ
| 0x7000FA28
|-
| FUSE_TSENSOR_3
| 0x7000FA2C
|-
| FUSE_SKU_BOND_OUT_L
| 0x7000FA30
|-
| FUSE_SKU_BOND_OUT_H
| 0x7000FA34
|-
| FUSE_SKU_BOND_OUT_U
| 0x7000FA38
|-
| FUSE_SKU_BOND_OUT_V
| 0x7000FA3C
|-
| FUSE_SKU_BOND_OUT_W
| 0x7000FA40
|-
| FUSE_OPT_SUBREVISION
| 0x7000FA48
|-
| FUSE_TSENSOR_4
| 0x7000FA54
|-
| FUSE_TSENSOR_5
| 0x7000FA58
|-
| FUSE_TSENSOR_6
| 0x7000FA5C
|-
| FUSE_TSENSOR_7
| 0x7000FA60
|-
| FUSE_OPT_PRIV_SEC_DIS
| 0x7000FA64
|-
| [[#FUSE_PKC_DISABLE|FUSE_PKC_DISABLE]]
| 0x7000FA68
|-
| FUSE_FALCON_DEBUG_DISABLE
| 0x7000FA7C
|-
| FUSE_TSENSOR_COMMON
| 0x7000FA80
|-
| FUSE_DEBUG_AUTH_OVERRIDE
| 0x7000FA9C
|-
| FUSE_GCPLEX_CONFIG_FUSE
| 0x7000FAC8
|-
| FUSE_TSENSOR_8
| 0x7000FAD4
|-
| FUSE_DEBUG_AUTHENTICATION
| 0x7000FAE4
|-
| FUSE_SECURE_PROVISION_INDEX
| 0x7000FAE8
|-
| FUSE_AID
| 0x7000FAF8
|-
| FUSE_SPARE_REALIGNMENT_REG
| 0x7000FAFC
|-
| FUSE_RESERVED_CALIB0
| 0x7000FB04
|-
| FUSE_OPT_GPU_TPC0_DISABLE
| 0x7000FB0C
|-
| FUSE_TSENSOR_9
| 0x7000FB1C
|-
| FUSE_OPT_GPU_TPC1_DISABLE
| 0x7000FB3C
|-
| FUSE_USB_CALIB_EXT
| 0x7000FB50
|-
| FUSE_OPT_ECC_EN
| 0x7000FB58
|-
| FUSE_SPARE_BIT_0
| 0x7000FB80
|-
| FUSE_SPARE_BIT_1
| 0x7000FB84
|-
| [[#FUSE_SPARE_BIT_2|FUSE_SPARE_BIT_2]]
| 0x7000FB88
|-
| [[#FUSE_SPARE_BIT_3|FUSE_SPARE_BIT_3]]
| 0x7000FB8C
|-
| [[#FUSE_SPARE_BIT_4|FUSE_SPARE_BIT_4]]
| 0x7000FB90
|-
| [[#FUSE_SPARE_BIT_5|FUSE_SPARE_BIT_5]]
| 0x7000FB94
|-
| FUSE_SPARE_BIT_6
| 0x7000FB98
|-
| FUSE_SPARE_BIT_7
| 0x7000FB9C
|-
| FUSE_SPARE_BIT_8
| 0x7000FBA0
|-
| FUSE_SPARE_BIT_9
| 0x7000FBA4
|-
| FUSE_SPARE_BIT_10
| 0x7000FBA8
|-
| FUSE_SPARE_BIT_11
| 0x7000FBAC
|-
| FUSE_SPARE_BIT_12
| 0x7000FBB0
|-
| FUSE_SPARE_BIT_13
| 0x7000FBB4
|-
| FUSE_SPARE_BIT_14
| 0x7000FBB8
|-
| FUSE_SPARE_BIT_15
| 0x7000FBBC
|-
| FUSE_SPARE_BIT_16
| 0x7000FBC0
|-
| FUSE_SPARE_BIT_17
| 0x7000FBC4
|-
| FUSE_SPARE_BIT_18
| 0x7000FBC8
|-
| FUSE_SPARE_BIT_19
| 0x7000FBCC
|-
| FUSE_SPARE_BIT_20
| 0x7000FBD0
|-
| FUSE_SPARE_BIT_21
| 0x7000FBD4
|-
| FUSE_SPARE_BIT_22
| 0x7000FBD8
|-
| FUSE_SPARE_BIT_23
| 0x7000FBDC
|-
| FUSE_SPARE_BIT_24
| 0x7000FBE0
|-
| FUSE_SPARE_BIT_25
| 0x7000FBE4
|-
| FUSE_SPARE_BIT_26
| 0x7000FBE8
|-
| FUSE_SPARE_BIT_27
| 0x7000FBEC
|-
| FUSE_SPARE_BIT_28
| 0x7000FBF0
|-
| FUSE_SPARE_BIT_29
| 0x7000FBF4
|-
| FUSE_SPARE_BIT_30
| 0x7000FBF8
|-
| FUSE_SPARE_BIT_31
| 0x7000FBFC
|}

==== FUSE_SKU_INFO ====
Stores the SKU ID (must be 0x83).

==== FUSE_FA ====
Stores failure analysis mode.

==== FUSE_SOC_SPEEDO_1 ====
Stores the bootrom patch version.

==== FUSE_RESERVED_ODM0 ====
This appears to store a hardware ID.

==== FUSE_RESERVED_ODM1 ====
This appears to store a hardware ID.

==== FUSE_RESERVED_ODM2 ====
{| class="wikitable" border="1"
! Bits
! Description
|-
| 0-4
| [5.0.0+] Used as key generation
|}

This appears to store a hardware ID.

==== FUSE_RESERVED_ODM3 ====
This appears to store a hardware ID.

==== FUSE_RESERVED_ODM4 ====
{| class="wikitable" border="1"
! Bits
! Description
|-
| 0-1
| Unit type (3 = debug; 0 = retail)
|-
| 2
| Unknown config (must be 1 on retail)
|-
| [1.0.0-3.0.2] 3-5
[4.0.0+] 3-7
| DRAM id
|-
| 8
| Unknown config mask (must be 0 on retail)
|-
| 9
| Unit type mask (0 = debug; 1 = retail)
|-
| 10
| [3.0.0+] Kiosk mode (0 = retail; 1 = kiosk)
|-
| 11
| [5.0.0+] SoC variant (0 = T210; 1 = T214)
|-
| 16-19
| [4.0.0+] New unit type
|}

This stores some device configuration parameters.

==== FUSE_RESERVED_ODM6 ====
This register returns the value programmed into index 0x3A of the fuse array.

==== FUSE_RESERVED_ODM7 ====
This register returns the value programmed into index 0x3C of the fuse array.

==== FUSE_SPARE_BIT_2 ====
Stores part of the speedo fusing revision.

==== FUSE_SPARE_BIT_3 ====
Stores part of the speedo fusing revision.

==== FUSE_SPARE_BIT_4 ====
Stores part of the speedo fusing revision.

==== FUSE_SPARE_BIT_5 ====
Must be non-zero on retail units, otherwise the first bootloader panics.
On debug units it can be zero, which tells the bootloader to choose from two debug master key seeds. If set to non-zero on a debug unit, it tells the bootloader to choose from two retail master key seeds (only the last one matches the retail master key seed).

==== FUSE_PRIVATE_KEY ====
This stores the 160-bit private key (128 bit SBK + 32-bit device key).
Reads to these registers after the SBK is locked out produce all-FF output.

==== FUSE_PUBLIC_KEY ====
This stores the SHA256 hash of the 2048-bit RSA key expected at BCT+0x210.

==== FUSE_RESERVED_SW ====
{| class="wikitable" border="1"
! Bits
! Description
|-
| 0-2
| Boot device
|-
| 3
| Skip device selection straps (0 = don't skip; 1 = skip)
|-
| 4
| ENABLE_CHARGER_DETECT
|-
| 5
| ENABLE_WATCHDOG
|-
| 6
| Forced RCM two button mode (0 = Only VOLUME_UP; 1 = VOLUME_UP + HOME)
|-
| 7
| RCM USB controller mode (0 = USB 2.0; 1 = XUSB)
|}

This caches the value of the sw_reserved fuse from the hardware array.

==== FUSE_PKC_DISABLE ====
This caches the value of the pkc_disable fuse from the hardware array.

== eFuses ==
The actual hardware fuses can be programmed through the fuse driver after enabling fuse programming.

Below is a list of common fuse indexes used by Tegra devices (and applicable to the Switch).
Note that the indexes are relative to the start of the fuse array and each element is a 4 byte word. A single fuse write operation always writes the same word at both fuse_array + 0 (PRIMARY_ALIAS) and fuse_array + 1 (REDUNDANT_ALIAS).

{| class="wikitable" border="1"
! Name
! Index
! Bits
|-
| jtag_disable
| 0x00
| 1
|-
| odm_production_mode
| 0x00
| 1
|-
| odm_lock
| 0x00
| 4
|-
| public_key
| 0x0C
| 256
|-
| secure_boot_key
| 0x22
| 128
|-
| device_key
| 0x2A
| 32
|-
| sec_boot_dev_cfg
| 0x2C
| 16
|-
| sec_boot_dev_sel
| 0x2C
| 3
|-
| sw_reserved
| 0x2E
| 12
|-
| ignore_dev_sel_straps
| 0x2E
| 1
|-
| [[#odm_reserved|odm_reserved]]
| 0x2E
| 256
|-
| pkc_disable
| 0x52
| 1
|-
| debug_authentication
| 0x5A
| 5
|-
| aid
| 0x67
| 32
|-
| [[#bootrom_ipatch|bootrom_ipatch]]
| 0x72
| 624
|}

=== odm_reserved ===
The first bootloader only burns fuses in this region.
Both fuse indexes 0x3A (odm_reserved + 0x0C) and 0x3C (odm_reserved + 0x0E) are used for anti-downgrade control. These fuses will have their values cached into [[#FUSE_RESERVED_ODM6|FUSE_RESERVED_ODM6]] and [[#FUSE_RESERVED_ODM7|FUSE_RESERVED_ODM7]].

=== bootrom_ipatch ===
Tegra210 based hardware such as the Switch provides support for bootrom patches. The patch data is burned to the hardware fuse array using a specific format (see [https://gist.github.com/shuffle2/f8728159da100e9df2606d43925de0af shuffle2's ipatch decoder]). The bootrom reads these fuses in order to initialize the IPATCH hardware, which allows overriding data returned for code and data fetches done by BPMP. The revision stored in FUSE_CP_REV indicates the unique set of values stored in ipatch fuses.

The following represents the patch data dumped from a Switch console:
<syntaxhighlight>
RAM:00000000 ; =============== S U B R O U T I N E =======================================
RAM:00000000
RAM:00000000
RAM:00000000 irom_svc_dispatch
RAM:00000000 STMFD SP!, {R0-R2} ; ipatches:
RAM:00000000 ; 0 b57df00 16ae df00 : svc #0x00 (offset 0x48)
RAM:00000000 ; 1 1820df22 3040 df22 : svc #0x22 (offset 0x8c)
RAM:00000000 ; 2 3797df26 6f2e df26 : svc #0x26 (offset 0x94)
RAM:00000000 ; 3 7d9e2000 fb3c 2000 : movs r0, #0x00
RAM:00000000 ; 4 42bdf2c 856 df2c : svc #0x2c (offset 0xa0)
RAM:00000000 ; 5 37aadf42 6f54 df42 : svc #0x42 (offset 0xcc)
RAM:00000000 ; 6 972df4b 12e4 df4b : svc #0x4b (offset 0xde)
RAM:00000000 ; 7 2293df54 4526 df54 : svc #0x54 (offset 0xf0)
RAM:00000000 ; 8 21fadf5d 43f4 df5d : svc #0x5d (offset 0x102)
RAM:00000000 ; 9 bba2ac57 17744 ac57 : data
RAM:00000000 ; 10 bbac3d19 17758 3d19 : data
RAM:00000000 ; 11 1e952001 3d2a 2001 : movs r0, #0x01
RAM:00000004 MOV R2, LR
RAM:00000008 SUB R2, R2, #2
RAM:0000000C LDR R2, [R2]
RAM:00000010 AND R2, R2, #0xFF
RAM:00000014 MOV R2, R2,LSL#1
RAM:00000018 LDR R0, =0x1007B0
RAM:0000001C LDR R1, =0x1007F8
RAM:00000020 SUB R1, R1, R0
RAM:00000024 LDR R0, =0x40004C30
RAM:00000028 ADD R0, R0, R1
RAM:0000002C ADD R2, R2, R0
RAM:00000030 ORR R2, R2, #1
RAM:00000034 LDMFD SP!, {R0,R1}
RAM:00000038 BX R2
RAM:00000038 ; End of function irom_svc_dispatch
RAM:00000038
RAM:00000038 ; ---------------------------------------------------------------------------
RAM:0000003C dword_3C DCD 0x1007B0 ; DATA XREF: irom_svc_dispatch+18↑r
RAM:00000040 dword_40 DCD 0x1007F8 ; DATA XREF: irom_svc_dispatch+1C↑r
RAM:00000044 dword_44 DCD 0x40004C30 ; DATA XREF: irom_svc_dispatch+24↑r
RAM:00000048 CODE16
RAM:00000048
RAM:00000048 ; =============== S U B R O U T I N E =======================================
RAM:00000048
RAM:00000048
RAM:00000048 sub_48
RAM:00000048 MOVS R2, #0 ; 0 b57df00 16ae df00 : svc #0x00 (offset 0x48)
RAM:0000004A MVNS R2, R2
RAM:0000004C LDR R1, =0x60006410
RAM:0000004E STR R2, [R1,#0x30]
RAM:00000050 STR R2, [R1,#0x38]
RAM:00000052 LDR R1, =0x600060F8
RAM:00000054 STR R2, [R1]
RAM:00000056 STR R2, [R1,#4]
RAM:00000058 LDR R1, =0x60006284
RAM:0000005A STR R2, [R1]
RAM:0000005C STR R2, [R1,#0x18]
RAM:0000005E ADDS R1, #0x80
RAM:00000060 ADDS R1, #0x1C
RAM:00000062 STR R2, [R1]
RAM:00000064 STR R2, [R1,#8]
RAM:00000066 STR R2, [R1,#0x10]
RAM:00000068 ADDS R1, #0x80
RAM:0000006A STR R2, [R1]
RAM:0000006C STR R2, [R1,#4]
RAM:0000006E LDR R1, =0x60006554
RAM:00000070 STR R2, [R1]
RAM:00000072 MOVS R2, #0xA0000000
RAM:00000076 LDR R1, =0x60006148
RAM:00000078 STR R2, [R1]
RAM:0000007A ADDS R1, #0x38 ; '8'
RAM:0000007C STR R2, [R1]
RAM:0000007E MOVS R2, #0xE0000000
RAM:00000082 LDR R1, =0x600066A0
RAM:00000084 STR R2, [R1]
RAM:00000086 MOVS R1, #0
RAM:00000088 MOVS R0, #0xE
RAM:0000008A B pop_r2_mov_pc_lr
RAM:0000008A ; End of function sub_48
RAM:0000008A
RAM:0000008C
RAM:0000008C ; =============== S U B R O U T I N E =======================================
RAM:0000008C
RAM:0000008C
RAM:0000008C sub_8C
RAM:0000008C LDR R0, [R1,#0x18] ; 1 1820df22 3040 df22 : svc #0x22 (offset 0x8c)
RAM:0000008E MOVS R2, #1
RAM:00000090 ORRS R0, R2
RAM:00000092 B pop_r2_mov_pc_lr
RAM:00000092 ; End of function sub_8C
RAM:00000092
RAM:00000094
RAM:00000094 ; =============== S U B R O U T I N E =======================================
RAM:00000094
RAM:00000094
RAM:00000094 sub_94
RAM:00000094 LDR R2, [R4,#0x50] ; 2 3797df26 6f2e df26 : svc #0x26 (offset 0x94)
RAM:00000096 ADDS R2, R2, #2
RAM:00000098 STR R2, [R4,#0x50]
RAM:0000009A SUBS R1, #0x80
RAM:0000009C STR R1, [R4,#0x34]
RAM:0000009E B pop_r2_mov_pc_lr
RAM:0000009E ; End of function sub_94
RAM:0000009E
RAM:000000A0
RAM:000000A0 ; =============== S U B R O U T I N E =======================================
RAM:000000A0
RAM:000000A0
RAM:000000A0 sub_A0
RAM:000000A0
RAM:000000A0 ; FUNCTION CHUNK AT RAM:00000148 SIZE 00000004 BYTES
RAM:000000A0
RAM:000000A0 MOVS R0, #0x70000000 ; 4 42bdf2c 856 df2c : svc #0x2c (offset 0xa0)
RAM:000000A4 LDR R6, =dword_7000EF14
RAM:000000A6 LDR R2, =dword_7000E5B4
RAM:000000A8 LDR R2, [R2]
RAM:000000AA CMP R2, #0
RAM:000000AC BEQ loc_B4
RAM:000000AE LDR R2, [R6]
RAM:000000B0 STR R2, [R0,#8]
RAM:000000B2 B loc_BC
RAM:000000B4 ; ---------------------------------------------------------------------------
RAM:000000B4
RAM:000000B4 loc_B4 ; CODE XREF: sub_A0+C↑j
RAM:000000B4 LDR R2, [R0,#8]
RAM:000000B6 LSRS R0, R0, #0x12
RAM:000000B8 ORRS R2, R0
RAM:000000BA STR R2, [R6]
RAM:000000BC
RAM:000000BC loc_BC ; CODE XREF: sub_A0+12↑j
RAM:000000BC LDR R6, =dword_7000E9C0
RAM:000000BE LDR R0, [R6]
RAM:000000C0 MOVS R2, #0x4000
RAM:000000C4 ORRS R2, R0
RAM:000000C6 STR R2, [R6]
RAM:000000C8 LDR R0, [R5,#0x10]
RAM:000000CA B pop_r2_mov_pc_lr
RAM:000000CA ; End of function sub_A0
RAM:000000CA
RAM:000000CC
RAM:000000CC ; =============== S U B R O U T I N E =======================================
RAM:000000CC
RAM:000000CC
RAM:000000CC sub_CC
RAM:000000CC MOVS R2, #0xF000000 ; 5 37aadf42 6f54 df42 : svc #0x42 (offset 0xcc)
RAM:000000D0 BICS R1, R2
RAM:000000D2 STR R1, [R4,#0x10]
RAM:000000D4 LDR R1, [R4,#0x50]
RAM:000000D6 MOVS R2, #7
RAM:000000D8 BICS R1, R2
RAM:000000DA STR R1, [R4,#0x50]
RAM:000000DC B pop_r2_mov_pc_lr
RAM:000000DC ; End of function sub_CC
RAM:000000DC
RAM:000000DE
RAM:000000DE ; =============== S U B R O U T I N E =======================================
RAM:000000DE
RAM:000000DE
RAM:000000DE sub_DE
RAM:000000DE LDR R2, =dword_7000FA9C ; 6 972df4b 12e4 df4b : svc #0x4b (offset 0xde)
RAM:000000E0 LDR R2, [R2]
RAM:000000E2 LSRS R2, R2, #8
RAM:000000E4 LSLS R2, R2, #1
RAM:000000E6 LDR R1, [R4]
RAM:000000E8 BICS R1, R2
RAM:000000EA STR R1, [R4]
RAM:000000EC CMP R0, #0
RAM:000000EE B pop_r2_mov_pc_lr
RAM:000000EE ; End of function sub_DE
RAM:000000EE
RAM:000000F0
RAM:000000F0 ; =============== S U B R O U T I N E =======================================
RAM:000000F0
RAM:000000F0
RAM:000000F0 sub_F0
RAM:000000F0
RAM:000000F0 arg_0= 0
RAM:000000F0
RAM:000000F0 LDR R0, =0x400049F0 ; 7 2293df54 4526 df54 : svc #0x54 (offset 0xf0)
RAM:000000F2 LDR R2, [R0]
RAM:000000F4 STR R2, [SP,#arg_0]
RAM:000000F6 LDR R0, =0x40010000
RAM:000000F8 LSRS R2, R2, #17
RAM:000000FA BEQ pop_r2_mov_pc_lr ; if ([0x400049F0] >> 17) == 0) {
RAM:000000FA ; r2 = [0x400049F0];
RAM:000000FA ; } else {
RAM:000000FC LDR R0, =APBDEV_PMC_CNTRL_0
RAM:000000FE STR R4, [R0] ; write APBDEV_PMC_CNTRL
RAM:00000100
RAM:00000100 loc_100 ; CODE XREF: sub_F0:loc_100↓j
RAM:00000100 B loc_100 ; hang
RAM:00000100 ; End of function sub_F0 ; }
RAM:00000100
RAM:00000102
RAM:00000102 ; =============== S U B R O U T I N E =======================================
RAM:00000102
RAM:00000102
RAM:00000102 sub_102
RAM:00000102
RAM:00000102 arg_0= 0
RAM:00000102
RAM:00000102 LDR R2, =0x40010220 ; 8 21fadf5d 43f4 df5d : svc #0x5d (offset 0x102)
RAM:00000104 STR R2, [SP,#arg_0] ; set r2 retval = [0x40010220]
RAM:00000106 LDR R2, [R2,#0x18]
RAM:00000108 ADDS R0, #0xFC
RAM:0000010A STR R2, [R0,#0x1C] ; [r0+0x118] = [0x40010220 + 0x18]
RAM:0000010C B pop_r2_mov_pc_lr
RAM:0000010C ; End of function sub_102
RAM:0000010C
RAM:0000010C ; ---------------------------------------------------------------------------
RAM:0000010E DCB 0
RAM:0000010F DCB 0
RAM:00000110 off_110 DCD 0x60006410 ; DATA XREF: sub_48+4↑r
RAM:00000114 off_114 DCD 0x600060F8 ; DATA XREF: sub_48+A↑r
RAM:00000118 off_118 DCD 0x60006284 ; DATA XREF: sub_48+10↑r
RAM:0000011C off_11C DCD 0x60006554 ; DATA XREF: sub_48+26↑r
RAM:00000120 off_120 DCD 0x60006148 ; DATA XREF: sub_48+2E↑r
RAM:00000124 off_124 DCD 0x600066A0 ; DATA XREF: sub_48+3A↑r
RAM:00000128 off_128 DCD dword_7000EF14 ; DATA XREF: sub_A0+4↑r
RAM:0000012C off_12C DCD dword_7000E5B4 ; DATA XREF: sub_A0+6↑r
RAM:00000130 off_130 DCD dword_7000E9C0 ; DATA XREF: sub_A0:loc_BC↑r
RAM:00000134 off_134 DCD dword_7000FA9C ; DATA XREF: sub_DE↑r
RAM:00000138 off_138 DCD 0x400049F0 ; DATA XREF: sub_F0↑r
RAM:0000013C dword_13C DCD 0x40010000 ; DATA XREF: sub_F0+6↑r
RAM:00000140 off_140 DCD APBDEV_PMC_CNTRL_0 ; DATA XREF: sub_F0+C↑r
RAM:00000144 off_144 DCD 0x40010220 ; DATA XREF: sub_102↑r
RAM:00000148 ; ---------------------------------------------------------------------------
RAM:00000148 ; START OF FUNCTION CHUNK FOR sub_A0
RAM:00000148
RAM:00000148 pop_r2_mov_pc_lr ; CODE XREF: sub_48+42↑j
RAM:00000148 ; sub_8C+6↑j ...
RAM:00000148 POP {R2}
RAM:0000014A MOV PC, LR
RAM:0000014A ; END OF FUNCTION CHUNK FOR sub_A0
</syntaxhighlight>

The last 4 patches are exclusive to the Switch, while the remaining ones are often included in most Tegra210 based devices.

==== ipatch 0 ====
This patch configures clock enables and clock gate overrides for new hardware.

<syntaxhighlight lang="c">
u32 CLK_ENB_H_SET = 0x60006328;
u32 CLK_ENB_L_SET = 0x60006320;
u32 CLK_ENB_U_SET = 0x60006330;
u32 CLK_ENB_V_SET = 0x60006440;
u32 CLK_ENB_W_SET = 0x60006448;
u32 CLK_ENB_X_SET = 0x60006284;
u32 CLK_ENB_Y_SET = 0x6000629C;
u32 LVL2_CLK_GATE_OVRA = 0x600060F8;
u32 LVL2_CLK_GATE_OVRB = 0x600060FC;
u32 LVL2_CLK_GATE_OVRC = 0x600063A0;
u32 LVL2_CLK_GATE_OVRD = 0x600063A4;
u32 LVL2_CLK_GATE_OVRE = 0x60006554;
u32 CLK_SOURCE_VI = 0x60006148;
u32 CLK_SOURCE_HOST1X = 0x60006180;
u32 CLK_SOURCE_NVENC = 0x600066A0;

// Set all clock enables and overrides
*(u32 *)CLK_ENB_V_SET = 0xFFFFFFFF;
*(u32 *)CLK_ENB_W_SET = 0xFFFFFFFF;
*(u32 *)LVL2_CLK_GATE_OVRA = 0xFFFFFFFF;
*(u32 *)LVL2_CLK_GATE_OVRB = 0xFFFFFFFF;
*(u32 *)CLK_ENB_X_SET = 0xFFFFFFFF;
*(u32 *)CLK_ENB_Y_SET = 0xFFFFFFFF;
*(u32 *)CLK_ENB_L_SET = 0xFFFFFFFF;
*(u32 *)CLK_ENB_H_SET = 0xFFFFFFFF;
*(u32 *)CLK_ENB_U_SET = 0xFFFFFFFF;
*(u32 *)LVL2_CLK_GATE_OVRC = 0xFFFFFFFF;
*(u32 *)LVL2_CLK_GATE_OVRD = 0xFFFFFFFF;
*(u32 *)LVL2_CLK_GATE_OVRE = 0xFFFFFFFF;

// Set VI, HOST1X and NVENC clock sources to CLK_M
*(u32 *)CLK_SOURCE_VI = 0xA0000000;
*(u32 *)CLK_SOURCE_HOST1X = 0xA0000000;
*(u32 *)CLK_SOURCE_NVENC = 0xE0000000;

/*
Untranslated instructions:

MOVS R1, #0
MOVS R0, #0xE
*/

return;
</syntaxhighlight>

==== ipatch 1 ====
This patch is a bugfix.

LP0 resume code expects APBDEV_PMC_SCRATCH190_0 to be set to 0x01, but the bootrom didn't set it.

<syntaxhighlight lang="c">
u32 APBDEV_PMC_SCRATCH190_0 = 0x7000EC18;
u32 pmc_scratch190_val = *(u32 *)APBDEV_PMC_SCRATCH190_0;

return (pmc_scratch190_val | 0x01);
</syntaxhighlight>

==== ipatch 2 ====
This patch adjusts USB configurations.

<syntaxhighlight lang="c">
u32 USB1_UTMIP_SPARE_CFG0_0 = 0x7D000834;
u32 USB1_UTMIP_BIAS_CFG2_0 = 0x7D000850;

// Increase UTMIP_HSSQUELCH_LEVEL_NEW by 0x02
*(u32 *)USB1_UTMIP_BIAS_CFG2_0 += 0x02;

// Clear FUSE_HS_IREF_CAP_CFG
*(u32 *)USB1_UTMIP_SPARE_CFG0_0 = ((*(u32 *)USB1_UTMIP_SPARE_CFG0_0 & ~(0x118)) - 0x80);

return;
</syntaxhighlight>

==== ipatch 3 ====
This patch pertains to XHCI IRQ clearing checks and forces a result code to be 0.

==== ipatch 4 ====
This patch allows backing up and restoring strapping options for warmboot.

<syntaxhighlight lang="c">
u32 APBDEV_PMC_SCRATCH0_0 = 0x7000E450;
u32 APBDEV_PMC_RST_STATUS_0 = 0x7000E5B4;
u32 APBDEV_PMC_SEC_DISABLE8_0 = 0x7000E9C0;
u32 APBDEV_PMC_SECURE_SCRATCH111_0 = 0x7000EF14;
u32 APB_MISC_PP_STRAPPING_OPT_A_0 = 0x70000008;

u32 reset_status = *(u32 *)APBDEV_PMC_RST_STATUS_0;

// Check for regular power on
if (reset_status == 0)
{
// Set all buttons in RCM_STRAPS and backup to PMC scratch
*(u32 *)APBDEV_PMC_SECURE_SCRATCH111_0 = (*(u32 *)APB_MISC_PP_STRAPPING_OPT_A_0 | 0x1C00);
}
else
{
// Restore strapping options from PMC scratch
*(u32 *)APB_MISC_PP_STRAPPING_OPT_A_0 = *(u32 *)APBDEV_PMC_SECURE_SCRATCH111_0;
}

// Disable write access to APBDEV_PMC_SECURE_SCRATCH111_0
*(u32 *)APBDEV_PMC_SEC_DISABLE8_0 |= 0x4000;

return *(u32 *)APBDEV_PMC_SCRATCH0_0;
</syntaxhighlight>

==== ipatch 5 ====
This patch adjusts USB configurations.

<syntaxhighlight lang="c">
u32 USB1_UTMIP_HSRX_CFG0_0 = 0x7D000810;
u32 USB1_UTMIP_BIAS_CFG2_0 = 0x7D000850;

// Clear UTMIP_IDLE_WAIT, UTMIP_ELASTIC_LIMIT and UTMIP_PCOUNT_UPDN_DIV,
// and set UTMIP_IDLE_WAIT to 0x11 and UTMIP_ELASTIC_LIMIT to 0x10
*(u32 *)USB1_UTMIP_HSRX_CFG0_0 = ((*(u32 *)USB1_UTMIP_HSRX_CFG0_0 & ~(0xF8000) + 0x88000 & ~(0x7C00) + 0x4000) & ~(0xF000000));

// Clear UTMIP_HSSQUELCH_LEVEL_NEW
*(u32 *)USB1_UTMIP_BIAS_CFG2_0 &= ~(0x07);

return;
</syntaxhighlight>

==== ipatch 6 ====
This patch is a factory backdoor.

It allows controlling the debug authentication configuration using a fuse.

<syntaxhighlight lang="c">
u32 FUSE_DEBUG_AUTH_OVERRIDE = 0x7000FA9C;

u32 debug_auth_override_val = *(u32 *)FUSE_DEBUG_AUTH_OVERRIDE;
debug_auth_override_val = ((debug_auth_override_val >> 0x08) << 0x01);

// Override debug authentication value stored in IRAM
*(u32 *)0x400028E4 &= ~(debug_auth_override_val);

/*
Untranslated instructions:

CMP R0, #0
*/

return;
</syntaxhighlight>

==== ipatch 7 ====
This patch is a bugfix.

It prevents overflowing IRAM (0x40010000) when copying the warmboot binary from DRAM.

<syntaxhighlight lang="c">
u32 APBDEV_PMC_CNTRL_0 = 0x7000E400;

u32 warmboot_header_addr = 0x400049F0;
u32 warmboot_bin_size = *(u32 *)warmboot_bin_header_addr;

// Invalid warmboot binary size
if (warmboot_size >> 0x11)
{
// Assert MAIN_RST
// 0x40004BF0 comes from R4 and the bootrom doesn't bother to change it
*(u32 *)APBDEV_PMC_CNTRL_0 = 0x40004BF0;

// Deadlock
while(1);
}

/*
Untranslated instructions:

LDR R0, =0x40010000
LDR R2, [warmboot_bin_header_addr]
*/

return;
</syntaxhighlight>

==== ipatch 8 ====
This patch is a bugfix.

It sets the correct warmboot binary entrypoint address for RSA signature verification, which would be done in DRAM instead of IRAM without this patch.

<syntaxhighlight lang="c">
u32 warmboot_addr_ptr = 0x40010238;
u32 warmboot_entry_addr_ptr = 0x40004C28;

*(u32 *)warmboot_entry_addr_ptr = *(u32 *)warmboot_addr_ptr;

/*
Untranslated instructions:

LDR R2, [warmboot_addr_ptr]
*/

return;
</syntaxhighlight>

==== ipatches 9 and 10 ====
These patches modify the 256-bit Secure Provisioning AES key with index 0x3A.

==== ipatch 11 ====
This patch pertains to the [[Security_Engine|Security Engine]] context restore process and forces SE_OPERATION_UNK1 to be 0x01.

== Anti-downgrade ==
The first bootloader verifies [[#FUSE_RESERVED_ODM7|FUSE_RESERVED_ODM7]] to prevent downgrading.
How many fuses are expected to be burnt depends the device's unit type as below.

{| class="wikitable" border="1"
|-
! System version
! Expected number of burnt fuses (retail)
! Expected number of burnt fuses (non-retail)
|-
| 1.0.0
| 1
| 0
|-
| 2.0.0-2.3.0
| 2
| 0
|-
| 3.0.0
| 3
| 1
|-
| 3.0.1-3.0.2
| 4
| 1
|-
| 4.0.0-4.1.0
| 5
| 1
|-
| 5.0.0-5.1.0
| 6
| 1
|-
| 6.0.0-6.1.0
| 7
| 1
|-
| 6.2.0
| 8
| 1
|-
| 7.0.0-7.0.1
| 9
| 1
|}

If too many fuses are burnt the bootloader will panic immediately.

If too few are burnt, the bootloader will enable fuse programming and write the expected value to fuse indexes 0x3A and 0x3C. Afterwards, fuse programming is disabled and the panic value 0x21 is written to PMC_SCRATCH200 register (0x7000EC40). Finally, the watchdog timer is initialized and programmed to force a reset.

On a subsequent boot, after the anti-downgrade fuses are checked again, the PMC_RST_STATUS register (0x7000E5B4) is checked and if set to 0x01 (watchdog reset) the PMC_SCRATCH200 register (0x7000EC40) will be checked for the panic value 0x21.
PMC_RST_STATUS will only be set back to 0 (power on reset) if the fuse count matches the new expected value, otherwise the system will panic.

TRM

2019-02-13T01:04:27Z

Adubbz: Added TRM redirect, so it shows up in search results properly

#REDIRECT [[Tegra-X1]]

NCM services

2019-02-11T07:03:30Z

Adubbz: Make unofficial ILocationResolver names consistent with official names

NCM contains services for internal file path and content management.

= Location Resolver services =
== lr ==
This is "nn::lr::ILocationResolverManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || OpenLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 1 || OpenRegisteredLocationResolver || None ||
|-
| 2 || RefreshLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 3 || [2.0.0+] OpenAddOnContentLocationResolver || None ||
|}

The only sysmodules which use this service are [[Filesystem_services|FS]], [[Loader_services|Loader]], and [[NS_Services|NS]]. [[boot2]] has access but doesn't use it.

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

{| class="wikitable" border="1"
|-
! 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+] [[#RedirectProgramPath2]]
|-
| 11 || [5.0.0+] [[#Refresh2]]
|-
| 12 || [5.0.0+] [[#DeleteProgramPath]]
|-
| 13 || [5.0.0+] [[#DeleteApplicationControlPath]]
|-
| 14 || [5.0.0+] [[#DeleteApplicationHtmlDocumentPath]]
|-
| 15 || [5.0.0+] [[#DeleteApplicationLegalInformationPath]]
|-
| 16 || [7.0.0+] ? (Takes a total of 8-bytes of input and a type-0x1A output buffer, no output)
|-
| 17 || [7.0.0+] ? (Takes a total of 8-bytes of input and a type-0x19 input buffer, no output)
|-
| 18 || [7.0.0+] ? (Takes a total of 8-bytes of input and a type-0x19 input buffer, no output)
|-
| 19 || [7.0.0+] ? (Takes a total of 8-bytes of input, no output)
|}

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

The Get* commands load the [[Filesystem_services|ContentPath]] from linked-lists' [[#Location_List_Entry|entries]] in memory using the input TitleID. When the command fails to find an entry for the specified TitleID, 0x408 is returned for GetProgramNcaPath 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 u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

==== RedirectProgramPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 0.

==== ResolveApplicationControlPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== ResolveApplicationHtmlDocumentPath====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

==== ResolveDataPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== RedirectApplicationControlPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== RedirectApplicationHtmlDocumentPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ResolveApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

==== RedirectApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== Refresh ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 0.

==== RedirectProgramPath2 ====
Same as [[#RedirectProgramPath|RedirectProgramPath]], but inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== Refresh2 ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 1.

==== DeleteProgramPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== DeleteApplicationControlPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== DeleteApplicationHtmlDocumentPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== DeleteApplicationLegalInformationPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

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

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 title ID at a time.

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveProgramPath || u64 TitleID + C descriptor || Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
|-
| 1 || RegisterProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 0 fallback TID and path to the provided arguments.
|-
| 2 || UnregisterProgramPath || u64 TitleID || If the Type 0 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 3 || RedirectProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|-
| 4 || [2.0.0+] ResolveHtmlDocumentPath || u64 TitleID + C descriptor ||
|-
| 5 || [2.0.0+] RegisterHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 1 fallback TID and path to the provided arguments.
|-
| 6 || [2.0.0+] UnregisterHtmlDocumentPath || u64 TitleID || If the Type 1 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 7 || [2.0.0+] RedirectHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|-
| 8 || [7.0.0+] ? || No input/output. ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveAddOnContentPath || u64 TitleID + C descriptor ||
|-
| 1 || RegisterAddOnContentStorage || [[Filesystem_services#StorageId|StorageID]] + u64 TitleID ||
|-
| 2 || UnregisterAllAddOnContentPath || None || Clears all registered titles here.
|}

=== Location List Entry ===
Total size is 0x320 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8|| Pointer to previous entry
|-
| 0x8 || 0x8|| Pointer to next entry
|-
| 0x10 || 0x8|| TitleID
|-
| 0x18 || 0x300 || [[Filesystem_services|ContentPath]]
|-
| 0x318 || 0x4 || Flag
|-
| 0x31C || 0x4 || Padding
|}

= Content Manager services =
== ncm ==
This is "nn::ncm::IContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || CreateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 1 || CreateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 2 || VerifyContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 3 || VerifyContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 4 || OpenContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 5 || OpenContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 6 || [1.0.0] CloseContentStorageForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentStorage->CloseAndFlushStorage().
|-
| 7 || [1.0.0] CloseContentMetaDatabaseForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentMetaDatabase->CloseMetaDatabase().
|-
| 8 || CleanupContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and deletes the associated savedata.
|-
| 9 || [2.0.0+] ActivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentStorage for the StorageID to be gotten with GetIContentStorage. Note: Name is not official.
|-
| 10 || [2.0.0+] InactivateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentStorage. Note: Name is not official.
|-
| 11 || [2.0.0+] ActivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentMetaDatabase for the StorageID to be gotten with GetIContentMetaDatabase. Note: Name is not official.
|-
| 12 || [2.0.0+] InactivateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentMetaDatabase. Note: Name is not official.
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GeneratePlaceHolderId]] || Returns a random UUID for the Content Storage.
|-
| 1 || CreatePlaceHolder || Takes two [[#NcaID]]s, and a u64 filesize.
|-
| 2 || DeletePlaceHolder || Takes a [[#NcaID]].
|-
| 3 || HasPlaceHolder || Takes a [[#NcaID]].
|-
| 4 || WritePlaceHolder || Takes a [[#NcaID]], a u64-offset, and type 5 buffer. Writes the buffer to the file for the NcaID's placeholder path at the specified offset.
|-
| 5 || Register || Takes two [[#NcaID]]s, moves the Placeholder NCA content to the registered NCA path.
|-
| 6 || Delete || Takes a [[#NcaID]].
|-
| 7 || Has || Takes a [[#NcaID]].
|-
| 8 || GetPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 9 || GetPlaceHolderPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 10 || CleanupAllPlaceHolder || Deletes and re-creates the Placeholder directory.
|-
| 11 || ListPlaceHolder || This is like [[#GetNumberOfRegisteredEntries]], but for the Placeholder directory.
|-
| 12 || [[#GetContentCount]] ||
|-
| 13 || [[#ListContentId]] ||
|-
| 14 || [[#GetSizeFromContentId]] ||
|-
| 15 || DisableForcibly || Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.
|-
| 16 || [2.0.0+] RevertToPlaceHolder || Takes three 0x10-sized [[#NcaID]]s. Creates the registered directory NCA path, and renames the placeholder path to the registered NCA path.
|-
| 17 || [2.0.0+] SetPlaceHolderSize || Takes a [[#NcaID]], and a u64 size
|-
| 18 || [2.0.0+] [[#ReadContentIdFile]] ||
|-
| 19 || [2.0.0+] GetRightsIdFromPlaceHolderId || Gets the Rights ID for the [[#NcaID]]'s placeholder path.
|-
| 20 || [2.0.0+] GetRightsIdFromContentId || Gets the Rights ID for the [[#NcaID]]'s registered path
|-
| 21 || [2.0.0+] WriteContentForDebug || Takes a [[#NcaID]], a u64 offset, and a type 5 buffer. On debug units, writes the buffer to the NCA's registered path. On retail units, this just aborts.
|-
| 22 || [2.0.0+] GetFreeSpaceSize || Gets free space for the storage.
|-
| 23 || [2.0.0+] GetTotalSpaceSize || Gets total space for the storage.
|-
| 24 || [3.0.0+] FlushPlaceHolder || Flushes resources for the storage without closing it.
|-
| 25 || [4.0.0+] GetSizeFromPlaceHolderId ||
|-
| 26 || [4.0.0+] RepairInvalidFileAttribute ||
|}

==== GeneratePlaceHolderId ====
Generates a random [[#NcaID]] for use as a placeholder.

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

==== GetContentCount ====
Writes the total number of entries which can be read by GetEntries, to cmdreply <SFCO_offset>+0x10.

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

Each entry is a [[#NcaID]].

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 [[#NcaID]] as input.

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

==== ReadContentIdFile ====
Takes an output buffer, a [[#NcaID]] as input, and a u64 file offset.

Reads plaintext NCA file contents from the Registered path for the NcaID.

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

Note the official name for Meta Record is "ContentMetaKey".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Set || Takes a [[NCA#Meta_records|Meta Record]], a type-5 [[NCA#Content_records|Content Records]] buffer and a u64 size.
|-
| 1 || Get || Takes a [[NCA#Meta_records|Meta Record]], a type-6 buffer to write [[NCA#Content_records|Content Records]] 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 meta records. Set takes this same data as input.
|-
| 2 || Remove || Takes a [[NCA#Meta_records|Meta Record]], and removes the associated record.
|-
| 3 || GetContentIdByType || Takes a [[NCA#Meta_records|Meta Record]] and a u8 [[#Title_Types|Title Type]]. Returns a [[#NcaID]].
|-
| 4 || ListContentInfo || Takes a type-6 buffer to write [[NCA#Content_records|Content Record]] entries to, a [[NCA#Meta_records|Meta Record]], and a u32 index into the Content Record entries to start copying from. Returns a u32 entries_read.
|-
| 5 || List || Takes a type-6 buffer to write [[NCA#Meta_records|Meta Record]]s to, a u32 [[#Title_Types|Title Type]], a u64 TID, a u64 TID_LOW, and u64 TID_HIGH. Writes into the buffer all Meta Records with low <= record->title_id <= high, and record->type == type. Returns u32 numEntriesTotal, numEntriesWritten. 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.
|-
| 6 || GetLatestContentMetaKey || Takes a u64 title id, and returns the [[NCA#Meta_records|Meta Record]] with the highest version field for that title id.
|-
| 7 || [[#ListApplication]] ||
|-
| 8 || Has || Takes a [[NCA#Meta_records|Meta Record]] and returns whether that record is present in the database.
|-
| 9 || HasAll || Takes a type-5 buffer containing [[NCA#Meta_records|Meta Records]] (code assumes there are size/sizeof(meta_record) records in the buffer), and returns whether all of those records are present in the database.
|-
| 10 || GetSize || Takes a [[NCA#Meta_records|Meta Record]], and returns the size of the associated [[NCA#Content_records|Content Records]].
|-
| 11 || GetRequiredSystemVersion || Takes a [[NCA#Meta_records|Meta Record]], and returns u32 from ContentRecords + 16 (only if the Meta record has type Application or Patch).
|-
| 12 || GetPatchId || Takes a [[NCA#Meta_records|Meta Record]], and returns the update title id for that record.
|-
| 13 || DisableForcibly || Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.
|-
| 14 || [[#LookupOrphanContent]] || Takes a type-6 byte buffer, and a type-5 buffer of [[#NcaID]]s.
|-
| 15 || Commit || Flushes the in-memory database to savedata.
|-
| 16 || HasContent || Takes a [[NCA#Meta_records|Meta Record]] and an [[#NcaID]]. Returns whether the content records for that meta record contain the NcaID.
|-
| 17 || ListContentMetaInfo || Takes a type-6 [[NCA#Meta_records|Meta Record]] output buffer, a u32 eoffset into that buffer, and an input [[NCA#Meta_records|Meta Record]].
|-
| 18 || GetAttributes || Takes a [[NCA#Meta_records|Meta Record]], and returns u8 from ContentRecords + 6.
|-
| 19 || [2.0.0+] GetRequiredApplicationVersion || Does the same thing as GetEntryUnknownRecordSize, but for AddOnContents.
|-
| 20 || [5.0.0+] GetContentIdByTypeAndIdOffset ||
|}

==== ListApplication ====
Each 24-byte entry (officially "ApplicationContentMetaKey") is as follows:
[[NCA#Meta_records|meta_record]] meta_record;
u64 base_title_id;

This function takes in a type 6 buffer to write entries to, and a u8 "filter" [[#Title_Types|type]]. 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 u32 num_entries_total, and a u32 num_entries_written.

==== ReadEntryMetaRecords ====
Takes a type-6 [[NCA#Meta_records|Meta Record]] output buffer, a u32 eoffset into that buffer, and an input [[NCA#Meta_records|Meta Record]] entry. Returns a u32 for total_read_entries.

Reads the meta records stored in the entry's content records into the output buffer.

This is used, for example, with System Update title 0100000000000816, which contains Meta Records for all other systitles in its Content Records.

==== LookupOrphanContent ====
Takes a type-6 byte buffer, and a type-5 buffer containing [[#NcaID]]s.

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 [[#NcaID]] in the input buffer, it checks if that NcaID 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, NcaID in NcaIDs:
if is_present_in_database(NcaID):
out_buf[i] = 0

=== NcaID ===
This is a 0x10-byte entry. This is originally from the hex portion of "<hex>.nca" directory-names from this storage FS(like [[SD_Filesystem|SD]]). This is also referred to as "ContentId" in the official SDK.

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

=== Enums ===
==== Title Types ====

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x01
| SystemProgram ([[Title_list#System_Modules|System Modules]] or [[Title_list#System_Applets|System Applets]])
|-
| 0x02
| SystemData ([[Title_list#System_Data_Archives|System Data Archives]])
|-
| 0x03
| SystemUpdate
|-
| 0x04
| BootImagePackage ([[Title_list|Firmware package A or C]])
|-
| 0x05
| BootImagePackageSafe ([[Title_list|Firmware package B or D]])
|-
| 0x80
| Application
|-
| 0x81
| Patch
|-
| 0x82
| AddOnContent
|-
| 0x83
| Delta
|}

== ncm:v ==
This service doesn't normally exist on retail.

[[Category:Services]]

USB services

2018-10-27T04:09:44Z

Adubbz: This shouldn't have been changed

One symbol in USB-sysmodule is: "vtable for nn::usb::detail::UsbComplexTegra21x".

= usb:ds =
This is "nn::usb::ds::IDsService".

Used for Switch<>PC USB comms, aka Switch-as-device. This seems to only be usable in handheld-mode with the Switch directly connected to a host via an USB cable, not(?) in docked-mode.
This service is used during [[Factory Setup|factory setup]] by [[Manu Services|manu]].

This service session is used as an IPC [[IPC_Marshalling|domain]] by [[Manu Services|manu]]. All of these {get-session} commands also return an output u8 and the u32 [[IPC_Marshalling|domainID]], for using those sessions as domains.

This service can be used by multiple processes at the same time, with separate interfaces. However, if one process does usbds shutdown, usbds will reset to defaults even if there's a process still using it.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#BindDevice]]
|-
| 1 || [[#BindClientProcess]]
|-
| 2 || [[#GetDsInterface]]
|-
| 3 || [[#GetStateChangeEvent]]
|-
| 4 || [[#GetState]]
|-
| [2.0.0-4.1.0] 5 || [[#SetVidPidBcd]]
|-
| [5.0.0+] 5 || ClearDeviceData
|-
| 6 || [5.0.0+] AddUsbStringDescriptor
|-
| 7 || [5.0.0+] DeleteUsbStringDescriptor
|-
| 8 || [5.0.0+] SetUsbDeviceDescriptor
|-
| 9 || [5.0.0+] SetBinaryObjectStore
|-
| 10 || [5.0.0+] Enable
|-
| 11 || [5.0.0+] Disable
|}

Initialization done by [[Manu Services|manu]]:
* Initial service init:
** Get service/etc.
** Uses [[#BindDevice]].
** Uses [[#BindClientProcess]].
** Uses [[#GetStateChangeEvent]].
** Uses [[#SetVidPidBcd]].
* Interface init:
** Uses [[#GetDsInterface]], then uses commands from that with the rest of the following.
** Uses [[#GetSetupEvent]].
** Uses [[#GetCtrlInCompletionEvent]].
** Uses [[#GetCtrlOutCompletionEvent]].
* Initializes two endpoints via using [[#GetDsEndpoint]] twice.

== Configuration ==
The following is the default USB config strings, while the usbds service isn't being used. All of the below configuration will reset to the defaults when all usbds-related sessions are closed. These can be set with [[#SetVidPidBcd]]. The default string for Product is loaded from [[Settings_services|settings]] config. The default is referred to by usb-sysmodule as "Dummy".
Product: Nintendo Switch
Manufacturer: Nintendo
SerialNumber: SerialNumber

The following is the default <code>lsusb -v {...}</code> output when the usbds service wasn't used.

The endpoints are configured using [[#GetDsEndpoint]], the total number of endpoints is the number of open [[#IDsEndpoint]] sessions. bInterfaceNumber is {0-based index for the enabled [[#IDsInterface]] session.} Some of the interface fields are configured using [[#GetDsInterface]].

Additional descriptors for use with interfaces and endpoints can't be configured with usbds, even though the former is used for the default HID interface. This seems to be the main(?) restriction with using usbds for Switch-as-arbitrary-devices. The device class fields can't be configured, interface class fields are set instead.

When usbds is in use where [[#SetVidPidBcd]] wasn't used, the VID/PID is 057e:3000.

Bus 003 Device 006: ID 057e:2000 Nintendo Co., Ltd
Couldn't open device, some information will be missing
Device Descriptor:
bLength 18
bDescriptorType 1
bcdUSB 2.00
bDeviceClass 0 (Defined at Interface level)
bDeviceSubClass 0
bDeviceProtocol 0
bMaxPacketSize0 64
idVendor 0x057e Nintendo Co., Ltd
idProduct 0x2000
bcdDevice 1.00
iManufacturer 1
iProduct 2
iSerial 3
bNumConfigurations 1
Configuration Descriptor:
bLength 9
bDescriptorType 2
wTotalLength 34
bNumInterfaces 1
bConfigurationValue 1
iConfiguration 0
bmAttributes 0xc0
Self Powered
MaxPower {...}
Interface Descriptor:
bLength 9
bDescriptorType 4
bInterfaceNumber 0
bAlternateSetting 0
bNumEndpoints 1
bInterfaceClass 3 Human Interface Device
bInterfaceSubClass 0 No Subclass
bInterfaceProtocol 0 None
iInterface 0
HID Device Descriptor:
bLength 9
bDescriptorType 33
bcdHID 2.00
bCountryCode 0 Not supported
bNumDescriptors 1
bDescriptorType 34 Report
wDescriptorLength 26
Report Descriptors:
** UNAVAILABLE **
Endpoint Descriptor:
bLength 7
bDescriptorType 5
bEndpointAddress 0x81 EP 1 IN
bmAttributes 3
Transfer Type Interrupt
Synch Type None
Usage Type Data
wMaxPacketSize 0x0001 1x 1 bytes
bInterval 16

== BindDevice ==
Takes an u32 ('''complexId'''). [[Manu_Services|Manu]] sends 0x02.

Binding more than once with the current session is not allowed. Once this command is used, the USB device will not be listed with <code>lsusb</code> until [[#EnableInterface]] is used.

Returns a not-found error when complexId isn't 0x02, for values 0x0-0x4 at least.

== BindClientProcess ==
Takes 1 copy-handle for the current process (0xFFFF8001).

== GetDsInterface ==
Takes 2 type-5 buffers and returns an [[#IDsInterface]]. [[Manu_Services|Manu]] sends a 0x09-byte command (e.g.: 0x09, 0x04, 0x04, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0x00) in the first buffer and a string ("usb") in the second buffer.

When the strlen output for the second buffer is >=0x40, size 0x40 is used instead for copying the string. This is the interface name, it's not sent over USB.

Returns an error when [[#BindDevice]] wasn't used.

Up to 4 interfaces can be used+[[#EnableInterface|enabled]].

Structure of the first buffer(this is the same as [http://libusb.sourceforge.net/api-1.0/structlibusb__interface__descriptor.html libusb__interface__descriptor]):
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || bLength. Must match 0x9.
|-
| 0x1 || 0x1 || bDescriptorType. Must match 0x4.
|-
| 0x2 || 0x1 || bInterfaceNumber. When 0x4, the bInterfaceNumber is automatically allocated(error will be thrown if no space). Otherwise, it's used directly and must be <=3.
|-
| 0x3 || 0x1 || bAlternateSetting. Must match 0x0.
|-
| 0x4 || 0x1 || bNumEndpoints. Ignored.
|-
| 0x5 || 0x1 || bInterfaceClass
|-
| 0x6 || 0x1 || bInterfaceSubClass
|-
| 0x7 || 0x1 || bInterfaceProtocol
|-
| 0x8 || 0x1 || iInterface. Ignored.
|}

Only the first 0x9-bytes are used.

== GetStateChangeEvent ==
Returns an event handle for when the state returned by [[#GetState]] changes. Signalled when Switch<->host USB comms change between started/stopped. USB cable connected/disconnected while at least 1 interface was enabled, or interface enabled/disabled while the USB cable was connected which then caused USB-comms state to change.

== GetState ==
No input. Returns an output u32. Returns an error when [[#BindDevice]] wasn't used.

Returns the current state. Values:
* 0: Initial state.
* 6: Device init starting.
* 3: {Initialization}, previous state is 6.
* 4: {Initialization}, previous state is 3.
* 5: Initialization done, data-transfer is now available.

== SetVidPidBcd ==
Takes a type-5 buffer with 0x66 bytes of USB descriptor data (see [[Manu_Services#manu|manu]]).

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x2 || VID (idVendor)
|-
| 0x2 || 0x2 || PID (idProduct)
|-
| 0x4 || 0x2 || bcdDevice
|-
| 0x6 || 0x20 || Manufacturer
|-
| 0x26 || 0x20 || Product
|-
| 0x46 || 0x20 || SerialNumber
|}

The last 3 blocks are ASCII strings. The data following each string is all-zero, for padding to size 0x20.

== IDsInterface ==
This is "nn::usb::ds::IDsInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetDsEndpoint]] ||
|-
| 1 || [[#GetSetupEvent]] ||
|-
| 2 || || Takes a type-0x6 output buffer, no other output. Memcpys data to outbuf with outsize, uses size 0x8 if outsize is too large.
|-
| 3 || [[#EnableInterface]] ||
|-
| 4 || [[#DisableInterface]] ||
|-
| 5 || [[#CtrlInPostBufferAsync]] ||
|-
| 6 || [[#CtrlOutPostBufferAsync]] ||
|-
| 7 || [[#GetCtrlInCompletionEvent]] ||
|-
| 8 || [[#GetCtrlInReportData]] ||
|-
| 9 || [[#GetCtrlOutCompletionEvent]] ||
|-
| 10 || [[#GetCtrlOutReportData]] ||
|-
| 11 || [[#StallCtrl]] ||
|-
| 12 || [5.0.0+] AppendConfigurationData ||
|}

Commands cmd2, [[#CtrlInPostBufferAsync]], [[#CtrlOutPostBufferAsync]], and [[#StallCtrl]], will throw an error if the interface is not [[#EnableInterface|enabled]]. [[#GetDsEndpoint]] will throw an error if the interface is [[#EnableInterface|enabled]].

=== GetDsEndpoint ===
Takes a type-5 buffer and returns an [[#IDsEndpoint]]. [[Manu_Services|Manu]] uses this twice for getting two endpoint sessions, with the following 0x7-byte buffer data:
* First endpoint: 0x07, 0x05, 0x80, 0x02, 0x00, 0x02, 0x00
** bLength=0x7
** bDescriptorType=LIBUSB_DT_ENDPOINT
** bEndpointAddress=LIBUSB_ENDPOINT_IN
** bmAttributes=LIBUSB_TRANSFER_TYPE_BULK
** wMaxPacketSize=0x200
** bInterval=0
* Second endpoint: Same as above except byte2 is 0x00(bEndpointAddress=LIBUSB_ENDPOINT_OUT).

Each field is an u8, except for offset 0x4-0x5 which is an u16.

This structure matches [http://libusb.sourceforge.net/api-1.0/structlibusb__endpoint__descriptor.html libusb_endpoint_descriptor], with audio-only-devices fields bRefresh and bSynchAddress removed.

The buffer size must be >=0x7. Only the first 0x7-bytes from the buffer are used.
* Byte0(bLength) must match 0x7.
* Byte1(bDescriptorType) must match 0x5.
* Byte2(bEndpointAddress) is only compared with 0x80 to determine whether to use an input or output endpoint, the actual endpoint-number is allocated automatically by checking state. Hence, all input endpoints must use bEndpointAddress==0x80. Up to endpoint-number 0xF can be allocated for each endpoint-direction, for a total of 16 endpoints including control, and 15 for non-control endpoints([[#IDsEndpoint]] sessions for each direction). This matches the Tegra maximum.

From the Tegra datasheet: "The maximum packet size supported on any endpoint is 1024 bytes in high-speed mode, for both device and host modes."

=== GetSetupEvent ===
Returns an event handle. Unknown what triggers signalling, not signalled during interface-enable / device<>host USB-comms init.

=== EnableInterface ===
Takes no arguments. Enables the current interface.

Only one interface can be enabled at a time per bInterfaceNumber. When bInterfaceNumber is auto-allocate(0x4) for [[#GetDsEndpoint]] this isn't an issue since the final bInterfaceNumber will be unique.

Once enabled, the device/interface can then actually be used over USB.

=== DisableInterface ===
Takes no arguments. Disables the current interface.

=== CtrlInPostBufferAsync ===
Same as [[#PostBufferAsync]](with same input/output), except this uses control input endpoint 0x80.

=== CtrlOutPostBufferAsync ===
Same as [[#PostBufferAsync]](with same input/output), except this uses control output endpoint 0x00.

=== GetCtrlInCompletionEvent ===
Returns an event handle for polling the completion of input control commands. Same as [[#GetCompletionEvent]], except this uses control input endpoint 0x80.

=== GetCtrlInReportData ===
Same as [[#GetReportData]](with same input/output), except this uses control input endpoint 0x80.

=== GetCtrlOutCompletionEvent ===
Returns an event handle for polling the completion of output control commands. Same as [[#GetCompletionEvent]], except this uses control output endpoint 0x00.

=== GetCtrlOutReportData ===
Same as [[#GetReportData]](with same input/output), except this uses control output endpoint 0x00.

=== StallCtrl ===
No input/output.

Calls a function with both control endpoints(0x80 and 0x00) with the same function. From strings: "m_pProtocol->Stall(0x80)" "m_pProtocol->Stall(0x00)".

=== IDsEndpoint ===
This is "nn::usb::ds::IDsEndpoint".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#PostBufferAsync]] ||
|-
| 1 || || No input/output.
|-
| 2 || [[#GetCompletionEvent]] ||
|-
| 3 || [[#GetReportData]] ||
|-
| 4 || [[#Stall]] ||
|-
| 5 || || Takes an input u8, no output.
|}

==== PostBufferAsync ====
Takes an u32 ('''size''') and an u64 ('''buffer'''). Returns an output u32 ('''urbId'''). The output urbId can then be used while parsing the output of [[#GetReportData]], after waiting for the CompletionEvent to be signalled.

The buffer address must be 0x1000-byte aligned. The input size doesn't matter. It helps to use svcSetMemoryAttribute to turn off caching on the buffer.

Used for data-transfer with input/output endpoints.

The user-process must flush dcache for the buffer before using this command.

When sending data where size is larger than wMaxPacketSize, it will automatically send multiple USB packets where last packet size = {remaining size}. Every {wMaxPacketSize}-bytes is a different packet. This only occurs in some cases. When '''size''' is ~0x1000000(exact size unknown), Switch-side silently hangs, while host-side will timeout(no traffic on USB bus indicating failure).

For receiving data, if size is less than {actual received USB packet size} the rest of the packet will be discarded. Later PostBufferAsync cmd(s) will only return data from new packets, not the remainder of the earlier packet(s).

==== GetCompletionEvent ====
No input. Returns an output event handle for polling the completion of [[#PostBufferAsync]], even when it finished via [[#Stall]].

==== GetReportData ====
No input. Returns 0x84 bytes of report data from the endpoint. Seems to be eventually loaded from state, since this doesn't trigger any USB bus activity. All-zero before PostBufferAsync was used at least once.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x10*0x8(0x80) || 0x8 entries 0x10-bytes each for each report.
|-
| 0x80 || 0x4 || u32 report count
|}

Entry data:
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || u32 id (urbId from post-buffer commands)
|-
| 0x4 || 0x4 || u32 requestedSize
|-
| 0x8 || 0x4 || u32 transferredSize
|-
| 0xC || 0x4 || u32 urb status, converted to error-codes. 0x3 = success, 0x4 = 0x828c, 0x5 = 0x748c. All other values are invalid.
|-
|}

==== Stall ====
No input/output.

Calls the same function used by [[#StallCtrl]], except this uses the endpoint associated with the current session.

Stops in-progress data-transfer done by [[#PostBufferAsync]].

= usb:hs =
This is "nn::usb::hs::IClientRootSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#BindClientProcess_2|#BindClientProcess]]
|-
| 1 || [[#QueryAllInterfaces]]
|-
| 2 || [[#QueryAvailableInterfaces]]
|-
| 3 || [[#QueryAcquiredInterfaces]]
|-
| 4 || [[#CreateInterfaceAvailableEvent]]
|-
| 5 || [[#DestroyInterfaceAvailableEvent]]
|-
| 6 || [[#GetInterfaceStateChangeEvent]]
|-
| 7 || [[#AcquireUsbIf]]
|-
| 8 || [6.0.0+]
|}

General USB devices usage, used by [[Audio_services|audio]], [[HID_services|hid]] and [[Sockets_services|bsdsockets]].

== BindClientProcess ==
Takes 1 copy-handle for the current process (0xFFFF8001).

== QueryAllInterfaces ==
Takes a 0x10-byte input struct and a type-0x6 output buffer, returns an output u32.

== QueryAvailableInterfaces ==
Takes a 0x10-byte input struct and a type-0x6 output buffer, returns an output u32.

== QueryAcquiredInterfaces ==
Takes a type-0x6 output buffer and returns an output u32.

== CreateInterfaceAvailableEvent ==
Takes an input u8 and returns an output handle.

== DestroyInterfaceAvailableEvent ==
Takes an input u8, no output.

== GetInterfaceStateChangeEvent ==
No input, returns an output handle.

== AcquireUsbIf ==
Takes an input u32 and a type-0x6 output buffer, returns an [[#IClientIfSession]].

== IClientIfSession ==
This is "nn::usb::hs::IClientIfSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || || No input, returns an output handle.
|-
| 1 || [[#SetInterface]] ||
|-
| 2 || [[#GetInterface]] ||
|-
| 3 || [[#GetAlternateInterface]] ||
|-
| 4 || [[#GetCurrentFrame]] ||
|-
| 5 || [[#CtrlXferAsync]] ||
|-
| 6 || || No input, returns an output handle.
|-
| 7 || [[#GetCtrlXferReport]] ||
|-
| 8 || [[#ResetDevice]] ||
|-
| 9 || [[#OpenUsbEp]] ||
|}

=== SetInterface ===
Takes an input u8 and a type-0x6 output buffer, no output.

=== GetInterface ===
Takes a type-0x6 output buffer, no output.

=== GetAlternateInterface ===
Takes an input u8 and a type-0x6 output buffer, no output.

=== GetCurrentFrame ===
No input, returns an output u32.

=== CtrlXferAsync ===
Takes 2 input u8s and 3 input u16s, no output.

=== GetCtrlXferReport ===
Takes a type-0x6 output buffer, no output.

=== ResetDevice ===
No input/output.

=== OpenUsbEp ===
Takes an input u16 and 4 input u32s, returns a 0x7-byte output struct and an [[#IClientEpSession]].

=== IClientEpSession ===
This is "nn::usb::hs::IClientEpSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#Open]] ||
|-
| 1 || [[#Close]] ||
|-
| 2 || || No input, returns an output handle.
|-
| 3 || [[#Populate]] ||
|-
| 4 || [[#PostBufferAsync_2|#PostBufferAsync]] ||
|-
| 5 || [[#GetXferReport]] ||
|-
| 6 || || Takes 3 input u32s, 2 input u64s, and a type-0x5 input buffer, returns an output u32.
|-
| 7 || [4.0.0+] ||
|-
| 8 || [4.0.0+] ||
|}

==== Open ====
No input/output.

==== Close ====
No input/output.

==== Populate ====
No input/output.

==== PostBufferAsync ====
Takes an input u32 and 2 input u64s, returns an output u32.

==== GetXferReport ====
Takes an input u32 and a type-0x6 output buffer, returns an output u32.

= usb:pd =
This is "nn::usb::pd::detail::IPdManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetPdSession
|}

Only system-titles with access to this are [[PTM_services|ptm]] and [[AM_services|am]].

== IPdSession ==
This is "nn::usb::pd::detail::IPdSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || BindNoticeEvent
|-
| 1 ||
|-
| 2 || GetStatus
|-
| 3 || GetNotice
|-
| 4 ||
|-
| 5 ||
|-
| 6 || ReplyPowerRequest
|}

= usb:pd:c =
This is "nn::usb::pd::detail::IPdCradleManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetPdCradleSession || Returns a session handle for the below.
|}

USB-sysmodule symbols for this refer to "Cradle", which is the [[Dock]].

== IPdCradleSession ==
This is "nn::usb::pd::detail::IPdCradleSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || VdmUserWrite || Input { u32 value; u32 VdmUserId; }. Output {}.
If Cradle or RelayBox is connected, issues given VDM with value.
|-
| 1 || VdmUserRead || Input { u32 VdmUserId; }. Output { u32 value; }.
If Cradle or RelayBox is connected, returns u32 response from issuing given VDM.
|-
| 2 || Vdm20Init || No input/output.
If Cradle or RelayBox is connected, caches result of VDM 0x20.
|-
| 3 || GetFwType || No input. Returns an output u16.
|-
| 4 || GetFwRevision || No input. Returns an output u16.
|-
| 5 || GetManufacturerId || No input. Returns an output u16.
|-
| 6 || GetDeviceId || No input. Returns an output u16.
|-
| 7 || [3.0.0+] ||
|-
| 8 || [3.0.0+] ||
|}

Note: The VdmUserId given to VdmUserRead/VdmUserWrite is translated from the given (enum) value to the actual cmd to send.

= usb:pm =
This is "nn::usb::pm::IPmService".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 ||
|}

USB Port Manager, only system-title using this is [[PTM_services|ptm]].

[[Category:Services]]

USB services

2018-10-27T04:07:38Z

Adubbz: usb:hs is used by audio too

One symbol in USB-sysmodule is: "vtable for nn::usb::detail::UsbComplexTegra21x".

= usb:ds =
This is "nn::usb::ds::IDsService".

Used for Switch<>PC USB comms, aka Switch-as-device. This seems to only be usable in handheld-mode with the Switch directly connected to a host via an USB cable, not(?) in docked-mode.
This service is used during [[Factory Setup|factory setup]] by [[Manu Services|manu]].

This service session is used as an IPC [[IPC_Marshalling|domain]] by [[Manu Services|manu]]. All of these {get-session} commands also return an output u8 and the u32 [[IPC_Marshalling|domainID]], for using those sessions as domains.

This service can be used by multiple processes at the same time, with separate interfaces. However, if one process does usbds shutdown, usbds will reset to defaults even if there's a process still using it.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#BindDevice]]
|-
| 1 || [[#BindClientProcess]]
|-
| 2 || [[#GetDsInterface]]
|-
| 3 || [[#GetStateChangeEvent]]
|-
| 4 || [[#GetState]]
|-
| [2.0.0-4.1.0] 5 || [[#SetVidPidBcd]]
|-
| [5.0.0+] 5 || ClearDeviceData
|-
| 6 || [5.0.0+] AddUsbStringDescriptor
|-
| 7 || [5.0.0+] DeleteUsbStringDescriptor
|-
| 8 || [5.0.0+] SetUsbDeviceDescriptor
|-
| 9 || [5.0.0+] SetBinaryObjectStore
|-
| 10 || [5.0.0+] Enable
|-
| 11 || [5.0.0+] Disable
|}

Initialization done by [[Manu Services|manu]]:
* Initial service init:
** Get service/etc.
** Uses [[#BindDevice]].
** Uses [[#BindClientProcess]].
** Uses [[#GetStateChangeEvent]].
** Uses [[#SetVidPidBcd]].
* Interface init:
** Uses [[#GetDsInterface]], then uses commands from that with the rest of the following.
** Uses [[#GetSetupEvent]].
** Uses [[#GetCtrlInCompletionEvent]].
** Uses [[#GetCtrlOutCompletionEvent]].
* Initializes two endpoints via using [[#GetDsEndpoint]] twice.

== Configuration ==
The following is the default USB config strings, while the usbds service isn't being used. All of the below configuration will reset to the defaults when all usbds-related sessions are closed. These can be set with [[#SetVidPidBcd]]. The default string for Product is loaded from [[Settings_services|settings]] config. The default is referred to by usb-sysmodule as "Dummy".
Product: Nintendo Switch
Manufacturer: Nintendo
SerialNumber: SerialNumber

The following is the default <code>lsusb -v {...}</code> output when the usbds service wasn't used.

The endpoints are configured using [[#GetDsEndpoint]], the total number of endpoints is the number of open [[#IDsEndpoint]] sessions. bInterfaceNumber is {0-based index for the enabled [[#IDsInterface]] session.} Some of the interface fields are configured using [[#GetDsInterface]].

Additional descriptors for use with interfaces and endpoints can't be configured with usbds, even though the former is used for the default HID interface. This seems to be the main(?) restriction with using usbds for Switch-as-arbitrary-devices. The device class fields can't be configured, interface class fields are set instead.

When usbds is in use where [[#SetVidPidBcd]] wasn't used, the VID/PID is 057e:3000.

Bus 003 Device 006: ID 057e:2000 Nintendo Co., Ltd
Couldn't open device, some information will be missing
Device Descriptor:
bLength 18
bDescriptorType 1
bcdUSB 2.00
bDeviceClass 0 (Defined at Interface level)
bDeviceSubClass 0
bDeviceProtocol 0
bMaxPacketSize0 64
idVendor 0x057e Nintendo Co., Ltd
idProduct 0x2000
bcdDevice 1.00
iManufacturer 1
iProduct 2
iSerial 3
bNumConfigurations 1
Configuration Descriptor:
bLength 9
bDescriptorType 2
wTotalLength 34
bNumInterfaces 1
bConfigurationValue 1
iConfiguration 0
bmAttributes 0xc0
Self Powered
MaxPower {...}
Interface Descriptor:
bLength 9
bDescriptorType 4
bInterfaceNumber 0
bAlternateSetting 0
bNumEndpoints 1
bInterfaceClass 3 Human Interface Device
bInterfaceSubClass 0 No Subclass
bInterfaceProtocol 0 None
iInterface 0
HID Device Descriptor:
bLength 9
bDescriptorType 33
bcdHID 2.00
bCountryCode 0 Not supported
bNumDescriptors 1
bDescriptorType 34 Report
wDescriptorLength 26
Report Descriptors:
** UNAVAILABLE **
Endpoint Descriptor:
bLength 7
bDescriptorType 5
bEndpointAddress 0x81 EP 1 IN
bmAttributes 3
Transfer Type Interrupt
Synch Type None
Usage Type Data
wMaxPacketSize 0x0001 1x 1 bytes
bInterval 16

== BindDevice ==
Takes an u32 ('''complexId'''). [[Manu_Services|Manu]] sends 0x02.

Binding more than once with the current session is not allowed. Once this command is used, the USB device will not be listed with <code>lsusb</code> until [[#EnableInterface]] is used.

Returns a not-found error when complexId isn't 0x02, for values 0x0-0x4 at least.

== BindClientProcess ==
Takes 1 copy-handle for the current process (0xFFFF8001).

== GetDsInterface ==
Takes 2 type-5 buffers and returns an [[#IDsInterface]]. [[Manu_Services|Manu]] sends a 0x09-byte command (e.g.: 0x09, 0x04, 0x04, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0x00) in the first buffer and a string ("usb") in the second buffer.

When the strlen output for the second buffer is >=0x40, size 0x40 is used instead for copying the string. This is the interface name, it's not sent over USB.

Returns an error when [[#BindDevice]] wasn't used.

Up to 4 interfaces can be used+[[#EnableInterface|enabled]].

Structure of the first buffer(this is the same as [http://libusb.sourceforge.net/api-1.0/structlibusb__interface__descriptor.html libusb__interface__descriptor]):
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || bLength. Must match 0x9.
|-
| 0x1 || 0x1 || bDescriptorType. Must match 0x4.
|-
| 0x2 || 0x1 || bInterfaceNumber. When 0x4, the bInterfaceNumber is automatically allocated(error will be thrown if no space). Otherwise, it's used directly and must be <=3.
|-
| 0x3 || 0x1 || bAlternateSetting. Must match 0x0.
|-
| 0x4 || 0x1 || bNumEndpoints. Ignored.
|-
| 0x5 || 0x1 || bInterfaceClass
|-
| 0x6 || 0x1 || bInterfaceSubClass
|-
| 0x7 || 0x1 || bInterfaceProtocol
|-
| 0x8 || 0x1 || iInterface. Ignored.
|}

Only the first 0x9-bytes are used.

== GetStateChangeEvent ==
Returns an event handle for when the state returned by [[#GetState]] changes. Signalled when Switch<->host USB comms change between started/stopped. USB cable connected/disconnected while at least 1 interface was enabled, or interface enabled/disabled while the USB cable was connected which then caused USB-comms state to change.

== GetState ==
No input. Returns an output u32. Returns an error when [[#BindDevice]] wasn't used.

Returns the current state. Values:
* 0: Initial state.
* 6: Device init starting.
* 3: {Initialization}, previous state is 6.
* 4: {Initialization}, previous state is 3.
* 5: Initialization done, data-transfer is now available.

== SetVidPidBcd ==
Takes a type-5 buffer with 0x66 bytes of USB descriptor data (see [[Manu_Services#manu|manu]]).

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x2 || VID (idVendor)
|-
| 0x2 || 0x2 || PID (idProduct)
|-
| 0x4 || 0x2 || bcdDevice
|-
| 0x6 || 0x20 || Manufacturer
|-
| 0x26 || 0x20 || Product
|-
| 0x46 || 0x20 || SerialNumber
|}

The last 3 blocks are ASCII strings. The data following each string is all-zero, for padding to size 0x20.

== IDsInterface ==
This is "nn::usb::ds::IDsInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetDsEndpoint]] ||
|-
| 1 || [[#GetSetupEvent]] ||
|-
| 2 || || Takes a type-0x6 output buffer, no other output. Memcpys data to outbuf with outsize, uses size 0x8 if outsize is too large.
|-
| 3 || [[#EnableInterface]] ||
|-
| 4 || [[#DisableInterface]] ||
|-
| 5 || [[#CtrlInPostBufferAsync]] ||
|-
| 6 || [[#CtrlOutPostBufferAsync]] ||
|-
| 7 || [[#GetCtrlInCompletionEvent]] ||
|-
| 8 || [[#GetCtrlInReportData]] ||
|-
| 9 || [[#GetCtrlOutCompletionEvent]] ||
|-
| 10 || [[#GetCtrlOutReportData]] ||
|-
| 11 || [[#StallCtrl]] ||
|-
| 12 || [5.0.0+] AppendConfigurationData ||
|}

Commands cmd2, [[#CtrlInPostBufferAsync]], [[#CtrlOutPostBufferAsync]], and [[#StallCtrl]], will throw an error if the interface is not [[#EnableInterface|enabled]]. [[#GetDsEndpoint]] will throw an error if the interface is [[#EnableInterface|enabled]].

=== GetDsEndpoint ===
Takes a type-5 buffer and returns an [[#IDsEndpoint]]. [[Manu_Services|Manu]] uses this twice for getting two endpoint sessions, with the following 0x7-byte buffer data:
* First endpoint: 0x07, 0x05, 0x80, 0x02, 0x00, 0x02, 0x00
** bLength=0x7
** bDescriptorType=LIBUSB_DT_ENDPOINT
** bEndpointAddress=LIBUSB_ENDPOINT_IN
** bmAttributes=LIBUSB_TRANSFER_TYPE_BULK
** wMaxPacketSize=0x200
** bInterval=0
* Second endpoint: Same as above except byte2 is 0x00(bEndpointAddress=LIBUSB_ENDPOINT_OUT).

Each field is an u8, except for offset 0x4-0x5 which is an u16.

This structure matches [http://libusb.sourceforge.net/api-1.0/structlibusb__endpoint__descriptor.html libusb_endpoint_descriptor], with audio-only-devices fields bRefresh and bSynchAddress removed.

The buffer size must be >=0x7. Only the first 0x7-bytes from the buffer are used.
* Byte0(bLength) must match 0x7.
* Byte1(bDescriptorType) must match 0x5.
* Byte2(bEndpointAddress) is only compared with 0x80 to determine whether to use an input or output endpoint, the actual endpoint-number is allocated automatically by checking state. Hence, all input endpoints must use bEndpointAddress==0x80. Up to endpoint-number 0xF can be allocated for each endpoint-direction, for a total of 16 endpoints including control, and 15 for non-control endpoints([[#IDsEndpoint]] sessions for each direction). This matches the Tegra maximum.

From the Tegra datasheet: "The maximum packet size supported on any endpoint is 1024 bytes in high-speed mode, for both device and host modes."

=== GetSetupEvent ===
Returns an event handle. Unknown what triggers signalling, not signalled during interface-enable / device<>host USB-comms init.

=== EnableInterface ===
Takes no arguments. Enables the current interface.

Only one interface can be enabled at a time per bInterfaceNumber. When bInterfaceNumber is auto-allocate(0x4) for [[#GetDsEndpoint]] this isn't an issue since the final bInterfaceNumber will be unique.

Once enabled, the device/interface can then actually be used over USB.

=== DisableInterface ===
Takes no arguments. Disables the current interface.

=== CtrlInPostBufferAsync ===
Same as [[#PostBufferAsync]](with same input/output), except this uses control input endpoint 0x80.

=== CtrlOutPostBufferAsync ===
Same as [[#PostBufferAsync]](with same input/output), except this uses control output endpoint 0x00.

=== GetCtrlInCompletionEvent ===
Returns an event handle for polling the completion of input control commands. Same as [[#GetCompletionEvent]], except this uses control input endpoint 0x80.

=== GetCtrlInReportData ===
Same as [[#GetReportData]](with same input/output), except this uses control input endpoint 0x80.

=== GetCtrlOutCompletionEvent ===
Returns an event handle for polling the completion of output control commands. Same as [[#GetCompletionEvent]], except this uses control output endpoint 0x00.

=== GetCtrlOutReportData ===
Same as [[#GetReportData]](with same input/output), except this uses control output endpoint 0x00.

=== StallCtrl ===
No input/output.

Calls a function with both control endpoints(0x80 and 0x00) with the same function. From strings: "m_pProtocol->Stall(0x80)" "m_pProtocol->Stall(0x00)".

=== IDsEndpoint ===
This is "nn::usb::ds::IDsEndpoint".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#PostBufferAsync]] ||
|-
| 1 || || No input/output.
|-
| 2 || [[#GetCompletionEvent]] ||
|-
| 3 || [[#GetReportData]] ||
|-
| 4 || [[#Stall]] ||
|-
| 5 || || Takes an input u8, no output.
|}

==== PostBufferAsync ====
Takes an u32 ('''size''') and an u64 ('''buffer'''). Returns an output u32 ('''urbId'''). The output urbId can then be used while parsing the output of [[#GetReportData]], after waiting for the CompletionEvent to be signalled.

The buffer address must be 0x1000-byte aligned. The input size doesn't matter. It helps to use svcSetMemoryAttribute to turn off caching on the buffer.

Used for data-transfer with input/output endpoints.

The user-process must flush dcache for the buffer before using this command.

When sending data where size is larger than wMaxPacketSize, it will automatically send multiple USB packets where last packet size = {remaining size}. Every {wMaxPacketSize}-bytes is a different packet. This only occurs in some cases. When '''size''' is ~0x1000000(exact size unknown), Switch-side silently hangs, while host-side will timeout(no traffic on USB bus indicating failure).

For receiving data, if size is less than {actual received USB packet size} the rest of the packet will be discarded. Later PostBufferAsync cmd(s) will only return data from new packets, not the remainder of the earlier packet(s).

==== GetCompletionEvent ====
No input. Returns an output event handle for polling the completion of [[#PostBufferAsync]], even when it finished via [[#Stall]].

==== GetReportData ====
No input. Returns 0x84 bytes of report data from the endpoint. Seems to be eventually loaded from state, since this doesn't trigger any USB bus activity. All-zero before PostBufferAsync was used at least once.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x10*0x8(0x80) || 0x8 entries 0x10-bytes each for each report.
|-
| 0x80 || 0x4 || u32 report count
|}

Entry data:
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || u32 id (urbId from post-buffer commands)
|-
| 0x4 || 0x4 || u32 requestedSize
|-
| 0x8 || 0x4 || u32 transferredSize
|-
| 0xC || 0x4 || u32 urb status, converted to error-codes. 0x3 = success, 0x4 = 0x828c, 0x5 = 0x748c. All other values are invalid.
|-
|}

==== Stall ====
No input/output.

Calls the same function used by [[#StallCtrl]], except this uses the endpoint associated with the current session.

Stops in-progress data-transfer done by [[#PostBufferAsync]].

= usb:hs =
This is "nn::usb::hs::IClientRootSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#BindClientProcess_2|#BindClientProcess]]
|-
| 1 || [[#QueryAllInterfaces]]
|-
| 2 || [[#QueryAvailableInterfaces]]
|-
| 3 || [[#QueryAcquiredInterfaces]]
|-
| 4 || [[#CreateInterfaceAvailableEvent]]
|-
| 5 || [[#DestroyInterfaceAvailableEvent]]
|-
| 6 || [[#GetInterfaceStateChangeEvent]]
|-
| 7 || [[#AcquireUsbIf]]
|-
| 8 || [6.0.0+]
|}

General USB devices usage, used by [[Audio_services|audio]], [[HID_services|hid]] and [[Sockets_services|bsdsockets]].

== BindClientProcess ==
Takes 1 copy-handle for the current process (0xFFFF8001).

== QueryAllInterfaces ==
Takes a 0x10-byte input struct and a type-0x6 output buffer, returns an output u32.

== QueryAvailableInterfaces ==
Takes a 0x10-byte input struct and a type-0x6 output buffer, returns an output u32.

== QueryAcquiredInterfaces ==
Takes a type-0x6 output buffer and returns an output u32.

== CreateInterfaceAvailableEvent ==
Takes an input u8 and returns an output handle.

== DestroyInterfaceAvailableEvent ==
Takes an input u8, no output.

== GetInterfaceStateChangeEvent ==
No input, returns an output handle.

== AcquireUsbIf ==
Takes an input u32 and a type-0x6 output buffer, returns an [[#IClientIfSession]].

== IClientIfSession ==
This is "nn::usb::hs::IClientIfSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || || No input, returns an output handle.
|-
| 1 || [[#SetInterface]] ||
|-
| 2 || [[#GetInterface]] ||
|-
| 3 || [[#GetAlternateInterface]] ||
|-
| 4 || [[#GetCurrentFrame]] ||
|-
| 5 || [[#CtrlXferAsync]] ||
|-
| 6 || || No input, returns an output handle.
|-
| 7 || [[#GetCtrlXferReport]] ||
|-
| 8 || [[#ResetDevice]] ||
|-
| 9 || [[#OpenUsbEp]] ||
|}

=== SetInterface ===
Takes an input u8 and a type-0x6 output buffer, no output.

=== GetInterface ===
Takes a type-0x6 output buffer, no output.

=== GetAlternateInterface ===
Takes an input u8 and a type-0x6 output buffer, no output.

=== GetCurrentFrame ===
No input, returns an output u32.

=== CtrlXferAsync ===
Takes 2 input u8s and 3 input u16s, no output.

=== GetCtrlXferReport ===
Takes a type-0x6 output buffer, no output.

=== ResetDevice ===
No input/output.

=== OpenUsbEp ===
Takes an input u16 and 4 input u32s, returns a 0x7-byte output struct and an [[#IClientEpSession]].

=== IClientEpSession ===
This is "nn::usb::hs::IClientEpSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#Open]] ||
|-
| 1 || [[#Close]] ||
|-
| 2 || || No input, returns an output handle.
|-
| 3 || [[#Populate]] ||
|-
| 4 || [[#PostBufferAsync]] ||
|-
| 5 || [[#GetXferReport]] ||
|-
| 6 || || Takes 3 input u32s, 2 input u64s, and a type-0x5 input buffer, returns an output u32.
|-
| 7 || [4.0.0+] ||
|-
| 8 || [4.0.0+] ||
|}

==== Open ====
No input/output.

==== Close ====
No input/output.

==== Populate ====
No input/output.

==== PostBufferAsync ====
Takes an input u32 and 2 input u64s, returns an output u32.

==== GetXferReport ====
Takes an input u32 and a type-0x6 output buffer, returns an output u32.

= usb:pd =
This is "nn::usb::pd::detail::IPdManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetPdSession
|}

Only system-titles with access to this are [[PTM_services|ptm]] and [[AM_services|am]].

== IPdSession ==
This is "nn::usb::pd::detail::IPdSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || BindNoticeEvent
|-
| 1 ||
|-
| 2 || GetStatus
|-
| 3 || GetNotice
|-
| 4 ||
|-
| 5 ||
|-
| 6 || ReplyPowerRequest
|}

= usb:pd:c =
This is "nn::usb::pd::detail::IPdCradleManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetPdCradleSession || Returns a session handle for the below.
|}

USB-sysmodule symbols for this refer to "Cradle", which is the [[Dock]].

== IPdCradleSession ==
This is "nn::usb::pd::detail::IPdCradleSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || VdmUserWrite || Input { u32 value; u32 VdmUserId; }. Output {}.
If Cradle or RelayBox is connected, issues given VDM with value.
|-
| 1 || VdmUserRead || Input { u32 VdmUserId; }. Output { u32 value; }.
If Cradle or RelayBox is connected, returns u32 response from issuing given VDM.
|-
| 2 || Vdm20Init || No input/output.
If Cradle or RelayBox is connected, caches result of VDM 0x20.
|-
| 3 || GetFwType || No input. Returns an output u16.
|-
| 4 || GetFwRevision || No input. Returns an output u16.
|-
| 5 || GetManufacturerId || No input. Returns an output u16.
|-
| 6 || GetDeviceId || No input. Returns an output u16.
|-
| 7 || [3.0.0+] ||
|-
| 8 || [3.0.0+] ||
|}

Note: The VdmUserId given to VdmUserRead/VdmUserWrite is translated from the given (enum) value to the actual cmd to send.

= usb:pm =
This is "nn::usb::pm::IPmService".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 ||
|}

USB Port Manager, only system-title using this is [[PTM_services|ptm]].

[[Category:Services]]

ETicket services

2018-10-18T22:21:17Z

Adubbz: Few new names

= es =
This is "nn::es::IETicketService".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || ImportTicket
|-
| 2 || ImportTicketCertificateSet
|-
| 3 || DeleteTicket
|-
| 4 || DeletePersonalizedTicket
|-
| 5 || DeleteAllCommonTicket
|-
| 6 || DeleteAllPersonalizedTicket
|-
| 7 || DeleteAllPersonalizedTicketEx
|-
| 8 || [2.0.0-5.1.0] GetTitleKey
|-
| 9 || CountCommonTicket
|-
| 10 || CountPersonalizedTicket
|-
| 11 || ListCommonTicket / [6.0.0+] ListCommonTicketRightsIds
|-
| 12 || ListPersonalizedTicket / [6.0.0+] ListPersonalizedTicketRightsIds
|-
| 13 || ListMissingPersonalizedTicket
|-
| 14 || GetCommonTicketSize
|-
| 15 || [2.0.0-5.1.0] GetPersonalizedTicketSize
|-
| 16 || GetCommonTicketData
|-
| 17 || [2.0.0-5.1.0] GetPersonalizedTicketData
|-
| 18 || OwnTicket
|-
| 19 || GetTicketInfo
|-
| 20 || ListLightTicketInfo
|-
| 21 || [2.0.0+] SignData
|-
| 22 || [4.0.0+] GetCommonTicketAndCertificateSize
|-
| 23 || [4.0.0+] GetCommonTicketAndCertificateData
|-
| 24 || [4.0.0+] ImportPrepurchaseRecord
|-
| 25 || [4.0.0+] DeletePrepurchaseRecord
|-
| 26 || [4.0.0+] DeleteAllPrepurchaseRecord
|-
| 27 || [4.0.0+] CountPrepurchaseRecord
|-
| 28 || [4.0.0+] ListPrepurchaseRecord / [6.0.0+] ListPrepurchaseRecordRightsIds
|-
| 29 || [4.0.0+] ListPrepurchaseRecordInfo
|-
| 30 || [5.0.0+] CountTicket
|-
| 31 || [5.0.0+] ListTicketRightsIds
|-
| 32 || [5.0.0+] CountPrepurchaseRecordEx
|-
| 33 || [5.0.0+] ListPrepurchaseRecordRightsIdsEx
|-
| 34 || [5.0.0+] GetEncryptedTicketSize
|-
| 35 || [5.0.0+] GetEncryptedTicketData
|-
| 36 || [6.0.0+] DeleteAllInactiveELicenseRequiredPersonalizedTicket
|-
| 501 || [6.0.0+]
|-
| 502 || [6.0.0+]
|-
| 503 || [6.0.0+] GetTitleKey
|-
| 504 || [6.0.0+]
|-
| 508 || [6.0.0+]
|-
| 509 || [6.0.0+]
|-
| 510 || [6.0.0+]
|-
| 1001 || [6.0.0+]
|-
| 1002 || [6.0.0+]
|-
| 1003 || [6.0.0+]
|-
| 1004 || [6.0.0+]
|-
| 1005 || [6.0.0+]
|-
| 1006 || [6.0.0+]
|-
| 1007 || [6.0.0+]
|-
| 1009 || [6.0.0+]
|-
| 1010 || [6.0.0+]
|-
| 1011 || [6.0.0+]
|-
| 1012 || [6.0.0+]
|-
| 1013 || [6.0.0+]
|-
| 1014 || [6.0.0+]
|-
| 1015 || [6.0.0+]
|-
| 1016 || [6.0.0+]
|-
| 1501 || [6.0.0+]
|-
| 1502 || [6.0.0+]
|-
| 1503 || [6.0.0+]
|-
| 1504 || [6.0.0+]
|-
| 1505 || [6.0.0+]
|-
| 2000 || [6.0.0+]
|-
| 2501 || [6.0.0+]
|-
| 2502 || [6.0.0+]
|}

USB services

2018-09-19T08:44:51Z

Adubbz: Fixed editing the USB services page

One symbol in USB-sysmodule is: "vtable for nn::usb::detail::UsbComplexTegra21x".

= usb:ds =
This is "nn::usb::ds::IDsService".

Used for Switch<>PC USB comms, aka Switch-as-device. This seems to only be usable in handheld-mode with the Switch directly connected to a host via an USB cable, not(?) in docked-mode.
This service is used during [[Factory Setup|factory setup]] by [[Manu Services|manu]].

This service session is used as an IPC [[IPC_Marshalling|domain]] by [[Manu Services|manu]]. All of these {get-session} commands also return an output u8 and the u32 [[IPC_Marshalling|domainID]], for using those sessions as domains.

This service can be used by multiple processes at the same time, with separate interfaces. However, if one process does usbds shutdown, usbds will reset to defaults even if there's a process still using it.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#BindDevice]]
|-
| 1 || [[#BindClientProcess]]
|-
| 2 || [[#GetDsInterface]]
|-
| 3 || [[#GetStateChangeEvent]]
|-
| 4 || [[#GetState]]
|-
| [2.0.0-4.1.0] 5 || [[#SetVidPidBcd]]
|-
| [5.0.0+] 5 || ClearDeviceData
|-
| 6 || [5.0.0+] AddUsbStringDescriptor
|-
| 7 || [5.0.0+] DeleteUsbStringDescriptor
|-
| 8 || [5.0.0+] SetUsbDeviceDescriptor
|-
| 9 || [5.0.0+] SetBinaryObjectStore
|-
| 10 || [5.0.0+] Enable
|-
| 11 || [5.0.0+] Disable
|}

Initialization done by [[Manu Services|manu]]:
* Initial service init:
** Get service/etc.
** Uses [[#BindDevice]].
** Uses [[#BindClientProcess]].
** Uses [[#GetStateChangeEvent]].
** Uses [[#SetVidPidBcd]].
* Interface init:
** Uses [[#GetDsInterface]], then uses commands from that with the rest of the following.
** Uses [[#GetSetupEvent]].
** Uses [[#GetCtrlInCompletionEvent]].
** Uses [[#GetCtrlOutCompletionEvent]].
* Initializes two endpoints via using [[#GetDsEndpoint]] twice.

== Configuration ==
The following is the default USB config strings, while the usbds service isn't being used. All of the below configuration will reset to the defaults when all usbds-related sessions are closed. These can be set with [[#SetVidPidBcd]]. The default string for Product is loaded from [[Settings_services|settings]] config. The default is referred to by usb-sysmodule as "Dummy".
Product: Nintendo Switch
Manufacturer: Nintendo
SerialNumber: SerialNumber

The following is the default <code>lsusb -v {...}</code> output when the usbds service wasn't used.

The endpoints are configured using [[#GetDsEndpoint]], the total number of endpoints is the number of open [[#IDsEndpoint]] sessions. bInterfaceNumber is {0-based index for the enabled [[#IDsInterface]] session.} Some of the interface fields are configured using [[#GetDsInterface]].

Additional descriptors for use with interfaces and endpoints can't be configured with usbds, even though the former is used for the default HID interface. This seems to be the main(?) restriction with using usbds for Switch-as-arbitrary-devices. The device class fields can't be configured, interface class fields are set instead.

When usbds is in use where [[#SetVidPidBcd]] wasn't used, the VID/PID is 057e:3000.

Bus 003 Device 006: ID 057e:2000 Nintendo Co., Ltd
Couldn't open device, some information will be missing
Device Descriptor:
bLength 18
bDescriptorType 1
bcdUSB 2.00
bDeviceClass 0 (Defined at Interface level)
bDeviceSubClass 0
bDeviceProtocol 0
bMaxPacketSize0 64
idVendor 0x057e Nintendo Co., Ltd
idProduct 0x2000
bcdDevice 1.00
iManufacturer 1
iProduct 2
iSerial 3
bNumConfigurations 1
Configuration Descriptor:
bLength 9
bDescriptorType 2
wTotalLength 34
bNumInterfaces 1
bConfigurationValue 1
iConfiguration 0
bmAttributes 0xc0
Self Powered
MaxPower {...}
Interface Descriptor:
bLength 9
bDescriptorType 4
bInterfaceNumber 0
bAlternateSetting 0
bNumEndpoints 1
bInterfaceClass 3 Human Interface Device
bInterfaceSubClass 0 No Subclass
bInterfaceProtocol 0 None
iInterface 0
HID Device Descriptor:
bLength 9
bDescriptorType 33
bcdHID 2.00
bCountryCode 0 Not supported
bNumDescriptors 1
bDescriptorType 34 Report
wDescriptorLength 26
Report Descriptors:
** UNAVAILABLE **
Endpoint Descriptor:
bLength 7
bDescriptorType 5
bEndpointAddress 0x81 EP 1 IN
bmAttributes 3
Transfer Type Interrupt
Synch Type None
Usage Type Data
wMaxPacketSize 0x0001 1x 1 bytes
bInterval 16

== BindDevice ==
Takes an u32 ('''complexId'''). [[Manu_Services|Manu]] sends 0x02.

Binding more than once with the current session is not allowed. Once this command is used, the USB device will not be listed with <code>lsusb</code> until [[#EnableInterface]] is used.

Returns a not-found error when complexId isn't 0x02, for values 0x0-0x4 at least.

== BindClientProcess ==
Takes 1 copy-handle for the current process (0xFFFF8001).

== GetDsInterface ==
Takes 2 type-5 buffers and returns an [[#IDsInterface]]. [[Manu_Services|Manu]] sends a 0x09-byte command (e.g.: 0x09, 0x04, 0x04, 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0x00) in the first buffer and a string ("usb") in the second buffer.

When the strlen output for the second buffer is >=0x40, size 0x40 is used instead for copying the string. This is the interface name, it's not sent over USB.

Returns an error when [[#BindDevice]] wasn't used.

Up to 4 interfaces can be used+[[#EnableInterface|enabled]].

Structure of the first buffer(this is the same as [http://libusb.sourceforge.net/api-1.0/structlibusb__interface__descriptor.html libusb__interface__descriptor]):
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || bLength. Must match 0x9.
|-
| 0x1 || 0x1 || bDescriptorType. Must match 0x4.
|-
| 0x2 || 0x1 || bInterfaceNumber. When 0x4, the bInterfaceNumber is automatically allocated(error will be thrown if no space). Otherwise, it's used directly and must be <=3.
|-
| 0x3 || 0x1 || bAlternateSetting. Must match 0x0.
|-
| 0x4 || 0x1 || bNumEndpoints. Ignored.
|-
| 0x5 || 0x1 || bInterfaceClass
|-
| 0x6 || 0x1 || bInterfaceSubClass
|-
| 0x7 || 0x1 || bInterfaceProtocol
|-
| 0x8 || 0x1 || iInterface. Ignored.
|}

Only the first 0x9-bytes are used.

== GetStateChangeEvent ==
Returns an event handle for when the state returned by [[#GetState]] changes. Signalled when Switch<->host USB comms change between started/stopped. USB cable connected/disconnected while at least 1 interface was enabled, or interface enabled/disabled while the USB cable was connected which then caused USB-comms state to change.

== GetState ==
No input. Returns an output u32. Returns an error when [[#BindDevice]] wasn't used.

Returns the current state. Values:
* 0: Initial state.
* 6: Device init starting.
* 3: {Initialization}, previous state is 6.
* 4: {Initialization}, previous state is 3.
* 5: Initialization done, data-transfer is now available.

== SetVidPidBcd ==
Takes a type-5 buffer with 0x66 bytes of USB descriptor data (see [[Manu_Services#manu|manu]]).

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x2 || VID (idVendor)
|-
| 0x2 || 0x2 || PID (idProduct)
|-
| 0x4 || 0x2 || bcdDevice
|-
| 0x6 || 0x20 || Manufacturer
|-
| 0x26 || 0x20 || Product
|-
| 0x46 || 0x20 || SerialNumber
|}

The last 3 blocks are ASCII strings. The data following each string is all-zero, for padding to size 0x20.

== IDsInterface ==
This is "nn::usb::ds::IDsInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetDsEndpoint]] ||
|-
| 1 || [[#GetSetupEvent]] ||
|-
| 2 || || Takes a type-0x6 output buffer, no other output. Memcpys data to outbuf with outsize, uses size 0x8 if outsize is too large.
|-
| 3 || [[#EnableInterface]] ||
|-
| 4 || [[#DisableInterface]] ||
|-
| 5 || [[#CtrlInPostBufferAsync]] ||
|-
| 6 || [[#CtrlOutPostBufferAsync]] ||
|-
| 7 || [[#GetCtrlInCompletionEvent]] ||
|-
| 8 || [[#GetCtrlInReportData]] ||
|-
| 9 || [[#GetCtrlOutCompletionEvent]] ||
|-
| 10 || [[#GetCtrlOutReportData]] ||
|-
| 11 || [[#StallCtrl]] ||
|-
| 12 || [5.0.0+] AppendConfigurationData ||
|}

Commands cmd2, [[#CtrlInPostBufferAsync]], [[#CtrlOutPostBufferAsync]], and [[#StallCtrl]], will throw an error if the interface is not [[#EnableInterface|enabled]]. [[#GetDsEndpoint]] will throw an error if the interface is [[#EnableInterface|enabled]].

=== GetDsEndpoint ===
Takes a type-5 buffer and returns an [[#IDsEndpoint]]. [[Manu_Services|Manu]] uses this twice for getting two endpoint sessions, with the following 0x7-byte buffer data:
* First endpoint: 0x07, 0x05, 0x80, 0x02, 0x00, 0x02, 0x00
** bLength=0x7
** bDescriptorType=LIBUSB_DT_ENDPOINT
** bEndpointAddress=LIBUSB_ENDPOINT_IN
** bmAttributes=LIBUSB_TRANSFER_TYPE_BULK
** wMaxPacketSize=0x200
** bInterval=0
* Second endpoint: Same as above except byte2 is 0x00(bEndpointAddress=LIBUSB_ENDPOINT_OUT).

Each field is an u8, except for offset 0x4-0x5 which is an u16.

This structure matches [http://libusb.sourceforge.net/api-1.0/structlibusb__endpoint__descriptor.html libusb_endpoint_descriptor], with audio-only-devices fields bRefresh and bSynchAddress removed.

The buffer size must be >=0x7. Only the first 0x7-bytes from the buffer are used.
* Byte0(bLength) must match 0x7.
* Byte1(bDescriptorType) must match 0x5.
* Byte2(bEndpointAddress) is only compared with 0x80 to determine whether to use an input or output endpoint, the actual endpoint-number is allocated automatically by checking state. Hence, all input endpoints must use bEndpointAddress==0x80. Up to endpoint-number 0xF can be allocated for each endpoint-direction, for a total of 16 endpoints including control, and 15 for non-control endpoints([[#IDsEndpoint]] sessions for each direction). This matches the Tegra maximum.

From the Tegra datasheet: "The maximum packet size supported on any endpoint is 1024 bytes in high-speed mode, for both device and host modes."

=== GetSetupEvent ===
Returns an event handle. Unknown what triggers signalling, not signalled during interface-enable / device<>host USB-comms init.

=== EnableInterface ===
Takes no arguments. Enables the current interface.

Only one interface can be enabled at a time per bInterfaceNumber. When bInterfaceNumber is auto-allocate(0x4) for [[#GetDsEndpoint]] this isn't an issue since the final bInterfaceNumber will be unique.

Once enabled, the device/interface can then actually be used over USB.

=== DisableInterface ===
Takes no arguments. Disables the current interface.

=== CtrlInPostBufferAsync ===
Same as [[#PostBufferAsync]](with same input/output), except this uses control input endpoint 0x80.

=== CtrlOutPostBufferAsync ===
Same as [[#PostBufferAsync]](with same input/output), except this uses control output endpoint 0x00.

=== GetCtrlInCompletionEvent ===
Returns an event handle for polling the completion of input control commands. Same as [[#GetCompletionEvent]], except this uses control input endpoint 0x80.

=== GetCtrlInReportData ===
Same as [[#GetReportData]](with same input/output), except this uses control input endpoint 0x80.

=== GetCtrlOutCompletionEvent ===
Returns an event handle for polling the completion of output control commands. Same as [[#GetCompletionEvent]], except this uses control output endpoint 0x00.

=== GetCtrlOutReportData ===
Same as [[#GetReportData]](with same input/output), except this uses control output endpoint 0x00.

=== StallCtrl ===
No input/output.

Calls a function with both control endpoints(0x80 and 0x00) with the same function. From strings: "m_pProtocol->Stall(0x80)" "m_pProtocol->Stall(0x00)".

=== IDsEndpoint ===
This is "nn::usb::ds::IDsEndpoint".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#PostBufferAsync]] ||
|-
| 1 || || No input/output.
|-
| 2 || [[#GetCompletionEvent]] ||
|-
| 3 || [[#GetReportData]] ||
|-
| 4 || [[#Stall]] ||
|-
| 5 || || Takes an input u8, no output.
|}

==== PostBufferAsync ====
Takes an u32 ('''size''') and an u64 ('''buffer'''). Returns an output u32 ('''urbId'''). The output urbId can then be used while parsing the output of [[#GetReportData]], after waiting for the CompletionEvent to be signalled.

The buffer address must be 0x1000-byte aligned. The input size doesn't matter. It helps to use svcSetMemoryAttribute to turn off caching on the buffer.

Used for data-transfer with input/output endpoints.

The user-process must flush dcache for the buffer before using this command.

When sending data where size is larger than wMaxPacketSize, it will automatically send multiple USB packets where last packet size = {remaining size}. Every {wMaxPacketSize}-bytes is a different packet. This only occurs in some cases. When '''size''' is ~0x1000000(exact size unknown), Switch-side silently hangs, while host-side will timeout(no traffic on USB bus indicating failure).

For receiving data, if size is less than {actual received USB packet size} the rest of the packet will be discarded. Later PostBufferAsync cmd(s) will only return data from new packets, not the remainder of the earlier packet(s).

==== GetCompletionEvent ====
No input. Returns an output event handle for polling the completion of [[#PostBufferAsync]], even when it finished via [[#Stall]].

==== GetReportData ====
No input. Returns 0x84 bytes of report data from the endpoint. Seems to be eventually loaded from state, since this doesn't trigger any USB bus activity. All-zero before PostBufferAsync was used at least once.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x10*0x8(0x80) || 0x8 entries 0x10-bytes each for each report.
|-
| 0x80 || 0x4 || u32 report count
|}

Entry data:
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || u32 id (urbId from post-buffer commands)
|-
| 0x4 || 0x4 || u32 requestedSize
|-
| 0x8 || 0x4 || u32 transferredSize
|-
| 0xC || 0x4 || u32 urb status, converted to error-codes. 0x3 = success, 0x4 = 0x828c, 0x5 = 0x748c. All other values are invalid.
|-
|}

==== Stall ====
No input/output.

Calls the same function used by [[#StallCtrl]], except this uses the endpoint associated with the current session.

Stops in-progress data-transfer done by [[#PostBufferAsync]].

= usb:hs =
This is "nn::usb::hs::IClientRootSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || BindClientProcess
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 ||
|-
| 6 || GetInterfaceStateChangeEvent
|-
| 7 || GetClientIfSession
|}

General USB devices usage, used by [[HID_services|hid]] and [[Sockets_services|bsdsockets]].

== IClientIfSession ==
This is "nn::usb::hs::IClientIfSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 || CtrlXferAsync
|-
| 6 ||
|-
| 7 || GetCtrlXferReport
|-
| 8 ||
|-
| 9 || GetClientEpSession
|}

=== IClientEpSession ===
This is "nn::usb::hs::IClientEpSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 || PostBufferAsync
|-
| 5 ||
|-
| 6 ||
|-
| 7 || [4.0.0+]
|-
| 8 || [4.0.0+]
|}

= usb:pd =
This is "nn::usb::pd::detail::IPdManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetPdSession
|}

Only system-titles with access to this are [[PTM_services|ptm]] and [[AM_services|am]].

== IPdSession ==
This is "nn::usb::pd::detail::IPdSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || BindNoticeEvent
|-
| 1 ||
|-
| 2 || GetStatus
|-
| 3 || GetNotice
|-
| 4 ||
|-
| 5 ||
|-
| 6 || ReplyPowerRequest
|}

= usb:pd:c =
This is "nn::usb::pd::detail::IPdCradleManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetPdCradleSession || Returns a session handle for the below.
|}

USB-sysmodule symbols for this refer to "Cradle", which is the [[Dock]].

== IPdCradleSession ==
This is "nn::usb::pd::detail::IPdCradleSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || VdmUserWrite || Input { u32 value; u32 VdmUserId; }. Output {}.
If Cradle or RelayBox is connected, issues given VDM with value.
|-
| 1 || VdmUserRead || Input { u32 VdmUserId; }. Output { u32 value; }.
If Cradle or RelayBox is connected, returns u32 response from issuing given VDM.
|-
| 2 || Vdm20Init || No input/output.
If Cradle or RelayBox is connected, caches result of VDM 0x20.
|-
| 3 || GetFwType || No input. Returns an output u16.
|-
| 4 || GetFwRevision || No input. Returns an output u16.
|-
| 5 || GetManufacturerId || No input. Returns an output u16.
|-
| 6 || GetDeviceId || No input. Returns an output u16.
|-
| 7 || [3.0.0+] ||
|-
| 8 || [3.0.0+] ||
|}

Note: The VdmUserId given to VdmUserRead/VdmUserWrite is translated from the given (enum) value to the actual cmd to send.

= usb:pm =
This is "nn::usb::pm::IPmService".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 ||
|}

USB Port Manager, only system-title using this is [[PTM_services|ptm]].

[[Category:Services]]

ETicket services

2018-09-01T01:47:23Z

Adubbz: This appears to be the same function, just renamed

= es =
This is "nn::es::IETicketService".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || ImportTicket
|-
| 2 || ImportTicketCertificateSet
|-
| 3 || DeleteTicket
|-
| 4 || DeletePersonalizedTicket
|-
| 5 || DeleteAllCommonTicket
|-
| 6 || DeleteAllPersonalizedTicket
|-
| 7 || DeleteAllPersonalizedTicketEx
|-
| 8 || [2.0.0-5.1.0] GetTitleKey
|-
| 9 || CountCommonTicket
|-
| 10 || CountPersonalizedTicket
|-
| 11 || ListCommonTicket
|-
| 12 || ListPersonalizedTicket
|-
| 13 || ListMissingPersonalizedTicket
|-
| 14 || GetCommonTicketSize
|-
| 15 || [2.0.0-5.1.0] GetPersonalizedTicketSize
|-
| 16 || GetCommonTicketData
|-
| 17 || [2.0.0-5.1.0] GetPersonalizedTicketData
|-
| 18 || OwnTicket
|-
| 19 || GetTicketInfo
|-
| 20 || ListLightTicketInfo
|-
| 21 || [2.0.0+] SignData
|-
| 22 || [4.0.0+] GetCommonTicketAndCertificateSize
|-
| 23 || [4.0.0+] GetCommonTicketAndCertificateData
|-
| 24 || [4.0.0+] ImportPrepurchaseRecord
|-
| 25 || [4.0.0+] DeletePrepurchaseRecord
|-
| 26 || [4.0.0+] DeleteAllPrepurchaseRecord
|-
| 27 || [4.0.0+] CountPrepurchaseRecord
|-
| 28 || [4.0.0+] ListPrepurchaseRecord
|-
| 29 || [4.0.0+] ListPrepurchaseRecordInfo
|-
| 30 || [5.0.0+]
|-
| 31 || [5.0.0+]
|-
| 32 || [5.0.0+]
|-
| 33 || [5.0.0+]
|-
| 34 || [5.0.0+]
|-
| 35 || [5.0.0+]
|-
| 36 || [6.0.0+]
|-
| 501 || [6.0.0+]
|-
| 502 || [6.0.0+]
|-
| 503 || [6.0.0+] GetTitleKey
|-
| 504 || [6.0.0+]
|-
| 508 || [6.0.0+]
|-
| 509 || [6.0.0+]
|-
| 510 || [6.0.0+]
|-
| 1001 || [6.0.0+]
|-
| 1002 || [6.0.0+]
|-
| 1003 || [6.0.0+]
|-
| 1004 || [6.0.0+]
|-
| 1005 || [6.0.0+]
|-
| 1006 || [6.0.0+]
|-
| 1007 || [6.0.0+]
|-
| 1009 || [6.0.0+]
|-
| 1010 || [6.0.0+]
|-
| 1011 || [6.0.0+]
|-
| 1012 || [6.0.0+]
|-
| 1013 || [6.0.0+]
|-
| 1014 || [6.0.0+]
|-
| 1015 || [6.0.0+]
|-
| 1016 || [6.0.0+]
|-
| 1501 || [6.0.0+]
|-
| 1502 || [6.0.0+]
|-
| 1503 || [6.0.0+]
|-
| 1504 || [6.0.0+]
|-
| 1505 || [6.0.0+]
|-
| 2000 || [6.0.0+]
|-
| 2501 || [6.0.0+]
|-
| 2502 || [6.0.0+]
|}

NS services

2018-08-31T10:29:05Z

Adubbz: Placeholder name for command 94

= aoc:u =
This is "nn::aocsrv::detail::IAddOnContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CountAddOnContentByApplicationId
|-
| 1 || ListAddOnContentByApplicationId
|-
| 2 || CountAddOnContent
|-
| 3 || ListAddOnContent
|-
| 4 || GetAddOnContentBaseIdByApplicationId
|-
| 5 || GetAddOnContentBaseId
|-
| 6 || PrepareAddOnContentByApplicationId
|-
| 7 || PrepareAddOnContent
|-
| 8 || [4.0.0+] GetAddOnContentListChangedEvent
|}

= ns:am =
This is "nn::ns::detail::IApplicationManagerInterface".

[3.0.0+] This service was replaced by [[#ns:am2, ns:ec, ns:rid, ns:rt, ns:web|ns:am2]].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#ListApplicationRecord]]
|-
| 1 || GenerateApplicationRecordCount
|-
| 2 || GetApplicationRecordUpdateSystemEvent
|-
| 3 || GetApplicationViewDeprecated
|-
| 4 || DeleteApplicationEntity
|-
| 5 || DeleteApplicationCompletely
|-
| 6 || IsAnyApplicationEntityRedundant
|-
| 7 || DeleteRedundantApplicationEntity
|-
| 8 || IsApplicationEntityMovable
|-
| 9 || MoveApplicationEntity
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 16 || PushApplicationRecord
|-
| 17 || ListApplicationRecordContentMeta
|-
| 18 ||
|-
| 19 || [[#LaunchApplication]]
|-
| 21 || [[#GetApplicationContentPath]]
|-
| 22 || TerminateApplication
|-
| 23 || [2.0.0+] ResolveApplicationContentPath
|-
| 26 || BeginInstallApplication
|-
| 27 || DeleteApplicationRecord
|-
| 30 || RequestApplicationUpdateInfo
|-
| 31 || RequestUpdateApplication
|-
| 32 || CancelApplicationDownload
|-
| 33 || ResumeApplicationDownload
|-
| 34 ||
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 38 || CheckApplicationLaunchVersion
|-
| 39 || CheckApplicationLaunchRights
|-
| 40 || GetApplicationLogoData
|-
| 41 || CalculateApplicationDownloadRequiredSize
|-
| 42 || CleanupSdCard
|-
| 43 || CheckSdCardMountStatus
|-
| 44 || GetSdCardMountStatusChangedEvent
|-
| 45 || GetGameCardAttachmentEvent
|-
| 46 || GetGameCardAttachmentInfo
|-
| 47 || [[#GetTotalSpaceSize]]
|-
| 48 || [[#GetFreeSpaceSize]]
|-
| 49 || GetSdCardRemovedEvent
|-
| 52 || GetGameCardUpdateDetectionEvent
|-
| 53 || DisableApplicationAutoDelete
|-
| 54 || EnableApplicationAutoDelete
|-
| 55 || [[#GetApplicationDesiredLanguage]]
|-
| 56 || SetApplicationTerminateResult
|-
| 57 || ClearApplicationTerminateResult
|-
| 58 || GetLastSdCardMountUnexpectedResult
|-
| 59 || ConvertApplicationLanguageToLanguageCode
|-
| 60 || [[#ConvertLanguageCodeToApplicationLanguage]]
|-
| 61 || GetBackgroundDownloadStressTaskInfo
|-
| 62 || GetGameCardStopper
|-
| 63 || IsSystemProgramInstalled
|-
| 64 || [2.0.0+] StartApplyDeltaTask
|-
| 65 || [2.0.0+] GetRequestServerStopper
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || [2.0.0+] ResetToFactorySettingsForRefurbishment
|-
| 200 || CalculateUserSaveDataStatistics
|-
| 201 || DeleteUserSaveDataAll
|-
| 210 || DeleteUserSystemSaveData
|-
| 220 || UnregisterNetworkServiceAccount
|-
| 300 || GetApplicationShellEvent
|-
| 301 || PopApplicationShellEventInfo
|-
| 302 || LaunchLibraryApplet
|-
| 303 || TerminateLibraryApplet
|-
| 304 || LaunchSystemApplet
|-
| 305 || TerminateSystemApplet
|-
| 306 || LaunchOverlayApplet
|-
| 307 || TerminateOverlayApplet
|-
| 400 || [[#GetApplicationControlData]]
|-
| 401 || InvalidateAllApplicationControlCache
|-
| 402 || RequestDownloadApplicationControlData
|-
| 403 || GetMaxApplicationControlCacheCount
|-
| 404 || [2.0.0+] InvalidateApplicationControlCache
|-
| 405 || [2.0.0+] ListApplicationControlCacheEntryInfo
|-
| 502 || [2.0.0+] RequestCheckGameCardRegistration
|-
| 503 || [2.0.0+] RequestGameCardRegistrationGoldPoint
|-
| 504 || [2.0.0+] RequestRegisterGameCard
|-
| 600 || [2.0.0+] CountApplicationContentMeta
|-
| 601 || [2.0.0+] [[#ListApplicationContentMetaStatus]]
|-
| 602 || [2.0.0+] ListAvailableAddOnContent
|-
| 603 || [2.0.0+] GetOwnedApplicationContentMetaStatus
|-
| 604 || [2.0.0+] RegisterContentsExternalKey
|-
| 605 || [2.0.0+] ListApplicationContentMetaStatusWithRightsCheck
|-
| 700 || [2.0.0+] PushDownloadTaskList
|-
| 701 || [2.0.0+] ClearTaskStatusList
|-
| 702 || [2.0.0+] RequestDownloadTaskList
|-
| 703 || [2.0.0+] RequestEnsureDownloadTask
|-
| 704 || [2.0.0+] ListDownloadTaskStatus
|-
| 705 || [2.0.0+] RequestDownloadTaskListData
|-
| 800 || [2.0.0+] RequestVersionList
|-
| 801 || [2.0.0+] ListVersionList
|-
| 900 || [2.0.0+] GetApplicationRecord
|-
| 901 || [2.0.0+] GetApplicationRecordProperty
|-
| 902 || [2.0.0+] EnableApplicationAutoUpdate
|-
| 903 || [2.0.0+] DisableApplicationAutoUpdate
|-
| 904 || [2.0.0+] TouchApplication
|-
| 905 || [2.0.0+] RequestApplicationUpdate
|-
| 906 || [2.0.0+] IsApplicationUpdateRequested
|-
| 907 || [2.0.0+] WithdrawApplicationUpdateRequest
|-
| 908 || [2.0.0+] ListApplicationRecordInstalledContentMeta
|-
| 1000 || [2.0.0+] RequestVerifyApplicationDeprecated
|-
| 1001 || [2.0.0+] CorruptApplicationForDebug
|-
| 1200 || [2.0.0+] NeedsUpdateVulnerability
|-
| 1300 || [2.0.0+] IsAnyApplicationEntityInstalled
|-
| 1301 || [2.0.0+] DeleteApplicationContentEntities
|-
| 1302 || [2.0.0+] CleanupUnrecordedApplicationEntity
|-
| 1400 || [2.0.0+] PrepareShutdown
|-
| 1500 || [2.0.0+] FormatSdCard
|-
| 1501 || [2.0.0+] NeedsSystemUpdateToFormatSdCard
|-
| 1502 || [2.0.0+] GetLastSdCardFormatUnexpectedResult
|-
| 1503 || [2.0.0+]
|-
| 1600 || [2.0.0+] GetSystemSeedForPseudoDeviceId
|-
| 1700 || [2.0.0+] ListApplicationDownloadingContentMeta
|-
| 1800 || [2.0.0+] IsNotificationSetupCompleted
|-
| 1801 || [2.0.0+] GetLastNotificationInfoCount
|-
| 1802 || [2.0.0+] ListLastNotificationInfo
|}

== ListApplicationRecord ==
Takes a type-6 output buffer and an u64.

Returns an array of title-info entries using the specified offset and size. No input titleID is passed to this.

=== Application Record Format ===

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Title ID
|-
| 0x8
| 0x1
| Type? (Known values: 2=Installing?, 3=Gamecard?, 4=Installed?)
|-
| 0x9
| 0x1
| Unknown, usually 0x02
|-
| 0xA
| 0x6
| Unknown, usually zeros?
|-
| 0x10
| 0x1
| Unknown, seems to change between reboots and removing/reinserting gamecards
|-
| 0x11
| 0x7
| Unknown, usually zeros?
|}

== LaunchApplication ==
Takes an input u64 titleID, returns an output u64 PID.

Launches an application title which is registered with NS.

== GetApplicationContentPath ==
Takes a 0x16-type output buffer, an u8 [[NCA|type]], and an u64 titleID.

The input titleID is used with the application-title table like various other cmds, anything not in that table can't be used with this.

Returns a string path for the specified type of patch content with this titleID, otherwise returns regular-application paths when update-title not installed. Returns an error when the specified type of content doesn't exist for this title. Starts with "@{SdCardContent,UserContent}://" and ends in ".nca".

For gamecard content, the output path is: "@GcSXXXXXXXX:/<NcaId>.nca". NCA-type0 with gamecard returns 0 with an empty output string.

The output string is then used by the user-process with [[Filesystem_services|FS]] to mount the content.

== GetTotalSpaceSize ==
Takes an input media-id that must be 5.

Returns the u64 from [[Content_Manager_services#IContentStorage]] cmd22.

== GetFreeSpaceSize ==
Takes an input media-id that must be 5.

Returns the u64 from [[Content_Manager_services#IContentStorage]] cmd23.

== GetApplicationDesiredLanguage ==
Takes an input u8 language-bitmask, returns an output u8 [[control.nacp]] langentry index.

User-processes generate the language-bitmask with the following for all 16 lang-entries: <code>if(<either string in langentry[i] is non-empty>)bitmask |= 1<<i</code>

== ConvertLanguageCodeToApplicationLanguage ==
Takes an input u8 pointer for the resulting Id to be written to and a string represented as a u64 (i.e 0x53552D6E65 for 'en-US').

Returns 0 if an ID was successfully found, otherwise returns 0x25810.

== GetApplicationControlData ==
Takes an input u8 flag, an u64 titleID, and a type-0x6 output buffer. Returns an output u32 for actual_size. Official user-processes use buffer size 0x24000. [[qlaunch]] only uses flag value 0x1.

Loads cached [[control.nacp]] to buf+0 and the cached icon to buf+0x4000. Returns an error if the buffer is too small.

== ListApplicationContentMetaStatus ==
Returns 0x10-byte entries using the specified titleID starting at the specified u32 entryindex. Can only return game titles. The second entry if any is the update-title usually. When the input entryindex is >= totalentries, this will return 0 with out_entrycount=0.

Entry structure:
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| u8 "type". [[Content_Manager_services|Title type]] (String is from web-applet)
|-
| 0x1
| 0x1
| u8 "installedStorage" / [[Filesystem_services|StorageId]] (String is from web-applet)
|-
| 0x2
| 0x1
| Unknown. Non-zero with output from cmd 605, differs for app/update titles.
|-
| 0x3
| 0x1
| Padding
|-
| 0x4
| 0x4
| u32 Title-version
|-
| 0x8
| 0x8
| u64 titleID
|}

= ns:am2, ns:ec, ns:rid, ns:rt, ns:web =
These services are all, at the top level, "nn::ns::detail::IServiceGetterInterface". These commands check a state field for a command-specific bit and returns an error if not set, this is likely a permissions check for service+command.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 7992 || [[#IECommerceInterface|GetECommerceInterface]]
|-
| 7993 || [[#IApplicationVersionInterface|GetApplicationVersionInterface]]
|-
| 7994 || [[#IFactoryResetInterface|GetFactoryResetInterface]]
|-
| 7995 || [[#IAccountProxyInterface|GetAccountProxyInterface]]
|-
| 7996 || [[#IApplicationManagerInterface|GetApplicationManagerInterface]]
|-
| 7997 || [[#IDownloadTaskInterface|GetDownloadTaskInterface]]
|-
| 7998 || [[#IContentManagementInterface|GetContentManagementInterface]]
|-
| 7999 || [[#IDocumentInterface|GetDocumentInterface]]
|-
|}

=== IAccountProxyInterface ===
This is "nn::ns::detail::IAccountProxyInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CreateUserAccount
|-
|}

=== IApplicationManagerInterface ===
This is "nn::ns::detail::IApplicationManagerInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#ListApplicationRecord]]
|-
| 1 || GenerateApplicationRecordCount
|-
| 2 || GetApplicationRecordUpdateSystemEvent
|-
| 3 || GetApplicationViewDeprecated
|-
| 4 || DeleteApplicationEntity
|-
| 5 || DeleteApplicationCompletely
|-
| 6 || IsAnyApplicationEntityRedundant
|-
| 7 || DeleteRedundantApplicationEntity
|-
| 8 || IsApplicationEntityMovable
|-
| 9 || MoveApplicationEntity
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 16 || PushApplicationRecord
|-
| 17 || ListApplicationRecordContentMeta
|-
| 19 || [?.?.?-5.1.0] [[#LaunchApplication]]
|-
| 21 || [[#GetApplicationContentPath]]
|-
| 22 || TerminateApplication
|-
| 23 || ResolveApplicationContentPath
|-
| 26 || BeginInstallApplication
|-
| 27 || DeleteApplicationRecord
|-
| 30 || RequestApplicationUpdateInfo
|-
| 32 || CancelApplicationDownload
|-
| 33 || ResumeApplicationDownload
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 38 || CheckApplicationLaunchVersion
|-
| 39 || CheckApplicationLaunchRights
|-
| 40 || GetApplicationLogoData
|-
| 41 || CalculateApplicationDownloadRequiredSize
|-
| 42 || CleanupSdCard
|-
| 43 || CheckSdCardMountStatus
|-
| 44 || GetSdCardMountStatusChangedEvent
|-
| 45 || GetGameCardAttachmentEvent
|-
| 46 || GetGameCardAttachmentInfo
|-
| 47 || [[#GetTotalSpaceSize]]
|-
| 48 || [[#GetFreeSpaceSize]]
|-
| 49 || GetSdCardRemovedEvent
|-
| 52 || GetGameCardUpdateDetectionEvent
|-
| 53 || DisableApplicationAutoDelete
|-
| 54 || EnableApplicationAutoDelete
|-
| 55 || GetApplicationDesiredLanguage
|-
| 56 || SetApplicationTerminateResult
|-
| 57 || ClearApplicationTerminateResult
|-
| 58 || GetLastSdCardMountUnexpectedResult
|-
| 59 || ConvertApplicationLanguageToLanguageCode
|-
| 60 || [[#ConvertLanguageCodeToApplicationLanguage]]
|-
| 61 || GetBackgroundDownloadStressTaskInfo
|-
| 62 || GetGameCardStopper
|-
| 63 || IsSystemProgramInstalled
|-
| 64 || StartApplyDeltaTask
|-
| 65 || GetRequestServerStopper
|-
| 66 || GetBackgroundApplyDeltaStressTaskInfo
|-
| 67 || CancelApplicationApplyDelta
|-
| 68 || ResumeApplicationApplyDelta
|-
| 69 || CalculateApplicationApplyDeltaRequiredSize
|-
| 70 || ResumeAll
|-
| 71 || GetStorageSize
|-
| 80 || RequestDownloadApplication
|-
| 81 || RequestDownloadAddOnContent
|-
| 82 || DownloadApplication
|-
| 83 || CheckApplicationResumeRights
|-
| 84 || GetDynamicCommitEvent
|-
| 85 || RequestUpdateApplication2
|-
| 86 || EnableApplicationCrashReport
|-
| 87 || IsApplicationCrashReportEnabled
|-
| 90 || BoostSystemMemoryResourceLimit
|-
| 91 || [6.0.0+]
|-
| 92 || [6.0.0+]
|-
| 93 || [6.0.0+]
|-
| 94 || [6.0.0+] LaunchApplication2
|-
| 95 || [6.0.0+]
|-
| 96 || [6.0.0+]
|-
| 97 || [6.0.0+]
|-
| 98 || [6.0.0+]
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || ResetToFactorySettingsForRefurbishment
|-
| 200 || CalculateUserSaveDataStatistics
|-
| 201 || DeleteUserSaveDataAll
|-
| 210 || DeleteUserSystemSaveData
|-
| 211 || [6.0.0+]
|-
| 220 || UnregisterNetworkServiceAccount
|-
| 221 || [6.0.0+]
|-
| 300 || GetApplicationShellEvent
|-
| 301 || PopApplicationShellEventInfo
|-
| 302 || LaunchLibraryApplet
|-
| 303 || TerminateLibraryApplet
|-
| 304 || LaunchSystemApplet
|-
| 305 || TerminateSystemApplet
|-
| 306 || LaunchOverlayApplet
|-
| 307 || TerminateOverlayApplet
|-
| 400 || GetApplicationControlData
|-
| 401 || InvalidateAllApplicationControlCache
|-
| 402 || RequestDownloadApplicationControlData
|-
| 403 || GetMaxApplicationControlCacheCount
|-
| 404 || InvalidateApplicationControlCache
|-
| 405 || ListApplicationControlCacheEntryInfo
|-
| 406 || [6.0.0+]
|-
| 502 || RequestCheckGameCardRegistration
|-
| 503 || RequestGameCardRegistrationGoldPoint
|-
| 504 || RequestRegisterGameCard
|-
| 505 || GetGameCardMountFailureEvent
|-
| 506 || IsGameCardInserted
|-
| 507 || EnsureGameCardAccess
|-
| 508 || GetLastGameCardMountFailureResult
|-
| 509 || ListApplicationIdOnGameCard
|-
| 600 || CountApplicationContentMeta
|-
| 601 || [[#ListApplicationContentMetaStatus]]
|-
| 602 || [?.?.?-5.1.0] ListAvailableAddOnContent
|-
| 603 || GetOwnedApplicationContentMetaStatus
|-
| 604 || RegisterContentsExternalKey
|-
| 605 || ListApplicationContentMetaStatusWithRightsCheck
|-
| 606 || GetContentMetaStorage
|-
| 607 || [6.0.0+]
|-
| 700 || PushDownloadTaskList
|-
| 701 || ClearTaskStatusList
|-
| 702 || RequestDownloadTaskList
|-
| 703 || RequestEnsureDownloadTask
|-
| 704 || ListDownloadTaskStatus
|-
| 705 || RequestDownloadTaskListData
|-
| 800 || RequestVersionList
|-
| 801 || ListVersionList
|-
| 802 || RequestVersionListData
|-
| 900 || GetApplicationRecord
|-
| 901 || GetApplicationRecordProperty
|-
| 902 || EnableApplicationAutoUpdate
|-
| 903 || DisableApplicationAutoUpdate
|-
| 904 || TouchApplication
|-
| 905 || RequestApplicationUpdate
|-
| 906 || IsApplicationUpdateRequested
|-
| 907 || WithdrawApplicationUpdateRequest
|-
| 908 || ListApplicationRecordInstalledContentMeta
|-
| 909 || WithdrawCleanupAddOnContentsWithNoRightsRecommendation
|-
| 910 || [6.0.0+]
|-
| 911 || [6.0.0+]
|-
| 912 || [6.0.0+]
|-
| 1000 || RequestVerifyApplicationDeprecated
|-
| 1001 || CorruptApplicationForDebug
|-
| 1002 || RequestVerifyAddOnContentsRights
|-
| 1003 || RequestVerifyApplication
|-
| 1004 || CorruptContentForDebug
|-
| 1200 || NeedsUpdateVulnerability
|-
| 1300 || IsAnyApplicationEntityInstalled
|-
| 1301 || DeleteApplicationContentEntities
|-
| 1302 || CleanupUnrecordedApplicationEntity
|-
| 1303 || CleanupAddOnContentsWithNoRights
|-
| 1304 || DeleteApplicationContentEntity
|-
| 1305 || [?.?.?-5.1.0] TryDeleteRunningApplicationEntity
|-
| 1306 || [?.?.?-5.1.0] TryDeleteRunningApplicationCompletely
|-
| 1307 || [?.?.?-5.1.0] TryDeleteRunningApplicationContentEntities
|-
| 1308 || [6.0.0+]
|-
| 1309 || [6.0.0+]
|-
| 1400 || PrepareShutdown
|-
| 1500 || FormatSdCard
|-
| 1501 || NeedsSystemUpdateToFormatSdCard
|-
| 1502 || GetLastSdCardFormatUnexpectedResult
|-
| 1504 || InsertSdCard
|-
| 1505 || RemoveSdCard
|-
| 1600 || GetSystemSeedForPseudoDeviceId
|-
| 1601 || ResetSystemSeedForPseudoDeviceId
|-
| 1700 || ListApplicationDownloadingContentMeta
|-
| 1701 || GetApplicationView
|-
| 1702 || GetApplicationDownloadTaskStatus
|-
| 1703 || GetApplicationViewDownloadErrorContext
|-
| 1800 || IsNotificationSetupCompleted
|-
| 1801 || GetLastNotificationInfoCount
|-
| 1802 || ListLastNotificationInfo
|-
| 1803 || ListNotificationTask
|-
| 1900 || IsActiveAccount
|-
| 1901 || RequestDownloadApplicationPrepurchasedRights
|-
| 1902 || GetApplicationTicketInfo
|-
| 2000 || GetSystemDeliveryInfo
|-
| 2001 || SelectLatestSystemDeliveryInfo
|-
| 2002 || VerifyDeliveryProtocolVersion
|-
| 2003 || GetApplicationDeliveryInfo
|-
| 2004 || HasAllContentsToDeliver
|-
| 2005 || CompareApplicationDeliveryInfo
|-
| 2006 || CanDeliverApplication
|-
| 2007 || ListContentMetaKeyToDeliverApplication
|-
| 2008 || NeedsSystemUpdateToDeliverApplication
|-
| 2009 || EstimateRequiredSize
|-
| 2010 || RequestReceiveApplication
|-
| 2011 || CommitReceiveApplication
|-
| 2012 || GetReceiveApplicationProgress
|-
| 2013 || RequestSendApplication
|-
| 2014 || GetSendApplicationProgress
|-
| 2015 || CompareSystemDeliveryInfo
|-
| 2016 || ListNotCommittedContentMeta
|-
| 2017 || CreateDownloadTask
|-
| 2018 || [6.0.0+]
|-
| 2050 || [6.0.0+]
|-
| 2100 || [6.0.0+]
|-
| 2101 || [6.0.0+]
|-
| 2150 || [6.0.0+]
|-
| 2151 || [6.0.0+]
|-
| 2152 || [6.0.0+]
|-
| 2153 || [6.0.0+]
|-
| 2154 || [6.0.0+]
|-
| 2160 || [6.0.0+]
|-
| 2161 || [6.0.0+]
|-
| 2170 || [6.0.0+]
|-
| 2171 || [6.0.0+]
|-
| 2180 || [6.0.0+]
|-
| 2181 || [6.0.0+]
|-
| 2182 || [6.0.0+]
|-
| 2190 || [6.0.0+]
|-
| 2199 || [6.0.0+]
|-
| 2200 || [6.0.0+]
|-
| 2201 || [6.0.0+]
|-
| 2250 || [6.0.0+]
|-
| 2300 || [6.0.0+]
|-
|}

=== IApplicationVersionInterface ===
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetLaunchRequiredVersion
|-
| 1 || UpgradeLaunchRequiredVersion
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 800 || RequestVersionList
|-
| 801 || ListVersionList
|-
| 802 || RequestVersionListData
|-
| 1000 || PerformAutoUpdate
|-
|}

=== IContentManagerInterface ===
This is "nn::ns::detail::IContentManagementInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 43 || CheckSdCardMountStatus
|-
| 47 || GetTotalSpaceSize
|-
| 48 || GetFreeSpaceSize
|-
| 600 || CountApplicationContentMeta
|-
| 601 || ListApplicationContentMetaStatus
|-
| 605 || ListApplicationContentMetaStatusWithRightsCheck
|-
| 607 || IsAnyApplicationRunning
|-
|}

=== IDocumentInterface ===
This is "nn::ns::detail::IDocumentInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 21 || GetApplicationContentPath
|-
| 23 || ResolveApplicationContentPath
|-
|}

=== IDownloadTaskInterface ===
This is "nn::ns::detail::IDownloadTaskInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 701 || ClearTaskStatusList
|-
| 702 || RequestDownloadTaskList
|-
| 703 || RequestEnsureDownloadTask
|-
| 704 || ListDownloadTaskStatus
|-
| 705 || RequestDownloadTaskListData
|-
| 706 || TryCommitCurrentApplicationDownloadTask
|-
| 707 || EnableAutoCommit
|-
| 708 || DisableAutoCommit
|-
| 709 || TriggerDynamicCommitEvent
|-
|}

=== IECommerceInterface===
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || RequestLinkDevice
|-
|}

=== IFactoryResetInterface ===
This is "nn::ns::detail::IFactoryResetInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || ResetToFactorySettingsForRefurbishment
|-
|}

= ns:vm =
This is "nn::ns::detail::IVulnerabilityManagerInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1200 || [3.0.0+] NeedsUpdateVulnerability
|-
| 1201 || [4.0.0+] UpdateSafeSystemVersionForDebug
|-
| 1202 || [4.0.0+] GetSafeSystemVersion
|-
|}

= ns:su =
This is "nn::ns::detail::ISystemUpdateInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetBackgroundNetworkUpdateState
|-
| 1 || [[#ISystemUpdateControl|OpenSystemUpdateControl]]
|-
| 2 || NotifyExFatDriverRequired
|-
| 3 || ClearExFatDriverStatusForDebug
|-
| 4 || RequestBackgroundNetworkUpdate
|-
| 5 || NotifyBackgroundNetworkUpdate
|-
| 6 || NotifyExFatDriverDownloadedForDebug
|-
| 9 || GetSystemUpdateNotificationEventForContentDelivery
|-
| 10 || NotifySystemUpdateForContentDelivery
|-
| 11 || PrepareShutdown
|-
| 16 || DestroySystemUpdateTask
|-
| 17 || RequestSendSystemUpdate
|-
| 18 || GetSendSystemUpdateProgress
|-
|}

== ISystemUpdateControl ==
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || HasDownloaded
|-
| 1 || RequestCheckLatestUpdate
|-
| 2 || RequestDownloadLatestUpdate
|-
| 3 || GetDownloadProgress
|-
| 4 || ApplyDownloadedUpdate
|-
| 5 || RequestPrepareCardUpdate
|-
| 6 || GetPrepareCardUpdateProgress
|-
| 7 || HasPreparedCardUpdate
|-
| 8 || ApplyCardUpdate
|-
| 9 || GetDownloadedEulaDataSize
|-
| 10 || GetDownloadedEulaData
|-
| 11 || SetupCardUpdate
|-
| 12 || GetPreparedCardUpdateEulaDataSize
|-
| 13 || GetPreparedCardUpdateEulaData
|-
| 14 || SetupCardUpdateViaSystemUpdater
|-
| 15 || HasReceived
|-
| 16 || RequestReceiveSystemUpdate
|-
| 17 || GetReceiveProgress
|-
| 18 || ApplyReceivedUpdate
|-
| 19 || GetReceivedEulaDataSize
|-
| 20 || GetReceivedEulaData
|-
| 21 || SetupToReceiveSystemUpdate
|-
|}

= ns:dev =
This is "nn::ns::detail::IDevelopInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#LaunchProgram]]
|-
| 1 || [[#TerminateProcess]]
|-
| 2 || [[#TerminateProgram]]
|-
| 4 || [[#GetShellEventHandle]]
|-
| 5 || [[#GetShellEventInfo]]
|-
| 6 || [[#TerminateApplication]]
|-
| 7 || [[#PrepareLaunchProgramFromHost]]
|-
| 8 || [[#LaunchApplication_2|#LaunchApplication]]
|-
| 9 || [[#LaunchApplicationWithStorageId]]
|-
|}

== LaunchProgram ==
Wrapper for "pm:shell" [[Process_Manager_services#LaunchProcess|LaunchProcess]].

== TerminateProcess ==
Wrapper for "pm:shell" [[Process_Manager_services#TerminateTitleByPid|TerminateTitleByPid]].

== TerminateProgram ==
Wrapper for "pm:shell" [[Process_Manager_services#TerminateTitleByTitleId|TerminateTitleByTitleId]].

== GetShellEventHandle==
Wrapper for "pm:shell" [[Process_Manager_services#GetProcessEventWaiter|GetProcessEventWaiter]].

== GetShellEventInfo ==
Wrapper for "pm:shell" [[Process_Manager_services#GetProcessEventType|GetProcessEventType]].

== TerminateApplication ==
Calls "pm:shell" [[Process_Manager_services#GetCrashingProcessPid|GetCrashingProcessPid]] and sends PID to [[Process_Manager_services#TerminateTitleByPid|TerminateTitleByPid]].

== PrepareLaunchProgramFromHost ==
Takes a type-0x5 input buffer containing the [[Filesystem_services|ContentPath]], returns an output 0x10-byte struct.

Calls [[NCM_services#IPathResolverForStorage|IPathResolverForStorage]] Set...NcaPath functions.

== LaunchApplication ==
Takes an input u32 [[Process_Manager_services|launch_flags]] and u64 titleID, returns an output u64 PID.

Same as LaunchApplicationWithStorageId except the last two params passed to the internal vtable funcptr call are value 0x6, instead of from the command input.

== LaunchApplicationWithStorageId ==
Takes 2 input u8s, an u32 [[Process_Manager_services|launch_flags]], and an u64 titleID. Returns an output u64 PID.

Launches an application title which is registered with NS.

[[Category:Services]]

ETicket services

2018-08-31T10:24:24Z

Adubbz: Placeholder name for command 503

= es =
This is "nn::es::IETicketService".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || ImportTicket
|-
| 2 || ImportTicketCertificateSet
|-
| 3 || DeleteTicket
|-
| 4 || DeletePersonalizedTicket
|-
| 5 || DeleteAllCommonTicket
|-
| 6 || DeleteAllPersonalizedTicket
|-
| 7 || DeleteAllPersonalizedTicketEx
|-
| 8 || [2.0.0-5.1.0] GetTitleKey
|-
| 9 || CountCommonTicket
|-
| 10 || CountPersonalizedTicket
|-
| 11 || ListCommonTicket
|-
| 12 || ListPersonalizedTicket
|-
| 13 || ListMissingPersonalizedTicket
|-
| 14 || GetCommonTicketSize
|-
| 15 || [2.0.0-5.1.0] GetPersonalizedTicketSize
|-
| 16 || GetCommonTicketData
|-
| 17 || [2.0.0-5.1.0] GetPersonalizedTicketData
|-
| 18 || OwnTicket
|-
| 19 || GetTicketInfo
|-
| 20 || ListLightTicketInfo
|-
| 21 || [2.0.0+] SignData
|-
| 22 || [4.0.0+] GetCommonTicketAndCertificateSize
|-
| 23 || [4.0.0+] GetCommonTicketAndCertificateData
|-
| 24 || [4.0.0+] ImportPrepurchaseRecord
|-
| 25 || [4.0.0+] DeletePrepurchaseRecord
|-
| 26 || [4.0.0+] DeleteAllPrepurchaseRecord
|-
| 27 || [4.0.0+] CountPrepurchaseRecord
|-
| 28 || [4.0.0+] ListPrepurchaseRecord
|-
| 29 || [4.0.0+] ListPrepurchaseRecordInfo
|-
| 30 || [5.0.0+]
|-
| 31 || [5.0.0+]
|-
| 32 || [5.0.0+]
|-
| 33 || [5.0.0+]
|-
| 34 || [5.0.0+]
|-
| 35 || [5.0.0+]
|-
| 36 || [6.0.0+]
|-
| 501 || [6.0.0+]
|-
| 502 || [6.0.0+]
|-
| 503 || [6.0.0+] GetTitleKey2
|-
| 504 || [6.0.0+]
|-
| 508 || [6.0.0+]
|-
| 509 || [6.0.0+]
|-
| 510 || [6.0.0+]
|-
| 1001 || [6.0.0+]
|-
| 1002 || [6.0.0+]
|-
| 1003 || [6.0.0+]
|-
| 1004 || [6.0.0+]
|-
| 1005 || [6.0.0+]
|-
| 1006 || [6.0.0+]
|-
| 1007 || [6.0.0+]
|-
| 1009 || [6.0.0+]
|-
| 1010 || [6.0.0+]
|-
| 1011 || [6.0.0+]
|-
| 1012 || [6.0.0+]
|-
| 1013 || [6.0.0+]
|-
| 1014 || [6.0.0+]
|-
| 1015 || [6.0.0+]
|-
| 1016 || [6.0.0+]
|-
| 1501 || [6.0.0+]
|-
| 1502 || [6.0.0+]
|-
| 1503 || [6.0.0+]
|-
| 1504 || [6.0.0+]
|-
| 1505 || [6.0.0+]
|-
| 2000 || [6.0.0+]
|-
| 2501 || [6.0.0+]
|-
| 2502 || [6.0.0+]
|}

NS services

2018-08-31T09:39:13Z

Adubbz: Added 6.0.0 commands

= aoc:u =
This is "nn::aocsrv::detail::IAddOnContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CountAddOnContentByApplicationId
|-
| 1 || ListAddOnContentByApplicationId
|-
| 2 || CountAddOnContent
|-
| 3 || ListAddOnContent
|-
| 4 || GetAddOnContentBaseIdByApplicationId
|-
| 5 || GetAddOnContentBaseId
|-
| 6 || PrepareAddOnContentByApplicationId
|-
| 7 || PrepareAddOnContent
|-
| 8 || [4.0.0+] GetAddOnContentListChangedEvent
|}

= ns:am =
This is "nn::ns::detail::IApplicationManagerInterface".

[3.0.0+] This service was replaced by [[#ns:am2, ns:ec, ns:rid, ns:rt, ns:web|ns:am2]].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#ListApplicationRecord]]
|-
| 1 || GenerateApplicationRecordCount
|-
| 2 || GetApplicationRecordUpdateSystemEvent
|-
| 3 || GetApplicationViewDeprecated
|-
| 4 || DeleteApplicationEntity
|-
| 5 || DeleteApplicationCompletely
|-
| 6 || IsAnyApplicationEntityRedundant
|-
| 7 || DeleteRedundantApplicationEntity
|-
| 8 || IsApplicationEntityMovable
|-
| 9 || MoveApplicationEntity
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 16 || PushApplicationRecord
|-
| 17 || ListApplicationRecordContentMeta
|-
| 18 ||
|-
| 19 || [[#LaunchApplication]]
|-
| 21 || [[#GetApplicationContentPath]]
|-
| 22 || TerminateApplication
|-
| 23 || [2.0.0+] ResolveApplicationContentPath
|-
| 26 || BeginInstallApplication
|-
| 27 || DeleteApplicationRecord
|-
| 30 || RequestApplicationUpdateInfo
|-
| 31 || RequestUpdateApplication
|-
| 32 || CancelApplicationDownload
|-
| 33 || ResumeApplicationDownload
|-
| 34 ||
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 38 || CheckApplicationLaunchVersion
|-
| 39 || CheckApplicationLaunchRights
|-
| 40 || GetApplicationLogoData
|-
| 41 || CalculateApplicationDownloadRequiredSize
|-
| 42 || CleanupSdCard
|-
| 43 || CheckSdCardMountStatus
|-
| 44 || GetSdCardMountStatusChangedEvent
|-
| 45 || GetGameCardAttachmentEvent
|-
| 46 || GetGameCardAttachmentInfo
|-
| 47 || [[#GetTotalSpaceSize]]
|-
| 48 || [[#GetFreeSpaceSize]]
|-
| 49 || GetSdCardRemovedEvent
|-
| 52 || GetGameCardUpdateDetectionEvent
|-
| 53 || DisableApplicationAutoDelete
|-
| 54 || EnableApplicationAutoDelete
|-
| 55 || [[#GetApplicationDesiredLanguage]]
|-
| 56 || SetApplicationTerminateResult
|-
| 57 || ClearApplicationTerminateResult
|-
| 58 || GetLastSdCardMountUnexpectedResult
|-
| 59 || ConvertApplicationLanguageToLanguageCode
|-
| 60 || [[#ConvertLanguageCodeToApplicationLanguage]]
|-
| 61 || GetBackgroundDownloadStressTaskInfo
|-
| 62 || GetGameCardStopper
|-
| 63 || IsSystemProgramInstalled
|-
| 64 || [2.0.0+] StartApplyDeltaTask
|-
| 65 || [2.0.0+] GetRequestServerStopper
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || [2.0.0+] ResetToFactorySettingsForRefurbishment
|-
| 200 || CalculateUserSaveDataStatistics
|-
| 201 || DeleteUserSaveDataAll
|-
| 210 || DeleteUserSystemSaveData
|-
| 220 || UnregisterNetworkServiceAccount
|-
| 300 || GetApplicationShellEvent
|-
| 301 || PopApplicationShellEventInfo
|-
| 302 || LaunchLibraryApplet
|-
| 303 || TerminateLibraryApplet
|-
| 304 || LaunchSystemApplet
|-
| 305 || TerminateSystemApplet
|-
| 306 || LaunchOverlayApplet
|-
| 307 || TerminateOverlayApplet
|-
| 400 || [[#GetApplicationControlData]]
|-
| 401 || InvalidateAllApplicationControlCache
|-
| 402 || RequestDownloadApplicationControlData
|-
| 403 || GetMaxApplicationControlCacheCount
|-
| 404 || [2.0.0+] InvalidateApplicationControlCache
|-
| 405 || [2.0.0+] ListApplicationControlCacheEntryInfo
|-
| 502 || [2.0.0+] RequestCheckGameCardRegistration
|-
| 503 || [2.0.0+] RequestGameCardRegistrationGoldPoint
|-
| 504 || [2.0.0+] RequestRegisterGameCard
|-
| 600 || [2.0.0+] CountApplicationContentMeta
|-
| 601 || [2.0.0+] [[#ListApplicationContentMetaStatus]]
|-
| 602 || [2.0.0+] ListAvailableAddOnContent
|-
| 603 || [2.0.0+] GetOwnedApplicationContentMetaStatus
|-
| 604 || [2.0.0+] RegisterContentsExternalKey
|-
| 605 || [2.0.0+] ListApplicationContentMetaStatusWithRightsCheck
|-
| 700 || [2.0.0+] PushDownloadTaskList
|-
| 701 || [2.0.0+] ClearTaskStatusList
|-
| 702 || [2.0.0+] RequestDownloadTaskList
|-
| 703 || [2.0.0+] RequestEnsureDownloadTask
|-
| 704 || [2.0.0+] ListDownloadTaskStatus
|-
| 705 || [2.0.0+] RequestDownloadTaskListData
|-
| 800 || [2.0.0+] RequestVersionList
|-
| 801 || [2.0.0+] ListVersionList
|-
| 900 || [2.0.0+] GetApplicationRecord
|-
| 901 || [2.0.0+] GetApplicationRecordProperty
|-
| 902 || [2.0.0+] EnableApplicationAutoUpdate
|-
| 903 || [2.0.0+] DisableApplicationAutoUpdate
|-
| 904 || [2.0.0+] TouchApplication
|-
| 905 || [2.0.0+] RequestApplicationUpdate
|-
| 906 || [2.0.0+] IsApplicationUpdateRequested
|-
| 907 || [2.0.0+] WithdrawApplicationUpdateRequest
|-
| 908 || [2.0.0+] ListApplicationRecordInstalledContentMeta
|-
| 1000 || [2.0.0+] RequestVerifyApplicationDeprecated
|-
| 1001 || [2.0.0+] CorruptApplicationForDebug
|-
| 1200 || [2.0.0+] NeedsUpdateVulnerability
|-
| 1300 || [2.0.0+] IsAnyApplicationEntityInstalled
|-
| 1301 || [2.0.0+] DeleteApplicationContentEntities
|-
| 1302 || [2.0.0+] CleanupUnrecordedApplicationEntity
|-
| 1400 || [2.0.0+] PrepareShutdown
|-
| 1500 || [2.0.0+] FormatSdCard
|-
| 1501 || [2.0.0+] NeedsSystemUpdateToFormatSdCard
|-
| 1502 || [2.0.0+] GetLastSdCardFormatUnexpectedResult
|-
| 1503 || [2.0.0+]
|-
| 1600 || [2.0.0+] GetSystemSeedForPseudoDeviceId
|-
| 1700 || [2.0.0+] ListApplicationDownloadingContentMeta
|-
| 1800 || [2.0.0+] IsNotificationSetupCompleted
|-
| 1801 || [2.0.0+] GetLastNotificationInfoCount
|-
| 1802 || [2.0.0+] ListLastNotificationInfo
|}

== ListApplicationRecord ==
Takes a type-6 output buffer and an u64.

Returns an array of title-info entries using the specified offset and size. No input titleID is passed to this.

=== Application Record Format ===

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Title ID
|-
| 0x8
| 0x1
| Type? (Known values: 2=Installing?, 3=Gamecard?, 4=Installed?)
|-
| 0x9
| 0x1
| Unknown, usually 0x02
|-
| 0xA
| 0x6
| Unknown, usually zeros?
|-
| 0x10
| 0x1
| Unknown, seems to change between reboots and removing/reinserting gamecards
|-
| 0x11
| 0x7
| Unknown, usually zeros?
|}

== LaunchApplication ==
Takes an input u64 titleID, returns an output u64 PID.

Launches an application title which is registered with NS.

== GetApplicationContentPath ==
Takes a 0x16-type output buffer, an u8 [[NCA|type]], and an u64 titleID.

The input titleID is used with the application-title table like various other cmds, anything not in that table can't be used with this.

Returns a string path for the specified type of patch content with this titleID, otherwise returns regular-application paths when update-title not installed. Returns an error when the specified type of content doesn't exist for this title. Starts with "@{SdCardContent,UserContent}://" and ends in ".nca".

For gamecard content, the output path is: "@GcSXXXXXXXX:/<NcaId>.nca". NCA-type0 with gamecard returns 0 with an empty output string.

The output string is then used by the user-process with [[Filesystem_services|FS]] to mount the content.

== GetTotalSpaceSize ==
Takes an input media-id that must be 5.

Returns the u64 from [[Content_Manager_services#IContentStorage]] cmd22.

== GetFreeSpaceSize ==
Takes an input media-id that must be 5.

Returns the u64 from [[Content_Manager_services#IContentStorage]] cmd23.

== GetApplicationDesiredLanguage ==
Takes an input u8 language-bitmask, returns an output u8 [[control.nacp]] langentry index.

User-processes generate the language-bitmask with the following for all 16 lang-entries: <code>if(<either string in langentry[i] is non-empty>)bitmask |= 1<<i</code>

== ConvertLanguageCodeToApplicationLanguage ==
Takes an input u8 pointer for the resulting Id to be written to and a string represented as a u64 (i.e 0x53552D6E65 for 'en-US').

Returns 0 if an ID was successfully found, otherwise returns 0x25810.

== GetApplicationControlData ==
Takes an input u8 flag, an u64 titleID, and a type-0x6 output buffer. Returns an output u32 for actual_size. Official user-processes use buffer size 0x24000. [[qlaunch]] only uses flag value 0x1.

Loads cached [[control.nacp]] to buf+0 and the cached icon to buf+0x4000. Returns an error if the buffer is too small.

== ListApplicationContentMetaStatus ==
Returns 0x10-byte entries using the specified titleID starting at the specified u32 entryindex. Can only return game titles. The second entry if any is the update-title usually. When the input entryindex is >= totalentries, this will return 0 with out_entrycount=0.

Entry structure:
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| u8 "type". [[Content_Manager_services|Title type]] (String is from web-applet)
|-
| 0x1
| 0x1
| u8 "installedStorage" / [[Filesystem_services|StorageId]] (String is from web-applet)
|-
| 0x2
| 0x1
| Unknown. Non-zero with output from cmd 605, differs for app/update titles.
|-
| 0x3
| 0x1
| Padding
|-
| 0x4
| 0x4
| u32 Title-version
|-
| 0x8
| 0x8
| u64 titleID
|}

= ns:am2, ns:ec, ns:rid, ns:rt, ns:web =
These services are all, at the top level, "nn::ns::detail::IServiceGetterInterface". These commands check a state field for a command-specific bit and returns an error if not set, this is likely a permissions check for service+command.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 7992 || [[#IECommerceInterface|GetECommerceInterface]]
|-
| 7993 || [[#IApplicationVersionInterface|GetApplicationVersionInterface]]
|-
| 7994 || [[#IFactoryResetInterface|GetFactoryResetInterface]]
|-
| 7995 || [[#IAccountProxyInterface|GetAccountProxyInterface]]
|-
| 7996 || [[#IApplicationManagerInterface|GetApplicationManagerInterface]]
|-
| 7997 || [[#IDownloadTaskInterface|GetDownloadTaskInterface]]
|-
| 7998 || [[#IContentManagementInterface|GetContentManagementInterface]]
|-
| 7999 || [[#IDocumentInterface|GetDocumentInterface]]
|-
|}

=== IAccountProxyInterface ===
This is "nn::ns::detail::IAccountProxyInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CreateUserAccount
|-
|}

=== IApplicationManagerInterface ===
This is "nn::ns::detail::IApplicationManagerInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#ListApplicationRecord]]
|-
| 1 || GenerateApplicationRecordCount
|-
| 2 || GetApplicationRecordUpdateSystemEvent
|-
| 3 || GetApplicationViewDeprecated
|-
| 4 || DeleteApplicationEntity
|-
| 5 || DeleteApplicationCompletely
|-
| 6 || IsAnyApplicationEntityRedundant
|-
| 7 || DeleteRedundantApplicationEntity
|-
| 8 || IsApplicationEntityMovable
|-
| 9 || MoveApplicationEntity
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 16 || PushApplicationRecord
|-
| 17 || ListApplicationRecordContentMeta
|-
| 19 || [?.?.?-5.1.0] [[#LaunchApplication]]
|-
| 21 || [[#GetApplicationContentPath]]
|-
| 22 || TerminateApplication
|-
| 23 || ResolveApplicationContentPath
|-
| 26 || BeginInstallApplication
|-
| 27 || DeleteApplicationRecord
|-
| 30 || RequestApplicationUpdateInfo
|-
| 32 || CancelApplicationDownload
|-
| 33 || ResumeApplicationDownload
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 38 || CheckApplicationLaunchVersion
|-
| 39 || CheckApplicationLaunchRights
|-
| 40 || GetApplicationLogoData
|-
| 41 || CalculateApplicationDownloadRequiredSize
|-
| 42 || CleanupSdCard
|-
| 43 || CheckSdCardMountStatus
|-
| 44 || GetSdCardMountStatusChangedEvent
|-
| 45 || GetGameCardAttachmentEvent
|-
| 46 || GetGameCardAttachmentInfo
|-
| 47 || [[#GetTotalSpaceSize]]
|-
| 48 || [[#GetFreeSpaceSize]]
|-
| 49 || GetSdCardRemovedEvent
|-
| 52 || GetGameCardUpdateDetectionEvent
|-
| 53 || DisableApplicationAutoDelete
|-
| 54 || EnableApplicationAutoDelete
|-
| 55 || GetApplicationDesiredLanguage
|-
| 56 || SetApplicationTerminateResult
|-
| 57 || ClearApplicationTerminateResult
|-
| 58 || GetLastSdCardMountUnexpectedResult
|-
| 59 || ConvertApplicationLanguageToLanguageCode
|-
| 60 || [[#ConvertLanguageCodeToApplicationLanguage]]
|-
| 61 || GetBackgroundDownloadStressTaskInfo
|-
| 62 || GetGameCardStopper
|-
| 63 || IsSystemProgramInstalled
|-
| 64 || StartApplyDeltaTask
|-
| 65 || GetRequestServerStopper
|-
| 66 || GetBackgroundApplyDeltaStressTaskInfo
|-
| 67 || CancelApplicationApplyDelta
|-
| 68 || ResumeApplicationApplyDelta
|-
| 69 || CalculateApplicationApplyDeltaRequiredSize
|-
| 70 || ResumeAll
|-
| 71 || GetStorageSize
|-
| 80 || RequestDownloadApplication
|-
| 81 || RequestDownloadAddOnContent
|-
| 82 || DownloadApplication
|-
| 83 || CheckApplicationResumeRights
|-
| 84 || GetDynamicCommitEvent
|-
| 85 || RequestUpdateApplication2
|-
| 86 || EnableApplicationCrashReport
|-
| 87 || IsApplicationCrashReportEnabled
|-
| 90 || BoostSystemMemoryResourceLimit
|-
| 91 || [6.0.0+]
|-
| 92 || [6.0.0+]
|-
| 93 || [6.0.0+]
|-
| 94 || [6.0.0+]
|-
| 95 || [6.0.0+]
|-
| 96 || [6.0.0+]
|-
| 97 || [6.0.0+]
|-
| 98 || [6.0.0+]
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || ResetToFactorySettingsForRefurbishment
|-
| 200 || CalculateUserSaveDataStatistics
|-
| 201 || DeleteUserSaveDataAll
|-
| 210 || DeleteUserSystemSaveData
|-
| 211 || [6.0.0+]
|-
| 220 || UnregisterNetworkServiceAccount
|-
| 221 || [6.0.0+]
|-
| 300 || GetApplicationShellEvent
|-
| 301 || PopApplicationShellEventInfo
|-
| 302 || LaunchLibraryApplet
|-
| 303 || TerminateLibraryApplet
|-
| 304 || LaunchSystemApplet
|-
| 305 || TerminateSystemApplet
|-
| 306 || LaunchOverlayApplet
|-
| 307 || TerminateOverlayApplet
|-
| 400 || GetApplicationControlData
|-
| 401 || InvalidateAllApplicationControlCache
|-
| 402 || RequestDownloadApplicationControlData
|-
| 403 || GetMaxApplicationControlCacheCount
|-
| 404 || InvalidateApplicationControlCache
|-
| 405 || ListApplicationControlCacheEntryInfo
|-
| 406 || [6.0.0+]
|-
| 502 || RequestCheckGameCardRegistration
|-
| 503 || RequestGameCardRegistrationGoldPoint
|-
| 504 || RequestRegisterGameCard
|-
| 505 || GetGameCardMountFailureEvent
|-
| 506 || IsGameCardInserted
|-
| 507 || EnsureGameCardAccess
|-
| 508 || GetLastGameCardMountFailureResult
|-
| 509 || ListApplicationIdOnGameCard
|-
| 600 || CountApplicationContentMeta
|-
| 601 || [[#ListApplicationContentMetaStatus]]
|-
| 602 || [?.?.?-5.1.0] ListAvailableAddOnContent
|-
| 603 || GetOwnedApplicationContentMetaStatus
|-
| 604 || RegisterContentsExternalKey
|-
| 605 || ListApplicationContentMetaStatusWithRightsCheck
|-
| 606 || GetContentMetaStorage
|-
| 607 || [6.0.0+]
|-
| 700 || PushDownloadTaskList
|-
| 701 || ClearTaskStatusList
|-
| 702 || RequestDownloadTaskList
|-
| 703 || RequestEnsureDownloadTask
|-
| 704 || ListDownloadTaskStatus
|-
| 705 || RequestDownloadTaskListData
|-
| 800 || RequestVersionList
|-
| 801 || ListVersionList
|-
| 802 || RequestVersionListData
|-
| 900 || GetApplicationRecord
|-
| 901 || GetApplicationRecordProperty
|-
| 902 || EnableApplicationAutoUpdate
|-
| 903 || DisableApplicationAutoUpdate
|-
| 904 || TouchApplication
|-
| 905 || RequestApplicationUpdate
|-
| 906 || IsApplicationUpdateRequested
|-
| 907 || WithdrawApplicationUpdateRequest
|-
| 908 || ListApplicationRecordInstalledContentMeta
|-
| 909 || WithdrawCleanupAddOnContentsWithNoRightsRecommendation
|-
| 910 || [6.0.0+]
|-
| 911 || [6.0.0+]
|-
| 912 || [6.0.0+]
|-
| 1000 || RequestVerifyApplicationDeprecated
|-
| 1001 || CorruptApplicationForDebug
|-
| 1002 || RequestVerifyAddOnContentsRights
|-
| 1003 || RequestVerifyApplication
|-
| 1004 || CorruptContentForDebug
|-
| 1200 || NeedsUpdateVulnerability
|-
| 1300 || IsAnyApplicationEntityInstalled
|-
| 1301 || DeleteApplicationContentEntities
|-
| 1302 || CleanupUnrecordedApplicationEntity
|-
| 1303 || CleanupAddOnContentsWithNoRights
|-
| 1304 || DeleteApplicationContentEntity
|-
| 1305 || [?.?.?-5.1.0] TryDeleteRunningApplicationEntity
|-
| 1306 || [?.?.?-5.1.0] TryDeleteRunningApplicationCompletely
|-
| 1307 || [?.?.?-5.1.0] TryDeleteRunningApplicationContentEntities
|-
| 1308 || [6.0.0+]
|-
| 1309 || [6.0.0+]
|-
| 1400 || PrepareShutdown
|-
| 1500 || FormatSdCard
|-
| 1501 || NeedsSystemUpdateToFormatSdCard
|-
| 1502 || GetLastSdCardFormatUnexpectedResult
|-
| 1504 || InsertSdCard
|-
| 1505 || RemoveSdCard
|-
| 1600 || GetSystemSeedForPseudoDeviceId
|-
| 1601 || ResetSystemSeedForPseudoDeviceId
|-
| 1700 || ListApplicationDownloadingContentMeta
|-
| 1701 || GetApplicationView
|-
| 1702 || GetApplicationDownloadTaskStatus
|-
| 1703 || GetApplicationViewDownloadErrorContext
|-
| 1800 || IsNotificationSetupCompleted
|-
| 1801 || GetLastNotificationInfoCount
|-
| 1802 || ListLastNotificationInfo
|-
| 1803 || ListNotificationTask
|-
| 1900 || IsActiveAccount
|-
| 1901 || RequestDownloadApplicationPrepurchasedRights
|-
| 1902 || GetApplicationTicketInfo
|-
| 2000 || GetSystemDeliveryInfo
|-
| 2001 || SelectLatestSystemDeliveryInfo
|-
| 2002 || VerifyDeliveryProtocolVersion
|-
| 2003 || GetApplicationDeliveryInfo
|-
| 2004 || HasAllContentsToDeliver
|-
| 2005 || CompareApplicationDeliveryInfo
|-
| 2006 || CanDeliverApplication
|-
| 2007 || ListContentMetaKeyToDeliverApplication
|-
| 2008 || NeedsSystemUpdateToDeliverApplication
|-
| 2009 || EstimateRequiredSize
|-
| 2010 || RequestReceiveApplication
|-
| 2011 || CommitReceiveApplication
|-
| 2012 || GetReceiveApplicationProgress
|-
| 2013 || RequestSendApplication
|-
| 2014 || GetSendApplicationProgress
|-
| 2015 || CompareSystemDeliveryInfo
|-
| 2016 || ListNotCommittedContentMeta
|-
| 2017 || CreateDownloadTask
|-
| 2018 || [6.0.0+]
|-
| 2050 || [6.0.0+]
|-
| 2100 || [6.0.0+]
|-
| 2101 || [6.0.0+]
|-
| 2150 || [6.0.0+]
|-
| 2151 || [6.0.0+]
|-
| 2152 || [6.0.0+]
|-
| 2153 || [6.0.0+]
|-
| 2154 || [6.0.0+]
|-
| 2160 || [6.0.0+]
|-
| 2161 || [6.0.0+]
|-
| 2170 || [6.0.0+]
|-
| 2171 || [6.0.0+]
|-
| 2180 || [6.0.0+]
|-
| 2181 || [6.0.0+]
|-
| 2182 || [6.0.0+]
|-
| 2190 || [6.0.0+]
|-
| 2199 || [6.0.0+]
|-
| 2200 || [6.0.0+]
|-
| 2201 || [6.0.0+]
|-
| 2250 || [6.0.0+]
|-
| 2300 || [6.0.0+]
|-
|}

=== IApplicationVersionInterface ===
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetLaunchRequiredVersion
|-
| 1 || UpgradeLaunchRequiredVersion
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 800 || RequestVersionList
|-
| 801 || ListVersionList
|-
| 802 || RequestVersionListData
|-
| 1000 || PerformAutoUpdate
|-
|}

=== IContentManagerInterface ===
This is "nn::ns::detail::IContentManagementInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 43 || CheckSdCardMountStatus
|-
| 47 || GetTotalSpaceSize
|-
| 48 || GetFreeSpaceSize
|-
| 600 || CountApplicationContentMeta
|-
| 601 || ListApplicationContentMetaStatus
|-
| 605 || ListApplicationContentMetaStatusWithRightsCheck
|-
| 607 || IsAnyApplicationRunning
|-
|}

=== IDocumentInterface ===
This is "nn::ns::detail::IDocumentInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 21 || GetApplicationContentPath
|-
| 23 || ResolveApplicationContentPath
|-
|}

=== IDownloadTaskInterface ===
This is "nn::ns::detail::IDownloadTaskInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 701 || ClearTaskStatusList
|-
| 702 || RequestDownloadTaskList
|-
| 703 || RequestEnsureDownloadTask
|-
| 704 || ListDownloadTaskStatus
|-
| 705 || RequestDownloadTaskListData
|-
| 706 || TryCommitCurrentApplicationDownloadTask
|-
| 707 || EnableAutoCommit
|-
| 708 || DisableAutoCommit
|-
| 709 || TriggerDynamicCommitEvent
|-
|}

=== IECommerceInterface===
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || RequestLinkDevice
|-
|}

=== IFactoryResetInterface ===
This is "nn::ns::detail::IFactoryResetInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || ResetToFactorySettingsForRefurbishment
|-
|}

= ns:vm =
This is "nn::ns::detail::IVulnerabilityManagerInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1200 || [3.0.0+] NeedsUpdateVulnerability
|-
| 1201 || [4.0.0+] UpdateSafeSystemVersionForDebug
|-
| 1202 || [4.0.0+] GetSafeSystemVersion
|-
|}

= ns:su =
This is "nn::ns::detail::ISystemUpdateInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetBackgroundNetworkUpdateState
|-
| 1 || [[#ISystemUpdateControl|OpenSystemUpdateControl]]
|-
| 2 || NotifyExFatDriverRequired
|-
| 3 || ClearExFatDriverStatusForDebug
|-
| 4 || RequestBackgroundNetworkUpdate
|-
| 5 || NotifyBackgroundNetworkUpdate
|-
| 6 || NotifyExFatDriverDownloadedForDebug
|-
| 9 || GetSystemUpdateNotificationEventForContentDelivery
|-
| 10 || NotifySystemUpdateForContentDelivery
|-
| 11 || PrepareShutdown
|-
| 16 || DestroySystemUpdateTask
|-
| 17 || RequestSendSystemUpdate
|-
| 18 || GetSendSystemUpdateProgress
|-
|}

== ISystemUpdateControl ==
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || HasDownloaded
|-
| 1 || RequestCheckLatestUpdate
|-
| 2 || RequestDownloadLatestUpdate
|-
| 3 || GetDownloadProgress
|-
| 4 || ApplyDownloadedUpdate
|-
| 5 || RequestPrepareCardUpdate
|-
| 6 || GetPrepareCardUpdateProgress
|-
| 7 || HasPreparedCardUpdate
|-
| 8 || ApplyCardUpdate
|-
| 9 || GetDownloadedEulaDataSize
|-
| 10 || GetDownloadedEulaData
|-
| 11 || SetupCardUpdate
|-
| 12 || GetPreparedCardUpdateEulaDataSize
|-
| 13 || GetPreparedCardUpdateEulaData
|-
| 14 || SetupCardUpdateViaSystemUpdater
|-
| 15 || HasReceived
|-
| 16 || RequestReceiveSystemUpdate
|-
| 17 || GetReceiveProgress
|-
| 18 || ApplyReceivedUpdate
|-
| 19 || GetReceivedEulaDataSize
|-
| 20 || GetReceivedEulaData
|-
| 21 || SetupToReceiveSystemUpdate
|-
|}

= ns:dev =
This is "nn::ns::detail::IDevelopInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#LaunchProgram]]
|-
| 1 || [[#TerminateProcess]]
|-
| 2 || [[#TerminateProgram]]
|-
| 4 || [[#GetShellEventHandle]]
|-
| 5 || [[#GetShellEventInfo]]
|-
| 6 || [[#TerminateApplication]]
|-
| 7 || [[#PrepareLaunchProgramFromHost]]
|-
| 8 || [[#LaunchApplication_2|#LaunchApplication]]
|-
| 9 || [[#LaunchApplicationWithStorageId]]
|-
|}

== LaunchProgram ==
Wrapper for "pm:shell" [[Process_Manager_services#LaunchProcess|LaunchProcess]].

== TerminateProcess ==
Wrapper for "pm:shell" [[Process_Manager_services#TerminateTitleByPid|TerminateTitleByPid]].

== TerminateProgram ==
Wrapper for "pm:shell" [[Process_Manager_services#TerminateTitleByTitleId|TerminateTitleByTitleId]].

== GetShellEventHandle==
Wrapper for "pm:shell" [[Process_Manager_services#GetProcessEventWaiter|GetProcessEventWaiter]].

== GetShellEventInfo ==
Wrapper for "pm:shell" [[Process_Manager_services#GetProcessEventType|GetProcessEventType]].

== TerminateApplication ==
Calls "pm:shell" [[Process_Manager_services#GetCrashingProcessPid|GetCrashingProcessPid]] and sends PID to [[Process_Manager_services#TerminateTitleByPid|TerminateTitleByPid]].

== PrepareLaunchProgramFromHost ==
Takes a type-0x5 input buffer containing the [[Filesystem_services|ContentPath]], returns an output 0x10-byte struct.

Calls [[NCM_services#IPathResolverForStorage|IPathResolverForStorage]] Set...NcaPath functions.

== LaunchApplication ==
Takes an input u32 [[Process_Manager_services|launch_flags]] and u64 titleID, returns an output u64 PID.

Same as LaunchApplicationWithStorageId except the last two params passed to the internal vtable funcptr call are value 0x6, instead of from the command input.

== LaunchApplicationWithStorageId ==
Takes 2 input u8s, an u32 [[Process_Manager_services|launch_flags]], and an u64 titleID. Returns an output u64 PID.

Launches an application title which is registered with NS.

[[Category:Services]]

NS services

2018-08-31T08:29:34Z

Adubbz: Goodnight Sweet Price

= aoc:u =
This is "nn::aocsrv::detail::IAddOnContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CountAddOnContentByApplicationId
|-
| 1 || ListAddOnContentByApplicationId
|-
| 2 || CountAddOnContent
|-
| 3 || ListAddOnContent
|-
| 4 || GetAddOnContentBaseIdByApplicationId
|-
| 5 || GetAddOnContentBaseId
|-
| 6 || PrepareAddOnContentByApplicationId
|-
| 7 || PrepareAddOnContent
|-
| 8 || [4.0.0+] GetAddOnContentListChangedEvent
|}

= ns:am =
This is "nn::ns::detail::IApplicationManagerInterface".

[3.0.0+] This service was replaced by [[#ns:am2, ns:ec, ns:rid, ns:rt, ns:web|ns:am2]].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#ListApplicationRecord]]
|-
| 1 || GenerateApplicationRecordCount
|-
| 2 || GetApplicationRecordUpdateSystemEvent
|-
| 3 || GetApplicationViewDeprecated
|-
| 4 || DeleteApplicationEntity
|-
| 5 || DeleteApplicationCompletely
|-
| 6 || IsAnyApplicationEntityRedundant
|-
| 7 || DeleteRedundantApplicationEntity
|-
| 8 || IsApplicationEntityMovable
|-
| 9 || MoveApplicationEntity
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 16 || PushApplicationRecord
|-
| 17 || ListApplicationRecordContentMeta
|-
| 18 ||
|-
| 19 || [1.0.0-5.1.0] [[#LaunchApplication]]
|-
| 21 || [[#GetApplicationContentPath]]
|-
| 22 || TerminateApplication
|-
| 23 || [2.0.0+] ResolveApplicationContentPath
|-
| 26 || BeginInstallApplication
|-
| 27 || DeleteApplicationRecord
|-
| 30 || RequestApplicationUpdateInfo
|-
| 31 || RequestUpdateApplication
|-
| 32 || CancelApplicationDownload
|-
| 33 || ResumeApplicationDownload
|-
| 34 ||
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 38 || CheckApplicationLaunchVersion
|-
| 39 || CheckApplicationLaunchRights
|-
| 40 || GetApplicationLogoData
|-
| 41 || CalculateApplicationDownloadRequiredSize
|-
| 42 || CleanupSdCard
|-
| 43 || CheckSdCardMountStatus
|-
| 44 || GetSdCardMountStatusChangedEvent
|-
| 45 || GetGameCardAttachmentEvent
|-
| 46 || GetGameCardAttachmentInfo
|-
| 47 || [[#GetTotalSpaceSize]]
|-
| 48 || [[#GetFreeSpaceSize]]
|-
| 49 || GetSdCardRemovedEvent
|-
| 52 || GetGameCardUpdateDetectionEvent
|-
| 53 || DisableApplicationAutoDelete
|-
| 54 || EnableApplicationAutoDelete
|-
| 55 || [[#GetApplicationDesiredLanguage]]
|-
| 56 || SetApplicationTerminateResult
|-
| 57 || ClearApplicationTerminateResult
|-
| 58 || GetLastSdCardMountUnexpectedResult
|-
| 59 || ConvertApplicationLanguageToLanguageCode
|-
| 60 || [[#ConvertLanguageCodeToApplicationLanguage]]
|-
| 61 || GetBackgroundDownloadStressTaskInfo
|-
| 62 || GetGameCardStopper
|-
| 63 || IsSystemProgramInstalled
|-
| 64 || [2.0.0+] StartApplyDeltaTask
|-
| 65 || [2.0.0+] GetRequestServerStopper
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || [2.0.0+] ResetToFactorySettingsForRefurbishment
|-
| 200 || CalculateUserSaveDataStatistics
|-
| 201 || DeleteUserSaveDataAll
|-
| 210 || DeleteUserSystemSaveData
|-
| 220 || UnregisterNetworkServiceAccount
|-
| 300 || GetApplicationShellEvent
|-
| 301 || PopApplicationShellEventInfo
|-
| 302 || LaunchLibraryApplet
|-
| 303 || TerminateLibraryApplet
|-
| 304 || LaunchSystemApplet
|-
| 305 || TerminateSystemApplet
|-
| 306 || LaunchOverlayApplet
|-
| 307 || TerminateOverlayApplet
|-
| 400 || [[#GetApplicationControlData]]
|-
| 401 || InvalidateAllApplicationControlCache
|-
| 402 || RequestDownloadApplicationControlData
|-
| 403 || GetMaxApplicationControlCacheCount
|-
| 404 || [2.0.0+] InvalidateApplicationControlCache
|-
| 405 || [2.0.0+] ListApplicationControlCacheEntryInfo
|-
| 502 || [2.0.0+] RequestCheckGameCardRegistration
|-
| 503 || [2.0.0+] RequestGameCardRegistrationGoldPoint
|-
| 504 || [2.0.0+] RequestRegisterGameCard
|-
| 600 || [2.0.0+] CountApplicationContentMeta
|-
| 601 || [2.0.0+] [[#ListApplicationContentMetaStatus]]
|-
| 602 || [2.0.0+] ListAvailableAddOnContent
|-
| 603 || [2.0.0+] GetOwnedApplicationContentMetaStatus
|-
| 604 || [2.0.0+] RegisterContentsExternalKey
|-
| 605 || [2.0.0+] ListApplicationContentMetaStatusWithRightsCheck
|-
| 700 || [2.0.0+] PushDownloadTaskList
|-
| 701 || [2.0.0+] ClearTaskStatusList
|-
| 702 || [2.0.0+] RequestDownloadTaskList
|-
| 703 || [2.0.0+] RequestEnsureDownloadTask
|-
| 704 || [2.0.0+] ListDownloadTaskStatus
|-
| 705 || [2.0.0+] RequestDownloadTaskListData
|-
| 800 || [2.0.0+] RequestVersionList
|-
| 801 || [2.0.0+] ListVersionList
|-
| 900 || [2.0.0+] GetApplicationRecord
|-
| 901 || [2.0.0+] GetApplicationRecordProperty
|-
| 902 || [2.0.0+] EnableApplicationAutoUpdate
|-
| 903 || [2.0.0+] DisableApplicationAutoUpdate
|-
| 904 || [2.0.0+] TouchApplication
|-
| 905 || [2.0.0+] RequestApplicationUpdate
|-
| 906 || [2.0.0+] IsApplicationUpdateRequested
|-
| 907 || [2.0.0+] WithdrawApplicationUpdateRequest
|-
| 908 || [2.0.0+] ListApplicationRecordInstalledContentMeta
|-
| 1000 || [2.0.0+] RequestVerifyApplicationDeprecated
|-
| 1001 || [2.0.0+] CorruptApplicationForDebug
|-
| 1200 || [2.0.0+] NeedsUpdateVulnerability
|-
| 1300 || [2.0.0+] IsAnyApplicationEntityInstalled
|-
| 1301 || [2.0.0+] DeleteApplicationContentEntities
|-
| 1302 || [2.0.0+] CleanupUnrecordedApplicationEntity
|-
| 1400 || [2.0.0+] PrepareShutdown
|-
| 1500 || [2.0.0+] FormatSdCard
|-
| 1501 || [2.0.0+] NeedsSystemUpdateToFormatSdCard
|-
| 1502 || [2.0.0+] GetLastSdCardFormatUnexpectedResult
|-
| 1503 || [2.0.0+]
|-
| 1600 || [2.0.0+] GetSystemSeedForPseudoDeviceId
|-
| 1700 || [2.0.0+] ListApplicationDownloadingContentMeta
|-
| 1800 || [2.0.0+] IsNotificationSetupCompleted
|-
| 1801 || [2.0.0+] GetLastNotificationInfoCount
|-
| 1802 || [2.0.0+] ListLastNotificationInfo
|}

== ListApplicationRecord ==
Takes a type-6 output buffer and an u64.

Returns an array of title-info entries using the specified offset and size. No input titleID is passed to this.

=== Application Record Format ===

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Title ID
|-
| 0x8
| 0x1
| Type? (Known values: 2=Installing?, 3=Gamecard?, 4=Installed?)
|-
| 0x9
| 0x1
| Unknown, usually 0x02
|-
| 0xA
| 0x6
| Unknown, usually zeros?
|-
| 0x10
| 0x1
| Unknown, seems to change between reboots and removing/reinserting gamecards
|-
| 0x11
| 0x7
| Unknown, usually zeros?
|}

== LaunchApplication ==
Takes an input u64 titleID, returns an output u64 PID.

Launches an application title which is registered with NS.

== GetApplicationContentPath ==
Takes a 0x16-type output buffer, an u8 [[NCA|type]], and an u64 titleID.

The input titleID is used with the application-title table like various other cmds, anything not in that table can't be used with this.

Returns a string path for the specified type of patch content with this titleID, otherwise returns regular-application paths when update-title not installed. Returns an error when the specified type of content doesn't exist for this title. Starts with "@{SdCardContent,UserContent}://" and ends in ".nca".

For gamecard content, the output path is: "@GcSXXXXXXXX:/<NcaId>.nca". NCA-type0 with gamecard returns 0 with an empty output string.

The output string is then used by the user-process with [[Filesystem_services|FS]] to mount the content.

== GetTotalSpaceSize ==
Takes an input media-id that must be 5.

Returns the u64 from [[Content_Manager_services#IContentStorage]] cmd22.

== GetFreeSpaceSize ==
Takes an input media-id that must be 5.

Returns the u64 from [[Content_Manager_services#IContentStorage]] cmd23.

== GetApplicationDesiredLanguage ==
Takes an input u8 language-bitmask, returns an output u8 [[control.nacp]] langentry index.

User-processes generate the language-bitmask with the following for all 16 lang-entries: <code>if(<either string in langentry[i] is non-empty>)bitmask |= 1<<i</code>

== ConvertLanguageCodeToApplicationLanguage ==
Takes an input u8 pointer for the resulting Id to be written to and a string represented as a u64 (i.e 0x53552D6E65 for 'en-US').

Returns 0 if an ID was successfully found, otherwise returns 0x25810.

== GetApplicationControlData ==
Takes an input u8 flag, an u64 titleID, and a type-0x6 output buffer. Returns an output u32 for actual_size. Official user-processes use buffer size 0x24000. [[qlaunch]] only uses flag value 0x1.

Loads cached [[control.nacp]] to buf+0 and the cached icon to buf+0x4000. Returns an error if the buffer is too small.

== ListApplicationContentMetaStatus ==
Returns 0x10-byte entries using the specified titleID starting at the specified u32 entryindex. Can only return game titles. The second entry if any is the update-title usually. When the input entryindex is >= totalentries, this will return 0 with out_entrycount=0.

Entry structure:
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| u8 "type". [[Content_Manager_services|Title type]] (String is from web-applet)
|-
| 0x1
| 0x1
| u8 "installedStorage" / [[Filesystem_services|StorageId]] (String is from web-applet)
|-
| 0x2
| 0x1
| Unknown. Non-zero with output from cmd 605, differs for app/update titles.
|-
| 0x3
| 0x1
| Padding
|-
| 0x4
| 0x4
| u32 Title-version
|-
| 0x8
| 0x8
| u64 titleID
|}

= ns:am2, ns:ec, ns:rid, ns:rt, ns:web =
These services are all, at the top level, "nn::ns::detail::IServiceGetterInterface". These commands check a state field for a command-specific bit and returns an error if not set, this is likely a permissions check for service+command.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 7992 || [[#IECommerceInterface|GetECommerceInterface]]
|-
| 7993 || [[#IApplicationVersionInterface|GetApplicationVersionInterface]]
|-
| 7994 || [[#IFactoryResetInterface|GetFactoryResetInterface]]
|-
| 7995 || [[#IAccountProxyInterface|GetAccountProxyInterface]]
|-
| 7996 || [[#IApplicationManagerInterface|GetApplicationManagerInterface]]
|-
| 7997 || [[#IDownloadTaskInterface|GetDownloadTaskInterface]]
|-
| 7998 || [[#IContentManagementInterface|GetContentManagementInterface]]
|-
| 7999 || [[#IDocumentInterface|GetDocumentInterface]]
|-
|}

=== IAccountProxyInterface ===
This is "nn::ns::detail::IAccountProxyInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || CreateUserAccount
|-
|}

=== IApplicationManagerInterface ===
This is "nn::ns::detail::IApplicationManagerInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#ListApplicationRecord]]
|-
| 1 || GenerateApplicationRecordCount
|-
| 2 || GetApplicationRecordUpdateSystemEvent
|-
| 3 || GetApplicationViewDeprecated
|-
| 4 || DeleteApplicationEntity
|-
| 5 || DeleteApplicationCompletely
|-
| 6 || IsAnyApplicationEntityRedundant
|-
| 7 || DeleteRedundantApplicationEntity
|-
| 8 || IsApplicationEntityMovable
|-
| 9 || MoveApplicationEntity
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 16 || PushApplicationRecord
|-
| 17 || ListApplicationRecordContentMeta
|-
| 19 || [[#LaunchApplication]]
|-
| 21 || [[#GetApplicationContentPath]]
|-
| 22 || TerminateApplication
|-
| 23 || ResolveApplicationContentPath
|-
| 26 || BeginInstallApplication
|-
| 27 || DeleteApplicationRecord
|-
| 30 || RequestApplicationUpdateInfo
|-
| 32 || CancelApplicationDownload
|-
| 33 || ResumeApplicationDownload
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 38 || CheckApplicationLaunchVersion
|-
| 39 || CheckApplicationLaunchRights
|-
| 40 || GetApplicationLogoData
|-
| 41 || CalculateApplicationDownloadRequiredSize
|-
| 42 || CleanupSdCard
|-
| 43 || CheckSdCardMountStatus
|-
| 44 || GetSdCardMountStatusChangedEvent
|-
| 45 || GetGameCardAttachmentEvent
|-
| 46 || GetGameCardAttachmentInfo
|-
| 47 || [[#GetTotalSpaceSize]]
|-
| 48 || [[#GetFreeSpaceSize]]
|-
| 49 || GetSdCardRemovedEvent
|-
| 52 || GetGameCardUpdateDetectionEvent
|-
| 53 || DisableApplicationAutoDelete
|-
| 54 || EnableApplicationAutoDelete
|-
| 55 || GetApplicationDesiredLanguage
|-
| 56 || SetApplicationTerminateResult
|-
| 57 || ClearApplicationTerminateResult
|-
| 58 || GetLastSdCardMountUnexpectedResult
|-
| 59 || ConvertApplicationLanguageToLanguageCode
|-
| 60 || [[#ConvertLanguageCodeToApplicationLanguage]]
|-
| 61 || GetBackgroundDownloadStressTaskInfo
|-
| 62 || GetGameCardStopper
|-
| 63 || IsSystemProgramInstalled
|-
| 64 || StartApplyDeltaTask
|-
| 65 || GetRequestServerStopper
|-
| 66 || GetBackgroundApplyDeltaStressTaskInfo
|-
| 67 || CancelApplicationApplyDelta
|-
| 68 || ResumeApplicationApplyDelta
|-
| 69 || CalculateApplicationApplyDeltaRequiredSize
|-
| 70 || ResumeAll
|-
| 71 || GetStorageSize
|-
| 80 || RequestDownloadApplication
|-
| 81 || RequestDownloadAddOnContent
|-
| 82 || DownloadApplication
|-
| 83 || CheckApplicationResumeRights
|-
| 84 || GetDynamicCommitEvent
|-
| 85 || RequestUpdateApplication2
|-
| 86 || EnableApplicationCrashReport
|-
| 87 || IsApplicationCrashReportEnabled
|-
| 90 || BoostSystemMemoryResourceLimit
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || ResetToFactorySettingsForRefurbishment
|-
| 200 || CalculateUserSaveDataStatistics
|-
| 201 || DeleteUserSaveDataAll
|-
| 210 || DeleteUserSystemSaveData
|-
| 220 || UnregisterNetworkServiceAccount
|-
| 300 || GetApplicationShellEvent
|-
| 301 || PopApplicationShellEventInfo
|-
| 302 || LaunchLibraryApplet
|-
| 303 || TerminateLibraryApplet
|-
| 304 || LaunchSystemApplet
|-
| 305 || TerminateSystemApplet
|-
| 306 || LaunchOverlayApplet
|-
| 307 || TerminateOverlayApplet
|-
| 400 || GetApplicationControlData
|-
| 401 || InvalidateAllApplicationControlCache
|-
| 402 || RequestDownloadApplicationControlData
|-
| 403 || GetMaxApplicationControlCacheCount
|-
| 404 || InvalidateApplicationControlCache
|-
| 405 || ListApplicationControlCacheEntryInfo
|-
| 502 || RequestCheckGameCardRegistration
|-
| 503 || RequestGameCardRegistrationGoldPoint
|-
| 504 || RequestRegisterGameCard
|-
| 505 || GetGameCardMountFailureEvent
|-
| 506 || IsGameCardInserted
|-
| 507 || EnsureGameCardAccess
|-
| 508 || GetLastGameCardMountFailureResult
|-
| 509 || ListApplicationIdOnGameCard
|-
| 600 || CountApplicationContentMeta
|-
| 601 || [[#ListApplicationContentMetaStatus]]
|-
| 602 || ListAvailableAddOnContent
|-
| 603 || GetOwnedApplicationContentMetaStatus
|-
| 604 || RegisterContentsExternalKey
|-
| 605 || ListApplicationContentMetaStatusWithRightsCheck
|-
| 606 || GetContentMetaStorage
|-
| 700 || PushDownloadTaskList
|-
| 701 || ClearTaskStatusList
|-
| 702 || RequestDownloadTaskList
|-
| 703 || RequestEnsureDownloadTask
|-
| 704 || ListDownloadTaskStatus
|-
| 705 || RequestDownloadTaskListData
|-
| 800 || RequestVersionList
|-
| 801 || ListVersionList
|-
| 802 || RequestVersionListData
|-
| 900 || GetApplicationRecord
|-
| 901 || GetApplicationRecordProperty
|-
| 902 || EnableApplicationAutoUpdate
|-
| 903 || DisableApplicationAutoUpdate
|-
| 904 || TouchApplication
|-
| 905 || RequestApplicationUpdate
|-
| 906 || IsApplicationUpdateRequested
|-
| 907 || WithdrawApplicationUpdateRequest
|-
| 908 || ListApplicationRecordInstalledContentMeta
|-
| 909 || WithdrawCleanupAddOnContentsWithNoRightsRecommendation
|-
| 1000 || RequestVerifyApplicationDeprecated
|-
| 1001 || CorruptApplicationForDebug
|-
| 1002 || RequestVerifyAddOnContentsRights
|-
| 1003 || RequestVerifyApplication
|-
| 1004 || CorruptContentForDebug
|-
| 1200 || NeedsUpdateVulnerability
|-
| 1300 || IsAnyApplicationEntityInstalled
|-
| 1301 || DeleteApplicationContentEntities
|-
| 1302 || CleanupUnrecordedApplicationEntity
|-
| 1303 || CleanupAddOnContentsWithNoRights
|-
| 1304 || DeleteApplicationContentEntity
|-
| 1305 || TryDeleteRunningApplicationEntity
|-
| 1306 || TryDeleteRunningApplicationCompletely
|-
| 1307 || TryDeleteRunningApplicationContentEntities
|-
| 1400 || PrepareShutdown
|-
| 1500 || FormatSdCard
|-
| 1501 || NeedsSystemUpdateToFormatSdCard
|-
| 1502 || GetLastSdCardFormatUnexpectedResult
|-
| 1504 || InsertSdCard
|-
| 1505 || RemoveSdCard
|-
| 1600 || GetSystemSeedForPseudoDeviceId
|-
| 1601 || ResetSystemSeedForPseudoDeviceId
|-
| 1700 || ListApplicationDownloadingContentMeta
|-
| 1701 || GetApplicationView
|-
| 1702 || GetApplicationDownloadTaskStatus
|-
| 1703 || GetApplicationViewDownloadErrorContext
|-
| 1800 || IsNotificationSetupCompleted
|-
| 1801 || GetLastNotificationInfoCount
|-
| 1802 || ListLastNotificationInfo
|-
| 1803 || ListNotificationTask
|-
| 1900 || IsActiveAccount
|-
| 1901 || RequestDownloadApplicationPrepurchasedRights
|-
| 1902 || GetApplicationTicketInfo
|-
| 2000 || GetSystemDeliveryInfo
|-
| 2001 || SelectLatestSystemDeliveryInfo
|-
| 2002 || VerifyDeliveryProtocolVersion
|-
| 2003 || GetApplicationDeliveryInfo
|-
| 2004 || HasAllContentsToDeliver
|-
| 2005 || CompareApplicationDeliveryInfo
|-
| 2006 || CanDeliverApplication
|-
| 2007 || ListContentMetaKeyToDeliverApplication
|-
| 2008 || NeedsSystemUpdateToDeliverApplication
|-
| 2009 || EstimateRequiredSize
|-
| 2010 || RequestReceiveApplication
|-
| 2011 || CommitReceiveApplication
|-
| 2012 || GetReceiveApplicationProgress
|-
| 2013 || RequestSendApplication
|-
| 2014 || GetSendApplicationProgress
|-
| 2015 || CompareSystemDeliveryInfo
|-
| 2016 || ListNotCommittedContentMeta
|-
| 2017 || CreateDownloadTask
|-
|}

=== IApplicationVersionInterface ===
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetLaunchRequiredVersion
|-
| 1 || UpgradeLaunchRequiredVersion
|-
| 35 || UpdateVersionList
|-
| 36 || PushLaunchVersion
|-
| 37 || ListRequiredVersion
|-
| 800 || RequestVersionList
|-
| 801 || ListVersionList
|-
| 802 || RequestVersionListData
|-
| 1000 || PerformAutoUpdate
|-
|}

=== IContentManagerInterface ===
This is "nn::ns::detail::IContentManagementInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 11 || CalculateApplicationOccupiedSize
|-
| 43 || CheckSdCardMountStatus
|-
| 47 || GetTotalSpaceSize
|-
| 48 || GetFreeSpaceSize
|-
| 600 || CountApplicationContentMeta
|-
| 601 || ListApplicationContentMetaStatus
|-
| 605 || ListApplicationContentMetaStatusWithRightsCheck
|-
| 607 || IsAnyApplicationRunning
|-
|}

=== IDocumentInterface ===
This is "nn::ns::detail::IDocumentInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 21 || GetApplicationContentPath
|-
| 23 || ResolveApplicationContentPath
|-
|}

=== IDownloadTaskInterface ===
This is "nn::ns::detail::IDownloadTaskInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 701 || ClearTaskStatusList
|-
| 702 || RequestDownloadTaskList
|-
| 703 || RequestEnsureDownloadTask
|-
| 704 || ListDownloadTaskStatus
|-
| 705 || RequestDownloadTaskListData
|-
| 706 || TryCommitCurrentApplicationDownloadTask
|-
| 707 || EnableAutoCommit
|-
| 708 || DisableAutoCommit
|-
| 709 || TriggerDynamicCommitEvent
|-
|}

=== IECommerceInterface===
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || RequestLinkDevice
|-
|}

=== IFactoryResetInterface ===
This is "nn::ns::detail::IFactoryResetInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 100 || ResetToFactorySettings
|-
| 101 || ResetToFactorySettingsWithoutUserSaveData
|-
| 102 || ResetToFactorySettingsForRefurbishment
|-
|}

= ns:vm =
This is "nn::ns::detail::IVulnerabilityManagerInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1200 || [3.0.0+] NeedsUpdateVulnerability
|-
| 1201 || [4.0.0+] UpdateSafeSystemVersionForDebug
|-
| 1202 || [4.0.0+] GetSafeSystemVersion
|-
|}

= ns:su =
This is "nn::ns::detail::ISystemUpdateInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetBackgroundNetworkUpdateState
|-
| 1 || [[#ISystemUpdateControl|OpenSystemUpdateControl]]
|-
| 2 || NotifyExFatDriverRequired
|-
| 3 || ClearExFatDriverStatusForDebug
|-
| 4 || RequestBackgroundNetworkUpdate
|-
| 5 || NotifyBackgroundNetworkUpdate
|-
| 6 || NotifyExFatDriverDownloadedForDebug
|-
| 9 || GetSystemUpdateNotificationEventForContentDelivery
|-
| 10 || NotifySystemUpdateForContentDelivery
|-
| 11 || PrepareShutdown
|-
| 16 || DestroySystemUpdateTask
|-
| 17 || RequestSendSystemUpdate
|-
| 18 || GetSendSystemUpdateProgress
|-
|}

== ISystemUpdateControl ==
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || HasDownloaded
|-
| 1 || RequestCheckLatestUpdate
|-
| 2 || RequestDownloadLatestUpdate
|-
| 3 || GetDownloadProgress
|-
| 4 || ApplyDownloadedUpdate
|-
| 5 || RequestPrepareCardUpdate
|-
| 6 || GetPrepareCardUpdateProgress
|-
| 7 || HasPreparedCardUpdate
|-
| 8 || ApplyCardUpdate
|-
| 9 || GetDownloadedEulaDataSize
|-
| 10 || GetDownloadedEulaData
|-
| 11 || SetupCardUpdate
|-
| 12 || GetPreparedCardUpdateEulaDataSize
|-
| 13 || GetPreparedCardUpdateEulaData
|-
| 14 || SetupCardUpdateViaSystemUpdater
|-
| 15 || HasReceived
|-
| 16 || RequestReceiveSystemUpdate
|-
| 17 || GetReceiveProgress
|-
| 18 || ApplyReceivedUpdate
|-
| 19 || GetReceivedEulaDataSize
|-
| 20 || GetReceivedEulaData
|-
| 21 || SetupToReceiveSystemUpdate
|-
|}

= ns:dev =
This is "nn::ns::detail::IDevelopInterface".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#LaunchProgram]]
|-
| 1 || [[#TerminateProcess]]
|-
| 2 || [[#TerminateProgram]]
|-
| 4 || [[#GetShellEventHandle]]
|-
| 5 || [[#GetShellEventInfo]]
|-
| 6 || [[#TerminateApplication]]
|-
| 7 || [[#PrepareLaunchProgramFromHost]]
|-
| 8 || [[#LaunchApplication_2|#LaunchApplication]]
|-
| 9 || [[#LaunchApplicationWithStorageId]]
|-
|}

== LaunchProgram ==
Wrapper for "pm:shell" [[Process_Manager_services#LaunchProcess|LaunchProcess]].

== TerminateProcess ==
Wrapper for "pm:shell" [[Process_Manager_services#TerminateTitleByPid|TerminateTitleByPid]].

== TerminateProgram ==
Wrapper for "pm:shell" [[Process_Manager_services#TerminateTitleByTitleId|TerminateTitleByTitleId]].

== GetShellEventHandle==
Wrapper for "pm:shell" [[Process_Manager_services#GetProcessEventWaiter|GetProcessEventWaiter]].

== GetShellEventInfo ==
Wrapper for "pm:shell" [[Process_Manager_services#GetProcessEventType|GetProcessEventType]].

== TerminateApplication ==
Calls "pm:shell" [[Process_Manager_services#GetCrashingProcessPid|GetCrashingProcessPid]] and sends PID to [[Process_Manager_services#TerminateTitleByPid|TerminateTitleByPid]].

== PrepareLaunchProgramFromHost ==
Takes a type-0x5 input buffer containing the [[Filesystem_services|ContentPath]], returns an output 0x10-byte struct.

Calls [[NCM_services#IPathResolverForStorage|IPathResolverForStorage]] Set...NcaPath functions.

== LaunchApplication ==
Takes an input u32 [[Process_Manager_services|launch_flags]] and u64 titleID, returns an output u64 PID.

Same as LaunchApplicationWithStorageId except the last two params passed to the internal vtable funcptr call are value 0x6, instead of from the command input.

== LaunchApplicationWithStorageId ==
Takes 2 input u8s, an u32 [[Process_Manager_services|launch_flags]], and an u64 titleID. Returns an output u64 PID.

Launches an application title which is registered with NS.

[[Category:Services]]

ETicket services

2018-08-31T07:14:07Z

Adubbz: These were probably added in 2.0.0, not 1.0.0

= es =
This is "nn::es::IETicketService".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || ImportTicket
|-
| 2 || ImportTicketCertificateSet
|-
| 3 || DeleteTicket
|-
| 4 || DeletePersonalizedTicket
|-
| 5 || DeleteAllCommonTicket
|-
| 6 || DeleteAllPersonalizedTicket
|-
| 7 || DeleteAllPersonalizedTicketEx
|-
| 8 || [2.0.0-5.1.0] GetTitleKey
|-
| 9 || CountCommonTicket
|-
| 10 || CountPersonalizedTicket
|-
| 11 || ListCommonTicket
|-
| 12 || ListPersonalizedTicket
|-
| 13 || ListMissingPersonalizedTicket
|-
| 14 || GetCommonTicketSize
|-
| 15 || [2.0.0-5.1.0] GetPersonalizedTicketSize
|-
| 16 || GetCommonTicketData
|-
| 17 || [2.0.0-5.1.0] GetPersonalizedTicketData
|-
| 18 || OwnTicket
|-
| 19 || GetTicketInfo
|-
| 20 || ListLightTicketInfo
|-
| 21 || [2.0.0+] SignData
|-
| 22 || [4.0.0+] GetCommonTicketAndCertificateSize
|-
| 23 || [4.0.0+] GetCommonTicketAndCertificateData
|-
| 24 || [4.0.0+] ImportPrepurchaseRecord
|-
| 25 || [4.0.0+] DeletePrepurchaseRecord
|-
| 26 || [4.0.0+] DeleteAllPrepurchaseRecord
|-
| 27 || [4.0.0+] CountPrepurchaseRecord
|-
| 28 || [4.0.0+] ListPrepurchaseRecord
|-
| 29 || [4.0.0+] ListPrepurchaseRecordInfo
|-
| 30 || [5.0.0+]
|-
| 31 || [5.0.0+]
|-
| 32 || [5.0.0+]
|-
| 33 || [5.0.0+]
|-
| 34 || [5.0.0+]
|-
| 35 || [5.0.0+]
|-
| 36 || [6.0.0+]
|-
| 501 || [6.0.0+]
|-
| 502 || [6.0.0+]
|-
| 503 || [6.0.0+]
|-
| 504 || [6.0.0+]
|-
| 508 || [6.0.0+]
|-
| 509 || [6.0.0+]
|-
| 510 || [6.0.0+]
|-
| 1001 || [6.0.0+]
|-
| 1002 || [6.0.0+]
|-
| 1003 || [6.0.0+]
|-
| 1004 || [6.0.0+]
|-
| 1005 || [6.0.0+]
|-
| 1006 || [6.0.0+]
|-
| 1007 || [6.0.0+]
|-
| 1009 || [6.0.0+]
|-
| 1010 || [6.0.0+]
|-
| 1011 || [6.0.0+]
|-
| 1012 || [6.0.0+]
|-
| 1013 || [6.0.0+]
|-
| 1014 || [6.0.0+]
|-
| 1015 || [6.0.0+]
|-
| 1016 || [6.0.0+]
|-
| 1501 || [6.0.0+]
|-
| 1502 || [6.0.0+]
|-
| 1503 || [6.0.0+]
|-
| 1504 || [6.0.0+]
|-
| 1505 || [6.0.0+]
|-
| 2000 || [6.0.0+]
|-
| 2501 || [6.0.0+]
|-
| 2502 || [6.0.0+]
|}

ETicket services

2018-08-31T07:12:55Z

Adubbz: Added 6.0.0 commands

= es =
This is "nn::es::IETicketService".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || ImportTicket
|-
| 2 || ImportTicketCertificateSet
|-
| 3 || DeleteTicket
|-
| 4 || DeletePersonalizedTicket
|-
| 5 || DeleteAllCommonTicket
|-
| 6 || DeleteAllPersonalizedTicket
|-
| 7 || DeleteAllPersonalizedTicketEx
|-
| 8 || [1.0.0-5.1.0] GetTitleKey
|-
| 9 || CountCommonTicket
|-
| 10 || CountPersonalizedTicket
|-
| 11 || ListCommonTicket
|-
| 12 || ListPersonalizedTicket
|-
| 13 || ListMissingPersonalizedTicket
|-
| 14 || GetCommonTicketSize
|-
| 15 || [1.0.0-5.1.0] GetPersonalizedTicketSize
|-
| 16 || GetCommonTicketData
|-
| 17 || [1.0.0-5.1.0] GetPersonalizedTicketData
|-
| 18 || OwnTicket
|-
| 19 || GetTicketInfo
|-
| 20 || ListLightTicketInfo
|-
| 21 || [2.0.0+] SignData
|-
| 22 || [4.0.0+] GetCommonTicketAndCertificateSize
|-
| 23 || [4.0.0+] GetCommonTicketAndCertificateData
|-
| 24 || [4.0.0+] ImportPrepurchaseRecord
|-
| 25 || [4.0.0+] DeletePrepurchaseRecord
|-
| 26 || [4.0.0+] DeleteAllPrepurchaseRecord
|-
| 27 || [4.0.0+] CountPrepurchaseRecord
|-
| 28 || [4.0.0+] ListPrepurchaseRecord
|-
| 29 || [4.0.0+] ListPrepurchaseRecordInfo
|-
| 30 || [5.0.0+]
|-
| 31 || [5.0.0+]
|-
| 32 || [5.0.0+]
|-
| 33 || [5.0.0+]
|-
| 34 || [5.0.0+]
|-
| 35 || [5.0.0+]
|-
| 36 || [6.0.0+]
|-
| 501 || [6.0.0+]
|-
| 502 || [6.0.0+]
|-
| 503 || [6.0.0+]
|-
| 504 || [6.0.0+]
|-
| 508 || [6.0.0+]
|-
| 509 || [6.0.0+]
|-
| 510 || [6.0.0+]
|-
| 1001 || [6.0.0+]
|-
| 1002 || [6.0.0+]
|-
| 1003 || [6.0.0+]
|-
| 1004 || [6.0.0+]
|-
| 1005 || [6.0.0+]
|-
| 1006 || [6.0.0+]
|-
| 1007 || [6.0.0+]
|-
| 1009 || [6.0.0+]
|-
| 1010 || [6.0.0+]
|-
| 1011 || [6.0.0+]
|-
| 1012 || [6.0.0+]
|-
| 1013 || [6.0.0+]
|-
| 1014 || [6.0.0+]
|-
| 1015 || [6.0.0+]
|-
| 1016 || [6.0.0+]
|-
| 1501 || [6.0.0+]
|-
| 1502 || [6.0.0+]
|-
| 1503 || [6.0.0+]
|-
| 1504 || [6.0.0+]
|-
| 1505 || [6.0.0+]
|-
| 2000 || [6.0.0+]
|-
| 2501 || [6.0.0+]
|-
| 2502 || [6.0.0+]
|}

Error codes

2018-07-15T02:33:48Z

Adubbz: Added FS error code 2

= Structure =
These have been redesigned from the 3DS so that they fit within a Aarch64 MOV instruction immediate most of the time (without requiring the additional MOVK).

{| class=wikitable
! Bits || Field
|-
| 8-0 || Module
|-
| 21-9 || Description
|}

When a fatal-error is received the error code is outputted using the following formatter:
%04d-%04d

.. where the first code is <code>2000 + Module</code>, and the other being <code>Description</code>. Bits >=22 from the error-code are unused when displaying fatal-errors, since the Description ends with bit21.

= Modules =
{| class=wikitable
! Value || Name
|-
| 1 || Kernel
|-
| 2 || FS
|-
| 3 || OS (Memory, Thread, Mutex, NVIDIA)
|-
| 4 || HTCS
|-
| 5 || NCM
|-
| 6 || DD
|-
| 7 || Debug Monitor
|-
| 8 || LR
|-
| 9 || Loader
|-
| 10 || CMIF (IPC command interface)
|-
| 11 || HIPC (IPC)
|-
| 15 || PM
|-
| 16 || NS
|-
| 17 || Sockets
|-
| 18 || HTC
|-
| 20 || NCM Content
|-
| 21 || SM
|-
| 22 || RO userland
|-
| 24 || SDMMC
|-
| 25 || OVLN
|-
| 26 || SPL
|-
| 100 || ETHC
|-
| 101 || I2C
|-
| 102 || GPIO
|-
| 103 || UART
|-
| 105 || Settings
|-
| 107 || WLAN
|-
| 108 || XCD
|-
| 110 || NIFM
|-
| 111 || Hwopus
|-
| 113 || Bluetooth
|-
| 114 || VI
|-
| 115 || NFP
|-
| 116 || Time
|-
| 117 || FGM
|-
| 118 || OE
|-
| 120 || PCIe
|-
| 121 || Friends
|-
| 122 || BCAT
|-
| 123 || SSL
|-
| 124 || Account
|-
| 125 || News
|-
| 126 || Mii
|-
| 127 || NFC
|-
| 128 || AM
|-
| 129 || Play Report
|-
| 130 || AHID
|-
| 132 || Home Menu (Qlaunch)
|-
| 133 || PCV
|-
| 134 || OMM
|-
| 135 || BPC
|-
| 136 || PSM
|-
| 137 || NIM
|-
| 138 || PSC
|-
| 139 || TC
|-
| 140 || USB
|-
| 141 || NSD
|-
| 142 || PCTL
|-
| 143 || BTM
|-
| 144 || EC (Shop)
|-
| 145 || ETicket
|-
| 146 || NGC (Bad Words)
|-
| 147 || Error Report
|-
| 148 || APM
|-
| 150 || Profiler
|-
| 151 || Error Upload
|-
| 153 || Audio
|-
| 154 || NPNS
|-
| 155 || NPNS HTTP Stream
|-
| 157 || ARP
|-
| 158 || SWKBD
|-
| 159 || Boot
|-
| 161 || NFC Mifare
|-
| 162 || Userland assert
|-
| 163 || Fatal
|-
| 164 || NIM Shop
|-
| 165 || SPSM
|-
| 167 || BGTC
|-
| 168 || Userland crash
|-
| 180 || SREPO
|-
| 181 || Dauth
|-
| 202 || HID
|-
| 203 || LDN
|-
| 205 || Irsensor
|-
| 206 || Capture
|-
| 208 || Manu
|-
| 209 || ATK
|-
| 210 || Web
|-
| 211 ||
|-
| 212 || GRC
|-
| 216 || Migration
|-
| 217 || Migration Idc Server
|-
| 345 || libnx
|-
| 346 || [[Homebrew ABI]]
|-
| 347 || Homebrew Loader
|-
| 348 || libnx Nvidia errors
|-
| 800 || [[Internet_Browser|General web-applet]]
|-
| 809 || [[Internet_Browser|WifiWebAuthApplet]]
|-
| 810 || [[Internet_Browser|Whitelisted-applet]]
|-
| 811 || [[Internet_Browser|ShopN]]
|}

8XX is for/includes system applets.

= Error codes =
{| class=wikitable
! Value || Module || Description || Notes
|-
| 0x1C01 || 1 || 14 || Invalid kernel capability descriptor
|-
| 0x4201 || 1 || 33 || [[SPL_services#GetConfig|IsDebugMode]] isn't set.
|-
| 0x8C01 || 1 || 70 || No more debug events
|-
| 0xCA01 || 1 || 101 || Invalid size
|-
| 0xCC01 || 1 || 102 || Invalid address
|-
| 0xCE01 || 1 || 103 || Slabheap full
|-
| 0xD001 || 1 || 104 || Memory full
|-
| 0xD201 || 1 || 105 || Handle-table full.
|-
| 0xD401 || 1 || 106 || Invalid memory state / invalid memory permissions.
|-
| 0xD801 || 1 || 108 || Invalid memory permissions.
|-
| 0xDC01 || 1 || 110 || Invalid memory range
|-
| 0xE001 || 1 || 112 || Invalid thread priority.
|-
| 0xE201 || 1 || 113 || Invalid processor id.
|-
| 0xE401 || 1 || 114 || Invalid handle.
|-
| 0xE601 || 1 || 115 || Syscall copy from user failed.
|-
| 0xE801 || 1 || 116 || Invalid combination
|-
| 0xEA01 || 1 || 117 || Time out. Also when you give 0 handles to svcWaitSynchronizationN.
|-
| 0xEC01 || 1 || 118 || Canceled/interrupted [?]
|-
| 0xEE01 || 1 || 119 || Exceeding maximum
|-
| 0xF001 || 1 || 120 || Invalid enum
|-
| 0xF201 || 1 || 121 || No such entry
|-
| 0xF401 || 1 || 122 || Irq/DeviceAddressSpace/{...} already registered
|-
| 0xF601 || 1 || 123 || Port remote dead
|-
| 0xF801 || 1 || 124 || [Usermode] Unhandled interrupt
|-
| 0xFA01 || 1 || 125 || Wrong memory permission?
|-
| 0xFC01 || 1 || 126 || Reserved value
|-
| 0xFE01 || 1 || 127 || Invalid hardware breakpoint
|-
| 0x10001 || 1 || 128 || [Usermode] Fatal exception
|-
| 0x10201 || 1 || 129 || Last thread didn't belong to your process
|-
| 0x10601 || 1 || 131 || Port max sessions exceeded
|-
| 0x10801 || 1 || 132 || Resource limit exceeded
|-
| 0x20801 || 1 || 260 || Command buffer too small
|-
| 0x41001 || 1 || 520 || Process not being debugged
|-
| 0x402 || 2 || 2 || Directory/file(?) already exists.
|-
| 0xE02 || 2 || 7 || Savedata [[Filesystem_services|already]] mounted
|-
| 0x7802 || 2 || 60 || The specified [[NCA]]-type doesn't exist for this title.
|-
| 0x7D202 || 2 || 1001 || Process does not have RomFs
|-
| 0x7D402 || 2 || 1002 || Title-id not found / savedata not found.
|-
| 0xFA202 || 2 || 2001 || SD card not inserted
|-
| 0x13B002 || 2 || 2520 || Gamecard not inserted
|-
| 0x13DA02 || 2 || 2541 || Version check failed when mounting gamecard sysupdate partition?
|-
| 0x171402 || 2 || 2954 || Invalid gamecard handle.
|-
| 0x196002 || 2 || 3248 || Out of memory
|-
| 0x196202 || 2 || 3249 || Out of memory
|-
| 0x1A4A02 || 2 || 3365 || Out of memory
|-
| 0x235202 || 2 || 4521 || Invalid NCA Key index
|-
| 0x235E02 || 2 || 4527 || NCA-path used with the wrong titleID.
|-
| 0x250E02 || 2 || 4743 || [[NAX0|Corrupted]] NAX0 header.
|-
| 0x251002 || 2 || 4744 || Invalid [[NAX0]] magicnum.
|-
| 0x2EE202 || 2 || 6001 || Invalid input
|-
| 0x2EE602 || 2 || 6003 || Path too long
|-
| 0x2EEA02 || 2 || 6005 || Invalid directory path.
|-
| 0x2F5A02 || 2 || 6061 || Offset outside storage
|-
| 0x313802 || 2 || 6300 || Operation not supported
|-
| 0x320002 || 2 || 6400 || Permission denied
|-
| 0x326602 || 2 || 6451 || Missing titlekey(?) required to mount content
|-
| 0x3EA03 || 3 || 501 || Invalid handle
|-
| 0x3EE03 || 3 || 503 || Invalid memory mirror
|-
| 0x7FE03 || 3 || 1023 || TLS slot is not allocated
|-
| 0xA05 || 5 || 5 || [[Content_Manager_services|NcaID]] not found. Returned when attempting to mount titles which exist that aren't *8XX titles, the same way *8XX titles are mounted.
|-
| 0xE05 || 5 || 7 || TitleId not found
|-
| 0x1805 || 5 || 12 || Invalid StorageId
|-
| 0xDC05 || 5 || 110 || Gamecard not inserted
|-
| 0x17C05 || 5 || 190 || Gamecard not initialized
|-
| 0x1F405 || 5 || 250 || Sdcard not inserted
|-
| 0x20805 || 5 || 260 || Storage not mounted
|-
| 0x806 || 6 || 4 || Converted from error 0xD401
|-
| 0x1006 || 6 || 8 || Converted from error 0xE401
|-
| 0x408 || 8 || 2 || Program location entry not found
|-
| 0x608 || 8 || 3 || Invalid context for control location
|-
| 0x808 || 8 || 4 || Storage not found
|-
| 0xA08 || 8 || 5 || Access denied
|-
| 0xC08 || 8 || 6 || Offline manual HTML location entry not found
|-
| 0xE08 || 8 || 7 || Title is not registered
|-
| 0x1008 || 8 || 8 || Control location entry for host not found
|-
| 0x1208 || 8 || 9 || Legal info HTML location entry not found
|-
| 0x209 || 9 || 1 || Args too long.
|-
| 0x409 || 9 || 2 || Maximum processes loaded.
|-
| 0x609 || 9 || 3 || NPDM too big.
|-
| 0x19009 || 9 || 200 || Invalid access control sizes in NPDM.
|-
| 0x809 || 9 || 4 || Invalid NPDM.
|-
| 0xA09 || 9 || 5 || Invalid files.
|-
| 0xE09 || 9 || 7 || Already registered.
|-
| 0x1009 || 9 || 8 || Title not found.
|-
| 0x1209 || 9 || 9 || Title-id in ACI0 doesn't match range in ACID.
|-
| 0x6609 || 9 || 51 || Invalid memory state/permission
|-
| 0x6A09 || 9 || 53 || Invalid NRR
|-
| 0xA209 || 9 || 81 || Unaligned NRR address
|-
| 0xA409 || 9 || 82 || Bad NRR size
|-
| 0xAA09 || 9 || 85 || Bad NRR address
|-
| 0xAE09 || 9 || 87 || Bad initialization
|-
| 0xC809 || 9 || 100 || Unknown ACI0 descriptor
|-
| 0xCE09 || 9 || 103 || ACID/ACI0 don't match for descriptor "KernelFlags"
|-
| 0xD009 || 9 || 104 || ACID/ACI0 don't match for descriptor "SyscallMask"
|-
| 0xD409 || 9 || 106 || ACID/ACI0 don't match for descriptor "MapIoOrNormalRange"
|-
| 0xD609 || 9 || 107 || ACID/ACI0 don't match for descriptor "MapNormalPage"
|-
| 0xDE09 || 9 || 111 || ACID/ACI0 don't match for descriptor "InterruptPair"
|-
| 0xE209 || 9 || 113 || ACID/ACI0 don't match for descriptor "ApplicationType"
|-
| 0xE409 || 9 || 114 || ACID/ACI0 don't match for descriptor "KernelReleaseVersion"
|-
| 0xE609 || 9 || 115 || ACID/ACI0 don't match for descriptor "HandleTableSize"
|-
| 0xE809 || 9 || 116 || ACID/ACI0 don't match for descriptor "DebugFlags"
|-
| 0x1A80A || 10 || 212 || Bad magic (expected 'SFCO')
|-
| 0x20B || 11 || 1 || Size too big to fit to marshal.
|-
| 0x11A0B || 11 || 141 || Went past maximum during marshalling.
|-
| 0x1900B || 11 || 200 || Session doesn't support domains.
|-
| 0x25A0B || 11 || 301 || Remote process is dead.
|-
| 0x3D60B || 11 || 491 || IPC Query 1 failed.
|-
| 0x20F || 15 || 1 || Pid not found
|-
| 0x60F || 15 || 3 || Process has no pending events
|-
| 0xA0F || 15 || 5 || Application already running
|-
| 0x410 || 16 || 2 || Title-id not found
|-
| 0xF010 || 16 || 120 || Gamecard sysupdate not required
|-
| 0x1F610 || 16 || 251 || Unexpected StorageId
|-
| 0x415 || 21 || 2 || Not initialized.
|-
| 0x615 || 21 || 3 || Max sessions
|-
| 0xC15 || 21 || 6 || Invalid name (all zeroes)
|-
| 0x1015 || 21 || 8 || Permission denied
|-
| 0x416 || 22 || 2 || Address space is full
|-
| 0x616 || 22 || 3 || NRO already loaded
|-
| 0x816 || 22 || 4 || Invalid NRO header values
|-
| 0xC16 || 22 || 6 || Bad NRR magic
|-
| 0x1016 || 22 || 8 || Reached max NRR count
|-
| 0x1216 || 22 || 9 || Unable to verify NRO hash or NRR signature
|-
| 0x80216 || 22 || 1025 || Address not page-aligned
|-
| 0x80416 || 22 || 1026 || Incorrect NRO size
|-
| 0x80816 || 22 || 1028 || NRO not loaded
|-
| 0x80A16 || 22 || 1029 || NRR not loaded
|-
| 0x80C16 || 22 || 1030 || Already initialized
|-
| 0x80E16 || 22 || 1031 || Not initialized
|-
| 0x41A || 26 || 2 || Argument is invalid
|-
| 0xC81A || 26 || 100 || Incorrect buffer size
|-
| 0xCA1A || 26 || 101 || Unknown TZ error
|-
| 0xD01A || 26 || 104 || All AES engines busy
|-
| 0xD21A || 26 || 105 || Invalid AES engine-id
|-
| 0x272 || 114 || 1 || Generic error
|-
| 0xCC74 || 116 || 102 || Time not set
|-
| 0x287C || 124 || 20 || Argument is NULL
|-
| 0x2C7C || 124 || 22 || Argument is invalid
|-
| 0x3C7C || 124 || 30 || Bad input buffer size
|-
| 0x407C || 124 || 32 || Invalid input buffer
|-
| 0x7A880 || 128 || 500 || <code>am.debug!dev_function</code> setting needs to be set
|-
| 0x3CF089 || 137 || 7800 || Unknown/invalid libcurl error.
|-
| 0x3E8289-0x3F4089 || 137 || 8001-8096 || libcurl error 1-96. Some of the libcurl errors in the error-table map to the above unknown-libcurl-error however.
|-
| 0x668C || 140 || 51 || USB data-transfer in progress
|-
| 0xD48C || 140 || 106 || Invalid descriptor
|-
| 0x1928C || 140 || 201 || USB device not bound / interface already enabled
|-
| 0x299 || 153 || 1 || Invalid audio device
|-
| 0x499 || 153 || 2 || Invalid buffer address
|-
| 0x699 || 153 || 3 || Invalid sample rate
|-
| 0x1499 || 153 || 10 || Invalid channel count
|-
| 0xC0899 || 153 || 1540 || Audio output was already started
|-
| 0x3C9D || 157 || 30 || Address is NULL
|-
| 0x3E9D || 157 || 31 || PID is NULL
|-
| 0x549D || 157 || 42 || Already bound
|-
| 0xCC9D || 157 || 102 || Invalid PID
|-
| 0x35B || 347 || 1 || Failed to init SM.
|-
| 0x55B || 347 || 2 || Failed to init FS.
|-
| 0x75B || 347 || 3 || Failed to to open NRO file. May also happen when SD card isn't inserted / SD mounting failed earlier.
|-
| 0x95B || 347 || 4 || Failed to read NRO header.
|-
| 0xB5B || 347 || 5 || Invalid NRO magic.
|-
| 0xD5B || 347 || 6 || Invalid NRO segments.
|-
| 0xF5B || 347 || 7 || Failed to read NRO.
|-
| 0x135B || 347 || 9 || Failed to allocate heap.
|-
| 0x255B || 347 || 18 || Failed to map code-binary memory.
|-
| 0x275B || 347 || 19 || Failed to map code memory (.text).
|-
| 0x295B || 347 || 20 || Failed to map code memory (.rodata).
|-
| 0x2B5B || 347 || 21 || Failed to map code memory (.data+.bss).
|-
| 0x315B || 347 || 24 || Failed to unmap code memory (.text).
|-
| 0x335B || 347 || 25 || Failed to unmap code memory (.rodata).
|-
| 0x355B || 347 || 26 || Failed to unmap code memory (.data+.bss).
|}

== FS Error Codes ==
The following are the error codes recognized by nn::fs::detail::LogErrorMessage found in some [[Factory Setup|factory]] titles:

{| class=wikitable
! Value || Description || Message
|-
| 0x7802 || 60 || Error: Specified mount name already exists.
|-
| 0xD401 || 106 || Error: Passed buffer is not usable for fs library.
|-
| 0x7D202 || 1001 || Error: Specified partition is not found.
|-
| 0x7D402 || 1002 || Error: Specified target is not found.
|-
| 0xFA002 - 0x138602 || 2000 - 2499 || Error: Failed to access SD card.
|-
| 0x136802 - 0x176E02 || 2500 - 2999 || Error: Failed to access game card.
|-
| 0x177202 || 3001 || Error: Specified operation is not implemented.
|-
| 0x177A02 || 3005 || Error: Specified value is out of range.
|-
| 0x1B5802 - 0x1F3E02 || 3500 - 3999 || Error: Failed to access MMC.
|-
| 0x1F4202 - 0x219602 || 4001 - 4299 || Error: ROM is corrupted.
|-
| 0x219A02 - 0x232602 || 4301 - 4499 || Error: Save data is corrupted.
|-
| 0x232A02 - 0x23EE02 || 4501 - 4599 || Error: NCA is corrupted.
|-
| 0x23F202 - 0x243E02 || 4601 - 4639 || Error: Integrity verification failed.
|-
| 0x244202 - 0x246602 || 4641 - 4659 || Error: Partition FS is corrupted.
|-
| 0x246A02 - 0x248E02 || 4661 - 4679 || Error: Built-in-storage is corrupted.
|-
| 0x249202 - 0x24B602 || 4681 - 4699 || Error: FAT FS is corrupted.
|-
| 0x24BA02 - 0x24DE02 || 4701 - 4719 || Error: HOST FS is corrupted.
|-
| 0x1F4002 - 0x270E02 || 4000, 4300, 4500, 4600, 4640, 4660, 4680, 4700, 4720-4999 || Error: Data is corrupted.
|-
| 0x271002 - 0x2EDE02 || 5000-5999 || Error: Unexpected failure occurred.
|-
| 0x2EE402 - 0x2F1A02 || 6002-6029 || Error: Invalid path was specified.
|-
| 0x2F5A02 || 6061 || Error: Invalid offset was specified.
|-
| 0x2F5C02 || 6062 || Error: Invalid size was specified.
|-
| 0x2F5E02 || 6063 || Error: Null pointer argument was specified.
|-
| 0x2EE002 || 6000 || Error: Precondition violation.
|-
| 0x2EE202 - 0x306E02 || 6001-6199 || Error: Invalid argument was specified.
|-
| 0x307202 || 6201 || Error: OpenMode_AllowAppend is required for implicit extension of file size by WriteFile().
|-
| 0x307002 - 0x313602 || 6200, 6202 - 6299 || Error: Invalid operation for the open mode.
|-
| 0x313802 - 0x31FE02 || 6300-6399 || Error: Unsupported operation.
|-
| 0x320002 - 0x32C602 || 6400-6499 || Error: Permission denied.
|-
| 0x346402 || 6706 || Error: Enough journal space is not left.
|-
| 0x346A02 || 6709 || Error: The open count of files and directories reached the limitation.
|}

= Fatal Errors =
{| class=wikitable
! Error || Description
|-
| 2162-0002
| Can be triggered by running [[SVC|svcBreak]]. The svcBreak params have no affect on the value of the thrown error-code.
|-
| 2168-0000
| Userland ARM undefined instruction exception
|-
| 2168-0001
| Userland ARM prefetch-abort due to PC set to non-executable region
|-
| 2168-0002
| Userland ARM data abort. Also caused by abnormal process termination via [[SVC|svcExitProcess]]. Note: directly jumping to nnMain()-retaddr from non-main-thread has the same result.
|-
| 2168-0003
| Userland PC address not aligned to 4 bytes
|-
| 2168-0008
| Can occur when attempting to call an svc outside the whitelist
|}

= Support Errors =
{| class=wikitable
! Error || Module || Description || Notes
|-
|
| {web-applets listed above}
| 2750
| MP4 parsing failed.
|}

Normal error-codes displayed by the system also use the same format as fatal-errors.

Error codes

2018-07-15T02:01:49Z

Adubbz: Third time's the charm

= Structure =
These have been redesigned from the 3DS so that they fit within a Aarch64 MOV instruction immediate most of the time (without requiring the additional MOVK).

{| class=wikitable
! Bits || Field
|-
| 8-0 || Module
|-
| 21-9 || Description
|}

When a fatal-error is received the error code is outputted using the following formatter:
%04d-%04d

.. where the first code is <code>2000 + Module</code>, and the other being <code>Description</code>. Bits >=22 from the error-code are unused when displaying fatal-errors, since the Description ends with bit21.

= Modules =
{| class=wikitable
! Value || Name
|-
| 1 || Kernel
|-
| 2 || FS
|-
| 3 || OS (Memory, Thread, Mutex, NVIDIA)
|-
| 4 || HTCS
|-
| 5 || NCM
|-
| 6 || DD
|-
| 7 || Debug Monitor
|-
| 8 || LR
|-
| 9 || Loader
|-
| 10 || CMIF (IPC command interface)
|-
| 11 || HIPC (IPC)
|-
| 15 || PM
|-
| 16 || NS
|-
| 17 || Sockets
|-
| 18 || HTC
|-
| 20 || NCM Content
|-
| 21 || SM
|-
| 22 || RO userland
|-
| 24 || SDMMC
|-
| 25 || OVLN
|-
| 26 || SPL
|-
| 100 || ETHC
|-
| 101 || I2C
|-
| 102 || GPIO
|-
| 103 || UART
|-
| 105 || Settings
|-
| 107 || WLAN
|-
| 108 || XCD
|-
| 110 || NIFM
|-
| 111 || Hwopus
|-
| 113 || Bluetooth
|-
| 114 || VI
|-
| 115 || NFP
|-
| 116 || Time
|-
| 117 || FGM
|-
| 118 || OE
|-
| 120 || PCIe
|-
| 121 || Friends
|-
| 122 || BCAT
|-
| 123 || SSL
|-
| 124 || Account
|-
| 125 || News
|-
| 126 || Mii
|-
| 127 || NFC
|-
| 128 || AM
|-
| 129 || Play Report
|-
| 130 || AHID
|-
| 132 || Home Menu (Qlaunch)
|-
| 133 || PCV
|-
| 134 || OMM
|-
| 135 || BPC
|-
| 136 || PSM
|-
| 137 || NIM
|-
| 138 || PSC
|-
| 139 || TC
|-
| 140 || USB
|-
| 141 || NSD
|-
| 142 || PCTL
|-
| 143 || BTM
|-
| 144 || EC (Shop)
|-
| 145 || ETicket
|-
| 146 || NGC (Bad Words)
|-
| 147 || Error Report
|-
| 148 || APM
|-
| 150 || Profiler
|-
| 151 || Error Upload
|-
| 153 || Audio
|-
| 154 || NPNS
|-
| 155 || NPNS HTTP Stream
|-
| 157 || ARP
|-
| 158 || SWKBD
|-
| 159 || Boot
|-
| 161 || NFC Mifare
|-
| 162 || Userland assert
|-
| 163 || Fatal
|-
| 164 || NIM Shop
|-
| 165 || SPSM
|-
| 167 || BGTC
|-
| 168 || Userland crash
|-
| 180 || SREPO
|-
| 181 || Dauth
|-
| 202 || HID
|-
| 203 || LDN
|-
| 205 || Irsensor
|-
| 206 || Capture
|-
| 208 || Manu
|-
| 209 || ATK
|-
| 210 || Web
|-
| 211 ||
|-
| 212 || GRC
|-
| 216 || Migration
|-
| 217 || Migration Idc Server
|-
| 345 || libnx
|-
| 346 || [[Homebrew ABI]]
|-
| 347 || Homebrew Loader
|-
| 348 || libnx Nvidia errors
|-
| 800 || [[Internet_Browser|General web-applet]]
|-
| 809 || [[Internet_Browser|WifiWebAuthApplet]]
|-
| 810 || [[Internet_Browser|Whitelisted-applet]]
|-
| 811 || [[Internet_Browser|ShopN]]
|}

8XX is for/includes system applets.

= Error codes =
{| class=wikitable
! Value || Module || Description || Notes
|-
| 0x1C01 || 1 || 14 || Invalid kernel capability descriptor
|-
| 0x4201 || 1 || 33 || [[SPL_services#GetConfig|IsDebugMode]] isn't set.
|-
| 0x8C01 || 1 || 70 || No more debug events
|-
| 0xCA01 || 1 || 101 || Invalid size
|-
| 0xCC01 || 1 || 102 || Invalid address
|-
| 0xCE01 || 1 || 103 || Slabheap full
|-
| 0xD001 || 1 || 104 || Memory full
|-
| 0xD201 || 1 || 105 || Handle-table full.
|-
| 0xD401 || 1 || 106 || Invalid memory state / invalid memory permissions.
|-
| 0xD801 || 1 || 108 || Invalid memory permissions.
|-
| 0xDC01 || 1 || 110 || Invalid memory range
|-
| 0xE001 || 1 || 112 || Invalid thread priority.
|-
| 0xE201 || 1 || 113 || Invalid processor id.
|-
| 0xE401 || 1 || 114 || Invalid handle.
|-
| 0xE601 || 1 || 115 || Syscall copy from user failed.
|-
| 0xE801 || 1 || 116 || Invalid combination
|-
| 0xEA01 || 1 || 117 || Time out. Also when you give 0 handles to svcWaitSynchronizationN.
|-
| 0xEC01 || 1 || 118 || Canceled/interrupted [?]
|-
| 0xEE01 || 1 || 119 || Exceeding maximum
|-
| 0xF001 || 1 || 120 || Invalid enum
|-
| 0xF201 || 1 || 121 || No such entry
|-
| 0xF401 || 1 || 122 || Irq/DeviceAddressSpace/{...} already registered
|-
| 0xF601 || 1 || 123 || Port remote dead
|-
| 0xF801 || 1 || 124 || [Usermode] Unhandled interrupt
|-
| 0xFA01 || 1 || 125 || Wrong memory permission?
|-
| 0xFC01 || 1 || 126 || Reserved value
|-
| 0xFE01 || 1 || 127 || Invalid hardware breakpoint
|-
| 0x10001 || 1 || 128 || [Usermode] Fatal exception
|-
| 0x10201 || 1 || 129 || Last thread didn't belong to your process
|-
| 0x10601 || 1 || 131 || Port max sessions exceeded
|-
| 0x10801 || 1 || 132 || Resource limit exceeded
|-
| 0x20801 || 1 || 260 || Command buffer too small
|-
| 0x41001 || 1 || 520 || Process not being debugged
|-
| 0xE02 || 2 || 7 || Savedata [[Filesystem_services|already]] mounted
|-
| 0x7802 || 2 || 60 || The specified [[NCA]]-type doesn't exist for this title.
|-
| 0x7D202 || 2 || 1001 || Process does not have RomFs
|-
| 0x7D402 || 2 || 1002 || Title-id not found / savedata not found.
|-
| 0xFA202 || 2 || 2001 || SD card not inserted
|-
| 0x13B002 || 2 || 2520 || Gamecard not inserted
|-
| 0x13DA02 || 2 || 2541 || Version check failed when mounting gamecard sysupdate partition?
|-
| 0x171402 || 2 || 2954 || Invalid gamecard handle.
|-
| 0x196002 || 2 || 3248 || Out of memory
|-
| 0x196202 || 2 || 3249 || Out of memory
|-
| 0x1A4A02 || 2 || 3365 || Out of memory
|-
| 0x2EEA02 || 1 || 6005 || Directory/file(?) already exists.
|-
| 0x235202 || 2 || 4521 || Invalid NCA Key index
|-
| 0x235E02 || 2 || 4527 || NCA-path used with the wrong titleID.
|-
| 0x250E02 || 2 || 4743 || [[NAX0|Corrupted]] NAX0 header.
|-
| 0x251002 || 2 || 4744 || Invalid [[NAX0]] magicnum.
|-
| 0x2EE202 || 2 || 6001 || Invalid input
|-
| 0x2EE602 || 2 || 6003 || Path too long
|-
| 0x2EEA02 || 2 || 6005 || Directory/file(?) already exists.
|-
| 0x2F5A02 || 2 || 6061 || Offset outside storage
|-
| 0x313802 || 2 || 6300 || Operation not supported
|-
| 0x320002 || 2 || 6400 || Permission denied
|-
| 0x326602 || 2 || 6451 || Missing titlekey(?) required to mount content
|-
| 0x3EA03 || 3 || 501 || Invalid handle
|-
| 0x3EE03 || 3 || 503 || Invalid memory mirror
|-
| 0x7FE03 || 3 || 1023 || TLS slot is not allocated
|-
| 0xA05 || 5 || 5 || [[Content_Manager_services|NcaID]] not found. Returned when attempting to mount titles which exist that aren't *8XX titles, the same way *8XX titles are mounted.
|-
| 0xE05 || 5 || 7 || TitleId not found
|-
| 0x1805 || 5 || 12 || Invalid StorageId
|-
| 0xDC05 || 5 || 110 || Gamecard not inserted
|-
| 0x17C05 || 5 || 190 || Gamecard not initialized
|-
| 0x1F405 || 5 || 250 || Sdcard not inserted
|-
| 0x20805 || 5 || 260 || Storage not mounted
|-
| 0x806 || 6 || 4 || Converted from error 0xD401
|-
| 0x1006 || 6 || 8 || Converted from error 0xE401
|-
| 0x408 || 8 || 2 || Program location entry not found
|-
| 0x608 || 8 || 3 || Invalid context for control location
|-
| 0x808 || 8 || 4 || Storage not found
|-
| 0xA08 || 8 || 5 || Access denied
|-
| 0xC08 || 8 || 6 || Offline manual HTML location entry not found
|-
| 0xE08 || 8 || 7 || Title is not registered
|-
| 0x1008 || 8 || 8 || Control location entry for host not found
|-
| 0x1208 || 8 || 9 || Legal info HTML location entry not found
|-
| 0x209 || 9 || 1 || Args too long.
|-
| 0x409 || 9 || 2 || Maximum processes loaded.
|-
| 0x609 || 9 || 3 || NPDM too big.
|-
| 0x19009 || 9 || 200 || Invalid access control sizes in NPDM.
|-
| 0x809 || 9 || 4 || Invalid NPDM.
|-
| 0xA09 || 9 || 5 || Invalid files.
|-
| 0xE09 || 9 || 7 || Already registered.
|-
| 0x1009 || 9 || 8 || Title not found.
|-
| 0x1209 || 9 || 9 || Title-id in ACI0 doesn't match range in ACID.
|-
| 0x6609 || 9 || 51 || Invalid memory state/permission
|-
| 0x6A09 || 9 || 53 || Invalid NRR
|-
| 0xA209 || 9 || 81 || Unaligned NRR address
|-
| 0xA409 || 9 || 82 || Bad NRR size
|-
| 0xAA09 || 9 || 85 || Bad NRR address
|-
| 0xAE09 || 9 || 87 || Bad initialization
|-
| 0xC809 || 9 || 100 || Unknown ACI0 descriptor
|-
| 0xCE09 || 9 || 103 || ACID/ACI0 don't match for descriptor "KernelFlags"
|-
| 0xD009 || 9 || 104 || ACID/ACI0 don't match for descriptor "SyscallMask"
|-
| 0xD409 || 9 || 106 || ACID/ACI0 don't match for descriptor "MapIoOrNormalRange"
|-
| 0xD609 || 9 || 107 || ACID/ACI0 don't match for descriptor "MapNormalPage"
|-
| 0xDE09 || 9 || 111 || ACID/ACI0 don't match for descriptor "InterruptPair"
|-
| 0xE209 || 9 || 113 || ACID/ACI0 don't match for descriptor "ApplicationType"
|-
| 0xE409 || 9 || 114 || ACID/ACI0 don't match for descriptor "KernelReleaseVersion"
|-
| 0xE609 || 9 || 115 || ACID/ACI0 don't match for descriptor "HandleTableSize"
|-
| 0xE809 || 9 || 116 || ACID/ACI0 don't match for descriptor "DebugFlags"
|-
| 0x1A80A || 10 || 212 || Bad magic (expected 'SFCO')
|-
| 0x20B || 11 || 1 || Size too big to fit to marshal.
|-
| 0x11A0B || 11 || 141 || Went past maximum during marshalling.
|-
| 0x1900B || 11 || 200 || Session doesn't support domains.
|-
| 0x25A0B || 11 || 301 || Remote process is dead.
|-
| 0x3D60B || 11 || 491 || IPC Query 1 failed.
|-
| 0x20F || 15 || 1 || Pid not found
|-
| 0x60F || 15 || 3 || Process has no pending events
|-
| 0xA0F || 15 || 5 || Application already running
|-
| 0x410 || 16 || 2 || Title-id not found
|-
| 0xF010 || 16 || 120 || Gamecard sysupdate not required
|-
| 0x1F610 || 16 || 251 || Unexpected StorageId
|-
| 0x415 || 21 || 2 || Not initialized.
|-
| 0x615 || 21 || 3 || Max sessions
|-
| 0xC15 || 21 || 6 || Invalid name (all zeroes)
|-
| 0x1015 || 21 || 8 || Permission denied
|-
| 0x416 || 22 || 2 || Address space is full
|-
| 0x616 || 22 || 3 || NRO already loaded
|-
| 0x816 || 22 || 4 || Invalid NRO header values
|-
| 0xC16 || 22 || 6 || Bad NRR magic
|-
| 0x1016 || 22 || 8 || Reached max NRR count
|-
| 0x1216 || 22 || 9 || Unable to verify NRO hash or NRR signature
|-
| 0x80216 || 22 || 1025 || Address not page-aligned
|-
| 0x80416 || 22 || 1026 || Incorrect NRO size
|-
| 0x80816 || 22 || 1028 || NRO not loaded
|-
| 0x80A16 || 22 || 1029 || NRR not loaded
|-
| 0x80C16 || 22 || 1030 || Already initialized
|-
| 0x80E16 || 22 || 1031 || Not initialized
|-
| 0x41A || 26 || 2 || Argument is invalid
|-
| 0xC81A || 26 || 100 || Incorrect buffer size
|-
| 0xCA1A || 26 || 101 || Unknown TZ error
|-
| 0xD01A || 26 || 104 || All AES engines busy
|-
| 0xD21A || 26 || 105 || Invalid AES engine-id
|-
| 0x272 || 114 || 1 || Generic error
|-
| 0xCC74 || 116 || 102 || Time not set
|-
| 0x287C || 124 || 20 || Argument is NULL
|-
| 0x2C7C || 124 || 22 || Argument is invalid
|-
| 0x3C7C || 124 || 30 || Bad input buffer size
|-
| 0x407C || 124 || 32 || Invalid input buffer
|-
| 0x7A880 || 128 || 500 || <code>am.debug!dev_function</code> setting needs to be set
|-
| 0x3CF089 || 137 || 7800 || Unknown/invalid libcurl error.
|-
| 0x3E8289-0x3F4089 || 137 || 8001-8096 || libcurl error 1-96. Some of the libcurl errors in the error-table map to the above unknown-libcurl-error however.
|-
| 0x668C || 140 || 51 || USB data-transfer in progress
|-
| 0xD48C || 140 || 106 || Invalid descriptor
|-
| 0x1928C || 140 || 201 || USB device not bound / interface already enabled
|-
| 0x299 || 153 || 1 || Invalid audio device
|-
| 0x499 || 153 || 2 || Invalid buffer address
|-
| 0x699 || 153 || 3 || Invalid sample rate
|-
| 0x1499 || 153 || 10 || Invalid channel count
|-
| 0xC0899 || 153 || 1540 || Audio output was already started
|-
| 0x3C9D || 157 || 30 || Address is NULL
|-
| 0x3E9D || 157 || 31 || PID is NULL
|-
| 0x549D || 157 || 42 || Already bound
|-
| 0xCC9D || 157 || 102 || Invalid PID
|-
| 0x35B || 347 || 1 || Failed to init SM.
|-
| 0x55B || 347 || 2 || Failed to init FS.
|-
| 0x75B || 347 || 3 || Failed to to open NRO file. May also happen when SD card isn't inserted / SD mounting failed earlier.
|-
| 0x95B || 347 || 4 || Failed to read NRO header.
|-
| 0xB5B || 347 || 5 || Invalid NRO magic.
|-
| 0xD5B || 347 || 6 || Invalid NRO segments.
|-
| 0xF5B || 347 || 7 || Failed to read NRO.
|-
| 0x135B || 347 || 9 || Failed to allocate heap.
|-
| 0x255B || 347 || 18 || Failed to map code-binary memory.
|-
| 0x275B || 347 || 19 || Failed to map code memory (.text).
|-
| 0x295B || 347 || 20 || Failed to map code memory (.rodata).
|-
| 0x2B5B || 347 || 21 || Failed to map code memory (.data+.bss).
|-
| 0x315B || 347 || 24 || Failed to unmap code memory (.text).
|-
| 0x335B || 347 || 25 || Failed to unmap code memory (.rodata).
|-
| 0x355B || 347 || 26 || Failed to unmap code memory (.data+.bss).
|}

== FS Error Codes ==
The following are the error codes recognized by nn::fs::detail::LogErrorMessage found in some [[Factory Setup|factory]] titles:

{| class=wikitable
! Value || Description || Message
|-
| 0x7802 || 60 || Error: Specified mount name already exists.
|-
| 0xD401 || 106 || Error: Passed buffer is not usable for fs library.
|-
| 0x7D202 || 1001 || Error: Specified partition is not found.
|-
| 0x7D402 || 1002 || Error: Specified target is not found.
|-
| 0xFA002 - 0x138602 || 2000 - 2499 || Error: Failed to access SD card.
|-
| 0x136802 - 0x176E02 || 2500 - 2999 || Error: Failed to access game card.
|-
| 0x177202 || 3001 || Error: Specified operation is not implemented.
|-
| 0x177A02 || 3005 || Error: Specified value is out of range.
|-
| 0x1B5802 - 0x1F3E02 || 3500 - 3999 || Error: Failed to access MMC.
|-
| 0x1F4202 - 0x219602 || 4001 - 4299 || Error: ROM is corrupted.
|-
| 0x219A02 - 0x232602 || 4301 - 4499 || Error: Save data is corrupted.
|-
| 0x232A02 - 0x23EE02 || 4501 - 4599 || Error: NCA is corrupted.
|-
| 0x23F202 - 0x243E02 || 4601 - 4639 || Error: Integrity verification failed.
|-
| 0x244202 - 0x246602 || 4641 - 4659 || Error: Partition FS is corrupted.
|-
| 0x246A02 - 0x248E02 || 4661 - 4679 || Error: Built-in-storage is corrupted.
|-
| 0x249202 - 0x24B602 || 4681 - 4699 || Error: FAT FS is corrupted.
|-
| 0x24BA02 - 0x24DE02 || 4701 - 4719 || Error: HOST FS is corrupted.
|-
| 0x1F4002 - 0x270E02 || 4000, 4300, 4500, 4600, 4640, 4660, 4680, 4700, 4720-4999 || Error: Data is corrupted.
|-
| 0x271002 - 0x2EDE02 || 5000-5999 || Error: Unexpected failure occurred.
|-
| 0x2EE402 - 0x2F1A02 || 6002-6029 || Error: Invalid path was specified.
|-
| 0x2F5A02 || 6061 || Error: Invalid offset was specified.
|-
| 0x2F5C02 || 6062 || Error: Invalid size was specified.
|-
| 0x2F5E02 || 6063 || Error: Null pointer argument was specified.
|-
| 0x2EE002 || 6000 || Error: Precondition violation.
|-
| 0x2EE202 - 0x306E02 || 6001-6199 || Error: Invalid argument was specified.
|-
| 0x307202 || 6201 || Error: OpenMode_AllowAppend is required for implicit extension of file size by WriteFile().
|-
| 0x307002 - 0x313602 || 6200, 6202 - 6299 || Error: Invalid operation for the open mode.
|-
| 0x313802 - 0x31FE02 || 6300-6399 || Error: Unsupported operation.
|-
| 0x320002 - 0x32C602 || 6400-6499 || Error: Permission denied.
|-
| 0x346402 || 6706 || Error: Enough journal space is not left.
|-
| 0x346A02 || 6709 || Error: The open count of files and directories reached the limitation.
|}

= Fatal Errors =
{| class=wikitable
! Error || Description
|-
| 2162-0002
| Can be triggered by running [[SVC|svcBreak]]. The svcBreak params have no affect on the value of the thrown error-code.
|-
| 2168-0000
| Userland ARM undefined instruction exception
|-
| 2168-0001
| Userland ARM prefetch-abort due to PC set to non-executable region
|-
| 2168-0002
| Userland ARM data abort. Also caused by abnormal process termination via [[SVC|svcExitProcess]]. Note: directly jumping to nnMain()-retaddr from non-main-thread has the same result.
|-
| 2168-0003
| Userland PC address not aligned to 4 bytes
|-
| 2168-0008
| Can occur when attempting to call an svc outside the whitelist
|}

= Support Errors =
{| class=wikitable
! Error || Module || Description || Notes
|-
|
| {web-applets listed above}
| 2750
| MP4 parsing failed.
|}

Normal error-codes displayed by the system also use the same format as fatal-errors.

Error codes

2018-07-15T01:58:42Z

Adubbz: Wrong location

= Structure =
These have been redesigned from the 3DS so that they fit within a Aarch64 MOV instruction immediate most of the time (without requiring the additional MOVK).

{| class=wikitable
! Bits || Field
|-
| 8-0 || Module
|-
| 21-9 || Description
|}

When a fatal-error is received the error code is outputted using the following formatter:
%04d-%04d

.. where the first code is <code>2000 + Module</code>, and the other being <code>Description</code>. Bits >=22 from the error-code are unused when displaying fatal-errors, since the Description ends with bit21.

= Modules =
{| class=wikitable
! Value || Name
|-
| 1 || Kernel
|-
| 2 || FS
|-
| 3 || OS (Memory, Thread, Mutex, NVIDIA)
|-
| 4 || HTCS
|-
| 5 || NCM
|-
| 6 || DD
|-
| 7 || Debug Monitor
|-
| 8 || LR
|-
| 9 || Loader
|-
| 10 || CMIF (IPC command interface)
|-
| 11 || HIPC (IPC)
|-
| 15 || PM
|-
| 16 || NS
|-
| 17 || Sockets
|-
| 18 || HTC
|-
| 20 || NCM Content
|-
| 21 || SM
|-
| 22 || RO userland
|-
| 24 || SDMMC
|-
| 25 || OVLN
|-
| 26 || SPL
|-
| 100 || ETHC
|-
| 101 || I2C
|-
| 102 || GPIO
|-
| 103 || UART
|-
| 105 || Settings
|-
| 107 || WLAN
|-
| 108 || XCD
|-
| 110 || NIFM
|-
| 111 || Hwopus
|-
| 113 || Bluetooth
|-
| 114 || VI
|-
| 115 || NFP
|-
| 116 || Time
|-
| 117 || FGM
|-
| 118 || OE
|-
| 120 || PCIe
|-
| 121 || Friends
|-
| 122 || BCAT
|-
| 123 || SSL
|-
| 124 || Account
|-
| 125 || News
|-
| 126 || Mii
|-
| 127 || NFC
|-
| 128 || AM
|-
| 129 || Play Report
|-
| 130 || AHID
|-
| 132 || Home Menu (Qlaunch)
|-
| 133 || PCV
|-
| 134 || OMM
|-
| 135 || BPC
|-
| 136 || PSM
|-
| 137 || NIM
|-
| 138 || PSC
|-
| 139 || TC
|-
| 140 || USB
|-
| 141 || NSD
|-
| 142 || PCTL
|-
| 143 || BTM
|-
| 144 || EC (Shop)
|-
| 145 || ETicket
|-
| 146 || NGC (Bad Words)
|-
| 147 || Error Report
|-
| 148 || APM
|-
| 150 || Profiler
|-
| 151 || Error Upload
|-
| 153 || Audio
|-
| 154 || NPNS
|-
| 155 || NPNS HTTP Stream
|-
| 157 || ARP
|-
| 158 || SWKBD
|-
| 159 || Boot
|-
| 161 || NFC Mifare
|-
| 162 || Userland assert
|-
| 163 || Fatal
|-
| 164 || NIM Shop
|-
| 165 || SPSM
|-
| 167 || BGTC
|-
| 168 || Userland crash
|-
| 180 || SREPO
|-
| 181 || Dauth
|-
| 202 || HID
|-
| 203 || LDN
|-
| 205 || Irsensor
|-
| 206 || Capture
|-
| 208 || Manu
|-
| 209 || ATK
|-
| 210 || Web
|-
| 211 ||
|-
| 212 || GRC
|-
| 216 || Migration
|-
| 217 || Migration Idc Server
|-
| 345 || libnx
|-
| 346 || [[Homebrew ABI]]
|-
| 347 || Homebrew Loader
|-
| 348 || libnx Nvidia errors
|-
| 800 || [[Internet_Browser|General web-applet]]
|-
| 809 || [[Internet_Browser|WifiWebAuthApplet]]
|-
| 810 || [[Internet_Browser|Whitelisted-applet]]
|-
| 811 || [[Internet_Browser|ShopN]]
|}

8XX is for/includes system applets.

= Error codes =
{| class=wikitable
! Value || Module || Description || Notes
|-
| 0x1C01 || 1 || 14 || Invalid kernel capability descriptor
|-
| 0x4201 || 1 || 33 || [[SPL_services#GetConfig|IsDebugMode]] isn't set.
|-
| 0x8C01 || 1 || 70 || No more debug events
|-
| 0xCA01 || 1 || 101 || Invalid size
|-
| 0xCC01 || 1 || 102 || Invalid address
|-
| 0xCE01 || 1 || 103 || Slabheap full
|-
| 0xD001 || 1 || 104 || Memory full
|-
| 0xD201 || 1 || 105 || Handle-table full.
|-
| 0xD401 || 1 || 106 || Invalid memory state / invalid memory permissions.
|-
| 0xD801 || 1 || 108 || Invalid memory permissions.
|-
| 0xDC01 || 1 || 110 || Invalid memory range
|-
| 0xE001 || 1 || 112 || Invalid thread priority.
|-
| 0xE201 || 1 || 113 || Invalid processor id.
|-
| 0xE401 || 1 || 114 || Invalid handle.
|-
| 0xE601 || 1 || 115 || Syscall copy from user failed.
|-
| 0xE801 || 1 || 116 || Invalid combination
|-
| 0xEA01 || 1 || 117 || Time out. Also when you give 0 handles to svcWaitSynchronizationN.
|-
| 0xEC01 || 1 || 118 || Canceled/interrupted [?]
|-
| 0xEE01 || 1 || 119 || Exceeding maximum
|-
| 0xF001 || 1 || 120 || Invalid enum
|-
| 0xF201 || 1 || 121 || No such entry
|-
| 0xF401 || 1 || 122 || Irq/DeviceAddressSpace/{...} already registered
|-
| 0xF601 || 1 || 123 || Port remote dead
|-
| 0xF801 || 1 || 124 || [Usermode] Unhandled interrupt
|-
| 0xFA01 || 1 || 125 || Wrong memory permission?
|-
| 0xFC01 || 1 || 126 || Reserved value
|-
| 0xFE01 || 1 || 127 || Invalid hardware breakpoint
|-
| 0x10001 || 1 || 128 || [Usermode] Fatal exception
|-
| 0x10201 || 1 || 129 || Last thread didn't belong to your process
|-
| 0x10601 || 1 || 131 || Port max sessions exceeded
|-
| 0x10801 || 1 || 132 || Resource limit exceeded
|-
| 0x20801 || 1 || 260 || Command buffer too small
|-
| 0x41001 || 1 || 520 || Process not being debugged
|-
| 0xE02 || 2 || 7 || Savedata [[Filesystem_services|already]] mounted
|-
| 0x7802 || 2 || 60 || The specified [[NCA]]-type doesn't exist for this title.
|-
| 0x7D202 || 2 || 1001 || Process does not have RomFs
|-
| 0x7D402 || 2 || 1002 || Title-id not found / savedata not found.
|-
| 0xFA202 || 2 || 2001 || SD card not inserted
|-
| 0x13B002 || 2 || 2520 || Gamecard not inserted
|-
| 0x13DA02 || 2 || 2541 || Version check failed when mounting gamecard sysupdate partition?
|-
| 0x171402 || 2 || 2954 || Invalid gamecard handle.
|-
| 0x196002 || 2 || 3248 || Out of memory
|-
| 0x196202 || 2 || 3249 || Out of memory
|-
| 0x1A4A02 || 2 || 3365 || Out of memory
|-
| 0x2EEA02 || 1 || 6005 || Directory/file(?) already exists.
|-
| 0x235202 || 2 || 4521 || Invalid NCA Key index
|-
| 0x235E02 || 2 || 4527 || NCA-path used with the wrong titleID.
|-
| 0x250E02 || 2 || 4743 || [[NAX0|Corrupted]] NAX0 header.
|-
| 0x251002 || 2 || 4744 || Invalid [[NAX0]] magicnum.
|-
| 0x2EE202 || 2 || 6001 || Invalid input
|-
| 0x2EE602 || 2 || 6003 || Path too long
|-
| 0x2F5A02 || 2 || 6061 || Offset outside storage
|-
| 0x313802 || 2 || 6300 || Operation not supported
|-
| 0x320002 || 2 || 6400 || Permission denied
|-
| 0x326602 || 2 || 6451 || Missing titlekey(?) required to mount content
|-
| 0x3EA03 || 3 || 501 || Invalid handle
|-
| 0x3EE03 || 3 || 503 || Invalid memory mirror
|-
| 0x7FE03 || 3 || 1023 || TLS slot is not allocated
|-
| 0xA05 || 5 || 5 || [[Content_Manager_services|NcaID]] not found. Returned when attempting to mount titles which exist that aren't *8XX titles, the same way *8XX titles are mounted.
|-
| 0xE05 || 5 || 7 || TitleId not found
|-
| 0x1805 || 5 || 12 || Invalid StorageId
|-
| 0xDC05 || 5 || 110 || Gamecard not inserted
|-
| 0x17C05 || 5 || 190 || Gamecard not initialized
|-
| 0x1F405 || 5 || 250 || Sdcard not inserted
|-
| 0x20805 || 5 || 260 || Storage not mounted
|-
| 0x806 || 6 || 4 || Converted from error 0xD401
|-
| 0x1006 || 6 || 8 || Converted from error 0xE401
|-
| 0x408 || 8 || 2 || Program location entry not found
|-
| 0x608 || 8 || 3 || Invalid context for control location
|-
| 0x808 || 8 || 4 || Storage not found
|-
| 0xA08 || 8 || 5 || Access denied
|-
| 0xC08 || 8 || 6 || Offline manual HTML location entry not found
|-
| 0xE08 || 8 || 7 || Title is not registered
|-
| 0x1008 || 8 || 8 || Control location entry for host not found
|-
| 0x1208 || 8 || 9 || Legal info HTML location entry not found
|-
| 0x209 || 9 || 1 || Args too long.
|-
| 0x409 || 9 || 2 || Maximum processes loaded.
|-
| 0x609 || 9 || 3 || NPDM too big.
|-
| 0x19009 || 9 || 200 || Invalid access control sizes in NPDM.
|-
| 0x809 || 9 || 4 || Invalid NPDM.
|-
| 0xA09 || 9 || 5 || Invalid files.
|-
| 0xE09 || 9 || 7 || Already registered.
|-
| 0x1009 || 9 || 8 || Title not found.
|-
| 0x1209 || 9 || 9 || Title-id in ACI0 doesn't match range in ACID.
|-
| 0x6609 || 9 || 51 || Invalid memory state/permission
|-
| 0x6A09 || 9 || 53 || Invalid NRR
|-
| 0xA209 || 9 || 81 || Unaligned NRR address
|-
| 0xA409 || 9 || 82 || Bad NRR size
|-
| 0xAA09 || 9 || 85 || Bad NRR address
|-
| 0xAE09 || 9 || 87 || Bad initialization
|-
| 0xC809 || 9 || 100 || Unknown ACI0 descriptor
|-
| 0xCE09 || 9 || 103 || ACID/ACI0 don't match for descriptor "KernelFlags"
|-
| 0xD009 || 9 || 104 || ACID/ACI0 don't match for descriptor "SyscallMask"
|-
| 0xD409 || 9 || 106 || ACID/ACI0 don't match for descriptor "MapIoOrNormalRange"
|-
| 0xD609 || 9 || 107 || ACID/ACI0 don't match for descriptor "MapNormalPage"
|-
| 0xDE09 || 9 || 111 || ACID/ACI0 don't match for descriptor "InterruptPair"
|-
| 0xE209 || 9 || 113 || ACID/ACI0 don't match for descriptor "ApplicationType"
|-
| 0xE409 || 9 || 114 || ACID/ACI0 don't match for descriptor "KernelReleaseVersion"
|-
| 0xE609 || 9 || 115 || ACID/ACI0 don't match for descriptor "HandleTableSize"
|-
| 0xE809 || 9 || 116 || ACID/ACI0 don't match for descriptor "DebugFlags"
|-
| 0x1A80A || 10 || 212 || Bad magic (expected 'SFCO')
|-
| 0x20B || 11 || 1 || Size too big to fit to marshal.
|-
| 0x11A0B || 11 || 141 || Went past maximum during marshalling.
|-
| 0x1900B || 11 || 200 || Session doesn't support domains.
|-
| 0x25A0B || 11 || 301 || Remote process is dead.
|-
| 0x3D60B || 11 || 491 || IPC Query 1 failed.
|-
| 0x20F || 15 || 1 || Pid not found
|-
| 0x60F || 15 || 3 || Process has no pending events
|-
| 0xA0F || 15 || 5 || Application already running
|-
| 0x410 || 16 || 2 || Title-id not found
|-
| 0xF010 || 16 || 120 || Gamecard sysupdate not required
|-
| 0x1F610 || 16 || 251 || Unexpected StorageId
|-
| 0x415 || 21 || 2 || Not initialized.
|-
| 0x615 || 21 || 3 || Max sessions
|-
| 0xC15 || 21 || 6 || Invalid name (all zeroes)
|-
| 0x1015 || 21 || 8 || Permission denied
|-
| 0x416 || 22 || 2 || Address space is full
|-
| 0x616 || 22 || 3 || NRO already loaded
|-
| 0x816 || 22 || 4 || Invalid NRO header values
|-
| 0xC16 || 22 || 6 || Bad NRR magic
|-
| 0x1016 || 22 || 8 || Reached max NRR count
|-
| 0x1216 || 22 || 9 || Unable to verify NRO hash or NRR signature
|-
| 0x80216 || 22 || 1025 || Address not page-aligned
|-
| 0x80416 || 22 || 1026 || Incorrect NRO size
|-
| 0x80816 || 22 || 1028 || NRO not loaded
|-
| 0x80A16 || 22 || 1029 || NRR not loaded
|-
| 0x80C16 || 22 || 1030 || Already initialized
|-
| 0x80E16 || 22 || 1031 || Not initialized
|-
| 0x41A || 26 || 2 || Argument is invalid
|-
| 0xC81A || 26 || 100 || Incorrect buffer size
|-
| 0xCA1A || 26 || 101 || Unknown TZ error
|-
| 0xD01A || 26 || 104 || All AES engines busy
|-
| 0xD21A || 26 || 105 || Invalid AES engine-id
|-
| 0x272 || 114 || 1 || Generic error
|-
| 0xCC74 || 116 || 102 || Time not set
|-
| 0x287C || 124 || 20 || Argument is NULL
|-
| 0x2C7C || 124 || 22 || Argument is invalid
|-
| 0x3C7C || 124 || 30 || Bad input buffer size
|-
| 0x407C || 124 || 32 || Invalid input buffer
|-
| 0x7A880 || 128 || 500 || <code>am.debug!dev_function</code> setting needs to be set
|-
| 0x3CF089 || 137 || 7800 || Unknown/invalid libcurl error.
|-
| 0x3E8289-0x3F4089 || 137 || 8001-8096 || libcurl error 1-96. Some of the libcurl errors in the error-table map to the above unknown-libcurl-error however.
|-
| 0x668C || 140 || 51 || USB data-transfer in progress
|-
| 0xD48C || 140 || 106 || Invalid descriptor
|-
| 0x1928C || 140 || 201 || USB device not bound / interface already enabled
|-
| 0x299 || 153 || 1 || Invalid audio device
|-
| 0x499 || 153 || 2 || Invalid buffer address
|-
| 0x699 || 153 || 3 || Invalid sample rate
|-
| 0x1499 || 153 || 10 || Invalid channel count
|-
| 0xC0899 || 153 || 1540 || Audio output was already started
|-
| 0x3C9D || 157 || 30 || Address is NULL
|-
| 0x3E9D || 157 || 31 || PID is NULL
|-
| 0x549D || 157 || 42 || Already bound
|-
| 0xCC9D || 157 || 102 || Invalid PID
|-
| 0x35B || 347 || 1 || Failed to init SM.
|-
| 0x55B || 347 || 2 || Failed to init FS.
|-
| 0x75B || 347 || 3 || Failed to to open NRO file. May also happen when SD card isn't inserted / SD mounting failed earlier.
|-
| 0x95B || 347 || 4 || Failed to read NRO header.
|-
| 0xB5B || 347 || 5 || Invalid NRO magic.
|-
| 0xD5B || 347 || 6 || Invalid NRO segments.
|-
| 0xF5B || 347 || 7 || Failed to read NRO.
|-
| 0x135B || 347 || 9 || Failed to allocate heap.
|-
| 0x255B || 347 || 18 || Failed to map code-binary memory.
|-
| 0x275B || 347 || 19 || Failed to map code memory (.text).
|-
| 0x295B || 347 || 20 || Failed to map code memory (.rodata).
|-
| 0x2B5B || 347 || 21 || Failed to map code memory (.data+.bss).
|-
| 0x315B || 347 || 24 || Failed to unmap code memory (.text).
|-
| 0x335B || 347 || 25 || Failed to unmap code memory (.rodata).
|-
| 0x355B || 347 || 26 || Failed to unmap code memory (.data+.bss).
|}

== FS Error Codes ==
The following are the error codes recognized by nn::fs::detail::LogErrorMessage found in some [[Factory Setup|factory]] titles:

{| class=wikitable
! Value || Description || Message
|-
| 0x7802 || 60 || Error: Specified mount name already exists.
|-
| 0xD401 || 106 || Error: Passed buffer is not usable for fs library.
|-
| 0x7D202 || 1001 || Error: Specified partition is not found.
|-
| 0x7D402 || 1002 || Error: Specified target is not found.
|-
| 0xFA002 - 0x138602 || 2000 - 2499 || Error: Failed to access SD card.
|-
| 0x136802 - 0x176E02 || 2500 - 2999 || Error: Failed to access game card.
|-
| 0x177202 || 3001 || Error: Specified operation is not implemented.
|-
| 0x177A02 || 3005 || Error: Specified value is out of range.
|-
| 0x1B5802 - 0x1F3E02 || 3500 - 3999 || Error: Failed to access MMC.
|-
| 0x1F4202 - 0x219602 || 4001 - 4299 || Error: ROM is corrupted.
|-
| 0x219A02 - 0x232602 || 4301 - 4499 || Error: Save data is corrupted.
|-
| 0x232A02 - 0x23EE02 || 4501 - 4599 || Error: NCA is corrupted.
|-
| 0x23F202 - 0x243E02 || 4601 - 4639 || Error: Integrity verification failed.
|-
| 0x244202 - 0x246602 || 4641 - 4659 || Error: Partition FS is corrupted.
|-
| 0x246A02 - 0x248E02 || 4661 - 4679 || Error: Built-in-storage is corrupted.
|-
| 0x249202 - 0x24B602 || 4681 - 4699 || Error: FAT FS is corrupted.
|-
| 0x24BA02 - 0x24DE02 || 4701 - 4719 || Error: HOST FS is corrupted.
|-
| 0x1F4002 - 0x270E02 || 4000, 4300, 4500, 4600, 4640, 4660, 4680, 4700, 4720-4999 || Error: Data is corrupted.
|-
| 0x271002 - 0x2EDE02 || 5000-5999 || Error: Unexpected failure occurred.
|-
| 0x2EE402 - 0x2F1A02 || 6002-6029 || Error: Invalid path was specified.
|-
| 0x2F5A02 || 6061 || Error: Invalid offset was specified.
|-
| 0x2F5C02 || 6062 || Error: Invalid size was specified.
|-
| 0x2F5E02 || 6063 || Error: Null pointer argument was specified.
|-
| 0x2EE002 || 6000 || Error: Precondition violation.
|-
| 0x2EE202 - 0x306E02 || 6001-6199 || Error: Invalid argument was specified.
|-
| 0x307202 || 6201 || Error: OpenMode_AllowAppend is required for implicit extension of file size by WriteFile().
|-
| 0x307002 - 0x313602 || 6200, 6202 - 6299 || Error: Invalid operation for the open mode.
|-
| 0x313802 - 0x31FE02 || 6300-6399 || Error: Unsupported operation.
|-
| 0x320002 - 0x32C602 || 6400-6499 || Error: Permission denied.
|-
| 0x346402 || 6706 || Error: Enough journal space is not left.
|-
| 0x346A02 || 6709 || Error: The open count of files and directories reached the limitation.
|}

= Fatal Errors =
{| class=wikitable
! Error || Description
|-
| 2162-0002
| Can be triggered by running [[SVC|svcBreak]]. The svcBreak params have no affect on the value of the thrown error-code.
|-
| 2168-0000
| Userland ARM undefined instruction exception
|-
| 2168-0001
| Userland ARM prefetch-abort due to PC set to non-executable region
|-
| 2168-0002
| Userland ARM data abort. Also caused by abnormal process termination via [[SVC|svcExitProcess]]. Note: directly jumping to nnMain()-retaddr from non-main-thread has the same result.
|-
| 2168-0003
| Userland PC address not aligned to 4 bytes
|-
| 2168-0008
| Can occur when attempting to call an svc outside the whitelist
|}

= Support Errors =
{| class=wikitable
! Error || Module || Description || Notes
|-
|
| {web-applets listed above}
| 2750
| MP4 parsing failed.
|}

Normal error-codes displayed by the system also use the same format as fatal-errors.

Error codes

2018-07-15T01:56:39Z

Adubbz: Added error code 6005

= Structure =
These have been redesigned from the 3DS so that they fit within a Aarch64 MOV instruction immediate most of the time (without requiring the additional MOVK).

{| class=wikitable
! Bits || Field
|-
| 8-0 || Module
|-
| 21-9 || Description
|}

When a fatal-error is received the error code is outputted using the following formatter:
%04d-%04d

.. where the first code is <code>2000 + Module</code>, and the other being <code>Description</code>. Bits >=22 from the error-code are unused when displaying fatal-errors, since the Description ends with bit21.

= Modules =
{| class=wikitable
! Value || Name
|-
| 1 || Kernel
|-
| 2 || FS
|-
| 3 || OS (Memory, Thread, Mutex, NVIDIA)
|-
| 4 || HTCS
|-
| 5 || NCM
|-
| 6 || DD
|-
| 7 || Debug Monitor
|-
| 8 || LR
|-
| 9 || Loader
|-
| 10 || CMIF (IPC command interface)
|-
| 11 || HIPC (IPC)
|-
| 15 || PM
|-
| 16 || NS
|-
| 17 || Sockets
|-
| 18 || HTC
|-
| 20 || NCM Content
|-
| 21 || SM
|-
| 22 || RO userland
|-
| 24 || SDMMC
|-
| 25 || OVLN
|-
| 26 || SPL
|-
| 100 || ETHC
|-
| 101 || I2C
|-
| 102 || GPIO
|-
| 103 || UART
|-
| 105 || Settings
|-
| 107 || WLAN
|-
| 108 || XCD
|-
| 110 || NIFM
|-
| 111 || Hwopus
|-
| 113 || Bluetooth
|-
| 114 || VI
|-
| 115 || NFP
|-
| 116 || Time
|-
| 117 || FGM
|-
| 118 || OE
|-
| 120 || PCIe
|-
| 121 || Friends
|-
| 122 || BCAT
|-
| 123 || SSL
|-
| 124 || Account
|-
| 125 || News
|-
| 126 || Mii
|-
| 127 || NFC
|-
| 128 || AM
|-
| 129 || Play Report
|-
| 130 || AHID
|-
| 132 || Home Menu (Qlaunch)
|-
| 133 || PCV
|-
| 134 || OMM
|-
| 135 || BPC
|-
| 136 || PSM
|-
| 137 || NIM
|-
| 138 || PSC
|-
| 139 || TC
|-
| 140 || USB
|-
| 141 || NSD
|-
| 142 || PCTL
|-
| 143 || BTM
|-
| 144 || EC (Shop)
|-
| 145 || ETicket
|-
| 146 || NGC (Bad Words)
|-
| 147 || Error Report
|-
| 148 || APM
|-
| 150 || Profiler
|-
| 151 || Error Upload
|-
| 153 || Audio
|-
| 154 || NPNS
|-
| 155 || NPNS HTTP Stream
|-
| 157 || ARP
|-
| 158 || SWKBD
|-
| 159 || Boot
|-
| 161 || NFC Mifare
|-
| 162 || Userland assert
|-
| 163 || Fatal
|-
| 164 || NIM Shop
|-
| 165 || SPSM
|-
| 167 || BGTC
|-
| 168 || Userland crash
|-
| 180 || SREPO
|-
| 181 || Dauth
|-
| 202 || HID
|-
| 203 || LDN
|-
| 205 || Irsensor
|-
| 206 || Capture
|-
| 208 || Manu
|-
| 209 || ATK
|-
| 210 || Web
|-
| 211 ||
|-
| 212 || GRC
|-
| 216 || Migration
|-
| 217 || Migration Idc Server
|-
| 345 || libnx
|-
| 346 || [[Homebrew ABI]]
|-
| 347 || Homebrew Loader
|-
| 348 || libnx Nvidia errors
|-
| 800 || [[Internet_Browser|General web-applet]]
|-
| 809 || [[Internet_Browser|WifiWebAuthApplet]]
|-
| 810 || [[Internet_Browser|Whitelisted-applet]]
|-
| 811 || [[Internet_Browser|ShopN]]
|}

8XX is for/includes system applets.

= Error codes =
{| class=wikitable
! Value || Module || Description || Notes
|-
| 0x1C01 || 1 || 14 || Invalid kernel capability descriptor
|-
| 0x4201 || 1 || 33 || [[SPL_services#GetConfig|IsDebugMode]] isn't set.
|-
| 0x8C01 || 1 || 70 || No more debug events
|-
| 0xCA01 || 1 || 101 || Invalid size
|-
| 0xCC01 || 1 || 102 || Invalid address
|-
| 0xCE01 || 1 || 103 || Slabheap full
|-
| 0xD001 || 1 || 104 || Memory full
|-
| 0xD201 || 1 || 105 || Handle-table full.
|-
| 0xD401 || 1 || 106 || Invalid memory state / invalid memory permissions.
|-
| 0xD801 || 1 || 108 || Invalid memory permissions.
|-
| 0xDC01 || 1 || 110 || Invalid memory range
|-
| 0xE001 || 1 || 112 || Invalid thread priority.
|-
| 0xE201 || 1 || 113 || Invalid processor id.
|-
| 0xE401 || 1 || 114 || Invalid handle.
|-
| 0xE601 || 1 || 115 || Syscall copy from user failed.
|-
| 0xE801 || 1 || 116 || Invalid combination
|-
| 0xEA01 || 1 || 117 || Time out. Also when you give 0 handles to svcWaitSynchronizationN.
|-
| 0xEC01 || 1 || 118 || Canceled/interrupted [?]
|-
| 0xEE01 || 1 || 119 || Exceeding maximum
|-
| 0xF001 || 1 || 120 || Invalid enum
|-
| 0xF201 || 1 || 121 || No such entry
|-
| 0xF401 || 1 || 122 || Irq/DeviceAddressSpace/{...} already registered
|-
| 0xF601 || 1 || 123 || Port remote dead
|-
| 0xF801 || 1 || 124 || [Usermode] Unhandled interrupt
|-
| 0xFA01 || 1 || 125 || Wrong memory permission?
|-
| 0xFC01 || 1 || 126 || Reserved value
|-
| 0xFE01 || 1 || 127 || Invalid hardware breakpoint
|-
| 0x10001 || 1 || 128 || [Usermode] Fatal exception
|-
| 0x10201 || 1 || 129 || Last thread didn't belong to your process
|-
| 0x10601 || 1 || 131 || Port max sessions exceeded
|-
| 0x10801 || 1 || 132 || Resource limit exceeded
|-
| 0x20801 || 1 || 260 || Command buffer too small
|-
| 0x41001 || 1 || 520 || Process not being debugged
|-
| 0xE02 || 2 || 7 || Savedata [[Filesystem_services|already]] mounted
|-
| 0x7802 || 2 || 60 || The specified [[NCA]]-type doesn't exist for this title.
|-
| 0x7D202 || 2 || 1001 || Process does not have RomFs
|-
| 0x7D402 || 2 || 1002 || Title-id not found / savedata not found.
|-
| 0xFA202 || 2 || 2001 || SD card not inserted
|-
| 0x13B002 || 2 || 2520 || Gamecard not inserted
|-
| 0x13DA02 || 2 || 2541 || Version check failed when mounting gamecard sysupdate partition?
|-
| 0x171402 || 2 || 2954 || Invalid gamecard handle.
|-
| 0x196002 || 2 || 3248 || Out of memory
|-
| 0x196202 || 2 || 3249 || Out of memory
|-
| 0x1A4A02 || 2 || 3365 || Out of memory
|-
| 0x235202 || 2 || 4521 || Invalid NCA Key index
|-
| 0x235E02 || 2 || 4527 || NCA-path used with the wrong titleID.
|-
| 0x250E02 || 2 || 4743 || [[NAX0|Corrupted]] NAX0 header.
|-
| 0x251002 || 2 || 4744 || Invalid [[NAX0]] magicnum.
|-
| 0x2EE202 || 2 || 6001 || Invalid input
|-
| 0x2EE602 || 2 || 6003 || Path too long
|-
| 0x2F5A02 || 2 || 6061 || Offset outside storage
|-
| 0x313802 || 2 || 6300 || Operation not supported
|-
| 0x320002 || 2 || 6400 || Permission denied
|-
| 0x326602 || 2 || 6451 || Missing titlekey(?) required to mount content
|-
| 0x3EA03 || 3 || 501 || Invalid handle
|-
| 0x3EE03 || 3 || 503 || Invalid memory mirror
|-
| 0x7FE03 || 3 || 1023 || TLS slot is not allocated
|-
| 0xA05 || 5 || 5 || [[Content_Manager_services|NcaID]] not found. Returned when attempting to mount titles which exist that aren't *8XX titles, the same way *8XX titles are mounted.
|-
| 0xE05 || 5 || 7 || TitleId not found
|-
| 0x1805 || 5 || 12 || Invalid StorageId
|-
| 0xDC05 || 5 || 110 || Gamecard not inserted
|-
| 0x17C05 || 5 || 190 || Gamecard not initialized
|-
| 0x1F405 || 5 || 250 || Sdcard not inserted
|-
| 0x20805 || 5 || 260 || Storage not mounted
|-
| 0x806 || 6 || 4 || Converted from error 0xD401
|-
| 0x1006 || 6 || 8 || Converted from error 0xE401
|-
| 0x408 || 8 || 2 || Program location entry not found
|-
| 0x608 || 8 || 3 || Invalid context for control location
|-
| 0x808 || 8 || 4 || Storage not found
|-
| 0xA08 || 8 || 5 || Access denied
|-
| 0xC08 || 8 || 6 || Offline manual HTML location entry not found
|-
| 0xE08 || 8 || 7 || Title is not registered
|-
| 0x1008 || 8 || 8 || Control location entry for host not found
|-
| 0x1208 || 8 || 9 || Legal info HTML location entry not found
|-
| 0x209 || 9 || 1 || Args too long.
|-
| 0x409 || 9 || 2 || Maximum processes loaded.
|-
| 0x609 || 9 || 3 || NPDM too big.
|-
| 0x19009 || 9 || 200 || Invalid access control sizes in NPDM.
|-
| 0x809 || 9 || 4 || Invalid NPDM.
|-
| 0xA09 || 9 || 5 || Invalid files.
|-
| 0xE09 || 9 || 7 || Already registered.
|-
| 0x1009 || 9 || 8 || Title not found.
|-
| 0x1209 || 9 || 9 || Title-id in ACI0 doesn't match range in ACID.
|-
| 0x6609 || 9 || 51 || Invalid memory state/permission
|-
| 0x6A09 || 9 || 53 || Invalid NRR
|-
| 0xA209 || 9 || 81 || Unaligned NRR address
|-
| 0xA409 || 9 || 82 || Bad NRR size
|-
| 0xAA09 || 9 || 85 || Bad NRR address
|-
| 0xAE09 || 9 || 87 || Bad initialization
|-
| 0xC809 || 9 || 100 || Unknown ACI0 descriptor
|-
| 0xCE09 || 9 || 103 || ACID/ACI0 don't match for descriptor "KernelFlags"
|-
| 0xD009 || 9 || 104 || ACID/ACI0 don't match for descriptor "SyscallMask"
|-
| 0xD409 || 9 || 106 || ACID/ACI0 don't match for descriptor "MapIoOrNormalRange"
|-
| 0xD609 || 9 || 107 || ACID/ACI0 don't match for descriptor "MapNormalPage"
|-
| 0xDE09 || 9 || 111 || ACID/ACI0 don't match for descriptor "InterruptPair"
|-
| 0xE209 || 9 || 113 || ACID/ACI0 don't match for descriptor "ApplicationType"
|-
| 0xE409 || 9 || 114 || ACID/ACI0 don't match for descriptor "KernelReleaseVersion"
|-
| 0xE609 || 9 || 115 || ACID/ACI0 don't match for descriptor "HandleTableSize"
|-
| 0xE809 || 9 || 116 || ACID/ACI0 don't match for descriptor "DebugFlags"
|-
| 0x1A80A || 10 || 212 || Bad magic (expected 'SFCO')
|-
| 0x20B || 11 || 1 || Size too big to fit to marshal.
|-
| 0x11A0B || 11 || 141 || Went past maximum during marshalling.
|-
| 0x1900B || 11 || 200 || Session doesn't support domains.
|-
| 0x25A0B || 11 || 301 || Remote process is dead.
|-
| 0x3D60B || 11 || 491 || IPC Query 1 failed.
|-
| 0x20F || 15 || 1 || Pid not found
|-
| 0x60F || 15 || 3 || Process has no pending events
|-
| 0xA0F || 15 || 5 || Application already running
|-
| 0x410 || 16 || 2 || Title-id not found
|-
| 0xF010 || 16 || 120 || Gamecard sysupdate not required
|-
| 0x1F610 || 16 || 251 || Unexpected StorageId
|-
| 0x415 || 21 || 2 || Not initialized.
|-
| 0x615 || 21 || 3 || Max sessions
|-
| 0xC15 || 21 || 6 || Invalid name (all zeroes)
|-
| 0x1015 || 21 || 8 || Permission denied
|-
| 0x416 || 22 || 2 || Address space is full
|-
| 0x616 || 22 || 3 || NRO already loaded
|-
| 0x816 || 22 || 4 || Invalid NRO header values
|-
| 0xC16 || 22 || 6 || Bad NRR magic
|-
| 0x1016 || 22 || 8 || Reached max NRR count
|-
| 0x1216 || 22 || 9 || Unable to verify NRO hash or NRR signature
|-
| 0x80216 || 22 || 1025 || Address not page-aligned
|-
| 0x80416 || 22 || 1026 || Incorrect NRO size
|-
| 0x80816 || 22 || 1028 || NRO not loaded
|-
| 0x80A16 || 22 || 1029 || NRR not loaded
|-
| 0x80C16 || 22 || 1030 || Already initialized
|-
| 0x80E16 || 22 || 1031 || Not initialized
|-
| 0x41A || 26 || 2 || Argument is invalid
|-
| 0xC81A || 26 || 100 || Incorrect buffer size
|-
| 0xCA1A || 26 || 101 || Unknown TZ error
|-
| 0xD01A || 26 || 104 || All AES engines busy
|-
| 0xD21A || 26 || 105 || Invalid AES engine-id
|-
| 0x272 || 114 || 1 || Generic error
|-
| 0xCC74 || 116 || 102 || Time not set
|-
| 0x287C || 124 || 20 || Argument is NULL
|-
| 0x2C7C || 124 || 22 || Argument is invalid
|-
| 0x3C7C || 124 || 30 || Bad input buffer size
|-
| 0x407C || 124 || 32 || Invalid input buffer
|-
| 0x7A880 || 128 || 500 || <code>am.debug!dev_function</code> setting needs to be set
|-
| 0x3CF089 || 137 || 7800 || Unknown/invalid libcurl error.
|-
| 0x3E8289-0x3F4089 || 137 || 8001-8096 || libcurl error 1-96. Some of the libcurl errors in the error-table map to the above unknown-libcurl-error however.
|-
| 0x668C || 140 || 51 || USB data-transfer in progress
|-
| 0xD48C || 140 || 106 || Invalid descriptor
|-
| 0x1928C || 140 || 201 || USB device not bound / interface already enabled
|-
| 0x299 || 153 || 1 || Invalid audio device
|-
| 0x499 || 153 || 2 || Invalid buffer address
|-
| 0x699 || 153 || 3 || Invalid sample rate
|-
| 0x1499 || 153 || 10 || Invalid channel count
|-
| 0xC0899 || 153 || 1540 || Audio output was already started
|-
| 0x3C9D || 157 || 30 || Address is NULL
|-
| 0x3E9D || 157 || 31 || PID is NULL
|-
| 0x549D || 157 || 42 || Already bound
|-
| 0xCC9D || 157 || 102 || Invalid PID
|-
| 0x35B || 347 || 1 || Failed to init SM.
|-
| 0x55B || 347 || 2 || Failed to init FS.
|-
| 0x75B || 347 || 3 || Failed to to open NRO file. May also happen when SD card isn't inserted / SD mounting failed earlier.
|-
| 0x95B || 347 || 4 || Failed to read NRO header.
|-
| 0xB5B || 347 || 5 || Invalid NRO magic.
|-
| 0xD5B || 347 || 6 || Invalid NRO segments.
|-
| 0xF5B || 347 || 7 || Failed to read NRO.
|-
| 0x135B || 347 || 9 || Failed to allocate heap.
|-
| 0x255B || 347 || 18 || Failed to map code-binary memory.
|-
| 0x275B || 347 || 19 || Failed to map code memory (.text).
|-
| 0x295B || 347 || 20 || Failed to map code memory (.rodata).
|-
| 0x2B5B || 347 || 21 || Failed to map code memory (.data+.bss).
|-
| 0x315B || 347 || 24 || Failed to unmap code memory (.text).
|-
| 0x335B || 347 || 25 || Failed to unmap code memory (.rodata).
|-
| 0x355B || 347 || 26 || Failed to unmap code memory (.data+.bss).
|}

== FS Error Codes ==
The following are the error codes recognized by nn::fs::detail::LogErrorMessage found in some [[Factory Setup|factory]] titles:

{| class=wikitable
! Value || Description || Message
|-
| 0x7802 || 60 || Error: Specified mount name already exists.
|-
| 0xD401 || 106 || Error: Passed buffer is not usable for fs library.
|-
| 0x7D202 || 1001 || Error: Specified partition is not found.
|-
| 0x7D402 || 1002 || Error: Specified target is not found.
|-
| 0xFA002 - 0x138602 || 2000 - 2499 || Error: Failed to access SD card.
|-
| 0x136802 - 0x176E02 || 2500 - 2999 || Error: Failed to access game card.
|-
| 0x177202 || 3001 || Error: Specified operation is not implemented.
|-
| 0x177A02 || 3005 || Error: Specified value is out of range.
|-
| 0x1B5802 - 0x1F3E02 || 3500 - 3999 || Error: Failed to access MMC.
|-
| 0x1F4202 - 0x219602 || 4001 - 4299 || Error: ROM is corrupted.
|-
| 0x219A02 - 0x232602 || 4301 - 4499 || Error: Save data is corrupted.
|-
| 0x232A02 - 0x23EE02 || 4501 - 4599 || Error: NCA is corrupted.
|-
| 0x23F202 - 0x243E02 || 4601 - 4639 || Error: Integrity verification failed.
|-
| 0x244202 - 0x246602 || 4641 - 4659 || Error: Partition FS is corrupted.
|-
| 0x246A02 - 0x248E02 || 4661 - 4679 || Error: Built-in-storage is corrupted.
|-
| 0x249202 - 0x24B602 || 4681 - 4699 || Error: FAT FS is corrupted.
|-
| 0x24BA02 - 0x24DE02 || 4701 - 4719 || Error: HOST FS is corrupted.
|-
| 0x1F4002 - 0x270E02 || 4000, 4300, 4500, 4600, 4640, 4660, 4680, 4700, 4720-4999 || Error: Data is corrupted.
|-
| 0x271002 - 0x2EDE02 || 5000-5999 || Error: Unexpected failure occurred.
|-
| 0x2EE402 - 0x2F1A02 || 6002-6029 || Error: Invalid path was specified.
|-
| 0x2F5A02 || 6061 || Error: Invalid offset was specified.
|-
| 0x2F5C02 || 6062 || Error: Invalid size was specified.
|-
| 0x2F5E02 || 6063 || Error: Null pointer argument was specified.
|-
| 0x2EE002 || 6000 || Error: Precondition violation.
|-
| 0x2EE202 - 0x306E02 || 6001-6199 || Error: Invalid argument was specified.
|-
| 0x2EEA02 || 6005 || Directory/file(?) already exists.
|-
| 0x307202 || 6201 || Error: OpenMode_AllowAppend is required for implicit extension of file size by WriteFile().
|-
| 0x307002 - 0x313602 || 6200, 6202 - 6299 || Error: Invalid operation for the open mode.
|-
| 0x313802 - 0x31FE02 || 6300-6399 || Error: Unsupported operation.
|-
| 0x320002 - 0x32C602 || 6400-6499 || Error: Permission denied.
|-
| 0x346402 || 6706 || Error: Enough journal space is not left.
|-
| 0x346A02 || 6709 || Error: The open count of files and directories reached the limitation.
|}

= Fatal Errors =
{| class=wikitable
! Error || Description
|-
| 2162-0002
| Can be triggered by running [[SVC|svcBreak]]. The svcBreak params have no affect on the value of the thrown error-code.
|-
| 2168-0000
| Userland ARM undefined instruction exception
|-
| 2168-0001
| Userland ARM prefetch-abort due to PC set to non-executable region
|-
| 2168-0002
| Userland ARM data abort. Also caused by abnormal process termination via [[SVC|svcExitProcess]]. Note: directly jumping to nnMain()-retaddr from non-main-thread has the same result.
|-
| 2168-0003
| Userland PC address not aligned to 4 bytes
|-
| 2168-0008
| Can occur when attempting to call an svc outside the whitelist
|}

= Support Errors =
{| class=wikitable
! Error || Module || Description || Notes
|-
|
| {web-applets listed above}
| 2750
| MP4 parsing failed.
|}

Normal error-codes displayed by the system also use the same format as fatal-errors.

NCM services

2018-07-13T11:39:10Z

Adubbz: Correct return order

NCM contains services for internal file path and content management.

= Location Resolver services =
== lr ==
This is "nn::lr::ILocationResolverManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || OpenLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 1 || OpenRegisteredLocationResolver || None ||
|-
| 2 || RefreshLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
|-
| 3 || [2.0.0+] OpenAddOnContentLocationResolver || None ||
|}

The only sysmodules which use this service are [[Filesystem_services|FS]], [[Loader_services|Loader]], and [[NS_Services|NS]]. [[boot2]] has access but doesn't use it.

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

{| class="wikitable" border="1"
|-
! 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+] [[#SetProgramNcaPath2]]
|-
| 11 || [5.0.0+] [[#ClearLocationResolver2]]
|-
| 12 || [5.0.0+] [[#DeleteProgramNcaPath]]
|-
| 13 || [5.0.0+] [[#DeleteControlNcaPath]]
|-
| 14 || [5.0.0+] [[#DeleteDocHtmlNcaPath]]
|-
| 15 || [5.0.0+] [[#DeleteInfoHtmlNcaPath]]
|}

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

The Get* commands load the [[Filesystem_services|ContentPath]] from linked-lists' [[#Location_List_Entry|entries]] in memory using the input TitleID. When the command fails to find an entry for the specified TitleID, 0x408 is returned for GetProgramNcaPath 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 u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

==== RedirectProgramPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 0.

==== ResolveApplicationControlPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== ResolveApplicationHtmlDocumentPath====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

==== ResolveDataPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

==== RedirectApplicationControlPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== RedirectApplicationHtmlDocumentPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ResolveApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

==== RedirectApplicationLegalInformationPath ====
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== Refresh ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 0.

==== SetProgramNcaPath2 ====
Same as [[#SetProgramNcaPath|SetProgramNcaPath]], but inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.

==== ClearLocationResolver2 ====
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 1.

==== DeleteProgramNcaPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== DeleteControlNcaPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== DeleteDocHtmlNcaPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

==== DeleteInfoHtmlNcaPath ====
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].

Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.

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

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 title ID at a time.

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveProgramPath || u64 TitleID + C descriptor || Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
|-
| 1 || RegisterProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 0 fallback TID and path to the provided arguments.
|-
| 2 || UnregisterProgramPath || u64 TitleID || If the Type 0 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 3 || RedirectProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|-
| 4 || [2.0.0+] ResolveHtmlDocumentPath || u64 TitleID + C descriptor ||
|-
| 5 || [2.0.0+] RegisterHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 1 fallback TID and path to the provided arguments.
|-
| 6 || [2.0.0+] UnregisterHtmlDocumentPath || u64 TitleID || If the Type 1 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
|-
| 7 || [2.0.0+] RedirectHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Arguments || Notes
|-
| 0 || ResolveAddOnContentPath || u64 TitleID + C descriptor ||
|-
| 1 || RegisterAddOnContentStorage || [[Filesystem_services#StorageId|StorageID]] + u64 TitleID ||
|-
| 2 || UnregisterAllAddOnContentPath || None || Clears all registered titles here.
|}

=== Location List Entry ===
Total size is 0x320 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8|| Pointer to previous entry
|-
| 0x8 || 0x8|| Pointer to next entry
|-
| 0x10 || 0x8|| TitleID
|-
| 0x18 || 0x300 || [[Filesystem_services|ContentPath]]
|-
| 0x318 || 0x4 || Flag
|-
| 0x31C || 0x4 || Padding
|}

= Content Manager services =
== ncm ==
This is "nn::ncm::IContentManager".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || CreateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 1 || CreateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 2 || VerifyContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 3 || VerifyContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
|-
| 4 || OpenContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 5 || OpenContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], [2.0.0+] Only returns a storage if one has previously been opened globally via OpenIContentStorage.
|-
| 6 || [1.0.0] CloseContentStorageForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentStorage->CloseAndFlushStorage().
|-
| 7 || [1.0.0] CloseContentMetaDatabaseForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentMetaDatabase->CloseMetaDatabase().
|-
| 8 || CleanupContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and deletes the associated savedata.
|-
| 9 || [2.0.0+] OpenContentStorage2 || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentStorage for the StorageID to be gotten with GetIContentStorage. Note: Name is not official.
|-
| 10 || [2.0.0+] CloseContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentStorage. Note: Name is not official.
|-
| 11 || [2.0.0+] OpenContentMetaDatabase2 || Takes a [[Filesystem_services#StorageId|StorageID]], and opens an IContentMetaDatabase for the StorageID to be gotten with GetIContentMetaDatabase. Note: Name is not official.
|-
| 12 || [2.0.0+] CloseContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and closes the associated IContentMetaDatabase. Note: Name is not official.
|}

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

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GeneratePlaceHolderId]] || Returns a random UUID for the Content Storage.
|-
| 1 || CreatePlaceHolder || Takes two [[#NcaID]]s, and a u64 filesize.
|-
| 2 || DeletePlaceHolder || Takes a [[#NcaID]].
|-
| 3 || HasPlaceHolder || Takes a [[#NcaID]].
|-
| 4 || WritePlaceHolder || Takes a [[#NcaID]], a u64-offset, and type 5 buffer. Writes the buffer to the file for the NcaID's placeholder path at the specified offset.
|-
| 5 || Register || Takes two [[#NcaID]]s, moves the Placeholder NCA content to the registered NCA path.
|-
| 6 || Delete || Takes a [[#NcaID]].
|-
| 7 || Has || Takes a [[#NcaID]].
|-
| 8 || GetPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 9 || GetPlaceHolderPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
|-
| 10 || CleanupAllPlaceHolder || Deletes and re-creates the Placeholder directory.
|-
| 11 || ListPlaceHolder || This is like [[#GetNumberOfRegisteredEntries]], but for the Placeholder directory.
|-
| 12 || [[#GetContentCount]] ||
|-
| 13 || [[#ListContentId]] ||
|-
| 14 || [[#GetSize]] ||
|-
| 15 || DisableForcibly || Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.
|-
| 16 || [2.0.0+] RevertToPlaceHolder || Takes three 0x10-sized [[#NcaID]]s. Creates the registered directory NCA path, and renames the placeholder path to the registered NCA path.
|-
| 17 || [2.0.0+] SetPlaceHolderSize || Takes a [[#NcaID]], and a u64 size
|-
| 18 || [2.0.0+] [[#ReadContentIdFile]] ||
|-
| 19 || [2.0.0+] GetRightsIdFromPlaceHolderId || Gets the Rights ID for the [[#NcaID]]'s placeholder path.
|-
| 20 || [2.0.0+] GetRightsIdFromContentId || Gets the Rights ID for the [[#NcaID]]'s registered path
|-
| 21 || [2.0.0+] WriteContentForDebug || Takes a [[#NcaID]], a u64 offset, and a type 5 buffer. On debug units, writes the buffer to the NCA's registered path. On retail units, this just aborts.
|-
| 22 || [2.0.0+] GetFreeSpaceSize || Gets free space for the storage.
|-
| 23 || [2.0.0+] GetTotalSpaceSize || Gets total space for the storage.
|-
| 24 || [3.0.0+] FlushStorage || Flushes resources for the storage without closing it.
|-
| 25 || [4.0.0+] ||
|-
| 26 || [4.0.0+] ||
|}

==== GeneratePlaceHolderId ====
Generates a random [[#NcaID]] for use as a placeholder.

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

==== GetContentCount ====
Writes the total number of entries which can be read by GetEntries, to cmdreply <SFCO_offset>+0x10.

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

Each entry is a [[#NcaID]].

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?).

==== GetSize ====
Takes a [[#NcaID]] as input.

Returns the total size readable by ReadEntryRaw. This is the same as the size-field in the [[NAX0]] "<NcaID>.nca/00" file.

==== ReadContentIdFile ====
Takes an output buffer, a [[#NcaID]] as input, and a u64 file offset.

Reads plaintext NCA file contents from the Registered path for the NcaID.

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

Note the official name for Meta Record is "ContentMetaKey".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Set || Takes a [[NCA#Meta_records|Meta Record]], a type-5 [[NCA#Content_records|Content Records]] buffer and a u64 size.
|-
| 1 || Get || Takes a [[NCA#Meta_records|Meta Record]], a type-6 buffer to write [[NCA#Content_records|Content Records]] to and a u64 size. Returns the actual Content Records size read.
|-
| 2 || Remove || Takes a [[NCA#Meta_records|Meta Record]], and removes the associated record.
|-
| 3 || GetContentIdByType || Takes a [[NCA#Meta_records|Meta Record]] and a u8 [[#Title_Types|Title Type]]. Returns a [[#NcaID]].
|-
| 4 || ListContentInfo || Takes a type-6 buffer to write [[NCA#Content_records|Content Record]] entries to, a [[NCA#Meta_records|Meta Record]], and a u32 index into the Content Record entries to start copying from. Returns a u32 entries_read.
|-
| 5 || List || Takes a type-6 buffer to write [[NCA#Meta_records|Meta Record]]s to, a u32 [[#Title_Types|Title Type]], a u64 TID, a u64 TID_LOW, and u64 TID_HIGH. Writes into the buffer all Meta Records 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.
|-
| 6 || GetLatestContentMetaKey || Takes a u64 title id, and returns the [[NCA#Meta_records|Meta Record]] with the highest version field for that title id.
|-
| 7 || [[#ListApplication]] ||
|-
| 8 || Has || Takes a [[NCA#Meta_records|Meta Record]] and returns whether that record is present in the database.
|-
| 9 || HasAll || Takes a type-5 buffer containing [[NCA#Meta_records|Meta Records]] (code assumes there are size/sizeof(meta_record) records in the buffer), and returns whether all of those records are present in the database.
|-
| 10 || GetSize || Takes a [[NCA#Meta_records|Meta Record]], and returns the size of the associated [[NCA#Content_records|Content Records]].
|-
| 11 || GetRequiredSystemVersion || Takes a [[NCA#Meta_records|Meta Record]], and returns u32 from ContentRecords + 16 (only if the Meta record has type Application or Patch).
|-
| 12 || GetPatchId || Takes a [[NCA#Meta_records|Meta Record]], and returns the update title id for that record.
|-
| 13 || DisableForcibly || Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.
|-
| 14 || [[#LookupOrphanContent]] || Takes a type-6 byte buffer, and a type-5 buffer of [[#NcaID]]s.
|-
| 15 || Commit || Flushes the in-memory database to savedata.
|-
| 16 || HasContent || Takes a [[NCA#Meta_records|Meta Record]] and an [[#NcaID]]. Returns whether the content records for that meta record contain the NcaID.
|-
| 17 || ListContentMetaInfo || Takes a type-6 [[NCA#Meta_records|Meta Record]] output buffer, a u32 eoffset into that buffer, and an input [[NCA#Meta_records|Meta Record]].
|-
| 18 || GetAttributes || Takes a [[NCA#Meta_records|Meta Record]], and returns u8 from ContentRecords + 6.
|-
| 19 || [2.0.0+] GetRequiredApplicationVersion || Does the same thing as GetEntryUnknownRecordSize, but for AddOnContents.
|-
| 20 || [5.0.0+] ||
|}

==== ListApplication ====
Each 24-byte entry (officially "ApplicationContentMetaKey") is as follows:
[[NCA#Meta_records|meta_record]] meta_record;
u64 base_title_id;

This function takes in a type 6 buffer to write entries to, and a u8 "filter" [[#Title_Types|type]]. 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 u32 num_entries_total, and a u32 num_entries_written.

==== ReadEntryMetaRecords ====
Takes a type-6 [[NCA#Meta_records|Meta Record]] output buffer, a u32 eoffset into that buffer, and an input [[NCA#Meta_records|Meta Record]] entry. Returns a u32 for total_read_entries.

Reads the meta records stored in the entry's content records into the output buffer.

This is used, for example, with System Update title 0100000000000816, which contains Meta Records for all other systitles in its Content Records.

==== LookupOrphanContent ====
Takes a type-6 byte buffer, and a type-5 buffer containing [[#NcaID]]s.

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 [[#NcaID]] in the input buffer, it checks if that NcaID 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, NcaID in NcaIDs:
if is_present_in_database(NcaID):
out_buf[i] = 0

=== NcaID ===
This is a 0x10-byte entry. This is originally from the hex portion of "<hex>.nca" directory-names from this storage FS(like [[SD_Filesystem|SD]]). This is also referred to as "ContentId" in the official SDK.

The NcaID is the same as the first 0x10-bytes from the calculated SHA256 hash, from hashing the entire output from ReadEntryRaw.

=== Enums ===
==== Title Types ====

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x01
| System Programs ([[Title_list#System_Modules|System Modules]] or [[Title_list#System_Applets|System Applets]])
|-
| 0x02
| [[Title_list#System_Data_Archives|System Data Archives]]
|-
| 0x03
| System Update
|-
| 0x04
| [[Title_list|Firmware package A]]
|-
| 0x05
| [[Title_list|Firmware package B]]
|-
| 0x80
| Regular application
|-
| 0x81
| Update title
|-
| 0x82
| Add-on content
|-
| 0x83
| Delta title
|}

== ncm:v ==
This service doesn't normally exist on retail.

[[Category:Services]]

Glue services

2018-07-12T03:06:20Z

Adubbz: Added info on the launch property format

= arp:r =
This is "nn::arp::detail::IReader".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetApplicationLaunchProperty
|-
| 1 || GetApplicationLaunchPropertyWithApplicationId
|-
| 2 || GetApplicationControlProperty
|-
| 3 || GetApplicationControlPropertyWithApplicationId
|}

== GetApplicationControlPropertyWithApplicationId ==

Takes in a title id and a type-0x16 buffer. This is filled with the contents of control.nacp for that application.

= arp:w =
This is "nn::arp::detail::IWriter".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || AcquireRegistrar
|-
| 1 || DeleteProperties
|}

== IRegistrar ==
This is "nn::arp::detail::IRegistrar".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Issue
|-
| 1 || SetApplicationLaunchProperty
|-
| 2 || SetApplicationControlProperty
|}

=== Launch Property Format ===

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| Title ID
|-
| 0x8
| 0x4
| Version
|-
| 0xC
| 0x1
| Base Game Storage ID
|-
| 0xD
| 0x1
| Update Storage ID
|-
| 0xE
| 0x2
| Padding
|}

[[Category:Services]]

2017-10-13T21:46:43Z

Adubbz: