@mchp-mcc/scf-pic8-pwm-v2 4.2.9 → 4.2.11

package/src/DerivedData.ts

@@ -1,346 +0,0 @@
-import {
-    AppModel,
-    DerivedData,
-    DerivedFunctions,
-} from "../generated_module/src/types/AutoModuleTypes";
-import * as Processor from "@microchip/scf-common/lib/Processor";
-import { PwmCalculator } from "./PwmCalculator";
-import * as pwm_general from "./interfaces/pwm_general_parameters";
-import * as initializer_system from "@microchip/initializer-system";
-import { Interface, Arguments } from "@microchip/scf-interface";
-import { getGeneratorModel, getHeaderFiles } from "./GeneratorModel";
-import { MyComponentNames, MyExportNames } from "../generated_module/src/types";
-import { getAutoSdlHelp } from "@microchip/scf-automodule-impl/lib/autoModule/ContextualHelp";
-import { getPinsLogic } from "../generated_module/src/pins/PCPHelper";
-import { MyImports } from "../generated_module/src/types";
-import { getCFunctionValidator, PatternValidator } from "@microchip/scf-validators/lib";
-import { QueryAdapterKey, intf_args } from "@microchip/pin-standard/lib/pin-standard";
-
-export const getDerivedData = (dataModel: AppModel): 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
-class EmptyDerivedData implements DerivedData {
-    getMyFunctions = (): DerivedFunctions => {
-        return {};
-    };
-    getModel = (): AppModel | undefined => {
-        return undefined;
-    };
-}
-
-//This data will be used at the processor stage
-class MyDerivedData implements DerivedData {
-    private dataModel: AppModel;
-    private pwmCalculator: PwmCalculator;
-    private cValidator: PatternValidator = getCFunctionValidator();
-
-    constructor(dataModel: AppModel) {
-        this.dataModel = dataModel;
-    }
-
-    private getPwmCalculator = (): PwmCalculator => {
-        if (!this.pwmCalculator) {
-            this.pwmCalculator = new PwmCalculator(
-                this.getTimerPrValue(),
-                this.getTimerPrescaler(),
-                this.dataModel.getImportValue("osc_clocks")?.fosc ?? 0,
-                Number(this.dataModel.getComponentValue("dutyCycle")),
-            );
-        }
-        return this.pwmCalculator;
-    };
-
-    getMyFunctions = (): DerivedFunctions => {
-        return {
-            overrideDefaultValues: this.overrideDefaultValues,
-            overrideOptions: this.overrideDefaultOptions,
-            moduleName: (): string | undefined => this.dataModel.getHardware()?.getName(),
-            pinData: this.getMyPinData,
-            alerts: this.getMyAlerts,
-
-            pwm_general_parameters_payload: this.pwm_general_parameters_payload,
-            initializer_system_results: this.initializer_system_results,
-
-            dutyCycleValidator: this.dutyCycleValidator,
-
-            componentName: this.componentName,
-            pwmdcValue: (): number => this.getPwmCalculator().getCCPRValue(),
-            pwmPeriod: (): number => this.getPwmCalculator().getPwmPeriod(),
-            pwmFrequency: (): number => this.getPwmCalculator().getPwmFrequency(),
-            pwmResolution: (): number => this.getPwmCalculator().getPwmResolution(),
-
-            ctselCcptmrs1: this.ctselTimerSetting,
-            ctselCcptmrs: this.ctselTimerSetting,
-            ctselPwmtmrs: this.ctselTimerSetting,
-            pwmdchPwmdch: (): number =>
-                Number(this.dataModel.getComponentValue("pwmdcValue")) >> 2,
-            pwmdclPwmdcl: (): number =>
-                Number(this.dataModel.getComponentValue("pwmdcValue")) & 3,
-
-            templateData: (): any => getGeneratorModel(this.dataModel),
-            getHelpUrl: this.getSdlHelpOverride,
-            filterImports: this.filterImports,
-            getPinsLogic: getPinsLogic,
-            importName: this.friendlyImportName,
-            componentNameValidator: this.componentNameValidator,
-            getCustomUiErrors: this.getCustomUiErrors,
-            pin_standard_args: this.getPinstandardArgs,
-        };
-    };
-
-    private friendlyImportName = (importKey: string): string => {
-        if (importKey === "scf_pic8_pwm_v2") return "PWM Hardware";
-        if (importKey === "osc_clocks") return "Oscillator Clock";
-        if (importKey === "initializer_system") return "system.c Initialize()";
-        if (importKey === "pin_standard") return "Pins";
-        return importKey;
-    };
-
-    private overrideDefaultValues = (componentName: string): any => {
-        switch (componentName) {
-            case "componentName":
-                return this.dataModel.getHardware()?.getName();
-            default:
-                return undefined;
-        }
-    };
-
-    private componentNameValidator = (): any => {
-        return {
-            pattern: this.cValidator.getRjsfValidation().pattern,
-        };
-    };
-
-    private getCustomUiErrors = (componentName: string): Error[] | undefined => {
-        switch (componentName) {
-            case "componentName":
-                return [
-                    {
-                        name: "pattern",
-                        message: this.cValidator.getCustomErrorMessage(),
-                    },
-                ];
-            default:
-                return undefined;
-        }
-    };
-
-    private readonly getPinstandardArgs = (): intf_args => {
-        const args: intf_args = {
-            queryAdapters: ["pps", "apfcon"],
-            queryAdapterMap: {
-                [QueryAdapterKey.ALLPINS]: "^PWM[0-9]{0,1}$",
-            },
-        };
-
-        return args;
-    };
-
-    private overrideDefaultOptions = (componentName: string): any[] => {
-        switch (componentName) {
-            case "timerSelection": {
-                const result: any[] = [];
-                const CCPTMRSREG =
-                    this.dataModel.getPeripheralDescription()?.registers?.CCPTMRS1 ??
-                    this.dataModel.getPeripheralDescription()?.registers?.CCPTMRS;
-                const PWMTMRSREG = this.dataModel.getPeripheralDescription()?.registers
-                    ?.PWMTMRS;
-                if (CCPTMRSREG) {
-                    const CTSELSETT = CCPTMRSREG.settings?.CTSEL;
-                    for (const eachoptn of CTSELSETT?.options ?? []) {
-                        const timeroptnregex = /^pwm\d+timer(\d)$/i;
-                        const optnmatch = eachoptn.alias.match(timeroptnregex);
-                        const correctOptnName =
-                            (optnmatch?.length ?? 0) > 1 ? "TMR" + optnmatch?.[1] : "";
-                        result.push(correctOptnName);
-                    }
-                }
-                if (PWMTMRSREG) {
-                    const CTSELSETT = PWMTMRSREG.settings?.CTSEL;
-                    for (const eachoptn of CTSELSETT?.options ?? []) {
-                        const timeroptnregex = /^pwm\d+timer(\d)$/i;
-                        const optnmatch = eachoptn.alias.match(timeroptnregex);
-                        const correctOptnName =
-                            (optnmatch?.length ?? 0) > 1 ? "TMR" + optnmatch?.[1] : "";
-                        result.push(correctOptnName);
-                    }
-                }
-                if (!CCPTMRSREG && !PWMTMRSREG) {
-                    result.push("TMR2");
-                }
-                return result;
-            }
-            default:
-                return [] /*for other fields - undefined as take options from moduleconfig.json*/;
-        }
-    };
-
-    public getModel = (): AppModel => {
-        return this.dataModel;
-    };
-
-    private getMyPinData = (): any => {
-        return {};
-    };
-
-    private filterImports = (imports: MyImports): MyImports => {
-        let filteredImports: MyImports = imports;
-        const ImportKeys = ["Timer"];
-
-        ImportKeys.forEach((importKey) => {
-            filteredImports = this.getModel().filterImportBySetting(
-                filteredImports,
-                importKey,
-                (option: Processor.Option<any>): any => {
-                    if (option.payload !== undefined) {
-                        const rstSource =
-                            this.dataModel.getComponentValue("timerSelection") ??
-                            "disabled";
-                        const regexpNumber = /\d/;
-                        const inst = rstSource.match(regexpNumber);
-                        if (rstSource.indexOf("TMR") !== -1) {
-                            return option.payload.moduleName === "TMR" + inst;
-                        }
-                    }
-                },
-            ) as MyImports;
-        });
-        return filteredImports;
-    };
-
-    private getMyAlerts = (): Processor.Alert[] => {
-        const alerts: Processor.Alert[] = [];
-
-        const timerSelection: string =
-            this.dataModel.getComponentValue("timerSelection") ?? "";
-        const groupmatch = timerSelection.match(/^TMR([0-9])$/) ?? "";
-        const timersuffix = groupmatch?.length > 1 ? groupmatch[1] : "";
-        if (
-            this.dataModel.getAssignedImport("Timer") == undefined ||
-            this.dataModel.getAssignedImport("Timer")?.handle?.label !==
-                "TMR" + timersuffix
-        ) {
-            alerts.push({
-                text: `Please select ${timerSelection} as the Timer Dependency.`,
-                type: Processor.AlertTypes.Warning,
-            });
-        } else {
-            alerts.push({
-                text: `${this.dataModel.getName()} uses ${timerSelection}.`,
-                type: Processor.AlertTypes.Hint,
-            });
-            alerts.push({
-                text: `Postscaler setting in ${timerSelection} does not affect the calculated parameters in PWM module.`,
-                type: Processor.AlertTypes.Hint,
-            });
-            if (
-                Number(this.dataModel.getComponentValue("pwmdcValue")) / 4 >
-                this.getTimerPrValue()
-            ) {
-                alerts.push({
-                    text: `The value for Duty Cycle percentage is crossing 100 because the period value set in tmr is greater than the dutycycle value set in PWM. Set the duty cycle to be less than 100 percent.`,
-                    type: Processor.AlertTypes.Warning,
-                });
-            }
-        }
-
-        return alerts;
-    };
-
-    private getSdlHelpOverride = (
-        componentName: MyComponentNames,
-        helpUrl: string,
-    ): string => {
-        if (componentName === "timerSelection") {
-            if (this.getModel().getPeripheralDescription()?.registers?.CCPTMRS1) {
-                componentName = "ctselCcptmrs1";
-            } else if (this.getModel().getPeripheralDescription()?.registers?.CCPTMRS) {
-                componentName = "ctselCcptmrs";
-            } else if (this.getModel().getPeripheralDescription()?.registers?.PWMTMRS) {
-                componentName = "ctselPwmtmrs";
-            }
-        } else if (componentName === "dutyCycle" || componentName === "pwmdcValue") {
-            helpUrl = helpUrl?.replace(
-                "${instance}",
-                this.getModel().getHardware()?.getName() ?? "",
-            );
-        }
-
-        return getAutoSdlHelp(this.getModel() as any, componentName, helpUrl);
-    };
-
-    private pwm_general_parameters_payload = (): pwm_general.ProcessedPayload => {
-        return {
-            interfaceApi: pwm_general.Interface.createFirmwareApi(
-                this.dataModel.getComponentValue("componentName") ?? "",
-                getHeaderFiles(this.dataModel),
-            ),
-            customName: this.dataModel.getComponentValue("componentName"),
-            modulename: this.dataModel.getName(),
-            isdriverisr: false,
-            ispwmi_enabled: false,
-            ispwmpi_enabled: false,
-            moduleName: this.dataModel.getName(),
-        };
-    };
-
-    private initializer_system_results = (): initializer_system.Results => {
-        return {
-            initializer: {
-                name: this.dataModel.getComponentValue("componentName") + "_Initialize",
-                header: getHeaderFiles(this.dataModel)[0],
-            },
-        };
-    };
-
-    private dutyCycleValidator = (): any => {
-        return {
-            minimum: 0,
-            maximum: 100,
-        };
-    };
-
-    private componentName = (): string | undefined => {
-        const arg = this.getArg("pwm_general", pwm_general.Interface);
-        if (arg) {
-            const pwmArg: pwm_general.Arguments = arg;
-            return pwmArg.customName;
-        }
-        return undefined;
-    };
-
-    private ctselTimerSetting = (): string | undefined => {
-        const timerSelection: string =
-            this.dataModel.getComponentValue("timerSelection") ?? "";
-        const groupmatch = timerSelection.match(/^TMR([0-9])$/) ?? "";
-        if (groupmatch.length > 1) {
-            const timersuffix = groupmatch?.length > 1 ? groupmatch[1] : "";
-            return this.dataModel.getHardware()?.getName() + "timer" + timersuffix;
-        } else {
-            return undefined;
-        }
-    };
-
-    private getTimerPrValue = (): number => {
-        return this.dataModel.getImportValue("Timer")?.periodRegisterValue ?? 255;
-    };
-
-    private getTimerPrescaler = (): number => {
-        return this.dataModel.getImportValue("Timer")?.prescaleValue ?? 1;
-    };
-
-    private getArg = (key: MyExportNames, id: Interface): Arguments => {
-        const exportInterface = this.dataModel
-            .getExportInterfaces()
-            .getInterface(key, id.getInterfaceId());
-        if (exportInterface?.args) {
-            // choose the first requester for now
-            return exportInterface.args[Object.keys(exportInterface.args)[0]];
-        }
-    };
-}

