rp2040js 0.17.15 → 0.17.17

package/README.md

@@ -30,7 +30,7 @@ npm start
 
 ### 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:
+To run the MicroPython demo, first download [RPI_PICO-20230426-v1.20.0.uf2](https://micropython.org/resources/firmware/RPI_PICO-20230426-v1.20.0.uf2), place it in the rp2040js root directory, then run:
 
 ```
 npm install

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

@@ -1,8 +1,14 @@
 import { RP2040 } from '../rp2040';
 import { FIFO } from '../utils/fifo';
+import { DREQChannel } from './dma';
 import { BasePeripheral, Peripheral } from './peripheral';
+export interface ISPIDMAChannels {
+    rx: DREQChannel;
+    tx: DREQChannel;
+}
 export declare class RPSPI extends BasePeripheral implements Peripheral {
     readonly irq: number;
+    readonly dreq: ISPIDMAChannels;
     readonly rxFIFO: FIFO;
     readonly txFIFO: FIFO;
     onTransmit: (value: number) => void;
@@ -20,7 +26,9 @@ export declare class RPSPI extends BasePeripheral implements Peripheral {
     get masterMode(): boolean;
     get spiMode(): 2 | 3 | 0 | 1;
     get clockFrequency(): number;
-    constructor(rp2040: RP2040, name: string, irq: number);
+    private updateDMATx;
+    private updateDMARx;
+    constructor(rp2040: RP2040, name: string, irq: number, dreq: ISPIDMAChannels);
     private doTX;
     completeTransmit(rxValue: number): void;
     checkInterrupts(): void;

package/dist/cjs/peripherals/spi.js

@@ -53,9 +53,10 @@ const SSPRXINTR = 1 << 2;
 const SSPRTINTR = 1 << 1;
 const SSPRORINTR = 1 << 0;
 class RPSPI extends peripheral_1.BasePeripheral {
-    constructor(rp2040, name, irq) {
+    constructor(rp2040, name, irq, dreq) {
         super(rp2040, name);
         this.irq = irq;
+        this.dreq = dreq;
         this.rxFIFO = new fifo_1.FIFO(8);
         this.txFIFO = new fifo_1.FIFO(8);
         // User provided callbacks
@@ -67,6 +68,8 @@ class RPSPI extends peripheral_1.BasePeripheral {
         this.clockDivisor = 0;
         this.intRaw = 0;
         this.intEnable = 0;
+        this.updateDMATx();
+        this.updateDMARx();
     }
     get intStatus() {
         return this.intRaw & this.intEnable;
@@ -93,6 +96,22 @@ class RPSPI extends peripheral_1.BasePeripheral {
         const scr = (this.control0 >> SCR_SHIFT) & SCR_MASK;
         return this.rp2040.clkPeri / (this.clockDivisor * (1 + scr));
     }
+    updateDMATx() {
+        if (this.txFIFO.full) {
+            this.rp2040.dma.clearDREQ(this.dreq.tx);
+        }
+        else {
+            this.rp2040.dma.setDREQ(this.dreq.tx);
+        }
+    }
+    updateDMARx() {
+        if (this.rxFIFO.empty) {
+            this.rp2040.dma.clearDREQ(this.dreq.rx);
+        }
+        else {
+            this.rp2040.dma.setDREQ(this.dreq.rx);
+        }
+    }
     doTX() {
         if (!this.busy && !this.txFIFO.empty) {
             const value = this.txFIFO.pull();
@@ -132,6 +151,8 @@ class RPSPI extends peripheral_1.BasePeripheral {
         if (this.intStatus !== prevStatus) {
             this.checkInterrupts();
         }
+        this.updateDMATx();
+        this.updateDMARx();
     }
     readUint32(offset) {
         switch (offset) {
@@ -191,7 +212,8 @@ class RPSPI extends peripheral_1.BasePeripheral {
                 return;
             case SSPDR:
                 if (!this.txFIFO.full) {
-                    this.txFIFO.push(value);
+                    // decoded with respect to SSPCR0.DSS
+                    this.txFIFO.push(value & ((1 << this.dataBits) - 1));
                     this.doTX();
                     this.fifosUpdated();
                 }

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

@@ -1,14 +1,20 @@
 import { RP2040 } from '../rp2040';
+import { DREQChannel } from './dma';
 import { BasePeripheral, Peripheral } from './peripheral';
+export interface IUARTDMAChannels {
+    rx: DREQChannel;
+    tx: DREQChannel;
+}
 export declare class RPUART extends BasePeripheral implements Peripheral {
     readonly irq: number;
+    readonly dreq: IUARTDMAChannels;
     private ctrlRegister;
     private lineCtrlRegister;
     private rxFIFO;
     private interruptMask;
     private interruptStatus;
     onByte?: (value: number) => void;
-    constructor(rp2040: RP2040, name: string, irq: number);
+    constructor(rp2040: RP2040, name: string, irq: number, dreq: IUARTDMAChannels);
     get enabled(): boolean;
     get txEnabled(): boolean;
     get rxEnabled(): boolean;

package/dist/cjs/peripherals/uart.js

@@ -24,9 +24,10 @@ const UARTEN = 1 << 0;
 // Interrupt bits
 const UARTRXINTR = 1 << 4;
 class RPUART extends peripheral_1.BasePeripheral {
-    constructor(rp2040, name, irq) {
+    constructor(rp2040, name, irq, dreq) {
         super(rp2040, name);
         this.irq = irq;
+        this.dreq = dreq;
         this.ctrlRegister = RXE | TXE;
         this.lineCtrlRegister = 0;
         this.rxFIFO = new fifo_1.FIFO(32);
@@ -108,6 +109,12 @@ class RPUART extends peripheral_1.BasePeripheral {
                 break;
             case UARTCR:
                 this.ctrlRegister = value;
+                if (this.enabled) {
+                    this.rp2040.dma.setDREQ(this.dreq.tx);
+                }
+                else {
+                    this.rp2040.dma.clearDREQ(this.dreq.tx);
+                }
                 break;
             case UARTIMSC:
                 this.interruptMask = value & 0x7ff;

package/dist/cjs/rp2040.d.ts

@@ -35,7 +35,6 @@ export declare class RP2040 {
     readonly sio: RPSIO;
     readonly uart: RPUART[];
     readonly i2c: RPI2C[];
-    readonly spi: RPSPI[];
     readonly pwm: RPPWM;
     readonly adc: RPADC;
     readonly gpio: GPIOPin[];
@@ -43,6 +42,7 @@ export declare class RP2040 {
     readonly dma: RPDMA;
     readonly pio: RPPIO[];
     readonly usbCtrl: RPUSBController;
+    readonly spi: RPSPI[];
     private stopped;
     logger: Logger;
     private executeTimer;

package/dist/cjs/rp2040.js

@@ -54,9 +54,17 @@ class RP2040 {
         this.clkPeri = 125 * MHz;
         this.ppb = new ppb_1.RPPPB(this, 'PPB');
         this.sio = new sio_1.RPSIO(this);
-        this.uart = [new uart_1.RPUART(this, 'UART0', irq_1.IRQ.UART0), new uart_1.RPUART(this, 'UART1', irq_1.IRQ.UART1)];
+        this.uart = [
+            new uart_1.RPUART(this, 'UART0', irq_1.IRQ.UART0, {
+                rx: dma_1.DREQChannel.DREQ_UART0_RX,
+                tx: dma_1.DREQChannel.DREQ_UART0_TX,
+            }),
+            new uart_1.RPUART(this, 'UART1', irq_1.IRQ.UART1, {
+                rx: dma_1.DREQChannel.DREQ_UART1_RX,
+                tx: dma_1.DREQChannel.DREQ_UART1_TX,
+            }),
+        ];
         this.i2c = [new i2c_1.RPI2C(this, 'I2C0', irq_1.IRQ.I2C0), new i2c_1.RPI2C(this, 'I2C1', irq_1.IRQ.I2C1)];
-        this.spi = [new spi_1.RPSPI(this, 'SPI0', irq_1.IRQ.SPI0), new spi_1.RPSPI(this, 'SPI1', irq_1.IRQ.SPI1)];
         this.pwm = new pwm_1.RPPWM(this, 'PWM_BASE');
         this.adc = new adc_1.RPADC(this, 'ADC');
         this.gpio = [
@@ -105,6 +113,16 @@ class RP2040 {
             new pio_1.RPPIO(this, 'PIO1', irq_1.IRQ.PIO1_IRQ0, 1),
         ];
         this.usbCtrl = new usb_1.RPUSBController(this, 'USB');
+        this.spi = [
+            new spi_1.RPSPI(this, 'SPI0', irq_1.IRQ.SPI0, {
+                rx: dma_1.DREQChannel.DREQ_SPI0_RX,
+                tx: dma_1.DREQChannel.DREQ_SPI0_TX,
+            }),
+            new spi_1.RPSPI(this, 'SPI1', irq_1.IRQ.SPI1, {
+                rx: dma_1.DREQChannel.DREQ_SPI1_RX,
+                tx: dma_1.DREQChannel.DREQ_SPI1_TX,
+            }),
+        ];
         this.stopped = true;
         this.logger = new logging_1.ConsoleLogger(logging_1.LogLevel.Debug, true);
         this.executeTimer = null;

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

@@ -1,8 +1,14 @@
 import { RP2040 } from '../rp2040';
 import { FIFO } from '../utils/fifo';
+import { DREQChannel } from './dma';
 import { BasePeripheral, Peripheral } from './peripheral';
+export interface ISPIDMAChannels {
+    rx: DREQChannel;
+    tx: DREQChannel;
+}
 export declare class RPSPI extends BasePeripheral implements Peripheral {
     readonly irq: number;
+    readonly dreq: ISPIDMAChannels;
     readonly rxFIFO: FIFO;
     readonly txFIFO: FIFO;
     onTransmit: (value: number) => void;
@@ -20,7 +26,9 @@ export declare class RPSPI extends BasePeripheral implements Peripheral {
     get masterMode(): boolean;
     get spiMode(): 2 | 3 | 0 | 1;
     get clockFrequency(): number;
-    constructor(rp2040: RP2040, name: string, irq: number);
+    private updateDMATx;
+    private updateDMARx;
+    constructor(rp2040: RP2040, name: string, irq: number, dreq: ISPIDMAChannels);
     private doTX;
     completeTransmit(rxValue: number): void;
     checkInterrupts(): void;

package/dist/esm/peripherals/spi.js

@@ -50,9 +50,10 @@ const SSPRXINTR = 1 << 2;
 const SSPRTINTR = 1 << 1;
 const SSPRORINTR = 1 << 0;
 export class RPSPI extends BasePeripheral {
-    constructor(rp2040, name, irq) {
+    constructor(rp2040, name, irq, dreq) {
         super(rp2040, name);
         this.irq = irq;
+        this.dreq = dreq;
         this.rxFIFO = new FIFO(8);
         this.txFIFO = new FIFO(8);
         // User provided callbacks
@@ -64,6 +65,8 @@ export class RPSPI extends BasePeripheral {
         this.clockDivisor = 0;
         this.intRaw = 0;
         this.intEnable = 0;
+        this.updateDMATx();
+        this.updateDMARx();
     }
     get intStatus() {
         return this.intRaw & this.intEnable;
@@ -90,6 +93,22 @@ export class RPSPI extends BasePeripheral {
         const scr = (this.control0 >> SCR_SHIFT) & SCR_MASK;
         return this.rp2040.clkPeri / (this.clockDivisor * (1 + scr));
     }
+    updateDMATx() {
+        if (this.txFIFO.full) {
+            this.rp2040.dma.clearDREQ(this.dreq.tx);
+        }
+        else {
+            this.rp2040.dma.setDREQ(this.dreq.tx);
+        }
+    }
+    updateDMARx() {
+        if (this.rxFIFO.empty) {
+            this.rp2040.dma.clearDREQ(this.dreq.rx);
+        }
+        else {
+            this.rp2040.dma.setDREQ(this.dreq.rx);
+        }
+    }
     doTX() {
         if (!this.busy && !this.txFIFO.empty) {
             const value = this.txFIFO.pull();
@@ -129,6 +148,8 @@ export class RPSPI extends BasePeripheral {
         if (this.intStatus !== prevStatus) {
             this.checkInterrupts();
         }
+        this.updateDMATx();
+        this.updateDMARx();
     }
     readUint32(offset) {
         switch (offset) {
@@ -188,7 +209,8 @@ export class RPSPI extends BasePeripheral {
                 return;
             case SSPDR:
                 if (!this.txFIFO.full) {
-                    this.txFIFO.push(value);
+                    // decoded with respect to SSPCR0.DSS
+                    this.txFIFO.push(value & ((1 << this.dataBits) - 1));
                     this.doTX();
                     this.fifosUpdated();
                 }

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

@@ -1,14 +1,20 @@
 import { RP2040 } from '../rp2040';
+import { DREQChannel } from './dma';
 import { BasePeripheral, Peripheral } from './peripheral';
+export interface IUARTDMAChannels {
+    rx: DREQChannel;
+    tx: DREQChannel;
+}
 export declare class RPUART extends BasePeripheral implements Peripheral {
     readonly irq: number;
+    readonly dreq: IUARTDMAChannels;
     private ctrlRegister;
     private lineCtrlRegister;
     private rxFIFO;
     private interruptMask;
     private interruptStatus;
     onByte?: (value: number) => void;
-    constructor(rp2040: RP2040, name: string, irq: number);
+    constructor(rp2040: RP2040, name: string, irq: number, dreq: IUARTDMAChannels);
     get enabled(): boolean;
     get txEnabled(): boolean;
     get rxEnabled(): boolean;

package/dist/esm/peripherals/uart.js

@@ -21,9 +21,10 @@ const UARTEN = 1 << 0;
 // Interrupt bits
 const UARTRXINTR = 1 << 4;
 export class RPUART extends BasePeripheral {
-    constructor(rp2040, name, irq) {
+    constructor(rp2040, name, irq, dreq) {
         super(rp2040, name);
         this.irq = irq;
+        this.dreq = dreq;
         this.ctrlRegister = RXE | TXE;
         this.lineCtrlRegister = 0;
         this.rxFIFO = new FIFO(32);
@@ -105,6 +106,12 @@ export class RPUART extends BasePeripheral {
                 break;
             case UARTCR:
                 this.ctrlRegister = value;
+                if (this.enabled) {
+                    this.rp2040.dma.setDREQ(this.dreq.tx);
+                }
+                else {
+                    this.rp2040.dma.clearDREQ(this.dreq.tx);
+                }
                 break;
             case UARTIMSC:
                 this.interruptMask = value & 0x7ff;

package/dist/esm/rp2040.d.ts

@@ -35,7 +35,6 @@ export declare class RP2040 {
     readonly sio: RPSIO;
     readonly uart: RPUART[];
     readonly i2c: RPI2C[];
-    readonly spi: RPSPI[];
     readonly pwm: RPPWM;
     readonly adc: RPADC;
     readonly gpio: GPIOPin[];
@@ -43,6 +42,7 @@ export declare class RP2040 {
     readonly dma: RPDMA;
     readonly pio: RPPIO[];
     readonly usbCtrl: RPUSBController;
+    readonly spi: RPSPI[];
     private stopped;
     logger: Logger;
     private executeTimer;

package/dist/esm/rp2040.js

@@ -5,7 +5,7 @@ import { IRQ } from './irq';
 import { RPADC } from './peripherals/adc';
 import { RPBUSCTRL } from './peripherals/busctrl';
 import { RPClocks } from './peripherals/clocks';
-import { RPDMA } from './peripherals/dma';
+import { DREQChannel, RPDMA } from './peripherals/dma';
 import { RPI2C } from './peripherals/i2c';
 import { RPIO } from './peripherals/io';
 import { RPPADS } from './peripherals/pads';
@@ -51,9 +51,17 @@ export class RP2040 {
         this.clkPeri = 125 * MHz;
         this.ppb = new RPPPB(this, 'PPB');
         this.sio = new RPSIO(this);
-        this.uart = [new RPUART(this, 'UART0', IRQ.UART0), new RPUART(this, 'UART1', IRQ.UART1)];
+        this.uart = [
+            new RPUART(this, 'UART0', IRQ.UART0, {
+                rx: DREQChannel.DREQ_UART0_RX,
+                tx: DREQChannel.DREQ_UART0_TX,
+            }),
+            new RPUART(this, 'UART1', IRQ.UART1, {
+                rx: DREQChannel.DREQ_UART1_RX,
+                tx: DREQChannel.DREQ_UART1_TX,
+            }),
+        ];
         this.i2c = [new RPI2C(this, 'I2C0', IRQ.I2C0), new RPI2C(this, 'I2C1', IRQ.I2C1)];
-        this.spi = [new RPSPI(this, 'SPI0', IRQ.SPI0), new RPSPI(this, 'SPI1', IRQ.SPI1)];
         this.pwm = new RPPWM(this, 'PWM_BASE');
         this.adc = new RPADC(this, 'ADC');
         this.gpio = [
@@ -102,6 +110,16 @@ export class RP2040 {
             new RPPIO(this, 'PIO1', IRQ.PIO1_IRQ0, 1),
         ];
         this.usbCtrl = new RPUSBController(this, 'USB');
+        this.spi = [
+            new RPSPI(this, 'SPI0', IRQ.SPI0, {
+                rx: DREQChannel.DREQ_SPI0_RX,
+                tx: DREQChannel.DREQ_SPI0_TX,
+            }),
+            new RPSPI(this, 'SPI1', IRQ.SPI1, {
+                rx: DREQChannel.DREQ_SPI1_RX,
+                tx: DREQChannel.DREQ_SPI1_TX,
+            }),
+        ];
         this.stopped = true;
         this.logger = new ConsoleLogger(LogLevel.Debug, true);
         this.executeTimer = null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rp2040js",
-  "version": "0.17.15",
+  "version": "0.17.17",
   "description": "Raspberry Pi Pico (RP2040) Emulator",
   "repository": "https://github.com/wokwi/rp2040js",
   "keywords": [
@@ -16,6 +16,9 @@
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "typings": "./dist/cjs/index.d.ts",
+  "engines": {
+    "node": ">=16.0.0"
+  },
   "exports": {
     ".": {
       "import": "./dist/esm/index.js",
@@ -36,7 +39,8 @@
     "start:micropython": "ts-node demo/micropython-run.ts",
     "start:circuitpython": "ts-node demo/micropython-run.ts --circuitpython",
     "start:gdbdiff": "ts-node debug/gdbdiff.ts",
-    "test": "jest"
+    "test": "jest",
+    "test:micropython-spi": "ts-node test/micropython-spi-test.ts"
   },
   "devDependencies": {
     "@types/jest": "^27.4.1",