rp2040js 1.1.0 → 1.2.0

package/README.md

@@ -1,3 +1,5 @@
+![](../../actions/workflows/ci-test.yml/badge.svg) ![](../../actions/workflows/ci-micropython.yml/badge.svg) ![](../../actions/workflows/ci-pico-sdk.yml/badge.svg)
+
 # rp2040js
 
 Raspberry Pi Pico Emulator for the [Wokwi Simulation Platform](https://wokwi.com). It blinks, runs Arduino code, and even the MicroPython REPL!
@@ -58,7 +60,7 @@ A GDB server on port 3333 can be enabled by specifying the `--gdb` flag:
 npm run start:micropython -- --gdb
 ```
 
-For using the MicroPython demo code in tests, the `--expect-text` can come handy: it will look for the given text in the serial output and exit with code 0 if found, or 1 if not found. You can find an example in [the MicroPython CI test](./github/workflows/ci-micropython.yml).
+For using the MicroPython demo code in tests, the `--expect-text` can come handy: it will look for the given text in the serial output and exit with code 0 if found, or 1 if not found. You can find an example in [the MicroPython CI test](./.github/workflows/ci-micropython.yml).
 
 #### Filesystem support
 

package/dist/cjs/peripherals/pio.d.ts

@@ -92,6 +92,8 @@ export declare class RPPIO extends BasePeripheral implements Peripheral {
     readonly machines: StateMachine[];
     stopped: boolean;
     fdebug: number;
+    txStall: number;
+    rxStall: number;
     inputSyncBypass: number;
     irq: number;
     pinValues: number;

package/dist/cjs/peripherals/pio.js

@@ -169,6 +169,7 @@ class StateMachine {
             return;
         }
         this.txFIFO.push(value);
+        this.pio.txStall &= ~(FDEBUG_TXSTALL << this.index);
         this.updateDMATx();
         this.checkWait();
         if (this.txFIFO.full) {
@@ -181,6 +182,7 @@ class StateMachine {
             return 0;
         }
         const result = this.rxFIFO.pull();
+        this.pio.rxStall &= ~(FDEBUG_RXSTALL << this.index);
         this.updateDMARx();
         this.checkWait();
         if (this.rxFIFO.empty) {
@@ -440,7 +442,8 @@ class StateMachine {
                         this.pio.checkInterrupts();
                     }
                     else {
-                        this.pio.fdebug |= FDEBUG_RXSTALL << this.index;
+                        this.pio.rxStall |= FDEBUG_RXSTALL << this.index;
+                        this.pio.fdebug |= this.pio.rxStall;
                         this.wait(WaitType.rxFIFO, false, this.inputShiftReg);
                     }
                     this.inputShiftCount = 0;
@@ -458,7 +461,8 @@ class StateMachine {
                         this.pio.checkInterrupts();
                     }
                     else {
-                        this.pio.fdebug |= FDEBUG_TXSTALL << this.index;
+                        this.pio.txStall |= FDEBUG_TXSTALL << this.index;
+                        this.pio.fdebug |= this.pio.txStall;
                         this.wait(WaitType.Out, false, arg);
                     }
                 }
@@ -488,7 +492,8 @@ class StateMachine {
                         this.pio.checkInterrupts();
                     }
                     else {
-                        this.pio.fdebug |= FDEBUG_TXSTALL << this.index;
+                        this.pio.txStall |= FDEBUG_TXSTALL << this.index;
+                        this.pio.fdebug |= this.pio.txStall;
                         if (block) {
                             this.wait(WaitType.txFIFO, false, 0);
                         }
@@ -511,7 +516,8 @@ class StateMachine {
                         this.pio.checkInterrupts();
                     }
                     else {
-                        this.pio.fdebug |= FDEBUG_RXSTALL << this.index;
+                        this.pio.rxStall |= FDEBUG_RXSTALL << this.index;
+                        this.pio.fdebug |= this.pio.rxStall;
                         if (block) {
                             this.wait(WaitType.rxFIFO, false, this.inputShiftReg);
                         }
@@ -831,6 +837,8 @@ class RPPIO extends peripheral_js_1.BasePeripheral {
         ];
         this.stopped = true;
         this.fdebug = 0;
+        this.txStall = 0;
+        this.rxStall = 0;
         this.inputSyncBypass = 0;
         this.irq = 0;
         this.pinValues = 0;
@@ -977,6 +985,7 @@ class RPPIO extends peripheral_js_1.BasePeripheral {
             }
             case FDEBUG:
                 this.fdebug &= ~this.rawWriteValue;
+                this.fdebug |= this.txStall | this.rxStall;
                 break;
             case TXF0:
                 this.machines[0].writeFIFO(value);

package/dist/cjs/peripherals/xosc.d.ts

@@ -0,0 +1,13 @@
+import { BasePeripheral, Peripheral } from './peripheral.js';
+export declare class RPXOSC extends BasePeripheral implements Peripheral {
+    private ctrl;
+    private status;
+    private dormant;
+    private startup;
+    private count;
+    private enabled;
+    private stable;
+    private isDormant;
+    readUint32(offset: number): number;
+    writeUint32(offset: number, value: number): void;
+}

package/dist/cjs/peripherals/xosc.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RPXOSC = void 0;
+const peripheral_js_1 = require("./peripheral.js");
+// XOSC register offsets
+const XOSC_CTRL = 0x00;
+const XOSC_STATUS = 0x04;
+const XOSC_DORMANT = 0x08;
+const XOSC_STARTUP = 0x0c;
+const XOSC_COUNT = 0x1c;
+// CTRL register bits
+const CTRL_ENABLE_LSB = 12;
+const CTRL_ENABLE_BITS = 0x00fff000;
+const CTRL_FREQ_RANGE_BITS = 0x00000fff;
+// CTRL ENABLE values
+const CTRL_ENABLE_DISABLE = 0xd1e;
+const CTRL_ENABLE_ENABLE = 0xfab;
+// STATUS register bits
+const STATUS_STABLE = 0x80000000; // bit 31
+const STATUS_BADWRITE = 0x01000000; // bit 24
+const STATUS_ENABLED = 0x00001000; // bit 12
+const STATUS_FREQ_RANGE_BITS = 0x00000003;
+// DORMANT register values
+const DORMANT_VALUE = 0x636f6d61; // "coma" in ASCII
+const WAKE_VALUE = 0x77616b65; // "wake" in ASCII
+// STARTUP register bits
+const STARTUP_X4 = 0x00100000; // bit 20
+const STARTUP_DELAY_BITS = 0x00003fff;
+class RPXOSC extends peripheral_js_1.BasePeripheral {
+    constructor() {
+        super(...arguments);
+        this.ctrl = 0;
+        this.status = 0;
+        this.dormant = 0;
+        this.startup = 0;
+        this.count = 0;
+        this.enabled = false;
+        this.stable = false;
+        this.isDormant = false;
+    }
+    readUint32(offset) {
+        switch (offset) {
+            case XOSC_CTRL:
+                return this.ctrl;
+            case XOSC_STATUS: {
+                let status = this.status;
+                if (this.stable) {
+                    status |= STATUS_STABLE;
+                }
+                if (this.enabled) {
+                    status |= STATUS_ENABLED;
+                }
+                return status;
+            }
+            case XOSC_DORMANT:
+                return this.dormant;
+            case XOSC_STARTUP:
+                return this.startup;
+            case XOSC_COUNT:
+                return this.count;
+        }
+        return super.readUint32(offset);
+    }
+    writeUint32(offset, value) {
+        switch (offset) {
+            case XOSC_CTRL: {
+                this.ctrl = value;
+                const enableValue = (value & CTRL_ENABLE_BITS) >>> CTRL_ENABLE_LSB;
+                const freqRange = value & CTRL_FREQ_RANGE_BITS;
+                void freqRange; // Currently unused, but could be logged or validated
+                if (enableValue === CTRL_ENABLE_ENABLE) {
+                    if (!this.isDormant) {
+                        this.enabled = true;
+                        // For simplicity, become stable immediately
+                        // In real hardware, this would take time based on STARTUP register
+                        this.stable = true;
+                    }
+                }
+                else if (enableValue === CTRL_ENABLE_DISABLE) {
+                    this.enabled = false;
+                    this.stable = false;
+                }
+                else if (enableValue !== 0) {
+                    // Invalid write to ENABLE field
+                    this.status |= STATUS_BADWRITE;
+                    this.warn(`Invalid ENABLE value written: 0x${enableValue.toString(16)}`);
+                }
+                break;
+            }
+            case XOSC_STATUS:
+                // Clear BADWRITE bit if written as 1 (write-1-to-clear)
+                if (value & STATUS_BADWRITE) {
+                    this.status &= ~STATUS_BADWRITE;
+                }
+                break;
+            case XOSC_DORMANT:
+                if (value === DORMANT_VALUE) {
+                    this.isDormant = true;
+                    this.stable = false;
+                }
+                else if (value === WAKE_VALUE) {
+                    this.isDormant = false;
+                    if (this.enabled) {
+                        this.stable = true;
+                    }
+                }
+                this.dormant = value;
+                break;
+            case XOSC_STARTUP:
+                this.startup = value & (STARTUP_X4 | STARTUP_DELAY_BITS);
+                break;
+            case XOSC_COUNT:
+                // Writing to COUNT starts the countdown
+                this.count = value & 0xff;
+                // For simplicity, we don't actually implement the countdown
+                // In real hardware, this would decrement at the XOSC frequency
+                break;
+            default:
+                super.writeUint32(offset, value);
+        }
+    }
+}
+exports.RPXOSC = RPXOSC;

package/dist/cjs/rp2040.js

@@ -27,6 +27,7 @@ const timer_js_1 = require("./peripherals/timer.js");
 const uart_js_1 = require("./peripherals/uart.js");
 const usb_js_1 = require("./peripherals/usb.js");
 const watchdog_js_1 = require("./peripherals/watchdog.js");
+const xosc_js_1 = require("./peripherals/xosc.js");
 const sio_js_1 = require("./sio.js");
 const logging_js_1 = require("./utils/logging.js");
 exports.FLASH_START_ADDRESS = 0x10000000;
@@ -137,7 +138,7 @@ class RP2040 {
             0x40018: new peripheral_js_1.UnimplementedPeripheral(this, 'IO_QSPI_BASE'),
             0x4001c: new pads_js_1.RPPADS(this, 'PADS_BANK0_BASE', 'bank0'),
             0x40020: new pads_js_1.RPPADS(this, 'PADS_QSPI_BASE', 'qspi'),
-            0x40024: new peripheral_js_1.UnimplementedPeripheral(this, 'XOSC_BASE'),
+            0x40024: new xosc_js_1.RPXOSC(this, 'XOSC_BASE'),
             0x40028: new peripheral_js_1.UnimplementedPeripheral(this, 'PLL_SYS_BASE'),
             0x4002c: new peripheral_js_1.UnimplementedPeripheral(this, 'PLL_USB_BASE'),
             0x40030: new busctrl_js_1.RPBUSCTRL(this, 'BUSCTRL_BASE'),

package/dist/esm/peripherals/pio.d.ts

@@ -92,6 +92,8 @@ export declare class RPPIO extends BasePeripheral implements Peripheral {
     readonly machines: StateMachine[];
     stopped: boolean;
     fdebug: number;
+    txStall: number;
+    rxStall: number;
     inputSyncBypass: number;
     irq: number;
     pinValues: number;

package/dist/esm/peripherals/pio.js

@@ -166,6 +166,7 @@ export class StateMachine {
             return;
         }
         this.txFIFO.push(value);
+        this.pio.txStall &= ~(FDEBUG_TXSTALL << this.index);
         this.updateDMATx();
         this.checkWait();
         if (this.txFIFO.full) {
@@ -178,6 +179,7 @@ export class StateMachine {
             return 0;
         }
         const result = this.rxFIFO.pull();
+        this.pio.rxStall &= ~(FDEBUG_RXSTALL << this.index);
         this.updateDMARx();
         this.checkWait();
         if (this.rxFIFO.empty) {
@@ -437,7 +439,8 @@ export class StateMachine {
                         this.pio.checkInterrupts();
                     }
                     else {
-                        this.pio.fdebug |= FDEBUG_RXSTALL << this.index;
+                        this.pio.rxStall |= FDEBUG_RXSTALL << this.index;
+                        this.pio.fdebug |= this.pio.rxStall;
                         this.wait(WaitType.rxFIFO, false, this.inputShiftReg);
                     }
                     this.inputShiftCount = 0;
@@ -455,7 +458,8 @@ export class StateMachine {
                         this.pio.checkInterrupts();
                     }
                     else {
-                        this.pio.fdebug |= FDEBUG_TXSTALL << this.index;
+                        this.pio.txStall |= FDEBUG_TXSTALL << this.index;
+                        this.pio.fdebug |= this.pio.txStall;
                         this.wait(WaitType.Out, false, arg);
                     }
                 }
@@ -485,7 +489,8 @@ export class StateMachine {
                         this.pio.checkInterrupts();
                     }
                     else {
-                        this.pio.fdebug |= FDEBUG_TXSTALL << this.index;
+                        this.pio.txStall |= FDEBUG_TXSTALL << this.index;
+                        this.pio.fdebug |= this.pio.txStall;
                         if (block) {
                             this.wait(WaitType.txFIFO, false, 0);
                         }
@@ -508,7 +513,8 @@ export class StateMachine {
                         this.pio.checkInterrupts();
                     }
                     else {
-                        this.pio.fdebug |= FDEBUG_RXSTALL << this.index;
+                        this.pio.rxStall |= FDEBUG_RXSTALL << this.index;
+                        this.pio.fdebug |= this.pio.rxStall;
                         if (block) {
                             this.wait(WaitType.rxFIFO, false, this.inputShiftReg);
                         }
@@ -827,6 +833,8 @@ export class RPPIO extends BasePeripheral {
         ];
         this.stopped = true;
         this.fdebug = 0;
+        this.txStall = 0;
+        this.rxStall = 0;
         this.inputSyncBypass = 0;
         this.irq = 0;
         this.pinValues = 0;
@@ -973,6 +981,7 @@ export class RPPIO extends BasePeripheral {
             }
             case FDEBUG:
                 this.fdebug &= ~this.rawWriteValue;
+                this.fdebug |= this.txStall | this.rxStall;
                 break;
             case TXF0:
                 this.machines[0].writeFIFO(value);

package/dist/esm/peripherals/xosc.d.ts

@@ -0,0 +1,13 @@
+import { BasePeripheral, Peripheral } from './peripheral.js';
+export declare class RPXOSC extends BasePeripheral implements Peripheral {
+    private ctrl;
+    private status;
+    private dormant;
+    private startup;
+    private count;
+    private enabled;
+    private stable;
+    private isDormant;
+    readUint32(offset: number): number;
+    writeUint32(offset: number, value: number): void;
+}

package/dist/esm/peripherals/xosc.js

@@ -0,0 +1,119 @@
+import { BasePeripheral } from './peripheral.js';
+// XOSC register offsets
+const XOSC_CTRL = 0x00;
+const XOSC_STATUS = 0x04;
+const XOSC_DORMANT = 0x08;
+const XOSC_STARTUP = 0x0c;
+const XOSC_COUNT = 0x1c;
+// CTRL register bits
+const CTRL_ENABLE_LSB = 12;
+const CTRL_ENABLE_BITS = 0x00fff000;
+const CTRL_FREQ_RANGE_BITS = 0x00000fff;
+// CTRL ENABLE values
+const CTRL_ENABLE_DISABLE = 0xd1e;
+const CTRL_ENABLE_ENABLE = 0xfab;
+// STATUS register bits
+const STATUS_STABLE = 0x80000000; // bit 31
+const STATUS_BADWRITE = 0x01000000; // bit 24
+const STATUS_ENABLED = 0x00001000; // bit 12
+const STATUS_FREQ_RANGE_BITS = 0x00000003;
+// DORMANT register values
+const DORMANT_VALUE = 0x636f6d61; // "coma" in ASCII
+const WAKE_VALUE = 0x77616b65; // "wake" in ASCII
+// STARTUP register bits
+const STARTUP_X4 = 0x00100000; // bit 20
+const STARTUP_DELAY_BITS = 0x00003fff;
+export class RPXOSC extends BasePeripheral {
+    constructor() {
+        super(...arguments);
+        this.ctrl = 0;
+        this.status = 0;
+        this.dormant = 0;
+        this.startup = 0;
+        this.count = 0;
+        this.enabled = false;
+        this.stable = false;
+        this.isDormant = false;
+    }
+    readUint32(offset) {
+        switch (offset) {
+            case XOSC_CTRL:
+                return this.ctrl;
+            case XOSC_STATUS: {
+                let status = this.status;
+                if (this.stable) {
+                    status |= STATUS_STABLE;
+                }
+                if (this.enabled) {
+                    status |= STATUS_ENABLED;
+                }
+                return status;
+            }
+            case XOSC_DORMANT:
+                return this.dormant;
+            case XOSC_STARTUP:
+                return this.startup;
+            case XOSC_COUNT:
+                return this.count;
+        }
+        return super.readUint32(offset);
+    }
+    writeUint32(offset, value) {
+        switch (offset) {
+            case XOSC_CTRL: {
+                this.ctrl = value;
+                const enableValue = (value & CTRL_ENABLE_BITS) >>> CTRL_ENABLE_LSB;
+                const freqRange = value & CTRL_FREQ_RANGE_BITS;
+                void freqRange; // Currently unused, but could be logged or validated
+                if (enableValue === CTRL_ENABLE_ENABLE) {
+                    if (!this.isDormant) {
+                        this.enabled = true;
+                        // For simplicity, become stable immediately
+                        // In real hardware, this would take time based on STARTUP register
+                        this.stable = true;
+                    }
+                }
+                else if (enableValue === CTRL_ENABLE_DISABLE) {
+                    this.enabled = false;
+                    this.stable = false;
+                }
+                else if (enableValue !== 0) {
+                    // Invalid write to ENABLE field
+                    this.status |= STATUS_BADWRITE;
+                    this.warn(`Invalid ENABLE value written: 0x${enableValue.toString(16)}`);
+                }
+                break;
+            }
+            case XOSC_STATUS:
+                // Clear BADWRITE bit if written as 1 (write-1-to-clear)
+                if (value & STATUS_BADWRITE) {
+                    this.status &= ~STATUS_BADWRITE;
+                }
+                break;
+            case XOSC_DORMANT:
+                if (value === DORMANT_VALUE) {
+                    this.isDormant = true;
+                    this.stable = false;
+                }
+                else if (value === WAKE_VALUE) {
+                    this.isDormant = false;
+                    if (this.enabled) {
+                        this.stable = true;
+                    }
+                }
+                this.dormant = value;
+                break;
+            case XOSC_STARTUP:
+                this.startup = value & (STARTUP_X4 | STARTUP_DELAY_BITS);
+                break;
+            case XOSC_COUNT:
+                // Writing to COUNT starts the countdown
+                this.count = value & 0xff;
+                // For simplicity, we don't actually implement the countdown
+                // In real hardware, this would decrement at the XOSC frequency
+                break;
+            default:
+                super.writeUint32(offset, value);
+        }
+    }
+}

package/dist/esm/rp2040.js

@@ -24,6 +24,7 @@ import { RPTimer } from './peripherals/timer.js';
 import { RPUART } from './peripherals/uart.js';
 import { RPUSBController } from './peripherals/usb.js';
 import { RPWatchdog } from './peripherals/watchdog.js';
+import { RPXOSC } from './peripherals/xosc.js';
 import { RPSIO } from './sio.js';
 import { ConsoleLogger, LogLevel } from './utils/logging.js';
 export const FLASH_START_ADDRESS = 0x10000000;
@@ -134,7 +135,7 @@ export class RP2040 {
             0x40018: new UnimplementedPeripheral(this, 'IO_QSPI_BASE'),
             0x4001c: new RPPADS(this, 'PADS_BANK0_BASE', 'bank0'),
             0x40020: new RPPADS(this, 'PADS_QSPI_BASE', 'qspi'),
-            0x40024: new UnimplementedPeripheral(this, 'XOSC_BASE'),
+            0x40024: new RPXOSC(this, 'XOSC_BASE'),
             0x40028: new UnimplementedPeripheral(this, 'PLL_SYS_BASE'),
             0x4002c: new UnimplementedPeripheral(this, 'PLL_USB_BASE'),
             0x40030: new RPBUSCTRL(this, 'BUSCTRL_BASE'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rp2040js",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Raspberry Pi Pico (RP2040) Emulator",
   "repository": "https://github.com/wokwi/rp2040js",
   "keywords": [