Difference between revisions of "Filesystem services"

From 3dbrew
Jump to navigation Jump to search
m (Add anchors)
 
(73 intermediate revisions by 17 users not shown)
Line 1: Line 1:
−
[[Category:Services]]
+
= Services =
−
 
+
{{Anchor|FS}}{{Anchor|FSUSER}}{{Anchor|fs:USER}}
−
= Filesystem service "fs:USER" =
+
== Filesystem service "fs:USER" ==
 
You can at most have 32 FS archive handles.
 
You can at most have 32 FS archive handles.
  
Line 446: Line 446:
 
| 0x101005
 
| 0x101005
 
|-
 
|-
−
| 0x08560200
+
| 0x08560240
 
| [[3.0.0-5]]
 
| [[3.0.0-5]]
 
| [[FS:CreateSystemSaveData|CreateSystemSaveData]]
 
| [[FS:CreateSystemSaveData|CreateSystemSaveData]]
Line 553: Line 553:
 
| 0x086B00C2
 
| 0x086B00C2
 
|?
 
|?
−
|?
+
|SetOtherSaveDataSecureValue
 
| 00121004
 
| 00121004
 
|-
 
|-
 
| 0x086C00C2
 
| 0x086C00C2
 
|?
 
|?
−
|?
+
|GetOtherSaveDataSecureValue
 
| 00121004
 
| 00121004
 
|-
 
|-
Line 567: Line 567:
 
|-
 
|-
 
| 0x086E00C0
 
| 0x086E00C0
−
|?
+
|Related to Secure Value? Used in Pokemon Sun/Moon.
−
|?
+
|SetThisSaveDataSecureValue
 
|None?
 
|None?
 
|-
 
|-
 
| 0x086F0040
 
| 0x086F0040
−
|?
+
|Related to Secure Value? Used in Pokemon Sun/Moon.
−
|?
+
|GetThisSaveDataSecureValue
 
| 0xE
 
| 0xE
 
|-
 
|-
Line 626: Line 626:
 
| 0x00101015
 
| 0x00101015
 
|-
 
|-
−
| 0x087A....
+
| 0x087A0180
 
| [[9.6.0-24|9.6.0-X]]
 
| [[9.6.0-24|9.6.0-X]]
−
| ?
+
| [[FS:AddSeed|AddSeed]]
 
| 0x00200000
 
| 0x00200000
 
|-
 
|-
Line 643: Line 643:
 
| 0x087D0000
 
| 0x087D0000
 
| [[9.6.0-24|9.6.0-X]]
 
| [[9.6.0-24|9.6.0-X]]
−
| Writes an u32 from state to cmdreply[2]. Probably the total number of titles in the SEEDDB?
+
| GetNumSeeds. Writes the number of seeds to cmdreply[2]
 
| 0x00200000
 
| 0x00200000
 
|-
 
|-
Line 685: Line 685:
 
| ?
 
| ?
 
| 0x00200000
 
| 0x00200000
 +
|-
 +
| 0x088600C0
 +
| [[11.1.0-34|11.1.0-X]]
 +
| [[FS:CheckUpdatedDat|CheckUpdatedDat]]
 +
| 0x00080000
 
|}
 
|}
  
Line 693: Line 698:
 
Each session for fs:USER has separate permissions, initially these are set to all zero's for new fs:USER sessions. The permissions/etc for fs:USER sessions are initialized via [[FS:Initialize]](loaded from the user process exheader).
 
Each session for fs:USER has separate permissions, initially these are set to all zero's for new fs:USER sessions. The permissions/etc for fs:USER sessions are initialized via [[FS:Initialize]](loaded from the user process exheader).
  
−
=File service=
+
{{Anchor|FSLDR}}{{Anchor|fs:LDR}}
 +
== Filesystem service "fs:LDR" ==
 +
This service is identical to fs:USER, except [[FS:OpenArchive]] archive 0x2345678E can only be accessed with fs:LDR.
 +
 
 +
{{Anchor|FSReg}}{{Anchor|FSREG}}{{Anchor|fs:REG}}
 +
== ProgramRegistry service "fs:REG" ==
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
Line 700: Line 710:
 
|-
 
|-
 
| 0x000100C6
 
| 0x000100C6
−
| [[FSFile:Dummy1|Dummy1]]
+
| [[FSReg:Dummy1|Dummy1]]
 
|-
 
|-
−
| 0x040100C4
+
| 0x040103C0
−
| [[FSFile:Control|Control]]
+
| [[FSReg:Register|Register]]
 
|-
 
|-
−
| 0x08010100
+
| 0x04020040
−
| [[FSFile:OpenSubFile|OpenSubFile]]
+
| [[FSReg:Unregister|Unregister]]
 
|-
 
|-
−
| 0x080200C2
+
| 0x040300C0
−
| [[FSFile:Read|Read]]
+
| [[FSReg:GetProgramInfo|GetProgramInfo]]
 
|-
 
|-
−
| 0x08030102
+
| 0x04040100
−
| [[FSFile:Write|Write]]
+
| [[FSReg:LoadProgram|LoadProgram]]
 
|-
 
|-
−
| 0x08040000
+
| 0x04050080
−
| [[FSFile:GetSize|GetSize]]
+
| [[FSReg:UnloadProgram|UnloadProgram]]
 
|-
 
|-
−
| 0x08050080
+
| 0x04060080
−
| [[FSFile:SetSize|SetSize]]
+
| [[FSReg:CheckHostLoadId|CheckHostLoadId]]
 +
|}
 +
 
 +
Only two sessions can be opened for this service at a time, hence no other processes can use this due to [[Process_Manager_Services|pm-module]] and [[Loader_Services|loader]] using this.
 +
 
 +
=File and directory access=
 +
==Files==
 +
File session handles obtained via [[FS:OpenFile]] and [[FS:OpenFileDirectly]] can be used to access files through a service-like interface, despite not being an actual service registered using [[SRV:RegisterService]]. To use this service-like interface, simply call the SendSyncRequest SVC with a file session handle, using the IPC buffer in thread-local storage for parameters and responses, just like you would with a proper service.
 +
 
 +
{| class="wikitable" border="1"
 
|-
 
|-
−
| 0x08060000
+
!  Command Header
−
| [[FSFile:GetAttributes|GetAttributes]]
+
!  Description
 
|-
 
|-
−
| 0x08070040
+
| 0x000100C6
−
| [[FSFile:SetAttributes|SetAttributes]]
+
| [[FSFile:Dummy1|Dummy1]]
 +
|-
 +
| 0x040100C4
 +
| [[FSFile:Control|Control]]
 +
|-
 +
| 0x08010100
 +
| [[FSFile:OpenSubFile|OpenSubFile]]
 +
|-
 +
| 0x080200C2
 +
| [[FSFile:Read|Read]]
 +
|-
 +
| 0x08030102
 +
| [[FSFile:Write|Write]]
 +
|-
 +
| 0x08040000
 +
| [[FSFile:GetSize|GetSize]]
 +
|-
 +
| 0x08050080
 +
| [[FSFile:SetSize|SetSize]]
 +
|-
 +
| 0x08060000
 +
| [[FSFile:GetAttributes|GetAttributes]]
 +
|-
 +
| 0x08070040
 +
| [[FSFile:SetAttributes|SetAttributes]]
 
|-
 
|-
 
| 0x08080000
 
| 0x08080000
Line 742: Line 785:
 
|-
 
|-
 
| 0x0C010100
 
| 0x0C010100
−
| ? (takes two u64(?), outputs u64)
+
| [[FSFile:GetAvailable|GetAvailable]]
 
|}
 
|}
  
−
=Directory service=
+
==Directories==
 +
Directory session handles obtained via [[FS:OpenDirectory]] are usable via a service-like interface, following the exact same procedure described above for file sessions.
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
Line 777: Line 821:
 
|}
 
|}
  
