1=========================================================================== 2NINTENDO Revolution SDK 3.1 + patch 2 3 Oct 12, 2007 4=========================================================================== 5 6Table of Contents 7- Introduction 8- Cautions 9- License Information 10- Revision History 11- System Requirements 12- Installation Procedure 13- Differences from the Dolphin SDK 14- Currently Known Bugs 15- File List 16 17======================================================================= 18Introduction 19======================================================================= 20This is the Revolution SDK Version 3.1 + Patch 2. 21The Revolution SDK supports the Wii development environment. 22The 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. 23 24This version of SDK has been greatly modified from the previous version. 25There is no longer a full compatibility with the modules built with earlier SDK versions. 26For details about what has changed, read man/en_US/ReleaseNote.html. 27 28======================================================================= 29Precautions 30======================================================================= 31----------------------------------------------------------------------- 32You must choose firmware according to its usage. 33----------------------------------------------------------------------- 34From now on, select from two types of firmware for each title: firmware for titles with network support (*), and firmware for titles without network support. 35 36Firmware for titles without network support : 33.4.16 37Firmware for titles with network support : 35.4.16 38 39* In the Revolution SDK, titles with network support are defined to be those that support "Nintendo Wi-Fi Connection" or "WiiConnect24". 40 41 42To select the firmware, use "setfirmware script" included in this package. 43For details, refer to the "setfirmware" section (Tools > Settings Scripts > setfirmware) in the SDK Reference Manual. 44 45In 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. 46For details, refer to the "ndrun_prechecker" section (Tools > Settings Scripts > ndrun_prechecker) in the SDK Reference Manual. 47This feature is enabled by installing version 071002 or later of the NDEV software package. 48 49When each of these settings scripts is used, some items require caution. 50Be sure to read over the reference manual once for each settings script. 51 52----------------------------------------------------------------------- 53Running in the Wii Menu 54----------------------------------------------------------------------- 55Programs created using this SDK are expected to run in the Wii Menu of the version noted below or later. 56 57Wii Menu: 3.1 58 59Abnormal behavior may occur in systems whose version is earlier than the one above. 60 61======================================================================= 62License Information: 63======================================================================= 64 65- The following files are found in this SDK: 66 67/dvddata/axdemo/synth/GM16.DLS: Roland DLS file. 68/dvddata/axdemo/synth/gm16adpcm.pcm: GM16.DLS data converted for use with Wii (audio source files, ADPCM version). 69/dvddata/axdemo/synth/gm16adpcm.wt: GM16.DLS data converted for use with Wii (table files, ADPCM version). 70/dvddata/axdemo/synth/gm16pcm.pcm: GM16.DLS data converted for use with Wii (audio source files, PCM version). 71/dvddata/axdemo/synth/gm16pcm.wt: GM16.DLS data converted for use with Wii (table files, PCM version). 72 73To use all or part of the data from an application, you must comply with an end-user license agreement with Roland. 74 75The end-user license agreement is found in the following directory: 76 77/docs/en_US/License/Roland/Roland END-USER LICENSE AGREEMENT.pdf 78 79Contact information may be found in the following file. 80 81/docs/en_US/License/Roland/Roland_contact_info.txt 82 83Please read this agreement before using the data. 84 85- The audio library of this SDK supports Dolby Surround and Dolby Pro Logic II 86To use these features in a game, you must have a license agreement with Dolby. 87Please read the following file before using these features: 88 89/docs/en_US/License/Dolby/DPL2_for_Wii_E.pdf 90 91======================================================================= 92Revision History 93======================================================================= 94For the revision history of this release, see man/en_US/ReleaseNote.html. 95 96======================================================================= 97System Requirements 98======================================================================= 99For details on system requirements for the Revolution SDK, see RVL_QuickStartGuide.pdf. 100 101Three USB ports are required to connect to a PC. 102(Although two ports are specified in some manuals, three USB ports are now required.) 103 104This version of the SDK only supports the commercial release versions of NDEV. 105Whenever possible, use the NDEV software package version 071002 or later. 106 107======================================================================= 108Installation Procedure 109======================================================================= 110Install two types of firmware: one for titles with network support (35.4.16), and the other - without (33.4.16). 111 1121. Unpack the package in any directory and specify the path to RVL_SDK/ using the environment variable REVOLUTION_SDK_ROOT. 113To 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) 114 115REM ************************************************************ 116REM * 117REM * Please specify your installation paths here: 118REM * 119REM ************************************************************ 120SET REVOLUTION_SDK_ROOT=C:\RVL_SDK 121 122 1232. Before executing any sample demos or other executable files, be absolutely certain to update the NDEV firmware according to the procedure given below. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 124In a typical environment, the update program is executed by starting the Bourne-again shell (bash) and entering "fwupdate35_4_16_xx". 125(For xx, enter either "jp", "us", or "eu".) 126 127If 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 128 129 "ODEM -r -l swupdate35_4_16_xx.gcm". 130 131Once 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. 132 133If any of the versions are already higher than this, the update will fail after displaying "Import: *** ...failed," but you can continue without any problems. 134 135 136======================================================================= 137Differences from the Dolphin SDK: 138======================================================================= 139- The path to Revolution SDK is specified with the environment variable REVOLUTION_SDK_ROOT 140 141- The header file is placed in the following directory: 142$(REVOLUTION_SDK_ROOT)/include/revolution/ 143 144- The build target is RVL 145(This was HW2 for the Nintendo GameCube SDK.)) 146 147- The run-time library is compiled using CodeWarrior 3.0 Alpha 5 Patch 2 148 149 150======================================================================= 151Currently Known Bugs: 152======================================================================= 153----------------------------------------------------------------------- 154[GX] Command processor hardware bug 155 156A bug in the graphics hardware command processor (CP) was caused by a difference in internal processing timing, compared with Nintendo GameCube. 157 158Since this bug is treated within the library, no special response is required for applications as long as they perform rendering using the GX library. 159 160However, note the following points when creating original display lists using the GD library or other means. 161 162This 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(). 163Therefore, 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. 164 165This bug will not be corrected in hardware in the final product. 166----------------------------------------------------------------------- 167[HIO2] Transfer directions in the dual and multi demos of hio2demo 168 169The 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. 170 171Although 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. 172When 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. 173----------------------------------------------------------------------- 174[VI] MPAL display is not supported. 175 176Current system does not support display of MPAL. Release date is undecided. 177----------------------------------------------------------------------- 178[VI] A bug in the screen burn-in protection during the execution of OSFatal 179 180When 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). 181 182Normally, OSFatal displays an error message and stops the system. Currently, however, that error message is displayed while the burn-in protection is still running. 183----------------------------------------------------------------------- 184[WPAD] Problem with speaker playback simultaneous with WPADControlDpd 185 186When 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. 187 188Before beginning sound playback, wait a short time after pointer startup. 189 190This issue has not yet been addressed. 191----------------------------------------------------------------------- 192[OS] Broadway floating-point calculation mode 193 194REVOLUTION OS uses a non-IEEE mode for floating-point calculations. 195Calculation result is converted to 0 if it returns an IEEE754-format, non-normalized number. 196----------------------------------------------------------------------- 197[CW] A link error occurs when building with CodeWarrior IDE 198 199In default projects up to CodeWarrior Alpha5 patch2, the esp library was not linked by default. 200 201Drag and drop to add the library to the projects. 202 203This will be fixed in the next release of CW. 204----------------------------------------------------------------------- 205[DVD] DVD fatal errors occur when a disc is repeatedly ejected and inserted during disc reading 206 207It 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. 208 209This problem is currently under investigation. 210 211Because it is impossible to avoid this problem from the application side, there are no specific workarounds. 212----------------------------------------------------------------------- 213[REL/RSO] I get a warning while running the make demo. 214 215While running the make demo, the following warning is displayed with the creation of each plf: 216 217Example warning: 218 219### mwldeppc.exe Linker Warning: 220# linker command file 'b.o' is missing from project. 221 222The warning is output because an unrelated object file is specified in partial.lcf. 223It has not yet been decided how or when this problem will be corrected, but the warning has no effect on operation. 224----------------------------------------------------------------------- 225