driverge-mcp 0.0.0 → 0.0.1

package/dist/codegen/portable.d.ts

@@ -1,4 +1,100 @@
-import type { DatasheetJson } from "../schema/types.js";
-import type { DriverArtifact } from "./types.js";
-/** Render the portable thin-HAL driver skeleton for a validated datasheet. */
+import { type Register } from "../pdf/types.js";
+import type { Command, DatasheetJson } from "../schema/types.js";
+import type { DriverArtifact, FillInBrief, GeneratedFile } from "./types.js";
+export declare const AUTOGEN: (part: string, mfr: string, busLine: string) => string;
+export declare function registerConstants(prefix: string, registers: Register[]): string[];
+/** Where the host AI must enumerate a register map that Driverge couldn't extract. */
+export declare function registerMapTodo(prefix: string, pages: number[]): string[];
+/** Where the host AI must enumerate a command set that Driverge couldn't extract. */
+export declare function commandSetTodo(prefix: string, pages: number[]): string[];
+/** fill_in_brief.register_map_todo text — shared by the C and cpp generators. */
+export declare function registerMapTodoText(json: DatasheetJson, name: string, prefix: string): string;
+/** fill_in_brief.command_set_todo text — shared by the C and cpp generators. */
+export declare function commandSetTodoText(json: DatasheetJson, name: string, prefix: string): string;
+export type RegisterMapBus = "I2C" | "SPI" | "UART" | "CAN";
+interface BusSeam {
+    /** Lines appended after the "Thin-HAL seam" header comment, in order. */
+    decl: string[];
+    /** Field(s) for the driver handle typedef struct. */
+    handleField: string;
+    /** Body of <name>_read_register (dev, reg, value already in scope). Unused for UART/CAN. */
+    readBody: string[];
+    /** Body of <name>_write_register (dev, reg, value already in scope). Unused for UART/CAN. */
+    writeBody: string[];
+}
+export declare const BUS_SEAM: Record<RegisterMapBus, BusSeam>;
+/** Which BUS_SEAM row a protocol.bus resolves to. "unknown" defaults to the I2C
+ *  seam, matching the pre-existing (pre-Session-B) fallback behavior. */
+export declare function seamBusFor(bus: string): RegisterMapBus;
+export declare function uartFramingBody(params: string[]): string[];
+export declare function canFramingBody(params: string[]): string[];
+export declare const CAN_QUIRKS_NOTE = "Confirm the arbitration IDs / SDO message schema this part uses for register/command access from the datasheet; CAN device interfaces are device-specific.";
+export declare function bitFieldMacros(prefix: string, registers: Register[]): string[];
+/**
+ * Names the register_map fill_in_brief prose uses to refer to the driver's own
+ * init/read/write entry points. Defaults to the C free-function names
+ * (`<name>_init`, `read_register`/`write_register`); the cpp generator passes
+ * the class method names instead so the SAME brief builder produces
+ * language-accurate text without duplicating the quirks/framing prose (Session
+ * D: cpp language option).
+ */
+export interface RegisterBriefCalls {
+    init: string;
+    readRegister: string;
+    writeRegister: string;
+}
+export declare function registerBrief(json: DatasheetJson, calls?: Partial<RegisterBriefCalls>): FillInBrief;
+/**
+ * Names the command_set fill_in_brief prose uses for the driver's own entry
+ * points. Defaults to the C free-function names; the cpp generator passes the
+ * class method names instead (Session D: cpp language option) — see
+ * RegisterBriefCalls for the register_map analogue.
+ */
+export interface CommandBriefCalls {
+    sendCommand: string;
+    readData: string;
+    crc8: string;
+}
+export declare function commandBrief(json: DatasheetJson, commands: Command[], crc: Command["crc"] | undefined, uart: boolean, can: boolean, name: string, prefix: string, calls?: Partial<CommandBriefCalls>): FillInBrief;
+/**
+ * Static prose block shared by the C and cpp command_set init() bodies
+ * (mentions no function names, so there is nothing to parameterize).
+ */
+export declare const COMMAND_INIT_TODO: readonly string[];
+/** The I2C command-frame comment in send_command — no callable names, shared verbatim. */
+export declare const I2C_COMMAND_FRAME_NOTE: readonly string[];
+/**
+ * read_data's "implement the actual read framing" TODO comment. `crc8Name` is
+ * the bare callable name (no parens) — `<name>_crc8` for C, `crc8` for cpp.
+ */
+export declare function commandReadDataTodo(crc8Name: string): string[];
+/**
+ * Renders a CRC-8 stub function/method body. `qualifiedName` is the full
+ * callable name to emit — a free function (`sht3x_crc8`) for C or a qualified
+ * method (`Sht3x::crc8`) for cpp — so this single builder covers both without
+ * duplicating the TODO prose (Session D: cpp language option).
+ */
+export declare function crc8Body(qualifiedName: string, crc: NonNullable<Command["crc"]>, prefix: string): string[];
+/**
+ * register_map init()'s "implement the power-on/reset sequence" TODO comment.
+ * The uart/can branch mentions no callable names (just the seam functions), so
+ * it is identical for C and cpp; the register-access branch takes the write
+ * call as a parameter (`<name>_write_register()` for C, `writeRegister()` for
+ * cpp) so both flavors share this one builder (Session D: cpp language
+ * option).
+ */
+export declare function registerInitTodo(uart: boolean, can: boolean, writeRegisterCall: string): string[];
+export declare function makeFiles(name: string, header: string[], source: string[], ext?: {
+    header: string;
+    source: string;
+}): GeneratedFile[];
+/**
+ * Render the portable thin-HAL driver skeleton for a validated datasheet.
+ * DeviceInterface is a 2-member discriminated union, so narrowing on `kind`
+ * here — rather than casting inside registerDriver/commandDriver — lets both
+ * take an explicit, correctly-typed array with no cast. Any kind other than
+ * "command_set" is treated as register_map, matching buildInterface's
+ * register-first fallback (see schema/assemble) exactly.
+ */
 export declare function generatePortableDriver(json: DatasheetJson): DriverArtifact;
+export {};