3dbrew - User contributions [en]

NCCH

2014-12-22T07:44:36Z

Idunoe:

[[Category:File formats]]
The following text tries to document the structure of the NCCH container format.

== Overview ==
There are two known NCCH container specialisations used on the 3DS, "executable" and "non-executable", officially known as CXI and CFA respectively.

== CXI ==

The CXI (CTR Executable Image) specialisation of the NCCH container, contains executable code, which runs on a single ARM11 core. It can communicate through SVC calls with the other ARM11 core running the 'system' program code. For reasons of clarity, the ARM11 cores will sometimes be called the 'appcore' and 'syscore' respectively.

The CXI format is structured in the following order:
* first a NCCH header,
* followed by an extended header,
* followed by an access descriptor,
* followed by an '''optional''' plain binary region,
* followed by an '''optional''' executable filesystem ([[ExeFS]]) - (contains ARM11 code, Home menu [[SMDH|icn]]/bnr and [[Logo|logo]]),
* and finally followed by an '''optional''' read-only filesystem ([[RomFS]]) - (Used for external file storage).

The extended header contains additional information regarding access control.
The plain binary region is an area specifically stored in plaintext, mostly containing SDK library strings for identification.

== CFA ==

The CFA (CTR File Archive) specialisation of the NCCH container, is not executable, but are used in conjunction with CXI files. For instance the DLP Child Container and the Electronic Manual. (There is a system update NCCH which follows this format, but is used by the 3DS rather than the Application NCCH, and only works when embedded in the [[CCI]] format because the nVer is kept in the header of retail [[CCI]] files instead of the application NCCH). There are CFA files which exist alone in a title, but these are just [[Title list|System Data Archive]] titles and are found only in the [[Flash Filesystem#CTR partition|NAND]].

CFA files are structured in the following order:
* first a NCCH header,
* followed by an '''optional''' executable filesystem ([[ExeFS]]) (same as in CXI, except no ARM11 code)
* followed by an '''optional''' read-only filesystem ([[RomFS]])

Non-Executable NCCH file examples(Includes Decrypted [[RomFS]]):

[https://dl.dropbox.com/u/60710927/CTR/Sample/DLP%20Child.7z DLPChild Container]
[https://dl.dropbox.com/u/60710927/CTR/Sample/Manual.7z Electronic Manual]

== NCCH Specs ==

=== Encryption ===
The extended header, the [[ExeFS]] and the [[RomFS]] are encrypted using 128-bit AES CTR. See here regarding the [https://github.com/3dshax/ctr/blob/master/ctrtool/ncch.c CTR].

The key is generated using the [[AES|AES Engine]] key generator, where the keyX is set by the bootrom (keyslot 0x2C) and the keyY is the first 0x10 bytes of the NCCH signature. This method of key generation is referred to as "secure-crypto".

If a certain NCCH flag is set, a fixed AES key is used. There are two fixed keys, one for titles which have the system category bit set (SystemFixedKey), and one for the rest ("zeros" key). These are debug keys, as they aren't nomally supported on retail systems.

As of [[7.0.0-13|7.0.0-X]] the system supports a new encryption method for secure-crypto (when ncchflag[3] != 0). Where a second key is generated using the same keyY but with another [[AES|keyslot]]. The second key is used to crypt the [[RomFS]] and [[ExeFS]] files which don't have filenames "icon" or "banner"(i.e. ".code" and ".firm"). While everything else is crypted with the original key. Note the CTR used is the same for both keys. This makes titles "recognizable" but not "launchable" on systems which don't support this method or the keyslot used. See below for keyslots used for generating the second key.

{| class="wikitable" border="1"
|-
! ncchflag[3]
! FW Introduced
! Old3DS
! AES Keyslot
! Notes
|-
| 0x01
| [[7.0.0-13|7.0.0-X]]
| style="background: green" | Yes
| 0x25
| This keyslot is [[Savegames|initialized]] by the 6.0 gamecard savegame keyY init function during boot, using a different portion of the [[Savegames|final]] hash(this keyslot is separate from the one used for the 6.0 save crypto).
|-
| 0x0A
| [[9.3.0-21|9.3.0-X]]
| style="background: red" | No
| ?
|
|}

=== Format ===

Currently, only [[ExeFS]]:/.code can be compressed (with a LZ77 variant). A flag in the [[NCCH/Extended Header#System Info|exheader]] determines if this is the case.

On retail for SD applications, exheader_systeminfoflags.flag bit1 must be set.

Retail CFAs use the default NCCH product code "CTR-P-CTAP", while retail title/gamecard CXIs use NCCH product code "CTR-X-XXXX". This product code is the NCCH [[Serials|serial code]]. The region-locking info checked by home menu is stored in the [[SMDH#BNR Region|icon]].

All of the hashes stored in this NCCH header are over the cleartext data. The ExeFS/RomFS superblock starts at offset 0x0 in the ExeFS/RomFS, and the size is specified by the hash region fields. Nintendo's NCCH validation code seems to have the size of this region fixed to 0x200 bytes (for ExeFS at least).

As of [[5.0.0-11]] the application [[ExeFS]]:/logo can be loaded from the plaintext region between the access descriptor and the plain region, all applications built since [[5.0.0-11]] store the logo here. The size of this logo is always 0x2000-bytes.

The plain region mainly contains tags for each SDK library used when building the CXI. The version used for the "FIRMWARE" tag is the kernel/FIRM [[Configuration_Memory|version]], this version can also be stored in the exheader "kernel release version" ARM11 kernel descriptor field. As of [[2.2.0-X]] the NATIVE_FIRM kernels check the CXI exheader "kernel release version" field, if it is stored in the CXI exheader. If the kernel/FIRM version specified by this field is higher than the version of the running NATIVE_FIRM, the kernel will return error-code 0xD9001413.

=== NCCH Header ===
{| class="wikitable" border="1"
|-
! OFFSET
! SIZE
! DESCRIPTION
|-
| 0x000
| 0x100
| RSA-2048 signature of the NCCH header, using SHA-256.
|-
| 0x100
| 4
| Magic ID, always 'NCCH'
|-
| 0x104
| 4
| Content size, in media units (1 media unit = 0x200 bytes)
|-
| 0x108
| 8
| Partition ID
|-
| 0x110
| 2
| Maker code
|-
| 0x112
| 2
| Version
|-
| 0x114
| 4
| Reserved
|-
| 0x118
| 8
| Program ID
|-
| 0x120
| 0x10
| Reserved
|-
| 0x130
| 0x20
| Logo Region SHA-256 hash. (For applications built with SDK 5+) (Supported from firmware: [[5.0.0-11]])
|-
| 0x150
| 0x10
| Product code
|-
| 0x160
| 0x20
| Extended header SHA-256 hash (SHA256 of 2x Alignment Size, beginning at 0x0 of ExHeader)
|-
| 0x180
| 4
| Extended header size
|-
| 0x184
| 4
| Reserved
|-
| 0x188
| 8
| Flags (See Below)
|-
| 0x190
| 4
| Plain region offset, in media units
|-
| 0x194
| 4
| Plain region size, in media units
|-
| 0x198
| 4
| Logo Region offset, in media units (For applications built with SDK 5+) (Supported from firmware: [[5.0.0-11]])
|-
| 0x19c
| 4
| Logo Region size, in media units (For applications built with SDK 5+) (Supported from firmware: [[5.0.0-11]])
|-
| 0x1A0
| 4
| ExeFS offset, in media units
|-
| 0x1A4
| 4
| ExeFS size, in media units
|-
| 0x1A8
| 4
| ExeFS hash region size, in media units
|-
| 0x1AC
| 4
| Reserved
|-
| 0x1B0
| 4
| RomFS offset, in media units
|-
| 0x1B4
| 4
| RomFS size, in media units
|-
| 0x1B8
| 4
| RomFS hash region size, in media units
|-
| 0x1BC
| 4
| Reserved
|-
| 0x1C0
| 0x20
| ExeFS superblock SHA-256 hash - (SHA-256 hash, starting at 0x0 of the ExeFS over the number of media units specified in the ExeFS hash region size)
|-
| 0x1E0
| 0x20
| RomFS superblock SHA-256 hash - (SHA-256 hash, starting at 0x0 of the RomFS over the number of media units specified in the RomFS hash region size)
|}

=== NCCH Flags ===
{| class="wikitable" border="1"
|-
! INDEX
! DESCRIPTION
|-
| 3
| Crypto Method: When this is non-zero, a NCCH crypto method using two keyslots is used(see above).
|-
| 4
| Content Platform: 1 = CTR.
|-
| 5
| Content Type Bit-masks: Data = 0x1, Executable = 0x2, SystemUpdate = 0x4, Manual = 0x8, Child = (0x4<nowiki>|</nowiki>0x8), Trial = 0x10. When 'Data' is set, but not 'Executable', NCCH is a CFA. Otherwise when 'Executable' is set, NCCH is a CXI.
|-
| 6
| Content Unit Size i.e. u32 ContentUnitSize = 0x200*2^flags[6];
|-
| 7
| Bit-masks: FixedCryptoKey = 0x1, NoMountRomFs = 0x2, NoCrypto = 0x4
|}
CXIs NCCH header signature is verified using the RSA public key stored in the accessdesc,(which follows the exheader) while CFAs NCCH header is verified with a fixed RSA public key.

==== NCCH header example for Lego Starwars III ====
Signature: 720FF8F83F2A1E998322A026D1434165
ED19642ABC1CB2722135AA202BEAD60A
80BCD21C768C597B8268FEF2C64EA710
4C9BA5E12CFFBD1D0C619F4EF7B42CA7
DD8482CB4EB26720AD66CDA57ABCBCFB
D63268A6E2896A59B3B744E39E45B88A
ABB4C0980ACC6210818DCE6DAC838A10
95D0F66B352474D4B3DA4B333F49912D
29AF7EA58BC8C890B18C70B7D540A9FB
EBE24A5312055617D3353B28C3EB1D17
61021BEFF6AD22C384835B40BD44DFAD
981F6350F9458B17BCB5F768C92ABC93
2BCE9888855A8998F4CDE40C9543514A
C57B84EB75A680E7C742632614620D1D
A253284DF3DC01091EB3800C36FD62EE
BA15340F1FD498FAB67C0302E9CDA397
Magic: NCCH
Content size: 0x1cfef400
Partition id: 0004000000038c00
Maker code: 3436 ("46")
Version: 0002
Program id: 0004000000038c00
Temp flag: 00
Product code: CTR-P-ALGP
Extended header hash: 0C27E3C1DE7B2AE2D3114F32A4EEBF46
9AFD0CF352C11D4984C2A9F1D2144C63
Extended header size: 00000400
Flags: 0000030100000000
Plain region offset: 0x00004a00
Plain region size: 0x00000200
ExeFS offset: 0x00004c00
ExeFS size: 0x00143800
ExeFS hash region size: 0x00000200
RomFS offset: 0x00148400
RomFS size: 0x1ceab000
RomFS hash region size: 0x00000200
ExeFS Superblock Hash: 130C042615F647C4C63225EA9E67F8A2
7B15246B88FBC7A927257B84977B787B
RomFS Superblock Hash: A65BEE1060BB6A6821BBCEC600035B7E
64FB6EACA7F0960CFB1F5A37087728F7
Note: Offsets and sizes in media units have been converted to byte sizes.

==== Plain region example for Lego Starwars III ====
0004a00: 5b 53 44 4b 2b 4e 49 4e 54 45 4e 44 4f 3a 43 54 [SDK+NINTENDO:CT [SDK+NINTENDO:CTR_SDK-0_14_23_200_none]
0004a10: 52 5f 53 44 4b 2d 30 5f 31 34 5f 32 33 5f 32 30 R_SDK-0_14_23_20
0004a20: 30 5f 6e 6f 6e 65 5d 00 5b 53 44 4b 2b 4e 49 4e 0_none].[SDK+NIN [SDK+NINTENDO:Firmware-02_27]
0004a30: 54 45 4e 44 4f 3a 46 69 72 6d 77 61 72 65 2d 30 TENDO:Firmware-0
0004a40: 32 5f 32 37 5d 00 5b 53 44 4b 2b 4d 6f 62 69 63 2_27].[SDK+Mobic [SDK+Mobiclip:Deblocker_1_0_2]
0004a50: 6c 69 70 3a 44 65 62 6c 6f 63 6b 65 72 5f 31 5f lip:Deblocker_1_
0004a60: 30 5f 32 5d 00 5b 53 44 4b 2b 4d 6f 62 69 63 6c 0_2].[SDK+Mobicl [SDK+Mobiclip:ImaAdpcmDec_1_0_0]
0004a70: 69 70 3a 49 6d 61 41 64 70 63 6d 44 65 63 5f 31 ip:ImaAdpcmDec_1
0004a80: 5f 30 5f 30 5d 00 5b 53 44 4b 2b 4d 6f 62 69 63 _0_0].[SDK+Mobic [SDK+Mobiclip:MobiclipDec_1_0_1]
0004a90: 6c 69 70 3a 4d 6f 62 69 63 6c 69 70 44 65 63 5f lip:MobiclipDec_
0004aa0: 31 5f 30 5f 31 5d 00 5b 53 44 4b 2b 4d 6f 62 69 1_0_1].[SDK+Mobi [SDK+Mobiclip:MoflexDemuxer_1_0_2]
0004ab0: 63 6c 69 70 3a 4d 6f 66 6c 65 78 44 65 6d 75 78 clip:MoflexDemux
0004ac0: 65 72 5f 31 5f 30 5f 32 5d 00 00 00 00 00 00 00 er_1_0_2].......
0004ad0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
0004ae0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................

==== Example dependency list from the extended header ====
00850 41 50 54 3A 55 00 00 00 24 68 69 6F 46 49 4F 00 APT:U...$hioFIO.
00860 24 68 6F 73 74 69 6F 30 24 68 6F 73 74 69 6F 31 $hostio0$hostio1
00870 61 63 3A 75 00 00 00 00 62 6F 73 73 3A 55 00 00 ac:u....boss:U..
00880 63 61 6D 3A 75 00 00 00 63 65 63 64 3A 75 00 00 cam:u...cecd:u..
00890 63 66 67 3A 75 00 00 00 64 6C 70 3A 46 4B 43 4C cfg:u...dlp:FKCL
008A0 64 6C 70 3A 53 52 56 52 64 73 70 3A 3A 44 53 50 dlp:SRVRdsp::DSP
008B0 66 72 64 3A 75 00 00 00 66 73 3A 55 53 45 52 00 frd:u...fs:USER.
008C0 67 73 70 3A 3A 47 70 75 68 69 64 3A 55 53 45 52 gsp::Gpuhid:USER
008D0 68 74 74 70 3A 43 00 00 6D 69 63 3A 75 00 00 00 http:C..mic:u...
008E0 6E 64 6D 3A 75 00 00 00 6E 65 77 73 3A 75 00 00 ndm:u...<nowiki>news:u..</nowiki>
008F0 6E 77 6D 3A 3A 55 44 53 70 74 6D 3A 75 00 00 00 nwm::UDSptm:u...
00900 70 78 69 3A 64 65 76 00 73 6F 63 3A 55 00 00 00 pxi:dev.soc:U...
00910 73 73 6C 3A 43 00 00 00 79 32 72 3A 75 00 00 00 ssl:C...y2r:u...
00920 69 72 3A 55 53 45 52 00 6C 64 72 3A 72 6F 00 00 ir:USER.ldr:ro..
00930 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
00940 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
00950 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
00960 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
... ...
009D0 FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
009E0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
009F0 00 03 00 00 00 00 00 00 00 00 00 00 00 00 00 02 . .............

=== Extended Header ===
See also: [https://github.com/3dshax/ctr/blob/master/ctrtool/exheader.h]

See [[NCCH/Extended Header|this]]

== Tools ==

[https://github.com/3dshax/ctr/tree/master/ctrtool ctrtool] - (CMD)(Windows/Linux) Parsing and decrypting(debug only) NCCH files

[[3DSExplorer]] - (GUI)(Windows Only) Parsing NCCH files

NCCH

2014-12-22T06:33:03Z

Idunoe: /* NCCH Flags */

[[Category:File formats]]
The following text tries to document the structure of the NCCH container format.

== Overview ==
There are two known NCCH container specialisations used on the 3DS, "executable" and "non-executable", officially known as CXI and CFA respectively.

== CXI ==

The CXI (CTR Executable Image) specialisation of the NCCH container, contains executable code, which runs on a single ARM11 core. It can communicate through SVC calls with the other ARM11 core running the 'system' program code. For reasons of clarity, the ARM11 cores will sometimes be called the 'appcore' and 'syscore' respectively.

The CXI format is structured in the following order:
* first a NCCH header,
* followed by an extended header,
* followed by an access descriptor,
* followed by an '''optional''' plain binary region,
* followed by an '''optional''' executable filesystem ([[ExeFS]]) - (contains ARM11 code, Home menu [[SMDH|icn]]/bnr and [[Logo|logo]]),
* and finally followed by an '''optional''' read-only filesystem ([[RomFS]]) - (Used for external file storage).

The extended header contains additional information regarding access control.
The plain binary region is an area specifically stored in plaintext, mostly containing SDK library strings for identification.

== CFA ==

The CFA (CTR File Archive) specialisation of the NCCH container, is not executable, but are used in conjunction with CXI files. For instance the DLP Child Container and the Electronic Manual. (There is a system update NCCH which follows this format, but is used by the 3DS rather than the Application NCCH, and only works when embedded in the [[CCI]] format because the nVer is kept in the header of retail [[CCI]] files instead of the application NCCH). There are CFA files which exist alone in a title, but these are just [[Title list|System Data Archive]] titles and are found only in the [[Flash Filesystem#CTR partition|NAND]].

CFA files are structured in the following order:
* first a NCCH header,
* followed by an '''optional''' executable filesystem ([[ExeFS]]) (same as in CXI, except no ARM11 code)
* followed by an '''optional''' read-only filesystem ([[RomFS]])

Non-Executable NCCH file examples(Includes Decrypted [[RomFS]]):

[https://dl.dropbox.com/u/60710927/CTR/Sample/DLP%20Child.7z DLPChild Container]
[https://dl.dropbox.com/u/60710927/CTR/Sample/Manual.7z Electronic Manual]

== NCCH Specs ==

=== Encryption ===
The extended header, the [[ExeFS]] and the [[RomFS]] are encrypted using 128-bit AES CTR. See here regarding the [https://github.com/3dshax/ctr/blob/master/ctrtool/ncch.c CTR].

By default encrypted regions are compressed(ExeFS:/.code only) with an LZ77 variant, then encrypted. The spec allows for both unencrypted and uncompressed regions to exist. Development units use a fixed system key for system titles. For the "Secure crypto" NCCH encryption mode(the encryption mode used for retail NCCH) the [[AES|keyY]] is the first 0x10-bytes of the NCCH signature, the AES engine internally generates the final-normal key(see [[AES|here]] for the keyslot).

As of [[7.0.0-13]] the system now supports a new encryption method for the secure-cryptotype, the CTR for this is the same as before. This is enabled when NCCH flag[3] is non-zero. When enabled, the [[RomFS]] and [[ExeFS]] files which don't have filenames "icon" or "banner"(that is, ".code") are crypted with a different keyslot. This keyslot is [[Savegames|initialized]] by the 6.0 gamecard savegame keyY init function during boot, using a different portion of the [[Savegames|final]] hash(this keyslot is separate from the one used for the 6.0 save crypto).

With New3DS [[9.3.0-21|9.3.0-X]] new NCCH crypto support was added, enabled via ncchflag[3]=0x0A. This is identical to the v7.0 crypto except with a New3DS-only keyslot.

=== Format ===

On retail for SD applications, exheader_systeminfoflags.flag bit1 must be set.

Retail CFAs use NCCH product code "CTR-P-CTAP", while retail title/gamecard CXIs use NCCH product code "CTR-P-XXXX". This product code is the NCCH [[Serials|serial code]]. The region-locking info checked by home menu is stored in the [[SMDH#BNR Region|icon]].

All of the hashes stored in this NCCH header are over the cleartext data. The ExeFS/RomFS superblock starts at offset 0x0 in the ExeFS/RomFS, and the size is specified by the hash region fields. Interestingly, Nintendo's NCCH validation code seems to have the size of this region fixed to 0x200 bytes (for ExeFS at least).

As of [[5.0.0-11]] the application [[ExeFS]]:/.logo can be loaded from the plaintext region between the access descriptor and the plain region, all applications built since [[5.0.0-11]] store the logo here. The size of this logo is always 0x2000-bytes.

The plain region mainly contains tags for each SDK library used when building the CXI. The version used for the "FIRMWARE" tag is the kernel/FIRM [[Configuration_Memory|version]], this version can also be stored in the exheader "kernel release version" ARM11 kernel descriptor field. As of [[2.2.0-X]] the NATIVE_FIRM kernels check the CXI exheader "kernel release version" field, if it is stored in the CXI exheader. If the kernel/FIRM version specified by this field is higher than the version of the running NATIVE_FIRM, the kernel will return error-code 0xD9001413.

=== NCCH Header ===
{| class="wikitable" border="1"
|-
! OFFSET
! SIZE
! DESCRIPTION
|-
| 0x000
| 0x100
| RSA-2048 signature of the NCCH header, using SHA-256.
|-
| 0x100
| 4
| Magic ID, always 'NCCH'
|-
| 0x104
| 4
| Content size, in media units (1 media unit = 0x200 bytes)
|-
| 0x108
| 8
| Partition ID
|-
| 0x110
| 2
| Maker code
|-
| 0x112
| 2
| Version
|-
| 0x114
| 4
| Reserved
|-
| 0x118
| 8
| Program ID
|-
| 0x120
| 0x10
| Reserved
|-
| 0x130
| 0x20
| Logo Region SHA-256 hash. (For applications built with SDK 5+) (Supported from firmware: [[5.0.0-11]])
|-
| 0x150
| 0x10
| Product code
|-
| 0x160
| 0x20
| Extended header SHA-256 hash (SHA256 of 2x Alignment Size, beginning at 0x0 of ExHeader)
|-
| 0x180
| 4
| Extended header size
|-
| 0x184
| 4
| Reserved
|-
| 0x188
| 8
| Flags (See Below)
|-
| 0x190
| 4
| Plain region offset, in media units
|-
| 0x194
| 4
| Plain region size, in media units
|-
| 0x198
| 4
| Logo Region offset, in media units (For applications built with SDK 5+) (Supported from firmware: [[5.0.0-11]])
|-
| 0x19c
| 4
| Logo Region size, in media units (For applications built with SDK 5+) (Supported from firmware: [[5.0.0-11]])
|-
| 0x1A0
| 4
| ExeFS offset, in media units
|-
| 0x1A4
| 4
| ExeFS size, in media units
|-
| 0x1A8
| 4
| ExeFS hash region size, in media units
|-
| 0x1AC
| 4
| Reserved
|-
| 0x1B0
| 4
| RomFS offset, in media units
|-
| 0x1B4
| 4
| RomFS size, in media units
|-
| 0x1B8
| 4
| RomFS hash region size, in media units
|-
| 0x1BC
| 4
| Reserved
|-
| 0x1C0
| 0x20
| ExeFS superblock SHA-256 hash - (SHA-256 hash, starting at 0x0 of the ExeFS over the number of media units specified in the ExeFS hash region size)
|-
| 0x1E0
| 0x20
| RomFS superblock SHA-256 hash - (SHA-256 hash, starting at 0x0 of the RomFS over the number of media units specified in the RomFS hash region size)
|}

=== NCCH Flags ===
{| class="wikitable" border="1"
|-
! INDEX
! DESCRIPTION
|-
| 3
| Crypto Method: When this is non-zero, a NCCH crypto method using two keyslots is used(see above). v7.0 keyslot(Old3DS/New3DS) = 0x01, v9.3 keyslot(New3DS only) = 0x0A.
|-
| 4
| Content Platform: 1 = CTR.
|-
| 5
| Content Type Bit-masks: Data = 0x1, Executable = 0x2, SystemUpdate = 0x4, Manual = 0x8, Child = (0x4<nowiki>|</nowiki>0x8), Trial = 0x10. When 'Data' is set, but not 'Executable', NCCH is a CFA. Otherwise when 'Executable' is set, NCCH is a CXI.
|-
| 6
| Content Unit Size i.e. u32 ContentUnitSize = 0x200*2^flags[6];
|-
| 7
| Bit-masks: FixedCryptoKey = 0x1, NoMountRomFs = 0x2, NoCrypto = 0x4
|}
CXIs NCCH header signature is verified using the RSA public key stored in the accessdesc,(which follows the exheader) while CFAs NCCH header is verified with a fixed RSA public key.

==== NCCH header example for Lego Starwars III ====
Signature: 720FF8F83F2A1E998322A026D1434165
ED19642ABC1CB2722135AA202BEAD60A
80BCD21C768C597B8268FEF2C64EA710
4C9BA5E12CFFBD1D0C619F4EF7B42CA7
DD8482CB4EB26720AD66CDA57ABCBCFB
D63268A6E2896A59B3B744E39E45B88A
ABB4C0980ACC6210818DCE6DAC838A10
95D0F66B352474D4B3DA4B333F49912D
29AF7EA58BC8C890B18C70B7D540A9FB
EBE24A5312055617D3353B28C3EB1D17
61021BEFF6AD22C384835B40BD44DFAD
981F6350F9458B17BCB5F768C92ABC93
2BCE9888855A8998F4CDE40C9543514A
C57B84EB75A680E7C742632614620D1D
A253284DF3DC01091EB3800C36FD62EE
BA15340F1FD498FAB67C0302E9CDA397
Magic: NCCH
Content size: 0x1cfef400
Partition id: 0004000000038c00
Maker code: 3436 ("46")
Version: 0002
Program id: 0004000000038c00
Temp flag: 00
Product code: CTR-P-ALGP
Extended header hash: 0C27E3C1DE7B2AE2D3114F32A4EEBF46
9AFD0CF352C11D4984C2A9F1D2144C63
Extended header size: 00000400
Flags: 0000030100000000
Plain region offset: 0x00004a00
Plain region size: 0x00000200
ExeFS offset: 0x00004c00
ExeFS size: 0x00143800
ExeFS hash region size: 0x00000200
RomFS offset: 0x00148400
RomFS size: 0x1ceab000
RomFS hash region size: 0x00000200
ExeFS Superblock Hash: 130C042615F647C4C63225EA9E67F8A2
7B15246B88FBC7A927257B84977B787B
RomFS Superblock Hash: A65BEE1060BB6A6821BBCEC600035B7E
64FB6EACA7F0960CFB1F5A37087728F7
Note: Offsets and sizes in media units have been converted to byte sizes.

==== Plain region example for Lego Starwars III ====
0004a00: 5b 53 44 4b 2b 4e 49 4e 54 45 4e 44 4f 3a 43 54 [SDK+NINTENDO:CT [SDK+NINTENDO:CTR_SDK-0_14_23_200_none]
0004a10: 52 5f 53 44 4b 2d 30 5f 31 34 5f 32 33 5f 32 30 R_SDK-0_14_23_20
0004a20: 30 5f 6e 6f 6e 65 5d 00 5b 53 44 4b 2b 4e 49 4e 0_none].[SDK+NIN [SDK+NINTENDO:Firmware-02_27]
0004a30: 54 45 4e 44 4f 3a 46 69 72 6d 77 61 72 65 2d 30 TENDO:Firmware-0
0004a40: 32 5f 32 37 5d 00 5b 53 44 4b 2b 4d 6f 62 69 63 2_27].[SDK+Mobic [SDK+Mobiclip:Deblocker_1_0_2]
0004a50: 6c 69 70 3a 44 65 62 6c 6f 63 6b 65 72 5f 31 5f lip:Deblocker_1_
0004a60: 30 5f 32 5d 00 5b 53 44 4b 2b 4d 6f 62 69 63 6c 0_2].[SDK+Mobicl [SDK+Mobiclip:ImaAdpcmDec_1_0_0]
0004a70: 69 70 3a 49 6d 61 41 64 70 63 6d 44 65 63 5f 31 ip:ImaAdpcmDec_1
0004a80: 5f 30 5f 30 5d 00 5b 53 44 4b 2b 4d 6f 62 69 63 _0_0].[SDK+Mobic [SDK+Mobiclip:MobiclipDec_1_0_1]
0004a90: 6c 69 70 3a 4d 6f 62 69 63 6c 69 70 44 65 63 5f lip:MobiclipDec_
0004aa0: 31 5f 30 5f 31 5d 00 5b 53 44 4b 2b 4d 6f 62 69 1_0_1].[SDK+Mobi [SDK+Mobiclip:MoflexDemuxer_1_0_2]
0004ab0: 63 6c 69 70 3a 4d 6f 66 6c 65 78 44 65 6d 75 78 clip:MoflexDemux
0004ac0: 65 72 5f 31 5f 30 5f 32 5d 00 00 00 00 00 00 00 er_1_0_2].......
0004ad0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
0004ae0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................

==== Example dependency list from the extended header ====
00850 41 50 54 3A 55 00 00 00 24 68 69 6F 46 49 4F 00 APT:U...$hioFIO.
00860 24 68 6F 73 74 69 6F 30 24 68 6F 73 74 69 6F 31 $hostio0$hostio1
00870 61 63 3A 75 00 00 00 00 62 6F 73 73 3A 55 00 00 ac:u....boss:U..
00880 63 61 6D 3A 75 00 00 00 63 65 63 64 3A 75 00 00 cam:u...cecd:u..
00890 63 66 67 3A 75 00 00 00 64 6C 70 3A 46 4B 43 4C cfg:u...dlp:FKCL
008A0 64 6C 70 3A 53 52 56 52 64 73 70 3A 3A 44 53 50 dlp:SRVRdsp::DSP
008B0 66 72 64 3A 75 00 00 00 66 73 3A 55 53 45 52 00 frd:u...fs:USER.
008C0 67 73 70 3A 3A 47 70 75 68 69 64 3A 55 53 45 52 gsp::Gpuhid:USER
008D0 68 74 74 70 3A 43 00 00 6D 69 63 3A 75 00 00 00 http:C..mic:u...
008E0 6E 64 6D 3A 75 00 00 00 6E 65 77 73 3A 75 00 00 ndm:u...<nowiki>news:u..</nowiki>
008F0 6E 77 6D 3A 3A 55 44 53 70 74 6D 3A 75 00 00 00 nwm::UDSptm:u...
00900 70 78 69 3A 64 65 76 00 73 6F 63 3A 55 00 00 00 pxi:dev.soc:U...
00910 73 73 6C 3A 43 00 00 00 79 32 72 3A 75 00 00 00 ssl:C...y2r:u...
00920 69 72 3A 55 53 45 52 00 6C 64 72 3A 72 6F 00 00 ir:USER.ldr:ro..
00930 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
00940 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
00950 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
00960 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
... ...
009D0 FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
009E0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
009F0 00 03 00 00 00 00 00 00 00 00 00 00 00 00 00 02 . .............

=== Extended Header ===
See also: [https://github.com/3dshax/ctr/blob/master/ctrtool/exheader.h]

See [[NCCH/Extended Header|this]]

== Tools ==

[https://github.com/3dshax/ctr/tree/master/ctrtool ctrtool] - (CMD)(Windows/Linux) Parsing and decrypting(debug only) NCCH files

[[3DSExplorer]] - (GUI)(Windows Only) Parsing NCCH files

Home Menu

2014-12-09T02:16:53Z

Idunoe: /* System Versions List */

The '''Home Menu''' is the heart of the Nintendo 3DS. From there one can start games, applications, and access various processes including the friends list. It is launched by [[NS]], and is always running in the background in 3DS-mode except when other programID-high 00040030 applications like Internet Browser, Friend-List, etc are running. Home Menu is still running while [[System Settings]] is running, however the System Settings application does not allow directly returning to home-menu. The system will normally re-launch Home Menu when the Home Menu process crashes/terminates. When this re-launch occurs while Home Menu is active, Home Menu displays an error message which says to manually reboot the system.

== System Versions ==
Nintendo devised a system, whereby updates would be delivered via two channels:
*Card Updates (CUP) - The Nintendo 3DS is updated with data from an [[System Update CFA|update partition]] on retail gamecard title.
*Network Updates (NUP) - The Nintendo 3DS is updated by downloading data from Nintendo's [[Title list|CDN]].

CUPs will only deliver updates to core features, such as the Home Menu, [[Nintendo 3DS Camera]] etc. CUPs will not deliver updates to Network features, such as [[System Transfer]], [[Internet Browser]], [[StreetPass Mii Plaza]] or [[EShop|eShop]].

NUPs can deliver updates to core features as well as (updated) Network Features.

As a result of deciding to make a distinction between what content could be updated and how, Nintendo split the system version displayed by [[System Settings]] into two parts: [[CVer]] (Console Version) and [[NVer]] (Network Update Version). Represented as:
<CVer Major>.<CVer Minor>.<CVer Micro>-<NUP Version><NUP Region>

The Console Version represents the version of the collectively installed core features. And the NUP Version represents the version of the collectively installed network features.

So if a 3DS' System Firmware read '''2.1.0-2U''', it would indicate a console version of '''2.1.0''' and a NUP version of '''2U'''.

NOTES:
* CUPs can only update core content, so [[NVer]] is never updated with CUPs.
* NUPs will not update [[NVer]] if network features are not updated. (Best seen with the USA vs JPN/EUR 6.0.0 NUP)

CUPs are implemented by adding a [[System Update CFA]] to retail NCSD gamecard images. Nintendo generally creates CUPs after NUPs are released.

When updating the system from 4.5.0-6 to 4.5.0-10, the following titles are updated(in the order of title download+install): [[Health and Safety Information]], [[Nintendo 3DS Camera]], [[eShop]], [[System Transfer]], [[Internet Browser]], [[Title_list|0004009B00014102]], [[Title_list|0004009B00014202]], [[Title_list|0004009B00014302]], [[NVer]], and [[FIRM|AGB_FIRM]].

=== System Versions List ===
{| class="wikitable"
|-
! System version
! Home Menu title version
! Release date
! Changelog
! System security [[3DS_exploits|flaws]] fixed*
! 3DS-mode homebrew affected*
! CUP Released
! CDN Availability
! CDN Post Date
|-
| [[1.0.0-0|1.0.0-0]]
| 0
| February 26, 2011
| Shipped with 3DS on launch
|
|
| Yes
| Available
| February 18, 2011
|-
| [[1.1.0-1|1.1.0-1]]
| 0
| February ?, 2011
| General bug fixes
Added 3D Video title to menu. ("For a Limited Time Only")
|
|
| Yes
| Available
| March 1, 2011
|-
| [[2.0.0-2|2.0.0-2]]
| 1029
| June 6/7, 2011
| [[eShop]] added, web browser available, [[System Transfer]] added. Full DSiWare data management available. [[Automatic_System_Update_Download|Automatic]] downloading for system updates added.
|
|
| No
| Available
| June 6, 2011
|-
| [[2.1.0-3|2.1.0-3]]
| 2049
| June 15, 2011
| Fixes the Ridge Racer freeze.
|
|
| Yes
| Available
| June 15, 2011
|-
| [[2.1.0-4|2.1.0-4]]
| Not updated
| July 25, 2011
| System stability improvements and other adjustments.
|
|
| No
| Available
| July 25, 2011
|-
| [[2.2.0-X|2.2.0]]
| ?
| November 6, 2011
| CUP Only Release. Improved the arrangement of [[Friend List]]. Update from some game cards such as Super Mario 3D Land.
|
|
| Yes
| Unavailable
| ?
|-
| [[3.0.0-5|3.0.0-5]]
| 4111
| December 7, 2011
| Added 3D video recording to the camera title, updated Mii Streetpass Plaza, [[System Transfer]] between 3DS systems available, improved eShop, home menu QR code scanning with QR codes containing URLs. [[Nintendo Zone]] is now always accessible, 3D video streaming support was added to NZone. This added support for running GBA VC titles via AGB_FIRM as well, support for GBA VC titles was also added to NATIVE_FIRM.
|
|
| Yes
| Available
| December 7, 2011
|-
| [[3.0.0-6|3.0.0-6]]
| Not updated
| December 21, 2011
| Only StreetPass Mii Plaza and the [[NVer]] title were updated. From Nintendo's release notes: "System stability improvements and other adjustments".
|
|
| No
| Available
| December 21, 2011
|-
| [[4.0.0-7|4.0.0-7]]
| 5131
| April 24, 2012
| Add folders to Home Menu, game patching added, buy more expensive games than 1000 yen in JPN. System titles for CHN, TWN, and KOR became available.
| Yes
|
| Yes
| Available
| April 24, 2012
|-
| [[4.1.0-8|4.1.0-8]]
| Not updated
| May 14, 2012
| From changelog: "improvements to overall system stability and other minor adjustments". Once updated to [[4.1.0-8]], the parental-controls PIN is no longer required for future system updates.
| Yes
|
| Yes
| Available
| May 14, 2012
|-
| [[4.2.0-9|4.2.0-9]]
| 6146
| June 26, 2012
| Improved eShop safety for entering credit-card info, and behind the scenes improvements. Stored CC info will be deleted by this updated eShop, and can be re-entered again.
|
|
| Yes
| Available
| June 26, 2012
|-
| [[4.3.0-10|4.3.0-10]]
| Not updated
| July 24, 2012
| Updated eShop, bad word list and NZone hotspot list updated.
|
|
| Yes
| Available
| July 24, 2012
|-
| [[4.4.0-10|4.4.0-10]]
| Not updated
| September 19, 2012
| NZone hotspot list updated and TWL_FIRM updated for blocking flash cards.
|
|
| Yes
| Available
| September 19, 2012
|-
| [[4.4.0-10|4.4.0-10C]]
| Not updated
| October 17, 2012
| China-only, the *only* updated title was [[System Settings]]. This title was updated to a version already available in TWN/KOR.
|
|
| ?
| Available
| October 17, 2012
|-
| [[4.5.0-10|4.5.0-10]]
| Not updated
| December 4, 2012
| Flash-card block via updated TWL_FIRM and whitelist. NZone hotspot list updated as well.
|
|
| Yes
| Available
| December 4, 2012
|-
| [[5.0.0-11|5.0.0-11]]
| 7172
| March 25, 2013
| Many system titles including NATIVE_FIRM were updated, multiple vulnerabilities were fixed as well.
| Yes
| Yes
| No
| Available
| March 25, 2013
|-
| [[5.1.0-11|5.1.0-11]]
| Not updated
| April 4, 2013
| NATIVE_FIRM and NS were updated. According to the official change-log: "Resolves an issue that may prevent access to the System Settings or other features."
| No
| No
| Yes
| Available
| April 4, 2013
|-
| [[6.0.0-11|6.0.0-12 (-11U)]]
| 8198
| June 17, 2013
| Official change-log: "Users can now back up save data for downloadable versions of Nintendo 3DS software and most Virtual Console games". For EUR/JPN, the [[StreetPass Mii Plaza]] application and the [[Nintendo 3DS Camera]] application were updated. Other titles for all regions were updated as well.
| Yes
|
| No
| Available
| June 17, 2013
|-
| [[6.1.0-11|6.1.0-12 (-11U)]]
| Not updated
| June 27, 2013
| Official change-log: "Further improvements to overall system stability and other minor adjustments have been made to enhance the user experience."
|
|
| Yes
| Available
| June 27, 2013
|-
| [[6.1.0-12U]]
| Not updated
| July 11, 2013
| This USA-only update added the updated network features applications which were first released in JPN/EUR with the [[6.0.0-11|6.0.0-12 NUP]] update.
|
|
| No
| Available
| July 11, 2013
|-
| [[6.2.0-12]]
| Not updated
| August 6, 2013
| This update added support for the StreetPass relay feature, updated TWL_FIRM, and updated the Nintendo Zone hotspots list.
|
|
| Yes
| Available
| August 6, 2013
|-
| [[6.3.0-12]]
| Not updated
| September 13, 2013
| See [[6.3.0-12|this]].
| No
| No
| No
| Available
| September 13, 2013
|-
| [[6.4.0-12]]
| ?
| November 11, 2013
| See [[6.4.0-12|this]](Only for the KOR and TWN regions).
|
|
| No
| Available
| November 11, 2013
|-
| [[7.0.0-13]]
| 9230
| December 9, 2013
| See [[7.0.0-13|this]].
| Yes
|
| No
| Available
| December 9, 2013
|-
| [[7.1.0-14]]
| Not updated
| December 19, 2013
| See [[7.1.0-14|this]].
| No
|
| Yes
| Available
| December 19, 2013
|-
| [[7.1.0-15]]
| Not updated
| January 22, 2014
| See [[7.1.0-15|this]].
| No
| No
| No
| Available
| January 22, 2014
|-
| [[7.1.0-16]]
| Not updated
| February 26, 2014
| See [[7.1.0-16|this]].
| No
| No
| No
| Available
| February 26, 2014
|-
| [[7.2.0-17]]
| Not updated
| May 12, 2014
| See [[7.2.0-17|this]].
|
| No
| Yes
| Available
| May 12, 2014
|-
| [[8.0.0-18]]
| Not updated
| July 7, 2014
| See [[8.0.0-18|this]].
| No
| No
| Yes
| Available
| July 7, 2014
|-
| [[8.1.0-18]]
| Not updated
| July 24, 2014
| See [[8.1.0-18|this]].
| No
| No
| Yes
| Available
| July 24, 2014
|-
| [[8.1.0-19]]
| Not updated
| August 7, 2014
| See [[8.1.0-19|this]].
| No
| No
| No
| Available
| August 7, 2014
|-
| [[8.1.0-0 New3DS]]
| Not updated
| September 26, 2014
| See [[8.1.0-0 New3DS|this]].
|
| No
| No
| Available
| September 26, 2014
|-
| 8.1.0-19
| Not updated
| October 2, 2014
| Japan-only "update", see [http://yls8.mtheall.com/ninupdates/reports.php?date=10-02-14_02-05-03&sys=ctr here]. The only change was that a new title([[New_3DS]]-only system application) was added, CVer/NVer titles were not even updated. The initial version of this [[Title_list|title]] is a stub.
| No
| No
| No
| Available
| October 2, 2014
|-
| [[9.0.0-20]]
| v11272
| October 6, 2014
| See [[9.0.0-20|this]].
|
| No
| No
| Available
| October 6, 2014
|-
| [[9.1.0-20J]]
| v14336(JPN-region title)
| October 10, 2014
| Japan-only, see [[9.1.0-20J|this]].
| No
| No
| No
| Available
| October 10, 2014
|-
| [[9.2.0-20]]
|
| October 29, 2014
| See [[9.2.0-20|this]].
| No
| No
| No
| Available
| October 29, 2014
|-
| [[9.3.0-21]]
|
| December 8, 2014
| See [[9.3.0-21|this]].
| Yes
| Yes
| No
| Available
| December 8, 2014
|}

"System security [[3DS_exploits|flaws]] fixed*": This includes known flaws, and any fixed flaws discovered via code bin-diff. This does not include ARM11-userland ROP entrypoints unless specifically mentioned otherwise on the system-update page.

"System security [[3DS_exploits|flaws]] fixed*" and "3DS-mode homebrew affected" only apply to the changes done with that specific system-update.

[[Category:Nintendo Software]]

== Auto-Boot Function ==
When the Home Menu is initially loaded by [[NS]], it checks the gamecard ExeFS:/[[SMDH|icon]] for the auto-boot flag. If the auto-boot flag is set, it will load the application on the cartridge and the home menu will not remain running in the background, or at least not in an operational state. Using software cues to return to the home menu, or sleep menu while in this state, causes a shutdown.

Notable features of demo titles:
*Auto-boot demos generally disable the functionality of the home button.
*The ''New Super Mario Bros 2'' demo, retained the functionality of the home button, and had an timer which triggered the demo to quit after a period of inactivity.

Auto-boot cartridges, can bypass some of the functions of the Home Menu. Auto Booted software:
* Doesn't show usage history in the [[Activity Log]]
* Bypasses Parental controls
* Bypasses Forced Game Card Updates
* Bypasses Initial 3DS Setup
* The console does not have a friends list presence.
* Is still subject to region lock(see below).

Region lock is still active, so the home menu will refuse to launch demos with incorrect region lock will not load, displaying "An Error has Occurred". However, game card update partition checks are not done, which allows launching demos that have region free encoding, but have an alternate(or even invalid) region update partition.

The following auto-boot paths can be used by Home Menu, checked in the same order listed below(the above gamecard auto-boot is checked before this):
{| class="wikitable"
! Key-combo / requirements for this path
! Description
|-
| R, L, and X
| This launches [[System Settings]] for touchscreen calibration.
|-
| R, L, and Y
| This launches [[System Settings]] for circlepad calibration.
|}

The following is only checked when the low u16 from [[Config_Savegame|config]] block 0x00110000 is value zero(normally this is non-zero). Thus, the below is only handled when a system setup is required.
{| class="wikitable"
! Key-combo / requirements for this path
! Description
|-
| R, X, Y, A, and B, a 3DS gamecard must be inserted as well.
| This launches the gamecard application. Note that pressing the HOME button in the gamecard application launched this way will only result in the system shutting down.
|-
| This is used when the above path isn't used.
| This launches System Settings for the system setup.
|}

== Region Lockout ==

One of the Home Menu's functions, is to regulate region lockout. The region lockout data for any given title is held in the [[SMDH#BNR Region|ICN data]]. There are 6 regions of which have their own region lockout, Japan, USA, Europe(including Nintendo Australia), China, Taiwan and Korea. There is also a value which makes a title exempt from region lockout, and consequently accessible from any region of 3DS.

The region-field stored in the [[SMDH|ICN-data]] is only checked when Home Menu itself launches a title, not when other titles use NS to have Home Menu launch titles. This isn't actually useful for gamecard region-free however, due to the gamecard system-updates, see below.

Also note that while some gamecard games are mostly region-free(main CXI is identical for all regions of the gamecard), those gamecards can't actually be launched with all 3DS regions due to the gamecard system-update, see below. Note that the main CXI being identical for all regions of a gamecard also means the savedata keyY is identical for all regions of that gamecard too(except for old system-version <v2.2 games, in some cases, due to different cardIDs).

=== Effects of Region Lockout ===
Every 3DS title regardless of location (NAND/SD Card/Game Card) is subject to region lockout scrutiny by the Home Menu. And the home menu treats 'out-of-region' titles by simply refusing to show them on the home menu. No messages are shown on the home menu to notify the user, the title is simply ignored. However out-of-region SD Card titles, will appear and quickly disappear, while all the SD Titles are being processed. In cases where access to the home menu GUI is not needed to launch the title (like in the case of kiosk demos), the home menu states an error has occurred, and launching of the title is stopped.

=== Game Card Updates ===
Either intentionally a region lock mechanism or not, the function which checks the game card update partition returns an error when it is detected the update is for a region other than the 3DS's region (Most likely triggered by the absence of the correct CVer title). And errors returned from checking the update partition, will result in the home menu displaying "This Game Card cannnot be used", when the user attempts to launch the title.

== Home-menu [[SpotPass]] usage ==

Home-menu uses two domains with HTTPS for SpotPass. SpotPass stores this content in Home-menu's NAND shared extdata.

* The system notifications are downloaded from: https://a248.e.akamai.net/f/248/103046/10m/npdl.c.app.nintendowifi.net/p01/nsa/<regionID>/<filename>/<langcode>/<filename> Where langcode is the two-character language codes from [[Config_Savegame|config]], and regionID is from the below table. <filename> is bashoX/sysmsgX where X is 0-3.
* https://pls.c.shop.nintendowifi.net/pl/upload This URL is used for uploading data from the home menu NAND shared extdata, it's unknown what this is used for. This data is uploaded every 24 hours.
* https://npul.c.app.nintendowifi.net/p01/recv/<regionID>/<filename> This is used for uploading unknown data from extdata. <filename> can be "phu", "tiu", "splu", or "sendmgn".

{| class="wikitable"
|-
! Region
! ID
|-
| JPN
| gWr4JXxb2mKTG3lq
|-
| NA
| uuI82221UKkqmtbp
|-
| EUR / Others
| UrXSeurnxhPrq7AS
|}

The SpotPass content payload for notifications begin with a header, followed by an [[SMDH|icon]] and the UTF-16 text, and various metadata.

== Automatic System Update Download ==
See [[Automatic System Update Download]].

== Home Menu Error Messages ==
{| class="wikitable"
|-
! Dialog Text
! Description
|-
| "An error has occured. Please save your data ... then restart the system"
| This dialog is displayed when a system process(including Home Menu) crashes/terminates. This dialog is also displayed for system errors as well.
|}

== Home Menu Themes ==
See [[Home_Menu/Themes|here]].

== SD ExtData ==
The SD ExtData [[Extdata#Filesystem|File System]] for Home Menu is as follows:

root
├── icon
├── boss
└── user
├── SaveData.dat
├── Cache.dat
└── CacheD.dat

{| class="wikitable" border="1"
|-
! File
! Details
! Size
! FW Introduced
! Plaintext
|-
| icon
| Stubbed. Always image 00000002.
| 0x4 Bytes
| n/a
|
|-
| SaveData.dat
| Always image 00000003.
| 0x2cb0 Bytes
| [[1.0.0-0]]
| [https://dl.dropboxusercontent.com/u/60710927/CTR/Sample/HomeMenuExtdata/SaveData.dat Download]
|-
| Cache.dat
| Indexes and records details for the cached icon data. Always image 00000004.
| 0x1688 Bytes
| [[1.0.0-0]]
| [https://dl.dropboxusercontent.com/u/60710927/CTR/Sample/HomeMenuExtdata/Cache.dat Download]
|-
| CacheD.dat
| Cached icon data for Home Menu. Always image 00000005.
| 0x4cfe00 Bytes
| [[1.0.0-0]]
| [https://dl.dropboxusercontent.com/u/60710927/CTR/Sample/HomeMenuExtdata/CacheD.dat Download]
|}

=== Cache.dat & CacheD.dat ===
These two files work in tandem to allow the home menu to cache icon data for applications which are presented on the Home Menu. The size of both files suggests a maximum cache size of 360 icons. Cache.dat stores details about the cache icon data, and CacheD.dat stores the icon data. The icon cache stores icon data for *all* applications shown on the Home Menu, this includes DSi NAND Titles, and DS(i) cartridges. The format of cached DS(i) icon data is not understood, but they are the same size as 3DS icon data (0x36c0).

In Cache.dat the first 8 bytes are reserved, then follows each icon slots's entry in the format:
{| class="wikitable" border="1"
|-
! OFFSET
! SIZE
! DESCRIPTION
|-
| 0x0
| 8
| Title ID in Little Endian
|-
| 0x8
| 4
| Unknown
|-
| 0xc
| 4
| Unknown
|}

All unused entries have the Title IDs filled with "0xff".

In CacheD.dat, the icon data is concatenated together, with the first icon at offset 0x0.

== See Also ==
* http://www.nintendo.com/consumer/systems/3ds/en_na/menu_update.jsp
* http://www.nintendo.co.jp/netinfo/3ds/JPN/ja.html
* http://yls8.mtheall.com/ninupdates/reports.php

Title Database

2014-11-29T15:45:27Z

Idunoe: The tickets in ticket.db are not encrypted.

These files contain data relating to install/usage/management of installed 3DS titles. The database files are located at:

* nand/dbs
* sdmc/Nintendo 3DS/<ID0>/<ID1>/dbs

ID0 is the first 0x10-bytes from a SHA256 [[nand/private/movable.sed|hash]]. The installation of [[SD Filesystem|SD Card]] titles was introduced in the [[2.0.0-2]] update and the SD dbs files are encrypted. These files are [[extdata]] images. The NAND extdata images are cleartext, however some of the images contain data encrypted with a console-unique keyslot.

These files are only created on SD(via [[Application_Manager_Services|AM]]) if they don't exist when the [[eShop]] application is starting up, during network init etc(prior to showing the "system update required" dialog).

These files are stored under this directory:
{| class="wikitable" border="1"
|-
! Stored on SD card
! Stored in CTR-NAND
! Filename
! [[Savegames#AES_MAC_header|CTR-9DB0]] ID
! Description
|-
| No
| Yes
| ticket.db
| 0x0
| This contains the installed tickets(NAND and SD).
|-
| No
| Yes
| certs.db
| 0x1
| This contains the certificate chain used to verify TMDs and other certificates.
|-
| Yes
| Yes
| title.db
| 0x2
| Title database, this contains entries for all installed titles (TWL & CTR) on the 3DS(Each database is responsible for titles installed on its medium).
|-
| Yes
| Yes
| import.db
| 0x3
| This is an Import Database, it contains entries for titles(or versions of titles) not yet installed, ready for transferring to the title.db. (Automatic Update uses this, so completing the update takes seconds)
|-
| No
| Yes
| tmp_t.db
| 0x4
| This is the temporary Title database containing one entry for the currently installed [[Download Play]] Child.
|-
| No
| Yes
| tmp_i.db
| 0x5
| Similar to import.db, except it's used in conjunction with tmp_t.db, for installing [[Download Play]] Children.
|}

The SD dbs images use the same [[nand/private/movable.sed|keyslot]] as the other SD/NAND savedata images for the AES-MAC. The NAND dbs images for the AES-MAC use a console-unique keyslot where the keyX and keyY for it are initialized by bootrom.

The *.db [[extdata|Extdata]] images do not use a DATA partition, so there are two versions of the database in the image, an active and old version (the active one is defined by the DIFF header). These database files consist of a pre-header with size of 0x80 identifying the Database Type, followed by a BDRI container. The offsets in the BDRI header are usually relative to the offset to the start of the BDRI header (0x80 in the file)

== Pre Header ==

{| class="wikitable"
|-
! Start
! Length
! Description
|-
| 0x00
| 8
| Database Type "Magic" (see below)
|-
| 0x08
| 0x78
| Reserved
|}

=== Database Magic ===

{| class="wikitable"
|-
! Database Type
! Magic
|-
| CTR-NAND import.db
| NANDIDB
|-
| CTR-NAND title.db
| NANDTDB
|-
| CTR-NAND tmp_i.db
| TEMPIDB
|-
| CTR-NAND tmp_t.db
| TEMPIDB
|-
| SD Card import.db
| TEMPTDB
|-
| SD Card title.db
| TEMPTDB
|}

== BDRI ==

Information stored about titles in these Title Database files are stored in two parts in a BDRI partition. Firstly in a Title Entry Table, and secondly in a Title Info Table.

{| class="wikitable"
|-
! Start
! Length
! Description
|-
| 0x0
| 4
| Database Magic ("BDRI")
|-
| 0x4
| 4
| Magic Number (0x30000)
|-
| 0x8
| 8
| Unknown
|-
| 0x10
| 8
| File Size(including pre header), divided by the value at relative offset 0x18 (usually = 0x80)
|-
| 0x18
| 4
| Usually 0x80
|-
| 0x1C
| 4
| Reserved
|-
| 0x20
| 0x20
| Unknown/Constant
|-
| 0x40
| 0x18
| Unknown
|-
| 0x58
| 8
| Relative Title Entry Table Offset
|-
| 0x60
| 0x20
| Unknown
|}

== Title Entry Table ==

This contains 'Entries' for all the titles stored in the database. However this just appears to be an indexing table, the majority of title information is kept in a Title Info Table, which these index entries point to. Title Entries start immediately after the Title Entry Table Header. And there is no padding between entries.

=== Header ===

{| class="wikitable"
|-
! Start
! Length
! Description
|-
| 0x0
| 4
| Unknown/Magic? (usually = 0x2)
|-
| 0x4
| 4
| Unknown/Magic? (usually = 0x3)
|-
| 0x8
| 0x24
| Reserved
|-
| 0x2C
| 4
| Number of used Title Entries
|-
| 0x30
| 0x50
| Reserved
|-
| 0x80
| 4
| MAX Number of Title Entries
|-
| 0x84
| 4
| Unknown
|-
| 0x88
| 0x20
| Reserved
|}

=== Title Entry Format ===

The entries are 0x2C bytes long.

{| class="wikitable"
|-
! Start
! Length
! Description
|-
| 0x0
| 4
| Unknown
|-
| 0x4
| 4
| Active Flag. If this isn't = 0x1, then this entry slot is unused
|-
| 0x8
| 0x8
| Title ID
|-
| 0x10
| 4
| Title Entry Index
|-
| 0x14
| 4
| Relative Title Info Offset, divided by the value at offset 0x18 in this Title Entry (usually 0x80)
|-
| 0x18
| 0x4
| Usually 0x80
|-
| 0x1c
| 4
| Reserved
|-
| 0x20
| 4
| Unknown, occasionally this value is the title's "Title ID lower"
|-
| 0x24
| 0x4
| Unknown
|-
| 0x28
| 0x4
| Unknown
|}

* The actual Title Info offset is calculated by the following: Offset of BDRI Header + Relative Offset of Title Entry Table + Relative Title Info Offset

== Title Info Table ==

These consist of 0x80 byte long entries, pointed to by the title index entries. They contain information taken from both the application NCCH file(s) and TMD.

{| class="wikitable"
|-
! Start
! Length
! Description
|-
| 0x0
| 8
| Title Size
|-
| 0x8
| 4
| Title Type(usually 0x40)
|-
| 0xC
| 4
| Title Version
|-
| 0x10
| 4
| Flags_0
|-
| 0x14
| 4
| TMD Content ID
|-
| 0x18
| 4
| CMD Content ID
|-
| 0x1c
| 4
| Flags_1
|-
| 0x20
| 4
| ExtdataID low (zero if title doesn't use Extdata)
|-
| 0x24
| 4
| Reserved
|-
| 0x28
| 8
| Flags_2
|-
| 0x30
| 0x10
| Product Code
|-
| 0x40
| 0x10
| Reserved
|-
| 0x50
| 0x4
| Unknown
|-
| 0x54
| 0x2c
| Reserved
|}

==== Flags_0 ====

{| class="wikitable"
|-
! Index
! Description
|-
| 0
| Electronic Manual
|-
| 1
| ?
|-
| 2
| ?
|-
| 3
| ?
|}

==== Flags_1 ====

{| class="wikitable"
|-
! Index
! Description
|-
| 0
| SD Save Data
|-
| 1
| ?
|-
| 2
| ?
|-
| 3
| ?
|}

==== Flags_2 ====

{| class="wikitable"
|-
! Index
! Description
|-
| 0
| DSiWare Related (Visibility on Home Menu/Export Flag?)
|-
| 1
| ?
|-
| 2
| ?
|-
| 3
| ?
|-
| 4
| Found with DSiWare Titles and titles with an 'Application' Title ID
|-
| 5
| DSiWare Related (Visibility on Home Menu/Export Flag?)
|-
| 6
| ?
|-
| 7
| ?
|}

'''NOTES:'''

It is important to note the database doesn't contain a hash of the [[Title Data Structure|.cmd]]. So if a user has more than one valid set of [[Title Data Structure|application data]] for a given .cmd Content ID they can be manually interchanged without issue. Though renaming a .cmd file to match the Content ID which the title.db is expecting will result in an error, as the CTR for the per-console encryption layer changes depending on the file path, and the MAC of the .cmd is probably generated with the .cmd Content ID in mind.

These NAND/SD /dbs images seem to be loaded by the ARM9 while NATIVE_FIRM is booting.

== Tools ==

[https://github.com/ps3hen/ctr_toolkit/tree/master/extdata_tool extdata_tool] - parsing cleartext .db extdata images

Makerom

2014-11-27T15:05:50Z

Idunoe: fix typo

{{Infobox homebrew
| title = makerom
| type = pc utility
| author = [[User:3dsguy|3dsguy]]
| download = https://anonfiles.com/file/865643f366d17771aa907d467f00826f
| source = https://github.com/profi200/Project_CTR/tree/master/makerom
| version = 0.13
}}

makerom is a tool which can be used to create [[NCCH]], [[NCSD|CCI]], and [[CIA]] files.

== Format Overviews ==
=== NCCH ===
The native format storing code binaries and data archives for the 3DS is [[NCCH]]. [[NCCH]] files are comprised of:
* code/exheader/plainregion (used for code execution) (plainregion just lists included SDK library add-ons)
* icon (app title text, icon, homemenu settings, see [[SMDH|here]]
* banner (cbmd + cwav, i.e. the upper screen banner/sound shown on the homemenu)
* logo (the splash screen displayed after an application is launched from the homemenu)
* romfs (read-only filesystem used to store resources)

Typical uses for NCCH files include:
* Executable image (code+exheader+icon+banner+logo+romfs)
* e-Manual archive (accessed from homemenu) (romfs)
* [[Download Play|DLP]] child CIA archive (accessed from application) (romfs)
* Update Data archive (romfs)
* Standalone data archive (romfs)
* DLC index archive (icon+romfs)
* DLC archive (romfs)

=== CCI ===
The native format for gamecard images is [[NCSD|CCI]] and is a NCCH container format. CCI files are limited to containing 8 NCCH files, and can contain NCCH files for applications titles only.
==== NCCH configuration for CCI ====
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Executable image
| YES
| 0
|-
| e-Manual archive
| NO
| 1
|-
| DLP child CIA archive
| NO
| 2
|-
| Update Data archive
| NO
| 7
|}

=== CIA ===
The native format for packaging NCCH files for install is [[CIA]], which is also a NCCH container format. CIA files are limited to containing 65535 NCCH files and can be used to contain NCCH files for any title type. CIA files also contain '''signed''' data used by the 3DS for general title management and DRM. Installing custom CIA files on a 3DS which also uses eShop/SysUpdates is unwise as conflicts will likely occur.

==== NCCH configurations for CIA ====
Applications (Application/DlpChild/Demo/Patch/SystemApplication):
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Executable image
| YES
| 0
|-
| e-Manual archive
| NO
| 1
|-
| DLP child CIA archive
| NO
| 2
|}

System Applet/Module:
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Executable image
| YES
| 0
|}

System Data Archives:
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Data archive
| YES
| 0
|}

DLC:

The number of DLC data archives in DLC varies for each DLC.
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| DLC index archive
| YES
| 0
|-
| DLC data archive
| YES
| Varies
|}

== Using Makerom ==

=== Command line ===

makerom [general args] [rsf args] [crypto args] [ncch 0 build args] [cci args] [cia args]

'''General Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -f <format>
| 'ncch'/'cxi'/'cfa'/'cci'/'cia'
| Specify the output file format. 'ncch'/'cxi'/'cfa' has no affect, probably parsed without error for legacy support.
|-
| -o <path>
| Valid file path.
| Specify name/path for output file. Makerom will decided a name if this is not specified.
|-
| -v
| not required
| Enables verbose output.
|}

'''RSF Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -rsf <path>
| Valid file path
| Specify the path to Rom Specification File(RSF). See below for creating RSF.
|-
| -D<NAME>=<VALUE>
|
| This is used to substitute where "$(<NAME>)" exists in the RSF files with "<VALUE>". (Uppercase isn't a requirement)
|}

'''Crypto Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -target <target>
| 't'/'d'/'p'
| Specify key-chain. This affects encryption, signing and '-desc' template availability. t=test, suitable for homebrew. d=devkit(incomplete), suitable for devkits. p=retail(unusable), suitable for signing retail software?
|-
| -ckeyid <index>
| Any value between 0-255 (inclusive).
| Overrides the default common key used to encrypt CIA title keys.
|-
| -showkeys
| none
| Dumps loaded key-chain to stdout.
|}

'''NCCH Build Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -elf <file>
| Valid file path
| Specify ELF. See below for creating ELF.
|-
| -icon <file>
| Valid file path
| Specify [[SMDH|icon]].
|-
| -banner <file>
| Valid file path
| Specify banner.
|-
| -desc <apptype>:<fw>
| <apptype>='app'/'ecapp'/'demo'/'dlpchild'. <fw>='kernel version minor'.
| Use a template for [[Exheader|exheader/accessdesc]]. These are hard-coded, so not all firmwares have a template. A value from 1-7 can be used in place of 'kernel version minor'. A template shouldn't be used if the title needs "special" permissions, the RSF must be configured fully.
|-
| -exefslogo
| none
| Include logo in ExeFS. Required for usage on <5.0 systems.
|}

Arguments useful for rebuilding a NCCH file:
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -code <file>
| Valid file path
| Specify decompressed/plaintext exefs code binary.
|-
| -exheader <file>
| Valid file path
| Specify plaintext exheader binary.
|-
| -logo <file>
| Valid file path
| Specify logo.
|-
| -plainrgn <file>
| Valid file path
| Specify NCCH plain-region.
|-
| -romfs <file>
| Valid file path
| Specify an unencrypted RomFS binary.
|}

'''CCI Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -content <path>:<index>
| <path>=Valid file path. <index>=Any value between 0-7 (inclusive)
| Include a built NCCH file in the CCI container. "-i" can be used instead of "-content".
|-
| -devcci
| none
| Build a debug CCI?
|-
| -nomodtid
| none
| Don't modify the TitleIds of NCCH files included to match NCCH0
|-
| -alignwr
| none
| Align the offset for the Card2 writable region to the end of the last NCCH in the CCI.
|}

'''CIA Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -content <path>:<index>:<id>
| <path>=Valid file path. <index>=Any value between 0x0-0xFFFF (inclusive). <id>=Any value between 0x0-0xFFFFFFFF (inclusive)
| Include a built NCCH file in the CIA container. If <id> isn't specified, it will be generated randomly. "-i" can be used instead of "-content".
|-
| -major <version>
| Any value between 0-63 (inclusive)
| Specify the version major for the title. This cannot be used with "-dver".
|-
| -minor <version>
| Any value between 0-63 (inclusive)
| Specify the version minor for the title. This cannot be used with "-dver".
|-
| -micro <version>
| Any value between 0-15 (inclusive)
| Specify the version micro for the title.
|-
| -dver <version>
| Any value between 0-4095 (inclusive)
| Specify the data-title version for the title. This cannot be used with "-major" or "-minor".
|-
| -dlc
| none
| Specify this flag when building a DLC CIA.
|-
| -rand
| none
| Use a random title key to encrypt CIA content.
|}

==== Examples ====

General examples:

'''Create CXI'''
makerom -o sample.cxi -rsf sample.rsf -target t -elf sample.elf -icon sample.icn -banner sample.bnr -desc app:4

'''Create CFA'''
makerom -o sample.cfa -rsf sample.rsf -target t

'''Create CCI'''
makerom -f cci -o sample.cci -target t -i sample.cxi:0 -i sample.cfa:1

'''Create CIA'''
makerom -f cia -o sample.cia -target t -i sample.cxi:0:0 -i sample.cfa:1:1

Makerom supports building a NCCH file and including it automatically (as index 0) into a NCCH container:

'''Create CCI and CXI at the same time and include a CFA'''
makerom -f cci -o sample.cci -rsf sample.rsf -target t -elf sample.elf -icon sample.icn -banner sample.bnr -desc app:4 -i sample.cfa:1

'''Create CIA and CXI at the same time and include a CFA'''
makerom -f cia -o sample.cia -rsf sample.rsf -target t -elf sample.elf -icon sample.icn -banner sample.bnr -desc app:4 -i sample.cfa:1:1

Rebuilding CXI:
makerom -o rebuild.cxi -rsf rebuild.rsf -target t -code rebuild/code.bin -exheader rebuild/exheader.bin -icon rebuild/icon.bin -banner rebuild/banner.bin -romfs rebuild/romfs.bin

=== Creating RSF files ===
Inspired by Nintendo's format for their makerom, a yaml configuration file is required for creating NCCH files. CIA/CCI can be created without using a RSF file, but default settings will be used.

For CXI, RSF files can be used to specify permissions, and access control settings. Makerom can use default settings by use of the "-desc" option, which removes the requirement for specifying them in the RSF file.

Sample RSF to be used with "-desc": [https://gist.githubusercontent.com/3DSGuy/83e12e0ae3dcccb9827f/raw/sample0.rsf download] (link broken)

Sample RSF to be used without "-desc": [https://gist.githubusercontent.com/3DSGuy/83e12e0ae3dcccb9827f/raw/sample1.rsf download] (link broken)

=== Creating ELF files ===
DevKitARM used in conjunction with [https://github.com/smealum/ctrulib ctrulib] can create ELF files compatible with makerom, provided they are linked with [https://gist.github.com/yellows8/6da7984a80a825b10294 this linker script], and striped.

ELF files that are created using the official SDK are also supported by makerom.

== Compiling Source ==
For Windows a MinGW/MSYS build setup is required.

For Linux, gcc/g++/make must be installed.

All additional libraries used by makerom (polarssl/libyaml) are included in the source, and are linked statically.

== Issues ==

* RomFS hasn't been completely implemented (but valid pre-built RomFS can be used as substitute)

Makerom

2014-11-27T15:04:39Z

Idunoe: Added relevant cli argument explainations.

{{Infobox homebrew
| title = makerom
| type = pc utility
| author = [[User:3dsguy|3dsguy]]
| download = https://anonfiles.com/file/865643f366d17771aa907d467f00826f
| source = https://github.com/profi200/Project_CTR/tree/master/makerom
| version = 0.13
}}

makerom is a tool which can be used to create [[NCCH]], [[NCSD|CCI]], and [[CIA]] files.

== Format Overviews ==
=== NCCH ===
The native format storing code binaries and data archives for the 3DS is [[NCCH]]. [[NCCH]] files are comprised of:
* code/exheader/plainregion (used for code execution) (plainregion just lists included SDK library add-ons)
* icon (app title text, icon, homemenu settings, see [[SMDH|here]]
* banner (cbmd + cwav, i.e. the upper screen banner/sound shown on the homemenu)
* logo (the splash screen displayed after an application is launched from the homemenu)
* romfs (read-only filesystem used to store resources)

Typical uses for NCCH files include:
* Executable image (code+exheader+icon+banner+logo+romfs)
* e-Manual archive (accessed from homemenu) (romfs)
* [[Download Play|DLP]] child CIA archive (accessed from application) (romfs)
* Update Data archive (romfs)
* Standalone data archive (romfs)
* DLC index archive (icon+romfs)
* DLC archive (romfs)

=== CCI ===
The native format for gamecard images is [[NCSD|CCI]] and is a NCCH container format. CCI files are limited to containing 8 NCCH files, and can contain NCCH files for applications titles only.
==== NCCH configuration for CCI ====
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Executable image
| YES
| 0
|-
| e-Manual archive
| NO
| 1
|-
| DLP child CIA archive
| NO
| 2
|-
| Update Data archive
| NO
| 7
|}

=== CIA ===
The native format for packaging NCCH files for install is [[CIA]], which is also a NCCH container format. CIA files are limited to containing 65535 NCCH files and can be used to contain NCCH files for any title type. CIA files also contain '''signed''' data used by the 3DS for general title management and DRM. Installing custom CIA files on a 3DS which also uses eShop/SysUpdates is unwise as conflicts will likely occur.

==== NCCH configurations for CIA ====
Applications (Application/DlpChild/Demo/Patch/SystemApplication):
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Executable image
| YES
| 0
|-
| e-Manual archive
| NO
| 1
|-
| DLP child CIA archive
| NO
| 2
|}

System Applet/Module:
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Executable image
| YES
| 0
|}

System Data Archives:
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Data archive
| YES
| 0
|}

DLC:

The number of DLC data archives in DLC varies for each DLC.
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| DLC index archive
| YES
| 0
|-
| DLC data archive
| YES
| Varies
|}

== Using Makerom ==

=== Command line ===

makerom [general args] [rsf args] [crypto args] [ncch 0 build args] [cci args] [cia args]

'''General Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -f <format>
| 'ncch'/'cxi'/'cfa'/'cci'/'cia'
| Specify the output file format. 'ncch'/'cxi'/'cfa' has no affect, probably parsed without error for legacy support.
|-
| -o <path>
| Valid file path.
| Specify name/path for output file. Makerom will decided a name if this is not specified.
|-
| -v
| not required
| Enables verbose output.
|}

'''RSF Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -rsf <path>
| Valid file path
| Specify the path to Rom Specification File(RSF). See below for creating RSF.
|-
| -D<NAME>=<VALUE>
|
| This is used to substitute where "$(<NAME>)" exists in the RSF files with "<VALUE>". (Uppercase isn't a requirement)
|}

'''Crypto Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -target <target>
| 't'/'d'/'p'
| Specify key-chain. This affects encryption, signing and '-desc' template availability. t=test, suitable for homebrew. d=devkit(incomplete), suitable for devkits. p=retail(unusable), suitable for signing retail software?
|-
| -ckeyid <index>
| Any value between 0-255 (inclusive).
| Overrides the default common key used to encrypt CIA title keys.
|-
| -showkeys
| none
| Dumps loaded key-chain to stdout.
|}

'''NCCH Build Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -elf <file>
| Valid file path
| Specify ELF. See below for creating ELF.
|-
| -icon <file>
| Valid file path
| Specify [[SMDH|icon]].
|-
| -banner <file>
| Valid file path
| Specify banner.
|-
| -desc <apptype>:<fw>
| <apptype>='app'/'ecapp'/'demo'/'dlpchild'. <fw>='kernel version minor'.
| Use a template for [[Exheader|exheader/accessdesc]]. These are hard-coded, so not all firmwares have a template. A value from 1-7 can be used in place of 'kernel version minor'. A template shouldn't be used if the title needs "special" permissions, the RSF must be configured fully.
|-
| -exefslogo
| none
| Include logo in ExeFS. Required for usage on <5.0 systems.
|}

Arguments useful for rebuilding a NCCH file:
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -code <file>
| Valid file path
| Specify decompressed/plaintext exefs code binary.
|-
| -exheader <file>
| Valid file path
| Specify plaintext exheader binary.
|-
| -logo <file>
| Valid file path
| Specify logo.
|-
| -plainrgn <file>
| Valid file path
| Specify NCCH plain-region.
|-
| -romfs <file>
| Valid file path
| Specify an unencrypted RomFS binary.
|}

'''CCI Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -content <path>:<index>
| <path>=Valid file path. <index>=Any value between 0-7 (inclusive)
| Include a built NCCH file in the CCI container. "-i" can be used instead of "-content".
|-
| -devcci
| none
| Build a debug CCI?
|-
| -nomodtid
| none
| Don't modify the TitleIds of NCCH files included to match NCCH0
|-
| -alignwr
| none
| Align the offset for the Card2 writable region to the end of the last NCCH in the CCI.
|}

'''CIA Arguments'''
{| class="wikitable"
|-
! Argument
! Acceptable values
! Notes
|-
| -content <path>:<index>:<id>
| <path>=Valid file path. <index>=Any value between 0x0-0xFFFF (inclusive). <id>=Any value between 0x0-0xFFFFFFFF (inclusive)
| Include a built NCCH file in the CIA container. If <id> isn't specified, it will be generated randomly. "-i" can be used instead of "-content".
|-
| -major <version>
| Any value between 0-63 (inclusive)
| Specify the version major for the title. This cannot be used with "-dver".
|-
| -minor <version>
| Any value between 0-63 (inclusive)
| Specify the version minor for the title. This cannot be used with "-dver".
|-
| -micro <version>
| Any value between 0-15 (inclusive)
| Specify the version micro for the title.
|-
| -dver <version>
| Any value between 0-4095 (inclusive)
| Specify the data-title version for the title. This cannot be used with "-major" or "-minor".
|-
| -dlc
| none
| Specify this flag when building a DLC CIA.
|-
| -rand
| none
| Use a random title key to encrypt CIA content.
|}

==== Examples ====

General examples:

'''Create CXI'''
makerom -o sample.cxi -rsf sample.rsf -target t -elf sample.elf -icon sample.icn -banner sample.bnr -desc app:4

'''Create CFA'''
makerom -o sample.cfa -rsf sample.rsf -target t

'''Create CCI'''
makerom -f cci -o sample.cci -target t -i sample.cxi:0 -i sample.cfa:1

'''Create CIA'''
makerom -f cia -o sample.cia -target t -i sample.cxi:0:0 -i sample.cfa:1:1

Makerom supports building a NCCH file and including it automatically (as index 0) into a NCCH container:

'''Create CCI and CXI at the same time and include a CFA'''
makerom -f cci -o sample.cia -rsf sample.rsf -target t -elf sample.elf -icon sample.icn -banner sample.bnr -desc app:4 -i sample.cfa:1

'''Create CIA and CXI at the same time and include a CFA'''
makerom -f cia -o sample.cia -rsf sample.rsf -target t -elf sample.elf -icon sample.icn -banner sample.bnr -desc app:4 -i sample.cfa:1:1

Rebuilding CXI:
makerom -o rebuild.cxi -rsf rebuild.rsf -target t -code rebuild/code.bin -exheader rebuild/exheader.bin -icon rebuild/icon.bin -banner rebuild/banner.bin -romfs rebuild/romfs.bin

=== Creating RSF files ===
Inspired by Nintendo's format for their makerom, a yaml configuration file is required for creating NCCH files. CIA/CCI can be created without using a RSF file, but default settings will be used.

For CXI, RSF files can be used to specify permissions, and access control settings. Makerom can use default settings by use of the "-desc" option, which removes the requirement for specifying them in the RSF file.

Sample RSF to be used with "-desc": [https://gist.githubusercontent.com/3DSGuy/83e12e0ae3dcccb9827f/raw/sample0.rsf download] (link broken)

Sample RSF to be used without "-desc": [https://gist.githubusercontent.com/3DSGuy/83e12e0ae3dcccb9827f/raw/sample1.rsf download] (link broken)

=== Creating ELF files ===
DevKitARM used in conjunction with [https://github.com/smealum/ctrulib ctrulib] can create ELF files compatible with makerom, provided they are linked with [https://gist.github.com/yellows8/6da7984a80a825b10294 this linker script], and striped.

ELF files that are created using the official SDK are also supported by makerom.

== Compiling Source ==
For Windows a MinGW/MSYS build setup is required.

For Linux, gcc/g++/make must be installed.

All additional libraries used by makerom (polarssl/libyaml) are included in the source, and are linked statically.

== Issues ==

* RomFS hasn't been completely implemented (but valid pre-built RomFS can be used as substitute)

Main Page/Navigation

2014-11-24T05:32:43Z

Idunoe: Undo revision 10835 by Trollinteemo (talk)

{{Main page box|Navigation|Main Page/Navigation}}
<div style="margin: -.3em -1em -1em -1em;">
{| width="100%" bgcolor="#fff" border="0" cellpadding="2px" cellspacing="2px" style="margin:auto;"
|- align="center" bgcolor="#e7eef6"
! width="25%" | '''General'''
! width="25%" | '''3DS hardware'''
! width="50%" colspan="2" | '''3DS software'''
|- valign="top" style="background: #F5FAFF;"
|
*[[Glossary]]
*[[FAQ]]
*[[Friend code]]
*[[Games]]
*[[Serials]]
*[[:Category:PC utilities|PC Utilities]]
*[[Homebrew Exploits]]
*[[Homebrew Applications]]
*[[3DS System Flaws]]
|
*[[Hardware]]
*[[Peripherals]]
*[[Gamecards]]
*[[Video Capture]]
|
*[[Nintendo Software]]
*[[3DS Development Unit Software]]
*[[Memory layout]]
*[[Services API]]
*[[SVC|List of systemcalls]]
*[[IO|List of IO registers]]
*[[:Category:Kernel_objects|Kernel objects]]
*[[3DS System Flaws]]
|
*[[:Category:File_formats|File Formats]] ([[NCSD|CCI]]/[[NCCH#CXI|CXI]]/[[CIA]])
*[[Title list]]
*[[Title metadata]]
*[[Update Data]]
*[[SD Filesystem]]
*[[Flash Filesystem]]
*[[Bootloader]]
*[[Savegames]]
|}
</div>
{{box-footer-empty}}

Makerom

2014-11-22T04:43:47Z

Idunoe: Added brief format overview so people better understand what it is they're making.

{{Infobox homebrew
| title = makerom
| type = pc utility
| author = [[User:3dsguy|3dsguy]]
| download = https://anonfiles.com/file/2e954a4b954778e8bcd0c317f071c272
| source = https://github.com/3DSGuy/Project_CTR/tree/master/makerom
| version = 0.8
}}

makerom is a tool which can be used to create [[NCCH]], [[NCSD|CCI]], and [[CIA]] files.

== Format Overviews ==
=== NCCH ===
The native format storing code binaries and data archives for the 3DS is [[NCCH]]. [[NCCH]] files are comprised of:
* code/exheader/plainregion (used for code execution) (plainregion just lists included SDK library add-ons)
* icon (app title text, icon, homemenu settings, see [[SMDH|here]]
* banner (cbmd + cwav, i.e. the upper screen banner/sound shown on the homemenu)
* logo (the splash screen displayed after an application is launched from the homemenu)
* romfs (read-only filesystem used to store resources)

Typical uses for NCCH files include:
* Executable image (code+exheader+icon+banner+logo+romfs)
* e-Manual archive (accessed from homemenu) (romfs)
* [[Download Play|DLP]] child CIA archive (accessed from application) (romfs)
* Update Data archive (romfs)
* Standalone data archive (romfs)
* DLC index archive (icon+romfs)
* DLC archive (romfs)

=== CCI ===
The native format for gamecard images is [[NCSD|CCI]] and is a NCCH container format. CCI files are limited to containing 8 NCCH files, and can contain NCCH files for applications titles only.
==== NCCH configuration for CCI ====
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Executable image
| YES
| 0
|-
| e-Manual archive
| NO
| 1
|-
| DLP child CIA archive
| NO
| 2
|-
| Update Data archive
| NO
| 7
|}

=== CIA ===
The native format for packaging NCCH files for install is [[CIA]], which is also a NCCH container format. CIA files are limited to containing 65535 NCCH files and can be used to contain NCCH files for any title type. CIA files also contain data used by the 3DS for general title management and DRM. Installing custom CIA files on a 3DS which also uses eShop/SysUpdates is unwise as conflicts will likely occur.

==== NCCH configurations for CIA ====
Applications (Application/DlpChild/Demo/Patch/SystemApplication):
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Executable image
| YES
| 0
|-
| e-Manual archive
| NO
| 1
|-
| DLP child CIA archive
| NO
| 2
|}

System Applet/Module:
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Executable image
| YES
| 0
|}

System Data Archives:
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| Data archive
| YES
| 0
|}

DLC:

The number of DLC data archives in DLC varies for each DLC.
{| class="wikitable"
|-
! NCCH
! Required
! Index
|-
| DLC index archive
| YES
| 0
|-
| DLC data archive
| YES
| Varies
|}

== Using Makerom ==

=== Command line ===
Since CCI and CIA are NCCH containers, makerom was built so CXIs could be built stand alone or straight into a container format. It is also possible rebuild CXIs from an ELF file. As a result there are many combinations which can be used; for simplicity, specific functions will be explained by breaking them up into argument groups:

'''Creating CXIs from scratch:'''
-elf <elf path> -rsf <rsf path> [-icon <[[SMDH|icon]] path> -banner <banner path>]

'''Rebuilding CXIs:'''
-code <decompressed exefs .code> -exheader <exheader from original CXI> -rsf <rsf path> [-icon <[[SMDH|icon]] path> -banner <banner path> -romfs <cleartext romfs binary>]

'''Creating CFAs:'''
-f cfa -rsf <rsf path> [-icon <[[SMDH|icon]] path> -romfs <romfs binary>]

'''Creating CCIs:'''
-f cci [-content <path>:<index> ...]

'''Creating CIAs:'''
-f cia [-content <path>:<index>:<id> ...]

'''Using Desc presets:'''
-desc <app type>:<firm version>

* 'app type' can be SDApp / ECApp / Demo / DlpChild
* 'firm version' is the target kernel version minor for the intended 3DS system.

'''Examples:'''
Create a CCI, using a manual CFA, and a desc preset:
makerom -f cci -elf homebrew.elf -rsf app.rsf -desc sdapp:33 -icon homebrew.icn -banner homebrew.bnr -content manual.cfa:1 -o homebrew.cci

Create a CIA using an already built application CXI and manual CFA:
makerom -f cia -content homebrew.cxi:0:0 -content manual.cfa:1:1 -o homebrew.cia

Rebuild a CXI:
makerom -code code.bin -exheader exheader.bin -icon icon.bin -banner banner.bin -romfs romfs.bin -rsf app.rsf -desc sdapp:33 -o rebuild.cxi

=== Creating RSF files ===
Inspired by Nintendo's format for their makerom, a yaml configuration file is required for creating NCCH files. CIA/CCI can be created without using a RSF file, but default settings will be used.

For CXI, RSF files can be used to specify permissions, and access control settings. Makerom can use default settings by use of the "-desc" option, which removes the requirement for specifying them in the RSF file.

Sample RSF to be used with "-desc": [https://gist.githubusercontent.com/3DSGuy/83e12e0ae3dcccb9827f/raw/sample0.rsf download]

Sample RSF to be used without "-desc": [https://gist.githubusercontent.com/3DSGuy/83e12e0ae3dcccb9827f/raw/sample1.rsf download]

=== Creating ELF files ===
DevKitARM used in conjunction with [https://github.com/smealum/ctrulib ctrulib] can create ELF files compatible with makerom, provided they are linked with [https://gist.github.com/yellows8/6da7984a80a825b10294 this linker script], and striped.

ELF files that are created using the official SDK are also supported by makerom.

== Compiling Source ==
For Windows a MinGW/MSYS build setup is required.

For Linux, gcc/g++/make must be installed.

All additional libraries used by makerom (polarssl/libyaml) are included in the source, and are linked statically.

== Issues ==

* RomFS hasn't been completely implemented (but valid pre-built RomFS can be used as substitute)