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

package/src/PinsLogic.ts

@@ -1,213 +0,0 @@
-import { AppModel } from "../generated_module/src/types/AutoModuleTypes";
-import { pin_row, behaviour } from "@microchip/pin-standard";
-
-// provide complete dynamic data for all pin rows. It overrides static pindata.json
-export const getCompletePinData = (appModel: AppModel): any => {
-    // way to programatically override the json data
-    return {};
-};
-
-// overrides pin data for a particular row based on model.
-export function getRowData(appModel: AppModel, rowData: pin_row): pin_row | undefined {
-    const pwminstancename = appModel.getHardware()?.getPeripheral()?.instance;
-    const moduleName = appModel.getName() ?? "PWM";
-    const allPinsData: any = appModel.getImportValue("pin_standard")?.allpins;
-    const modulePins: string[] = getModulePins(allPinsData, moduleName);
-    const pinName: string = getPinName(modulePins, rowData.filter.aliasReEx);
-    const pinBehaviour: string = getpinBehaviour(allPinsData, moduleName, pinName);
-    const isPPS = pinBehaviour === "pps";
-    const isAPFCON = pinBehaviour === "apfcon";
-
-    if (pinName === "") {
-        return undefined;
-    }
-    if (rowData.name === "out") {
-        rowData = {
-            ...rowData,
-            module: moduleName,
-            function: moduleName + "OUT",
-            filter: {
-                module: moduleName,
-                aliasReEx: `^PWM${pwminstancename}$`,
-            },
-            behaviour: isPPS
-                ? behaviour.PPS
-                : isAPFCON
-                ? behaviour.APFCON
-                : behaviour.LOCK_UNLOCK,
-        };
-    } else if (rowData.name === "pwmx0") {
-        rowData = {
-            ...rowData,
-            module: moduleName,
-            function: moduleName + "0OUT",
-            filter: {
-                ...rowData.filter,
-                module: moduleName,
-            },
-            behaviour: isPPS
-                ? behaviour.PPS
-                : isAPFCON
-                ? behaviour.APFCON
-                : behaviour.LOCK_UNLOCK,
-        };
-        if (appModel.isComponentValue("pwmoe0Pwmaoe") === true) {
-            rowData = {
-                ...rowData,
-                behaviourMeta: { lockPinRegEx: moduleName + "0" },
-            };
-        }
-    } else if (rowData.name === "pwmx1") {
-        rowData = {
-            ...rowData,
-            module: moduleName,
-            function: moduleName + "1OUT",
-            filter: {
-                ...rowData.filter,
-                module: moduleName,
-            },
-            behaviour: isPPS
-                ? behaviour.PPS
-                : isAPFCON
-                ? behaviour.APFCON
-                : behaviour.LOCK_UNLOCK,
-        };
-        if (appModel.isComponentValue("pwmoe1Pwmaoe") === true) {
-            rowData = {
-                ...rowData,
-                behaviourMeta: { lockPinRegEx: moduleName + "1" },
-            };
-        }
-    } else if (rowData.name === "pwmx2") {
-        rowData = {
-            ...rowData,
-            module: moduleName,
-            function: moduleName + "2OUT",
-            filter: {
-                ...rowData.filter,
-                module: moduleName,
-            },
-            behaviour: isPPS
-                ? behaviour.PPS
-                : isAPFCON
-                ? behaviour.APFCON
-                : behaviour.LOCK_UNLOCK,
-        };
-        if (appModel.isComponentValue("pwmoe2Pwmaoe") === true) {
-            rowData = {
-                ...rowData,
-                behaviourMeta: { lockPinRegEx: moduleName + "2" },
-            };
-        }
-    } else if (rowData.name === "pwmx3") {
-        rowData = {
-            ...rowData,
-            module: moduleName,
-            function: moduleName + "3OUT",
-            filter: {
-                ...rowData.filter,
-                module: moduleName,
-            },
-            behaviour: isPPS
-                ? behaviour.PPS
-                : isAPFCON
-                ? behaviour.APFCON
-                : behaviour.LOCK_UNLOCK,
-        };
-        if (appModel.isComponentValue("pwmoe3Pwmaoe") === true) {
-            rowData = {
-                ...rowData,
-                behaviourMeta: { lockPinRegEx: moduleName + "3" },
-            };
-        }
-    }
-
-    let rowActions = [];
-    const pwmx0Regcomponent = appModel.getComponent("pwmoe0Pwmaoe")?.component;
-    const pwmx1Regcomponent = appModel.getComponent("pwmoe1Pwmaoe")?.component;
-    const pwmx2Regcomponent = appModel.getComponent("pwmoe2Pwmaoe")?.component;
-    const pwmx3Regcomponent = appModel.getComponent("pwmoe3Pwmaoe")?.component;
-
-    if (pwmx0Regcomponent) {
-        rowActions = rowActions.concat(
-            appModel
-                .getPCPHelper?.()
-                .stateActionBuilder(rowData)
-                .rowWithName("pwmx0")
-                .forComponent(pwmx0Regcomponent)
-                .addIfLockedSetValue(moduleName + "0", true)
-                .addIfUnLockedSetValue(".*", false)
-                .build(),
-        );
-    }
-    if (pwmx1Regcomponent) {
-        rowActions = rowActions.concat(
-            appModel
-                .getPCPHelper?.()
-                .stateActionBuilder(rowData)
-                .rowWithName("pwmx1")
-                .forComponent(pwmx1Regcomponent)
-                .addIfLockedSetValue(moduleName + "1", true)
-                .addIfUnLockedSetValue(".*", false)
-                .build(),
-        );
-    }
-    if (pwmx2Regcomponent) {
-        rowActions = rowActions.concat(
-            appModel
-                .getPCPHelper?.()
-                .stateActionBuilder(rowData)
-                .rowWithName("pwmx2")
-                .forComponent(pwmx2Regcomponent)
-                .addIfLockedSetValue(moduleName + "2", true)
-                .addIfUnLockedSetValue(".*", false)
-                .build(),
-        );
-    }
-    if (pwmx3Regcomponent) {
-        rowActions = rowActions.concat(
-            appModel
-                .getPCPHelper?.()
-                .stateActionBuilder(rowData)
-                .rowWithName("pwmx3")
-                .forComponent(pwmx3Regcomponent)
-                .addIfLockedSetValue(moduleName + "3", true)
-                .addIfUnLockedSetValue(".*", false)
-                .build(),
-        );
-    }
-    rowData = { ...rowData, actions: rowActions };
-    return rowData;
-}
-const getModulePins = (allPins: any, moduleName: string): string[] => {
-    const pins: string[] = [];
-    for (const portPin in allPins) {
-        const modulePins: any = allPins[portPin]?.[moduleName];
-        for (const modulePin in modulePins) {
-            if (pins.indexOf(modulePin) === -1) {
-                pins.push(modulePin);
-            }
-        }
-    }
-    return pins;
-};
-const getPinName = (modulePins: string[], regEx: string): string => {
-    let pinName = "";
-    modulePins.forEach((pin) => {
-        if (pin.match(new RegExp(regEx, "g"))) {
-            pinName = pin;
-        }
-    });
-    return pinName;
-};
-const getpinBehaviour = (allPins: any, moduleName: string, pinName: string): string => {
-    for (const portPin in allPins) {
-        const pinData: any = allPins[portPin]?.[moduleName]?.[pinName];
-        if (pinData?.["pps"]) {
-            return "pps";
-        } else if (pinData?.["apfcon"]) {
-            return "apfcon";
-        }
-    }
-    return "lock_unlock";
-};

