Run build and rp2040js simulation on CI (#19)

* Make build easier

* Add CI

* tag

* install gcc

* Add rp2040js

* Patch

* Fix wildcard

* Fix

* sleep

* fix

* Remove unnecessary patch

* Patch picoruby instead of pico-sdk

* Remove unnecessary file

* Remove patch

* Use tee

Author: take-cheeze

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
+        fetch-tags: true
+    - run: |
+        sudo apt remove man-db
+        sudo apt install -y cmake ruby gcc-arm-none-eabi npm
+        pushd lib/pico-sdk
+        git fetch origin --tags --recurse-submodules=no
+        popd
+        pushd lib/pico-extras
+        git fetch origin --tags --recurse-submodules=no
+        popd
+        pushd lib/rp2040js
+        git apply < ../../.github/workflows/rp2040js.patch
+        npm install
+        popd
+    - run: rake mrubyc:pico:debug
+    - run: |
+        set -eux
+        npm --prefix ./lib/rp2040js run start:micropython -- --image $PWD/build_pico/R2P2_PICO-FLASH*.uf2 | tee log.txt &
+        sleep 10
+        kill -9 %1
+        # cat log.txt
+        grep "/etc/init.d/r2p2" log.txt
+        # grep "No app.(mrb|rb) found" log.txt
+
+

.github/workflows/rp2040js.patch

@@ -0,0 +1,55 @@
+diff --git a/demo/micropython-run.ts b/demo/micropython-run.ts
+index 2eed868..4c24513 100644
+--- a/demo/micropython-run.ts
++++ b/demo/micropython-run.ts
+@@ -6,6 +6,7 @@ import { USBCDC } from '../src/usb/cdc.js';
+ import { ConsoleLogger, LogLevel } from '../src/utils/logging.js';
+ import { bootromB1 } from './bootrom.js';
+ import { loadCircuitpythonFlashImage, loadMicropythonFlashImage, loadUF2 } from './load-flash.js';
++import { RP2040SysInfo } from '../src/peripherals/sysinfo.js';
+ 
+ const args = minimist(process.argv.slice(2), {
+   string: [
+@@ -90,5 +91,42 @@ process.stdin.on('data', (chunk) => {
+   }
+ });
+ 
++export class CustomRP2040SysInfo extends RP2040SysInfo {
++  readUint32(offset: number) {
++    const PLATFORM = 0x4;
++    switch (offset) {
++      case PLATFORM:
++        return 0x01000002;
++    }
++    return super.readUint32(offset);
++  }
++}
++
++mcu.peripherals[0x40000] = new CustomRP2040SysInfo(mcu, 'SYSINFO_BASE');
++
++mcu.onBreak = (code) => {
++  // TODO: raise HardFault exception
++  // console.error('Breakpoint!', code);
++  // console.log(code);
++
++  if(code == 27){
++    const this_ = mcu.core;
++    const RAM_START_ADDRESS = 0x20000000;
++    const flashAddr = this_.registers[0];
++    const ramAddr = this_.registers[1] - RAM_START_ADDRESS;
++    const count = this_.registers[2];
++
++    // console.log("flash write:", flashAddr, ramAddr, count)
++
++    mcu.flash.set(mcu.sram.slice(ramAddr, ramAddr+count), flashAddr);
++
++    // Copy LR to PC register
++    // this.registers[15] = this.registers[14];
++    // this_.PC = this_.LR;
++  } else {
++    simulator.stop();
++  }
++};
++
+ simulator.rp2040.core.PC = 0x10000000;
+ simulator.execute();

.gitmodules

@@ -1,3 +1,12 @@
 [submodule "lib/picoruby"]
 	path = lib/picoruby
 	url = [email protected]:picoruby/picoruby.git
+[submodule "lib/pico-sdk"]
+	path = lib/pico-sdk
+	url = https://github.com/raspberrypi/pico-sdk.git
+[submodule "lib/pico-extras"]
+	path = lib/pico-extras
+	url = https://github.com/raspberrypi/pico-extras.git
+[submodule "lib/rp2040js"]
+	path = lib/rp2040js
+	url = https://github.com/wokwi/rp2040js.git

CMakeLists.txt

@@ -93,7 +93,10 @@ add_dependencies(${PROJECT_NAME}
 )
 foreach(rb ${RUBY_FILES})
   add_custom_target(${rb}
-    COMMAND ${PICORBC} -B${rb} -o${CMAKE_SOURCE_DIR}/${BUILD_DIR}/mrb/${rb}.c ${CMAKE_SOURCE_DIR}/mrblib/${rb}.rb
+    COMMAND
+      mkdir -p ${CMAKE_SOURCE_DIR}/${BUILD_DIR}/mrb &&
+      ${PICORBC} -B${rb} -o${CMAKE_SOURCE_DIR}/${BUILD_DIR}/mrb/${rb}.c ${CMAKE_SOURCE_DIR}/mrblib/${rb}.rb
+    DEPENDS ${CMAKE_SOURCE_DIR}/mrblib/${rb}.rb
   )
 endforeach(rb)
 

Rakefile

@@ -1,5 +1,12 @@
 require "fileutils"
 
+unless ENV.include? "PICO_SDK_PATH"
+  ENV["PICO_SDK_PATH"] = "#{File.dirname(__FILE__)}/lib/pico-sdk"
+end
+unless ENV.include? "PICO_EXTRAS_PATH"
+  ENV["PICO_EXTRAS_PATH"] = "#{File.dirname(__FILE__)}/lib/pico-extras"
+end
+
 PICO_SDK_TAG = "2.1.1"
 if PICO_SDK_TAG == "2.1.1"
   PICO_EXTRAS_TAG = "sdk-2.1.0" # workaround. 2.1.1 and 2.1.0 are the same
@@ -128,7 +135,7 @@ task :check_pico_sdk => :check_pico_sdk_path do
       raise <<~MSG
         pico-sdk #{PICO_SDK_TAG} is not checked out!\n
         Tips for dealing with:\n
-        cd $PICO_SDK_PATH && git pull && git checkout #{PICO_SDK_TAG} && git submodule update --recursive\n
+        cd $PICO_SDK_PATH && git fetch origin --tags && git checkout #{PICO_SDK_TAG} && git submodule update --recursive\n
       MSG
     end
   end
@@ -137,7 +144,7 @@ task :check_pico_sdk => :check_pico_sdk_path do
       raise <<~MSG
         pico-extras #{PICO_EXTRAS_TAG} is not checked out!\n
         Tips for dealing with:\n
-        cd $PICO_EXTRAS_PATH && git pull && git checkout #{PICO_EXTRAS_TAG} && git submodule update --recursive\n
+        cd $PICO_EXTRAS_PATH && git fetch origin --tags && git checkout #{PICO_EXTRAS_TAG} && git submodule update --recursive\n
       MSG
     end
   end