TWL-SDK Revision History


TWL-SDK 5.1 Release Version (2009/02/27)
Note 71-01:(DSP) Updated the audio and graphics components
Note 71-02:(DevEnv) Fixed a problem in the arena region of expanded main memory
Note 71-03:(GX) Clarified the group of functions that ignore settings when the LCD is in the OFF state
Note 71-04:(MATH) Revised the TWL-SDK Migration Guide
Note 71-05:(MB) Fixed the HYBRID Card application clone boot
Note 71-06:(MB) Fixed the multiboot-Model and fake_child sample demos
Note 71-07:(OS) Added a process to wait for the divider to end when loading context
Note 71-08:(PM) Fixed interrupt-specific problem with PM_ForceToPowerOff
Note 71-09:(SSP) Corrected the JPEG decoding process
Note 71-10:(SSP) Fixed problem with SSP_StartJpegEncoderWithEncodeData
Note 71-11: (TOOL) Fixed tad2rom
Note 71-12:(WM) Corrected sample demos
Known Issues in NITRO-SDK version 5.1 Release Version
TWL-SDK 5.1 RC (2009/02/10)
Note 70-01:(CTRDG) Made CTRDG_Init a weak function
Note 70-02:(DevEnv) Revised the TWL-SDK Transition Guide
Note 70-03:(FS) Split up the FAT driver initialization functions
Note 70-04:(FS) Fixed a bug in the FS_SetSeekCache function
Note 70-05:(FS) Fixed a bug specific to system shutdown
Note 70-06:(FS) Fixed a bug specific to working with long path names
Note 70-07:(GX) Revised the GX_SetDefaultNDMA function
Note 70-08:(MB) Reduced the amount of memory consumed when using MB parent
Note 70-09:(PM) Added a note to the PM_SetLCDPower Function Reference
Note 70-10:(SND) Added API for changing sound volume
Note 70-11:(STD) Revised the STD_SearchChar* functions
Note 70-12:(TOOL) Changed NandFiler
Note 70-13:(TOOL) Added a method for displaying the size of NAND applications in TwlNmenu
Note 70-14: (TOOL) Revised WMTestTool
Note 70-15:(TOOL) Changed makerom.TWL
Note 70-16:(TOOL) Deleted mb_child_simple.srl
Note 70-17:(TOOL) Added mb_child for separate operating environments
Note 70-18:(WFS) Fixed a bug in child end process
Note 70-19:(WM) Added the rssi member to the WMPortRecvCallback structure
Note 70-20:(MISC) Revised the sample demos
Known Issues in NITRO-SDK Version 5.1 RC
TWL-SDK 5.1 PR2 (2009/01/15)
Note 69-01:(CAMERA) Revised demo
Note 69-02:(CARD) Strengthened card access determination
Note 69-03:(DSP) Changed the DSP_PlayShutterSound function
Note 69-04:(DevEnv) Updated the TWL-SDK Transition Guide
Note 69-05:(EL) Added the EL_CalcEnoughBufferSizeforLink* functions
Note 69-06:(EL) Added the EL_GetResultCode function
Note 69-07:(EL) Revised the EL_Unlink function
Note 69-08:(FS) Added the FS_ForceToEnableLatencyEmulation function
Note 69-09:(GX) Corrected the Sub_Double3D sample demo
Note 69-10:(MB) Added text about the pseudo-Download Play feature
Note 69-11:(NA) Updated the NAND Application Development Manual
Note 69-12:(OS) Expanded OSMutex
Note 69-13:(PM) Made revisions specific to turning off the LCD
Note 69-14:(SND) Added the SNDEX_GetCurrentVolume[Async] functions
Note 69-15:(SND) Restricted repeated execution of SNDEX_SetVolume[Async] functions
Note 69-16:(SND) Fixed method of exclusive control when continuously playing shutter sound
Note 69-17:(SSP) Added the SSP_ExtractJpegDecoderExif function
Note 69-18:(SSP) Fixed a bug in the SSP_StartJpegDecoder function
Note 69-19:(SSP) Fixed a bug in the SSP_StartJpegDecoder function
Note 69-20:(SSP) Integrated the demos
Note 69-21:(TOOL) Added features to NandFiler for importing and exporting Save Data
Note 69-22:(TOOL) Changed makerom.TWL
Note 69-23:(TOOL) Added the tad2rom tool
Note 69-24:(WM) Fixed a problem with the execution of the WM_SetMPDataToPort function callback
Known Problems with SDK 5.1 PR2
TWL-SDK 5.1 PR (2008/12/10)
Note 68-01:(CAMERA) Fixed infinite loop bug in CAMERA_Init function
Note 68-02:(CARD) Changed the default settings of the cache disable operations
Note 68-03:(CARD) Added functions to determine operating mode
Note 68-04:(CRYPTO) Changed the padding method for RSA encryption
Note 68-05:(CRYPTO) Changed the library's section placement
Note 68-06:(DSP) Fixed a bug in the DSP_PlaySound function
Note 68-07:(DSP) Revised the timing of shutter sound playback
Note 68-08:(DSP) Fixed a problem with stereo sound playback
Note 68-09:(DSP) Restricted playable shutter sound data
Note 68-10:(DevEnv) Added documentation for ARM7 components
Note 68-11:(DevEnv) Added ARM7 component
Note 68-12:(DevEnv) Corrected the BuildFinalRom demo
Note 68-13:(DevEnv) Added build switch to disable IS-NITRO-DEBUGGER debug features
Note 68-14:(DevEnv) Made revisions relating to NITRO build Static segment
Note 68-15:(DevEnv) Added guide for transition from NITRO-SDK
Note 68-16:(ENV) Corrected API name of ENV_SetResourceSetArray function
Note 68-17:(FS) Added the FS_ATTRIBUTE_IS_OFFLINE flag
Note 68-18:(FS) Fixed a bug in the FS_GetSeekCacheSize function
Note 68-19:(FS) Fixed bugs in the FS_SetSeekCache and FS_SeekFile functions
Note 68-20:(FS) Revised the overlay-staticinit demo
Note 68-21:(FS) Added functions to determine archive status
Note 68-22:(FS) Made revisions specific to cache operation when accessing files
Note 68-23:(GX) Revised the Sub_Double3D sample demo
Note 68-24:(MB) Added formal support for HYBRID program clone boot feature
Note 68-25:(NA) Revised the NA_LoadSharedFontTable function
Note 68-26:(OS) Made OS_GetSerialNo a private function
Note 68-27:(OS) Changed the OS_ResetSystem function process
Note 68-28:(OS) Revised references to arena and protection region
Note 68-29:(OS) Revised functions that get Parental Control status
Note 68-30:(PM) Added the pm-2 demo
Note 68-31:(PM) Added exclusive control for hardware reset and application jumps
Note 68-32:(PM) Fixed a bug with hardware reset
Note 68-33:(SND) Prohibited changing DSPMixRate during shutter sound playback
Note 68-34:(SND) Prohibited execution of SNDEX functions during shutter sound playback
Note 68-35:(SND) Fixed a problem related to the execution of multiple SNDEX functions
Note 68-36:(SND) Corrected return value typo in asynchronous function references
Note 68-37:(SSP) Revised behavior in HYBRID build NITRO mode
Note 68-38:(SSP) Privatized the JPEG encode/decode signature feature
Note 68-39:(SSP) Added the SSP_ConvertJpegEncodeData and SSP_StartJpegEncoderWithEncodeData functions
Note 68-40:(TOOL) Fixed bugs in NandFiler
Note 68-41:(TOOL) Added a TWL version of mb_child.srl
Note 68-42:(TOOL) Added a TWL screen banner viewer to addbanner
Note 68-43: (TOOL) Revisions to buryarg.TWL
Note 68-44:(TOOL) Expanded cmptad functionality
Note 68-45:(TOOL) Enhanced error-checking functionality of compstatic tool
Note 68-46:(TOOL) Revised makebanner and makebanner.TWL
Note 68-47: (TOOL) Changed makerom.TWL.exe
Note 68-48:(TOOL) Changed makerom.exe
Note 68-49:(TOOL) Added functionality to showversion to display build mode
Note 68-50:(TOOL) Added background graphic for banner previewing
Note 68-51:(WM) Fixed a bug in MP communication during component overload
Note 68-52:(WM) Changed behavior for Wireless OFF mode
Note 68-53:(WVR) Fixed a bug in Wireless library shutdown in switchover demo
Note 68-54: (MISC) Changed part of the banner format
Known Issues in NITRO-SDK Version 5.1 PR
TWL-SDK 5.0 Release Version (2008/10/23)
Note 67-01: (CAMERA) Corrected error handling for simpleShoot-1, simpleShoot-2
Note 67-02: (CAMERA) Revised the simpleShoot-2 demo
Note 67-03: (CARD) Support for parent backup device
Note 67-04: (DSP) Revised synchronous version of the DSP graphics component function
Note 67-05: (DSP) Corrected inconsistency in the results of the DSP_Scaling* and DSP_CalcScalingFactor* functions
Note 67-06: (DSP) Revised termination process for each DSP component
Note 67-07:(DevEnv) Updated documents specific to the build switch
Note 67-08: (FS) Improved open determination for TWL-exclusive files
Note 67-09: (MB) Added a switch for the build mode on multiboot-wfs distributed child devices
Note 67-10: (MI) Added the MI_SendNDmaGXCommand* functions
Note 67-11:(OS) Added the OS_IsCodecTwlMode function
Note 67-12: (OS) Added the demo for the OS_JumpTo* functions
Note 67-13: (OS) Added a function to get the status of parental controls
Note 67-14: (OS) Movement of the function reference's Operating Environment section
Note 67-15: (PM) Added exclusive control for hardware resets and application jumps
Note 67-16: (PM) Revised Power Button process
Note 67-17: (SCFG) Adjusted SCFG functions
Note 67-18: (SND) Abolished headphone mute when setting the IIR filter (targeting microphone input)
Note 67-19: (SND) Fixed a SNDEX_SetVolumeSwitchCallback function bug
Note 67-20: (SND) Added functionality to the extraFunc demo
Note 67-21: (SSP) NITRO mode support for the JPEG library
Note 67-22: (SSP) Added error processing for the SSP_StartJpegEncoder function
Note 67-23: (STD) Handled a bug where the STD_CompareNString function would not return correct values
Note 67-24: (STD) Revised the STD_ConvertAsciiToInt and STD_ConvertAsciiToLong functions
Note 67-25: (STD) Revised the STD_TSNPrintf, STD_TSPrintf, STD_TVSNPrintf, and STD_TVSPrintf functions
Note 67-26: (STD) Revised the STD_TSScanf and STD_TVSScanf functions
Note 67-27: (TOOL) Added backup and restore features for saved data in NandFiler
Note 67-28: (TOOL) Added the ability to import from DS cards to TwINmenu
Note 67-29: (TOOL) Added the cmptad tool
Note 67-30: (TOOL) Added makebanner.exe and makebanner.TWL.exe warnings
Note 67-31: (TOOL) Added makelst and stripdebug references
Note 67-32: (TOOL) Changed makerom.TWL.exe
Note 67-33: (TOOL) Added a feature to maketad to create an SRL file for writing to a DS card
Note 67-34: (TWL Wireless) Fixed a bug where the system would hang when a reset is applied during TWL wireless communication
Known Issues in NITRO-SDK version 5.0 Release Version