package/src/PwmCalculator.test.tsx

@@ -1,113 +0,0 @@
-import { PwmCalculator } from "./PwmCalculator";
-
-describe("Pwm Calculations: PR = 0x7c, Prescaler = 0x4, fosc = 4M, DC = 75", () => {
-    const pwmCalculator = new PwmCalculator(0x7c, 16, 4000000, 75);
-
-    test("getPwmPeriod", () => {
-        expect(pwmCalculator.getPwmPeriod()).toBe(0.002);
-    });
-
-    test("getPwmFrequency", () => {
-        expect(pwmCalculator.getPwmFrequency()).toBe(500);
-    });
-
-    test("getPwmResolution", () => {
-        expect(pwmCalculator.getPwmResolution()).toBe(8);
-    });
-
-    test("getCCPRValue", () => {
-        expect(pwmCalculator.getCCPRValue()).toBe(374);
-    });
-
-    test("getActualDutyCycle", () => {
-        expect(pwmCalculator.getActualDutyCycle()).toBe(75);
-    });
-
-    test("getActualPulseWidth", () => {
-        expect(pwmCalculator.getActualPulseWidth()).toBe(0.001496);
-    });
-});
-
-describe("Pwm Calculations: PR = 0x4d, Prescaler = 0x5, fosc = 1M, DC = 60", () => {
-    const pwmCalculator2 = new PwmCalculator(0x4d, 32, 1000000, 60);
-
-    test("getPwmPeriod", () => {
-        expect(pwmCalculator2.getPwmPeriod()).toBe(0.009984);
-    });
-
-    test("getPwmFrequency", () => {
-        expect(pwmCalculator2.getPwmFrequency()).toBe(100.16);
-    });
-
-    test("getPwmResolution", () => {
-        expect(pwmCalculator2.getPwmResolution()).toBe(8);
-    });
-
-    test("getCCPRValue", () => {
-        expect(pwmCalculator2.getCCPRValue()).toBe(186);
-    });
-
-    test("getActualDutyCycle", () => {
-        expect(pwmCalculator2.getActualDutyCycle()).toBe(60);
-    });
-
-    test("getActualPulseWidth", () => {
-        expect(pwmCalculator2.getActualPulseWidth()).toBe(0.005952);
-    });
-});
-
-describe("Pwm Calculations: PR = 0x0, Prescaler = 0x0, fosc = 1M, DC = 0", () => {
-    const pwmCalculator2 = new PwmCalculator(0x0, 0, 1000000, 0);
-
-    test("getPwmPeriod", () => {
-        expect(pwmCalculator2.getPwmPeriod()).toBe(0);
-    });
-
-    test("getPwmFrequency", () => {
-        expect(pwmCalculator2.getPwmFrequency()).toBe(0);
-    });
-
-    test("getPwmResolution", () => {
-        expect(pwmCalculator2.getPwmResolution()).toBe(2);
-    });
-
-    test("getCCPRValue", () => {
-        expect(pwmCalculator2.getCCPRValue()).toBe(0);
-    });
-
-    test("getActualDutyCycle", () => {
-        expect(pwmCalculator2.getActualDutyCycle()).toBe(0);
-    });
-
-    test("getActualPulseWidth", () => {
-        expect(pwmCalculator2.getActualPulseWidth()).toBe(0);
-    });
-});
-
-describe("Pwm Calculations: PR = 0x0, Prescaler = 0x0, fosc = 0, DC = 0", () => {
-    const pwmCalculator2 = new PwmCalculator(0x0, 0, 0, 0);
-
-    test("getPwmPeriod", () => {
-        expect(pwmCalculator2.getPwmPeriod()).toBe(0);
-    });
-
-    test("getPwmFrequency", () => {
-        expect(pwmCalculator2.getPwmFrequency()).toBe(0);
-    });
-
-    test("getPwmResolution", () => {
-        expect(pwmCalculator2.getPwmResolution()).toBe(2);
-    });
-
-    test("getCCPRValue", () => {
-        expect(pwmCalculator2.getCCPRValue()).toBe(0);
-    });
-
-    test("getActualDutyCycle", () => {
-        expect(pwmCalculator2.getActualDutyCycle()).toBe(0);
-    });
-
-    test("getActualPulseWidth", () => {
-        expect(pwmCalculator2.getActualPulseWidth()).toBe(0);
-    });
-});

