@mchp-mcc/clock-16bit-driver 1.1.0 → 1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mchp-mcc/clock-16bit-driver",
-    "version": "1.1.0",
+    "version": "1.1.1",
     "scf": {
         "reducer": "output/reducer.js",
         "creator": "output/creator.js",
@@ -81,7 +81,7 @@
         "@mchp-mcc/pic-8bit-types": "^5.4.1",
         "@microchip/api-prefix-registration": "^0.1.0",
         "@microchip/canfd-clock-interface": "^1.0.0",
-        "@microchip/clock-16bit-config-interface": "^1.1.2",
+        "@microchip/clock-16bit-config-interface": "^1.1.5",
         "@microchip/clock-16bit-interface": "^1.1.0",
         "@microchip/fosc-hz": "^0.1.2",
         "@microchip/pin-standard": "^0.4.1",
@@ -175,4 +175,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.ts

@@ -20,9 +20,13 @@ const CLOCK_16BIT_CONFIG_INTERFACE = "clock_16bit_config_interface";
 const DIGITS_AFTER_DECIMAL_POINT = 2;
 const COMPONENT_AUX_CLOCK_SOURCE = "auxClockSource";
 const COMPONENT_MAIN_CLOCK_SOURCE = "mainClockSource";
+const COMPONENT_CAN_FD_CLOCK_SOURCE_FREQ = "canfdClkSrcFreq";
 export const COMPONENT_AUX_CLOCK_INPUT_FREQUENCY = "auxClockInputFrequency_Hz";
 export const COMPONENT_MAIN_CLOCK_INPUT_FREQUENCY = "mainClockInputFrequency_Hz";
 const COMPONENT_REF_CLOCK_SOURCE = "refClockSource";
+const COMPONENT_REF_CLOCK_ENABLE = "refClockEnable";
+export const COMPONENT_CALCULATED_REF_OUTPUT_FREQUENCY =
+    "calculatedRefOutputFrequency_Hz";
 const COMPONENT_CANFD_CLOCK_SOURCE = "canfdClockSource";
 export const COMPONENT_REQUESTED_SYSTEM_FREQUENCY = "requestedSystemFrequency_Hz";
 const COMPONENT_FVCO_DIVIDER = "fvcoDivider";
@@ -102,6 +106,7 @@ class MyDerivedData implements DerivedData {
             requestedCanfdClockOutputFrequency_Hz: this
                 .getRequestedCanfdClockOutputFrequency_Hz,
             getUiBehavior: this.getUiBehavior,
+            isEnabled: this.isComponentEnabled,
             mainClockInputFrequency_HzValidator: this.mainClockInputFrequency_HzValidator,
             auxClockInputFrequency_HzValidator: this.auxClockInputFrequency_HzValidator,
             requestedAuxClockOutputFrequency_HzValidator: this
@@ -118,6 +123,38 @@ class MyDerivedData implements DerivedData {
         };
     };
 
+    private isComponentEnabled = (componentName: string): boolean => {
+        let isComponentEnabled = false;
+        if (
+            componentName === COMPONENT_REF_CLOCK_SOURCE ||
+            componentName === COMPONENT_REQUESTED_REF_CLOCK_OUTPUT_FREQUENCY
+        ) {
+            if (this.dataModel?.getComponentValue(COMPONENT_REF_CLOCK_ENABLE) === true) {
+                isComponentEnabled = true;
+            }
+        } else if (
+            componentName === COMPONENT_REF_CLOCK_ENABLE ||
+            componentName === COMPONENT_MAIN_CLOCK_SOURCE ||
+            componentName === COMPONENT_MAIN_CLOCK_INPUT_FREQUENCY ||
+            componentName === COMPONENT_SET_MAX_FREQUENCY ||
+            componentName === COMPONENT_FVCO_DIVIDER ||
+            componentName === COMPONENT_AUX_CLOCK_SOURCE ||
+            componentName === COMPONENT_CANFD_CLOCK_SOURCE ||
+            componentName === COMPONENT_AFVCO_DIVIDER ||
+            componentName === COMPONENT_AUX_CLOCK_INPUT_FREQUENCY ||
+            componentName === COMPONENT_REQUESTED_AUX_CLOCK_OUTPUT_FREQUENCY
+        ) {
+            isComponentEnabled = true;
+        } else if (componentName === COMPONENT_REQUESTED_SYSTEM_FREQUENCY) {
+            if (
+                this.dataModel?.getComponentValue(COMPONENT_SET_MAX_FREQUENCY) === false
+            ) {
+                isComponentEnabled = true;
+            }
+        }
+        return isComponentEnabled;
+    };
+
     private getCustomUiErrors = (componentName: string): Error[] | undefined => {
         let customErrors: Error[];
         switch (componentName) {
@@ -207,6 +244,17 @@ class MyDerivedData implements DerivedData {
         return minClockFrequency;
     };
 
+    private getClockPropertiesFromPayLoad = (): any => {
+        let clockProperties: unknown;
+        const interfaceData: clock_16bit_config_interface.ProcessedPayload = this.dataModel.getImportValue(
+            CLOCK_16BIT_CONFIG_INTERFACE,
+        );
+        if (interfaceData != undefined) {
+            clockProperties = interfaceData?.clockProperties;
+        }
+        return clockProperties;
+    };
+
     private getMaxClockFrequency = (): number => {
         let maxClockFrequency = 0;
         const interfaceData: clock_16bit_config_interface.ProcessedPayload = this.dataModel.getImportValue(
@@ -224,10 +272,24 @@ class MyDerivedData implements DerivedData {
         const interfaceData: clock_16bit_config_interface.ProcessedPayload = this.dataModel.getImportValue(
             CLOCK_16BIT_CONFIG_INTERFACE,
         );
-        if (interfaceData != undefined) {
+        if (
+            interfaceData != undefined &&
+            this.dataModel?.getComponentValue("mainClockSource") !=
+                "FRC Oscillator with Postscaler"
+        ) {
             maxSystemClockFrequency =
                 interfaceData?.mainClockPayload?.maxSystemClockFrequency ?? 0;
         }
+        if (
+            this.dataModel?.getComponentValue("mainClockSource") ==
+            "FRC Oscillator with Postscaler"
+        ) {
+            if (this.getClockPropertiesFromPayLoad()["FRC_CLOCK"] != undefined) {
+                maxSystemClockFrequency = Number(
+                    this.getClockPropertiesFromPayLoad()["FRC_CLOCK"]?.value,
+                );
+            }
+        }
         return maxSystemClockFrequency;
     };
 
@@ -240,7 +302,7 @@ class MyDerivedData implements DerivedData {
                         "Requested FCAN frequency can be configured from CAN 2.0/CAN-FD modules in Drivers category",
                 };
                 break;
-            case "canfdClkSrcFreq":
+            case COMPONENT_CAN_FD_CLOCK_SOURCE_FREQ:
                 uiBehavior = {
                     ["ui:help"]:
                         "CAN FD clock source frequency should be less than or equal to 640 MHz",
@@ -296,17 +358,15 @@ class MyDerivedData implements DerivedData {
 
     private isMainClockInputFrequencyVisible = (): boolean => {
         let visible = false;
-        if (!this.dataModel.getComponentValue(COMPONENT_SET_MAX_FREQUENCY)) {
-            const mainClockSource = this.dataModel.getComponentValue(
-                COMPONENT_MAIN_CLOCK_SOURCE,
-            );
-            if (mainClockSource != undefined) {
-                if (
-                    mainClockSource?.indexOf(PRIMARY) >= 0 ||
-                    mainClockSource?.indexOf(EXTERNAL) >= 0
-                ) {
-                    visible = true;
-                }
+        const mainClockSource = this.dataModel.getComponentValue(
+            COMPONENT_MAIN_CLOCK_SOURCE,
+        );
+        if (mainClockSource != undefined) {
+            if (
+                mainClockSource?.indexOf(PRIMARY) >= 0 ||
+                mainClockSource?.indexOf(EXTERNAL) >= 0
+            ) {
+                visible = true;
             }
         }
         return visible;
@@ -314,7 +374,7 @@ class MyDerivedData implements DerivedData {
 
     private isRequestedSystemFrequencyVisible = (): boolean => {
         let visible = false;
-        if (!this.dataModel.getComponentValue(COMPONENT_SET_MAX_FREQUENCY)) {
+        if (this.dataModel?.getComponentValue(COMPONENT_SET_MAX_FREQUENCY) === false) {
             const mainClockSource = this.dataModel.getComponentValue(
                 COMPONENT_MAIN_CLOCK_SOURCE,
             );
@@ -390,20 +450,17 @@ class MyDerivedData implements DerivedData {
         } else if (
             componentName === COMPONENT_REF_CLOCK_SOURCE ||
             componentName === COMPONENT_REQUESTED_REF_CLOCK_OUTPUT_FREQUENCY ||
-            componentName === "calculatedRefOutputFrequency_Hz"
+            componentName === COMPONENT_CALCULATED_REF_OUTPUT_FREQUENCY ||
+            componentName === COMPONENT_REF_CLOCK_ENABLE
         ) {
             return this.isRefClockSupported();
         } else if (
             componentName === COMPONENT_CANFD_CLOCK_SOURCE ||
             componentName === COMPONENT_REQUESTED_CANFD_CLOCK_OUTPUT_FREQUENCY ||
             componentName === "calculatedCanfdOutputFrequency_Hz" ||
-            componentName === "canfdClkSrcFreq"
+            componentName === COMPONENT_CAN_FD_CLOCK_SOURCE_FREQ
         ) {
             return this.isCanfdClockSupported();
-        } else if (componentName === COMPONENT_MAIN_CLOCK_SOURCE) {
-            if (this.dataModel.getComponentValue(COMPONENT_SET_MAX_FREQUENCY)) {
-                return false;
-            }
         }
         return true;
     };
@@ -472,6 +529,17 @@ class MyDerivedData implements DerivedData {
                 });
             }
         }
+        if (this.dataModel?.getComponentValue(COMPONENT_SET_MAX_FREQUENCY)) {
+            const mainClockSource = this.dataModel?.getComponentValue(
+                COMPONENT_MAIN_CLOCK_SOURCE,
+            );
+            if (mainClockSource != undefined && mainClockSource?.indexOf(PLL) < 0) {
+                alerts.push({
+                    type: Processor.AlertTypes.Warning,
+                    text: "Please select PLL as clock source.",
+                });
+            }
+        }
 
         return alerts;
     };
@@ -940,27 +1008,38 @@ class MyDerivedData implements DerivedData {
     };
 
     private auxClockArg = (): any => {
-        return {
-            auxClockSource: this.dataModel.getComponentValue(COMPONENT_AUX_CLOCK_SOURCE),
-            auxClockInputFrequency_Hz: this.dataModel.getComponentValue(
-                COMPONENT_AUX_CLOCK_INPUT_FREQUENCY,
-            ),
-            requestedAuxClockOutputFrequency_Hz: this.dataModel.getComponentValue(
-                COMPONENT_REQUESTED_AUX_CLOCK_OUTPUT_FREQUENCY,
-            ),
-            afvcoDivider: Number(
-                this.dataModel.getComponentValue(COMPONENT_AFVCO_DIVIDER),
-            ),
-        };
+        if (
+            this.dataModel.getComponentValue(COMPONENT_AUX_CLOCK_SOURCE) !=
+            "FRC Oscillator"
+        ) {
+            return {
+                auxClockSource: this.dataModel.getComponentValue(
+                    COMPONENT_AUX_CLOCK_SOURCE,
+                ),
+                auxClockInputFrequency_Hz: this.dataModel.getComponentValue(
+                    COMPONENT_AUX_CLOCK_INPUT_FREQUENCY,
+                ),
+                requestedAuxClockOutputFrequency_Hz: this.dataModel.getComponentValue(
+                    COMPONENT_REQUESTED_AUX_CLOCK_OUTPUT_FREQUENCY,
+                ),
+                afvcoDivider: Number(
+                    this.dataModel.getComponentValue(COMPONENT_AFVCO_DIVIDER),
+                ),
+            };
+        }
     };
 
     private refClockArg = (): any => {
-        return {
-            refClockSource: this.dataModel.getComponentValue(COMPONENT_REF_CLOCK_SOURCE),
-            requestedRefClockOutputFrequency_Hz: this.dataModel.getComponentValue(
-                COMPONENT_REQUESTED_REF_CLOCK_OUTPUT_FREQUENCY,
-            ),
-        };
+        if (this.dataModel.getComponentValue(COMPONENT_REF_CLOCK_ENABLE) === true) {
+            return {
+                refClockSource: this.dataModel.getComponentValue(
+                    COMPONENT_REF_CLOCK_SOURCE,
+                ),
+                requestedRefClockOutputFrequency_Hz: this.dataModel.getComponentValue(
+                    COMPONENT_REQUESTED_REF_CLOCK_OUTPUT_FREQUENCY,
+                ),
+            };
+        }
     };
 
     private canfdClockArg = (): any => {

package/src/catalog.json

@@ -10,6 +10,8 @@
                     "avr",
                     "pic8",
                     "driver",
+                    "pic24",
+                    "dspic",
                     ""
                 ],
                 "name": "Clock",

package/src/moduleConfig.json

@@ -6,7 +6,7 @@
         "false": "disabled"
     },
     "help": {
-        "url": "v2/keyword-lookup?keyword=SYSTEM_16BIT_MELODY_DRIVER&version=latest&redirect=true",
+        "url": "v2/keyword-lookup?keyword=CLOCK_16BIT_MELODY_DRIVER&version=latest&redirect=true",
         "tooltip": "Click here to open documentation"
     },
     "UIGroups": {
@@ -41,7 +41,7 @@
             "import": {
                 "interfaceId": {
                     "name": "clock-16bit-config-interface",
-                    "version": "^1.1.2"
+                    "version": "^1.1.5"
                 },
                 "isRequired": true
             }
@@ -335,6 +335,17 @@
                 "readonly": true
             }
         },
+        "refClockEnable": {
+            "name": "refClockEnable",
+            "description": "Reference Clock Enable",
+            "type": "boolean",
+            "defaultValue": false,
+            "group": "refClock",
+            "tabs": [
+                "main"
+            ],
+            "category": "software"
+        },
         "refClockSource": {
             "name": "refClockSource",
             "description": "REFO Clock Source",