TWL-SDK Version 5.1 Official Release

(2009/02/27)


Note 71-01:(DSP) Updated the audio and graphics components

The DSP's internal data transfer process was updated, so the components have also been updated.


Note 71-02:(DevEnv) Fixed a problem in the arena region of expanded main memory

In TWL mode, even if the auto-load module was placed in expanded main memory, this would not be taken into consideration and the expanded main memory arena would be allocated from the start of expanded main memory. This problem was corrected by revising the lcf template file.


Note 71-03:(GX) Clarified the group of functions that ignore settings when the LCD is in the OFF state

When the LCD display is in the OFF state the GX circuitry clock is paused, so settings configured during that time are ignored in a number of functions.
This fact has been added to the reference information for the following functions.


Note 71-04:(MATH) Revised the TWL-SDK Migration Guide

Added the section 2.11 MATH MD5 Function Not Recommended to the document $TwlSDK/docs/TechnicalNotes/AboutNitroToTwl.pdf.


Note 71-05:(MB) Fixed the HYBRID Card application clone boot

When a HYBRID-build card application operating in the hardware environment conducted a clone boot, the process would forcibly stop on a CARD library validity check. This problem, which was caused by unnecessary ROM access, has been fixed.


Note 71-06:(MB) Fixed the multiboot-Model and fake_child sample demos