package/src/PwmCalculator.tsx

@@ -1,67 +0,0 @@
-// Reused from Q43 CCP calculator
-// TODO: delete this duplicate and add CCP calculator dependency
-import log10 from "core-js/features/math/log10";
-
-export class PwmCalculator {
-    private prValue: number;
-    private prescaler: number;
-    private fosc: number;
-    private dutyCycleRatio: number;
-
-    constructor(prValue: number, prescaler: number, fosc: number, dutyCycle: number) {
-        this.prValue = prValue;
-        this.prescaler = prescaler;
-        this.fosc = fosc;
-        this.dutyCycleRatio = dutyCycle / 100;
-    }
-
-    public getPwmPeriod = (): number => {
-        let pwmPeriod = (this.prValue + 1) * 4 * this.prescaler;
-        if (this.fosc > 0) {
-            pwmPeriod = pwmPeriod / this.fosc;
-        } else {
-            pwmPeriod = 0;
-        }
-        return pwmPeriod;
-    };
-
-    public getPwmFrequency = (): number => {
-        let pwmFrequency = (this.prValue + 1) * 4 * this.prescaler;
-        if (pwmFrequency > 0) {
-            pwmFrequency = this.fosc / pwmFrequency;
-        } else {
-            pwmFrequency = 0;
-        }
-
-        pwmFrequency = Math.round(pwmFrequency * 100) / 100;
-        return pwmFrequency;
-    };
-
-    public getPwmResolution = (): number => {
-        const pwmResolution = log10(4 * (this.prValue + 1)) / log10(2);
-        return Math.floor(pwmResolution);
-    };
-
-    public getCCPRValue = (): number => {
-        const ccprValue = Math.round(this.dutyCycleRatio * 4 * (this.prValue + 1) - 1);
-        if (ccprValue < 0) {
-            return 0;
-        }
-        return ccprValue;
-    };
-
-    public getActualDutyCycle = (): number => {
-        const dcRatio = this.getCCPRValue() / (4 * (this.prValue + 1));
-        return Math.round(dcRatio * 100);
-    };
-
-    public getActualPulseWidth = (): number => {
-        let pulseWidth = this.getCCPRValue() * this.prescaler;
-        if (this.fosc > 0) {
-            pulseWidth = pulseWidth / this.fosc;
-        } else {
-            pulseWidth = 0;
-        }
-        return pulseWidth;
-    };
-}

