@mchp-mcc/scf-pic8-osc-v1 4.3.2 → 4.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mchp-mcc/scf-pic8-osc-v1",
-    "version": "4.3.2",
+    "version": "4.3.3",
     "scf": {
         "reducer": "auto",
         "creator": "output/creator.js",
@@ -10,7 +10,74 @@
         },
         "displayName": "Clock Control",
         "category": "System",
-        "nullPrototype": "output/nullPrototype.json"
+        "nullPrototype": "output/nullPrototype.json",
+        "autoProcessor": "output/autoProcessor.js",
+        "autoCreator": "output/autoCreator.js",
+        "prototype": {
+            "payload": null,
+            "imports": {
+                "scf_pic8_osc_v1": {
+                    "interfaceId": {
+                        "name": "scf-pic8-osc-v1",
+                        "version": "1.0.0"
+                    },
+                    "isRequired": true
+                },
+                "initializer_system": {
+                    "interfaceId": {
+                        "name": "initializer-system",
+                        "version": "^0.5.3"
+                    }
+                },
+                "config_device": {
+                    "interfaceId": {
+                        "name": "config-device",
+                        "version": "^1.1.1"
+                    }
+                },
+                "config_request": {
+                    "interfaceId": {
+                        "name": "config-request",
+                        "version": "^2.0.1"
+                    }
+                },
+                "pin_standard": {
+                    "interfaceId": {
+                        "name": "pin-standard",
+                        "version": "^0.1.0"
+                    }
+                },
+                "device_meta": {
+                    "interfaceId": {
+                        "name": "device-meta",
+                        "version": "1.0.0"
+                    }
+                }
+            },
+            "exports": {
+                "osc_clocks": {
+                    "interfaces": [
+                        {
+                            "interfaceId": {
+                                "name": "osc-clocks",
+                                "version": "0.2.0"
+                            }
+                        }
+                    ]
+                },
+                "fosc": {
+                    "interfaces": [
+                        {
+                            "interfaceId": {
+                                "name": "fosc-hz",
+                                "version": "0.3.0"
+                            }
+                        }
+                    ]
+                }
+            },
+            "isEntryPoint": true
+        }
     },
     "scf-automodule": {
         "peripheral": {
@@ -23,12 +90,12 @@
         },
         "mode": "standard",
         "hookPaths": {
-            "processor": "generated_module/src/processor.tsx",
-            "creator": "generated_module/src/creator.tsx"
+            "processor": "generated_module/src/processor.ts",
+            "creator": "generated_module/src/creator.ts"
         },
         "shouldNotifyOnDeploy": false
     },
