ctr_makerom

Table of Contents

  1. Introduction
  2. How to Use
  3. RSF File
  4. DESC File
  5. Game Software Prototype Code
  6. Variables Defined Within OMakefiles
  7. Revision History

Introduction

This ctr_makerom tool is for creating CCI (CTR Card Image) files. CCI files are created based on the content in RSF files.

If a NAND application is specified as the output format, a CXI (CTR eXecutable Image) file is generated as the output. The requirements for CXI file generation are the same as for CCI files.

How to Use

What's Required

You will need the following to create a CCI file:

RSF files contain the information required to create a CCI file. They must be created individually for each application. By default, the SDK's default RSF file is used. Be sure to always use the DESC file included in the SDK.

Commands

% ctr_makerom32 ELF_FILE -rsf RSF_FILE -desc DESC_FILE [-o OUTPUT_FILE] [-Dname=value...] [-f FORMAT] [-info INFO_FILE] [-banner BANNER_FILE] [-icon ICON_FILE] [-content CONTENTS_PATH:INDEX] [-j NUM]

You must specify the ELF, RSF, and DESC files. All other options are optional.

Options

Options Description
-rsf Specifies the RSF file.
-desc Specifies the DESC file.
-banner Specifies the banner file.
-icon Specifies the icon file.
Unless you specify an icon file with this option, you cannot get the EULA version from the application.
-content CONTENTS_PATH:INDEX Specifies content (.cfa) included in the CCI.
Specify the contents file path in CONTENTS_PATH.
Specify the partition number including the content in INDEX.
The values specifiable for INDEX vary depending on the following conditions.
When an ELF_FILE is specified The value 1 through 7 can be specified for INDEX.
When an ELF_FILE is not specified The value 0 through 7 can be specified for INDEX.
-o Specifies the output filename. If omitted, the output file will have the same basename as the ELF file used as input, and instead of the .elf extension, the output file extension will be .cci for card applications and .cxi for NAND applications.
-Dname=value Specifies the variable name (name) and value (value) to reference in the RSF file. Locations where $(name) is written in the RSF file are replaced with the value command line argument and then evaluated.
-f FORMAT Specifies the format of the image to output. The following values can be specified for FORMAT.
card Outputs in .cci format. Specify this option when creating a standard card application.
nand Outputs in .cxi format. Specify this option when building a NAND application.
You must use the .cxi file generated as input to ctr_makecia to create a .cia file in order to create images that can actually be imported to NAND.
data Output is made in .cfa format. The generated .cfa file can be made to include a separate CCI by using the -content option.
If nothing is specified, the default value of nand is used.
-info Specifies the output file to which to output information about the output image. If unspecified, the output filename will have the .xml filename extension. This file contains information about the application title and ROMFS.
-j NUM Specifies the number of makerom parallel processes. However, only some processes can be performed in parallel.
When it is not specified, the CPU core count for the execution environment is acquired and used.

RSF File

This is a file that contains the settings for the CCI file.

Format

The RSF file format is shown below.

BasicInfo:
  Title:           # Application title
  CompanyCode:     # Company code
  ProductCode:     # Product code
  MediaSize:       # Media size
  Logo:            # Logo data specification
  BackupMemoryType:  # Backup memory type

TitleInfo:
  Category:        # Title category
  UniqueId:        # Unique ID for title code
  ChildIndex:      # DLP child index

Rom:
  HostRoot:    # Root path of the ROM file system
  Reject:      # File and directory names to exclude from the ROM file system

AccessControlInfo:
  Priority:          # Main thread priority.
  UseExtSaveData:    # Whether to use expanded save data.
  ExtSaveDataNumber: # Expanded save data number.
  FileSystemAccess:  # File system access permissions.

SystemControlInfo:
StackSize:   # Stack size of main thread.
  RemasterVersion:   # The remaster version

Option:
  EnableCompress:  # Enables/disables compression of static memory

Configure the values of the items under the six main sections (BasicInfo, TitleInfo, Rom, AccessControlInfo, SystemControlInfo, and Option).
Set the values using the following format:

Specifying Single Values

Key Name: Value

Specifying Multiple Values

Key Name:
  - Value 1
  - Value 2
  ...

Notes

Descriptions of the settings for each of these items are shown below.

BasicInfo

Item Description Comments
Title The title of the application. Specifies the application title in eight or fewer ASCII characters.
CompanyCode The company code. Company code that was assigned when the licensing agreement was signed with Nintendo. Two ASCII characters.
ProductCode Product code. Specifies the product code issued by Nintendo.
MediaSize Specifies the media size. Specify a value of 125 MB, 256 MB, 512 MB, 1 GB, or 2 GB.
Logo Specifies the type of logo data. Specify "Nintendo" for Nintendo titles, "Distributed" for titles for which Nintendo purchased the publishing license from the software manufacturer or titles for which Nintendo acquired the publishing license from a publisher, and "Licensed" for all other titles. If omitted, "Nintendo" is used as the default value.

The value "Published" was valid in previous versions, but it has been replaced by "Distributed". If you specify "Published", it is handled as "Distributed". In future releases it will not be possible to specify "Published".
BackupMemoryType Specify the backup memory type. This is ignored for download applications.
Specify None, 128 KB, or 512 KB.

TitleInfo

