wiiKey base v1.3 README
==========================

What's new?
=========================================
Version 1.3 of the wiiKey base system has an added configuration option
for the full gc region free feature. It also incrorporates a new version
of the wiikey dvdDump application.


Overview:
=========================================
wiiKey base combines various applications into a single bootable
disc. This release includes:

- wiikey configuration
- wiikey dvdDump (dumps discs to sdcard)
- some of the most popular gamecube homebrew apps:

- SDLoad 1.0 by Costis
- Snes9x 1.43 GX 0.5 Port by Softdev
- GCOs MultiGame Version by emu_kidid
- MFE Distro 1.0 by Isobel


Burn the image using any application capable of writing DVD disc
images i.e. ImgBurn/Nero/CloneCD/cdrecord/DeepBurner/etc


Navigation:
============================================
For those without a gamecube controller, both the main menu and the
disc dumper support navigation via the reset button. Pressing reset
for a short time will move the cursor, holding the button for one
second selects the current entry. The included homebrew apps require
a gc controller naturally.



wiikey configuration:
============================================

Note:
For stealth reasons the current settings can not be read from
the chip. That's why running the configuration will show the
initial settings regardless of the saved setup.


Region override [ON/OFF]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Enabling this option will make the region of wii/gc games appear to
be the region of your console, allowing you to boot games from other
regions. Most NTSC wii games will work on US and JAP consoles. Many
PAL games will run on NTSC consoles. For a more complete list see:

Please note that Region override has to be activated for Full GC Regionfree.

Full GC regionfree [ON/OFF]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Boots GC imports directly using a small apploader hook to setup the
correct video mode. Make sure you also enable the basic region feature,
thats what gets you through the wii menu in the first place. Unlike a
real GC, the NTSC Wii doesnt output PAL50. That means the game may
run but theres no picture. PAL60 games will work, however you need to
enable it. The common way to bring up the "use PAL60?" dialog on a
game is to hold B while booting. Forcing to NTSC may work as well. PAL consoles output NTSC just fine.

Audiofix [ON/OFF]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Enables fix for gamecube games using streaming audio. If you have
backups that are already patched with fstfix, you can disable the
option here.

DVDR Discspeed [3x/6x]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sets the default speed for recordable media. Fast or silent, you decide!
If you experience that your Wii resets itself when you start a disc on 6x,
you might want to try it on 3x as well.


Special thanks to:
====================
- Costis for SDLoad 1.0
- Softdev for his great port of Snes9x
- Emu_kidid for GcOs on the wii
- Isobel for the wonderful MFE mplayer frontend

What does it do?:
Boots all region Gamecube games (original or legal backups)
Explore ISO9660 discs up to 4.7gb(?) and launch DOL/ELF

How to:
Insert this disc into your modded Wii and boot it.
Eject it and put in your favourite GC game and boot!

Requirements:
Wii
Wiinja / Cyclo-Wiz
GC Game

1.5, the update to Teaser 4.