-    "jenkinsPipeline": "MCU8_DS_PIPELINE_1XY",
+    "jenkinsPipeline": "MCU8_DS_PIPELINE_2XY",
     "license": "SEE LICENSE IN LICENSE.txt",
     "scripts": {
         "build": "gulp build --gulpfile config/gulpfile.js --cwd .",
@@ -48,8 +115,9 @@
         "build-run-dir-future": "node config/extract-run-directory-future.js",
         "profile": "jest profile",
         "release": "yarn build && yarn test && node -e 'require(\"./config/scf-project-scripts\").releaseProject()'",
-        "test:itf:all": "node ./node_modules/@mchp-mcc/ccl-itf/lib/index.js --sp=tests/itf --rd=run --df=\"PIC18F57Q43|PIC16F18877|PIC16LF18875|PIC18F16Q40|PIC18F16Q41|PIC18F47Q10\"",
-        "test:itf:dev": "node ./node_modules/@mchp-mcc/ccl-itf/lib/index.js --sp=tests/itf --rd=run --sf=osc.major.test.ts --df=\"PIC18F57Q43|PIC16F18877|PIC16LF18875|PIC18F16Q40|PIC18F16Q41|PIC18F47Q10\""
+        "test:itf:all": "node ./node_modules/@microchip/ccl-itf/lib/index.js --sp=tests/itf --rd=run --df=\"PIC18F57Q43|PIC16F18877|PIC16LF18875|PIC18F16Q40|PIC18F16Q41|PIC18F47Q10\"",
+        "test:itf:dev": "node ./node_modules/@microchip/ccl-itf/lib/index.js --sp=tests/itf --rd=run --sf=osc.major.test.ts --df=\"PIC18F57Q43\"",
+        "postprocess": "node config/appendPrototype.js"
     },
     "husky": {
         "hooks": {
@@ -63,8 +131,7 @@
     },
     "files": [
         "output/**/*",
-        "config.json",
-        "src/**/*"
+        "config.json"
     ],
     "repository": {
         "type": "git",
@@ -97,12 +164,11 @@
         "@microchip/basic_pin": "^1.0.2",
         "@microchip/config-request": "^2.0.2",
         "@microchip/fosc-hz": "^0.3.0",
-        "@microchip/scf-automodule-interface": "^0.16.5",
-        "@microchip/scf-common": "^3.10.0",
-        "@microchip/scf-device": "^8.2.0",
+        "@microchip/scf-common": "^3.17.0",
+        "@microchip/scf-device": "^8.5.0",
         "@microchip/scf-integration-test": "^1.0.0",
         "@microchip/scf-interface": "^1.4.0",
-        "@microchip/scf-register-view-helper": "^2.4.0",
+        "@microchip/scf-register-view-helper": "^2.5.0",
         "babel-jest": "^27.0.6"
     },
     "devDependencies": {
@@ -112,19 +178,19 @@
         "@babel/preset-react": "^7.9.4",
         "@babel/preset-typescript": "^7.9.0",
         "@mchp-mcc/avr-8bit": "^4.2.6",
-        "@mchp-mcc/ccl-itf": "^0.2.13",
-        "@mchp-mcc/pic-8bit": "^5.4.5-dev2",
-        "@mchp-mcc/pic-8bit-types": "^5.4.1",
+        "@mchp-mcc/pic-8bit": "^5.13.0-dev.2",
+        "@mchp-mcc/pic-8bit-types": "^5.13.0-dev.2",
+        "@microchip/ccl-itf": "^1.5.0",
         "@microchip/config-device": "^1.1.1",
         "@microchip/initializer-system": "^0.5.4",
         "@microchip/interrupt-vectored": "^1.2.0",
+        "@microchip/melody-automodule-interface": "^1.6.2",
         "@microchip/osc-clocks": "^0.2.0",
-        "@microchip/pic-8bit-types": "^5.0.1",
-        "@microchip/pin-standard": "^0.2.14",
-        "@microchip/run-directory": "^2.4.28",
-        "@microchip/run-directory-future": "^1.1.17",
-        "@microchip/scf-automodule": "^4.14.5",
-        "@microchip/scf-autoview": "^3.17.0",
+        "@microchip/pin-standard": "^0.4.1",
+        "@microchip/run-directory": "^4.2.3",
+        "@microchip/scf-automodule": "^5.6.2",
+        "@microchip/scf-automodule-impl": "^1.8.2",
+        "@microchip/scf-autoview": "^3.26.1",
         "@microchip/scf-project-scripts": "^1.0.0",
         "@microchip/scf-server": "^1.5.10",
         "@types/core-js": "^2.5.1",

package/src/ClockCalculator.test.ts

@@ -1,117 +0,0 @@
-import { ClockCalculator } from "./ClockCalculator";
-import { StringConstants } from "./StringConstants";
-
-describe("Osc Calculations", () => {
-    // jest cases for system oscillator calculations
-    it("Test case 1: oscSelect = SOSC, HFInternalClk = 4_MHz, externalClk = 1000000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator("SOSC", "4_MHz", 1000000, 1).getCurrentSystemClk(),
-        ).toBe(32768);
-    });
-
-    it("Test case 2: oscSelect = LFINTOSC, HFInternalClk = 4_MHz, externalClk = 1000000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator("LFINTOSC", "4_MHz", 1000000, 1).getCurrentSystemClk(),
-        ).toBe(31000);
-    });
-
-    it("Test case 3: oscSelect = HFINTOSC, HFInternalClk = 4_MHz, externalClk = 1000000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator("HFINTOSC", "4_MHz", 1000000, 1).getCurrentSystemClk(),
-        ).toBe(4000000);
-    });
-
-    it("Test case 4: oscSelect = EXTOSC, HFInternalClk = 4_MHz, externalClk = 1000000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator("EXTOSC", "4_MHz", 1000000, 1).getCurrentSystemClk(),
-        ).toBe(1000000);
-    });
-
-    it("Test case 5: oscSelect = EXTOSC   with 4x PLL, HFInternalClk = 4_MHz, externalClk = 1000000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator(
-                "EXTOSC   with 4x PLL",
-                "4_MHz",
-                1000000,
-                1,
-            ).getCurrentSystemClk(),
-        ).toBe(1000000);
-    });
-
-    it("Test case 6: oscSelect = EXTOSC   with 4x PLL, HFInternalClk = 4_MHz, externalClk = 5000000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator(
-                "EXTOSC   with 4x PLL",
-                "4_MHz",
-                5000000,
-                1,
-            ).getCurrentSystemClk(),
-        ).toBe(20000000);
-    });
-
-    it("Test case 7: oscSelect = EXTOSC   with 4x PLL, HFInternalClk = 4_MHz, externalClk = 17000000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator(
-                "EXTOSC   with 4x PLL",
-                "4_MHz",
-                17000000,
-                1,
-            ).getCurrentSystemClk(),
-        ).toBe(17000000);
-    });
-
-    it("Test case 8: oscSelect = SOSC, HFInternalClk = 4_MHz, externalClk = 17000000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator(
-                StringConstants.SOSC,
-                "4_MHz",
-                17000000,
-                1,
-            ).getCurrentSystemClk(),
-        ).toBe(32768);
-    });
-
-    it("Test case 9: oscSelect = HFINTOSC_2xPLL, HFInternalClk = 4_MHz, externalClk = 17000000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator(
-                StringConstants.HFINTOSC_2xPLL,
-                "4_MHz",
-                17000000,
-                1,
-            ).getCurrentSystemClk(),
-        ).toBe(4000000);
-    });
-
-    it("Test case 10: oscSelect = EXTOSC, HFInternalClk = 4_MHz, externalClk = 170000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator(
-                StringConstants.EXTOSC,
-                "4_MHz",
-                17000000,
-                1,
-            ).getCurrentSystemClk(),
-        ).toBe(17000000);
-    });
-
-    it("Test case 11: oscSelect = EXTOSC, HFInternalClk = 4_MHz, externalClk = 17000000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator(
-                StringConstants.EXTOSC,
-                "4_MHz",
-                17000000,
-                1,
-            ).getCurrentSystemClk(),
-        ).toBe(17000000);
-    });
-
-    it("Test case 12: oscSelect = HFINTOSC_2xPLL, HFInternalClk = 4_MHz, externalClk = 17000000Hz, clkDevider = 1", () => {
-        expect(
-            new ClockCalculator(
-                StringConstants.HFINTOSC_2xPLL,
-                "8_MHz",
-                17000000,
-                1,
-            ).getCurrentSystemClk(),
-        ).toBe(16000000);
-    });
-});

