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

package/src/DerivedData.ts

@@ -1,304 +0,0 @@
-import * as Processor from "@microchip/scf-common/lib/Processor";
-import { ClockCalculator } from "./ClockCalculator";
-import * as initializer_system from "@microchip/initializer-system";
-import * as config_device from "@microchip/config-device";
-import { StringConstants } from "./StringConstants";
-import osc_clocks from "@microchip/osc-clocks";
-import * as config_request from "@microchip/config-request";
-import {
-    AppModel,
-    DerivedData,
-    DerivedFunctions,
-} from "../generated_module/src/types/AutoModuleTypes";
-import * as InterfaceTypes from "@microchip/scf-interface";
-
-export const getDerivedData = (dataModel: AppModel | undefined): DerivedData => {
-    if (dataModel) {
-        return new MyDerivedData(dataModel);
-    }
-    return new EmptyDerivedData();
-};
-
-//This data will be used at the creator stage and relies on only the state
-export class EmptyDerivedData implements DerivedData {
-    getMyFunctions = (): DerivedFunctions => {
-        return {};
-    };
-    getModel = (): AppModel | undefined => {
-        return undefined;
-    };
-}
-
-//This data will be used at the processor stage
-export class MyDerivedData implements DerivedData {
-    private dataModel: AppModel;
-    private clockCalculator: ClockCalculator;
-
-    constructor(dataModel: AppModel) {
-        this.dataModel = dataModel;
-    }
-
-    getClockCalculator = (): ClockCalculator => {
-        if (!this.clockCalculator) {
-            this.clockCalculator = new ClockCalculator(
-                this.getModel().getComponentValue("noscOsccon1") ?? "",
-                this.getModel().getComponentValue("hffrqOscfrq") ?? "",
-                this.getModel().getComponentValue("externalClk") ?? 32768,
-                parseInt(this.getModel().getComponentValue("ndivOsccon1") ?? ""),
-            );
-        }
-        return this.clockCalculator;
-    };
-
-    getMyFunctions = (): DerivedFunctions => {
-        return {
-            moduleName: this.getModuleName,
-            alerts: this.getMyAlerts,
-            isEnabled: this.isEnabled,
-            isVisible: this.isVisible,
-            currentSystemClk: (): number =>
-                this.getClockCalculator().getCurrentSystemClk(),
-            "fosc-hz_payload": (): string =>
-                this.getClockCalculator().getCurrentSystemClk().toString(),
-            initializer_system_results: this.initializer_system_results,
-            config_device_results: this.config_device_results,
-            templateData: this.getTemplateData,
-            config_request_args: (): config_request.Arguments => [
-                "FEXTOSC",
-                "CLKOUTEN",
-                "MCLRE",
-                "LVP",
-            ],
-            "osc-clocks_payload": this.getOscClocksProcessedPayload,
-        };
-    };
-
-    private getOscClocksProcessedPayload = (): osc_clocks.ProcessedPayload => {
-        const oscObj: osc_clocks.ProcessedPayload = {
-            extosc: this.getClockCalculator().getExtOsc() ?? "32768",
-            fosc: this.getClockCalculator().getCurrentSystemClk().toString() ?? "1000000",
-            hfintosc: this.getClockCalculator().getHfIntOsc() ?? "1000000",
-            lfintosc: this.getClockCalculator().getLfIntOsc() ?? "31000",
-            mfintosc: this.getClockCalculator().getMfIntOsc() ?? "500000",
-            mfintosc_31Khz: this.getClockCalculator().getMfIntOsc_31KHz() ?? "31250",
-            sosc: this.getClockCalculator().getSosc() ?? "32768",
-        };
-        const hasSosc: boolean =
-            this.dataModel.isComponentValue("soscenOscen") !== undefined ? true : false;
-        if (hasSosc) {
-            oscObj.hasSosc = true;
-            oscObj.soscEnabled = this.dataModel.isComponentValue("soscenOscen");
-            oscObj.soscPowerMode = this.dataModel.getComponentValue("soscpwrOsccon3");
-        }
-        return oscObj;
-    };
-
-    public getModuleName = (): string => {
-        return "Clock Control";
-    };
-    public getModel = (): AppModel => {
-        return this.dataModel;
-    };
-
-    private getTemplateData = (): any => {
-        const headers: InterfaceTypes.HeaderFile = {
-            name: "clock.h",
-            path: "../",
-        };
-        const initRegisters = this.dataModel.getRegisterValues();
-        return {
-            productName: "CCL",
-            productVersion: "1.8.2",
-            compiler: "XC8 v2.20",
-            tool: "MPLAB X 5.40",
-
-            deviceFrequency: this.getClockCalculator().getCurrentSystemClk().toString(),
-
-            initRegisters: initRegisters,
-            header: headers,
-
-            moduleNameUpperCase: this.getModuleName().toUpperCase(),
-            moduleNameLowerCase: this.getModuleName().toLowerCase(),
-        };
-    };
-    private initializer_system_results = (): initializer_system.Results => {
-        return {
-            initializer: {
-                name: "CLOCK_Initialize",
-                header: {
-                    name: "clock.h",
-                    path: "system/",
-                },
-                priority: initializer_system.INIT_PRIORITY.START,
-            },
-        };
-    };
-
-    private config_device_results = (): config_device.Results => {
-        return {
-            headers: [
-                {
-                    name: "clock.h",
-                    path: "system/",
-                },
-            ],
-        };
-    };
-
-    private isEnabled = (componentName: string): boolean => {
-        switch (componentName) {
-            case "hffrqOscfrq":
-                return (
-                    this.dataModel.getComponentValue("noscOsccon1")?.indexOf("HF") != -1
-                );
-            case "currentSystemClk":
-                return false;
-            case "lfIntOscFreq":
-                return false;
-            default:
-                return true;
-        }
-    };
-
-    private isVisible = (componentName: string): boolean => {
-        const componentValue = this.dataModel.getComponentValue("noscOsccon1");
-        switch (componentName) {
-            case "externalClk":
-                if (
-                    componentValue === StringConstants.EXTOSC ||
-                    componentValue === StringConstants.EXTOSC_4xPLL
-                ) {
-                    return true;
-                } else {
-                    return false;
-                }
-            case "lfIntOscFreq":
-                if (componentValue != StringConstants.LFINTOSC) {
-                    return false;
-                } else {
-                    return true;
-                }
-            case "hffrqOscfrq":
-                if (
-                    componentValue != StringConstants.HFINTOSC &&
-                    componentValue != StringConstants.HFINTOSC_2xPLL
-                ) {
-                    return false;
-                } else {
-                    return true;
-                }
-            default:
-                return true;
-        }
-    };
-
-    private getDynamicComponetDefaultValue = (
-        componentName: string,
-    ): string | undefined => {
-        const externalClkSelectedOptions = this.dataModel.getImportValue(
-            "config_request",
-        )?.[componentName];
-        let selectedOptionVal: string | undefined;
-        if (externalClkSelectedOptions) {
-            selectedOptionVal = externalClkSelectedOptions["defaultValue"]["value"];
-        }
-        return selectedOptionVal ?? undefined;
-    };
-
-    private getMyAlerts = (): Processor.Alert[] => {
-        const alerts: Processor.Alert[] = [];
-        const selectedOptionVal: string =
-            this.getDynamicComponetDefaultValue("FEXTOSC") ?? "";
-        const noscOsccon1 = this.dataModel.getComponentValue("noscOsccon1");
-
-        if (
-            noscOsccon1 === StringConstants.EXTOSC_4xPLL ||
-            noscOsccon1 === StringConstants.EXTOSC
-        ) {
-            alerts.push({
-                type: Processor.AlertTypes.Hint,
-                text:
-                    'Please configure required "External Oscillator Selection" in System Module config bits',
-            });
-        }
-
-        if (
-            noscOsccon1 === StringConstants.EXTOSC_4xPLL &&
-            ((this.getModel().getComponentValue("externalClk") ?? 0) <=
-                this.getClockCalculator().MIN_PLL ||
-                (this.getModel().getComponentValue("externalClk") ?? 0) >
-                    this.getClockCalculator().MAX_PLL)
-        ) {
-            alerts.push({
-                type: Processor.AlertTypes.Warning,
-                text:
-                    "The frequency selected does not fall within the PLL locking range. Therefore, the actual frequency produced by hardware maybe unpredictable when the PLL is enabled. Either change the clock frequency or select a different option in Oscillator select.",
-            });
-        }
-
-        if (
-            noscOsccon1 === StringConstants.EXTOSC_4xPLL ||
-            noscOsccon1 === StringConstants.EXTOSC
-        ) {
-            if (
-                selectedOptionVal?.indexOf("external clock") != -1 &&
-                this.getClockCalculator().getCurrentSystemClk() >
-                    StringConstants.ExtClkFreq_64MHz
-            ) {
-                alerts.push({
-                    type: Processor.AlertTypes.Warning,
-                    text:
-                        "External clock frequency is greater than recommended value (" +
-                        StringConstants.ExtClkFreq_64MHz +
-                        " Hz)",
-                });
-            }
-
-            if (
-                selectedOptionVal?.indexOf("crystal oscillator") != -1 &&
-                (this.getModel().getComponentValue("externalClk") ?? 0) > 16000000 &&
-                this.getClockCalculator().getCurrentSystemClk() >
-                    StringConstants.ExtClkFreq_20MHz
-            ) {
-                alerts.push({
-                    type: Processor.AlertTypes.Warning,
-                    text:
-                        "External clock frequency is greater than recommended value (" +
-                        StringConstants.ExtClkFreq_20MHz +
-                        " Hz)",
-                });
-            }
-
-            if (
-                selectedOptionVal.indexOf("Oscillator not enabled") != -1 &&
-                this.getClockCalculator().getCurrentSystemClk() >
-                    StringConstants.ExtClkFreq_32MHz
-            ) {
-                alerts.push({
-                    type: Processor.AlertTypes.Warning,
-                    text:
-                        "External clock frequency is greater than recommended value (" +
-                        StringConstants.ExtClkFreq_32MHz +
-                        " Hz)",
-                });
-            }
-        }
-
-        const HFClk = parseInt(
-            this.dataModel.getComponentValue("hffrqOscfrq")?.replace("_MHz", "") ?? "0",
-        );
-        if (
-            this.dataModel.getComponentValue("noscOsccon1") ===
-                StringConstants.HFINTOSC_2xPLL &&
-            (HFClk == 1 || HFClk == 2 || HFClk == 4 || HFClk == 32)
-        ) {
-            alerts.push({
-                type: Processor.AlertTypes.Warning,
-                text:
-                    "The frequency set in HF Internal Clock may not get generated by the clock hardware properly since it does not fall within the 2xPLL range of 8-16 MHz. Therefore, it is recommended that the option 'HFINTOSC' be selected in the Oscillator select combo box.",
-            });
-        }
-
-        return alerts;
-    };
-}