During initialization of the multiboot-Model and fake_child demos, if the call to the GX_VBlankIntr function was late and the child became mb_child_***.srl, sometimes the screen after the boot would not display. This problem has been fixed.

Also, the build modes in multiboot-Model were restricted to NITRO mode for no reason, so this restriction was eliminated.


Note 71-07:(OS) Added a process to wait for the divider to end when loading context

When OS_LoadContext was called while operating in TWL mode, sometimes the process would exit from the function without waiting for the end of the divider's calculation after the context was loaded. To correct this, the process now waits for the calculation to end when operating in TWL mode.


Note 71-08:(PM) Fixed interrupt-specific problem with PM_ForceToPowerOff

When the PM_ForceToPowerOff function was called to turn the power off at a time when interrupts were prohibited and the LCD was in the OFF state, the program would halt.
This problem has been fixed.


Note 71-09:(SSP) Corrected the JPEG decoding process

For some images, the JPEG decoding process would not yield the intended decoding result. This has been corrected.


Note 71-10:(SSP) Fixed problem with SSP_StartJpegEncoderWithEncodeData

When JPEG encoding was performed using the SSP_StartJpegEncoderWithEncodeData function, the thumbnails could not be created correctly. This has been fixed.


Note 71-11: (TOOL) Fixed tad2rom

The program would crash if the argument did not contain the forward slash ( / ). This problem has been fixed.


Note 71-12:(WM) Corrected sample demos

In the following sample demos, the port number used for wireless communications differed from the corresponding demos contained in Revolution SDK Extension. This prevented normal communications between Wii and DS systems, and has been fixed.


Known Issues in NITRO-SDK version 5.1 Release Version


TWL-SDK Version 5.1 RC

(2009/02/10)


Note 70-01:(CTRDG) Made CTRDG_Init a weak function

The CTRDG_Init function could be called from the OS_Init function without using any CTRDG functions. A number of CTRDG functions would then be linked, taking up a large amount of memory.
The CTRDG_Init function has been converted to a weak function. For applications that do not access Game Paks, definitions can be altered to reduce the amount of memory taken up by the CTRDG library.
For more information, see the CTRDG_DummyInit function.


Note 70-02:(DevEnv) Revised the TWL-SDK Transition Guide

Added information to sections 3.1 and 5.1 in the $TwlSDK/docs/TechnicalNotes/AboutNitroToTwl.pdf documentation, mentioning that the library uses more memory when you transition from NITRO-SDK to TWL-SDK NITRO or HYBRID ROM.


Note 70-03:(FS) Split up the FAT driver initialization functions

Because normal card-boot applications do not use NAND system memory or an SD memory card, the FAT driver initialization function has been split up so applications do not link to FAT drivers when they do not need to.
If your HYBRID build card-boot application uses NAND system memory or an SD memory card, you need to call the FS_InitFatDriver function in addition to the FS_Init function.


Note 70-04:(FS) Fixed a bug in the FS_SetSeekCache function

If the address for the start or the end of the buffer specified by the FS_SetSeekCache function did not align with the cache boundary, subsequent seek operations were unpredictable. This bug has been fixed.
Accordingly, the FS_GetSeekCacheSize function now returns a 64-byte value to accommodate cache boundary padding.


Note 70-05:(FS) Fixed a bug specific to system shutdown

If the power button was pressed while a 2 MB or larger file was being written or read from NAND system memory, the shutdown sequence occasionally would not complete. That bug has been fixed.


Note 70-06:(FS) Fixed a bug specific to working with long path names

When dealing with path names that reached the FAT upper limit of 255 characters, operations that should succeed would occasionally return FS_RESULT_NO_ENTRY and fail. That bug has been corrected.


Note 70-07:(GX) Revised the GX_SetDefaultNDMA function

When a HYBRID build was operating in NITRO mode, the GX_SetDefaultNDMA function would be called. That has been corrected.


Note 70-08:(MB) Reduced the amount of memory consumed when using MB parent

The buffer used for scanning when using MB child functionality (DS Download Play only) was also linked when using MB parent functionality. To reduce memory consumption, this has been revised so the buffer is not linked when it is not needed.


Note 70-09:(PM) Added a note to the PM_SetLCDPower Function Reference

As a result of the revision described in Note 69-13, you no longer need to make a separate call to the GX_DispOn function when you use the the PM_SetLCDPower function to turn the LCD back on. This has been added to the function reference.


Note 70-10:(SND) Added API for changing sound volume

Two functions, SNDEX_SetIgnoreHWVolume and SNDEX_ResetIgnoreHWVolume, have been added. They allow you to preset a value that you want to use to change the sound volume, to temporarily change to that value, and to revert back to the original volume.
You need to conform to the Programming Guidelines when using these two functions.

In addition, the $TwlSDK/build/demos.TWL/snd/ignoreHWVolumeDemo sample demo has been added. The demo uses these two functions to play sounds at the specified volume for a specified time.


Note 70-11:(STD) Revised the STD_SearchChar* functions

Revised the STD_SearchChar and STD_SearchCharReverse functions to enable searching for null characters.