/// WHATSNEW ///
What's New (since Teaser4):
-Multi Games (up to as many a disc can fit (but it won't look pretty on screen))
-Audiofix (with drivecode from FCEU108)
-Panasonic Q still supported
-Ripping improved to read the sectors safely
-Updated AR Builder for this source.
-ViperGC Version is back, with no features lost - Yes, mp3 player on viperGC!( dollz3 is nice)
-Drive Firmware Dumping from http://GCIP/DFW.DAT
-DOL UPLOADING via HTTP. http://gcip/ and send ;)
-ELF Loading from DVD (FIXED, WORKING!)
-Hold Y at boot to boot backup
-Hold X at boot to boot original ipl
-And some other various fixes that the public doesn't notice
-Updated documentation
-DVD status shown in menu
-GCM FST parsing

What's New (Teaser 4):
-For all you GCoS 1.4 Lovers, There's an option in here to boot games as GCoS 1.4 did
-MP3 Player (Now able to continously play and skip songs
(longer you hold "A" the more songs it skips)
-Zlib was removed, as it wasn't being used
-ELF Loading from DVD (It's there, but unsure if working :P)
-Memcard detection in slot1 (that's all for now)
-AR can now be sent over or embedded (to embedd, grab GCoS AR BUILDER.rar)
-Failsafe in modes, i.e. if the disc isn't detected you don't have to reload GCoS
-And some other various fixes

What's New (Teaser 1/2):
-DVD+R reading
-Reading sectors in 2048 byte intervals (possibly 5mins faster ripping time)
-MP3 Player
-IPL Fonts
-Zlib is in there, but doing nothing
-Dol Loading from DVD
-Full No swap drive 04,06,08,Q support
-Saving of region preferences
-Network Settings applied on the fly
-Dol uploading fixed yet again!
-DVD Reset from tools menu

What's New (GCOS 1.4)
-Auto-detect region improved
-Full drive 8 support
-Much improved drive code
-Dol uploading fixed! Check the nc directory for uploading dols in windows!
-Ripping works for all users

/// NOTES ///
Building notes:
-New flag, -DVIPR or -DQOOB
-Rest is the same as last build

WARNING:
VIPERGC USERS WILL HAVE TO USE THE PROGRAMMER TO FLASH BACK TO VIPERGC.
I AM IN NO WAY RESPONSIBLE IF YOU CANNOT FLASH BACK DUE TO A BROKEN CABLE!

/// HTTP USAGE ///
(GCIP = your gamecube's IP)
Upload dol files to: http://GCIP/
Rip discs from http://GCIP/backup.iso
Dump DVD Drive Firmware from http://GCIP/DFW.DAT (after going to Misc->Dump FW)
Dump system memory, IPL, RealIPL with /MEM, /IPL, /REALIPL

/// FUTURE ///
There will be some nice GCoS related updates soon from a developer in the team, stay tuned!
This was the final build from this codebase, we've now officially moved to libogc dev.

The recovery disc for wiikey 1.9b has been added to the Resources section. If the upgrade process is interrupted before reflashing is completed the wiikey chip will be left in an inoperable state where it cannot load GC/Wii discs. The Recovery disc can be used to restore its firmware.

whatsnew:
** FINAL v4F Release **
- FIXED MEMORY CARD ISSUE!

whatsnew:
** FINAL v4 Release **
- DVD9 support added
- Gamecube Supported (Softmod and XenoGC)
- Straight to disc listing, no waiting
- Auto menu video mode setting
- If a game requires audio, it will ask to be setup (bit of a problem on GC)
- Game listing re-coded
- Improved the .iso generation speed ALOT

*Do not use Shrunk Audio streaming games (they may crash!)

Notes:

Using the app:
You must specify a region for the output file.
Examples are:
GCOS MultiGame Creator V4.exe output.gcm USA game1.gcm game2.gcm etc
GCOS MultiGame Creator V4.exe output.gcm JAP game1.gcm game2.gcm etc
GCOS MultiGame Creator V4.exe output.gcm PAL game1.gcm game2.gcm etc

It will create a self-booting GCOS dvd

After a bit of tinkering, GC MultiGames are now working fine on GCOS :) Use our own little application to create GCOS GC MultiGame DVD's up to ~8GB (full DVD9 size to be exact). That's right, GCOS has it first! You may pre-shrink Isos first using GCM Utility 0.5 (one by one).

Takes about 8min give or take to create a ~8.3Gb Iso image on a 2.4Ghz P4.

Why is Cobra MultiGame DVD support only "partial"?
Since Cobra MultiGame DVD's rely on games being on 32kb aligned, some are not playable as this changed now to 128kb. This means that most likely the first title burned on the disc won't work. However instead of removing all support for them, I have left in partial support. GCOS will scan your disc, find whatever it knows will work on Wii drives and only list that. However if you run the DOL file provided on a GC, you will have support for old and new.

Technical Notes:
If you want to develop your own app to make these multigame dvd's, here's a rundown of the disc format we made:
-=The GCOS MultiGame DVD Format=-:
Header: Just rip the header that a game makes, easiest way to explain.
Offset table is at 0x40, same as CobraMultigame (in DVD9, offsets are >>2).
First possible location a game can be is at 0x20000.
All games must be placed on offsets divisible by 0x20000 with no remainder. (Aligned)


whatsnew:
** v3 **
- Audio Streaming games now work.
- Fixed up regions for all modchips (Autodetect works now)
- Fixed up syntax on the .exe

Whatsnew:
** SELFBOOT Multigame Ver v2**
- .exe now creates multiboot and selfboot iso all in one.
- NOTE: These new discs won't work on the old MultiGame ver GCOS DVD.
- NOTE: Games Created with previous tool WILL WORK.

Whatsnew:
** Multigame Ver **
- Fixed menu from going to nowhere if up was pressed
- Added support for full DVD MultiGames [new GCOS Format ;)]
- Added Best support possible for Multigame discs (Cobra ones)
- Made GUI Neater in MultiGame select area

A new Wii image dumper has been released which allows you to dump a disc in as little as three hours (it used to be 50 a while ago). It also includes a complete re-write of the dump code, error correction and integrated unscrambler.

Changelog

Changes 0.4 - 1.0:
- Faster!!! (dumps a Wii disc in 3 hours)
- complete rewrite of dumping code
- error correction
- integrated unscrambler

Changes 1.0 - 1.1:
- Fixed division by zero bug
- took out the gdr drive detection code
- supported by wiinja modchip

Changes 1.1 - 1.2:
- Tried fixing more bugs
- removed flash components

Changes 1.31 - 2.0:
- Faster!! (dumps in about 2.5 hours)
- Faster unscrambling
- Status information while unscrambling
- Works with USB drives!!

Amazing tool which communicates with the Wii DVD drive serial interface and allows you to read/write from the Wii's DVD drive RAM. C source code for linux and windows along with a binary compiled for windows. (keyword: Erant's dvdtool)

Usage of the program:

The DVD Tool usage is fairly simple, to read from memory, type
./dvdtool -s -r
So, if you wanted to read 0x40 bytes from 0x8000 (main memory start), you'd type
./dvdtool -s 0x40 -r 0x8000
The file argument is an optional argument for reading, if no valid file is specified,
the output is a formatted output to stdout. The -s argument is also an optional argument,
not specifying it will assume a default of 0x20 bytes.

To write to memory, you'd use a similar syntax

./dvdtool -s -w

The only difference is the last argument, it can take a file or a formatted array.
In either case, the -s option is again optional, not specifying it will assume
the size of the array, or the size of the file.
An example to write an array to 0x8100:

./dvdtool -w 0x8100 "0xFF,0x0,0xFF,0x0" will write {0xFF,0x0,0xFF,0x0} to 0x8100.

The insert code command is slightly more complicated, you need a compiled and assembled
binary to insert. Code execution starts at 0x408000, which is in extra RAM. Code size limit
is estimated at roughly 8kb, so enough for pretty much anything. You need to pre-pend your code
with a NOP instruction, and append it with an 'RTS' instruction, to resume normal code execution.

An example of some code you could assemble and insert:

NOP
MOV 0xFF, D0
MOV 0x8000, A0
MOV D0, (A0)
RTS

This will write the value 0xFF to 0x8000. You can again check proper execution by performing a read operation.If the application returns a 'write error' after code injection, your code has crashed the interrupt thread of the DVD drive, and it'll need either a power cycle or reboot. Syntax of the code inject is easy enough,

./dvdtool -i code.bin

(A sample, compiled program called code.bin is included, it's source is also included. Run it, and check for 0xEA, 0xEA at 0x8001 for correct functioning).

Making the datacable

In order to make the datacable, you need only a few basic items. A DB-25 connector, two diodes, and some cable. Connect the diodes in reverse (so, PC ---|<--- Wii) to the DB-25 connector, to pins 1 and 14. Just connect some wires to pins 18 and 11, these will be the GND and output wires. The other two dioded wires are clock and input. Now, open your Wii, remove the DVD drive, and turn it over. Look for the following pattern near IC3001:
- 1 -
2 3 4
- 5 6

3 is SBO1 (Output)
4 is SBT1 (CLK)
6 is SBI1 (Input)

With the numbers being pads, and - being nothing. Now, solder the wire from pin 1 to pad 4 (CLK line). Pin 14 goes to pad 6, and pin 11 goes to pad 3. Just find a suitable place to attach the wire from pin 18, which is GND. (Placing the board so you can read the writing on IC3001, look at connector P3001, the rightmost pad is GND and the third from the right is GND). Check your solder connections with a multimeter, then close up your Wii, and issue the ./dvdtool -r 0x8000 command in root mode. If you see hexadecimal numbers, congratulations! If you don't, check the proper functioning of your cable, wether or not you're in root mode, and if the parport0 and ppdev drivers are properly installed.

dvdtool.conf

Contains only two things, the second line is the command write delay, the delay after a command is written, and should probably be left alone. The first is the bit read/write delay, the delay done after a bit is written or read. In standby mode (orange led), this is pretty safe at 50, but for ON mode (green led), should be set to 100 or higher, to avoid sync errors.

Debugging

If you're getting out of sync errors every now and again, make sure your Wii is in stand by mode (orange LED, higher transfer rates), or adjust the timing settings in dvdtool.conf, or try adding a 47pF capacitor to GND to your clock line. (At the Wii side). The code is also still fairly crude, so if you encounter any bugs, please give them to me.


Wii Disc Drive:

Chips:

IC1001 "[M]" "AN22023" "619P7002" (tqfp-48)
IC1002 "[M]" "41224" "616C5279" (probably a power switching / motor controller chip. - tqfp-65)
IC2001 "GC2-D1" "616P7300" (tqfp-144)
IC2003 "(underlined L) X9" "TDA" (6-pin package)
IC3001 Panasonic "Panasonic" "GC2R-D2A" "610U6MF7" (tqfp-100)

Ports:

P1001 Connects to laser/focus/read assembly
P1003 Connects to laser assembly movement motor
P1004 Connects to optical Disc detection subboard on "bottom" side
P2001 Connects to Wii motherboard Port P4 (via 32 pin flat cable)
P3001 Connects to Wii motherboard Port P8 (via 12-pin wire bundle cable)


Wii Mainboard Chips:

Chip listing:

U1: "(E)" "HOLLYWOOD" "(C)(M)'06Nintendo" "(ATI logo)" "(BroadOn logo)" "(NEC logo) JAPAN" "C10046F5-211-PN2-A" "0633KK01X" (video/IO chip, BGA/unknown 31x31mm)
U2: "(IBM logo)" "BROADWAY" "39X6735" "IBM9316" "BWYC-72914" "06340706V 14" "CANADA" (CPU, BGA/unknown 21x21mm)
U3: Samsung K4J52324QC-BC14 "SAMSUNG 631" "K4J52324QC-BC14" "EFEA75DX" (Memory!, BGA/unknown 14x11mm)
U3 (alternate): Quimonda "0638" "A" "HYB18H512321AFL14B" "HVV52176" (Memory chip, likely the same pinout and same/similar specs to the samsung chip)
U4: Sharp PQ070XH02Z "070XH02" "SHARP" "12H U6" (LDO voltage regulator, set at 1.8V - TO-263 package, 5 pins 10x8mm)
U5: "H8DU" (*tiny* 5-pin tsop-6 3x1.5mm)
U6: "AVE-RVL" "BU9055EKV" "629 145" (Audio/Video encoder/DAC tqfp-64 10x10mm)
U6 (alternate): "AVE-RVL A" "C8391" "0635EMM" (same package as previous chip)
U7: Mitsumi "616" "AMPAM" (Audio Amp, tsop-8 5x4mm)
U7 (alternate): No logo, "AMPAM" "6943" (same package as previous chip)
U8: MX "E062674-MG" "MX23L4005-24C1" "RTC-RVL A" "2S08802" (RTC, TSOP28 18x8mm)
U9: "JK0U" (Power-on-reset generator *tiny* 5-pin tsop-6 3x1.5mm)
U10: "JK0U" (Power-on-reset generator *tiny* 5-pin tsop-6 3x1.5mm)
U11:
U12:
U13:
U14: Samsung K9F4G08U0A "SAMSUNG 631" "K9F4G08U0A" "PCG1" "FHFL82GAU" (flash memory, tsop-48 18.5x12mm)
U14 (alternate): Hynix "KOR" KY27UF084G2M" "TPCB 647A" (flash memory, same package/pinout as samsung chip)
U15: Sanyo LV5043 "LV5043" "6SP0" (DC-DC Converter controller, ssop-30 10x5mm)
U16: Sanyo LV5043 "LV5043" "6SP0" (DC-DC Converter controller, ssop-30 10x5mm)
U17: Sanyo LV5043 "LV5043" "6SP0" (DC-DC Converter controller, ssop-30 10x5mm)
U18: "2901" "6M56" (tsop-14 5x4mm)
U19: Sharp PQ033DNA1ZPH "033DNA1" "SHARP" "H U7" (LDO regulator, 3.3V 1A, 4 pins 6x5mm)
U20:
U21:
U22: "H4" (*tiny* 5-pin tsop-6 3x1.5mm)

Ports:

P1 Gamecube memory cards port
P2 Rear fan power connector
P3 Disc slot LED port
P4 Disc drive port (see Wii console Disc Drive page)
P5 AV and "sensor bar" port
P6 Gamecube controller ports (all 4 of 'em)
P7 Battery port
P8 Disc drive port (see Wii console Disc Drive page)
P9 USB ports
P10 SD Card port. Marked "A0635D6"
P11 Power connector
P12 Bluetooth Daughtercard
P13 802.11 Wifi daughtercard

Crystals:

X1 "6373" "T 6276"
X1 (alternate) "27000" "K640Y"
X2 "32.768" "KDS0631" (32768Hz, RTC oscilator)

wiiKey base 1.2 released!

--------------------------------------------------------------------------------

Version 1.2 of the setup disc is now available for download. It combines
various applications into a single bootable disc. This release includes:

- wiikey configuration
- wiikey dvdDump (dumps discs to sdcard)
- some of the most popular gamecube homebrew apps:

- SDLoad 1.0 by Costis
- Snes9x 1.43 GX 0.5 Port by Softdev
- GCOs MultiGame Version by emu_kidid
- MFE Distro 1.0 by Isobel

We like to point out that this disc does not update the chips firmware
in any way. It merely adjusts the configuration stored in EEPROM.

what's next ?
==============================
Coming up next will be the first wiikey firmware update. Among some new
features/improvements, it will fix the audiostreaming bug, that causes
several gamecube games to crash right now. More details will be
announced soon on the official website.

A simple GUI to make GCOS multi game discs & PAL/NTSC patching & unscramble wii iso's. Is also collection of tools to help you create Wii & GC images.

With Wii Ui you can:

Make multi boot games using gcos for use in the Wii or GC (upto 15 images).
Build an emulator image using the built in emulators in the gui.
Unscramble Wii ISO's.
Region patch Wii ISO's.
Create a dummy file to pad out your iso if needed.
Edit GC images with GC-Tool.
Burn Your newley created iso (Requires ImgBurn Installed).

GCMUtility allows you to shrink Gamecube images down to their minimal size. It also can generate multiboot images of several Gamecube games.

Usage:
Click the Add ISO button at the top to insert an ISO image into the main window.
Click the check box beside the imported game.
The Shrink button at the bottom will now become enabled. Click it and select the name and location to save the newly shrunk image. NOTE: Shrinking is only possible when there is a single game with a check mark activated.
Continue adding ISO images. Once you have two or more checked, the Generate Multiboot ISO button is activated. Click it to create the ISO.

AloneTrio has announced that WabModCheap has finally reached its final version. While this is welcome news for Wii owners, it also serves as AloneTrio's last release for the Wii. According to him, he won't be working on WABModCheap anymore as it now has all the features he needed.

WabModCheap is a program that lets Wii owners load backups without actually installing a mod chip on their consoles. All you have to do to run it is to connect your Wii to your PC using parallel cables (4 wire Wii side). For more installation and usage instructions, please see the readme file included in the download.

Version 3.0 of WabModCheap still doesn't use hardcoded sync values since Wii syncing generally depends a lot on you parallel port speeds. One last thing, Alone Trio also says that you will sometimes need to turn your Wii off anf on again before re-using WABModCheap. Remember, read the readme file more more info.