1=========================================================================== 2NINTENDO Revolution SDK 3.2 3October 1, 2008 4=========================================================================== 5 6Table of Contents 7- Introduction 8- Precautions 9- License Information 10- Revision History 11- System Requirements 12- Installation Procedure 13- Differences from the Dolphin SDK 14- Known Bugs 15- File List 16 17======================================================================= 18Introduction 19======================================================================= 20This is the Revolution SDK version 3.2 patch 2. 21 22This patch is a cumulative patch. It includes the content of all patches up to the present. 23To use the patch, overwrite the SDK 3.2 directory. 24 25For details about what has changed, read man/en_US/ReleaseNote.html. 26 27======================================================================= 28Precautions 29======================================================================= 30----------------------------------------------------------------------- 31You must choose firmware according to its usage. 32----------------------------------------------------------------------- 33Starting with the SDK 3.1 patch, you must select either "extended firmware" or "standard firmware," as appropriate, for developed titles. 34 35Specifically, all titles that use Revolution SDK Extensions, Revolution DWC, or USB keyboards must use the extended firmware. Other titles should use the standard firmware. 36 37The versions of the firmware that correspond to each are shown below. 38 39 Standard firmware: 53.16.17 40 Extended firmware: 55.18.25 41 42To select the firmware, use the setfirmware script included in this package. For details, see the following Revolution Function Reference Manual entries: 43 44[Tools] - [Settings scripts] - [setfirmware] 45man/en_US/tools/setfirmware.html 46 47In 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, see the following Revolution Function Reference Manual entries: 48 49[Tools] - [Settings scripts] - [ndrun_prechecker] 50man/en_US/tools/ndrun_prechecker.html 51 52In particular, if you are using the CodeWarrior IDE, you must configure it so that the script window is displayed. The "Precautions" section of the aforementioned ndrun_prechecker function reference page describes how to configure this. 53 54This feature is enabled by installing version 071002 or later of the NDEV software package. 55 56 57When each of these settings scripts is used, some items require caution. 58Be sure to read over the reference manual once for each settings script. 59 60----------------------------------------------------------------------- 61Running in the Wii Menu 62----------------------------------------------------------------------- 63Programs created using this SDK are expected to run in the following version (or later) of the Wii Menu. 64 65Wii Menu: 3.0 66 67Abnormal behavior may occur in systems running earlier versions. 68 69======================================================================= 70License Information 71======================================================================= 72 73- The following files are found in this SDK: 74 75 /dvddata/axdemo/synth/GM16.DLS : Roland DLS file 76 /dvddata/axdemo/synth/gm16adpcm.pcm : GM16.DLS converted for use with the Wii 77 (audio source file, ADPCM version) 78 /dvddata/axdemo/synth/gm16adpcm.wt : GM16.DLS converted for use with the Wii 79 (table file, ADPCM version) 80 /dvddata/axdemo/synth/gm16pcm.pcm : GM16.DLS converted for use with the Wii 81 (audio source file, PCM version) 82 /dvddata/axdemo/synth/gm16pcm.wt : GM16.DLS converted for use with the Wii 83 (table file, PCM version) 84 85 To use all or part of the data from an application, you must comply with an end-user license agreement with Roland. 86 87 The end-user license agreement is found in the following directory. 88 89 /docs/en_US/License/Roland/Roland END-USER LICENSE AGREEMENT.pdf 90 /docs/en_US/License/Roland/Roland END-USER LICENSE AGREEMENT.pdf 91 92 Contact information may be found in the following file. 93 94 /docs/en_US/License/Roland/Roland_contact_info.txt 95 96 Please read this agreement before using the data. 97 98- 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. 99 100 /docs/en_US/License/Dolby/DPL2_for_Wii.pdf 101 102======================================================================= 103Revision History 104======================================================================= 105For the revision history of this release, see man/en_US/ReleaseNote.html. 106 107======================================================================= 108System Requirements 109======================================================================= 110Refer to RVL-QuickStartGuide.us.pdf, provided separately, for details on system requirements for the Revolution SDK. 111 112Three USB ports are required to connect to a PC. (Although two ports are specified in some manuals, three USB ports are now required.) 113 114This version of the SDK only supports the commercial release versions of NDEV. 115Whenever possible, use the NDEV software package version 071002 or later. 116 117======================================================================= 118Installation Procedure 119======================================================================= 120Install the two versions of the firmware: the extended firmware (55.18.25) and standard firmware (53.16.17). 121 1221. Overwrite the SDK directory with this patch package. 123 124 1252. Before executing any sample demos or other executable programs, be absolutely certain to update the NDEV firmware according to the procedure given below. 126 In a typical environment, the update program is executed by starting a bash shell and entering "fwupdate_SDK-3.2_xx". 127 (For xx, enter "jp", "us", or "eu".) 128 129 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 swupdate_SDK-3_2_xx.gcm" (without the quotes). 130 (For xx, enter "jp", "us", or "eu".) 131 132 Once the update is complete, the message "SWUpdate Successful" will appear on screen, and the NDEV firmware will be updated to Firmware 53.15.17, Firmware 55.15.24, and DEVKIT BOOT PROGRAM v1.18. 133 134 If these or later versions are already installed, you can continue without any problems even though "Import: *** ...failed" is displayed and update fails. 135 136 The DEVKIT BOOT PROGRAM v1.18 uses Firmware 55.15.24 to start, but this does not affect the operation of titles that support the standard firmware. 137 138======================================================================= 139Differences from the Dolphin SDK 140======================================================================= 141- The path to Revolution SDK is specified with the environment variable REVOLUTION_SDK_ROOT 142 143- The header file is placed in the following directory. 144 $(REVOLUTION_SDK_ROOT)/include/revolution/ 145 146- The build target is RVL. 147 (This was HW2 for the Nintendo GameCube SDK.) 148 149- The run-time library is compiled using CodeWarrior 3.0 Alpha 5 Patch 2. 150 151 152======================================================================= 153Currently Known Bugs 154======================================================================= 155----------------------------------------------------------------------- 156[GX] Command processor hardware bug 157 158 A bug was found in the graphics hardware command processor (CP), caused by a difference in internal processing timing as compared with Nintendo GameCube. 159 160 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. 161 162 However, note the following points when creating original display lists using the GD library or other means. 163 164 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 rendering 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. 165 166 This bug will not be corrected in hardware in the final product. 167 168----------------------------------------------------------------------- 169[HIO2] Transfer directions in the dual and multi demos of hio2demo 170 171 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. 172 173 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. 174 175----------------------------------------------------------------------- 176[VI] MPAL display is not supported. 177 178 Current system does not support display of MPAL. Release date is undecided. 179 180----------------------------------------------------------------------- 181[VI] A bug in the screen burn-in protection during the execution of OSFatal 182 183 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). 184 185 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. 186 187----------------------------------------------------------------------- 188[WPAD] Problem with speaker playback simultaneous with WPADControlDpd 189 190 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. 191 192 Before beginning sound playback, wait a short time after pointer startup. 193 194 This issue has not yet been addressed. 195 196----------------------------------------------------------------------- 197[OS] Broadway floating-point calculation mode 198 199 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. 200 201----------------------------------------------------------------------- 202[CW] A link error occurs when building with CodeWarrior IDE 203 204 In default projects up to CodeWarrior Alpha5 patch2, the esp library was not linked by default. 205 206 Use the stationary patch released for version 3.0 Alpha 5 of CodeWarrior for GAMECUBE. 207 208 This will be fixed in the next release of CW. 209 210----------------------------------------------------------------------- 211[REL/RSO] A warning occurs while making the demo 212 213 When making demos, the following warning is displayed with the creation of each PLF: 214 215 Example warning: 216 217 ### mwldeppc.exe Linker Warning: 218 # linker command file 'b.o' is missing from project. 219 220 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. 221 222----------------------------------------------------------------------- 223[BTE] Private-use functions are made global with general-purpose names 224 225The following general-purpose function names are global within the library. 226Please take note of this. 227 228LogMsg 229LogMsg_0 230LogMsg_1 231LogMsg_2 232LogMsg_3 233LogMsg_4 234LogMsg_5 235LogMsg_6 236 237Due to various circumstances, there are no plans to improve this matter in the future. 238 239----------------------------------------------------------------------- 240 241======================================================================= 242File List 243======================================================================= 244========================== FILE LIST Patch2 ========================== 245 246./RVL/bin/tools/swupdate_SDK-3_2_eu.gcm 247./RVL/bin/tools/swupdate_SDK-3_2_jp.gcm 248./RVL/bin/tools/swupdate_SDK-3_2_us.gcm 249./RVL/boot/apploader.img 250./RVL/lib/os.a 251./RVL/lib/osD.a 252./X86/bin/dat/0000000100000035.bin 253./X86/bin/dat/0000000100000037.bin 254./X86/bin/fwupdate_SDK-3_2_eu 255./X86/bin/fwupdate_SDK-3_2_jp 256./X86/bin/fwupdate_SDK-3_2_us 257./X86/bin/makeWad.exe 258./X86/bin/ndrun_fwlist 259./X86/bin/setfirmware 260./docs/en_US/Developer/Hardware_Transition_Guide/RVL-HardwareTransitionGuide.jp.pdf 261./include/revolution/cx/CXStreamingUncompression.h 262./include/revolution/sdkver.h 263./man/en_US/ReleaseNote.html 264./man/en_US/a-z.html 265./man/en_US/cx/CXInitUncompContextHuffmanFront.html 266./man/en_US/gx/list.html 267./man/en_US/hid/HIDCloseAsync.html 268./man/en_US/hid/HIDError.html 269./man/en_US/hid/HIDOpenAsync.html 270./man/en_US/hid/HIDSetupHandler.html 271./man/en_US/hid/index.html 272./man/en_US/hid/intro.html 273./man/en_US/hid/toc.html 274./man/en_US/icons.html 275./man/en_US/kbd/KBDExit.html 276./man/en_US/kbd/KBDInit.html 277./man/en_US/kbd/KBDInitRegionUS.html 278./man/en_US/kbd/intro.html 279./man/en_US/kbd/toc.html 280./man/en_US/main.html 281./man/en_US/nand/intro.html 282./readme-RVL_SDK-3_2-patch2_jp.txt 283========================== FILE LIST Patch ========================== 284 285./RVL/bin/tools/swupdate_SDK-3_2_eu.gcm 286./RVL/bin/tools/swupdate_SDK-3_2_jp.gcm 287./RVL/bin/tools/swupdate_SDK-3_2_us.gcm 288./RVL/lib/gx.a 289./RVL/lib/gxD.a 290./RVL/lib/kbd.a 291./RVL/lib/kbdD.a 292./RVL/lib/kpad.a 293./RVL/lib/kpadD.a 294./RVL/lib/nand.a 295./RVL/lib/nandD.a 296./RVL/lib/os.a 297./RVL/lib/osD.a 298./RVL/lib/vi.a 299./RVL/lib/viD.a 300./RVL/lib/wpad.a 301./RVL/lib/wpadD.a 302./RVL/lib/wud.a 303./RVL/lib/wudD.a 304./X86/bin/darchD.exe 305./X86/bin/setfirmware 306./build/demos/gxdemo/src/DisplayList/DL-tex.c 307./build/demos/gxdemo/src/DisplayList/DL-tf-mtx.c 308./build/demos/gxdemo/src/G2D/G2D-test.c 309./build/demos/gxdemo/src/Indirect/ind-tile-test.c 310./build/demos/gxdemo/src/TexGen/tg-shadow2.c 311./build/demos/videmo/src/frb-vi-gamma.c 312./build/demos/wbcdemo/src/handling_weight.c 313./build/demos/wpaddemo/src/dummy_checker.c 314./build/demos/wpaddemo/src/memory.c 315./build/demos/wpaddemo/src/wpad_axdemo.c 316./build/demos/wpaddemo/src/wpad_seqdemo.c 317./build/demos/wpaddemo/src/wpad_spdemo.c 318./build/libraries/kpad/src/KPAD.c 319./build/tools/darch/buildscript 320./build/tools/darch/include/darch.h 321./build/tools/darch/makefile 322./build/tools/darch/src/create.c 323./build/tools/darch/src/darch.c 324./build/tools/darch/src/extract.c 325./build/tools/darch/src/fst.c 326./build/tools/darch/src/out.c 327./build/tools/darch/src/utils.c 328./build/tools/darch/vc++/darch.sln 329./build/tools/darch/vc++/darch.vcproj 330./docs/en_US/Developer/Graphics_Programmer's_Guide/CMPR_Texture.jp.pdf 331./docs/en_US/Developer/Graphics_Programmer's_Guide/GX.jp.pdf 332./docs/en_US/Developer/Programmer's_Guide/Hio2If.jp.pdf 333./docs/en_US/Developer/Programmer's_Guide/OS.jp.pdf 334./docs/en_US/Developer/Programmer's_Guide/PAD.jp.pdf 335./docs/en_US/Developer/Programmer's_Guide/WBC.jp.pdf 336./include/revolution/sdkver.h 337./man/en_US/ReleaseNote_jp.html 338./man/en_US/a-z.html 339./man/en_US/ax/Utility/AXGetAdpcmData.html 340./man/en_US/ax_applications/Effect/AXFXChorusExpShutdownDpl2.html 341./man/en_US/ax_applications/Effect/AXFXChorusShutdownDpl2.html 342./man/en_US/ax_applications/Effect/AXFXDelayExpShutdownDpl2.html 343./man/en_US/ax_applications/Effect/AXFXDelayShutdownDpl2.html 344./man/en_US/ax_applications/Effect/AXFXReverbHiExpShutdownDpl2.html 345./man/en_US/ax_applications/Effect/AXFXReverbHiShutdownDpl2.html 346./man/en_US/ax_applications/Effect/AXFXReverbStdExpShutdownDpl2.html 347./man/en_US/ax_applications/Effect/AXFXReverbStdShutdownDpl2.html 348./man/en_US/ax_applications/sampledemos/axfilter.html 349./man/en_US/ax_applications/sampledemos/compressor.html 350./man/en_US/ax_applications/sampledemos/dpl2demo.html 351./man/en_US/ax_applications/sampledemos/dpl2reverb.html 352./man/en_US/ax_applications/sampledemos/expchorus.html 353./man/en_US/ax_applications/sampledemos/expdelay.html 354./man/en_US/ax_applications/sampledemos/expreverbHi.html 355./man/en_US/ax_applications/sampledemos/expreverbStd.html 356./man/en_US/ax_applications/sampledemos/fxbussend.html 357./man/en_US/bootseq/intro.html 358./man/en_US/contents.html 359./man/en_US/enc/chineseextbl.html 360./man/en_US/gx/Enumerated_Types/GXPerf0.html 361./man/en_US/gx/Framebuffer/GXReadBoundingBox.html 362./man/en_US/gx/Framebuffer/GXSetTexCopyDst.html 363./man/en_US/gx/Geometry/GXSetVtxDesc.html 364./man/en_US/gx/GfxFIFO/GXGetCPUFifo.html 365./man/en_US/gx/Indirect/GXSetTevIndWarp.html 366./man/en_US/gx/Lighting/GXInitLightSpot.html 367./man/en_US/gx/TexCoordGen/GXSetTexCoordGen2.html 368./man/en_US/gx/Texture/GXTexObjInitFlow.html 369./man/en_US/gx/list.html 370./man/en_US/gx/sampledemos/Framebuffer/frb-vfilter.html 371./man/en_US/gx/sampledemos/PerfCounters/perf-sync.html 372./man/en_US/gx/sampledemos/sampledemos.html 373./man/en_US/icons.html 374./man/en_US/kpad/KPADGetBtnProcMode.html 375./man/en_US/kpad/KPADRead.html 376./man/en_US/kpad/KPADReadEx.html 377./man/en_US/kpad/KPADSetBtnProcMode.html 378./man/en_US/kpad/intro.html 379./man/en_US/kpad/list.html 380./man/en_US/kpad/sampledemos/kpadsample.html 381./man/en_US/kpad/toc.html 382./man/en_US/main.html 383./man/en_US/nadk/CNTChangeDir.html 384./man/en_US/nadk/CNTGetCurrentDir.html 385./man/en_US/nand/intro.html 386./man/en_US/os/Alarm/OSCancelAlarms.html 387./man/en_US/os/Alarm/OSGetAlarmUserData.html 388./man/en_US/os/Alarm/OSSetAlarmTag.html 389./man/en_US/os/Hash/OSCalcCRC.html 390./man/en_US/os/Thread/OSCheckActiveThreads.html 391./man/en_US/os/Thread/fig0.png 392./man/en_US/os/Thread/intro.html 393./man/en_US/rso/tools/makerso.html 394./man/en_US/sc/SCGetSimpleAddressRegionIdHi.html 395./man/en_US/thp/tools/THPFormat.html 396./man/en_US/thp/tools/THPFormat/MovieData.html 397./man/en_US/thp/tools/THPFormat/THPAudioInfo.html 398./man/en_US/thp/tools/THPFormat/THPFrameCompInfo.html 399./man/en_US/thp/tools/THPFormat/THPFrameOffsetData.html 400./man/en_US/thp/tools/THPFormat/THPHeader.html 401./man/en_US/thp/tools/THPFormat/THPVideoInfo.html 402./man/en_US/wbc/demo_private.html 403./man/en_US/wbc/intro_private.html 404./man/en_US/wpad/WPADRegisterBLCWorkarea.html 405./man/en_US/wpad/intro.html 406./man/en_US/wpad/sampledemos/demos.html 407./man/en_US/wpad/toc.html 408./readme-RVL_SDK-3_2-patch.txt 409 410
