=========================================================================== NINTENDO Revolution SDK 3.1 + patch 2 Oct 12, 2007 =========================================================================== Table of Contents - Introduction - Cautions - License Information - Revision History - System Requirements - Installation Procedure - Differences from the Dolphin SDK - Currently Known Bugs - File List ======================================================================= Introduction ======================================================================= This is the Revolution SDK Version 3.1 + Patch 2. The Revolution SDK supports the Wii development environment. The Revolution SDK includes many libraries that reflect changes in hardware after Nintendo GameCube. In addition, it includes many demo programs that describe how to build and execute applications. This version of SDK has been greatly modified from the previous version. There is no longer a full compatibility with the modules built with earlier SDK versions. For details about what has changed, read man/en_US/ReleaseNote.html. ======================================================================= Precautions ======================================================================= ----------------------------------------------------------------------- You must choose firmware according to its usage. ----------------------------------------------------------------------- From now on, select from two types of firmware for each title: firmware for titles with network support (*), and firmware for titles without network support. Firmware for titles without network support : 33.4.16 Firmware for titles with network support : 35.4.16 * In the Revolution SDK, titles with network support are defined to be those that support "Nintendo Wi-Fi Connection" or "WiiConnect24". To select the firmware, use "setfirmware script" included in this package. For details, refer to the "setfirmware" section (Tools > Settings Scripts > setfirmware) in the SDK Reference Manual. In addition, the ndrun_prechecker script is available to check that appropriate firmware is used at startup time by the .elf file passed as an argument when ndrun is executed. For details, refer to the "ndrun_prechecker" section (Tools > Settings Scripts > ndrun_prechecker) in the SDK Reference Manual. This feature is enabled by installing version 071002 or later of the NDEV software package. When each of these settings scripts is used, some items require caution. Be sure to read over the reference manual once for each settings script. ----------------------------------------------------------------------- Running in the Wii Menu ----------------------------------------------------------------------- Programs created using this SDK are expected to run in the Wii Menu of the version noted below or later. Wii Menu: 3.1 Abnormal behavior may occur in systems whose version is earlier than the one above. ======================================================================= License Information: ======================================================================= - The following files are found in this SDK: /dvddata/axdemo/synth/GM16.DLS: Roland DLS file. /dvddata/axdemo/synth/gm16adpcm.pcm: GM16.DLS data converted for use with Wii (audio source files, ADPCM version). /dvddata/axdemo/synth/gm16adpcm.wt: GM16.DLS data converted for use with Wii (table files, ADPCM version). /dvddata/axdemo/synth/gm16pcm.pcm: GM16.DLS data converted for use with Wii (audio source files, PCM version). /dvddata/axdemo/synth/gm16pcm.wt: GM16.DLS data converted for use with Wii (table files, PCM version). To use all or part of the data from an application, you must comply with an end-user license agreement with Roland. The end-user license agreement is found in the following directory: /docs/en_US/License/Roland/Roland END-USER LICENSE AGREEMENT.pdf Contact information may be found in the following file. /docs/en_US/License/Roland/Roland_contact_info.txt Please read this agreement before using the data. - The audio library of this SDK supports Dolby Surround and Dolby Pro Logic II To use these features in a game, you must have a license agreement with Dolby. Please read the following file before using these features: /docs/en_US/License/Dolby/DPL2_for_Wii_E.pdf ======================================================================= Revision History ======================================================================= For the revision history of this release, see man/en_US/ReleaseNote.html. ======================================================================= System Requirements ======================================================================= For details on system requirements for the Revolution SDK, see RVL_QuickStartGuide.pdf. Three USB ports are required to connect to a PC. (Although two ports are specified in some manuals, three USB ports are now required.) This version of the SDK only supports the commercial release versions of NDEV. Whenever possible, use the NDEV software package version 071002 or later. ======================================================================= Installation Procedure ======================================================================= Install two types of firmware: one for titles with network support (35.4.16), and the other - without (33.4.16). 1. Unpack the package in any directory and specify the path to RVL_SDK/ using the environment variable REVOLUTION_SDK_ROOT. To use the startup batch file(RVL_NDEV.bat) included in the SDK, be sure to edit the location in the batch file where the environment variable is specified. (See example below) REM ************************************************************ REM * REM * Please specify your installation paths here: REM * REM ************************************************************ SET REVOLUTION_SDK_ROOT=C:\RVL_SDK 2. Before executing any sample demos or other executable files, be absolutely certain to update the NDEV firmware according to the procedure given below. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In a typical environment, the update program is executed by starting the Bourne-again shell (bash) and entering "fwupdate35_4_16_xx". (For xx, enter either "jp", "us", or "eu".) If the environment is customized or if things do not go smoothly using the method described above, go to the RVL_SDK/RVL/bin/tools directory and run "ODEM -r -l swupdate35_4_16_xx.gcm". Once the update is complete, the message "SWUpdate Successful" appears on the screen, and the NDEV firmware is updated to Firmware 35.4.16 DEVKIT BOOT PROGRAM v1.15. If any of the versions are already higher than this, the update will fail after displaying "Import: *** ...failed," but you can continue without any problems. ======================================================================= Differences from the Dolphin SDK: ======================================================================= - The path to Revolution SDK is specified with the environment variable REVOLUTION_SDK_ROOT - The header file is placed in the following directory: $(REVOLUTION_SDK_ROOT)/include/revolution/ - The build target is RVL (This was HW2 for the Nintendo GameCube SDK.)) - The run-time library is compiled using CodeWarrior 3.0 Alpha 5 Patch 2 ======================================================================= Currently Known Bugs: ======================================================================= ----------------------------------------------------------------------- [GX] Command processor hardware bug A bug in the graphics hardware command processor (CP) was caused by a difference in internal processing timing, compared with Nintendo GameCube. Since this bug is treated within the library, no special response is required for applications as long as they perform rendering using the GX library. However, note the following points when creating original display lists using the GD library or other means. This bug occurs when a command that corresponds to the register type CP (as described in the function reference About GX States) is sent immediately before drawing a primitive with a function such as GXBegin(). Therefore, if you need to set a CP command immediately before drawing primitives, be absolutely sure to include at least one GX_NOP (0x00) after the CP command. This bug will not be corrected in hardware in the final product. ----------------------------------------------------------------------- [HIO2] Transfer directions in the dual and multi demos of hio2demo The dual demo of hio2demo carries out communication using separate channels: EXI0 for communication from NDEV to PC, and MrEXI for communication from PC to NDEV. However, transfers using EXI0 are not supported on the current hardware, so only unidirectional communication from PC to NDEV works. Although the multi demo is designed for multiple NDEV consoles connected to a single PC, operations are currently not verified when multiple NDEV units are connected. When one NDEV is connected, specifications state to use EXI0 from PC to NDEV, and MrEXI from NDEV to PC, in the opposite manner from dual mode. However, for the same reasons as described above, only unidirectional communication from NDEV to PC works. ----------------------------------------------------------------------- [VI] MPAL display is not supported. Current system does not support display of MPAL. Release date is undecided. ----------------------------------------------------------------------- [VI] A bug in the screen burn-in protection during the execution of OSFatal When OSFatal runs while the screen burn-in protection feature is running, OSFatal runs without recovering from the burn-in protection state (the screen stays dark). Normally, OSFatal displays an error message and stops the system. Currently, however, that error message is displayed while the burn-in protection is still running. ----------------------------------------------------------------------- [WPAD] Problem with speaker playback simultaneous with WPADControlDpd When speaker sound is played back while starting the pointer with the WPADControlDpd function, the beginning portion of audio will not play back due to the operation of pointer startup. Before beginning sound playback, wait a short time after pointer startup. This issue has not yet been addressed. ----------------------------------------------------------------------- [OS] Broadway floating-point calculation mode REVOLUTION OS uses a non-IEEE mode for floating-point calculations. Calculation result is converted to 0 if it returns an IEEE754-format, non-normalized number. ----------------------------------------------------------------------- [CW] A link error occurs when building with CodeWarrior IDE In default projects up to CodeWarrior Alpha5 patch2, the esp library was not linked by default. Drag and drop to add the library to the projects. This will be fixed in the next release of CW. ----------------------------------------------------------------------- [DVD] DVD fatal errors occur when a disc is repeatedly ejected and inserted during disc reading It has been reported that DVD fatal errors occur when a disc is repeatedly ejected and inserted during disc reading on the RVT-R READER and Wii console. This problem is currently under investigation. Because it is impossible to avoid this problem from the application side, there are no specific workarounds. ----------------------------------------------------------------------- [REL/RSO] I get a warning while running the make demo. While running the make demo, the following warning is displayed with the creation of each plf: Example warning: ### mwldeppc.exe Linker Warning: # linker command file 'b.o' is missing from project. The warning is output because an unrelated object file is specified in partial.lcf. It has not yet been decided how or when this problem will be corrected, but the warning has no effect on operation. -----------------------------------------------------------------------