Note 70-12:(TOOL) Changed NandFiler

Made the following changes to NandFiler:


Note 70-13:(TOOL) Added a method for displaying the size of NAND applications in TwlNmenu

Added the display of the overall size (TitleSize) of an imported NAND application in units of KB.


Note 70-14: (TOOL) Revised WMTestTool

Sometimes the system would freeze on scanEx test in the WMTestTool. That bug has been corrected.


Note 70-15:(TOOL) Changed makerom.TWL

Made the following changes to makerom.TWL.


Note 70-16:(TOOL) Deleted mb_child_simple.srl

Deleted the mb_child_simple.srl independent downloader in combination with renaming the mb_child program.


Note 70-17:(TOOL) Added mb_child for separate operating environments

Added mb_child_[NITRO|TWL].srl for IS-NITRO-EMULATOR and the NITRO environment, and for IS-TWL-DEBUGGER and the TWL environment, each with the same specification as the respective DS Download Play specifications.
The mb_child included up until the previous version is the same as the newly added mb_child_TWL.srl.


Note 70-18:(WFS) Fixed a bug in child end process

When WFS for a child was ended by a call to the WFS_EndClient function, and a ROM archive was subsequently accessed, the process would stop on a data access exception.


Note 70-19:(WM) Added the rssi member to the WMPortRecvCallback structure

The rssi member has been added to the WMPortRecvCallback structure to get information about receiver sensitivity for data (frames) received during MP communication.


Note 70-20:(MISC) Revised the sample demos

Revised a number of sample demos that randomly called OS_SetIrqMask to control interrupts during program initialization.


Known Issues in NITRO-SDK Version 5.1 RC


TWL-SDK Version 5.1 PR2

(2009/01/15)


Note 69-01:(CAMERA) Revised demo

A portion of the CAMERA library demo did not comply with the camera specifications. That has been corrected.


Note 69-02:(CARD) Strengthened card access determination

Strengthened the library's internal determination process so programs that start in any mode other than Card Boot do not inadvertently access DS Cards that are in an unknown state.


Note 69-03:(DSP) Changed the DSP_PlayShutterSound function

Until now, FALSE was returned when forced output of the sound failed inside the DSP_PlayShutterSound function. That has been changed so the process is now retried inside the function until it is successful.

With this revision, the DSP_PlayShutterSound function now only returns FALSE when the specified shutter sound does not match the I2S operating frequency.


Note 69-04:(DevEnv) Updated the TWL-SDK Transition Guide

Text about the Static module in NITRO ROM has been deleted from $TwlSDK/docs/TechnicalNotes/AboutNitroToTwl.pdf because it is not needed starting with TWL-SDK 5.1 PR.
In addition, some of the text about ROM archives in NAND applications was edited for accuracy.


Note 69-05:(EL) Added the EL_CalcEnoughBufferSizeforLink* functions

The following functions have been added to calculate the size of buffers needed for dynamic links.


Note 69-06:(EL) Added the EL_GetResultCode function

Added the EL_GetResultCode function, which can be used to get details about the result of the process last performed by EL.


Note 69-07:(EL) Revised the EL_Unlink function

The EL_Unlink function always returned 0, regardless of success or failure. That has been corrected.


Note 69-08:(FS) Added the FS_ForceToEnableLatencyEmulation function

Added the FS_ForceToEnableLatencyEmulation function to forcibly enable the feature to simulate waits because the feature is disabled for the FINALROM build.


Note 69-09:(GX) Corrected the Sub_Double3D sample demo

The previous correction to the Sub_Double3D demo (Note 68-23) was updated. The same kind of correction was made to DEMOLib.


Note 69-10:(MB) Added text about the pseudo-Download Play feature

Added an overview of the MB library's pseudo-Download Play functionality and an explanation of the fake_childsample that uses this to $TwlSDK/docs/technicalNotes/AboutMultiBoot.pdf.


Note 69-11:(NA) Updated the NAND Application Development Manual

Added a precaution about simple debugging in section 6.2 of $TwlSDK/docs/TechnicalNotes/NandAppManual.pdf.
Note that a NAND application executed from an SRL file on IS-TWL-DEBUGGER will behave differently than the released version.


Note 69-12:(OS) Expanded OSMutex

Added implementations of read/write lock to mutex in the OS library.
The following functions have been added.

This change was actually implemented in the 5.1 PR version, but it was left out of the changelog file.


Note 69-13:(PM) Made revisions specific to turning off the LCD

In order to turn the LCD off with the PM_SetLCDPower function, a call must be made to the GX_DispOff function. PM_SetLCDPower has been revised so that it internally calls GX_DispOff if it is not called by the application.


Note 69-14:(SND) Added the SNDEX_GetCurrentVolume[Async] functions

There are now two types of sound volume values: the sound volume of the console, and the pending sound volume (see also Note 69-15).
Therefore, the SNDEX_GetCurrentVolume[Async] functions have been added to get the current console volume value.
The SNDEX_GetVolume[Async] functions get the pending volume value. If there is no pending value they get the current value.

The pending volume value is applied after several frames, so if SNDEX_SetVolume[Async] functions are being frequently used, or if you do not want to get the exact sound volume of the console at the time the function is called, there is no need to use theSNDEX_GetCurrentVolume[Async] functions.


Note 69-15:(SND) Restricted repeated execution of SNDEX_SetVolume[Async] functions

There is a limit to the number of times that the sound volume value can be stored in dedicated nonvolatile memory, so restrictions have been placed on the SNDEX_SetVolume[Async] functions. Sound volume values set by functions are held pending for roughly 10 frames before they are written. After the pending time has ended the value that is written is the value that was most recently set.


Note 69-16:(SND) Fixed method of exclusive control when continuously playing shutter sound

When the operation for continuous playback of shutter sound was repeated, exclusive control inside the SND library did not work well and the process would stop on a Panic. That bug has been fixed.


