1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<HTML> 3<HEAD> 4<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows"> 6<META http-equiv="Content-Style-Type" content="text/css"> 7<TITLE>NandFiler</TITLE> 8<LINK rel="stylesheet" href="../css/nitro.css" type="text/css"> 9<STYLE type="text/css"> 10<!-- 11.sample_source{ 12 background-color : #e8e8e8; 13} 14H3{ 15 color : teal; 16} 17pre 18{ 19 display: compact; 20 font-family : "Courier New", monospace; 21 font-weight : normal; 22 font-size : normal; 23 24/* margin : 0pt 0pt 6pt 50pt;*/ 25 padding : 2pt 8pt 2pt 8pt; 26 background-color : #eee; 27 28 border-style : solid; 29 border-width : 1px; 30} 31.command_list{ 32 margin-bottom : 16pt; 33} 34.command_desc{ 35 } 36.command_item{ 37 margin-top : 16pt; 38 background-color : #e8e8e8; 39} 40.blockquoted_table { 41 border : 1px; 42 width : 80%; 43} 44TD.table,TH.table{ 45 border-color : #c0d8d8; 46 padding : 1pt 4pt 1pt 4pt; 47 border-width : 1px; 48 border-style : solid; 49} 50div.screen 51{ 52 float: left; 53 padding: 2px; 54 background-color: black; 55 margin: 0 0.5em 1em 1em; 56} 57ol, ul 58{ 59 padding-left: 4em; 60 margin-left: 0pt; 61} 62 63div.screen img.main 64{ 65 margin-bottom: 10px; 66} 67.warning 68{ 69 color: red; 70} 71table 72{ 73 left: 0; 74} 75table.plain td 76{ 77 border: none; 78 background-color: transparent; 79} 80--> 81</STYLE> 82</HEAD> 83<BODY> 84<H1 align="left">NandFiler</H1> 85<H2>Overview</H2> 86<P>NandFiler is a tool for manipulating data in the system memory (NAND). It can be used to delete, browse, and edit photo data as well as the Save Data of the NAND application stored in Wii system memory. By using an SD Card, this tool can also be used to import and export Save Data. 87</P> 88 89<H2>Execution</H2> 90<P> 91It can be run in the following ways: 92</P> 93<ul> 94<li>Using the IS-TWL-DEBUGGER software to run <CODE>NandFiler.srl</CODE> 95<li>Using the IS-TWL-DEBUGGER software to import and then run <CODE>NandFiler.tad</CODE> 96<li>Writing <CODE>NandFiler.srl</CODE> to a DS Game Card and then running it 97<li>Using TWL Nmenu to import and then run <CODE>NandFiler.tad</CODE> 98</ul> 99<P> 100If running the TWL Nmenu using the IS-TWL-DEBUGGER software, a "Please wait a moment" dialog box will appear, and you will no longer be able to perform operations in the IS-TWL-DEBUGGER software. To exit, click <B>Force Quit</B> in the dialog box. 101</P> 102 103<H2>Mode</H2> 104<P>There are three modes in NandFiler:</P> 105<ul> 106 <li>Filer mode: Lets you traverse directories and check file sizes, timestamps, and attributes</li> 107 <li>View mode: Lets you browse file contents</li> 108 <li>Edit mode: Lets you edit file contents</li> 109</ul> 110 111<H2>Filer Mode</H2> 112<div class="screen"><img class="main" src="NandFiler/Filer_0.png"></div> 113<div class="screen"><img class="main" src="NandFiler/Filer_1.png"></div> 114<P> 115The NandFiler application is started in Filer mode by default.<BR>In <CODE>Filer</CODE> mode, after you select either photo data, NAND application Save Data that has been already imported in the system, or SD Card data, you can browse and operate on that directory tree.<BR><FONT color=#ff0000>When you are browsing the contents of an SD Card, file and directory names will not be displayed if they use characters that cannot be converted to Shift_JIS.</FONT> <br clear="left"> 116 117The following table shows what operations you can perform. 118 119</P> 120<table class="table"> 121<tbody> 122<tr><th>Button<th>Operation 123<tr><td>SELECT<td>Displays a list of operations. 124<tr><td>← →<td>Switches pages for the displayed items. 125<tr><td>↑ ↓<td>Selects files and so on. 126<tr><td>A<td>Confirms an item. 127<tr><td>B<td>Cancels the selected archive or file.<br>Moves to the parent directory. 128<tr><td>X<td>Opens a submenu when a file or archive is selected. 129</tbody> 130</table> 131 132<h3>Title Selection</h3> 133<P> 134This is the state immediately after startup. The left side of the screen displays links to the game code of the installed NAND application (blue), and to photo data and the SD card (purple).<BR>Selecting a Game Code will switch to archive selection in the center of the screen. Selecting a link to photo data or an SD card will switch to file selection on the right side of the screen. The following operations can be selected on the submenu displayed by pressing the X Button. 135<ul> 136 <li>Export ... Export data</li> 137</ul> 138</P> 139 140<h4>Export</h4> 141<p> 142Copies files from the application's Save Data region or the PHOTO directory to the SD card.<BR>A directory is created on the SD card (named either [<CODE>4-digit game code_4-digit version</CODE>] or [<CODE>PHOTO</CODE>]) and then the data are copied there. 143 144</p> 145 146 147<h3><a name="Archive">Archive Selection</a></h3> 148<p> 149Selecting a Game Code under Title Selection moves here. For Archive Selection, you can choose <CODE>Public</CODE>, <CODE>Private</CODE>, or <CODE>SBanner</CODE>. These are links to the public save data, private save data, and sub-banner of the NAND application selected under Title Selection.<br>The following operations can be selected on the submenu displayed by pressing the X Button. 150</p> 151<ul> 152 <li>Backup: Backs up save data</li> 153 <li>Break: Destroys the save data region</li> 154 <li>Delete: Deletes the save data region or sub-banner</li> 155 <li>Size0: Sets the size of the save data region or sub-banner to 0</li> 156 <li>Format: Formats the save data region or sub-banner</li> 157</ul> 158<p> 159However, the Backup and Break features do not exist in the sub-banner submenu. 160</p> 161 162<h4>Backup</h4> 163<p> 164Backs up save data on the SD card. The data backed up here can be imported using the <CODE>Restore</CODE> operation, described below.<BR><CODE>Backup</CODE> differs from the <CODE>Export</CODE> operation described above in that the entire file system of the Save Data region is copied to the SD card, whereas with Export, data are copied in file units. 165</p> 166 167<h4>Break</h4> 168<p> 169Destroys the FAT system region of the save data. Use this for debugging an assumed problem with the save data region causing <a href="../fs/fs_result_const.html"><CODE>FS_RESULT_BAD_FORMAT</CODE></a> to occur.<br> The destroyed save data region can be restored with this tool using any of the methods described below. 170</p> 171 172 <ul> 173 <li>Execute Backup before using Break and then use Restore after Break</li> 174<li>Run Format (files in the save data are deleted)</li> 175<li>Reimport the application in question on the TWL Nmenu</li> 176<li>Re-import using the IS-TWL-DEBUGGER software: select <B>File → Load File → TAD</B> and the <B>Control imports</B> option</li> 177 </ul> 178<p> 179To restore while the application is running, use <a href="../na/archive/NA_FormatTitleArchive.html"><CODE>NA_FormatTitleArchive</CODE></a>. 180</p> 181 182<h4>Delete, Size0</h4> 183<p> 184The Nintendo DSi Shop download process allocates regions for an application's ROM region, save data region, and sub-banner file, in that order. However, the save data region and other regions may not be allocated properly if the DSi system power is turned off during the download. <CODE>Delete</CODE> and <CODE>Size0</CODE> are used for debugging when this abnormal situation is expected to occur. 185</p> 186<p> 187The <CODE>Delete</CODE> command reproduces a state in which no files have been created. <CODE>Size0</CODE> reproduces a state in which the files were created, but the size of the region was allocated as 0. Either of these can occur if the power is turned off during a download. A save data region or sub-banner in an illegal state can be recovered in the same way as it can when the <CODE>Break</CODE> command is used. (However, you cannot use a method that uses the <CODE>Restore</CODE> command.) 188</p> 189<p> 190<FONT color=#ff0000>We are currently investigating ways for applications to handle these errors.</FONT><br> 191</p> 192 193<h4>Format</h4> 194<p> 195Initializes the save data and sub-banner. This command can recover the save data and sub-banner if they were put into an illegal state using <CODE>Backup</CODE>, <CODE>Delete</CODE>, or <CODE>Size0</CODE>. 196</p> 197 198<h3>File Selection</h3> 199<P> 200If PHOTO or SD have been selected under Title Selection, selecting any save data under Archive Selection will move to here.<BR>A list of directories (yellow) and files (white) are displayed under File Selection.<br>Press the A Button when a directory is selected to browse the contents of that directory. Press the A Button when a file is selected to switch to View mode.<br> 201 202Following is the meaning of the information that is displayed at the top of the screen in File Selection. 203 204<table class="table"> 205<tbody> 206<tr><td>Size<td>File size. 207<tr><td>CTime<td>The time the file was created. 208<tr><td>MTime<td>The time the file was last modified. 209<tr><td>ATime<td>The time the file was last accessed. 210<tr><td>Attr<td>File attributes <BR>REA: Read only files<BR>HID: Hidden files<BR>SYS: System files<BR>VOL: Volume level<BR>PRO: Protected files<BR>ARC: Archives 211<tr><td>Very bottom of screen<td>Full path to the selected file. 212</tbody> 213</table> 214 215 216The following operations can be selected on the submenu displayed by pressing the X Button. 217<ul> 218<li>Import ... Imports Save Data</li> 219 <li>Delete: Deletes files and directories</li> 220 <li>Restore: Restores save data</li> 221</ul> 222</P> 223 224<h4>Import</h4> 225<p> 226This operation is valid for directories created with the <CODE>Export</CODE> operation. Note, however, that exported PHOTO directories cannot be imported.<BR>This operation copies data to the Save Data region of system memory. Provided the data does not exceed the size of the Save Data region of system memory, the data copied over by <CODE>Export</CODE> can be imported even if they have been altered. 227</p> 228 229<h4>Delete</h4> 230<p> 231Deletes a file or directory. If a directory is selected, files and directories inside the directory are deleted recursively. 232</p> 233 234<h4>Restore</h4> 235<p> 236This operation is only valid for save data backup files created using the Backup feature. The backup file on the SD card is imported to system NAND memory.<BR>Note that importing backup files will fail in the cases given below. 237 <ul> 238 <li>When the backup file has been modified</li> 239 <li>When the backup file name has been changed</li> 240 <li>When the corresponding application has been deleted</li> 241 <li>When the save data save size of the application in question has changed</li> 242 <li>When <CODE>Delete</CODE> or <CODE>Size0</CODE> has been run on the save data for the application in question (in this case, you can use <CODE>Format</CODE> to import it).</li> 243 </ul> 244</p> 245 246 247 248<H2>View Mode</H2> 249<P> 250<div class="screen"><img class="main" src="NandFiler/Viewer_0.png"></div> 251 252In View mode, you can view file contents. The displayed filename and addresses are shown on the upper screen. <BR>The content of the file (binary values and corresponding characters) is shown on the lower screen.<BR> <BR> 253</P> 254 255<br clear="left"> 256 257 258<p> 259The following specifications apply to the display of characters. 260<ul> 261<li>0x00 can be replaced by 0x20 (by a space)</li> 262<li>0x20 to 0x7A conform to ASCII code</li> 263<li>Other regions display hiragana and katakana (font incorporated as sample)</li> 264</ul> 265</p> 266 267The following table shows what operations you can perform. 268 269<table class="table"> 270<tbody> 271<tr><th>Button<th>Operation 272<tr><td>← →<td>Scrolls one page at a time. 273<tr><td>↑ ↓<td>Scrolls (one line at a time). 274<tr><td>A<td>Switches to Edit mode. 275<tr><td>B<td>Switches to <CODE>Filer</CODE> mode.<BR>If file has been edited in Edit mode, it will be saved. 276</tbody> 277</table> 278 279 280<H2>Edit Mode</H2> 281 282<P> 283<div class="screen"><img class="main" src="NandFiler/Editor_0.png"></div> 284Edit mode lets you edit files.<BR>Take note of the following restrictions. 285</P> 286 287<br clear="left"> 288<h4>Editing restrictions</h4> 289<ul> 290<li>There is no support for changes in file size.</li> 291<li>When the file being edited is larger than 14M, if regions near the start and the end of the file are edited at the same time, earlier changes will not be reflected.</li> 292</ul> 293 294<h3>Non-Editing State</h3> 295<p>This state occurs when entering Edit mode.</p> 296<table class="table"> 297<tbody> 298<tr><th>Button<th>Operation 299<tr><td>← → ↑ ↓<td>Moves the cursor 300<tr><td>A<td>Switches to the editing state 301<tr><td>B<td>Switches to View mode 302</tbody> 303</table> 304 305<h3>Editing State</h3> 306 307<table class="table"> 308<tbody> 309<tr><th>Button<th>Operation 310<tr><td>← → ↑ ↓<td>Moves the cursor 311<tr><td>B<td>Switches to the non-editing state<BR> 312<tr><td>L, R<td>Increase, Decrease value 313</tbody> 314</table> 315 316<P> 317Pressing the L or R Buttons in the editing state will change the value at the current cursor position. Locations where any edits have been made will appear in green. The cursor can be moved freely even in the editing state, but the horizontal range of movement is reduced compared to the non-editing state. To save edits, in View mode, press the B Button and then select <B>Yes</B> from the choices displayed. 318</P> 319<H2>Location</H2> 320<P><CODE>$TwlSDK/bin/ARM9-TS/Rom/NandFiler.srl<br> $TwlSDK/bin/ARM9-TS/Rom/NandFiler.tad</CODE></P> 321 322<H2>See Also</H2> 323 324<H2>Revision History</H2> 325<P> 3262009/05/20 Noted that non-Shift_JIS filenames on an SD Card are not displayed; added sub-banners to Archive Selection; and added the <CODE>Delete</CODE>, <CODE>Size0</CODE>, and <CODE>Format</CODE> features. <br>2009/02/18 Added text related to the <CODE>Break</CODE> feature and <CODE>FS_RESULT_BAD_FORMAT</CODE>. <br>2008/01/13 Added text for the <CODE>Import</CODE> and <CODE>Export</CODE> features. <br>2008/12/08 Mentioned restrictions when editing. <br>2008/11/26 Complied with added screenshots and changes to operations. <br>2008/10/21 Added text for the <CODE>Backup</CODE> and <CODE>Restore</CODE> features. <br>2008/09/16 Added text for the <CODE>Break</CODE> feature. <br>2008/07/18 In <B>Location</B>, changed "Release" to "Rom." <br>2008/07/14 Changed terminology. <br>2008/07/07 Initial version.<br> 327</P> 328<hr><p>CONFIDENTIAL</p></body> 329</HTML>