@mchp-mcc/dspic33a-flash 1.0.1

package/src/GeneratorModel.ts

@@ -0,0 +1,138 @@
+import { AppModel } from "../generated_module/src/types/AutoModuleTypes";
+import {
+    FLASH_INSTRUCTION_TYPE,
+    getMyDerivedData,
+    MyDerivedData,
+} from "../src/DerivedData";
+
+export const generatableItems = (model: AppModel): any => {
+    if (model) {
+        return new GeneratorModel(model);
+    }
+    return undefined;
+};
+
+class GeneratorModel {
+    private dataModel: AppModel;
+    constructor(dataModel: AppModel) {
+        this.dataModel = dataModel;
+    }
+
+    public getGeneratableItems = (): any => {
+        return this.getFlashGeneratableItems();
+    };
+
+    private getFlashGeneratableItems = (): any => {
+        const derivedData: MyDerivedData = getMyDerivedData(
+            this.dataModel,
+        ) as MyDerivedData;
+        if (!derivedData) return;
+        const interruptDriven = derivedData.getInterruptDrivenStatus();
+        //The template data is now responsible for getting all the information for the ftl's
+        const generatableItems = {
+            generatePLIBVersion: true,
+            PLIBVersion: "1.0.1",
+            disclaimer: "/*disclaimer*/",
+            generateInterfaceContent: derivedData.enableInterfaceDefinitionGeneration(),
+            moduleNameUpperCase: this.dataModel.getName().toLocaleUpperCase(),
+            moduleNameLowerCase: this.dataModel.getName().toLocaleLowerCase(),
+            generateBlockingAPI: derivedData.getBlockingAPIGenerationStatus(),
+            generateNonBlockingAPI: derivedData.getNonBlockingAPIGenerationStatus(),
+            interruptDriven: interruptDriven,
+            interfaceApi: derivedData.basic_flash_payload(),
+            properties: derivedData.getProperties(),
+            flashWordWriteSizeInInstructions: derivedData.getFlashWordWriteSizeInInstructions(),
+            flashInstructionType: FLASH_INSTRUCTION_TYPE,
+            flashWriteInstructionCount: String(
+                derivedData.getFlashWriteInstructionCount(),
+            ).replace(/,/g, ""),
+            flashInterface: derivedData.getFlashInterface(),
+            flashEraseInstructionCount: String(
+                derivedData.getFlashEraseInstructionCount(),
+            ).replace(/,/g, ""),
+            flashHasAuxiliary: derivedData.getFlashHasAuxiliary(),
+            flashEnduranceMinimum: derivedData.getFlashEnduranceMinimum(),
+            flashBytesPerInstruction: derivedData.getFlashBytesPerInstruction(),
+            flashPcUnitsPerInstruction: derivedData.getFlashPcUnitsPerInstruction(),
+            flashWordWriteOpCode: derivedData.getFlashWordWriteOpCodeHexString(),
+            flashRowWriteOpcode: derivedData.getFlashWriteRowOpCodeHexString(),
+            flashOpCodeMask: derivedData.getFlashOpCodeMaskHexString(),
+            flashErasePageSizeInInstructions: String(
+                derivedData.getFlashErasePageSizeInInstructions(),
+            ).replace(/,/g, ""),
+            flashPageEraseOpcode: derivedData.getFlashErasePageOpCodeHexString(),
+            flashHasEcc: derivedData.getFlashHasEcc(),
+            flashHasRowProgramming: derivedData.getFlashHasRowProgramming(),
+            flashWriteRowSizeInInstructions: String(
+                derivedData.getFlashWriteRowSizeInInstructions(),
+            ).replace(/,/g, ""),
+            flashEndAddress: derivedData.getFlashEndAddressHexString(),
+            flashProgramBeginAddress: derivedData.getFlashProgramBeginAddressHexString(),
+            flashUnlockKey: derivedData.getFlashUnlockKey(),
+            doxyDriverGroupName: "Flash Driver",
+        };
+        const interrupts = this.dataModel.getHardware()?.getPeripheral().interrupts;
+        if (interrupts != undefined) {
+            const flashInterrupt = interrupts["NVMI"];
+            if (interruptDriven) {
+                const contextList = getInterruptContextList(this.dataModel);
+                generatableItems["flashInterruptEnable"] = flashInterrupt?.enable ?? "";
+                generatableItems["flashInterruptFlag"] = flashInterrupt?.flag ?? "";
+                generatableItems["flashIsrHandlerName"] =
+                    flashInterrupt?.handlerName ?? "";
+                generatableItems["isFlashContextSupported"] = isContextSupported(
+                    contextList,
+                    flashInterrupt?.name ?? "",
+                );
+            }
+        }
+        generatableItems[
+            "nvmControlRegister"
+        ] = this.dataModel?.getRegisters()?.NVMCON?.name;
+        generatableItems[
+            "nvmAddressRegister"
+        ] = this.dataModel?.getRegisters()?.NVMADR?.name;
+        generatableItems[
+            "nvmDataRegister0"
+        ] = this.dataModel?.getRegisters()?.NVMDATA0?.name;
+        generatableItems[
+            "nvmDataRegister1"
+        ] = this.dataModel?.getRegisters()?.NVMDATA1?.name;
+        generatableItems[
+            "nvmDataRegister2"
+        ] = this.dataModel?.getRegisters()?.NVMDATA2?.name;
+        generatableItems[
+            "nvmDataRegister3"
+        ] = this.dataModel?.getRegisters()?.NVMDATA3?.name;
+        generatableItems[
+            "nvmSrcAddressRegister"
+        ] = this.dataModel?.getRegisters()?.NVMSRCADR?.name;
+        return generatableItems;
+    };
+}
+
+export const getInterruptContextList = (dataModel: AppModel): string[] => {
+    const interruptPayload = dataModel.getImportValue("interrupt_service");
+
+    let contextList: string[] = [];
+    if (interruptPayload) {
+        if (interruptPayload?.contextEnabledInterruptList) {
+            contextList = interruptPayload["contextEnabledInterruptList"];
+        }
+    }
+    return contextList;
+};
+
+export const isContextSupported = (
+    contextList: string[],
+    interruptName: string,
+): boolean => {
+    let isContextSupported = false;
+    for (const ctxName of contextList) {
+        if (ctxName === interruptName) {
+            isContextSupported = true;
+            break;
+        }
+    }
+    return isContextSupported;
+};

package/src/catalog.json

@@ -0,0 +1,25 @@
+{
+    "name": "@mchp-mcc/local-catalog",
+    "version": "1.0.0",
+    "content": [
+        {
+            "name": "@mchp-mcc/dspic33a-flash",
+            "version": "*",
+            "meta": {
+                "keywords": [
+                    "avr",
+                    "pic8",
+                    "driver",
+                    ""
+                ],
+                "name": "FLASH",
+                "category": "PLIB",
+                "description": "<Write description here>",
+                "deviceFilterRegEx": ".*",
+                "defaultSelection": true,
+                "releaseNotesLink": "https://onlinedocs.microchip.com/v2/keyword-lookup?keyword\u003dMCC.MELODY.8BITAVR.RELEASENOTES\u0026version\u003dlatest\u0026redirect\u003dtrue"
+            }
+        }
+    ],
+    "catalogs": []
+}