Note 69-17:(SSP) Added the SSP_ExtractJpegDecoderExif function

Added the SSP_ExtractJpegDecoderExif function for extracting only EXIF information from JPEG files.


Note 69-18:(SSP) Fixed a bug in the SSP_StartJpegDecoder function

Fixed a bug that caused the SSP_StartJpegDecoder function to halt internally for certain files.


Note 69-19:(SSP) Fixed a bug in the SSP_StartJpegDecoder function

Fixed the problem of an internal stack overflow that occurred when the SSP_StartJpegDecoder function was used on certain files.


Note 69-20:(SSP) Integrated the demos

Integrated the SSP demos now that there is no need for separate TWL and NITRO versions (as per the change described in Note 68-37).


Note 69-21:(TOOL) Added features to NandFiler for importing and exporting Save Data

It is now possible to import and export data between SD cards and both the NAND application Save Data region and the PHOTO directory.
(The PHOTO directory data can only be exported.)
With this added functionality, you can now use Save Data that has been modified on a PC during debugging.


Note 69-22:(TOOL) Changed makerom.TWL

The JpegSign property in makerom.TWL does not always have to be set TRUE, so it has been made private.
This change was added in the 5.1 PR version, but it was left out of the changelog.


Note 69-23:(TOOL) Added the tad2rom tool

The tad2rom tool has been added for writing TAD-encapsulated SRL files.
This differs from the -n option of maketad because a TAD file can be used as input.
The resulting SRL file can only be used when Card mode is added to TwINmenu.


Note 69-24:(WM) Fixed a problem with the execution of the WM_SetMPDataToPort function callback

During MP communications, if the parent was reset and communications were cut, the callback registered by the WM_SetMPDataToPort function would never execute. That bug has been fixed.


Known Problems with SDK 5.1 PR2


TWL-SDK Version 5.1 PR

(2008/12/10)


Note 68-01:(CAMERA) Fixed infinite loop bug in CAMERA_Init function

Even when the camera cannot be used, for example when ferret.TWL is being used as an ARM7 component, the CAMERA_Init function can enter an infinite loop during its internal processing. To fix this bug, the function now fails initialization and returns an error in such cases.


Note 68-02:(CARD) Changed the default settings of the cache disable operations

In order to improve the efficiency of the ROM data loading process, the default threshold value for disabling cache has been changed to 1 KB for IC and 9 KB for DC, and the instruction cache is not disabled.

In addition, added the CARD_SetCacheFlushFlag function to change these settings with the program.


Note 68-03:(CARD) Added functions to determine operating mode

The following functions have been added to determine the executable operating mode from the ROM header information.


Note 68-04:(CRYPTO) Changed the padding method for RSA encryption

Starting with PKCS#1 v1.5, padding is now used for RSA encryption and decryption.
Be aware that prior data encrypted by CRYPTO RSA can no longer be decrypted.


Note 68-05:(CRYPTO) Changed the library's section placement

The location of part of the CRYPTO library has been changed to the ltdmain region.
This affects the usable space in those memory regions.


Note 68-06:(DSP) Fixed a bug in the DSP_PlaySound function

When the DSP_PlaySound function played sounds, sometimes as much as 10 milliseconds was cut off and not output. That bug has been fixed.


Note 68-07:(DSP) Revised the timing of shutter sound playback

The sound quality changed when the shutter sound was played with the headphones attached.

This problem was resolved by adding a wait before the shutter sound is played back.


Note 68-08:(DSP) Fixed a problem with stereo sound playback

When the DSP_PlaySound or DSP_PlayShutterSound functions were used to play stereo sound, the left and right channels were switched. That issue has been fixed.
This does not affect the camera shutter sound, which is monaural.


Note 68-09:(DSP) Restricted playable shutter sound data

Guidelines regulate the playback of DSP shutter sounds. A check feature has been added to the DSP_PlayShutterSound function to make sure that shutter sounds are not played if the frequency is different from the I2S setting.
Therefore, the specification for stereo/monaural has been removed from the arguments of the DSP_PlayShutterSound function, and the following sound data has been deleted.


Note 68-10:(DevEnv) Added documentation for ARM7 components

The following documentation about the ARM7 components has been added.
$TwlSDK/docs/TechnicalNotes/AboutComponents.pdf


Note 68-11:(DevEnv) Added ARM7 component

Added ferret.TWL to the ARM7 components.
Like racoon.TWL, this component can only be used when creating TWL-exclusive applications.
This new component is more compact than racoon.TWL because it omits the features for wireless communications and use of the camera.


Note 68-12:(DevEnv) Corrected the BuildFinalRom demo

Because libsyscall.twl.a now makes use of items that belong to the TWL-SDK, it has been deleted from $TwlSDK/build/demos/tips/BuildFinalRom.
For more information, read the TWL-SDK application development guide, $TwlSDK/docs/TechnicalNotes/AboutTwlApplication.pdf.


Note 68-13:(DevEnv) Added build switch to disable IS-NITRO-DEBUGGER debug features

A build switch has been added so you can reduce the amount of memory used by the TWL-SDK in a development environment where debugging is carried out only by IS-TWL-DEBUGGER. The switch disables the IS-NITRO-DEBUGGER debug features and circumvents unnecessary library links.


Note 68-14:(DevEnv) Made revisions relating to NITRO build Static segment

In programs built as NITRO-only titles, the default address of the Static segment was defined as 0x02000400. Because this includes an unused region of 1KB, it has been revised to 0x02000000.

This revision does not affect the behavior of the application, but it increases the available arena region by 1KB.


Note 68-15:(DevEnv) Added guide for transition from NITRO-SDK

The following new document explains how to transition from NITRO-SDK to TWL-SDK,
$TwlSDK/docs/TechnicalNotes/AboutNitroToTwl.pdf


Note 68-16:(ENV) Corrected API name of ENV_SetResourceSetArray function

The ENV_SetResourceSetArray function had the wrong API name. The reference and the API name have been corrected.

