PIC16(L)F15313/23 Full-Featured 8/14-Pin Microcontrollers Description PIC16(L)F15313/23 microcontrollers feature Analog, Core Independent Peripherals and Communication Peripherals, combined with eXtreme Low-Power (XLP) technology for a wide range of general purpose and low-power applications. The devices feature multiple PWMs, multiple communication, temperature sensor, and memory features like Memory Access Partition (MAP) to support customers in data protection and bootloader applications, and Device Information Area (DIA) which stores factory calibration values to help improve temperature sensor accuracy. Core Features Power-Saving Functionality * C Compiler Optimized RISC Architecture * Operating Speed: - DC - 32 MHz clock input - 125 ns minimum instruction cycle * Interrupt Capability * 16-Level Deep Hardware Stack * Timers: - 8-bit Timer2 with Hardware Limit Timer (HLT) - 16-bit Timer0/1 * Low-Current Power-on Reset (POR) * Configurable Power-up Timer (PWRTE) * Brown-out Reset (BOR) * Low-Power BOR (LPBOR) Option * Windowed Watchdog Timer (WWDT): - Variable prescaler selection - Variable window size selection - All sources configurable in hardware or software * Programmable Code Protection * DOZE mode: Ability to Run the CPU Core Slower than the System Clock * IDLE mode: Ability to halt CPU Core while Internal Peripherals Continue Operating * SLEEP mode: Lowest Power Consumption * Peripheral Module Disable (PMD): - Ability to disable hardware module to minimize active power consumption of unused peripherals Memory * * * * 3.5 KB Flash Program Memory 256 Bytes Data SRAM Direct, Indirect and Relative Addressing modes Memory Access Partition (MAP): - Write protect - Customizable Partition * Device Information Area (DIA) * Device Configuration Information (DCI) Operating Characteristics * Operating Voltage Range: - 1.8V to 3.6V (PIC16LF15313/23) - 2.3V to 5.5V (PIC16F15313/23) * Temperature Range: - Industrial: -40C to 85C - Extended: -40C to 125C 2017 Microchip Technology Inc. eXtreme Low-Power (XLP) Features * Sleep mode: 50 nA @ 1.8V, typical * Watchdog Timer: 500 nA @ 1.8V, typical * Operating Current: - 8 A @ 32 kHz, 1.8V, typical - 32 A/MHz @ 1.8V, typical Digital Peripherals * Four Configurable Logic Cells (CLC): - Integrated combinational and sequential logic * Complementary Waveform Generator (CWG): - Rising and falling edge dead-band control - Full-bridge, half-bridge, 1-channel drive - Multiple signal sources * Two Capture/Compare/PWM (CCP) module: - 16-bit resolution for Capture/Compare modes - 10-bit resolution for PWM mode * Four 10-Bit PWMs * Numerically Controlled Oscillator (NCO): - Generates true linear frequency control and increased frequency resolution - Input Clock: 0 Hz < FNCO < 32 MHz - Resolution: FNCO/220 * One EUSART, RS-232, RS-485, LIN compatible Preliminary DS40001897A-page 1 PIC16(L)F15313/23 Digital Peripherals (Cont.) Flexible Oscillator Structure * I/O Pins: - Individually programmable pull-ups - Slew rate control - Interrupt-on-change with edge-select - Input level selection control (ST or TTL) - Digital open-drain enable * Peripheral Pin Select (PPS): - Enables pin mapping of digital I/O * High-Precision Internal Oscillator: - Software selectable frequency range up to 32 MHz, 1% typical * x2/x4 PLL with Internal and External Sources * Low-Power Internal 32 kHz Oscillator (LFINTOSC) * External Oscillator Block with: - Three crystal/resonator modes up to 20 MHz - Three external clock modes up to 32 MHz * Fail-Safe Clock Monitor: - Allows for safe shutdown if primary clock stops * Oscillator Start-up Timer (OST): - Ensures stability of crystal oscillator resources Analog Peripherals * Analog-to-Digital Converter (ADC): - 10-bit with up to 43 external channels - Operates in Sleep * Up to two Comparators: - FVR, DAC and external input pin available on inverting and noninverting input - Software selectable hysteresis - Outputs available internally to other modules, or externally through PPS * 5-Bit Digital-to-Analog Converter (DAC): - 5-bit resolution, rail-to-rail - Positive Reference Selection - Unbuffered I/O pin output - Internal connections to ADCs and comparators * Voltage Reference: - Fixed Voltage Reference with 1.024V, 2.048V and 4.096V output levels * Zero-Cross Detect module: - AC high voltage zero-crossing detection for simplifying TRIAC control - Synchronized switching control and timing 2017 Microchip Technology Inc. Preliminary DS40001897A-page 2 PIC16(L)F15313/23 5-bit DAC Comparator 8-bit/ (with HLT) Timer 16-bit Timer Window Watchdog Timer CCP/10-bit PWM CWG NCO CLC Memory Access Partition Device Information Area Peripheral Pin Select Peripheral Module Disable Debug (1) 6 5 1 1 1 2 Y 2/4 1 1 4 Y Y Y Y 1/1 Y Y I PIC16(L)F15323 (C) 2 3.5 224 256 12 11 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 1/1 Y Y I PIC16(L)F15324 (D) 4 7 12 11 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 2/1 Y Y I PIC16(L)F15325 (B) 8 14 224 1024 12 11 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 2/1 Y Y I PIC16(L)F15344 (D) 4 7 18 17 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 2/1 Y Y I PIC16(L)F15345 (B) 8 14 224 1024 18 17 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 2/1 Y Y I PIC16(L)F15354 (A) 4 7 25 24 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 2/2 Y Y I PIC16(L)F15355 (A) 8 14 224 1024 25 24 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 2/2 Y Y I PIC16(L)F15356 (E) 16 28 224 2048 25 24 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 2/2 Y Y I PIC16(L)F15375 (E) 8 14 224 1024 36 35 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 2/2 Y Y I PIC16(L)F15376 (E) 16 28 224 2048 36 35 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 2/2 Y Y I PIC16(L)F15385 (E) 8 14 224 1024 44 43 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 2/2 Y Y I PIC16(L)F15386 (E) 16 28 224 2048 44 43 1 2 1 2 Y 2/4 1 1 4 Y Y Y Y 2/2 Y Y I Note 1: 224 512 224 512 224 512 EUSART/ I2C-SPI 10-bit ADC 3.5 224 256 Zero-Cross Detect Temperature Indicator I/OPins 2 Data SRAM (bytes) Program Flash Memory (KB) PIC16(L)F15313 (C) Device Storage Area Flash (B) Program Flash Memory (KW) PIC16(L)F153XX FAMILY TYPES Data Sheet Index TABLE 1: I - Debugging integrated on chip. Data Sheet Index: A: DS40001853 PIC16(L)F15354/5 Data Sheet, 28-Pin B: DS40001865 PIC16(L)F15325/45 Data Sheet, 14/20-Pin C: DS40001897 PIC16(L)F15313/23 Data Sheet, 8/14-Pin D: DS40001889 PIC16(L)F15324/44 Data Sheet, 14/20-Pin E: PIC16(L)F15356/75/76/85/86 Data Sheet, 28/40/48-Pin Note: DS40001866 For other small form-factor package availability and marking information, visit www.microchip.com/packaging or contact your local sales office. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 3 PIC16(L)F15313/23 TABLE 2: PACKAGES Device PIC16(L)F15313 PIC16(L)F15323 2017 Microchip Technology Inc. PDIP SOIC DFN Preliminary TSSOP UQFN (4x4) DS40001897A-page 4 PIC16(L)F15313/23 PIN DIAGRAMS VDD RA5 RA4 VPP/MCLR/RA3 8 7 6 5 VSS RA0/ICSPDAT RA1/ICSPCLK RA2 See Table 3 for location of all peripheral functions. 14-PIN PDIP, SOIC, TSSOP Note: 1 2 3 4 VDD RA5 RA4 VPP/MCLR/RA3 RC5 RC4 RC3 1 2 3 4 5 6 7 PIC16(L)F15323 Note: PIC16(L)F15313 8-PIN PDIP, SOIC, MSOP 14 13 12 11 10 9 8 VSS RA0/ICSPDAT RA1/ICSPCLK RA2 RC0 RC1 RC2 See Table 4 for location of all peripheral functions. VDD NC NC Vss 16-PIN UQFN (4X4) 16 15 14 13 RA5 RA4 MCLR/VPP/RA3 RC5 1 2 3 4 PIC16(L)F15323 12 11 10 9 RA0/ICSPDAT RA1/ICSPCLK RA2 RC0 RC4 RC3 RC2 RC1 5 6 7 8 Note 1: 2: See Table 4 for location of all peripheral functions. It is recommended that the exposed bottom pad be connected to VSS. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 5 NCO DAC Timers CCP PWM CWG MSSP ZCD CLC CLKR Interrupt Pull-up Basic 7 ANA0 C1IN0+ DAC1OUT TX1/ CK1(1) CLCIN3(1) IOCA0 Y ICSPDAT RA1 6 ANA1 VREF+ C1IN0- DAC1REF+ T0CKI(1) SCK1(4) SCL1(1,4) RX1/ DT1(1) CLCIN2(1) IOCA1 Y ICSPCLK RA2 5 ANA2 CWG1IN(1) SDA1(1,4) SDI1(1) ZCD1 INT(1) IOCA2 Y RA3 4 SS1(1) CLCIN0(1) IOCA3 Y MCLR VPP RA4 3 ANA4 C1IN1- T1G(1) IOCA4 Y CLKOUT OSC2 RA5 2 ANA5 ADACT(1) T1CKI(1) T2IN(1) CCP1(1) CCP2(1) CLCIN1(1) IOCA5 Y CLKIN OSC1 EIN VDD 1 VDD VSS 8 VSS TMR0 CCP1 PWM3OUT CWG1A SDO1 DT1(3) CLC1OUT CLKR CCP2 PWM4OUT CWG1B SCK1 CK1 CLC2OUT PWM5OUT CWG1C SCL1(3,4) TX1 CLC3OUT PWM6OUT CWG1D SDA1(3,4) CLC4OUT OUT(2) Note 1: 2: 3: 4: C1OUT NCO1OUT EUSART Comparator RA0 This is a PPS remappable input signal. The input function may be moved from the default location shown to one of several other PORTx pins. All digital output signals shown in this row are PPS re-mappable. These signals may be mapped to output onto one of several PORTx pin options. This is a bidirectional signal. For normal module operation, the firmware should map this signal to the same pin in both the PPS input and PPS output registers. These pins are configured for I2C logic levels. PPS assignments to the other pins will operate, but input logic levels will be standard TTL/ST as selected by the INLVL register, instead of the I2C specific or SMBUS input buffer thresholds. DS40001897A-page 6 PIC16(L)F15313/23 Reference Preliminary ADC 8-PIN ALLOCATION TABLE (PIC16(L)F15313) 8-Pin PDIP/SOIC/ MSOP TABLE 3: I/O(2) 2017 Microchip Technology Inc. PIN ALLOCATION TABLES CCP PWM CWG MSSP ZCD EUSART CLC CLKR C1IN0+ DAC1OUT IOCA0 Y ICSPDAT ANA1 VREF+ C1IN0C2IN0- DAC1REF+ T0CKI(1) IOCA1 Y ICSPCLK RA2 11 10 ANA2 CWG1IN(1) ZCD1 INT(1) IOCA2 Y RA3 4 3 IOCA3 Y MCLR VPP RA4 3 2 ANA4 T1G(1) IOCA4 Y CLKOUT OSC2 RA5 2 1 ANA5 T1CKI(1) T2IN CLCIN3(1) IOCA5 Y CLKIN OSC1 EIN RC0 10 9 ANC0 C2IN0+ SCK1(1) SCL1(1,4) TX2(1) CK2(1) IOCC0 Y RC1 9 8 ANC1 C1IN1C2IN1- SDA1(1,4) SDI1(1) RX2(1) DT2(1) CLCIN2(1) IOCC1 Y RC2 8 7 ANC2 C1IN2C2IN2- IOCC2 Y RC3 7 6 ANC3 C1IN3C2IN3- CCP2(1) SS1(1) CLCIN0(1) IOCC3 Y RC4 6 5 ANC4 TX1(1) CK1(1) CLCIN1(1) IOCC4 Y RC5 5 4 ANC5 CCP1(1) RX1(1) DT1(1) IOCC5 Y VDD 1 16 VDD VSS 14 13 VSS DS40001897A-page 7 1: 2: 3: 4: This is a PPS re-mappable input signal. The input function may be moved from the default location shown to one of several other PORTx pins. All digital output signals shown in this row are PPS re-mappable. These signals may be mapped to output onto one of several PORTx pin options. This is a bidirectional signal. For normal module operation, the firmware should map this signal to the same pin in both the PPS input and PPS output registers. These pins are configured for I2C logic levels. PPS assignments to the other pins will operate, but input logic levels will be standard TTL/ST as selected by the INLVL register, instead of the I2C specific or SMBUS input buffer thresholds. PIC16(L)F15313/23 Note Basic Timers ANA0 11 Pull-up NCO 12 12 Interrupt Comparator 13 RA1 DAC Reference RA0 ADC 16-Pin QFN/UQFN Preliminary 14-Pin PDIP/SOIC/TSSOP 14/16-PIN ALLOCATION TABLE (PIC16(L)F15323) I/O(2) 2017 Microchip Technology Inc. TABLE 4: 14-Pin PDIP/SOIC/TSSOP 16-Pin QFN/UQFN ADC Reference Comparator NCO DAC Timers CCP PWM CWG MSSP ZCD EUSART CLC CLKR Interrupt Pull-up Basic 14/16-PIN ALLOCATION TABLE (PIC16(L)F15323) (CONTINUED) I/O(2) 2017 Microchip Technology Inc. TABLE 4: OUT(2) C1OUT NCO1OUT TMR0 CCP1 PWM3OUT CWG1A SDO1 DT1(3) CLC1OUT CLKR C2OUT CCP2 PWM4OUT CWG1B SCK1 CK1 CLC2OUT PWM5OUT CWG1C SCL1(3,4) TX1 CLC3OUT PWM6OUT CWG1D SDA1(3,4) DT2(3) CLC4OUT CK2 TX2 Note Preliminary 1: 2: 3: 4: This is a PPS re-mappable input signal. The input function may be moved from the default location shown to one of several other PORTx pins. All digital output signals shown in this row are PPS re-mappable. These signals may be mapped to output onto one of several PORTx pin options. This is a bidirectional signal. For normal module operation, the firmware should map this signal to the same pin in both the PPS input and PPS output registers. These pins are configured for I2C logic levels. PPS assignments to the other pins will operate, but input logic levels will be standard TTL/ST as selected by the INLVL register, instead of the I2C specific or SMBUS input buffer thresholds. PIC16(L)F15313/23 DS40001897A-page 8 PIC16(L)F15313/23 Table of Contents 1.0 2.0 3.0 4.0 5.0 6.0 7.0 8.0 9.0 10.0 11.0 12.0 13.0 14.0 15.0 16.0 17.0 18.0 19.0 20.0 21.0 22.0 23.0 24.0 25.0 26.0 27.0 28.0 29.0 30.0 31.0 32.0 33.0 34.0 35.0 36.0 37.0 38.0 39.0 40.0 Device Overview ........................................................................................................................................................................ 11 Guidelines for Getting Started with PIC16(L)F15313/23 Microcontrollers.................................................................................. 22 Enhanced Mid-Range CPU ........................................................................................................................................................ 25 Memory Organization ................................................................................................................................................................. 27 Device Configuration .................................................................................................................................................................. 75 Device Information Area............................................................................................................................................................. 86 Device Configuration Information ............................................................................................................................................... 88 Resets ........................................................................................................................................................................................ 89 Oscillator Module (with Fail-Safe Clock Monitor) ..................................................................................................................... 100 Interrupts .................................................................................................................................................................................. 117 Power-Saving Operation Modes .............................................................................................................................................. 139 Windowed Watchdog Timer (WWDT) ...................................................................................................................................... 146 Nonvolatile Memory (NVM) Control.......................................................................................................................................... 154 I/O Ports ................................................................................................................................................................................... 172 Peripheral Pin Select (PPS) Module ........................................................................................................................................ 185 Peripheral Module Disable ....................................................................................................................................................... 194 Interrupt-On-Change ................................................................................................................................................................ 202 Fixed Voltage Reference (FVR) .............................................................................................................................................. 209 Temperature Indicator Module ................................................................................................................................................. 212 Analog-to-Digital Converter (ADC) Module .............................................................................................................................. 215 5-Bit Digital-to-Analog Converter (DAC1) Module.................................................................................................................... 229 Numerically Controlled Oscillator (NCO) Module ..................................................................................................................... 234 Comparator Module.................................................................................................................................................................. 244 Zero-Cross Detection (ZCD) Module........................................................................................................................................ 254 Timer0 Module ......................................................................................................................................................................... 260 Timer1 Module with Gate Control............................................................................................................................................. 266 Timer2 Module With Hardware Limit Timer (HLT).................................................................................................................... 279 Capture/Compare/PWM Modules ............................................................................................................................................ 299 Pulse-Width Modulation (PWM) ............................................................................................................................................... 311 Complementary Waveform Generator (CWG) Module ............................................................................................................ 318 Configurable Logic Cell (CLC).................................................................................................................................................. 343 Master Synchronous Serial Port (MSSP1) Module .................................................................................................................. 360 Enhanced Universal Synchronous Asynchronous Receiver Transmitter (EUSART) ............................................................... 411 Reference Clock Output Module .............................................................................................................................................. 439 In-Circuit Serial ProgrammingTM (ICSPTM) ............................................................................................................................... 443 Instruction Set Summary .......................................................................................................................................................... 445 Electrical Specifications............................................................................................................................................................ 458 DC and AC Characteristics Graphs and Charts ....................................................................................................................... 487 Development Support............................................................................................................................................................... 488 Packaging Information.............................................................................................................................................................. 492 2017 Microchip Technology Inc. Preliminary DS40001897A-page 9 PIC16(L)F15313/23 TO OUR VALUED CUSTOMERS It is our intention to provide our valued customers with the best documentation possible to ensure successful use of your Microchip products. To this end, we will continue to improve our publications to better suit your needs. Our publications will be refined and enhanced as new volumes and updates are introduced. If you have any questions or comments regarding this publication, please contact the Marketing Communications Department via E-mail at docerrors@microchip.com. We welcome your feedback. Most Current Data Sheet To obtain the most up-to-date version of this data sheet, please register at our Worldwide Website at: http://www.microchip.com You can determine the version of a data sheet by examining its literature number found on the bottom outside corner of any page. The last character of the literature number is the version number, (e.g., DS30000000A is version A of document DS30000000). Errata An errata sheet, describing minor operational differences from the data sheet and recommended workarounds, may exist for current devices. As device/documentation issues become known to us, we will publish an errata sheet. The errata will specify the revision of silicon and revision of document to which it applies. To determine if an errata sheet exists for a particular device, please check with one of the following: * Microchip's Worldwide Website; http://www.microchip.com * Your local Microchip sales office (see last page) When contacting a sales office, please specify which device, revision of silicon and data sheet (include literature number) you are using. Customer Notification System Register on our website at www.microchip.com to receive the most current information on all of our products. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 10 PIC16(L)F15313/23 DEVICE OVERVIEW TABLE 1-1: DEVICE PERIPHERAL SUMMARY Peripheral PIC16(L)F15323 The PIC16(L)F15313/23 are described within this data sheet. The PIC16(L)F15313/23 devices are available in 8/14-pin PDIP, SSOP, SOIC, DFN, and UQFN packages. Figure 1-1 and Figure 1-2 shows the block diagrams of the PIC16(L)F15313/23 devices. Table 1-2 and Table 1-3 shows the pinout descriptions. PIC16(L)F15313 1.0 Analog-to-Digital Converter Digital-to-Analog Converter (DAC1) Fixed Voltage Reference (FVR) Numerically Controlled Oscillator (NCO1) Temperature Indicator Module (TIM) Zero-Cross Detect (ZCD1) CCP1 CCP2 C1 Reference Table 1-1 for peripherals available per device. Capture/Compare/PWM Modules (CCP) Comparator Module (Cx) C2 Configurable Logic Cell (CLC) CLC1 CLC2 CLC3 CLC4 CWG1 EUSART1 MSSP1 PWM3 PWM4 PWM5 PWM6 Timer0 Timer1 Timer2 Complementary Waveform Generator (CWG) Enhanced Universal Synchronous/Asynchronous Receiver/Transmitter (EUSART) Master Synchronous Serial Ports (MSSP) Pulse-Width Modulator (PWM) Timers 2017 Microchip Technology Inc. Preliminary DS40001897A-page 11 PIC16(L)F15313/23 1.1 1.1.1 1.1.2.3 Register and Bit Naming Conventions REGISTER NAMES When there are multiple instances of the same peripheral in a device, the peripheral control registers will be depicted as the concatenation of a peripheral identifier, peripheral instance, and control identifier. The control registers section will show just one instance of all the register names with an `x' in the place of the peripheral instance number. This naming convention may also be applied to peripherals when there is only one instance of that peripheral in the device to maintain compatibility with other devices in the family that contain more than one. 1.1.2 BIT NAMES There are two variants for bit names: * Short name: Bit function abbreviation * Long name: Peripheral abbreviation + short name 1.1.2.1 Short Bit Names Short bit names are an abbreviation for the bit function. For example, some peripherals are enabled with the EN bit. The bit names shown in the registers are the short name variant. Short bit names are useful when accessing bits in C programs. The general format for accessing bits by the short name is RegisterNamebits.ShortName. For example, the enable bit, EN, in the COG1CON0 register can be set in C programs with the instruction COG1CON0bits.EN = 1. Short names are generally not useful in assembly programs because the same name may be used by different peripherals in different bit positions. When this occurs, during the include file generation, all instances of that short bit name are appended with an underscore plus the name of the register in which the bit resides to avoid naming contentions. 1.1.2.2 Long Bit Names Long bit names are constructed by adding a peripheral abbreviation prefix to the short name. The prefix is unique to the peripheral thereby making every long bit name unique. The long bit name for the COG1 enable bit is the COG1 prefix, G1, appended with the enable bit short name, EN, resulting in the unique bit name G1EN. Long bit names are useful in both C and assembly programs. For example, in C the COG1CON0 enable bit can be set with the G1EN = 1 instruction. In assembly, this bit can be set with the BSF COG1CON0,G1EN instruction. 2017 Microchip Technology Inc. Bit Fields Bit fields are two or more adjacent bits in the same register. Bit fields adhere only to the short bit naming convention. For example, the three Least Significant bits of the COG1CON0 register contain the mode control bits. The short name for this field is MD. There is no long bit name variant. Bit field access is only possible in C programs. The following example demonstrates a C program instruction for setting the COG1 to the Push-Pull mode: COG1CON0bits.MD = 0x5; Individual bits in a bit field can also be accessed with long and short bit names. Each bit is the field name appended with the number of the bit position within the field. For example, the Most Significant mode bit has the short bit name MD2 and the long bit name is G1MD2. The following two examples demonstrate assembly program sequences for setting the COG1 to Push-Pull mode: Example 1: MOVLW ANDWF MOVLW IORWF ~(1< CALL, CALLW RETURN, RETLW Interrupt, RETFIE READING PROGRAM MEMORY AS DATA There are three methods of accessing constants in program memory. The first method is to use tables of RETLW instructions. The second method is to set an FSR to point to the program memory. The third method is to use the NVMREG interface to access the program memory. For an example of NVMREG interface use, reference Section 13.3, NVMREG Access. 15 4.1.1.1 RETLW Instruction Stack Level 1 The RETLW instruction can be used to provide access to tables of constants. The recommended way to create such a table is shown in Example 4-1. Stack Level 15 EXAMPLE 4-1: Stack Level 0 constants BRW Reset Vector Interrupt Vector On-chip Program Memory 0000h RETLW RETLW RETLW RETLW 0004h 0005h Page 0 Rollover to Page 0 07FFh 0800h DATA0 DATA1 DATA2 DATA3 RETLW INSTRUCTION ;Add Index in W to ;program counter to ;select data ;Index0 data ;Index1 data my_function ;... LOTS OF CODE... MOVLW DATA_INDEX call constants ;... THE CONSTANT IS IN W The BRW instruction makes this type of table very simple to implement. 4.1.1.2 Rollover to Page 0 2017 Microchip Technology Inc. 7FFFh Indirect Read with FSR The program memory can be accessed as data by setting bit 7 of an FSRxH register and reading the matching INDFx register. The MOVIW instruction will place the lower eight bits of the addressed word in the W register. Writes to the program memory cannot be performed via the INDF registers. Instructions that read the program memory via the FSR require one extra instruction cycle to complete. Example 4-2 demonstrates reading the program memory via an FSR. Preliminary DS40001897A-page 28 PIC16(L)F15313/23 The HIGH directive will set bit 7 if a label points to a location in the program memory. This applies to the assembly code Example 4-2 shown below. EXAMPLE 4-2: ACCESSING PROGRAM MEMORY VIA FSR constants RETLW DATA0 ;Index0 data RETLW DATA1 ;Index1 data RETLW DATA2 RETLW DATA3 my_function ;... LOTS OF CODE... MOVLW LOW constants MOVWF FSR1L MOVLW HIGH constants MOVWF FSR1H MOVIW 0[FSR1] ;THE PROGRAM MEMORY IS IN W 4.2 Memory Access Partition (MAP) User Flash is partitioned into: * Application Block * Boot Block, and * Storage Area Flash (SAF) Block The user can allocate the memory usage by setting the BBEN bit, selecting the size of the partition defined by BBSIZE[2:0] bits and enabling the Storage Area Flash by the SAFEN bit of the Configuration Word (see Register 5-4). Refer to Table 4-2 for the different user Flash memory partitions. 4.2.1 APPLICATION BLOCK Default settings of the Configuration bits (BBEN = 1 and SAFEN = 1) assign all memory in the user Flash area to the Application Block. 4.2.2 BOOT BLOCK If BBEN = 1, the Boot Block is enabled and a specific address range is alloted as the Boot Block based on the value of the BBSIZE bits of Configuration Word (Register 5-4) and the sizes provided in . 4.2.3 STORAGE AREA FLASH Storage Area Flash (SAF) is enabled by clearing the SAFEN bit of the Configuration Word in Register 5-4. If enabled, the SAF block is placed at the end of memory and spans 128 words. If the Storage Area Flash (SAF) is enabled, the SAF area is not available for program execution. 4.2.4 MEMORY WRITE PROTECTION All the memory blocks have corresponding write protection fuses WRTAPP, WRTB and WRTC bits in the Configuration Word 4 (Register 5-4). If write-protected locations are written from NVMCON registers, memory is not changed and the WRERR bit defined in Register 12-5 is set as explained in Section 13.3.8 "WRERR Bit". 4.2.5 MEMORY VIOLATION A Memory Execution Violation Reset occurs while executing an instruction that has been fetched from outside a valid execution area, clearing the MEMV bit. Refer to Section 8.12 "Memory Execution Violation" for the available valid program execution areas and the PCON1 register definition (Register 8-3) for MEMV bit conditions. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 29 PIC16(L)F15313/23 TABLE 4-2: MEMORY ACCESS PARTITION Partition REG Address BBEN = 1 SAFEN = 1 00 0000h *** Last Boot Block Memory Address PFM Last Boot Block Memory Address + 1(1) *** Last Program Memory Address - 80h BBEN = 1 SAFEN = 0 BBEN = 0 SAFEN = 0 BOOT BLOCK(4) BOOT BLOCK(4) APPLICATION BLOCK(4) APPLICATION BLOCK(4) APPLICATION BLOCK(4) APPLICATION BLOCK(4) Last Program Memory Address - 7Fh(2) *** Last Program Memory Address SAF(4) CONFIG Config Memory Address(3) Note 1: 2: 3: 4: BBEN = 0 SAFEN = 1 SAF(4) CONFIG Last Boot Block Memory Address is based on BBSIZE<2:0> given in . Last Program Memory Address is the Flash size given in Table 4-1. Config Memory Address are the address locations of the Configuration Words given in Table 13-2. Each memory block has a corresponding write protection fuse defined by the WRTAPP, WRTB and WRTC bits in the Configuration Word (Register 5-4). 2017 Microchip Technology Inc. Preliminary DS40001897A-page 30 PIC16(L)F15313/23 4.3 4.3.1 Data Memory Organization The data memory is partitioned into 64 memory banks with 128 bytes in each bank. Each bank consists of: * * * * 12 core registers Up to 100 Special Function Registers (SFR) Up to 80 bytes of General Purpose RAM (GPR) 16 bytes of common RAM FIGURE 4-2: The active bank is selected by writing the bank number into the Bank Select Register (BSR). All data memory can be accessed either directly (via instructions that use the file registers) or indirectly via the two File Select Registers (FSR). See Section 4.6 "Indirect Addressing" for more information. Data memory uses a 13-bit address. The upper six bits of the address define the Bank address and the lower seven bits select the registers/RAM in that bank. BANKED MEMORY PARTITIONING 4.3.2 Rev. 10-000041B 9/21/2016 7-bit Bank Offset BANK SELECTION CORE REGISTERS The core registers contain the registers that directly affect the basic operation. The core registers occupy the first 12 addresses of every data memory bank (addresses x00h/x08h through x0Bh/x8Bh). These registers are listed below in Table 4-3. Memory Region 00h Core Registers (12 bytes) TABLE 4-3: 0Bh 0Ch Special Function Registers(1) (up to 100 bytes maximum) 1Fh 20h General Purpose RAM (80 bytes maximum) CORE REGISTERS Addresses BANKx x00h or x80h x01h or x81h x02h or x82h x03h or x83h x04h or x84h x05h or x85h x06h or x86h x07h or x87h x08h or x88h x09h or x89h x0Ah or x8Ah x0Bh or x8Bh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON 6Fh 70h Common RAM (16 bytes) 7Fh Note 1: This table shows the address for an example bank with 20 Bytes of SFRs only. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 31 PIC16(L)F15313/23 4.3.2.1 STATUS Register The STATUS register, shown in Register 4-1, contains: * the arithmetic status of the ALU * the Reset status The STATUS register can be the destination for any instruction, like any other register. If the STATUS register is the destination for an instruction that affects the Z, DC or C bits, then the write to these three bits is disabled. These bits are set or cleared according to the device logic. Furthermore, the TO and PD bits are not writable. Therefore, the result of an instruction with the STATUS register as destination may be different than intended. REGISTER 4-1: U-0 It is recommended, therefore, that only BCF, BSF, SWAPF and MOVWF instructions are used to alter the STATUS register, because these instructions do not affect any Status bits. For other instructions not affecting any Status bits, refer to Section 36.0 "Instruction Set Summary". Note 1: The C and DC bits operate as Borrow and Digit Borrow out bits, respectively, in subtraction. STATUS: STATUS REGISTER U-0 -- For example, CLRF STATUS will clear bits <4:3> and <1:0>, and set the Z bit. This leaves the STATUS register as `000u u1uu' (where u = unchanged). -- U-0 R-1/q R-1/q R/W-0/u R/W-0/u R/W-0/u -- TO PD Z DC(1) C(1) bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7-5 Unimplemented: Read as `0' bit 4 TO: Time-Out bit 1 = After power-up, CLRWDT instruction or SLEEP instruction 0 = A WDT time-out occurred bit 3 PD: Power-Down bit 1 = After power-up or by the CLRWDT instruction 0 = By execution of the SLEEP instruction bit 2 Z: Zero bit 1 = The result of an arithmetic or logic operation is zero 0 = The result of an arithmetic or logic operation is not zero bit 1 DC: Digit Carry/Digit Borrow bit (ADDWF, ADDLW, SUBLW, SUBWF instructions)(1) 1 = A carry-out from the 4th low-order bit of the result occurred 0 = No carry-out from the 4th low-order bit of the result bit 0 C: Carry/Borrow bit(1) (ADDWF, ADDLW, SUBLW, SUBWF instructions)(1) 1 = A carry-out from the Most Significant bit of the result occurred 0 = No carry-out from the Most Significant bit of the result occurred Note 1: For Borrow, the polarity is reversed. A subtraction is executed by adding the two's complement of the second operand. For rotate (RRF, RLF) instructions, this bit is loaded with either the high-order or low-order bit of the source register. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 32 PIC16(L)F15313/23 4.3.3 SPECIAL FUNCTION REGISTER The Special Function Registers are registers used by the application to control the desired operation of peripheral functions in the device. The Special Function Registers occupy the 20 bytes of the data banks 0-59 and 100 bytes of the data banks 60-63, after the core registers. The SFRs associated with the operation of the peripherals are described in the appropriate peripheral chapter of this data sheet. 4.3.4 GENERAL PURPOSE RAM There are up to 80 bytes of GPR in each data memory bank. 4.3.4.1 Linear Access to GPR The general purpose RAM can be accessed in a non-banked method via the FSRs. This can simplify access to large memory structures. See Section 4.6.2 "Linear Data Memory" for more information. 4.3.5 COMMON RAM There are 16 bytes of common RAM accessible from all banks. 4.3.6 DEVICE MEMORY MAPS The memory maps are as shown in through . 2017 Microchip Technology Inc. Preliminary DS40001897A-page 33 2017 Microchip Technology Inc. TABLE 4-4: PIC16(L)F15313/23 MEMORY MAP, BANKS 0-7 BANK 0 000h BANK 1 080h Core Register (Table 4-3) Preliminary 00Bh 00Ch 00Dh 00Eh 00Fh 010h 011h 012h 013h 014h 015h 016h 017h 018h 019h 01Ah 01Bh 01Ch 01Dh 01Eh 01Fh 020h PORTA -- PORTC(2) -- -- -- TRISA -- TRISC(2) -- -- -- LATA -- LATC(2) -- -- -- -- -- Core Register (Table 4-3) 08Bh 08Ch 08Dh 08Eh 08Fh 090h 091h 092h 093h 094h 095h 096h 097h 098h 099h 09Ah 09Bh 09Ch 09Dh 09Eh 09Fh 0A0h 10Bh 10Ch 10Dh 10Eh 10Fh 110h 111h 112h 113h 114h 115h 116h 117h 118h 119h 11Ah 11Bh 11Ch 11Dh 11Eh 11Fh 120h 0FFh Common RAM Accesses 70h-7Fh 1: Unimplemented locations read as `0'. 2: Present only in PIC16(L)F15323. -- -- -- -- -- -- -- -- -- -- -- -- -- RC1REG1 TX1REG1 SP1BRG1L SP1BRG1H RC1STA1 TX1STA1 BAUD1CON1 Core Register (Table 4-3) 18Bh 18Ch 18Dh 18Eh 18Fh 190h 191h 192h 193h 194h 195h 196h 197h 198h 199h 19Ah 19Bh 19Ch 19Dh 19Eh 19Fh 1A0h 17Fh Common RAM Accesses 70h-7Fh SSP1BUF SSP1ADD SSP1MASK SSP1STAT SSP1CON1 SSP1CON2 SSP1CON3 -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 5 280h Core Register (Table 4-3) 20Bh 20Ch 20Dh 20Eh 20Fh 210h 211h 212h 213h 214h 215h 216h 217h 218h 219h 21Ah 21Bh 21Ch 21Dh 21Eh 21Fh 220h TMR1L TMR1H T1CON T1GCON T1GATE T1CLK -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 6 300h Core Register (Table 4-3) 28Bh 28Ch 28Dh 28Eh 28Fh 290h 291h 292h 293h 294h 295h 296h 297h 298h 299h 29Ah 29Bh 29Ch 29Dh 29Eh 29Fh 2A0h TMR2 PR2 T2CON T2HLT T2CLK T2ERS -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 7 380h Core Register (Table 4-3) 30Bh 30Ch 30Dh 30Eh 30Fh 310h 311h 312h 313h 314h 315h 316h 317h 318h 319h 31Ah 31Bh 31Ch 31Dh 31Eh 31Fh 320h CCPR1L CCPR1H CCP1CON CCP1CAP CCPR2L CCPR2H CCP2CON CCP2CAP PWM3DCL PWM3DCH PWM3CON -- PWM4DCL PWM4DCH PWM4CON -- PWM5DCL PWM5DCH PWM5CON -- Core Register (Table 4-3) 38Bh 38Ch 38Dh 38Eh 38Fh 390h 391h 392h 393h 394h 395h 396h 397h 398h 399h 39Ah 39Bh 39Ch 39Dh 39Eh 39Fh 3A0h PWM6DCL PWM6DCH PWM6CON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 32Fh General Purpose Register 80 Bytes 16Fh 170h BANK 4 200h Unimplemented Read as `0' 1EFh 1F0h 1FFh Common RAM Accesses 70h-7Fh Unimplemented Read as `0' 26Fh 270h 27Fh Common RAM Accesses 70h-7Fh Unimplemented Read as `0' 2EFh 2F0h 2FFh Common RAM Accesses 70h-7Fh 330h 36Fh 370h 37Fh Unimplemented Read as `0' Common RAM Accesses 70h-7Fh Unimplemented Read as `0' 3EFh 3F0h 3FFh Common RAM Accesses 70h-7Fh DS40001897A-page 34 PIC16(L)F15313/23 0EFh 0F0h Note -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- ADRESL ADRESH ADCON0 ADCON1 ADACT BANK 3 180h Core Register (Table 4-3) General Purpose Register 80 Bytes General Purpose Register 96 Bytes 07Fh BANK 2 100h 2017 Microchip Technology Inc. TABLE 4-5: PIC16(L)F15313/23 MEMORY MAP, BANKS 8-15 BANK 8 400h BANK 9 480h Core Register (Table 4-3) Preliminary 40Bh 40Ch 40Dh 40Eh 40Fh 410h 411h 412h 413h 414h 415h 416h 417h 418h 419h 41Ah 41Bh 41Ch 41Dh 41Eh 41Fh 420h -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Core Register (Table 4-3) 48Bh 48Ch 48Dh 48Eh 48Fh 490h 491h 492h 493h 494h 495h 496h 497h 498h 499h 49Ah 49Bh 49Ch 49Dh 49Eh 49Fh 4A0h 47Fh Note Common RAM Accesses 70h-7Fh 1: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Core Register (Table 4-3) 50Bh 50Ch 50Dh 50Eh 50Fh 510h 511h 512h 513h 514h 515h 516h 517h 518h 519h 51Ah 51Bh 51Ch 51Dh 51Eh 51Fh 520h Unimplemented Read as `0' 4EFh 4F0h 4FFh Common RAM Accesses 70h-7Fh Unimplemented locations read as `0'. BANK 11 580h -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Core Register (Table 4-3) 58Bh 58Ch 58Dh 58Eh 58Fh 590h 591h 592h 593h 594h 595h 596h 597h 598h 599h 59Ah 59Bh 59Ch 59Dh 59Eh 59Fh 5A0h Unimplemented Read as `0' 56Fh 570h 57Fh Common RAM Accesses 70h-7Fh BANK 12 600h NCO1ACCL NCO1ACCH NCO1ACCU NCO1INCL NCO1INCH NCO1INCU NCO1CON NCO1CLK -- -- -- -- -- -- -- -- TMR0 PR0 T0CON0 T0CON1 Core Register (Table 4-3) 60Bh 60Ch 60Dh 60Eh 60Fh 610h 611h 612h 613h 614h 615h 616h 617h 618h 619h 61Ah 61Bh 61Ch 61Dh 61Eh 61Fh 620h Unimplemented Read as `0' 5EFh 5F0h 5FFh Common RAM Accesses 70h-7Fh BANK 13 680h CWG1CLK CWG1DAT CWG1DBR CWG1DBF CWG1CON0 CWG1CON1 CWG1AS0 CWG1AS1 CWG1STR -- -- -- -- -- -- -- -- -- -- -- Core Register (Table 4-3) 68Bh 68Ch 68Dh 68Eh 68Fh 690h 691h 692h 693h 694h 695h 696h 697h 698h 699h 69Ah 69Bh 69Ch 69Dh 69Eh 69Fh 6A0h Unimplemented Read as `0' 66Fh 670h 67Fh Common RAM Accesses 70h-7Fh BANK 14 700h 6EFh 6F0h 6FFh -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 15 780h Core Register (Table 4-3) 70Bh 70Ch 70Dh 70Eh 70Fh 710h 711h 712h 713h 714h 715h 716h 717h 718h 719h 71Ah 71Bh 71Ch 71Dh 71Eh 71Fh 720h PIR0 PIR1 PIR2 PIR3 PIR4 PIR5 PIR6 PIR7 -- -- PIE0 PIE1 PIE2 PIE3 PIE4 PIE5 PIE6 PIE7 -- -- Core Register (Table 4-3) 78Bh 78Ch 78Dh 78Eh 78Fh 790h 791h 792h 793h 794h 795h 796h 797h 798h 799h 79Ah 79Bh 79Ch 79Dh 79Eh 79Fh 7A0h -- -- -- -- -- -- -- -- -- -- PMD0 PMD1 PMD2 PMD3 PMD4 PMD5 -- -- -- -- Unimplemented Unimplemented Unimplemented Read as `0' Read as `0' Read as `0' Common RAM Accesses 70h-7Fh 76Fh 770h 77Fh Common RAM Accesses 70h-7Fh 7EFh 7F0h 7FFh Common RAM Accesses 70h-7Fh DS40001897A-page 35 PIC16(L)F15313/23 Unimplemented Read as `0' 46Fh 470h BANK 10 500h 2017 Microchip Technology Inc. TABLE 4-6: PIC16(L)F15313/23 MEMORY MAP, BANKS 16-23 BANK 16 800h BANK 17 880h Core Register (Table 4-3) Preliminary 80Bh 80Ch 80Dh 80Eh 80Fh 810h 811h 812h 813h 814h 815h 816h 817h 818h 819h 81Ah 81Bh 81Ch 81Dh 81Eh 81Fh 820h WDTCON0 WDTCON1 WDTL WDTH WDTU BORCON VREGCON(2) PCON0 PCON1 -- -- -- -- -- NVMADRL NVMADRH NVMDATL NVMDATH NVMCON1 NVMCON2 Core Register (Table 4-3) 88Bh 88Ch 88Dh 88Eh 88Fh 890h 891h 892h 893h 894h 895h 896h 897h 898h 899h 89Ah 89Bh 89Ch 89Dh 89Eh 89Fh 8A0h 87Fh Note Common RAM Accesses 70h-7Fh 1: 2: 3: CPUDOZE OSCCON1 OSCCON2 OSCCON3 OSCSTAT1 OSCEN OSCTUNE OSCFRQ -- CLKRCON CLKCLK -- -- -- -- -- -- -- -- -- Core Register (Table 4-3) 90Bh 90Ch 90Dh 90Eh 90Fh 910h 911h 912h 913h 914h 915h 916h 917h 918h 919h 91Ah 91Bh 91Ch 91Dh 91Eh 91Fh 920h Unimplemented Read as `0' 8EFh 8F0h 8FFh Common RAM Accesses 70h-7Fh BANK 19 980h FVRCON -- DAC1CON0 DAC1CON1 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- ZCDCON Core Register (Table 4-3) 98Bh 98Ch 98Dh 98Eh 98Fh 990h 991h 992h 993h 994h 995h 996h 997h 998h 999h 99Ah 99Bh 99Ch 99Dh 99Eh 99Fh 9A0h Unimplemented Read as `0' 96Fh 970h 97Fh Unimplemented locations read as `0'. Register not implemented on LF devices. Present only on PIC16(L)F15323. Common RAM Accesses 70h-7Fh BANK 20 A00h -- -- -- CMOUT CM1CON0 CM1CON1 CM1NCH CM1PCH CM2CON0(3) CM2CON1(3) CM2NCH(3) CM2PCH(3) -- -- -- -- -- -- -- -- Core Register (Table 4-3) A0Bh A0Ch A0Dh A0Eh A0Fh A10h A11h A12h A13h A14h A15h A16h A17h A18h A19h A1Ah A1Bh A1Ch A1Dh A1Eh A1Fh A20h Unimplemented Read as `0' 9EFh 9F0h 9FFh Common RAM Accesses 70h-7Fh BANK 21 A80h -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Core Register (Table 4-3) A8Bh A8Ch A8Dh A8Eh A8Fh A90h A91h A92h A93h A94h A95h A96h A97h A98h A99h A9Ah A9Bh A9Ch A9Dh A9Eh A9Fh AA0h Unimplemented Read as `0' A6Fh A70h A7Fh Common RAM Accesses 70h-7Fh BANK 22 B00h -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Core Register (Table 4-3) B0Bh B0Ch B0Dh B0Eh B0Fh B10h B11h B12h B13h B14h B15h B16h B17h B18h B19h B1Ah B1Bh B1Ch B1Dh B1Eh B1Fh B20h Unimplemented Read as `0' AEFh AF0h AFFh Common RAM Accesses 70h-7Fh BANK 23 B80h -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Core Register (Table 4-3) B8Bh B8Ch B8Dh B8Eh B8Fh B90h B91h B92h B93h B94h B95h B96h B97h B98h B99h B9Ah B9Bh B9Ch B9Dh B9Eh B9Fh BA0h Unimplemented Read as `0' B6Fh B70h B7Fh Common RAM Accesses 70h-7Fh -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Unimplemented Read as `0' BEFh BF0h BFFh Common RAM Accesses 70h-7Fh DS40001897A-page 36 PIC16(L)F15313/23 Unimplemented Read as `0' 86Fh 870h BANK 18 900h 2017 Microchip Technology Inc. TABLE 4-7: PIC16(L)F15313/23 MEMORY MAP, BANKS 56-63 BANK 56 1C00h BANK 57 1C80h Core Register (Table 4-3) Preliminary 1C0Bh 1C0Ch 1C0Dh 1C0Eh 1C0Fh 1C10h 1C11h 1C12h 1C13h 1C14h 1C15h 1C16h 1C17h 1C18h 1C19h 1C1Ah 1C1Bh 1C1Ch 1C1Dh 1C1Eh 1C1Fh 1C20h -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Core Register (Table 4-3) 1C8Bh 1C8Ch 1C8Dh 1C8Eh 1C8Fh 1C90h 1C91h 1C92h 1C93h 1C94h 1C95h 1C96h 1C97h 1C98h 1C99h 1C9Ah 1C9Bh 1C9Ch 1C9Dh 1C9Eh 1C9Fh 1CA0h 1C7Fh Note Common RAM Accesses 70h-7Fh -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Core Register (Table 4-3) 1D0Bh 1D0Ch 1D0Dh 1D0Eh 1D0Fh 1D10h 1D11h 1D12h 1D13h 1D14h 1D15h 1D16h 1D17h 1D18h 1D19h 1D1Ah 1D1Bh 1D1Ch 1D1Dh 1D1Eh 1D1Fh 1D20h Unimplemented Read as `0' 1CEFh 1CF0h 1CFFh Common RAM Accesses 70h-7Fh BANK 59 1D80h -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Core Register (Table 4-3) 1D8Bh 1D8Ch D8Dh1 1D8Eh 1D8Fh 1D90h 1D91h 1D92h 1D93h 1D94h 1D95h 1D96h 1D97h 1D98h 1D99h 1D9Ah 1D9Bh 1D9Ch 1D9Dh 1D9Eh 1D9Fh 1DA0h Unimplemented Read as `0' 1D6Fh 1D70h 1D7Fh Common RAM Accesses 70h-7Fh BANK 60 1E00h -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 61 1E80h Core Register (Table 4-3) BANK 62 1F00h Core Register (Table 4-3) BANK 63 1F80h Core Register (Table 4-3) Core Register (Table 4-3) 1E0Bh 1E0Ch 1E0Dh 1E0Eh 1E0Fh 1E10h 1E11h 1E12h 1E13h 1E14h 1E15h 1E16h 1E17h CLC Controls 1E18h (See Table 4-8 for 1E19h register mapping details) 1E1Ah 1E1Bh 1E1Ch 1E1Dh 1E1Eh 1E1Fh 1E20h 1E8Bh 1F0Bh 1F8Bh 1E8Ch 1F0Ch 1F8Ch 1E8Dh 1F0Dh 1F8Dh 1E8Eh 1F0Eh 1F8Eh 1E8Fh 1F0Fh 1F8Fh 1E90h 1F10h 1F90h 1E91h 1F11h 1F91h 1E92h 1F12h 1F92h 1E93h 1F13h 1F93h 1E94h 1F14h 1F94h 1E95h 1F15h 1F95h 1E96h 1F16h 1F96h 1E97h nnnPPS Controls 1F17h RxyPPS Controls 1F97h (See Table 4-8 for 1E98h (See Table 4-8 for 1F18h (See Table 4-8 for 1F98h register mapping 1E99h register mapping 1F19h register mapping 1F99h details) details) details) 1E9Ah 1F1Ah 1F9Ah 1E9Bh 1F1Bh 1F9Bh 1E9Ch 1F1Ch 1F9Ch 1E9Dh 1F1Dh 1F9Dh 1E9Eh 1F1Eh 1F9Eh 1E9Fh 1F1Fh 1F9Fh 1EA0h 1F20h 1FA0h 1E6Fh 1E70h 1EEFh 1EF0h Unimplemented Read as `0' 1DEFh 1DF0h 1DFFh Common RAM Accesses 70h-7Fh 1E7Fh Common RAM Accesses 70h-7Fh 1EFFh 1: Unimplemented locations read as `0'. 2: The banks 24-55 have been omitted from the tables in the data sheet since the banks have unimplemented registers. Common RAM Accesses 70h-7Fh 1F6Fh 1F70h 1F7Fh Common RAM Accesses 70h-7Fh 1FEFh 1FF0h 1FFFh Common RAM Accesses 70h-7Fh DS40001897A-page 37 PIC16(L)F15313/23 Unimplemented Read as `0' 1C6Fh 1C70h BANK 58 1D00h PIC16(L)F15313/23 TABLE 4-8: PIC16(L)F15313/23 MEMORY MAP, BANKS 60, 61, 62, AND 63 Bank 60 Bank 61 Bank 62 Bank 63 1E0Ch -- 1E8Ch -- 1F0Ch -- 1F8Ch -- 1E0Dh -- 1E8Dh -- 1F0Dh -- 1F8Dh -- 1E0Eh -- 1E8Eh -- 1F0Eh -- 1F8Eh -- 1E0Fh CLCDATA 1E8Fh PPSLOCK 1F0Fh -- 1F8Fh -- 1E10h CLC1CON 1E90h INTPPS 1F10h RA0PPS 1F90h -- 1E11h CLC1POL 1E91h T0CKIPPS 1F11h RA1PPS 1F91h -- 1E12h CLC1SEL0 1E92h T1CKIPPS 1F12h RA2PPS 1F92h -- 1E13h CLC1SEL1 1E93h T1GPPS 1F13h RA3PPS 1F93h -- 1E14h CLC1SEL2 1E94h -- 1F14h RA4PPS 1F94h -- 1E15h CLC1SEL3 1E95h -- 1F15h RA5PPS 1F95h -- 1E16h CLC1GLS0 1E96h -- 1F16h -- 1F96h -- 1E17h CLC1GLS1 1E97h -- 1F17h -- 1F97h -- 1E18h CLC1GLS2 1E98h -- 1F18h -- 1F98h -- 1E19h 1E1Ah CLC1GLS3 -- -- 1F99h 1F9Ah -- -- 1F19h 1F1Ah -- CLC2CON 1E99h 1E9Ah 1E1Bh CLC2POL 1E9Bh -- 1F1Bh -- 1F9Bh -- 1E1Ch CLC2SEL0 1E9Ch T2INPPS 1F1Ch -- 1F9Ch -- 1E1Dh CLC2SEL1 1E9Dh -- 1F1Dh -- 1F9Dh -- 1E1Eh CLC2SEL2 1E9Eh -- 1F1Eh -- 1F9Eh -- 1E1Fh CLC2SEL3 1E9Fh -- 1F1Fh -- 1F9Fh -- 1E20h CLC2GLS0 1EA0h -- 1F20h RC0PPS(1) 1FA0h -- 1E21h CLC2GLS1 1EA1h CCP1PPS 1F21h RC1PPS(1) 1FA1h -- 1E22h CLC2GLS2 1EA2h CCP2PPS 1F22h RC2PPS(1) 1FA2h -- 1E23h CLC2GLS3 1EA3h -- 1F23h RC3PPS(1) 1FA3h -- 1E24h CLC3CON 1EA4h -- 1F24h RC4PPS(1) 1FA4h -- 1E25h CLC3POL 1EA5h -- 1F25h RC5PPS(1) 1FA5h -- 1E26h CLC3SEL0 1EA6h -- 1F26h -- 1FA6h -- 1E27h CLC3SEL1 1EA7h -- 1F27h -- 1FA7h -- 1E28h CLC3SEL2 1EA8h -- 1F28h -- 1FA8h -- 1E29h 1E2Ah CLC3SEL3 -- -- 1FA9h 1FAAh -- -- 1F29h 1F2Ah -- CLC3GLS0 1EA9h 1EAAh 1E2Bh CLC3GLS1 1EABh -- 1F2Bh -- 1FABh -- 1E2Ch CLC3GLS2 1EACh -- 1F2Ch -- 1FACh -- 1E2Dh CLC3GLS3 1EADh -- 1F2Dh -- 1FADh -- 1E2Eh CLC4CON 1EAEh -- 1F2Eh -- 1FAEh -- 1E2Fh CLC4POL -- 1F2Fh -- 1FAFh -- 1E30h CLC4SEL0 1EAFh 1EB0h -- 1F30h -- 1FB0h -- 1E31h CLC4SEL1 1EB1h CWG1PPS 1F31h -- 1FB1h -- 1E32h CLC4SEL2 1EB2h -- 1F32h -- 1FB2h -- 1E33h 1E34h CLC4SEL3 1EB3h -- 1F33h -- 1FB3h -- CLC4GLS0 1EB4h -- 1F34h -- 1FB4h -- 1E35h 1E36h CLC4GLS1 1EB5h -- 1F35h -- 1FB5h -- CLC4GLS2 1EB6h -- 1F36h -- 1FB6h -- 1E37h CLC4GLS3 1EB7h -- -- 1FB7h -- 1E38h -- 1EB8h -- 1F37h 1F38h ANSELA 1FB8h -- 1E39h -- 1EB9h -- 1F39h WPUA 1FB9h -- 1E3Ah -- 1EBAh -- 1F3Ah ODCONA 1FBAh -- 1E3Bh -- 1EBBh CLCIN0PPS 1F3Bh SLRCONA 1FBBh -- 1E3Ch -- 1EBCh CLCIN1PPS 1F3Ch INLVLA 1FBCh -- 1E3Dh -- 1EBDh CLCIN2PPS 1F3Dh IOCAP 1FBDh -- 1E3Eh -- 1EBEh CLCIN3PPS 1F3Eh -- 1EBFh -- 1F3Fh 1FBEh 1FBFh -- 1E3Fh IOCAN IOCAF 1E40h -- 1EC0h -- 1F40h -- 1FC0h -- -- -- = Unimplemented data memory locations, read as `0' Legend: Note -- 1: Present only in PIC16(L)F15323. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 38 PIC16(L)F15313/23 TABLE 4-8: PIC16(L)F15313/23 MEMORY MAP, BANKS 60, 61, 62, AND 63 (CONTINUED) Bank 60 Bank 61 Bank 62 1E41h -- 1EC1h -- 1F41h -- 1FC1h -- 1E42h -- 1EC2h -- 1F42h -- 1FC2h -- 1E43h -- 1EC3h ADACTPPS 1F43h -- 1FC3h -- 1E44h -- 1EC4h -- 1F44h -- 1FC4h -- 1E45h -- 1EC5h SSP1CLKPPS 1F45h -- 1FC5h -- 1E46h -- 1EC6h SSP1DATPPS 1F46h -- 1FC6h -- 1E47h -- 1EC7h SSP1SSPPS 1F47h -- 1FC7h -- 1E48h -- 1EC8h -- 1F48h -- 1FC8h -- 1E49h 1E4Ah -- -- -- 1FC9h 1FCAh -- -- 1F49h 1F4Ah -- -- 1EC9h 1ECAh 1E4Bh -- 1ECBh RXDT1PPS 1F4Bh -- 1FCBh -- 1E4Ch -- 1ECCh TXCK1PPS 1F4Ch -- 1FCCh -- 1E4Dh -- 1ECDh -- 1F4Dh -- 1FCDh -- 1E4Eh -- 1ECEh -- 1F4Eh ANSELC(1) 1FCEh -- 1E4Fh -- 1ECFh -- 1F4Fh WPUC(1) 1FCFh -- 1E50h -- 1ED0h -- 1F50h ODCONC(1) 1FD0h -- 1E51h -- 1ED1h -- 1F51h SLRCONC(1) 1FD1h -- 1E52h -- 1ED2h -- 1F52h INLVLC(1) 1FD2h -- 1E53h -- 1ED3h -- 1F53h IOCCP(1) 1FD3h -- 1E54h -- 1ED4h -- 1F54h -- 1ED5h -- 1F55h 1FD4h 1FD5h -- 1E55h IOCCN(1) IOCCF(1) 1E56h -- 1ED6h -- 1F56h -- 1FD6h -- 1E57h -- 1ED7h -- 1F57h -- 1FD7h -- 1E58h -- 1ED8h -- 1F58h -- 1FD8h -- 1E59h 1E5Ah -- -- 1FD9h -- -- 1F59h 1F5Ah -- -- 1ED9h 1EDAh -- 1FDAh -- 1E5Bh -- 1EDBh -- 1F5Bh -- 1FDBh -- 1E5Ch -- 1EDCh -- 1F5Ch -- 1FDCh -- 1E5Dh -- 1EDDh -- 1F5Dh -- 1FDDh -- 1E5Eh -- 1EDEh -- 1F5Eh -- 1FDEh -- 1E5Fh -- -- 1F5Fh -- 1FDFh -- 1E60h -- 1EDFh 1EE0h -- 1F60h -- 1FE0h -- 1E61h -- 1EE1h -- 1F61h -- 1FE1h -- 1E62h -- 1EE2h -- 1F62h -- 1FE2h -- 1E63h 1E64h -- 1EE3h -- 1F63h -- 1FE3h BSR_ICDSHAD -- 1EE4h -- 1F64h -- 1FE4h STATUS_SHAD 1E65h 1E66h -- 1EE5h -- 1F65h -- 1FE5h WREG_SHAD -- 1EE6h -- 1F66h -- 1FE6h BSR_SHAD 1E67h 1E68h -- 1EE7h -- -- 1FE7h PCLATH_SHAD -- 1EE8h -- 1F67h 1F68h -- 1FE8h FSR0L_SHAD 1E69h -- 1EE9h -- 1F69h -- 1FE9h FSR0H_SHAD 1E6Ah -- 1EEAh -- 1F6Ah -- 1E6Bh -- 1EEBh -- 1F6Bh -- 1FEAh 1FEBh FSR1L_SHAD FSR1H_SHAD 1E6Ch -- 1EECh -- 1F6Ch -- 1FECh -- 1E6Dh -- 1EEDh -- 1F6Dh -- 1FEDh STKPTR 1E6Eh -- 1EEEh -- 1F6Eh -- 1FEEh TOSL 1E6Fh -- 1EEFh -- 1F6Fh -- 1FEFh TOSH -- -- = Unimplemented data memory locations, read as `0' Legend: Note Bank 63 1: Present only in PIC16(L)F15323. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 39 PIC16(L)F15313/23 TABLE 4-9: Bank Offset Bank 0-Bank 63 SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (ALL BANKS) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR All Banks x00h or x80h INDF0 Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) xxxx xxxx xxxx xxxx x01h or x81h INDF1 Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx xxxx xxxx x02h or x82h PCL 0000 0000 0000 0000 x03h or x83h STATUS ---1 1000 ---q quuu x04h or x84h FSR0L FSR0L Indirect Data Memory Address 0 Low Pointer 0000 0000 uuuu uuuu x05h or x85h FSR0H FSR0H Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 x06h or x86h FSR1L FSR1L Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu x07h or x87h FSR1H FSR1H Indirect Data Memory Address 1 High Pointer 0000 0000 0000 0000 x08h or x88h BSR --00 0000 --00 0000 x09h or x89h WREG x0Ah or x8Ah PCLATH -- x0Bh or x8Bh INTCON GIE Legend: Note 1: PCL -- -- -- -- TO -- PD Z DC C BSR<5:0> Working Register Write Buffer for the upper 7 bits of the Program Counter PEIE -- -- -- -- -- INTEDG 0000 0000 uuuu uuuu -000 0000 -000 0000 00-- ---1 00-- ---1 x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. These Registers can be accessed from any bank. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 40 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR RA1 RA0 --xx xxxx --uu uuuu Bank 0 CPU CORE REGISTERS; see Table 4-9 for specifics 00Ch PORTA 00Dh -- 00Eh PORTC(1) -- -- RA5 RA4 RA3 RA2 Unimplemented -- -- RC5 RC4 RC3 RC2 RC1 RC0 ---- ---- ---- ---- --xx xxxx --uu uuuu -- 00Fh -- Unimplemented -- 010h -- Unimplemented -- -- 011h -- Unimplemented ---- ---- ---- ---- 012h TRISA --11 -111 --11 -111 013h -- 014h TRISC(1) -- -- TRISA5 TRISA4 -- TRISA2 TRISA1 TRISA0 Unimplemented -- -- TRISC5 TRISC4 TRISC3 TRISC2 TRISC1 TRISC0 -- -- --11 1111 --11 1111 Preliminary 015h -- Unimplemented -- -- 016h -- Unimplemented -- -- 017h -- Unimplemented -- -- 018h LATA -- 019h -- -- 01Ah LATC(1) -- -- LATA5 LATA4 -- LATA2 -- LATC5 LATC4 LATC3 LATA1 LATA0 --xx xxxx --uu uuuu LATC1 LATC0 --xx xxxx --uu uuuu Unimplemented LATC2 -- -- Unimplemented -- -- -- Unimplemented -- -- 01Dh -- Unimplemented -- -- 01Eh -- Unimplemented -- -- 01Fh -- Unimplemented -- -- Legend: Note 1: x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Present only in PIC16(L)F15323. DS40001897A-page 41 PIC16(L)F15313/23 01Bh 01Ch 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR -- -- Bank 1 CPU CORE REGISTERS; see Table 4-3 for specifics 08Ch -- 09Ah -- Unimplemented 09Bh ADRESL ADC Result Register Low xxxx xxxx uuuu uuuu 09Ch ADRESH ADC Result Register High xxxx xxxx uuuu uuuu 09Dh ADCON0 0000 0000 0000 0000 09Eh ADCON1 ADFM 09Fh ADACT -- Legend: CHS<5:0> ADCS<2:0> -- -- GO/DONE -- -- ADON ADPREF<1:0> ADACT<4:0> 0000 --00 0000 --00 ---0 0000 ---0 0000 x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 42 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR -- -- Bank 2 CPU CORE REGISTERS; see Table 4-3 for specifics 10Ch -- 118h -- 119h RC1REG EUSART Receive Data Register 0000 0000 0000 0000 11Ah TX1REG EUSART Transmit Data Register 0000 0000 0000 0000 11Bh SP1BRGL SP1BRG<7:0> 0000 0000 0000 0000 11Ch SP1BRGH SP1BRG<15:8> 0000 0000 0000 0000 11Dh RC1STA SPEN RX9 SREN CREN ADDEN FERR OERR RX9D 0000 0000 0000 0000 11Eh TX1STA CSRC TX9 TXEN SYNC SENDB BRGH TRMT TX9D 0000 0010 0000 0010 11Fh BAUD1CON ABDOVF RCIDL -- SCKP BRG16 -- WUE ABDEN 01-0 0-00 01-0 0-00 Legend: Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 43 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 3 CPU CORE REGISTERS; see Table 4-3 for specifics 18Ch SSP1BUF xxxx xxxx xxxx xxxx 18Dh SSP1ADD ADD<7:0> 0000 0000 0000 0000 18Eh SSP1MSK MSK<7:0> 1111 1111 1111 1111 18Fh SSP1STAT SMP 190h SSP1CON1 WCOL SSPOV 191h SSP1CON2 GCEN ACKSTAT 192h SSP1CON3 ACKTIM PCIE SCIE 193h -- 19Fh -- Legend: Synchronous Serial Port Receive Buffer/Transmit Register CKE P S R/W UA BF 0000 0000 0000 0000 SSPEN CKP SSPM3 SSPM2 SSPM1 SSPM0 0000 0000 0000 0000 ACKDT ACKEN RCEN PEN RSEN SEN 0000 0000 0000 0000 BOEN SDAHT SBCDE AHEN DHEN 0000 0000 0000 0000 -- -- D/A Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 44 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 4 CPU CORE REGISTERS; see Table 4-3 for specifics 20Ch TMR1L Holding Register for the Least Significant Byte of the 16-bit TMR1 Register 0000 0000 uuuu uuuu 20Dh TMR1H Holding Register for the Most Significant Byte of the 16-bit TMR1 Register 0000 0000 uuuu uuuu 20Eh T1CON -- -- --uu -u0u 20Fh T1GCON GE GPOL GTM 210h T1GATE -- -- -- 211h T1CLK -- -- -- 212h -- 21Fh -- Legend: CKPS<1:0> GSPM -- SYNC RD16 ON --00 -000 GGO/DONE GVAL -- -- 0000 0x-- uuuu ux-- ---0 0000 ---u uuuu ---- 0000 ---- uuuu -- -- GSS<4:0> -- CS<3:0> Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 45 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Value on: POR, BOR Value on: MCLR Holding Register for the 8-bit TMR2 Register 0000 0000 0000 0000 TMR2 Period Register 1111 1111 1111 1111 0000 0000 0000 0000 0000 0000 0000 0000 Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Bank 5 CPU CORE REGISTERS; see Table 4-3 for specifics 28Ch T2TMR 28Dh T2PR 28Eh T2CON ON 28Fh T2HLT PSYNC CKPOL CKSYNC 290h T2CLKCON -- -- -- -- CS<3:0> ---- 0000 ---- 0000 291h T2RST -- -- -- -- RSEL<3:0> ---- 0000 ---- 0000 292h -- 29Fh -- -- -- Legend: CKPS<2:0> OUTPS<3:0> MODE<4:0> Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 46 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 6 CPU CORE REGISTERS; see Table 4-3 for specifics 30Ch CCPR1L Capture/Compare/PWM Register 1 (LSB) xxxx xxxx uuuu uuuu 30Dh CCPR1H Capture/Compare/PWM Register 1 (MSB) xxxx xxxx uuuu uuuu 30Eh CCP1CON EN -- OUT FMT 0-00 0000 0-00 0000 30Fh CCP1CAP -- -- -- -- ---- -000 ---- -000 310h CCPR2L Capture/Compare/PWM Register 2 (LSB) xxxx xxxx uuuu uuuu 311h CCPR2H Capture/Compare/PWM Register 2 (MSB) xxxx xxxx uuuu uuuu 312h CCP2CON EN 0-00 0000 0-00 0000 313h CCP2CAP -- 314h PWM3DCL Preliminary 315h PWM3DCH 316h PWM3CON 317h -- 318h PWM4DCL 319h PWM4DCH 31Ah PWM4CON -- PWM5DCL 31Dh PWM5DCH 31Eh PWM5CON 31Fh Legend: -- -- CTS<2:0> -- OUT FMT -- -- -- -- ---- -000 ---- -000 -- -- -- -- -- -- xx-- ---- uu-- ---- xxxx xxxx uuuu uuuu OUT POL -- -- -- -- 0-00 ---- 0-00 ---- -- -- -- -- -- -- -- -- xx-- ---- uu-- ---- xxxx xxxx uuuu uuuu OUT POL -- -- -- -- 0-00 ---- 0-00 ---- -- -- -- -- -- -- -- -- xx-- ---- uu-- ---- xxxx xxxx uuuu uuuu OUT POL -- -- -- -- 0-00 ---- 0-00 ---- -- -- DC<1:0> MODE<3:0> CTS<2:0> DC<9:0> EN -- Unimplemented DC<1:0> DC<9:0> EN -- Unimplemented DC<1:0> DC<9:0> EN -- Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. DS40001897A-page 47 PIC16(L)F15313/23 31Bh 31Ch MODE<3:0> 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR -- -- xx-- ---- uu-- ---- Bank 7 CPU CORE REGISTERS; see Table 4-3 for specifics 38Ch PWM6DCL 38Dh PWM6DCH 38Eh PWM6CON 38Fh -- 39Fh -- Legend: -- DC<1:0> -- -- -- DC<9:0> EN -- OUT POL -- -- -- -- Unimplemented xxxx xxxx uuuu uuuu 0-00 ---- 0-00 ---- -- -- x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 48 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 8-10 CPU CORE REGISTERS; see Table 4-3 for specifics x0Ch/ x8Ch -- x1Fh/ x9Fh Legend: -- Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 49 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 11 CPU CORE REGISTERS; see Table 4-3 for specifics Preliminary 58Ch NCO1ACCL NCO1ACC<7:0> 0000 0000 0000 0000 58Dh NCO1ACCH NCO1ACC<15:8> 0000 0000 0000 0000 58Eh NCO1ACCU ---- 0000 ---- 0000 58Fh NCO1INCL NCO1INC<7:0> 0000 0001 0000 0001 590h NCO1INCH NCO1INC<15:8> 0000 0000 0000 0000 591h NCO1INCU -- -- -- -- 592h NCO1CON N1EN -- N1OUT N1POL -- 593h NCO1CLK -- -- 594h -- Unimplemented 595h -- 596h -- -- -- -- NCO1ACC<19:16> NCO1INC<19:16> ---- 0000 0-00 ---0 0-00 ---0 000- -000 000- -000 -- -- Unimplemented -- -- -- Unimplemented -- -- 597h -- Unimplemented -- -- 598h -- Unimplemented -- -- 599h -- Unimplemented -- -- 59Ah -- Unimplemented -- -- 59Bh -- Unimplemented -- -- 59Ch TMR0L Holding Register for the Least Significant Byte of the 16-bit TMR0 Register 0000 0000 0000 0000 59Dh TMR0H Holding Register for the Most Significant Byte of the 16-bit TMR0 Register 59Eh T0CON0 59Fh T0CON1 Legend: N1PWS<2:0> T0EN -- T0CS<2:0> T0OUT -- -- N1PFM N1CKS<2:0> 1111 1111 1111 1111 T016BIT T0OUTPS<3:0> 0-00 0000 0-00 0000 T0ASYNC T0CKPS<3:0> 0000 0000 0000 0000 x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. DS40001897A-page 50 PIC16(L)F15313/23 ---- 0000 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR -- CS ---- ---0 ---- ---0 Bank 12 CPU CORE REGISTERS; see Table 4-3 for specifics 60Ch CWG1CLKCON -- -- -- -- 60Dh CWG1DAT -- -- -- -- 60Eh CWG1DBR -- -- -- -- DAT<3:0> DBR<5:0> ---- 0000 ---- 0000 --00 0000 --00 0000 --00 0000 --00 0000 Preliminary 60Fh CWG1DBF -- -- 610h CWG1CON0 EN LD -- -- -- 611h CWG1CON1 -- -- IN -- POLD 612h CWG1AS0 SHUTDOWN REN -- -- 0001 01-- 0001 01-- 613h CWG1AS1 -- -- -- AS4E AS3E AS2E AS1E AS0E ---0 0000 ---u 0000 614h CWG1STR OVRD OVRC OVRB OVRA STRD STRC STRB STRA 0000 0000 0000 0000 615h -- 61Fh -- -- -- Legend: DBF<5:0> LSBD<2:0> MODE<2:0> POLC LSAC<2:0> POLB POLA Unimplemented 00-- -000 00-- -000 --x- 0000 --u- 0000 x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. PIC16(L)F15313/23 DS40001897A-page 51 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR -- -- Bank 13 CPU CORE REGISTERS; see Table 4-3 for specifics 68Ch -- 69Fh Legend: -- Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 52 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 14 CPU CORE REGISTERS; see Table 4-3 for specifics 70Ch PIR0 -- -- TMR0IF IOCIF -- -- -- INTF --00 ---0 --00 ---0 70Dh PIR1 OSFIF CSWIF -- -- -- -- -- ADIF 00-- --00 00-- --00 70Eh PIR2 -- ZCDIF -- -- -- -- C2IF(1) C1IF -0-- --00 -0-- --00 70Fh PIR3 -- -- RC1IF TX1IF -- -- BCL1IF SSP1IF --00 --00 --00 --00 710h PIR4 -- -- -- -- -- -- TMR2IF TMR1IF ---- --00 ---- --00 711h PIR5 CLC4IF CLC3IF CLC2IF CLC1IF -- -- -- TMR1GIF 0000 ---0 0000 ---0 712h PIR6 -- -- -- -- -- -- CCP2IF CCP1IF ---- --00 ---- --00 713h PIR7 -- -- NVMIF NCO1IF -- -- -- CWG1IF --00 ---0 --00 ---0 -- Preliminary -- Unimplemented -- -- Unimplemented -- -- 716h PIE0 -- -- TMR0IE IOCIE -- -- --00 ---0 --00 ---0 717h PIE1 OSFIE CSWIE -- -- -- 718h PIE2 -- ZCDIE -- -- -- 719h PIE3 -- -- RC1IE TX1IE -- -- 71Ah PIE4 -- -- -- -- -- -- 71Bh PIE5 CLC4IE CLC3IE CLC2IE CLC1IE -- -- -- 71Ch PIE6 -- -- -- -- -- -- CCP2IE CCP1IE ---- --00 ---- --00 71Dh PIE7 -- -- NVMIE NCO1IE -- -- -- CWG1IE --00 ---0 --00 ---0 71Eh -- Unimplemented -- -- 71Fh -- Unimplemented -- -- Legend: Note 1: -- INTE -- -- ADIE 00-- --00 00-- --00 -- C2IE(1) C1IE -0-- --00 -0-- --00 BCL1IE SSP1IE --00 --00 --00 --00 TMR2IE TMR1IE ---- --00 ---- --00 TMR1GIE 0000 ---0 0000 ---0 x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Present only on PIC16(L)F15323. DS40001897A-page 53 PIC16(L)F15313/23 714h 715h 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR -- -- 00-- -000 Bank 15 CPU CORE REGISTERS; see Table 4-3 for specifics Preliminary 78Ch -- 795h -- 796h PMD0 SYSCMD FVRMD -- -- -- NVMMD CLKRMD IOCMD 00-- -000 797h PMD1 NCO1MD -- -- -- -- TMR2MD TMR1MD TMR0MD 0--- -000 0--- -000 798h PMD2 -- DAC1MD ADCMD -- -- CMP2MD(1) CMP1MD ZCDMD -00- -000 -00- -000 799h PMD3 -- -- PWM6MD PWM5MD PWM4MD PWM3MD CCP2MD CCP1MD --00 0000 --00 0000 79Ah PMD4 -- UART1MD -- MSSP1MD -- -- -- CWG1MD -0-0 ---0 -0-0 ---0 79Bh PMD5 -- -- -- CLC4MD CLC3MD CLC2MD CLC1MD -- ---0 000- ---0 000- 79Ch -- Unimplemented -- -- 79Dh -- Unimplemented -- -- 79Eh -- Unimplemented -- -- 79Fh -- Unimplemented -- -- Legend: Note 1: Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Present only on PIC16(L)F15323. PIC16(L)F15313/23 DS40001897A-page 54 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 16 CPU CORE REGISTERS; see Table 4-3 for specifics Preliminary 80Ch WDTCON0 -- 80Dh WDTCON1 -- -- 80Eh WDTPSL 80Fh WDTPSH 810h WDTTMR -- 811h BORCON SBOREN -- -- -- 812h VREGCON -- -- -- 813h PCON0 STKOVF STKUNF 814h PCON1 -- -- 815h -- Unimplemented 816h -- 817h --qq qqq0 --qq qqq0 -qqq -qqq -qqq -qqq PSCNT<7:0> 0000 0000 0000 0000 PSCNT<15:8> 0000 0000 0000 0000 WDTPS<4:0> SWDTEN -- WDTCS<2:0> WINDOW<2:0> PSCNT17 PSCNT16 xxxx x000 xxxx x000 -- -- -- BORRDY 1--- ---q u--- ---u -- -- -- VREGPM(1) -- ---- --0- ---- --0- WDTWV RWDT RMCLR RI POR BOR 0011 110q qqqq qquu -- -- -- -- MEMV -- ---- --1- ---- --u- -- -- Unimplemented -- -- -- Unimplemented -- -- 818h -- Unimplemented -- -- 819h -- Unimplemented -- -- 81Ah NVMADRL NVMADR<7:0> xxxx xxxx uuuu uuuu 81Bh NVMADRH -xxx xxxx -uuu uuuu 81Ch NVMDATL 81Dh NVMDATH -- -- 81Eh NVMCON1 -- NVMREGS 81Fh NVMCON2 -- NVMADR<14:8> NVMDAT<7:0> NVMDAT<13:8> LWLO FREE WRERR WREN WR RD NVMCON2<7:0> x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Present only on PIC16F15313/23. 0000 0000 0000 0000 --00 0000 --00 0000 -000 x000 -000 q000 xxxx xxxx uuuu uuuu DS40001897A-page 55 PIC16(L)F15313/23 STATE Legend: Note 1: WDTTMR<3:0> 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 DOZE1 DOZE0 Value on: POR, BOR Value on: MCLR Bank 17 CPU CORE REGISTERS; see Table 4-3 for specifics 88Ch CPUDOZE IDLEN 88Dh OSCCON1 -- 88Eh OSCCON2 -- 88Fh OSCCON3 CSWHOLD DOZEN ROI -- DOE DOZE2 NOSC<2:0> NDIV<3:0> COSC<2:0> -- -- CDIV<3:0> ORDY NOSCR 0000 -000 u000 -000 -qqq 0000 -qqq 0000 -qqq qqqq -qqq qqqq -- -- -- 0--0 0--- 0--0 0--qqqq -q-q Preliminary 890h OSCSTAT EXTOR HFOR MFOR LFOR -- ADOR -- PLLR q000 -q-0 891h OSCEN EXTOEN HFOEN MFOEN LFOEN -- ADOEN -- -- 0000 -0-- 0000 -0-- 892h OSCTUNE -- -- --10 0000 --10 0000 893h OSCFRQ -- -- ---- -qqq ---- -qqq 894h -- 895h CLKRCON CLKREN -- -- 896h CLKRCLK -- -- -- 897h -- 89Fh -- Legend: HFTUN<5:0> -- -- -- HFFRQ<2:0> Unimplemented CLKRDC<1:0> -- CLKRDIV<2:0> CLKRCLK<3:0> Unimplemented -- -- 0--x xxxx 0--u uuuu ---- 0000 ---- 0000 -- -- x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. PIC16(L)F15313/23 DS40001897A-page 56 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR 0x00 xxxx 0q00 uuuu Bank 18 CPU CORE REGISTERS; see Table 4-3 for specifics 90Ch FVRCON 90Dh -- 90Eh DAC1CON0 EN -- OE1 90Fh DAC1CON1 -- -- -- 910h -- 91Eh -- 91Fh Legend: ZCDCON FVREN FVRRDY TSEN TSRNG CDAFVR<1:0> ADFVR<1:0> Unimplemented OE2 PSS<1:0> -- NSS DAC1R<4:0> Unimplemented ZCDSEN -- ZCDOUT ZCDPOL -- -- ZCDINTP ZCDINTN -- -- 0-00 00-0 0-00 00-0 ---0 0000 ---0 0000 -- -- 0-x0 --00 0-x0 --00 x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 57 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 19 CPU CORE REGISTERS; see Table 4-3 for specifics Preliminary 98Ch -- Unimplemented -- -- 98Dh -- Unimplemented -- -- 98Eh -- Unimplemented -- -- 98Fh CMOUT -- -- -- -- -- -- 990h CM1CON0 EN OUT -- POL -- 991h CM1CON1 -- -- -- -- -- 992h CM1NCH -- -- -- -- -- 993h CM1PCH -- -- -- -- -- 994h CM2CON0(1) EN OUT -- POL -- -- 995h CM2CON1(1) -- -- -- -- -- -- 996h CM2NCH(1) -- -- -- -- -- NCH<2:0> 997h CM2PCH(1) -- -- -- -- -- PCH<2:0> 994h -- 99Fh -- Legend: Note 1: MC2OUT MC1OUT ---- --00 ---- --00 -- HYS SYNC 00-0 --00 00-0 --00 -- INTP INTN ---- --00 ---- --00 NCH<2:0> ---- -000 ---- -000 PCH<2:0> ---- -000 ---- -000 HYS SYNC 00-0 --00 00-0 --00 INTP INTN ---- --00 ---- --00 ---- -000 ---- -000 ---- -000 ---- -000 -- -- Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Present only on PIC16(L)F15323. PIC16(L)F15313/23 DS40001897A-page 58 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR -- -- Bank 20 CPU CORE REGISTERS; see Table 4-3 for specifics A0Ch -- A1Fh Legend: -- Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 59 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR -- -- Bank 21-59 CPU CORE REGISTERS; see Table 4-3 for specifics x0Ch/ x8Ch -- x1Fh/ x9Fh Legend: -- Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 60 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 60 CPU CORE REGISTERS; see Table 4-3 for specifics 1E0Ch -- Unimplemented -- -- 1E0Dh -- Unimplemented -- -- 1E0Eh -- Unimplemented -- -- 1E0Fh CLCDATA ---- xxxx ---- uuuu 0-00 0000 0-00 0000 -- -- -- -- MLC4OUT Preliminary 1E10h CLCCON LC1EN -- LC1OUT LC1INTP LC1INTN 1E11h CLC1POL LC1POL -- -- -- LC1G4POL 1E12h CLC1SEL0 -- -- 1E13h CLC1SEL1 -- 1E14h CLC1SEL2 -- 1E15h CLC1SEL3 1E16h MLC3OUT MLC2OUT MLC1OUT LC1MODE<2:0> LC1G3POL LC1G2POL LC1G1POL 0--- uuuu LC1D1S<5:0> --xx xxxx --uu uuuu -- LC1D2S<5:0> --xx xxxx --uu uuuu -- LC1D3S<5:0> --xx xxxx --uu uuuu -- -- LC1D4S<5:0> --xx xxxx --uu uuuu CLC1GLS0 LC1G1D4T LC1G4D3N LC1G1D3T LC1G1D3N LC1G1D2T LC1G1D2N LC1G1D1T LC1G1D1N xxxx xxxx uuuu uuuu 1E17h CLC1GLS1 LC1G2D4T LC1G4D3N LC1G2D3T LC1G2D3N LC1G2D2T LC1G2D2N LC1G2D1T LC1G2D1N xxxx xxxx uuuu uuuu 1E18h CLC1GLS2 LC1G3D4T LC1G4D3N LC1G3D3T LC1G3D3N LC1G3D2T LC1G3D2N LC1G3D1T LC1G3D1N xxxx xxxx uuuu uuuu 1E19h CLC1GLS3 LC1G4D4T LC1G4D3N LC1G4D3T LC1G4D3N LC1G4D2T LC1G4D2N LC1G4D1T LC1G4D1N xxxx xxxx uuuu uuuu 1E1Ah CLC2CON LC2EN -- LC2OUT LC2INTP LC2INTN 0-00 0000 0-00 0000 1E1Bh CLC2POL LC2POL -- -- -- LC2G4POL 1E1Ch CLC2SEL0 -- -- 1E1Dh CLC2SEL1 -- 1E1Eh CLC2SEL2 -- 1E1Fh CLC2SEL3 1E20h LC2MODE<2:0> LC2G3POL LC2G2POL LC2G1POL DS40001897A-page 61 0--- xxxx 0--- uuuu LC2D1S<5:0> --xx xxxx --uu uuuu -- LC2D2S<5:0> --xx xxxx --uu uuuu -- LC2D3S<5:0> --xx xxxx --uu uuuu -- -- LC2D4S<5:0> --xx xxxx --uu uuuu CLC2GLS0 LC2G1D4T LC2G4D3N LC2G1D3T LC2G1D3N LC2G1D2T LC2G1D2N LC2G1D1T LC2G1D1N xxxx xxxx uuuu uuuu 1E21h CLC2GLS1 LC2G2D4T LC2G4D3N LC2G2D3T LC2G2D3N LC2G2D2T LC2G2D2N LC2G2D1T LC2G2D1N xxxx xxxx uuuu uuuu 1E22h CLC2GLS2 LC2G3D4T LC2G4D3N LC2G3D3T LC2G3D3N LC2G3D2T LC2G3D2N LC2G3D1T LC2G3D1N xxxx xxxx uuuu uuuu 1E23h CLC2GLS3 LC2G4D4T LC2G4D3N LC2G4D3T LC2G4D3N LC2G4D2T LC2G4D2N LC2G4D1T LC2G4D1N xxxx xxxx uuuu uuuu 1E24h CLC3CON LC3EN -- LC3OUT LC3INTP LC3INTN 0-00 0000 0-00 0000 1E25h CLC3POL LC3POL -- -- -- LC3G4POL 1E26h CLC3SEL0 -- -- 1E27h CLC3SEL1 -- 1E28h CLC3SEL2 -- 1E29h CLC3SEL3 1E2Ah CLC3GLS0 Legend: LC3MODE LC3G3POL LC3G2POL LC3G1POL 0--- xxxx 0--- uuuu LC3D1S<5:0> --xx xxxx --uu uuuu -- LC3D2S<5:0> --xx xxxx --uu uuuu -- LC3D3S<5:0> --xx xxxx --uu uuuu -- -- LC3D4S<5:0> --xx xxxx --uu uuuu LC3G1D4T LC3G4D3N xxxx xxxx uuuu uuuu LC3G1D3T LC3G1D3N LC3G1D2T LC3G1D2N LC3G1D1T LC3G1D1N x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. PIC16(L)F15313/23 0--- xxxx 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 60 (Continued) 1E2Bh CLC3GLS1 LC3G2D4T LC3G4D3N LC3G2D3T LC3G2D3N LC3G2D2T LC3G2D2N LC3G2D1T LC3G2D1N xxxx xxxx uuuu uuuu 1E2Ch CLC3GLS2 LC3G3D4T LC3G4D3N LC3G3D3T LC3G3D3N LC3G3D2T LC3G3D2N LC3G3D1T LC3G3D1N xxxx xxxx uuuu uuuu 1E2Dh CLC3GLS3 LC3G4D4T LC3G4D3N LC3G4D3T LC3G4D3N LC3G4D2T LC3G4D2N LC3G4D1T LC3G4D1N xxxx xxxx uuuu uuuu 1E2Eh CLC4CON LC4EN -- LC4OUT LC4INTP LC4INTN 0-00 0000 0-00 0000 1E2Fh CLC4POL LC4POL -- -- -- LC4G4POL 1E30h CLC4SEL0 -- -- 1E31h CLC4SEL1 -- 1E32h CLC4SEL2 -- 1E33h CLC4SEL3 1E34h LC4MODE<2:0> LC4G3POL LC4G2POL LC4G1POL Preliminary 0--- xxxx 0--- uuuu LC4D1S<5:0> --xx xxxx --uu uuuu -- LC4D2S<5:0> --xx xxxx --uu uuuu -- LC4D3S<5:0> --xx xxxx --uu uuuu -- -- LC4D4S<5:0> --xx xxxx --uu uuuu CLC4GLS0 LC4G1D4T LC4G4D3N LC4G1D3T LC4G1D3N LC4G1D2T LC4G1D2N LC4G1D1T LC4G1D1N xxxx xxxx uuuu uuuu 1E35h CLC4GLS1 LC4G2D4T LC4G4D3N LC4G2D3T LC4G2D3N LC4G2D2T LC4G2D2N LC4G2D1T LC4G2D1N xxxx xxxx uuuu uuuu 1E36h CLC4GLS2 LC4G3D4T LC4G4D3N LC4G3D3T LC4G3D3N LC4G3D2T LC4G3D2N LC4G3D1T LC4G3D1N xxxx xxxx uuuu uuuu 1E37h CLC4GLS3 LC4G4D4T LC4G4D3N LC4G4D3T LC4G4D3N LC4G4D2T LC4G4D2N LC4G4D1T LC4G4D1N xxxx xxxx uuuu uuuu 1E38h -- 1E6Fh -- -- -- Legend: Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. PIC16(L)F15313/23 DS40001897A-page 62 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 61 CPU CORE REGISTERS; see Table 4-3 for specifics 1E8Ch -- Unimplemented -- -- 1E8Dh -- Unimplemented -- -- 1E8Eh -- Unimplemented -- -- 1E8Fh PPSLOCK -- -- ---- ---0 ---- ---0 -- -- -- -- -- PPSLOCKED Preliminary INTPPS -- -- INTPPS<5:0> --00 1000 --uu uuuu T0CKIPPS -- -- T0CKIPPS<5:0> --00 0100 --uu uuuu 1E92h T1CKIPPS -- -- T1CKIPPS<5:0> --01 0000 --uu uuuu 1E93h T1GPPS -- -- T1GPPS<5:0> --00 1101 --uu uuuu 1E94h -- 1E9Bh -- -- -- 1E9Ch T2INPPS --01 0011 --uu uuuu 1E9Dh -- 1EA0h -- -- -- 1EA1h CCP1PPS -- -- CCP1PPS<5:0> --01 0010 --uu uuuu 1EA2h CCP2PPS -- -- CCP2PPS<5:0> --01 0001 --uu uuuu 1EA3h -- 1EB0h -- -- -- 1EB1h CWG1PPS --00 1000 --uu uuuu 1EB2h -- 1EBAh -- -- -- 1EBBh CLCIN0PPS -- -- CLCIN0PPS<5:0> --00 0000 --uu uuuu 1EBCh CLCIN1PPS -- -- CLCIN1PPS<5:0> --00 0001 --uu uuuu 1EBDh CLCIN2PPS -- -- CLCIN2PPS<5:0> --00 1110 --uu uuuu 1EBEh CLCIN3PPS -- -- CLCIN3PPS<5:0> --00 1111 --uu uuuu 1EBFh -- 1EC2h -- -- -- 1EC3h ADACTPPS --001100 --uuuuuu 1EC4h -- -- -- Legend: Unimplemented -- -- T2INPPS<5:0> Unimplemented Unimplemented -- -- CWG1PPS<5:0> Unimplemented Unimplemented -- -- CLCIN3PPS<5:0> Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. PIC16(L)F15313/23 DS40001897A-page 63 1E90h 1E91h 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 61 (Continued) 1EC5h SSP1CLKPPS -- -- SSP1CLKPPS<5:0> --01 0011 --uu uuuu 1EC6h SSP1DATPPS -- -- SSP1DATPPS<5:0> --01 0100 --uu uuuu 1EC7h SSP1SSPPS -- -- SSP1SSPPS<5:0> --00 0101 --uu uuuu 1ECBh RX1DTPPS -- -- RX1DTPPS<5:0> --01 0111 --uu uuuu 1ECCh TX1CKPPS -- -- TX1CKPPS<5:0> --01 0110 --uu uuuu 1ECDh -- Unimplemented -- -- 1ECEh -- Unimplemented -- -- 1ECFh -- 1EEFh -- Unimplemented -- -- Legend: x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Preliminary PIC16(L)F15313/23 DS40001897A-page 64 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 62 CPU CORE REGISTERS; see Table 4-3 for specifics Preliminary -- Unimplemented -- -- -- Unimplemented -- -- 1F0Eh -- Unimplemented -- -- 1F0Fh -- Unimplemented -- -- 1F10h RA0PPS -- -- -- RA0PPS<4:0> ---0 0000 ---u uuuu 1F11h RA1PPS -- -- -- RA1PPS<4:0> ---0 0000 ---u uuuu 1F12h RA2PPS -- -- -- RA2PPS<4:0> ---0 0000 ---u uuuu 1F13h RA3PPS -- -- -- RA3PPS<4:0> ---0 0000 ---u uuuu 1F14h RA4PPS -- -- -- RA4PPS<4:0> ---0 0000 ---u uuuu 1F15h RA5PPS -- -- -- RA5PPS<4:0> ---0 0000 ---u uuuu 1F16h -- 1F1Fh -- -- -- 1F20h RC0PPS(1) -- -- -- RC0PPS<4:0> ---0 0000 ---u uuuu 1F21h RC1PPS(1) -- -- -- RC1PPS<4:0> ---0 0000 ---u uuuu 1F22h RC2PPS(1) -- -- -- RC2PPS<4:0> ---0 0000 ---u uuuu 1F23h RC3PPS(1) -- -- -- RC3PPS<4:0> ---0 0000 ---u uuuu 1F24h RC4PPS(1) -- -- -- RC4PPS<4:0> ---0 0000 ---u uuuu 1F25h RC5PPS(1) -- -- -- RC5PPS<4:0> ---0 0000 ---u uuuu Legend: Note 1: Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Present only in PIC16(L)F15323. DS40001897A-page 65 PIC16(L)F15313/23 1F0Ch 1F0Dh 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR Bank 62 (Continued) Preliminary ANSELA -- -- ANSA5 ANSA4 -- ANSA2 ANSA1 ANSA0 --11 1111 --11 1111 1F39h WPUA -- -- WPUA5 WPUA4 WPUA3 WPUA2 WPUA1 WPUA0 --00 0000 --00 0000 1F3Ah ODCONA -- -- ODCA5 ODCA4 -- ODCA2 ODCA1 ODCA0 --00 0000 --00 0000 1F3Bh SLRCONA -- -- SLRA5 SLRA4 -- SLRA2 SLRA1 SLRA0 --11 1111 --11 1111 1F3Ch INLVLA -- -- INLVLA5 INLVLA4 INLVLA3 INLVLA2 INLVLA1 INLVLA0 --11 1111 --11 1111 1F3Dh IOCAP -- -- IOCAP5 IOCAP4 IOCAP3 IOCAP2 IOCAP1 IOCAP0 --00 0000 --00 0000 1F3Eh IOCAN -- -- IOCAN5 IOCAN4 IOCAN3 IOCAN2 IOCAN1 IOCAN0 --00 0000 --00 0000 1F3Fh IOCAF -- -- IOCAF5 IOCAF4 IOCAF3 IOCAF2 IOCAF1 IOCAF0 --00 0000 --00 0000 1F40h -- 1F4Dh -- -- -- 1F4Eh ANSELC(1) -- -- ANSC5 ANSC4 ANSC3 ANSC2 ANSC1 ANSC0 --11 1111 --11 1111 1F4Fh WPUC(1) -- -- WPUC5 WPUC4 WPUC3 WPUC2 WPUC1 WPUC0 --00 0000 --00 0000 1F50h ODCONC(1) -- -- ODCC5 ODCC4 ODCC3 ODCC2 ODCC1 ODCC0 --00 0000 --00 0000 1F51h SLRCONC(1) -- -- SLRC5 SLRC4 SLRC3 SLRC2 SLRC1 SLRC0 --11 1111 --11 1111 1F52h INLVLC(1) -- -- INLVLC5 INLVLC4 INLVLC3 INLVLC2 INLVLC1 INLVLC0 --11 1111 --11 1111 1F53h IOCCP(1) -- -- IOCCP5 IOCCP4 IOCCP3 IOCCP2 IOCCP1 IOCCP0 --00 0000 --00 0000 1F54h IOCCN(1) -- -- IOCCN5 IOCCN4 IOCCN3 IOCCN2 IOCCN1 IOCCN0 --00 0000 --00 0000 1F55h IOCCF(1) -- -- IOCCF5 IOCCF4 IOCCF3 IOCCF2 IOCCF1 IOCCF0 --00 0000 --00 0000 1F56h -- 1F6Fh -- -- -- Legend: Note 1: Unimplemented Unimplemented x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. Present only in PIC16(L)F15323. DS40001897A-page 66 PIC16(L)F15313/23 1F38h 2017 Microchip Technology Inc. TABLE 4-10: Address SPECIAL FUNCTION REGISTER SUMMARY BANKS 0-63 (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on: MCLR -- -- ---- -xxx ---- -uuu xxxx xxxx uuuu uuuu Bank 63 CPU CORE REGISTERS; see Table 4-3 for specifics 1F8Ch -- 1FE3h -- 1FE4h STATUS_SHAD 1FE5h WREG_SHAD 1FE6h BSR_SHAD -- 1FE7h PCLATH_SHAD -- Unimplemented -- -- -- -- -- Z DC C Working Register Shadow -- -- Bank Select Register Shadow Program Counter Latch High Register Shadow ---x xxxx ---u uuuu -xxx xxxx uuuu uuuu Preliminary 1FE8h FSR0L_SHAD Indirect Data Memory Address 0 Low Pointer Shadow xxxx xxxx uuuu uuuu 1FE9h FSR0H_SHAD Indirect Data Memory Address 0 High Pointer Shadow xxxx xxxx uuuu uuuu 1FEAh FSR1L_SHAD Indirect Data Memory Address 1 Low Pointer Shadow xxxx xxxx uuuu uuuu 1FEBh FSR1H_SHAD Indirect Data Memory Address 1 High Pointer Shadow xxxx xxxx uuuu uuuu 1FECh -- 1FEDh STKPTR -- 1FEEh TOSL Top of Stack Low byte 1FEFh TOSH -- Legend: Unimplemented -- -- Current Stack Pointer Top of Stack High byte -- -- ---1 1111 ---1 1111 xxxx xxxx uuuu uuuu -xxx xxxx -uuu uuuu x = unknown, u = unchanged, q = depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations unimplemented, read as `0'. PIC16(L)F15313/23 DS40001897A-page 67 PIC16(L)F15313/23 4.4 4.4.2 PCL and PCLATH The Program Counter (PC) is 15 bits wide. The low byte comes from the PCL register, which is a readable and writable register. The high byte (PC<14:8>) is not directly readable or writable and comes from PCLATH. On any Reset, the PC is cleared. Figure 4-3 shows the five situations for the loading of the PC. FIGURE 4-3: LOADING OF PC IN DIFFERENT SITUATIONS Rev. 10-000042A 7/30/2013 14 PCH PCL 0 PC 7 6 8 0 PCLATH Instruction with PCL as Destination PCH PCL 0 PC 6 4 0 PCLATH PCL 0 PC 6 7 0 PCLATH 14 PCH PCL 0 PCL 0 PC 4.4.4 BRW 15 PCH If using BRW, load the W register with the desired unsigned address and execute BRW. The entire PC will be loaded with the address PC + 1 + W. BRA 15 If using BRA, the entire PC will be loaded with PC + 1 + the signed value of the operand of the BRA instruction. PC + OPCODE <8:0> 4.4.1 BRANCHING The branching instructions add an offset to the PC. This allows relocatable code and code that crosses page boundaries. There are two forms of branching, BRW and BRA. The PC will have incremented to fetch the next instruction in both cases. When using either branching instruction, a PCL memory boundary may be crossed. PC + W 14 A computed function CALL allows programs to maintain tables of functions and provide another way to execute state machines or look-up tables. When performing a table read using a computed function CALL, care should be exercised if the table location crosses a PCL memory boundary (each 256-byte block). CALLW 8 W PC COMPUTED FUNCTION CALLS The CALLW instruction enables computed calls by combining PCLATH and W to form the destination address. A computed CALLW is accomplished by loading the W register with the desired address and executing CALLW. The PCL register is loaded with the value of W and PCH is loaded with PCLATH. 11 PCH 4.4.3 GOTO, CALL OPCODE <10:0> 14 A computed GOTO is accomplished by adding an offset to the program counter (ADDWF PCL). When performing a table read using a computed GOTO method, care should be exercised if the table location crosses a PCL memory boundary (each 256-byte block). Refer to Application Note AN556, "Implementing a Table Read" (DS00556). If using the CALL instruction, the PCH<2:0> and PCL registers are loaded with the operand of the CALL instruction. PCH<6:3> is loaded with PCLATH<6:3>. ALU result 14 COMPUTED GOTO MODIFYING PCL Executing any instruction with the PCL register as the destination simultaneously causes the Program Counter PC<14:8> bits (PCH) to be replaced by the contents of the PCLATH register. This allows the entire contents of the program counter to be changed by writing the desired upper seven bits to the PCLATH register. When the lower eight bits are written to the PCL register, all 15 bits of the program counter will change to the values contained in the PCLATH register and those being written to the PCL register. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 68 PIC16(L)F15313/23 4.5 4.5.1 Stack The stack is accessible through the TOSH, TOSL and STKPTR registers. STKPTR is the current value of the Stack Pointer. TOSH:TOSL register pair points to the TOP of the stack. Both registers are read/writable. TOS is split into TOSH and TOSL due to the 15-bit size of the PC. To access the stack, adjust the value of STKPTR, which will position TOSH:TOSL, then read/write to TOSH:TOSL. STKPTR is five bits to allow detection of overflow and underflow. All devices have a 16-level x 15-bit wide hardware stack (refer to Figure 4-4 through Figure 4-7). The stack space is not part of either program or data space. The PC is PUSHed onto the stack when CALL or CALLW instructions are executed or an interrupt causes a branch. The stack is POPed in the event of a RETURN, RETLW or a RETFIE instruction execution. PCLATH is not affected by a PUSH or POP operation. The stack operates as a circular buffer if the STVREN bit is programmed to `0` (Configuration Words). This means that after the stack has been PUSHed sixteen times, the seventeenth PUSH overwrites the value that was stored from the first PUSH. The eighteenth PUSH overwrites the second PUSH (and so on). The STKOVF and STKUNF flag bits will be set on an Overflow/Underflow, regardless of whether the Reset is enabled. Note: Care should be taken when modifying the STKPTR while interrupts are enabled. During normal program operation, CALL, CALLW and interrupts will increment STKPTR while RETLW, RETURN, and RETFIE will decrement STKPTR. STKPTR can be monitored to obtain to value of stack memory left at any given time. The STKPTR always points at the currently used place on the stack. Therefore, a CALL or CALLW will increment the STKPTR and then write the PC, and a return will unload the PC value from the stack and then decrement the STKPTR. Note 1: There are no instructions/mnemonics called PUSH or POP. These are actions that occur from the execution of the CALL, CALLW, RETURN, RETLW and RETFIE instructions or the vectoring to an interrupt address. FIGURE 4-4: ACCESSING THE STACK Reference Figure 4-4 through Figure 4-7 for examples of accessing the stack. ACCESSING THE STACK EXAMPLE 1 Rev. 10-000043A 7/30/2013 TOSH:TOSL 0x0F STKPTR = 0x1F Stack Reset Disabled (STVREN = 0) 0x0E 0x0D 0x0C 0x0B Initial Stack Configuration: 0x0A After Reset, the stack is empty. The empty stack is initialized so the Stack Pointer is pointing at 0x1F. If the Stack Overflow/Underflow Reset is enabled, the TOSH/TOSL register will return `0'. If the Stack Overflow/Underflow Reset is disabled, the TOSH/TOSL register will return the contents of stack address 0x0F. 0x09 0x08 0x07 0x06 0x05 0x04 0x03 0x02 0x01 0x00 TOSH:TOSL 2017 Microchip Technology Inc. 0x1F 0x0000 Preliminary STKPTR = 0x1F Stack Reset Enabled (STVREN = 1) DS40001897A-page 69 PIC16(L)F15313/23 FIGURE 4-5: ACCESSING THE STACK EXAMPLE 2 Rev. 10-000043B 7/30/2013 0x0F 0x0E 0x0D 0x0C 0x0B 0x0A This figure shows the stack configuration after the first CALL or a single interrupt. If a RETURN instruction is executed, the return address will be placed in the Program Counter and the Stack Pointer decremented to the empty state (0x1F). 0x09 0x08 0x07 0x06 0x05 0x04 0x03 0x02 0x01 TOSH:TOSL FIGURE 4-6: 0x00 Return Address STKPTR = 0x00 ACCESSING THE STACK EXAMPLE 3 Rev. 10-000043C 7/30/2013 0x0F 0x0E 0x0D 0x0C After seven CALLs or six CALLs and an interrupt, the stack looks like the figure on the left. A series of RETURN instructions will repeatedly place the return addresses into the Program Counter and pop the stack. 0x0B 0x0A 0x09 0x08 0x07 TOSH:TOSL 2017 Microchip Technology Inc. 0x06 Return Address 0x05 Return Address 0x04 Return Address 0x03 Return Address 0x02 Return Address 0x01 Return Address 0x00 Return Address Preliminary STKPTR = 0x06 DS40001897A-page 70 PIC16(L)F15313/23 FIGURE 4-7: ACCESSING THE STACK EXAMPLE 4 Rev. 10-000043D 7/30/2013 TOSH:TOSL 4.5.2 0x0F Return Address 0x0E Return Address 0x0D Return Address 0x0C Return Address 0x0B Return Address 0x0A Return Address 0x09 Return Address 0x08 Return Address 0x07 Return Address 0x06 Return Address 0x05 Return Address 0x04 Return Address 0x03 Return Address 0x02 Return Address 0x01 Return Address 0x00 Return Address When the stack is full, the next CALL or an interrupt will set the Stack Pointer to 0x10. This is identical to address 0x00 so the stack will wrap and overwrite the return address at 0x00. If the Stack Overflow/Underflow Reset is enabled, a Reset will occur and location 0x00 will not be overwritten. STKPTR = 0x10 OVERFLOW/UNDERFLOW RESET If the STVREN bit in Configuration Words (Register 5-2) is programmed to `1', the device will be Reset if the stack is PUSHed beyond the sixteenth level or POPed beyond the first level, setting the appropriate bits (STKOVF or STKUNF, respectively) in the PCON register. 4.6 Indirect Addressing The INDFn registers are not physical registers. Any instruction that accesses an INDFn register actually accesses the register at the address specified by the File Select Registers (FSR). If the FSRn address specifies one of the two INDFn registers, the read will return `0' and the write will not occur (though Status bits may be affected). The FSRn register value is created by the pair FSRnH and FSRnL. The FSR registers form a 16-bit address that allows an addressing space with 65536 locations. These locations are divided into three memory regions: * Traditional/Banked Data Memory * Linear Data Memory * Program Flash Memory 2017 Microchip Technology Inc. Preliminary DS40001897A-page 71 PIC16(L)F15313/23 FIGURE 4-8: INDIRECT ADDRESSING PIC16(L)F15313/23 Rev. 10-000044F 1/13/2017 0x0000 0x0000 Traditional Data Memory 0x1FFF 0x2000 Linear Data Memory 0X2FEF 0X2FF0 Reserved FSR Address Range 0x7FFF 0x8000 PC value = 0x000 Program Flash Memory 0x87FF 2017 Microchip Technology Inc. PC value = 0x7FF Preliminary DS40001897A-page 72 PIC16(L)F15313/23 4.6.1 TRADITIONAL/BANKED DATA MEMORY The traditional or banked data memory is a region from FSR address 0x000 to FSR address 0x1FFF. The addresses correspond to the absolute addresses of all SFR, GPR and common registers. FIGURE 4-9: TRADITIONAL/BANKED DATA MEMORY MAP Rev. 10-000056B 12/14/2016 Direct Addressing 5 BSR 0 Indirect Addressing From Opcode 6 0 Bank Select 7 FSRxH 0 0 0 Location Select 0x00 Bank Select 000000 000001 000010 111111 Bank 0 Bank 1 Bank 63 0 7 FSRxL 0 Location Select 0x7F 2017 Microchip Technology Inc. Bank 2 Preliminary DS40001897A-page 73 PIC16(L)F15313/23 4.6.2 4.6.3 LINEAR DATA MEMORY The linear data memory is the region from FSR address 0x2000 to FSR address 0X2FEF. This region is a virtual region that points back to the 80-byte blocks of GPR memory in all the banks. Refer to Figure 4-10 for the Linear Data Memory Map. Note: The address range 0x2000 to 0x2FF0 represents the complete addressable Linear Data Memory up to Bank 50. The actual implemented Linear Data Memory will differ from one device to the other in a family. Confirm the memory limits on every device. To make constant data access easier, the entire Program Flash Memory is mapped to the upper half of the FSR address space. When the MSB of FSRnH is set, the lower 15 bits are the address in program memory which will be accessed through INDF. Only the lower eight bits of each memory location is accessible via INDF. Writing to the Program Flash Memory cannot be accomplished via the FSR/INDF interface. All instructions that access Program Flash Memory via the FSR/INDF interface will require one additional instruction cycle to complete. FIGURE 4-11: Unimplemented memory reads as 0x00. Use of the linear data memory region allows buffers to be larger than 80 bytes because incrementing the FSR beyond one bank will go directly to the GPR memory of the next bank. The 16 bytes of common memory are not included in the linear data memory region. FIGURE 4-10: PROGRAM FLASH MEMORY PROGRAM FLASH MEMORY MAP Rev. 10-000058A 7/31/2013 7 1 FSRnH 0 Location Select 7 FSRnL 0 0x8000 LINEAR DATA MEMORY MAP Program Flash Memory (low 8 bits) Rev. 10-000057B 8/24/2016 7 FSRnH 0x0000 0 Location Select 7 FSRnL 0 0x2000 0x020 Bank 0 0x06F 0xFFFF 0x0A0 Bank 1 0x0EF 0x7FFF 0x120 Bank 2 0x16F 0x2FEF 2017 Microchip Technology Inc. 0x1920 Bank 50 0x196F Preliminary DS40001897A-page 74 PIC16(L)F15313/23 5.0 DEVICE CONFIGURATION Device configuration consists of the Configuration Words, User ID, Device ID, Device Information Area (DIA), (see Section 6.0 "Device Information Area"), and the Device Configuration Information (DCI) regions, (see Section 7.0 "Device Configuration Information"). 5.1 Configuration Words The devices have several Configuration Words starting at address 8007h. The Configuration bits establish configuration values prior to the execution of any software; Configuration bits enable or disable device-specific features. In terms of programming, these Configuration bits should be considered: important 1. LVP: Low-Voltage Programming Enable bit * 1 = ON - Low-Voltage Programming is enabled. MCLR/VPP pin function is MCLR. MCLRE Configuration bit is ignored. * 0 = OFF - HV on MCLR/VPP must be used for programming. 2. CP: User Nonvolatile Memory (NVM) Program Memory Code Protection bit * 1 = OFF - User NVM code protection disabled * 0 = ON - User NVM code protection enabled 2017 Microchip Technology Inc. Preliminary DS40001897A-page 75 PIC16(L)F15313/23 5.2 Register Definitions: Configuration Words REGISTER 5-1: CONFIGURATION WORD 1: OSCILLATORS R/P-1 U-1 R/P-1 U-1 U-1 R/P-1 FCMEN -- CSWEN -- -- CLKOUTEN bit 13 bit 8 U-1 R/P-1 R/P-1 R/P-1 U-1 R/P-1 R/P-1 R/P-1 -- RSTOSC2 RSTOSC1 RSTOSC0 -- FEXTOSC2 FEXTOSC1 FEXTOSC0 bit 7 bit 0 Legend: R = Readable bit P = Programmable bit x = Bit is unknown U = Unimplemented bit, read as `1' `0' = Bit is cleared `1' = Bit is set W = Writable bit n = Value when blank or after Bulk Erase bit 13 FCMEN: Fail-Safe Clock Monitor Enable bit 1 = FSCM timer enabled 0 = FSCM timer disabled bit 12 Unimplemented: Read as `1' bit 11 CSWEN: Clock Switch Enable bit 1 = Writing to NOSC and NDIV is allowed 0 = The NOSC and NDIV bits cannot be changed by user software bit 10-9 Unimplemented: Read as `1' bit 8 CLKOUTEN: Clock Out Enable bit If FEXTOSC = EC (high, mid or low) or Not Enabled: 1 = CLKOUT function is disabled; I/O or oscillator function on OSC2 0 = CLKOUT function is enabled; FOSC/4 clock appears at OSC2 Otherwise: This bit is ignored. bit 7 Unimplemented: Read as `1' bit 6-4 RSTOSC<2:0>: Power-up Default Value for COSC bits This value is the Reset-default value for COSC and selects the oscillator first used by user software. 111 = EXTOSC operating per FEXTOSC bits (device manufacturing default) 110 = HFINTOSC with HFFRQ = 3'b010 101 = LFINTOSC 100 = Reserved 011 = Reserved 010 = EXTOSC with 4x PLL, with EXTOSC operating per FEXTOSC bits 001 = EXTOSC with 2x PLL, with EXTOSC operating per FEXTOSC bits 000 = HFINTOSC with CDIV = 1:1 and HFFRQ = 3'b110 bit 3 Unimplemented: Read as `1' bit 2-0 FEXTOSC<2:0>:FEXTOSC External Oscillator Mode Selection bits 111 = EC (External Clock) above 8 MHz; PFM set to high power (device manufacturing default) 110 = EC (External Clock) for 100 kHz to 8 MHz; PFM set to medium power 101 = EC (External Clock) below 100 kHz 100 = Oscillator not enabled 011 = Reserved (do not use) 010 = HS (Crystal oscillator) above 4 MHz; PFM set to high power 001 = XT (Crystal oscillator) above 100 kHz, below 4 MHz; PFM set to medium power 000 = LP (Crystal oscillator) optimized for 32.768 kHz; PFM set to low power 2017 Microchip Technology Inc. Preliminary DS40001897A-page 76 PIC16(L)F15313/23 REGISTER 5-2: CONFIGURATION WORD 2: SUPERVISORS R/P-1 R/P-1 R/P-1 R/P-1 R/P-1 U-1 DEBUG STVREN PPS1WAY ZCDDIS BORV -- bit 13 bit 8 R/P-1 R/P-1 R/P-1 U-1 U-1 U-1 R/P-1 R/P-1 BOREN1 BOREN0 LPBOREN -- -- -- PWRTE MCLRE bit 7 bit 0 Legend: R = Readable bit P = Programmable bit x = Bit is unknown U = Unimplemented bit, read as `1' `0' = Bit is cleared `1' = Bit is set W = Writable bit n = Value when blank or after Bulk Erase bit 13 DEBUG: Debugger Enable bit 1 = Background debugger disabled 0 = Background debugger enabled bit 12 STVREN: Stack Overflow/Underflow Reset Enable bit 1 = Stack Overflow or Underflow will cause a Reset 0 = Stack Overflow or Underflow will not cause a Reset bit 11 PPS1WAY: PPSLOCK One-Way Set Enable bit 1 = The PPSLOCK bit can be cleared and set only once; PPS registers remain locked after one clear/set cycle 0 = The PPSLOCK bit can be set and cleared repeatedly (subject to the unlock sequence) bit 10 ZCDDIS: Zero-Cross Detect Disable bit 1 = ZCD disabled. ZCD can be enabled by setting the ZCDSEN bit of the ZCDCON register 0 = ZCD always enabled (ZCDSEN bit is ignored) bit 9 BORV: Brown-out Reset Voltage Selection bit(1) 1 = Brown-out Reset voltage (VBOR) set to lower trip point level 0 = Brown-out Reset voltage (VBOR) set to higher trip point level bit 8 Unimplemented: Read as `1' bit 7-6 BOREN<1:0>: Brown-out Reset Enable bits When enabled, Brown-out Reset Voltage (VBOR) is set by the BORV bit 11 = Brown-out Reset is enabled; SBOREN bit is ignored 10 = Brown-out Reset is enabled while running, disabled in Sleep; SBOREN bit is ignored 01 = Brown-out Reset is enabled according to SBOREN 00 = Brown-out Reset is disabled bit 5 LPBOREN: Low-Power BOR Enable bit 1 = ULPBOR is disabled 0 = ULPBOR is enabled bit 4-2 Unimplemented: Read as `1' bit 1 PWRTE: Power-up Timer Enable bit 1 = PWRT is disabled 0 = PWRT is enabled bit 0 MCLRE: Master Clear (MCLR) Enable bit If LVP = 1: RE3 pin function is MCLR (it will reset the device when driven low) If LVP = 0: 1 = MCLR pin is MCLR (it will reset the device when driven low) 0 = MCLR pin may be used as general purpose RE3 input Note 1: 2: See Vbor parameter for specific trip point voltages. The DEBUG bit in Configuration Words is managed automatically by device development tools including debuggers and programmers. For normal device operation, this bit should be maintained as a `1'. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 77 PIC16(L)F15313/23 REGISTER 5-3: CONFIGURATION WORD 3: WINDOWED WATCHDOG R/P-1 R/P-1 R/P-1 R/P-1 R/P-1 R/P-1 WDTCCS2 WDTCCS1 WDTCCS0 WDTCWS2 WDTCWS1 WDTCWS0 bit 13 bit 8 U-1 R/P-1 R/P-1 R/P-1 R/P-1 R/P-1 R/P-1 R/P-1 -- WDTE1 WDTE0 WDTCPS4 WDTCPS3 WDTCPS2 WDTCPS1 WDTCPS0 bit 7 bit 0 Legend: R = Readable bit P = Programmable bit x = Bit is unknown U = Unimplemented bit, read as `1' `0' = Bit is cleared `1' = Bit is set W = Writable bit n = Value when blank or after Bulk Erase bit 13-11 WDTCCS<2:0>: WDT Input Clock Selector bits 111 = Software Control 110 = Reserved . . . . 010 = Reserved 001 = WDT reference clock is the 31.0 kHz LFINTOSC 000 = WDT reference clock is the 31.25 kHz HFINTOSC (MFINTOSC) output bit 10-8 WDTCWS<2:0>: WDT Window Select bits WDTWS at POR Value Window delay Percent of time Window opening Percent of time 111 111 n/a 100 110 111 n/a 100 101 101 25 75 100 100 37.5 62.5 011 011 50 50 010 010 62.5 37.5 001 001 75 25 000 000 87.5 12.5 WDTCWS Software control of WDTWS? Keyed access required? Yes No No Yes bit 7 Unimplemented: Read as `1' bit 6-5 WDTE<1:0>: WDT Operating mode: 11 =WDT enabled regardless of Sleep; SWDTEN is ignored 10 =WDT enabled while Sleep = 0, suspended when Sleep = 1; SWDTEN ignored 01 =WDT enabled/disabled by SWDTEN bit in WDTCON0 00 =WDT disabled, SWDTEN is ignored 2017 Microchip Technology Inc. Preliminary DS40001897A-page 78 PIC16(L)F15313/23 REGISTER 5-3: bit 4-0 CONFIGURATION WORD 3: WINDOWED WATCHDOG (CONTINUED) WDTCPS<4:0>: WDT Period Select bits WDTPS at POR WDTCPS Typical Time Out (FIN = 31 kHz) Software Control of WDTPS? Value Divider Ratio 11111(1) 01011 1:65536 216 2s Yes 11110 ... 10011 11110 ... 10011 1:32 25 1 ms No 10010 10010 1:8388608 223 256 s 10001 10001 1:4194304 222 128 s 64 s 10000 10000 1:2097152 221 01111 01111 1:1048576 220 32 s 19 01110 01110 1:524299 2 16 s 01101 01101 1:262144 218 8s 17 01100 01100 1:131072 2 4s 01011 01011 1:65536 216 2s 1s 01010 01010 1:32768 215 01001 01001 1:16384 214 512 ms 256 ms 128 ms 01000 01000 1:8192 213 00111 00111 1:4096 212 11 64 ms 00110 00110 1:2048 2 00101 00101 1:1024 210 32 ms 16 ms 00100 00100 1:512 29 00011 00011 1:256 28 8 ms 4 ms 00010 00010 1:128 27 00001 00001 1:64 26 2 ms 1:32 5 1 ms 00000 Note 1: 00000 2 No 0b11111 is the default value of the WDTCPS bits. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 79 PIC16(L)F15313/23 REGISTER 5-4: CONFIGURATION WORD 4: MEMORY R/W-1 U-1 LVP R/W-1 -- bit 13 WRTSAF 12 U-1 (1) 11 -- R/W-1 WRTC 10 (1) R/W-1 WRTB(1) 9 bit 8 R/W-1 U-1 U-1 R/W-1 R/W-1 R/W-1 R/W-1 R/W-1 WRTAPP(1) -- -- SAFEN(1) BBEN(1) BBSIZE2 BBSIZE1 BBSIZE0 6 5 4 3 2 1 bit 7 bit 0 Legend: R = Readable bit P = Programmable bit x = Bit is unknown U = Unimplemented bit, read as `1' `0' = Bit is cleared `1' = Bit is set W = Writable bit n = Value when blank or after Bulk Erase bit 13 LVP: Low Voltage Programming Enable bit 1 = Low voltage programming enabled. MCLR/VPP pin function is MCLR. MCLRE Configuration bit is ignored. 0 = HV on MCLR/VPP must be used for programming. The LVP bit cannot be written (to zero) while operating from the LVP programming interface. The purpose of this rule is to prevent the user from dropping out of LVP mode while programming from LVP mode, or accidentally eliminating LVP mode from the configuration state. The preconditioned (erased) state for this bit is critical. bit 12 Unimplemented: Read as `1' bit 11 WRTSAF: Storage Area Flash Write Protection bit 1 = SAF NOT write-protected 0 = SAF write-protected Unimplemented, if SAF is not supported in the device family and only applicable if SAFEN = 0. bit 10 Unimplemented: Read as `1' bit 9 WRTC: Configuration Register Write Protection bit 1 = Configuration Register NOT write-protected 0 = Configuration Register write-protected bit 8 WRTB: Boot Block Write Protection bit 1 = Boot Block NOT write-protected 0 = Boot Block write-protected Only applicable if BBEN = 0. bit 7 WRTAPP: Application Block Write Protection bit 1 = Application Block NOT write-protected 0 = Application Block write-protected bit 6-5 Unimplemented: Read as `1' bit 4 SAFEN: SAF Enable bit 1 = SAF disabled 0 = SAF enabled bit 3 BBEN: Boot Block Enable bit 1 = Boot Block disabled 0 = Boot Block enabled bit 2-0 BBSIZE<2:0>: Boot Block Size Selection bits (See Table 5-1) BBSIZE is used only when BBEN = 0 BBSIZ bits can only be written while BBEN = 1; after BBEN = 0, BBSIZ is write-protected. Note 1: Bits are implemented as sticky bits. Once protection is enabled, it can only be reset through a Bulk Erase. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 80 PIC16(L)F15313/23 TABLE 5-1: BOOT BLOCK SIZE BITS Actual Boot Block Size User Program Memory Size (words) Last Boot Block Memory Access BBEN BBSIZE<2:0> 1 xxx 0 -- 0 111 512 01FFh 110-000 1024 03FFh 0 Note: The maximum boot block size is half the user program memory size. All selections higher than the maximum are set to half size. For example, all BBSIZE = 000 - 100 produce a boot block size of 4kW on a 8kW device. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 81 PIC16(L)F15313/23 REGISTER 5-5: CONFIGURATION WORD 5: CODE PROTECTION U-1 U-1 U-1 U-1 U-1 U-1 -- -- -- -- -- -- bit 13 bit 8 U-1 U-1 U-1 U-1 U-1 U-1 U-1 R/P-1 -- -- -- -- -- -- -- CP bit 7 bit 0 Legend: R = Readable bit P = Programmable bit x = Bit is unknown U = Unimplemented bit, read as `1' `0' = Bit is cleared `1' = Bit is set W = Writable bit n = Value when blank or after Bulk Erase bit 13-1 Unimplemented: Read as `1' bit 0 CP: Program Flash Memory Code Protection bit 1 = Program Flash Memory code protection disabled 0 = Program Flash Memory code protection enabled 2017 Microchip Technology Inc. Preliminary DS40001897A-page 82 PIC16(L)F15313/23 5.3 Code Protection Code protection allows the device to be protected from unauthorized access. Program memory protection and data memory are controlled independently. Internal access to the program memory is unaffected by any code protection setting. 5.3.1 PROGRAM MEMORY PROTECTION The entire program memory space is protected from external reads and writes by the CP bit in Configuration Words. When CP = 0, external reads and writes of program memory are inhibited and a read will return all `0's. The CPU can continue to read program memory, regardless of the protection bit settings. Self-writing the program memory is dependent upon the write protection setting. See Section 5.4 "Write Protection" for more information. 5.4 Write Protection Write protection allows the device to be protected from unintended self-writes. Applications, such as boot loader software, can be protected while allowing other regions of the program memory to be modified. The WRTAPP, WRTSAF, WRTB, WRTC bits in Configuration Words (Register 5-4) define whether the corresponding region of the program memory block is protected or not. 5.5 User ID Four memory locations (8000h-8003h) are designated as ID locations where the user can store checksum or other code identification numbers. These locations are readable and writable during normal execution. See Section 13.3.6 "NVMREG Access to Device Information Area, Device Configuration Area, User ID, Device ID and Configuration Words" for more information on accessing these memory locations. For more information on checksum calculation, see the "PIC16(L)F153xx Memory Programming Specification" (DS40001838). 2017 Microchip Technology Inc. Preliminary DS40001897A-page 83 PIC16(L)F15313/23 5.6 Device ID and Revision ID The 14-bit Device ID word is located at 8006h and the 14-bit Revision ID is located at 8005h. These locations are read-only and cannot be erased or modified. Development tools, such as device programmers and debuggers, may be used to read the Device ID, Revision ID and Configuration Words. These locations can also be read from the NVMCON register. 5.7 Register Definitions: Device and Revision REGISTER 5-6: DEVID: DEVICE ID REGISTER R R R R R R DEV<13:8> bit 13 R R bit 8 R R R R R R DEV<7:0> bit 7 bit 0 Legend: R = Readable bit `1' = Bit is set bit 13-0 `0' = Bit is cleared DEV<13:0>: Device ID bits Device DEVID<13:0> Values PIC16F15313 11 0000 1011 1110 (30BEh) PIC16LF15313 11 0000 1011 1111 (30BFh) PIC16F15323 11 0000 1100 0000 (30C0h) PIC16LF15323 11 0000 1100 0001 (30C1h) 2017 Microchip Technology Inc. Preliminary DS40001897A-page 84 PIC16(L)F15313/23 REGISTER 5-7: R R 1 0 REVISIONID: REVISION ID REGISTER R R R R R R MJRREV<5:0> R R R R R R MNRREV<5:0> bit 13 bit 0 Legend: R = Readable bit `0' = Bit is cleared `1' = Bit is set x = Bit is unknown bit 13-12 Fixed Value: Read-only bits These bits are fixed with value `10' for all devices included in this data sheet. bit 11-6 MJRREV<5:0>: Major Revision ID bits These bits are used to identify a major revision. bit 5-0 MNRREV<5:0>: Minor Revision ID bits These bits are used to identify a minor revision. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 85 PIC16(L)F15313/23 6.0 DEVICE INFORMATION AREA The Device Information Area (DIA) is a dedicated region in the program memory space; it is a new feature in the PIC16(L)F15313/23 family of devices. The DIA contains the calibration data for the internal temperature indicator module, stores the Microchip Unique Identifier words and the Fixed Voltage Reference voltage readings measured in mV. TABLE 6-1: The complete DIA table is shown in Table 6-1: Device Information Area, followed by a description of each region and its functionality. The data is mapped from 8100h to 811Fh in the PIC16(L)F15313/23 family. These locations are read-only and cannot be erased or modified. The data is programmed into the device during manufacturing. DEVICE INFORMATION AREA Address Range Name of Region Standard Device Information MUI0 MUI1 MUI2 MUI3 8100h-8108h MUI4 Microchip Unique Identifier (9 Words) MUI5 MUI6 MUI7 MUI8 8109h MUI9 1 Word Reserved EUI0 EUI1 EUI2 EUI3 810Ah-8111h EUI4 Unassigned (8 Words) EUI5 EUI6 EUI7 8112h TSLR1 Unassigned (1 word) 8113h TSLR2 Temperature indicator ADC reading at 90C (low range setting) 8114h TSLR3 Unassigned (1 word) 8115h TSHR1 Unassigned (1 word) 8116h TSHR2 Temperature indicator ADC reading at 90C (high range setting) 8117h TSHR3 Unassigned (1 Word) 8118h FVRA1X ADC FVR1 Output voltage for 1x setting (in mV) 8119h FVRA2X ADC FVR1 Output Voltage for 2x setting (in mV) 811Ah FVRA4X(1) ADC FVR1 Output Voltage for 4x setting (in mV) 811Bh FVRC1X Comparator FVR2 output voltage for 1x setting (in mV) 811Ch FVRC2X Comparator FVR2 output voltage for 2x setting (in mV) 811Dh FVRC4X(1) 811Eh-811Fh Note 1: Comparator FVR2 output voltage for 4x setting (in mV) Unassigned (2 Words) Value not present on LF devices. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 86 PIC16(L)F15313/23 6.1 Microchip Unique identifier (MUI) The PIC16(L)F15313/23 devices are individually encoded during final manufacturing with a Microchip Unique Identifier, or MUI. The MUI cannot be erased by a Bulk Erase command or any other user-accessible means. This feature allows for manufacturing traceability of Microchip Technology devices in applications where this is a required. It may also be used by the application manufacturer for a number of functions that require unverified unique identification, such as: * Tracking the device * Unique serial number The MUI consists of nine program words. When taken together, these fields form a unique identifier. The MUI is stored in nine read-only locations, located between 8100h to 8109h in the DIA space. Table 6-1 lists the addresses of the identifier words. Note: 6.2 For applications that require verified unique identification, contact your Microchip Technology sales office to create a Serialized Quick Turn Programming option. External Unique Identifier (EUI) The EUI data is stored at locations 810Ah to 8111h in the program memory region. This region is an optional space for placing application specific information. The data is coded per customer requirements during manufacturing. The EUI cannot be erased by a Bulk Erase command. Note: Data is stored in this address range on receiving a request from the customer. The customer may contact the local sales representative or Field Applications Engineer, and provide them the unique identifier information that is required to be stored in this region. 6.3 Analog-to-Digital Conversion Data of the Temperature Sensor The purpose of the temperature indicator module is to provide a temperature-dependent voltage that can be measured by an analog module. Section 19.0 "Temperature Indicator Module" explains the operation of the Temperature Indicator module and defines terms such as the low range and high range settings of the sensor. The DIA table contains the internal ADC measurement values of the temperature sensor for low and high range at fixed points of reference. The values are measured during test and are unique to each device. The right-justified ADC readings are stored in the DIA memory region. The calibration data can be used to plot the approximate sensor output voltage, VTSENSE vs. Temperature curve. * TSLR<3:1>: Address 8112h to 8114h store the measurements for the low range setting of the temperature sensor at VDD = 3V. * TSHR<3:1>: Address 8115h to 8117h store the measurements for the high range setting of the temperature sensor at VDD = 3V. The stored measurements are made by the device ADC using the internal VREF = 2.048V. 6.4 Fixed Voltage Reference Data The Fixed Voltage Reference, or FVR, is a stable voltage reference, independent of VDD, with 1.024V, 2.048V or 4.096V selectable output levels. The output of the FVR can be configured to supply a reference voltage to the following: * * * * ADC input channel ADC positive reference Comparator positive input Digital-to-Analog Converter For more information on the FVR, refer to Section 18.0 "Fixed Voltage Reference (FVR)". The DIA stores measured FVR voltages for this device in mV for the different buffer settings of 1x, 2x or 4x at program memory locations 8118h to 811Dh. * FVRA1X stores the value of ADC FVR1 Output voltage for 1x setting (in mV) * FVRA2X stores the value of ADC FVR1 Output Voltage for 2x setting (in mV) * FVRA4X stores the value of ADC FVR1 Output Voltage for 4x setting (in mV) * FVRC1X stores the value of Comparator FVR2 output voltage for 1x setting (in mV) * FVRC2X stores the value of Comparator FVR2 output voltage for 2x setting (in mV) * FVRC4X stores the value of Comparator FVR2 output voltage for 4x setting (in mV) 2017 Microchip Technology Inc. Preliminary DS40001897A-page 87 PIC16(L)F15313/23 7.0 DEVICE CONFIGURATION INFORMATION The Device Configuration Information (DCI) is a dedicated region in the Program Flash Memory mapped from 8200h to 821Fh. The data stored in the DCI memory is hard-coded into the device during manufacturing. TABLE 7-1: Refer to Table 7-1 for the complete DCI table address and description. The DCI holds information about the device which is useful for programming and bootloader applications. These locations are read-only and cannot be erased or modified. DEVICE CONFIGURATION INFORMATION FOR PIC16(L)F15313/23 DEVICES VALUE ADDRESS Name 8200h ERSIZ 8201h 8202h 8203h EESIZ EE Data memory size 8204h PCNT Pin Count 7.1 DESCRIPTION UNITS Erase Row Size 32 Words WLSIZ Number of write latches 32 Latches URSIZ Number of User Rows 64 Rows 0 Bytes 8/14 Pins DIA and DCI Access The DIA and DCI data are read-only and cannot be erased or modified. See 13.3.6 "NVMREG Access to Device Information Area, Device Configuration Area, User ID, Device ID and Configuration Words" for more information on accessing these memory locations. Development tools, such as device programmers and debuggers, may be used to read the DIA and DCI regions, similar to the Device ID and Revision ID. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 88 PIC16(L)F15313/23 8.0 A simplified block diagram of the On-Chip Reset Circuit is shown in Figure 8-1. RESETS There are multiple ways to reset this device: * * * * * * * * * * Power-on Reset (POR) Brown-out Reset (BOR) Low-Power Brown-out Reset (LPBOR) MCLR Reset WDT Reset RESET instruction Stack Overflow Stack Underflow Programming mode exit Memory Violation Reset (MEMV) To allow VDD to stabilize, an optional Power-up Timer can be enabled to extend the Reset time after a BOR or POR event. FIGURE 8-1: SIMPLIFIED BLOCK DIAGRAM OF ON-CHIP RESET CIRCUIT Rev. 10-000006F 8/30/2016 ICSPTM Programming Mode Exit RESET Instruction Memory Violation Stack Underflow Stack Overflow VPP/MCLR MCLRE WWDT Time-out/ Window violation Device Reset Power-on Reset VDD Brown-out Reset(1) R LFINTOSC Power-up Timer PWRTE LPBOR Reset Note 1: See Table 8-1 for BOR active conditions. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 89 PIC16(L)F15313/23 8.1 Power-on Reset (POR) The POR circuit holds the device in Reset until VDD has reached an acceptable level for minimum operation. Slow rising VDD, fast operating speeds or analog performance may require greater than minimum VDD. The PWRT, BOR or MCLR features can be used to extend the start-up period until all device operation conditions have been met. 8.2 Brown-out Reset (BOR) The BOR circuit holds the device in Reset when VDD reaches a selectable minimum level. Between the POR and BOR, complete voltage range coverage for execution protection can be implemented. The Brown-out Reset module has four operating modes controlled by the BOREN<1:0> bits in Configuration Words. The four operating modes are: * * * * BOR is always on BOR is off when in Sleep BOR is controlled by software BOR is always off Refer to Table 8-1 for more information. The Brown-out Reset voltage level is selectable by configuring the BORV bit in Configuration Words. A VDD noise rejection filter prevents the BOR from triggering on small events. If VDD falls below VBOR for a duration greater than parameter TBORDC, the device will reset. See Figure 8-2 for more information. TABLE 8-1: BOR OPERATING MODES Instruction Execution upon: Release of POR or Wake-up from Sleep BOREN<1:0> SBOREN Device Mode BOR Mode 11 X X Active Wait for release of BOR(1) (BORRDY = 1) Awake Active 10 X Sleep Disabled Waits for release of BOR (BORRDY = 1) Waits for BOR Reset release 1 X Active 0 X Disabled X X Disabled 01 00 Waits for BOR Reset release (BORRDY = 1) Begins immediately (BORRDY = x) Note 1: In this specific case, "Release of POR" and "Wake-up from Sleep", there is no delay in start-up. The BOR ready flag, (BORRDY = 1), will be set before the CPU is ready to execute instructions because the BOR circuit is forced on by the BOREN<1:0> bits. 8.2.1 BOR IS ALWAYS ON 8.2.2 BOR IS OFF IN SLEEP When the BOREN bits of Configuration Words are programmed to `11', the BOR is always on. The device start-up will be delayed until the BOR is ready and VDD is higher than the BOR threshold. When the BOREN bits of Configuration Words are programmed to `10', the BOR is on, except in Sleep. The device start-up will be delayed until the BOR is ready and VDD is higher than the BOR threshold. BOR protection is active during Sleep. The BOR does not delay wake-up from Sleep. BOR protection is not active during Sleep. The device wake-up will be delayed until the BOR is ready. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 90 PIC16(L)F15313/23 8.2.3 BOR CONTROLLED BY SOFTWARE When the BOREN bits of Configuration Words are programmed to `01', the BOR is controlled by the SBOREN bit of the BORCON register. The device start-up is not delayed by the BOR ready condition or the VDD level. 8.2.4 BOR IS ALWAYS OFF When the BOREN bits of the Configuration Words are programmed to `00', the BOR is off at all times. The device start-up is not delayed by the BOR ready condition or the VDD level. BOR protection begins as soon as the BOR circuit is ready. The status of the BOR circuit is reflected in the BORRDY bit of the BORCON register. BOR protection is unchanged by Sleep. FIGURE 8-2: BROWN-OUT SITUATIONS VDD Internal Reset VBOR TPWRT(1) VDD Internal Reset VBOR < TPWRT TPWRT(1) VDD VBOR Internal Reset Note 1: TPWRT(1) TPWRT delay only if PWRTE bit is programmed to `0'. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 91 PIC16(L)F15313/23 8.3 Register Definitions: Brown-out Reset Control REGISTER 8-1: R/W-1/u (1) SBOREN BORCON: BROWN-OUT RESET CONTROL REGISTER U-0 U-0 U-0 U-0 U-0 U-0 R-q/u -- -- -- -- -- -- BORRDY bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7 SBOREN: Software Brown-out Reset Enable bit(1) If BOREN <1:0> in Configuration Words 01: SBOREN is read/write, but has no effect on the BOR. If BOREN <1:0> in Configuration Words = 01: 1 = BOR Enabled 0 = BOR Disabled bit 6-1 Unimplemented: Read as `0' bit 0 BORRDY: Brown-out Reset Circuit Ready Status bit 1 = The Brown-out Reset circuit is active 0 = The Brown-out Reset circuit is inactive Note 1: BOREN<1:0> bits are located in Configuration Words. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 92 PIC16(L)F15313/23 8.4 8.5.2 Low-Power Brown-out Reset (LPBOR) The Low-Power Brown-out Reset (LPBOR) is an important part of the Reset subsystem. Refer to Figure 8-1 to see how the BOR and LPBOR interact with other modules. The LPBOR is used to monitor the external VDD pin. When too low of a voltage is detected, the device is held in Reset. 8.4.1 ENABLING LPBOR The LPBOR is controlled by the LPBOR bit of the Configuration Word (Register 5-1). When the device is erased, the LPBOR module defaults to disabled. 8.4.2 LPBOR MODULE OUTPUT The output of the LPBOR module is a signal indicating whether or not a Reset is to be asserted. When this occurs, a register bit (BOR) is changed to indicate that a BOR Reset has occurred. The same bit is set for either the BOR or the LPBOR (refer to Register 8-3). This signal is OR'd with the output of the BOR module to provide the generic BOR signal, which goes to the PCON register and to the power control block. Refer to Figure 8-1 for the OR gate connections of the BOR and LPBOR Reset signals, which eventually generates one common BOR Reset. 8.5 MCLR The MCLR is an optional external input that can reset the device. The MCLR function is controlled by the MCLRE bit of Configuration Words and the LVP bit of Configuration Words (Table 8-2). TABLE 8-2: LVP MCLR 0 0 Disabled 1 0 Enabled x 1 Enabled 8.5.1 MCLR ENABLED The device has a noise filter in the MCLR Reset path. The filter will detect and ignore small pulses. A Reset does not drive the MCLR pin low. 2017 Microchip Technology Inc. 8.6 Windowed Watchdog Timer (WWDT) Reset The Watchdog Timer generates a Reset if the firmware does not issue a CLRWDT instruction within the time-out period and the window is open. The TO and PD bits in the STATUS register and the WDT bit in PCON are changed to indicate a WDT Reset caused by the timer overflowing, and WDTWV bit in the PCON register is changed to indicate a WDT Reset caused by a window violation. See Section 12.0 "Windowed Watchdog Timer (WWDT)" for more information. 8.7 RESET Instruction A RESET instruction will cause a device Reset. The RI bit in the PCON register will be set to `0'. See Table 8-4 for default conditions after a RESET instruction has occurred. 8.8 Stack Overflow/Underflow Reset The device can reset when the Stack Overflows or Underflows. The STKOVF or STKUNF bits of the PCON register indicate the Reset condition. These Resets are enabled by setting the STVREN bit in Configuration Words. See Section 4.5.2 "Overflow/Underflow Reset" for more information. 8.9 8.10 When MCLR is enabled and the pin is held low, the device is held in Reset. The MCLR pin is connected to VDD through an internal weak pull-up. Refer to Section 2.3 "Master Clear (MCLR) Pin" for recommended MCLR connections. Note: When MCLR is disabled, the pin functions as a general purpose input and the internal weak pull-up is under software control. See Section 14.1 "I/O Priorities" for more information. Programming Mode Exit Upon exit of In-Circuit Serial ProgrammingTM (ICSPTM) mode, the device will behave as if a POR had just occurred (the device does not reset upon run time self-programming/erase operations). MCLR CONFIGURATION MCLRE MCLR DISABLED Power-up Timer The Power-up Timer optionally delays device execution after a BOR or POR event. This timer is typically used to allow VDD to stabilize before allowing the device to start running. The Power-up Timer is controlled by the PWRTE bit of the Configuration Words. The Power-up Timer provides a nominal 64 ms time out on POR or Brown-out Reset. The device is held in Reset as long as PWRT is active. The PWRT delay allows additional time for the VDD to rise to an acceptable level. The Power-up Timer is enabled by clearing the PWRTE bit in the Configuration Words. The Power-up Timer starts after the release of the POR and BOR. For additional information, refer to Application Note AN607, "Power-up Trouble Shooting" (DS00607). Preliminary DS40001897A-page 93 PIC16(L)F15313/23 8.11 Start-up Sequence Upon the release of a POR or BOR, the following must occur before the device will begin executing: 1. 2. 3. Power-up Timer runs to completion (if enabled). Oscillator start-up timer runs to completion (if required for oscillator source). MCLR must be released (if enabled). The total time-out will vary based on oscillator configuration and Power-up Timer Configuration. See Section 9.0 "Oscillator Module (with Fail-Safe Clock Monitor)" for more information. The Power-up Timer runs independently of MCLR Reset. If MCLR is kept low long enough, the Power-up Timer and oscillator start-up timer will expire. This is useful for testing purposes or to synchronize more than one device operating in parallel. See Figure 8-3. FIGURE 8-3: RESET START-UP SEQUENCE Rev. 10-000032C 9/14/2016 VDD Internal POR TPWRT Power-up Timer MCLR Internal RESET Int. Oscillator FOSC Begin Execution code execution (1) code execution (1) Internal Oscillator, PWRTEN = 0 Internal Oscillator, PWRTEN = 1 VDD Internal POR TPWRT Power-up Timer MCLR Internal RESET Ext. Clock (EC) FOSC Begin Execution code execution (1) External Clock (EC modes), PWRTEN = 0 Note 1: code execution (1) External Clock (EC modes), PWRTEN = 1 Code execution begins 10 FOSC cycles after the FOSC clock is released. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 94 PIC16(L)F15313/23 8.12 Memory Execution Violation A Memory Execution Violation Reset occurs if executing an instruction being fetched from outside the valid execution area. The different valid execution areas are defined as follows: * Flash Memory: Table 4-1 shows the addresses available on the PIC16(L)F15313/23 devices based on user Flash size. Execution outside this region generates a memory execution violation. * Storage Area Flash (SAF): If Storage Area Flash (SAF) is enabled (Section 4.2.3 "Storage Area Flash"), the SAF area (Table 4-2) is not a valid execution area. Prefetched instructions that are not executed do not cause memory execution violations. For example, a GOTO instruction in the last memory location will prefetch from an invalid location; this is not an error. If an instruction from an invalid location tries to execute, the memory violation is generated immediately, and any concurrent interrupt requests are ignored. When a memory execution violation is generated, the device is reset and flag MEMV is cleared in PCON1 (Register 8-3) to signal the cause. The flag needs to be set in code after a memory execution violation. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 95 PIC16(L)F15313/23 8.13 Determining the Cause of a Reset Upon any Reset, multiple bits in the STATUS and PCON registers are updated to indicate the cause of the Reset. Table 8-3 and Table 8-4 show the Reset conditions of these registers. STKUNF RWDT RMCLR RI POR BOR TO PD MEMV RESET STATUS BITS AND THEIR SIGNIFICANCE STOVF TABLE 8-3: 0 0 1 1 1 0 x 1 1 1 Power-on Reset 0 0 1 1 1 0 x 0 x u Illegal, TO is set on POR 0 0 1 1 1 0 x x 0 u Illegal, PD is set on POR 0 0 u 1 1 u 0 1 1 u Brown-out Reset u u 0 u u u u 0 u u WWDT Reset u u u u u u u 0 0 u WWDT Wake-up from Sleep u u u u u u u 1 0 u Interrupt Wake-up from Sleep u u u 0 u u u u u 1 MCLR Reset during normal operation u u u 0 u u u 1 0 u MCLR Reset during Sleep u u u u 0 u u u u u RESET Instruction Executed 1 u u u u u u u u u Stack Overflow Reset (STVREN = 1) u 1 u u u u u u u u Stack Underflow Reset (STVREN = 1) u u u u u u u u u 0 Memory violation Reset TABLE 8-4: Condition RESET CONDITION FOR SPECIAL REGISTERS Program Counter STATUS Register PCON0 Register PCON1 Register Power-on Reset 0000h ---1 1000 0011 110x ---- --1- MCLR Reset during normal operation 0000h ---u uuuu uuuu 0uuu ---- --1- MCLR Reset during Sleep 0000h ---1 0uuu uuuu 0uuu ---- --u- WWDT Timeout Reset 0000h ---0 uuuu uuu0 uuuu ---- --u- WWDT Wake-up from Sleep PC + 1 ---0 0uuu uuuu uuuu ---- --u- WWDT Window Violation 0000h ---u uuuu uu0u uuuu ---- --u- Brown-out Reset 0000h ---1 1000 0011 11u0 ---- --u- ---1 0uuu uuuu uuuu ---- --u- Condition Interrupt Wake-up from Sleep PC + 1 (1) RESET Instruction Executed 0000h ---u uuuu uuuu u0uu ---- --u- Stack Overflow Reset (STVREN = 1) 0000h ---u uuuu 1uuu uuuu ---- --u- Stack Underflow Reset (STVREN = 1) 0000h ---u uuuu u1uu uuuu ---- --u- Memory Violation Reset (MEMV = 0) 0 -uuu uuuu uuuu uuuu ---- --0- Legend: u = unchanged, x = unknown, - = unimplemented bit, reads as `0'. Note 1: When the wake-up is due to an interrupt and Global Enable bit (GIE) is set, the return address is pushed on the stack and PC is loaded with the interrupt vector (0004h) after execution of PC + 1. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 96 PIC16(L)F15313/23 8.14 Power Control (PCONx) Registers The Power Control (PCONx) registers contain flag bits to differentiate between a: * * * * * * Power-on Reset (POR) Brown-out Reset (BOR) Reset Instruction Reset (RI) MCLR Reset (RMCLR) Watchdog Timer Reset (RWDT) Watchdog Timer Window Violation Reset (WDTWV) * Stack Underflow Reset (STKUNF) * Stack Overflow Reset (STKOVF) * Memory Violation Reset (MEMV) The PCON0 register bits are shown in Register 8-2. The PCON1 register bits are shown in Register 8-3. Hardware will change the corresponding register bit during the Reset process; if the Reset was not caused by the condition, the bit remains unchanged (Table 8-4). Software should reset the bit to the inactive state after the restart (hardware will not reset the bit). Software may also set any PCON bit to the active state, so that user code may be tested, but no reset action will be generated. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 97 PIC16(L)F15313/23 8.15 Register Definitions: Power Control REGISTER 8-2: PCON0: POWER CONTROL REGISTER 0 R/W/HS-0/q R/W/HS-0/q STKOVF STKUNF R/W/HC-1/q R/W/HC-1/q R/W/HC-1/q WDTWV RWDT R/W/HC-1/q R/W/HC-q/u R/W/HC-q/u RI POR BOR RMCLR bit 7 bit 0 Legend: HC = Bit is cleared by hardware HS = Bit is set by hardware R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -m/n = Value at POR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7 STKOVF: Stack Overflow Flag bit 1 = A Stack Overflow occurred 0 = A Stack Overflow has not occurred or cleared by firmware bit 6 STKUNF: Stack Underflow Flag bit 1 = A Stack Underflow occurred 0 = A Stack Underflow has not occurred or cleared by firmware bit 5 WDTWV: WDT Window Violation Flag bit 1 = A WDT Window Violation Reset has not occurred or set to `1' by firmware 0 = A WDT Window Violation Reset has occurred (a CLRWDT instruction was executed either without arming the window or outside the window (cleared by hardware) bit 4 RWDT: Watchdog Timer Reset Flag bit 1 = A Watchdog Timer Reset has not occurred or set to `1' by firmware 0 = A Watchdog Timer Reset has occurred (cleared by hardware) bit 3 RMCLR: MCLR Reset Flag bit 1 = A MCLR Reset has not occurred or set to `1' by firmware 0 = A MCLR Reset has occurred (cleared by hardware) bit 2 RI: RESET Instruction Flag bit 1 = A RESET instruction has not been executed or set to `1' by firmware 0 = A RESET instruction has been executed (cleared by hardware) bit 1 POR: Power-on Reset Status bit 1 = No Power-on Reset occurred 0 = A Power-on Reset occurred (must be set in software after a Power-on Reset occurs) bit 0 BOR: Brown-out Reset Status bit 1 = No Brown-out Reset occurred 0 = A Brown-out Reset occurred (must be set in software after a Power-on Reset or Brown-out Reset occurs) 2017 Microchip Technology Inc. Preliminary DS40001897A-page 98 PIC16(L)F15313/23 REGISTER 8-3: PCON1: POWER CONTROL REGISTER 0 U-0 U-0 U-0 U-0 U-0 U-0 R/W/HC-1/u U-0 -- -- -- -- -- -- MEMV -- bit 7 bit 0 Legend: HC = Bit is cleared by hardware R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -m/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7-2 Unimplemented: Read as `0' bit 1 MEMV: Memory Violation Flag bit 1 = No Memory Violation Reset occurred or set to `1' by firmware. 0 = A Memory Violation Reset occurred (set to `0' in hardware when a Memory Violation occurs)) bit 0 Unimplemented: Read as `0' TABLE 8-5: SUMMARY OF REGISTERS ASSOCIATED WITH RESETS Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page BORCON SBOREN -- -- -- -- -- -- BORRDY 92 PCON0 STKOVF STKUNF WDTWV RWDT RMCLR RI POR BOR 99 PCON1 -- -- -- -- -- -- MEMV -- 99 STATUS -- -- -- TO PD Z DC C 32 WDTCON0 -- -- SWDTEN 150 Name WDTPS<4:0> Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by Resets. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 99 PIC16(L)F15313/23 9.0 OSCILLATOR MODULE (WITH FAIL-SAFE CLOCK MONITOR) 9.1 Overview The oscillator module has a wide variety of clock sources and selection features that allow it to be used in a wide range of applications while maximizing performance and minimizing power consumption. Figure 9-1 illustrates a block diagram of the oscillator module. Clock sources can be supplied from external oscillators, quartz-crystal resonators. In addition, the system clock source can be supplied from one of two internal oscillators and PLL circuits, with a choice of speeds selectable via software. Additional clock features include: * Selectable system clock source between external or internal sources via software. * Fail-Safe Clock Monitor (FSCM) designed to detect a failure of the external clock source (LP, XT, HS, ECH, ECM, ECL) and switch automatically to the internal oscillator. * Oscillator Start-up Timer (OST) ensures stability of crystal oscillator sources. The RSTOSC bits of Configuration Word 1 determine the type of oscillator that will be used when the device reset, including when it is first powered up. If an external clock source is selected, the FEXTOSC bits of Configuration Word 1 must be used to select the external clock mode. The external oscillator module can be configured in one of the following clock modes, by setting the FEXTOSC<2:0> bits of Configuration Word 1: 1. 2. 3. 4. 5. 6. ECL - External Clock Low-Power mode ECL<= 500 kHz ECM - External Clock Medium Power mode ECM <= 8 MHz ECH - External Clock High-Power mode ECH <= 32 MHz LP - 32 kHz Low-Power Crystal mode. XT - Medium Gain Crystal or Ceramic Resonator Oscillator mode (between 100 kHz and 4 MHz) HS - High Gain Crystal or Ceramic Resonator mode (above 4 MHz) The ECH, ECM, and ECL clock modes rely on an external logic level signal as the device clock source. The LP, XT, and HS clock modes require an external crystal or resonator to be connected to the device. Each mode is optimized for a different frequency range. The INTOSC internal oscillator block produces low and high-frequency clock sources, designated LFINTOSC and HFINTOSC. (see Internal Oscillator Block, Figure 9-1). A wide selection of device clock frequencies may be derived from these clock sources. The internal clock modes, LFINTOSC, HFINTOSC (set at 1 MHz), or HFINTOSC (set at 32 MHz) can be set through the RSTOSC bits. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 100 2017 Microchip Technology Inc. SIMPLIFIED PIC(R) MCU CLOCK SOURCE BLOCK DIAGRAM FIGURE 9-1: Rev. 10-000208K 1/12/2017 CLKIN External Oscillator (EXTOSC) CLKOUT CDIV<4:0> 4x PLL Mode COSC<2:0> 1001 111 256 1000 001 128 0111 64 0110 32 0101 16 0100 8 0011 4 0010 Sleep 2 0001 Idle 1 0000 Preliminary 9-bit Postscaler Divider 2x PLL Mode 010 LFINTOSC 100 31kHz Oscillator 101 110 Reserved 000 011 HFINTOSC Sleep System Clock SYSCMD HFFRQ<2:0> 1 - 32 MHz Oscillator MFINTOSC FSCM To Peripherals DS40001897A-page 101 500 kHz 31.25 kHz To Peripherals To Peripherals To Peripherals Peripheral Clock PIC16(L)F15313/23 512 PLLBlock PIC16(L)F15313/23 9.2 Clock Source Types Clock sources can be classified as external or internal. External clock sources rely on external circuitry for the clock source to function. Examples are: oscillator modules (ECH, ECM, ECL mode), quartz crystal resonators or ceramic resonators (LP, XT and HS modes). Internal clock sources are contained within the oscillator module. The internal oscillator block has two internal oscillators and a dedicated Phase Lock Loop (PLL) that are used to generate internal system clock sources. The High-Frequency Internal Oscillator (HFINTOSC) can produce a range from 1 to 32 MHz. The Low-Frequency Internal Oscillator (LFINTOSC) generates a 31 kHz frequency. The external oscillator block can also be used with the PLL. See Section 9.2.1.4 "4x PLL" for more details. The system clock can be selected between external or internal clock sources via the NOSC bits in the OSCCON1 register. See Section 9.3 "Clock Switching" for additional information. 9.2.1 EXTERNAL CLOCK SOURCES An external clock source can be used as the device system clock by performing one of the following actions: * Program the RSTOSC<2:0> bits in the Configuration Words to select an external clock source that will be used as the default system clock upon a device Reset * Write the NOSC<2:0> and NDIV<4:0> bits in the OSCCON1 register to switch the system clock source See Section 9.3 information. 9.2.1.1 "Clock Switching" for more EC Mode The External Clock (EC) mode allows an externally generated logic level signal to be the system clock source. When operating in this mode, an external clock source is connected to the OSC1 input. OSC2/CLKOUT is available for general purpose I/O or CLKOUT. Figure 9-2 shows the pin connections for EC mode. The Oscillator Start-up Timer (OST) is disabled when EC mode is selected. Therefore, there is no delay in operation after a Power-on Reset (POR) or wake-up from Sleep. Because the PIC(R) MCU design is fully static, stopping the external clock input will have the effect of halting the device while leaving all data intact. Upon restarting the external clock, the device will resume operation as if no time had elapsed. FIGURE 9-2: CLKIN Clock from Ext. System PIC(R) MCU FOSC/4 or I/O(1) Note 1: 9.2.1.2 EXTERNAL CLOCK (EC) MODE OPERATION OSC2/CLKOUT Output depends upon CLKOUTEN bit of the Configuration Words. LP, XT, HS Modes The LP, XT and HS modes support the use of quartz crystal resonators or ceramic resonators connected to OSC1 and OSC2 (Figure 9-3). The three modes select a low, medium or high gain setting of the internal inverter-amplifier to support various resonator types and speed. LP Oscillator mode selects the lowest gain setting of the internal inverter-amplifier. LP mode current consumption is the least of the three modes. This mode is designed to drive only 32.768 kHz tuning-fork type crystals (watch crystals). XT Oscillator mode selects the intermediate gain setting of the internal inverter-amplifier. XT mode current consumption is the medium of the three modes. This mode is best suited to drive crystals and resonators with a medium drive level specification. HS Oscillator mode selects the highest gain setting of the internal inverter-amplifier. HS mode current consumption is the highest of the three modes. This mode is best suited for resonators that require a high drive setting. Figure 9-3 and Figure 9-4 show typical circuits for quartz crystal and ceramic resonators, respectively. EC mode has three power modes to select from through Configuration Words: * ECH - High power, 32 MHz * ECM - Medium power, 8 MHz * ECL - Low power, 0.5 MHz 2017 Microchip Technology Inc. Preliminary DS40001897A-page 102 PIC16(L)F15313/23 FIGURE 9-3: QUARTZ CRYSTAL OPERATION (LP, XT OR HS MODE) FIGURE 9-4: CERAMIC RESONATOR OPERATION (XT OR HS MODE) Rev. 10-000059A 7/30/2013 PIC(R) MCU OSC1/CLKIN PIC(R) MCU C1 OSC1/CLKIN C1 To Internal Logic Quartz Crystal C2 RS(1) (2) RF RP(3) 2: C2 Ceramic RS(1) Resonator OSC2/CLKOUT A series resistor (Rs) may be required for quartz crystals with low drive level. Sleep Note 1: Quartz crystal characteristics vary according to type, package and manufacturer. The user should consult the manufacturer data sheets for specifications and recommended application. 2: Always verify oscillator performance over the VDD and temperature range that is expected for the application. 3: For oscillator design assistance, reference the following Microchip Application Notes: * AN826, "Crystal Oscillator Basics and Crystal Selection for rfPIC(R) and PIC(R) Devices" (DS00826) * AN849, "Basic PIC(R) Oscillator Design" (DS00849) * AN943, "Practical PIC(R) Oscillator Analysis and Design" (DS00943) * AN949, "Making Your Oscillator Work" (DS00949) OSC2/CLKOUT A series resistor (RS) may be required for ceramic resonators with low drive level. 2: The value of RF varies with the Oscillator mode selected (typically between 2 M to 10 M. The value of RF varies with the Oscillator mode selected (typically between 2 M and 10 M). 2017 Microchip Technology Inc. RF(2) Sleep Note 1: Note 1: To Internal Logic 3: An additional parallel feedback resistor (RP) may be required for proper ceramic resonator operation. 9.2.1.3 Oscillator Start-up Timer (OST) If the oscillator module is configured for LP, XT or HS modes, the Oscillator Start-up Timer (OST) counts 1024 oscillations from OSC1. This occurs following a Power-on Reset (POR), Brown-out Reset (BOR) or a wake-up from Sleep. The OST ensures that the oscillator circuit, using a quartz crystal resonator or ceramic resonator, has started and is providing a stable system clock to the oscillator module. Preliminary DS40001897A-page 103 PIC16(L)F15313/23 9.2.1.4 4x PLL 9.2.2 The oscillator module contains a PLL that can be used with external clock sources and internal oscillator to provide a system clock source. The input frequency for the PLL must fall within specifications. See the PLL Clock Timing Specifications in Table 37-9. The PLL may be enabled for use by one of two methods: 1. 2. Program the RSTOSC bits in the Configuration Word 1 to enable the EXTOSC with 4x PLL. Write the NOSC bits in the OSCCON1 register to enable the EXTOSC with 4x PLL. Note 1: Quartz crystal characteristics vary according to type, package and manufacturer. The user should consult the manufacturer data sheets for specifications and recommended application. 2: Always verify oscillator performance over the VDD and temperature range that is expected for the application. 3: For oscillator design assistance, reference the following Microchip Application Notes: * AN826, "Crystal Oscillator Basics and Crystal Selection for rfPIC(R) and PIC(R) Devices" (DS00826) * AN849, "Basic PIC(R) Oscillator Design" (DS00849) * AN943, "Practical PIC(R) Oscillator Analysis and Design" (DS00943) * AN949, "Making Your Oscillator Work" (DS00949) * TB097, "Interfacing a Micro Crystal MS1V-T1K 32.768 kHz Tuning Fork Crystal to a PIC16F690/SS" (DS91097) * AN1288, "Design Practices for Low-Power External Oscillators" (DS01288) 2017 Microchip Technology Inc. INTERNAL CLOCK SOURCES The device may be configured to use an internal oscillator block as the system clock by performing one of the following actions: * Program the RSTOSC<2:0> bits in Configuration Words to select the INTOSC clock source, which will be used as the default system clock upon a device Reset. * Write the NOSC<2:0> bits in the OSCCON1 register to switch the system clock source to the internal oscillator during run-time. See Section 9.3 "Clock Switching" for more information. In INTOSC mode, CLKIN is available for general purpose I/O. CLKOUT is available for general purpose I/O or CLKOUT. The function of the CLKOUT pin is determined by the CLKOUTEN bit in Configuration Words. The internal oscillator block has two independent oscillators that can produce two internal system clock sources. 1. 2. Preliminary The HFINTOSC (High-Frequency Internal Oscillator) is factory calibrated and operates up to 32 MHz. The frequency of HFINTOSC can be selected through the OSCFRQ Frequency Selection register, and fine-tuning can be done via the OSCTUNE register. The LFINTOSC (Low-Frequency Internal Oscillator) is factory-calibrated and operates at 31 kHz. DS40001897A-page 104 PIC16(L)F15313/23 9.2.2.1 HFINTOSC 9.2.2.2 The High-Frequency Internal Oscillator (HFINTOSC) is a precision digitally-controlled internal clock source that produces a stable clock up to 32 MHz. The HFINTOSC can be enabled through one of the following methods: * Programming the RSTOSC<2:0> bits in Configuration Word 1 to `110' (1 MHz) or `001' (32 MHz) to set the oscillator upon device Power-up or Reset. * Write to the NOSC<2:0> bits of the OSCCON1 register during run-time. The HFINTOSC frequency can be selected by setting the HFFRQ<2:0> bits of the OSCFRQ register. The MFINTOSC is an internal clock source within the HFINTOSC that provides two (500 kHz, 32 kHz) constant clock outputs. These constant clock outputs are available for selection to various peripherals, internally. The NDIV<3:0> bits of the OSCCON1 register allow for division of the HFINTOSC output from a range between 1:1 and 1:512. Internal Oscillator Frequency Adjustment The internal oscillator is factory-calibrated. This internal oscillator can be adjusted in software by writing to the OSCTUNE register (Register 9-7). The default value of the OSCTUNE register is 00h. The value is a 6-bit two's complement number. A value of 1Fh will provide an adjustment to the maximum frequency. A value of 20h will provide an adjustment to the minimum frequency. When the OSCTUNE register is modified, the oscillator frequency will begin shifting to the new frequency. Code execution continues during this shift. There is no indication that the shift has occurred. OSCTUNE does not affect the LFINTOSC frequency. Operation of features that depend on the LFINTOSC clock source frequency, such as the Power-up Timer (PWRT), Watchdog Timer (WDT), Fail-Safe Clock Monitor (FSCM) and peripherals, are not affected by the change in frequency. 9.2.2.3 LFINTOSC The Low-Frequency Internal Oscillator (LFINTOSC) is a factory-calibrated 31 kHz internal clock source. The LFINTOSC is the clock source for the Power-up Timer (PWRT), Watchdog Timer (WDT) and Fail-Safe Clock Monitor (FSCM). The LFINTOSC can also be used as the system clock, or as a clock or input source to certain peripherals. The LFINTOSC is selected as the clock source through one of the following methods: * Programming the RSTOSC<2:0> bits of Configuration Word 1 to enable LFINTOSC. * Write to the NOSC<2:0> bits of the OSCCON1 register. 9.2.2.4 Oscillator Status and Manual Enable The `ready' status of each oscillator is displayed in the OSCSTAT register (Register 9-4). The oscillators can also be manually enabled through the OSCEN register (Register 9-7). Manual enabling makes it possible to verify the operation of the EXTOSC oscillator. This can be achieved by enabling the selected oscillator, then watching the corresponding `ready' state of the oscillator in the OSCSTAT register. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 105 PIC16(L)F15313/23 9.3 Clock Switching The system clock source can be switched between external and internal clock sources via software using the New Oscillator Source (NOSC) and New Divider selection request (NDIV) bits of the OSCCON1 register. 9.3.1 NEW OSCILLATOR SOURCE (NOSC) AND NEW DIVIDER SELECTION REQUEST (NDIV) BITS The New Oscillator Source (NOSC) and New Divider selection request (NDIV) bits of the OSCCON1 register select the system clock source and the frequency that are used for the CPU and peripherals. When new values of NOSC and NDIV are written to OSCCON1, the current oscillator selection will continue to operate while waiting for the new clock source to indicate that it is stable and ready. In some cases, the newly requested source may already be in use, and is ready immediately. In the case of a divider-only change, the new and old sources are the same, and will be immediately ready. The device may enter Sleep while waiting for the switch as described in Section 9.3.3 "Clock Switch and Sleep". When the new oscillator is ready, the New Oscillator is Ready (NOSCR) bit of OSCCON3 and the Clock Switch Interrupt Flag (CSWIF) bit of PIR1 become set (CSWIF = 1). If Clock Switch Interrupts are enabled (CSWIE = 1), an interrupt will be generated at that time. The Oscillator Ready (ORDY) bit of OSCCON3 can also be polled to determine when the oscillator is ready in lieu of an interrupt. If the Clock Switch Hold (CSWHOLD) bit of OSCCON3 is clear, the oscillator switch will occur when the new Oscillator's READY bit (NOSCR) is set, and the interrupt (if enabled) will be serviced at the new oscillator setting. If CSWHOLD is set, the oscillator switch is suspended, while execution continues using the current (old) clock source. When the NOSCR bit is set, software should: * set CSWHOLD = 0 so the switch can complete, or * copy COSC into NOSC to abandon the switch. Changing the clock post-divider without changing the clock source (e.g., changing FOSC from 1 MHz to 2 MHz) is handled in the same manner as a clock source change, as described previously. The clock source will already be active, so the switch is relatively quick. CSWHOLD must be clear (CSWHOLD = 0) for the switch to complete. The current COSC and CDIV are indicated in the OSCCON2 register up to the moment when the switch actually occurs, at which time OSCCON2 is updated and ORDY is set. NOSCR is cleared by hardware to indicate that the switch is complete. 9.3.2 PLL INPUT SWITCH Switching between the PLL and any non-PLL source is managed as described above. The input to the PLL is established when NOSC selects the PLL, and maintained by the COSC setting. When NOSC and COSC select the PLL with different input sources, the system continues to run using the COSC setting, and the new source is enabled per NOSC. When the new oscillator is ready (and CSWHOLD = 0), system operation is suspended while the PLL input is switched and the PLL acquires lock. Note: 9.3.3 If the PLL fails to lock, the FSCM will trigger. CLOCK SWITCH AND SLEEP If OSCCON1 is written with a new value and the device is put to Sleep before the switch completes, the switch will not take place and the device will enter Sleep mode. When the device wakes from Sleep and the CSWHOLD bit is clear, the device will wake with the `new' clock active, and the clock switch interrupt flag bit (CSWIF) will be set. When the device wakes from Sleep and the CSWHOLD bit is set, the device will wake with the `old' clock active and the new clock will be requested again. If DOZE is in effect, the switch occurs on the next clock cycle, whether or not the CPU is operating during that cycle. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 106 PIC16(L)F15313/23 FIGURE 9-5: CLOCK SWITCH (CSWHOLD = 0) OSCCON1 WRITTEN OSC #1 OSC #2 ORDY NOTE 2 NOSCR NOTE 1 CSWIF CSWHOLD USER CLEAR Note 1: CSWIF is asserted coincident with NOSCR; interrupt is serviced at OSC#2 speed. 2: The assertion of NOSCR is hidden from the user because it appears only for the duration of the switch. FIGURE 9-6: CLOCK SWITCH (CSWHOLD = 1) OSCCON1 WRITTEN OSC #1 OSC #2 ORDY NOSCR CSWIF NOTE 1 USER CLEAR CSWHOLD Note 1: CSWIF is asserted coincident with NOSCR, and may be cleared before or after clearing CSWHOLD = 0. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 107 PIC16(L)F15313/23 FIGURE 9-7: CLOCK SWITCH ABANDONED OSCCON1 WRITTEN OSCCON1 WRITTEN OSC #1 NOTE 2 ORDY NOSCR CSWIF NOTE 1 CSWHOLD Note 1: CSWIF may be cleared before or after rewriting OSCCON1; CSWIF is not automatically cleared. 2: ORDY = 0 if OSCCON1 does not match OSCCON2; a new switch will begin. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 108 PIC16(L)F15313/23 9.4 9.4.2 Fail-Safe Clock Monitor The Fail-Safe Clock Monitor (FSCM) allows the device to continue operating should the external oscillator fail. The FSCM is enabled by setting the FCMEN bit in the Configuration Words. The FSCM is applicable to all external Oscillator modes (LP, XT, HS, ECL, ECM, ECH. FIGURE 9-8: FSCM BLOCK DIAGRAM Clock Monitor Latch External Clock S Q FAIL-SAFE OPERATION When the external clock fails, the FSCM switches the device clock to the HFINTOSC at 1 MHz clock frequency and sets the bit flag OSFIF of the PIR1 register. Setting this flag will generate an interrupt if the OSFIE bit of the PIE1 register is also set. The device firmware can then take steps to mitigate the problems that may arise from a failed clock. The system clock will continue to be sourced from the internal clock source until the device firmware successfully restarts the external oscillator and switches back to external operation, by writing to the NOSC and NDIV bits of the OSCCON1 register. 9.4.3 LFINTOSC Oscillator / 64 31 kHz (~32 s) 488 Hz (~2 ms) R Q Sample Clock 9.4.1 Clock Failure Detected FAIL-SAFE DETECTION The FSCM module detects a failed oscillator by comparing the external oscillator to the FSCM sample clock. The sample clock is generated by dividing the LFINTOSC by 64. See Figure 9-8. Inside the fail detector block is a latch. The external clock sets the latch on each falling edge of the external clock. The sample clock clears the latch on each rising edge of the sample clock. A failure is detected when an entire half-cycle of the sample clock elapses before the external clock goes low. FIGURE 9-9: FAIL-SAFE CONDITION CLEARING The Fail-Safe condition is cleared after a Reset, executing a SLEEP instruction or changing the NOSC and NDIV bits of the OSCCON1 register. When switching to the external oscillator, or external oscillator and PLL, the OST is restarted. While the OST is running, the device continues to operate from the INTOSC selected in OSCCON1. When the OST times out, the Fail-Safe condition is cleared after successfully switching to the external clock source. The OSFIF bit should be cleared prior to switching to the external clock source. If the Fail-Safe condition still exists, the OSFIF flag will again become set by hardware. 9.4.4 RESET OR WAKE-UP FROM SLEEP The FSCM is designed to detect an oscillator failure after the Oscillator Start-up Timer (OST) has expired. The OST is used after waking up from Sleep and after any type of Reset. The OST is not used with the EC Clock modes so that the FSCM will be active as soon as the Reset or wake-up has completed. Therefore, the device will always be executing code while the OST is operating. FSCM TIMING DIAGRAM Sample Clock Oscillator Failure System Clock Output Clock Monitor Output (Q) Failure Detected OSCFIF Test Note: Test Test The system clock is normally at a much higher frequency than the sample clock. The relative frequencies in this example have been chosen for clarity. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 109 PIC16(L)F15313/23 9.5 Register Definitions: Oscillator Control REGISTER 9-1: OSCCON1: OSCILLATOR CONTROL REGISTER1 R/W-f/f(1) U-0 -- R/W-f/f(1) NOSC<2:0> R/W-f/f(1) R/W-q/q (2,3) R/W-q/q R/W-q/q R/W-q/q NDIV<3:0>(2,3,4) bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared f = determined by fuse setting bit 7 Unimplemented: Read as `0' bit 6-4 NOSC<2:0>: New Oscillator Source Request bits The setting requests a source oscillator and PLL combination per Table 9-1. POR value = RSTOSC (Register 5-1). bit 3-0 NDIV<3:0>: New Divider Selection Request bits The setting determines the new postscaler division ratio per Table 9-1. Note 1: 2: 3: 4: The default value (f/f) is set equal to the RSTOSC Configuration bits. If NOSC is written with a reserved value (Table 9-1), the operation is ignored and neither NOSC nor NDIV is written. When CSWEN = 0, this register is read-only and cannot be changed from the POR value. When NOSC = 110 (HFINTOSC 4 MHz), the NDIV bits will default to `0010' upon Reset; for all other NOSC settings the NDIV bits will default to `0000' upon Reset. REGISTER 9-2: OSCCON2: OSCILLATOR CONTROL REGISTER 2 R-n/n(2) U-0 -- R-n/n(2) R-n/n(2) R-n/n(2) R-n/n(2) COSC<2:0> R-n/n(2) R-n/n(2) CDIV<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 Unimplemented: Read as `0' bit 6-4 COSC<2:0>: Current Oscillator Source Select bits (read-only) Indicates the current source oscillator and PLL combination per Table 9-1. bit 3-0 CDIV<3:0>: Current Divider Select bits (read-only) Indicates the current postscaler division ratio per Table 9-1. Note 1: The POR value is the value present when user code execution begins. 2: The Reset value (n/n) is the same as the NOSC/NDIV bits. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 110 PIC16(L)F15313/23 TABLE 9-1: NOSC/COSC BIT SETTINGS TABLE 9-2: NDIV/CDIV BIT SETTINGS NOSC<2:0>/ COSC<2:0> Clock Source NDIV<3:0>/ CDIV<3:0> Clock divider 111 EXTOSC(1) 1111-1010 Reserved 110 HFINTOSC(2) 1001 512 101 LFINTOSC 1000 256 100 Reserved 0111 128 011 Reserved (operates like NOSC = 110) 0110 64 0101 32 Note 1: 2: 010 EXTOSC with 4x PLL(1) 0100 16 001 HFINTOSC with 2x PLL(1) 0011 8 000 Reserved (it operates like NOSC = 110) 0010 4 0001 2 0000 1 EXTOSC configured by the FEXTOSC bits of Configuration Word 1 (Register 5-1). HFINTOSC settings are configured with the HFFRQ bits of the OSCFRQ register (Register 9-6). REGISTER 9-3: OSCCON3: OSCILLATOR CONTROL REGISTER 3 R/W/HC-0/0 U-0 U-0 R-0/0 R-0/0 U-0 U-0 U-0 CSWHOLD -- -- ORDY NOSCR -- -- -- bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 CSWHOLD: Clock Switch Hold bit 1 = Clock switch will hold (with interrupt) when the oscillator selected by NOSC is ready 0 = Clock switch may proceed when the oscillator selected by NOSC is ready; if this bit is clear at the time that NOSCR becomes `1', the switch will occur bit 6-5 Unimplemented: Read as `0'. bit 4 ORDY: Oscillator Ready bit (read-only) 1 = OSCCON1 = OSCCON2; the current system clock is the clock specified by NOSC 0 = A clock switch is in progress bit 3 NOSCR: New Oscillator is Ready bit (read-only) 1 = A clock switch is in progress and the oscillator selected by NOSC indicates a "ready" condition 0 = A clock switch is not in progress, or the NOSC-selected oscillator is not yet ready bit 2-0 Unimplemented: Read as `0' 2017 Microchip Technology Inc. Preliminary DS40001897A-page 111 PIC16(L)F15313/23 REGISTER 9-4: OSCSTAT: OSCILLATOR STATUS REGISTER 1 R-q/q R-q/q R-q/q R-q/q U-0 R-q/q U-0 R-q/q EXTOR HFOR MFOR LFOR -- ADOR -- PLLR bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 EXTOR: EXTOSC (external) Oscillator Ready bit 1 = The oscillator is ready to be used 0 = The oscillator is not enabled, or is not yet ready to be used. bit 6 HFOR: HFINTOSC Oscillator Ready bit 1 = The oscillator is ready to be used 0 = The oscillator is not enabled, or is not yet ready to be used. bit 5 MFOR: MFINTOSC Oscillator Ready bit 1 = The oscillator is ready to be used 0 = The oscillator is not enabled, or is not yet ready to be used. bit 4 LFOR: LFINTOSC Oscillator Ready bit 1 = The oscillator is ready to be used 0 = The oscillator is not enabled, or is not yet ready to be used. bit 3 Unimplemented: Read as `0' bit 2 ADOR: CRC Oscillator Ready bit 1 = The oscillator is ready to be used 0 = The oscillator is not enabled, or is not yet ready to be used. bit 1 Unimplemented: Read as `0' bit 0 PLLR: PLL is Ready bit 1 = The PLL is ready to be used 0 = The PLL is not enabled, the required input source is not ready, or the PLL is not locked. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 112 PIC16(L)F15313/23 REGISTER 9-5: OSCEN: OSCILLATOR MANUAL ENABLE REGISTER R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 U-0 R/W-0/0 U-0 U-0 EXTOEN HFOEN MFOEN LFOEN -- ADOEN -- -- bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 EXTOEN: External Oscillator Manual Request Enable bit(1) 1 = EXTOSC is explicitly enabled, operating as specified by FEXTOSC 0 = EXTOSC could be enabled by some modules bit 6 HFOEN: HFINTOSC Oscillator Manual Request Enable bit 1 = HFINTOSC is explicitly enabled, operating as specified by OSCFRQ 0 = HFINTOSC could be enabled by another module bit 5 MFOEN: MFINTOSC Oscillator Manual Request Enable bit 1 = MFINTOSC is explicitly enabled 0 = MFINTOSC could be enabled by another module bit 4 LFOEN: LFINTOSC (31 kHz) Oscillator Manual Request Enable bit 1 = LFINTOSC is explicitly enabled 0 = LFINTOSC could be enabled by another module bit 3 Unimplemented: Read as `0' bit 2 ADOEN: FRC Oscillator Manual Request Enable bit 1 = FRC is explicitly enabled 0 = FRC could be enabled by another module bit 1-0 Unimplemented: Read as `0' 2017 Microchip Technology Inc. Preliminary DS40001897A-page 113 PIC16(L)F15313/23 REGISTER 9-6: OSCFRQ: HFINTOSC FREQUENCY SELECTION REGISTER U-0 U-0 U-0 U-0 U-0 -- -- -- -- -- R/W-q/q R/W-q/q R/W-q/q HFFRQ<2:0>(1) bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-3 Unimplemented: Read as `0' bit 2-0 HFFRQ<2:0>: HFINTOSC Frequency Selection bits Nominal Freq (MHz): 111 = Reserved 110 = 32 101 = 16 100 = 12 011 = 8 010 = 4 001 = 2 000 = 1 Note 1: When RSTOSC=110 (HFINTOSC 1 MHz), the HFFRQ bits will default to `010' upon Reset; when RSTOSC = 001 (HFINTOSC 32 MHz), the HFFRQ bits will default to `101' upon Reset. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 114 PIC16(L)F15313/23 REGISTER 9-7: OSCTUNE: HFINTOSC TUNING REGISTER U-0 U-0 -- -- R/W-1/1 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 HFTUN<5:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0'. bit 5-0 HFTUN<5:0>: HFINTOSC Frequency Tuning bits 01 1111 = Maximum frequency 01 1110 = *** 00 0001 = 00 0000 = Center frequency. Oscillator module is running at the calibrated frequency (default value). 11 1111 = *** 10 0001 = 10 0000 = Minimum frequency. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 115 PIC16(L)F15313/23 TABLE 9-3: SUMMARY OF REGISTERS ASSOCIATED WITH CLOCK SOURCES Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page OSCCON1 -- NOSC<2:0> NDIV<3:0> 110 OSCCON2 -- COSC<2:0> CDIV<3:0> 110 OSCCON3 CWSHOLD -- -- ORDY NOSCR OSCFRQ -- -- -- -- -- OSCSTAT EXTOR HFOR MFOR LFOR -- OSCTUNE -- -- EXTOEN HFOEN OSCEN Legend: CONFIG1 Legend: -- -- HFFRQ<2:0> ADOR -- PLLR HFTUN<5:0> MFOEN -- LFOEN 111 114 112 115 ADOEN -- -- 113 -- = unimplemented location, read as `0'. Shaded cells are not used by clock sources. TABLE 9-4: Name -- SUMMARY OF CONFIGURATION WORD WITH CLOCK SOURCES Bits Bit -/7 Bit -/6 13:8 -- -- 7:0 -- Bit 13/5 Bit 12/4 Bit 11/3 Bit 10/2 FCMEN -- CSWEN -- RSTOSC<2:0> -- Bit 9/1 Bit 8/0 -- CLKOUTEN FEXTOSC<2:0> Register on Page 76 -- = unimplemented location, read as `0'. Shaded cells are not used by clock sources. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 116 PIC16(L)F15313/23 10.0 INTERRUPTS The interrupt feature allows certain events to preempt normal program flow. Firmware is used to determine the source of the interrupt and act accordingly. Some interrupts can be configured to wake the MCU from Sleep mode. This chapter contains the following information for Interrupts: * * * * * Operation Interrupt Latency Interrupts During Sleep INT Pin Automatic Context Saving Many peripherals produce interrupts. Refer to the corresponding chapters for details. A block diagram of the interrupt logic is shown in Figure 10-1. FIGURE 10-1: INTERRUPT LOGIC Rev. 10-000010C 10/12/2016 TMR0IF TMR0IE Peripheral Interrupts (ADIF) PIR1 <0> (ADIE) PIE1 <0> Wake-up (If in Sleep mode) INTF INTE IOCIF IOCIE Interrupt to CPU PEIE PIRn PIEn 2017 Microchip Technology Inc. GIE Preliminary DS40001897A-page 117 PIC16(L)F15313/23 10.1 Operation 10.2 Interrupts are disabled upon any device Reset. They are enabled by setting the following bits: * GIE bit of the INTCON register * Interrupt Enable bit(s) of the PIEx[y] registers for the specific interrupt event(s) * PEIE bit of the INTCON register (if the Interrupt Enable bit of the interrupt event is contained in the PIEx registers) Interrupt Latency Interrupt latency is defined as the time from when the interrupt event occurs to the time code execution at the interrupt vector begins. The interrupt is sampled during Q1 of the instruction cycle. The actual interrupt latency then depends on the instruction that is executing at the time the interrupt is detected. See Figure 10-2 and Figure 10-3 for more details. The PIR1, PIR2, PIR3, PIR4, PIR5, PIR6, and PIR7 registers record individual interrupts via interrupt flag bits. Interrupt flag bits will be set, regardless of the status of the GIE, PEIE and individual interrupt enable bits. The following events happen when an interrupt event occurs while the GIE bit is set: * Current prefetched instruction is flushed * GIE bit is cleared * Current Program Counter (PC) is pushed onto the stack * Critical registers are automatically saved to the shadow registers (See "Section 10.5 "Automatic Context Saving") * PC is loaded with the interrupt vector 0004h The firmware within the Interrupt Service Routine (ISR) should determine the source of the interrupt by polling the interrupt flag bits. The interrupt flag bits must be cleared before exiting the ISR to avoid repeated interrupts. Because the GIE bit is cleared, any interrupt that occurs while executing the ISR will be recorded through its interrupt flag, but will not cause the processor to redirect to the interrupt vector. The RETFIE instruction exits the ISR by popping the previous address from the stack, restoring the saved context from the shadow registers and setting the GIE bit. For additional information on a specific interrupts operation, refer to its peripheral chapter. Note 1: Individual interrupt flag bits are set, regardless of the state of any other enable bits. 2: All interrupts will be ignored while the GIE bit is cleared. Any interrupt occurring while the GIE bit is clear will be serviced when the GIE bit is set again. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 118 PIC16(L)F15313/23 FIGURE 10-2: INTERRUPT LATENCY Rev. 10-000269E 8/31/2016 OSC1 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 CLKOUT INT pin Valid Interrupt window(1) Fetch PC - 1 Execute PC - 2 1 Cycle Instruction at PC PC = 0x0004 PC + 1 PC PC - 1 123 PC Indeterminate Latency(2) 123 PC = 0x0005 PC = 0x0006 PC = 0x0004 PC = 0x0005 Latency Note 1: An interrupt may occur at any time during the interrupt window. 2: Since an interrupt may occur any time during the interrupt window, the actual latency can vary. FIGURE 10-3: INT PIN INTERRUPT TIMING Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 OSC1 (4) INT pin (1) (1) INTF Interrupt Latency (5) (2) GIE INSTRUCTION FLOW PC Instruction Fetched Instruction Executed Note 1: PC Inst (PC) Inst (PC - 1) PC + 1 Inst (PC + 1) PC + 1 -- Forced NOP Inst (PC) 0004h Inst (0004h) Forced NOP 0005h Inst (0005h) Inst (0004h) INTF flag is sampled here (every Q1). 2: Asynchronous interrupt latency = 3-5 TCY. Synchronous latency = 3-4 TCY, where TCY = instruction cycle time. Latency is the same whether Inst (PC) is a single cycle or a 2-cycle instruction. 3: For minimum width of INT pulse, refer to AC specifications in Section 37.0 "Electrical Specifications". 4: INTF may be set any time during the Q4-Q1 cycles. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 119 PIC16(L)F15313/23 10.3 Interrupts During Sleep Interrupts can be used to wake from Sleep. To wake from Sleep, the peripheral must be able to operate without the system clock. The interrupt source must have the appropriate Interrupt Enable bit(s) set prior to entering Sleep. On waking from Sleep, if the GIE bit is also set, the processor will branch to the interrupt vector. Otherwise, the processor will continue executing instructions after the SLEEP instruction. The instruction directly after the SLEEP instruction will always be executed before branching to the ISR. Refer to Section 11.0 "PowerSaving Operation Modes" for more details. 10.4 INT Pin The INT pin can be used to generate an asynchronous edge-triggered interrupt. Refer to Figure 10-3. This interrupt is enabled by setting the INTE bit of the PIE0 register. The INTEDG bit of the INTCON register determines on which edge the interrupt will occur. When the INTEDG bit is set, the rising edge will cause the interrupt. When the INTEDG bit is clear, the falling edge will cause the interrupt. The INTF bit of the PIR0 register will be set when a valid edge appears on the INT pin. If the GIE and INTE bits are also set, the processor will redirect program execution to the interrupt vector. 10.5 Automatic Context Saving Upon entering an interrupt, the return PC address is saved on the stack. Additionally, the following registers are automatically saved in the shadow registers: * * * * * W register STATUS register (except for TO and PD) BSR register FSR registers PCLATH register Upon exiting the Interrupt Service Routine, these registers are automatically restored. Any modifications to these registers during the ISR will be lost. If modifications to any of these registers are desired, the corresponding shadow register should be modified and the value will be restored when exiting the ISR. The shadow registers are available in Bank 31 and are readable and writable. Depending on the user's application, other registers may also need to be saved. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 120 PIC16(L)F15313/23 10.6 Register Definitions: Interrupt Control REGISTER 10-1: INTCON: INTERRUPT CONTROL REGISTER R/W-0/0 R/W-0/0 U-0 U-0 U-0 U-0 U-0 R/W-1/1 GIE PEIE -- -- -- -- -- INTEDG bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 GIE: Global Interrupt Enable bit 1 = Enables all active interrupts 0 = Disables all interrupts bit 6 PEIE: Peripheral Interrupt Enable bit 1 = Enables all active peripheral interrupts 0 = Disables all peripheral interrupts bit 5-1 Unimplemented: Read as `0' bit 0 INTEDG: Interrupt Edge Select bit 1 = Interrupt on rising edge of INT pin 0 = Interrupt on falling edge of INT pin Note: Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Enable bit, GIE, of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 121 PIC16(L)F15313/23 REGISTER 10-2: PIE0: PERIPHERAL INTERRUPT ENABLE REGISTER 0 U-0 U-0 R/W-0/0 R/W-0/0 U-0 U-0 U-0 R/W-0/0 -- -- TMR0IE IOCIE -- -- -- INTE bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware set bit 7-6 Unimplemented: Read as `0' bit 5 TMR0IE: Timer0 Overflow Interrupt Enable bit 1 = Enables the Timer0 interrupt 0 = Disables the Timer0 interrupt bit 4 IOCIE: Interrupt-on-Change Interrupt Enable bit 1 = Enables the IOC change interrupt 0 = Disables the IOC change interrupt bit 3-1 Unimplemented: Read as `0' bit 0 INTE: INT External Interrupt Flag bit(1) 1 = Enables the INT external interrupt 0 = Disables the INT external interrupt Note 1: Note: The External Interrupt GPIO pin is selected by INTPPS (Register 15-1). Bit PEIE of the INTCON register must be set to enable any peripheral interrupt controlled by PIE1-PIE7. Interrupt sources controlled by the PIE0 register do not require PEIE to be set in order to allow interrupt vectoring (when GIE is set). 2017 Microchip Technology Inc. Preliminary DS40001897A-page 122 PIC16(L)F15313/23 REGISTER 10-3: PIE1: PERIPHERAL INTERRUPT ENABLE REGISTER 1 R/W-0/0 R/W-0/0 U-0 U-0 U-0 U-0 R/W-0/0 R/W-0/0 OSFIE CSWIE -- -- -- -- -- ADIE bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 OSFIE: Oscillator Fail Interrupt Enable bit 1 = Enables the Oscillator Fail Interrupt 0 = Disables the Oscillator Fail Interrupt bit 6 CSWIE: Clock Switch Complete Interrupt Enable bit 1 = The clock switch module interrupt is enabled 0 = The clock switch module interrupt is disabled bit 5-1 Unimplemented: Read as `0' bit 0 ADIE: Analog-to-Digital Converter (ADC) Interrupt Enable bit 1 = Enables the ADC interrupt 0 = Disables the ADC interrupt Note: Bit PEIE of the INTCON register must be set to enable any peripheral interrupt controlled by registers PIE1-PIE7 2017 Microchip Technology Inc. Preliminary DS40001897A-page 123 PIC16(L)F15313/23 REGISTER 10-4: U-0 PIE2: PERIPHERAL INTERRUPT ENABLE REGISTER 2 R/W-0/0 -- ZCDIE U-0 -- U-0 -- U-0 -- U-0 -- R/W-0/0 (1) C2IE bit 7 R/W-0/0 C1IE bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 Unimplemented: Read as `0' bit 6 ZCDIE: Zero-Cross Detection (ZCD) Interrupt Enable bit 1 = Enables the ZCD interrupt 0 = Disables the ZCD interrupt bit 5-2 Unimplemented: Read as `0' bit 1 C2IE: Comparator C2 Interrupt Enable bit 1 = Enables the Comparator C2 interrupt 0 = Disables the Comparator C2 interrupt bit 0 C1IE: Comparator C1 Interrupt Enable bit 1 = Enables the Comparator C1 interrupt 0 = Disables the Comparator C1 interrupt Note 1: Note: Present only on PIC16(L)F15323. Bit PEIE of the INTCON register must be set to enable any peripheral interrupt controlled by registers PIE1-PIE7. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 124 PIC16(L)F15313/23 REGISTER 10-5: PIE3: PERIPHERAL INTERRUPT ENABLE REGISTER 3 U-0 U-0 R/W-0/0 R/W-0/0 U-0 U-0 R/W-0/0 R/W-0/0 -- -- RC1IE TX1IE -- -- BCL1IE SSP1IE bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5 RC1IE: USART Receive Interrupt Enable bit 1 = Enables the USART receive interrupt 0 = Enables the USART receive interrupt bit 4 TX1IE: USART Transmit Interrupt Enable bit 1 = Enables the USART transmit interrupt 0 = Disables the USART transmit interrupt bit 3-2 Unimplemented: Read as `0' bit 1 BCL1IE: MSSP1 Bus Collision Interrupt Enable bit 1 = MSSP bus collision interrupt enabled 0 = MSSP bus collision interrupt disabled bit 0 SSP1IE: Synchronous Serial Port (MSSP1) Interrupt Enable bit 1 = Enables the MSSP interrupt 0 = Disables the MSSP interrupt Note: Bit PEIE of the INTCON register must be set to enable any peripheral interrupt controlled by PIE1-PIE7. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 125 PIC16(L)F15313/23 REGISTER 10-6: PIE4: PERIPHERAL INTERRUPT ENABLE REGISTER 4 U-0 U-0 U-0 U-0 U-0 U-0 R/W-0/0 R/W-0/0 -- -- -- -- -- -- TMR2IE TMR1IE bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware set bit 7-2 Unimplemented: Read as `0' bit 1 TMR2IE: TMR2 to PR2 Match Interrupt Enable bit 1 = Enables the Timer2 to PR2 match interrupt 0 = Disables the Timer2 to PR2 match interrupt bit 0 TMR1IE: Timer1 Overflow Interrupt Enable bit 1 = Enables the Timer1 overflow interrupt 0 = Enables the Timer1 overflow interrupt Note: Bit PEIE of the INTCON register must be set to enable any peripheral interrupt controlled by registers PIE1-PIE7. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 126 PIC16(L)F15313/23 REGISTER 10-7: PIE5: PERIPHERAL INTERRUPT ENABLE REGISTER 5 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 U-0 U-0 U-0 R/W-0/0 CLC4IE CLC3IE CLC2IE CLC1IE -- -- -- TMR1GIE bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware set bit 7 CLC4IE: CLC4 Interrupt Enable bit 1 = CLC4 interrupt enabled 0 = CLC4 interrupt disabled bit 6 CLC3IE: CLC3 Interrupt Enable bit 1 = CLC3 interrupt enabled 0 = CLC3 interrupt disabled bit 5 CLC2IE: CLC2 Interrupt Enable bit 1 = CLC2 interrupt enabled 0 = CLC2 interrupt disabled bit 4 CLC1IE: CLC1 Interrupt Enable bit 1 = CLC1 interrupt enabled 0 = CLC1 interrupt disabled bit 3-1 Unimplemented: Read as `0' bit 0 TMR1GIE: Timer1 Gate Interrupt Enable bit 1 = Enables the Timer1 gate acquisition interrupt 0 = Disables the Timer1 gate acquisition interrupt Note: Bit PEIE of the INTCON register must be set to enable any peripheral interrupt controlled by registers PIE1-PIE7. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 127 PIC16(L)F15313/23 REGISTER 10-8: PIE6: PERIPHERAL INTERRUPT ENABLE REGISTER 6 U-0 U-0 U-0 U-0 U-0 U-0 R/W-0/0 R/W-0/0 -- -- -- -- -- -- CCP2IE CCP1IE bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware set bit 7-2 Unimplemented: Read as `0'. bit 1 CCP2IE: CCP2 Interrupt Enable bit 1 = CCP2 interrupt is enabled 0 = CCP2 interrupt is disabled bit 0 CCP1IE: CCP1 Interrupt Enable bit 1 = CCP1 interrupt is enabled 0 = CCP1 interrupt is disabled Note: Bit PEIE of the INTCON register must be set to enable any peripheral interrupt controlled by registers PIE1-PIE7. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 128 PIC16(L)F15313/23 REGISTER 10-9: PIE7: PERIPHERAL INTERRUPT ENABLE REGISTER 7 U-0 U-0 R/W-0/0 R/W-0/0 U-0 U-0 U-0 R/W-0/0 -- -- NVMIE NCO1IE -- -- -- CWG1IE bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware set bit 7-6 Unimplemented: Read as `0'. bit 5 NVMIE: NVM Interrupt Enable bit 1 = NVM task complete interrupt enabled 0 = NVM interrupt not enabled bit 4 NCO1IE: NCO Interrupt Enable bit 1 = NCO rollover interrupt enabled 0 = NCO rollover interrupt disabled bit 3-1 Unimplemented: Read as `0'. bit 0 CWG1IE: Complementary Waveform Generator (CWG) 2 Interrupt Enable bit 1 = CWG1 interrupt is enabled 0 = CWG1 interrupt disabled Note: Bit PEIE of the INTCON register must be set to enable any peripheral interrupt controlled by registers PIE1-PIE7. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 129 PIC16(L)F15313/23 REGISTER 10-10: PIR0: PERIPHERAL INTERRUPT STATUS REGISTER 0 U-0 U-0 R/W/HS-0/0 R-0 U-0 U-0 U-0 R/W/HS-0/0 -- -- TMR0IF IOCIF -- -- -- INTF(1) bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS= Hardware Set bit 7-6 Unimplemented: Read as `0' bit 5 TMR0IF: Timer0 Overflow Interrupt Flag bit 1 = Timer0 register has overflowed (must be cleared in software) 0 = Timer0 register did not overflow bit 4 IOCIF: Interrupt-on-Change Interrupt Flag bit (read-only)(2) 1 = One or more of the IOCAF-IOCEF register bits are currently set, indicating an enabled edge was detected by the IOC module. 0 = None of the IOCAF-IOCEF register bits are currently set bit 3-1 Unimplemented: Read as `0' bit 0 INTF: INT External Interrupt Flag bit(1) 1 = The INT external interrupt occurred (must be cleared in software) 0 = The INT external interrupt did not occur Note 1: 2: Note: The External Interrupt GPIO pin is selected by INTPPS (Register 15-1). The IOCIF bit is the logical OR of all the IOCAF-IOCEF flags. Therefore, to clear the IOCIF flag, application firmware must clear all of the lower level IOCAF-IOCEF register bits. Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Enable bit, GIE, of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 130 PIC16(L)F15313/23 REGISTER 10-11: PIR1: PERIPHERAL INTERRUPT REQUEST REGISTER 1 R/W/HS-0/0 R/W/HS-0/0 U-0 U-0 U-0 U-0 U-0 R/W/HS-0/0 OSFIF CSWIF -- -- -- -- -- ADIF bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware set bit 7 OSFIF: Oscillator Fail-Safe Interrupt Flag bit 1 = Oscillator fail-safe interrupt has occurred (must be cleared in software) 0 = No oscillator fail-safe interrupt bit 6 CSWIF: Clock Switch Complete Interrupt Flag bit 1 = The clock switch module indicates an interrupt condition and is ready to complete the clock switch operation (must be cleared in software) 0 = The clock switch does not indicate an interrupt condition bit 5-1 Unimplemented: Read as `0' bit 0 ADIF: Analog-to-Digital Converter (ADC) Interrupt Flag bit 1 = An A/D conversion or complex operation has completed (must be cleared in software) 0 = An A/D conversion or complex operation is not complete Note: Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Enable bit, GIE, of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 131 PIC16(L)F15313/23 REGISTER 10-12: PIR2: PERIPHERAL INTERRUPT REQUEST REGISTER 2 U-0 R/W/HS-0/0 -- ZCDIF U-0 -- U-0 -- U-0 -- U-0 -- R/W/HS-0/0 C2IF bit 7 (1) R/W/HS-0/0 C1IF bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware set bit 7 Unimplemented: Read as `0' bit 6 ZCDIF: Zero-Cross Detect (ZCD1) Interrupt Flag bit 1 = An enabled rising and/or falling ZCD1 event has been detected (must be cleared in software) 0 = No ZCD1 event has occurred bit 5-2 Unimplemented: Read as `0' bit 1 C2IF: Comparator C2 Interrupt Flag bit 1 = Comparator 2 interrupt asserted (must be cleared in software) 0 = Comparator 2 interrupt not asserted bit 0 C1IF: Comparator C1 Interrupt Flag bit 1 = Comparator 1 interrupt asserted (must be cleared in software) 0 = Comparator 1 interrupt not asserted Note 1: Note: Present only on PIC16(L)F15323. Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Enable bit, GIE, of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 132 PIC16(L)F15313/23 REGISTER 10-13: PIR3: PERIPHERAL INTERRUPT REQUEST REGISTER 3 U-0 U-0 -- -- R/W/HS-0/0 R/W/HS-0/0 RC1IF TX1IF U-0 U-0 R/W/HS-0/0 R/W/HS-0/0 -- -- BCL1IF SSP1IF bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware clearable bit 7-6 Unimplemented: Read as `0' bit 5 RC1IF: EUSART1 Receive Interrupt Flag (read-only) bit (1) 1 = The EUSART1 receive buffer is not empty (contains at least one byte) 0 = The EUSART1 receive buffer is empty bit 4 TX1IF: EUSART1 Transmit Interrupt Flag (read-only) bit(2) 1 = The EUSART1 transmit buffer contains at least one unoccupied space 0 = The EUSART1 transmit buffer is currently full. The application firmware should not write to TXxREG again, until more room becomes available in the transmit buffer. bit 3-2 Unimplemented: Read as `0' bit 1 BCL1IF: MSSP1 Bus Collision Interrupt Flag bit 1 = A bus collision was detected (must be cleared in software) 0 = No bus collision was detected bit 0 SSP1IF: Synchronous Serial Port (MSSP1) Interrupt Flag bit 1 = The Transmission/Reception/Bus Condition is complete (must be cleared in software) 0 = Waiting for the Transmission/Reception/Bus Condition in progress Note 1: 2: Note: The RCxIF flag is a read-only bit. To clear the RCxIF flag, the firmware must read from RCxREG enough times to remove all bytes from the receive buffer. The TXxIF flag is a read-only bit, indicating if there is room in the transmit buffer. To clear the TX1IF flag, the firmware must write enough data to TXxREG to completely fill all available bytes in the buffer. The TXxIF flag does not indicate transmit completion (use TRMT for this purpose instead). Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Enable bit, GIE, of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 133 PIC16(L)F15313/23 REGISTER 10-14: PIR4: PERIPHERAL INTERRUPT REQUEST REGISTER 4 U-0 U-0 U-0 U-0 U-0 U-0 R/W/HS-0/0 R/W/HS-0/0 -- -- -- -- -- -- TMR2IF TMR1IF bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware set bit 7-2 Unimplemented: Read as `0' bit 1 TRM2IF: Timer2 Interrupt Flag bit 1 = The TMR2 postscaler overflowed, or in 1:1 mode, a TMR2 to PR2 match occurred (must be cleared in software) 0 = No TMR2 event has occurred bit 0 TRM1IF: Timer1 Overflow Interrupt Flag bit 1 = Timer1 overflow occurred (must be cleared in software) 0 = No Timer1 overflow occurred Note: Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Enable bit, GIE, of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 134 PIC16(L)F15313/23 REGISTER 10-15: PIR5: PERIPHERAL INTERRUPT REQUEST REGISTER 5 R/W/HS-0/0 R/W/HS-0/0 CLC4IF CLC3IF R/W/HS-0/0 R/W/HS-0/0 CLC2IF CLC1IF U-0 U-0 U-0 R/W/HS-0/0 -- -- -- TMR1GIF bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware set bit 7 CLC4IF: CLC4 Interrupt Flag bit 1 = A CLC4OUT interrupt condition has occurred (must be cleared in software) 0 = No CLC4 interrupt event has occurred bit 6 CLC3IF: CLC3 Interrupt Flag bit 1 = A CLC3OUT interrupt condition has occurred (must be cleared in software) 0 = No CLC3 interrupt event has occurred bit 5 CLC2IF: CLC2 Interrupt Flag bit 1 = A CLC2OUT interrupt condition has occurred (must be cleared in software) 0 = No CLC2 interrupt event has occurred bit 4 CLC1IF: CLC1 Interrupt Flag bit 1 = A CLC1OUT interrupt condition has occurred (must be cleared in software) 0 = No CLC1 interrupt event has occurred bit 3-1 Unimplemented: Read as `0' bit 0 TMR1GIF: Timer1 Gate Interrupt Flag bit 1 = The Timer1 Gate has gone inactive (the acquisition is complete) 0 = The Timer1 Gate has not gone inactive Note: Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Enable bit, GIE, of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 135 PIC16(L)F15313/23 REGISTER 10-16: PIR6: PERIPHERAL INTERRUPT REQUEST REGISTER 6 U-0 U-0 U-0 U-0 U-0 U-0 R/W/HS-0/0 R/W/HS-0/0 -- -- -- -- -- -- CCP2IF CCP1IF bit 7 bit 0 Legend: R = Readable bit W = Writable bit u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware set bit 7-2 Unimplemented: Read as `0' bit 1 CCP2IF: CCP2 Interrupt Flag bit U = Unimplemented bit, read as `0' CCPM Mode Value Capture bit 0 Compare PWM 1 Capture occurred (must be cleared in software) Compare match occurred (must be cleared in software) Output trailing edge occurred (must be cleared in software) 0 Capture did not occur Compare match did not occur Output trailing edge did not occur CCP1IF: CCP1 Interrupt Flag bit CCPM Mode Value Capture Note: Compare PWM 1 Capture occurred (must be cleared in software) Compare match occurred (must be cleared in software) Output trailing edge occurred (must be cleared in software) 0 Capture did not occur Compare match did not occur Output trailing edge did not occur Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Enable bit, GIE, of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 136 PIC16(L)F15313/23 REGISTER 10-17: PIR7: PERIPHERAL INTERRUPT REQUEST REGISTER 7 U-0 U-0 -- -- R/W/HS-0/0 R/W/HS-0/0 NVMIF NCO1IF U-0 U-0 U-0 R/W/HS-0/0 -- -- -- CWG1IF bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Hardware set bit 7-6 Unimplemented: Read as `0' bit 5 NVMIF: Nonvolatile Memory (NVM) Interrupt Flag bit 1 = The requested NVM operation has completed 0 = NVM interrupt not asserted bit 4 NCO1IF: Numerically Controlled Oscillator (NCO) Interrupt Flag bit 1 = The NCO has rolled over 0 = No NCO interrupt event has occurred bit 3-1 Unimplemented: Read as `0' bit 0 CWG1IF: CWG1 Interrupt Flag bit 1 = CWG1 has gone into shutdown 0 = CWG1 is operating normally, or interrupt cleared Note: Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Enable bit, GIE, of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 137 PIC16(L)F15313/23 TABLE 10-1: SUMMARY OF REGISTERS ASSOCIATED WITH INTERRUPTS Name Bit 7 Bit 6 INTCON Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page GIE PEIE -- -- -- -- -- INTEDG 121 PIE0 -- -- TMR0IE IOCIE -- -- -- INTE 122 PIE1 OSFIE CSWIE -- -- -- -- -- ADIE 123 PIE2 -- ZCDIE -- -- -- -- C2IE(1) C1IE 124 PIE3 -- -- RC1IE TX1IE -- -- BCL1IE SSP1IE 125 PIE4 -- -- -- -- -- -- TMR2IE TMR1IE 126 PIE5 CLC4IE CLC3IE CLC2IE CLC1IE -- -- -- TMR1GIE 127 PIE6 -- -- -- -- -- -- CCP2IE CCP1IE 128 PIE7 -- -- NVMIE NCO1IE -- -- -- CWG1IE 129 PIR0 -- -- TMR0IF IOCIF -- -- -- INTF 130 PIR1 OSFIF CSWIF -- -- -- -- -- ADIF 131 C1IF 132 PIR2 -- ZCDIF -- -- -- -- C2IF(1) PIR3 -- -- RC1IF TX1IF -- -- BCL1IF SSP1IF 133 PIR4 -- -- -- -- -- -- TMR2IF TMR1IF 134 PIR5 CLC4IF CLC3IF CLC2IF CLC1IF -- -- -- TMR1GIF 135 PIR6 -- -- -- -- -- -- CCP2IF CCP1IF 136 -- -- NVMIF NCO1IF -- -- -- CWG1IF 137 PIR7 Legend: Note 1: -- = unimplemented location, read as `0'. Shaded cells are not used by interrupts. Present only on PIC16(L)F15323. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 138 PIC16(L)F15313/23 11.0 operate, while only the CPU and PFM are affected. The reduced execution saves power by eliminating unnecessary operations within the CPU and memory. POWER-SAVING OPERATION MODES The purpose of the Power-Down modes is to reduce power consumption. There are three Power-Down modes: DOZE mode, IDLE mode, and SLEEP mode. 11.1 When the Doze Enable (DOZEN) bit is set (DOZEN = 1), the CPU executes only one instruction cycle out of every N cycles as defined by the DOZE<2:0> bits of the CPUDOZE register. For example, if DOZE<2:0> = 100, the instruction cycle ratio is 1:32. The CPU and memory execute for one instruction cycle and then lay idle for 31 instruction cycles. During the unused cycles, the peripherals continue to operate at the system clock speed. DOZE Mode DOZE mode allows for power saving by reducing CPU operation and program memory (PFM) access, without affecting peripheral operation. DOZE mode differs from Sleep mode because the system oscillators continue to FIGURE 11-1: DOZE MODE OPERATION EXAMPLE System Clock 1 1 2 /Z WZ 1 2 3 1 2 3 4 1 2 3 4 2 3 4 1 2 3 4 1 1 2 3 4 2 3 4 1 1 2 3 4 1 2 3 4 1 2 3 4 1 2 3 4 2 3 4 3 4 1 2 3 4 1 2 3 4 PFM Op's Fetch Fetch Push 0004h Fetch Fetch CPU Op's Exec Exec Exec(1,2) NOP Exec Exec 4 1 2 3 4 1 2 3 4 1 2 3 4 1 2 3 4 1 2 3 4 CPU Clock Exec Interrupt Here (ROI = 1) Note 1: 2: 11.1.1 Multi-cycle instructions are executed to completion before fetching 0004h. If the pre-fetched instruction clears GIE, the ISR will not occur, but DOZEN is still cleared and the CPU will resume execution at full speed. DOZE OPERATION The Doze operation is illustrated in Figure 11-1. For this example: * Doze enable (DOZEN) bit set (DOZEN = 1) * DOZE<2:0> = 001 (1:4) ratio * Recover-on-Interrupt (ROI) bit set (ROI = 1) As with normal operation, the PFM fetches for the next instruction cycle. The Q-clocks to the peripherals continue throughout. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 139 PIC16(L)F15313/23 11.1.2 INTERRUPTS DURING DOZE If an interrupt occurs and the Recover-on-Interrupt bit is clear (ROI = 0) at the time of the interrupt, the Interrupt Service Routine (ISR) continues to execute at the rate selected by DOZE<2:0>. Interrupt latency is extended by the DOZE<2:0> ratio. If an interrupt occurs and the ROI bit is set (ROI = 1) at the time of the interrupt, the DOZEN bit is cleared and the CPU executes at full speed. The prefetched instruction is executed and then the interrupt vector sequence is executed. In Figure 11-1, the interrupt occurs during the 2nd instruction cycle of the Doze period, and immediately brings the CPU out of Doze. If the Doze-On-Exit (DOE) bit is set (DOE = 1) when the RETFIE operation is executed, DOZEN is set, and the CPU executes at the reduced rate based on the DOZE<2:0> ratio. 11.2 Sleep Mode Sleep mode is entered by executing the SLEEP instruction, while the Idle Enable (IDLEN) bit of the CPUDOZE register is clear (IDLEN = 0). If the SLEEP instruction is executed while the IDLEN bit is set (IDLEN = 1), the CPU will enter the IDLE mode (Section 11.2.3 "Low-Power Sleep Mode"). Upon entering Sleep mode, the following conditions exist: 1. 2. 3. 4. 5. 6. 7. 8. WDT will be cleared but keeps running if enabled for operation during Sleep The PD bit of the STATUS register is cleared The TO bit of the STATUS register is set CPU Clock and System Clock 31 kHz LFINTOSC, HFINTOSC are unaffected and peripherals using them may continue operation in Sleep. ADC is unaffected if the dedicated FRC oscillator is selected the conversion will be left abandoned if FOSC is selected and ADRES will have an incorrect value I/O ports maintain the status they had before Sleep was executed (driving high, low, or high-impedance). This does not apply in the case of any asynchronous peripheral which is active and may affect the I/O port value Resets other than WDT are not affected by Sleep mode Refer to individual chapters for more details on peripheral operation during Sleep. To minimize current consumption, the following conditions should be considered: - I/O pins should not be floating - External circuitry sinking current from I/O pins - Internal circuitry sourcing current from I/O pins - Current draw from pins with internal weak pull-ups - Modules using any oscillator I/O pins that are high-impedance inputs should be pulled to VDD or VSS externally to avoid switching currents caused by floating inputs. Any module with a clock source that is not FOSC can be enabled. Examples of internal circuitry that might be sourcing current include modules such as the DAC and FVR modules. See Section 21.0 "5-Bit Digital-to-Analog Converter (DAC1) Module", Section 18.0 "Fixed Voltage Reference (FVR)" for more information on these modules. 11.2.1 WAKE-UP FROM SLEEP The device can wake-up from Sleep through one of the following events: 1. 2. 3. 4. 5. 6. External Reset input on MCLR pin, if enabled. BOR Reset, if enabled. POR Reset. Watchdog Timer, if enabled. Any external interrupt. Interrupts by peripherals capable of running during Sleep (see individual peripheral for more information). The first three events will cause a device Reset. The last three events are considered a continuation of program execution. To determine whether a device Reset or wake-up event occurred, refer to Section 8.12 "Memory Execution Violation". When the SLEEP instruction is being executed, the next instruction (PC + 1) is prefetched. For the device to wake-up through an interrupt event, the corresponding interrupt enable bit must be enabled. Wake-up will occur regardless of the state of the GIE bit. If the GIE bit is disabled, the device continues execution at the instruction after the SLEEP instruction. If the GIE bit is enabled, the device executes the instruction after the SLEEP instruction, the device will then call the Interrupt Service Routine. In cases where the execution of the instruction following SLEEP is not desirable, the user should have a NOP after the SLEEP instruction. The WDT is cleared when the device wakes-up from Sleep, regardless of the source of wake-up. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 140 PIC16(L)F15313/23 11.2.2 WAKE-UP USING INTERRUPTS When global interrupts are disabled (GIE cleared) and any interrupt source, with the exception of the clock switch interrupt, has both its interrupt enable bit and interrupt flag bit set, one of the following will occur: * If the interrupt occurs before the execution of a SLEEP instruction - SLEEP instruction will execute as a NOP - WDT and WDT prescaler will not be cleared - TO bit of the STATUS register will not be set - PD bit of the STATUS register will not be cleared FIGURE 11-2: * If the interrupt occurs during or after the execution of a SLEEP instruction - SLEEP instruction will be completely executed - Device will immediately wake-up from Sleep - WDT and WDT prescaler will be cleared - TO bit of the STATUS register will be set - PD bit of the STATUS register will be cleared Even if the flag bits were checked before executing a SLEEP instruction, it may be possible for flag bits to become set before the SLEEP instruction completes. To determine whether a SLEEP instruction executed, test the PD bit. If the PD bit is set, the SLEEP instruction was executed as a NOP. WAKE-UP FROM SLEEP THROUGH INTERRUPT Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 CLKIN(1) TOST(3) CLKOUT(2) Interrupt flag Interrupt Latency (4) GIE bit (INTCON reg.) Instruction Flow PC Instruction Fetched Instruction Executed Note 11.2.3 1: 2: 3: 4: Processor in Sleep PC Inst(PC) = Sleep Inst(PC - 1) PC + 1 PC + 2 PC + 2 Inst(PC + 1) Inst(PC + 2) Sleep Inst(PC + 1) PC + 2 Forced NOP 0004h 0005h Inst(0004h) Inst(0005h) Forced NOP Inst(0004h) External clock. High, Medium, Low mode assumed. CLKOUT is shown here for timing reference. TOST = 1024 TOSC. This delay does not apply to EC and INTOSC Oscillator modes. GIE = 1 assumed. In this case after wake-up, the processor calls the ISR at 0004h. If GIE = 0, execution will continue in-line. 11.2.3.1 LOW-POWER SLEEP MODE The PIC16F15313/23 device contains an internal Low Dropout (LDO) voltage regulator, which allows the device I/O pins to operate at voltages up to 5.5V while the internal device logic operates at a lower voltage. The LDO and its associated reference circuitry must remain active when the device is in Sleep mode. The PIC16F15313/23 allows the user to optimize the operating current in Sleep, depending on the application requirements. Low-Power Sleep mode can be selected by setting the VREGPM bit of the VREGCON register. Depending on the configuration of these bits, the LDO and reference circuitry are placed in a low-power state when the device is in Sleep. 2017 Microchip Technology Inc. Sleep Current vs. Wake-up Time In the default operating mode, the LDO and reference circuitry remain in the normal configuration while in Sleep. The device is able to exit Sleep mode quickly since all circuits remain active. In Low-Power Sleep mode, when waking-up from Sleep, an extra delay time is required for these circuits to return to the normal configuration and stabilize. The Low-Power Sleep mode is beneficial for applications that stay in Sleep mode for long periods of time. The Normal mode is beneficial for applications that need to wake from Sleep quickly and frequently. Preliminary DS40001897A-page 141 PIC16(L)F15313/23 11.2.3.2 Peripheral Usage in Sleep 11.3.1 Some peripherals that can operate in Sleep mode will not operate properly with the Low-Power Sleep mode selected. The Low-Power Sleep mode is intended for use with these peripherals: * * * * Brown-out Reset (BOR) Watchdog Timer (WDT) External interrupt pin/interrupt-on-change pins Timer1 (with external clock source) IDLE mode ends when an interrupt occurs (even if GIE = 0), but IDLEN is not changed. The device can re-enter IDLE by executing the SLEEP instruction. If Recover-on-Interrupt is enabled (ROI = 1), the interrupt that brings the device out of Idle also restores full-speed CPU execution when doze is also enabled. 11.3.2 It is the responsibility of the end user to determine what is acceptable for their application when setting the VREGPM settings in order to ensure operation in Sleep. 11.3 IDLE AND WDT When in IDLE, the WDT Reset is blocked and will instead wake the device. The WDT wake-up is not an interrupt, therefore ROI does not apply. Note: Note: IDLE AND INTERRUPTS The PIC16LF15313/23 does not have a configurable Low-Power Sleep mode. PIC16LF15313/23 is an unregulated device and is always in the lowest power state when in Sleep, with no wake-up time penalty. This device has a lower maximum VDD and I/O voltage than the PIC16F15313/23. See Section 37.0 "Electrical Specifications" for more information. The WDT can bring the device out of IDLE, in the same way it brings the device out of Sleep. The DOZEN bit is not affected. IDLE Mode When the Idle Enable (IDLEN) bit is clear (IDLEN = 0), the SLEEP instruction will put the device into full Sleep mode (see Section 11.2 "Sleep Mode"). When IDLEN is set (IDLEN = 1), the SLEEP instruction will put the device into IDLE mode. In IDLE mode, the CPU and memory operations are halted, but the peripheral clocks continue to run. This mode is similar to DOZE mode, except that in IDLE both the CPU and PFM are shut off. Note: Peripherals using FOSC will continue running while in Idle (but not in Sleep). Peripherals using HFINTOSCLFINTOSC will continue running in both Idle and Sleep. Note: If CLKOUT is enabled (CLKOUT = 0, Configuration Word 1), the output will continue operating while in Idle. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 142 PIC16(L)F15313/23 11.4 Register Definitions: Voltage Regulator and DOZE Control REGISTER 11-1: VREGCON: VOLTAGE REGULATOR CONTROL REGISTER(1) U-0 U-0 U-0 U-0 U-0 U-0 R/W-0/0 U-1 -- -- -- -- -- -- VREGPM -- bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-2 Unimplemented: Read as `0' bit 1 VREGPM: Voltage Regulator Power Mode Selection bit 1 = Low-Power Sleep mode enabled in Sleep(2) Draws lowest current in Sleep, slower wake-up 0 = Normal Power mode enabled in Sleep(2) Draws higher current in Sleep, faster wake-up bit 0 Unimplemented: Read as `1'. Maintain this bit set Note 1: 2: PIC16F15313/23 only. See Section 37.0 "Electrical Specifications". 2017 Microchip Technology Inc. Preliminary DS40001897A-page 143 PIC16(L)F15313/23 REGISTER 11-2: CPUDOZE: DOZE AND IDLE REGISTER R/W-0/u R/W/HC/HS-0/0 R/W-0/0 R/W-0/0 U-0 IDLEN DOZEN(1,2) ROI DOE -- R/W-0/0 R/W-0/0 R/W-0/0 DOZE<2:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 IDLEN: Idle Enable bit 1 = A SLEEP instruction inhibits the CPU clock, but not the peripheral clock(s) 0 = A SLEEP instruction places the device into full Sleep mode bit 6 DOZEN: Doze Enable bit(1,2) 1 = The CPU executes instruction cycles according to DOZE setting 0 = The CPU executes all instruction cycles (fastest, highest power operation) bit 5 ROI: Recover-on-Interrupt bit 1 = Entering the Interrupt Service Routine (ISR) makes DOZEN = 0 bit, bringing the CPU to full-speed operation. 0 = Interrupt entry does not change DOZEN bit 4 DOE: Doze on Exit bit 1 = Executing RETFIE makes DOZEN = 1, bringing the CPU to reduced speed operation. 0 = RETFIE does not change DOZEN bit 3 Unimplemented: Read as `0' bit 2-0 DOZE<2:0>: Ratio of CPU Instruction Cycles to Peripheral Instruction Cycles 111 =1:256 110 =1:128 101 =1:64 100 =1:32 011 =1:16 010 =1:8 001 =1:4 000 =1:2 Note 1: 2: When ROI = 1 or DOE = 1, DOZEN is changed by hardware interrupt entry and/or exit. Entering ICD overrides DOZEN, returning the CPU to full execution speed; this bit is not affected. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 144 PIC16(L)F15313/23 TABLE 11-1: SUMMARY OF REGISTERS ASSOCIATED WITH POWER-DOWN MODE Name Bit 7 Bit 6 INTCON Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page GIE PEIE -- -- -- -- -- INTEDG 121 PIE0 -- -- TMR0IE IOCIE -- -- -- INTE 122 PIE1 OSFIE CSWIE -- -- -- -- -- ADIE 123 C1IE 124 PIE2 ZCDIE -- -- -- -- C2IE -- -- RC1IE TX1IE -- -- BCL1IE SSP1IE 125 PIE4 -- -- -- -- -- -- TMR2IE TMR1IE 126 PIR0 -- -- TMR0IF IOCIF -- -- -- INTF 130 PIR1 OSFIF CSWIF -- -- -- -- -- ADIF 131 PIR2 -- ZCDIF -- -- -- -- C2IF(1) C1IF 132 PIR3 -- -- RC1IF TX1IF -- -- BCL1IF SSP1IF 133 PIR4 -- -- -- -- -- -- TMR2IF TMR1IF 134 IOCAP -- -- IOCAP5 IOCAP4 IOCAP3 IOCAP2 IOCAP1 IOCAP0 204 IOCAN -- -- IOCAN5 IOCAN4 IOCAN3 IOCAN2 IOCAN1 IOCAN0 204 IOCAF -- -- IOCAF5 IOCAF4 IOCAF3 IOCAF2 IOCAF1 IOCAF0 205 IOCCP4 IOCCP3 IOCCP2 IOCCP1 IOCCP0 206 PIE3 -- (1) IOCCP(1) -- -- IOCCP5 IOCCN(1) -- -- IOCCN5 IOCCN4 IOCCN3 IOCCN2 IOCCN1 IOCCN0 206 IOCCF(1) -- -- IOCCF5 IOCCF4 IOCCF3 IOCCF2 IOCCF1 IOCCF0 207 STATUS -- -- -- TO PD Z DC C 32 VREGCON -- -- -- -- -- -- VREGPM -- 143 CPUDOZE IDLEN DOZEN ROI DOE -- -- -- WDTCON0 Legend: Note 1: DOZE<2:0> WDTPS<4:0> 144 SWDTEN 150 -- = unimplemented location, read as `0'. Shaded cells are not used in Power-Down mode. Present only in PIC16(L)F15323. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 145 PIC16(L)F15313/23 12.0 WINDOWED WATCHDOG TIMER (WWDT) The Watchdog Timer (WDT) is a system timer that generates a Reset if the firmware does not issue a CLRWDT instruction within the time-out period. The Watchdog Timer is typically used to recover the system from unexpected events. The Windowed Watchdog Timer (WWDT) differs in that CLRWDT instructions are only accepted when they are performed within a specific window during the time-out period. The WDT has the following features: * Selectable clock source * Multiple operating modes - WDT is always on - WDT is off when in Sleep - WDT is controlled by software - WDT is always off * Configurable time-out period is from 1 ms to 256 seconds (nominal) * Configurable window size from 12.5 to 100 percent of the time-out period * Multiple Reset conditions * Operation during Sleep 2017 Microchip Technology Inc. Preliminary DS40001897A-page 146 PIC16(L)F15313/23 FIGURE 12-1: WATCHDOG TIMER BLOCK DIAGRAM Rev. 10-000162B 8/21/2015 WWDT Armed WDT Window Violation Window Closed Window Sizes CLRWDT Comparator WDTWS RESET Reserved 111 Reserved 110 Reserved 101 Reserved 100 Reserved 011 Reserved 010 MFINTOSC/16 001 LFINTOSC 000 R 18-bit Prescale Counter E WDTCS WDTPS R 5-bit WDT Counter Overflow Latch WDT Time-out WDTE<1:0> = 01 SWDTEN WDTE<1:0> = 11 WDTE<1:0> = 10 Sleep 2017 Microchip Technology Inc. Preliminary DS40001897A-page 147 PIC16(L)F15313/23 12.1 Independent Clock Source 12.4 Watchdog Window The WDT can derive its time base from either the 31 kHz LFINTOSC or 31.25 kHz MFINTOSC internal oscillators, depending on the value of either the WDTCCS<2:0> Configuration bits or the WDTCS<2:0> bits of WDTCON1. Time intervals in this chapter are based on a minimum nominal interval of 1 ms. See Section 37.0 "Electrical Specifications" for LFINTOSC and MFINTOSC tolerances. The Watchdog Timer has an optional Windowed mode that is controlled by the WDTCWS<2:0> Configuration bits and WINDOW<2:0> bits of the WDTCON1 register. In the Windowed mode, the CLRWDT instruction must occur within the allowed window of the WDT period. Any CLRWDT instruction that occurs outside of this window will trigger a window violation and will cause a WDT Reset, similar to a WDT time out. See Figure 12-2 for an example. 12.2 The window size is controlled by the WDTCWS<2:0> Configuration bits, or the WINDOW<2:0> bits of WDTCON1, if WDTCWS<2:0> = 111. WDT Operating Modes The Watchdog Timer module has four operating modes controlled by the WDTE<1:0> bits in Configuration Words. See Table 12-1. 12.2.1 WDT IS ALWAYS ON When the WDTE bits of Configuration Words are set to `11', the WDT is always on. WDT protection is active during Sleep. 12.2.2 In the event of a window violation, a Reset will be generated and the WDTWV bit of the PCON register will be cleared. This bit is set by a POR or can be set in firmware. 12.5 The WDT is cleared when any of the following conditions occur: WDT IS OFF IN SLEEP When the WDTE bits of Configuration Words are set to `10', the WDT is on, except in Sleep. When the WDTE bits of Configuration Words are set to `01', the WDT is controlled by the SWDTEN bit of the WDTCON0 register. * * * * * * * 12.2.4 12.5.1 WDT protection is not active during Sleep. 12.2.3 WDT CONTROLLED BY SOFTWARE WDT IS OFF When the WDTE bits of the Configuration Word are set to `00', the WDT is always OFF. WDT protection is unchanged by Sleep. See Table 12-1 for more details. TABLE 12-1: WDTE<1:0> 11 10 WDT OPERATING MODES Device SWDTEN Mode Active Awake Active Sleep Disabled 1 X Active 0 X Disabled X X Disabled X 01 00 12.3 WDT Mode X X Time-Out Period The WDTPS bits of the WDTCON0 register set the time-out period from 1 ms to 256 seconds (nominal). After a Reset, the default time-out period is two seconds. 2017 Microchip Technology Inc. Clearing the WDT Any Reset Valid CLRWDT instruction is executed Device enters Sleep Device wakes up from Sleep WDT is disabled Oscillator Start-up Timer (OST) is running Any write to the WDTCON0 or WDTCON1 registers CLRWDT CONSIDERATIONS (WINDOWED MODE) When in Windowed mode, the WDT must be armed before a CLRWDT instruction will clear the timer. This is performed by reading the WDTCON0 register. Executing a CLRWDT instruction without performing such an arming action will trigger a window violation. See Table 12-2 for more information. 12.6 Operation During Sleep When the device enters Sleep, the WDT is cleared. If the WDT is enabled during Sleep, the WDT resumes counting. When the device exits Sleep, the WDT is cleared again. The WDT remains clear until the OST, if enabled, completes. See Section 9.0 "Oscillator Module (with FailSafe Clock Monitor)" for more information on the OST. When a WDT time-out occurs while the device is in Sleep, no Reset is generated. Instead, the device wakes up and resumes operation. The TO and PD bits in the STATUS register are changed to indicate the event. The RWDT bit in the PCON register can also be used. See Section 4.3.2.1 "STATUS Register" for more information. Preliminary DS40001897A-page 148 PIC16(L)F15313/23 TABLE 12-2: WDT CLEARING CONDITIONS Conditions WDT WDTE<1:0> = 00 WDTE<1:0> = 01 and SWDTEN = 0 WDTE<1:0> = 10 and enter Sleep Cleared CLRWDT Command Oscillator Fail Detected Exit Sleep + System Clock = EXTOSC, INTOSC Change INTOSC divider (IRCF bits) FIGURE 12-2: Unaffected WINDOW PERIOD AND DELAY Rev. 10-000163A 8/15/2016 CLRWDT Instruction (or other WDT Reset) Window Period Window Closed Window Open Window Delay (window violation can occur) 2017 Microchip Technology Inc. Preliminary Time-out Event DS40001897A-page 149 PIC16(L)F15313/23 12.7 Register Definitions: Windowed Watchdog Timer Control REGISTER 12-1: WDTCON0: WATCHDOG TIMER CONTROL REGISTER 0 U-0 U-0 R/W(3)-q/q(2) R/W(3)-q/q(2) R/W(3)-q/q(2) R/W(3)-q/q(2) R/W(3)-q/q(2) R/W-0/0 -- -- WDTPS<4:0>(1) SWDTEN bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7-6 Unimplemented: Read as `0' bit 5-1 WDTPS<4:0>: Watchdog Timer Prescale Select bits(1) Bit Value = Prescale Rate 11111 = Reserved. Results in minimum interval (1:32) * * * 10011 = Reserved. Results in minimum interval (1:32) 10010 10001 10000 01111 01110 01101 01100 01011 01010 01001 01000 00111 00110 00101 00100 00011 00010 00001 00000 bit 0 = = = = = = = = = = = = = = = = = = = 1:8388608 (223) (Interval 256s nominal) 1:4194304 (222) (Interval 128s nominal) 1:2097152 (221) (Interval 64s nominal) 1:1048576 (220) (Interval 32s nominal) 1:524288 (219) (Interval 16s nominal) 1:262144 (218) (Interval 8s nominal) 1:131072 (217) (Interval 4s nominal) 1:65536 (Interval 2s nominal) (Reset value) 1:32768 (Interval 1s nominal) 1:16384 (Interval 512 ms nominal) 1:8192 (Interval 256 ms nominal) 1:4096 (Interval 128 ms nominal) 1:2048 (Interval 64 ms nominal) 1:1024 (Interval 32 ms nominal) 1:512 (Interval 16 ms nominal) 1:256 (Interval 8 ms nominal) 1:128 (Interval 4 ms nominal) 1:64 (Interval 2 ms nominal) 1:32 (Interval 1 ms nominal) SWDTEN: Software Enable/Disable for Watchdog Timer bit If WDTE<1:0> = 1x: This bit is ignored. If WDTE<1:0> = 01: 1 = WDT is turned on 0 = WDT is turned off If WDTE<1:0> = 00: This bit is ignored. Note 1: 2: 3: Times are approximate. WDT time is based on 31 kHz LFINTOSC. When WDTCPS <4:0> in CONFIG3 = 11111, the Reset value of WDTPS<4:0> is 01011. Otherwise, the Reset value of WDTPS<4:0> is equal to WDTCPS<4:0> in CONFIG3. When WDTCPS <4:0> in CONFIG3 11111, these bits are read-only. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 150 PIC16(L)F15313/23 REGISTER 12-2: WDTCON1: WATCHDOG TIMER CONTROL REGISTER 1 U-0 R/W(3)-q/q(1) R/W(3)-q/q(1) R/W(3)-q/q(1) U-0 -- WDTCS<2:0> -- R/W(4)-q/q(2) R/W(4)-q/q(2) R/W(4)-q/q(2) WINDOW<2:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7 Unimplemented: Read as `0' bit 6-4 WDTCS<2:0>: Watchdog Timer Clock Select bits 111 = Reserved * * * 010 = Reserved 001 = MFINTOSC 31.25 kHz 000 = LFINTOSC 31 kHz bit 3 Unimplemented: Read as `0' bit 2-0 WINDOW<2:0>: Watchdog Timer Window Select bits Note 1: 2: 3: 4: WINDOW<2:0> Window delay Percent of time Window opening Percent of time 111 N/A 100 110 12.5 87.5 101 25 75 100 37.5 62.5 011 50 50 010 62.5 37.5 001 75 25 000 87.5 12.5 If WDTCCS <2:0> in CONFIG3 = 111, the Reset value of WDTCS<2:0> is 000. The Reset value of WINDOW<2:0> is determined by the value of WDTCWS<2:0> in the CONFIG3 register. If WDTCCS<2:0> in CONFIG3 111, these bits are read-only. If WDTCWS<2:0> in CONFIG3 111, these bits are read-only. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 151 PIC16(L)F15313/23 REGISTER 12-3: R-0/0 WDTPSL: WDT PRESCALE SELECT LOW BYTE REGISTER R-0/0 R-0/0 R-0/0 R-0/0 R-0/0 R-0/0 R-0/0 PSCNT<7:0>(1) bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared PSCNT<7:0>: Prescale Select Low Byte bits(1) bit 7-0 Note 1: The 18-bit WDT prescale value, PSCNT<17:0> includes the WDTPSL, WDTPSH and the lower bits of the WDTTMR registers. PSCNT<17:0> is intended for debug operations and should be read during normal operation. REGISTER 12-4: R-0/0 WDTPSH: WDT PRESCALE SELECT HIGH BYTE REGISTER R-0/0 R-0/0 R-0/0 R-0/0 R-0/0 R-0/0 R-0/0 PSCNT<15:8>(1) bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared PSCNT<15:8>: Prescale Select High Byte bits(1) bit 7-0 Note 1: The 18-bit WDT prescale value, PSCNT<17:0> includes the WDTPSL, WDTPSH and the lower bits of the WDTTMR registers. PSCNT<17:0> is intended for debug operations and should be read during normal operation. REGISTER 12-5: U-0 WDTTMR: WDT TIMER REGISTER R-0/0 -- R-0/0 R-0/0 R-0/0 WDTTMR<3:0> R-0/0 STATE R-0/0 R-0/0 PSCNT<17:16>(1) bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 Unimplemented: Read as `0' bit 6-3 WDTTMR<3:0>: Watchdog Timer Value bits bit 2 STATE: WDT Armed Status bit 1 = WDT is armed 0 = WDT is not armed bit 1-0 PSCNT<17:16>: Prescale Select Upper Byte bits(1) Note 1: The 18-bit WDT prescale value, PSCNT<17:0> includes the WDTPSL, WDTPSH and the lower bits of the WDTTMR registers. PSCNT<17:0> is intended for debug operations and should be read during normal operation. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 152 PIC16(L)F15313/23 TABLE 12-3: Name SUMMARY OF REGISTERS ASSOCIATED WITH WATCHDOG TIMER Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page OSCCON1 -- NOSC<2:0> NDIV<3:0> OSCCON2 -- COSC<2:0> CDIV<3:0> OSCCON3 CSWHOLD -- -- ORDY NOSCR -- -- -- PCON0 STKOVF STKUNF WDTWV RWDT RMCLR RI POR BOR 99 STATUS -- -- -- TO PD Z DC C 32 WDTCON0 -- -- SWDTEN 150 WDTCON1 -- -- WDTCS<2:0> PSCNT<7:0> WDTPSH PSCNT<15:8> -- Legend: CONFIG1 Legend: 111 151 WINDOW<2:0> 152 152 WDTTMR<4:0> STATE PSCNT<17:16> 152 - = unimplemented locations read as `0'. Shaded cells are not used by Watchdog Timer. TABLE 12-4: Name 110 WDTPS<4:0> WDTPSL WDTTMR 110 SUMMARY OF CONFIGURATION WORD WITH WATCHDOG TIMER Bits Bit -/7 Bit -/6 Bit 13/5 Bit 12/4 Bit 11/3 Bit 10/2 Bit 9/1 Bit 8/0 13:8 -- -- FCMEN -- CSWEN -- -- CLKOUTEN 7:0 -- RSTOSC<2:0> -- FEXTOSC<2:0> Register on Page 76 -- = unimplemented location, read as `0'. Shaded cells are not used by Watchdog Timer. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 153 PIC16(L)F15313/23 13.0 NONVOLATILE MEMORY (NVM) CONTROL TABLE 13-1: FLASH MEMORY ORGANIZATION BY DEVICE NVM consists of the Program Flash Memory (PFM). NVM is accessible by using both the FSR and INDF registers, or through the NVMREG register interface. The write time is controlled by an on-chip timer. The write/erase voltages are generated by an on-chip charge pump rated to operate over the operating voltage range of the device. NVM can be protected in two ways; by either code protection or write protection. Code protection (CP bit in Configuration Word 5) disables access, reading and writing, to the PFM via external device programmers. Code protection does not affect the self-write and erase functionality. Code protection can only be Reset by a device programmer performing a Bulk Erase to the device, clearing all nonvolatile memory, Configuration bits, and User IDs. Write protection prohibits self-write and erase to a portion or all of the PFM, as defined by the WRT<1:0> bits of Configuration Word 4. Write protection does not affect a device programmer's ability to read, write, or erase the device. 13.1 Device PIC16(L)F15313 PIC16(L)F15323 32 2048 2048 All or a portion of a row can be programmed. Data to be written into the program memory row is written to 14-bit wide data write latches. These latches are not directly accessible, but may be loaded via sequential writes to the NVMDATH:NVMDATL register pair. Note: PFM consists of an array of 14-bit words as user memory, with additional words for User ID information, Configuration words, and interrupt vectors. PFM provides storage locations for: 13.1.1 PFM data can be read and/or written to through: 32 Total Program Flash (words) It is important to understand the PFM memory structure for erase and programming operations. PFM is arranged in rows. A row consists of 32 14-bit program memory words. A row is the minimum size that can be erased by user software. Program Flash Memory (PFM) * User program instructions * User defined data Row Write Erase Latches (words) (words) To modify only a portion of a previously programmed row, the contents of the entire row must be read. Then, the new data and retained data can be written into the write latches to reprogram the row of PFM. However, any unprogrammed locations can be written without first erasing the row. In this case, it is not necessary to save and rewrite the other previously programmed locations PROGRAM MEMORY VOLTAGES The PFM is readable and writable during normal operation over the full VDD range. * CPU instruction fetch (read-only) * FSR/INDF indirect access (read-only) (Section 13.2 "FSR and INDF Access") * NVMREG access (Section 13.3 "NVMREG Access" * In-Circuit Serial ProgrammingTM (ICSPTM) 13.1.1.1 Read operations return a single word of memory. When write and erase operations are done on a row basis, the row size is defined in Table 13-1. PFM will erase to a logic `1' and program to a logic `0'. Programming Externally The program memory cell and control logic support write and Bulk Erase operations down to the minimum device operating voltage. Special BOR operation is enabled during Bulk Erase (Section 8.2.4 "BOR is always OFF"). 13.1.1.2 Self-programming The program memory cell and control logic will support write and row erase operations across the entire VDD range. Bulk Erase is not available when selfprogramming. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 154 PIC16(L)F15313/23 13.2 FIGURE 13-1: FSR and INDF Access The FSR and INDF registers allow indirect access to the PFM. 13.2.1 FSR READ Rev. 10-000046D 8/15/2016 With the intended address loaded into an FSR register a MOVIW instruction or read of INDF will read data from the PFM. Reading from NVM requires one instruction cycle. The CPU operation is suspended during the read, and resumes immediately after. Read operations return a single byte of memory. 13.2.2 Select Memory: PFM, DIA, DCI, Config Words, User ID (NVMREGS) Select Word Address (NVMADRH:NVMADRL) NVMREG Access The NVMREG interface allows read/write access to all the locations accessible by FSRs, and also read/write access to the User ID locations, and read-only access to the device identification, revision, and Configuration data. Writing or erasing of NVM via the NVMREG interface is prevented when the device is write-protected. 13.3.1 Start Read Operation FSR WRITE Writing/erasing the NVM through the FSR registers (ex. MOVWI instruction) is not supported in the PIC16(L)F15313/23 devices. 13.3 FLASH PROGRAM MEMORY READ FLOWCHART Data read now in NVMDATH:NVMDATL End Read Operation NVMREG READ OPERATION To read a NVM location using the NVMREG interface, the user must: 1. 2. 3. Clear the NVMREGS bit of the NVMCON1 register if the user intends to access PFM locations, or set NMVREGS if the user intends to access User ID, or Configuration locations. Write the desired address into the NVMADRH:NVMADRL register pair (). Set the RD bit of the NVMCON1 register to initiate the read. Once the read control bit is set, the CPU operation is suspended during the read, and resumes immediately after. The data is available in the very next cycle, in the NVMDATH:NVMDATL register pair; therefore, it can be read as two bytes in the following instructions. NVMDATH:NVMDATL register pair will hold this value until another read or until it is written to by the user. Upon completion, the RD bit is cleared by hardware. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 155 PIC16(L)F15313/23 EXAMPLE 13-1: PROGRAM MEMORY READ * This code block will read 1 word of program * memory at the memory address: PROG_ADDR_HI : PROG_ADDR_LO * data will be returned in the variables; * PROG_DATA_HI, PROG_DATA_LO BANKSEL MOVLW MOVWF MOVLW MOVWF NVMADRL PROG_ADDR_LO NVMADRL PROG_ADDR_HI NVMADRH ; Select Bank for NVMCON registers ; ; Store LSB of address ; ; Store MSB of address BCF BSF NVMCON1,NVMREGS NVMCON1,RD ; Do not select Configuration Space ; Initiate read MOVF MOVWF MOVF MOVWF NVMDATL,W PROG_DATA_LO NVMDATH,W PROG_DATA_HI ; ; ; ; 2017 Microchip Technology Inc. Get LSB of word Store in user location Get MSB of word Store in user location Preliminary DS40001897A-page 156 PIC16(L)F15313/23 13.3.2 NVM UNLOCK SEQUENCE FIGURE 13-2: The unlock sequence is a mechanism that protects the NVM from unintended self-write programming or erasing. The sequence must be executed and completed without interruption to successfully complete any of the following operations: * * * * PFM Row Erase Load of PFM write latches Write of PFM write latches to PFM memory Write of PFM write latches to User IDs NVM UNLOCK SEQUENCE FLOWCHART Rev. 10-000047B 8/24/2015 Start Unlock Sequence The unlock sequence consists of the following steps and must be completed in order: Write 0x55 to NVMCON2 * Write 55h to NVMCON2 * Write AAh to NMVCON2 * Set the WR bit of NVMCON1 Once the WR bit is set, the processor will stall internal operations until the operation is complete and then resume with the next instruction. Note: The two NOP instructions after setting the WR bit that were required in previous devices are not required for PIC16(L)F15313/23 devices. See Figure 13-2. Write 0xAA to NVMCON2 Initiate Write or Erase operation (WR = 1) End Unlock Sequence Since the unlock sequence must not be interrupted, global interrupts should be disabled prior to the unlock sequence and re-enabled after the unlock sequence is completed. EXAMPLE 13-2: BCF BANKSEL BSF MOVLW MOVWF MOVLW MOVWF BSF BSF Note 1: 2: NVM UNLOCK SEQUENCE INTCON, GIE NVMCON1 NVMCON1, WREN 55h NVMCON2 AAh NVMCON2 NVMCON1, WR INTCON, GIE ; ; ; ; ; ; ; ; ; Recommended so sequence is not interrupted Enable write/erase Load 55h Step 1: Load 55h into NVMCON2 Step 2: Load W with AAh Step 3: Load AAH into NVMCON2 Step 4: Set WR bit to begin write/erase Re-enable interrupts Sequence begins when NVMCON2 is written; steps 1-4 must occur in the cycle-accurate order shown. Opcodes shown are illustrative; any instruction that has the indicated effect may be used. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 157 PIC16(L)F15313/23 13.3.3 NVMREG ERASE OF PFM FIGURE 13-3: Before writing to PFM, the word(s) to be written must be erased or previously unwritten. PFM can only be erased one row at a time. No automatic erase occurs upon the initiation of the write to PFM. Rev. 10-000048B 8/24/2015 Start Erase Operation To erase a PFM row: 1. 2. 3. 4. NVM ERASE FLOWCHART Clear the NVMREGS bit of the NVMCON1 register to erase PFM locations, or set the NMVREGS bit to erase User ID locations. Write the desired address into the NVMADRH:NVMADRL register pair (Table 13-2). Set the FREE and WREN bits of the NVMCON1 register. Perform the unlock sequence as described in Section 13.3.2 "NVM Unlock Sequence". Select Memory: PFM, Config Words, User ID (NVMREGS) Select Word Address (NVMADRH:NVMADRL) If the PFM address is write-protected, the WR bit will be cleared and the erase operation will not take place. While erasing PFM, CPU operation is suspended, and resumes when the operation is complete. Upon completion, the NVMIF is set, and an interrupt will occur if the NVMIE bit is also set. Select Erase Operation (FREE=1) Write latch data is not affected by erase operations, and WREN will remain unchanged. Enable Write/Erase Operation (WREN=1) Disable Interrupts (GIE=0) Unlock Sequence (See Note 1) CPU stalls while Erase operation completes (2 ms typical) Disable Write/Erase Operation (WREN = 0) Re-enable Interrupts (GIE = 1) End Erase Operation Note 1: 2017 Microchip Technology Inc. Preliminary See Figure 13-2. DS40001897A-page 158 PIC16(L)F15313/23 EXAMPLE 13-3: ERASING ONE ROW OF PROGRAM FLASH MEMORY (PFM) ; This sample row erase routine assumes the following: ; 1.A valid address within the erase row is loaded in variables ADDRH:ADDRL ; 2.ADDRH and ADDRL are located in common RAM (locations 0x70 - 0x7F) BANKSEL MOVF MOVWF MOVF MOVWF BCF BSF BSF BCF NVMADRL ADDRL,W NVMADRL ADDRH,W NVMADRH NVMCON1,NVMREGS NVMCON1,FREE NVMCON1,WREN INTCON,GIE ; Load lower 8 bits of erase address boundary ; ; ; ; ; Load upper 6 bits of erase address boundary Choose PFM memory area Specify an erase operation Enable writes Disable interrupts during unlock sequence ; -------------------------------REQUIRED UNLOCK SEQUENCE:-----------------------------MOVLW MOVWF MOVLW MOVWF BSF 55h NVMCON2 AAh NVMCON2 NVMCON1,WR ; ; ; ; ; Load 55h to get ready for unlock sequence First step is to load 55h into NVMCON2 Second step is to load AAh into W Third step is to load AAh into NVMCON2 Final step is to set WR bit ; -------------------------------------------------------------------------------------BSF BCF TABLE 13-2: INTCON,GIE NVMCON1,WREN ; Re-enable interrupts, erase is complete ; Disable writes NVM ORGANIZATION AND ACCESS INFORMATION Master Values Memory Function Reset Vector User Memory INT Vector User Memory User ID Program Counter (PC), ICSPTM Address NVMREG Access Memory Type 0000h 0001h 0003h 0004h NVMREGS bit (NVMCON1) NVMADR< 14:0> 0 0000h 8000h 0001h 8001h 0 PFM 0 0003h 0004h Allowed Operations Read Write FSR Address 8003h 0005h 0 0005h 8005h 0 07FFh 87FFh 8000h 8003h PFM 1 -- -- 0000h Read 0003h Write 0004h -- 8004h Rev ID 8005h 1 0005h Device ID 8006h 1 0006h CONFIG1 8007h 1 0007h CONFIG2 8008h 1 0008h CONFIG3 8009h 1 0009h CONFIG4 800Ah 1 000Ah CONFIG5 800Bh 8100h-82FFh 2017 Microchip Technology Inc. PFM PFM and Hard coded 1 000Bh 1 0100h02FFh Preliminary FSR Programming Address Read-0nly 8004h 07FFh Reserved DIA and DCI FSR Access Read-Only No Access Read Write Read-Only No Access DS40001897A-page 159 PIC16(L)F15313/23 13.3.4 NVMREG WRITE TO PROGRAM MEMORY Program memory is programmed using the following steps: 1. 2. 3. 4. Load the address of the row to be programmed into NVMADRH:NVMADRL. Load each write latch with data. Initiate a programming operation. Repeat steps 1 through 3 until all data is written. The following steps should be completed to load the write latches and program a row of program memory. These steps are divided into two parts. First, each write latch is loaded with data from the NVMDATH:NVMDATL using the unlock sequence with LWLO = 1. When the last word to be loaded into the write latch is ready, the LWLO bit is cleared and the unlock sequence executed. This initiates the programming operation, writing all the latches into Flash program memory. Note: Before writing to program memory, the word(s) to be written must be erased or previously unwritten. Program memory can only be erased one row at a time. No automatic erase occurs upon the initiation of the write. Program memory can be written one or more words at a time. The maximum number of words written at one time is equal to the number of write latches. See Figure 13-4 (row writes to program memory with 32 write latches) for more details. The write latches are aligned to the Flash row address boundary defined by the upper ten bits of NVMADRH:NVMADRL, (NVMADRH<6:0>:NVMADRL<7:5>) with the lower five bits of NVMADRL, (NVMADRL<4:0>) determining the write latch being loaded. Write operations do not cross these boundaries. At the completion of a program memory write operation, the data in the write latches is reset to contain 0x3FFF. The special unlock sequence is required to load a write latch with data or initiate a Flash programming operation. If the unlock sequence is interrupted, writing to the latches or program memory will not be initiated. 1. 2. Set the WREN bit of the NVMCON1 register. Clear the NVMREGS bit of the NVMCON1 register. 3. Set the LWLO bit of the NVMCON1 register. When the LWLO bit of the NVMCON1 register is `1', the write sequence will only load the write latches and will not initiate the write to Flash program memory. 4. Load the NVMADRH:NVMADRL register pair with the address of the location to be written. 5. Load the NVMDATH:NVMDATL register pair with the program memory data to be written. 6. Execute the unlock sequence (Section 13.3.2 "NVM Unlock Sequence"). The write latch is now loaded. 7. Increment the NVMADRH:NVMADRL register pair to point to the next location. 8. Repeat steps 5 through 7 until all but the last write latch has been loaded. 9. Clear the LWLO bit of the NVMCON1 register. When the LWLO bit of the NVMCON1 register is `0', the write sequence will initiate the write to Flash program memory. 10. Load the NVMDATH:NVMDATL register pair with the program memory data to be written. 11. Execute the unlock sequence (Section 13.3.2 "NVM Unlock Sequence"). The entire program memory latch content is now written to Flash program memory. Note: The program memory write latches are reset to the blank state (0x3FFF) at the completion of every write or erase operation. As a result, it is not necessary to load all the program memory write latches. Unloaded latches will remain in the blank state. An example of the complete write sequence is shown in Example 13-4. The initial address is loaded into the NVMADRH:NVMADRL register pair; the data is loaded using indirect addressing. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 160 2017 Microchip Technology Inc. FIGURE 13-4: 7 6 - r9 NVMREGS WRITES TO PROGRAM FLASH MEMORY WITH 32 WRITE LATCHES 0 7 5 4 NVMADRH r8 r7 r6 r5 r4 r3 r2 r1 r0 c4 0 7 NVMADRL - c3 c2 c1 5 - 0 7 NVMDATH NVMDATL 6 c0 Rev. 10-000004F 8/15/2016 0 8 14 10 Program Memory Write Latches 5 14 Write Latch #0 00h 14 14 Write Latch #30 1Eh Write Latch #1 01h 14 Write Latch #31 1Fh NVMADRL<4:0> Preliminary 14 DS40001897A-page 161 NVMADRH<6:0> NVMADRL<7:5> Row Address Decode 14 14 Row Addr Addr Addr Addr 000h 0000h 0001h 001Eh 001Fh 001h 0010h 0011h 003Eh 003Fh 002h 0020h 0021h 005Eh 005Fh End Addr End Addr Flash Program Memory Configuration Memory User ID, Device ID, Revision ID, Configuration Words, DIA, DCI NVMREGS = 1 PIC16(L)F15313/23 NVMREGS=0 14 PIC16(L)F15313/23 FIGURE 13-5: PROGRAM FLASH MEMORY WRITE FLOWCHART Rev. 10-000049C 8/24/2015 Start Write Operation Determine number of words to be written into PFM. The number of words cannot exceed the number of words per row (word_cnt) Load the value to write TABLAT Update the word counter (word_cnt--) Select access to PFM locations using NVMREG<1:0> bits Last word to write ? Yes Write Latches to PFM Disable Interrupts (GIE = 0) Select Row Address TBLPTR No Select Write Operation (FREE = 0) Load Write Latches Only Enable Write/Erase Operation (WREN = 1) Unlock Sequence (See note 1) Disable Interrupts (GIE = 0) Unlock Sequence (See note 1) No delay when writing to PFM Latches CPU stalls while Write operation completes (2 ms typical) Re-enable Interrupts (GIE = 1) Disable Write/Erase Operation (WREN = 0) Re-enable Interrupts (GIE = 1) End Write Operation Increment Address TBLPTR++ Note 1: See Figure 13-2. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 162 PIC16(L)F15313/23 EXAMPLE 13-4: ; ; ; ; ; ; ; WRITING TO PROGRAM FLASH MEMORY This write routine assumes the following: 1. 64 bytes of data are loaded, starting at the address in DATA_ADDR 2. Each word of data to be written is made up of two adjacent bytes in DATA_ADDR, stored in little endian format 3. A valid starting address (the least significant bits = 00000) is loaded in ADDRH:ADDRL 4. ADDRH and ADDRL are located in common RAM (locations 0x70 - 0x7F) 5. NVM interrupts are not taken into account BANKSEL MOVF MOVWF MOVF MOVWF MOVLW MOVWF MOVLW MOVWF BCF BSF BSF NVMADRH ADDRH,W NVMADRH ADDRL,W NVMADRL LOW DATA_ADDR FSR0L HIGH DATA_ADDR FSR0H NVMCON1,NVMREGS NVMCON1,WREN NVMCON1,LWLO MOVIW MOVWF MOVIW MOVWF FSR0++ NVMDATL FSR0++ NVMDATH MOVF XORLW ANDLW BTFSC GOTO NVMADRL,W 0x1F 0x1F STATUS,Z START_WRITE CALL INCF GOTO UNLOCK_SEQ NVMADRL,F LOOP ; If not, go load latch ; Increment address NVMCON1,LWLO UNLOCK_SEQ NVMCON1,WREN ; Latch writes complete, now write memory ; Perform required unlock sequence ; Disable writes ; Load initial address ; Load initial data address ; Set Program Flash Memory as write location ; Enable writes ; Load only write latches LOOP START_WRITE BCF CALL BCF UNLOCK_SEQ MOVLW BCF MOVWF MOVLW MOVWF BSF BSF return 55h INTCON,GIE NVMCON2 AAh NVMCON2 NVMCON1,WR INTCON,GIE 2017 Microchip Technology Inc. ; Load first data byte ; Load second data byte ; ; ; ; Check if lower bits of address are 00000 and if on last of 32 addresses Last of 32 words? If so, go write latches into memory ; Disable interrupts ; Begin unlock sequence ; Unlock sequence complete, re-enable interrupts Preliminary DS40001897A-page 163 PIC16(L)F15313/23 13.3.5 MODIFYING FLASH PROGRAM MEMORY FIGURE 13-6: When modifying existing data in a program memory row, and data within that row must be preserved, it must first be read and saved in a RAM image. Program memory is modified using the following steps: 1. 2. 3. 4. 5. 6. 7. FLASH PROGRAM MEMORY MODIFY FLOWCHART Rev. 10-000050B 8/21/2015 Start Modify Operation Load the starting address of the row to be modified. Read the existing data from the row into a RAM image. Modify the RAM image to contain the new data to be written into program memory. Load the starting address of the row to be rewritten. Erase the program memory row. Load the write latches with data from the RAM image. Initiate a programming operation. Read Operation (See Note 1) An image of the entire row read must be stored in RAM Modify Image The words to be modified are changed in the RAM image Erase Operation (See Note 2) Write Operation Use RAM image (See Note 3) End Modify Operation Note 1: 2: 3: 2017 Microchip Technology Inc. Preliminary See Figure 13-1. See Figure 13-3. See Figure 13-5. DS40001897A-page 164 PIC16(L)F15313/23 13.3.6 NVMREG ACCESS TO DEVICE INFORMATION AREA, DEVICE CONFIGURATION AREA, USER ID, DEVICE ID AND CONFIGURATION WORDS NVMREGS can be used to access the following memory regions: * * * * * Device Information Area (DIA) Device Configuration Information (DCI) User ID region Device ID and Revision ID Configuration Words The value of NVMREGS is set to `1' in the NVMCON1 register to access these regions. The memory regions listed above would be pointed to by PC<15> = 1, but not all addresses reference valid data. Different access may exist for reads and writes. Refer to Table 13-3. When read access is initiated on an address outside the parameters listed in Table 13-3, the NVMDATH: NVMDATL register pair is cleared, reading back `0's. TABLE 13-3: NVMREGS ACCESS TO DEVICE INFORMATION AREA, DEVICE CONFIGURATION AREA, USER ID, DEVICE ID AND CONFIGURATION WORDS (NVMREGS = 1) Address Function Read Access Write Access 8000h-8003h 8005h-8006h 8007h-800Bh 8100h-82FFh User IDs Device ID/Revision ID Configuration Words 1-5 DIA and DCI Yes Yes Yes Yes Yes No No No 2017 Microchip Technology Inc. Preliminary DS40001897A-page 165 PIC16(L)F15313/23 EXAMPLE 13-5: ; ; ; ; ; ; ; DEVICE ID ACCESS This write routine assumes the following: 1. A full row of data are loaded, starting at the address in DATA_ADDR 2. Each word of data to be written is made up of two adjacent bytes in DATA_ADDR, stored in little endian format 3. A valid starting address (the least significant bits = 00000) is loaded in ADDRH:ADDRL 4. ADDRH and ADDRL are located in common RAM (locations 0x70 - 0x7F) 5. NVM interrupts are not taken into account BANKSEL MOVF MOVWF MOVF MOVWF MOVLW MOVWF MOVLW MOVWF BCF BSF BSF NVMADRH ADDRH,W NVMADRH ADDRL,W NVMADRL LOW DATA_ADDR FSR0L HIGH DATA_ADDR FSR0H NVMCON1,NVMREGS NVMCON1,WREN NVMCON1,LWLO MOVIW MOVWF MOVIW MOVWF FSR0++ NVMDATL FSR0++ NVMDATH CALL INCF MOVF XORLW ANDLW BTFSC GOTO UNLOCK_SEQ NVMADRL,F NVMADRL,W 0x1F 0x1F STATUS,Z START_WRITE GOTO LOOP ; Load initial address ; Load initial data address ; Set PFM as write location ; Enable writes ; Load only write latches LOOP START_WRITE BCF CALL BCF NVMCON1,LWLO UNLOCK_SEQ NVMCON1,LWLO ; Load first data byte ; Load second data byte ; If not, go load latch ; Increment address ; ; ; ; Check if lower bits of address are 00000 and if on last of 32 addresses Last of 32 words? If so, go write latches into memory ; Latch writes complete, now write memory ; Perform required unlock sequence ; Disable writes UNLOCK_SEQ MOVLW BCF MOVWF MOVLW MOVWF BSF BSF return 2017 Microchip Technology Inc. 55h INTCON,GIE NVMCON2 AAh NVMCON2 NVMCON1,WR INTCON,GIE ; Disable interrupts ; Begin unlock sequence ; Unlock sequence complete, re-enable interrupts Preliminary DS40001897A-page 166 PIC16(L)F15313/23 13.3.7 WRITE VERIFY It is considered good programming practice to verify that program memory writes agree with the intended value. Since program memory is stored as a full row then the stored program memory contents are compared with the intended data stored in RAM after the last write is complete. FIGURE 13-7: FLASH PROGRAM MEMORY VERIFY FLOWCHART Rev. 10-000051B 12/4/2015 Start Verify Operation This routine assumes that the last row of data written was from an image saved on RAM. This image will be used to verify the data currently stored in PFM Read Operation(1) NVMDAT = RAM image ? Yes No No Fail Verify Operation Last word ? Yes End Verify Operation Note 1: See Figure 13-1. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 167 PIC16(L)F15313/23 13.3.8 WRERR BIT The WRERR bit can be used to determine if a write error occurred. WRERR will be set if one of the following conditions occurs: * If WR is set while the NVMADRH:NMVADRL points to a write-protected address * A Reset occurs while a self-write operation was in progress * An unlock sequence was interrupted The WRERR bit is normally set by hardware, but can be set by the user for test purposes. Once set, WRERR must be cleared in software. TABLE 13-4: ACTIONS FOR PFM WHEN WR = 1 Free LWLO Actions for PFM when WR = 1 1 x Erase the 32-word row of NVMADRH:NVMADRL * If WP is enabled, WR is cleared and location. See Section 13.3.3 "NVMREG Erase WRERR is set of PFM" * All 32 words are erased * NVMDATH:NVMDATL is ignored 0 1 Copy NVMDATH:NVMDATL to the write latch corresponding to NVMADR LSBs. See Section 13.3.3 "NVMREG Erase of PFM" * Write protection is ignored * No memory access occurs 0 0 Write the write-latch data to PFM row. See Section 13.3.3 "NVMREG Erase of PFM" * If WP is enabled, WR is cleared and WRERR is set * Write latches are reset to 3FFh * NVMDATH:NVMDATL is ignored 2017 Microchip Technology Inc. Preliminary Comments DS40001897A-page 168 PIC16(L)F15313/23 13.4 Register Definitions: Flash Program Memory Control REGISTER 13-1: R/W-x/u NVMDATL: NONVOLATILE MEMORY DATA LOW BYTE REGISTER R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u NVMDAT<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 NVMDAT<7:0>: Read/write value for Least Significant bits of program memory REGISTER 13-2: NVMDATH: NONVOLATILE MEMORY DATA HIGH BYTE REGISTER U-0 U-0 -- -- R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u NVMDAT<13:8> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 NVMDAT<13:8>: Read/write value for Most Significant bits of program memory REGISTER 13-3: R/W-0/0 NVMADRL: NONVOLATILE MEMORY ADDRESS LOW BYTE REGISTER R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 NVMADR<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 NVMADR<7:0>: Specifies the Least Significant bits for program memory address REGISTER 13-4: U-1 NVMADRH: NONVOLATILE MEMORY ADDRESS HIGH BYTE REGISTER R/W-0/0 R/W-0/0 --(1) R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 NVMADR<14:8> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 Unimplemented: Read as `1' bit 6-0 NVMADR<14:8>: Specifies the Most Significant bits for program memory address Note 1: Bit is undefined while WR = 1 2017 Microchip Technology Inc. Preliminary DS40001897A-page 169 PIC16(L)F15313/23 REGISTER 13-5: NVMCON1: NONVOLATILE MEMORY CONTROL 1 REGISTER U-0 R/W-0/0 R/W-0/0 R/W/HC-0/0 R/W/HC-x/q R/W-0/0 R/S/HC-0/0 R/S/HC-0/0 -- NVMREGS LWLO FREE WRERR(1,2,3) WREN WR(4,5,6) RD bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' S = Bit can only be set x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HC = Bit is cleared by hardware bit 7 Unimplemented: Read as `0' bit 6 NVMREGS: Configuration Select bit 1 = Access DIA, DCI, Configuration, User ID and Device ID Registers 0 = Access PFM bit 5 LWLO: Load Write Latches Only bit When FREE = 0: 1 = The next WR command updates the write latch for this word within the row; no memory operation is initiated. 0 = The next WR command writes data or erases Otherwise: The bit is ignored bit 4 FREE: PFM Erase Enable bit When NVMREGS:NVMADR points to a PFM location: 1 = Performs an erase operation with the next WR command; the 32-word pseudo-row containing the indicated address is erased (to all 1s) to prepare for writing. 0 = All erase operations have completed normally bit 3 WRERR: Program/Erase Error Flag bit(1,2,3) This bit is normally set by hardware. 1 = A write operation was interrupted by a Reset, interrupted unlock sequence, or WR was written to one while NVMADR points to a write-protected address. 0 = The program or erase operation completed normally bit 2 WREN: Program/Erase Enable bit 1 = Allows program/erase cycles 0 = Inhibits programming/erasing of program Flash bit 1 WR: Write Control bit(4,5,6) When NVMREG:NVMADR points to a PFM location: 1 = Initiates the operation indicated by Table 13-4 0 = NVM program/erase operation is complete and inactive. bit 0 RD: Read Control bit(7) 1 = Initiates a read at address = NVMADR1, and loads data to NVMDAT Read takes one instruction cycle and the bit is cleared when the operation is complete. The bit can only be set (not cleared) in software. 0 = NVM read operation is complete and inactive Note 1: 2: 3: 4: 5: 6: Bit is undefined while WR = 1. Bit must be cleared by software; hardware will not clear this bit. Bit may be written to `1' by software in order to implement test sequences. This bit can only be set by following the unlock sequence of Section 13.3.2 "NVM Unlock Sequence". Operations are self-timed, and the WR bit is cleared by hardware when complete. Once a write operation is initiated, setting this bit to zero will have no effect. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 170 PIC16(L)F15313/23 REGISTER 13-6: W-0/0 NVMCON2: NONVOLATILE MEMORY CONTROL 2 REGISTER W-0/0 W-0/0 W-0/0 W-0/0 W-0/0 W-0/0 W-0/0 NVMCON2<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' S = Bit can only be set x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 NVMCON2<7:0>: Flash Memory Unlock Pattern bits To unlock writes, a 55h must be written first followed by an AAh before setting the WR bit of the NVMCON1 register. The value written to this register is used to unlock the writes. TABLE 13-5: SUMMARY OF REGISTERS ASSOCIATED WITH NONVOLATILE MEMORY (NVM) Name Bit 7 Bit 6 INTCON Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page GIE PEIE -- -- -- -- -- INTEDG 121 PIE7 -- -- NVMIE NCO1IE -- -- -- CWG1IE 129 PIR7 -- -- NVMIF NCO1IF -- -- -- CWG1IF 137 -- NVMREGS LWLO FREE WRERR WREN WR RD 170 NVMCON1 NVMCON2 NVMCON2<7:0> 171 NVMADRL NVMADR<7:0> 169 NVMADRH --(1) NVMADR<14:8> NVMDATL NVMDATH Legend: Note 1: NVMDAT<7:0> -- -- NVMDAT<13:8> 169 169 169 -- = unimplemented location, read as `0'. Shaded cells are not used by NVM. Unimplemented, read as `1'. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 171 PIC16(L)F15313/23 Disabling the input buffer prevents analog signal levels on the pin between a logic high and low from causing excessive current in the logic input circuitry. A simplified model of a generic I/O port, without the interfaces to other peripherals, is shown in Figure 14-1. I/O PORTS PORT AVAILABILITY PER DEVICE Device PORTA TABLE 14-1: PIC16(L)F15313 PIC16(L)F15323 PORTC 14.0 FIGURE 14-1: GENERIC I/O PORT OPERATION Rev. 10-000052A 7/30/2013 Read LATx Each port has standard registers for its operation. These registers are: TRISx * PORTx registers (reads the levels on the pins of the device) * LATx registers (output latch) * TRISx registers (data direction) * ANSELx registers (analog select) * WPUx registers (weak pull-up) * INLVLx (input level control) * SLRCONx registers (slew rate) * ODCONx registers (open-drain) D Q Write LATx Write PORTx VDD CK Data Register Data bus I/O pin Read PORTx To digital peripherals Most port pins share functions with device peripherals, both analog and digital. In general, when a peripheral is enabled on a port pin, that pin cannot be used as a general purpose output; however, the pin can still be read. The Data Latch (LATx registers) is useful for read-modify-write operations on the value that the I/O pins are driving. A write operation to the LATx register has the same effect as a write to the corresponding PORTx register. A read of the LATx register reads of the values held in the I/O PORT latches, while a read of the PORTx register reads the actual I/O pin value. Ports that support analog inputs have an associated ANSELx register. When an ANSEL bit is set, the digital input buffer associated with that bit is disabled. ANSELx To analog peripherals VSS 14.1 I/O Priorities Each pin defaults to the PORT data latch after Reset. Other functions are selected with the peripheral pin select logic. See Section 15.0 "Peripheral Pin Select (PPS) Module" for more information. Analog input functions, such as ADC and comparator inputs, are not shown in the peripheral pin select lists. These inputs are active when the I/O pin is set for Analog mode using the ANSELx register. Digital output functions may continue to control the pin when it is in Analog mode. Analog outputs, when enabled, take priority over the digital outputs and force the digital output driver to the high-impedance state. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 172 PIC16(L)F15313/23 14.2 14.2.3 PORTA Registers 14.2.1 DATA REGISTER PORTA is a 6-bit wide, bidirectional port. The corresponding data direction register is TRISA (Register 14-2). Setting a TRISA bit (= 1) will make the corresponding PORTA pin an input (i.e., disable the output driver). Clearing a TRISA bit (= 0) will make the corresponding PORTA pin an output (i.e., enables output driver and puts the contents of the output latch on the selected pin). Example 14.2.8 shows how to initialize PORTA. Reading the PORTA register (Register 14-1) reads the status of the pins, whereas writing to it will write to the PORT latch. All write operations are read-modify-write operations. Therefore, a write to a port implies that the port pins are read, this value is modified and then written to the PORT data latch (LATA). The PORT data latch LATA (Register 14-3) holds the output port data, and contains the latest value of a LATA or PORTA write. EXAMPLE 14-1: ; ; ; ; INITIALIZING PORTA This code example illustrates initializing the PORTA register. The other ports are initialized in the same manner. BANKSEL CLRF BANKSEL CLRF BANKSEL CLRF BANKSEL MOVLW MOVWF 14.2.2 PORTA PORTA LATA LATA ANSELA ANSELA TRISA B'00111000' TRISA The ODCONA register (Register 14-6) controls the open-drain feature of the port. Open-drain operation is independently selected for each pin. When an ODCONA bit is set, the corresponding port output becomes an open-drain driver capable of sinking current only. When an ODCONA bit is cleared, the corresponding port output pin is the standard push-pull drive capable of sourcing and sinking current. Note: 14.2.4 SLEW RATE CONTROL INPUT THRESHOLD CONTROL The INLVLA register (Register 14-8) controls the input voltage threshold for each of the available PORTA input pins. A selection between the Schmitt Trigger CMOS or the TTL Compatible thresholds is available. The input threshold is important in determining the value of a read of the PORTA register and also the level at which an interrupt-on-change occurs, if that feature is enabled. See Table 37-4 for more information on threshold levels. Note: DIRECTION CONTROL The TRISA register (Register 14-2) controls the PORTA pin output drivers, even when they are being used as analog inputs. The user should ensure the bits in the TRISA register are maintained set when using them as analog inputs. I/O pins configured as analog inputs always read `0'. 2017 Microchip Technology Inc. It is not necessary to set open-drain control when using the pin for I2C; the I2C module controls the pin and makes the pin open-drain. The SLRCONA register (Register 14-7) controls the slew rate option for each port pin. Slew rate control is independently selectable for each port pin. When an SLRCONA bit is set, the corresponding port pin drive is slew rate limited. When an SLRCONA bit is cleared, The corresponding port pin drive slews at the maximum rate possible. 14.2.5 ; ;Init PORTA ;Data Latch ; ; ;digital I/O ; ;Set RA<5:3> as inputs ;and set RA<2:0> as ;outputs OPEN-DRAIN CONTROL Preliminary Changing the input threshold selection should be performed while all peripheral modules are disabled. Changing the threshold level during the time a module is active may inadvertently generate a transition associated with an input pin, regardless of the actual voltage level on that pin. DS40001897A-page 173 PIC16(L)F15313/23 14.2.6 ANALOG CONTROL The ANSELA register (Register 14-4) is used to configure the Input mode of an I/O pin to analog. Setting the appropriate ANSELA bit high will cause all digital reads on the pin to be read as `0' and allow analog functions on the pin to operate correctly. The state of the ANSELA bits has no effect on digital output functions. A pin with its TRIS bit clear and its ANSEL bit set will still operate as a digital output, but the Input mode will be analog. This can cause unexpected behavior when executing read-modify-write instructions on the affected port. Note: 14.2.7 The ANSELA bits default to the Analog mode after Reset. To use any pins as digital general purpose or peripheral inputs, the corresponding ANSEL bits must be initialized to `0' by user software. WEAK PULL-UP CONTROL The WPUA register (Register 14-5) controls the individual weak pull-ups for each PORT pin. 14.2.8 PORTA FUNCTIONS AND OUTPUT PRIORITIES Each PORTA pin is multiplexed with other functions. Each pin defaults to the PORT latch data after Reset. Other output functions are selected with the peripheral pin select logic or by enabling an analog output, such as the DAC. See Section 15.0 "Peripheral Pin Select (PPS) Module" for more information. Analog input functions, such as ADC and comparator inputs are not shown in the peripheral pin select lists. Digital output functions may continue to control the pin when it is in Analog mode. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 174 PIC16(L)F15313/23 14.3 Register Definitions: PORTA REGISTER 14-1: PORTA: PORTA REGISTER U-0 U-0 R/W-x/u R/W-x/u R-x/u R/W-x/u R/W-x/u R/W-x/u -- -- RA5 RA4 RA3 RA2 RA1 RA0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 RA<5:0>: PORTA I/O Value bits(1) 1 = Port pin is > VIH 0 = Port pin is < VIL Note 1: Writes to PORTA are actually written to corresponding LATA register. Reads from PORTA register returns of actual I/O pin values. REGISTER 14-2: TRISA: PORTA TRI-STATE REGISTER U-0 U-0 R/W-1/1 R/W-1/1 U-0 R/W-1/1 R/W-1/1 R/W-1/1 -- -- TRISA5 TRISA4 -- TRISA2 TRISA1 TRISA0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-4 TRISA<5:4>: PORTA Tri-State Control bits 1 = PORTA pin configured as an input (tri-stated) 0 = PORTA pin configured as an output bit 3 Unimplemented: Read as `0' bit 2-0 TRISA<2:0>: PORTA Tri-State Control bits 1 = PORTA pin configured as an input (tri-stated) 0 = PORTA pin configured as an output 2017 Microchip Technology Inc. Preliminary DS40001897A-page 175 PIC16(L)F15313/23 REGISTER 14-3: LATA: PORTA DATA LATCH REGISTER U-0 U-0 R/W-x/u R/W-x/u U-0 R/W-x/u R/W-x/u R/W-x/u -- -- LATA5 LATA4 -- LATA2 LATA1 LATA0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-4 LATA<5:4>: RA<5:4> Output Latch Value bits(1) bit 3 Unimplemented: Read as `0' bit 2-0 LATA<2:0>: RA<2:0> Output Latch Value bits(1) Note 1: Writes to PORTA are actually written to corresponding LATA register. Reads from PORTA register returns actual I/O pin values. REGISTER 14-4: ANSELA: PORTA ANALOG SELECT REGISTER U-0 U-0 R/W-1/1 R/W-1/1 U-0 R/W-1/1 R/W-1/1 R/W-1/1 -- -- ANSA5 ANSA4 -- ANSA2 ANSA1 ANSA0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-4 ANSA<5:4>: Analog Select between Analog or Digital Function on pins RA<5:4>, respectively 1 =Analog input. Pin is assigned as analog input(1). Digital input buffer disabled. 0 = Digital I/O. Pin is assigned to port or digital special function. bit 3 Unimplemented: Read as `0' bit 2-0 ANSA<2:0>: Analog Select between Analog or Digital Function on pins RA<2:0>, respectively 1 = Analog input. Pin is assigned as analog input(1). Digital input buffer disabled. 0 = Digital I/O. Pin is assigned to port or digital special function. Note 1: When setting a pin to an analog input, the corresponding TRIS bit must be set to Input mode in order to allow external control of the voltage on the pin. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 176 PIC16(L)F15313/23 REGISTER 14-5: U-0 -- WPUA: WEAK PULL-UP PORTA REGISTER U-0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 -- WPUA5 WPUA4 WPUA3(1) WPUA2 WPUA1 WPUA0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 WPUA<5:0>: Weak Pull-up Register bits(1) 1 = Pull-up enabled 0 = Pull-up disabled Note 1: 2: If MCLRE = 1, the weak pull-up in RA3 is always enabled; bit WPUA3 is not affected. The weak pull-up device is automatically disabled if the pin is configured as an output. REGISTER 14-6: ODCONA: PORTA OPEN-DRAIN CONTROL REGISTER U-0 U-0 R/W-0/0 R/W-0/0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 -- -- ODCA5 ODCA4 -- ODCA2 ODCA1 ODCA0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-4 ODCA<5:4>: PORTA Open-Drain Enable bits For RA<5:4> pins, respectively 1 = Port pin operates as open-drain drive (sink current only) 0 = Port pin operates as standard push-pull drive (source and sink current) bit 3 Unimplemented: Read as `0' bit 2-0 ODCA<2:0>: PORTA Open-Drain Enable bits For RA<2:0> pins, respectively 1 = Port pin operates as open-drain drive (sink current only) 0 = Port pin operates as standard push-pull drive (source and sink current) 2017 Microchip Technology Inc. Preliminary DS40001897A-page 177 PIC16(L)F15313/23 REGISTER 14-7: SLRCONA: PORTA SLEW RATE CONTROL REGISTER U-0 U-0 R/W-1/1 R/W-1/1 U-0 R/W-1/1 R/W-1/1 R/W-1/1 -- -- SLRA5 SLRA4 -- SLRA2 SLRA1 SLRA0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-4 SLRA<5:4>: PORTA Slew Rate Enable bits For RA<5:4> pins, respectively 1 = Port pin slew rate is limited 0 = Port pin slews at maximum rate bit 3 Unimplemented: Read as `0' bit 2-0 SLRA<2:0>: PORTA Slew Rate Enable bits For RA<2:0> pins, respectively 1 = Port pin slew rate is limited 0 = Port pin slews at maximum rate REGISTER 14-8: U-0 -- INLVLA: PORTA INPUT LEVEL CONTROL REGISTER U-0 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 -- INLVLA5 INLVLA4 INLVLA3 INLVLA2 INLVLA1 INLVLA0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 INLVLA<5:0>: PORTA Input Level Select bits For RA<5:0> pins, respectively 1 = ST input used for PORT reads and interrupt-on-change 0 = TTL input used for PORT reads and interrupt-on-change 2017 Microchip Technology Inc. Preliminary DS40001897A-page 178 PIC16(L)F15313/23 TABLE 14-2: Name PORTA SUMMARY OF REGISTERS ASSOCIATED WITH PORTA Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page -- -- RA5 RA4 RA3 RA2 RA1 RA0 175 TRISA4 -- TRISA2 TRISA1 TRISA0 175 TRISA -- -- TRISA5 LATA -- -- LATA5 LATA4 -- LATA2 LATA1 LATA0 176 ANSELA -- -- ANSA5 ANSA4 -- ANSA2 ANSA1 ANSA0 176 WPUA -- -- WPUA5 WPUA4 WPUA3 WPUA2 WPUA1 WPUA0 177 ODCA4 -- ODCA2 ODCA1 ODCA0 177 ODCONA -- -- ODCA5 SLRCONA -- -- SLRA5 SLRA4 -- SLRA2 SLRA1 SLRA0 178 INLVLA -- -- INLVLA5 INLVLA4 INLVLA3 INLVLA2 INLVLA1 INLVLA0 178 Legend: x = unknown, u = unchanged, - = unimplemented locations read as `0'. Shaded cells are not used by PORTA. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 179 PIC16(L)F15313/23 14.4 14.4.1 PORTC Registers (PIC16(L)F15323 only) DATA REGISTER PORTC is a 6-bit wide bidirectional port. The corresponding data direction register is TRISC (Register 14-10). Setting a TRISC bit (= 1) will make the corresponding PORTC pin an input (i.e., put the corresponding output driver in a High-Impedance mode). Clearing a TRISC bit (= 0) will make the corresponding PORTC pin an output (i.e., enable the output driver and put the contents of the output latch on the selected pin). Figure 14-1 shows how to initialize an I/O port. Reading the PORTC register (Register 14-9) reads the status of the pins, whereas writing to it will write to the PORT latch. All write operations are read-modify-write operations. Therefore, a write to a port implies that the port pins are read, this value is modified and then written to the PORT data latch (LATC). The PORT data latch LATC (Register 14-11) holds the output port data, and contains the latest value of a LATC or PORTC write. 14.4.2 DIRECTION CONTROL The TRISC register (Register 14-10) controls the PORTC pin output drivers, even when they are being used as analog inputs. The user should ensure the bits in the TRISC register are maintained set when using them as analog inputs. I/O pins configured as analog inputs always read `0'. 14.4.3 OPEN-DRAIN CONTROL The ODCONC register (Register 14-14) controls the open-drain feature of the port. Open-drain operation is independently selected for each pin. When an ODCONC bit is set, the corresponding port output becomes an open-drain driver capable of sinking current only. When an ODCONC bit is cleared, the corresponding port output pin is the standard push-pull drive capable of sourcing and sinking current. Note: 14.4.4 It is not necessary to set open-drain control when using the pin for I2C; the I2C module controls the pin and makes the pin open-drain. SLEW RATE CONTROL The SLRCONC register (Register 14-15) controls the slew rate option for each port pin. Slew rate control is independently selectable for each port pin. When an SLRCONC bit is set, the corresponding port pin drive is slew rate limited. When an SLRCONC bit is cleared, The corresponding port pin drive slews at the maximum rate possible. 2017 Microchip Technology Inc. 14.4.5 INPUT THRESHOLD CONTROL The INLVLC register (Register 14-16) controls the input voltage threshold for each of the available PORTC input pins. A selection between the Schmitt Trigger CMOS or the TTL Compatible thresholds is available. The input threshold is important in determining the value of a read of the PORTC register and also the level at which an interrupt-on-change occurs, if that feature is enabled. See Table 37-4 for more information on threshold levels. Note: 14.4.6 Changing the input threshold selection should be performed while all peripheral modules are disabled. Changing the threshold level during the time a module is active may inadvertently generate a transition associated with an input pin, regardless of the actual voltage level on that pin. ANALOG CONTROL The ANSELC register (Register 14-12) is used to configure the Input mode of an I/O pin to analog. Setting the appropriate ANSELC bit high will cause all digital reads on the pin to be read as `0' and allow analog functions on the pin to operate correctly. The state of the ANSELC bits has no effect on digital output functions. A pin with TRIS clear and ANSELC set will still operate as a digital output, but the Input mode will be analog. This can cause unexpected behavior when executing read-modify-write instructions on the affected port. Note: 14.4.7 The ANSELC bits default to the Analog mode after Reset. To use any pins as digital general purpose or peripheral inputs, the corresponding ANSEL bits must be initialized to `0' by user software. WEAK PULL-UP CONTROL The WPUC register (Register 14-13) controls the individual weak pull-ups for each port pin. 14.4.8 PORTC FUNCTIONS AND OUTPUT PRIORITIES Each pin defaults to the PORT latch data after Reset. Other output functions are selected with the peripheral pin select logic. See Section 15.0 "Peripheral Pin Select (PPS) Module" for more information. Analog input functions, such as ADC and comparator inputs, are not shown in the peripheral pin select lists. Digital output functions may continue to control the pin when it is in Analog mode. Preliminary DS40001897A-page 180 PIC16(L)F15313/23 14.5 Register Definitions: PORTC REGISTER 14-9: PORTC: PORTC REGISTER U-0 U-0 R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u -- -- RC5 RC4 RC3 RC2 RC1 RC0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 RC<5:0>: PORTC General Purpose I/O Pin bits(1) 1 = Port pin is > VIH 0 = Port pin is < VIL Note 1: Writes to PORTC are actually written to corresponding LATC register. The actual I/O pin values are read from the PORTC register. REGISTER 14-10: TRISC: PORTC TRI-STATE REGISTER U-0 U-0 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 -- -- TRISC5 TRISC4 TRISC3 TRISC2 TRISC1 TRISC0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 TRISC<5:0>: PORTC Tri-State Control bits 1 = PORTC pin configured as an input (tri-stated) 0 = PORTC pin configured as an output REGISTER 14-11: LATC: PORTC DATA LATCH REGISTER U-0 -- U-0 R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u -- LATC5 LATC4 LATC3 LATC2 LATC1 LATC0 bit 0 bit 7 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 LATC<5:0>: PORTC Output Latch Value bits((1) Note 1: Writes to PORTC are actually written to corresponding LATC register. Reads from PORTC register returns actual I/O pin values. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 181 PIC16(L)F15313/23 REGISTER 14-12: ANSELC: PORTC ANALOG SELECT REGISTER U-0 U-0 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 -- ANSC5 ANSC4 ANSC3 ANSC2 ANSC1 ANSC0 -- bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 ANSC<5:0>: Analog Select between Analog or Digital Function on Pins RC<5:0>, respectively(1) 1 = Analog input. Pin is assigned as analog input(1). Digital input buffer disabled. 0 = Digital I/O. Pin is assigned to port or digital special function. Note 1: When setting a pin to an analog input, the corresponding TRIS bit must be set to Input mode in order to allow external control of the voltage on the pin. REGISTER 14-13: WPUC: WEAK PULL-UP PORTC REGISTER U-0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 -- -- WPUC5 WPUC4 WPUC3 WPUC2 WPUC1 WPUC0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 WPUC<5:0>: Weak Pull-up Register bits 1 = Pull-up enabled 0 = Pull-up disabled 2017 Microchip Technology Inc. Preliminary DS40001897A-page 182 PIC16(L)F15313/23 REGISTER 14-14: ODCONC: PORTC OPEN-DRAIN CONTROL REGISTER U-0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 -- -- ODCC5 ODCC4 ODCC3 ODCC2 ODCC1 ODCC0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 ODCC<5:0>: PORTC Open-Drain Enable bits For RC<5:0> pins, respectively 1 = Port pin operates as open-drain drive (sink current only) 0 = Port pin operates as standard push-pull drive (source and sink current) REGISTER 14-15: SLRCONC: PORTC SLEW RATE CONTROL REGISTER U-0 -- U-0 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 -- SLRC5 SLRC4 SLRC3 SLRC2 SLRC1 SLRC0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 SLRC<5:0>: PORTC Slew Rate Enable bits For RC<5:0> pins, respectively 1 = Port pin slew rate is limited 0 = Port pin slews at maximum rate REGISTER 14-16: INLVLC: PORTC INPUT LEVEL CONTROL REGISTER U-0 U-0 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 -- -- INLVLC5 INLVLC4 INLVLC3 INLVLC2 INLVLC1 INLVLC0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 INLVLC<5:0>: PORTC Input Level Select bits For RC<5:0> pins, respectively 1 = ST input used for PORT reads and interrupt-on-change 0 = TTL input used for PORT reads and interrupt-on-change 2017 Microchip Technology Inc. Preliminary DS40001897A-page 183 PIC16(L)F15313/23 TABLE 14-3: SUMMARY OF REGISTERS ASSOCIATED WITH PORTC Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page PORTC -- -- RC5 RC4 RC3 RC2 RC1 RC0 181 TRISC -- -- TRISC5 TRISC4 TRISC3 TRISC2 TRISC1 TRISC0 181 LATC -- -- LATC5 LATC4 LATC3 LATC2 LATC1 LATC0 181 -- ANSC5 ANSC4 ANSC3 ANSC2 ANSC1 ANSC0 182 WPUC4 WPUC3 WPUC2 WPUC1 WPUC0 182 ODCC4 ODCC3 ODCC2 ODCC1 ODCC0 183 Name ANSELC -- WPUC -- -- WPUC5 ODCONC -- -- ODCC5 SLRCONC -- -- SLRC5 SLRC4 SLRC3 SLRC2 SLRC1 SLRC0 183 -- INLVLC5 INLVLC4 INLVLC3 INLVLC2 INLVLC1 INLVLC0 183 INLVLC -- Legend: - = unimplemented locations read as `0'. Shaded cells are not used by PORTC. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 184 PIC16(L)F15313/23 15.0 PERIPHERAL PIN SELECT (PPS) MODULE The Peripheral Pin Select (PPS) module connects peripheral inputs and outputs to the device I/O pins. Only digital signals are included in the selections. All analog inputs and outputs remain fixed to their assigned pins. Input and output selections are independent as shown in the simplified block diagram Figure 15-1. FIGURE 15-1: SIMPLIFIED PPS BLOCK DIAGRAM PPS Outputs RA0PPS PPS Inputs abcPPS RA0 RA0 Peripheral abc RxyPPS Rxy Peripheral xyz RC7(1) RC7PPS(1) xyzPPS Note: 15.1 RC7(1) Not available on 14-Pin devices. PPS Inputs 15.2 Each peripheral has a PPS register with which the inputs to the peripheral are selected. Inputs include the device pins. Although every peripheral has its own PPS input selection register, the selections are identical for every peripheral as shown in Register 15-1. Note: The notation "xxx" in the register name is a place holder for the peripheral identifier. For example, CLC1PPS. PPS Outputs Each I/O pin has a PPS register with which the pin output source is selected. With few exceptions, the port TRIS control associated with that pin retains control over the pin output driver. Peripherals that control the pin output driver as part of the peripheral operation will override the TRIS control as needed. These peripherals are (See Section 15.3 "Bidirectional Pins"): * EUSART (synchronous operation) * MSSP (I2C) Although every pin has its own PPS peripheral selection register, the selections are identical for every pin as shown in Register 15-2. Note: 2017 Microchip Technology Inc. Preliminary The notation "Rxy" is a place holder for the pin port and bit identifiers. For example, x and y for PORTA bit 0 would be A and 0, respectively, resulting in the pin PPS output selection register RA0PPS. DS40001897A-page 185 PIC16(L)F15313/23 TABLE 15-1: PPS INPUT SIGNAL ROUTING OPTIONS (PIC16(L)F15313) INPUT SIGNAL NAME Input Register Name Default Location at POR Reset Value (xxxPPS<4:0>) Remappable to Pins of PORTx PIC16(L)F15313 PORTA INT INTPPS RA2 00010 T0CKI T0CKIPPS RA2 00010 T1CKI T1CKIPSS RA5 00101 T1G T1GPPS RA4 00100 T2IN T2INPPS RA5 00101 CCP1 CCP1PPS RA5 00101 CCP2 CCP2PPS RA5 00101 CWG1IN CWG1INPPS RA2 00010 CLCIN0 CLCIN0PPS RA3 00011 CLCIN1 CLCIN1PPS RA5 00101 CLCIN2 CLCIN2PPS RA1 00001 CLCIN3 CLCIN3PPS RA0 00000 ADACT ADACTPPS RA5 00101 SCK1/SCL1 SSP1CLKPPS RA1 00001 SDI1/SDA1 SSP1DATPPS RA2 00010 SS1 SSP1SS1PPS RA3 00011 RX1/DT1 RX1PPS RA1 00001 CK1 TX1PPS RA0 00000 2017 Microchip Technology Inc. Preliminary DS40001897A-page 186 PIC16(L)F15313/23 TABLE 15-2: PPS INPUT SIGNAL ROUTING OPTIONS (PIC16(L)F15323) INPUT SIGNAL NAME Input Register Name Remappable to Pins of PORTx Default Location at POR Reset Value (xxxPPS<4:0>) PIC16(L)F15323 PORTA PORTC INT INTPPS RA2 00010 T0CKI T0CKIPPS RA2 00010 T1CKI T1CKIPSS RA5 00101 T1G T1GPPS RA4 00100 T2IN T2INPPS RA5 00101 CCP1 CCP1PPS RC5 10101 CCP2 CCP2PPS RC3 10011 CWG1IN CWG1INPPS RA2 00010 CLCIN0 CLCIN0PPS RC3 10011 CLCIN1 CLCIN1PPS RC4 10100 CLCIN2 CLCIN2PPS RC1 10001 CLCIN3 CLCIN3PPS RA5 00101 ADACT ADACTPPS RC2 10010 SCK1/SCL1 SSP1CLKPPS RC0 10000 SDI1/SDA1 SSP1DATPPS RC1 10001 SS1 SSP1SS1PPS RC3 10011 RX1/DT1 RX1DTPPS RC5 10101 CK1 TX1CKPPS RC4 10100 2017 Microchip Technology Inc. Preliminary DS40001897A-page 187 PIC16(L)F15313/23 TABLE 15-3: PPS INPUT REGISTER VALUES Desired Input Pin Value to Write to Register RA0 0x00 RA1 0x01 RA2 0x02 RA3 0x03 RA4 0x04 RA5 0x05 RC0(1) 0x10 (1) 0x11 RC2(1) 0x12 RC3(1) 0x13 RC4(1) 0x14 (1) 0x15 RC1 RC5 Note 1: Present on PIC16(L)F15323 only. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 188 PIC16(L)F15313/23 15.3 Bidirectional Pins 15.5 PPS selections for peripherals with bidirectional signals on a single pin must be made so that the PPS input and PPS output select the same pin. Peripherals that have bidirectional signals include: * EUSART (synchronous operation) * MSSP (I2C) Note: 15.4 The I2C SCLx and SDAx functions can be remapped through PPS. However, only the RB1, RB2, RC3 and RC4 pins have the I2C and SMBus specific input buffers implemented (I2C mode disables INLVL and sets thresholds that are specific for I2C). If the SCLx or SDAx functions are mapped to some other pin (other than RB1, RB2, RC3 or RC4), the general purpose TTL or ST input buffers (as configured based on INLVL register setting) will be used instead. In most applications, it is therefore recommended only to map the SCLx and SDAx pin functions to the RB1, RB2, RC3 or RC4 pins. PPS Permanent Lock The PPS can be permanently locked by setting the PPS1WAY Configuration bit. When this bit is set, the PPSLOCKED bit can only be cleared and set one time after a device Reset. This allows for clearing the PPSLOCKED bit so that the input and output selections can be made during initialization. When the PPSLOCKED bit is set after all selections have been made, it will remain set and cannot be cleared until after the next device Reset event. 15.6 Operation During Sleep PPS input and output selections are unaffected by Sleep. 15.7 Effects of a Reset A device Power-on-Reset (POR) clears all PPS input and output selections to their default values (Permanent Lock Removed). All other Resets leave the selections unchanged. Default input selections are shown in Table 15-1 and Table 15-2. PPS Lock The PPS includes a mode in which all input and output selections can be locked to prevent inadvertent changes. PPS selections are locked by setting the PPSLOCKED bit of the PPSLOCK register. Setting and clearing this bit requires a special sequence as an extra precaution against inadvertent changes. Examples of setting and clearing the PPSLOCKED bit are shown in Example 15-1. EXAMPLE 15-1: PPS LOCK/UNLOCK SEQUENCE ; suspend interrupts BCF INTCON,GIE ; BANKSEL PPSLOCK ; set bank ; required sequence, next 5 instructions MOVLW 0x55 MOVWF PPSLOCK MOVLW 0xAA MOVWF PPSLOCK ; Set PPSLOCKED bit to disable writes or ; Clear PPSLOCKED bit to enable writes BSF PPSLOCK,PPSLOCKED ; restore interrupts BSF INTCON,GIE 2017 Microchip Technology Inc. Preliminary DS40001897A-page 189 PIC16(L)F15313/23 TABLE 15-4: Output Signal Name PPS OUTPUT SIGNAL ROUTING OPTIONS (PIC16(L)F15313) RxyPPS Register Value TABLE 15-5: Remappable to Pins of PORTx PIC16(L)F15313 Output Signal Name PPS OUTPUT SIGNAL ROUTING OPTIONS (PIC16(L)F15323) RxyPPS Register Value PORTA Remappable to Pins of PORTx PIC16(L)F15323 PORTA PORTC CLKR 0x1B CLKR 0x1B NCO1OUT 0x1A NCO1OUT 0x1A TMR0 0x19 TMR0 0x19 SDO1/SDA1 0x16 SDO1/SDA1 0x16 SCK1/SCL1 0x15 SCK1/SCL1 0x15 C1OUT 0x13 C2OUT 0x14 DT1 0x10 C1OUT 0x13 TX1/CK1 0x0F DT1 0x10 PWM6OUT 0x0E TX1/CK1 0x0F PWM5OUT 0x0D PWM6OUT 0x0E PWM4OUT 0x0C PWM5OUT 0x0D PWM3OUT 0x0B PWM4OUT 0x0C CCP2 0x0A PWM3OUT 0x0B CCP1 0x09 CCP2 0x0A CWG1D 0x08 CCP1 0x09 CWG1C 0x07 CWG1D 0x08 CWG1B 0x06 CWG1C 0x07 CWG1A 0x05 CWG1B 0x06 CLC4OUT 0x04 CWG1A 0x05 CLC3OUT 0x03 CLC4OUT 0x04 CLC2OUT 0x02 CLC3OUT 0x03 CLC1OUT 0x01 CLC2OUT 0x02 CLC1OUT 0x01 2017 Microchip Technology Inc. Preliminary DS40001897A-page 190 PIC16(L)F15313/23 15.8 Register Definitions: PPS Input Selection REGISTER 15-1: xxxPPS: PERIPHERAL xxx INPUT SELECTION(1) U-0 U-0 -- -- R/W-q/u R/W-q/u R/W/q/u R/W-q/u R/W-q/u R/W-q/u xxxPPS<5:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = value depends on peripheral bit 7-6 Unimplemented: Read as `0' bit 5-0 xxxPPS<5:0>: Peripheral xxx Input Selection bits See Table 15-1 and Table 15-2. Note 1: 2: The "xxx" in the register name "xxxPPS" represents the input signal function name, such as "INT", "T0CKI", "RX", etc. This register summary shown here is only a prototype of the array of actual registers, as each input function has its own dedicated SFR (ex: INTPPS, T0CKIPPS, RXPPS, etc.). Each specific input signal may only be mapped to a subset of these I/O pins, as shown in Table 15-1 and Table 15-2. Attempting to map an input signal to a non-supported I/O pin will result in undefined behavior. For example, the "INT" signal map be mapped to any PORTA or PORTB pin. Therefore, the INTPPS register may be written with values from 0x00-0x0F (corresponding to RA0-RB7). Attempting to write 0x10 or higher to the INTPPS register is not supported and will result in undefined behavior. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 191 PIC16(L)F15313/23 REGISTER 15-2: RxyPPS: PIN Rxy OUTPUT SOURCE SELECTION REGISTER U-0 U-0 U-0 -- -- -- R/W-0/u R/W-0/u R/W-0/u R/W-0/u R/W-0/u RxyPPS<4:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-5 Unimplemented: Read as `0' bit 4-0 RxyPPS<4:0>: Pin Rxy Output Source Selection bits See Table 15-4 and Table 15-5. Note 1: TRIS control is overridden by the peripheral as required. REGISTER 15-3: PPSLOCK: PPS LOCK REGISTER U-0 U-0 U-0 U-0 U-0 U-0 U-0 R/W-0/0 -- -- -- -- -- -- -- PPSLOCKED bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-1 Unimplemented: Read as `0' bit 0 PPSLOCKED: PPS Locked bit 1= PPS is locked. PPS selections can not be changed. 0= PPS is not locked. PPS selections can be changed. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 192 PIC16(L)F15313/23 TABLE 15-6: Name SUMMARY OF REGISTERS ASSOCIATED WITH THE PPS MODULE Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on page -- -- -- -- -- PPSLOCKED 192 PPSLOCK -- -- INTPPS -- -- INTPPS<5:0> 191 T0CKIPPS -- -- T0CKIPPS<5:0> 191 T1CKIPPS -- -- T1CKIPPS<5:0> 191 T1GPPS -- -- T2INPPS T1GPPS<5:0> 191 T2INPPS<5:0> 191 CCP1PPS -- -- CCP1PPS<5:0> 191 CCP2PPS -- -- CCP2PPS<5:0> 191 CWG1PPS -- -- CWG1PPS<5:0> 191 SSP1CLKPPS -- -- SSP1CLKPPS<5:0> 191 SSP1DATPPS -- -- SSP1DATPPS<5:0> 191 SSP1SSPPS -- -- SSP1SSPPS<5:0> 191 RX1DTPPS -- -- RX1DTPPS<5:0> 191 TX1CKPPS -- -- TX1CKPPS<5:0> 191 CLCIN0PPS -- -- CLCIN0PPS<5:0> 191 CLCIN1PPS -- -- CLCIN1PPS<5:0> 191 CLCIN2PPS -- -- CLCIN2PPS<5:0> 191 CLCIN3PPS -- -- CLCIN3PPS<5:0> 191 ADACTPPS -- -- ADACTPPS<5:0> 191 RA0PPS -- -- -- RA0PPS<4:0> 192 RA1PPS -- -- -- RA1PPS<4:0> 192 RA2PPS -- -- -- RA2PPS<4:0> 192 RA3PPS -- -- -- RA3PPS<4:0> 192 RA4PPS -- -- -- RA4PPS<4:0> 192 RA5PPS -- -- -- RA5PPS<4:0> 192 RC0PPS(1) -- -- -- RC0PPS<4:0> 192 (1) -- -- -- RC1PPS<4:0> 192 RC2PPS(1) -- -- -- RC2PPS<4:0> 192 (1) -- -- -- RC3PPS<4:0> 192 RC4PPS(1) -- -- -- RC4PPS<4:0> 192 RC5PPS(1) -- -- -- RC5PPS<4:0> 192 RC6PPS(1) -- -- -- RC6PPS<4:0> 192 -- -- -- RC7PPS<4:0> 192 RC1PPS RC3PPS RC7PPS (1) Legend: Note 1: -- = unimplemented, read as `0'. Shaded cells are unused by the PPS module. Present on PIC16(L)F15323 only. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 193 PIC16(L)F15313/23 16.0 PERIPHERAL MODULE DISABLE 16.2 The PIC16(L)F15313/23 provides the ability to disable selected modules, placing them into the lowest possible Power mode. For legacy reasons, all modules are ON by default following any Reset. 16.1 Disabling a Module Enabling a module When the register bit is cleared, the module is reenabled and will be in its Reset state; SFR data will reflect the POR Reset values. Depending on the module, it may take up to one full instruction cycle for the module to become active. There should be no interaction with the module (e.g., writing to registers) for at least one instruction after it has been re-enabled. Disabling a module has the following effects: 16.3 * All clock and control inputs to the module are suspended; there are no logic transitions, and the module will not function. * The module is held in Reset: - Writing to SFRs is disabled - Reads return 00h When a module is disabled, all the associated PPS selection registers (Registers xxxPPS Register 15-1, 15-2, and 15-3), are also disabled. 2017 Microchip Technology Inc. 16.4 Disabling a Module System Clock Disable Setting SYSCMD (PMD0, Register 16-1) disables the system clock (FOSC) distribution network to the peripherals. Not all peripherals make use of SYSCLK, so not all peripherals are affected. Refer to the specific peripheral description to see if it will be affected by this bit. Preliminary DS40001897A-page 194 PIC16(L)F15313/23 REGISTER 16-1: PMD0: PMD CONTROL REGISTER 0 R/W-0/0 R/W-0/0 U-0 U-0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 SYSCMD FVRMD -- -- -- NVMMD CLKRMD IOCMD 7 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7 SYSCMD: Disable Peripheral System Clock Network bit See description in Section 16.4 "System Clock Disable". 1 = System clock network disabled (a.k.a. FOSC) 0 = System clock network enabled bit 6 FVRMD: Disable Fixed Voltage Reference (FVR) bit 1 = FVR module disabled 0 = FVR module enabled bit 5-3 Unimplemented: Read as `0' bit 2 NVMMD: NVM Module Disable bit(1) 1 = User memory reading and writing is disabled; NVMCON registers cannot be written; FSR access to these locations returns zero. 0 = NVM module enabled bit 1 CLKRMD: Disable Clock Reference CLKR bit 1 = CLKR module disabled 0 = CLKR module enabled bit 0 IOCMD: Disable Interrupt-on-Change bit, All Ports 1 = IOC module(s) disabled 0 = IOC module(s) enabled Note 1: When enabling NVM, a delay of up to 1 s may be required before accessing data. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 195 PIC16(L)F15313/23 REGISTER 16-2: PMD1: PMD CONTROL REGISTER 1 R/W-0/0 U-0 U-0 U-0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 NCO1MD -- -- -- -- TMR2MD TMR1MD TMR0MD bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7 NCO1MD: Disable Numerically Control Oscillator bit 1 = NCO1 module disabled 0 = NCO1 module enabled bit 6-3 Unimplemented: Read as `0' bit 2 TMR2MD: Disable Timer TMR2 bit 1 = Timer2 module disabled 0 = Timer2 module enabled bit 1 TMR1MD: Disable Timer TMR1 bit 1 = Timer1 module disabled 0 = Timer1 module enabled bit 0 TMR0MD: Disable Timer TMR0 bit 1 = Timer0 module disabled 0 = Timer0 module enabled 2017 Microchip Technology Inc. Preliminary DS40001897A-page 196 PIC16(L)F15313/23 REGISTER 16-3: PMD2: PMD CONTROL REGISTER 2 U-0 R/W-0/0 R/W-0/0 U-0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 -- DAC1MD ADCMD -- -- CMP2MD CMP1MD ZCDMD bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7 Unimplemented: Read as `0' bit 6 DAC1MD: Disable DAC1 bit 1 = DAC module disabled 0 = DAC module enabled bit 5 ADCMD: Disable ADC bit 1 = ADC module disabled 0 = ADC module enabled bit 4-3 Unimplemented: Read as `0' bit 2 CMP2MD: Disable Comparator C2 bit(1) 1 = C2 module disabled 0 = C2 module enabled bit 1 CMP1MD: Disable Comparator C1 bit 1 = C1 module disabled 0 = C1 module enabled bit 0 ZCDMD: Disable ZCD bit 1 = ZCD module disabled 0 = ZCD module enabled Note 1: Present only on PIC16(L)F15323. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 197 PIC16(L)F15313/23 REGISTER 16-4: PMD3: PMD CONTROL REGISTER 3 U-0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 -- -- PWM6MD PWM5MD PWM4MD PWM3MD CCP2MD CCP1MD bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7-6 Unimplemented: Read as `0' bit 5 PWM6MD: Disable Pulse-Width Modulator PWM6 bit 1 = PWM6 module disabled 0 = PWM6 module enabled bit 4 PWM5MD: Disable Pulse-Width Modulator PWM5 bit 1 = PWM5 module disabled 0 = PWM5 module enabled bit 3 PWM4MD: Disable Pulse-Width Modulator PWM4 bit 1 = PWM4 module disabled 0 = PWM4 module enabled bit 2 PWM3MD: Disable Pulse-Width Modulator PWM3 bit 1 = PWM3 module disabled 0 = PWM3 module enabled bit 1 CCP2MD: Disable CCP2 bit 1 = CCP2 module disabled 0 = CCP2 module enabled bit 0 CCP1MD: Disable CCP1 bit 1 = CCP1 module disabled 0 = CCP1 module enabled 2017 Microchip Technology Inc. Preliminary DS40001897A-page 198 PIC16(L)F15313/23 REGISTER 16-5: PMD4: PMD CONTROL REGISTER 4 U-0 R/W-0/0 U-0 R/W-0/0 U-0 U-0 U-0 R/W-0/0 -- UART1MD -- MSSP1MD -- -- -- CWG1MD bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7 Unimplemented: Read as `0' bit 6 UART1MD: Disable EUSART1 bit 1 = EUSART1 module disabled 0 = EUSART1 module enabled bit 5 Unimplemented: Read as `0' bit 4 MSSP1MD: Disable MSSP1 bit 1 = MSSP1 module disabled 0 = MSSP1 module enabled bit 3-1 Unimplemented: Read as `0' bit 0 CWG1MD: Disable CWG1 bit 1 = CWG1 module disabled 0 = CWG1 module enabled 2017 Microchip Technology Inc. Preliminary DS40001897A-page 199 PIC16(L)F15313/23 REGISTER 16-6: PMD5 - PMD CONTROL REGISTER 5 U-0 U-0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 U-0 -- -- -- CLC4MD CLC3MD CLC2MD CLC1MD -- bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7-5 Unimplemented: Read as `0' bit 4 CLC4MD: Disable CLC4 bit 1 = CLC4 module disabled 0 = CLC4 module enabled bit 3 CLC3MD: Disable CLC3 bit 1 = CLC3 module disabled 0 = CLC3 module enabled bit 2 CLC2MD: Disable CLC2 bit 1 = CLC2 module disabled 0 = CLC2 module enabled bit 1 CLC1MD: Disable CLC bit 1 = CLC1 module disabled 0 = CLC1 module enabled bit 0 Unimplemented: Read as `0' 2017 Microchip Technology Inc. Preliminary DS40001897A-page 200 PIC16(L)F15313/23 TABLE 16-1: Name SUMMARY OF REGISTERS ASSOCIATED WITH THE PPS MODULE Register on page CLKRMD IOCMD 195 TMR1MD TMR0MD 196 ZCDMD 197 Bit 6 Bit 5 Bit 4 Bit 3 PMD0 SYSCMD FVRMD -- -- -- NVMMD PMD1 NCO1MD -- -- -- -- TMR2MD PMD2 -- DAC1MD ADCMD -- -- CMP2MD CMP1MD PMD3 -- -- PWM6MD PWM5MD PWM4MD PWM3MD CCP2MD CCP1MD 198 PMD4 -- UART1MD -- MSSP1MD -- -- -- CWG1MD 199 -- -- -- CLC4MD CLC3MD CLC2MD CLC1MD -- 200 PMD5 Legend: Bit 2 Bit 0 Bit 7 Bit 1 -- = unimplemented, read as `0'. Shaded cells are unused by the PPS module. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 201 PIC16(L)F15313/23 17.0 INTERRUPT-ON-CHANGE 17.3 An interrupt can be generated by detecting a signal that has either a rising edge or a falling edge. Any individual pin, or combination of pins, can be configured to generate an interrupt. The interrupt-on-change module has the following features: * * * * Interrupt-on-Change enable (Master Switch) Individual pin configuration Rising and falling edge detection Individual pin interrupt flags Enabling the Module To allow individual pins to generate an interrupt, the IOCIE bit of the PIE0 register must be set. If the IOCIE bit is disabled, the edge detection on the pin will still occur, but an interrupt will not be generated. 17.2 The bits located in the IOCxF registers are status flags that correspond to the interrupt-on-change pins of each port. If an expected edge is detected on an appropriately enabled pin, then the status flag for that pin will be set, and an interrupt will be generated if the IOCIE bit is set. The IOCIF bit of the PIR0 register reflects the status of all IOCxF bits. 17.3.1 Figure 17-1 is a block diagram of the IOC module. 17.1 Interrupt Flags Individual Pin Configuration CLEARING INTERRUPT FLAGS The individual status flags, (IOCxF register bits), can be cleared by resetting them to zero. If another edge is detected during this clearing operation, the associated status flag will be set at the end of the sequence, regardless of the value actually being written. In order to ensure that no detected edge is lost while clearing flags, only AND operations masking out known changed bits should be performed. The following sequence is an example of what should be performed. EXAMPLE 17-1: For each pin, a rising edge detector and a falling edge detector are present. To enable a pin to detect a rising edge, the associated bit of the IOCxP register is set. To enable a pin to detect a falling edge, the associated bit of the IOCxN register is set. A pin can be configured to detect rising and falling edges simultaneously by setting the associated bits in both of the IOCxP and IOCxN registers. MOVLW XORWF ANDWF 17.4 CLEARING INTERRUPT FLAGS (PORTA EXAMPLE) 0xff IOCAF, W IOCAF, F Operation in Sleep The interrupt-on-change interrupt event will wake the device from Sleep mode, if the IOCIE bit is set. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 202 PIC16(L)F15313/23 FIGURE 17-1: INTERRUPT-ON-CHANGE BLOCK DIAGRAM (PORTA EXAMPLE) Rev. 10-000037D 10/3/2016 IOCANx D Q R Q4Q1 edge detect RAx IOCAPx D Q R data bus = 0 or 1 D S to data bus IOCAFx Q write IOCAFx IOCIE Q2 IOC interrupt to CPU core from all other IOCnFx individual pin detectors Note 1: See Table 8-1 for BOR Active Conditions. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 203 PIC16(L)F15313/23 17.5 Register Definitions: Interrupt-on-Change Control REGISTER 17-1: U-0 IOCAP: INTERRUPT-ON-CHANGE PORTA POSITIVE EDGE REGISTER U-0 -- -- R/W-0/0 IOCAP5 R/W-0/0 IOCAP4 R/W-0/0 IOCAP3 R/W-0/0 IOCAP2 R/W-0/0 IOCAP1 (1) R/W-0/0 IOCAP0(1) bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: read as `0' bit 5-0 IOCAP<5:0>: Interrupt-on-Change PORTA Positive Edge Enable bits 1 = Interrupt-on-Change enabled on the pin for a positive-going edge. IOCAFx bit and IOCIF flag will be set upon detecting an edge. 0 = Interrupt-on-Change disabled for the associated pin. REGISTER 17-2: IOCAN: INTERRUPT-ON-CHANGE PORTA NEGATIVE EDGE REGISTER U-0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 -- -- IOCAN5 IOCAN4 IOCAN3 IOCAN2 IOCAN1(1) IOCAN0(1) bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: read as `0' bit 5-0 IOCAN<5:0>: Interrupt-on-Change PORTA Negative Edge Enable bits 1 = Interrupt-on-Change enabled on the pin for a negative-going edge. IOCAFx bit and IOCIF flag will be set upon detecting an edge. 0 = Interrupt-on-Change disabled for the associated pin. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 204 PIC16(L)F15313/23 REGISTER 17-3: U-0 IOCAF: INTERRUPT-ON-CHANGE PORTA FLAG REGISTER U-0 -- -- R/W/HS-0/0 R/W/HS-0/0 R/W/HS-0/0 IOCAF5 IOCAF4 IOCAF3 R/W/HS-0/0 IOCAF2 R/W/HS-0/0 IOCAF1 bit 7 (1) R/W/HS-0/0 IOCAF0(1) bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS - Bit is set in hardware bit 7-6 Unimplemented: read as `0' bit 5-0 IOCAF<5:0>: Interrupt-on-Change PORTA Flag bits 1 = An enabled change was detected on the associated pin. Set when IOCAPx = 1 and a rising edge was detected on RAx, or when IOCANx = 1 and a falling edge was detected on RAx. 0 = No change was detected, or the user cleared the detected change. Note 1: If the debugger is enabled, these bits are not available for use. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 205 PIC16(L)F15313/23 REGISTER 17-4: IOCCP: INTERRUPT-ON-CHANGE PORTC POSITIVE EDGE REGISTER(1) U-0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 -- -- IOCCP5 IOCCP4 IOCCP3 IOCCP2 IOCCP1 IOCCP0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: read as `0' bit 5-0 IOCCP<5:0>: Interrupt-on-Change PORTC Positive Edge Enable bits 1 = Interrupt-on-Change enabled on the pin for a positive-going edge. IOCCFx bit and IOCIF flag will be set upon detecting an edge. 0 = Interrupt-on-Change disabled for the associated pin Note 1: Present only in PIC16(L)F15323. REGISTER 17-5: IOCCN: INTERRUPT-ON-CHANGE PORTC NEGATIVE EDGE REGISTER(1) U-0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 -- -- IOCCN5 IOCCN4 IOCCN3 IOCCN2 IOCCN1 IOCCN0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: read as `0' bit 5-0 IOCCN<5:0>: Interrupt-on-Change PORTC Negative Edge Enable bits 1 = Interrupt-on-Change enabled on the pin for a negative-going edge. IOCCFx bit and IOCIF flag will be set upon detecting an edge. 0 = Interrupt-on-Change disabled for the associated pin Note 1: Present only in PIC16(L)F15323. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 206 PIC16(L)F15313/23 REGISTER 17-6: IOCCF: INTERRUPT-ON-CHANGE PORTC FLAG REGISTER(1) U-0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 -- -- IOCCF5 IOCCF4 IOCCF3 IOCCF2 IOCCF1 IOCCF0 bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS - Bit is set in hardware bit 7-0 Note 1: IOCCF<7:0>: Interrupt-on-Change PORTC Flag bits 1 = An enabled change was detected on the associated pin Set when IOCCPx = 1 and a rising edge was detected on RCx, or when IOCCNx = 1 and a falling edge was detected on RCx. 0 = No change was detected, or the user cleared the detected change Present only on PIC16(L)F15323. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 207 PIC16(L)F15313/23 TABLE 17-1: SUMMARY OF REGISTERS ASSOCIATED WITH INTERRUPT-ON-CHANGE Bit 3 Bit 2 Bit 1 Bit 0 Register on Page -- -- -- -- INTEDG 121 IOCIE -- -- -- INTE 122 IOCAP4 IOCAP3 IOCAP2 IOCAP1 IOCAP0 204 IOCAN5 IOCAN4 IOCAN3 IOCAN2 IOCAN1 IOCAN0 204 IOCAF5 IOCAF4 IOCAF3 IOCAF2 IOCAF1 IOCAF0 205 IOCCP1 IOCCP0 206 IOCCN1 IOCCN0 206 IOCCF0 207 Name Bit 7 Bit 6 INTCON GIE PEIE -- PIE0 -- -- TMR0IE IOCAP -- -- IOCAP5 IOCAN -- -- IOCAF -- -- (1) IOCCP -- -- IOCCP5 IOCCP4 IOCCP3 IOCCP2 IOCCN(1) -- -- IOCCN5 IOCCN4 IOCCN3 IOCCN2 IOCCF(1) -- -- IOCCF5 IOCCF4 IOCCF3 IOCCF2 IOCCF1 Legend: Note 1: Bit 5 Bit 4 -- = unimplemented location, read as `0'. Shaded cells are not used by interrupt-on-change. Present only in PIC16(L)F15323. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 208 PIC16(L)F15313/23 18.0 FIXED VOLTAGE REFERENCE (FVR) 18.1 The output of the FVR, which is connected to the ADC, comparators, and DAC, is routed through two independent programmable gain amplifiers. Each amplifier can be programmed for a gain of 1x, 2x or 4x, to produce the three possible voltage levels. The Fixed Voltage Reference, or FVR, is a stable voltage reference, independent of VDD, with 1.024V, 2.048V or 4.096V selectable output levels. The output of the FVR can be configured to supply a reference voltage to the following: * * * * The ADFVR<1:0> bits of the FVRCON register are used to enable and configure the gain amplifier settings for the reference supplied to the ADC module. Reference Section 20.0 "Analog-to-Digital Converter (ADC) Module" for additional information. ADC input channel ADC positive reference Comparator positive and negative input Digital-to-Analog Converter (DAC) The CDAFVR<1:0> bits of the FVRCON register are used to enable and configure the gain amplifier settings for the reference supplied to the DAC and comparator module. Reference Section 21.0 "5-Bit Digital-to-Analog Converter (DAC1) Module" and Section 23.0 "Comparator Module" for additional information. The FVR can be enabled by setting the FVREN bit of the FVRCON register. Note: Independent Gain Amplifiers Fixed Voltage Reference output cannot exceed VDD. 18.2 FVR Stabilization Period When the Fixed Voltage Reference module is enabled, it requires time for the reference and amplifier circuits to stabilize. FVRRDY is an indicator of the reference being ready. In the case of an LF device, or a device on which the BOR is enabled in the Configuration Word settings, then the FVRRDY bit will be high prior to setting FVREN as those module require the reference voltage. FIGURE 18-1: VOLTAGE REFERENCE BLOCK DIAGRAM Rev. 10-000053D 9/15/2016 ADFVR<1:0> CDAFVR<1:0> 2 1x 2x 4x ADC FVR Buffer 1x 2x 4x Comparator and DAC FVR Buffer 2 FVREN Voltage Reference Note 1: 2: FVRRDY (Note 1) FVRRDY is always `1'. Any peripheral requiring the Fixed Reference (See Table 18-1). 2017 Microchip Technology Inc. Preliminary DS40001897A-page 209 PIC16(L)F15313/23 18.3 Register Definitions: FVR Control REGISTER 18-1: FVRCON: FIXED VOLTAGE REFERENCE CONTROL REGISTER R/W-0/0 R-q/q FVREN FVRRDY(1) R/W-0/0 TSEN (3) R/W-0/0 TSRNG R/W-0/0 (3) R/W-0/0 R/W-0/0 CDAFVR<1:0> bit 7 R/W-0/0 ADFVR<1:0> bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7 FVREN: Fixed Voltage Reference Enable bit 1 = Fixed Voltage Reference is enabled 0 = Fixed Voltage Reference is disabled bit 6 FVRRDY: Fixed Voltage Reference Ready Flag bit(1) 1 = Fixed Voltage Reference output is ready for use 0 = Fixed Voltage Reference output is not ready or not enabled bit 5 TSEN: Temperature Indicator Enable bit(3) 1 = Temperature Indicator is enabled 0 = Temperature Indicator is disabled bit 4 TSRNG: Temperature Indicator Range Selection bit(3) 1 = Temperature in High Range VOUT = 3VT 0 = Temperature in Low Range VOUT = 2VT bit 3-2 CDAFVR<1:0>: Comparator FVR Buffer Gain Selection bits 11 = Comparator FVR Buffer Gain is 4x, (4.096V)(2) 10 = Comparator FVR Buffer Gain is 2x, (2.048V)(2) 01 = Comparator FVR Buffer Gain is 1x, (1.024V) 00 = Comparator FVR Buffer is off bit 1-0 ADFVR<1:0>: ADC FVR Buffer Gain Selection bit 11 = ADC FVR Buffer Gain is 4x, (4.096V)(2) 10 = ADC FVR Buffer Gain is 2x, (2.048V)(2) 01 = ADC FVR Buffer Gain is 1x, (1.024V) 00 = ADC FVR Buffer is off Note 1: 2: 3: FVRRDY is always `1'. Fixed Voltage Reference output cannot exceed VDD. See Section 19.0 "Temperature Indicator Module" for additional information. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 210 PIC16(L)F15313/23 TABLE 18-1: Name FVRCON SUMMARY OF REGISTERS ASSOCIATED WITH FIXED VOLTAGE REFERENCE Bit 7 Bit 6 Bit 5 Bit 4 FVREN FVRRDY TSEN TSRNG ADCON0 Bit 2 CDAFVR<1:0> CHS<5:0> ADCON1 ADFM DAC1CON0 Legend: Bit 3 DAC1EN -- DAC1OE1 DAC1OE2 -- DAC1PSS<1:0> Bit 0 ADFVR<1:0> GO/DONE -- ADCS<2:0> Bit 1 ADON Register on page 210 223 ADPREF<1:0> 224 -- 232 DAC1NSS - = unimplemented locations read as `0'. Shaded cells are not used with the Fixed Voltage Reference. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 211 PIC16(L)F15313/23 19.0 TEMPERATURE INDICATOR MODULE This family of devices is equipped with a temperature circuit designed to measure the operating temperature of the silicon die. The main purpose of the temperature indicator module is to provide a temperature-dependent voltage that can be measured by the Analog-toDigital Converter. The circuit's range of operating temperature falls between -40C and +125C. The circuit may be used as a temperature threshold detector or a more accurate temperature indicator, depending on the level of calibration performed. A one-point calibration allows the circuit to indicate a temperature closely surrounding that point. A two-point calibration allows the circuit to sense the entire range of temperature more accurately. 19.1 Module Operation The temperature indicator module consists of a temperature-sensing circuit that provides a voltage to the device ADC. The analog voltage output, VTSENSE, varies inversely to the device temperature. The output of the temperature indicator is referred to as VOUT. The output of the circuit is measured using the internal Analog-to-Digital Converter. A channel is reserved for the temperature circuit output. Refer to Section 20.0 "Analog-to-Digital Converter (ADC) Module" for detailed information. The ON/OFF bit for the module is located in the FVRCON register. See Section 18.0 "Fixed Voltage Reference (FVR)" for more information. The circuit is enabled by setting the TSEN bit of the FVRCON register. When the module is disabled, the circuit draws no current. The circuit operates in either High or Low range. Refer to Section 19.5 "Temperature Indicator Range" for more details on the range settings. 19.2 This section describes how the sensor voltage can be used to estimate the temperature of the module. To use the sensor, the output voltage, VTSENSE, is measured and the corresponding temperature is determined. Equation 19-1 provides an estimate for the die temperature based on the VTSENSE value. EQUATION 19-1: Figure 19-1 shows a simplified block diagram of the temperature indicator module. FIGURE 19-1: TEMPERATURE INDICATOR BLOCK DIAGRAM Rev. 10-000069B 10/18/2016 Estimation of Temperature SENSOR TEMPERATURE T SENSE = V TSENSE Mt + T OFFSET Where: Mt = 1/Mv, where Mv = sensor voltage sensitivity (V/C). TOFFSET is the temperature difference between the theoretical temperature and the actual temperature. VREF TSEN VOUT Temp. Indicator To ADC TSRNG 2017 Microchip Technology Inc. Preliminary DS40001897A-page 212 PIC16(L)F15313/23 19.2.1 CALIBRATION 19.2.1.1 19.2.2 Single-Point Calibration Single-point calibration is performed by application software using Equation 19-1 and the assumed Mt. A reading of VTSENSE at a known temperature is taken, and the theoretical temperature is calculated by temporarily setting TOFFSET = 0. Then TOFFSET is computed as the difference of the actual and calculated temperatures. Finally, TOFFSET is stored in nonvolatile memory within the device, and is applied to future readings to gain a more accurate measurement. 19.2.1.2 Higher-Order Calibration TEMPERATURE RESOLUTION The resolution of the ADC reading, Ma (C/count), depends on both the ADC resolution N and the reference voltage used for conversion, as shown in Equation 19-2. It is recommended to use the smallest VREF value, such as 2.048 FVR reference voltage, instead of VDD. Note: Refer to Section 37.0 "Electrical Specifications" for FVR reference voltage accuracy. EQUATION 19-2: If the application requires more precise temperature measurement, additional calibrations steps will be necessary. For these applications, two-point or threepoint calibration is recommended. V REF Ma = ----------- Mt N 2 V REF ----------N 2 Ma = -----------Mv Note 1: The TOFFSET value may be determined by the user with a temperature test. 2: Although the measurement range is -40C to +125 C due to the variations in offset error, the single-point uncalibrated calculated TSENSE value may indicate a temperature from -140C to +225C before the calibration offset is applied. 3: The user must take into consideration self-heating of the device at different clock frequencies and output pin loading. For package related thermal characteristics information, refer to Section TABLE 37-6: "Thermal Characteristics". TEMPERATURE RESOLUTION (C/LSb) Where: Mv = sensor voltage sensitivity (V/C) VREF = Reference voltage of the ADC module (in Volts) N = Resolution of the ADC The typical Mv value for a single diode is approximately -1.267 to -1.32 mV/C. The typical Mv value for a stack of two diodes (low range setting) is approximately -2.533 mV/C. The typical Mv value for a stack of three diodes (high range setting) is approximately -3.8 mV/C. 19.3 ADC Acquisition Time To ensure accurate temperature measurements, the user must wait a minimum of 25 us for the ADC value to settle, after the ADC input multiplexer is connected to the temperature indicator output, before the conversion is performed. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 213 PIC16(L)F15313/23 19.4 Minimum Operating VDD 19.6 When the temperature circuit is operated in Low range, the device may be operated at any operating voltage that is within specifications. When the temperature circuit is operated in High range, the device operating voltage, VDD, must be high enough to ensure that the temperature circuit is correctly biased. During factory testing, internal ADC readings are taken at a single temperature point within the operating range of the device, and stored in the Data Information Area (DIA). Two readings are currently taken and stored in the DIA for each device. One with the low range setting selected and one for the high range setting. Both readings are taken at the same temperature reference point. Table 19-1 shows the recommended minimum VDD vs. Range setting. TABLE 19-1: Min. VDD, TSRNG = 0 (Low Range) 2.5 1.8 19.5 These single temperature point readings stored in the DIA can be used to perform the single-point calibration as described in Section 19.2.1 "Calibration" by solving Equation 19-1 for TOFFSET. RECOMMENDED VDD vs. RANGE Min.VDD, TSRNG = 1 (High Range) Device Information Area (DIA) Data Note that the lower temperature range (e.g., -40C) will suffer in accuracy because temperature conversion must extrapolate below the reference points, amplifying any measurement errors. Note: Temperature Indicator Range The temperature indicator circuit operates in either High or Low range. The High range, selected by setting the TSRNG bit of the FVRCON register, provides a wider output voltage. This provides more resolution over the temperature range. High range requires a higher-bias voltage to operate and thus, a higher VDD is needed. The Low range is selected by clearing the TSRNG bit of the FVRCON register. The Low range generates a lower sensor voltage and thus, a lower VDD voltage is needed to operate the circuit. Refer to Section 6.3 "Analog-to-Digital Conversion Data of the Temperature Sensor" for more information on the temperature indicator data stored in the DIA and how to access it. The output voltage of the sensor is the highest value at -40C and the lowest value at +125C. * High Range: The High range is used in applications with the reference for the ADC, VREF = 2.048V. This range may not be suitable for battery-powered applications. * Low Range: This mode is useful in applications in which the VDD is too low for high-range operation. The VDD in this mode can be as low as 1.8V. VDD must, however, be at least 0.5V higher than the maximum sensor voltage depending on the expected low operating temperature. TABLE 19-2: SUMMARY OF REGISTERS ASSOCIATED WITH THE TEMPERATURE INDICATOR Name Bit 7 Bit 6 Bit 5 Bit 4 FVRCON FVREN FVRRDY TSEN TSRNG ADCON0 ADCON1 ADACT Bit 3 Bit 2 CDFVR<1:0> CHS<5:0> ADFM -- ADCS<2:0> -- Bit 1 ADFVR<1:0> GO/DONE -- -- Bit 0 -- ADACT<4:0> ADON ADPREF<1:0> Register on Page 210 223 224 225 ADRESH ADRESH<7:0> 226 ADRESL ADRESL<7:0> 226 Legend: Shaded cells are unused by the Temperature Indicator module. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 214 PIC16(L)F15313/23 20.0 The ADC voltage reference is software selectable to be either internally generated or externally supplied. ANALOG-TO-DIGITAL CONVERTER (ADC) MODULE The Analog-to-Digital Converter (ADC) allows conversion of an analog input signal to a 10-bit binary representation of that signal. This device uses analog inputs, which are multiplexed into a single sample and hold circuit. The output of the sample and hold is connected to the input of the converter. The converter generates a 10-bit binary result via successive approximation and stores the conversion result into the ADC result registers (ADRESH:ADRESL register pair). Figure 20-1 shows the block diagram of the ADC. FIGURE 20-1: The ADC can generate an interrupt upon completion of a conversion. This interrupt can be used to wake-up the device from Sleep. ADC BLOCK DIAGRAM VDD ADPREF Rev. 10-000033A 7/30/2013 Positive Reference Select VDD VREF+ pin External Channel Inputs ANa VRNEG VRPOS . . . ADC_clk sampled input ANz Internal Channel Inputs ADCS<2:0> VSS AN0 ADC Clock Select FOSC/n Fosc Divider FRC FOSC FRC Temp Indicator DACx_output ADC CLOCK SOURCE FVR_buffer1 ADC Sample Circuit CHS<4:0> ADFM set bit ADIF Write to bit GO/DONE 10-bit Result GO/DONE Q1 Q4 16 start ADRESH Q2 TRIGSEL<3:0> 10 complete ADRESL Enable Trigger Select ADON . . . VSS Trigger Sources AUTO CONVERSION TRIGGER 2017 Microchip Technology Inc. Preliminary DS40001897A-page 215 PIC16(L)F15313/23 20.1 20.1.3 ADC Configuration When configuring and using the ADC the following functions must be considered: * * * * * * Port configuration Channel selection ADC voltage reference selection ADC conversion clock source Interrupt control Result formatting 20.1.1 20.1.2 VREF+ pin VDD FVR 2.048V FVR 4.096V (Not available on LF devices) The ADPREF bit of the ADCON1 register provides control of the negative voltage reference. The negative voltage reference can be: PORT CONFIGURATION Analog voltages on any pin that is defined as a digital input may cause the input buffer to conduct excess current. CHANNEL SELECTION * VREF- pin * VSS See Section 18.0 "Fixed Voltage Reference (FVR)" for more details on the Fixed Voltage Reference. 20.1.4 Six Port A channels Six Port C channels (PIC16(L)F15323 only) Temperature Indicator DAC output Fixed Voltage Reference (FVR) AVSS (Ground) The CHS<5:0> bits of the ADCON0 register (Register 20-1) determine which channel is connected to the sample and hold circuit. When changing channels, a delay is required before starting the next conversion. Refer to Section 20.2 "ADC Operation" for more information. FOSC/2 FOSC/4 FOSC/8 FOSC/16 FOSC/32 FOSC/64 ADCRC (dedicated RC oscillator) The time to complete one bit conversion is defined as TAD. One full 10-bit conversion requires 11.5 TAD periods as shown in Figure 20-2. For correct conversion, the appropriate TAD specification must be met. Refer to Table 37-13 for more information. Table 20-1 gives examples of appropriate ADC clock selections. Note: Note: It is recommended that when switching from an ADC channel of a higher voltage to a channel of a lower voltage, that the user selects the VSS channel before connecting to the channel with the lower voltage. If the ADC does not have a dedicated VSS input channel, the VSS selection (DAC1R<4:0> = b'00000') through the DAC output channel can be used. If the DAC is in use, a free input channel can be connected to VSS, and can be used in place of the DAC. 2017 Microchip Technology Inc. CONVERSION CLOCK The source of the conversion clock is software selectable via the ADCS<2:0> bits of the ADCON1 register. There are seven possible clock options: * * * * * * * There are several channel selections available: * * * * * * The ADPREF<1:0> bits of the ADCON1 register provides control of the positive voltage reference. The positive voltage reference can be: * * * * The ADC can be used to convert both analog and digital signals. When converting analog signals, the I/O pin will be configured for analog by setting the associated TRIS and ANSEL bits. Refer to Section 14.0 "I/O Ports" for more information. Note: ADC VOLTAGE REFERENCE Preliminary Unless using the ADCRC, any changes in the system clock frequency will change the ADC clock frequency, which may adversely affect the ADC result. DS40001897A-page 216 PIC16(L)F15313/23 TABLE 20-1: ADC CLOCK PERIOD (TAD) VS. DEVICE OPERATING FREQUENCIES ADC Clock Period (TAD) Device Frequency (FOSC) ADC Clock Source ADCS<2:0> 32 MHz 20 MHz 16 MHz 8 MHz 4 MHz FOSC/2 000 62.5ns(2) 100 ns(2) 125 ns(2) 250 ns(2) 500 ns(2) 2.0 s FOSC/4 100 125 ns(2) ns(2) ns(2) ns(2) 1.0 s 4.0 s FOSC/8 001 0.5 s(2) 400 ns(2) 0.5 s(2) 1.0 s 2.0 s 8.0 s(3) FOSC/16 101 800 ns 800 ns 1.0 s 2.0 s 4.0 s 16.0 s(3) 200 250 500 FOSC/32 010 1.0 s 1.6 s 2.0 s 4.0 s FOSC/64 110 2.0 s 3.2 s 4.0 s 8.0 s(3) ADCRC Legend: Note 1: 2: 3: 4: 1.0-6.0 x11 s(1,4) 1.0-6.0 s(1,4) 1.0-6.0 s(1,4) 1.0-6.0 s(3) 32.0 s(2) 16.0 s(2) 64.0 s(2) 8.0 s(1,4) 1 MHz 1.0-6.0 s(1,4) 1.0-6.0 s(1,4) Shaded cells are outside of recommended range. See TAD parameter for ADCRC source typical TAD value. These values violate the required TAD time. Outside the recommended TAD time. The ADC clock period (TAD) and total ADC conversion time can be minimized when the ADC clock is derived from the system clock FOSC. However, the ADCRC oscillator source must be used when conversions are to be performed with the device in Sleep mode. FIGURE 20-2: ANALOG-TO-DIGITAL CONVERSION TAD CYCLES Rev. 10-000035A 7/30/2013 TAD1 TAD2 TAD3 TAD4 TAD5 TAD6 TAD7 TAD8 TAD9 TAD10 TAD11 b9 b8 b7 b6 b5 b4 b3 b2 b1 b0 THCD Conversion Starts TACQ Holding capacitor disconnected from analog input (THCD). Set GO bit On the following cycle: ADRESH:ADRESL is loaded, GO bit is cleared, ADIF bit is set, holding capacitor is reconnected to analog input. Enable ADC (ADON bit) and Select channel (ACS bits) 2017 Microchip Technology Inc. Preliminary DS40001897A-page 217 PIC16(L)F15313/23 20.1.5 INTERRUPTS 20.1.6 The ADC module allows for the ability to generate an interrupt upon completion of an Analog-to-Digital conversion. The ADC Interrupt Flag is the ADIF bit in the PIR1 register. The ADC Interrupt Enable is the ADIE bit in the PIE1 register. The ADIF bit must be cleared in software. RESULT FORMATTING The 10-bit ADC conversion result can be supplied in two formats, left justified or right justified. The ADFM bit of the ADCON1 register controls the output format. Figure 20-3 shows the two output formats. Note 1: The ADIF bit is set at the completion of every conversion, regardless of whether or not the ADC interrupt is enabled. 2: The ADC operates during Sleep only when the ADCRC oscillator is selected. This interrupt can be generated while the device is operating or while in Sleep. If the device is in Sleep, the interrupt will wake-up the device. Upon waking from Sleep, the next instruction following the SLEEP instruction is always executed. If the user is attempting to wake-up from Sleep and resume in-line code execution, the ADIE bit of the PIE1 register and the PEIE bit of the INTCON register must both be set and the GIE bit of the INTCON register must be cleared. If all three of these bits are set, the execution will switch to the Interrupt Service Routine (ISR). FIGURE 20-3: 10-BIT ADC CONVERSION RESULT FORMAT Rev. 10-000 054A 12/21/201 6 ADRESH ADRESL (ADFM = 0) MSb LSb bit 0 bit 7 10-bit ADC Result (ADFM = 1) bit 0 bit 7 Unimplemented: Read as `0' MSb bit 7 LSb bit 0 bit 7 10-bit ADC Result Unimplemented: Read as `0' 2017 Microchip Technology Inc. bit 0 Preliminary DS40001897A-page 218 PIC16(L)F15313/23 20.2 20.2.1 20.2.3 ADC Operation STARTING A CONVERSION To enable the ADC module, the ADON bit of the ADCON0 register must be set to a `1'. Setting the GO/DONE bit of the ADCON0 register to a `1' will start the Analog-to-Digital conversion. Note: 20.2.2 The GO/DONE bit will not be set in the same instruction that turns on the ADC. Refer to Section 20.2.5 "ADC Conversion Procedure". COMPLETION OF A CONVERSION When the conversion is complete, the ADC module will: * Clear the GO/DONE bit * Set the ADIF Interrupt Flag bit * Update the ADRESH and ADRESL registers with new conversion result Note: A device Reset forces all registers to their Reset state. Thus, the ADC module is turned off and any pending conversion is terminated. ADC OPERATION DURING SLEEP The ADC module can operate during Sleep. This requires the ADC clock source to be set to the ADCRC option. When the ADCRC oscillator source is selected, the ADC waits one additional instruction before starting the conversion. This allows the SLEEP instruction to be executed, which can reduce system noise during the conversion. If the ADC interrupt is enabled, the device will wake-up from Sleep when the conversion completes. If the ADC interrupt is disabled, the ADC module is turned off after the conversion completes, although the ADON bit remains set. When the ADC clock source is something other than ADCRC, a SLEEP instruction causes the present conversion to be aborted and the ADC module is turned off, although the ADON bit remains set. 20.2.4 AUTO-CONVERSION TRIGGER The Auto-conversion Trigger allows periodic ADC measurements without software intervention. When a rising edge of the selected source occurs, the GO/DONE bit is set by hardware. The Auto-conversion Trigger source is selected with the ADACT<4:0> bits of the ADACT register. Using the Auto-conversion Trigger does not assure proper ADC timing. It is the user's responsibility to ensure that the ADC timing requirements are met. See Table 20-2 for auto-conversion sources. TABLE 20-2: ADACT VALUE 2017 Microchip Technology Inc. ADC AUTO-CONVERSION TABLE SOURCE/ PERIPHERAL DESCRIPTION 0x00 Disabled 0x01 ADACTPPS Pin Selected by ADACTPPS 0x02 TMR0 Timer0 overflow condition 0x03 TMR1 Timer1 overflow condition 0x04 TMR2 Match between Timer2 postscaled value and PR2 0x05 CCP1 CCP1 output 0x06 CCP2 CCP2 output 0x07 PWM3 PWM3 output 0x08 PWM4 PWM4 output 0x09 PWM5 PWM5 output 0x0A PWM6 PWM6 output 0x0B NCO1 NCO1 output 0x0C C1OUT Comparator C1 output 0x0D C2OUT Comparator C2 output 0x0E IOCIF Interrupt-on change flag trigger 0x0F CLC1 CLC1 output 0x10 CLC2 CLC2 output 0x11 CLC3 CLC3 output 0x12 CLC4 CLC4 output 0x13-0xFF Reserved Reserved, do not use Preliminary External Trigger Disabled DS40001897A-page 219 PIC16(L)F15313/23 20.2.5 ADC CONVERSION PROCEDURE This is an example procedure for using the ADC to perform an Analog-to-Digital conversion: 1. 2. 3. 4. 5. 6. 7. 8. Configure Port: * Disable pin output driver (Refer to the TRIS register) * Configure pin as analog (Refer to the ANSEL register) Configure the ADC module: * Select ADC conversion clock * Select voltage reference * Select ADC input channel * Turn on ADC module Configure ADC interrupt (optional): * Clear ADC interrupt flag * Enable ADC interrupt * Enable peripheral interrupt * Enable global interrupt(1) Wait the required acquisition time(2). Start conversion by setting the GO/DONE bit. Wait for ADC conversion to complete by one of the following: * Polling the GO/DONE bit * Waiting for the ADC interrupt Read ADC Result. Clear the ADC interrupt flag (required if interrupt is enabled). EXAMPLE 20-1: ADC CONVERSION ;This code block configures the ADC ;for polling, Vdd and Vss references, ADCRC ;oscillator and AN0 input. ; ;Conversion start & polling for completion ; are included. ; BANKSEL ADCON1 ; MOVLW B'11110000' ;Right justify, ADCRC ;oscillator MOVWF ADCON1 ;Vdd and Vss Vref BANKSEL TRISA ; BSF TRISA,0 ;Set RA0 to input BANKSEL ANSELA ; BSF ANSELA,0 ;Set RA0 to analog BANKSEL ADCON0 ; MOVLW B'00000001' ;Select channel AN0 MOVWF ADCON0 ;Turn ADC On CALL SampleTime ;Acquisiton delay BSF ADCON0,ADGO ;Start conversion BTFSC ADCON0,ADGO ;Is conversion done? GOTO $-1 ;No, test again BANKSEL ADRESH ; MOVF ADRESH,W ;Read upper 2 bits MOVWF RESULTHI ;store in GPR space BANKSEL ADRESL ; MOVF ADRESL,W ;Read lower 8 bits MOVWF RESULTLO ;Store in GPR space Note 1: The global interrupt can be disabled if the user is attempting to wake-up from Sleep and resume in-line code execution. 2: Refer to Section 20.3 "ADC Acquisition Requirements". 2017 Microchip Technology Inc. Preliminary DS40001897A-page 220 PIC16(L)F15313/23 20.3 ADC Acquisition Requirements For the ADC to meet its specified accuracy, the charge holding capacitor (CHOLD) must be allowed to fully charge to the input channel voltage level. The Analog Input model is shown in Figure 20-4. The source impedance (RS) and the internal sampling switch (RSS) impedance directly affect the time required to charge the capacitor CHOLD. The sampling switch (RSS) impedance varies over the device voltage (VDD), refer to Figure 20-4. The maximum recommended impedance for analog sources is 10 k. As the EQUATION 20-1: Assumptions: source impedance is decreased, the acquisition time may be decreased. After the analog input channel is selected (or changed), an ADC acquisition must be done before the conversion can be started. To calculate the minimum acquisition time, Equation 20-1 may be used. This equation assumes that 1/2 LSb error is used (1024 steps for the ADC). The 1/2 LSb error is the maximum error allowed for the ADC to meet its specified resolution. ACQUISITION TIME EXAMPLE Temperature = 50C and external impedance of 10k 5.0V V DD T ACQ = Amplifier Settling Time + Hold Capacitor Charging Time + Temperature Coefficient = T AMP + T C + T COFF = 2s + T C + Temperature - 25C 0.05s/C The value for TC can be approximated with the following equations: 1 = V CHOLD V AP P LI ED 1 - -------------------------n+1 2 -1 ;[1] VCHOLD charged to within 1/2 lsb -TC ---------- RC V AP P LI ED 1 - e = V CHOLD ;[2] VCHOLD charge response to VAPPLIED - Tc --------- 1 RC ;combining [1] and [2] V AP P LI ED 1 - e = V A PP LIE D 1 - -------------------------n+1 2 -1 Note: Where n = number of bits of the ADC. Solving for TC: T C = - C HOLD R IC + R SS + R S ln(1/2047) = - 10pF 1k + 7k + 10k ln(0.0004885) = 1.37 s Therefore: T A CQ = 2s + 1.37 + 50C- 25C 0.05s/C = 4.62s Note 1: The VAPPLIED has no effect on the equation, since it cancels itself out. 2: The charge holding capacitor (CHOLD) is not discharged after each conversion. 3: The maximum recommended impedance for analog sources is 10 k. This is required to meet the pin leakage specification. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 221 PIC16(L)F15313/23 FIGURE 20-4: ANALOG INPUT MODEL Rev. 10-000070A 8/23/2016 VDD RS Analog Input pin VT 0.6V RIC 1K Sampling switch SS RSS ILEAKAGE(1) VA Legend: CHOLD CPIN ILEAKAGE RIC RSS SS VT RS Note 1: FIGURE 20-5: CPIN 5pF CHOLD = 10 pF VT 0.6V Ref- = Sample/Hold Capacitance = Input Capacitance = Leakage Current at the pin due to varies injunctions = Interconnect Resistance = Resistance of Sampling switch = Sampling Switch = Threshold Voltage = Source Resistance VDD 6V 5V 4V 3V 2V RSS 5 6 7 8 9 10 11 Sampling Switch (k ) See Refer to Section 37.0 "Electrical Specifications". ADC TRANSFER FUNCTION Full-Scale Range 3FFh 3FEh ADC Output Code 3FDh 3FCh 3FBh 03h 02h 01h 00h Analog Input Voltage 0.5 LSB Ref- 2017 Microchip Technology Inc. 1.5 LSB Zero-Scale Transition Full-Scale Transition Preliminary Ref+ DS40001897A-page 222 PIC16(L)F15313/23 20.4 Register Definitions: ADC Control REGISTER 20-1: R/W-0/0 ADCON0: ADC CONTROL REGISTER 0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 CHS<5:0> R/W-0/0 R/W-0/0 GO/DONE ADON bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-2 CHS<5:0>: Analog Channel Select bits 111111 = FVR Buffer 2 reference voltage(2) 111110 = FVR 1Buffer 1 reference voltage(2) 111101 = DAC1 output voltage(1) 111100 = Temperature sensor output(3) 111011 = AVSS (Analog Ground) 010111 = Reserved 010110 = Reserved 010101 = RC5(4) 010100 = RC4(4) 010011 = RC3(4) 010010 = RC2(4) 010001 = RC1(4) 010000 = RC0(4) 001111 = Reserved * * * 000110 = Reserved 000101 = RA5(5) 000100 = RA4(5) 000011 = RA3 000010 = RA2 000001 = RA1 000000 = RA0 bit 1 GO/DONE: ADC Conversion Status bit 1 = ADC conversion cycle in progress. Setting this bit starts an ADC conversion cycle. This bit is automatically cleared by hardware when the ADC conversion has completed. 0 = ADC conversion completed/not in progress bit 0 ADON: ADC Enable bit 1 = ADC is enabled 0 = ADC is disabled and consumes no operating current Note 1: 2: 3: 4: 5: See Section 21.0 "5-Bit Digital-to-Analog Converter (DAC1) Module" for more information. See Section 18.0 "Fixed Voltage Reference (FVR)" for more information. See Section 19.0 "Temperature Indicator Module" for more information. Present only on the PIC16(L)F15323. The analog functionality on the channels RA4 and RA5 is disabled when the system clock source is an external oscillator. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 223 PIC16(L)F15313/23 REGISTER 20-2: R/W-0/0 ADCON1: ADC CONTROL REGISTER 1 R/W-0/0 ADFM R/W-0/0 R/W-0/0 ADCS<2:0> U-0 U-0 -- -- R/W-0/0 bit 7 R/W-0/0 ADPREF<1:0> bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 ADFM: ADC Result Format Select bit 1 = Right justified. Six Most Significant bits of ADRESH are set to `0' when the conversion result is loaded. 0 = Left justified. Six Least Significant bits of ADRESL are set to `0' when the conversion result is loaded. bit 6-4 ADCS<2:0>: ADC Conversion Clock Select bits 111 = ADCRC (dedicated RC oscillator) 110 = FOSC/64 101 = FOSC/16 100 = FOSC/4 011 = ADCRC (dedicated RC oscillator) 010 = FOSC/32 001 = FOSC/8 000 = FOSC/2 bit 3-2 Unimplemented: Read as `0' bit 1-0 ADPREF<1:0>: ADC Positive Voltage Reference Configuration bits 11 = VREF+ is connected to internal Fixed Voltage Reference (FVR) module(1) 10 = VREF+ is connected to external VREF+ pin(1) 01 = Reserved 00 = VREF+ is connected to VDD Note 1: When selecting the VREF+ pin as the source of the positive reference, be aware that a minimum voltage specification exists. See Table 37-14 for details. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 224 PIC16(L)F15313/23 REGISTER 20-3: ADACT: A/D AUTO-CONVERSION TRIGGER U-0 U-0 U-0 -- -- -- R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 ADACT<4:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-5 Unimplemented: Read as `0' bit 4-0 ADACT<4:0>: Auto-Conversion Trigger Selection bits(1) (see Table 20-2) Note 1: This is a rising edge sensitive input for all sources. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 225 PIC16(L)F15313/23 REGISTER 20-4: R/W-x/u ADRESH: ADC RESULT REGISTER HIGH (ADRESH) ADFM = 0 R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u ADRES<9:2> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 ADRES<9:2>: ADC Result Register bits Upper eight bits of 10-bit conversion result REGISTER 20-5: R/W-x/u ADRESL: ADC RESULT REGISTER LOW (ADRESL) ADFM = 0 R/W-x/u ADRES<1:0> R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u -- -- -- -- -- -- bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 ADRES<1:0>: ADC Result Register bits Lower two bits of 10-bit conversion result bit 5-0 Reserved: Do not use. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 226 PIC16(L)F15313/23 REGISTER 20-6: ADRESH: ADC RESULT REGISTER HIGH (ADRESH) ADFM = 1 R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u -- -- -- -- -- -- R/W-x/u R/W-x/u ADRES<9:8> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-2 Reserved: Do not use. bit 1-0 ADRES<9:8>: ADC Result Register bits Upper two bits of 10-bit conversion result REGISTER 20-7: R/W-x/u ADRESL: ADC RESULT REGISTER LOW (ADRESL) ADFM = 1 R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u ADRES<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 ADRES<7:0>: ADC Result Register bits Lower eight bits of 10-bit conversion result 2017 Microchip Technology Inc. Preliminary DS40001897A-page 227 PIC16(L)F15313/23 TABLE 20-3: Name SUMMARY OF REGISTERS ASSOCIATED WITH ADC Bit 7 INTCON Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page GIE PEIE -- -- -- -- -- INTEDG 121 PIE1 OSFIE CSWIE -- -- -- -- -- ADIE 123 PIR1 OSFIF CSWIF -- -- -- -- -- ADIF 131 -- TRISA5 TRISA4 -- TRISA2 TRISA1 TRISA0 175 -- ANSC5 ANSC4 ANSC3 ANSC2 ANSC1 ANSC0 182 GO/DONE ADON 223 TRISA -- ANSELC(1) -- ADCON0 CHS<5:0> ADCON1 ADFM ADACT ADCS<2:0> -- -- -- -- ADRESH ADRESH<7:0> ADRESL ADRESL<7:0> FVRCON FVREN FVRRDY TSEN DAC1CON1 -- -- -- OSCSTAT1 EXTOR HFOR MFOR Legend: Note 1: -- ADPREF<1:0> ADACT<4:0> TSRNG 225 226 226 CDAFVR<1:0> ADFVR<1:0> DAC1R<4:0> LFOR SOR 224 ADOR 210 232 -- PLLR 112 -- = unimplemented read as `0'. Shaded cells are not used for the ADC module. Present on PIC16(L)F15323PIC16(L)F15323 only. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 228 PIC16(L)F15313/23 21.0 5-BIT DIGITAL-TO-ANALOG CONVERTER (DAC1) MODULE The Digital-to-Analog Converter supplies a variable voltage reference, ratiometric with the input source, with 32 selectable output levels. 21.1 Output Voltage Selection The DAC has 32 voltage level ranges. The 32 levels are set with the DAC1R<4:0> bits of the DAC1CON1 register. The DAC output voltage is determined by Equation 21-1: The input of the DAC can be connected to: * External VREF pins * VDD supply voltage * FVR (Fixed Voltage Reference) The output of the DAC can be configured to supply a reference voltage to the following: * Comparator positive input * ADC input channel * DAC1OUT pin The Digital-to-Analog Converter (DAC) is enabled by setting the DAC1EN bit of the DAC1CON0 register. EQUATION 21-1: DAC OUTPUT VOLTAGE V V V 21.2 OUT DAC1R 4:0 = V -V ----------------------------------- + V SOURCESOURCE+ SOURCE5 2 SOURCE+ = V DD or V REF+ or FV R V SOURCE- = SS or V REF- Ratiometric Output Level The DAC output value is derived using a resistor ladder with each end of the ladder tied to a positive and negative voltage reference input source. If the voltage of either input source fluctuates, a similar fluctuation will result in the DAC output value. The value of the individual resistors within the ladder can be found in Table 37-15. 21.3 DAC Voltage Reference Output The DAC voltage can be output to the DAC1OUT1/2 pins by setting the DAC1OE1/2 bits of the DAC1CON0 register, respectively. Selecting the DAC reference voltage for output on the DAC1OUT1/2 pins automatically overrides the digital output buffer and digital input threshold detector functions, disables the weak pull-up, and disables the current-controlled drive function of that pin. Reading the DAC1OUT1/2 pin when it has been configured for DAC reference voltage output will always return a `0'. Due to the limited current drive capability, a buffer must be used on the DAC voltage reference output for external connections to the DAC1OUT1/2 pins. Figure 21-2 shows an example buffering technique. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 229 PIC16(L)F15313/23 FIGURE 21-1: DIGITAL-TO-ANALOG CONVERTER BLOCK DIAGRAM Rev. 10-000026G 12/15/2016 Reserved 11 FVR Buffer 10 VSOURCE+ R 01 VREF+ DACR<4:0> 5 00 VDD R DACPSS R 32-to-1 MUX R 32 Steps DACEN DACx_output To Peripherals R DACxOUT1(1) R DACOE1 R DACxOUT2(1) 1 VREF- DACOE2 VSOURCE- 0 VSS DACNSS Note 1: The unbuffered DACx_output is provided on the DACxOUT pin(s). FIGURE 21-2: VOLTAGE REFERENCE OUTPUT BUFFER EXAMPLE PIC(R) MCU DAC Module R Voltage Reference Output Impedance 2017 Microchip Technology Inc. DAC1OUT Preliminary + - Buffered DAC Output DS40001897A-page 230 PIC16(L)F15313/23 21.4 Operation During Sleep The DAC continues to function during Sleep. When the device wakes up from Sleep through an interrupt or a Watchdog Timer time-out, the contents of the DAC1CON0 register are not affected. 21.5 Effects of a Reset A device Reset affects the following: * DAC is disabled. * DAC output voltage is removed from the DAC1OUT1/2 pins. * The DAC1R<4:0> range select bits are cleared. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 231 PIC16(L)F15313/23 21.6 Register Definitions: DAC Control REGISTER 21-1: DAC1CON0: VOLTAGE REFERENCE CONTROL REGISTER 0 R/W-0/0 U-0 R/W-0/0 R/W-0/0 DAC1EN -- DAC1OE1 DAC1OE2 R/W-0/0 R/W-0/0 U-0 R/W-0/0 -- DAC1NSS DAC1PSS<1:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 DAC1EN: DAC1 Enable bit 1 = DAC is enabled 0 = DAC is disabled bit 6 Unimplemented: Read as `0' bit 5 DAC1OE1: DAC1 Voltage Output 1 Enable bit 1 = DAC voltage level is an output on the DAC1OUT1 pin 0 = DAC voltage level is disconnected from the DAC1OUT1 pin bit 4 DAC1OE2: DAC1 Voltage Output 1 Enable bit 1 = DAC voltage level is an output on the DAC1OUT2 pin 0 = DAC voltage level is disconnected from the DAC1OUT2 pin bit 3-2 DAC1PSS<1:0>: DAC1 Positive Source Select bits 11 = Reserved, do not use 10 = FVR output 01 = VREF+ pin 00 = VDD bit 1 Unimplemented: Read as `0' bit 0 DAC1NSS: Read as `0' REGISTER 21-2: DAC1CON1: VOLTAGE REFERENCE CONTROL REGISTER 1 U-0 U-0 U-0 -- -- -- R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 DAC1R<4:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-5 Unimplemented: Read as `0' bit 4-0 DAC1R<4:0>: DAC1 Voltage Output Select bits VOUT = (VSRC+ - VSRC-)*(DAC1R<4:0>/32) + VSRC 2017 Microchip Technology Inc. Preliminary DS40001897A-page 232 PIC16(L)F15313/23 TABLE 21-1: Name SUMMARY OF REGISTERS ASSOCIATED WITH THE DAC1 MODULE Register on page -- DAC1NSS 232 Bit 5 Bit 4 DAC1CON0 DAC1EN -- DAC1OE1 DAC1OE2 DAC1CON1 -- -- -- CM1PSEL -- -- -- -- -- PCH<2:0> 252 -- -- -- -- -- PCH<2:0> 252 Legend: Note 1: Bit 2 Bit 0 Bit 6 CM2PSEL(1) Bit 3 Bit 1 Bit 7 DAC1PSS<1:0> DAC1R<4:0> 232 -- = Unimplemented location, read as `0'. Shaded cells are not used with the DAC module. Present on PIC16(L)F15323 only. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 233 PIC16(L)F15313/23 22.0 NUMERICALLY CONTROLLED OSCILLATOR (NCO) MODULE The Numerically Controlled Oscillator (NCO) module is a timer that uses overflow from the addition of an increment value to divide the input frequency. The advantage of the addition method over simple counter driven timer is that the output frequency resolution does not vary with the divider value. The NCO is most useful for application that requires frequency accuracy and fine resolution at a fixed duty cycle. Features of the NCO include: * * * * * * * 20-bit Increment Function Fixed Duty Cycle mode (FDC) mode Pulse Frequency (PF) mode Output Pulse Width Control Multiple Clock Input Sources Output Polarity Control Interrupt Capability Figure 22-1 is a simplified block diagram of the NCO module. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 234 2017 Microchip Technology Inc. FIGURE 22-1: NUMERICALLY CONTROLLED OSCILLATOR MODULE SIMPLIFIED BLOCK DIAGRAM NCOxINCU NCOxINCH NCOxINCL 20 Rev. 10-000028D 3/24/2017 (1) INCBUFU INCBUFH 20 INCBUFL 20 1111 NCO_overflow Adder 20 NCOx Clock Sources NCOx_clk See NCOxCLK Register NCOxACCU NCOxACCH NCOxACCL 20 NCO_interrupt 0000 Preliminary NxCKS<3:0> 4 set bit NCOxIF Fixed Duty Cycle Mode Circuitry D Q D Q 0 _ 1 Q NCOxOUT NxPOL NCOx_out EN S Q Ripple Counter R Q _ R DS40001897A-page 235 3 NxPWS<2:0> Note 1: To Peripherals NxOUT Pulse Frequency Mode Circuitry The increment registers are double-buffered to allow for value changes to be made without first disabling the NCO module. The full increment value is loaded into the buffer registers on the second rising edge of the NCOx_clk signal that occurs immediately after a write to NCOxINCL register. The buffers are not user-accessible and are shown here for reference. PIC16(L)F15313/23 NxPFM TRIS bit PIC16(L)F15313/23 22.1 NCO OPERATION The NCO operates by repeatedly adding a fixed value to an accumulator. Additions occur at the input clock rate. The accumulator will overflow with a carry periodically, which is the raw NCO output (NCO_overflow). This effectively reduces the input clock by the ratio of the addition value to the maximum accumulator value. See Equation 22-1. The NCO output can be further modified by stretching the pulse or toggling a flip-flop. The modified NCO output is then distributed internally to other peripherals and can be optionally output to a pin. The accumulator overflow also generates an interrupt (NCO_overflow). The NCO period changes in discrete steps to create an average frequency. EQUATION 22-1: NCO OVERFLOW FREQUENCY NCO Clock Frequency Increment Value F OVERFLOW = --------------------------------------------------------------------------------------------------------------20 2 22.1.1 NCO CLOCK SOURCES 22.1.4 Clock sources available to the NCO include: * * * * * * * * * The increment value is stored in three registers making up a 20-bit incrementer. In order of LSB to MSB they are: HFINTOSC FOSC LC1_out LC2_out LC3_out LC4_out MFINTOSC (500 kHz) MFINTOSC (32 kHz) CLKR * NCO1INCL * NCO1INCH * NCO1INCU The NCO clock source is selected by configuring the N1CKS<2:0> bits in the NCO1CLK register. 22.1.2 ACCUMULATOR The accumulator is a 20-bit register. Read and write access to the accumulator is available through three registers: * NCO1ACCL * NCO1ACCH * NCO1ACCU 22.1.3 INCREMENT REGISTERS When the NCO module is enabled, the NCO1INCU and NCO1INCH registers should be written first, then the NCO1INCL register. Writing to the NCO1INCL register initiates the increment buffer registers to be loaded simultaneously on the second rising edge of the NCO_clk signal. The registers are readable and writable. The increment registers are double-buffered to allow value changes to be made without first disabling the NCO module. When the NCO module is disabled, the increment buffers are loaded immediately after a write to the increment registers. Note: The increment buffer registers are not useraccessible. ADDER The NCO Adder is a full adder, which operates synchronously from the source clock. The addition of the previous result and the increment value replaces the accumulator value on the rising edge of each input clock. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 236 PIC16(L)F15313/23 22.2 FIXED DUTY CYCLE MODE 22.5 In Fixed Duty Cycle (FDC) mode, every time the accumulator overflows (NCO_overflow), the output is toggled at a frequency rate half of the FOVERFLOW. This provides a 50% duty cycle, provided that the increment value remains constant. For more information, see Figure 22-2. Interrupts When the accumulator overflows (NCO_overflow), the NCO Interrupt Flag bit, NCO1IF, of the PIR7 register is set. To enable the interrupt event (NCO_interrupt), the following bits must be set: The FDC mode is selected by clearing the N1PFM bit in the NCO1CON register. * * * * 22.3 The interrupt must be cleared by software by clearing the NCO1IF bit in the Interrupt Service Routine. PULSE FREQUENCY MODE In Pulse Frequency (PF) mode, every time the Accumulator overflows, the output becomes active for one or more clock periods. Once the clock period expires, the output returns to an inactive state. This provides a pulsed output. The output becomes active on the rising clock edge immediately following the overflow event. For more information, see Figure 22-2. The value of the active and inactive states depends on the polarity bit, N1POL in the NCO1CON register. The PF mode is selected by setting the N1PFM bit in the NCO1CON register. 22.3.1 OUTPUT PULSE WIDTH CONTROL When operating in PF mode, the active state of the output can vary in width by multiple clock periods. Various pulse widths are selected with the N1PWS<2:0> bits in the NCO1CLK register. When the selected pulse width is greater than the Accumulator overflow time frame, then NCO1 output does not toggle. 22.4 N1EN bit of the NCO1CON register NCO1IE bit of the PIE7 register PEIE bit of the INTCON register GIE bit of the INTCON register 22.6 Effects of a Reset All of the NCO registers are cleared to zero as the result of a Reset. 22.7 Operation in Sleep The NCO module operates independently from the system clock and will continue to run during Sleep, provided that the clock source selected remains active. The HFINTOSC remains active during Sleep when the NCO module is enabled and the HFINTOSC is selected as the clock source, regardless of the system clock source selected. In other words, if the HFINTOSC is simultaneously selected as the system clock and the NCO clock source, when the NCO is enabled, the CPU will go idle during Sleep, but the NCO will continue to operate and the HFINTOSC will remain active. This will have a direct effect on the Sleep mode current. OUTPUT POLARITY CONTROL The last stage in the NCO module is the output polarity. The N1POL bit in the NCO1CON register selects the output polarity. Changing the polarity while the interrupts are enabled will cause an interrupt for the resulting output transition. The NCO output signal (NCO1_out) is available to the following peripherals: * * * * * CLC CWG Timer1 Timer2 CLKR 2017 Microchip Technology Inc. Preliminary DS40001897A-page 237 2017 Microchip Technology Inc. FIGURE 22-2: FDC OUTPUT MODE OPERATION DIAGRAM Rev. 10-000029A 11/7/2013 NCOx Clock Source NCOx Increment Value NCOx Accumulator Value 4000h 00000h 04000h 08000h 4000h FC000h 00000h 04000h 08000h 4000h FC000h 00000h 04000h 08000h Preliminary NCO_overflow NCO_interrupt DS40001897A-page 238 NCOx Output PF Mode NCOxPWS = 000 NCOx Output PF Mode NCOxPWS = 001 PIC16(L)F15313/23 NCOx Output FDC Mode PIC16(L)F15313/23 22.8 NCO Control Registers REGISTER 22-1: NCO1CON: NCO CONTROL REGISTER R/W-0/0 U-0 R-0/0 R/W-0/0 U-0 U-0 U-0 R/W-0/0 N1EN -- N1OUT N1POL -- -- -- N1PFM bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 N1EN: NCO1 Enable bit 1 = NCO1 module is enabled 0 = NCO1 module is disabled bit 6 Unimplemented: Read as `0' bit 5 N1OUT: NCO1 Output bit Displays the current output value of the NCO1 module. bit 4 N1POL: NCO1 Polarity bit 1 = NCO1 output signal is inverted 0 = NCO1 output signal is not inverted bit 3-1 Unimplemented: Read as `0' bit 0 N1PFM: NCO1 Pulse Frequency Mode bit 1 = NCO1 operates in Pulse Frequency mode 0 = NCO1 operates in Fixed Duty Cycle mode, divide by 2 2017 Microchip Technology Inc. Preliminary DS40001897A-page 239 PIC16(L)F15313/23 REGISTER 22-2: R/W-0/0 NCO1CLK: NCO1 INPUT CLOCK CONTROL REGISTER R/W-0/0 R/W-0/0 N1PWS<2:0>(1,2) U-0 R/W-0/0 -- R/W-0/0 R/W-0/0 R/W-0/0 N1CKS<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-5 N1PWS<2:0>: NCO1 Output Pulse Width Select bits(1) 111 = NCO1 output is active for 128 input clock periods 110 = NCO1 output is active for 64 input clock periods 101 = NCO1 output is active for 32 input clock periods 100 = NCO1 output is active for 16 input clock periods 011 = NCO1 output is active for 8 input clock periods 010 = NCO1 output is active for 4 input clock periods 001 = NCO1 output is active for 2 input clock periods 000 = NCO1 output is active for 1 input clock period bit 4 Unimplemented: Read as `0' bit 3-0 N1CKS<3:0>: NCO1 Clock Source Select bits 1011-1111 = Reserved 1010 = LC4_out 1001 = LC3_out 1000 = LC2_out 0111 = LC1_out 0110 = CLKR 0101 = Reserved 0100 = MFINTOSC (32 kHz) 0011 = MFINTOSC (500 kHz) 0010 = LFINTOSC 0001 = HFINTOSC 0000 = FOSC Note 1: N1PWS applies only when operating in Pulse Frequency mode. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 240 PIC16(L)F15313/23 REGISTER 22-3: R/W-0/0 NCO1ACCL: NCO1 ACCUMULATOR REGISTER - LOW BYTE R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 NCO1ACC<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 NCO1ACC<7:0>: NCO1 Accumulator, Low Byte REGISTER 22-4: R/W-0/0 NCO1ACCH: NCO1 ACCUMULATOR REGISTER - HIGH BYTE R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 NCO1ACC<15:8> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 NOC1ACC<15:8>: NCO1 Accumulator, High Byte NCO1ACCU: NCO1 ACCUMULATOR REGISTER - UPPER BYTE(1) REGISTER 22-5: U-0 U-0 U-0 U-0 -- -- -- -- R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 NCO1ACC<19:16> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-4 Unimplemented: Read as `0' bit 3-0 NCO1ACC<19:16>: NCO1 Accumulator, Upper Byte Note 1: The accumulator spans registers NCO1ACCU:NCO1ACCH: NCO1ACCL. The 24 bits are reserved but not all are used.This register updates in real-time, asynchronously to the CPU; there is no provision to guarantee atomic access to this 24-bit space using an 8-bit bus. Writing to this register while the module is operating will produce undefined results. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 241 PIC16(L)F15313/23 NCO1INCL: NCO1 INCREMENT REGISTER - LOW BYTE(1,2) REGISTER 22-6: R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-1/1 NCO1INC<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 Note 1: 2: NCO1INC<7:0>: NCO1 Increment, Low Byte The logical increment spans NCO1INCU:NCO1INCH:NCO1INCL. DDSINC is double-buffered as INCBUF; INCBUF is updated on the next falling edge of NCOCLK after writing to NCO1INCL; NCO1INCU and NCO1INCH should be written prior to writing NCO1INCL. NCO1INCH: NCO1 INCREMENT REGISTER - HIGH BYTE(1) REGISTER 22-7: R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 NCO1INC<15:8> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 Note 1: NCO1INC<15:8>: NCO1 Increment, High Byte The logical increment spans NCO1INCU:NCO1INCH:NCO1INCL. NCO1INCU: NCO1 INCREMENT REGISTER - UPPER BYTE(1) REGISTER 22-8: U-0 U-0 U-0 U-0 -- -- -- -- R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 NCO1INC<19:16> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-4 Unimplemented: Read as `0' bit 3-0 NCO1INC<19:16>: NCO1 Increment, Upper Byte Note 1: The logical increment spans NCO1INCU:NCO1INCH:NCO1INCL. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 242 PIC16(L)F15313/23 TABLE 22-1: Name INTCON PIR7 PIE7 NCO1CON SUMMARY OF REGISTERS ASSOCIATED WITH NCO Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page GIE PEIE INTEDG 121 -- -- NVMIF NCO1IF -- -- -- CWG1IF 137 -- -- NVMIE NCO1IE -- -- -- CWG1IE 129 N1EN N1OUT N1POL N1PFM 239 NCO1CLK N1PWS<2:0> N1CKS<3:0> 240 NCO1ACCL NCO1ACC<7:0> 241 NCO1ACCH NCO1ACC<15:8> 241 NCO1ACCU NCO1ACC<19:16> 241 NCO1INCL NCO1INC<7:0> 242 NCO1INCH NCO1INC<15:8> 242 NCO1INCU RxyPPS Legend: NCO1AINC<19:16> RxyPPS<4:0> 242 192 -- = unimplemented read as `0'. Shaded cells are not used for NCO module. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 243 PIC16(L)F15313/23 23.0 COMPARATOR MODULE FIGURE 23-1: Comparators are used to interface analog circuits to a digital circuit by comparing two analog voltages and providing a digital indication of their relative magnitudes. Comparators are very useful mixed signal building blocks because they provide analog functionality independent of program execution. The analog comparator module includes the following features: * * * * * VIN+ + VIN- - Output VINVIN+ Programmable input selection Selectable voltage reference Programmable output polarity Rising/falling output edge interrupts CWG1 Auto-shutdown source 23.1 SINGLE COMPARATOR Output Comparator Overview A single comparator is shown in Figure 23-1 along with the relationship between the analog input levels and the digital output. When the analog voltage at VIN+ is less than the analog voltage at VIN-, the output of the comparator is a digital low level. When the analog voltage at VIN+ is greater than the analog voltage at VIN-, the output of the comparator is a digital high level. Note: The black areas of the output of the comparator represents the uncertainty due to input offsets and response time. The comparators available are shown in Table 23-1. TABLE 23-1: AVAILABLE COMPARATORS Device C1 PIC16(L)F15313 PIC16(L)F15323 2017 Microchip Technology Inc. C2 Preliminary DS40001897A-page 244 PIC16(L)F15313/23 FIGURE 23-2: COMPARATOR MODULE SIMPLIFIED BLOCK DIAGRAM Rev. 10-000027K 11/20/2015 CxNCH<2:0> 3 CxON CxIN0- 000 CxIN1- 001 CxIN2- 010 CxIN3- 011 Reserved 100 Reserved 101 FVR_buffer2 110 (1) CxON(1) CxVN Interrupt Rising Edge CxINTP Interrupt Falling Edge CxINTN set bit CxIF - D CxOUT Q MCxOUT Cx CxVP 111 + Q1 CxSP CxHYS CxPOL CxOUT_sync CxIN0+ 000 CxIN1+ 001 CxSYNC Reserved 011 Reserved 100 DAC_output 101 FVR_buffer2 110 TRIS bit 0 PPS 010 Reserved to peripherals D (From Timer1 Module) T1CLK Q CxOUT 1 RxyPPS 111 CxPCH<2:0> Note 1: 2 CxON(1) When CxON = 0, all multiplexer inputs are disconnected and the Comparator will produce a `0' at the output. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 245 PIC16(L)F15313/23 23.2 23.2.3 Comparator Control Each comparator has two control registers: CMxCON0 and CMxCON1. The CMxCON0 register (see Register 23-1) contains Control and Status bits for the following: * * * * * Enable Output Output polarity Hysteresis enable Timer1 output synchronization Inverting the output of the comparator is functionally equivalent to swapping the comparator inputs. The polarity of the comparator output can be inverted by setting the CxPOL bit of the CMxCON0 register. Clearing the CxPOL bit results in a non-inverted output. Table 23-2 shows the output state versus input conditions, including polarity control. TABLE 23-2: The CMxCON1 register (see Register 23-2) contains Control bits for the following: * Interrupt on positive/negative edge enables * The CMxNSEL and CMxPSEL (Register 23-3 and Register 23-4) contain control bits for the following: - Positive input channel selection - Negative input channel selection 23.2.1 COMPARATOR OUTPUT POLARITY COMPARATOR OUTPUT STATE VS. INPUT CONDITIONS Input Condition CxPOL CxOUT CxVN > CxVP 0 0 CxVN < CxVP 0 1 CxVN > CxVP 1 1 CxVN < CxVP 1 0 COMPARATOR ENABLE Setting the CxON bit of the CMxCON0 register enables the comparator for operation. Clearing the CxON bit disables the comparator resulting in minimum current consumption. 23.2.2 COMPARATOR OUTPUT The output of the comparator can be monitored by reading either the CxOUT bit of the CMxCON0 register or the MCxOUT bit of the CMOUT register. The comparator output can also be routed to an external pin through the RxyPPS register (Register 15-2). The corresponding TRIS bit must be clear to enable the pin as an output. Note 1: The internal output of the comparator is latched with each instruction cycle. Unless otherwise specified, external outputs are not latched. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 246 PIC16(L)F15313/23 23.3 Comparator Hysteresis A selectable amount of separation voltage can be added to the input pins of each comparator to provide a hysteresis function to the overall operation. Hysteresis is enabled by setting the CxHYS bit of the CMxCON0 register. The associated interrupt flag bit, CxIF bit of the PIR2 register, must be cleared in software. If another edge is detected while this flag is being cleared, the flag will still be set at the end of the sequence. Note: See Comparator Specifications in Table 37-14 for more information. 23.4 Timer1 Gate Operation The output resulting from a comparator operation can be used as a source for gate control of Timer1. See Section 26.5 "Timer Gate" for more information. This feature is useful for timing the duration or interval of an analog event. It is recommended that the comparator output be synchronized to Timer1. This ensures that Timer1 does not increment while a change in the comparator is occurring. 23.4.1 COMPARATOR OUTPUT SYNCHRONIZATION 23.6 Although a comparator is disabled, an interrupt can be generated by changing the output polarity with the CxPOL bit of the CMxCON0 register, or by switching the comparator on or off with the CxON bit of the CMxCON0 register. Comparator Positive Input Selection Configuring the CxPCH<2:0> bits of the CMxPSEL register directs an internal voltage reference or an analog pin to the noninverting input of the comparator: * * * * CxIN0+ analog pin DAC output FVR (Fixed Voltage Reference) VSS (Ground) The output from a comparator can be synchronized with Timer1 by setting the CxSYNC bit of the CMxCON0 register. See Section 18.0 "Fixed Voltage Reference (FVR)" for more information on the Fixed Voltage Reference module. Once enabled, the comparator output is latched on the falling edge of the Timer1 source clock. If a prescaler is used with Timer1, the comparator output is latched after the prescaling function. To prevent a race condition, the comparator output is latched on the falling edge of the Timer1 clock source and Timer1 increments on the rising edge of its clock source. See the Comparator Block Diagram (Figure 23-2) and the Timer1 Block Diagram (Figure 26-1) for more information. See Section 21.0 "5-Bit Digital-to-Analog Converter (DAC1) Module" for more information on the DAC input signal. 23.5 Comparator Interrupt An interrupt can be generated upon a change in the output value of the comparator for each comparator, a rising edge detector and a falling edge detector are present. When either edge detector is triggered and its associated enable bit is set (CxINTP and/or CxINTN bits of the CMxCON1 register), the Corresponding Interrupt Flag bit (CxIF bit of the PIR2 register) will be set. Any time the comparator is disabled (CxON = 0), all comparator inputs are disabled. 23.7 The CxNCH<2:0> bits of the CMxCON1 register direct an analog input pin and internal reference voltage or analog ground to the inverting input of the comparator: * CxIN- pin * FVR (Fixed Voltage Reference) * Analog Ground Note: To enable the interrupt, you must set the following bits: * CxON, CxPOL and CxSP bits of the CMxCON0 register * CxIE bit of the PIE2 register * CxINTP bit of the CMxCON1 register (for a rising edge detection) * CxINTN bit of the CMxCON1 register (for a falling edge detection) * PEIE and GIE bits of the INTCON register 2017 Microchip Technology Inc. Comparator Negative Input Selection Preliminary To use CxINy+ and CxINy- pins as analog input, the appropriate bits must be set in the ANSEL register and the corresponding TRIS bits must also be set to disable the output drivers. DS40001897A-page 247 PIC16(L)F15313/23 23.8 Comparator Response Time 23.9 The comparator output is indeterminate for a period of time after the change of an input source or the selection of a new reference voltage. This period is referred to as the response time. The response time of the comparator differs from the settling time of the voltage reference. Therefore, both of these times must be considered when determining the total response time to a comparator input change. See the Comparator and Voltage Reference Specifications in Table 37-14 for more details. Analog Input Connection Considerations A simplified circuit for an analog input is shown in Figure 23-3. Since the analog input pins share their connection with a digital input, they have reverse biased ESD protection diodes to VDD and VSS. The analog input, therefore, must be between VSS and VDD. If the input voltage deviates from this range by more than 0.6V in either direction, one of the diodes is forward biased and a latch-up may occur. A maximum source impedance of 10 k is recommended for the analog sources. Also, any external component connected to an analog input pin, such as a capacitor or a Zener diode, should have very little leakage current to minimize inaccuracies introduced. Note 1: When reading a PORT register, all pins configured as analog inputs will read as a `0'. Pins configured as digital inputs will convert as an analog input, according to the input specification. 2: Analog levels on any pin defined as a digital input, may cause the input buffer to consume more current than is specified. FIGURE 23-3: ANALOG INPUT MODEL VDD Rs < 10K Analog Input pin VT 0.6V RIC To Comparator VA CPIN 5 pF VT 0.6V ILEAKAGE(1) Vss Legend: CPIN = Input Capacitance ILEAKAGE = Leakage Current at the pin due to various junctions RIC = Interconnect Resistance = Source Impedance RS = Analog Voltage VA VT = Threshold Voltage Note 1: See I/O Ports in Table 37-4. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 248 PIC16(L)F15313/23 23.10 CWG1 Auto-shutdown Source The output of the comparator module can be used as an auto-shutdown source for the CWG1 module. When the output of the comparator is active and the corresponding ASxE is enabled, the CWG operation will be suspended immediately (see Section 30.10 "Auto-Shutdown"). 23.11 Operation in Sleep Mode The comparator module can operate during Sleep. The comparator clock source is based on the Timer1 clock source. If the Timer1 clock source is either the system clock (FOSC) or the instruction clock (FOSC/4), Timer1 will not operate during Sleep, and synchronized comparator outputs will not operate. A comparator interrupt will wake the device from Sleep. The CxIE bits of the PIE2 register must be set to enable comparator interrupts. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 249 PIC16(L)F15313/23 23.12 Register Definitions: Comparator Control REGISTER 23-1: CMxCON0: COMPARATOR Cx CONTROL REGISTER 0 R/W-0/0 R-0/0 U-0 R/W-0/0 U-0 U-0 R/W-0/0 R/W-0/0 ON OUT -- POL -- -- HYS SYNC bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 ON: Comparator Enable bit 1 = Comparator is enabled 0 = Comparator is disabled and consumes no active power bit 6 OUT: Comparator Output bit If CxPOL = 1 (inverted polarity): 1 = CxVP < CxVN 0 = CxVP > CxVN If CxPOL = 0 (noninverted polarity): 1 = CxVP > CxVN 0 = CxVP < CxVN bit 5 Unimplemented: Read as `0' bit 4 POL: Comparator Output Polarity Select bit 1 = Comparator output is inverted 0 = Comparator output is not inverted bit 3-2 Unimplemented: Read as `0' bit 1 HYS: Comparator Hysteresis Enable bit 1 = Comparator hysteresis enabled 0 = Comparator hysteresis disabled bit 0 SYNC: Comparator Output Synchronous Mode bit 1 = Comparator output to Timer1 and I/O pin is synchronous to changes on Timer1 clock source. Output updated on the falling edge of Timer1 clock source. 0 = Comparator output to Timer1 and I/O pin is asynchronous 2017 Microchip Technology Inc. Preliminary DS40001897A-page 250 PIC16(L)F15313/23 REGISTER 23-2: CMxCON1: COMPARATOR Cx CONTROL REGISTER 1 U-0 U-0 U-0 U-0 U-0 U-0 R/W-0/0 R/W-0/0 -- -- -- -- -- -- INTP INTN bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-2 Unimplemented: Read as `0' bit 1 INTP: Comparator Interrupt on Positive-Going Edge Enable bits 1 = The CxIF interrupt flag will be set upon a positive-going edge of the CxOUT bit 0 = No interrupt flag will be set on a positive-going edge of the CxOUT bit bit 0 INTN: Comparator Interrupt on Negative-Going Edge Enable bits 1 = The CxIF interrupt flag will be set upon a negative-going edge of the CxOUT bit 0 = No interrupt flag will be set on a negative-going edge of the CxOUT bit 2017 Microchip Technology Inc. Preliminary DS40001897A-page 251 PIC16(L)F15313/23 REGISTER 23-3: CMxNSEL: COMPARATOR Cx NEGATIVE INPUT SELECT REGISTER U-0 U-0 U-0 U-0 U-0 -- -- -- -- -- R/W-0/0 R/W-0/0 R/W-0/0 NCH<2:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-3 Unimplemented: Read as `0' bit 2-0 NCH<2:0>: Comparator Negative Input Channel Select bits 111 = CxVN connects to AVSS 110 = CxVN connects to FVR Buffer 2 101 = CxVN unconnected 100 = CxVN unconnected 011 = CxVN connects to CxIN3- pin 010 = CxVN connects to CxIN2- pin 001 = CxVN connects to CxIN1- pin 000 = CxVN connects to CxIN0- pin REGISTER 23-4: CMxPSEL: COMPARATOR Cx POSITIVE INPUT SELECT REGISTER U-0 U-0 U-0 U-0 U-0 -- -- -- -- -- R/W-0/0 R/W-0/0 R/W-0/0 PCH<2:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-3 Unimplemented: Read as `0' bit 2-0 PCH<2:0>: Comparator Positive Input Channel Select bits 111 = CxVP connects to AVSS 110 = CxVP connects to FVR Buffer 2 101 = CxVP connects to DAC output 100 = CxVP unconnected 011 = CxVP unconnected 010 = CxVP unconnected 001 = CxVP connects to CxIN1+ pin 000 = CxVP connects to CxIN0+ pin 2017 Microchip Technology Inc. Preliminary DS40001897A-page 252 PIC16(L)F15313/23 REGISTER 23-5: CMOUT: COMPARATOR OUTPUT REGISTER U-0 U-0 U-0 U-0 U-0 U-0 R-0/0 R-0/0 -- -- -- -- -- -- MC2OUT MC1OUT bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-2 Unimplemented: Read as `0' bit 1 MC2OUT: Mirror Copy of C2OUT bit bit 0 MC1OUT: Mirror Copy of C1OUT bit TABLE 23-3: Name SUMMARY OF REGISTERS ASSOCIATED WITH COMPARATOR MODULE Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page CMxCON0 ON OUT -- POL -- -- HYS SYNC 250 CMxCON1 -- -- -- -- -- -- INTP INTN 251 CMOUT -- -- -- -- -- -- MC2OUT MC1OUT 253 FVRCON FVREN FVRRDY TSEN TSRNG CDAFVR<1:0> DAC1CON0 DAC1EN -- DAC1OE1 DAC1OE2 DAC1PSS<1:0> DAC1CON1 -- -- -- INTCON ADFVR<1:0> -- DAC1NSS DAC1R<4:0> 210 232 232 GIE PEIE -- PIE2 -- ZCDIE -- -- -- PIR2 -- ZCDIF -- -- -- RxyPPS CLCINxPPS -- -- CLCIN0PPS<5:0> 191 T1GPPS<5:0> 191 T1GPPS Legend: INTEDG 121 -- C2IE C1IE 124 -- C2IF C1IF 132 RxyPPS<4:0> 192 -- = unimplemented location, read as `0'. Shaded cells are unused by the comparator module. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 253 PIC16(L)F15313/23 24.0 ZERO-CROSS DETECTION (ZCD) MODULE 24.1 The ZCD module detects when an A/C signal crosses through the ground potential. The actual zero crossing threshold is the zero crossing reference voltage, VCPINV, which is typically 0.75V above ground. The connection to the signal to be detected is through a series current limiting resistor. The module applies a current source or sink to the ZCD pin to maintain a constant voltage on the pin, thereby preventing the pin voltage from forward biasing the ESD protection diodes. When the applied voltage is greater than the reference voltage, the module sinks current. When the applied voltage is less than the reference voltage, the module sources current. The current source and sink action keeps the pin voltage constant over the full range of the applied voltage. The ZCD module is shown in the simplified block diagram Figure 24-2. The ZCD module is useful when monitoring an A/C waveform for, but not limited to, the following purposes: * * * * A/C period measurement Accurate long term time measurement Dimmer phase delayed drive Low EMI cycle switching 2017 Microchip Technology Inc. External Resistor Selection The ZCD module requires a current limiting resistor in series with the external voltage source. The impedance and rating of this resistor depends on the external source peak voltage. Select a resistor value that will drop all of the peak voltage when the current through the resistor is nominally 300 A. Refer to Equation 24-1 and Figure 24-1. Make sure that the ZCD I/O pin internal weak pull-up is disabled so it does not interfere with the current source and sink. EQUATION 24-1: EXTERNAL RESISTOR V PEAK R SERIES = ----------------4 3 10 FIGURE 24-1: VPEAK EXTERNAL VOLTAGE VMAXPEAK VMINPEAK VCPINV Preliminary DS40001897A-page 254 PIC16(L)F15313/23 FIGURE 24-2: SIMPLIFIED ZCD BLOCK DIAGRAM VPULLUP Rev. 10-000194D 6/10/2016 optional VDD RPULLUP - Zcpinv ZCDxIN RSERIES RPULLDOWN + External voltage source optional ZCD Output for other modules ZCDxPOL ZCDxOUT pin Interrupt det ZCDxINTP ZCDxINTN Set ZCDxIF flag Interrupt det 2017 Microchip Technology Inc. Preliminary DS40001897A-page 255 PIC16(L)F15313/23 24.2 ZCD Logic Output 24.5 Correcting for VCPINV offset The ZCD module includes a Status bit, which can be read to determine whether the current source or sink is active. The OUT bit of the ZCDxCON register is set when the current sink is active, and cleared when the current source is active. The OUT bit is affected by the polarity even if the module is disabled. The actual voltage at which the ZCD switches is the reference voltage at the noninverting input of the ZCD op amp. For external voltage source waveforms other than square waves, this voltage offset from zero causes the zero-cross event to occur either too early or too late. 24.3 24.5.1 ZCD Logic Polarity The POL bit of the ZCDxCON register inverts the ZCDxOUT bit relative to the current source and sink output. When the POL bit is set, a OUT high indicates that the current source is active, and a low output indicates that the current sink is active. The POL bit affects the ZCD interrupts. See Section 24.4 "ZCD Interrupts". 24.4 ZCD Interrupts An interrupt will be generated upon a change in the ZCD logic output when the appropriate interrupt enables are set. A rising edge detector and a falling edge detector are present in the ZCD for this purpose. The ZCDIF bit of the PIR2 register will be set when either edge detector is triggered and its associated enable bit is set. The INTP enables rising edge interrupts and the INTN bit enables falling edge interrupts. Both are located in the ZCDxCON register. CORRECTION BY AC COUPLING When the external voltage source is sinusoidal then the effects of the VCPINV offset can be eliminated by isolating the external voltage source from the ZCD pin with a capacitor in addition to the voltage reducing resistor. The capacitor will cause a phase shift resulting in the ZCD output switch in advance of the actual zero crossing event. The phase shift will be the same for both rising and falling zero crossings, which can be compensated for by either delaying the CPU response to the ZCD switch by a timer or other means, or selecting a capacitor value large enough that the phase shift is negligible. To determine the series resistor and capacitor values for this configuration, start by computing the impedance, Z, to obtain a peak current of 300 uA. Next, arbitrarily select a suitably large non-polar capacitor and compute its reactance, Xc, at the external voltage source frequency. Finally, compute the series resistor, capacitor peak voltage, and phase shift by the formulas shown in Equation 24-2. To fully enable the interrupt, the following bits must be set: EQUATION 24-2: * ZCDIE bit of the PIE2 register * INTP bit of the ZCDxCON register (for a rising edge detection) * INTN bit of the ZCDxCON register (for a falling edge detection) * PEIE and GIE bits of the INTCON register R-C CALCULATIONS VPEAK = external voltage source peak voltage f = external voltage source frequency C = series capacitor R = series resistor Changing the POL bit can cause an interrupt, regardless of the level of the EN bit. The ZCDIF bit of the PIR2 register must be cleared in software as part of the interrupt service. If another edge is detected while this flag is being cleared, the flag will still be set at the end of the sequence. VC = Peak capacitor voltage = Capacitor induced zero crossing phase advance in radians T = Time ZC event occurs before actual zero crossing Z = VPEAK/3x10-4 Xc = 1/(2fC) R = (Z2 - Xc2) VC = Xc(3x10-4) = Tan-1(Xc/R) T = /(2f) 2017 Microchip Technology Inc. Preliminary DS40001897A-page 256 PIC16(L)F15313/23 EXAMPLE 24-1: VRMS = 120 VPEAK =VRMS* f = 60 Hz C = 0.1 uF Z = VPEAK/3x10-4 = 169.7/(3x10-4) = 565.7 kOhms Xc = 1/(2fC) = 1/(2*60*1*10-7) = 26.53 kOhms R = (Z2 - Xc2) = 565.1 kOhms (computed) R = 560 kOhms (used) This offset time can be compensated for by adding a pull-up or pull-down biasing resistor to the ZCD pin. A pull-up resistor is used when the external voltage source is varying relative to VSS. A pull-down resistor is used when the voltage is varying relative to VDD. The resistor adds a bias to the ZCD pin so that the target external voltage source must go to zero to pull the pin voltage to the VCPINV switching voltage. The pull-up or pull-down value can be determined with the equation shown in Equation 24-4. EQUATION 24-4: ZCD PULL-UP/DOWN ZR = (R2 + Xc2) = 560.6 kOhms (using actual resistor) IPEAK = VPEAK/ ZR = 302.7*10-6 When External Signal is relative to Vss: VC = Xc* IPEAK = 8.0 V R SERIES V PULLUP - V cpinv R PULLUP = -----------------------------------------------------------------------V cpinv = Tan-1(Xc/R) = 0.047 radians T = /(2f) = 125.6 us When External Signal is relative to VDD: 24.5.2 * SERIES Vcpinv R PULLDOWN = R ------------------------------------------------- V DD - Vcpinv CORRECTION BY OFFSET CURRENT When the waveform is varying relative to VSS, then the zero cross is detected too early as the waveform falls and too late as the waveform rises. When the waveform is varying relative to VDD, then the zero cross is detected too late as the waveform rises and too early as the waveform falls. The actual offset time can be determined for sinusoidal waveforms with the corresponding equations shown in Equation 24-3. EQUATION 24-3: ZCD EVENT OFFSET When External Voltage Source is relative to Vss: T OFFSET Vcpinv asin ------------------ V PEAK = ---------------------------------2 Freq 24.6 Handling VPEAK variations If the peak amplitude of the external voltage is expected to vary, the series resistor must be selected to keep the ZCD current source and sink below the design maximum range of 600 A and above a reasonable minimum range. A general rule of thumb is that the maximum peak voltage can be no more than six times the minimum peak voltage. To ensure that the maximum current does not exceed 600 A and the minimum is at least 100 A, compute the series resistance as shown in Equation 24-5. The compensating pull-up for this series resistance can be determined with Equation 24-4 because the pull-up value is not dependent from the peak voltage. When External Voltage Source is relative to VDD: EQUATION 24-5: T OFFSET V DD - Vcpinv asin -------------------------------- V PEAK = ------------------------------------------------2 Freq 2017 Microchip Technology Inc. Preliminary SERIES R FOR V RANGE V MAXPEAK + V MINPEAK R SERIES = ---------------------------------------------------------4 7 10 DS40001897A-page 257 PIC16(L)F15313/23 24.7 Operation During Sleep The ZCD current sources and interrupts are unaffected by Sleep. 24.8 Effects of a Reset The ZCD circuit can be configured to default to the active or inactive state on Power-on-Reset (POR). When the ZCDDIS Configuration bit is cleared, the ZCD circuit will be active at POR. When the ZCD Configuration bit is set, the EN bit of the ZCDxCON register must be set to enable the ZCD module. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 258 PIC16(L)F15313/23 24.9 Register Definitions: ZCD Control REGISTER 24-1: ZCDCON: ZERO-CROSS DETECTION CONTROL REGISTER R/W-q/q U-0 R-x/x R/W-0/0 U-0 U-0 R/W-0/0 R/W-0/0 SEN -- OUT POL -- -- INTP INTN bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = value depends on Configuration bits bit 7 SEN: Zero-Cross Detection Enable bit 1 = Zero-cross detect is enabled. ZCD pin is forced to output to source and sink current. 0 = Zero-cross detect is disabled. ZCD pin operates according to PPS and TRIS controls. bit 6 Unimplemented: Read as `0' bit 5 OUT: Zero-Cross Detection Logic Level bit POL bit = 1: 1 = ZCD pin is sourcing current 0 = ZCD pin is sinking current POL bit = 0: 1 = ZCD pin is sinking current 0 = ZCD pin is sourcing current bit 4 POL: Zero-Cross Detection Logic Output Polarity bit 1 = ZCD logic output is inverted 0 = ZCD logic output is not inverted bit 3-2 Unimplemented: Read as `0' bit 1 INTP: Zero-Cross Positive Edge Interrupt Enable bit 1 = ZCDIF bit is set on low-to-high ZCDx_output transition 0 = ZCDIF bit is unaffected by low-to-high ZCDx_output transition bit 0 INTN: Zero-Cross Negative Edge Interrupt Enable bit 1 = ZCDIF bit is set on high-to-low ZCDx_output transition 0 = ZCDIF bit is unaffected by high-to-low ZCDx_output transition TABLE 24-1: SUMMARY OF REGISTERS ASSOCIATED WITH THE ZCD MODULE Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on page -- -- RC1IE TX1IE -- -- BCL1IE SSP1IE 125 PIR3 -- -- RC1IF TX1IF -- -- BCL1IF SSP1IF 133 ZCDxCON EN -- OUT POL -- -- INTP INTN 259 Name PIE3 Legend: -- = unimplemented, read as `0'. Shaded cells are unused by the ZCD module. TABLE 24-2: Name CONFIG2 Legend: SUMMARY OF CONFIGURATION WORD WITH THE ZCD MODULE Bits Bit -/7 Bit -/6 Bit 13/5 Bit 12/4 Bit 11/3 Bit 10/2 Bit 9/1 Bit 8/0 13:8 -- -- DEBUG STVREN PPS1WAY ZCDDIS BORV -- 7:0 BOREN <1:0> LPBOREN -- -- -- PWRTE MCLRE Register on Page 77 -- = unimplemented location, read as `0'. Shaded cells are not used by the ZCD module. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 259 PIC16(L)F15313/23 25.0 TIMER0 MODULE The Timer0 module is an 8/16-bit timer/counter with the following features: * * * * * * * * * 16-bit timer/counter 8-bit timer/counter with programmable period Synchronous or asynchronous operation Selectable clock sources Programmable prescaler (independent of Watchdog Timer) Programmable postscaler Operation during Sleep mode Interrupt on match or overflow Output on I/O pin (via PPS) or to other peripherals 25.1 Timer0 Operation Timer0 can operate as either an 8-bit timer/counter or a 16-bit timer/counter. The mode is selected with the T016BIT bit of the T0CON register. 25.1.1 16-BIT MODE In normal operation, TMR0 increments on the rising edge of the clock source. A 15-bit prescaler on the clock input gives several prescale options (see prescaler control bits, T0CKPS<3:0> in the T0CON1 register). 25.1.1.1 Timer0 Reads and Writes in 16-Bit Mode TMR0H is not the actual high byte of Timer0 in 16-bit mode. It is actually a buffered version of the real high byte of Timer0, which is neither directly readable nor writable (see Figure 25-1). TMR0H is updated with the contents of the high byte of Timer0 during a read of TMR0L. This provides the ability to read all 16 bits of Timer0 without having to verify that the read of the high and low byte was valid, due to a rollover between successive reads of the high and low byte. Similarly, a write to the high byte of Timer0 must also take place through the TMR0H Buffer register. The high byte is updated with the contents of TMR0H when a write occurs to TMR0L. This allows all 16 bits of Timer0 to be updated at once. 25.1.2 8-BIT MODE In normal operation, TMR0 increments on the rising edge of the clock source. A 15-bit prescaler on the clock input gives several prescale options (see prescaler control bits, T0CKPS<3:0> in the T0CON1 register). 2017 Microchip Technology Inc. The value of TMR0L is compared to that of the Period buffer, a copy of TMR0H, on each clock cycle. When the two values match, the following events happen: * TMR0_out goes high for one prescaled clock period * TMR0L is reset * The contents of TMR0H are copied to the period buffer In 8-bit mode, the TMR0L and TMR0H registers are both directly readable and writable. The TMR0L register is cleared on any device Reset, while the TMR0H register initializes at FFh. Both the prescaler and postscaler counters are cleared on the following events: * A write to the TMR0L register * A write to either the T0CON0 or T0CON1 registers * Any device Reset - Power-on Reset (POR), MCLR Reset, Watchdog Timer Reset (WDTR) or * Brown-out Reset (BOR) 25.1.3 COUNTER MODE In Counter mode, the prescaler is normally disabled by setting the T0CKPS bits of the T0CON1 register to `0000'. Each rising edge of the clock input (or the output of the prescaler if the prescaler is used) increments the counter by `1'. 25.1.4 TIMER MODE In Timer mode, the Timer0 module will increment every instruction cycle as long as there is a valid clock signal and the T0CKPS bits of the T0CON1 register (Register 25-2) are set to `0000'. When a prescaler is added, the timer will increment at the rate based on the prescaler value. 25.1.5 ASYNCHRONOUS MODE When the T0ASYNC bit of the T0CON1 register is set (T0ASYNC = `1'), the counter increments with each rising edge of the input source (or output of the prescaler, if used). Asynchronous mode allows the counter to continue operation during Sleep mode provided that the clock also continues to operate during Sleep. 25.1.6 SYNCHRONOUS MODE When the T0ASYNC bit of the T0CON1 register is clear (T0ASYNC = 0), the counter clock is synchronized to the system oscillator (FOSC/4). When operating in Synchronous mode, the counter clock frequency cannot exceed FOSC/4. Preliminary DS40001897A-page 260 PIC16(L)F15313/23 25.2 Clock Source Selection 25.5 The T0CS<2:0> bits of the T0CON1 register are used to select the clock source for Timer0. Register 25-2 displays the clock source selections. 25.2.1 INTERNAL CLOCK SOURCE When the internal clock source is selected, Timer0 operates as a timer and will increment on multiples of the clock source, as determined by the Timer0 prescaler. 25.2.2 EXTERNAL CLOCK SOURCE When an external clock source is selected, Timer0 can operate as either a timer or a counter. Timer0 will increment on multiples of the rising edge of the external clock source, as determined by the Timer0 prescaler. 25.3 Programmable Prescaler A software programmable prescaler is available for exclusive use with Timer0. There are 16 prescaler options for Timer0 ranging in powers of two from 1:1 to 1:32768. The prescaler values are selected using the T0CKPS<3:0> bits of the T0CON1 register. The prescaler is not directly readable or writable. Clearing the prescaler register can be done by writing to the TMR0L register or the T0CON1 register. 25.4 Programmable Postscaler A software programmable postscaler (output divider) is available for exclusive use with Timer0. There are 16 postscaler options for Timer0 ranging from 1:1 to 1:16. The postscaler values are selected using the T0OUTPS<3:0> bits of the T0CON0 register. The postscaler is not directly readable or writable. Clearing the postscaler register can be done by writing to the TMR0L register or the T0CON0 register. In the 16-bit mode, if the postscaler option is selected to a ratio other than 1:1, the reload of the TMR0H and TMR0L registers is not possible inside the Interrupt Service Routine. The timer period must be calculated with the prescaler and postscaler factors selected. 2017 Microchip Technology Inc. Operation during Sleep When operating synchronously, Timer0 will halt. When operating asynchronously, Timer0 will continue to increment and wake the device from Sleep (if Timer0 interrupts are enabled) provided that the input clock source is active. 25.6 Timer0 Interrupts The Timer0 interrupt flag bit (TMR0IF) is set when either of the following conditions occur: * 8-bit TMR0L matches the TMR0H value * 16-bit TMR0 rolls over from `FFFFh' When the postscaler bits (T0OUTPS<3:0>) are set to 1:1 operation (no division), the T0IF flag bit will be set with every TMR0 match or rollover. In general, the TMR0IF flag bit will be set every T0OUTPS +1 matches or rollovers. If Timer0 interrupts are enabled (TMR0IE bit of the PIE0 register = 1), the CPU will be interrupted and the device may wake from sleep (see Section 25.2 "Clock Source Selection" for more details). 25.7 Timer0 Output The Timer0 output can be routed to any I/O pin via the RxyPPS output selection register (see Section 15.0 "Peripheral Pin Select (PPS) Module" for additional information). The Timer0 output can also be used by other peripherals, such as the Auto-conversion Trigger of the Analog-to-Digital Converter. Finally, the Timer0 output can be monitored through software via the Timer0 output bit (T0OUT) of the T0CON0 register (Register 25-1). TMR0_out will be one postscaled clock period when a match occurs between TMR0L and TMR0H in 8-bit mode, or when TMR0 rolls over in 16-bit mode. The Timer0 output is a 50% duty cycle that toggles on each TMR0_out rising clock edge. Preliminary DS40001897A-page 261 PIC16(L)F15313/23 FIGURE 25-1: BLOCK DIAGRAM OF TIMER0 Rev. 10-000017G 4/6/2017 CLC1 111 Reserved 110 MFINTOSC 101 LFINTOSC 100 HFINTOSC 011 FOSC/4 010 PPS 001 T0CKPS<3:0> Peripherals TMR0 body T0OUTPS<3:0> T0IF 1 Prescaler SYNC 0 IN OUT TMR0 FOSC/4 T016BIT T0ASYNC 000 T0_out Postscaler Q D T0CKIPPS PPS RxyPPS CK Q 3 T0CS<2:0> 16-bit TMR0 Body Diagram (T016BIT = 1) 8-bit TMR0 Body Diagram (T016BIT = 0) IN TMR0L R Clear IN TMR0L TMR0 High Byte OUT 8 Read TMR0L COMPARATOR OUT Write TMR0L T0_match 8 8 TMR0H TMR0 High Byte Latch Enable 8 TMR0H 8 Internal Data Bus 2017 Microchip Technology Inc. Preliminary DS40001897A-page 262 PIC16(L)F15313/23 REGISTER 25-1: T0CON0: TIMER0 CONTROL REGISTER 0 R/W-0/0 U-0 R-0 R/W-0/0 T0EN -- T0OUT T016BIT R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 T0OUTPS<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 T0EN: Timer0 Enable bit 1 = The module is enabled and operating 0 = The module is disabled and in the lowest power mode bit 6 Unimplemented: Read as `0' bit 5 T0OUT: Timer0 Output bit (read-only) Timer0 output bit bit 4 T016BIT: Timer0 Operating as 16-bit Timer Select bit 1 = Timer0 is a 16-bit timer 0 = Timer0 is an 8-bit timer bit 3-0 T0OUTPS<3:0>: Timer0 output postscaler (divider) select bits 1111 = 1:16 Postscaler 1110 = 1:15 Postscaler 1101 = 1:14 Postscaler 1100 = 1:13 Postscaler 1011 = 1:12 Postscaler 1010 = 1:11 Postscaler 1001 = 1:10 Postscaler 1000 = 1:9 Postscaler 0111 = 1:8 Postscaler 0110 = 1:7 Postscaler 0101 = 1:6 Postscaler 0100 = 1:5 Postscaler 0011 = 1:4 Postscaler 0010 = 1:3 Postscaler 0001 = 1:2 Postscaler 0000 = 1:1 Postscaler 2017 Microchip Technology Inc. Preliminary DS40001897A-page 263 PIC16(L)F15313/23 REGISTER 25-2: R/W-0/0 T0CON1: TIMER0 CONTROL REGISTER 1 R/W-0/0 T0CS<2:0> R/W-0/0 R/W-0/0 R/W-0/0 T0ASYNC R/W-0/0 R/W-0/0 R/W-0/0 T0CKPS<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-5 T0CS<2:0>: Timer0 Clock Source select bits 111 = LC1_out 110 = Reserved 101 = MFINTOSC (500 kHz) 100 = LFINTOSC 011 = HFINTOSC 010 = FOSC/4 001 = T0CKIPPS (Inverted) 000 = T0CKIPPS (True) bit 4 T0ASYNC: TMR0 Input Asynchronization Enable bit 1 = The input to the TMR0 counter is not synchronized to system clocks 0 = The input to the TMR0 counter is synchronized to FOSC/4 bit 3-0 T0CKPS<3:0>: Prescaler Rate Select bit 1111 = 1:32768 1110 = 1:16384 1101 = 1:8192 1100 = 1:4096 1011 = 1:2048 1010 = 1:1024 1001 = 1:512 1000 = 1:256 0111 = 1:128 0110 = 1:64 0101 = 1:32 0100 = 1:16 0011 = 1:8 0010 = 1:4 0001 = 1:2 0000 = 1:1 2017 Microchip Technology Inc. Preliminary DS40001897A-page 264 PIC16(L)F15313/23 TABLE 25-1: Name SUMMARY OF REGISTERS ASSOCIATED WITH TIMER0 Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page TMR0L Holding Register for the Least Significant Byte of the 16-bit TMR0 Register 260* TMR0H Holding Register for the Most Significant Byte of the 16-bit TMR0 Register 260* T0CON0 T0EN T0CON1 T0OUT T0CS<2:0> T016BIT T0ASYNC T0OUTPS<3:0> 263 T0CKPS<3:0> 264 T0CKIPPS T0CKIPPS<5:0> 191 TMR0PPS TMR0PPS<5:0> 191 T1GCON GE GPOL GTM GSPM GGO/DONE GVAL -- -- 275 INTCON GIE PEIE INTEDG 121 PIR0 TMR0IF IOCIF INTF 130 PIE0 TMR0IE IOCIE INTE 122 Legend: * -- = Unimplemented location, read as `0'. Shaded cells are not used by the Timer0 module. Page with Register information. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 265 PIC16(L)F15313/23 26.0 * Wake-up on overflow (external clock, Asynchronous mode only) * Time base for the Capture/Compare function * Auto-conversion Trigger (with CCP) * Selectable Gate Source Polarity * Gate Toggle mode * Gate Single-Pulse mode * Gate Value Status * Gate Event Interrupt TIMER1 MODULE WITH GATE CONTROL The Timer1 module is 16-bit timer/counters with the following features: * * * * 16-bit timer/counter register pair (TMR1H:TMR1L) Programmable internal or external clock source 2-bit prescaler Clock source for optional comparator synchronization * Multiple Timer1 gate (count enable) sources * Interrupt on overflow FIGURE 26-1: Figure 26-1 is a block diagram of the Timer1 module. This device has one instance of Timer1 type modules. TIMER1 BLOCK DIAGRAM TMRxGATE<4:0> Rev. 10-000018J 8/15/2016 4 TxGPPS TxGSPM 00000 PPS 1 0 NOTE (5) Single Pulse Acq. Control 1 11111 D D 0 Q TxGVAL Q1 Q TxGGO/DONE TxGPOL CK Q Interrupt TMRxON R set bit TMRxGIF det TxGTM TMRxGE set flag bit TMRxIF TMRxON EN To Comparators (6) (2) Tx_overflow TMRx TMRxH TMRxL Q Synchronized Clock Input 0 D 1 TxCLK TxSYNC TMRxCLK<3:0> 4 TxCKIPPS (1) 0000 PPS Note Prescaler 1,2,4,8 (4) 1111 det 2 TxCKPS<1:0> Note 1: Synchronize(3) Fosc/2 Internal Clock Sleep Input ST Buffer is high speed type when using TxCKIPPS. 2: TMRx register increments on rising edge. 3: Synchronize does not operate while in Sleep. 4: See Register 26-3 for Clock source selections. 5: See Register 26-4 for GATE source selections. 6: Synchronized comparator output should not be used in conjunction with synchronized input clock. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 266 PIC16(L)F15313/23 26.1 Timer1 Operation 26.2 The Timer1 modules are 16-bit incrementing counters which are accessed through the TMR1H:TMR1L register pairs. Writes to TMR1H or TMR1L directly update the counter. When used with an internal clock source, the module is a timer and increments on every instruction cycle. When used with an external clock source, the module can be used as either a timer or counter and increments on every selected edge of the external source. The timer is enabled by configuring the TMR1ON and GE bits in the T1CON and T1GCON registers, respectively. Table 26-1 displays the Timer1 enable selections. TABLE 26-1: TIMER1 ENABLE SELECTIONS Timer1 Operation TMR1ON TMR1GE 1 1 Count Enabled 1 0 Always On 0 1 Off 0 0 Off Clock Source Selection The T1CLK register is used to select the clock source for the timer. Register 26-3 shows the possible clock sources that may be selected to make the timer increment. 26.2.1 INTERNAL CLOCK SOURCE When the internal clock source FOSC is selected, the TMR1H:TMR1L register pair will increment on multiples of FOSC as determined by the respective Timer1 prescaler. When the FOSC internal clock source is selected, the timer register value will increment by four counts every instruction clock cycle. Due to this condition, a 2 LSB error in resolution will occur when reading the TMR1H:TMR1L value. To utilize the full resolution of the timer in this mode, an asynchronous input signal must be used to gate the timer clock input. Out of the total timer gate signal sources, the following subset of sources can be asynchronous and may be useful for this purpose: * * * * * * * * CLC4 output CLC3 output CLC2 output CLC1 output Zero-Cross Detect output Comparator2 output Comparator1 output TxG PPS remappable input pin 26.2.2 EXTERNAL CLOCK SOURCE When the timer is enabled and the external clock input source (ex: T1CKI PPS remappable input) is selected as the clock source, the timer will increment on the rising edge of the external clock input. When using an external clock source, the timer can be configured to run synchronously or asynchronously, as described in Section 26.4 "Timer Operation in Asynchronous Counter Mode". Note: In Counter mode, a falling edge must be registered by the counter prior to the first incrementing rising edge after any one or more of the following conditions: * * * * 2017 Microchip Technology Inc. Preliminary The timer is first enabled after POR Firmware writes to TMR1H or TMR1L The timer is disabled The timer is re-enabled (e.g., TMR1ON-->1) when the T1CKI signal is currently logic low. DS40001897A-page 267 PIC16(L)F15313/23 26.3 26.4.1 Timer Prescaler Timer1 has four prescaler options allowing 1, 2, 4 or 8 divisions of the clock input. The CKPS bits of the T1CON register control the prescale counter. The prescale counter is not directly readable or writable; however, the prescaler counter is cleared upon a write to TMR1H or TMR1L. 26.4 Timer Operation in Asynchronous Counter Mode If the control bit SYNC of the T1CON register is set, the external clock input is not synchronized. The timer increments asynchronously to the internal phase clocks. If the external clock source is selected then the timer will continue to run during Sleep and can generate an interrupt on overflow, which will wake-up the processor. However, special precautions in software are needed to read/write the timer (see Section 26.4.1 "Reading and Writing Timer1 in Asynchronous Counter Mode"). Note: When switching from synchronous to asynchronous operation, it is possible to skip an increment. When switching from asynchronous to synchronous operation, it is possible to produce an additional increment. READING AND WRITING TIMER1 IN ASYNCHRONOUS COUNTER MODE Reading TMR1H or TMR1L while the timer is running from an external asynchronous clock will ensure a valid read (taken care of in hardware). However, the user should keep in mind that reading the 16-bit timer in two 8-bit values itself, poses certain problems, since the timer may overflow between the reads. For writes, it is recommended that the user simply stop the timer and write the desired values. A write contention may occur by writing to the timer registers, while the register is incrementing. This may produce an unpredictable value in the TMR1H:TMR1L register pair. 26.5 Timer Gate Timer1 can be configured to count freely or the count can be enabled and disabled using the time gate circuitry. This is also referred to as Timer Gate Enable. The timer gate can also be driven by multiple selectable sources. 26.5.1 TIMER GATE ENABLE The Timer Gate Enable mode is enabled by setting the GE bit of the T1GCON register. The polarity of the Timer Gate Enable mode is configured using the GPOL bit of the T1GCON register. When Timer Gate Enable signal is enabled, the timer will increment on the rising edge of the Timer1 clock source. When Timer Gate Enable signal is disabled, the timer always increments, regardless of the GE bit. See Figure 26-3 for timing details. TABLE 26-2: 2017 Microchip Technology Inc. TIMER GATE ENABLE SELECTIONS T1CLK T1GPOL T1G 1 1 Counts 1 0 Holds Count 0 1 Holds Count 0 0 Counts Preliminary Timer Operation DS40001897A-page 268 PIC16(L)F15313/23 26.5.2 TIMER GATE SOURCE SELECTION One of the several different external or internal signal sources may be chosen to gate the timer and allow the timer to increment. The gate input signal source can be selected based on the T1GATE register setting. See the T1GATE register (Register 26-4) description for a complete list of the available gate sources. The polarity for each available source is also selectable. Polarity selection is controlled by the GPOL bit of the T1GCON register. 26.5.2.1 T1G Pin Gate Operation The T1G pin is one source for the timer gate control. It can be used to supply an external source to the time gate circuitry. 26.5.2.2 Timer0 Overflow Gate Operation 26.5.4 TIMER1 GATE SINGLE-PULSE MODE When Timer1 Gate Single-Pulse mode is enabled, it is possible to capture a single-pulse gate event. Timer1 Gate Single-Pulse mode is first enabled by setting the GSPM bit in the T1GCON register. Next, the GGO/DONE bit in the T1GCON register must be set. The timer will be fully enabled on the next incrementing edge. On the next trailing edge of the pulse, the GGO/DONE bit will automatically be cleared. No other gate events will be allowed to increment the timer until the GGO/DONE bit is once again set in software. See Figure 26-5 for timing details. If the Single-Pulse Gate mode is disabled by clearing the GSPM bit in the T1GCON register, the GGO/DONE bit should also be cleared. When Timer0 overflows, or a period register match condition occurs (in 8-bit mode), a low-to-high pulse will automatically be generated and internally supplied to the Timer1 gate circuitry. Enabling the Toggle mode and the Single-Pulse mode simultaneously will permit both sections to work together. This allows the cycle times on the timer gate source to be measured. See Figure 26-6 for timing details. 26.5.2.3 26.5.5 Comparator C1 Gate Operation The output resulting from a Comparator 1 operation can be selected as a source for the timer gate control. The Comparator 1 output can be synchronized to the timer clock or left asynchronous. For more information see Section 23.4.1 "Comparator Output Synchronization". 26.5.2.4 The output resulting from a Comparator 2 operation can be selected as a source for the timer gate control. The Comparator 2 output can be synchronized to the timer clock or left asynchronous. For more information see Section 23.4.1 "Comparator Output Synchronization". 26.5.3 When Timer1 Gate Value Status is utilized, it is possible to read the most current level of the gate control value. The value is stored in the GVAL bit in the T1GCON register. The GVAL bit is valid even when the timer gate is not enabled (GE bit is cleared). 26.5.6 Comparator C2 Gate Operation TIMER1 GATE TOGGLE MODE TIMER1 GATE VALUE STATUS TIMER1 GATE EVENT INTERRUPT When Timer1 Gate Event Interrupt is enabled, it is possible to generate an interrupt upon the completion of a gate event. When the falling edge of GVAL occurs, the TMR1GIF flag bit in the PIR5 register will be set. If the TMR1GIE bit in the PIE5 register is set, then an interrupt will be recognized. The TMR1GIF flag bit operates even when the timer gate is not enabled (TMR1GE bit is cleared). When Timer1 Gate Toggle mode is enabled, it is possible to measure the full-cycle length of a timer gate signal, as opposed to the duration of a single level pulse. The timer gate source is routed through a flip-flop that changes state on every incrementing edge of the signal. See Figure 26-4 for timing details. Timer1 Gate Toggle mode is enabled by setting the GTM bit of the T1GCON register. When the GTM bit is cleared, the flip-flop is cleared and held clear. This is necessary in order to control which edge is measured. Note: Enabling Toggle mode at the same time as changing the gate polarity may result in indeterminate operation. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 269 PIC16(L)F15313/23 26.6 Timer1 Interrupts 26.8 The timer register pair (TMR1H:TMR1L) increments to FFFFh and rolls over to 0000h. When the timer rolls over, the respective timer interrupt flag bit of the PIR5 register is set. To enable the interrupt on rollover, you must set these bits: * * * * ON bit of the T1CON register TMR1IE bit of the PIE4 register PEIE bit of the INTCON register GIE bit of the INTCON register The interrupt is cleared by clearing the TMR1IF bit in the Interrupt Service Routine. Note: 26.7 To avoid immediate interrupt vectoring, the TMR1H:TMR1L register pair should be preloaded with a value that is not imminently about to rollover, and the TMR1IF flag should be cleared prior to enabling the timer interrupts. The CCP modules use the TMR1H:TMR1L register pair as the time base when operating in Capture or Compare mode. In Capture mode, the value in the TMR1H:TMR1L register pair is copied into the CCPRxH:CCPRxL register pair on a configured event. In Compare mode, an event is triggered when the value CCPRxH:CCPRxL register pair matches the value in the TMR1H:TMR1L register pair. This event can be an Auto-conversion Trigger. For more information, see "Capture/Compare/PWM Modules". 26.9 Section 28.0 CCP Auto-Conversion Trigger When any of the CCP's are configured to trigger an auto-conversion, the trigger will clear the TMR1H:TMR1L register pair. This auto-conversion does not cause a timer interrupt. The CCP module may still be configured to generate a CCP interrupt. In this mode of operation, the CCPRxH:CCPRxL register pair becomes the period register for Timer1. Timer1 Operation During Sleep Timer1 can only operate during Sleep when setup in Asynchronous Counter mode. In this mode, an external crystal or clock source can be used to increment the counter. To set up the timer to wake the device: * * * * * * CCP Capture/Compare Time Base ON bit of the T1CON register must be set TMR1IE bit of the PIE4 register must be set PEIE bit of the INTCON register must be set SYNC bit of the T1CON register must be set CS bits of the T1CLK register must be configured The timer clock source must be enabled and continue operation during sleep. The timer should be synchronized and FOSC/4 should be selected as the clock source in order to utilize the Auto-conversion Trigger. Asynchronous operation of the timer can cause an Auto-conversion Trigger to be missed. In the event that a write to TMR1H or TMR1L coincides with an Auto-conversion Trigger from the CCP, the write will take precedence. For more information, see Section 28.2.4 "Compare During Sleep". The device will wake-up on an overflow and execute the next instructions. If the GIE bit of the INTCON register is set, the device will call the Interrupt Service Routine. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 270 PIC16(L)F15313/23 FIGURE 26-2: TIMER1 INCREMENTING EDGE TxCKI = 1 when the timer is enabled TxCKI = 0 when the timer is enabled Note 1: 2: Arrows indicate counter increments. In Counter mode, a falling edge must be registered by the counter prior to the first incrementing rising edge of the clock. FIGURE 26-3: TIMER1 GATE ENABLE MODE TMRxGE TxGPOL Selected gate input TxCKI TxGVAL TMRxH:TMRxL Count 2017 Microchip Technology Inc. N N+1 Preliminary N+2 N+3 N+4 DS40001897A-page 271 PIC16(L)F15313/23 FIGURE 26-4: TIMER1 GATE TOGGLE MODE TMRxGE TxGPOL TxGTM Selected gate input TxCKI TxGVAL TMRxH:TMRxL Count FIGURE 26-5: N N+1 N+2 N+3 N+4 N+5 N+6 N+7 N+8 TIMER1 GATE SINGLE-PULSE MODE TMRxGE TxGPOL TxGSPM TxGGO/ DONE Cleared by hardware on falling edge of TxGVAL Set by software Counting enabled on rising edge of selected source Selected gate source TxCKI TxGVAL TMRxH:TMRxL Count TMRxGIF N N+1 Set by hardware on falling edge of TxGVAL Cleared by software 2017 Microchip Technology Inc. N+2 Preliminary Cleared by software DS40001897A-page 272 PIC16(L)F15313/23 FIGURE 26-6: TIMER1 GATE SINGLE-PULSE AND TOGGLE COMBINED MODE TMRxGE TxGPOL TxGSPM TxGTM TxGGO/ DONE Cleared by hardware on falling edge of TxGVAL Set by software Counting enabled on rising edge of selected source Selected gate source TxCKI TxGVAL TMRxH:TMRxL Count TMRxGIF N Cleared by software 2017 Microchip Technology Inc. N+1 N+2 N+3 N+4 Set by hardware on falling edge of TxGVAL Preliminary Cleared by software DS40001897A-page 273 PIC16(L)F15313/23 26.10 Register Definitions: Timer1 Control REGISTER 26-1: T1CON: TIMER1 CONTROL REGISTER U-0 U-0 -- -- R/W-0/u R/W-0/u CKPS<1:0> U-0 R/W-0/u R/W-0/u R/W-0/u -- SYNC RD16 ON bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-4 CKPS<1:0>: Timer1 Input Clock Prescale Select bits 11 = 1:8 Prescale value 10 = 1:4 Prescale value 01 = 1:2 Prescale value 00 = 1:1 Prescale value bit 3 Unimplemented: Read as `0' bit 2 SYNC: Timer1 Synchronization Control bit When TMR1CLK = FOSC or FOSC/4 This bit is ignored. The timer uses the internal clock and no additional synchronization is performed. ELSE 0 = Synchronize external clock input with system clock 1 = Do not synchronize external clock input bit 1 RD16: 16-bit Read/Write Mode Enable bit 0 = Enables register read/write of Timer1 in two 8-bit operation 1 = Enables register read/write of Timer1 in one 16-bit operation bit 0 ON: Timer1 On bit 1 = Enables Timer1 0 = Stops Timer1 and clears Timer1 gate flip-flop 2017 Microchip Technology Inc. Preliminary DS40001897A-page 274 PIC16(L)F15313/23 REGISTER 26-2: T1GCON: TIMER1 GATE CONTROL REGISTER R/W-0/u R/W-0/u R/W-0/u R/W-0/u R/W/HC-0/u R-x/x U-0 U-0 GE GPOL GTM GSPM GGO/DONE GVAL -- -- bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HC = Bit is cleared by hardware bit 7 GE: Timer1 Gate Enable bit If ON = 0: This bit is ignored If ON = 1: 1 = Timer1 counting is controlled by the Timer1 gate function 0 = Timer1 is always counting bit 6 GPOL: Timer1 Gate Polarity bit 1 = Timer1 gate is active-high (Timer1 counts when gate is high) 0 = Timer1 gate is active-low (Timer1 counts when gate is low) bit 5 GTM: Timer1 Gate Toggle Mode bit 1 = Timer1 Gate Toggle mode is enabled 0 = Timer1 Gate Toggle mode is disabled and toggle flip-flop is cleared Timer1 gate flip-flop toggles on every rising edge. bit 4 GSPM: Timer1 Gate Single-Pulse Mode bit 1 = Timer1 Gate Single-Pulse mode is enabled 0 = Timer1 Gate Single-Pulse mode is disabled bit 3 GGO/DONE: Timer1 Gate Single-Pulse Acquisition Status bit 1 = Timer1 gate single-pulse acquisition is ready, waiting for an edge 0 = Timer1 gate single-pulse acquisition has completed or has not been started This bit is automatically cleared when GSPM is cleared bit 2 GVAL: Timer1 Gate Value Status bit Indicates the current state of the Timer1 gate that could be provided to TMR1H:TMR1L Unaffected by Timer1 Gate Enable (GE) bit 1-0 Unimplemented: Read as `0' 2017 Microchip Technology Inc. Preliminary DS40001897A-page 275 PIC16(L)F15313/23 REGISTER 26-3: T1CLK TIMER1 CLOCK SELECT REGISTER U-0 U-0 U-0 U-0 -- -- -- -- R/W-0/u R/W-0/u R/W-0/u R/W-0/u CS<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HC = Bit is cleared by hardware bit 7-4 Unimplemented: Read as `0' bit 3-0 CS<3:0>: Timer1 Clock Select bits 1111 = Reserved 1110 = Reserved 1101 = LC4_out 1100 = LC3_out 1011 = LC2_out 1010 = LC1_out 1001 = Timer0 overflow output 1000 = CLKR output 0111 = Reserved 0110 = MFINTOSC (32 kHz) 0101 = MFINTOSC (500 kHz) 0100 = LFINTOSC 0011 = HFINTOSC 0010 = FOSC 0001 = FOSC/4 0000 = T1CKIPPS 2017 Microchip Technology Inc. Preliminary DS40001897A-page 276 PIC16(L)F15313/23 REGISTER 26-4: T1GATE TIMER1 GATE SELECT REGISTER U-0 U-0 U-0 -- -- -- R/W-0/u R/W-0/u R/W-0/u R/W-0/u R/W-0/u GSS<4:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HC = Bit is cleared by hardware bit 7-5 Unimplemented: Read as `0' bit 4-0 GSS<4:0>: Timer1 Gate Select bits 11111-10001 = Reserved 10000 = LC4_out 01111 = LC3_out 01110 = LC2_out 01101 = LC1_out 00100 = ZCD1_output 01011 = C2OUT_sync 01010 = C1OUT_sync 01001 = NCO1_out 01000 = PWM6_out 00111 = PWM5_out 00110 = PWM4_out 00101 = PWM3_out 00100 = CCP2_out 00011 = CCP1_out 00010 = TMR2_postscaled 00001 = Timer0 overflow output 00000 = T1GPPS 2017 Microchip Technology Inc. Preliminary DS40001897A-page 277 PIC16(L)F15313/23 TABLE 26-3: Name INTCON SUMMARY OF REGISTERS ASSOCIATED WITH TIMER1 Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page GIE PEIE INTEDG 121 PIE4 -- -- -- -- -- -- TMR2IE TMR1IE 126 PIR4 -- -- -- -- -- -- TMR2IF TMR1IF 134 -- SYNC RD16 ON 274 GGO/DONE GVAL -- -- 275 T1CON -- -- T1GCON GE GPOL GTM T1GATE -- -- -- -- -- -- T1CLK CKPS<1:0> GSPM GSS<4:0> -- CS<3:0> 277 276 TMR1L Holding Register for the Least Significant Byte of the 16-bit TMR1 Register 266* TMR1H Holding Register for the Most Significant Byte of the 16-bit TMR1 Register 266* T1CKIPPS T1CKIPPS<5:0> 191 T1GPPS T1GPPS<5:0> 191 CCPxCON CCPxEN CCPxOE CLCxSELy LCxDyS<4:0> 352 ADACT ADACT<4:0> 225 Legend: * CCPxOUT CCPxFMT CCPxMODE<3:0> 306 -- = Unimplemented location, read as `0'. Shaded cells are not used with the Timer1 modules. Page with register information. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 278 PIC16(L)F15313/23 27.0 * * * * * * * TIMER2 MODULE WITH HARDWARE LIMIT TIMER (HLT) The Timer2 module is an 8-bit timer that can operate as free-running period counters or in conjunction with external signals that control start, run, freeze, and reset operation in One-Shot and Monostable modes of operation. Sophisticated waveform control such as pulse density modulation are possible by combining the operation of this timer with other internal peripherals such as the comparators and CCP modules. Features of the timer include: See Figure 27-1 for a block diagram of Timer2. See Figure 27-2 for the clock source block diagram. * 8-bit timer register * 8-bit period register FIGURE 27-1: TIMER2 BLOCK DIAGRAM RSEL <:0> INPPS TxIN PPS External Reset (2) Sources Selectable external hardware timer Resets Programmable prescaler (1:1 to 1:128) Programmable postscaler (1:1 to 1:16) Selectable synchronous/asynchronous operation Alternate clock sources Interrupt-on-period Three modes of operation: - Free Running Period - One-shot - Monostable Rev. 10-000168C 9/10/2015 MODE<4:0> TMRx_ers Edge Detector Level Detector Mode Control (2 clock Sync) MODE<3> reset CCP_pset(1) MODE<4:3>=01 enable D MODE<4:1>=1011 Q Clear ON CPOL 0 Prescaler TMRx_clk T[7MR 3 CKPS<2:0> Sync 1 Fosc/4 PSYNC R Comparator Set flag bit TMRxIF Postscaler TMRx_postscaled 4 Sync (2 Clocks) ON 1 7[PR OUTPS<3:0> 0 CSYNC Note 1: 2: Signal to the CCP to trigger the PWM pulse. See Register 27-4 for external Reset sources. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 279 PIC16(L)F15313/23 FIGURE 27-2: TIMER2 CLOCK SOURCE BLOCK DIAGRAM TxCLKCON Rev. 10-000 169B 5/29/201 4 TXINPPS TXIN 27.1.2 PPS Timer Clock Sources (See Table 27-2) the output postscaler counter. When the postscaler count equals the value in the OUTPS<4:0> bits of the TMRxCON1 register, a one TMR2_clk period wide pulse occurs on the TMR2_postscaled output, and the postscaler count is cleared. The One-Shot mode is identical to the Free Running Period mode except that the ON bit is cleared and the timer is stopped when TMR2 matches T2PR and will not restart until the T2ON bit is cycled off and on. Postscaler OUTPS<4:0> values other than 0 are meaningless in this mode because the timer is stopped at the first period event and the postscaler is reset when the timer is restarted. TMR2_clk 27.1.3 27.1 ONE-SHOT MODE MONOSTABLE MODE Monostable modes are similar to One-Shot modes except that the ON bit is not cleared and the timer can be restarted by an external Reset event. Timer2 Operation Timer2 operates in three major modes: 27.2 * Free Running Period * One-shot * Monostable The Timer2 module's primary output is TMR2_postscaled, which pulses for a single TMR2_clk period when the postscaler counter matches the value in the OUTPS bits of the TMR2CON register. The T2PR postscaler is incremented each time the TMR2 value matches the T2PR value. This signal can be selected as an input to several other input modules: Within each mode there are several options for starting, stopping, and reset. Table 27-1 lists the options. In all modes, the TMR2 count register is incremented on the rising edge of the clock signal from the programmable prescaler. When TMR2 equals T2PR, a high level is output to the postscaler counter. TMR2 is cleared on the next clock input. An external signal from hardware can also be configured to gate the timer operation or force a TMR2 count Reset. In Gate modes the counter stops when the gate is disabled and resumes when the gate is enabled. In Reset modes the TMR2 count is reset on either the level or edge from the external source. The TMR2 and T2PR registers are both directly readable and writable. The TMR2 register is cleared and the T2PR register initializes to FFh on any device Reset. Both the prescaler and postscaler counters are cleared on the following events: * * * * a write to the TMR2 register a write to the T2CON register any device Reset External Reset Source event that resets the timer. Note: 27.1.1 TMR2 is not cleared when T2CON is written. FREE RUNNING PERIOD MODE The value of TMR2 is compared to that of the Period register, T2PR, on each TMR2_clk cycle. When the two values match, the comparator resets the value of TMR2 to 00h on the next rising TMR2_clk edge and increments 2017 Microchip Technology Inc. Timer2 Output * The ADC module, as an Auto-conversion Trigger * COG, as an auto-shutdown source In addition, the Timer2 is also used by the CCP module for pulse generation in PWM mode. Both the actual TMR2 value as well as other internal signals are sent to the CCP module to properly clock both the period and pulse width of the PWM signal. See Section 28.0 "Capture/Compare/PWM Modules" for more details on setting up Timer2 for use with the CCP, as well as the timing diagrams in Section 27.5 "Operation Examples" for examples of how the varying Timer2 modes affect CCP PWM output. 27.3 External Reset Sources In addition to the clock source, the Timer2 also takes in an external Reset source. This external Reset source is selected for Timer2 with the T2RST register. This source can control starting and stopping of the timer, as well as resetting the timer, depending on which mode the timer is in. The mode of the timer is controlled by the MODE<4:0> bits of the TMRxHLT register. Edge-Triggered modes require six Timer clock periods between external triggers. Level-Triggered modes require the triggering level to be at least three Timer clock periods long. External triggers are ignored while in Debug Freeze mode. Preliminary DS40001897A-page 280 PIC16(L)F15313/23 TABLE 27-1: TIMER2 OPERATING MODES MODE<4:0> Mode <4:3> <2:0> Output Operation 000 001 Period Pulse 010 Free Running Period Start Reset Stop Software gate (Figure 27-4) ON = 1 -- ON = 0 Hardware gate, active-high (Figure 27-5) ON = 1 and TMRx_ers = 1 -- ON = 0 or TMRx_ers = 0 Hardware gate, active-low ON = 1 and TMRx_ers = 0 -- ON = 0 or TMRx_ers = 1 011 Rising or falling edge Reset TMRx_ers 100 Rising edge Reset (Figure 27-6) TMRx_ers 00 101 110 Period Pulse with Hardware Reset 111 000 001 010 One-shot Edge triggered start (Note 1) 011 One-shot Timer Control Operation 01 100 101 110 111 Edge triggered start and hardware Reset (Note 1) Falling edge Reset Mono-stable 010 High level Reset (Figure 27-7) 10 Reserved 111 Reserved Note 1: 2: 3: 11 TMRx_ers = 1 ON = 0 or TMRx_ers = 1 ON = 1 -- Rising edge start (Figure 27-9) ON = 1 and TMRx_ers -- Falling edge start ON = 1 and TMRx_ers -- Any edge start ON = 1 and TMRx_ers -- Rising edge start and Rising edge Reset (Figure 27-10) ON = 1 and TMRx_ers TMRx_ers Falling edge start and Falling edge Reset ON = 1 and TMRx_ers TMRx_ers Rising edge start and Low level Reset (Figure 27-11) ON = 1 and TMRx_ers TMRx_ers = 0 Falling edge start and High level Reset ON = 1 and TMRx_ers TMRx_ers = 1 Edge triggered start (Note 1) Rising edge start (Figure 27-12) ON = 1 and TMRx_ers -- Falling edge start ON = 1 and TMRx_ers -- Any edge start ON = 1 and TMRx_ers -- ON = 0 or Next clock after TMRx = PRx (Note 2) ON = 0 or Next clock after TMRx = PRx (Note 3) Reserved Reserved 101 One-shot ON = 0 or TMRx_ers = 0 Software start (Figure 27-8) 100 110 TMRx_ers = 0 Reserved 011 Reserved TMRx_ers ON = 1 Low level Reset 000 001 ON = 0 Level triggered start and hardware Reset High level start and Low level Reset (Figure 27-13) ON = 1 and TMRx_ers = 1 TMRx_ers = 0 Low level start & High level Reset ON = 1 and TMRx_ers = 0 TMRx_ers = 1 ON = 0 or Held in Reset (Note 2) Reserved xxx If ON = 0 then an edge is required to restart the timer after ON = 1. When TMRx = PRx then the next clock clears ON and stops TMRx at 00h. When TMRx = PRx then the next clock stops TMRx at 00h but does not clear ON. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 281 PIC16(L)F15313/23 27.4 Timer2 Interrupt Timer2 can also generate a device interrupt. The interrupt is generated when the postscaler counter matches one of 16 postscale options (from 1:1 through 1:16), which are selected with the postscaler control bits, OUTPS<3:0> of the T2CON register. The interrupt is enabled by setting the TMR2IE interrupt enable bit of the PIE4 register. Interrupt timing is illustrated in Figure 27-3. FIGURE 27-3: TIMER2 PRESCALER, POSTSCALER, AND INTERRUPT TIMING DIAGRAM Rev. 10-000205A 4/7/2016 0b010 CKPS PRx 1 OUTPS 0b0001 TMRx_clk TMRx 0 0 1 1 0 1 0 TMRx_postscaled TMRxIF (1) (2) (1) Note 1: Setting the interrupt flag is synchronized with the instruction clock. Synchronization may take as many as 2 instruction cycles 2: Cleared by software. 27.5 27.5.1 Operation Examples Unless otherwise specified, the following notes apply to the following timing diagrams: - Both the prescaler and postscaler are set to 1:1 (both the CKPS and OUTPS bits in the TxCON register are cleared). - The diagrams illustrate any clock except Fosc/4 and show clock-sync delays of at least two full cycles for both ON and Timer2_ers. When using Fosc/4, the clock-sync delay is at least one instruction period for Timer2_ers; ON applies in the next instruction period. - The PWM Duty Cycle and PWM output are illustrated assuming that the timer is used for the PWM function of the CCP module as described in Section 28.0 "Capture/Compare/PWM Modules". The signals are not a part of the Timer2 module. 2017 Microchip Technology Inc. SOFTWARE GATE MODE This mode corresponds to legacy Timer2 operation. The timer increments with each clock input when ON = 1 and does not increment when ON = 0. When the TMRx count equals the PRx period count the timer resets on the next clock and continues counting from 0. Operation with the ON bit software controlled is illustrated in Figure 27-4. With PRx = 5, the counter advances until TMRx = 5, and goes to zero with the next clock. Preliminary DS40001897A-page 282 PIC16(L)F15313/23 FIGURE 27-4: SOFTWARE GATE MODE TIMING DIAGRAM (MODE = 00000) Rev. 10-000195B 5/30/2014 0b00000 MODE TMRx_clk Instruction(1) BSF BCF BSF ON PRx TMRx 5 0 1 2 3 4 5 0 1 2 3 4 5 0 1 2 3 4 5 0 1 TMRx_postscaled PWM Duty Cycle 3 PWM Output Note 1: BSF and BCF represent Bit-Set File and Bit-Clear File instructions executed by the CPU to set or clear the ON bit of TxCON. CPU execution is asynchronous to the timer clock input. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 283 PIC16(L)F15313/23 27.5.2 HARDWARE GATE MODE When MODE<4:0> = 00001 then the timer is stopped when the external signal is high. When MODE<4:0> = 00010 then the timer is stopped when the external signal is low. The Hardware Gate modes operate the same as the Software Gate mode except the TMRx_ers external signal gates the timer. When used with the CCP the gating extends the PWM period. If the timer is stopped when the PWM output is high then the duty cycle is also extended. FIGURE 27-5: Figure 27-5 illustrates the Hardware Gating mode for MODE<4:0> = 00001 in which a high input level starts the counter. HARDWARE GATE MODE TIMING DIAGRAM (MODE = 00001) Rev. 10-000 196B 5/30/201 4 0b00001 MODE TMRx_clk TMRx_ers PRx TMRx 5 0 1 2 3 4 5 0 1 2 3 4 5 0 1 TMRx_postscaled PWM Duty Cycle 3 PWM Output 2017 Microchip Technology Inc. Preliminary DS40001897A-page 284 PIC16(L)F15313/23 27.5.3 EDGE-TRIGGERED HARDWARE LIMIT MODE When the timer is used in conjunction with the CCP in PWM mode then an early Reset shortens the period and restarts the PWM pulse after a two clock delay. Refer to Figure 27-6. In Hardware Limit mode the timer can be reset by the TMRx_ers external signal before the timer reaches the period count. Three types of Resets are possible: * Reset on rising or falling edge (MODE<4:0>= 00011) * Reset on rising edge (MODE<4:0> = 00100) * Reset on falling edge (MODE<4:0> = 00101) FIGURE 27-6: EDGE-TRIGGERED HARDWARE LIMIT MODE TIMING DIAGRAM (MODE = 00100) Rev. 10-000 197B 5/30/201 4 0b00100 MODE TMRx_clk PRx 5 Instruction(1) BSF BCF BSF ON TMRx_ers TMRx 0 1 2 0 1 2 3 4 5 0 1 2 3 4 5 0 1 TMRx_postscaled PWM Duty Cycle 3 PWM Output Note 1: BSF and BCF represent Bit-Set File and Bit-Clear File instructions executed by the CPU to set or clear the ON bit of TxCON. CPU execution is asynchronous to the timer clock input. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 285 PIC16(L)F15313/23 27.5.4 LEVEL-TRIGGERED HARDWARE LIMIT MODE When the CCP uses the timer as the PWM time base then the PWM output will be set high when the timer starts counting and then set low only when the timer count matches the CCPRx value. The timer is reset when either the timer count matches the PRx value or two clock periods after the external Reset signal goes true and stays true. In the Level-Triggered Hardware Limit Timer modes the counter is reset by high or low levels of the external signal TMRx_ers, as shown in Figure 27-7. Selecting MODE<4:0> = 00110 will cause the timer to reset on a low level external signal. Selecting MODE<4:0> = 00111 will cause the timer to reset on a high level external signal. In the example, the counter is reset while TMRx_ers = 1. ON is controlled by BSF and BCF instructions. When ON = 0 the external signal is ignored. FIGURE 27-7: The timer starts counting, and the PWM output is set high, on either the clock following the PRx match or two clocks after the external Reset signal relinquishes the Reset. The PWM output will remain high until the timer counts up to match the CCPRx pulse width value. If the external Reset signal goes true while the PWM output is high then the PWM output will remain high until the Reset signal is released allowing the timer to count up to match the CCPRx value. LEVEL-TRIGGERED HARDWARE LIMIT MODE TIMING DIAGRAM (MODE = 00111) Rev. 10-000198B 5/30/2014 0b00111 MODE TMRx_clk 5 PRx Instruction(1) BSF BCF BSF ON TMRx_ers TMRx 0 1 2 0 1 2 3 4 5 0 0 1 2 3 4 5 0 TMRx_postscaled PWM Duty Cycle 3 PWM Output Note 1: BSF and BCF represent Bit-Set File and Bit-Clear File instructions executed by the CPU to set or clear the ON bit of TxCON. CPU execution is asynchronous to the timer clock input. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 286 PIC16(L)F15313/23 27.5.5 SOFTWARE START ONE-SHOT MODE In One-Shot mode the timer resets and the ON bit is cleared when the timer value matches the PRx period value. The ON bit must be set by software to start another timer cycle. Setting MODE<4:0> = 01000 selects One-Shot mode which is illustrated in Figure 27-8. In the example, ON is controlled by BSF and BCF instructions. In the first case, a BSF instruction sets ON and the counter runs to completion and clears ON. In the second case, a BSF instruction starts the cycle, BCF/BSF instructions turn the counter off and on during the cycle, and then it runs to completion. FIGURE 27-8: When One-Shot mode is used in conjunction with the CCP PWM operation the PWM pulse drive starts concurrent with setting the ON bit. Clearing the ON bit while the PWM drive is active will extend the PWM drive. The PWM drive will terminate when the timer value matches the CCPRx pulse width value. The PWM drive will remain off until software sets the ON bit to start another cycle. If software clears the ON bit after the CCPRx match but before the PRx match then the PWM drive will be extended by the length of time the ON bit remains cleared. Another timing cycle can only be initiated by setting the ON bit after it has been cleared by a PRx period count match. SOFTWARE START ONE-SHOT MODE TIMING DIAGRAM (MODE = 01000) Rev. 10-000199B 4/7/2016 0b01000 MODE TMRx_clk 5 PRx Instruction(1) BSF BSF BCF BSF ON TMRx 0 1 2 3 4 5 0 1 2 3 4 5 0 TMRx_postscaled PWM Duty Cycle 3 PWM Output Note 1: BSF and BCF represent Bit-Set File and Bit-Clear File instructions executed by the CPU to set or clear the ON bit of TxCON. CPU execution is asynchronous to the timer clock input. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 287 PIC16(L)F15313/23 27.5.6 EDGE-TRIGGERED ONE-SHOT MODE The Edge-Triggered One-Shot modes start the timer on an edge from the external signal input, after the ON bit is set, and clear the ON bit when the timer matches the PRx period value. The following edges will start the timer: * Rising edge (MODE<4:0> = 01001) * Falling edge (MODE<4:0> = 01010) * Rising or Falling edge (MODE<4:0> = 01011) FIGURE 27-9: If the timer is halted by clearing the ON bit then another TMRx_ers edge is required after the ON bit is set to resume counting. Figure 27-9 illustrates operation in the rising edge One-Shot mode. When Edge-Triggered One-Shot mode is used in conjunction with the CCP then the edge-trigger will activate the PWM drive and the PWM drive will deactivate when the timer matches the CCPRx pulse width value and stay deactivated when the timer halts at the PRx period count match. EDGE-TRIGGERED ONE-SHOT MODE TIMING DIAGRAM (MODE = 01001) Rev. 10-000200B 5/19/2016 0b01001 MODE TMRx_clk 5 PRx Instruction(1) BSF BSF BCF ON TMRx_ers TMRx 0 1 2 3 4 5 0 1 2 CCP_pset TMRx_postscaled PWM Duty Cycle 3 PWM Output Note 1: BSF and BCF represent Bit-Set File and Bit-Clear File instructions executed by the CPU to set or clear the ON bit of TxCON. CPU execution is asynchronous to the timer clock input. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 288 2017 Microchip Technology Inc. 27.5.7 EDGE-TRIGGERED HARDWARE LIMIT ONE-SHOT MODE The timer resets and clears the ON bit when the timer value matches the PRx period value. External signal edges will have no effect until after software sets the ON bit. Figure 27-10 illustrates the rising edge hardware limit one-shot operation. In Edge-Triggered Hardware Limit One-Shot modes the timer starts on the first external signal edge after the ON bit is set and resets on all subsequent edges. Only the first edge after the ON bit is set is needed to start the timer. The counter will resume counting automatically two clocks after all subsequent external Reset edges. Edge triggers are as follows: * Rising edge start and Reset (MODE<4:0> = 01100) * Falling edge start and Reset (MODE<4:0> = 01101) FIGURE 27-10: When this mode is used in conjunction with the CCP then the first starting edge trigger, and all subsequent Reset edges, will activate the PWM drive. The PWM drive will deactivate when the timer matches the CCPRx pulse-width value and stay deactivated until the timer halts at the PRx period match unless an external signal edge resets the timer before the match occurs. EDGE-TRIGGERED HARDWARE LIMIT ONE-SHOT MODE TIMING DIAGRAM (MODE = 01100) Rev. 10-000201B 4/7/2016 MODE 0b01100 TMRx_clk Preliminary 5 PRx Instruction(1) BSF BSF ON 0 TMRx 1 2 3 4 5 0 1 2 0 1 2 3 4 TMRx_postscaled PWM Duty Cycle 3 DS40001897A-page 289 PWM Output Note 1: BSF and BCF represent Bit-Set File and Bit-Clear File instructions executed by the CPU to set or clear the ON bit of TxCON. CPU execution is asynchronous to the timer clock input. 5 0 PIC16(L)F15313/23 TMRx_ers 2017 Microchip Technology Inc. 27.5.8 LEVEL RESET, EDGE-TRIGGERED HARDWARE LIMIT ONE-SHOT MODES When the timer count matches the PRx period count, the timer is reset and the ON bit is cleared. When the ON bit is cleared by either a PRx match or by software control a new external signal edge is required after the ON bit is set to start the counter. In Level -Triggered One-Shot mode the timer count is reset on the external signal level and starts counting on the rising/falling edge of the transition from Reset level to the active level while the ON bit is set. Reset levels are selected as follows: * Low Reset level (MODE<4:0> = 01110) * High Reset level (MODE<4:0> = 01111) FIGURE 27-11: When Level-Triggered Reset One-Shot mode is used in conjunction with the CCP PWM operation the PWM drive goes active with the external signal edge that starts the timer. The PWM drive goes inactive when the timer count equals the CCPRx pulse width count. The PWM drive does not go active when the timer count clears at the PRx period count match. LOW LEVEL RESET, EDGE-TRIGGERED HARDWARE LIMIT ONE-SHOT MODE TIMING DIAGRAM (MODE = 01110) Rev. 10-000202B 4/7/2016 MODE 0b01110 TMRx_clk 5 PRx Preliminary Instruction(1) BSF BSF ON TMRx_ers 1 2 3 4 5 0 1 0 1 2 3 TMRx_postscaled PWM Duty Cycle 3 PWM Output DS40001897A-page 290 Note 1: BSF and BCF represent Bit-Set File and Bit-Clear File instructions executed by the CPU to set or clear the ON bit of TxCON. CPU execution is asynchronous to the timer clock input. 4 5 0 PIC16(L)F15313/23 0 TMRx 2017 Microchip Technology Inc. 27.5.9 EDGE-TRIGGERED MONOSTABLE MODES When an Edge-Triggered Monostable mode is used in conjunction with the CCP PWM operation the PWM drive goes active with the external Reset signal edge that starts the timer, but will not go active when the timer matches the PRx value. While the timer is incrementing, additional edges on the external Reset signal will not affect the CCP PWM. The Edge-Triggered Monostable modes start the timer on an edge from the external Reset signal input, after the ON bit is set, and stop incrementing the timer when the timer matches the PRx period value. The following edges will start the timer: * Rising edge (MODE<4:0> = 10001) * Falling edge (MODE<4:0> = 10010) * Rising or Falling edge (MODE<4:0> = 10011) FIGURE 27-12: RISING EDGE-TRIGGERED MONOSTABLE MODE TIMING DIAGRAM (MODE = 10001) Rev. 10-000203A 4/7/2016 0b10001 MODE TMRx_clk Preliminary PRx Instruction(1) 5 BSF BCF BSF BCF BSF ON TMRx_ers 0 1 2 3 4 5 0 1 2 3 4 5 TMRx_postscaled PWM Duty Cycle 3 PWM Output DS40001897A-page 291 Note 1: BSF and BCF represent Bit-Set File and Bit-Clear File instructions executed by the CPU to set or clear the ON bit of TxCON. CPU execution is asynchronous to the timer clock input. 0 1 2 3 4 5 0 PIC16(L)F15313/23 TMRx 2017 Microchip Technology Inc. 27.5.10 LEVEL-TRIGGERED HARDWARE LIMIT ONE-SHOT MODES When the timer count matches the PRx period count, the timer is reset and the ON bit is cleared. When the ON bit is cleared by either a PRx match or by software control the timer will stay in Reset until both the ON bit is set and the external signal is not at the Reset level. The Level-Triggered Hardware Limit One-Shot modes hold the timer in Reset on an external Reset level and start counting when both the ON bit is set and the external signal is not at the Reset level. If one of either the external signal is not in Reset or the ON bit is set then the other signal being set/made active will start the timer. Reset levels are selected as follows: When Level-Triggered Hardware Limit One-Shot modes are used in conjunction with the CCP PWM operation the PWM drive goes active with either the external signal edge or the setting of the ON bit, whichever of the two starts the timer. * Low Reset level (MODE<4:0> = 10110) * High Reset level (MODE<4:0> = 10111) FIGURE 27-13: LEVEL-TRIGGERED HARDWARE LIMIT ONE-SHOT MODE TIMING DIAGRAM (MODE = 10110) Rev. 10-000204A 4/7/2016 0b10110 MODE TMR2_clk Preliminary PRx 5 Instruction(1) BSF BSF BCF BSF ON TMRx 0 1 2 3 4 5 0 1 2 3 TMR2_postscaled PWM Duty Cycle `D3 DS40001897A-page 292 PWM Output Note 1: BSF and BCF represent Bit-Set File and Bit-Clear File instructions executed by the CPU to set or clear the ON bit of TxCON. CPU execution is asynchronous to the timer clock input. 0 1 2 3 4 5 0 PIC16(L)F15313/23 TMR2_ers PIC16(L)F15313/23 27.6 Timer2 Operation During Sleep When PSYNC = 1, Timer2 cannot be operated while the processor is in Sleep mode. The contents of the TMR2 and T2PR registers will remain unchanged while processor is in Sleep mode. When PSYNC = 0, Timer2 will operate in Sleep as long as the clock source selected is also still running. Selecting the LFINTOSC, MFINTOSC, or HFINTOSC oscillator as the timer clock source will keep the selected oscillator running during Sleep. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 293 PIC16(L)F15313/23 27.7 Register Definitions: Timer2 Control REGISTER 27-1: T2CLKCON: TIMER2 CLOCK SELECTION REGISTER U-0 U-0 U-0 U-0 -- -- -- -- R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 CS<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-4 Unimplemented: Read as `0' bit 3-0 CS<3:0>: Timer2 Clock Select bits 1111 = Reserved 1110 = LC4_out 1101 = LC3_out 1100 = LC2_out 1011 = LC1_out 1010 = ZCD1_output 1001 = NCO1_out 1000 = CLKR 0111 = Reserved 0110 = MFINTOSC (31.25 kHz) 0101 = MFINTOSC (500 kHz) 0100 = LFINTOSC 0011 = HFINTOSC (32 MHz) 0010 = FOSC 0001 = FOSC/4 0000 = T2CKIPPS 2017 Microchip Technology Inc. Preliminary DS40001897A-page 294 PIC16(L)F15313/23 REGISTER 27-2: R/W/HC-0/0 T2CON: TIMER2 CONTROL REGISTER R/W-0/0 (1) ON R/W-0/0 R/W-0/0 R/W-0/0 CKPS<2:0> R/W-0/0 R/W-0/0 R/W-0/0 OUTPS<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HC = Bit is cleared by hardware bit 7 ON: Timerx On bit 1 = Timerx is on 0 = Timerx is off: all counters and state machines are reset bit 6-4 CKPS<2:0>: Timer2-type Clock Prescale Select bits 111 = 1:128 Prescaler 110 = 1:64 Prescaler 101 = 1:32 Prescaler 100 = 1:16 Prescaler 011 = 1:8 Prescaler 010 = 1:4 Prescaler 001 = 1:2 Prescaler 000 = 1:1 Prescaler bit 3-0 OUTPS<3:0>: Timerx Output Postscaler Select bits 1111 = 1:16 Postscaler 1110 = 1:15 Postscaler 1101 = 1:14 Postscaler 1100 = 1:13 Postscaler 1011 = 1:12 Postscaler 1010 = 1:11 Postscaler 1001 = 1:10 Postscaler 1000 = 1:9 Postscaler 0111 = 1:8 Postscaler 0110 = 1:7 Postscaler 0101 = 1:6 Postscaler 0100 = 1:5 Postscaler 0011 = 1:4 Postscaler 0010 = 1:3 Postscaler 0001 = 1:2 Postscaler 0000 = 1:1 Postscaler Note 1: In certain modes, the ON bit will be auto-cleared by hardware. See Section 27.5 "Operation Examples". 2017 Microchip Technology Inc. Preliminary DS40001897A-page 295 PIC16(L)F15313/23 REGISTER 27-3: T2HLT: TIMERx HARDWARE LIMIT CONTROL REGISTER R/W-0/0 R/W-0/0 R/W-0/0 PSYNC(1, 2) CKPOL(3) CKSYNC(4, 5) R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 MODE<4:0>(6, 7) bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 PSYNC: Timerx Prescaler Synchronization Enable bit(1, 2) 1 = TMRx Prescaler Output is synchronized to Fosc/4 0 = TMRx Prescaler Output is not synchronized to Fosc/4 bit 6 CKPOL: Timerx Clock Polarity Selection bit(3) 1 = Falling edge of input clock clocks timer/prescaler 0 = Rising edge of input clock clocks timer/prescaler bit 5 CKSYNC: Timerx Clock Synchronization Enable bit(4, 5) 1 = ON register bit is synchronized to TMR2_clk input 0 = ON register bit is not synchronized to TMR2_clk input bit 4-0 MODE<4:0>: Timerx Control Mode Selection bits(6, 7) See Table 27-1. Note 1: Setting this bit ensures that reading TMRx will return a valid value. 2: When this bit is `1', Timer2 cannot operate in Sleep mode. 3: CKPOL should not be changed while ON = 1. 4: Setting this bit ensures glitch-free operation when the ON is enabled or disabled. 5: When this bit is set then the timer operation will be delayed by two TMRx input clocks after the ON bit is set. 6: Unless otherwise indicated, all modes start upon ON = 1 and stop upon ON = 0 (stops occur without affecting the value of TMRx). 7: When TMRx = PRx, the next clock clears TMRx, regardless of the operating mode. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 296 PIC16(L)F15313/23 REGISTER 27-4: T2RST: TIMER2 EXTERNAL RESET SIGNAL SELECTION REGISTER U-0 U-0 U-0 U-0 -- -- -- -- R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 RSEL<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-4 Unimplemented: Read as `0' bit 3-0 RSEL<3:0>: Timer2 External Reset Signal Source Selection bits 1111 = Reserved 1101 = LC4_out 1100 = LC3_out 1011 = LC2_out 1010 = LC1_out 1001 = ZCD1_output 1000 = C2OUT_sync(1) 0111 = C1OUT_sync 0110 = PWM6_out 0101 = PWM5_out 0100 = PWM4_out 0011 = PWM3_out 0010 = CCP2_out 0001 = CCP1_out 0000 = T2INPPS Note 1: Present on PIC16(L)F15323 only. Reserved for the PIC16(L)F15313. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 297 PIC16(L)F15313/23 TABLE 27-2: Name SUMMARY OF REGISTERS ASSOCIATED WITH TIMER2 Bit 7 Bit 6 Bit 5 Bit 4 CCP1CON EN -- OUT FMT MODE<3:0> CCP2CON EN -- OUT FMT MODE<3:0> INTCON GIE PEIE -- -- -- OSFIE CSWIE -- -- -- OSFIF CSWIF -- -- -- PIE1 PIR1 PR2 Timer2 Module Period Register TMR2 Holding Register for the 8-bit TMR2 Register Bit 2 Bit 1 Bit 0 Register on Page 306 306 -- -- INTEDG 121 -- ADIE 123 -- -- ADIF 131 280* T2CON ON T2CLKCON -- -- -- T2RST -- -- -- T2HLT PSYNC CKPOL CKSYNC Legend: * Bit 3 280* CKPS<2:0> OUTPS<3:0> 295 -- CS<3:0> 294 -- RSEL<3:0> 297 MODE<4:0> 296 -- = unimplemented location, read as `0'. Shaded cells are not used for Timer2 module. Page provides register information. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 298 PIC16(L)F15313/23 28.0 CAPTURE/COMPARE/PWM MODULES The Capture/Compare/PWM module is a peripheral that allows the user to time and control different events, and to generate Pulse-Width Modulation (PWM) signals. In Capture mode, the peripheral allows the timing of the duration of an event. The Compare mode allows the user to trigger an external event when a predetermined amount of time has expired. The PWM mode can generate Pulse-Width Modulated signals of varying frequency and duty cycle. The Capture/Compare/PWM modules available are shown in Table 28-1. TABLE 28-1: AVAILABLE CCP MODULES Device PIC16(L)F15313/23 CCP1 CCP2 The Capture and Compare functions are identical for all CCP modules. Note 1: In devices with more than one CCP module, it is very important to pay close attention to the register names used. A number placed after the module acronym is used to distinguish between separate modules. For example, the CCP1CON and CCP2CON control the same operational aspects of two completely different CCP modules. 2: Throughout this section, generic references to a CCP module in any of its operating modes may be interpreted as being equally applicable to CCPx module. Register names, module signals, I/O pins, and bit names may use the generic designator `x' to indicate the use of a numeral to distinguish a particular module, when required. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 299 PIC16(L)F15313/23 28.1 Figure 28-1 shows a simplified diagram of the capture operation. Capture Mode Capture mode makes use of the 16-bit Timer1 resource. When an event occurs on the capture source, the 16-bit CCPRxH:CCPRxL register pair captures and stores the 16-bit value of the TMR1H:TMR1L register pair, respectively. An event is defined as one of the following and is configured by the CCPxMODE<3:0> bits of the CCPxCON register: * * * * 28.1.1 In Capture mode, the CCPx pin should be configured as an input by setting the associated TRIS control bit. Note: Every falling edge Every rising edge Every 4th rising edge Every 16th rising edge If the CCPx pin is configured as an output, a write to the port can cause a capture condition. The capture source is selected by configuring the CCPxCTS<2:0> bits of the CCPxCAP register. The following sources can be selected: * * * * * * * * When a capture is made, the Interrupt Request Flag bit CCPxIF of the PIR6 register is set. The interrupt flag must be cleared in software. If another capture occurs before the value in the CCPRxH, CCPRxL register pair is read, the old captured value is overwritten by the new captured value. FIGURE 28-1: CAPTURE SOURCES CCPxPPS input C1OUT_sync C2OUT_sync IOC_interrupt LC1_out LC2_out LC3_out LC4_out CAPTURE MODE OPERATION BLOCK DIAGRAM Rev. 10-000158F 9/1/2015 RxyPPS CCPx CTS<2:0> TRIS Control CCPx LC4_out 111 LC3_out 110 LC2_out 101 LC1_out 100 IOC_interrupt 011 C2OUT_sync 010 C1OUT_sync 001 PPS 000 CCPRxH CCPRxL 16 Prescaler 1,4,16 set CCPxIF and Edge Detect 16 MODE <3:0> TMR1H TMR1L CCPxPPS 2017 Microchip Technology Inc. Preliminary DS40001897A-page 300 PIC16(L)F15313/23 28.1.2 28.1.5 TIMER1 MODE RESOURCE CAPTURE DURING SLEEP Timer1 must be running in Timer mode or Synchronized Counter mode for the CCP module to use the capture feature. In Asynchronous Counter mode, the capture operation may not work. Capture mode depends upon the Timer1 module for proper operation. There are two options for driving the Timer1 module in Capture mode. It can be driven by the instruction clock (FOSC/4), or by an external clock source. See Section 26.0 "Timer1 Module with Gate Control" for more information on configuring Timer1. When Timer1 is clocked by FOSC/4, Timer1 will not increment during Sleep. When the device wakes from Sleep, Timer1 will continue from its previous state. 28.1.3 SOFTWARE INTERRUPT MODE When the Capture mode is changed, a false capture interrupt may be generated. The user should keep the CCPxIE interrupt enable bit of the PIE6 register clear to avoid false interrupts. Additionally, the user should clear the CCPxIF interrupt flag bit of the PIR6 register following any change in Operating mode. Note: 28.1.4 Clocking Timer1 from the system clock (FOSC) should not be used in Capture mode. In order for Capture mode to recognize the trigger event on the CCPx pin, Timer1 must be clocked from the instruction clock (FOSC/4). CCP PRESCALER Capture mode will operate during Sleep when Timer1 is clocked by an external clock source. 28.2 Compare Mode Compare mode makes use of the 16-bit Timer1 resource. The 16-bit value of the CCPRxH:CCPRxL register pair is constantly compared against the 16-bit value of the TMR1H:TMR1L register pair. When a match occurs, one of the following events can occur: * * * * * Toggle the CCPx output Set the CCPx output Clear the CCPx output Generate an Auto-conversion Trigger Generate a Software Interrupt There are four prescaler settings specified by the CCPxMODE<3:0> bits of the CCPxCON register. Whenever the CCP module is turned off, or the CCP module is not in Capture mode, the prescaler counter is cleared. Any Reset will clear the prescaler counter. The action on the pin is based on the value of the CCPxMODE<3:0> control bits of the CCPxCON register. At the same time, the interrupt flag CCPxIF bit is set, and an ADC conversion can be triggered, if selected. Switching from one capture prescaler to another does not clear the prescaler and may generate a false interrupt. To avoid this unexpected operation, turn the module off by clearing the CCPxCON register before changing the prescaler. Example 28-1 demonstrates the code to perform this function. All Compare modes can generate an interrupt and trigger and ADC conversion. Figure 28-2 shows a simplified diagram of the compare operation. FIGURE 28-2: EXAMPLE 28-1: COMPARE MODE OPERATION BLOCK DIAGRAM CHANGING BETWEEN CAPTURE PRESCALERS CLRF MOVLW MOVWF ;Set Bank bits to point ;to CCPxCON CCPxCON ;Turn CCP module off NEW_CAPT_PS ;Load the W reg with ;the new prescaler ;move value and CCP ON CCPxCON ;Load CCPxCON with this ;value CCPxMODE<3:0> Mode Select BANKSEL CCPxCON Set CCPxIF Interrupt Flag (PIR6) 4 CCPRxH CCPRxL CCPx Pin Q S R Output Logic Match Comparator TMR1H TRIS Output Enable TMR1L Auto-conversion Trigger 2017 Microchip Technology Inc. Preliminary DS40001897A-page 301 PIC16(L)F15313/23 28.2.1 CCPX PIN CONFIGURATION 28.3 The software must configure the CCPx pin as an output by clearing the associated TRIS bit and defining the appropriate output pin through the RxyPPS registers. See Section 15.0 "Peripheral Pin Select (PPS) Module" for more details. The CCP output can also be used as an input for other peripherals. Note: 28.2.2 Clearing the CCPxCON register will force the CCPx compare output latch to the default low level. This is not the PORT I/O data latch. TIMER1 MODE RESOURCE In Compare mode, Timer1 must be running in either Timer mode or Synchronized Counter mode. The compare operation may not work in Asynchronous Counter mode. See Section 26.0 "Timer1 Module with Gate Control" for more information on configuring Timer1. Note: 28.2.3 Clocking Timer1 from the system clock (FOSC) should not be used in Compare mode. In order for Compare mode to recognize the trigger event on the CCPx pin, TImer1 must be clocked from the instruction clock (FOSC/4) or from an external clock source. AUTO-CONVERSION TRIGGER All CCPx modes set the CCP interrupt flag (CCPxIF). When this flag is set and a match occurs, an Auto-conversion Trigger can take place if the CCP module is selected as the conversion trigger source. Refer to Section 20.2.4 "Auto-Conversion Trigger" for more information. Note: 28.2.4 Removing the match condition by changing the contents of the CCPRxH and CCPRxL register pair, between the clock edge that generates the Auto-conversion Trigger and the clock edge that generates the Timer1 Reset, will preclude the Reset from occurring PWM Overview Pulse-Width Modulation (PWM) is a scheme that provides power to a load by switching quickly between fully on and fully off states. The PWM signal resembles a square wave where the high portion of the signal is considered the on state and the low portion of the signal is considered the off state. The high portion, also known as the pulse width, can vary in time and is defined in steps. A larger number of steps applied, which lengthens the pulse width, also supplies more power to the load. Lowering the number of steps applied, which shortens the pulse width, supplies less power. The PWM period is defined as the duration of one complete cycle or the total amount of on and off time combined. PWM resolution defines the maximum number of steps that can be present in a single PWM period. A higher resolution allows for more precise control of the pulse width time and in turn the power that is applied to the load. The term duty cycle describes the proportion of the on time to the off time and is expressed in percentages, where 0% is fully off and 100% is fully on. A lower duty cycle corresponds to less power applied and a higher duty cycle corresponds to more power applied. Figure 28-3 shows a typical waveform of the PWM signal. 28.3.1 STANDARD PWM OPERATION The standard PWM mode generates a Pulse-Width Modulation (PWM) signal on the CCPx pin with up to ten bits of resolution. The period, duty cycle, and resolution are controlled by the following registers: * * * * PR2 registers T2CON registers CCPRxL registers CCPxCON registers Figure 28-4 shows a simplified block diagram of PWM operation. Note: The corresponding TRIS bit must be cleared to enable the PWM output on the CCPx pin. FIGURE 28-3: COMPARE DURING SLEEP Since FOSC is shut down during Sleep mode, the Compare mode will not function properly during Sleep, unless the timer is running. The device will wake on interrupt (if enabled). CCP PWM OUTPUT SIGNAL Period Pulse Width TMR2 = PR2 TMR2 = CCPRxH:CCPRxL TMR2 = 0 2017 Microchip Technology Inc. Preliminary DS40001897A-page 302 PIC16(L)F15313/23 FIGURE 28-4: SIMPLIFIED PWM BLOCK DIAGRAM Rev. 10-000 157C 9/5/201 4 Duty cycle registers CCPRxH CCPRxL CCPx_out set CCPIF 10-bit Latch(2) (Not accessible by user) Comparator R PPS Q RxyPPS S TMR2 Module R TMR2 To Peripherals CCPx TRIS Control (1) ERS logic Comparator CCPx_pset PR2 28.3.2 SETUP FOR PWM OPERATION 6. Enable PWM output pin: * Wait until the Timer overflows and the TMR2IF bit of the PIR4 register is set. See Note below. * Enable the CCPx pin output driver by clearing the associated TRIS bit. The following steps should be taken when configuring the CCP module for standard PWM operation: 1. 2. 3. 4. 5. Use the desired output pin RxyPPS control to select CCPx as the source and disable the CCPx pin output driver by setting the associated TRIS bit. Load the PR2 register with the PWM period value. Configure the CCP module for the PWM mode by loading the CCPxCON register with the appropriate values. Load the CCPRxL register, and the CCPRxH register with the PWM duty cycle value and configure the CCPxFMT bit of the CCPxCON register to set the proper register alignment. Configure and start Timer2: * Clear the TMR2IF interrupt flag bit of the PIR4 register. See Note below. * Configure the CKPS bits of the T2CON register with the Timer prescale value. * Enable the Timer by setting the Timer2 ON bit of the T2CON register. 2017 Microchip Technology Inc. Note: 28.3.3 In order to send a complete duty cycle and period on the first PWM output, the above steps must be included in the setup sequence. If it is not critical to start with a complete PWM signal on the first output, then step 6 may be ignored. CCP/PWM CLOCK SELECTION The PIC16(L)F15313/23 allows each individual CCP and PWM module to select the timer source that controls the module. Each module has an independent selection. Preliminary DS40001897A-page 303 PIC16(L)F15313/23 28.3.4 TIMER2 TIMER RESOURCE FIGURE 28-5: This device has a newer version of the Timer2 module that has many new modes, which allow for greater customization and control of the PWM signals than on older parts. Refer to Section 27.5 "Operation Examples" for examples of PWM signal generation using the different modes of Timer2. The CCP operation requires that the timer used as the PWM time base has the FOSC/4 clock source selected 28.3.5 PWM 10-BIT ALIGNMENT Rev. 10-000 160A 12/9/201 3 CCPRxH CCPRxL 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 FMT = 1 CCPRxH CCPRxL 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 PWM PERIOD 10-bit Duty Cycle The PWM period is specified by the PR2 register of Timer2. The PWM period can be calculated using the formula of Equation 28-1. EQUATION 28-1: 9 8 7 6 5 4 3 2 1 0 EQUATION 28-2: PWM PERIOD T OSC (TMR2 Prescale Value) (TMR2 Prescale Value) TOSC = 1/FOSC When TMR2 is equal to PR2, the following three events occur on the next increment cycle: * TMR2 is cleared * The CCPx pin is set. (Exception: If the PWM duty cycle = 0%, the pin will not be set.) * The PWM duty cycle is transferred from the CCPRxL/H register pair into a 10-bit buffer. Note: 28.3.6 PULSE WIDTH Pulse Width = CCPRxH:CCPRxL register pair PWM Period = PR2 + 1 4 T OSC Note 1: FMT = 0 EQUATION 28-3: DUTY CYCLE RATIO CCPRxH:CCPRxL register pair Duty Cycle Ratio = ---------------------------------------------------------------------------------4 PR2 + 1 CCPRxH:CCPRxL register pair are used to double buffer the PWM duty cycle. This double buffering provides for glitchless PWM operation. The Timer postscaler (see Section 27.4 "Timer2 Interrupt") is not used in the determination of the PWM frequency. The 8-bit timer TMR2 register is concatenated with either the 2-bit internal system clock (FOSC), or two bits of the prescaler, to create the 10-bit time base. The system clock is used if the Timer2 prescaler is set to 1:1. PWM DUTY CYCLE When the 10-bit time base matches the CCPRxH:CCPRxL register pair, then the CCPx pin is cleared (see Figure 28-4). The PWM duty cycle is specified by writing a 10-bit value to the CCPRxH:CCPRxL register pair. The alignment of the 10-bit value is determined by the CCPRxFMT bit of the CCPxCON register (see Figure 28-5). The CCPRxH:CCPRxL register pair can be written to at any time; however the duty cycle value is not latched into the 10-bit buffer until after a match between PR2 and TMR2. Equation 28-2 is used to calculate the PWM pulse width. Equation 28-3 is used to calculate the PWM duty cycle ratio. 28.3.7 PWM RESOLUTION The resolution determines the number of available duty cycles for a given period. For example, a 10-bit resolution will result in 1024 discrete duty cycles, whereas an 8-bit resolution will result in 256 discrete duty cycles. The maximum PWM resolution is ten bits when PR2 is 255. The resolution is a function of the PR2 register value as shown by Equation 28-4. EQUATION 28-4: PWM RESOLUTION log 4 PR2 + 1 Resolution = ------------------------------------------ bits log 2 Note: 2017 Microchip Technology Inc. Preliminary If the pulse width value is greater than the period the assigned PWM pin(s) will remain unchanged. DS40001897A-page 304 PIC16(L)F15313/23 TABLE 28-2: EXAMPLE PWM FREQUENCIES AND RESOLUTIONS (FOSC = 20 MHz) PWM Frequency 1.22 kHz Timer Prescale PR2 Value 78.12 kHz 156.3 kHz 208.3 kHz 16 4 1 1 1 1 0xFF 0xFF 0x3F 0x1F 0x17 10 10 10 8 7 6.6 EXAMPLE PWM FREQUENCIES AND RESOLUTIONS (FOSC = 8 MHz) PWM Frequency 1.22 kHz 4.90 kHz 19.61 kHz 76.92 kHz 153.85 kHz 200.0 kHz 16 4 1 1 1 1 0x65 0x65 0x65 0x19 0x0C 0x09 8 8 8 6 5 5 Timer Prescale PR2 Value Maximum Resolution (bits) 28.3.8 19.53 kHz 0xFF Maximum Resolution (bits) TABLE 28-3: 4.88 kHz OPERATION IN SLEEP MODE In Sleep mode, the TMR2 register will not increment and the state of the module will not change. If the CCPx pin is driving a value, it will continue to drive that value. When the device wakes up, TMR2 will continue from its previous state. 28.3.9 CHANGES IN SYSTEM CLOCK FREQUENCY The PWM frequency is derived from the system clock frequency. Any changes in the system clock frequency will result in changes to the PWM frequency. See Section 9.0 "Oscillator Module (with Fail-Safe Clock Monitor)" for additional details. 28.3.10 EFFECTS OF RESET Any Reset will force all ports to Input mode and the CCP registers to their Reset states. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 305 PIC16(L)F15313/23 28.4 Register Definitions: CCP Control Long bit name prefixes for the CCP peripherals are shown in Section 1.1 "Register and Bit Naming Conventions". TABLE 28-4: LONG BIT NAMES PREFIXES FOR CCP PERIPHERALS Peripheral Bit Name Prefix CCP1 CCP1 CCP2 CCP2 REGISTER 28-1: CCPxCON: CCPx CONTROL REGISTER R/W-0/0 U-0 R-x R/W-0/0 EN -- OUT FMT R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 MODE<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Reset `1' = Bit is set `0' = Bit is cleared bit 7 EN: CCPx Module Enable bit 1 = CCPx is enabled 0 = CCPx is disabled bit 6 Unimplemented: Read as `0' bit 5 OUT: CCPx Output Data bit (read-only) bit 4 FMT: CCPW (Pulse Width) Alignment bit MODE = Capture mode Unused MODE = Compare mode Unused MODE = PWM mode 1 = Left-aligned format 0 = Right-aligned format 2017 Microchip Technology Inc. Preliminary DS40001897A-page 306 PIC16(L)F15313/23 REGISTER 28-1: bit 3-0 Note 1: CCPxCON: CCPx CONTROL REGISTER (CONTINUED) MODE<3:0>: CCPx Mode Select bits(1) 1111 - 1100 = PWM mode (Timer2 as the timer source) 1110 = Reserved 1101 = Reserved 1100 = Reserved 1011 = 1010 = 1001 = 1000 = Compare mode: output will pulse 0-1-0; Clears TMR1 Compare mode: output will pulse 0-1-0 Compare mode: clear output on compare match Compare mode: set output on compare match 0111 = 0110 = 0101 = 0100 = Capture mode: every 16th rising edge of CCPx input Capture mode: every 4th rising edge of CCPx input Capture mode: every rising edge of CCPx input Capture mode: every falling edge of CCPx input 0011 = 0010 = 0001 = 0000 = Capture mode: every edge of CCPx input Compare mode: toggle output on match Compare mode: toggle output on match; clear TMR1 Capture/Compare/PWM off (resets CCPx module) All modes will set the CCPxIF bit, and will trigger an ADC conversion if CCPx is selected as the ADC trigger source. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 307 PIC16(L)F15313/23 REGISTER 28-2: CCPxCAP: CAPTURE INPUT SELECTION REGISTER U-0 U-0 U-0 U-0 U-0 -- -- -- -- -- R/W-0/x R/W-0/x R/W-0/x CTS<2:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Reset `1' = Bit is set `0' = Bit is cleared bit 7-3 Unimplemented: Read as `0' bit 2-0 CTS<2:0>: Capture Trigger Input Selection bits CTS CCP1.capture 111 LC4_out 110 LC3_out 101 LC2_out 100 LC1_out 011 IOC_interrupt 010 C2OUT 001 C1OUT CCP1PPS 000 REGISTER 28-3: R/W-x/x CCP2.capture CCP2PPS CCPRxL REGISTER: CCPx REGISTER LOW BYTE R/W-x/x R/W-x/x R/W-x/x R/W-x/x R/W-x/x R/W-x/x R/W-x/x CCPRx<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Reset `1' = Bit is set `0' = Bit is cleared bit 7-0 CCPxMODE = Capture mode CCPRxL<7:0>: Capture value of TMR1L CCPxMODE = Compare mode CCPRxL<7:0>: LS Byte compared to TMR1L CCPxMODE = PWM modes when CCPxFMT = 0: CCPRxL<7:0>: Pulse-width Least Significant eight bits CCPxMODE = PWM modes when CCPxFMT = 1: CCPRxL<7:6>: Pulse-width Least Significant two bits CCPRxL<5:0>: Not used. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 308 PIC16(L)F15313/23 REGISTER 28-4: R/W-x/x CCPRxH REGISTER: CCPx REGISTER HIGH BYTE R/W-x/x R/W-x/x R/W-x/x R/W-x/x R/W-x/x R/W-x/x R/W-x/x CCPRx<15:8> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Reset `1' = Bit is set `0' = Bit is cleared bit 7-0 CCPxMODE = Capture mode CCPRxH<7:0>: Captured value of TMR1H CCPxMODE = Compare mode CCPRxH<7:0>: MS Byte compared to TMR1H CCPxMODE = PWM modes when CCPxFMT = 0: CCPRxH<7:2>: Not used CCPRxH<1:0>: Pulse-width Most Significant two bits CCPxMODE = PWM modes when CCPxFMT = 1: CCPRxH<7:0>: Pulse-width Most Significant eight bits 2017 Microchip Technology Inc. Preliminary DS40001897A-page 309 PIC16(L)F15313/23 TABLE 28-5: Name SUMMARY OF REGISTERS ASSOCIATED WITH CCPx Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 GIE PEIE -- -- -- -- -- -- -- -- PIE4 -- -- -- -- -- CCP1CON EN -- OUT FMT CCP1CAP -- -- -- -- INTCON PIR4 CCPR1L Capture/Compare/PWM Register 1 (LSB) CCPR1H Capture/Compare/PWM Register 1 (MSB) -- OUT FMT CCP2CAP -- -- -- -- CCPR2H Capture/Compare/PWM Register 1 (MSB) -- -- INTEDG 121 -- TMR2IF TMR1IF 134 -- TMR2IE TMR1IE 126 MODE<3:0> -- CTS<2:0> 306 308 309 EN Capture/Compare/PWM Register 1 (LSB) Bit 0 308 CCP2CON CCPR2L Register on Page Bit 1 MODE<3:0> -- CTS<2:0> 306 308 308 308 CCP1PPS -- -- CCP1PPS<5:0> 191 CCP2PPS -- -- CCP2PPS<5:0> 191 RxyPPS -- -- -- RxyPPS<4:0> 192 ADACT -- -- -- ADACT<4:0> 225 CLCxSELy -- -- -- LCxDyS<4:0> 352 -- -- -- CWG1ISM Legend: -- IS<3:0> 341 -- = Unimplemented location, read as `0'. Shaded cells are not used by the CCP module. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 310 PIC16(L)F15313/23 29.0 PULSE-WIDTH MODULATION (PWM) The PWMx modules generate Pulse-Width Modulated (PWM) signals of varying frequency and duty cycle. In addition to the CCP modules, the PIC16(L)F15313/23 devices contain four 10-bit PWM modules (PWM3, PWM4, PWM5 and PWM6). The PWM modules reproduce the PWM capability of the CCP modules. FIGURE 29-1: Q1 PWM OUTPUT Q2 Q3 Q4 Rev. 10-000023C 8/26/2015 FOSC PWM Pulse Width TMRx = 0 TMRx = PWMxDC Note: The PWM3/4/5/6 modules are four instances of the same PWM module design. Throughout this section, the lower case `x' in register and bit names is a generic reference to the PWM module number (which should be substituted with 3, or 4, or, 5 or 6 during code development). For example, the control register is generically described in this chapter as PWMxCON, but the actual device registers are PWM3CON, PWM4CON, PWM5CON and PWM6CON. Similarly, the PWMxEN bit represents the PWM3EN, PWM4EN, PWM5EN and PWM6EN bits. TMRx = PRx (1) (1) (1) Note 1: Timer dependent on PWMTMRS register settings. Pulse-Width Modulation (PWM) is a scheme that provides power to a load by switching quickly between fully on and fully off states. The PWM signal resembles a square wave where the high portion of the signal is considered the `on' state (pulse width), and the low portion of the signal is considered the `off' state. The term duty cycle describes the proportion of the `on' time to the `off' time and is expressed in percentages, where 0% is fully off and 100% is fully on. A lower duty cycle corresponds to less power applied and a higher duty cycle corresponds to more power applied. The PWM period is defined as the duration of one complete cycle or the total amount of on and off time combined. PWM resolution defines the maximum number of steps that can be present in a single PWM period. A higher resolution allows for more precise control of the pulse width time and, in turn, the power that is applied to the load. Figure 29-1 shows a typical waveform of the PWM signal. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 311 PIC16(L)F15313/23 29.1 Standard PWM Mode The standard PWM mode generates a Pulse-Width Modulation (PWM) signal on the PWMx pin with up to ten bits of resolution. The period, duty cycle, and resolution are controlled by the following registers: * * * * * TMR2 register PR2 register PWMxCON registers PWMxDCH registers PWMxDCL registers Figure 29-2 shows a simplified block diagram of PWM operation. If PWMPOL = 0, the default state of the output is `0`. If PWMPOL = 1, the default state is `1'. If PWMEN = 0, the output will be the default state. Note: The corresponding TRIS bit must be cleared to enable the PWM output on the PWMx pin FIGURE 29-2: SIMPLIFIED PWM BLOCK DIAGRAM Rev. 10-000022B 9/24/2014 PWMxDCL<7:6> Duty cycle registers PWMxDCH PWMx_out 10-bit Latch (Not visible to user) R Comparator Q 0 1 S To Peripherals PPS PWMx Q TMR2 Module TMR2 Comparator R PWMxPOL (1) RxyPPS TRIS Control T2_match PR2 Note 1: 8-bit timer is concatenated with two bits generated by Fosc or two bits of the internal prescaler to create 10-bit time-base. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 312 PIC16(L)F15313/23 29.1.1 PWM CLOCK SELECTION 29.1.4 The PIC16(L)F15313/23 allows each individual CCP and PWM module to select the timer source that controls the module. Each module has an independent selection. 29.1.2 USING THE TMR2 WITH THE PWM MODULE This device has a newer version of the TMR2 module that has many new modes, which allow for greater customization and control of the PWM signals than on older parts. Refer to Section 27.5 "Operation Examples" for examples of PWM signal generation using the different modes of Timer2. Note: 29.1.3 PWM operation requires that the timer used as the PWM time base has the FOSC/4 clock source selected. PWM PERIOD The PWM duty cycle is specified by writing a 10-bit value to the PWMxDC register. The PWMxDCH contains the eight MSbs and the PWMxDCL<7:6> bits contain the two LSbs. The PWMDC register is double-buffered and can be updated at any time. This double buffering is essential for glitch-free PWM operation. New values take effect when TMR2 = PR2. Note that PWMDC is left-justified. The 8-bit timer TMR2 register is concatenated with either the 2-bit internal system clock (FOSC), or two bits of the prescaler, to create the 10-bit time base. The system clock is used if the Timer2 prescaler is set to 1:1. Equation 29-2 is used to calculate the PWM pulse width. Equation 29-3 is used to calculate the PWM duty cycle ratio. EQUATION 29-2: Referring to Figure 29-1, the PWM output has a period and a pulse width. The frequency of the PWM is the inverse of the period (1/period). The PWM period is specified by writing to the PR2 register. The PWM period can be calculated using the following formula: EQUATION 29-1: PWM DUTY CYCLE Pulse Width EQUATION 29-3: 29.1.5 Note 1: TOSC = 1/FOSC When TMR2 is equal to PR2, the following three events occur on the next increment cycle: * TMR2 is cleared * The PWMx pin is set (Exception: If the PWM duty cycle = 0%, the pin will not be set.) * The PWM pulse width is latched from PWMxDC. PWM RESOLUTION The resolution determines the number of available duty cycles for a given period. For example, a 10-bit resolution will result in 1024 discrete duty cycles, whereas an 8-bit resolution will result in 256 discrete duty cycles. The maximum PWM resolution is ten bits when PR2 is 255. The resolution is a function of the PR2 register value as shown by Equation 29-4. EQUATION 29-4: If the pulse width value is greater than the period the assigned PWM pin(s) will remain unchanged. 2017 Microchip Technology Inc. DUTY CYCLE RATIO PWM PERIOD Note: PULSE WIDTH Preliminary PWM RESOLUTION log 4 PR2 + 1 Resolution = ------------------------------------------ bits log 2 DS40001897A-page 313 PIC16(L)F15313/23 29.1.6 OPERATION IN SLEEP MODE 29.1.8 In Sleep mode, the TMR2 register will not increment and the state of the module will not change. If the PWMx pin is driving a value, it will continue to drive that value. When the device wakes up, TMR2 will continue from its previous state. 29.1.7 EFFECTS OF RESET Any Reset will force all ports to Input mode and the PWMx registers to their Reset states. CHANGES IN SYSTEM CLOCK FREQUENCY The PWM frequency is derived from the system clock frequency. Any changes in the system clock frequency will result in changes to the PWM frequency. See Section 9.0 "Oscillator Module (with Fail-Safe Clock Monitor)" for additional details. TABLE 29-1: EXAMPLE PWM FREQUENCIES AND RESOLUTIONS (FOSC = 20 MHz) PWM Frequency Timer Prescale PR2 Value Maximum Resolution (bits) TABLE 29-2: 4.88 kHz 19.53 kHz 78.12 kHz 156.3 kHz 208.3 kHz 16 4 1 1 1 1 0xFF 0xFF 0xFF 0x3F 0x1F 0x17 10 10 10 8 7 6.6 EXAMPLE PWM FREQUENCIES AND RESOLUTIONS (FOSC = 8 MHz) PWM Frequency Timer Prescale PR2 Value Maximum Resolution (bits) 29.1.9 1.22 kHz 1.22 kHz 4.90 kHz 19.61 kHz 76.92 kHz 153.85 kHz 200.0 kHz 16 4 1 1 1 1 0xFF 0xFF 0xFF 0x3F 0x1F 0x17 10 10 10 8 7 6.6 SETUP FOR PWM OPERATION The following steps should be taken when configuring the module for using the PWMx outputs: 1. Disable the PWMx pin output driver(s) by setting the associated TRIS bit(s). 2. Configure the PWM output polarity by configuring the PWMxPOL bit of the PWMxCON register. 3. Load the PR2 register with the PWM period value, as determined by Equation 29-1. 4. Load the PWMxDCH register and bits <7:6> of the PWMxDCL register with the PWM duty cycle value, as determined by Equation 29-2. 5. Configure and start Timer2: * Clear the TMR2IF interrupt flag bit of the PIR4 register. * Select the Timer2 prescale value by configuring the CKPS<2:0> bits of the T2CON register. * Enable Timer2 by setting the Timer2 ON bit of the T2CON register. 2017 Microchip Technology Inc. 6. Wait until the TMR2IF is set. 7. When the TMR2IF flag bit is set: * Clear the associated TRIS bit(s) to enable the output driver. * Route the signal to the desired pin by configuring the RxyPPS register. * Enable the PWMx module by setting the PWMxEN bit of the PWMxCON register. In order to send a complete duty cycle and period on the first PWM output, the above steps must be followed in the order given. If it is not critical to start with a complete PWM signal, then the PWM module can be enabled during Step 2 by setting the PWMxEN bit of the PWMxCON register. Preliminary DS40001897A-page 314 PIC16(L)F15313/23 29.2 Register Definitions: PWM Control REGISTER 29-1: PWMxCON: PWM CONTROL REGISTER R/W-0/0 U-0 R-0 R/W-0/0 U-0 U-0 U-0 U-0 PWMxEN -- PWMxOUT PWMxPOL -- -- -- -- bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 PWMxEN: PWM Module Enable bit 1 = PWM module is enabled 0 = PWM module is disabled bit 6 Unimplemented: Read as `0' bit 5 PWMxOUT: PWM Module Output Level when Bit is Read bit 4 PWMxPOL: PWMx Output Polarity Select bit 1 = PWM output is active-low 0 = PWM output is active-high bit 3-0 Unimplemented: Read as `0' 2017 Microchip Technology Inc. Preliminary DS40001897A-page 315 PIC16(L)F15313/23 REGISTER 29-2: R/W-x/u PWMxDCH: PWM DUTY CYCLE HIGH BITS R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u PWMxDC<9:2> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 PWMxDC<9:2>: PWM Duty Cycle Most Significant bits These bits are the MSbs of the PWM duty cycle. The two LSbs are found in PWMxDCL Register. REGISTER 29-3: R/W-x/u PWMxDCL: PWM DUTY CYCLE LOW BITS R/W-x/u PWMxDC<1:0> U-0 U-0 U-0 U-0 U-0 U-0 -- -- -- -- -- -- bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 PWMxDC<1:0>: PWM Duty Cycle Least Significant bits These bits are the LSbs of the PWM duty cycle. The MSbs are found in PWMxDCH Register. bit 5-0 Unimplemented: Read as `0' 2017 Microchip Technology Inc. Preliminary DS40001897A-page 316 PIC16(L)F15313/23 TABLE 29-3: Name T2CON SUMMARY OF REGISTERS ASSOCIATED WITH PWMx Bit 7 Bit 6 ON Bit 5 Bit 4 Bit 3 Bit 2 CKPS<2:0> Bit 1 Bit 0 OUTPS<3:0> T2TMR Holding Register for the 8-bit TMR2 Register T2PR TMR2 Period Register Register on Page 295 280* 280* RxyPPS -- -- RxyPPS<4:0> -- 192 CWG1ISM -- -- CLCxSELy -- -- IS<3:0> 341 TRISA -- -- TRISA5 TRISA4 -- TRISA2 TRISA1 TRISA0 175 TRISC(1) -- -- TRISC5 TRISC4 TRISC3 TRISC2 TRISC1 TRISC0 181 LCxDyS<5:0> 352 Legend: - = Unimplemented locations, read as `0'. Shaded cells are not used by the PWMx module. * Page with Register information. Note 1: Present on PIC16(L)F15323 only. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 317 PIC16(L)F15313/23 30.0 COMPLEMENTARY WAVEFORM GENERATOR (CWG) MODULE The Complementary Waveform Generator (CWG) produces half-bridge, full-bridge, and steering of PWM waveforms. It is backwards compatible with previous ECCP functions. The CWG has the following features: * Six operating modes: - Synchronous Steering mode - Asynchronous Steering mode - Full-Bridge mode, Forward - Full-Bridge mode, Reverse - Half-Bridge mode - Push-Pull mode * Output polarity control * Output steering - Synchronized to rising event - Immediate effect * Independent 6-bit rising and falling event deadband timers - Clocked dead band - Independent rising and falling dead-band enables * Auto-shutdown control with: - Selectable shutdown sources - Auto-restart enable - Auto-shutdown pin override control 30.1 Fundamental Operation The CWG module can operate in six different modes, as specified by MODE of the CWG1CON0 register: * Half-Bridge mode (Figure 30-9) * Push-Pull mode (Figure 30-2) - Full-Bridge mode, Forward (Figure 30-3) - Full-Bridge mode, Reverse (Figure 30-3) * Steering mode (Figure 30-10) * Synchronous Steering mode (Figure 30-11) It may be necessary to guard against the possibility of circuit faults or a feedback event arriving too late or not at all. In this case, the active drive must be terminated before the Fault condition causes damage. Thus, all output modes support auto-shutdown, which is covered in 30.10 "Auto-Shutdown". 30.1.1 HALF-BRIDGE MODE In Half-Bridge mode, two output signals are generated as true and inverted versions of the input as illustrated in Figure 30-9. A non-overlap (dead-band) time is inserted between the two outputs as described in Section 30.5 "Dead-Band Control". The unused outputs CWG1C and CWG1D drive similar signals, with polarity independently controlled by the POLC and POLD bits of the CWG1CON1 register, respectively. The CWG modules available are shown in Table 30-1. TABLE 30-1: AVAILABLE CWG MODULES Device PIC16(L)F15313/23 2017 Microchip Technology Inc. CWG1 Preliminary DS40001897A-page 318 2017 Microchip Technology Inc. FIGURE 30-1: SIMPLIFIED CWG BLOCK DIAGRAM (HALF-BRIDGE MODE) Rev. 10-000166B 8/29/2014 CWG_data Rising Deadband Block See CWGxISM Register CWG_dataA clock signal_out CWG_dataC signal_in Preliminary D Q CWGxISM<3:0> E R Q Falling Deadband Block CWG_dataB clock signal_out signal_in SHUTDOWN HFINTOSC 1 FOSC 0 CWGxCLK<0> DS40001897A-page 319 PIC16(L)F15313/23 EN CWG_dataD PIC16(L)F15313/23 30.1.2 PUSH-PULL MODE In Push-Pull mode, two output signals are generated, alternating copies of the input as illustrated in Figure 30-2. This alternation creates the push-pull effect required for driving some transformer-based power supply designs. The push-pull sequencer is reset whenever EN = 0 or if an auto-shutdown event occurs. The sequencer is clocked by the first input pulse, and the first output appears on CWG1A. The unused outputs CWG1C and CWG1D drive copies of CWG1A and CWG1B, respectively, but with polarity controlled by the POLC and POLD bits of the CWG1CON1 register, respectively. 30.1.3 FULL-BRIDGE MODES In Forward and Reverse Full-Bridge modes, three outputs drive static values while the fourth is modulated by the input data signal. In Forward Full-Bridge mode, CWG1A is driven to its active state, CWG1B and CWG1C are driven to their inactive state, and CWG1D is modulated by the input signal. In Reverse Full-Bridge mode, CWG1C is driven to its active state, CWG1A and CWG1D are driven to their inactive states, and CWG1B is modulated by the input signal. In Full-Bridge mode, the dead-band period is used when there is a switch from forward to reverse or vice-versa. This dead-band control is described in Section 30.5 "Dead-Band Control", with additional details in Section 30.6 "Rising Edge and Reverse Dead Band" and Section 30.7 "Falling Edge and Forward Dead Band". The mode selection may be toggled between forward and reverse toggling the MODE<0> bit of the CWG1CON0 while keeping MODE<2:1> static, without disabling the CWG module. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 320 2017 Microchip Technology Inc. FIGURE 30-2: SIMPLIFIED CWG BLOCK DIAGRAM (PUSH-PULL MODE) Rev. 10-000167B 8/29/2014 CWG_data See CWGxISM Register D Q CWG_dataA Q CWG_dataC R CWG_dataB Preliminary D Q E Q CWG_dataD CWGxISM<3:0> R EN DS40001897A-page 321 PIC16(L)F15313/23 SHUTDOWN 2017 Microchip Technology Inc. FIGURE 30-3: SIMPLIFIED CWG BLOCK DIAGRAM (FORWARD AND REVERSE FULL-BRIDGE MODES) Rev. 10-000165B 8/29/2014 Reverse Deadband Block MODE0 clock signal_out See CWGxISM Register signal_in CWG_dataA D D Q Q CWG_dataB Q CWG_dataC CWGxISM<3:0> Preliminary E R CWG_dataD Q clock signal_out signal_in Forward Deadband Block EN CWG_data SHUTDOWN FOSC CWGxCLK<0> 1 0 DS40001897A-page 322 PIC16(L)F15313/23 HFINTOSC PIC16(L)F15313/23 30.1.4 STEERING MODES In Steering modes, the data input can be steered to any or all of the four CWG output pins. In Synchronous Steering mode, changes to steering selection registers take effect on the next rising input. In Non-Synchronous mode, steering takes effect on the next instruction cycle. Additional details are provided in Section 30.9 "CWG Steering Mode". FIGURE 30-4: SIMPLIFIED CWG BLOCK DIAGRAM (OUTPUT STEERING MODES) Rev. 10-000164B 8/26/2015 See CWGxISM Register CWG_dataA CWG_data CWG_dataB CWG_dataC CWG_dataD D Q CWGxISM <3:0> E R Q EN SHUTDOWN 30.2 Clock Source The CWG module allows the following clock sources to be selected: * Fosc (system clock) * HFINTOSC (16 MHz only) The clock sources are selected using the CS bit of the CWG1CLKCON register. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 323 PIC16(L)F15313/23 30.3 Selectable Input Sources 30.4 The CWG generates the output waveforms from the input sources in Table 30-2. TABLE 30-2: SELECTABLE INPUT SOURCES Source Peripheral Signal Name CWG input PPS pin CWG1IN PPS CCP1 CCP1_out CCP2 CCP2_out PWM3 PWM3_out PWM4 PWM4_out PWM5 PWM5_out PWM6 PWM6_out NCO NCO1_out Comparator C1 C1OUT_sync Comparator C2 C2OUT_sync CLC1 LC1_out CLC2 LC2_out CLC3 LC3_out CLC4 LC4_out 30.4.1 Output Control POLARITY CONTROL The polarity of each CWG output can be selected independently. When the output polarity bit is set, the corresponding output is active-high. Clearing the output polarity bit configures the corresponding output as active-low. However, polarity does not affect the override levels. Output polarity is selected with the POLx bits of the CWG1CON1. Auto-shutdown and steering options are unaffected by polarity. The input sources are selected using the CWG1ISM register. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 324 PIC16(L)F15313/23 FIGURE 30-5: CWG OUTPUT BLOCK DIAGRAM Rev. 10-000171B 9/24/2014 LSAC<1:0> CWG_dataA 1 POLA OVRA `1' 11 `0' 10 High Z 01 00 0 RxyPPS TRIS Control 1 0 PPS CWGxA STRA(1) LSBD<1:0> CWG_dataB 1 POLB OVRB `1' 11 `0' 10 High Z 01 00 0 RxyPPS TRIS Control 1 0 CWGxB PPS STRB(1) LSAC<1:0> CWG_dataC 1 POLC OVRC `1' 11 `0' 10 High Z 01 00 0 RxyPPS TRIS Control 1 0 CWGxC PPS STRC(1) LSBD<1:0> CWG_dataD 1 POLD OVRD `1' 11 `0' 10 High Z 01 00 0 RxyPPS TRIS Control 1 0 PPS CWGxD STRD(1) CWG_shutdown Note 1: 2017 Microchip Technology Inc. STRx is held to 1 in all modes other than Output Steering Mode. Preliminary DS40001897A-page 325 PIC16(L)F15313/23 30.5 Dead-Band Control 30.6 The dead-band control provides non-overlapping PWM signals to prevent shoot-through current in PWM switches. Dead-band operation is employed for HalfBridge and Full-Bridge modes. The CWG contains two 6-bit dead-band counters. One is used for the rising edge of the input source control in Half-Bridge mode or for reverse dead-band Full-Bridge mode. The other is used for the falling edge of the input source control in Half-Bridge mode or for forward dead band in FullBridge mode. Dead band is timed by counting CWG clock periods from zero up to the value in the rising or falling deadband counter registers. See CWG1DBR and CWG1DBF registers, respectively. 30.5.1 DEAD-BAND FUNCTIONALITY IN HALF-BRIDGE MODE In Half-Bridge mode, the dead-band counters dictate the delay between the falling edge of the normal output and the rising edge of the inverted output. This can be seen in Figure 30-9. 30.5.2 DEAD-BAND FUNCTIONALITY IN FULL-BRIDGE MODE In Full-Bridge mode, the dead-band counters are used when undergoing a direction change. The MODE<0> bit of the CWG1CON0 register can be set or cleared while the CWG is running, allowing for changes from Forward to Reverse mode. The CWG1A and CWG1C signals will change upon the first rising input edge following a direction change, but the modulated signals (CWG1B or CWG1D, depending on the direction of the change) will experience a delay dictated by the deadband counters. This is demonstrated in Figure 30-3. 2017 Microchip Technology Inc. Rising Edge and Reverse Dead Band CWG1DBR controls the rising edge dead-band time at the leading edge of CWG1A (Half-Bridge mode) or the leading edge of CWG1B (Full-Bridge mode). The CWG1DBR value is double-buffered. When EN = 0, the CWG1DBR register is loaded immediately when CWG1DBR is written. When EN = 1, then software must set the LD bit of the CWG1CON0 register, and the buffer will be loaded at the next falling edge of the CWG input signal. If the input source signal is not present for enough time for the count to be completed, no output will be seen on the respective output. 30.7 Falling Edge and Forward Dead Band CWG1DBF controls the dead-band time at the leading edge of CWG1B (Half-Bridge mode) or the leading edge of CWG1D (Full-Bridge mode). The CWG1DBF value is double-buffered. When EN = 0, the CWG1DBF register is loaded immediately when CWG1DBF is written. When EN = 1 then software must set the LD bit of the CWG1CON0 register, and the buffer will be loaded at the next falling edge of the CWG input signal. If the input source signal is not present for enough time for the count to be completed, no output will be seen on the respective output. Refer to Figure 30-6 and Figure 30-7 for examples. Preliminary DS40001897A-page 326 2017 Microchip Technology Inc. FIGURE 30-6: DEAD-BAND OPERATION CWG1DBR = 0X01, CWG1DBF = 0X02 cwg_clock Input Source CWG1A CWG1B Preliminary FIGURE 30-7: DEAD-BAND OPERATION, CWG1DBR = 0X03, CWG1DBF = 0X04, SOURCE SHORTER THAN DEAD BAND Input Source CWG1A CWG1B source shorter than dead band DS40001897A-page 327 PIC16(L)F15313/23 cwg_clock PIC16(L)F15313/23 30.8 EQUATION 30-1: Dead-Band Uncertainty When the rising and falling edges of the input source are asynchronous to the CWG clock, it creates uncertainty in the dead-band time delay. The maximum uncertainty is equal to one CWG clock period. Refer to Equation 30-1 for more details. DEAD-BAND UNCERTAINTY 1 TDEADBAND_UNCERTAINTY = ----------------------------Fcwg_clock Example: FCWG_CLOCK = 16 MHz Therefore: 1 TDEADBAND_UNCERTAINTY = ----------------------------Fcwg_clock 1 = -----------------16MHz = 62.5ns FIGURE 30-8: EXAMPLE OF PWM DIRECTION CHANGE MODE0 CWG1A CWG1B CWG1C CWG1D No delay CWG1DBR No delay CWG1DBF CWG1_data Note 1: 2: 3: WGPOL{ABCD} = 0 The direction bit MODE<0> (Register 30-1) can be written any time during the PWM cycle, and takes effect at the next rising CWG1_data. When changing directions, CWG1A and CWG1C switch at rising CWG1_data; modulated CWG1B and CWG1D are held inactive for the dead band duration shown; dead band affects only the first pulse after the direction change. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 328 PIC16(L)F15313/23 FIGURE 30-9: CWG HALF-BRIDGE MODE OPERATION CWG1_clock CWG1A CWG1C Falling Event Dead Band Rising Event Dead Band Rising Event D Falling Event Dead Band CWG1B CWG1D CWG1_data Note: CWG1_rising_src = CCP1_out, CWG1_falling_src = ~CCP1_out 2017 Microchip Technology Inc. Preliminary DS40001897A-page 329 PIC16(L)F15313/23 30.9 30.9.1 CWG Steering Mode In Steering mode (MODE = 00x), the CWG allows any combination of the CWG1x pins to be the modulated signal. The same signal can be simultaneously available on multiple pins, or a fixed-value output can be presented. When the respective STRx bit of CWG1OCON0 is `0', the corresponding pin is held at the level defined. When the respective STRx bit of CWG1OCON0 is `1', the pin is driven by the input data signal. The user can assign the input data signal to one, two, three, or all four output pins. The POLx bits of the CWG1CON1 register control the signal polarity only when STRx = 1. The CWG auto-shutdown operation also applies in Steering modes as described in Section 30.10 "AutoShutdown". An auto-shutdown event will only affect pins that have STRx = 1. FIGURE 30-10: STEERING SYNCHRONIZATION Changing the MODE bits allows for two modes of steering, synchronous and asynchronous. When MODE = 000, the steering event is asynchronous and will happen at the end of the instruction that writes to STRx (that is, immediately). In this case, the output signal at the output pin may be an incomplete waveform. This can be useful for immediately removing a signal from the pin. When MODE = 001, the steering update is synchronous and occurs at the beginning of the next rising edge of the input data signal. In this case, steering the output on/off will always produce a complete waveform. Figure 30-10 and Figure 30-11 illustrate the timing of asynchronous and synchronous steering, respectively. EXAMPLE OF ASYNCHRONOUS STEERING EVENT (MODE<2:0> = 000) Rising Event CWG1_data (Rising and Falling Source) STR CWG1 OVR Data OVR follows CWG1_data FIGURE 30-11: EXAMPLE OF STEERING EVENT (MODE<2:0> = 001) CWG1_data (Rising and Falling Source) STR CWG1 OVR Data OVR Data follows CWG1_data 2017 Microchip Technology Inc. Preliminary DS40001897A-page 330 PIC16(L)F15313/23 30.10 Auto-Shutdown 30.11 Operation During Sleep Auto-shutdown is a method to immediately override the CWG output levels with specific overrides that allow for safe shutdown of the circuit. The shutdown state can be either cleared automatically or held until cleared by software. The auto-shutdown circuit is illustrated in Figure 30-12. The CWG module operates independently from the system clock and will continue to run during Sleep, provided that the clock and input sources selected remain active. 30.10.1 * CWG module is enabled * Input source is active * HFINTOSC is selected as the clock source, regardless of the system clock source selected. SHUTDOWN The shutdown state can be entered by either of the following two methods: * Software generated * External Input 30.10.1.1 Software Generated Shutdown Setting the SHUTDOWN bit of the CWG1AS0 register will force the CWG into the shutdown state. When the auto-restart is disabled, the shutdown state will persist as long as the SHUTDOWN bit is set. The HFINTOSC remains active during Sleep when all the following conditions are met: In other words, if the HFINTOSC is simultaneously selected as the system clock and the CWG clock source, when the CWG is enabled and the input source is active, then the CPU will go idle during Sleep, but the HFINTOSC will remain active and the CWG will continue to operate. This will have a direct effect on the Sleep mode current. When auto-restart is enabled, the SHUTDOWN bit will clear automatically and resume operation on the next rising edge event. 30.10.2 EXTERNAL INPUT SOURCE External shutdown inputs provide the fastest way to safely suspend CWG operation in the event of a Fault condition. When any of the selected shutdown inputs goes active, the CWG outputs will immediately go to the selected override levels without software delay. Several input sources can be selected to cause a shutdown condition. All input sources are active-low. The sources are: * * * * Comparator C1OUT_sync Comparator C2OUT_sync Timer2 - TMR2_postscaled CWG1IN input pin Shutdown inputs are selected using the CWG1AS1 register (Register 30-6). Note: Shutdown inputs are level sensitive, not edge sensitive. The shutdown state cannot be cleared, except by disabling autoshutdown, as long as the shutdown input level persists. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 331 2017 Microchip Technology Inc. FIGURE 30-12: CWG SHUTDOWN BLOCK DIAGRAM Write `1' to SHUTDOWN bit Rev. 10-000172F 3/14/2017 PPS INAS CWGxINPPS C1OUT_sync C1AS C2OUT_sync C2AS TMR2_postscaled TMR2AS S Q SHUTDOWN S D FREEZE REN Write `0' to SHUTDOWN bit Q CWG_shutdown R CWG_data CK Preliminary PIC16(L)F15313/23 DS40001897A-page 332 PIC16(L)F15313/23 30.12 Configuring the CWG 30.12.2 The following steps illustrate how to properly configure the CWG. After an auto-shutdown event has occurred, there are two ways to resume operation: 1. * Software controlled * Auto-restart 2. 3. 4. 5. Ensure that the TRIS control bits corresponding to the desired CWG pins for your application are set so that the pins are configured as inputs. Clear the EN bit, if not already cleared. Set desired mode of operation with the MODE bits. Set desired dead-band times, if applicable to mode, with the CWG1DBR and CWG1DBF registers. Setup the following controls in the CWG1AS0 and CWG1AS1 registers. a. Select the desired shutdown source. b. Select both output overrides to the desired levels (this is necessary even if not using autoshutdown because start-up will be from a shutdown state). c. Set which pins will be affected by auto-shutdown with the CWG1AS1 register. d. Set the SHUTDOWN bit and clear the REN bit. 6. 7. Select the desired input source using the CWG1ISM register. Configure the following controls. a. Select desired clock source CWG1CLKCON register. using the AUTO-SHUTDOWN RESTART The restart method is selected with the REN bit of the CWG1CON2 register. Waveforms of software controlled and automatic restarts are shown in Figure 30-13 and Figure 30-14. 30.12.2.1 Software Controlled Restart When the REN bit of the CWG1AS0 register is cleared, the CWG must be restarted after an auto-shutdown event by software. Clearing the shutdown state requires all selected shutdown inputs to be low, otherwise the SHUTDOWN bit will remain set. The overrides will remain in effect until the first rising edge event after the SHUTDOWN bit is cleared. The CWG will then resume operation. 30.12.2.2 Auto-Restart When the REN bit of the CWG1CON2 register is set, the CWG will restart from the auto-shutdown state automatically. The SHUTDOWN bit will clear automatically when all shutdown sources go low. The overrides will remain in effect until the first rising edge event after the SHUTDOWN bit is cleared. The CWG will then resume operation. b. Select the desired output polarities using the CWG1CON1 register. c. Set the output enables for the desired outputs. 8. 9. Set the EN bit. Clear TRIS control bits corresponding to the desired output pins to configure these pins as outputs. 10. If auto-restart is to be used, set the REN bit and the SHUTDOWN bit will be cleared automatically. Otherwise, clear the SHUTDOWN bit to start the CWG. 30.12.1 PIN OVERRIDE LEVELS The levels driven to the output pins, while the shutdown input is true, are controlled by the LSBD and LSAC bits of the CWG1AS0 register. LSBD<1:0> controls the CWG1B and D override levels and LSAC<1:0> controls the CWG1A and C override levels. The control bit logic level corresponds to the output logic drive level while in the shutdown state. The polarity control does not affect the override level. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 333 2017 Microchip Technology Inc. FIGURE 30-13: SHUTDOWN FUNCTIONALITY, AUTO-RESTART DISABLED (REN = 0, LSAC = 01, LSBD = 01) Shutdown Event Ceases REN Cleared by Software CWG Input Source Shutdown Source SHUTDOWN CWG1A CWG1C Tri-State (No Pulse) CWG1B CWG1D Tri-State (No Pulse) No Shutdown Preliminary Output Resumes Shutdown FIGURE 30-14: SHUTDOWN FUNCTIONALITY, AUTO-RESTART ENABLED (REN = 1, LSAC = 01, LSBD = 01) Shutdown Event Ceases REN auto-cleared by hardware Shutdown Source SHUTDOWN DS40001897A-page 334 CWG1A CWG1C Tri-State (No Pulse) CWG1B CWG1D Tri-State (No Pulse) No Shutdown Shutdown Output Resumes PIC16(L)F15313/23 CWG Input Source PIC16(L)F15313/23 30.13 Register Definitions: CWG Control Long bit name prefixes for the CWG peripherals are shown in Section 1.1 "Register and Bit Naming Conventions". REGISTER 30-1: CWG1CON0: CWG1 CONTROL REGISTER 0 R/W-0/0 R/W/HC-0/0 U-0 U-0 U-0 EN LD(1) -- -- -- R/W-0/0 R/W-0/0 R/W-0/0 MODE<2:0> bit 7 bit 0 Legend: HC = Bit is cleared by hardware HS = Bit is set by hardware R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7 EN: CWG1 Enable bit 1 = Module is enabled 0 = Module is disabled bit 6 LD: CWG1 Load Buffer bits(1) 1 = Buffers to be loaded on the next rising/falling event 0 = Buffers not loaded bit 5-3 Unimplemented: Read as `0' bit 2-0 MODE<2:0>: CWG1 Mode bits 111 = Reserved 110 = Reserved 101 = CWG outputs operate in Push-Pull mode 100 = CWG outputs operate in Half-Bridge mode 011 = CWG outputs operate in Reverse Full-Bridge mode 010 = CWG outputs operate in Forward Full-Bridge mode 001 = CWG outputs operate in Synchronous Steering mode 000 = CWG outputs operate in Steering mode Note 1: This bit can only be set after EN = 1 and cannot be set in the same instruction that EN is set. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 335 PIC16(L)F15313/23 REGISTER 30-2: CWG1CON1: CWG1 CONTROL REGISTER 1 U-0 U-0 R-x U-0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 -- -- IN -- POLD POLC POLB POLA bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7-6 Unimplemented: Read as `0' bit 5 IN: CWG Input Value bit bit 4 Unimplemented: Read as `0' bit 3 POLD: CWG1D Output Polarity bit 1 = Signal output is inverted polarity 0 = Signal output is normal polarity bit 2 POLC: CWG1C Output Polarity bit 1 = Signal output is inverted polarity 0 = Signal output is normal polarity bit 1 POLB: CWG1B Output Polarity bit 1 = Signal output is inverted polarity 0 = Signal output is normal polarity bit 0 POLA: CWG1A Output Polarity bit 1 = Signal output is inverted polarity 0 = Signal output is normal polarity 2017 Microchip Technology Inc. Preliminary DS40001897A-page 336 PIC16(L)F15313/23 REGISTER 30-3: CWG1DBR: CWG1 RISING DEAD-BAND COUNTER REGISTER U-0 U-0 -- -- R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u DBR<5:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7-6 Unimplemented: Read as `0' bit 5-0 DBR<5:0>: Rising Event Dead-Band Value for Counter bits REGISTER 30-4: CWG1DBF: CWG1 FALLING DEAD-BAND COUNTER REGISTER U-0 U-0 -- -- R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u DBF<5:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7-6 Unimplemented: Read as `0' bit 5-0 DBF<5:0>: Falling Event Dead-Band Value for Counter bits 2017 Microchip Technology Inc. Preliminary DS40001897A-page 337 PIC16(L)F15313/23 REGISTER 30-5: CWG1AS0: CWG1 AUTO-SHUTDOWN CONTROL REGISTER 0 R/W/HS-0/0 R/W-0/0 (1, 2) REN SHUTDOWN R/W-0/0 R/W-1/1 R/W-0/0 LSBD<1:0> R/W-1/1 LSAC<1:0> U-0 U-0 -- -- bit 7 bit 0 Legend: HC = Bit is cleared by hardware HS = Bit is set by hardware R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7 SHUTDOWN: Auto-Shutdown Event Status bit(1, 2) 1 = An Auto-Shutdown state is in effect 0 = No Auto-shutdown event has occurred bit 6 REN: Auto-Restart Enable bit 1 = Auto-restart enabled 0 = Auto-restart disabled bit 5-4 LSBD<1:0>: CWG1B and CWG1D Auto-Shutdown State Control bits 11 =A logic `1' is placed on CWG1B/D when an auto-shutdown event is present 10 =A logic `0' is placed on CWG1B/D when an auto-shutdown event is present 01 =Pin is tri-stated on CWG1B/D when an auto-shutdown event is present 00 =The inactive state of the pin, including polarity, is placed on CWG1B/D after the required deadband interval bit 3-2 LSAC<1:0>: CWG1A and CWG1C Auto-Shutdown State Control bits 11 =A logic `1' is placed on CWG1A/C when an auto-shutdown event is present 10 =A logic `0' is placed on CWG1A/C when an auto-shutdown event is present 01 =Pin is tri-stated on CWG1A/C when an auto-shutdown event is present 00 =The inactive state of the pin, including polarity, is placed on CWG1A/C after the required deadband interval bit 1-0 Unimplemented: Read as `0' Note 1: This bit may be written while EN = 0 (CWG1CON0 register) to place the outputs into the shutdown configuration. 2: The outputs will remain in auto-shutdown state until the next rising edge of the input signal after this bit is cleared. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 338 PIC16(L)F15313/23 REGISTER 30-6: CWG1AS1: CWG1 AUTO-SHUTDOWN CONTROL REGISTER 1 U-1 U-1 U-1 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 -- -- -- AS4E AS3E AS2E AS1E AS0E bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7-5 Unimplemented: Read as `0' bit 4 AS4E: CLC2 Output bit 1 = LC2_out shut-down is enabled 0 = LC2_out shut-down is disabled bit 3 AS3E: Comparator C2 Output bit 1 = C2 output shut-down is enabled 0 = C2 output shut-down is disabled bit 2 AS2E: Comparator C1 Output bit 1 = C1 output shut-down is enabled 0 = C1 output shut-down is disabled bit 2 AS1E: TMR2 Postscale Output bit 1 = TMR2 Postscale shut-down is enabled 0 = TMR2 Postscale shut-down is disabled bit 0 AS0E: CWG1 Input Pin bit 1 = Input pin selected by CWG1PPS shut-down is enabled 0 = Input pin selected by CWG1PPS shut-down is disabled 2017 Microchip Technology Inc. Preliminary DS40001897A-page 339 PIC16(L)F15313/23 CWG1STR: CWG1 STEERING CONTROL REGISTER(1) REGISTER 30-7: R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 OVRD OVRC OVRB OVRA STRD(2) STRC(2) STRB(2) STRA(2) bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7 OVRD: Steering Data D bit bit 6 OVRC: Steering Data C bit bit 5 OVRB: Steering Data B bit bit 4 OVRA: Steering Data A bit bit 3 STRD: Steering Enable D bit(2) 1 = CWG1D output has the CWG1_data waveform with polarity control from POLD bit 0 = CWG1D output is assigned the value of OVRD bit bit 2 STRC: Steering Enable C bit(2) 1 = CWG1C output has the CWG1_data waveform with polarity control from POLC bit 0 = CWG1C output is assigned the value of OVRC bit bit 1 STRB: Steering Enable B bit(2) 1 = CWG1B output has the CWG1_data waveform with polarity control from POLB bit 0 = CWG1B output is assigned the value of OVRB bit bit 0 STRA: Steering Enable A bit(2) 1 = CWG1A output has the CWG1_data waveform with polarity control from POLA bit 0 = CWG1A output is assigned the value of OVRA bit Note 1: The bits in this register apply only when MODE<2:0> = 00x. 2: This bit is effectively double-buffered when MODE<2:0> = 001. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 340 PIC16(L)F15313/23 REGISTER 30-8: CWG1CLK: CWG1 CLOCK SELECTION REGISTER U-0 U-0 U-0 U-0 U-0 U-0 U-0 R/W-0/0 -- -- -- -- -- -- -- CS bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7-1 Unimplemented: Read as `0' bit 0 CS: CWG1 Clock Selection bit 1 = HFINTOSC 16 MHz is selected 0 = FOSC is selected REGISTER 30-9: CWG1ISM: CWG1 INPUT SELECTION REGISTER U-0 U-0 U-0 U-0 -- -- -- -- R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 IS<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared q = Value depends on condition bit 7-4 Unimplemented: Read as `0' bit 3-0 IS<3:0>: CWG1 Input Selection bits 1111 = Reserved. No channel connected. 1110 = Reserved. No channel connected. 1101 = LC4_out 1100 = LC3_out 1011 = LC2_out 1010 = LC1_out 1001 = Comparator C2 out(1) 1000 = Comparator C1 out 0111 = NCO1 output 0110 = PWM6_out 0101 = PWM5_out 0100 = PWM4_out 0011 = PWM3_out 0010 = CCP2_out 0001 = CCP1_out 0000 = CWG11CLK Note 1: Present on PIC16(L)F15323 only. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 341 PIC16(L)F15313/23 TABLE 30-3: SUMMARY OF REGISTERS ASSOCIATED WITH CWG Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 CWG1CLKCON -- -- -- -- -- -- CWG1ISM -- -- -- -- CWG1DBR -- -- -- -- CWG1CON0 EN LD -- IN -- -- CWG1AS0 SHUTDOWN REN CWG1AS1 -- -- CWG1STR OVRD OVRC Legend: Bit 0 Register on Page -- CS 341 IS<3:0> 341 DBR<5:0> CWG1DBF CWG1CON1 Bit 1 337 DBF<5:0> -- -- -- POLD LSBD<1:0> 337 MODE<2:0> POLC LSAC<1:0> 340 POLB POLA -- -- 336 338 -- AS4E AS3E AS2E AS1E AS0E 339 OVRB OVRA STRD STRC STRB STRA 340 - = unimplemented locations read as `0'. Shaded cells are not used by CWG. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 342 PIC16(L)F15313/23 31.0 CONFIGURABLE LOGIC CELL (CLC) The Configurable Logic Cell (CLCx) module provides programmable logic that operates outside the speed limitations of software execution. The logic cell selects from 40 input signals and, through the use of configurable gates, reduces the inputs to four logic lines that drive one of eight selectable single-output logic functions. Input sources are a combination of the following: * * * * I/O pins Internal clocks Peripherals Register bits The output can be directed internally to peripherals and to an output pin. Refer to Figure 31-1 for a simplified diagram showing signal flow through the CLCx. Possible configurations include: * Combinatorial Logic - AND - NAND - AND-OR - AND-OR-INVERT - OR-XOR - OR-XNOR * Latches - S-R - Clocked D with Set and Reset - Transparent D with Set and Reset - Clocked J-K with Reset The CLC modules available are shown in Table 31-1. TABLE 31-1: AVAILABLE CLC MODULES Device CLC1 CLC2 CLC3 CLC4 PIC16(L)F15313/23 Note: The CLC1, CLC2, CLC3 and CLC4 are four separate module instances of the same CLC module design. Throughout this section, the lower case `x' in register and bit names is a generic reference to the CLC number (which should be substituted with 1, 2, 3, or 4 during code development). For example, the control register is generically described in this chapter as CLCxCON, but the actual device registers are CLC1CON, CLC2CON, CLC3CON and CLC4CON. Similarly, the LCxEN bit represents the LC1EN, LC2EN, LC3EN and LC4EN bits. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 343 PIC16(L)F15313/23 FIGURE 31-1: CLCx SIMPLIFIED BLOCK DIAGRAM Rev. 10-000025H 11/9/2016 D OUT CLCxOUT Q Q1 . . . LCx_in[n-2] LCx_in[n-1] LCx_in[n] CLCx_out Input Data Selection Gates(1) LCx_in[0] LCx_in[1] LCx_in[2] EN lcxg1 lcxg2 CLCxPPS Logic lcxq Function lcxg3 to Peripherals PPS CLCx (2) lcxg4 POL MODE<2:0> TRIS Interrupt det INTP INTN set bit CLCxIF Interrupt det Note 1: 2: See Figure 31-2: Input Data Selection and Gating. See Figure 31-3: Programmable Logic Functions. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 344 PIC16(L)F15313/23 31.1 TABLE 31-2: CLCx Setup Programming the CLCx module is performed by configuring the four stages in the logic signal flow. The four stages are: * * * * Data selection Data gating Logic function selection Output polarity CLCx DATA INPUT SELECTION LCxDyS<4:0> Value CLCx Input Source 101000 to 111111 [40+] Reserved 100111 [39] CWG1B output 100110 [38] CWG1A output 100101 [37] Reserved 100100 [36] Reserved 100011 [35] MSSP1 SCK output Each stage is setup at run time by writing to the corresponding CLCx Special Function Registers. This has the added advantage of permitting logic reconfiguration on-the-fly during program execution. 100010 [34] MSSP1 SDO output 100001 [33] Reserved 31.1.1 DATA SELECTION There are 40 signals available as inputs to the configurable logic. Four 40-input multiplexers are used to select the inputs to pass on to the next stage. Data selection is through four multiplexers as indicated on the left side of Figure 31-2. Data inputs in the figure are identified by a generic numbered input name. Table 31-2 correlates the generic input name to the actual signal for each CLC module. The column labeled `LCxDyS<4:0> Value' indicates the MUX selection code for the selected data input. LCxDyS is an abbreviation to identify specific multiplexers: LCxD1S<4:0> through LCxD4S<4:0>. Data inputs are selected with CLCxSEL0 through CLCxSEL3 registers (Register 31-3 through Register 31-6). 100000 [32] Reserved 011111 [31] EUSART1 (TX/CK) output 011110 [30] EUSART1 (DT) output 011101 [29] CLC4 output 011100 [28] CLC3 output 011011 [27] CLC2 output 011010 [26] CLC1 output 011001 [25] IOCIF 011000 [24] ZCD output 010111 [23] C2OUT(1) 010110 [22] C1OUT 010101 [21] NCO1 output 010100 [20] PWM6 output 010011 [19] PWM5 output 010010 [18] PWM4 output 010001 [17] PWM3 output 010000 [16] CCP2 output 001111 [15] CCP1 output 001110 [14] Timer2 overflow 001101 [13] Timer1 overflow 001100 [12] Timer0 overflow 001011 [11] CLKR 001010 [10] ADCRC 001001 [9] Reserved 001000 [8] MFINTOSC (32 kHz) 000111 [7] MFINTOSC (500 kHz) 000110 [6] LFINTOSC 000101 [5] HFINTOSC 000100 [4] FOSC 000011 [3] CLCIN3PPS 000010 [2] CLCIN2PPS 000001 [1] Note 2017 Microchip Technology Inc. Preliminary 1: CLCIN1PPS Present on PIC16(L)F15323 only. DS40001897A-page 345 PIC16(L)F15313/23 31.1.2 DATA GATING Outputs from the input multiplexers are directed to the desired logic function input through the data gating stage. Each data gate can direct any combination of the four selected inputs. Note: 31.1.3 Data gating is undefined at power-up. The gate stage is more than just signal direction. The gate can be configured to direct each input signal as inverted or non-inverted data. The output of each gate can be inverted before going on to the logic function stage. The gating is in essence a 1-to-4 input AND/NAND/OR/NOR gate. When every input is inverted and the output is inverted, the gate is an OR of all enabled data inputs. When the inputs and output are not inverted, the gate is an AND or all enabled inputs. Table 31-3 summarizes the basic logic that can be obtained in gate 1 by using the gate logic select bits. The table shows the logic of four input variables, but each gate can be configured to use less than four. If no inputs are selected, the output will be zero or one, depending on the gate output polarity bit. TABLE 31-3: CLCxGLSy 1 4-input AND 0x55 0 4-input NAND 0xAA 1 4-input NOR 0xAA 0 4-input OR 0x00 0 Logic 0 0x00 1 Logic 1 * * * * * * * * AND-OR OR-XOR AND S-R Latch D Flip-Flop with Set and Reset D Flip-Flop with Reset J-K Flip-Flop with Reset Transparent Latch with Set and Reset Logic functions are shown in Figure 31-2. Each logic function has four inputs and one output. The four inputs are the four data gate outputs of the previous stage. The output is fed to the inversion stage and from there to other peripherals, an output pin, and back to the CLCx itself. OUTPUT POLARITY The last stage in the Configurable Logic Cell is the output polarity. Setting the LCxPOL bit of the CLCxPOL register inverts the output signal from the logic stage. Changing the polarity while the interrupts are enabled will cause an interrupt for the resulting output transition. Gate Logic 0x55 LOGIC FUNCTION There are eight available logic functions including: 31.1.4 DATA GATING LOGIC LCxGyPOL Data gating is indicated in the right side of Figure 31-2. Only one gate is shown in detail. The remaining three gates are configured identically with the exception that the data enables correspond to the enables for that gate. It is possible (but not recommended) to select both the true and negated values of an input. When this is done, the gate output is zero, regardless of the other inputs, but may emit logic glitches (transient-induced pulses). If the output of the channel must be zero or one, the recommended method is to set all gate bits to zero and use the gate polarity bit to set the desired level. Data gating is configured with the logic gate select registers as follows: * * * * Gate 1: CLCxGLS0 (Register 31-7) Gate 2: CLCxGLS1 (Register 31-8) Gate 3: CLCxGLS2 (Register 31-9) Gate 4: CLCxGLS3 (Register 31-10) Register number suffixes are different than the gate numbers because other variations of this module have multiple gate selections in the same register. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 346 PIC16(L)F15313/23 31.2 CLCx Interrupts 31.6 An interrupt will be generated upon a change in the output value of the CLCx when the appropriate interrupt enables are set. A rising edge detector and a falling edge detector are present in each CLC for this purpose. The CLCxIF bit of the associated PIR5 register will be set when either edge detector is triggered and its associated enable bit is set. The LCxINTP enables rising edge interrupts and the LCxINTN bit enables falling edge interrupts. Both are located in the CLCxCON register. To fully enable the interrupt, set the following bits: * CLCxIE bit of the PIE5 register * LCxINTP bit of the CLCxCON register (for a rising edge detection) * LCxINTN bit of the CLCxCON register (for a falling edge detection) * PEIE and GIE bits of the INTCON register The CLCxIF bit of the PIR5 register, must be cleared in software as part of the interrupt service. If another edge is detected while this flag is being cleared, the flag will still be set at the end of the sequence. 31.3 Output Mirror Copies Mirror copies of all LCxCON output bits are contained in the CLCxDATA register. Reading this register reads the outputs of all CLCs simultaneously. This prevents any reading skew introduced by testing or reading the LCxOUT bits in the individual CLCxCON registers. 31.4 Effects of a Reset CLCx Setup Steps The following steps should be followed when setting up the CLCx: * Disable CLCx by clearing the LCxEN bit. * Select desired inputs using CLCxSEL0 through CLCxSEL3 registers (See Table 31-2). * Clear any associated ANSEL bits. * Enable the chosen inputs through the four gates using CLCxGLS0, CLCxGLS1, CLCxGLS2, and CLCxGLS3 registers. * Select the gate output polarities with the LCxGyPOL bits of the CLCxPOL register. * Select the desired logic function with the LCxMODE<2:0> bits of the CLCxCON register. * Select the desired polarity of the logic output with the LCxPOL bit of the CLCxPOL register. (This step may be combined with the previous gate output polarity step). * If driving a device pin, set the desired pin PPS control register and also clear the TRIS bit corresponding to that output. * If interrupts are desired, configure the following bits: - Set the LCxINTP bit in the CLCxCON register for rising event. - Set the LCxINTN bit in the CLCxCON register for falling event. - Set the CLCxIE bit of the PIE5 register. - Set the GIE and PEIE bits of the INTCON register. * Enable the CLCx by setting the LCxEN bit of the CLCxCON register. The CLCxCON register is cleared to zero as the result of a Reset. All other selection and gating values remain unchanged. 31.5 Operation During Sleep The CLC module operates independently from the system clock and will continue to run during Sleep, provided that the input sources selected remain active. The HFINTOSC remains active during Sleep when the CLC module is enabled and the HFINTOSC is selected as an input source, regardless of the system clock source selected. In other words, if the HFINTOSC is simultaneously selected as the system clock and as a CLC input source, when the CLC is enabled, the CPU will go idle during Sleep, but the CLC will continue to operate and the HFINTOSC will remain active. This will have a direct effect on the Sleep mode current. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 347 PIC16(L)F15313/23 FIGURE 31-2: INPUT DATA SELECTION AND GATING Data Selection LCx_in Data GATE 1 lcxd1T LCxD1G1T lcxd1N LCxD1G1N LCx_in LCxD2G1T LCxD1S<5:0> LCxD2G1N lcxg1 LCx_in LCxD3G1T lcxd2T LCxG1POL LCxD3G1N lcxd2N LCxD4G1T LCx_in LCxD2S<5:0> LCxD4G1N LCx_in Data GATE 2 lcxg2 lcxd3T (Same as Data GATE 1) lcxd3N Data GATE 3 LCx_in lcxg3 LCxD3S<5:0> (Same as Data GATE 1) Data GATE 4 LCx_in lcxg4 (Same as Data GATE 1) lcxd4T lcxd4N LCx_in LCxD4S<5:0> 2017 Microchip Technology Inc. Preliminary DS40001897A-page 348 PIC16(L)F15313/23 FIGURE 31-3: PROGRAMMABLE LOGIC FUNCTIONS Rev. 10-000122A 5/18/2016 AND-OR OR-XOR lcxg1 lcxg1 lcxg2 lcxg2 lcxq lcxq lcxg3 lcxg3 lcxg4 lcxg4 LCxMODE<2:0> = 000 LCxMODE<2:0> = 001 4-input AND S-R Latch lcxg1 lcxg1 S Q lcxq Q lcxq lcxg2 lcxg2 lcxq lcxg3 lcxg3 R lcxg4 lcxg4 LCxMODE<2:0> = 010 LCxMODE<2:0> = 011 1-Input D Flip-Flop with S and R 2-Input D Flip-Flop with R lcxg4 lcxg2 D S lcxg4 Q lcxq D lcxg2 lcxg1 lcxg1 R lcxg3 R lcxg3 LCxMODE<2:0> = 100 LCxMODE<2:0> = 101 J-K Flip-Flop with R 1-Input Transparent Latch with S and R lcxg4 lcxg2 J Q lcxq lcxg2 D lcxg3 LE S Q lcxq lcxg1 lcxg4 K R lcxg3 R lcxg1 LCxMODE<2:0> = 110 2017 Microchip Technology Inc. LCxMODE<2:0> = 111 Preliminary DS40001897A-page 349 PIC16(L)F15313/23 31.7 Register Definitions: CLC Control REGISTER 31-1: CLCxCON: CONFIGURABLE LOGIC CELL CONTROL REGISTER R/W-0/0 U-0 R-0/0 R/W-0/0 R/W-0/0 LCxEN -- LCxOUT LCxINTP LCxINTN R/W-0/0 R/W-0/0 R/W-0/0 LCxMODE<2:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 LCxEN: Configurable Logic Cell Enable bit 1 = Configurable logic cell is enabled and mixing input signals 0 = Configurable logic cell is disabled and has logic zero output bit 6 Unimplemented: Read as `0' bit 5 LCxOUT: Configurable Logic Cell Data Output bit Read-only: logic cell output data, after LCPOL; sampled from CLCxOUT bit 4 LCxINTP: Configurable Logic Cell Positive Edge Going Interrupt Enable bit 1 = CLCxIF will be set when a rising edge occurs on CLCxOUT 0 = CLCxIF will not be set bit 3 LCxINTN: Configurable Logic Cell Negative Edge Going Interrupt Enable bit 1 = CLCxIF will be set when a falling edge occurs on CLCxOUT 0 = CLCxIF will not be set bit 2-0 LCxMODE<2:0>: Configurable Logic Cell Functional Mode bits 111 = Cell is 1-input transparent latch with S and R 110 = Cell is J-K flip-flop with R 101 = Cell is 2-input D flip-flop with R 100 = Cell is 1-input D flip-flop with S and R 011 = Cell is S-R latch 010 = Cell is 4-input AND 001 = Cell is OR-XOR 000 = Cell is AND-OR 2017 Microchip Technology Inc. Preliminary DS40001897A-page 350 PIC16(L)F15313/23 REGISTER 31-2: CLCxPOL: SIGNAL POLARITY CONTROL REGISTER R/W-0/0 U-0 U-0 U-0 R/W-x/u R/W-x/u R/W-x/u R/W-x/u LCxPOL -- -- -- LCxG4POL LCxG3POL LCxG2POL LCxG1POL bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 LCxPOL: CLCxOUT Output Polarity Control bit 1 = The output of the logic cell is inverted 0 = The output of the logic cell is not inverted bit 6-4 Unimplemented: Read as `0' bit 3 LCxG4POL: Gate 3 Output Polarity Control bit 1 = The output of gate 3 is inverted when applied to the logic cell 0 = The output of gate 3 is not inverted bit 2 LCxG3POL: Gate 2 Output Polarity Control bit 1 = The output of gate 2 is inverted when applied to the logic cell 0 = The output of gate 2 is not inverted bit 1 LCxG2POL: Gate 1 Output Polarity Control bit 1 = The output of gate 1 is inverted when applied to the logic cell 0 = The output of gate 1 is not inverted bit 0 LCxG1POL: Gate 0 Output Polarity Control bit 1 = The output of gate 0 is inverted when applied to the logic cell 0 = The output of gate 0 is not inverted 2017 Microchip Technology Inc. Preliminary DS40001897A-page 351 PIC16(L)F15313/23 REGISTER 31-3: CLCxSEL0: GENERIC CLCx DATA 0 SELECT REGISTER U-0 U-0 -- -- R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u LCxD1S<5:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 LCxD1S<5:0>: CLCx Data1 Input Selection bits See Table 31-2. REGISTER 31-4: CLCxSEL1: GENERIC CLCx DATA 1 SELECT REGISTER U-0 U-0 -- -- R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u LCxD2S<5:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 LCxD2S<5:0>: CLCx Data 2 Input Selection bits See Table 31-2. REGISTER 31-5: CLCxSEL2: GENERIC CLCx DATA 2 SELECT REGISTER U-0 U-0 -- -- R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u LCxD3S<5:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 LCxD3S<5:0>: CLCx Data 3 Input Selection bits See Table 31-2. REGISTER 31-6: CLCxSEL3: GENERIC CLCx DATA 3 SELECT REGISTER U-0 U-0 -- -- R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u LCxD4S<5:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-6 Unimplemented: Read as `0' bit 5-0 LCxD4S<5:0>: CLCx Data 4 Input Selection bits See Table 31-2. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 352 PIC16(L)F15313/23 REGISTER 31-7: CLCxGLS0: GATE 0 LOGIC SELECT REGISTER R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u LCxG1D4T LCxG1D4N LCxG1D3T LCxG1D3N LCxG1D2T LCxG1D2N LCxG1D1T LCxG1D1N bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 LCxG1D4T: Gate 0 Data 4 True (non-inverted) bit 1 = CLCIN3 (true) is gated into CLCx Gate 0 0 = CLCIN3 (true) is not gated into CLCx Gate 0 bit 6 LCxG1D4N: Gate 0 Data 4 Negated (inverted) bit 1 = CLCIN3 (inverted) is gated into CLCx Gate 0 0 = CLCIN3 (inverted) is not gated into CLCx Gate 0 bit 5 LCxG1D3T: Gate 0 Data 3 True (non-inverted) bit 1 = CLCIN2 (true) is gated into CLCx Gate 0 0 = CLCIN2 (true) is not gated into CLCx Gate 0 bit 4 LCxG1D3N: Gate 0 Data 3 Negated (inverted) bit 1 = CLCIN2 (inverted) is gated into CLCx Gate 0 0 = CLCIN2 (inverted) is not gated into CLCx Gate 0 bit 3 LCxG1D2T: Gate 0 Data 2 True (non-inverted) bit 1 = CLCIN1 (true) is gated into CLCx Gate 0 0 = CLCIN1 (true) is not gated into l CLCx Gate 0 bit 2 LCxG1D2N: Gate 0 Data 2 Negated (inverted) bit 1 = CLCIN1 (inverted) is gated into CLCx Gate 0 0 = CLCIN1 (inverted) is not gated into CLCx Gate 0 bit 1 LCxG1D1T: Gate 0 Data 1 True (non-inverted) bit 1 = CLCIN0 (true) is gated into CLCx Gate 0 0 = CLCIN0 (true) is not gated into CLCx Gate 0 bit 0 LCxG1D1N: Gate 0 Data 1 Negated (inverted) bit 1 = CLCIN0 (inverted) is gated into CLCx Gate 0 0 = CLCIN0 (inverted) is not gated into CLCx Gate 0 2017 Microchip Technology Inc. Preliminary DS40001897A-page 353 PIC16(L)F15313/23 REGISTER 31-8: CLCxGLS1: GATE 1 LOGIC SELECT REGISTER R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u LCxG2D4T LCxG2D4N LCxG2D3T LCxG2D3N LCxG2D2T LCxG2D2N LCxG2D1T LCxG2D1N bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 LCxG2D4T: Gate 1 Data 4 True (non-inverted) bit 1 = CLCIN3 (true) is gated into CLCx Gate 1 0 = CLCIN3 (true) is not gated into CLCx Gate 1 bit 6 LCxG2D4N: Gate 1 Data 4 Negated (inverted) bit 1 = CLCIN3 (inverted) is gated into CLCx Gate 1 0 = CLCIN3 (inverted) is not gated into CLCx Gate 1 bit 5 LCxG2D3T: Gate 1 Data 3 True (non-inverted) bit 1 = CLCIN2 (true) is gated into CLCx Gate 1 0 = CLCIN2 (true) is not gated into CLCx Gate 1 bit 4 LCxG2D3N: Gate 1 Data 3 Negated (inverted) bit 1 = CLCIN2 (inverted) is gated into CLCx Gate 1 0 = CLCIN2 (inverted) is not gated into CLCx Gate 1 bit 3 LCxG2D2T: Gate 1 Data 2 True (non-inverted) bit 1 = CLCIN1 (true) is gated into CLCx Gate 1 0 = CLCIN1 (true) is not gated into CLCx Gate 1 bit 2 LCxG2D2N: Gate 1 Data 2 Negated (inverted) bit 1 = CLCIN1 (inverted) is gated into CLCx Gate 1 0 = CLCIN1 (inverted) is not gated into CLCx Gate 1 bit 1 LCxG2D1T: Gate 1 Data 1 True (non-inverted) bit 1 = CLCIN0 (true) is gated into CLCx Gate 1 0 = CLCIN0 (true) is not gated into CLCx Gate1 bit 0 LCxG2D1N: Gate 1 Data 1 Negated (inverted) bit 1 = CLCIN0 (inverted) is gated into CLCx Gate 1 0 = CLCIN0 (inverted) is not gated into CLCx Gate 1 2017 Microchip Technology Inc. Preliminary DS40001897A-page 354 PIC16(L)F15313/23 REGISTER 31-9: CLCxGLS2: GATE 2 LOGIC SELECT REGISTER R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u LCxG3D4T LCxG3D4N LCxG3D3T LCxG3D3N LCxG3D2T LCxG3D2N LCxG3D1T LCxG3D1N bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 LCxG3D4T: Gate 2 Data 4 True (non-inverted) bit 1 = CLCIN3 (true) is gated into CLCx Gate 2 0 = CLCIN3 (true) is not gated into CLCx Gate 2 bit 6 LCxG3D4N: Gate 2 Data 4 Negated (inverted) bit 1 = CLCIN3 (inverted) is gated into CLCx Gate 2 0 = CLCIN3 (inverted) is not gated into CLCx Gate 2 bit 5 LCxG3D3T: Gate 2 Data 3 True (non-inverted) bit 1 = CLCIN2 (true) is gated into CLCx Gate 2 0 = CLCIN2 (true) is not gated into CLCx Gate 2 bit 4 LCxG3D3N: Gate 2 Data 3 Negated (inverted) bit 1 = CLCIN2 (inverted) is gated into CLCx Gate 2 0 = CLCIN2 (inverted) is not gated into CLCx Gate 2 bit 3 LCxG3D2T: Gate 2 Data 2 True (non-inverted) bit 1 = CLCIN1 (true) is gated into CLCx Gate 2 0 = CLCIN1 (true) is not gated into CLCx Gate 2 bit 2 LCxG3D2N: Gate 2 Data 2 Negated (inverted) bit 1 = CLCIN1 (inverted) is gated into CLCx Gate 2 0 = CLCIN1 (inverted) is not gated into CLCx Gate 2 bit 1 LCxG3D1T: Gate 2 Data 1 True (non-inverted) bit 1 = CLCIN0 (true) is gated into CLCx Gate 2 0 = CLCIN0 (true) is not gated into CLCx Gate 2 bit 0 LCxG3D1N: Gate 2 Data 1 Negated (inverted) bit 1 = CLCIN0 (inverted) is gated into CLCx Gate 2 0 = CLCIN0 (inverted) is not gated into CLCx Gate 2 2017 Microchip Technology Inc. Preliminary DS40001897A-page 355 PIC16(L)F15313/23 REGISTER 31-10: CLCxGLS3: GATE 3 LOGIC SELECT REGISTER R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u R/W-x/u LCxG4D4T LCxG4D4N LCxG4D3T LCxG4D3N LCxG4D2T LCxG4D2N LCxG4D1T LCxG4D1N bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 LCxG4D4T: Gate 3 Data 4 True (non-inverted) bit 1 = CLCIN3 (true) is gated into CLCx Gate 3 0 = CLCIN3 (true) is not gated into CLCx Gate 3 bit 6 LCxG4D4N: Gate 3 Data 4 Negated (inverted) bit 1 = CLCIN3 (inverted) is gated into CLCx Gate 3 0 = CLCIN3 (inverted) is not gated into CLCx Gate 3 bit 5 LCxG4D3T: Gate 3 Data 3 True (non-inverted) bit 1 = CLCIN2 (true) is gated into CLCx Gate 3 0 = CLCIN2 (true) is not gated into CLCx Gate 3 bit 4 LCxG4D3N: Gate 3 Data 3 Negated (inverted) bit 1 = CLCIN2 (inverted) is gated into CLCx Gate 3 0 = CLCIN2 (inverted) is not gated into CLCx Gate 3 bit 3 LCxG4D2T: Gate 3 Data 2 True (non-inverted) bit 1 = CLCIN1 (true) is gated into CLCx Gate 3 0 = CLCIN1 (true) is not gated into CLCx Gate 3 bit 2 LCxG4D2N: Gate 3 Data 2 Negated (inverted) bit 1 = CLCIN1 (inverted) is gated into CLCx Gate 3 0 = CLCIN1 (inverted) is not gated into CLCx Gate 3 bit 1 LCxG4D1T: Gate 4 Data 1 True (non-inverted) bit 1 = CLCIN0 (true) is gated into CLCx Gate 3 0 = CLCIN0 (true) is not gated into CLCx Gate 3 bit 0 LCxG4D1N: Gate 3 Data 1 Negated (inverted) bit 1 = CLCIN0 (inverted) is gated into CLCx Gate 3 0 = CLCIN0 (inverted) is not gated into CLCx Gate 3 2017 Microchip Technology Inc. Preliminary DS40001897A-page 356 PIC16(L)F15313/23 REGISTER 31-11: CLCDATA: CLC DATA OUTPUT U-0 U-0 U-0 U-0 R-0 R-0 R-0 R-0 -- -- -- -- MLC4OUT MLC3OUT MLC2OUT MLC1OUT bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-4 Unimplemented: Read as `0' bit 3 MLC4OUT: Mirror copy of LC4OUT bit bit 2 MLC3OUT: Mirror copy of LC3OUT bit bit 1 MLC2OUT: Mirror copy of LC2OUT bit bit 0 MLC1OUT: Mirror copy of LC1OUT bit 2017 Microchip Technology Inc. Preliminary DS40001897A-page 357 PIC16(L)F15313/23 TABLE 31-4: SUMMARY OF REGISTERS ASSOCIATED WITH CLCx Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page GIE PEIE INTEDG 121 PIR5 CLC4IF CLC3IF CLC2IF CLC1IF -- -- -- TMR1GIF 135 PIE5 CLC4IE CLC4IE CLC2IE CLC1IE -- -- -- TMR1GIE CLC1CON LC1EN LC1OUT LC1INTP LC1INTN CLC1POL LC1POL LC1G4POL CLC1SEL0 LC1D1S<5:0> 352 CLC1SEL1 LC1D2S<5:0> 352 CLC1SEL2 LC1D3S<5:0> 352 CLC1SEL3 LC1D4S<5:0> CLC1GLS0 LC1G1D3T LC1G1D3N LC1G1D2T LC1G1D2N LC1G1D1T LC1G1D1N 353 CLC1GLS1 LC1G2D3T LC1G2D3N LC1G2D2T LC1G2D2N LC1G2D1T LC1G2D1N 354 CLC1GLS2 LC1G3D3T LC1G3D3N LC1G3D2T LC1G3D2N LC1G3D1T LC1G3D1N 355 CLC1GLS3 LC1G4D3T LC1G4D3N LC1G4D2T LC1G4D2N LC1G4D1T LC1G4D1N 356 CLC2CON LC2EN LC2OUT LC2INTP LC2INTN CLC2POL LC2POL LC2G4POL CLC2SEL0 LC2D1S<5:0> 352 CLC2SEL1 LC2D2S<5:0> 352 CLC2SEL2 LC2D3S<5:0> 352 CLC2SEL3 CLC2GLS0 LC2G1D3T LC2G1D3N LC2G1D2T LC2G1D2N LC2G1D1T LC2G1D1N 353 CLC2GLS1 LC2G2D3T LC2G2D3N LC2G2D2T LC2G2D2N LC2G2D1T LC2G2D1N 354 CLC2GLS2 LC2G3D3T LC2G3D3N LC2G3D2T LC2G3D2N LC2G3D1T LC2G3D1N 355 CLC2GLS3 LC2G4D3T LC2G4D3N LC2G4D2T LC2G4D2N LC2G4D1T LC2G4D1N 356 CLC3CON LC3EN LC3OUT LC3INTP LC3INTN CLC3POL LC3POL LC3G4POL CLC3SEL0 LC3D1S<5:0> 352 CLC3SEL1 LC3D2S<5:0> 352 CLC3SEL2 LC3D3S<5:0> 352 CLC3SEL3 LC3D4S<5:0> 352 Name INTCON LC1MODE<2:0> LC1G3POL LC1G2POL LC1G1POL LC2G2POL 350 LC2G1POL LC2D4S<5:0> 351 352 LC3MODE<2:0> LC3G3POL 351 352 LC2MODE<2:0> LC2G3POL 127 350 LC3G2POL 350 LC3G1POL 351 CLC3GLS0 LC3G1D3T LC3G1D3N LC3G1D2T LC3G1D2N LC3G1D1T LC3G1D1N 353 CLC3GLS1 LC3G2D3T LC3G2D3N LC3G2D2T LC3G2D2N LC3G2D1T LC3G2D1N 354 CLC3GLS2 LC3G3D3T LC3G3D3N LC3G3D2T LC3G3D2N LC3G3D1T LC3G3D1N 355 CLC3GLS3 LC3G4D3T LC3G4D3N LC3G4D2T LC3G4D2N LC3G4D1T LC3G4D1N 356 CLC4CON LC4EN LC4OUT LC4INTP LC4INTN CLC4POL LC4POL LC4G4POL CLC4SEL0 LC4D1S<5:0> 352 CLC4SEL1 LC4D2S<5:0> 352 CLC4SEL2 LC4D3S<5:0> 352 CLC4SEL3 LC4D4S<5:0> 352 CLC4GLS0 Legend: LC4G1D3T LC4G1D3N LC4G1D2T LC4MODE<2:0> LC4G3POL LC4G1D2N LC4G2POL LC4G1D1T 350 LC4G1POL LC4G1D1N 351 353 -- = unimplemented, read as `0'. Shaded cells are unused by the CLCx modules. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 358 PIC16(L)F15313/23 TABLE 31-4: Name SUMMARY OF REGISTERS ASSOCIATED WITH CLCx (continued) Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 CLC4GLS1 LC4G2D3T LC4G2D3N LC4G2D2T LC4G2D2N LC4G2D1T LC4G2D1N 354 CLC4GLS2 LC4G3D3T LC4G3D3N LC4G3D2T LC4G3D2N LC4G3D1T LC4G3D1N 355 CLC4GLS3 LC4G4D3T LC4G4D3N LC4G4D2T LC4G4D2N LC4G4D1T LC4G4D1N CLCIN0PPS CLCIN0PPS<5:0> 191 CLCIN1PPS CLCIN1PPS<5:0> 191 CLCIN2PPS CLCIN2PPS<5:0> 191 CLCIN3PPS<5:0> 191 CLCIN3PPS Legend: 356 -- = unimplemented, read as `0'. Shaded cells are unused by the CLCx modules. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 359 PIC16(L)F15313/23 32.0 MASTER SYNCHRONOUS SERIAL PORT (MSSP1) MODULE 32.1 MSSP Module Overview The Master Synchronous Serial Port (MSSP) module is a serial interface useful for communicating with other peripheral or microcontroller devices. These peripheral devices may be serial EEPROMs, shift registers, display drivers, A/D converters, etc. The MSSP module can operate in one of two modes: * Serial Peripheral Interface (SPI) * Inter-Integrated Circuit (I2C) The SPI interface supports the following modes and features: * * * * * Master mode Slave mode Clock Parity Slave Select Synchronization (Slave mode only) Daisy-chain connection of slave devices Figure 32-1 is a block diagram of the SPI interface module. FIGURE 32-1: MSSP BLOCK DIAGRAM (SPI MODE) Data Bus Read Write SSP1BUF Reg SSPDATPPS SDI PPS SSPSR Reg Shift Clock bit 0 SDO PPS RxyPPS SS SS Control Enable PPS Edge Select SSPSSPPS SSPCLKPPS(2) SCK SSPM<3:0> 4 PPS Edge Select PPS TRIS bit Note 1: 2: 2 (CKP, CKE) Clock Select RxyPPS(1) ( T2_match 2 ) Prescaler TOSC 4, 16, 64 Baud Rate Generator (SSP1ADD) Output selection for master mode. Input selection for slave mode. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 360 PIC16(L)F15313/23 The I2C interface supports the following modes and features: * * * * * * * Master mode Slave mode Byte NACKing (Slave mode) Limited multi-master support 7-bit and 10-bit addressing Start and Stop interrupts Interrupt masking FIGURE 32-2: * * * * * Clock stretching Bus collision detection General call address matching Address masking Selectable SDA hold times Figure 32-2 is a block diagram of the I2C interface module in Master mode. Figure 32-3 is a diagram of the I2C interface module in Slave mode. MSSP BLOCK DIAGRAM (I2C MASTER MODE) Internal data bus SSPDATPPS(1) Read [SSPM<3:0>] Write SDA SDA in PPS SSP1BUF Baud Rate Generator (SSP1ADD) SSPCLKPPS SCL PPS LSb Start bit, Stop bit, Acknowledge Generate (SSP1CON2) (Hold off clock source) (2) Receive Enable (RCEN) MSb Clock Cntl SSPSR PPS Clock arbitrate/BCOL detect Shift Clock RxyPPS(1) PPS RxyPPS(2) SCL in Bus Collision Start bit detect, Stop bit detect Write collision detect Clock arbitration State counter for end of XMIT/RCV Address Match detect Note 1: SDA pin selections must be the same for input and output. 2: SCL pin selections must be the same for input and output. 2017 Microchip Technology Inc. Preliminary Set/Reset: S, P, SSP1STAT, WCOL, SSPOV Reset SEN, PEN (SSP1CON2) Set SSP1IF, BCL1IF DS40001897A-page 361 PIC16(L)F15313/23 FIGURE 32-3: MSSP BLOCK DIAGRAM (I2C SLAVE MODE) Internal Data Bus Read Write SSPCLKPPS(2) SCL PPS PPS SSP1BUF Reg Shift Clock Clock Stretching SSPSR Reg MSb RxyPPS(2) LSb SSP1MSK Reg (1) SSPDATPPS SDA Match Detect Addr Match PPS SSP1ADD Reg PPS Start and Stop bit Detect RxyPPS(1) Note 1: SDA pin selections must be the same for input and output. 2: SCL pin selections must be the same for input and output. 2017 Microchip Technology Inc. Preliminary Set, Reset S, P bits (SSP1STAT Reg) DS40001897A-page 362 PIC16(L)F15313/23 32.2 SPI Mode Overview The Serial Peripheral Interface (SPI) bus is a synchronous serial data communication bus that operates in Full-Duplex mode. Devices communicate in a master/slave environment where the master device initiates the communication. A slave device is controlled through a Chip Select known as Slave Select. The SPI bus specifies four signal connections: * * * * Serial Clock (SCK) Serial Data Out (SDO) Serial Data In (SDI) Slave Select (SS) During each SPI clock cycle, a full-duplex data transmission occurs. This means that while the master device is sending out the MSb from its shift register (on its SDO pin) and the slave device is reading this bit and saving it as the LSb of its shift register, that the slave device is also sending out the MSb from its shift register (on its SDO pin) and the master device is reading this bit and saving it as the LSb of its shift register. After eight bits have been shifted out, the master and slave have exchanged register values. If there is more data to exchange, the shift registers are loaded with new data and the process repeats itself. Figure 32-1 shows the block diagram of the MSSP module when operating in SPI mode. The SPI bus operates with a single master device and one or more slave devices. When multiple slave devices are used, an independent Slave Select connection is required from the master device to each slave device. Figure 32-4 shows a typical connection between a master device and multiple slave devices. The master selects only one slave at a time. Most slave devices have tri-state outputs so their output signal appears disconnected from the bus when they are not selected. Transmissions involve two shift registers, eight bits in size, one in the master and one in the slave. Data is always shifted out one bit at a time, with the Most Significant bit (MSb) shifted out first. At the same time, a new Least Significant bit (LSb) is shifted into the same register. Whether the data is meaningful or not (dummy data), depends on the application software. This leads to three scenarios for data transmission: * Master sends useful data and slave sends dummy data. * Master sends useful data and slave sends useful data. * Master sends dummy data and slave sends useful data. Transmissions may involve any number of clock cycles. When there is no more data to be transmitted, the master stops sending the clock signal and it deselects the slave. Every slave device connected to the bus that has not been selected through its slave select line must disregard the clock and transmission signals and must not transmit out any data of its own. Figure 32-5 shows a typical connection between two processors configured as master and slave devices. Data is shifted out of both shift registers on the programmed clock edge and latched on the opposite edge of the clock. The master device transmits information out on its SDO output pin which is connected to, and received by, the slave's SDI input pin. The slave device transmits information out on its SDO output pin, which is connected to, and received by, the master's SDI input pin. To begin communication, the master device first sends out the clock signal. Both the master and the slave devices should be configured for the same clock polarity. The master device starts a transmission by sending out the MSb from its shift register. The slave device reads this bit from that same line and saves it into the LSb position of its shift register. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 363 PIC16(L)F15313/23 FIGURE 32-4: SPI MASTER AND MULTIPLE SLAVE CONNECTION SPI Master SCK SCK SDO SDI SDI SDO General I/O General I/O SS General I/O SCK SDI SDO SPI Slave #1 SPI Slave #2 SS SCK SDI SDO SPI Slave #3 SS 32.2.1 SPI MODE REGISTERS The MSSP module has five registers for SPI mode operation. These are: * * * * * * MSSP STATUS register (SSP1STAT) MSSP Control register 1 (SSP1CON1) MSSP Control register 3 (SSP1CON3) MSSP Data Buffer register (SSP1BUF) MSSP Address register (SSP1ADD) MSSP Shift register (SSP1SR) (Not directly accessible) SSP1CON1 and SSP1STAT are the control and status registers in SPI mode operation. The SSP1CON1 register is readable and writable. The lower six bits of the SSP1STAT are read-only. The upper two bits of the SSP1STAT are read/write. In one SPI master mode, SSP1ADD can be loaded with a value used in the Baud Rate Generator. More information on the Baud Rate Generator is available in Section 32.7 "Baud Rate Generator". SSP1SR is the shift register used for shifting data in and out. SSP1BUF provides indirect access to the SSP1SR register. SSP1BUF is the buffer register to which data bytes are written, and from which data bytes are read. In receive operations, SSP1SR and SSP1BUF together create a buffered receiver. When SSP1SR receives a complete byte, it is transferred to SSP1BUF and the SSP1IF interrupt is set. During transmission, the SSP1BUF is not buffered. A write to SSP1BUF will write to both SSP1BUF and SSP1SR. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 364 PIC16(L)F15313/23 32.2.2 SPI MODE OPERATION When initializing the SPI, several options need to be specified. This is done by programming the appropriate control bits (SSP1CON1<3:0> and SSP1STAT<7:6>). These control bits allow the following to be specified: * * * * Master mode (SCK is the clock output) Slave mode (SCK is the clock input) Clock Polarity (Idle state of SCK) Data Input Sample Phase (middle or end of data output time) * Clock Edge (output data on rising/falling edge of SCK) * Clock Rate (Master mode only) * Slave Select mode (Slave mode only) To enable the serial port, SSP Enable bit, SSPEN of the SSP1CON1 register, must be set. To reset or reconfigure SPI mode, clear the SSPEN bit, re-initialize the SSP1CONx registers and then set the SSPEN bit. This configures the SDI, SDO, SCK and SS pins as serial port pins. For the pins to behave as the serial port function, some must have their data direction bits (in the TRISx register) appropriately programmed as follows: * SDI must have corresponding TRIS bit set * SDO must have corresponding TRIS bit cleared * SCK (Master mode) must have corresponding TRIS bit cleared * SCK (Slave mode) must have corresponding TRIS bit set * SS must have corresponding TRIS bit set The MSSP consists of a transmit/receive shift register (SSP1SR) and a buffer register (SSP1BUF). The SSP1SR shifts the data in and out of the device, MSb first. The SSP1BUF holds the data that was written to the SSP1SR until the received data is ready. Once the eight bits of data have been received, that byte is moved to the SSP1BUF register. Then, the Buffer Full Detect bit, BF of the SSP1STAT register, and the interrupt flag bit, SSP1IF, are set. Any write to the SSP1BUF register during transmission/reception of data will be ignored and the write collision detect bit WCOL of the SSP1CON1 register, will be set. User software must clear the WCOL bit to allow the following write(s) to the SSP1BUF register to complete successfully. When the application software is expecting to receive valid data, the SSP1BUF should be read before the next byte of data to transfer is written to the SSP1BUF. The Buffer Full bit, BF of the SSP1STAT register, indicates when SSP1BUF has been loaded with the received data (transmission is complete). When the SSP1BUF is read, the BF bit is cleared. This data may be irrelevant if the SPI is only a transmitter. Generally, the MSSP interrupt is used to determine when the transmission/reception has completed. If the interrupt method is not going to be used, then software polling can be done to ensure that a write collision does not occur. The SSP1SR is not directly readable or writable and can only be accessed by addressing the SSP1BUF register. Any serial port function that is not desired may be overridden by programming the corresponding data direction (TRIS) register to the opposite value. FIGURE 32-5: SPI MASTER/SLAVE CONNECTION SPI Master SSPM<3:0> = 00xx = 1010 SPI Slave SSPM<3:0> = 010x SDO SDI Serial Input Buffer (SSP1BUF) SDI Shift Register (SSP1SR) MSb Serial Input Buffer (SSP1BUF) LSb SCK General I/O Processor 1 2017 Microchip Technology Inc. SDO Serial Clock Slave Select (optional) Preliminary Shift Register (SSP1SR) MSb LSb SCK SS Processor 2 DS40001897A-page 365 PIC16(L)F15313/23 32.2.3 SPI MASTER MODE The clock polarity is selected by appropriately programming the CKP bit of the SSP1CON1 register and the CKE bit of the SSP1STAT register. This then, would give waveforms for SPI communication as shown in Figure 32-6, Figure 32-8, Figure 32-9 and Figure 32-10, where the MSB is transmitted first. In Master mode, the SPI clock rate (bit rate) is user programmable to be one of the following: The master can initiate the data transfer at any time because it controls the SCK line. The master determines when the slave (Processor 2, Figure 32-5) is to broadcast data by the software protocol. In Master mode, the data is transmitted/received as soon as the SSP1BUF register is written to. If the SPI is only going to receive, the SDO output could be disabled (programmed as an input). The SSP1SR register will continue to shift in the signal present on the SDI pin at the programmed clock rate. As each byte is received, it will be loaded into the SSP1BUF register as if a normal received byte (interrupts and Status bits appropriately set). * * * * * FOSC/4 (or TCY) FOSC/16 (or 4 * TCY) FOSC/64 (or 16 * TCY) Timer2 output/2 FOSC/(4 * (SSP1ADD + 1)) Figure 32-6 shows the waveforms for Master mode. When the CKE bit is set, the SDO data is valid before there is a clock edge on SCK. The change of the input sample is shown based on the state of the SMP bit. The time when the SSP1BUF is loaded with the received data is shown. FIGURE 32-6: SPI MODE WAVEFORM (MASTER MODE) Write to SSP1BUF SCK (CKP = 0 CKE = 0) SCK (CKP = 1 CKE = 0) 4 Clock Modes SCK (CKP = 0 CKE = 1) SCK (CKP = 1 CKE = 1) SDO (CKE = 0) bit 7 bit 6 bit 5 bit 4 bit 3 bit 2 bit 1 bit 0 SDO (CKE = 1) bit 7 bit 6 bit 5 bit 4 bit 3 bit 2 bit 1 bit 0 SDI (SMP = 0) bit 0 bit 7 Input Sample (SMP = 0) SDI (SMP = 1) bit 0 bit 7 Input Sample (SMP = 1) SSP1IF SSP1SR to SSP1BUF 2017 Microchip Technology Inc. Preliminary DS40001897A-page 366 PIC16(L)F15313/23 32.2.4 32.2.5 SPI SLAVE MODE In Slave mode, the data is transmitted and received as external clock pulses appear on SCK. When the last bit is latched, the SSP1IF interrupt flag bit is set. Before enabling the module in SPI Slave mode, the clock line must match the proper Idle state. The clock line can be observed by reading the SCK pin. The Idle state is determined by the CKP bit of the SSP1CON1 register. While in Slave mode, the external clock is supplied by the external clock source on the SCK pin. This external clock must meet the minimum high and low times as specified in the electrical specifications. While in Sleep mode, the slave can transmit/receive data. The shift register is clocked from the SCK pin input and when a byte is received, the device will generate an interrupt. If enabled, the device will wake-up from Sleep. 32.2.4.1 Daisy-Chain Configuration The SPI bus can sometimes be connected in a daisy-chain configuration. The first slave output is connected to the second slave input, the second slave output is connected to the third slave input, and so on. The final slave output is connected to the master input. Each slave sends out, during a second group of clock pulses, an exact copy of what was received during the first group of clock pulses. The whole chain acts as one large communication shift register. The daisy-chain feature only requires a single Slave Select line from the master device. Figure 32-7 shows the block diagram of a typical daisy-chain connection when operating in SPI mode. In a daisy-chain configuration, only the most recent byte on the bus is required by the slave. Setting the BOEN bit of the SSP1CON3 register will enable writes to the SSP1BUF register, even if the previous byte has not been read. This allows the software to ignore data that may not apply to it. SLAVE SELECT SYNCHRONIZATION The Slave Select can also be used to synchronize communication. The Slave Select line is held high until the master device is ready to communicate. When the Slave Select line is pulled low, the slave knows that a new transmission is starting. If the slave fails to receive the communication properly, it will be reset at the end of the transmission, when the Slave Select line returns to a high state. The slave is then ready to receive a new transmission when the Slave Select line is pulled low again. If the Slave Select line is not used, there is a risk that the slave will eventually become out of sync with the master. If the slave misses a bit, it will always be one bit off in future transmissions. Use of the Slave Select line allows the slave and master to align themselves at the beginning of each transmission. The SS pin allows a Synchronous Slave mode. The SPI must be in Slave mode with SS pin control enabled (SSP1CON1<3:0> = 0100). When the SS pin is low, transmission and reception are enabled and the SDO pin is driven. When the SS pin goes high, the SDO pin is no longer driven, even if in the middle of a transmitted byte and becomes a floating output. External pull-up/pull-down resistors may be desirable depending on the application. Note 1: When the SPI is in Slave mode with SS pin control enabled (SSP1CON1<3:0> = 0100), the SPI module will reset if the SS pin is set to VDD. 2: When the SPI is used in Slave mode with CKE set; the user must enable SS pin control. 3: While operated in SPI Slave mode the SMP bit of the SSP1STAT register must remain clear. When the SPI module resets, the bit counter is forced to `0'. This can be done by either forcing the SS pin to a high level or clearing the SSPEN bit. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 367 PIC16(L)F15313/23 FIGURE 32-7: SPI DAISY-CHAIN CONNECTION SPI Master SCK SCK SDO SDI SDI SPI Slave #1 SDO General I/O SS SCK SDI SPI Slave #2 SDO SS SCK SDI SPI Slave #3 SDO SS FIGURE 32-8: SLAVE SELECT SYNCHRONOUS WAVEFORM SS SCK (CKP = 0 CKE = 0) SCK (CKP = 1 CKE = 0) Write to SSP1BUF Shift register SSP1SR and bit count are reset SSP1BUF to SSP1SR SDO bit 7 bit 6 bit 7 SDI bit 6 bit 0 bit 0 bit 7 bit 7 Input Sample SSP1IF Interrupt Flag SSP1SR to SSP1BUF 2017 Microchip Technology Inc. Preliminary DS40001897A-page 368 PIC16(L)F15313/23 FIGURE 32-9: SPI MODE WAVEFORM (SLAVE MODE WITH CKE = 0) SS Optional SCK (CKP = 0 CKE = 0) SCK (CKP = 1 CKE = 0) Write to SSP1BUF Valid SDO bit 7 bit 6 bit 5 bit 4 bit 3 bit 2 bit 1 bit 0 SDI bit 0 bit 7 Input Sample SSP1IF Interrupt Flag SSP1SR to SSP1BUF Write Collision detection active FIGURE 32-10: SPI MODE WAVEFORM (SLAVE MODE WITH CKE = 1) SS Not Optional SCK (CKP = 0 CKE = 1) SCK (CKP = 1 CKE = 1) Write to SSP1BUF Valid SDO bit 7 bit 6 bit 5 bit 4 bit 3 bit 2 bit 1 bit 0 SDI bit 0 bit 7 Input Sample SSP1IF Interrupt Flag SSP1SR to SSP1BUF Write Collision detection active 2017 Microchip Technology Inc. Preliminary DS40001897A-page 369 PIC16(L)F15313/23 32.2.6 SPI OPERATION IN SLEEP MODE In SPI Master mode, module clocks may be operating at a different speed than when in Full-Power mode; in the case of the Sleep mode, all clocks are halted. In SPI Master mode, when the Sleep mode is selected, all module clocks are halted and the transmission/reception will remain in that state until the device wakes. After the device returns to Run mode, the module will resume transmitting and receiving data. In SPI Slave mode, the SPI Transmit/Receive Shift register operates asynchronously to the device. This allows the device to be placed in Sleep mode and data to be shifted into the SPI Transmit/Receive Shift register. When all eight bits have been received, the MSSP interrupt flag bit will be set and if enabled, will wake the device. 32.3 I2C This is followed by a single Read/Write bit, which determines whether the master intends to transmit to or receive data from the slave device. If the requested slave exists on the bus, it will respond with an Acknowledge bit, otherwise known as an ACK. The master then continues in either Transmit mode or Receive mode and the slave continues in the complement, either in Receive mode or Transmit mode, respectively. FIGURE 32-11: VDD SCL MODE OVERVIEW The Inter-Integrated Circuit bus is a multi-master serial data communication bus. Devices communicate in a master/slave environment where the master devices initiate the communication. A slave device is controlled through addressing. SCL VDD Master (I2C) The I2C bus specifies two signal connections: I2C MASTER/ SLAVE CONNECTION Slave SDA SDA The Acknowledge bit (ACK) is an active-low signal, which holds the SDA line low to indicate to the transmitter that the slave device has received the transmitted data and is ready to receive more. * Serial Clock (SCL) * Serial Data (SDA) Figure 32-11 shows the block diagram of the MSSP module when operating in I2C mode. Both the SCL and SDA connections are bidirectional open-drain lines, each requiring pull-up resistors for the supply voltage. Pulling the line to ground is considered a logical zero and letting the line float is considered a logical one. Figure 32-11 shows a typical connection between two processors configured as master and slave devices. The I2C bus can operate with one or more master devices and one or more slave devices. There are four potential modes of operation for a given device: * Master Transmit mode (master is transmitting data to a slave) * Master Receive mode (master is receiving data from a slave) * Slave Transmit mode (slave is transmitting data to a master) * Slave Receive mode (slave is receiving data from the master) The transition of a data bit is always performed while the SCL line is held low. Transitions that occur while the SCL line is held high are used to indicate Start and Stop bits. On the last byte of data communicated, the master device may end the transmission by sending a Stop bit. If the master device is in Receive mode, it sends the Stop bit in place of the last ACK bit. A Stop bit is indicated by a low-to-high transition of the SDA line while the SCL line is held high. In some cases, the master may want to maintain control of the bus and re-initiate another transmission. If so, the master device may send another Start bit in place of the Stop bit. To begin communication, a master device starts out in Master Transmit mode. The master device sends out a Start bit followed by the address byte of the slave it intends to communicate with. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 370 PIC16(L)F15313/23 32.3.1 CLOCK STRETCHING 32.4 When a slave device has not completed processing data, it can delay the transfer of more data through the process of clock stretching. An addressed slave device may hold the SCL clock line low after receiving or sending a bit, indicating that it is not yet ready to continue. The master that is communicating with the slave will attempt to raise the SCL line in order to transfer the next bit, but will detect that the clock line has not yet been released. Because the SCL connection is open-drain, the slave has the ability to hold that line low until it is ready to continue communicating. Clock stretching allows receivers that cannot keep up with a transmitter to control the flow of incoming data. 32.3.2 ARBITRATION Each master device must monitor the bus for Start and Stop bits. If the device detects that the bus is busy, it cannot begin a new message until the bus returns to an Idle state. However, two master devices may try to initiate a transmission on or about the same time. When this occurs, the process of arbitration begins. Each transmitter checks the level of the SDA data line and compares it to the level that it expects to find. The first transmitter to observe that the two levels do not match, loses arbitration, and must stop transmitting on the SDA line. For example, if one transmitter holds the SDA line to a logical one (lets it float) and a second transmitter holds it to a logical zero (pulls it low), the result is that the SDA line will be low. The first transmitter then observes that the level of the line is different than expected and concludes that another transmitter is communicating. The first transmitter to notice this difference is the one that loses arbitration and must stop driving the SDA line. If this transmitter is also a master device, it also must stop driving the SCL line. It then can monitor the lines for a Stop condition before trying to reissue its transmission. In the meantime, the other device that has not noticed any difference between the expected and actual levels on the SDA line continues with its original transmission. Slave Transmit mode can also be arbitrated, when a master addresses multiple slaves, but this is less common. 2017 Microchip Technology Inc. I2C MODE OPERATION All MSSP I2C communication is byte oriented and shifted out MSb first. Six SFR registers and two interrupt flags interface the module with the PIC(R) microcontroller and user software. Two pins, SDA and SCL, are exercised by the module to communicate with other external I2C devices. 32.4.1 BYTE FORMAT All communication in I2C is done in 9-bit segments. A byte is sent from a master to a slave or vice-versa, followed by an Acknowledge bit sent back. After the eighth falling edge of the SCL line, the device outputting data on the SDA changes that pin to an input and reads in an acknowledge value on the next clock pulse. The clock signal, SCL, is provided by the master. Data is valid to change while the SCL signal is low, and sampled on the rising edge of the clock. Changes on the SDA line while the SCL line is high define special conditions on the bus, explained below. 32.4.2 DEFINITION OF I2C TERMINOLOGY There is language and terminology in the description of I2C communication that have definitions specific to I2C. That word usage is defined below and may be used in the rest of this document without explanation. This table was adapted from the Philips I2C specification. 32.4.3 SDA AND SCL PINS Selection of any I2C mode with the SSPEN bit set, forces the SCL and SDA pins to be open-drain. These pins should be set by the user to inputs by setting the appropriate TRIS bits. Note 1: Any device pin can be selected for SDA and SCL functions with the PPS peripheral. These functions are bidirectional. The SDA input is selected with the SSPDATPPS registers. The SCL input is selected with the SSPCLKPPS registers. Outputs are selected with the RxyPPS registers. It is the user's responsibility to make the selections so that both the input and the output for each function is on the same pin. Preliminary DS40001897A-page 371 PIC16(L)F15313/23 32.4.4 SDA HOLD TIME 32.4.5 The hold time of the SDA pin is selected by the SDAHT bit of the SSP1CON3 register. Hold time is the time SDA is held valid after the falling edge of SCL. Setting the SDAHT bit selects a longer 300 ns minimum hold time and may help on buses with large capacitance. TABLE 32-1: TERM I2C BUS TERMS Transmitter The device which shifts data out onto the bus. Receiver The device which shifts data in from the bus. Master The device that initiates a transfer, generates clock signals and terminates a transfer. Slave The device addressed by the master. Multi-master A bus with more than one device that can initiate data transfers. Arbitration Procedure to ensure that only one master at a time controls the bus. Winning arbitration ensures that the message is not corrupted. Synchronization Procedure to synchronize the clocks of two or more devices on the bus. Idle No master is controlling the bus, and both SDA and SCL lines are high. Active Any time one or more master devices are controlling the bus. Addressed Slave device that has received a Slave matching address and is actively being clocked by a master. Matching Address byte that is clocked into a Address slave that matches the value stored in SSP1ADD. Write Request Slave receives a matching address with R/W bit clear, and is ready to clock in data. Read Request Master sends an address byte with the R/W bit set, indicating that it wishes to clock data out of the Slave. This data is the next and all following bytes until a Restart or Stop. Clock Stretching When a device on the bus hold SCL low to stall communication. Bus Collision Any time the SDA line is sampled low by the module while it is outputting and expected high state. 2017 Microchip Technology Inc. The I2C specification defines a Start condition as a transition of SDA from a high to a low state while SCL line is high. A Start condition is always generated by the master and signifies the transition of the bus from an Idle to an active state. Figure 32-12 shows wave forms for Start and Stop conditions. 32.4.6 Description START CONDITION STOP CONDITION A Stop condition is a transition of the SDA line from low-to-high state while the SCL line is high. Note: At least one SCL low time must appear before a Stop is valid, therefore, if the SDA line goes low then high again while the SCL line stays high, only the Start condition is detected. 32.4.7 RESTART CONDITION A Restart is valid any time that a Stop would be valid. A master can issue a Restart if it wishes to hold the bus after terminating the current transfer. A Restart has the same effect on the slave that a Start would, resetting all slave logic and preparing it to clock in an address. The master may want to address the same or another slave. Figure 32-13 shows the wave form for a Restart condition. In 10-bit Addressing Slave mode a Restart is required for the master to clock data out of the addressed slave. Once a slave has been fully addressed, matching both high and low address bytes, the master can issue a Restart and the high address byte with the R/W bit set. The slave logic will then hold the clock and prepare to clock out data. 32.4.8 START/STOP CONDITION INTERRUPT MASKING The SCIE and PCIE bits of the SSP1CON3 register can enable the generation of an interrupt in Slave modes that do not typically support this function. Slave modes where interrupt on Start and Stop detect are already enabled, these bits will have no effect. Preliminary DS40001897A-page 372 PIC16(L)F15313/23 FIGURE 32-12: I2C START AND STOP CONDITIONS SDA SCL S Start P Change of Change of Data Allowed Data Allowed Condition FIGURE 32-13: Stop Condition I2C RESTART CONDITION Sr Change of Change of Data Allowed Restart Data Allowed Condition 32.4.9 ACKNOWLEDGE SEQUENCE The 9th SCL pulse for any transferred byte in I2C is dedicated as an Acknowledge. It allows receiving devices to respond back to the transmitter by pulling the SDA line low. The transmitter must release control of the line during this time to shift in the response. The Acknowledge (ACK) is an active-low signal, pulling the SDA line low indicates to the transmitter that the device has received the transmitted data and is ready to receive more. The result of an ACK is placed in the ACKSTAT bit of the SSP1CON2 register. 2017 Microchip Technology Inc. Slave software, when the AHEN and DHEN bits are set, allow the user to set the ACK value sent back to the transmitter. The ACKDT bit of the SSP1CON2 register is set/cleared to determine the response. There are certain conditions where an ACK will not be sent by the slave. If the BF bit of the SSP1STAT register or the SSPOV bit of the SSP1CON1 register are set when a byte is received. When the module is addressed, after the eighth falling edge of SCL on the bus, the ACKTIM bit of the SSP1CON3 register is set. The ACKTIM bit indicates the acknowledge time of the active bus. The ACKTIM Status bit is only active when the AHEN bit or DHEN bit is enabled. Preliminary DS40001897A-page 373 PIC16(L)F15313/23 32.5 I2C SLAVE MODE OPERATION 32.5.2 The MSSP Slave mode operates in one of four modes selected by the SSPM bits of SSP1CON1 register. The modes can be divided into 7-bit and 10-bit Addressing mode. 10-bit Addressing modes operate the same as 7-bit with some additional overhead for handling the larger addresses. Modes with Start and Stop bit interrupts operate the same as the other modes with SSP1IF additionally getting set upon detection of a Start, Restart, or Stop condition. 32.5.1 SLAVE MODE ADDRESSES The SSP1ADD register (Register 32-6) contains the Slave mode address. The first byte received after a Start or Restart condition is compared against the value stored in this register. If the byte matches, the value is loaded into the SSP1BUF register and an interrupt is generated. If the value does not match, the module goes idle and no indication is given to the software that anything happened. The SSP Mask register (Register 32-5) affects the address matching process. See Section 32.5.9 "SSP Mask Register" for more information. 32.5.1.1 I2C Slave 7-bit Addressing Mode In 7-bit Addressing mode, the LSb of the received data byte is ignored when determining if there is an address match. 32.5.1.2 I2C Slave 10-bit Addressing Mode In 10-bit Addressing mode, the first received byte is compared to the binary value of `1 1 1 1 0 A9 A8 0'. A9 and A8 are the two MSb's of the 10-bit address and stored in bits 2 and 1 of the SSP1ADD register. After the acknowledge of the high byte the UA bit is set and SCL is held low until the user updates SSP1ADD with the low address. The low address byte is clocked in and all eight bits are compared to the low address value in SSP1ADD. Even if there is not an address match; SSP1IF and UA are set, and SCL is held low until SSP1ADD is updated to receive a high byte again. When SSP1ADD is updated the UA bit is cleared. This ensures the module is ready to receive the high address byte on the next communication. A high and low address match as a write request is required at the start of all 10-bit addressing communication. A transmission can be initiated by issuing a Restart once the slave is addressed, and clocking in the high address with the R/W bit set. The slave hardware will then acknowledge the read request and prepare to clock out data. This is only valid for a slave after it has received a complete high and low address byte match. 2017 Microchip Technology Inc. SLAVE RECEPTION When the R/W bit of a matching received address byte is clear, the R/W bit of the SSP1STAT register is cleared. The received address is loaded into the SSP1BUF register and acknowledged. When the overflow condition exists for a received address, then not Acknowledge is given. An overflow condition is defined as either bit BF of the SSP1STAT register is set, or bit SSPOV of the SSP1CON1 register is set. The BOEN bit of the SSP1CON3 register modifies this operation. For more information see Register 32-4. An MSSP interrupt is generated for each transferred data byte. Flag bit, SSP1IF, must be cleared by software. When the SEN bit of the SSP1CON2 register is set, SCL will be held low (clock stretch) following each received byte. The clock must be released by setting the CKP bit of the SSP1CON1 register. 32.5.2.1 7-bit Addressing Reception This section describes a standard sequence of events for the MSSP module configured as an I2C slave in 7-bit Addressing mode. Figure 32-14 and Figure 32-15 is used as a visual reference for this description. This is a step by step process of what typically must be done to accomplish I2C communication. 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. Preliminary Start bit detected. S bit of SSP1STAT is set; SSP1IF is set if interrupt on Start detect is enabled. Matching address with R/W bit clear is received. The slave pulls SDA low sending an ACK to the master, and sets SSP1IF bit. Software clears the SSP1IF bit. Software reads received address from SSP1BUF clearing the BF flag. If SEN = 1; Slave software sets CKP bit to release the SCL line. The master clocks out a data byte. Slave drives SDA low sending an ACK to the master, and sets SSP1IF bit. Software clears SSP1IF. Software reads the received byte from SSP1BUF clearing BF. Steps 8-12 are repeated for all received bytes from the master. Master sends Stop condition, setting P bit of SSP1STAT, and the bus goes idle. DS40001897A-page 374 PIC16(L)F15313/23 32.5.2.2 7-bit Reception with AHEN and DHEN Slave device reception with AHEN and DHEN set operate the same as without these options with extra interrupts and clock stretching added after the eighth falling edge of SCL. These additional interrupts allows time for the slave software to decide whether it wants to ACK the receive address or data byte. This list describes the steps that need to be taken by slave software to use these options for I2C communication. Figure 32-16 displays a module using both address and data holding. Figure 32-17 includes the operation with the SEN bit of the SSP1CON2 register set. 1. S bit of SSP1STAT is set; SSP1IF is set if interrupt on Start detect is enabled. 2. Matching address with R/W bit clear is clocked in. SSP1IF is set and CKP cleared after the eighth falling edge of SCL. 3. Slave clears the SSP1IF. 4. Slave can look at the ACKTIM bit of the SSP1CON3 register to determine if the SSP1IF was after or before the ACK. 5. Slave reads the address value from SSP1BUF, clearing the BF flag. 6. Slave sets ACK value clocked out to the master by setting ACKDT. 7. Slave releases the clock by setting CKP. 8. SSP1IF is set after an ACK, not after a NACK. 9. If SEN = 1 the slave hardware will stretch the clock after the ACK. 10. Slave clears SSP1IF. Note: SSP1IF is still set after the ninth falling edge of SCL even if there is no clock stretching and BF has been cleared. Only if NACK is sent to master is SSP1IF not set 11. SSP1IF set and CKP cleared after eighth falling edge of SCL for a received data byte. 12. Slave looks at ACKTIM bit of SSP1CON3 to determine the source of the interrupt. 13. Slave reads the received data from SSP1BUF clearing BF. 14. Steps 7-14 are the same for each received data byte. 15. Communication is ended by either the slave sending an ACK = 1, or the master sending a Stop condition. If a Stop is sent and Interrupt on Stop Detect is disabled, the slave will only know by polling the P bit of the SSP1STAT register. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 375 2017 Microchip Technology Inc. I2C SLAVE, 7-BIT ADDRESS, RECEPTION (SEN = 0, AHEN = 0, DHEN = 0) FIGURE 32-14: Bus Master sends Stop condition From Slave to Master Receiving Address SDA SCL S Receiving Data A7 A6 A5 A4 A3 A2 A1 1 2 3 4 5 6 7 ACK 8 9 Receiving Data D7 D6 D5 D4 D3 D2 D1 1 2 3 4 5 6 7 D0 ACK D7 8 9 1 ACK = 1 D6 D5 D4 D3 D2 D1 D0 2 3 4 5 6 7 8 9 P Preliminary SSP1IF Cleared by software Cleared by software SSP1BUF is read First byte of data is available in SSP1BUF SSPOV SSPOV set because SSP1BUF is still full. ACK is not sent. DS40001897A-page 376 PIC16(L)F15313/23 BF SSP1IF set on 9th falling edge of SCL 2017 Microchip Technology Inc. I2C SLAVE, 7-BIT ADDRESS, RECEPTION (SEN = 1, AHEN = 0, DHEN = 0) FIGURE 32-15: Bus Master sends Stop condition Receive Address SDA SCL S Receive Data A7 A6 A5 A4 A3 A2 A1 1 2 3 4 5 6 7 R/W=0 ACK 8 9 SEN Receive Data D7 D6 D5 D4 D3 D2 D1 D0 ACK 1 2 3 4 5 6 7 8 9 SEN ACK D7 D6 D5 D4 D3 D2 D1 D0 1 2 3 4 5 6 7 8 9 P Clock is held low until CKP is set to `1' Preliminary SSP1IF Cleared by software BF SSP1IF set on 9th falling edge of SCL First byte of data is available in SSP1BUF SSPOV SSPOV set because SSP1BUF is still full. ACK is not sent. CKP DS40001897A-page 377 CKP is written to `1' in software, releasing SCL CKP is written to `1' in software, releasing SCL SCL is not held low because ACK= 1 PIC16(L)F15313/23 SSP1BUF is read Cleared by software 2017 Microchip Technology Inc. I2C SLAVE, 7-BIT ADDRESS, RECEPTION (SEN = 0, AHEN = 1, DHEN = 1) FIGURE 32-16: Master sends Stop condition Master Releases SDA to slave for ACK sequence Receiving Address SDA Receiving Data ACK D7 D6 D5 D4 D3 D2 D1 D0 A7 A6 A5 A4 A3 A2 A1 Received Data ACK ACK=1 D7 D6 D5 D4 D3 D2 D1 D0 SCL S 1 2 3 4 5 6 7 8 9 1 2 3 4 5 6 7 8 9 1 2 3 4 5 6 7 8 9 P SSP1IF If AHEN = 1: SSP1IF is set BF Preliminary ACKDT CKP SSP1IF is set on 9th falling edge of SCL, after ACK Address is read from SSP1BUF Data is read from SSP1BUF Slave software clears ACKDT to ACK the received byte Slave software sets ACKDT to not ACK When DHEN = 1: CKP is cleared by hardware on 8th falling edge of SCL CKP set by software, SCL is released ACKTIM ACKTIM set by hardware on 8th falling edge of SCL DS40001897A-page 378 S P ACKTIM cleared by hardware in 9th rising edge of SCL ACKTIM set by hardware on 8th falling edge of SCL PIC16(L)F15313/23 When AHEN = 1: CKP is cleared by hardware and SCL is stretched No interrupt after not ACK from Slave Cleared by software 2017 Microchip Technology Inc. I2C SLAVE, 7-BIT ADDRESS, RECEPTION (SEN = 1, AHEN = 1, DHEN = 1) FIGURE 32-17: R/W = 0 Receiving Address SDA ACK A7 A6 A5 A4 A3 A2 A1 SCL S 1 2 3 4 5 6 7 Master sends Stop condition Master releases SDA to slave for ACK sequence 8 9 Receive Data 1 2 3 4 5 6 ACK Receive Data D7 D6 D5 D4 D3 D2 D1 D0 7 8 ACK 9 D7 D6 D5 D4 D3 D2 D1 D0 1 2 3 4 5 6 7 8 9 P SSP1IF No interrupt after if not ACK from Slave Cleared by software Preliminary BF Received address is loaded into SSP1BUF Received data is available on SSP1BUF ACKDT Slave sends not ACK CKP When AHEN = 1; on the 8th falling edge of SCL of an address byte, CKP is cleared When DHEN = 1; on the 8th falling edge of SCL of a received data byte, CKP is cleared ACKTIM ACKTIM is set by hardware on 8th falling edge of SCL DS40001897A-page 379 S P ACKTIM is cleared by hardware on 9th rising edge of SCL Set by software, release SCL CKP is not cleared if not ACK PIC16(L)F15313/23 Slave software clears ACKDT to ACK the received byte SSP1BUF can be read any time before next byte is loaded PIC16(L)F15313/23 32.5.3 SLAVE TRANSMISSION 32.5.3.2 7-bit Transmission When the R/W bit of the incoming address byte is set and an address match occurs, the R/W bit of the SSP1STAT register is set. The received address is loaded into the SSP1BUF register, and an ACK pulse is sent by the slave on the ninth bit. A master device can transmit a read request to a slave, and then clock data out of the slave. The list below outlines what software for a slave will need to do to accomplish a standard transmission. Figure 32-18 can be used as a reference to this list. Following the ACK, slave hardware clears the CKP bit and the SCL pin is held low (see Section 32.5.6 "Clock Stretching" for more detail). By stretching the clock, the master will be unable to assert another clock pulse until the slave is done preparing the transmit data. 1. The transmit data must be loaded into the SSP1BUF register which also loads the SSP1SR register. Then the SCL pin should be released by setting the CKP bit of the SSP1CON1 register. The eight data bits are shifted out on the falling edge of the SCL input. This ensures that the SDA signal is valid during the SCL high time. The ACK pulse from the master-receiver is latched on the rising edge of the ninth SCL input pulse. This ACK value is copied to the ACKSTAT bit of the SSP1CON2 register. If ACKSTAT is set (not ACK), then the data transfer is complete. In this case, when the not ACK is latched by the slave, the slave goes idle and waits for another occurrence of the Start bit. If the SDA line was low (ACK), the next transmit data must be loaded into the SSP1BUF register. Again, the SCL pin must be released by setting bit CKP. An MSSP interrupt is generated for each data transfer byte. The SSP1IF bit must be cleared by software and the SSP1STAT register is used to determine the status of the byte. The SSP1IF bit is set on the falling edge of the ninth clock pulse. 32.5.3.1 Slave Mode Bus Collision A slave receives a read request and begins shifting data out on the SDA line. If a bus collision is detected and the SBCDE bit of the SSP1CON3 register is set, the BCL1IF bit of the PIR3 register is set. Once a bus collision is detected, the slave goes idle and waits to be addressed again. User software can use the BCL1IF bit to handle a slave bus collision. 2017 Microchip Technology Inc. Master sends a Start condition on SDA and SCL. 2. S bit of SSP1STAT is set; SSP1IF is set if interrupt on Start detect is enabled. 3. Matching address with R/W bit set is received by the Slave setting SSP1IF bit. 4. Slave hardware generates an ACK and sets SSP1IF. 5. SSP1IF bit is cleared by user. 6. Software reads the received address from SSP1BUF, clearing BF. 7. R/W is set so CKP was automatically cleared after the ACK. 8. The slave software loads the transmit data into SSP1BUF. 9. CKP bit is set releasing SCL, allowing the master to clock the data out of the slave. 10. SSP1IF is set after the ACK response from the master is loaded into the ACKSTAT register. 11. SSP1IF bit is cleared. 12. The slave software checks the ACKSTAT bit to see if the master wants to clock out more data. Note 1: If the master ACKs the clock will be stretched. 2: ACKSTAT is the only bit updated on the rising edge of SCL (9th) rather than the falling. 13. Steps 9-13 are repeated for each transmitted byte. 14. If the master sends a not ACK; the clock is not held, but SSP1IF is still set. 15. The master sends a Restart condition or a Stop. 16. The slave is no longer addressed. Preliminary DS40001897A-page 380 2017 Microchip Technology Inc. I2C SLAVE, 7-BIT ADDRESS, TRANSMISSION (AHEN = 0) FIGURE 32-18: Master sends Stop condition Receiving Address SDA R/W = 1 A7 A6 A5 A4 A3 A2 A1 SCL S 1 2 3 4 5 6 7 ACK 8 9 Automatic Transmitting Data Automatic ACK Transmitting Data D7 D6 D5 D4 D3 D2 D1 D0 ACK D7 D6 D5 D4 D3 D2 D1 D0 1 1 2 3 4 5 6 7 8 9 2 3 4 5 6 7 8 9 P SSP1IF Cleared by software BF Received address is read from SSP1BUF Data to transmit is loaded into SSP1BUF BF is automatically cleared after 8th falling edge of SCL Preliminary CKP When R/W is set SCL is always held low after 9th SCL falling edge Set by software CKP is not held for not ACK ACKSTAT R/W R/W is copied from the matching address byte D/A DS40001897A-page 381 Indicates an address has been received S P PIC16(L)F15313/23 Masters not ACK is copied to ACKSTAT PIC16(L)F15313/23 32.5.3.3 7-bit Transmission with Address Hold Enabled Setting the AHEN bit of the SSP1CON3 register enables additional clock stretching and interrupt generation after the eighth falling edge of a received matching address. Once a matching address has been clocked in, CKP is cleared and the SSP1IF interrupt is set. Figure 32-19 displays a standard waveform of a 7-bit address slave transmission with AHEN enabled. 1. 2. Bus starts Idle. Master sends Start condition; the S bit of SSP1STAT is set; SSP1IF is set if interrupt on Start detect is enabled. 3. Master sends matching address with R/W bit set. After the eighth falling edge of the SCL line the CKP bit is cleared and SSP1IF interrupt is generated. 4. Slave software clears SSP1IF. 5. Slave software reads ACKTIM bit of SSP1CON3 register, and R/W and D/A of the SSP1STAT register to determine the source of the interrupt. 6. Slave reads the address value from the SSP1BUF register clearing the BF bit. 7. Slave software decides from this information if it wishes to ACK or not ACK and sets the ACKDT bit of the SSP1CON2 register accordingly. 8. Slave sets the CKP bit releasing SCL. 9. Master clocks in the ACK value from the slave. 10. Slave hardware automatically clears the CKP bit and sets SSP1IF after the ACK if the R/W bit is set. 11. Slave software clears SSP1IF. 12. Slave loads value to transmit to the master into SSP1BUF setting the BF bit. Note: SSP1BUF cannot be loaded until after the ACK. 13. Slave sets the CKP bit releasing the clock. 14. Master clocks out the data from the slave and sends an ACK value on the ninth SCL pulse. 15. Slave hardware copies the ACK value into the ACKSTAT bit of the SSP1CON2 register. 16. Steps 10-15 are repeated for each byte transmitted to the master from the slave. 17. If the master sends a not ACK the slave releases the bus allowing the master to send a Stop and end the communication. Note: Master must send a not ACK on the last byte to ensure that the slave releases the SCL line to receive a Stop. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 382 2017 Microchip Technology Inc. FIGURE 32-19: I2C SLAVE, 7-BIT ADDRESS, TRANSMISSION (AHEN = 1) Master sends Stop condition Master releases SDA to slave for ACK sequence Receiving Address SDA SCL ACK A7 A6 A5 A4 A3 A2 A1 S 1 2 3 4 5 6 Automatic R/W = 1 7 8 9 Transmitting Data Automatic ACK D7 D6 D5 D4 D3 D2 D1 D0 D7 D6 D5 D4 D3 D2 D1 D0 1 1 2 3 4 5 6 7 8 9 Transmitting Data 2 3 4 5 6 7 ACK 8 9 P SSP1IF Cleared by software BF Received address is read from SSP1BUF Data to transmit is loaded into SSP1BUF BF is automatically cleared after 8th falling edge of SCL Preliminary ACKDT Slave clears ACKDT to ACK address ACKSTAT CKP When AHEN = 1; CKP is cleared by hardware after receiving matching address. ACKTIM DS40001897A-page 383 R/W D/A ACKTIM is set on 8th falling edge of SCL CKP not cleared When R/W = 1; CKP is always cleared after ACK Set by software, releases SCL ACKTIM is cleared on 9th rising edge of SCL after not ACK PIC16(L)F15313/23 Master's ACK response is copied to SSP1STAT PIC16(L)F15313/23 32.5.4 32.5.5 SLAVE MODE 10-BIT ADDRESS RECEPTION This section describes a standard sequence of events for the MSSP module configured as an I2C slave in 10-bit Addressing mode. Figure 32-20 is used as a visual reference for this description. This is a step by step process of what must be done by slave software to accomplish I2C communication. 1. 2. 3. 4. 5. 6. 7. 8. Bus starts Idle. Master sends Start condition; S bit of SSP1STAT is set; SSP1IF is set if interrupt on Start detect is enabled. Master sends matching high address with R/W bit clear; UA bit of the SSP1STAT register is set. Slave sends ACK and SSP1IF is set. Software clears the SSP1IF bit. Software reads received address from SSP1BUF clearing the BF flag. Slave loads low address into SSP1ADD, releasing SCL. Master sends matching low address byte to the slave; UA bit is set. 10-BIT ADDRESSING WITH ADDRESS OR DATA HOLD Reception using 10-bit addressing with AHEN or DHEN set is the same as with 7-bit modes. The only difference is the need to update the SSP1ADD register using the UA bit. All functionality, specifically when the CKP bit is cleared and SCL line is held low are the same. Figure 32-21 can be used as a reference of a slave in 10-bit addressing with AHEN set. Figure 32-22 shows a standard waveform for a slave transmitter in 10-bit Addressing mode. Note: Updates to the SSP1ADD register are not allowed until after the ACK sequence. 9. Slave sends ACK and SSP1IF is set. Note: If the low address does not match, SSP1IF and UA are still set so that the slave software can set SSP1ADD back to the high address. BF is not set because there is no match. CKP is unaffected. 10. Slave clears SSP1IF. 11. Slave reads the received matching address from SSP1BUF clearing BF. 12. Slave loads high address into SSP1ADD. 13. Master clocks a data byte to the slave and clocks out the slaves ACK on the ninth SCL pulse; SSP1IF is set. 14. If SEN bit of SSP1CON2 is set, CKP is cleared by hardware and the clock is stretched. 15. Slave clears SSP1IF. 16. Slave reads the received byte from SSP1BUF clearing BF. 17. If SEN is set the slave sets CKP to release the SCL. 18. Steps 13-17 repeat for each received byte. 19. Master sends Stop to end the transmission. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 384 2017 Microchip Technology Inc. I2C SLAVE, 10-BIT ADDRESS, RECEPTION (SEN = 1, AHEN = 0, DHEN = 0) FIGURE 32-20: Master sends Stop condition Receive Second Address Byte Receive First Address Byte SDA SCL S 1 1 1 1 0 A9 A8 1 2 3 4 5 6 7 ACK 8 9 A7 A6 A5 A4 A3 A2 A1 A0 ACK 1 2 3 4 5 6 7 8 9 Receive Data Receive Data D7 D6 D5 D4 D3 D2 D1 D0 ACK 1 2 3 4 5 6 7 8 9 D7 D6 D5 D4 D3 D2 D1 D0 ACK 1 2 3 4 5 6 7 8 9 P SCL is held low while CKP = 0 SSP1IF Preliminary Set by hardware on 9th falling edge Cleared by software BF Receive address is read from SSP1BUF Data is read from SSP1BUF UA When UA = 1; SCL is held low Software updates SSP1ADD and releases SCL CKP DS40001897A-page 385 Set by software, When SEN = 1; releasing SCL CKP is cleared after 9th falling edge of received byte PIC16(L)F15313/23 If address matches SSP1ADD it is loaded into SSP1BUF 2017 Microchip Technology Inc. I2C SLAVE, 10-BIT ADDRESS, RECEPTION (SEN = 0, AHEN = 1, DHEN = 0) FIGURE 32-21: Receive First Address Byte SDA SCL S Receive Second Address Byte R/W = 0 1 1 1 1 0 A9 A8 1 2 3 4 5 6 7 ACK 8 9 UA Receive Data A7 A6 A5 A4 A3 A2 A1 A0 ACK 1 2 3 4 5 6 7 8 9 UA Receive Data D7 D6 D5 D4 D3 D2 D1 1 2 3 4 5 6 7 D0 ACK D7 8 9 1 D6 D5 2 SSP1IF Set by hardware on 9th falling edge Cleared by software Cleared by software Preliminary BF SSP1BUF can be read anytime before the next received byte Received data is read from SSP1BUF ACKDT UA Update to SSP1ADD is not allowed until 9th falling edge of SCL CKP DS40001897A-page 386 If when AHEN = 1; on the 8th falling edge of SCL of an address byte, CKP is cleared ACKTIM ACKTIM is set by hardware on 8th falling edge of SCL Update of SSP1ADD, clears UA and releases SCL Set CKP with software releases SCL PIC16(L)F15313/23 Slave software clears ACKDT to ACK the received byte 2017 Microchip Technology Inc. I2C SLAVE, 10-BIT ADDRESS, TRANSMISSION (SEN = 0, AHEN = 0, DHEN = 0) FIGURE 32-22: Master sends Restart event Receiving Address R/W = 0 1 1 1 1 0 A9 A8 SDA SCL S 1 2 3 4 5 6 7 ACK 8 9 Receiving Second Address Byte 2 3 4 5 6 7 8 Transmitting Data Byte Receive First Address Byte A7 A6 A5 A4 A3 A2 A1 A0 ACK 1 Master sends not ACK 1 1 1 1 0 A9 A8 1 9 2 3 4 5 6 7 8 ACK 9 Master sends Stop condition ACK = 1 D7 D6 D5 D4 D3 D2 D1 D0 1 2 3 4 5 6 7 8 9 P Sr SSP1IF Preliminary Set by hardware Cleared by software Set by hardware BF SSP1BUF loaded with received address Received address is read from SSP1BUF Data to transmit is loaded into SSP1BUF UA CKP After SSP1ADD is updated, UA is cleared and SCL is released High address is loaded back into SSP1ADD When R/W = 1; CKP is cleared on 9th falling edge of SCL ACKSTAT Set by software releases SCL Masters not ACK is copied R/W DS40001897A-page 387 R/W is copied from the matching address byte D/A Indicates an address has been received PIC16(L)F15313/23 UA indicates SSP1ADD must be updated PIC16(L)F15313/23 32.5.6 CLOCK STRETCHING 32.5.6.3 Byte NACKing Clock stretching occurs when a device on the bus holds the SCL line low, effectively pausing communication. The slave may stretch the clock to allow more time to handle data or prepare a response for the master device. A master device is not concerned with stretching as anytime it is active on the bus and not transferring data it is stretching. Any stretching done by a slave is invisible to the master software and handled by the hardware that generates SCL. When AHEN bit of SSP1CON3 is set; CKP is cleared by hardware after the eighth falling edge of SCL for a received matching address byte. When DHEN bit of SSP1CON3 is set; CKP is cleared after the eighth falling edge of SCL for received data. The CKP bit of the SSP1CON1 register is used to control stretching in software. Any time the CKP bit is cleared, the module will wait for the SCL line to go low and then hold it. Setting CKP will release SCL and allow more communication. 32.5.7 32.5.6.1 Normal Clock Stretching Following an ACK if the R/W bit of SSP1STAT is set, a read request, the slave hardware will clear CKP. This allows the slave time to update SSP1BUF with data to transfer to the master. If the SEN bit of SSP1CON2 is set, the slave hardware will always stretch the clock after the ACK sequence. Once the slave is ready; CKP is set by software and communication resumes. 32.5.6.2 Stretching after the eighth falling edge of SCL allows the slave to look at the received address or data and decide if it wants to ACK the received data. CLOCK SYNCHRONIZATION AND THE CKP BIT Any time the CKP bit is cleared, the module will wait for the SCL line to go low and then hold it. However, clearing the CKP bit will not assert the SCL output low until the SCL output is already sampled low. Therefore, the CKP bit will not assert the SCL line until an external I2C master device has already asserted the SCL line. The SCL output will remain low until the CKP bit is set and all other devices on the I2C bus have released SCL. This ensures that a write to the CKP bit will not violate the minimum high time requirement for SCL (see Figure 32-23). 10-bit Addressing Mode In 10-bit Addressing mode, when the UA bit is set the clock is always stretched. This is the only time the SCL is stretched without CKP being cleared. SCL is released immediately after a write to SSP1ADD. FIGURE 32-23: CLOCK SYNCHRONIZATION TIMING Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 SDA DX - 1 DX SCL CKP Master device asserts clock Master device releases clock WR SSP1CON1 2017 Microchip Technology Inc. Preliminary DS40001897A-page 388 PIC16(L)F15313/23 32.5.8 GENERAL CALL ADDRESS SUPPORT In 10-bit Address mode, the UA bit will not be set on the reception of the general call address. The slave will prepare to receive the second byte as data, just as it would in 7-bit mode. The addressing procedure for the I2C bus is such that the first byte after the Start condition usually determines which device will be the slave addressed by the master device. The exception is the general call address which can address all devices. When this address is used, all devices should, in theory, respond with an acknowledge. If the AHEN bit of the SSP1CON3 register is set, just as with any other address reception, the slave hardware will stretch the clock after the eighth falling edge of SCL. The slave must then set its ACKDT value and release the clock with communication progressing as it would normally. The general call address is a reserved address in the I2C protocol, defined as address 0x00. When the GCEN bit of the SSP1CON2 register is set, the slave module will automatically ACK the reception of this address regardless of the value stored in SSP1ADD. After the slave clocks in an address of all zeros with the R/W bit clear, an interrupt is generated and slave software can read SSP1BUF and respond. Figure 32-24 shows a general call reception sequence. FIGURE 32-24: SLAVE MODE GENERAL CALL ADDRESS SEQUENCE Address is compared to General Call Address after ACK, set interrupt R/W = 0 ACK D7 General Call Address SDA SCL S 1 2 3 4 5 6 7 8 9 1 Receiving Data ACK D6 D5 D4 D3 D2 D1 D0 2 3 4 5 6 7 8 9 SSP1IF BF (SSP1STAT<0>) Cleared by software SSP1BUF is read GCEN (SSP1CON2<7>) '1' 32.5.9 SSP MASK REGISTER An SSP Mask (SSP1MSK) register (Register 32-5) is available in I2C Slave mode as a mask for the value held in the SSP1SR register during an address comparison operation. A zero (`0') bit in the SSP1MSK register has the effect of making the corresponding bit of the received address a "don't care". 2017 Microchip Technology Inc. This register is reset to all `1's upon any Reset condition and, therefore, has no effect on standard SSP operation until written with a mask value. The SSP Mask register is active during: * 7-bit Address mode: address compare of A<7:1>. * 10-bit Address mode: address compare of A<7:0> only. The SSP mask has no effect during the reception of the first (high) byte of the address. Preliminary DS40001897A-page 389 PIC16(L)F15313/23 32.6 I2C Master Mode 32.6.1 I2C MASTER MODE OPERATION Master mode is enabled by setting and clearing the appropriate SSPM bits in the SSP1CON1 register and by setting the SSPEN bit. In Master mode, the SDA and SCK pins must be configured as inputs. The MSSP peripheral hardware will override the output driver TRIS controls when necessary to drive the pins low. The master device generates all of the serial clock pulses and the Start and Stop conditions. A transfer is ended with a Stop condition or with a Repeated Start condition. Since the Repeated Start condition is also the beginning of the next serial transfer, the I2C bus will not be released. Master mode of operation is supported by interrupt generation on the detection of the Start and Stop conditions. The Stop (P) and Start (S) bits are cleared from a Reset or when the MSSP module is disabled. Control of the I 2C bus may be taken when the P bit is set, or the bus is Idle. In Master Transmitter mode, serial data is output through SDA, while SCL outputs the serial clock. The first byte transmitted contains the slave address of the receiving device (7 bits) and the Read/Write (R/W) bit. In this case, the R/W bit will be logic `0'. Serial data is transmitted eight bits at a time. After each byte is transmitted, an Acknowledge bit is received. Start and Stop conditions are output to indicate the beginning and the end of a serial transfer. In Firmware Controlled Master mode, user code conducts all I 2C bus operations based on Start and Stop bit condition detection. Start and Stop condition detection is the only active circuitry in this mode. All other communication is done by the user software directly manipulating the SDA and SCL lines. The following events will cause the SSP Interrupt Flag bit, SSP1IF, to be set (SSP interrupt, if enabled): * * * * * Start condition generated Stop condition generated Data transfer byte transmitted/received Acknowledge transmitted/received Repeated Start generated Note 1: The MSSP module, when configured in I2C Master mode, does not allow queuing of events. For instance, the user is not allowed to initiate a Start condition and immediately write the SSP1BUF register to initiate transmission before the Start condition is complete. In this case, the SSP1BUF will not be written to and the WCOL bit will be set, indicating that a write to the SSP1BUF did not occur In Master Receive mode, the first byte transmitted contains the slave address of the transmitting device (7 bits) and the R/W bit. In this case, the R/W bit will be logic `1'. Thus, the first byte transmitted is a 7-bit slave address followed by a `1' to indicate the receive bit. Serial data is received via SDA, while SCL outputs the serial clock. Serial data is received eight bits at a time. After each byte is received, an Acknowledge bit is transmitted. Start and Stop conditions indicate the beginning and end of transmission. A Baud Rate Generator is used to set the clock frequency output on SCL. See Section 32.7 "Baud Rate Generator" for more detail. 2: When in Master mode, Start/Stop detection is masked and an interrupt is generated when the SEN/PEN bit is cleared and the generation is complete. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 390 PIC16(L)F15313/23 32.6.2 CLOCK ARBITRATION Clock arbitration occurs when the master, during any receive, transmit or Repeated Start/Stop condition, releases the SCL pin (SCL allowed to float high). When the SCL pin is allowed to float high, the Baud Rate Generator (BRG) is suspended from counting until the SCL pin is actually sampled high. When the SCL pin is sampled high, the Baud Rate Generator is reloaded with the contents of SSP1ADD<7:0> and begins counting. This ensures that the SCL high time will always be at least one BRG rollover count in the event that the clock is held low by an external device (Figure 32-25). FIGURE 32-25: BAUD RATE GENERATOR TIMING WITH CLOCK ARBITRATION SDA DX - 1 DX SCL deasserted but slave holds SCL low (clock arbitration) SCL allowed to transition high SCL BRG decrements on Q2 and Q4 cycles BRG Value 03h 02h 01h 00h (hold off) 03h 02h SCL is sampled high, reload takes place and BRG starts its count BRG Reload 32.6.3 WCOL STATUS FLAG If the user writes the SSP1BUF when a Start, Restart, Stop, Receive or Transmit sequence is in progress, the WCOL is set and the contents of the buffer are unchanged (the write does not occur). Any time the WCOL bit is set it indicates that an action on SSP1BUF was attempted while the module was not idle. Note: Because queuing of events is not allowed, writing to the lower five bits of SSP1CON2 is disabled until the Start condition is complete. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 391 PIC16(L)F15313/23 32.6.4 I2C MASTER MODE START CONDITION TIMING Note 1: If at the beginning of the Start condition, the SDA and SCL pins are already sampled low, or if during the Start condition, the SCL line is sampled low before the SDA line is driven low, a bus collision occurs, the Bus Collision Interrupt Flag, BCLIF, is set, the Start condition is aborted and the I2C module is reset into its Idle state. To initiate a Start condition (Figure 32-26), the user sets the Start Enable bit, SEN bit of the SSP1CON2 register. If the SDA and SCL pins are sampled high, the Baud Rate Generator is reloaded with the contents of SSP1ADD<7:0> and starts its count. If SCL and SDA are both sampled high when the Baud Rate Generator times out (TBRG), the SDA pin is driven low. The action of the SDA being driven low while SCL is high is the Start condition and causes the S bit of the SSP1STAT1 register to be set. Following this, the Baud Rate Generator is reloaded with the contents of SSP1ADD<7:0> and resumes its count. When the Baud Rate Generator times out (TBRG), the SEN bit of the SSP1CON2 register will be automatically cleared by hardware; the Baud Rate Generator is suspended, leaving the SDA line held low and the Start condition is complete. FIGURE 32-26: 2: The Philips I2C specification states that a bus collision cannot occur on a Start. FIRST START BIT TIMING Set S bit (SSP1STAT<3>) Write to SEN bit occurs here At completion of Start bit, hardware clears SEN bit and sets SSP1IF bit SDA = 1, SCL = 1 TBRG TBRG Write to SSP1BUF occurs here SDA 1st bit 2nd bit TBRG SCL S 2017 Microchip Technology Inc. Preliminary TBRG DS40001897A-page 392 PIC16(L)F15313/23 32.6.5 I2C MASTER MODE REPEATED cally cleared and the Baud Rate Generator will not be reloaded, leaving the SDA pin held low. As soon as a Start condition is detected on the SDA and SCL pins, the S bit of the SSP1STAT register will be set. The SSP1IF bit will not be set until the Baud Rate Generator has timed out. START CONDITION TIMING A Repeated Start condition (Figure 32-27) occurs when the RSEN bit of the SSP1CON2 register is programmed high and the master state machine is no longer active. When the RSEN bit is set, the SCL pin is asserted low. When the SCL pin is sampled low, the Baud Rate Generator is loaded and begins counting. The SDA pin is released (brought high) for one Baud Rate Generator count (TBRG). When the Baud Rate Generator times out, if SDA is sampled high, the SCL pin will be deasserted (brought high). When SCL is sampled high, the Baud Rate Generator is reloaded and begins counting. SDA and SCL must be sampled high for one TBRG. This action is then followed by assertion of the SDA pin (SDA = 0) for one TBRG while SCL is high. SCL is asserted low. Following this, the RSEN bit of the SSP1CON2 register will be automati- FIGURE 32-27: Note 1: If RSEN is programmed while any other event is in progress, it will not take effect. 2: A bus collision during the Repeated Start condition occurs if: * SDA is sampled low when SCL goes from low-to-high. * SCL goes low before SDA is asserted low. This may indicate that another master is attempting to transmit a data `1'. REPEATED START CONDITION WAVEFORM S bit set by hardware Write to SSP1CON2 occurs here SDA = 1, SCL (no change) At completion of Start bit, hardware clears RSEN bit and sets SSP1IF SDA = 1, SCL = 1 TBRG TBRG TBRG 1st bit SDA Write to SSP1BUF occurs here TBRG SCL Sr TBRG Repeated Start 2017 Microchip Technology Inc. Preliminary DS40001897A-page 393 PIC16(L)F15313/23 32.6.6 I2C MASTER MODE TRANSMISSION 32.6.6.3 Transmission of a data byte, a 7-bit address or the other half of a 10-bit address is accomplished by simply writing a value to the SSP1BUF register. This action will set the Buffer Full flag bit, BF, and allow the Baud Rate Generator to begin counting and start the next transmission. Each bit of address/data will be shifted out onto the SDA pin after the falling edge of SCL is asserted. SCL is held low for one Baud Rate Generator rollover count (TBRG). Data should be valid before SCL is released high. When the SCL pin is released high, it is held that way for TBRG. The data on the SDA pin must remain stable for that duration and some hold time after the next falling edge of SCL. After the eighth bit is shifted out (the falling edge of the eighth clock), the BF flag is cleared and the master releases SDA. This allows the slave device being addressed to respond with an ACK bit during the ninth bit time if an address match occurred, or if data was received properly. The status of ACK is written into the ACKSTAT bit on the rising edge of the ninth clock. If the master receives an Acknowledge, the Acknowledge Status bit, ACKSTAT, is cleared. If not, the bit is set. After the ninth clock, the SSP1IF bit is set and the master clock (Baud Rate Generator) is suspended until the next data byte is loaded into the SSP1BUF, leaving SCL low and SDA unchanged (Figure 32-28). After the write to the SSP1BUF, each bit of the address will be shifted out on the falling edge of SCL until all seven address bits and the R/W bit are completed. On the falling edge of the eighth clock, the master will release the SDA pin, allowing the slave to respond with an Acknowledge. On the falling edge of the ninth clock, the master will sample the SDA pin to see if the address was recognized by a slave. The status of the ACK bit is loaded into the ACKSTAT Status bit of the SSP1CON2 register. Following the falling edge of the ninth clock transmission of the address, the SSP1IF is set, the BF flag is cleared and the Baud Rate Generator is turned off until another write to the SSP1BUF takes place, holding SCL low and allowing SDA to float. 32.6.6.1 ACKSTAT Status Flag In Transmit mode, the ACKSTAT bit of the SSP1CON2 register is cleared when the slave has sent an Acknowledge (ACK = 0) and is set when the slave does not Acknowledge (ACK = 1). A slave sends an Acknowledge when it has recognized its address (including a general call), or when the slave has properly received its data. 32.6.6.4 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. BF Status Flag Typical transmit sequence: The user generates a Start condition by setting the SEN bit of the SSP1CON2 register. SSP1IF is set by hardware on completion of the Start. SSP1IF is cleared by software. The MSSP module will wait the required start time before any other operation takes place. The user loads the SSP1BUF with the slave address to transmit. Address is shifted out the SDA pin until all eight bits are transmitted. Transmission begins as soon as SSP1BUF is written to. The MSSP module shifts in the ACK bit from the slave device and writes its value into the ACKSTAT bit of the SSP1CON2 register. The MSSP module generates an interrupt at the end of the ninth clock cycle by setting the SSP1IF bit. The user loads the SSP1BUF with eight bits of data. Data is shifted out the SDA pin until all eight bits are transmitted. The MSSP module shifts in the ACK bit from the slave device and writes its value into the ACKSTAT bit of the SSP1CON2 register. Steps 8-11 are repeated for all transmitted data bytes. The user generates a Stop or Restart condition by setting the PEN or RSEN bits of the SSP1CON2 register. Interrupt is generated once the Stop/Restart condition is complete. In Transmit mode, the BF bit of the SSP1STAT register is set when the CPU writes to SSP1BUF and is cleared when all eight bits are shifted out. 32.6.6.2 WCOL Status Flag If the user writes the SSP1BUF when a transmit is already in progress (i.e., SSP1SR is still shifting out a data byte), the WCOL bit is set and the contents of the buffer are unchanged (the write does not occur). WCOL must be cleared by software before the next transmission. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 394 2017 Microchip Technology Inc. I2C MASTER MODE WAVEFORM (TRANSMISSION, 7 OR 10-BIT ADDRESS) FIGURE 32-28: Write SSP1CON2<0> SEN = 1 Start condition begins From slave, clear ACKSTAT bit SSP1CON2<6> SEN = 0 Transmit Address to Slave SDA A7 A6 A5 A4 ACKSTAT in SSP1CON2 = 1 A3 A2 Transmitting Data or Second Half of 10-bit Address R/W = 0 ACK = 0 A1 ACK D7 D6 D5 D4 D3 D2 D1 D0 1 SCL held low while CPU responds to SSP1IF 2 3 4 5 6 7 8 SSP1BUF written with 7-bit address and R/W start transmit SCL S 1 2 3 4 5 6 7 8 9 9 P Preliminary SSP1IF Cleared by software Cleared by software service routine from SSP interrupt SSP1BUF written SEN After Start condition, SEN cleared by hardware PEN DS40001897A-page 395 R/W SSP1BUF is written by software PIC16(L)F15313/23 BF (SSP1STAT<0>) Cleared by software PIC16(L)F15313/23 32.6.7 I2C MASTER MODE RECEPTION 32.6.7.4 Master mode reception (Figure 32-29) is enabled by programming the Receive Enable bit, RCEN bit of the SSP1CON2 register. Note: The MSSP module must be in an Idle state before the RCEN bit is set or the RCEN bit will be disregarded. The Baud Rate Generator begins counting and on each rollover, the state of the SCL pin changes (high-to-low/low-to-high) and data is shifted into the SSP1SR. After the falling edge of the eighth clock, the receive enable flag is automatically cleared, the contents of the SSP1SR are loaded into the SSP1BUF, the BF flag bit is set, the SSP1IF flag bit is set and the Baud Rate Generator is suspended from counting, holding SCL low. The MSSP is now in Idle state awaiting the next command. When the buffer is read by the CPU, the BF flag bit is automatically cleared. The user can then send an Acknowledge bit at the end of reception by setting the Acknowledge Sequence Enable, ACKEN bit of the SSP1CON2 register. 32.6.7.1 BF Status Flag In receive operation, the BF bit is set when an address or data byte is loaded into SSP1BUF from SSP1SR. It is cleared when the SSP1BUF register is read. 32.6.7.2 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. SSPOV Status Flag In receive operation, the SSPOV bit is set when eight bits are received into the SSP1SR and the BF flag bit is already set from a previous reception. 32.6.7.3 1. WCOL Status Flag If the user writes the SSP1BUF when a receive is already in progress (i.e., SSP1SR is still shifting in a data byte), the WCOL bit is set and the contents of the buffer are unchanged (the write does not occur). 2017 Microchip Technology Inc. 12. 13. 14. 15. Preliminary Typical Receive Sequence: The user generates a Start condition by setting the SEN bit of the SSP1CON2 register. SSP1IF is set by hardware on completion of the Start. SSP1IF is cleared by software. User writes SSP1BUF with the slave address to transmit and the R/W bit set. Address is shifted out the SDA pin until all eight bits are transmitted. Transmission begins as soon as SSP1BUF is written to. The MSSP module shifts in the ACK bit from the slave device and writes its value into the ACKSTAT bit of the SSP1CON2 register. The MSSP module generates an interrupt at the end of the ninth clock cycle by setting the SSP1IF bit. User sets the RCEN bit of the SSP1CON2 register and the master clocks in a byte from the slave. After the eighth falling edge of SCL, SSP1IF and BF are set. Master clears SSP1IF and reads the received byte from SSP1BUF, clears BF. Master sets ACK value sent to slave in ACKDT bit of the SSP1CON2 register and initiates the ACK by setting the ACKEN bit. Master's ACK is clocked out to the slave and SSP1IF is set. User clears SSP1IF. Steps 8-13 are repeated for each received byte from the slave. Master sends a not ACK or Stop to end communication. DS40001897A-page 396 2017 Microchip Technology Inc. I2C MASTER MODE WAVEFORM (RECEPTION, 7-BIT ADDRESS) FIGURE 32-29: Write to SSP1CON2<4> to start Ackno1wledge sequence SDA = ACKDT (SSP1CON2<5>) = 0 Write to SSP1CON2<0>(SEN = 1), begin Start condition Transmit Address to Slave A7 SDA A6 A5 A4 A3 A2 RCEN = 1, start next receive ACK PEN bit = 1 written here RCEN cleared automatically Receiving Data from Slave Receiving Data from Slave A1 R/W Set ACKEN, start Acknowledge sequence SDA = ACKDT = 1 ACK from Master SDA = ACKDT = 0 Master configured as a receiver by programming SSP1CON2<3> (RCEN = 1) SEN = 0 Write to SSP1BUF occurs here, RCEN cleared ACK from Slave automatically start XMIT D7 D6 D5 D4 D3 D2 D1 ACK D0 D7 D6 D5 D4 D3 D2 D1 D0 ACK Bus master terminates transfer ACK is not sent SCL S 1 2 3 4 5 6 7 8 9 1 2 3 4 5 6 7 8 9 1 2 3 4 5 6 7 Data shifted in on falling edge of CLK Preliminary Set SSP1IF interrupt at end of receive Cleared by software Cleared by software Cleared by software Cleared by software Cleared in software Last bit is shifted into SSP1SR and contents are unloaded into SSP1BUF SSPOV SSPOV is set because SSP1BUF is still full ACKEN DS40001897A-page 397 RCEN Master configured as a receiver by programming SSP1CON2<3> (RCEN = 1) RCEN cleared automatically ACK from Master SDA = ACKDT = 0 RCEN cleared automatically Set SSP1IF interrupt at end of Acknowledge sequence Set P bit (SSP1STAT<4>) and SSP1IF PIC16(L)F15313/23 BF (SSP1STAT<0>) P Set SSP1IF at end of receive Set SSP1IF interrupt at end of Acknowledge sequence SSP1IF SDA = 0, SCL = 1 while CPU responds to SSP1IF 9 8 PIC16(L)F15313/23 32.6.8 ACKNOWLEDGE SEQUENCE TIMING 32.6.9 A Stop bit is asserted on the SDA pin at the end of a receive/transmit by setting the Stop Sequence Enable bit, PEN bit of the SSP1CON2 register. At the end of a receive/transmit, the SCL line is held low after the falling edge of the ninth clock. When the PEN bit is set, the master will assert the SDA line low. When the SDA line is sampled low, the Baud Rate Generator is reloaded and counts down to `0'. When the Baud Rate Generator times out, the SCL pin will be brought high and one TBRG (Baud Rate Generator rollover count) later, the SDA pin will be deasserted. When the SDA pin is sampled high while SCL is high, the P bit of the SSP1STAT register is set. A TBRG later, the PEN bit is cleared and the SSP1IF bit is set (Figure 32-31). An Acknowledge sequence is enabled by setting the Acknowledge Sequence Enable bit, ACKEN bit of the SSP1CON2 register. When this bit is set, the SCL pin is pulled low and the contents of the Acknowledge data bit are presented on the SDA pin. If the user wishes to generate an Acknowledge, then the ACKDT bit should be cleared. If not, the user should set the ACKDT bit before starting an Acknowledge sequence. The Baud Rate Generator then counts for one rollover period (TBRG) and the SCL pin is deasserted (pulled high). When the SCL pin is sampled high (clock arbitration), the Baud Rate Generator counts for TBRG. The SCL pin is then pulled low. Following this, the ACKEN bit is automatically cleared, the Baud Rate Generator is turned off and the MSSP module then goes into IDLE mode (Figure 32-30). 32.6.8.1 32.6.9.1 WCOL Status Flag If the user writes the SSP1BUF when a Stop sequence is in progress, then the WCOL bit is set and the contents of the buffer are unchanged (the write does not occur). WCOL Status Flag If the user writes the SSP1BUF when an Acknowledge sequence is in progress, then WCOL bit is set and the contents of the buffer are unchanged (the write does not occur). FIGURE 32-30: STOP CONDITION TIMING ACKNOWLEDGE SEQUENCE WAVEFORM Acknowledge sequence starts here, write to SSP1CON2 ACKEN = 1, ACKDT = 0 ACKEN automatically cleared TBRG TBRG SDA ACK D0 SCL 8 9 SSP1IF SSP1IF set at the end of receive Cleared in software Cleared in software SSP1IF set at the end of Acknowledge sequence Note: TBRG = one Baud Rate Generator period. FIGURE 32-31: STOP CONDITION RECEIVE OR TRANSMIT MODE SCL = 1 for TBRG, followed by SDA = 1 for TBRG after SDA sampled high. P bit (SSP1STAT<4>) is set. Write to SSP1CON2, set PEN PEN bit (SSP1CON2<2>) is cleared by hardware and the SSP1IF bit is set Falling edge of 9th clock TBRG SCL SDA ACK P TBRG TBRG TBRG SCL brought high after TBRG SDA asserted low before rising edge of clock to setup Stop condition Note: TBRG = one Baud Rate Generator period. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 398 PIC16(L)F15313/23 32.6.10 SLEEP OPERATION 32.6.13 2 While in Sleep mode, the I C slave module can receive addresses or data and when an address match or complete byte transfer occurs, wake the processor from Sleep (if the MSSP interrupt is enabled). 32.6.11 EFFECTS OF A RESET A Reset disables the MSSP module and terminates the current transfer. 32.6.12 MULTI-MASTER MODE In Multi-Master mode, the interrupt generation on the detection of the Start and Stop conditions allows the determination of when the bus is free. The Stop (P) and Start (S) bits are cleared from a Reset or when the MSSP module is disabled. Control of the I 2C bus may be taken when the P bit of the SSP1STAT register is set, or the bus is Idle, with both the S and P bits clear. When the bus is busy, enabling the SSP interrupt will generate the interrupt when the Stop condition occurs. In multi-master operation, the SDA line must be monitored for arbitration to see if the signal level is the expected output level. This check is performed by hardware with the result placed in the BCL1IF bit. The states where arbitration can be lost are: * * * * * Address Transfer Data Transfer A Start Condition A Repeated Start Condition An Acknowledge Condition MULTI -MASTER COMMUNICATION, BUS COLLISION AND BUS ARBITRATION Multi-Master mode support is achieved by bus arbitration. When the master outputs address/data bits onto the SDA pin, arbitration takes place when the master outputs a `1' on SDA, by letting SDA float high and another master asserts a `0'. When the SCL pin floats high, data should be stable. If the expected data on SDA is a `1' and the data sampled on the SDA pin is `0', then a bus collision has taken place. The master will set the Bus Collision Interrupt Flag, BCL1IF and reset the I2C port to its Idle state (Figure 32-32). If a transmit was in progress when the bus collision occurred, the transmission is halted, the BF flag is cleared, the SDA and SCL lines are deasserted and the SSP1BUF can be written to. When the user services the bus collision Interrupt Service Routine and if the I2C bus is free, the user can resume communication by asserting a Start condition. If a Start, Repeated Start, Stop or Acknowledge condition was in progress when the bus collision occurred, the condition is aborted, the SDA and SCL lines are deasserted and the respective control bits in the SSP1CON2 register are cleared. When the user services the bus collision Interrupt Service Routine and if the I2C bus is free, the user can resume communication by asserting a Start condition. The master will continue to monitor the SDA and SCL pins. If a Stop condition occurs, the SSP1IF bit will be set. A write to the SSP1BUF will start the transmission of data at the first data bit, regardless of where the transmitter left off when the bus collision occurred. In Multi-Master mode, the interrupt generation on the detection of Start and Stop conditions allows the determination of when the bus is free. Control of the I2C bus can be taken when the P bit is set in the SSP1STAT register, or the bus is Idle and the S and P bits are cleared. FIGURE 32-32: BUS COLLISION TIMING FOR TRANSMIT AND ACKNOWLEDGE Data changes while SCL = 0 SDA line pulled low by another source SDA released by master Sample SDA. While SCL is high, data does not match what is driven by the master. Bus collision has occurred. SDA SCL Set bus collision interrupt (BCL1IF) BCL1IF 2017 Microchip Technology Inc. Preliminary DS40001897A-page 399 PIC16(L)F15313/23 32.6.13.1 Bus Collision During a Start Condition During a Start condition, a bus collision occurs if: a) b) SDA or SCL are sampled low at the beginning of the Start condition (Figure 32-33). SCL is sampled low before SDA is asserted low (Figure 32-34). During a Start condition, both the SDA and the SCL pins are monitored. If the SDA pin is sampled low during this count, the BRG is reset and the SDA line is asserted early (Figure 32-35). If, however, a `1' is sampled on the SDA pin, the SDA pin is asserted low at the end of the BRG count. The Baud Rate Generator is then reloaded and counts down to zero; if the SCL pin is sampled as `0' during this time, a bus collision does not occur. At the end of the BRG count, the SCL pin is asserted low. Note: If the SDA pin is already low, or the SCL pin is already low, then all of the following occur: * the Start condition is aborted, * the BCL1IF flag is set and * the MSSP module is reset to its Idle state (Figure 32-33). The Start condition begins with the SDA and SCL pins deasserted. When the SDA pin is sampled high, the Baud Rate Generator is loaded and counts down. If the SCL pin is sampled low while SDA is high, a bus collision occurs because it is assumed that another master is attempting to drive a data `1' during the Start condition. FIGURE 32-33: The reason that bus collision is not a factor during a Start condition is that no two bus masters can assert a Start condition at the exact same time. Therefore, one master will always assert SDA before the other. This condition does not cause a bus collision because the two masters must be allowed to arbitrate the first address following the Start condition. If the address is the same, arbitration must be allowed to continue into the data portion, Repeated Start or Stop conditions. BUS COLLISION DURING START CONDITION (SDA ONLY) SDA goes low before the SEN bit is set. Set BCL1IF, S bit and SSP1IF set because SDA = 0, SCL = 1. SDA SCL Set SEN, enable Start condition if SDA = 1, SCL = 1 SEN cleared automatically because of bus collision. SSP module reset into Idle state. SEN BCL1IF SDA sampled low before Start condition. Set BCL1IF. S bit and SSP1IF set because SDA = 0, SCL = 1. SSP1IF and BCL1IF are cleared by software S SSP1IF SSP1IF and BCL1IF are cleared by software 2017 Microchip Technology Inc. Preliminary DS40001897A-page 400 PIC16(L)F15313/23 FIGURE 32-34: BUS COLLISION DURING START CONDITION (SCL = 0) SDA = 0, SCL = 1 TBRG TBRG SDA Set SEN, enable Start sequence if SDA = 1, SCL = 1 SCL SCL = 0 before SDA = 0, bus collision occurs. Set BCL1IF. SEN SCL = 0 before BRG time-out, bus collision occurs. Set BCL1IF. BCL1IF Interrupt cleared by software '0' '0' SSP1IF '0' '0' S FIGURE 32-35: BRG RESET DUE TO SDA ARBITRATION DURING START CONDITION SDA = 0, SCL = 1 Set S Less than TBRG SDA Set SSP1IF TBRG SDA pulled low by other master. Reset BRG and assert SDA. SCL S SCL pulled low after BRG time-out SEN BCL1IF Set SEN, enable Start sequence if SDA = 1, SCL = 1 '0' S SSP1IF SDA = 0, SCL = 1, set SSP1IF 2017 Microchip Technology Inc. Preliminary Interrupts cleared by software DS40001897A-page 401 PIC16(L)F15313/23 32.6.13.2 Bus Collision During a Repeated Start Condition counting. If SDA goes from high-to-low before the BRG times out, no bus collision occurs because no two masters can assert SDA at exactly the same time. During a Repeated Start condition, a bus collision occurs if: a) b) If SCL goes from high-to-low before the BRG times out and SDA has not already been asserted, a bus collision occurs. In this case, another master is attempting to transmit a data `1' during the Repeated Start condition, see Figure 32-37. A low level is sampled on SDA when SCL goes from low level to high level (Case 1). SCL goes low before SDA is asserted low, indicating that another master is attempting to transmit a data `1' (Case 2). If, at the end of the BRG time-out, both SCL and SDA are still high, the SDA pin is driven low and the BRG is reloaded and begins counting. At the end of the count, regardless of the status of the SCL pin, the SCL pin is driven low and the Repeated Start condition is complete. When the user releases SDA and the pin is allowed to float high, the BRG is loaded with SSP1ADD and counts down to zero. The SCL pin is then deasserted and when sampled high, the SDA pin is sampled. If SDA is low, a bus collision has occurred (i.e., another master is attempting to transmit a data `0', Figure 32-36). If SDA is sampled high, the BRG is reloaded and begins FIGURE 32-36: BUS COLLISION DURING A REPEATED START CONDITION (CASE 1) SDA SCL Sample SDA when SCL goes high. If SDA = 0, set BCL1IF and release SDA and SCL. RSEN BCL1IF Cleared by software S '0' SSP1IF '0' FIGURE 32-37: BUS COLLISION DURING REPEATED START CONDITION (CASE 2) TBRG TBRG SDA SCL BCL1IF SCL goes low before SDA, set BCL1IF. Release SDA and SCL. Interrupt cleared by software RSEN '0' S SSP1IF 2017 Microchip Technology Inc. Preliminary DS40001897A-page 402 PIC16(L)F15313/23 32.6.13.3 Bus Collision During a Stop Condition The Stop condition begins with SDA asserted low. When SDA is sampled low, the SCL pin is allowed to float. When the pin is sampled high (clock arbitration), the Baud Rate Generator is loaded with SSP1ADD and counts down to zero. After the BRG times out, SDA is sampled. If SDA is sampled low, a bus collision has occurred. This is due to another master attempting to drive a data `0' (Figure 32-38). If the SCL pin is sampled low before SDA is allowed to float high, a bus collision occurs. This is another case of another master attempting to drive a data `0' (Figure 32-39). Bus collision occurs during a Stop condition if: a) b) After the SDA pin has been deasserted and allowed to float high, SDA is sampled low after the BRG has timed out (Case 1). After the SCL pin is deasserted, SCL is sampled low before SDA goes high (Case 2). FIGURE 32-38: BUS COLLISION DURING A STOP CONDITION (CASE 1) TBRG TBRG TBRG SDA SDA sampled low after TBRG, set BCL1IF SDA asserted low SCL PEN BCL1IF P '0' SSP1IF '0' FIGURE 32-39: BUS COLLISION DURING A STOP CONDITION (CASE 2) TBRG TBRG TBRG SDA SCL goes low before SDA goes high, set BCL1IF Assert SDA SCL PEN BCL1IF P '0' SSP1IF '0' 2017 Microchip Technology Inc. Preliminary DS40001897A-page 403 PIC16(L)F15313/23 32.7 BAUD RATE GENERATOR The MSSP module has a Baud Rate Generator available for clock generation in both I2C and SPI Master modes. The Baud Rate Generator (BRG) reload value is placed in the SSP1ADD register (Register 32-6). When a write occurs to SSP1BUF, the Baud Rate Generator will automatically begin counting down. Once the given operation is complete, the internal clock will automatically stop counting and the clock pin will remain in its last state. module clock line. The logic dictating when the reload signal is asserted depends on the mode the MSSP is being operated in. Table 32-4 demonstrates clock rates based on instruction cycles and the BRG value loaded into SSP1ADD. EQUATION 32-1: FOSC FCLOCK = -------------------------------------------------- SSP 1ADD + 1 4 An internal signal "Reload" in Figure 32-40 triggers the value from SSP1ADD to be loaded into the BRG counter. This occurs twice for each oscillation of the FIGURE 32-40: BAUD RATE GENERATOR BLOCK DIAGRAM SSPM<3:0> SSPM<3:0> Reload SCL Control SSPCLK SSP1ADD<7:0> Reload BRG Down Counter FOSC/2 Note: Values of 0x00, 0x01 and 0x02 are not valid for SSP1ADD when used as a Baud Rate Generator for I2C. This is an implementation limitation. TABLE 32-2: Note: MSSP CLOCK RATE W/BRG FOSC FCY BRG Value FCLOCK (2 Rollovers of BRG) 32 MHz 8 MHz 13h 400 kHz 32 MHz 8 MHz 19h 308 kHz 32 MHz 8 MHz 4Fh 100 kHz 16 MHz 4 MHz 09h 400 kHz 16 MHz 4 MHz 0Ch 308 kHz 16 MHz 4 MHz 27h 100 kHz 4 MHz 1 MHz 09h 100 kHz Refer to the I/O port electrical specifications in Table 37-4 to ensure the system is designed to support IOL requirements. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 404 PIC16(L)F15313/23 32.8 Register Definitions: MSSP1 Control REGISTER 32-1: SSP1STAT: SSP1 STATUS REGISTER R/W-0/0 R/W-0/0 R/HS/HC-0 R/HS/HC-0 R/HS/HC-0 R/HS/HC-0 R/HS/HC-0 R/HS/HC-0 SMP CKE(1) D/A P(2) S(2) R/W UA BF bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS/HC = Hardware set/clear bit 7 SMP: SPI Data Input Sample bit SPI Master mode: 1 = Input data sampled at end of data output time 0 = Input data sampled at middle of data output time SPI Slave mode: SMP must be cleared when SPI is used in Slave mode In I2 C Master or Slave mode: 1 = Slew rate control disabled for Standard Speed mode (100 kHz and 1 MHz) 0 = Slew rate control enabled for High-Speed mode (400 kHz) bit 6 CKE: SPI Clock Edge Select bit (SPI mode only)(1) In SPI Master or Slave mode: 1 = Transmit occurs on transition from active to Idle clock state 0 = Transmit occurs on transition from Idle to active clock state In I2 C mode only: 1 = Enable input logic so that thresholds are compliant with SMBus specification 0 = Disable SMBus specific inputs bit 5 D/A: Data/Address bit (I2C mode only) 1 = Indicates that the last byte received or transmitted was data 0 = Indicates that the last byte received or transmitted was address bit 4 P: Stop bit(2) (I2C mode only. This bit is cleared when the MSSP module is disabled, SSPEN is cleared.) 1 = Indicates that a Stop bit has been detected last (this bit is `0' on Reset) 0 = Stop bit was not detected last bit 3 S: Start bit (2) (I2C mode only. This bit is cleared when the MSSP module is disabled, SSPEN is cleared.) 1 = Indicates that a Start bit has been detected last (this bit is `0' on Reset) 0 = Start bit was not detected last bit 2 R/W: Read/Write bit information (I2C mode only) This bit holds the R/W bit information following the last address match. This bit is only valid from the address match to the next Start bit, Stop bit, or not ACK bit. In I2 C Slave mode: 1 = Read 0 = Write In I2 C Master mode: 1 = Transmit is in progress 0 = Transmit is not in progress OR-ing this bit with SEN, RSEN, PEN, RCEN or ACKEN will indicate if the MSSP is in IDLE mode. bit 1 UA: Update Address bit (10-bit I2C mode only) 1 = Indicates that the user needs to update the address in the SSP1ADD register 0 = Address does not need to be updated bit 0 BF: Buffer Full Status bit Receive (SPI and I2 C modes): 1 = Receive complete, SSPBUF is full 0 = Receive not complete, SSPBUF is empty Transmit (I2 C mode only): 1 = Data transmit in progress (does not include the ACK and Stop bits), SSP1BUF is full 0 = Data transmit complete (does not include the ACK and Stop bits), SSP1BUF is empty Note 1: 2: Polarity of clock state is set by the CKP bit of the SSP1CON register. This bit is cleared on Reset and when SSPEN is cleared. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 405 PIC16(L)F15313/23 REGISTER 32-2: SSP1CON1: SSP1 CONTROL REGISTER 1 R/C/HS-0/0 R/C/HS-0/0 R/W-0/0 R/W-0/0 WCOL SSPOV(1) SSPEN CKP R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 SSPM<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HS = Bit is set by hardware C = User cleared bit 7 WCOL: Write Collision Detect bit (Transmit mode only) 1 = The SSP1BUF register is written while it is still transmitting the previous word (must be cleared in software) 0 = No collision bit 6 SSPOV: Receive Overflow Indicator bit(1) In SPI mode: 1 = A new byte is received while the SSP1BUF register is still holding the previous data. In case of overflow, the data in SSP1SR is lost. Overflow can only occur in Slave mode. In Slave mode, the user must read the SSP1BUF, even if only transmitting data, to avoid setting overflow. In Master mode, the overflow bit is not set since each new reception (and transmission) is initiated by writing to the SSP1BUF register (must be cleared in software). 0 = No overflow In I2C mode: 1 = A byte is received while the SSP1BUF register is still holding the previous byte. SSPOV is a "don't care" in Transmit mode (must be cleared in software). 0 = No overflow bit 5 SSPEN: Synchronous Serial Port Enable bit In both modes, when enabled, the following pins must be properly configured as input or output In SPI mode: 1 = Enables serial port and configures SCK, SDO, SDI and SS as the source of the serial port pins(2) 0 = Disables serial port and configures these pins as I/O port pins In I2C mode: 1 = Enables the serial port and configures the SDA and SCL pins as the source of the serial port pins(3) 0 = Disables serial port and configures these pins as I/O port pins bit 4 CKP: Clock Polarity Select bit In SPI mode: 1 = Idle state for clock is a high level 0 = Idle state for clock is a low level In I2C Slave mode: SCL release control 1 = Enable clock 0 = Holds clock low (clock stretch). (Used to ensure data setup time.) In I2C Master mode: Unused in this mode bit 3-0 SSPM<3:0>: Synchronous Serial Port Mode Select bits 1111 = I2C Slave mode, 10-bit address with Start and Stop bit interrupts enabled 1110 = I2C Slave mode, 7-bit address with Start and Stop bit interrupts enabled 1101 = Reserved 1100 = Reserved 1011 = I2C firmware controlled Master mode (slave idle) 1010 = SPI Master mode, clock = FOSC/(4 * (SSP1ADD+1))(5) 1001 = Reserved 1000 = I2C Master mode, clock = FOSC / (4 * (SSP1ADD+1))(4) 0111 = I2C Slave mode, 10-bit address 0110 = I2C Slave mode, 7-bit address 0101 = SPI Slave mode, clock = SCK pin, SS pin control disabled, SS can be used as I/O pin 0100 = SPI Slave mode, clock = SCK pin, SS pin control enabled 0011 = SPI Master mode, clock = T2_match/2 0010 = SPI Master mode, clock = FOSC/64 0001 = SPI Master mode, clock = FOSC/16 0000 = SPI Master mode, clock = FOSC/4 Note 1: 2: 3: 4: 5: In Master mode, the overflow bit is not set since each new reception (and transmission) is initiated by writing to the SSP1BUF register. When enabled, these pins must be properly configured as input or output. Use SSP1SSPPS, SSP1CLKPPS, SSP1DATPPS, and RxyPPS to select the pins. When enabled, the SDA and SCL pins must be configured as inputs. Use SSP1CLKPPS, SSP1DATPPS, and RxyPPS to select the pins. SSP1ADD values of 0, 1 or 2 are not supported for I2C mode. SSP1ADD value of `0' is not supported. Use SSPM = 0000 instead. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 406 PIC16(L)F15313/23 REGISTER 32-3: SSP1CON2: SSP1 CONTROL REGISTER 2 (I2C MODE ONLY)(1) R/W-0/0 R/HS/HC-0 R/W-0/0 R/S/HC-0/0 R/S/HC-0/0 R/S/HC-0/0 R/S/HC-0/0 R/S/HC-0/0 GCEN ACKSTAT ACKDT ACKEN RCEN PEN RSEN SEN bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared HC = Cleared by hardware S = User set bit 7 GCEN: General Call Enable bit (in I2C Slave mode only) 1 = Enable interrupt when a general call address (0x00 or 00h) is received in the SSP1SR 0 = General call address disabled bit 6 ACKSTAT: Acknowledge Status bit (in I2C mode only) 1 = Acknowledge was not received 0 = Acknowledge was received bit 5 ACKDT: Acknowledge Data bit (in I2C mode only) In Receive mode: Value transmitted when the user initiates an Acknowledge sequence at the end of a receive 1 = Not Acknowledge 0 = Acknowledge bit 4 ACKEN: Acknowledge Sequence Enable bit (in I2C Master mode only) In Master Receive mode: 1 = Initiate Acknowledge sequence on SDA and SCL pins, and transmit ACKDT data bit. Automatically cleared by hardware. 0 = Acknowledge sequence idle bit 3 RCEN: Receive Enable bit (in I2C Master mode only) 1 = Enables Receive mode for I2C 0 = Receive idle bit 2 PEN: Stop Condition Enable bit (in I2C Master mode only) SCKMSSP Release Control: 1 = Initiate Stop condition on SDA and SCL pins. Automatically cleared by hardware. 0 = Stop condition Idle bit 1 RSEN: Repeated Start Condition Enable bit (in I2C Master mode only) 1 = Initiate Repeated Start condition on SDA and SCL pins. Automatically cleared by hardware. 0 = Repeated Start condition Idle bit 0 SEN: Start Condition Enable/Stretch Enable bit In Master mode: 1 = Initiate Start condition on SDA and SCL pins. Automatically cleared by hardware. 0 = Start condition Idle In Slave mode: 1 = Clock stretching is enabled for both slave transmit and slave receive (stretch enabled) 0 = Clock stretching is disabled Note 1: For bits ACKEN, RCEN, PEN, RSEN, SEN: If the I2C module is not in the IDLE mode, this bit may not be set (no spooling) and the SSP1BUF may not be written (or writes to the SSP1BUF are disabled). 2017 Microchip Technology Inc. Preliminary DS40001897A-page 407 PIC16(L)F15313/23 REGISTER 32-4: SSP1CON3: SSP1 CONTROL REGISTER 3 R-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 ACKTIM(3) PCIE SCIE BOEN SDAHT SBCDE AHEN DHEN bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 ACKTIM: Acknowledge Time Status bit (I2C mode only)(3) 1 = Indicates the I2C bus is in an Acknowledge sequence, set on 8th falling edge of SCL clock 0 = Not an Acknowledge sequence, cleared on 9TH rising edge of SCL clock bit 6 PCIE: Stop Condition Interrupt Enable bit (I2C mode only) 1 = Enable interrupt on detection of Stop condition 0 = Stop detection interrupts are disabled(2) bit 5 SCIE: Start Condition Interrupt Enable bit (I2C mode only) 1 = Enable interrupt on detection of Start or Restart conditions 0 = Start detection interrupts are disabled(2) bit 4 BOEN: Buffer Overwrite Enable bit In SPI Slave mode:(1) 1 = SSPBUF updates every time that a new data byte is shifted in ignoring the BF bit 0 = If new byte is received with BF bit of the SSPSTAT register already set, SSPOV bit of the SSPCON1 register is set, and the buffer is not updated In I2 C Master mode and SPI Master mode: This bit is ignored. In I2 C Slave mode: 1 = SSPBUF is updated and ACK is generated for a received address/data byte, ignoring the state of the SSPOV bit only if the BF bit = 0. 0 = SSPBUF is only updated when SSPOV is clear bit 3 SDAHT: SDA Hold Time Selection bit (I2C mode only) 1 = Minimum of 300 ns hold time on SDA after the falling edge of SCL 0 = Minimum of 100 ns hold time on SDA after the falling edge of SCL bit 2 SBCDE: Slave Mode Bus Collision Detect Enable bit (I2C Slave mode only) If, on the rising edge of SCL, SDA is sampled low when the module is outputting a high state, the BCL1IF bit of the PIR3 register is set, and bus goes idle 1 = Enable slave bus collision interrupts 0 = Slave bus collision interrupts are disabled bit 1 AHEN: Address Hold Enable bit (I2C Slave mode only) 1 = Following the eighth falling edge of SCL for a matching received address byte; CKP bit of the SSPCON1 register will be cleared and the SCL will be held low. 0 = Address holding is disabled bit 0 DHEN: Data Hold Enable bit (I2C Slave mode only) 1 = Following the eighth falling edge of SCL for a received data byte; slave hardware clears the CKP bit of the SSPCON1 register and SCL is held low. 0 = Data holding is disabled Note 1: 2: 3: For daisy-chained SPI operation; allows the user to ignore all but the last received byte. SSPOV is still set when a new byte is received and BF = 1, but hardware continues to write the most recent byte to SSPBUF. This bit has no effect in Slave modes that Start and Stop condition detection is explicitly listed as enabled. The ACKTIM Status bit is only active when the AHEN bit or DHEN bit is set. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 408 PIC16(L)F15313/23 REGISTER 32-5: R/W-1/1 SSP1MSK: SSP1 MASK REGISTER R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 SSP1MSK<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-1 SSP1MSK<7:1>: Mask bits 1 = The received address bit n is compared to SSP1ADD to detect I2C address match 0 = The received address bit n is not used to detect I2C address match bit 0 SSP1MSK<0>: Mask bit for I2C Slave mode, 10-bit Address I2C Slave mode, 10-bit address (SSPM<3:0> = 0111 or 1111): 1 = The received address bit 0 is compared to SSP1ADD<0> to detect I2C address match 0 = The received address bit 0 is not used to detect I2C address match I2C Slave mode, 7-bit address: MSK0 bit is ignored. REGISTER 32-6: R/W-0/0 SSP1ADD: MSSP1 ADDRESS AND BAUD RATE REGISTER (I2C MODE) R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 SSP1ADD<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared Master mode: bit 7-0 SSP1ADD<7:0>: Baud Rate Clock Divider bits SCL pin clock period = ((ADD<7:0> + 1) *4)/FOSC 10-Bit Slave mode - Most Significant Address Byte: bit 7-3 Not used: Unused for Most Significant Address Byte. Bit state of this register is a "don't care". Bit pattern sent by master is fixed by I2C specification and must be equal to `11110'. However, those bits are compared by hardware and are not affected by the value in this register. bit 2-1 SSP1ADD<2:1>: Two Most Significant bits of 10-bit address bit 0 Not used: Unused in this mode. Bit state is a "don't care". 10-Bit Slave mode - Least Significant Address Byte: bit 7-0 SSP1ADD<7:0>: Eight Least Significant bits of 10-bit address 7-Bit Slave mode: bit 7-1 SSP1ADD<7:1>: 7-bit address bit 0 Not used: Unused in this mode. Bit state is a "don't care". 2017 Microchip Technology Inc. Preliminary DS40001897A-page 409 PIC16(L)F15313/23 REGISTER 32-7: R/W-x SSP1BUF: MSSP1 BUFFER REGISTER R/W-x R/W-x R/W-x R/W-x R/W-x R/W-x R/W-x SSP1BUF<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 SSP1BUF<7:0>: MSSP Buffer bits TABLE 32-3: Name INTCON SUMMARY OF REGISTERS ASSOCIATED WITH MSSP1 Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page GIE PEIE -- -- -- -- -- INTEDG 121 -- -- -- -- ADIF 131 -- -- -- ADIE 123 S R/W UA BF 405 PIR1 OSFIF CSWIF -- PIE1 OSFIE CSWIE -- SSP1STAT SMP CKE D/A P SSP1CON1 WCOL SSPOV SSPEN CKP SSP1CON2 GCEN ACKSTAT ACKDT ACKEN RCEN PEN RSEN SEN 407 SSP1CON3 ACKTIM PCIE SCIE BOEN SDAHT SBCDE AHEN DHEN 405 SSPM<3:0> 406 SSP1MSK SSPMSK<7:0> 409 SSP1ADD SSPADD<7:0> 409 SSP1BUF SSPBUF<7:0> 410 SSP1CLKPPS -- -- SSP1CLKPPS<5:0> 191 SSP1DATPPS -- -- SSP1DATPPS<5:0> 191 SSP1SSPPS -- -- SSP1SSPPS<5:0> RxyPPS -- -- Legend: Note 1: -- RxyPPS<4:0> 191 192 -- = Unimplemented location, read as `0'. Shaded cells are not used by the MSSP module When using designated I2C pins, the associated pin values in INLVLx will be ignored. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 410 PIC16(L)F15313/23 33.0 The EUSART module includes the following capabilities: ENHANCED UNIVERSAL SYNCHRONOUS ASYNCHRONOUS RECEIVER TRANSMITTER (EUSART) * * * * * * * * * * Full-duplex asynchronous transmit and receive Two-character input buffer One-character output buffer Programmable 8-bit or 9-bit character length Address detection in 9-bit mode Input buffer overrun error detection Received character framing error detection Half-duplex synchronous master Half-duplex synchronous slave Programmable clock polarity in synchronous modes * Sleep operation The Enhanced Universal Synchronous Asynchronous Receiver Transmitter (EUSART) module is a serial I/O communications peripheral. It contains all the clock generators, shift registers and data buffers necessary to perform an input or output serial data transfer independent of device program execution. The EUSART, also known as a Serial Communications Interface (SCI), can be configured as a full-duplex asynchronous system or half-duplex synchronous system. Full-Duplex mode is useful for communications with peripheral systems, such as CRT terminals and personal computers. Half-Duplex Synchronous mode is intended for communications with peripheral devices, such as A/D or D/A integrated circuits, serial EEPROMs or other microcontrollers. These devices typically do not have internal clocks for baud rate generation and require the external clock signal provided by a master synchronous device. The EUSART module implements the following additional features, making it ideally suited for use in Local Interconnect Network (LIN) bus systems: * Automatic detection and calibration of the baud rate * Wake-up on Break reception * 13-bit Break character transmit Block diagrams of the EUSART transmitter and receiver are shown in Figure 33-1 and Figure 33-2. The EUSART transmit output (TX_out) is available to the TX/CK pin and internally to the following peripherals: * Configurable Logic Cell (CLC) FIGURE 33-1: EUSART TRANSMIT BLOCK DIAGRAM Data Bus SYNC CSRC 8 TXEN LSb (8) 0 0 * * * TRMT Multiplier TX_out /n TX9 n BRG16 SPxBRGH SPxBRGL RX/DT pin PPS SYNC FOSC +1 Pin Buffer and Control Transmit Shift Register (TSR) CKPPS Note 1: RxyPPS(1) MSb 1 Baud Rate Generator Interrupt TXxIF TXxREG Register CK pin PPS TXxIE x4 x16 x64 TX9D SYNC 1 X 0 0 0 0 BRGH X 1 1 0 0 1 BRG16 X 1 0 1 0 PPS RxyPPS In Synchronous mode the DT output and RX input PPS selections should enable the same pin. 2017 Microchip Technology Inc. TX/CK pin Preliminary SYNC CSRC DS40001897A-page 411 PIC16(L)F15313/23 FIGURE 33-2: EUSART RECEIVE BLOCK DIAGRAM SPEN RX/DT pin CREN OERR RXPPS(1) RSR Register MSb Pin Buffer and Control PPS Baud Rate Generator Data Recovery FOSC +1 SPxBRGH SPxBRGL Multiplier x4 x16 x64 SYNC 1 X 0 0 0 BRGH X 1 1 0 0 BRG16 X 1 0 1 0 Stop (8) *** 7 1 LSb 0 Start RX9 /n BRG16 n FERR RX9D RCxREG Register 8 Note 1: RCIDL In Synchronous mode the DT output and RX input PPS selections should enable the same pin. FIFO Data Bus RXxIF RXxIE Interrupt The operation of the EUSART module is controlled through three registers: * Transmit Status and Control (TX1STA) * Receive Status and Control (RC1STA) * Baud Rate Control (BAUD1CON) These registers are detailed in Register 33-1, Register 33-2 and Register 33-3, respectively. The RX input pin is selected with the RXPPS. The CK input is selected with the TXPPS register. TX, CK, and DT output pins are selected with each pin's RxyPPS register. Since the RX input is coupled with the DT output in Synchronous mode, it is the user's responsibility to select the same pin for both of these functions when operating in Synchronous mode. The EUSART control logic will control the data direction drivers automatically. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 412 PIC16(L)F15313/23 33.1 33.1.1.2 EUSART Asynchronous Mode The EUSART transmits and receives data using the standard non-return-to-zero (NRZ) format. NRZ is implemented with two levels: a VOH Mark state which represents a `1' data bit, and a VOL Space state which represents a `0' data bit. NRZ refers to the fact that consecutively transmitted data bits of the same value stay at the output level of that bit without returning to a neutral level between each bit transmission. An NRZ transmission port idles in the Mark state. Each character transmission consists of one Start bit followed by eight or nine data bits and is always terminated by one or more Stop bits. The Start bit is always a space and the Stop bits are always marks. The most common data format is eight bits. Each transmitted bit persists for a period of 1/(Baud Rate). An on-chip dedicated 8-bit/16-bit Baud Rate Generator is used to derive standard baud rate frequencies from the system oscillator. See Table 33-3 for examples of baud rate configurations. Transmitting Data A transmission is initiated by writing a character to the TX1REG register. If this is the first character, or the previous character has been completely flushed from the TSR, the data in the TX1REG is immediately transferred to the TSR register. If the TSR still contains all or part of a previous character, the new character data is held in the TX1REG until the Stop bit of the previous character has been transmitted. The pending character in the TX1REG is then transferred to the TSR in one TCY immediately following the Stop bit transmission. The transmission of the Start bit, data bits and Stop bit sequence commences immediately following the transfer of the data to the TSR from the TX1REG. 33.1.1.3 Transmit Data Polarity The EUSART transmits and receives the LSb first. The EUSART's transmitter and receiver are functionally independent, but share the same data format and baud rate. Parity is not supported by the hardware, but can be implemented in software and stored as the ninth data bit. The polarity of the transmit data can be controlled with the SCKP bit of the BAUD1CON register. The default state of this bit is `0' which selects high true transmit idle and data bits. Setting the SCKP bit to `1' will invert the transmit data resulting in low true idle and data bits. The SCKP bit controls transmit data polarity in Asynchronous mode only. In Synchronous mode, the SCKP bit has a different function. See Section 33.4.1.2 "Clock Polarity". 33.1.1 33.1.1.4 EUSART ASYNCHRONOUS TRANSMITTER The EUSART transmitter block diagram is shown in Figure 33-1. The heart of the transmitter is the serial Transmit Shift Register (TSR), which is not directly accessible by software. The TSR obtains its data from the transmit buffer, which is the TX1REG register. 33.1.1.1 Enabling the Transmitter The EUSART transmitter is enabled for asynchronous operations by configuring the following three control bits: * TXEN = 1 * SYNC = 0 * SPEN = 1 All other EUSART control bits are assumed to be in their default state. Setting the TXEN bit of the TX1STA register enables the transmitter circuitry of the EUSART. Clearing the SYNC bit of the TX1STA register configures the EUSART for asynchronous operation. Setting the SPEN bit of the RC1STA register enables the EUSART and automatically configures the TX/CK I/O pin as an output. If the TX/CK pin is shared with an analog peripheral, the analog I/O function must be disabled by clearing the corresponding ANSEL bit. Note: Transmit Interrupt Flag The TX1IF interrupt flag bit of the PIR3 register is set whenever the EUSART transmitter is enabled and no character is being held for transmission in the TX1REG. In other words, the TX1IF bit is only clear when the TSR is busy with a character and a new character has been queued for transmission in the TX1REG. The TX1IF flag bit is not cleared immediately upon writing TX1REG. TX1IF becomes valid in the second instruction cycle following the write execution. Polling TX1IF immediately following the TX1REG write will return invalid results. The TX1IF bit is read-only, it cannot be set or cleared by software. The TX1IF interrupt can be enabled by setting the TX1IE interrupt enable bit of the PIE3 register. However, the TX1IF flag bit will be set whenever the TX1REG is empty, regardless of the state of TX1IE enable bit. To use interrupts when transmitting data, set the TX1IE bit only when there is more data to send. Clear the TX1IE interrupt enable bit upon writing the last character of the transmission to the TX1REG. The TX1IF Transmitter Interrupt flag is set when the TXEN enable bit is set. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 413 PIC16(L)F15313/23 33.1.1.5 TSR Status 33.1.1.7 The TRMT bit of the TX1STA register indicates the status of the TSR register. This is a read-only bit. The TRMT bit is set when the TSR register is empty and is cleared when a character is transferred to the TSR register from the TX1REG. The TRMT bit remains clear until all bits have been shifted out of the TSR register. No interrupt logic is tied to this bit, so the user has to poll this bit to determine the TSR status. Note: 33.1.1.6 1. 2. 3. The TSR register is not mapped in data memory, so it is not available to the user. Transmitting 9-Bit Characters The EUSART supports 9-bit character transmissions. When the TX9 bit of the TX1STA register is set, the EUSART will shift nine bits out for each character transmitted. The TX9D bit of the TX1STA register is the ninth, and Most Significant data bit. When transmitting 9-bit data, the TX9D data bit must be written before writing the eight Least Significant bits into the TX1REG. All nine bits of data will be transferred to the TSR shift register immediately after the TX1REG is written. A special 9-bit Address mode is available for use with multiple receivers. See Section 33.1.2.7 "Address Detection" for more information on the Address mode. FIGURE 33-3: Write to TXxREG BRG Output (Shift Clock) 6. 7. 8. Initialize the SP1BRGH, SP1BRGL register pair and the BRGH and BRG16 bits to achieve the desired baud rate (see Section 33.3 "EUSART Baud Rate Generator (BRG)"). Enable the asynchronous serial port by clearing the SYNC bit and setting the SPEN bit. If 9-bit transmission is desired, set the TX9 control bit. A set ninth data bit will indicate that the eight Least Significant data bits are an address when the receiver is set for address detection. Set SCKP bit if inverted transmit is desired. Enable the transmission by setting the TXEN control bit. This will cause the TX1IF interrupt bit to be set. If interrupts are desired, set the TX1IE interrupt enable bit of the PIE3 register. An interrupt will occur immediately provided that the GIE and PEIE bits of the INTCON register are also set. If 9-bit transmission is selected, the ninth bit should be loaded into the TX9D data bit. Load 8-bit data into the TX1REG register. This will start the transmission. ASYNCHRONOUS TRANSMISSION Word 1 TX/CK pin Start bit bit 0 bit 1 bit 7/8 Stop bit Word 1 TXxIF bit (Transmit Buffer Reg. Empty Flag) TRMT bit (Transmit Shift Reg. Empty Flag) 4. 5. Asynchronous Transmission Set-up: 1 TCY Word 1 Transmit Shift Reg. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 414 PIC16(L)F15313/23 FIGURE 33-4: ASYNCHRONOUS TRANSMISSION (BACK-TO-BACK) Write to TXxREG BRG Output (Shift Clock) Word 1 TX/CK pin TXxIF bit (Transmit Buffer Reg. Empty Flag) TRMT bit (Transmit Shift Reg. Empty Flag) Start bit bit 0 1 TCY bit 7/8 Stop bit Start bit bit 0 Word 2 1 TCY Word 1 Transmit Shift Reg. Word 2 Transmit Shift Reg. EUSART ASYNCHRONOUS RECEIVER 33.1.2.2 The Asynchronous mode is typically used in RS-232 systems. The receiver block diagram is shown in Figure 33-2. The data is received on the RX/DT pin and drives the data recovery block. The data recovery block is actually a high-speed shifter operating at 16 times the baud rate, whereas the serial Receive Shift Register (RSR) operates at the bit rate. When all eight or nine bits of the character have been shifted in, they are immediately transferred to a two character First-In-First-Out (FIFO) memory. The FIFO buffering allows reception of two complete characters and the start of a third character before software must start servicing the EUSART receiver. The FIFO and RSR registers are not directly accessible by software. Access to the received data is via the RC1REG register. 33.1.2.1 Enabling the Receiver The EUSART receiver is enabled for asynchronous operation by configuring the following three control bits: * CREN = 1 * SYNC = 0 * SPEN = 1 All other EUSART control bits are assumed to be in their default state. Setting the CREN bit of the RC1STA register enables the receiver circuitry of the EUSART. Clearing the SYNC bit of the TX1STA register configures the EUSART for asynchronous operation. Setting the SPEN bit of the RC1STA register enables the EUSART. The programmer must set the corresponding TRIS bit to configure the RX/DT I/O pin as an input. Note: bit 1 Word 1 This timing diagram shows two consecutive transmissions. Note: 33.1.2 Word 2 Receiving Data The receiver data recovery circuit initiates character reception on the falling edge of the first bit. The first bit, also known as the Start bit, is always a zero. The data recovery circuit counts one-half bit time to the center of the Start bit and verifies that the bit is still a zero. If it is not a zero then the data recovery circuit aborts character reception, without generating an error, and resumes looking for the falling edge of the Start bit. If the Start bit zero verification succeeds then the data recovery circuit counts a full bit time to the center of the next bit. The bit is then sampled by a majority detect circuit and the resulting `0' or `1' is shifted into the RSR. This repeats until all data bits have been sampled and shifted into the RSR. One final bit time is measured and the level sampled. This is the Stop bit, which is always a `1'. If the data recovery circuit samples a `0' in the Stop bit position then a framing error is set for this character, otherwise the framing error is cleared for this character. See Section 33.1.2.4 "Receive Framing Error" for more information on framing errors. Immediately after all data bits and the Stop bit have been received, the character in the RSR is transferred to the EUSART receive FIFO and the RX1IF interrupt flag bit of the PIR3 register is set. The top character in the FIFO is transferred out of the FIFO by reading the RC1REG register. Note: If the receive FIFO is overrun, no additional characters will be received until the overrun condition is cleared. See Section 33.1.2.5 "Receive Overrun Error" for more information on overrun errors. If the RX/DT function is on an analog pin, the corresponding ANSEL bit must be cleared for the receiver to function. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 415 PIC16(L)F15313/23 33.1.2.3 Receive Interrupts 33.1.2.6 The RX1IF interrupt flag bit of the PIR3 register is set whenever the EUSART receiver is enabled and there is an unread character in the receive FIFO. The RX1IF interrupt flag bit is read-only, it cannot be set or cleared by software. RX1IF interrupts are enabled by setting all of the following bits: * RX1IE, Interrupt Enable bit of the PIE3 register * PEIE, Peripheral Interrupt Enable bit of the INTCON register * GIE, Global Interrupt Enable bit of the INTCON register 33.1.2.4 The EUSART supports 9-bit character reception. When the RX9 bit of the RC1STA register is set the EUSART will shift nine bits into the RSR for each character received. The RX9D bit of the RC1STA register is the ninth and Most Significant data bit of the top unread character in the receive FIFO. When reading 9-bit data from the receive FIFO buffer, the RX9D data bit must be read before reading the eight Least Significant bits from the RC1REG. 33.1.2.7 The RX1IF interrupt flag bit will be set when there is an unread character in the FIFO, regardless of the state of interrupt enable bits. Receive Framing Error Each character in the receive FIFO buffer has a corresponding framing error Status bit. A framing error indicates that a Stop bit was not seen at the expected time. The framing error status is accessed via the FERR bit of the RC1STA register. The FERR bit represents the status of the top unread character in the receive FIFO. Therefore, the FERR bit must be read before reading the RC1REG. The FERR bit is read-only and only applies to the top unread character in the receive FIFO. A framing error (FERR = 1) does not preclude reception of additional characters. It is not necessary to clear the FERR bit. Reading the next character from the FIFO buffer will advance the FIFO to the next character and the next corresponding framing error. Receiving 9-Bit Characters Address Detection A special Address Detection mode is available for use when multiple receivers share the same transmission line, such as in RS-485 systems. Address detection is enabled by setting the ADDEN bit of the RC1STA register. Address detection requires 9-bit character reception. When address detection is enabled, only characters with the ninth data bit set will be transferred to the receive FIFO buffer, thereby setting the RX1IF interrupt bit. All other characters will be ignored. Upon receiving an address character, user software determines if the address matches its own. Upon address match, user software must disable address detection by clearing the ADDEN bit before the next Stop bit occurs. When user software detects the end of the message, determined by the message protocol used, software places the receiver back into the Address Detection mode by setting the ADDEN bit. The FERR bit can be forced clear by clearing the SPEN bit of the RC1STA register which resets the EUSART. Clearing the CREN bit of the RC1STA register does not affect the FERR bit. A framing error by itself does not generate an interrupt. Note: 33.1.2.5 If all receive characters in the receive FIFO have framing errors, repeated reads of the RC1REG will not clear the FERR bit. Receive Overrun Error The receive FIFO buffer can hold two characters. An overrun error will be generated if a third character, in its entirety, is received before the FIFO is accessed. When this happens the OERR bit of the RC1STA register is set. The characters already in the FIFO buffer can be read but no additional characters will be received until the error is cleared. The error must be cleared by either clearing the CREN bit of the RC1STA register or by resetting the EUSART by clearing the SPEN bit of the RC1STA register. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 416 PIC16(L)F15313/23 33.1.2.8 Asynchronous Reception Setup: 33.1.2.9 1. Initialize the SP1BRGH, SP1BRGL register pair and the BRGH and BRG16 bits to achieve the desired baud rate (see Section 33.3 "EUSART Baud Rate Generator (BRG)"). 2. Clear the ANSEL bit for the RX pin (if applicable). 3. Enable the serial port by setting the SPEN bit. The SYNC bit must be clear for asynchronous operation. 4. If interrupts are desired, set the RX1IE bit of the PIE3 register and the GIE and PEIE bits of the INTCON register. 5. If 9-bit reception is desired, set the RX9 bit. 6. Enable reception by setting the CREN bit. 7. The RX1IF interrupt flag bit will be set when a character is transferred from the RSR to the receive buffer. An interrupt will be generated if the RX1IE interrupt enable bit was also set. 8. Read the RC1STA register to get the error flags and, if 9-bit data reception is enabled, the ninth data bit. 9. Get the received eight Least Significant data bits from the receive buffer by reading the RC1REG register. 10. If an overrun occurred, clear the OERR flag by clearing the CREN receiver enable bit. FIGURE 33-5: This mode would typically be used in RS-485 systems. To set up an Asynchronous Reception with Address Detect Enable: 1. Initialize the SP1BRGH, SP1BRGL register pair and the BRGH and BRG16 bits to achieve the desired baud rate (see Section 33.3 "EUSART Baud Rate Generator (BRG)"). 2. Clear the ANSEL bit for the RX pin (if applicable). 3. Enable the serial port by setting the SPEN bit. The SYNC bit must be clear for asynchronous operation. 4. If interrupts are desired, set the RX1IE bit of the PIE3 register and the GIE and PEIE bits of the INTCON register. 5. Enable 9-bit reception by setting the RX9 bit. 6. Enable address detection by setting the ADDEN bit. 7. Enable reception by setting the CREN bit. 8. The RX1IF interrupt flag bit will be set when a character with the ninth bit set is transferred from the RSR to the receive buffer. An interrupt will be generated if the RX1IE interrupt enable bit was also set. 9. Read the RC1STA register to get the error flags. The ninth data bit will always be set. 10. Get the received eight Least Significant data bits from the receive buffer by reading the RC1REG register. Software determines if this is the device's address. 11. If an overrun occurred, clear the OERR flag by clearing the CREN receiver enable bit. 12. If the device has been addressed, clear the ADDEN bit to allow all received data into the receive buffer and generate interrupts. ASYNCHRONOUS RECEPTION Start bit bit 0 RX/DT pin 9-bit Address Detection Mode Setup Rcv Shift Reg Rcv Buffer Reg. RCIDL bit 1 bit 7/8 Stop bit Start bit bit 0 Word 1 RCxREG bit 7/8 Stop bit Start bit bit 7/8 Stop bit Word 2 RCxREG Read Rcv Buffer Reg. RCxREG RXxIF (Interrupt Flag) OERR bit CREN Note: This timing diagram shows three words appearing on the RX input. The RCxREG (receive buffer) is read after the third word, causing the OERR (overrun) bit to be set. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 417 PIC16(L)F15313/23 33.2 Clock Accuracy with Asynchronous Operation The factory calibrates the internal oscillator block output (INTOSC). However, the INTOSC frequency may drift as VDD or temperature changes, and this directly affects the asynchronous baud rate. Two methods may be used to adjust the baud rate clock, but both require a reference clock source of some kind. The first (preferred) method uses the OSCTUNE register to adjust the INTOSC output. Adjusting the value in the OSCTUNE register allows for fine resolution changes to the system clock source. See Section 9.2.2.2 "Internal Oscillator Frequency Adjustment" for more information. The other method adjusts the value in the Baud Rate Generator. This can be done automatically with the Auto-Baud Detect feature (see Section 33.3.1 "Auto-Baud Detect"). There may not be fine enough resolution when adjusting the Baud Rate Generator to compensate for a gradual change in the peripheral clock frequency. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 418 PIC16(L)F15313/23 33.3 EXAMPLE 33-1: EUSART Baud Rate Generator (BRG) The Baud Rate Generator (BRG) is an 8-bit or 16-bit timer that is dedicated to the support of both the asynchronous and synchronous EUSART operation. By default, the BRG operates in 8-bit mode. Setting the BRG16 bit of the BAUD1CON register selects 16-bit mode. For a device with FOSC of 16 MHz, desired baud rate of 9600, Asynchronous mode, 8-bit BRG: FOSC Desired Baud Rate = -----------------------------------------------------------------------64 [SPBRGH:SPBRGL] + 1 Solving for SPxBRGH:SPxBRGL: The SP1BRGH, SP1BRGL register pair determines the period of the free running baud rate timer. In Asynchronous mode the multiplier of the baud rate period is determined by both the BRGH bit of the TX1STA register and the BRG16 bit of the BAUD1CON register. In Synchronous mode, the BRGH bit is ignored. Table 33-1 contains the formulas for determining the baud rate. Example 33-1 provides a sample calculation for determining the baud rate and baud rate error. CALCULATING BAUD RATE ERROR F OS C --------------------------------------------Desired Baud Rate X = --------------------------------------------- - 1 64 16000000 -----------------------9600 = ------------------------ - 1 64 = 25.042 = 25 16000000 Calculated Baud Rate = --------------------------64 25 + 1 Typical baud rates and error values for various Asynchronous modes have been computed for your convenience and are shown in Table 33-3. It may be advantageous to use the high baud rate (BRGH = 1), or the 16-bit BRG (BRG16 = 1) to reduce the baud rate error. The 16-bit BRG mode is used to achieve slow baud rates for fast oscillator frequencies. = 9615 Calc. Baud Rate - Desired Baud Rate Error = -------------------------------------------------------------------------------------------Desired Baud Rate 9615 - 9600 = ---------------------------------- = 0.16% 9600 Writing a new value to the SP1BRGH, SP1BRGL register pair causes the BRG timer to be reset (or cleared). This ensures that the BRG does not wait for a timer overflow before outputting the new baud rate. If the system clock is changed during an active receive operation, a receive error or data loss may result. To avoid this problem, check the status of the RCIDL bit to make sure that the receive operation is idle before changing the system clock. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 419 PIC16(L)F15313/23 33.3.1 AUTO-BAUD DETECT The EUSART module supports automatic detection and calibration of the baud rate. In the Auto-Baud Detect (ABD) mode, the clock to the BRG is reversed. Rather than the BRG clocking the incoming RX signal, the RX signal is timing the BRG. The Baud Rate Generator is used to time the period of a received 55h (ASCII "U") which is the Sync character for the LIN bus. The unique feature of this character is that it has five rising edges including the Stop bit edge. Setting the ABDEN bit of the BAUD1CON register starts the auto-baud calibration sequence. While the ABD sequence takes place, the EUSART state machine is held in Idle. On the first rising edge of the receive line, after the Start bit, the SP1BRG begins counting up using the BRG counter clock as shown in Figure 33-6. The fifth rising edge will occur on the RX pin at the end of the eighth bit period. At that time, an accumulated value totaling the proper BRG period is left in the SP1BRGH, SP1BRGL register pair, the ABDEN bit is automatically cleared and the RX1IF interrupt flag is set. The value in the RC1REG needs to be read to clear the RX1IF interrupt. RC1REG content should be discarded. When calibrating for modes that do not use the SP1BRGH register the user can verify that the SP1BRGL register did not overflow by checking for 00h in the SP1BRGH register. The BRG auto-baud clock is determined by the BRG16 and BRGH bits as shown in Table 33-1. During ABD, both the SP1BRGH and SP1BRGL registers are used as a 16-bit counter, independent of the BRG16 bit setting. While calibrating the baud rate period, the SP1BRGH and SP1BRGL registers are clocked at FIGURE 33-6: Note 1: If the WUE bit is set with the ABDEN bit, auto-baud detection will occur on the byte following the Break character (see Section 33.3.3 "Auto-Wake-up on Break"). 2: It is up to the user to determine that the incoming character baud rate is within the range of the selected BRG clock source. Some combinations of oscillator frequency and EUSART baud rates are not possible. 3: During the auto-baud process, the auto-baud counter starts counting at one. Upon completion of the auto-baud sequence, to achieve maximum accuracy, subtract 1 from the SP1BRGH:SP1BRGL register pair. TABLE 33-1: BRG COUNTER CLOCK RATES BRG16 BRGH BRG Base Clock BRG ABD Clock 0 0 FOSC/64 FOSC/512 0 1 FOSC/16 FOSC/128 1 0 FOSC/16 FOSC/128 1 1 FOSC/4 FOSC/32 Note: During the ABD sequence, SP1BRGL and SP1BRGH registers are both used as a 16-bit counter, independent of the BRG16 setting. AUTOMATIC BAUD RATE CALIBRATION XXXXh BRG Value 1/8th the BRG base clock rate. The resulting byte measurement is the average bit time when clocked at full speed. RX pin 0000h 001Ch Start Edge #1 bit 1 bit 0 Edge #2 bit 3 bit 2 Edge #3 bit 5 bit 4 Edge #4 bit 7 bit 6 Edge #5 Stop bit BRG Clock Auto Cleared Set by User ABDEN bit RCIDL RXxIF bit (Interrupt) Read RCxREG SPxBRGL XXh 1Ch SPxBRGH XXh 00h Note 1: The ABD sequence requires the EUSART module to be configured in Asynchronous mode. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 420 PIC16(L)F15313/23 33.3.2 AUTO-BAUD OVERFLOW 33.3.3.1 During the course of automatic baud detection, the ABDOVF bit of the BAUD1CON register will be set if the baud rate counter overflows before the fifth rising edge is detected on the RX pin. The ABDOVF bit indicates that the counter has exceeded the maximum count that can fit in the 16 bits of the SP1BRGH:SP1BRGL register pair. The overflow condition will set the RX1IF flag. The counter continues to count until the fifth rising edge is detected on the RX pin. The RCIDL bit will remain false (`0') until the fifth rising edge at which time the RCIDL bit will be set. If the RC1REG is read after the overflow occurs but before the fifth rising edge then the fifth rising edge will set the RX1IF again. Terminating the auto-baud process early to clear an overflow condition will prevent proper detection of the sync character fifth rising edge. If any falling edges of the sync character have not yet occurred when the ABDEN bit is cleared then those will be falsely detected as Start bits. The following steps are recommended to clear the overflow condition: 1. 2. 3. Read RC1REG to clear RX1IF. If RCIDL is `0' then wait for RDCIF and repeat step 1. Clear the ABDOVF bit. 33.3.3 Special Considerations Break Character To avoid character errors or character fragments during a wake-up event, the wake-up character must be all zeros. When the wake-up is enabled the function works independent of the low time on the data stream. If the WUE bit is set and a valid non-zero character is received, the low time from the Start bit to the first rising edge will be interpreted as the wake-up event. The remaining bits in the character will be received as a fragmented character and subsequent characters can result in framing or overrun errors. Therefore, the initial character in the transmission must be all `0's. This must be ten or more bit times, 13-bit times recommended for LIN bus, or any number of bit times for standard RS-232 devices. Oscillator Start-up Time Oscillator start-up time must be considered, especially in applications using oscillators with longer start-up intervals (i.e., LP, XT or HS/PLL mode). The Sync Break (or wake-up signal) character must be of sufficient length, and be followed by a sufficient interval, to allow enough time for the selected oscillator to start and provide proper initialization of the EUSART. WUE Bit AUTO-WAKE-UP ON BREAK During Sleep mode, all clocks to the EUSART are suspended. Because of this, the Baud Rate Generator is inactive and a proper character reception cannot be performed. The Auto-Wake-up feature allows the controller to wake-up due to activity on the RX/DT line. This feature is available only in Asynchronous mode. The Auto-Wake-up feature is enabled by setting the WUE bit of the BAUD1CON register. Once set, the normal receive sequence on RX/DT is disabled, and the EUSART remains in an Idle state, monitoring for a wake-up event independent of the CPU mode. A wake-up event consists of a high-to-low transition on the RX/DT line. (This coincides with the start of a Sync Break or a wake-up signal character for the LIN protocol.) The wake-up event causes a receive interrupt by setting the RX1IF bit. The WUE bit is cleared in hardware by a rising edge on RX/DT. The interrupt condition is then cleared in software by reading the RC1REG register and discarding its contents. To ensure that no actual data is lost, check the RCIDL bit to verify that a receive operation is not in process before setting the WUE bit. If a receive operation is not occurring, the WUE bit may then be set just prior to entering the Sleep mode. The EUSART module generates an RX1IF interrupt coincident with the wake-up event. The interrupt is generated synchronously to the Q clocks in normal CPU operating modes (Figure 33-7), and asynchronously if the device is in Sleep mode (Figure 33-8). The interrupt condition is cleared by reading the RC1REG register. The WUE bit is automatically cleared by the low-to-high transition on the RX line at the end of the Break. This signals to the user that the Break event is over. At this point, the EUSART module is in IDLE mode waiting to receive the next character. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 421 PIC16(L)F15313/23 FIGURE 33-7: AUTO-WAKE-UP BIT (WUE) TIMING DURING NORMAL OPERATION Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 OSC1 Auto Cleared Bit set by user WUE bit RX/DT Line RXxIF Note 1: Cleared due to User Read of RCxREG The EUSART remains in Idle while the WUE bit is set. FIGURE 33-8: AUTO-WAKE-UP BIT (WUE) TIMINGS DURING SLEEP Q1Q2 Q3 Q4 Q1Q2 Q3 Q4 Q1Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1Q2 Q3 Q4 OSC1 Auto Cleared Bit Set by User WUE bit RX/DT Line Note 1 RXxIF Sleep Command Executed Note 1: 2: 33.3.4 Cleared due to User Read of RCxREG Sleep Ends If the wake-up event requires long oscillator warm-up time, the automatic clearing of the WUE bit can occur while the stposc signal is still active. This sequence should not depend on the presence of Q clocks. The EUSART remains in Idle while the WUE bit is set. BREAK CHARACTER SEQUENCE 33.3.4.1 Break and Sync Transmit Sequence The EUSART module has the capability of sending the special Break character sequences that are required by the LIN bus standard. A Break character consists of a Start bit, followed by 12 `0' bits and a Stop bit. The following sequence will start a message frame header made up of a Break, followed by an auto-baud Sync byte. This sequence is typical of a LIN bus master. To send a Break character, set the SENDB and TXEN bits of the TX1STA register. The Break character transmission is then initiated by a write to the TX1REG. The value of data written to TX1REG will be ignored and all `0's will be transmitted. 1. 2. The SENDB bit is automatically reset by hardware after the corresponding Stop bit is sent. This allows the user to preload the transmit FIFO with the next transmit byte following the Break character (typically, the Sync character in the LIN specification). 4. The TRMT bit of the TX1STA register indicates when the transmit operation is active or idle, just as it does during normal transmission. See Figure 33-9 for the timing of the Break character sequence. When the TX1REG becomes empty, as indicated by the TX1IF, the next data byte can be written to TX1REG. 2017 Microchip Technology Inc. 3. 5. Preliminary Configure the EUSART for the desired mode. Set the TXEN and SENDB bits to enable the Break sequence. Load the TX1REG with a dummy character to initiate transmission (the value is ignored). Write `55h' to TX1REG to load the Sync character into the transmit FIFO buffer. After the Break has been sent, the SENDB bit is reset by hardware and the Sync character is then transmitted. DS40001897A-page 422 PIC16(L)F15313/23 33.3.5 RECEIVING A BREAK CHARACTER The Enhanced EUSART module can receive a Break character in two ways. The first method to detect a Break character uses the FERR bit of the RC1STA register and the received data as indicated by RC1REG. The Baud Rate Generator is assumed to have been initialized to the expected baud rate. A Break character has been received when: * RX1IF bit is set * FERR bit is set * RC1REG = 00h The second method uses the Auto-Wake-up feature described in Section 33.3.3 "Auto-Wake-up on Break". By enabling this feature, the EUSART will sample the next two transitions on RX/DT, cause an RX1IF interrupt, and receive the next data byte followed by another interrupt. Note that following a Break character, the user will typically want to enable the Auto-Baud Detect feature. For both methods, the user can set the ABDEN bit of the BAUD1CON register before placing the EUSART in Sleep mode. FIGURE 33-9: Write to TXxREG SEND BREAK CHARACTER SEQUENCE Dummy Write BRG Output (Shift Clock) TX (pin) Start bit bit 0 bit 1 bit 11 Stop bit Break TXxIF bit (Transmit Interrupt Flag) TRMT bit (Transmit Shift Empty Flag) SENDB (send Break control bit) 2017 Microchip Technology Inc. SENDB Sampled Here Preliminary Auto Cleared DS40001897A-page 423 PIC16(L)F15313/23 33.4 33.4.1.2 EUSART Synchronous Mode Synchronous serial communications are typically used in systems with a single master and one or more slaves. The master device contains the necessary circuitry for baud rate generation and supplies the clock for all devices in the system. Slave devices can take advantage of the master clock by eliminating the internal clock generation circuitry. There are two signal lines in Synchronous mode: a bidirectional data line and a clock line. Slaves use the external clock supplied by the master to shift the serial data into and out of their respective receive and transmit shift registers. Since the data line is bidirectional, synchronous operation is half-duplex only. Half-duplex refers to the fact that master and slave devices can receive and transmit data but not both simultaneously. The EUSART can operate as either a master or slave device. Start and Stop bits are not used in synchronous transmissions. 33.4.1 SYNCHRONOUS MASTER MODE The following bits are used to configure the EUSART for synchronous master operation: * * * * * SYNC = 1 CSRC = 1 SREN = 0 (for transmit); SREN = 1 (for receive) CREN = 0 (for transmit); CREN = 1 (for receive) SPEN = 1 Master Clock Synchronous data transfers use a separate clock line, which is synchronous with the data. A device configured as a master transmits the clock on the TX/CK line. The TX/CK pin output driver is automatically enabled when the EUSART is configured for synchronous transmit or receive operation. Serial data bits change on the leading edge to ensure they are valid at the trailing edge of each clock. One clock cycle is generated for each data bit. Only as many clock cycles are generated as there are data bits. 2017 Microchip Technology Inc. A clock polarity option is provided for Microwire compatibility. Clock polarity is selected with the SCKP bit of the BAUD1CON register. Setting the SCKP bit sets the clock Idle state as high. When the SCKP bit is set, the data changes on the falling edge of each clock. Clearing the SCKP bit sets the Idle state as low. When the SCKP bit is cleared, the data changes on the rising edge of each clock. 33.4.1.3 Synchronous Master Transmission Data is transferred out of the device on the RX/DT pin. The RX/DT and TX/CK pin output drivers are automatically enabled when the EUSART is configured for synchronous master transmit operation. A transmission is initiated by writing a character to the TX1REG register. If the TSR still contains all or part of a previous character the new character data is held in the TX1REG until the last bit of the previous character has been transmitted. If this is the first character, or the previous character has been completely flushed from the TSR, the data in the TX1REG is immediately transferred to the TSR. The transmission of the character commences immediately following the transfer of the data to the TSR from the TX1REG. Each data bit changes on the leading edge of the master clock and remains valid until the subsequent leading clock edge. Setting the SYNC bit of the TX1STA register configures the device for synchronous operation. Setting the CSRC bit of the TX1STA register configures the device as a master. Clearing the SREN and CREN bits of the RC1STA register ensures that the device is in the Transmit mode, otherwise the device will be configured to receive. Setting the SPEN bit of the RC1STA register enables the EUSART. 33.4.1.1 Clock Polarity Note: The TSR register is not mapped in data memory, so it is not available to the user. 33.4.1.4 Synchronous Master Transmission Set-up: 1. 2. 3. 4. 5. 6. 7. 8. Preliminary Initialize the SP1BRGH, SP1BRGL register pair and the BRGH and BRG16 bits to achieve the desired baud rate (see Section 33.3 "EUSART Baud Rate Generator (BRG)"). Enable the synchronous master serial port by setting bits SYNC, SPEN and CSRC. Disable Receive mode by clearing bits SREN and CREN. Enable Transmit mode by setting the TXEN bit. If 9-bit transmission is desired, set the TX9 bit. If interrupts are desired, set the TX1IE bit of the PIE3 register and the GIE and PEIE bits of the INTCON register. If 9-bit transmission is selected, the ninth bit should be loaded in the TX9D bit. Start transmission by loading data to the TX1REG register. DS40001897A-page 424 PIC16(L)F15313/23 FIGURE 33-10: SYNCHRONOUS TRANSMISSION RX/DT pin bit 0 bit 1 Word 1 bit 2 bit 7 bit 0 bit 1 Word 2 bit 7 TX/CK pin (SCKP = 0) TX/CK pin (SCKP = 1) Write to TXxREG Reg Write Word 1 Write Word 2 TXxIF bit (Interrupt Flag) TRMT bit TXEN bit Note: `1' `1' Sync Master mode, SPxBRGL = 0, continuous transmission of two 8-bit words. FIGURE 33-11: SYNCHRONOUS TRANSMISSION (THROUGH TXEN) RX/DT pin bit 0 bit 1 bit 2 bit 6 bit 7 TX/CK pin Write to TXxREG reg TXxIF bit TRMT bit TXEN bit 33.4.1.5 Synchronous Master Reception Data is received at the RX/DT pin. The RX/DT pin output driver is automatically disabled when the EUSART is configured for synchronous master receive operation. In Synchronous mode, reception is enabled by setting either the Single Receive Enable bit (SREN of the RC1STA register) or the Continuous Receive Enable bit (CREN of the RC1STA register). When SREN is set and CREN is clear, only as many clock cycles are generated as there are data bits in a single character. The SREN bit is automatically cleared at the completion of one character. When CREN is set, clocks are continuously generated until CREN is cleared. If CREN is cleared in the middle of a character the CK clock stops immediately and the partial character is discarded. If SREN and CREN are both set, then SREN is cleared at the completion of the first character and CREN takes precedence. 2017 Microchip Technology Inc. To initiate reception, set either SREN or CREN. Data is sampled at the RX/DT pin on the trailing edge of the TX/CK clock pin and is shifted into the Receive Shift Register (RSR). When a complete character is received into the RSR, the RX1IF bit is set and the character is automatically transferred to the two character receive FIFO. The Least Significant eight bits of the top character in the receive FIFO are available in RC1REG. The RX1IF bit remains set as long as there are unread characters in the receive FIFO. Note: Preliminary If the RX/DT function is on an analog pin, the corresponding ANSEL bit must be cleared for the receiver to function. DS40001897A-page 425 PIC16(L)F15313/23 33.4.1.6 Slave Clock received. The RX9D bit of the RC1STA register is the ninth, and Most Significant, data bit of the top unread character in the receive FIFO. When reading 9-bit data from the receive FIFO buffer, the RX9D data bit must be read before reading the eight Least Significant bits from the RC1REG. Synchronous data transfers use a separate clock line, which is synchronous with the data. A device configured as a slave receives the clock on the TX/CK line. The TX/CK pin output driver is automatically disabled when the device is configured for synchronous slave transmit or receive operation. Serial data bits change on the leading edge to ensure they are valid at the trailing edge of each clock. One data bit is transferred for each clock cycle. Only as many clock cycles should be received as there are data bits. Note: 33.4.1.7 33.4.1.9 1. Initialize the SP1BRGH, SP1BRGL register pair for the appropriate baud rate. Set or clear the BRGH and BRG16 bits, as required, to achieve the desired baud rate. 2. Clear the ANSEL bit for the RX pin (if applicable). 3. Enable the synchronous master serial port by setting bits SYNC, SPEN and CSRC. 4. Ensure bits CREN and SREN are clear. 5. If interrupts are desired, set the RX1IE bit of the PIE3 register and the GIE and PEIE bits of the INTCON register. 6. If 9-bit reception is desired, set bit RX9. 7. Start reception by setting the SREN bit or for continuous reception, set the CREN bit. 8. Interrupt flag bit RX1IF will be set when reception of a character is complete. An interrupt will be generated if the enable bit RX1IE was set. 9. Read the RC1STA register to get the ninth bit (if enabled) and determine if any error occurred during reception. 10. Read the 8-bit received data by reading the RC1REG register. 11. If an overrun error occurs, clear the error by either clearing the CREN bit of the RC1STA register or by clearing the SPEN bit which resets the EUSART. If the device is configured as a slave and the TX/CK function is on an analog pin, the corresponding ANSEL bit must be cleared. Receive Overrun Error The receive FIFO buffer can hold two characters. An overrun error will be generated if a third character, in its entirety, is received before RC1REG is read to access the FIFO. When this happens the OERR bit of the RC1STA register is set. Previous data in the FIFO will not be overwritten. The two characters in the FIFO buffer can be read, however, no additional characters will be received until the error is cleared. The OERR bit can only be cleared by clearing the overrun condition. If the overrun error occurred when the SREN bit is set and CREN is clear then the error is cleared by reading RC1REG. If the overrun occurred when the CREN bit is set then the error condition is cleared by either clearing the CREN bit of the RC1STA register or by clearing the SPEN bit which resets the EUSART. 33.4.1.8 Receiving 9-bit Characters The EUSART supports 9-bit character reception. When the RX9 bit of the RC1STA register is set the EUSART will shift nine bits into the RSR for each character FIGURE 33-12: RX/DT pin Synchronous Master Reception Set-up: SYNCHRONOUS RECEPTION (MASTER MODE, SREN) bit 0 bit 1 bit 2 bit 3 bit 4 bit 5 bit 6 bit 7 TX/CK pin (SCKP = 0) TX/CK pin (SCKP = 1) Write to bit SREN SREN bit CREN bit `0' `0' RXxIF bit (Interrupt) Read RCxREG Note: Timing diagram demonstrates Sync Master mode with bit SREN = 1 and bit BRGH = 0. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 426 PIC16(L)F15313/23 33.4.2 SYNCHRONOUS SLAVE MODE 33.4.2.1 The following bits are used to configure the EUSART for synchronous slave operation: * * * * * SYNC = 1 CSRC = 0 SREN = 0 (for transmit); SREN = 1 (for receive) CREN = 0 (for transmit); CREN = 1 (for receive) SPEN = 1 The operation of the Synchronous Master and Slave modes are identical (see Section 33.4.1.3 "Synchronous Master Transmission"), except in the case of the Sleep mode. If two words are written to the TX1REG and then the SLEEP instruction is executed, the following will occur: Setting the SYNC bit of the TX1STA register configures the device for synchronous operation. Clearing the CSRC bit of the TX1STA register configures the device as a slave. Clearing the SREN and CREN bits of the RC1STA register ensures that the device is in the Transmit mode, otherwise the device will be configured to receive. Setting the SPEN bit of the RC1STA register enables the EUSART. 1. 2. 3. 4. 5. The first character will immediately transfer to the TSR register and transmit. The second word will remain in the TX1REG register. The TX1IF bit will not be set. After the first character has been shifted out of TSR, the TX1REG register will transfer the second character to the TSR and the TX1IF bit will now be set. If the PEIE and TX1IE bits are set, the interrupt will wake the device from Sleep and execute the next instruction. If the GIE bit is also set, the program will call the Interrupt Service Routine. 33.4.2.2 1. 2. 3. 4. 5. 6. 7. 8. 2017 Microchip Technology Inc. EUSART Synchronous Slave Transmit Preliminary Synchronous Slave Transmission Set-up: Set the SYNC and SPEN bits and clear the CSRC bit. Clear the ANSEL bit for the CK pin (if applicable). Clear the CREN and SREN bits. If interrupts are desired, set the TX1IE bit of the PIE3 register and the GIE and PEIE bits of the INTCON register. If 9-bit transmission is desired, set the TX9 bit. Enable transmission by setting the TXEN bit. If 9-bit transmission is selected, insert the Most Significant bit into the TX9D bit. Start transmission by writing the Least Significant eight bits to the TX1REG register. DS40001897A-page 427 PIC16(L)F15313/23 33.4.2.3 EUSART Synchronous Slave Reception 33.4.2.4 The operation of the Synchronous Master and Slave modes is identical (Section 33.4.1.5 "Synchronous Master Reception"), with the following exceptions: * Sleep * CREN bit is always set, therefore the receiver is never idle * SREN bit, which is a "don't care" in Slave mode 1. 2. 3. A character may be received while in Sleep mode by setting the CREN bit prior to entering Sleep. Once the word is received, the RSR register will transfer the data to the RC1REG register. If the RX1IE enable bit is set, the interrupt generated will wake the device from Sleep and execute the next instruction. If the GIE bit is also set, the program will branch to the interrupt vector. 4. 5. 6. 7. 8. 9. 2017 Microchip Technology Inc. Preliminary Synchronous Slave Reception Set-up: Set the SYNC and SPEN bits and clear the CSRC bit. Clear the ANSEL bit for both the CK and DT pins (if applicable). If interrupts are desired, set the RX1IE bit of the PIE3 register and the GIE and PEIE bits of the INTCON register. If 9-bit reception is desired, set the RX9 bit. Set the CREN bit to enable reception. The RX1IF bit will be set when reception is complete. An interrupt will be generated if the RX1IE bit was set. If 9-bit mode is enabled, retrieve the Most Significant bit from the RX9D bit of the RC1STA register. Retrieve the eight Least Significant bits from the receive FIFO by reading the RC1REG register. If an overrun error occurs, clear the error by either clearing the CREN bit of the RC1STA register or by clearing the SPEN bit which resets the EUSART. DS40001897A-page 428 PIC16(L)F15313/23 33.5 EUSART Operation During Sleep The EUSART will remain active during Sleep only in the Synchronous Slave mode. All other modes require the system clock and therefore cannot generate the necessary signals to run the Transmit or Receive Shift registers during Sleep. Synchronous Slave mode uses an externally generated clock to run the Transmit and Receive Shift registers. 33.5.1 SYNCHRONOUS RECEIVE DURING SLEEP To receive during Sleep, all the following conditions must be met before entering Sleep mode: * RC1STA and TX1STA Control registers must be configured for Synchronous Slave Reception (see Section 33.4.2.4 "Synchronous Slave Reception Set-up:"). * If interrupts are desired, set the RX1IE bit of the PIE3 register and the GIE and PEIE bits of the INTCON register. * The RX1IF interrupt flag must be cleared by reading RC1REG to unload any pending characters in the receive buffer. Upon entering Sleep mode, the device will be ready to accept data and clocks on the RX/DT and TX/CK pins, respectively. When the data word has been completely clocked in by the external device, the RX1IF interrupt flag bit of the PIR3 register will be set. Thereby, waking the processor from Sleep. 33.5.2 SYNCHRONOUS TRANSMIT DURING SLEEP To transmit during Sleep, all the following conditions must be met before entering Sleep mode: * The RC1STA and TX1STA Control registers must be configured for synchronous slave transmission (see Section 33.4.2.2 "Synchronous Slave Transmission Set-up:"). * The TX1IF interrupt flag must be cleared by writing the output data to the TX1REG, thereby filling the TSR and transmit buffer. * If interrupts are desired, set the TX1IE bit of the PIE3 register and the PEIE bit of the INTCON register. * Interrupt enable bits TX1IE of the PIE3 register and PEIE of the INTCON register must set. Upon entering Sleep mode, the device will be ready to accept clocks on TX/CK pin and transmit data on the RX/DT pin. When the data word in the TSR has been completely clocked out by the external device, the pending byte in the TX1REG will transfer to the TSR and the TX1IF flag will be set. Thereby, waking the processor from Sleep. At this point, the TX1REG is available to accept another character for transmission, which will clear the TX1IF flag. Upon waking from Sleep, the instruction following the SLEEP instruction will be executed. If the Global Interrupt Enable (GIE) bit is also set then the Interrupt Service Routine at address 0004h will be called. Upon waking from Sleep, the instruction following the SLEEP instruction will be executed. If the Global Interrupt Enable (GIE) bit of the INTCON register is also set, then the Interrupt Service Routine at address 004h will be called. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 429 PIC16(L)F15313/23 33.6 Register Definitions: EUSART Control REGISTER 33-1: R/W-/0 TX1STA: TRANSMIT STATUS AND CONTROL REGISTER R/W-0/0 CSRC TX9 R/W-0/0 TXEN (1) R/W-0/0 R/W-0/0 R/W-0/0 R-1/1 R/W-0/0 SYNC SENDB BRGH TRMT TX9D bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 CSRC: Clock Source Select bit Asynchronous mode: Unused in this mode - value ignored Synchronous mode: 1 = Master mode (clock generated internally from BRG) 0 = Slave mode (clock from external source) bit 6 TX9: 9-bit Transmit Enable bit 1 = Selects 9-bit transmission 0 = Selects 8-bit transmission bit 5 TXEN: Transmit Enable bit(1) 1 = Transmit enabled 0 = Transmit disabled bit 4 SYNC: EUSART Mode Select bit 1 = Synchronous mode 0 = Asynchronous mode bit 3 SENDB: Send Break Character bit Asynchronous mode: 1 = Send SYNCH BREAK on next transmission - Start bit, followed by 12 `0' bits, followed by Stop bit; cleared by hardware upon completion 0 = SYNCH BREAK transmission disabled or completed Synchronous mode: Unused in this mode - value ignored bit 2 BRGH: High Baud Rate Select bit Asynchronous mode: 1 = High speed 0 = Low speed Synchronous mode: Unused in this mode - value ignored bit 1 TRMT: Transmit Shift Register Status bit 1 = TSR empty 0 = TSR full bit 0 TX9D: Ninth bit of Transmit Data Can be address/data bit or a parity bit. Note 1: SREN/CREN overrides TXEN in Sync mode. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 430 PIC16(L)F15313/23 REGISTER 33-2: R/W-0/0 (1) SPEN RC1STA: RECEIVE STATUS AND CONTROL REGISTER R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R-0/0 R-0/0 R-0/0 RX9 SREN CREN ADDEN FERR OERR RX9D bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 SPEN: Serial Port Enable bit(1) 1 = Serial port enabled 0 = Serial port disabled (held in Reset) bit 6 RX9: 9-Bit Receive Enable bit 1 = Selects 9-bit reception 0 = Selects 8-bit reception bit 5 SREN: Single Receive Enable bit Asynchronous mode: Unused in this mode - value ignored Synchronous mode - Master: 1 = Enables single receive 0 = Disables single receive This bit is cleared after reception is complete. Synchronous mode - Slave Unused in this mode - value ignored bit 4 CREN: Continuous Receive Enable bit Asynchronous mode: 1 = Enables continuous receive until enable bit CREN is cleared 0 = Disables continuous receive Synchronous mode: 1 = Enables continuous receive until enable bit CREN is cleared (CREN overrides SREN) 0 = Disables continuous receive bit 3 ADDEN: Address Detect Enable bit Asynchronous mode 9-bit (RX9 = 1): 1 = Enables address detection - enable interrupt and load of the receive buffer when the ninth bit in the receive buffer is set 0 = Disables address detection, all bytes are received and ninth bit can be used as parity bit Asynchronous mode 8-bit (RX9 = 0): Unused in this mode - value ignored bit 2 FERR: Framing Error bit 1 = Framing error (can be updated by reading RCxREG register and receive next valid byte) 0 = No framing error bit 1 OERR: Overrun Error bit 1 = Overrun error (can be cleared by clearing bit CREN) 0 = No overrun error bit 0 RX9D: Ninth bit of Received Data This can be address/data bit or a parity bit and must be calculated by user firmware. Note 1: The EUSART module automatically changes the pin from tri-state to drive as needed. Configure the associated TRIS bits for TX/CK and RX/DT to 1. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 431 PIC16(L)F15313/23 REGISTER 33-3: BAUD1CON: BAUD RATE CONTROL REGISTER R/W-0/0 R-1/1 U-0 R/W-0/0 R/W-0/0 U-0 R/W-0/0 R/W-0/0 ABDOVF RCIDL -- SCKP BRG16 -- WUE ABDEN bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 ABDOVF: Auto-Baud Detect Overflow bit Asynchronous mode: 1 = Auto-baud timer overflowed 0 = Auto-baud timer did not overflow Synchronous mode: Don't care bit 6 RCIDL: Receive Idle Flag bit Asynchronous mode: 1 = Receiver is Idle 0 = Start bit has been received and the receiver is receiving Synchronous mode: Don't care bit 5 Unimplemented: Read as `0' bit 4 SCKP: Clock/Transmit Polarity Select bit Asynchronous mode: 1 = Idle state for transmit (TX) is a low level 0 = Idle state for transmit (TX) is a high level Synchronous mode: 1 = Idle state for clock (CK) is a high level 0 = Idle state for clock (CK) is a low level bit 3 BRG16: 16-bit Baud Rate Generator bit 1 = 16-bit Baud Rate Generator is used 0 = 8-bit Baud Rate Generator is used bit 2 Unimplemented: Read as `0' bit 1 WUE: Wake-up Enable bit Asynchronous mode: 1 = USART will continue to sample the Rx pin - interrupt generated on falling edge; bit cleared in hardware on following rising edge. 0 = RX pin not monitored nor rising edge detected Synchronous mode: Unused in this mode - value ignored bit 0 ABDEN: Auto-Baud Detect Enable bit Asynchronous mode: 1 = Enable baud rate measurement on the next character - requires reception of a SYNCH field (55h); cleared in hardware upon completion 0 = Baud rate measurement disabled or completed Synchronous mode: Unused in this mode - value ignored 2017 Microchip Technology Inc. Preliminary DS40001897A-page 432 PIC16(L)F15313/23 RC1REG(1): RECEIVE DATA REGISTER REGISTER 33-4: R-0 R-0 R-0 R-0 R-0 R-0 R-0 R-0 RC1REG<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 Note 1: RC1REG<7:0>: Lower eight bits of the received data; read-only; see also RX9D (Register 33-2) RC1REG (including the 9th bit) is double buffered, and data is available while new data is being received. TX1REG(1): TRANSMIT DATA REGISTER REGISTER 33-5: R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 TX1REG<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 Note 1: TX1REG<7:0>: Lower eight bits of the received data; read-only; see also RX9D (Register 33-1) TX1REG (including the 9th bit) is double buffered, and can be written when previous data has started shifting. SP1BRGL(1): BAUD RATE GENERATOR REGISTER REGISTER 33-6: R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 SP1BRG<7:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-0 Note 1: SP1BRG<7:0>: Lower eight bits of the Baud Rate Generator Writing to SP1BRG resets the BRG counter. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 433 PIC16(L)F15313/23 SP1BRGH(1, 2): BAUD RATE GENERATOR HIGH REGISTER REGISTER 33-7: R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 R/W-0 SP1BRG<15:8> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 Note 1: 2: SP1BRG<15:8>: Upper eight bits of the Baud Rate Generator SP1BRGH value is ignored for all modes unless BAUDxCON is active. Writing to SP1BRGH resets the BRG counter. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 434 PIC16(L)F15313/23 TABLE 33-2: Name INTCON SUMMARY OF REGISTERS ASSOCIATED WITH EUSART Bit 7 Bit 6 GIE PEIE Bit 5 Register on Page Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 INTEDG 121 TX1IE PIE3 -- -- RC1IE -- -- BCL1IE SSP1IE 125 PIR3 -- -- RC1IF TX1IF -- -- BCL1IF SSP1IF 133 SPEN RX9 SREN CREN ADDEN FERR OERR RX9D 431 CSRC TX9 TXEN SYNC SENDB BRGH TRMT TX9D 430 ABDOVF RCIDL SCKP BRG16 WUE ABDEN 432 RCxSTA TXxSTA BAUDxCON RCxREG EUSART Receive Data Register TXxREG EUSART Transmit Data Register 433* 433* SPxBRGL SPxBRG<7:0> SPxBRGH 433* SPxBRG<15:8> 434* RXPPS RXPPS<5:0> 191 CKPPS CXPPS<5:0> 191 RxyPPS CLCxSELy Legend: * RxyPPS<4:0> LCxDyS<5:0> 192 352 -- = unimplemented location, read as `0'. Shaded cells are not used for the EUSART module. Page with register information. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 435 PIC16(L)F15313/23 TABLE 33-3: BAUD RATE FORMULAS Configuration Bits BRG/EUSART Mode Baud Rate Formula 0 8-bit/Asynchronous FOSC/[64 (n+1)] 0 1 8-bit/Asynchronous 0 1 0 16-bit/Asynchronous 0 1 1 16-bit/Asynchronous 1 0 x 8-bit/Synchronous 1 x 16-bit/Synchronous SYNC BRG16 BRGH 0 0 0 1 Legend: FOSC/[16 (n+1)] FOSC/[4 (n+1)] x = Don't care, n = value of SPxBRGH, SPxBRGL register pair. TABLE 33-4: BAUD RATE FOR ASYNCHRONOUS MODES SYNC = 0, BRGH = 0, BRG16 = 0 BAUD RATE FOSC = 32.000 MHz FOSC = 20.000 MHz FOSC = 18.432 MHz FOSC = 11.0592 MHz Actual Rate % Error SPBRG value (decimal) 300 1200 -- -- -- -- -- -- -- 1221 2400 2404 0.16 207 2404 0.16 129 2400 0.00 119 2400 0.00 9600 9615 0.16 51 9470 -1.36 32 9600 0.00 29 9600 0.00 17 10417 10417 0.00 47 10417 0.00 29 10286 -1.26 27 10165 -2.42 16 19.2k 19.23k 0.16 25 19.53k 1.73 15 19.20k 0.00 14 19.20k 0.00 8 57.6k 55.55k -- -3.55 -- 3 -- -- -- -- -- -- -- 57.60k -- 0.00 7 -- 57.60k -- 0.00 2 -- -- 115.2k Actual Rate % Error SPBRG value (decimal) Actual Rate -- 1.73 -- 255 % Error SPBRG value (decimal) Actual Rate % Error SPBRG value (decimal) -- 1200 -- 0.00 -- 239 -- 1200 -- 0.00 -- 143 71 -- SYNC = 0, BRGH = 0, BRG16 = 0 BAUD RATE FOSC = 8.000 MHz FOSC = 4.000 MHz FOSC = 3.6864 MHz FOSC = 1.000 MHz Actual Rate % Error SPBRG value (decimal) 300 1200 -- 1202 -- 0.16 -- 103 300 1202 0.16 0.16 207 51 300 1200 0.00 191 47 300 1202 0.16 0.16 51 12 2400 2404 0.16 51 2404 0.16 25 2400 0.00 23 -- -- -- 9600 9615 0.16 12 -- -- -- 9600 0.00 5 -- -- -- 10417 10417 0.00 11 10417 0.00 5 -- -- -- -- -- -- 19.2k -- -- -- -- -- -- 19.20k 0.00 2 -- -- -- 57.6k -- -- -- -- -- -- 57.60k 0.00 0 -- -- -- 115.2k -- -- -- -- -- -- -- -- -- -- -- -- 2017 Microchip Technology Inc. Actual Rate % Error SPBRG value (decimal) Actual Rate % Error 0.00 Preliminary SPBRG value (decimal) Actual Rate % Error SPBRG value (decimal) DS40001897A-page 436 PIC16(L)F15313/23 TABLE 33-4: BAUD RATE FOR ASYNCHRONOUS MODES (CONTINUED) SYNC = 0, BRGH = 1, BRG16 = 0 BAUD RATE FOSC = 32.000 MHz Actual Rate % Error SPBRG value (decimal) FOSC = 20.000 MHz Actual Rate % Error SPBRG value (decimal) FOSC = 18.432 MHz Actual Rate % Error SPBRG value (decimal) FOSC = 11.0592 MHz Actual Rate % Error SPBRG value (decimal) 300 -- -- -- -- -- -- -- -- -- -- -- -- 1200 -- -- -- -- -- -- -- -- -- -- -- -- 2400 -- -- -- -- -- -- -- -- -- -- -- -- 9600 9615 0.16 207 9615 0.16 129 9600 0.00 119 9600 0.00 71 10417 10417 0.00 191 10417 0.00 119 10378 -0.37 110 10473 0.53 65 19.2k 19.23k 0.16 103 19.23k 0.16 64 19.20k 0.00 59 19.20k 0.00 35 57.6k 57.14k -0.79 34 56.82k -1.36 21 57.60k 0.00 19 57.60k 0.00 11 115.2k 117.64k 2.12 16 113.64k -1.36 10 115.2k 0.00 9 115.2k 0.00 5 SYNC = 0, BRGH = 1, BRG16 = 0 BAUD RATE FOSC = 8.000 MHz Actual Rate % Error SPBRG value (decimal) FOSC = 4.000 MHz Actual Rate % Error SPBRG value (decimal) FOSC = 3.6864 MHz Actual Rate % Error SPBRG value (decimal) FOSC = 1.000 MHz Actual Rate % Error SPBRG value (decimal) 207 300 -- -- -- -- -- -- -- -- -- 300 0.16 1200 -- -- -- 1202 0.16 207 1200 0.00 191 1202 0.16 51 2400 2404 0.16 207 2404 0.16 103 2400 0.00 95 2404 0.16 25 9600 9615 0.16 51 9615 0.16 25 9600 0.00 23 -- -- -- 10417 10417 0.00 47 10417 0.00 23 10473 0.53 21 10417 0.00 5 19.2k 19231 0.16 25 19.23k 0.16 12 19.2k 0.00 11 -- -- -- 57.6k 55556 -3.55 8 -- -- -- 57.60k 0.00 3 -- -- -- 115.2k -- -- -- -- -- -- 115.2k 0.00 1 -- -- -- SYNC = 0, BRGH = 0, BRG16 = 1 BAUD RATE FOSC = 32.000 MHz SPBRG Actual % value Rate Error (decimal) FOSC = 20.000 MHz Actual Rate % Error SPBRG value (decimal) FOSC = 18.432 MHz Actual Rate FOSC = 11.0592 MHz % Error SPBRG value (decimal) Actual Rate % Error SPBRG value (decimal) 300 1200 300.0 1200 0.00 -0.02 6666 3332 300.0 1200 -0.01 -0.03 4166 1041 300.0 1200 0.00 0.00 3839 959 300.0 1200 0.00 0.00 2303 575 2400 2401 -0.04 832 2399 -0.03 520 2400 0.00 479 2400 0.00 287 71 9600 9615 0.16 207 9615 0.16 129 9600 0.00 119 9600 0.00 10417 10417 0.00 191 10417 0.00 119 10378 -0.37 110 10473 0.53 65 19.2k 19.23k 0.16 103 19.23k 0.16 64 19.20k 0.00 59 19.20k 0.00 35 57.6k 57.14k -0.79 34 56.818 -1.36 21 57.60k 0.00 19 57.60k 0.00 11 115.2k 117.6k 2.12 16 113.636 -1.36 10 115.2k 0.00 9 115.2k 0.00 5 2017 Microchip Technology Inc. Preliminary DS40001897A-page 437 PIC16(L)F15313/23 TABLE 33-4: BAUD RATE FOR ASYNCHRONOUS MODES (CONTINUED) SYNC = 0, BRGH = 0, BRG16 = 1 BAUD RATE FOSC = 8.000 MHz Actual Rate % Error SPBRG value (decimal) FOSC = 4.000 MHz Actual Rate FOSC = 3.6864 MHz % Error SPBRG value (decimal) Actual Rate FOSC = 1.000 MHz % Error SPBRG value (decimal) Actual Rate % Error SPBRG value (decimal) 207 300 299.9 -0.02 1666 300.1 0.04 832 300.0 0.00 767 300.5 0.16 1200 1199 -0.08 416 1202 0.16 207 1200 0.00 191 1202 0.16 51 2400 2404 0.16 207 2404 0.16 103 2400 0.00 95 2404 0.16 25 9600 9615 0.16 51 9615 0.16 25 9600 0.00 23 -- -- -- 10417 10417 0.00 47 10417 0.00 23 10473 0.53 21 10417 0.00 5 19.2k 19.23k 0.16 25 19.23k 0.16 12 19.20k 0.00 11 -- -- -- 57.6k 55556 -3.55 8 -- -- -- 57.60k 0.00 3 -- -- -- 115.2k -- -- -- -- -- -- 115.2k 0.00 1 -- -- -- SYNC = 0, BRGH = 1, BRG16 = 1 or SYNC = 1, BRG16 = 1 BAUD RATE FOSC = 32.000 MHz SPBRG Actual % value Rate Error (decimal) FOSC = 20.000 MHz Actual Rate % Error SPBRG value (decimal) FOSC = 18.432 MHz Actual Rate FOSC = 11.0592 MHz % Error SPBRG value (decimal) Actual Rate % Error SPBRG value (decimal) 300 1200 300.0 1200 0.00 0.00 26666 6666 300.0 1200 0.00 -0.01 16665 4166 300.0 1200 0.00 0.00 15359 3839 300.0 1200 0.00 0.00 9215 2303 2400 2400 0.01 3332 2400 0.02 2082 2400 0.00 1919 2400 0.00 1151 9600 9604 0.04 832 9597 -0.03 520 9600 0.00 479 9600 0.00 287 10417 10417 0.00 767 10417 0.00 479 10425 0.08 441 10433 0.16 264 19.2k 19.18k -0.08 416 19.23k 0.16 259 19.20k 0.00 239 19.20k 0.00 143 57.6k 57.55k -0.08 138 57.47k -0.22 86 57.60k 0.00 79 57.60k 0.00 47 115.2k 115.9k 0.64 68 116.3k 0.94 42 115.2k 0.00 39 115.2k 0.00 23 SYNC = 0, BRGH = 1, BRG16 = 1 or SYNC = 1, BRG16 = 1 BAUD RATE FOSC = 8.000 MHz Actual Rate FOSC = 4.000 MHz % Error SPBRG value (decimal) Actual Rate FOSC = 3.6864 MHz % Error SPBRG value (decimal) Actual Rate FOSC = 1.000 MHz % Error SPBRG value (decimal) Actual Rate % Error SPBRG value (decimal) 300 300.0 0.00 6666 300.0 0.01 3332 300.0 0.00 3071 300.1 0.04 832 1200 1200 -0.02 1666 1200 0.04 832 1200 0.00 767 1202 0.16 207 2400 2401 0.04 832 2398 0.08 416 2400 0.00 383 2404 0.16 103 9600 9615 0.16 207 9615 0.16 103 9600 0.00 95 9615 0.16 25 10417 10417 0 191 10417 0.00 95 10473 0.53 87 10417 0.00 23 19.2k 19.23k 0.16 103 19.23k 0.16 51 19.20k 0.00 47 19.23k 0.16 12 57.6k 57.14k -0.79 34 58.82k 2.12 16 57.60k 0.00 15 -- -- -- 115.2k 117.6k 2.12 16 111.1k -3.55 8 115.2k 0.00 7 -- -- -- 2017 Microchip Technology Inc. Preliminary DS40001897A-page 438 PIC16(L)F15313/23 34.0 REFERENCE CLOCK OUTPUT MODULE The reference clock output module provides the ability to send a clock signal to the clock reference output pin (CLKR). The reference clock output module has the following features: * Selectable input clock * Programmable clock divider * Selectable duty cycle 34.1 CLOCK SOURCE CLOCK SYNCHRONIZATION Once the reference clock enable (CLKREN) is set, the module is ensured to be glitch-free at start-up. When the reference clock output is disabled, the output signal will be disabled immediately. SELECTABLE DUTY CYCLE The CLKRDC<1:0> bits of the CLKRCON register can be used to modify the duty cycle of the output clock. A duty cycle of 25%, 50%, or 75% can be selected for all clock rates, with the exception of the undivided base FOSC value. The duty cycle can be changed while the module is enabled; however, in order to prevent glitches on the output, the CLKRDC<1:0> bits should only be changed when the module is disabled (CLKREN = 0). Note: The reference clock output module has a selectable clock source. The CLKRCLK register (Register 34-2) controls which input is used. 34.1.1 34.3 34.4 The CLKRDC1 bit is reset to `1'. This makes the default duty cycle 50% and not 0%. OPERATION IN SLEEP MODE The reference clock output module clock is based on the system clock. When the device goes to Sleep, the module outputs will remain in their current state. This will have a direct effect on peripherals using the reference clock output as an input signal. Clock dividers and clock duty cycles can be changed while the module is enabled, but glitches may occur on the output. To avoid possible glitches, clock dividers and clock duty cycles should be changed only when the CLKREN is clear. 34.2 PROGRAMMABLE CLOCK DIVIDER The module takes the system clock input and divides it based on the value of the CLKRDIV<2:0> bits of the CLKRCON register (Register 34-1). The following configurations can be made based on the CLKRDIV<2:0> bits: * * * * * * * * Base clock value Base clock value divided by 2 Base clock value divided by 4 Base clock value divided by 8 Base clock value divided by 16 Base clock value divided by 32 Base clock value divided by 64 Base clock value divided by 128 The clock divider values can be changed while the module is enabled; however, in order to prevent glitches on the output, the CLKRDIV<2:0> bits should only be changed when the module is disabled (CLKREN = 0). 2017 Microchip Technology Inc. Preliminary DS40001897A-page 439 PIC16(L)F15313/23 FIGURE 34-1: CLOCK REFERENCE BLOCK DIAGRAM Rev. 10-000261A 9/10/2015 CLKRDIV<2:0> Counter Reset Reference Clock Divider CLKREN See CLKRCLK Register D CLKREN CLKRCLK<3:0> FREEZE ENABLED(1) ICD FREEZE MODE(1) FIGURE 34-2: Q 128 111 64 110 32 101 16 100 8 011 4 010 2 001 CLKRDC<1:0> CLKR Duty Cycle PPS To Peripherals 000 EN CLOCK REFERENCE TIMING P2 P1 FOSC CLKREN CLKR Output CLKRDIV[2:0] = 001 CLKRDC[1:0] = 10 CLKR Output Duty Cycle (50%) FOSC / 2 CLKRDIV[2:0] = 001 CLKRDC[1:0] = 01 Duty Cycle (25%) 2017 Microchip Technology Inc. Preliminary DS40001897A-page 440 PIC16(L)F15313/23 REGISTER 34-1: CLKRCON: REFERENCE CLOCK CONTROL REGISTER R/W-0/0 U-0 U-0 CLKREN -- -- R/W-0/0 R/W-0/0 CLKRDC<1:0> R/W-0/0 R/W-0/0 R/W-0/0 CLKRDIV<2:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7 CLKREN: Reference Clock Module Enable bit 1 = Reference clock module enabled 0 = Reference clock module is disabled bit 6-5 Unimplemented: Read as `0' bit 4-3 CLKRDC<1:0>: Reference Clock Duty Cycle bits (1) 11 = Clock outputs duty cycle of 75% 10 = Clock outputs duty cycle of 50% 01 = Clock outputs duty cycle of 25% 00 = Clock outputs duty cycle of 0% bit 2-0 CLKRDIV<2:0>: Reference Clock Divider bits 111 = Base clock value divided by 128 110 = Base clock value divided by 64 101 = Base clock value divided by 32 100 = Base clock value divided by 16 011 = Base clock value divided by 8 010 = Base clock value divided by 4 001 = Base clock value divided by 2 000 = Base clock value Note 1: Bits are valid for reference clock divider values of two or larger, the base clock cannot be further divided. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 441 PIC16(L)F15313/23 REGISTER 34-2: CLKRCLK: CLOCK REFERENCE CLOCK SELECTION REGISTER U-0 U-0 U-0 U-0 -- -- -- -- R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 CLKRCLK<3:0> bit 7 bit 0 Legend: R = Readable bit W = Writable bit U = Unimplemented bit, read as `0' u = Bit is unchanged x = Bit is unknown -n/n = Value at POR and BOR/Value at all other Resets `1' = Bit is set `0' = Bit is cleared bit 7-4 Unimplemented: Read as `0' bit 3-0 CLKRCLK<3:0>: CLKR Input bits Clock Selection 1111 = Reserved * * * 1011 = Reserved 1010 = LC4_out 1001 = LC3_out 1000 = LC2_out 0111 = LC1_out 0110 = NCO1_out 0101 = Reserved 0100 = MFINTOSC (31.25 kHz) 0011 = MFINTOSC (500 kHz) 0010 = LFINTOSC 0001 = HFINTOSC 0000 = FOSC TABLE 34-1: Name SUMMARY OF REGISTERS ASSOCIATED WITH CLOCK REFERENCE OUTPUT Bit 7 Bit 6 Bit 5 CLKRCON CLKREN -- -- CLKRCLK -- -- -- CLCxSELy -- -- RxyPPS -- -- Legend: Bit 4 Bit 3 Bit 2 CLKRDC<1:0> -- Bit 1 CLKRDIV<2:0> CLKRCLK<3:0> LCxDyS<5:0> -- Bit 0 RxyPPS<4:0> Register on Page 441 442 352 192 -- = unimplemented, read as `0'. Shaded cells are not used by the CLKR module. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 442 PIC16(L)F15313/23 35.0 IN-CIRCUIT SERIAL PROGRAMMINGTM (ICSPTM) 35.3 ICSPTM programming allows customers to manufacture circuit boards with unprogrammed devices. Programming can be done after the assembly process, allowing the device to be programmed with the most recent firmware or a custom firmware. Five pins are needed for ICSPTM programming: * ICSPCLK * ICSPDAT * MCLR/VPP * VDD * VSS Connection to a target device is typically done through an ICSPTM header. A commonly found connector on development tools is the RJ-11 in the 6P6C (6-pin, 6-connector) configuration. See Figure 35-1. FIGURE 35-1: VDD In Program/Verify mode the program memory, User IDs and the Configuration Words are programmed through serial communications. The ICSPDAT pin is a bidirectional I/O used for transferring the serial data and the ICSPCLK pin is the clock input. For more information on ICSPTM refer to the "PIC16(L)F153XX Memory Programming Specification" (DS40001838). 35.1 The Low-Voltage Programming Entry mode allows the PIC(R) Flash MCUs to be programmed using VDD only, without high voltage. When the LVP bit of Configuration Words is set to `1', the low-voltage ICSP programming entry is enabled. To disable the Low-Voltage ICSP mode, the LVP bit must be programmed to `0'. The LVP bit can only be reprogrammed to `0' by using the High-Voltage Programming mode. Entry into the Low-Voltage Programming Entry mode requires the following steps: 1. 2. ICSPDAT NC 2 4 6 ICSPCLK 1 3 5 Target VSS PC Board Bottom Side Pin Description* 1 = VPP/MCLR High-Voltage Programming Entry Mode Low-Voltage Programming Entry Mode ICD RJ-11 STYLE CONNECTOR INTERFACE VPP/MCLR 2 = VDD Target 3 = VSS (ground) 4 = ICSPDAT The device is placed into High-Voltage Programming Entry mode by holding the ICSPCLK and ICSPDAT pins low then raising the voltage on MCLR/VPP to VIHH. 35.2 Common Programming Interfaces 5 = ICSPCLK 6 = No Connect Another connector often found in use with the PICkitTM programmers is a standard 6-pin header with 0.1 inch spacing. Refer to Figure 35-2. For additional interface recommendations, refer to your specific device programmer manual prior to PCB design. It is recommended that isolation devices be used to separate the programming pins from other circuitry. The type of isolation is highly dependent on the specific application and may include devices such as resistors, diodes, or even jumpers. See Figure 35-3 for more information. MCLR is brought to VIL. A 32-bit key sequence is presented on ICSPDAT, while clocking ICSPCLK. Once the key sequence is complete, MCLR must be held at VIL for as long as Program/Verify mode is to be maintained. If low-voltage programming is enabled (LVP = 1), the MCLR Reset function is automatically enabled and cannot be disabled. See Section 8.5"MCLR" for more information. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 443 PIC16(L)F15313/23 FIGURE 35-2: PICkitTM PROGRAMMER STYLE CONNECTOR INTERFACE Rev. 10-000128A 7/30/2013 Pin 1 Indicator Pin Description* 1 = VPP/MCLR 1 2 3 4 5 6 2 = VDD Target 3 = VSS (ground) 4 = ICSPDAT 5 = ICSPCLK 6 = No connect FIGURE 35-3: TYPICAL CONNECTION FOR ICSPTM PROGRAMMING Rev. 10-000129A 7/30/2013 External Programming Signals Device to be Programmed VDD VDD VDD VPP MCLR/VPP VSS VSS Data ICSPDAT Clock ICSPCLK * * * To Normal Connections * Isolation devices (as required). 2017 Microchip Technology Inc. Preliminary DS40001897A-page 444 PIC16(L)F15313/23 36.0 INSTRUCTION SET SUMMARY 36.1 Read-Modify-Write Operations * Byte Oriented * Bit Oriented * Literal and Control Any instruction that specifies a file register as part of the instruction performs a Read-Modify-Write (R-M-W) operation. The register is read, the data is modified, and the result is stored according to either the instruction, or the destination designator `d'. A read operation is performed on a register even if the instruction writes to that register. The literal and control category contains the most varied instruction word format. TABLE 36-1: Each instruction is a 14-bit word containing the operation code (opcode) and all required operands. The opcodes are broken into three broad categories. Table 36-3 lists the instructions recognized by the MPASMTM assembler. All instructions are executed within a single instruction cycle, with the following exceptions, which may take two or three cycles: * Subroutine entry takes two cycles (CALL, CALLW) * Returns from interrupts or subroutines take two cycles (RETURN, RETLW, RETFIE) * Program branching takes two cycles (GOTO, BRA, BRW, BTFSS, BTFSC, DECFSZ, INCSFZ) * One additional instruction cycle will be used when any instruction references an indirect file register and the file select register is pointing to program memory. One instruction cycle consists of 4 oscillator cycles; for an oscillator frequency of 4 MHz, this gives a nominal instruction execution rate of 1 MHz. All instruction examples use the format `0xhh' to represent a hexadecimal number, where `h' signifies a hexadecimal digit. OPCODE FIELD DESCRIPTIONS Field f Description Register file address (0x00 to 0x7F) W Working register (accumulator) b Bit address within an 8-bit file register k Literal field, constant data or label x Don't care location (= 0 or 1). The assembler will generate code with x = 0. It is the recommended form of use for compatibility with all Microchip software tools. d Destination select; d = 0: store result in W, d = 1: store result in file register f. Default is d = 1. n FSR or INDF number. (0-1) mm Prepost increment-decrement mode selection TABLE 36-2: ABBREVIATION DESCRIPTIONS Field PC Program Counter TO Time-Out bit C DC Z PD 2017 Microchip Technology Inc. Description Preliminary Carry bit Digit Carry bit Zero bit Power-Down bit DS40001897A-page 445 PIC16(L)F15313/23 36.2 General Format for Instructions TABLE 36-3: INSTRUCTION SET 14-Bit Opcode Mnemonic, Operands Description Cycles MSb LSb Status Affected Notes BYTE-ORIENTED FILE REGISTER OPERATIONS ADDWF ADDWFC ANDWF ASRF LSLF LSRF CLRF CLRW COMF DECF INCF IORWF MOVF MOVWF RLF RRF SUBWF SUBWFB SWAPF XORWF f, d f, d f, d f, d f, d f, d f - f, d f, d f, d f, d f, d f f, d f, d f, d f, d f, d f, d Add W and f Add with Carry W and f AND W with f Arithmetic Right Shift Logical Left Shift Logical Right Shift Clear f Clear W Complement f Decrement f Increment f Inclusive OR W with f Move f Move W to f Rotate Left f through Carry Rotate Right f through Carry Subtract W from f Subtract with Borrow W from f Swap nibbles in f Exclusive OR W with f DECFSZ INCFSZ f, d f, d Decrement f, Skip if 0 Increment f, Skip if 0 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 00 11 00 11 11 11 00 00 00 00 00 00 00 00 00 00 00 11 00 00 0111 1101 0101 0111 0101 0110 0001 0001 1001 0011 1010 0100 1000 0000 1101 1100 0010 1011 1110 0110 dfff dfff dfff dfff dfff dfff lfff 0000 dfff dfff dfff dfff dfff 1fff dfff dfff dfff dfff dfff dfff ffff ffff ffff ffff ffff ffff ffff 00xx ffff ffff ffff ffff ffff ffff ffff ffff ffff ffff ffff ffff C, DC, Z C, DC, Z Z C, Z C, Z C, Z Z Z Z Z Z Z Z C C C, DC, Z C, DC, Z Z 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 2 BYTE ORIENTED SKIP OPERATIONS 1(2) 1(2) 00 00 1, 2 1, 2 1011 dfff ffff 1111 dfff ffff BIT-ORIENTED FILE REGISTER OPERATIONS BCF BSF f, b f, b Bit Clear f Bit Set f BTFSC BTFSS f, b f, b Bit Test f, Skip if Clear Bit Test f, Skip if Set 1 1 01 01 00bb bfff ffff 01bb bfff ffff 2 2 1, 2 1, 2 BIT-ORIENTED SKIP OPERATIONS 1 (2) 1 (2) 01 01 10bb bfff ffff 11bb bfff ffff 1 1 1 1 1 1 1 1 11 11 11 00 11 11 11 11 1110 1001 1000 000 0001 0000 1100 1010 LITERAL OPERATIONS ADDLW ANDLW IORLW MOVLB MOVLP MOVLW SUBLW XORLW k k k k k k k k Note 1: If the Program Counter (PC) is modified, or a conditional test is true, the instruction requires two cycles. The second cycle is executed as a NOP. If this instruction addresses an INDF register and the MSb of the corresponding FSR is set, this instruction will require one additional instruction cycle. 2: Add literal and W AND literal with W Inclusive OR literal with W Move literal to BSR Move literal to PCLATH Move literal to W Subtract W from literal Exclusive OR literal with W 2017 Microchip Technology Inc. Preliminary kkkk kkkk kkkk 0k 1kkk kkkk kkkk kkkk kkkk kkkk kkkk kkkk kkkk kkkk kkkk kkkk C, DC, Z Z Z C, DC, Z Z DS40001897A-page 446 PIC16(L)F15313/23 TABLE 36-3: INSTRUCTION SET (CONTINUED) 14-Bit Opcode Mnemonic, Operands Description Cycles MSb LSb Status Affected Notes CONTROL OPERATIONS BRA BRW CALL CALLW GOTO RETFIE RETLW RETURN k - k - k k k - Relative Branch Relative Branch with W Call Subroutine Call Subroutine with W Go to address Return from interrupt Return with literal in W Return from Subroutine CLRWDT NOP RESET SLEEP TRIS - - - - f Clear Watchdog Timer No Operation Software device Reset Go into Standby or IDLE mode Load TRIS register with W ADDFSR MOVIW n, k n mm MOVWI k[n] n mm Add Literal k to FSRn Move Indirect FSRn to W with pre/post inc/dec modifier, mm Move INDFn to W, Indexed Indirect. Move W to Indirect FSRn with pre/post inc/dec modifier, mm Move W to INDFn, Indexed Indirect. 2 2 2 2 2 2 2 2 11 00 10 00 10 00 11 00 001k 0000 0kkk 0000 1kkk 0000 0100 0000 kkkk 0000 kkkk 0000 kkkk 0000 kkkk 0000 kkkk 1011 kkkk 1010 kkkk 1001 kkkk 1000 00 00 00 00 00 0000 0000 0000 0000 0000 0110 0000 0000 0110 0110 0100 TO, PD 0000 0001 0011 TO, PD 0fff INHERENT OPERATIONS 1 1 1 1 1 C-COMPILER OPTIMIZED k[n] Note 1: 2: 3: 1 1 11 00 0001 0nkk kkkk 0000 0001 0nmm Z 2, 3 1 1 11 00 1111 0nkk kkkk Z 0000 0001 1nmm 2 2, 3 1 11 1111 1nkk kkkk 2 If the Program Counter (PC) is modified, or a conditional test is true, the instruction requires two cycles. The second cycle is executed as a NOP. If this instruction addresses an INDF register and the MSb of the corresponding FSR is set, this instruction will require one additional instruction cycle. See Table in the MOVIW and MOVWI instruction descriptions. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 447 PIC16(L)F15313/23 36.3 Instruction Descriptions ADDFSR Add Literal to FSRn ANDLW AND literal with W Syntax: [ label ] ADDFSR FSRn, k Syntax: [ label ] ANDLW Operands: -32 k 31 n [ 0, 1] Operands: 0 k 255 Operation: (W) .AND. (k) (W) Operation: FSR(n) + k FSR(n) Status Affected: Z Status Affected: None Description: Description: The signed 6-bit literal `k' is added to the contents of the FSRnH:FSRnL register pair. The contents of W register are AND'ed with the 8-bit literal `k'. The result is placed in the W register. ANDWF AND W with f k FSRn is limited to the range 0000h-FFFFh. Moving beyond these bounds will cause the FSR to wrap-around. ADDLW Add literal and W Syntax: [ label ] ADDLW Operands: 0 k 255 Operation: Status Affected: Syntax: [ label ] ANDWF Operands: 0 f 127 d 0,1 (W) + k (W) Operation: (W) .AND. (f) (destination) C, DC, Z Status Affected: Z Description: The contents of the W register are added to the 8-bit literal `k' and the result is placed in the W register. Description: AND the W register with register `f'. If `d' is `0', the result is stored in the W register. If `d' is `1', the result is stored back in register `f'. ASRF Arithmetic Right Shift ADDWF Add W and f Syntax: [ label ] ADDWF Operands: 0 f 127 d 0,1 Operation: (W) + (f) (destination) Status Affected: C, DC, Z Description: Add the contents of the W register with register `f'. If `d' is `0', the result is stored in the W register. If `d' is `1', the result is stored back in register `f'. ADDWFC k f,d Syntax: [ label ] ASRF Operands: 0 f 127 d [0,1] Operation: (f<7>) dest<7> (f<7:1>) dest<6:0>, (f<0>) C, [ label ] ADDWFC Operands: 0 f 127 d [0,1] Operation: (W) + (f) + (C) dest C, Z Description: The contents of register `f' are shifted one bit to the right through the Carry flag. The MSb remains unchanged. If `d' is `0', the result is placed in W. If `d' is `1', the result is stored back in register `f'. register f C f {,d} Status Affected: C, DC, Z Description: Add W, the Carry flag and data memory location `f'. If `d' is `0', the result is placed in W. If `d' is `1', the result is placed in data memory location `f'. 2017 Microchip Technology Inc. f {,d} Status Affected: ADD W and CARRY bit to f Syntax: f,d Preliminary DS40001897A-page 448 PIC16(L)F15313/23 BCF Bit Clear f Syntax: [ label ] BCF BTFSC f,b Bit Test f, Skip if Clear Syntax: [ label ] BTFSC f,b 0 f 127 0b7 Operands: 0 f 127 0b7 Operands: Operation: 0 (f) Operation: skip if (f) = 0 Status Affected: None Status Affected: None Description: Bit `b' in register `f' is cleared. Description: If bit `b' in register `f' is `1', the next instruction is executed. If bit `b', in register `f', is `0', the next instruction is discarded, and a NOP is executed instead, making this a 2-cycle instruction. BRA Relative Branch BTFSS Bit Test f, Skip if Set Syntax: [ label ] BRA label [ label ] BRA $+k Syntax: [ label ] BTFSS f,b Operands: 0 f 127 0b<7 Operands: -256 label - PC + 1 255 -256 k 255 Operation: skip if (f) = 1 Operation: (PC) + 1 + k PC Status Affected: None Status Affected: None Description: Description: Add the signed 9-bit literal `k' to the PC. Since the PC will have incremented to fetch the next instruction, the new address will be PC + 1 + k. This instruction is a 2-cycle instruction. This branch has a limited range. If bit `b' in register `f' is `0', the next instruction is executed. If bit `b' is `1', then the next instruction is discarded and a NOP is executed instead, making this a 2-cycle instruction. BRW Relative Branch with W Syntax: [ label ] BRW Operands: None Operation: (PC) + (W) PC Status Affected: None Description: Add the contents of W (unsigned) to the PC. Since the PC will have incremented to fetch the next instruction, the new address will be PC + 1 + (W). This instruction is a 2-cycle instruction. BSF Bit Set f Syntax: [ label ] BSF Operands: 0 f 127 0b7 Operation: 1 (f) Status Affected: None Description: Bit `b' in register `f' is set. 2017 Microchip Technology Inc. f,b Preliminary DS40001897A-page 449 PIC16(L)F15313/23 CALL Call Subroutine CLRWDT Clear Watchdog Timer Syntax: [ label ] CALL k Syntax: [ label ] CLRWDT Operands: 0 k 2047 Operands: None Operation: (PC)+ 1 TOS, k PC<10:0>, (PCLATH<6:3>) PC<14:11> Operation: Status Affected: None 00h WDT 0 WDT prescaler, 1 TO 1 PD Description: Call Subroutine. First, return address (PC + 1) is pushed onto the stack. The 11-bit immediate address is loaded into PC bits <10:0>. The upper bits of the PC are loaded from PCLATH. CALL is a 2-cycle instruction. Status Affected: TO, PD Description: CLRWDT instruction resets the Watchdog Timer. It also resets the prescaler of the WDT. Status bits TO and PD are set. CALLW Subroutine Call With W COMF Complement f Syntax: [ label ] CALLW Syntax: [ label ] COMF Operands: None Operands: Operation: (PC) +1 TOS, (W) PC<7:0>, (PCLATH<6:0>) PC<14:8> 0 f 127 d [0,1] Operation: (f) (destination) Status Affected: Z Description: The contents of register `f' are complemented. If `d' is `0', the result is stored in W. If `d' is `1', the result is stored back in register `f'. DECF Decrement f Syntax: [ label ] DECF f,d f,d Status Affected: None Description: Subroutine call with W. First, the return address (PC + 1) is pushed onto the return stack. Then, the contents of W is loaded into PC<7:0>, and the contents of PCLATH into PC<14:8>. CALLW is a 2-cycle instruction. CLRF Clear f Syntax: [ label ] CLRF Operands: 0 f 127 Operands: Operation: 00h (f) 1Z 0 f 127 d [0,1] Operation: (f) - 1 (destination) Status Affected: Z Status Affected: Z Description: The contents of register `f' are cleared and the Z bit is set. Description: Decrement register `f'. If `d' is `0', the result is stored in the W register. If `d' is `1', the result is stored back in register `f'. CLRW Clear W Syntax: [ label ] CLRW f Operands: None Operation: 00h (W) 1Z Status Affected: Z Description: W register is cleared. Zero bit (Z) is set. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 450 PIC16(L)F15313/23 DECFSZ Decrement f, Skip if 0 INCFSZ Increment f, Skip if 0 Syntax: [ label ] DECFSZ f,d Syntax: [ label ] Operands: 0 f 127 d [0,1] Operands: 0 f 127 d [0,1] Operation: (f) - 1 (destination); skip if result = 0 Operation: (f) + 1 (destination), skip if result = 0 Status Affected: None Status Affected: None Description: The contents of register `f' are decremented. If `d' is `0', the result is placed in the W register. If `d' is `1', the result is placed back in register `f'. If the result is `1', the next instruction is executed. If the result is `0', then a NOP is executed instead, making it a 2-cycle instruction. Description: The contents of register `f' are incremented. If `d' is `0', the result is placed in the W register. If `d' is `1', the result is placed back in register `f'. If the result is `1', the next instruction is executed. If the result is `0', a NOP is executed instead, making it a 2-cycle instruction. GOTO Unconditional Branch IORLW Inclusive OR literal with W Syntax: [ label ] Syntax: [ label ] GOTO k INCFSZ f,d IORLW k Operands: 0 k 2047 Operands: 0 k 255 Operation: k PC<10:0> PCLATH<6:3> PC<14:11> Operation: (W) .OR. k (W) Status Affected: Z Status Affected: None Description: Description: GOTO is an unconditional branch. The 11-bit immediate value is loaded into PC bits <10:0>. The upper bits of PC are loaded from PCLATH<4:3>. GOTO is a 2-cycle instruction. The contents of the W register are OR'ed with the 8-bit literal `k'. The result is placed in the W register. INCF Increment f IORWF Inclusive OR W with f Syntax: [ label ] Syntax: [ label ] Operands: 0 f 127 d [0,1] INCF f,d Operands: 0 f 127 d [0,1] Operation: (f) + 1 (destination) Operation: (W) .OR. (f) (destination) Status Affected: Z Status Affected: Z Description: The contents of register `f' are incremented. If `d' is `0', the result is placed in the W register. If `d' is `1', the result is placed back in register `f'. Description: Inclusive OR the W register with register `f'. If `d' is `0', the result is placed in the W register. If `d' is `1', the result is placed back in register `f'. 2017 Microchip Technology Inc. Preliminary IORWF f,d DS40001897A-page 451 PIC16(L)F15313/23 LSLF Logical Left Shift MOVF Syntax: [ label ] LSLF Syntax: [ label ] Operands: 0 f 127 d [0,1] Operands: 0 f 127 d [0,1] Operation: (f<7>) C (f<6:0>) dest<7:1> 0 dest<0> Operation: (f) (dest) f {,d} Status Affected: C, Z Description: The contents of register `f' are shifted one bit to the left through the Carry flag. A `0' is shifted into the LSb. If `d' is `0', the result is placed in W. If `d' is `1', the result is stored back in register `f'. C register f 0 Z Description: The contents of register f is moved to a destination dependent upon the status of d. If d = 0, destination is W register. If d = 1, the destination is file register f itself. d = 1 is useful to test a file register since status flag Z is affected. Words: 1 Cycles: 1 Logical Right Shift Syntax: [ label ] LSRF Operands: 0 f 127 d [0,1] Operation: 0 dest<7> (f<7:1>) dest<6:0>, (f<0>) C, Status Affected: C, Z Description: The contents of register `f' are shifted one bit to the right through the Carry flag. A `0' is shifted into the MSb. If `d' is `0', the result is placed in W. If `d' is `1', the result is stored back in register `f'. 2017 Microchip Technology Inc. MOVF FSR, 0 After Instruction W = value in FSR register Z = 1 LSRF f {,d} register f MOVF f,d Status Affected: Example: 0 Move f C Preliminary DS40001897A-page 452 PIC16(L)F15313/23 MOVIW Move INDFn to W MOVLP Syntax: [ label ] MOVIW ++FSRn [ label ] MOVIW --FSRn [ label ] MOVIW FSRn++ [ label ] MOVIW FSRn-[ label ] MOVIW k[FSRn] Syntax: [ label ] MOVLP k Operands: 0 k 127 Operands: n [0,1] mm [00,01, 10, 11] -32 k 31 Operation: INDFn W Effective address is determined by * FSR + 1 (preincrement) * FSR - 1 (predecrement) * FSR + k (relative offset) After the Move, the FSR value will be either: * FSR + 1 (all increments) * FSR - 1 (all decrements) * Unchanged Status Affected: Operation: k PCLATH Status Affected: None Description: The 7-bit literal `k' is loaded into the PCLATH register. MOVLW Move literal to W Syntax: [ label ] 0 k 255 Operation: k (W) Status Affected: None Description: The 8-bit literal `k' is loaded into W register. The "don't cares" will assemble as `0's. Words: 1 1 Mode Syntax mm Cycles: Preincrement ++FSRn 00 Example: --FSRn 01 Postincrement FSRn++ 10 Postdecrement FSRn-- 11 Description: Note: The INDFn registers are not physical registers. Any instruction that accesses an INDFn register actually accesses the register at the address specified by the FSRn. Syntax: [ label ] MOVLB k Operands: 0k Operation: k BSR Status Affected: None Description: The 6-bit literal `k' is loaded into the Bank Select Register (BSR). 2017 Microchip Technology Inc. 0x5A MOVWF Move W to f Syntax: [ label ] MOVWF Operands: 0 f 127 Operation: (W) (f) 0x5A f Status Affected: None Description: Move data from W register to register `f'. Words: 1 Cycles: 1 Example: FSRn is limited to the range 0000h FFFFh. Incrementing/decrementing it beyond these bounds will cause it to wrap-around. Move literal to BSR MOVLW After Instruction W = This instruction is used to move data between W and one of the indirect registers (INDFn). Before/after this move, the pointer (FSRn) is updated by pre/post incrementing/decrementing it. MOVLB MOVLW k Operands: Z Predecrement Move literal to PCLATH Preliminary MOVWF LATA Before Instruction LATA = 0xFF W = 0x4F After Instruction LATA = 0x4F W = 0x4F DS40001897A-page 453 PIC16(L)F15313/23 MOVWI Move W to INDFn NOP No Operation Syntax: [ label ] MOVWI ++FSRn [ label ] MOVWI --FSRn [ label ] MOVWI FSRn++ [ label ] MOVWI FSRn-[ label ] MOVWI k[FSRn] Syntax: [ label ] Operands: None n [0,1] mm [00,01, 10, 11] -32 k 31 Description: No operation. Words: 1 Cycles: 1 Operands: Operation: W INDFn Effective address is determined by * FSR + 1 (preincrement) * FSR - 1 (predecrement) * FSR + k (relative offset) After the Move, the FSR value will be either: * FSR + 1 (all increments) * FSR - 1 (all decrements) Unchanged Status Affected: None Mode Syntax Preincrement ++FSRn 00 Predecrement --FSRn 01 Postincrement FSRn++ 10 Postdecrement FSRn-- 11 Description: This instruction is used to move data between W and one of the indirect registers (INDFn). Before/after this move, the pointer (FSRn) is updated by pre/post incrementing/decrementing it. mm NOP Operation: No operation Status Affected: None Example: NOP RESET Software Reset Syntax: [ label ] RESET Operands: None Operation: Execute a device Reset. Resets the RI flag of the PCON register. Status Affected: None Description: This instruction provides a way to execute a hardware Reset by software. RETFIE Return from Interrupt Syntax: [ label ] Operands: None Operation: TOS PC, 1 GIE RETFIE k Status Affected: None Note: The INDFn registers are not physical registers. Any instruction that accesses an INDFn register actually accesses the register at the address specified by the FSRn. Description: Return from Interrupt. Stack is POPed and Top-of-Stack (TOS) is loaded in the PC. Interrupts are enabled by setting Global Interrupt Enable bit, GIE (INTCON<7>). This is a 2-cycle instruction. FSRn is limited to the range 0000h-FFFFh. Incrementing/decrementing it beyond these bounds will cause it to wrap-around. Words: 1 Cycles: 2 Example: The increment/decrement operation on FSRn WILL NOT affect any Status bits. 2017 Microchip Technology Inc. Preliminary RETFIE After Interrupt PC = GIE = TOS 1 DS40001897A-page 454 PIC16(L)F15313/23 RETLW Return with literal in W Syntax: [ label ] RLF RETLW k Syntax: [ label ] 0 f 127 d [0,1] See description below Operands: 0 k 255 Operands: Operation: k (W); TOS PC Operation: Status Affected: None Description: The W register is loaded with the 8-bit literal `k'. The program counter is loaded from the top of the stack (the return address). This is a 2-cycle instruction. Words: 1 Cycles: 2 Example: TABLE Rotate Left f through Carry RLF f,d Status Affected: C Description: The contents of register `f' are rotated one bit to the left through the Carry flag. If `d' is `0', the result is placed in the W register. If `d' is `1', the result is stored back in register `f'. C CALL TABLE;W contains table ;offset value * ;W now has table value * * ADDWF PC ;W = offset RETLW k1 ;Begin table RETLW k2 ; * * * RETLW kn ; End of table Before Instruction W = After Instruction W = 0x07 Return from Subroutine Syntax: [ label ] RETURN None Operation: TOS PC Status Affected: None Description: Return from subroutine. The stack is POPed and the top of the stack (TOS) is loaded into the program counter. This is a 2-cycle instruction. 2017 Microchip Technology Inc. 1 Cycles: 1 Example: RLF REG1,0 Before Instruction REG1 C After Instruction REG1 W C = = 1110 0110 0 = = = 1110 0110 1100 1100 1 RRF Rotate Right f through Carry Syntax: [ label ] Operands: 0 f 127 d [0,1] Operation: See description below Status Affected: C Description: The contents of register `f' are rotated one bit to the right through the Carry flag. If `d' is `0', the result is placed in the W register. If `d' is `1', the result is placed back in register `f'. value of k8 RETURN Operands: Words: Register f Preliminary RRF f,d C Register f DS40001897A-page 455 PIC16(L)F15313/23 SUBWF SLEEP Subtract W from f Enter Sleep mode Syntax: [ label ] Operands: 0 f 127 d [0,1] Operation: (f) - (W) destination) Syntax: [ label ] Operands: None SLEEP Operation: 00h WDT, 0 WDT prescaler, 1 TO, 0 PD Status Affected: TO, PD Description: The power-down Status bit, PD is cleared. Time-out Status bit, TO is set. Watchdog Timer and its prescaler are cleared. See Section 11.2 "Sleep Mode" for more information. Status Affected: C, DC, Z Description: Subtract (2's complement method) W register from register `f'. If `d' is `0', the result is stored in the W register. If `d' is `1', the result is stored back in register `f. SUBWFB SUBLW Subtract W from literal Syntax: [ label ] SUBWF f,d C=0 Wf C=1 Wf DC = 0 W<3:0> f<3:0> DC = 1 W<3:0> f<3:0> Subtract W from f with Borrow Syntax: SUBWFB Operands: 0 f 127 d [0,1] f {,d} Operation: (f) - (W) - (B) dest Status Affected: C, DC, Z Description: Subtract W and the BORROW flag (CARRY) from register `f' (2's complement method). If `d' is `0', the result is stored in W. If `d' is `1', the result is stored back in register `f'. SWAPF Swap Nibbles in f SUBLW k Operands: 0 k 255 Operation: k - (W) W) Status Affected: C, DC, Z Syntax: [ label ] The W register is subtracted (2's complement method) from the 8-bit literal `k'. The result is placed in the W register. Operands: 0 f 127 d [0,1] Operation: (f<3:0>) (destination<7:4>), (f<7:4>) (destination<3:0>) Description: SWAPF f,d C=0 Wk Status Affected: None C=1 Wk Description: DC = 0 W<3:0> k<3:0> DC = 1 W<3:0> k<3:0> The upper and lower nibbles of register `f' are exchanged. If `d' is `0', the result is placed in the W register. If `d' is `1', the result is placed in register `f'. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 456 PIC16(L)F15313/23 TRIS Load TRIS Register with W XORLW Exclusive OR literal with W Syntax: [ label ] TRIS f Syntax: [ label ] Operands: 5f7 Operands: 0 k 255 Operation: (W) TRIS register `f' Operation: (W) .XOR. k W) Status Affected: None Status Affected: Z Description: Move data from W register to TRIS register. When `f' = 5, TRISA is loaded. When `f' = 6, TRISB is loaded. When `f' = 7, TRISC is loaded. Description: The contents of the W register are XOR'ed with the 8-bit literal `k'. The result is placed in the W register. XORWF 2017 Microchip Technology Inc. XORLW k Exclusive OR W with f Syntax: [ label ] Operands: 0 f 127 d [0,1] XORWF f,d Operation: (W) .XOR. (f) destination) Status Affected: Z Description: Exclusive OR the contents of the W register with register `f'. If `d' is `0', the result is stored in the W register. If `d' is `1', the result is stored back in register `f'. Preliminary DS40001897A-page 457 PIC16(L)F15313/23 37.0 ELECTRICAL SPECIFICATIONS 37.1 Absolute Maximum Ratings() Ambient temperature under bias...................................................................................................... -40C to +125C Storage temperature ........................................................................................................................ -65C to +150C Voltage on pins with respect to VSS on VDD pin PIC16F15313/23 ....................................................................................................... -0.3V to +6.5V PIC16LF15313/23 ..................................................................................................... -0.3V to +4.0V on MCLR pin ........................................................................................................................... -0.3V to +9.0V on all other pins ............................................................................................................ -0.3V to (VDD + 0.3V) Maximum current on VSS pin(1) -40C TA +85C .............................................................................................................. 250 mA 85C TA +125C ............................................................................................................... 85 mA on VDD pin for 28-Pin devices(1) -40C TA +85C .............................................................................................................. 250 mA 85C TA +125C ............................................................................................................... 85 mA on VDD pin for 40-Pin devices(1) -40C TA +85C .............................................................................................................. 350 mA 85C TA +125C ............................................................................................................. 120 mA on any standard I/O pin ...................................................................................................................... 50 mA Clamp current, IK (VPIN < 0 or VPIN > VDD) ................................................................................................... 20 mA Total power dissipation(2)................................................................................................................................ 800 mW Note 1: 2: Maximum current rating requires even load distribution across I/O pins. Maximum current rating may be limited by the device package power dissipation characterizations, see Table 37-6 to calculate device specifications. Power dissipation is calculated as follows: PDIS = VDD x {IDD - IOH} + VDD - VOH) x IOH} + VOI x IOL NOTICE: Stresses above those listed under "Absolute Maximum Ratings" may cause permanent damage to the device. This is a stress rating only and functional operation of the device at those or any other conditions above those indicated in the operation listings of this specification is not implied. Exposure above maximum rating conditions for extended periods may affect device reliability. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 458 PIC16(L)F15313/23 37.2 Standard Operating Conditions The standard operating conditions for any device are defined as: Operating Voltage: Operating Temperature: VDDMIN VDD VDDMAX TA_MIN TA TA_MAX VDD -- Operating Supply Voltage(1) PIC16LF15313/23 VDDMIN (Fosc 16 MHz) ......................................................................................................... +1.8V VDDMIN (Fosc 32 MHz) ......................................................................................................... +2.5V VDDMAX .................................................................................................................................... +3.6V PIC16F15313/23 VDDMIN (Fosc 16 MHz) ......................................................................................................... +2.3V VDDMIN (Fosc 32 MHz) ......................................................................................................... +2.5V VDDMAX .................................................................................................................................... +5.5V TA -- Operating Ambient Temperature Range Industrial Temperature TA_MIN ...................................................................................................................................... -40C TA_MAX .................................................................................................................................... +85C Extended Temperature TA_MIN ...................................................................................................................................... -40C TA_MAX .................................................................................................................................. +125C Note 1: See Parameter Supply Voltage, DS Characteristics: Supply Voltage. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 459 PIC16(L)F15313/23 VOLTAGE FREQUENCY GRAPH, -40C TA +125C, PIC16(L)F15313/23 ONLY FIGURE 37-1: VDD (V) 5.5 2.5 2.3 0 10 4 16 32 Frequency (MHz) Note 1: The shaded region indicates the permissible combinations of voltage and frequency. 2: Refer to Table 37-7 for each Oscillator mode's supported frequencies. VOLTAGE FREQUENCY GRAPH, -40C TA +125C, PIC16(L)F15313/23 ONLY VDD (V) FIGURE 37-2: 3.6 2.5 1.8 0 4 10 16 32 Frequency (MHz) Note 1: The shaded region indicates the permissible combinations of voltage and frequency. 2: Refer to Table 37-7 for each Oscillator mode's supported frequencies. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 460 PIC16(L)F15313/23 37.3 DC Characteristics TABLE 37-1: SUPPLY VOLTAGE PIC16LF15313/23 Standard Operating Conditions (unless otherwise stated) PIC16F15313/23 Param. No. Sym. Characteristic Min. Typ. Max. Units Conditions Supply Voltage D002 VDD 1.8 2.5 -- -- 3.6 3.6 V V FOSC 16 MHz FOSC 16 MHz D002 VDD 2.3 2.5 -- -- 5.5 5.5 V V FOSC 16 MHz FOSC 16 MHz RAM Data Retention(1) D003 VDR 1.5 -- -- V Device in Sleep mode D003 VDR 1.7 -- -- V Device in Sleep mode Power-on Reset Release Voltage(2) D004 VPOR -- 1.6 -- V BOR or LPBOR disabled(3) D004 VPOR -- 1.6 -- V BOR or LPBOR disabled(3) Power-on Reset Rearm Voltage(2) D005 VPORR -- 0.8 -- V BOR or LPBOR disabled(3) D005 VPORR -- 1.5 -- V BOR or LPBOR disabled(3) VDD Rise Rate to ensure internal Power-on Reset signal(2) D006 SVDD 0.05 -- -- V/ms BOR or LPBOR disabled(3) D006 SVDD 0.05 -- -- V/ms BOR or LPBOR disabled(3) Note 1: 2: 3: 4: Data in "Typ." column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. This is the limit to which VDD can be lowered in Sleep mode without losing RAM data. See Figure 37-3, POR and POR REARM with Slow Rising VDD. See Table 37-11 for BOR and LPBOR trip point information. = F device 2017 Microchip Technology Inc. Preliminary DS40001897A-page 461 PIC16(L)F15313/23 FIGURE 37-3: POR AND POR REARM WITH SLOW RISING VDD VDD VPOR VPORR SVDD VSS NPOR(1) POR REARM VSS TVLOW(3) Note 1: 2: 3: TPOR(2) When NPOR is low, the device is held in Reset. TPOR 1 s typical. TVLOW 2.7 s typical. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 462 PIC16(L)F15313/23 TABLE 37-2: SUPPLY CURRENT (IDD)(1,2,4) Standard Operating Conditions (unless otherwise stated) PIC16LF15313/23 PIC16F15313/23 Param. No. Conditions Symbol Device Characteristics Min. Typ. Max. Units VDD D100 IDDXT4 XT = 4 MHz -- 360 400 A 3.0V D100 IDDXT4 XT = 4 MHz -- 380 450 A 3.0V D101 IDDHFO16 HFINTOSC = 16 MHz -- 1.4 1.8 mA 3.0V D101 IDDHFO16 HFINTOSC = 16 MHz -- 1.5 1.9 mA 3.0V D102 IDDHFOPLL HFINTOSC = 32 MHz -- 2.3 3.2 mA 3.0V D102 IDDHFOPLL HFINTOSC = 32 MHz -- 2.4 3.2 mA 3.0V D103 IDDHSPLL32 HS+PLL = 32 MHz -- 2.3 3.2 mA 3.0V D103 IDDHSPLL32 HS+PLL = 32 MHz -- 2.4 3.2 mA 3.0V D104 IDDIDLE IDLE mode, HFINTOSC = 16 MHz -- 1.05 1.5 mA 3.0V D104 IDDIDLE IDLE mode, HFINTOSC = 16 MHz -- 1.15 1.5 mA 3.0V D105 IDDDOZE(3) DOZE mode, HFINTOSC = 16 MHz, Doze Ratio = 16 -- 1.1 -- mA 3.0V D105 IDDDOZE(3) DOZE mode, HFINTOSC = 16 MHz, Doze Ratio = 16 -- 1.2 -- mA 3.0V Note 1: 2: 3: 4: 5: Note Data in "Typ." column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. The test conditions for all IDD measurements in active operation mode are: OSC1 = external square wave, from rail-to-rail; all I/O pins are outputs driven low; MCLR = VDD; WDT disabled. The supply current is mainly a function of the operating voltage and frequency. Other factors, such as I/O pin loading and switching rate, oscillator type, internal code execution pattern and temperature, also have an impact on the current consumption. IDDDOZE = [IDDIDLE*(N-1)/N] + IDDHFO16/N where N = DOZE Ratio (Register 11-2). PMD bits are all in the default state, no modules are disabled. = F device 2017 Microchip Technology Inc. Preliminary DS40001897A-page 463 PIC16(L)F15313/23 TABLE 37-3: POWER-DOWN CURRENT (IPD)(1,2) PIC16LF15313/23 Standard Operating Conditions (unless otherwise stated) PIC16F15313/23 Standard Operating Conditions (unless otherwise stated) VREGPM = 1 Param. No. Symbol Device Characteristics Conditions Min. Typ. Max. +85C Max. +125C Units 2 9 A 3.0V 3.0V VDD D200 IPD IPD Base -- 0.06 D200 D200A IPD IPD Base -- 0.4 4 12 -- 18 22 27 D201 IPD_WDT Low-Frequency Internal Oscillator/WDT -- 0.8 4.0 11.5 A A A D201 IPD_WDT Low-Frequency Internal Oscillator/WDT -- 0.9 5.0 13 A 3.0V D203 IPD_FVR FVR -- 33 47 47 3.0V D203 IPD_FVR FVR -- 28 44 44 D204 IPD_BOR Brown-out Reset (BOR) -- 10 17 19 D204 IPD_BOR Brown-out Reset (BOR) -- 14 18 20 D205 IPD_LPBOR Low-Power Brown-out Reset (LPBOR) -- 0.5 4 10 D207 IPD_ADCA ADC - Active -- 250 -- -- D207 IPD_ADCA ADC - Active -- 280 -- -- D208 IPD_CMP Comparator -- 30 42 44 D208 IPD_CMP Comparator -- 33 44 45 A A A A A A A A A Note 1: 2: 3: 4: 5: 3.0V Note VREGPM = 0 3.0V 3.0V 3.0V 3.0V 3.0V 3.0V ADC is converting (4) 3.0V ADC is converting (4) 3.0V 3.0V Data in "Typ." column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. The peripheral current is the sum of the base IDD and the additional current consumed when this peripheral is enabled. The peripheral current can be determined by subtracting the base IDD or IPD current from this limit. Max. values should be used when calculating total current consumption. The power-down current in Sleep mode does not depend on the oscillator type. Power-down current is measured with the part in Sleep mode with all I/O pins in high-impedance state and tied to VSS. All peripheral currents listed are on a per-peripheral basis if more than one instance of a peripheral is available. ADC clock source is FRC. = F device 2017 Microchip Technology Inc. Preliminary DS40001897A-page 464 PIC16(L)F15313/23 TABLE 37-4: I/O PORTS Standard Operating Conditions (unless otherwise stated) Param. No. Sym. VIL Characteristic Min. Typ Max. Units -- -- Conditions -- 0.8 V 4.5V VDD 5.5V -- 0.15 VDD V 1.8V VDD 4.5V 2.0V VDD 5.5V Input Low Voltage I/O PORT: D300 with TTL buffer D301 D302 with Schmitt Trigger buffer -- -- 0.2 VDD V D303 with I2C levels -- -- 0.3 VDD V with SMBus levels -- -- 0.8 V -- -- 0.2 VDD V D304 D305 MCLR VIH 2.7V VDD 5.5V Input High Voltage I/O PORT: D320 with TTL buffer D321 2.0 -- -- V 4.5V VDD 5.5V 0.25 VDD + 0.8 -- -- V 1.8V VDD 4.5V 2.0V VDD 5.5V D322 with Schmitt Trigger buffer 0.8 VDD -- -- V D323 with I2C levels 0.7 VDD -- -- V D324 with SMBus levels D325 MCLR IIL D340 D341 MCLR(2) IPUR Weak Pull-up Current VOL Output Low Voltage D350 D360 I/O ports VOH D370 CIO -- V -- -- V -- 5 125 nA VSS VPIN VDD, Pin at high-impedance, 85C -- 5 1000 nA VSS VPIN VDD, Pin at high-impedance, 125C -- 50 200 nA VSS VPIN VDD, Pin at high-impedance, 85C 25 120 200 A VDD = 3.0V, VPIN = VSS -- -- 0.6 V IOL = 10.0mA, VDD = 3.0V VDD - 0.7 -- -- V IOH = 6.0 mA, VDD = 3.0V -- 5 50 pF Output High Voltage I/O ports D380 -- Input Leakage Current(1) I/O Ports D342 2.7V VDD 5.5V 2.1 0.7 VDD All I/O pins Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. Note 1: Negative current is defined as current sourced by the pin. 2: The leakage current on the MCLR pin is strongly dependent on the applied voltage level. The specified levels represent normal operating conditions. Higher leakage current may be measured at different input voltages. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 465 PIC16(L)F15313/23 TABLE 37-5: MEMORY PROGRAMMING SPECIFICATIONS Standard Operating Conditions (unless otherwise stated) Param. No. Sym. Characteristic Min. Typ Max. Units Voltage on MCLR/VPP pin to enter programming mode 8 -- 9 V Current on MCLR/VPP pin during programming mode -- 1 -- mA Conditions High Voltage Entry Programming Mode Specifications MEM01 VIHH MEM02 IPPGM (Note 2, Note 3) (Note 2) Programming Mode Specifications MEM10 VBE VDD for Bulk Erase -- 2.7 -- V MEM11 IDDPGM Supply Current during Programming operation -- -- 10 mA Program Flash Memory Specifications MEM30 EP Flash Memory Cell Endurance 10k -- -- E/W -40C TA +85C (Note 1) MEM32 TP_RET Characteristic Retention -- 40 -- Year Provided no other specifications are violated MEM33 VP_RD VDD for Read operation VDDMIN -- VDDMAX V MEM34 VP_REW VDD for Row Erase or Write operation VDDMIN -- VDDMAX V MEM35 TP_REW Self-Timed Row Erase or Self-Timed Write -- 2.0 2.5 ms Note 1: 2: 3: Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. Flash Memory Cell Endurance for the Flash memory is defined as: One Row Erase operation and one Self-Timed Write. Required only if CONFIG4, bit LVP is disabled. The MPLAB(R) ICD2 does not support variable VPP output. Circuitry to limit the ICD2 VPP voltage must be placed between the ICD2 and target system when programming or debugging with the ICD2. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 466 PIC16(L)F15313/23 TABLE 37-6: THERMAL CHARACTERISTICS Standard Operating Conditions (unless otherwise stated) Param. No. TH01 TH02 Sym. Characteristic JA Thermal Resistance Junction to Ambient JC TH03 TJMAX TH04 PD TH05 Thermal Resistance Junction to Case Maximum Junction Temperature Power Dissipation PINTERNAL Internal Power Dissipation Typ. Units Conditions 70 C/W 95.3C C/W 8-pin SOIC package 100.0 C/W 8-pin DFN package 100.0 C/W 14-pin PDIP package 100.0 C/W 14-pin TSSOP package 77.7 C/W 14-pin SOIC package 51.5 C/W 16-pin UQFN 4x4mm package 32.75 C/W 8-pin PDIP package 31.0 C/W 8-pin SOIC package 24.4 C/W 8-pin DFN package 5.4 C/W 14-pin PDIP package 27.5 C/W 14-pin TSSOP package 31.1 C/W 14-pin SOIC package 23.1 C/W 16-pin UQFN 4x4mm package 150 C 8-pin PDIP package -- W PD = PINTERNAL + PI/O -- W PINTERNAL = IDD x VDD(1) TH06 PI/O I/O Power Dissipation -- W PI/O = (IOL * VOL) + (IOH * (VDD - VOH)) TH07 PDER Derated Power -- W PDER = PDMAX (TJ - TA)/JA(2) Note 1: IDD is current to run the chip alone without driving any load on the output pins. 2: TA = Ambient Temperature, TJ = Junction Temperature 2017 Microchip Technology Inc. Preliminary DS40001897A-page 467 PIC16(L)F15313/23 37.4 AC Characteristics FIGURE 37-4: LOAD CONDITIONS Rev. 10-000133A 8/1/2013 Load Condition Pin CL VSS Legend: CL=50 pF for all pins 2017 Microchip Technology Inc. Preliminary DS40001897A-page 468 PIC16(L)F15313/23 FIGURE 37-5: CLOCK TIMING Q4 Q1 Q2 Q3 Q4 Q1 CLKIN OS2 OS1 OS2 OS20 CLKOUT (CLKOUT Mode) Note See Table 37-7. 1: TABLE 37-7: EXTERNAL CLOCK/OSCILLATOR TIMING REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Param. No. Sym. Characteristic Min. Typ Max. Units Conditions ECL Oscillator OS1 FECL Clock Frequency -- -- 500 kHz OS2 TECL_DC Clock Duty Cycle 40 -- 60 % ECM Oscillator OS3 FECM Clock Frequency -- -- 4 MHz OS4 TECM_DC Clock Duty Cycle 40 -- 60 % ECH Oscillator OS5 FECH Clock Frequency -- -- 32 MHz OS6 TECH_DC Clock Duty Cycle 40 -- 60 % Clock Frequency -- -- 100 kHz Note 4 Clock Frequency -- -- 4 MHz Note 4 Clock Frequency -- -- 20 MHz Note 4 (Note 2, Note 3) LP Oscillator OS7 FLP XT Oscillator OS8 FXT HS Oscillator OS9 FHS System Oscillator OS20 FOSC System Clock Frequency -- -- 32 MHz OS21 FCY Instruction Frequency -- FOSC/4 -- MHz OS22 TCY Instruction Period 125 1/FCY -- ns * Note 1: 2: 3: 4: These parameters are characterized but not tested. Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. Instruction cycle period (TCY) equals four times the input oscillator time base period. All specified values are based on characterization data for that particular oscillator type under standard operating conditions with the device executing code. Exceeding these specified limits may result in an unstable oscillator operation and/or higher than expected current consumption. All devices are tested to operate at "min" values with an external clock applied to OSC1 pin. When an external clock input is used, the "max" cycle time limit is "DC" (no clock) for all devices. The system clock frequency (FOSC) is selected by the "main clock switch controls" as described in Section 9.0 "Oscillator Module (with Fail-Safe Clock Monitor)". The system clock frequency (FOSC) must meet the voltage requirements defined in the Section 37.2 "Standard Operating Conditions". LP, XT and HS oscillator modes require an appropriate crystal or resonator to be connected to the device. For clocking the device with the external square wave, one of the EC mode selections must be used. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 469 PIC16(L)F15313/23 INTERNAL OSCILLATOR PARAMETERS(1) TABLE 37-8: Standard Operating Conditions (unless otherwise stated) Param. No. Sym. Characteristic Min. Typ Max. Units Conditions OS50 FHFOSC Precision Calibrated HFINTOSC Frequency -- 4 8 12 16 32 -- MHz (Note 2) OS51 FHFOSCLP Low-Power Optimized HFINTOSC Frequency -- -- 1 2 -- -- MHz MHz OS52 FMFOSC Internal Calibrated MFINTOSC Frequency -- 500 -- kHz OS53 FLFOSC Internal LFINTOSC Frequency -- 31 -- kHz OS54 THFOSCST HFINTOSC Wake-up from Sleep Start-up Time -- -- 11 50 20 -- s s OS56 TLFOSCST -- 0.2 -- ms LFINTOSC Wake-up from Sleep Start-up Time VREGPM = 0 VREGPM = 1 Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. Note 1: To ensure these oscillator frequency tolerances, VDD and VSS must be capacitively decoupled as close to the device as possible. 0.1 F and 0.01 F values in parallel are recommended. 2: See Figure 37-6: Precision Calibrated HFINTOSC Frequency Accuracy Over Device VDD and Temperature. FIGURE 37-6: PRECISION CALIBRATED HFINTOSC FREQUENCY ACCURACY OVER DEVICE VDD AND TEMPERATURE 125 5% Temperature (C) 85 3% 60 2% 0 5% -40 1.8 2.0 2.3 3.0 3.5 4.0 4.5 5.0 5.5 VDD (V) 2017 Microchip Technology Inc. Preliminary DS40001897A-page 470 PIC16(L)F15313/23 TABLE 37-9: PLL SPECIFICATIONS Standard Operating Conditions (unless otherwise stated) VDD 2.5V Param. No. Sym. Characteristic PLL Input Frequency Range PLL01 FPLLIN PLL02 FPLLOUT PLL Output Frequency Range PLL03 TPLLST PLL Lock Time from Start-up PLL04 FPLLJIT PLL Output Frequency Stability (Jitter) Min. Typ Max. Units Conditions 4 -- 8 MHz 16 -- 32 MHz Note 1 -- 200 -- s -0.25 -- 0.25 % * These parameters are characterized but not tested. Data in "Typ" column is at 5V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. Note 1: The output frequency of the PLL must meet the FOSC requirements listed in Parameter D002. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 471 PIC16(L)F15313/23 FIGURE 37-7: CLKOUT AND I/O TIMING Cycle Write Fetch Q1 Q4 Read Execute Q2 Q3 FOSC IO2 IO1 IO10 CLKOUT IO8, IO9 IO6, IO7 IO5 IO4 I/O pin (Input) IO3 I/O pin (Output) New Value Old Value IO6, IO7, IO8, IO9 TABLE 37-10: I/O AND CLKOUT TIMING SPECIFICATIONS Standard Operating Conditions (unless otherwise stated) Param. No. IO1* Sym. Characteristic Min. Conditions IO7* CLKOUT rising edge delay (rising edge Fosc (Q1 cycle) to falling edge CLKOUT TCLKOUTL CLKOUT falling edge delay (rising edge Fosc (Q3 cycle) to rising edge CLKOUT Port output valid time (rising edge TIO_VALID Fosc (Q1 cycle) to port valid) Port input setup time (Setup time TIO_SETUP before rising edge Fosc - Q2 cycle) Port input hold time (Hold time after TIO_HOLD rising edge Fosc - Q2 cycle) TIOR_SLREN Port I/O rise time, slew rate enabled TIOR_SLRDIS Port I/O rise time, slew rate disabled IO8* TIOF_SLREN Port I/O fall time, slew rate enabled -- 25 -- ns VDD = 3.0V IO9* TIOF_SLRDIS Port I/O fall time, slew rate disabled -- 5 -- ns VDD = 3.0V IO10* TINT 25 -- -- ns IO11* TIOC 25 -- -- ns IO2* IO3* IO4* IO5* IO6* TCLKOUTH Typ Max. Units INT pin high or low time to trigger an interrupt Interrupt-on-Change minimum high or low time to trigger interrupt *These parameters are characterized but not tested. 2017 Microchip Technology Inc. Preliminary -- -- 70 ns -- -- 72 ns -- 50 70 ns 20 -- -- ns 50 -- -- ns -- 25 -- ns VDD = 3.0V -- 5 -- ns VDD = 3.0V DS40001897A-page 472 PIC16(L)F15313/23 FIGURE 37-8: RESET, WATCHDOG TIMER, OSCILLATOR START-UP TIMER AND POWER-UP TIMER TIMING VDD MCLR RST01 Internal POR RST04 PWRT Time-out RST05 OSC Start-up Time Internal Reset(1) Watchdog Timer Reset(1) RST03 RST02 RST02 I/O pins Note 1: Asserted low. FIGURE 37-9: BROWN-OUT RESET TIMING AND CHARACTERISTICS VDD VBOR + VHYST VBOR (Device in Brown-out Reset) (Device not in Brown-out Reset) (RST08)(1) Reset (RST04)(1) (due to BOR) Note 1: 64 ms delay only if PWRTE bit in the Configuration Word register is programmed to `1'; 2 ms delay if PWRTE = 0. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 473 PIC16(L)F15313/23 TABLE 37-11: RESET, WDT, OSCILLATOR START-UP TIMER, POWER-UP TIMER, BROWN-OUT RESET AND LOW-POWER BROWN-OUT RESET SPECIFICATIONS Standard Operating Conditions (unless otherwise stated) Param. No. Sym. Characteristic Min. Typ Max. Units RST01* TMCLR MCLR Pulse Width Low to ensure Reset 2 -- -- s RST02* TIOZ I/O high-impedance from Reset detection -- -- 2 s RST03 TWDT Watchdog Timer Time-out Period -- 16 -- ms RST04* TPWRT Power-up Timer Period -- 65 -- ms RST05 TOST Oscillator Start-up Timer Period(1,2) RST06 VBOR Brown-out Reset Voltage(4) RST07 VBORHYS RST08 TBORDC RST09 VLPBOR -- 1024 -- TOSC 2.55 2.30 1.80 2.70 2.45 1.90 2.85 2.60 2.10 V V V Brown-out Reset Hysteresis -- 40 -- mV Brown-out Reset Response Time -- 3 -- s Low-Power Brown-out Reset Voltage 1.8 1.9 2.2 V Conditions 16 ms Nominal Reset Time BORV = 0 BORV = 1 (F devices) BORV = 1 (LF devices) LF Devices Only * These parameters are characterized but not tested. Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. Note 1: By design, the Oscillator Start-up Timer (OST) counts the first 1024 cycles, independent of frequency. 2: To ensure these voltage tolerances, VDD and VSS must be capacitively decoupled as close to the device as possible. 0.1 F and 0.01 F values in parallel are recommended. TABLE 37-12: ANALOG-TO-DIGITAL CONVERTER (ADC) ACCURACY SPECIFICATIONS(1,2): Standard Operating Conditions (unless otherwise stated) VDD = 3.0V, TA = 25C Param. No. AD01 Sym. Characteristic Min. Typ Max. Units bit NR Resolution -- -- 10 Conditions AD02 EIL Integral Error -- 0.1 1.0 AD03 EDL Differential Error -- 0.1 1.0 LSb ADCREF+ = 3.0V, ADCREF-= 0V LSb ADCREF+ = 3.0V, ADCREF-= 0V AD04 EOFF Offset Error -- 0.5 2.0 LSb ADCREF+ = 3.0V, ADCREF-= 0V AD05 EGN Gain Error -- 0.2 1.0 LSb ADCREF+ = 3.0V, ADCREF-= 0V AD06 VADREF ADC Reference Voltage (ADREF+ - ADREF-) 1.8 -- VDD V AD07 VAIN Full-Scale Range ADREF- -- ADREF+ V AD08 ZAIN Recommended Impedance of Analog Voltage Source -- 10 -- k AD09 RVREF ADC Voltage Reference Ladder Impedance -- 50 -- k Note 3 * These parameters are characterized but not tested. Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. Note 1: Total Absolute Error is the sum of the offset, gain and integral non-linearity (INL) errors. 2: The ADC conversion result never decreases with an increase in the input and has no missing codes. 3: This is the impedance seen by the VREF pads when the external reference pads are selected. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 474 PIC16(L)F15313/23 TABLE 37-13: ANALOG-TO-DIGITAL CONVERTER (ADC) CONVERSION TIMING SPECIFICATIONS Standard Operating Conditions (unless otherwise stated) Param. Sym. No. AD20 TAD Characteristic Min. Typ Max. Units 1 -- 9 s The requirement is to set ADCCS correctly to produce this period/frequency. 1 2 6 s Using FRC as the ADC clock source ADOSC = 1 Set of GO/DONE bit to Clear of GO/DONE bit ADC Clock Period AD21 AD22 TCNV Conversion Time -- 11 -- TAD AD23 TACQ Acquisition Time -- 2 -- s AD24 THCD Sample and Hold Capacitor Disconnect Time -- -- -- s * Conditions FOSC-based clock source FRC-based clock source These parameters are characterized but not tested. Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. ADC CONVERSION TIMING (ADC CLOCK FOSC-BASED) FIGURE 37-10: BSF ADCON0, GO AD24 1 TCY AD22 Q4 9 ADC Data 8 7 6 3 2 1 0 NEW_DATA OLD_DATA ADRES 1 TCY ADIF GO Sample DONE Sampling Stopped AD23 FIGURE 37-11: ADC CONVERSION TIMING (ADC CLOCK FROM ADCRC) BSF ADCON0, GO AD24 1 TCY AD22 Q4 AD20 ADC_clk 9 ADC Data 8 7 6 OLD_DATA ADRES 2 1 0 NEW_DATA 1 TCY ADIF GO Sample 3 DONE AD23 2017 Microchip Technology Inc. Sampling Stopped Preliminary DS40001897A-page 475 PIC16(L)F15313/23 TABLE 37-14: COMPARATOR SPECIFICATIONS Standard Operating Conditions (unless otherwise stated) VDD = 3.0V, TA = 25C Param. No. CM01 Sym. VIOFF Characteristics Input Offset Voltage Min. Typ. Max. Units -- -- 50 mV CM02 VICM Input Common Mode Range GND -- VDD V CM03 CMRR Common Mode Input Rejection Ratio -- 50 -- dB Comments VICM = VDD/2 CM04 VHYST Comparator Hysteresis 15 25 35 mV CM05 TRESP(1) Response Time, Rising Edge -- 300 600 ns Response Time, Falling Edge -- 220 500 ns CMOS6 TMCV2VO(2) Mode Change to Valid Output -- -- 10 s * Note 1: 2: These parameters are characterized but not tested. Response time measured with one comparator input at VDD/2, while the other input transitions from VSS to VDD. A mode change includes changing any of the control register values, including module enable. TABLE 37-15: 5-BIT DAC SPECIFICATIONS Standard Operating Conditions (unless otherwise stated) VDD = 3.0V, TA = 25C Param. No. Sym. Characteristics Min. Typ. Max. Units -- (VDACREF+ -VDACREF-) /32 -- V LSb DSB01 VLSB Step Size DSB01 VACC Absolute Accuracy -- -- 0.5 DSB03* RUNIT Unit Resistor Value -- 5000 -- DSB04* TST Settling Time(1) -- -- 10 s * Note 1: Comments These parameters are characterized but not tested. Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. Settling time measured while DACR<4:0> transitions from `00000' to `01111'. TABLE 37-16: FIXED VOLTAGE REFERENCE (FVR) SPECIFICATIONS Standard Operating Conditions (unless otherwise stated) Param. No. Symbol Characteristic Min. Typ. Max. Units Conditions FVR01 VFVR1 1x Gain (1.024V) -4 -- +4 % VDD 2.5V, -40C to 85C FVR02 VFVR2 2x Gain (2.048V) -4 -- +4 % VDD 2.5V, -40C to 85C FVR03 VFVR4 4x Gain (4.096V) -5 -- +5 % VDD 4.75V, -40C to 85C FVR04 TFVRST FVR Start-up Time -- 25 -- us FVR05 FVRA1X/FVRC1X FVR output voltage for 1x setting stored in the DIA -- 1024 -- mV FVR06 FVRA2X/FVRC2X FVR output voltage for 2x setting stored in the DIA -- 2048 -- mV FVR07 FVRA4X/FVRC4X FVR output voltage for 4x setting stored in the DIA -- 4096 -- mV 2017 Microchip Technology Inc. Preliminary DS40001897A-page 476 PIC16(L)F15313/23 TABLE 37-17: ZERO CROSS DETECT (ZCD) SPECIFICATIONS Standard Operating Conditions (unless otherwise stated) VDD = 3.0V, TA = 25C Param. No. Sym. Characteristics Min. Typ Max. Units -- 0.75 -- V ZC01 VPINZC Voltage on Zero Cross Pin ZC02 IZCD_MAX Maximum source or sink current -- -- 600 A ZC03 TRESPH Response Time, Rising Edge -- 1 -- s TRESPL Response Time, Falling Edge -- 1 -- s Comments Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. FIGURE 37-12: TIMER0 AND TIMER1 EXTERNAL CLOCK TIMINGS T0CKI 40 41 42 T1CKI 45 46 47 49 TMR0 or TMR1 2017 Microchip Technology Inc. Preliminary DS40001897A-page 477 PIC16(L)F15313/23 TABLE 37-18: TIMER0 AND TIMER1 EXTERNAL CLOCK REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Operating Temperature -40C TA +125C Param. No. 40* Sym. TT0H Characteristic T0CKI High Pulse Width Min. No Prescaler TT0L T0CKI Low Pulse Width No Prescaler Max. Units 0.5 TCY + 20 -- -- ns 10 -- -- ns With Prescaler 41* Typ 0.5 TCY + 20 -- -- ns 10 -- -- ns Greater of: 20 or TCY + 40 N -- -- ns With Prescaler 42* TT0P T0CKI Period 45* TT1H T1CKI High Synchronous, No Prescaler Time Synchronous, with Prescaler 0.5 TCY + 20 -- -- ns 15 -- -- ns Asynchronous 30 -- -- ns Synchronous, No Prescaler 0.5 TCY + 20 -- -- ns Synchronous, with Prescaler 15 -- -- ns Asynchronous 30 -- -- ns Greater of: 30 or TCY + 40 N -- -- ns TT1L 46* T1CKI Low Time 47* TT1P T1CKI Input Synchronous Period 49* TCKEZTMR1 Delay from External Clock Edge to Timer Increment Asynchronous * 60 -- -- ns 2 TOSC -- 7 TOSC -- Conditions N = prescale value N = prescale value Timers in Sync mode These parameters are characterized but not tested. Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 478 PIC16(L)F15313/23 FIGURE 37-13: CAPTURE/COMPARE/PWM TIMINGS (CCP) CCPx (Capture mode) CC01 CC02 CC03 Note: Refer to Figure 37-4 for load conditions. TABLE 37-19: CAPTURE/COMPARE/PWM REQUIREMENTS (CCP) Standard Operating Conditions (unless otherwise stated) Operating Temperature -40C TA +125C Param. Sym. No. Characteristic CC01* TccL CCPx Input Low Time No Prescaler CC02* TccH CCPx Input High Time No Prescaler CC03* TccP CCPx Input Period With Prescaler With Prescaler * Min. Typ Max. Units 0.5TCY + 20 -- -- ns 20 -- -- ns 0.5TCY + 20 -- -- ns 20 -- -- ns 3TCY + 40 N -- -- ns Conditions N = prescale value These parameters are characterized but not tested. Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 479 PIC16(L)F15313/23 FIGURE 37-14: CLC PROPAGATION TIMING Rev. 10-000031A 6/16/2016 CLCxINn CLC Input time CLCxINn CLC Input time LCx_in[n](1) LCx_in[n](1) CLC01 Note 1: CLC Module LCx_out(1) CLC Output time CLCx CLC Module LCx_out(1) CLC Output time CLCx CLC02 CLC03 See Figure 31-1 to identify specific CLC signals. TABLE 37-20: CONFIGURABLE LOGIC CELL (CLC) CHARACTERISTICS Standard Operating Conditions (unless otherwise stated) Operating temperature -40C TA +125C Param. No. Sym. Characteristic Min. Typ Max. Units Conditions CLC01* TCLCIN CLC input time -- 7 IO5 ns (Note 1) CLC02* TCLC CLC module input to output propagation time -- -- 24 12 -- -- ns ns VDD = 1.8V VDD > 3.6V -- IO7 -- -- (Note 1) -- IO8 -- -- (Note 1) -- 32 FOSC MHz CLC03* TCLCOUT CLC output time Rise Time Fall Time CLC04* FCLCMAX CLC maximum switching frequency * These parameters are characterized but not tested. Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. Note 1: See Table 37-10 for IO5, IO7 and IO8 rise and fall times. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 480 PIC16(L)F15313/23 FIGURE 37-15: EUSART SYNCHRONOUS TRANSMISSION (MASTER/SLAVE) TIMING CK US121 US121 DT US122 US120 Refer to Figure 37-4 for load conditions. Note: TABLE 37-21: EUSART SYNCHRONOUS TRANSMISSION CHARACTERISTICS Standard Operating Conditions (unless otherwise stated) Param. No. US120 Symbol TCKH2DTV Characteristic Min. Max. Units Conditions 3.0V VDD 5.5V SYNC XMIT (Master and Slave) Clock high to data-out valid -- 80 ns -- 100 ns 1.8V VDD 5.5V 45 ns 3.0V VDD 5.5V US121 TCKRF Clock out rise time and fall time (Master mode) -- -- 50 ns 1.8V VDD 5.5V US122 TDTRF Data-out rise time and fall time -- 45 ns 3.0V VDD 5.5V -- 50 ns 1.8V VDD 5.5V FIGURE 37-16: EUSART SYNCHRONOUS RECEIVE (MASTER/SLAVE) TIMING CK US125 DT US126 Note: Refer to Figure 37-4 for load conditions. TABLE 37-22: EUSART SYNCHRONOUS RECEIVE REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Param. No. Symbol US125 TDTV2CKL US126 TCKL2DTL Characteristic Min. Max. Units SYNC RCV (Master and Slave) Data-setup before CK (DT hold time) 10 -- ns Data-hold after CK (DT hold time) 15 -- ns 2017 Microchip Technology Inc. Preliminary Conditions DS40001897A-page 481 PIC16(L)F15313/23 FIGURE 37-17: SPI MASTER MODE TIMING (CKE = 0, SMP = 0) SS SP81 SCK (CKP = 0) SP71 SP72 SP78 SP79 SP79 SP78 SCK (CKP = 1) SP80 bit 6 - - - - - -1 MSb SDO LSb SP75, SP76 SDI MSb In bit 6 - - - -1 LSb In SP74 SP73 Note: Refer to Figure 37-4 for load conditions. FIGURE 37-18: SPI MASTER MODE TIMING (CKE = 1, SMP = 1) SS SP81 SCK (CKP = 0) SP71 SP72 SP79 SP73 SCK (CKP = 1) SP80 MSb SDO SP78 bit 6 - - - - - -1 LSb SP75, SP76 SDI MSb In bit 6 - - - -1 LSb In SP74 SP73 Note: Refer to Figure 37-4 for load conditions. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 482 PIC16(L)F15313/23 FIGURE 37-19: SPI SLAVE MODE TIMING (CKE = 0) SS SP70 SCK (CKP = 0) SP83 SP71 SP72 SP78 SP79 SP79 SP78 SCK (CKP = 1) SP80 MSb SDO LSb bit 6 - - - - - -1 SP77 SP75, SP76 SDI MSb In bit 6 - - - -1 LSb In SP74 SP73 Note: Refer to Figure 37-4 for load conditions. FIGURE 37-20: SS SPI SLAVE MODE TIMING (CKE = 1) SP82 SP70 SP83 SCK (CKP = 0) SP71 SP72 SCK (CKP = 1) SP80 MSb SDO bit 6 - - - - - -1 LSb SP77 SP75, SP76 SDI MSb In bit 6 - - - -1 LSb In SP74 SP73 Note: Refer to Figure 37-4 for load conditions. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 483 PIC16(L)F15313/23 TABLE 37-23: SPI MODE REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Param. No. SP70* Symbol Characteristic TSSL2SCH, TSSL2SCL SS to SCK or SCK input Min. Typ Max. Units 2.25*TCY -- -- ns Conditions SP71* TSCH SCK input high time (Slave mode) TCY + 20 -- -- ns SP72* TSCL SCK input low time (Slave mode) TCY + 20 -- -- ns SP73* TDIV2SCH, TDIV2SCL Setup time of SDI data input to SCK edge 100 -- -- ns SP74* TSCH2DIL, TSCL2DIL Hold time of SDI data input to SCK edge 100 -- -- ns SP75* TDOR SDO data output rise time -- 10 25 ns 3.0V VDD 5.5V -- 25 50 ns 1.8V VDD 5.5V SDO data output fall time -- 10 25 ns SP76* TDOF SP77* TSSH2DOZ SS to SDO output high-impedance 10 -- 50 ns SP78* TSCR SCK output rise time (Master mode) -- 10 25 ns 3.0V VDD 5.5V -- 25 50 ns 1.8V VDD 5.5V 25 ns SP79* TSCF SCK output fall time (Master mode) -- 10 SP80* TSCH2DOV, TSCL2DOV SDO data output valid after SCK edge -- -- 50 ns 3.0V VDD 5.5V -- -- 145 ns 1.8V VDD 5.5V SP81* TDOV2SCH, TDOV2SCL SDO data output setup to SCK edge 1 Tcy -- -- ns SP82* TSSL2DOV SDO data output valid after SS edge -- -- 50 ns SP83* TSCH2SSH, TSCL2SSH SS after SCK edge 1.5 TCY + 40 -- -- ns * These parameters are characterized but not tested. Data in "Typ" column is at 3.0V, 25C unless otherwise stated. These parameters are for design guidance only and are not tested. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 484 PIC16(L)F15313/23 FIGURE 37-21: I2C BUS START/STOP BITS TIMING SCL SP93 SP91 SP90 SP92 SDA Stop Condition Start Condition Note: Refer to Figure 37-4 for load conditions. TABLE 37-24: I2C BUS START/STOP BITS REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Param. No. SP90* Symbol TSU:STA THD:STA SP91* TSU:STO SP92* THD:STO SP93 * Characteristic Min. Typ Max. Units Conditions ns Only relevant for Repeated Start condition ns After this period, the first clock pulse is generated Start condition 100 kHz mode 4700 -- -- Setup time 400 kHz mode 600 -- -- Start condition 100 kHz mode 4000 -- -- Hold time 400 kHz mode 600 -- -- Stop condition 100 kHz mode 4700 -- -- Setup time 400 kHz mode 600 -- -- Stop condition 100 kHz mode 4000 -- -- Hold time 400 kHz mode 600 -- -- ns ns These parameters are characterized but not tested. FIGURE 37-22: I2C BUS DATA TIMING SP103 SCL SP100 SP90 SP102 SP101 SP106 SP107 SP91 SDA In SP92 SP110 SP109 SP109 SDA Out Note: Refer to Figure 37-4 for load conditions. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 485 PIC16(L)F15313/23 TABLE 37-25: I2C BUS DATA REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Param. No. SP100* Symbol THIGH Characteristic Clock high time Min. Max. Units 100 kHz mode 4.0 -- s Device must operate at a minimum of 1.5 MHz 400 kHz mode 0.6 -- s Device must operate at a minimum of 10 MHz 1.5TCY -- 100 kHz mode 4.7 -- s Device must operate at a minimum of 1.5 MHz 400 kHz mode 1.3 -- s Device must operate at a minimum of 10 MHz SSP module SP101* TLOW Clock low time 1.5TCY -- 100 kHz mode -- 1000 ns 400 kHz mode 20 + 0.1CB 300 ns -- 250 ns 20 + 0.1CB 250 ns SSP module SP102* SP103* TR TF SDA and SCL rise time SDA and SCL fall time 100 kHz mode 400 kHz mode SP106* SP107* SP109* SP110* THD:DAT TSU:DAT TAA TBUF Data input hold time Data input setup time Output valid from clock Bus free time Bus capacitive loading Conditions 100 kHz mode 0 -- ns 400 kHz mode 0 0.9 s 100 kHz mode 250 -- ns 400 kHz mode 100 -- ns 100 kHz mode -- 3500 ns 400 kHz mode -- -- ns 100 kHz mode 4.7 -- s 400 kHz mode 1.3 -- s -- 400 pF CB is specified to be from 10-400 pF CB is specified to be from 10-400 pF (Note 2) (Note 1) Time the bus must be free before a new transmission can start SP111 CB * Note 1: These parameters are characterized but not tested. As a transmitter, the device must provide this internal minimum delay time to bridge the undefined region (min. 300 ns) of the falling edge of SCL to avoid unintended generation of Start or Stop conditions. A Fast mode (400 kHz) I2C bus device can be used in a Standard mode (100 kHz) I2C bus system, but the requirement TSU:DAT 250 ns must then be met. This will automatically be the case if the device does not stretch the low period of the SCL signal. If such a device does stretch the low period of the SCL signal, it must output the next data bit to the SDA line TR max. + TSU:DAT = 1000 + 250 = 1250 ns (according to the Standard mode I2C bus specification), before the SCL line is released. 2: 2017 Microchip Technology Inc. Preliminary DS40001897A-page 486 PIC16(L)F15313/23 38.0 DC AND AC CHARACTERISTICS GRAPHS AND CHARTS The graphs and tables provided in this section are for design guidance and are not tested. In some graphs or tables, the data presented are outside specified operating range (i.e., outside specified VDD range). This is for information only and devices are ensured to operate properly only within the specified range. Unless otherwise noted, all graphs apply to both the L and LF devices. Note: The graphs and tables provided following this note are a statistical summary based on a limited number of samples and are provided for informational purposes only. The performance characteristics listed herein are not tested or guaranteed. In some graphs or tables, the data presented may be outside the specified operating range (e.g., outside specified power supply range) and therefore, outside the warranted range. "Typical" represents the mean of the distribution at 25C. "Maximum", "Max.", "Minimum" or "Min." represents (mean + 3) or (mean - 3) respectively, where is a standard deviation, over each temperature range. Charts and graphs are not available at this time. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 487 PIC16(L)F15313/23 39.0 DEVELOPMENT SUPPORT 39.1 The PIC(R) microcontrollers (MCU) and dsPIC(R) digital signal controllers (DSC) are supported with a full range of software and hardware development tools: * Integrated Development Environment - MPLAB(R) X IDE Software - MPLAB(R) XPRESS IDE Software * Compilers/Assemblers/Linkers - MPLAB XC Compiler - MPASMTM Assembler - MPLINKTM Object Linker/ MPLIBTM Object Librarian - MPLAB Assembler/Linker/Librarian for Various Device Families * Simulators - MPLAB X SIM Software Simulator * Emulators - MPLAB REAL ICETM In-Circuit Emulator * In-Circuit Debuggers/Programmers - MPLAB ICD 3 - PICkitTM 3 * Device Programmers - MPLAB PM3 Device Programmer * Low-Cost Demonstration/Development Boards, Evaluation Kits and Starter Kits * Third-party development tools MPLAB X Integrated Development Environment Software The MPLAB X IDE is a single, unified graphical user interface for Microchip and third-party software, and hardware development tool that runs on Windows(R), Linux and Mac OS(R) X. Based on the NetBeans IDE, MPLAB X IDE is an entirely new IDE with a host of free software components and plug-ins for highperformance application development and debugging. Moving between tools and upgrading from software simulators to hardware debugging and programming tools is simple with the seamless user interface. With complete project management, visual call graphs, a configurable watch window and a feature-rich editor that includes code completion and context menus, MPLAB X IDE is flexible and friendly enough for new users. With the ability to support multiple tools on multiple projects with simultaneous debugging, MPLAB X IDE is also suitable for the needs of experienced users. Feature-Rich Editor: * Color syntax highlighting * Smart code completion makes suggestions and provides hints as you type * Automatic code formatting based on user-defined rules * Live parsing User-Friendly, Customizable Interface: * Fully customizable interface: toolbars, toolbar buttons, windows, window placement, etc. * Call graph window Project-Based Workspaces: * * * * Multiple projects Multiple tools Multiple configurations Simultaneous debugging sessions File History and Bug Tracking: * Local file history feature * Built-in support for Bugzilla issue tracker 2017 Microchip Technology Inc. Preliminary DS40001897A-page 488 PIC16(L)F15313/23 39.2 MPLAB XC Compilers 39.4 The MPLAB XC Compilers are complete ANSI C compilers for all of Microchip's 8, 16, and 32-bit MCU and DSC devices. These compilers provide powerful integration capabilities, superior code optimization and ease of use. MPLAB XC Compilers run on Windows, Linux or MAC OS X. For easy source level debugging, the compilers provide debug information that is optimized to the MPLAB X IDE. The free MPLAB XC Compiler editions support all devices and commands, with no time or memory restrictions, and offer sufficient code optimization for most applications. MPLAB XC Compilers include an assembler, linker and utilities. The assembler generates relocatable object files that can then be archived or linked with other relocatable object files and archives to create an executable file. MPLAB XC Compiler uses the assembler to produce its object file. Notable features of the assembler include: * * * * * * Support for the entire device instruction set Support for fixed-point and floating-point data Command-line interface Rich directive set Flexible macro language MPLAB X IDE compatibility 39.3 MPASM Assembler The MPASM Assembler is a full-featured, universal macro assembler for PIC10/12/16/18 MCUs. The MPASM Assembler generates relocatable object files for the MPLINK Object Linker, Intel(R) standard HEX files, MAP files to detail memory usage and symbol reference, absolute LST files that contain source lines and generated machine code, and COFF files for debugging. The MPASM Assembler features include: MPLINK Object Linker/ MPLIB Object Librarian The MPLINK Object Linker combines relocatable objects created by the MPASM Assembler. It can link relocatable objects from precompiled libraries, using directives from a linker script. The MPLIB Object Librarian manages the creation and modification of library files of precompiled code. When a routine from a library is called from a source file, only the modules that contain that routine will be linked in with the application. This allows large libraries to be used efficiently in many different applications. The object linker/library features include: * Efficient linking of single libraries instead of many smaller files * Enhanced code maintainability by grouping related modules together * Flexible creation of libraries with easy module listing, replacement, deletion and extraction 39.5 MPLAB Assembler, Linker and Librarian for Various Device Families MPLAB Assembler produces relocatable machine code from symbolic assembly language for PIC24, PIC32 and dsPIC DSC devices. MPLAB XC Compiler uses the assembler to produce its object file. The assembler generates relocatable object files that can then be archived or linked with other relocatable object files and archives to create an executable file. Notable features of the assembler include: * * * * * * Support for the entire device instruction set Support for fixed-point and floating-point data Command-line interface Rich directive set Flexible macro language MPLAB X IDE compatibility * Integration into MPLAB X IDE projects * User-defined macros to streamline assembly code * Conditional assembly for multipurpose source files * Directives that allow complete control over the assembly process 2017 Microchip Technology Inc. Preliminary DS40001897A-page 489 PIC16(L)F15313/23 39.6 MPLAB X SIM Software Simulator The MPLAB X SIM Software Simulator allows code development in a PC-hosted environment by simulating the PIC MCUs and dsPIC DSCs on an instruction level. On any given instruction, the data areas can be examined or modified and stimuli can be applied from a comprehensive stimulus controller. Registers can be logged to files for further run-time analysis. The trace buffer and logic analyzer display extend the power of the simulator to record and track program execution, actions on I/O, most peripherals and internal registers. The MPLAB X SIM Software Simulator fully supports symbolic debugging using the MPLAB XC Compilers, and the MPASM and MPLAB Assemblers. The software simulator offers the flexibility to develop and debug code outside of the hardware laboratory environment, making it an excellent, economical software development tool. 39.7 MPLAB REAL ICE In-Circuit Emulator System The MPLAB REAL ICE In-Circuit Emulator System is Microchip's next generation high-speed emulator for Microchip Flash DSC and MCU devices. It debugs and programs all 8, 16 and 32-bit MCU, and DSC devices with the easy-to-use, powerful graphical user interface of the MPLAB X IDE. The emulator is connected to the design engineer's PC using a high-speed USB 2.0 interface and is connected to the target with either a connector compatible with in-circuit debugger systems (RJ-11) or with the new high-speed, noise tolerant, LowVoltage Differential Signal (LVDS) interconnection (CAT5). The emulator is field upgradeable through future firmware downloads in MPLAB X IDE. MPLAB REAL ICE offers significant advantages over competitive emulators including full-speed emulation, run-time variable watches, trace analysis, complex breakpoints, logic probes, a ruggedized probe interface and long (up to three meters) interconnection cables. 2017 Microchip Technology Inc. 39.8 MPLAB ICD 3 In-Circuit Debugger System The MPLAB ICD 3 In-Circuit Debugger System is Microchip's most cost-effective, high-speed hardware debugger/programmer for Microchip Flash DSC and MCU devices. It debugs and programs PIC Flash microcontrollers and dsPIC DSCs with the powerful, yet easy-to-use graphical user interface of the MPLAB IDE. The MPLAB ICD 3 In-Circuit Debugger probe is connected to the design engineer's PC using a highspeed USB 2.0 interface and is connected to the target with a connector compatible with the MPLAB ICD 2 or MPLAB REAL ICE systems (RJ-11). MPLAB ICD 3 supports all MPLAB ICD 2 headers. 39.9 PICkit 3 In-Circuit Debugger/ Programmer The MPLAB PICkit 3 allows debugging and programming of PIC and dsPIC Flash microcontrollers at a most affordable price point using the powerful graphical user interface of the MPLAB IDE. The MPLAB PICkit 3 is connected to the design engineer's PC using a fullspeed USB interface and can be connected to the target via a Microchip debug (RJ-11) connector (compatible with MPLAB ICD 3 and MPLAB REAL ICE). The connector uses two device I/O pins and the Reset line to implement in-circuit debugging and In-Circuit Serial ProgrammingTM (ICSPTM). 39.10 MPLAB PM3 Device Programmer The MPLAB PM3 Device Programmer is a universal, CE compliant device programmer with programmable voltage verification at VDDMIN and VDDMAX for maximum reliability. It features a large LCD display (128 x 64) for menus and error messages, and a modular, detachable socket assembly to support various package types. The ICSP cable assembly is included as a standard item. In Stand-Alone mode, the MPLAB PM3 Device Programmer can read, verify and program PIC devices without a PC connection. It can also set code protection in this mode. The MPLAB PM3 connects to the host PC via an RS-232 or USB cable. The MPLAB PM3 has high-speed communications and optimized algorithms for quick programming of large memory devices, and incorporates an MMC card for file storage and data applications. Preliminary DS40001897A-page 490 PIC16(L)F15313/23 39.11 Demonstration/Development Boards, Evaluation Kits, and Starter Kits 39.12 Third-Party Development Tools A wide variety of demonstration, development and evaluation boards for various PIC MCUs and dsPIC DSCs allows quick application development on fully functional systems. Most boards include prototyping areas for adding custom circuitry and provide application firmware and source code for examination and modification. The boards support a variety of features, including LEDs, temperature sensors, switches, speakers, RS-232 interfaces, LCD displays, potentiometers and additional EEPROM memory. Microchip also offers a great collection of tools from third-party vendors. These tools are carefully selected to offer good value and unique functionality. * Device Programmers and Gang Programmers from companies, such as SoftLog and CCS * Software Tools from companies, such as Gimpel and Trace Systems * Protocol Analyzers from companies, such as Saleae and Total Phase * Demonstration Boards from companies, such as MikroElektronika, Digilent(R) and Olimex * Embedded Ethernet Solutions from companies, such as EZ Web Lynx, WIZnet and IPLogika(R) The demonstration and development boards can be used in teaching environments, for prototyping custom circuits and for learning about various microcontroller applications. In addition to the PICDEMTM and dsPICDEMTM demonstration/development board series of circuits, Microchip has a line of evaluation kits and demonstration software for analog filter design, KEELOQ(R) security ICs, CAN, IrDA(R), PowerSmart battery management, SEEVAL(R) evaluation system, Sigma-Delta ADC, flow rate sensing, plus many more. Also available are starter kits that contain everything needed to experience the specified device. This usually includes a single application and debug capability, all on one board. Check the Microchip web page (www.microchip.com) for the complete list of demonstration, development and evaluation kits. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 491 PIC16(L)F15313/23 40.0 PACKAGING INFORMATION 40.1 Package Marking Information 8-Lead PDIP (300 mil) Example XXXXXXXX XXXXXNNN 16F15313 P e3 017 YYWW 1525 8-Lead SOIC (3.90 mm) Example 16F15313 PIC16F18313 -I/SO e3 SN e3 1525 NNN 1304017 017 8-Lead UDFN (3x3x0.9 mm) Example MGJ0 1525 017 XXXX YYWW NNN PIN 1 Legend: XX...X Y YY WW NNN * Note: PIN 1 Customer-specific information Year code (last digit of calendar year) Year code (last 2 digits of calendar year) Week code (week of January 1 is week `01') Alphanumeric traceability code Pb-free JEDEC(R) designator for Matte Tin (Sn) This package is Pb-free. The Pb-free JEDEC designator ( e3 ) can be found on the outer packaging for this package. In the event the full Microchip part number cannot be marked on one line, it will be carried over to the next line, thus limiting the number of available characters for customer-specific information. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 492 PIC16(L)F15313/23 40.1 Package Marking Information 14-Lead PDIP (300 mil) Example PIC16F15323 /SO e3 1525017 14-Lead TSSOP (4.4 mm) Example XXXXXXXX YYWW NNN 16F15323 1525 e3 017 14-Lead SOIC (3.90 mm) Example PIC16F15323 /SO e3 1525017 Legend: XX...X Y YY WW NNN * Note: Customer-specific information Year code (last digit of calendar year) Year code (last 2 digits of calendar year) Week code (week of January 1 is week `01') Alphanumeric traceability code Pb-free JEDEC(R) designator for Matte Tin (Sn) This package is Pb-free. The Pb-free JEDEC designator ( e3 ) can be found on the outer packaging for this package. In the event the full Microchip part number cannot be marked on one line, it will be carried over to the next line, thus limiting the number of available characters for customer-specific information. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 493 PIC16(L)F15313/23 40.1 Package Marking Information (Continued) 16-Lead UQFN (4x4x0.5 mm) PIN 1 Example PIN 1 PIC16 F15323 /MV 525017 e3 Legend: XX...X Y YY WW NNN * Note: TABLE 40-1: Customer-specific information Year code (last digit of calendar year) Year code (last 2 digits of calendar year) Week code (week of January 1 is week `01') Alphanumeric traceability code Pb-free JEDEC(R) designator for Matte Tin (Sn) This package is Pb-free. The Pb-free JEDEC designator ( e3 ) can be found on the outer packaging for this package. In the event the full Microchip part number cannot be marked on one line, it will be carried over to the next line, thus limiting the number of available characters for customer-specific information. 8-LEAD 3x3 UDFN TOP MARKING Part Number Marking PIC16F15313 MGJ0 PIC16LF15313 MGK0 2017 Microchip Technology Inc. Preliminary DS40001897A-page 494 PIC16(L)F15313/23 The following sections give the technical details of the packages. 8-Lead Plastic Dual In-Line (P) - 300 mil Body [PDIP] Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging D A N B E1 NOTE 1 1 2 TOP VIEW E C A2 A PLANE L c A1 e eB 8X b1 8X b .010 C SIDE VIEW END VIEW Microchip Technology Drawing No. C04-018D Sheet 1 of 2 2017 Microchip Technology Inc. Preliminary DS40001897A-page 495 PIC16(L)F15313/23 8-Lead Plastic Dual In-Line (P) - 300 mil Body [PDIP] Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging ALTERNATE LEAD DESIGN (VENDOR DEPENDENT) DATUM A DATUM A b b e 2 e 2 e e Units Dimension Limits Number of Pins N e Pitch Top to Seating Plane A Molded Package Thickness A2 Base to Seating Plane A1 Shoulder to Shoulder Width E Molded Package Width E1 Overall Length D Tip to Seating Plane L c Lead Thickness Upper Lead Width b1 b Lower Lead Width Overall Row Spacing eB MIN .115 .015 .290 .240 .348 .115 .008 .040 .014 - INCHES NOM 8 .100 BSC .130 .310 .250 .365 .130 .010 .060 .018 - MAX .210 .195 .325 .280 .400 .150 .015 .070 .022 .430 Notes: 1. Pin 1 visual index feature may vary, but must be located within the hatched area. 2. Significant Characteristic 3. Dimensions D and E1 do not include mold flash or protrusions. Mold flash or protrusions shall not exceed .010" per side. 4. Dimensioning and tolerancing per ASME Y14.5M BSC: Basic Dimension. Theoretically exact value shown without tolerances. Microchip Technology Drawing No. C04-018D Sheet 2 of 2 2017 Microchip Technology Inc. Preliminary DS40001897A-page 496 PIC16(L)F15313/23 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2017 Microchip Technology Inc. Preliminary DS40001897A-page 497 PIC16(L)F15313/23 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2017 Microchip Technology Inc. Preliminary DS40001897A-page 498 PIC16(L)F15313/23 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2017 Microchip Technology Inc. Preliminary DS40001897A-page 499 PIC16(L)F15313/23 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2017 Microchip Technology Inc. Preliminary DS40001897A-page 500 PIC16(L)F15313/23 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2017 Microchip Technology Inc. Preliminary DS40001897A-page 501 PIC16(L)F15313/23 ' !"#$%& ! " #! $ ! %& '#* ##! !! 7;;'''" "; % 2017 Microchip Technology Inc. Preliminary + % 6 ! !&! DS40001897A-page 502 PIC16(L)F15313/23 *+ ' , $ !"# ,$ & ! " #! $ ! %& '#* ##! !! 7;;'''" "; % + % 6 ! !&! N NOTE 1 E1 1 3 2 D E A2 A L A1 c b1 b e eB ^!# "# j"!# _$"H 6+# _ +! _KX _ | ? ! !+ _{ ?]K } } ? &&+ % %## ??\ ?V ?\ ]#! !+ ? ?\ } } X V? V\ $& ! $& ~&! &&+ %~&! X? \ {@ j! V\ \ \ ! !+ j ?\ ??\ ?V ? ?\ H? \ H ? ? ] } } j& %## ^ j&~&! j ' j&~&! {@ ' J V ' ? +?@#$&G6!$ "@ *H$!"$#!H !&'! ! ! & J6 !K ! #! V "# #&X?& ! $&" &6# ! $# # &6# ! $# ## !G &?Y #& "# &! X[?\ ]K7]# "# ! G !@$# ''! $!! # 2017 Microchip Technology Inc. Preliminary ' K\] DS40001897A-page 503 PIC16(L)F15313/23 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2017 Microchip Technology Inc. Preliminary DS40001897A-page 504 PIC16(L)F15313/23 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2017 Microchip Technology Inc. Preliminary DS40001897A-page 505 PIC16(L)F15313/23 ' ! " #! $ ! %& '#* ##! !! 7;;'''" "; % 2017 Microchip Technology Inc. Preliminary + % 6 ! !&! DS40001897A-page 506 PIC16(L)F15313/23 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2017 Microchip Technology Inc. Preliminary DS40001897A-page 507 PIC16(L)F15313/23 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2017 Microchip Technology Inc. Preliminary DS40001897A-page 508 PIC16(L)F15313/23 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2017 Microchip Technology Inc. Preliminary DS40001897A-page 509 PIC16(L)F15313/23 16-Lead Ultra Thin Plastic Quad Flat, No Lead Package (JQ) - 4x4x0.5 mm Body [UQFN] Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging D A B N NOTE 1 1 2 E (DATUM B) (DATUM A) 2X 0.20 C 2X TOP VIEW 0.20 C SEATING PLANE A1 0.10 C C A 16X (A3) 0.08 C SIDE VIEW 0.10 C A B D2 0.10 C A B E2 2 e 2 1 NOTE 1 K N 16X b 0.10 L e C A B BOTTOM VIEW Microchip Technology Drawing C04-257A Sheet 1 of 2 2017 Microchip Technology Inc. Preliminary DS40001897A-page 510 PIC16(L)F15313/23 16-Lead Ultra Thin Plastic Quad Flat, No Lead Package (JQ) - 4x4x0.5 mm Body [UQFN] Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging Units Dimension Limits Number of Pins N e Pitch Overall Height A Standoff A1 A3 Terminal Thickness Overall Width E E2 Exposed Pad Width Overall Length D D2 Exposed Pad Length Terminal Width b Terminal Length L K Terminal-to-Exposed-Pad MIN 0.45 0.00 2.50 2.50 0.25 0.30 0.20 MILLIMETERS NOM 16 0.65 BSC 0.50 0.02 0.127 REF 4.00 BSC 2.60 4.00 BSC 2.60 0.30 0.40 - MAX 0.55 0.05 2.70 2.70 0.35 0.50 - Notes: 1. Pin 1 visual index feature may vary, but must be located within the hatched area. 2. Package is saw singulated 3. Dimensioning and tolerancing per ASME Y14.5M BSC: Basic Dimension. Theoretically exact value shown without tolerances. REF: Reference Dimension, usually without tolerance, for information purposes only. Microchip Technology Drawing C04-257A Sheet 2 of 2 2017 Microchip Technology Inc. Preliminary DS40001897A-page 511 PIC16(L)F15313/23 16-Lead Ultra Thin Plastic Quad Flat, No Lead Package (JQ) - 4x4x0.5 mm Body [UQFN] Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging C1 X2 16 1 2 C2 Y2 Y1 X1 E SILK SCREEN RECOMMENDED LAND PATTERN Units Dimension Limits E Contact Pitch Optional Center Pad Width X2 Optional Center Pad Length Y2 Contact Pad Spacing C1 Contact Pad Spacing C2 Contact Pad Width (X16) X1 Contact Pad Length (X16) Y1 MIN MILLIMETERS NOM 0.65 BSC MAX 2.70 2.70 4.00 4.00 0.35 0.80 Notes: 1. Dimensioning and tolerancing per ASME Y14.5M BSC: Basic Dimension. Theoretically exact value shown without tolerances. Microchip Technology Drawing C04-2257A 2017 Microchip Technology Inc. Preliminary DS40001897A-page 512 PIC16(L)F15313/23 APPENDIX A: DATA SHEET REVISION HISTORY Revision A (4/2017) Initial release of the document. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 513 PIC16(L)F15313/23 THE MICROCHIP WEBSITE CUSTOMER SUPPORT Microchip provides online support via our website at www.microchip.com. This website is used as a means to make files and information easily available to customers. Accessible by using your favorite Internet browser, the website contains the following information: Users of Microchip products can receive assistance through several channels: * Product Support - Data sheets and errata, application notes and sample programs, design resources, user's guides and hardware support documents, latest software releases and archived software * General Technical Support - Frequently Asked Questions (FAQ), technical support requests, online discussion groups, Microchip consultant program member listing * Business of Microchip - Product selector and ordering guides, latest Microchip press releases, listing of seminars and events, listings of Microchip sales offices, distributors and factory representatives * * * * Distributor or Representative Local Sales Office Field Application Engineer (FAE) Technical Support Customers should contact their distributor, representative or Field Application Engineer (FAE) for support. Local sales offices are also available to help customers. A listing of sales offices and locations is included in the back of this document. Technical support is available through the website at: http://www.microchip.com/support CUSTOMER CHANGE NOTIFICATION SERVICE Microchip's customer notification service helps keep customers current on Microchip products. Subscribers will receive e-mail notification whenever there are changes, updates, revisions or errata related to a specified product family or development tool of interest. To register, access the Microchip website at www.microchip.com. Under "Support", click on "Customer Change Notification" and follow the registration instructions. 2017 Microchip Technology Inc. Preliminary DS40001897A-page 514 PIC16(L)F15313/23 PRODUCT IDENTIFICATION SYSTEM To order or obtain information, e.g., on pricing or delivery, refer to the factory or the listed sales office. [X](1) PART NO. Device - X Tape and Reel Temperature Option Range /XX XXX Package Pattern Device: PIC16F15313, PIC16LF15313 PIC16F15323, PIC16LF15323 Tape and Reel Option: Blank T = Standard packaging (tube or tray) = Tape and Reel(1) Temperature Range: I E = -40C to +85C = -40C to +125C Package:(2) JQ MF P SL SN ST = = = = = = Pattern: a) PIC16F15323- E/P Extended temperature PDIP package (Industrial) (Extended) 16-lead UQFN 4x4x0.5mm 8-lead DFN 3x3mm 8-lead 14-lead PDIP 14-lead SOIC 8-lead SOIC 14-lead TSSOP Note QTP, SQTP, Code or Special Requirements (blank otherwise) 2017 Microchip Technology Inc. Examples: Preliminary 1: 2: Tape and Reel identifier only appears in the catalog part number description. This identifier is used for ordering purposes and is not printed on the device package. Check with your Microchip Sales Office for package availability with the Tape and Reel option. Small form-factor packaging options may be available. Check www.microchip.com/packaging for small-form factor package availability, or contact your local Sales Office. DS40001897A-page 515 PIC16(L)F15313/23 Note the following details of the code protection feature on Microchip devices: * Microchip products meet the specification contained in their particular Microchip Data Sheet. * Microchip believes that its family of products is one of the most secure families of its kind on the market today, when used in the intended manner and under normal conditions. * There are dishonest and possibly illegal methods used to breach the code protection feature. All of these methods, to our knowledge, require using the Microchip products in a manner outside the operating specifications contained in Microchip's Data Sheets. Most likely, the person doing so is engaged in theft of intellectual property. * Microchip is willing to work with the customer who is concerned about the integrity of their code. * Neither Microchip nor any other semiconductor manufacturer can guarantee the security of their code. Code protection does not mean that we are guaranteeing the product as "unbreakable." Code protection is constantly evolving. We at Microchip are committed to continuously improving the code protection features of our products. Attempts to break Microchip's code protection feature may be a violation of the Digital Millennium Copyright Act. If such acts allow unauthorized access to your software or other copyrighted work, you may have a right to sue for relief under that Act. Information contained in this publication regarding device applications and the like is provided only for your convenience and may be superseded by updates. It is your responsibility to ensure that your application meets with your specifications. MICROCHIP MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION, INCLUDING BUT NOT LIMITED TO ITS CONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY OR FITNESS FOR PURPOSE. Microchip disclaims all liability arising from this information and its use. Use of Microchip devices in life support and/or safety applications is entirely at the buyer's risk, and the buyer agrees to defend, indemnify and hold harmless Microchip from any and all damages, claims, suits, or expenses resulting from such use. No licenses are conveyed, implicitly or otherwise, under any Microchip intellectual property rights unless otherwise stated. Microchip received ISO/TS-16949:2009 certification for its worldwide headquarters, design and wafer fabrication facilities in Chandler and Tempe, Arizona; Gresham, Oregon and design centers in California and India. The Company's quality system processes and procedures are for its PIC(R) MCUs and dsPIC(R) DSCs, KEELOQ(R) code hopping devices, Serial EEPROMs, microperipherals, nonvolatile memory and analog products. In addition, Microchip's quality system for the design and manufacture of development systems is ISO 9001:2000 certified. QUALITY MANAGEMENT SYSTEM CERTIFIED BY DNV Trademarks The Microchip name and logo, the Microchip logo, AnyRate, AVR, AVR logo, AVR Freaks, BeaconThings, BitCloud, chipKIT, chipKIT logo, CryptoMemory, CryptoRF, dsPIC, FlashFlex, flexPWR, Heldo, JukeBlox, KEELOQ, KEELOQ logo, Kleer, LANCheck, LINK MD, maXStylus, maXTouch, MediaLB, megaAVR, MOST, MOST logo, MPLAB, OptoLyzer, PIC, picoPower, PICSTART, PIC32 logo, Prochip Designer, QTouch, RightTouch, SAM-BA, SpyNIC, SST, SST Logo, SuperFlash, tinyAVR, UNI/O, and XMEGA are registered trademarks of Microchip Technology Incorporated in the U.S.A. and other countries. ClockWorks, The Embedded Control Solutions Company, EtherSynch, Hyper Speed Control, HyperLight Load, IntelliMOS, mTouch, Precision Edge, and Quiet-Wire are registered trademarks of Microchip Technology Incorporated in the U.S.A. Adjacent Key Suppression, AKS, Analog-for-the-Digital Age, Any Capacitor, AnyIn, AnyOut, BodyCom, CodeGuard, CryptoAuthentication, CryptoCompanion, CryptoController, dsPICDEM, dsPICDEM.net, Dynamic Average Matching, DAM, ECAN, EtherGREEN, In-Circuit Serial Programming, ICSP, InterChip Connectivity, JitterBlocker, KleerNet, KleerNet logo, Mindi, MiWi, motorBench, MPASM, MPF, MPLAB Certified logo, MPLIB, MPLINK, MultiTRAK, NetDetach, Omniscient Code Generation, PICDEM, PICDEM.net, PICkit, PICtail, PureSilicon, QMatrix, RightTouch logo, REAL ICE, Ripple Blocker, SAM-ICE, Serial Quad I/O, SMART-I.S., SQI, SuperSwitcher, SuperSwitcher II, Total Endurance, TSHARC, USBCheck, VariSense, ViewSpan, WiperLock, Wireless DNA, and ZENA are trademarks of Microchip Technology Incorporated in the U.S.A. and other countries. SQTP is a service mark of Microchip Technology Incorporated in the U.S.A. Silicon Storage Technology is a registered trademark of Microchip Technology Inc. in other countries. GestIC is a registered trademark of Microchip Technology Germany II GmbH & Co. KG, a subsidiary of Microchip Technology Inc., in other countries. All other trademarks mentioned herein are property of their respective companies. (c) 2017, Microchip Technology Incorporated, All Rights Reserved. ISBN: 978-1-5224-1620-3 == ISO/TS 16949 == 2017 Microchip Technology Inc. Preliminary DS40001897A-page 516 Worldwide Sales and Service AMERICAS ASIA/PACIFIC ASIA/PACIFIC EUROPE Corporate Office 2355 West Chandler Blvd. Chandler, AZ 85224-6199 Tel: 480-792-7200 Fax: 480-792-7277 Technical Support: http://www.microchip.com/ support Web Address: www.microchip.com Asia Pacific Office Suites 3707-14, 37th Floor Tower 6, The Gateway Harbour City, Kowloon China - Xiamen Tel: 86-592-2388138 Fax: 86-592-2388130 Austria - Wels Tel: 43-7242-2244-39 Fax: 43-7242-2244-393 China - Zhuhai Tel: 86-756-3210040 Fax: 86-756-3210049 Denmark - Copenhagen Tel: 45-4450-2828 Fax: 45-4485-2829 India - Bangalore Tel: 91-80-3090-4444 Fax: 91-80-3090-4123 Finland - Espoo Tel: 358-9-4520-820 Atlanta Duluth, GA Tel: 678-957-9614 Fax: 678-957-1455 Hong Kong Tel: 852-2943-5100 Fax: 852-2401-3431 Australia - Sydney Tel: 61-2-9868-6733 Fax: 61-2-9868-6755 China - Beijing Tel: 86-10-8569-7000 Fax: 86-10-8528-2104 Austin, TX Tel: 512-257-3370 China - Chengdu Tel: 86-28-8665-5511 Fax: 86-28-8665-7889 Boston Westborough, MA Tel: 774-760-0087 Fax: 774-760-0088 China - Chongqing Tel: 86-23-8980-9588 Fax: 86-23-8980-9500 Chicago Itasca, IL Tel: 630-285-0071 Fax: 630-285-0075 Dallas Addison, TX Tel: 972-818-7423 Fax: 972-818-2924 Detroit Novi, MI Tel: 248-848-4000 Houston, TX Tel: 281-894-5983 Indianapolis Noblesville, IN Tel: 317-773-8323 Fax: 317-773-5453 Tel: 317-536-2380 Los Angeles Mission Viejo, CA Tel: 949-462-9523 Fax: 949-462-9608 Tel: 951-273-7800 Raleigh, NC Tel: 919-844-7510 New York, NY Tel: 631-435-6000 San Jose, CA Tel: 408-735-9110 Tel: 408-436-4270 Canada - Toronto Tel: 905-695-1980 Fax: 905-695-2078 India - New Delhi Tel: 91-11-4160-8631 Fax: 91-11-4160-8632 India - Pune Tel: 91-20-3019-1500 Japan - Osaka Tel: 81-6-6152-7160 Fax: 81-6-6152-9310 Japan - Tokyo Tel: 81-3-6880- 3770 Fax: 81-3-6880-3771 China - Dongguan Tel: 86-769-8702-9880 Korea - Daegu Tel: 82-53-744-4301 Fax: 82-53-744-4302 China - Guangzhou Tel: 86-20-8755-8029 China - Hangzhou Tel: 86-571-8792-8115 Fax: 86-571-8792-8116 China - Hong Kong SAR Tel: 852-2943-5100 Fax: 852-2401-3431 China - Nanjing Tel: 86-25-8473-2460 Fax: 86-25-8473-2470 China - Qingdao Tel: 86-532-8502-7355 Fax: 86-532-8502-7205 China - Shanghai Tel: 86-21-3326-8000 Fax: 86-21-3326-8021 Korea - Seoul Tel: 82-2-554-7200 Fax: 82-2-558-5932 or 82-2-558-5934 Malaysia - Kuala Lumpur Tel: 60-3-6201-9857 Fax: 60-3-6201-9859 Malaysia - Penang Tel: 60-4-227-8870 Fax: 60-4-227-4068 Philippines - Manila Tel: 63-2-634-9065 Fax: 63-2-634-9069 Singapore Tel: 65-6334-8870 Fax: 65-6334-8850 China - Shenyang Tel: 86-24-2334-2829 Fax: 86-24-2334-2393 China - Shenzhen Tel: 86-755-8864-2200 Fax: 86-755-8203-1760 Taiwan - Hsin Chu Tel: 886-3-5778-366 Fax: 886-3-5770-955 Taiwan - Kaohsiung Tel: 886-7-213-7830 China - Wuhan Tel: 86-27-5980-5300 Fax: 86-27-5980-5118 Taiwan - Taipei Tel: 886-2-2508-8600 Fax: 886-2-2508-0102 China - Xian Tel: 86-29-8833-7252 Fax: 86-29-8833-7256 Thailand - Bangkok Tel: 66-2-694-1351 Fax: 66-2-694-1350 2017 Microchip Technology Inc. France - Paris Tel: 33-1-69-53-63-20 Fax: 33-1-69-30-90-79 France - Saint Cloud Tel: 33-1-30-60-70-00 Germany - Garching Tel: 49-8931-9700 Germany - Haan Tel: 49-2129-3766400 Germany - Heilbronn Tel: 49-7131-67-3636 Germany - Karlsruhe Tel: 49-721-625370 Germany - Munich Tel: 49-89-627-144-0 Fax: 49-89-627-144-44 Germany - Rosenheim Tel: 49-8031-354-560 Israel - Ra'anana Tel: 972-9-744-7705 Italy - Milan Tel: 39-0331-742611 Fax: 39-0331-466781 Italy - Padova Tel: 39-049-7625286 Netherlands - Drunen Tel: 31-416-690399 Fax: 31-416-690340 Norway - Trondheim Tel: 47-7289-7561 Poland - Warsaw Tel: 48-22-3325737 Romania - Bucharest Tel: 40-21-407-87-50 Spain - Madrid Tel: 34-91-708-08-90 Fax: 34-91-708-08-91 Sweden - Gothenberg Tel: 46-31-704-60-40 Sweden - Stockholm Tel: 46-8-5090-4654 UK - Wokingham Tel: 44-118-921-5800 Fax: 44-118-921-5820 Preliminary DS40001897A-page 517 11/07/16