package/src/ClockCalculator.ts

@@ -1,81 +0,0 @@
-import { StringConstants } from "./StringConstants";
-
-export class ClockCalculator {
-    private lfintosc = "31000";
-    private mfintosc = "500000";
-    private mfintosc_31KHz = "31250";
-    private sosc = "32768";
-    private oscSelect: string;
-    private HFInternalClk: string;
-    private externalClk: number;
-    private clkDivider: number;
-
-    MAX_PLL = 16000000; // in Hz
-    MIN_PLL = 3000000; // in Hz
-
-    public constructor(
-        oscSelect: string,
-        HFInternalClk: string,
-        externalClk: number,
-        clkDivider: number,
-    ) {
-        this.oscSelect = oscSelect;
-        this.HFInternalClk = HFInternalClk;
-        this.externalClk = externalClk;
-        this.clkDivider = clkDivider;
-    }
-
-    public getCurrentSystemClk = (): number => {
-        let currentSystemClk: number;
-        let HFClk: number;
-
-        if (this.oscSelect === StringConstants.SOSC) {
-            currentSystemClk = 32768 / this.clkDivider;
-        } else if (this.oscSelect === StringConstants.LFINTOSC) {
-            currentSystemClk = 31000 / this.clkDivider;
-        } else if (this.oscSelect === StringConstants.HFINTOSC) {
-            HFClk = parseInt(this.HFInternalClk?.replace("_MHz", "") ?? "1000000");
-            currentSystemClk = (HFClk * 1000000) / this.clkDivider;
-        } else if (this.oscSelect === StringConstants.HFINTOSC_2xPLL) {
-            HFClk = parseInt(this.HFInternalClk?.replace("_MHz", "") ?? "1000000");
-            if (HFClk == 8 || HFClk == 12 || HFClk == 16) {
-                currentSystemClk = (HFClk * 2 * 1000000) / this.clkDivider;
-            } else {
-                currentSystemClk = (HFClk * 1000000) / this.clkDivider;
-            }
-        } else if (this.oscSelect === StringConstants.EXTOSC) {
-            currentSystemClk = this.externalClk / this.clkDivider;
-        } else {
-            if (this.externalClk <= this.MIN_PLL || this.externalClk > this.MAX_PLL) {
-                currentSystemClk = this.externalClk / this.clkDivider;
-            } else {
-                currentSystemClk = (this.externalClk * 4) / this.clkDivider;
-            }
-        }
-        return Math.round(currentSystemClk);
-    };
-
-    public getHfIntOsc = (): string => {
-        return this.HFInternalClk?.replace("_MHz", "000000") ?? "1000000";
-    };
-
-    public getMfIntOsc = (): string => {
-        return this.mfintosc;
-    };
-
-    public getMfIntOsc_31KHz = (): string => {
-        return this.mfintosc_31KHz;
-    };
-
-    public getLfIntOsc = (): string => {
-        return this.lfintosc;
-    };
-
-    public getExtOsc = (): string => {
-        return this.externalClk.toString();
-    };
-
-    public getSosc = (): string => {
-        return this.sosc;
-    };
-}

package/src/CreatorFunctions.ts

@@ -1,12 +0,0 @@
-import { CreatorFunctions } from "@microchip/scf-automodule-interface";
-import { MyState } from "../generated_module/src/types/AutoModuleTypes";
-
-export const getCreatorFunctions = (): CreatorFunctions => {
-    return {
-        shouldImport: shouldImport,
-    };
-};
-
-const shouldImport = (importKey: string, state: MyState): boolean => {
-    return true;
-};