add @devicescript/spi module

Author: mmoskal

bytecode/bytecode.md

@@ -644,3 +644,5 @@ Only `true` and `false` values.
     delay = 167
     fromCharCode = 168
     _allocRole = 169
+    spiConfigure = 170
+    spiXfer = 171

compiler/src/bytecode.ts

@@ -281,7 +281,7 @@ export enum BuiltInObject {
 }
 
 export enum BuiltInString {
-    __MAX = 169,
+    __MAX = 171,
     _EMPTY = 0,
     MINFINITY = 1, // -Infinity
     DEVICESCRIPT = 2,
@@ -452,6 +452,8 @@ export enum BuiltInString {
     DELAY = 167,
     FROMCHARCODE = 168,
     _ALLOCROLE = 169,
+    SPICONFIGURE = 170,
+    SPIXFER = 171,
 }
 
 export const OP_PRINT_FMTS = [
@@ -737,6 +739,8 @@ export const BUILTIN_STRING__VAL = [
     "delay",
     "fromCharCode",
     "_allocRole",
+    "spiConfigure",
+    "spiXfer",
 ]
 export const BUILTIN_OBJECT__VAL = [
     "Math",

devs/run-tests/allcompile.ts

@@ -6,6 +6,7 @@ import "@devicescript/i2c"
 import "@devicescript/settings"
 import "@devicescript/drivers"
 import "@devicescript/gpio"
+import "@devicescript/spi"
 import "@devicescript/runtime"
 
 console.log("all libraries compiled and didn't crash!")

jacdac-ts

@@ -519,6 +519,11 @@ declare module "@devicescript/core" {
 
     export interface PinBase {
         _pinBrand: unknown
+
+        /**
+         * Hardware pin number
+         */
+        gpio: number
     }
 
     /**

packages/core/src/devicescript-core.d.ts

@@ -62,3 +62,5 @@ Math.log2 = function log2(x) {
     await fn()
     return await ds.suspend<ds.Packet>()
 }
+// this is overridden byt the gpio package
+;(ds as typeof ds).gpio = gpio => ({ gpio } as any)

packages/core/src/utils.ts

@@ -3,10 +3,6 @@ import * as ds from "@devicescript/core"
 // extend interfaces
 declare module "@devicescript/core" {
     export interface PinBase {
-        /**
-         * hardware pin number
-         */
-        gpio: number
         /**
          * Configure pin mode.
          * @param mode desired mode

packages/gpio/src/pins.ts

@@ -0,0 +1,17 @@
+# @devicescript/spi
+
+[DeviceScript](https://microsoft.github.io/devicescript/) SPI master support.
+
+-   [Read documentation](https://microsoft.github.io/devicescript/developer/servers/spi)
+
+## Contributing
+
+Contributions are welcome! See [contributing page](../../CONTRIBUTING.md).
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
+trademarks or logos is subject to and must follow
+[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+Any use of third-party trademarks or logos are subject to those third-party's policies.

packages/spi/README.md

@@ -0,0 +1 @@
+{}

packages/spi/devsconfig.json

@@ -0,0 +1,41 @@
+{
+    "name": "@devicescript/spi",
+    "version": "2.9.12",
+    "private": true,
+    "dependencies": {},
+    "devDependencies": {
+        "@devicescript/cli": "*"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/devicescript.git",
+        "directory": "packages/spi"
+    },
+    "scripts": {
+        "setup": "devicescript build",
+        "build:devicescript": "devicescript build src/main.ts -F allFunctions",
+        "build": "yarn build:devicescript",
+        "watch:devicescript": "devicescript devtools src/main.ts",
+        "watch": "yarn watch:devicescript",
+        "test:devicescript": "devicescript run src/main.ts --test --test-self-exit -F allFunctions",
+        "test": "yarn test:devicescript",
+        "start": "yarn watch"
+    },
+    "main": "./src/index.ts",
+    "license": "MIT",
+    "devicescript": {
+        "bundle": true,
+        "library": true
+    },
+    "files": [
+        "src/*.ts",
+        "devsconfig.json"
+    ],
+    "keywords": [
+        "devicescript"
+    ],
+    "author": "Microsoft",
+    "publishConfig": {
+        "access": "public"
+    }
+}

packages/spi/package.json

@@ -0,0 +1 @@
+export * from "./spi"

packages/spi/src/index.ts

@@ -0,0 +1,3 @@
+import { describe, expect, test } from "@devicescript/test"
+
+describe("drivers", () => {})

packages/spi/src/main.ts

@@ -0,0 +1,50 @@
+import * as ds from "@devicescript/core"
+
+export interface SPIConfig {
+    miso?: ds.InputPin
+    mosi?: ds.OutputPin
+    sck?: ds.OutputPin
+    mode?: number
+    hz?: number
+}
+
+type DsSpi = typeof ds & {
+    spiConfigure(
+        miso: number,
+        mosi: number,
+        sck: number,
+        mode: number,
+        hz: number
+    ): void
+    spiXfer(tx: Buffer, rx: Buffer): Promise<void>
+}
+
+function pinNum(p: ds.Pin) {
+    return p ? p.gpio : -1
+}
+
+export function spiConfigure(cfg: SPIConfig) {
+    ;(ds as DsSpi).spiConfigure(
+        pinNum(cfg.miso),
+        pinNum(cfg.mosi),
+        pinNum(cfg.sck),
+        cfg.mode || 0,
+        cfg.hz || 1000000
+    )
+}
+
+export async function spiWrite(buf: Buffer) {
+    await (ds as DsSpi).spiXfer(buf, null)
+}
+
+export async function spiRead(numbytes: number) {
+    const r = Buffer.alloc(numbytes)
+    await (ds as DsSpi).spiXfer(null, r)
+    return r
+}
+
+export async function spiXfer(buf: Buffer) {
+    const r = Buffer.alloc(buf.length)
+    await (ds as DsSpi).spiXfer(buf, r)
+    return r
+}

packages/spi/src/spi.ts

@@ -0,0 +1,21 @@
+{
+    "compilerOptions": {
+        "moduleResolution": "node",
+        "target": "es2022",
+        "module": "es2022",
+        "lib": [],
+        "strict": true,
+        "strictNullChecks": false,
+        "strictFunctionTypes": true,
+        "sourceMap": false,
+        "declaration": false,
+        "experimentalDecorators": true,
+        "preserveConstEnums": true,
+        "noImplicitThis": true,
+        "isolatedModules": true,
+        "noImplicitAny": true,
+        "moduleDetection": "force",
+        "types": []
+    },
+    "include": ["**/*.ts", "../../core/src/*.ts"]
+}

packages/spi/src/tsconfig.json

@@ -41,6 +41,7 @@ function init(modules: {
                                 "@devicescript/settings",
                                 "@devicescript/drivers",
                                 "@devicescript/gpio",
+                                "@devicescript/spi",
                                 "@devicescript/runtime",
                             ]) {
                                 json.peerDependencies[n] = "*"

plugin/src/plugin.ts

@@ -261,7 +261,7 @@
 #define DEVS_BUILTIN_OBJECT_DSPACKETSPEC 38
 #define DEVS_BUILTIN_OBJECT_DSPACKETSPEC_PROTOTYPE 39
 
-#define DEVS_BUILTIN_STRING___MAX 169
+#define DEVS_BUILTIN_STRING___MAX 171
 #define DEVS_BUILTIN_STRING__EMPTY 0
 #define DEVS_BUILTIN_STRING_MINFINITY 1 // -Infinity
 #define DEVS_BUILTIN_STRING_DEVICESCRIPT 2
@@ -432,6 +432,8 @@
 #define DEVS_BUILTIN_STRING_DELAY 167
 #define DEVS_BUILTIN_STRING_FROMCHARCODE 168
 #define DEVS_BUILTIN_STRING__ALLOCROLE 169
+#define DEVS_BUILTIN_STRING_SPICONFIGURE 170
+#define DEVS_BUILTIN_STRING_SPIXFER 171
 
 #define DEVS_OP_HANDLERS                                                                           \
     expr_invalid, exprx_builtin_object, stmt1_call0, stmt2_call1, stmt3_call2, stmt4_call3,        \
@@ -475,7 +477,7 @@
         "_commandResponse", "isAction", "millis", "from", "hex", "utf8", "utf-8", "suspended",     \
         "reboot", "server", "spec", "ServiceSpec", "classIdentifier", "lookup", "PacketSpec",      \
         "parent", "response", "ServerInterface", "_onServerPacket", "_serverSend",                 \
-        "notImplemented", "delay", "fromCharCode", "_allocRole"
+        "notImplemented", "delay", "fromCharCode", "_allocRole", "spiConfigure", "spiXfer"
 #define DEVS_BUILTIN_OBJECT__VAL                                                                   \
     "Math", "Object", "Object_prototype", "Array", "Array_prototype", "Buffer",                    \
         "Buffer_prototype", "String", "String_prototype", "Number", "Number_prototype", "DsFiber", \

runtime/devicescript/devs_bytecode.h

@@ -33,6 +33,7 @@ typedef struct devs_activation devs_activation_t;
 #define DEVS_PKT_KIND_SEND_PKT 2
 #define DEVS_PKT_KIND_SEND_RAW_PKT 3
 #define DEVS_PKT_KIND_SUSPENDED 4
+#define DEVS_PKT_KIND_AWAITING 5
 
 typedef void (*devs_resume_cb_t)(devs_ctx_t *ctx, void *userdata);
 
@@ -49,6 +50,7 @@ typedef struct devs_fiber {
             uint16_t resend_timeout;
         } reg_get;
         value_t v;
+        uint8_t *awaiting;
     } pkt_data;
 
     uint8_t pkt_kind : 4;
@@ -247,6 +249,8 @@ void devs_fiber_set_wake_time(devs_fiber_t *fiber, unsigned time);
 void devs_fiber_sleep(devs_fiber_t *fiber, unsigned time);
 void devs_fiber_termiante(devs_fiber_t *fiber);
 void devs_fiber_yield(devs_ctx_t *ctx);
+void devs_fiber_await(devs_fiber_t *fib, uint8_t *awaiting);
+void devs_fiber_await_done(uint8_t *awaiting);
 // if `args` is passed, `numparams==0`
 // otherwise, `numparams` arguments are sought on the_stack
 int devs_fiber_call_function(devs_fiber_t *fiber, unsigned numparams, devs_array_t *args);

runtime/devicescript/devs_internal.h

@@ -19,7 +19,7 @@ typedef struct {
     } handler;
 } devs_builtin_function_t;
 
-#define DEVS_BUILTIN_MAX_ARGS 4
+#define DEVS_BUILTIN_MAX_ARGS 8 // not sure this does anything, except for the stack size
 #define DEVS_BUILTIN_FLAG_IS_PROPERTY 0x01
 #define DEVS_BUILTIN_FLAG_ASYNC_CALL 0x02
 #define DEVS_BUILTIN_FLAG_NO_SELF 0x04

runtime/devicescript/devs_proto.h

@@ -175,6 +175,18 @@ void devs_fiber_sleep(devs_fiber_t *fiber, unsigned time) {
     devs_fiber_yield(fiber->ctx);
 }
 
+void devs_fiber_await(devs_fiber_t *fib, uint8_t *awaiting) {
+    *awaiting = 0;
+    fib->pkt_kind = DEVS_PKT_KIND_AWAITING;
+    fib->pkt_data.awaiting = awaiting;
+    devs_fiber_sleep(fib, 0xffffffff);
+}
+
+void devs_fiber_await_done(uint8_t *awaiting) {
+    *awaiting = 1;
+    JD_WAKE_MAIN();
+}
+
 static void free_fiber(devs_fiber_t *fiber) {
     devs_jd_clear_pkt_kind(fiber);
     devs_ctx_t *ctx = fiber->ctx;
@@ -438,10 +450,12 @@ static int devs_fiber_wake_some(devs_ctx_t *ctx) {
     devs_fiber_t *fibmin = NULL;
 
     for (devs_fiber_t *fiber = ctx->fibers; fiber; fiber = fiber->next) {
-        if (fiber->role_wkp) {
+        if (fiber->role_wkp ||
+            (fiber->pkt_kind == DEVS_PKT_KIND_AWAITING && *fiber->pkt_data.awaiting)) {
             fibmin = fiber;
             break;
         }
+
         if (fiber->wake_time && fiber->wake_time <= now_) {
             if (fibmin == NULL || fibmin->wake_time > fiber->wake_time)
                 fibmin = fiber;

runtime/devicescript/fibers.c

@@ -0,0 +1,68 @@
+#include "devs_internal.h"
+#include "services/interfaces/jd_spi.h"
+
+void fun5_DeviceScript_spiConfigure(devs_ctx_t *ctx) {
+#if JD_SPI
+    jd_spi_cfg_t cfg = {
+        .miso = devs_arg_int(ctx, 0),
+        .mosi = devs_arg_int(ctx, 1),
+        .sck = devs_arg_int(ctx, 2),
+        .mode = devs_arg_int(ctx, 3),
+        .hz = devs_arg_int(ctx, 4),
+    };
+
+    int r = jd_spi_init(&cfg);
+    if (r)
+        devs_throw_range_error(ctx, "SPI init failed: %d", r);
+#else
+    devs_throw_not_supported_error(ctx, "SPI");
+#endif
+}
+
+#if JD_SPI
+static uint8_t is_done;
+static void spi_done(void) {
+    devs_fiber_await_done(&is_done);
+}
+
+void throw_spi_error(devs_ctx_t *ctx, void *userdata) {
+    devs_throw_range_error(ctx, "SPI error: %d", (int)(intptr_t)userdata);
+}
+#endif
+
+void fun2_DeviceScript_spiXfer(devs_ctx_t *ctx) {
+#if JD_SPI
+    value_t tx = devs_arg(ctx, 0);
+    value_t rx = devs_arg(ctx, 1);
+
+    unsigned tx_sz;
+    const void *tx_ptr = devs_bufferish_data(ctx, tx, &tx_sz);
+    unsigned rx_sz;
+    const void *rx_ptr = devs_bufferish_data(ctx, rx, &rx_sz);
+
+    if (!jd_spi_is_ready())
+        devs_throw_range_error(ctx, "SPI busy");
+    else if (!tx_ptr && !rx_ptr)
+        devs_throw_expecting_error_ext(ctx, "at least one of TX/RX buffers", tx);
+    else if (tx_ptr && rx_ptr && tx_sz != rx_sz)
+        devs_throw_expecting_error_ext(ctx, "same size TX/RX buffers", tx);
+    else if (rx_ptr && !devs_buffer_is_writable(ctx, rx))
+        devs_throw_expecting_error_ext(ctx, "mutable Buffer", rx);
+    else {
+        if (!tx_sz)
+            tx_sz = rx_sz;
+        devs_fiber_t *fib = ctx->curr_fiber;
+        devs_fiber_await(fib, &is_done);
+        int r = jd_spi_xfer(tx_ptr, (void *)rx_ptr, tx_sz, spi_done);
+        if (r) {
+            // we've been already de-scheduled - arrange for exception on resume
+            fib->resume_cb = throw_spi_error;
+            fib->resume_data = (void *)r;
+            devs_fiber_await_done(&is_done); // schedule resume
+        }
+    }
+
+#else
+    devs_throw_not_supported_error(ctx, "SPI");
+#endif
+}

runtime/devicescript/impl_dsspi.c

@@ -375,6 +375,9 @@ bool devs_jd_should_run(devs_fiber_t *fiber) {
     case DEVS_PKT_KIND_SEND_RAW_PKT:
         return handle_send_raw_pkt(fiber);
 
+    case DEVS_PKT_KIND_AWAITING:
+        return *fiber->pkt_data.awaiting ? RESUME_USER_CODE : KEEP_WAITING;
+
     default:
         JD_PANIC();
     }