PIC16LF1554/1559 20-Pin Flash, 8-Bit Microcontrollers with XLP Technology Description: The PIC16LF1554/1559 microcontrollers with Microchip enhanced mid-range core deliver unique on-chip features for the design of mTouch(R) solutions and general purpose applications in 14/20-pin count packages. Up to 17 analog channels connecting to two 10-bit ADCs with automated hardware CVD modules, two PWMs and multiple communication peripherals offer an excellent solution to implement capacitive sensing and other front-end sampling applications with minimal software overhead. High-Performance RISC CPU: Peripheral Features: * Only 49 Instructions to Learn * Operating Speed: - DC - 32 MHz clock input - DC - 125 ns instruction cycle * Interrupt Capability with Automatic Context Saving * 16-Level Deep Hardware Stack with Optional Overflow/Underflow Reset * Direct, Indirect and Relative Addressing modes: - Two full 16-bit File Select Registers (FSRs) - FSRs can read program and data memory * Up to 17 I/O Pins and One Input-only Pin: - High current sink/source for LED drivers - Individually programmable interrupt-onchange pins - Individually programmable weak pull-ups * Timer0: 8-Bit Timer/Counter with 8-Bit Programmable Prescaler * Enhanced Timer1: - 16-bit timer/counter with prescaler - External Gate Input mode * Timer2 modules: 8-Bit Timer/Counter with 8-Bit Period Register, Prescaler and Postscaler * Two PWM modules * Two Analog-to-Digital Converters (ADC): - 10-bit resolution - Up to 17 channels - Simultaneous sampling on two ADCs - Connect multiple channels together for sampling - External conversion trigger - Flexible analog channel selection - Conversion during Sleep - Fixed Voltage Reference as channel - External pin as ADC positive reference - Temp sensor channel input * Voltage Reference module: - Fixed Voltage Reference (FVR) with 1.024V and 2.048V output levels * Hardware Capacitive Voltage Divider (CVD): - Double-sample conversions - Two sets of result registers - Inverted acquisition - 7-bit pre-charge timer - 7-bit acquisition timer - Two guard ring output drives - 30 pF adjustable sample and hold capacitor array * Master Synchronous Serial Port (MSSP) with SPI and I2CTM with: - 7-bit address masking - SMBus/PMBusTM compatibility Special Microcontroller Features: * Precision 16 MHz Internal Oscillator: - Factory calibrated to 1%, typical - Software selectable frequency range from 32 MHz to 31 kHz * 31 kHz Low-Power Internal Oscillator * 4x Phase-Locked Loop (PLL) * Power-Saving Sleep mode * Power-on Reset (POR) * Power-up Timer (PWRT) * BOR with Selectable Trip Point * Low-Power Brown-Out Reset (LPBOR) * Extended Watchdog Timer (WDT) * In-Circuit Serial ProgrammingTM (ICSPTM) via Two Pins * In-Circuit Debug (ICD) via Two Pins * Enhanced Low-Voltage Programming (LVP) * Operating Voltage Range: - 1.8V to 3.6V * Programmable Code Protection * Self-Programmable under Software Control Low-Power Features: * Standby Current: - 30 nA @ 1.8V, typical * Operating Current: - 75 A @ 1 MHz, 1.8V, typical * Low-Power Watchdog Timer Current: - 500 nA @ 1.8V, typical 2014 Microchip Technology Inc. DS40001761A-page 1 PIC16LF1554/1559 * Enhanced Universal Synchronous Asynchronous Receiver Transmitter (EUSART): - RS-232, RS-485 and LIN compatible - Auto-Baud Detect - Auto-wake-up on start Debug(3) Cap Touch Channels PWM MSSP EUSART Timers 8/16-Bit 10-bit ADC (ch)(2) I/Os(1) SRAM (bytes) Data EEPROM (bytes) Device Program Memory Flash (words) Data Sheet Index PIC16LF1554/1559 Family Types PIC16LF1554 (A) 4096 0 256 12 11 2/1 1 1 2 11 I PIC16LF1559 (A) 8192 0 512 18 17 2/1 1 1 2 17 I Note 1: 2: 3: RA3 is input only. 11/17 analog channels are connected to two ADC modules. Debugging Methods: (I) - Integrated on Chip; (H) - available using Debug Header Data Sheet Index: (Unshaded devices are described in this document) A. Note: DS40001761 PIC16LF1554/1559 Data Sheet, 14/20-Pin, 8-Bit Flash Microcontrollers. For other small form-factor package availability and marking information, please visit http://www.microchip.com/packaging or contact your local sales office. DS40001761A-page 2 2014 Microchip Technology Inc. PIC16LF1554/1559 Pin Diagrams FIGURE 1: 14-PIN PDIP, SOIC, TSSOP VDD PIC16LF1554 1 RA5 2 RA4 3 MCLR/VPP/RA3 4 RC5 5 RC4 6 14 VSS 13 RA0 12 RA1 11 RA2 10 RC0 9 RC1 8 RC2 RC3 7 Note: See Table 1 for location of all peripheral functions. VSS NC NC 16-PIN QFN VDD FIGURE 2: 16 15 14 13 RA5 1 12 RA0 RA4 2 PIC16LF1554 11 RA1 5 6 7 8 RC1 9 RC0 RC2 RC5 4 RC3 10 RA2 RC4 MCLR/VPP/RA3 3 Note: See Table 1 for location of all peripheral functions. 20-PIN PDIP, SSOP VDD 1 RA5 2 20 VSS 19 RA0 RA4 3 18 RA1 MCLR/VPP/RA3 4 17 RA2 RC5 5 RC4 6 RC3 7 RC6 8 PIC16LF1559 FIGURE 3: 16 RC0 15 RC1 14 RC2 13 RB4 RC7 9 12 RB5 RB7 10 11 RB6 Note: See Table 2 for location of all peripheral functions. 2014 Microchip Technology Inc. DS40001761A-page 3 PIC16LF1554/1559 RA0 VSS VDD RA5 20-PIN QFN (4x4) RA4 FIGURE 4: 20 19 18 17 16 15 RA1 MCLR/VPP/RA3 1 14 RA2 RC5 2 RC4 3 PIC16LF1559 13 RC0 11 RC2 8 9 10 RB4 7 RB5 6 RB6 RC6 5 RB7 12 RC1 RC7 RC3 4 Note: See Table 2 for location of all peripheral functions. DS40001761A-page 4 2014 Microchip Technology Inc. PIC16LF1554/1559 Pin Allocation Tables 14-Pin PDIP/SOIC/TSSOP 16-Pin QFN ADC Reference Timers PWM EUSART MSSP Interrupt Pull-up Basic 14-PIN AND 16-PIN ALLOCATION TABLE (PIC16LF1554) I/O TABLE 1: RA0 13 12 AN0 -- -- -- -- -- IOC Y ICSPDAT/ ICDDAT RA1 12 11 AN1 VREF+ -- -- -- -- IOC Y ICSPCLK ICDCLK RA2 11 10 AN2 -- T0CKI -- -- -- INT/ IOC Y -- RA3 4 3 -- -- -- -- -- SS(1) SDA(1) SDI(1) IOC Y MCLR VPP RA4 3 2 AN10 ADTRIG -- T1G -- RX(1) DT(1) SDO(1) IOC Y CLKOUT RA5 2 1 AN20 -- T1CKI -- -- -- IOC Y CLKIN RC0 10 9 AN13 -- -- -- -- SCL SCK -- Y -- RC1 9 8 AN23 -- -- -- -- SDA(1) SDI(1) -- Y -- RC2 8 7 AN12 AD1GRDB AD2GRDB(1) -- -- PWM1 -- SDO(1) -- Y -- RC3 7 6 AN22 AD1GRDB(1) AD2GRDB -- -- PWM2 TX(1) CK(1) SS(1) -- Y -- RC4 6 5 AN11 AD1GRDA AD2GRDA(1) -- -- -- TX(1) CK(1) -- -- Y -- RC5 5 4 AN21 AD1GRDA(1) AD2GRDA -- -- -- RX(1) DT(1) -- -- Y -- VDD 1 16 -- -- -- -- -- -- -- -- VDD VSS 14 13 -- -- -- -- -- -- -- -- VSS Note 1: Pin functions can be assigned to one of two pin locations via software. 2014 Microchip Technology Inc. DS40001761A-page 5 PIC16LF1554/1559 20-PIN ALLOCATION TABLE (PIC16LF1559) Reference Timers PWM EUSART MSSP Interrupt Pull-up Basic RA0 19 16 AN0 -- -- -- -- -- IOC Y ICSPDAT/ ICDDAT RA1 18 15 AN1 VREF+ -- -- -- -- IOC Y ICSPCLK/ ICDCLK RA2 17 14 AN2 -- T0CKI -- -- -- INT/ IOC Y -- I/O ADC 20-Pin QFN 20-Pin PDIP/SSOP TABLE 2: RA3 4 1 -- -- -- -- -- SDA(1) SDI(1) SS(1) IOC Y MCLR VPP RA4 3 20 AN10 ADTRIG -- T1G -- -- -- IOC Y CLKOUT RA5 2 19 AN20 -- T1CKI -- -- -- IOC Y CLKIN -- SDA(1) IOC Y -- RB4 13 10 AN26 -- -- -- SDI(1) RB5 12 9 AN16 -- -- -- RX DT -- IOC Y -- RB6 11 8 AN25 -- -- -- -- SCL SCK IOC Y -- RB7 10 7 AN15 -- -- -- TX CK -- IOC Y -- RC0 16 13 AN13 -- -- -- -- -- -- Y -- RC1 15 12 AN23 -- -- -- -- -- -- Y -- RC2 14 11 AN12 AD1GRDB AD2GRDB(1) -- -- PWM1 -- -- -- Y -- RC3 7 4 AN22 AD1GRDB(1) AD2GRDB -- -- PWM2 -- -- -- Y -- RC4 6 3 AN11 AD1GRDA AD2GRDA(1) -- -- -- -- -- -- Y -- RC5 5 2 AN21 AD1GRDA(1) AD2GRDA -- -- -- -- -- -- Y -- RC6 8 5 AN14 -- -- -- -- SS(1) -- Y -- RC7 9 6 AN24 -- -- -- -- SDO -- Y -- VDD 1 18 -- -- -- -- -- -- -- -- VDD VSS 20 17 -- -- -- -- -- -- -- -- VSS Note 1: Pin functions can be assigned to one of two pin locations via software. DS40001761A-page 6 2014 Microchip Technology Inc. PIC16LF1554/1559 Table of Contents 1.0 Device Overview .......................................................................................................................................................................... 9 2.0 Enhanced Mid-Range CPU ........................................................................................................................................................ 16 3.0 Memory Organization ................................................................................................................................................................. 18 4.0 Device Configuration .................................................................................................................................................................. 52 5.0 Oscillator Module........................................................................................................................................................................ 56 6.0 Resets ........................................................................................................................................................................................ 64 7.0 Interrupts .................................................................................................................................................................................... 72 8.0 Power-Down Mode (Sleep) ........................................................................................................................................................ 82 9.0 Watchdog Timer (WDT) ............................................................................................................................................................. 84 10.0 Flash Program Memory Control ................................................................................................................................................. 88 11.0 I/O Ports ................................................................................................................................................................................... 105 12.0 Interrupt-on-Change ................................................................................................................................................................. 118 13.0 Fixed Voltage Reference (FVR) ............................................................................................................................................... 123 14.0 Temperature Indicator Module ................................................................................................................................................. 125 15.0 Analog-to-Digital Converter (ADC) Module .............................................................................................................................. 127 16.0 Hardware Capacitive Voltage Divider (CVD) Module............................................................................................................... 141 17.0 Timer0 Module ......................................................................................................................................................................... 164 18.0 Timer1 Module with Gate Control............................................................................................................................................. 167 19.0 Timer2 Module ......................................................................................................................................................................... 178 20.0 Master Synchronous Serial Port (MSSP) Module .................................................................................................................... 181 21.0 Enhanced Universal Synchronous Asynchronous Receiver Transmitter (EUSART) ............................................................... 234 22.0 Pulse Width Modulation (PWM) Module................................................................................................................................... 261 23.0 In-Circuit Serial ProgrammingTM (ICSPTM) ............................................................................................................................... 267 24.0 Instruction Set Summary .......................................................................................................................................................... 269 25.0 Electrical Specifications............................................................................................................................................................ 283 26.0 DC and AC Characteristics Graphs and Charts ....................................................................................................................... 305 27.0 Development Support............................................................................................................................................................... 306 28.0 Packaging Information.............................................................................................................................................................. 310 Appendix A: Data Sheet Revision History.......................................................................................................................................... 328 The Microchip Web Site ..................................................................................................................................................................... 329 Customer Change Notification Service .............................................................................................................................................. 329 Customer Support .............................................................................................................................................................................. 329 Product Identification System ............................................................................................................................................................ 330 2014 Microchip Technology Inc. DS40001761A-page 7 PIC16LF1554/1559 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 Web site 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 Web site; 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 web site at www.microchip.com to receive the most current information on all of our products. DS40001761A-page 8 2014 Microchip Technology Inc. PIC16LF1554/1559 1.0 DEVICE OVERVIEW The PIC16LF1554/1559 devices are described within this data sheet. The block diagram of these devices is shown in Figure 1-1, the available peripherals are shown in Table 1-1 and the pinout descriptions are shown in Table 1-2 and Table 1-3. Peripheral PIC16LF1559 DEVICE PERIPHERAL SUMMARY PIC16LF1554 TABLE 1-1: Analog-to-Digital Converter (ADC) ADC1 ADC2 Hardware Capacitive Voltage Divider (CVD) Enhanced Universal Synchronous/Asynchronous Receiver/Transmitter (EUSART) Fixed Voltage Reference (FVR) Temperature Indicator MSSP PWM1 PWM2 Timer0 Timer1 Timer2 Master Synchronous Serial Ports PWM Modules Timers 2014 Microchip Technology Inc. DS40001761A-page 9 PIC16LF1554/1559 PIC16LF1554/1559 BLOCK DIAGRAM(1,2) FIGURE 1-1: Program Flash Memory RAM PORTA OSC2/CLKOUT OSC1/CLKIN Timing Generation CPU INTRC Oscillator PORTB(3) (See Figure 2-1) PORTC MCLR Hardware CVD MSSP TMR2 TMR1 TMR0 Temp Indicator ADC1 10-bit ADC2 10-bit PWM2 Note 1: FVR PWM1 EUSART See applicable chapters for more information on peripherals. 2: See Table 1-1 for peripherals available on specific devices. 3: PIC16LF1559 only. DS40001761A-page 10 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 1-2: PIC16LF1554 PINOUT DESCRIPTION Name RA0/AN0/ISCPDAT/ICDDAT RA1/AN1/VREF+/ICSPCLK/ICDCLK RA2/AN2/TOCKI/INT/ RA3/VPP/SS(1)/SDA(1)/SDI(1)/ MCLR RA4/AN10/ADTRIG/CLKOUT/ RX(1)/DT(1)/SDO(1)/T1G RA5/AN20/CLKIN/T1CKI RC0/AN13/SCL/SCK Function Input Type RA0 TTL AN0 AN ICSPDAT ST CMOS ICSPTM Data I/O ICDDAT ST CMOS In-Circuit Debug Data RA1 TTL CMOS General Purpose I/O AN1 AN -- ADC Channel Input VREF+ AN -- ADC Positive Voltage Reference Input ICSPCLK ST CMOS ICSP Programming Clock ICDCLK ST CMOS In-Circuit Debug Clock RA2 TTL CMOS General Purpose I/O AN2 AN -- ADC Channel Input TOCKI ST -- Timer0 Clock Input INT ST -- External Interrupt RA3 TTL Vpp HV -- Programming Voltage ST -- Slave Select Input SS 2 Output Type Description CMOS General Purpose I/O -- ADC Channel Input CMOS General Purpose Input with IOC and WPU SDA I CTM OD I2CTM Data Input/Output SDI CMOS -- SPI Data Input MCLR ST -- Master Clear with Internal Pull-up RA4 TTL AN10 AN -- ADC Channel Input ADTRIG ST -- ADC Conversion Trigger Input CLKOUT -- RX ST DT ST CMOS USART Synchronous Data SDO -- CMOS SPI Data Output T1G ST RA5 TTL AN20 AN CLKIN CMOS -- External Clock Input (EC mode) T1CKI ST -- Timer1 Clock Input RC0 TTL AN13 AN -- ADC Channel Input SCL I2C OD I2C Clock SCK ST CMOS General Purpose I/O CMOS FOSC/4 Output -- -- USART Asynchronous Input Timer1 Gate Input CMOS General Purpose I/O -- ADC Channel Input CMOS General Purpose I/O CMOS SPI Clock Legend: AN = Analog input or output CMOS = CMOS compatible input or output OD TTL = TTL compatible input ST = Schmitt Trigger input with CMOS levels I2C HV = High Voltage XTAL = Crystal Note 1: Alternate pin function selected with the APFCON (Register 11-1) register. 2014 Microchip Technology Inc. = Open Drain = Schmitt Trigger input with I2C levels DS40001761A-page 11 PIC16LF1554/1559 TABLE 1-2: PIC16LF1554 PINOUT DESCRIPTION (CONTINUED) Name RC1/AN23/SDA(1)/SDI(1) RC2/AN12/AD1GRDB(1)/AD2GRDB(1)/ PWM1/SDO(1) RC3/AN22/AD1GRDB(1)/AD2GRDB(1)/ PWM2/TX(1)/CK(1)/SS(1) RC4/AN11/AD1GRDA(1)/AD2GRDA(1)/ TX(1)/CK(1) RC5/AN21/AD1GRDA(1)/AD2GRDA(1)/ RX(1)/DT(1) Function Input Type Output Type RC1 TTL AN23 AN -- ADC Channel Input SDA 2 I C OD I2C Data Input/Output SDI CMOS -- SPI Data Input RC2 TTL AN12 AN AD1GRDB -- CMOS ADC1 Guard Ring Output B AD2GRDB -- CMOS ADC2 Guard Ring Output B Description CMOS General Purpose I/O CMOS General Purpose I/O -- ADC Channel Input PWM1 -- CMOS PWM Output SDO -- CMOS SPI Data Output RC3 TTL AN22 AN AD1GRDB -- CMOS ADC1 Guard Ring Output B AD2GRDB -- CMOS ADC2 Guard Ring Output B PWM2 -- CMOS PWM Output TX -- CMOS USART Asynchronous Transmit CK ST CMOS USART Synchronous Clock SS ST CMOS General Purpose I/O -- -- ADC Channel Input Slave Select Input RC3 TTL AN11 AN CMOS General Purpose I/O AD1GRDA -- CMOS ADC1 Guard Ring Output B AD2GRDA -- CMOS ADC2 Guard Ring Output B TX -- CMOS USART Asynchronous Transmit CK ST CMOS USART Synchronous Clock RC5 TTL CMOS General Purpose I/O AN21 AN AD1GRDA -- CMOS ADC1 Guard Ring Output B AD2GRDA -- CMOS ADC2 Guard Ring Output B RX ST DT ST -- -- -- ADC Channel Input ADC Channel Input USART Asynchronous Input CMOS USART Synchronous Data Legend: AN = Analog input or output CMOS = CMOS compatible input or output OD TTL = TTL compatible input ST = Schmitt Trigger input with CMOS levels I2C HV = High Voltage XTAL = Crystal Note 1: Alternate pin function selected with the APFCON (Register 11-1) register. DS40001761A-page 12 = Open Drain = Schmitt Trigger input with I2C levels 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 1-3: PIC16LF1559 PINOUT DESCRIPTION Name RA0/AN0/ISCPDAT/ICDDAT RA1/AN1/VREF+/ICSPCLK/ICDCLK RA2/AN2/TOCKI/INT RA3/VPP/SS(1)/SDA(1)/SDI(1)/MCLR RA4/AN10/ADTRIG/CLKOUT/T1G RA5/AN20/CLKIN/T1CKI RB4/AN26/SDA(1)/SDI(1) Function Input Type Output Type RA0 TTL CMOS General Purpose I/O AN0 AN -- ADC Channel Input ICSPDAT ST CMOS ICSPTM Data I/O ICDDAT ST CMOS In-Circuit Debug Data RA1 TTL CMOS General Purpose I/O AN1 AN -- ADC Channel Input VREF+ AN -- ADC Positive Voltage Reference Input ICSPCLK ST CMOS ICSP Programming Clock ICDCLK ST CMOS In-Circuit Debug Clock RA2 TTL CMOS General Purpose I/O AN2 AN -- ADC Channel Input TOCKI ST -- Timer0 Clock Input External Interrupt Description INT ST -- RA3 TTL CMOS Vpp HV -- Programming Voltage SS ST -- Slave Select Input SDA I2CTM OD I2CTM Data Input/Output SDI CMOS -- SPI Data Input Master Clear with Internal Pull-up General Purpose Input with IOC and WPU MCLR ST -- RA4 TTL CMOS General Purpose I/O AN10 AN -- ADC Channel Input ADTRIG ST -- ADC Conversion Trigger Input CLKOUT -- CMOS T1G ST -- RA5 TTL CMOS FOSC/4 Output Timer1 Gate input. General Purpose I/O AN20 AN -- ADC Channel Input CLKIN CMOS -- External Clock Input (EC mode) T1CKI ST -- Timer1 clock Input RB4 TTL CMOS General Purpose I/O AN26 AN -- ADC Channel Input SDA I2C OD I2C Data Input/Output SDI CMOS -- SPI Data Input Legend: AN = Analog input or output CMOS = CMOS compatible input or output OD TTL = TTL compatible input ST = Schmitt Trigger input with CMOS levels I2C HV = High Voltage XTAL = Crystal Note 1: Alternate pin function selected with the APFCON (Register 11-1) register. 2014 Microchip Technology Inc. = Open Drain = Schmitt Trigger input with I2C levels DS40001761A-page 13 PIC16LF1554/1559 TABLE 1-3: PIC16LF1559 PINOUT DESCRIPTION (CONTINUED) Name RB5/AN16/RX(1)/DT(1) RB6/AN25/SCL/SCK RB7/AN15/TX/CK RC0/AN13 RC1/AN23 RC2/AN12/AD1GRDB(1)/AD2GRDB(1) /PWM1 RC3/AN22/AD1GRDB(1)/AD2GRDB(1) /PWM2 RC4/AN11/AD1GRDA(1) /AD2GRDA(1) RC5/AN21/AD1GRDA(1)/AD2GRDA(1) Function Input Type Output Type RB5 TTL CMOS AN16 AN -- ADC Channel Input RX ST -- USART Asynchronous Input DT ST CMOS USART Synchronous Data RB6 TTL CMOS General Purpose I/O AN25 AN -- ADC Channel Input SCL I2C OD I2C Clock SCK ST CMOS SPI Clock RB7 TTL CMOS General Purpose I/O AN15 AN -- ADC Channel Input TX -- CMOS USART Asynchronous Transmit CK ST CMOS USART Synchronous Clock RC0 TTL CMOS General Purpose I/O AN13 AN -- ADC Channel Input RC1 TTL CMOS General Purpose I/O AN23 AN -- ADC Channel Input RC2 TTL CMOS General Purpose I/O Description General Purpose I/O AN12 AN -- AD1GRDB -- CMOS ADC1 Guard Ring Output B ADC Channel Input AD2GRDB -- CMOS ADC2 Guard Ring Output B PWM1 -- CMOS PWM Output RC3 TTL CMOS General Purpose I/O AN22 AN -- ADC Channel Input AD1GRDB -- CMOS ADC1 Guard Ring Output B AD2GRDB -- CMOS ADC2 Guard Ring Output B PWM2 -- CMOS PWM Output RC4 TTL CMOS General Purpose I/O AN11 AN -- AD1GRDA -- CMOS ADC1 Guard Ring Output B ADC Channel Input AD2GRDA -- CMOS ADC2 Guard Ring Output B RC5 TTL CMOS General Purpose I/O AN21 AN -- ADC Channel Input AD1GRDA -- CMOS ADC1 Guard Ring Output B AD2GRDA -- CMOS ADC2 Guard Ring Output B Legend: AN = Analog input or output CMOS = CMOS compatible input or output OD TTL = TTL compatible input ST = Schmitt Trigger input with CMOS levels I2C HV = High Voltage XTAL = Crystal Note 1: Alternate pin function selected with the APFCON (Register 11-1) register. DS40001761A-page 14 = Open Drain = Schmitt Trigger input with I2C levels 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 1-3: PIC16LF1559 PINOUT DESCRIPTION (CONTINUED) Name RC6/AN14/SS(1) RC7/AN24/SDO Function Input Type Output Type RC6 TTL CMOS General Purpose I/O AN14 AN -- ADC Channel Input SS ST -- Slave Select Input RC7 TTL CMOS AN24 AN -- SDO -- CMOS Description General Purpose I/O ADC Channel Input SPI Data Output Legend: AN = Analog input or output CMOS = CMOS compatible input or output OD TTL = TTL compatible input ST = Schmitt Trigger input with CMOS levels I2C HV = High Voltage XTAL = Crystal Note 1: Alternate pin function selected with the APFCON (Register 11-1) register. 2014 Microchip Technology Inc. = Open Drain = Schmitt Trigger input with I2C levels DS40001761A-page 15 PIC16LF1554/1559 2.0 ENHANCED MID-RANGE CPU This family of devices contain an enhanced mid-range 8-bit CPU core. The CPU has 49 instructions. Interrupt capability includes automatic context saving. The hardware stack is 16 levels deep and has Overflow and Underflow Reset capability. Direct, Indirect, and Relative Addressing modes are available. Two File Select Registers (FSRs) provide the ability to read program and data memory. * * * * Automatic Interrupt Context Saving 16-level Stack with Overflow and Underflow File Select Registers Instruction Set FIGURE 2-1: CORE BLOCK DIAGRAM Rev. 10-000055A 7/30/2013 15 Configuration 15 MUX Flash Program Memory Data Bus 16-Level Stack (15-bit) RAM 14 Program Bus 8 Program Counter 12 Program Memory Read (PMR) RAM Addr Addr MUX Instruction Reg Direct Addr 7 5 Indirect Addr 12 12 BSR Reg 15 FSR0 Reg 15 FSR1 Reg STATUS Reg 8 Instruction Decode and Control CLKIN CLKOUT Timing Generation Internal Oscillator Block DS40001761A-page 16 Power-up Timer Power-on Reset Watchdog Timer Brown-out Reset VDD 3 8 MUX ALU W Reg VSS 2014 Microchip Technology Inc. PIC16LF1554/1559 2.1 Automatic Interrupt Context Saving During interrupts, certain registers are automatically saved in shadow registers and restored when returning from the interrupt. This saves stack space and user code. See Section 7.5 "Automatic Context Saving", for more information. 2.2 16-Level Stack with Overflow and Underflow These devices have a hardware stack memory 15 bits wide and 16 words deep. A Stack Overflow or Underflow will set the appropriate bit (STKOVF or STKUNF) in the PCON register, and if enabled, will cause a software Reset. See section Section 3.4 "Stack" for more details. 2.3 File Select Registers There are two 16-bit File Select Registers (FSR). FSRs can access all file registers and program memory, which allows one Data Pointer for all memory. When an FSR points to program memory, there is one additional instruction cycle in instructions using INDF to allow the data to be fetched. General purpose memory can now also be addressed linearly, providing the ability to access contiguous data larger than 80 bytes. There are also new instructions to support the FSRs. See Section 3.5 "Indirect Addressing" for more details. 2.4 Instruction Set There are 49 instructions for the enhanced mid-range CPU to support the features of the CPU. See Section 24.0 "Instruction Set Summary" for more details. 2014 Microchip Technology Inc. DS40001761A-page 17 PIC16LF1554/1559 3.0 MEMORY ORGANIZATION These devices contain the following types of memory: * Program Memory - Configuration Words - Device ID - User ID - Flash Program Memory * Data Memory - Core Registers - Special Function Registers - General Purpose RAM - Common RAM 3.1 Program Memory Organization The enhanced mid-range core has a 15-bit program counter capable of addressing a 32K x 14 program memory space. Table 3-1 shows the memory sizes implemented. Accessing a location above these boundaries will cause a wrap-around within the implemented memory space. The Reset vector is at 0000h and the interrupt vector is at 0004h (see Figure 3-1). The following features are associated with access and control of program memory and data memory: * PCL and PCLATH * Stack * Indirect Addressing TABLE 3-1: DEVICE SIZES AND ADDRESSES Program Memory Space (Words) Last Program Memory Address High-Endurance Flash Memory Address Range (1) PIC16LF1554 4,096 0FFFh 0F80h-0FFFh PIC16LF1559 8,192 1FFFh 1F80h-1FFFh Device Note 1: High-endurance Flash applies to low byte of each address in the range. DS40001761A-page 18 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 3-1: PROGRAM MEMORY MAP AND STACK FOR PIC16LF1554 FIGURE 3-2: PROGRAM MEMORY MAP AND STACK FOR PIC16LF1559 Rev. 10-000040A 7/30/2013 Rev. 10-000040B 7/30/2013 PC<14:0> CALL, CALLW RETURN, RETLW Interrupt, RETFIE On-chip Program Memory PC<14:0> CALL, CALLW RETURN, RETLW Interrupt, RETFIE 15 15 Stack Level 0 Stack Level 0 Stack Level 1 Stack Level 1 Stack Level 15 Stack Level 15 Reset Vector 0000h Reset Vector 0000h Interrupt Vector 0004h 0005h Interrupt Vector 0004h 0005h Page 0 Page 0 07FFh 0800h Page 1 Rollover to Page 0 0FFFh 1000h 07FFh 0800h On-chip Program Memory Page 1 0FFFh 1000h Page 2 17FFh 1800h Page 3 Rollover to Page 1 2014 Microchip Technology Inc. Rollover to Page 0 1FFFh 2000h Rollover to Page 3 7FFFh 7FFFh DS40001761A-page 19 PIC16LF1554/1559 3.1.1 READING PROGRAM MEMORY AS DATA 3.1.1.2 Indirect Read with FSR 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 3-1. The program memory can be accessed as data by setting bit 7 of the 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 access the program memory via the FSR require one extra instruction cycle to complete. Example 3-2 demonstrates accessing the program memory via an FSR. EXAMPLE 3-1: The HIGH operator will set bit 7 if a label points to a location in program memory. There are two 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. 3.1.1.1 RETLW Instruction constants BRW RETLW RETLW RETLW RETLW 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. If your code must remain portable with previous generations of microcontrollers, then the BRW instruction is not available so the older table read method must be used. DS40001761A-page 20 EXAMPLE 3-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 2014 Microchip Technology Inc. PIC16LF1554/1559 3.2 Data Memory Organization The data memory is partitioned in 32 memory banks with 128 bytes in a bank. Each bank consists of (Figure 3-3): * * * * 12 core registers 20 Special Function Registers (SFR) Up to 80 bytes of General Purpose RAM (GPR) 16 bytes of common RAM The active bank is selected by writing the bank number into the Bank Select Register (BSR). Unimplemented memory will read as `0'. 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 3.5 "Indirect Addressing" for more information. Data memory uses a 12-bit address. The upper five bits of the address define the Bank address and the lower seven bits select the registers/RAM in that bank. 2014 Microchip Technology Inc. 3.2.1 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 3-2. For detailed information, see Table 3-8. TABLE 3-2: 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 DS40001761A-page 21 PIC16LF1554/1559 3.2.1.1 STATUS Register The STATUS register, shown in Register 3-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 3-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 24.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 the upper three bits and set the Z bit. This leaves the STATUS register as `000u u1uu' (where u = unchanged). -- U-0 R-1/q -- TO R-1/q PD R/W-0/u R/W-0/u R/W-0/u 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. DS40001761A-page 22 2014 Microchip Technology Inc. PIC16LF1554/1559 3.2.2 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 after the core registers of every data memory bank (addresses x0Ch/x8Ch through x1Fh/x9Fh). The registers associated with the operation of the peripherals are described in the appropriate peripheral chapter of this data sheet. 3.2.3 GENERAL PURPOSE RAM There are up to 80 bytes of GPR in each data memory bank. The Special Function Registers occupy the 20 bytes after the core registers of every data memory bank (addresses x0Ch/x8Ch through x1Fh/x9Fh). 3.2.3.1 FIGURE 3-3: BANKED MEMORY PARTITIONING Rev. 10-000041A 7/30/2013 7-bit Bank Offset Memory Region 00h Core Registers (12 bytes) 0Bh 0Ch Special Function Registers (20 bytes maximum) 1Fh 20h 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 3.5.2 "Linear Data Memory" for more information. 3.2.4 General Purpose RAM (80 bytes maximum) COMMON RAM There are 16 bytes of common RAM accessible from all banks. 3.2.5 DEVICE MEMORY MAPS The memory maps for PIC16LF1554/1559 are as shown in Table 3-3 through Table 3-7. 6Fh 70h Common RAM (16 bytes) 7Fh 2014 Microchip Technology Inc. DS40001761A-page 23 PIC16LF1554 MEMORY MAP, BANKS 0-7 000h 001h 002h 003h 004h 005h 006h 007h 008h 009h 00Ah 00Bh 00Ch 00Dh 00Eh 00Fh 010h 011h 012h 013h 014h 015h 016h 017h 018h 019h 01Ah BANK 0 INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON PORTA -- PORTC -- -- PIR1 PIR2 -- -- TMR0 TMR1L TMR1H T1CON T1GCON TMR2 080h 081h 082h 083h 084h 085h 086h 087h 088h 089h 08Ah 08Bh 08Ch 08Dh 08Eh 08Fh 090h 091h 092h 093h 094h 095h 096h 097h 098h 099h 09Ah 01Bh PR2 09Bh 01Ch T2CON 09Ch 01Dh -- 09Dh 01Eh -- 09Eh 01Fh -- 09Fh 020h 2014 Microchip Technology Inc. 0A0h 06Fh 070h 0EFh 0F0h 07Fh 0FFh Legend: 1: 100h 101h 102h 103h 104h 105h 106h 107h 108h 109h 10Ah 10Bh 10Ch 10Dh 10Eh 10Fh 110h 111h 112h 113h 114h 115h 116h 117h 118h 119h 11Ah BANK 2 INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON LATA -- LATC -- -- -- -- -- -- -- BORCON FVRCON -- -- -- 180h 181h 182h 183h 184h 185h 186h 187h 188h 189h 18Ah 18Bh 18Ch 18Dh 18Eh 18Fh 190h 191h 192h 193h 194h 195h 196h 197h 198h 199h 19Ah BANK 3 INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON ANSELA -- ANSELC -- -- PMADRL PMADRH PMDATL PMDATH PMCON1 PMCON2 -- -- RCREG TXREG 200h 201h 202h 203h 204h 205h 206h 207h 208h 209h 20Ah 20Bh 20Ch 20Dh 20Eh 20Fh 210h 211h 212h 213h 214h 215h 216h 217h 218h 219h 21Ah BANK 4 INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON WPUA -- -- -- -- SSPBUF SSPADD SSPMSK SSPSTAT SSPCON1 SSPCON2 SSPCON3 -- -- -- 280h 281h 282h 283h 284h 285h 286h 287h 288h 289h 28Ah 28Bh 28Ch 28Dh 28Eh 28Fh 290h 291h 292h 293h 294h 295h 296h 297h 298h 299h 29Ah BANK 5 INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 300h 301h 302h 303h 304h 305h 306h 307h 308h 309h 30Ah 30Bh 30Ch 30Dh 30Eh 30Fh 310h 311h 312h 313h 314h 315h 316h 317h 318h 319h 31Ah BANK 6 INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 380h 381h 382h 383h 384h 385h 386h 387h 388h 389h 38Ah 38Bh 38Ch 38Dh 38Eh 38Fh 390h 391h 392h 393h 394h 395h 396h 397h 398h 399h 39Ah BANK 7 INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- IOCAP IOCAN IOCAF -- -- -- -- -- -- -- 11Bh -- 19Bh SPBRGL 21Bh -- 29Bh -- 31Bh -- 39Bh -- 11Ch -- 19Ch SPBRGH 21Ch -- 29Ch -- 31Ch -- 39Ch -- 11Dh APFCON 19Dh RCSTA 21Dh -- 29Dh -- 31Dh -- 39Dh -- 11Eh -- 19Eh TXSTA 21Eh -- 29Eh -- 31Eh -- 39Eh -- 11Fh -- 19Fh BAUDCON 21Fh -- 29Fh -- 31Fh -- 39Fh -- 120h General Purpose Register 80 Bytes General Purpose Register 96 Bytes Note BANK 1 INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON TRISA -- TRISC -- -- PIE1 PIE2 -- -- OPTION PCON WDTCON -- OSCCON OSCSTAT ADRESL/ AD1RES0L(1) ADRESH/ AD1RES0H(1) ADCON0/ AD1CON0(1) ADCON1/ ADCOMCON(1) ADCON2/ AD1CON2(1) Accesses 70h - 7Fh 1A0h General Purpose Register 80 Bytes 16Fh 170h 17Fh Accesses 70h - 7Fh = Unimplemented data memory locations, read as `0'. These ADC registers are the same as the registers in Bank 14. 220h Unimplemented Read as `0' 1EFh 1F0h 1FFh Accesses 70h - 7Fh 2A0h Unimplemented Read as `0' 26Fh 270h 27Fh Accesses 70h - 7Fh 320h Unimplemented Read as `0' 2EFh 2F0h 2FFh Accesses 70h - 7Fh 3A0h Unimplemented Read as `0' 36Fh 370h 37Fh Accesses 70h - 7Fh Unimplemented Read as `0' 3EFh 3F0h 3FFh Accesses 70h - 7Fh PIC16LF1554/1559 DS40001761A-page 24 TABLE 3-3: 2014 Microchip Technology Inc. TABLE 3-4: PIC16LF1559 MEMORY MAP, BANKS 0-7 BANK 0 BANK 1 INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON PORTA PORTB PORTC -- -- PIR1 PIR2 -- -- TMR0 TMR1L TMR1H T1CON T1GCON TMR2 080h 081h 082h 083h 084h 085h 086h 087h 088h 089h 08Ah 08Bh 08Ch 08Dh 08Eh 08Fh 090h 091h 092h 093h 094h 095h 096h 097h 098h 099h 09Ah 01Bh PR2 09Bh 01Ch T2CON 09Ch 01Dh -- 09Dh 01Eh -- 09Eh 01Fh -- 020h 09Fh 0A0h DS40001761A-page 25 06Fh 070h 0EFh 0F0h 07Fh 0FFh Legend: 1: BANK 2 BANK 4 BANK 5 BANK 6 BANK 7 INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON LATA LATB LATC -- -- -- -- -- -- -- BORCON FVRCON -- -- -- 180h 181h 182h 183h 184h 185h 186h 187h 188h 189h 18Ah 18Bh 18Ch 18Dh 18Eh 18Fh 190h 191h 192h 193h 194h 195h 196h 197h 198h 199h 19Ah INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON ANSELA ANSELB ANSELC -- -- PMADRL PMADRH PMDATL PMDATH PMCON1 PMCON2 -- -- RCREG TXREG 200h 201h 202h 203h 204h 205h 206h 207h 208h 209h 20Ah 20Bh 20Ch 20Dh 20Eh 20Fh 210h 211h 212h 213h 214h 215h 216h 217h 218h 219h 21Ah INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON WPUA WPUB -- -- -- SSPBUF SSPADD SSPMSK SSPSTAT SSPCON1 SSPCON2 SSPCON3 -- -- -- 280h 281h 282h 283h 284h 285h 286h 287h 288h 289h 28Ah 28Bh 28Ch 28Dh 28Eh 28Fh 290h 291h 292h 293h 294h 295h 296h 297h 298h 299h 29Ah INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 300h 301h 302h 303h 304h 305h 306h 307h 308h 309h 30Ah 30Bh 30Ch 30Dh 30Eh 30Fh 310h 311h 312h 313h 314h 315h 316h 317h 318h 319h 31Ah INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- 380h 381h 382h 383h 384h 385h 386h 387h 388h 389h 38Ah 38Bh 38Ch 38Dh 38Eh 38Fh 390h 391h 392h 393h 394h 395h 396h 397h 398h 399h 39Ah INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- IOCAP IOCAN IOCAF IOCBP IOCBN IOCBF -- -- -- -- 11Bh -- 19Bh SPBRGL 21Bh -- 29Bh -- 31Bh -- 39Bh -- 11Ch -- 19Ch SPBRGH 21Ch -- 29Ch -- 31Ch -- 39Ch -- 11Dh APFCON 19Dh RCSTA 21Dh -- 29Dh -- 31Dh -- 39Dh -- 11Eh -- 19Eh TXSTA 21Eh -- 29Eh -- 31Eh -- 39Eh -- 11Fh -- 19Fh BAUDCON 21Fh -- 29Fh -- 31Fh -- 39Fh -- 320h General Purpose Register 16 Bytes 3A0h 120h Accesses 70h - 7Fh BANK 3 100h 101h 102h 103h 104h 105h 106h 107h 108h 109h 10Ah 10Bh 10Ch 10Dh 10Eh 10Fh 110h 111h 112h 113h 114h 115h 116h 117h 118h 119h 11Ah General Purpose Register 80 Bytes General Purpose Register 96 Bytes Note INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON TRISA TRISB TRISC -- -- PIE1 PIE2 -- -- OPTION PCON WDTCON -- OSCCON OSCSTAT ADRESL/ AD1RES0L(1) ADRESH/ AD1RES0H(1) ADCON0/ AD1CON0(1) ADCON1/ ADCOMCON(1) ADCON2/ AD1CON2(1) 1A0h General Purpose Register 80 Bytes 16Fh 170h 17Fh Accesses 70h - 7Fh = Unimplemented data memory locations, read as `0'. These ADC registers are the same as the registers in Bank 14. 220h General Purpose Register 80 Bytes 1EFh 1F0h 1FFh Accesses 70h - 7Fh 2A0h General Purpose Register 80 Bytes 26Fh 270h 27Fh Accesses 70h - 7Fh General Purpose Register 80 Bytes 2EFh 2F0h 2FFh Accesses 70h - 7Fh 330h Unimplemented Read as `0' Unimplemented Read as `0' 36Fh 370h 37Fh Accesses 70h - 7Fh 3EFh 3F0h 3FFh Accesses 70h - 7Fh PIC16LF1554/1559 000h 001h 002h 003h 004h 005h 006h 007h 008h 009h 00Ah 00Bh 00Ch 00Dh 00Eh 00Fh 010h 011h 012h 013h 014h 015h 016h 017h 018h 019h 01Ah PIC16LF1554/1559 MEMORY MAP, BANKS 8-15 BANK 8 BANK 9 BANK 10 BANK 11 BANK 12 BANK 13 BANK 14 400h 401h 402h 403h 404h 405h 406h 407h 408h 409h 40Ah 40Bh 40Ch 40Dh 40Eh 40Fh 410h INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- 480h 481h 482h 483h 484h 485h 486h 487h 488h 489h 48Ah 48Bh 48Ch 48Dh 48Eh 48Fh 490h INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- 500h 501h 502h 503h 504h 505h 506h 507h 508h 509h 50Ah 50Bh 50Ch 50Dh 50Eh 50Fh 510h INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- 580h 581h 582h 583h 584h 585h 586h 587h 588h 589h 58Ah 58Bh 58Ch 58Dh 58Eh 58Fh 590h INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- 600h 601h 602h 603h 604h 605h 606h 607h 608h 609h 60Ah 60Bh 60Ch 60Dh 60Eh 60Fh 610h INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- 680h 681h 682h 683h 684h 685h 686h 687h 688h 689h 68Ah 68Bh 68Ch 68Dh 68Eh 68Fh 690h INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- 700h 701h 702h 703h 704h 705h 706h 707h 708h 709h 70Ah 70Bh 70Ch 70Dh 70Eh 70Fh 710h 411h -- 491h -- 511h -- 591h -- 611h PWM1DCL 691h -- 711h 412h -- 492h -- 512h -- 592h -- 612h PWM1DCH 692h -- 712h 2014 Microchip Technology Inc. 413h -- 493h -- 513h -- 593h -- 613h PWM1CON 693h -- 713h 414h 415h 416h 417h 418h 419h -- -- -- -- -- -- 494h 495h 496h 497h 498h 499h -- -- -- -- -- -- 514h 515h 516h 517h 518h 519h -- -- -- -- -- -- 594h 595h 596h 597h 598h 599h -- -- -- -- -- -- 614h 615h 616h 617h 618h 619h PWM2DCL PWM2DCH PWM2CON -- -- -- 694h 695h 696h 697h 698h 699h -- -- -- -- -- -- 714h 715h 716h 717h 718h 719h 41Ah -- 49Ah -- 51Ah -- 59Ah -- 61Ah -- 69Ah -- 71Ah 41Bh -- 49Bh -- 51Bh -- 59Bh -- 61Bh -- 69Bh -- 71Bh 41Ch -- 49Ch -- 51Ch -- 59Ch -- 61Ch -- 69Ch -- 71Ch 41Dh -- 49Dh -- 51Dh -- 59Dh -- 61Dh -- 69Dh -- 71Dh 41Eh 41Fh 420h -- -- 49Eh 49Fh 4A0h -- -- 51Eh 51Fh 520h -- -- 59Eh 59Fh 9A0h -- -- 61Eh 61Fh 620h -- -- 69Eh 69Fh 6A0h -- -- 71Eh 71Fh 720h Unimplemented Read as `0' 46Fh 470h Unimplemented Read as `0' 4EFh 4F0h Accesses 70h - 7Fh 47Fh Note 56Fh 570h Accesses 70h - 7Fh 4FFh 1: Unimplemented Read as `0' Unimplemented Read as `0' 5EFh 5F0h Accesses 70h - 7Fh 57Fh These ADC registers are the same as the registers in Bank 1. Unimplemented Read as `0' 66Fh 670h Accesses 70h - 7Fh 5FFh Unimplemented Read as `0' 6EFh 6F0h Accesses 70h - 7Fh 67Fh BANK 15 780h 781h 782h 783h 784h 785h 786h 787h 788h 789h 78Ah 78Bh 78Ch 78Dh 78Eh 78Fh 790h 791h 792h 793h 794h 795h 796h 797h 798h 799h 79Ah 79Bh 79Ch 79Dh 79Eh 79Fh 7A0h Unimplemented Read as `0' 76Fh 770h Accesses 70h - 7Fh 6FFh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- AD1CON0/ AAD1CON0(1) AADCON1/ ADCOMCON(1) AD1CON2/ AAD1CON2(1) AAD1CON3 AADSTAT AAD1PRE AAD1ACQ AAD1GRD AAD1CAP AD1RES0L/ AAD1RES0L(1) AD1RES0H/ AAD1RES0H(1) AD1RES1L/ AAD1RES1L AD1RES1H/ AAD1RES1H AAD1CH -- -- AD2CON2/ AAD2CON2 AAD2CON3 -- AAD2PRE AAD2ACQ AAD2GRD AAD2CAP AD2RES0L/ AAD2RES0L AD2RES0H/ AAD2RES0H AD2RES1L/ AAD2RES1L AD2RES1H/ AAD2RES1H AAD2CH -- Unimplemented Read as `0' 7EFh 7F0h Accesses 70h - 7Fh 77Fh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- AD2CON0/ AAD2CON0 Accesses 70h - 7Fh 7FFh PIC16LF1554/1559 DS40001761A-page 26 TABLE 3-5: 2014 Microchip Technology Inc. TABLE 3-6: PIC16LF1554/1559 MEMORY MAP, BANKS 16-23 BANK 16 INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 17 880h 881h 882h 883h 884h 885h 886h 887h 888h 889h 88Ah 88Bh 88Ch 88Dh 88Eh 88Fh 890h 891h 892h 893h 894h 895h 896h 897h 898h 899h 89Ah 89Bh 89Ch 89Dh 89Eh 89Fh 8A0h Unimplemented Read as `0' DS40001761A-page 27 86Fh 870h BANK 18 900h 901h 902h 903h 904h 905h 906h 907h 908h 909h 90Ah 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 Accesses 70h - 7Fh 87Fh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 19 980h 981h 982h 983h 984h 985h 986h 987h 988h 989h 98Ah 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 Accesses 70h - 7Fh 8FFh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 20 A00h A01h A02h A03h A04h A05h A06h A07h A08h A09h A0Ah 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 Accesses 70h - 7Fh 97Fh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 21 A80h A81h A82h A83h A84h A85h A86h A87h A88h A89h A8Ah 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 Accesses 70h - 7Fh 9FFh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 22 B00h B01h B02h B03h B04h B05h B06h B07h B08h B09h B0Ah 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 Accesses 70h - 7Fh A7Fh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 23 B80h B81h B82h B83h B84h B85h B86h B87h B88h B89h B8Ah 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 Accesses 70h - 7Fh AFFh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Unimplemented Read as `0' BEFh BF0h Accesses 70h - 7Fh B7Fh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Accesses 70h - 7Fh BFFh PIC16LF1554/1559 800h 801h 802h 803h 804h 805h 806h 807h 808h 809h 80Ah 80Bh 80Ch 80Dh 80Eh 80Fh 810h 811h 812h 813h 814h 815h 816h 817h 818h 819h 81Ah 81Bh 81Ch 81Dh 81Eh 81Fh 820h PIC16LF1554/1559 MEMORY MAP, BANKS 24-31 BANK 24 C00h C01h C02h C03h C04h C05h C06h C07h C08h C09h C0Ah C0Bh C0Ch C0Dh C0Eh C0Fh C10h C11h C12h C13h C14h C15h C16h C17h C18h C19h C1Ah C1Bh C1Ch C1Dh C1Eh C1Fh C20h INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 25 C80h C81h C82h C83h C84h C85h C86h C87h C88h C89h C8Ah C8Bh C8Ch C8Dh C8Eh C8Fh C90h C91h C92h C93h C94h C95h C96h C97h C98h C99h C9Ah C9Bh C9Ch C9Dh C9Eh C9Fh CA0h 2014 Microchip Technology Inc. Unimplemented Read as `0' C6Fh C70h CFFh BANK 26 D00h D01h D02h D03h D04h D05h D06h D07h D08h D09h D0Ah D0Bh D0Ch D0Dh D0Eh D0Fh D10h D11h D12h D13h D14h D15h D16h D17h D18h D19h D1Ah D1Bh D1Ch D1Dh D1Eh D1Fh D20h Unimplemented Read as `0' CEFh CF0h Accesses 70h - 7Fh Legend: INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 27 D80h D81h D82h D83h D84h D85h D86h D87h D88h D89h D8Ah D8Bh D8Ch D8Dh D8Eh D8Fh D90h D91h D92h D93h D94h D95h D96h D97h D98h D99h D9Ah D9Bh D9Ch D9Dh D9Eh D9Fh DA0h Unimplemented Read as `0' D6Fh D70h Accesses 70h - 7Fh CFFh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Unimplemented Read as `0' DEFh DF0h Accesses 70h - 7Fh D7Fh = Unimplemented data memory locations, read as `0'. BANK 28 E00h E01h E02h E03h E04h E05h E06h E07h E08h E09h E0Ah E0Bh E0Ch E0Dh E0Eh E0Fh E10h E11h E12h E13h E14h E15h E16h E17h E18h E19h E1Ah E1Bh E1Ch E1Dh E1Eh E1Fh E20h BANK 29 E80h E81h E82h E83h E84h E85h E86h E87h E88h E89h E8Ah E8Bh E8Ch E8Dh E8Eh E8Fh E90h E91h E92h E93h E94h E95h E96h E97h E98h E99h E9Ah E9Bh E9Ch E9Dh E9Eh E9Fh EA0h Unimplemented Read as `0' E6Fh E70h Accesses 70h - 7Fh DFFh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 30 F00h F01h F02h F03h F04h F05h F06h F07h F08h F09h F0Ah F0Bh F0Ch F0Dh F0Eh F0Fh F10h F11h F12h F13h F14h F15h F16h F17h F18h F19h F1Ah F1Bh F1Ch F1Dh F1Eh F1Fh F20h Unimplemented Read as `0' EEFh EF0h Accesses 70h - 7Fh E7Fh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- BANK 31 F80h INDF0 F81h INDF1 F82h PCL F83h STATUS F84h FSR0L F85h FSR0H F86h FSR1L F87h FSR1H F88h BSR F89h WREG F8Ah PCLATH F8Bh INTCON F8Ch F8Dh F8Eh F8Fh F90h F91h F92h F93h F94h F95h F96h F97h See Table 3-9 for F98h register mapping F99h details F9Ah F9Bh F9Ch F9Dh F9Eh F9Fh FA0h Unimplemented Read as `0' F6Fh F70h Accesses 70h - 7Fh EFFh INDF0 INDF1 PCL STATUS FSR0L FSR0H FSR1L FSR1H BSR WREG PCLATH INTCON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- FEFh F0h Accesses 70h - 7Fh F7Fh Accesses 70h - 7Fh FFFh PIC16LF1554/1559 DS40001761A-page 28 TABLE 3-7: PIC16LF1554/1559 3.2.6 CORE FUNCTION REGISTERS SUMMARY The Core Function registers listed in Table 3-8 can be addressed from any Bank. TABLE 3-8: Addr. Name CORE FUNCTION REGISTERS SUMMARY Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on POR, BOR Value on all other Resets Bank 0-31 x00h or x80h INDF0 Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) xxxx xxxx uuuu uuuu x01h or x81h INDF1 Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu x02h or x82h PCL Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 x03h or x83h STATUS x04h or x84h FSR0L Indirect Data Memory Address 0 Low Pointer 0000 0000 uuuu uuuu x05h or x85h FSR0H Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 x06h or x86h FSR1L Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu x07h or x87h FSR1H Indirect Data Memory Address 1 High Pointer 0000 0000 0000 0000 x08h or x88h BSR x09h or x89h WREG -- -- -- -- TO PD -- Z DC C BSR<4:0> -- x0Bh or INTCON x8Bh GIE 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter PEIE TMR0IE INTE IOCIE ---1 1000 ---q quuu ---0 0000 ---0 0000 Working Register x0Ah or PCLATH x8Ah Legend: -- TMR0IF INTF -000 0000 -000 0000 IOCIF 0000 0000 0000 0000 x = unknown, u = unchanged, q = value depends on condition, - = unimplemented, read as `0', r = reserved. Shaded locations are unimplemented, read as `0'. 2014 Microchip Technology Inc. DS40001761A-page 29 PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 0 000h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) 001h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu 002h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 003h STATUS(1) 004h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 005h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 006h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu 007h FSR1H(1) 008h BSR(1) 009h WREG(1) 00Ah PCLATH(1) -- 00Bh INTCON(1) GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 0000 0000 0000 0000 00Ch PORTA -- -- RA5 RA4 RA3 RA2 RA1 RA0 --xx xxxx --xx xxxx -- -- -- xxxx ---- xxxx -----xx xxxx --xx xxxx 00Dh 00Eh -- -- -- PD Z DC C -- -- 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter -000 0000 -000 0000 Unimplemented RB7 RB6 RB5 RB4 -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu Indirect Data Memory Address 1 High Pointer -- PORTB(2) PORTB(3) TO xxxx xxxx uuuu uuuu -- -- PORTC(2) -- -- RC5 RC4 RC3 RC2 RC1 RC0 PORTC(3) RC7 RC6 RC5 RC4 RC3 RC2 RC1 RC0 xxxx xxxx xxxx xxxx TXIF SSP1IF -- TMR2IF TMR1IF 0000 0-00 0000 0-00 -- BCLIF -- -- -- -0-- 0--- -0-- 0--- 011h PIR1 TMR1GIF AD1IF RCIF 012h PIR2 -- AD2IF -- 015h TMR0 Timer0 Module Register xxxx xxxx uuuu uuuu 016h TMR1L Holding Register for the Least Significant Byte of the 16-bit TMR1 Count xxxx xxxx uuuu uuuu 017h TMR1H Holding Register for the Most Significant Byte of the 16-bit TMR1 Count 018h T1CON 019h T1GCON 01Ah TMR2 Timer 2 Module Register 01Bh PR2 Timer 2 Period Register 01Ch T2CON 01Dh -- Unimplemented -- -- 01Eh -- Unimplemented -- -- 01Fh -- Unimplemented -- -- Legend: Note 1: 2: 3: 4: TMR1CS<1:0> TMR1GE -- T1GPOL T1CKPS<1:0> T1GTM T1GSPM xxxx xxxx uuuu uuuu -- T1SYNC -- TMR1ON 0000 -0-0 uuuu -u-u T1GGO/ DONE T1GVAL -- T1GSS 0000 0x-0 uuuu ux-u T2OUTPS<3:0> 0000 0000 0000 0000 1111 1111 1111 1111 TMR2ON T2CKPS<1:0> -000 0000 -000 0000 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. DS40001761A-page 30 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 1 080h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) 081h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu 082h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 xxxx xxxx uuuu uuuu 083h STATUS(1) 084h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 085h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 086h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu 087h FSR1H(1) 088h BSR(1) -- -- -- TO PD Z DC C Indirect Data Memory Address 1 High Pointer -- -- -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 089h WREG(1) 08Ah PCLATH(1) -- 08Bh INTCON(1) GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 0000 0000 0000 0000 08Ch TRISA -- -- TRISA5 TRISA4 -- TRISA2 TRISA1 TRISA0 --11 1111 --11 1111 08Dh 08Eh Working Register TRISB(2) TRISB(3) 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter -000 0000 -000 0000 Unimplemented TRISB7 -- -- TRISB6 TRISB5 TRISB4 -- -- -- -- 1111 ---- 1111 -----11 1111 --11 1111 TRISC(2) -- -- TRISC5 TRISC4 TRISC3 TRISC2 TRISC1 TRISC0 TRISC(3) TRISC7 TRISC6 TRISC5 TRISC4 TRISC3 TRISC2 TRISC1 TRISC0 1111 1111 1111 1111 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 0000 0-00 0000 0-00 -- -- -- -0-- 0--- -0-- 0--- BOR 00-1 11qq 00-q qquu SWDTEN --01 0110 --01 0110 091h PIE1 092h PIE2 -- AD2IE -- -- BCLIE 095h OPTION_REG WPUEN INTEDG TMR0CS TMR0SE PSA 096h PCON STKOVF STKUNF -- RWDT RMCLR -- -- PS<2:0> RI POR 1111 1111 1111 1111 097h WDTCON 098h -- 099h OSCCON SPLLEN 09Ah OSCSTAT -- 09Bh ADRESL/ AD1RES0L(4) ADC1 Result Register 0 Low xxxx xxxx uuuu uuuu 09Ch ADRESH/ AD1RES0H(4) ADC1 Result Register 0 High xxxx xxxx uuuu uuuu 09Dh ADCON0/ AD1CON0(4) 09Eh ADCON1/ ADCOMCON(4) 09Fh ADCON2/ AD1CON2(4) Legend: Note 1: 2: 3: 4: WDTPS<4:0> Unimplemented -- IRCF<3:0> PLLSR CHS14 -- HFIOFR CHS13 CHS12 -- -- -- -- CHS11 CHS10 ADFM ADCS<2:0> -- GO/ DONE_ALL -- TRIGSEL1<2:0> -- -- SCS<1:0> LFIOFR GO/DONE1 -- 0011 1-00 0011 1-00 HFIOFS AD1ON -0-0 --00 -q-q -q0q -000 0000 -000 0000 ADPREF<1:0> 0000 -000 0000 -000 -- -000 ---- -000 ---- -- 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. 2014 Microchip Technology Inc. DS40001761A-page 31 PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 2 100h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) 101h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu 102h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 xxxx xxxx uuuu uuuu 103h STATUS(1) 104h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 105h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 106h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu 107h FSR1H(1) 108h BSR(1) -- -- -- TO PD Z DC C Indirect Data Memory Address 1 High Pointer -- -- -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 109h WREG(1) 10Ah PCLATH(1) -- 10Bh INTCON(1) GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 0000 0000 0000 0000 10Ch LATA -- -- LATA5 LATA4 -- LATA2 LATA1 LATA0 --xx xxxx --uu uuuu -- -- -- xxxx ---- uuuu ---- 10Dh 10Eh Working Register LATB(2) LATB(3) 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter -000 0000 -000 0000 Unimplemented LATB7 LATB6 LATB5 LATB4 -- -- -- LATC(2) -- -- LATC5 LATC4 LATC3 LATC2 LATC1 LATC0 --xx xxxx --uu uuuu LATC(3) LATC7 LATC6 LATC5 LATC4 LATC3 LATC2 LATC1 LATC0 xxxx xxxx uuuu uuuu 10Fh -- Unimplemented -- -- 110h -- Unimplemented -- -- 111h -- Unimplemented -- -- 112h -- Unimplemented -- -- 113h -- Unimplemented -- -- 114h -- Unimplemented -- -- 115h -- Unimplemented -- -- 116h BORCON SBOREN BORFS -- -- -- -- FVREN FVRRDY TSEN TSRNG -- -- -- BORRDY 10-- ---q uu-- ---u 117h FVRCON 118h -- Unimplemented -- -- 119h -- Unimplemented -- -- 11Ah -- Unimplemented -- -- 11Bh -- Unimplemented -- -- 11Ch -- Unimplemented -- -- 11Dh APFCON 11Eh -- Unimplemented -- -- 11Fh -- Unimplemented -- -- Legend: Note 1: 2: 3: 4: RXDTSEL SDOSEL SSSEL SDSEL -- TXCKSEL ADFVR<1:0> 0q00 --00 0q00 --00 GRDBSEL GRDASEL 0000 -000 0000 -000 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. DS40001761A-page 32 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 3 180h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) 181h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu 182h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 xxxx xxxx uuuu uuuu 183h STATUS(1) 184h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 185h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 186h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu 187h FSR1H(1) 188h BSR(1) -- -- -- TO PD Z DC C Indirect Data Memory Address 1 High Pointer -- -- -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 189h WREG(1) 18Ah PCLATH(1) -- 18Bh INTCON(1) GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 0000 0000 0000 0000 18Ch ANSELA -- -- ANSA5 ANSA4 -- ANSA2 ANSA1 ANSA0 1111 -111 1111 -111 -- -- -- 1111 ---- 1111 ---- 18Dh 18Eh Working Register ANSELB(2) ANSELB(3) 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter -000 0000 -000 0000 Unimplemented ANSB7 ANSB6 ANSB5 ANSB4 -- -- -- ANSELC(2) -- -- ANSC5 ANSC4 ANSC3 ANSC2 ANSC1 ANSC0 --11 1111 --11 1111 ANSELC(3) ANSC7 ANSC6 ANSC5 ANSC4 ANSC3 ANSC2 ANSC1 ANSC0 1111 1111 1111 1111 18Fh -- Unimplemented -- -- 190h -- Unimplemented -- -- 191h PMADRL 192h PMADRH 193h PMDATL 194h PMDATH -- -- 195h PMCON1 -- CFGS 196h PMCON2 197h -- Unimplemented -- -- 198h -- Unimplemented -- -- 199h RCREG USART Receive Data Register 0000 0000 0000 0000 19Ah TXREG USART Transmit Data Register 0000 0000 0000 0000 19Bh SPBRGL SPBRG Low 0000 0000 0000 0000 19Ch SPBRGH SPBRG High 19Dh RCSTA SPEN RX9 SREN CREN ADDEN FERR OERR RX9D 0000 000x 0000 000x 19Eh TXSTA CSRC TX9 TXEN SYNC SENDB BRGH TRMT TX9D 0000 0010 0000 0010 19Fh BAUDCON ABDOVF RCIDL -- SCKP BRG16 -- WUE ABDEN 01-0 0-00 01-0 0-00 Legend: Note 1: 2: 3: 4: Program Memory Address Register Low Byte -- 0000 0000 0000 0000 Program Memory Address Register High Byte 1000 0000 1000 0000 Program Memory Read Data Register Low Byte xxxx xxxx uuuu uuuu Program Memory Read Data Register High Byte LWLO FREE WRERR WREN WR --xx xxxx --uu uuuu RD Program Memory Control Register 2 -000 x000 -000 q000 0000 0000 0000 0000 0000 0000 0000 0000 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. 2014 Microchip Technology Inc. DS40001761A-page 33 PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 4 200h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) 201h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu 202h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 xxxx xxxx uuuu uuuu 203h STATUS(1) 204h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 205h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 206h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu 207h FSR1H(1) 208h BSR(1) -- -- -- TO PD Z DC C Indirect Data Memory Address 1 High Pointer -- -- -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 209h WREG(1) 20Ah PCLATH(1) -- GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 0000 0000 0000 0000 -- -- WPUA5 WPUA4 WPUA3 WPUA2 WPUA1 WPUA0 --11 1111 --11 1111 -- -- -- 1111 ---- 1111 ---- 20Bh INTCON(1) 20Ch WPUA 20Dh WPUB(2) WPUB(3) Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter -000 0000 -000 0000 Unimplemented WPUB7 WPUB6 WPUB5 WPUB4 -- -- -- 20Eh -- Unimplemented -- -- 20Fh -- Unimplemented -- -- 210h -- Unimplemented -- -- 211h SSPBUF Synchronous Serial Port Receive Buffer/Transmit Register xxxx xxxx uuuu uuuu 212h SSPADD Synchronous Serial Port (I2CTM mode) Address Register 0000 0000 0000 0000 213h SSPMSK Synchronous Serial Port (I2C mode) Address Mask Register 1111 1111 1111 1111 214h SSPSTAT SMP CKE D/A P S R/W UA BF 0000 0000 0000 0000 215h SSPCON1 WCOL SSPOV SSPEN CKP SSPM3 SSPM2 SSPM1 SSPM0 0000 0000 0000 0000 216h SSPCON2 GCEN ACKSTAT ACKDT ACKEN RCEN PEN RSEN SEN 0000 0000 0000 0000 217h SSPCON3 ACKTIM PCIE SCIE BOEN SDAHT SBCDE AHEN DHEN 0000 0000 0000 0000 218h -- Unimplemented -- -- 219h -- Unimplemented -- -- 21Ah -- Unimplemented -- -- 21Bh -- Unimplemented -- -- 21Ch -- Unimplemented -- -- 21Dh -- Unimplemented -- -- 21Eh -- Unimplemented -- -- 21Fh -- Unimplemented -- -- Legend: Note 1: 2: 3: 4: 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. DS40001761A-page 34 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 5 280h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) 281h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu 282h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 xxxx xxxx uuuu uuuu 283h STATUS(1) 284h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 285h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 286h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu 287h FSR1H(1) 288h BSR(1) -- -- -- TO PD Z DC C Indirect Data Memory Address 1 High Pointer -- 289h WREG(1) 28Ah PCLATH(1) -- GIE -- -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter -000 0000 -000 0000 28Bh INTCON(1) 28Ch -- Unimplemented -- -- 28Dh -- Unimplemented -- -- 28Eh -- Unimplemented -- -- 28Fh -- Unimplemented -- -- 290h -- Unimplemented -- -- 291h -- Unimplemented -- -- 292h -- Unimplemented -- -- 293h -- Unimplemented -- -- 294h -- Unimplemented -- -- 295h -- Unimplemented -- -- 296h -- Unimplemented -- -- 297h -- Unimplemented -- -- 298h -- Unimplemented -- -- 299h -- Unimplemented -- -- 29Ah -- Unimplemented -- -- 29Bh -- Unimplemented -- -- 29Ch -- Unimplemented -- -- 29Dh -- Unimplemented -- -- 29Eh -- Unimplemented -- -- 29Fh -- Unimplemented -- -- Legend: Note 1: 2: 3: 4: PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 0000 0000 0000 0000 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. 2014 Microchip Technology Inc. DS40001761A-page 35 PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 6 300h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) 301h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu 302h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 xxxx xxxx uuuu uuuu 303h STATUS(1) 304h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 305h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 306h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu 307h FSR1H(1) 308h BSR(1) -- -- -- TO PD Z DC C Indirect Data Memory Address 1 High Pointer -- 309h WREG(1) 30Ah PCLATH(1) -- GIE -- -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter -000 0000 -000 0000 30Bh INTCON(1) 30Ch -- Unimplemented -- -- 30Dh -- Unimplemented -- -- 30Eh -- Unimplemented -- -- 30Fh -- Unimplemented -- -- 310h -- Unimplemented -- -- 311h -- Unimplemented -- -- 312h -- Unimplemented -- -- 313h -- Unimplemented -- -- 314h -- Unimplemented -- -- 315h -- Unimplemented -- -- 316h -- Unimplemented -- -- 317h -- Unimplemented -- -- 318h -- Unimplemented -- -- 319h -- Unimplemented -- -- 31Ah -- Unimplemented -- -- 31Bh -- Unimplemented -- -- 31Ch -- Unimplemented -- -- 31Dh -- Unimplemented -- -- 31Eh -- Unimplemented -- -- 31Fh -- Unimplemented -- -- Legend: Note 1: 2: 3: 4: PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 0000 0000 0000 0000 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. DS40001761A-page 36 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 7 380h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) 381h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu 382h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 xxxx xxxx uuuu uuuu 383h STATUS(1) 384h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 385h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 386h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu 387h FSR1H(1) 388h BSR(1) -- -- -- TO PD Z DC C Indirect Data Memory Address 1 High Pointer -- 389h WREG(1) 38Ah PCLATH(1) -- GIE -- -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter -000 0000 -000 0000 38Bh INTCON(1) 38Ch -- Unimplemented -- -- 38Dh -- Unimplemented -- -- 38Eh -- Unimplemented -- -- 38Fh -- Unimplemented -- -- 390h -- Unimplemented -- -- 391h IOCAP -- -- IOCAP5 IOCAP4 IOCAP3 IOCAP2 IOCAP1 IOCAP0 --00 0000 --00 0000 392h IOCAN -- -- IOCAN5 IOCAN4 IOCAN3 IOCAN2 IOCAN1 IOCAN0 --00 0000 --00 0000 393h IOCAF -- -- IOCAF5 IOCAF4 IOCAF3 IOCAF2 IOCAF1 IOCAF0 --00 0000 --00 0000 -- -- -- 0000 ---- 0000 ---- -- -- -- 0000 ---- 0000 ---- -- -- -- 0000 ---- 0000 ---- 394h 395h 396h PEIE TMR0IE IOCBP(2) IOCBP(3) IOCBP7 IOCBP6 IOCBP5 IOCBP4 IOCBN7 IOCBN6 IOCBN5 IOCBN4 TMR0IF INTF IOCIF IOCBF7 IOCBF6 IOCBF5 IOCBF4 -- -- -- Unimplemented -- 0000 0000 0000 0000 -- Unimplemented IOCBF(2) IOCBF(3) IOCIE Unimplemented IOCBN(2) IOCBN(3) INTE -- -- -- -- 397h -- Unimplemented -- -- 398h -- Unimplemented -- -- 399h -- Unimplemented -- -- 39Ah -- Unimplemented -- -- 39Bh -- Unimplemented -- -- 39Ch -- Unimplemented -- -- 39Dh -- Unimplemented -- -- 39Eh -- Unimplemented -- -- 39Fh -- Unimplemented -- -- Legend: Note 1: 2: 3: 4: 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. 2014 Microchip Technology Inc. DS40001761A-page 37 PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Banks 8-11 x00h/ x80h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) xxxx xxxx uuuu uuuu x00h/ x81h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu x02h/ x82h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 x03h/ x83h STATUS(1) x04h/ x84h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 0000 0000 uuuu uuuu x05h/ x85h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 x06h/ x86h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu x07h/ x87h FSR1H(1) Indirect Data Memory Address 1 High Pointer 0000 0000 0000 0000 x08h/ x88h BSR(1) x09h/ x89h WREG(1) x0Ah/ x8Ah PCLATH(1) -- x0Bh/ x8Bh INTCON(1) GIE x0Ch/ x8Ch -- x1Fh/ x9Fh -- Legend: Note 1: 2: 3: 4: -- -- -- -- -- TO PD -- Z DC C BSR<4:0> ---0 0000 ---0 0000 Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter PEIE TMR0IE INTE IOCIE Unimplemented ---1 1000 ---q quuu TMR0IF INTF -000 0000 -000 0000 IOCIF 0000 000x 0000 000u -- -- 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. DS40001761A-page 38 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 12 600h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) 601h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu 602h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 xxxx xxxx uuuu uuuu 603h STATUS(1) 604h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 605h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 606h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu 607h FSR1H(1) 608h BSR(1) -- -- -- TO PD Z DC C Indirect Data Memory Address 1 High Pointer -- 609h WREG(1) 60Ah PCLATH(1) -- GIE -- -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter -000 0000 -000 0000 60Bh INTCON(1) 60Ch -- Unimplemented -- -- 60Dh -- Unimplemented -- -- 60Eh -- Unimplemented -- -- 60Fh -- Unimplemented -- -- 610h -- Unimplemented -- -- 611h PWM1DCL PEIE PWM1DCL<7:6> TMR0IE -- INTE -- IOCIE -- TMR0IF -- INTF IOCIF -- -- 00-- ---- 00-- ---- 612h PWM1DCH 613h PWM1CON 614h PWM2DCL 615h PWM2DCH 616h PWM2CON 617h -- Unimplemented -- -- 618h -- Unimplemented -- -- 619h -- Unimplemented -- -- 61Ah -- Unimplemented -- -- 61Bh -- Unimplemented -- -- 61Ch -- Unimplemented -- -- 61Dh -- Unimplemented -- -- 61Eh -- Unimplemented -- -- 61Fh -- Unimplemented -- -- Legend: Note 1: 2: 3: 4: PWM 1 Duty Cycle Register (MSB) (PWM1DC<9:2>) 0000 0000 0000 0000 PWM1EN PWM1OE PWM2DCL<7:6> xxxx xxxx uuuu uuuu PWM1OUT PWM1POL -- -- -- -- 0000 ---- 0000 ---- -- -- -- -- -- -- 00-- ---- 00-- ---- -- -- PWM 2 Duty Cycle Register (MSB) (PWM2DC<9:2>) PWM2EN PWM2OE PWM2OUT PWM2POL -- -- xxxx xxxx uuuu uuuu 0000 ---- 0000 ---- 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. 2014 Microchip Technology Inc. DS40001761A-page 39 PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Banks 13 x00h/ x80h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) xxxx xxxx uuuu uuuu x00h/ x81h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu x02h/ x82h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 x03h/ x83h STATUS(1) x04h/ x84h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 0000 0000 uuuu uuuu x05h/ x85h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 x06h/ x86h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu x07h/ x87h FSR1H(1) Indirect Data Memory Address 1 High Pointer 0000 0000 0000 0000 x08h/ x88h BSR(1) x09h/ x89h WREG(1) x0Ah/ x8Ah PCLATH(1) -- x0Bh/ x8Bh INTCON(1) GIE x0Ch/ x8Ch -- x1Fh/ x9Fh -- Legend: Note 1: 2: 3: 4: -- -- -- -- -- TO PD -- Z DC C BSR<4:0> ---0 0000 ---0 0000 Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter PEIE TMR0IE INTE IOCIE Unimplemented ---1 1000 ---q quuu TMR0IF INTF -000 0000 -000 0000 IOCIF 0000 000x 0000 000u -- -- 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. DS40001761A-page 40 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 14 700h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) 701h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu 702h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 xxxx xxxx uuuu uuuu 703h STATUS(1) 704h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 705h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 706h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu 707h FSR1H(1) 708h BSR(1) -- -- -- TO PD Z DC C Indirect Data Memory Address 1 High Pointer -- 709h WREG(1) 70Ah PCLATH(1) -- GIE -- -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter -000 0000 -000 0000 70Bh INTCON(1) 70Ch -- Unimplemented -- -- 70Dh -- Unimplemented -- -- 70Eh -- Unimplemented -- -- 70Fh -- Unimplemented -- -- 710h -- Unimplemented -- -- 711h AD1CON0/ AAD1CON0(4) -- 712h AADCON1/ ADCOMCON(4) ADFM 713h AD1CON2/ AAD1CON2(4) -- PEIE CHS14 TMR0IE INTE CHS13 IOCIE CHS12 TMR0IF INTF CHS11 CHS10 GO/DONE1 ADCS<2:0> -- GO/ DONE_ALL TRIGSEL1<2:0> -- -- -- -- -- AD1IPEN -- AD1CONV IOCIF AD1ON ADPREF<1:0> -- 0000 000x 0000 000u -000 0000 -000 0000 0000 -000 0000 -000 -000 ---- -000 ---- 714h AAD1CON3 AD1EPPOL AD1IPPOL 715h AADSTAT -- AD2CONV 716h AAD1PRE -- AD1PRE<6:0> 717h AAD1ACQ -- AAD1ACQ<6:0> 718h AAD1GRD GRD1BOE GRD1AOE GRD1POL -- 719h AAD1CAP -- -- -- -- 71Ah AD1RES0L/ AAD1RES0L(4) ADC Result 0 Register Low xxxx xxxx uuuu uuuu 71Bh AD1RES0H/ AAD1RES0H(4) ADC Result 0 Register High xxxx xxxx uuuu uuuu 71Ch AD1RES1L/ AAD1RES1L ADC Result 1 Register Low xxxx xxxx uuuu uuuu 71Dh AD1RES1H/ AAD1RES1H ADC Result 1 Register High xxxx xxxx uuuu uuuu 71Eh 71Fh Legend: Note 1: 2: 3: 4: -- -- AD2STG<1:0> -- AD1DSEN 00-- --00 00-- --00 AD1STG<1:0> -000 -000 -000 -000 -000 0000 -000 0000 -000 0000 -000 0000 -- -- -- ADD1CAP<3:0> 000- ---- 000- ------- 0000 ---- 0000 AAD1CH(2) -- -- -- -- CH13 CH12 CH11 CH10 ---- 0000 ---- 0000 AAD1CH(3) -- CH16 CH15 CH14 CH13 CH12 CH11 CH10 -000 0000 -000 0000 -- Unimplemented -- -- 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. 2014 Microchip Technology Inc. DS40001761A-page 41 PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 15 780h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) 781h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu 782h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 xxxx xxxx uuuu uuuu 783h STATUS(1) 784h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 785h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 786h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu 787h FSR1H(1) 788h BSR(1) -- -- -- TO PD Z DC C Indirect Data Memory Address 1 High Pointer -- 789h WREG(1) 78Ah PCLATH(1) -- GIE -- -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter -000 0000 -000 0000 78Bh INTCON(1) 78Ch -- Unimplemented -- -- 78Dh -- Unimplemented -- -- 78Eh -- Unimplemented -- -- 78Fh -- Unimplemented -- -- 790h -- Unimplemented -- -- 791h AD2CON0/ AAD2CON0 -- 792h -- 793h AD2CON2/ AAD2CON2 -- AD2EPPOL PEIE TMR0IE CHS24 CHS23 INTE IOCIE CHS22 CHS21 TMR0IF CHS20 INTF GO/DONE2 IOCIF AD2ON Unimplemented TRIG2SEL1<2:0> -000 0000 -000 0000 -- -- -- -- -- -- AD2IPEN -- -- -000 ---- -000 ---- 794h AAD2CON3 795h -- 796h AAD2PRE 797h AAD2ACQ -- 798h AAD2GRD GRD2BOE GRD2AOE GRD2POL -- 799h AAD2CAP -- -- -- -- 79Ah AD2RES0L/ AAD2RES0L ADC 2 Result 0 Register Low xxxx xxxx uuuu uuuu 79Bh AD2RES0H/ AAD2RES0H ADC 2 Result 0 Register High xxxx xxxx uuuu uuuu 79Ch AD2RES1L/ AAD2RES1L ADC 2 Result 1 Register Low xxxx xxxx uuuu uuuu 79Dh AD2RES1H/ AAD2RES1H ADC 2 Result 1 Register High xxxx xxxx uuuu uuuu 79Eh 79Fh Legend: Note 1: 2: 3: 4: AD2IPPOL 0000 000x 0000 000u -- -- AD2DSEN 00-- --00 00-- --00 Unimplemented -- -- AD2PRE<6:0> AAD2ACQ<6:0> -- -- -000 0000 -000 0000 -000 0000 -000 0000 -- -- -- ADD2CAP<3:0> 000- ---- 000- ------- 0000 ---- 0000 AAD2CH(2) -- -- -- -- CH23 CH22 CH21 CH20 ---- 0000 ---- 0000 AAD2CH(3) -- CH26 CH25 CH24 CH23 CH22 CH21 CH20 -000 0000 -000 0000 -- Unimplemented -- -- 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. DS40001761A-page 42 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Banks 16-30 x00h/ x80h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) xxxx xxxx uuuu uuuu x00h/ x81h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu x02h/ x82h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 x03h/ x83h STATUS(1) x04h/ x84h FSR0L(1) Indirect Data Memory Address 0 Low Pointer 0000 0000 uuuu uuuu x05h/ x85h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 x06h/ x86h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu x07h/ x87h FSR1H(1) Indirect Data Memory Address 1 High Pointer 0000 0000 0000 0000 x08h/ x88h BSR(1) x09h/ x89h WREG(1) x0Ah/ x8Ah PCLATH(1) -- x0Bh/ x8Bh INTCON(1) GIE Legend: Note 1: 2: 3: 4: -- -- -- -- -- TO PD -- Z DC C BSR<4:0> ---0 0000 ---0 0000 Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter PEIE TMR0IE INTE IOCIE ---1 1000 ---q quuu TMR0IF INTF -000 0000 -000 0000 IOCIF 0000 0000 0000 0000 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. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. 2014 Microchip Technology Inc. DS40001761A-page 43 PIC16LF1554/1559 TABLE 3-9: Address SPECIAL FUNCTION REGISTER SUMMARY (CONTINUED) Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Value on: POR, BOR Value on all other Resets Bank 31 F80h INDF0(1) Addressing this location uses contents of FSR0H/FSR0L to address data memory (not a physical register) F81h INDF1(1) Addressing this location uses contents of FSR1H/FSR1L to address data memory (not a physical register) xxxx xxxx uuuu uuuu F82h PCL(1) Program Counter (PC) Least Significant Byte 0000 0000 0000 0000 xxxx xxxx uuuu uuuu F83h STATUS(1) F84h FSR0L(1) Indirect Data Memory Address 0 Low Pointer F85h FSR0H(1) Indirect Data Memory Address 0 High Pointer 0000 0000 0000 0000 F86h FSR1L(1) Indirect Data Memory Address 1 Low Pointer 0000 0000 uuuu uuuu F87h FSR1H(1) F88h BSR(1) -- WREG(1) F8Ah PCLATH(1) -- GIE F8Bh INTCON(1) -- FE3h -- FE4h STATUS_SHAD -- TO PD Z DC C -- -- 0000 0000 0000 0000 BSR<4:0> ---0 0000 ---0 0000 Working Register 0000 0000 uuuu uuuu Write Buffer for the upper 7 bits of the Program Counter PEIE TMR0IE INTE IOCIE TMR0IF INTF -000 0000 -000 0000 IOCIF Unimplemented Unimplemented -- -- -- FE5h WREG_SHAD FE6h BSR_SHAD -- FE7h PCLATH_SHAD -- -- -- -- Z DC Working Register Normal (Non-ICD) Shadow -- ---1 1000 ---q quuu 0000 0000 uuuu uuuu Indirect Data Memory Address 1 High Pointer -- F89h F8Ch -- FE2h -- C 0000 0000 0000 0000 -- -- -- -- ---- -xxx ---- -uuu xxxx xxxx uuuu uuuu Bank Select Register Normal (Non-ICD) Shadow Program Counter Latch High Register Normal (Non-ICD) Shadow ---x xxxx ---u uuuu -xxx xxxx uuuu uuuu FE8h FSR0L_SHAD Indirect Data Memory Address 0 Low Pointer Normal (Non-ICD) Shadow xxxx xxxx uuuu uuuu FE9h FSR0H_SHAD Indirect Data Memory Address 0 High Pointer Normal (Non-ICD) Shadow xxxx xxxx uuuu uuuu FEAh FSR1L_SHAD Indirect Data Memory Address 1 Low Pointer Normal (Non-ICD) Shadow xxxx xxxx uuuu uuuu FEBh FSR1H_SHAD Indirect Data Memory Address 1 High Pointer Normal (Non-ICD) Shadow xxxx xxxx uuuu uuuu FECh -- FEDh STKPTR Unimplemented FEEh TOSL FEFh TOSH Legend: Note 1: 2: 3: 4: -- -- -- -- Current Stack pointer Top of Stack Low byte -- 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'. These registers can be accessed from any bank. PIC16LF1554. PIC16LF1559. These registers/bits are available at two address locations, in Bank 1 and Bank 14. DS40001761A-page 44 2014 Microchip Technology Inc. PIC16LF1554/1559 3.3 3.3.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 3-4 shows the five situations for the loading of the PC. FIGURE 3-4: 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 ALU result 14 PCH PCL 0 PC 6 4 0 PCLATH GOTO, CALL 11 OPCODE <10:0> 14 PCH PCL 0 PC 6 7 0 PCLATH 14 PCH CALLW 8 W PCL 0 PCL 0 PC BRW 15 PC + W 14 PCH PC BRA 15 PC + OPCODE <8:0> 3.3.1 COMPUTED GOTO 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). 3.3.3 COMPUTED FUNCTION CALLS 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). 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>. 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. 3.3.4 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. 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. If using BRA, the entire PC will be loaded with PC + 1 + the signed value of the operand of the BRA instruction. 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. 2014 Microchip Technology Inc. DS40001761A-page 45 PIC16LF1554/1559 3.4 3.4.1 Stack All devices have a 16-level x 15-bit wide hardware stack (refer to Figure 3-5 through Figure 3-8). 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 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 3-5: ACCESSING THE STACK The stack is available 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 5 bits to allow detection of overflow and underflow. 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. At any time STKPTR can be inspected to see how much stack is left. 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 and then decrement the STKPTR. Reference Figure 3-5 through Figure 3-8 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 DS40001761A-page 46 0x1F 0x0000 STKPTR = 0x1F Stack Reset Enabled (STVREN = 1) 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 3-6: 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 3-7: 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 2014 Microchip Technology Inc. 0x06 Return Address 0x05 Return Address 0x04 Return Address 0x03 Return Address 0x02 Return Address 0x01 Return Address 0x00 Return Address STKPTR = 0x06 DS40001761A-page 47 PIC16LF1554/1559 FIGURE 3-8: ACCESSING THE STACK EXAMPLE 4 Rev. 10-000043D 7/30/2013 TOSH:TOSL 3.4.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 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. DS40001761A-page 48 2014 Microchip Technology Inc. PIC16LF1554/1559 3.5 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. FIGURE 3-9: 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 Data Memory * Linear Data Memory * Program Flash Memory INDIRECT ADDRESSING Rev. 10-000044A 7/30/2013 0x0000 0x0000 Traditional Data Memory 0x0FFF 0x1000 0x0FFF Reserved 0x1FFF 0x2000 Linear Data Memory 0x29AF 0x29B0 Reserved FSR Address Range 0x7FFF 0x8000 0x0000 Program Flash Memory 0xFFFF Note: 0x7FFF Not all memory regions are completely implemented. Consult device memory tables for memory limits. 2014 Microchip Technology Inc. DS40001761A-page 49 PIC16LF1554/1559 3.5.1 TRADITIONAL DATA MEMORY The traditional data memory is a region from FSR address 0x000 to FSR address 0xFFF. The addresses correspond to the absolute addresses of all SFR, GPR and common registers. FIGURE 3-10: TRADITIONAL DATA MEMORY MAP Rev. 10-000056A 7/31/2013 Direct Addressing 4 BSR 0 Indirect Addressing From Opcode 6 0 Bank Select 7 FSRxH 0 0 0 0 Location Select 0x00 00000 Bank Select 00001 00010 11111 Bank 0 Bank 1 Bank 2 Bank 31 0 7 FSRxL 0 Location Select 0x7F DS40001761A-page 50 2014 Microchip Technology Inc. PIC16LF1554/1559 3.5.2 LINEAR DATA MEMORY The linear data memory is the region from FSR address 0x2000 to FSR address 0x29AF. This region is a virtual region that points back to the 80-byte blocks of GPR memory in all the banks. 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 3-11: LINEAR DATA MEMORY MAP 3.5.3 PROGRAM FLASH MEMORY 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 3-12: PROGRAM FLASH MEMORY MAP Rev. 10-000058A 7/31/2013 Rev. 10-000057A 7/31/2013 7 FSRnH 0 0 1 0 Location Select 7 FSRnL 7 1 0 FSRnH 0 Location Select 0x2000 7 FSRnL 0 0x8000 0x020 Bank 0 0x06F 0x0A0 Bank 1 0x0EF Program Flash Memory (low 8 bits) 0x120 Bank 2 0x16F 0x29AF 2014 Microchip Technology Inc. 0x0000 0xF20 Bank 30 0xF6F 0xFFFF 0x7FFF DS40001761A-page 51 PIC16LF1554/1559 4.0 DEVICE CONFIGURATION Device configuration consists of Configuration Words, Code Protection and Device ID. 4.1 Configuration Words There are several Configuration Word bits that allow different oscillator and memory protection options. These are implemented as Configuration Word 1 at 8007h and Configuration Word 2 at 8008h. Note: 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'. DS40001761A-page 52 2014 Microchip Technology Inc. PIC16LF1554/1559 4.2 Register Definitions: Configuration Words REGISTER 4-1: CONFIG1: CONFIGURATION WORD 1 U-1 -- U-1 R/P-1 -- CLKOUTEN R/P-1 R/P-1 U-1 BOREN<1:0> -- bit 13 R/P-1 R/P-1 R/P-1 CP MCLRE PWRTE bit 8 R/P-1 R/P-1 WDTE<1:0> U-1 R/P-1 -- R/P-1 FOSC<1:0> bit 7 bit 0 Legend: R = Readable bit P = Programmable bit U = Unimplemented bit, read as `1' `0' = Bit is cleared `1' = Bit is set -n = Value when blank or after Bulk Erase bit 13-12 Unimplemented: Read as `1' bit 11 CLKOUTEN: Clock Out Enable bit 1 = CLKOUT function is disabled. I/O function on the CLKOUT pin 0 = CLKOUT function is enabled on the CLKOUT pin bit 10-9 BOREN<1:0>: Brown-Out Reset Enable bits(1) 11 = BOR enabled 10 = BOR enabled during operation and disabled in Sleep 01 = BOR controlled by SBOREN bit of the BORCON register 00 = BOR disabled bit 8 Unimplemented: Read as `1' bit 7 CP: Code Protection bit(2) 1 = Program memory code protection is disabled 0 = Program memory code protection is enabled bit 6 MCLRE: MCLR/VPP Pin Function Select bit If LVP bit = 1: This bit is ignored. If LVP bit = 0: 1 = MCLR/VPP pin function is MCLR; Weak pull-up enabled. 0 = MCLR/VPP pin function is digital input; MCLR internally disabled; Weak pull-up under control of WPUA3 bit. bit 5 PWRTE: Power-Up Timer Enable bit 1 = PWRT disabled 0 = PWRT enabled bit 4-3 WDTE<1:0>: Watchdog Timer Enable bits 11 = WDT enabled 10 = WDT enabled while running and disabled in Sleep 01 = WDT controlled by the SWDTEN bit in the WDTCON register 00 = WDT disabled bit 2 Unimplemented: Read as `1' bit 1-0 FOSC<1:0>: Oscillator Selection bits 11 = ECH: External Clock, High-Power mode: on CLKIN pin 10 = ECM: External Clock, Medium-Power mode: on CLKIN pin 01 = ECL: External Clock, Low-Power mode: on CLKIN pin 00 = INTOSC oscillator: I/O function on CLKIN Note 1: 2: Enabling Brown-out Reset does not automatically enable Power-up Timer. Once enabled, code-protect can only be disabled by bulk erasing the device. 2014 Microchip Technology Inc. DS40001761A-page 53 PIC16LF1554/1559 REGISTER 4-2: CONFIG2: CONFIGURATION WORD 2 R/P-1 R/P-1 R/P-1 R/P-1 R/P-1 U-1 LVP DEBUG LPBOR BORV STVREN -- bit 13 bit 8 U-1 U-1 U-1 U-1 U-1 U-1 -- -- -- -- -- -- R/P-1 R/P-1 WRT<1:0> bit 7 bit 0 Legend: R = Readable bit P = Programmable bit U = Unimplemented bit, read as `1' `0' = Bit is cleared `1' = Bit is set -n = Value when blank or after Bulk Erase bit 13 LVP: Low-Voltage Programming Enable bit(1) 1 = Low-voltage programming enabled 0 = High-voltage on MCLR must be used for programming bit 12 DEBUG: In-Circuit Debugger Mode bit(2) 1 = In-Circuit Debugger disabled, ICSPCLK and ICSPDAT are general purpose I/O pins 0 = In-Circuit Debugger enabled, ICSPCLK and ICSPDAT are dedicated to the debugger bit 11 LPBOR: Low-Power BOR Enable bit 1 = Low-Power Brown-out Reset is disabled 0 = Low-Power Brown-out Reset is enabled bit 10 BORV: Brown-Out Reset Voltage Selection bit(3) 1 = Brown-out Reset voltage (VBOR), low trip point selected 0 = Brown-out Reset voltage (VBOR), high trip point selected bit 9 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 8-2 Unimplemented: Read as `1' bit 1-0 WRT<1:0>: Flash Memory Self-Write Protection bits 4 kW Flash memory (PIC16LF1554 only) 11 = Write protection off 10 = 000h to 1FFh write protected, 200h to FFFh may be modified 01 = 000h to 7FFh write protected, 800h to FFFh may be modified 00 = 000h to FFFh write protected, no addresses may be modified 8 kW Flash memory (PIC16LF1559 only) 11 = Write protection off 10 = 000h to 01FFh write protected, 0200h to 1FFFh may be modified 01 = 000h to 0FFFh write protected, 1000h to 1FFFh may be modified 00 = 000h to 1FFFh write protected, no addresses may be modified Note 1: 2: 3: The LVP bit cannot be programmed to `0' when Programming mode is entered via LVP. 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'. See VBOR parameter for specific trip point voltages. DS40001761A-page 54 2014 Microchip Technology Inc. PIC16LF1554/1559 4.3 Code Protection 4.5 Code protection allows the device to be protected from unauthorized access. Internal access to the program memory is unaffected by any code protection setting. 4.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. Writing the program memory is dependent upon the write protection setting. See Section 4.4 "Write Protection" for more information. 4.4 Write Protection Write protection allows the device to be protected from unintended self-writes. Applications, such as bootloader software, can be protected while allowing other regions of the program memory to be modified. 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 10.4 "User ID, Device ID and Configuration Word Access" for more information on accessing these memory locations. For more information on checksum calculation, see the "PIC16LF1554/1559 Memory Programming Specification" (DS40001743). 4.6 Device ID and Revision ID The memory location 8006h is where the Device ID and Revision ID are stored. The upper nine bits hold the Device ID. The lower five bits hold the Revision ID. See Section 10.4 "User ID, Device ID and Configuration Word Access" for more information on accessing these memory locations. Development tools, such as device programmers and debuggers, may be used to read the Device ID and Revision ID. The WRT<1:0> bits in Configuration Words define the size of the program memory block that is protected. 4.7 Register Definitions: Device ID REGISTER 4-3: DEVID: DEVICE ID REGISTER R R R R R R DEV<8:3> bit 13 R R bit 8 R R R DEV<2:0> R R R REV<4:0> bit 7 bit 0 Legend: R = Readable bit `1' = Bit is set bit 13-5 `0' = Bit is cleared DEV<8:0>: Device ID bits DEVID<13:0> Values Device bit 4-0 DEV<8:0> REV<4:0> PIC16LF1554 0010 1111 000 x xxxx PIC16LF1559 0010 1111 001 x xxxx REV<4:0>: Revision ID bits These bits are used to identify the revision (see Table above under DEV<8:0>). 2014 Microchip Technology Inc. DS40001761A-page 55 PIC16LF1554/1559 5.0 OSCILLATOR MODULE The oscillator module can be configured in one of the following clock modes. 5.1 Overview 1. 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 5-1 illustrates a block diagram of the oscillator module. ECL - External Clock Low-Power mode (0 MHz to 0.5 MHz) ECM - External Clock Medium-Power mode (0.5 MHz to 4 MHz) ECH - External Clock High-Power mode (4 MHz to 20 MHz) INTOSC - Internal oscillator (31 kHz to 32 MHz) 2. 3. 4. Clock source modes are selected by the FOSC<1:0> bits in the Configuration Words. The FOSC bits determine the type of oscillator that will be used when the device is first powered. Clock sources can be supplied from external clock oscillators. 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: The EC clock mode relies on an external logic level signal as the device clock source. * Selectable system clock source between external or internal sources via software. The INTOSC internal oscillator block produces low and high-frequency clock sources, designated LFINTOSC and HFINTOSC (see Internal Oscillator Block, Figure 5-1). A wide selection of device clock frequencies may be derived from these clock sources. SIMPLIFIED PIC(R) MCU CLOCK SOURCE BLOCK DIAGRAM FIGURE 5-1: CLKIN EC Sleep CPU and MUX 4x PLL IRCF<3:0> Peripherals INTOSC 16 MHz Primary OSC 31 kHz Source DS40001761A-page 56 MUX Start-up Control Logic Postscaler 4 16 MHz 8 MHz 4 MHz 2 MHz 1 MHz 500 kHz 250 kHz 125 kHz 62.5 kHz 31.25 kHz 31 kHz Clock Control 2 FOSC<1:0> 2 SCS<1:0> WDT, PWRT and other Modules 2014 Microchip Technology Inc. PIC16LF1554/1559 5.2 5.2.1.1 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 (EC mode). Internal clock sources are contained within the oscillator module. The oscillator block has two internal oscillators that are used to generate two system clock sources: the 16 MHz High-Frequency Internal Oscillator (HFINTOSC) and the 31 kHz Low-Frequency Internal Oscillator (LFINTOSC). The system clock can be selected between external or internal clock sources via the System Clock Select (SCS) bits in the OSCCON register. See Section 5.3 "Clock Switching" for additional information. 5.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 FOSC<1: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. * Clear the SCS<1:0> bits in the OSCCON register to switch the system clock source to: - An external clock source determined by the value of the FOSC bits. See Section 5.3 information. "Clock Switching" 2014 Microchip Technology Inc. for 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 CLKIN input. CLKOUT is available for general purpose I/O or CLKOUT. Figure 5-2 shows the pin connections for EC mode. EC mode has three power modes to select from through Configuration Words: * High power, 4-20 MHz (FOSC = 11) * Medium power, 0.5-4 MHz (FOSC = 10) * Low power, 0-0.5 MHz (FOSC = 01) When EC mode is selected, 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 5-2: Clock from Ext. System FOSC/4 or I/O(1) EXTERNAL CLOCK (EC) MODE OPERATION CLKIN PIC(R) MCU CLKOUT more Note 1: Output depends upon CLKOUTEN bit of the Configuration Words. DS40001761A-page 57 PIC16LF1554/1559 5.2.2 INTERNAL CLOCK SOURCES The device may be configured to use the internal oscillator block as the system clock by performing either of the following actions: * Program the FOSC<1:0> bits in Configuration Words to select the INTOSC clock source, which will be used as the default system clock upon a device Reset. * Set the SCS<1:0> bits in the OSCCON register to `1x' to switch the system clock source to the internal oscillator during run-time. See Section 5.3 "Clock Switching" for more information. In INTOSC mode, the CLKIN pin is available for general purpose I/O. The CLKOUT pin 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. 1. 2. The HFINTOSC (High-Frequency Internal Oscillator) is factory calibrated and operates at 16 MHz. The LFINTOSC (Low-Frequency Internal Oscillator) is uncalibrated and operates at 31 kHz. 5.2.2.1 HFINTOSC 5.2.2.2 LFINTOSC The Low-Frequency Internal Oscillator (LFINTOSC) is an uncalibrated 31 kHz internal clock source. The output of the LFINTOSC connects to a multiplexer (see Figure 5-1). Select 31 kHz, via software, using the IRCF<3:0> bits of the OSCCON register. See Section 5.2.2.4 "Internal Oscillator Clock Switch Timing" for more information. The LFINTOSC is also the source for the Power-up Timer (PWRT) and Watchdog Timer (WDT). The LFINTOSC is enabled by selecting 31 kHz (IRCF<3:0> bits of the OSCCON register = 000x) as the system clock source (SCS bits of the OSCCON register = 1x), or when any of the following are enabled: * Configure the IRCF<3:0> bits of the OSCCON register for the LF frequency, and * FOSC<1:0> = 00, or * Set the System Clock Source (SCS) bits of the OSCCON register to `1x' Peripherals that use the LFINTOSC are: * Power-up Timer (PWRT) * Watchdog Timer (WDT) The Low-Frequency Internal Oscillator Ready bit (LFIOFR) of the OSCSTAT register indicates when the LFINTOSC is running. The High-Frequency Internal Oscillator (HFINTOSC) is a factory calibrated 16 MHz internal clock source. The outputs of the HFINTOSC connects to a prescaler and multiplexer (see Figure 5-1). One of multiple frequencies derived from the HFINTOSC can be selected via software using the IRCF<3:0> bits of the OSCCON register. See Section 5.2.2.4 "Internal Oscillator Clock Switch Timing" for more information. The HFINTOSC is enabled by: * Configure the IRCF<3:0> bits of the OSCCON register for the desired HF frequency, and * FOSC<1:0> = 00, or * Set the System Clock Source (SCS) bits of the OSCCON register to `1x'. A fast start-up oscillator allows internal circuits to power-up and stabilize before switching to HFINTOSC. The High-Frequency Internal Oscillator Ready bit (HFIOFR) of the OSCSTAT register indicates when the HFINTOSC is running. The High-Frequency Internal Oscillator Stable bit (HFIOFS) of the OSCSTAT register indicates when the HFINTOSC is running within 0.5% of its final value. DS40001761A-page 58 2014 Microchip Technology Inc. PIC16LF1554/1559 5.2.2.3 Internal Oscillator Frequency Selection The system clock speed can be selected via software using the Internal Oscillator Frequency Select bits IRCF<3:0> of the OSCCON register. The outputs of the 16 MHz HFINTOSC postscaler and the LFINTOSC connect to a multiplexer (see Figure 5-1). The Internal Oscillator Frequency Select bits IRCF<3:0> of the OSCCON register select the frequency. One of the following frequencies can be selected via software: - 32 MHz (requires 4x PLL) 16 MHz 8 MHz 4 MHz 2 MHz 1 MHz 500 kHz (default after Reset) 250 kHz 125 kHz 62.5 kHz 31.25 kHz 31 kHz (LFINTOSC) Note: Following any Reset, the IRCF<3:0> bits of the OSCCON register are set to `0111' and the frequency selection is set to 500 kHz. The user can modify the IRCF bits to select a different frequency. The IRCF<3:0> bits of the OSCCON register allow duplicate selections for some frequencies. These duplicate choices can offer system design trade-offs. Lower power consumption can be obtained when changing oscillator sources for a given frequency. Faster transition times can be obtained between frequency changes that use the same oscillator source. 5.2.2.4 Internal Oscillator Clock Switch Timing When switching between the HFINTOSC and the LFINTOSC, the new oscillator may already be shut down to save power (see Figure 5-3). If this is the case, there is a delay after the IRCF<3:0> bits of the OSCCON register are modified before the frequency selection takes place. The OSCSTAT register will reflect the current active status of the HFINTOSC and LFINTOSC oscillators. The sequence of a frequency selection is as follows: 1. 2. 3. 4. IRCF<3:0> bits of the OSCCON register are modified. If the new clock is shut down, a clock start-up delay is started. Clock switch circuitry waits for a falling edge of the current clock. Clock switch is complete. See Figure 5-3 for more details. If the internal oscillator speed is switched between two clocks of the same source, there is no start-up delay before the new frequency is selected. Start-up delay specifications are located in the oscillator tables of Section 25.0 "Electrical Specifications". 5.2.2.5 32 MHz Internal Oscillator Frequency Selection The Internal Oscillator Block can be used with the 4x PLL to produce a 32 MHz internal system clock source. The following settings are required to use the 32 MHz internal clock source: * The FOSC bits in Configuration Word 1 must be set to use the INTOSC source as the device system clock (FOSC<1:0> = 00). * The SCS bits in the OSCCON register must be cleared to use the clock determined by FOSC<1:0> in Configuration Word 1 (SCS<1:0> = 00). * The IRCF bits in the OSCCON register must be set to the 8 MHz HFINTOSC set to use (IRCF<3:0> = 1110). * The SPLLEN bit in the OSCCON register must be set to enable the 4x PLL. The 4x PLL is not available for use with the internal oscillator when the SCS bits of the OSCCON register are set to `1x'. The SCS bits must be set to `00' to use the 4x PLL with the internal oscillator. 2014 Microchip Technology Inc. DS40001761A-page 59 PIC16LF1554/1559 FIGURE 5-3: HFINTOSC INTERNAL OSCILLATOR SWITCH TIMING LFINTOSC (WDT disabled) HFINTOSC Start-up Time 2-cycle Sync Running 2-cycle Sync Running LFINTOSC 0 IRCF <3:0> 0 System Clock HFINTOSC LFINTOSC (WDT enabled) HFINTOSC LFINTOSC 0 IRCF <3:0> 0 System Clock LFINTOSC HFINTOSC LFINTOSC turns off unless WDT is enabled LFINTOSC Start-up Time 2-cycle Sync Running HFINTOSC IRCF <3:0> =0 0 System Clock DS40001761A-page 60 2014 Microchip Technology Inc. PIC16LF1554/1559 5.3 5.3.1 Clock Switching The system clock source can be switched between external and internal clock sources via software using the System Clock Select (SCS) bits of the OSCCON register. The following clock sources can be selected using the SCS bits: SYSTEM CLOCK SELECT (SCS) BITS The System Clock Select (SCS) bits of the OSCCON register selects the system clock source that is used for the CPU and peripherals. * When the SCS bits of the OSCCON register = 00, the system clock source is determined by value of the FOSC<1:0> bits in the Configuration Words. * When the SCS bits of the OSCCON register = 1x, the system clock source is chosen by the internal oscillator frequency selected by the IRCF<3:0> bits of the OSCCON register. After a Reset, the SCS bits of the OSCCON register are always cleared. * Default system oscillator determined by FOSC bits in Configuration Words * Internal Oscillator Block (INTOSC) When switching between clock sources, a delay is required to allow the new clock to stabilize. These oscillator delays are shown in Table 5-1. TABLE 5-1: OSCILLATOR SWITCHING DELAYS Switch From Switch To Frequency Oscillator Delay LFINTOSC HFINTOSC 31 kHz 31.25 kHz-32 MHz EC DC - 20 MHz EC DC - 20 MHz 1 cycle of each Any clock source HFINTOSC 31.25 kHz-16 MHz 2 s (approx.) Any clock source LFINTOSC 31 kHz 1 cycle of each Sleep/POR LFINTOSC 2014 Microchip Technology Inc. 2 cycles DS40001761A-page 61 PIC16LF1554/1559 5.4 Register Definitions: Oscillator Control REGISTER 5-1: R/W-0/0 OSCCON: OSCILLATOR CONTROL REGISTER R/W-0/0 SPLLEN R/W-1/1 R/W-1/1 R/W-1/1 IRCF<3:0> U-0 R/W-0/0 R/W-0/0 SCS<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 SPLLEN: Software PLL Enable bit 1 = 4x PLL Is enabled 0 = 4x PLL is disabled bit 6-3 IRCF<3:0>: Internal Oscillator Frequency Select bits 1111 = 16 MHz 1110 = 8 MHz 1101 = 4 MHz 1100 = 2 MHz 1011 = 1 MHz 1010 = 500 kHz(1) 1001 = 250 kHz(1) 1000 = 125 kHz(1) 0111 = 500 kHz (default upon Reset) 0110 = 250 kHz 0101 = 125 kHz 0100 = 62.5 kHz 001x = 31.25 kHz 000x = 31 kHz (LFINTOSC) bit 2 Unimplemented: Read as `0' bit 1-0 SCS<1:0>: System Clock Select bits 1x = Internal oscillator block 01 = Reserved 00 = Clock determined by FOSC<1:0> in Configuration Words Note 1: Duplicate frequency derived from HFINTOSC. DS40001761A-page 62 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 5-2: OSCSTAT: OSCILLATOR STATUS REGISTER U-0 R-0/q U-0 R-0/q U-0 U-0 R-0/q R-0/q -- PLLSR -- HFIOFR -- -- LFIOFR HFIOFS 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 = Conditional bit 7 Unimplemented: Read as `0' bit 6 PLLSR: 4x PLL Ready bit 1 = 4x PLL is ready 0 = 4x PLL is not ready bit 5 Unimplemented: Read as `0' bit 4 HFIOFR: High-Frequency Internal Oscillator Ready bit 1 = 16 MHz Internal Oscillator (HFINTOSC) is ready 0 = 16 MHz Internal Oscillator (HFINTOSC) is not ready bit 3-2 Unimplemented: Read as `0' bit 1 LFIOFR: Low-Frequency Internal Oscillator Ready bit 1 = 31 kHz Internal Oscillator (LFINTOSC) is ready 0 = 31 kHz Internal Oscillator (LFINTOSC) is not ready bit 0 HFIOFS: High-Frequency Internal Oscillator Stable bit 1 = 16 MHz Internal Oscillator (HFINTOSC) is stable 0 = 16 MHz Internal Oscillator (HFINTOSC) is not yet stable TABLE 5-2: SUMMARY OF REGISTERS ASSOCIATED WITH CLOCK SOURCES Name Bit 7 Bit 6 OSCCON SPLLEN OSCSTAT -- Bit 5 Bit 4 Bit 3 IRCF<3:0> PLLSR -- Bit 2 -- HFIOFR -- Bit 1 Bit 0 SCS<1:0> -- LFIOFR HFIOFS Register on Page 62 63 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by clock sources. TABLE 5-3: Name CONFIG1 SUMMARY OF CONFIGURATION WORD WITH CLOCK SOURCES Bits Bit -/7 Bit -/6 Bit 13/5 Bit 12/4 Bit 11/3 13:8 -- -- -- -- CLKOUTEN 7:0 CP MCLRE PWRTE WDTE<1:0> Bit 10/2 Bit 9/1 Bit 8/0 BOREN<1:0> -- -- FOSC<1:0> Register on Page 53 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by clock sources. 2014 Microchip Technology Inc. DS40001761A-page 63 PIC16LF1554/1559 6.0 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 To allow VDD to stabilize, an optional Power-up Timer can be enabled to extend the Reset time after a BOR or POR event. A simplified block diagram of the on-chip Reset circuit is shown in Figure 6-1. FIGURE 6-1: SIMPLIFIED BLOCK DIAGRAM OF ON-CHIP RESET CIRCUIT Rev. 10-000006A 8/14/2013 ICSPTM Programming Mode Exit RESET Instruction Stack Underflow Stack Overlfow MCLRE VPP/MCLR Sleep WDT Time-out Device Reset Power-on Reset VDD BOR Active(1) Brown-out Reset LPBOR Reset Note 1: R LFINTOSC Power-up Timer PWRTE See Table 6-1 for BOR active conditions. DS40001761A-page 64 2014 Microchip Technology Inc. PIC16LF1554/1559 6.1 Power-on Reset (POR) 6.2 Brown-out Reset (BOR) 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. 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. 6.1.1 * * * * POWER-UP TIMER (PWRT) 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 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" (DS00000607). TABLE 6-1: 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 6-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 6-2 for more information. 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 Waits for BOR ready(1) (BORRDY = 1) Awake Active 10 X Sleep Disabled Waits for BOR ready (BORRDY = 1) Active Waits for BOR ready(1) (BORRDY = 1) X Disabled X Disabled Begins immediately (BORRDY = x) 1 X 0 X 01 00 Note 1: In these specific cases, "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. 6.2.1 BOR IS ALWAYS ON 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. BOR protection is active during Sleep. The BOR does not delay wake-up from Sleep. 6.2.2 BOR IS OFF IN SLEEP 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. 2014 Microchip Technology Inc. BOR protection is not active during Sleep. The device wake-up will be delayed until the BOR is ready. 6.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. 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. DS40001761A-page 65 PIC16LF1554/1559 FIGURE 6-2: BROWN-OUT SITUATIONS VDD VBOR Internal Reset TPWRT(1) VDD VBOR Internal Reset < TPWRT TPWRT(1) VDD VBOR Internal Reset TPWRT(1) Note 1: TPWRT delay only if PWRTE bit is programmed to `0'. 6.3 Register Definitions: BOR Control REGISTER 6-1: BORCON: BROWN-OUT RESET CONTROL REGISTER R/W-1/u R/W-0/u U-0 U-0 U-0 U-0 U-0 R-q/u SBOREN BORFS -- -- -- -- -- 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 If BOREN <1:0> in Configuration Words = 01: 1 = BOR Enabled 0 = BOR Disabled If BOREN <1:0> in Configuration Words 01: SBOREN is read/write, but has no effect on the BOR bit 6 BORFS: Brown-Out Reset Fast Start bit(1) If BOREN <1:0> = 10 (Disabled in Sleep) or BOREN<1:0> = 01 (Under software control): 1 = Band gap is forced on always (covers sleep/wake-up/operating cases) 0 = Band gap operates normally, and may turn off If BOREN<1:0> = 11 (Always on) or BOREN<1:0> = 00 (Always off) BORFS is Read/Write, but has no effect. bit 5-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. DS40001761A-page 66 2014 Microchip Technology Inc. PIC16LF1554/1559 6.4 Low-Power Brown-out Reset (LPBOR) The Low-Power Brown-Out Reset (LPBOR) operates like the BOR to detect low voltage conditions on the VDD pin. When too low of a voltage is detected, the device is held in Reset. When this occurs, a register bit (BOR) is changed to indicate that a BOR Reset has occurred. The BOR bit in PCON is used for both BOR and the LPBOR. Refer to Register 6-2. The LPBOR voltage threshold (VLPBOR) has a wider tolerance than the BOR (VBOR), but requires much less current (LPBOR current) to operate. The LPBOR is intended for use when the BOR is configured as disabled (BOREN = 00) or disabled in Sleep mode (BOREN = 10). Refer to Figure 6-1 to see how the LPBOR interacts with other modules. 6.4.1 ENABLING LPBOR The LPBOR is controlled by the LPBOR bit of Configuration Words. When the device is erased, the LPBOR module defaults to disabled. 6.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 6-2). TABLE 6-2: MCLR CONFIGURATION MCLRE LVP MCLR 0 0 Disabled 1 0 Enabled x 1 Enabled 6.5.1 MCLR ENABLED 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. The device has a noise filter in the MCLR Reset path. The filter will detect and ignore small pulses. Note: 6.5.2 A Reset does not drive the MCLR pin low. MCLR DISABLED When MCLR is disabled, the pin functions as a general purpose input and the internal weak pull-up is under software control. See Section 11.3 "PORTA Registers" for more information. 2014 Microchip Technology Inc. 6.6 Watchdog Timer (WDT) Reset The Watchdog Timer generates a Reset if the firmware does not issue a CLRWDT instruction within the time-out period. The TO and PD bits in the STATUS register are changed to indicate the WDT Reset. See Section 9.0 "Watchdog Timer (WDT)" for more information. 6.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 6-4 for default conditions after a RESET instruction has occurred. 6.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 3.4.2 "Overflow/Underflow Reset" for more information. 6.9 Programming Mode Exit Upon exit of Programming mode, the device will behave as if a POR had just occurred. 6.10 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 Configuration Words. 6.11 Start-up Sequence Upon the release of a POR or BOR, the following must occur before the device will begin executing: 1. 2. Power-up Timer runs to completion (if enabled). MCLR must be released (if enabled). The total time-out will vary based on oscillator configuration and Power-up Timer configuration. See Section 5.0 "Oscillator Module" for more information. The Power-up Timer runs independently of MCLR Reset. If MCLR is kept low long enough, the Power-up Timer will expire. Upon bringing MCLR high, the device will begin execution after 10 FOSC cycles (see Figure 6-3). This is useful for testing purposes or to synchronize more than one device operating in parallel. DS40001761A-page 67 PIC16LF1554/1559 FIGURE 6-3: RESET START-UP SEQUENCE Rev. 10-000032A 7/30/2013 VDD Internal POR TPWRT Power-up Timer MCLR Internal RESET Int. Oscillator FOSC Begin Execution code execution (1) Internal Oscillator, PWRTEN = 0 code execution (1) 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 code execution (1) External Clock (EC modes), PWRTEN = 1 VDD Internal POR TPWRT Power-up Timer MCLR Internal RESET Osc Start-Up Timer TOST TOST Ext. Oscillator FOSC Begin Execution code execution (1) External Oscillators , PWRTEN = 0, IESO = 0 code execution (1) External Oscillators , PWRTEN = 1, IESO = 0 VDD Internal POR TPWRT Power-up Timer MCLR Internal RESET Osc Start-Up Timer TOST TOST Ext. Oscillator Int. Oscillator FOSC Begin Execution code execution (1) External Oscillators , PWRTEN = 0, IESO = 1 Note 1: code execution (1) External Oscillators , PWRTEN = 1, IESO = 1 Code execution begins 10 FOSC cycles after the FOSC clock is released. DS40001761A-page 68 2014 Microchip Technology Inc. PIC16LF1554/1559 6.12 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 6-3 and Table 6-4 show the Reset conditions of these registers. TABLE 6-3: RESET STATUS BITS AND THEIR SIGNIFICANCE STKOVF STKUNF RWDT RMCLR RI POR BOR TO PD Condition 0 0 1 1 1 0 x 1 1 Power-on Reset 0 0 1 1 1 0 x 0 x Illegal, TO is set on POR 0 0 1 1 1 0 x x 0 Illegal, PD is set on POR 0 0 u 1 1 u 0 1 1 Brown-out Reset u u 0 u u u u 0 u WDT Reset u u u u u u u 0 0 WDT Wake-up from Sleep u u u u u u u 1 0 Interrupt Wake-up from Sleep u u u 0 u u u u u MCLR Reset during normal operation u u u 0 u u u 1 0 MCLR Reset during Sleep u u u u 0 u u u u RESET Instruction Executed 1 u u u u u u u u Stack Overflow Reset (STVREN = 1) u 1 u u u u u u u Stack Underflow Reset (STVREN = 1) TABLE 6-4: RESET CONDITION FOR SPECIAL REGISTERS Program Counter STATUS Register PCON Register Power-on Reset 0000h ---1 1000 00-- 110x MCLR Reset during normal operation 0000h ---u uuuu uu-- 0uuu MCLR Reset during Sleep 0000h ---1 0uuu uu-- 0uuu WDT Reset 0000h ---0 uuuu uu-- uuuu WDT Wake-up from Sleep PC + 1 ---0 0uuu uu-- uuuu Brown-out Reset 0000h ---1 1uuu 00-- 11u0 ---1 0uuu uu-- uuuu ---u uuuu uu-- u0uu Condition Interrupt Wake-up from Sleep RESET Instruction Executed PC + 1 (1) 0000h Stack Overflow Reset (STVREN = 1) 0000h ---u uuuu 1u-- uuuu Stack Underflow Reset (STVREN = 1) 0000h ---u uuuu u1-- uuuu Legend: u = unchanged, x = unknown, - = unimplemented bit, reads as `0'. Note 1: When the wake-up is due to an interrupt and the Global Interrupt 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. 2014 Microchip Technology Inc. DS40001761A-page 69 PIC16LF1554/1559 6.13 Power Control (PCON) Register The Power Control (PCON) register contains 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) Stack Underflow Reset (STKUNF) Stack Overflow Reset (STKOVF) The PCON register bits are shown in Register 6-2. 6.14 Register Definitions: Power Control REGISTER 6-2: PCON: POWER CONTROL REGISTER R/W/HS-0/q R/W/HS-0/q U-0 STKOVF STKUNF -- R/W/HC-1/q R/W/HC-1/q 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 -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 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 Unimplemented: Read as `0' bit 4 RWDT: Watchdog Timer Reset Flag bit 1 = A Watchdog Timer Reset has not occurred or set 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 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 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) DS40001761A-page 70 2014 Microchip Technology Inc. PIC16LF1554/1559 SUMMARY OF REGISTERS ASSOCIATED WITH RESETS(1) TABLE 6-5: Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page BORCON SBOREN BORFS -- -- -- -- -- BORRDY 66 PCON STKOVF STKUNF -- RWDT RMCLR RI POR BOR 70 STATUS -- -- -- TO PD Z DC C 22 WDTCON -- -- SWDTEN 86 Name Bit 7 WDTPS<4:0> Legend: -- = unimplemented bit, reads as `0'. Shaded cells are not used by Resets. Note 1: Other (non Power-up) Resets include MCLR Reset and Watchdog Timer Reset during normal operation. TABLE 6-6: Name CONFIG1 CONFIG2 SUMMARY OF CONFIGURATION WORD WITH RESETS Bits Bit -/7 Bit -/6 Bit 13/5 Bit 12/4 Bit 11/3 13:8 -- -- -- -- CLKOUTEN 7:0 CP 13:8 -- -- LVP DEBUG LPBOR BORV 7:0 -- -- -- -- -- -- MCLRE PWRTE WDTE<1:0> Bit 10/2 Bit 9/1 BOREN<1:0> -- Bit 8/0 -- FOSC<1:0> STVREN -- WRT<1:0> Register on Page 53 54 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by Resets. 2014 Microchip Technology Inc. DS40001761A-page 71 PIC16LF1554/1559 7.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 7-1. FIGURE 7-1: INTERRUPT LOGIC Rev. 10-000010A 7/30/2013 TMR0IF TMR0IE Peripheral Interrupts (TMR1IF) PIR1<0> (TMR1IE) PIE1<0> Wake-up (If in Sleep mode) INTF INTE IOCIF IOCIE Interrupt to CPU PEIE PIRn<7> PIEn<7> DS40001761A-page 72 GIE 2014 Microchip Technology Inc. PIC16LF1554/1559 7.1 Operation 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) 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 PIE1, PIE2 and PIE3 registers) The INTCON, PIR1, PIR2 and PIR3 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 7.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 interrupt's 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. 2014 Microchip Technology Inc. DS40001761A-page 73 PIC16LF1554/1559 7.2 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 latency for synchronous interrupts is three or four instruction cycles. For asynchronous interrupts, the latency is three to five instruction cycles, depending on when the interrupt occurs. See Figure 7-2 and Figure 7-3 for more details. FIGURE 7-2: INTERRUPT LATENCY Fosc 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 Q1 Q2 Q3 Q4 CLKR Interrupt Sampled during Q1 Interrupt GIE PC Execute PC-1 PC 1-Cycle Instruction at PC PC+1 0004h 0005h NOP NOP Inst(0004h) PC+1/FSR ADDR New PC/ PC+1 0004h 0005h Inst(PC) NOP NOP Inst(0004h) FSR ADDR PC+1 PC+2 0004h 0005h INST(PC) NOP NOP NOP Inst(0004h) Inst(0005h) FSR ADDR PC+1 0004h 0005h INST(PC) NOP NOP Inst(0004h) Inst(PC) Interrupt GIE PC Execute PC-1 PC 2-Cycle Instruction at PC Interrupt GIE PC Execute PC-1 PC 3-Cycle Instruction at PC Interrupt GIE PC Execute PC-1 PC 3-Cycle Instruction at PC DS40001761A-page 74 PC+2 NOP NOP 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 7-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 FOSC CLKOUT (3) INT pin (1) (1) INTF Interrupt Latency(2) (4) GIE INSTRUCTION FLOW PC PC Instruction Fetched Instruction Executed Inst (PC) Inst (PC - 1) PC + 1 Inst (PC + 1) Inst (PC) PC + 1 -- Forced NOP 0004h 0005h Inst (0004h) Inst (0005h) Forced NOP Inst (0004h) Note 1: 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 25.0 "Electrical Specifications". 4: INTF is enabled to be set any time during the Q4-Q1 cycles. 2014 Microchip Technology Inc. DS40001761A-page 75 PIC16LF1554/1559 7.3 Interrupts During Sleep Some 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 8.0 "PowerDown Mode (Sleep)" for more details. 7.4 INT Pin The INT pin can be used to generate an asynchronous edge-triggered interrupt. This interrupt is enabled by setting the INTE bit of the INTCON register. The INTEDG bit of the OPTION_REG 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 INTCON 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. 7.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. DS40001761A-page 76 2014 Microchip Technology Inc. PIC16LF1554/1559 7.6 Register Definitions: Interrupt Control REGISTER 7-1: R/W-0/0 GIE(1) INTCON: INTERRUPT CONTROL 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-0/0 (2) TMR0IE INTE IOCIE TMR0IF INTF IOCIF(3) PEIE 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) 1 = Enables all active interrupts 0 = Disables all interrupts bit 6 PEIE: Peripheral Interrupt Enable bit(2) 1 = Enables all active peripheral interrupts 0 = Disables all peripheral interrupts bit 5 TMR0IE: Timer0 Overflow Interrupt Enable bit 1 = Enables the Timer0 interrupt 0 = Disables the Timer0 interrupt bit 4 INTE: INT External Interrupt Enable bit 1 = Enables the INT external interrupt 0 = Disables the INT external interrupt bit 3 IOCIE: Interrupt-on-Change Enable bit 1 = Enables the interrupt-on-change 0 = Disables the interrupt-on-change bit 2 TMR0IF: Timer0 Overflow Interrupt Flag bit 1 = TMR0 register has overflowed 0 = TMR0 register did not overflow bit 1 INTF: INT External Interrupt Flag bit 1 = The INT external interrupt occurred 0 = The INT external interrupt did not occur bit 0 IOCIF: Interrupt-on-Change Interrupt Flag bit(3) 1 = When at least one of the interrupt-on-change pins changed state 0 = None of the interrupt-on-change pins have changed state Note 1: Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Interrupt Enable bit, GIE of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. 2: Bit PEIE of the INTCON register must be set to enable any peripheral interrupt. 3: The IOCIF flag bit is read-only and cleared when all the interrupt-on-change flags in the IOCxF registers have been cleared by software. 2014 Microchip Technology Inc. DS40001761A-page 77 PIC16LF1554/1559 REGISTER 7-2: PIE1: PERIPHERAL INTERRUPT ENABLE REGISTER 1 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 U-0 R/W-0/0 R/W-0/0 TMR1GIE AD1IE RCIE TXIE SSP1IE -- 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 bit 7 TMR1GIE: Timer1 Gate Interrupt Enable bit 1 = Enables the Timer1 gate acquisition interrupt 0 = Disables the Timer1 gate acquisition interrupt bit 6 AD1IE: Analog-to-Digital Converter (ADC1) Interrupt Enable bit 1 = Enables the ADC interrupt 0 = Disables the ADC interrupt bit 5 RCIE: USART Receive Interrupt Enable bit 1 = Enables the USART receive interrupt 0 = Disables the USART receive interrupt bit 4 TXIE: USART Transmit Interrupt Enable bit 1 = Enables the USART transmit interrupt 0 = Disables the USART transmit interrupt bit 3 SSP1IE: Synchronous Serial Port (MSSP) Interrupt Enable bit 1 = Enables the MSSP interrupt 0 = Disables the MSSP interrupt bit 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 = Disables the Timer1 overflow interrupt Note: Bit PEIE of the INTCON register must be set to enable any peripheral interrupt. DS40001761A-page 78 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 7-3: PIE2: PERIPHERAL INTERRUPT ENABLE REGISTER 2 U-0 R/W-0/0 U-0 U-0 R/W-0/0 U-0 U-0 U-0 -- AD2IE -- -- BCLIE -- -- -- 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 AD2IE: Analog-to-Digital Converter (ADC) 2 Interrupt Enable bit 1 = Enables the ADC interrupt 0 = Disables the ADC interrupt bit 5-4 Unimplemented: Read as `0' bit 3 BCLIE: MSSP Bus Collision Interrupt Enable bit 1 = Enables the MSSP Bus Collision Interrupt 0 = Disables the MSSP Bus Collision Interrupt bit 2-0 Unimplemented: Read as `0' Note: Bit PEIE of the INTCON register must be set to enable any peripheral interrupt. 2014 Microchip Technology Inc. DS40001761A-page 79 PIC16LF1554/1559 REGISTER 7-4: PIR1: PERIPHERAL INTERRUPT REQUEST REGISTER 1 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 U-0 R/W-0/0 R/W-0/0 TMR1GIF AD1IF RCIF TXIF SSP1IF -- 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 bit 7 TMR1GIF: Timer1 Gate Interrupt Flag bit 1 = Interrupt is pending 0 = Interrupt is not pending bit 6 AD1IF: ADC 1 Interrupt Flag bit 1 = Interrupt is pending 0 = Interrupt is not pending bit 5 RCIF: USART Receive Interrupt Flag bit 1 = Interrupt is pending 0 = Interrupt is not pending bit 4 TXIF: USART Transmit Interrupt Flag bit 1 = Interrupt is pending 0 = Interrupt is not pending bit 3 SSP1IF: Synchronous Serial Port (MSSP) Interrupt Flag bit 1 = Interrupt is pending 0 = Interrupt is not pending bit 2 Unimplemented: Read as `0' bit 1 TMR2IF: Timer2 to PR2 Interrupt Flag bit 1 = Interrupt is pending 0 = Interrupt is not pending bit 0 TMR1IF: Timer1 Overflow Interrupt Flag bit 1 = Interrupt is pending 0 = Interrupt is not pending Note: Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Interrupt Enable bit, GIE of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. DS40001761A-page 80 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 7-5: PIR2: PERIPHERAL INTERRUPT REQUEST REGISTER 2 U-0 R/W-0/0 U-0 U-0 R/W-0/0 U-0 U-0 U-0 -- AD2IF -- -- BCLIF -- -- -- 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 AD2IF: ADC 2 Interrupt Flag bit 1 = Interrupt is pending 0 = Interrupt is not pending bit 5-4 Unimplemented: Read as `0' bit 3 BCLIF: MSSP Bus Collision Interrupt Flag bit 1 = Interrupt is pending 0 = Interrupt is not pending bit 2-0 Unimplemented: Read as `0' Note: Interrupt flag bits are set when an interrupt condition occurs, regardless of the state of its corresponding enable bit or the Global Interrupt Enable bit, GIE of the INTCON register. User software should ensure the appropriate interrupt flag bits are clear prior to enabling an interrupt. TABLE 7-1: Name INTCON OPTION_REG SUMMARY OF REGISTERS ASSOCIATED WITH INTERRUPTS Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 WPUEN INTEDG TMR0CS TMR0SE PSA PS<2:0> 166 PIE1 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 78 PIE2 -- AD2IE -- -- BCLIE -- -- -- 79 PIR1 TMR1GIF AD1IF RCIF TXIF SSP1IF -- TMR2IF TMR1IF 80 PIR2 -- AD2IF -- -- BCLIF -- -- -- 81 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by interrupts. 2014 Microchip Technology Inc. DS40001761A-page 81 PIC16LF1554/1559 8.0 POWER-DOWN MODE (SLEEP) The Power-Down mode is entered by executing a SLEEP instruction. Upon entering Sleep mode, the following conditions exist: 1. 2. 3. 4. 5. 6. WDT will be cleared but keeps running, if enabled for operation during Sleep. PD bit of the STATUS register is cleared. TO bit of the STATUS register is set. CPU clock is disabled. 31 kHz LFINTOSC is unaffected and peripherals that operate from it may continue operation in Sleep. Timer1 and peripherals that operate from Timer1 continue operation in Sleep when the Timer1 clock source selected is: * LFINTOSC * T1CKI * Timer1 oscillator ADC is unaffected, if the dedicated FRC oscillator is selected. I/O ports maintain the status they had before SLEEP was executed (driving high, low or highimpedance). Resets other than WDT are not affected by Sleep mode. 8.1 Wake-up from Sleep The device can wake-up from Sleep through one of the following events: 1. External Reset input on MCLR pin, if enabled 2. BOR Reset, if enabled 3. POR Reset 4. Watchdog Timer, if enabled 5. Any external interrupt 6. 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 6.12 "Determining the Cause of a Reset". Refer to individual chapters for more details on peripheral operation during Sleep. 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. To minimize current consumption, the following conditions should be considered: The WDT is cleared when the device wakes up from Sleep, regardless of the source of wake-up. 7. 8. 9. * * * * * 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 31 kHz LFINTOSC I/O pins that are high-impedance inputs should be pulled to VDD or VSS externally to avoid switching currents caused by floating inputs. Examples of internal circuitry that might be sourcing current include the FVR module. See Section 13.0 "Fixed Voltage Reference (FVR)" for more information on this module. DS40001761A-page 82 2014 Microchip Technology Inc. PIC16LF1554/1559 8.1.1 WAKE-UP USING INTERRUPTS When global interrupts are disabled (GIE cleared) and any interrupt source 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. * 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. TABLE 8-1: SUMMARY OF REGISTERS ASSOCIATED WITH POWER-DOWN MODE Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page INTCON GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 IOCAF -- -- IOCAF5 IOCAF4 IOCAF3 IOCAF2 IOCAF1 IOCAF0 120 IOCAN -- -- IOCAN5 IOCAN4 IOCAN3 IOCAN2 IOCAN1 IOCAN0 120 IOCAP -- -- IOCAP5 IOCAP4 IOCAP3 IOCAP2 IOCAP1 IOCAP0 120 IOCBF(1) IOCBF7 IOCBF6 IOCBF5 IOCBF4 -- -- -- -- 121 (1) IOCBN IOCBN7 IOCBN6 IOCBN5 IOCBN4 -- -- -- -- 121 IOCBP(1) IOCBP7 IOCBP6 IOCBP5 IOCBP4 -- -- -- -- 121 PIE1 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 78 PIE2 -- AD2IE -- -- BCLIE -- -- -- 79 PIR1 TMR1GIF AD1IF RCIF TXIF SSP1IF -- TMR2IF TMR1IF 80 PIR2 -- AD2IF -- -- BCLIF -- -- -- 81 STATUS -- -- -- TO PD Z DC C 22 WDTCON -- -- SWDTEN 86 WDTPS<4:0> Legend: -- = unimplemented, read as `0'. Shaded cells are not used in Power-Down mode. Note 1: These registers are only available for PIC16LF1559. 2014 Microchip Technology Inc. DS40001761A-page 83 PIC16LF1554/1559 9.0 WATCHDOG TIMER (WDT) The Watchdog Timer 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 WDT has the following features: * Independent 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) * Multiple Reset conditions * Operation during Sleep FIGURE 9-1: WATCHDOG TIMER BLOCK DIAGRAM Rev. 10-000141A 7/30/2013 WDTE<1:0> = 01 SWDTEN WDTE<1:0> = 11 LFINTOSC 23-bit Programmable Prescaler WDT WDT Time-out WDTE<1:0> = 10 Sleep DS40001761A-page 84 WDTPS<4:0> 2014 Microchip Technology Inc. PIC16LF1554/1559 9.1 Independent Clock Source 9.3 The WDT derives its time base from the 31 kHz LFINTOSC internal oscillator. Time intervals in this chapter are based on a nominal interval of 1 ms. See Section 25.0 "Electrical Specifications" for the LFINTOSC tolerances. The WDTPS bits of the WDTCON register set the time-out period from 1 ms to 256 seconds (nominal). After a Reset, the default time-out period is two seconds. 9.4 9.2 WDT Operating Modes The Watchdog Timer module has four operating modes controlled by the WDTE<1:0> bits in Configuration Words. See Table 9-1. 9.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. 9.2.2 WDT IS OFF IN SLEEP WDT protection is not active during Sleep. WDT CONTROLLED BY SOFTWARE When the WDTE bits of Configuration Words are set to `01', the WDT is controlled by the SWDTEN bit of the WDTCON register. WDT protection is unchanged by Sleep. See Table 9-1 for more details. TABLE 9-1: WDTE<1:0> WDT OPERATING MODES SWDTEN Device Mode WDT Mode X Active Awake Active Sleep Disabled 1 X Active 0 X Disabled X X Disabled 11 X 10 X 01 00 TABLE 9-2: Clearing the WDT The WDT is cleared when any of the following conditions occur: * * * * * * * Any Reset CLRWDT instruction is executed Device enters Sleep Device wakes up from Sleep Oscillator fail WDT is disabled Oscillator Start-up Timer (OST) is running See Table 9-2 for more information. When the WDTE bits of Configuration Words are set to `10', the WDT is on, except in Sleep. 9.2.3 Time-out Period 9.5 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 5.0 "Oscillator Module" 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 3.0 "Memory Organization" for more information. WDT CLEARING CONDITIONS Conditions WDT WDTE<1:0> = 00 WDTE<1:0> = 01 and SWDTEN = 0 WDTE<1:0> = 10 and enter Sleep CLRWDT Command Cleared Oscillator Fail Detected Exit Sleep + System Clock = T1OSC, EXTRC, INTOSC, EXTCLK Exit Sleep + System Clock = XT, HS, LP Change INTOSC divider (IRCF bits) 2014 Microchip Technology Inc. Cleared until the end of OST Unaffected DS40001761A-page 85 PIC16LF1554/1559 9.6 Register Definitions: Watchdog Control REGISTER 9-1: WDTCON: WATCHDOG TIMER CONTROL REGISTER U-0 U-0 -- -- R/W-0/0 R/W-1/1 R/W-0/0 R/W-1/1 R/W-1/1 WDTPS<4:0> R/W-0/0 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 bit 7-6 Unimplemented: Read as `0' bit 5-1 WDTPS<4:0>: Watchdog Timer Period 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 Note 1: = = = = = = = = = = = = = = = = = = = 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. Times are approximate. WDT time is based on 31 kHz LFINTOSC. DS40001761A-page 86 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 9-3: SUMMARY OF REGISTERS ASSOCIATED WITH WATCHDOG TIMER Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 -- IRCF<3:0> Bit 1 Bit 0 SCS<1:0> Register on Page OSCCON SPLLEN PCON STKOVF STKUNF -- RWDT RMCLR RI POR BOR 70 STATUS -- -- -- TO PD Z DC C 22 WDTCON -- -- SWDTEN 86 WDTPS<4:0> 62 Legend: x = unknown, u = unchanged, - = unimplemented locations read as `0'. Shaded cells are not used by Watchdog Timer. TABLE 9-4: Name CONFIG1 SUMMARY OF CONFIGURATION WORD WITH WATCHDOG TIMER Bits Bit -/7 Bit -/6 Bit 13/5 Bit 12/4 Bit 11/3 13:8 -- -- -- -- CLKOUTEN 7:0 CP MCLRE PWRTE WDTE<1:0> Bit 10/2 Bit 9/1 Bit 8/0 BOREN<1:0> -- -- FOSC<1:0> Register on Page 53 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by Watchdog Timer. 2014 Microchip Technology Inc. DS40001761A-page 87 PIC16LF1554/1559 10.0 FLASH PROGRAM MEMORY CONTROL The Flash program memory is readable and writable during normal operation over the full VDD range. Program memory is indirectly addressed using Special Function Registers (SFRs). The SFRs used to access program memory are: * * * * * * PMCON1 PMCON2 PMDATL PMDATH PMADRL PMADRH When accessing the program memory, the PMDATH:PMDATL register pair forms a 2-byte word that holds the 14-bit data for read/write, and the PMADRH:PMADRL register pair forms a 2-byte word that holds the 15-bit address of the program memory location being read. 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. The Flash program memory can be protected in two ways; by code protection (CP bit in Configuration Words) and write protection (WRT<1:0> bits in Configuration Words). Code protection (CP = 0)(1), disables access, reading and writing, to the Flash program memory 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 Flash program memory, Configuration bits and User IDs. Write protection prohibits self-write and erase to a portion or all of the Flash program memory, as defined by the bits WRT<1:0>. Write protection does not affect a device programmers ability to read, write or erase the device. Note 1: Code protection of the entire Flash program memory array is enabled by clearing the CP bit of Configuration Words. 10.1 PMADRL and PMADRH Registers The PMADRH:PMADRL register pair can address up to a maximum of 32K words of program memory. When selecting a program address value, the MSB of the address is written to the PMADRH register and the LSB is written to the PMADRL register. DS40001761A-page 88 10.1.1 PMCON1 AND PMCON2 REGISTERS PMCON1 is the control register for Flash program memory accesses. Control bits RD and WR initiate read and write, respectively. These bits cannot be cleared, only set, in software. They are cleared by hardware at completion of the read or write operation. The inability to clear the WR bit in software prevents the accidental, premature termination of a write operation. The WREN bit, when set, will allow a write operation to occur. On power-up, the WREN bit is clear. The WRERR bit is set when a write operation is interrupted by a Reset during normal operation. In these situations, following Reset, the user can check the WRERR bit and execute the appropriate error handling routine. The PMCON2 register is a write-only register. Attempting to read the PMCON2 register will return all `0's. To enable writes to the program memory, a specific pattern (the unlock sequence), must be written to the PMCON2 register. The required unlock sequence prevents inadvertent writes to the program memory write latches and Flash program memory. 10.2 Flash Program Memory Overview It is important to understand the Flash program memory structure for erase and programming operations. Flash program memory is arranged in rows. A row consists of a fixed number of 14-bit program memory words. A row is the minimum size that can be erased by user software. After a row has been erased, the user can reprogram all or a portion of this row. Data to be written into the program memory row is written to 14-bit wide data write latches. These write latches are not directly accessible to the user, but may be loaded via sequential writes to the PMDATH:PMDATL register pair. Note: If the user wants to modify only a portion of a previously programmed row, then the contents of the entire row must be read and saved in RAM prior to the erase. Then, new data and retained data can be written into the write latches to reprogram the row of Flash program memory. 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. See Table 10-1 for Erase Row size and the number of write latches for Flash program memory. 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 10-1: Device PIC16LF1554 PIC16LF1559 10.2.1 FLASH MEMORY ORGANIZATION BY DEVICE Row Erase (words) Write Latches (words) 32 32 READING THE FLASH PROGRAM MEMORY To read a program memory location, the user must: 1. 2. 3. Write the desired address to the PMADRH:PMADRL register pair. Clear the CFGS bit of the PMCON1 register. Then, set control bit RD of the PMCON1 register. Once the read control bit is set, the program memory Flash controller will use the second instruction cycle to read the data. This causes the second instruction immediately following the "BSF PMCON1,RD" instruction to be ignored. The data is available in the very next cycle, in the PMDATH:PMDATL register pair; therefore, it can be read as two bytes in the following instructions. PMDATH:PMDATL register pair will hold this value until another read or until it is written to by the user. Note: The two instructions following a program memory read are required to be NOPs. This prevents the user from executing a 2-cycle instruction on the next instruction after the RD bit is set. FIGURE 10-1: FLASH PROGRAM MEMORY READ FLOWCHART Rev. 10-000046A 7/30/2013 Start Read Operation Select Program or Configuration Memory (CFGS) Select Word Address (PMADRH:PMADRL) Initiate Read operation (RD = 1) Instruction fetched ignored NOP execution forced Instruction fetched ignored NOP execution forced Data read now in PMDATH:PMDATL End Read Operation 2014 Microchip Technology Inc. DS40001761A-page 89 PIC16LF1554/1559 FIGURE 10-2: FLASH PROGRAM MEMORY READ CYCLE EXECUTION Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 PC Flash ADDR Flash Data PC + 1 INSTR (PC) INSTR(PC - 1) executed here PMADRH,PMADRL INSTR (PC + 1) BSF PMCON1,RD executed here PC +3 PC+3 PMDATH,PMDATL INSTR(PC + 1) instruction ignored Forced NOP executed here PC + 5 PC + 4 INSTR (PC + 3) INSTR(PC + 2) instruction ignored Forced NOP executed here INSTR (PC + 4) INSTR(PC + 3) executed here INSTR(PC + 4) executed here RD bit PMDATH PMDATL Register EXAMPLE 10-1: FLASH 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 PMADRL PROG_ADDR_LO PMADRL PROG_ADDR_HI PMADRH ; Select Bank for PMCON registers ; ; Store LSB of address ; ; Store MSB of address BCF BSF NOP NOP PMCON1,CFGS PMCON1,RD ; ; ; ; Do not select Configuration Space Initiate read Ignored (Figure 10-2) Ignored (Figure 10-2) MOVF MOVWF MOVF MOVWF PMDATL,W PROG_DATA_LO PMDATH,W PROG_DATA_HI ; ; ; ; Get LSB of word Store in user location Get MSB of word Store in user location DS40001761A-page 90 2014 Microchip Technology Inc. PIC16LF1554/1559 10.2.2 FLASH MEMORY UNLOCK SEQUENCE The unlock sequence is a mechanism that protects the Flash program memory from unintended self-write programming or erasing. The sequence must be executed and completed without interruption to successfully complete any of the following operations: * Row Erase * Load program memory write latches * Write of program memory write latches to program memory * Write of program memory write latches to User IDs FIGURE 10-3: FLASH PROGRAM MEMORY UNLOCK SEQUENCE FLOWCHART Rev. 10-000047A 7/30/2013 Start Unlock Sequence Write 0x55 to PMCON2 The unlock sequence consists of the following steps: 1. Write 55h to PMCON2 2. Write AAh to PMCON2 Write 0xAA to PMCON2 3. Set the WR bit in PMCON1 4. NOP instruction 5. NOP instruction Once the WR bit is set, the processor will always force two NOP instructions. When an Erase Row or Program Row operation is being performed, the processor will stall internal operations (typical 2 ms), until the operation is complete and then resume with the next instruction. When the operation is loading the program memory write latches, the processor will always force the two NOP instructions and continue uninterrupted with the next instruction. 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. 2014 Microchip Technology Inc. Initiate Write or Erase operation (WR = 1) Instruction fetched ignored NOP execution forced Instruction fetched ignored NOP execution forced End Unlock Sequence DS40001761A-page 91 PIC16LF1554/1559 10.2.3 ERASING FLASH PROGRAM MEMORY FIGURE 10-4: While executing code, program memory can only be erased by rows. To erase a row: 1. 2. 3. 4. 5. Rev. 10-000048A 7/30/2013 Load the PMADRH:PMADRL register pair with any address within the row to be erased. Clear the CFGS bit of the PMCON1 register. Set the FREE and WREN bits of the PMCON1 register. Write 55h, then AAh, to PMCON2 (Flash programming unlock sequence). Set control bit WR of the PMCON1 register to begin the erase operation. See Example 10-2. After the "BSF PMCON1,WR" instruction, the processor requires two cycles to set up the erase operation. The user must place two NOP instructions immediately following the WR bit set instruction. The processor will halt internal operations for the typical 2 ms erase time. This is not Sleep mode as the clocks and peripherals will continue to run. After the erase cycle, the processor will resume operation with the third instruction after the PMCON1 write instruction. FLASH PROGRAM MEMORY ERASE FLOWCHART Start Erase Operation Disable Interrupts (GIE = 0) Select Program or Configuration Memory (CFGS) Select Row Address (PMADRH:PMADRL) Select Erase Operation (FREE = 1) Enable Write/Erase Operation (WREN = 1) 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: DS40001761A-page 92 See Figure 10-3. 2014 Microchip Technology Inc. PIC16LF1554/1559 EXAMPLE 10-2: ERASING ONE ROW OF PROGRAM MEMORY Required Sequence ; This row erase routine assumes the following: ; 1. A valid address within the erase row is loaded in ADDRH:ADDRL ; 2. ADDRH and ADDRL are located in shared data memory 0x70 - 0x7F (common RAM) BCF BANKSEL MOVF MOVWF MOVF MOVWF BCF BSF BSF INTCON,GIE PMADRL ADDRL,W PMADRL ADDRH,W PMADRH PMCON1,CFGS PMCON1,FREE PMCON1,WREN MOVLW MOVWF MOVLW MOVWF BSF NOP NOP 55h PMCON2 0AAh PMCON2 PMCON1,WR BCF BSF PMCON1,WREN INTCON,GIE 2014 Microchip Technology Inc. ; Disable ints so required sequences will execute properly ; Load lower 8 bits of erase address boundary ; Load upper 6 bits of erase address boundary ; Not configuration space ; Specify an erase operation ; Enable writes ; ; ; ; ; ; ; ; ; ; Start of required sequence to initiate erase Write 55h Write AAh Set WR bit to begin erase NOP instructions are forced as processor starts row erase of program memory. The processor stalls until the erase process is complete after erase processor continues with 3rd instruction ; Disable writes ; Enable interrupts DS40001761A-page 93 PIC16LF1554/1559 10.2.4 WRITING TO FLASH PROGRAM MEMORY Program memory is programmed using the following steps: 1. 2. 3. 4. Load the address in PMADRH:PMADRL of the row to be programmed. 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 PMDATH:PMDATL 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 10-5 (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 10-bits of PMADRH:PMADRL, (PMADRH<6:0>:PMADRL<7:5>) with the lower five bits of PMADRL, (PMADRL<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. 3. Set the WREN bit of the PMCON1 register. Clear the CFGS bit of the PMCON1 register. Set the LWLO bit of the PMCON1 register. When the LWLO bit of the PMCON1 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 PMADRH:PMADRL register pair with the address of the location to be written. 5. Load the PMDATH:PMDATL register pair with the program memory data to be written. 6. Execute the unlock sequence (Section 10.2.2 "Flash Memory Unlock Sequence"). The write latch is now loaded. 7. Increment the PMADRH:PMADRL 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 PMCON1 register. When the LWLO bit of the PMCON1 register is `0', the write sequence will initiate the write to Flash program memory. 10. Load the PMDATH:PMDATL register pair with the program memory data to be written. 11. Execute the unlock sequence (Section 10.2.2 "Flash Memory 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 10-3. The initial address is loaded into the PMADRH:PMADRL register pair; the data is loaded using indirect addressing. DS40001761A-page 94 2014 Microchip Technology Inc. 2014 Microchip Technology Inc. FIGURE 10-5: 7 BLOCK WRITES TO FLASH PROGRAM MEMORY WITH 32 WRITE LATCHES 6 0 7 5 4 PMADRH - r9 r8 r7 r6 r5 0 7 PMADRL r4 r3 r2 r1 r0 c4 c3 c2 c1 - 5 - 0 7 PMDATH PMDATL 6 c0 Rev. 10-000004A 7/30/2013 0 8 14 Program Memory Write Latches 5 10 14 PMADRL<4:0> Write Latch #0 00h 14 PMADRH<6:0>: PMADRL<7:5> Row Address Decode 14 14 Write Latch #30 1Eh Write Latch #1 01h 14 Write Latch #31 1Fh 14 14 Row Addr Addr Addr Addr 000h 0000h 0001h 001Eh 001Fh 001h 0020h 0021h 003Eh 003Fh 002h 0040h 0041h 005Eh 005Fh 3FEh 7FC0h 7FC1h 7FDEh 7FDFh 3FFh 7FE0h 7FE1h 7FFEh 7FFFh Flash Program Memory DS40001761A-page 95 400h CFGS = 1 8000h - 8003h 8004h - 8005h 8006h 8007h - 8008h 8009h - 801Fh USER ID 0 - 3 reserved DEVICE ID Dev / Rev Configuration Words reserved Configuration Memory PIC16LF1554/1559 CFGS = 0 14 PIC16LF1554/1559 FIGURE 10-6: FLASH PROGRAM MEMORY WRITE FLOWCHART Rev. 10-000049A 7/30/2013 Start Write Operation Determine number of words to be written into Program or Configuration Memory. The number of words cannot exceed the number of words per row (word_cnt) Enable Write/Erase Operation (WREN = 1) Load the value to write (PMDATH:PMDATL) Disable Interrupts (GIE = 0) Update the word counter (word_cnt--) Write Latches to Flash (LWLO = 0) Select Program or Config. Memory (CFGS) Last word to write ? Yes Unlock Sequence (See Note 1) Select Row Address (PMADRH:PMADRL) No Select Write Operation (FREE = 0) Load Write Latches Only (LWLO = 1) Unlock Sequence (See Note 1) No delay when writing to Program Memory Latches CPU stalls while Write operation completes (2 ms typical) Disable Write/Erase Operation (WREN = 0) Re-enable Interrupts (GIE = 1) Increment Address (PMADRH:PMADRL++) End Write Operation Note 1: See Figure 10-3. DS40001761A-page 96 2014 Microchip Technology Inc. PIC16LF1554/1559 EXAMPLE 10-3: ; ; ; ; ; ; ; WRITING TO FLASH PROGRAM MEMORY (32 WRITE LATCHES) 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 shared data memory 0x70 - 0x7F (common RAM) BCF BANKSEL MOVF MOVWF MOVF MOVWF MOVLW MOVWF MOVLW MOVWF BCF BSF BSF INTCON,GIE PMADRH ADDRH,W PMADRH ADDRL,W PMADRL LOW DATA_ADDR FSR0L HIGH DATA_ADDR FSR0H PMCON1,CFGS PMCON1,WREN PMCON1,LWLO ; ; ; ; ; ; ; ; ; ; ; ; ; Disable ints so required sequences will execute properly Bank 3 Load initial address MOVIW MOVWF MOVIW MOVWF FSR0++ PMDATL FSR0++ PMDATH ; Load first data byte into lower ; ; Load second data byte into upper ; MOVF XORLW ANDLW BTFSC GOTO PMADRL,W 0x1F 0x1F STATUS,Z START_WRITE ; Check if lower bits of address are '00000' ; Check if we're on the last of 32 addresses ; ; Exit if last of 32 words, ; MOVLW MOVWF MOVLW MOVWF BSF NOP 55h PMCON2 0AAh PMCON2 PMCON1,WR ; ; ; ; ; ; ; ; PMADRL,F LOOP ; Still loading latches Increment address ; Write next latches PMCON1,LWLO ; No more loading latches - Actually start Flash program ; memory write 55h PMCON2 0AAh PMCON2 PMCON1,WR ; ; ; ; ; ; ; ; ; ; ; ; ; Load initial data address Load initial data address Not configuration space Enable writes Only Load Write Latches Required Sequence LOOP NOP INCF GOTO Required Sequence START_WRITE BCF MOVLW MOVWF MOVLW MOVWF BSF NOP NOP BCF BSF PMCON1,WREN INTCON,GIE 2014 Microchip Technology Inc. Start of required write sequence: Write 55h Write AAh Set WR bit to begin write NOP instructions are forced as processor loads program memory write latches Start of required write sequence: Write 55h Write AAh Set WR bit to begin write NOP instructions are forced as processor writes all the program memory write latches simultaneously to program memory. After NOPs, the processor stalls until the self-write process in complete after write processor continues with 3rd instruction Disable writes Enable interrupts DS40001761A-page 97 PIC16LF1554/1559 10.3 Modifying Flash Program Memory FIGURE 10-7: 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-000050A 7/30/2013 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. Start Modify 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 DS40001761A-page 98 Note 1: See Figure 10-2. 2: See Figure 10-4. 3: See Figure 10-5. 2014 Microchip Technology Inc. PIC16LF1554/1559 10.4 User ID, Device ID and Configuration Word Access Instead of accessing program memory, the User ID's, Device ID/Revision ID and Configuration Words can be accessed when CFGS = 1 in the PMCON1 register. This is the region that would be pointed to by PC<15> = 1, but not all addresses are accessible. Different access may exist for reads and writes. Refer to Table 10-2. When read access is initiated on an address outside the parameters listed in Table 10-2, the PMDATH:PMDATL register pair is cleared, reading back `0's. TABLE 10-2: USER ID, DEVICE ID AND CONFIGURATION WORD ACCESS (CFGS = 1) Address Function Read Access Write Access 8000h-8003h User IDs Yes Yes 8006h Device ID/Revision ID Yes No 8007h-8008h Configuration Words 1 and 2 Yes No EXAMPLE 10-4: CONFIGURATION WORD AND DEVICE ID ACCESS * This code block will read 1 word of program memory at the memory address: * PROG_ADDR_LO (must be 00h-08h) data will be returned in the variables; * PROG_DATA_HI, PROG_DATA_LO BANKSEL MOVLW MOVWF CLRF PMADRL PROG_ADDR_LO PMADRL PMADRH ; Select correct Bank ; ; Store LSB of address ; Clear MSB of address BSF BCF BSF NOP NOP BSF PMCON1,CFGS INTCON,GIE PMCON1,RD INTCON,GIE ; ; ; ; ; ; Select Configuration Space Disable interrupts Initiate read Executed (See Figure 10-2) Ignored (See Figure 10-2) Restore interrupts MOVF MOVWF MOVF MOVWF PMDATL,W PROG_DATA_LO PMDATH,W PROG_DATA_HI ; ; ; ; Get LSB of word Store in user location Get MSB of word Store in user location 2014 Microchip Technology Inc. DS40001761A-page 99 PIC16LF1554/1559 10.5 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 page then the stored program memory contents are compared with the intended data stored in RAM after the last write is complete. FIGURE 10-8: FLASH PROGRAM MEMORY VERIFY FLOWCHART Rev. 10-000051A 7/30/2013 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 Flash Program Memory Read Operation (See Note 1) PMDAT = RAM image ? No Yes Fail Verify Operation No Last word ? Yes End Verify Operation Note 1: See Figure 10-2. DS40001761A-page 100 2014 Microchip Technology Inc. PIC16LF1554/1559 10.6 Register Definitions: Flash Program Memory Control REGISTER 10-1: R/W-x/u PMDATL: PROGRAM 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 PMDAT<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 PMDAT<7:0>: Read/write value for Least Significant bits of program memory REGISTER 10-2: PMDATH: PROGRAM 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 PMDAT<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 PMDAT<13:8>: Read/write value for Most Significant bits of program memory 2014 Microchip Technology Inc. DS40001761A-page 101 PIC16LF1554/1559 REGISTER 10-3: R/W-0/0 PMADRL: PROGRAM 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 PMADR<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 PMADR<7:0>: Specifies the Least Significant bits for program memory address REGISTER 10-4: U-1 PMADRH: PROGRAM MEMORY ADDRESS HIGH 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 PMADR<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 PMADR<14:8>: Specifies the Most Significant bits for program memory address DS40001761A-page 102 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 10-5: PMCON1: PROGRAM MEMORY CONTROL 1 REGISTER U-1 R/W-0/0 R/W-0/0 -- CFGS LWLO R/W/HC-0/0 R/W/HC-x/q FREE WRERR R/W-0/0 R/S/HC-0/0 R/S/HC-0/0 WREN WR 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 `1' bit 6 CFGS: Configuration Select bit 1 = Access Configuration, User ID and Device ID Registers 0 = Access Flash program memory bit 5 LWLO: Load Write Latches Only bit(1) 1 = Only the addressed program memory write latch is loaded/updated on the next WR command 0 = The addressed program memory write latch is loaded/updated and a write of all program memory write latches will be initiated on the next WR command bit 4 FREE: Program Flash Erase Enable bit 1 = Performs an erase operation on the next WR command (hardware cleared upon completion) 0 = Performs a write operation on the next WR command bit 3 WRERR: Program/Erase Error Flag bit(2) 1 = Condition indicates an improper program or erase sequence attempt or termination (bit is set automatically on any set attempt (write `1') of the WR bit). 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 1 = Initiates a program Flash program/erase operation. The operation is self-timed and the bit is cleared by hardware once operation is complete. The WR bit can only be set (not cleared) in software. 0 = Program/erase operation to the Flash is complete and inactive. bit 0 RD: Read Control bit 1 = Initiates a program Flash read. Read takes one cycle. RD is cleared in hardware. The RD bit can only be set (not cleared) in software. 0 = Does not initiate a program Flash read. Note 1: 2: The LWLO bit is ignored during a program memory erase operation (FREE = 1). The WRERR bit is automatically set by hardware when a program memory write or erase operation is started (WR = 1). 2014 Microchip Technology Inc. DS40001761A-page 103 PIC16LF1554/1559 REGISTER 10-6: W-0/0 PMCON2: PROGRAM 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 Program Memory Control Register 2 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 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 PMCON1 register. The value written to this register is used to unlock the writes. There are specific timing requirements on these writes. TABLE 10-3: SUMMARY OF REGISTERS ASSOCIATED WITH FLASH PROGRAM MEMORY Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page INTCON GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 PMCON1 --(1) CFGS LWLO FREE WRERR WREN WR RD 103 PMCON2 Program Memory Control Register 2 104 PMADR<7:0> 102 PMADRL --(1) PMADRH PMADR<14:8> PMDATL 102 PMDAT<7:0> -- PMDATH -- 101 PMDAT<13:8> 101 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by Flash program memory. Note 1: Unimplemented, read as `1'. TABLE 10-4: Name CONFIG1 CONFIG2 SUMMARY OF CONFIGURATION WORD WITH FLASH PROGRAM MEMORY Bits Bit -/7 Bit -/6 Bit 13/5 Bit 12/4 Bit 11/3 13:8 -- -- -- -- CLKOUTEN 7:0 CP MCLRE PWRTE 13:8 -- -- LVP DEBUG LPBOR BORV 7:0 -- -- -- -- -- -- WDTE<1:0> Bit 10/2 Bit 9/1 BOREN<1:0> -- Bit 8/0 -- FOSC<1:0> STVREN -- WRT<1:0> Register on Page 53 54 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by Flash program memory. DS40001761A-page 104 2014 Microchip Technology Inc. PIC16LF1554/1559 11.0 I/O PORTS FIGURE 11-1: GENERIC I/O PORT OPERATION Each port has three standard registers for its operation. These registers are: Rev. 10-000052A 7/30/2013 * TRISx registers (data direction) * PORTx registers (reads the levels on the pins of the device) * LATx registers (output latch) Read LATx TRISx Some ports may have one or more of the following additional registers. These registers are: D Q Write LATx Write PORTx * ANSELx (analog select) * WPUx (weak pull-up) VDD CK Data Register 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. Data bus I/O pin Read PORTx To digital peripherals PORT AVAILABILITY PER DEVICE ANSELx Device PORTB PORTC To analog peripherals PORTA TABLE 11-1: PIC16LF1554 PIC16LF1559 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 ANSELx bit is set, the digital input buffer associated with that bit is disabled. 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 11-1. 2014 Microchip Technology Inc. VSS 11.1 Alternate Pin Function The Alternate Pin Function Control (APFCON) register is used to steer specific peripheral input and output functions between different pins. The APFCON register is shown in Register 11-1. For this device family, the following functions can be moved between different pins. * * * * * * * * * SS RX/DT TX/CK SDO SDA AD1GRDA AD1GRDB AD2GRDA AD2GRDB These bits have no effect on the values of any TRISx register. PORTx and TRISx overrides will be routed to the correct pin. The unselected pin will be unaffected. DS40001761A-page 105 PIC16LF1554/1559 11.2 Register Definitions: Alternate Pin Function Control REGISTER 11-1: APFCON: ALTERNATE PIN FUNCTION CONTROL REGISTER R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 U-0 R/W-0/0 R/W-0/0 R/W-0/0 RXDTSEL SDOSEL SSSEL SDSEL -- TXCKSEL GRDBSEL GRDASEL 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 RXDTSEL: Pin Selection bit(1) 0 = RX/DT function is on RC5 1 = RX/DT function is on RA4 bit 6 SDOSEL: Pin Selection bit(1) 0 = SDO function is on RC2 1 = SDO function is on RA4 bit 5 SSSEL: Pin Selection bit For 14 Pin Device (PIC16LF1554): 0 = SS function is on RA3 1 = SS function is on RC3 For 20 Pin Device (PIC16LF1559): 0 = SS function is on RA3 1 = SS function is on RC6 bit 4 SDSEL: Pin Selection bit For 14 Pin Device (PIC16LF1554): 0 = SDA / SDI function is on RC1 1 = SDA / SDI function is on RA3 For 20 Pin Device (PIC16LF1559): 0 = SDA / SDI function is on RB4 1 = SDA / SDI function is on RA3 bit 3 Unimplemented: Read as `0' bit 2 TXCKSEL: Pin Selection bit(1) 0 = TX/CK function is on RC4 1 = TX/CK function is on RC3 bit 1 GRDBSEL: Pin Selection bit 0 = AD1GRDB function is on RC2, AD2GRDB function is on RC3 1 = AD1GRDB function is on RC3, AD2GRDB function is on RC2 bit 0 GRDASEL: Pin Selection bit 0 = AD1GRDA function is on RC4, AD2GRDA function is on RC5 1 = AD1GRDA function is on RC5, AD2GRDA function is on RC4 Note 1: Bit only implemented on PIC16LF1554. DS40001761A-page 106 2014 Microchip Technology Inc. PIC16LF1554/1559 11.3 PORTA Registers 11.3.1 DATA REGISTER PORTA is a 6-bit wide, bidirectional port. The corresponding data direction register is TRISA (Register 11-3). 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). The exception is RA3, which is input-only and its TRISx bit will always read as `1'. Example 11-1 shows how to initialize an I/O port. Reading the PORTA register (Register 11-2) 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). 11.3.2 DIRECTION CONTROL The TRISA register (Register 11-3) 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 input always read `0'. 11.3.3 ANALOG CONTROL 11.3.4 PORTA FUNCTIONS AND OUTPUT PRIORITIES Each PORTA pin is multiplexed with other functions. The pins, their combined functions and their output priorities are shown in Table 11-2. When multiple outputs are enabled, the actual pin control goes to the peripheral with the highest priority. Analog input functions, such as ADC and comparator inputs, are not shown in the priority lists. These inputs are active when the I/O pin is set for Analog mode using the ANSELx registers. Digital output functions may control the pin when it is in Analog mode with the priority shown below in Table 11-2. TABLE 11-2: PORTA OUTPUT PRIORITY Function Priority(1) Pin Name RA0 ICSPDAT RA0 RA1 RA1 RA2 RA2 RA3 RA3 RA4 CLKOUT RA4 RA5 Note 1: RA5 Priority listed from highest to lowest. The ANSELA register (Register 11-5) 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 TRIS clear and ANSEL 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: The ANSELA bits default to the Analog mode after Reset. To use any pins as digital general purpose or peripheral inputs, the corresponding ANSELx bits must be initialized to `0' by user software. EXAMPLE 11-1: BANKSEL CLRF BANKSEL CLRF BANKSEL CLRF BANKSEL MOVLW MOVWF INITIALIZING PORTA PORTA PORTA LATA LATA ANSELA ANSELA TRISA B'00111000' TRISA ; ;Init PORTA ;Data Latch ; ; ;digital I/O ; ;Set RA<5:3> as inputs ;and set RA<2:0> as ;outputs 2014 Microchip Technology Inc. DS40001761A-page 107 PIC16LF1554/1559 11.4 Register Definitions: PORTA REGISTER 11-2: PORTA: PORTA REGISTER U-0 U-0 R/W-x/x R/W-x/x R-x/x R/W-x/x R/W-x/x R/W-x/x -- -- 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 is return of actual I/O pin values. REGISTER 11-3: TRISA: PORTA TRI-STATE REGISTER U-0 U-0 R/W-1/1 R/W-1/1 U-1 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 bit 1 = PORTA pin configured as an input (tri-stated) 0 = PORTA pin configured as an output bit 3 Unimplemented: Read as `1' bit 2-0 TRISA<2:0>: PORTA Tri-State Control bit 1 = PORTA pin configured as an input (tri-stated) 0 = PORTA pin configured as an output DS40001761A-page 108 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 11-4: 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 is return of actual I/O pin values. REGISTER 11-5: 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 RA4, 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. 2014 Microchip Technology Inc. DS40001761A-page 109 PIC16LF1554/1559 WPUA: WEAK PULL-UP PORTA REGISTER(1,2) REGISTER 11-6: 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 -- -- WPUA5 WPUA4 WPUA3 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(3) 1 = Pull-up enabled 0 = Pull-up disabled Note 1: 2: 3: Global WPUEN bit of the OPTION_REG register must be cleared for individual pull-ups to be enabled. The weak pull-up device is automatically disabled if the pin is configured as an output. For the WPUA3 bit, when MCLRE = 1, weak pull-up is internally enabled, but not reported here. TABLE 11-3: Name 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 -- -- ANSA5 ANSA4 -- ANSA2 ANSA1 ANSA0 109 SSSEL SDSEL -- LATA5 LATA4 -- ANSELA APFCON RXDTSEL SDOSEL -- LATA OPTION_REG -- WPUEN INTEDG TMR0CS TMR0SE TXCKSEL GRDBSEL GRDASEL LATA2 LATA1 PSA LATA0 PS<2:0> 106 109 166 PORTA -- -- RA5 RA4 RA3 RA2 RA1 RA0 108 TRISA -- -- TRISA5 TRISA4 --(1) TRISA2 TRISA1 TRISA0 108 WPUA -- -- WPUA5 WPUA4 WPUA3 WPUA2 WPUA1 WPUA0 110 Legend: x = unknown, u = unchanged, - = unimplemented locations read as `0'. Shaded cells are not used by PORTA. Note 1: Unimplemented, read as `1'. TABLE 11-4: Name CONFIG1 SUMMARY OF CONFIGURATION WORD WITH PORTA Bits Bit -/7 Bit -/6 13:8 -- -- 7:0 CP Bit 13/5 Bit 12/4 -- MCLRE PWRTE -- Bit 11/3 Bit 10/2 Bit 9/1 Bit 8/0 CLKOUTEN BOREN<1:0> -- WDTE<1:0> -- FOSC<2:0> Register on Page 53 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by PORTA. DS40001761A-page 110 2014 Microchip Technology Inc. PIC16LF1554/1559 11.5 11.5.1 PORTB Registers (PIC16LF1559 Only) DATA REGISTER PORTB is a 4-bit wide, bidirectional port. The corresponding data direction register is TRISB (Register 11-8). Setting a TRISB bit (= 1) will make the corresponding PORTB pin an input (i.e., disable the output driver). Clearing a TRISB bit (= 0) will make the corresponding PORTB pin an output (i.e., enables output driver and puts the contents of the output latch on the selected pin). Example 11-1 shows how to initialize an I/O port. Reading the PORTB register (Register 11-7) 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 (LATB). 11.5.2 DIRECTION CONTROL The TRISB register (Register 11-8) controls the PORTB pin output drivers, even when they are being used as analog inputs. The user should ensure the bits in the TRISB register are maintained set when using them as analog inputs. I/O pins configured as analog input always read `0'. 11.5.3 11.5.4 PORTB FUNCTIONS AND OUTPUT PRIORITIES Each PORTB pin is multiplexed with other functions. The pins, their combined functions and their output priorities are shown in Table 11-5. When multiple outputs are enabled, the actual pin control goes to the peripheral with the highest priority. Analog input functions, such as ADC and comparator inputs, are not shown in the priority lists. These inputs are active when the I/O pin is set for Analog mode using the ANSELx registers. Digital output functions may control the pin when it is in Analog mode with the priority shown below in Table 11-5. TABLE 11-5: PORTB OUTPUT PRIORITY Function Priority(1) Pin Name RB4 SDA RB4 RB5 RB5 RB6 SCL SCK RB6 RB7 TX RB7 Note 1: Priority listed from highest to lowest. ANALOG CONTROL The ANSELB register (Register 11-10) is used to configure the Input mode of an I/O pin to analog. Setting the appropriate ANSELB 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 ANSELB bits has no effect on digital output functions. A pin with TRIS clear and ANSEL 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: The ANSELB bits default to the Analog mode after Reset. To use any pins as digital general purpose or peripheral inputs, the corresponding ANSELx bits must be initialized to `0' by user software. 2014 Microchip Technology Inc. DS40001761A-page 111 PIC16LF1554/1559 11.6 Register Definitions: PORTB REGISTER 11-7: R/W-x/x PORTB: PORTB REGISTER R/W-x/x RB7 RB6 R/W-x/x R/W-x/x U-0 U-0 U-0 U-0 RB4 -- -- -- -- RB5 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 RB<7:4>: PORTB I/O Value bits(1) 1 = Port pin is > VIH 0 = Port pin is < VIL bit 3-0 Unimplemented: Read as `0' Note 1: Writes to PORTB are actually written to corresponding LATB register. Reads from PORTB register is return of actual I/O pin values. REGISTER 11-8: TRISB: PORTB TRI-STATE REGISTER R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 U-0 U-0 U-0 U-0 TRISB7 TRISB6 TRISB5 TRISB4 -- -- -- -- 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 TRISB<7:4>: PORTB Tri-State Control bits 1 = PORTB pin configured as an input (tri-stated) 0 = PORTB pin configured as an output bit 3-0 Unimplemented: Read as `0' DS40001761A-page 112 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 11-9: LATB: PORTB DATA LATCH REGISTER R/W-x/u R/W-x/u R/W-x/u R/W-x/u U-0 U-0 U-0 U-0 LATB7 LATB6 LATB5 LATB4 -- -- -- -- 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 LATB<7:4>: RB<7:4> Output Latch Value bits(1) bit 3-0 Unimplemented: Read as `0' Note 1: Writes to PORTB are actually written to corresponding LATB register. Reads from PORTB register is return of actual I/O pin values. REGISTER 11-10: ANSELB: PORTB ANALOG SELECT REGISTER R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 U-0 U-0 U-0 U-0 ANSB7 ANSB6 ANSB5 ANSB4 -- -- -- -- 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 ANSB<7:4>: Analog Select between Analog or Digital Function on pins RB<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-0 Unimplemented: Read as `0' 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. 2014 Microchip Technology Inc. DS40001761A-page 113 PIC16LF1554/1559 REGISTER 11-11: WPUB: WEAK PULL-UP PORTB REGISTER(1,2) R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 U-0 U-0 U-0 U-0 WPUB7 WPUB6 WPUB5 WPUB4 -- -- -- -- 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 WPUB<7:4>: Weak Pull-up Register bits 1 = Pull-up enabled 0 = Pull-up disabled bit 3-0 Unimplemented: Read as `0' Note 1: 2: Global WPUEN bit of the OPTION_REG register must be cleared for individual pull-ups to be enabled. The weak pull-up device is automatically disabled if the pin is configured as an output. SUMMARY OF REGISTERS ASSOCIATED WITH PORTB(1) TABLE 11-6: Name ANSELB APFCON Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page ANSB7 ANSB6 ANSB5 ANSB4 -- -- -- -- 113 SSSEL SDSEL -- LATB5 LATB4 -- RXDTSEL SDOSEL LATB LATB7 OPTION_REG WPUEN LATB6 INTEDG TMR0CS TMR0SE TXCKSEL GRDBSEL GRDASEL -- -- PSA -- PS<2:0> 106 113 166 PORTB RB7 RB6 RB5 RB4 -- -- -- -- 112 TRISB TRISB7 TRISB6 TRISB5 TRISB4 -- -- -- -- 112 WPUB WPUB7 WPUB6 WPUB5 WPUB4 -- -- -- -- 114 Legend: x = unknown, u = unchanged, - = unimplemented locations read as `0'. Shaded cells are not used by PORTB. Note 1: PIC16LF1559 only. TABLE 11-7: Name CONFIG1 SUMMARY OF CONFIGURATION WORD WITH PORTB Bits Bit -/7 13:8 -- 7:0 CP Bit -/6 Bit 13/5 Bit 12/4 Bit 11/3 -- -- -- CLKOUTEN MCLRE PWRTE WDTE<1:0> Bit 10/2 Bit 9/1 BOREN<1:0> -- Bit 8/0 -- FOSC<1:0> Register on Page 53 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by PORTB. DS40001761A-page 114 2014 Microchip Technology Inc. PIC16LF1554/1559 11.7 11.7.1 PORTC Registers DATA REGISTER PORTC is a 8-bit wide, bidirectional port. The corresponding data direction register is TRISC (Register 11-13). Setting a TRISC bit (= 1) will make the corresponding PORTC pin an input (i.e., disable the output driver). 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). Example 11-1 shows how to initialize an I/O port. Reading the PORTC register (Register 11-12) 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). 11.7.2 DIRECTION CONTROL The TRISC register (Register 11-13) 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 input always read `0'. 11.7.3 ANALOG CONTROL The ANSELC register (Register 11-15) 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. 11.7.4 PORTC FUNCTIONS AND OUTPUT PRIORITIES Each PORTC pin is multiplexed with other functions. The pins, their combined functions and their output priorities are shown in Table 11-8. When multiple outputs are enabled, the actual pin control goes to the peripheral with the highest priority. Analog input and some digital input functions are not included in the output priority list. These input functions can remain active when the pin is configured as an output. Certain digital input functions override other port functions and are included in the output priority list. TABLE 11-8: PORTC OUTPUT PRIORITY Function Priority(1) Pin Name RC0 RC0 RC1 RC1 RC2 PWM1 RC2 RC4 RC4 RC5 RC5 RC6 RC6 RC7 SDO RC7 Note 1: Priority listed from highest to lowest. The state of the ANSELC bits has no effect on digital output functions. A pin with TRIS clear and ANSEL 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: The ANSELC bits default to the Analog mode after Reset. To use any pins as digital general purpose or peripheral inputs, the corresponding ANSELx bits must be initialized to `0' by user software. 2014 Microchip Technology Inc. DS40001761A-page 115 PIC16LF1554/1559 11.8 Register Definitions: PORTC REGISTER 11-12: PORTC: PORTC REGISTER R/W-x/u R/W-x/u RC7(1) (1) RC6 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-0 Note 1: RC<7:0>: PORTC General Purpose I/O Pin bits 1 = Port pin is > VIH 0 = Port pin is < VIL Functions not available on PIC16LF1554. REGISTER 11-13: TRISC: PORTC TRI-STATE 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 R/W-1/1 TRISC7(1) TRISC6(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-0 Note 1: TRISC<7:0>: PORTC Tri-State Control bits 1 = PORTC pin configured as an input (tri-stated) 0 = PORTC pin configured as an output Functions not available on PIC16LF1554. DS40001761A-page 116 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 11-14: LATC: PORTC DATA LATCH REGISTER R/W-x/u R/W-x/u LATC7(1) (1) LATC6 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 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 LATC<7:0>: PORTC Output Latch Value bits(2) bit 7-0 Note 1: 2: Functions not available on PIC16LF1554. Writes to PORTC are actually written to corresponding LATC register. Reads from PORTC register is return of actual I/O pin values. REGISTER 11-15: ANSELC: PORTC ANALOG SELECT 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 R/W-1/1 ANSC7(1) ANSC6(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-0 Note 1: 2: ANSC<7:0>: Analog Select between Analog or Digital Function on pins RC<7:0>, respectively 1 = Analog input. Pin is assigned as analog input(2). Digital input buffer disabled. 0 = Digital I/O. Pin is assigned to port or digital special function. Functions not available on PIC16LF1554. 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. TABLE 11-9: Name ANSELC LATC PORTC TRISC Legend: Note 1: SUMMARY OF REGISTERS ASSOCIATED WITH PORTC Bit 7 Bit 6 ANSC7(1) ANSC6(1) (1) LATC7 (1) RC7 LATC6(1) RC6(1) TRISC7(1) TRISC6(1) Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page ANSC5 ANSC4 ANSC3 ANSC2 ANSC1 ANSC0 117 LATC5 LATC4 LATC3 LATC2 LATC1 LATC0 117 RC5 RC4 RC3 RC2 RC1 RC0 116 TRISC5 TRISC4 TRISC3 TRISC2 TRISC1 TRISC0 116 x = unknown, u = unchanged, - = unimplemented locations read as `0'. Shaded cells are not used by PORTC. Functions not available on PIC16LF1554. 2014 Microchip Technology Inc. DS40001761A-page 117 PIC16LF1554/1559 12.0 INTERRUPT-ON-CHANGE The PORTA and PORTB pins can be configured to operate as Interrupt-On-Change (IOC) pins. An interrupt can be generated by detecting a signal that has either a rising edge or a falling edge. Any individual port pin, or combination of port 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 Figure 12-1 is a block diagram of the IOC module. 12.1 Enabling the Module 12.3 Interrupt Flags The IOCAFx and IOCBFx bits located in the IOCAF and IOCBF registers, respectively, are status flags that correspond to the interrupt-on-change pins of the associated 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 INTCON register reflects the status of all IOCAFx and IOCBFx bits. 12.4 Clearing Interrupt Flags The individual status flags, (IOCAFx and IOCBFx 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. To allow individual port pins to generate an interrupt, the IOCIE bit of the INTCON 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. 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. 12.2 Individual Pin Configuration EXAMPLE 12-1: For each port 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. MOVLW XORWF ANDWF A pin can be configured to detect rising and falling edges simultaneously by setting both associated bits of the IOCxP and IOCxN registers, respectively. 12.5 CLEARING INTERRUPT FLAGS (PORTA EXAMPLE) 0xff IOCAF, W IOCAF, F Operation in Sleep The interrupt-on-change interrupt sequence will wake the device from Sleep mode, if the IOCIE bit is set. If an edge is detected while in Sleep mode, the IOCxF register will be updated prior to the first instruction executed out of Sleep. DS40001761A-page 118 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 12-1: INTERRUPT-ON-CHANGE BLOCK DIAGRAM (PORTA EXAMPLE) Rev. 10-000037A 7/30/2013 IOCANx D Q R Q4Q1 edge detect RAx IOCAPx D data bus = 0 or 1 Q write IOCAFx R D S to data bus IOCAFx Q R IOCIE Q2 IOC interrupt to CPU core from all other IOCnFx individual pin detectors FOSC Q1 Q1 Q3 Q2 Q3 Q4 Q4Q1 Q1 Q2 Q2 Q3 Q4 Q4Q1 2014 Microchip Technology Inc. Q4 Q4Q1 Q4Q1 DS40001761A-page 119 PIC16LF1554/1559 12.6 Register Definitions: Interrupt-on-Change Control REGISTER 12-1: IOCAP: INTERRUPT-ON-CHANGE PORTA POSITIVE 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 -- -- IOCAP5 IOCAP4 IOCAP3 IOCAP2 IOCAP1 IOCAP0 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 12-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 IOCAN0 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. REGISTER 12-3: IOCAF: INTERRUPT-ON-CHANGE PORTA FLAG REGISTER U-0 U-0 R/W/HS-0/0 R/W/HS-0/0 R/W/HS-0/0 R/W/HS-0/0 R/W/HS-0/0 R/W/HS-0/0 -- -- IOCAF5 IOCAF4 IOCAF3 IOCAF2 IOCAF1 IOCAF0 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-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. DS40001761A-page 120 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 12-4: IOCBP: INTERRUPT-ON-CHANGE PORTB POSITIVE EDGE REGISTER R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 U-0 U-0 U-0 U-0 IOCBP7 IOCBP6 IOCBP5 IOCBP4 -- -- -- -- 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 IOCBP<7:4>: Interrupt-on-Change PORTB Positive Edge Enable bits 1 = Interrupt-on-Change enabled on the pin for a positive going edge. IOCBFx bit and IOCIF flag will be set upon detecting an edge. 0 = Interrupt-on-Change disabled for the associated pin. bit 3-0 Unimplemented: Read as `0' REGISTER 12-5: IOCBN: INTERRUPT-ON-CHANGE PORTB NEGATIVE EDGE REGISTER R/W-0/0 R/W-0/0 R/W-0/0 R/W-0/0 U-0 U-0 U-0 U-0 IOCBN7 IOCBN6 IOCBN5 IOCBN4 -- -- -- -- 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 IOCBN<7:4>: Interrupt-on-Change PORTB Negative Edge Enable bits 1 = Interrupt-on-Change enabled on the pin for a negative going edge. IOCBFx bit and IOCIF flag will be set upon detecting an edge. 0 = Interrupt-on-Change disabled for the associated pin. bit 3-0 Unimplemented: Read as `0' REGISTER 12-6: IOCBF: INTERRUPT-ON-CHANGE PORTB FLAG REGISTER R/W/HS-0/0 R/W/HS-0/0 R/W/HS-0/0 R/W/HS-0/0 U-0 U-0 U-0 U-0 IOCBF7 IOCBF6 IOCBF5 IOCBF4 -- -- -- -- bit 7 bit 0 Legend: R = Readable bit W = Writable bit u = Bit is unchanged x = Bit is unknown U = Unimplemented bit, read as `0' -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-4 IOCBF<7:4>: Interrupt-on-Change PORTB Flag bits 1 = An enabled change was detected on the associated pin. Set when IOCBPx = 1 and a rising edge was detected on RBx, or when IOCBNx = 1 and a falling edge was detected on RBx. 0 = No change was detected, or the user cleared the detected change. bit 3-0 Unimplemented: Read as `0' 2014 Microchip Technology Inc. DS40001761A-page 121 PIC16LF1554/1559 TABLE 12-1: Name SUMMARY OF REGISTERS ASSOCIATED WITH INTERRUPT-ON-CHANGE Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page ANSELA -- -- ANSA5 ANSA4 -- ANSA2 ANSA1 ANSA0 109 INTCON GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 IOCAF -- -- IOCAF5 IOCAF4 IOCAF3 IOCAF2 IOCAF1 IOCAF0 120 IOCAN -- -- IOCAN5 IOCAN4 IOCAN3 IOCAN2 IOCAN1 IOCAN0 120 IOCAP -- -- IOCAP5 IOCAP4 IOCAP3 IOCAP2 IOCAP1 IOCAP0 120 IOCBF IOCBF7 IOCBF6 IOCBF5 IOCBF4 -- -- -- -- 121 IOCBN IOCBN7 IOCBN6 IOCBN5 IOCBN4 -- -- -- -- 121 IOCBP IOCBP7 IOCBP6 IOCBP5 IOCBP4 -- -- -- -- 121 TRISA2 TRISA1 TRISA0 108 -- -- -- 112 TRISA -- -- TRISA5 TRISA4 --(1) TRISB TRISB7 TRISB6 TRISB5 TRISB4 -- Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by interrupt-on-change. Note 1: Unimplemented, read as `1'. DS40001761A-page 122 2014 Microchip Technology Inc. PIC16LF1554/1559 13.0 FIXED VOLTAGE REFERENCE (FVR) 13.1 Independent Gain Amplifier The output of the FVR supplied to the ADC is routed through a programmable gain amplifier. Each amplifier can be programmed for a gain of 1x or 2x, to produce the two possible voltage levels. The Fixed Voltage Reference, or FVR, is a stable voltage reference, independent of VDD, with 1.024V and 2.048V selectable output levels. The output of the FVR can be configured as the FVR input channel on the ADC. 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 15.0 "Analog-to-Digital Converter (ADC) Module" for additional information. The FVR can be enabled by setting the FVREN bit of the FVRCON register. 13.2 FVR Stabilization Period When the Fixed Voltage Reference module is enabled, it requires time for the reference and amplifier circuits to stabilize. Once the circuits stabilize and are ready for use, the FVRRDY bit of the FVRCON register will be set. See Section 25.0 "Electrical Specifications" for the minimum delay requirement. FIGURE 13-1: VOLTAGE REFERENCE BLOCK DIAGRAM ADFVR<1:0> 2 FVR BUFFER1 (To ADC Module) x1 x2 1.024V Fixed Reference + FVREN - FVRRDY Any peripheral requiring the Fixed Reference (See Table 13-1) TABLE 13-1: Peripheral HFINTOSC BOR PERIPHERALS REQUIRING THE FIXED VOLTAGE REFERENCE (FVR) Conditions Description FOSC<1:0> = 00 and IRCF<3:0> = 000x INTOSC is active and device is not in Sleep. BOREN<1:0> = 11 BOR always enabled. BOREN<1:0> = 10 and BORFS = 1 BOR disabled in Sleep mode, BOR Fast Start enabled. BOREN<1:0> = 01 and BORFS = 1 BOR under software control, BOR Fast Start enabled. 2014 Microchip Technology Inc. DS40001761A-page 123 PIC16LF1554/1559 13.3 Register Definitions: FVR Control REGISTER 13-1: FVRCON: FIXED VOLTAGE REFERENCE CONTROL REGISTER R/W-0/0 R-q/q R/W-0/0 R/W-0/0 U-0 U-0 FVREN FVRRDY TSEN TSRNG -- -- R/W-0/0 R/W-0/0 ADFVR<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 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 = 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(1) 1 = Temperature Indicator is enabled 0 = Temperature Indicator is disabled bit 4 TSRNG: Temperature Indicator Range Selection bit(1) 1 = VOUT = VDD - 4VT (High Range) 0 = VOUT = VDD - 2VT (Low Range) bit 3-2 Unimplemented: Read as `0' bit 1-0 ADFVR<1:0>: ADC Fixed Voltage Reference Selection bit 11 = ADC Fixed Voltage Reference Peripheral output is off 10 = ADC Fixed Voltage Reference Peripheral output is 2x (2.048V)(2) 01 = ADC Fixed Voltage Reference Peripheral output is 1x (1.024V) 00 = ADC Fixed Voltage Reference Peripheral output is off Note 1: 2: See Section 14.0 "Temperature Indicator Module" for additional information. Fixed Voltage Reference output cannot exceed VDD. TABLE 13-2: Name FVRCON SUMMARY OF REGISTERS ASSOCIATED WITH THE FIXED VOLTAGE REFERENCE Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 FVREN FVRRDY TSEN TSRNG -- -- Bit 1 Bit 0 ADFVR<1:0> Register on page 124 Legend: Shaded cells are unused by the Fixed Voltage Reference module. DS40001761A-page 124 2014 Microchip Technology Inc. PIC16LF1554/1559 14.0 TEMPERATURE INDICATOR MODULE FIGURE 14-1: This family of devices is equipped with a temperature circuit designed to measure the operating temperature of the silicon die. The circuit's range of operating temperature falls between -40C and +85C. The output is a voltage that is proportional to the device temperature. The output of the temperature indicator is internally connected to the device ADC. Rev. 10-000069A 7/31/2013 VDD TSEN The circuit may be used as a temperature threshold detector or a more accurate temperature indicator, depending on the level of calibration performed. A onepoint 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. Reference Application Note AN1333, "Use and Calibration of the Internal Temperature Indicator" (DS01333) for more details regarding the calibration process. 14.1 TEMPERATURE CIRCUIT DIAGRAM TSRNG VOUT Temp. Indicator To ADC Circuit Operation Figure 14-1 shows a simplified block diagram of the temperature circuit. The proportional voltage output is achieved by measuring the forward voltage drop across multiple silicon junctions. Equation 14-1 describes the output characteristics of the temperature indicator. EQUATION 14-1: VOUT RANGES High Range: VOUT = VDD - 4VT Low Range: VOUT = VDD - 2VT The temperature sense circuit is integrated with the Fixed Voltage Reference (FVR) module. See Section 13.0 "Fixed Voltage Reference (FVR)" for more information. The circuit is enabled by setting the TSEN bit of the FVRCON register. When disabled, the circuit draws no current. The 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, but may be less consistent from part to part. This range requires a higher bias voltage to operate and thus, a higher VDD is needed. 14.2 Minimum Operating VDD 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. Table 14-1 shows the recommended minimum VDD vs. range setting. TABLE 14-1: RECOMMENDED VDD vs. RANGE Min. VDD, TSRNG = 1 Min. VDD, TSRNG = 0 3.6V 1.8V 14.3 Temperature Output 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 15.0 "Analog-to-Digital Converter (ADC) Module" for detailed information. The low range is selected by clearing the TSRNG bit of the FVRCON register. The low range generates a lower voltage drop and thus, a lower bias voltage is needed to operate the circuit. The low range is provided for low voltage operation. 2014 Microchip Technology Inc. DS40001761A-page 125 PIC16LF1554/1559 14.4 ADC Acquisition Time To ensure accurate temperature measurements, the user must wait at least 200 s after the ADC input multiplexer is connected to the temperature indicator output before the conversion is performed. In addition, the user must wait 200 s between sequential conversions of the temperature indicator output. TABLE 14-2: Name FVRCON SUMMARY OF REGISTERS ASSOCIATED WITH THE TEMPERATURE INDICATOR Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 FVREN FVRRDY TSEN TSRNG -- -- Bit 1 Bit 0 ADFVR<1:0> Register on page 118 Legend: Shaded cells are unused by the temperature indicator module. DS40001761A-page 126 2014 Microchip Technology Inc. PIC16LF1554/1559 15.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 (ADxRESxH:ADxRESxL register pair). FIGURE 15-1: The ADC can generate an interrupt upon completion of a conversion. This interrupt can be used to wake-up the device from Sleep. The PIC16LF1554/1559 has two ADCs, which can operate together or separately. Both ADCs can generate an interrupt upon completion of a conversion. This interrupt can be used to wake up the device from Sleep. Figure 15-1 shows the block diagram of the two ADCs. ADC SIMPLIFIED BLOCK DIAGRAM AAD1CON3 AAD1PRE AAD1ACQ AAD1GRD AAD1CAP AN1x AN0 AN1 AN2 AN10 AN11 AN12 AN13 AN14(1) AN15(1) AN16(1) VREFH Temp Indicator FVR Buffer1 AD1ON AD1RESxH CH1x EN Hardware CVD 16 10 IN ADC1 OUT GO VPOS CLK AD1RESxL AAD1CH - Secondary Channel Select 0 = Left Justify 1 = Right Justify Automatic Trigger Sources TRIGSEL1<2:0> CHS1<4:0> GO/DONE1 OR Positive Voltage Reference Clock Source ADPREF<1:0> ADCS<2:0> GO/DONE_ALL GO/DONE2 OR ADFM Automatic Trigger Sources AN20 AN21 AN22 AN23 AN24(1) AN25(1) AN26(1) TRIGSEL2<2:0> CH2x VREFH Temp Indicator FVR Buffer2 CHS2<4:0> Note 1: 2: GO VPOS CLK IN ADC2 OUT Hardware CVD EN AAD2CH - Secondary Channel Select AN2x AAD2CAP AAD2GRD AAD2ACQ AAD2PRE AAD2CON3 10 0 = Left Justify 1 = Right Justify 16 AD2RESxH AD2RESxL AD2ON PIC16LF1559 only. See Section 16.0 "Hardware Capacitive Voltage Divider (CVD) Module" for more information. 2014 Microchip Technology Inc. DS40001761A-page 127 PIC16LF1554/1559 15.1 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 15.1.1 PORT CONFIGURATION The ADC can be used to convert both analog and digital signals. When converting analog signals, the I/O pin should be configured for analog by setting the associated TRISx and ANSELx bits. Refer to Section 11.0 "I/O Ports" for more information. Note: 15.1.2 Analog voltages on any pin that is defined as a digital input may cause the input buffer to conduct excess current. CHANNEL SELECTION There are 11 channel selections available for PIC16LF1554 and 17 for PIC16LF1559. Three channels (AN0, AN1 and AN2) can be selected by both ADC1 and ADC2. The following channels can be selected by either of the ADCs: * * * * 15.1.4 CONVERSION CLOCK The source of the conversion clock is software selectable via the ADCS bits of the ADCON1 register. There are seven possible clock options: * * * * * * * FOSC/2 FOSC/4 FOSC/8 FOSC/16 FOSC/32 FOSC/64 FRC (internal 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 15-2. For correct conversion, the appropriate TAD specification must be met. Refer to the ADC conversion requirements in Section 25.0 "Electrical Specifications" for more information. Table 15-1 gives examples of appropriate ADC clock selections. Note: Unless using the FRC, any changes in the system clock frequency will change the ADC clock frequency, which may adversely affect the ADC result. AN<27:0> pins Temperature Indicator FVR Buffer 1 VREFH The CHSx bits of the ADxCON0 register determine which channel is connected to the sample and hold circuit of ADCx. When changing channels, a delay (TACQ) is required before starting the next conversion. Refer to Section 15.2.6 "Individual ADC Conversion Procedure" for more information. 15.1.3 ADC VOLTAGE REFERENCE The ADC module uses a positive and a negative voltage reference. The positive reference is labeled VREFH and the negative reference is labeled VREFL. The positive voltage reference (VREFH) is selected by the ADPREF bits in the ADCON1 register. The positive voltage reference source can be: * VREF+ pin * VDD The negative voltage reference (VREFL) source is: * VSS DS40001761A-page 128 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 15-1: ADC CLOCK PERIOD (TAD) vs. DEVICE OPERATING FREQUENCIES(1) ADC Clock Period (TAD) ADC Clock Source Device Frequency (FOSC) ADCS<2:0> 32 MHz 20 MHz 16 MHz 8 MHz 4 MHz 1 MHz Fosc/2 000 62.5 ns 100 ns 125 ns 250 ns 500 ns 2.0 s Fosc/4 100 125 ns 200 ns 250 ns 500 ns 1.0 s 4.0 s Fosc/8 001 250 ns 400 ns 500 ns 1.0 s 2.0 s 8.0 s Fosc/16 101 500 ns 800 ns 1.0 s 2.0 s 4.0 s 16.0 s Fosc/32 010 1.0 s 1.6 s 2.0 s 4.0 s 8.0 s 32.0 s Fosc/64 110 2.0 s 3.2 s 4.0 s 8.0 s 16.0 s 64.0 s FRC x11 1.0-6.0 s 1.0-6.0 s 1.0-6.0 s 1.0-6.0 s 1.0-6.0 s 1.0-6.0 s Legend: Shaded cells are outside of recommended range. Note 1: The TAD period when using the FRC clock source can fall within a specified range, (see TAD parameter). The TAD period when using the FOSC-based clock source can be configured for a more precise TAD period. However, the FRC clock source must be used when conversions are to be performed with the device in Sleep mode. FIGURE 15-2: ANALOG-TO-DIGITAL CONVERSION TAD CYCLES TAD1 TAD2 TAD3 TAD4 TAD5 b9 b8 b7 b6 TAD6 TAD7 b5 b4 TAD8 b3 TAD9 TAD10 TAD11 b2 b1 b0 THCD Conversion Starts TACQ Holding capacitor disconnected from analog input (THCD) Set GO/DONEx bit On the following cycle: ADxRESxH:ADxRESxL is loaded, GO/DONEx bit is cleared, ADxIF bit is set, holding capacitor is reconnected to analog input. Enable ADC (ADxON bit) and Select channel (ACS bits) 2014 Microchip Technology Inc. DS40001761A-page 129 PIC16LF1554/1559 15.1.5 INTERRUPTS 15.1.6 The ADC module allows for the ability to generate an interrupt upon completion of an Analog-to-Digital conversion. The ADCx interrupt flag is the ADxIF bit in the PIRx register. The ADCx interrupt enable is the ADxIE bit in the PIEx register. The ADxIF 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/ADCOMCON register controls the output format. Figure 15-3 shows the two output formats. Note 1: The ADxIF bit is set at the completion of every conversion, regardless of whether or not the ADCx interrupt is enabled. 2: The ADC operates during Sleep only when the FRC 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 GIE and PEIE bits of the INTCON register must be disabled. If the GIE and PEIE bits of the INTCON register are enabled, execution will switch to the Interrupt Service Routine. FIGURE 15-3: 10-BIT ADC CONVERSION RESULT FORMAT ADxRESxL ADxRESxH (ADFM = 0) MSB LSB bit 7 bit 0 bit 7 Unimplemented: Read as `0' 10-bit ADC Result (ADFM = 1) bit 0 LSB MSB bit 7 Unimplemented: Read as `0' DS40001761A-page 130 bit 0 bit 7 bit 0 10-bit ADC Result 2014 Microchip Technology Inc. PIC16LF1554/1559 15.2 15.2.1 ADC Operation STARTING A CONVERSION To enable the ADCx module, the ADxON bit of the ADxCON0 register must be set to a `1'. Setting the GO/DONEx bit of the ADxCON0 register to a `1' will start the Analog-to-Digital Conversion. Setting the GO/DONE_ALL bit of the ADCON1/ ADCOMCON register to a `1' will start the Analog-to-Digital conversion for both ADC1 and ADC2, which is called synchronized conversion. Note: 15.2.2 The GO/DONEx bit should not be set in the same instruction that turns on the ADC. Refer to Section 15.2.6 "Individual ADC Conversion Procedure". COMPLETION OF A CONVERSION When the conversion is complete, the ADC module will: * Clear the GO/DONEx bit * Clear the GO/DONE_ALL bit if a synchronized conversion is done * Set the ADxIF interrupt flag bit * Update the ADxRESxH and ADxRESxL registers with new conversion result Note: 15.2.3 Only ADxRES0 will be updated after a single sample conversion. The completion of a double sample conversion will update both ADxRES0 and ADxRES1 registers. Refer to Section 16.1.6 "Double Sample Conversion" for more information. TERMINATING A CONVERSION If a conversion must be terminated before completion, the GO/DONEx bit can be cleared in software. If the GO/DONE_ALL bit is cleared in software, the synchronized conversion will stop. The ADxRESxH and ADxRESxL registers will be updated with the partially complete Analog-to-Digital conversion sample. Incomplete bits will match the last bit converted. Note: 15.2.4 ADC OPERATION DURING SLEEP The ADC module can operate during Sleep. This requires the ADC clock source to be set to the FRC option. Performing the ADC conversion during Sleep can reduce system noise. 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 ADxON bit remains set. When the ADC clock source is something other than FRC, a SLEEP instruction causes the present conversion to be aborted and the ADC module is turned off, although the ADxON bit remains set. 15.2.5 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/ DONEx bit is set by hardware. The auto-conversion trigger source is selected with the TRIGSEL1<2:0> bits of the ADxCON2 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 15-2 for auto-conversion sources. TABLE 15-2: AUTO-CONVERSION SOURCES Source Peripheral Trigger Event Timer0 Timer0 Overflow Timer1 Timer1 Overflow Timer2 Timer2 matches PR2 ADTRIG pin ADTRIG Rising Edge ADTRIG pin ADTRIG Falling Edge A device Reset forces all registers to their Reset state. Thus, the ADC module is turned off and any pending conversion is terminated. 2014 Microchip Technology Inc. DS40001761A-page 131 PIC16LF1554/1559 15.2.6 INDIVIDUAL ADC CONVERSION PROCEDURE This is an example procedure for using the ADCx to perform an Analog-to-Digital conversion: 1. 2. 3. 4. 5. 6. 7. 8. Configure Port: * Disable pin output driver (Refer to the TRISx register) * Configure pin as analog (Refer to the ANSELx register) Configure the ADCx module: * Select ADCx conversion clock * Configure voltage reference * Select ADCx input channel * Turn on ADCx module Configure ADCx interrupt (optional): * Clear ADCx interrupt flag * Enable ADCx interrupt * Enable peripheral interrupt * Enable global interrupt(1) Wait the required acquisition time(2). Start conversion by setting the GO/DONEx bit. Wait for ADCx conversion to complete by one of the following: * Polling the GO/DONEx bit * Waiting for the ADCx interrupt (interrupts enabled) Read ADCx Result. Clear the ADCx interrupt flag (required if interrupt is enabled). EXAMPLE 15-1: ADC CONVERSION ;This code block configures the ADC1 ;for polling, Vdd and Vss references, FRC ;oscillator and AN0 input. ; ;Conversion start and polling for completion ;are included. ; BANKSEL ADCON1 ; MOVLW B'11110000' ;Right justify, FRC ;oscillator MOVWF ADCON1 ;VDD is VREFH 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 MOVLW .5 MOVWF AAD1ACQ ;Acquisiton delay BSF ADCON0,ADGO ;Start conversion BTFSC ADCON0,ADGO ;Is conversion done? GOTO $-1 ;No, test again BANKSEL AD1RES0H ; MOVF AD1RES0H,W ;Read upper 2 bits MOVWF RESULTHI ;store in GPR space BANKSEL AD1RES0L ; MOVF AD1RES0L,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 15.4 "ADC Acquisition Requirements". DS40001761A-page 132 2014 Microchip Technology Inc. PIC16LF1554/1559 15.3 Register Definitions: ADC Control REGISTER 15-1: ADCON0(1)/AD1CON0(2): ANALOG-TO-DIGITAL (ADC) 1 CONTROL REGISTER 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 R/W-0/0 -- CHS14 CHS13 CHS12 CHS11 CHS10 GO/DONE1(4) AD1ON 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-2 CHS1<4:0>: Analog Channel Select bits for ADC1 00000 = Channel 0, (AN0) 00001 = Channel 1, (AN1) 00010 = Channel 2, (AN2) 00011 = Reserved 00100 = Reserved 00101 = Reserved 00110 = Reserved 00111 = Reserved 01000 = Reserved 01001 = Reserved 01010 = Channel 10, (AN10) 01011 = Channel 11, (AN11) 01100 = Channel 12, (AN12) 01101 = Channel 13, (AN13) 01110 = Channel 14, (AN14)(3) 01111 = Channel 15, (AN15)(3) 10000 = Channel 16, (AN16)(3) 10001 = Reserved 10010 = Reserved 10011 = Reserved 10100 = Reserved 10101 = Reserved 10110 = Reserved 10111 = Reserved 11000 = Reserved 11001 = Reserved 11010 = Reserved 11011 = VREFH (ADC Positive Reference) 11100 = Reserved 11101 = Temperature Indicator 11110 = Reserved 11111 = Fixed Voltage Reference (FVREF) Buffer 1 Output bit 1 GO/DONE1: ADC1 Conversion Status bit (4) If AD1ON = 1 1 = ADC conversion in progress. Setting this bit starts the ADC conversion. When the RC clock source is selected, the ADC module waits one instruction before starting the conversion. 0 = ADC conversion not in progress (This bit is automatically cleared by hardware when the ADC conversion is complete.) If this bit is cleared while a conversion is in progress, the conversion will stop and the results of the conversion up to this point will be transferred to the result registers, but the AD1IF interrupt flag bit will not be set. If AD1ON = 0 0 = ADC conversion not in progress bit 0 AD1ON: ADC Module 1 Enable bit 1 = ADC converter module 1 is operating 0 = ADC converter module 1 is shut off and consumes no operating current. All Analog channels are disconnected. Note 1: 2: 3: 4: Bank 1 name is ADCON0. Bank 14 name is AD1CON0. PIC16LF1559 only. Not implemented on PIC16LF1554. When the AD1DSEN bit is set; the GO/DONE1 bit will clear after a second conversion has completed. 2014 Microchip Technology Inc. DS40001761A-page 133 PIC16LF1554/1559 REGISTER 15-2: AD2CON0: ANALOG-TO-DIGITAL (ADC) 2 CONTROL REGISTER 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 R/W-0/0 -- CHS24 CHS23 CHS22 CHS21 CHS20 GO/DONE2(2) AD2ON 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-2 CHS2<4:0>: Analog Channel Select bits for ADC2 When AD2ON = 0, all multiplexer inputs are disconnected. 00000 = Channel 0, (AN0) 00001 = Channel 1, (AN1) 00010 = Channel 2, (AN2) 00011 = Reserved 00100 = Reserved 00101 = Reserved 00110 = Reserved 00111 = Reserved 01000 = Reserved 01001 = Reserved 01010 = Reserved 01011 = Reserved 01100 = Reserved 01101 = Reserved 01110 = Reserved 01111 = Reserved 10000 = Reserved 10001 = Reserved 10010 = Reserved 10011 = Reserved 10100 = Channel 20, (AN20) 10101 = Channel 21, (AN21) 10110 = Channel 22, (AN22) 10111 = Channel 23, (AN23) 11000 = Channel 24, (AN24)(1) 11001 = Channel 25, (AN25)(1) 11010 = Channel 26, (AN26)(1) 11011 = VREFH (ADC Positive Reference) 11100 = Reserved 11101 = Temperature Indicator 11110 = Reserved 11111 = Fixed Voltage Reference (FVREF) bit 1 GO/DONE2: ADC2 Conversion Status bit(2) If AD2ON = 1 1 = ADC conversion in progress. Setting this bit starts the ADC conversion. When the RC clock source is selected, the ADC Module waits one instruction before starting the conversion. 0 = ADC conversion not in progress (This bit is automatically cleared by hardware when the ADC conversion is complete.) If this bit is cleared while a conversion is in progress, the conversion will stop and the results of the conversion up to this point will be transferred to the result registers, but the AD2IF interrupt flag bit will not be set. If AD2ON = 0 0 = ADC conversion not in progress bit 0 AD2ON: ADC Module 2 Enable bit 1 = ADC converter module 2 is operating 0 = ADC converter module 2 is shut off and consumes no operating current. All Analog channels are disconnected. Note 1: 2: PIC16LF1559 only. Not implemented on PIC16LF1554. When the AD2DSEN bit is set; the GO/DONE2 bit will clear after a second conversion has completed. DS40001761A-page 134 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 15-3: R/W-0/0 ADCON1(1)/ADCOMCON(2): ADC CONTROL REGISTER 1 R/W-0/0 ADFM R/W-0/0 R/W-0/0 ADCS<2:0> U-0 R/W-0/0 -- GO/DONE_ALL 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 ADxRESxH are set to `0' when the conversion result is loaded. 0 = Left justified. Six Least Significant bits of ADxRESxL are set to `0' when the conversion result is loaded. bit 6-4 ADCS<2:0>: ADC Conversion Clock Select bits 000 = FOSC/2 001 = FOSC/8 010 = FOSC/32 011 = FRC (clock supplied from an internal RC oscillator) 100 = FOSC/4 101 = FOSC/16 110 = FOSC/64 111 = FRC (clock supplied from an internal RC oscillator) bit 3 Unimplemented: Read as `0' bit 2 GO/DONE_ALL(3): Synchronized ADC Conversion Status bit 1 = Synchronized ADC conversion in progress. Setting this bit starts conversion in any ADC with ADxON = 1. 0 = Synchronized ADC conversion completed/ not in progress. bit 1-0 ADPREF<1:0>: ADC Positive Voltage Reference Configuration bits 00 = VREFH is connected to VDD 01 = Reserved 10 = VREFH is connected to external VREF+ pin(4) 11 = VREFH is connected to internal Fixed Voltage Reference. Note 1: 2: 3: 4: Bank 1 name is ADCON1. Bank 14 name is ADCOMCON. Setting this bit triggers the GO/DONEx bits in both ADCs. Each ADC will run a conversion according to its control register settings. This bit reads as an OR of the individual GO/DONEx bits. When selecting the VREF+ pin as the source of the positive reference, be aware that a minimum voltage specification exists. See Section 25.0 "Electrical Specifications" for details. 2014 Microchip Technology Inc. DS40001761A-page 135 PIC16LF1554/1559 REGISTER 15-4: U-0 ADxCON2: ADC CONTROL REGISTER 2 R/W-0/0 -- R/W-0/0 R/W-0/0 TRIGSELx<2: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 Unimplemented: Read as `0' bit 6-4 TRIGSELx<2:0>: Auto-Conversion Trigger Selection bits 000 = No Auto Conversion Trigger selected 001 = Reserved 010 = Reserved 011 = Timer0 Overflow(1) 100 = Timer1 Overflow(1) 101 = Timer2 Match to PR2(1) 110 = ADTRIG Rising Edge 111 = ADTRIG Falling Edge bit 3-0 Unimplemented: Read as `0' Note 1: Signal also sets its corresponding interrupt flag. REGISTER 15-5: R/W-x/u ADxRESxH: ADC RESULT REGISTER HIGH (ADxRESxH) 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 DS40001761A-page 136 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 15-6: R/W-x/u ADxRESxL: ADC RESULT REGISTER LOW (ADxRESxL) 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. REGISTER 15-7: ADxRESxH: ADC RESULT REGISTER HIGH (ADxRESxH) 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 15-8: R/W-x/u ADxRESxL: ADC RESULT REGISTER LOW (ADxRESxL) 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 2014 Microchip Technology Inc. DS40001761A-page 137 PIC16LF1554/1559 15.4 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 15-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 15-4. The maximum recommended impedance for analog sources is 10 k. EQUATION 15-1: As the 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 15-1 may be used. This equation assumes that 1/2 LSb error is used (1,024 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 Assumptions: Temperature = 50C and external impedance of 10 k 3.3V V DD T ACQ = Amplifier Settling Time + Hold Capacitor Charging Time + Temperature Coefficient = T AMP + T C + T COFF = 2 s + T C + Temperature - 25C 0.05 s/C The value for TC can be approximated with the following equations: 1 V APPLIED 1 - ------------------------------ = V CHOLD n+1 2 - 1 ;[1] VCHOLD charged to within 1/2 lsb -T C --------- RC = VCHOLD V APPLIED 1 - e ;[2] VCHOLD charge response to VAPPLIED -T C ---------- RC 1 V APPLIED 1 - e = V APPLIED 1 - ------------------------------ n+1 2 - 1 ;combining [1] and [2] 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) = - 15 pF 1k + 7k + 10k ln(0.0004885) = 2.06 s Therefore: T ACQ = 2s + 2.06s + 50C- 25C 0.05s/C = 5.31 s Note 1: The reference voltage (VRPOS) 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. 4: The calculation above assumed CHOLD = 15pF. This value can be larger than 15pF by setting the AADxCAP register. DS40001761A-page 138 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 15-4: ANALOG INPUT MODEL VDD RS VA Legend: Analog Input pin VT 0.6V CPIN 5 pF VT 0.6V RIC 1k ILEAKAGE(1) = Sample/Hold Capacitance CPIN = Input Capacitance ILEAKAGE = Leakage Current at the pin due to varies injunctions Note 1: 2: CHOLD = 15 pF(2) VREFL CHOLD RIC Sampling Switch SS RSS = Interconnect Resistance RSS = Resistance of Sampling switch SS = Sampling Switch VT = Threshold Voltage VDD 6V 5V 4V 3V 2V RSS 5 6 7 8 910 11 Sampling Switch (k) Refer to Section 25.0 "Electrical Specifications". Additional CHOLD could be added by setting the ADDxCAP register. FIGURE 15-5: ADC TRANSFER FUNCTION Full-Scale Range 3FFh 3FEh ADC Output Code 3FDh 3FCh 3FBh 03h 02h 01h 00h Analog Input Voltage 0.5 LSB VREFL 2014 Microchip Technology Inc. Zero-Scale Transition 1.5 LSB Full-Scale Transition VREFH DS40001761A-page 139 PIC16LF1554/1559 TABLE 15-3: Name SUMMARY OF REGISTERS ASSOCIATED WITH ADC Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 ADCON0/ AD1CON0 -- CHS14 CHS13 CHS12 CHS11 CHS10 GO/DONE1 AD1ON 133 AD2CON0 -- CHS24 CHS23 CHS22 CHS21 CHS20 GO/DONE2 AD2ON 134 ADPREF<1:0> 135 ADCON1/ ADCOMCON ADxCON2 ADFM ADCS<2:0> -- GO/DONE_ALL -- TRIGSELx<2:0> -- -- Bit 1 -- Bit 0 Register on Page Bit 7 -- 136 ADxRESxH ADC Result Register High 136, 137 ADxRESxL ADC Result Register Low 137, 137 ANSELA -- -- ANSA5 ANSA4 -- ANSA2 ANSA1 ANSA0 109 ANSELB ANSB7 ANSB6 ANSB5 ANSB4 -- -- -- -- 113 ANSELC ANSC7 ANSC6 ANSC5 ANSC4 ANSC3 ANSC2 ANSC1 ANSC0 117 INTCON GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 PIE1 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 78 PIR1 TMR1GIF AD1IF RCIF TXIF SSP1IF -- TMR2IF TMR1IF 80 TRISA2 TRISA1 TRISA0 108 -- -- -- 112 TRISC2 TRISC1 TRISC0 116 TRISA -- -- TRISA5 TRISA4 --(1) TRISB TRISB7 TRISB6 TRISB5 TRISB4 -- TRISC TRISC7 TRISC6 TRISC5 TRISC4 TRISC3 FVRCON FVREN FVRRDY TSEN TSRNG -- -- ADFVR<1:0> 124 Legend: x = unknown, u = unchanged, -- = unimplemented read as `0', q = value depends on condition. Shaded cells are not used for ADC module. Note 1: Unimplemented, read as `1'. DS40001761A-page 140 2014 Microchip Technology Inc. PIC16LF1554/1559 16.0 HARDWARE CAPACITIVE VOLTAGE DIVIDER (CVD) MODULE The hardware Capacitive Voltage Divider (CVD) module is a peripheral, which allows the user to perform a relative capacitance measurement on any ADC channel using the internal ADC sample and hold capacitance as a reference. This relative capacitance measurement can be used to implement capacitive touch or proximity sensing applications. Note: For more information on capacitive voltage divider sensing method refer to the Application Note AN1478, "mTouch(R) Sensing Solution Acquisition Methods Capacitive Voltage Divider" (DS01478). The CVD operation begins with the ADC's internal sample and hold capacitor (CHOLD) being disconnected from the path which connects it to the external capacitive sensor node. While disconnected, CHOLD is pre-charged to VDD or VSS, while the path to the sensor node is also discharged to VDD or VSS. Typically, this node is discharged to the level opposite that of CHOLD. When the pre-charge phase is complete, the VDD/VSS bias paths for the two nodes are shut off and CHOLD and the path to the external sensor node are reconnected, at which time the acquisition phase of the CVD operation begins. During acquisition, a capacitive voltage divider is formed between the pre-charged CHOLD the and sensor nodes, which results in a final voltage level settling on CHOLD, which is determined by the capacitances and pre-charge levels of the two nodes involved. After acquisition, the ADC converts the voltage level held on CHOLD. This process is then usually repeated with the selected pre-charge levels for both the CHOLD and the inverted sensor nodes. Figure 16-1 shows the waveform for two inverted CVD measurements, which is also known is differential CVD measurement. In a typical application, an Analog-to-Digital Converter (ADC) channel is attached to a pad on a Printed Circuit Board (PCB), which is electrically isolated from the end user. A capacitive change is detected on the ADC channel using the CVD conversion method when the end user places a finger over the PCB pad, the developer then can implement software to detect a touch or proximity event. Key features of this module include: * * * * * * * * Automated double sample conversions Two sets of result registers Inversion of second sample 7-bit pre-charge timer 7-bit acquisition timer Two guard ring output drives Adjustable sample and hold capacitor array Simultaneous CVD sampling on two ADCs 2014 Microchip Technology Inc. DS40001761A-page 141 PIC16LF1554/1559 FIGURE 16-1: DIFFERENTIAL CVD MEASUREMENT WAVEFORM Precharge Acquisition Conversion Precharge Acquisition Conversion External Capacitive Sensor ADC Sample and Hold Capacitor Voltage VDD VSS First Sample Second Sample Time FIGURE 16-2: HARDWARE CAPACITIVE VOLTAGE DIVIDER BLOCK DIAGRAM (3) XOR ADxEPPOL AND ADxDSEN ADxIPEN ADxCONV VDD (3) ANx XOR ADxIPPOL VDD (2) ADC ADxCH CHOLD ANxx CHxx ADxCAP<3:0> Secondary Channels(1) Note 1: Output drivers are disabled on any enabled secondary channel. 2: Disconnected for pre-charge and conversion stages. 3: Only enabled during pre-charge stage. DS40001761A-page 142 2014 Microchip Technology Inc. PIC16LF1554/1559 16.1 Hardware CVD Operation Capacitive Voltage Divider is a charge averaging capacitive sensing method. The hardware CVD module will automate the process of charging, averaging between the external sensor and the internal ADC sample and hold capacitor, and then initiating the ADC conversions. The whole process can be expanded into three stages: pre-charge, acquisition, and conversion. See Figure 16-5 for basic information on the timing of three stages. 16.1.1 PRE-CHARGE TIMER The pre-charge stage is an optional 1-127 instruction/TAD cycle time delay used to put the external ADC channel and the internal sample and hold capacitor (CHOLD) into pre-conditioned states. The pre-charge stage of conversion is enabled by writing a non-zero value to the ADxPRE<6:0> bits of the AADxPRE register. This stage is initiated when a conversion sequence is started by either the GO/DONEx, GO/DONE_ALL bit or a Special Event Trigger. When initiating an ADC conversion, if the ADxPRE bits are cleared, this stage is skipped. During the pre-charge time, CHOLD is disconnected from the outer portion of the sample path that leads to the external capacitive sensor and is connected to either VDD or VSS, depending on the value of the ADxEPPOL bit of the AADxCON3 register. At the same time, the port pin logic of the selected analog channel is overridden to drive a digital high or low out, in order to pre-charge the outer portion of the ADC's sample path, which includes the external sensor. The output polarity of this override is determined by the ADxEPPOL bit of the AADxCON3 register. Even though the analog channel of the pin is selected, the analog multiplexer is forced open during the precharge stage. The ADC multiplex or logic is overridden and disabled only during the pre-charge time. 16.1.2 ACQUISITION TIMER The acquisition timer controls the time allowed to acquire the signal to be sampled. The acquisition delay time is from 1 to 127 instruction/TAD cycles and is used to allow the voltage on the internal sample and hold capacitor (CHOLD) to settle to a final value through charge averaging. The acquisition time of conversion is enabled by writing a non-zero value to the AADxACQ<6:0> bits of the AADxACQ register. When the acquisition time is enabled, the time starts immediately following the pre-charge stage. If the ADxPRE<6:0> bits of the AADxPRE register are set to zero, the acquisition time is initiated by either setting the GO/DONEx, GO/DONE_ALL bit or a Special Event Trigger. At the start of the acquisition stage, the port pin logic of the selected analog channel is again overridden to turn off the digital high/low output drivers so that they do not affect the final result of charge averaging. Also, the selected ADC channel is connected to CHOLD. This allows charge averaging to proceed between the precharged channel and the CHOLD capacitor. 16.1.3 STARTING A CONVERSION To enable the ADC module, the ADxCON bit of the AADxCON0 register must be set. Setting the GO/DONEx, GO/DONE_ALL or by the Special Event Trigger inputs will start the Analog-to-Digital conversion. Once a conversion begins, it proceeds until complete, while the ADxON bit is set. If the ADxON bit is cleared, the conversion is halted. The GO/DONEx bit of the AADxCON0 register indicates that a conversion is occurring, regardless of the starting trigger. Note: 16.1.4 The GO/DONEx bit should not be set in the same instruction that turns on the ADC. Refer to Section Section 16.1.10 "Hardware CVD Double Conversion Procedure" COMPLETION OF A CONVERSION When the conversion is complete, the ADC module will: * Clear the GO/DONEx bit of the AADxCON0 register or clear the GO/DONE_ALL bit of the AADCON1 register if synchronized conversion is used. * Set the ADxIF interrupt flag bit of the PIRx register. * Update the AADxRESxH and AADxRESxL registers with new conversion results. 2014 Microchip Technology Inc. DS40001761A-page 143 PIC16LF1554/1559 16.1.5 TERMINATING A CONVERSION If a conversion must be terminated before completion, clear the GO/DONEx bit. The AADxRESxH and AADxRESxL registers will be updated with the partially complete Analog-to-Digital conversion sample. Incomplete bits will match the last bit converted. The AADSTAT register can be used to track the status of the hardware CVD module during a conversion. Note: 16.1.6 A device Reset forces all registers to their Reset state. Thus, the ADC module is turned off and any pending conversion is terminated. DOUBLE SAMPLE CONVERSION Double sampling can be enabled by setting the AADxSEN bit of the AADxCON3 register. When this bit is set, two conversions are completed each time the GO/DONEx, GO/DONE_ALL bit is set or a Special Event Trigger occurs. The GO/DONEx or GO/DONE_ALL bits remain set for the duration of both conversions and is used to signal the end of the conversion. Without setting the ADxIPEN bit, the double conversion will have identical charge/discharge on the internal and external capacitor for these two conversions. Setting the ADxIPEN bit prior to a double conversion will allow the user to perform a pseudo-differential CVD measurement by subtracting the results from the double conversion. This is highly recommended for noise immunity purposes. The result of the first conversion is written to the AADxRES0H and AADxRES0L registers. The second conversion starts two clock cycles after the first has completed, while the GO/DONEx and GO/DONE_ALL bits remain set. When the ADxIPEN bit of AADxCON3 is set, the value used by the ADC for the ADxEPPOL, ADxIPPOL and GRDxPOL bits are inverted. The value stored in those bit locations is unchanged. All other control signals remain unchanged from the first conversion. The result of the second conversion is stored in the AADxRES1H and AADxRES1L registers. See Figure 16-4 and Figure 16-5 for more information. 16.1.7 GUARD RING OUTPUTS The guard ring outputs consist of a pair of digital outputs from the hardware CVD module. Each ADC has its own pair of guard ring outputs. This function is enabled by the GRDxAOE and GRDxBOE bits of the AADxGRD register. Polarity of the output is controlled by the GRDxPOL bit. Once enabled and while ADxON = 1, the guard ring outputs of the ADC are active at all times. The outputs are initialized at the start of the pre-charge stage to match the polarity of the GRDxPOL bit. The guard output signal changes polarity at the start of the acquisition phase. The value stored by the GRDPOL bit does not change. When in Double Sampling mode, the ring output levels are inverted during the second precharge and acquisition phases if ADDxSEN = 1 and ADxIPEN = 1. For more information on the timing of the guard ring output, refer to Figure 16-4 and Figure 16-5. A typical guard ring circuit is displayed in Figure 16-2. CGUARD represents the capacitance of the guard ring trace placed on a PCB board. The user selects values for RA and RB that will create a voltage profile on CGUARD, which will match the selected channel during acquisition. The purpose of the guard ring is to generate a signal in phase with the CVD sensing signal to minimize the effects of the parasitic capacitance on sensing electrodes. It also can be used as a mutual drive for mutual capacitive sensing. For more information about active guard and mutual drive, see Application Note AN1478, "mTouch(R) Sensing Solution Acquisition Methods Capacitive Voltage Divider" (DS01478). FIGURE 16-3: GUARD RING CIRCUIT ADxGRDA RA RB CGUARD ADxGRDB DS40001761A-page 144 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 16-4: DIFFERENTIAL CVD WITH GUARD RING OUTPUT WAVEFORM Voltage Guard Ring Output External Capacitive Sensor VDD VSS First Sample Second Sample Time 16.1.8 ADDITIONAL SAMPLE AND HOLD CAPACITOR Additional capacitance can be added in parallel with the sample and hold capacitor (CHOLD) by setting the ADDxCAP<3:0> bits of the AADxCAP register. This bit connects a digitally programmable capacitance to the ADC conversion bus, increasing the effective internal capacitance of the sample and hold capacitor in the ADC module. Each ADC has its own additional capacitance array. This is used to improve the match between internal and external capacitance for a better sensing performance. The additional capacitance does not affect analog performance of the ADC because it is not connected during conversion. See Figure 16-1. 16.1.9 SECONDARY CHANNEL Each ADC has one primary channel selected by CHx<4:0> bits of the AADxCON0 register. Multiple secondary channels can be connected to the ADC conversion bus by setting the bits in the AADxCH register. This allows a combined CVD scan on multiple ADC channels, which is beneficial for low-power and proximity capacitive sensing. Each secondary channel is forced to input. The ANSELx bit for secondary channel is still under user control. During the pre-charge stage, the output drivers on each secondary channel will be overridden by the hardware CVD module and do exactly what the output drivers on the ADC's primary channel are configured to do. Both the primary and secondary channels are connected to the ADC as soon as the channels are selected by the CHx<4:0> bits of the AADxCON0 register and the bits in the AADxCH register. FIGURE 16-5: Pre-Charge Time 1-127 TINST/TAD (TPRE) HARDWARE CVD SEQUENCE TIMING DIAGRAM Acquisition/ Sharing Time 1-127 TINST/TAD (TACQ) External and Internal External and Internal Channels share Channels are charged/discharged charge If ADxPRE 0 If ADxACQ 0 Set GO/DONEx bit 2014 Microchip Technology Inc. Conversion Time (Traditional Timing of ADC Conversion) TCY - TAD TAD1 TAD2 TAD3 TAD4 TAD5 TAD6 TAD7 TAD8 TAD9 TAD10 TAD11 b4 b1 b0 b6 b7 b2 b8 b3 b9 b5 Conversion starts Holding capacitor CHOLD is disconnected from analog input (typically 100 ns) If ADxPRE = 0 If ADxACQ = 0 (Traditional Operation Start) On the following cycle: AADxRES0H:AADxRES0L is loaded, ADxIF bit is set, GO/DONEx bit is cleared DS40001761A-page 145 DOUBLE SAMPLE CONVERSION SEQUENCE (ADDSEN = 1 AND ADIPEN = 0) Pre-charge Acquisition AADXPRE<6:0> AADXACQ<6:0> PIC16LF1554/1559 DS40001761A-page 146 FIGURE 16-6: Pre-charge Acquisition AADXPRE<6:0> AADXACQ<6:0> Conversion Clock TAD 1-127 TINST 1-127 TINST (1) (1) 2INST1-127 TINST 1-127 TINST (1) (1) (2) AADxRESxL/H<9:0> 10'h000 (3) 10'h000 10th 9th 8th 7th 6th 5th 4th 3rd 2nd 1st TPRE TACQ TCONV 3'b001 3'b010 3'b011 First result written to AADxRES0L/H TPRE 10th 9th 8th 7th 6th 5th 4th 3rd 2nd 1st TACQ TCONV 3'b110 3'b111 Second result written to AADxRES1L/H ADxGRDA (GRDxPOL = 0) ADxGRDB Internal CHOLD Charging (ADxIPPOL = 1) External Channel Charging (ADxEPPOL = 0) External Channel Connected To Internal CHOLD 2014 Microchip Technology Inc. GO/DONEx ADxIF ADxSTAT<2:0> 3'b101 Note 1: When the conversion clock is ADCRC, the pre-charge and acquisition timers are clocked by ADCRC. 2: The AADxRES0L/H registers are set to zero during this period. 3: The AADxRES1L/H registers are set to zero during this period. 3'b000 2014 Microchip Technology Inc. FIGURE 16-7: DOUBLE SAMPLE CONVERSION SEQUENCE (ADDSEN = 1 AND ADIPEN = 1) Pre-charge Acquisition AADXPRE<6:0> AADXACQ<6:0> Pre-charge Acquisition AADXPRE<6:0> AADXACQ<6:0> Conversion Clock TAD 1-127 TINST 1-127 TINST (1) (1) 2INST1-127 TINST 1-127 TINST (1) (1) (2) AADxRESxL/H<9:0> 10'h000 (3) 10'h000 10th 9th 8th 7th 6th 5th 4th 3rd 2nd 1st TPRE TACQ TCONV 3'b001 3'b010 3'b011 First result written to AADxRES0L/H TPRE 10th 9th 8th 7th 6th 5th 4th 3rd 2nd 1st TACQ TCONV 3'b110 3'b111 Second result written to AADxRES1L/H ADxGRDA (GRDxPOL = 0) ADxGRDB Internal CHOLD Charging (ADxIPPOL = 1) External Channel Connected To Internal CHOLD GO/DONEx ADxIF DS40001761A-page 147 ADxSTAT<2:0> 3'b101 Note 1: When the conversion clock is ADCRC, the pre-charge and acquisition timers are clocked by ADCRC. 2: The AADxRES0L/H registers are set to zero during this period. 3: The AADxRES1L/H registers are set to zero during this period. 3'b000 PIC16LF1554/1559 External Channel Charging (ADxEPPOL = 0) PIC16LF1554/1559 16.1.10 HARDWARE CVD DOUBLE CONVERSION PROCEDURE This is an example procedure for using hardware CVD to perform a double conversion for differential CVD measurement with active guard drive. 1. 2. 3. 4. 5. 6. 7. 8. Configure Port: * Enable pin output driver (Refer to the TRISx register). * Configure pin output low (Refer to the LATx register). * Disable weak pull-up (Refer to the WPUx register). Configure the ADC module: * Select an appropriate ADC conversion clock for your oscillator frequency. * Configure voltage reference. * Select ADC input channel. * Turn on the ADC module. Configure the hardware CVD module: * Configure charge polarity and double conversion. * Configure pre-charge and acquisition timer. * Configure guard ring (optional). * Select additional capacitance (optional). Configure ADC interrupt (optional): * Clear ADC interrupt flag * Enable ADC interrupt * Enable peripheral interrupt * Enable global interrupt(1) Start conversion by setting the GO/DONEx, GO/DONE_ALL bit or by enabling the Special Event Trigger in the ADDxCON2 register. Wait for the ADC conversion to complete by one of the following: * Polling the GO/DONEx or GO/DONE_ALL bit. * Waiting for the ADC interrupt (interrupts enabled). Read ADC result: * Conversion 1 result in ADDxRES0H and ADDxRES0L * Conversion 2 result in ADDxRES1H and ADDxRES1L Clear the ADC interrupt flag (required if interrupt is enabled). Note 1: The global interrupt can be disabled if the user is attempting to wake-up from Sleep and resume in-line code execution. DS40001761A-page 148 EXAMPLE 16-1: HARDWARE CVD DOUBLE CONVERSION ;This code block configures the ADC ;for polling, VDD and VSS references, Fosc/16 ;clock and AN0 input. ; ;The Hardware CVD1 will perform an inverted ;double conversion, Guard A and B drive are ;both enabled. ;Conversion start & polling for completion are included. ; BANKSEL TRISA BCF TRISA,0 ;Set RA0 to output BANKSEL LATA BCF LATA,0 ;RA0 output low BANKSEL ANSELA BCF ANSELA,0 ;Set RA0 to digital BANKSEL WPUA BCF WPUA,0 ;Disable pull-up on RA0 ;Initialize ADC and Hardware CVD BANKSEL MOVLW MOVWF BANKSEL MOVLW MOVWF MOVLW MOVWF AAD1CON0 B'00000001' AAD1CON0 AADCON1 B'11010000' AADCON1 B'00000000' AAD1CH BANKSEL MOVLW MOVWF BANKSEL MOVLW MOVWF BANKSEL MOVLW MOVWF BANKSEL MOVLW MOVWF BANKSEL MOVLW MOVWF AAD1CON3 B'01000011' AAD1CON3 AAD1PRE .10 AAD1PRE AAD1ACQ .10 AAD1ACQ AAD1GRD B'11000000' AAD1GRD AAD1CAP B'00000000' AAD1CAP BANKSEL BSF BTFSC GOTO AD1CON0 AD1CON0, GO AD1CON0, GO $-1 ;Select channel AN0 ;VDD and VSS VREF ;No secondary channel ;Double and inverted ; ;Pre-charge Timer ;Acquisition Timer ;Guard on A and B ;No additional ;Capacitance ;No, test again ;RESULTS OF CONVERIONS 1. BANKSEL AAD1RES0H ; MOVF AAD1RES0H,W ;Read upper 2 MOVWF RESULT0H ;Store in GPR MOVF AAD1RES0L,W ;Read lower 8 MOVWF RESULT0L ;Store in GPR bits space bits space ;RESULTS OF CONVERIONS 2. BANKSEL AAD1RES1H ; MOVF AAD1RES1H,W ;Read upper 2 MOVWF RESULT1H ;Store in GPR MOVF AAD1RES1L,W ;Read lower 8 MOVWF RESULT1L ;Store in GPR bits space bits space 2014 Microchip Technology Inc. PIC16LF1554/1559 16.1.11 HARDWARE CVD REGISTER MAPPING The hardware CVD module is an enhanced expansion of the standard ADC module as stated in Section 15.0 "Analog-to-Digital Converter (ADC) Module" and is backward compatible with the other devices in this family. Control of the standard ADC1 module uses Bank 1 registers, see Table 16-1. This set of registers is mapped into Bank 14 with the control registers for the hardware CVD module. Although this subset of registers has different names, they are identical. Since the registers for the standard ADC are mapped into the Bank 14 address space, any changes to registers in Bank 1 will be reflected in Bank 14 and vice-versa. TABLE 16-1: HARDWARE CVD REGISTER MAPPING [Bank 14 Address] [Bank 1 Address] Hardware CVD ADC AAD1CON0(1) [09Dh] ADCON0(1) [712h] AAD1CON1(1) [09Eh] ADCON1(1) AAD1CON2(1) [09Fh] ADCON2(1) [711h] [713h] [714h] AAD1CON3 [715h] AAD1STAT [716h] AAD1PRE [717h] AAD1ACQ [718h] AAD1GRD [719h] AAD1CAP [71Ah] AAD1RES0L(1) [09Bh] AD1RES0L(1) AAD1RES0H(1) [09Ch] AD1RES0H(1) [71Bh] [71Ch] AAD1RES1L [71Dh] AAD1RES1H [71Eh] AAD1CH Note 1: Register is mapped in Bank 1 and Bank 14, using different names in each bank. The ADC2 only has one set of registers in Bank 15. However, letter `A', which stands for advanced, is added to the beginning of each register's name for legacy ADC control in this chapter. For example, AD2CON0 in Section 15.0 "Analog-to-Digital Converter (ADC) Module" uses the name of AAD2CON0 in this chapter. Please note that this is just an alias name, they still represent the same SFR register address in memory. 2014 Microchip Technology Inc. DS40001761A-page 149 PIC16LF1554/1559 16.2 Register Definitions: Hardware CVD Control AAD1CON0: HARDWARE CVD 1 CONTROL REGISTER 0(1,2) REGISTER 16-1: 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 R/W-0/0 -- CHS14 CHS13 CHS12 CHS11 CHS10 GO/DONE1(4) AD1ON 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-2 CHS1<4:0>: Analog Channel Select bits for ADC1 When AD1ON = 0, all multiplexer inputs are disconnected. 00000 = Channel 0, (AN0) 00001 = Channel 1, (AN1) 00010 = Channel 2, (AN2) 00011 = Reserved 00100 = Reserved 00101 = Reserved 00110 = Reserved 00111 = Reserved 01000 = Reserved 01001 = Reserved 01010 = Channel 10, (AN10) 01011 = Channel 11, (AN11) 01100 = Channel 12, (AN12) 01101 = Channel 13, (AN13) 01110 = Channel 14, (AN14)(3) 01111 = Channel 15, (AN15)(3) 10000 = Channel 16, (AN16)(3) 10001 = Reserved 10010 = Reserved 10011 = Reserved 10100 = Reserved 10101 = Reserved 10110 = Reserved 10111 = Reserved 11000 = Reserved 11001 = Reserved 11010 = Reserved 11011 = VREFH (ADC Positive Reference) 11100 = Reserved 11101 = Temperature Indicator 11110 = Reserved 11111 = Fixed Voltage Reference (FVREF) Buffer 1 Output bit 1 GO/DONE1: ADC1 Conversion Status bit (4) If AD1ON = 1 1 = ADC conversion in progress. Setting this bit starts the ADC conversion. When the RC clock source is selected, the ADC Module waits one instruction before starting the conversion. 0 = ADC conversion not in progress (This bit is automatically cleared by hardware when the ADC conversion is complete.) If this bit is cleared while a conversion is in progress, the conversion will stop and the results of the conversion up to this point will be transferred to the result registers, but the AD1IF interrupt flag bit will not be set. If AD1ON = 0 0 = ADC conversion not in progress bit 0 AD1ON: ADC Module 1 Enable bit 1 = ADC1 is enabled 0 = ADC1 is disabled and consumes no operating current. All analog channels are disconnected. Note 1: 2: 3: 4: Bank 1 name is ADCON0. Bank 14 name is AAD1CON0. PIC16LF1559 only. Not implemented on PIC16LF1554. When the AD1DSEN bit is set; the GO/DONE1 bit will clear after a second conversion has completed. DS40001761A-page 150 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 16-2: AAD2CON0: HARDWARE CVD 2 CONTROL REGISTER 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 R/W-0/0 -- CHS24 CHS23 CHS22 CHS21 CHS20 GO/DONE2(2) AD2ON 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-2 CHS2<4:0>: Analog Channel Select bits for ADC2 When AD2ON = 0, all multiplexer inputs are disconnected. 00000 = Channel 0, (AN0) 00001 = Channel 1, (AN1) 00010 = Channel 2, (AN2) 00011 = Reserved 00100 = Reserved 00101 = Reserved 00110 = Reserved 00111 = Reserved 01000 = Reserved 01001 = Reserved 01010 = Reserved 01011 = Reserved 01100 = Reserved 01101 = Reserved 01110 = Reserved 01111 = Reserved 10000 = Reserved 10001 = Reserved 10010 = Reserved 10011 = Reserved 10100 = Channel 20, (AN20) 10101 = Channel 21, (AN21) 10110 = Channel 22, (AN22) 10111 = Channel 23, (AN23) 11000 = Channel 24, (AN24)(1) 11001 = Channel 25, (AN25)(1) 11010 = Channel 26, (AN26)(1) 11011 = VREFH (ADC Positive Reference) 11100 = Reserved 11101 = Temperature Indicator 11110 = Reserved 11111 = Fixed Voltage Reference (FVREF) Buffer 1 Output bit 1 GO/DONE2: ADC2 Conversion Status bit (2) If AD2ON = 1 1 = ADC conversion in progress. Setting this bit starts the ADC conversion. When the RC clock source is selected, the ADC Module waits one instruction before starting the conversion. 0 = ADC conversion not in progress (This bit is automatically cleared by hardware when the ADC conversion is complete.) If this bit is cleared while a conversion is in progress, the conversion will stop and the results of the conversion up to this point will be transferred to the result registers, but the AD2IF interrupt flag bit will not be set. If AD2ON = 0 0 = ADC conversion not in progress bit 0 AD2ON: ADC Module 2 Enable bit 1 = ADC2 is enabled 0 = ADC2 is disabled and consumes no operating current. All analog channels are disconnected. Note 1: PIC16LF1559 only. Not implemented on PIC16LF1554. 2: When the AD2DSEN bit is set; the GO/DONE2 bit will clear after a second conversion has completed. 2014 Microchip Technology Inc. DS40001761A-page 151 PIC16LF1554/1559 REGISTER 16-3: AAD1CH: HARDWARE CVD 1 SECONDARY CHANNEL SELECT REGISTER(1,2,3,4) 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 R/W-0/0 -- CH16 CH15 CH14 CH13 CH12 CH11 CH10 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 CH16: Channel 16 to ADC1 Connection bit(5) 1 = AN16 is connected to ADC1 0 = AN16 is not connected to ADC1 bit 5 CH15: Channel 15 to ADC1 Connection bit(5) 1 = AN15 is connected to ADC1 0 = AN15 is not connected to ADC1 bit 4 CH14: Channel 14 to ADC1 Connection bit(5) 1 = AN14 is connected to ADC1 0 = AN14 is not connected to ADC1 bit 3 CH13: Channel 13 to ADC1 Connection bit 1 = AN13 is connected to ADC1 0 = AN13 is not connected to ADC1 bit 2 CH12: Channel 12 to ADC1 Connection bit 1 = AN12 is connected to ADC1 0 = AN12 is not connected to ADC1 bit 1 CH11: Channel 11 to ADC1 Connection bit 1 = AN11 is connected to ADC1 0 = AN11 is not connected to ADC1 bit 0 CH10: Channel 10 to ADC1 Connection bit 1 = AN10 is connected to ADC1 0 = AN10 is not connected to ADC1 Note 1: This register selects secondary channels which are connected in parallel to the primary channel selected in AAD1CON0. Pre-charge bias is applied to both the primary and secondary channels. 2: If the same channel is selected as both primary and secondary then the selection as primary takes precedence. 3: Enabling these bits automatically overrides the corresponding TRIS bit to tri-state the selected pin. 4: In the same way that the CHSx bits in AAD1CON0 only close the switch when the ADC is enabled, these connections and the TRISx overrides are only active if the ADC is enabled by setting ADxON. 5: PIC16LF1559 only. Unimplemented/Read as `0' on PIC16LF1554. DS40001761A-page 152 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 16-4: AAD2CH: HARDWARE CVD 2 SECONDARY CHANNEL SELECT REGISTER(1,2,3,4) 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 R/W-0/0 -- CH26 CH25 CH24 CH23 CH22 CH21 CH20 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 CH26: Channel 26 to ADC2 Connection bit(5) 1 = AN26 is connected to ADC2 0 = AN26 is not connected to ADC2 bit 5 CH25: Channel 25 to ADC2 Connection bit(5) 1 = AN25 is connected to ADC2 0 = AN25 is not connected to ADC2 bit 4 CH24: Channel 24 to ADC2 Connection bit(5) 1 = AN24 is connected to ADC2 0 = AN24 is not connected to ADC2 bit 3 CH23: Channel 23 to ADC2 Connection bit 1 = AN23 is connected to ADC2 0 = AN23 is not connected to ADC2 bit 2 CH22: Channel 22 to ADC2 Connection bit 1 = AN22 is connected to ADC2 0 = AN22 is not connected to ADC2 bit 1 CH21: Channel 21 to ADC2 Connection bit 1 = AN21 is connected to ADC2 0 = AN21 is not connected to ADC2 bit 0 CH20: Channel 20 to ADC2 Connection bit 1 = AN20 is connected to ADC2 0 = AN20 is not connected to ADC2 Note 1: This register selects secondary channels which are connected in parallel to the primary channel selected in AAD2CON0. Pre-charge bias is applied to both the primary and secondary channels. 2: If the same channel is selected as both primary and secondary then the selection as primary takes precedence. 3: Enabling these bits automatically overrides the corresponding TRIS bit to tri-state the selected pin. 4: In the same way that the CHSx bits in AAD2CON0 only close the switch when the ADC is enabled, these connections and the TRISx overrides are only active if the ADC is enabled by setting ADxON. 5: PIC16LF1559 only. Unimplemented/Read as `0' on PIC16LF1554. 2014 Microchip Technology Inc. DS40001761A-page 153 PIC16LF1554/1559 REGISTER 16-5: R/W-0/0 AADCON1(1)/ADCOMCON(2): HARDWARE CVD CONTROL REGISTER 1(1,2) R/W-0/0 ADFM R/W-0/0 R/W-0/0 ADCS<2:0> U-0 U-0 -- GO/DONE_ALL 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 AADxRESxH are set to `0' when the conversion result is loaded. 0 = Left justified. Six Least Significant bits of AADxRESxL are set to `0' when the conversion result is loaded. bit 6-4 ADCS<2:0>: ADC Conversion Clock Select bits 111 = FRC (clock supplied from a dedicated RC oscillator) 110 = FOSC/64 101 = FOSC/16 100 = FOSC/4 011 = FRC (clock supplied from a dedicated RC oscillator) 010 = FOSC/32 001 = FOSC/8 000 = FOSC/2 bit 3 Unimplemented: Read as `0' bit 2 GO/DONE_ALL(3): Synchronized ADC Conversion Status bit 1 = Synchronized ADC conversion in progress. Setting this bit starts conversion in any ADC with ADxON = 1. 0 = Synchronized ADC conversion completed/ not in progress. bit 1-0 ADPREF<1:0>: ADC Positive Voltage Reference Configuration bits 00 = VREFH is connected to VDD 01 = Reserved 10 = VREFH is connected to external VREF+ pin(4) 11 = VREFH is connected to internal Fixed Voltage Reference Note 1: 2: 3: 4: Bank 1 name is ADCON1. Bank 14 name is AADCON1/ADCOMCON. Setting this bit triggers the GO/DONEx bits in both ADCs. Each ADC will run a conversion according to its control register settings. This bit reads as an OR of the individual GO/DONEx bits. When selecting the VREF+ pin as the source of the positive reference, be aware that a minimum voltage specification exists. See Section 25.0 "Electrical Specifications" for details. DS40001761A-page 154 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 16-6: U-0 AADxCON2: HARDWARE CVD CONTROL REGISTER 2(1) R/W-0/0 R/W-0/0 R/W-0/0 TRIGSELx<2:0>(1) -- 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 Unimplemented: Read as `0' bit 6-4 TRIGSELx<2:0>: Auto-Conversion Trigger Selection bits 000 = No Auto Conversion Trigger selected 001 = Reserved 010 = Reserved 011 = Timer0 Overflow(2) 100 = Timer1 Overflow(2) 101 = Timer2 Match to PR2(2) 110 = ADTRIG Rising Edge 111 = ADTRIG Falling Edge bit 3-0 Unimplemented: Read as `0' Note 1: 2: See Section 16.1.11 "Hardware CVD Register Mapping" for more information. Signal used to set the corresponding interrupt flag. 2014 Microchip Technology Inc. DS40001761A-page 155 PIC16LF1554/1559 REGISTER 16-7: AADxCON3: HARDWARE CVD CONTROL REGISTER 3 R/W-0/0 R/W-0/0 U-0 U-0 U-0 U-0 R/W-0/0 R/W-0/0 ADxEPPOL ADxIPPOL -- -- -- -- ADxIPEN ADxDSEN 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 ADxEPPOL: External Pre-charge Polarity bit(1) 1 = Selected channel is connected to VDDIO during pre-charge time 0 = Selected channel is connected to VSS during pre-charge time bit 6 ADxIPPOL: Internal Pre-charge Polarity bit(1) 1 = CHOLD is shorted to VREFH during pre-charge time 0 = CHOLD is shorted to VREFL during pre-charge time bit 5-2 Unimplemented: Read as `0' bit 1 ADxIPEN: ADC Invert Polarity Enable bit If ADxDSEN = 1: 1 = The output value of the ADxEPPOL, ADxIPPOL, and GRDxPOL bits used by the ADC are inverted for the second conversion 0 = The second ADC conversion proceeds like the first If ADxDSEN = 0: This bit has no effect. bit 0 ADxDSEN: ADC Double Sample Enable bit 1 = The ADC immediately starts a new conversion after completing a conversion. GO/DONEx bit is not automatically clear at end of conversion. 0 = ADC operates in the traditional, single conversion mode Note 1: When the ADxDSEN = 1 and ADxIPEN = 1; the polarity of this output is inverted for the second conversion time. The stored bit value does not change. DS40001761A-page 156 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 16-8: AADSTAT: HARDWARE CVD STATUS REGISTER U-0 R/W-0/0 -- AD2CONV R/W-0/0 R/W-0/0 AD2STG<1:0> U-0 R/W-0/0 -- AD1CONV R/W-0/0 bit 7 R/W-0/0 AD1STG<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 Unimplemented: Read as `0' bit 6 AD2CONV: ADC2 Conversion Status bit 1 = Indicates ADC2 is in Conversion Sequence for AAD2RES1H:AAD2RES1L 0 = Indicates ADC2 is in Conversion Sequence for AAD2RES0H:AAD2RES0L (Also reads `0' when GO/DONE2 = 0) bit 5-4 AD2STG<1:0>: ADC2 Stage Status bit 11 = ADC2 module is in conversion stage 10 = ADC2 module is in acquisition stage 01 = ADC2 module is in pre-charge stage 00 = ADC2 module is not converting (same as GO/DONE2= 0) bit 3 Unimplemented: Read as `0' bit 2 AD1CONV: ADC2 Conversion Status bit 1 = Indicates ADC1 is in Conversion Sequence for AAD1RES1H:AAD1RES1L 0 = Indicates ADC1 is in Conversion Sequence for AAD1RES0H:AAD1RES0L (Also reads `0' when GO/DONE1 = 0) bit 1-0 AD1STG<1:0>: ADC1 Stage Status bit 11 = ADC1 module is in conversion stage 10 = ADC1 module is in acquisition stage 01 = ADC1 module is in pre-charge stage 00 = ADC1 module is not converting (same as GO/DONE1= 0) 2014 Microchip Technology Inc. DS40001761A-page 157 PIC16LF1554/1559 REGISTER 16-9: U-0 AADxPRE: HARDWARE CVD PRE-CHARGE CONTROL 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 ADxPRE<6: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-0 ADxPRE<6:0>: Pre-charge Time Select bits(1) 111 1111 = Pre-charge for 127 instruction cycles 111 1110 = Pre-charge for 126 instruction cycles * * * 000 0001 = Pre-charge for 1 instruction cycle (Fosc/4) 000 0000 = ADC pre-charge time is disabled Note 1: When the FRC clock is selected as the conversion clock source, it is also the clock used for the pre-charge and acquisition times. REGISTER 16-10: AADxACQ: HARDWARE CVD ACQUISITION TIME CONTROL 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 R/W-0/0 AADxACQ<6: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-0 AADxACQ<6:0>: Acquisition/Charge Share Time Select bits(1) 111 1111 = Acquisition/charge share for 127 instruction cycles 111 1110 = Acquisition/charge share for 126 instruction cycles * * * 000 0001 = Acquisition/charge share for one instruction cycle (Fosc/4) 000 0000 = ADC Acquisition/charge share time is disabled Note 1: When the FRC clock is selected as the conversion clock source, it is also the clock used for the pre-charge and acquisition times. DS40001761A-page 158 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 16-11: AADxGRD: HARDWARE CVD GUARD RING CONTROL REGISTER R/W-0/0 R/W-0/0 R/W-0/0 U-0 U-0 U-0 U-0 U-0 GRDxBOE(2) GRDxAOE(2) GRDxPOL(1,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 GRDxBOE: Guard Ring B Output Enable bit(2) 1 = ADC guard ring output is enabled to ADxGRDB pin. Its corresponding TRISx bit must be clear. 0 = No ADC guard ring function to this pin is enabled bit 6 GRDxAOE: Guard Ring A Output Enable bit(2) 1 = ADC Guard Ring Output is enabled to ADxGRDA pin. Its corresponding TRISx, x bit must be clear. 0 = No ADC Guard Ring function is enabled bit 5 GRDxPOL: Guard Ring Polarity Selection bit(1,2) 1 = ADCx guard ring outputs start as digital high during pre-charge stage 0 = ADCx guard ring outputs start as digital low during pre-charge stage bit 4-0 Unimplemented: Read as `0' Note 1: 2: When the ADxDSEN = 1 and ADxIPEN = 1; the polarity of this output is inverted for the second conversion time. The stored bit value does not change. Guard Ring outputs are maintained while ADxCON = 1. The ADxGRDA output switches polarity at the start of the acquisition time. 2014 Microchip Technology Inc. DS40001761A-page 159 PIC16LF1554/1559 REGISTER 16-12: AADxCAP: HARDWARE CVD ADDITIONAL SAMPLE CAPACITOR 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 ADDxCAP<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 ADDxCAP<3:0>: ADC Additional Sample Capacitor Selection bits 1111 = Nominal Additional Sample Capacitor of 30pF 1110 = Nominal Additional Sample Capacitor of 28pF 1101 = Nominal Additional Sample Capacitor of 26pF 1100 = Nominal Additional Sample Capacitor of 24pF 1011 = Nominal Additional Sample Capacitor of 22pF 1010 = Nominal Additional Sample Capacitor of 20pF 1001 = Nominal Additional Sample Capacitor of 18pF 1000 = Nominal Additional Sample Capacitor of 16pF 0111 = Nominal Additional Sample Capacitor of 14pF 0110 = Nominal Additional Sample Capacitor of 12pF 0101 = Nominal Additional Sample Capacitor of 10pF 0100 = Nominal Additional Sample Capacitor of 8pF 0011 = Nominal Additional Sample Capacitor of 6pF 0010 = Nominal Additional Sample Capacitor of 4pF 0001 = Nominal Additional Sample Capacitor of 2pF 0000 = Additional Sample Capacitor is Disabled DS40001761A-page 160 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 16-13: AADxRESxH: HARDWARE CVD RESULT REGISTER MSB ADFM = 0(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 ADRESx<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 ADRESx<9:2>: ADC Result Register bits Upper eight bits of 10-bit conversion result Note 1: See Section 16.1.11 "Hardware CVD Register Mapping" for more information. REGISTER 16-14: AADxRESxL: HARDWARE CVD RESULT REGISTER LSL ADFM = 0(1) R/W-x/u R/W-x/u ADRESx<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 ADRESx<1:0>: ADC Result Register bits Lower two bits of 10-bit conversion result bit 5-0 Reserved: Do not use. Note 1: See Section 16.1.11 "Hardware CVD Register Mapping" for more information. 2014 Microchip Technology Inc. DS40001761A-page 161 PIC16LF1554/1559 REGISTER 16-15: AADxRESxH: HARDWARE CVD RESULT REGISTER MSB ADFM = 1(1) U-0 U-0 U-0 U-0 U-0 U-0 -- -- -- -- -- -- R/W-x/u R/W-x/u ADRESx<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 ADRESx<9:8>: ADC Result Register bits Upper two bits of 10-bit conversion result Note 1: See Section 16.1.11 "Hardware CVD Register Mapping" for more information. REGISTER 16-16: AADxRESxL: HARDWARE CVD RESULT REGISTER LSB ADFM = 1(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 ADRESx<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: ADRESx<7:0>: ADC Result Register bits Lower eight bits of 10-bit conversion result See Section 16.1.11 "Hardware CVD Register Mapping" for more information. DS40001761A-page 162 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 16-2: Name SUMMARY OF REGISTERS ASSOCIATED WITH HARDWARE CVD Bit 6 Bit 5 Bit 4 AADxCAP -- -- -- -- AAD1CON0 -- CHS14 CHS13 CHS10 CHS11 CHS10 GO/DONE1 AD1ON 150 AAD2CON0 -- CHS24 CHS23 CHS20 CHS21 CHS20 GO/DONE2 AD2ON 151 AADCON1/ ADCOMCON ADFM ADCS<2:0> -- GO/DONE_ALL -- TRIGSELx<2:0> -- -- -- -- 155 -- -- ADxIPEN ADxDSEN 156 -- -- -- -- AADxCON2 AADxCON3 ADxEPPOL ADxIPPOL AADxGRD GRDxBOE AADxPRE -- -- GRDxAOE GRDxPOL -- -- Bit 3 Bit 2 Bit 1 Bit 0 Register on Page Bit 7 ADDxCAP<3:0> 160 ADPREF<1:0> 154 159 ADxPRE<6:0> 158 AADxRES0H ADC Result 0 Register High 161 AADxRES0L ADC Result 0 Register Low 161 AADxRES1H ADC Result 1 Register High 162 AADxRES1L ADC Result 1 Register Low 162 AADSTAT -- AADxACQ -- AD2CONV AD2STG<1:0> -- AD1CONV AD1STG<1:0> AADxACQ<6:0> 157 158 ANSELA -- -- ANSA5 ANSA4 -- ANSA2 ANSA1 ANSA0 109 ANSELB ANSB7 ANSB6 ANSB5 ANSB4 -- -- -- -- 113 ANSC1 ANSC0 ANSELC ANSC7 ANSC6 ANSC5 ANSC4 ANSC3 ANSC2 FVRCON FVREN FVRRDY TSEN TSRNG -- -- INTCON PIE1 ADFVR<1:0> 117 124 GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 78 PIE2 -- AD2IE -- -- BCLIE -- -- -- 79 PIR1 TMR1GIF AD1IF RCIF TXIF SSP1IF -- TMR2IF TMR1IF 80 PIR2 -- AD2IF -- -- BCLIF -- -- -- 81 TRISA -- -- TRISA5 TRISA4 --(1) TRISA2 TRISA1 TRISA0 108 TRISB TRISB7 TRISB6 TRISB5 TRISB4 -- -- -- -- 112 TRISC TRISC7 TRISC6 TRISC5 TRISC4 TRISC3 TRISC2 TRISC1 TRISC0 116 Legend: Note 1: -- = unimplemented read as `0'. Shaded cells are not used for hardware CVD module. Unimplemented, read as `1'. 2014 Microchip Technology Inc. DS40001761A-page 163 PIC16LF1554/1559 17.0 17.1.2 TIMER0 MODULE 8-BIT COUNTER MODE The Timer0 module is an 8-bit timer/counter with the following features: In 8-Bit Counter mode, the Timer0 module will increment on every rising or falling edge of the T0CKI pin. * * * * * * 8-Bit Counter mode using the T0CKI pin is selected by setting the TMR0CS bit in the OPTION_REG register to `1'. 8-bit timer/counter register (TMR0) 3-bit prescaler (independent of Watchdog Timer) Programmable internal or external clock source Programmable external clock edge selection Interrupt on overflow TMR0 can be used to gate Timer1 The rising or falling transition of the incrementing edge for either input source is determined by the TMR0SE bit in the OPTION_REG register. Figure 17-1 is a block diagram of the Timer0 module. 17.1 Timer0 Operation The Timer0 module can be used as either an 8-bit timer or an 8-bit counter. 17.1.1 8-BIT TIMER MODE The Timer0 module will increment every instruction cycle, if used without a prescaler. 8-bit Timer mode is selected by clearing the TMR0CS bit of the OPTION_REG register. When TMR0 is written, the increment is inhibited for two instruction cycles immediately following the write. Note: The value written to the TMR0 register can be adjusted, in order to account for the two instruction cycle delay when TMR0 is written. FIGURE 17-1: TIMER0 BLOCK DIAGRAM Rev. 10-000017A 8/5/2013 TMR0CS Fosc/4 T0CKI(1) PSA 0 1 TMR0SE 1 write to TMR0 Prescaler R 0 FOSC/2 T0CKI Sync Circuit PS<2:0> T0_overflow TMR0 Q1 set bit TMR0IF Note 1: The T0CKI prescale output frequency should not exceed FOSC/8. DS40001761A-page 164 2014 Microchip Technology Inc. PIC16LF1554/1559 17.1.3 SOFTWARE PROGRAMMABLE PRESCALER A software programmable prescaler is available for exclusive use with Timer0. The prescaler is enabled by clearing the PSA bit of the OPTION_REG register. Note: The Watchdog Timer (WDT) uses its own independent prescaler. There are eight prescaler options for the Timer0 module ranging from 1:2 to 1:256. The prescale values are selectable via the PS<2:0> bits of the OPTION_REG register. In order to have a 1:1 prescaler value for the Timer0 module, the prescaler must be disabled by setting the PSA bit of the OPTION_REG register. The prescaler is not readable or writable. All instructions writing to the TMR0 register will clear the prescaler. 17.1.4 TIMER0 INTERRUPT Timer0 will generate an interrupt when the TMR0 register overflows from FFh to 00h. The TMR0IF interrupt flag bit of the INTCON register is set every time the TMR0 register overflows, regardless of whether or not the Timer0 interrupt is enabled. The TMR0IF bit can only be cleared in software. The Timer0 interrupt enable is the TMR0IE bit of the INTCON register. Note: 17.1.5 The Timer0 interrupt cannot wake the processor from Sleep since the timer is frozen during Sleep. 8-BIT COUNTER MODE SYNCHRONIZATION When in 8-Bit Counter mode, the incrementing edge on the T0CKI pin must be synchronized to the instruction clock. Synchronization can be accomplished by sampling the prescaler output on the Q2 and Q4 cycles of the instruction clock. The high and low periods of the external clocking source must meet the timing requirements as shown in Section 25.0 "Electrical Specifications". 17.1.6 OPERATION DURING SLEEP Timer0 cannot operate while the processor is in Sleep mode. The contents of the TMR0 register will remain unchanged while the processor is in Sleep mode. 2014 Microchip Technology Inc. DS40001761A-page 165 PIC16LF1554/1559 17.2 Register Definitions: Option Register REGISTER 17-1: OPTION_REG: OPTION REGISTER R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 R/W-1/1 WPUEN INTEDG TMR0CS TMR0SE PSA R/W-1/1 R/W-1/1 R/W-1/1 PS<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 WPUEN: Weak Pull-Up Enable bit 1 = All weak pull-ups are disabled (except MCLR, if it is enabled) 0 = Weak pull-ups are enabled by individual WPUx latch values bit 6 INTEDG: Interrupt Edge Select bit 1 = Interrupt on rising edge of INT pin 0 = Interrupt on falling edge of INT pin bit 5 TMR0CS: Timer0 Clock Source Select bit 1 = Transition on T0CKI pin 0 = Internal instruction cycle clock (FOSC/4) bit 4 TMR0SE: Timer0 Source Edge Select bit 1 = Increment on high-to-low transition on T0CKI pin 0 = Increment on low-to-high transition on T0CKI pin bit 3 PSA: Prescaler Assignment bit 1 = Prescaler is not assigned to the Timer0 module 0 = Prescaler is assigned to the Timer0 module bit 2-0 PS<2:0>: Prescaler Rate Select bits Bit Value Timer0 Rate 1:2 1:4 1:8 1 : 16 1 : 32 1 : 64 1 : 128 1 : 256 000 001 010 011 100 101 110 111 TABLE 17-1: Name Bit 7 ADxCON2 OPTION_REG TRISA Legend: * Note 1: Bit 6 -- INTCON TMR0 SUMMARY OF REGISTERS ASSOCIATED WITH TIMER0 Bit 5 Bit 4 Bit 3 TRIGSELx<2:0> Bit 2 Bit 1 Bit 0 Register on Page -- -- -- -- 136 GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 WPUEN INTEDG TMR0CS TMR0SE PSA PS<2:0> 166 Holding Register for the 8-bit Timer0 Count -- -- TRISA5 TRISA4 164* --(1) TRISA2 TRISA1 TRISA0 108 -- = Unimplemented location, read as `0'. Shaded cells are not used by the Timer0 module. Page provides register information. Unimplemented, read as `1'. DS40001761A-page 166 2014 Microchip Technology Inc. PIC16LF1554/1559 18.0 * Interrupt on overflow * Wake-up on overflow (external clock, Asynchronous mode only) * ADC Auto-Conversion Trigger(s) * 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 a 16-bit timer/counter with the following features: * * * * * 16-bit timer/counter register pair (TMR1H:TMR1L) Programmable internal or external clock source 2-bit prescaler Optionally synchronized comparator out Multiple Timer1 gate (count enable) sources FIGURE 18-1: Figure 18-1 is a block diagram of the Timer1 module. TIMER1 BLOCK DIAGRAM T1GSS<1:0> Rev. 10-000018A 8/5/2013 T1G 00 T0_overflow 01 C1OUT_sync 10 C2OUT_sync 11 T1GSPM 0 1 D 1 Single Pulse Acq. Control D 0 T1GVAL Q Q1 Q T1GGO/DONE T1GPOL CK Q Interrupt TMR1ON R set bit TMR1GIF det T1GTM TMR1GE set flag bit TMR1IF TMR1ON EN T1_overflow TMR1(2) TMR1H TMR1L Q Synchronized Clock Input 0 D 1 T1CLK T1SYNC TMR1CS<1:0> OUT SOSCI/T1CKI SOSCO Secondary Oscillator 1 0 EN LFINTOSC 11 10 Fosc Internal Clock 01 00 Fosc/4 Internal Clock T1OSCEN Prescaler 1,2,4,8 Synchronize(3) det 2 T1CKPS<1:0> Fosc/2 Internal Clock Sleep Input (1) Secondary Clock To Clock Switching Module Note 1: ST Buffer is high speed type when using T1CKI. 2: Timer1 register increments on rising edge. 3: Synchronize does not operate while in Sleep. 2014 Microchip Technology Inc. DS40001761A-page 167 PIC16LF1554/1559 18.1 Timer1 Operation 18.2 The Timer1 module is a 16-bit incrementing counter which is accessed through the TMR1H:TMR1L register pair. 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. Timer1 is enabled by configuring the TMR1ON and TMR1GE bits in the T1CON and T1GCON registers, respectively. Table 18-1 displays the Timer1 enable selections. TABLE 18-1: Clock Source Selection The TMR1CS<1:0> bits of the T1CON register are used to select the clock source for Timer1. Table 18-2 displays the clock source selections. 18.2.1 INTERNAL CLOCK SOURCE When the internal clock source is selected, the TMR1H:TMR1L register pair will increment on multiples of FOSC as determined by the Timer1 prescaler. When the FOSC internal clock source is selected, the Timer1 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 Timer1 value. To utilize the full resolution of Timer1, an asynchronous input signal must be used to gate the Timer1 clock input. The following asynchronous sources may be used: TIMER1 ENABLE SELECTIONS Timer1 Operation * Asynchronous event on the T1G pin to Timer1 gate * C1 or C2 comparator input to Timer1 gate TMR1ON TMR1GE 0 0 Off 18.2.2 0 1 Off 1 0 Always On When the external clock source is selected, the Timer1 module may work as a timer or a counter. 1 1 Count Enabled EXTERNAL CLOCK SOURCE When enabled to count, Timer1 is incremented on the rising edge of the external clock input T1CKI. The external clock source can be synchronized to the microcontroller system clock or it can run asynchronously. 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: * * * * Timer1 enabled after POR Write to TMR1H or TMR1L Timer1 is disabled Timer1 is disabled (TMR1ON = 0) when T1CKI is high then Timer1 is enabled (TMR1ON=1) when T1CKI is low. TABLE 18-2: TMR1CS<1:0> DS40001761A-page 168 CLOCK SOURCE SELECTIONS Clock Source 11 LFINTOSC 10 External Clocking on T1CKI Pin 01 System Clock (FOSC) 00 Instruction Clock (FOSC/4) 2014 Microchip Technology Inc. PIC16LF1554/1559 18.3 Timer1 Prescaler Timer1 has four prescaler options allowing 1, 2, 4 or 8 divisions of the clock input. The T1CKPS 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. 18.5 Timer1 can be configured to count freely or the count can be enabled and disabled using Timer1 gate circuitry. This is also referred to as Timer1 Gate Enable. Timer1 gate can also be driven by multiple selectable sources. 18.5.1 18.4 Timer1 Operation in Asynchronous Counter Mode If control bit T1SYNC 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 18.4.1 "Reading and Writing Timer1 in Asynchronous Counter Mode"). Note: 18.4.1 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 Timer1 Gate TIMER1 GATE ENABLE The Timer1 Gate Enable mode is enabled by setting the TMR1GE bit of the T1GCON register. The polarity of the Timer1 Gate Enable mode is configured using the T1GPOL bit of the T1GCON register. When Timer1 Gate Enable mode is enabled, Timer1 will increment on the rising edge of the Timer1 clock source. When Timer1 Gate Enable mode is disabled, no incrementing will occur and Timer1 will hold the current count. See Figure 18-3 for timing details. TABLE 18-3: TIMER1 GATE ENABLE SELECTIONS T1CLK T1GPOL T1G 0 0 Counts 0 1 Holds Count 1 0 Holds Count 1 1 Counts 18.5.2 Timer1 Operation TIMER1 GATE SOURCE SELECTION 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. Timer1 gate source selections are shown in Table 18-4. Source selection is controlled by the T1GSS bit of the T1GCON register. The polarity for each available source is also selectable. Polarity selection is controlled by the T1GPOL bit of the T1GCON register. 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. TABLE 18-4: 2014 Microchip Technology Inc. T1GSS TIMER1 GATE SOURCES Timer1 Gate Source 0 Timer1 Gate pin (T1G) 1 Overflow of Timer0 (T0_overflow) (TMR0 increments from FFh to 00h) DS40001761A-page 169 PIC16LF1554/1559 18.5.2.1 T1G Pin Gate Operation The T1G pin is one source for Timer1 gate control. It can be used to supply an external source to the Timer1 gate circuitry. 18.5.2.2 Timer0 Overflow Gate Operation When Timer0 increments from FFh to 00h, a low-tohigh pulse will automatically be generated and internally supplied to the Timer1 gate circuitry. 18.5.3 TIMER1 GATE TOGGLE MODE When Timer1 Gate Toggle mode is enabled, it is possible to measure the full-cycle length of a Timer1 gate signal, as opposed to the duration of a single level pulse. The Timer1 gate source is routed through a flip-flop that changes state on every incrementing edge of the signal. See Figure 18-4 for timing details. 18.5.5 TIMER1 GATE VALUE STATUS 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 T1GVAL bit in the T1GCON register. The T1GVAL bit is valid even when the Timer1 gate is not enabled (TMR1GE bit is cleared). 18.5.6 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 T1GVAL occurs, the TMR1GIF flag bit in the PIR1 register will be set. If the TMR1GIE bit in the PIE1 register is set, then an interrupt will be recognized. The TMR1GIF flag bit operates even when the Timer1 gate is not enabled (TMR1GE bit is cleared). Timer1 Gate Toggle mode is enabled by setting the T1GTM bit of the T1GCON register. When the T1GTM bit is cleared, the flip-flop is cleared and held clear. This is necessary in order to control which edge is measured. Note: 18.5.4 Enabling Toggle mode at the same time as changing the gate polarity may result in indeterminate operation. 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 T1GSPM bit in the T1GCON register. Next, the T1GGO/ DONE bit in the T1GCON register must be set. The Timer1 will be fully enabled on the next incrementing edge. On the next trailing edge of the pulse, the T1GGO/ DONE bit will automatically be cleared. No other gate events will be allowed to increment Timer1 until the T1GGO/DONE bit is once again set in software. See Figure 18-5 for timing details. If the Single Pulse Gate mode is disabled by clearing the T1GSPM bit in the T1GCON register, the T1GGO/DONE bit should also be cleared. Enabling the Toggle mode and the Single-Pulse mode simultaneously will permit both sections to work together. This allows the cycle times on the Timer1 gate source to be measured. See Figure 18-6 for timing details. DS40001761A-page 170 2014 Microchip Technology Inc. PIC16LF1554/1559 18.6 Timer1 Interrupt The Timer1 register pair (TMR1H:TMR1L) increments to FFFFh and rolls over to 0000h. When Timer1 rolls over, the Timer1 interrupt flag bit of the PIR1 register is set. To enable the interrupt on rollover, you must set these bits: * * * * TMR1ON bit of the T1CON register TMR1IE bit of the PIE1 register PEIE bit of the INTCON register GIE bit of the INTCON register 18.7.1 ALTERNATE PIN LOCATIONS This module incorporates I/O pins that can be moved to other locations with the use of the alternate pin function register, APFCON. To determine which pins can be moved and what their default locations are upon a Reset, see Section 11.1 "Alternate Pin Function" for more information. The interrupt is cleared by clearing the TMR1IF bit in the Interrupt Service Routine. Note: 18.7 The TMR1H:TMR1L register pair and the TMR1IF bit should be cleared before enabling interrupts. 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: * * * * * TMR1ON bit of the T1CON register must be set TMR1IE bit of the PIE1 register must be set PEIE bit of the INTCON register must be set T1SYNC bit of the T1CON register must be set TMR1CS bits of the T1CON register must be configured 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. Timer1 oscillator will continue to operate in Sleep regardless of the T1SYNC bit setting. FIGURE 18-2: TIMER1 INCREMENTING EDGE T1CKI = 1 when TMR1 Enabled T1CKI = 0 when TMR1 Enabled Note 1: Arrows indicate counter increments. 2: In Counter mode, a falling edge must be registered by the counter prior to the first incrementing rising edge of the clock. 2014 Microchip Technology Inc. DS40001761A-page 171 PIC16LF1554/1559 FIGURE 18-3: TIMER1 GATE ENABLE MODE TMR1GE T1GPOL t1g_in T1CKI T1GVAL Timer1 N FIGURE 18-4: N+1 N+2 N+3 N+4 TIMER1 GATE TOGGLE MODE TMR1GE T1GPOL T1GTM t1g_in T1CKI T1GVAL Timer1 N DS40001761A-page 172 N+1 N+2 N+3 N+4 N+5 N+6 N+7 N+8 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 18-5: TIMER1 GATE SINGLE-PULSE MODE TMR1GE T1GPOL T1GSPM T1GGO/ Cleared by hardware on falling edge of T1GVAL Set by software DONE Counting enabled on rising edge of T1G t1g_in T1CKI T1GVAL Timer1 TMR1GIF N Cleared by software 2014 Microchip Technology Inc. N+1 N+2 Set by hardware on falling edge of T1GVAL Cleared by software DS40001761A-page 173 PIC16LF1554/1559 FIGURE 18-6: TIMER1 GATE SINGLE-PULSE AND TOGGLE COMBINED MODE TMR1GE T1GPOL T1GSPM T1GTM T1GGO/ Cleared by hardware on falling edge of T1GVAL Set by software DONE Counting enabled on rising edge of T1G t1g_in T1CKI T1GVAL Timer1 TMR1GIF DS40001761A-page 174 N Cleared by software N+1 N+2 N+3 Set by hardware on falling edge of T1GVAL N+4 Cleared by software 2014 Microchip Technology Inc. PIC16LF1554/1559 18.8 Register Definitions: Timer1 Control REGISTER 18-1: R/W-0/u T1CON: TIMER1 CONTROL REGISTER R/W-0/u TMR1CS<1:0> R/W-0/u R/W-0/u T1CKPS<1:0> U-0 R/W-0/u U-0 R/W-0/u -- T1SYNC -- TMR1ON 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 TMR1CS<1:0>: Timer1 Clock Source Select bits 11 = Timer1 clock source is LFINTOSC 10 = Timer1 clock source is external clock from T1CKI pin (on the rising edge) 01 = Timer1 clock source is system clock (FOSC) 00 = Timer1 clock source is instruction clock (FOSC/4) bit 5-4 T1CKPS<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 T1SYNC: Timer1 Synchronization Control bit 1 = Do not synchronize asynchronous clock input 0 = Synchronize asynchronous clock input with system clock (FOSC) bit 1 Unimplemented: Read as `0' bit 0 TMR1ON: Timer1 On bit 1 = Enables Timer1 0 = Stops Timer1 and clears Timer1 gate flip-flop 2014 Microchip Technology Inc. DS40001761A-page 175 PIC16LF1554/1559 REGISTER 18-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 R/W-0/u TMR1GE T1GPOL T1GTM T1GSPM T1GGO/DONE T1GVAL -- T1GSS 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 TMR1GE: Timer1 Gate Enable bit If TMR1ON = 0: This bit is ignored If TMR1ON = 1: 1 = Timer1 counting is controlled by the Timer1 gate function 0 = Timer1 counts regardless of Timer1 gate function bit 6 T1GPOL: 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 T1GTM: 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 T1GSPM: Timer1 Gate Single-Pulse Mode bit 1 = Timer1 gate Single-Pulse mode is enabled and is controlling Timer1 gate 0 = Timer1 gate Single-Pulse mode is disabled bit 3 T1GGO/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 bit 2 T1GVAL: 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 (TMR1GE). bit 1 Unimplemented: Read as `0' bit 0 T1GSS: Timer1 Gate Source Select bits 01 = Timer0 overflow output (T0_overflow) 00 = Timer1 gate pin (T1G) DS40001761A-page 176 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 18-5: 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 ANSELA -- -- ANSA5 ANSA4 -- ANSA2 ANSA1 ANSA0 109 APFCON RXDTSEL SDOSEL SSSEL SDSEL -- TXCKSEL INTCON GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 -- PLLSR -- HFIOFR -- -- LFIOFR HFIOFS 63 PIE1 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 78 PIR1 TMR1GIF AD1IF RCIF TXIF SSP1IF -- TMR2IF TMR1IF 80 TMR1H Holding Register for the Most Significant Byte of the 16-bit TMR1 Count 171* TMR1L Holding Register for the Least Significant Byte of the 16-bit TMR1 Count 171* Name OSCSTAT TRISA -- T1CON TMR1CS<1:0> T1GCON Legend: * Note 1: TMR1GE -- T1GPOL TRISA5 TRISA4 T1CKPS<1:0> T1GTM T1GSPM GRDBSEL GRDASEL 106 --(1) TRISA2 TRISA1 TRISA0 108 -- T1SYNC -- TMR1ON 175 T1GGO/ DONE T1GVAL -- T1GSS 176 -- = unimplemented location, read as `0'. Shaded cells are not used by the Timer1 module. Page provides register information. Unimplemented, read as `1'. 2014 Microchip Technology Inc. DS40001761A-page 177 PIC16LF1554/1559 19.0 TIMER2 MODULE The Timer2 module incorporates the following features: * 8-bit Timer and Period registers (TMR2 and PR2, respectively) * Readable and writable (both registers) * Software programmable prescaler (1:1, 1:4, 1:16, and 1:64) * Software programmable postscaler (1:1 to 1:16) * Interrupt on TMR2 match with PR2 See Figure 19-1 for a block diagram of Timer2. FIGURE 19-1: TIMER2 BLOCK DIAGRAM Rev. 10-000019A 7/30/2013 T2_match Prescaler 1:1, 1:4, 1:16, 1:64 Fosc/4 TMR2 R To Peripherals 2 T2CKPS<1:0> Postscaler 1:1 to 1:16 Comparator set bit TMR2IF 4 T2OUTPS<3:0> PR2 FIGURE 19-2: TIMER2 TIMING DIAGRAM Rev. 10-000020A 7/30/2013 FOSC/4 1:4 Prescale 0x03 PR2 TMR2 0x00 0x01 0x02 0x03 0x00 0x01 0x02 Pulse Width(1) T2_match Note 1: The Pulse Width of T2_match is equal to the scaled input of TMR2. DS40001761A-page 178 2014 Microchip Technology Inc. PIC16LF1554/1559 19.1 Timer2 Operation 19.3 Timer2 Output The clock input to the Timer2 module is the system instruction clock (FOSC/4). The output of TMR2 is T2_match. T2_match is available to the following peripherals: TMR2 increments from 00h on each clock edge. * * * * A 4-bit counter/prescaler on the clock input allows direct input, divide-by-4 and divide-by-16 prescale options. These options are selected by the prescaler control bits, T2CKPS<1:0> of the T2CON register. The value of TMR2 is compared to that of the Period register, PR2, on each clock cycle. When the two values match, the comparator generates a match signal as the timer output. This signal also resets the value of TMR2 to 00h on the next cycle and drives the output counter/ postscaler (see Section 19.2 "Timer2 Interrupt"). The TMR2 and PR2 registers are both directly readable and writable. The TMR2 register is cleared on any device Reset, whereas the PR2 register initializes to FFh. Both the prescaler and postscaler counters are cleared on the following events: * * * * * * * * * a write to the TMR2 register a write to the T2CON register Power-On Reset (POR) Brown-Out Reset (BOR) MCLR Reset Watchdog Timer (WDT) Reset Stack Overflow Reset Stack Underflow Reset RESET Instruction Note: 19.2 Configurable Logic Cell (CLC) Master Synchronous Serial Port (MSSP) Numerically Controlled Oscillator (NCO) Pulse Width Modulator (PWM) The T2_match signal is synchronous with the system clock. Figure 19-3 shows two examples of the timing of the T2_match signal relative to FOSC and prescale value, T2CKPS<1:0>. The upper diagram illustrates 1:1 prescale timing and the lower diagram, 1:X prescale timing. FIGURE 19-3: Rev. 10-000021A 7/30/2013 Q1 Timer2 can also generate an optional device interrupt. The Timer2 output signal (T2_match) provides the input for the 4-bit counter/postscaler. This counter generates the TMR2 match interrupt flag which is latched in TMR2IF of the PIR1 register. The interrupt is enabled by setting the TMR2 Match Interrupt Enable bit, TMR2IE of the PIE1 register. A range of 16 postscale options (from 1:1 through 1:16 inclusive) can be selected with the postscaler control bits, T2OUTPS<3:0>, of the T2CON register. 2014 Microchip Technology Inc. Q2 Q3 Q4 Q1 FOSC TCY1 FOSC/4 T2_match TMR2 = 0 TMR2 = PR2 match PRESCALE = 1:1 (T2CKPS<1:0> = 00) TMR2 is not cleared when T2CON is written. Timer2 Interrupt T2_MATCH TIMING DIAGRAM TCY1 TCY2 ... ... FOSC/4 ... T2_match TCYX TMR2 = PR2 match TMR2 = 0 PRESCALE = 1:X (T2CKPS<1:0> = 01,10,11) 19.4 Timer2 Operation During Sleep Timer2 cannot be operated while the processor is in Sleep mode. The contents of the TMR2 and PR2 registers will remain unchanged while the processor is in Sleep mode. DS40001761A-page 179 PIC16LF1554/1559 19.5 Register Definitions: Timer2 Control REGISTER 19-1: U-0 T2CON: TIMER2 CONTROL REGISTER R/W-0/0 R/W-0/0 -- R/W-0/0 R/W-0/0 R/W-0/0 T2OUTPS<3:0> R/W-0/0 TMR2ON R/W-0/0 T2CKPS<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 Unimplemented: Read as `0' bit 6-3 T2OUTPS<3:0>: Timer2 Output Postscaler Select bits 0000 = 1:1 Postscaler 0001 = 1:2 Postscaler 0010 = 1:3 Postscaler 0011 = 1:4 Postscaler 0100 = 1:5 Postscaler 0101 = 1:6 Postscaler 0110 = 1:7 Postscaler 0111 = 1:8 Postscaler 1000 = 1:9 Postscaler 1001 = 1:10 Postscaler 1010 = 1:11 Postscaler 1011 = 1:12 Postscaler 1100 = 1:13 Postscaler 1101 = 1:14 Postscaler 1110 = 1:15 Postscaler 1111 = 1:16 Postscaler bit 2 TMR2ON: Timer2 On bit 1 = Timer2 is on 0 = Timer2 is off bit 1-0 T2CKPS<1:0>: Timer2 Clock Prescale Select bits 00 = Prescaler is 1 01 = Prescaler is 4 10 = Prescaler is 16 11 = Prescaler is 64 TABLE 19-1: SUMMARY OF REGISTERS ASSOCIATED WITH TIMER2 Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page INTCON GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 PIE1 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 78 PIR1 TMR1GIF AD1IF RCIF TXIF SSP1IF -- TMR2IF TMR1IF 80 Timer2 Module Period Register PR2 T2CON -- TMR2 T2OUTPS<3:0> TMR2ON 178* T2CKPS<1:0> Holding Register for the 8-bit TMR2 Count 180 178* Legend: -- = unimplemented location, read as `0'. Shaded cells are not used for Timer2 module. * Page provides register information. DS40001761A-page 180 2014 Microchip Technology Inc. PIC16LF1554/1559 20.0 20.1 MASTER SYNCHRONOUS SERIAL PORT (MSSP) MODULE Note: MSSP Module Overview Register names, 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. 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, ADC converters, etc. The MSSP module can operate in one of two modes: * Serial Peripheral Interface (SPI) * Inter-Integrated CircuitTM (I2CTM) 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 20-1 is a block diagram of the SPI interface module. FIGURE 20-1: MSSP BLOCK DIAGRAM (SPI MODE) Data Bus Read Write SSPBUF Reg SDI SDO_out SSPSR Reg SDO bit 0 SS SS Control Enable Shift Clock 2 (CKP, CKE) Clock Select Edge Select SCK_out SSPM<3:0> 4 SCK Edge Select Prescaler TOSC 4, 16, 64 Baud Rate Generator (SSPADD) TRISx bit 2014 Microchip Technology Inc. DS40001761A-page 181 PIC16LF1554/1559 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 Clock stretching Bus collision detection General call address matching Address masking Address Hold and Data Hold modes Selectable SDA hold times Figure 20-2 is a block diagram of the I2C interface module in Master mode. Figure 20-3 is a diagram of the I2C interface module in Slave mode. PIC16LF1554/1559 has one MSSP module. MSSP BLOCK DIAGRAM (I2CTM MASTER MODE) Internal data bus Read [SSPM<3:0>] Write SSPBUF Baud Rate Generator (SSPADD) SDA in Receive Enable (RCEN) SCL SCL in Bus Collision DS40001761A-page 182 LSb Start bit, Stop bit, Acknowledge Generate (SSPCON2) Start bit detect, Stop bit detect Write collision detect Clock arbitration State counter for end of XMIT/RCV Address Match detect Clock Cntl SSPSR MSb (Hold off clock source) Shift Clock SDA Clock arbitrate/BCOL detect FIGURE 20-2: Set/Reset: S, P, SSPSTAT, WCOL, SSPOV Reset SEN, PEN (SSPCON2) Set SSP1IF, BCLIF 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 20-3: MSSP BLOCK DIAGRAM (I2CTM SLAVE MODE) Internal Data Bus Read Write SSPBUF Reg SCL Shift Clock SSPSR Reg SDA MSb LSb SSPMSK Reg Match Detect Addr Match SSPADD Reg Start and Stop bit Detect 2014 Microchip Technology Inc. Set, Reset S, P bits (SSPSTAT Reg) DS40001761A-page 183 PIC16LF1554/1559 20.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) Figure 20-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 20-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. With either the master or the slave device, 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. 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. 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 20-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. DS40001761A-page 184 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 20-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 20.2.1 SPI MODE REGISTERS The MSSP module has five registers for SPI mode operation. These are: * * * * * * MSSP STATUS register (SSPSTAT) MSSP Control Register 1 (SSPCON1) MSSP Control Register 3 (SSPCON3) MSSP Data Buffer register (SSPBUF) MSSP Address register (SSPADD) MSSP Shift register (SSPSR) (Not directly accessible) SSPCON1 and SSPSTAT are the control and STATUS registers in SPI mode operation. The SSPCON1 register is readable and writable. The lower six bits of the SSPSTAT are read-only. The upper two bits of the SSPSTAT are read/write. In SPI master mode, SSPADD can be loaded with a value used in the Baud Rate Generator. More information on the Baud Rate Generator is available in Section 20.7 "Baud Rate Generator" SSPSR is the shift register used for shifting data in and out. SSPBUF provides indirect access to the SSPSR register. SSPBUF is the buffer register to which data bytes are written, and from which data bytes are read. In receive operations, SSPSR and SSPBUF together create a buffered receiver. When SSPSR receives a complete byte, it is transferred to SSPBUF and the SSP1IF interrupt is set. During transmission, the SSPBUF is not buffered. A write to SSPBUF will write to both SSPBUF and SSPSR. 2014 Microchip Technology Inc. DS40001761A-page 185 PIC16LF1554/1559 20.2.2 SPI MODE OPERATION When initializing the SPI, several options need to be specified. This is done by programming the appropriate control bits (SSPCON1<5:0> and SSPSTAT<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) When the application software is expecting to receive valid data, the SSPBUF should be read before the next byte of data to transfer is written to the SSPBUF. The Buffer Full bit, BF of the SSPSTAT register, indicates when SSPBUF has been loaded with the received data (transmission is complete). When the SSPBUF 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 SSPSR is not directly readable or writable and can only be accessed by addressing the SSPBUF register. Additionally, the SSPSTAT register indicates the various Status conditions. To enable the serial port, SSP Enable bit, SSPEN of the SSPCON1 register, must be set. To reset or reconfigure SPI mode, clear the SSPEN bit, re-initialize the SSPCONx 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 TRISx bit set * SDO must have corresponding TRISx bit cleared * SCK (Master mode) must have corresponding TRISx bit cleared * SCK (Slave mode) must have corresponding TRISx bit set * SS must have corresponding TRISx bit set Any serial port function that is not desired may be overridden by programming the corresponding data direction (TRISx) register to the opposite value. The MSSP consists of a transmit/receive shift register (SSPSR) and a buffer register (SSPBUF). The SSPSR shifts the data in and out of the device, MSb first. The SSPBUF holds the data that was written to the SSPSR until the received data is ready. Once the eight bits of data have been received, that byte is moved to the SSPBUF register. Then, the Buffer Full Detect bit, BF of the SSPSTAT register, and the interrupt flag bit, SSP1IF, are set. This double-buffering of the received data (SSPBUF) allows the next byte to start reception before reading the data that was just received. Any write to the SSPBUF register during transmission/reception of data will be ignored and the write collision detect bit WCOL of the SSPCON1 register, will be set. User software must clear the WCOL bit to allow the following write(s) to the SSPBUF register to complete successfully. DS40001761A-page 186 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 20-5: SPI MASTER/SLAVE CONNECTION SPI Master SSPM<3:0> = 00xx = 1010 SPI Slave SSPM<3:0> = 010x SDI SDO Serial Input Buffer (BUF) LSb SCK General I/O Processor 1 2014 Microchip Technology Inc. SDO SDI Shift Register (SSPSR) MSb Serial Input Buffer (SSPBUF) Serial Clock Slave Select (optional) Shift Register (SSPSR) MSb LSb SCK SS Processor 2 DS40001761A-page 187 PIC16LF1554/1559 20.2.3 SPI MASTER MODE 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 20-5) is to broadcast data by the software protocol. In Master mode, the data is transmitted/received as soon as the SSPBUF register is written to. If the SPI is only going to receive, the SDO output could be disabled (programmed as an input). The SSPSR 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 SSPBUF register as if a normal received byte (interrupts and Status bits appropriately set). FIGURE 20-6: The clock polarity is selected by appropriately programming the CKP bit of the SSPCON1 register and the CKE bit of the SSPSTAT register. This then, would give waveforms for SPI communication as shown in Figure 20-6, Figure 20-8, Figure 20-9 and Figure 20-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: * * * * FOSC/4 (or TCY) FOSC/16 (or 4 * TCY) FOSC/64 (or 16 * TCY) Fosc/(4 * (SSPADD + 1)) Figure 20-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 SSPBUF is loaded with the received data is shown. SPI MODE WAVEFORM (MASTER MODE) Write to SSPBUF 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 7 bit 0 Input Sample (SMP = 1) SSP1IF SSPSR to SSPBUF DS40001761A-page 188 2014 Microchip Technology Inc. PIC16LF1554/1559 20.2.4 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 SSPCON1 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. 20.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 20-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 SSPCON3 register will enable writes to the SSPBUF register, even if the previous byte has not been read. This allows the software to ignore data that may not apply to it. 20.2.5 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 (SSPCON1<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 (SSPCON1<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 SSPSTAT 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. 2014 Microchip Technology Inc. DS40001761A-page 189 PIC16LF1554/1559 FIGURE 20-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 20-8: SLAVE SELECT SYNCHRONOUS WAVEFORM SS SCK (CKP = 0 CKE = 0) SCK (CKP = 1 CKE = 0) Write to SSPBUF Shift register SSPSR and bit count are reset SSPBUF to SSPSR SDO bit 7 bit 6 bit 7 SDI bit 6 bit 0 bit 0 bit 7 bit 7 Input Sample SSP1IF Interrupt Flag SSPSR to SSPBUF DS40001761A-page 190 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 20-9: SPI MODE WAVEFORM (SLAVE MODE WITH CKE = 0) SS Optional SCK (CKP = 0 CKE = 0) SCK (CKP = 1 CKE = 0) Write to SSPBUF 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 SSPSR to SSPBUF Write Collision detection active FIGURE 20-10: SPI MODE WAVEFORM (SLAVE MODE WITH CKE = 1) SS Not Optional SCK (CKP = 0 CKE = 1) SCK (CKP = 1 CKE = 1) Write to SSPBUF Valid SDO bit 7 bit 6 bit 5 bit 4 bit 3 bit 2 bit 1 bit 0 SDI bit 7 bit 0 Input Sample SSP1IF Interrupt Flag SSPSR to SSPBUF Write Collision detection active 2014 Microchip Technology Inc. DS40001761A-page 191 PIC16LF1554/1559 20.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. Special care must be taken by the user when the MSSP clock is much faster than the system clock. In Slave mode, when MSSP interrupts are enabled, after the master completes sending data, an MSSP interrupt will wake the controller from Sleep. If an exit from Sleep mode is not desired, MSSP interrupts should be disabled. TABLE 20-1: 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. SUMMARY OF REGISTERS ASSOCIATED WITH SPI OPERATION Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page ANSELA -- -- ANSA5 ANSA4 -- ANSA2 ANSA1 ANSA0 109 APFCON RXDTSEL SDOSEL SSSEL SDSEL -- TXCKSEL GRDBSEL GRDASEL 106 INTCON GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 PIE1 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 78 PIR1 TMR1GIF AD1IF RCIF TXIF SSP1IF -- TMR2IF TMR1IF 80 Name SSPBUF Synchronous Serial Port Receive Buffer/Transmit Register 185* SSPCON1 WCOL SSPOV SSPEN CKP SSPCON3 ACKTIM PCIE SCIE BOEN SDAHT SBCDE AHEN DHEN 232 SSPSTAT SMP CKE D/A P S R/W UA BF 229 -- -- TRISA5 TRISA4 --(1) TRISA2 TRISA1 TRISA0 108 TRISA Legend: * Note 1: SSPM<3:0> 230 -- = Unimplemented location, read as `0'. Shaded cells are not used by the MSSP in SPI mode. Page provides register information. Unimplemented, read as `1'. DS40001761A-page 192 2014 Microchip Technology Inc. PIC16LF1554/1559 20.3 I2C MODE OVERVIEW FIGURE 20-11: The Inter-Integrated Circuit Bus (I2C) 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. The I2C bus specifies two signal connections: * Serial Clock (SCL) * Serial Data (SDA) Figure 20-2 and Figure 20-3 show the block diagrams 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 20-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) 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. 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. A Start bit is indicated by a high-to-low transition of the SDA line while the SCL line is held high. Address and data bytes are sent out, Most Significant bit (MSb) first. The Read/Write bit is sent out as a logical one when the master intends to read data from the slave, and is sent out as a logical zero when it intends to write data to the slave. 2014 Microchip Technology Inc. I2CTM MASTER/ SLAVE CONNECTION VDD SCL SCL VDD Master 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. 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. If the master intends to write to the slave, then it repeatedly sends out a byte of data, with the slave responding after each byte with an ACK bit. In this example, the master device is in Master Transmit mode and the slave is in Slave Receive mode. If the master intends to read from the slave, then it repeatedly receives a byte of data from the slave, and responds after each byte with an ACK bit. In this example, the master device is in Master Receive mode and the slave is Slave Transmit mode. 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 first sends a not ACK bit in place of an ACK and then terminates the transfer with a Stop bit. 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 or last ACK bit when it is in receive mode. The I2C bus specifies three message protocols; * Single message where a master writes data to a slave. * Single message where a master reads data from a slave. * Combined message where a master initiates a minimum of two writes, or two reads, or a combination of writes and reads, to one or more slaves. When one device is transmitting a logical one, or letting the line float, and a second device is transmitting a logical zero, or holding the line low, the first device can detect that the line is not a logical one. This detection, when used on the SCL line, is called clock stretching. Clock stretching gives slave devices a mechanism to control the flow of data. When this detection is used on DS40001761A-page 193 PIC16LF1554/1559 the SDA line, it is called arbitration. Arbitration ensures that there is only one master device communicating at any single time. 20.3.1 CLOCK STRETCHING 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. 20.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, there are three conditions under which a collision can occur: a) Two master devices may try to initiate a transmission on or about the same time b) A device acting as multiple devices on the bus (one of which is acting as a master) may collide with another master which is trying to access a slave address on the first device c) Two slaves may respond to a general call read at the same time 20.3.2.1 Multi-Master Collision In the first condition each master 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 must also stop driving the SCL line. Then it 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 DS40001761A-page 194 and actual levels on the SDA line continues with its original transmission. It can do so without any complications because, so far, the transmission appears exactly as expected with no other transmitter disturbing the message. 20.3.2.2 Multi-Master with Slave Recovery In the second condition there are essentially three entities on the bus: a master and a slave that reside within the same device, and a second master attempting to access the slave. If the master coupled to the slave loses the arbitration, then the slave must be able to recover and correctly respond to the second master. To accomplish this, the master which shares a device with the slave must use the I2C Firmware Controller Master mode of operation. This mode utilizes software to perform the master function, while the slave monitors the bus as a separate entity allowing it to respond to the second master. To detect a collision, each device transmitting on the bus must check the level of the SDA data line and compare it to the level that it expects to find. The first transmitter to observe that the two levels do not match loses arbitration, and it must drop off the bus as well as stop transmitting on the SDA line if it is acting as a master. 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. If two master devices send a message to two different slave devices at the address stage, the master sending the lower slave address always wins arbitration. When two master devices send messages to the same slave address, and addresses can sometimes refer to multiple slaves, the arbitration process must continue into the data stage. 20.3.2.3 Multi-Slave Collision When a system attempts a slave read from the general call address, there is the possibility that more than one slave devices may attempt to return data to the master. When this happens, a read collision occurs and the slaves which fail the arbitration must fall off the bus and allow the winning device to continue its data transmission. Once the winning device has completed its data transfer, the master can then initiate an additional read from the general call address to retrieve the second slave's data. In large systems this may require multiple reads by the master. Several protocols use this feature and the MSSP hardware incorporates a detection mechanism in the slave read to detect the condition and respond appropriately. In most designs, arbitration usually occurs very rarely, but it is a necessary process for proper multi-master support or even multi-slave systems that use general call address reads. 2014 Microchip Technology Inc. PIC16LF1554/1559 20.4 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. 20.4.1 BYTE FORMAT TABLE 20-2: TERM 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. 20.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 I2CTM specification. 20.4.3 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. Note: Data is tied to output zero when an I mode is enabled. 20.4.4 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 Slave device that has received a matching address and is actively being clocked by a master. Matching Address Address byte that is clocked into a slave that matches the value stored in SSPADD. 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. 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 TRISx bits. 2C SDA HOLD TIME The hold time of the SDA pin is selected by the SDAHT bit of the SSPCON3 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. Clock Stretching When a device on the bus hold SCL low to stall communication. Bus Collision 2014 Microchip Technology Inc. Description Transmitter 2 All communication in I C 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 8th 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. I2CTM BUS TERMS Any time the SDA line is sampled low by the module while it is outputting and expected high state. DS40001761A-page 195 PIC16LF1554/1559 20.4.5 START CONDITION 20.4.7 2 The I C 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 20-12 shows wave forms for Start and Stop conditions. 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 20-13 shows the wave form for a Restart condition. A bus collision can occur on a Start condition if the module samples the SDA line low before asserting it low. This does not conform to the I2C Specification that states no bus collision can occur on a Start. 20.4.6 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. 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. After a full match with R/W clear in 10-bit mode, a prior match flag is set and maintained. Until a Stop condition, a high address with R/W clear, or high address match fails. 20.4.8 START/STOP CONDITION INTERRUPT MASKING The SCIE and PCIE bits of the SSPCON3 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. I2CTM START AND STOP CONDITIONS FIGURE 20-12: SDA SCL S Start P Change of Change of Data Allowed Data Allowed Condition FIGURE 20-13: Stop Condition I2CTM RESTART CONDITION Sr Change of Change of Data Allowed Restart Data Allowed Condition DS40001761A-page 196 2014 Microchip Technology Inc. PIC16LF1554/1559 20.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 indicated 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 SSPCON2 register. 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 SSPCON2 register is set/cleared to determine the response. Slave hardware will generate an ACK response if the AHEN and DHEN bits of the SSPCON3 register are clear. There are certain conditions where an ACK will not be sent by the slave. If the BF bit of the SSPSTAT register or the SSPOV bit of the SSPCON1 register are set when a byte is received. When the module is addressed, after the 8th falling edge of SCL on the bus, the ACKTIM bit of the SSPCON3 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. 20.5 I2C SLAVE MODE OPERATION The MSSP Slave mode operates in one of four modes selected in the SSPM bits of the SSPCON1 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. 20.5.1 SLAVE MODE ADDRESSES The SSPADD register (Register 20-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 SSPBUF 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 20-5) affects the address matching process. See Section 20.5.9 "SSP Mask Register" for more information. 20.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. 20.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 of the 10-bit address and stored in bits 2 and 1 of the SSPADD register. After the acknowledge of the high byte the UA bit is set and SCL is held low until the user updates SSPADD with the low address. The low address byte is clocked in and all eight bits are compared to the low address value in SSPADD. Even if there is not an address match; SSP1IF and UA are set, and SCL is held low until SSPADD is updated to receive a high byte again. When SSPADD 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. 2014 Microchip Technology Inc. DS40001761A-page 197 PIC16LF1554/1559 20.5.2 SLAVE RECEPTION When the R/W bit of a matching received address byte is clear, the R/W bit of the SSPSTAT register is cleared. The received address is loaded into the SSPBUF 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 SSPSTAT register is set, or bit SSPOV of the SSPCON1 register is set. The BOEN bit of the SSPCON3 register modifies this operation. For more information see Register 20-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 SSPCON2 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 SSPCON1 register, except sometimes in 10-bit mode. See Section 20.2.3 "SPI Master Mode" for more detail. 20.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 20-14 and Figure 20-15 are used as visual references 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. Start bit detected. S bit of SSPSTAT 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 SSPBUF 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 SSPBUF clearing BF. Steps 8-12 are repeated for all received bytes from the Master. Master sends Stop condition, setting P bit of SSPSTAT, and the bus goes idle. DS40001761A-page 198 20.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 8th falling edge of SCL. These additional interrupts allow the slave software to decide whether it wants to ACK the receive address or data byte, rather than the hardware. This functionality adds support for PMBusTM that was not present on previous versions of this module. This list describes the steps that need to be taken by slave software to use these options for I2C communication. Figure 20-16 displays a module using both address and data holding. Figure 20-17 includes the operation with the SEN bit of the SSPCON2 register set. 1. S bit of SSPSTAT 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 8th falling edge of SCL. 3. Slave clears the SSP1IF. 4. Slave can look at the ACKTIM bit of the SSPCON3 register to determine if the SSP1IF was after or before the ACK. 5. Slave reads the address value from SSPBUF, 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 9th 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 8th falling edge of SCL for a received data byte. 12. Slave looks at ACKTIM bit of SSPCON3 to determine the source of the interrupt. 13. Slave reads the received data from SSPBUF 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 SSPSTAT register. 2014 Microchip Technology Inc. 2014 Microchip Technology Inc. SSPOV BF SSP1IF S 1 A7 2 A6 3 A5 4 A4 5 A3 Receiving Address 6 A2 7 A1 8 9 ACK 1 D7 2 D6 4 5 D3 6 D2 7 D1 SSPBUF is read Cleared by software 3 D4 Receiving Data D5 8 9 2 D6 First byte of data is available in SSPBUF 1 D0 ACK D7 4 5 D3 6 D2 7 D1 SSPOV set because SSPBUF is still full. ACK is not sent. Cleared by software 3 D4 Receiving Data D5 8 D0 9 P SSP1IF set on 9th falling edge of SCL ACK = 1 FIGURE 20-14: SCL SDA From Slave to Master Bus Master sends Stop condition PIC16LF1554/1559 I2CTM SLAVE, 7-BIT ADDRESS, RECEPTION (SEN = 0, AHEN = 0, DHEN = 0) DS40001761A-page 199 DS40001761A-page 200 CKP SSPOV BF SSP1IF 1 SCL S A7 2 A6 3 A5 4 A4 5 A3 6 A2 7 A1 8 9 R/W=0 ACK SEN 2 D6 3 D5 4 D4 5 D3 6 D2 7 D1 8 D0 CKP is written to `1' in software, releasing SCL SSPBUF is read Cleared by software Clock is held low until CKP is set to `1' 1 D7 Receive Data 9 ACK SEN 3 D5 4 D4 5 D3 First byte of data is available in SSPBUF 6 D2 7 D1 SSPOV set because SSPBUF is still full. ACK is not sent. Cleared by software 2 D6 CKP is written to `1' in software, releasing SCL 1 D7 Receive Data 8 D0 9 ACK SCL is not held low because ACK= 1 SSP1IF set on 9th falling edge of SCL P FIGURE 20-15: SDA Receive Address Bus Master sends Stop condition PIC16LF1554/1559 I2CTM SLAVE, 7-BIT ADDRESS, RECEPTION (SEN = 1, AHEN = 0, DHEN = 0) 2014 Microchip Technology Inc. 2014 Microchip Technology Inc. P S ACKTIM CKP ACKDT BF SSP1IF S Receiving Address 1 3 5 6 7 8 ACK the received byte Slave software clears ACKDT to Address is read from SSBUF If AHEN = 1: SSP1IF is set 4 ACKTIM set by hardware on 8th falling edge of SCL When AHEN=1: CKP is cleared by hardware and SCL is stretched 2 A7 A6 A5 A4 A3 A2 A1 Receiving Data 9 2 3 4 5 6 7 ACKTIM cleared by hardware in 9th rising edge of SCL When DHEN=1: CKP is cleared by hardware on 8th falling edge of SCL SSP1IF is set on 9th falling edge of SCL, after ACK 1 8 ACK D7 D6 D5 D4 D3 D2 D1 D0 Received Data 1 2 4 5 6 ACKTIM set by hardware on 8th falling edge of SCL CKP set by software, SCL is released 8 Slave software sets ACKDT to not ACK 7 Cleared by software 3 D7 D6 D5 D4 D3 D2 D1 D0 Data is read from SSPBUF 9 ACK 9 P No interrupt after not ACK from Slave ACK=1 Master sends Stop condition FIGURE 20-16: SCL SDA Master Releases SDA to slave for ACK sequence PIC16LF1554/1559 I2CTM SLAVE, 7-BIT ADDRESS, RECEPTION (SEN = 0, AHEN = 1, DHEN = 1) DS40001761A-page 201 DS40001761A-page 202 P S ACKTIM CKP ACKDT BF SSP1IF S Receiving Address 4 5 6 7 8 When AHEN = 1; on the 8th falling edge of SCL of an address byte, CKP is cleared Slave software clears ACKDT to ACK the received byte Received address is loaded into SSPBUF 2 3 ACKTIM is set by hardware on 8th falling edge of SCL 1 A7 A6 A5 A4 A3 A2 A1 9 ACK Receive Data 2 3 4 5 6 7 8 ACKTIM is cleared by hardware on 9th rising edge of SCL When DHEN = 1; on the 8th falling edge of SCL of a received data byte, CKP is cleared Received data is available on SSPBUF Cleared by software 1 D7 D6 D5 D4 D3 D2 D1 D0 9 ACK Receive Data 1 3 4 5 6 7 8 Set by software, release SCL Slave sends not ACK SSPBUF can be read any time before next byte is loaded 2 D7 D6 D5 D4 D3 D2 D1 D0 9 ACK CKP is not cleared if not ACK No interrupt after if not ACK from Slave P Master sends Stop condition FIGURE 20-17: SCL SDA R/W = 0 Master releases SDA to slave for ACK sequence PIC16LF1554/1559 I2CTM SLAVE, 7-BIT ADDRESS, RECEPTION (SEN = 1, AHEN = 1, DHEN = 1) 2014 Microchip Technology Inc. PIC16LF1554/1559 20.5.3 SLAVE TRANSMISSION 20.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 SSPSTAT register is set. The received address is loaded into the SSPBUF 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 20-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 20.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 SSPBUF register which also loads the SSPSR register. Then the SCL pin should be released by setting the CKP bit of the SSPCON1 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 SSPCON2 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 SSPBUF 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 SSPSTAT register is used to determine the status of the byte. The SSP1IF bit is set on the falling edge of the ninth clock pulse. 20.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 SSPCON3 register is set, the BCLIF bit of the PIRx register is set. Once a bus collision is detected, the slave goes Idle and waits to be addressed again. User software can use the BCLIF bit to handle a slave bus collision. 2014 Microchip Technology Inc. Master sends a Start condition on SDA and SCL. 2. S bit of SSPSTAT 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 SSPBUF, clearing BF. 7. R/W is set so CKP was automatically cleared after the ACK. 8. The slave software loads the transmit data into SSPBUF. 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. DS40001761A-page 203 DS40001761A-page 204 P S D/A R/W ACKSTAT CKP BF SSP1IF S 1 2 5 6 7 Received address is read from SSPBUF 4 Indicates an address has been received R/W is copied from the matching address byte When R/W is set SCL is always held low after 9th SCL falling edge 3 8 9 Automatic 2 3 4 5 Set by software Data to transmit is loaded into SSPBUF Cleared by software 1 6 7 8 9 D7 D6 D5 D4 D3 D2 D1 D0 ACK Transmitting Data 2 3 4 5 7 8 CKP is not held for not ACK 6 Masters not ACK is copied to ACKSTAT BF is automatically cleared after 8th falling edge of SCL 1 D7 D6 D5 D4 D3 D2 D1 D0 Transmitting Data 9 ACK P FIGURE 20-18: SCL SDA R/W = 1 Automatic A7 A6 A5 A4 A3 A2 A1 ACK Receiving Address Master sends Stop condition PIC16LF1554/1559 I2CTM SLAVE, 7-BIT ADDRESS, TRANSMISSION (AHEN = 0) 2014 Microchip Technology Inc. PIC16LF1554/1559 20.5.3.3 7-Bit Transmission with Address Hold Enabled Setting the AHEN bit of the SSPCON3 register enables additional clock stretching and interrupt generation after the 8th 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 20-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 SSPSTAT is set; SSP1IF is set if interrupt on Start detect is enabled. 3. Master sends matching address with R/W bit set. After the 8th 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 SSPCON3 register, and R/W and D/A of the SSPSTAT register to determine the source of the interrupt. 6. Slave reads the address value from the SSPBUF 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 SSPCON2 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 SSPBUF setting the BF bit. Note: SSPBUF cannot be loaded until after the ACK. 13. Slave sets CKP bit releasing the clock. 14. Master clocks out the data from the slave and sends an ACK value on the 9th SCL pulse. 15. Slave hardware copies the ACK value into the ACKSTAT bit of the SSPCON2 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. 2014 Microchip Technology Inc. DS40001761A-page 205 DS40001761A-page 206 D/A R/W ACKTIM CKP ACKSTAT ACKDT BF SSP1IF S Receiving Address 2 4 5 6 7 8 Slave clears ACKDT to ACK address ACKTIM is set on 8th falling edge of SCL 9 ACK When R/W = 1; CKP is always cleared after ACK R/W = 1 Received address is read from SSPBUF 3 When AHEN = 1; CKP is cleared by hardware after receiving matching address. 1 A7 A6 A5 A4 A3 A2 A1 3 4 5 6 Cleared by software 2 Set by software, releases SCL Data to transmit is loaded into SSPBUF 1 7 8 9 Transmitting Data Automatic D7 D6 D5 D4 D3 D2 D1 D0 ACK ACKTIM is cleared on 9th rising edge of SCL Automatic Transmitting Data 1 3 4 5 6 7 after not ACK CKP not cleared Master's ACK response is copied to SSPSTAT BF is automatically cleared after 8th falling edge of SCL 2 8 D7 D6 D5 D4 D3 D2 D1 D0 9 ACK P Master sends Stop condition FIGURE 20-19: SCL SDA Master releases SDA to slave for ACK sequence PIC16LF1554/1559 I2CTM SLAVE, 7-BIT ADDRESS, TRANSMISSION (AHEN = 1) 2014 Microchip Technology Inc. PIC16LF1554/1559 20.5.4 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 20-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 SSPSTAT 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 SSPSTAT register is set. Slave sends ACK and SSP1IF is set. Software clears the SSP1IF bit. Software reads received address from SSPBUF clearing the BF flag. Slave loads low address into SSPADD, releasing SCL. Master sends matching low address byte to the Slave; UA bit is set. 20.5.5 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 SSPADD register using the UA bit. All functionality, specifically when the CKP bit is cleared and SCL line is held low are the same. Figure 20-21 can be used as a reference of a slave in 10-bit addressing with AHEN set. Figure 20-22 shows a standard waveform for a slave transmitter in 10-bit Addressing mode. Note: Updates to the SSPADD 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 SSPADD 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 SSPBUF clearing BF. 12. Slave loads high address into SSPADD. 13. Master clocks a data byte to the slave and clocks out the slaves ACK on the 9th SCL pulse; SSP1IF is set. 14. If SEN bit of SSPCON2 is set, CKP is cleared by hardware and the clock is stretched. 15. Slave clears SSP1IF. 16. Slave reads the received byte from SSPBUF 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. 2014 Microchip Technology Inc. DS40001761A-page 207 DS40001761A-page 208 CKP UA BF SSP1IF S 1 1 2 1 5 6 7 0 A9 A8 8 Set by hardware on 9th falling edge 4 1 When UA = 1; SCL is held low If address matches SSPADD it is loaded into SSPBUF 3 1 Receive First Address Byte 9 ACK 1 3 4 5 6 7 8 Software updates SSPADD and releases SCL 2 9 A7 A6 A5 A4 A3 A2 A1 A0 ACK Receive Second Address Byte 1 3 4 5 6 7 8 9 1 3 4 5 6 7 Data is read from SSPBUF SCL is held low while CKP = 0 2 8 9 D7 D6 D5 D4 D3 D2 D1 D0 ACK Receive Data Set by software, When SEN = 1; releasing SCL CKP is cleared after 9th falling edge of received byte Receive address is read from SSPBUF Cleared by software 2 D7 D6 D5 D4 D3 D2 D1 D0 ACK Receive Data P FIGURE 20-20: SCL SDA Master sends Stop condition PIC16LF1554/1559 I2CTM SLAVE, 10-BIT ADDRESS, RECEPTION (SEN = 1, AHEN = 0, DHEN = 0) 2014 Microchip Technology Inc. 2014 Microchip Technology Inc. ACKTIM CKP UA ACKDT BF 2 1 5 0 6 A9 7 A8 Set by hardware on 9th falling edge 4 1 8 R/W = 0 ACKTIM is set by hardware on 8th falling edge of SCL If when AHEN = 1; on the 8th falling edge of SCL of an address byte, CKP is cleared Slave software clears ACKDT to ACK the received byte 3 1 Receive First Address Byte 9 ACK UA 2 3 A5 4 A4 6 A2 7 A1 Update to SSPADD is not allowed until 9th falling edge of SCL SSPBUF can be read anytime before the next received byte 5 A3 Receive Second Address Byte A6 Cleared by software 1 A7 8 A0 9 ACK UA 2 D6 3 D5 4 D4 6 D2 Set CKP with software releases SCL 7 D1 Update of SSPADD, clears UA and releases SCL 5 D3 Receive Data Cleared by software 1 D7 8 9 2 Received data is read from SSPBUF 1 D6 D5 Receive Data D0 ACK D7 FIGURE 20-21: SSP1IF 1 SCL S 1 SDA PIC16LF1554/1559 I2CTM SLAVE, 10-BIT ADDRESS, RECEPTION (SEN = 0, AHEN = 1, DHEN = 0) DS40001761A-page 209 DS40001761A-page 210 D/A R/W ACKSTAT CKP UA BF SSP1IF 4 5 6 7 Set by hardware 3 Indicates an address has been received UA indicates SSPADD must be updated SSPBUF loaded with received address 2 8 9 1 SCL S Receiving Address R/W = 0 1 1 1 1 0 A9 A8 ACK 1 3 4 5 6 7 8 After SSPADD is updated, UA is cleared and SCL is released Cleared by software 2 9 A7 A6 A5 A4 A3 A2 A1 A0 ACK Receiving Second Address Byte 1 4 5 6 7 8 Set by hardware 2 3 R/W is copied from the matching address byte When R/W = 1; CKP is cleared on 9th falling edge of SCL High address is loaded back into SSPADD Received address is read from SSPBUF Sr 1 1 1 1 0 A9 A8 Receive First Address Byte 9 ACK 2 3 4 5 6 7 8 Masters not ACK is copied Set by software releases SCL Data to transmit is loaded into SSPBUF 1 D7 D6 D5 D4 D3 D2 D1 D0 Transmitting Data Byte 9 P Master sends Stop condition ACK = 1 Master sends not ACK FIGURE 20-22: SDA Master sends Restart event PIC16LF1554/1559 I2CTM SLAVE, 10-BIT ADDRESS, TRANSMISSION (SEN = 0, AHEN = 0, DHEN = 0) 2014 Microchip Technology Inc. PIC16LF1554/1559 20.5.6 CLOCK STRETCHING 20.5.6.2 10-Bit Addressing Mode 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. 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 SSPADD. The CKP bit of the SSPCON1 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. When AHEN bit of SSPCON3 is set; CKP is cleared by hardware after the 8th falling edge of SCL for a received matching address byte. When DHEN bit of SSPCON3 is set; CKP is cleared after the 8th falling edge of SCL for received data. 20.5.6.1 Stretching after the 8th 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. Normal Clock Stretching Following an ACK if the R/W bit of SSPSTAT is set, a read request, the slave hardware will clear CKP. This allows the slave time to update SSPBUF with data to transfer to the master. If the SEN bit of SSPCON2 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. Note 1: The BF bit has no effect on if the clock will be stretched or not. This is different than previous versions of the module that would not stretch the clock, clear CKP, if SSPBUF was read before the 9th falling edge of SCL. 2: Previous versions of the module did not stretch the clock for a transmission if SSPBUF was loaded before the 9th falling edge of SCL. It is now always cleared for read requests. FIGURE 20-23: Note: Previous versions of the module did not stretch the clock if the second address byte did not match. 20.5.6.3 20.5.7 Byte NACKing 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 20-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 SSPCON1 2014 Microchip Technology Inc. DS40001761A-page 211 PIC16LF1554/1559 20.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 SSPCON3 register is set, just as with any other address reception, the slave hardware will stretch the clock after the 8th 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 SSPCON2 register is set, the slave module will automatically ACK the reception of this address regardless of the value stored in SSPADD. 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 SSPBUF and respond. Figure 20-24 shows a general call reception sequence. FIGURE 20-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 (SSPSTAT<0>) Cleared by software GCEN (SSPCON2<7>) SSPBUF is read '1' 20.5.9 SSP MASK REGISTER An SSP Mask (SSPMSK) register (Register 20-5) is available in I2C Slave mode as a mask for the value held in the SSPSR register during an address comparison operation. A zero (`0') bit in the SSPMSK register has the effect of making the corresponding bit of the received address a "don't care". 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. DS40001761A-page 212 2014 Microchip Technology Inc. PIC16LF1554/1559 20.6 I2C MASTER MODE Master mode is enabled by setting and clearing the appropriate SSPM bits in the SSPCON1 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 TRISx controls when necessary to drive the pins low. 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 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 detected Stop condition detected 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 SSPBUF register to initiate transmission before the Start condition is complete. In this case, the SSPBUF will not be written to and the WCOL bit will be set, indicating that a write to the SSPBUF did not occur 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. 2014 Microchip Technology Inc. 20.6.1 I2C MASTER MODE OPERATION 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. 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 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 20.7 "Baud Rate Generator" for more detail. 20.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 SSPADD 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 20-25). DS40001761A-page 213 PIC16LF1554/1559 FIGURE 20-25: BAUD RATE GENERATOR TIMING WITH CLOCK ARBITRATION SDA DX - 1 DX SCL allowed to transition high SCL deasserted but slave holds SCL low (clock arbitration) 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 20.6.3 WCOL STATUS FLAG Start condition and causes the S bit of the SSPSTAT1 register to be set. Following this, the Baud Rate Generator is reloaded with the contents of SSPADD<7:0> and resumes its count. When the Baud Rate Generator times out (TBRG), the SEN bit of the SSPCON2 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. If the user writes the SSPBUF when a Start, Restart, Stop, Receive or Transmit sequence is in progress, the WCOL bit 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 SSPBUF was attempted while the module was not Idle. Note: 20.6.4 Because queuing of events is not allowed, writing to the lower five bits of SSPCON2 is disabled until the Start condition is complete. 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. I2C MASTER MODE START CONDITION TIMING To initiate a Start condition (Figure 20-26), the user sets the Start Enable bit, SEN bit of the SSPCON2 register. If the SDA and SCL pins are sampled high, the Baud Rate Generator is reloaded with the contents of SSPADD<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 FIGURE 20-26: 2: The Philips I2CTM Specification states that a bus collision cannot occur on a Start. FIRST START BIT TIMING Write to SEN bit occurs here Set S bit (SSPSTAT<3>) At completion of Start bit, hardware clears SEN bit and sets SSP1IF bit SDA = 1, SCL = 1 TBRG TBRG Write to SSPBUF occurs here SDA 1st bit 2nd bit TBRG SCL S DS40001761A-page 214 TBRG 2014 Microchip Technology Inc. PIC16LF1554/1559 20.6.5 I2C MASTER MODE REPEATED START CONDITION TIMING SSPCON2 register will be automatically 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 SSPSTAT register will be set. The SSP1IF bit will not be set until the Baud Rate Generator has timed out. A Repeated Start condition (Figure 20-27) occurs when the RSEN bit of the SSPCON2 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 FIGURE 20-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'. REPEAT START CONDITION WAVEFORM S bit set by hardware Write to SSPCON2 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 SSPBUF occurs here TBRG SCL Sr TBRG Repeated Start 20.6.6 I2C MASTER MODE TRANSMISSION 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 SSPBUF 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 2014 Microchip Technology Inc. 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 SSPBUF, leaving SCL low and SDA unchanged (Figure 20-28). After the write to the SSPBUF, 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 SSPCON2 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 SSPBUF takes place, holding SCL low and allowing SDA to float. DS40001761A-page 215 PIC16LF1554/1559 20.6.6.1 BF Status Flag In Transmit mode, the BF bit of the SSPSTAT register is set when the CPU writes to SSPBUF and is cleared when all eight bits are shifted out. 20.6.6.2 WCOL Status Flag If the user writes the SSPBUF when a transmit is already in progress (i.e., SSPSR 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. 20.6.6.3 ACKSTAT Status Flag In Transmit mode, the ACKSTAT bit of the SSPCON2 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. 20.6.6.4 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. Typical Transmit Sequence The user generates a Start condition by setting the SEN bit of the SSPCON2 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 SSPBUF with the slave address to transmit. Address is shifted out the SDA pin until all eight bits are transmitted. Transmission begins as soon as SSPBUF 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 SSPCON2 register. The MSSP module generates an interrupt at the end of the ninth clock cycle by setting the SSP1IF bit. The user loads the SSPBUF 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 SSPCON2 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 SSPCON2 register. Interrupt is generated once the Stop/Restart condition is complete. DS40001761A-page 216 2014 Microchip Technology Inc. 2014 Microchip Technology Inc. S R/W PEN SEN BF (SSPSTAT<0>) SSP1IF SCL SDA A6 A5 A4 A3 A2 A1 3 4 5 Cleared by software 2 6 7 8 9 After Start condition, SEN cleared by hardware SSPBUF written 1 D7 1 SCL held low while CPU responds to SSP1IF ACK = 0 R/W = 0 SSPBUF written with 7-bit address and R/W start transmit A7 Transmit Address to Slave 3 D5 4 D4 5 D3 6 D2 7 D1 8 D0 SSPBUF is written by software Cleared by software service routine from SSP interrupt 2 D6 Transmitting Data or Second Half of 10-bit Address From slave, clear ACKSTAT bit SSPCON2<6> P Cleared by software 9 ACK ACKSTAT in SSPCON2 = 1 FIGURE 20-28: SEN = 0 Write SSPCON2<0> SEN = 1 Start condition begins PIC16LF1554/1559 I2CTM MASTER MODE WAVEFORM (TRANSMISSION, 7 OR 10-BIT ADDRESS) DS40001761A-page 217 PIC16LF1554/1559 20.6.7 I2C MASTER MODE RECEPTION Master mode reception (Figure 20-29) is enabled by programming the Receive Enable bit, RCEN bit of the SSPCON2 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 SSPSR. After the falling edge of the eighth clock, the receive enable flag is automatically cleared, the contents of the SSPSR are loaded into the SSPBUF, 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 SSPCON2 register. 20.6.7.1 BF Status Flag In receive operation, the BF bit is set when an address or data byte is loaded into SSPBUF from SSPSR. It is cleared when the SSPBUF register is read. 20.6.7.2 1. 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 SSPSR and the BF flag bit is already set from a previous reception. 20.6.7.3 20.6.7.4 WCOL Status Flag If the user writes the SSPBUF when a receive is already in progress (i.e., SSPSR 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). DS40001761A-page 218 12. 13. 14. 15. Typical Receive Sequence The user generates a Start condition by setting the SEN bit of the SSPCON2 register. SSP1IF is set by hardware on completion of the Start. SSP1IF is cleared by software. User writes SSPBUF 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 SSPBUF 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 SSPCON2 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 SSPCON2 register and the Master clocks in a byte from the slave. After the 8th falling edge of SCL, SSP1IF and BF are set. User clears SSP1IF and reads the received byte from SSPBUF, which clears the BF flag. User either clears the SSPCON2 ACKDT bit to receive another byte or sets the ACKDT bit to suppress further data and then initiates the acknowledge sequence by setting the ACKEN bit. Master's ACK or not 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. If the ACKDT bit was set in step 11, then the user can send a Stop to release the bus. 2014 Microchip Technology Inc. 2014 Microchip Technology Inc. RCEN ACKEN SSPOV BF (SSPSTAT<0>) SDA = 0, SCL = 1 while CPU responds to SSP1IF SSP1IF S 1 A7 2 4 5 6 Cleared by software 3 A6 A5 A4 A3 A2 Transmit Address to Slave 7 8 9 ACK 2 3 5 6 7 8 D0 9 ACK 2 3 4 RCEN cleared automatically 5 6 7 Cleared by software Set SSP1IF interrupt at end of Acknowledge sequence Data shifted in on falling edge of CLK 1 ACK from Master SDA = ACKDT = 0 Cleared in software Set SSP1IF at end of receive 9 ACK is not sent ACK P Set SSP1IF interrupt at end of Acknowledge sequence Bus master terminates transfer Set P bit (SSPSTAT<4>) and SSP1IF PEN bit = 1 written here SSPOV is set because SSPBUF is still full 8 D0 RCEN cleared automatically D7 D6 D5 D4 D3 D2 D1 RCEN cleared automatically Set ACKEN, start Acknowledge sequence SDA = ACKDT = 1 Receiving Data from Slave RCEN = 1, start next receive ACK from Master SDA = ACKDT = 0 Last bit is shifted into SSPSR and contents are unloaded into SSPBUF Cleared by software Set SSP1IF interrupt at end of receive 4 Cleared by software 1 D7 D6 D5 D4 D3 D2 D1 Receiving Data from Slave RCEN cleared automatically Master configured as a receiver by programming SSPCON2<3> (RCEN = 1) A1 R/W ACK from Slave Master configured as a receiver by programming SSPCON2<3> (RCEN = 1) FIGURE 20-29: SCL SDA SEN = 0 Write to SSPBUF occurs here, start XMIT Write to SSPCON2<0> (SEN = 1), begin Start condition Write to SSPCON2<4> to start Acknowledge sequence SDA = ACKDT (SSPCON2<5>) = 0 PIC16LF1554/1559 I2CTM MASTER MODE WAVEFORM (RECEPTION, 7-BIT ADDRESS) DS40001761A-page 219 PIC16LF1554/1559 20.6.8 ACKNOWLEDGE SEQUENCE TIMING 20.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 SSPCON2 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 SSPSTAT register is set. A TBRG later, the PEN bit is cleared and the SSP1IF bit is set (Figure 20-31). An Acknowledge sequence is enabled by setting the Acknowledge Sequence Enable bit, ACKEN bit of the SSPCON2 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 20-30). 20.6.8.1 20.6.9.1 WCOL Status Flag If the user writes the SSPBUF 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 SSPBUF when an Acknowledge sequence is in progress, then the WCOL bit is set and the contents of the buffer are unchanged (the write does not occur). FIGURE 20-30: STOP CONDITION TIMING ACKNOWLEDGE SEQUENCE WAVEFORM Acknowledge sequence starts here, write to SSPCON2 ACKEN = 1, ACKDT = 0 ACKEN automatically cleared TBRG TBRG SDA SCL D0 ACK 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. DS40001761A-page 220 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 20-31: STOP CONDITION RECEIVE OR TRANSMIT MODE SCL = 1 for TBRG, followed by SDA = 1 for TBRG after SDA sampled high. P bit (SSPSTAT<4>) is set. Write to SSPCON2, set PEN PEN bit (SSPCON2<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. 20.6.10 SLEEP OPERATION 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). 20.6.11 EFFECTS OF A RESET A Reset disables the MSSP module and terminates the current transfer. 20.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 SSPSTAT 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 BCLIF bit. The states where arbitration can be lost are: * * * * * Address Transfer Data Transfer A Start Condition A Repeated Start Condition An Acknowledge Condition 20.6.13 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, BCLIF and reset the I2C port to its Idle state (Figure 20-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 SSPBUF 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 SSPCON2 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 SSPBUF 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 SSPSTAT register, or the bus is Idle and the S and P bits are cleared. 2014 Microchip Technology Inc. DS40001761A-page 221 PIC16LF1554/1559 FIGURE 20-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 (BCLIF) BCLIF 20.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 20-33). SCL is sampled low before SDA is asserted low (Figure 20-34). During a Start condition, both the SDA and the SCL pins are monitored. 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 BCLIF flag is set and * the MSSP module is reset to its Idle state (Figure 20-33). Note: 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. 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. If the SDA pin is sampled low during this count, the BRG is reset and the SDA line is asserted early (Figure 20-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. DS40001761A-page 222 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 20-33: BUS COLLISION DURING START CONDITION (SDA ONLY) SDA goes low before the SEN bit is set. Set BCLIF, 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 SDA sampled low before Start condition. Set BCLIF. S bit and SSP1IF set because SDA = 0, SCL = 1. BCLIF SSP1IF and BCLIF are cleared by software S SSP1IF SSP1IF and BCLIF are cleared by software FIGURE 20-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 BCLIF. SEN SCL = 0 before BRG time-out, bus collision occurs. Set BCLIF. BCLIF Interrupt cleared by software `0' `0' SSP1IF `0' `0' S 2014 Microchip Technology Inc. DS40001761A-page 223 PIC16LF1554/1559 FIGURE 20-35: BRG RESET DUE TO SDA ARBITRATION DURING START CONDITION SDA = 0, SCL = 1 Set S Less than TBRG SDA SCL TBRG SDA pulled low by other master. Reset BRG and assert SDA. S SCL pulled low after BRG time-out SEN BCLIF Set SSP1IF Set SEN, enable Start sequence if SDA = 1, SCL = 1 `0' S SSP1IF SDA = 0, SCL = 1, set SSP1IF DS40001761A-page 224 Interrupts cleared by software 2014 Microchip Technology Inc. PIC16LF1554/1559 20.6.13.2 Bus Collision During a Repeated Start Condition If SDA is low, a bus collision has occurred (i.e., another master is attempting to transmit a data `0', Figure 20-36). If SDA is sampled high, the BRG is reloaded and begins 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) 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 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 20-37. When the user releases SDA and the pin is allowed to float high, the BRG is loaded with SSPADD and counts down to zero. The SCL pin is then deasserted and when sampled high, the SDA pin is sampled. FIGURE 20-36: 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. BUS COLLISION DURING A REPEATED START CONDITION (CASE 1) SDA SCL Sample SDA when SCL goes high. If SDA = 0, set BCLIF and release SDA and SCL. RSEN BCLIF Cleared by software S `0' SSP1IF `0' FIGURE 20-37: BUS COLLISION DURING REPEATED START CONDITION (CASE 2) TBRG TBRG SDA SCL BCLIF SCL goes low before SDA, set BCLIF. Release SDA and SCL. Interrupt cleared by software RSEN S `0' SSP1IF 2014 Microchip Technology Inc. DS40001761A-page 225 PIC16LF1554/1559 20.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 SSPADD and counts down to 0. 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 20-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 20-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 20-38: BUS COLLISION DURING A STOP CONDITION (CASE 1) TBRG TBRG SDA sampled low after TBRG, set BCLIF TBRG SDA SDA asserted low SCL PEN BCLIF P `0' SSP1IF `0' FIGURE 20-39: BUS COLLISION DURING A STOP CONDITION (CASE 2) TBRG TBRG TBRG SDA Assert SDA SCL SCL goes low before SDA goes high, set BCLIF PEN BCLIF P `0' SSP1IF `0' DS40001761A-page 226 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 20-3: SUMMARY OF REGISTERS ASSOCIATED WITH I2CTM OPERATION Name Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Reset Values on Page: INTCON GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 PIE1 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 78 PIE2 -- AD2IE -- -- BCLIE -- -- -- 79 PIR1 TMR1GIF AD1IF RCIF TXIF SSP1IF -- TMR2IF TMR1IF 80 PIR2 -- AD2IF -- -- BCLIF -- -- -- 81 SSPADD ADD<7:0> 233 SSPBUF Synchronous Serial Port Receive Buffer/Transmit Register 185* SSPCON1 WCOL SSPOV SSPEN CKP SSPCON2 GCEN ACKSTAT ACKDT ACKEN RCEN PEN RSEN SEN 231 SSPCON3 ACKTIM PCIE SCIE BOEN SDAHT SBCDE AHEN DHEN 232 SSPMSK SSPSTAT TRISA SSPM<3:0> 230 MSK<7:0> SMP -- CKE -- D/A TRISA5 233 P S R/W UA BF TRISA4 --(1) TRISA2 TRISA1 TRISA0 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used by the MSSP module in * Page provides register information. Note 1: Unimplemented, read as `1'. 2014 Microchip Technology Inc. 229 I2CTM 108 mode. DS40001761A-page 227 PIC16LF1554/1559 20.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 SSPADD register (Register 20-6). When a write occurs to SSPBUF, 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. An internal signal "Reload" in Figure 20-40 triggers the value from SSPADD to be loaded into the BRG counter. This occurs twice for each oscillation of the module clock line. The logic dictating when the reload signal is asserted depends on the mode the MSSP is being operated in. Table 20-4 demonstrates clock rates based on instruction cycles and the BRG value loaded into SSPADD. EQUATION 20-1: FOSC FCLOCK = ------------------------------------------------ SSPxADD + 1 4 FIGURE 20-40: BAUD RATE GENERATOR BLOCK DIAGRAM SSPM<3:0> SSPM<3:0> Reload SCL Control SSPxCLK SSPADD<7:0> Reload BRG Down Counter FOSC/2 Note: Values of 0x00, 0x01 and 0x02 are not valid for SSPADD when used as a Baud Rate Generator for I2C. This is an implementation limitation. TABLE 20-4: Note 1: 20.7.1 MSSP CLOCK RATE W/BRG FOSC FCY BRG Value FCLOCK (2 Rollovers of BRG) 32 MHz 8 MHz 13h 400 kHz(1) 32 MHz 8 MHz 19h 308 kHz 32 MHz 8 MHz 4Fh 100 kHz 16 MHz 4 MHz 09h 400 kHz(1) 16 MHz 4 MHz 0Ch 308 kHz 16 MHz 4 MHz 27h 100 kHz 4 MHz 1 MHz 09h 100 kHz The I2CTM interface does not conform to the 400 kHz I2C specification (which applies to rates greater than 100 kHz) in all details, but may be used with care where higher rates are required by the application. ALTERNATE PIN LOCATIONS This module incorporates I/O pins that can be moved to other locations with the use of the alternate pin function register, APFCON. To determine which pins can be moved and what their default locations are upon a Reset, see Section 11.1 "Alternate Pin Function" for more information. DS40001761A-page 228 2014 Microchip Technology Inc. PIC16LF1554/1559 20.8 Register Definitions: MSSP Control REGISTER 20-1: SSPSTAT: SSP STATUS REGISTER R/W-0/0 R/W-0/0 R-0/0 R-0/0 R-0/0 R-0/0 R-0/0 R-0/0 SMP CKE D/A P S 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 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) 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 CTM 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 (I2CTM 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 (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 (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 SSPADD 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), SSPBUF is full 0 = Data transmit complete (does not include the ACK and Stop bits), SSPBUF is empty 2014 Microchip Technology Inc. DS40001761A-page 229 PIC16LF1554/1559 REGISTER 20-2: SSPCON1: SSP CONTROL REGISTER 1 R/C/HS-0/0 R/C/HS-0/0 R/W-0/0 R/W-0/0 WCOL SSPOV 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 Master mode: 1 = A write to the SSPBUF register was attempted while the I2CTM conditions were not valid for a transmission to be started 0 = No collision Slave mode: 1 = The SSPBUF 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 SSPBUF register is still holding the previous data. In case of overflow, the data in SSPSR is lost. Overflow can only occur in Slave mode. In Slave mode, the user must read the SSPBUF, 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 SSPBUF register (must be cleared in software). 0 = No overflow 2 In I C mode: 1 = A byte is received while the SSPBUF 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, these 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 I2 C 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 I2 C Slave mode: SCL release control 1 = Enable clock 0 = Holds clock low (clock stretch). Used to ensure data setup time. In I2 C Master mode: Unused in this mode bit 3-0 SSPM<3:0>: Synchronous Serial Port Mode Select bits 0000 = SPI Master mode, clock = FOSC/4 0001 = SPI Master mode, clock = FOSC/16 0010 = SPI Master mode, clock = FOSC/64 0011 = Reserved 0100 = SPI Slave mode, clock = SCK pin, SS pin control enabled 0101 = SPI Slave mode, clock = SCK pin, SS pin control disabled, SS can be used as I/O pin 0110 = I2C Slave mode, 7-bit address 0111 = I2C Slave mode, 10-bit address 1000 = I2C Master mode, clock = FOSC / (4 * (SSPADD+1))(4) 1001 = Reserved 1010 = SPI Master mode, clock = FOSC/(4 * (SSPADD+1))(5) 1011 = I2C firmware controlled Master mode (Slave idle) 1100 = Reserved 1101 = Reserved 1110 = I2C Slave mode, 7-bit address with Start and Stop bit interrupts enabled 1111 = I2C Slave mode, 10-bit address with Start and Stop bit interrupts enabled 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 SSPBUF register. When enabled, these pins must be properly configured as input or output. When enabled, the SDA and SCL pins must be configured as inputs. SSPADD values of 0, 1 or 2 are not supported for I2C mode. SSPADD value of `0' is not supported. Use SSPM = 0000 instead. DS40001761A-page 230 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 20-3: SSPCON2: SSP CONTROL REGISTER 2 R/W-0/0 R-0/0 R/W-0/0 R/S/HS-0/0 R/S/HS-0/0 R/S/HS-0/0 R/S/HS-0/0 R/W/HS-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 I2CTM Slave mode only) 1 = Enable interrupt when a general call address (0x00 or 00h) is received in the SSPSR 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)(1) 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) 1 = Enables Receive mode for I2C 0 = Receive idle bit 2 PEN: Stop Condition Enable bit (in I2C Master mode only)(1) SCK 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) 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(1) 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: If the I2C module is not in the Idle mode, this bit may not be set (no spooling) and the SSPBUF may not be written (or writes to the SSPBUF are disabled). 2014 Microchip Technology Inc. DS40001761A-page 231 PIC16LF1554/1559 REGISTER 20-4: SSPCON3: SSP 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 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 (I2CTM mode only)(3) 1 = Indicates the I2C bus is in an Acknowledge sequence, set on eighth falling edge of SCL clock 0 = Not an Acknowledge sequence, cleared on ninth 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 BCLIF bit of the PIR2 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. DS40001761A-page 232 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 20-5: R/W-1/1 SSPMSK: SSP 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 MSK<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 MSK<7:1>: Mask bits 1 = The received address bit n is compared to SSPADD<n> to detect I2C address match 0 = The received address bit n is not used to detect I2C address match bit 0 MSK<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 SSPADD<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, the bit is ignored REGISTER 20-6: R/W-0/0 SSPADD: MSSP ADDRESS AND BAUD RATE REGISTER (I2CTM 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 ADD<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 ADD<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 ADD<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 ADD<7:0>: Eight Least Significant bits of 10-bit address 7-Bit Slave mode: bit 7-1 ADD<7:1>: 7-bit address bit 0 Not used: Unused in this mode. Bit state is a "don't care". 2014 Microchip Technology Inc. DS40001761A-page 233 PIC16LF1554/1559 21.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 ADC or DAC 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 21-1 and Figure 21-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 21-1: EUSART TRANSMIT BLOCK DIAGRAM Rev. 10-000113A 10/14/2013 Data bus TXIE 8 Interrupt TXREG register TXIF 8 MSb LSb (8) 0 TX/CK Pin Buffer and Control Transmit Shift Register (TSR) TX_out TXEN Baud Rate Generator TRMT FOSC /n TX9 n BRG16 TX9D +1 Multiplier x16 x64 SYNC 1 x 0 0 0 BRGH x 1 1 0 0 BRG16 x 1 0 1 0 SPBRGH SPBRGL DS40001761A-page 234 x4 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 21-2: EUSART RECEIVE BLOCK DIAGRAM Rev. 10-000114A 7/30/2013 CREN OERR RCIDL SPEN RSR Register MSb RX/DT pin Pin Buffer and Control Baud Rate Generator Data Recovery FOSC Stop (8) 7 LSb 1 0 Start /n RX9 BRG16 +1 Multiplier x4 x16 x64 SYNC 1 x 0 0 0 BRGH x 1 1 0 0 BRG16 x 1 0 1 0 SPBRGH SPBRGL n FIFO FERR RX9D RCREG Register 8 Data Bus RCIF RCIE Interrupt The operation of the EUSART module is controlled through three registers: * Transmit Status and Control (TXSTA) * Receive Status and Control (RCSTA) * Baud Rate Control (BAUDCON) These registers are detailed in Register 21-1, Register 21-2 and Register 21-3, respectively. When the receiver or transmitter section is not enabled then the corresponding RX or TX pin may be used for general purpose input and output. 2014 Microchip Technology Inc. DS40001761A-page 235 PIC16LF1554/1559 21.1 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 21-5 for examples of baud rate configurations. 21.1.1.2 Transmitting Data A transmission is initiated by writing a character to the TXREG register. If this is the first character, or the previous character has been completely flushed from the TSR, the data in the TXREG 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 TXREG until the Stop bit of the previous character has been transmitted. The pending character in the TXREG 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 TXREG. 21.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 BAUDCON 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 21.5.1.2 "Clock Polarity". 21.1.1 21.1.1.4 EUSART ASYNCHRONOUS TRANSMITTER The EUSART transmitter block diagram is shown in Figure 21-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 TXREG register. 21.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 TXSTA register enables the transmitter circuitry of the EUSART. Clearing the SYNC bit of the TXSTA register configures the EUSART for asynchronous operation. Setting the SPEN bit of the RCSTA 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 ANSELx bit. Note: Transmit Interrupt Flag The TXIF interrupt flag bit of the PIR1 register is set whenever the EUSART transmitter is enabled and no character is being held for transmission in the TXREG. In other words, the TXIF bit is only clear when the TSR is busy with a character and a new character has been queued for transmission in the TXREG. The TXIF flag bit is not cleared immediately upon writing TXREG. TXIF becomes valid in the second instruction cycle following the write execution. Polling TXIF immediately following the TXREG write will return invalid results. The TXIF bit is read-only, it cannot be set or cleared by software. The TXIF interrupt can be enabled by setting the TXIE interrupt enable bit of the PIE1 register. However, the TXIF flag bit will be set whenever the TXREG is empty, regardless of the state of TXIE enable bit. To use interrupts when transmitting data, set the TXIE bit only when there is more data to send. Clear the TXIE interrupt enable bit upon writing the last character of the transmission to the TXREG. The TXIF Transmitter Interrupt flag is set when the TXEN enable bit is set. DS40001761A-page 236 2014 Microchip Technology Inc. PIC16LF1554/1559 21.1.1.5 TSR Status 21.1.1.7 The TRMT bit of the TXSTA 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 TXREG. 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: 21.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 TXSTA register is set, the EUSART will shift nine bits out for each character transmitted. The TX9D bit of the TXSTA 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 TXREG. All nine bits of data will be transferred to the TSR shift register immediately after the TXREG is written. A special 9-bit Address mode is available for use with multiple receivers. See Section 21.1.2.7 "Address Detection" for more information on the address mode. FIGURE 21-3: Write to TXREG BRG Output (Shift Clock) 6. 7. 8. Initialize the SPBRGH, SPBRGL register pair and the BRGH and BRG16 bits to achieve the desired baud rate (see Section 21.4 "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 TXIF interrupt bit to be set. If interrupts are desired, set the TXIE interrupt enable bit of the PIE1 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 TXREG 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 TXIF 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. 2014 Microchip Technology Inc. DS40001761A-page 237 PIC16LF1554/1559 FIGURE 21-4: ASYNCHRONOUS TRANSMISSION (BACK-TO-BACK) Write to TXREG TX/CK pin Start bit bit 0 bit 1 Word 1 1 TCY TXIF bit (Transmit Buffer Reg. Empty Flag) bit 7/8 Stop bit Start bit Word 2 bit 0 1 TCY Word 1 Transmit Shift Reg. TRMT bit (Transmit Shift Reg. Empty Flag) Note: Word 2 Word 1 BRG Output (Shift Clock) Word 2 Transmit Shift Reg. This timing diagram shows two consecutive transmissions. TABLE 21-1: SUMMARY OF REGISTERS ASSOCIATED WITH ASYNCHRONOUS TRANSMISSION Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page ABDOVF RCIDL -- SCKP BRG16 -- WUE ABDEN 245 GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 PIE1 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 78 PIR1 TMR1GIF AD1IF RCIF TXIF SSP1IF -- TMR2IF TMR1IF 80 SPEN RX9 SREN CREN ADDEN FERR OERR RX9D 244 Name BAUDCON INTCON RCSTA SPBRGL BRG<7:0> 246* SPBRGH BRG<15:8> 246* TRISB TRISB7 TRISB6 TXSTA TRISB5 TRISB4 -- -- -- -- EUSART Transmit Data Register TXREG CSRC TX9 TXEN SYNC SENDB BRGH 112 236 TRMT TX9D 243 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used for asynchronous transmission. * Page provides register information. DS40001761A-page 238 2014 Microchip Technology Inc. PIC16LF1554/1559 21.1.2 EUSART ASYNCHRONOUS RECEIVER The Asynchronous mode is typically used in RS-232 systems. The receiver block diagram is shown in Figure 21-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 RCREG register. 21.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 RCSTA register enables the receiver circuitry of the EUSART. Clearing the SYNC bit of the TXSTA register configures the EUSART for asynchronous operation. Setting the SPEN bit of the RCSTA register enables the EUSART. The programmer must set the corresponding TRISx bit to configure the RX/DT I/O pin as an input. Note: If the RX/DT function is on an analog pin, the corresponding ANSELx bit must be cleared for the receiver to function. 21.1.2.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 21.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 RCIF interrupt flag bit of the PIR1 register is set. The top character in the FIFO is transferred out of the FIFO by reading the RCREG register. Note: 21.1.2.3 If the receive FIFO is overrun, no additional characters will be received until the overrun condition is cleared. See Section 21.1.2.5 "Receive Overrun Error" for more information on overrun errors. Receive Interrupts The RCIF interrupt flag bit of the PIR1 register is set whenever the EUSART receiver is enabled and there is an unread character in the receive FIFO. The RCIF interrupt flag bit is read-only, it cannot be set or cleared by software. RCIF interrupts are enabled by setting all of the following bits: * RCIE, Interrupt Enable bit of the PIE1 register * PEIE, Peripheral Interrupt Enable bit of the INTCON register * GIE, Global Interrupt Enable bit of the INTCON register The RCIF interrupt flag bit will be set when there is an unread character in the FIFO, regardless of the state of interrupt enable bits. 2014 Microchip Technology Inc. DS40001761A-page 239 PIC16LF1554/1559 21.1.2.4 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 RCSTA 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 RCREG. 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. The FERR bit can be forced clear by clearing the SPEN bit of the RCSTA register, which resets the EUSART. Clearing the CREN bit of the RCSTA register does not affect the FERR bit. A framing error by itself does not generate an interrupt. Note: 21.1.2.5 21.1.2.7 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 RCSTA 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 RCIF 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. If all receive characters in the receive FIFO have framing errors, repeated reads of the RCREG 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 RCSTA 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 RCSTA register or by resetting the EUSART by clearing the SPEN bit of the RCSTA register. 21.1.2.6 Receiving 9-Bit Characters The EUSART supports 9-bit character reception. When the RX9 bit of the RCSTA register is set, the EUSART will shift nine bits into the RSR for each character received. The RX9D bit of the RCSTA 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 RCREG. DS40001761A-page 240 2014 Microchip Technology Inc. PIC16LF1554/1559 21.1.2.8 Asynchronous Reception Set-up: Initialize the SPBRGH, SPBRGL register pair and the BRGH and BRG16 bits to achieve the desired baud rate (see Section 21.4 "EUSART Baud Rate Generator (BRG)"). 2. Clear the ANSELx 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 RCIE bit of the PIE1 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 RCIF 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 RCIE interrupt enable bit was also set. 8. Read the RCSTA 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 RCREG register. 10. If an overrun occurred, clear the OERR flag by clearing the CREN receiver enable bit. 21.1.2.9 1. 2014 Microchip Technology Inc. 9-Bit Address Detection Mode Set-up This mode would typically be used in RS-485 systems. To set up an asynchronous reception with address detect enable: 1. Initialize the SPBRGH, SPBRGL register pair and the BRGH and BRG16 bits to achieve the desired baud rate (see Section 21.4 "EUSART Baud Rate Generator (BRG)"). 2. Clear the ANSELx 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 RCIE bit of the PIE1 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 RCIF 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 RCIE interrupt enable bit was also set. 9. Read the RCSTA 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 RCREG 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. DS40001761A-page 241 PIC16LF1554/1559 FIGURE 21-5: ASYNCHRONOUS RECEPTION Start bit bit 0 RX/DT pin bit 7/8 Stop bit bit 1 Rcv Shift Reg Rcv Buffer Reg. Start bit bit 0 Start bit bit 7/8 Stop bit Word 2 RCREG Word 1 RCREG RCIDL bit 7/8 Stop bit Read Rcv Buffer Reg. RCREG RCIF (Interrupt Flag) OERR bit CREN Note: This timing diagram shows three words appearing on the RX input. The RCREG (receive buffer) is read after the third word, causing the OERR (overrun) bit to be set. TABLE 21-2: Name SUMMARY OF REGISTERS ASSOCIATED WITH ASYNCHRONOUS RECEPTION Bit 7 Bit 6 ABDOVF GIE PIE1 PIR1 BAUDCON INTCON Bit 2 Bit 1 Bit 0 Register on Page BRG16 -- WUE ABDEN 245 IOCIE TMR0IF INTF IOCIF 77 TXIE SSP1IE -- TMR2IE TMR1IE 78 TXIF SSP1IF -- TMR2IF TMR1IF 80 Bit 5 Bit 4 Bit 3 RCIDL -- SCKP PEIE TMR0IE INTE TMR1GIE AD1IE RCIE TMR1GIF AD1IF RCIF RCREG EUSART Receive Data Register RCSTA SPEN RX9 SREN CREN ADDEN FERR 239* OERR RX9D 244 SPBRGL BRG<7:0> 246* SPBRGH BRG<15:8> 246* TRISB TRISB7 TRISB6 TRISB5 TRISB4 -- -- -- -- 112 TXSTA CSRC TX9 TXEN SYNC SENDB BRGH TRMT TX9D 243 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used for asynchronous reception. * Page provides register information. 21.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. The Auto-Baud Detect feature (see Section 21.4.1 "Auto-Baud Detect") can be used to compensate for changes in the INTOSC frequency. There may not be fine enough resolution when adjusting the Baud Rate Generator to compensate for a gradual change in the peripheral clock frequency. DS40001761A-page 242 2014 Microchip Technology Inc. PIC16LF1554/1559 21.3 Register Definitions: EUSART Control REGISTER 21-1: R/W-/0 TXSTA: 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: Don't care 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 Sync Break on next transmission (cleared by hardware upon completion) 0 = Sync Break transmission completed Synchronous mode: Don't care bit 2 BRGH: High Baud Rate Select bit Asynchronous mode: 1 = High speed 0 = Low speed Synchronous mode: Unused in this mode 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. 2014 Microchip Technology Inc. DS40001761A-page 243 PIC16LF1554/1559 REGISTER 21-2: RCSTA: RECEIVE STATUS AND CONTROL REGISTER R/W-0/0 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 SPEN 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 = Serial port enabled (configures RX/DT and TX/CK pins as serial port pins) 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: Don't care Synchronous mode - Master: 1 = Enables single receive 0 = Disables single receive This bit is cleared after reception is complete. Synchronous mode - Slave Don't care bit 4 CREN: Continuous Receive Enable bit Asynchronous mode: 1 = Enables receiver 0 = Disables receiver 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 the receive buffer when RSR<8> 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): Don't care bit 2 FERR: Framing Error bit 1 = Framing error (can be updated by reading RCREG 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. DS40001761A-page 244 2014 Microchip Technology Inc. PIC16LF1554/1559 REGISTER 21-3: BAUDCON: BAUD RATE CONTROL REGISTER R-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: Synchronous Clock Polarity Select bit Asynchronous mode: 1 = Transmit inverted data to the TX/CK pin 0 = Transmit non-inverted data to the TX/CK pin Synchronous mode: 1 = Data is clocked on rising edge of the clock 0 = Data is clocked on falling edge of the clock 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 = Receiver is waiting for a falling edge. No character will be received, RCIF bit will be set. WUE will automatically clear after RCIF is set. 0 = Receiver is operating normally Synchronous mode: Don't care bit 0 ABDEN: Auto-Baud Detect Enable bit Asynchronous mode: 1 = Auto-Baud Detect mode is enabled (clears when auto-baud is complete) 0 = Auto-Baud Detect mode is disabled Synchronous mode: Don't care 2014 Microchip Technology Inc. DS40001761A-page 245 PIC16LF1554/1559 21.4 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 BAUDCON register selects 16-bit mode. The SPBRGH, SPBRGL 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 TXSTA register and the BRG16 bit of the BAUDCON register. In Synchronous mode, the BRGH bit is ignored. Table 21-3 contains the formulas for determining the baud rate. Example 21-1 provides a sample calculation for determining the baud rate and baud rate error. Typical baud rates and error values for various asynchronous modes have been computed for your convenience and are shown in Table 21-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. EXAMPLE 21-1: CALCULATING BAUD RATE ERROR For a device with FOSC of 16 MHz, desired baud rate of 9600, Asynchronous mode, 8-bit BRG: F OS C Desired Baud Rate = -----------------------------------------------------------------------64 [SPBRGH:SPBRGL] + 1 Solving for SPBRGH:SPBRGL: FOSC --------------------------------------------Desired Baud Rate X = --------------------------------------------- - 1 64 16000000 -----------------------9600 = ------------------------ - 1 64 = 25.042 = 25 16000000 Calculated Baud Rate = --------------------------64 25 + 1 = 9615 Calc. Baud Rate - Desired Baud Rate Error = -------------------------------------------------------------------------------------------Desired Baud Rate 9615 - 9600 = ---------------------------------- = 0.16% 9600 Writing a new value to the SPBRGH, SPBRGL 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. DS40001761A-page 246 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 21-3: BAUD RATE FORMULAS Configuration Bits SYNC BRG16 BRGH BRG/EUSART Mode Baud Rate Formula FOSC/[64 (n+1)] 0 0 0 8-bit/Asynchronous 0 0 1 8-bit/Asynchronous 0 1 0 16-bit/Asynchronous 0 1 1 16-bit/Asynchronous 1 0 x 8-bit/Synchronous 1 1 x 16-bit/Synchronous FOSC/[16 (n+1)] FOSC/[4 (n+1)] Legend: x = Don't care, n = value of SPBRGH, SPBRGL register pair. TABLE 21-4: Name BAUDCON RCSTA SUMMARY OF REGISTERS ASSOCIATED WITH THE BAUD RATE GENERATOR Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 ABDOVF RCIDL -- SCKP BRG16 SPEN RX9 SREN CREN ADDEN SPBRGL BRG<7:0> SPBRGH BRG<15:8> TXSTA CSRC TX9 TXEN SYNC SENDB Bit 1 Bit 0 Register on Page -- WUE ABDEN 245 FERR OERR RX9D 244 Bit 2 246* 246* BRGH TRMT TX9D 243 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used for the Baud Rate Generator. * Page provides register information. 2014 Microchip Technology Inc. DS40001761A-page 247 PIC16LF1554/1559 TABLE 21-5: BAUD RATES FOR ASYNCHRONOUS MODES SYNC = 0, BRGH = 0, BRG16 = 0 BAUD RATE FOSC = 32.000 MHz FOSC = 20.000 MHz FOSC = 11.0592 MHz Actual Rate % Error 300 -- -- -- -- -- -- -- -- -- -- -- -- 1200 -- -- -- 1221 1.73 255 1200 0.00 239 1200 0.00 143 Actual Rate % Error SPBRG value (decimal) FOSC = 18.432 MHz SPBRG value (decimal) Actual Rate % Error SPBRG value (decimal) Actual Rate % Error SPBRG value (decimal) 2400 2404 0.16 207 2404 0.16 129 2400 0.00 119 2400 0.00 71 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 -- -- -- -- -- -- -- -- -- -- -- -- SYNC = 0, BRGH = 0, 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 FOSC = 1.000 MHz % Error SPBRG value (decimal) Actual Rate % Error SPBRG value (decimal) 300 -- -- -- 300 0.16 207 300 0.00 191 300 0.16 51 1200 1202 0.16 103 1202 0.16 51 1200 0.00 47 1202 0.16 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 -- -- -- -- -- -- -- -- -- -- -- -- 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 FOSC = 11.0592 MHz SPBRG value (decimal) 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 DS40001761A-page 248 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 21-5: BAUD RATES FOR ASYNCHRONOUS MODES (CONTINUED) SYNC = 0, BRGH = 1, BRG16 = 0 BAUD RATE FOSC = 8.000 MHz SPBRG Actual % value Rate Error (decimal) FOSC = 4.000 MHz SPBRG Actual % value Rate Error (decimal) FOSC = 3.6864 MHz SPBRG Actual % value Rate Error (decimal) FOSC = 1.000 MHz SPBRG Actual % value Rate Error (decimal) 300 1200 -- -- -- -- -- -- -- 1202 -- 0.16 -- 207 -- 1200 -- 0.00 -- 191 300 1202 0.16 0.16 207 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 Actual Rate FOSC = 20.000 MHz % Error SPBRG value (decimal) Actual Rate FOSC = 18.432 MHz % Error SPBRG value (decimal) Actual Rate FOSC = 11.0592 MHz % Error SPBRG value (decimal) Actual Rate % Error SPBRG value (decimal) 300 300.0 0.00 6666 300.0 -0.01 4166 300.0 0.00 3839 300.0 0.00 2303 1200 1200 -0.02 3332 1200 -0.03 1041 1200 0.00 959 1200 0.00 575 2400 2401 -0.04 832 2399 -0.03 520 2400 0.00 479 2400 0.00 287 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.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 SYNC = 0, BRGH = 0, 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 % Error FOSC = 1.000 MHz SPBRG value (decimal) Actual Rate % Error SPBRG value (decimal) 300 299.9 -0.02 1666 300.1 0.04 832 300.0 0.00 767 300.5 0.16 207 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 -- -- -- 2014 Microchip Technology Inc. DS40001761A-page 249 PIC16LF1554/1559 TABLE 21-5: BAUD RATES FOR ASYNCHRONOUS MODES (CONTINUED) SYNC = 0, BRGH = 1, BRG16 = 1 or SYNC = 1, BRG16 = 1 FOSC = 32.000 MHz SPBRG Actual % value Rate Error (decimal) FOSC = 20.000 MHz SPBRG Actual % value Rate Error (decimal) FOSC = 18.432 MHz SPBRG Actual % value Rate Error (decimal) FOSC = 11.0592 MHz SPBRG Actual % value Rate Error (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 BAUD RATE 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 -- -- -- DS40001761A-page 250 2014 Microchip Technology Inc. PIC16LF1554/1559 21.4.1 AUTO-BAUD DETECT 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 21.4.3 "Auto-Wake-up on Break"). 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 BAUDCON register starts the auto-baud calibration sequence (Figure 21-6). 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 SPBRG begins counting up using the BRG counter clock as shown in Table 21-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 SPBRGH, SPBRGL register pair, the ABDEN bit is automatically cleared and the RCIF interrupt flag is set. The value in the RCREG needs to be read to clear the RCIF interrupt. RCREG content should be discarded. When calibrating for modes that do not use the SPBRGH register the user can verify that the SPBRGL register did not overflow by checking for 00h in the SPBRGH register. 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 1. Upon completion of the auto-baud sequence, to achieve maximum accuracy, subtract 1 from the SPBRGH:SPBRGL register pair. TABLE 21-6: The BRG auto-baud clock is determined by the BRG16 and BRGH bits as shown in Table 21-6. During ABD, both the SPBRGH and SPBRGL registers are used as a 16-bit counter, independent of the BRG16 bit setting. While calibrating the baud rate period, the SPBRGH and SPBRGL registers are clocked at 1/8th the BRG base clock rate. The resulting byte measurement is the average bit time when clocked at full speed. FIGURE 21-6: 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 FOSC/4 FOSC/32 1 Note 1: During the ABD sequence, SPBRGL and SPBRGH registers are both used as a 16-bit counter, independent of BRG16 setting. AUTOMATIC BAUD RATE CALIBRATION XXXXh BRG Value BRG COUNTER CLOCK RATES(1) 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 RCIF bit (Interrupt) Read RCREG SPBRGL XXh 1Ch SPBRGH XXh 00h Note 1: The ABD sequence requires the EUSART module to be configured in Asynchronous mode. 2014 Microchip Technology Inc. DS40001761A-page 251 PIC16LF1554/1559 21.4.2 AUTO-BAUD OVERFLOW During the course of automatic baud detection, the ABDOVF bit of the BAUDCON 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 SPBRGH:SPBRGL register pair. After the ABDOVF bit has been set, the counter continues to count until the fifth rising edge is detected on the RX pin. Upon detecting the fifth RX edge, the hardware will set the RCIF interrupt flag and clear the ABDEN bit of the BAUDCON register. The RCIF flag can be subsequently cleared by reading the RCREG register. The ABDOVF flag of the BAUDCON register can be cleared by software directly. To terminate the auto-baud process before the RCIF flag is set, clear the ABDEN bit then clear the ABDOVF bit of the BAUDCON register. The ABDOVF bit will remain set if the ABDEN bit is not cleared first. 21.4.3 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 BAUDCON 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 EUSART module generates an RCIF interrupt coincident with the wake-up event. The interrupt is generated synchronously to the Q clocks in normal CPU operating modes (Figure 21-7), and asynchronously if the device is in Sleep mode (Figure 21-8). The interrupt condition is cleared by reading the RCREG register. 21.4.3.1 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 The wake-up event causes a receive interrupt by setting the RCIF 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 RCREG 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 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. DS40001761A-page 252 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 21-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 RCIF Note 1: Cleared due to User Read of RCREG The EUSART remains in Idle while the WUE bit is set. FIGURE 21-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 RCIF Sleep Command Executed Note 1: 2: Sleep Ends Cleared due to User Read of RCREG 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. 2014 Microchip Technology Inc. DS40001761A-page 253 PIC16LF1554/1559 21.4.4 BREAK CHARACTER 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. To send a Break character, set the SENDB and TXEN bits of the TXSTA register. The Break character transmission is then initiated by a write to the TXREG. The value of data written to TXREG will be ignored and all `0's will be transmitted. 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). The TRMT bit of the TXSTA register indicates when the transmit operation is active or idle, just as it does during normal transmission. See Figure 21-9 for the timing of the Break character sequence. 21.4.4.1 Break and Sync Transmit Sequence 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. 1. 2. 3. 4. 5. 21.4.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 RCSTA register and the received data as indicated by RCREG. The Baud Rate Generator is assumed to have been initialized to the expected baud rate. A Break character has been received when; * RCIF bit is set * FERR bit is set * RCREG = 00h The second method uses the Auto-Wake-up feature described in Section 21.4.3 "Auto-Wake-up on Break". By enabling this feature, the EUSART will sample the next two transitions on RX/DT, cause an RCIF 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 BAUDCON register before placing the EUSART in Sleep mode. Configure the EUSART for the desired mode. Set the TXEN and SENDB bits to enable the Break sequence. Load the TXREG with a dummy character to initiate transmission (the value is ignored). Write `55h' to TXREG 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. When the TXREG becomes empty, as indicated by the TXIF, the next data byte can be written to TXREG. FIGURE 21-9: Write to TXREG SEND BREAK CHARACTER SEQUENCE Dummy Write BRG Output (Shift Clock) TX (pin) Start bit bit 0 bit 1 bit 11 Stop bit Break TXIF bit (Transmit Interrupt Flag) TRMT bit (Transmit Shift Empty Flag) SENDB (send Break control bit) DS40001761A-page 254 SENDB Sampled Here Auto Cleared 2014 Microchip Technology Inc. PIC16LF1554/1559 21.5 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. 21.5.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 Setting the SYNC bit of the TXSTA register configures the device for synchronous operation. Setting the CSRC bit of the TXSTA register configures the device as a master. Clearing the SREN and CREN bits of the RCSTA register ensures that the device is in the Transmit mode, otherwise the device will be configured to receive. Setting the SPEN bit of the RCSTA register enables the EUSART. 21.5.1.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. 2014 Microchip Technology Inc. 21.5.1.2 Clock Polarity A clock polarity option is provided for Microwire compatibility. Clock polarity is selected with the SCKP bit of the BAUDCON 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. 21.5.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 TXREG register. If the TSR still contains all or part of a previous character the new character data is held in the TXREG 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 TXREG is immediately transferred to the TSR. The transmission of the character commences immediately following the transfer of the data to the TSR from the TXREG. Each data bit changes on the leading edge of the master clock and remains valid until the subsequent leading clock edge. Note: The TSR register is not mapped in data memory, so it is not available to the user. 21.5.1.4 Synchronous Master Transmission Set-up: 1. 2. 3. 4. 5. 6. 7. 8. Initialize the SPBRGH, SPBRGL register pair and the BRGH and BRG16 bits to achieve the desired baud rate (see Section 21.4 "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 TXIE bit of the PIE1 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 TXREG register. DS40001761A-page 255 PIC16LF1554/1559 FIGURE 21-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 TXREG Reg Write Word 1 Write Word 2 TXIF bit (Interrupt Flag) TRMT bit TXEN bit `1' Note: `1' Sync Master mode, SPBRGL = 0, continuous transmission of two 8-bit words. FIGURE 21-11: SYNCHRONOUS TRANSMISSION (THROUGH TXEN) RX/DT pin bit 0 bit 2 bit 1 bit 6 bit 7 TX/CK pin Write to TXREG reg TXIF bit TRMT bit TXEN bit TABLE 21-7: Name SUMMARY OF REGISTERS ASSOCIATED WITH SYNCHRONOUS MASTER TRANSMISSION Bit 7 Bit 6 ABDOVF GIE PIE1 PIR1 BAUDCON INTCON RCSTA Bit 2 Bit 1 Bit 0 Register on Page BRG16 -- WUE ABDEN 245 IOCIE TMR0IF INTF IOCIF 77 TXIE SSP1IE -- TMR2IE TMR1IE 78 RCIF TXIF SSP1IF -- TMR2IF TMR1IF 80 SREN CREN ADDEN FERR OERR RX9D Bit 5 Bit 4 Bit 3 RCIDL -- SCKP PEIE TMR0IE INTE TMR1GIE AD1IE RCIE TMR1GIF AD1IF SPEN RX9 244 SPBRGL BRG<7:0> 246* SPBRGH BRG<15:8> 246* TRISB TRISB7 TRISB6 TXSTA Legend: * TRISB5 TRISB4 -- -- -- -- BRGH TRMT TX9D EUSART Transmit Data Register TXREG CSRC TX9 TXEN SYNC SENDB 112 236* 243 -- = unimplemented location, read as `0'. Shaded cells are not used for synchronous master transmission. Page provides register information. DS40001761A-page 256 2014 Microchip Technology Inc. PIC16LF1554/1559 21.5.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 RCSTA register) or the Continuous Receive Enable bit (CREN of the RCSTA 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. 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 RCIF 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 RCREG. The RCIF bit remains set as long as there are unread characters in the receive FIFO. Note: 21.5.1.6 If the RX/DT function is on an analog pin, the corresponding ANSELx bit must be cleared for the receiver to function. Slave Clock 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: 21.5.1.7 If the device is configured as a slave and the TX/CK function is on an analog pin, the corresponding ANSELx bit must be cleared. Receive Overrun Error 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 RCREG. If the overrun occurred when the CREN bit is set then the error condition is cleared by either clearing the CREN bit of the RCSTA register or by clearing the SPEN bit which resets the EUSART. 21.5.1.8 Receiving 9-Bit Characters The EUSART supports 9-bit character reception. When the RX9 bit of the RCSTA register is set, the EUSART will shift 9 bits into the RSR for each character received. The RX9D bit of the RCSTA 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 RCREG. 21.5.1.9 Synchronous Master Reception Set-up: 1. Initialize the SPBRGH, SPBRGL 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 ANSELx 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 RCIE bit of the PIE1 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 RCIF will be set when reception of a character is complete. An interrupt will be generated if the enable bit RCIE was set. 9. Read the RCSTA 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 RCREG register. 11. If an overrun error occurs, clear the error by either clearing the CREN bit of the RCSTA register or by clearing the SPEN bit which resets the EUSART. The receive FIFO buffer can hold two characters. An overrun error will be generated if a third character, in its entirety, is received before RCREG is read to access the FIFO. When this happens the OERR bit of the RCSTA register is set. Previous data in the FIFO will not be overwritten. The two characters in the FIFO 2014 Microchip Technology Inc. DS40001761A-page 257 PIC16LF1554/1559 FIGURE 21-12: SYNCHRONOUS RECEPTION (MASTER MODE, SREN) RX/DT pin 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' RCIF bit (Interrupt) Read RCREG Note: Timing diagram demonstrates Sync Master mode with bit SREN = 1 and bit BRGH = 0. TABLE 21-8: SUMMARY OF REGISTERS ASSOCIATED WITH SYNCHRONOUS MASTER RECEPTION Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page ABDOVF RCIDL -- SCKP BRG16 -- WUE ABDEN 245 GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 PIE1 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 78 PIR1 TMR1GIF AD1IF RCIF TXIF SSP1IF -- TMR2IF TMR1IF Name BAUDCON INTCON RCREG RCSTA EUSART Receive Data Register SPEN RX9 SREN SPBRGL CREN ADDEN FERR OERR RX9D BRG<7:0> SPBRGH 80 239* 244 246* BRG<15:8> 246* TRISB TRISB7 TRISB6 TRISB5 TRISB4 -- -- -- -- 112 TXSTA CSRC TX9 TXEN SYNC SENDB BRGH TRMT TX9D 243 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used for synchronous master reception. * Page provides register information. DS40001761A-page 258 2014 Microchip Technology Inc. PIC16LF1554/1559 21.5.2 SYNCHRONOUS SLAVE MODE 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 1. 2. 3. 4. Setting the SYNC bit of the TXSTA register configures the device for synchronous operation. Clearing the CSRC bit of the TXSTA register configures the device as a slave. Clearing the SREN and CREN bits of the RCSTA register ensures that the device is in the Transmit mode, otherwise the device will be configured to receive. Setting the SPEN bit of the RCSTA register enables the EUSART. 21.5.2.1 If two words are written to the TXREG and then the SLEEP instruction is executed, the following will occur: EUSART Synchronous Slave Transmit 5. 21.5.2.2 1. The operation of the Synchronous Master and Slave modes are identical (see Section 21.5.1.3 "Synchronous Master Transmission"), except in the case of the Sleep mode. 2. 3. 4. 5. 6. 7. 8. TABLE 21-9: The first character will immediately transfer to the TSR register and transmit. The second word will remain in the TXREG register. The TXIF bit will not be set. After the first character has been shifted out of TSR, the TXREG register will transfer the second character to the TSR and the TXIF bit will now be set. If the PEIE and TXIE 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. Synchronous Slave Transmission Set-up: Set the SYNC and SPEN bits and clear the CSRC bit. Clear the ANSELx bit for the CK pin (if applicable). Clear the CREN and SREN bits. If interrupts are desired, set the TXIE bit of the PIE1 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 TXREG register. SUMMARY OF REGISTERS ASSOCIATED WITH SYNCHRONOUS SLAVE TRANSMISSION Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 Register on Page ABDOVF RCIDL -- SCKP BRG16 -- WUE ABDEN 245 GIE PEIE TMR0IE INTE IOCIE TMR0IF INTF IOCIF 77 PIE1 TMR1GIE AD1IE RCIE TXIE SSP1IE -- TMR2IE TMR1IE 78 PIR1 TMR1GIF AD1IF RCIF TXIF SSP1IF -- TMR2IF TMR1IF 80 SPEN RX9 SREN CREN ADDEN FERR OERR RX9D 244 TRISB4 -- -- -- -- Name BAUDCON INTCON RCSTA TRISB TRISB7 TRISB6 TXREG TXSTA TRISB5 EUSART Transmit Data Register CSRC TX9 TXEN SYNC SENDB BRGH 112 236* TRMT TX9D 243 Legend: -- = unimplemented location, read as `0'. Shaded cells are not used for synchronous slave transmission. * Page provides register information. 2014 Microchip Technology Inc. DS40001761A-page 259 PIC16LF1554/1559 21.5.2.3 EUSART Synchronous Slave Reception 21.5.2.4 The operation of the Synchronous Master and Slave modes is identical (Section 21.5.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 RCREG register. If the RCIE 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. Synchronous Slave Reception Set-up: Set the SYNC and SPEN bits and clear the CSRC bit. Clear the ANSELx bit for both the CK and DT pins (if applicable). If interrupts are desired, set the RCIE bit of the PIE1 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 RCIF bit will be set when reception is complete. An interrupt will be generated if the RCIE bit was set. If 9-bit mode is enabled, retrieve the Most Significant bit from the RX9D bit of the RCSTA register. Retrieve the eight Least Significant bits from the receive FIFO by reading the RCREG register. If an overrun error occurs, clear the error by either clearing the CREN bit of the RCSTA register or by clearing the SPEN bit which resets the EUSART. TABLE 21-10: SUMMARY OF REGISTERS ASSOCIATED WITH SYNCHRONOUS SLAVE RECEPTION Name Bit 7 Bit 6 ABDOVF GIE PIE1 PIR1 BAUDCON INTCON Bit 2 Bit 1 Bit 0 Register on Page BRG16 -- WUE ABDEN 245 IOCIE TMR0IF INTF IOCIF 77 TXIE SSP1IE -- TMR2IE TMR1IE 78 TXIF SSP1IF -- TMR2IF TMR1IF 80 Bit 5 Bit 4 Bit 3 RCIDL -- SCKP PEIE TMR0IE INTE TMR1GIE AD1IE RCIE TMR1GIF AD1IF RCIF RCREG EUSART Receive Data Register 239* SPEN RX9 SREN CREN ADDEN FERR OERR RX9D 244 TRISB TRISB7 TRISB6 TRISB5 TRISB4 -- -- -- -- 112 TXSTA CSRC TX9 TXEN SYNC SENDB BRGH TRMT TX9D 243 RCSTA Legend: -- = unimplemented location, read as `0'. Shaded cells are not used for synchronous slave reception. * Page provides register information. DS40001761A-page 260 2014 Microchip Technology Inc. PIC16LF1554/1559 22.0 PULSE-WIDTH MODULATION (PWM) MODULE The PWM module generates a pulse-width modulated signal determined by the duty cycle, period, and resolution that are configured by the following registers: * * * * * PR2 T2CON PWMxDCH PWMxDCL PWMxCON Figure 22-1 shows a simplified block diagram of PWM operation. For a step-by-step procedure on how to set up this module for PWM operation, refer to Section 22.1.9 "Setup for PWM Operation Using PWMx Pins". FIGURE 22-1: SIMPLIFIED PWM BLOCK DIAGRAM Rev. 10-000022A 8/5/2013 PWMxDCL<7:6> Duty cycle registers PWMxDCH PWMx_out 10-bit Latch (Not visible to user) To Peripherals PWMxOE R Comparator Q 0 1 S PWMx Q TMR2 Module TMR2 Comparator R PWMxPOL (1) 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. 2014 Microchip Technology Inc. DS40001761A-page 261 PIC16LF1554/1559 22.1 PWMx Pin Configuration All PWM outputs are multiplexed with the PORT data latch. The user must configure the pins as outputs by clearing the associated TRISx bits. Note: 22.1.1 Clearing the PWMxOE bit will relinquish control of the PWMx pin. FUNDAMENTAL OPERATION The PWM module produces a 10-bit resolution output. Timer2 and PR2 set the period of the PWM. The PWMxDCL and PWMxDCH registers configure the duty cycle. The period is common to all PWM modules, whereas the duty cycle is independently controlled. Note: The Timer2 postscaler is not used in the determination of the PWM frequency. The postscaler could be used to have a servo update rate at a different frequency than the PWM output. All PWM outputs associated with Timer2 are set when TMR2 is cleared. Each PWMx is cleared when TMR2 is equal to the value specified in the corresponding PWMxDCH (8 MSb) and PWMxDCL<7:6> (2 LSb) registers. When the value is greater than or equal to PR2, the PWM output is never cleared (100% duty cycle). Note: 22.1.2 The PWMxDCH and PWMxDCL registers are double buffered. The buffers are updated when Timer2 matches PR2. Care should be taken to update both registers before the timer match occurs. PWM OUTPUT POLARITY The output polarity is inverted by setting the PWMxPOL bit of the PWMxCON register. 22.1.3 PWM PERIOD The PWM period is specified by the PR2 register of Timer2. The PWM period can be calculated using the formula of Equation 22-1. EQUATION 22-1: PWM PERIOD When TMR2 is equal to PR2, the following three events occur on the next increment cycle: * TMR2 is cleared * The PWM output is active (Exception: When the PWM duty cycle = 0%, the PWM output will remain inactive.) * The PWMxDCH and PWMxDCL register values are latched into the buffers. Note: 22.1.4 The Timer2 postscaler has no effect on the PWM operation. PWM DUTY CYCLE The PWM duty cycle is specified by writing a 10-bit value to the PWMxDCH and PWMxDCL register pair. The PWMxDCH register contains the eight MSbs and the PWMxDCL<7:6>, the two LSbs. The PWMxDCH and PWMxDCL registers can be written to at any time. Equation 22-2 is used to calculate the PWM pulse width. Equation 22-3 is used to calculate the PWM duty cycle ratio. EQUATION 22-2: PULSE WIDTH Pulse Width = PWMxDCH:PWMxDCL<7:6> T OSC (TMR2 Prescale Value) Note: TOSC = 1/FOSC EQUATION 22-3: DUTY CYCLE RATIO PWMxDCH:PWMxDCL<7:6> Duty Cycle Ratio = ---------------------------------------------------------------------------------4 PR2 + 1 The 8-bit timer TMR2 register is concatenated with the two Least Significant bits of 1/FOSC, adjusted by the Timer2 prescaler to create the 10-bit time base. The system clock is used if the Timer2 prescaler is set to 1:1. Figure 22-2 shows a waveform of the PWM signal when the duty cycle is set for the smallest possible pulse. FIGURE 22-2: PWM OUTPUT PWM Period = PR2 + 1 4 T OSC Q1 (TMR2 Prescale Value) Note: TOSC = 1/FOSC Q2 Q3 Q4 Rev. 10-000023A 7/30/2013 FOSC PWM Pulse Width TMR2 = 0 TMR2 = PWMxDC TMR2 = PR2 DS40001761A-page 262 2014 Microchip Technology Inc. PIC16LF1554/1559 22.1.5 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 22-4. EQUATION 22-4: PWM RESOLUTION log 4 PR2 + 1 Resolution = ------------------------------------------ bits log 2 Note: If the pulse width value is greater than the period the assigned PWM pin(s) will remain unchanged. TABLE 22-1: EXAMPLE PWM FREQUENCIES AND RESOLUTIONS (FOSC = 32 MHz) PWM Frequency Timer Prescale (1, 4, 16) PRx Value Maximum Resolution (bits) TABLE 22-2: Timer Prescale PR2 Value Maximum Resolution (bits) 31.25 kHz 125 kHz 250 kHz 333.3 kHz 16 4 1 1 1 1 0xFF 0xFF 0xFF 0x3F 0x1F 0x17 10 10 10 8 7 6.6 0.31 kHz 4.88 kHz 19.53 kHz 78.12 kHz 156.3 kHz 208.3 kHz 64 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) 22.1.6 7.81 kHz EXAMPLE PWM FREQUENCIES AND RESOLUTIONS (FOSC = 20 MHz) PWM Frequency TABLE 22-3: 1.95 kHz 0.31 kHz 4.90 kHz 19.61 kHz 76.92 kHz 153.85 kHz 200.0 kHz 64 4 1 1 1 1 0x65 0x65 0x65 0x19 0x0C 0x09 8 8 8 6 5 5 OPERATION IN SLEEP MODE 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. 22.1.7 CHANGES IN SYSTEM CLOCK FREQUENCY The PWM frequency is derived from the system clock frequency (FOSC). Any changes in the system clock frequency will result in changes to the PWM frequency. Refer to Section 5.0 "Oscillator Module" for additional details. 22.1.8 EFFECTS OF RESET Any Reset will force all ports to Input mode and the PWM registers to their Reset states. 2014 Microchip Technology Inc. DS40001761A-page 263 PIC16LF1554/1559 22.1.9 SETUP FOR PWM OPERATION USING PWMx PINS The following steps should be taken when configuring the module for PWM operation using the PWMx pins: 1. 2. 3. 4. 5. 6. 7. 8. Disable the PWMx pin output driver(s) by setting the associated TRISx bit(s). Clear the PWMxCON register. Load the PR2 register with the PWM period value. Clear the PWMxDCH register and bits <7:6> of the PWMxDCL register. Configure and start Timer2: * Clear the TMR2IF interrupt flag bit of the PIR1 register. See note below. * Configure the T2CKPS bits of the T2CON register with the Timer2 prescale value. * Enable Timer2 by setting the TMR2ON bit of the T2CON register. Enable PWM output pin and wait until Timer2 overflows, TMR2IF bit of the PIR1 register is set. See note below. Enable the PWMx pin output driver(s) by clearing the associated TRISx bit(s) and setting the PWMxOE bit of the PWMxCON register. Configure the PWM module by loading the PWMxCON register with the appropriate values. Note 1: 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 move Step 8 to replace Step 4. 2: For operation with other peripherals only, disable PWMx pin outputs. DS40001761A-page 264 2014 Microchip Technology Inc. PIC16LF1554/1559 22.2 Register Definitions: PWM Control REGISTER 22-1: PWMxCON: PWM CONTROL REGISTER R/W-0/0 R/W-0/0 R-0/0 R/W-0/0 U-0 U-0 U-0 U-0 PWMxEN PWMxOE 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 PWMxOE: PWM Module Output Enable bit 1 = Output to PWMx pin is enabled 0 = Output to PWMx pin is disabled bit 5 PWMxOUT: PWM Module Output Value bit 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' REGISTER 22-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 PWMxDCH<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 PWMxDCH<7:0>: PWM Duty Cycle Most Significant bits These bits are the MSbs of the PWM duty cycle. The two LSbs are found in the PWMxDCL register. 2014 Microchip Technology Inc. DS40001761A-page 265 PIC16LF1554/1559 REGISTER 22-3: R/W-x/u PWMxDCL: PWM DUTY CYCLE LOW BITS R/W-x/u PWMxDCL<7:6> 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 PWMxDCL<7:6>: PWM Duty Cycle Least Significant bits These bits are the LSbs of the PWM duty cycle. The MSbs are found in the PWMxDCH register. bit 5-0 Unimplemented: Read as `0' TABLE 22-4: Name SUMMARY OF REGISTERS ASSOCIATED WITH PWM Bit 7 Bit 6 PR2 Bit 5 Bit 4 PWM1DCH PWM1DCL Bit 1 Bit 0 -- -- -- -- -- -- -- 266 -- -- -- -- 265 -- -- PWM2CON PWM2EN PWM2OE PWM2OUT PWM2POL PWM2DCH PWM2DCL -- 178* PWM1DCH<7:0> PWM1DCL<7:6> -- -- -- -- T2OUTPS<3:0> TMR2 265 265 PWM2DCH<7:0> PWM2DCL<7:6> Register on Page Bit 2 Timer2 module Period Register PWM1CON PWM1EN PWM1OE PWM1OUT PWM1POL T2CON Bit 3 265 -- TMR2ON -- -- T2CKPS<1:0> Timer2 module Register 266 180 178* TRISA -- -- TRISA5 TRISA4 --(1) TRISA2 TRISA1 TRISA0 108 TRISC TRISC7 TRISC6 TRISC5 TRISC4 TRISC3 TRISC2 TRISC1 TRISC0 116 Legend: * Note 1: - = Unimplemented locations, read as `0', u = unchanged, x = unknown. Shaded cells are not used by the PWM. Page provides register information. Unimplemented, read as `1'. DS40001761A-page 266 2014 Microchip Technology Inc. PIC16LF1554/1559 23.0 IN-CIRCUIT SERIAL PROGRAMMINGTM (ICSPTM) 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 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 "PIC12(L)F1501/PIC16(L)F150X Memory Programming Specification" (DS41573). 23.1 High-Voltage Programming Entry Mode 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. 23.2 Low-Voltage Programming Entry Mode 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 ICSP Low-Voltage Programming Entry mode is enabled. To disable the Low-Voltage ICSP mode, the LVP bit must be programmed to `0'. 23.3 Common Programming Interfaces 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 23-1. FIGURE 23-1: VDD ICD RJ-11 STYLE CONNECTOR INTERFACE ICSPDAT NC 2 4 6 ICSPCLK 1 3 5 Target VPP/MCLR VSS PC Board Bottom Side Pin Description* 1 = VPP/MCLR 2 = VDD Target 3 = VSS (ground) 4 = ICSPDAT 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 23-2. Entry into the Low-Voltage Programming Entry mode requires the following steps: 1. 2. 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 6.5 "MCLR" for more information. The LVP bit can only be reprogrammed to `0' by using the High-Voltage Programming mode. 2014 Microchip Technology Inc. DS40001761A-page 267 PIC16LF1554/1559 FIGURE 23-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 * The 6-pin header (0.100" spacing) accepts 0.025" square pins For additional interface recommendations, refer to your specific device programmer manual prior to PCB design. FIGURE 23-3: 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 23-3 for more information. 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). DS40001761A-page 268 2014 Microchip Technology Inc. PIC16LF1554/1559 24.0 INSTRUCTION SET SUMMARY Each instruction is a 14-bit word containing the operation code (opcode) and all required operands. The opcodes are broken into three broad categories. * Byte Oriented * Bit Oriented * Literal and Control The literal and control category contains the most varied instruction word format. Table 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 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. 24.1 Read-Modify-Write Operations 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. TABLE 24-1: 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 Pre-post increment-decrement mode selection TABLE 24-2: ABBREVIATION DESCRIPTIONS Field PC Program Counter TO Time-Out bit C DC Z PD 2014 Microchip Technology Inc. Description Carry bit Digit Carry bit Zero bit Power-Down bit DS40001761A-page 269 PIC16LF1554/1559 FIGURE 24-1: GENERAL FORMAT FOR INSTRUCTIONS Byte-oriented file register operations 13 8 7 6 OPCODE d f (FILE #) 0 d = 0 for destination W d = 1 for destination f f = 7-bit file register address Bit-oriented file register operations 13 10 9 7 6 OPCODE b (BIT #) f (FILE #) 0 b = 3-bit bit address f = 7-bit file register address Literal and control operations General 13 OPCODE 8 7 0 k (literal) k = 8-bit immediate value CALL and GOTO instructions only 13 11 10 OPCODE 0 k (literal) k = 11-bit immediate value MOVLP instruction only 13 OPCODE 7 6 0 k (literal) k = 7-bit immediate value MOVLB instruction only 13 OPCODE 5 4 0 k (literal) k = 5-bit immediate value BRA instruction only 13 OPCODE 9 8 0 k (literal) k = 9-bit immediate value FSR Offset instructions 13 OPCODE 7 6 n 5 0 k (literal) n = appropriate FSR k = 6-bit immediate value FSR Increment instructions 13 OPCODE 3 2 1 0 n m (mode) n = appropriate FSR m = 2-bit mode value OPCODE only 13 0 OPCODE DS40001761A-page 270 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 24-3: ENHANCED MID-RANGE 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 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 DECFSZ INCFSZ f, d f, d Decrement f, Skip if 0 Increment f, Skip if 0 1(2) 1(2) 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 ADDLW ANDLW IORLW MOVLB MOVLP MOVLW SUBLW XORLW k k k k k k k k 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 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. See Table in the MOVIW and MOVWI instruction descriptions. 00 00 1, 2 1, 2 1011 dfff ffff 1111 dfff ffff BIT-ORIENTED FILE REGISTER OPERATIONS 1 1 00bb bfff ffff 01bb bfff ffff 2 2 01 01 10bb bfff ffff 11bb bfff ffff 1, 2 1, 2 11 11 11 00 11 11 11 11 1110 1001 1000 0000 0001 0000 1100 1010 01 01 BIT-ORIENTED SKIP OPERATIONS 1 (2) 1 (2) LITERAL OPERATIONS 2: 3: 2014 Microchip Technology Inc. 1 1 1 1 1 1 1 1 kkkk kkkk kkkk 001k 1kkk kkkk kkkk kkkk kkkk kkkk kkkk kkkk kkkk kkkk kkkk kkkk C, DC, Z Z Z C, DC, Z Z DS40001761A-page 271 PIC16LF1554/1559 TABLE 24-3: ENHANCED MID-RANGE INSTRUCTION SET (CONTINUED) 14-Bit Opcode Mnemonic, Operands Description Cycles MSb LSb Status Affected Notes CONTROL OPERATIONS 2 2 2 2 2 2 2 2 BRA BRW CALL CALLW GOTO RETFIE RETLW RETURN 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 OPTION RESET SLEEP TRIS - - - - - f Clear Watchdog Timer No Operation Load OPTION_REG register with W Software device Reset Go into Standby 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. 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 00 0000 0000 0000 0000 0000 0000 0110 0000 0110 0000 0110 0110 0100 TO, PD 0000 0010 0001 0011 TO, PD 0fff 1 1 11 00 1 1 11 00 0001 0nkk kkkk 0000 0001 0nmm Z kkkk 1111 0nkk 1nmm Z 0000 0001 kkkk 1 11 1111 1nkk INHERENT OPERATIONS 1 1 1 1 1 1 C-COMPILER OPTIMIZED k[n] Note 1: 2: 3: 2, 3 2 2, 3 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. DS40001761A-page 272 2014 Microchip Technology Inc. PIC16LF1554/1559 24.2 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. 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 ANDWF Syntax: [ label ] ADDLW Syntax: [ label ] ANDWF Operands: 0 f 127 d 0,1 Operation: (W) .AND. (f) (destination) Status Affected: Z 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 k Operands: 0 k 255 Operation: (W) + k (W) Status Affected: C, DC, 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. ADDWF Add W and f f,d Syntax: [ label ] ADDWF Syntax: [ label ] ASRF Operands: 0 f 127 d 0,1 Operands: 0 f 127 d [0,1] Operation: (W) + (f) (destination) Operation: (f<7>) dest<7> (f<7:1>) dest<6:0>, (f<0>) C, f,d 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 ADD W and CARRY bit to f Syntax: [ label ] ADDWFC Operands: 0 f 127 d [0,1] Status Affected: 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} Operation: (W) + (f) + (C) dest 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'. 2014 Microchip Technology Inc. f {,d} DS40001761A-page 273 PIC16LF1554/1559 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<b>) Operation: skip if (f<b>) = 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: Operands: -256 label - PC + 1 255 -256 k 255 0 f 127 0b<7 Operation: skip if (f<b>) = 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<b>) Status Affected: None Description: Bit `b' in register `f' is set. DS40001761A-page 274 f,b 2014 Microchip Technology Inc. PIC16LF1554/1559 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 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 f f,d 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 Operands: None Operation: 00h (W) 1Z Status Affected: Z Description: W register is cleared. Zero bit (Z) is set. 2014 Microchip Technology Inc. DS40001761A-page 275 PIC16LF1554/1559 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] 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'. DS40001761A-page 276 INCF f,d IORWF f,d 2014 Microchip Technology Inc. PIC16LF1554/1559 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'. 2014 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 DS40001761A-page 277 PIC16LF1554/1559 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 Operation: k PCLATH Status Affected: None Description: The 7-bit literal `k' is loaded into the PCLATH register. 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: 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: 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. 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. FSRn is limited to the range 0000h FFFFh. Incrementing/decrementing it beyond these bounds will cause it to wrap-around. MOVLB Move literal to BSR Syntax: [ label ] MOVLB k Operands: 0 k 31 Operation: k BSR Status Affected: None Description: The 5-bit literal `k' is loaded into the Bank Select Register (BSR). DS40001761A-page 278 MOVLW k Operands: Z Predecrement Move literal to PCLATH MOVLW 0x5A After Instruction W = 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: MOVWF OPTION_REG Before Instruction OPTION_REG = W = After Instruction OPTION_REG = W = 0xFF 0x4F 0x4F 0x4F 2014 Microchip Technology Inc. PIC16LF1554/1559 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 Operation: No operation Status Affected: None n [0,1] mm [00,01, 10, 11] -32 k 31 Description: No operation. Words: 1 Cycles: 1 Operands: Operation: Status Affected: 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 None Mode Syntax mm 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. 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. Example: NOP NOP OPTION Load OPTION_REG Register with W Syntax: [ label ] OPTION Operands: None Operation: (W) OPTION_REG Status Affected: None Description: Move data from W register to OPTION_REG register. 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. FSRn is limited to the range 0000h FFFFh. Incrementing/decrementing it beyond these bounds will cause it to wrap-around. The increment/decrement operation on FSRn WILL NOT affect any Status bits. 2014 Microchip Technology Inc. DS40001761A-page 279 PIC16LF1554/1559 RETFIE Return from Interrupt Syntax: [ label ] RETFIE RETURN Return from Subroutine Syntax: [ label ] None RETURN Operands: None Operands: Operation: TOS PC, 1 GIE Operation: TOS PC Status Affected: None Status Affected: None Description: 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. 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. Words: 1 Cycles: 2 Example: RETFIE After Interrupt PC = GIE = TOS 1 RETLW Return with literal in W Syntax: [ label ] Operands: 0 k 255 Operation: k (W); TOS PC 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 RETLW k RLF Rotate Left 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 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'. RLF 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 = DS40001761A-page 280 Words: 1 Cycles: 1 Example: RLF f,d Register f REG1,0 Before Instruction REG1 C After Instruction REG1 W C = = 1110 0110 0 = = = 1110 0110 1100 1100 1 0x07 value of k8 2014 Microchip Technology Inc. PIC16LF1554/1559 SUBLW Subtract W from literal Syntax: [ label ] RRF Rotate Right f through Carry Syntax: [ label ] Operands: 0 f 127 d [0,1] Operands: 0 k 255 Operation: k - (W) W) Operation: See description below Status Affected: C, DC, Z Status Affected: C Description: 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'. The W register is subtracted (2's complement method) from the 8-bit literal `k'. The result is placed in the W register. RRF f,d C Register f SUBLW k C=0 Wk C=1 Wk DC = 0 W<3:0> k<3:0> DC = 1 W<3:0> k<3:0> SLEEP Enter Sleep mode SUBWF Subtract W from f Syntax: [ label ] Syntax: [ label ] Operands: 0 f 127 d [0,1] SLEEP Operands: None 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. The processor is put into Sleep mode with the oscillator stopped. 2014 Microchip Technology Inc. SUBWF f,d Operation: (f) - (W) destination) 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. C=0 Wf C=1 Wf DC = 0 W<3:0> f<3:0> DC = 1 W<3:0> f<3:0> SUBWFB Subtract W from f with Borrow Syntax: SUBWFB Operands: 0 f 127 d [0,1] Operation: (f) - (W) - (B) dest f {,d} 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'. DS40001761A-page 281 PIC16LF1554/1559 SWAPF Swap Nibbles in f XORLW Exclusive OR literal with W Syntax: [ label ] Syntax: [ label ] Operands: 0 f 127 d [0,1] Operands: 0 k 255 (f<3:0>) (destination<7:4>), (f<7:4>) (destination<3:0>) Operation: (W) .XOR. k W) Status Affected: Z Description: The contents of the W register are XOR'ed with the 8-bit literal `k'. The result is placed in the W register. Operation: SWAPF f,d Status Affected: None Description: 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'. TRIS Load TRIS Register with W Syntax: [ label ] TRIS f XORWF XORLW k Exclusive OR W with f Syntax: [ label ] Operands: 0 f 127 d [0,1] XORWF f,d (W) .XOR. (f) destination) Operands: 5f7 Operation: (W) TRIS register `f' Operation: 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: 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'. DS40001761A-page 282 2014 Microchip Technology Inc. PIC16LF1554/1559 25.0 ELECTRICAL SPECIFICATIONS 25.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......................................................................................................................... -0.3V to +4.0V on MCLR pin ..................................................................................................................... -0.3V to +9.0V on all other pins ...................................................................................................... -0.3V to (VDD + 0.3V) Total power dissipation(1) ............................................................................................................................... 800 mW Maximum current out of VSS pin, -40C TA +85C for industrial ......................................................................... 210 mA out of VSS pin, -40C TA +125C for extended ......................................................................... 95 mA into VDD pin, -40C TA +85C for industrial ............................................................................ 150 mA into VDD pin, -40C TA +125C for extended............................................................................ 70 mA Clamp current, IK (VPIN < 0 or VPIN > VDD)20 mA Maximum output current sunk by any I/O pin ......................................................................................................................... 25 mA sourced by any I/O pin .................................................................................................................... 25 mA Power dissipation is calculated as follows: PDIS = VDD x {IDD - IOH} + {(VDD - VOH) x IOH} + (VOl x IOL). Note 1: 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. 25.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) VDDMIN (Fosc 16 MHz) ......................................................................................................... +1.8V VDDMIN (16 MHz < Fosc 32 MHz) ......................................................................................... +2.5V VDDMAX .................................................................................................................................... +3.6V 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 D001 in DC Characteristics: Supply Voltage. 2014 Microchip Technology Inc. DS40001761A-page 283 PIC16LF1554/1559 FIGURE 25-1: PIC16LF1554/1559 VOLTAGE FREQUENCY GRAPH, -40C TA +125C VDD (V) 3.6 2.5 1.8 4 8 12 16 20 24 28 32 Frequency (MHz) Note 1: The shaded region indicates the permissible combinations of voltage and frequency. 2: Refer to Table 25-7 for each Oscillator mode's supported frequencies. DS40001761A-page 284 2014 Microchip Technology Inc. PIC16LF1554/1559 25.3 DC Characteristics TABLE 25-1: SUPPLY VOLTAGE Standard Operating Conditions (unless otherwise stated) Operating temperature -40C TA +85C for industrial -40C TA +125C for extended PIC16LF1554/1559 Param. No. D001 Sym. VDD D002* Characteristic Min. Typ. Max. Units Conditions Supply Voltage (VDDMIN, VDDMAX) VDR D002A* VPOR* 1.8 2.5 -- -- 3.6 3.6 V V FOSC 16 MHz: FOSC 32 MHz RAM Data Retention Voltage(1) 1.5 -- -- V Device in Sleep mode Power-on Reset Release Voltage -- 1.6 -- V D002B* VPORR* Power-on Reset Rearm Voltage -- 0.8 -- V D003 -7 -8 -7 -8 -- -- -- -- 6 6 6 6 % D003C* TCVFVR Temperature Coefficient, Fixed Voltage Reference -- -130 -- ppm/C D003D* VFVR/ VIN Line Regulation, Fixed Voltage Reference -- 0.270 -- %/V D004* VDD Rise Rate to ensure internal Power-on Reset signal 0.05 -- -- V/ms VADFVR Fixed Voltage Reference Voltage for ADC, Initial Accuracy SVDD 1.024V, VDD 2.5V, 85C (Note 2) 1.024V, VDD 2.5V, 125C (Note 2) 2.048V, VDD 2.5V, 85C 2.048V, VDD 2.5V, 125C See Section 6.1 "Power-on Reset (POR)" for details. * 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: This is the limit to which VDD can be lowered in Sleep mode without losing RAM data. 2: For proper operation, the minimum value of the ADC positive voltage reference must be 1.8V or greater. When selecting the FVR or the VREF+ pin as the source of the ADC positive voltage reference, be aware that the voltage must be 1.8V or greater. FIGURE 25-2: POR AND POR REARM WITH SLOW RISING VDD VDD VPOR VPORR VSS NPOR(1) POR REARM VSS TVLOW(2) Note 1: 2: 3: TPOR(3) When NPOR is low, the device is held in Reset. TPOR 1 s typical. TVLOW 2.7 s typical. 2014 Microchip Technology Inc. DS40001761A-page 285 PIC16LF1554/1559 TABLE 25-2: SUPPLY CURRENT (IDD) Standard Operating Conditions (unless otherwise stated) Operating temperature -40C TA +85C for industrial -40C TA +125C for extended PIC16LF1554/1559 Param. No. Device Characteristics Conditions Min. Typ. Max. Units Note VDD Supply Current (IDD)(1, 2) D010 -- 2.5 18 A 1.8 FOSC = 31 kHz LFINTOSC mode -- 4 20 A 3.0 -- 0.35 0.70 mA 1.8 -- 0.5 1.10 mA 3.0 -- 0.5 1.2 mA 1.8 -- 0.75 1.75 mA 3.0 D013 -- 1.4 3.5 mA 3.0 FOSC = 32 MHz HFINTOSC mode with PLL D014 -- 3 17 A 1.8 -- 5 20 A 3.0 FOSC = 32 kHz ECL mode D015 -- 11 40 A 1.8 -- 16 60 A 3.0 D016 -- 23 65 A 1.8 -- 36 100 A 3.0 D017 -- 75 250 A 1.8 -- 120 430 A 3.0 -- 0.65 1.5 mA 3.0 D011 D012 D018 FOSC = 8 MHz HFINTOSC mode FOSC = 16 MHz HFINTOSC mode FOSC = 500 kHz ECL mode FOSC = 1 MHz ECM mode FOSC = 4 MHz ECM mode FOSC = 20 MHz ECH mode Data in "Typ." column is at 25C unless otherwise stated. These parameters are for design guidance only and are not tested. Note 1: The test conditions for all IDD measurements in active operation mode are: CLKIN = external square wave, from rail-to-rail; all I/O pins tri-stated, pulled to VDD; MCLR = VDD; WDT disabled. 2: 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. DS40001761A-page 286 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 25-3: POWER-DOWN CURRENTS (IPD) Standard Operating Conditions (unless otherwise stated) Operating temperature -40C TA +85C for industrial -40C TA +125C for extended PIC16LF1554/1559 Param. No. Device Characteristics Min. Typ. Power-down Base Current (IPD) D020 Max. Max. Units +85C +125C Conditions VDD Note (2) -- 0.02 1.0 8 A 1.8 -- 0.03 2 9 A 3.0 WDT, BOR, FVR, and T1OSC disabled, all Peripherals Inactive LPWDT Current (Note 1) -- 0.24 2 9 A 1.8 -- 0.37 3 10 A 3.0 -- 13 28 30 A 1.8 -- 22 30 33 A 3.0 D023 -- 6.5 17 20 A 3.0 BOR Current (Note 1) D024 -- 0.1 4 10 A 3.0 LPBOR Current ADC Current (Note 1, Note 3), no conversion in progress D021 D022 D025 D026* -- 0.03 3.5 9 A 1.8 -- 0.04 4.0 10 A 3.0 -- 250 -- -- A 1.8 -- 250 -- -- A 3.0 FVR current (Note 1) ADC Current (Note 1, Note 3), conversion in progress * These parameters are characterized but not tested. Data in "Typ." column is at 25C unless otherwise stated. These parameters are for design guidance only and are not tested. Note 1: The peripheral current is the sum of the base IDD or IPD 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. 2: 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 VDD. 3: ADC oscillator source is FRC. 2014 Microchip Technology Inc. DS40001761A-page 287 PIC16LF1554/1559 TABLE 25-4: I/O PORTS DC CHARACTERISTICS Param. No. Sym. VIL D030 D031 D032 VIH D040 D041 D042 IIL D060 D061 IPUR Characteristic D080 VOH D090 D101A* * Note 1: 2: 3: Min. Typ. Max. Units -- -- -- 0.15 VDD 0.2 VDD 0.2 VDD V V V 1.8V VDD 3.6V 2.0V VDD 3.6V -- -- -- -- -- -- -- -- V V V 1.8V VDD 3.6V 2.0V VDD 3.6V 5 125 nA -- 5 50 1000 200 nA nA VSS VPIN VDD, Pin at high-impedance at 85C 125C VSS VPIN VDD at 85C 25 100 200 A VDD = 3.3V, VPIN = VSS -- -- 0.6 V IOL = 6mA, VDD = 3.3V IOL = 1.8mA, VDD = 1.8V VDD - 0.7 -- -- V IOH = 3mA, VDD = 3.3V IOH = 1mA, VDD = 1.8V Input Low Voltage I/O PORT: with TTL buffer -- with Schmitt Trigger buffer -- MCLR -- Input High Voltage I/O ports: with TTL buffer 0.25 VDD + 0.8 with Schmitt Trigger buffer 0.8 VDD MCLR 0.8 VDD Input Leakage Current(1) I/O ports -- MCLR(2) Weak Pull-up Current D070* VOL Standard Operating Conditions (unless otherwise stated) Operating temperature -40C TA +85C for industrial -40C TA +125C for extended Output Low Voltage(3) I/O ports Output High Voltage(3) I/O ports Conditions Capacitive Loading Specs on Output Pins CIO All I/O pins -- -- 50 pF 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. Negative current is defined as current sourced by the pin. 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. Including OSC2 in CLKOUT mode. DS40001761A-page 288 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 25-5: MEMORY PROGRAMMING SPECIFICATIONS Standard Operating Conditions (unless otherwise stated) Operating temperature -40C TA +125C DC CHARACTERISTICS Param. No. Sym. Characteristic Min. Typ. Max. Units 8.0 -- 9.0 V Conditions Program Memory Programming Specifications D110 VIHH Voltage on MCLR/VPP pin D111 IDDP Supply Current during Programming -- -- 10 mA D112 VBE VDD for Bulk Erase 2.7 -- VDDMAX V D113 VPEW VDD for Write or Row Erase VDDMIN -- VDDMAX V D114 IPPPGM Current on MCLR/VPP during Erase/Write -- -- 1.0 mA D115 IDDPGM Current on VDD during Erase/Write -- -- 5.0 mA D121 EP Cell Endurance 10K -- -- E/W (Note 2) Program Flash Memory -40C to +85C (Note 1) D122 VPRW VDD for Read/Write VDDMIN -- VDDMAX V D123 TIW Self-timed Write Cycle Time -- 2 2.5 ms D124 TRETD Characteristic Retention -- 40 -- Year Provided no other specifications are violated D125 EHEFC High-Endurance Flash Cell 100K -- -- E/W 0C to +60C, Lower byte, Last 128 Addresses in Flash Memory 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: Self-write and Block Erase. 2: Required only if single-supply programming is disabled. 2014 Microchip Technology Inc. DS40001761A-page 289 PIC16LF1554/1559 TABLE 25-6: THERMAL CHARACTERISTICS Standard Operating Conditions (unless otherwise stated) Operating temperature -40C TA +125C Param. No. TH01 TH02 Sym. JA JC TH03 TJMAX TH04 PD TH05 Characteristic Thermal Resistance Junction to Ambient Thermal Resistance Junction to Case Maximum Junction Temperature Power Dissipation PINTERNAL Internal Power Dissipation Typ. Units Conditions 70.0 C/W 14-pin PDIP package 95.3 C/W 14-pin SOIC package 100.0 C/W 14-pin TSSOP package 45.7 C/W 16-pin QFN (4x4x0.9 mm) package 62.2 C/W 20-pin PDIP package 87.3 C/W 20-pin SSOP package 43.0 C/W 20-pin QFN package 32.8 C/W 14-pin PDIP package 31.0 C/W 14-pin SOIC package 24.4 C/W 14-pin TSSOP package 6.3 C/W 16-pin QFN (4x4x0.9 mm) package 27.5 C/W 20-pin PDIP package 31.1 C/W 20-pin SSOP package 5.3 C/W 20-pin QFN package 150 C -- 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. DS40001761A-page 290 2014 Microchip Technology Inc. PIC16LF1554/1559 25.4 AC Characteristics Timing Parameter Symbology has been created with one of the following formats: 1. TppS2ppS 2. TppS T F Frequency Lowercase letters (pp) and their meanings: pp cc CCP1 ck CLKOUT cs CS di SDIx do SDO dt Data in io I/O PORT mc MCLR Uppercase letters and their meanings: S F Fall H High I Invalid (High-impedance) L Low FIGURE 25-3: T Time osc rd rw sc ss t0 t1 wr CLKIN RD RD or WR SCKx SS T0CKI T1CKI WR P R V Z Period Rise Valid High-impedance LOAD CONDITIONS Load Condition Pin CL VSS Legend: CL = 50 pF for all pins FIGURE 25-4: CLOCK TIMING Q4 Q1 Q2 Q3 Q4 Q1 CLKIN OS02 OS12 OS11 OS03 CLKOUT (CLKOUT mode) Note: See Table 25-9. 2014 Microchip Technology Inc. DS40001761A-page 291 PIC16LF1554/1559 TABLE 25-7: CLOCK OSCILLATOR TIMING REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Operating temperature -40C TA +125C Param. Sym. No. OS01 Characteristic FOSC External CLKIN Frequency(1) Min. Typ. Max. Units Conditions DC -- 0.5 MHz EC Oscillator mode (low) DC -- 4 MHz EC Oscillator mode (medium) EC Oscillator mode (high) DC -- 20 MHz OS02 TOSC External CLKIN Period(1) 50 -- ns EC mode OS03 TCY Instruction Cycle Time(1) 200 -- DC ns TCY = FOSC/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. Note 1: 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 CLKIN pin. When an external clock input is used, the "max" cycle time limit is "DC" (no clock) for all devices. TABLE 25-8: OSCILLATOR PARAMETERS Standard Operating Conditions (unless otherwise stated) Operating Temperature -40C TA +125C Param. No. Sym. Characteristic Min. Typ. Max. Units Conditions MHz 0C TA +85C OS08 HFOSC Internal Calibrated HFINTOSC Frequency(1) -- 16.0 -- OS08A HFTOL Frequency Tolerance -- 3 -- % 25C, 16 MHz -- 6 -- % 0C TA +85C, 16 MHZ -- 31 -- kHz -- 5 8 s OS09 LFOSC OS10* TIOSC ST HFINTOSC Wake-up from Sleep Start-up Time Internal LFINTOSC Frequency -40C TA +125C * 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: 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. DS40001761A-page 292 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 25-5: CLKOUT AND I/O TIMING Cycle Write Fetch Q1 Q4 Read Execute Q2 Q3 FOSC OS12 OS11 OS20 OS21 CLKOUT OS19 OS18 OS16 OS13 OS17 I/O pin (Input) OS14 OS15 I/O pin (Output) New Value Old Value OS18, OS19 TABLE 25-9: CLKOUT AND I/O TIMING PARAMETERS Standard Operating Conditions (unless otherwise stated) Operating Temperature -40C TA +125C Param. No. Sym. Characteristic FOSC to CLKOUT (1) OS11 TosH2ckL OS12 TosH2ckH FOSC to CLKOUT OS13 TckL2ioV (1) CLKOUT to Port out valid(1) (1) Min. Typ. Max. Units Conditions -- -- 70 ns VDD = 3.3-3.6V -- -- 72 ns VDD = 3.3-3.6V -- -- 20 ns OS14 TioV2ckH Port input valid before CLKOUT TOSC + 200 ns -- -- ns OS15 TosH2ioV Fosc (Q1 cycle) to Port out valid -- 50 70* ns VDD = 3.3-3.6V OS16 TosH2ioI Fosc (Q2 cycle) to Port input invalid (I/O in hold time) 50 -- -- ns VDD = 3.3-3.6V OS17 TioV2osH Port input valid to Fosc(Q2 cycle) (I/O in setup time) 20 -- -- ns OS18* TioR Port output rise time -- 15 32 ns VDD = 2.0V VDD = 2.0V OS19* TioF Port output fall time -- 28 55 ns OS20* Tinp INT pin input high or low time 25 -- -- ns OS21* Tioc Interrupt-on-change new input level time 25 -- -- ns * These parameters are characterized but not tested. Data in "Typ." column is at 3.0V, 25C unless otherwise stated. Note 1: Measurements are taken in EC mode where CLKOUT output is 4 x TOSC. 2014 Microchip Technology Inc. DS40001761A-page 293 PIC16LF1554/1559 FIGURE 25-6: RESET, WATCHDOG TIMER AND POWER-UP TIMER TIMING VDD MCLR 30 Internal POR 33 PWRT Time-out Internal Reset(1) Watchdog Timer Reset(1) 31 34 34 I/O pins Note 1: Asserted low. FIGURE 25-7: BROWN-OUT RESET TIMING AND CHARACTERISTICS VDD VBOR and VHYST VBOR (Device in Brown-out Reset) (Device not in Brown-out Reset) 37 Reset (due to BOR) Note 1: 33(1) 64 ms delay only if PWRTE bit in the Configuration Words is programmed to `0'. 2 ms delay if PWRTE = 0. DS40001761A-page 294 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 25-10: RESET, WATCHDOG TIMER, POWER-UP TIMER AND BROWN-OUT RESET PARAMETERS Standard Operating Conditions (unless otherwise stated) Operating Temperature -40C TA +125C Param. No. Sym. Characteristic Min. Typ. Max. Units Conditions 2 5 -- -- -- -- s s -40C to +85C +85C to +125C TWDTLP Low-Power Watchdog Timer Time-out Period 10 16 27 ms VDD = 3.3V-3.6V, 1:16 Prescaler used 33* TPWRT Power-up Timer Period, PWRTE = 0 40 65 140 ms 34* TIOZ I/O high-impedance from MCLR Low or Watchdog Timer Reset -- -- 2.0 s 35 VBOR Brown-out Reset Voltage(1) 2.55 1.80 2.70 1.90 2.85 2.05 V V 36* VHYST Brown-out Reset Hysteresis 0 25 50 mV -40C to +85C 37* TBORDC Brown-out Reset DC Response Time 1 3 5 s VDD VBOR 30 TMCL 31 MCLR Pulse Width (low) BORV = 0 BORV = 1 * 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: 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. FIGURE 25-8: TIMER0 EXTERNAL CLOCK TIMINGS T0CKI 40 41 42 T1CKI 45 46 47 49 TMR0 2014 Microchip Technology Inc. DS40001761A-page 295 PIC16LF1554/1559 TABLE 25-11: TIMER0 AND TIMER1 EXTERNAL CLOCK REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Param. No. Sym. Characteristic 40* TT0H T0CKI High Pulse Width No Prescaler 41* TT0L T0CKI Low Pulse Width No Prescaler Min. Typ. Max. Units 0.5 TCY + 20 -- -- ns ns With Prescaler 10 -- -- 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 Time Synchronous, No Prescaler 0.5 TCY + 20 -- -- ns Synchronous, with Prescaler 15 -- -- ns Asynchronous TT1L 46* TT1P 47* 48* T1CKI Low Time T1CKI Input Period 30 -- -- ns Synchronous, No Prescaler 0.5 TCY + 20 -- -- ns Synchronous, with Prescaler 15 -- -- ns Asynchronous 30 -- -- ns Synchronous Greater of: 30 or TCY + 40 N -- -- ns Asynchronous 60 -- -- ns 2 TOSC -- 7 TOSC -- TCKEZTMR1 Delay from External Clock Edge to Timer Increment * 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. TABLE 25-12: PIC16LF1554/1559 ANALOG-TO-DIGITAL CONVERTER (ADC) CHARACTERISTICS(1,2,3) Standard Operating Conditions (unless otherwise stated) Operating temperature Tested at 25C Param. Sym. No. Characteristic Min. Typ. Max. Units Conditions AD01 NR Resolution -- -- 10 bit AD02 EIL Integral Error -- 0.5 1 LSb -40C to +85C, VREF 2.0V AD03 EDL Differential Error -- 0.4 1 LSb -40C to +85C, VREF 2.0V AD04 EOFF Offset Error -- 0.4 2 LSb -40C to +85C, VREF 2.0V AD05 EGN -- 0.3 2 LSb -40C to +85C, VREF 2.0V AD06 VREF Reference Voltage Range (VREFH - VREFL) 1.8 2.0 -- -- -- -- V V AD07 VAIN Full-Scale Range VSS -- VREF V AD08 ZAIN Recommended Impedance of Analog Voltage Source -- -- 3 k * Note 1: 2: 3: 4: Gain Error Absolute Minimum (Note 4) Minimum for 1LSb Accuracy Can go higher if external 0.01F capacitor is present on input pin. 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. Total Absolute Error includes integral, differential, offset and gain errors. The ADC conversion result never decreases with an increase in the input voltage and has no missing codes. When ADC is off, it will not consume any current other than leakage current. The power-down current specification includes any such leakage from the ADC module. ADC VREF is selected by ADPREF<1:0> bits. DS40001761A-page 296 2014 Microchip Technology Inc. PIC16LF1554/1559 TABLE 25-13: PIC16LF1554/1559 ADC CONVERSION REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Operating temperature -40C TA +125C Param. Sym. No. AD130* TAD AD131 TCNV AD132* TACQ Characteristic Min. Typ. Max. Units Conditions ADC Clock Period 0.7 0.7 -- -- 25 8 s s TOSC-based, -40C to +85C TOSC-based, +85C to +125C ADC Internal FRC Oscillator Period 1.0 1.6 6.0 s ADCS<1:0> = 11 (ADFRC mode) Conversion Time (not including Acquisition Time)(1) -- 11 -- TAD Set GO/DONEx bit to conversion complete Acquisition Time -- 5.0 -- s * 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: The ADRES register may be read on the following TCY cycle. FIGURE 25-9: PIC16LF1554/1559 ADC CONVERSION TIMING (NORMAL MODE) BSF ADCON0, GO AD134 1 TCY (TOSC/2(1)) AD131 Q4 AD130 ADC CLK(1) 9 ADC Data 8 7 6 3 OLD_DATA ADRES 1 0 NEW_DATA 1 TCY ADxIF GO Sample 2 DONE AD132 Sampling Stopped Note 1: If the ADC clock source is selected as FRC, a time of TCY is added before the ADC clock starts. This allows the SLEEP instruction to be executed. 2014 Microchip Technology Inc. DS40001761A-page 297 PIC16LF1554/1559 FIGURE 25-10: PIC16LF1554/1559 ADC CONVERSION TIMING (SLEEP MODE) BSF ADCON0, GO AD134 (TOSC/2 + TCY(1)) 1 TCY AD131 Q4 AD130 ADC CLK 9 ADC Data 8 7 6 OLD_DATA ADRES 3 2 1 0 NEW_DATA ADxIF 1 TCY GO DONE Sample AD132 Sampling Stopped Note 1: If the ADC clock source is selected as FRC, a time of TCY is added before the ADC clock starts. This allows the SLEEP instruction to be executed. DS40001761A-page 298 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 25-11: USART SYNCHRONOUS TRANSMISSION (MASTER/SLAVE) TIMING CK US121 US121 DT US122 US120 Refer to Figure 25-3 for Load conditions. Note: TABLE 25-14: USART SYNCHRONOUS TRANSMISSION REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Param. No. Symbol US120 TCKH2DTV US121 US122 TCKRF TDTRF FIGURE 25-12: Characteristic Min. Max. Units Conditions SYNC XMIT (Master and Slave) Clock high to data-out valid -- 80 ns 3.0V VDD 3.3V -- 100 ns 1.8V VDD 3.3V Clock out rise time and fall time (Master mode) -- 45 ns 3.0V VDD 3.3V -- 50 ns 1.8V VDD 3.3V Data-out rise time and fall time -- 45 ns 3.0V VDD 3.3V -- 50 ns 1.8V VDD 3.3V USART SYNCHRONOUS RECEIVE (MASTER/SLAVE) TIMING CK US125 DT US126 Note: Refer to Figure 25-3 for Load conditions. TABLE 25-15: USART SYNCHRONOUS RECEIVE REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Param. No. Symbol Characteristic US125 TDTV2CKL SYNC RCV (Master and Slave) Data-hold before CK (DT hold time) US126 TCKL2DTL Data-hold after CK (DT hold time) 2014 Microchip Technology Inc. Min. Max. Units 10 -- ns 15 -- ns Conditions DS40001761A-page 299 PIC16LF1554/1559 FIGURE 25-13: 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 25-3 for Load conditions. FIGURE 25-14: SPI MASTER MODE TIMING (CKE = 1, SMP = 1) SS SP81 SCK (CKP = 0) SP71 SP72 SP79 SP73 SCK (CKP = 1) SP80 MSb SDO bit 6 - - - - - -1 SP78 LSb SP75, SP76 SDI MSb In bit 6 - - - -1 LSb In SP74 Note: Refer to Figure 25-3 for Load conditions. DS40001761A-page 300 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 25-15: SPI SLAVE MODE TIMING (CKE = 0) SS SP70 SCK (CKP = 0) SP83 SP71 SP72 SP78 SP79 SCK (CKP = 1) SP79 SP78 SP80 MSb SDO LSb bit 6 - - - - - -1 SP77 SP75, SP76 SDI MSb In bit 6 - - - -1 LSb In SP74 SP73 Note: Refer to Figure 25-3 for Load conditions. FIGURE 25-16: 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 Note: Refer to Figure 25-3 for Load conditions. 2014 Microchip Technology Inc. DS40001761A-page 301 PIC16LF1554/1559 TABLE 25-16: SPI MODE REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Param. No. Symbol Characteristic SP70* TSSL2SCH, TSSL2SCL SS to SCK or SCK input SP71* TSCH Min. Typ. Max. Units Conditions 2.25 TCY -- -- ns SCK input high time (Slave mode) 1 TCY + 20 -- -- ns SP72* TSCL SCK input low time (Slave mode) 1 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 SP76* TDOF SDO data output fall time -- 10 25 ns 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 SP79* TSCF SCK output fall time (Master mode) -- 10 25 ns SP80* TSCH2DOV, TSCL2DOV SDO data output valid after SCK edge -- -- 50 ns 3.0V VDD 5.5V -- -- 145 ns 1.8V VDD 5.5V 1 Tcy -- -- ns -- -- 50 ns 1.5 TCY + 40 -- -- ns SP81* TDOV2SCH, SDO data output setup to SCK TDOV2SCL edge SP82* TSSL2DOV SDO data output valid after SS edge SP83* TSCH2SSH, TSCL2SSH SS after SCK edge * 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. DS40001761A-page 302 2014 Microchip Technology Inc. PIC16LF1554/1559 FIGURE 25-17: I2CTM BUS START/STOP BITS TIMING SCL SP93 SP91 SP90 SP92 SDA Stop Condition Start Condition Note: Refer to Figure 25-3 for Load conditions. TABLE 25-17: I2CTM BUS START/STOP BITS REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Param. No. Symbol SP90* TSU:STA SP91* THD:STA SP92* TSU:STO SP93 THD:STO Stop condition Characteristic Start condition 100 kHz mode 4700 Typ. Max. Units -- -- 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 Hold time * Min. 400 kHz mode 600 -- -- 100 kHz mode 4000 -- -- 400 kHz mode 600 -- -- Conditions ns Only relevant for Repeated Start condition ns After this period, the first clock pulse is generated ns ns These parameters are characterized but not tested. FIGURE 25-18: I2CTM BUS DATA TIMING SP103 SCL SP90 SP100 SP102 SP101 SP106 SP107 SP91 SDA In SP92 SP110 SP109 SP109 SDA Out Note: Refer to Figure 25-3 for Load conditions. 2014 Microchip Technology Inc. DS40001761A-page 303 PIC16LF1554/1559 TABLE 25-18: I2CTM BUS DATA REQUIREMENTS Standard Operating Conditions (unless otherwise stated) Param. No. Symbol SP100* THIGH Characteristic Clock high time Min. Max. Units Conditions 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 1.5TCY -- SSP module SP101* TLOW Clock low time SSP module SP102* SP103* TR TF SDA and SCL rise time 100 kHz mode -- 1000 ns 400 kHz mode 20 + 0.1CB 300 ns SDA and SCL fall time 100 kHz mode -- 250 ns 400 kHz mode 20 + 0.1CB 250 ns 0 -- ns SP106* THD:DAT Data input hold time 100 kHz mode 400 kHz mode 0 0.9 s SP107* TSU:DAT Data input setup time 100 kHz mode 250 -- ns 400 kHz mode 100 -- ns SP109* TAA Output valid from clock 100 kHz mode -- 3500 ns 400 kHz mode -- -- ns SP110* TBUF Bus free time 100 kHz mode 4.7 -- s 400 kHz mode 1.3 -- s -- 400 pF SP111 * Note 1: 2: CB Bus capacitive loading 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 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) I2CTM 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. DS40001761A-page 304 2014 Microchip Technology Inc. PIC16LF1554/1559 26.0 DC AND AC CHARACTERISTICS GRAPHS AND CHARTS Graphs and charts are not available at this time. 2014 Microchip Technology Inc. DS40001761A-page 305 PIC16LF1554/1559 27.0 DEVELOPMENT SUPPORT 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 * 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 27.1 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 DS40001761A-page 306 2014 Microchip Technology Inc. PIC16LF1554/1559 27.2 MPLAB XC Compilers 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 27.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: 27.4 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 27.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 2014 Microchip Technology Inc. DS40001761A-page 307 PIC16LF1554/1559 27.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. 27.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 upgradable 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. DS40001761A-page 308 27.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. 27.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). 27.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. 2014 Microchip Technology Inc. PIC16LF1554/1559 27.11 Demonstration/Development Boards, Evaluation Kits, and Starter Kits 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. 27.12 Third-Party Development Tools 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, 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. 2014 Microchip Technology Inc. DS40001761A-page 309 PIC16LF1554/1559 28.0 PACKAGING INFORMATION 28.1 Package Marking Information 14-Lead PDIP (300 mil) Example PIC16LF1554 -I/P e3 1405017 28-Lead SOIC (7.50 mm) 14-Lead SOIC (3.90 mm) Example Example PIC16LF1554 -I/SL e3 1405017 Legend: XX...X Y YY WW NNN e3 * Note: DS40001761A-page 310 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. 2014 Microchip Technology Inc. PIC16LF1554/1559 Package Marking Information (Continued) 14-Lead TSSOP (4.4 mm) Example XXXXXXXX YYWW NNN 16LF1554 1405 017 16-Lead QFN (4x4x0.9 mm) PIN 1 Example PIN 1 PIC16 LF1554 -I/ML 140517 e3 Legend: XX...X Y YY WW NNN e3 * 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. 2014 Microchip Technology Inc. DS40001761A-page 311 PIC16LF1554/1559 Package Marking Information (Continued) 20-Lead PDIP (300 mil) XXXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXX YYWWNNN 20-Lead SSOP (5.30 mm) Example PIC16LF1559 -E/P e3 1120123 Example PIC16LF1559 -I/SS e3 1120123 Legend: XX...X Y YY WW NNN e3 * Note: DS40001761A-page 312 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. 2014 Microchip Technology Inc. PIC16LF1554/1559 Package Marking Information (Continued) 20-Lead QFN (4x4x0.9 mm) PIN 1 Example PIN 1 Legend: XX...X Y YY WW NNN e3 * Note: PIC16 LF1559 -E/ML 405017 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. 2014 Microchip Technology Inc. DS40001761A-page 313 PIC16LF1554/1559 28.2 Package Details The following sections give the technical details of the packages. 4 & ' !&" & 5# *!( !!& 5 %& &#& && 366***' '6 5 N NOTE 1 E1 1 3 2 D E A2 A L A1 c b1 b e eB 7&! '! :'&! 8"') %! 8,9. 8 8 & < & & 8; 2, = = 1 - 1 2!& & 1 = = . - -1 ##5 "# & 5!! "# >#& ##5>#& . 1 ? ; :& -1 1 1 : 1 - 1 ? 1 ) 1 @ ) ? 2 = = & & :# 7 5!! :#>#& : * :#>#& ; * + - !"#$%&" ' ()"&'"!&) &#*& & & # +%&, & !& - '! !#.# &"#' #%! & "! ! #%! & "! !! &$#/ !# '! #& .01 2,32!'! &$&"! **& "&& ! DS40001761A-page 314 * ,12 2014 Microchip Technology Inc. PIC16LF1554/1559 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2014 Microchip Technology Inc. DS40001761A-page 315 PIC16LF1554/1559 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging DS40001761A-page 316 2014 Microchip Technology Inc. PIC16LF1554/1559 4 & ' !&" & 5# *!( !!& 5 %& &#& && 366***' '6 5 2014 Microchip Technology Inc. DS40001761A-page 317 PIC16LF1554/1559 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging DS40001761A-page 318 2014 Microchip Technology Inc. PIC16LF1554/1559 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2014 Microchip Technology Inc. DS40001761A-page 319 PIC16LF1554/1559 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging DS40001761A-page 320 2014 Microchip Technology Inc. PIC16LF1554/1559 ! " # $ %& ' (()* "# 4 & ' !&" & 5# *!( !!& 5 %& &#& && 366***' '6 5 D2 D EXPOSED PAD e E2 E 2 2 1 1 b TOP VIEW K N N NOTE 1 L BOTTOM VIEW A3 A A1 7&! '! :'&! 8"') %! ::. . 8 8 8; < @ & ; 9 & ? &# %% 1 , && 5!! - ; >#& . .$ . !##>#& ; :& .$ !##:& @12, .4 2, 1 @1 ? 2, 1 @1 , &&>#& ) 1 - -1 , &&:& : - 1 , &&& .$ !## X = !"#$%&" ' ()"&'"!&) &#*& & & # 5!!*!"&# - '! #& .01 2,3 2!'! &$&"! **& "&& ! .43 % '! ("!"*& "&& (% % '& " !! 2014 Microchip Technology Inc. ? = * ,2 DS40001761A-page 321 PIC16LF1554/1559 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging DS40001761A-page 322 2014 Microchip Technology Inc. PIC16LF1554/1559 + 4 & ' !&" & 5# *!( !!& 5 %& &#& && 366***' '6 5 N E1 NOTE 1 1 2 3 D E A2 A L c A1 b1 eB e b 7&! '! :'&! 8"') %! 8,9. 8 8 & < & & 8; 2, = = 1 - 1 2!& & 1 = = . - - -1 ##5 "# & 5!! "# >#& ##5>#& . 1 ? ; :& ? - @ : 1 - 1 ? 1 ) 1 @ ) ? 2 = = & & :# 7 5!! :#>#& : * :#>#& ; * + - !"#$%&" ' ()"&'"!&) &#*& & & # +%&, & !& - '! !#.# &"#' #%! & "! ! #%! & "! !! &$#/ !# '! #& .01 2,3 2!'! &$&"! **& "&& ! 2014 Microchip Technology Inc. * ,2 DS40001761A-page 323 PIC16LF1554/1559 + ,-.% , / ,, 0) ,,/ 4 & ' !&" & 5# *!( !!& 5 %& &#& && 366***' '6 5 D N E E1 NOTE 1 1 2 e b c A2 A A1 L1 7&! '! :'&! 8"') %! L ::. . 8 8 8; < & ; 9 & = = @1 1 ?1 &# %% 1 = = ; >#& . ? ? ##5>#& . 1 1- 1@ ; :& @ 1 11 1 1 ##5 5!! 4 &:& : 4 & & : :# 4 5!! & :#>#& @12, 1.4 = Y Y 1 ?Y ) = -? !"#$%&" ' ()"&'"!&) &#*& & & # '! !#.# &"#' #%! & "! ! #%! & "! !! &$#'' !# - '! #& .01 2,3 2!'! &$&"! **& "&& ! .43 % '! ("!"*& "&& (% % '& " !! DS40001761A-page 324 * ,2 2014 Microchip Technology Inc. PIC16LF1554/1559 Note: For the most current package drawings, please see the Microchip Packaging Specification located at http://www.microchip.com/packaging 2014 Microchip Technology Inc. DS40001761A-page 325 PIC16LF1554/1559 + " # $ %& ' (()* "# 4 & ' !&" & 5# *!( !!& 5 %& &#& && 366***' '6 5 D D2 EXPOSED PAD e E2 2 E b 2 1 1 K N N NOTE 1 TOP VIEW L BOTTOM VIEW A A1 A3 7&! '! :'&! 8"') %! ::. . 8 8 8; < & ; 9 & ? &# %% 1 , && 5!! - ; >#& . .$ . !##>#& ; :& .$ !##:& 12, .4 2, @ ? 2, @ ? , &&>#& ) ? 1 - , &&:& : - 1 X = = , &&& .$ !## !"#$%&" ' ()"&'"!&) &#*& & & # 5!!*!"&# - '! #& .01 2,3 2!'! &$&"! **& "&& ! .43 % '! ("!"*& "&& (% % '& " !! DS40001761A-page 326 * ,@2 2014 Microchip Technology Inc. PIC16LF1554/1559 4 & ' !&" & 5# *!( !!& 5 %& &#& && 366***' '6 5 2014 Microchip Technology Inc. DS40001761A-page 327 PIC16LF1554/1559 APPENDIX A: DATA SHEET REVISION HISTORY Revision A (07/2014) Initial release of the document. DS40001761A-page 328 2014 Microchip Technology Inc. PIC16LF1554/1559 THE MICROCHIP WEB SITE CUSTOMER SUPPORT Microchip provides online support via our WWW site at www.microchip.com. This web site is used as a means to make files and information easily available to customers. Accessible by using your favorite Internet browser, the web site 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 web site at: http://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 web site at www.microchip.com. Under "Support", click on "Customer Change Notification" and follow the registration instructions. 2014 Microchip Technology Inc. DS40001761A-page 329 PIC16LF1554/1559 PRODUCT IDENTIFICATION SYSTEM To order or obtain information, e.g., on pricing or delivery, refer to the factory or the listed sales office. PART NO. [X](1) /XX XXX Device Tape and Reel Option Package Pattern Examples: a) b) Device: PIC16LF1554, PIC16LF1559. Tape and Reel Option: Blank T Package:(2) P SL ST ML SS Pattern: QTP, SQTP, Code or Special Requirements (blank otherwise) DS40001761A-page 330 c) PIC16LF1559T/SS Tape and Reel, SOIC package PIC16LF1554/P PDIP package PIC16LF1559/ML 298 QFN package = Standard packaging (tube or tray) = Tape and Reel(1) = = = = = Plastic DIP SOIC TSSOP QFN SSOP Note 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. For other small form-factor package availability and marking information, please visit www.microchip.com/packaging or contact your local sales office. 2014 Microchip Technology Inc. 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. Trademarks The Microchip name and logo, the Microchip logo, dsPIC, FlashFlex, flexPWR, JukeBlox, KEELOQ, KEELOQ logo, Kleer, LANCheck, MediaLB, MOST, MOST logo, MPLAB, OptoLyzer, PIC, PICSTART, PIC32 logo, RightTouch, SpyNIC, SST, SST Logo, SuperFlash and UNI/O are registered trademarks of Microchip Technology Incorporated in the U.S.A. and other countries. The Embedded Control Solutions Company and mTouch are registered trademarks of Microchip Technology Incorporated in the U.S.A. Analog-for-the-Digital Age, BodyCom, chipKIT, chipKIT logo, CodeGuard, dsPICDEM, dsPICDEM.net, ECAN, In-Circuit Serial Programming, ICSP, Inter-Chip Connectivity, KleerNet, KleerNet logo, MiWi, MPASM, MPF, MPLAB Certified logo, MPLIB, MPLINK, MultiTRAK, NetDetach, Omniscient Code Generation, PICDEM, PICDEM.net, PICkit, PICtail, RightTouch logo, REAL ICE, SQI, Serial Quad I/O, 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 trademarks 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) 2014, Microchip Technology Incorporated, Printed in the U.S.A., All Rights Reserved. ISBN: 978-1-63276-372-3 QUALITY MANAGEMENT SYSTEM CERTIFIED BY DNV == ISO/TS 16949 == 2014 Microchip Technology Inc. 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. DS40001761A-page 331 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 Hong Kong Tel: 852-2943-5100 Fax: 852-2401-3431 India - Bangalore Tel: 91-80-3090-4444 Fax: 91-80-3090-4123 Austria - Wels Tel: 43-7242-2244-39 Fax: 43-7242-2244-393 Denmark - Copenhagen Tel: 45-4450-2828 Fax: 45-4485-2829 Australia - Sydney Tel: 61-2-9868-6733 Fax: 61-2-9868-6755 Atlanta Duluth, GA Tel: 678-957-9614 Fax: 678-957-1455 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 Chicago Itasca, IL Tel: 630-285-0071 Fax: 630-285-0075 Cleveland Independence, OH Tel: 216-447-0464 Fax: 216-447-0643 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 Los Angeles Mission Viejo, CA Tel: 949-462-9523 Fax: 949-462-9608 New York, NY Tel: 631-435-6000 San Jose, CA Tel: 408-735-9110 Canada - Toronto Tel: 905-673-0699 Fax: 905-673-6509 DS40001761A-page 332 China - Chongqing Tel: 86-23-8980-9588 Fax: 86-23-8980-9500 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-5407-5533 Fax: 86-21-5407-5066 China - Shenyang Tel: 86-24-2334-2829 Fax: 86-24-2334-2393 China - Shenzhen Tel: 86-755-8864-2200 Fax: 86-755-8203-1760 China - Wuhan Tel: 86-27-5980-5300 Fax: 86-27-5980-5118 China - Xian Tel: 86-29-8833-7252 Fax: 86-29-8833-7256 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 France - Paris Tel: 33-1-69-53-63-20 Fax: 33-1-69-30-90-79 Germany - Dusseldorf Tel: 49-2129-3766400 Japan - Tokyo Tel: 81-3-6880- 3770 Fax: 81-3-6880-3771 Germany - Munich Tel: 49-89-627-144-0 Fax: 49-89-627-144-44 Korea - Daegu Tel: 82-53-744-4301 Fax: 82-53-744-4302 Germany - Pforzheim Tel: 49-7231-424750 Korea - Seoul Tel: 82-2-554-7200 Fax: 82-2-558-5932 or 82-2-558-5934 Italy - Milan Tel: 39-0331-742611 Fax: 39-0331-466781 Italy - Venice Tel: 39-049-7625286 Malaysia - Kuala Lumpur Tel: 60-3-6201-9857 Fax: 60-3-6201-9859 Netherlands - Drunen Tel: 31-416-690399 Fax: 31-416-690340 Malaysia - Penang Tel: 60-4-227-8870 Fax: 60-4-227-4068 Poland - Warsaw Tel: 48-22-3325737 Philippines - Manila Tel: 63-2-634-9065 Fax: 63-2-634-9069 Singapore Tel: 65-6334-8870 Fax: 65-6334-8850 Taiwan - Hsin Chu Tel: 886-3-5778-366 Fax: 886-3-5770-955 Spain - Madrid Tel: 34-91-708-08-90 Fax: 34-91-708-08-91 Sweden - Stockholm Tel: 46-8-5090-4654 UK - Wokingham Tel: 44-118-921-5800 Fax: 44-118-921-5820 Taiwan - Kaohsiung Tel: 886-7-213-7830 Taiwan - Taipei Tel: 886-2-2508-8600 Fax: 886-2-2508-0102 Thailand - Bangkok Tel: 66-2-694-1351 Fax: 66-2-694-1350 China - Xiamen Tel: 86-592-2388138 Fax: 86-592-2388130 China - Zhuhai Tel: 86-756-3210040 Fax: 86-756-3210049 03/25/14 2014 Microchip Technology Inc. Mouser Electronics Authorized Distributor Click to View Pricing, Inventory, Delivery & Lifecycle Information: Microchip: PIC16LF1554-E/ML PIC16LF1554T-I/SL PIC16LF1559-I/P PIC16LF1554-E/SL PIC16LF1554-E/P PIC16LF1559I/SS PIC16LF1559T-I/SS PIC16LF1554T-I/ML PIC16LF1559-E/ML PIC16LF1559-E/SS PIC16LF1554-I/P PIC16LF1559-E/P PIC16LF1554-E/ST PIC16LF1554-I/ST PIC16LF1559-I/ML PIC16LF1554-I/ML PIC16LF1554TI/ST PIC16LF1559T-I/ML PIC16LF1554-I/SL