−
= Filesystem service "fs:LDR" =
+
= Archives =
−
This service is identical to fs:USER, except [[FS:OpenArchive]] archive 0x2345678E can only be accessed with fs:LDR.
 
−
 
 
−
= ProgramRegistry service "fs:REG" =
 
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
−
!  Command Header
+
!  ArchiveId
 
!  Description
 
!  Description
 +
!  Accessible via [[Filesystem_services|FS]]
 +
!  Accessible via [[Filesystem_services_PXI|FSPXI]]
 +
!  Only accessible by Process9 internally
 +
!  Requires binary [[FS:OpenFile|Lowpath]]
 +
!  Required exheader FS access info bitmask
 
|-
 
|-
−
| 0x000100C6
+
| 0x00000003
−
| [[FSReg:Dummy1|Dummy1]]
+
| SelfNCCH (including [[#RomFS|RomFS]])
 +
| Yes
 +
| No
 +
| No
 +
| No
 +
| None
 
|-
 
|-
−
| 0x040103C0
+
| 0x00000004
−
| [[FSReg:Register|Register]]
+
| SaveData (the saveID/mediatype for this is loaded from data originally from the user process' exheader)
 +
| Yes
 +
| No
 +
| No
 +
| No
 +
| None
 
|-
 
|-
−
| 0x04020040
+
| 0x00000006
−
| [[FSReg:Unregister|Unregister]]
+
| ExtSaveData
−
|-
+
| Yes
−
| 0x040300C0
+
| No
−
| [[FSReg:GetProgramInfo|GetProgramInfo]]
+
| No
 +
| Yes
 +
| 0x100D, when the input extdataID isn't listed in the exheader.
 
|-
 
|-
−
| 0x04040100
+
| 0x00000007
−
| [[FSReg:LoadProgram|LoadProgram]]
+
| Shared ExtSaveData
 +
| Yes
 +
| No
 +
| No
 +
| Yes
 +
| None
 
|-
 
|-
−
| 0x04050080
+
| 0x00000008
−
| [[FSReg:UnloadProgram|UnloadProgram]]
+
| SystemSaveData
 +
| Yes
 +
| No
 +
| No
 +
| Yes
 +
| 0x4, when the input saveID doesn't match the exheader system-saveID.
 
|-
 
|-
−
| 0x04060080
+
| 0x00000009
−
| [[FSReg:CheckHostLoadId|CheckHostLoadId]]
+
| SDMC
−
|}
+
| Yes
−
 
+
| Yes
−
Only one session can be opened for this service at a time, hence no other processes can use this due to [[Process_Manager_Services|pm-module]] using this.
+
| No
−
 
+
| No
−
=SEEDDB=
+
| 0x8E
−
With [[9.6.0-24|9.6.0-X]] new [[System_SaveData]] with saveID 0001000F was added, this seems to be handled by FS-module itself, probably via the new service-cmds added to fsuser. [[Home Menu]] and [[NIM_Services|NIM]] module have access to those commands.
 
−
 
 
−
The SEEDDB savedata contains the title-unique seed-data used for the new [[NCCH]] keyY generation added with FIRM [[9.6.0-24|9.6.0-X]].
 
−
 
 
−
= Common Types =
 
−
== MediaType ==
 
−
{| class="wikitable" border="1"
 
 
|-
 
|-
−
!  Value
+
| 0x0000000A
−
!  Description
+
| SDMC Write-Only
 +
| Yes
 +
| No
 +
| No
 +
| No
 +
| 0x808E
 
|-
 
|-
−
| 0
+
| 0x12345678
−
| NAND
+
| ExtSaveData for BOSS
 +
| Yes
 +
| No
 +
| No
 +
| Yes
 +
| 0x44
 
|-
 
|-
−
| 1
+
| 0x12345679
−
| SD
+
| CARD SPI FS
 +
| Yes
 +
| Yes
 +
| No
 +
| No
 +
| 0x16
 
|-
 
|-
−
| 2
+
| 0x1234567B
−
| Game Card
+
| ExtSaveData, and ExtSaveData for BOSS
−
|}
+
| No
−
 
+
| Yes
−
== OpenFlags ==
+
| No
−
{| class="wikitable" border="1"
+
| Yes
 +
|  
 
|-
 
|-
−
!  Bit
+
| 0x1234567C
−
!  Description
+
| SystemSaveData
 +
| No
 +
| Yes
 +
| No
 +
| Yes
 +
|
 
|-
 
|-
−
| 0
+
| 0x1234567D
−
| Read
+
| NAND RW
 +
| Yes
 +
| Yes
 +
| No
 +
| No
 +
| 0x800
 
|-
 
|-
−
| 1
+
| 0x1234567E
−
| Write
+
| NAND RO
 +
| Yes
 +
| Yes
 +
| No
 +
| No
 +
| 0x200
 
|-
 
|-
−
| 2
+
| 0x1234567F
−
| Create
+
| NAND RO Write FS
−
|}
+
| No
−
 
+
| Yes
−
== Attributes ==
+
| No
−
{| class="wikitable" border="1"
+
| No
 +
| ?
 
|-
 
|-
−
!  Offset
+
| 0x12345680
−
!  Size
+
| Unknown. There's code for this in spider v9.9, but that code isn't actually used.
−
!  Description
+
| Yes
 +
| ?
 +
| No
 +
| Yes
 +
| ?
 
|-
 
|-
−
| 0x0
+
| 0x12345681
−
| 0x1
+
| Unknown. Accessed by FS service.
−
| Is Directory
+
| ?
 +
| ?
 +
| No
 +
| ?
 +
| ?
 
|-
 
|-
−
| 0x1
+
| 0x12345682
−
| 0x1
+
| Unknown. There's code for this in spider v9.9, but that code isn't actually used.
−
| Is Hidden
+
| Yes
 +
| ?
 +
| No
 +
| Yes
 +
| ?
 
|-
 
|-
−
| 0x2
+
| 0x2345678A
−
| 0x1
+
| Used for accessing general NCCH data. With FSPXI this also allows savedata access.
−
| Is Archive
+
| Yes
 +
| Yes
 +
| No
 +
| Yes
 +
| 0x1005
 
|-
 
|-
−
| 0x3
+
| 0x2345678B
−
| 0x1
+
| ?
−
| Is Read-Only
+
| No
−
|}
+
| No
−
 
+
| Yes
−
== DirectoryEntry ==
+
| Yes
−
{| class="wikitable" border="1"
+
|  
 
|-
 
|-
−
!  Offset
+
| 0x2345678C
−
!  Size
+
| Used internally to access [[Title_Database|/dbs]] files?
−
!  Description
+
| No
 +
| No
 +
| Yes
 +
| Yes
 +
|
 
|-
 
|-
−
| 0x0
+
| 0x2345678D
−
| 0x20C
+
| ?
−
| UTF-16 Entry Name
+
| No
 +
| No
 +
| Yes
 +
| No
 +
|  
 
|-
 
|-
−
| 0x20C
+
| 0x2345678E
−
| 0xA
+
| FSPXI: Similar to archive 0x2345678A. For fs:LDR(used by the "loader" FIRM ARM11-process), only ExeFS. Not accessible with fs:USER.
−
| UTF-8 Short Name
+
| Yes
 +
| Yes
 +
| No
 +
| Yes
 +
| None, see description.
 
|-
 
|-
−
| 0x216
+
| 0x567890AB
−
| 0x4
+
| NAND CTR FS
−
| UTF-8 Extension
+
| No
 +
| Yes
 +
| No
 +
| No
 +
| ?
 
|-
 
|-
−
| 0x21A
+
| 0x567890AC
−
| 0x1
+
| TWL PHOTO
−
| Always 1
+
| Yes
 +
| Yes
 +
| No
 +
| No
 +
| ?
 
|-
 
|-
−
| 0x21B
+
| 0x567890AD
−
| 0x1
+
| TWLS (DSi Sound stores recordings here). This is mapped to the FAT12 image stored in the file at [[Twln/shared2/0000]].
−
| Reserved
+
| No
 +
| Yes
 +
| No
 +
| No
 +
| ?
 
|-
 
|-
−
| 0x21C
+
| 0x567890AE
−
| 0x4
+
| NAND TWL FS
−
| [[Filesystem_services#Attributes|Attributes]]
+
| Yes
 +
| Yes
 +
| No
 +
| No
 +
| 0x100
 
|-
 
|-
−
| 0x220
+
| 0x567890AF
−
| 0x8
+
| NAND W FS
−
| Entry Size
+
| Yes
−
|}
+
| Yes
−
 
+
| No
−
== ArchiveResource ==
+
| No
−
{| class="wikitable" border="1"
+
| 0x100
 
|-
 
|-
−
!  Offset
+
| 0x567890B0
−
!  Size
+
| ?
−
!  Description
+
| No
 +
| Yes
 +
| No
 +
| No
 +
|
 
|-
 
|-
−
| 0x0
+
| 0x567890B1
−
| 0x4
+
| Gamecard SaveData (for check). This is a wrapper for UserSaveDataForCheck: the OpenArchive code for that is called with archive-lowpath TID=0/mediatype=2(gamecard).
−
| Sector byte-size
+
| Yes
 +
| No
 +
| No
 +
| No
 +
| 0x6
 
|-
 
|-
−
| 0x4
+
| 0x567890B2
−
| 0x4
+
| UserSaveData (for check). This is the same as the regular SaveData archive, except with this the savedata ID and mediatype is loaded from the input archive lowpath.
−
| Cluster byte-size
+
| Yes
−
|-
 
−
| 0x8
 
−
| 0x4
 
−
| Partition capacity in clusters
 
−
|-
 
−
| 0xC
 
−
| 0x4
 
−
| Available free space in clusters
 
−
|}
 
−
 
 
−
== ArchiveId ==
 
−
{| class="wikitable" border="1"
 
−
|-
 
−
!  Idcode
 
−
!  Description
 
−
!  Accessible via [[Filesystem_services|FS]]
 
−
!  Accessible via [[Filesystem_services_PXI|FSPXI]]
 
−
!  Requires binary [[FS:OpenFile|Lowpath]]
 
−
|-
 
−
| 0x00000003
 
−
| Application RomFS
 
−
| Yes
 
 
| No
 
| No
 
| No
 
| No
 +
| Yes
 +
| 0x6
 
|-
 
|-
−
| 0x00000004
+
| 0x567890B4
−
| SaveData (the saveID/mediatype for this is loaded from data originally from the user process' exheader)
+
| Similar to 0x567890B2 but can only access Accessible Save specified in [[NCCH/Extended_Header#Storage_Info|exheader]]?
 
| Yes
 
| Yes
 
| No
 
| No
 
| No
 
| No
 +
| Yes
 +
| ?
 +
|}
 +
 +
Archives listed as not requiring a binary lowpath, use lowpath type [[FS:OpenFile|empty]].
 +
 +
The above permission bitmasks are from v2.x, see the above Services section for how these are handled.
 +
 +
Archives CTR NAND, NAND RO Write FS, TWL NAND, NAND W FS, and CARD SPI FS require the corresponding process exheader access control mount flag to be set, in the exheader for any of the currently running ARM11 processes, for [[Filesystem_services_PXI|FSPXI]]. The access rights checked by [[Filesystem services|FS]] module for archive mounting with fs:USER, are stored in the process' exheader accessinfo.
 +
 +
The CARDSPI archive allows access to the gamecard CARD1 raw savedata flash(aka "cardspi:/" in [[FIRM|Process9]]), the file lowpath must be WCHAR "/". The "NAND W FS" archive allows access to the raw NAND image(aka "wnand:/" in Process9), the file lowpath must be WCHAR "/".
 +
 +
= Filenames and Paths =
 +
{{Anchor|PathType}} PathType:
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Value
 +
!  Description
 
|-
 
|-
−
| 0x00000006
+
| -1
−
| ExtSaveData
+
| Returned internally by Process9, when errors occur it seems(in particular when no nul-terminator was found in the input path). The data ptr is set to NULL.
−
| Yes
 
−
| No
 
−
| Yes
 
 
|-
 
|-
−
| 0x00000007
+
| 0x0
−
| Shared ExtSaveData
+
| INVALID - Specifies an invalid path
−
| Yes
 
−
| No
 
−
| Yes
 
 
|-
 
|-
−
| 0x00000008
+
| 0x1
−
| SystemSaveData
+
| EMPTY - Specifies an empty path
−
| Yes
 
−
| No
 
−
| Yes
 
 
|-
 
|-
−
| 0x00000009
+
| 0x2
−
| SDMC
+
| BINARY - Non-text based path. Meaning is per-archive
−
| Yes
 
−
| Yes
 
−
| No
 
 
|-
 
|-
−
| 0x0000000A
+
| 0x3
−
| SDMC Write-Only
+
| ASCII - Text-based path with 7-bit ASCII characters padded to 8-bits each (signed char)
−
| Yes
 
−
| No
 
−
| No
 
 
|-
 
|-
−
| 0x12345678
+
| 0x4
−
| ExtSaveData for BOSS
+
| UTF16 - Text-based path with UTF-16 characters
−
| Yes
+
|}
−
| No
+
 
−
| Yes
+
In IPC requests, sizes of ASCII and UTF16 paths must include space for the null-terminator.
 +
 
 +
== Binary LowPath ==
 +
The format of the data that a binary LowPath points to is custom per archive.
 +
 
 +
=== SelfNCCH File Path Data Format ===
 +
{| class="wikitable" border="1"
 
|-
 
|-
−
| 0x12345679
+
!  Index word
−
| CARD SPI FS
+
!  Description
−
| Yes
 
−
| Yes
 
−
| No
 
 
|-
 
|-
−
| 0x1234567B
+
| 0
−
| ExtSaveData, and ExtSaveData for BOSS
+
| Type:
−
| No
+
* 0x0: RomFS
−
| Yes
+
* 0x1: error 0xD9004676
−
| Yes
+
* 0x2: ExeFS
 +
* 0x3: Error 0xE0E046BE.
 +
* 0x4: FS-module crashes on this
 +
* 0x5: Update RomFS?
 
|-
 
|-
−
| 0x1234567C
+
| 1-2
−
| SystemSaveData
+
| File name for ExeFS ("icon"/"banner"/"logo"). ".code" is not allowed
−
| No
+
|}
−
| Yes
+
 
−
| Yes
+
Note that ExeFS files only support reading from offset=0 and with size=file_size.
 +
 
 +
=== SystemSaveData Archive Path Data Format ===
 +
==== FS ====
 +
{| class="wikitable" border="1"
 
|-
 
|-
−
| 0x1234567D
+
!  Index word
−
| NAND RW
+
!  Description
−
| Yes
 
−
| Yes
 
−
| No
 
 
|-
 
|-
−
| 0x1234567E
+
| 0
−
| NAND RO
+
| [[Mediatypes|Mediatype]] (must be zero for NAND)
−
| Yes
 
−
| Yes
 
−
| No
 
 
|-
 
|-
−
| 0x1234567F
+
| 1
−
| NAND RO Write FS
+
| saveid
−
| No
+
|}
−
| Yes
+
The file/directory lowpath is a text lowpath in the [[Savegames|savegame]] filesystem.
−
| No
+
 
 +
==== FSPXI ====
 +
{| class="wikitable" border="1"
 
|-
 
|-
−
| 0x2345678A
+
!  Index word
−
| User/GameCard SaveData (for check), and other uses (FS can only mount the latter; includes ExeFS and RomFS) (lo hi mediatype reserved)
+
!  Description
−
| Yes
 
−
| Yes
 
−
| Yes
 
 
|-
 
|-
−
| 0x2345678B
+
| 0
−
| ?
+
| u8 [[Mediatypes|Mediatype]] (must be zero for NAND)
−
| No
+
|}
−
| No
+
The file lowpath is a binary lowpath containing the u64 saveid, however the high word of the saveid is always zero. The mounted file is the cleartext savegame image. Up to 32 SystemSaveData image files can be opened under a single mounted FSPXI archive.
−
| Yes
+
 
 +
=== UserSaveDataForCheck Archive Path Data Format ===
 +
{| class="wikitable" border="1"
 
|-
 
|-
−
| 0x2345678C
+
!  Index word
−
| ?
+
!  Description
−
| No
 
−
| No
 
−
| Yes
 
 
|-
 
|-
−
| 0x2345678D
+
| 0
−
| ?
+
| [[Mediatypes|Mediatype]] (must be non-zero)
−
| No
+
|-
−
| No
+
| 1
−
| No
+
| Lower word saveid
 
|-
 
|-
−
| 0x2345678E
+
| 2
−
| FSPXI: Similar to archive 0x2345678A. For fs:LDR(used by the "loader" FIRM ARM11-process), only ExeFS. Not accessible with fs:USER.
+
| Upper word saveid
−
| Yes
+
|}
−
| Yes
+
The file/directory lowpath for this FS archive is a text path in the [[Savegames|savegame]] filesystem.
−
| Yes
+
 
 +
=== 0x567890B4 Archive Path Data Format ===
 +
{| class="wikitable" border="1"
 
|-
 
|-
−
| 0x567890AB
+
!  Index word
−
| NAND CTR FS
+
!  Description
−
| No
 
−
| Yes
 
−
| No
 
 
|-
 
|-
−
| 0x567890AC
+
| 0
−
| TWL PHOTO
+
| [[Mediatypes|Mediatype]]
−
| Yes
+
|-
−
| Yes
+
| 1
−
| No
+
| <code><nowiki>Lower_word_saveid >> 8</nowiki></code> ?
 
|-
 
|-
−
| 0x567890AD
+
| 2
−
| ?
+
| Unknown. Game calculate this using formula <code><nowiki>0xFFFFFF00 | unknown_b</nowiki></code>
−
| No
+
|}
−
| Yes
+
 
−
| No
+
=== ExtSaveData Archive Path Data Format ===
 +
{| class="wikitable" border="1"
 
|-
 
|-
−
| 0x567890AE
+
!  Index word
−
| NAND TWL FS
+
!  Description
−
| Yes
 
−
| Yes
 
−
| No
 
 
|-
 
|-
−
| 0x567890AF
+
| 0
−
| NAND W FS
+
| [[Mediatypes|Mediatype]]
−
| Yes
 
−
| Yes
 
−
| No
 
 
|-
 
|-
−
| 0x567890B0
+
| 1
−
| ?
+
| Lower word saveid
−
| No
 
−
| Yes
 
−
| No
 
 
|-
 
|-
−
| 0x567890B1
+
| 2
−
| Gamecard SaveData (for check). This is a wrapper for UserSaveDataForCheck: the OpenArchive code for that is called with archive-lowpath TID=0/mediatype=2(gamecard).
+
| Upper word saveid
−
| Yes
+
|}
−
| No
+
For FS, the file/directory lowpath is a text path in the [[extdata]] filesystem. For FSPXI, the file lowpath is a text path relative to the "/extdata/<ExtdataIDHigh>/<ExtdataIDLow>" directory on SD/NAND, for the cleartext extdata image to mount.
−
| No
+
 
 +
=== 0x2345678A Archive Path Data Format ===
 +
{| class="wikitable" border="1"
 
|-
 
|-
−
| 0x567890B2
+
!  Index word
−
| UserSaveData (for check). This is the same as the regular SaveData archive, except with this the savedata ID and mediatype is loaded from the input archive lowpath.
+
!  Description
−
| Yes
+
|-
−
| No
+
| 0
−
| Yes
+
| Lower word programID
 +
|-
 +
| 1
 +
| Upper word programID
 +
|-
 +
| 2
 +
| ([[Mediatypes|Mediatype]] & 0xFF) | (uninitialized_data? & 0xFFFFFF00)
 
|-
 
|-
−
| 0x567890B4
+
| 3
−
| ? SaveData from Demo Version of Retail Game
+
| Number of something? Hardcoded per-archive, 0 for ExeFS, 200 for area:, 100 for rate:, 40 for eula:, etc.
−
| Yes
 
−
| No
 
−
| No
 
 
|}
 
|}
  
−
Archives listed as not requiring a binary lowpath, use lowpath type [[FS:OpenFile|empty]].
+
File lowpath:
−
 
 
−
Archives CTR NAND, NAND RO Write FS, TWL NAND, NAND W FS, and CARD SPI FS require the corresponding process exheader access control mount flag to be set, in the exheader for any of the currently running ARM11 processes, for [[Filesystem_services_PXI|FSPXI]]. The access rights checked by [[Filesystem services|FS]] module for archive mounting with fs:USER, are stored in the process' exheader accessinfo.
 
−
 
 
−
The CARDSPI archive allows access to the gamecard CARD1 raw savedata flash(aka "cardspi:/" in [[FIRM|Process9]]), the file lowpath must be WCHAR "/". The "NAND W FS" archive allows access to the raw NAND image(aka "wnand:/" in Process9), the file lowpath must be WCHAR "/".
 
−
 
 
−
== PathType ==
 
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
−
!  Value
+
!  Index word
 
!  Description
 
!  Description
 
|-
 
|-
−
| 0x0
+
| 0
−
| INVALID - Specifies an invalid path.
+
| 0 for NCCH data, 1 for savedata. The latter is only valid for FSPXI. Value 2 is allowed via archive 0x3, it's unknown what this is.
 
|-
 
|-
−
| 0x1
+
| 1
−
| EMPTY - Specifies an empty path.
+
| TMD content index / NCSD partition index.
 
|-
 
|-
−
| 0x2
+
| 2
−
| BINARY - Non-text based path. Meaning is per-archive.
+
| Type: 0=romfs(0 for non-NCCH as well), 1=exefs ".code"(?), 2=exefs "icon"/"banner"/"logo", 3=unknown, 4=unknown, 5=unknown.
 
|-
 
|-
−
| 0x3
+
| 3-4
−
| CHAR - Text-based path with 8-bit characters.
+
| Filename for ExeFS.
−
|-
 
−
| 0x4
 
−
| WCHAR - Text-based path with 16-bit characters.
 
 
|}
 
|}
  
−
=== Binary LowPath ===
+
The 0x14-byte lowpath is all-zero for accessing the title's main RomFS.
−
The format of the data that a binary LowPath points to is custom per archive.
+
 
 +
=== [[RomFS]] ===
 +
 
 +
Archives 0x3 and 0x2345678E both allow for accessing the [[RomFS#Level_3_Format|level-3 IVFC images]] for RomFS access. The main CXI RomFS is accessible via an all-zero 0xc-byte binary file-lowpath. The update RomFS can be accessed with the first u32 in the binary file-lowpath being set to 0x5. The user must handle parsing the filesystem used in the exposed image itself.
 +
 
 +
With FSPXI the returned data for RomFS is the entire RomFS section from the NCCH, starting at the IVFC header.
  
−
==== SystemSaveData Archive Path Data Format ====
+
The 0x3 archive is an interface for the 0x2345678E archive with the current process programID+mediatype. The file lowpath is 3-words. These words are written to 0x2345678E-archive file_lowpath+0, with the rest of that lowpath set to all-zero(lowpath is different from archive 0x2345678A). File lowpath:
−
===== FS =====
 
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
Line 1,148: Line 1,269:
 
!  Description
 
!  Description
 
|-
 
|-
−
| 0  
+
| 0
−
| [[Mediatypes|Mediatype]] (must be zero for NAND)
+
| See above. The only values which FS-module doesn't allow to be used here are:
 +
* 0x1: Error 0xE0E046BE.
 +
* 0x3: Error 0xE0E046BE.
 +
* 0x4: FS-module executes svcBreak when using this.
 
|-
 
|-
−
| 1
+
| 1-2
−
| saveid
+
| See above. Not validated by FS-module.
 
|}
 
|}
−
The file/directory lowpath is a text lowpath in the [[Savegames|savegame]] filesystem.
 
  
−
===== FSPXI =====
+
=SEEDDB=
 +
With [[9.6.0-24|9.6.0-X]] new [[System_SaveData]] with saveID 0001000F was added, this seems to be handled by FS-module itself, probably via the new service-cmds added to fsuser. [[Home Menu]] and [[NIM_Services|NIM]] module have access to those commands.
 +
 
 +
The SEEDDB savedata contains the title-unique seed-data used for the new [[NCCH]] keyY generation added with FIRM [[9.6.0-24|9.6.0-X]].
 +
 
 +
= Common Types =
 +
== MediaType ==
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
−
!  Index word
+
!  Value
 
!  Description
 
!  Description
 
|-
 
|-
−
| 0  
+
| 0
−
| u8 [[Mediatypes|Mediatype]] (must be zero for NAND)
+
| NAND
 +
|-
 +
| 1
 +
| SD
 +
|-
 +
| 2
 +
| Game Card
 
|}
 
|}
−
The file lowpath is a binary lowpath containing the u64 saveid, however the high word of the saveid is always zero. The mounted file is the cleartext savegame image. Up to 32 SystemSaveData image files can be opened under a single mounted FSPXI archive.
 
  
−
==== UserSaveDataForCheck Archive Path Data Format ====
+
== SystemMediaType ==
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
−
!  Index word
+
!  Value
 
!  Description
 
!  Description
 
|-
 
|-
−
| 0  
+
| 0
−
| [[Mediatypes|Mediatype]] (must be non-zero)
+
| CTR NAND
 
|-
 
|-
 
| 1
 
| 1
−
| Lower word saveid
+
| TWL NAND
 
|-
 
|-
 
| 2
 
| 2
−
| Upper word saveid
+
| SD
 +
|-
 +
| 3
 +
| TWL Photo
 
|}
 
|}
−
The file/directory lowpath for this FS archive is a text path in the [[Savegames|savegame]] filesystem.
 
  
−
==== ExtSaveData Archive Path Data Format ====
+
== OpenFlags ==
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
−
!  Index word
+
!  Bit
 
