@mchp-mcc/scf-pic8-clc-v1 4.0.11 → 4.0.13

package/output/cla_clc_stacked_v5.c.ftl

@@ -1,40 +1,27 @@
- /**
-   ${moduleNameUpperCase} Generated Driver File
- 
-   @Company
-     Microchip Technology Inc.
- 
-   @File Name
-     ${moduleNameLowerCase}.c
- 
-   @Summary
-     This is the generated driver implementation file for the ${moduleNameUpperCase} driver.
- 
-   @Description
-     This source file provides implementations for driver APIs for ${moduleNameUpperCase}.
-     Generation Information :
-         Driver Version    :  1.0.0
-     The generated drivers are tested against the following:
-         Compiler          :  ${compiler}
-         MPLAB             :  ${tool}
- */ 
+/**
+ * ${moduleNameUpperCase} Generated Driver File.
+ * 
+ * @file ${moduleNameLowerCase}.c
+ * 
+ * @ingroup  ${moduleNameLowerCase}
+ * 
+ * @brief This file contains the API implementations for the ${moduleNameUpperCase} driver.
+ *
+ * @version ${moduleNameUpperCase} Driver Version 1.0.1
+*/
+${disclaimer}
 
- ${disclaimer}
- 
- /**
-   Section: Included Files
- */
 
 #include <xc.h>
 #include "../${header.name}"
 
-/**
-  Section: ${moduleNameUpperCase} APIs
-*/
+<#if interruptEnabled>
+static void (*${moduleNameUpperCase}_CLCI_InterruptHandler)(void);
+static void ${moduleNameUpperCase}_DefaultCLCI_ISR(void);
+</#if>
 
 void ${api.Initialize.name}(void)
 {
-    // Set the ${moduleNameUpperCase} to the options selected in the User Interface
     
     <#list initRegisters as reg>
     // ${reg.comment}
@@ -44,6 +31,8 @@ void ${api.Initialize.name}(void)
     <#if interruptEnabled>
     // Clear the CLC interrupt flag
     ${interruptFlagName} = 0;
+    //Configure interrupt handlers
+    ${moduleNameUpperCase}_CLCI_SetInterruptHandler(${moduleNameUpperCase}_DefaultCLCI_ISR);
     // Enabling ${moduleNameUpperCase} interrupt.
     ${interruptEnableBitName} = 1;
     </#if>
@@ -59,9 +48,25 @@ void __interrupt(irq(${IRQname}),base(${IVTBaseAddress}),low_priority) ${api.ISR
 <#else>
 void ${api.ISR.name}(void)
 </#if>
-{
+{   
     // Clear the CLC interrupt flag
     ${interruptFlagName} = 0;
+
+    if (${moduleNameUpperCase}_CLCI_InterruptHandler != NULL)
+    {
+        ${moduleNameUpperCase}_CLCI_InterruptHandler();
+    }
+}
+
+void ${moduleNameUpperCase}_CLCI_SetInterruptHandler(void (* InterruptHandler)(void))
+{
+    ${moduleNameUpperCase}_CLCI_InterruptHandler = InterruptHandler;
+}
+
+static void ${moduleNameUpperCase}_DefaultCLCI_ISR(void)
+{
+    //Add your interrupt code here or
+    //Use ${moduleNameUpperCase}_CLCI_SetInterruptHandler() function to use custom ISR
 }
 </#if>
 

package/output/cla_clc_stacked_v5.h.ftl

@@ -1,109 +1,61 @@
- /**
-   ${moduleNameUpperCase} Generated Driver API Header File
- 
-   @Company
-     Microchip Technology Inc. 
-
-   @File Name
-    ${moduleNameLowerCase}.h
-
-   @Summary
-     This is the generated header file for the ${moduleNameUpperCase} driver.
- 
-   @Description
-     This header file provides APIs for driver for ${moduleNameUpperCase} driver.
-     Generation Information :
-         Driver Version    :  1.0.0
-     The generated drivers are tested against the following:
-         Compiler          :  ${compiler}
-         MPLAB             :  ${tool}
- */
-
+/**
+ * ${moduleNameUpperCase} Generated Driver API Header File.
+ * 
+ * @file ${moduleNameLowerCase}.h
+ * 
+ * @defgroup  ${moduleNameLowerCase} ${moduleNameUpperCase}
+ * 
+ * @brief This file contains the API prototypes for the ${moduleNameUpperCase} driver.
+ *
+ * @version ${moduleNameUpperCase} Driver Version 1.0.1
+*/
 ${disclaimer}
 
 #ifndef ${moduleNameUpperCase}_H
  #define ${moduleNameUpperCase}_H
- 
- /**
-   Section: Included Files
- */
 
 #include <xc.h>
 #include <stdint.h>
 #include <stdbool.h>
 
 /**
-  Section: ${moduleNameUpperCase} APIs
-*/
-
-/**
-  @Summary
-    Initializes the ${moduleNameUpperCase}
-
-  @Description
-    This routine configures the ${moduleNameUpperCase} specific control registers
-
-  @Preconditions
-    None
-
-  @Returns
-    None
-
-  @Param
-    None
-
-  @Comment
-
-  @Example
-    <code>
-    ${api.Initialize.name}();
-    </code>
-*/
+ * @ingroup ${moduleNameLowerCase}
+ * @brief  Initializes the ${moduleNameUpperCase}. This routine configures the ${moduleNameUpperCase} specific control registers.
+ * @param None.
+ * @return None.
+ * 
+ */
 ${simpleApi.Initialize};
 
 <#if interruptEnabled>
 <#if isVectoredInterruptEnabled>
 <#else>
-/**
-  @Summary
-    ${moduleNameUpperCase} Interrupt Service Routine
-
-  @Description
-    This is the ${moduleNameUpperCase} interrupt service routine called by the Interrupt Manager. Place your ${moduleNameUpperCase} interrupt code here.
-
-  @Preconditions
-    ${api.Initialize.name}() function should have been called before calling this function
 
-  @Returns
-    None
-
-  @Param
-    None
-
-*/
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Implements the Interrupt Service Routine (ISR) for the CLC interrupt events.
+ * @pre ${api.Initialize.name}() is already called.
+ * @param None.
+ * @return None.
+ */
 ${simpleApi.ISR};
 </#if>
-</#if>
 /**
-  @Summary
-    Returns output pin status of the CLC module.
-
-  @Description
-    This routine returns output pin status of the CLC module.
-
-  @Param
-    None.
-
-  @Returns
-    Output pin status
- 
-  @Example 
-    <code>
-    bool outputStatus;
-    outputStatus = ${api.OutputStatusGet.name}();
-    </code>
+ * @ingroup clc
+ * @brief Sets the callback function for the interrupt event.
+ * @param *InterruptHandler - Callback function for the interrupt event.
+ * @return None.
 */
+void ${moduleNameUpperCase}_CLCI_SetInterruptHandler(void (* InterruptHandler)(void));
+</#if>
 
+/**
+ * @ingroup ${moduleNameLowerCase}
+ * @brief Returns the output pin status of the CLC module.
+ * @param  None.
+ * @retval True - Output is 1.
+ * @retval False - Output is 0.
+ */
 ${simpleApi.OutputStatusGet};
 
 #endif  // ${moduleNameUpperCase}_H