The API name that was in effect before this correction can still be used, so this change does not require you to revise existing code.


Note 68-17:(FS) Added the FS_ATTRIBUTE_IS_OFFLINE flag

Added the FS_ATTRIBUTE_IS_OFFLINE flag, which provides an easy way to determine whether a file is located in the TWL-only region in the NITRO environment.

This flag is returned as one of the entry attributes by the FS_ReadDirectory and FS_GetPathInfo functions.


Note 68-18:(FS) Fixed a bug in the FS_GetSeekCacheSize function

When the file size was not divisible by the cluster size, the FS_GetSeekCacheSize function would return a value that was 1-cluster too small. That bug has been fixed.


Note 68-19:(FS) Fixed bugs in the FS_SetSeekCache and FS_SeekFile functions

Both the FS_SetSeekCache and FS_SeekFile functions would sometimes read outside the region for the seek cache.


Note 68-20:(FS) Revised the overlay-staticinit demo

In the $TwlSDK/build/demos/fs/overlay-staticinit sample demo, the upper and lower screens were reversed. That has been fixed.


Note 68-21:(FS) Added functions to determine archive status

The following group of functions has been added to determine whether archives exist and whether they are available.


Note 68-22:(FS) Made revisions specific to cache operation when accessing files

When the FS_ReadFileAsync function was used to asynchronously read a NAND or SD card archive file, if the specified buffer address was not 32-byte aligned, the beginning of the data would be cached. That bug has been fixed.

The function reference was also edited to explain that if the buffer is referenced before the read process is completed, the consistency between the actual data and the cache will be lost.


Note 68-23:(GX) Revised the Sub_Double3D sample demo

When the $TwlSDK/build/demos/gx/UnitTours/Sub_Double3D sample demo alternately showed the captured image and the original image, there was no way to deal with screen flicker. This has been fixed.


Note 68-24:(MB) Added formal support for HYBRID program clone boot feature

Revised the internal operations of the MB library and the emuchild.exe tool so now HYBRID mode programs can also use the clone boot feature.


Note 68-25:(NA) Revised the NA_LoadSharedFontTable function

Fixed the NA_LoadSharedFontTable function so it can be called more than once.
In line with this change, pBuffer can now be deallocated after the function succeeds.


Note 68-26:(OS) Made OS_GetSerialNo a private function

The OS_GetSerialNo function, which is used to get the WL product serial number, is now private because it is not appropriate for use in applications.


Note 68-27:(OS) Changed the OS_ResetSystem function process

The OS_ResetSystem function design prohibited interrupts after DMA completion. The order has been changed, so now interrupts are prohibited before DMA completion.


Note 68-28:(OS) Revised references to arena and protection region

In the OS Reference Manual, the memory maps in the overviews for the arena and protection region were revised to reflect the fact that the start of main memory is a system-reserved region.


Note 68-29:(OS) Revised functions that get Parental Control status

The following functions, which get Parental Control status, have all been changed to return FALSE when Parental Control settings have not been entirely configured in the console.


Note 68-30:(PM) Added the pm-2 demo

Added the $TwlSDK/build/demos.TWL/spi/pm-2 sample.
This sample demo uses the PM_SetAutoExit function to enable a choice between immediately shutting down via the POWER button or delaying shutdown until the user's process ends.


Note 68-31:(PM) Added exclusive control for hardware reset and application jumps

If the power button is pressed or a battery-low interrupt is detected during a hardware reset or a application jump, the latter process is now given priority.


Note 68-32:(PM) Fixed a bug with hardware reset

If a hardware reset was conducted during the execution of certain SNDEX functions (for example, SNDEX_SetI2SFrequencyAsync and SNDEX_SetIirFilterAsync), the hardware reset would not complete. That bug has been fixed.


Note 68-33:(SND) Prohibited changing DSPMixRate during shutter sound playback

When the shutter sound is being played by the DSP_PlayShutterSound function, the DSPMixRate setting is temporarily altered inside the library. Depending on the timing of the call to the SNDEX_SetDSPMixRate[Async] functions, this setting was occasionally overwritten. The process has been revised so that now when the SNDEX_SetDSPMixRate[Async] functions are called during shutter sound playback, the function returns SNDEX_RESULT_EXCLUSIVE.


Note 68-34:(SND) Prohibited execution of SNDEX functions during shutter sound playback

If a series of processes using SNDEX functions are conducted before and after the playback of shutter sounds, an interrupt by another SNDEX function during the midst of this series can, depending on the timing, leave the system in an unknown state. To fix this bug, the SNDEX functions (with some exceptions) now return SNDEX_RESULT_EXCLUSIVE and fail if they execute while shutter sounds are being played by the DSP_PlayShutterSound function. Note that this revision does not guarantee success of shutter sound playback. In fact, if the DSP_PlayShutterSound function executes while SNDEX functions are processing, it will fail due to exclusive control by the SNDEX library.


Note 68-35:(SND) Fixed a problem related to the execution of multiple SNDEX functions

The SNDEX library's exclusive control was incomplete. When multiple SNDEX functions were executed in parallel, sometimes an internal state would become invalid and an error would return, regardless of the success or failure of the process in ARM7.
This problem has been corrected.


Note 68-36:(SND) Corrected return value typo in asynchronous function references

The references of the asynchronous functions stated that SNDEX_PXI_RESULT_EXCLUSIVE was returned as the processing result, but that is incorrect. The references have been revised to read that the return value is SNDEX_RESULT_EXCLUSIVE.
Since these two constants are equivalent, the correct behavior will result even if the incorrect notation is used.


Note 68-37:(SSP) Revised behavior in HYBRID build NITRO mode

With the HYBRID build, the SSP library could not be used in NITRO mode. That has been fixed.


Note 68-38:(SSP) Privatized the JPEG encode/decode signature feature

The guidelines now prohibit the use of the signature feature in JPEG files in ROM archives, so the following signature-related functions have been made private.


