@mchp-mcc/scf-pic8-opamp-v2 1.0.0

package/output/header-template.h.ftl

@@ -0,0 +1,353 @@
+/**
+ * ${moduleNameUpperCase} Generated Driver API Header File
+ * 
+ * @file ${moduleNameLowerCase}.h
+ * 
+ * @defgroup  ${moduleNameLowerCase} ${moduleNameUpperCase}
+ * 
+ * @brief This is the generated header file for the ${moduleNameUpperCase} driver.
+ *
+ * @version ${moduleNameUpperCase} Driver Version 1.0.0
+*/
+${disclaimer}
+
+#ifndef ${moduleNameUpperCase}_H
+#define ${moduleNameUpperCase}_H
+
+/**
+  Section: Included Files
+*/
+#include <stdint.h>
+#include <stdbool.h>
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_Initialize API
+ */
+#define ${componentName}_Initialize ${moduleNameUpperCase}_Initialize
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_EnableChargePump API
+ */
+#define ${componentName}_EnableChargePump ${moduleNameUpperCase}_EnableChargePump
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_DisableChargePump API
+ */
+#define ${componentName}_DisableChargePump ${moduleNameUpperCase}_DisableChargePump
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_EnableSoftwareUnityGain API
+ */
+#define ${componentName}_EnableSoftwareUnityGain ${moduleNameUpperCase}_EnableSoftwareUnityGain
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_DisableSoftwareUnityGain API
+ */
+#define ${componentName}_DisableSoftwareUnityGain ${moduleNameUpperCase}_DisableSoftwareUnityGain
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_SetPositiveChannel API
+ */
+#define ${componentName}_SetPositiveChannel ${moduleNameUpperCase}_SetPositiveChannel
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_SetPositiveSource API
+ */
+#define ${componentName}_SetPositiveSource ${moduleNameUpperCase}_SetPositiveSource
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_SetNegativeChannel API
+ */
+#define ${componentName}_SetNegativeChannel ${moduleNameUpperCase}_SetNegativeChannel
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_SetNegativeSource API
+ */
+#define ${componentName}_SetNegativeSource ${moduleNameUpperCase}_SetNegativeSource
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_SetResistorLadder API
+ */
+#define ${componentName}_SetResistorLadder ${moduleNameUpperCase}_SetResistorLadder
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_EnableHardwareOverride API
+ */
+#define ${componentName}_EnableHardwareOverride ${moduleNameUpperCase}_EnableHardwareOverride
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_SetHardwareOverrideSource API
+ */
+#define ${componentName}_SetHardwareOverrideSource ${moduleNameUpperCase}_SetHardwareOverrideSource
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_DisableHardwareOverride API
+ */
+#define ${componentName}_DisableHardwareOverride ${moduleNameUpperCase}_DisableHardwareOverride
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_ManualInputOffsetCalibration API
+ */
+#define ${componentName}_ManualInputOffsetCalibration ${moduleNameUpperCase}_ManualInputOffsetCalibration
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_StartAutomaticOffsetCalibration API
+ */
+#define ${componentName}_StartAutomaticOffsetCalibration ${moduleNameUpperCase}_StartAutomaticOffsetCalibration
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_isAutomaticOffsetCalibrationDone API
+ */
+#define ${componentName}_isAutomaticOffsetCalibrationDone ${moduleNameUpperCase}_isAutomaticOffsetCalibrationDone
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_StartPeakTroughReset API
+ */
+#define ${componentName}_StartPeakTroughReset ${moduleNameUpperCase}_StartPeakTroughReset
+
+/**
+ * @ingroup  ${moduleNameLowerCase}
+ * @brief    This macro defines the Custom Name for \ref ${moduleNameUpperCase}_StopPeakTroughReset API
+ */
+#define ${componentName}_StopPeakTroughReset ${moduleNameUpperCase}_StopPeakTroughReset
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @enum ${moduleNameUpperCase}_resistor_select
+ * @brief Enumeration of R2/R1 resistor ratio
+*/
+typedef enum
+{
+    ${moduleNameUpperCase}_R2byR1_is_0dp07,    /**<R2/R1 = 0.07*/
+    ${moduleNameUpperCase}_R2byR1_is_0dp14,    /**<R2/R1 = 0.14*/
+    ${moduleNameUpperCase}_R2byR1_is_0dp33,    /**<R2/R1 = 0.33*/
+    ${moduleNameUpperCase}_R2byR1_is_1,        /**<R2/R1 = 1*/
+    ${moduleNameUpperCase}_R2byR1_is_1dp67,    /**<R2/R1 = 1.67*/
+    ${moduleNameUpperCase}_R2byR1_is_3,        /**<R2/R1 = 3*/
+    ${moduleNameUpperCase}_R2byR1_is_7,        /**<R2/R1 = 7*/
+    ${moduleNameUpperCase}_R2byR1_is_15        /**<R2/R1 = 15*/
+} ${moduleNameUpperCase}_resistor_select;
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @enum ${moduleNameUpperCase}_posChannel_select
+ * @brief Enumeration of available Positive Channels
+*/
+typedef enum
+{
+    ${moduleNameUpperCase}_posChannel_Vss = 0x0,
+    ${moduleNameUpperCase}_posChannel_GSEL = 0x1,
+    ${moduleNameUpperCase}_posChannel_${moduleInstance}IN = 0x2,
+    ${moduleNameUpperCase}_posChannel_Vdd_by_2 = 0x3,
+    ${moduleNameUpperCase}_posChannel_DAC1 = 0x4,
+    ${moduleNameUpperCase}_posChannel_DAC2 = 0x5,
+    ${moduleNameUpperCase}_posChannel_DAC3 = 0x6
+} ${moduleNameUpperCase}_posChannel_select;
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @enum ${moduleNameUpperCase}_posSource_select
+ * @brief Enumeration of available Positive Sources
+*/
+typedef enum
+{
+    <#list posSources as source>
+    ${moduleNameUpperCase}_${source.name} = ${source.value}<#if source_has_next>,</#if>
+    </#list>
+} ${moduleNameUpperCase}_posSource_select;
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @enum ${moduleNameUpperCase}_negChannel_select
+ * @brief Enumeration of available Negative Channels
+*/
+typedef enum
+{
+    ${moduleNameUpperCase}_negChannel_No_Connection = 0x0,
+    ${moduleNameUpperCase}_negChannel_GSEL = 0x1,
+    ${moduleNameUpperCase}_negChannel_${moduleInstance}IN = 0x2,
+    ${moduleNameUpperCase}_negChannel_DAC1 = 0x4,
+    ${moduleNameUpperCase}_negChannel_DAC2 = 0x5,
+    ${moduleNameUpperCase}_negChannel_DAC3 = 0x6
+} ${moduleNameUpperCase}_negChannel_select;
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @enum ${moduleNameUpperCase}_negSource_select
+ * @brief Enumeration of available Negative Sources
+*/
+typedef enum
+{
+    <#list negSources as source>
+    ${moduleNameUpperCase}_${source.name} = ${source.value}<#if source_has_next>,</#if>   
+    </#list>
+} ${moduleNameUpperCase}_negSource_select;
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief This routine initializes the ${moduleNameUpperCase} and must be called before any other ${moduleNameUpperCase} routine is called.
+ * This routine should only be called once during system initialization.
+ * @param None
+ * @return None
+*/
+void ${moduleNameUpperCase}_Initialize(void);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Enables the ${moduleNameUpperCase} Charge Pump
+ * @pre ${moduleNameLowerCase} should be initialized with ${moduleNameUpperCase}_Initialize() before calling this API.
+ * @param None
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_EnableChargePump(void);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Disables the ${moduleNameUpperCase} Charge Pump
+ * @param None
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_DisableChargePump(void);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Enables ${moduleNameUpperCase} to operate with unity gain
+ * @param None
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_EnableSoftwareUnityGain(void);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Disables unity gain in ${moduleNameUpperCase} 
+ * @param None
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_DisableSoftwareUnityGain(void);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Sets the positive channel as per user selection
+ * @param Desired positive channel. For available positive channels refer ${moduleNameUpperCase}_posChannel_select enum from ${moduleNameLowerCase}.h file
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_SetPositiveChannel(${moduleNameUpperCase}_posChannel_select posChannel);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Sets the positive source as per user selection
+ * @param Desired positive source. For available positive sources refer ${moduleNameUpperCase}_posSource_select enum from ${moduleNameLowerCase}.h file
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_SetPositiveSource(${moduleNameUpperCase}_posSource_select posSource);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Sets the negative channel as per user selection
+ * @param Desired negative channel. For available negative channels refer ${moduleNameUpperCase}_negChannel_select enum from ${moduleNameLowerCase}.h file
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_SetNegativeChannel(${moduleNameUpperCase}_negChannel_select negChannel);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Sets the negative source as per user selection
+ * @param Desired negative source. For available negative sources refer ${moduleNameUpperCase}_negSource_select enum from ${moduleNameLowerCase}.h file
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_SetNegativeSource(${moduleNameUpperCase}_negSource_select negSource);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Sets the R1 and R2 values of internal resistor ladder as per user selection
+ * @param Desired resistor selection. For available resistor values refer ${moduleNameUpperCase}_resistor_sel enum from ${moduleNameLowerCase}.h file
+ * @return None
+*/
+void ${moduleNameUpperCase}_SetResistorLadder(${moduleNameUpperCase}_resistor_select resistorSelection);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Enables hardware override by setting the override enable bit
+ * @param None
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_EnableHardwareOverride(void);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Selects the Hardware Override Source and polarity
+ * @pre The ${moduleNameUpperCase}_EnableHardwareOverride() routine must be called before this routine
+ * @param Desired hardware override source and source polarity
+ * @return None
+*/
+void ${moduleNameUpperCase}_SetHardwareOverrideSource(uint8_t overrideSource, uint8_t polarity);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Disables the hardware override by clearing the override enable bit
+ * @param None
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_DisableHardwareOverride(void);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Sets the input offset calibration
+ * @param Desired input offset based on calibration
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_ManualInputOffsetCalibration(uint8_t offset);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Starts the automatic input offset calibration
+ * @param None
+ * @return None
+*/
+void ${moduleNameUpperCase}_StartAutomaticOffsetCalibration(void);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Checks if the automatic input offset calibration has been completed
+ * @pre The ${moduleNameUpperCase}_StartAutomaticOffsetCalibration() routine must be called before this routine
+ * @param None
+ * @return true or false
+*/
+inline bool ${moduleNameUpperCase}_isAutomaticOffsetCalibrationDone(void);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Initiate peak or trough reset
+ * @pre The hardware control configuration registers must be set appropriately
+ * @param None
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_StartPeakTroughReset(void);
+
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Stop peak or trough reset
+ * @pre The hardware control configuration registers must be set appropriately
+ * @param None
+ * @return None
+*/
+inline void ${moduleNameUpperCase}_StopPeakTroughReset(void);
+
+#endif //${moduleNameUpperCase}_H

package/output/nullPrototype.json

@@ -0,0 +1,43 @@
+{
+    "payload": null,
+    "imports": {
+        "scf_pic8_opamp_v2": {
+            "interfaceId": {
+                "name": "scf-pic8-opamp-v2",
+                "version": "1.0.0"
+            },
+            "isRequired": true
+        },
+        "initializer_system": {
+            "interfaceId": {
+                "name": "initializer-system",
+                "version": "^0"
+            }
+        },
+        "pin_standard": {
+            "interfaceId": {
+                "name": "pin-standard",
+                "version": "^0"
+            }
+        },
+        "device_meta": {
+            "interfaceId": {
+                "name": "device-meta",
+                "version": "^1.0.0"
+            }
+        }
+    },
+    "exports": {
+        "opa": {
+            "interfaces": [
+                {
+                    "interfaceId": {
+                        "name": "opa-output-parameters",
+                        "version": "1.0.0"
+                    }
+                }
+            ]
+        }
+    },
+    "isEntryPoint": true
+}