@mchp-mcc/scf-pic8-interrupt-v3 1.0.0

package/output/interrupt_manager_priorityDisabled.c.ftl

@@ -0,0 +1,169 @@
+/**
+ * Interrupt Manager Generated Driver File
+ *
+ * @file interrupt.c
+ * 
+ * @ingroup interrupt 
+ * 
+ * @brief This file contains the API implementation for the Interrupt Manager driver.
+ * 
+ * @version Interrupt Manager Driver Version 2.0.5
+*/
+
+${disclaimer}
+
+#include "../../${header[0].path}${header[0].name}"
+#include "../../system/system.h"
+#include "../pins.h"
+
+<#list allocatedPins as intPin>
+void (*${intPin.functionName}_InterruptHandler)(void);
+</#list>
+
+void  INTERRUPT_Initialize (void)
+{
+    <#if IPENData??>
+    // ${IPENData.comment}
+    ${IPENData.name} = ${IPENData.value};
+
+    </#if>
+    <#list allocatedPins as pin>
+    // Clear the interrupt flag
+    <#if pin.edge??>
+    // Set the external interrupt edge detect
+    </#if> 
+    ${pin.customName}_InterruptFlagClear();   
+    <#if pin.edge??>
+    ${pin.customName}_${pin.edge}EdgeSet();
+    </#if>    
+    // Set Default Interrupt Handler
+    ${pin.functionName}_SetInterruptHandler(${pin.functionName}_DefaultInterruptHandler);
+    <#if pin.interruptEnabled == false>// </#if>${pin.customName}_InterruptEnable();
+
+    </#list>   
+}
+
+<#if hasHighInterrupts>
+/**
+ * @ingroup interrupt
+ * @brief Services the Interrupt Service Routines (ISR) of enabled interrupts and is called every time an interrupt is triggered.
+ * @pre Interrupt Manager is initialized.
+ * @param None.
+ * @return None.
+ */
+void __interrupt() INTERRUPT_InterruptManager (void)
+{
+    <#assign isIfCondUsedBefore = false>
+    <#assign isPieInterruptConfigured = false>
+    // interrupt handler
+    <#list highInterrupts as interrupt>
+        <#if isIfCondUsedBefore && serviceSingleIsrPerInterrupt>
+                <#assign if_cmd = "else if">
+        <#else>
+                <#assign if_cmd = "if">
+        </#if>
+        <#if (!interrupt.isPeripheralInterrupt || !pieAvailable)>
+            <#assign isIfCondUsedBefore = true>
+    ${if_cmd}(${interrupt.enable} == 1 && ${interrupt.flag} == 1)
+    {
+        <#if interrupt.generateISR>
+        ${interrupt.isrCallback.name}();
+        <#else>
+        //${interrupt.isrCallback.name}();
+        </#if>
+    }
+        <#else>
+            <#assign isPieInterruptConfigured = true>
+        </#if>
+    </#list>  
+    <#if isPieInterruptConfigured>
+        <#if isIfCondUsedBefore && serviceSingleIsrPerInterrupt>
+                <#assign if_cmd = "else if">
+        <#else>
+                <#assign if_cmd = "if">
+        </#if>  
+    ${if_cmd}(${INTCON.settings.PEIE.bitName} == 1)
+    {
+        <#assign isIfCondUsedBefore = false>
+        <#list highInterrupts as interrupt>
+            <#if isIfCondUsedBefore && serviceSingleIsrPerInterrupt>
+                    <#assign if_cmd = "else if">
+            <#else>
+                    <#assign if_cmd = "if">
+            </#if> 
+            <#if (interrupt.isPeripheralInterrupt && pieAvailable)>
+                <#assign isIfCondUsedBefore = true>
+        ${if_cmd}(${interrupt.enable} == 1 && ${interrupt.flag} == 1)
+        {
+            <#if interrupt.generateISR>
+            ${interrupt.isrCallback.name}();
+            <#else>
+            //${interrupt.isrCallback.name}();
+            </#if>
+        } 
+            </#if>
+        </#list>  
+        <#if preemptiveHigh>
+        else
+        {
+            //Unhandled Interrupt
+        }
+        </#if>
+    }      
+    </#if>    
+    <#if preemptiveHigh>
+    else
+    {
+        //Unhandled Interrupt
+    }
+    </#if>
+}
+</#if>
+
+<#list allocatedPins as intPin>
+<#if vectoredInterruptEnabled>
+
+/**
+ * @ingroup interrupt
+ * @brief Execute whenever the signal on the ${intPin.functionName} pin will transition to the preconfigured state.
+ * @pre Interrupt Manager is initialized.
+ * @param None.
+ * @return None.
+ */
+<#if intPin.isHighPriority>
+void __interrupt(irq(${intPin.getIRQname}),base(${IVTBaseAddress})) ${intPin.functionName}_ISR()
+<#else>
+void __interrupt(irq(${intPin.getIRQname}),base(${IVTBaseAddress}),low_priority) ${intPin.functionName}_ISR()
+</#if>
+<#else>
+void ${intPin.functionName}_ISR(void)
+</#if>
+{
+    ${intPin.customName}_InterruptFlagClear();
+
+    // Callback function gets called everytime this ISR executes
+    ${intPin.functionName}_CallBack();    
+}
+
+
+void ${intPin.functionName}_CallBack(void)
+{
+    // Add your custom callback code here
+    if(${intPin.functionName}_InterruptHandler)
+    {
+        ${intPin.functionName}_InterruptHandler();
+    }
+}
+
+void ${intPin.functionName}_SetInterruptHandler(void (* InterruptHandler)(void)){
+    ${intPin.functionName}_InterruptHandler = InterruptHandler;
+}
+
+void ${intPin.functionName}_DefaultInterruptHandler(void){
+    // add your ${intPin.functionName} interrupt custom code
+    // or set custom function using ${intPin.functionName}_SetInterruptHandler()
+}
+</#list>
+/**
+ End of File
+*/

