bf853b71d6
* Literally clear the repo to nothing for starters * The screen color changes with key presses There's enough code here that the screen color can change when you press the keys. Right now it's most all unsafe code directly in the example file. The strange thing is that llvm is making us define atomic helper functions when it's not supposed to do that, so we need to investigate more before proceeding too much. * can't tell if this is broken or if mgba is busted on mac * unix dumper * don't panic * oops * GbaCell into its own file, also i had broken the rt irq handler. * closer to an acceptable demo. * make IrqFn into just an alias. * wrap most current mmio types. * more stuff * Use paste to remove a whole bunch of repetition (#166) * gba cells are "unwind safe", they can't be in a bad intermediate state, that's the point * Once again we must thank Yandros for saving us from ourselves. * assembly updates. * oops * finish video MMIO basics, no docs yet. * small note. * simplify asm irq handler stack usage. * ewram support. * more cell stuff. * Remove the non-Zlib dependency, sorry Sp00ph :( * add proper dma support. * small docs improvement. * bitmap and oam declarations * more macros * single bit constants will be extremely useful * add `IntrWait` * rename for clarity * improvements * use the new constant * improve sound support * timers * key support * add a prelude module. * fix doc * more and more assembly (mem fns will need global_asm probably) * more comments. * comment updates. * readme * more video support, and put IrqFn alias into interrupts module. * finish working in the EABI code. * CI config. * funding file. * rustc plz inline these functions when you can :3 * "rt0" is unnecessarily cryptic * overhaul the readme. * phrasing Co-authored-by: Sp00ph <61327188+Sp00ph@users.noreply.github.com>
2.6 KiB
gba
Status: Pending
This branch is a pending release for 0.7 of the crate.
How To Make Your Own GBA Project Using This Crate
This will require the use of Nightly Rust. Any recent-ish version of Nightly should be fine.
Get ARM Binutils
You'll need the ARM version of the GNU binutils in your path, specifically the linker (arm-none-eabi-ld).
Linux folks can use the package manager. Mac and Windows folks can use the ARM Website.
Run rustup component add rust-src
This makes rustup keep the standard library source code on hand, which is necessary for build-std to work.
Create .cargo/config.toml
You should set up your project's cargo config like so:
[build]
target = "thumbv4t-none-eabi"
[unstable]
build-std = ["core"]
[target.thumbv4t-none-eabi]
runner = "mgba-qt"
rustflags = ["-Clink-arg=-Tlink_scripts/mono_boot.ld"]
This sets the default build target to be thumbv4t-none-eabi using the unstable build-std cargo feature.
Also, this sets cargo run to run the binary as an argument to mgba-qt.
If you're on windows then your copy of mGBA will be called "mgba.exe" instead.
Also, this sets mono_boot.ld as the linker script. You'll need to copy this into your project. If you save it to another location, adjust the path accordingly.
Make Your Executables
At this point you can make a bin or an example.
Every executable will need to be no_std and no_main.
Place these at the top of the file:
#![no_std]
#![no_main]
Every executable will need a panic handler defined, even if your code can't actually panic. A minimal panic handler looks like this:
#[panic_handler]
fn panic_handler(_: &core::panic::PanicInfo) -> ! {
loop {}
}
Every executable will need a main function defined.
We used the no_main attribute on the executable so that Rust will allow us to use a non-standard function signature:
#[no_mangle]
extern "C" fn main() -> ! {
loop {}
}
Optional: Use objcopy and gbafix
The cargo build will produce ELF files, which mGBA can run directly.
If you want to run your program on real hardware you'll need to:
objcopythe raw binary out of the ELF into its own file.- Use
gbafixto give the file appropriate header data to that file.
You can get gbafix through cargo: cargo install gbafix.
Other GBA Crates
This crate provides a largely "unmanaged" interaction with the GBA's hardware. If you would like an API that use the borrow checker to guide you more, the agb crate might be what you want.