MPAE-19111 updating readme and metadata files for upgrade to XC8 v3.0 and latest MCC

Author: CoffeeConsumer

.main-meta/main.json

@@ -4,27 +4,27 @@
     "content": {
         "metaDataVersion": "1.3.0",
         "name": "com.microchip.mcu8.mplabx.project.pic18f57q43-dma-uart-to-pwm-part2",
-        "version": "2.0.0",
+        "version": "3.0.0",
         "displayName": "DMA controlled LED dimming via Serial Stream",
         "projectName": "pic18f57q43-dma-uart-to-pwm-part2",
         "shortDescription": "Part 2 example showing how to use DMA to transfer data from UART recieve buffer to PWM duty cycle register to control a PWM.",
         "ide": {
             "name": "MPLAB X",
-            "semverRange": ">=6.15.0"
+            "semverRange": "^6.2.0"
         },
         "compiler": [
 			{
 				"name": "XC8",
-				"semverRange": "^2.45.0"
+				"semverRange": "^3.0.0"
 			}
 		],
         "dfp": {
             "name": "PIC18-Q_DFP",
-            "semverRange": "^1.3.89"
+            "semverRange": "^1.26.442"
         },
         "configurator": {
             "name": "MCC",
-            "semverRange": ">=5.5.7"
+            "semverRange": ">=5.7.1"
         },
         "device": {
             "metaDataVersion": "1.0.0",

README.md

@@ -28,11 +28,11 @@ This is part 2 of 2 of an example showing how to set up [Direct Memory Access (D
 ## Software Used
 
 All software used in this example is listed here:
-- [MPLAB® X IDE 5.30](https://www.microchip.com/mplab/mplab-x-ide?utm_campaign=PIC18FQ43&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=pic18f57q43-dma-uart-to-pwm-part2-MCU8_MMTCha) or newer
-- [MPLAB® XC8 2.10 compiler](https://www.microchip.com/mplab/compilers?utm_campaign=PIC18FQ43&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=pic18f57q43-dma-uart-to-pwm-part2-MCU8_MMTCha) or newer
-- [MPLAB® Code Configurator (MCC) 3.95.0](https://www.microchip.com/mplab/mplab-code-configurator?utm_campaign=PIC18FQ43&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=pic18f57q43-dma-uart-to-pwm-part2-MCU8_MMTCha) or newer
+- [MPLAB® X IDE 6.20](https://www.microchip.com/mplab/mplab-x-ide?utm_campaign=PIC18FQ43&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=pic18f57q43-dma-uart-to-pwm-part2-MCU8_MMTCha) or newer
+- [MPLAB® XC8 3.00 compiler](https://www.microchip.com/mplab/compilers?utm_campaign=PIC18FQ43&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=pic18f57q43-dma-uart-to-pwm-part2-MCU8_MMTCha) or newer
+- [MPLAB® Code Configurator (MCC) 5.7.1](https://www.microchip.com/mplab/mplab-code-configurator?utm_campaign=PIC18FQ43&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=pic18f57q43-dma-uart-to-pwm-part2-MCU8_MMTCha) or newer
   - [MCC Device Libraries PIC10 / PIC12 / PIC16 / PIC18 MCUs](https://www.microchip.com/mplab/mplab-code-configurator?utm_campaign=PIC18FQ43&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=pic18f57q43-dma-uart-to-pwm-part2-MCU8_MMTCha)
-- [Microchip PIC18F-Q Series Device Support (1.4.109)](https://www.microchip.com/mplab/mplab-code-configurator?utm_campaign=PIC18FQ43&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=pic18f57q43-dma-uart-to-pwm-part2-MCU8_MMTCha) or newer
+- [Microchip PIC18F-Q Series Device Support (1.26.442)](https://www.microchip.com/mplab/mplab-code-configurator?utm_campaign=PIC18FQ43&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=pic18f57q43-dma-uart-to-pwm-part2-MCU8_MMTCha) or newer
 
 ## Hardware Used
 - **PIC18F57Q43 Curiosity Nano** [(DM164150)](https://www.microchip.com/Developmenttools/ProductDetails/DM164150?utm_campaign=PIC18FQ43&utm_source=GitHub&utm_medium=hyperlink&utm_term=&utm_content=pic18f57q43-dma-uart-to-pwm-part2-MCU8_MMTCha)
@@ -71,76 +71,92 @@ As noted before - this is part 2 of 2 of an example showing how to set up [Direc
 4. In **Choose Project** window
    1. Select **Microchip Embedded** category
    2. Select **Standalone Project**
-   3. Hit **Next>**
+   3. Click **Next>**
 5. In **Select Device** window
    1. Select **PIC18F57Q43** as your device
    2. Pro-tip: quickly filter for devices by inputting the last 3-4 characters of the device name and then selecting from the drop-down list (e.g. Q43).
-   3.  Hit **Next>**
+   3.  Click **Next>**
 6.  In **Select Tool (Optional)** window
     1.  If device is connected – select Microchip Kits -> PIC18F57Q43 Curiosity Nano (PKOB nano)
     2.  If not, you can do this later when programming the device.
-    3.  Hit **Next>**
+    3.  Click **Next>**
 7.  In **Select Compiler** window
-    1.  Select XC8 (v2.10)
-    2.  Hit **Finish**
+    1.  Select XC8 (v3.00)
+    2.  Click **Finish**
 
 ### Configure MCC
-8. In **System Module** window
-9. Set **Oscillator Select** to **HFINTOSC**
+8. In **Project Resources** under **System** select **Clock Control**
+9. In **Clock Control** tab, set Clock Source to **HFINTOSC**
     1. While this example uses a system clock of 1MHz, it should be noted that any larger value for the system clock should provide similar results.
-10. Under **Device Resources** left-hand pane
-    1.  Open the **Peripherals** drop-down
-    2.  Double-click the (PIC10/PIC12/…) instance of the PWM and USART3 peripherals to add them your project.
 
 ![](images/configure-system-clock.jpg)
 
-11. In UART window/tab
-    1.  Set baud rate to 9600
+10. In **Project Resources** under **System** select **Configuration Bits**
+    1. In the **Configuration Bits** tab, choose **Oscillator not enabled** under **External Oscillaotr Selection**
+    2. Under **Reset Oscillator Selection** choose **HFINTOSC with HFFRQ = 4 MHz and CDIV = 4:1**
+
+
+11. Under **Device Resources** left-hand pane
+    1.  Open the **Drivers** drop-down
+    2.  Double-click **PWM1_16BIT** under the **PWM** drop-down to add it to your project.
+    3.  Double-click **UART3** under the **UART** drop-down to add it to your project.
+
+
+12. Click on **UART3** under the **Project Resources** pane 
+    1.  In the **UART** tab, set baud rate to 9600
 
 ![](images/configure-uart3.jpg)
 
-12. In the **PWM window** / Easy Setup tab
-    1.  Check the box next to **Enable PWM**
-    2.  In the **Registers tab**, Set **PWM1LDS to DMA1**
-    3.  **Warning:** Make this change only after doing the previous step where you configure the model in the Easy Setup window.
+13. In the **PWM1_16BIT window** / Easy Setup tab
+    1. Check the Slider next to **Enable PWM**
+    2. Choose **Left aligned mode** under the **Mode** drop-down      
+    3. Set the **Requested Frequency** to 1 KHz 
 
 ![](images/mcc-configure-pwm-easy-view.jpg)
 
-![](images/mcc-configure-pwm-register.jpg)
 
-13. In the **Pin Manager: Grid View** window, connect pins:
-    1.  RX3 -> A4
-    2.  TX3 -> A3 (not needed necessarily since we are just receiving)
-    3.  PWM -> RF3 (pin tied to CNano board LED0 as per schematic)
+14. In the **Pin Manager: Grid View** window, connect pins:
+    1. RX3 -> RA4
+    2. PWM -> RF3 (pin tied to CNano board LED0 as per schematic)
+    3. Select **Pins** under the **System** drop-down in **Project Resources**
+    4. Make sure that the **Analog** option for RA4 and RF3 is un-checked
 
 ![](images/mcc-configure-pin-manager-gridview.jpg)
+![](images/pinsview.jpg)
 
-14. In the **DMA window** manager
-    1.  Enable DMA CHANNEL 1 and make the changes shown in the table and screenshot below with explanations
 
-|     | Module    | Region | SFR     | VarName | VarSize | Address | Mode      | Message Size | Start Trigger | Abort Trigger |
-|-----|-----------|--------|---------|---------|---------|---------|-----------|--------------|---------------|---------------|
-| Src | UART3     | SFR    | U3RXB   | -       | -       | -       | unchanged | 1            | U3RX          | None          |
-| Dst | PWM_16bit | SFR    | PWMS1P1 | -       | -       | -       | increment | 2            | (see above)   | (see above)   |
+15. Choose **DMA1** under **Device Resources**
+     1. In the **DMA1** tab, select **DMA Enable**
+     2. Choose the **Start Trigger** as **U3RX**
+     3. Turn on **Start Trigger Enable**
+     4. Choose **SFR**, **UART3**, **U3RXB** for **Source Region**, **Source Module**, and **Source SFR** respectively
+     5. Choose **Source Mode** as unchanged
+     6. Set **Source Message Size** to **1**
+     7. Choose **SFR**, **PWM1_16BIT**, and **PWM1S1P1L** for **Destination Region**, **Destination Module** and **Destination SFR** respectively
+     8. Set **Destination Mode** to **incremented**
+     9. Set **Destination Message Size** to **2**  
 
 
-![](images/configure-dma-1.jpg)
 
-![](images/configure-dma-2.jpg)
+![](images/configure-dma-1.jpg)
 
-![](images/configure-dma-3.jpg)
 
-15. What we just did:
+16. What we just did:
     1.  **UART3** is the data **source module** of DMA channel 1
     2.  **U3RXB** is the **SFR (Special function register) region** that we want data to be sourced from.
     3.  The **U3RXB SFR register is 1-byte**, therefore the **mode is unchanged** since we don’t need to increment over multiple bytes or registers.
     4.  Similarly, the **UART RX Buffer is 1-byte**, so we need to indicate that the **message size is 1-byte**
     5.  **PWM1_16bit** is the data destination module, with the **PWM1S1P1L** being the specific destination SFR.
-    6.  The PWM period register is 16-bits, meaning we will need to **increment** in order to load both the low register that we started with and the PWM1S1P1H (high), which also means our **message size is 2**-bytes since we are loading two 8-bit registers.
+    6.  The PWM period register is 16-bits, meaning we will need to **increment** in order to load both the low register that we started with and the PWM1S1P1H (high), which also means our **message size** is 2 bytes since we are loading two 8-bit registers.
     7.  Set the DMA **start trigger** to fire every time the RX Buffer is full (**U3RX**).
-    8.  **NOTE**** - we did not need to set VarSize, VarName, and Address parameters as these are only required when working with user-defined values in memory as opposed to fixed SFRs in this case.
-16. Hit **Generate Project** and
-17. Hit **Program the device** ![](images/program-device-icon.png)
+    8.  **NOTE*** we did not need to set VarSize, VarName, and Address parameters as these are only required when working with user-defined values in memory as opposed to fixed SFRs in this case.
+17. Click **Generate Project** 
+18. In the `main.c` file that was generated, add the following line of code before `while(1)`:
+    <br>
+     `PWM1LDS = 0xB;   // PWM1 auto-load trigger source is DMA1_Destination_Count_Done`
+    This allows the PWM regsiter to be automatically loaded when the DMA transfer is complete.
+
+19. Click **Program the device** ![](images/program-device-icon.png)
 
 ## Conclusion
-There you have it. You just implemented some systems coms, automatic memory operations, and waveform without writing any lines of code. Feel free to build on the project as you see fit, find more detailed applications in the documents linked in the [**resource section**](#related-documentation), or check out other code examples in the repo.
+There you have it. You just implemented some systems coms, automatic memory operations, and waveform while only having to write one line of code. Feel free to build on the project as you see fit, find more detailed applications in the documents linked in the [**resource section**](#related-documentation), or check out other code examples in the repo.