rp2040js 1.3.3 → 1.4.0

package/dist/esm/peripherals/pwm.js

@@ -103,12 +103,15 @@ class PWMChannel {
                 if (value & CSR_EN && !(this.csr & CSR_EN)) {
                     this.updateDoubleBuffered();
                 }
+                // PH_ADV and PH_RET are self-clearing, so they never appear in the stored csr value
                 this.csr = value & ~(CSR_PH_ADV | CSR_PH_RET);
-                if (this.csr & CSR_PH_ADV) {
-                    this.timer.advance(1);
-                }
-                if (this.csr & CSR_PH_RET) {
-                    this.timer.advance(-1);
+                if (value & CSR_EN) {
+                    if (value & CSR_PH_ADV) {
+                        this.timer.advance(1);
+                    }
+                    if (value & CSR_PH_RET) {
+                        this.timer.advance(-1);
+                    }
                 }
                 this.divMode = (this.csr >> CSR_DIVMODE_SHIFT) & CSR_DIVMODE_MASK;
                 this.setBDirection(this.divMode === PWMDivMode.FreeRunning);

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

@@ -28,6 +28,8 @@ export declare class RPUART extends BasePeripheral implements Peripheral {
     get wordLength(): 5 | 6 | 7 | 8 | undefined;
     get baudDivider(): number;
     get baudRate(): number;
+    /** Re-reports the baud rate, unless the firmware has not set the divider yet. */
+    clkPeriChanged(): void;
     get flags(): number;
     checkInterrupts(): void;
     feedByte(value: number): void;

package/dist/esm/peripherals/uart.js

@@ -77,6 +77,13 @@ export class RPUART extends BasePeripheral {
     get baudRate() {
         return Math.round(this.rp2040.clkPeri / (this.baudDivider * 16));
     }
+    /** Re-reports the baud rate, unless the firmware has not set the divider yet. */
+    clkPeriChanged() {
+        var _a;
+        if (this.baudDivider) {
+            (_a = this.onBaudRateChange) === null || _a === void 0 ? void 0 : _a.call(this, this.baudRate);
+        }
+    }
     get flags() {
         return (this.rxFIFO.full ? RXFF : 0) | (this.rxFIFO.empty ? RXFE : 0) | TXFE;
     }

package/dist/esm/rp2040.d.ts

@@ -2,10 +2,12 @@ import { IClock } from './clock/clock.js';
 import { CortexM0Core } from './cortex-m0-core.js';
 import { GPIOPin } from './gpio-pin.js';
 import { RPADC } from './peripherals/adc.js';
+import { RPClocks } from './peripherals/clocks.js';
 import { RPDMA } from './peripherals/dma.js';
 import { RPI2C } from './peripherals/i2c.js';
 import { Peripheral } from './peripherals/peripheral.js';
 import { RPPIO } from './peripherals/pio.js';
+import { RPPLL } from './peripherals/pll.js';
 import { RPPPB } from './peripherals/ppb.js';
 import { RPPWM } from './peripherals/pwm.js';
 import { RPSPI } from './peripherals/spi.js';
@@ -19,6 +21,11 @@ export declare const RAM_START_ADDRESS = 536870912;
 export declare const APB_START_ADDRESS = 1073741824;
 export declare const DPRAM_START_ADDRESS = 1343225856;
 export declare const SIO_START_ADDRESS = 3489660928;
+/**
+ * Notified after clk_sys changes. Listeners that cache a frequency derived from clk_sys
+ * (PIO clock dividers, for instance) use this to re-derive it.
+ */
+export type ClockListener = (clkSys: number, oldClkSys: number) => void;
 export declare class RP2040 {
     readonly clock: IClock;
     readonly bootrom: Uint32Array<ArrayBuffer>;
@@ -32,6 +39,13 @@ export declare class RP2040 {
     readonly core: CortexM0Core;
     clkSys: number;
     clkPeri: number;
+    /** Crystal oscillator frequency. 12 MHz on the Raspberry Pi Pico and most other boards. */
+    xoscFreq: number;
+    /** Ring oscillator frequency. Varies with voltage/temperature on real silicon. */
+    roscFreq: number;
+    readonly pllSys: RPPLL;
+    readonly pllUsb: RPPLL;
+    readonly clocks: RPClocks;
     readonly ppb: RPPPB;
     readonly sio: RPSIO;
     readonly uart: RPUART[];
@@ -45,6 +59,7 @@ export declare class RP2040 {
     readonly usbCtrl: RPUSBController;
     readonly spi: RPSPI[];
     logger: Logger;
+    private readonly clockListeners;
     readonly peripherals: {
         [index: number]: Peripheral;
     };
@@ -53,6 +68,15 @@ export declare class RP2040 {
     loadBootrom(bootromData: Uint32Array): void;
     reset(): void;
     readUint32(address: number): number;
+    /**
+     * Recomputes `clkSys` and `clkPeri` from the PLL and CLOCKS registers and updates the
+     * peripherals derived from them. Until firmware configures the clock tree, each keeps its default.
+     */
+    updateClocks(): void;
+    private updateClkSys;
+    private updateClkPeri;
+    /** Registers a listener to be notified whenever clk_sys changes. Returns an unsubscribe function. */
+    addClockListener(listener: ClockListener): () => boolean;
     findPeripheral(address: number): Peripheral;
     /** We assume the address is 16-bit aligned */
     readUint16(address: number): number;

package/dist/esm/rp2040.js

@@ -11,6 +11,7 @@ import { RPIO } from './peripherals/io.js';
 import { RPPADS } from './peripherals/pads.js';
 import { UnimplementedPeripheral } from './peripherals/peripheral.js';
 import { RPPIO } from './peripherals/pio.js';
+import { RPPLL } from './peripherals/pll.js';
 import { RPPPB } from './peripherals/ppb.js';
 import { RPPSM } from './peripherals/psm.js';
 import { RPPWM } from './peripherals/pwm.js';
@@ -53,6 +54,13 @@ export class RP2040 {
         /* Clocks */
         this.clkSys = 125 * MHz;
         this.clkPeri = 125 * MHz;
+        /** Crystal oscillator frequency. 12 MHz on the Raspberry Pi Pico and most other boards. */
+        this.xoscFreq = 12 * MHz;
+        /** Ring oscillator frequency. Varies with voltage/temperature on real silicon. */
+        this.roscFreq = 6.5 * MHz;
+        this.pllSys = new RPPLL(this, 'PLL_SYS_BASE');
+        this.pllUsb = new RPPLL(this, 'PLL_USB_BASE');
+        this.clocks = new RPClocks(this, 'CLOCKS_BASE');
         this.ppb = new RPPPB(this, 'PPB');
         this.sio = new RPSIO(this);
         this.uart = [
@@ -125,11 +133,12 @@ export class RP2040 {
             }),
         ];
         this.logger = new ConsoleLogger(LogLevel.Debug, true);
+        this.clockListeners = new Set();
         this.peripherals = {
             0x18000: new RPSSI(this, 'SSI'),
             0x40000: new RP2040SysInfo(this, 'SYSINFO_BASE'),
             0x40004: new RP2040SysCfg(this, 'SYSCFG'),
-            0x40008: new RPClocks(this, 'CLOCKS_BASE'),
+            0x40008: this.clocks,
             0x4000c: new RPReset(this, 'RESETS_BASE'),
             0x40010: new RPPSM(this, 'PSM_BASE'),
             0x40014: new RPIO(this, 'IO_BANK0_BASE'),
@@ -137,8 +146,8 @@ export class RP2040 {
             0x4001c: new RPPADS(this, 'PADS_BANK0_BASE', 'bank0'),
             0x40020: new RPPADS(this, 'PADS_QSPI_BASE', 'qspi'),
             0x40024: new RPXOSC(this, 'XOSC_BASE'),
-            0x40028: new UnimplementedPeripheral(this, 'PLL_SYS_BASE'),
-            0x4002c: new UnimplementedPeripheral(this, 'PLL_USB_BASE'),
+            0x40028: this.pllSys,
+            0x4002c: this.pllUsb,
             0x40030: new RPBUSCTRL(this, 'BUSCTRL_BASE'),
             0x40034: this.uart[0],
             0x40038: this.uart[1],
@@ -214,6 +223,46 @@ export class RP2040 {
         this.logger.warn(LOG_NAME, `Read from invalid memory address: ${address.toString(16)}`);
         return 0xffffffff;
     }
+    /**
+     * Recomputes `clkSys` and `clkPeri` from the PLL and CLOCKS registers and updates the
+     * peripherals derived from them. Until firmware configures the clock tree, each keeps its default.
+     */
+    updateClocks() {
+        this.updateClkSys();
+        this.updateClkPeri();
+    }
+    updateClkSys() {
+        const clkSys = this.clocks.sysFreq;
+        // 0 means clk_sys is fed from an unmodelled or unconfigured source: keep the last value
+        if (!clkSys || clkSys === this.clkSys) {
+            return;
+        }
+        const oldClkSys = this.clkSys;
+        this.clkSys = clkSys;
+        this.ppb.systickTimer.frequency = clkSys;
+        for (const channel of this.pwm.channels) {
+            channel.timer.frequency = this.pwm.clockFreq;
+        }
+        for (const listener of this.clockListeners) {
+            listener(clkSys, oldClkSys);
+        }
+    }
+    updateClkPeri() {
+        const clkPeri = this.clocks.periFreq;
+        // 0 means the clock generator is stopped, or the source is one we do not model
+        if (!clkPeri || clkPeri === this.clkPeri) {
+            return;
+        }
+        this.clkPeri = clkPeri;
+        for (const uart of this.uart) {
+            uart.clkPeriChanged();
+        }
+    }
+    /** Registers a listener to be notified whenever clk_sys changes. Returns an unsubscribe function. */
+    addClockListener(listener) {
+        this.clockListeners.add(listener);
+        return () => this.clockListeners.delete(listener);
+    }
     findPeripheral(address) {
         return this.peripherals[(address >>> 14) << 2];
     }

package/dist/esm/utils/timer32.js

@@ -34,6 +34,12 @@ export class Timer32 {
      */
     advance(delta) {
         this.baseValue += delta;
+        if (this.topValue !== 0xffffffff) {
+            // Keep the base value in range, so that retarding past 0 wraps around to the top
+            const topModulo = this.timerMode === TimerMode.ZigZag ? this.topValue * 2 : this.topValue + 1;
+            this.baseValue = ((this.baseValue % topModulo) + topModulo) % topModulo;
+        }
+        this.updated();
     }
     get rawCounter() {
         const { baseFreq, prescalerValue, baseNanos, baseValue, enabled, timerMode } = this;

package/package.json

@@ -1,88 +1,88 @@
-{
-  "name": "rp2040js",
-  "version": "1.3.3",
-  "description": "Raspberry Pi Pico (RP2040) Emulator",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/wokwi/rp2040js.git"
-  },
-  "keywords": [
-    "rp2040",
-    "raspberry pi pico",
-    "emulator"
-  ],
-  "files": [
-    "dist"
-  ],
-  "author": "Uri Shaked <uri@wokwi.com>",
-  "license": "MIT",
-  "type": "module",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "typings": "./dist/cjs/index.d.ts",
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
-      },
-      "require": {
-        "types": "./dist/cjs/index.d.ts",
-        "default": "./dist/cjs/index.js"
-      }
-    },
-    "./gdb-tcp-server": {
-      "import": {
-        "types": "./dist/esm/gdb/gdb-tcp-server.d.ts",
-        "default": "./dist/esm/gdb/gdb-tcp-server.js"
-      },
-      "require": {
-        "types": "./dist/cjs/gdb/gdb-tcp-server.d.ts",
-        "default": "./dist/cjs/gdb/gdb-tcp-server.js"
-      }
-    }
-  },
-  "scripts": {
-    "build": "rimraf dist && tsc && tsc -p tsconfig.cjs.json && node build-scripts/dist-package-json",
-    "prepublish": "npm run build",
-    "prepare": "husky install",
-    "format:check": "prettier --check **/*.{ts,js} !**/dist/** !**/node_modules/**",
-    "lint": "eslint . --ext .ts",
-    "start": "tsx demo/emulator-run.ts",
-    "start:micropython": "tsx demo/micropython-run.ts",
-    "start:circuitpython": "tsx demo/micropython-run.ts --circuitpython",
-    "start:gdbdiff": "tsx debug/gdbdiff.ts",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:micropython-spi": "tsx test/micropython-spi-test.ts"
-  },
-  "devDependencies": {
-    "@types/minimist": "^1.2.2",
-    "@types/node": "^20",
-    "@typescript-eslint/eslint-plugin": "^6.7.3",
-    "@typescript-eslint/parser": "^6.7.3",
-    "eslint": "^8.50.0",
-    "husky": "^8.0.3",
-    "lint-staged": "^15.4.3",
-    "minimist": "^1.2.7",
-    "prettier": "^3.0.3",
-    "prettier-plugin-organize-imports": "^4.3.0",
-    "rimraf": "^5.0.5",
-    "tsx": "^4.19.3",
-    "typescript": "^5.7.3",
-    "uf2": "^1.0.0",
-    "vitest": "^4.1.9"
-  },
-  "lint-staged": {
-    "**/*.ts": [
-      "eslint --fix",
-      "prettier --write"
-    ],
-    "**/*.js": [
-      "prettier --write"
-    ]
-  }
-}
+{
+  "name": "rp2040js",
+  "version": "1.4.0",
+  "description": "Raspberry Pi Pico (RP2040) Emulator",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wokwi/rp2040js.git"
+  },
+  "keywords": [
+    "rp2040",
+    "raspberry pi pico",
+    "emulator"
+  ],
+  "files": [
+    "dist"
+  ],
+  "author": "Uri Shaked <uri@wokwi.com>",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "typings": "./dist/cjs/index.d.ts",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./gdb-tcp-server": {
+      "import": {
+        "types": "./dist/esm/gdb/gdb-tcp-server.d.ts",
+        "default": "./dist/esm/gdb/gdb-tcp-server.js"
+      },
+      "require": {
+        "types": "./dist/cjs/gdb/gdb-tcp-server.d.ts",
+        "default": "./dist/cjs/gdb/gdb-tcp-server.js"
+      }
+    }
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc && tsc -p tsconfig.cjs.json && node build-scripts/dist-package-json",
+    "prepublish": "npm run build",
+    "prepare": "husky install",
+    "format:check": "prettier --check **/*.{ts,js} !**/dist/** !**/node_modules/**",
+    "lint": "eslint . --ext .ts",
+    "start": "tsx demo/emulator-run.ts",
+    "start:micropython": "tsx demo/micropython-run.ts",
+    "start:circuitpython": "tsx demo/micropython-run.ts --circuitpython",
+    "start:gdbdiff": "tsx debug/gdbdiff.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:micropython-spi": "tsx test/micropython-spi-test.ts"
+  },
+  "devDependencies": {
+    "@types/minimist": "^1.2.2",
+    "@types/node": "^20",
+    "@typescript-eslint/eslint-plugin": "^6.7.3",
+    "@typescript-eslint/parser": "^6.7.3",
+    "eslint": "^8.50.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^15.4.3",
+    "minimist": "^1.2.7",
+    "prettier": "^3.0.3",
+    "prettier-plugin-organize-imports": "^4.3.0",
+    "rimraf": "^5.0.5",
+    "tsx": "^4.19.3",
+    "typescript": "^5.7.3",
+    "uf2": "^1.0.0",
+    "vitest": "^4.1.9"
+  },
+  "lint-staged": {
+    "**/*.ts": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "**/*.js": [
+      "prettier --write"
+    ]
+  }
+}