SPG29x SDK with Mattel HyperScan support
HyperScan specific:
- HyperScan controller support
- HyperScan LEDs
- USB FAT32 Disk Support (FAT32 formatted as MBR)
- USB Booting
SPG29x specific:
- I2C
- UART
- NOR flash interface
- Basic TVE/Framebuffer
- Custom interrupt handling
More will hopefully be added in the future..
This SDK includes multiple examples for how to interface with the hardware, and most of the code should be documented. Some examples are as listed:
- [DEMO] - This shows a very basic controller/framebuffer demo
- [FlashRecovery] - This flashes a custom bootloader to allow CFW/OFW recovery, and live loading of firmware
- [PONG] - A very terrible PONG game, I wouldn't use it for production of any kind
- [FlashCFW] - This allows flashing a CFW/OFW permanently from recovery mode on HyperScan
I've included the S+Core IDE in the tools directory. This only works for Windows, but could be installed in WINE under Linux, which was the reason I chose to develop with this method since the S+Core Binutils/GCC hasn't been supported in years it makes trying to track down and build the toolchain from source unneccessary, and a lot more accessible, plus we can ensure that anyone who uses the IDE from this repo will be on the same versions since the back-end of the IDE uses a fixed version Bintuils/GCC.
Get this repo and navigate to "HyperScan-SPG29x-SDK\tools\S+core IDE-V2.6.1.exe" and then double click to install.
Done.
Oh, also install python3 because some of the examples use python scripting, as well as the recovery tools.
All of the examples SHOULD be documented in the code. The best way to test out the examples is to get this repo, install the IDE, and then go to File->Open Workspace and then navigate to the examples folder and open the desired example folder and select the .spw/.spg file of that example, and everything should load accordingly.
The IDE will actually produce a HYPER.EXE file for HyperScan by default in the Debug folder of the selected example (ex: /examples/CD/PONG/Debug/Hyper.Exe) when compiled. Some projects have other projects embedded into them, and some are made to run from recovery mode instead of as a HyperScan app.
The HYPER.EXE files on HyperScan are loaded to address 0xA00901FC and their entry point is 0xA0091000 and so if you try to compile an example that is meant to run from recovery/firmware space, you will not get results as the firmware is loaded from NOR flash (or UART for recovery) to 0xA00001FC and entry is at 0xA0001000 on HyperScan. This can be checked by looking at the *.ld file of your current project (ex: hyperscan_Prog.ld) and you'll see for example:
/* Read-only sections, merged into text segment: */
. = 0xA0001000;Which tells you that this is built for running in recovery mode, or as a firmware file, as opposed to it saying 0xA0091000 there, which would indicate it's to be ran from CD, or loaded in the HyperScan OS as a HYPER.EXE.
The examples all link to singular library code source in the repo, under the hyperscan folder. The reason for this is that if there's any updates to the libraries, you can just update from the repo and because everything is pulling from the singular location the changes are reflected when you open any existing example, so then you just recompile and the new code gets applied to the binary. Because of this reason, when starting a new project, the easiest way to do so is to simply copy an example from the example folder, paste it in the example folder, give it a new name, and start the new project there as all of the include and source paths should remain the same and create a uniform structure to the code, and this has the added benefit of making your project be in the examples folder just in case someone wants to send a pull request. :p
It is possible, albeit not as straightforward, to start a completely new project and import the libraries and headers into the IDE. I won't go over how to do this here as this will be very dependent on where exactly in the filepath you pull your libraries, sources, and includes from, as well as there would need to be changes to your startup.s and linkerscripts and various build environment settings to get this working, but just know that it IS possible, just not recommended unless you know what you're doing, because otherwise you will not get the results you're looking for.
- Step 1: Go to File->New
- Step 2: Choose CD-ROM(ISO) and No Multisession
- Step 3: Go to the ISO tab and under "File name length" select either ISO Level1 or ISO Level2
- Step 4: Now go to the Format section while still in the ISO tab and select "Mode 1"
- Step 5: Now go to the Character set section while still in the ISO tab and select "ISO9660"
- Step 6: Make sure Joilet is NOT selected and now go to the "Burn" tab and select Finalize CD
- Step 7: Change the "Write method" to "Disc-at-once"
- Step 8: Now you should be able to start a new compilation and you can navigate to your "Hyper.Exe" file and burn it.
There now exists a way for us to not only debug our apps via UART, but also to load code through it as well, though this requires some very simple soldering skills.
When you remove the 4 rubber plugs and 4 screws on the CD side of the Mattel HyperScan, you can then take the bottom of the system apart and you'll notice a label on the board that says "RX" and "TX" as well as a few others. What you'll need to do is get a UART cable and solder the "RX" line from your UART cable to the "TX" solder pad on the Mattel HyperScan, and then solder the "TX" line from your UART cable to the "RX" solder pad on the Mattel HyperScan. Once this is done you can do the following steps:
- Step 1:
We now have the ability to load homebrew through a FAT32 formatted USB drive. The only prerequisite is that you have to provide power to the USB device externally. This is usually acheived through a USB Y-Splitter with one side having the USB drive, and the other side having only power going through an adapter. Once this is done you can then do the following steps:
- Step 1:
- Bushing - RIP :( He was responsible for the hyperscan.bin firmware file being dumped originally, and a good source of valid information
- LiraNuna - Reverse engineering, and coding, etc
- HyperScanDev - Reverse engineering, Discord moderator, etc
- Sunplus - They actually indirectly provided a lot of information and tools through other S+Core products, and at least made a very good effort to support open-source
- Mattel - I like Barbie
Free Software, Hell Yeah!