rp2040js 0.14.8 → 0.14.9

package/README.md

@@ -19,6 +19,7 @@ If you want to develop your own application using the Raspberry Pi Pico simulato
 
 ## Run the demo project
 
+### Native code
 You'd need to get `hello_uart.hex` by building it from the [pico-examples repo](https://github.com/raspberrypi/pico-examples/tree/master/uart/hello_uart), then copy it to the rp2040js root directory and run:
 
 ```
@@ -26,16 +27,37 @@ npm install
 npm start
 ```
 
-To run the micropython demo, first download [rp2-pico-20210902-v1.17.uf2](https://micropython.org/resources/firmware/rp2-pico-20210902-v1.17.uf2), place it in the rp2040js root directory, then run:
+### MicroPython code
+To run the MicroPython demo, first download [rp2-pico-20210902-v1.17.uf2](https://micropython.org/resources/firmware/rp2-pico-20210902-v1.17.uf2), place it in the rp2040js root directory, then run:
 
 ```
 npm install
 npm run start:micropython
 ```
 
-and enjoy the MicroPython REPL! Quit the REPL with Ctrl+D.
+and enjoy the MicroPython REPL! Quit the REPL with Ctrl+X.
 
-You can replace rp2-pico-20210902-v1.17.uf2 any recent MicroPython or CircuitPython release built for the RP2040.
+You can replace rp2-pico-20210902-v1.17.uf2 with any recent MicroPython or CircuitPython release built for the RP2040.
+
+With MicroPython – and probably also CircuitPython – you can use the filesystem on the Pico. This becomes useful as more than one script file is used in your code. Just put a [LittleFS](https://github.com/littlefs-project/littlefs) formatted filesystem image called `littlefs.img` into the rp2040js root directory, and your `main.py` will be automatically started from there.
+
+A simple way to create a suitable LittleFS image containing your script files is outlined in [create_littlefs_image.py](https://github.com/tomods/GrinderController/blob/358ad3e0f795d8cc0bdf4f21bb35f806871d433f/tools/create_littlefs_image.py).
+So, using [littlefs-python](https://pypi.org/project/littlefs-python/), you can do the following:
+```python
+from littlefs import LittleFS
+files = ['your.py', 'files.py', 'here.py', 'main.py']
+output_image = 'output/littlefs.img'  # symlinked/copied to rp2040js root directory
+lfs = LittleFS(block_size=4096, block_count=352, prog_size=256)
+for filename in files:
+    with open(filename, 'rb') as src_file, lfs.open(filename, 'w') as lfs_file:
+        lfs_file.write(src_file.read())
+with open(output_image, 'wb') as fh:
+    fh.write(lfs.context.buffer)
+```
+
+Other ways of creating LittleFS images can be found [here](https://github.com/wokwi/littlefs-wasm) or [here](https://github.com/littlefs-project/littlefs#related-projects).
+
+Currently, the filesystem is not writeable, as the SSI peripheral required for flash writing is not implemented yet. If you're interested in hacking, see the discussion in https://github.com/wokwi/rp2040js/issues/88 for a workaround.
 
 ## Learn more
 

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

@@ -1,5 +1,7 @@
 import { IClockTimer } from '../clock/clock';
 import { BasePeripheral, Peripheral } from './peripheral';
+export declare const CPUID = 3328;
+export declare const ICSR = 3332;
 export declare const VTOR = 3336;
 export declare const SHPR2 = 3356;
 export declare const SHPR3 = 3360;

package/dist/cjs/peripherals/ppb.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RPPPB = exports.SHPR3 = exports.SHPR2 = exports.VTOR = void 0;
+exports.RPPPB = exports.SHPR3 = exports.SHPR2 = exports.VTOR = exports.ICSR = exports.CPUID = void 0;
 const irq_1 = require("../irq");
 const peripheral_1 = require("./peripheral");
+exports.CPUID = 0xd00;
+exports.ICSR = 0xd04;
 exports.VTOR = 0xd08;
 exports.SHPR2 = 0xd1c;
 exports.SHPR3 = 0xd20;
@@ -23,6 +25,18 @@ const NVIC_IPR4 = 0x410;
 const NVIC_IPR5 = 0x414;
 const NVIC_IPR6 = 0x418;
 const NVIC_IPR7 = 0x41c;
+/** ICSR Bits */
+const NMIPENDSET = 1 << 31;
+const PENDSVSET = 1 << 28;
+const PENDSVCLR = 1 << 27;
+const PENDSTSET = 1 << 26;
+const PENDSTCLR = 1 << 25;
+const ISRPREEMPT = 1 << 23;
+const ISRPENDING = 1 << 22;
+const VECTPENDING_MASK = 0x1ff;
+const VECTPENDING_SHIFT = 12;
+const VECTACTIVE_MASK = 0x1ff;
+const VECTACTIVE_SHIFT = 0;
 /** PPB stands for Private Periphral Bus.
  * These are peripherals that are part of the ARM Cortex Core, and there's one copy for each processor core.
  *
@@ -41,6 +55,21 @@ class RPPPB extends peripheral_1.BasePeripheral {
     readUint32(offset) {
         const { rp2040 } = this;
         switch (offset) {
+            case exports.CPUID:
+                return 0x410cc601; /* Verified against actual hardware */
+            case exports.ICSR: {
+                const pendingInterrupts = this.rp2040.pendingInterrupts ||
+                    this.rp2040.pendingPendSV ||
+                    this.rp2040.pendingSystick ||
+                    this.rp2040.pendingSVCall;
+                const vectPending = this.rp2040.vectPending;
+                return ((this.rp2040.pendingNMI ? NMIPENDSET : 0) |
+                    (this.rp2040.pendingPendSV ? PENDSVSET : 0) |
+                    (this.rp2040.pendingSystick ? PENDSTSET : 0) |
+                    (pendingInterrupts ? ISRPENDING : 0) |
+                    (vectPending << VECTPENDING_SHIFT) |
+                    ((this.rp2040.IPSR & VECTACTIVE_MASK) << VECTACTIVE_SHIFT));
+            }
             case exports.VTOR:
                 return rp2040.VTOR;
             /* NVIC */
@@ -100,6 +129,26 @@ class RPPPB extends peripheral_1.BasePeripheral {
         const { rp2040 } = this;
         const hardwareInterruptMask = (1 << irq_1.MAX_HARDWARE_IRQ) - 1;
         switch (offset) {
+            case exports.ICSR:
+                if (value & NMIPENDSET) {
+                    this.rp2040.pendingNMI = true;
+                    rp2040.interruptsUpdated = true;
+                }
+                if (value & PENDSVSET) {
+                    this.rp2040.pendingPendSV = true;
+                    rp2040.interruptsUpdated = true;
+                }
+                if (value & PENDSVCLR) {
+                    this.rp2040.pendingPendSV = false;
+                }
+                if (value & PENDSTSET) {
+                    this.rp2040.pendingSystick = true;
+                    rp2040.interruptsUpdated = true;
+                }
+                if (value & PENDSTCLR) {
+                    this.rp2040.pendingSystick = false;
+                }
+                return;
             case exports.VTOR:
                 rp2040.VTOR = value;
                 return;

package/dist/cjs/rp2040.d.ts

@@ -74,6 +74,8 @@ export declare class RP2040 {
     pendingInterrupts: number;
     enabledInterrupts: number;
     interruptPriorities: number[];
+    pendingNMI: boolean;
+    pendingPendSV: boolean;
     pendingSVCall: boolean;
     pendingSystick: boolean;
     interruptsUpdated: boolean;
@@ -114,10 +116,12 @@ export declare class RP2040 {
     set SPmain(value: number);
     exceptionEntry(exceptionNumber: number): void;
     exceptionReturn(excReturn: number): void;
+    get pendSVPriority(): number;
     get svCallPriority(): number;
     get systickPriority(): number;
     get gpioValues(): number;
     exceptionPriority(n: number): number;
+    get vectPending(): number;
     setInterrupt(irq: number, value: boolean): void;
     checkForInterrupts(): boolean;
     updateIOInterrupt(): void;

package/dist/cjs/rp2040.js

@@ -162,6 +162,8 @@ class RP2040 {
         this.pendingInterrupts = 0;
         this.enabledInterrupts = 0;
         this.interruptPriorities = [0xffffffff, 0x0, 0x0, 0x0];
+        this.pendingNMI = false;
+        this.pendingPendSV = false;
         this.pendingSVCall = false;
         this.pendingSystick = false;
         this.interruptsUpdated = false;
@@ -542,6 +544,9 @@ class RP2040 {
         // if CurrentMode == Mode_Thread && SCR.SLEEPONEXIT == '1' then
         // SleepOnExit(); // IMPLEMENTATION DEFINED
     }
+    get pendSVPriority() {
+        return (this.SHPR3 >> 22) & 0x3;
+    }
     get svCallPriority() {
         return this.SHPR2 >>> 30;
     }
@@ -569,9 +574,9 @@ class RP2040 {
             case EXC_SVCALL:
                 return this.svCallPriority;
             case EXC_PENDSV:
-                return (this.readUint32(this.SHPR3) >> 22) & 0x3;
+                return this.pendSVPriority;
             case EXC_SYSTICK:
-                return this.readUint32(this.SHPR3) >>> 30;
+                return this.systickPriority;
             default: {
                 if (n < 16) {
                     return LOWEST_PRIORITY;
@@ -586,6 +591,32 @@ class RP2040 {
             }
         }
     }
+    get vectPending() {
+        if (this.pendingNMI) {
+            return EXC_NMI;
+        }
+        const { svCallPriority, systickPriority, pendSVPriority, pendingInterrupts } = this;
+        for (let priority = 0; priority < LOWEST_PRIORITY; priority++) {
+            const levelInterrupts = pendingInterrupts & this.interruptPriorities[priority];
+            if (this.pendingSVCall && priority === svCallPriority) {
+                return EXC_SVCALL;
+            }
+            if (this.pendingPendSV && priority === pendSVPriority) {
+                return EXC_PENDSV;
+            }
+            if (this.pendingSystick && priority === systickPriority) {
+                return EXC_SYSTICK;
+            }
+            if (levelInterrupts) {
+                for (let interruptNumber = 0; interruptNumber < 32; interruptNumber++) {
+                    if (levelInterrupts & (1 << interruptNumber)) {
+                        return 16 + interruptNumber;
+                    }
+                }
+            }
+        }
+        return 0;
+    }
     setInterrupt(irq, value) {
         const irqBit = 1 << irq;
         if (value && !(this.pendingInterrupts & irqBit)) {
@@ -611,7 +642,12 @@ class RP2040 {
                 : LOWEST_PRIORITY
             : Math.min(this.exceptionPriority(this.IPSR), this.PM ? 0 : LOWEST_PRIORITY);
         const interruptSet = this.pendingInterrupts & this.enabledInterrupts;
-        const { svCallPriority, systickPriority } = this;
+        const { svCallPriority, systickPriority, pendSVPriority } = this;
+        if (this.pendingNMI) {
+            this.pendingNMI = false;
+            this.exceptionEntry(EXC_NMI);
+            return true;
+        }
         for (let priority = 0; priority < currentPriority; priority++) {
             const levelInterrupts = interruptSet & this.interruptPriorities[priority];
             if (this.pendingSVCall && priority === svCallPriority) {
@@ -619,6 +655,11 @@ class RP2040 {
                 this.exceptionEntry(EXC_SVCALL);
                 return true;
             }
+            if (this.pendingPendSV && priority === pendSVPriority) {
+                this.pendingPendSV = false;
+                this.exceptionEntry(EXC_PENDSV);
+                return true;
+            }
             if (this.pendingSystick && priority === systickPriority) {
                 this.pendingSystick = false;
                 this.exceptionEntry(EXC_SYSTICK);

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

@@ -1,5 +1,7 @@
 import { IClockTimer } from '../clock/clock';
 import { BasePeripheral, Peripheral } from './peripheral';
+export declare const CPUID = 3328;
+export declare const ICSR = 3332;
 export declare const VTOR = 3336;
 export declare const SHPR2 = 3356;
 export declare const SHPR3 = 3360;

package/dist/esm/peripherals/ppb.js

@@ -1,5 +1,7 @@
 import { MAX_HARDWARE_IRQ } from '../irq';
 import { BasePeripheral } from './peripheral';
+export const CPUID = 0xd00;
+export const ICSR = 0xd04;
 export const VTOR = 0xd08;
 export const SHPR2 = 0xd1c;
 export const SHPR3 = 0xd20;
@@ -20,6 +22,18 @@ const NVIC_IPR4 = 0x410;
 const NVIC_IPR5 = 0x414;
 const NVIC_IPR6 = 0x418;
 const NVIC_IPR7 = 0x41c;
+/** ICSR Bits */
+const NMIPENDSET = 1 << 31;
+const PENDSVSET = 1 << 28;
+const PENDSVCLR = 1 << 27;
+const PENDSTSET = 1 << 26;
+const PENDSTCLR = 1 << 25;
+const ISRPREEMPT = 1 << 23;
+const ISRPENDING = 1 << 22;
+const VECTPENDING_MASK = 0x1ff;
+const VECTPENDING_SHIFT = 12;
+const VECTACTIVE_MASK = 0x1ff;
+const VECTACTIVE_SHIFT = 0;
 /** PPB stands for Private Periphral Bus.
  * These are peripherals that are part of the ARM Cortex Core, and there's one copy for each processor core.
  *
@@ -38,6 +52,21 @@ export class RPPPB extends BasePeripheral {
     readUint32(offset) {
         const { rp2040 } = this;
         switch (offset) {
+            case CPUID:
+                return 0x410cc601; /* Verified against actual hardware */
+            case ICSR: {
+                const pendingInterrupts = this.rp2040.pendingInterrupts ||
+                    this.rp2040.pendingPendSV ||
+                    this.rp2040.pendingSystick ||
+                    this.rp2040.pendingSVCall;
+                const vectPending = this.rp2040.vectPending;
+                return ((this.rp2040.pendingNMI ? NMIPENDSET : 0) |
+                    (this.rp2040.pendingPendSV ? PENDSVSET : 0) |
+                    (this.rp2040.pendingSystick ? PENDSTSET : 0) |
+                    (pendingInterrupts ? ISRPENDING : 0) |
+                    (vectPending << VECTPENDING_SHIFT) |
+                    ((this.rp2040.IPSR & VECTACTIVE_MASK) << VECTACTIVE_SHIFT));
+            }
             case VTOR:
                 return rp2040.VTOR;
             /* NVIC */
@@ -97,6 +126,26 @@ export class RPPPB extends BasePeripheral {
         const { rp2040 } = this;
         const hardwareInterruptMask = (1 << MAX_HARDWARE_IRQ) - 1;
         switch (offset) {
+            case ICSR:
+                if (value & NMIPENDSET) {
+                    this.rp2040.pendingNMI = true;
+                    rp2040.interruptsUpdated = true;
+                }
+                if (value & PENDSVSET) {
+                    this.rp2040.pendingPendSV = true;
+                    rp2040.interruptsUpdated = true;
+                }
+                if (value & PENDSVCLR) {
+                    this.rp2040.pendingPendSV = false;
+                }
+                if (value & PENDSTSET) {
+                    this.rp2040.pendingSystick = true;
+                    rp2040.interruptsUpdated = true;
+                }
+                if (value & PENDSTCLR) {
+                    this.rp2040.pendingSystick = false;
+                }
+                return;
             case VTOR:
                 rp2040.VTOR = value;
                 return;

package/dist/esm/rp2040.d.ts

@@ -74,6 +74,8 @@ export declare class RP2040 {
     pendingInterrupts: number;
     enabledInterrupts: number;
     interruptPriorities: number[];
+    pendingNMI: boolean;
+    pendingPendSV: boolean;
     pendingSVCall: boolean;
     pendingSystick: boolean;
     interruptsUpdated: boolean;
@@ -114,10 +116,12 @@ export declare class RP2040 {
     set SPmain(value: number);
     exceptionEntry(exceptionNumber: number): void;
     exceptionReturn(excReturn: number): void;
+    get pendSVPriority(): number;
     get svCallPriority(): number;
     get systickPriority(): number;
     get gpioValues(): number;
     exceptionPriority(n: number): number;
+    get vectPending(): number;
     setInterrupt(irq: number, value: boolean): void;
     checkForInterrupts(): boolean;
     updateIOInterrupt(): void;

package/dist/esm/rp2040.js

@@ -159,6 +159,8 @@ export class RP2040 {
         this.pendingInterrupts = 0;
         this.enabledInterrupts = 0;
         this.interruptPriorities = [0xffffffff, 0x0, 0x0, 0x0];
+        this.pendingNMI = false;
+        this.pendingPendSV = false;
         this.pendingSVCall = false;
         this.pendingSystick = false;
         this.interruptsUpdated = false;
@@ -539,6 +541,9 @@ export class RP2040 {
         // if CurrentMode == Mode_Thread && SCR.SLEEPONEXIT == '1' then
         // SleepOnExit(); // IMPLEMENTATION DEFINED
     }
+    get pendSVPriority() {
+        return (this.SHPR3 >> 22) & 0x3;
+    }
     get svCallPriority() {
         return this.SHPR2 >>> 30;
     }
@@ -566,9 +571,9 @@ export class RP2040 {
             case EXC_SVCALL:
                 return this.svCallPriority;
             case EXC_PENDSV:
-                return (this.readUint32(this.SHPR3) >> 22) & 0x3;
+                return this.pendSVPriority;
             case EXC_SYSTICK:
-                return this.readUint32(this.SHPR3) >>> 30;
+                return this.systickPriority;
             default: {
                 if (n < 16) {
                     return LOWEST_PRIORITY;
@@ -583,6 +588,32 @@ export class RP2040 {
             }
         }
     }
+    get vectPending() {
+        if (this.pendingNMI) {
+            return EXC_NMI;
+        }
+        const { svCallPriority, systickPriority, pendSVPriority, pendingInterrupts } = this;
+        for (let priority = 0; priority < LOWEST_PRIORITY; priority++) {
+            const levelInterrupts = pendingInterrupts & this.interruptPriorities[priority];
+            if (this.pendingSVCall && priority === svCallPriority) {
+                return EXC_SVCALL;
+            }
+            if (this.pendingPendSV && priority === pendSVPriority) {
+                return EXC_PENDSV;
+            }
+            if (this.pendingSystick && priority === systickPriority) {
+                return EXC_SYSTICK;
+            }
+            if (levelInterrupts) {
+                for (let interruptNumber = 0; interruptNumber < 32; interruptNumber++) {
+                    if (levelInterrupts & (1 << interruptNumber)) {
+                        return 16 + interruptNumber;
+                    }
+                }
+            }
+        }
+        return 0;
+    }
     setInterrupt(irq, value) {
         const irqBit = 1 << irq;
         if (value && !(this.pendingInterrupts & irqBit)) {
@@ -608,7 +639,12 @@ export class RP2040 {
                 : LOWEST_PRIORITY
             : Math.min(this.exceptionPriority(this.IPSR), this.PM ? 0 : LOWEST_PRIORITY);
         const interruptSet = this.pendingInterrupts & this.enabledInterrupts;
-        const { svCallPriority, systickPriority } = this;
+        const { svCallPriority, systickPriority, pendSVPriority } = this;
+        if (this.pendingNMI) {
+            this.pendingNMI = false;
+            this.exceptionEntry(EXC_NMI);
+            return true;
+        }
         for (let priority = 0; priority < currentPriority; priority++) {
             const levelInterrupts = interruptSet & this.interruptPriorities[priority];
             if (this.pendingSVCall && priority === svCallPriority) {
@@ -616,6 +652,11 @@ export class RP2040 {
                 this.exceptionEntry(EXC_SVCALL);
                 return true;
             }
+            if (this.pendingPendSV && priority === pendSVPriority) {
+                this.pendingPendSV = false;
+                this.exceptionEntry(EXC_PENDSV);
+                return true;
+            }
             if (this.pendingSystick && priority === systickPriority) {
                 this.pendingSystick = false;
                 this.exceptionEntry(EXC_SYSTICK);

package/package.json

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