package/src/GeneratorModel.test.tsx

@@ -1,39 +0,0 @@
-//import { getModel } from "../generated_module/src/App/AppModel";
-import { AppModel } from "../generated_module/src/types/AutoModuleTypes";
-import { getModel, mockState } from "../generated_module/tests/AppModel.test";
-import { mockAssignedModule } from "../generated_module/tests/processor.test";
-import * as MyDerivedData from "./DerivedData";
-import * as GenertorModel from "./GeneratorModel";
-
-describe("GeneratorModel", () => {
-    describe("getGeneratorModel", () => {
-        test("componentName is undefined", () => {
-            const mockModule = mockAssignedModule(mockState());
-            const model = getModel(mockModule, MyDerivedData.getDerivedData as any);
-            if (model) {
-                model.getComponentValue = (comp_name: string): any => {
-                    const compData = {
-                        componentName: undefined,
-                    };
-                    return compData[comp_name];
-                };
-                expect(
-                    GenertorModel.getGeneratorModel(model as any).customName,
-                ).toBeUndefined();
-            }
-        });
-
-        test("PeripheralDescription is undefined", () => {
-            const mockModule = mockAssignedModule(mockState());
-            const model = getModel(mockModule, MyDerivedData.getDerivedData as any);
-            if (model) {
-                model.getPeripheralDescription = (): any => {
-                    return undefined;
-                };
-                expect(
-                    GenertorModel.getGeneratorModel(model as AppModel).hardwareSettings,
-                ).toBeDefined;
-            }
-        });
-    });
-});

