docs: documentation for LA

Author: CloudyPadmal

pslab-core.X/bus/i2c/i2c.c

@@ -800,6 +800,8 @@ response_t I2C_CommandEnableSMBus(void) {
     I2C2CONbits.SMEN = 1;
     // Enables I2C2 module and configure SDA2 and SCL2 as serial port pins
     I2C2CONbits.I2CEN = 1;
+    
+    return SUCCESS;
 }
 
 response_t I2C_CommandDisableSMBus(void) {
@@ -809,6 +811,7 @@ response_t I2C_CommandDisableSMBus(void) {
     I2C2CONbits.SMEN = 0;
     // Enables I2C2 module and configure SDA2 and SCL2 as serial port pins
     I2C2CONbits.I2CEN = 1;
+    
     return SUCCESS;
 }
 

pslab-core.X/commands.c

@@ -227,11 +227,11 @@ command_func_t* const cmd_table[NUM_PRIMARY_CMDS + 1][NUM_SECONDARY_CMDS_MAX + 1
      // 0                               1 GET_TIMING                    2                               3
         Undefined,                      Unimplemented,                  Undefined,                      Undefined,
      // 4 START_ONE_CHAN_LA             5 START_TWO_CHAN_LA             6 START_FOUR_CHAN_LA            7 FETCH_DMA_DATA
-        LOGICANALYZER_OneChannel,       LOGICANALYZER_TwoChannel,       LOGICANALYZER_FourChannel,      Unimplemented,
+        LOGICANALYZER_OneChannel,       LOGICANALYZER_TwoChannel,       LOGICANALYZER_FourChannel,      Removed,
      // 8 FETCH_INT_DMA_DATA            9 FETCH_LONG_DMA_DATA           10 COMPARATOR_TO_LA             11 GET_INITIAL_STATES
         BUFFER_FetchInt,                BUFFER_FetchLong,               Unimplemented,                  INTERVAL_GetState,
      // 12 TIMING_MEASUREMENTS          13 INTERVAL_MEASUREMENTS        14 CONFIGURE_COMPARATOR         15 START_ALTERNATE_ONE_CHAN_LA
-        Unimplemented,                  Unimplemented,                  Unimplemented,                  LOGICANALYZER_OneChannelAlt,
+        Unimplemented,                  Unimplemented,                  Removed,                        LOGICANALYZER_OneChannelAlt,
      // 16 START_THREE_CHAN_LA          17 STOP_LA                      18                              19
         LOGICANALYZER_ThreeChannel,     LOGICANALYZER_Stop,             Undefined,                      Undefined,
      // 20                              21                              22                              23

pslab-core.X/commands.h

@@ -17,7 +17,7 @@ extern "C" {
  * This is used to set the dimensions of the command table, and to sanitize
  * received commands.
  */
-#define NUM_PRIMARY_CMDS 12
+#define NUM_PRIMARY_CMDS 13
 #define NUM_FLASH_CMDS 4
 #define NUM_ADC_CMDS 23
 #define NUM_SPI_CMDS 7

pslab-core.X/helpers/interval.c

@@ -61,7 +61,6 @@ void INTERVAL_CaptureOne(uint16_t count, uint8_t channel, uint8_t mode, uint8_t
             CMP4_SetupComparator();
         }
         RPINR8bits.IC4R = PIN_MANAGER_DIGITAL_PINS[(trig >> 4) & 0xF];
-
         IC4_SetCaptureTimer(IC_PARAMS_CAPTURE_TIMER_PERIPHERAL);
         IC1_SetCaptureSource(IC_PARAMS_CAPTURE_SOURCE_IC4);
         IC2_SetCaptureSource(IC_PARAMS_CAPTURE_SOURCE_IC4);
@@ -102,7 +101,7 @@ void INTERVAL_CaptureTwo(uint16_t count, uint8_t mode, uint8_t channel) {
     SetDMA_MODE(DMA_MODES_TWO_CHANNEL);
 
     RPINR7bits.IC1R = PIN_MANAGER_DIGITAL_PINS[channel & 0xF];
-    RPINR8bits.IC3R = PIN_MANAGER_DIGITAL_PINS[(channel >> 4)&0xF];
+    RPINR8bits.IC3R = PIN_MANAGER_DIGITAL_PINS[(channel >> 4) & 0xF];
 
     IC_PARAMS_SetCaptureTimer(IC_PARAMS_CAPTURE_TIMER_PERIPHERAL);
     IC_PARAMS_CombineOddEvenModules();
@@ -152,7 +151,11 @@ void INTERVAL_CaptureThree(uint16_t count, uint16_t mode, uint8_t trig) {
     IC3_UseSourceTo(IC_PARAMS_SOURCE_TASK_TRIGGER);
 
     if (trig & 7) {
-        RPINR8bits.IC4R = PIN_MANAGER_DIGITAL_PINS[(trig >> 4) & 0xF];
+        if ((trig >> 4) == 4) {
+            CVR_SetupComparator();
+            CMP4_SetupComparator();
+        }
+        RPINR8bits.IC4R = PIN_MANAGER_DIGITAL_PINS[(trig >> 4) & 0xF]; 
         IC1_SetCaptureSource(IC_PARAMS_CAPTURE_SOURCE_IC4);
         IC2_SetCaptureSource(IC_PARAMS_CAPTURE_SOURCE_IC4);
         IC3_SetCaptureSource(IC_PARAMS_CAPTURE_SOURCE_IC4);

pslab-core.X/instruments/logicanalyzer.c

@@ -6,8 +6,8 @@
 #include "../registers/comparators/ic3.h"
 #include "../registers/comparators/ic4.h"
 #include "../registers/comparators/ic_params.h"
-#include "../registers/system/pin_manager.h"
 #include "../registers/system/interrupt_manager.h"
+#include "../registers/system/pin_manager.h"
 #include "../registers/timers/tmr2.h"
 #include "../commands.h"
 
@@ -94,12 +94,16 @@ response_t LOGICANALYZER_TwoChannel(void) {
     }
 
     return SUCCESS;
+    
+    // TODO: Implement trigger actions for any of the two channels. Right now
+    // only one channel can be set as trigger source. Using CN interrupts, this
+    // can be extended to listen to multiple trigger sources.
 }
 
 response_t LOGICANALYZER_ThreeChannel(void) {
 
     uint16_t points = UART1_ReadInt();
-    uint8_t config = UART1_Read();
+    uint8_t config = UART1_ReadInt();
     uint8_t trigger = UART1_Read();
 
     IC4_InterruptHighPriority();
@@ -119,6 +123,10 @@ response_t LOGICANALYZER_ThreeChannel(void) {
     }
 
     return SUCCESS;
+    
+    // TODO: Implement trigger actions for any of the three channels. Right now
+    // only one channel can be set as trigger source. Using CN interrupts, this
+    // can be extended to listen to multiple trigger sources.
 }
 
 response_t LOGICANALYZER_FourChannel(void) {
@@ -132,7 +140,7 @@ response_t LOGICANALYZER_FourChannel(void) {
     INTERVAL_CaptureFour(points, mode, prescaler);
 
     if (trigger & 1) {
-        LA_TRIGGER_STATE = (trigger & 2) ? 1 : 0;
+        LA_TRIGGER_STATE = trigger & 2 ? FALLING_EDGE : RISING_EDGE;
         LA_TRIGGER_CHANNEL = 0;
 
         if ((trigger >> 2) & 1) {
@@ -151,7 +159,6 @@ response_t LOGICANALYZER_FourChannel(void) {
             INTERRUPT_LA4PinChange(true);
             LA_TRIGGER_CHANNEL |= 8;
         }
-        
         INTERRUPT_ClearPinChangeInterruptsFlag();
         INTERRUPT_EnablePinChangeInterrupts();
     } else {

pslab-core.X/instruments/logicanalyzer.h

@@ -7,11 +7,23 @@
  * @brief Capture logic level changes on a single channel.
  *
  * @description
+ * This routine will log timer values for the changes occurred in a pin defined 
+ * by the configuration byte. 
+ * 
+ * If a trigger is enabled, this will use an external interrupt service routine 
+ * attached to a pin defined by the trigger byte. Once the logic level is observed
+ * to be the same as in EDGE bit, IC1 and IC2 modules will start the combined 
+ * timer (32-bits) and pass them to BUFFER using first two DMA channels.
+ * 
+ * If no trigger is set, the timers will be started right away once the function
+ * is called and logic level changes will logged referring to IC1 and IC2 capture 
+ * timers in BUFFER using the same DMA channels.
+ * 
  * This command function takes three arguments over serial:
  * 1. (uint16) number of data points to capture
  * 2. (uint8) trigger conditions:
  *            | 7 | 6 | 5 | 4 | 3 | 2 |  1   | 0  |
- *            |      PIN      | X | X | EDGE | EN |
+ *            |  TRIGGER PIN  | X | X | EDGE | EN |
  *            PIN: Digital pin from map:
  *              0: LA1,
  *              1: LA2,
@@ -22,9 +34,9 @@
  *              6: FREQ
  *            EDGE: Falling (1) or Rising (0) edge trigger
  *            EN: Enable trigger
- * 3. (uint8)  Configuration byte:
- *             | 7  | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
- *             |    CHANNEL     |     MODE      |
+ * 3. (uint8) channel and mode configurations:
+ *            | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+ *            |  DIGITAL PIN  |  TRANSITIONS  |
  *             CHANNEL: Digital pin from the same map as above `PIN` maps
  *             MODE: Logic transitions to capture. Refer `IC_PARAMS_CAPTURE_MODE`
  * 
@@ -41,10 +53,29 @@ response_t LOGICANALYZER_OneChannel(void);
  * @brief Capture logic level changes in one channel
  *
  * @description
+ * This routine is much similar to `LOGICANALYZER_OneChannel` except the trigger
+ * is handled differently. If trigger is enabled, IC4 pin will be connected to a
+ * pin defined by the trigger byte and an ISR will be activated for IC4 module.
+ * This will trigger an interrupt when a logic change defined by the trigger byte
+ * is observed at the pin attached to IC4. At the same time, IC1 and IC2 start
+ * their timers and log timer values to BUFFER using DMA0 and DMA1 channels
+ * 
  * This command function takes three arguments over serial:
- * 1. (uint16) Number of data points/change events to capture
- * 2. (uint8) Trigger settings
- * 3. (uint8) Channel and mode configurations
+ * 1. (uint16) number of data points to capture
+ * 2. (uint8) trigger conditions:
+ *            | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+ *            |    TRIG PIN   | X | TRIG MODE |
+ *            PIN: Digital pin from map:
+ *              0: LA1,
+ *              1: LA2,
+ *              2: LA3,
+ *              3: LA4,
+ *              4: COMP4,
+ *              5: SPI_CS,
+ *              6: FREQ
+ * 3. (uint8) channel and mode configuration:
+ *            | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+ *            |  DIGITAL PIN  |  TRANSITIONS  |
  * 
  * It returns nothing over serial.
  * It sends an acknowledge byte (SUCCESS).
@@ -57,10 +88,37 @@ response_t LOGICANALYZER_OneChannelAlt(void);
  * @brief Capture logic level changes in two channels
  *
  * @description
- * This command function takes three arguments over serial:
- * 1. (uint16) Number of data points/change events to capture
- * 2. (uint8) Trigger settings
- * 3. (uint8) Channel and mode configurations
+ * This routine will log timer values on logic level changes in two different 
+ * pins defined by the channel byte.
+ * 
+ * If a trigger is enabled, this will use an external interrupt service routine
+ * attached to a pin defined by trigger byte. Once the logic level is observed
+ * to be the same as in EDGE bit, All IC modules will start the combined 
+ * timers (32-bits) and pass them to BUFFER using all four DMA channels.
+ * 
+ * If no trigger is enabled, the timers will be started right away once the 
+ * function is called and logic level changes will logged referring to IC1 and 
+ * IC3 combined capture timers in BUFFER using the same DMA channels.
+ * 
+ * This command function takes four arguments over serial:
+ * 1. (uint16) number of data points to capture
+ * 2. (uint8) trigger conditions:
+ *            | 7 | 6 | 5 | 4 | 3 | 2 |   1  | 0  |
+ *            |    TRIG PIN   | X | X | EDGE | EN |
+ *            PIN: Digital pin from map:
+ *              0: LA1,
+ *              1: LA2,
+ *              2: LA3,
+ *              3: LA4,
+ *              4: COMP4,
+ *              5: SPI_CS,
+ *              6: FREQ
+ * 3. (uint8) mode configurations:
+ *            | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+ *            |  PIN 2 MODES  |  PIN 1 MODES  |
+ * 4. (uint8) channel configurations:
+ *            | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+ *            | PIN 2 CHANNEL | PIN 1 CHANNEL |
  * 
  * It returns nothing over serial.
  * It sends an acknowledge byte (SUCCESS).
@@ -73,10 +131,36 @@ response_t LOGICANALYZER_TwoChannel(void);
  * @brief Capture logic level changes in three channels
  *
  * @description
+ * This routine will log timer values on logic level changes in LA1, LA2 and LA3
+ * pins. These pins are fixed for this mode of operation.
+ * 
+ * If a trigger is enabled, this will use IC4 module as a trigger source to start
+ * IC1, 2 and 3 timers. Once the logic level change as defined in trigger byte is
+ * observed at IC4, it will generate an interrupt that will turn on all IC1,2,3
+ * timers which will capture logic level changes defined in configuration integer.
+ * IC modules will have 16-bit timers and the value is logged to BUFFER using
+ * three DMA channels.
+ * 
+ * If no trigger is enabled, the timers will be started right away once the 
+ * function is called and logic level changes will logged referring to IC1, 2 
+ * and IC3 combined capture timers in BUFFER using the same DMA channels.
+ * 
  * This command function takes three arguments over serial:
- * 1. (uint16) Number of data points/change events to capture
- * 2. (uint8) Trigger settings
- * 3. (uint8) Channel and mode configurations
+ * 1. (uint16) number of data points to capture
+ * 2. (uint16) configurations:
+ *            | F | E | D | C | B | A | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+ *            | X | X | X | X |   LA3 EDGES   |   LA2 EDGES   |   LA1 EDGES   |
+ * 3. (uint8) trigger conditions:
+ *            | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+ *            |    TRIG PIN   | X | TRIG MODE |
+ *            PIN: Trig pin from map:
+ *              0: LA1,
+ *              1: LA2,
+ *              2: LA3,
+ *              3: LA4,
+ *              4: COMP4,
+ *              5: SPI_CS,
+ *              6: FREQ
  * 
  * It returns nothing over serial.
  * It sends an acknowledge byte (SUCCESS).
@@ -89,10 +173,29 @@ response_t LOGICANALYZER_ThreeChannel(void);
  * @brief Capture logic level changes in four channels
  *
  * @description
- * This command function takes three arguments over serial:
- * 1. (uint16) Number of data points/change events to capture
- * 2. (uint8) Trigger settings
- * 3. (uint8) Channel and mode configurations
+ * This routine will log timer values on logic level changes in LA1, LA2, LA3 
+ * and LA4 pins. These pins are fixed for this mode of operation.
+ * 
+ * If a trigger is enabled, this will use CN (Change Notifier) Interrupt Service
+ * Routine to trigger the IC timers to log logic level changes. If any of the 4
+ * pins observe a logic change as defined in trigger byte, the timers will get
+ * started logging logic level changes in all 4 pins defined in the configuration
+ * integer. IC modules will have 16-bit timers and the value is logged to BUFFER 
+ * using all four DMA channels.
+ * 
+ * If no trigger is enabled, the timers will be started right away once the 
+ * function is called and logic level changes will logged referring to IC1, IC2,
+ * IC3 and IC4 capture timers in BUFFER using the same DMA channels.
+ * 
+ * This command function takes four arguments over serial:
+ * 1. (uint16) number of data points to capture
+ * 2. (uint16) mode configurations:
+ *            | F | E | D | C | B | A | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
+ *            |   LA4 EDGES   |   LA3 EDGES   |   LA2 EDGES   |   LA1 EDGES   |
+ * 3. (uint8) pre-scaler settings for timer 2
+ * 4. (uint8) trigger settings:
+ *            | 7 | 6 |  5  |  4  |  3  |  2  |  1   | 0  |
+ *            | X | X | LA4 | LA3 | LA2 | LA1 | EDGE | EN |
  * 
  * It returns nothing over serial.
  * It sends an acknowledge byte (SUCCESS).
@@ -106,7 +209,7 @@ response_t LOGICANALYZER_FourChannel(void);
  *
  * @description
  * This command function does not take any arguments over serial. It will stop 
- * all the capture modules.
+ * all the input capture modules.
  * 
  * It returns nothing over serial.
  * It sends an acknowledge byte (SUCCESS).

pslab-core.X/registers/comparators/ic4.c

@@ -1,4 +1,13 @@
 #include "ic4.h"
+#include "../../helpers/interval.h"
+
+void __attribute__((__interrupt__, no_auto_psv)) _IC4Interrupt(void) {
+    SetDefaultDIGITAL_STATES();
+    IC4_Stop();
+    IC4_InterruptFlagClear();
+    IC4_InterruptDisable();
+    SetDefaultDIGITAL_STATES_ERROR();
+}
 
 void IC4_Initialize(void) {
     IC4_InitializeCON1();

pslab-core.X/registers/system/interrupt_manager.c

@@ -17,11 +17,11 @@ void __attribute__((__interrupt__, no_auto_psv)) _CNInterrupt(void) {
         INTERRUPT_LA2PinChange(DISABLE);
         INTERRUPT_LA3PinChange(DISABLE);
         INTERRUPT_LA4PinChange(DISABLE);
-        
         INTERRUPT_DisablePinChangeInterrupts();
+        
+        TMR2_Start();
         SetDefaultDIGITAL_STATES();
         IC_PARAMS_ManualTriggerAll();
-        TMR2_Start();
         SetDefaultDIGITAL_STATES_ERROR();
     }
     INTERRUPT_ClearPinChangeInterruptsFlag();