MPAE-10376: Initial Commit

Author: robertperkel

README.md

@@ -54,7 +54,7 @@ Note: Value of the resistor depends on the desired brightness, wavelength, and o
 
 Note: To Reverse Direction, Swap "A" and "B" lines on the encoder.
 
-### Encoder Wiring and Setup
+### Encoder Wiring and Demo Setup
 
 Depending on the encoder, the specific circuit required for proper operation will vary. The manufacturer of the device will specify the circuits required to interface with the device.
 
@@ -156,5 +156,13 @@ To prevent invalid reads, this example uses TMR1 and TMR3 in 16-bit read mode to
 
 To find the net direction of rotation, subtract the net change of one of the timers from the other. The sign of this value indicates whether the encoder is turning clockwise or counter-clockwise. The magnitude of this value represents (approximately) how far it has rotated.
 
+### CLC Implementation
+
+![CLC1 Image](./images/CLC1.png)  
+*Figure 11 - CLC 1 Implementation*
+
+![CLC1 Image](./images/CLC2.png)  
+*Figure 12 - CLC 2 Implementation*  
+
 ## Summary
 In this example, a quadrature decoder was almost entirely implemented in hardware on the PIC18F16Q40 device. This implementation minimizes the amount of software required, freeing up the CPU to perform other tasks. This code example can be easily tailored for a specific application. The only requirements to implement the quadrature decoder (with no physical outputs or indicators) are 2 CLCs, TMR1, TMR2, and TMR3.

images/clc1.png

@@ -3,7 +3,7 @@
 #include <stdint.h>
 #include <stdbool.h>
 
-#include "mcc_generated_files/mcc.h"
+#include "mcc_generated_files/system/system.h"
 
 //Net Encoder Change (in Pulses)
 static volatile int16_t encoder;
@@ -17,6 +17,20 @@ void initEncoders(void)
     newEncoder = false;
 }
 
