@typecad/framework-zephyr 1.0.0-alpha.16 → 1.0.0-alpha.19

package/LICENSE

@@ -1,21 +1,202 @@
-MIT License
-
-Copyright (c) 2026 typecad0
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,87 +1,49 @@
-# @typecad/framework-zephyr
-
-TypeCAD framework package that lowers HAL operation IR to **native Zephyr RTOS
-driver API calls**. Generates a real Zephyr application (`main` + `src/main.cpp`
-+ `CMakeLists.txt` + `prj.conf`), compiled through Zephyr's `west` / CMake /
-Ninja build system.
-
-GPIO is lowered through devicetree specs (`gpio_pin_*_dt`) so an active-low
-LED's polarity is honored by the DT flags, not by the generated code.
-
-## Requirements
-
-- Zephyr RTOS ≥ 3.x installed (the SDK + a west-enabled Python environment).
-- The framework auto-discovers `west` without requiring you to activate the
-  venv first. Discovery cascade (first usable wins):
-  1. `west` already on `PATH` (env already activated / global install).
-  2. `$ZEPHYR_BASE` sibling venv: `${ZEPHYR_BASE}/../.venv/<python> -m west`.
-  3. Well-known workspace layouts (`~/zephyrproject/.venv`,
-     `/opt/zephyrproject/.venv`, etc.).
-  4. System pythons (`python`, `python3`, `py`) via `-m west`.
-
-If none is found, the build errors with an actionable message pointing at the
-fix (`pip install west`, set `ZEPHYR_BASE`, or activate the venv).
-
-## How it works
-
-- HAL ops (`gpio.write`, `i2c.reg_read`, etc.) lower to native Zephyr driver
-  calls (`gpio_pin_set_dt`, `i2c_reg_read_byte`, etc.) — no Arduino API.
-- The generated `src/main.cpp` defines `int main(void)` — the standard Zephyr
-  C entry point. Top-level statements lower straight into `main()` (no
-  `setup()`/`loop()` pair); event-driven programs get their scheduler loop
-  appended inside `main()` by the driver machinery.
-- The framework emits a complete Zephyr application: root `CMakeLists.txt`
-  (`find_package(Zephyr)` + `file(GLOB src/*.cpp)`) and `prj.conf` (the Kconfig
-  symbols for the lowered peripherals). Both are regenerated idempotently —
-  only rewritten when their content changes, so Ninja's incremental build is
-  preserved.
-- Board targets are not curated: **every board variant in the generated board
-  catalog** resolves the same way (`resolveChipFromBoard` over the catalog's
-  board data — there is no hardcoded chip registry or target list). The
-  catalog is machine-local, generated from your Zephyr tree by
-  `cuttlefish board sync` (and refreshed automatically by builds).
-
-## Installation
-
-```sh
-cuttlefish create   # pick a board from the catalog; the Zephyr framework is the default
-```
-
-Or in `cuttlefish.config.ts`:
-
-```ts
-export default {
-  entry: './src/main.ts',
-  board: 'xiao_ble/nrf52840',
-  framework: '@typecad/framework-zephyr',
-};
-```
-
-## HAL coverage
-
-The manifest (`src/framework.manifest.ts`) is the honest, complete record of
-what lowers. Fully lowered: **gpio, pwm, adc, dac** (pin-fact-gated),
-**i2c, spi, uart, interrupts, timing, wdt, counter, thread, shift, board
-constants**, **random** (xorshift32 PRNG seeded from the Zephyr entropy tap),
-**preferences (Store)**, **fs (File)**, **sensor**, **ble**, **snprintf**, and
-**wifi/http/mqtt** (ESP32-class radio targets only — nRF52840 has no WiFi).
-**Display** lowers via the generic `<zephyr/drivers/display.h>` GFX runtime.
-Declared unsupported on this target: **i2s, twai/CAN, ethernet, espnow,
-hardware crypto, pcnt, mcpwm**. USB CDC is board-gated: it lowers only on
-boards whose DTS enables the USB device controller.
-
-Run `npm test` (the manifest validator) to confirm the declared coverage matches
-the actual lowering behavior.
-
-## Notes / limitations
-
-- **Minimal C++ libc.** Zephyr's default C++ support (`lib/cpp/minimal`) has no
-  `<vector>`, `<string>`, `<iostream>`, `<functional>`, exceptions, or RTTI.
-  `prj.conf` enables `CONFIG_NEWLIB_LIBC` for `std::string`/`std::vector`; array
-  literals still promote to the StaticArray wrapper, not `std::vector`.
-- **Debug mode.** `cuttlefish build --debug` routes through `printk` (always
-  available, no `CONFIG_CONSOLE` dependency) rather than `std::cout`, since the
-  minimal libc has no iostream. Breakpoints halt on console input (`ENTER`
-  continues, `s` skips).
-- **AUTOSAR compliance.** All emitted C++ uses `static_cast`/`reinterpret_cast`
-  (no C-style casts) so the shim bytes pass `--autosar=strict`.
+# `@typecad/framework-zephyr`
+
+The Zephyr engine behind your [typeCAD/hal](https://typecad.dev) builds.
+
+When you scaffold a firmware project with `npx @typecad/hal create` and pick
+a board, this is the package that lands in your dependencies and does the
+heavy lifting: your TypeScript compiles to **real Zephyr RTOS applications**,
+built and flashed with Zephyr's own toolchain.
+
+## Why
+
+Zephyr is a production-grade RTOS — but its devicetree, Kconfig, and CMake
+layers demand real effort before your first blink. This package moves that
+effort into the toolchain: you write TypeScript against `@typecad/hal`, and
+the generated firmware calls the native Zephyr driver APIs directly. No
+boilerplate project, no devicetree hand-editing, no Arduino compatibility
+shims — just the RTOS, driven by code you can read.
+
+## What it does for you
+
+- **Generates a complete Zephyr application** from your firmware — entry
+  point, devicetree overlays, and Kconfig — regenerated automatically
+  whenever your code changes.
+- **Builds and flashes through Zephyr's `west` toolchain**, discovering
+  your environment without activation scripts (works from any terminal).
+- **Knows your board.** Board definitions come from your Zephyr tree's
+  catalog — 1,300+ board variants, same workflow for every one.
+- **Debugs on hardware.** Set breakpoints in your TypeScript in VS Code and
+  debug the running board (the TypeCAD Debug extension ships into every
+  project).
+- **Installs the toolchain for you.** No Zephyr SDK yet? One command:
+
+  ```sh
+  npx --package @typecad/framework-zephyr zephyr-installer
+  ```
+
+## Start here
+
+```bash
+npx @typecad/hal create my-firmware   # pick a board — this framework is the default
+cd my-firmware && npm run upload
+```
+
+- [typeCAD](https://typecad.dev) — documentation and guides
+- [`@typecad/hal`](https://www.npmjs.com/package/@typecad/hal) — the product
+
+## License
+
+Apache-2.0

package/dist/as-built.d.ts

@@ -10,7 +10,7 @@ export interface AsBuiltFacts {
     pwm: AsBuiltRoute[];
     dac: AsBuiltRoute[];
 }
-/** The .cuttlefish/as-built.json shape (machine-authored facts file). */
+/** The .typecad-hal/as-built.json shape (machine-authored facts file). */
 export interface AsBuiltFile {
     version: 1;
     board: string;
@@ -27,7 +27,7 @@ export interface AsBuiltFile {
  * its labels inline before the node name.
  */
 export declare function parseZephyrDts(text: string): AsBuiltFacts;
-/** Parse + shape-validate .cuttlefish/as-built.json; errors name the file. */
+/** Parse + shape-validate .typecad-hal/as-built.json; errors name the file. */
 export declare function parseAsBuiltJson(text: string, source?: string): AsBuiltFile;
 /** Serialize the as-built snapshot (deterministic field order). */
 export declare function asBuiltJson(board: string, facts: AsBuiltFacts): string;

package/dist/as-built.js

@@ -156,8 +156,8 @@ export function parseZephyrDts(text) {
     }
     return facts;
 }
-/** Parse + shape-validate .cuttlefish/as-built.json; errors name the file. */
-export function parseAsBuiltJson(text, source = '.cuttlefish/as-built.json') {
+/** Parse + shape-validate .typecad-hal/as-built.json; errors name the file. */
+export function parseAsBuiltJson(text, source = '.typecad-hal/as-built.json') {
     let parsed;
     try {
         parsed = JSON.parse(text);

package/dist/audit.d.ts

@@ -0,0 +1,111 @@
+import type { ReadFile } from '@typecad/cuttlefish/api/shared';
+export type KconfigValue = string | number | boolean;
+/** Parse a merged Kconfig file: `CONFIG_X=y` (true), `# CONFIG_X is not set`
+ *  (explicit false), `CONFIG_X=123` / `CONFIG_X="s"` (value). Comment blocks
+ *  and everything else are ignored. Absent symbols are simply not in the map
+ *  (Kconfig default applies — treat as "not enabled" for y/n symbols). */
+export declare function parseMergedConfig(text: string): Map<string, KconfigValue>;
+/** Sweep a resolved devicetree for every `compatible` string — the enabled
+ *  hardware the firmware actually wired (attack-surface inventory input).
+ *  Multi-string compatibles ("a,b", "a,b-fallback") contribute EVERY entry
+ *  (the fallback binds the same node); nodes marked status = "disabled"
+ *  contribute nothing. Node scoping is a brace-depth walk: every block is a
+ *  node, and only its OWN properties (nested child blocks stripped) decide
+ *  its status/compatibles. */
+export declare function sweepCompatibles(dtsText: string): string[];
+export interface SecurityFacts {
+    config: Map<string, KconfigValue>;
+    compatibles: string[];
+}
+export type AuditSeverity = 'high' | 'medium' | 'low';
+export interface AuditFinding {
+    rule: string;
+    title: string;
+    severity: AuditSeverity;
+    requirement: string;
+    remediation: string;
+    /** The as-built evidence line(s) that triggered the rule. */
+    evidence: string;
+}
+export interface AuditRule {
+    id: string;
+    title: string;
+    severity: AuditSeverity;
+    /** CRA essential-requirement paraphrase this rule maps to. */
+    requirement: string;
+    remediation: string;
+    /** Returns the evidence string when the rule fires, else null. */
+    evaluate: (facts: SecurityFacts) => string | null;
+}
+/**
+ * The Zephyr security baseline. Rules read ONLY config/devicetree facts —
+ * never a board name or SoC family (all-boards-are-equal). Every rule must
+ * be waivable with a recorded justification: real products have real
+ * exceptions, and a conformity assessor wants to see them documented, not
+ * hidden.
+ */
+export declare const SECURITY_RULES: readonly AuditRule[];
+/** Evaluate the baseline over the facts. Order follows rule severity. */
+export declare function evaluateSecurityRules(facts: SecurityFacts): AuditFinding[];
+export interface AuditWaiver {
+    rule: string;
+    justification: string;
+    date?: string;
+}
+export declare function parseWaiverFile(text: string | undefined): {
+    waivers: AuditWaiver[];
+    error?: string;
+};
+/** Find .typecad-hal/audit-waivers.json, walking up from `cwd` (bounded). */
+export declare function findWaiverFile(readFile: ReadFile, cwd: string): string | undefined;
+export interface AuditRunner {
+    cwd?: string;
+    /** The last build's compile_commands.json path, or undefined. */
+    compileCommandsPath?: () => string | undefined;
+    readFile: ReadFile;
+}
+export interface AuditReport {
+    schema: 'typecad-hal/security-audit@1';
+    generated: string;
+    buildDir: string;
+    summary: {
+        console: 'uart' | 'usb' | 'rtt' | 'none';
+        shell: boolean;
+        network: boolean;
+        bluetooth: boolean;
+        usbDevice: boolean;
+        entropy: boolean;
+        watchdog: boolean;
+        hardware: string[];
+    };
+    findings: AuditFinding[];
+    deviations: (AuditFinding & {
+        justification: string;
+        date?: string;
+    })[];
+    rulesEvaluated: number;
+    waiverFile?: string;
+}
+export declare function buildAuditReport(args: {
+    buildDir: string;
+    facts: SecurityFacts;
+    findings: AuditFinding[];
+    deviations: (AuditFinding & {
+        justification: string;
+        date?: string;
+    })[];
+    generated?: string;
+    waiverFile?: string;
+}): AuditReport;
+/** Options accepted by `runAuditPresenter` (structurally compatible with the
+ *  parsed `typecad-hal audit` CLI options). */
+export interface AuditPresenterOptions {
+    /** Exit 1 on any unwaived high/medium finding. */
+    strict?: boolean;
+    /** Print only the JSON report (clean CI pipe); the sidecar is still written. */
+    json?: boolean;
+}
+/** @internal Test-only override of the default runner. */
+export declare function __setAuditRunnerForTest(runner: AuditRunner | undefined): void;
+/** `typecad-hal audit` presenter. */
+export declare function runAuditPresenter(options: AuditPresenterOptions): void;