package/src/GeneratorModel.tsx

@@ -1,65 +0,0 @@
-import { AppModel } from "../generated_module/src/types/AutoModuleTypes";
-import * as pwm_general from "./interfaces/pwm_general_parameters";
-import * as InterfaceTypes from "@microchip/scf-interface";
-import { getOptionValueByName } from "../generated_module/src/autoModule/AutoModuleHelpers";
-import { getTemplateSettings } from "../generated_module/src/autoModule/AutoModuleTemplates";
-import { values } from "../generated_module/src/Utils";
-
-export const getGeneratorModel = (model: AppModel): any => {
-    if (!model.getHardware()) return {};
-
-    const pwmInterface = pwm_general.Interface.createFirmwareApi(
-        model.getComponentValue("componentName") ?? "",
-        getHeaderFiles(model),
-    );
-
-    const templateSettings = getTemplateSettings(model);
-
-    const registerValues = templateSettings?.registers;
-    const initRegisters: any[] = values(registerValues ?? {});
-
-    const ctsel = model.getPeripheralDescription()?.registers?.CCPTMRS1?.settings?.CTSEL;
-    const CTSELvalue = ctsel
-        ? getOptionValueByName(ctsel, model.getDerivedFunction("ctselCcptmrs1"))
-        : 1;
-
-    return {
-        moduleNameLowerCase: model.getName()?.toLowerCase(),
-        moduleNameUpperCase: model.getName()?.toUpperCase(),
-        header: pwmInterface.headerFiles?.[0],
-        api: pwmInterface.api,
-        simpleApi: pwmInterface.simpleApi,
-
-        productName: "",
-        productVersion: "",
-        selectedDevice: "PIC18F47Q10",
-        compiler: "XC8 v2.20",
-        tool: "MPLABX v5.40",
-
-        //From System Manager
-        useWatchdog: model.getImportValue("wdtEnable") ?? false, //TODO
-
-        //Registers and Settings
-        initRegisters: initRegisters,
-        // PWMDCH: templateSettings?.registers?.PWMDCH.name ?? "",
-        // PWMDCL: templateSettings?.registers?.PWMDCL?.name ?? "",
-        CCPTMRSregname: templateSettings?.registers?.CCPTMRS1?.name ?? "",
-        CTSELsettingname:
-            templateSettings?.registers?.CCPTMRS1?.settings?.CTSEL.name ?? "",
-        CTSELvalue: CTSELvalue,
-        timerselpresence:
-            (ctsel?.options?.length ?? 0) > 0 ? "timerselpresent" : "timerselabsent",
-
-        pwmdcValue: model.getComponentValue("pwmdcValue"),
-        ...registerValues,
-    };
-};
-
-export const getHeaderFiles = (model: AppModel): InterfaceTypes.HeaderFile[] => {
-    return [
-        {
-            name: model.getName().toLowerCase() + ".h",
-            path: "pwm/",
-        },
-    ];
-};