Feature/nx (#155)

Add support for Nintendo switch homebrew

- Add a C application linking magenboy_core and compiling to nintendo
switch using libnx (including CI)
- Fix UB in static allocator
- Some refactors in common and rpi in order to reuse some modules

Author: alloncm

.dockerignore

@@ -0,0 +1,4 @@
+*target/
+.github/
+docs/
+*Dockerfile

.github/workflows/rust.yml

@@ -56,4 +56,8 @@ jobs:
       run: cargo make libretro_desktop
 
     - name: Build libretro android
-      run: cargo make libretro_android
+      run: cargo make libretro_android
+
+    - name: Build nintendo switch
+      if: ${{ matrix.os == 'ubuntu-latest' }}  # This fails on windows since it does not have docker installed
+      run: cargo make nx

.gitignore

@@ -40,9 +40,6 @@ bld/
 # Uncomment if you have tasks that create the project's static files in wwwroot
 #wwwroot/
 
-#vscode
-.vscode/
-
 # Visual Studio 2017 auto generated files
 Generated\ Files/
 

.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+    "C_Cpp.clang_format_fallbackStyle": "WebKit",
+    "C_Cpp.default.includePath": [
+        "${DEVKITPRO}\\libnx\\include",
+        "${DEVKITPRO}\\devkitA64\\aarch64-none-elf\\include",
+        "${DEVKITPRO}\\devkitA64\\lib\\gcc\\aarch64-none-elf\\15.1.0\\include"
+    ],
+    "rust-analyzer.cargo.extraEnv": {
+        "RPI": "4"
+    },
+    "rust-analyzer.cargo.allTargets": false,
+    "rust-analyzer.check.workspace": true,
+}

Cargo.lock

@@ -6,11 +6,12 @@ members = [
     "core",
     "rpi",
     "common", 
-    "libretro"
+    "libretro",
+    "nx"
 ]
 
 [workspace.package]
-version = "4.1.0"
+version = "4.2.0"
 authors = ["alloncm <alloncm@gmail.com>"]
 rust-version = "1.73"   # cause of cargo-ndk used to build for android platform
 edition = "2021"

Cargo.toml

@@ -45,7 +45,7 @@ install_crate_args=["--locked", "--version", "0.2.5"]
 command = "cross"
 args = ["build", "--release", "--target", "armv7-unknown-linux-gnueabihf", "--bin", "rpios","--no-default-features", "--features", "os"]
 
-[tasks.pre-rpibm]
+[tasks.nightly-install]
 command = "rustup"
 args = ["toolchain", "install", "--profile", "minimal", "--no-self-update", "${nightly_version}"]
 
@@ -55,7 +55,7 @@ install_crate = "cargo-binutils"
 install_crate_args=["--locked", "--version", "0.3.6"]
 command = "rust-objcopy"
 args = ["target/armv7a-none-eabihf/release/baremetal", "-O", "binary", "kernel7.img"]
-dependencies = ["pre-rpibm", "build_rpi_baremetal","install_llvm_tools"]
+dependencies = ["nightly-install", "build_rpi_baremetal","install_llvm_tools"]
 
 [tasks.build_rpi_baremetal]
 toolchain = "${nightly_version}"
@@ -85,4 +85,8 @@ dependencies = ["add_android_target"]
 
 [tasks.add_android_target]
 command = "rustup"
-args = ["target", "add", "aarch64-linux-android"]
+args = ["target", "add", "aarch64-linux-android"]
+
+[tasks.nx]
+command = "docker"
+args = ["build", "--progress=plain", ".", "--file", "nx/Dockerfile", "--target", "export", "--output=.", "--build-arg", "NIGHTLY=${nightly_version}"]

Makefile.toml

@@ -10,7 +10,7 @@ Install `cargo-make`
 ```sh
 cargo install cargo-make
 ```
-verify you have docker or podman installed 
+Verify you have cmake and docker or podman installed
 
 ### Desktop
 
@@ -73,6 +73,10 @@ rustup component add llvm-tools-preview
 
 See - [LibretroDocs](docs/Libretro.md)
 
+### Nintendo Switch
+
+See - [NxDocs](docs/Nx.md)
+
 ## Running
 
 ### Desktop

README.md

@@ -10,13 +10,15 @@ edition.workspace = true
 magenboy_core = {path = "../core"}
 log = "0.4"
 cfg-if = "1"
+libm = "0.2.15"
 crossbeam-channel = {version = "0.5", optional = true}
 fern = {version = "0.6", optional = true}
 chrono = {version = "0.4", optional = true}
 
 [features]
-std = ["chrono", "fern", "crossbeam-channel"]
+std = ["chrono", "fern", "crossbeam-channel", "alloc"]
 dbg = ["std"]
+alloc = []
 
 [dev-dependencies]
 criterion = "0.3"

common/Cargo.toml

@@ -1,3 +1,5 @@
+use alloc::{string::String, vec::Vec};
+
 use magenboy_core::apu::audio_device::{Sample, AudioDevice, StereoSample, BUFFER_SIZE};
 
 pub trait AudioResampler{