@mchp-mcc/scf-pic8-pwm-v2 4.2.5 → 4.2.7

package/output/pwm-v2.c.ftl

@@ -5,9 +5,9 @@
   *
   * @ingroup ${moduleNameLowerCase}
   *
-  * @brief This file contains the driver code for ${moduleNameUpperCase} module.
+  * @brief This file contains the API implementations for the ${moduleNameUpperCase} module.
   *
-  * @version ${moduleNameUpperCase} Driver Version 2.0.2
+  * @version ${moduleNameUpperCase} Driver Version 2.0.3
 */
 
  ${disclaimer}
@@ -28,7 +28,15 @@
     // Set the PWM to the options selected in the ${productName}.
     <#list initRegisters as reg>
     // ${reg.comment}
-    ${reg.name} = ${reg.valueAsHex};   
+    <#if reg.name == "CCPTMRS1">
+    ${CCPTMRS1.settings.CTSEL.bitName} = ${CCPTMRS1.settings.CTSEL.valueAsHex};
+    <#elseif reg.name == "CCPTMRS">
+    ${CCPTMRS.settings.CTSEL.bitName} = ${CCPTMRS.settings.CTSEL.valueAsHex};
+    <#elseif reg.name == "PWMTMRS0">  
+    ${PWMTMRS.settings.CTSEL.bitName} = ${PWMTMRS.settings.CTSEL.valueAsHex};
+    <#else>
+    ${reg.name} = ${reg.valueAsHex};
+    </#if> 
 
     </#list>
     <#if timerselpresence == "timerselpresent">
@@ -56,8 +64,8 @@
  void ${api.LoadDutyValue.name}(uint16_t dutyValue)
  {
      // Writing to 8 MSBs of PWM duty cycle in PWMDCH register
-     ${PWMDCH} = (uint8_t) ((dutyValue & 0x03FCu) >> 2);
+     ${PWMDCH.name} = (uint8_t) ((dutyValue & 0x03FCu) >> 2);
      
      // Writing to 2 LSBs of PWM duty cycle in PWMDCL register
-     ${PWMDCL} = (uint8_t) ((dutyValue & 0x0003u) << 6);
+     ${PWMDCL.name} = (uint8_t) ((dutyValue & 0x0003u) << 6);
  }

package/output/pwm-v2.h.ftl

@@ -5,9 +5,9 @@
  *
  * @defgroup ${moduleNameLowerCase} ${moduleNameUpperCase}
  *
- * @brief This header file provides APIs for the ${moduleNameUpperCase} driver.
+ * @brief This file contains the API prototypes for the ${moduleNameUpperCase} driver.
  *
- * @version ${moduleNameUpperCase} Driver Version 2.0.2
+ * @version ${moduleNameUpperCase} Driver Version 2.0.3
 */
 
 ${disclaimer}
