https://switchbrew.org/w/api.php?action=feedcontributions&feedformat=atom&user=Liam
Nintendo Switch Brew - User contributions [en]
2026-04-17T19:11:56Z
User contributions
MediaWiki 1.43.1
https://switchbrew.org/w/index.php?title=Filesystem_services&diff=12621
Filesystem services
2023-12-11T23:22:55Z
<p>Liam: </p>
<hr />
<div>= fsp-ldr =<br />
This is "nn::fssrv::sf::IFileSystemProxyForLoader".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#OpenCodeFileSystem]]<br />
|-<br />
| 1 || [[#IsArchivedProgram]]<br />
|-<br />
| 2 || [4.0.0+] [[#SetCurrentProcess]]<br />
|}<br />
<br />
== OpenCodeFileSystem ==<br />
Takes a type-0x19 input buffer containing a [[#FspPath]] and an input [[NCM_services#ProgramId|ProgramId]]. Returns an [[#IFileSystem]].<br />
<br />
[10.0.0+] This now takes an additional type-0x1A output buffer.<br />
<br />
[16.0.0+] This now takes an additional input [[#ContentAttributes]].<br />
<br />
[17.0.0+] This now takes a type-0x6 output buffer instead of a type-0x1A output buffer.<br />
<br />
== IsArchivedProgram ==<br />
Takes an input u64 ProcessId. Returns a bool (1 if the process id's [[#FspPath]] ends in ".nca").<br />
<br />
== SetCurrentProcess ==<br />
Takes an input u64 ProcessId. No output.<br />
<br />
= fsp-pr =<br />
This is "nn::fssrv::sf::IProgramRegistry".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#RegisterProgram]]<br />
|-<br />
| 1 || [[#UnregisterProgram]]<br />
|-<br />
| 2 || [4.0.0+] [[#SetCurrentProcess]]<br />
|-<br />
| 256 || [1.0.0-9.2.0] [[#SetEnabledProgramVerification]]<br />
|}<br />
<br />
== RegisterProgram ==<br />
Takes a [[NCM_services#StorageId|StorageId]], an u64 ProcessId, a [[NCM_services#ProgramId|ProgramId]], 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]]<br />
<br />
Final FS permissions are stored as (ACI0_perms & ACID_perms). Will panic(svcBreak) when buffer sizes from ipc-rawdata are invalid.<br />
<br />
== UnregisterProgram ==<br />
Takes a pid. Removes registered FS permissions for that PID.<br />
<br />
== SetEnabledProgramVerification ==<br />
Seems to sets a global flag to inputval & 1.<br />
<br />
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.<br />
<br />
[10.0.0+] This was moved to [[Loader_services|Loader]].<br />
<br />
= fsp-srv =<br />
This is "nn::fssrv::sf::IFileSystemProxy".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [1.0.0] [[#OpenFileSystem]]<br />
|-<br />
| 1 || [[#SetCurrentProcess]]<br />
|-<br />
| 2 || OpenDataFileSystemByCurrentProcess<br />
|-<br />
| 7 || [2.0.0+] [[#OpenFileSystemWithPatch]]<br />
|-<br />
| 8 || [16.0.0+] [[#OpenFileSystemWithIdObsolete]] ([2.0.0-15.0.1] OpenFileSystemWithId)<br />
|-<br />
| 9 || [3.0.0+] OpenDataFileSystemByProgramId<br />
|-<br />
| 10 || [16.0.0+] [[#OpenFileSystemWithId]]<br />
|-<br />
| 11 || [[#OpenBisFileSystem]]<br />
|-<br />
| 12 || [[#OpenBisStorage]]<br />
|-<br />
| 13 || InvalidateBisCache<br />
|-<br />
| 17 || OpenHostFileSystem<br />
|-<br />
| 18 || OpenSdCardFileSystem<br />
|-<br />
| 19 || [2.0.0+] FormatSdCardFileSystem<br />
|-<br />
| 21 || [[#DeleteSaveDataFileSystem]]<br />
|-<br />
| 22 || [[#CreateSaveDataFileSystem]]<br />
|-<br />
| 23 || [[#CreateSaveDataFileSystemBySystemSaveDataId]]<br />
|-<br />
| 24 || RegisterSaveDataFileSystemAtomicDeletion<br />
|-<br />
| 25 || [2.0.0+] DeleteSaveDataFileSystemBySaveDataSpaceId<br />
|-<br />
| 26 || [2.0.0+] FormatSdCardDryRun<br />
|-<br />
| 27 || [2.0.0+] IsExFatSupported<br />
|-<br />
| 28 || [4.0.0+] DeleteSaveDataFileSystemBySaveDataAttribute<br />
|-<br />
| 30 || [[#OpenGameCardStorage]]<br />
|-<br />
| 31 || [[#OpenGameCardFileSystem]]<br />
|-<br />
| 32 || [3.0.0+] ExtendSaveDataFileSystem<br />
|-<br />
| 33 || [5.0.0+] DeleteCacheStorage<br />
|-<br />
| 34 || [5.0.0+] GetCacheStorageSize<br />
|-<br />
| 35 || [6.0.0+] [[#CreateSaveDataFileSystemWithHashSalt]]<br />
|-<br />
| 36 || [9.0.0+] OpenHostFileSystemWithOption<br />
|-<br />
| 37 || [14.0.0+] CreateSaveDataFileSystemWithCreationInfo2<br />
|-<br />
| 51 || [[#OpenSaveDataFileSystem]]<br />
|-<br />
| 52 || [[#OpenSaveDataFileSystemBySystemSaveDataId]]<br />
|-<br />
| 53 || [2.0.0+] [[#OpenReadOnlySaveDataFileSystem]]<br />
|-<br />
| 57 || [3.0.0+] [[#ReadSaveDataFileSystemExtraDataBySaveDataSpaceId]]<br />
|-<br />
| 58 || [[#ReadSaveDataFileSystemExtraData]]<br />
|-<br />
| 59 || [2.0.0+] WriteSaveDataFileSystemExtraData<br />
|-<br />
| 60 || [[#OpenSaveDataInfoReader]]<br />
|-<br />
| 61 || [[#OpenSaveDataInfoReaderBySaveDataSpaceId]]<br />
|-<br />
| 62 || [5.0.0+] OpenSaveDataInfoReaderOnlyCacheStorage<br />
|-<br />
| 64 || [5.0.0+] OpenSaveDataInternalStorageFileSystem<br />
|-<br />
| 65 || [5.0.0+] UpdateSaveDataMacForDebug<br />
|-<br />
| 66 || [5.0.0+] WriteSaveDataFileSystemExtraDataWithMask<br />
|-<br />
| 67 || [6.0.0+] [[#FindSaveDataWithFilter]]<br />
|-<br />
| 68 || [6.0.0+] [[#OpenSaveDataInfoReaderWithFilter]]<br />
|-<br />
| 69 || [8.0.0+] ReadSaveDataFileSystemExtraDataBySaveDataAttribute<br />
|-<br />
| 70 || [8.0.0+] WriteSaveDataFileSystemExtraDataWithMaskBySaveDataAttribute<br />
|-<br />
| 71 || [10.0.0+] ReadSaveDataFileSystemExtraDataWithMaskBySaveDataAttribute<br />
|-<br />
| 80 || OpenSaveDataMetaFile<br />
|-<br />
| 81 || [4.0.0+] [[#OpenSaveDataTransferManager]]<br />
|-<br />
| 82 || [5.0.0+] [[#OpenSaveDataTransferManagerVersion2]]<br />
|-<br />
| 83 || [6.0.0+] [[#OpenSaveDataTransferProhibiter]]<br />
|-<br />
| 84 || [6.0.0+] [[#ListAccessibleSaveDataOwnerId]]<br />
|-<br />
| 85 || [9.0.0+] [[#OpenSaveDataTransferManagerForSaveDataRepair]]<br />
|-<br />
| 86 || [10.0.0+] [[#OpenSaveDataMover]]<br />
|-<br />
| 87 || [11.0.0+] [[#OpenSaveDataTransferManagerForRepair]]<br />
|-<br />
| 100 || OpenImageDirectoryFileSystem<br />
|-<br />
| 101 || [11.0.0+] OpenBaseFileSystem<br />
|-<br />
| 102 || [12.0.0+] FormatBaseFileSystem<br />
|-<br />
| 110 || [[#OpenContentStorageFileSystem]]<br />
|-<br />
| 120 || [6.0.0-9.2.0] [[#OpenCloudBackupWorkStorageFileSystem]]<br />
|-<br />
| 130 || [7.0.0+] [[#OpenCustomStorageFileSystem]]<br />
|-<br />
| 200 || OpenDataStorageByCurrentProcess<br />
|-<br />
| 201 || [3.0.0+] OpenDataStorageByProgramId<br />
|-<br />
| 202 || [[#OpenDataStorageByDataId]]<br />
|-<br />
| 203 || OpenPatchDataStorageByCurrentProcess<br />
|-<br />
| 204 || [7.0.0+] [[#OpenDataFileSystemWithProgramIndex]]<br />
|-<br />
| 205 || [7.0.0+] [[#OpenDataStorageWithProgramIndex]]<br />
|-<br />
| 206 || [13.0.0+] OpenDataStorageByPath<br />
|-<br />
| 207 || [15.0.0+] OpenDataFileSystemByDataId<br />
|-<br />
| 400 || [[#OpenDeviceOperator]]<br />
|-<br />
| 500 || [[#OpenSdCardDetectionEventNotifier]]<br />
|-<br />
| 501 || [[#OpenGameCardDetectionEventNotifier]]<br />
|-<br />
| 510 || [5.0.0+] OpenSystemDataUpdateEventNotifier<br />
|-<br />
| 511 || [5.0.0+] NotifySystemDataUpdateEvent<br />
|-<br />
| 520 || [6.0.0+] [[#SimulateDeviceDetectionEvent]]<br />
|-<br />
| 600 || [1.0.0-3.0.2] SetCurrentPosixTime<br />
|-<br />
| 601 || QuerySaveDataTotalSize<br />
|-<br />
| 602 || [[#VerifySaveDataFileSystem]]<br />
|-<br />
| 603 || CorruptSaveDataFileSystem<br />
|-<br />
| 604 || CreatePaddingFile<br />
|-<br />
| 605 || DeleteAllPaddingFiles<br />
|-<br />
| 606 || [2.0.0+] GetRightsId<br />
|-<br />
| 607 || [2.0.0+] RegisterExternalKey<br />
|-<br />
| 608 || [2.0.0+] UnregisterAllExternalKey<br />
|-<br />
| 609 || [2.0.0-15.0.1] GetRightsIdByPath<br />
|-<br />
| 610 || [3.0.0+] GetRightsIdAndKeyGenerationByPath<br />
|-<br />
| 611 || [4.0.0+] SetCurrentPosixTimeWithTimeDifference<br />
|-<br />
| 612 || [4.0.0+] GetFreeSpaceSizeForSaveData<br />
|-<br />
| 613 || [4.0.0+] VerifySaveDataFileSystemBySaveDataSpaceId<br />
|-<br />
| 614 || [4.0.0+] CorruptSaveDataFileSystemBySaveDataSpaceId<br />
|-<br />
| 615 || [5.0.0+] QuerySaveDataInternalStorageTotalSize<br />
|-<br />
| 616 || [6.0.0+] [[#GetSaveDataCommitId]]<br />
|-<br />
| 617 || [7.0.0+] UnregisterExternalKey<br />
|-<br />
| 618 || [17.0.0+] GetProgramId<br />
|-<br />
| 620 || [2.0.0+] [[#SetSdCardEncryptionSeed]]<br />
|-<br />
| 630 || [4.0.0+] SetSdCardAccessibility<br />
|-<br />
| 631 || [4.0.0+] IsSdCardAccessible<br />
|-<br />
| 640 || [4.0.0-7.0.1] IsSignedSystemPartitionOnSdCardValid<br />
|-<br />
| 700 || [5.0.0+] [[#OpenAccessFailureDetectionEventNotifier]]<br />
|-<br />
| 701 || [5.0.0+] GetAccessFailureDetectionEvent<br />
|-<br />
| 702 || [5.0.0+] IsAccessFailureDetected<br />
|-<br />
| 710 || [5.0.0+] ResolveAccessFailure<br />
|-<br />
| 720 || [5.0.0+] AbandonAccessFailure<br />
|-<br />
| 800 || [2.0.0+] GetAndClearErrorInfo<br />
|-<br />
| 810 || [7.0.0+] RegisterProgramIndexMapInfo<br />
|-<br />
| 1000 || [1.0.0-9.2.0] SetBisRootForHost<br />
|-<br />
| 1001 || [[#SetSaveDataSize]]<br />
|-<br />
| 1002 || [[#SetSaveDataRootPath]]<br />
|-<br />
| 1003 || DisableAutoSaveDataCreation<br />
|-<br />
| 1004 || [[#SetGlobalAccessLogMode]]<br />
|-<br />
| 1005 || [[#GetGlobalAccessLogMode]]<br />
|-<br />
| 1006 || [[#OutputAccessLogToSdCard]]<br />
|-<br />
| 1007 || [4.0.0+] RegisterUpdatePartition<br />
|-<br />
| 1008 || [4.0.0+] OpenRegisteredUpdatePartition<br />
|-<br />
| 1009 || [4.0.0+] GetAndClearMemoryReportInfo<br />
|-<br />
| 1010 || [5.1.0-6.2.0] SetDataStorageRedirectTarget<br />
|-<br />
| 1011 || [7.0.0+] [[#GetProgramIndexForAccessLog]]<br />
|-<br />
| 1012 || [9.0.0+] GetFsStackUsage<br />
|-<br />
| 1013 || [9.0.0+] UnsetSaveDataRootPath<br />
|-<br />
| 1014 || [10.0.0-10.2.0] OutputMultiProgramTagAccessLog<br />
|-<br />
| 1016 || [11.0.0+] FlushAccessLogOnSdCard<br />
|-<br />
| 1017 || [11.0.0+] OutputApplicationInfoAccessLog<br />
|-<br />
| 1018 || [13.0.0+] SetDebugOption<br />
|-<br />
| 1019 || [13.0.0+] UnsetDebugOption<br />
|-<br />
| 1100 || [4.0.0+] OverrideSaveDataTransferTokenSignVerificationKey<br />
|-<br />
| 1110 || [6.0.0+] CorruptSaveDataFileSystemByOffset<br />
|-<br />
| 1200 || [6.0.0+] [[#OpenMultiCommitManager]]<br />
|-<br />
| 1300 || [10.0.0+] [[#OpenBisWiper]]<br />
|-<br />
| 1400 || [15.0.0+] NotifyErrorContextServiceReady<br />
|}<br />
<br />
== Permissions ==<br />
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]].<br />
<br />
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.<br />
<br />
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.<br />
<br />
If the code were to request an invalid input type, panic. But this never happens.<br />
<br />
The output values for [[#ReadWrite]] CanMountRegisteredUpdatePartition and [[#Call]] CanRegisterUpdatePartition are masked with the cached value of [[SMC#IsDebugMode|DebugMode]].<br />
<br />
=== ReadWrite ===<br />
{| class="wikitable" border="1"<br />
|-<br />
! AccessibilityType || Name || Mask || Permission || Used by<br />
|-<br />
| 0x0 || CanMountLogo || 0x8000000000000801 || R- || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]<br />
|-<br />
| 0x1 || CanMountContentMeta || 0x8000000000000801 || R- || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]<br />
|-<br />
| 0x2 || CanMountContentControl || 0x8000000000000801 || R- || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]<br />
|-<br />
| 0x3 || CanMountContentManual || 0x8000000000000801 || R- || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]<br />
|-<br />
| 0x4 || CanMountContentData || 0x8000000000000801 || R- || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]<br />
|-<br />
| 0x5 || CanMountApplicationPackage || 0x8000000000000801 || R- || [[#OpenFileSystem]], [[#OpenFileSystemWithPatch]], [[#OpenFileSystemWithId]]<br />
|-<br />
| 0x6 || CanMountSaveDataStorage || 0x8000000000000000 || RW ||<br />
|-<br />
| 0x7 || CanMountContentStorage || 0x8000000000000800 || RW || [[#OpenContentStorageFileSystem]]<br />
|-<br />
| 0x8 || CanMountImageAndVideoStorage ||0x8000000000001000 || RW || [[#OpenImageDirectoryFileSystem]]<br />
|-<br />
| 0x9 || CanMountCustomStorage0 || 0x8000000000000000 || RW || OpenCustomStorageFileSystem<br />
|-<br />
| 0xA || CanMountBisCalibrationFile || 0x8000000000000084 || RW || [[#OpenBisFileSystem]]<br />
|-<br />
| 0xB || CanMountBisSafeMode || 0x8000000000000080 || RW || [[#OpenBisFileSystem]]<br />
|-<br />
| 0xC || CanMountBisUser || 0x8000000000008080 || RW || [[#OpenBisFileSystem]]<br />
|-<br />
| 0xD || CanMountBisSystem || 0x8000000000008080 || RW || [[#OpenBisFileSystem]]<br />
|-<br />
| 0xE || CanMountBisSystemProperEncryption || 0x8000000000000080 || RW || [[#OpenBisFileSystem]]<br />
|-<br />
| 0xF || CanMountBisSystemProperPartition || 0x8000000000000080 || RW || [[#OpenBisFileSystem]]<br />
|-<br />
| 0x10 || CanMountSdCard || 0xC000000000200000 || RW || [[#OpenSdCardFileSystem]]<br />
|-<br />
| 0x11 || CanMountGameCard || 0x8000000000000010 || R- || [[#OpenGameCardFileSystem]]<br />
|-<br />
| 0x12 || CanMountDeviceSaveData || 0x8000000000040020 || RW || [[#OpenSaveDataFileSystem]]<br />
|-<br />
| 0x13 || CanMountSystemSaveData || 0x8000000000000028 || RW || [[#OpenSaveDataFileSystemBySystemSaveDataId]]<br />
|-<br />
| 0x14 || CanMountOthersSaveData || 0x8000000000000020 || RW || [[#OpenSaveDataFileSystem]]<br />
|-<br />
| 0x15 || CanMountOthersSystemSaveData || 0x8000000000000020 || RW || [[#OpenSaveDataFileSystemBySystemSaveDataId]]<br />
|-<br />
| 0x16 || CanOpenBisPartitionBootPartition1Root || 0x8000000000010082 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x17 || CanOpenBisPartitionBootPartition2Root || 0x8000000000010080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x18 || CanOpenBisPartitionUserDataRoot || 0x8000000000000080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x19 || CanOpenBisPartitionBootConfigAndPackage2Part1 || 0x8000000000010080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x1A || CanOpenBisPartitionBootConfigAndPackage2Part2 || 0x8000000000010080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x1B || CanOpenBisPartitionBootConfigAndPackage2Part3 || 0x8000000000010080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x1C || CanOpenBisPartitionBootConfigAndPackage2Part4 || 0x8000000000010080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x1D || CanOpenBisPartitionBootConfigAndPackage2Part5 || 0x8000000000010080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x1E || CanOpenBisPartitionBootConfigAndPackage2Part6 || 0x8000000000010080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x1F || CanOpenBisPartitionCalibrationBinary || 0x8000000000000084 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x20 || CanOpenBisPartitionCalibrationFile || 0x8000000000000084 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x21 || CanOpenBisPartitionSafeMode || 0x8000000000000080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x22 || CanOpenBisPartitionUser || 0x8000000000000080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x23 || CanOpenBisPartitionSystem || 0x8000000000000080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x24 || CanOpenBisPartitionSystemProperEncryption || 0x8000000000000080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x25 || CanOpenBisPartitionSystemProperPartition || 0x8000000000000080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| 0x26 || CanOpenBisPartitionDeviceTreeBlob || 0x8000002000000080 || RW || [[#OpenBisStorage]]<br />
|-<br />
| [3.0.0+] 0x27 || CanOpenSdCardStorage || 0xC000000000200000 || RW || <br />
|-<br />
| [3.0.0+] 0x28 || CanOpenGameCardStorage || 0x8000000000000100 || RW || [[#OpenGameCardStorage]], [[#EraseGameCard]] (bit1), [[#WriteToGameCard]] (bit1), [[#GetGameCardErrorInfo]] (bit1), [[#EraseAndWriteParamDirectly]] (bit1), [[#ReadParamDirectly]] (bit1), [[#ForceEraseGameCard]] (bit1)<br />
|-<br />
| [4.0.0+] 0x29 || CanMountSystemDataPrivate || 0x8000000000100008 || R- || [[#OpenFileSystem]], [[#OpenDataStorageByDataId]]<br />
|-<br />
| [5.0.0+] 0x2A || CanMountHost || 0xC000000000400000 || RW || [[#OpenHostFileSystem]]<br />
|-<br />
| [6.0.0+] 0x2B || CanMountRegisteredUpdatePartition || 0x8000000000010000 || R- || [[#OpenRegisteredUpdatePartition]]<br />
|-<br />
| [7.0.0+] 0x2C || CanOpenSaveDataInternalStorage || 0x8000000000000000 || RW || [[#OpenSaveDataInternalStorageFileSystem]]<br />
|-<br />
| [7.0.0+] 0x2D || CanMountTemporaryDirectory || 0xC000000000000000 || RW || <br />
|-<br />
| [11.0.0+] 0x2E || CanMountAllBaseFilesystem || 0x8000000000000000 || RW || OpenBaseFileSystem<br />
|-<br />
| [15.0.0+] 0x2F || CanNotMount || 0x0000000000000000 || -- || OpenCustomStorageFileSystem<br />
|}<br />
<br />
=== Call ===<br />
{| class="wikitable" border="1"<br />
|-<br />
! OperationType || Name || Mask || Used by<br />
|-<br />
| 0x0 || CanInvalidateBisCache || 0x8000000000000080 || [[#InvalidateBisCache]]<br />
|-<br />
| 0x1 || CanEraseMmc || 0x8000000000000080 || EraseMmc<br />
|-<br />
| 0x2 || CanGetGameCardDeviceCertificate || 0x8000000000000010 || GetGameCardDeviceCertificate<br />
|-<br />
| 0x3 || CanGetGameCardIdSet || 0x8000000000000010 || GetGameCardIdSet<br />
|-<br />
| 0x4 || CanFinalizeGameCardDriver || 0x8000000000000200 || FinalizeGameCardDriver<br />
|-<br />
| 0x5 || CanGetGameCardAsicInfo || 0x8000000000000200 || GetGameCardAsicInfo<br />
|-<br />
| 0x6 || CanGetGameCardAsicCertificate || 0x8000000000000200 || GetGameCardAsicCertificate<br />
|-<br />
| 0x7 || CanCreateSaveData || 0x8000000000002020 || [[#CreateSaveDataFileSystem]]<br />
|-<br />
| 0x8 || CanDeleteSaveData || 0x8000000000000060 || [[#DeleteSaveDataFileSystem]], RegisterSaveDataFileSystemAtomicDeletion<br />
|-<br />
| 0x9 || CanCreateSystemSaveData || 0x8000000000000028 || CreateSaveDataFileSystemBySystemSaveDataId<br />
|-<br />
| 0xA || CanCreateOthersSystemSaveData || 0x8000000000000020 || CreateSaveDataFileSystemBySystemSaveDataId<br />
|-<br />
| 0xB || CanDeleteSystemSaveData || 0x8000000000004028 || [[#DeleteSaveDataFileSystem]], RegisterSaveDataFileSystemAtomicDeletion<br />
|-<br />
| 0xC || CanOpenSaveDataInfoReader || 0x8000000000000060 || [[#OpenSaveDataInfoReaderBySaveDataSpaceId]], [[#OpenSaveDataInfoReader]]<br />
|-<br />
| 0xD || CanOpenSaveDataInfoReaderForSystem || 0x8000000000004020 || [[#OpenSaveDataInfoReaderBySaveDataSpaceId]], [[#OpenSaveDataInfoReader]]<br />
|-<br />
| 0xE || CanOpenSaveDataInfoReaderForInternal || 0x8000000000000040 || [[#OpenSaveDataInfoReaderWithFilter]]<br />
|-<br />
| 0xF || CanOpenSaveDataMetaFile || 0x8000000000020000 || OpenSaveDataMetaFile<br />
|-<br />
| 0x10 || CanSetCurrentPosixTime || 0x8000000000000400 || SetCurrentPosixTime, SetCurrentPosixTimeWithTimeDifference<br />
|-<br />
| 0x11 || CanReadSaveDataFileSystemExtraData || 0x8000000000004060 || [[#ReadSaveDataFileSystemExtraData]]<br />
|-<br />
| 0x12 || CanSetGlobalAccessLogMode || 0x8000000000080000 || [[#SetGlobalAccessLogMode]]<br />
|-<br />
| 0x13 || CanSetSpeedEmulationMode || 0x8000000000080000 || SetSpeedEmulationMode<br />
|-<br />
| 0x14 || CanDebug || 0xC000000000000000 || <br />
|-<br />
| 0x15 || CanFillBis || 0xC000000000800000 || CreatePaddingFile, DeleteAllPaddingFiles<br />
|-<br />
| [2.0.0+] 0x16 || CanCorruptSaveData || 0xC000000001000000 || CorruptSaveDataFileSystem, CorruptSaveDataFileSystemBySaveDataSpaceId<br />
|-<br />
| [2.0.0+] 0x17 || CanCorruptSystemSaveData || 0x8000000001000060 || CorruptSaveDataFileSystem, CorruptSaveDataFileSystemBySaveDataSpaceId<br />
|-<br />
| [2.0.0+] 0x18 || CanVerifySaveData || 0x8000000000000060 || [[#VerifySaveDataFileSystem]], VerifySaveDataFileSystemBySaveDataSpaceId<br />
|-<br />
| [2.0.0+] 0x19 || CanDebugSaveData || 0xC000000002000000 || [[#CreateSaveDataFileSystem]], [[#OpenSaveDataFileSystem]], [[#SetSaveDataRootPath]]<br />
|-<br />
| [2.0.0+] 0x1A || CanFormatSdCard || 0x8000000004000000 || FormatSdCardFileSystem<br />
|-<br />
| [3.0.0+] 0x1B || CanGetRightsId || 0x8000000008000000 || GetRightsId, GetRightsIdAndKeyGenerationByPath, GetRightsIdByPath<br />
|-<br />
| [3.0.0+] 0x1C || CanRegisterExternalKey || 0x8000000010000000 || RegisterExternalKey, UnregisterAllExternalKey<br />
|-<br />
| [4.0.0+] 0x1D || CanSetEncryptionSeed || 0x8000000000000800 || [[#SetSdCardEncryptionSeed]]<br />
|-<br />
| [4.0.0+] 0x1E || CanWriteSaveDataFileSystemExtraDataTimeStamp || 0x8000000000000020 || WriteSaveDataFileSystemExtraData, WriteSaveDataFileSystemExtraDataWithMask<br />
|-<br />
| [4.0.0+] 0x1F || CanWriteSaveDataFileSystemExtraDataFlags || 0x8000000000004020 || WriteSaveDataFileSystemExtraData, WriteSaveDataFileSystemExtraDataWithMask<br />
|-<br />
| [4.0.0+] 0x20 || CanWriteSaveDataFileSystemExtraDataCommitId || 0x8000000000000020 || WriteSaveDataFileSystemExtraData, WriteSaveDataFileSystemExtraDataWithMask<br />
|-<br />
| [5.0.0+] 0x21 || CanWriteSaveDataFileSystemExtraDataAll || 0x8000000000000000 || WriteSaveDataFileSystemExtraData, WriteSaveDataFileSystemExtraDataWithMask<br />
|-<br />
| [5.0.0+] 0x22 || CanExtendSaveData || 0x8000000000002020 || ExtendSaveDataFileSystem<br />
|-<br />
| [5.0.0+] 0x23 || CanExtendSystemSaveData || 0x8000000000000028 || ExtendSaveDataFileSystem<br />
|-<br />
| [5.0.0+] 0x24 || CanExtendOthersSystemSaveData || 0x8000000000000020 || ExtendSaveDataFileSystem<br />
|-<br />
| [5.0.0+] 0x25 || CanRegisterUpdatePartition || 0x8000000020000000 || RegisterUpdatePartition<br />
|-<br />
| [5.0.0+] 0x26 || CanOpenSaveDataTransferManager || 0x8000000040000000 || [[#OpenSaveDataTransferManager]]<br />
|-<br />
| [5.0.0+] 0x27 || CanOpenSaveDataTransferManagerVersion2 || 0x8000000200000000 || [[#OpenSaveDataTransferManagerVersion2]]<br />
|-<br />
| [5.0.0+] 0x28 || CanOpenSaveDataTransferManagerForSaveDataRepair || 0x8000000200000000 || OpenSaveDataTransferManagerForSaveDataRepair<br />
|-<br />
| [5.0.0+] 0x29 || CanOpenSaveDataTransferManagerForSaveDataRepairTool || 0x8000000000000000 || OpenSaveDataTransferManagerForSaveDataRepair<br />
|-<br />
| [5.0.0+] 0x2A || CanOpenOpenSaveDataTransferProhibiter || 0x8000000200002000 || [[#OpenSaveDataTransferProhibiter]]<br />
|-<br />
| [5.0.0+] 0x2B || CanOpenSaveDataMover || 0x8000001000000000 || [[#OpenSaveDataMover]]<br />
|-<br />
| [5.0.0+] 0x2C || CanOpenBisWiper || 0x8000000000000800 || [[#OpenBisWiper]]<br />
|-<br />
| [5.0.0+] 0x2D || CanListAccessibleSaveDataOwnerId || 0x8000000240002000 || [[#ListAccessibleSaveDataOwnerId]]<br />
|-<br />
| [5.0.0+] 0x2E || CanControlMmcPatrol || 0x8000000000000000 || SuspendMmcPatrol, ResumeMmcPatrol<br />
|-<br />
| [5.0.0+] 0x2F || CanOverrideSaveDataTransferTokenSignVerificationKey || 0x8000000000000000 || OverrideSaveDataTransferTokenSignVerificationKey<br />
|-<br />
| [5.1.0+] 0x30 || CanOpenSdCardDetectionEventNotifier || 0x8000000080200000 || [[#OpenSdCardDetectionEventNotifier]]<br />
|-<br />
| [6.0.0+] 0x31 || CanOpenGameCardDetectionEventNotifier || 0x8000000080000110 || [[#OpenGameCardDetectionEventNotifier]]<br />
|-<br />
| [6.0.0+] 0x32 || CanOpenSystemDataUpdateEventNotifier || 0x8000000000100008 || OpenSystemDataUpdateEventNotifier<br />
|-<br />
| [6.0.0+] 0x33 || CanNotifySystemDataUpdateEvent || 0x8000000000010000 || NotifySystemDataUpdateEvent<br />
|-<br />
| [6.0.0+] 0x34 || CanOpenAccessFailureDetectionEventNotifier || 0x8000000100000000 || [[#OpenAccessFailureDetectionEventNotifier]]<br />
|-<br />
| [6.0.0+] 0x35 || CanGetAccessFailureDetectionEvent || 0x8000000100000000 || GetAccessFailureDetectionEvent<br />
|-<br />
| [6.0.0+] 0x36 || CanIsAccessFailureDetected || 0x8000000100000000 || IsAccessFailureDetected<br />
|-<br />
| [6.0.0+] 0x37 || CanResolveAccessFailure || 0x8000000100000000 || ResolveAccessFailure<br />
|-<br />
| [6.0.0+] 0x38 || CanAbandonAccessFailure || 0x8000000100000000 || AbandonAccessFailure<br />
|-<br />
| [8.0.0+] 0x39 || CanQuerySaveDataInternalStorageTotalSize || 0x8000000040000000 || QuerySaveDataInternalStorageTotalSize<br />
|-<br />
| [9.0.0+] 0x3A || CanGetSaveDataCommitId || 0x8000000200000020 || [[#GetSaveDataCommitId]]<br />
|-<br />
| [9.0.0+] 0x3B || CanSetSdCardAccessibility || 0x8000000000200000 || SetSdCardAccessibility<br />
|-<br />
| [9.0.0+] 0x3C || CanSimulateDevice || 0x4000000000000000 || SimulateDeviceDetectionEvent, SetSimulationEvent, ClearSimulationEvent<br />
|-<br />
| [9.0.0+] 0x3D || CanCreateSaveDataWithHashSalt || 0x8000000000000000 || [[#CreateSaveDataFileSystem]], [[#CreateSaveDataFileSystemWithHashSalt]]<br />
|-<br />
| [9.0.0+] 0x3E || CanRegisterProgramIndexMapInfo || 0x8000000400000000 || RegisterProgramIndexMapInfo<br />
|-<br />
| [9.0.0+] 0x3F || CanChallengeCardExistence || 0x8000000000000010 || ChallengeCardExistence<br />
|-<br />
| [9.0.0+] 0x40 || CanCreateOwnSaveData || 0x8000000800000000 || [[#CreateSaveDataFileSystem]], CreateSaveDataFileSystemWithHashSalt<br />
|-<br />
| [9.0.0+] 0x41 || CanDeleteOwnSaveData || 0x8000000800000000 || [[#DeleteSaveDataFileSystem]]<br />
|-<br />
| [10.0.0+] 0x42 || CanReadOwnSaveDataFileSystemExtraData || 0x8000000800000000 || [[#ReadSaveDataFileSystemExtraData]]<br />
|-<br />
| [10.0.0+] 0x43 || CanExtendOwnSaveData || 0x8000000800000000 || ExtendSaveDataFileSystem<br />
|-<br />
| [10.2.0+] 0x44 || CanOpenOwnSaveDataTransferProhibiter || 0x8000000800000000 || [[#OpenSaveDataTransferProhibiter]]<br />
|-<br />
| [11.0.0+] 0x45 || CanFindOwnSaveDataWithFilter || 0x8000000800000000 || [[#FindSaveDataWithFilter]]<br />
|-<br />
| [13.0.0+] 0x46 || CanOpenSaveDataTransferManagerForRepair || 0x8000000000000020 || [[#OpenSaveDataTransferManagerForRepair]]<br />
|-<br />
| [13.0.0+] 0x47 || CanSetDebugConfiguration || 0x8000000000000000 || SetDebugOption, UnsetDebugOption<br />
|-<br />
| [15.0.0+] 0x48 || CanOpenDataStorageByPath || 0x8000000000000000 || OpenDataStorageByPath<br />
|-<br />
| [17.0.0+] 0x49 || CanNotifyErrorContextServiceReady || 0x8000004000000000 || NotifyErrorContextServiceReady<br />
|-<br />
| [17.0.0+] 0x4A || CanGetProgramId || 0x8000000008000000 || GetProgramId<br />
|}<br />
<br />
== OpenFileSystem ==<br />
Takes a type-0x19 input buffer containing a [[#FspPath]] and an input [[#FileSystemProxyType]]. Returns an [[#IFileSystem]].<br />
<br />
[2.0.0+] This function was removed.<br />
<br />
== SetCurrentProcess ==<br />
Takes an input u64 ProcessId. No output.<br />
<br />
== OpenFileSystemWithPatch ==<br />
Takes an input [[#FileSystemProxyType]] and an input [[NCM_services#ProgramId|ProgramId]]. Returns an [[#IFileSystem]].<br />
<br />
Web-applet loads the [[#FileSystemProxyType]] (which must be '''Manual''') from u32_table[inparam].<br />
<br />
Note: web-applet strings refer to both this cmd and [[#OpenFileSystemWithId]] as "MountContent", but official nn_sf_sync symbols use "OpenXX" names.<br />
<br />
== OpenFileSystemWithIdObsolete ==<br />
Takes a type-0x19 input buffer containing a [[#FspPath]], an input [[#FileSystemProxyType]] and an input [[NCM_services#ProgramId|ProgramId]]. Returns an [[#IFileSystem]].<br />
<br />
The [[#IFileSystem]] must be '''Meta''' if the NCA type is 0.<br />
<br />
The input buffer is the output string path from [[NS_Services#GetApplicationContentPath|GetApplicationContentPath]].<br />
<br />
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.<br />
<br />
The official "MountApplicationPackage" func uses this with in64=0 and [[#FileSystemProxyType]] '''Package'''.<br />
<br />
After the [[#FileSystemProxyType]] specific permissions are checked, it then gets the func retval for permissions-type 0x25 and func0.<br />
<br />
When [[#FileSystemProxyType]] is '''Meta''', 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 [[NCM_services#ProgramId|ProgramId]], then an error is thrown on mismatch.<br />
<br />
== OpenFileSystemWithId ==<br />
Takes a type-0x19 input buffer containing a [[#FspPath]], an input [[#ContentAttributes]], an input [[#FileSystemProxyType]] and an input [[NCM_services#ProgramId|ProgramId]]. Returns an [[#IFileSystem]].<br />
<br />
== OpenBisFileSystem ==<br />
Takes a type-0x19 input buffer containing a [[#FspPath]] and an input [[#BisPartitionId]]. Returns an [[#IFileSystem]].<br />
<br />
Official user-process code sets instr[0] = 0 normally.<br />
<br />
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.<br />
<br />
== OpenBisStorage ==<br />
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.<br />
<br />
== InvalidateBisCache ==<br />
Seems to invalidate the Bis cache for MBR/GPT after overwriting that data via the OpenBisStorage IStorage. Used by [[SystemInitializer]].<br />
<br />
== DeleteSaveDataFileSystem ==<br />
Takes an input u64.<br />
<br />
== CreateSaveDataFileSystem ==<br />
Takes a 0x40-byte [[#SaveDataAttribute]], a 0x40-byte [[#SaveDataCreationInfo]], and a 0x10-byte input struct which governs creation of a saveMeta file.<br />
<br />
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 meta file size, +4 u8 = 1 meta index which dictates meta file name.<br />
<br />
Creates non-system savedata.<br />
<br />
== CreateSaveDataFileSystemBySystemSaveDataId ==<br />
Takes a 0x40-byte [[#SaveDataAttribute]] and a 0x40-byte [[#SaveDataCreationInfo]].<br />
<br />
Creates savedata in the SYSTEM [[Flash_Filesystem|NAND]] partition.<br />
<br />
== OpenGameCardStorage ==<br />
Takes two input u32s (gamecard handle, partition ID), and returns an [[#IStorage]] for the [[Gamecard_Format|partition]].<br />
<br />
== OpenGameCardFileSystem ==<br />
Takes two input u32s, with the second u32 located at +4 in rawdata after the first u32. Returns an [[#IFileSystem]].<br />
<br />
Mounts a [[Gamecard_Partition|gamecard partition]].<br />
<br />
== CreateSaveDataFileSystemWithHashSalt ==<br />
Takes a total of 0xB0-bytes of input, no output.<br />
<br />
== OpenSaveDataFileSystem ==<br />
Takes an input u8 [[#SaveDataSpaceId]] and a 0x40-byte [[#SaveDataAttribute]]. Official user-process code is only known to use value 1 for the u8.<br />
<br />
Returns an [[#IFileSystem]].<br />
<br />
Permissions aren't checked until the specified save is successfully found.<br />
<br />
Only one process (specifically only one [[#IFileSystem]] session) can mount a given savedata at any given time (this includes SystemSaveData).<br />
<br />
== OpenSaveDataFileSystemBySystemSaveDataId ==<br />
Takes an input u8 [[#SaveDataSpaceId]] and a 0x40-byte [[#SaveDataAttribute]]. Web-applet only uses value0 for the input u8.<br />
<br />
Returns an [[#IFileSystem]].<br />
<br />
Mounts savedata in the SYSTEM [[Flash_Filesystem|NAND]] partition.<br />
<br />
== OpenReadOnlySaveDataFileSystem ==<br />
Takes an input u8 [[#SaveDataSpaceId]] and a 0x40-byte [[#SaveDataAttribute]], and returns an [[#IFileSystem]].<br />
<br />
Mounts SaveData as ReadOnly.<br />
<br />
== ReadSaveDataFileSystemExtraDataBySaveDataSpaceId ==<br />
Takes an input u8 [[#SaveDataSpaceId]], an input u64 saveID, and a type-0x6 output buffer containing the [[#SaveDataFileSystemExtraData]].<br />
<br />
== ReadSaveDataFileSystemExtraData ==<br />
Takes an input u64 saveID and a type-0x6 output buffer containing the [[#SaveDataFileSystemExtraData]].<br />
<br />
== OpenSaveDataInfoReader ==<br />
No input, returns an output [[#ISaveDataInfoReader]].<br />
<br />
== OpenSaveDataInfoReaderBySaveDataSpaceId ==<br />
Takes an input u8 [[#SaveDataSpaceId]], returns an output [[#ISaveDataInfoReader]].<br />
<br />
== FindSaveDataWithFilter ==<br />
Takes a total of 0x50-bytes of input, returns 8-bytes of output and a type-0x6 output buffer.<br />
<br />
== OpenSaveDataInfoReaderWithFilter ==<br />
Takes a total of 0x50-bytes of input, returns an [[#ISaveDataInfoReader]].<br />
<br />
== OpenSaveDataTransferManager ==<br />
No input, returns an [[#ISaveDataTransferManager]].<br />
<br />
== OpenSaveDataTransferManagerVersion2 ==<br />
No input, returns an [[#ISaveDataTransferManagerWithDivision]].<br />
<br />
== OpenSaveDataTransferProhibiter ==<br />
Takes an input u64, returns an [[#ISaveDataTransferProhibiter]].<br />
<br />
== ListAccessibleSaveDataOwnerId ==<br />
Takes a total of 0x10-bytes of input, returns 4-bytes of output and a type-0x6 output buffer.<br />
<br />
== OpenSaveDataTransferManagerForSaveDataRepair ==<br />
No input, returns an output [[#ISaveDataTransferManagerForSaveDataRepair]].<br />
<br />
== OpenSaveDataMover ==<br />
Takes 2 input [[#SaveDataSpaceId]], an input u64 size and a TransferMemory handle. Returns an output [[#ISaveDataMover]].<br />
<br />
== OpenSaveDataTransferManagerForRepair ==<br />
No input, returns an output [[#ISaveDataTransferManagerForRepair]].<br />
<br />
== OpenContentStorageFileSystem ==<br />
Takes a [[#ContentStorageId]]. Invalid values return 0x2EE202.<br />
<br />
Returns an [[#IFileSystem]] with NCA files. The read data from these files is identical to the data read by [[NCM_services#ReadContentIdFile]].<br />
<br />
== OpenCloudBackupWorkStorageFileSystem ==<br />
Takes 4-bytes of input, returns an [[#IFileSystem]].<br />
<br />
== OpenCustomStorageFileSystem ==<br />
Takes a [[#CustomStorageId]]. Invalid values return 0x2EE202.<br />
<br />
Returns an [[#IFileSystem]] from either User:/CustomStorage0 or Sdcard:/Nintendo/CustomStorage0. If on the SD card, an AesXtsFileSystem is created using a key source specifically for custom storage.<br />
<br />
== OpenDataStorageByDataId ==<br />
Takes a [[NCM_services#StorageId|StorageID]] and a [[NCM_services#DataId|DataId]].<br />
<br />
Returns a [[IPC_Marshalling#Domain_message|domain object ID]] implementing the [[#IStorage]] interface for data archives.<br />
<br />
== OpenDataFileSystemWithProgramIndex ==<br />
Takes an input u8, returns an [[#IFileSystem]].<br />
<br />
== OpenDataStorageWithProgramIndex ==<br />
Takes an input u8, returns an [[#IStorage]].<br />
<br />
== OpenDeviceOperator ==<br />
This command returns a session to a port implementing the [[#IDeviceOperator]] interface.<br />
<br />
== OpenSdCardDetectionEventNotifier ==<br />
This command returns a session to a port implementing the [[#IEventNotifier]] interface.<br />
<br />
== OpenGameCardDetectionEventNotifier ==<br />
This command returns a session to a port implementing the [[#IEventNotifier]] interface.<br />
<br />
== SimulateDeviceDetectionEvent ==<br />
Takes a total of 0xC-bytes of input, no output.<br />
<br />
== VerifySaveDataFileSystem ==<br />
Takes an unknown input u64 and a type-0x6 output buffer.<br />
<br />
The input u64 high-byte must be non-zero, otherwise an [[Error_codes|error]] is returned(0xE02).<br />
<br />
== GetSaveDataCommitId ==<br />
Takes an input u8 and u64, returns an output u64.<br />
<br />
== SetSdCardEncryptionSeed ==<br />
Takes in the 0x10 byte SD card encryption seed, and loads it into FS-module state.<br />
<br />
[[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 all-zero except for the byte at offset 0x20. This byte is set to 1 by NS if the SD card has been mounted successfully and is subsequently passed to SetSdCardAccessibility.<br />
<br />
== OpenAccessFailureDetectionEventNotifier ==<br />
Takes 8-bytes of input and returns an [[#IEventNotifier]].<br />
<br />
[8.0.0+] Now takes an additional 8-bytes of input.<br />
<br />
== SetSaveDataSize ==<br />
Takes two input u64s "size" and "journal_size", and writes them to fsp-srv object member variables.<br />
<br />
These variables are normally initialized with 32 MiB (0x2000000) and 16 MiB (0x1000000), respectively.<br />
<br />
These variables don't seem to be actually used anywhere else (?)<br />
<br />
== SetSaveDataRootPath ==<br />
Takes an input path, and does snprintf(<fsp-srv object>->m_save_data_root_path, FS_MAX_PATH-1, "/%s", input_path);<br />
<br />
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.<br />
<br />
== SetGlobalAccessLogMode ==<br />
Takes an input u32.<br />
<br />
== SetGlobalAccessLogMode ==<br />
Takes an input u32.<br />
<br />
== GetGlobalAccessLogMode ==<br />
Returns an output u32.<br />
<br />
GlobalAccessLogMode is normally 0.<br />
<br />
== OutputAccessLogToSdCard ==<br />
Takes a type-0x5 input buffer.<br />
<br />
The input buffer is the string to output to the log. User-processes normally include a newline at the end.<br />
<br />
User-processes only use this when the value previously loaded from [[#GetGlobalAccessLogMode]] has bit1 set.<br />
<br />
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.<br />
<br />
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).<br />
<br />
== GetProgramIndexForAccessLog ==<br />
No input, returns two 32-bit values "version" and "program_index".<br />
<br />
== OpenMultiCommitManager ==<br />
No input, returns an output [[#IMultiCommitManager]].<br />
<br />
== OpenBisWiper ==<br />
Takes an input u64 size and a TransferMemory handle. Returns an output [[#IWiper]].<br />
<br />
= IStorage =<br />
This is "nn::fssrv::sf::IStorage".<br />
<br />
This is the interface for a raw device, usually a block device.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#Read]]<br />
|-<br />
| 1 || [[#Write]]<br />
|-<br />
| 2 || [[#Flush]]<br />
|-<br />
| 3 || [[#SetSize]]<br />
|-<br />
| 4 || [[#GetSize]]<br />
|-<br />
| 5 || [4.0.0+] OperateRange<br />
|}<br />
<br />
== Read ==<br />
Takes a type-0x46 buffer, an offset and length.<br />
<br />
== Write ==<br />
Takes a type-0x45 buffer, an offset and length.<br />
<br />
== Flush ==<br />
No input.<br />
<br />
== SetSize ==<br />
Takes a size.<br />
<br />
== GetSize ==<br />
Returns a size.<br />
<br />
= IFileSystem =<br />
This is "nn::fssrv::sf::IFileSystem".<br />
<br />
There are two main implementations of this interface:<br />
<br />
* '''nn::fs::fsa::IFileSystem''': The main IFileSystem implementation. Filesystem classes implement this interface, and FS code usually operates on this interface.<br />
* '''nn::fssrv::sf::IFileSystem''': Used for sending an IFileSystem over IPC. Not used outside of IPC code.<br />
<br />
There are two adapter classes to convert between these interfaces:<br />
<br />
* '''nn::fssrv::detail::FileSystemInterfaceAdapter''': Allows access to an nn::fs::fsa::IFileSystem via the nn::fssrv::sf::IFileSystem interface.<br />
* '''nn::fs::detail::FileSystemServiceObjectAdapter''': Allows access to an nn::fssrv::sf::IFileSystem via the nn::fs::fsa::IFileSystem interface.<br />
<br />
When the FS process returns a filesystem, it will wrap the filesystem object in a FileSystemInterfaceAdapter to return it over IPC.<br />
Then when FS application code receives that filesystem, it will wrap the nn::fssrv::sf::IFileSystem object in a FileSystemServiceObjectAdapter before using it.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || CreateFile<br />
|-<br />
| 1 || DeleteFile<br />
|-<br />
| 2 || CreateDirectory<br />
|-<br />
| 3 || DeleteDirectory<br />
|-<br />
| 4 || DeleteDirectoryRecursively<br />
|-<br />
| 5 || RenameFile<br />
|-<br />
| 6 || RenameDirectory<br />
|-<br />
| 7 || [[#GetEntryType]]<br />
|-<br />
| 8 || [[#OpenFile]]<br />
|-<br />
| 9 || [[#OpenDirectory]]<br />
|-<br />
| 10 || [[#Commit]]<br />
|-<br />
| 11 || [[#GetFreeSpaceSize]]<br />
|-<br />
| 12 || [[#GetTotalSpaceSize]]<br />
|-<br />
| 13 || [3.0.0+] [[#CleanDirectoryRecursively]]<br />
|-<br />
| 14 || [3.0.0+] [[#GetFileTimeStampRaw]]<br />
|-<br />
| 15 || [4.0.0+] QueryEntry<br />
|-<br />
| 16 || [15.0.0+] GetFileSystemAttribute<br />
|}<br />
<br />
== GetEntryType ==<br />
Takes a type-0x9 input buffer for the path and returns [[#DirectoryEntryType]] as an output u32.<br />
<br />
== OpenFile ==<br />
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:<br />
<br />
* When bit 0 is set, the file is Readable: you can use the Read operation.<br />
* When bit 1 is set, the file is Writable: you can use the Write operation.<br />
* 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)<br />
<br />
== OpenDirectory ==<br />
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.<br />
<br />
== Commit ==<br />
Like [https://3dbrew.org/wiki/FS:ControlArchive 3DS], this has to be used after writing to savedata for the changes to take affect.<br />
<br />
== GetFreeSpaceSize ==<br />
Takes a type-0x9 input buffer for the path and returns an output byte-size u64 for the total free space with this FS.<br />
<br />
== GetTotalSpaceSize ==<br />
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).<br />
<br />
== CleanDirectoryRecursively ==<br />
Takes a type-0x9 input buffer for the path and clears the contents of the directory specified in the path.<br />
<br />
== GetFileTimeStampRaw ==<br />
Takes a type-0x19 input buffer for the path and returns a 0x20-byte struct. This contains 3 u64s and an u8.<br />
<br />
= IDirectory =<br />
This is "nn::fssrv::sf::IDirectory".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#Read]]<br />
|-<br />
| 1 || [[#GetEntryCount]]<br />
|}<br />
<br />
== Read ==<br />
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.<br />
<br />
The output buffer contains the read array of [[#DirectoryEntry]]. This doesn't include entries for "." and "..".<br />
<br />
== GetEntryCount ==<br />
Returns an u64 for the total number of readable entries.<br />
<br />
= DirectoryEntry =<br />
This is "nn::fs::DirectoryEntry".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset || Size || Description<br />
|-<br />
| 0x0 || 0x301 || Path<br />
|-<br />
| 0x301 || 0x1 || File attributes (bit 0 = is directory; bit 1 = archive bit)<br />
|-<br />
| 0x302 || 0x2 || Padding?<br />
|-<br />
| 0x304 || 0x1 || [[#DirectoryEntryType]]<br />
|-<br />
| 0x305 || 0x3 || Padding?<br />
|-<br />
| 0x308 || 0x8 || Filesize, 0 for directories.<br />
|}<br />
<br />
= DirectoryEntryType =<br />
This is "nn::fs::DirectoryEntryType".<br />
<br />
An s8 value indicating a directory entry type. The current values are:<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Description<br />
|-<br />
| 0 || Directory<br />
|-<br />
| 1 || File<br />
|}<br />
<br />
= IFile =<br />
This is "nn::fssrv::sf::IFile".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || Read<br />
|-<br />
| 1 || Write<br />
|-<br />
| 2 || Flush<br />
|-<br />
| 3 || SetSize<br />
|-<br />
| 4 || GetSize<br />
|-<br />
| 5 || [4.0.0+] OperateRange<br />
|-<br />
| 6 || [12.0.0+] OperateRangeWithBuffer<br />
|}<br />
<br />
= ISaveDataInfoReader =<br />
This is "nn::fssrv::sf::ISaveDataInfoReader".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#ReadSaveDataInfo]]<br />
|}<br />
<br />
== ReadSaveDataInfo ==<br />
Takes a type-0x6 output buffer. Returns an output u64 for total output entries. This buffer contains an array of [[#SaveDataInfo]].<br />
<br />
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).<br />
<br />
= IDeviceOperator =<br />
This is "nn::fssrv::sf::IDeviceOperator".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#IsSdCardInserted]]<br />
|-<br />
| 1 || [[#GetSdCardSpeedMode]]<br />
|-<br />
| 2 || [2.0.0+] [[#GetSdCardCid]]<br />
|-<br />
| 3 || [2.0.0+] [[#GetSdCardUserAreaSize]]<br />
|-<br />
| 4 || [2.0.0+] [[#GetSdCardProtectedAreaSize]]<br />
|-<br />
| 5 || [2.0.0+] [[#GetAndClearSdCardErrorInfo]]<br />
|-<br />
| 6 || [17.0.0+] GetSdCardHostControllerStatus<br />
|-<br />
| 100 || [[#GetMmcCid]]<br />
|-<br />
| 101 || [[#GetMmcSpeedMode]]<br />
|-<br />
| 110 || [[#EraseMmc]]<br />
|-<br />
| 111 || [[#GetMmcPartitionSize]]<br />
|-<br />
| 112 || [2.0.0+] [[#GetMmcPatrolCount]]<br />
|-<br />
| 113 || [2.0.0+] [[#GetAndClearMmcErrorInfo]]<br />
|-<br />
| 114 || [2.0.0+] [[#GetMmcExtendedCsd]]<br />
|-<br />
| 115 || [4.0.0+] [[#SuspendMmcPatrol]]<br />
|-<br />
| 116 || [4.0.0+] [[#ResumeMmcPatrol]]<br />
|-<br />
| 117 || [17.0.0+] EraseMmcWithRange<br />
|-<br />
| 200 || [[#IsGameCardInserted]]<br />
|-<br />
| 201 || [[#EraseGameCard]]<br />
|-<br />
| 202 || [[#GetGameCardHandle]]<br />
|-<br />
| 203 || [[#GetGameCardUpdatePartitionInfo]]<br />
|-<br />
| 204 || [[#FinalizeGameCardDriver]]<br />
|-<br />
| 205 || [[#GetGameCardAttribute]]<br />
|-<br />
| 206 || [[#GetGameCardDeviceCertificate]]<br />
|-<br />
| 207 || [[#GetGameCardAsicInfo]]<br />
|-<br />
| 208 || [[#GetGameCardIdSet]]<br />
|-<br />
| 209 || [[#WriteToGameCardDirectly]]<br />
|-<br />
| 210 || [[#SetVerifyWriteEnalbleFlag]]<br />
|-<br />
| 211 || [[#GetGameCardImageHash]]<br />
|-<br />
| 212 || [2.0.0+] [[#GetGameCardDeviceIdForProdCard]]<br />
|-<br />
| 213 || [2.0.0+] [[#EraseAndWriteParamDirectly]]<br />
|-<br />
| 214 || [2.0.0+] [[#ReadParamDirectly]]<br />
|-<br />
| 215 || [2.0.0+] [[#ForceEraseGameCard]]<br />
|-<br />
| 216 || [2.0.0+] [[#GetGameCardErrorInfo]]<br />
|-<br />
| 217 || [2.1.0+] [[#GetGameCardErrorReportInfo]]<br />
|-<br />
| 218 || [3.0.0+] [[#GetGameCardDeviceId]]<br />
|-<br />
| 219 || [8.0.0+] [[#ChallengeCardExistence]]<br />
|-<br />
| 220 || [9.0.0+] [[#GetGameCardCompatibilityType]]<br />
|-<br />
| 221 || [17.0.0+] GetGameCardAsicCertificate<br />
|-<br />
| 300 || [[#SetSpeedEmulationMode]]<br />
|-<br />
| 301 || [[#GetSpeedEmulationMode]]<br />
|-<br />
| 400 || [5.0.0+] [[#SuspendSdmmcControl]]<br />
|-<br />
| 401 || [5.0.0+] [[#ResumeSdmmcControl]]<br />
|-<br />
| 402 || [6.0.0+] [[#GetSdmmcConnectionStatus]]<br />
|-<br />
| 500 || [6.0.0+] [[#SetDeviceSimulationEvent]]<br />
|-<br />
| 501 || [6.0.0+] [[#ClearDeviceSimulationEvent]]<br />
|}<br />
<br />
== IsSdCardInserted ==<br />
No input. Returns an output bool.<br />
<br />
== GetSdCardSpeedMode ==<br />
No input. Returns an output [[#SdCardSpeedMode]].<br />
<br />
== GetSdCardCid ==<br />
Takes a type-0x6 output buffer and an input s64 '''BufferSize'''. No output.<br />
<br />
== GetSdCardUserAreaSize ==<br />
No input. Returns an output s64 '''SdCardUserAreaSize'''.<br />
<br />
== GetSdCardProtectedAreaSize ==<br />
No input. Returns an output s64 '''SdCardProtectedAreaSize'''.<br />
<br />
== GetAndClearSdCardErrorInfo ==<br />
Takes a type-0x6 output buffer '''LogBuffer''' and an input s64 '''LogBufferSize'''. Returns an output [[#StorageErrorInfo]] and an output s64 '''LogSize'''.<br />
<br />
== GetMmcCid ==<br />
Takes a type-0x6 output buffer and an input s64 '''BufferSize'''. No output.<br />
<br />
== GetMmcSpeedMode ==<br />
No input. Returns an output [[#MmcSpeedMode]].<br />
<br />
== EraseMmc ==<br />
Takes an input [[#MmcPartition]]. No output.<br />
<br />
== GetMmcPartitionSize ==<br />
Takes an input [[#MmcPartition]]. Returns an output s64 '''MmcPartitionSize'''.<br />
<br />
== GetMmcPatrolCount ==<br />
No input. Returns an output u32 '''MmcPatrolCount'''.<br />
<br />
== GetAndClearMmcErrorInfo ==<br />
Takes a type-0x6 output buffer '''LogBuffer''' and an input s64 '''LogBufferSize'''. Returns an output [[#StorageErrorInfo]] and an output s64 '''LogSize'''.<br />
<br />
== GetMmcExtendedCsd ==<br />
Takes a type-0x6 output buffer and an input s64 '''BufferSize'''. No output.<br />
<br />
== SuspendMmcPatrol ==<br />
No input/output.<br />
<br />
== ResumeMmcPatrol ==<br />
No input/output.<br />
<br />
== IsGameCardInserted ==<br />
No input. Returns an output bool.<br />
<br />
== EraseGameCard ==<br />
Takes an input [[#GameCardSize]] and an input u64 '''NormalAreaSize'''. No output.<br />
<br />
== GetGameCardHandle ==<br />
No input. Returns an output [[#GameCardHandle]].<br />
<br />
== GetGameCardUpdatePartitionInfo ==<br />
Takes an input [[#GameCardHandle]]. Returns an output [[#GameCardUpdatePartitionInfo]].<br />
<br />
== FinalizeGameCardDriver ==<br />
No input/output.<br />
<br />
== GetGameCardAttribute ==<br />
Takes an input [[#GameCardHandle]]. Returns an output [[#GameCardAttribute]].<br />
<br />
== GetGameCardDeviceCertificate ==<br />
Takes a type-0x6 output buffer, an input s64 '''BufferSize''' and an input [[#GameCardHandle]]. No output.<br />
<br />
== GetGameCardAsicInfo ==<br />
Takes a type-0x5 input buffer '''FwBuffer''', a type-0x6 output buffer containing [[#RmaInformation]] and two input s64s '''FwBufferSize''' and '''RmaInformationSize'''. No output.<br />
<br />
== GetGameCardIdSet ==<br />
Takes a type-0x6 output buffer containing a [[#GameCardIdSet]] and an input s64 '''BufferSize'''. No output.<br />
<br />
== WriteToGameCardDirectly ==<br />
Takes a type-0x6 output buffer and two input s64s '''Offset''' and '''BufferSize'''. No output.<br />
<br />
== SetVerifyWriteEnalbleFlag ==<br />
Takes an input bool. No output.<br />
<br />
== GetGameCardImageHash ==<br />
Takes a type-0x6 output buffer, an input s64 '''BufferSize''' and an input [[#GameCardHandle]]. No output.<br />
<br />
== GetGameCardDeviceIdForProdCard ==<br />
Takes a type-0x5 input buffer '''CardHeaderForDev''', a type-0x6 output buffer and two input s64s '''CardHeaderForDevSize''' and '''BufferSize'''. No output.<br />
<br />
== EraseAndWriteParamDirectly ==<br />
Takes a type-0x5 input buffer and an input s64 '''BufferSize'''. No output.<br />
<br />
== ReadParamDirectly ==<br />
Takes a type-0x6 output buffer and an input s64 '''BufferSize'''. No output.<br />
<br />
== ForceEraseGameCard ==<br />
No input/output.<br />
<br />
== GetGameCardErrorInfo ==<br />
No input. Returns an output [[#GameCardErrorInfo]].<br />
<br />
== GetGameCardErrorReportInfo ==<br />
No input. Returns an output [[#GameCardErrorReportInfo]].<br />
<br />
== GetGameCardDeviceId ==<br />
Takes a type-0x6 output buffer and an input s64 '''BufferSize'''. No output.<br />
<br />
== ChallengeCardExistence ==<br />
Takes a type-0x6 output buffer, two type-0x5 input buffers and an input [[#GameCardHandle]]. No output.<br />
<br />
[9.0.0+] The [[Account_services|account]] system module uses this as part of a new challenge-response mechanism for [[Network#aauth|application authentication]].<br />
<br />
== GetGameCardCompatibilityType ==<br />
Takes an input [[#GameCardHandle]]. Returns an output [[#GameCardCompatibilityType]].<br />
<br />
== SetSpeedEmulationMode ==<br />
Takes an input [[#SpeedEmulationMode]]. No output.<br />
<br />
== GetSpeedEmulationMode ==<br />
No input. Returns an output [[#SpeedEmulationMode]].<br />
<br />
== SuspendSdmmcControl ==<br />
No input/output.<br />
<br />
== ResumeSdmmcControl ==<br />
No input/output.<br />
<br />
== GetSdmmcConnectionStatus ==<br />
Takes a total of 4-bytes of input. Returns a total of 8-bytes of output.<br />
<br />
== SetDeviceSimulationEvent == <br />
Takes a total of 0x14-bytes of input. No output.<br />
<br />
== ClearDeviceSimulationEvent ==<br />
Takes a total of 4-bytes of input. No output.<br />
<br />
= IEventNotifier =<br />
This is "nn::fssrv::sf::IEventNotifier".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#GetEventHandle]]<br />
|}<br />
<br />
== GetEventHandle ==<br />
No input, returns an output Event handle. With official sw the EventClearMode is user-specified.<br />
<br />
= ISaveDataTransferManager =<br />
This is "nn::fssrv::sf::ISaveDataTransferManager".<br />
<br />
This was added with [[4.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#GetChallenge]]<br />
|-<br />
| 16 || [[#SetToken]]<br />
|-<br />
| 32 || [[#OpenSaveDataExporter]]<br />
|-<br />
| 64 || [[#OpenSaveDataImporter]]<br />
|}<br />
<br />
== GetChallenge ==<br />
No input/output, takes a type-0x6 output buffer.<br />
<br />
== SetToken ==<br />
No input/output, takes a type-0x5 input buffer.<br />
<br />
== OpenSaveDataExporter ==<br />
Takes an input u8 [[#SaveDataSpaceId]] and u64, returns an [[#ISaveDataExporter]].<br />
<br />
== OpenSaveDataImporter ==<br />
Takes an input u8 [[#SaveDataSpaceId]] and a 0x10-byte userID, and a type-0x5 input buffer. Returns an output u64 and an [[#ISaveDataImporter]].<br />
<br />
= ISaveDataTransferManagerForSaveDataRepair =<br />
This is "nn::fssrv::sf::ISaveDataTransferManagerForSaveDataRepair".<br />
<br />
This was added with [[9.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#GetChallenge]]<br />
|-<br />
| 16 || [[#SetKeyPackage]]<br />
|-<br />
| 80 || [[#OpenSaveDataExporterAndGetEncryptedKey]]<br />
|-<br />
| 81 || [[#PrepareOpenSaveDataImporter]]<br />
|-<br />
| 90 || [[#OpenSaveDataImporter]]<br />
|-<br />
| 91 || [[#OpenSaveDataImporter2]]<br />
|-<br />
| 100 || [[#OpenSaveDataExporterWithKey]]<br />
|-<br />
| 110 || [[#OpenSaveDataImporterWithKey]]<br />
|}<br />
<br />
== SetKeyPackage ==<br />
No input/output, takes a type-0x5 input buffer.<br />
<br />
== OpenSaveDataExporterAndGetEncryptedKey ==<br />
Takes a total of 0x10-bytes of input and a type-0x1A output buffer to receive a RsaEncryptedKey. Returns an [[#ISaveDataDivisionExporter]].<br />
<br />
== PrepareOpenSaveDataImporter ==<br />
Takes a type-0x1A output buffer to receive a RsaEncryptedKey.<br />
<br />
== OpenSaveDataImporter ==<br />
Takes a total of 0x18-bytes of input and two type-0x5 input buffers, returns an [[#ISaveDataDivisionImporter]].<br />
<br />
== OpenSaveDataImporter2 ==<br />
Takes a total of 0x18-bytes of input and a type-0x5 input buffer, returns an [[#ISaveDataDivisionImporter]].<br />
<br />
== OpenSaveDataExporterWithKey ==<br />
Takes a total of 0x20-bytes of input, returns an [[#ISaveDataDivisionExporter]].<br />
<br />
== OpenSaveDataImporterWithKey ==<br />
Takes a total of 0x28-bytes of input and a type-0x5 input buffer, returns an [[#ISaveDataDivisionImporter]].<br />
<br />
[17.0.0+] Now only takes 0x18-bytes of input and an additional type-0x5 input buffer.<br />
<br />
= ISaveDataMover =<br />
This is "nn::fssrv::sf::ISaveDataMover".<br />
<br />
This was added with [[10.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 8 || [[#Register]]<br />
|-<br />
| 16 || [[#Process]]<br />
|-<br />
| 18 || [[#Cancel]]<br />
|}<br />
<br />
== Register ==<br />
Takes an input u64, no output.<br />
<br />
== Process ==<br />
Takes an input u64, returns an output u64.<br />
<br />
== Cancel ==<br />
No input/output.<br />
<br />
= ISaveDataTransferManagerForRepair =<br />
This is "nn::fssrv::sf::ISaveDataTransferManagerForRepair".<br />
<br />
This was added with [[11.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 80 || [[#OpenSaveDataExporter]]<br />
|-<br />
| 90 || [[#OpenSaveDataImporter]]<br />
|}<br />
<br />
== OpenSaveDataExporter ==<br />
Takes a total of 0x10-bytes of input, returns an [[#ISaveDataDivisionExporter]].<br />
<br />
== OpenSaveDataImporter ==<br />
Takes 1-byte of input, a type-0x5 input buffer, returns an [[#ISaveDataDivisionImporter]].<br />
<br />
= ISaveDataExporter =<br />
This is "nn::fssrv::sf::ISaveDataExporter".<br />
<br />
This was added with [[4.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#GetSaveDataInfo]]<br />
|-<br />
| 1 || [[#GetRestSize]]<br />
|-<br />
| 16 || [[#Pull]]<br />
|-<br />
| 17 || [[#PullInitialData]]<br />
|}<br />
<br />
== GetSaveDataInfo ==<br />
No input/output, takes a type-0x1A [[#SaveDataInfo]] output buffer.<br />
<br />
The actual name for this is the SaveDataExporter constructor. This is used automatically after [[#OpenSaveDataExporter]] by official sw.<br />
<br />
== GetRestSize ==<br />
No input, returns an output u64.<br />
<br />
== Pull ==<br />
Takes a type-0x6 output buffer, returns an output u64.<br />
<br />
== PullInitialData ==<br />
No input/output, takes a type-0x6 output buffer.<br />
<br />
= ISaveDataImporter =<br />
This is "nn::fssrv::sf::ISaveDataImporter".<br />
<br />
This was added with [[4.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#GetSaveDataInfo]]<br />
|-<br />
| 1 || [[#GetRestSize]]<br />
|-<br />
| 16 || [[#Push]]<br />
|-<br />
| 17 || [[#Finalize]]<br />
|}<br />
<br />
== GetSaveDataInfo ==<br />
No input/output, takes a type-0x1A [[#GetSaveDataInfo]] output buffer.<br />
<br />
The actual name for this is the SaveDataImporter constructor. This is used automatically after [[#OpenSaveDataImporter]] by official sw.<br />
<br />
== GetRestSize ==<br />
No input, returns an output u64.<br />
<br />
== Push ==<br />
No input/output, takes a type-0x5 input buffer.<br />
<br />
== Finalize ==<br />
No input/output.<br />
<br />
= ISaveDataTransferManagerWithDivision =<br />
This is "nn::fssrv::sf::ISaveDataTransferManagerWithDivision".<br />
<br />
This was added with [[5.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#GetChallenge]]<br />
|-<br />
| 16 || [[#SetKeySeedPackage]]<br />
|-<br />
| 32 || [[#OpenSaveDataExporter]]<br />
|-<br />
| 33 || [[#OpenSaveDataExporterForDiffExport]]<br />
|-<br />
| 34 || [6.0.0+] [[#OpenSaveDataExporterByContext]]<br />
|-<br />
| 63 || [17.0.0+] OpenSaveDataImporter<br />
|-<br />
| 64 || [6.0.0+] [[#OpenSaveDataImporterDeprecated]] ([5.0.0-5.1.0] OpenSaveDataImporter)<br />
|-<br />
| 65 || [[#OpenSaveDataImporterForDiffImport]]<br />
|-<br />
| 66 || [6.0.0+] [[#OpenSaveDataImporterForDuplicateDiffImport]]<br />
|-<br />
| 67 || [6.0.0-16.1.0] [[#OpenSaveDataImporter]]<br />
|-<br />
| 68 || [6.0.0+] [[#OpenSaveDataImporterByContext]]<br />
|-<br />
| 69 || [6.0.0+] [[#CancelSuspendingImport]]<br />
|-<br />
| 70 || [10.0.0+] DecryptAndVerifyInitialData<br />
|-<br />
| 80 || [11.0.0+] DecryptoAndVerifyPortContext<br />
|}<br />
<br />
== GetChallenge ==<br />
No input/output, takes a type-0x6 output buffer containing the '''Challenge'''.<br />
<br />
== SetKeySeedPackage ==<br />
No input/output, takes a type-0x5 input buffer containing the '''KeySeedPackage'''.<br />
<br />
== OpenSaveDataExporter ==<br />
Takes an input u8 [[#SaveDataSpaceId]] and u64. Returns an [[#ISaveDataDivisionExporter]].<br />
<br />
== OpenSaveDataExporterForDiffExport ==<br />
Takes an input u8 [[#SaveDataSpaceId]], an u64, and a type-0x5 input buffer [[#InitialDataVersion2]]. Returns an [[#ISaveDataDivisionExporter]].<br />
<br />
== OpenSaveDataExporterByContext ==<br />
No input/output, takes a type-0x5 input buffer, returns an [[#ISaveDataDivisionExporter]].<br />
<br />
== OpenSaveDataImporterDeprecated ==<br />
Takes an input u8 [[#SaveDataSpaceId]], a 0x10-byte userID, and a type-0x5 input buffer [[#InitialDataVersion2]]. Returns an [[#ISaveDataDivisionImporter]].<br />
<br />
== OpenSaveDataImporterForDiffImport ==<br />
Takes an input u8 [[#SaveDataSpaceId]], an u64, and a type-0x5 input buffer [[#InitialDataVersion2]], returns an [[#ISaveDataDivisionImporter]].<br />
<br />
== OpenSaveDataImporterForDuplicateDiffImport ==<br />
Takes an input u8 and an u64, and a type-0x5 input buffer, returns an [[#ISaveDataDivisionImporter]].<br />
<br />
== OpenSaveDataImporter ==<br />
Takes an input u8, an u8(bool), a 0x10-byte struct, and a type-0x5 input buffer, returns an [[#ISaveDataDivisionImporter]].<br />
<br />
== OpenSaveDataImporterByContext ==<br />
No input/output, takes a type-0x5 input buffer, returns an [[#ISaveDataDivisionImporter]].<br />
<br />
== CancelSuspendingImport ==<br />
Takes an input u64 and a 0x10-byte struct, no output.<br />
<br />
= ISaveDataDivisionExporter =<br />
This is "nn::fssrv::sf::ISaveDataDivisionExporter".<br />
<br />
This was added with [[5.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#SetDivisionCount]]<br />
|-<br />
| 1 || [6.0.0+] [[#GetSaveDataInfo]]<br />
|-<br />
| 16 || [[#OpenSaveDataDiffChunkIterator]]<br />
|-<br />
| 48 || [[#OpenSaveDataChunkExporter]]<br />
|-<br />
| 64 || [6.0.0-8.1.0] [[#FinalizeFullExport]]<br />
|-<br />
| 65 || [6.0.0-8.1.0] [[#FinalizeDiffExport]]<br />
|-<br />
| 66 || [6.0.0+] [[#CancelExport]]<br />
|-<br />
| 67 || [6.0.0+] [[#SuspendExport]]<br />
|-<br />
| 70 || [6.0.0+] [[#GetKeySeed]]<br />
|-<br />
| 71 || [6.0.0+] [[#GetInitialDataMac]]<br />
|-<br />
| 72 || [6.0.0+] [[#FinalizeExport]]<br />
|-<br />
| 73 || [9.0.0+] [[#GetInitialDataMacKeyGeneration]]<br />
|-<br />
| 80 || [6.0.0+] [[#GetImportInitialDataAad]]<br />
|-<br />
| 81 || [6.0.0+] [[#SetExportInitialDataAad]]<br />
|-<br />
| 96 || [6.0.0+] [[#GetReportInfo]]<br />
|}<br />
<br />
== SetDivisionCount ==<br />
Takes an input u32, no output.<br />
<br />
== OpenSaveDataChunkExporter ==<br />
Takes an input u32, returns an [[#ISaveDataChunkExporter]].<br />
<br />
== FinalizeFullExport ==<br />
No input, returns two 0x10-byte output structs.<br />
<br />
== FinalizeDiffExport ==<br />
No input, returns an output 0x10-byte struct.<br />
<br />
== CancelExport ==<br />
No input/output.<br />
<br />
== SuspendExport ==<br />
No input/output, takes a type-0x6 output buffer.<br />
<br />
== GetKeySeed ==<br />
No input, returns an output 0x10-byte struct.<br />
<br />
== GetInitialDataMac ==<br />
No input, returns an output 0x10-byte struct.<br />
<br />
== FinalizeExport ==<br />
No input/output.<br />
<br />
== SetExportInitialDataAad ==<br />
Takes an input 0x20-byte struct, no output.<br />
<br />
= ISaveDataDivisionImporter =<br />
This is "nn::fssrv::sf::ISaveDataDivisionImporter".<br />
<br />
This was added with [[5.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [6.0.0+] [[#GetSaveDataInfo]]<br />
|-<br />
| 16 || [[#OpenSaveDataDiffChunkIterator]]<br />
|-<br />
| 32 || [[#InitializeImport]]<br />
|-<br />
| 33 || [[#FinalizeImport]]<br />
|-<br />
| 34 || [6.0.0+] [[#CancelImport]]<br />
|-<br />
| 35 || [6.0.0+] [[#GetImportContext]]<br />
|-<br />
| 36 || [6.0.0+] [[#SuspendImport]]<br />
|-<br />
| 37 || [11.0.0+] FinalizeImportWithoutSwap<br />
|-<br />
| 48 || [[#OpenSaveDataChunkImporter]]<br />
|-<br />
| 64 || [6.0.0+] [[#GetImportInitialDataAad]]<br />
|-<br />
| 80 || [6.0.0+] [[#GetReportInfo]]<br />
|}<br />
<br />
== GetSaveDataInfo ==<br />
No input/output, takes a type-0x6 output buffer.<br />
<br />
== OpenSaveDataDiffChunkIterator ==<br />
No input, returns an [[#ISaveDataChunkIterator]].<br />
<br />
== InitializeImport ==<br />
No input, returns an output u64.<br />
<br />
== FinalizeImport ==<br />
No input/output.<br />
<br />
== CancelImport ==<br />
No input/output.<br />
<br />
== GetImportContext ==<br />
No input/output, takes a type-0x6 output buffer.<br />
<br />
== SuspendImport ==<br />
No input/output.<br />
<br />
== OpenSaveDataChunkImporter ==<br />
Takes an input u32, returns an [[#ISaveDataChunkImporter]].<br />
<br />
== GetImportInitialDataAad == <br />
No input, returns an output 0x20-byte struct.<br />
<br />
== GetReportInfo ==<br />
No input, returns an output 0x20-byte struct.<br />
<br />
= ISaveDataChunkIterator =<br />
This is "nn::fssrv::sf::ISaveDataChunkIterator".<br />
<br />
This was added with [[5.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#Next]]<br />
|-<br />
| 1 || [[#IsEnd]] <br />
|-<br />
| 16 || [[#GetId]] <br />
|}<br />
<br />
== Next ==<br />
No input/output.<br />
<br />
== IsEnd ==<br />
No input, returns an output u8.<br />
<br />
== GetId ==<br />
No input, returns an output u32.<br />
<br />
= ISaveDataChunkExporter =<br />
This is "nn::fssrv::sf::ISaveDataChunkExporter".<br />
<br />
This was added with [[5.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#Pull]]<br />
|-<br />
| 16 || [6.0.0+] [[#GetRestRawDataSize]]<br />
|}<br />
<br />
== Pull ==<br />
Takes an input u64 and a type-0x6 output buffer, returns an output u64.<br />
<br />
== GetRestRawDataSize ==<br />
No input, returns an output u64.<br />
<br />
= ISaveDataChunkImporter =<br />
This is "nn::fssrv::sf::ISaveDataChunkImporter".<br />
<br />
This was added with [[5.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#Push]]<br />
|}<br />
<br />
== Push ==<br />
Takes an input u64 and a type-0x5 input buffer, no output.<br />
<br />
= ISaveDataTransferProhibiter =<br />
This is "nn::fssrv::sf::ISaveDataTransferProhibiter".<br />
<br />
This was added with [6.0.0+].<br />
<br />
This doesn't seem to handle any commands (?).<br />
<br />
= IMultiCommitManager =<br />
This is "nn::fssrv::sf::IMultiCommitManager".<br />
<br />
This was added with [6.0.0+].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 1 || [[#Add]]<br />
|-<br />
| 2 || [[#Commit]]<br />
|}<br />
<br />
== Add ==<br />
Takes an input [[#IFilesystem]], no output.<br />
<br />
== Commit ==<br />
No input/output.<br />
<br />
= IWiper =<br />
This is "nn::fssrv::sf::IWiper".<br />
<br />
This was added with [[10.0.0]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| 0 || [[#Startup|Startup]]<br />
|-<br />
| 16 || [[#Process_2|Process]]<br />
|}<br />
<br />
== Startup ==<br />
No input. Returns an u64.<br />
<br />
== Process ==<br />
No input. Returns an u64.<br />
<br />
= IStorageDeviceManager =<br />
This is "nn::fssrv::storage::sf::IStorageDeviceManager".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| N/A || IsInserted<br />
|-<br />
| N/A || IsHandleValid<br />
|-<br />
| N/A || OpenDetectionEvent<br />
|-<br />
| N/A || OpenOperator<br />
|-<br />
| N/A || OpenDevice<br />
|-<br />
| N/A || OpenStorage<br />
|-<br />
| N/A || Invalidate<br />
|}<br />
<br />
= IStorageDeviceOperator =<br />
This is "nn::fssrv::storage::sf::IStorageDeviceOperator".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| N/A || Operate<br />
|-<br />
| N/A || OperateIn<br />
|-<br />
| N/A || OperateOut<br />
|-<br />
| N/A || OperateOut2<br />
|-<br />
| N/A || OperateInOut<br />
|-<br />
| N/A || OperateIn2Out<br />
|}<br />
<br />
= IStorageDevice =<br />
This is "nn::fssrv::storage::sf::IStorageDevice".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Cmd || Name<br />
|-<br />
| N/A || GetHandle<br />
|-<br />
| N/A || IsHandleValid<br />
|-<br />
| N/A || OpenOperator<br />
|-<br />
| N/A || Read<br />
|-<br />
| N/A || Write<br />
|-<br />
| N/A || Flush<br />
|-<br />
| N/A || SetSize<br />
|-<br />
| N/A || GetSize<br />
|-<br />
| N/A || OperateRange<br />
|}<br />
<br />
= FileSystemProxyType =<br />
This is "nn::fs::FileSystemProxyType".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Code<br />
|-<br />
| 1 || Rom<br />
|-<br />
| 2 || Logo<br />
|-<br />
| 3 || Control<br />
|-<br />
| 4 || Manual<br />
|-<br />
| 5 || Meta<br />
|-<br />
| 6 || Data<br />
|-<br />
| 7 || Package<br />
|-<br />
| 8 || [4.0.0+] RegisteredUpdate<br />
|}<br />
<br />
= ContentType =<br />
This is "nn::fs::ContentType".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Meta<br />
|-<br />
| 1 || Control<br />
|-<br />
| 2 || Manual<br />
|-<br />
| 3 || Logo<br />
|-<br />
| 4 || Data<br />
|}<br />
<br />
= ContentAttributes =<br />
This is "nn::fs::ContentAttributes".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || None<br />
|-<br />
| 15 || All<br />
|}<br />
<br />
= ContentStorageId =<br />
This is "nn::fs::ContentStorageId".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || System<br />
|-<br />
| 1 || User<br />
|-<br />
| 2 || SdCard<br />
|-<br />
| 3 || [16.0.0+] System0<br />
|}<br />
<br />
= SaveDataSpaceId =<br />
This is "nn::fs::SaveDataSpaceId".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || System<br />
|-<br />
| 1 || User<br />
|-<br />
| 2 || SdSystem<br />
|-<br />
| 3 || [3.0.0+] Temporary<br />
|-<br />
| 4 || [4.0.0+] SdUser<br />
|-<br />
| 100 || [3.0.0+] ProperSystem<br />
|-<br />
| 101 || [3.0.0+] SafeMode<br />
|}<br />
<br />
Determines the storage where the savedata is stored.<br />
<br />
= SaveDataType =<br />
This is "nn::fs::SaveDataType".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || System<br />
|-<br />
| 1 || Account<br />
|-<br />
| 2 || Bcat<br />
|-<br />
| 3 || Device<br />
|-<br />
| 4 || [3.0.0+] Temporary<br />
|-<br />
| 5 || [3.0.0+] Cache<br />
|-<br />
| 6 || [4.0.0+] SystemBcat<br />
|}<br />
<br />
= SaveDataRank =<br />
This is "nn::fs::SaveDataRank".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Primary<br />
|-<br />
| 1 || Secondary<br />
|}<br />
<br />
= SaveDataEnumerateOption =<br />
This is "nn::fs::SaveDataEnumerateOption".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 1 || AllRank<br />
|}<br />
<br />
= SaveDataFlags =<br />
This is "nn::fs::SaveDataFlags".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 1 || KeepAfterResettingSystemSaveData<br />
|-<br />
| 2 || KeepAfterRefurbishment<br />
|-<br />
| 4 || KeepAfterResettingSystemSaveDataWithoutUserSaveData<br />
|-<br />
| 8 || NeedsSecureDelete<br />
|}<br />
<br />
= SaveDataMetaType =<br />
This is "nn::fs::SaveDataMetaType".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || None<br />
|-<br />
| 1 || Thumbnail<br />
|-<br />
| 2 || ExtensionContext<br />
|}<br />
<br />
= ImageDirectoryId =<br />
This is "nn::fs::ImageDirectoryId".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Nand<br />
|-<br />
| 1 || SdCard<br />
|}<br />
<br />
= CloudBackupWorkStorageId =<br />
This is "nn::fs::CloudBackupWorkStorageId".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Nand<br />
|-<br />
| 1 || SdCard<br />
|}<br />
<br />
= CustomStorageId =<br />
This is "nn::fs::CustomStorageId".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || System<br />
|-<br />
| 1 || SdCard<br />
|}<br />
<br />
= Priority =<br />
This is "nn::fs::Priority".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Realtime<br />
|-<br />
| 1 || Normal<br />
|-<br />
| 2 || Low<br />
|}<br />
<br />
= PriorityRaw =<br />
This is "nn::fs::PriorityRaw".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Realtime<br />
|-<br />
| 1 || Normal<br />
|-<br />
| 2 || Low<br />
|-<br />
| 3 || Background<br />
|}<br />
<br />
= AbortSpecifier =<br />
This is "nn::fs::AbortSpecifier".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Default<br />
|-<br />
| 1 || Abort<br />
|-<br />
| 2 || ReturnResult<br />
|}<br />
<br />
= OperationId =<br />
This is "nn::fs::OperationId".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Clear<br />
|-<br />
| 1 || ClearSignature<br />
|-<br />
| 2 || InvalidateCache<br />
|-<br />
| 3 || QueryRange<br />
|}<br />
<br />
= MountHostOption =<br />
This is "nn::fs::MountHostOption".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 1 || PseudoCaseSensitive<br />
|}<br />
<br />
= BisPartitionId =<br />
This is "nn::fs::BisPartitionId".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || BootPartition1Root<br />
|-<br />
| 10 || BootPartition2Root<br />
|-<br />
| 20 || UserDataRoot<br />
|-<br />
| 21 || BootConfigAndPackage2Part1<br />
|-<br />
| 22 || BootConfigAndPackage2Part2<br />
|-<br />
| 23 || BootConfigAndPackage2Part3<br />
|-<br />
| 24 || BootConfigAndPackage2Part4<br />
|-<br />
| 25 || BootConfigAndPackage2Part5<br />
|-<br />
| 26 || BootConfigAndPackage2Part6<br />
|-<br />
| 27 || CalibrationBinary<br />
|-<br />
| 28 || CalibrationFile<br />
|-<br />
| 29 || SafeMode<br />
|-<br />
| 30 || User<br />
|-<br />
| 31 || System<br />
|-<br />
| 32 || SystemProperEncryption<br />
|-<br />
| 33 || SystemProperPartition<br />
|-<br />
| 34 || SignedSystemPartitionOnSafeMode<br />
|-<br />
| 35 || [16.0.0+] DeviceTreeBlob<br />
|-<br />
| 36 || [16.0.0+] System0<br />
|}<br />
<br />
= SdCardSpeedMode =<br />
This is "nn::fs::SdCardSpeedMode".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Identification<br />
|-<br />
| 1 || DefaultSpeed<br />
|-<br />
| 2 || HighSpeed<br />
|-<br />
| 3 || Sdr12<br />
|-<br />
| 4 || Sdr25<br />
|-<br />
| 5 || Sdr50<br />
|-<br />
| 6 || Sdr104<br />
|-<br />
| 7 || Ddr50<br />
|-<br />
| 8 || Unknown<br />
|}<br />
<br />
= MmcSpeedMode =<br />
This is "nn::fs::MmcSpeedMode".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Identification<br />
|-<br />
| 1 || LegacySpeed<br />
|-<br />
| 2 || HighSpeed<br />
|-<br />
| 3 || Hs200<br />
|-<br />
| 4 || Hs400<br />
|-<br />
| 5 || Unknown<br />
|}<br />
<br />
= MmcPartition =<br />
This is "nn::fs::MmcPartition".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || UserData<br />
|-<br />
| 1 || BootPartition1<br />
|-<br />
| 2 || BootPartition2<br />
|}<br />
<br />
= MemoryReportInfo =<br />
This is "nn::fs::MemoryReportInfo".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| PooledBufferFreeSizePeak<br />
|-<br />
| 0x8<br />
| 0x8<br />
| PooledBufferRetriedCount<br />
|-<br />
| 0x10<br />
| 0x8<br />
| PooledBufferReduceAllocationCount<br />
|-<br />
| 0x18<br />
| 0x8<br />
| BufferManagerFreeSizePeak<br />
|-<br />
| 0x20<br />
| 0x8<br />
| BufferManagerRetriedCount<br />
|-<br />
| 0x28<br />
| 0x8<br />
| ExpHeapFreeSizePeak<br />
|-<br />
| 0x30<br />
| 0x8<br />
| BufferPoolFreeSizePeak<br />
|-<br />
| 0x38<br />
| 0x8<br />
| PatrolReadAllocateBufferSuccessCount<br />
|-<br />
| 0x40<br />
| 0x8<br />
| PatrolReadAllocateBufferFailureCount<br />
|-<br />
| 0x48<br />
| 0x8<br />
| BufferManagerTotalAllocatableSizePeak<br />
|-<br />
| 0x50<br />
| 0x8<br />
| BufferPoolAllocateSizeMax<br />
|-<br />
| 0x58<br />
| 0x8<br />
| PooledBufferFailedIdealAllocationCountOnAsyncAccess<br />
|-<br />
| 0x60<br />
| 0x20<br />
| Reserved<br />
|}<br />
<br />
= StorageErrorInfo =<br />
This is "nn::fs::StorageErrorInfo".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| NumActivationFailures<br />
|-<br />
| 0x4<br />
| 0x4<br />
| NumActivationErrorCorrections<br />
|-<br />
| 0x8<br />
| 0x4<br />
| NumReadWriteFailures<br />
|-<br />
| 0xC<br />
| 0x4<br />
| NumReadWriteErrorCorrections<br />
|}<br />
<br />
= GameCardErrorInfo =<br />
This is "nn::fs::GameCardErrorInfo".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x2<br />
| GameCardCrcErrorCount<br />
|-<br />
| 0x2<br />
| 0x2<br />
| Reserved<br />
|-<br />
| 0x4<br />
| 0x2<br />
| AsicCrcErrorCount<br />
|-<br />
| 0x6<br />
| 0x2<br />
| Reserved<br />
|-<br />
| 0x8<br />
| 0x2<br />
| RefreshCount<br />
|-<br />
| 0xA<br />
| 0x2<br />
| Reserved<br />
|-<br />
| 0xC<br />
| 0x2<br />
| ReadRetryCount<br />
|-<br />
| 0xE<br />
| 0x2<br />
| TimeoutRetryErrorCount<br />
|}<br />
<br />
= GameCardErrorReportInfo =<br />
This is "nn::fs::GameCardErrorReportInfo".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| [[#GameCardErrorInfo|ErrorInfo]]<br />
|-<br />
| 0x10<br />
| 0x2<br />
| AsicReinitializeFailureDetail<br />
|-<br />
| 0x12<br />
| 0x2<br />
| InsertionCount<br />
|-<br />
| 0x14<br />
| 0x2<br />
| RemovalCount<br />
|-<br />
| 0x16<br />
| 0x2<br />
| AsicReinitializeCount<br />
|-<br />
| 0x18<br />
| 0x4<br />
| AsicInitializeCount<br />
|-<br />
| 0x1C<br />
| 0x2<br />
| AsicReinitializeFailureCount<br />
|-<br />
| 0x1E<br />
| 0x2<br />
| AwakenFailureCount<br />
|-<br />
| 0x20<br />
| 0x2<br />
| Reserved<br />
|-<br />
| 0x22<br />
| 0x2<br />
| RefreshCount<br />
|-<br />
| 0x24<br />
| 0x4<br />
| LastReadErrorPageAddress<br />
|-<br />
| 0x28<br />
| 0x4<br />
| LastReadErrorPageCount<br />
|-<br />
| 0x2C<br />
| 0x4<br />
| AwakenCount<br />
|-<br />
| 0x30<br />
| 0x4<br />
| ReadCountFromInsert<br />
|-<br />
| 0x34<br />
| 0x4<br />
| ReadCountFromAwaken<br />
|-<br />
| 0x38<br />
| 0x8<br />
| Reserved <br />
|}<br />
<br />
= GameCardHandle =<br />
This is "nn::fs::GameCardHandle". This is an u32. <br />
<br />
= GameCardPartition =<br />
This is "nn::fs::GameCardPartition".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Update<br />
|-<br />
| 1 || Normal<br />
|-<br />
| 2 || Secure<br />
|-<br />
| 3 || [4.0.0+] Logo<br />
|}<br />
<br />
= GameCardPartitionRaw =<br />
This is "nn::fs::GameCardPartitionRaw".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || NormalReadOnly<br />
|-<br />
| 1 || SecureReadOnly<br />
|-<br />
| 2 || RootWriteOnly<br />
|}<br />
<br />
= GameCardAttribute =<br />
This is "nn::fs::GameCardAttribute".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 1 || AutoBootFlag<br />
|-<br />
| 2 || HistoryEraseFlag<br />
|-<br />
| 4 || [4.0.0+] RepairToolFlag<br />
|-<br />
| 8 || [9.0.0+] DifferentRegionCupToTerraDeviceFlag<br />
|-<br />
| 16 || [9.0.0+] DifferentRegionCupToGlobalDeviceFlag<br />
|}<br />
<br />
= GameCardSize =<br />
This is "nn::fs::GameCardSize".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 1 || Size1GB<br />
|-<br />
| 2 || Size2GB<br />
|-<br />
| 4 || Size4GB<br />
|-<br />
| 8 || Size8GB<br />
|-<br />
| 16 || Size16GB<br />
|-<br />
| 32 || Size32GB<br />
|}<br />
<br />
= GameCardClockRate =<br />
This is "nn::fs::GameCardClockRate".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 25 || ClockRate25MHz<br />
|-<br />
| 50 || ClockRate50MHz<br />
|}<br />
<br />
= GameCardCompatibilityType =<br />
This is "nn::fs::GameCardCompatibilityType".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || Global<br />
|-<br />
| 1 || China<br />
|}<br />
<br />
= GameCardUpdatePartitionInfo =<br />
This is "nn::fs::GameCardUpdatePartitionInfo".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Id<br />
|}<br />
<br />
= GameCardIdSet =<br />
This is "nn::gc::GameCardIdSet".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| [[#CardId1|Id1]]<br />
|-<br />
| 0x4<br />
| 0x4<br />
| [[#CardId2|Id2]]<br />
|-<br />
| 0x8<br />
| 0x4<br />
| [[#CardId3|Id3]]<br />
|}<br />
<br />
= CardId1 =<br />
This is "nn::gc::detail::CardId1".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| [[#MakerCodeForCardId1|MakerCode]]<br />
|-<br />
| 0x1<br />
| 0x1<br />
| [[#MemoryCapacity|MemoryCapacity]]<br />
|-<br />
| 0x2<br />
| 0x1<br />
| Reserved<br />
|-<br />
| 0x3<br />
| 0x1<br />
| MemoryType<br />
|}<br />
<br />
= CardId2 =<br />
This is "nn::gc::detail::CardId2".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| CardSecurityNumber<br />
|-<br />
| 0x1<br />
| 0x1<br />
| CardType<br />
|-<br />
| 0x2<br />
| 0x2<br />
| Reserved<br />
|}<br />
<br />
= CardId3 =<br />
This is "nn::gc::detail::CardId3".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
= MakerCodeForCardId1 =<br />
This is "nn::gc::detail::MakerCodeForCardId1".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0x36 || Unknown<br />
|-<br />
| 0xC2 || MegaChips<br />
|-<br />
| 0xAE || Lapis<br />
|}<br />
<br />
= MemoryCapacity =<br />
This is "nn::gc::detail::MemoryCapacity".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0xFA || 1GB<br />
|-<br />
| 0xF8 || 2GB<br />
|-<br />
| 0xF0 || 4GB<br />
|-<br />
| 0xE0 || 8GB<br />
|-<br />
| 0xE1 || 16GB<br />
|-<br />
| 0xE2 || 32GB<br />
|}<br />
<br />
= RmaInformation =<br />
This is "nn::gc::RmaInformation". This is a 0x200-byte struct.<br />
<br />
= SimulatingDeviceType =<br />
This is "nn::fs::SimulatingDeviceType".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || eMMC<br />
|-<br />
| 1 || SdCard<br />
|-<br />
| 2 || GameCard<br />
|}<br />
<br />
= SimulatingDeviceDetectionMode =<br />
This is "nn::fs::SimulatingDeviceDetectionMode".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || NoSimulation<br />
|-<br />
| 1 || DeviceAttached<br />
|-<br />
| 2 || DeviceRemoved<br />
|}<br />
<br />
= SimulatingDeviceAccessFailureEventType =<br />
This is "nn::fs::SimulatingDeviceAccessFailureEventType".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || None<br />
|-<br />
| 1 || AccessTimeoutFailure<br />
|-<br />
| 2 || AccessFailure<br />
|-<br />
| 3 || DataCorruption<br />
|}<br />
<br />
= SimulatingDeviceTargetOperation =<br />
This is "nn::fs::SimulatingDeviceTargetOperation".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 1 || Read<br />
|-<br />
| 2 || Write<br />
|}<br />
<br />
= SpeedEmulationMode =<br />
This is "nn::fs::SpeedEmulationMode".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Name<br />
|-<br />
| 0 || None<br />
|-<br />
| 1 || Faster<br />
|-<br />
| 2 || Slower<br />
|-<br />
| 3 || Random<br />
|}<br />
<br />
= FspPath =<br />
This is "nn::fssrv::sf::FspPath". This is a 0x301-byte string.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Path || Notes<br />
|-<br />
| @SystemContent ||<br />
|- <br />
| @UserContent ||<br />
|-<br />
| @SdCardContent ||<br />
|-<br />
| @CalibFile ||<br />
|-<br />
| @Safe ||<br />
|-<br />
| @User ||<br />
|-<br />
| @System ||<br />
|-<br />
| @Sdcard ||<br />
|-<br />
| @Host ||<br />
|-<br />
| @GcApp || Gamecard App partition (Partition 2)<br />
|-<br />
| @GcXYYYYYYYY || Gamecard Contents. X is the partition type (U - Update, N - Normal, S - Secure). Y is the gamecard handle as a 32-bit hex value <br />
|-<br />
| @upp || Gamecard update partition (Partition 0)<br />
|-<br />
| [4.0.0+] @RegUpdate || Registered update partition<br />
|}<br />
<br />
= SaveDataAttribute =<br />
This is "nn::fs::SaveDataAttribute".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| [[NCM_services#ApplicationId|ApplicationId]] (0 for SystemSaveData)</br>SaveData: 0 can be used for accessing the savedata associated with the current FS session [[NCM_services#ApplicationId|ApplicationId]], otherwise when set this is the [[NCM_services#ApplicationId|ApplicationId]] associated with the savedata to access.<br />
|-<br />
| 0x8<br />
| 0x10<br />
| UserId</br>For user-specific savedata(saveuser) when set, otherwise when zero this indicates the common savedata(savecommon). This is loaded from [[Account_services]].<br />
|-<br />
| 0x18<br />
| 0x8<br />
| [[Flash_Filesystem|SystemSaveDataId]] (0 for SaveData)<br />
|-<br />
| 0x20<br />
| 0x1<br />
| [[#SaveDataType]]<br />
|-<br />
| 0x21<br />
| 0x1<br />
| [[#SaveDataRank]]<br />
|-<br />
| 0x22<br />
| 0x2<br />
| SaveDataIndex<br />
|-<br />
| 0x24<br />
| 0x4<br />
| Padding<br />
|-<br />
| 0x28<br />
| 0x8<br />
| 0 for SystemSaveData/SaveData.<br />
|-<br />
| 0x30<br />
| 0x8<br />
| 0 for SystemSaveData/SaveData.<br />
|-<br />
| 0x38<br />
| 0x8<br />
| 0 for SystemSaveData/SaveData.<br />
|}<br />
<br />
Total size is 0x40-bytes.<br />
<br />
For DeviceSaveData, this struct is all-zero except for the [[#SaveDataType]] field (and optionally the ApplicationId if specified).<br />
<br />
= SaveDataCreationInfo =<br />
This is "nn::fs::SaveDataCreationInfo".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| SaveDataSize<br />
|-<br />
| 0x8<br />
| 0x8<br />
| JournalSize<br />
|-<br />
| 0x10<br />
| 0x8<br />
| AvailableSize</br>0x4000 for SystemSaveData/SaveData/DeviceSaveData/BcatSaveData.<br />
|-<br />
| 0x18<br />
| 0x8<br />
| OwnerId</br>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 [[NCM_services#ProgramId|ProgramId]] of the bcat-sysmodule.<br />
|-<br />
| 0x20<br />
| 0x4<br />
| [[#SaveDataFlags]]</br>Written using an input param for official user-processes. Hard-coded 0 for BcatSaveData.<br />
|-<br />
| 0x24<br />
| 0x1<br />
| [[#SaveDataSpaceId]]</br>Official user-processes only uses 0 here for SystemSaveData, 1 for SaveData/DeviceSaveData/BcatSaveData.<br />
|-<br />
| 0x25<br />
| 0x1<br />
| Unknown. 0 for SystemSaveData/SaveData.<br />
|-<br />
| 0x26<br />
| 0x1A<br />
| Not initialized for SystemSaveData/SaveData.<br />
|}<br />
<br />
Total size is 0x40-bytes.<br />
<br />
= DeviceSaveData =<br />
This is accessed using the same commands for SaveData with the same input u8, the only difference compared to SaveData is the [[#SaveDataAttribute]].<br />
<br />
= BcatSaveData =<br />
This is accessed using the same commands for SaveData with the same input u8. The [[#SaveDataAttribute]] is the same as DeviceSaveData (besides the SaveDataType), except that the [[NCM_services#ApplicationId|ApplicationId]] field is always set to <input ApplicationId> (unlike DeviceSaveData where it's optional). See above regarding [[#SaveDataCreationInfo]].<br />
<br />
The 0x10-byte struct passed to [[#CreateSaveDataFileSystem]] has the first 0x5-bytes set to all-zero.<br />
<br />
MountSystemBcatSaveData uses [[#OpenSaveDataFileSystemBySystemSaveDataId]] with [[#SaveDataSpaceId]] System. The [[#SaveDataAttribute]] is all-zero, except for the SaveDataType, and SystemSaveDataId is set to the input param.<br />
<br />
= SaveDataInfo =<br />
This is "nn::fs::SaveDataInfo".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| SaveDataId<br />
|-<br />
| 0x8<br />
| 0x1<br />
| [[#SaveDataSpaceId]]<br />
|-<br />
| 0x9<br />
| 0x1<br />
| [[#SaveDataType]]<br />
|-<br />
| 0xA<br />
| 0x6<br />
| Padding?<br />
|-<br />
| 0x10<br />
| 0x10<br />
| UserId<br />
|-<br />
| 0x20<br />
| 0x8<br />
| SystemSaveDataId (0 for regular SaveData)<br />
|-<br />
| 0x28<br />
| 0x8<br />
| [[NCM_services#ApplicationId|ApplicationId]] (for regular SaveData)<br />
|-<br />
| 0x30<br />
| 0x8<br />
| Raw saveimage size<br />
|-<br />
| 0x38<br />
| 0x2<br />
| SaveDataIndex<br />
|-<br />
| 0x3A<br />
| 0x1<br />
| [[#SaveDataRank]]<br />
|-<br />
| 0x3B<br />
| 0x25<br />
| Unknown. Usually zeros?<br />
|}<br />
<br />
This is a 0x60-byte struct.<br />
<br />
= SaveDataFileSystemExtraData =<br />
This is a 0x200-byte struct. Appears to match [[Savegames#Extra_data]].<br />
<br />
= InitialDataVersion2 =<br />
This is a 0x8210-byte struct used by [[#ISaveDataTransferManagerWithDivision]].<br />
<br />
[[Category:Services]]</div>
Liam
https://switchbrew.org/w/index.php?title=NPDM&diff=11669
NPDM
2022-04-18T20:10:31Z
<p>Liam: </p>
<hr />
<div>This is the Switch equivalent of 3DS [https://www.3dbrew.org/wiki/NCCH/Extended_Header exheader]. This is the file with extension ".npdm" in {Switch ExeFS}. The size of this file varies.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x80<br />
| [[#META|META]]<br />
|-<br />
| 0x80<br />
| <Varies><br />
| [[#ACID|ACID]]<br />
|-<br />
| <See META><br />
| <See META><br />
| [[#ACI0|ACI0]]<br />
|}<br />
<br />
= META =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magic ("META")<br />
|-<br />
| 0x4<br />
| 0x4<br />
| [9.0.0+] SignatureKeyGeneration<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[#Flags|Flags]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Reserved<br />
|-<br />
| 0xE<br />
| 0x1<br />
| [[#MainThreadPriority|MainThreadPriority]]<br />
|-<br />
| 0xF<br />
| 0x1<br />
| MainThreadCoreNumber<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x14<br />
| 0x4<br />
| [3.0.0+] [[#SystemResourceSize|SystemResourceSize]]<br />
|-<br />
| 0x18<br />
| 0x4<br />
| [[#Version|Version]]<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| [[#MainThreadStackSize|MainThreadStackSize]]<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Name (usually/always "Application")<br />
|-<br />
| 0x30<br />
| 0x10<br />
| ProductCode (usually/always all zeroes)<br />
|-<br />
| 0x40<br />
| 0x30<br />
| Reserved<br />
|-<br />
| 0x70<br />
| 0x4<br />
| [[#ACI0|AciOffset]]<br />
|-<br />
| 0x74<br />
| 0x4<br />
| [[#ACI0|AciSize]]<br />
|-<br />
| 0x78<br />
| 0x4<br />
| [[#ACID|AcidOffset]]<br />
|-<br />
| 0x7C<br />
| 0x4<br />
| [[#ACID|AcidSize]]<br />
|}<br />
<br />
== Flags ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 0<br />
| Is64BitInstruction<br />
|-<br />
| 1-3<br />
| ProcessAddressSpace (0x00 = AddressSpace32Bit, 0x01 = AddressSpace64BitOld, 0x02 = AddressSpace32BitNoReserved, 0x03 = AddressSpace64Bit)<br />
|-<br />
| 4<br />
| [7.0.0+] OptimizeMemoryAllocation<br />
|-<br />
| 5<br />
| [11.0.0+] DisableDeviceAddressSpaceMerge<br />
|}<br />
<br />
== MainThreadPriority ==<br />
Ranges from 0 to 0x3F.<br />
<br />
== SystemResourceSize ==<br />
This is the size of PersonalMmHeap. Maximum size as of 5.0.0 is 0x1FE00000.<br />
<br />
== Version ==<br />
0 for all titles.<br />
<br />
[8.1.0+] Now set to 1 for certain titles.<br />
<br />
[9.0.0+] Now set to a proper version field for all titles.<br />
<br />
== MainThreadStackSize ==<br />
Must be aligned to 0x1000.<br />
<br />
In non-nspwn scenarios, values of 0 can also rarely break in Horizon. This might be something auto-adapting or a security feature of some sort?<br />
<br />
= ACID =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x100<br />
| RSA-2048 signature over the data starting at 0x100 with the size field from 0x204<br />
|-<br />
| 0x100<br />
| 0x100<br />
| RSA-2048 public key for the second [[NCA_Format|NCA]] signature<br />
|-<br />
| 0x200<br />
| 0x4<br />
| Magic ("ACID")<br />
|-<br />
| 0x204<br />
| 0x4<br />
| Size<br />
|-<br />
| 0x208<br />
| 0x1<br />
| [9.0.0+] Version<br />
|-<br />
| 0x209<br />
| 0x1<br />
| [14.0.0+] <br />
|-<br />
| 0x20A<br />
| 0x2<br />
| Reserved<br />
|-<br />
| 0x20C<br />
| 0x4<br />
| [[#Flags_2|Flags]]<br />
|-<br />
| 0x210<br />
| 0x8<br />
| ProgramIdMin<br />
|-<br />
| 0x218<br />
| 0x8<br />
| ProgramIdMax<br />
|-<br />
| 0x220<br />
| 0x4<br />
| [[#FsAccessControl|FacOffset]]<br />
|-<br />
| 0x224<br />
| 0x4<br />
| [[#FsAccessControl|FacSize]]<br />
|-<br />
| 0x228<br />
| 0x4<br />
| [[#SrvAccessControl|SacOffset]]<br />
|-<br />
| 0x22C<br />
| 0x4<br />
| [[#SrvAccessControl|SacSize]]<br />
|-<br />
| 0x230<br />
| 0x4<br />
| [[#KernelCapability|KcOffset]]<br />
|-<br />
| 0x234<br />
| 0x4<br />
| [[#KernelCapability|KcSize]]<br />
|-<br />
| 0x238<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
== Flags ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 0<br />
| ProductionFlag<br />
|-<br />
| 1<br />
| UnqualifiedApproval<br />
|-<br />
| 2-5<br />
| [5.0.0+] MemoryRegion (0 = Application, 1 = Applet, 2 = SecureSystem, 3 = NonSecureSystem)<br />
|}<br />
<br />
MemoryRegion is set to Application for "starter" and NonSecureSystem for "nvservices".<br />
<br />
= ACI0 =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magic ("ACI0")<br />
|-<br />
| 0x4<br />
| 0xC<br />
| Reserved<br />
|-<br />
| 0x10<br />
| 0x8<br />
| ProgramId<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Reserved<br />
|-<br />
| 0x20<br />
| 0x4<br />
| [[#FsAccessControl|FacOffset]]<br />
|-<br />
| 0x24<br />
| 0x4<br />
| [[#FsAccessControl|FacSize]]<br />
|-<br />
| 0x28<br />
| 0x4<br />
| [[#SrvAccessControl|SacOffset]]<br />
|-<br />
| 0x2C<br />
| 0x4<br />
| [[#SrvAccessControl|SacSize]]<br />
|-<br />
| 0x30<br />
| 0x4<br />
| [[#KernelCapability|KcOffset]]<br />
|-<br />
| 0x34<br />
| 0x4<br />
| [[#KernelCapability|KcSize]]<br />
|-<br />
| 0x38<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
= FsAccessControl =<br />
For [[#ACID|ACID]] this is a simple descriptor as follows:<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| Version (always 1, must be non-zero)<br />
|-<br />
| 0x1<br />
| 0x1<br />
| [5.0.0+] ContentOwnerIdCount<br />
|-<br />
| 0x2<br />
| 0x1<br />
| [5.0.0+] SaveDataOwnerIdCount<br />
|-<br />
| 0x3<br />
| 0x1<br />
| Padding<br />
|-<br />
| 0x4<br />
| 0x8<br />
| [[#FsAccessFlag|FsAccessFlag]]<br />
|-<br />
| 0xC<br />
| 0x8<br />
| ContentOwnerIdMin<br />
|-<br />
| 0x14<br />
| 0x8<br />
| ContentOwnerIdMax<br />
|-<br />
| 0x1C<br />
| 0x8<br />
| SaveDataOwnerIdMin<br />
|-<br />
| 0x24<br />
| 0x8<br />
| SaveDataOwnerIdMax<br />
|-<br />
| 0x2C<br />
| 0x8 * ContentOwnerIdCount<br />
| [5.0.0+] ContentOwnerIds<br />
|-<br />
| Variable<br />
| 0x8 * SaveDataOwnerIdCount<br />
| [5.0.0+] SaveDataOwnerIds<br />
|}<br />
<br />
For [[#ACI0|ACI0]] this embeds data as follows:<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| Version (always 1, must be non-zero)<br />
|-<br />
| 0x1<br />
| 0x3<br />
| Padding<br />
|-<br />
| 0x4<br />
| 0x8<br />
| [[#FsAccessFlag|FsAccessFlag]]<br />
|-<br />
| 0xC<br />
| 0x4<br />
| ContentOwnerInfoOffset<br />
|-<br />
| 0x10<br />
| 0x4<br />
| ContentOwnerInfoSize<br />
|-<br />
| 0x14<br />
| 0x4<br />
| SaveDataOwnerInfoOffset<br />
|-<br />
| 0x18<br />
| 0x4<br />
| SaveDataOwnerInfoSize<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| (Optional) ContentOwnerIdCount<br />
|-<br />
| 0x1C<br />
| 0x8 * ContentOwnerIdCount<br />
| ContentOwnerIds<br />
|-<br />
| Variable<br />
| 0x4<br />
| SaveDataOwnerIdCount<br />
|-<br />
| Variable<br />
| 0x1 * SaveDataOwnerIdCount<br />
| Accessibilities (1=Read, 2=Write, 3=ReadWrite)<br />
|-<br />
| Variable (padded to nearest 4 bytes)<br />
| 0x8 * SaveDataOwnerIdCount<br />
| SaveDataOwnerIds<br />
|}<br />
<br />
== FsAccessFlag ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Name<br />
! Description<br />
|-<br />
| 0<br />
| ApplicationInfo<br />
| MountContent* is accessible when set.<br />
|-<br />
| 1<br />
| BootModeControl<br />
| <br />
|-<br />
| 2<br />
| Calibration<br />
| <br />
|-<br />
| 3<br />
| SystemSaveData<br />
| <br />
|-<br />
| 4<br />
| GameCard<br />
| <br />
|-<br />
| 5<br />
| SaveDataBackUp<br />
| <br />
|-<br />
| 6<br />
| SaveDataManagement<br />
| <br />
|-<br />
| 7<br />
| BisAllRaw<br />
| <br />
|-<br />
| 8<br />
| GameCardRaw<br />
| <br />
|-<br />
| 9<br />
| GameCardPrivate<br />
| <br />
|-<br />
| 10<br />
| SetTime<br />
| <br />
|-<br />
| 11<br />
| ContentManager<br />
| <br />
|-<br />
| 12<br />
| ImageManager<br />
| <br />
|-<br />
| 13<br />
| CreateSaveData<br />
| <br />
|-<br />
| 14<br />
| SystemSaveDataManagement<br />
| <br />
|-<br />
| 15<br />
| BisFileSystem<br />
| <br />
|-<br />
| 16<br />
| SystemUpdate<br />
| <br />
|-<br />
| 17<br />
| SaveDataMeta<br />
| <br />
|-<br />
| 18<br />
| DeviceSaveData<br />
| <br />
|-<br />
| 19<br />
| SettingsControl<br />
| <br />
|-<br />
| 20<br />
| SystemData<br />
| <br />
|-<br />
| 21<br />
| SdCard<br />
| <br />
|-<br />
| 22<br />
| Host<br />
| <br />
|-<br />
| 23<br />
| FillBis<br />
| <br />
|-<br />
| 24<br />
| CorruptSaveData<br />
| <br />
|-<br />
| 25<br />
| SaveDataForDebug<br />
| <br />
|-<br />
| 26<br />
| FormatSdCard<br />
| <br />
|-<br />
| 27<br />
| GetRightsId<br />
| <br />
|-<br />
| 28<br />
| RegisterExternalKey<br />
| <br />
|-<br />
| 29<br />
| RegisterUpdatePartition<br />
| <br />
|-<br />
| 30<br />
| SaveDataTransfer<br />
| <br />
|-<br />
| 31<br />
| DeviceDetection<br />
|<br />
|-<br />
| 32<br />
| AccessFailureResolution<br />
| <br />
|-<br />
| 33<br />
| SaveDataTransferVersion2<br />
| <br />
|-<br />
| 34<br />
| RegisterProgramIndexMapInfo<br />
| <br />
|-<br />
| 35<br />
| CreateOwnSaveData<br />
| <br />
|-<br />
| 36<br />
| MoveCacheStorage<br />
| <br />
|-<br />
| 37-61<br />
| Reserved<br />
| <br />
|-<br />
| 62<br />
| Debug<br />
| See [[SPL_services#GetConfig|here]].<br />
|-<br />
| 63<br />
| FullPermission<br />
| Enables access to everything: all [[Filesystem_services#Permissions|permission types]] which check a bitmask have this bit set.<br />
|}<br />
<br />
Controls the [[Filesystem_services#Permissions|filesystem permissions]].<br />
<br />
Web-applets permissions:<br />
* "LibAppletWeb" and "LibAppletOff" have same access control: bit0 and bit3 set, and bit62 set.<br />
* Rest of the web-applets: Same as above except bit0 isn't set.<br />
<br />
= Service Access Control =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 0-2<br />
| Size (length of the service-name without null-terminator minus 1)<br />
|-<br />
| 7<br />
| IsServer (service is allowed to be registered)<br />
|-<br />
| Variable<br />
| Name<br />
|}<br />
<br />
This is a list of [[Services_API|service]]-name strings which the title has access to.<br />
<br />
The service name string starts after the first byte and supports the wildcard <code>*</code> character.<br />
<br />
= KernelCapability =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Pattern of lower bits<br />
! Lowest clear bitmask/bit<br />
! Description<br />
|-<br />
| <code>0bxxxxxxxxxxxx0111</code><br />
| Bit3<br />
| [[#ThreadInfo]]<br />
|-<br />
| <code>0bxxxxxxxxxxx01111</code><br />
| Bit4<br />
| [[#EnableSystemCalls]]<br />
|-<br />
| <code>0bxxxxxxxxx0111111</code><br />
| Bit6<br />
| [[#MemoryMap]]<br />
|-<br />
| <code>0bxxxxxxxx01111111</code><br />
| Bit7<br />
| [[#IoMemoryMap]]<br />
|-<br />
| <code>0bxxxxx01111111111</code><br />
| Bit10<br />
| [8.0.0+] [[#MemoryRegionMap]]<br />
|-<br />
| <code>0bxxxx011111111111</code><br />
| Bit11<br />
| [[#EnableInterrupts]]<br />
|-<br />
| <code>0bxx01111111111111</code><br />
| Bit13<br />
| [[#MiscParams]]<br />
|-<br />
| <code>0bx011111111111111</code><br />
| Bit14<br />
| [[#KernelVersion]]<br />
|-<br />
| <code>0b0111111111111111</code><br />
| Bit15<br />
| [[#HandleTableSize]]<br />
|-<br />
| <code>0b1111111111111111</code><br />
| Bit16<br />
| [[#MiscFlags]]<br />
|-<br />
| All ones<br />
| <br />
| Invalid<br />
|}<br />
<br />
These descriptors are identified by pattern 01..11 in low bits.<br />
<br />
== ThreadInfo ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 4-9<br />
| LowestPriority<br />
|-<br />
| 10-15<br />
| HighestPriority<br />
|-<br />
| 16-23<br />
| MinCoreNumber<br />
|-<br />
| 24-31<br />
| MaxCoreNumber<br />
|}<br />
<br />
== EnableSystemCalls ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 5-28<br />
| SystemCallId<br />
|-<br />
| 29-31<br />
| Index<br />
|}<br />
<br />
== MemoryMap ==<br />
MemoryMap entries are stored in pairs. The first pair will contain BeginAddress and PermissionType, while the second pair will contain Size and MappingType.<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 7-30<br />
| BeginAddress<br />
|-<br />
| 31<br />
| PermissionType (0=RW, 1=RO)<br />
|}<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 7-26<br />
| Size<br />
|-<br />
| 27-30<br />
| Reserved<br />
|-<br />
| 31<br />
| MappingType (0=Io, 1=Static)<br />
|}<br />
<br />
=== Restrictions ===<br />
The physaddr range 0x80060000-0x2000000000 is not allowed to be mapped as IO.<br />
The physaddr range 0x80000000-0x2000000000 is not allowed to be mapped as Normal.<br />
<br />
[2.0.0-4.1.0] The range for IO was changed into 0x80060000-0x81D3FFFF.<br />
<br />
[2.0.0-4.1.0] A blacklist was added for IO and Normal mappings:<br />
* 0x50040000-0x50060000 (ARM, Interrupt Controller)<br />
* 0x6000F000 (Exception Vectors)<br />
* 0x6001DC00-0x6001E000 (IPATCH)<br />
* 0x7000E000 (RTC/PMC)<br />
* 0x70019000 (MC)<br />
* 0x7001C000 (MC0)<br />
* 0x7001D000 (MC1)<br />
<br />
[5.0.0+] For IO, this blacklist was abandoned and instead two range checks were added. For Normal mappings it is still applied<br />
<br />
== IoMemoryMap ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 8-31<br />
| BeginAddress<br />
|}<br />
<br />
== MemoryRegionMap ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 11-16<br />
| RegionType0 (0 = NoMapping, 1 = KernelTraceBuffer, 2 = OnMemoryBootImage, 3 = DTB)<br />
|-<br />
| 17<br />
| RegionIsReadOnly0<br />
|-<br />
| 18-23<br />
| RegionType1 (0 = NoMapping, 1 = KernelTraceBuffer, 2 = OnMemoryBootImage, 3 = DTB)<br />
|-<br />
| 24<br />
| RegionIsReadOnly1<br />
|-<br />
| 25-30<br />
| RegionType2 (0 = NoMapping, 1 = KernelTraceBuffer, 2 = OnMemoryBootImage, 3 = DTB)<br />
|-<br />
| 31<br />
| RegionIsReadOnly2<br />
|}<br />
<br />
MemoryRegionMap is supported by the kernel but not by [[Loader_services|Loader]]. Thus, only initial processes may possess this capability.<br />
<br />
== EnableInterrupts ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 12-21<br />
| InterruptNumber0<br />
|-<br />
| 22-31<br />
| InterruptNumber1<br />
|}<br />
<br />
0x3FF means empty.<br />
<br />
== MiscParams ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 14-16<br />
| ProgramType (0 = System, 1 = Application, 2 = Applet)<br />
|}<br />
<br />
ProgramType is parsed by [[Process Manager services]]. Defaults to 0 if descriptor doesn't exist. Can only run 1 application at a time.<br />
<br />
== KernelVersion ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 15-18<br />
| MinorVersion<br />
|-<br />
| 19-31<br />
| MajorVersion<br />
|}<br />
<br />
This encodes the intended kernel version for the program.<br />
<br />
The kernel requires that the intended version is >= the minimum supported version (3.0 for all released kernels), and <= the current version.<br />
<br />
Kernel version is derived from/equivalent to SDK version:<br />
* Kernel Major = SDK Major + 4<br />
* Kernel Minor = SDK Minor<br />
<br />
=== Versions ===<br />
{| class="wikitable" border="1"<br />
|-<br />
! Firmware || Kernel Version || Corresponding SDK Version<br />
|-<br />
| 1.0.0 || 5.0 || 1.0.0.0<br />
|-<br />
| 2.0.0 || 6.1 || 2.1.0.0<br />
|-<br />
| 3.0.0 || 7.4 || 3.4.0.0<br />
|-<br />
| 3.0.2 || 7.4 || 3.4.0.0<br />
|-<br />
| 5.0.0 || 9.3 || 5.3.0.0<br />
|-<br />
| 10.0.0 || 14.4 || 10.4.0.0<br />
|-<br />
| 11.0.0 || 15.4 || 11.4.0.0<br />
|-<br />
| 11.0.1 || 15.4 || 11.4.0.0<br />
|}<br />
<br />
== HandleTableSize ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 16-25<br />
| HandleTableSize<br />
|}<br />
<br />
== MiscFlags ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 17<br />
| EnableDebug<br />
|-<br />
| 18<br />
| ForceDebug<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=XCI&diff=10815
XCI
2021-04-07T07:11:55Z
<p>Liam: </p>
<hr />
<div>This is the format used for storing the contents of a Nintendo Switch Gamecard.<br />
<br />
= Structure =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1000<br />
| [[#CardKeyArea]]<br />
|-<br />
| 0x1000<br />
| 0x200<br />
| [[#CardHeader]]<br />
|-<br />
| 0x1200<br />
| 0x6E00<br />
| ReservedArea<br />
|-<br />
| 0x8000<br />
| 0x8000<br />
| [[#CertArea]]<br />
|-<br />
| 0x10000<br />
| Variable<br />
| [[#NormalArea]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#RomArea]]<br />
|-<br />
| Invalid<br />
| Invalid<br />
| BackupArea<br />
|}<br />
<br />
== CardKeyArea ==<br />
This region cannot be read directly once written to the Gamecard. Therefore, it is hidden away during read/write operations on the raw Gamecard data.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x200<br />
| [[#InitialData]]<br />
|-<br />
| 0x200<br />
| 0xD00<br />
| [[#TitleKeyArea]]<br />
|-<br />
| 0xF00<br />
| 0x100<br />
| Reserved<br />
|}<br />
<br />
=== InitialData ===<br />
This region is used for challenge–response authentication when changing to the Gamecard's secure mode.<br />
<br />
[[Filesystem_services|FS]] calculates a SHA-256 hash over the whole 0x200 bytes and compares it with the hash stored at offset 0x160 in the [[#CardHeader]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Package ID from [[#CardHeader]] at offset 0x110<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Empty<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Challenge–response authentication data<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Challenge–response authentication MAC<br />
|-<br />
| 0x30<br />
| 0xC<br />
| Challenge–response authentication Nonce<br />
|-<br />
| 0x3C<br />
| 0x1C4<br />
| Reserved (must be empty)<br />
|}<br />
<br />
=== TitleKeyArea ===<br />
This region is stored encrypted and contains the title keys used by the [[#InitialData]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| TitleKey1<br />
|-<br />
| 0x8<br />
| 0x8<br />
| TitleKey2<br />
|-<br />
| 0x10<br />
| 0xCF0<br />
| Reserved<br />
|}<br />
<br />
== CardHeader ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x100<br />
| RSA-2048 PKCS #1 signature over the header (data from 0x100 to 0x200)<br />
|-<br />
| 0x100<br />
| 0x4<br />
| MagicCode ("HEAD")<br />
|-<br />
| 0x104<br />
| 0x4<br />
| RomAreaStartPageAddress (in Gamecard page units, which are 0x200 bytes)<br />
|-<br />
| 0x108<br />
| 0x4<br />
| BackupAreaStartPageAddress (always 0xFFFFFFFF)<br />
|-<br />
| 0x10C<br />
| 0x1<br />
| TitleKeyDecIndex (high nibble) and KekIndex (low nibble)<br />
|-<br />
| 0x10D<br />
| 0x1<br />
| [[#RomSize]]<br />
|-<br />
| 0x10E<br />
| 0x1<br />
| CardHeaderVersion<br />
|-<br />
| 0x10F<br />
| 0x1<br />
| [[#Flags]]<br />
|-<br />
| 0x110<br />
| 0x8<br />
| PackageId (used for challenge–response authentication)<br />
|-<br />
| 0x118<br />
| 0x4<br />
| ValidDataEndAddress (in Gamecard page units, which are 0x200 bytes)<br />
|-<br />
| 0x11C<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x120<br />
| 0x10<br />
| Iv (reversed)<br />
|-<br />
| 0x130<br />
| 0x8<br />
| PartitionFsHeaderAddress<br />
|-<br />
| 0x138<br />
| 0x8<br />
| PartitionFsHeaderSize<br />
|-<br />
| 0x140<br />
| 0x20<br />
| PartitionFsHeaderHash (SHA-256 hash of the [[#PartitionFsHeader]])<br />
|-<br />
| 0x160<br />
| 0x20<br />
| InitialDataHash (SHA-256 hash of the [[#InitialData]])<br />
|-<br />
| 0x180<br />
| 0x4<br />
| SelSec (0x01 = T1, 0x02 = T2)<br />
|-<br />
| 0x184<br />
| 0x4<br />
| SelT1Key (always 2)<br />
|-<br />
| 0x188<br />
| 0x4<br />
| SelKey (always 0)<br />
|-<br />
| 0x18C<br />
| 0x4<br />
| LimArea (in Gamecard page units, which are 0x200 bytes)<br />
|-<br />
| 0x190<br />
| 0x70<br />
| [[#CardInfo]]<br />
|}<br />
<br />
=== CardInfo ===<br />
This region is stored encrypted (AES-128-CBC).<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| FwVersion (0x00 = Development, 0x01 = Retail, [4.0.0+] 0x02 = Retail, [11.0.0+] 0x04 = Retail)<br />
|-<br />
| 0x8<br />
| 0x4<br />
| AccCtrl1 (0x00A10011 = 25MHz access, 0x00A10010 = 50MHz access)<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Wait1TimeRead (always 0x1388)<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Wait2TimeRead (always 0)<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Wait1TimeWrite (always 0)<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Wait2TimeWrite (always 0)<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| FwMode (the current SdkAddonVersion)<br />
|-<br />
| 0x20<br />
| 0x4<br />
| UppVersion<br />
|-<br />
| 0x24<br />
| 0x1<br />
| [9.0.0+] CompatibilityType (0x00 = Normal, 0x01 = Terra)<br />
|-<br />
| 0x25<br />
| 0x3<br />
| Empty<br />
|-<br />
| 0x28<br />
| 0x8<br />
| UppHash (SHA-256 hash of the [[#UpdatePartition]])<br />
|-<br />
| 0x30<br />
| 0x8<br />
| UppId (always 0x0100000000000816)<br />
|-<br />
| 0x38<br />
| 0x38<br />
| Empty<br />
|}<br />
<br />
=== RomSize ===<br />
[[Filesystem_services|FS]] retrieves this data as [[Filesystem_services#GameCardSize|GameCardSize]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value<br />
! Description<br />
|-<br />
| 0xFA<br />
| 1GB<br />
|-<br />
| 0xF8<br />
| 2GB<br />
|-<br />
| 0xF0<br />
| 4GB<br />
|-<br />
| 0xE0<br />
| 8GB<br />
|-<br />
| 0xE1<br />
| 16GB<br />
|-<br />
| 0xE2<br />
| 32GB<br />
|}<br />
<br />
=== Flags ===<br />
[[Filesystem_services|FS]] retrieves this data as [[Filesystem_services#GameCardAttribute|GameCardAttribute]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 0<br />
| AutoBoot<br />
|-<br />
| 1<br />
| HistoryErase<br />
|-<br />
| 2<br />
| [4.0.0+] RepairTool<br />
|-<br />
| 3<br />
| [9.0.0+] DifferentRegionCupToTerraDevice<br />
|-<br />
| 4<br />
| [9.0.0+] DifferentRegionCupToGlobalDevice<br />
|}<br />
<br />
== CertArea ==<br />
This is the Gamecard's unique certificate.<br />
<br />
[[Filesystem_services|FS]] retrieves this data with [[Filesystem_services#GetGameCardDeviceCertificate|GetGameCardDeviceCertificate]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x100<br />
| RSA-2048 PKCS #1 signature over the data from 0x100 to 0x200<br />
|-<br />
| 0x100<br />
| 0x4<br />
| MagicCode ("CERT")<br />
|-<br />
| 0x104<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x108<br />
| 0x1<br />
| KekIndex<br />
|-<br />
| 0x109<br />
| 0x7<br />
| Reserved<br />
|-<br />
| 0x110<br />
| 0x10<br />
| DeviceId<br />
|-<br />
| 0x120<br />
| 0x10<br />
| Iv<br />
|-<br />
| 0x130<br />
| 0xD0<br />
| Data (encrypted)<br />
|-<br />
| 0x200<br />
| 0x7E00<br />
| Reserved<br />
|}<br />
<br />
== NormalArea ==<br />
This region contains all non-secure partitions of the Gamecard file system.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#PartitionFsHeader|RootPartitionHeader]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#PartitionFsHeader|UpdatePartitionHeader]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#UpdatePartition|UpdatePartition]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [4.0.0+] [[#PartitionFsHeader|LogoPartitionHeader]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [4.0.0+] [[#LogoPartition|LogoPartition]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#PartitionFsHeader|NormalPartitionHeader]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#NormalPartition|NormalPartition]]<br />
|}<br />
<br />
=== UpdatePartition ===<br />
This partition contains .cnmt.nca + .nca files for the entire system update required to play the game. Launch day carts contain a full copy of 1.0 ncas, newer carts contain newer sysupdate NCAs etc.<br />
<br />
=== NormalPartition ===<br />
This partition contains the .cnmt.nca and the game icondata nca. This is presumably for future compatibility so that if a future update changes the cryptographic protocol for the secure partition. Game icon data can still be shown in the home menu on old firmwares.<br />
<br />
[4.0.0+] This partition is now empty.<br />
<br />
=== LogoPartition ===<br />
[4.0.0+] This partition now contains the contents of the [[#NormalPartition]].<br />
<br />
== RomArea ==<br />
This region contains all secure partitions of the Gamecard file system.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#PartitionFsHeader|SecurePartitionHeader]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#SecurePartition|SecurePartition]]<br />
|}<br />
<br />
=== SecurePartition ===<br />
This partition contains an identical copy of the .cnmt.nca and game icondata nca, as well as all other ncas required for the game.<br />
<br />
== PartitionFs ==<br />
This is the Gamecard file system which starts with magicnum "HFS0".<br />
<br />
=== PartitionFsHeader ===<br />
The "SHA-256 File System" or "HFS0" starts at offset 0x10000 in the Gamecard. The first 0x200 bytes act as a global header and represent the root partition which points to the other partitions ("normal", "logo", "update" and "secure").<br />
<br />
A hash for this header is stored at offset 0x140 in the [[#CardHeader]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| MagicCode ("HFS0")<br />
|-<br />
| 0x4<br />
| 0x4<br />
| FileCount<br />
|-<br />
| 0x8<br />
| 0x4<br />
| StringTableSize<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x10<br />
| X<br />
| [[#FileEntryTable]]<br />
|-<br />
| 0x10 + X<br />
| Y<br />
| StringTable<br />
|-<br />
| 0x10 + X + Y<br />
| Z<br />
| RawFileData<br />
|}<br />
<br />
==== FileEntryTable ====<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Offset of file in Data<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Size of file in Data<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Offset of filename in String Table<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Size of Hashed region of file (for HFS0s, this is the size of the pre-filedata portion, for NCAs this is usually 0x200)<br />
|-<br />
| 0x18<br />
| 8<br />
| Zero/Reserved<br />
|-<br />
| 0x20<br />
| 0x20<br />
| SHA-256 hash of the first (size of hashed region) bytes of filedata<br />
|}<br />
<br />
The string table is 00-padded to align the start of raw filedata with a sector/media unit boundary (usually?).</div>
Liam
https://switchbrew.org/w/index.php?title=XCI&diff=10814
XCI
2021-04-07T06:29:02Z
<p>Liam: </p>
<hr />
<div>This is the format used for storing the contents of a Nintendo Switch Gamecard.<br />
<br />
= Structure =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1000<br />
| [[#CardKeyArea]]<br />
|-<br />
| 0x1000<br />
| 0x200<br />
| [[#CardHeader]]<br />
|-<br />
| 0x1200<br />
| 0x6E00<br />
| ReservedArea<br />
|-<br />
| 0x8000<br />
| 0x8000<br />
| [[#CertArea]]<br />
|-<br />
| 0x10000<br />
| Variable<br />
| [[#NormalArea]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#RomArea]]<br />
|-<br />
| Invalid<br />
| Invalid<br />
| BackupArea<br />
|}<br />
<br />
== CardKeyArea ==<br />
This region cannot be read directly once written to the Gamecard. Therefore, it is hidden away during read/write operations on the raw Gamecard data.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x200<br />
| [[#InitialData]]<br />
|-<br />
| 0x200<br />
| 0xD00<br />
| [[#TitleKeyArea]]<br />
|-<br />
| 0xF00<br />
| 0x100<br />
| Reserved<br />
|}<br />
<br />
=== InitialData ===<br />
This region is used for challenge–response authentication when changing to the Gamecard's secure mode.<br />
<br />
[[Filesystem_services|FS]] calculates a SHA-256 hash over the whole 0x200 bytes and compares it with the hash stored at offset 0x160 in the [[#CardHeader]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Package ID from [[#CardHeader]] at offset 0x110<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Empty<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Challenge–response authentication data<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Challenge–response authentication MAC<br />
|-<br />
| 0x30<br />
| 0xC<br />
| Challenge–response authentication Nonce<br />
|-<br />
| 0x3C<br />
| 0x1C4<br />
| Reserved (must be empty)<br />
|}<br />
<br />
=== TitleKeyArea ===<br />
This region is stored encrypted and contains the title keys used by the [[#InitialData]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| TitleKey1<br />
|-<br />
| 0x8<br />
| 0x8<br />
| TitleKey2<br />
|-<br />
| 0x10<br />
| 0xCF0<br />
| Reserved<br />
|}<br />
<br />
== CardHeader ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x100<br />
| RSA-2048 PKCS #1 signature over the header (data from 0x100 to 0x200)<br />
|-<br />
| 0x100<br />
| 0x4<br />
| MagicCode ("HEAD")<br />
|-<br />
| 0x104<br />
| 0x4<br />
| RomAreaStartPageAddress (in Gamecard page units, which are 0x200 bytes)<br />
|-<br />
| 0x108<br />
| 0x4<br />
| BackupAreaStartPageAddress (always 0xFFFFFFFF)<br />
|-<br />
| 0x10C<br />
| 0x1<br />
| TitleKeyDecIndex (high nibble) and KekIndex (low nibble)<br />
|-<br />
| 0x10D<br />
| 0x1<br />
| [[#RomSize]]<br />
|-<br />
| 0x10E<br />
| 0x1<br />
| CardHeaderVersion<br />
|-<br />
| 0x10F<br />
| 0x1<br />
| [[#Flags]]<br />
|-<br />
| 0x110<br />
| 0x8<br />
| PackageId (used for challenge–response authentication)<br />
|-<br />
| 0x118<br />
| 0x8<br />
| ValidDataEndAddress (in Gamecard page units, which are 0x200 bytes)<br />
|-<br />
| 0x120<br />
| 0x10<br />
| Iv (reversed)<br />
|-<br />
| 0x130<br />
| 0x8<br />
| PartitionFsHeaderAddress<br />
|-<br />
| 0x138<br />
| 0x8<br />
| PartitionFsHeaderSize<br />
|-<br />
| 0x140<br />
| 0x20<br />
| PartitionFsHeaderHash (SHA-256 hash of the [[#PartitionFsHeader]])<br />
|-<br />
| 0x160<br />
| 0x20<br />
| InitialDataHash (SHA-256 hash of the [[#InitialData]])<br />
|-<br />
| 0x180<br />
| 0x4<br />
| SelSec (0x01 = T1, 0x02 = T2)<br />
|-<br />
| 0x184<br />
| 0x4<br />
| SelT1Key (always 2)<br />
|-<br />
| 0x188<br />
| 0x4<br />
| SelKey (always 0)<br />
|-<br />
| 0x18C<br />
| 0x4<br />
| LimArea (in Gamecard page units, which are 0x200 bytes)<br />
|-<br />
| 0x190<br />
| 0x70<br />
| [[#CardInfo]]<br />
|}<br />
<br />
=== CardInfo ===<br />
This region is stored encrypted (AES-128-CBC).<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| FwVersion (0x00 = Development, 0x01 = Retail, [4.0.0+] 0x02 = Retail, [11.0.0+] 0x04 = Retail)<br />
|-<br />
| 0x8<br />
| 0x4<br />
| AccCtrl1 (0x00A10011 = 25MHz access, 0x00A10010 = 50MHz access)<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Wait1TimeRead (always 0x1388)<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Wait2TimeRead (always 0)<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Wait1TimeWrite (always 0)<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Wait2TimeWrite (always 0)<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| FwMode (the current SdkAddonVersion)<br />
|-<br />
| 0x20<br />
| 0x4<br />
| UppVersion<br />
|-<br />
| 0x24<br />
| 0x1<br />
| [9.0.0+] CompatibilityType (0x00 = Normal, 0x01 = Terra)<br />
|-<br />
| 0x25<br />
| 0x3<br />
| Empty<br />
|-<br />
| 0x28<br />
| 0x8<br />
| UppHash (SHA-256 hash of the [[#UpdatePartition]])<br />
|-<br />
| 0x30<br />
| 0x8<br />
| UppId (always 0x0100000000000816)<br />
|-<br />
| 0x38<br />
| 0x38<br />
| Empty<br />
|}<br />
<br />
=== RomSize ===<br />
[[Filesystem_services|FS]] retrieves this data as [[Filesystem_services#GameCardSize|GameCardSize]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value<br />
! Description<br />
|-<br />
| 0xFA<br />
| 1GB<br />
|-<br />
| 0xF8<br />
| 2GB<br />
|-<br />
| 0xF0<br />
| 4GB<br />
|-<br />
| 0xE0<br />
| 8GB<br />
|-<br />
| 0xE1<br />
| 16GB<br />
|-<br />
| 0xE2<br />
| 32GB<br />
|}<br />
<br />
=== Flags ===<br />
[[Filesystem_services|FS]] retrieves this data as [[Filesystem_services#GameCardAttribute|GameCardAttribute]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 0<br />
| AutoBoot<br />
|-<br />
| 1<br />
| HistoryErase<br />
|-<br />
| 2<br />
| [4.0.0+] RepairTool<br />
|-<br />
| 3<br />
| [9.0.0+] DifferentRegionCupToTerraDevice<br />
|-<br />
| 4<br />
| [9.0.0+] DifferentRegionCupToGlobalDevice<br />
|}<br />
<br />
== CertArea ==<br />
This is the Gamecard's unique certificate.<br />
<br />
[[Filesystem_services|FS]] retrieves this data with [[Filesystem_services#GetGameCardDeviceCertificate|GetGameCardDeviceCertificate]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x100<br />
| RSA-2048 PKCS #1 signature over the data from 0x100 to 0x200<br />
|-<br />
| 0x100<br />
| 0x4<br />
| MagicCode ("CERT")<br />
|-<br />
| 0x104<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x108<br />
| 0x1<br />
| KekIndex<br />
|-<br />
| 0x109<br />
| 0x7<br />
| Reserved<br />
|-<br />
| 0x110<br />
| 0x10<br />
| DeviceId<br />
|-<br />
| 0x120<br />
| 0x10<br />
| Iv<br />
|-<br />
| 0x130<br />
| 0xD0<br />
| Data (encrypted)<br />
|-<br />
| 0x200<br />
| 0x7E00<br />
| Reserved<br />
|}<br />
<br />
== NormalArea ==<br />
This region contains all non-secure partitions of the Gamecard file system.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#PartitionFsHeader|RootPartitionHeader]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#PartitionFsHeader|UpdatePartitionHeader]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#UpdatePartition|UpdatePartition]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [4.0.0+] [[#PartitionFsHeader|LogoPartitionHeader]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [4.0.0+] [[#LogoPartition|LogoPartition]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#PartitionFsHeader|NormalPartitionHeader]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#NormalPartition|NormalPartition]]<br />
|}<br />
<br />
=== UpdatePartition ===<br />
This partition contains .cnmt.nca + .nca files for the entire system update required to play the game. Launch day carts contain a full copy of 1.0 ncas, newer carts contain newer sysupdate NCAs etc.<br />
<br />
=== NormalPartition ===<br />
This partition contains the .cnmt.nca and the game icondata nca. This is presumably for future compatibility so that if a future update changes the cryptographic protocol for the secure partition. Game icon data can still be shown in the home menu on old firmwares.<br />
<br />
[4.0.0+] This partition is now empty.<br />
<br />
=== LogoPartition ===<br />
[4.0.0+] This partition now contains the contents of the [[#NormalPartition]].<br />
<br />
== RomArea ==<br />
This region contains all secure partitions of the Gamecard file system.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#PartitionFsHeader|SecurePartitionHeader]]<br />
|-<br />
| Variable<br />
| Variable<br />
| [[#SecurePartition|SecurePartition]]<br />
|}<br />
<br />
=== SecurePartition ===<br />
This partition contains an identical copy of the .cnmt.nca and game icondata nca, as well as all other ncas required for the game.<br />
<br />
== PartitionFs ==<br />
This is the Gamecard file system which starts with magicnum "HFS0".<br />
<br />
=== PartitionFsHeader ===<br />
The "SHA-256 File System" or "HFS0" starts at offset 0x10000 in the Gamecard. The first 0x200 bytes act as a global header and represent the root partition which points to the other partitions ("normal", "logo", "update" and "secure").<br />
<br />
A hash for this header is stored at offset 0x140 in the [[#CardHeader]].<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| MagicCode ("HFS0")<br />
|-<br />
| 0x4<br />
| 0x4<br />
| FileCount<br />
|-<br />
| 0x8<br />
| 0x4<br />
| StringTableSize<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x10<br />
| X<br />
| [[#FileEntryTable]]<br />
|-<br />
| 0x10 + X<br />
| Y<br />
| StringTable<br />
|-<br />
| 0x10 + X + Y<br />
| Z<br />
| RawFileData<br />
|}<br />
<br />
==== FileEntryTable ====<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Offset of file in Data<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Size of file in Data<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Offset of filename in String Table<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Size of Hashed region of file (for HFS0s, this is the size of the pre-filedata portion, for NCAs this is usually 0x200)<br />
|-<br />
| 0x18<br />
| 8<br />
| Zero/Reserved<br />
|-<br />
| 0x20<br />
| 0x20<br />
| SHA-256 hash of the first (size of hashed region) bytes of filedata<br />
|}<br />
<br />
The string table is 00-padded to align the start of raw filedata with a sector/media unit boundary (usually?).</div>
Liam
https://switchbrew.org/w/index.php?title=CNMT&diff=9785
CNMT
2020-07-17T23:18:39Z
<p>Liam: </p>
<hr />
<div>This is the metadata file that ends in <code>".cnmt{.nca}"</code> or <code>"meta0.ncd"</code>. This seems to replace the TMD format.<br />
<br />
The official name for CNMT is "PackagedContentMeta".<br />
<br />
== Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#ContentMetaType|Content Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Reserved<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Extended Header Size<br />
|-<br />
| 0x10<br />
| 0x2<br />
| Content Count<br />
|-<br />
| 0x12<br />
| 0x2<br />
| Content Meta Count<br />
|-<br />
| 0x14<br />
| 0x1<br />
| Content Meta Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0x15<br />
| 0x3<br />
| Reserved<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Required Download System Version<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
== SystemUpdate Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Extended Data Size<br />
|}<br />
<br />
== Application Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Patch ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Required Application Version<br />
|}<br />
<br />
== Patch Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
== AddOnContent Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required Application Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
== Delta Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
== Packaged Content Info ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Hash<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Content ID<br />
|-<br />
| 0x30<br />
| 0x6<br />
| Size<br />
|-<br />
| 0x36<br />
| 0x1<br />
| Content Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x37<br />
| 0x1<br />
| ID Offset<br />
|}<br />
<br />
== Content Meta Info ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Content Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Content Meta Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Reserved<br />
|}<br />
<br />
This is used for SystemUpdate, see here: [[NCM_services#ReadEntryMetaRecords]].<br />
<br />
== SystemUpdate Extended Data ==<br />
<br />
If the Version field is 1, the format is:<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Variation Count<br />
|-<br />
| 0x8<br />
| 0x20 * Variation Count<br />
| [[CNMT#Firmware_Variation_Info_(Version_1)|Firmware Variation Info (Version 1)]]<br />
|}<br />
<br />
If the Version field is 2, the format is:<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Variation Count<br />
|-<br />
| 0x8<br />
| 0x4 * Variation Count<br />
| Firmware Variation ID<br />
|-<br />
| <br />
| 0x20 * Variation Count<br />
| [[CNMT#Firmware_Variation_Info_(Version_2)|Firmware Variation Info (Version 2)]]<br />
|-<br />
| <br />
| 0x10 * Meta Count (From [[CNMT#Firmware_Variation_Info_(Version_2)|Firmware Variation Info (Version 2)]])<br />
| [[CNMT#Content_Meta_Info|Content Meta Info]] (If Refer To Base is False)<br />
|}<br />
<br />
=== Firmware Variation Info (Version 1) ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Firmware Variation ID<br />
|-<br />
| 0x4<br />
| 0x1C<br />
| Reserved<br />
|}<br />
<br />
=== Firmware Variation Info (Version 2) ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| Refer To Base (0=False, 1=True)<br />
|-<br />
| 0x1<br />
| 0x3<br />
| Reserved<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Meta Count<br />
|-<br />
| 0x8<br />
| 0x18<br />
| Reserved<br />
|}<br />
<br />
== Patch Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| History Count<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Delta History Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Delta Count<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Fragment Set Count<br />
|-<br />
| 0x10<br />
| 0x4<br />
| History Content Count<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Delta Content Count<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x1C<br />
| 0x38 * History Count<br />
| [[CNMT#History_Header|History Headers]]<br />
|-<br />
| <br />
| 0x28 * Delta History Count<br />
| [[CNMT#Delta_History|Delta Histories]]<br />
|-<br />
| <br />
| 0x28 * Delta Count<br />
| [[CNMT#Delta_Header|Delta Headers]]<br />
|-<br />
| <br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Fragment_Set|Fragment Sets]]<br />
|-<br />
| <br />
| 0x18 * History Content Count<br />
| [[CNMT#Packaged_Content_Info|History Content Info]] (Packaged Content Info without the Hash entry)<br />
|-<br />
| <br />
| 0x38 * Delta Content Count<br />
| [[CNMT#Packaged_Content_Info|Delta Packaged Content Info]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (From [[CNMT#Fragment_Set|Fragment Sets]])<br />
| [[CNMT#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
=== History Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Content Meta Key (Slightly different Content Meta Info)<br />
|-<br />
| 0x10<br />
| 0x20<br />
| Digest<br />
|-<br />
| 0x30<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x32<br />
| 0x6<br />
| Reserved<br />
|}<br />
<br />
=== Delta History ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Download Size<br />
|-<br />
| 0x20<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
=== Delta Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Reserved<br />
|-<br />
| 0x20<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x22<br />
| 0x6<br />
| Reserved<br />
|}<br />
<br />
=== Fragment Set ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Source Content ID<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Destination Content ID<br />
|-<br />
| 0x20<br />
| 0x6<br />
| Source Size<br />
|-<br />
| 0x26<br />
| 0x6<br />
| Destination Size<br />
|-<br />
| 0x2C<br />
| 0x2<br />
| Fragment Indicator Count<br />
|-<br />
| 0x2E<br />
| 0x1<br />
| Fragment Target Content Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x2F<br />
| 0x1<br />
| Update Type (0=ApplyAsDelta, 1=Overwrite, 2=Create)<br />
|-<br />
| 0x30<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
=== Fragment Indicator ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x2<br />
| Content Info Index<br />
|-<br />
| 0x2<br />
| 0x2<br />
| Fragment Index<br />
|}<br />
<br />
== Delta Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Reserved<br />
|-<br />
| 0x20<br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Fragment_Set|Fragment Sets]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (From [[CNMT#Fragment_Set|Fragment Sets]])<br />
| [[CNMT#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
== Digest ==<br />
<br />
Always found at the end of the file.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Digest<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=BCT&diff=9784
BCT
2020-07-17T22:57:03Z
<p>Liam: </p>
<hr />
<div>BCT (Boot Configuration Table) is a data structure present on Tegra based devices that supplies boot time configuration parameters.<br />
<br />
The Switch's BCT is included in the firmware package titles (0100000000000819 and 010000000000081A) and is installed into eMMC storage's [[Flash_Filesystem#Boot_Partitions|boot partition 0]]. A total of four BCT copies can be installed into the system: normal, normal backup, safe mode and safe mode backup.<br />
<br />
The Erista BCT's data is only signed after offset 0x0510. Therefore, regions like [[#CustomerData|CustomerData]] can be freely modified without resigning. This is done by [[NS_Services|NS]] when injecting a new [[Flash_Filesystem#Keyblob|keyblob]] during a system update, for example.<br />
<br />
The Mariko BCT's data is signed and encrypted after offset 0x0480, so the [[Flash_Filesystem#Keyblob|keyblob]] system is no longer used.<br />
<br />
During boot, the boot ROM parses the appropriate BCT from eMMC storage and stores a copy of it in IRAM at address 0x40000000.<br />
<br />
= Format =<br />
== Erista ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Field<br />
! Description<br />
|-<br />
| 0x0000<br />
| 0x210<br />
| BadBlockTable<br />
| Table containing information on bad blocks<br />
0x0000: EntriesUsed (0x200)<br />
0x0004: VirtualBlockSizeLog2 (0x0F)<br />
0x0005: BlockSizeLog2 (0x0E)<br />
0x0006: BadBlocks<br />
0x0206: Reserved<br />
|-<br />
| 0x0210<br />
| 0x100<br />
| Key<br />
| BCT RSA public key's modulus<br />
|-<br />
| 0x0310<br />
| 0x110<br />
| Signature<br />
| BCT cryptographic signature<br />
0x0310: CryptoHash (empty)<br />
0x0320: RsaPssSig<br />
|-<br />
| 0x0420<br />
| 0x04<br />
| SecProvisioningKeyNumInsecure<br />
| Used for Factory Secure Provisioning (always 0)<br />
|-<br />
| 0x0424<br />
| 0x20<br />
| SecProvisioningKey<br />
| Used for Factory Secure Provisioning (always 0)<br />
|-<br />
| 0x0444<br />
| 0xC4<br />
| [[#CustomerData|CustomerData]]<br />
| Data block available for the customer (used in key generation)<br />
0x0444: Reserved (0x0C bytes)<br />
0x0450: [[Flash_Filesystem#Keyblob|Keyblob]] (0xB0 bytes)<br />
0x0500: Reserved (0x08 bytes)<br />
|-<br />
| 0x0508<br />
| 0x04<br />
| OdmData<br />
| Legacy field (unused)<br />
|-<br />
| 0x050C<br />
| 0x04<br />
| Reserved<br />
| Legacy field (unused)<br />
|-<br />
| 0x0510<br />
| 0x10<br />
| RandomAesBlock<br />
| Always empty<br />
|-<br />
| 0x0520<br />
| 0x10<br />
| UniqueChipId<br />
| Always empty<br />
|-<br />
| 0x0530<br />
| 0x04<br />
| BootDataVersion<br />
| Set to 0x00210001 (BOOTDATA_VERSION_T210)<br />
|-<br />
| 0x0534<br />
| 0x04<br />
| BlockSizeLog2<br />
| Always 0x0E<br />
|-<br />
| 0x0538<br />
| 0x04<br />
| PageSizeLog2<br />
| Always 0x09<br />
|-<br />
| 0x053C<br />
| 0x04<br />
| PartitionSize<br />
| Always 0x01000000<br />
|-<br />
| 0x0540<br />
| 0x04<br />
| NumParamSets<br />
| Number of device parameter sets (always 0x01)<br />
|-<br />
| 0x0544<br />
| 0x04<br />
| DevType<br />
| Device type (0x04 == Sdmmc)<br />
|-<br />
| 0x0548<br />
| 0x40<br />
| DevParams<br />
| Device parameters<br />
0x0548: ClockDivider (0x09 == 24MHz)<br />
0x054C: DataWidth (0x02 == 8Bit)<br />
|-<br />
| 0x0588<br />
| 0x04<br />
| NumSdramSets<br />
| Number of SDRAM parameter sets (always set to 0, but parameters are used despite this)<br />
|-<br />
| 0x058C<br />
| 0x768<br />
| SdramParams0<br />
| Default values filled in<br />
|-<br />
| 0x0CF4<br />
| 0x768<br />
| SdramParams1<br />
| Default values filled in<br />
|-<br />
| 0x145C<br />
| 0x768<br />
| SdramParams2<br />
| Default values filled in<br />
|-<br />
| 0x1BC4<br />
| 0x768<br />
| SdramParams3<br />
| Default values filled in<br />
|-<br />
| 0x232C<br />
| 0x04<br />
| BootLoadersUsed<br />
| Number of bootloaders installed (always 0x02, maximum is 0x04)<br />
|-<br />
| 0x2330<br />
| 0x12C<br />
| [[#BootLoader0|BootLoader0]]<br />
| Configuration parameters for bootloader 0 (main)<br />
0x2330: Version (variable)<br />
0x2334: StartBlock (0x00000040 (BootImagePackage), 0x00000100 (BootImagePackageSafe))<br />
0x2338: StartPage (0x00000000)<br />
0x233C: Length (variable)<br />
0x2340: LoadAddress (0x40010000)<br />
0x2344: EntryPoint (0x40010020 for 1.0.0-3.0.2, 0x40010040 for 4.0.0+)<br />
0x2348: Attribute (0x00000000 (BootImagePackage), 0x00000001 (BootImagePackageSafe))<br />
0x234C: CryptoHash (empty)<br />
0x235C: RsaPssSig<br />
|-<br />
| 0x245C<br />
| 0x12C<br />
| BootLoader1<br />
| Configuration parameters for bootloader 1 (backup)<br />
0x245C: Version (variable)<br />
0x2460: StartBlock (0x00000050 (BootImagePackage), 0x00000110 (BootImagePackageSafe))<br />
0x2464: StartPage (0x00000000)<br />
0x2468: Length (variable)<br />
0x246C: LoadAddress (0x40010000)<br />
0x2470: EntryPoint (0x40010020 for 1.0.0-3.0.2, 0x40010040 for 4.0.0+)<br />
0x2474: Attribute (0x00000000 (BootImagePackage), 0x00000001 (BootImagePackageSafe))<br />
0x2478: CryptoHash (empty)<br />
0x2488: RsaPssSig<br />
|-<br />
| 0x2588<br />
| 0x12C<br />
| BootLoader2<br />
| Reserved space for bootloader 2 (unused)<br />
|-<br />
| 0x26B4<br />
| 0x12C<br />
| BootLoader3<br />
| Reserved space for bootloader 3 (unused)<br />
|-<br />
| 0x27E0<br />
| 0x01<br />
| EnableFailBack<br />
| Always 0<br />
|-<br />
| 0x27E1<br />
| 0x04<br />
| SecureJtagControl<br />
| Always 0<br />
|-<br />
| 0x27E5<br />
| 0x04<br />
| SecProvisioningKeyNumSecure<br />
| Used for Factory Secure Provisioning (always 0)<br />
|-<br />
| 0x27E9<br />
| 0x12<br />
| Reserved<br />
| Always starts with 0x80000000 (NVBOOT padding pattern)<br />
|-<br />
| 0x27FB<br />
| 0x05<br />
| Padding<br />
| Empty<br />
|}<br />
<br />
=== CustomerData ===<br />
This data block is ignored by the boot ROM, therefore is available for the programmer to use freely.<br />
The Switch uses 0xB0 bytes of this area, at offset 0x0450, to store the active [[Flash_Filesystem#Keyblob|keyblob]]. All remaining bytes are zero.<br />
<br />
The first bootloader validates and decrypts this block for further key generation.<br />
The decrypted keyblob payload is as follows.<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x80<br />
| Array of master static key encryption keys<br />
|-<br />
| 0x80<br />
| 0x10 <br />
| [[Package1#PK11_Blob|PK11]] key<br />
|}<br />
<br />
=== BootLoader0 ===<br />
The version field controls which keyblob is used, where 0x01 is the first one. See [[Cryptosystem]] for the keyblobs used by each system-version.<br />
<br />
== Mariko ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Field<br />
! Description<br />
|-<br />
| 0x0000<br />
| 0x210<br />
| Pcp<br />
| BCT public cryptographic parameters<br />
0x0000: KeySize<br />
0x0004: Reserved<br />
0x0010: PublicKeyModulus<br />
0x0110: PublicKeyExponent<br />
|-<br />
| 0x0210<br />
| 0x110<br />
| Signature<br />
| BCT cryptographic signature<br />
0x0210: CryptoHash (empty)<br />
0x0220: RsaPssSig<br />
|-<br />
| 0x0320<br />
| 0x160<br />
| <br />
| Empty<br />
|-<br />
| 0x0480<br />
| 0x10<br />
| RandomAesBlock<br />
| Not empty<br />
|-<br />
| 0x0490<br />
| 0x10<br />
| UniqueChipId<br />
| Always empty<br />
|-<br />
| 0x04A0<br />
| 0x04<br />
| BootDataVersion<br />
| Set to 0x00210001 (BOOTDATA_VERSION_T210)<br />
|-<br />
| 0x04A4<br />
| 0x04<br />
| BlockSizeLog2<br />
| Always 0x0E<br />
|-<br />
| 0x04A8<br />
| 0x04<br />
| PageSizeLog2<br />
| Always 0x09<br />
|-<br />
| 0x04AC<br />
| 0x04<br />
| PartitionSize<br />
| Always 0x01000000<br />
|-<br />
| 0x04B0<br />
| 0x04<br />
| NumParamSets<br />
| Number of device parameter sets (always 0x01)<br />
|-<br />
| 0x04B4<br />
| 0x04<br />
| DevType<br />
| Device type (0x04 == Sdmmc)<br />
|-<br />
| 0x04B8<br />
| 0x40<br />
| DevParams<br />
| Device parameters<br />
|-<br />
| 0x04F8<br />
| 0x04<br />
| NumSdramSets<br />
| Number of SDRAM parameter sets (always set to 0, but parameters are used despite this)<br />
|-<br />
| 0x04FC<br />
| 0x838<br />
| SdramParams0<br />
| Default values filled in<br />
|-<br />
| 0x0D34<br />
| 0x838<br />
| SdramParams1<br />
| Default values filled in<br />
|-<br />
| 0x156C<br />
| 0x838<br />
| SdramParams2<br />
| Default values filled in<br />
|-<br />
| 0x1DA4<br />
| 0x838<br />
| SdramParams3<br />
| Default values filled in<br />
|-<br />
| 0x25DC<br />
| 0x04<br />
| BootLoadersUsed<br />
| Number of bootloaders installed (always 0x02, maximum is 0x04)<br />
|-<br />
| 0x25E0<br />
| 0x10<br />
| BootLoader0<br />
| Configuration parameters for bootloader 0 (main)<br />
0x25E0: StartBlock (0x00000040 (BootImagePackage), 0x00000100 (BootImagePackageSafe))<br />
0x25E4: StartPage (0x00000000)<br />
0x25E8: Version (variable)<br />
0x25EC: Reserved<br />
|-<br />
| 0x25F0<br />
| 0x10<br />
| BootLoader1<br />
| Configuration parameters for bootloader 1 (backup)<br />
0x25F0: StartBlock (0x00000050 (BootImagePackage), 0x00000110 (BootImagePackageSafe))<br />
0x25F4: StartPage (0x00000000)<br />
0x25F8: Version (variable)<br />
0x25FC: Reserved<br />
|-<br />
| 0x2600<br />
| 0x10<br />
| BootLoader2<br />
| Reserved space for bootloader 2 (unused)<br />
|-<br />
| 0x2610<br />
| 0x10<br />
| BootLoader3<br />
| Reserved space for bootloader 3 (unused)<br />
|-<br />
| 0x2620<br />
| 0x5C<br />
| <br />
| Empty<br />
|-<br />
| 0x267C<br />
| 0x184<br />
| Reserved<br />
| Always starts with 0x80000000 (NVBOOT padding pattern)<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=Package1&diff=9683
Package1
2020-06-28T20:04:30Z
<p>Liam: </p>
<hr />
<div>Present in the firmware package titles (0100000000000819, 010000000000081A, 010000000000081B and 010000000000081C) and installed into eMMC storage's [[Flash_Filesystem#Boot_Partitions|boot partitions 0 and 1]], "package1" contains the first Switch bootloader ("Package1ldr") to run under the NVIDIA boot processor (an ARM7TDMI called "BPMP", "BPMP-Lite", "AVP" or "COP"), as well as the actual encrypted package1 ("PK11") blob containing the second Switch Bootloader and TrustZone code.<br />
<br />
The boot ROM validates, copies to IRAM and executes this package by parsing it's information block from the [[BCT|BCT]].<br />
<br />
= Format =<br />
== Erista ==<br />
This package is distributed as a plaintext initial bootloader (package1ldr) and a secondary encrypted blob ("PK11"). Execution starts at plaintext package1ldr which will set up hardware, generate keys and decrypt the next stage.<br />
<br />
=== Header ===<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Package1ldr hash (first four bytes of SHA256(package1ldr))<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Secure Monitor hash (first four bytes of SHA256(secure_monitor))<br />
|-<br />
| 0x8<br />
| 0x4<br />
| NX Bootloader hash (first four bytes of SHA256(nx_bootloader))<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Build ID<br />
|-<br />
| 0x10<br />
| 0xE<br />
| Build Timestamp (yyyyMMddHHmmss)<br />
|-<br />
| 0x1E<br />
| 0x1<br />
| [7.0.0+] Key Generation<br />
|-<br />
| 0x1F<br />
| 0x1<br />
| Version<br />
|}<br />
<br />
=== Package1ldr ===<br />
The code for this stage is stored in plaintext inside the package. By looking into the BCT's bootloader0_info (normal) or bootloader1_info (safe mode), the boot ROM starts executing this stage at address 0x40010020 in IRAM (0x40010040 for 4.0.0+).<br />
<br />
==== Initialization ====<br />
The stack pointer is set.<br />
<br />
<syntaxhighlight lang="c"><br />
// Set the stack pointer<br />
*(u32 *)sp = 0x40008000;<br />
<br />
// Jump to main<br />
bootloader_main();<br />
<br />
// Infinite loop<br />
deadlock();<br />
</syntaxhighlight><br />
<br />
==== Main ====<br />
The bootloader poisons the exception vectors, cleans up memory (.bss and init_array), sets up hardware devices (including the security engine and fuses), does all the necessary checks, generates keys and finally decrypts and executes the next stage.<br />
<br />
<syntaxhighlight lang="c"><br />
// Poison all exception vectors<br />
*(u32 *)0x6000F200 = panic();<br />
*(u32 *)0x6000F204 = panic();<br />
*(u32 *)0x6000F208 = panic();<br />
*(u32 *)0x6000F20C = panic();<br />
*(u32 *)0x6000F210 = panic();<br />
*(u32 *)0x6000F214 = panic();<br />
*(u32 *)0x6000F218 = panic();<br />
*(u32 *)0x6000F21C = panic();<br />
<br />
u32 bss_addr_end = bss_addr_start;<br />
u32 bss_offset = 0;<br />
u32 bss_size = bss_addr_end - bss_addr_start;<br />
<br />
// Clear .bss region<br />
// Never happens due to bss_size being set to 0<br />
while (bss_offset < bss_size)<br />
{<br />
*(u32 *)bss_addr_start + bss_offset = 0;<br />
bss_offset += 0x04;<br />
}<br />
<br />
u32 init_array_addr_end = init_array_addr_start;<br />
u32 init_array_offset = init_array_addr_start;<br />
<br />
// Call init methods<br />
// Never happens due to init_array_addr_end being set to init_array_addr_start<br />
while (init_array_offset < init_array_addr_end)<br />
{<br />
u32 init_method_offset = *(u32 *)init_array_offset;<br />
<br />
call_init_method(init_method_offset + init_array_offset);<br />
init_array_offset += 0x04;<br />
}<br />
<br />
// Setup I2S1, I2S2, I2S3, I2S4, DISPLAY and VIC<br />
mbist_workaround();<br />
<br />
// Program the SE clock and resets<br />
// Uses RST_DEVICES_V, CLK_OUT_ENB_V, CLK_SOURCE_SE and CLK_V_SE<br />
enable_se_clkrst();<br />
<br />
// Set MISC_CLK_ENB<br />
// This makes fuse registers visible<br />
enable_misc_clk(0x01);<br />
<br />
// Read FUSE_SKU_INFO and compare with 0x83<br />
check_sku();<br />
<br />
// Check configuration fuses<br />
check_config_fuses();<br />
<br />
u32 bct_iram_addr = 0x40000000;<br />
<br />
// Check bootloader version from BCT<br />
check_bootloader_ver(bct_iram_addr);<br />
<br />
// Check anti-downgrade fuses<br />
check_downgrade();<br />
<br />
// Set FUSE_DIS_PGM<br />
// Disables fuse programming until next reboot<br />
disable_fuse_pgm();<br />
<br />
// Setup memory controllers<br />
enable_mem_ctl();<br />
<br />
// Setup the security engine's address<br />
set_se_addr(0x70012000);<br />
<br />
// Check SE global config<br />
check_se_status();<br />
<br />
// Generate keys<br />
keygen(bct_iram_addr);<br />
<br />
u32 pk11_blob_addr = 0x40013FE0;<br />
<br />
// Decrypt the PK11 blob and get the next stage's entrypoint<br />
nx_boot_addr = decrypt_pk11_blob(pk11_blob_addr);<br />
<br />
u32 nx_boot_sp = 0x40007000;<br />
<br />
// Set the stack pointer and jump to a stub responsible<br />
// for cleaning up and branching into the next stage<br />
exec_nx_boot_stub(nx_boot_addr, nx_boot_stub_addr, nx_boot_sp);<br />
<br />
return;<br />
</syntaxhighlight><br />
<br />
[6.2.0+] The bootloader maintains most of its design, but passes execution to a [[TSEC]] payload and is left in an infinite loop.<br />
<br />
<syntaxhighlight lang="c"><br />
// Poison all exception vectors<br />
*(u32 *)0x6000F200 = panic();<br />
*(u32 *)0x6000F204 = panic();<br />
*(u32 *)0x6000F208 = panic();<br />
*(u32 *)0x6000F20C = panic();<br />
*(u32 *)0x6000F210 = panic();<br />
*(u32 *)0x6000F214 = panic();<br />
*(u32 *)0x6000F218 = panic();<br />
*(u32 *)0x6000F21C = panic();<br />
<br />
u32 bss_addr_end = bss_addr_start;<br />
u32 bss_offset = 0;<br />
u32 bss_size = bss_addr_end - bss_addr_start;<br />
<br />
// Clear .bss region<br />
// Never happens due to bss_size being set to 0<br />
while (bss_offset < bss_size)<br />
{<br />
*(u32 *)bss_addr_start + bss_offset = 0;<br />
bss_offset += 0x04;<br />
}<br />
<br />
u32 init_array_addr_end = init_array_addr_start;<br />
u32 init_array_offset = init_array_addr_start;<br />
<br />
// Call init methods<br />
// Never happens due to init_array_addr_end being set to init_array_addr_start<br />
while (init_array_offset < init_array_addr_end)<br />
{<br />
u32 init_method_offset = *(u32 *)init_array_offset;<br />
<br />
call_init_method(init_method_offset + init_array_offset);<br />
init_array_offset += 0x04;<br />
}<br />
<br />
// Setup I2S1, I2S2, I2S3, I2S4, DISPLAY and VIC<br />
mbist_workaround();<br />
<br />
// Program the SE clock and resets<br />
// Uses RST_DEVICES_V, CLK_OUT_ENB_V, CLK_SOURCE_SE and CLK_V_SE<br />
enable_se_clkrst();<br />
<br />
// Set MISC_CLK_ENB<br />
// This makes fuse registers visible<br />
enable_misc_clk(0x01);<br />
<br />
// Setup the security engine's address<br />
set_se_addr(0x70012000);<br />
<br />
// Check SE global config<br />
check_se_status();<br />
<br />
// Read FUSE_SKU_INFO and compare with 0x83<br />
check_sku();<br />
<br />
// Check configuration fuses<br />
check_config_fuses();<br />
<br />
u32 bct_iram_addr = 0x40000000;<br />
<br />
// Check bootloader version from BCT<br />
check_bootloader_ver(bct_iram_addr);<br />
<br />
// Check anti-downgrade fuses<br />
check_downgrade();<br />
<br />
// Setup memory controllers<br />
enable_mem_ctl();<br />
<br />
// Clear SYS_CLK_DIVISOR<br />
*(u32 *)CLK_SOURCE_SYS = 0;<br />
<br />
// Place I2C5 in reset<br />
u32 rst_dev_h_val = *(u32 *)RST_DEVICES_H;<br />
rst_dev_h_val &= ~(0x8000);<br />
rst_dev_h_val |= 0x8000;<br />
*(u32 *)RST_DEVICES_H = rst_dev_h_val;<br />
<br />
// Program the HOST1X clock and resets<br />
// Uses RST_DEVICES_L, CLK_OUT_ENB_L, CLK_SOURCE_HOST1X and CLK_L_HOST1X<br />
enable_host1x_clkrst();<br />
<br />
// Program the TSEC clock and resets<br />
// Uses RST_DEVICES_U, CLK_OUT_ENB_U, CLK_SOURCE_TSEC and CLK_U_TSEC<br />
enable_tsec_clkrst();<br />
<br />
// Program the SOR_SAFE clock and resets<br />
// Uses RST_DEVICES_Y, CLK_OUT_ENB_Y and CLK_Y_SOR_SAFE<br />
enable_sor_safe_clkrst();<br />
<br />
// Program the SOR0 clock and resets<br />
// Uses RST_DEVICES_X, CLK_OUT_ENB_X and CLK_X_SOR0<br />
enable_sor0_clkrst();<br />
<br />
// Program the SOR1 clock and resets<br />
// Uses RST_DEVICES_X, CLK_OUT_ENB_X, CLK_SOURCE_SOR1 and CLK_X_SOR1<br />
enable_sor1_clkrst();<br />
<br />
// Program the KFUSE clock resets<br />
// Uses RST_DEVICES_H, CLK_OUT_ENB_H and CLK_H_KFUSE<br />
enable_kfuse_clkrst();<br />
<br />
// Clear the Falcon DMA control register<br />
*(u32 *)FALCON_DMACTL = 0;<br />
<br />
// Enable Falcon IRQs<br />
*(u32 *)FALCON_IRQMSET = 0xFFF2;<br />
<br />
// Enable Falcon IRQs<br />
*(u32 *)FALCON_IRQDEST = 0xFFF0;<br />
<br />
// Enable Falcon interfaces<br />
*(u32 *)FALCON_ITFEN = 0x03;<br />
<br />
// Wait for Falcon's DMA engine to be idle<br />
wait_flcn_dma_idle();<br />
<br />
// Set DMA transfer base address to 0x40010E00>> 0x08<br />
*(u32 *)FALCON_DMATRFBASE = 0x40010E;<br />
<br />
u32 trf_mode = 0; // A value of 0 sets FALCON_DMATRFCMD_IMEM<br />
u32 dst_offset = 0;<br />
u32 src_offset = 0;<br />
<br />
// Load code into Falcon (0x100 bytes at a time)<br />
while (src_offset < 0x2900)<br />
{<br />
flcn_load_firm(trf_mode, src_offset, dst_offset);<br />
src_offset += 0x100;<br />
dst_offset += 0x100;<br />
}<br />
<br />
// Set magic value in host1x scratch space<br />
*(u32 *)0x50003300 = 0x34C2E1DA;<br />
<br />
// Clear Falcon scratch1 MMIO<br />
*(u32 *)FALCON_SCRATCH1 = 0;<br />
<br />
// Set Falcon boot key version in scratch0 MMIO<br />
*(u32 *)FALCON_SCRATCH0 = 0x01;<br />
<br />
// Set Falcon's boot vector address<br />
*(u32 *)FALCON_BOOTVEC = 0;<br />
<br />
// Signal Falcon's CPU<br />
*(u32 *)FALCON_CPUCTL = 0x02;<br />
<br />
// Infinite loop<br />
deadlock();<br />
</syntaxhighlight><br />
<br />
===== Panic =====<br />
If a panic occurs, all sensitive memory contents are cleared, the security engine and fuse programming are disabled and the boot processor is left in a halted state.<br />
<br />
<syntaxhighlight lang="c"><br />
// Clear all stack contents<br />
clear_stack();<br />
<br />
// Terminate the security engine<br />
disable_se();<br />
<br />
// Set FUSE_DIS_PGM<br />
// Disables fuse programming until next reboot<br />
disable_fuse_pgm();<br />
<br />
// Clear temporary key storage memory<br />
clear_mem();<br />
<br />
// Clear the PK11 blob from memory<br />
clear_pk11_blob();<br />
<br />
// Halt the boot processor<br />
while (true)<br />
*(u32 *)FLOW_CTLR_HALT_COP_EVENTS = (FLOW_MODE_STOP | HALT_COP_EVENT_JTAG);<br />
</syntaxhighlight><br />
<br />
===== Anti-downgrade =====<br />
See [[Fuses#Anti-downgrade|Anti-downgrade]].<br />
<br />
===== Memory controllers =====<br />
After disabling fuse programming, the bootloader configures the EMC and MEM/MC. It additionally disables QSPI resets and programs a special aperture designed for AHB redirected access to IRAM.<br />
<br />
<syntaxhighlight lang="c"> <br />
// Initialize EMC's clock source<br />
u32 emc_clk_src_val = *(u32 *)PERIPH_CLK_SOURCE_EMC;<br />
*(u32 *)PERIPH_CLK_SOURCE_EMC = (emc_clk_src_val | 0x40000000);<br />
<br />
// Enable CLK_H_EMC<br />
u32 clk_out_enb_h_val = *(u32 *)CLK_OUT_ENB_SET_H;<br />
clk_out_enb_h_val &= ~(0x2000000);<br />
clk_out_enb_h_val |= 0x2000000;<br />
*(u32 *)CLK_OUT_ENB_SET_H = clk_out_enb_h_val;<br />
<br />
// Enable CLK_H_MEM<br />
clk_out_enb_h_val = *(u32 *)CLK_OUT_ENB_SET_H;<br />
clk_out_enb_h_val &= ~(0x01);<br />
clk_out_enb_h_val |= 0x01;<br />
*(u32 *)CLK_OUT_ENB_SET_H = clk_out_enb_h_val;<br />
<br />
// Enable CLK_X_EMC_DLL<br />
u32 clk_out_enb_x_val = *(u32 *)CLK_OUT_ENB_SET_X;<br />
clk_out_enb_x_val &= ~(0x4000);<br />
clk_out_enb_x_val |= 0x4000;<br />
*(u32 *)CLK_OUT_ENB_SET_X = clk_out_enb_x_val;<br />
<br />
// Enable RST_H_EMC and RST_H_MEM<br />
*(u32 *)RST_DEVICES_SET_H = 0x2000001;<br />
<br />
// Wait a while<br />
mdelay(0x05);<br />
<br />
// Disable RST_Y_QSPI<br />
u32 rst_clr_y_val = *(u32 *)RST_DEVICES_CLR_Y;<br />
rst_clr_y_val &= ~(0x80000);<br />
rst_clr_y_val |= 0x80000;<br />
*(u32 *)RST_DEVICES_CLR_Y = rst_clr_y_val;<br />
<br />
// Refresh MC_IRAM_REG_CTRL<br />
// Should be set to 0 (MC_ENABLE_IRAM_CFG_WRITES)<br />
u32 mc_iram_reg_ctrl_val = *(u32 *)MC_IRAM_REG_CTRL;<br />
*(u32 *)MC_IRAM_REG_CTRL = mc_iram_reg_ctrl_val;<br />
<br />
// Set base and top addresses for AHB redirected IRAM path<br />
// This allows devices like the GPU to access this range<br />
*(u32 *)MC_IRAM_BOM = 0x40000000;<br />
*(u32 *)MC_IRAM_TOM = 0x4003F000;<br />
<br />
// Read back MC_IRAM_REG_CTRL<br />
mc_iram_reg_ctrl_val = *(u32 *)MC_IRAM_REG_CTRL;<br />
<br />
return mc_iram_reg_ctrl_val;<br />
</syntaxhighlight><br />
<br />
[6.2.0+] MC_IRAM_TOM is now set to 0x80000000 to allow TSEC to access IRAM and all MMIO.<br />
<br />
===== Key generation =====<br />
After the security engine is ready and before decrypting the next stage, the bootloader initializes and generates several keys into hardware keyslots.<br />
For more details on the Switch's cryptosystem, please see [[Cryptosystem|this page]].<br />
<br />
[6.2.0+] The key generation process was moved into an encrypted [[TSEC]] payload.<br />
<br />
====== Selection ======<br />
Depending on [[Fuses#FUSE_RESERVED_ODM4|FUSE_RESERVED_ODM4]] and [[Fuses#FUSE_SPARE_BIT_5|FUSE_SPARE_BIT_5]] different static seeds are selected for key generation.<br />
<br />
<syntaxhighlight lang="c"><br />
// Initialize keyslots 0x0C and 0x0D as readable<br />
init_keyslot(0x0C, 0x15);<br />
init_keyslot(0x0D, 0x15);<br />
<br />
// Find the BCT's data address from IRAM header<br />
u32 bct_data_addr = *(u32 *)bct_imem_addr + 0x4C;<br />
u32 bct_customer_data_addr = *(u32 *)bct_data_addr + 0x450;<br />
<br />
// Wrapper to get unit type from FUSE_RESERVED_ODM4<br />
// This tells if the device is retail or debug<br />
bool is_retail = is_unit_retail();<br />
<br />
u32 master_static_seed_addr = 0;<br />
u32 master_static_seed_size = 0;<br />
<br />
if (is_retail)<br />
{<br />
// Read FUSE_SPARE_BIT_5<br />
// This tells which master key to use<br />
u32 master_key_ver = read_fuse_spare_bit_5();<br />
<br />
// Invalid for retail<br />
if (!master_key_ver)<br />
panic();<br />
else<br />
{<br />
master_static_seed_addr = static_seed1_addr;<br />
master_static_seed_size = 0x10;<br />
<br />
// Generate retail keys<br />
generate_retail_keys(bct_customer_data_addr, static_seed_addr, static_seed_size);<br />
}<br />
}<br />
else<br />
{<br />
// Read FUSE_SPARE_BIT_5<br />
// This tells which master key to use<br />
u32 master_key_ver = read_fuse_spare_bit_5();<br />
<br />
// Use debug key set<br />
if (!master_key_ver)<br />
{<br />
// Read the first byte of the BCT RSA PSS signature<br />
u8 rsa_pss_1_byte = *(u8 *)bct_data_addr + 0x210;<br />
<br />
if (rsa_pss_1_byte == 0x11)<br />
{<br />
master_static_seed_addr = static_seed6_addr;<br />
master_static_seed_size = 0x10;<br />
}<br />
else <br />
{<br />
master_static_seed_addr = static_seed7_addr;<br />
master_static_seed_size = 0x10;<br />
}<br />
<br />
// Generate debug keys<br />
generate_debug_keys(static_seed_addr, static_seed_size);<br />
}<br />
else<br />
{<br />
// Read the first byte of the BCT RSA PSS signature<br />
u8 rsa_pss_1_byte = *(u8 *)bct_data_addr + 0x210;<br />
<br />
if (rsa_pss_1_byte == 0x4F) // Different key as in retail mode<br />
{<br />
master_static_seed_addr = static_seed0_addr;<br />
master_static_seed_size = 0x10;<br />
}<br />
else // Same key as in retail mode<br />
{<br />
master_static_seed_addr = static_seed1_addr;<br />
master_static_seed_size = 0x10;<br />
}<br />
<br />
// Generate retail keys<br />
generate_retail_keys(bct_customer_data_addr, master_static_seed_addr, master_static_seed_size);<br />
}<br />
}<br />
<br />
// Initialize keyslots 0x0C and 0x0D as unreadable<br />
init_keyslot(0x0C, 0xFF);<br />
init_keyslot(0x0D, 0xFF);<br />
<br />
return;<br />
</syntaxhighlight><br />
<br />
====== generate_retail_keys ======<br />
In order to generate retail keys, the bootloader starts by initializing TSEC and grabbing it's [[TSEC#TSEC_key_generation|device key]]. Using static seeds and the SBK, the keyblob injected into the BCT's [[BCT#customer_data|customer_data]] is validated and decrypted. The resulting keys will then be used to generate the master static key and the master device key.<br />
<br />
See the pseudocode bellow for the detailed process.<br />
<br />
<syntaxhighlight lang="c"><br />
u32 in_addr = 0;<br />
u32 in_size = 0;<br />
u32 out_addr = 0;<br />
u32 out_size = 0;<br />
u32 keyslot = 0;<br />
u32 keyslot_dst = 0;<br />
<br />
// Get the TSEC device key<br />
tsec_get_device_key(tsec_device_key_addr, 0x10);<br />
<br />
// Install the TSEC device key into keyslot 0x0D<br />
set_keyslot_data(0x0D, tsec_device_key_addr, 0x10);<br />
<br />
in_addr = static_seed2_addr;<br />
in_size = 0x10;<br />
out_addr = keyblob_device_key_addr;<br />
out_size = 0x10;<br />
keyslot = 0x0D;<br />
<br />
// Use the tsec_device_key (keyslot 0x0D) to decrypt the static_seed2<br />
// This generates the keyblob_device_key<br />
aes_ecb_decrypt(out_addr, out_size, keyslot, in_addr, in_size);<br />
<br />
in_addr = keyblob_device_key_addr;<br />
in_size = 0x10;<br />
keyslot = 0x0E;<br />
keyslot_dst = 0x0D;<br />
<br />
// Use SBK (keyslot 0x0E) to further decrypt the<br />
// keyblob_device_key and install it into keyslot 0x0D<br />
// This will generate the keyblob_key<br />
decrypt_keyslot(keyslot_dst, keyslot, in_addr, in_size);<br />
<br />
// Clear SBK and SSK keyslots<br />
clear_keyslot(0x0E);<br />
clear_keyslot(0x0F);<br />
<br />
in_addr = static_seed4_addr;<br />
in_size = 0x10;<br />
keyslot = 0x0D;<br />
keyslot_dst = 0x0B;<br />
<br />
// Use keyblob_key (keyslot 0x0D) to decrypt the<br />
// static_seed4_addr and install it to keyslot 0x0B<br />
// This will generate the bct_mac_key<br />
decrypt_keyslot(keyslot_dst, keyslot, in_addr, in_size);<br />
<br />
in_addr = bct_customer_data_addr + 0x10;<br />
in_size = 0xA0;<br />
out_addr = mac_addr;<br />
out_size = 0x10;<br />
keyslot = 0x0B;<br />
<br />
// Use the bct_mac_key (keyslot 0x0B) to generate<br />
// CMAC over bct_customer_data_addr + 0x10<br />
aes_cmac(out_addr, out_size, keyslot, in_addr, in_size);<br />
<br />
// Compare the generated hash with the first<br />
// 0x10 bytes of bct_customer_data<br />
bool match = safe_memcmp(mac_addr, bct_customer_data_addr, 0x10);<br />
<br />
// Hashes don't match<br />
if (!match)<br />
panic();<br />
<br />
in_addr = bct_customer_data_addr + 0x20;<br />
in_size = 0x90;<br />
ctr_addr = bct_customer_data_addr + 0x10;<br />
ctr_size = 0x10;<br />
out_addr = dec_payload_addr;<br />
out_size = 0x90;<br />
keyslot = 0x0D;<br />
<br />
// AES-CTR decrypt<br />
// Use the keyblob_key (keyslot 0x0D) to decrypt bct_customer_data_addr + 0x20<br />
// using bct_customer_data_addr + 0x10 as CTR<br />
aes_ctr_decrypt(out_addr, out_size, keyslot, in_addr, in_size, ctr_addr, ctr_size);<br />
<br />
// Install the last decrypted keyblob key into keyslot 0x0B<br />
// This is the pk11_key<br />
set_keyslot_data(0x0B, dec_payload_addr + 0x80, 0x10);<br />
<br />
// Install the first decrypted keyblob key into keyslot 0x0C<br />
// This is the master_static_kek<br />
set_keyslot_data(0x0C, dec_payload_addr, 0x10);<br />
<br />
// Clear out the decrypted data<br />
memclear(dec_payload_addr, 0x90);<br />
<br />
in_addr = master_static_seed_addr;<br />
in_size = master_static_seed_size;<br />
keyslot = 0x0C;<br />
keyslot_dst = 0x0C;<br />
<br />
// Use the master_static_kek (keyslot 0x0C) to decrypt<br />
// master_static_seed and install it into keyslot 0x0C<br />
// This will generate the master_static_key<br />
decrypt_keyslot(keyslot_dst, keyslot, in_addr, in_size);<br />
<br />
in_addr = static_seed3_addr;<br />
in_size = 0x10;<br />
keyslot = 0x0D;<br />
keyslot_dst = 0x0D;<br />
<br />
// Use keyblob_key (keyslot 0x0D) to decrypt<br />
// static_seed3_addr and install it into keyslot 0x0D<br />
// This will generate the master_device_key<br />
decrypt_keyslot(keyslot_dst, keyslot, in_addr, in_size);<br />
<br />
return;<br />
</syntaxhighlight><br />
<br />
====== generate_debug_keys ======<br />
In order to generate debug keys, the bootloader only uses static seeds, the SBK and the SSK.<br />
<br />
See the pseudocode bellow for the detailed process.<br />
<br />
<syntaxhighlight lang="c"><br />
u32 in_addr = 0;<br />
u32 in_size = 0;<br />
u32 keyslot = 0;<br />
u32 keyslot_dst = 0;<br />
<br />
in_addr = static_seed8_addr;<br />
in_size = 0x10;<br />
keyslot = 0x0E;<br />
keyslot_dst = 0x0B;<br />
<br />
// Use SBK (keyslot 0x0E) to decrypt the<br />
// static_seed8 and install it to keyslot 0x0B<br />
// This will generate debug_pk11_key<br />
decrypt_keyslot(keyslot_dst, keyslot, in_addr, in_size);<br />
<br />
in_addr = static_seed5_addr;<br />
in_size = 0x10;<br />
keyslot = 0x0E;<br />
keyslot_dst = 0x0C;<br />
<br />
// Use SBK (keyslot 0x0E) to decrypt the<br />
// static_seed5 and install it to keyslot 0x0C<br />
// This will generate debug_master_static_kek<br />
decrypt_keyslot(keyslot_dst, keyslot, in_addr, in_size);<br />
<br />
in_addr = static_seed9_addr;<br />
in_size = 0x10;<br />
keyslot = 0x0F;<br />
keyslot_dst = 0x0D;<br />
<br />
// Use SSK (keyslot 0x0F) to decrypt the<br />
// static_seed9 and install it to keyslot 0x0D<br />
// This will generate debug_keyblob_key<br />
decrypt_keyslot(keyslot_dst, keyslot, in_addr, in_size);<br />
<br />
// Clear SBK and SSK keyslots<br />
clear_keyslot(0x0E);<br />
clear_keyslot(0x0F);<br />
<br />
in_addr = master_static_seed_addr;<br />
in_size = master_static_seed_size;<br />
keyslot = 0x0C;<br />
keyslot_dst = 0x0C;<br />
<br />
// Use the debug_master_static_kek (keyslot 0x0C) to decrypt the<br />
// master_static_seed and install it to keyslot 0x0C<br />
// This will generate the master_static_key<br />
decrypt_keyslot(keyslot_dst, keyslot, in_addr, in_size);<br />
<br />
in_addr = static_seed3_addr;<br />
in_size = 0x10;<br />
keyslot = 0x0D;<br />
keyslot_dst = 0x0D;<br />
<br />
// Use debug_keyblob_key (keyslot 0x0D) to decrypt the<br />
// static_seed3 and install it to keyslot 0x0D<br />
// This will generate the master_device_key<br />
decrypt_keyslot(keyslot_dst, keyslot, in_addr, in_size);<br />
<br />
return;<br />
</syntaxhighlight><br />
<br />
=== Package1 (PK11) ===<br />
This blob is stored encrypted inside the package and is decrypted by package1ldr.<br />
<br />
==== Encryption ====<br />
The encrypted blob is prepended with it's CTR and total image size. After checking the image's size against an hardcoded value (can change on firmware updates), the image is AES-CTR decrypted and the keyslot used for decryption is immediately cleared.<br />
<br />
<syntaxhighlight lang="c"><br />
// Maximum encrypted blob's size on firmware version 1.0.0<br />
u32 max_pk11_enc_blob_size = 0x29000;<br />
<br />
u32 pk11_enc_blob_size = *(u32 *)pk11_blob_addr;<br />
u32 pk11_enc_blob_ctr_addr = pk11_blob_addr + 0x10; <br />
u32 pk11_enc_blob_addr = pk11_blob_addr + 0x20;<br />
<br />
// Validate the encrypted blob's size<br />
if (pk11_enc_blob_size > max_pk11_enc_blob_size)<br />
panic();<br />
<br />
u32 in_addr = pk11_enc_blob_addr;<br />
u32 in_size = pk11_enc_blob_size;<br />
u32 ctr_addr = pk11_enc_blob_ctr_addr;<br />
u32 ctr_size = 0x10;<br />
u32 out_addr = pk11_dec_blob_addr;<br />
u32 out_size = pk11_dec_blob_size;<br />
u32 keyslot = 0x0B;<br />
<br />
// AES-CTR decrypt<br />
// Use the pk11_key (keyslot 0x0B) to decrypt the blob in place<br />
aes_ctr_decrypt(out_addr, out_size, keyslot, in_addr, in_size, ctr_addr, ctr_size);<br />
<br />
// Clear pk11_key keyslot<br />
clear_keyslot(0x0B);<br />
<br />
// Validate the decrypted blob<br />
// Checks the "PK11" magic and some pk11 header fields<br />
bool is_valid = check_pk11_header(pk11_dec_blob_addr, pk11_dec_blob_size);<br />
<br />
// Invalid PK11 image<br />
if (!is_valid)<br />
panic();<br />
<br />
u32 pk11_header_size = 0x20;<br />
u32 pk11_sec1_offset = *(u32 *)pk11_dec_blob_addr + 0x14;<br />
u32 pk11_sec2_size = *(u32 *)pk11_dec_blob_addr + 0x18;<br />
<br />
// Calculate NX bootloader's entrypoint<br />
u32 nx_boot_addr = (pk11_dec_blob_addr + pk11_header_size + pk11_sec1_offset + pk11_sec2_size);<br />
<br />
return nx_boot_addr;<br />
</syntaxhighlight><br />
<br />
==== Header ====<br />
When decrypted, the blob is encapsulated in the following header.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 4<br />
| Magic "PK11"<br />
|-<br />
| 0x4<br />
| 4<br />
| Section 0 size<br />
|-<br />
| 0x8<br />
| 4<br />
| Section 0 offset<br />
|-<br />
| 0xC<br />
| 4<br />
| Unknown<br />
|-<br />
| 0x10<br />
| 4<br />
| Section 1 size<br />
|-<br />
| 0x14<br />
| 4<br />
| Section 1 offset<br />
|-<br />
| 0x18<br />
| 4<br />
| Section 2 size<br />
|-<br />
| 0x1C<br />
| 4<br />
| Section 2 offset<br />
|}<br />
<br />
What each section is used for may vary per system-version.<br />
<br />
==== Section 0 ====<br />
This section contains the warmboot binary.<br />
<br />
==== Section 1 ====<br />
This section contains the NX bootloader, which is run after the initial bootloader in package1.<br />
<br />
==== Section 2 ====<br />
This section contains the Secure Monitor binary.<br />
<br />
== Mariko ==<br />
This package is now distributed in a custom, signed and encrypted format.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x110<br />
| Cryptographic signature<br />
0x0000: CryptoHash (empty)<br />
0x0010: RsaPssSig<br />
|-<br />
| 0x110<br />
| 0x20<br />
| Random block<br />
|-<br />
| 0x130<br />
| 0x20<br />
| SHA256 hash over package1 data<br />
|-<br />
| 0x150<br />
| 0x4<br />
| KeyGeneration<br />
|-<br />
| 0x154<br />
| 0x4<br />
| Length<br />
|-<br />
| 0x158<br />
| 0x4<br />
| LoadAddress<br />
|-<br />
| 0x15C<br />
| 0x4<br />
| EntryPoint<br />
|-<br />
| 0x160<br />
| 0x10<br />
| Reserved<br />
|-<br />
| 0x170<br />
| Variable<br />
| Package1 data<br />
0x0170: [[Package1#Header|Header]]<br />
0x0190: Body (encrypted)<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=NPDM&diff=8896
NPDM
2020-03-11T12:55:45Z
<p>Liam: Update MemoryMap bits and FsAccessControl structure</p>
<hr />
<div>This is the Switch equivalent of 3DS [https://www.3dbrew.org/wiki/NCCH/Extended_Header exheader]. This is the file with extension ".npdm" in {Switch ExeFS}. The size of this file varies.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x80<br />
| [[#META|META]]<br />
|-<br />
| 0x80<br />
| <Varies><br />
| [[#ACID|ACID]]<br />
|-<br />
| <See META><br />
| <See META><br />
| [[#ACI0|ACI0]]<br />
|}<br />
<br />
= META =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magicnum "META"<br />
|-<br />
| 0x4<br />
| 0x4<br />
| [9.0.0+] AcidSignatureKeyGeneration (0 or 1)<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[#Flags|Flags]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Reserved<br />
|-<br />
| 0xE<br />
| 0x1<br />
| [[#MainThreadPriority|MainThreadPriority]]<br />
|-<br />
| 0xF<br />
| 0x1<br />
| MainThreadCoreNumber<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x14<br />
| 0x4<br />
| [3.0.0+] [[#SystemResourceSize|SystemResourceSize]]<br />
|-<br />
| 0x18<br />
| 0x4<br />
| [[#Version|Version]]<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| [[#MainThreadStackSize|MainThreadStackSize]]<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Name (usually/always "Application")<br />
|-<br />
| 0x30<br />
| 0x10<br />
| ProductCode (usually/always all zeroes)<br />
|-<br />
| 0x40<br />
| 0x30<br />
| Reserved<br />
|-<br />
| 0x70<br />
| 0x4<br />
| [[#ACI0|AciOffset]]<br />
|-<br />
| 0x74<br />
| 0x4<br />
| [[#ACI0|AciSize]]<br />
|-<br />
| 0x78<br />
| 0x4<br />
| [[#ACID|AcidOffset]]<br />
|-<br />
| 0x7C<br />
| 0x4<br />
| [[#ACID|AcidSize]]<br />
|}<br />
<br />
== Flags ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 0<br />
| Is64BitInstruction<br />
|-<br />
| 1-3<br />
| ProcessAddressSpace (0x00 = AddressSpace32Bit, 0x01 = AddressSpace64BitOld, 0x02 = AddressSpace32BitNoReserved, 0x03 = AddressSpace64Bit)<br />
|-<br />
| 4<br />
| OptimizeMemoryAllocation<br />
|}<br />
<br />
== MainThreadPriority ==<br />
Ranges from 0 to 0x3F.<br />
<br />
== SystemResourceSize ==<br />
This is the size of PersonalMmHeap. Maximum size as of 5.0.0 is 0x1FE00000.<br />
<br />
== Version ==<br />
0 for all titles.<br />
<br />
[8.1.0+] Now set to 1 for certain titles.<br />
<br />
[9.0.0+] Now set to a proper version field for all titles.<br />
<br />
== MainThreadStackSize ==<br />
Must be aligned to 0x1000.<br />
<br />
In non-nspwn scenarios, values of 0 can also rarely break in Horizon. This might be something auto-adapting or a security feature of some sort?<br />
<br />
= ACID =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x100<br />
| RSA-2048 signature over the data starting at 0x100 with the size field from 0x204<br />
|-<br />
| 0x100<br />
| 0x100<br />
| RSA-2048 public key for the second [[NCA_Format|NCA]] signature<br />
|-<br />
| 0x200<br />
| 0x4<br />
| Magicnum "ACID"<br />
|-<br />
| 0x204<br />
| 0x4<br />
| Size<br />
|-<br />
| 0x208<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x20C<br />
| 0x4<br />
| [[#Flags_2|Flags]]<br />
|-<br />
| 0x210<br />
| 0x8<br />
| ProgramIdMin<br />
|-<br />
| 0x218<br />
| 0x8<br />
| ProgramIdMax<br />
|-<br />
| 0x220<br />
| 0x4<br />
| [[#FsAccessControl|FsAccessControlOffset]]<br />
|-<br />
| 0x224<br />
| 0x4<br />
| [[#FsAccessControl|FsAccessControlSize]]<br />
|-<br />
| 0x228<br />
| 0x4<br />
| [[#SrvAccessControl|SrvAccessControlOffset]]<br />
|-<br />
| 0x22C<br />
| 0x4<br />
| [[#SrvAccessControl|SrvAccessControlSize]]<br />
|-<br />
| 0x230<br />
| 0x4<br />
| [[#KernelCapability|KernelCapabilityOffset]]<br />
|-<br />
| 0x234<br />
| 0x4<br />
| [[#KernelCapability|KernelCapabilitySize]]<br />
|-<br />
| 0x238<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
== Flags ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 0<br />
| ProductionFlag<br />
|-<br />
| 1<br />
| UnqualifiedApproval<br />
|-<br />
| 2-3<br />
| [5.0.0+ ] MemoryRegion (0 = Application, 1 = Applet, 2 = SecureSystem, 3 = NonSecureSystem)<br />
|}<br />
<br />
MemoryRegion is set to Application for "starter" and NonSecureSystem for "nvservices".<br />
<br />
= ACI0 =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magicnum "ACI0"<br />
|-<br />
| 0x4<br />
| 0xC<br />
| Reserved<br />
|-<br />
| 0x10<br />
| 0x8<br />
| ProgramId<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Reserved<br />
|-<br />
| 0x20<br />
| 0x4<br />
| [[#FsAccessControl|FsAccessControlOffset]]<br />
|-<br />
| 0x24<br />
| 0x4<br />
| [[#FsAccessControl|FsAccessControlSize]]<br />
|-<br />
| 0x28<br />
| 0x4<br />
| [[#SrvAccessControl|SrvAccessControlOffset]]<br />
|-<br />
| 0x2C<br />
| 0x4<br />
| [[#SrvAccessControl|SrvAccessControlSize]]<br />
|-<br />
| 0x30<br />
| 0x4<br />
| [[#KernelCapability|KernelCapabilityOffset]]<br />
|-<br />
| 0x34<br />
| 0x4<br />
| [[#KernelCapability|KernelCapabilitySize]]<br />
|-<br />
| 0x38<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
= FsAccessControl =<br />
For [[#ACID|ACID]] this is a simple descriptor as follows:<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| Version (always 1, must be non-zero)<br />
|-<br />
| 0x1<br />
| 0x1<br />
| ContentOwnerIdCount<br />
|-<br />
| 0x2<br />
| 0x1<br />
| SaveDataOwnerIdCount<br />
|-<br />
| 0x3<br />
| 0x1<br />
| Padding<br />
|-<br />
| 0x4<br />
| 0x8<br />
| [[#FsAccessFlag|FsAccessFlag]]<br />
|-<br />
| 0xC<br />
| 0x8<br />
| ContentOwnerIdMin<br />
|-<br />
| 0x14<br />
| 0x8<br />
| ContentOwnerIdMax<br />
|-<br />
| 0x1C<br />
| 0x8<br />
| SaveDataOwnerIdMin<br />
|-<br />
| 0x24<br />
| 0x8<br />
| SaveDataOwnerIdMax<br />
|-<br />
| 0x2C<br />
| 0x8 * ContentOwnerIdCount<br />
| ContentOwnerIds<br />
|-<br />
| Variable<br />
| 0x8 * SaveDataOwnerIdCount<br />
| SaveDataOwnerIds<br />
|}<br />
<br />
For [[#ACI0|ACI0]] this embeds data as follows:<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| Version (always 1, must be non-zero)<br />
|-<br />
| 0x1<br />
| 0x3<br />
| Padding<br />
|-<br />
| 0x4<br />
| 0x8<br />
| [[#FsAccessFlag|FsAccessFlag]]<br />
|-<br />
| 0xC<br />
| 0x4<br />
| ContentOwnerInfoOffset<br />
|-<br />
| 0x10<br />
| 0x4<br />
| ContentOwnerInfoSize<br />
|-<br />
| 0x14<br />
| 0x4<br />
| SaveDataOwnerInfoOffset<br />
|-<br />
| 0x18<br />
| 0x4<br />
| SaveDataOwnerInfoSize<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| (Optional) ContentOwnerIdCount<br />
|-<br />
| 0x1C<br />
| 0x8 * ContentOwnerIdCount<br />
| ContentOwnerIds<br />
|-<br />
| Variable<br />
| 0x4<br />
| SaveDataOwnerIdCount<br />
|-<br />
| Variable<br />
| 0x1 * SaveDataOwnerIdCount<br />
| Accessibilities (1=Read, 2=Write, 3=ReadWrite)<br />
|-<br />
| Variable (padded to nearest 4 bytes)<br />
| 0x8 * SaveDataOwnerIdCount<br />
| SaveDataOwnerIds<br />
|}<br />
<br />
== FsAccessFlag ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Name<br />
! Description<br />
|-<br />
| 0<br />
| ApplicationInfo<br />
| MountContent* is accessible when set.<br />
|-<br />
| 1<br />
| BootModeControl<br />
| <br />
|-<br />
| 2<br />
| Calibration<br />
| <br />
|-<br />
| 3<br />
| SystemSaveData<br />
| <br />
|-<br />
| 4<br />
| GameCard<br />
| <br />
|-<br />
| 5<br />
| SaveDataBackUp<br />
| <br />
|-<br />
| 6<br />
| SaveDataManagement<br />
| <br />
|-<br />
| 7<br />
| BisAllRaw<br />
| <br />
|-<br />
| 8<br />
| GameCardRaw<br />
| <br />
|-<br />
| 9<br />
| GameCardPrivate<br />
| <br />
|-<br />
| 10<br />
| SetTime<br />
| <br />
|-<br />
| 11<br />
| ContentManager<br />
| <br />
|-<br />
| 12<br />
| ImageManager<br />
| <br />
|-<br />
| 13<br />
| CreateSaveData<br />
| <br />
|-<br />
| 14<br />
| SystemSaveDataManagement<br />
| <br />
|-<br />
| 15<br />
| BisFileSystem<br />
| <br />
|-<br />
| 16<br />
| SystemUpdate<br />
| <br />
|-<br />
| 17<br />
| SaveDataMeta<br />
| <br />
|-<br />
| 18<br />
| DeviceSaveData<br />
| <br />
|-<br />
| 19<br />
| SettingsControl<br />
| <br />
|-<br />
| 20<br />
| SystemData<br />
| <br />
|-<br />
| 21<br />
| SdCard<br />
| <br />
|-<br />
| 22<br />
| Host<br />
| <br />
|-<br />
| 23<br />
| FillBis<br />
| <br />
|-<br />
| 24<br />
| CorruptSaveData<br />
| <br />
|-<br />
| 25<br />
| SaveDataForDebug<br />
| <br />
|-<br />
| 26<br />
| FormatSdCard<br />
| <br />
|-<br />
| 27<br />
| GetRightsId<br />
| <br />
|-<br />
| 28<br />
| RegisterExternalKey<br />
| <br />
|-<br />
| 29<br />
| RegisterUpdatePartition<br />
| <br />
|-<br />
| 30<br />
| SaveDataTransfer<br />
| <br />
|-<br />
| 31<br />
| DeviceDetection<br />
|<br />
|-<br />
| 32<br />
| AccessFailureResolution<br />
| <br />
|-<br />
| 33<br />
| SaveDataTransferVersion2<br />
| <br />
|-<br />
| 34<br />
| RegisterProgramIndexMapInfo<br />
| <br />
|-<br />
| 35<br />
| CreateOwnSaveData<br />
| <br />
|-<br />
| 36-61<br />
| Reserved<br />
| <br />
|-<br />
| 62<br />
| Debug<br />
| See [[SPL_services#GetConfig|here]].<br />
|-<br />
| 63<br />
| FullPermission<br />
| Enables access to everything: all [[Filesystem_services#Permissions|permission types]] which check a bitmask have this bit set.<br />
|}<br />
<br />
Controls the [[Filesystem_services#Permissions|filesystem permissions]].<br />
<br />
Web-applets permissions:<br />
* "LibAppletWeb" and "LibAppletOff" have same access control: bit0 and bit3 set, and bit62 set.<br />
* Rest of the web-applets: Same as above except bit0 isn't set.<br />
<br />
= Service Access Control =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 0-2<br />
| Size (length of the service-name without null-terminator minus 1)<br />
|-<br />
| 7<br />
| IsServer (service is allowed to be registered)<br />
|-<br />
| Variable<br />
| Name<br />
|}<br />
<br />
This is a list of [[Services_API|service]]-name strings which the title has access to.<br />
<br />
The service name string starts after the first byte and supports the wildcard <code>*</code> character.<br />
<br />
= KernelCapability =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Pattern of lower bits<br />
! Lowest clear bitmask/bit<br />
! Description<br />
|-<br />
| <code>0bxxxxxxxxxxxx0111</code><br />
| Bit3<br />
| [[#ThreadInfo]]<br />
|-<br />
| <code>0bxxxxxxxxxxx01111</code><br />
| Bit4<br />
| [[#EnableSystemCalls]]<br />
|-<br />
| <code>0bxxxxxxxxx0111111</code><br />
| Bit6<br />
| [[#MemoryMap]]<br />
|-<br />
| <code>0bxxxxxxxx01111111</code><br />
| Bit7<br />
| [[#IoMemoryMap]]<br />
|-<br />
| <code>0bxxxxx01111111111</code><br />
| Bit10<br />
| [8.0.0+] [[#MemoryRegionMap]]<br />
|-<br />
| <code>0bxxxx011111111111</code><br />
| Bit11<br />
| [[#EnableInterrupts]]<br />
|-<br />
| <code>0bxx01111111111111</code><br />
| Bit13<br />
| [[#MiscParams]]<br />
|-<br />
| <code>0bx011111111111111</code><br />
| Bit14<br />
| [[#KernelVersion]]<br />
|-<br />
| <code>0b0111111111111111</code><br />
| Bit15<br />
| [[#HandleTableSize]]<br />
|-<br />
| <code>0b1111111111111111</code><br />
| Bit16<br />
| [[#MiscFlags]]<br />
|-<br />
| All ones<br />
| <br />
| Invalid<br />
|}<br />
<br />
These descriptors are identified by pattern 01..11 in low bits.<br />
<br />
== ThreadInfo ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 4-9<br />
| LowestPriority<br />
|-<br />
| 10-15<br />
| HighestPriority<br />
|-<br />
| 16-23<br />
| MinCoreNumber<br />
|-<br />
| 24-31<br />
| MaxCoreNumber<br />
|}<br />
<br />
== EnableSystemCalls ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 5-28<br />
| SystemCallId<br />
|-<br />
| 29-31<br />
| Index<br />
|}<br />
<br />
== MemoryMap ==<br />
MemoryMap entries are stored in pairs. The first pair will contain BeginAddress and PermissionType, while the second pair will contain Size and MappingType.<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 7-30<br />
| BeginAddress<br />
|-<br />
| 31<br />
| PermissionType (0=RW, 1=RO)<br />
|}<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 7-26<br />
| Size<br />
|-<br />
| 27-30<br />
| Reserved<br />
|-<br />
| 31<br />
| MappingType (0=Io, 1=Static)<br />
|}<br />
<br />
=== Restrictions ===<br />
The physaddr range 0x80060000-0x2000000000 is not allowed to be mapped as IO.<br />
The physaddr range 0x80000000-0x2000000000 is not allowed to be mapped as Normal.<br />
<br />
[2.0.0-4.1.0] The range for IO was changed into 0x80060000-0x81D3FFFF.<br />
<br />
[2.0.0-4.1.0] A blacklist was added for IO and Normal mappings:<br />
* 0x50040000-0x50060000 (ARM, Interrupt Controller)<br />
* 0x6000F000 (Exception Vectors)<br />
* 0x6001DC00-0x6001E000 (IPATCH)<br />
* 0x7000E000 (RTC/PMC)<br />
* 0x70019000 (MC)<br />
* 0x7001C000 (MC0)<br />
* 0x7001D000 (MC1)<br />
<br />
[5.0.0+] For IO, this blacklist was abandoned and instead two range checks were added. For Normal mappings it is still applied<br />
<br />
== IoMemoryMap ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 8-31<br />
| BeginAddress<br />
|}<br />
<br />
== MemoryRegionMap ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 11-16<br />
| RegionType0 (0 = NoMapping, 1 = KernelTraceBuffer, 2 = OnMemoryBootImage, 3 = DTB)<br />
|-<br />
| 17<br />
| RegionIsReadOnly0<br />
|-<br />
| 18-23<br />
| RegionType1 (0 = NoMapping, 1 = KernelTraceBuffer, 2 = OnMemoryBootImage, 3 = DTB)<br />
|-<br />
| 24<br />
| RegionIsReadOnly1<br />
|-<br />
| 25-30<br />
| RegionType2 (0 = NoMapping, 1 = KernelTraceBuffer, 2 = OnMemoryBootImage, 3 = DTB)<br />
|-<br />
| 31<br />
| RegionIsReadOnly2<br />
|}<br />
<br />
MemoryRegionMap is supported by the kernel but not by [[Loader_services|Loader]]. Thus, only initial processes may possess this capability.<br />
<br />
== EnableInterrupts ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 12-21<br />
| InterruptNumber0<br />
|-<br />
| 22-31<br />
| InterruptNumber1<br />
|}<br />
<br />
0x3FF means empty.<br />
<br />
== MiscParams ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 14-16<br />
| ProgramType (0 = System, 1 = Application, 2 = Applet)<br />
|}<br />
<br />
ProgramType is parsed by [[Process Manager services]]. Defaults to 0 if descriptor doesn't exist. Can only run 1 application at a time.<br />
<br />
== KernelVersion ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 15-18<br />
| MinorVersion<br />
|-<br />
| 19-31<br />
| MajorVersion<br />
|}<br />
<br />
This is compared with 0x80000, when less than an error is returned. This is equivalent to comparing the bits starting at bit15 with 0x10. This enforces a minimum required version, not a maximum.<br />
<br />
=== Versions ===<br />
{| class="wikitable" border="1"<br />
|-<br />
! Firmware || Kernel Version || Minimum Allowed<br />
|-<br />
| 1.0.0 || 5.0.0 || 3.0.0<br />
|-<br />
| 2.0.0 || 6.1.0 || 3.0.0<br />
|-<br />
| 3.0.0 || 7.4.0 || 3.0.0<br />
|-<br />
| 3.0.2 || 7.4.0 || 3.0.0<br />
|-<br />
| 5.0.0 || 9.3.0 || 3.0.0<br />
|}<br />
<br />
== HandleTableSize ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 16-25<br />
| HandleTableSize<br />
|}<br />
<br />
== MiscFlags ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bits<br />
! Description<br />
|-<br />
| 17<br />
| EnableDebug<br />
|-<br />
| 18<br />
| ForceDebug<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=Package2&diff=8895
Package2
2020-03-11T12:37:07Z
<p>Liam: </p>
<hr />
<div>Present in the firmware package titles (0100000000000819, 010000000000081A, 010000000000081B and 010000000000081C) and installed into eMMC storage's [[Flash_Filesystem#User_Partitions|BCPKG2 partitions]], "package2" contains the Switch kernel and the built-in system modules.<br />
<br />
= Format =<br />
Package2 is distributed in an already encrypted format. Therefore, it's not additionally encrypted when installed into the flash filesystem.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x100<br />
| [[#Public Keys|RSA-2048]] signature (PKCS#1 v2.1 RSASSA-PSS-VERIFY with SHA256)<br />
|-<br />
| 0x100<br />
| 0x100<br />
| Encrypted header<br />
|-<br />
| 0x200<br />
| Variable<br />
| Encrypted body<br />
|}<br />
<br />
== Encryption ==<br />
Package2's contents are AES-CTR encrypted with a key known only by TrustZone.<br />
<br />
The encrypted header's CTR is stored as it's first 0x10 bytes (offset 0x100).<br />
The encrypted body is divided in up to 4 sections, each one with a CTR stored inside the decrypted header.<br />
<br />
== Header ==<br />
When decrypted, package2's header is as follows.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Header's CTR, official code copies the pre-decryption CTR over the decrypted result. Also used as metadata.<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Section 0 CTR<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Section 1 CTR<br />
|-<br />
| 0x30<br />
| 0x10<br />
| Section 2 CTR<br />
|-<br />
| 0x40<br />
| 0x10<br />
| Section 3 CTR<br />
|-<br />
| 0x50<br />
| 0x4<br />
| Magic "PK21"<br />
|-<br />
| 0x54<br />
| 0x4<br />
| Base offset<br />
|-<br />
| 0x58<br />
| 0x4<br />
| Always 0<br />
|-<br />
| 0x5C<br />
| 0x2<br />
| Version. HighByte must be <{maxver} and LowByte must be >{minver}, where {maxver} and {minver} are constants used by TZ updated with each package1 update.<br />
|-<br />
| 0x5E<br />
| 0x2<br />
| Padding<br />
|-<br />
| 0x60<br />
| 0x4<br />
| Section 0 size<br />
|-<br />
| 0x64<br />
| 0x4<br />
| Section 1 size<br />
|-<br />
| 0x68<br />
| 0x4<br />
| Section 2 size<br />
|-<br />
| 0x6C<br />
| 0x4<br />
| Section 3 size<br />
|-<br />
| 0x70<br />
| 0x4<br />
| Section 0 offset<br />
|-<br />
| 0x74<br />
| 0x4<br />
| Section 1 offset<br />
|-<br />
| 0x78<br />
| 0x4<br />
| Section 2 offset<br />
|-<br />
| 0x7C<br />
| 0x4<br />
| Section 3 offset<br />
|-<br />
| 0x80<br />
| 0x20<br />
| SHA-256 hash over encrypted section 0<br />
|-<br />
| 0xA0<br />
| 0x20<br />
| SHA-256 hash over encrypted section 1<br />
|-<br />
| 0xC0<br />
| 0x20<br />
| SHA-256 hash over encrypted section 2<br />
|-<br />
| 0xE0<br />
| 0x20<br />
| SHA-256 hash over encrypted section 3<br />
|}<br />
<br />
Each section follows each other immediately and is encrypted with the same key used for encrypting the header.<br />
The section offsets are relative to a base, which is typically 0x80000000 pointing to the base of DRAM.<br />
<br />
Before being decrypted, the encrypted header's CTR additionally encodes metadata used to validate package2's contents as follows:<br />
* Size of the entire package2 with the raw header = ctr_word2 ^ ctr_word3 ^ ctr_word0<br />
* Metadata version field = ((ctr_word1 ^ (ctr_word1 >> 16)) & 0xFF) ^ (ctr_word1 >> 24)<br />
<br />
In [4.0.0], the metadata version field must be less or equal to 4.<br />
<br />
== Section 0 ==<br />
When decrypted, this section contains the plaintext Switch kernel binary.<br />
<br />
== Section 1 ==<br />
When decrypted, this section contains the built-in system modules encapsulated in a custom format.<br />
<br />
Note: On firmware [[8.0.0]] INI1 is contained within the Kernel and section 1 is empty with NULL SHA256 to match.<br />
<br />
=== INI1 ===<br />
This is "Initial Process List".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magic "INI1"<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Size<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Number of KIPs (Must be lower than 0x51)<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
==== KIP1 ====<br />
This is "Kernel Initial Process".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magic "KIP1"<br />
|-<br />
| 0x4<br />
| 0xC<br />
| Name<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Program ID<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x1C<br />
| 0x1<br />
| Main Thread Priority<br />
|-<br />
| 0x1D<br />
| 0x1<br />
| Main Thread Core Number<br />
|-<br />
| 0x1E<br />
| 0x1<br />
| Reserved<br />
|-<br />
| 0x1F<br />
| 0x1<br />
| Flags (bit0=TextCompress, bit1=RoCompress, bit2=DataCompress, bit3=Is64BitInstruction, bit4=ProcessAddressSpace64Bit, bit5=[2.0.0+] UseSecureMemory)<br />
|-<br />
| 0x20<br />
| 0xC<br />
| Text [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x2C<br />
| 0x4<br />
| Main Thread Affinity Mask<br />
|-<br />
| 0x30<br />
| 0xC<br />
| Ro [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x3C<br />
| 0x4<br />
| Main Thread Stack Size<br />
|-<br />
| 0x40<br />
| 0xC<br />
| Data [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x4C<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x50<br />
| 0xC<br />
| Bss [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x5C<br />
| 0x24<br />
| Reserved (2 unused [[#Segment_Header|Segment Headers]])<br />
|-<br />
| 0x80<br />
| 0x80<br />
| [[NPDM#KernelCapability|Kernel Capability Data]]<br />
|}<br />
<br />
===== Segment Header =====<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Memory Offset<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Memory Size<br />
|-<br />
| 0x8<br />
| 0x4<br />
| File Size<br />
|}<br />
<br />
File size can be 0 or lower than exepected, this is the case for BSS for example.<br />
<br />
===== Compression =====<br />
The compression used here is BLZ, with a modified footer since 3ds. The footer is now 0xC bytes instead of 0x8, and has the form u32 compressed_data_len; u32 footer_size; u32 additional_len_when_uncompressed;<br />
<br />
== Section 2 ==<br />
This section has a valid CTR and SHA-256 hash (over NULL) stored in the package2's header, but it's size is always 0. Likely reserved for future expansion.<br />
<br />
== Section 3 ==<br />
This section is not present (CTR and SHA-256 hash in package2's header are NULL). Likely reserved for future expansion.<br />
<br />
= Versions =<br />
{| class="wikitable" border="1"<br />
|-<br />
! System version<br />
! Package1 maxver constant<br />
! Package1 minver constant<br />
! Package2 version field<br />
|-<br />
| [[1.0.0]]<br />
| 0x2<br />
| 0x3<br />
| 0x0104<br />
|-<br />
| [[2.0.0]]<br />
| 0x3<br />
| 0x4<br />
| 0x0205<br />
|-<br />
| [[3.0.0]]<br />
| 0x4<br />
| 0x5<br />
| 0x0306<br />
|-<br />
| [[3.0.2]]<br />
| 0x5<br />
| 0x6<br />
| 0x0407<br />
|-<br />
| [[4.0.0]]<br />
| 0x6<br />
| 0x7<br />
| 0x0508<br />
|-<br />
| [[5.0.0]]<br />
| 0x7<br />
| 0x8<br />
| 0x0609<br />
|-<br />
| [[6.0.0]]<br />
| 0x8<br />
| 0x9<br />
| 0x070A<br />
|-<br />
| [[6.2.0]]<br />
| 0x9<br />
| 0xA<br />
| 0x080B<br />
|-<br />
| [[7.0.0]]<br />
| 0xA<br />
| 0xB<br />
| 0x090C<br />
|-<br />
| [[8.1.0]]<br />
| 0xB<br />
| 0xC<br />
| 0x0A0D<br />
|-<br />
| [[9.0.0]]<br />
| 0xC<br />
| 0xD<br />
| 0x0B0E<br />
|-<br />
| [[9.1.0]]<br />
| 0xD<br />
| 0xE<br />
| 0x0C0F<br />
|}<br />
<br />
= Public Keys =<br />
<br />
=== Exponent ===<br />
0x10001<br />
<br />
=== Retail Modulus ===<br />
8D 13 A7 77 6A E5 DC C0 3B 25 D0 58 E4 20 69 59<br />
55 4B AB 70 40 08 28 07 A8 A7 FD 0F 31 2E 11 FE<br />
47 A0 F9 9D DF 80 DB 86 5A 27 89 CD 97 6C 85 C5<br />
6C 39 7F 41 F2 FF 24 20 C3 95 A6 F7 9D 4A 45 74<br />
8B 5D 28 8A C6 99 35 68 85 A5 64 32 80 9F D3 48<br />
39 A2 1D 24 67 69 DF 75 AC 12 B5 BD C3 29 90 BE<br />
37 E4 A0 80 9A BE 36 BF 1F 2C AB 2B AD F5 97 32<br />
9A 42 9D 09 8B 08 F0 63 47 A3 E9 1B 36 D8 2D 8A<br />
D7 E1 54 11 95 E4 45 88 69 8A 2B 35 CE D0 A5 0B<br />
D5 5D AC DB AF 11 4D CA B8 1E E7 01 9E F4 46 A3<br />
8A 94 6D 76 BD 8A C8 3B D2 31 58 0C 79 A8 26 E9<br />
D1 79 9C CB D4 2B 6A 4F C6 CC CF 90 A7 B9 98 47<br />
FD FA 4C 6C 6F 81 87 3B CA B8 50 F6 3E 39 5D 4D<br />
97 3F 0F 35 39 53 FB FA CD AB A8 7A 62 9A 3F F2<br />
09 27 96 3F 07 9A 91 F7 16 BF C6 3A 82 5A 4B CF<br />
49 50 95 8C 55 80 7E 39 B1 48 05 1E 21 C7 24 4F<br />
<br />
=== Debug Modulus ===<br />
B3 65 54 FB 0A B0 1E 85 A7 F6 CF 91 8E BA 96 99<br />
0D 8B 91 69 2A EE 01 20 4F 34 5C 2C 4F 4E 37 C7<br />
F1 0B D4 CD A1 7F 93 F1 33 59 CE B1 E9 DD 26 E6<br />
F3 BB 77 87 46 7A D6 4E 47 4A D1 41 B7 79 4A 38<br />
06 6E CF 61 8F CD C1 40 0B FA 26 DC C0 34 51 83<br />
D9 3B 11 54 3B 96 27 32 9A 95 BE 1E 68 11 50 A0<br />
6B 10 A8 83 8B F5 FC BC 90 84 7A 5A 5C 43 52 E6<br />
C8 26 E9 FE 06 A0 8B 53 0F AF 1E C4 1C 0B CF 50<br />
1A A4 F3 5C FB F0 97 E4 DE 32 0A 9F E3 5A AA B7<br />
44 7F 5C 33 60 B9 0F 22 2D 33 2A E9 69 79 31 42<br />
8F E4 3A 13 8B E7 26 BD 08 87 6C A6 F2 73 F6 8E<br />
A7 F2 FE FB 6C 28 66 0D BD D7 EB 42 A8 78 E6 B8<br />
6B AE C7 A9 E2 40 6E 89 20 82 25 8E 3C 6A 60 D7<br />
F3 56 8E EC 8D 51 8A 63 3C 04 78 23 0E 90 0C B4<br />
E7 86 3B 4F 8E 13 09 47 32 0E 04 B8 4D 5B B0 46<br />
71 B0 5C F4 AD 63 4F C5 E2 AC 1E C4 33 96 09 7B</div>
Liam
https://switchbrew.org/w/index.php?title=Package2&diff=8884
Package2
2020-03-07T17:22:28Z
<p>Liam: </p>
<hr />
<div>Present in the firmware package titles (0100000000000819, 010000000000081A, 010000000000081B and 010000000000081C) and installed into eMMC storage's [[Flash_Filesystem#User_Partitions|BCPKG2 partitions]], "package2" contains the Switch kernel and the built-in system modules.<br />
<br />
= Format =<br />
Package2 is distributed in an already encrypted format. Therefore, it's not additionally encrypted when installed into the flash filesystem.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x100<br />
| [[#Public Keys|RSA-2048]] signature (PKCS#1 v2.1 RSASSA-PSS-VERIFY with SHA256)<br />
|-<br />
| 0x100<br />
| 0x100<br />
| Encrypted header<br />
|-<br />
| 0x200<br />
| Variable<br />
| Encrypted body<br />
|}<br />
<br />
== Encryption ==<br />
Package2's contents are AES-CTR encrypted with a key known only by TrustZone.<br />
<br />
The encrypted header's CTR is stored as it's first 0x10 bytes (offset 0x100).<br />
The encrypted body is divided in up to 4 sections, each one with a CTR stored inside the decrypted header.<br />
<br />
== Header ==<br />
When decrypted, package2's header is as follows.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Header's CTR, official code copies the pre-decryption CTR over the decrypted result. Also used as metadata.<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Section 0 CTR<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Section 1 CTR<br />
|-<br />
| 0x30<br />
| 0x10<br />
| Section 2 CTR<br />
|-<br />
| 0x40<br />
| 0x10<br />
| Section 3 CTR<br />
|-<br />
| 0x50<br />
| 0x4<br />
| Magic "PK21"<br />
|-<br />
| 0x54<br />
| 0x4<br />
| Base offset<br />
|-<br />
| 0x58<br />
| 0x4<br />
| Always 0<br />
|-<br />
| 0x5C<br />
| 0x2<br />
| Version. HighByte must be <{maxver} and LowByte must be >{minver}, where {maxver} and {minver} are constants used by TZ updated with each package1 update.<br />
|-<br />
| 0x5E<br />
| 0x2<br />
| Padding<br />
|-<br />
| 0x60<br />
| 0x4<br />
| Section 0 size<br />
|-<br />
| 0x64<br />
| 0x4<br />
| Section 1 size<br />
|-<br />
| 0x68<br />
| 0x4<br />
| Section 2 size<br />
|-<br />
| 0x6C<br />
| 0x4<br />
| Section 3 size<br />
|-<br />
| 0x70<br />
| 0x4<br />
| Section 0 offset<br />
|-<br />
| 0x74<br />
| 0x4<br />
| Section 1 offset<br />
|-<br />
| 0x78<br />
| 0x4<br />
| Section 2 offset<br />
|-<br />
| 0x7C<br />
| 0x4<br />
| Section 3 offset<br />
|-<br />
| 0x80<br />
| 0x20<br />
| SHA-256 hash over encrypted section 0<br />
|-<br />
| 0xA0<br />
| 0x20<br />
| SHA-256 hash over encrypted section 1<br />
|-<br />
| 0xC0<br />
| 0x20<br />
| SHA-256 hash over encrypted section 2<br />
|-<br />
| 0xE0<br />
| 0x20<br />
| SHA-256 hash over encrypted section 3<br />
|}<br />
<br />
Each section follows each other immediately and is encrypted with the same key used for encrypting the header.<br />
The section offsets are relative to a base, which is typically 0x80000000 pointing to the base of DRAM.<br />
<br />
Before being decrypted, the encrypted header's CTR additionally encodes metadata used to validate package2's contents as follows:<br />
* Size of the entire package2 with the raw header = ctr_word2 ^ ctr_word3 ^ ctr_word0<br />
* Metadata version field = ((ctr_word1 ^ (ctr_word1 >> 16)) & 0xFF) ^ (ctr_word1 >> 24)<br />
<br />
In [4.0.0], the metadata version field must be less or equal to 4.<br />
<br />
== Section 0 ==<br />
When decrypted, this section contains the plaintext Switch kernel binary.<br />
<br />
== Section 1 ==<br />
When decrypted, this section contains the built-in system modules encapsulated in a custom format.<br />
<br />
Note: On firmware [[8.0.0]] INI1 is contained within the Kernel and section 1 is empty with NULL SHA256 to match.<br />
<br />
=== INI1 ===<br />
This is "Initial Process List".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magic "INI1"<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Size<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Number of KIPs (Must be lower than 0x51)<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
==== KIP1 ====<br />
This is "Kernel Initial Process".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magic "KIP1"<br />
|-<br />
| 0x4<br />
| 0xC<br />
| Name<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Program ID<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x1C<br />
| 0x1<br />
| Main Thread Priority<br />
|-<br />
| 0x1D<br />
| 0x1<br />
| Main Thread Core Number<br />
|-<br />
| 0x1E<br />
| 0x1<br />
| Reserved<br />
|-<br />
| 0x1F<br />
| 0x1<br />
| Flags (bit0=TextCompress, bit1=RoCompress, bit2=DataCompress, bit3=Is64BitInstruction, bit4=ProcessAddressSpace64Bit, bit5=[2.0.0+] UseSecureMemory)<br />
|-<br />
| 0x20<br />
| 0xC<br />
| Text [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x2C<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x30<br />
| 0xC<br />
| Ro [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x3C<br />
| 0x4<br />
| Main Thread Stack Size<br />
|-<br />
| 0x40<br />
| 0xC<br />
| Data [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x4C<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x50<br />
| 0xC<br />
| Bss [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x5C<br />
| 0x24<br />
| Reserved (2 unused [[#Segment_Header|Segment Headers]])<br />
|-<br />
| 0x80<br />
| 0x80<br />
| [[NPDM#KernelCapability|Kernel Capability Data]]<br />
|}<br />
<br />
===== Segment Header =====<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Offset<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Decompressed Size<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Compressed Size<br />
|}<br />
<br />
Compressed size can be 0 or lower than exepected, this is the case for BSS for example.<br />
<br />
===== Compression =====<br />
The compression used here is BLZ, with a modified footer since 3ds. The footer is now 0xC bytes instead of 0x8, and has the form u32 compressed_data_len; u32 initial_index; u32 additional_len_when_uncompressed;<br />
<br />
== Section 2 ==<br />
This section has a valid CTR and SHA-256 hash (over NULL) stored in the package2's header, but it's size is always 0. Likely reserved for future expansion.<br />
<br />
== Section 3 ==<br />
This section is not present (CTR and SHA-256 hash in package2's header are NULL). Likely reserved for future expansion.<br />
<br />
= Versions =<br />
{| class="wikitable" border="1"<br />
|-<br />
! System version<br />
! Package1 maxver constant<br />
! Package1 minver constant<br />
! Package2 version field<br />
|-<br />
| [[1.0.0]]<br />
| 0x2<br />
| 0x3<br />
| 0x0104<br />
|-<br />
| [[2.0.0]]<br />
| 0x3<br />
| 0x4<br />
| 0x0205<br />
|-<br />
| [[3.0.0]]<br />
| 0x4<br />
| 0x5<br />
| 0x0306<br />
|-<br />
| [[3.0.2]]<br />
| 0x5<br />
| 0x6<br />
| 0x0407<br />
|-<br />
| [[4.0.0]]<br />
| 0x6<br />
| 0x7<br />
| 0x0508<br />
|-<br />
| [[5.0.0]]<br />
| 0x7<br />
| 0x8<br />
| 0x0609<br />
|-<br />
| [[6.0.0]]<br />
| 0x8<br />
| 0x9<br />
| 0x070A<br />
|-<br />
| [[6.2.0]]<br />
| 0x9<br />
| 0xA<br />
| 0x080B<br />
|-<br />
| [[7.0.0]]<br />
| 0xA<br />
| 0xB<br />
| 0x090C<br />
|-<br />
| [[8.1.0]]<br />
| 0xB<br />
| 0xC<br />
| 0x0A0D<br />
|-<br />
| [[9.0.0]]<br />
| 0xC<br />
| 0xD<br />
| 0x0B0E<br />
|-<br />
| [[9.1.0]]<br />
| 0xD<br />
| 0xE<br />
| 0x0C0F<br />
|}<br />
<br />
= Public Keys =<br />
<br />
=== Exponent ===<br />
0x10001<br />
<br />
=== Retail Modulus ===<br />
8D 13 A7 77 6A E5 DC C0 3B 25 D0 58 E4 20 69 59<br />
55 4B AB 70 40 08 28 07 A8 A7 FD 0F 31 2E 11 FE<br />
47 A0 F9 9D DF 80 DB 86 5A 27 89 CD 97 6C 85 C5<br />
6C 39 7F 41 F2 FF 24 20 C3 95 A6 F7 9D 4A 45 74<br />
8B 5D 28 8A C6 99 35 68 85 A5 64 32 80 9F D3 48<br />
39 A2 1D 24 67 69 DF 75 AC 12 B5 BD C3 29 90 BE<br />
37 E4 A0 80 9A BE 36 BF 1F 2C AB 2B AD F5 97 32<br />
9A 42 9D 09 8B 08 F0 63 47 A3 E9 1B 36 D8 2D 8A<br />
D7 E1 54 11 95 E4 45 88 69 8A 2B 35 CE D0 A5 0B<br />
D5 5D AC DB AF 11 4D CA B8 1E E7 01 9E F4 46 A3<br />
8A 94 6D 76 BD 8A C8 3B D2 31 58 0C 79 A8 26 E9<br />
D1 79 9C CB D4 2B 6A 4F C6 CC CF 90 A7 B9 98 47<br />
FD FA 4C 6C 6F 81 87 3B CA B8 50 F6 3E 39 5D 4D<br />
97 3F 0F 35 39 53 FB FA CD AB A8 7A 62 9A 3F F2<br />
09 27 96 3F 07 9A 91 F7 16 BF C6 3A 82 5A 4B CF<br />
49 50 95 8C 55 80 7E 39 B1 48 05 1E 21 C7 24 4F<br />
<br />
=== Debug Modulus ===<br />
B3 65 54 FB 0A B0 1E 85 A7 F6 CF 91 8E BA 96 99<br />
0D 8B 91 69 2A EE 01 20 4F 34 5C 2C 4F 4E 37 C7<br />
F1 0B D4 CD A1 7F 93 F1 33 59 CE B1 E9 DD 26 E6<br />
F3 BB 77 87 46 7A D6 4E 47 4A D1 41 B7 79 4A 38<br />
06 6E CF 61 8F CD C1 40 0B FA 26 DC C0 34 51 83<br />
D9 3B 11 54 3B 96 27 32 9A 95 BE 1E 68 11 50 A0<br />
6B 10 A8 83 8B F5 FC BC 90 84 7A 5A 5C 43 52 E6<br />
C8 26 E9 FE 06 A0 8B 53 0F AF 1E C4 1C 0B CF 50<br />
1A A4 F3 5C FB F0 97 E4 DE 32 0A 9F E3 5A AA B7<br />
44 7F 5C 33 60 B9 0F 22 2D 33 2A E9 69 79 31 42<br />
8F E4 3A 13 8B E7 26 BD 08 87 6C A6 F2 73 F6 8E<br />
A7 F2 FE FB 6C 28 66 0D BD D7 EB 42 A8 78 E6 B8<br />
6B AE C7 A9 E2 40 6E 89 20 82 25 8E 3C 6A 60 D7<br />
F3 56 8E EC 8D 51 8A 63 3C 04 78 23 0E 90 0C B4<br />
E7 86 3B 4F 8E 13 09 47 32 0E 04 B8 4D 5B B0 46<br />
71 B0 5C F4 AD 63 4F C5 E2 AC 1E C4 33 96 09 7B</div>
Liam
https://switchbrew.org/w/index.php?title=Package2&diff=8883
Package2
2020-03-07T17:12:20Z
<p>Liam: Update KIP1 format</p>
<hr />
<div>Present in the firmware package titles (0100000000000819, 010000000000081A, 010000000000081B and 010000000000081C) and installed into eMMC storage's [[Flash_Filesystem#User_Partitions|BCPKG2 partitions]], "package2" contains the Switch kernel and the built-in system modules.<br />
<br />
= Format =<br />
Package2 is distributed in an already encrypted format. Therefore, it's not additionally encrypted when installed into the flash filesystem.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x100<br />
| [[#Public Keys|RSA-2048]] signature (PKCS#1 v2.1 RSASSA-PSS-VERIFY with SHA256)<br />
|-<br />
| 0x100<br />
| 0x100<br />
| Encrypted header<br />
|-<br />
| 0x200<br />
| Variable<br />
| Encrypted body<br />
|}<br />
<br />
== Encryption ==<br />
Package2's contents are AES-CTR encrypted with a key known only by TrustZone.<br />
<br />
The encrypted header's CTR is stored as it's first 0x10 bytes (offset 0x100).<br />
The encrypted body is divided in up to 4 sections, each one with a CTR stored inside the decrypted header.<br />
<br />
== Header ==<br />
When decrypted, package2's header is as follows.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Header's CTR, official code copies the pre-decryption CTR over the decrypted result. Also used as metadata.<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Section 0 CTR<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Section 1 CTR<br />
|-<br />
| 0x30<br />
| 0x10<br />
| Section 2 CTR<br />
|-<br />
| 0x40<br />
| 0x10<br />
| Section 3 CTR<br />
|-<br />
| 0x50<br />
| 0x4<br />
| Magic "PK21"<br />
|-<br />
| 0x54<br />
| 0x4<br />
| Base offset<br />
|-<br />
| 0x58<br />
| 0x4<br />
| Always 0<br />
|-<br />
| 0x5C<br />
| 0x2<br />
| Version. HighByte must be <{maxver} and LowByte must be >{minver}, where {maxver} and {minver} are constants used by TZ updated with each package1 update.<br />
|-<br />
| 0x5E<br />
| 0x2<br />
| Padding<br />
|-<br />
| 0x60<br />
| 0x4<br />
| Section 0 size<br />
|-<br />
| 0x64<br />
| 0x4<br />
| Section 1 size<br />
|-<br />
| 0x68<br />
| 0x4<br />
| Section 2 size<br />
|-<br />
| 0x6C<br />
| 0x4<br />
| Section 3 size<br />
|-<br />
| 0x70<br />
| 0x4<br />
| Section 0 offset<br />
|-<br />
| 0x74<br />
| 0x4<br />
| Section 1 offset<br />
|-<br />
| 0x78<br />
| 0x4<br />
| Section 2 offset<br />
|-<br />
| 0x7C<br />
| 0x4<br />
| Section 3 offset<br />
|-<br />
| 0x80<br />
| 0x20<br />
| SHA-256 hash over encrypted section 0<br />
|-<br />
| 0xA0<br />
| 0x20<br />
| SHA-256 hash over encrypted section 1<br />
|-<br />
| 0xC0<br />
| 0x20<br />
| SHA-256 hash over encrypted section 2<br />
|-<br />
| 0xE0<br />
| 0x20<br />
| SHA-256 hash over encrypted section 3<br />
|}<br />
<br />
Each section follows each other immediately and is encrypted with the same key used for encrypting the header.<br />
The section offsets are relative to a base, which is typically 0x80000000 pointing to the base of DRAM.<br />
<br />
Before being decrypted, the encrypted header's CTR additionally encodes metadata used to validate package2's contents as follows:<br />
* Size of the entire package2 with the raw header = ctr_word2 ^ ctr_word3 ^ ctr_word0<br />
* Metadata version field = ((ctr_word1 ^ (ctr_word1 >> 16)) & 0xFF) ^ (ctr_word1 >> 24)<br />
<br />
In [4.0.0], the metadata version field must be less or equal to 4.<br />
<br />
== Section 0 ==<br />
When decrypted, this section contains the plaintext Switch kernel binary.<br />
<br />
== Section 1 ==<br />
When decrypted, this section contains the built-in system modules encapsulated in a custom format.<br />
<br />
Note: On firmware [[8.0.0]] INI1 is contained within the Kernel and section 1 is empty with NULL SHA256 to match.<br />
<br />
=== INI1 ===<br />
This is "Initial Process List".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Type<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magic "INI1"<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Size<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Number of KIPs (Must be lower than 0x51)<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
==== KIP1 ====<br />
This is "Kernel Initial Process".<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Type<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magic "KIP1"<br />
|-<br />
| 0x4<br />
| 0xC<br />
| Name<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Program ID<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x1C<br />
| 0x1<br />
| Main Thread Priority<br />
|-<br />
| 0x1D<br />
| 0x1<br />
| Main Thread Core Number<br />
|-<br />
| 0x1E<br />
| 0x1<br />
| Reserved<br />
|-<br />
| 0x1F<br />
| 0x1<br />
| Flags (bit0=TextCompress, bit1=RoCompress, bit2=DataCompress, bit3=Is64BitInstruction, bit4=ProcessAddressSpace64Bit, bit5=[2.0.0+] UseSecureMemory)<br />
|-<br />
| 0x20<br />
| 0xC<br />
| Text [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x2C<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x30<br />
| 0xC<br />
| Ro [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x3C<br />
| 0x4<br />
| Main Thread Stack Size<br />
|-<br />
| 0x40<br />
| 0xC<br />
| Data [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x4C<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x50<br />
| 0xC<br />
| Bss [[#Segment_Header|Segment Header]]<br />
|-<br />
| 0x5C<br />
| 0x24<br />
| Reserved (2 unused [[#Segment_Header|Segment Headers]])<br />
|-<br />
| 0x80<br />
| 0x80<br />
| [[NPDM#KernelCapability|Kernel Capability Data]]<br />
|}<br />
<br />
===== Segment Header =====<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Offset<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Decompressed Size<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Compressed Size<br />
|}<br />
<br />
Compressed size can be 0 or lower than exepected, this is the case for BSS for example.<br />
<br />
===== Compression =====<br />
The compression used here is BLZ, with a modified footer since 3ds. The footer is now 0xC bytes instead of 0x8, and has the form u32 compressed_data_len; u32 initial_index; u32 additional_len_when_uncompressed;<br />
<br />
== Section 2 ==<br />
This section has a valid CTR and SHA-256 hash (over NULL) stored in the package2's header, but it's size is always 0. Likely reserved for future expansion.<br />
<br />
== Section 3 ==<br />
This section is not present (CTR and SHA-256 hash in package2's header are NULL). Likely reserved for future expansion.<br />
<br />
= Versions =<br />
{| class="wikitable" border="1"<br />
|-<br />
! System version<br />
! Package1 maxver constant<br />
! Package1 minver constant<br />
! Package2 version field<br />
|-<br />
| [[1.0.0]]<br />
| 0x2<br />
| 0x3<br />
| 0x0104<br />
|-<br />
| [[2.0.0]]<br />
| 0x3<br />
| 0x4<br />
| 0x0205<br />
|-<br />
| [[3.0.0]]<br />
| 0x4<br />
| 0x5<br />
| 0x0306<br />
|-<br />
| [[3.0.2]]<br />
| 0x5<br />
| 0x6<br />
| 0x0407<br />
|-<br />
| [[4.0.0]]<br />
| 0x6<br />
| 0x7<br />
| 0x0508<br />
|-<br />
| [[5.0.0]]<br />
| 0x7<br />
| 0x8<br />
| 0x0609<br />
|-<br />
| [[6.0.0]]<br />
| 0x8<br />
| 0x9<br />
| 0x070A<br />
|-<br />
| [[6.2.0]]<br />
| 0x9<br />
| 0xA<br />
| 0x080B<br />
|-<br />
| [[7.0.0]]<br />
| 0xA<br />
| 0xB<br />
| 0x090C<br />
|-<br />
| [[8.1.0]]<br />
| 0xB<br />
| 0xC<br />
| 0x0A0D<br />
|-<br />
| [[9.0.0]]<br />
| 0xC<br />
| 0xD<br />
| 0x0B0E<br />
|-<br />
| [[9.1.0]]<br />
| 0xD<br />
| 0xE<br />
| 0x0C0F<br />
|}<br />
<br />
= Public Keys =<br />
<br />
=== Exponent ===<br />
0x10001<br />
<br />
=== Retail Modulus ===<br />
8D 13 A7 77 6A E5 DC C0 3B 25 D0 58 E4 20 69 59<br />
55 4B AB 70 40 08 28 07 A8 A7 FD 0F 31 2E 11 FE<br />
47 A0 F9 9D DF 80 DB 86 5A 27 89 CD 97 6C 85 C5<br />
6C 39 7F 41 F2 FF 24 20 C3 95 A6 F7 9D 4A 45 74<br />
8B 5D 28 8A C6 99 35 68 85 A5 64 32 80 9F D3 48<br />
39 A2 1D 24 67 69 DF 75 AC 12 B5 BD C3 29 90 BE<br />
37 E4 A0 80 9A BE 36 BF 1F 2C AB 2B AD F5 97 32<br />
9A 42 9D 09 8B 08 F0 63 47 A3 E9 1B 36 D8 2D 8A<br />
D7 E1 54 11 95 E4 45 88 69 8A 2B 35 CE D0 A5 0B<br />
D5 5D AC DB AF 11 4D CA B8 1E E7 01 9E F4 46 A3<br />
8A 94 6D 76 BD 8A C8 3B D2 31 58 0C 79 A8 26 E9<br />
D1 79 9C CB D4 2B 6A 4F C6 CC CF 90 A7 B9 98 47<br />
FD FA 4C 6C 6F 81 87 3B CA B8 50 F6 3E 39 5D 4D<br />
97 3F 0F 35 39 53 FB FA CD AB A8 7A 62 9A 3F F2<br />
09 27 96 3F 07 9A 91 F7 16 BF C6 3A 82 5A 4B CF<br />
49 50 95 8C 55 80 7E 39 B1 48 05 1E 21 C7 24 4F<br />
<br />
=== Debug Modulus ===<br />
B3 65 54 FB 0A B0 1E 85 A7 F6 CF 91 8E BA 96 99<br />
0D 8B 91 69 2A EE 01 20 4F 34 5C 2C 4F 4E 37 C7<br />
F1 0B D4 CD A1 7F 93 F1 33 59 CE B1 E9 DD 26 E6<br />
F3 BB 77 87 46 7A D6 4E 47 4A D1 41 B7 79 4A 38<br />
06 6E CF 61 8F CD C1 40 0B FA 26 DC C0 34 51 83<br />
D9 3B 11 54 3B 96 27 32 9A 95 BE 1E 68 11 50 A0<br />
6B 10 A8 83 8B F5 FC BC 90 84 7A 5A 5C 43 52 E6<br />
C8 26 E9 FE 06 A0 8B 53 0F AF 1E C4 1C 0B CF 50<br />
1A A4 F3 5C FB F0 97 E4 DE 32 0A 9F E3 5A AA B7<br />
44 7F 5C 33 60 B9 0F 22 2D 33 2A E9 69 79 31 42<br />
8F E4 3A 13 8B E7 26 BD 08 87 6C A6 F2 73 F6 8E<br />
A7 F2 FE FB 6C 28 66 0D BD D7 EB 42 A8 78 E6 B8<br />
6B AE C7 A9 E2 40 6E 89 20 82 25 8E 3C 6A 60 D7<br />
F3 56 8E EC 8D 51 8A 63 3C 04 78 23 0E 90 0C B4<br />
E7 86 3B 4F 8E 13 09 47 32 0E 04 B8 4D 5B B0 46<br />
71 B0 5C F4 AD 63 4F C5 E2 AC 1E C4 33 96 09 7B</div>
Liam
https://switchbrew.org/w/index.php?title=CNMT&diff=8873
CNMT
2020-03-05T15:59:46Z
<p>Liam: Fix SystemUpdate Extended Data, change some names</p>
<hr />
<div>This is the metadata file that ends in <code>".cnmt{.nca}"</code> or <code>"meta0.ncd"</code>. This seems to replace the TMD format.<br />
<br />
The official name for CNMT is "PackagedContentMeta".<br />
<br />
== Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Program ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Content Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Reserved<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Extended Header Size<br />
|-<br />
| 0x10<br />
| 0x2<br />
| Content Count<br />
|-<br />
| 0x12<br />
| 0x2<br />
| Content Meta Count<br />
|-<br />
| 0x14<br />
| 0x1<br />
| Content Meta Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0x15<br />
| 0x3<br />
| Reserved<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Required Download System Version<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
== SystemUpdate Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Extended Data Size<br />
|}<br />
<br />
== Application Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Patch ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Required Application Version<br />
|}<br />
<br />
== Patch Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
== AddOnContent Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required Application Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
== Delta Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
== Packaged Content Info ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Hash<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Content ID<br />
|-<br />
| 0x30<br />
| 0x6<br />
| Size<br />
|-<br />
| 0x36<br />
| 0x1<br />
| Content Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x37<br />
| 0x1<br />
| ID Offset<br />
|}<br />
<br />
== Content Meta Info ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Program ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Content Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Content Meta Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Reserved<br />
|}<br />
<br />
This is used for SystemUpdate, see here: [[NCM_services#ReadEntryMetaRecords]].<br />
<br />
== SystemUpdate Extended Data ==<br />
<br />
If the Version field is 1, the format is:<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Variation Count<br />
|-<br />
| 0x8<br />
| 0x20 * Variation Count<br />
| [[CNMT#Firmware_Variation_Info_(Version_1)|Firmware Variation Info (Version 1)]]<br />
|}<br />
<br />
If the Version field is 2, the format is:<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Variation Count<br />
|-<br />
| 0x8<br />
| 0x4 * Variation Count<br />
| Firmware Variation ID<br />
|-<br />
| <br />
| 0x20 * Variation Count<br />
| [[CNMT#Firmware_Variation_Info_(Version_2)|Firmware Variation Info (Version 2)]]<br />
|-<br />
| <br />
| 0x10 * Meta Count (From [[CNMT#Firmware_Variation_Info_(Version_2)|Firmware Variation Info (Version 2)]])<br />
| [[CNMT#Content_Meta_Info|Content Meta Info]] (If Refer To Base is True)<br />
|}<br />
<br />
=== Firmware Variation Info (Version 1) ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Firmware Variation ID<br />
|-<br />
| 0x4<br />
| 0x1C<br />
| Reserved<br />
|}<br />
<br />
=== Firmware Variation Info (Version 2) ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| Refer To Base (0=False, 1=True)<br />
|-<br />
| 0x1<br />
| 0x3<br />
| Reserved<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Meta Count<br />
|-<br />
| 0x8<br />
| 0x18<br />
| Reserved<br />
|}<br />
<br />
== Patch Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| History Count<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Delta History Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Delta Count<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Fragment Set Count<br />
|-<br />
| 0x10<br />
| 0x4<br />
| History Content Count<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Delta Content Count<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x1C<br />
| 0x38 * History Count<br />
| [[CNMT#History_Header|History Headers]]<br />
|-<br />
| <br />
| 0x28 * Delta History Count<br />
| [[CNMT#Delta_History|Delta Histories]]<br />
|-<br />
| <br />
| 0x28 * Delta Count<br />
| [[CNMT#Delta_Header|Delta Headers]]<br />
|-<br />
| <br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Fragment_Set|Fragment Sets]]<br />
|-<br />
| <br />
| 0x18 * History Content Count<br />
| [[CNMT#Packaged_Content_Info|History Content Info]] (Packaged Content Info without the Hash entry)<br />
|-<br />
| <br />
| 0x38 * Delta Content Count<br />
| [[CNMT#Packaged_Content_Info|Delta Packaged Content Info]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (From [[CNMT#Fragment_Set|Fragment Sets]])<br />
| [[CNMT#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
=== History Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Content Meta Key (Slightly different Content Meta Info)<br />
|-<br />
| 0x10<br />
| 0x20<br />
| Digest<br />
|-<br />
| 0x30<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x32<br />
| 0x6<br />
| Reserved<br />
|}<br />
<br />
=== Delta History ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Download Size<br />
|-<br />
| 0x20<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
=== Delta Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Reserved<br />
|-<br />
| 0x20<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x22<br />
| 0x6<br />
| Reserved<br />
|}<br />
<br />
=== Fragment Set ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Source Content ID<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Destination Content ID<br />
|-<br />
| 0x20<br />
| 0x6<br />
| Source Size<br />
|-<br />
| 0x26<br />
| 0x6<br />
| Destination Size<br />
|-<br />
| 0x2C<br />
| 0x2<br />
| Fragment Indicator Count<br />
|-<br />
| 0x2E<br />
| 0x1<br />
| Fragment Target Content Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x2F<br />
| 0x1<br />
| Update Type (0=ApplyAsDelta, 1=Overwrite, 2=Create)<br />
|-<br />
| 0x30<br />
| 0x4<br />
| Reserved<br />
|}<br />
<br />
=== Fragment Indicator ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x2<br />
| Content Info Index<br />
|-<br />
| 0x2<br />
| 0x2<br />
| Fragment Index<br />
|}<br />
<br />
== Delta Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Reserved<br />
|-<br />
| 0x20<br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Fragment_Set|Fragment Sets]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (From [[CNMT#Fragment_Set|Fragment Sets]])<br />
| [[CNMT#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
== Digest ==<br />
<br />
Always found at the end of the file.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Digest<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=NRR0&diff=7483
NRR0
2019-08-20T13:55:07Z
<p>Liam: update structure</p>
<hr />
<div>[[Category:File formats]]<br />
The Switch uses the NRR file format to verify [[NRO]] at load time. These files contain hashes of each NRO that is allowed to be loaded by the program. An NRO's SHA-256 hash must match any of the hashes in the hash table. NRRs are signed with RSASSA-PSS-2048/SHA-256.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magic "NRR0"<br />
|-<br />
| 0x4<br />
| 0xC<br />
| Reserved<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Title ID Mask<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Title ID Pattern<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Reserved<br />
|-<br />
| 0x30<br />
| 0x100<br />
| Modulus for verifying the second signature<br />
|-<br />
| 0x130<br />
| 0x100<br />
| First signature signed by a Nintendo key, over the above contents<br />
|-<br />
| 0x230<br />
| 0x100<br />
| Second signature verifiable with the above key, over the rest of the file<br />
|-<br />
| 0x330<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x338<br />
| 0x4<br />
| File Size<br />
|-<br />
| 0x33C<br />
| 0x4<br />
| Module Type<br />
|-<br />
| 0x340<br />
| 0x4<br />
| Hash Offset (Always 0x350)<br />
|-<br />
| 0x344<br />
| 0x4<br />
| Hash Count<br />
|-<br />
| 0x348<br />
| 0x8<br />
| Reserved<br />
|-<br />
| 0x350<br />
| 0x20 * Hash Count<br />
| NRO hashes (SHA-256) <br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=NACP&diff=7482
NACP
2019-08-20T12:04:45Z
<p>Liam: </p>
<hr />
<div>This is '''control.nacp''', "nn::ns::ApplicationControlProperty".<br />
<br />
Roughly equivalent to non-gfx areas of 3DS SMDH. All strings for language-entries are UTF-8, unlike SMDH which uses UTF-16.<br />
<br />
Total size is 0x4000-bytes.<br />
<br />
= Structure =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x3000 (0x300*0x10)<br />
| [[#Title Entry|Title entries]]<br />
|-<br />
| 0x3000<br />
| 0x25<br />
| Isbn<br />
|-<br />
| 0x3025<br />
| 0x1<br />
| StartupUserAccount<br />
|-<br />
| 0x3026<br />
| 0x1<br />
| UserAccountSwitchLock<br />
|-<br />
| 0x3027<br />
| 0x1<br />
| AddOnContentRegistrationType<br />
|-<br />
| 0x3028<br />
| 0x4<br />
| ApplicationAttribute<br />
|-<br />
| 0x302C<br />
| 0x4<br />
| SupportedLanguages<br />
|-<br />
| 0x3030<br />
| 0x4<br />
| ParentalControl<br />
|-<br />
| 0x3034<br />
| 0x1<br />
| Screenshot<br />
|-<br />
| 0x3035<br />
| 0x1<br />
| [[#VideoCaptureMode]]<br />
|-<br />
| 0x3036<br />
| 0x1<br />
| DataLossConfirmation<br />
|-<br />
| 0x3037<br />
| 0x1<br />
| [[#PlayLogPolicy]]<br />
|-<br />
| 0x3038<br />
| 0x8<br />
| PresenceGroupId<br />
|-<br />
| 0x3040<br />
| 0x20<br />
| RatingAge<br />
|-<br />
| 0x3060<br />
| 0x10<br />
| DisplayVersion<br />
|-<br />
| 0x3070<br />
| 0x8<br />
| AddOnContentBaseId<br />
|-<br />
| 0x3078<br />
| 0x8<br />
| SaveDataOwnerId<br />
|-<br />
| 0x3080<br />
| 0x8<br />
| UserAccountSaveDataSize<br />
|-<br />
| 0x3088<br />
| 0x8<br />
| UserAccountSaveDataJournalSize<br />
|-<br />
| 0x3090<br />
| 0x8<br />
| DeviceSaveDataSize<br />
|-<br />
| 0x3098<br />
| 0x8<br />
| DeviceSaveDataJournalSize<br />
|-<br />
| 0x30A0<br />
| 0x8<br />
| BcatDeliveryCacheStorageSize<br />
|-<br />
| 0x30A8<br />
| 0x8<br />
| ApplicationErrorCodeCategory<br />
|-<br />
| 0x30B0<br />
| 0x40 (0x8*0x8)<br />
| LocalCommunicationIds<br />
|-<br />
| 0x30F0<br />
| 0x1<br />
| LogoType<br />
|-<br />
| 0x30F1<br />
| 0x1<br />
| LogoHandling<br />
|-<br />
| 0x30F2<br />
| 0x1<br />
| RuntimeAddOnContentInstall<br />
|-<br />
| 0x30F3<br />
| 0x3<br />
| Reserved<br />
|-<br />
| 0x30F6<br />
| 0x1<br />
| CrashReport<br />
|-<br />
| 0x30F7<br />
| 0x1<br />
| Hdcp<br />
|-<br />
| 0x30F8<br />
| 0x8<br />
| SeedForPseudoDeviceId<br />
|-<br />
| 0x3100<br />
| 0x41<br />
| [[BCAT_Content_Container|BcatPassphrase]] (all-zero when unused)<br />
|-<br />
| 0x3141<br />
| 0x1<br />
| StartupUserAccountOption<br />
|-<br />
| 0x3142<br />
| 0x6<br />
| ReservedForUserAccountSaveDataOperation<br />
|-<br />
| 0x3148<br />
| 0x8<br />
| UserAccountSaveDataMaxSize<br />
|-<br />
| 0x3150<br />
| 0x8<br />
| UserAccountSaveDataMaxJournalSize<br />
|-<br />
| 0x3158<br />
| 0x8<br />
| DeviceSaveDataMaxSize<br />
|-<br />
| 0x3160<br />
| 0x8<br />
| DeviceSaveDataMaxJournalSize<br />
|-<br />
| 0x3168<br />
| 0x8<br />
| TemporaryStorageSize<br />
|-<br />
| 0x3170<br />
| 0x8<br />
| CacheStorageSize<br />
|-<br />
| 0x3178<br />
| 0x8<br />
| CacheStorageJournalSize<br />
|-<br />
| 0x3180<br />
| 0x8<br />
| CacheStorageMaxSizeAndMaxJournalSize<br />
|-<br />
| 0x3188<br />
| 0x8<br />
| CacheStorageMaxIndex<br />
|-<br />
| 0x3190<br />
| 0x80 (0x8*0x10)<br />
| PlayLogQueryableApplicationId<br />
|-<br />
| 0x3210<br />
| 0x1<br />
| PlayLogQueryCapability<br />
|-<br />
| 0x3211<br />
| 0x1<br />
| RepairFlag<br />
|-<br />
| 0x3212<br />
| 0x1<br />
| ProgramIndex<br />
|-<br />
| 0x3213<br />
| 0x1<br />
| RequiredNetworkServiceLicenseOnLaunchFlag<br />
|-<br />
| 0x3214<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x3218<br />
| 0x18<br />
| [[#SendDataConfiguration/ReceivableDataConfiguration Entry|SendDataConfiguration]]<br />
|-<br />
| 0x3230<br />
| 0x180 (0x18 * 0x10)<br />
| [[#SendDataConfiguration/ReceivableDataConfiguration Entry|ReceivableDataConfigurations]]<br />
|-<br />
| 0x33B0<br />
| 0x8<br />
| JitConfigurationFlag<br />
|-<br />
| 0x33B8<br />
| 0x8<br />
| MemorySize<br />
|-<br />
| 0x33C0<br />
| 0xC40<br />
| Reserved<br />
|}<br />
<br />
== Title Entry ==<br />
Total size is 0x300-bytes.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x200<br />
| Application name strings<br />
|-<br />
| 0x200<br />
| 0x100<br />
| Application publisher strings<br />
|}<br />
<br />
Entry index for each [[Settings_services#LanguageCode|language]]:<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Entry-index || Icon [[NCA_Content_FS#FS-type3|language]] filename<br />
|-<br />
| 0 || "AmericanEnglish"<br />
|-<br />
| 1 || "BritishEnglish"<br />
|-<br />
| 2 || "Japanese"<br />
|-<br />
| 3 || "French"<br />
|-<br />
| 4 || "German"<br />
|-<br />
| 5 || "LatinAmericanSpanish"<br />
|-<br />
| 6 || "Spanish"<br />
|-<br />
| 7 || "Italian"<br />
|-<br />
| 8 || "Dutch"<br />
|-<br />
| 9 || "CanadianFrench"<br />
|-<br />
| 10 || "Portuguese"<br />
|-<br />
| 11 || "Russian"<br />
|-<br />
| 12 || "Korean"<br />
|-<br />
| 13 || "TraditionalChinese"<br />
|-<br />
| 14 || "SimplifiedChinese"<br />
|}<br />
<br />
Official apps tend to have the title entries' strings set only to English. Some apps don't have certain title entries set at all. In addition, official apps usually (?) don't have the following title entries set: Korean, Taiwanese, and Chinese.<br />
<br />
== VideoCaptureMode ==<br />
This is the enum used to determine how gameplay recording can occur, if at all.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Meaning<br />
|-<br />
| 0 || Disabled<br />
|-<br />
| 1 || Enabled<br />
|-<br />
| 2 || Automatic<br />
|}<br />
<br />
When this value is 0, gameplay cannot be recorded. When this value is 1, the game must manually sacrifice some of its heap as transfer memory for AM's IApplicationProxy->InitializeGamePlayRecording(). When this value is 2, AM will call NS->BoostSystemMemoryResourceSize(), and allocate the required memory for recording automatically without the usermode process having to do anything.<br />
<br />
== PlayLogPolicy ==<br />
[[Applet_Manager_services|AM]] passes [[Shared_Database_services#PlayLogPolicy|this]] to [[Shared_Database_services|pdm:ntfy]] cmd9.<br />
<br />
== PlayLogQueryCapability ==<br />
This is used with [[Applet_Manager_services|AM]] commands QueryApplicationPlayStatistics and QueryApplicationPlayStatisticsByUid, to verify whether querying the specified titleIDs are allowed. When not allowed, error 0x3E880 is returned.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Value || Meaning || Description<br />
|-<br />
| 0 || None || The specified titleIDs must match the user-process titleID.<br />
|-<br />
| 1 || WhiteList || The specified titleIDs must match the user-process titleID, or one of the titleIDs from PlayLogQueryableApplicationId.<br />
|-<br />
| 2 || All || All titleIDs are allowed.<br />
|}<br />
<br />
== SendDataConfiguration/ReceivableDataConfiguration Entry ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Id<br />
|-<br />
| 0x8<br />
| 0x10<br />
| Key<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=NPDM&diff=7481
NPDM
2019-08-20T11:47:49Z
<p>Liam: </p>
<hr />
<div>This is the Switch equivalent of 3DS [https://www.3dbrew.org/wiki/NCCH/Extended_Header exheader]. This is the file with extension ".npdm" in {Switch ExeFS}. The size of this file varies.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x80<br />
| META<br />
|-<br />
| 0x80<br />
| <Varies><br />
| ACID<br />
|-<br />
| <See META><br />
| <See META><br />
| ACI0<br />
|}<br />
<br />
= META =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magicnum "META"<br />
|-<br />
| 0x4<br />
| 0x8<br />
| Reserved<br />
|-<br />
| 0xC<br />
| 0x1<br />
| MMU flags (bit0 = use 64-bit instructions, bit1 = use 64-bit address space, bit2 = use 32-bit address space, bit3 = use 32-bit address space without reserved region, bit4 = optimize memory allocation?)<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Reserved<br />
|-<br />
| 0xE<br />
| 0x1<br />
| Main thread priority (0-63)<br />
|-<br />
| 0xF<br />
| 0x1<br />
| Main thread core number<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x14<br />
| 0x4<br />
| [3.0.0+] System resource (PersonalMmHeap) size (max size as of 5.x: 534773760)<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Version (0 for all titles prior to [[8.1.0]], 1 for certain titles since).<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| Main thread stack size (Should(?) be page-aligned. In non-nspwn scenarios, values of 0 can also rarely break in Horizon. This might be something auto-adapting or a security feature of some sort?)<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Title name (usually/always "Application")<br />
|-<br />
| 0x30<br />
| 0x10<br />
| Product code (usually/always all zeroes)<br />
|-<br />
| 0x40<br />
| 0x30<br />
| Reserved<br />
|-<br />
| 0x70<br />
| 0x4<br />
| [[#ACI0]] offset<br />
|-<br />
| 0x74<br />
| 0x4<br />
| [[#ACI0]] size<br />
|-<br />
| 0x78<br />
| 0x4<br />
| [[#ACID]] offset<br />
|-<br />
| 0x7C<br />
| 0x4<br />
| [[#ACID]] size<br />
|}<br />
<br />
= ACID =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x100<br />
| RSA-2048 signature over the data starting at 0x100 with the size field from 0x204<br />
|-<br />
| 0x100<br />
| 0x100<br />
| RSA-2048 public key for the second [[NCA_Format|NCA]] signature<br />
|-<br />
| 0x200<br />
| 0x4<br />
| Magicnum "ACID"<br />
|-<br />
| 0x204<br />
| 0x4<br />
| Data size<br />
|-<br />
| 0x208<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x20C<br />
| 0x4<br />
| Flags (bit0 = ProductionFlag, bit1 = UnqualifiedApproval, [5.0.0+] bit2-3: PoolPartition? For applets set to 0b01, for sysmodules set to 0b10. Exceptions: "starter" is set to 0, "nvservices" is set to 3)<br />
|-<br />
| 0x210<br />
| 0x8<br />
| TitleIdRange_Min<br />
|-<br />
| 0x218<br />
| 0x8<br />
| TitleIdRange_Max<br />
|-<br />
| 0x220<br />
| 0x4<br />
| [[#FS Access Control]] offset<br />
|-<br />
| 0x224<br />
| 0x4<br />
| [[#FS Access Control]] size<br />
|-<br />
| 0x228<br />
| 0x4<br />
| [[#Service Access Control]] offset<br />
|-<br />
| 0x22C<br />
| 0x4<br />
| [[#Service Access Control]] size<br />
|-<br />
| 0x230<br />
| 0x4<br />
| [[#Kernel Access Control]] offset<br />
|-<br />
| 0x234<br />
| 0x4<br />
| [[#Kernel Access Control]] size<br />
|-<br />
| 0x238<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
= ACI0 =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magicnum "ACI0"<br />
|-<br />
| 0x4<br />
| 0xC<br />
| Reserved<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Reserved<br />
|-<br />
| 0x20<br />
| 0x4<br />
| [[#FS Access Header]] offset<br />
|-<br />
| 0x24<br />
| 0x4<br />
| [[#FS Access Header]] size<br />
|-<br />
| 0x28<br />
| 0x4<br />
| [[#Service Access Control]] offset<br />
|-<br />
| 0x2C<br />
| 0x4<br />
| [[#Service Access Control]] size<br />
|-<br />
| 0x30<br />
| 0x4<br />
| [[#Kernel Access Control]] offset<br />
|-<br />
| 0x34<br />
| 0x4<br />
| [[#Kernel Access Control]] size<br />
|-<br />
| 0x38<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
= FS Access Header =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| Version (always 1, must be non-zero)<br />
|-<br />
| 0x1<br />
| 0x3<br />
| Padding<br />
|-<br />
| 0x4<br />
| 0x8<br />
| Permissions bitmask<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Data Size (always 0x1C)<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Size of Content Owner ID section.<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Data size (0x1C) plus Content Owner size<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Size of Save Data owners section (for applications that wish to share save data?)<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| (OPTIONAL) Amount of content owner id's<br />
|-<br />
| 0x1C<br />
| 0x8 * Content Owner ID's<br />
| Content owner ID's as uint64's.<br />
|-<br />
| VARIABLE<br />
| 0x4<br />
| Amount of save owner id's<br />
|-<br />
| VARIABLE<br />
| 0x1 * Save data owner accessibilities (?)<br />
| Sets flags for what save data owners can do with other applications save data (?)<br />
|-<br />
| VARIABLE (Pad to nearest 4 bytes)<br />
| 0x8 * Amount of save owner ID's<br />
| Save data owner ID's<br />
|}<br />
<br />
= FS Access Control =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| Version (always 1, must be non-zero)<br />
|-<br />
| 0x1<br />
| 0x3<br />
| Padding<br />
|-<br />
| 0x4<br />
| 0x8<br />
| Permissions bitmask<br />
|-<br />
| 0xC<br />
| 0x20<br />
| Reserved<br />
|}<br />
<br />
[[Filesystem_services#Permissions|Permissions]] bitmask:<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bit<br />
! Name<br />
! Description<br />
|-<br />
| 0<br />
| ApplicationInfo<br />
| MountContent* is accessible when set.<br />
|-<br />
| 1<br />
| BootModeControl<br />
| <br />
|-<br />
| 2<br />
| Calibration<br />
| <br />
|-<br />
| 3<br />
| SystemSaveData<br />
| <br />
|-<br />
| 4<br />
| GameCard<br />
| <br />
|-<br />
| 5<br />
| SaveDataBackUp<br />
| <br />
|-<br />
| 6<br />
| SaveDataManagement<br />
| <br />
|-<br />
| 7<br />
| BisAllRaw<br />
| <br />
|-<br />
| 8<br />
| GameCardRaw<br />
| <br />
|-<br />
| 9<br />
| GameCardPrivate<br />
| <br />
|-<br />
| 10<br />
| SetTime<br />
| <br />
|-<br />
| 11<br />
| ContentManager<br />
| <br />
|-<br />
| 12<br />
| ImageManager<br />
| <br />
|-<br />
| 13<br />
| CreateSaveData<br />
| <br />
|-<br />
| 14<br />
| SystemSaveDataManagement<br />
| <br />
|-<br />
| 15<br />
| BisFileSystem<br />
| <br />
|-<br />
| 16<br />
| SystemUpdate<br />
| <br />
|-<br />
| 17<br />
| SaveDataMeta<br />
| <br />
|-<br />
| 18<br />
| DeviceSaveData<br />
| <br />
|-<br />
| 19<br />
| SettingsControl<br />
| <br />
|-<br />
| 20<br />
| SystemData<br />
| <br />
|-<br />
| 21<br />
| SdCard<br />
| <br />
|-<br />
| 22<br />
| Host<br />
| <br />
|-<br />
| 23<br />
| FillBis<br />
| <br />
|-<br />
| 24<br />
| CorruptSaveData<br />
| <br />
|-<br />
| 25<br />
| SaveDataForDebug<br />
| <br />
|-<br />
| 26<br />
| FormatSdCard<br />
| <br />
|-<br />
| 27<br />
| GetRightsId<br />
| <br />
|-<br />
| 28<br />
| RegisterExternalKey<br />
| <br />
|-<br />
| 29<br />
| RegisterUpdatePartition<br />
| <br />
|-<br />
| 30<br />
| SaveDataTransfer<br />
| <br />
|-<br />
| 31<br />
| DeviceDetection<br />
|<br />
|-<br />
| 32<br />
| AccessFailureResolution<br />
| <br />
|-<br />
| 33<br />
| SaveDataTransferVersion2<br />
| <br />
|-<br />
| 34-61<br />
| Reserved<br />
| <br />
|-<br />
| 62<br />
| Debug<br />
| See [[SPL_services#GetConfig|here]].<br />
|-<br />
| 63<br />
| FullPermission<br />
| Enables access to everything: all [[Filesystem_services#Permissions|permission types]] which check a bitmask have this bit set.<br />
|}<br />
<br />
Web-applets permissions:<br />
* "LibAppletWeb" and "LibAppletOff" have same access control: bit0 and bit3 set, and bit62 set.<br />
* Rest of the web-applets: Same as above except bit0 isn't set.<br />
<br />
= Service Access Control =<br />
This is a list of [[Services_API|service]]-name strings which the title has access to, with the following structure:<br />
+0: control_byte<br />
+1: {service-name without nul-terminator}<br />
<br />
Bitmask 0x07 in control_byte is the {length of the service-name without nul-terminator} - 1.<br />
<br />
Bitmask 0x80 in control_byte means service is allowed to be registered.<br />
<br />
The service string can contain a wildcard <code>*</code> character.<br />
<br />
= Kernel Access Control =<br />
On Switch, descriptors are identified by pattern 01..11 in low bits.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Pattern of lower bits<br />
! Lowest clear bitmask/bit<br />
! Type<br />
! Fields<br />
|-<br />
| <code>0bxxxxxxxxxxxx0111</code><br />
| Bit3<br />
| KernelFlags<br />
| Bit31-24: Highest allowed cpu id, bit23-16: Lowest allowed cpu id, bit15-10: Highest allowed thread prio, bit9-4: Lowest allowed thread prio<br />
|-<br />
| <code>0bxxxxxxxxxxx01111</code><br />
| Bit4<br />
| SyscallMask<br />
| Bits 29-31: Syscall mask table index; Bits 5-28: Mask<br />
|-<br />
| <code>0bxxxxxxxxx0111111</code><br />
| Bit6<br />
| MapIoOrNormalRange<br />
| Bits 7-30: Alternating start page and number of pages, bit31: Alternating read-only flag then MemoryAttribute 0x2001/0x42002 selector flag<br />
|-<br />
| <code>0bxxxxxxxx01111111</code><br />
| Bit7<br />
| MapNormalPage (RW)<br />
| Bits 8-31: Page<br />
|-<br />
| <code>0bxxxx011111111111</code><br />
| Bit11<br />
| InterruptPair<br />
| Bits 12-21: Irq0, bits 22-31: Irq1, 0x3FF means empty.<br />
|-<br />
| <code>0bxx01111111111111</code><br />
| Bit13<br />
| ApplicationType<br />
| Bit16-14: ApplicationType (0=sysmodule, 1=application, 2=applet), bit16 ignored. Parsed by [[Process Manager services]]. Defaults to 0 if descriptor doesn't exist. Can only run 1 application at a time.<br />
|-<br />
| <code>0bx011111111111111</code><br />
| Bit14<br />
| KernelReleaseVersion<br />
| Bits 15-X: Version. The raw descriptor is compared with 0x80000, when less than an error is returned. This is equivalent to comparing the bits starting at bit15 with 0x10. This enforces a minimum required version, not a maximum.<br />
|-<br />
| <code>0b0111111111111111</code><br />
| Bit15<br />
| HandleTableSize<br />
| Bit25-16: Number of handles the table shall fit.<br />
|-<br />
| <code>0b1111111111111111</code><br />
| Bit16<br />
| DebugFlags<br />
| Bit17: can be debugged, bit18: can debug others<br />
|-<br />
| All ones<br />
| <br />
| Ignored<br />
|<br />
|}<br />
<br />
== Mapping restrictions ==<br />
The physaddr range 0x80060000-0x2000000000 is not allowed to be mapped as IO.<br />
The physaddr range 0x80000000-0x2000000000 is not allowed to be mapped as Normal.<br />
<br />
[2.0.0-4.1.0] The range for IO was changed into 0x80060000-0x81D3FFFF.<br />
<br />
[2.0.0-4.1.0] A blacklist was added for IO and Normal mappings:<br />
* 0x50040000-0x50060000 (ARM, Interrupt Controller)<br />
* 0x6000F000 (Exception Vectors)<br />
* 0x6001DC00-0x6001E000 (IPATCH)<br />
* 0x7000E000 (RTC/PMC)<br />
* 0x70019000 (MC)<br />
* 0x7001C000 (MC0)<br />
* 0x7001D000 (MC1)<br />
<br />
[5.0.0+] For IO, this blacklist was abandoned and instead two range checks were added. For Normal mappings it is still applied<br />
<br />
== Kernel versions ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Firmware || Kernel Version || Minimum Allowed<br />
|-<br />
| 1.0.0 || 5.0.0 || 3.0.0<br />
|-<br />
| 2.0.0 || 6.1.0 || 3.0.0<br />
|-<br />
| 3.0.0 || 7.4.0 || 3.0.0<br />
|-<br />
| 3.0.2 || 7.4.0 || 3.0.0<br />
|-<br />
| 5.0.0 || 9.3.0 || 3.0.0<br />
|}<br />
<br />
Bit31-19: Major version</br><br />
Bit18-15: Minor version</br><br />
Bit14-0: Zeroes</div>
Liam
https://switchbrew.org/w/index.php?title=NPDM&diff=7480
NPDM
2019-08-20T11:46:58Z
<p>Liam: update permissions bitmask, add meta flags bit4</p>
<hr />
<div>This is the Switch equivalent of 3DS [https://www.3dbrew.org/wiki/NCCH/Extended_Header exheader]. This is the file with extension ".npdm" in {Switch ExeFS}. The size of this file varies.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x80<br />
| META<br />
|-<br />
| 0x80<br />
| <Varies><br />
| ACID<br />
|-<br />
| <See META><br />
| <See META><br />
| ACI0<br />
|}<br />
<br />
= META =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magicnum "META"<br />
|-<br />
| 0x4<br />
| 0x8<br />
| Reserved<br />
|-<br />
| 0xC<br />
| 0x1<br />
| MMU flags (bit0 = use 64-bit instructions, bit1 = use 64-bit address space, bit2 = use 32-bit address space, bit3 = use 32-bit address space without reserved region, bit4 = optimize memory allocation?)<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Reserved<br />
|-<br />
| 0xE<br />
| 0x1<br />
| Main thread priority (0-63)<br />
|-<br />
| 0xF<br />
| 0x1<br />
| Main thread core number<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x14<br />
| 0x4<br />
| [3.0.0+] System resource (PersonalMmHeap) size (max size as of 5.x: 534773760)<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Version (0 for all titles prior to [[8.1.0]], 1 for certain titles since).<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| Main thread stack size (Should(?) be page-aligned. In non-nspwn scenarios, values of 0 can also rarely break in Horizon. This might be something auto-adapting or a security feature of some sort?)<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Title name (usually/always "Application")<br />
|-<br />
| 0x30<br />
| 0x10<br />
| Product code (usually/always all zeroes)<br />
|-<br />
| 0x40<br />
| 0x30<br />
| Reserved<br />
|-<br />
| 0x70<br />
| 0x4<br />
| [[#ACI0]] offset<br />
|-<br />
| 0x74<br />
| 0x4<br />
| [[#ACI0]] size<br />
|-<br />
| 0x78<br />
| 0x4<br />
| [[#ACID]] offset<br />
|-<br />
| 0x7C<br />
| 0x4<br />
| [[#ACID]] size<br />
|}<br />
<br />
= ACID =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x100<br />
| RSA-2048 signature over the data starting at 0x100 with the size field from 0x204<br />
|-<br />
| 0x100<br />
| 0x100<br />
| RSA-2048 public key for the second [[NCA_Format|NCA]] signature<br />
|-<br />
| 0x200<br />
| 0x4<br />
| Magicnum "ACID"<br />
|-<br />
| 0x204<br />
| 0x4<br />
| Data size<br />
|-<br />
| 0x208<br />
| 0x4<br />
| Reserved<br />
|-<br />
| 0x20C<br />
| 0x4<br />
| Flags (bit0 = ProductionFlag, bit1 = UnqualifiedApproval, [5.0.0+] bit2-3: PoolPartition? For applets set to 0b01, for sysmodules set to 0b10. Exceptions: "starter" is set to 0, "nvservices" is set to 3)<br />
|-<br />
| 0x210<br />
| 0x8<br />
| TitleIdRange_Min<br />
|-<br />
| 0x218<br />
| 0x8<br />
| TitleIdRange_Max<br />
|-<br />
| 0x220<br />
| 0x4<br />
| [[#FS Access Control]] offset<br />
|-<br />
| 0x224<br />
| 0x4<br />
| [[#FS Access Control]] size<br />
|-<br />
| 0x228<br />
| 0x4<br />
| [[#Service Access Control]] offset<br />
|-<br />
| 0x22C<br />
| 0x4<br />
| [[#Service Access Control]] size<br />
|-<br />
| 0x230<br />
| 0x4<br />
| [[#Kernel Access Control]] offset<br />
|-<br />
| 0x234<br />
| 0x4<br />
| [[#Kernel Access Control]] size<br />
|-<br />
| 0x238<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
= ACI0 =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Magicnum "ACI0"<br />
|-<br />
| 0x4<br />
| 0xC<br />
| Reserved<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Reserved<br />
|-<br />
| 0x20<br />
| 0x4<br />
| [[#FS Access Header]] offset<br />
|-<br />
| 0x24<br />
| 0x4<br />
| [[#FS Access Header]] size<br />
|-<br />
| 0x28<br />
| 0x4<br />
| [[#Service Access Control]] offset<br />
|-<br />
| 0x2C<br />
| 0x4<br />
| [[#Service Access Control]] size<br />
|-<br />
| 0x30<br />
| 0x4<br />
| [[#Kernel Access Control]] offset<br />
|-<br />
| 0x34<br />
| 0x4<br />
| [[#Kernel Access Control]] size<br />
|-<br />
| 0x38<br />
| 0x8<br />
| Reserved<br />
|}<br />
<br />
= FS Access Header =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| Version (always 1, must be non-zero)<br />
|-<br />
| 0x1<br />
| 0x3<br />
| Padding<br />
|-<br />
| 0x4<br />
| 0x8<br />
| Permissions bitmask<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Data Size (always 0x1C)<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Size of Content Owner ID section.<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Data size (0x1C) plus Content Owner size<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Size of Save Data owners section (for applications that wish to share save data?)<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| (OPTIONAL) Amount of content owner id's<br />
|-<br />
| 0x1C<br />
| 0x8 * Content Owner ID's<br />
| Content owner ID's as uint64's.<br />
|-<br />
| VARIABLE<br />
| 0x4<br />
| Amount of save owner id's<br />
|-<br />
| VARIABLE<br />
| 0x1 * Save data owner accessibilities (?)<br />
| Sets flags for what save data owners can do with other applications save data (?)<br />
|-<br />
| VARIABLE (Pad to nearest 4 bytes)<br />
| 0x8 * Amount of save owner ID's<br />
| Save data owner ID's<br />
|}<br />
<br />
= FS Access Control =<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x1<br />
| Version (always 1, must be non-zero)<br />
|-<br />
| 0x1<br />
| 0x3<br />
| Padding<br />
|-<br />
| 0x4<br />
| 0x8<br />
| Permissions bitmask<br />
|-<br />
| 0xC<br />
| 0x20<br />
| Reserved<br />
|}<br />
<br />
[[Filesystem_services#Permissions|Permissions]] bitmask:<br />
{| class="wikitable" border="1"<br />
|-<br />
! Bit<br />
! Name<br />
! Description<br />
|-<br />
| 0<br />
| ApplicationInfo<br />
| MountContent* is accessible when set.<br />
|-<br />
| 1<br />
| BootModeControl<br />
| <br />
|-<br />
| 2<br />
| Calibration<br />
| <br />
|-<br />
| 3<br />
| SystemSaveData<br />
| <br />
|-<br />
| 4<br />
| GameCard<br />
| <br />
|-<br />
| 5<br />
| SaveDataBackUp<br />
| <br />
|-<br />
| 6<br />
| SaveDataManagement<br />
| <br />
|-<br />
| 7<br />
| BisAllRaw<br />
| <br />
|-<br />
| 8<br />
| GameCardRaw<br />
| <br />
|-<br />
| 9<br />
| GameCardPrivate<br />
| <br />
|-<br />
| 10<br />
| SetTime<br />
| <br />
|-<br />
| 11<br />
| ContentManager<br />
| <br />
|-<br />
| 12<br />
| ImageManager<br />
| <br />
|-<br />
| 13<br />
| CreateSaveData<br />
| <br />
|-<br />
| 14<br />
| SystemSaveDataManagement<br />
| <br />
|-<br />
| 15<br />
| BisFileSystem<br />
| <br />
|-<br />
| 16<br />
| SystemUpdate<br />
| <br />
|-<br />
| 17<br />
| SaveDataMeta<br />
| <br />
|-<br />
| 18<br />
| DeviceSaveData<br />
| <br />
|-<br />
| 19<br />
| SettingsControl<br />
| <br />
|-<br />
| 20<br />
| SystemData<br />
| <br />
|-<br />
| 21<br />
| SdCard<br />
| <br />
|-<br />
| 22<br />
| Host<br />
| <br />
|-<br />
| 23<br />
| FillBis<br />
| <br />
|-<br />
| 24<br />
| CorruptSaveData<br />
| <br />
|-<br />
| 25<br />
| SaveDataForDebug<br />
| <br />
|-<br />
| 26<br />
| FormatSdCard<br />
| <br />
|-<br />
| 27<br />
| GetRightsId<br />
| <br />
|-<br />
| 28<br />
| RegisterExternalKey<br />
| <br />
|-<br />
| 29<br />
| RegisterUpdatePartition<br />
| <br />
|-<br />
| 30<br />
| SaveDataTransfer<br />
| <br />
|-<br />
| 31<br />
| DeviceDetection<br />
|<br />
|-<br />
| 32<br />
| AccessFailureResolution<br />
| <br />
|-<br />
| 33<br />
| SaveDataTransferVersion2<br />
| <br />
|-<br />
| 34<br />
| Reserved<br />
| <br />
|-<br />
| 35-61<br />
| Reserved<br />
| <br />
|-<br />
| 62<br />
| Debug<br />
| See [[SPL_services#GetConfig|here]].<br />
|-<br />
| 63<br />
| FullPermission<br />
| Enables access to everything: all [[Filesystem_services#Permissions|permission types]] which check a bitmask have this bit set.<br />
|}<br />
<br />
Web-applets permissions:<br />
* "LibAppletWeb" and "LibAppletOff" have same access control: bit0 and bit3 set, and bit62 set.<br />
* Rest of the web-applets: Same as above except bit0 isn't set.<br />
<br />
= Service Access Control =<br />
This is a list of [[Services_API|service]]-name strings which the title has access to, with the following structure:<br />
+0: control_byte<br />
+1: {service-name without nul-terminator}<br />
<br />
Bitmask 0x07 in control_byte is the {length of the service-name without nul-terminator} - 1.<br />
<br />
Bitmask 0x80 in control_byte means service is allowed to be registered.<br />
<br />
The service string can contain a wildcard <code>*</code> character.<br />
<br />
= Kernel Access Control =<br />
On Switch, descriptors are identified by pattern 01..11 in low bits.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Pattern of lower bits<br />
! Lowest clear bitmask/bit<br />
! Type<br />
! Fields<br />
|-<br />
| <code>0bxxxxxxxxxxxx0111</code><br />
| Bit3<br />
| KernelFlags<br />
| Bit31-24: Highest allowed cpu id, bit23-16: Lowest allowed cpu id, bit15-10: Highest allowed thread prio, bit9-4: Lowest allowed thread prio<br />
|-<br />
| <code>0bxxxxxxxxxxx01111</code><br />
| Bit4<br />
| SyscallMask<br />
| Bits 29-31: Syscall mask table index; Bits 5-28: Mask<br />
|-<br />
| <code>0bxxxxxxxxx0111111</code><br />
| Bit6<br />
| MapIoOrNormalRange<br />
| Bits 7-30: Alternating start page and number of pages, bit31: Alternating read-only flag then MemoryAttribute 0x2001/0x42002 selector flag<br />
|-<br />
| <code>0bxxxxxxxx01111111</code><br />
| Bit7<br />
| MapNormalPage (RW)<br />
| Bits 8-31: Page<br />
|-<br />
| <code>0bxxxx011111111111</code><br />
| Bit11<br />
| InterruptPair<br />
| Bits 12-21: Irq0, bits 22-31: Irq1, 0x3FF means empty.<br />
|-<br />
| <code>0bxx01111111111111</code><br />
| Bit13<br />
| ApplicationType<br />
| Bit16-14: ApplicationType (0=sysmodule, 1=application, 2=applet), bit16 ignored. Parsed by [[Process Manager services]]. Defaults to 0 if descriptor doesn't exist. Can only run 1 application at a time.<br />
|-<br />
| <code>0bx011111111111111</code><br />
| Bit14<br />
| KernelReleaseVersion<br />
| Bits 15-X: Version. The raw descriptor is compared with 0x80000, when less than an error is returned. This is equivalent to comparing the bits starting at bit15 with 0x10. This enforces a minimum required version, not a maximum.<br />
|-<br />
| <code>0b0111111111111111</code><br />
| Bit15<br />
| HandleTableSize<br />
| Bit25-16: Number of handles the table shall fit.<br />
|-<br />
| <code>0b1111111111111111</code><br />
| Bit16<br />
| DebugFlags<br />
| Bit17: can be debugged, bit18: can debug others<br />
|-<br />
| All ones<br />
| <br />
| Ignored<br />
|<br />
|}<br />
<br />
== Mapping restrictions ==<br />
The physaddr range 0x80060000-0x2000000000 is not allowed to be mapped as IO.<br />
The physaddr range 0x80000000-0x2000000000 is not allowed to be mapped as Normal.<br />
<br />
[2.0.0-4.1.0] The range for IO was changed into 0x80060000-0x81D3FFFF.<br />
<br />
[2.0.0-4.1.0] A blacklist was added for IO and Normal mappings:<br />
* 0x50040000-0x50060000 (ARM, Interrupt Controller)<br />
* 0x6000F000 (Exception Vectors)<br />
* 0x6001DC00-0x6001E000 (IPATCH)<br />
* 0x7000E000 (RTC/PMC)<br />
* 0x70019000 (MC)<br />
* 0x7001C000 (MC0)<br />
* 0x7001D000 (MC1)<br />
<br />
[5.0.0+] For IO, this blacklist was abandoned and instead two range checks were added. For Normal mappings it is still applied<br />
<br />
== Kernel versions ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Firmware || Kernel Version || Minimum Allowed<br />
|-<br />
| 1.0.0 || 5.0.0 || 3.0.0<br />
|-<br />
| 2.0.0 || 6.1.0 || 3.0.0<br />
|-<br />
| 3.0.0 || 7.4.0 || 3.0.0<br />
|-<br />
| 3.0.2 || 7.4.0 || 3.0.0<br />
|-<br />
| 5.0.0 || 9.3.0 || 3.0.0<br />
|}<br />
<br />
Bit31-19: Major version</br><br />
Bit18-15: Minor version</br><br />
Bit14-0: Zeroes</div>
Liam
https://switchbrew.org/w/index.php?title=CNMT&diff=6944
CNMT
2019-05-22T15:09:17Z
<p>Liam: </p>
<hr />
<div>This is the metadata file that ends in <code>".cnmt{.nca}"</code> or <code>"meta0.ncd"</code>. This seems to replace the TMD format.<br />
<br />
There's at least 9 different filenames used for ".cnmt":<br />
* "Application_{lower-case hex titleID}.cnmt"<br />
* "Patch_{lower-case hex titleID}.cnmt"<br />
* "AddOnContent_{lower-case hex titleID}.cnmt"<br />
* "SystemUpdate_{hex titleID}.cnmt"<br />
* "SystemData_{lower-case hex titleID}.cnmt"<br />
* "SystemProgram_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackage_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackageSafe_{lower-case hex titleID}.cnmt"<br />
* "Delta_{lower-case hex titleID}.cnmt"<br />
<br />
== Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Unused<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Extended Header Size<br />
|-<br />
| 0x10<br />
| 0x2<br />
| Content Count<br />
|-<br />
| 0x12<br />
| 0x2<br />
| Content Meta Count<br />
|-<br />
| 0x14<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0x15<br />
| 0x3<br />
| Unused<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Required Download System Version<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== SystemUpdate Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Extended Data Size<br />
|}<br />
<br />
== Application Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Patch ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Patch Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
== AddOnContent Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required Application Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Delta Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Content Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Hash<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Content ID<br />
|-<br />
| 0x30<br />
| 0x6<br />
| Size<br />
|-<br />
| 0x36<br />
| 0x1<br />
| Content Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x37<br />
| 0x1<br />
| Id Offset<br />
|}<br />
<br />
== Content Meta Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|}<br />
<br />
This is used for SystemUpdate, see here: [[NCM_services#ReadEntryMetaRecords]].<br />
<br />
== SystemUpdate Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Variation Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Firmware Variation<br />
|- <br />
| 0xC<br />
| 0x1C * Variation Count<br />
| Unused<br />
|}<br />
<br />
== Patch Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| History Count<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Delta History Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Delta Count<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Fragment Set Count<br />
|-<br />
| 0x10<br />
| 0x4<br />
| History Content Count<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Delta Content Count<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Unused<br />
|-<br />
| 0x1C<br />
| 0x38 * History Count<br />
| [[CNMT#History_Header|History Headers]]<br />
|-<br />
| <br />
| 0x28 * Delta History Count<br />
| [[CNMT#Delta_History|Delta Histories]]<br />
|-<br />
| <br />
| 0x28 * Delta Count<br />
| [[CNMT#Delta_Header|Delta Headers]]<br />
|-<br />
| <br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Fragment_Set|Fragment Sets]]<br />
|-<br />
| <br />
| 0x18 * History Content Count<br />
| [[CNMT#Content_Records|History Content Records (Content Records without the Hash entry)]]<br />
|-<br />
| <br />
| 0x38 * Delta Content Count<br />
| [[CNMT#Content_Records|Delta Content Records]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (Fragment Set)<br />
| [[CNMT#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
=== History Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| [[CNMT#Content_Meta_Records|Content Meta Record]]<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|-<br />
| 0x10<br />
| 0x20<br />
| Digest<br />
|-<br />
| 0x30<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x32<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Delta History ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Download Size<br />
|-<br />
| 0x20<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
=== Delta Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Unused<br />
|-<br />
| 0x20<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x22<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Fragment Set ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Source Content ID<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Destination Content ID<br />
|-<br />
| 0x20<br />
| 0x6<br />
| Source Size<br />
|-<br />
| 0x26<br />
| 0x6<br />
| Destination Size<br />
|-<br />
| 0x2C<br />
| 0x2<br />
| Fragment Indicator Count<br />
|-<br />
| 0x2E<br />
| 0x1<br />
| Content Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x2F<br />
| 0x1<br />
| Update Type (0=ApplyAsDelta, 1=Overwrite, 2=Create)<br />
|-<br />
| 0x30<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
=== Fragment Indicator ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x2<br />
| Content Info Index<br />
|-<br />
| 0x2<br />
| 0x2<br />
| Fragment Index<br />
|}<br />
<br />
== Delta Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Unused<br />
|-<br />
| 0x20<br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Fragment_Set|Fragment Sets]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (Fragment Set)<br />
| [[CNMT#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
== Digest ==<br />
<br />
Always found at the end of the file.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Digest<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=CNMT&diff=6943
CNMT
2019-05-22T14:11:35Z
<p>Liam: </p>
<hr />
<div>This is the metadata file that ends in <code>".cnmt{.nca}"</code> or <code>"meta0.ncd"</code>. This seems to replace the TMD format.<br />
<br />
There's at least 9 different filenames used for ".cnmt":<br />
* "Application_{lower-case hex titleID}.cnmt"<br />
* "Patch_{lower-case hex titleID}.cnmt"<br />
* "AddOnContent_{lower-case hex titleID}.cnmt"<br />
* "SystemUpdate_{hex titleID}.cnmt"<br />
* "SystemData_{lower-case hex titleID}.cnmt"<br />
* "SystemProgram_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackage_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackageSafe_{lower-case hex titleID}.cnmt"<br />
* "Delta_{lower-case hex titleID}.cnmt"<br />
<br />
== Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Unused<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Extended Header Size<br />
|-<br />
| 0x10<br />
| 0x2<br />
| Content Count<br />
|-<br />
| 0x12<br />
| 0x2<br />
| Content Meta Count<br />
|-<br />
| 0x14<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0x15<br />
| 0x3<br />
| Unused<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Required Download System Version<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== SystemUpdate Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Extended Data Size<br />
|}<br />
<br />
== Application Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Patch ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Patch Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
== AddOnContent Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required Application Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Delta Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Content Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Hash<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Content ID<br />
|-<br />
| 0x30<br />
| 0x6<br />
| Size<br />
|-<br />
| 0x36<br />
| 0x1<br />
| Title Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x37<br />
| 0x1<br />
| Id Offset<br />
|}<br />
<br />
== Content Meta Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|}<br />
<br />
This is used for SystemUpdate, see here: [[NCM_services#ReadEntryMetaRecords]].<br />
<br />
== SystemUpdate Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Variation Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Firmware Variation<br />
|- <br />
| 0xC<br />
| 0x1C * Variation Count<br />
| Unused<br />
|}<br />
<br />
== Patch Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| History Count<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Delta History Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Delta Count<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Fragment Set Count<br />
|-<br />
| 0x10<br />
| 0x4<br />
| History Content Count<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Delta Content Count<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Unused<br />
|-<br />
| 0x1C<br />
| 0x38 * History Count<br />
| [[CNMT#History_Header|History Headers]]<br />
|-<br />
| <br />
| 0x28 * Delta History Count<br />
| [[CNMT#Delta_History|Delta Histories]]<br />
|-<br />
| <br />
| 0x28 * Delta Count<br />
| [[CNMT#Delta_Header|Delta Headers]]<br />
|-<br />
| <br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Fragment_Set|Fragment Sets]]<br />
|-<br />
| <br />
| 0x18 * History Content Count<br />
| [[CNMT#Content_Records|History Content Records (Content Records without the Hash entry)]]<br />
|-<br />
| <br />
| 0x38 * Delta Content Count<br />
| [[CNMT#Content_Records|Delta Content Records]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (Fragment Set)<br />
| [[CNMT#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
=== History Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| [[CNMT#Content_Meta_Records|Content Meta Record]]<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|-<br />
| 0x10<br />
| 0x20<br />
| Digest<br />
|-<br />
| 0x30<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x32<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Delta History ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Download Size<br />
|-<br />
| 0x20<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
=== Delta Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Unused<br />
|-<br />
| 0x20<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x22<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Fragment Set ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Source Content ID<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Destination Content ID<br />
|-<br />
| 0x20<br />
| 0x6<br />
| Source Size<br />
|-<br />
| 0x26<br />
| 0x6<br />
| Destination Size<br />
|-<br />
| 0x2C<br />
| 0x2<br />
| Fragment Indicator Count<br />
|-<br />
| 0x2E<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0x2F<br />
| 0x1<br />
| Update Type (0=ApplyAsDelta, 1=Overwrite, 2=Create)<br />
|-<br />
| 0x30<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
=== Fragment Indicator ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x2<br />
| Content Info Index<br />
|-<br />
| 0x2<br />
| 0x2<br />
| Fragment Index<br />
|}<br />
<br />
== Delta Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Unused<br />
|-<br />
| 0x20<br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Fragment_Set|Fragment Sets]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (Fragment Set)<br />
| [[CNMT#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
== Digest ==<br />
<br />
Always found at the end of the file.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Digest<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=CNMT&diff=6942
CNMT
2019-05-22T14:09:03Z
<p>Liam: </p>
<hr />
<div>This is the metadata file that ends in <code>".cnmt{.nca}"</code> or <code>"meta0.ncd"</code>. This seems to replace the TMD format.<br />
<br />
There's at least 9 different filenames used for ".cnmt":<br />
* "Application_{lower-case hex titleID}.cnmt"<br />
* "Patch_{lower-case hex titleID}.cnmt"<br />
* "AddOnContent_{lower-case hex titleID}.cnmt"<br />
* "SystemUpdate_{hex titleID}.cnmt"<br />
* "SystemData_{lower-case hex titleID}.cnmt"<br />
* "SystemProgram_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackage_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackageSafe_{lower-case hex titleID}.cnmt"<br />
* "Delta_{lower-case hex titleID}.cnmt"<br />
<br />
== Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Unused<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Extended Header Size<br />
|-<br />
| 0x10<br />
| 0x2<br />
| Content Count<br />
|-<br />
| 0x12<br />
| 0x2<br />
| Content Meta Count<br />
|-<br />
| 0x14<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0x15<br />
| 0x3<br />
| Unused<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Required Download System Version<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== SystemUpdate Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Extended Data Size<br />
|}<br />
<br />
== Application Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Patch ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Patch Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
== AddOnContent Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required Application Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Delta Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Content Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Hash<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Content ID<br />
|-<br />
| 0x30<br />
| 0x6<br />
| Size<br />
|-<br />
| 0x36<br />
| 0x1<br />
| Title Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x37<br />
| 0x1<br />
| Id Offset<br />
|}<br />
<br />
== Content Meta Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|}<br />
<br />
This is used for SystemUpdate, see here: [[NCM_services#ReadEntryMetaRecords]].<br />
<br />
== SystemUpdate Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Variation Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Firmware Variation<br />
|- <br />
| 0xC<br />
| 0x1C * Variation Count<br />
| Unused<br />
|}<br />
<br />
== Patch Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| History Count<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Delta History Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Delta Count<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Fragment Set Count<br />
|-<br />
| 0x10<br />
| 0x4<br />
| History Content Count<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Delta Content Count<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Unused<br />
|-<br />
| 0x1C<br />
| 0x38 * History Count<br />
| [[CNMT#Patch_Extended_Data#History_Header|History Headers]]<br />
|-<br />
| <br />
| 0x28 * Delta History Count<br />
| [[CNMT#Patch_Extended_Data#Delta_History|Delta Histories]]<br />
|-<br />
| <br />
| 0x28 * Delta Count<br />
| [[CNMT#Patch_Extended_Data#Delta_Header|Delta Headers]]<br />
|-<br />
| <br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Patch_Extended_Data#Fragment_Set|Fragment Sets]]<br />
|-<br />
| <br />
| 0x18 * History Content Count<br />
| [[CNMT#Content_Records|History Content Records (Content Records without the Hash entry)]]<br />
|-<br />
| <br />
| 0x38 * Delta Content Count<br />
| [[CNMT#Content_Records|Delta Content Records]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (Fragment Set)<br />
| [[CNMT#Patch_Extended_Data#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
=== History Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| [[CNMT#Content_Meta_Records|Content Meta Record]]<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|-<br />
| 0x10<br />
| 0x20<br />
| Digest<br />
|-<br />
| 0x30<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x32<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Delta History ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Download Size<br />
|-<br />
| 0x20<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
=== Delta Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Unused<br />
|-<br />
| 0x20<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x22<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Fragment Set ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Source Content ID<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Destination Content ID<br />
|-<br />
| 0x20<br />
| 0x6<br />
| Source Size<br />
|-<br />
| 0x26<br />
| 0x6<br />
| Destination Size<br />
|-<br />
| 0x2C<br />
| 0x2<br />
| Fragment Indicator Count<br />
|-<br />
| 0x2E<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0x2F<br />
| 0x1<br />
| Update Type (0=ApplyAsDelta, 1=Overwrite, 2=Create)<br />
|-<br />
| 0x30<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
=== Fragment Indicator ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x2<br />
| Content Info Index<br />
|-<br />
| 0x2<br />
| 0x2<br />
| Fragment Index<br />
|}<br />
<br />
== Delta Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Unused<br />
|-<br />
| 0x20<br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Patch_Extended_Data#Fragment_Set|Fragment Sets]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (Fragment Set)<br />
| [[CNMT#Patch_Extended_Data#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
== Digest ==<br />
<br />
Always found at the end of the file.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Digest<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=CNMT&diff=6941
CNMT
2019-05-22T14:07:49Z
<p>Liam: </p>
<hr />
<div>This is the metadata file that ends in <code>".cnmt{.nca}"</code> or <code>"meta0.ncd"</code>. This seems to replace the TMD format.<br />
<br />
There's at least 9 different filenames used for ".cnmt":<br />
* "Application_{lower-case hex titleID}.cnmt"<br />
* "Patch_{lower-case hex titleID}.cnmt"<br />
* "AddOnContent_{lower-case hex titleID}.cnmt"<br />
* "SystemUpdate_{hex titleID}.cnmt"<br />
* "SystemData_{lower-case hex titleID}.cnmt"<br />
* "SystemProgram_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackage_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackageSafe_{lower-case hex titleID}.cnmt"<br />
* "Delta_{lower-case hex titleID}.cnmt"<br />
<br />
== Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Unused<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Extended Header Size<br />
|-<br />
| 0x10<br />
| 0x2<br />
| Content Count<br />
|-<br />
| 0x12<br />
| 0x2<br />
| Content Meta Count<br />
|-<br />
| 0x14<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0x15<br />
| 0x3<br />
| Unused<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Required Download System Version<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== SystemUpdate Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Extended Data Size<br />
|}<br />
<br />
== Application Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Patch ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Patch Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
== AddOnContent Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required Application Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Delta Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Content Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Hash<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Content ID<br />
|-<br />
| 0x30<br />
| 0x6<br />
| Size<br />
|-<br />
| 0x36<br />
| 0x1<br />
| Title Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x37<br />
| 0x1<br />
| Id Offset<br />
|}<br />
<br />
== Content Meta Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|}<br />
<br />
This is used for SystemUpdate, see here: [[NCM_services#ReadEntryMetaRecords]].<br />
<br />
== SystemUpdate Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Variation Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Firmware Variation<br />
|- <br />
| 0xC<br />
| 0x1C * Variation Count<br />
| Unused<br />
|}<br />
<br />
== Patch Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| History Count<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Delta History Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Delta Count<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Fragment Set Count<br />
|-<br />
| 0x10<br />
| 0x4<br />
| History Content Count<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Delta Content Count<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Unused<br />
|-<br />
| 0x1C<br />
| 0x38 * History Count<br />
| [[CNMT#Patch_Extended_Data#History_Header|History Headers]]<br />
|-<br />
| <br />
| 0x28 * Delta History Count<br />
| [[CNMT#Patch_Extended_Data#Delta_History|Delta Histories]]<br />
|-<br />
| <br />
| 0x28 * Delta Count<br />
| [[CNMT#Patch_Extended_Data#Delta_Header|Delta Headers]]<br />
|-<br />
| <br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Patch_Extended_Data#Fragment_Set|Fragment Sets]]<br />
|-<br />
| <br />
| 0x18 * History Content Count<br />
| [[CNMT#Content_Records|History Content Records (Content Records without the Hash entry)]]<br />
|-<br />
| <br />
| 0x38 * Delta Content Count<br />
| [[CNMT#Content_Records|Delta Content Records]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (Fragment Set)<br />
| [[CNMT#Patch_Extended_Data#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
=== History Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| [[CNMT#Content_Meta_Records|Content Meta Record]]<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|-<br />
| 0x10<br />
| 0x20<br />
| Digest<br />
|-<br />
| 0x30<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x32<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Delta History ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Download Size<br />
|-<br />
| 0x20<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
=== Delta Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Unused<br />
|-<br />
| 0x20<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x22<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Fragment Set ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Source Content ID<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Destination Content ID<br />
|-<br />
| 0x20<br />
| 0x6<br />
| Source Size<br />
|-<br />
| 0x26<br />
| 0x6<br />
| Destination Size<br />
|-<br />
| 0x2C<br />
| 0x2<br />
| Fragment Indicator Count<br />
|-<br />
| 0x2E<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0x2F<br />
| 0x1<br />
| Update Type (0=ApplyAsDelta, 1=Overwrite, 2=Create)<br />
|-<br />
| 0x30<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
=== Fragment Indicator ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x2<br />
| Content Info Index<br />
|-<br />
| 0x2<br />
| 0x2<br />
| Fragment Index<br />
|}<br />
<br />
== Delta Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Unused<br />
|-<br />
| 0x20<br />
| 0x34 * Fragment Set Count<br />
| [[CNMT#Patch_Extended_Data#Fragment_Set|Fragment Sets]]<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (Fragment Set)<br />
| [[CNMT#Patch_Extended_Data#Fragment_Indicator|Fragment Indicators]]<br />
|}<br />
<br />
== Digest ==<br />
<br />
Always found at the end of the file.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Digest<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=CNMT&diff=6940
CNMT
2019-05-22T13:59:20Z
<p>Liam: Fix some mistakes and add Delta Extended Data</p>
<hr />
<div>This is the metadata file that ends in <code>".cnmt{.nca}"</code> or <code>"meta0.ncd"</code>. This seems to replace the TMD format.<br />
<br />
There's at least 9 different filenames used for ".cnmt":<br />
* "Application_{lower-case hex titleID}.cnmt"<br />
* "Patch_{lower-case hex titleID}.cnmt"<br />
* "AddOnContent_{lower-case hex titleID}.cnmt"<br />
* "SystemUpdate_{hex titleID}.cnmt"<br />
* "SystemData_{lower-case hex titleID}.cnmt"<br />
* "SystemProgram_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackage_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackageSafe_{lower-case hex titleID}.cnmt"<br />
* "Delta_{lower-case hex titleID}.cnmt"<br />
<br />
== Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Unused<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Extended Header Size<br />
|-<br />
| 0x10<br />
| 0x2<br />
| Content Count<br />
|-<br />
| 0x12<br />
| 0x2<br />
| Content Meta Count<br />
|-<br />
| 0x14<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0x15<br />
| 0x3<br />
| Unused<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Required Download System Version<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== SystemUpdate Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Extended Data Size<br />
|}<br />
<br />
== Application Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Patch ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Patch Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
== AddOnContent Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required Application Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Delta Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Content Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Hash<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Content ID<br />
|-<br />
| 0x30<br />
| 0x6<br />
| Size<br />
|-<br />
| 0x36<br />
| 0x1<br />
| Title Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x37<br />
| 0x1<br />
| Id Offset<br />
|}<br />
<br />
== Content Meta Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|}<br />
<br />
This is used for SystemUpdate, see here: [[NCM_services#ReadEntryMetaRecords]].<br />
<br />
== SystemUpdate Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Variation Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Firmware Variation<br />
|- <br />
| 0xC<br />
| 0x1C * Variation Count<br />
| Unused<br />
|}<br />
<br />
== Patch Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| History Count<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Delta History Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Delta Count<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Fragment Set Count<br />
|-<br />
| 0x10<br />
| 0x4<br />
| History Content Count<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Delta Content Count<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Unused<br />
|-<br />
| 0x1C<br />
| 0x38 * History Count<br />
| History Headers<br />
|-<br />
| <br />
| 0x28 * Delta History Count<br />
| Delta Histories<br />
|-<br />
| <br />
| 0x28 * Delta Count<br />
| Delta Headers<br />
|-<br />
| <br />
| 0x34 * Fragment Set Count<br />
| Fragment Sets<br />
|-<br />
| <br />
| 0x18 * History Content Count<br />
| History Content Records (Content Records without the Hash entry)<br />
|-<br />
| <br />
| 0x38 * Delta Content Count<br />
| Delta Content Records<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (Fragment Set)<br />
| Fragment Indicators<br />
|}<br />
<br />
=== History Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|-<br />
| 0x10<br />
| 0x20<br />
| Digest<br />
|-<br />
| 0x30<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x32<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Delta History ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Download Size<br />
|-<br />
| 0x20<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
=== Delta Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Unused<br />
|-<br />
| 0x20<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x22<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Fragment Set ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Source Content ID<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Destination Content ID<br />
|-<br />
| 0x20<br />
| 0x6<br />
| Source Size<br />
|-<br />
| 0x26<br />
| 0x6<br />
| Destination Size<br />
|-<br />
| 0x2C<br />
| 0x2<br />
| Fragment Indicator Count<br />
|-<br />
| 0x2E<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0x2F<br />
| 0x1<br />
| Update Type (0=ApplyAsDelta, 1=Overwrite, 2=Create)<br />
|-<br />
| 0x30<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
=== Fragment Indicator ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x2<br />
| Content Info Index<br />
|-<br />
| 0x2<br />
| 0x2<br />
| Fragment Index<br />
|}<br />
<br />
== Delta Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Patch ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Patch ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Unused<br />
|-<br />
| 0x20<br />
| 0x34 * Fragment Set Count<br />
| Fragment Sets<br />
|-<br />
|<br />
| 0x4 * Fragment Indicator Count (Fragment Set)<br />
| Fragment Indicators<br />
|}<br />
<br />
== Digest ==<br />
<br />
Always found at the end of the file.<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Digest<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=CNMT&diff=6939
CNMT
2019-05-22T13:51:24Z
<p>Liam: Update all of Patch Extended Data and add SystemUpdate extended data</p>
<hr />
<div>This is the metadata file that ends in <code>".cnmt{.nca}"</code> or <code>"meta0.ncd"</code>. This seems to replace the TMD format.<br />
<br />
There's at least 9 different filenames used for ".cnmt":<br />
* "Application_{lower-case hex titleID}.cnmt"<br />
* "Patch_{lower-case hex titleID}.cnmt"<br />
* "AddOnContent_{lower-case hex titleID}.cnmt"<br />
* "SystemUpdate_{hex titleID}.cnmt"<br />
* "SystemData_{lower-case hex titleID}.cnmt"<br />
* "SystemProgram_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackage_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackageSafe_{lower-case hex titleID}.cnmt"<br />
* "Delta_{lower-case hex titleID}.cnmt"<br />
<br />
== Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Unused<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Extended Header Size<br />
|-<br />
| 0x10<br />
| 0x2<br />
| Content Count<br />
|-<br />
| 0x12<br />
| 0x2<br />
| Content Meta Count<br />
|-<br />
| 0x14<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0x15<br />
| 0x3<br />
| Unused<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Required Download System Version<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== SystemUpdate Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Extended Data Size<br />
|}<br />
<br />
== Application Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Patch ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|}<br />
<br />
== Patch Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
== AddOnContent Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required Application Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Delta Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Content Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Hash<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Content ID<br />
|-<br />
| 0x30<br />
| 0x6<br />
| Size<br />
|-<br />
| 0x36<br />
| 0x1<br />
| Title Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x37<br />
| 0x1<br />
| Id Offset<br />
|}<br />
<br />
== Content Meta Records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|}<br />
<br />
This is used for SystemUpdate, see here: [[NCM_services#ReadEntryMetaRecords]].<br />
<br />
== SystemUpdate Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Version<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Variation Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Firmware Variation<br />
|- <br />
| 0xC<br />
| 0x1C * Variation Count<br />
| Unused<br />
|}<br />
<br />
== Patch Extended Data ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| History Count<br />
|-<br />
| 0x4<br />
| 0x4<br />
| Delta History Count<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Delta Count<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Fragment Set Count<br />
|-<br />
| 0x10<br />
| 0x4<br />
| History Content Count<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Delta Content Count<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Unused<br />
|-<br />
| 0x1C<br />
| 0x38 * History Count<br />
| History Headers<br />
|-<br />
| <br />
| 0x28 * Delta History Count<br />
| Delta Histories<br />
|-<br />
| <br />
| 0x28 * Delta Count<br />
| Delta Headers<br />
|-<br />
| <br />
| 0x34 * Fragment Set Count<br />
| Fragment Sets<br />
|-<br />
| <br />
| 0x18 * History Content Count<br />
| History Content Records (Content Records without the Hash entry)<br />
|-<br />
| <br />
| 0x38 * Delta Content Count<br />
| Delta Content Records<br />
|}<br />
<br />
=== History Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Title Types]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|-<br />
| 0x10<br />
| 0x20<br />
| Digest<br />
|-<br />
| 0x30<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x32<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Delta History ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Title ID<br />
|-<br />
| 0x8<br />
| 0x8<br />
| Destination Title ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x8<br />
| Download Size<br />
|-<br />
| 0x20<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
=== Delta Header ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Source Title ID<br />
|-<br />
| 0x8<br />
| 8<br />
| Destination Title ID<br />
|-<br />
| 0x10<br />
| 0x4<br />
| Source Version<br />
|-<br />
| 0x14<br />
| 0x4<br />
| Destination Version<br />
|-<br />
| 0x18<br />
| 0x2<br />
| Fragment Set Count<br />
|-<br />
| 0x1A<br />
| 0x6<br />
| Unused<br />
|-<br />
| 0x20<br />
| 0x2<br />
| Content Info Count<br />
|-<br />
| 0x22<br />
| 0x6<br />
| Unused<br />
|}<br />
<br />
=== Fragment Set ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x10<br />
| Source Content ID<br />
|-<br />
| 0x10<br />
| 0x10<br />
| Destination Content ID<br />
|-<br />
| 0x20<br />
| 0x6<br />
| Source Size<br />
|-<br />
| 0x26<br />
| 0x6<br />
| Destination Size<br />
|-<br />
| 0x2C<br />
| 0x2<br />
| Fragment Indicator Count<br />
|-<br />
| 0x2E<br />
| 0x1<br />
| [[NCM_services#Title_Types|Title Types]]<br />
|-<br />
| 0x2F<br />
| 0x1<br />
| Update Type (0=ApplyAsDelta, 1=Overwrite, 2=Create)<br />
|-<br />
| 0x30<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
=== Fragment Indicator ===<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x2<br />
| Content Info Index<br />
|-<br />
| 0x2<br />
| 0x2<br />
| Fragment Index<br />
|}</div>
Liam
https://switchbrew.org/w/index.php?title=CNMT&diff=6938
CNMT
2019-05-22T13:30:56Z
<p>Liam: Update header and extended header - next is extended data</p>
<hr />
<div>This is the metadata file that ends in <code>".cnmt{.nca}"</code> or <code>"meta0.ncd"</code>. This seems to replace the TMD format.<br />
<br />
There's at least 9 different filenames used for ".cnmt":<br />
* "Application_{lower-case hex titleID}.cnmt"<br />
* "Patch_{lower-case hex titleID}.cnmt"<br />
* "AddOnContent_{lower-case hex titleID}.cnmt"<br />
* "SystemUpdate_{hex titleID}.cnmt"<br />
* "SystemData_{lower-case hex titleID}.cnmt"<br />
* "SystemProgram_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackage_{lower-case hex titleID}.cnmt"<br />
* "BootImagePackageSafe_{lower-case hex titleID}.cnmt"<br />
* "Delta_{lower-case hex titleID}.cnmt"<br />
<br />
== Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| [[Title_list|Version]]<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Unused<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Extended Header Size<br />
|-<br />
| 0x10<br />
| 0x2<br />
| Content Count<br />
|-<br />
| 0x12<br />
| 0x2<br />
| Content Meta Count<br />
|-<br />
| 0x14<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0x15<br />
| 0x3<br />
| Unused<br />
|-<br />
| 0x18<br />
| 0x4<br />
| Required Download System Version<br />
|-<br />
| 0x1C<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== SystemUpdate Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x4<br />
| Extended Header Size<br />
|}<br />
<br />
== Application Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Patch ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|}<br />
<br />
== Patch Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required System Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0x10<br />
| 0x8<br />
| Unused<br />
|}<br />
<br />
== AddOnContent Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Required Application Version<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Delta Extended Header ==<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Application ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Extended Data Size<br />
|-<br />
| 0xC<br />
| 0x4<br />
| Unused<br />
|}<br />
<br />
== Content records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x20<br />
| Hash<br />
|-<br />
| 0x20<br />
| 0x10<br />
| Content ID<br />
|-<br />
| 0x30<br />
| 0x6<br />
| Size<br />
|-<br />
| 0x36<br />
| 0x1<br />
| Title Type (0=Meta, 1=Program, 2=Data, 3=Control, 4=[[Internet_Browser|HtmlDocument]], 5=[[Internet_Browser|LegalInformation]], 6=[[NCA_Format|DeltaFragment]])<br />
|-<br />
| 0x37<br />
| 0x1<br />
| Id Offset<br />
|}<br />
<br />
== Meta records ==<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 0x8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 0x4<br />
| Version<br />
|-<br />
| 0xC<br />
| 0x1<br />
| [[NCM_services#Title_Types|Meta Type]]<br />
|-<br />
| 0xD<br />
| 0x1<br />
| Attributes (0=None, 1=IncludesExFatDriver, 2=Rebootless)<br />
|-<br />
| 0xE<br />
| 0x2<br />
| Unused<br />
|}<br />
<br />
This is used for SystemUpdate, see here: [[NCM_services#ReadEntryMetaRecords]].<br />
<br />
== Extended data ==<br />
<br />
Patch-type cnmt files include an extended data section. <br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 4<br />
| Number of previous cnmt entries.<br />
|-<br />
| 0x4<br />
| 4<br />
| Number of previous delta entries.<br />
|-<br />
| 0x8<br />
| 4<br />
| Number of delta info entries.<br />
|-<br />
| 0xC<br />
| 4<br />
| Number of delta application info entries.<br />
|-<br />
| 0x10<br />
| 4<br />
| Number of previous content entries.<br />
|-<br />
| 0x14<br />
| 4<br />
| Number of delta content entries.<br />
|-<br />
| 0x18<br />
| 4<br />
| Unused?<br />
|-<br />
| 0x1C<br />
| 0x38*X<br />
| Previous cnmt entries<br />
|-<br />
| <br />
| 0x28*X<br />
| Previous delta entries<br />
|-<br />
| <br />
| 0x28*X<br />
| Delta info entries<br />
|-<br />
| <br />
| 0x34*X<br />
| Delta application info entries<br />
|-<br />
| <br />
| 0x18*X<br />
| Previous content entries<br />
|-<br />
| <br />
| 0x38*X<br />
| Delta content entries. (Standard content records)<br />
|-<br />
| <br />
| 4<br />
| Unknown<br />
|-<br />
| <br />
| 4<br />
| Unknown<br />
|-<br />
| <br />
| 4<br />
| Unknown<br />
|-<br />
|}<br />
<br />
== Previous cnmt records ==<br />
<br />
Each entry is 0x38 bytes:<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 8<br />
| Title ID<br />
|-<br />
| 0x8<br />
| 4<br />
| Title version<br />
|-<br />
| 0xC<br />
| 1<br />
| Type (see [[NCM_services#Title_Types|Title Types]])<br />
|-<br />
| 0xD<br />
| 3<br />
| Unused?<br />
|-<br />
| 0x10<br />
| 32<br />
| Hash<br />
|-<br />
| 0x30<br />
| 2<br />
| Unknown<br />
|-<br />
| 0x32<br />
| 2<br />
| Unused?<br />
|-<br />
| 0x34<br />
| 4<br />
| Unused?<br />
|-<br />
|}<br />
<br />
This contains information on previous metadata files.<br />
<br />
== Previous delta records ==<br />
<br />
Each entry is 0x28 bytes:<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 8<br />
| Old title ID<br />
|-<br />
| 0x8<br />
| 8<br />
| New title ID<br />
|-<br />
| 0x10<br />
| 4<br />
| Old title version<br />
|-<br />
| 0x14<br />
| 4<br />
| New title version<br />
|-<br />
| 0x18<br />
| 8<br />
| Size<br />
|-<br />
| 0x20<br />
| 8<br />
| Unused?<br />
|-<br />
|}<br />
<br />
This contains information on previous delta patches.<br />
<br />
== Delta info records ==<br />
<br />
Each entry is 0x28 bytes:<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 8<br />
| Old title ID<br />
|-<br />
| 0x8<br />
| 8<br />
| New title ID<br />
|-<br />
| 0x10<br />
| 4<br />
| Old title version<br />
|-<br />
| 0x14<br />
| 4<br />
| New title version<br />
|-<br />
| 0x18<br />
| 8<br />
| Some sort of index?<br />
|-<br />
| 0x20<br />
| 8<br />
| Some sort of index?<br />
|-<br />
|}<br />
<br />
This contains information on the current delta patch.<br />
<br />
== Delta application info records ==<br />
<br />
Each entry is 0x34 bytes:<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 16<br />
| Old NcaId<br />
|-<br />
| 0x10<br />
| 16<br />
| New NcaId<br />
|-<br />
| 0x20<br />
| 6<br />
| Old size<br />
|-<br />
| 0x26<br />
| 2<br />
| Upper 2 bytes of the new size<br />
|-<br />
| 0x28<br />
| 4<br />
| Lower 4 bytes of the new size<br />
|-<br />
| 0x2C<br />
| 2<br />
| Unknown<br />
|-<br />
| 0x2E<br />
| 1<br />
| Type (see [[NCM_services#Title_Types|Title Types]])<br />
|-<br />
| 0x2F<br />
| 1<br />
| ? bit0 set = don't install?<br />
|-<br />
| 0x30<br />
| 4<br />
| Unused?<br />
|-<br />
|}<br />
<br />
This contains information on how to apply deltas to the previous patch.<br />
<br />
== Previous content records ==<br />
<br />
Each entry is 0x18 bytes:<br />
<br />
{| class="wikitable" border="1"<br />
|-<br />
! Offset<br />
! Size<br />
! Description<br />
|-<br />
| 0x0<br />
| 16<br />
| NcaId<br />
|-<br />
| 0x10<br />
| 6<br />
| Size<br />
|-<br />
| 0x16<br />
| 1<br />
| Type (see [[NCM_services#Title_Types|Title Types]])<br />
|-<br />
| 0x17<br />
| 1<br />
| <br />
|-<br />
|}<br />
<br />
This contains information on previous title content from earlier patches.</div>
Liam