!  Description
 
!  Description
 
|-
 
|-
−
| 0  
+
| 0
−
| [[Mediatypes|Mediatype]]
+
| Read
 
|-
 
|-
 
| 1
 
| 1
−
| Lower word saveid
+
| Write
 
|-
 
|-
 
| 2
 
| 2
−
| Upper word saveid
+
| Create
−
|}
+
|}
−
For FS, the file/directory lowpath is a text path in the [[extdata]] filesystem. For FSPXI, the file lowpath is a text path relative to the "/extdata/<ExtdataIDHigh>/<ExtdataIDLow>" directory on SD/NAND, for the cleartext extdata image to mount.
+
 
−
 
+
== Attributes ==
−
==== [[RomFS]] ====
+
{| class="wikitable" border="1"
−
The raw FS image for the main CXI RomFS(for the current app this is accessible via archiveid 0x3) can be accessed via an all-zero 0xc-byte binary file-lowpath. This allows access to the raw level-3 IVFC image: the user process must handle parsing the filesystem used in this image itself.
+
|-
−
 
+
!  Offset
−
In this scenario, OpenFile returns a handle to the RomFS archive.
+
!  Size
−
 
+
!  Description
−
== ProgramInfo ==
+
|-
−
{| class="wikitable" border="1"
+
| 0x0
−
|-
+
| 0x1
−
!  Offset
+
| Is Directory
−
!  Size
+
|-
−
!  Description
+
| 0x1
−
|-
+
| 0x1
−
| 0x0
+
| Is Hidden
−
| 0x8
+
|-
−
| Program ID
+
| 0x2
−
|-
+
| 0x1
−
| 0x8
+
| Is Archive
−
| 0x1
+
|-
−
| [[Filesystem_services#MediaType|Media Type]]
+
| 0x3
−
|-
+
| 0x1
−
| 0xC
+
| Is Read-Only
−
| 0x4
+
|}
−
| Reserved
+
 
−
|}
+
== WriteOption ==
−
 
+
{| class="wikitable" border="1"
−
== ProductInfo ==
+
|-
−
{| class="wikitable" border="1"
+
!  Offset
 +
!  Size
 +
!  Description
 +
|-
 +
| 0x0
 +
| 0x1
 +
| Flush
 +
|-
 +
| 0x1
 +
| 0x1
 +
| Update Time Stamp
 +
|-
 +
| 0x2
 +
| 0x1
 +
| Reserved
 +
|-
 +
| 0x3
 +
| 0x1
 +
| Reserved
 +
|}
 +
 
 +
== DirectoryEntry ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Offset
 +
!  Size
 +
!  Description
 +
|-
 +
| 0x0
 +
| 0x20C
 +
| UTF-16 Entry Name
 +
|-
 +
| 0x20C
 +
| 0xA
 +
| 8.3 short filename name
 +
|-
 +
| 0x216
 +
| 0x4
 +
| 8.3 short filename extension
 +
|-
 +
| 0x21A
 +
| 0x1
 +
| Always 1
 +
|-
 +
| 0x21B
 +
| 0x1
 +
| Reserved
 +
|-
 +
| 0x21C
 +
| 0x4
 +
| [[Filesystem_services#Attributes|Attributes]]
 +
|-
 +
| 0x220
 +
| 0x8
 +
| Entry Size
 +
|}
 +
 
 +
== ArchiveResource ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Offset
 +
!  Size
 +
!  Description
 +
|-
 +
| 0x0
 +
| 0x4
 +
| Sector byte-size
 +
|-
 +
| 0x4
 +
| 0x4
 +
| Cluster byte-size
 +
|-
 +
| 0x8
 +
| 0x4
 +
| Partition capacity in clusters
 +
|-
 +
| 0xC
 +
| 0x4
 +
| Available free space in clusters
 +
|}
 +
 
 +
== ProgramInfo ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Offset
 +
!  Size
 +
!  Description
 +
|-
 +
| 0x0
 +
| 0x8
 +
| Program ID
 +
|-
 +
| 0x8
 +
| 0x1
 +
| [[Filesystem_services#MediaType|Media Type]]
 +
|-
 +
| 0x9
 +
| 0x7
 +
| Padding
 +
|}
 +
 
 +
== ProductInfo ==
 +
{| class="wikitable" border="1"
 
|-
 
|-
 
!  Offset
 
!  Offset
Line 1,259: Line 1,497:
 
|  0x10
 
|  0x10
 
|  0x120
 
|  0x120
−
|  The [[nand/private/movable.sed]], encrypted with AES-CTR using the above MAC for the counter.
+
|  The [[nand/private/movable.sed]], encrypted with AES-CBC using the above MAC for the counter.
 
|}
 
|}
  
Line 1,396: Line 1,634:
 
=Errors=
 
=Errors=
 
See [[Filesystem_services_PXI]].
 
See [[Filesystem_services_PXI]].
 +
 +
[[Category:Services]]

Latest revision as of 09:36, 18 September 2024

Services[edit]

Filesystem service "fs:USER"[edit]

You can at most have 32 FS archive handles.

Command Header Available since system version Description Required exheader access info bitmask
0x000100C6 ? Dummy1 None
0x040100C4 ? Control None
0x08010002 ? Initialize None
0x080201C2 ? OpenFile None
0x08030204 ? OpenFileDirectly None
0x08040142 ? DeleteFile None
0x08050244 ? RenameFile None
0x08060142 ? DeleteDirectory None
0x08070142 ? DeleteDirectoryRecursively None
0x08080202 ? CreateFile None
0x08090182 ? CreateDirectory None
0x080A0244 ? RenameDirectory None
0x080B0102 ? OpenDirectory None
0x080C00C2 ? OpenArchive Each archive ID code has separate access info bitmasks, if it has any
0x080D0144 ? ControlArchive None
0x080E0080 ? CloseArchive None
0x080F0180 ? Obsoleted_2_0_FormatThisUserSaveData None
0x08100200 ? Obsoleted_3_0_CreateSystemSaveData 0x4, for when the input saveID doesn't match the exheader saveID
0x08110040 ? Obsoleted_3_0_DeleteSystemSaveData 0x1004, for when the input saveID doesn't match the exheader saveID
0x08120080 ? GetFreeBytes None
0x08130000 ? GetCardType 0x1017
0x08140000 ? GetSdmcArchiveResource None
0x08150000 ? GetNandArchiveResource 0x1007
0x08160000 ? GetSdmcFatfsError 0x2
0x08170000 ? IsSdmcDetected None
0x08180000 ? IsSdmcWritable None
0x08190042 ? GetSdmcCid 0x2
0x081A0042 ? GetNandCid 0x2
0x081B0000 ? GetSdmcSpeedInfo 0x2
0x081C0000 ? GetNandSpeedInfo 0x2
0x081D0042 ? GetSdmcLog 0x2
0x081E0042 ? GetNandLog 0x2
0x081F0000 ? ClearSdmcLog 0x2
0x08200000 ? ClearNandLog 0x2
0x08210000 ? CardSlotIsInserted 0x1017
0x08220000 ? CardSlotPowerOn 0x2
0x08230000 ? CardSlotPowerOff 0x2
0x08240000 ? CardSlotGetCardIFPowerStatus 0x2
0x08250040 ? CardNorDirectCommand 0x2
0x08260080 ? CardNorDirectCommandWithAddress 0x2
0x08270082 ? CardNorDirectRead 0x2
0x082800C2 ? CardNorDirectReadWithAddress 0x2
0x08290082 ? CardNorDirectWrite 0x2
0x082A00C2 ? CardNorDirectWriteWithAddress 0x2
0x082B00C2 ? CardNorDirectRead_4xIO 0x2
0x082C0082 ? CardNorDirectCpuWriteWithoutVerify 0x2
0x082D0040 ? CardNorDirectSectorEraseWithoutVerify 0x2
0x082E0040 ? GetProductInfo 0x1005
0x082F0040 ? GetProgramLaunchInfo 0x1005
0x08300182 ? Obsoleted_3_0_CreateExtSaveData 0xC, for when the input extdataID doesn't match the exheader extdataID
0x08310180 ? Obsoleted_3_0_CreateSharedExtSaveData 0x1005
0x08320102 ? Obsoleted_3_0_ReadExtSaveDataIcon 0x100D, for when the input extdataID doesn't match the exheader extdataID
0x08330082 ? Obsoleted_3_0_EnumerateExtSaveData 0x1005
0x08340082 ? Obsoleted_3_0_EnumerateSharedExtSaveData 0x1005
0x08350080 ? Obsoleted_3_0_DeleteExtSaveData 0x100D, for when the input extdataID doesn't match the exheader extdataID
0x08360080 ? Obsoleted_3_0_DeleteSharedExtSaveData 0x1005
0x08370040 ? SetCardSpiBaudRate 0x2
0x08380040 ? SetCardSpiBusMode 0x2
0x08390000 ? SendInitializeInfoTo9 None
0x083A0100 ? GetSpecialContentIndex 0x1005
0x083B00C2 ? GetLegacyRomHeader 0x1015
0x083C00C2 ? GetLegacyBannerData 0x1015
0x083D0100 ? CheckAuthorityToAccessExtSaveData 0x44
0x083E00C2 ? QueryTotalQuotaSize None
0x083F00C0 ? Obsoleted_3_0_GetExtDataBlockSize None
0x08400040 ? AbnegateAccessRight ?
0x08410000 ? DeleteSdmcRoot 0x1005
0x08420040 ? DeleteAllExtSaveDataOnNand 0x1005
0x08430000 ? InitializeCtrFileSystem None
0x08440000 ? CreateSeed 0x2
0x084500C2 ? GetFormatInfo ?
0x08460102 ? GetLegacyRomHeader2 0x1015
0x08470180 ? Obsoleted_2_0_FormatCtrCardUserSaveData 0x6
0x08480042 ? GetSdmcCtrRootPath 0x100D
0x08490040 ? GetArchiveResource ?
0x084A0002 ? ExportIntegrityVerificationSeed 0x4000
0x084B0002 ? ImportIntegrityVerificationSeed 0x4000
0x084C0242 ? FormatSaveData 0x6, in some cases this write isn't needed however
0x084D0102 ? GetLegacySubBannerData 0x1015
0x084E0342 ? UpdateSha256Context 0x5
0x084F0102 ? ReadSpecialFile None
0x08500040 ? GetSpecialFileSize None
0x08510242 3.0.0-5 CreateExtSaveData Shared extdata: 0x101005. Regular extdata in certain cases: 0xC
0x08520100 3.0.0-5 DeleteExtSaveData Shared extdata: 0x101005. Regular extdata in certain cases: 0x10100D
0x08530142 3.0.0-5 ReadExtSaveDataIcon 0x10100D (this doesn't apply in certain cases, however)
0x085400C0 3.0.0-5 GetExtDataBlockSize 0x10100D (this doesn't apply in certain cases, however)
0x08550102 3.0.0-5 EnumerateExtSaveData 0x101005
0x08560240 3.0.0-5 CreateSystemSaveData 0x4 (this doesn't apply in certain cases, however)
0x08570080 3.0.0-5 DeleteSystemSaveData 0x1004 (this doesn't apply in certain cases, however)
0x08580000 3.0.0-5 StartDeviceMoveAsSource 0x2004
0x08590200 3.0.0-5 StartDeviceMoveAsDestination 0x2004
0x085A00C0 3.0.0-5 SetArchivePriority None
0x085B0080 3.0.0-5 GetArchivePriority None
0x085C00C0 3.0.0-5 SetCtrCardLatencyParameter 0xE
0x085D01C0 3.0.0-5 SetFsCompatibilityInfo 0x100001
0x085E0040 3.0.0-5 ResetCardCompatibilityParameter 0xE
0x085F0040 3.0.0-5 SwitchCleanupInvalidSaveData 0x12004
0x08600042 3.0.0-5 EnumerateSystemSaveData 0x2004
0x08610042 3.0.0-5 InitializeWithSdkVersion None
0x08620040 3.0.0-5 SetPriority None
0x08630000 3.0.0-5 GetPriority None
0x08640000 3.0.0-5 Obsoleted_4_0_GetNandInfo Stubbed, this returns an error
0x08650140 4.0.0-7 SetSaveDataSecureValue 0x121004 (in certain cases this doesn't apply, however)
0x086600C0 4.0.0-7 GetSaveDataSecureValue 0x121004 (in certain cases this doesn't apply, however)
0x086700C4 4.0.0-7 ControlSecureSave 0x121004
0x08680000 4.0.0-7 GetMediaType None
0x08690000 4.0.0-7 Obsoleted_4_0_GetNandEraseCount Stubbed, this returns an error.
0x086A0082 4.0.0-7 ReadNandReport None
0x086B00C2 ? SetOtherSaveDataSecureValue 00121004
0x086C00C2 ? GetOtherSaveDataSecureValue 00121004
0x086D0040 ? ? 00020004
0x086E00C0 Related to Secure Value? Used in Pokemon Sun/Moon. SetThisSaveDataSecureValue None?
0x086F0040 Related to Secure Value? Used in Pokemon Sun/Moon. GetThisSaveDataSecureValue 0xE
0x087000C2 ? ? None?
0x08710100 ? ? 0xC
0x087201C0 ? ? 00080004
0x087300C0 ? ? 00080004
0x08740000 ? ? 00080004
0x08750140 ? ? None?
0x087600C0 ? ? None?
0x08770100 ? ? ?
0x087800C0 ? ? ?
0x087900C2 ? Same as GetLegacyBannerData, except for the last parameter this passes u8 value 0x1 instead of 0x0, for the FSPXI command. 0x00101015
0x087A0180 9.6.0-X AddSeed 0x00200000
0x087B.... 9.6.0-X Wrapper for the code internally used for command <0x087A....>. 0x00200000
0x087C.... 9.6.0-X Eventually calls same code as command <0x087A....>. 0x00200000
0x087D0000 9.6.0-X GetNumSeeds. Writes the number of seeds to cmdreply[2] 0x00200000
0x087E0042 9.6.0-X Eventually calls same code as command <0x087A....>. Writes a list of titleIDs to the outbuf, this is for titles with content-lock-seed(s) stored in SEEDDB. (u32 total_titleids_probably, ((Size<<4) | 12), outbufptr) 0x00200000
0x087F.... 9.6.0-X ? 0x00200000
0x0880.... 9.6.0-X Eventually calls same code as command <0x087A....>. 0x00200000
0x0881.... 9.6.0-X Eventually calls same code as command <0x087A....>. 0x00200000
0x0882.... 9.6.0-X Eventually calls same code as command <0x087A....>. 0x00200000
0x08830000 9.6.0-X Writes an output value to cmdreply[2]. 0x00200000
0x08840042 9.6.0-X Eventually calls same code as command <0x087A....>. 0x00200000
0x0885.... 9.6.0-X ? 0x00200000
0x088600C0 11.1.0-X CheckUpdatedDat 0x00080000

Note: The question marks from Dummy1 to GetSpecialFileSize on the "available since system version" field are mainly there because I think that most of these are necessary for the main system to function, so theoretically that would mean that since the creation of the 3DS these were available, or since launch if that makes more sense. But because of the peculiar nature of some of the functions, they will remain question marks until they can be confirmed 100%.

When access rights are required for a command, at least one of the bits in the process access info specified in the above table for the command must be set. Error 0xD9004676 is returned when a process attempts to use a command which it doesn't have access rights for the command. The exheader access info field is all zero's for most applications. Note that the permissions listed in the above table is for system-version v2.x, therefore permission bit(s) added with newer FIRM may be missing from this.

Each session for fs:USER has separate permissions, initially these are set to all zero's for new fs:USER sessions. The permissions/etc for fs:USER sessions are initialized via FS:Initialize(loaded from the user process exheader).

Filesystem service "fs:LDR"[edit]

This service is identical to fs:USER, except FS:OpenArchive archive 0x2345678E can only be accessed with fs:LDR.

ProgramRegistry service "fs:REG"[edit]

Command Header Description
0x000100C6 Dummy1
0x040103C0 Register
0x04020040 Unregister
0x040300C0 GetProgramInfo
0x04040100 LoadProgram
0x04050080 UnloadProgram
0x04060080 CheckHostLoadId

Only two sessions can be opened for this service at a time, hence no other processes can use this due to pm-module and loader using this.

File and directory access[edit]

Files[edit]

File session handles obtained via FS:OpenFile and FS:OpenFileDirectly can be used to access files through a service-like interface, despite not being an actual service registered using SRV:RegisterService. To use this service-like interface, simply call the SendSyncRequest SVC with a file session handle, using the IPC buffer in thread-local storage for parameters and responses, just like you would with a proper service.

Command Header Description
0x000100C6 Dummy1
0x040100C4 Control
0x08010100 OpenSubFile
0x080200C2 Read
0x08030102 Write
0x08040000 GetSize
0x08050080 SetSize
0x08060000 GetAttributes
0x08070040 SetAttributes
0x08080000 Close
0x08090000 Flush
0x080A0040 SetPriority
0x080B0000 GetPriority
0x080C0000 OpenLinkFile
0x0C010100 GetAvailable

Directories[edit]

Directory session handles obtained via FS:OpenDirectory are usable via a service-like interface, following the exact same procedure described above for file sessions.

Command Header Available since system version Description
0x000100C6 1.0.0-0 Dummy1
0x040100C4 1.0.0-0 Control
0x08010042 1.0.0-0 Read
0x08020000 1.0.0-0 Close
0x08030040 ? SetPriority
0x08040000 ? GetPriority

Archives[edit]

ArchiveId Description Accessible via FS Accessible via FSPXI Only accessible by Process9 internally Requires binary Lowpath Required exheader FS access info bitmask
0x00000003 SelfNCCH (including RomFS) Yes No No No None
0x00000004 SaveData (the saveID/mediatype for this is loaded from data originally from the user process' exheader) Yes No No No None
0x00000006 ExtSaveData Yes No No Yes 0x100D, when the input extdataID isn't listed in the exheader.
0x00000007 Shared ExtSaveData Yes No No Yes None
0x00000008 SystemSaveData Yes No No Yes 0x4, when the input saveID doesn't match the exheader system-saveID.
0x00000009 SDMC Yes Yes No No 0x8E
0x0000000A SDMC Write-Only Yes No No No 0x808E
0x12345678 ExtSaveData for BOSS Yes No No Yes 0x44
0x12345679 CARD SPI FS Yes Yes No No 0x16
0x1234567B ExtSaveData, and ExtSaveData for BOSS No Yes No Yes
0x1234567C SystemSaveData No Yes No Yes
0x1234567D NAND RW Yes Yes No No 0x800
0x1234567E NAND RO Yes Yes No No 0x200
0x1234567F NAND RO Write FS No Yes No No ?
0x12345680 Unknown. There's code for this in spider v9.9, but that code isn't actually used. Yes ? No Yes ?
0x12345681 Unknown. Accessed by FS service. ? ? No ? ?
0x12345682 Unknown. There's code for this in spider v9.9, but that code isn't actually used. Yes ? No Yes ?
0x2345678A Used for accessing general NCCH data. With FSPXI this also allows savedata access. Yes Yes No Yes 0x1005
0x2345678B ? No No Yes Yes
0x2345678C Used internally to access /dbs files? No No Yes Yes
0x2345678D ? No No Yes No
0x2345678E FSPXI: Similar to archive 0x2345678A. For fs:LDR(used by the "loader" FIRM ARM11-process), only ExeFS. Not accessible with fs:USER. Yes Yes No Yes None, see description.
0x567890AB NAND CTR FS No Yes No No ?
0x567890AC TWL PHOTO Yes Yes No No ?
0x567890AD TWLS (DSi Sound stores recordings here). This is mapped to the FAT12 image stored in the file at Twln/shared2/0000. No Yes No No ?
0x567890AE NAND TWL FS Yes Yes No No 0x100
0x567890AF NAND W FS Yes Yes No No 0x100
0x567890B0 ? No Yes No No
0x567890B1 Gamecard SaveData (for check). This is a wrapper for UserSaveDataForCheck: the OpenArchive code for that is called with archive-lowpath TID=0/mediatype=2(gamecard). Yes No No No 0x6
0x567890B2 UserSaveData (for check). This is the same as the regular SaveData archive, except with this the savedata ID and mediatype is loaded from the input archive lowpath. Yes No No Yes 0x6
0x567890B4 Similar to 0x567890B2 but can only access Accessible Save specified in exheader? Yes No No Yes ?

Archives listed as not requiring a binary lowpath, use lowpath type empty.

The above permission bitmasks are from v2.x, see the above Services section for how these are handled.

Archives CTR NAND, NAND RO Write FS, TWL NAND, NAND W FS, and CARD SPI FS require the corresponding process exheader access control mount flag to be set, in the exheader for any of the currently running ARM11 processes, for FSPXI. The access rights checked by FS module for archive mounting with fs:USER, are stored in the process' exheader accessinfo.

The CARDSPI archive allows access to the gamecard CARD1 raw savedata flash(aka "cardspi:/" in Process9), the file lowpath must be WCHAR "/". The "NAND W FS" archive allows access to the raw NAND image(aka "wnand:/" in Process9), the file lowpath must be WCHAR "/".

Filenames and Paths[edit]

PathType:

Value Description
-1 Returned internally by Process9, when errors occur it seems(in particular when no nul-terminator was found in the input path). The data ptr is set to NULL.
0x0 INVALID - Specifies an invalid path
0x1 EMPTY - Specifies an empty path
0x2 BINARY - Non-text based path. Meaning is per-archive
0x3 ASCII - Text-based path with 7-bit ASCII characters padded to 8-bits each (signed char)
0x4 UTF16 - Text-based path with UTF-16 characters

In IPC requests, sizes of ASCII and UTF16 paths must include space for the null-terminator.

Binary LowPath[edit]

The format of the data that a binary LowPath points to is custom per archive.

SelfNCCH File Path Data Format[edit]

Index word Description
0 Type:
  • 0x0: RomFS
  • 0x1: error 0xD9004676
  • 0x2: ExeFS
  • 0x3: Error 0xE0E046BE.
  • 0x4: FS-module crashes on this
  • 0x5: Update RomFS?
1-2 File name for ExeFS ("icon"/"banner"/"logo"). ".code" is not allowed

Note that ExeFS files only support reading from offset=0 and with size=file_size.

SystemSaveData Archive Path Data Format[edit]

FS[edit]

Index word Description
0 Mediatype (must be zero for NAND)
1 saveid

The file/directory lowpath is a text lowpath in the savegame filesystem.

FSPXI[edit]

Index word Description
0 u8 Mediatype (must be zero for NAND)

The file lowpath is a binary lowpath containing the u64 saveid, however the high word of the saveid is always zero. The mounted file is the cleartext savegame image. Up to 32 SystemSaveData image files can be opened under a single mounted FSPXI archive.

UserSaveDataForCheck Archive Path Data Format[edit]

Index word Description
0 Mediatype (must be non-zero)
1 Lower word saveid
2 Upper word saveid

The file/directory lowpath for this FS archive is a text path in the savegame filesystem.

0x567890B4 Archive Path Data Format[edit]

Index word Description
0 Mediatype
1 Lower_word_saveid >> 8 ?
2 Unknown. Game calculate this using formula 0xFFFFFF00 | unknown_b

ExtSaveData Archive Path Data Format[edit]

Index word Description
0 Mediatype
1 Lower word saveid
2 Upper word saveid

For FS, the file/directory lowpath is a text path in the extdata filesystem. For FSPXI, the file lowpath is a text path relative to the "/extdata/<ExtdataIDHigh>/<ExtdataIDLow>" directory on SD/NAND, for the cleartext extdata image to mount.

0x2345678A Archive Path Data Format[edit]

Index word Description
0 Lower word programID
1 Upper word programID
2 (Mediatype & 0xFF) | (uninitialized_data? & 0xFFFFFF00)
3 Number of something? Hardcoded per-archive, 0 for ExeFS, 200 for area:, 100 for rate:, 40 for eula:, etc.

File lowpath:

Index word Description
0 0 for NCCH data, 1 for savedata. The latter is only valid for FSPXI. Value 2 is allowed via archive 0x3, it's unknown what this is.
1 TMD content index / NCSD partition index.
2 Type: 0=romfs(0 for non-NCCH as well), 1=exefs ".code"(?), 2=exefs "icon"/"banner"/"logo", 3=unknown, 4=unknown, 5=unknown.
3-4 Filename for ExeFS.

The 0x14-byte lowpath is all-zero for accessing the title's main RomFS.

RomFS[edit]

Archives 0x3 and 0x2345678E both allow for accessing the level-3 IVFC images for RomFS access. The main CXI RomFS is accessible via an all-zero 0xc-byte binary file-lowpath. The update RomFS can be accessed with the first u32 in the binary file-lowpath being set to 0x5. The user must handle parsing the filesystem used in the exposed image itself.

With FSPXI the returned data for RomFS is the entire RomFS section from the NCCH, starting at the IVFC header.

The 0x3 archive is an interface for the 0x2345678E archive with the current process programID+mediatype. The file lowpath is 3-words. These words are written to 0x2345678E-archive file_lowpath+0, with the rest of that lowpath set to all-zero(lowpath is different from archive 0x2345678A). File lowpath:

Index word Description
0 See above. The only values which FS-module doesn't allow to be used here are:
  • 0x1: Error 0xE0E046BE.
  • 0x3: Error 0xE0E046BE.
  • 0x4: FS-module executes svcBreak when using this.
1-2 See above. Not validated by FS-module.

SEEDDB[edit]

With 9.6.0-X new System_SaveData with saveID 0001000F was added, this seems to be handled by FS-module itself, probably via the new service-cmds added to fsuser. Home Menu and NIM module have access to those commands.

The SEEDDB savedata contains the title-unique seed-data used for the new NCCH keyY generation added with FIRM 9.6.0-X.

Common Types[edit]

MediaType[edit]

Value Description
0 NAND
1 SD
2 Game Card

SystemMediaType[edit]

Value Description
0 CTR NAND
1 TWL NAND
2 SD
3 TWL Photo

OpenFlags[edit]

Bit Description
0 Read
1 Write
2 Create

Attributes[edit]

Offset Size Description
0x0 0x1 Is Directory
0x1 0x1 Is Hidden
0x2 0x1 Is Archive
0x3 0x1 Is Read-Only

WriteOption[edit]

Offset Size Description
0x0 0x1 Flush
0x1 0x1 Update Time Stamp
0x2 0x1 Reserved
0x3 0x1 Reserved

DirectoryEntry[edit]

Offset Size Description
0x0 0x20C UTF-16 Entry Name
0x20C 0xA 8.3 short filename name
0x216 0x4 8.3 short filename extension
0x21A 0x1 Always 1
0x21B 0x1 Reserved
0x21C 0x4 Attributes
0x220 0x8 Entry Size

ArchiveResource[edit]

Offset Size Description
0x0 0x4 Sector byte-size
0x4 0x4 Cluster byte-size
0x8 0x4 Partition capacity in clusters
0xC 0x4 Available free space in clusters

ProgramInfo[edit]

Offset Size Description
0x0 0x8 Program ID
0x8 0x1 Media Type
0x9 0x7 Padding

ProductInfo[edit]

Offset Size Description
0x0 0x10 Product Code
0x10 0x2 Company Code
0x12 0x2 Remaster Version

IntegrityVerificationSeed[edit]

Offset Size Description
0x0 0x10 AES-CBC MAC over a SHA256 hash, which hashes the first 0x110-bytes of the cleartext SEED.
0x10 0x120 The nand/private/movable.sed, encrypted with AES-CBC using the above MAC for the counter.

ExtSaveDataInfo[edit]

Offset Size Description
0x0 0x1 Media Type
0x1 0x1 Unknown
0x2 0x2 Reserved
0x4 0x8 Save ID
0xC 0x4 Reserved

SystemSaveDataInfo[edit]

Offset Size Description
0x0 0x1 Media Type
0x1 0x1 Unknown
0x2 0x2 Reserved
0x4 0x4 Save ID

SecureValueSlot[edit]

Value Description
0x1000 SD Application

CardSpiBaudRate[edit]

Value Description
0x0 512KHz
0x1 1MHz
0x2 2MHz
0x3 4MHz
0x4 8MHz
0x5 16MHz

CardSpiBusMode[edit]

Value Description
0x0 1-bit
0x1 4-bit

SpecialContentType[edit]

Value Description
0x1 Update
0x2 Manual
0x3 DLP Child

DeviceMoveContext[edit]

Offset Size Description
0x0 0x10 IVs
0x10 0x10 Encrypt Parameter

Errors[edit]

See Filesystem_services_PXI.

Retrieved from "https://www.3dbrew.org/w/index.php?title=Filesystem_services&oldid=22690"