Changes

Jump to navigation Jump to search

NCM services (view source)

Revision as of 18:45, 8 November 2023

9,628 bytes added ,  18:45, 8 November 2023
no edit summary
Line 1: Line 1:  
NCM contains services for internal file path and content management.
 
NCM contains services for internal file path and content management.
   −
= Location Resolver services =
+
= lr =
−
== lr ==
   
This is "nn::lr::ILocationResolverManager".
 
This is "nn::lr::ILocationResolverManager".
    
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
−
! Cmd || Name || Arguments || Notes
+
! Cmd || Name
 
|-
 
|-
−
| 0 || OpenLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
+
| 0 || [[#OpenLocationResolver|OpenLocationResolver]]
 
|-
 
|-
−
| 1 || OpenRegisteredLocationResolver || None ||
+
| 1 || [[#OpenRegisteredLocationResolver|OpenRegisteredLocationResolver]]
 
|-
 
|-
−
| 2 || RefreshLocationResolver || [[Filesystem_services#StorageId|StorageID]] ||
+
| 2 || [[#RefreshLocationResolver|RefreshLocationResolver]]
 
|-
 
|-
−
| 3 || [2.0.0+] OpenAddOnContentLocationResolver || None  ||
+
| 3 || [2.0.0+] [[#OpenAddOnContentLocationResolver|OpenAddOnContentLocationResolver]]
 +
|-
 +
| 4 || [15.0.0+] [[#SetEnabled|SetEnabled]]
 
|}
 
|}
    
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.
 
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 ===
+
== OpenLocationResolver ==
 +
Takes an input [[#StorageId]]. Returns an [[#ILocationResolver]].
 +
 
 +
== OpenRegisteredLocationResolver ==
 +
No input. Returns an [[#IRegisteredLocationResolver]].
 +
 
 +
== RefreshLocationResolver ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== OpenAddOnContentLocationResolver ==
 +
No input. Returns an [[#IAddOnContentLocationResolver]].
 +
 
 +
== SetEnabled ==
 +
Unofficial name.
 +
 
 +
Takes a type-0x5 input buffer containing an array of [[#StorageId]]. No output.
 +
 
 +
== ILocationResolver ==
 
This is "nn::lr::ILocationResolver".
 
This is "nn::lr::ILocationResolver".
   Line 27: Line 45:  
! Cmd || Name
 
! Cmd || Name
 
|-
 
|-
−
| 0 || [[#ResolveProgramPath]]
+
| 0 || [[#ResolveProgramPath|ResolveProgramPath]]
 
|-
 
|-
−
| 1 || [[#RedirectProgramPath]]
+
| 1 || [[#RedirectProgramPath|RedirectProgramPath]]
 
|-
 
|-
−
| 2 || [[#ResolveApplicationControlPath]]
+
| 2 || [[#ResolveApplicationControlPath|ResolveApplicationControlPath]]
 
|-
 
|-
−
| 3 || [[#ResolveApplicationHtmlDocumentPath]]
+
| 3 || [[#ResolveApplicationHtmlDocumentPath|ResolveApplicationHtmlDocumentPath]]
 
|-
 
|-
−
| 4 || [[#ResolveDataPath]]
+
| 4 || [[#ResolveDataPath|ResolveDataPath]]
 
|-
 
|-
−
| 5 || [[#RedirectApplicationControlPath]]
+
| 5 || [[#RedirectApplicationControlPath|RedirectApplicationControlPath]]
 
|-
 
|-
−
| 6 || [[#RedirectApplicationHtmlDocumentPath]]
+
| 6 || [[#RedirectApplicationHtmlDocumentPath|RedirectApplicationHtmlDocumentPath]]
 
|-
 
|-
−
| 7 || [[#ResolveApplicationLegalInformationPath]]
+
| 7 || [[#ResolveApplicationLegalInformationPath|ResolveApplicationLegalInformationPath]]
 
|-
 
|-
−
| 8 || [[#RedirectApplicationLegalInformationPath]]
+
| 8 || [[#RedirectApplicationLegalInformationPath|RedirectApplicationLegalInformationPath]]
 
|-
 
|-
−
| 9 || [[#Refresh]]
+
| 9 || [[#Refresh|Refresh]]
 
|-
 
|-
−
| 10 || [5.0.0+] [[#RedirectProgramPath2]]
+
| 10 || [5.0.0+] [[#RedirectApplicationProgramPath|RedirectApplicationProgramPath]]
 
|-
 
|-
−
| 11 || [5.0.0+] [[#Refresh2]]
+
| 11 || [5.0.0+] [[#ClearApplicationRedirection|ClearApplicationRedirection]]
 
|-
 
|-
−
| 12 || [5.0.0+] [[#DeleteProgramPath]]
+
| 12 || [5.0.0+] [[#EraseProgramRedirection|EraseProgramRedirection]]
 
|-
 
|-
−
| 13 || [5.0.0+] [[#DeleteApplicationControlPath]]
+
| 13 || [5.0.0+] [[#EraseApplicationControlRedirection|EraseApplicationControlRedirection]]
 
|-
 
|-
−
| 14 || [5.0.0+] [[#DeleteApplicationHtmlDocumentPath]]
+
| 14 || [5.0.0+] [[#EraseApplicationHtmlDocumentRedirection|EraseApplicationHtmlDocumentRedirection]]
 
|-
 
|-
−
| 15 || [5.0.0+] [[#DeleteApplicationLegalInformationPath]]
+
| 15 || [5.0.0+] [[#EraseApplicationLegalInformationRedirection|EraseApplicationLegalInformationRedirection]]
 
|-
 
|-
−
| 16 || [7.0.0+] [[#ResolveProgramPathForDebug]]
+
| 16 || [7.0.0+] [[#ResolveProgramPathForDebug|ResolveProgramPathForDebug]]
 
|-
 
|-
−
| 17 || [7.0.0+] [[#RedirectProgramPathForDebug]]
+
| 17 || [7.0.0+] [[#RedirectProgramPathForDebug|RedirectProgramPathForDebug]]
 
|-
 
|-
−
| 18 || [7.0.0+] [[#RedirectProgramPath2ForDebug]]
+
| 18 || [7.0.0+] [[#RedirectApplicationProgramPathForDebug|RedirectApplicationProgramPathForDebug]]
 
|-
 
|-
−
| 19 || [7.0.0+] [[#DeleteProgramPathForDebug]]
+
| 19 || [7.0.0+] [[#EraseProgramRedirectionForDebug|EraseProgramRedirectionForDebug]]
 +
|-
 +
| 20 || [15.0.0+] [[#Disable|Disable]]
 
|}
 
|}
   −
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.
+
If the supplied [[#StorageId]] is 1 (Host), a different set of internal functions is used to handle these commands. In this more restricted set of functions, [[#ResolveApplicationControlPath|ResolveApplicationControlPath]] 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 Get* commands load the [[#Path|Path]] from linked-lists' [[#LocationListEntry|entries]] in memory using the input [[#ProgramId]]. When the command fails to find an entry for the specified [[#ProgramId]], 0x408 is returned for [[#ResolveProgramPath|ResolveProgramPath]] and 0xA08 is returned for the rest.
    
The Set* commands always return 0 and add a new entry to the list. If a matching entry is found, it's removed first.
 
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 ====
+
=== ResolveProgramPath ===
−
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
+
Takes an input [[#ProgramId]] and a type-0x1A output buffer. No output.
   −
==== RedirectProgramPath ====
+
=== RedirectProgramPath ===
−
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
+
Takes an input [[#ProgramId]] and a type-0x19 input buffer containing a [[#Path|Path]]. No output.
   −
Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 0.
+
Inserts a new [[#LocationListEntry|entry]] with '''flag''' set to 0.
   −
==== ResolveApplicationControlPath ====
+
=== ResolveApplicationControlPath ===
−
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].
+
Takes an input [[#ApplicationId]] and a type-0x1A output buffer. No output.
   −
==== ResolveApplicationHtmlDocumentPath====
+
=== ResolveApplicationHtmlDocumentPath ===
−
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].
+
Takes an input [[#ApplicationId]] and a type-0x1A output buffer. No output.
   −
==== ResolveDataPath ====
+
=== ResolveDataPath ===
−
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].
+
Takes an input [[#DataId]] and a type-0x1A output buffer. No output.
   −
==== RedirectApplicationControlPath ====
+
=== RedirectApplicationControlPath ===
−
Takes an u64 '''TitleID''' and a X descriptor with a [[Filesystem_services#ContentPath|ContentPath]]. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].
+
Takes an input [[#ApplicationId]] and a type-0x19 input buffer containing a [[#Path|Path]]. No output.
   −
Inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.
+
[9.0.0+] Now takes an additional 8-bytes of input.
   −
==== RedirectApplicationHtmlDocumentPath ====
+
Inserts a new [[#LocationListEntry|entry]] with '''flag''' set to 1.
−
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.
+
=== RedirectApplicationHtmlDocumentPath ===
 +
Takes an input [[#ApplicationId]] and a type-0x19 input buffer containing a [[#Path|Path]]. No output.
   −
==== ResolveApplicationLegalInformationPath ====
+
[9.0.0+] Now takes an additional 8-bytes of input.
−
Takes an u64 '''TitleID''' and a C descriptor. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].
     −
==== RedirectApplicationLegalInformationPath ====
+
Inserts a new [[#LocationListEntry|entry]] with '''flag''' set to 1.
−
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.
+
=== ResolveApplicationLegalInformationPath ===
 +
Takes an input [[#ApplicationId]] and a type-0x1A output buffer. No output.
   −
==== Refresh ====
+
=== RedirectApplicationLegalInformationPath ===
−
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 0.
+
Takes an input [[#ApplicationId]] and a type-0x19 input buffer containing a [[#Path|Path]]. No output.
   −
==== RedirectProgramPath2 ====
+
[9.0.0+] Now takes an additional 8-bytes of input.
−
Same as [[#RedirectProgramPath|RedirectProgramPath]], but inserts a new [[#Location_List_Entry|entry]] with '''flag''' set to 1.
     −
==== Refresh2 ====
+
Inserts a new [[#LocationListEntry|entry]] with '''flag''' set to 1.
−
Takes no input. Frees all linked-lists' entries that have '''flag''' set to 1.
     −
==== DeleteProgramPath ====
+
=== Refresh ===
−
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
+
No input/output.
   −
Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.
+
Frees all linked-lists' entries that have '''flag''' set to 0.
   −
==== DeleteApplicationControlPath ====
+
=== RedirectApplicationProgramPath ===
−
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type3|NCA-type3]].
+
Same as [[#RedirectProgramPath|RedirectProgramPath]], but inserts a new [[#LocationListEntry|entry]] with '''flag''' set to 1.
   −
Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.
+
[9.0.0+] Now takes an additional 8-bytes of input.
   −
==== DeleteApplicationHtmlDocumentPath ====
+
=== ClearApplicationRedirection ===
−
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type4|NCA-type4]].
+
No input/output.
   −
Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.
+
Frees all linked-lists' entries that have '''flag''' set to 1.
   −
==== DeleteApplicationLegalInformationPath ====
+
[9.0.0+] Now takes a type-0x5 input buffer.
−
Takes an u64 '''TitleID'''. Used for [[NCA_Content_FS#NCA-type5|NCA-type5]].
     −
Removes the [[#Location_List_Entry|entry]] that matches the input TitleID.
+
=== EraseProgramRedirection ===
 +
Takes an input [[#ProgramId]]. No output.
 +
 
 +
Removes the [[#LocationListEntry|entry]] that matches the input [[#ProgramId]].
 +
 
 +
=== EraseApplicationControlRedirection ===
 +
Takes an input [[#ApplicationId]]. No output.
 +
 
 +
Removes the [[#LocationListEntry|entry]] that matches the input [[#ApplicationId]].
 +
 
 +
=== EraseApplicationHtmlDocumentRedirection ===
 +
Takes an input [[#ApplicationId]]. No output.
 +
 
 +
Removes the [[#LocationListEntry|entry]] that matches the input [[#ApplicationId]].
 +
 
 +
=== EraseApplicationLegalInformationRedirection ===
 +
Takes an input [[#ApplicationId]]. No output.
 +
 
 +
Removes the [[#LocationListEntry|entry]] that matches the input [[#ApplicationId]].
 +
 
 +
=== ResolveProgramPathForDebug ===
 +
Unofficial name.
   −
==== ResolveProgramPathForDebug ====
   
Same as [[#ResolveProgramPath|ResolveProgramPath]], but uses a redirection shim on top of the real program path.
 
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.
 
[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.
   −
==== RedirectProgramPathForDebug ====
+
=== RedirectProgramPathForDebug ===
 +
Unofficial name.
 +
 
 
Same as [[#RedirectProgramPath|RedirectProgramPath]], but uses a redirection shim on top of the real program path.
 
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.
 
[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.
   −
==== RedirectProgramPath2ForDebug ====
+
=== RedirectApplicationProgramPathForDebug ===
−
Same as [[#RedirectProgramPath2|RedirectProgramPath2]], but uses a redirection shim on top of the real program path.
+
Unofficial name.
 +
 
 +
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.
 
[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.
   −
==== DeleteProgramPathForDebug ====
+
=== EraseProgramRedirectionForDebug ===
−
Same as [[#DeleteProgramPath|DeleteProgramPath]], but uses a redirection shim on top of the real program path.
+
Unofficial name.
 +
 
 +
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.
 
[[NS_Services|NS]] uses this command if [[System_Settings#ns.application|ns.application!redirected_rom_storage_id_for_debug]] is different than 0x00.
   −
=== IRegisteredLocationResolver ===
+
=== Disable ===
 +
Unofficial name.
 +
 
 +
No input/output.
 +
 
 +
== IRegisteredLocationResolver ==
 
This is "nn::lr::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"
 
{| class="wikitable" border="1"
 
|-
 
|-
−
! Cmd || Name || Arguments || Notes
+
! Cmd || Name
 +
|-
 +
| 0 || [[#ResolveProgramPath_2|ResolveProgramPath]]
 
|-
 
|-
−
| 0 || ResolveProgramPath || u64 TitleID + C descriptor || Used for [[NCA_Content_FS#NCA-type1|NCA-type1]].
+
| 1 || [[#RegisterProgramPath|RegisterProgramPath]]
 
|-
 
|-
−
| 1 || RegisterProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] || Sets the Type 0 fallback TID and path to the provided arguments.
+
| 2 || [[#UnregisterProgramPath|UnregisterProgramPath]]
 
|-
 
|-
−
| 2 || UnregisterProgramPath || u64 TitleID || If the Type 0 fallback TID is == argument TID, unregisters the fallback path. Otherwise, noop.
+
| 3 || [[#RedirectProgramPath_2|RedirectProgramPath]]
 
|-
 
|-
−
| 3 || RedirectProgramPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
+
| 4 || [2.0.0+] [[#ResolveHtmlDocumentPath|ResolveHtmlDocumentPath]]
 
|-
 
|-
−
| 4 || [2.0.0+] ResolveHtmlDocumentPath || u64 TitleID + C descriptor ||
+
| 5 || [2.0.0+] [[#RegisterHtmlDocumentPath|RegisterHtmlDocumentPath]]
 
|-
 
|-
−
| 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|UnregisterHtmlDocumentPath]]
 
|-
 
|-
−
| 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|RedirectHtmlDocumentPath]]
 
|-
 
|-
−
| 7 || [2.0.0+] RedirectHtmlDocumentPath || u64 TitleID + X descriptor [[Filesystem_services#ContentPath|ContentPath]] ||
+
| 8 || [7.0.0+] [[#Refresh_2|Refresh]]
 
|-
 
|-
−
| 8 || [7.0.0+] Refresh || No input/output. ||  
+
| 9 || [9.0.0+] [[#RefreshExcluding|RefreshExcluding]]
 
|}
 
|}
   −
=== IAddOnContentLocationResolver ===
+
This works like [[#ILocationResolver]], but only two types of NCA paths can be gotten/set. In addition, each type has a fallback path that can be set for a single [[#ProgramId]] at a time.
 +
 
 +
=== ResolveProgramPath ===
 +
Takes an input [[#ProgramId]] and a type-0x1A output buffer. No output.
 +
 
 +
=== RegisterProgramPath ===
 +
Takes an input [[#ProgramId]] and a type-0x19 input buffer containing a [[#Path|Path]]. No output.
 +
 
 +
[9.0.0+] Now takes an additional 8-bytes of input.
 +
 
 +
=== UnregisterProgramPath ===
 +
Takes an input [[#ProgramId]]. No output.
 +
 
 +
=== RedirectProgramPath ===
 +
Takes an input [[#ProgramId]] and a type-0x19 input buffer containing a [[#Path|Path]]. No output.
 +
 
 +
[9.0.0+] Now takes an additional 8-bytes of input.
 +
 
 +
=== ResolveHtmlDocumentPath ===
 +
Takes an input [[#ApplicationId]] and a type-0x1A output buffer. No output.
 +
 
 +
=== RegisterHtmlDocumentPath ===
 +
Takes an input [[#ApplicationId]] and a type-0x19 input buffer containing a [[#Path|Path]]. No output.
 +
 
 +
[9.0.0+] Now takes an additional 8-bytes of input.
 +
 
 +
=== UnregisterHtmlDocumentPath ===
 +
Takes an input [[#ApplicationId]]. No output.
 +
 
 +
=== RedirectHtmlDocumentPath ===
 +
Takes an input [[#ApplicationId]] and a type-0x19 input buffer containing a [[#Path|Path]]. No output.
 +
 
 +
[9.0.0+] Now takes an additional 8-bytes of input.
 +
 
 +
=== Refresh ===
 +
No input/output.
 +
 
 +
=== RefreshExcluding ===
 +
Unofficial name.
 +
 
 +
Takes a type-0x5 input buffer containing an array of [[#ProgramId]]. No output.
 +
 
 +
== IAddOnContentLocationResolver ==
 
This is "nn::lr::IAddOnContentLocationResolver".
 
This is "nn::lr::IAddOnContentLocationResolver".
    
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
−
! Cmd || Name || Arguments || Notes
+
! Cmd || Name
 
|-
 
|-
−
| 0 || ResolveAddOnContentPath || u64 TitleID + C descriptor ||
+
| 0 || [[#ResolveAddOnContentPath|ResolveAddOnContentPath]]
 
|-
 
|-
−
| 1 || RegisterAddOnContentStorage || [[Filesystem_services#StorageId|StorageID]] + u64 TitleID ||
+
| 1 || [[#RegisterAddOnContentStorage|RegisterAddOnContentStorage]]
 
|-
 
|-
−
| 2 || UnregisterAllAddOnContentPath || None || Clears all registered titles here.
+
| 2 || [[#UnregisterAllAddOnContentPath|UnregisterAllAddOnContentPath]]
−
|}
  −
 
  −
=== Location List Entry ===
  −
Total size is 0x320 bytes.
  −
 
  −
{| class="wikitable" border="1"
   
|-
 
|-
−
! Offset || Size || Description
+
| 3 || [9.0.0+] [[#RefreshApplicationAddOnContent|RefreshApplicationAddOnContent]]
 
|-
 
|-
−
| 0x0 || 0x8|| Pointer to previous entry
+
| 4 || [9.0.0+] [[#UnregisterApplicationAddOnContent|UnregisterApplicationAddOnContent]]
 
|-
 
|-
−
| 0x8 || 0x8|| Pointer to next entry
+
| 5 || [15.0.0+] [[#GetRegisteredAddOnContentPaths|GetRegisteredAddOnContentPaths]]
 
|-
 
|-
−
| 0x10 || 0x8|| TitleID
+
| 6 || [15.0.0+] [[#RegisterAddOnContentPath|RegisterAddOnContentPath]]
 
|-
 
|-
−
| 0x18 || 0x300 || [[Filesystem_services|ContentPath]]
+
| 7 || [15.0.0+] [[#RegisterAddOnContentPaths|RegisterAddOnContentPaths]]
−
|-
  −
| 0x318 || 0x4 || Flag
  −
|-
  −
| 0x31C || 0x4 || Padding
   
|}
 
|}
   −
= Content Manager services =
+
=== ResolveAddOnContentPath ===
−
== ncm ==
+
Takes an input [[#DataId]] and a type-0x1A output buffer. No output.
 +
 
 +
=== RegisterAddOnContentStorage ===
 +
Takes an input [[#StorageId]] and an input [[#DataId]]. No output.
 +
 
 +
[9.0.0+] Now takes an additional input [[#ApplicationId]] for the owner application.
 +
 
 +
=== UnregisterAllAddOnContentPath ===
 +
No input/output.
 +
 
 +
=== RefreshApplicationAddOnContent ===
 +
Unofficial name.
 +
 
 +
Takes a type-0x5 input buffer containing an array of [[#ApplicationId]]. No output.
 +
 
 +
Unregisters entries with IDs absent from the input buffer.
 +
 
 +
=== UnregisterApplicationAddOnContent ===
 +
Unofficial name.
 +
 
 +
Takes an input [[#ApplicationId]]. No output.
 +
 
 +
Unregisters add on content entries for the input [[#ApplicationId]].
 +
 
 +
=== GetRegisteredAddOnContentPaths ===
 +
Unofficial name.
 +
 
 +
Takes an input [[#DataId]] and two type-0x16 output buffers. No output.
 +
 
 +
=== RegisterAddOnContentPath ===
 +
Unofficial name.
 +
 
 +
Takes an input [[#DataId]], an input [[#ApplicationId]] and a type-0x15 input buffer. No output.
 +
 
 +
=== RegisterAddOnContentPaths ===
 +
Unofficial name.
 +
 
 +
Takes an input [[#DataId]], an input [[#ApplicationId]] and two type-0x15 input buffers. No output.
 +
 
 +
= ncm =
 
This is "nn::ncm::IContentManager".
 
This is "nn::ncm::IContentManager".
    
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
−
! Cmd || Name || Notes
+
! Cmd || Name
 +
|-
 +
| 0 || [[#CreateContentStorage|CreateContentStorage]]
 
|-
 
|-
−
| 0 || CreateContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
+
| 1 || [[#CreateContentMetaDatabase|CreateContentMetaDatabase]]
 
|-
 
|-
−
| 1 || CreateContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
+
| 2 || [[#VerifyContentStorage|VerifyContentStorage]]
 
|-
 
|-
−
| 2 || VerifyContentStorage || Takes a [[Filesystem_services#StorageId|StorageID]].
+
| 3 || [[#VerifyContentMetaDatabase|VerifyContentMetaDatabase]]
 
|-
 
|-
−
| 3 || VerifyContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]].
+
| 4 || [[#OpenContentStorage|OpenContentStorage]]
 
|-
 
|-
−
| 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|OpenContentMetaDatabase]]
 
|-
 
|-
−
| 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|CloseContentStorageForcibly]]
 
|-
 
|-
−
| 6 || [1.0.0] CloseContentStorageForcibly || Takes a [[Filesystem_services#StorageId|StorageID]]. Calls IContentStorage->CloseAndFlushStorage().
+
| 7 || [1.0.0] [[#CloseContentMetaDatabaseForcibly|CloseContentMetaDatabaseForcibly]]
 
|-
 
|-
−
| 7 || [1.0.0] CloseContentMetaDatabaseForcibly || Takes a [[Filesystem_services#StorageId|StorageID]].  Calls IContentMetaDatabase->CloseMetaDatabase().
+
| 8 || [[#CleanupContentMetaDatabase|CleanupContentMetaDatabase]]
 
|-
 
|-
−
| 8 || CleanupContentMetaDatabase || Takes a [[Filesystem_services#StorageId|StorageID]], and deletes the associated savedata.
+
| 9 || [2.0.0+] [[#ActivateContentStorage|ActivateContentStorage]]
 
|-
 
|-
−
| 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|InactivateContentStorage]]
 
|-
 
|-
−
| 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|ActivateContentMetaDatabase]]
 
|-
 
|-
−
| 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|InactivateContentMetaDatabase]]
 
|-
 
|-
−
| 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|InvalidateRightsIdCache]]
 +
|-
 +
| 14 || [10.0.0+] [[#GetMemoryReport|GetMemoryReport]]
 +
|-
 +
| 15 || [16.0.0+] [[#ActivateFsContentStorage|ActivateFsContentStorage]]
 
|}
 
|}
   −
=== IContentStorage ===
+
== CreateContentStorage ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== CreateContentMetaDatabase ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== VerifyContentStorage ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== VerifyContentMetaDatabase ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== OpenContentStorage ==
 +
Takes an input [[#StorageId]]. Returns an [[#IContentStorage]].
 +
 
 +
[2.0.0+] Only returns a storage if one has previously been opened globally via [[#CreateContentStorage|CreateContentStorage]].
 +
 
 +
== OpenContentMetaDatabase ==
 +
Takes an input [[#StorageId]]. Returns an [[#IContentMetaDatabase]].
 +
 
 +
[2.0.0+] Only returns a storage if one has previously been opened globally via [[#CreateContentStorage|CreateContentStorage]].
 +
 
 +
== CloseContentStorageForcibly ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== CloseContentMetaDatabaseForcibly ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== CleanupContentMetaDatabase ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== ActivateContentStorage ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== InactivateContentStorage ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== ActivateContentMetaDatabase ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== InactivateContentMetaDatabase ==
 +
Takes an input [[#StorageId]]. No output.
 +
 
 +
== InvalidateRightsIdCache ==
 +
No input/output.
 +
 
 +
== GetMemoryReport ==
 +
No input. Returns an output [[#MemoryReport]].
 +
 
 +
== ActivateFsContentStorage ==
 +
Takes an input [[Filesystem_services#ContentStorageId|ContentStorageId]]. No output.
 +
 
 +
== IContentStorage ==
 
This is "nn::ncm::IContentStorage".
 
This is "nn::ncm::IContentStorage".
    
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
−
! Cmd || Name || Notes
+
! Cmd || Name
 
|-
 
|-
−
| 0 || [[#GeneratePlaceHolderId]] || Returns a random UUID for the Content Storage.
+
| 0 || [[#GeneratePlaceHolderId|GeneratePlaceHolderId]]
 
|-
 
|-
−
| 1 || CreatePlaceHolder || Takes two [[#NcaID]]s, and a u64 filesize.
+
| 1 || [[#CreatePlaceHolder|CreatePlaceHolder]]
 
|-
 
|-
−
| 2 || DeletePlaceHolder || Takes a [[#NcaID]].
+
| 2 || [[#DeletePlaceHolder|DeletePlaceHolder]]
 
|-
 
|-
−
| 3 || HasPlaceHolder ||  Takes a [[#NcaID]].
+
| 3 || [[#HasPlaceHolder|HasPlaceHolder]]
 
|-
 
|-
−
| 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.
+
| 4 || [[#WritePlaceHolder|WritePlaceHolder]]
 
|-
 
|-
−
| 5 || Register || Takes two [[#NcaID]]s, moves the Placeholder NCA content to the registered NCA path.
+
| 5 || [[#Register|Register]]
 
|-
 
|-
−
| 6 || Delete || Takes a [[#NcaID]].
+
| 6 || [[#Delete|Delete]]
 
|-
 
|-
−
| 7 || Has || Takes a [[#NcaID]].
+
| 7 || [[#Has|Has]]
 
|-
 
|-
−
| 8 || GetPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
+
| 8 || [[#GetPath|GetPath]]
 
|-
 
|-
−
| 9 || GetPlaceHolderPath || Takes a [[#NcaID]]. Returns a [[Filesystem_services#ContentPath|Content Path]].
+
| 9 || [[#GetPlaceHolderPath|GetPlaceHolderPath]]
 
|-
 
|-
−
| 10 || CleanupAllPlaceHolder || Deletes and re-creates the Placeholder directory.
+
| 10 || [[#CleanupAllPlaceHolder|CleanupAllPlaceHolder]]
 
|-
 
|-
−
| 11 || ListPlaceHolder || This is like [[#GetNumberOfRegisteredEntries]], but for the Placeholder directory.
+
| 11 || [[#ListPlaceHolder|ListPlaceHolder]]
 
|-
 
|-
−
| 12 || [[#GetContentCount]] ||
+
| 12 || [[#GetContentCount|GetContentCount]]
 
|-
 
|-
−
| 13 || [[#ListContentId]] ||
+
| 13 || [[#ListContentId|ListContentId]]
 
|-
 
|-
−
| 14 || [[#GetSizeFromContentId]] ||
+
| 14 || [[#GetSizeFromContentId|GetSizeFromContentId]]
 
|-
 
|-
−
| 15 || DisableForcibly || Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.
+
| 15 || [[#DisableForcibly|DisableForcibly]]
 
|-
 
|-
−
| 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.
+
| 16 || [2.0.0+] [[#RevertToPlaceHolder|RevertToPlaceHolder]]
 
|-
 
|-
−
| 17 || [2.0.0+] SetPlaceHolderSize || Takes a [[#NcaID]], and a u64 size
+
| 17 || [2.0.0+] [[#SetPlaceHolderSize|SetPlaceHolderSize]]
 
|-
 
|-
−
| 18 || [2.0.0+] [[#ReadContentIdFile]] ||
+
| 18 || [2.0.0+] [[#ReadContentIdFile|ReadContentIdFile]]
 
|-
 
|-
−
| 19 || [2.0.0+] [[#GetRightsIdFromPlaceHolderId]] ||
+
| 19 || [2.0.0+] [[#GetRightsIdFromPlaceHolderId|GetRightsIdFromPlaceHolderId]]
 
|-
 
|-
−
| 20 || [2.0.0+] [[#GetRightsIdFromContentId]] ||
+
| 20 || [2.0.0+] [[#GetRightsIdFromContentId|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.
+
| 21 || [2.0.0+] [[#WriteContentForDebug|WriteContentForDebug]]
 
|-
 
|-
−
| 22 || [2.0.0+] GetFreeSpaceSize || Gets free space for the storage.
+
| 22 || [2.0.0+] GetFreeSpaceSize
 
|-
 
|-
−
| 23 || [2.0.0+] GetTotalSpaceSize || Gets total space for the storage.
+
| 23 || [2.0.0+] GetTotalSpaceSize
 
|-
 
|-
−
| 24 || [3.0.0+] FlushPlaceHolder || Flushes resources for the storage without closing it.
+
| 24 || [3.0.0+] FlushPlaceHolder
 
|-
 
|-
−
| 25 || [4.0.0+] GetSizeFromPlaceHolderId ||
+
| 25 || [4.0.0+] GetSizeFromPlaceHolderId
 
|-
 
|-
−
| 26 || [4.0.0+] RepairInvalidFileAttribute ||
+
| 26 || [4.0.0+] RepairInvalidFileAttribute
 
|-
 
|-
−
| 27 || [8.0.0+] ||  
+
| 27 || [8.0.0+] GetRightsIdFromPlaceHolderIdWithCache
 +
|-
 +
| 28 || [13.0.0+] RegisterPath
 +
|-
 +
| 29 || [13.0.0+] ClearRegisteredPath
 +
|-
 +
| 30 || [17.0.0+] GetProgramId
 
|}
 
|}
   −
==== GeneratePlaceHolderId ====
+
=== GeneratePlaceHolderId ===
−
Generates a random [[#NcaID]] for use as a placeholder.
+
No input. Returns an output [[#PlaceHolderId]].
    
Calls nn::util::GenerateUuid(), which internally calls nn::os::GenerateRandomBytes(16);
 
Calls nn::util::GenerateUuid(), which internally calls nn::os::GenerateRandomBytes(16);
   −
==== GetContentCount ====
+
=== CreatePlaceHolder ===
−
Writes the total number of entries which can be read by GetEntries, to cmdreply <SFCO_offset>+0x10.
+
Takes an input [[#ContentId]], an input [[#PlaceHolderId]] and an input s64 '''FileSize'''. No output.
 +
 
 +
=== DeletePlaceHolder ===
 +
Takes an input [[#PlaceHolderId]]. No output.
 +
 
 +
=== HasPlaceHolder ===
 +
Takes an input [[#PlaceHolderId]]. Returns an output bool.
 +
 
 +
=== WritePlaceHolder ===
 +
Takes an input [[#PlaceHolderId]], an input u64 '''Offset''' and a type-0x5 input buffer. No output.
 +
 
 +
Writes the buffer to the file for the placeholder path at the specified offset.
 +
 
 +
=== Register ===
 +
Takes a [[#ContentId]] and a [[#PlaceHolderId]], no output. Moves the Placeholder NCA content to the registered NCA path.
 +
 
 +
=== Delete ===
 +
Takes a [[#ContentId]].
   −
==== ListContentId====
+
=== Has ===
−
Takes an output buffer, u32 offset and gets all entries starting at that offset.
+
Takes a [[#ContentId]].
−
Returns number of entries read.
     −
Each entry is a [[#NcaID]].
+
=== GetPath ===
 +
Takes a [[#ContentId]] and a type-0x1A output buffer containing a [[#Path|Path]].
 +
 
 +
=== GetPlaceHolderPath ===
 +
Takes a [[#PlaceHolderId]] and a type-0x1A output buffer containing a [[#Path|Path]].
 +
 
 +
=== CleanupAllPlaceHolder ===
 +
No input/output.
 +
 
 +
Deletes and re-creates the "Placeholder" directory.
 +
 
 +
=== ListPlaceHolder ===
 +
This is like [[#GetNumberOfRegisteredEntries|GetNumberOfRegisteredEntries]], but for the "Placeholder" directory.
 +
 
 +
=== GetContentCount ===
 +
No input. Returns an output u32 '''Count'''.
 +
 
 +
=== ListContentId ===
 +
Takes an output buffer, s32 offset and gets all entries starting at that offset. Returns number of entries read.
 +
 
 +
Each entry is a [[#ContentId]].
    
The total read entries is exactly the same as the number of "<hex>.nca" directories in the storage FS(or at least under the "registered" directory?).
 
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 ====
+
=== GetSizeFromContentId ===
−
Takes a [[#NcaID]] as input.
+
Takes a [[#ContentId]] as input.
   −
Returns the total size readable by [[#ReadContentIdFile]]. This is the same as the size-field in the [[NAX0]] "<NcaID>.nca/00" file.
+
Returns the total size readable by [[#ReadContentIdFile]]. This is the same as the size-field in the [[NAX0]] "<ContentId>.nca/00" file.
   −
==== ReadContentIdFile ====
+
=== DisableForcibly ===
−
Takes an output buffer, a [[#NcaID]] as input, and a u64 file offset.
+
No input/output.
   −
Reads plaintext NCA file contents from the Registered path for the NcaID.
+
Closes/Flushes all resources for the storage, and causes all future IPC commands to the current session to return error 0xC805.
   −
==== GetRightsIdFromPlaceHolderId ====
+
=== RevertToPlaceHolder ===
−
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.
+
Takes two [[#ContentId]] and a [[#PlaceHolderId]], no output.
   −
[3.0.0+] Returns an additional 8-bytes of output.
+
Creates the registered directory NCA path, and renames the placeholder path to the registered NCA path.
   −
Gets the Rights ID for the [[#NcaID]]'s placeholder path.
+
=== SetPlaceHolderSize ===
 +
Takes a [[#PlaceHolderId]], and a s64 size, no output.
   −
==== GetRightsIdFromContentId ====
+
=== ReadContentIdFile ===
−
Takes a total of 0x10-bytes of input, returns a total of 0x10-bytes of output.
+
Takes a type-0x6 output buffer, a [[#ContentId]] as input, and a s64 file offset.
   −
[3.0.0+] Returns an additional 8-bytes of output.
+
Reads plaintext NCA file contents from the "Registered" path for the ContentId.
   −
Gets the Rights ID for the [[#NcaID]]'s registered path
+
=== GetRightsIdFromPlaceHolderId ===
 +
Takes a [[#PlaceHolderId]], returns a [[#RightsId]].
   −
=== IContentMetaDatabase ===
+
Gets the Rights ID for the [[#PlaceHolderId]]'s placeholder path.
 +
 
 +
=== GetRightsIdFromContentId ===
 +
Takes a [[#ContentId]], returns a [[#RightsId]].
 +
 
 +
Gets the Rights ID for the [[#ContentId]]'s registered path
 +
 
 +
=== WriteContentForDebug ===
 +
Takes a [[#ContentId]], a u64 offset, and a type-0x5 input buffer.
 +
 
 +
On debug units, writes the buffer to the NCA's registered path. On retail units, this just aborts.
 +
 
 +
== IContentMetaDatabase ==
 
This is "nn::ncm::IContentMetaDatabase".
 
This is "nn::ncm::IContentMetaDatabase".
−
  −
Note the official name for Meta Record is "ContentMetaKey".
      
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
−
! Cmd || Name || Notes
+
! Cmd || Name
 +
|-
 +
| 0 || [[#Set|Set]]
 +
|-
 +
| 1 || [[#Get|Get]]
 +
|-
 +
| 2 || [[#Remove|Remove]]
 +
|-
 +
| 3 || [[#GetContentIdByType|GetContentIdByType]]
 
|-
 
|-
−
| 0 || Set || Takes a [[CNMT#Meta_records|Meta Record]], a type-5 [[CNMT#Content_records|Content Records]] buffer and a u64 size.
+
| 4 || [[#ListContentInfo|ListContentInfo]]
 
|-
 
|-
−
| 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.
+
| 5 || [[#List|List]]
 
|-
 
|-
−
| 2 || Remove || Takes a [[CNMT#Meta_records|Meta Record]], and removes the associated record.
+
| 6 || [[#GetLatestContentMetaKey|GetLatestContentMetaKey]]
 
|-
 
|-
−
| 3 || GetContentIdByType || Takes a [[CNMT#Meta_records|Meta Record]] and a u8 [[#Title_Types|Title Type]]. Returns a [[#NcaID]].
+
| 7 || [[#ListApplication|ListApplication]]
 
|-
 
|-
−
| 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.
+
| 8 || [[#Has|Has]]  
 
|-
 
|-
−
| 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.
+
| 9 || [[#HasAll|HasAll]]  
 
|-
 
|-
−
| 6 || GetLatestContentMetaKey || Takes a u64 title id, and returns the [[CNMT#Meta_records|Meta Record]] with the highest version field for that title id.
+
| 10 || [[#GetSize|GetSize]]  
 
|-
 
|-
−
| 7 || [[#ListApplication]] ||
+
| 11 || [[#GetRequiredSystemVersion|GetRequiredSystemVersion]]
 
|-
 
|-
−
| 8 || Has || Takes a [[CNMT#Meta_records|Meta Record]] and returns whether that record is present in the database.
+
| 12 || [[#GetPatchId|GetPatchId]]
 
|-
 
|-
−
| 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.
+
| 13 || [[#DisableForcibly|DisableForcibly]]
 
|-
 
|-
−
| 10 || GetSize || Takes a [[CNMT#Meta_records|Meta Record]], and returns the size of the associated [[CNMT#Content_records|Content Records]].
+
| 14 || [[#LookupOrphanContent|LookupOrphanContent]]
 
|-
 
|-
−
| 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).
+
| 15 || [[#Commit|Commit]]
 
|-
 
|-
−
| 12 || GetPatchId || Takes a [[CNMT#Meta_records|Meta Record]], and returns the update title id for that record.
+
| 16 || [[#HasContent|HasContent]]  
 
|-
 
|-
−
| 13 || DisableForcibly ||  Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.
+
| 17 || [[#ListContentMetaInfo|ListContentMetaInfo]]
 
|-
 
|-
−
| 14 || [[#LookupOrphanContent]] || Takes a type-6 byte buffer, and a type-5 buffer of [[#NcaID]]s.
+
| 18 || [[#GetAttributes|GetAttributes]]
 
|-
 
|-
−
| 15 || Commit || Flushes the in-memory database to savedata.
+
| 19 || [2.0.0+] [[#GetRequiredApplicationVersion|GetRequiredApplicationVersion]]
 
|-
 
|-
−
| 16 || HasContent || Takes a [[CNMT#Meta_records|Meta Record]] and an [[#NcaID]]. Returns whether the content records for that meta record contain the NcaID.
+
| 20 || [5.0.0+] [[#GetContentIdByTypeAndIdOffset|GetContentIdByTypeAndIdOffset]]  
 
|-
 
|-
−
| 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]].
+
| 21 || [10.0.0+] [[#GetCount|GetCount]]  
 
|-
 
|-
−
| 18 || GetAttributes || Takes a [[CNMT#Meta_records|Meta Record]], and returns u8 from ContentRecords + 6.
+
| 22 || [10.0.0+] [[#GetOwnerApplicationId|GetOwnerApplicationId]]  
 
|-
 
|-
−
| 19 || [2.0.0+] GetRequiredApplicationVersion || Does the same thing as GetEntryUnknownRecordSize, but for AddOnContents.
+
| 23 || [15.0.0+] GetContentAccessibilities
 
|-
 
|-
−
| 20 || [5.0.0+] GetContentIdByTypeAndIdOffset ||
+
| 24 || [15.0.0+] GetContentInfoByType
 +
|-
 +
| 25 || [15.0.0+] GetContentInfoByTypeAndIdOffset
 +
|-
 +
| 26 || [17.0.0+] GetPlatform
 
|}
 
|}
   −
==== ListApplication ====
+
=== Set ===
−
Each 24-byte entry (officially "ApplicationContentMetaKey") is as follows:
+
Takes a [[#ContentMetaKey]], a type-5 [[CNMT#PackagedContentInfo|PackagedContentInfo]] buffer and a u64 size.
−
  [[CNMT#Meta_records|meta_record]] meta_record;
+
 
−
  u64   base_title_id;
+
=== Get ===
 +
Takes a [[#ContentMetaKey]], a type-6 buffer to write [[CNMT#PackagedContentInfo|PackagedContentInfo]] to and a u64 size. Returns the actual number of bytes read into the buffer.
 +
 
 +
First 8 bytes of the data is header (u16 numExtraDataBytes, numContentRecords, numMetaRecords, padding). After the header is numExtraDataBytes of additional data, after which follow content records and content meta keys. Set takes this same data as input.
 +
 
 +
=== Remove ===
 +
Takes a [[#ContentMetaKey]], and removes the associated record.
 +
 
 +
=== GetContentIdByType ===
 +
Takes a [[#ContentMetaKey]] and a u8 [[#ContentType]]. Returns a [[#ContentId]].
 +
 
 +
=== ListContentInfo ===
 +
Takes a type-6 buffer to write [[CNMT#PackagedContentInfo|PackagedContentInfo]] entries to, a [[#ContentMetaKey]], and a s32 index into the entries to start copying from. Returns a s32 entries_read.
 +
 
 +
=== List ===
 +
Takes a type-6 buffer to write [[#ContentMetaKey]]s to, a u32 [[#ContentMetaType]], a [[#ProgramId]], a u64 ProgramId_Low, and u64 ProgramId_High. Returns s32 numEntriesTotal, numEntriesWritten.
 +
 
 +
Writes into the buffer all Content Meta Keys with low <= record->title_id <= high, and record->type == type. Additionally requires record->title_id == TID, if record->type is Application, Patch, Add-On, or Delta, otherwise, you can pass 0 for type to ignore the type and list them all in the range.
   −
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.
+
=== GetLatestContentMetaKey ===
 +
Takes a [[#ProgramId]], and returns the [[#ContentMetaKey]] with the highest version field for that [[#ProgramId]].
   −
This func returns a u32 num_entries_total, and a u32 num_entries_written.
+
=== ListApplication ===
 +
This function takes in a type 6 buffer to write [[#ApplicationContentMetaKey|ApplicationContentMetaKey]] entries to, and a u8 "filter". If filter is zero, all update records will be copied to to the output buffer (space permitting). Otherwise, only titles with type == filter_type will be copied to the output buffer.
   −
==== ReadEntryMetaRecords ====
+
This func returns a s32 num_entries_total, and a s32 num_entries_written.
−
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.
+
=== Has ===
 +
Takes a [[#ContentMetaKey]] and returns an output u8 bool indicating whether that record is present in the database.
   −
This is used, for example, with System Update title 0100000000000816, which contains Meta Records for all other systitles in its Content Records.
+
=== HasAll ===
 +
Takes a type-0x5 input buffer containing an array of [[#ContentMetaKey]], and returns whether all of those records are present in the database.
   −
==== LookupOrphanContent ====
+
=== GetSize ===
−
Takes a type-6 byte buffer, and a type-5 buffer containing [[#NcaID]]s.
+
Takes a [[#ContentMetaKey]], and returns the size of the associated [[CNMT#PackagedContentInfo|PackagedContentInfo]].
 +
 
 +
=== GetRequiredSystemVersion ===
 +
Takes an input [[#ContentMetaKey]]. Returns an output u32 '''RequiredSystemVersion'''.
 +
 
 +
=== GetPatchId ===
 +
Takes a [[#ContentMetaKey]], and returns the update [[#ProgramId]] for that record.
 +
 
 +
=== DisableForcibly ===
 +
Closes the meta database, and causes all future IPC commands to the current session to return error 0xDC05.
 +
 
 +
=== LookupOrphanContent ===
 +
Takes a type-6 byte buffer, and a type-0x5 buffer containing an array of [[#ContentId]].
    
This function was stubbed to return 0xDC05 in [[2.0.0]].
 
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.
+
On 1.0.0: Initialized the output buffer to all 1s. Then, for each [[#ContentId]] in the input buffer, it checks if that ContentId is present anywhere in the database, and if so writes 0 to the corresponding output byte.
    
In pseudocode, the function basically does the following:
 
In pseudocode, the function basically does the following:
   −
for i in range(len(out_buf)):
+
for i in range(len(out_buf)):
−
    out_buf[i] = 1
+
    out_buf[i] = 1
 +
 +
for i, ContentId in ContentId:
 +
    if is_present_in_database(ContentId):
 +
        out_buf[i] = 0
 +
 
 +
=== Commit ===
 +
Flushes the in-memory database to savedata.
 +
 
 +
=== HasContent ===
 +
Takes a [[#ContentMetaKey]] and an [[#ContentId]]. Returns whether the content records for that content meta key contain the [[#ContentId]].
 +
 
 +
=== ListContentMetaInfo ===
 +
Takes a type-6 [[#ContentMetaKey]] output buffer, a s32 offset into that buffer, and an input [[#ContentMetaKey]].
 +
 
 +
=== GetAttributes ===
 +
Takes an input [[#ContentMetaKey]]. Returns an output u8 '''Attributes'''.
 +
 
 +
=== GetRequiredApplicationVersion ===
 +
Does the same thing as [[#GetRequiredSystemVersion|GetRequiredSystemVersion]], but for AddOnContents.
 +
 
 +
=== GetContentIdByTypeAndIdOffset ===
 +
Takes a [[#ContentMetaKey]], a u8 [[#ContentType]] and a u8 id_offset. Returns a [[#ContentId]].
 +
 
 +
=== GetCount ===
 +
Returns a u32 count.
 +
 
 +
=== GetOwnerApplicationId ===
 +
Takes a [[#ContentMetaKey]]. Returns a [[#ApplicationId]].
 +
 
 +
= ncm:v =
 +
This is "nn::ncm::ISystemVersionManager".
 +
 
 +
This service doesn't exist on retail.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 0 || [[#GetSystemVersion|GetSystemVersion]]
 +
|}
 +
 
 +
== GetSystemVersion ==
 +
No input. Returns an output u32 '''SystemVersion'''.
 +
 
 +
= LocationListEntry =
 +
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|| [[#ProgramId]]
 +
|-
 +
| 0x18 || 0x300 || [[#Path|Path]]
 +
|-
 +
| 0x318 || 0x4 || Flag
 +
|-
 +
| 0x31C || 0x4 || Padding
 +
|}
 +
 
 +
= ContentId =
 +
This is "nn::ncm::ContentId".
 +
 
 +
This is a 0x10-byte entry. This is originally from the hex portion of "<hex>.nca" directory-names from this storage FS(like [[SD_Filesystem|SD]]).
 +
 
 +
The ContentId is the same as the first 0x10-bytes from the calculated SHA256 hash, from hashing the entire output from [[#ReadContentIdFile]].
 +
 
 +
= PlaceHolderId =
 +
This is "nn::ncm::PlaceHolderId".
 +
 
 +
This is the same as [[#ContentId]], except this is for placeholder content and originates from [[#GeneratePlaceHolderId]].
 +
 
 +
= ProgramId =
 +
This is "nn::ncm::ProgramId" or "nn::ncm::SystemProgramId".
 +
 
 +
This is an u64 ID bound to a [[Title_list#System_Modules|program]].
 +
 
 +
= DataId =
 +
This is "nn::ncm::DataId" or "nn::ncm::SystemDataId".
 +
 
 +
This is an u64 ID bound to a [[Title_list#System_Data_Archives|data archive]].
 +
 
 +
= ApplicationId =
 +
This is "nn::ncm::ApplicationId" or "nn::ncm::SystemApplicationId".
 +
 
 +
This is an u64 ID bound to an [[Title_list#System_Applications|application]].
 +
 
 +
Value 0 is invalid.
 +
 
 +
= PatchId =
 +
This is "nn::ncm::PatchId".
 +
 
 +
This is an u64 ID bound to a program patch.
 +
 
 +
= DeltaId =
 +
This is "nn::ncm::DeltaId".
 +
 
 +
This is an u64 ID bound to a program delta fragment.
 +
 
 +
= AddOnContentId =
 +
This is "nn::ncm::AddOnContentId".
   −
for i, NcaID in NcaIDs:
+
This is an u64 ID bound to add-on content data.
−
    if is_present_in_database(NcaID):
  −
        out_buf[i] = 0
     −
=== NcaID ===
+
= SystemUpdateId =
−
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.
+
This is "nn::ncm::SystemUpdateId".
   −
The NcaID is the same as the first 0x10-bytes from the calculated SHA256 hash, from hashing the entire output from [[#ReadContentIdFile]].
+
This is an u64 ID bound to system update data.
   −
=== Enums ===
+
= DataPatchId =
−
==== Title Types ====
+
This is "nn::ncm::DataPatchId".
 +
 
 +
This was added with [15.0.0+].
 +
 
 +
This is an u64 ID bound to a data patch.
 +
 
 +
= StorageId =
 +
This is "nn::ncm::StorageId".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Value || Name
 +
|-
 +
| 0 || None
 +
|-
 +
| 1 || Host
 +
|-
 +
| 2 || GameCard
 +
|-
 +
| 3 || BuiltInSystem
 +
|-
 +
| 4 || BuiltInUser
 +
|-
 +
| 5 || SdCard
 +
|-
 +
| 6 || Any
 +
|}
 +
 
 +
"None" and "Any" are meta storages.
 +
 
 +
nn::ncm::IsInstallableStorage returns true for BuiltInSystem, BuiltInUser, SdCard, and Any.
 +
 
 +
nn::ncm::IsUniqueStorage returns true for != None && != Any.
 +
 
 +
= RightsId =
 +
This is "nn::ncm::RightsId".
 +
 
 +
This is a 0x10-byte struct. [3.0.0+] This is a 0x18-byte struct.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset
 +
! Size
 +
! Description
 +
|-
 +
| 0x0 || 0x10 || FS Rights ID
 +
|-
 +
| 0x10 || 0x1 || [3.0.0+] KeyGeneration
 +
|-
 +
| 0x11 || 0x7 || [3.0.0+] Padding
 +
|}
 +
 
 +
= ProgramLocation =
 +
This is "nn::ncm::ProgramLocation".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset
 +
! Size
 +
! Description
 +
|-
 +
| 0x0 || 0x8 || [[#ProgramId]]
 +
|-
 +
| 0x8 || 0x1 || [[#StorageId]]
 +
|-
 +
| 0x9 || 0x7 || Padding
 +
|}
 +
 
 +
= Path =
 +
This is "nn::ncm::Path". This is a 0x300-byte string.
 +
 
 +
= ContentInstallType =
 +
This is "nn::ncm::ContentInstallType".
    
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
Line 455: Line 906:  
! Value
 
! Value
 
! Description
 
! Description
 +
|-
 +
| 0x0
 +
| Full
 +
|-
 +
| 0x1
 +
| FragmentOnly
 +
|-
 +
| 0x7
 +
| Invalid
 +
|}
 +
 +
= ContentMetaType =
 +
This is "nn::ncm::ContentMetaType".
 +
 +
{| class="wikitable" border="1"
 +
|-
 +
! Value
 +
! Description
 +
|-
 +
| 0x00
 +
| Invalid
 
|-
 
|-
 
| 0x01
 
| 0x01
Line 482: Line 954:  
| 0x83
 
| 0x83
 
| Delta
 
| Delta
 +
|-
 +
| 0x84
 +
| [15.0.0+] DataPatch
 
|}
 
|}
   −
== ncm:v ==
+
= ContentMetaPlatform =
−
This service doesn't normally exist on retail.
+
This is "nn::ncm::ContentMetaPlatform".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Value
 +
! Description
 +
|-
 +
| 0
 +
| Nx
 +
|}
 +
 
 +
= ContentType =
 +
This is "nn::ncm::ContentType".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Value
 +
! Description
 +
|-
 +
| 0
 +
| Meta
 +
|-
 +
| 1
 +
| Program
 +
|-
 +
| 2
 +
| Data
 +
|-
 +
| 3
 +
| Control
 +
|-
 +
| 4
 +
| HtmlDocument
 +
|-
 +
| 5
 +
| LegalInformation
 +
|-
 +
| 6
 +
| DeltaFragment
 +
|}
 +
 
 +
= ContentMetaKey =
 +
This is "nn::ncm::ContentMetaKey".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset
 +
! Size
 +
! Description
 +
|-
 +
| 0x0
 +
| 0x8
 +
| [[#ProgramId]]
 +
|-
 +
| 0x8
 +
| 0x4
 +
| Version
 +
|-
 +
| 0xC
 +
| 0x1
 +
| [[#ContentMetaType]]
 +
|-
 +
| 0xD
 +
| 0x1
 +
| [[#ContentInstallType]]
 +
|-
 +
| 0xE
 +
| 0x2
 +
| Padding
 +
|}
 +
 
 +
= ApplicationContentMetaKey =
 +
This is "nn::ncm::ApplicationContentMetaKey".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset
 +
! Size
 +
! Description
 +
|-
 +
| 0x0
 +
| 0x10
 +
| [[#ContentMetaKey|ContentMetaKey]]
 +
|-
 +
| 0x10
 +
| 0x8
 +
| [[#ApplicationId|ApplicationId]]
 +
|}
 +
 
 +
= MemoryReport =
 +
This is "nn::ncm::MemoryReport".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset
 +
! Size
 +
! Description
 +
|-
 +
| 0x0
 +
| 0x20
 +
| [[#MemoryResourceState|SystemContentMetaResourceState]]
 +
|-
 +
| 0x20
 +
| 0x20
 +
| [[#MemoryResourceState|SdAndUserContentMetaResourceState]]
 +
|-
 +
| 0x40
 +
| 0x20
 +
| [[#MemoryResourceState|GamecardContentMetaResourceState]]
 +
|-
 +
| 0x60
 +
| 0x20
 +
| [[#MemoryResourceState|HeapResourceState]]
 +
|}
 +
 
 +
== MemoryResourceState ==
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset
 +
! Size
 +
! Description
 +
|-
 +
| 0x0
 +
| 0x8
 +
| PeakTotalAllocSize
 +
|-
 +
| 0x8
 +
| 0x8
 +
| PeakAllocSize
 +
|-
 +
| 0x10
 +
| 0x8
 +
| AllocatableSize
 +
|-
 +
| 0x18
 +
| 0x8
 +
| TotalFreeSize
 +
|}
    
[[Category:Services]]
 
[[Category:Services]]
Retrieved from "https://switchbrew.org/wiki/Special:MobileDiff/6832...12580"

Navigation menu