package/output/interrupt_manager_priorityDisabled.h.ftl

@@ -0,0 +1,178 @@
+/**
+ * Interrupt Manager Generated Driver API Header File
+ * 
+ * @file interrupt.h
+ * 
+ * @defgroup interrupt INTERRUPT
+ * 
+ * @brief This file contains API prototypes and other data types for the Interrupt Manager driver.
+ *
+ * @version Interrupt Manager Driver Version 2.0.5
+*/
+
+${disclaimer}
+
+#ifndef INTERRUPT_H
+#define INTERRUPT_H
+
+
+/**
+ * @ingroup interrupt
+ * @brief Enables global interrupts.
+ * @param None.
+ * @return None.
+ */
+#define INTERRUPT_GlobalInterruptEnable() (${INTCON.settings.GIE.bitName} = 1)
+
+/**
+ * @ingroup interrupt
+ * @brief Disables global interrupts.
+ * @param None.
+ * @return None.
+ */
+#define INTERRUPT_GlobalInterruptDisable() (${INTCON.settings.GIE.bitName} = 0)
+
+/**
+ * @ingroup interrupt
+ * @brief Returns the Global Interrupt Enable bit status.
+ * @param None.
+ * @retval 0 - Global interrupt disabled.
+ * @retval 1 - Global interrupt enabled.
+ */
+#define INTERRUPT_GlobalInterruptStatus() (${INTCON.settings.GIE.bitName})
+
+<#if pieAvailable>
+/**
+ * @ingroup interrupt
+ * @brief Enables peripheral interrupts.
+ * @param None.
+ * @return None.
+ */
+#define INTERRUPT_PeripheralInterruptEnable() (${INTCON.settings.PEIE.bitName} = 1)
+
+/**
+ * @ingroup interrupt
+ * @brief Disables peripheral interrupts.
+ * @param None.
+ * @return None.
+ */
+#define INTERRUPT_PeripheralInterruptDisable() (${INTCON.settings.PEIE.bitName} = 0)
+</#if>
+
+/**
+ * @ingroup interrupt
+ * @brief Initializes peripheral interrupt priorities, enables or disables priority vectors and initializes the external interrupt.
+ * @param None.
+ * @return None.
+ */
+void INTERRUPT_Initialize (void);
+
+<#list allocatedPins as intPin>
+<#-- if intPin.interruptEnabled -->
+
+/**
+ * @ingroup interrupt
+ * @brief Clears the Interrupt flag for the external interrupt, ${intPin.functionName}.
+ * @param None.
+ * @return None.
+ */
+#define ${intPin.customName}_InterruptFlagClear()       (${intPin.flagName} = 0)
+
+/**
+ * @ingroup interrupt
+ * @brief Clears the interrupt enable for the external interrupt, ${intPin.functionName}. This way, the external interrupts on this pin will not be serviced by the interrupt handler.
+ * @param None.
+ * @return None.
+ */
+#define ${intPin.customName}_InterruptDisable()     (${intPin.enableBitName} = 0)
+
+/**
+ * @ingroup interrupt
+ * @brief Sets the interrupt enable for the external interrupt, ${intPin.functionName}. This way, the external interrupts on this pin will be serviced by the interrupt handler.
+ * @param None.
+ * @return None.
+ */
+#define ${intPin.customName}_InterruptEnable()       (${intPin.enableBitName} = 1)
+
+<#if intPin.edge?? && intPin.SFREdgeDetectFromPin??>
+/**
+ * @ingroup interrupt
+ * @brief Sets the edge detect of the external interrupt to positive edge. This way, the Interrupt flag will be set when the external interrupt pin level transitions from low to high.
+ * @param None.
+ * @return None.
+ */
+#define ${intPin.customName}_risingEdgeSet()          (${intPin.SFREdgeDetectFromPin} = 1)
+</#if>
+
+<#if intPin.edge?? && intPin.SFREdgeDetectFromPin??>
+/**
+ * @ingroup interrupt
+ * @brief Sets the edge detect of the external interrupt to negative edge. This way, the Interrupt flag will be set when the external interrupt pin level transitions from high to low.
+ * @param None.
+ * @return None.
+ */
+#define ${intPin.customName}_fallingEdgeSet()          (${intPin.SFREdgeDetectFromPin} = 0)
+</#if>
+<#-- /#if -->
+</#list>
+
+/**
+   Section: External Interrupt Handlers
+ */
+<#list allocatedPins as intPin>
+<#if vectoredInterruptEnabled>
+<#else>
+<#-- if intPin.interruptEnabled -->
+
+/**
+ * @ingroup interrupt
+ * @brief Executes the ISR whenever the signal on the ${intPin.functionName} pin transitions to the preconfigured state.
+ * @pre Interrupt Manager is initialized.
+ * @param None.
+ * @return None.
+ */
+void ${intPin.functionName}_ISR(void);
+</#if>
+
+/**
+ * @ingroup interrupt
+ * @brief Allows for a specific callback function to be called in the ${intPin.functionName} ISR and for a nonspecific interrupt handler to be called at run time.
+ * @pre Interrupt Manager is initialized.
+ * @param None.
+ * @return None.
+ */
+void ${intPin.functionName}_CallBack(void);
+
+/**
+ * @ingroup interrupt
+ * @brief Allows selecting an interrupt handler for ${intPin.customName} - ${intPin.functionName} at application run time.
+ * @pre Interrupt Manager is initialized.
+ * @param (*InterruptHandler)(void) - InterruptHandler function pointer.
+ * @return None.
+ */
+void ${intPin.functionName}_SetInterruptHandler(void (* InterruptHandler)(void));
+
+/**
+ * @ingroup interrupt
+ * @brief Dynamic interrupt handler to be called every time the ${intPin.functionName} ISR is executed. It allows any function to be registered at run time.
+ * @pre Interrupt Manager is initialized.
+ * @param None.
+ * @return None.
+ */
+extern void (*${intPin.functionName}_InterruptHandler)(void);
+
+/**
+ * @ingroup interrupt
+ * @brief Default interrupt handler to be called every time the ${intPin.functionName} ISR is executed. It allows any function to be registered at run time.
+ * @pre Interrupt Manager is initialized.
+ * @param None.
+ * @return None.
+ */
+void ${intPin.functionName}_DefaultInterruptHandler(void);
+<#-- /#if -->
+</#list>
+
+#endif  // INTERRUPT_H
+/**
+ End of File
+*/

package/output/nullPrototype.json

@@ -0,0 +1,49 @@
+{
+    "payload": null,
+    "imports": {
+        "scf_pic8_interrupt_v3": {
+            "interfaceId": {
+                "name": "scf-pic8-interrupt-v3",
+                "version": "1.0.0"
+            },
+            "isRequired": true
+        },
+        "initializer_system": {
+            "interfaceId": {
+                "name": "initializer-system",
+                "version": "^0"
+            }
+        },
+        "initializer_main": {
+            "interfaceId": {
+                "name": "initializer-main",
+                "version": "^0"
+            }
+        },
+        "pin_standard": {
+            "interfaceId": {
+                "name": "pin-standard",
+                "version": "^0"
+            }
+        },
+        "device_meta": {
+            "interfaceId": {
+                "name": "device-meta",
+                "version": "^1"
+            }
+        }
+    },
+    "exports": {
+        "interrupt": {
+            "interfaces": [
+                {
+                    "interfaceId": {
+                        "name": "interrupt-standard",
+                        "version": "1.0.1"
+                    }
+                }
+            ]
+        }
+    },
+    "isEntryPoint": true
+}