Filesystem services
fsp-ldr
| Cmd | Name | Arguments | Notes |
|---|---|---|---|
| 0 | MountCode | u64 TID + X descriptor #ContentPath | Returns an #IFileSystem. |
| 1 | IsCodeMounted | u64 PID | Returns a bool (1 if code is mounted). |
fsp-pr
| Cmd | Name | Notes |
|---|---|---|
| 0 | #SetFsPermissions | |
| 1 | #ClearFsPermissions | |
| 256 | #SetEnabledProgramVerification |
SetFsPermissions
Takes a storageID, a pid, a titleID and two type-A buffers. One contains ACI0 contents, other one contains ACID contents.
Final FS permissions are stored as (ACI0_perms & ACID_perms). Will panic(svcBreak) when buffer sizes from ipc-rawdata are invalid.
ClearFsPermissions
Takes a pid. Removes registered FS permissions for that PID.
SetEnabledProgramVerification
Seems to sets a global flag to inputval & 1.
When the flag is zero, it will set ret=0 instead of ret={error} when verifying a RSA signature fails. This RSA signature seems to be the signature in the NPDM ACID. It then skips verifying what seems to be the second signature in the NCA header. Note that if verifying the NPDM(?) signature is successful, and verifying that second signature fails, it will throw an error and abort.
fsp-srv
| Cmd | Name |
|---|---|
| 0 | [1.0.0] #MountContent |
| 1 | #Initialize |
| 2 | OpenDataFileSystemByCurrentProcess |
| 7 | [2.0.0+] #MountContent7 |
| 8 | [2.0.0+] #MountContent |
| 9 | [3.0.0+] OpenDataFileSystemByApplicationId |
| 11 | #MountBis |
| 12 | #OpenBisPartition |
| 13 | InvalidateBisCache |
| 17 | OpenHostFileSystemImpl |
| 18 | MountSdCard |
| 19 | [2.0.0+] FormatSdCard |
| 21 | #DeleteSaveData |
| 22 | #CreateSaveData |
| 23 | #CreateSystemSaveData |
| 24 | RegisterSaveDataAtomicDeletion |
| 25 | [2.0.0+] DeleteSaveDataWithSpaceId |
| 26 | [2.0.0+] FormatSdCardDryRun |
| 27 | [2.0.0+] IsExFatSupported |
| 30 | #OpenGameCardPartition |
| 31 | #MountGameCardPartition |
| 32 | [3.0.0+] ExtendSaveData |
| 51 | #MountSaveData |
| 52 | #MountSystemSaveData |
| 53 | [2.0.0+] MountSaveDataReadOnly |
| 57 | [3.0.0+] ReadSaveDataFileSystemExtraDataWithSpaceId |
| 58 | ReadSaveDataFileSystemExtraData |
| 59 | [2.0.0+] WriteSaveDataFileSystemExtraData |
| 60 | OpenSaveDataInfoReader |
| 61 | OpenSaveDataIterator |
| 80 | OpenSaveDataThumbnailFile |
| 100 | MountImageDirectory |
| 110 | #MountContentStorage |
| 200 | OpenDataStorageByCurrentProcess |
| 201 | [3.0.0+] OpenDataStorageByApplicationId |
| 202 | #OpenDataStorageByDataId |
| 203 | Returns an #IStorage |
| 400 | #OpenDeviceOperator |
| 500 | #OpenSdCardDetectionEventNotifier |
| 501 | #OpenGameCardDetectionEventNotifier |
| 600 | SetCurrentPosixTime |
| 601 | QuerySaveDataTotalSize |
| 602 | #VerifySaveData |
| 603 | CorruptSaveDataForDebug |
| 604 | CreatePaddingFile |
| 605 | DeleteAllPaddingFiles |
| 606 | [2.0.0+] GetRightsId |
| 607 | [2.0.0+] RegisterExternalKey |
| 608 | [2.0.0+] UnregisterExternalKey |
| 609 | [2.0.0+] GetRightsIdByPath |
| 610 | [3.0.0+] GetRightsIdByPath2 (returns extra byte) |
| 620 | [2.0.0+] #SetSdCardEncryptionSeed |
| 800 | [2.0.0+] GetAndClearFileSystemProxyErrorInfo |
| 1000 | SetBisRootForHost |
| 1001 | SetSaveDataSize |
| 1002 | SetSaveDataRootPath |
| 1003 | DisableAutoSaveDataCreation |
| 1004 | #SetGlobalAccessLogMode |
| 1005 | #GetGlobalAccessLogMode |
| 1006 | #OutputAccessLogToSdCard |
Permissions
Every time permissions are checked, the process registration #fsp-pr is loaded using the session processID. The permission data is populated with data from the NPDM,
If the processID is <= 6 (which happens only for built-in sysmodules), it will use a hardcoded registration data.
Note that the functions check whether or not at least one bit is set in the mask. This means that, you don't need to set 0xFFFFFFFFFFFFFFFF to get all permissions: it suffices to set 0x8000000000000000.
If the code were to request an invalid input type, panic. But this never happens.
RwPermissions
| Type(s) | Mask | Name | Value | Used by |
|---|---|---|---|---|
| 0x0 | 0x8000000000000801 | MountContentType2 | 1 | #MountContent |
| 0x1 | 0x8000000000000801 | MountContentType5 | 1 | #MountContent |
| 0x2 | 0x8000000000000801 | MountContentType3 | 1 | #MountContent |
| 0x3 | 0x8000000000000801 | MountContentType4 | 1 | #MountContent |
| 0x4 | 0x8000000000000801 | MountContentType6 | 1 | #MountContent |
| 0x5 | 0x8000000000000801 | MountContentType7 | 1 | #MountContent |
| 0x6 | 0x8000000000000000 | 3 | ||
| 0x7 | 0x8000000000000800 | ContentStorageAccess | 3 | #MountContentStorage |
| 0x8 | 0x8000000000001000 | ImageDirectoryAccess | 3 | #MountImageDirectory |
| 0x9 | 0x8000000000000084 | MountBisType28 | 3 | #MountBis |
| 0xA | 0x8000000000000080 | MountBisType29 | 3 | #MountBis |
| 0xB | 0x8000000000008080 | MountBisType30 | 3 | #MountBis |
| 0xC | 0x8000000000008080 | MountBisType31 | 3 | #MountBis |
| 0xD | 0x8000000000000080 | 3 | ||
| 0xE | 0xC000000000200000 | SdCardAccess | 3 | #MountSdCard |
| 0xF | 0x8000000000000010 | GameCardUser | 3 | #MountGameCardPartition |
| 0x10 | 0x8000000000040020 | SaveDataAccess0 | 3 | #MountSaveData |
| 0x11 | 0x8000000000000028 | SystemSaveDataAccess0 | 3 | #MountSystemSaveData |
| 0x12 | 0x8000000000000020 | SaveDataAccess1 | 3 | #MountSaveData |
| 0x13 | 0x8000000000000020 | SystemSaveDataAccess1 | 3 | #MountSystemSaveData |
| 0x14 | 0x8000000000010082 | BisPartition0 | 3 | #OpenBisPartition |
| 0x15 | 0x8000000000010080 | BisPartition10 | 3 | #OpenBisPartition |
| 0x17 | 0x8000000000010080 | BisPartition20 | 3 | #OpenBisPartition |
| 0x18 | 0x8000000000010080 | BisPartition21 | 3 | #OpenBisPartition |
| 0x19 | 0x8000000000010080 | BisPartition22 | 3 | #OpenBisPartition |
| 0x1A | 0x8000000000010080 | BisPartition23 | 3 | #OpenBisPartition |
| 0x1B | 0x8000000000010080 | BisPartition24 | 3 | #OpenBisPartition |
| 0x1C | 0x8000000000010080 | BisPartition25 | 3 | #OpenBisPartition |
| 0x16 | 0x8000000000000080 | BisPartition26 | 3 | #OpenBisPartition |
| 0x1D | 0x8000000000000084 | BisPartition27 | 3 | #OpenBisPartition |
| 0x1E | 0x8000000000000084 | BisPartition28 | 3 | #OpenBisPartition |
| 0x1F | 0x8000000000000080 | BisPartition29 | 3 | #OpenBisPartition |
| 0x20 | 0x8000000000000080 | BisPartition30 | 3 | #OpenBisPartition |
| 0x21 | 0x8000000000000080 | BisPartition31 | 3 | #OpenBisPartition |
| 0x22 | 0x8000000000000080 | BisPartition32 | 3 | #OpenBisPartition |
| 0x23 | 0xC000000000200000 | 3 | ||
| 0x24 | 0x8000000000000100 | GameCard_System | 3 | #OpenGameCardPartition, #EraseGameCard (bit1), #WriteToGameCard (bit1) |
| 0x25 | 0x8000000000100008 | MountContent_System | 1 | #MountContent, #OpenDataStorageByDataId |
| 0x26 | 0xC000000000400000 | HostAccess | 3 | #OpenHostFileSystemImpl |
BoolPermissions
| Type(s) | Mask | Name | Used by |
|---|---|---|---|
| 0x0 | 0x8000000000000080 | BisCache | #InvalidateBisCache |
| 0x1 | 0x8000000000000080 | EraseMmc | #EraseMmc |
| 0x2 | 0x8000000000000010 | GameCardCertificate | #GetGameCardDeviceCertificate |
| 0x3 | 0x8000000000000010 | GameCardIdSet | #GetGameCardIdSet |
| 0x4 | 0x8000000000000200 | GameCardDriver | #FinalizeGameCardDriver |
| 0x5 | 0x8000000000000200 | GameCardAsic | #GetGameCardAsicInfo |
| 0x6 | 0x8000000000002020 | SaveDataCreate | #CreateSaveData |
| 0x7 | 0x8000000000000060 | SaveDataDelete0 | #DeleteSaveData, #RegisterSaveDataAtomicDeletion |
| 0x8 | 0x8000000000000028 | SystemSaveDataCreate0 | #CreateSystemSaveData |
| 0x9 | 0x8000000000000020 | SystemSaveDataCreate1 | #CreateSystemSaveData |
| 0xA | 0x8000000000004028 | SaveDataDelete1 | #DeleteSaveData, #RegisterSaveDataAtomicDeletion |
| 0xB | 0x8000000000000060 | SaveDataIterators0 | #OpenSaveDataIterator, #OpenSaveDataInfoIterator |
| 0xC | 0x8000000000004020 | SaveDataIterators1 | #OpenSaveDataIterator, #OpenSaveDataInfoIterator |
| 0xD | 0x8000000000020000 | SaveThumbnails | #OpenSaveDataThumbnailFile |
| 0xE | 0x8000000000000400 | PosixTime | #SetCurrentPosixTime |
| 0xF | 0x8000000000004060 | SaveDataExtraData | #ReadSaveDataFileSystemExtraData |
| 0x10 | 0x8000000000080000 | GlobalMode | #SetGlobalAccessMode |
| 0x11 | 0x8000000000080000 | SpeedEmulation | #SetSpeedEmulationMode |
| 0x12 | Invalid | ||
| 0x13 | 0xC000000000800000 | PaddingFiles | #CreatePaddingFile, #DeletePaddingFiles |
| 0x14 | 0xC000000001000000 | SaveData_Debug | #CorruptSaveDataForDebug |
| 0x15 | 0xC000000002000000 | SaveData_SystemManagement | #CreateSaveData, #MountSaveData, #SetSaveDataRootPath |
| [2.0.0+] 0x16 | 0x8000000004000000 | ||
| [2.0.0+] 0x17 | 0x8000000008000000 | ||
| [2.0.0+] 0x18 | 0x8000000010000000 | ||
| [2.0.0+] 0x19 | 0x8000000000000800 | ||
| [2.0.0+] 0x1A | 0x8000000000004020 |
Initialize
Takes a pid-decscriptor.
MountContent7
Takes an input u32 (NCA-type) and an u64 title-id. Web-applet loads the u32 from u32_table[inparam]. Only type4 is usable with this?
Returns an #IFileSystem.
Note: web-applet strings refer to both this cmd and the below "MountContent" as "MountContent".
MountContent
Takes a type-0x19 input buffer, an in32, and an input title-id.
The in32 must be 5 if the NCA type is 0 (control).
The in32 must be 2..7.
The input buffer is the output string path from nsam GetContentNcaPath.
Returns an #IFileSystem.
May return errors when attempting to access NCA-paths for an update-title with a gamecard, when the gamecard isn't inserted. May return error 0x7D402 in some cases with update-titles. Non-val2 in32 values with NCA-type1 are unusable, even for normal titles.
The official "MountApplicationPackage" func uses this with in64=0 and in32=7.
After the in32-specific permissions are checked, it then gets the func retval for permissions-type 0x25 and func0.
When in32=5, it uses in64=0xffffffffffffffff internally, otherwise it checks if in64 is set to 0xffffffffffffffff then throws an error if so.
MountBis
Takes a type-0x19 input buffer string and a u32 Bis partitionID(see below). Official user-process code sets instr[0] = 0 normally.
Returns an #IFileSystem.
Only partitionIDs for FAT partitions are usable with this, otherwise error 0x2EE202 is returned. Seems to be about the same as #OpenBisPartition except this mounts the partition filesystem instead of allowing direct access to the partition sectors.
OpenBisPartition
Takes a u32 partition ID, returns 0x2EE202 for partitions which do not exist, 0x320002 for partitions which cannot be opened and a valid #IStorage handle otherwise.
InvalidateBisCache
Seems to invalidate the Bis cache for MBR/GPT after overwriting that data via the OpenBisPartition IStorage. Used by SystemInitializer.
DeleteSaveData
Takes an input u64.
CreateSaveData
Takes a 0x40-byte Save-struct entry, a 0x40-byte SaveCreate-struct entry, and a 0x10-byte input struct.
Only the first 0x5-bytes in the 0x10-byte struct are initialized: all-zero when automatically creating savedata during savecommon mount by official user-processes. In the dedicated save-creation code in official user-processes: +0 u32 = 0x40060, +4 u8 = 1.
Creates regular savedata.
CreateSystemSaveData
Takes a 0x40-byte Save-struct entry and a 0x40-byte SaveCreate-struct entry.
Creates savedata in the SYSTEM NAND partition.
OpenGameCardPartition
Takes an input u32 (partition ID), and returns an #IStorage for the partition.
MountGameCardPartition
Takes two input u32s, with the second u32 located at +4 in rawdata after the first u32.
Returns an #IFileSystem.
Mounts a gamecard partition.
MountSaveData
Takes an input u8 and a 0x40-byte Save-struct entry. Official user-process code is only known to use value 1 for the u8.
Returns an #IFileSystem.
Permissions aren't checked until the specified save is successfully found.
Only one process can mount a given savedata at any given time (this includes systemsavedata).
MountSystemSaveData
Takes an input u8 and a 0x40-byte Save-struct entry. Web-applet only uses value0 for the input u8.
Returns an #IFileSystem.
Mounts savedata in the SYSTEM NAND partition.
MountContentStorage
Takes a #ContentStorageId. Invalid values return 0x2EE202.
Returns an #IFileSystem with NCA files. The read data from these files is identical to the data read by Content_Manager_services#ReadEntryRaw.
OpenDataStorageByDataId
Takes a #StorageId and a TitleID.
Returns a domain object ID implementing the #IStorage interface for data archives.
OpenDeviceOperator
This command returns a session to a port implementing the #IDeviceOperator interface.
OpenSdCardDetectionEventNotifier
This command returns a session to a port implementing the #IEventNotifier interface.
OpenGameCardDetectionEventNotifier
This command returns a session to a port implementing the #IEventNotifier interface.
VerifySaveData
Takes an unknown input u64 and a type-0x6 output buffer.
The input u64 high-byte must be non-zero, otherwise an error is returned(0xE02).
SetSdCardEncryptionSeed
Takes 0x10-bytes of input.
Appears to be used to load the seed into FS-module state, since FS-module itself doesn't seem to have file-reading code to handle this itself.
NS-module uses this with data read from a file.
SetGlobalAccessLogMode
Takes an input u32.
GetGlobalAccessLogMode
Returns an output u32.
GlobalAccessLogMode is normally 0.
OutputAccessLogToSdCard
Takes a type-0x5 input buffer.
The input buffer is the string to output to the log. User-processes normally include a newline at the end.
User-processes only use this when the value previously loaded from #GetGlobalAccessLogMode has bit1 set.
When bit1 in GlobalAccessLogMode is clear, FS-module will just return 0 for OutputAccessLogToSdCard. However even with that set the log doesn't show up SD, unknown why.
The input buffer is written to the "$FsAccessLog:/FsAccessLog.txt" file, where "$FsAccessLog" is the SD-card mount-name. It's written to the current end of the file(appended).
IStorage
This is the interface for a raw device, usually a block device.
| Cmd | Name | Arguments |
|---|---|---|
| 0 | Read | Takes a type-0x46 buffer, an offset and length |
| 1 | Write | Takes a type-0x45 buffer, an offset and length |
| 2 | Flush | None |
| 3 | SetSize | Takes a size |
| 4 | GetSize | None |
IFileSystem
There are two main implementations of this interface:
- RomFS: Filesystem implementation statically linked in the binary. Uses an #IStorage interface as underlying raw device.
- IPC proxy: Used for all non-RomFS filesystems. In this case, actual filesystem implementation is in the FS process.
| Cmd | Name |
|---|---|
| 0 | CreateFile |
| 1 | DeleteFile |
| 2 | CreateDirectory |
| 3 | DeleteDirectory |
| 4 | DeleteDirectoryRecursively |
| 5 | RenameFile |
| 6 | RenameDirectory |
| 7 | GetEntryType |
| 8 | OpenFile |
| 9 | OpenDirectory |
| 10 | Commit |
| 11 | GetFreeSpaceSize |
| 12 | GetTotalSpaceSize |
| 13 | CleanDirectoryRecursively [3.0.0+] |
| 14 | GetFileTimeStampRaw [3.0.0+] |
Commit
Like 3DS, this has to be used after writing to savedata for the changes to take affect.
IDirectory
| Cmd | Name |
|---|---|
| 0 | Read |
| 1 | GetEntryCount |
IFile
| Cmd | Name |
|---|---|
| 0 | Read |
| 1 | Write |
| 2 | Flush |
| 3 | SetSize |
| 4 | GetSize |
ISaveDataInfoReader
IDeviceOperator
| Cmd | Name |
|---|---|
| 0 | IsSdCardInserted |
| 1 | GetSdCardSpeedMode |
| 2 | [2.0.0+] GetSdCardCid |
| 3 | [2.0.0+] GetSdCardUserAreaSize |
| 4 | [2.0.0+] GetSdCardProtectedAreaSize |
| 5 | [2.0.0+] GetAndClearSdCardErrorInfo |
| 6 | [2.0.0+] |
| 100 | GetMmcCid |
| 101 | GetMmcSpeedMode |
| 110 | EraseMmc |
| 111 | GetMmcPartitionSize |
| 112 | [2.0.0+] GetMmcPatrolCount |
| 113 | [2.0.0+] GetAndClearMmcErrorInfo |
| 114 | [2.0.0+] GetMmcExtendedCsd |
| 200 | IsGameCardInserted |
| 201 | EraseGameCard |
| 202 | GetGameCardHandle |
| 203 | #GetGameCardUpdatePartitionInfo |
| 204 | FinalizeGameCardDriver |
| 205 | GetGameCardAttribute |
| 206 | GetGameCardDeviceCertificate |
| 207 | GetGameCardAsicInfo |
| 208 | GetGameCardIdSet |
| 209 | WriteToGameCard |
| 210 | SetVerifyWriteEnalbleFlag |
| 211 | GetGameCardImageHash |
| 212 | [2.0.0+] GetGameCardErrorInfo |
| 213 | [2.0.0+] |
| 214 | [2.0.0+] GetGameCardCid |
| 215 | [2.0.0+] |
| 216 | [2.0.0+] |
| 217 | [2.1.0+] Returns 0x40-bytes of output data. |
| 300 | SetSpeedEmulationMode |
| 301 | GetSpeedEmulationMode |
GetGameCardUpdatePartitionInfo
Returns a titleID and the title-version for it.
- Output u32 with ARMS-gamecard: title-version v131162. This is the title-version for 2.1.0, which is the sysupdate included with this gamecard. Launch-day gamecards return title-version v450.
- Output u64 with ARMS-gamecard: titleID 0100000000000816.
NS appears to only use this with Content_Manager_services#GetTitleIdInfo and Content_Manager_services#GetUpdateTitleList with storageid=nandsys, for checking whether a sysupdate is required.
IEventNotifier
| Cmd | Name |
|---|---|
| 0 | BindEvent |
StorageId
| Value | Name |
|---|---|
| 0 | None |
| 1 | Host |
| 2 | GameCard |
| 3 | NandSystem |
| 4 | NandUser |
| 5 | SdCard |
ContentStorageId
| Value | Name |
|---|---|
| 0 | NandSystem |
| 1 | NandUser |
| 2 | SdCard |
ContentPath
These are the 0x300 paths to NCA files for the various filesystems FS can access, beginning with @. They're passed via X descriptors, and returned via various ncm/lr commands.
| Path | Notes |
|---|---|
| @SystemContent | |
| @UserContent | |
| @SdCardContent | |
| @CalibFile | |
| @Safe | |
| @User | |
| @System | |
| @Sdcard | |
| @Host | |
| @GcApp | Gamecard App partition (Partition 2) |
| @GcS00000001 | Gamecard Contents. |
| @upp | Gamecard update partition (Partition 0) |
BisPartitionID
Save Struct
| Offset | Size | Description |
|---|---|---|
| 0x0 | 0x8 | 0 for SystemSaveData. SaveData: 0 can be used for accessing the savedata associated with the current FS session titleID, otherwise when set this is the titleID associated with the savedata to access. |
| 0x8 | 0x10 | userID for user-specific savedata(saveuser) when set, otherwise when zero this indicates the common savedata(savecommon). This is loaded from Account_services. |
| 0x18 | 0x8 | u64 saveID. 0 for SaveData. |
| 0x20 | 0x8 | ContentStorageId? 0 for SystemSaveData. 1 for SaveData. 2 for DeviceSaveData(with official user-processes all other fields are 0 for DeviceSaveData). |
| 0x28 | 0x8 | 0 for SystemSaveData/SaveData. |
| 0x30 | 0x8 | 0 for SystemSaveData/SaveData. |
| 0x38 | 0x8 | 0 for SystemSaveData/SaveData. |
Total size is 0x40-bytes.
SaveCreate Struct
| Offset | Size | Description |
|---|---|---|
| 0x0 | 0x8 | IVFC level4 size? |
| 0x8 | 0x8 | Same as offset 0x0 normally? Hard-coded to 0x80000 for BcatSaveData. |
| 0x10 | 0x8 | 0x4000 for SystemSaveData/SaveData/DeviceSaveData/BcatSaveData. IVFC level4 block-size in bytes? |
| 0x18 | 0x8 | 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 titleID of the bcat-sysmodule. |
| 0x20 | 0x4 | Written using an input param for official user-processes. Hard-coded 0 for BcatSaveData. |
| 0x24 | 0x1 | Official user-processes only uses 0 here for SystemSaveData, 1 for SaveData/DeviceSaveData/BcatSaveData. |
| 0x25 | 0x1 | 0 for SystemSaveData/SaveData. |
| 0x26 | 0x1A | Not initialized for SystemSaveData/SaveData. |
Total size is 0x40-bytes.
DeviceSaveData
This is accessed using the same commands for SaveData with the same input u8, the only difference compared to SaveData is the Save-struct.
BcatSaveData
This is accessed using the same commands for SaveData with the same input u8. The Save-struct is the same as DeviceSaveData, except that the titleID field is set to <input titleID>. See above regarding SaveCreate-struct.
The 0x10-byte struct passed to #CreateSaveData has the first 0x5-bytes set to all-zero.