@@ -31,17 +31,17 @@ ${disclaimer}
 
 /**
  * @ingroup ${moduleNameLowerCase}
- * @brief This routine initializes the ${moduleNameUpperCase} interface.
- * @param none
- * @return none
+ * @brief Initializes the ${moduleNameUpperCase} interface.
+ * @param None.
+ * @return None.
  */
  ${simpleApi.Initialize};
 
  /**
  * @ingroup ${moduleNameLowerCase}
- * @brief This routine loads the 16 bit duty cycle value.
- * @param ${api.LoadDutyValue.arguments[0].type} ${api.LoadDutyValue.arguments[0].name} - load ${moduleNameUpperCase} duty cycle value.
- * @return none
+ * @brief Loads the 16-bit duty cycle value.
+ * @param ${api.LoadDutyValue.arguments[0].type} ${api.LoadDutyValue.arguments[0].name} - ${moduleNameUpperCase} duty cycle value to be loaded.
+ * @return None.
  */
  ${simpleApi.LoadDutyValue};
  

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mchp-mcc/scf-pic8-pwm-v2",
-    "version": "4.2.5",
+    "version": "4.2.7",
     "scf": {
         "reducer": "auto",
         "creator": "output/creator.js",
@@ -105,8 +105,8 @@
         "profile": "jest profile",
         "build-run-dir-future": "node config/extract-run-directory-future.js",
         "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",
-        "test:itf:dev": "node ./node_modules/@mchp-mcc/ccl-itf/lib/index.js --sp=./tests/itf --rd=./run --sf=pwmV2.major.test.ts --df=\"PIC16F18076\"",
+        "test:itf:all": "node ./node_modules/@microchip/ccl-itf/lib/index.js --sp=./tests/itf --rd=./run --sf=pwmV2.major.test.ts  --df=\"PIC16F18076|PIC16F18877|PIC18F47Q10\"",
+        "test:itf:dev": "node ./node_modules/@microchip/ccl-itf/lib/index.js --sp=./tests/itf --rd=./run --sf=pwmV2.major.test.ts --df=\"PIC16F18076\"",
         "postprocess": "node config/appendPrototype.js"
     },
     "husky": {
@@ -169,13 +169,13 @@
         "@babel/preset-env": "^7.9.6",
         "@babel/preset-react": "^7.9.4",
         "@babel/preset-typescript": "^7.9.0",
-        "@mchp-mcc/ccl-itf": "^0.2.16",
         "@mchp-mcc/pic-8bit": "^5.9.0-dev.5",
         "@mchp-mcc/pic-8bit-types": "^5.9.0-dev.5",
+        "@microchip/ccl-itf": "^1.5.0",
         "@microchip/initializer-system": "^0.5.3",
         "@microchip/melody-automodule-interface": "^1.5.1",
         "@microchip/pic-8bit-types": "^5.0.1",
-        "@microchip/run-directory": "^3.3.0",
+        "@microchip/run-directory": "^4.2.3",
         "@microchip/scf-automodule": "^5.5.1",
         "@microchip/scf-automodule-impl": "^1.7.1",
         "@microchip/scf-autoview": "^3.26.1",
@@ -230,4 +230,4 @@
     "description": "- Download & Install [nodejs](https://nodejs.org/en/download/)\r - Download & Install npm\r - Setup node & npm in enviroment path",
     "main": "lib/generated_module/src/index.js",
     "author": ""
-}
+}

package/src/DerivedData.test.ts

@@ -41,6 +41,17 @@ describe("Empty Derived Data Test ", () => {
     });
 });
 
+describe("C custom name validator", () => {
+    it("invalid Custom name", () => {
+        const mockModule = mockAssignedModule(mockState());
+        const model = getModel(mockModule, getDerivedData);
+        const derivedData = model?.getDerivedData() as DerivedData;
+        const derivedFunctions = derivedData?.getMyFunctions();
+        const cName = new RegExp(derivedFunctions.componentNameValidator().pattern);
+        expect(cName.test("custom-Name")).toBe(false);
+    });
+});
+
 describe("Import Interface test Cases ", () => {
     const mockMod = mockAssignedModule(mockState());
     const model = getModel(mockMod, MyDerivedData.getDerivedData);
@@ -288,8 +299,8 @@ describe("DerivedData for APIs: Timer selection -- >", () => {
             expect(derivedFunctions?.ctselPwmtmrs?.()).toEqual("PWM4timer2");
         });
     });
