refactor: ic modules with comments and combined blocks

Author: CloudyPadmal

src/registers/comparators/ic1.h

@@ -277,11 +277,66 @@ extern "C" {
     inline static void IC1_CombineOddEvenICModules(void) {
         IC1CON2bits.IC32 = 1;
     }
-    
+
+    /**
+    @Summary
+        Sets the trigger event for capture complete interrupt
+
+      @Description
+        This routine sets the trigger event for the input capture module to
+        notify the ISR that a capture event is complete
+
+      @Preconditions
+        IC1_Initialize function should have been called
+
+      @Param
+        IC_PARAMS_CAPTURE_INTERRUPT
+
+      @Returns
+        None
+     */
+    inline static void IC1_InputCaptureInterruptOn(IC_PARAMS_CAPTURE_INTERRUPT i) {
+        IC1CON1bits.ICI = i;
+    }
+
+    /**
+    @Summary
+        Defines the purpose of input capture pin source
+
+      @Description
+        This routine defines if the pin attached to IC module is used either to
+        trigger the IC1TMR or to synchronize the timer with another timer module.
+
+      @Preconditions
+        IC1_Initialize function should have been called
+
+      @Param
+        IC_PARAMS_SOURCE_TASK
+
+      @Returns
+        None
+     */
     inline static void IC1_UseSourceTo(IC_PARAMS_SOURCE_TASK t) {
         IC1CON2bits.ICTRIG = t;
     }
-    
+
+    /**
+    @Summary
+        Clears the set interrupt flag of IC1 capture interrupt
+
+      @Description
+        This routine will clear the interrupt flag of the IC1 capture
+        module.
+
+      @Preconditions
+        IC1_Initialize function should have been called
+
+      @Param
+        None
+
+      @Returns
+        None
+     */
     inline static void IC1_InterruptFlagClear(void) {
         IFS0bits.IC1IF = 0;
     }

src/registers/comparators/ic2.h

@@ -283,11 +283,66 @@ extern "C" {
     inline static void IC2_CombineOddEvenICModules(void) {
         IC2CON2bits.IC32 = 1;
     }
-    
+
+    /**
+    @Summary
+        Sets the trigger event for capture complete interrupt
+
+      @Description
+        This routine sets the trigger event for the input capture module to
+        notify the ISR that a capture event is complete
+
+      @Preconditions
+        IC2_Initialize function should have been called
+
+      @Param
+        IC_PARAMS_CAPTURE_INTERRUPT
+
+      @Returns
+        None
+     */
+    inline static void IC2_InputCaptureInterruptOn(IC_PARAMS_CAPTURE_INTERRUPT i) {
+        IC2CON1bits.ICI = i;
+    }
+
+    /**
+    @Summary
+        Defines the purpose of input capture pin source
+
+    @Description
+        This routine defines if the pin attached to IC module is used either to
+        trigger the IC2TMR or to synchronize the timer with another timer module.
+
+    @Preconditions
+        IC2_Initialize function should have been called
+
+    @Param
+        IC_PARAMS_SOURCE_TASK
+
+    @Returns
+        None
+    */
     inline static void IC2_UseSourceTo(IC_PARAMS_SOURCE_TASK t) {
         IC2CON2bits.ICTRIG = t;
     }
-    
+
+    /**
+    @Summary
+        Clears the set interrupt flag of IC2 capture interrupt
+
+      @Description
+        This routine will clear the interrupt flag of the IC2 capture
+        module.
+
+      @Preconditions
+        IC2_Initialize function should have been called
+
+      @Param
+        None
+
+      @Returns
+        None
+     */
     inline static void IC2_InterruptFlagClear(void) {
         IFS0bits.IC2IF = 0;
     }

src/registers/comparators/ic3.h

@@ -283,11 +283,66 @@ extern "C" {
     inline static void IC3_CombineOddEvenICModules(void) {
         IC3CON2bits.IC32 = 1;
     }
-    
+
+    /**
+    @Summary
+        Sets the trigger event for capture complete interrupt
+
+      @Description
+        This routine sets the trigger event for the input capture module to
+        notify the ISR that a capture event is complete
+
+      @Preconditions
+        IC3_Initialize function should have been called
+
+      @Param
+        IC_PARAMS_CAPTURE_INTERRUPT
+
+      @Returns
+        None
+     */
+    inline static void IC3_InputCaptureInterruptOn(IC_PARAMS_CAPTURE_INTERRUPT i) {
+        IC3CON1bits.ICI = i;
+    }
+
+    /**
+    @Summary
+        Defines the purpose of input capture pin source
+
+    @Description
+        This routine defines if the pin attached to IC module is used either to
+        trigger the IC3TMR or to synchronize the timer with another timer module.
+
+    @Preconditions
+        IC3_Initialize function should have been called
+
+    @Param
+        IC_PARAMS_SOURCE_TASK
+
+    @Returns
+        None
+    */
     inline static void IC3_UseSourceTo(IC_PARAMS_SOURCE_TASK t) {
         IC3CON2bits.ICTRIG = t;
     }
-    
+
+    /**
+    @Summary
+        Clears the set interrupt flag of IC3 capture interrupt
+
+      @Description
+        This routine will clear the interrupt flag of the IC3 capture
+        module.
+
+      @Preconditions
+        IC3_Initialize function should have been called
+
+      @Param
+        None
+
+      @Returns
+        None
+     */
     inline static void IC3_InterruptFlagClear(void) {
         IFS2bits.IC3IF = 0;
     }

src/registers/comparators/ic4.h

@@ -283,18 +283,89 @@ extern "C" {
     inline static void IC4_CombineOddEvenICModules(void) {
         IC4CON2bits.IC32 = 1;
     }
-    
+
+    /**
+    @Summary
+        Defines the purpose of input capture pin source
+
+    @Description
+        This routine defines if the pin attached to IC module is used either to
+        trigger the IC4TMR or to synchronize the timer with another timer module.
+
+    @Preconditions
+        IC4_Initialize function should have been called
+
+    @Param
+        IC_PARAMS_SOURCE_TASK
+
+    @Returns
+        None
+    */
     inline static void IC4_UseSourceTo(IC_PARAMS_SOURCE_TASK t) {
         IC4CON2bits.ICTRIG = t;
     }
 
+    /**
+    @Summary
+        Clears the set interrupt flag of IC4 capture interrupt
+
+      @Description
+        This routine will clear the interrupt flag of the IC4 capture
+        module.
+
+      @Preconditions
+        IC4_Initialize function should have been called
+
+      @Param
+        None
+
+      @Returns
+        None
+     */
     inline static void IC4_InterruptFlagClear(void) {
         IFS2bits.IC4IF = 0;
     }
-    
+
+    /**
+    @Summary
+        Enable IC4 interrupt
+
+      @Description
+        This routine will enable IC4 interrupt.
+
+      @Preconditions
+        IC4_Initialize function should have been called
+
+      @Param
+        None
+
+      @Returns
+        None
+     */
     inline static void IC4_InterruptEnable(void) {
         IEC2bits.IC4IE = 1;
     }
+
+    /**
+    @Summary
+        Sets the trigger event for capture complete interrupt
+
+      @Description
+        This routine sets the trigger event for the input capture module to
+        notify the ISR that a capture event is complete
+
+      @Preconditions
+        IC4_Initialize function should have been called
+
+      @Param
+        IC_PARAMS_CAPTURE_INTERRUPT
+
+      @Returns
+        None
+     */
+    inline static void IC4_InputCaptureInterruptOn(IC_PARAMS_CAPTURE_INTERRUPT i) {
+        IC4CON1bits.ICI = i;
+    }
 
     inline static void IC4_InterruptDisable(void) {
         IEC2bits.IC4IE = 0;

src/registers/comparators/ic_params.c

@@ -2,6 +2,7 @@
 #include "ic2.h"
 #include "ic3.h"
 #include "ic4.h"
+#include "../system/pin_manager.h"
 
 void IC_PARAMS_InitiateAll(void) {
     IC1_Initialize();
@@ -63,4 +64,52 @@ void IC_PARAMS_SetCaptureTimer(IC_PARAMS_CAPTURE_TIMER t) {
     IC2_SetCaptureTimer(t);
     IC3_SetCaptureTimer(t);
     IC4_SetCaptureTimer(t);
-}
+}
+
+void IC_PARAMS_ConfigureIntervalCaptureWithIC1AndIC2(uint8_t pin, 
+        IC_PARAMS_CAPTURE_TIMER timer, 
+        IC_PARAMS_CAPTURE_INTERRUPT interrupt,
+        IC_PARAMS_CAPTURE_MODE mode) {
+    
+    IC1_InterruptFlagClear();
+    
+    RPINR7bits.IC1R = PIN_MANAGER_DIGITAL_PINS[pin];
+    
+    IC1_Initialize();
+    IC1_CombineOddEvenICModules();
+    IC1_SetCaptureTimer(timer);
+    IC1_InputCaptureInterruptOn(interrupt);
+    IC1_UseSourceTo(IC_PARAMS_SOURCE_TASK_TRIGGER);
+    IC1_SetCaptureMode(mode);
+    
+    IC2_Initialize();
+    IC2_CombineOddEvenICModules();
+    IC2_SetCaptureTimer(timer);
+    IC2_InputCaptureInterruptOn(interrupt);
+    IC2_UseSourceTo(IC_PARAMS_SOURCE_TASK_TRIGGER);
+    IC2_SetCaptureMode(mode);
+}
+
+void IC_PARAMS_ConfigureIntervalCaptureWithIC3AndIC4(uint8_t pin, 
+        IC_PARAMS_CAPTURE_TIMER timer, 
+        IC_PARAMS_CAPTURE_INTERRUPT interrupt,
+        IC_PARAMS_CAPTURE_MODE mode) {
+    
+    IC3_InterruptFlagClear();
+    
+    RPINR8bits.IC3R = PIN_MANAGER_DIGITAL_PINS[pin];
+    
+    IC3_Initialize();
+    IC3_CombineOddEvenICModules();
+    IC3_SetCaptureTimer(timer);
+    IC3_InputCaptureInterruptOn(interrupt);
+    IC3_UseSourceTo(IC_PARAMS_SOURCE_TASK_TRIGGER);
+    IC3_SetCaptureMode(mode);
+    
+    IC4_Initialize();
+    IC4_CombineOddEvenICModules();
+    IC4_SetCaptureTimer(timer);
+    IC4_InputCaptureInterruptOn(interrupt);
+    IC4_UseSourceTo(IC_PARAMS_SOURCE_TASK_TRIGGER);
+    IC4_SetCaptureMode(mode);
+}