Updated review comments

jasminefrancisca · jasminefrancisca · commit 1b49e8a62a5e · 2022-04-07T22:53:17.000+05:30
diff --git a/dspic33e-adc-altsamp/.main-meta/main.json b/dspic33e-adc-altsamp/.main-meta/main.json
@@ -10,7 +10,7 @@
       "shortDescription":"ADC Alternate Sampling",
       "ide":{
          "name":"MPLABX",
-         "semverRange":">=5.50.0"
+         "semverRange":">=6.00"
       },
       "compiler":{
          "name":"XC16",
diff --git a/dspic33e-adc-altsamp/README.md b/dspic33e-adc-altsamp/README.md
@@ -25,11 +25,11 @@ Next, DMA uses DMA0STB base address to store the ADC samples and it generates in
 after transfer (TWO x 16 samples = 32 samples).
 Above process repeats continuously. 
 
-void __attribute__((__interrupt__)) _DMA0Interrupt(void);
+void \_\_attribute\_\_((\_\_interrupt\_\_)) _DMA0Interrupt(void);<br/>
 DMA interrupt service routine, moves the data from DMA buffer to ADC signal buffer 
 
-Timer time outs at 60M/(4999+1) = 12000 Hz.
-DMA interrupt @ 12K/32=  375 Hz.
+Timer time outs at 60M/(4999+1) = 12000 Hz.<br/>
+DMA interrupt @ 12K/32=  375 Hz.<br/>
 I/O pin toggles at 375/2= 187 Hz.
 
 RA4 pin is toggled in ISR, hence it will be toggling at ~ 187Hz
@@ -44,6 +44,6 @@ RA4 pin is toggled in ISR, hence it will be toggling at ~ 187Hz
 	
 ## Software Used 
 
-- MPLAB� X IDE v5.50 or newer (https://www.microchip.com/mplabx)
-- MPLAB� XC16 v1.70 or newer (https://www.microchip.com/xc)
+- MPLAB� X IDE v6.00 or newer (https://www.microchip.com/mplabx)
+- MPLAB� XC16 v2.00 or newer (https://www.microchip.com/xc)
 
diff --git a/dspic33e-adc-chscan-no-dma/.main-meta/main.json b/dspic33e-adc-chscan-no-dma/.main-meta/main.json
@@ -10,7 +10,7 @@
       "shortDescription":"ADC Channel Scanning without DMA",
       "ide":{
          "name":"MPLABX",
-         "semverRange":">=5.50.0"
+         "semverRange":">=6.00"
       },
       "compiler":{
          "name":"XC16",
diff --git a/dspic33e-adc-chscan-no-dma/README.md b/dspic33e-adc-chscan-no-dma/README.md
@@ -13,7 +13,7 @@ It will take FOUR Timer3 Timeout period to scan through all the FOUR Analog inpu
 ADC module clock time period is configured as Tad=Tcy*(ADCS+1)= (1/40M)*64 = 1.6us (625Khz). 
 Hence the conversion time for 10-bit A/D Conversion Time Tc=12*Tad = 19.2us
 
-void __attribute__((__interrupt__)) _ADC1Interrupt(void)
+void \_\_attribute\_\_((\_\_interrupt\_\_)) _ADC1Interrupt(void)
 ADC ISR sorts out the data and stores the converted data in separated buffers.
 ISR rate will be 8Khz, RA6 pin is toggled in ISR, hence it will be toggling at ~ 4Khz
 
@@ -26,6 +26,6 @@ ISR rate will be 8Khz, RA6 pin is toggled in ISR, hence it will be toggling at ~
 	
 ## Software Used 
 
-- MPLAB� X IDE v5.50 or newer (https://www.microchip.com/mplabx)
-- MPLAB� XC16 v1.70 or newer (https://www.microchip.com/xc)
+- MPLAB� X IDE v6.00 or newer (https://www.microchip.com/mplabx)
+- MPLAB� XC16 v2.00 or newer (https://www.microchip.com/xc)
 
diff --git a/dspic33e-adc-chscan/.main-meta/main.json b/dspic33e-adc-chscan/.main-meta/main.json
@@ -10,7 +10,7 @@
       "shortDescription":"ADC Channel Scanning",
       "ide":{
          "name":"MPLABX",
-         "semverRange":">=5.50.0"
+         "semverRange":">=6.00"
       },
       "compiler":{
          "name":"XC16",
diff --git a/dspic33e-adc-chscan/README.md b/dspic33e-adc-chscan/README.md
@@ -24,7 +24,7 @@ Next, DMA uses DMA0STB base address to store the ADC samples and it generates in
 after transfer (4 x 8 samples = 31 samples).
 Above process repeats continuously. 
 
-void __attribute__((__interrupt__)) _DMA0Interrupt(void);
+void \_\_attribute\_\_((\_\_interrupt\_\_)) _DMA0Interrupt(void);
 DMA interrupt service routine, moves the data from DMA buffer to ADC signal buffer 
 
 
@@ -41,6 +41,6 @@ RA4/RA6 pin is toggled in ISR, hence it will be toggling at ~ 187Hz where device
 	
 ## Software Used 
 
-- MPLAB� X IDE v5.50 or newer (https://www.microchip.com/mplabx)
-- MPLAB� XC16 v1.70 or newer (https://www.microchip.com/xc)
+- MPLAB� X IDE v6.00 or newer (https://www.microchip.com/mplabx)
+- MPLAB� XC16 v2.00 or newer (https://www.microchip.com/xc)
 
diff --git a/dspic33e-adc-in-sleep/.main-meta/main.json b/dspic33e-adc-in-sleep/.main-meta/main.json
@@ -10,7 +10,7 @@
       "shortDescription":"ADC Conversion in Sleep mode",
       "ide":{
          "name":"MPLABX",
-         "semverRange":">=5.50.0"
+         "semverRange":">=6.00"
       },
       "compiler":{
          "name":"XC16",
diff --git a/dspic33e-adc-in-sleep/README.md b/dspic33e-adc-in-sleep/README.md
@@ -9,12 +9,11 @@ Start of conversion is issued in the background loop and device enters sleep mod
 
 When the ADC conversion is completed in sleep mode, it wakes up the device and enters ADC ISR.
 
-
-void initAdc1(void);
+void initAdc1(void);<br/>
 ADC CH0 is set-up to covert AIN5 in 10-bit mode. ADC is configured to next sample data immediately after the conversion.
 But the start of conversion is issued manually in the background loop.
 
-void _ADC1Interrupt()
+void _ADC1Interrupt()<br/>
 Device enters the ADC ISR after waking up from sleep mode. ADC result is read in the ISR and PORTA (RA4) pin is toggled.
 
 
@@ -26,6 +25,6 @@ Device enters the ADC ISR after waking up from sleep mode. ADC result is read in
 	
 ## Software Used 
 
-- MPLAB� X IDE v5.50 or newer (https://www.microchip.com/mplabx)
-- MPLAB� XC16 v1.70 or newer (https://www.microchip.com/xc)
+- MPLAB� X IDE v6.00 or newer (https://www.microchip.com/mplabx)
+- MPLAB� XC16 v2.00 or newer (https://www.microchip.com/xc)
 
diff --git a/dspic33e-addr-err-trap/.main-meta/main.json b/dspic33e-addr-err-trap/.main-meta/main.json
@@ -10,7 +10,7 @@
       "shortDescription":"Address Error Traps for Easy Debugging",
       "ide":{
          "name":"MPLABX",
-         "semverRange":">=5.50.0"
+         "semverRange":">=6.00"
       },
       "compiler":{
          "name":"XC16",
diff --git a/dspic33e-addr-err-trap/README.md b/dspic33e-addr-err-trap/README.md
@@ -8,18 +8,18 @@ Microchip's 16-bit dsPIC
 take corrective action. Specifically, the ability to detect memory addressing errors is provided by means of 
 automatic Address Error Trap detection. Memory addressing errors may be caused by one of the following:
 
-a. A misaligned data word fetch is attempted. This condition occurs when an instruction performs a word 
+1.A misaligned data word fetch is attempted. This condition occurs when an instruction performs a word 
    access with the LSb of the effective address set to �1�. The dsPIC33E CPU requires all word accesses to 
    be aligned to an even address boundary.
 
-b. A bit manipulation instruction using the Indirect Addressing mode with the LSb of the effective address set to �1�.
+2.A bit manipulation instruction using the Indirect Addressing mode with the LSb of the effective address set to �1�.
 
-c. A data fetch from unimplemented data address space is attempted.
+3.A data fetch from unimplemented data address space is attempted.
 
-d. Execution of a �BRA #literal� instruction or a �GOTO #literal� instruction, where literal is an unimplemented 
+4.Execution of a �BRA #literal� instruction or a �GOTO #literal� instruction, where literal is an unimplemented 
    program memory address.
 
-e. Executing instructions after modifying the PC to point to unimplemented program memory addresses. 
+5.Executing instructions after modifying the PC to point to unimplemented program memory addresses. 
    The PC may be modified by loading a value into the stack and executing a RETURN instruction.
 
 If the application defines an Address Error Trap service routine (trap handler), the processor will vector to the 
@@ -39,6 +39,6 @@ an address error trap to occur. The compiler/assembler will also detect address
 	
 ## Software Used 
 
-- MPLAB� X IDE v5.50 or newer (https://www.microchip.com/mplabx)
-- MPLAB� XC16 v1.70 or newer (https://www.microchip.com/xc)
+- MPLAB� X IDE v6.00 or newer (https://www.microchip.com/mplabx)
+- MPLAB� XC16 v2.00 or newer (https://www.microchip.com/xc)
 
diff --git a/dspic33e-ecan-crosswire/.main-meta/main.json b/dspic33e-ecan-crosswire/.main-meta/main.json
@@ -10,7 +10,7 @@
       "shortDescription":"Crosswire Communication between CAN 1 and CAN 2 modules",
       "ide":{
          "name":"MPLABX",
-         "semverRange":">=5.50.0"
+         "semverRange":">=6.00"
       },
       "compiler":{
          "name":"XC16",
diff --git a/dspic33e-ecan-crosswire/README.md b/dspic33e-ecan-crosswire/README.md
@@ -4,29 +4,65 @@
 
 ## Description:
 
-The following boards are used for developing this code example
-Explorer 16 Development Board
-ECAN PicTail Card
+Crosswire Communication between ECAN 1 and ECAN 2 modules
 
-Connections to be done on the ECANPicTail Card - The Tx line of ECAN1 is connected to the Rx line of ECAN2 
-and the Tx line of ECAN2 is connected to the Rx line of ECAN1. 
+4 Message Buffers are defined for ECAN1 and ECAN2
 
-Alternatively a simple 2 node (ECAN1 and ECAN2) CAN BUS can be implemented using a twisted wire pair. This twisted wire pair must be connected at the output of the transcievers. Jumpers J7 and J6 must be set.
+Two message buffers are configured for ECAN1. One is configured as a Transmit Buffer to generate a Data Frame.
+The other is configured as a Receive Buffer to receive message sent by ECAN2.
 
-MPLLAB ICD3 Debugger/Programmer is used for debugging and running this code example.
+Two message buffers are configured for ECAN2. One is configured as a Transmit Buffer to generate a Data Frame.
+The other is configured as a Receive Buffer to receive message sent by ECAN1.
 
-b. dsPIC33EP256GP506
-The following boards are used for developing this code example
+Filters and Masks are enabled for both ECAN1 and ECAN2 for Message Reception
 
-Explorer 16 Development Board
-CAN BUS Analyzer
+In this code example, the ECAN1 and ECAN2 modules are configured for operation at 1 Mbps over the CAN bus.
+This is done in the main.c file.
 
-Connect ECAN1 of 506 device to CAN Bus Analyzer.
-Press switch S3 on explorer 16 board to transmit ECAN message. Similarly transmit ecan message
-from CAN bus analyzer and observe the received message in rx_ecan1message buffer.
+The configuration of the two ECAN modules is done in the ECAN1Config.c and ECAN2Config.c files.
 
-MPLAB ICD3 Debugger/Programmer is used for debugging and running this code example.
+The number of message buffers to be allocated in DMA RAM are configured by using the following definitions
+in the ECAN1Config.h and ECAN2Config.h file.
 
+#define  ECAN1_MSG_BUF_LENGTH <br/>
+#define  ECAN2_MSG_BUF_LENGTH <br/>
+
+The aligment attribute is used to make sure that the DMA allocates the base address for the peripheral
+correctly and assigns an offset based on this base address. This is essential when using peripheral indirect
+addressing mode of DMA, where the effective address is computed based on the base address partially and an 
+address generated by the peripheral. (in this case ECAN).
+
+\_\_attribute\_\_((eds,space(dma),aligned(Number of bytes)));
+
+The number of bytes may be decided based on the number of buffers being configured by the definition made earlier.
+This is calculated as follows -
+
+Number of bytes = (ECAN1_MSG_BUF_LENGTH * Number of words in one buffer)*2 and <br/>
+Number of bytes = (ECAN2_MSG_BUF_LENGTH * Number of words in one buffer)*2.
+
+For eg : If 4 message buffers are defined as
+
+#define  ECAN1_MSG_BUF_LENGTH 4, then,<br/>
+Number of bytes = 4 * 8 * 2 = 64 (because Number of words in one buffer = 8 for ECAN).
+
+The information on transmit message identifiers and other bits are written as arguments into these functions
+
+ecan1TransmitMsg(unsigned int buf, long txIdentifier, unsigned int ide, unsigned int remoteTransmit, unsigned int srr, unsigned int dataLength );<br/>
+ecan1TxData(unsigned int buf, unsigned int data1, unsigned int data2, unsigned int data3, unsigned int data4);<br/>
+ecan2TransmitMsg(unsigned int buf, long txIdentifier, unsigned int ide, unsigned int remoteTransmit, unsigned int srr, unsigned int dataLength );<br/>
+ecan2TxData(unsigned int buf, unsigned int data1, unsigned int data2, unsigned int data3, unsigned int data4);<br/>
+
+The information on message acceptance filters and masks are written as arguments into these function
+
+ecan1Filter(int n, long identifier, unsigned int exide,unsigned int bufPnt,unsigned int maskSel);<br/>
+ecan1Mask(int m, long identifierMask, unsigned int mide);<br/>
+ecan2Filter(int n, long identifier, unsigned int exide,unsigned int bufPnt,unsigned int maskSel);<br/>
+ecan2Mask(int m, long identifierMask, unsigned int mide);<br/>
+
+Note :-
+a. The PPS configuration in the ecan1_config.c and ecan2_config.c source files change with the device being used. THe user is advised
+to refer the datasheet and use the appropriate values for RPINR/RPOR registers for proper operation.
+b.  dsPIC33EP256GP506 device has only one ECAN node. So CAN Analyzer is used as another node here.
 
 ## Hardware Used
 
@@ -36,6 +72,6 @@ MPLAB ICD3 Debugger/Programmer is used for debugging and running this code examp
 	
 ## Software Used 
 
-- MPLAB� X IDE v5.50 or newer (https://www.microchip.com/mplabx)
-- MPLAB� XC16 v1.70 or newer (https://www.microchip.com/xc)
+- MPLAB� X IDE v6.00 or newer (https://www.microchip.com/mplabx)
+- MPLAB� XC16 v2.00 or newer (https://www.microchip.com/xc)
 
diff --git a/dspic33e-ecan-fifo/.main-meta/main.json b/dspic33e-ecan-fifo/.main-meta/main.json
@@ -10,7 +10,7 @@
       "shortDescription":"Transmitting multiple messages from CAN1 and receiving it in CAN2 FIFO",
       "ide":{
          "name":"MPLABX",
-         "semverRange":">=5.50.0"
+         "semverRange":">=6.00"
       },
       "compiler":{
          "name":"XC16",
diff --git a/dspic33e-ecan-fifo/README.md b/dspic33e-ecan-fifo/README.md
@@ -4,71 +4,62 @@
 
 ## Description:
 
-Transmitting 6 messages from ECAN1 and receiving it in ECAN2 FIFO
+Transmitting 6 messages from ECAN1 and receiving it in ECAN2 FIFO<br/>
 Transmitting 6 messages from ECAN2 and receiving it in ECAN1 FIFO
 
 32 Buffers are defined for ECAN1 and ECAN2
 
-
 Six message buffers are configured for ECAN1. All are configured as a Transmit Buffers to generate Data Frames.
 The reception of messages from ECAN2 is in FIFO.
 
 Six message buffers are configured for ECAN2. All are configured as a Transmit Buffers to generate Data Frames.
 The reception of messages from ECAN1 is in FIFO.
 
 Filters and Masks are enabled for both ECAN1 and ECAN2 for Message Reception in FIFO area.
-----------------------------------------------------------------------------------------------------------------
-
-
-
 
 In this code example, the ECAN1 and ECAN2 modules are configured for operation at 1 Mbps over the CAN bus.
 This is done in the main.c file.
 
-
 The configuration of the two ECAN modules is done in the ECAN1Config.c and ECAN2Config.c files.
 
-
 The number of message buffers to be allocated in DMA RAM are configured by using the following definitions
 in the ECAN1Config.h and ECAN2Config.h file.
 
-#define  ECAN1_MSG_BUF_LENGTH
+#define  ECAN1_MSG_BUF_LENGTH<br/>
 #define  ECAN2_MSG_BUF_LENGTH
 
 The alignment attribute is used to make sure that the DMA allocates the base address for the peripheral
 correctly and assigns an offset based on this base address. This is essential when using peripheral indirect
 addressing mode of DMA, where the effective address is computed based on the base address partially and an 
 address generated by the peripheral. (in this case ECAN).
 
-__attribute__((eds,space(dma),aligned(Number of bytes)));
+\_\_attribute\_\_((eds,space(dma),aligned(Number of bytes)));
 
 The number of bytes may be decided based on the number of buffers being configured by the definition made earlier.
 This is calculated as follows -
 
-Number of bytes = (ECAN1_MSG_BUF_LENGTH * Number of words in one buffer)*2 and
+Number of bytes = (ECAN1_MSG_BUF_LENGTH * Number of words in one buffer)*2 and <br/>
 Number of bytes = (ECAN2_MSG_BUF_LENGTH * Number of words in one buffer)*2.
 
 For eg : If 4 message buffers are defined as
 
-#define  ECAN1_MSG_BUF_LENGTH 4, then,
+#define  ECAN1_MSG_BUF_LENGTH 4, then,<br/>
 Number of bytes = 4 * 8 * 2 = 64 (because Number of words in one buffer = 8 for ECAN).
 
 The information on transmit message identifiers and other bits are written as arguments into these functions
 
 
-ecan1TransmitMsg(unsigned int buf, long txIdentifier, unsigned int ide, unsigned int remoteTransmit, unsigned int srr, unsigned int dataLength );
-ecan1TxData(unsigned int buf, unsigned int data1, unsigned int data2, unsigned int data3, unsigned int data4);
-ecan2TransmitMsg(unsigned int buf, long txIdentifier, unsigned int ide, unsigned int remoteTransmit, unsigned int srr, unsigned int dataLength );
-ecan2TxData(unsigned int buf, unsigned int data1, unsigned int data2, unsigned int data3, unsigned int data4);
-
+ecan1TransmitMsg(unsigned int buf, long txIdentifier, unsigned int ide, unsigned int remoteTransmit, unsigned int srr, unsigned int dataLength );<br/>
+ecan1TxData(unsigned int buf, unsigned int data1, unsigned int data2, unsigned int data3, unsigned int data4);<br/>
+ecan2TransmitMsg(unsigned int buf, long txIdentifier, unsigned int ide, unsigned int remoteTransmit, unsigned int srr, unsigned int dataLength );<br/>
+ecan2TxData(unsigned int buf, unsigned int data1, unsigned int data2, unsigned int data3, unsigned int data4);<br/>
 
 The information on message acceptance filters and masks are written as arguments into these function
 
-
-ecan1Filter(int n, long identifier, unsigned int exide,unsigned int bufPnt,unsigned int maskSel);
-ecan1Mask(int m, long identifierMask, unsigned int mide);
-ecan2Filter(int n, long identifier, unsigned int exide,unsigned int bufPnt,unsigned int maskSel);
-ecan2Mask(int m, long identifierMask, unsigned int mide);
+ecan1Filter(int n, long identifier, unsigned int exide,unsigned int bufPnt,unsigned int maskSel);<br/>
+ecan1Mask(int m, long identifierMask, unsigned int mide);<br/>
+ecan2Filter(int n, long identifier, unsigned int exide,unsigned int bufPnt,unsigned int maskSel);<br/>
+ecan2Mask(int m, long identifierMask, unsigned int mide);<br/>
 
 Note :- The PPS configuration in the ecan1_config.c and ecan2_config.c source files change with the device being used. THe user is advised
 to refer the datasheet and use the appropriate values for RPINR/RPOR registers for proper operation.
@@ -80,6 +71,6 @@ to refer the datasheet and use the appropriate values for RPINR/RPOR registers f
 	
 ## Software Used 
 
-- MPLAB� X IDE v5.50 or newer (https://www.microchip.com/mplabx)
-- MPLAB� XC16 v1.70 or newer (https://www.microchip.com/xc)
+- MPLAB� X IDE v6.00 or newer (https://www.microchip.com/mplabx)
+- MPLAB� XC16 v2.00 or newer (https://www.microchip.com/xc)
 
diff --git a/dspic33e-ecan-rtr/.main-meta/main.json b/dspic33e-ecan-rtr/.main-meta/main.json
@@ -10,7 +10,7 @@
       "shortDescription":"Transmitting a Remote message from CAN1 and requesting TX from CAN2",
       "ide":{
          "name":"MPLABX",
-         "semverRange":">=5.50.0"
+         "semverRange":">=6.00"
       },
       "compiler":{
          "name":"XC16",
diff --git a/dspic33e-ecan-rtr/README.md b/dspic33e-ecan-rtr/README.md
diff --git a/dspic33e-eds-auto/.main-meta/main.json b/dspic33e-eds-auto/.main-meta/main.json
diff --git a/dspic33e-eds-auto/README.md b/dspic33e-eds-auto/README.md
diff --git a/dspic33e-eds-manual/.main-meta/main.json b/dspic33e-eds-manual/.main-meta/main.json
diff --git a/dspic33e-eds-manual/README.md b/dspic33e-eds-manual/README.md
diff --git a/dspic33e-ext-intr/.main-meta/main.json b/dspic33e-ext-intr/.main-meta/main.json
diff --git a/dspic33e-ext-intr/README.md b/dspic33e-ext-intr/README.md