-    describe("Invalid Timer 7 -->", () => {
-        const mockModule = mockAssignedModule(getMockState(true, "TMR7", "TMR7"));
+    describe("Invalid Timer -->", () => {
+        const mockModule = mockAssignedModule(getMockState(true, "TMR", "TMR"));
         const model = getModel(mockModule, MyDerivedData.getDerivedData);
         const derivedData = model?.getDerivedData() as DerivedData;
         const derivedFunctions = derivedData?.getMyFunctions();

package/src/DerivedData.ts

@@ -13,6 +13,7 @@ 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";
 
 export const getDerivedData = (dataModel: AppModel): DerivedData => {
     if (dataModel) {
@@ -35,6 +36,7 @@ class EmptyDerivedData implements DerivedData {
 class MyDerivedData implements DerivedData {
     private dataModel: AppModel;
     private pwmCalculator: PwmCalculator;
+    private cValidator: PatternValidator = getCFunctionValidator();
 
     constructor(dataModel: AppModel) {
         this.dataModel = dataModel;
@@ -72,6 +74,7 @@ class MyDerivedData implements DerivedData {
             pwmResolution: (): number => this.getPwmCalculator().getPwmResolution(),
 
             ctselCcptmrs1: this.ctselTimerSetting,
+            ctselCcptmrs: this.ctselTimerSetting,
             ctselPwmtmrs: this.ctselTimerSetting,
             pwmdchPwmdch: (): number =>
                 Number(this.dataModel.getComponentValue("pwmdcValue")) >> 2,
@@ -83,6 +86,8 @@ class MyDerivedData implements DerivedData {
             filterImports: this.filterImports,
             getPinsLogic: getPinsLogic,
             importName: this.friendlyImportName,
+            componentNameValidator: this.componentNameValidator,
+            getCustomUiErrors: this.getCustomUiErrors,
         };
     };
 
@@ -103,12 +108,33 @@ class MyDerivedData implements DerivedData {
         }
     };
 
+    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 overrideDefaultOptions = (componentName: string): any[] => {
         switch (componentName) {
             case "timerSelection": {
                 const result: any[] = [];
-                const CCPTMRSREG = this.dataModel.getPeripheralDescription()?.registers
-                    ?.CCPTMRS1;
+                const CCPTMRSREG =
+                    this.dataModel.getPeripheralDescription()?.registers?.CCPTMRS1 ??
+                    this.dataModel.getPeripheralDescription()?.registers?.CCPTMRS;
                 const PWMTMRSREG = this.dataModel.getPeripheralDescription()?.registers
                     ?.PWMTMRS;
                 if (CCPTMRSREG) {
@@ -276,15 +302,14 @@ class MyDerivedData implements DerivedData {
     };
 
     private ctselTimerSetting = (): string | undefined => {
-        switch (this.dataModel.getComponentValue("timerSelection")) {
-            case "TMR2":
-                return this.dataModel.getHardware()?.getName() + "timer2";
-            case "TMR4":
-                return this.dataModel.getHardware()?.getName() + "timer4";
-            case "TMR6":
-                return this.dataModel.getHardware()?.getName() + "timer6";
-            default:
-                return 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;
         }
     };
 

package/src/GeneratorModel.tsx

@@ -41,8 +41,8 @@ export const getGeneratorModel = (model: AppModel): any => {
 
         //Registers and Settings
         initRegisters: initRegisters,
-        PWMDCH: templateSettings?.registers?.PWMDCH.name ?? "",
-        PWMDCL: templateSettings?.registers?.PWMDCL?.name ?? "",
+        // PWMDCH: templateSettings?.registers?.PWMDCH.name ?? "",
+        // PWMDCL: templateSettings?.registers?.PWMDCL?.name ?? "",
         CCPTMRSregname: templateSettings?.registers?.CCPTMRS1?.name ?? "",
         CTSELsettingname:
             templateSettings?.registers?.CCPTMRS1?.settings?.CTSEL.name ?? "",
@@ -51,6 +51,7 @@ export const getGeneratorModel = (model: AppModel): any => {
             (ctsel?.options?.length ?? 0) > 0 ? "timerselpresent" : "timerselabsent",
 
         pwmdcValue: model.getComponentValue("pwmdcValue"),
+        ...registerValues,
     };
 };
 

package/src/catalog.json

@@ -14,7 +14,7 @@
                     "name": "PWM",
                     "category": "Drivers/PWM",
                     "description": "This module is a 16-bit Pulse-Width Modulator (PWM) with a compare feature and multiple outputs.",
-                    "deviceFilterRegEx": "^PIC18F.*Q10$|^PIC16[L]{0,1}F188.*$|^PIC16F152.*$|^PIC16F180[57][45]$",
+                    "deviceFilterRegEx": "^PIC18F.*Q10$|^PIC16[L]{0,1}F188.*$|^PIC16F152.*$|^PIC16F180[57][45]$|^PIC18F.*K40$",
                     "releaseNotesLink": "https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.8BITPIC.RELEASENOTES&version=latest&redirect=true"
                 }
         }

package/src/moduleConfig.json

@@ -136,7 +136,8 @@
             "tabs": [
                 "main"
             ],
-            "category": "software"
+            "category": "software",
+            "validation": true
         },
         "tmr2Dependency": {
             "name": "tmr2Dependency",