Home

MPLAB ICD 3 In-Circuit Debugger User's Guide for

1. 30 MPLAB ICD 3 6860 eee 13 Documentation Wel VT 8 LAYOUT EES er encens EE 7 PC Power Down 45 61 Driver Board GE 19 20 21 22 23 24 0 63 PGD ns 19 20 21 22 23 24 Durability Card Guide ANR AKAA MAK A WAA RANTS 62 PIM mrasssasssasssaussssssssassuasssesesssasssssussssssesseesssssssasssassesssesssus 17 60 E Power Down 45 61 EEPROM Memonm 58 Preserve Memory 58 Erase All Before Program e Na rnd a Scart he 58 Processor Extension Kits 14 Programming F Productions russie rente 13 Firmware PUIEUPS 0 re nant nr tte e ne 21 Cancelled 46 Disconnected while Downloading 46 Q Firmware Downloads 58 Quick Reference Freeze oni om 45 30 Freeze Peripherals Setup 59 R G Reading Recommended 9 General Corrective Actions eee 52 AE 9 2012 Microchip Technology Inc DS52081A page 89 MPLAB ICD 3 User s Guide for MPLAB X IDE Reserved Resources by 26 06 reee 25 21 5 Software Breakpoints Selection 59 SOTP X 30 Standard Communication Connections ever vn Ede 19 Driver Board 63 Standard IC
2. 63 9 6 ICD 3 Test Interface 65 9 7 Target Board Considerations ss 66 Appendix A Revision History mam enr na nn UE npn ERN RAN RR RR 67 GOSSES 69 PR ER PP PER eee ee enr eee Re 89 Worldwide Sales and Service 7 0 7 91 DS52081A page 6 2012 Microchip Technology Inc MPLAB ICD 3 USER S MICROCHIP GUIDE FOR MPLAB X IDE Preface NOTICE TO CUSTOMERS All documentation becomes dated and this manual is no exception Microchip tools and documentation are constantly evolving to meet customer needs so some actual dialogs and or tool descriptions may differ from those in this document Please refer to our web site www microchip com to obtain the latest documentation available Documents are identified with a DS number This number is located on the bottom of each page in front of the page number The numbering convention for the DS number is DSXXXXXA where XXXXX is the document number and is the revision level of the document For the most up to date information on development tools see the MPLAB X IDE online help Select the Help menu and then Topics to open a list of available online help files INTRODUCTION This chapter contains general information that will be useful to know before using the MPLAB ICD 3 in circuit debugger Items discussed in this chapter include Document Layout Con
3. simplified diagram of some of the internal interface circuitry of the MPLAB ICD 3 In Circuit Debugger is shown For programming no clock is needed on the target device but power must be supplied When programming the debugger puts programming levels on VPP MCLR sends clock pulses on PGC and serial data via PGD To verify that the part has been programmed correctly clocks are sent to PGC and data is read back from PGD This conforms to the ICSP protocol of the device under development See the device programming specification for details DS52081A page 22 2012 Microchip Technology Inc Operation 26 REQUIREMENTS FOR DEBUGGING To debug set breakpoints see registers etc with the MPLAB ICD 3 In Circuit Debugger system there are critical elements that must be working correctly The debugger must be connected to a PC It must be powered by the PC via the USB cable and it must be communicating with the MPLAB X IDE software via the USB cable See Chapter 4 Common Debug Functions for details The debugger must be connected as shown in Figure 2 6 to the VPP PGC and PGD pins of the target device with the modular interface cable or equivalent Vss and VDD are also required to be connected between the debugger and target device The target device must have power and a functional running oscillator If the target device does not run for any reason the MPLAB ICD 3 In Circuit Debugger cannot debug The target d
4. M RM E 7 Part 1 Getting Started Chapter 1 About the Debugger 121 13 1 2 MPLAB ICD In Circuit Debugger Defined 13 1 3 How the MPLAB ICD In Circuit Debugger Helps You 14 1 4 MPLAB ICD In Circuit Debugger Kit Components 14 Chapter 2 Operation 2 1 8101902 Le WEE 15 2 2 Tools Comparison 16 2 3 Debugger to Target Communication 2 17 2 4 Target Communication Connections 19 2 5 Debugging with the Debugger nnne 22 2 6 Requirements for Debugging 23 2 7 Programming with the Debugger teta oio tie cte er ch ette s 25 2 8 Resources Used by the Debugger 25 Part 2 Features Chapter 3 General Setup Seite e Lee EE 29 29 3 3 Common Debug Features issus 30 3 4 Debugger Specific Debug Features 112 30 3 5 Quick Debug Program Reference 4 442 44 2 21 30 3 6 Debugger Programmer Limitations 31 Chapter 4 Common Debug Functions AA Mines EDD 33 4 2 Connecting the Target 1i bred at etais stades 33 4 3 Setting Up the Target Board e e ii 34 4 4 Starting and Stopping Debugging 2 35 4 5
5. Analog for the Digital Age Application Maestro chipKIT chipKIT logo CodeGuard dsPICDEM dsPICDEM net dsPlCworks dsSPEAK ECAN ECONOMONITOR FanSense HI TIDE In Circuit Serial Programming ICSP Mindi MiWi MPASM MPLAB Certified logo MPLIB MPLINK mTouch Omniscient Code Generation PICC PICC 18 PICDEM PICDEM net PICkit PICtail REAL ICE rfLAB Select Mode Total Endurance TSHARC UniWinDriver WiperLock 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 All other trademarks mentioned herein are property of their respective companies 2012 Microchip Technology Incorporated Printed in the U S A All Rights Reserved LI Printed on recycled paper ISBN 978 162076 251 6 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 MCUs and dsPIC DSCs KEELOQ 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 DS52081A page 2 2012 Microchip Technology Inc Object of Declaration MPLAB ICD
6. e 4 5 VIEWING PROCESSOR MEMORY AND FILES MPLAB X IDE provides several windows for viewing debug and various processor memory information that are selectable from the Window menu See MPLAB X IDE online help for more information on using these windows Window gt PIC Memory Views View data RAM and code ROM device memory Select from RAM Flash special function registers SFRs CPU and Configura tion bits e Window gt Debugging View debug information Select from variables watches call stack breakpoints and stopwatch To view your source code find the source code file you wish to view in the Project win dow and double click to open in a File window Code in this window is color coded according to the processor and build tool selected To change the style of color coding select Tools Options Fonts amp Colors Syntax tab For more on the Editor see NetBeans Help DE Basics gt Basic File Features EE R E 2X 2012 Microchip Technology Inc DS52081A page 35 MPLAB ICD 3 User s Guide for MPLAB X IDE 46 BREAKPOINTS AND STOPWATCH Use breakpoints to halt code execution at specified lines in your code Use the stopwatch with breakpoints to time code execution Breakpoint Resources Hardware or Software Breakpoint Selection Breakpoint and Stopwatch Usage 4 6
7. ports timers Microcontroller Mode One of the possible program memory configurations of PIC18 microcontrollers In microcontroller mode only internal execution is allowed Thus only the on chip pro gram memory is available in microcontroller mode Microprocessor Mode One of the possible program memory configurations of PIC18 microcontrollers In microprocessor mode the on chip program memory is not used The entire program memory is mapped externally Mnemonics Text instructions that can be translated directly into machine code Also referred to as opcodes Module The preprocessed output of a source file after preprocessor directives have been exe cuted Also known as a translation unit MPASM Assembler Microchip Technology s relocatable macro assembler for PIC microcontroller devices KeeLoq devices and Microchip memory devices MPLAB Language Tool for Device Microchip s C compilers assemblers and linkers for specified devices Select the type of language tool based on the device you will be using for your application e g if you will be creating C code on a PIC18 MCU select the MPLAB C Compiler for PIC18 MCUs DS52081A page 78 2012 Microchip Technology Inc Glossary MPLAB ICD Microchip in circuit debugger that works with MPLAB IDE MPLAB X IDE See ICE ICD MPLAB IDE MPLAB X IDE Microchip s Integrated Development Environment MPLAB IDE MPLAB X IDE comes with an editor project manage
8. 43 Chapter cl pnm 47 2012 Microchip Technology Inc DS52081A page 39 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 40 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Chapter 5 Troubleshooting First Steps 5 1 INTRODUCTION you are having problems with MPLAB ICD 3 In Circuit Debugger operation start here The 5 Questions to Answer First Top Reasons Why You Can t Debug Other Things to Consider 5 2 THE 5 QUESTIONS TO ANSWER FIRST 1 What device are you working with Often an upgrade to a newer version of MPLAB X IDE is required to support newer devices That is yellow light danger 2 Are you using a Microchip demo board or one of your own design Have you fol lowed the guidelines for resistors capacitors for communications connections See Chapter 2 Operation 3 Have you powered the target The debugger cannot power the target if greater than 100 mA 4 Are you using a USB hub in your set up Is it powered If you continue to have problems try using the debugger without the hub plugged directly into the PC 5 Are you using the standard communication cable RJ 11 shipped with the debugger If you have made a longer cable it can have communications errors 5 3 REASONS WHY YOU CAN T DEBUG 1 The oscillator is not working Check your Configuration bits setting for the oscillator If you are using an external osc
9. 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 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 QUALITY MANAGEMENT SYSTEM CERTIFIED BY DNV SO TS 16949 Trademarks The Microchip name and logo the Microchip logo dsPIC KEELOQ KEELOQ logo MPLAB PIC PICSTART 2 logo rfPIC and UNI O are registered trademarks of Microchip Technology Incorporated in the U S A and other countries FilterLab Hampshire HI TECH C Linear Active Thermistor MXDEV MXLAB SEEVAL and The Embedded Control Solutions Company are registered trademarks of Microchip Technology Incorporated in the U S A
10. MEAS ICD 3 Modular SCH Vh AME USB Power From PC 3 Reconnect the debugger to the PC Launch MPLAB X IDE Ensure that all existing projects are closed 5 Select Debug gt Run Debugger Programmer Selt Test then select the specific ICD 3 you want to test and click OK 6 Ensure the ICD 3 Test Interface Board and cable are connected Click Yes to continue 7 View the self test results in the debugger s Output window If the test runs suc cessfully you ll see the following Test interface PGC clock line write succeeded Test interface PGD data line write succeeded Test interface PGC clock line read succeeded Test interface PGD data line read succeeded Test interface LVP control line test succeeded Test interface MCLR level test succeeded ICD3 is functioning properly If you are still having problems with your target circuit please check the Target Board Considerations section of the online help 8 After the debugger passes the self test disconnect the ICD 3 Test Interface board from the debugger If any test failed please enter a ticket on http support microchip com copying and pasting the content of the output window into the problem description gt REENERT 2012 Microchip Technology Inc DS52081A page 65 MPLAB ICD 3 User s Guide for MPLAB X IDE 9 7 TARGET BOARD CONSIDERATIONS The target board should be powered according to the requirements of the selected
11. MICROCHIP MPLAB ICD 3 In Circuit Debugger User s Guide For MPLAB X IDE 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 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 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
12. Special Function Registers SFRs The portion of data memory RAM dedicated to registers that control 1 0 processor functions I O status timers or other modes or peripherals SQTP See Serialized Quick Turn Programming Stack Hardware Locations in PIC microcontroller where the return address is stored when a function call is made Stack Software Memory used by an application for storing return addresses function parameters and local variables This memory is dynamically allocated at runtime by instructions in the program It allows for reentrant function calls Stack Compiled A region of memory managed and allocated by the compiler in which variables are stat ically assigned space It replaces a software stack when such mechanisms cannot be efficiently implemented on the target device It precludes reentrancy MPLAB Starter Kit for Device Microchip s starter kits contains everything needed to begin exploring the specified device View a working application and then debug and program you own changes DS52081A page 84 2012 Microchip Technology Inc Glossary Static RAM or SRAM Static Random Access Memory Program memory you can read write on the target board that does not need refreshing frequently Status Bar The Status Bar is located on the bottom of the MPLAB IDE MPLAB X IDE window and indicates such current information as cursor position development mode and device and active tool bar Step Into
13. This command is the same as Single Step Step Into as opposed to Step Over follows a CALL instruction into a subroutine Step Over Step Over allows you to debug code without stepping into subroutines When stepping over a CALL instruction the next breakpoint will be set at the instruction after the CALL If for some reason the subroutine gets into an endless loop or does not return properly the next breakpoint will never be reached The Step Over command is the same as Single Step except for its handling of CALL instructions Step Out Step Out allows you to step out of a subroutine which you are currently stepping through This command executes the rest of the code in the subroutine and then stops execution at the return address to the subroutine Stimulus Input to the simulator i e data generated to exercise the response of simulation to external signals Often the data is put into the form of a list of actions in a text file Stimulus may be asynchronous synchronous pin clocked and register Stopwatch A counter for measuring execution cycles Storage Class Determines the lifetime of the memory associated with the identified object Storage Qualifier Indicates special properties of the objects being declared e g const Symbol A symbol is a general purpose mechanism for describing the various pieces which comprise a program These pieces include function names variable names section names file names struct enu
14. 9 5 21 MODULAR CONNECTOR SPECIFICATION Manufacturer Part Number AMP Incorporated 555165 1 Distributor Part Number Digi Key A9031ND The following table shows how the modular connector pins on an application corre spond to the microcontroller pins This configuration provides full ICD functionality FIGURE 9 2 MODULAR CONNECTOR PINOUT OF TARGET BOARD 16 Modular Microcontroller e Connector Pin Pin 6 PGM LVP Front View of Modular Connector on Target Board RB6 RB7 Ground VDD Target VPP 1 6 gt AJA Bottom View of Modular Connector Pinout on Target Board 9 5 2 2 MODULAR PLUG SPECIFICATION Manufacturer Part Number AMP Incorporated 5 554710 3 Distributor Part Number Digi Key A9117ND 9 5 2 3 MODULAR CABLE SPECIFICATION Manufacturer Part Number Microchip Technology 07 00024 8 00 a d Pin 1 Pin 6 1 CH DS52081A page 64 2012 Microchip Technology Inc Hardware Specification 9 6 ICD 3 TEST INTERFACE BOARD This board can be used to verify that the debugger is functioning properly To use this board 1 Disconnect the debugger from the target and the PC 2 Connectthe ICD 3 test interface board to the debugger using the modular cable MPLAB ICD 3 ICD 3 Test Interface Board POWER ACTIVE status In Circuit Debugger
15. Data Capture No No Yes Logic Probe Triggers No No Yes High Speed LVDS No No Yes Connection Production Programmer Yes No Yes DS52081A page 16 2012 Microchip Technology Inc Operation 2 3 DEBUGGER TO TARGET COMMUNICATION The debugger system configurations are discussed in the following sections CAUTION Do not connect the hardware before installing the software and USB drivers Also do not change hardware connections when the pod or target is powered 2 3 1 Standard ICSP Device Communication The debugger system can be configured to use standard ICSP communication for both programming and debugging functions This 6 pin connection is the same one used by the MPLAB ICD 2 In Circuit Debugger The modular cable can be inserted into either either of these items amatching socket at the target where the target device is on the target board Figure 2 1 astandard adapter header board combo available as a Processor Pak which is then plugged into the target board Figure 2 2 Note Older header boards used a 6 pin RJ 11 connector instead of an 8 pin connector so these headers may be connected directly to the debugger For more on standard communication see Chapter 9 Hardware Specification FIGURE 2 1 STANDARD DEBUGGER SYSTEM DEVICE WITH ON BOARD ICE CIRCUITRY POWER me STATUS In Circuit Debugger ICD 3 MICROCHIP 2012 Micr
16. Fax 317 773 5453 Los Angeles Mission Viejo CA Tel 949 462 9523 Fax 949 462 9608 Santa Clara Santa Clara CA Tel 408 961 6444 Fax 408 961 6445 Toronto Mississauga Ontario Canada Tel 905 673 0699 Fax 905 673 6509 ASIA PACIFIC Asia Pacific Office Suites 3707 14 37th Floor Tower 6 The Gateway Harbour City Kowloon Hong Kong Tel 852 2401 1200 Fax 852 2401 3431 Australia Sydney Tel 61 2 9868 6733 Fax 61 2 9868 6755 China Beijing Tel 86 10 8569 7000 Fax 86 10 8528 2104 China Chengdu Tel 86 28 8665 5511 Fax 86 28 8665 7889 China Chongqing Tel 86 23 8980 9588 Fax 86 23 8980 9500 China Hangzhou Tel 86 571 2819 3187 Fax 86 571 2819 3189 China Hong Kong SAR Tel 852 2401 1200 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 8203 2660 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 China Xiamen Tel 86 592 2388138 Fax 86 592 2388130 China Zhuhai Tel 86 756 3210040 Fax 86 756 3210049 ASIA PACIFIC India Bangalore Tel 91 80 3090 4444 Fax 91 80 3090 4123 India New Delhi Tel 91 11 4160 8631 Fax 91 11 4160 8632
17. 1 Breakpoint Resources For 16 bit devices breakpoints data captures and runtime watches use the same resources Therefore the available number of breakpoints is actually the available number of combined breakpoints triggers For 32 bit devices breakpoints use different resources than data captures and runtime watches Therefore the available number of breakpoints is independent of the avail able number of triggers The number of hardware and software breakpoints available and or used is displayed in the Project Environment window Window gt Project Environment See the MPLAB X IDE documentation for more on this feature Not all devices have software breakpoints For limitations on breakpoint operation including the general number of hardware breakpoints per device and hardware breakpoint skidding amounts see Limitations in the online help file Chapter 11 Limitations 4 6 2 Hardware or Software Breakpoint Selection The following table compares hardware and software breakpoints TABLE 4 1 HARDWARE VS SOFTWARE BREAKPOINTS Feature HW Breakpoints SW Breakpoints Number of breakpoints Limited Unlimited Breakpoints written to Debug registers Program memory Breakpoints applied to Memory registers Code Time to set breakpoints Minimal Oscillator speed dependent programming Flash memory Breakpoint skidding Most devices See the online No help Limitations section for details Wher
18. 3 In Circuit Debugger EU Declaration of Conformity Manufacturer Microchip Technology Inc 2355 W Chandler Blvd Chandler Arizona 85224 6199 USA This declaration of conformity is issued by the manufacturer The development evaluation tool is designed to be used for research and development in a laboratory environment This development evaluation tool is not intended to be a finished appliance nor is it intended for incorporation into finished appliances that are made commercially available as single functional units to end users This development evaluation tool complies with EU EMC Directive 2004 108 EC and as supported by the European Commission s Guide for the EMC Directive 2004 108 EC 8 February 2010 This development evaluation tool complies with EU RoHS2 Directive 2011 65 EU For information regarding the exclusive limited warranties applicable to Microchip products please see Microchip s standard terms and conditions of sale which are printed on our sales documentation and available at www microchip com Signed for and on behalf of Microchip Technology Inc at Chandler Arizona USA E M ec E d Deze Derek Carlson Date VP Development Tools 2012 Microchip Technology Inc DS52081A page 3 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 4 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Table of Contents
19. Device STATUS VPP MCLR MENS PGC p B PGD Vss MICROCHIP AVDD Interface Connector 2012 Microchip Technology Inc DS52081A page 19 MPLAB ICD 3 User s Guide for MPLAB X IDE 2 4 3 Target Powered In the following descriptions only three lines are active and relevant to core debugger operation pins 1 VPP MCLR 5 PGC and 4 PGD Pins 2 VDD and 3 Vss are shown on Figure 2 4 for completeness MPLAB ICD 3 has two configurations for powering the target device internal debugger and external target power The recommended source of power is external and derived from the target application In this configuration target VDD is sensed by the debugger to allow level translation for the target low voltage operation If the debugger does not sense voltage on its VDD line pin 2 of the interface connector it will not allow communication with the target 2 4 4 Debugger Powered The internal debugger power is limited in two aspects the voltage range is not as wide 3 5V the amount of current it can supply is limited to 100 mA This may be of benefit for very small applications that have the device VDD separated from the rest of the application circuit for independent programming but is not recommended for general usage as it imposes more current demands from the USB power system derived from the PC Be aware that the target VDD is sensed by the debugger to allow level
20. ICD 3 IN CIRCUIT DEBUGGER DEFINED The MPLAB ICD 3 In Circuit Debugger is an in circuit debugger that is controlled through a PC running MPLAB X IDE software on a Windows platform The MPLAB ICD 3 In Circuit Debugger is an integral part of the development engineer s toolsuite The application usage can vary from software development to hardware integration The MPLAB ICD 3 In Circuit Debugger is a complex debugger system used for hardware and software development of Microchip microcontrollers MCUs and dsPIC Digital Signal Controllers DSCs that are based on In Circuit Serial Programming ICSP and Enhanced In Circuit Serial Programming 2 wire serial interfaces The debugger system will execute code like an actual device because it uses a device with built in emulation circuitry instead of a special debugger chip for emulation All available features of a given device are accessible interactively and can be set and modified by the MPLAB X IDE interface The MPLAB ICD 3 debugger was developed for emulating embedded processors with rich debug facilities which differ from conventional system processors in the following aspects Processors run at maximum speeds Capability to incorporate UO port data input In addition to debugger functions the MPLAB ICD 3 In Circuit Debugger system also may be used as a device production programmer 2012 Microchip Technology Inc DS52081A page 13 MPLAB ICD 3 User s Guide for MPLA
21. India Pune Tel 91 20 2566 1512 Fax 91 20 2566 1513 Japan Osaka Tel 81 66 152 7160 Fax 81 66 152 9310 Japan Yokohama Tel 81 45 471 6166 Fax 81 45 471 6122 Korea Daegu Tel 82 53 744 4301 Fax 82 53 744 4302 Korea Seoul Tel 82 2 554 7200 Fax 82 2 558 5932 or 82 2 558 5934 Malaysia Kuala Lumpur Tel 60 3 6201 9857 Fax 60 3 6201 9859 Malaysia Penang Tel 60 4 227 8870 Fax 60 4 227 4068 Philippines Manila Tel 63 2 634 9065 Fax 63 2 634 9069 Singapore Tel 65 6334 8870 Fax 65 6334 8850 Taiwan Hsin Chu Tel 886 3 5778 366 Fax 886 3 5770 955 Taiwan Kaohsiung Tel 886 7 536 4818 Fax 886 7 330 9305 Taiwan Taipei Tel 886 2 2500 6610 Fax 886 2 2508 0102 Thailand Bangkok Tel 66 2 694 1351 Fax 66 2 694 1350 EUROPE Austria Wels Tel 43 7242 2244 39 Fax 43 7242 2244 393 Denmark Copenhagen Tel 45 4450 2828 Fax 45 4485 2829 France Paris Tel 33 1 69 53 63 20 Fax 33 1 69 30 90 79 Germany Munich Tel 49 89 627 144 0 Fax 49 89 627 144 44 Italy Milan Tel 39 0331 742611 Fax 39 0331 466781 Netherlands Drunen Tel 31 416 690399 Fax 31 416 690340 Spain Madrid Tel 34 91 708 08 90 Fax 34 91 708 08 91 UK Wokingham Tel 44 118 921 5869 Fax 44 118 921 5820 11 29 11 DS52081A page 91 2012 Microchip Technology Inc
22. Mode pro vides the Off Chip Memory selection dialog box Opcodes Operational Codes See Mnemonics Operators Symbols like the plus sign and the minus sign that are used when forming well defined expressions Each operator has an assigned precedence that is used to determine order of evaluation OTP One Time Programmable EPROM devices that are not in windowed packages Since EPROM needs ultraviolet light to erase its memory only windowed devices are eras able P Pass Counter A counter that decrements each time an event such as the execution of an instruction at a particular address occurs When the pass count value reaches zero the event is satisfied You can assign the Pass Counter to break and trace logic and to any sequential event in the complex trigger dialog PC Personal Computer or Program Counter PC Host Any PC running a supported Windows operating system Persistent Data Data that is never cleared or initialized Its intended use is so that an application can preserve data across a device Reset Phantom Byte An unimplemented byte in the dsPIC architecture that is used when treating the 24 bit instruction word as if it were a 32 bit instruction word Phantom bytes appear in dsPIC hex files DS52081A page 80 2012 Microchip Technology Inc Glossary PIC 5 PIC microcontrollers MCUs refers to all Microchip microcontroller families PICkit 2 and 3 Microchip s developmental d
23. Specifications 9 PAN SS ee 20 Hibernate mode 45 61 Hubs USB eee e edes 61 B Boot Flash 58 Breakpoints ICD 3 Test Interface Board 14 65 Hardware di ote e al 36 ICD Header 14 Setup Pete ie ae 36 ICD3Info0001 53 TEE 36 ICSP et ot E Ms 22 23 25 63 ICSPCLK iiie 63 6 IEN 63 Cables ID 58 Length ss 61 64 Indicator Eighlsu sn ue du nn er 62 Capacitors DO REN 20 21 Information Messages Re ER EE EH 53 14 Circuits That Will Prevent the Debugger From Func K ha AA 21 Keep hardware tool connected 29 Clock Speed nest 59 Kit Components 14 Code Protect 23 Configuration BB 23 L Configuration bits set in code 29 LEDS mi Pet Ee en 62 Low Voltage Programming Enable 58 D LVP configuration bit 58 Debug 0 24 Debug Mode Memories to 58 Sequence of Operations SR 23 Memory Ranges 0 8 Debug Top Reasons Why You Cantt 41 Modular Interface 23 Debug Program Quick
24. The base two numbering system that uses the digits 0 1 The rightmost digit counts ones the next counts multiples of 2 then 22 4 etc Breakpoint Hardware Breakpoint An event whose execution will cause a halt Software Breakpoint An address where execution of the firmware will halt Usually achieved by a special break instruction Build Compile and link all the source files for an application DS52081A page 70 2012 Microchip Technology Inc Glossary C C C C is a general purpose programming language which features economy of expression modern control flow and data structures and a rich set of operators C is the object oriented version of C Calibration Memory A special function register or registers used to hold values for calibration of a PIC micro controller on board RC oscillator or other device peripherals Central Processing Unit The part of a device that is responsible for fetching the correct instruction for execution decoding that instruction and then executing that instruction When necessary it works in conjunction with the arithmetic logic unit ALU to complete the execution of the instruction It controls the program memory address bus the data memory address bus and accesses to the stack Clean Clean removes all intermediary project files such as object hex and debug files for the active project These files are recreated from other files when a project is built COFF Common Ob
25. Viewing Processor Memory and Files 35 4 6 Breakpoints and Stopwatch 36 2012 Microchip Technology Inc DS52081A page 5 MPLAB ICD 3 User s Guide for MPLAB X IDE Part 3 Troubleshooting Chapter 5 Troubleshooting First Steps 5 1 41 5 2 The 5 Questions to Answer First 2 41 5 3 Top Reasons Why You Can t Debug 41 5 4 Other Things to Consider bd eb ea ide da 42 Chapter 6 Frequently Asked Questions FAQs 6 1 Introduction HT 43 6 2 How Does H Work 43 0 3 What level dni ay A i 45 Chapter 7 Messages 7 1 ie 47 7 2 Specific Error Messages nn ane te eae 47 7 3 General Corrective Actions data 52 7 4 Information Messages 0 53 Part 4 Reference Chapter 8 Debugger Function Summary 8 1 erte EE 57 8 2 Debugger Selection and Switching 57 8 3 Debugger Options Selection teint rinde cei aede ti 57 Chapter 9 Hardware Specification ses 61 ES Blue 101011101 EE 61 9 2 e ING EE 61 9 WEE En d e EE 61 94 MPLAB ICD 3 Debugger da dachebeedawladtets 62 9 5 Standard Communication Hardware
26. a read or write error 1 Did you hit Abort This may produce read write errors 2 Try the action again It may be a one time error 3 Ensure that the target is powered and at the correct voltage levels for the device See the device data sheet for required device voltage levels 4 Ensure that the debugger to target connection is correct PGC and PGD are connected 5 For write failures ensure that Erase all before Program is checked on the Program Memory tab of the Settings dialog 6 Ensure that the cables used are of the correct length 7 3 2 Debugger to Target Communication Error Actions The MPLAB ICD 3 In Circuit Debugger and the target device are out of sync with each other 1 Select Reset and then try the action again 2 Ensure that the cable s used are of the correct length 7 3 3 Debugger to PC Communication Error Actions The MPLAB ICD 3 In Circuit Debugger and MPLAB X are out of lynch with each other 1 Unplug and then plug in the debugger 1 Reconnect to the debugger 2 Try the operation again It is possible the error was a one time glitch 3 The version of MPLAB X installed may be incorrect for the version of firmware loaded on the MPLAB ICD 3 In Circuit Debugger Follow the steps outlined in Section 7 3 4 Corrupted Installation Actions 4 There may be an issue with the PC USB port See Section 7 3 5 USB Port Communication Error Actions 7 3 4 Corrupted Installation Actions The problem
27. boards optoisolated or electrically isolated A They are DC optoisolated but not AC optoisolated You cannot apply a floating or high voltage 120V to the current system Q What limitations are there with the standard cable A The standard ICSP RJ 11 cable does not allow for clock speeds greater than about 15 Mb sec dsPIC33F DSCs running at full speed are greater than the 15 Mb sec limit Q Will this slow down the running of the program A There is no cycle stealing with the MPLAB ICD 3 In Circuit Debugger The output of data is performed by the state machine in the silicon Q Is it possible to debug dsPIC DSC running at any speed A The MPLAB ICD 3 is capable of debugging at any device speed as specified in the device s data sheet Q What is the function of pin 6 the LVP pin A Pin 6 is reserved for the LVP Low Voltage Programming connection RR H n M ur DS52081A page 44 2012 Microchip Technology Inc Frequently Asked Questions FAQs 6 3 WHAT S WRONG Q My PC went into power down hibernate mode and now my debugger won t work What happened A When using the debugger for prolonged periods of time and especially as a debugger be sure to
28. debug executive to run The target will start from the Reset vector and execute until the Program Counter reaches the breakpoint address previously stored in the internal debug registers After the instruction at the breakpoint address is executed the in circuit debug mechanism of the target device fires and transfers the device s Program Counter to the debug executive much like an interrupt and the user s application is effectively halted The debugger communicates with the debug executive via PGC and PGD gets the breakpoint status information and sends it back to MPLAB X IDE MPLAB X IDE then sends a series of queries to the debugger to get information about the target device such as file register contents and the state of the CPU These queries are ultimately performed by the debug executive The debug executive runs just like an application in program memory It uses some locations on the stack for its temporary variables If the device does not run for whatever reason such as no oscillator a faulty power supply connection shorts on the target board etc then the debug executive cannot communicate to the MPLAB ICD 3 In Circuit Debugger and MPLAB X IDE will issue an error message DS52081A page 24 2012 Microchip Technology Inc Operation Another way to get a breakpoint is to select Debug gt Pause This toggles the PGC and PGD lines so that the in circuit debug mechanism of the target device switches the Program Counter f
29. dialog this can addition a small debug executive is placed in pro be any range of program memory gram memory and other debug resources are Programming SQTP reserved Debug features All for device breakpoints trace etc N A available Serial Quick Time N A Use the MPLAB PM3 to generate the SQTP file Then use the ICD3CMD to program the device DS52081A page 30 2012 Microchip Technology Inc General Setup 3 6 DEBUGGER PROGRAMMER LIMITATIONS For a complete list of debugger limitations for your device please see the online help file in MPLAB X IDE for the MPLAB ICD 3 In Circuit Debugger 2012 Microchip Technology Inc DS52081A page 31 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 32 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Chapter 4 Common Debug Functions 4 1 INTRODUCTION How to install and use the MPLAB ICD 3 In Circuit Debugger system is discussed Connecting the Target Setting Up the Target Board Starting and Stopping Debugging Viewing Processor Memory and Files Breakpoints and Stopwatch 4 2 CONNECTING THE TARGET A connection is built in to select the type of communication with the target See Section 2 3 Debugger to Target Communication for more details and a diagram 1 Plug in the USB power cable if not already connected 2 Attach the communication cable s between debu
30. exec is streamlined for more efficient com munication The debugger contains an FPGA large SRAM Buffers 1Mx8 and a High Speed USB interface Program memory image is downloaded and is con tained in the SRAM to allow faster programming The FPGA in the debugger serves as an accelerator for interfacing with the device in circuit debugger modules On traditional debuggers the data must come out on the bus in order to perform a complex trigger on that data Is this also required on the MPLAB ICD 3 In Circuit Debugger For example could halt based on a flag going high A Traditional debuggers use a special debugger chip ME for monitoring There is no ME with the MPLAB ICD 3 In Circuit Debugger so there are no bus ses to monitor externally With the MPLAB ICD 3 In Circuit Debugger rather than using external breakpoints the built in breakpoint circuitry of the debug engine is used the busses and breakpoint logic are monitored inside the part 2012 Microchip Technology Inc DS52081A page 43 MPLAB ICD 3 User s Guide for MPLAB X IDE Q Does the MPLAB ICD 3 In Circuit Debugger have complex breakpoints A Yes You can break based on a value in a data memory location You can also do sequenced breakpoints where several events are happening before it breaks However you can only do 2 sequences instead of 4 as you can in the MPLAB ICE 2000 You can also do the AND condition and do PASS counts Q Are any of the driver
31. fragmented If the problem persists contact Microchip 7 4 INFORMATION MESSAGES MPLAB ICD 3 In Circuit Debugger informational messages are listed below ICD3Info0001 ICD3 is functioning properly If you are still having problems with your target circuit please check the Target Board Considerations section of the online help See Section 9 7 Target Board Considerations 2012 Microchip Technology Inc DS52081A page 53 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 54 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Part 4 Reference Chapter 8 Debugger Function Summary eee 57 Chapter 9 Hardware Specifications 61 2012 Microchip Technology Inc DS52081A page 55 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 56 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE FOR MICROCHIP MPLAB X IDE Chapter 8 Debugger Function Summary 8 1 INTRODUCTION A summary of the MPLAB ICD 3 In Circuit Debugger functions is listed here Debugger Selection and Switching Debugger Options Selection 8 2 DEBUGGER SELECTION AND SWITCHING Use the Project Properties dialog to select or switch debuggers for a project To switch you must have more than one MPLAB ICD 3 connected to your computer MPLAB X IDE will differentiate between the two by displaying two different serial numbers To select or ch
32. in a source file Little Endian A data ordering scheme for multibyte data whereby the least significant byte is stored at the lower addresses Local Label A local label is one that is defined inside a macro with the LOCAL directive These labels are particular to a given instance of a macro s instantiation In other words the symbols and labels that are declared as local are no longer accessible after the ENDM macro is encountered Logic Probes Up to 14 logic probes can be connected to some Microchip emulators The logic probes provide external trace inputs trigger output signal 5V and a common ground Loop Back Test Board Used to test the functionality of the MPLAB REAL ICE in circuit emulator LVDS Low Voltage Differential Signaling A low noise low power low amplitude method for high speed gigabits per second data transmission over copper wire With standard 1 0 signaling data storage is contingent upon the actual voltage level Voltage level can be affected by wire length longer wires increase resistance which lowers voltage But with LVDS data storage is distinguished only by positive and neg ative voltage values not the voltage level Therefore data can travel over greater lengths of wire while maintaining a clear and consistent data stream Source http www webopedia com TERM L LVDS html M Machine Code The representation of a computer program that is actually read and interpreted by the processor A prog
33. is most likely caused by a incomplete or corrupted installation of MPLAB X 1 Uninstall all versions of MPLAB X from the PC 2 Reinstall the desired MPLAB X version 3 Ifthe problem persists contact Microchip DS52081A page 52 2012 Microchip Technology Inc Messages 7 3 5 USB Port Communication Error Actions The problem is most likely caused by a faulty or non existent communications port 1 Reconnect to the MPLAB ICD 3 In Circuit Debugger 2 Make sure the debugger is physically connected to the PC on the appropriate USB port Make sure the appropriate USB port has been selected in the debugger Settings Make sure the USB port is not in use by another device If using a USB hub make sure it is powered 6 Make sure the USB drivers are loaded ak 7 3 6 Debug Failure Actions The MPLAB ICD 3 In Circuit Debugger was unable to perform a debugging operation There are numerous reasons why this might occur See Chapter 5 Troubleshooting First Steps 7 3 7 Internal Error Actions Internal errors are unexpected and should not happen They are primarily used for internal Microchip development The most likely cause is a corrupted installation Section 7 3 4 Corrupted Installa tion Actions Another likely cause is exhausted system resources 1 Try rebooting your system to free up memory 2 Make sure you have a reasonable amount of free space on your hard drive and that it is not overly
34. taken when writing recursive macros it is easy to get caught in an infinite loop where there will be no exit from the recursion Reentrant A function that may have multiple simultaneously active instances This may happen due to either direct or indirect recursion or through execution during interrupt processing DS52081A page 82 2012 Microchip Technology Inc Glossary Relaxation The process of converting an instruction to an identical but smaller instruction This is useful for saving on code size MPLAB ASM30 currently knows how to RELAX a CALL instruction into an RCALL instruction This is done when the symbol that is being called is within 32k instruction words from the current instruction Relocatable An object whose address has not been assigned to a fixed location in memory Relocatable Section 16 bit assembler A section whose address is not fixed absolute The linker assigns addresses to relocatable sections through a process called relocation Relocation A process performed by the linker in which absolute addresses are assigned to relo catable sections and all symbols in the relocatable sections are updated to their new addresses ROM Read Only Memory Program Memory Memory that cannot be modified Run The command that releases the emulator from halt allowing it to run the application code and change or respond to I O in real time Run time Model Describes the use of target architecture
35. the separate linking of boot and secure application segments Address Value that identifies a location in memory Alphabetic Character Alphabetic characters are those characters that are letters of the arabic alphabet b Z A B Z Alphanumeric Alphanumeric characters are comprised of alphabetic characters and decimal digits 0 1 9 ANDed Breakpoints Set up an ANDed condition for breaking i e breakpoint 1 AND breakpoint 2 must occur at the same time before a program halt This can only be accomplished if a data breakpoint and a program memory breakpoint occur at the same time Anonymous Structure 16 bit C Compiler An unnamed structure PIC18 C Compiler An unnamed structure that is a member of a C union The mem bers of an anonymous structure may be accessed as if they were members of the enclosing union For example in the following code hi and 16 are members of an anonymous structure inside the union caster union castaway int intval struct char lo accessible as caster lo char hi accessible as caster hi caster 2012 Microchip Technology Inc DS52081A page 69 MPLAB ICD 3 User s Guide for MPLAB X IDE ANSI American National Standards Institute is an organization responsible for formulating and approving standards in the United States Application A set of software and hardware that may be controlled by a PIC microcontroller Archive Archiver An archive l
36. you have not already done so connect the MPLAB ICD 3 to the target using the appropriate cables see Section 4 2 Connecting the Target Then power the target If you are powering the target through the MPLAB ICD 3 use the Settings Dialog Power Tab DS52081A page 34 2012 Microchip Technology Inc Common Debug Functions 4 4 STARTING AND STOPPING DEBUGGING To debug an application in MPLAB X IDE you must create a project containing your source code so that the code may be built programmed into your device and executed as specified below To run your code select either Debug gt Debug Project or Debug Project from the Run toolbar To halt your code select either Debug gt Pause or Pause from the Debug toolbar To run your code again select either Debug gt Continue or Continue from the Debug toolbar To step through your code select either Debug gt Step Into or Step Into from the Debug toolbar Be careful not to step into a Sleep instruction or you will have to perform a processor Reset to resume emulation To step over a line of code select either Debug gt Step Over or Step Over from the Debug toolbar To end code execution select either Debug gt Finish Debugger Session or Finish Debugger Session from the Debug toolbar To perform a processor Reset on your code select either Debug gt Reset or Reset from the Debug toolbar Additional Resets such as POR BOR MCLR and Sys tem may be available depending on the device
37. 5 ND gt 3 4 DEBUGGER SPECIFIC DEBUG FEATURES Debugger specific debug features can be found under Chapter 4 Common Debug Functions Debug features in these sections include Breakpoints and Stopwatch External Triggers Logic Probes Data Capture Runtime Watches and the DMCI Trace If errors occur see Part 3 Troubleshooting Section 9 6 ICD 3 Test Interface Board 3 5 QUICK DEBUG PROGRAM REFERENCE The following table is a quick reference for using the MPLAB ICD 3 In Circuit Debugger as either a debugging or programming tool Please see previous chapters for informa tion on proper debugger set up and configuration TABLE 3 1 DEBUG VS PROGRAM OPERATION Item Debug Program Needed Hardware A PC and target application Microchip demo board or your own design Debugger pod USB cable communication driver board s and cable s Device with on board debug circuitry or debug Device with or without on board debug header with special ICE device circuitry MPLAB X IDE selection Project Properties ICD 3 as Hardware Tool Debug gt Debug Run Program Target Project toolbar button Program operation Programs application code into the device Depend Programs application code into the ing on the selections on the Project Properties dia device Depending on the selections log this can be any range of program memory In the Project Properties
38. 62 2012 Microchip Technology Inc Hardware Specification STANDARD COMMUNICATION HARDWARE For standard debugger communication with a target Section Chapter 2 Operation Section 2 3 1 Standard ICSP Device Communication use the RJ 11 connector To use this type of communication with a header board you may need a device specific Processor Pak which includes an 8 pin connector header board containing the desired ICE ICD device and a standard adapter board Note Older header boards used a 6 pin RJ 11 connector instead of an 8 pin connector so these headers may be connected directly to the debugger See the Header Board Specification DS51292 for more on available header boards 9 5 1 The standard communication is the main interface to the target processor It contains the connections to the high voltage VPP sense lines and clock and data connections required for programming and connecting with the target devices Standard Communication The VPP high voltage lines can produce a variable voltage that can swing from 0 to 14 volts to satisfy the voltage requirements for the specific emulation processor The VDD sense connection draws very little current from the target processor The actual power comes from the MPLAB ICD 3 In Circuit Debugger system as the VDD sense line is used as a reference only to track the target voltage The VDD connection is isolated with an optical switch The c
39. An area of memory used for dynamic memory allocation where blocks of memory are allocated and freed in an arbitrary order determined at runtime Hex Code Hex File Hex code is executable instructions stored in a hexadecimal format code Hex code is contained in a hex file Hexadecimal The base 16 numbering system that uses the digits 0 9 plus the letters A F or a f The digits A F represent hexadecimal digits with values of decimal 10 to 15 The rightmost digit counts ones the next counts multiples of 16 then 16 256 etc High Level Language A language for writing programs that is further removed from the processor than assembly l ICE ICD In Circuit Emulator In Circuit Debugger A hardware tool that debugs and programs a target device An emulator has more features than an debugger such as trace In Circuit Emulation In Circuit Debug The act of emulating or debugging with an in cir cuit emulator or debugger ICE ICD A device MCU or DSC with on board in circuit emulation or debug circuitry This device is always mounted on a header board and used to debug with an in circuit emulator or debugger ICSP In Circuit Serial Programming A method of programming Microchip embedded devices using serial communication and a minimum number of device pins IDE Integrated Development Environment as in MPLAB IDE MPLAB X IDE Identifier A function or variable name IEEE Institute of Electrical and Electronics Engine
40. B X IDE 1 3 HOW THE MPLAB ICD IN CIRCUIT DEBUGGER HELPS YOU The MPLAB ICD 3 In Circuit Debugger system allows you to Debug your application on your own hardware in real time Debug with hardware breakpoints Debug with software breakpoints Set breakpoints based on internal events Monitor internal file registers Emulate full speed Program your device 14 ICD IN CIRCUIT DEBUGGER KIT COMPONENTS The components of the MPLAB ICD 3 In Circuit Debugger system kit are 1 MPLAB ICD 3 with indicator lights 2 USB cable to provide communications between the debugger and a PC and to provide power to the debugger 3 Cable to connect the MPLAB ICD 3 to a header module or target board 4 CD 3 Test Interface Board 5 CD ROM with MPLAB X IDE software and online documentation FIGURE 1 1 BASIC DEBUGGER SYSTEM Indicator Lights Modular Cable to Target Board Header or ICD 3 Test Interface Board wf amp ICD 3 Test Interface USB Cable Additional hardware that may be ordered separately Transition socket ICD headers MPLAB processor extension kits DS52081A page 14 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Chapter 2 Operation 2 1 INTRODUCTION simplified description of how the MPLAB ICD 3 In Circuit Debugger system works is provided here It is intended to provide enough information so that a target board can be designe
41. B X IDE when the MPLAB ICD 3 debugger is chosen as the debug or program tool Chapter 9 Hardware Specification The hardware and electrical specifications of the debugger system CONVENTIONS USED IN THIS GUIDE This manual uses the following documentation conventions DOCUMENTATION CONVENTIONS Description Represents Examples Arial font Italic characters Referenced books MPLAB IDE User s Guide Emphasized text is the only compiler Initial caps A window the Output window A dialog the Settings dialog A menu selection select Enable Programmer Quotes A field name a window or Save project before build dialog Underlined italic text with A menu path File Save right angle bracket Bold characters A dialog button Click OK A tab Click the Power tab N Rnnnn A number in verilog format 4 b0010 2 hF1 where N is the total number of digits R is the radix and n isa digit Text in angle brackets lt gt A key on the keyboard Press Enter F1 Courier New font Plain Courier New Sample source code define START Filenames autoexec bat File paths c mcci8 n Keywords _asm endasm static Command line options Bit values E Constants OxFF Italic Courier New A variable argument file o Where file can be any valid filename Square brackets Optional arguments mcci8 options file options Curly brackets and pi
42. DE If the Hex file does not exist Reinstall MPLAB X DS52081A page 48 2012 Microchip Technology Inc Messages The MPLAB ICD 3 is missing its Program Executive Please reconnect to the PC and try again The MPLAB ICD 3 is missing its Debug Executive Please reconnect to the PC and try again MPLAB ICD 3 is missing its Device Database Please reconnect to the PC and try again The MPLAB ICD 3 is missing a Memory Object The current memory object in the MPLAB ICD 3 is corrupted Please retry the operation Unable to download debug executive If you receive this error while attempting to debug 1 Deselect the debugger as the debug tool 2 Close your project and then close MPLAB X 3 Restart MPLAB X and re open your project 4 Reselect the debugger as your debug tool and attempt to program your target device again Unable to download program executive If you receive this error while attempting to program 1 Deselect the debugger as the programmer 2 Close your project and then close MPLAB X 3 Restart MPLAB X and re open your project 4 Reselect the debugger as your programmer and attempt to program your target device again 7 2 5 Debug Failure Errors For the errors below read any instructions under your error message If these fail to fix the problem or if there are no instructions see Section 7 3 6 Debug Failure Actions Unable to open debug executive file Yos The target device
43. DE project component Non Extended Mode PIC18 MCUs In Non Extended mode the compiler will not utilize the extended instructions nor the indexed with literal offset addressing Non Real Time Refers to the processor at a breakpoint or executing single step instructions or MPLAB IDE MPLAB X IDE being run in simulator mode Non Volatile Storage A storage device whose contents are preserved when its power is off 2012 Microchip Technology Inc DS52081A page 79 MPLAB ICD 3 User s Guide for MPLAB X IDE NOP No Operation An instruction that has no effect when executed except to advance the program counter 0 Object Code Object File Object code is the machine code generated by an assembler or compiler An object file is a file containing machine code and possibly debug information It may be immedi ately executable or it may be relocatable requiring linking with other object files e g libraries to produce a complete executable program Object File Directives Directives that are used only when creating an object file Octal The base 8 number system that only uses the digits 0 7 The rightmost digit counts ones the next digit counts multiples of 8 then 82 64 etc Off Chip Memory Off chip memory refers to the memory selection option for the PIC18 device where memory may reside on the target board or where all program memory may be supplied by the emulator The Memory tab accessed from Options gt Development
44. E 8 5 SOFTWARE VS HARDWARE BREAKPOINTS Features Software Breakpoints Hardware Breakpoints Number of breakpoints unlimited limited Breakpoints are written to program memory debug registers Time to set breakpoints oscillator speed dependent minimal can take minutes Skidding no yes Note Using software breakpoints for debug impacts device endurance Therefore it is recommended that devices used in this manner not be used as production parts 8 3 5 Select peripherals to freeze or not freeze on program halt TABLE 8 6 FREEZE PERIPHERALS OPTION CATEGORY Freeze Peripherals Freeze all peripherals on halt This options applies to PIC12 16 18 MCUs Freeze this peripheral on halt This options applies to 16 and 32 bit MCUs Freeze Peripherals Peripheral PIC12 16 18 MCU Devices To freeze unfreeze all device peripherals on halt check uncheck the Freeze on Halt checkbox If this does not halt your desired peripheral be aware that some peripherals have no freeze on halt capability and cannot be controlled by the debugger dsPIC30F 33F PIC24F H and PIC32MX Devices For peripherals in the list Peripherals to Freeze on Halt check to freeze that periph eral on a halt Uncheck the peripheral to let it run while the program is halted If you do not see a peripheral on the list check All Other Peripherals If this does not halt your desired peri
45. For example ASSERT IPL 7 2012 Microchip Technology Inc DS52081A page 45 MPLAB ICD 3 User s Guide for MPLAB X IDE Q have finished debugging my code Now I ve programmed my part but it won t run What s wrong A Some things to consider are Have you selected the debugger as a programmer and then tried to program a header board A header board contains an ICE ICD version of the device and may not function like the actual device Only program regular devices with the debugger as a programmer Regular devices include devices that have on board ICE ICD circuitry but are not the special ICE ICD devices found on header boards Have you selected the debugger as a debugger and then tried to program a pro duction device Programming a device when the debugger is a debugger will program a debug executive into program memory and set up other device fea tures for debug see Section 2 6 1 Sequence of Operations Leading to Debugging To program final release code select the debugger as a pro grammer Have you selected Release from the Build Configuration drop down list or Project menu You must do this for final release code Rebuild your project reprogram the device and try to run your code again didn t set a software breakpoint yet have one in my code What s going on A What you are seeing is a phantom breakpoint Occasionally a breakpoint can become enabled when it shouldn t be Simpl
46. LAB ICD and reconnect If the problem persists contact Microchip for assistance The FPGA has failed its self test MPLAB X will attempt to download the latest firmware Please do not disconnect the ICD 3 during the download process If the problem persists contact Microchip for assistance The Driver board is missing Please unplug the MPLAB ICD 3 make sure the driver board is properly seated and reconnect If the problem persists contact Microchip for assistance The Main board serial EEPROM is missing Please unplug the MPLAB ICD 3 and reconnect If the problem persists contact Microchip for assistance The Driver board serial EEPROM is missing Please unplug the MPLAB ICD 3 and reconnect If the problem persists contact Microchip for assistance The DAC is missing Please unplug the MPLAB ICD 3 and reconnect If the problem persists contact Microchip for assistance The Main boards trigger IO expander is missing Please unplug the MPLAB ICD 3 and reconnect If the problem persists contact Microchip for assistance The Data pin I O test failed Please unplug the MPLAB ICD 3 and reconnect If the problem persists contact Microchip for assistance The Driver I O expander is missing Please unplug the MPLAB ICD and reconnect If the problem persists contact Microchip for assistance The VPP generator could not set the proper voltage Please unplug the MPLAB ICD 3 and then reconnect If problem persists contact Microchip for assistan
47. New Project to add your ICD 3 debugger to your project Use the project Properties dialog File Project Properties to set up debugger options Run the project build and run from Run gt Run Project Items of note are 1 2 Installing USB drivers on Windows OS systems requires following specific instructions See MPLAB X IDE documentation for details Each debugger contains a unique identifier which when first installed will be rec ognized by the OS regardless of which computer USB port is used MPLAB X IDE operation connects to the hardware tool at runtime Run or Debug Run To always be connected to the hardware tool like MPLAB IDE v8 see Tools Options Embedded button Generic Settings tab Keep hardware tool connected checkbox Configuration bits must now be set in code They can only be viewed in the con figuration bits window Window gt Memory Format drop down set as Code Memory drop down set as Configuration Bits 2012 Microchip Technology Inc DS52081A page 29 MPLAB ICD 3 User s Guide for MPLAB X IDE 3 3 COMMON DEBUG FEATURES Refer to the Help file Getting Started with MPLAB X IDE Debugging Code section for details on debug features This section includes Debug Running the project build program and run from Debug gt Debug Project Using breakpoints Stepping through code Using the Watch window Viewing Memory Variables and the Call Stack Using the Call Graph 5 3
48. SP Device Communication 17 ee E 36 Table Read 23 Target Connection Gi Le LS EET 19 Improper Circuits 21 Stahdard a e e oe Eee E ense Ele 19 Target Device remettre 23 Transition Socket 14 ua 9 34 U USB oerte eee vette lend 61 87 Cables Aer sme ida Ee Loa ise Ee 14 UNE ER IRE 61 USB 29 User ID 58 V MCaD tee re 20 Nd ME 19 20 22 23 19 20 21 23 VSS seti eden ete trees 19 20 22 23 W Watchdog Timer 23 87 DS52081A page 90 2012 Microchip Technology Inc MICROCHIP Worldwide Sales and Service AMERICAS 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 Atlanta Duluth GA Tel 678 957 9614 Fax 678 957 1455 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 Farmington Hills MI Tel 248 538 2250 Fax 248 538 2260 Indianapolis Noblesville IN Tel 317 773 8323
49. Then try to deselect the debugger again 4 Shut down MPLAB X ICD 3 failed to request DMA reads Unable to initialize ICD 3 database An Error occurred while running Address x Expected Value x Received Value x Target Device ID 0 does not match expected Device ID 0 Unable to properly create ICD 3 database 7 2 8 Internal Errors See Section 7 3 7 Internal Error Actions Initialization failed Unable to create ControlPointMediator Initialization failed Unable to create com object Initialization failed Unable to retrieve device information for device Yos Initialization failed Family class is unrecognized Initialization failed Failed while retrieving device database pic information Initialization failed Failed while retrieving tool database rice information Initialization failed Unable to load debug executive Initialization failed Unable to acquire emulation memory object Initialization failed Unable to acquire ToolExecMediator 2012 Microchip Technology Inc DS52081A page 51 MPLAB ICD 3 User s Guide for MPLAB X IDE 7 3 GENERAL CORRECTIVE ACTIONS These general corrective actions may solve your problem Read Write Error Actions Debugger to Target Communication Error Actions Debugger to PC Communication Error Actions Corrupted Installation Actions USB Port Communication Error Actions Debug Failure Actions Internal Error Actions 7 3 1 Read Write Error Actions If you receive
50. ange the debugger used for a project 1 Open the Project Properties dialog by doing one of the following a Click on the project name in the Project window and select File gt Project Properties b Right click on the project name in the Project window and select Properties 2 Under Categories click on default 3 Under Hardware Tools find ICD 3 and click on a serial number SN to select an debugger for use in the project 8 3 DEBUGGER OPTIONS SELECTION Set up debugger options on the debugger property pages of the Project Properties dialog 1 Open the Project Properties dialog by doing one of the following a Click on the project name in the Project window and select File gt Project Properties b Right click on the project name in the Project window and select Properties 2 Under Categories click on ICD 3 3 Select property pages from Options categories Click on an option to see its description in the text box below Click to the right of an option to change it Available option categories are Memories to Program Firmware Program Options Debug Options Freeze Peripherals Clock Power 2012 Microchip Technology Inc DS52081A page 57 8 3 1 MPLAB ICD 3 User s Guide for MPLAB X IDE Memories to Program Select the memories to be programmed into the target TABLE 8 1 MEMORIES TO PROGRAM OPTION CATEGORY Auto select memories Allow ICD 3 to Select Memories The
51. at will provide trace information from emulator data Since this is a software trace the macro must be added to code the code must be recompiled or reassembled and the target device must be programmed with this code before trace will work Trigger Output Trigger output refers to an emulator output signal that can be generated at any address or address range and is independent of the trace and breakpoint settings Any number of trigger output points can be set Trigraphs Three character sequences all starting with that are defined by ISO C as replacements for single characters U Unassigned Section A section which has not been assigned to a specific target memory block in the linker command file The linker must find a target memory block in which to allocate an unassigned section Uninitialized Data Data which is defined without an initial value In C int myVar defines a variable which will reside in an uninitialized data section Upload The Upload function transfers data from a tool such as an emulator or programmer to the host PC or from the target board to the emulator DS52081A page 86 2012 Microchip Technology Inc Glossary USB Universal Serial Bus An external peripheral interface standard for communication between a computer and external peripherals over a cable using bi serial transmission USB 1 0 1 1 supports data transfer rates of 12 Mbps Also referred to as high speed USB USB 2 0 support
52. by register Program Counter The location that contains the address of the instruction that is currently executing Program Counter Unit 16 bit assembler A conceptual representation of the layout of program memory The program counter increments by 2 for each instruction word In an executable section 2 program counter units are equivalent to 3 bytes In a read only section 2 program counter units are equivalent to 2 bytes Program Memory MPLAB IDE MPLAB X IDE The memory area in a device where instructions are stored Also the memory in the emulator or simulator containing the downloaded target application firmware 16 bit assembler compiler The memory area in a device where instructions are stored Project A project contains the files needed to build an application Source code linker script files etc along with their associations to various build tools and build options 2012 Microchip Technology Inc DS52081A page 81 MPLAB ICD 3 User s Guide for MPLAB X IDE Prologue A portion of compiler generated code that is responsible for allocating stack space pre serving registers and performing any other machine specific requirement specified in the runtime model This code executes before any user code for a given function Prototype System A term referring to a user s target application or target board Psect The OCG equivalent of a GCC section short for program section A block of code or data which
53. ce The VDD generator could not set the proper voltage Please unplug the MPLAB ICD 3 and then reconnect If problem persists contact Microchip for assistance The Clock or Data line has clamped the external voltage Please remove your target probe the voltage levels and then reconnect Too much current has been drawn on VPP Please disconnect your circuit check the MCLR line for shorts and then reconnect Too much current has been drawn on VDD Please disconnect your circuit check the CLK and DATA lines for shorts and then reconnect Target Vdd not detected Please ensure the target device is connect DS52081A page 50 2012 Microchip Technology Inc Messages 7 2 7 Miscellaneous Errors For the errors below read any instructions under your error message Could not open file There was a problem reading file Failed to set firmware suite Database initialization failure Connection failed timed out waiting to ICD 3 to respond MPLAB has lost communication with ICD 3 Unable to connect to ICD 3 MPLABComm connect failure ICD 3 is busy Please wait for the current operation to finish you receive this error when attempting to deselect the debugger as a debugger or programmer 1 Wait give the debugger time to finish any application tasks Then try to deselect the debugger again 2 Select Halt to stop any running applications Then try to deselect the debugger again 3 Unplug the debugger from the PC
54. command Failed while sending cmd SETPROBES command Failed while sending cmd SETBRACKET Failed to get status Failed to send database If you receive this error 1 Try downloading again It may be a one time error 2 Try manually downloading the highest number jam file Invalid command response sent 0x x received 0x x Failed while trying to enter ICE test mode Failed while trying to start DMA test Failed to properly receive DMA test data Timed out while waiting to process data from endpoint 0x x Transmission failure while receiving streaming data Interrupted Exception occurred Yos Unable to start streaming data reception Unable to start run time data reception Failed getting PC 7 2 3 Debugger to PC Communication Errors For the errors below read any instructions under your error message If these fail to fix the problem or if there are no instructions see Section 7 3 3 Debugger to PC Com munication Error Actions Failed to set debug options Failed while stepping the target Failed while halting the target Cannot communicate with s 7 2 4 Corrupted Outdated Installation Errors For the errors below read any instructions under your error message If these fail to fix the problem or if there are no instructions see Section 7 3 4 Corrupted Installation Actions Failed to download firmware If the Hex file exists Reconnect and try again If this does not work the file may be corrupted Reinstall MPLAB X I
55. d by the debugger The target device is run in debug mode EGRE CC O Jj C X2 w C M J Pg an 2012 Microchip Technology Inc DS52081A page 23 MPLAB ICD 3 User s Guide for MPLAB X IDE 2 6 2 Debugging Details Figure 2 7 illustrates the MPLAB ICD 3 In Circuit Debugger system when it is ready for debugging FIGURE 2 7 MPLAB ICD 3 IN CIRCUIT DEBUGGER READY FOR DEBUGGING Wii Internal zt Kee Debug be Registers T Running e 12V 1 for Debug 5V VPP MCLR Executive Internal Circuits Er to Function 2 xecutive 2 Area PGC Reserved T 5 Ver fs for Debug 4 7 Executive a Memory 4 PGD Hardware Stack Shared by Debug Exec Area Used by Debug Exec File Registers Typically in order to find out if an application program will run correctly a breakpoint is set early in the program code When a breakpoint is set from the user interface of MPLAB X IDE the address of the breakpoint is stored in the special internal debug registers of the target device Commands on PGC and PGD communicate directly to these registers to set the breakpoint address Next the Debug gt Debug Project function is usually selected in MPLAB X IDE The debugger will then tell the
56. d that is compatible with the debugger for both emulation and programming operations The basic theory of in circuit emulation and programming is discussed so that problems if encountered are quickly resolved Tools Comparison Debugger to Target Communication Target Communication Connections Debugging with the Debugger Requirements for Debugging Programming with the Debugger Resources Used by the Debugger 2012 Microchip Technology Inc DS52081A page 15 MPLAB ICD 3 User s Guide for MPLAB X IDE 2 2 TOOLS COMPARISON The MPLAB ICD 3 In Circuit Debugger system differs physically and operationally from other Microchip debug tools as shown below Specific features may vary by device see the online help file Chapter 2 Device and Feature Support TABLE 2 1 DEBUG TOOLS COMPARISON MPLAB ICD 3 PICkit 3 MPLAB REAL ICE Features In Circuit Programmer In Circuit Debugger Debugger Emulator USB Speed High and Full Full Only High and Full USB Driver Microchip HID Microchip USB Powered Yes Yes Yes Power to Target Yes Yes No Programmable VPP and VDD Yes Yes Yes Vdd Drain from Target 1ma 20ma 1ma Overvoltage Overcurrent Yes HW Yes SW Yes HW Protection Device emulation Full speed Full speed Full speed HW Breakpoints Complex Simple Complex Stopwatch Yes Yes Yes SW Breakpoints Yes No Yes Program Image No 512K bytes No Serialized USB Yes Yes Yes Trace No No Yes
57. d with MPLAB X IDE Usage troubleshooting and hardware specifications are covered This may be more up to date than the printed documentation Also debugger reserved resources and limitations are listed for various devices Header Board Specification DS51292 This booklet describes how to install and use MPLAB REAL ICE In Circuit Emulator headers Headers are used to better debug selected devices using special ICE device versions without the loss of pins or resources See also the Header online help file Transition Socket Specification DS51194 Consult this document for information on transition sockets available for use with headers 2012 Microchip Technology Inc DS52081A page 9 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 10 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Part 1 Getting Started Chapter 1 About the Debugger see 13 Chapter 2 Operation Ee 15 2012 Microchip Technology Inc DS52081A page 11 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 12 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Chapter 1 About the Debugger 1 1 INTRODUCTION An overview of the MPLAB ICD 3 In Circuit Debugger system is provided MPLAB ICD 3 In Circuit Debugger Defined How the MPLAB ICD 3 In Circuit Debugger Helps You MPLAB ICD 3 In Circuit Debugger Kit Components 1 2 MPLAB
58. device 2 0V 5 5V and the application The debugger does sense target power There is a 10KQ load on VDD TGT Depending on the type of debugger to target communications used there will be some considerations for target board circuitry Section 2 4 2 Target Connection Circuitry Section 2 4 2 Target Connection Circuitry Section 2 4 5 Circuits That Will Prevent the Debugger From Functioning Section 2 4 5 Circuits That Will Prevent the Debugger From Functioning DS52081A page 66 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Appendix A Revision History Revision A May 2012 Initial release of this document 2012 Microchip Technology Inc DS52081A page 67 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 68 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Glossary A Absolute Section A GCC compiler section with a fixed absolute address that cannot be changed by the linker Absolute Variable Function A variable or function placed at an absolute address using the OCG compiler s 6 address syntax Access Memory PIC18 Only Special registers on PIC18 devices that allow access regardless of the setting of the Bank Select Register BSR Access Entry Points Access entry points provide a way to transfer control across segments to a function which may not be defined at link time They support
59. disable the Hibernate mode in the Power Options Dialog window of your PC s operating system Go to the Hibernate tab and clear or uncheck the Enable hibernation check box This will ensure that all communication is maintained across all the USB subsystem components set my peripheral to NOT freeze on halt but it is suddenly freezing What s going on A For dsPIC30F 33F and PIC24F H devices a reserved bit in the peripheral control register usually either bit 14 or 5 is used as a Freeze bit by the debug ger If you have performed a write to the entire register you may have overwritten this bit The bit is user accessible in Debug mode To avoid this problem write only to the bits you wish to change for your application BTS BTC instead of to the entire register MOV Q When using a 16 bit device an unexpected Reset occurred How do I determine what caused it A Some things to consider To determine a Reset source check the RCON register Handle traps interrupts in an Interrupt Service Routine ISR You should include trap c style code i e void attribute interrupt _OscillatorFail void void attribute _ interrupt AltOscillatorFail void void attribute interrupt _OscillatorFail void INTCON1bits OSCFAIL 0 Clear the trap flag while 1 void attribute _ interrupt _AltOscillatorFail void INTCONIbits OSCFAIL 0 while 1 Use ASSERTs
60. e information about the breakpoint is written in the device What kind of device feature applies to the breakpoint This is where the breakpoint is set To select hardware or software breakpoints 1 Select your project in the Project window Then select either Edit gt Project Properties or right click and select Properties 2 Inthe Project Properties dialog select ICD 3 under Categories 3 Under Option Categories select Debug Options 4 Check Use software breakpoints to use software breakpoints Uncheck to use hardware breakpoints Note Using software breakpoints for debug impacts device endurance Therefore it is recommended that devices used in this manner not be used as production parts DS52081A page 36 2012 Microchip Technology Inc Common Debug Functions 4 6 3 Breakpoint and Stopwatch Usage Breakpoints halt execution of code To determine the time between the breakpoints use the stopwatch Please refer to the MPLAB X IDE Help for how to set up and use breakpoints and the stopwatch 2012 Microchip Technology Inc DS52081A page 37 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 38 2012 Microchip Technology Inc AN MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Part 3 Troubleshooting Chapter 5 Troubleshooting First Steps ss 41 Chapter 6 Frequently Asked Questions
61. echnology Inc DS52081A page 73 MPLAB ICD 3 User s Guide for MPLAB X IDE Extended Mode PIC18 MCUs In Extended mode the compiler will utilize the extended instructions i e ADDFSR ADDULNK CALLW MOVSF MOVSS PUSHL SUBFSR and SUBULNK and the indexed with literal offset addressing External Label A label that has external linkage External Linkage A function or variable has external linkage if it can be referenced from outside the module in which it is defined External Symbol A symbol for an identifier which has external linkage This may be a reference or a definition External Symbol Resolution A process performed by the linker in which external symbol definitions from all input modules are collected in an attempt to resolve all external symbol references Any external symbol references which do not have a corresponding definition cause a linker error to be reported External Input Line An external input signal logic probe line TRIGIN for setting an event based upon external signals External RAM Off chip Read Write memory F Fatal Error An error that will halt compilation immediately No further messages will be produced File Registers On chip data memory including General Purpose Registers GPRs and Special Function Registers SFRs Filter Determine by selection what data is included excluded in a trace display or data file Fixup The process of replacing object file symbolic references wit
62. emulator uses your and ranges selected device and default settings to determine what to program Manually select memories and ranges You select the type and range of memory to program see below Memory Check to program Memory where Memory is the type of memory Types include EEPROM ID Boot Flash Auxiliary Program Memory Check to program the target program memory range specified below Program Memory Start hex Program Memory End hex The starting and ending hex address range in program memory for programming reading or verification If you receive a programming error due to an incorrect end address correct the end address and program again Note The address range does not apply to the Erase function The Erase function will erase all data on the device Preserve Program Memory Check to not program the target program memory range specified below Preserve Program Memory Start hex Preserve Program Memory End hex The starting and ending hex address range in target program mem ory to preserve when programming reading or verifying This memory is read from the target and overlayed with existing MPLAB X IDE memory Preserve Memory Check to not erase Memory when programming where Memory is the type of memory Types include EEPROM ID Boot Flash Auxiliary 8 3 2 Firmware Select and load debugger firmware TABLE 8 2 FIRMWARE OPTION CATEGORY Use Latest Firm
63. ers 2012 Microchip Technology Inc DS52081A page 75 MPLAB ICD 3 User s Guide for MPLAB X IDE Import Bring data into the MPLAB IDE MPLAB X IDE from an outside source such as from a hex file Initialized Data Data which is defined with an initial value In C int myVar 5 defines a variable which will reside in an initialized data section Instruction Set The collection of machine language instructions that a particular processor understands Instructions A sequence of bits that tells a central processing unit to perform a particular operation and can contain data to be used in the operation Internal Linkage A function or variable has internal linkage if it can not be accessed from outside the module in which it is defined International Organization for Standardization An organization that sets standards in many businesses and technologies including computing and communications Also known as ISO Interrupt A signal to the CPU that suspends the execution of a running application and transfers control to an Interrupt Service Routine ISR so that the event may be processed Upon completion of the ISR normal execution of the application resumes Interrupt Handler A routine that processes special code when an interrupt occurs Interrupt Service Request IRQ An event which causes the processor to temporarily suspend normal instruction exe cution and to start executing an interrupt handler routine So
64. evice must have its configuration words programmed correctly The oscillator Configuration bits should correspond to RC XT etc depending on the target design For some devices the Watchdog Timer is enabled by default and needs to be disabled The target device must not have code protection enabled The target device must not have table read protection enabled For some devices with more than one PGC PGD pair the correct pair needs to be configured This only refers to debugging since programming will work over any PGC PGD pair LVP should be disabled 2 6 1 Sequence of Operations Leading to Debugging Given that the requirements for debugging are met the following actions can be performed when the MPLAB ICD 3 is set as the current tool Edit gt Project Properties Advanced MPLAB Environment When Debug gt Debug Project is selected the application code is programmed into the device s memory via the ICSP protocol as described at the beginning of this section A small debug executive program is loaded into the high area of program mem ory of the target device Since the debug executive must reside in program mem ory the application program must not use this reserved space Some devices have special memory areas dedicated to the debug executive Check your device data sheet for details Special in circuit debug registers in the target device are enabled by MPLAB X IDE These allow the debug executive to be activate
65. evice programmers with debug capability through Debug Express See the Readme files for each tool to see which devices are supported Plug ins The MPLAB IDE MPLAB X IDE has both built in components and plug in modules to configure the system for a variety of software and hardware tools Several plug in tools may be found under the Tools menu Pod The enclosure for an in circuit emulator or debugger Other names are Puck if the enclosure is round and Probe not be confused with logic probes Power on Reset Emulation A software randomization process that writes random values in data RAM areas to simulate uninitialized values in RAM upon initial power application Pragma A directive that has meaning to a specific compiler Often a pragma is used to convey implementation defined information to the compiler MPLAB C30 uses attributes to convey this information Precedence Rules that define the order of evaluation in expressions Production Programmer A production programmer is a programming tool that has resources designed in to pro gram devices rapidly It has the capability to program at various voltage levels and com pletely adheres to the programming specification Programming a device as fast as possible is of prime importance in a production environment where time is of the essence as the application circuit moves through the assembly line Profile For MPLAB SIM simulator a summary listing of executed stimulus
66. formation Messages 7 2 SPECIFIC ERROR MESSAGES MPLAB ICD 3 In Circuit Debugger error messages are listed below Text of the error messages listed below in the form x a variable will display as text relevant to your particular situation in the actual error message Read Write Errors Debugger to Target Communication Errors Debugger to PC Communication Errors Corrupted Outdated Installation Errors Debug Failure Errors Hardware Firmware Errors Miscellaneous Errors Internal Errors 7 2 1 Read Write Errors For the errors below read any instructions under your error message If these fail to fix the problem or if there are no instructions see Section 7 3 1 Read Write Error Actions Failed while writing to s Failed while reading Yos Failed to program device Failed to read device Failed to write to s memory Failed to erase the device Unable to read target register s Unable to write target register s Programming debug executive failed Programming program executive failed Failed to get Device ID 2012 Microchip Technology Inc DS52081A page 47 MPLAB ICD 3 User s Guide for MPLAB X IDE 7 2 2 Debugger to Target Communication Errors For the errors below read any instructions under your error message If these fail to fix the problem or if there are no instructions see Section 7 3 2 Debugger to Target Communication Error Actions Failed to reset the device Failed while sending cmd INITCOMM
67. generated code that is responsible for deallocating stack space restoring registers and performing any other machine specific requirement specified in the runtime model This code executes after any user code for a given function immediately prior to the function return EPROM Erasable Programmable Read Only Memory A programmable read only memory that can be erased usually by exposure to ultraviolet radiation Error Error File An error reports a problem that makes it impossible to continue processing your pro gram When possible an error identifies the source file name and line number where the problem is apparent An error file contains error messages and diagnostics gener ated by a language tool Event A description of a bus cycle which may include address data pass count external input cycle type fetch R W and time stamp Events are used to describe triggers breakpoints and interrupts Executable Code Software that is ready to be loaded for execution Export Send data out of the MPLAB IDE MPLAB X IDE in a standardized format Expressions Combinations of constants and or symbols separated by arithmetic or logical operators Extended Microcontroller Mode In extended microcontroller mode on chip program memory as well as external mem ory is available Execution automatically switches to external if the program memory address is greater than the internal memory space of the PIC18 device 2012 Microchip T
68. ger Do not use capacitors on PGC PGD they will prevent fast transitions on data and clock lines during programming and debug communications Do not use capacitors on MCLR they will prevent fast transitions of VPP A simple pull up resistor is generally sufficient Do not use diodes on PGC PGD they will prevent bidirectional communication between the debugger and the target device 2012 Microchip Technology Inc DS52081A page 21 MPLAB ICD 3 User s Guide for MPLAB X IDE 25 DEBUGGING WITH THE DEBUGGER There are two steps to using the MPLAB ICD 3 In Circuit Debugger system as a debugger The first requires that an application be programmed into the target device The second uses the internal in circuit debug hardware of the target Flash device to run and test the application program These two steps are directly related to the MPLAB X IDE operations 1 Programming the code into the target and activating special debug functions see the next section for details 2 Using the debugger to set breakpoints and run If the target device cannot be programmed correctly the MPLAB ICD 3 In Circuit Debugger will not be able to debug Figure 2 6 shows the basic interconnections required for programming Note that this is the same as Figure 2 4 but for the sake of clarity the VDD and Vss lines from the debugger are not shown FIGURE 2 6 PROPER CONNECTIONS FOR PROGRAMMING Programming VDD Voltage VPP MCLR
69. gger and target FIGURE 4 1 INSERT COMMUNICATIONS AND USB POWER CABLES Communications Cable O In Cireuit Debugger METAIS Ge From Target AN MICROCHIP USB Power From PC 2012 Microchip Technology Inc DS52081A page 33 MPLAB ICD 3 User s Guide for MPLAB X IDE 43 SETTING UP THE TARGET BOARD The target must be set up for the type of target device to be used 4 3 1 Using Production Devices For production devices the debugger may be connected directly to the target board The device on the target board must have built in debug circuitry so the MPLAB ICD 3 In Circuit Debugger can perform emulation with it Consult the device data sheet to see if the device has the needed debug circuitry i e it should have a Background Debugger Enable Configuration bit Note n the future devices with circuitry that support ICD may be used The target board must have a connector to accommodate the communications chosen for the debugger For connection information see Section 2 3 Debugger to Target Communication Section 2 3 1 Standard ICSP Device Communication 4 3 2 Using ICE Devices For ICE devices an ICE header board is required The header board contains the hardware necessary to emulate a specific device or family of devices For more information on ICE headers see the Header Board Specification DS51292 Note n the future ICD heade
70. h absolute addresses after relocation by the linker Flash A type of EEPROM where data is written or erased in blocks instead of bytes FNOP Forced No Operation A forced NOP cycle is the second cycle of a two cycle instruc tion Since the PIC microcontroller architecture is pipelined it prefetches the next instruction in the physical address space while it is executing the current instruction However if the current instruction changes the program counter this prefetched instruction is explicitly ignored causing a forced NOP cycle Frame Pointer A pointer that references the location on the stack that separates the stack based arguments from the stack based local variables Provides a convenient base from which to access local variables and other values for the current function DS52081A page 74 2012 Microchip Technology Inc Glossary Free Standing An implementation that accepts any strictly conforming program that does not use complex types and in which the use of the features specified in the library clause ANSI 89 standard clause 7 is confined to the contents of the standard headers lt float h gt lt iso646 h gt lt limits h gt lt stdarg h gt lt stdbool h gt lt stddef h gt and stdint h G GPR General Purpose Register The portion of device data memory RAM available for general use H Halt A stop of program execution Executing Halt is the same as stopping at a breakpoint Heap
71. ibrary is a collection of relocatable object modules It is created by assem bling multiple source files to object files and then using the archiver librarian to com bine the object files into one archive library file archive library can be linked with object modules and other archives libraries to create executable code ASCII American Standard Code for Information Interchange is a character set encoding that uses 7 binary digits to represent each character It includes upper and lower case letters digits symbols and control characters Assembly Assembler Assembly is a programming language that describes binary machine code in a sym bolic form An assembler is a language tool that translates assembly language source code into machine code Assigned Section A GCC compiler section which has been assigned to a target memory block in the linker command file Asynchronously Multiple events that do not occur at the same time This is generally used to refer to interrupts that may occur at any time during processor execution Asynchronous Stimulus Data generated to simulate external inputs to a simulator device Attribute GCC Characteristics of variables or functions in a C program which are used to describe machine specific properties Attribute Section GCC Characteristics of sections such as executable readonly or data that can be specified as flags in the assembler section directive B Binary
72. illator try using an internal oscillator If you are using an internal a PLL make sure your PLL settings are correct 2 The target board is not powered Check the power cable connection 3 The VDD voltage is outside the specifications for this device See the device programming specification for details 4 The debugger has somehow become physically disconnected from the PC and or the target board Check the communications cables connections 5 The device is code protected Check your Configuration bits setting for code protection 6 Debugger to PC communications has somehow been interrupted Reconnect to the debugger in MPLAB X 7 The device is code protected Check your Configuration bits setting for code protection 8 Youare trying to debug a production device that doesn t have debugging capa bilities Use a debug header instead See the Debug Header Specification in Recommended Reading 2012 Microchip Technology Inc DS52081A page 41 MPLAB ICD 3 User s Guide for MPLAB X IDE 9 The target application has somehow become corrupted or contains errors For example the regular linker script was used in the project instead of the debugger version of the linker script eg 18F8722 Ikr was used instead of 18 87221 1 Try rebuilding and reprogramming the target application Then initiate a Power On Reset of the target 10 You do not have the correct PGC PGD pin pairs programmed in your Configuration bits f
73. is not ready for debugging Please check your configuration bit settings and program the device before proceeding You will receive this message when you have not programmed your device for the first time and try to Run If you receive this message after this or immediately after pro gramming your device please refer to Section 7 3 6 Debug Failure Actions An unknown exception has occurred Please unplug the MPLAB ICD 3 and reconnect The Target is held in reset Please ensure the MCLR line is pulled up or High Z d The Debug Executive is found but can t be communicated with Please ensure your oscillator settings are correct If the device supports internal RC try to connect via that mode first See also Section 7 3 2 Debugger to Target Communication Error Actions ICD 3 was unloaded while still busy Please unplug and reconnect the USB cable before using ICD 3 again Target device was not found You must connect to a target device to use MPLAB ICD 3 See also Section 7 3 2 Debugger to Target Communication Error Actions 2012 Microchip Technology Inc DS52081A page 49 MPLAB ICD 3 User s Guide for MPLAB X IDE 7 2 6 Hardware Firmware Errors For the errors below read any instructions within your error message The 17 5 rail is unable to turn on Please unplug the MPLAB ICD 3 and reconnect If the problem persists contact Microchip for assistance The SRAM has failed its self test Please unplug the MP
74. is treated as a whole by the linker PWM Signals Pulse Width Modulation Signals Certain PIC MCU devices have a PWM peripheral Q Qualifier An address or an address range used by the Pass Counter or as an event before another operation in a complex trigger R Radix The number base hex or decimal used in specifying an address RAM Random Access Memory Data Memory Memory in which information can be accessed in any order Raw Data The binary representation of code or data associated with a section Read Only Memory Memory hardware that allows fast access to permanently stored data but prevents addition to or modification of the data Real Time When an in circuit emulator or debugger is released from the halt state the processor runs in Real Time mode and behaves exactly as the normal chip would behave In Real Time mode the real time trace buffer of an emulator is enabled and constantly captures all selected cycles and all break logic is enabled In an in circuit emulator or debugger the processor executes in real time until a valid breakpoint causes a halt or until the user halts the execution In the simulator real time simply means execution of the microcontroller instructions as fast as they can be simulated by the host CPU Recursive Calls A function that calls itself either directly or indirectly Recursion The concept that a function or macro having been defined can call itself Great care should be
75. ject File Format An object file of this format contains machine code debugging and other information Command Line Interface A means of communication between a program and its user based solely on textual input and output Compiled Stack A region of memory managed by the compiler in which variables are statically allocated space It replaces a software or hardware stack when such mechanisms cannot be effi ciently implemented on the target device Compiler A program that translates a source file written in a high level language into machine code Conditional Assembly Assembly language code that is included or omitted based on the assembly time value of a specified expression Conditional Compilation The act of compiling a program fragment only if a certain constant expression specified by a preprocessor directive is true Configuration Bits Special purpose bits programmed to set PIC microcontroller modes of operation A Configuration bit may or may not be preprogrammed Control Directives Directives in assembly language code that cause code to be included or omitted based on the assembly time value of a specified expression CPU See Central Processing Unit 2012 Microchip Technology Inc DS52081A page 71 MPLAB ICD 3 User s Guide for MPLAB X IDE Cross Reference File A file that references a table of symbols and a list of files that references the symbol If the symbol is defined the first file lis
76. lock and data connections are interfaces with the following characteristics Clock and data signals are in high impedance mode even when no power is applied to the MPLAB ICD 3 In Circuit Debugger system Clock and data signals are protected from high voltages caused by faulty targets systems or improper connections Clock and data signals are protected from high current caused from electrical shorts in faulty target systems FIGURE 9 1 6 PIN STANDARD PINOUT Standard Socket Pin Name Function 1 Power 2 VDD_TGT Power on target Bottom of 3 GND Ground O Target Board 4 PGD ICSPDAT Standard Com Data Jom 5 PGC ICSPCLK Standard Com Clock 6 PGM LVP Low Voltage Programming TABLE 9 1 ELECTRICAL LOGIC TABLE Logic Inputs ViH VDD 0 7 min VIL VDD 0 3V max Logic Outputs VDD 5V VDD 3V VDD 2 3V VDD 1 65V 3 8V VOH 2 4V min VOH 1 9V min VOH 1 2 min VOL 0 55V max VOL 0 55V VOL 0 3V max VoL 0 45V max Note 1 Loading PGC PGD 4 7K ohm load to ground 2012 Microchip Technology Inc DS52081A page 63 MPLAB ICD 3 User s Guide for MPLAB X IDE 9 5 2 Modular Cable and Connector For standard communications a modular cable connects the debugger and the target application The specifications for this cable and its connectors are listed below
77. m union tag names etc Symbols in MPLAB IDE MPLAB X IDE refer mainly to variable names function names and assembly labels The value of a symbol after linking is its value in memory Symbol Absolute Represents an immediate value such as a definition through the assembly equ directive System Window Control The system window control is located in the upper left corner of windows and some dia logs Clicking on this control usually pops up a menu that has the items Minimize Maximize and Close 2012 Microchip Technology Inc DS52081A page 85 MPLAB ICD 3 User s Guide for MPLAB X IDE T Target Refers to user hardware Target Application Software residing on the target board Target Board The circuitry and programmable device that makes up the target application Target Processor The microcontroller device on the target application board Template Lines of text that you build for inserting into your files at a later time The MPLAB Editor stores templates in template files Tool Bar A row or column of icons that you can click on to execute MPLAB IDE MPLAB X IDE functions Trace An emulator or simulator function that logs program execution The emulator logs pro gram execution into its trace buffer which is uploaded to MPLAB IDE MPLAB X IDE s trace window Trace Memory Trace memory contained within the emulator Trace memory is sometimes called the trace buffer Trace Macro A macro th
78. me processors have several interrupt request events allowing different priority interrupts Interrupt Service Routine ISR Language tools A function that handles an interrupt MPLAB IDE MPLAB X IDE User generated code that is entered when an interrupt occurs The location of the code in program memory will usually depend on the type of interrupt that has occurred Interrupt Vector Address of an interrupt service routine or interrupt handler L L value An expression that refers to an object that be examined and or modified An l value expression is used on the left hand side of an assignment Latency The time between an event and its response Library Librarian See Archive Archiver DS52081A page 76 2012 Microchip Technology Inc Glossary Linker language tool that combines object files and libraries to create executable code resolving references from one module to another Linker Script Files Linker script files are the command files of a linker They define linker options and describe available memory on the target platform Listing Directives Listing directives are those directives that control the assembler listing file format They allow the specification of titles pagination and other listing control Listing File listing file is an ASCII text file that shows the machine code generated for each source statement assembly instruction assembler directive or macro encountered
79. ochip Technology Inc DS52081A page 17 MPLAB ICD 3 User s Guide for MPLAB X IDE FIGURE 2 2 STANDARD DEBUGGER SYSTEM ICE DEVICE Processor Pak Standard Adapter 1n Circuit Debugger MEANS E ep Di MICROCHIP Power DS52081A page 18 2012 Microchip Technology Inc Operation 2 4 TARGET COMMUNICATION CONNECTIONS 2 4 1 Standard Communication Target Connection Using the RJ 11 connector the MPLAB ICD 3 In Circuit Debugger is connected to the target device with the modular interface six conductor cable The pin numbering for the connector is shown from the bottom of the target PC board in Figure 2 3 Note Cable connections at the debugger and target are mirror images of each other i e pin 1 on one end of the cable is connected to pin 6 on the other end of the cable See Section 9 5 2 3 Modular Cable Specification FIGURE 2 3 STANDARD CONNECTION AT TARGET Target Connector 2 4 2 Target Connection Circuitry Figure 2 4 shows the interconnections of the MPLAB ICD 3 In Circuit Debugger to the connector on the target board The diagram also shows the wiring from the connector to a device on the target PC board A pull up resistor usually around 10 connected from the VPP MCLR line to the VDD is recommended so that the line may be strobed low to reset the device FIGURE 2 4 STANDARD CONNECTION TARGET CIRCUITRY VDD
80. or devices with multiple PGC PGD pin pairs 11 Other configuration settings are interfering with debugging Any configuration setting that would prevent the target from executing code will also prevent the debugger from putting the code into debug mode 12 Brown Out Detect voltage is greater than the operating voltage VDD This means the device is in Reset and cannot be debugged 13 You have not followed the guidelines in Chapter 3 for communication connections 14 The debugger cannot always perform the action requested For example the debugger cannot set a breakpoint if the target application is currently running 5 4 OTHER THINGS TO CONSIDER 1 Itis possible the error was a one time glitch Try the operation again 2 There may be a problem programming in general As a test switch to program mer mode and program the target with the simplest application possible e g a program to blink an LED If the program will not run then you know that something is wrong with the target setup 3 Itis possible that the target device has been damaged in some way eg over current Development environments are notoriously hostile to components Consider trying another target device 4 Microchip offers myriad demonstration boards to support most of its microcon trollers Consider using one of these applications which are known to work to verify correct MPLAB ICD 3 In Circuit Debugger functionality Or use the Loop Back Test board to verif
81. p dsPIC DSC devices Digital Signal Processing Digital Signal Processor Digital signal processing DSP is the computer manipulation of digital signals com monly analog signals sound or image which have been converted to digital form sam pled A digital signal processor is a microprocessor that is designed for use in digital signal processing Directives Statements in source code that provide control of the language tool s operation Download Download is the process of sending data from a host to another device such as an emulator programmer or target board DWARF Debug With Arbitrary Record Format DWARF is a debug information format for ELF files DS52081A page 72 2012 Microchip Technology Inc Glossary 5 Electrically Erasable Programmable Read Only Memory special type of PROM that can be erased electrically Data is written or erased one byte at a time EEPROM retains its contents even when power is turned off ELF Executable and Linking Format An object file of this format contains machine code Debugging and other information is specified with DWARF ELF DWARF provide better debugging of optimized code than Emulation Emulator See ICE ICD Endianness The ordering of bytes in a multi byte object Environment MPLAB A folder containing files on how to program a device This folder can be transferred to a SD MMC card Epilogue A portion of compiler
82. pe Choice of mutually exclusive errorlevel 011 character arguments an OR selection Ellipses Replaces repeated text var_name var_name Represents code supplied void main void user DS52081A page 8 2012 Microchip Technology Inc Preface RECOMMENDED READING This user s guide describes how to use MPLAB ICD 3 in circuit debugger Other useful documents are listed below The following Microchip documents are available and recommended as supplemental reference resources In Circuit Debugger Design Advisory DS51764 Please read this first This document contains important information about operational issues that should be considered when using the MPLAB ICD 3 with your target design Release Notes for MPLAB ICD 3 In Circuit Debugger For the latest information on using MPLAB ICD 3 in circuit debugger read the Readme for MPLAB ICD 3 Debugger htm file an HTML file in the Readmes subdirectory of the MPLAB X IDE installation directory The release notes Readme contains update information and known issues that may not be included in this user s guide Using MPLAB ICD 3 In Circuit Debugger Poster DS52011 This poster shows you how to hook up the hardware and install the software for the MPLAB ICD 3 In Circuit Debugger using standard communications and a target board MPLAB ICD 3 In Circuit Debugger Online Help File A comprehensive help file for the debugger is include
83. pheral be aware that some peripherals have no freeze on halt capability and cannot be controlled by the debugger To select all peripherals including All Other Peripherals click Check All To deselect all peripherals including All Other Peripherals click Uncheck All 8 3 6 Clock Set the option to use the fast internal RC clock for selected device TABLE 8 7 CLOCK OPTION CATEGORY Use FRC in debug mode When debugging use the device fast internal RC FRC for clock dsPIC33F and PIC24F H ing instead of the oscillator specified for the application This is devices only useful when the application clock is slow Checking this checkbox will let the application run at the slow speed but debug at the faster FRC speed Reprogram after changing this setting Note Peripherals that are not frozen will operate at the FRC speed while debugging SR 2012 Microchip Technology Inc DS52081A page 59 MPLAB ICD 3 User s Guide for MPLAB X IDE 8 3 7 Power Select power options TABLE 8 8 POWER OPTION CATEGORY Power target circuit from ICD 3 If you enable check this option the Power on off button will be enabled on the toolbar It will initially be in the Power On state Every time it is clicked it will toggle to the opposite state If it is on it will toggle to off and if it is off it will toggle to on If the Power target circuit setting is disabled unchecked the Power on off button will go back
84. r and simulator MPLAB PM3 device programmer from Microchip Programs PIC18 microcontrollers and dsPIC digital signal controllers Can be used with MPLAB IDE MPLAB X IDE or stand alone Replaces PRO MATE Il MPLAB REAL ICE In Circuit Emulator Microchip s next generation in circuit emulator that works with MPLAB IDE MPLAB X IDE See ICE ICD MPLAB SIM Microchip s simulator that works with MPLAB IDE MPLAB X IDE in support of PIC MCU and dsPIC DSC devices MPLIB Object Librarian Microchip s librarian that can work with MPLAB IDE MPLAB X IDE MPLIB librarian is an object librarian for use with COFF object modules created using either MPASM assembler mpasm or mpasmwin v2 0 or MPLAB C18 C Compiler MPLINK Object Linker MPLINK linker is an object linker for the Microchip MPASM assembler and the Micro chip C18 C compiler MPLINK linker also may be used with the Microchip MPLIB librar ian MPLINK linker is designed to be used with MPLAB IDE MPLAB X IDE though it does not have to be MRU Most Recently Used Refers to files and windows available to be selected from MPLAB IDE MPLAB X IDE main pull down menus N Native Data Size For Native trace the size of the variable used in a Watch window must be of the same size as the selected device s data memory bytes for PIC18 devices and words for 16 bit devices Nesting Depth The maximum level to which macros can include other macros Node MPLAB IDE MPLAB X I
85. r boards with ICD devices Device ICD may be used A transition socket is used with the ICE header to connect the header to the target board Transition sockets are available in various styles to allow a common header to be connected to one of the supported surface mount package styles For more information on transition sockets see the Transition Socket Specification 0551194 Header board layout will be different for headers or processor extension packs For connection information see Section 2 3 Debugger to Target Communication and Section 2 3 1 Standard ICSP Device Communication 4 3 3 Powering the Target There are a couple of configurations for powering MPLAB ICD 3 and the target These are configuration essentials When using the USB connection the MPLAB ICD 3 can be powered from the PC but it can only provide a limited amount of current up to 100 mA at VDD from 3 5V to a small target board The desired method is for the target to provide VDD as it can provide a wider voltage range from 2 5V The additional benefit is that plug and play target detection facility is inherited i e MPLAB X IDE will let you know in the Output window when it has detected the target and has detected the device Note The target voltage is only used for powering up the drivers for the ICSP interface the target voltage does not power up the MPLAB ICD 3 The MPLAB ICD 3 system power is derived strictly from the USB port If
86. ram in binary machine code consists of a sequence of machine instructions possibly interspersed with data The collection of all possible instructions for a particular processor is known as its instruction set Machine Language A set of instructions for a specific central processing unit designed to be usable by a processor without being translated 2012 Microchip Technology Inc DS52081A page 77 MPLAB ICD 3 User s Guide for MPLAB X IDE Macro Macro instruction An instruction that represents a sequence of instructions in abbrevi ated form Macro Directives Directives that control the execution and data allocation within macro body definitions Makefile Export to a file the instructions to Make the project Use this file to Make your project outside of MPLAB IDE MPLAB X IDE i e with a make Make Project A command that rebuilds an application recompiling only those source files that have changed since the last complete compilation MCU Microcontroller Unit An abbreviation for microcontroller Also uC Memory Model For C compilers a representation of the memory available to the application For the PIC18 C compiler a description that specifies the size of pointers that point to program memory Message Text displayed to alert you to potential problems in language tool operation A message will not stop operation Microcontroller A highly integrated chip that contains a CPU RAM program memory
87. resources Runtime Watch A Watch window where the variables change in as the application is run See individual tool documentation to determine how to set up a runtime watch Not all tools support runtime watches S Scenario For MPLAB SIM simulator a particular setup for stimulus control Section The GCC equivalent of an OCG psect A block of code or data which is treated as a whole by the linker Section Attribute A GCC characteristic ascribed to a section e g an access section Sequenced Breakpoints Breakpoints that occur in a sequence Sequence execution of breakpoints is bottom up the last breakpoint in the sequence occurs first Serialized Quick Turn Programming Serialization allows you to program a serial number into each microcontroller device that the Device Programmer programs This number can be used as an entry code password or ID number Shell The MPASM assembler shell is a prompted input interface to the macro assembler There are two MPASM assembler shells one for the DOS version and one for the Windows version 2012 Microchip Technology Inc DS52081A page 83 MPLAB ICD 3 User s Guide for MPLAB X IDE Simulator A software program that models the operation of devices Single Step This command steps though code one instruction at a time After each instruction MPLAB IDE MPLAB X IDE updates register windows watch variables and status dis plays so you can analyze and debug instruction e
88. rom the user s code in program memory to the debug executive Again the target application program is effectively halted and MPLAB X IDE uses the debugger communications with the debug executive to interrogate the state of the target device 2 7 PROGRAMMING WITH THE DEBUGGER Use the MPLAB ICD 3 as a programmer to program an actual non ICE ICD device i e a device not on a header board Set the MPLAB ICD 3 In Circuit Debugger as the current tool Edit gt Project Properties Advanced MPLAB Environment to perform these actions When Run gt Run Project is selected the application code is programmed into the device s memory via the ICSP protocol No clock is required while programming and all modes of the processor can be programmed including code protect Watchdog Timer enabled and table read protect A small program executive program may be loaded into the high area of program memory for some target device This increases programming speeds for devices with large memories Special in circuit debug registers in the target device are disabled by MPLAB X IDE along with all debug features This means that a breakpoint cannot be set and register contents cannot be seen or altered The target device is run in release mode As a programmer the debugger can only toggle the MCLR line to Reset and start the target 2 8 RESOURCES USED BY THE DEBUGGER For a complete list of resources used by the debugger for your device please see
89. s data rates up to 480 Mbps V Vector The memory locations that an application will jump to when either a Reset or interrupt occurs Volatile A variable qualifier which prevents the compiler applying optimizations that affect how the variable is accessed in memory W Warning MPLAB IDE MPLAB X IDE An alert that is provided to warn you of a situation that would cause physical damage to a device software file or equipment 16 bit assembler compiler Warnings report conditions that may indicate a problem but do not halt processing In MPLAB C30 warning messages report the source file name and line number but include the text warning to distinguish them from error messages Watch Variable A variable that you may monitor during a debugging session in a Watch window Watch Window Watch windows contain a list of watch variables that are updated at each breakpoint Watchdog Timer WDT A timer on a PIC microcontroller that resets the processor after a selectable length of time The WDT is enabled or disabled and set up using Configuration bits Workbook For MPLAB SIM stimulator a setup for generation of SCL stimulus EG C 2012 Microchip Technology Inc DS52081A page 87 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 88 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Index A H Auxilliary Memory 58 Header Board Ne RTE 20
90. s than 100 mA Cable Length The PC to debugger cable length for proper operation is shipped in the debugger kit Powered Hubs If you are going to use a USB hub make sure it is self powered Also USB ports on PC keyboards do not have enough power for the debugger to operate PC Hibernate Power Down Modes Disable the hibernate or other power saver modes on your PC to ensure proper USB communications with the debugger 2012 Microchip Technology Inc DS52081A page 61 MPLAB ICD 3 User s Guide for MPLAB X IDE 9 4 MPLAB ICD 3 DEBUGGER The debugger consists of a main board enclosed in the casing with a USB connector and an RJ 11 connector On the debugger enclosure are indicator lights LEDs 9 4 1 Main Board This component has the interface processor dsPIC DSC the USB 2 0 interface capable of USB speeds of 480 Mb sec a Field Programmable Gate Array FPGA for general system control and increased communication throughput an SRAM for holding the program code image for programming into the emulation device on board Flash and LED indicators 9 4 2 Indicator Lights LEDs The indicator lights have the following significance LED Color Description Active Blue Lit when power is first applied or when target is connected Status Green Lit when the debugger is operating normally standby Red Lit when an operation has failed Orange Lit when the debugger is busy DS52081A page
91. ted is the location of the definition The remaining files contain references to the symbol D Data Directives Data directives are those that control the assembler s allocation of program or data memory and provide a way to refer to data items symbolically that is by meaningful names Data Memory On Microchip MCU and DSC devices data memory RAM is comprised of General Purpose Registers GPRs and Special Function Registers SFRs Some devices also have EEPROM data memory Data Monitor and Control Interface DMCI The Data Monitor and Control Interface or DMCI is a tool in MPLAB X IDE The inter face provides dynamic input control of application variables in projects Applica tion generated data can be viewed graphically using any of 4 dynamically assignable graph windows Debug Debugger See ICE ICD Debugging Information Compiler and assembler options that when selected provide varying degrees of infor mation used to debug application code See compiler or assembler documentation for details on selecting debug options Deprecated Features Features that are still supported for legacy reasons but will eventually be phased out and no longer used Device Programmer A tool used to program electrically programmable semiconductor devices such as microcontrollers Digital Signal Controller A A digital signal controller DSC is a microcontroller device with digital signal process ing capability i e Microchi
92. the online help file in MPLAB X IDE for the MPLAB ICD 3 In Circuit Debugger 2012 Microchip Technology Inc DS52081A page 25 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 26 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Part 2 Features Chapter 3 General Setup WEEN 29 Chapter 4 Common Debug Functions 33 2012 Microchip Technology Inc DS52081A page 27 MPLAB ICD 3 User s Guide for MPLAB X IDE NOTES DS52081A page 28 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Chapter 3 General Setup 3 1 INTRODUCTION How to get started using the MPLAB ICD 3 In Circuit Debugger is discussed Installation and Setup Common Debug Features Debugger Specific Debug Features Quick Debug Program Reference Debugger Programmer Limitations 3 2 INSTALLATION AND SETUP Refer to the Help file Getting Started with MPLAB X IDE for details on installing the IDE and setting up the debugger to work with it In summary 1 2 3 e 8 Install MPLAB X IDE Install the USB drivers as specified Connect to the PC For more information on target connections see Chapter 2 Operation Note The debugger CANNOT power a target board Install the language toolsuite compiler you want to use for development Launch MPLAB X IDE Use the New Project wizard File gt
93. to the disabled state Whatever state it is in when the project was last saved will be the state that it is in when the project is reopened Voltage Level If the checkbox above is checked select the target Vdd 3 0v 3 5v that the debugger will provide EEE DS52081A page 60 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Chapter 9 Hardware Specification 9 1 INTRODUCTION The hardware and electrical specifications of the MPLAB ICD 3 In Circuit Debugger system are detailed 9 2 HIGHLIGHTS This chapter discusses USB Port Power MPLAB ICD 3 Debugger Standard Communication Hardware ICD 3 Test Interface Board Target Board Considerations 9 3 USB PORT POWER The MPLAB ICD 3 In Circuit Debugger is connected to the host PC via a Universal Serial Bus USB port version 2 0 compliant The USB connectoris located on the side of the pod The system is capable of reloading the firmware via the USB interface System power is derived from the USB interface The debugger is classified as a high power system per the USB specification and requires 300 mA of power from the USB to function in all operational modes debugger programmer Note The MPLAB ICD In Circuit Debugger is powered through its USB connec tion The target board is powered from its own supply Alternatively the MPLAB ICD 3 can power it only if the target consumes les
94. translation for target low voltage operation If the debugger does not sense voltage on its VDD line pin 2 of the interface connector it will not allow communication with the target Not all devices have the AVDD and AVss lines but if they are present on the target device all must be connected to the appropriate levels in order for the debugger to operate In general it is recommended that all VDD AVDD and Vss AVss lines be connected to the appropriate levels Also devices with a VCAP line PIC18FXXY for example should be connected to the appropriate capacitor or level Note The interconnection is very simple Any problems experienced are often caused by other connections or components on these critical lines that interfere with the operation of the MPLAB ICD 3 In Circuit Debugger System as discussed in the following section DS52081A page 20 2012 Microchip Technology Inc Operation 2 4 5 Circuits That Will Prevent the Debugger From Functioning Figure 2 5 shows the active debugger lines with some components that will prevent the MPLAB ICD 3 In Circuit Debugger system from functioning FIGURE 2 5 IMPROPER CIRCUIT COMPONENTS VPP MCLR STATUS i Crcuit Debusse ICD 3 MICROCHIP Interface Connector Specifically these guidelines must be followed Do not use pull ups on PGC PGD they will disrupt the voltage levels since these lines have 4 7 KQ pull down resistors in the debug
95. ventions Used in this Guide Recommended Reading DOCUMENT LAYOUT This document describes how to use the MPLAB ICD 3 in circuit debugger as a development tool to emulate and debug firmware on a target board as well as how to program devices The document is organized as follows Part 1 Getting Started Chapter 1 About the Debugger What the MPLAB ICD 3 in circuit debugger is and how it can help you develop your application Chapter 2 Operation The theory of MPLAB ICD 3 in circuit debugger operation Explains configuration options Part 2 Features Chapter 6 General Setup How to set up MPLAB X IDE to use the debugger Chapter 4 Common Debug Functions A description of basic debug features available in MPLAB X IDE when the MPLAB ICD 3 in circuit debugger is chosen as the debug tool This includes the debug features breakpoints and stopwatch Part 2 Troubleshooting Chapter 5 Troubleshooting First Steps The first things you should try if you are having issues with debugger operation 2012 Microchip Technology Inc DS52081A page 7 MPLAB ICD 3 User s Guide for MPLAB X IDE Chapter 6 Frequently Asked Questions FAQs A list of frequently asked questions useful for troubleshooting Chapter 7 Messages A list of error messages and suggested resolutions Part 3 Reference Chapter 8 Debugger Function Summary A summary of debugger functions available in MPLA
96. ware Check to use the latest firmware Uncheck to select the firmware version below Firmware File Click in the right hand text box to search for a firmware file jam to associate with the debugger 8 3 3 Program Options Choose to erase all memory before programming or to merge code TABLE 8 3 PROGRAM OPTIONS OPTION CATEGORY Erase All Before Check to erase all memory before programming begins Program Unless programming new or already erased devices it is important to have this box checked If not checked the device is not erased and program code will be merged with the code already in the device Enable Low Voltage Programming For Programmer Settings only PIC12F 16F1xxx devices Forthe LVP configuration bit set to Low voltage programming enabled you may program in either high voltage default or low voltage enabled here Forthe LVP configuration bit set to High voltage on MCLR Vpp must be used for programming you may only program in high voltage DS52081A page 58 2012 Microchip Technology Inc 8 3 4 Debugger Function Summary Debug Options Use software breakpoints if available for the project device TABLE 8 4 DEBUG OPTIONS OPTION CATEGORY Use Software Breakpoints Check to use software breakpoints Uncheck to use hardware break points See discussion below to determine which type is best for your application TABL
97. xecution You can also single step C compiler source code but instead of executing single instructions MPLAB IDE MPLAB X IDE will execute all assembly level instructions generated by the line of the high level C statement Skew The information associated with the execution of an instruction appears on the proces sor bus at different times For example the executed opcodes appears on the bus as a fetch during the execution of the previous instruction the source data address and value and the destination data address appear when the opcodes is actually executed and the destination data value appears when the next instruction is executed The trace buffer captures the information that is on the bus at one instance Therefore one trace buffer entry will contain execution information for three instructions The number of cap tured cycles from one piece of information to another for a single instruction execution is referred to as the skew Skid When a hardware breakpoint is used to halt the processor one or more additional instructions may be executed before the processor halts The number of extra instructions executed after the intended breakpoint is referred to as the skid Source Code The form in which a computer program is written by the programmer Source code is written in a formal programming language which can be translated into machine code or executed by an interpreter Source File An ASCII text file containing source code
98. y disable or delete the breakpoint or close and reopen the workspace Q Iclicked the Cancel button when asked to download the latest firmware but now I want to download the firmware How do I do this A You can download it manually Select Debugger gt Settings Configuration tab and click Manual Download Select the highest number jam file and click Open Or you can exit MPLAB X IDE and enable the debugger to start it automatically Q laccidentally disconnected my debugger while firmware was downloading What do I do now A Reconnect the debugger It will begin to erase what had been written so it can restart This erasing will take about 7 seconds Please be patient The LEDs are all on during this process When it is done MPLAB X IDE will recognize the device and start the recovery process i e begin firmware download Q don t see my problem here Now what A Try the following resources Chapter 2 Operation Section 7 2 Specific Error Messages Section 7 3 General Corrective Actions Section 7 4 Information Messages DS52081A page 46 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Chapter 7 Messages 7 1 INTRODUCTION The MPLAB ICD 3 In Circuit Debugger produces many different error messages some are specific some are informational and others can be resolved with general corrective actions Specific Error Messages General Corrective Actions In
99. y the debugger itself Section 9 6 ICD 3 Test Interface Board 5 Review debugger debug operation to ensure proper application setup Chapter 2 Operation 6 Ifthe problem persists contact Microchip DS52081A page 42 2012 Microchip Technology Inc MPLAB ICD 3 USER S GUIDE MICROCHIP FOR MPLAB X IDE Chapter 6 Frequently Asked Questions FAQs 6 1 INTRODUCTION Look here for answers to frequently asked questions about the MPLAB ICD 3 In Circuit Debugger system How Does It Work What s Wrong 6 2 HOW DOES IT WORK Q What s in the silicon that allows it to communicate with the MPLAB ICD 3 In Circuit Debugger A MPLAB ICD 3 In Circuit Debugger can communicate with Flash silicon via the ICSP interface It uses the debug executive located in test memory How is the throughput of the processor affected by having to run the debug executive A The debug executive doesn t run while in Run mode so there is no throughput reduction when running your code i e the debugger doesn t steal any cycles from the target device How does the MPLAB ICD 3 In Circuit Debugger compare with other in circuit emulators debuggers A Please refer to Section 2 2 Tools Comparison How does MPLAB X IDE interface with the MPLAB ICD 3 In Circuit Debugger to allow more features than older debuggers A MPLAB ICD 3 In Circuit Debugger communicates using the debug executive located in the test area The debug

MPLAB ICD 3 In-Circuit Debugger User's Guide for

Contents

Download Pdf Manuals

Related Search

Related Contents