Item Description Comments
Category Specifies the application type.
Application Specify this when building a typical application.
DlpChild Specify this when building a download play child.
This must be specified along with ChildIndex (described later).
When unspecified, a value corresponding to DESC is automatically selected.
UniqueId The application's unique ID. Specifies the ID issued by Nintendo.
Specifies the same ID as the parent device for Download Play child devices.		 Valid values are from 0x00300 to 0xf7fff.
ChildIndex Specifies the download play child index. You can specify values from 0 through 255.

Rom

Item Description Comments
HostRoot The root path of the ROM file system.
Specify either an absolute path or a relative path from the directory that is the current directory when executing ctr_makerom. All files and directories under the directory specified here will be stored in the ROM file system. However, any files or directories that start with a period (".") will not be stored in the ROM file system, nor will any files or directories specified under the Reject item.
Reject Specify the names of files and directories to exclude from the ROM file system.
Any files or directories that match the names specified will not be stored in the ROM file system. You can set multiple values. Names can use the "*" and "?" wildcards ("*" matches 0 or more characters, and "?" matches a single character).		 Use the syntax described in the Specifying Multiple Values section.

SystemControlInfo

Item Description Comments
StackSize Specify the stack size of the main thread (in bytes). Must be a multiple of 4096.
RemasterVersion Specifies the remaster version. If unspecified, the version is treated as if 0 had been specified.

AccessControlInfo

Item Description Comments
Priority Specifies the priority of the main thread. You can specify values between 0 and 31 (inclusive).
UseExtSaveData Specify true when using expanded save data. The default value is false.
ExtSaveDataNumber Specify the expanded save data number using 20 bits. The default is the UniqueId.
FileSystemAccess Specifies the file system access permission attributes.
Specify from the following values:
  • DirectSdmc: Allows direct access to the SD Card. Specify this when using the library that directly accesses SD Cards.
  • Debug: Enables debug features, such as direct access to SD Cards. This value cannot be specified for retail versions.
 Use the syntax described in the Specifying Multiple Values section.

Option

Item Description Comments
EnableCompress Specify true to enable static memory compression or false to disable it. Memory is not compressed if doing so does not decrease the size. The compression rate is output to the file specified in the -info argument. If this argument is not specified, the default value of true is used.

Variables

Using the -Dname=value option allows you to pass variable names and their corresponding values to the ctr_makerom tool. The ctr_makerom tool replaces any occurrences of $(name) within the RSF file with the specified value, then evaluates the results. An example is shown below.

$ ctr_makerom32 test.axf -o test.cci -rsf test.rsf -DTITLE=Test -DROMFS_ROOT=files

--- test.rsf
BasicInfo:
  Title: $(TITLE)

Rom:
  HostRoot: "$(ROMFS_ROOT)"

--- Value at final evaluation
BasicInfo:
  Title: Test

Rom:
  HostRoot: "files"

DESC File

DESC files are placed in the CTR_SDK/resources/specfiles folder. Use the appropriate DESC file depending on the type of application you are creating.

Application Type DESC File Comments
General applications Application.desc
Download Play child DlpChild.desc

Edits to the DESC file are prohibited. Editing this file may prevent your application from operating properly.

When you use the build system, the option -desc CTR_SDK/resources/specfiles/Application.desc is specified automatically when you run ctr_makerom.
You can also specify within the OMakefile what DESC file to use. For details, see the Build Rules.

Game Software Prototype Code

The following code has been assigned for software testing and prototyping purposes. Use this as an ID for internal testing. Be careful to avoid duplicate IDs within your company and development department. Note that running ctr_makerom displays a warning if you are using UniqueId for the prototype code.

BasicInfo:
 CompanyCode:"00"
  ProductCode: "CTR-*-****"

TitleInfo:
  UniqueId   : 0xFF000 ～ 0xFF3FF

 * ... A-Z, 0-9

Note: In CTR-SDK 0.14.1 and prior versions, ProductCode used the format below, but this format is no longer usable in subsequent versions.
The value that is used in the 0.14.1 environment is the value with the "(###)" portion removed.

  ProductCode: "CTR-*-**** (###)"

Variables Defined Within OMakefiles

Refer to Build Rules (ctr_makerom) for more information about variables defined within the OMakefile.

Revision History

2010/12/27
Added a method for specifying the remaster version.
2010/12/10
Added remarks about ChildIndex.
Added information about Download Play child devices to UniqueId.
2010/12/07
Added description of when no logo is specified.
2010/11/18
Added description of DESC file types.
Added description of the change in logo specification.
Added description of the -icon option.
2010/11/11
Added description of file system access permission attributes.
2010/11/10
Added description of product code format change.
2010/10/29
Added description of expanded save data and backup memory specifications.
2010/10/26
Added description of logo data.
Changed specifiable range for UniqueId to 0x300.
2010/10/07
Added the -j option.
2010/09/24
Changed the -cxi option to -content and included a description.
Included a description of the -banner and -icon options.
Included a description of Category and ChildIndex specifications for TitleInfo and the logo specification for BasicInfo.
2010/08/17
Added the "Game Software Prototype Code" section.
2010/08/03
Added descriptions of the EnableCompress and MediaSize options.
Deleted the InitialCode option.
2010/07/19
Added a description of the -info option, CompanyCode, ProductCode, and UniqueId.
2010/07/14
Added a description of CXI files.
2009/12/22
Initial version.

CONFIDENTIAL