Note 68-39:(SSP) Added the SSP_ConvertJpegEncodeData and SSP_StartJpegEncoderWithEncodeData functions

Divided the encoding function, SSP_StartJpegEncoder, into a pre-encoding process and a process of actual encoding. These are the SSP_ConvertJpegEncodeData and SSP_StartJpegEncoderWithEncodeData functions.


Note 68-40:(TOOL) Fixed bugs in NandFiler

Restore did not work with Save Data titles that had a '9' in their game code. That bug has been fixed.


Note 68-41:(TOOL) Added a TWL version of mb_child.srl

Added mb_child.srl, which behaves almost the same as DS Download Play in the DSi.
Signature-verification of downloaded child applications has been omitted so a Download Play child can be started on a development console.


Note 68-42:(TOOL) Added a TWL screen banner viewer to addbanner

Added a feature to addbanner for checking how banners appear on the actual TWL screen.
For more information, see the addbanner manual.


Note 68-43: (TOOL) Revisions to buryarg.TWL

Argument data was not embedded correctly when buryarg.TWL specified a destination of standard output. That has been fixed.


Note 68-44:(TOOL) Expanded cmptad functionality

Added a feature to the cmptad tool to compare the identity of an SRL included in a TAD file and a specified SRL.


Note 68-45:(TOOL) Enhanced error-checking functionality of compstatic tool

The compstatic tool supports the ability to embed an overlay digest value table in a binary file. If you use this feature without preparing a region for embedding, the wrong region can be destroyed and unexpected behavior may occur.
This bug has been fixed, and incorrect usage is now detected as an error.


Note 68-46:(TOOL) Revised makebanner and makebanner.TWL

Since kanji characters cannot be used for game titles in banners, a warning is now displayed when kanji characters are included.
However, the check for kanji is not performed on banners for China (version 2).


Note 68-47:(TOOL) Made changes to makerom.TWL.exe

The following changes have been made to makerom.TWL.exe.


Note 68-48:(TOOL) Changed makerom.exe

An error is now generated when the banner specification is not an NTR banner.


Note 68-49:(TOOL) Added functionality to showversion to display build mode

In addition to existing information, the target (ARM9, ARM7) and build mode (DEBUG, RELEASE, FINALROM) are now shown.
An error is displayed if different build modes are mixed.


Note 68-50:(TOOL) Added background graphic for banner previewing

Added the following background graphic so the created banner can be previewed on the same screen as the DSi menu using the TWL-System NITRO-Viewer.
$TwlSDK/build/demos.TWL/tips/TWLBanner_anim1/banner/SDK_demo


Note 68-51:(WM) Fixed a bug in MP communication during component overload

MP communications would be cut when the component load became unusually high. That bug has been fixed.


Note 68-52:(WM) Changed behavior for Wireless OFF mode

The timing of errors returned from the WM library differed for TWL systems running in Wireless OFF mode and NITRO systems running with wireless communications prohibited. The same process can now be used to determine whether the use of wireless communications is prohibited.


Note 68-53:(WVR) Fixed a bug in Wireless library shutdown in switchover demo

There was a problem with the Wireless library quit process when transitioning from the WC library to the WH library. That has been fixed.


Note 68-54: (MISC) Changed part of the banner format

Along with the partial changes to the banner format, the following functions and tools have been revised so they now generate an error when the configured animation data is invalid.

For more information, see the $TwlSDK/man/ja_JP/tools/bannercvtr manual.


Known Issues in NITRO-SDK Version 5.1 PR



TWL-SDK Version 5.0 Official Release

(2008/10/23)


Note 67-01: (CAMERA) Corrected error handling for simpleShoot-1, simpleShoot-2

The DSP_PlayShutterSound function would sometimes fail when using the camera to continuously capture images with the simpleShoot-1 and simpleShoot-2 demos. That failure would result in an OS_Panic function termination.
However, actual use of the DSP_PlayShutterSound function assumed that the user would try until an image was successfully captured. Corrections reflect that.

This change was added in version 5.0 RC3, but it was left out of the changelog.


Note 67-02: (CAMERA) Revised the simpleShoot-2 demo

There are operations in simpleShoot-2, the demo that performs video capture, that violated guidelines. Operations were revised accordingly.


Note 67-03: (CARD) Support for parent backup device

Made the CARD library compatible with 1Mb-EEPROM backup devices and added CARD_BACKUP_TYPE_EEPROM_1MBITS to the CARDBackupType enumerated type.
In relation, the reference and sample demos were updated.


Note 67-04: (DSP) Revised synchronous version of the DSP graphics component function

The following two revisions were added.


Note 67-05: (DSP) Corrected inconsistency in the results of the DSP_Scaling* and DSP_CalcScalingFactor* functions

When enlarging an image using the DSP_Scaling* functions, output was sometimes produced that did not match that of the DSP_CalcScalingFactor* functions, depending on the size of the input image and the specified magnification. This bug was fixed.

When this problem would occur, there was a risk of a buffer overflow, depending on the size of the buffer storing results to be passed to the DSP_Scaling* functions.


Note 67-06: (DSP) Revised termination process for each DSP component

There were some inadequacies in the DSP component termination process. These were revised.


Note 67-07:(DevEnv) Updated documents specific to the build switch

Added an explanation to $TwlSDK/docs/SDKRules/Rule-Defines.html for the *_BUILD_TYPE build switch.

Portions were difficult to see in the Build Switch Usage Table. There were also mistakes. These have been fixed.


Note 67-08: (FS) Improved open determination for TWL-exclusive files

Internal determination of the FS library was improved to fail with FS_RESULT_PERMISSION_DENIED when a hybrid application is operating in the NITRO environment, and a file was opened in a TWL-exclusive region.


Note 67-09: (MB) Added a switch for the build mode on multiboot-wfs distributed child devices

Added a correction to child device applications distributed with a multiboot-wfs demo to Makefile to enable both NITRO-compatible and hybrid builds.

The TWL-specific features cannot be used even if the ROM built in hybrid mode was distributed to TWL system.
See the function reference's MB library overview for more information.