package/src/catalog.json

@@ -1,23 +0,0 @@
-{
-    "name": "@mchp-mcc/local-catalog",
-    "version": "1.0.0",
-    "content": [
-        {
-            "name": "@mchp-mcc/scf-pic8-pwm-v2",
-                "version": "*",
-                "meta": {
-                    "keywords": [
-                        "pic8",
-                        "pwm"
-                    ],
-                    "defaultSelection": "defaultRequired",
-                    "name": "PWM",
-                    "category": "Drivers/PWM",
-                    "description": "This module is a 16-bit Pulse-Width Modulator (PWM) with a compare feature and multiple outputs.",
-                    "deviceFilterRegEx": ".*",
-                    "releaseNotesLink": "https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.8BITPIC.RELEASENOTES&version=latest&redirect=true"
-                }
-        }
-    ],
-    "catalogs": []
-}

package/src/interfaces/pwm_general_parameters.test.tsx

@@ -1,40 +0,0 @@
-import { ProcessedExportInterface, Interface } from "./pwm_general_parameters";
-
-describe("The pwm_general_parameters interface", () => {
-    it("doesn't explode", () => {
-        expect(Interface.getInterfaceId()).toBeDefined();
-        expect(Interface.createPrototypeImport()).toBeDefined();
-        expect(Interface.createPrototypeExport()).toBeDefined();
-        expect(
-            Interface.createFirmwareApi("MyModule", [
-                { name: "mymodule.h", path: "include/" },
-            ]),
-        ).toBeDefined();
-        expect(Interface.createMock()).toBeDefined();
-    });
-
-    it("Checks Interface ID", () => {
-        expect(Interface.getInterfaceId().name).toBe("pwm_general_parameters");
-        expect(Interface.getInterfaceId().version).toBe("0.1.0");
-    });
-
-    it("Create's api with name, headers, or custom API undefined", () => {
-        expect(Interface.createFirmwareApi("", [{ name: "", path: "" }])).toBeDefined();
-    });
-});
-
-export const createMock = (): ProcessedExportInterface => {
-    return {
-        interfaceId: Interface.getInterfaceId(),
-        payload: {
-            interfaceApi: Interface.createFirmwareApi("MyModule", [
-                { name: "mymodule.h", path: "include/" },
-            ]),
-        },
-        args: {
-            requestId: {
-                customName: "MyModule",
-            },
-        },
-    };
-};