+uint16_t getAsyncTimer1Value(void)
+{
+    uint16_t t = TMR1L;    
+    t |= (TMR1H << 8);
+    return t;
+}
+
+uint16_t getAsyncTimer3Value(void)
+{
+    uint16_t t = TMR3L;    
+    t |= (TMR3H << 8);
+    return t;
+}
+
 void readTMRs_ISR(void)
 {
     static volatile uint16_t old_TMR1 = 0;
@@ -25,8 +39,8 @@ void readTMRs_ISR(void)
     uint16_t new_TMR1, new_TMR3, net_TMR1, net_TMR3;
 
     //Get Current Values
-    new_TMR1 = TMR1_ReadTimer();
-    new_TMR3 = TMR3_ReadTimer();
+    new_TMR1 = getAsyncTimer1Value();
+    new_TMR3 = getAsyncTimer3Value();
 
     //Zero out the net change
     net_TMR1 = 0;

images/clc2.png

@@ -46,7 +46,21 @@ extern "C" {
      * readTMRs_ISR. 
      *  */
     int16_t getNewEncoderValue(void);
-
+    
+    /** 
+     * <B><FONT COLOR=BLUE>uint16_t</FONT> getAsyncTimer1Value(<FONT COLOR=BLUE>void</FONT>)</B>
+     * 
+     * This function returns the TMR1 count without stopping the timer.
+     *  */
+    uint16_t getAsyncTimer1Value(void);
+    
+    /** 
+     * <B><FONT COLOR=BLUE>uint16_t</FONT> getAsyncTimer3Value(<FONT COLOR=BLUE>void</FONT>)</B>
+     * 
+     * This function returns the TMR3 count without stopping the timer.
+     *  */
+    uint16_t getAsyncTimer3Value(void);
+    
 #ifdef	__cplusplus
 }
 #endif

pic18f16q40-quadrature-decoder.X/config.mc3

@@ -1,51 +1,50 @@
-/**
-  Generated Main Source File
-
-  Company:
-    Microchip Technology Inc.
+/*
+Copyright (c) [2012-2020] Microchip Technology Inc.  
 
-  File Name:
-    main.c
+    All rights reserved.
 
-  Summary:
-    This is the main file generated using PIC10 / PIC12 / PIC16 / PIC18 MCUs
+    You are permitted to use the accompanying software and its derivatives 
+    with Microchip products. See the Microchip license agreement accompanying 
+    this software, if any, for additional info regarding your rights and 
+    obligations.
 
-  Description:
-    This header file provides implementations for driver APIs for all modules selected in the GUI.
-    Generation Information :
-        Product Revision  :  PIC10 / PIC12 / PIC16 / PIC18 MCUs - 1.81.6
-        Device            :  PIC18F16Q40
-        Driver Version    :  2.00
-*/
+    MICROCHIP SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS" WITHOUT 
+    WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT 
+    LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE, NON-INFRINGEMENT 
+    AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL MICROCHIP OR ITS
+    LICENSORS BE LIABLE OR OBLIGATED UNDER CONTRACT, NEGLIGENCE, STRICT 
+    LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER LEGAL EQUITABLE 
+    THEORY FOR ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES INCLUDING BUT NOT 
+    LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES, 
+    OR OTHER SIMILAR COSTS. 
 
-/*
-    (c) 2018 Microchip Technology Inc. and its subsidiaries. 
-    
-    Subject to your compliance with these terms, you may use Microchip software and any 
-    derivatives exclusively with Microchip products. It is your responsibility to comply with third party 
-    license terms applicable to your use of third party software (including open source software) that 
-    may accompany Microchip software.
+    To the fullest extend allowed by law, Microchip and its licensors 
+    liability will not exceed the amount of fees, if any, that you paid 
+    directly to Microchip to use this software. 
     
-    THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER 
-    EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY 
-    IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS 
-    FOR A PARTICULAR PURPOSE.
-    
-    IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, 
-    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND 
-    WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP 
-    HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO 
-    THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL 
-    CLAIMS IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT 
-    OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS 
-    SOFTWARE.
+    THIRD PARTY SOFTWARE:  Notwithstanding anything to the contrary, any 
+    third party software accompanying this software is subject to the terms 
+    and conditions of the third party's license agreement.  To the extent 
+    required by third party licenses covering such third party software, 
+    the terms of such license will apply in lieu of the terms provided in 
+    this notice or applicable license.  To the extent the terms of such 
+    third party licenses prohibit any of the restrictions described here, 
+    such restrictions will not apply to such third party software.
 */
+#include "mcc_generated_files/system/system.h"
 
-#include "mcc_generated_files/mcc.h"
 #include "encoder.h"
 #include "constants.h"
 #include "volume.h"
 
+void __interrupt(irq(U1TX),base(8)) UART_TX_HOTFIX_ISR()
+{
+    UART1_Transmit_ISR();
+}
+
+#define TIMER1_16BIT_ENABLE() do { TMR1CONbits.RD16 = 0b1; } while (0)
+#define TIMER3_16BIT_ENABLE() do { TMR3CONbits.RD16 = 0b1; } while (0)
+
 void main(void)
 {
     // Initialize the device
@@ -56,15 +55,21 @@ void main(void)
     initVolumeControl();
 
     //Start Pulse Counters
-    TMR1_StartTimer();
-    TMR3_StartTimer();
+    TIMER1_16BIT_ENABLE();
+    Timer1_Write(0x0000);
+    Timer1_Start();
+    
+    TIMER3_16BIT_ENABLE();
+    Timer3_Write(0x0000);
+    Timer3_Start();
 
     //Start Polling Timer
-    TMR2_SetInterruptHandler(&readTMRs_ISR);
-    TMR2_StartTimer();
+    Timer2_OverflowCallbackRegister(&readTMRs_ISR);
+    Timer2_Start();
 
     // Enable the Global Interrupts
-    INTERRUPT_GlobalInterruptEnable();
+    INTERRUPT_GlobalInterruptHighEnable();
+    INTERRUPT_GlobalInterruptLowEnable();
 
     //Sum of all encoder values in the period
     int encoderCounter = 0;
@@ -109,7 +114,7 @@ void main(void)
         //Prevent Sleep while transmitting
         if (UART1_is_tx_done())
         {
-            Sleep();
+            //Sleep();
             asm("NOP");
         }
 

pic18f16q40-quadrature-decoder.X/dist/free/production/pic18f16q40-quadrature-decoder.X.production.hex

@@ -0,0 +1,122 @@
+ /**
+   CLC1 Generated Driver API Header File
+ 
+   @Company
+     Microchip Technology Inc. 
+
+   @File Name
+    clc1.h
+
+   @Summary
+     This is the generated header file for the CLC1 driver.
+ 
+   @Description
+     This header file provides APIs for driver for CLC1 driver.
+     Generation Information :
+         Driver Version    :  1.0.0
+     The generated drivers are tested against the following:
+         Compiler          :  XC8 v2.20
+         MPLAB             :  MPLABX v5.40
+ */
+
+/*
+Copyright (c) [2012-2020] Microchip Technology Inc.  
+
+    All rights reserved.
+
+    You are permitted to use the accompanying software and its derivatives 
+    with Microchip products. See the Microchip license agreement accompanying 
+    this software, if any, for additional info regarding your rights and 
+    obligations.
+    
+    MICROCHIP SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS" WITHOUT 
+    WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT 
+    LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE, NON-INFRINGEMENT 
+    AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL MICROCHIP OR ITS
+    LICENSORS BE LIABLE OR OBLIGATED UNDER CONTRACT, NEGLIGENCE, STRICT 
+    LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER LEGAL EQUITABLE 
+    THEORY FOR ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES INCLUDING BUT NOT 
+    LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES, 
+    OR OTHER SIMILAR COSTS. 
+    
+    To the fullest extend allowed by law, Microchip and its licensors 
+    liability will not exceed the amount of fees, if any, that you paid 
+    directly to Microchip to use this software. 
+    
+    THIRD PARTY SOFTWARE:  Notwithstanding anything to the contrary, any 
+    third party software accompanying this software is subject to the terms 
+    and conditions of the third party's license agreement.  To the extent 
+    required by third party licenses covering such third party software, 
+    the terms of such license will apply in lieu of the terms provided in 
+    this notice or applicable license.  To the extent the terms of such 
+    third party licenses prohibit any of the restrictions described here, 
+    such restrictions will not apply to such third party software.
+*/
+
+#ifndef CLC1_H
+ #define CLC1_H
+ 
+ /**
+   Section: Included Files
+ */
+
+#include <xc.h>
+#include <stdint.h>
+#include <stdbool.h>
+
+/**
+  Section: CLC1 APIs
+*/
+
+/**
+  @Summary
+    Initializes the CLC1
+
+  @Description
+    This routine configures the CLC1 specific control registers
+
+  @Preconditions
+    None
+
+  @Returns
+    None
+
+  @Param
+    None
+
+  @Comment
+
+  @Example
+    <code>
+    CLC1_Initialize();
+    </code>
+*/
+void CLC1_Initialize(void);
+
+/**
+  @Summary
+    Returns output pin status of the CLC module.
+
+  @Description
+    This routine returns output pin status of the CLC module.
+
+  @Param
+    None.
+
+  @Returns
+    Output pin status
+ 
+  @Example 
+    <code>
+    bool outputStatus;
+    outputStatus = CLC1_OutputStatusGet();
+    </code>
+*/
+
+bool CLC1_OutputStatusGet(void);
+
+#endif  // CLC1_H
+/**
+ End of File
+*/
+