Note 67-10: (MI) Added the MI_SendNDmaGXCommand* functions

Conventionally, DMA was used as the function for sending the display list (the GX command string) to the command FIFO. However, a function that uses a new DMA has been added.


Note 67-11:(OS) Added the OS_IsCodecTwlMode function

Added the OS_IsCodecTwlMode function to get the codec operation mode.


Note 67-12: (OS) Added the demo for the OS_JumpTo* functions

Added $TwlSDK/build/demos.TWL/os/os_jump as a demo to indicate how the OS_JumpToSystemMenu, OS_RebootSystem, OS_JumpToWirelessSetting, OS_JumpToInternetSetting, and OS_JumpToEULAViewer functions work.


Note 67-13: (OS) Added a function to get the status of parental controls

Added a function for the application to get Parental Controls information performed by the TWL system settings.


Note 67-14: (OS) Movement of the function reference's Operating Environment section

References specific to operating environments such as the TWL-SDK function reference and the OS_GetConsoleType function had been placed in a category called OS/Debug (Operating Environment). However, these functions are expected to be used not only in debugging, but also with ordinary applications. They have therefore been removed from the debugging category to the OS/Operating Environment section.


Note 67-15: (PM) Added exclusive control for hardware resets and application jumps

By making application jumps and Power Button hardware resets exclusive, the possibility of unexpected operations happening when both occur simultaneously is eliminated.


Note 67-16: (PM) Revised Power Button process

Fixed a bug where the system would not shutdown but would instead perform a hardware reset when the Power Button was held down.


Note 67-17: (SCFG) Adjusted SCFG functions

The Function Reference Manual listed the SCFG_IsWramAccessible and SCFG_IsVramAccessible functions, but the definition of scfg.h listed them as the SCFG_IsWRAMAccessible and SCFG_IsVRAMAccessible functions.
That was changed to reflect the listing in the Function Reference Manual. The SCFG_IsWramAccessible and SCFG_IsVramAccessible functions are the standard.
However, as these may already be described as the SCFG_IsWRAMAccessible and SCFG_IsVRAMAccessible functions, the corresponding functions will be defined with a #define statement.

In addition, the spelling of the SCFG_GetPsramdBoundary function was corrected to the SCFG_GetPsramBoundary function.


Note 67-18: (SND) Abolished headphone mute when setting the IIR filter (targeting microphone input)

Headphone output was unnecessarily suppressed when changing the parameters for the IIR filter that targets microphone input using the SNDEX_SetIirFilter[Async] functions.
This problem has been corrected.


Note 67-19: (SND) Fixed a SNDEX_SetVolumeSwitchCallback function bug

Fixed a bug where the callback registered with the SNDEX_SetVolumeSwitchCallback function was not normally invoked.


Note 67-20: (SND) Added functionality to the extraFunc demo

Added functionality to the extraFunc demo to check the callback that notifies the pressing of the volume switch and the connection of headphones.


Note 67-21: (SSP) NITRO mode support for the JPEG library

Excluding signature functionality, the SSP library JPEG codec can now also be used in NITRO mode.


Note 67-22: (SSP) Added error processing for the SSP_StartJpegEncoder function

When the specified size for an image could not be encoded by the SSP_StartJpegEncoder function, corrupt images ended up being encoded. This was corrected to return an error in such cases.


Note 67-23: (STD) Handled a bug where the STD_CompareNString function would not return correct values

Fixed a bug where the STD_CompareNString function did not return correct values even if there was a match, depending on the value saved in the ending address, rounded up in 4-byte units, for the comparison's first string.


Note 67-24: (STD) Revised the STD_ConvertAsciiToInt and STD_ConvertAsciiToLong functions

When an integer overflow occurs, the corresponding standard functions, atoi and atol, behaved differently. This issues has been corrected.


Note 67-25: (STD) Revised the STD_TSNPrintf, STD_TSPrintf, STD_TVSNPrintf, and STD_TVSPrintf functions

Given security issues, fixed such that the %n format is not supported.


Note 67-26: (STD) Revised the STD_TSScanf and STD_TVSScanf functions

When scanning NULL characters, the standard sscanf function and its behavior differed. This issue has been corrected.


Note 67-27: (TOOL) Added backup and restore features for saved data in NandFiler

Changed so that it is possible to backup NAND application save data to an SD card.
This makes it possible to restore data saved in the system to the state when the data was backed up.


Note 67-28: (TOOL) Added the ability to import from DS cards to TwINmenu

Added a Card mode to TwINmenu that references and imports a TAD file written to a DS card.
DC cards can be used instead of SD cards.


Note 67-29: (TOOL) Added the cmptad tool

Added the cmptad tool to determine whether the SRL files included in two TAD files are the same.


Note 67-30: (TOOL) Added makebanner.exe and makebanner.TWL.exe warnings

Added a feature to makebanner.exe, and makebanner.TWL.exe to determine whether the game title has characters that can be displayed on the DS and TWL platforms and whether the horizontal width will fit within the range of the frame.
If characters or the horizontal width are illegal, a warning is displayed.


Note 67-31: (TOOL) Added makelst and stripdebug references

Added references for makelst and stripdebug, auxiliary tools for the use of the EL library.


Note 67-32: (TOOL) Changed makerom.TWL.exe

Made the following changes to makerom.TWL.exe.


Note 67-33: (TOOL) Added a feature to maketad to create an SRL file for writing to a DS card

Added a feature to maketad to output an SRL file that contains a TAD file.
This SRL file can only be used with the Card mode added to TwINmenu.


Note 67-34: (TWL Wireless) Fixed a bug where the system would hang when a reset is applied during TWL wireless communication

In extremely rare cases when a reset is applied during TWL wireless communication, the system would hang, leaving the reset incomplete. This bug has been verified and fixed.


Known Issues in NITRO-SDK version 5.0 Release Version


Nintendo Technical Support Center


CONFIDENTIAL