package/src/interfaces/pwm_general_parameters.tsx

@@ -1,121 +0,0 @@
-import { InterfaceId } from "@microchip/scf-common/lib/InterfaceId";
-import * as Creator from "@microchip/scf-common/lib/Creator";
-import * as Processor from "@microchip/scf-common/lib/Processor";
-import * as InterfaceTypes from "@microchip/scf-interface";
-
-/** The arguments to be provided to the implementation. */
-export interface Arguments extends InterfaceTypes.Arguments {
-    //Standard Interface
-    customName?: string;
-}
-
-/** The payload to be passed back to the dependent module after the BasicUART has been processed. */
-export interface ProcessedPayload extends InterfaceTypes.ProcessedPayload {
-    //Standard Interface
-    interfaceApi: InterfaceTypes.FirmwareAPIPayload<API>;
-    customName?: string;
-    modulename?: string;
-    isdriverisr?: boolean;
-    ispwmi_enabled?: boolean;
-    ispwmpi_enabled?: boolean;
-    moduleName?: string;
-}
-
-export interface API extends InterfaceTypes.CFunctions {
-    Initialize: InterfaceTypes.CFunction;
-    LoadDutyValue: InterfaceTypes.CFunction;
-}
-
-/** The type of the processed export interface */
-export type ProcessedExportInterface = Processor.ProcessedInterface<
-    ProcessedPayload,
-    Arguments
->;
-
-/** Used by implementations of this interface in their module's creator. */
-type CreatorExportInterface = Creator.Interface<ProcessedPayload>;
-
-const getInterfaceId = (): InterfaceId => {
-    return {
-        name: "pwm_general_parameters",
-        version: "0.1.0",
-    };
-};
-
-const createPrototypeImport = (): Creator.Import => {
-    return {
-        interfaceId: getInterfaceId(),
-    };
-};
-
-const createPrototypeExport = (): Creator.Export<CreatorExportInterface[]> => {
-    return {
-        interfaces: [{ interfaceId: getInterfaceId() }],
-    };
-};
-
-const createMock = (): ProcessedExportInterface => {
-    return {
-        interfaceId: getInterfaceId(),
-        payload: {
-            interfaceApi: Interface.createFirmwareApi("MyModule", [
-                { name: "mymodule.h", path: "include/" },
-            ]),
-        },
-        args: {
-            requestId: {
-                customName: "MyModule",
-            },
-        },
-    };
-};
-
-const createFirmwareApi = (
-    moduleName: string,
-    headerFiles: InterfaceTypes.HeaderFile[],
-): InterfaceTypes.FirmwareAPIPayload<API> => {
-    const prefix: string = moduleName ? moduleName : "undefined";
-    const api = createApi(prefix);
-
-    return {
-        api: api,
-        simpleApi: InterfaceTypes.buildSimpleApi(api),
-        headerFiles: headerFiles,
-    };
-};
-
-const createApi = (prefix: string): API => {
-    return {
-        Initialize: {
-            name: prefix + "_Initialize",
-            returns: "void",
-        },
-        LoadDutyValue: {
-            name: prefix + "_LoadDutyValue",
-            arguments: [
-                {
-                    name: "dutyValue",
-                    type: "uint16_t",
-                },
-            ],
-            returns: "void",
-        },
-    };
-};
-
-interface Interface extends InterfaceTypes.Interface {
-    createPrototypeImport: () => Creator.Import<Arguments>;
-    createMock: () => ProcessedExportInterface;
-    createFirmwareApi: (
-        moduleName: string,
-        headerFiles: InterfaceTypes.HeaderFile[],
-    ) => InterfaceTypes.FirmwareAPIPayload<API>;
-}
-
-export const Interface: Interface = {
-    createPrototypeExport: createPrototypeExport,
-    createPrototypeImport: createPrototypeImport,
-    getInterfaceId: getInterfaceId,
-    createMock: createMock,
-    createFirmwareApi: createFirmwareApi,
-};