DV164035 - Microchip Technology

MPLAB® ICD 3

In-Circuit Debugger

User’s Guide

Information contained in this publication regarding device

applications a nd the lik e is p ro vided on ly for yo ur con ve nien ce

and may be supers eded by up dates. I t is you r r es ponsibil it y to

ensure that your application meets with your specifications.

MICROCHIP MAKES NO REPRESENTATIONS OR

WARRANTIES OF ANY KIND WHETHER EXPRESS OR

IMPLIED, WRITTEN OR ORAL, STATUTORY OR

OTHERWISE, RELATED TO THE INFORMATION,

INCLUDING BUT NOT LIMITED TO ITS CONDITION,

QUALITY, PERFORMANCE, MERCHANTABILITY OR

FITNESS FOR PURPOSE. Microchip disclaims all liability

arising from this information and its use. Use of Microchip

devices in life support and/or safety applications is entirely at

the buyer’s risk, and the buyer agrees to defend, indemnify and

hold harmless Microchip from any and all damages, claims,

suits, or expenses resulting from such use. No licenses are

conveyed, implicitly or otherwise, under any Microchip

intellectual property rights.

Trademarks

The Microchip name and logo, the Microchip logo, Accuron,

dsPIC, KEELOQ, KEELOQ logo, MPLAB, PIC, PICmicro,

PICSTART, rfPIC, SmartS hunt and UNI/O are registered

trademarks of Microchip Technology Incorporated in the

U.S.A. and other countries.

FilterLab, Linear Active Thermistor, MXDEV, MXLAB,

SEEV AL, SmartSensor and The Embedded Control Solutions

Company are registered trademarks of Microchip Technology

Incorporated in the U.S.A.

Analog-for-the-Digital Age, Application Maestro, CodeGuard,

dsPICDEM, dsPICDEM.net, dsPICworks, dsSPEAK, ECAN,

ECONOMONITOR, FanSense, In-Circuit Serial

Prog ra m ming , IC SP, IC EPIC , M i n di , MiWi, MPASM, MP LA B

Certified logo, MPLIB, MPLINK, mTouch, PICkit, PICDEM,

PICDEM.net, PICtail , PIC32 logo, PowerCal, PowerInfo,

PowerMate, PowerTool, REAL ICE, rfLAB, Select Mode, Total

Endurance, WiperLock and ZENA are trademarks of

Microchip Technology Incorporated in the U.S.A. and other

countries.

SQTP is a service mark of Microchip T echnology Incorporated

in the U.S.A.

All other trademarks mentioned herein are property of their

respective companies.

Printed on recycled paper.

Note the following details of the code protecti on feature on Microch ip devices:

• Microchip products meet the specification contained in their particular Microchip Data Sheet.

• Microchip believes that its family of products is one of the most secure families of its kind on the market today, when used in the

intended manner and under normal conditions.

• There are dishonest and possibly illegal methods used to breach the code protection feature. All of these methods, to our

knowledge, require using the Microchip products in a manner outside the operating specifications contained in Microchip’s Data

Sheets. Most likely, the person doing so is engaged in theft of intellectual property.

• Microchip is willing to work with the customer who is concerned about the integrity of their code.

• Neither Microchip nor any other semiconductor manufacturer can guarantee the security of their code. Code protection does not

mean that we are guaranteeing the product as “unbreakable.”

Code protection is constantly evolving. We at Microchip are committed to continuously improving the code protection features of our

products. Attempts to break Microchip’s code protection feature may be a violation of the Digit al 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.

Microchip received ISO/TS-16949:2002 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, microperiph erals, nonvolatile memory and

analog products. In addition, Microchip’s quality system for the design

and manufacture of development systems is ISO 9001:2000 certified.

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Table of Contents

Preface ...........................................................................................................................1

Part 1 –Getting Started

Chapter 1. Overview

1.1 Introduction ..................................................................................................... 9

1.2 MPLAB ICD 3 In-Circuit Debugger Defined ...................................................9

1.3 How the MPLAB ICD 3 In-Circuit Debugger Helps You ...............................10

1.4 MPLAB ICD 3 In-Circuit Debugger Kit Components ... .............. ............... .. ..10

1.5 Device and Feature Support ........................................................................11

Chapter 2. Theory of Operatio n

2.1 Introduction ................................................................................................... 13

2.2 MPLAB ICD 3 In-Circuit Debugger vs. MPLAB ICE 2000/4000

In-Circuit Emulators ................................................................................ 13

2.3 MPLAB ICD 3 In-Circuit Debugger vs. MPLAB ICD 2 Debugger ................. 13

2.4 Debugger To Target Communication ........................... .. ............... ...............14

2.5 Communication Connections .......................................................................15

2.6 Debugging with the Debugger ................... ...................................................17

2.7 Re qu ireme n ts Fo r De b ug g i ng ............ ........... ....... ...... ....... ....... ........... ...... ... 1 8

2.8 Programming with the Debugger ..................................................................20

2.9 Resources Used by the Debugger ...............................................................20

Chapter 3. Installation

3.1 Introduction ................................................................................................... 21

3.2 Installing the Software .................................................................................. 21

3.3 Install in g th e USB De vice Dr ivers .... ...... ....... ....... ...... ....... .. ....... ...... ....... ..... 21

3.4 Co nn e c ting the T a rg e t ...... ... .. ...... ....... ....... ...... ....... .. ....... ...... ....... ....... ...... ... 2 2

3.5 Setting Up the Target Board ......................................................................... 22

3.6 Setting Up MPLAB IDE ................................................................................ 23

Chapter 4. General Setup

4.1 Introduction ................................................................................................... 25

4.2 Starting the MPLAB IDE Software ................................................................ 25

4.3 Creating a Project ......................................................................................... 26

4.4 Vie w in g th e Pr o je c t ....... ....... .. ...... ....... ....... ...... ....... ....... ...... ....... ...... ....... ..... 26

4.5 Bui ld in g th e Pr o je c t .... ...... ....... .. ....... ...... ....... ....... ...... ....... ....... ...... ....... ...... . 26

4.6 Set ting Con fi g urati o n B it s .......... ........... ....... ...... ....... ....... ...... ....... ....... ...... ... 2 7

4.7 Setting t he Debugger as the Debugger or Programmer ......... ......................27

4.8 Debugger/Programmer Limitations .............................................................. 27

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

Chapter 5. Tutorial

5.1 Introduction ................................................................................................... 29

5.2 Set ting Up th e Env i r o n m e n t an d S e le c tin g th e D ev i ce ..... ....... ....... ...... ....... . 30

5.3 Creating the Application Code ...................................................................... 30

5.4 Ru nn ing the P ro je c t Wizar d .. .. ....... ....... ...... ....... ...... ....... ....... ...... ....... ....... ... 3 3

5.5 Vie w in g th e Pr o je c t .. .. ....... ...... ....... ....... ...... ....... ...... ....... ....... ...... ... ...... ....... . 35

5.6 Vie w in g D e bu g Op tions .. ...... ....... ...... ....... ....... ...... .. ....... ....... ...... ....... ....... ... 3 6

5.7 Cre a ting a Hex File .. .. ....... ...... ....... ....... ...... ....... ...... ....... ....... ...... ....... ....... ... 3 7

5.8 Setting Up the Demo Board ......................................................................... 39

5.9 Loading Progra m Code For Debugging ............... ........................................39

5.10 Running Debug Code ................................................................................. 40

5.11 Debugging Code Using Breakpoints .......................................................... 40

5.12 Programming the Application ..................................................................... 45

Part 2 –Troubleshooting

Chapter 6. Frequently Asked Questions (FAQs)

6.1 Introduction ................................................................................................... 49

6.2 How Does It Work ........................................................................................ 49

6.3 What’s Wrong ............................................................................................... 50

Chapte r 7. Error Mess ages

7.1 Introduction ................................................................................................... 53

7.2 Specific Error Messages .............................................................................. 53

7.3 Ge n er a l C o rr e ct iv e Ac t io n s .. .. ....... ....... ...... ....... ...... ....... ....... .. ....... ...... ....... . 57

Part 3 –Reference

Chapter 8. Basic Debug Functions

8.1 Introduction ................................................................................................... 63

8.2 Bre a k p oi n ts .... ....... ...... ....... ....... ...... ....... ...... ....... ....... ...... ....... .. ....... ...... ...... 63

8.3 Sto p w a tc h ... ...... ....... ....... ...... ....... ...... ... ...... ....... ...... ....... ....... ...... ....... ....... ... 6 3

Chapter 9. Debugger Funct ion Summary

9.1 Introduction ................................................................................................... 65

9.2 Debugging Functions ................................. .................................................. 65

9.3 Debugging Dialogs/Windows ....................................................................... 68

9.4 Pro g ra mmin g Fun c tions ..... ....... ...... ....... ...... ....... ....... ...... ....... .. ....... ...... ...... 7 3

9.5 Set tings D ia lo g ........ ....... ...... ....... ...... ....... ....... ...... .. ....... ....... ...... ....... ....... ... 7 4

Table of Contents

Chapter 10. Hardware Specification

10.1 Intr o d uction .... ...... ....... ....... ...... ....... ...... ....... ....... ...... ... ...... ....... ...... ....... ..... 79

10.2 High lig h ts ....... ...... ... ...... ....... ...... ....... ....... ...... ....... ....... ...... ....... ...... ... ...... ... 7 9

10.3 Decl ar a tion of C o n fo rmity .. .. ...... ....... ....... ...... ....... ....... ...... ........... ....... ...... . 79

10.4 USB Po r t/Pow er ....... ...... ....... ....... ...... ........... ....... ....... ...... ....... ...... ....... ..... 80

10.5 MPLAB ICD 3 Debugger ................................ .. .................. .. .................. .. ..80

10.6 Standard C ommunication Hardware .......................................................... 81

10.7 ICD 3 T e s t In te rface Bo a rd .. .. .. ....... ...... ....... ....... ...... ....... ....... ...... ....... ...... . 82

10.8 Target Board Considerations ..................................................................... 83

Glossary .......................................................................................................................85

Index .............................................................................................................................99

Worldwide Sales and Service ..................................................................................102

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Preface

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 Lay out

• Conventions Used in this Guide

• Warranty Registration

• Recommended Reading

• The Microchip Web Site

• Development Systems Customer Change Notification Service

• Customer Support

• Revision History

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 Starte d

•Chapter 1. Overview – What the MPLAB ICD 3 in-circuit debugger is, and how it

can help you develop your application.

•Chapter 2. Theory of Operation – The theory of MPLAB ICD 3 in-circuit debug-

ger operation. Explains configuration options.

•Chapter 3. Ins tallation – How to install the debugger software and hardware.

•Chapter 4. General Setup – How to set up MPLAB IDE to use the debugger.

•Chapter 5. Tutorial – A brief tutorial on using the debugger.

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 “A” is the revision level of th e

document.

For the most up-to-date information on development tools, see the MPLAB® IDE on-line help.

Select the Help menu, and then Topics to open a list of available on-line help files.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

Part 2 – Troubleshooting

•Chapter 6. Frequently Asked Questions (FAQs) – A list of frequently asked

questions, useful for troubleshooting.

•Chapter 7. Error Messa g es – A list of error messages and suggested

resolutions.

Part 3 – Reference

•Chapter 8. Basic Debug Functions – A description of basic debugger features

available in MPLAB IDE when the MPLAB ICD 3 in-circuit debugger is chosen as

either the debug or programming tool. This includes the debug features

breakpoints, stopwatch, triggering and real-time watches.

•Chapter 9. Debugger Function Summary – A summary of debugger functions

available in MPLAB IDE when the MPLAB ICD 3 debugger is chosen as the

debug or program tool.

•Chapter 10. Hardware Specification – The hardware and electrical

specifications of the debugger system.

Preface

CONVENTIONS USED IN THIS GUIDE

This manu al us es the followi ng docum entatio n conv en tion s:

DOCUMENTATION CONVENTIONS

Description Represents Examples

Arial font:

Italic characters Referenced books MPLAB® IDE User’s Guide

Emphasized text ...is the only compile r...

Initial caps A window the Output window

A dialog the Settings dialog

A menu selection select Enable Programmer

Quotes A field name in a window or

dialog “Save project before build”

Underlined, italic text with

right angle bracket A menu path File>Save

Bold characters A dialog button Click OK

A tab Click the Power tab

N‘Rnnnn A number in verilo g forma t,

where N is the tota l number of

digit s, R is th e radi x and n is a

digit.

4‘b0010, 2‘hF1

Text in angle brackets < > A key on the keyboard Press <Enter>, <F1>

Courier New font:

Plain Courie r New Sample source code #define START

Filenames autoexec.bat

File paths c:\mcc18\h

Keywords _asm, _endasm, static

Command-line options -Opa+, -Opa-

Bit values 0, 1

Constants 0xFF, ‘A’

Italic Courier New A variable argument file.o, where file can be

any val id filena me

Square brackets [ ] Optional arguments mcc18 [options] file

[options]

Curly brackets and pipe

character: { | } Choice of mutually exclusive

arguments; an OR selection errorlevel {0|1}

Ellipses... Replaces repeated text var_name [,

var_name...]

Represents code supplied by

user void main (void)

{ ...

}

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

WARRANTY REGISTRATION

Please complete the enclosed Warranty Registration Card and mail it promptly.

Sending in the Warranty Registration Card entitles users to receive new product

updates. Interim software releases are available at the Microchip web site.

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.

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 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 (DS51765)

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 On-l ine Help File

A comprehensive help file for the debugger is included with MPLAB 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 ICD 3 in-circuit debugger

headers. Headers are used to better debug selected devices using special -ICE device

versions without the loss of pins or resources.

Transition Socket S pecification (DS51194)

Consult this document for information on transition sockets available for use with

MPLAB ICE 2000/4000 device adaptors, MPLAB ICD 2 headers and MPLAB ICD 3

in-circuit debugger headers.

Preface

THE MICROCHIP WEB SITE

Microchip provides online support via our web site at www.microchip.com. This web

site is used as a means to make files and information easily available to customers.

Accessible by using your favorite Internet browser, the web site contains the following

information:

•Product Support – Data sheets and errata, application notes and sample

programs, design resources, user’s guides and hardware support documents,

latest software releases and archived software

•General Technical Support – Frequently Asked Questions (FAQs), technical

support requests, online discussion groups, Microchip consultant program

member listing

•Business of Microchip – Product selector and ordering guides, latest Microchip

press releases, listing o f seminars and events, listings of Microchip sales offices,

distributors and factory representatives

DEVELOPMENT SYSTEMS CUSTOMER CHANGE NOTIFICATION SERVICE

Microchip’s customer notification service helps keep customers current on Microchip

products. Subscribers will receive e-mail notification whenever there are changes,

updates, revisions or errata related to a specified product family or development tool of

interest.

To register, access the Microchip web site at www.microchip.com, click on Customer

Change Notification and follow the registration instructions.

The Development Systems product group categories are:

•Compilers – The lat est infor mation o n Microc hip C compil ers, as semblers , linkers

and other language tools. These include all MPLAB C compilers; all MPLAB

assemblers (including MPASM™ assembler); all MPLAB linkers (including

MPLINK™ object linker); and all MPLAB librarians (including MPLIB™ object

librarian).

•Emulators – The latest information on Microchip in-circuit emulators.These

include the MPLAB REAL ICE™, MPLAB ICE 2000 and MPLAB ICE 4000

in-circuit emulators

•In-Circuit Debuggers – The latest information on the Microchip in-circuit

debuggers, the MPLAB ICD 2 in-circuit debugger and PICkit™ 2 debug express.

•MPLAB® IDE – The latest information on Microchip MPLAB IDE, the Windows®

Integrated Development Environment for development systems tools. This list is

focused on the MPLAB IDE, MPLAB IDE Project Manager, MPLAB Editor and

MPLAB SIM simulator, as well as general editing and debugging features.

•Programmers – The latest information on Microchip programmers. These include

the MPLAB PM3 and PRO MATE II device programmers and the PICSTART®

Plus and PICkit 1 and 2 development programmers.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

CUSTOMER SUPPORT

Users of Microchip products can receive assistance through several channels:

• Distributor or Representative

• Local Sales Office

• Field Application Engineer (FAE)

• Technical Support

Customers should contact their distributor , representative or field application engineer

(FAE) for support. Local sales offices are also available to help customers. A listing of

sales offices and locations is included in the back of this document.

Technical support is available through the web site at: http://support.microchip.com.

REVISION HISTORY

Revision A (September 2008)

This is the initial release of this document.

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Part 1 – Getting Started

Chapter 1. Overview....................................................................................................... 9

Chapter 2. Theory of Operatio n................. ..... ..................................... ..... .... ..... .........13

Chapter 3. Installation..................................................................................................21

Chapter 4. General Setu p............. ..... .... ........................................................ ..... ..... ....25

Chapter 5. Tutorial........................................................................................................29

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Chapter 1. Overview

1.1 INTRODUCTION

An overview of the MPLAB ICD 3 in-circuit debugger system is given.

• 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

• Device and Fe atu re Su ppo rt

1.2 MPLAB ICD 3 IN-CIRCUIT DEBUGGER DEFINED

The MPLAB ICD 3 in-circuit debugger is an in-circuit debugger that is controlled by a

PC running MPLAB IDE (v8.15 or greater) 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 PIC® 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 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 I/O port data input

In addition to debugger functions, the MPLAB ICD 3 in-circuit debugger system also

may be used as a development programmer.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

1.3 HOW THE MPLAB ICD 3 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

• Monito r inter nal file regis ter s

• Emulate full speed

• Program your device

1.4 MPLAB ICD 3 IN-CIRCUIT D EBUGGER 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 (also MPLAB ICD 2 compatible) to connect the MPLAB ICD 3 to a header

module or target board

4. MPLAB IDE Quick Start Guide (DS51281)

5. CD-ROM with MPLAB IDE software and on-line documentation

6. ICD 3 Test Interface Board

FIGURE 1-1: BASIC DEBUGGER SYSTEM

Additional hardware that may be ordered separately:

• Tra nsiti on soc k et

• ICD headers

• MPLAB processor extension kits

MPLAB® ICD 3

Modular Cable

to Target Board

USB Cable to PC

Indicator

Lights

or Header

Overview

1.5 DEVICE AND FEATURE SUPPORT

Table 1-1 and Table 1-2 show the current and future support for devices and device

features.

TABLE 1-1: 32-BIT AND 16-BIT (DATA MEMORY) DEVICES

Feature PIC32MX dsPIC33F,

PIC24F/H dsPIC30F

SMPS(1) dsPIC30F

Reset app lication C C C C

Run, Halt C C C C

Single Step C C C C

Animate C C C C

Full Speed Emulation C C C C

Hardware Break po ints C C C C

Advanced Breakpoints C C C C

Softw are Break po ints N C C C

Peripheral Freeze(2) C C C C

Break on data fetch or write C C C C

Break on Stack overflow C C C C

Stopwatch C C C N

Pass Counter C C C C

WDT overflow C C C N

Standard Speed Comm. C C C C

Processor Pak N F F N

Legend:

C = Current support

D = Support dependent on dev ic e

F = No support now, but planned in the future

N = Support Not Available

Note 1: Current Switch Mode Power Supply (SMPS) devices: dsPIC30F1010/2020/2023.

2: This feature operates differently depending on the selected device.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

TABLE 1-2: 8-BIT (DATA MEMORY) DEVICES

Feature PIC18FXXJ PIC18F,

PIC18F Enh,

PIC18FXXK PIC12F, PIC16F

Reset app lication C C C

Run, Halt C C C

Single Step C C C

Animate C C C

Full Speed Emulation C C C

Hardware Break po ints C C C

Advanced Breakpoints C C N

Softw are Break po ints C C N

Peripheral Freeze(1) C C C

Break on data fetch or write C C N

Break on Stack overflow C C N

Stopwatch C N N

Pass Counter C C N

WDT overflow C N N

Standard Speed Comm. C C C

Processor Pak F F F

Legend:

C = Current support

F = No support now, but planned in the future

N = Support Not Available

Note 1: This feature operates differently depending on the selected device.

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Chapter 2. Theory of Operation

2.1 INTRODUCTION

A simplified description of how the MPLAB ICD 3 in-circuit debugger system works is

provided here. It is intended to provide enough information so a target board can be

designed that is compatible with the debugger for both emulation and programming

operations. The basic theory of in-circuit emulation and programming is described so

that problems, if encountered, are quickly resolved.

• MPLAB ICD 3 In-Circuit Debugger vs. MPLAB ICE 2000/4000 In-Circuit

Emulators

• MPLAB ICD 3 In-Circuit Debugger vs. MPLAB ICD 2 Debugger

• Debugger To Target Communication

• Commun icati on Conn ection s

• Debugging with the Debugger

• Requirements For Debugging

• Programming with the Debugger

• Resources Used by the Debugger

2.2 MPLAB ICD 3 IN-CIRC UIT DEBUGGER VS. MPLAB ICE 2000/4000

IN-CIRCUIT EMULATORS

The MPLAB ICD 3 in-circuit debugger system is a next generation In-Circuit Debugger

(ICD) system. It differs from classical in-circuit emulator syste ms (e.g., MPLAB ICE

2000/4000) in a single, but important way: the production device and emulation device

are the same.

This is a great benefit since differences (errata) between the production silicon and

emulation silicon are eliminated. Additionally, as devices continue to operate at faster

speeds, traditional emulator systems present bottlenecks caused by internal busses

that must be carried off-chip to external memories and cannot offer full speed

emulation.

Another significant benefit is that there is no lead time between production silicon and

emulation silicon. Further , a problem encountered on a production board can be easily

debugged without having to install transition sockets and dealing with complicated

cabling systems and setups to have access to the application.

2.3 MPLAB ICD 3 IN-CIRCUIT DEBUGGER VS. MP LAB ICD 2 DEBUGGER

The MPLAB ICD 3 in-circuit debugger system is similar in function to the MPLAB ICD

2 in-circuit debugger system, but surpasses it in speed and functionality. The MPLAB

ICD 3 also:

• Featur es USB high sp eed

• Is USB powered

• Is a hardware accelerator

• Provides a programmable voltage power supply

• Eliminates the RS-232 port

• Includes a diagnostic self-test interface board

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

2.4 DEBUGGER TO TARGET COMMUNICATION

The debugger system configurations are discussed in the following sections.

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 either (1) inserted into a matching socket at the target, where

the target device is on the target board (Figure 2-1), or (2) inserted into a standard

adapter/header board combo (available as a Processor Pak), which in then plugged

into the target board (Figure 2-2).

For more on standard communication, see Chapter 10. “Hardware Specification”.

FIGURE 2-1: STANDARD DEBUGGER SYSTEM – DEVIC E WITH

ON-BOARD ICE CIRCUITRY

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.

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.

MPLAB® ICD 3

Target Board

Target Device

or PIM

Power

Theory of Operation

FIGURE 2-2: STANDARD DEBUGGER SYSTEM – ICE DEVICE

2.5 COMMUNICATION CONNECTIONS

2.5.1 S tandard 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.

FIGURE 2-3: STANDARD CONNECTION AT TARGET

2.5.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 kΩ) is

recommended to be connected from the VPP/MCLR line to VDD so that the line may be

strobed low to reset the device.

MPLAB® ICD 3

Target Board

Tran sition Socket

Device-ICE

Processor Pak

Standard

Adapter

Header

Device-ICE

ICD Header

Power

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 10.6.2.3 “Modular Cable Specification”.

Target

Connector

Target

Bottom Side

PC Board

VPP/MCLR Vss

PGC

VDD

PGDLVP

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

FIGURE 2-4: STANDARD CONNECTION TARGET CIRCUITRY

2.5.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 operate.

2.5.4 Debugger Powered

The internal debugger power is limited in two aspects: (1) the voltage range is not as

wide (3-5V); and (2) 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 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 operate.

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 (PIC18FXXJ for example) should

be connected to the appropriate capacitor or level.

/MCLR

PGC

PGD

User Reset

4.7K-10K

Interface

Connector

Application

PC Board

Device

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.

Theory of Operation

2.5.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-c ircu it debu gger system fro m func tio nin g.

FIGURE 2-5: IMPROPER CIRCUIT COMPONENTS

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 kΩ pull-down resistors in the debugger.

• 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.

2.6 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

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.

No!

VPP/MCLR

PGC

PGD

Interface

Connector

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

FIGURE 2-6: PROPER CONNECTIONS FOR PROGRAMMING

A 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

programmi ng lev el s 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.

2.7 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 IDE software via the

USB cable. See Chapter 3. “Installation” for details.

• The debugger must be connected as shown 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 device must have its configuration words programmed correctly:

- The oscillator Configuration bits should correspond to RC, XT, etc., depending

upon the target design.

- For some devices, the Watchdog T imer 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.

• LVP should be disabled.

Once the above conditions are met, you may proceed to the following:

• Sequence of Operations Leading to Debugging

• Debugging Details

2.7.1 Sequence of Operations Leading to Debugging

Given that the Requirements For Debugging are met, these actions can be performed

when the MPLAB ICD 3 in-circuit debugger is set as the current debugger from the

MPLAB IDE menu (Debugge r> Se le ct Tool>MPLAB ICD 3):

• The application code is compiled/assembled by selecting Project>Build

+5V

Programming

4.7 k

/MCLR

PGC

PGD

Internal Circuits

Voltage

Theory of Operation

Configuration>Debug.

• When Debugger>Program is selected, the application code is programmed into

the device’s memory via the ICSP protocol as described above.

• A small “debug executive” program is loaded into the high area of program

memory of the target device. Since the debug executive must reside in program

memory , 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. These allow

the debug executive to be activated by the debugger.

• The target device is held in Reset by keeping the VPP/MCLR line low.

2.7.2 Debugging Details

Figure 2-7 illustrates the MPLAB ICD 3 in-circuit debugger system when it is ready for

debugging.

FIGURE 2-7: MP LA B® ICD 3 IN-CIRCUIT DEBUGGER READY FOR

DEBUGGING

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 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 Debugger>Run function or the Run icon (forward arrow) is usually pressed

from MPLAB IDE. The debugger will then tell the 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 IDE. MPLAB 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

perform ed by the debu g execut iv e.

+5V

+12V

4.7 k

Inter nal Circ ui ts

Program

Memory

File

Registers

Internal

Debug

Registers

VPP/MCLR

PGC

PGD

Executive

Debug

Area Used by

Target

Running

must

for Debug

Executive

to Function

Area

VDD

Hardware

Stack Shared

by Debug Exec

Debug Exec

Reserved

for Debug

Executive

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

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 IDE will issue an error message.

Another way to get a breakpoint is to press the MPLAB IDE’s Halt button (the “pause”

symbol to the right of the Run arrow). This toggles the PGC and PGD lines so that the

in-circuit debug mechanism of the target device switches the Program Counter from the

user’s code in program memory to the debug executive. Again, the target application

program is effectively halted, and MPLAB IDE uses the debugger communications with

the debug executive to interrogate the state of the target device.

2.8 PROGRAMMING WITH THE DEBUGGER

Use the MPLAB ICD 3 in-circuit debugger as a programmer to program an actual (non

-ICE/-ICD) device, i.e., a device not on a header board. Select “MPLAB ICD 3” from

Programmer>Select Programmer and compile/assemble your application code with

the “Build Configuration” list box on the MPLAB IDE toolbar set to “Release”. Also, it

may be set by selecting Project>Build Configuration>Release.

All debug features are turned off or removed when the debugger is used as a

programmer. When using the Programmer>Program selection to program a device,

MPLAB IDE will disable the in-circuit debug registers so the MPLAB ICD 3 in-circuit

debugger will program only the target application code and the Configuration bits (and

EEPROM data, if available and selected) into the target device. The debug executive

will not be loaded. As a programmer, the debugger can only toggle the MCLR line to

reset and start the target. A breakpoint cannot be set, and register contents cannot be

seen or altered.

The MPLAB ICD 3 in-circuit debugger system programs the target using ICSP. VPP,

PGC and PGD lines should be connected as described previously . 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.

2.9 RESOURCES USED BY THE DEBUGGER

For a complete list of resources used by the debugger for your device, please see the

on-line help file in MPLAB IDE for the MPLAB ICD 3 in-circuit debugger.

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Chapter 3. Installation

3.1 INTRODUCTION

How to install the MPLAB ICD 3 in-circuit de bugger system is d iscussed.

• Installing the Software

• Installing the USB Device Drivers

• Connecting the Target

• Setting Up the Target Board

• Setting Up MPLAB IDE

3.2 INSTALLING THE SOFTWARE

To install the MPLAB IDE software, first acquire the latest MPLAB IDE installation

executable (MPxxxxx.exe, where xxxxx represents the version of MPLAB IDE) from

either the Microchip web site (www.microchip.com) or the MPLAB IDE CD-ROM

(DS51123). Then run the executable and follow the screens to install MPLAB IDE.

3.3 INSTALLING THE USB DE VICE DRIVERS

Installing MPLAB IDE will preinstall the USB device drivers for the MPLAB ICD 3

in-circuit debugger. Therefore, once you have installed MPLAB IDE, connect the

debugger to the PC with a USB cable and follow the Windows “New Hardware Wizard”

to automatically install the drivers.

Expanded USB device driver installation instructions may found at:

MPLAB IDE installation directory\ICD 3\Drivers\ddri.htm

Note: MPLAB IDE v8.15 or greater is required to use the MPLAB ICD 3 in-circuit

debugger.

Note: If a new MPLAB ICD 3 is connected to your PC, you will need to reinstall

the drivers for the new unit.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

3.4 CONNECTING THE TARGET

A connection is built-in to select the type of communication with the target. See

Section 2.4 “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 debugger and target.

FIGURE 3-1: INSERT COMMUNICATIONS AND USB/POWER CABLES

3.5 SETTING UP THE TARGET BOARD

The target must be set up for the type of target device to be used.

3.5.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 in order for the

MPLAB ICD 3 in-circuit debugger to 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

“Bac kg round Debu gger Enable ” Conf igu rat io n bit.

The target board must have a connector to accommodate the communications chosen

for the debugger. For connection information, see Section 2.4 “Debugger To Target

Communication”, “Standard ICSP Device Communication”.

3.5.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).

USB/Power

From PC

Communications

Cable

From Target

MPLAB® ICD 3

Note: In the future, devices with circuitry that support ICD may be used.

Note: In the future, ICD header boards with ICD devices (Device-IC D ) ma y be

used.

Installation

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” (DS51194).

Header board layout will be different for headers or processor extension packs. For

connection information, see Section 2.4 “Debugger To Target Communication”,

“Standard ICSP Device Communication”.

3.5.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, 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 IDE will let you know in the Output

window when it has detected the target and has detected the device.

If you have not already done so, connect the MPLAB ICD 3 to the target using the

appropriate cables (see Section 3.4 “Connecting the Target”). Then power the

target. If you are powering the target through the MPLAB ICD 3, see

Section 9.5 .8 “Settings Dialog, Power Tab” for instructions.

3.6 SETTING UP MPLAB IDE

Once the hardware is connected and powered, MPLAB IDE may be set up for use with

the MPLAB ICD 3 in-circuit debugger.

On some devices, you must select the communications channel in the Configuration

bits, e.g., PGC1/EMUC1 and PGD1/EMUD1. Make sure the pins selected here are the

same ones physically connected to the device.

For more on setting up a project and getting started with MPLAB ICD 3, see Chapter

4. “General Setup”.

To walk through the process of programming and debugging a device with the MPLAB

ICD 3, see Chap ter 5. “Tutorial”.

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.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Chapter 4. General Setup

4.1 INTRODUCTION

How to get started using the MPLAB ICD 3 in-circuit debugger is discussed.

• Starting t he MPLAB IDE Software

• Creating a Project

• Viewing the Project

• Building the Project

• Setting Configuration Bits

• Setting the Debugger as the Debugger or Programmer

• Debugge r/ Prog ra mme r Lim itatio ns

4.2 STARTING THE MPLAB IDE SOFTWARE

After installing the MPLAB IDE software (Section 3.2 “Installing the Software”),

invoke it by using any of these methods:

•Select S tart >Program s>Microchip >MPLAB ID E vx.xx>MP LAB IDE, where vx. xx is

the version number.

• Double click the MPLAB IDE desktop icon.

• Execute the file mplab.exe in the \core subdirectory of the MPLAB IDE

installation directory.

For more information on using the software, see:

•“MPLAB IDE User's Guide” (DS51519) – Comprehensive guide for using MPLAB

IDE.

•“MPLAB IDE Quick Start Guide” (DS51281) – Chapters 1 and 2 of the user's

guide.

• The on-line help files – Contains the most up-to-date information on MPLAB IDE

and MPLAB ICD 3 in-circuit debugger.

• Readme files – Last minute information on each release is included in Readme

for MPLAB IDE.txt and Readme for MPLAB ICD 3 Debugger.txt. Both

files are found in the Readmes subdirectory of the MPLAB IDE installation

directory.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

4.3 CREATING A PROJECT

The easiest way to create a new project is to select Project>Project Wizard. With the

help of the Project Wizard, a new project and the language tools for building that project

can be created. The wizard will guide you through the process of adding source files,

libraries, linker scripts, etc., to the various “nodes” on the project window. See MPLAB

IDE documentation for more detail on using this wizard. The basic steps are provided

here:

• Select your device (e.g., PIC24FJ128GA010)

• Select a language toolsuite (e.g., Microchip C30 Toolsuite)

• Name the project

• Add application files (e.g., program.c, support.s, counter.asm)

4.4 VIEWING THE PRO JECT

After the Project Wizard has created a project, the project and its associated files are

visible in the Project window. Additional files can be added to the project using the Proj-

ect window. Right click on any line in the project window tree to pop up a menu with

additional options for adding and removing files.

See MPLAB IDE documentation for more detail on using the Project window.

4.5 BUILDING THE PROJECT

After the project is created, the application needs to be built. This will create object

(hex) code for the application that can be programmed into the target by the MPLAB

ICD 3 in-circuit debugger.

To set build options, select Project>Build Options>Project.

When done , choose Project>Build All to build the project.

Note: If you do not have a custom linker script in your project, the Project

Manager will select the appropriate linker script for you.

Note: On the Project Manager toolbar (View>Toolbars>Project Manager), select

“Debug” from the drop-down list when using the MPLAB ICD 3 as a

debugger, or select “Release” when using it as a programmer.

General Setup

4.6 SETTING CONFIGURATION BITS

Although device Configuration bits may be set in code, they also may be set in the

MPLAB IDE Configuration window. Select Configure>Configuration Bits. By clicking on

the text in the “Settings” column, these can be changed.

Some Configuration bits of interest are:

•Watchdog Timer Enable – On most devices, the Watchdog Timer is enabled

initially. It is usually a good idea to disable this bit.

•Comm Channel Select – For some devices, you will need to select the commun-

cations channel for the device, e.g., PGC1/EMUC1 and PGD1/EMUD1. Make

sure the pins selected here are the same ones physically connected to the device.

•Oscillator – Select the configuration setting that matches the target oscillator.

4.7 SETTING THE DEBUGGER AS THE DEBUGGER OR PROGRAMMER

Select Debugger>Select Tool>MPLAB ICD 3 to choose the MPLAB ICD 3 in-circuit

debugger as the debug tool. The Debugger menu and MPLAB IDE toolbar will change

to display debug options once the tool is selected. Also, the Output window will open

and messages concerning MPLAB ICD 3 status and communications will be displayed

on the MPLAB ICD 3 tab. For more information, see Section 9.2 “Debugging

Functions” and Section 9.3 “Debugging Dialogs/Windows”.

Select Programmer>Select Programmer>MPLAB ICD 3 to choose the MPLAB ICD 3

in-circuit debugger as the programmer tool. The Programmer menu and MPLAB IDE

toolbar will change to display programmer options once the tool is selected. Also, the

Output window will open and messages concerning ICE status and communications

will be displayed on the MPLAB ICD 3 tab. For more information, see

Section 9.4 “Programming Functions”.

Select Debugger>Settings or Programmer>Settings to open the Setting s dia lo g

(Section 9.5 “Settings Dialog”) and set up options as needed.

If errors occurs, see:

•Chapter 7. “Er ror Messages”

•Chapter 6. “Frequently Asked Questions (FAQs)”

•Section 10.7 “ICD 3 Test Interface Board”

4.8 DEBUGGER/PROGRAMMER LIMITATIONS

For a complete list of debugger limitations for your device, please see the MPLAB

ICD 3 on-line help file in MPLAB IDE by selecting Help>T opics>MPLAB ICD 3 and click

OK.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Chapter 5. Tutorial

5.1 INTRODUCTION

This tutorial walks you through the process of developing a simple project using the

sam ple programs counter.c and timer.c. This is an implementation of the

PIC24FJ128GA010 device using the Explorer 16 Demo Board (DM240001). The

program counter.c is a simple counting program. The incremental count, delayed by

using Timer 1 (timer.c), is displayed via Port A on the demo board’s LEDs.

Topics covered in this chapter:

• Setting Up the Environment and Selecting the Device

• Creating the Application Code

• Running the Project Wizard

• Viewing the Project

• Viewing Debug Options

• Setting Up the Demo Board

• Loading Program Code For Debugging

• Running Debug Code

• Debugging Code Using Breakpoints

• Programming the Applica tion

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

5.2 SETTING UP THE ENVIRONMENT AND SELECTING THE DEVICE

Before beginning this tutorial, follow the steps in Chapter 3. “Installation” to set up the

MPLAB IDE software and MPLAB ICD 3 system hardware. Double click on the MPLAB

IDE icon to launch the application. Once launched, the MPLAB IDE desktop should

appear.

FIGURE 5-1: MP LA B® IDE DESKTOP

Selecting the Devi ce

To select the device for this tutorial:

1. Select Configure>Select Device.

2. In the Device Selection dialog, choose “PIC24FJ128GA010” from the Device list

box. The light icon next to “MPLAB ICD 3” in the “Microchip Tool

Programmer/Debugger Tool Support” sections should be green.

3. Click OK.

5.3 CREATING THE APPLICATION CODE

For this tutorial, two C programs (counter.c and timer.c) will be used. The code

for each is shown below.

1. Using Windows® Explorer, create a project folder and directory, for example,

C:\Projects\ICD3Tut.

2. Open an editor window by selecting File>New. Enter the code for the first

program (see text for counter.c) in this window and save to the

project\directory folder.

3. Open another editor window by selecting File>New. Enter the code for the

second program (see text for timer.c) in this window and save to the

project\directory folder.

Tutorial

counter.c

/*****************************************************************************

* MPLAB ICD 3 In-Circuit Debugger Tutorial

* Counting program

*****************************************************************************

* Demo Board: Explorer 16

* Processor: PIC24FJ128GA010

* Compiler: MPLAB C30

* Linker: MPLAB LINK30

* Company: Microchip Technology Incorporated

*****************************************************************************/

#include "p24FJ128GA010.h"

// Set up configuration bits

_CONFIG1( JTAGEN_OFF & GCP_OFF & GWRP_OFF & COE_OFF & FWDTEN_OFF & ICS_PGx2)

_CONFIG2( FCKSM_CSDCMD & OSCIOFNC_ON & POSCMOD_HS & FNOSC_PRI )

void TimerInit(void);

unsigned char TimerIsOverflowEvent(void);

// Set up user-defined variables

#define INIT_COUNT 0

unsigned int counter;

int main(void)

{

// Set up PortA IOs as digital output

AD1PCFG = 0xffff;

TRISA = 0x0000;

// Set up Timer1

TimerInit();

// Initialize variables

counter = INIT_COUNT;

while (1) {

// Wait for Timer1 overflow

if (TimerIsOverflowEvent()){

counter++; //increment counter

PORTA = counter; //display on port LEDs

}// End of if...

}// End of while loop...

}// End of main()...

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

timer.c

/*****************************************************************************

* MPLAB ICD 3 In-Circuit Debugger Tutorial

* Timer program

*****************************************************************************

* Demo Board: Explorer 16

* Processor: PIC24FJ128GA010

* Compiler: MPLAB C30

* Linker: MPLAB LINK30

* Company: Microchip Technology Incorporated

*****************************************************************************/

#include "p24FJ128GA010.h"

//declare functions

extern void TimerInit(void);

extern unsigned char TimerIsOverflowEvent(void);

/*********************************************************************

* Function: TimerInit

* PreCondition: None.

* Input: None.

* Output: None.

* Overview: Initializes Timer1 for use.

********************************************************************/

void TimerInit(void)

{

PR1 = 0xFFFF;

IPC0bits.T1IP = 5;

T1CON = 0b1000000000010000;

IFS0bits.T1IF = 0;

}

/*********************************************************************

* Function: TimerIsOverflowEvent

* PreCondition: None.

* Input: None.

* Output: Status.

* Overview: Checks for an overflow event, returns TRUE if

* an overflow occured.

* Note: This function should be checked at least twice

* per overflow period.

********************************************************************/

unsigned char TimerIsOverflowEvent(void)

{

if (IFS0bits.T1IF)

{

Tutorial

IFS0bits.T1IF = 0;

TMR1 = 0;

return(1);

}

return(0);

}

/*********************************************************************

* EOF

********************************************************************/

5.4 RUNNING THE PROJECT WIZARD

The MPLAB C30 C compiler will be used in this project. You may either purchase the

full compiler or download a free student version from the Microchip website.

1. To set up this project, select Project>Project Wizard. A Welcome screen will

appear.

2. Proceed to the second dialog of the wizard. The PIC24FJ128GA010 should be

selected.

3. Proceed to the next dialog of the wizard to set up the language tools. In the

“Active T oolsuite” pull-down, select “Microchip C30 T oolsuite.” Make sure that the

tools are set to the proper executables, by default located in the directory

C:\Program Files\Microchip\MPLAB C30\bin. MPLAB C30 should be

pointing to pic30-gcc.exe and MPLAB LINK30 should be pointing to

pic30-ld.exe.

FIGURE 5-2: PROJECT WIZARD – TOOLSUITE SELECTION

4. Proceed to the next dialog of the wizard to give a name and location to your proj-

ect. You may Browse to find a location.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

FIGURE 5-3: PROJECT WIZARD – PROJECT NAME

5. Proceed to the next dialog of the wizard where project files can be added. Files

can also be added later if something is missed.

For this example, browse to your project directory to find both files. Click on

counter.c to highlight it and then click on ADD>> to add it to the right pane.

Click on timer.c to highlight it and then click on ADD>> to add it to the right

pane.

Leave the “A” next to the file name. For more information on what this and other

letters mean, click the Help button on the dialog.

FIGURE 5-4: PROJECT WIZARD – ADD FILES

6. Proceed to the Summary screen. If you have made any errors, click <Back to

return to a previous wizard dialog. If everything is correct, click Finish.

Tutorial

5.5 VIEWING THE PRO JECT

After exiting the wizard, the MPLAB IDE desktop will again be visible. If the project

window is not open, select View/Project to see the Project window.

FIGURE 5- 5: PR OJ ECT WIND OW

Additional files can be added to the project using the project window . Right click on any

line in the project window tree to pop up a menu with additional options for adding and

removing files.

Note: Although the header file p24FJ128GA010.h and a linker script file are used

in the project, you do not need to add them to the project; MPLAB IDE will

find them for you.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

5.6 VIEWING DEBUG OPTIONS

Before you begin debugging your code, review the default settings of several items. In

your own projects, you may need to set these items differently.

5.6.1 Configuration Bits

In this tutorial, the relevant device Configuration bits are set in the counter.c code

using the _CONFIG1 and _CONFIG2 directives. For information on the function of these

PIC24FJ128GA010 configuration register bits, see the “PIC24FJ128GA Family Data

Sheet” (DS39747).

Configuration bits also may be set by selecting Configure>Configuration Bits and

unchecking “Configuration bits set in code”. Do not change any values for this tutorial.

FIGURE 5-6: CONFIGURATION BITS WINDOW

5.6.2 Selecting the Debugger as a Debugger

To select MPLAB ICD 3 in-circuit debugger as a debugger, select Debugger>Select

Tool>ICD 3. Then:

1. The Output window will open to display connection information. Depending on

the version of MPLAB IDE or the device selected, a message box may appear

indicating that the firmware needs to be updated. Select OK in the message box

to allow MPLAB IDE to install the new firmware. Also, since different MPLAB ICD

3 firmware is used for different families of devices, this message box may appear

when switching to a different device.

2. The Output window will display information about the firmware update and will

shen when the MPLAB ICD 3 is connected to the target.

3. The Debugger menu will show available debugger debug options.

4. A Debug toolbar will appear. Mouse over a button to see a pop-up of its function.

5.6.3 Programming Options

To set program options, select Debugger>Settings and click on the Program Memory

tab.

Tutorial

FIGURE 5-7: DEBUGGER PROGRAM MEMORY TAB

Here you may allow the debugger to automatically choose the programming ranges

(recommended) or you may select ranges manually.

• The “Memories” section should have “Program” checked, and “EEPROM” and

“ID” unchecked. When using the MPLAB ICD 3 in-circuit debugger as a debugger ,

Configuration bits will always be programmed and the “Configuration” box will be

checked and grayed out.

• For the PIC24FJ devices, all memory will be erased each time the chip is

programmed. Therefore, in the “Program Options” section, “Erase all before

Program” will have no effect.

• The “Program Memory” addresses (“Start” and “End” address) set the range of

program memory that will be read, programmed or verified.

When debugging code, you will frequently repeat the edit, rebuild, reprogram and run

sequence. To automate this, there are checkboxes “Program after successful build”

and “Run after successful program”. Leave these unchecked for now.

5.7 CREATING A HEX FILE

To create a hex file for debugging:

• On the Project toolbar, select “Debug” from the Build Configuration drop-down list.

•Select P r oject>Bui ld Al l or right click on the project name in the project window

and select “Build All” from the popup menu.

The project will build (Figure 5-8), and the resulting .hex file will have the same name

as the project (Figure 5-9). The hex file is the code that will be programmed into the

target device.

Note: Depending on the build options selected, your Output window may look

different from Figure 5-8 (Project>Build Options>Project, MP LAB C30 and

MPLAB LINK30 tabs.)

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

FIGURE 5-8: OUTPUT WINDOW

FIGURE 5-9: WINDOWS EXPLORER – PROJECT FILES

Tutorial

5.8 SETTING UP THE DEMO BOARD

Before beginning to debug, make sure the Explorer 16 Demo Board is set up properly.

For more information, see the “Explorer 16 Development Board User’s Guide”

(DS51589).

Settings for this tutorial should be as follows:

• PIC24FJ128GA010 PIM (Plug-In Module) plugged into the board.

• S2: “PIM” selected; “PIC” selection for devices soldered onto the board.

• J7: “PIC24” selected; the debugger will communicate directly with the

PIC24FJ128GA010 and not the on-board PIC18LF4550 USB device.

• JP2: LEDs have been enabled by connecting Jumper 2.

• D1 on: Power being supplied to board.

5.9 LOADING PROGRAM CODE FOR DEBUGGING

Select Debugger>Program to program RITut.hex into the PIC24FJ128GA010 on the

Explorer 16 demo board.

During pr ogramming, the ICD 3 tab of the Output dialog shows the current phase of

operation. When programming is complete, the dialog should look similar to

Figure 5-10.

FIGURE 5-10: OUTPUT WINDOW – MPLAB® ICD 3 TAB

Note: The debug executive code is automatically programmed in upper program

memory for MPLAB ICD 3 debug functions. Debug code must be

programmed into the target device to use the in-circuit debugging

capabilities of the MPLAB ICD 3 in-circuit debugger.

Note: If you have trouble programming your device or communicating with the

debugger, unplug the Explorer 16 board and use the self-test board

(Section 10.7 “ICD 3 Test Interface Board”) to verify communications.

For additional help, see Chapter 6. “Frequently Asked Questions

(FAQs)”.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

5.10 RUNNING DEBUG CODE

The MPLAB ICD 3 in-circuit debugger executes in Real Time or in Step mode.

• Real Time execution occurs when the device is put in the MPLAB IDE’s Run

mode.

• Step mode execution can be accessed after the processor is halted.

These toolbar buttons can be used for quick access to commonly-used debug

operations.

Begin in Real-Time mode:

1. Open the source files counter.c and timer.c (double click on the file names

in the Project window or use File>Open).

2. Select Debugger>Run (or click the Run toolbar button).

3. Observe the LEDs. They will be counting up in binary.

4. Select Debugger>Halt (or click the Halt toolbar button) to stop the program

execution.

5. When the debugger halts, one of the open source code windows will pop to the

front and a green arrow will indicate where the program halted.

To use Step mode:

1. Select Debugger>S tep Into (or click the Step Into toolbar button) to execute one

instruction and then halt. The green arrow in the code listing will move

accordingly.

2. Repeat as needed.

The step functions “Step Over” and “Step Out” are used with functions and discussed

in the MPLAB IDE documentation.

5.11 DEBUGGING CODE USING BREAKPOINTS

The example code in this tutorial has already been debugged and works as expected.

However , this code is still useful to demonstrate the debugging features of the MPLAB

ICD 3 in-circuit debugger. The first debug feature to be discussed are breakpoints.

Breakpoints stop code execution at a selected line of code.

• Setting Software Breakpoints

5.11.1 Choosing a Breakpoint Type

For the device used in this tutorial, you have the choice of using either hardware or

software break points.

To set breakpoint options, select Debugger>Settings and click on the Configuration

tab. Select the type of breakpoint that best suits your application needs. For this tutorial,

we will begin using the default breakpoint type (hardware breakpoints.)

Debugger

Menu Run Halt Animate Step Into Step Over Step Out Reset

Toolbar

Buttons

Tutorial

5.11.2 Setting a Single Hardware Breakpoint

To set a single breakpoint:

1. Select Debugger>Reset>Processor Reset (or click the Reset toolbar button) to

reset the example program.

2. Highlight or place the cursor on the following line of code from counter.c:

counter++; //increment counter

3. Double click on the line, or right click on the line and then select Set Breakpoint

from the shortcut menu. This line is now marked as a breakpoint (B in red stop

sign) as shown in Figure 5-11.

FIGURE 5-11: SET BREAKPOINT

4. Select Debugger>Run (or click the Run toolbar button) to run the program once

again in Real-Time mode. The program will halt at the line marked by the

breakpoint, but now there will be a green arrow over the breakpoint symbol.

FIGURE 5-12: PROGRAM HALTED

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

5. Open a new Watch window to watch the counter variable change value as the

program executes. Select View>Watch. The Watch dialog opens with the Watch

1 tab selected. Select “counter” from the list next to Add Symbol, and then click

the button. counter is added to the Watch window . Select “PORT A” from the list

next to Add SFR, and then click the button. PORTA is added to the Watch

window. The selected symbols should now be visible in the Watch window as

shown in Figure 5-13.

FIGURE 5-13: WA TCH WINDOW

6. Select Debugger>Run (or click the Run toolbar button) to run the program once

again. The program will halt at the breakpoint and you will notice that the value

of both variables has incremented by 1.

7. Run again as desired to see the values increase. When done, use

Debugger>Reset>Processor Reset (or click the Reset toolbar button) to reset

the processor.

5.11.3 Setting Multiple Hardware Breakpoints

To set multiple breakpoints, either set numerous single breakpoints as specified in the

previous section, or use the Breakpoints dialog (see Section 9.3.1 “Breakpoints

Dialog”). The Breakpoints dialog a lso allows you to control breakpoint interacti on.

1. Select Debugger>Breakpoints to open the Breakpoints dialog. The breakpoint

set in the previous section will be displayed in this dialog. Click the Add

Breakpoint button to add another breakpoint.

2. On the Program Memory tab of the Set Breakpoint dialog, enter “2e6” as the hex

Address and click OK.

FIGURE 5-14: SET BREAKPOINTS DIALOG

Note: If you exceed the maximum allowed number of breakpoints for your device,

MPLAB IDE will warn you.

Tutorial

The additional breakpoint will appear below the previous breakpoint in the

Breakpoints dialog and also as a breakpoint symbol next to the following line of

code:

PORTA = counter; //display on port LEDs

The breakpoint symbol is yellow in this case because it was set based on an

address.

FIGURE 5-15: TWO BREAKPOINTS

3. Run the program to see it halt at the first breakpoint. The values in the Watch win-

dow will not change. Then run again to see it stop at the second breakpoint. (The

program may skid past this breakpoint.) Now the values in the Watch window will

change.

5.11.4 Using the St opwa tch with Breakpoints

To determine the time between the breakpoints, use the Stopwatch.

1. Click Stopwatch (on the Breakpoints dialog) to open the Stopwatch dialog.

FIGURE 5-16: STOPWATCH DIALOG

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

2. Under “Start Condition”, select the first breakpoint from the list. Then uncheck

“Start condition will cause the target device to halt”.

3. Under “Stop Condition”, select the second breakpoint from the list. Then check

“Stop conditi on wil l cause the target devic e to halt” .

4. Check “Reset stopwatch on run”.

5. Click OK.

FIGURE 5-17: STOPWATCH DIALOG

6. Run the program until it halts. In the Output window, on the ICD 3 tab, the number

of cycles between the two instructions should be shown as:

Stopwatch cycle count = 4(decimal)

7. Clear both breakpoints from the code by deleting them from the Breakpoints dia-

log, double clicking on each line to remove them, or right clicking on each line

and selecting “Remove Breakpoint”. You can also right click and select

Breakpoints>Remove All Breakpoints to remove both at once.

5.11.5 Setting Software Breakpoints

To change the breakpoint type from hardware to software:

•Select Debugger>Settings and click on the Configuration tab.

• Click the radio button next to “Use Software Breakpoints”.

•Click OK.

You will now use software breakpoints instead of the hardware breakpoints used

previously.

1. To set a single software breakpoint, follow the instructions in

Section 5.11.2 “Setting a Single Hardware Breakpoint”.

- When you set a software breakpoint, you will see the following in the Output

window:

Programming software breakpoint(s)...

Software breakpoint(s) set.

- If you have already set a hardware breakpoint in this tutorial, the variables will

already be added to the Watch window for use with the software breakpoint.

Note: Using software breakpoints for debug impacts device endurance. There-

fore, it is recommended that devices used in this manner not be used as

production parts.

Tutorial

2. To set multiple software breakpoints, follow the instructions in

Section 5.11.3 “Setting Multiple Hardware Breakpoints”.

- There is no breakpoint skidding with software breakpoints, i.e., the program

halts on the breakpoint. This may affect how you see values change in the

Watch window.

- There is a maximum number of breakpoints with software breakpoints, i.e,

although this tutorial only uses two, the number of software breakpoints is

999.

3. The stopwatch is meant to be used with hardware breakpoints. However, you can

use the stopwatch with software breakpoints, but they will be converted to hard-

ware breakpoints as you select them. In the Output window, you will see:

Converting breakpoint types...

Breakpoint type conversion complete.

Follow the ste ps as specifi ed in Section 5.11.4 “Using the Stopwatch with

Breakpoints”.

4. Set the breakpoints to hardware again for the remainder of the tutorial. Select

Debugger>Settings, click on the Configuration tab, click the radio button next to

“Use Hardware Breakpoints” and then click OK.

5.12 PROGRAMMING THE APPLICATION

When the program is successfully debugged and running, the next step is to program

the device for stand-alone operation in the finished design. When doing this, the

resources reserved for debug are released for use by the application.

To program the application follow these steps:

1. Disable the MPLAB ICD 3 in-circuit debugger as the debug tool by selecting

Debugger>Select Tool>None.

2. Enable the MPLAB ICD 3 in-circuit debugger as the programmer by selecting

Programmer>Select Programmer>ICD 3.

3. Optional: Set up the ID in Configure>ID Memory (for devices that support ID

memory.)

4. Set up the parameters for programming on the Programmer>Settings, Program

Memory tab.

5. On the Project toolbar , select “Release” from the Build Configuration drop-down

list. Then select Project>Build All.

6. Select Programmer>Program.

The application should now be running on its own. Press the Reset (MCLR) but t o n on

the demo board to restart the count.

You can modify the program code to wait for a button press before beginning or to

terminate the program. Modifying the program will require you to select the debugger

as a debug tool.

1. Disable the MPLAB ICD 3 in-circuit debugger as the programmer by selecting

Programmer>Select Programmer>None.

2. Enable the MPLAB ICD 3 in-circuit debugger as the debug tool by selecting

Debugger>Select Tool>ICD 3.

3. Edit the counter.c code as desired. (This is left as an exercise for you.)

4. On the Project toolbar, select “Debug” from the Build Configuration drop-down

list. Then select Project>Build All.

5. Select Debugger>Program.

6. Run, step and debug your program as required.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Part 2 – Troubleshooting

Chapter 6. F requently Asked Questions (FAQs).......................................................49

Chapter 7. Error Mess ages................ .... ..... ..................................... ..... ..... .... ..............53

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

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

• What's in the silicon that allows it to communicate with the MPLAB ICD 3

in-circuit debugger?

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 th rough put of the pro ces sor affe cte d by ha ving t o ru n the de bug

executive?

•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?

Please refer to Section 2.2 “MPLAB ICD 3 In-Circuit Debugger vs. MPLAB ICE

2000/4000 In -C ircuit Emulat ors” and Section 2.3 “MPLAB ICD 3 In-Circuit

Debugger vs. MPLAB ICD 2 Debugger”.

• How does MPLAB IDE interf ace with the MPLAB ICD 3 in-circuit debugger to

allow more features than MPLAB ICD 2?

MPLAB ICD 3 in-circuit debugger communicates using the debug executive

located in the test area. The debug exec is streamlined for more efficient commu-

nication. The debugger contains an FPGA, large SRAM Buffers (1Mx8) and a

High S peed 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 the MPLAB ICE 2000/4000 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 debugg er? For example, could I halt based on

a flag going high?

The MPLAB ICE 2000/4000 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 busses 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.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

• Does the MPLAB ICD 3 in-circuit debugger have complex breakpoints like

MPLAB ICE 2000/4000?

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, but

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. See

Section 9.3.1 “Breakpoints Dialog” for more information.

• Are any of the driver boards opt oisolated or electrically isolated?

They are DC optoisolated, but not AC optoisolated. You cannot apply a floating or

high voltage (120V) to the current system.

• W hat limitations are there with the standard cable?

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.

• Will this slow down the running of the program?

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.

• Is it possible to debug a dsPIC DSC running at any speed?

The MPLAB ICD 3 is capable of debugging at any device speed as specified in

the device’s data sheet.

• What is the function of pin 6, the LVP pin?

Pin 6 is reserved for the LVP (Low-Voltage Programming) connection.

6.3 WHAT’S WRONG

• My PC went into powe r-down/hibernate mode, and now my debugger won’t

work. What happened?

When using the debugger for prolonged periods of time, and especially as a

debugger, be sure to 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.

• I set my peripheral to NOT freeze on halt, but it is suddenly freezing. What's

going on?

For dsPIC30F/33F and PIC24F/H devices, a reserved bit in the peripheral control

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).

Frequently Asked Questions (FAQs)

• When using a 16-bit device, an unexpected re set occurred. How do I

determine what caused it?

Some thin gs to consi de r:

- 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)

{

INTCON1bits.OSCFAIL = 0;

while (1);

}

- Use ASSERTs.

• I have finished debugging my code. Now I’ve programmed my part, but it

won’t run. What’s wrong?

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 pro-

gram a debug executive into program memory and set up other device features

for debug (see Section 2.7.1 “Sequence of Operations Leading to Debug-

ging”). To program final (release) code, select the debugger as a programmer.

- Have you selected “Release” from the Build Configuration drop-down list or Proj-

ect menu? You must do this for final (release) code. Rebuild your project, repro-

gram the device, and try to run your code again.

• I didn’t set a software breakpoint, yet I have one in my code. What’s going

on?

What you are seeing is a phantom breakpoint. Occasionally, a breakpoint can

become enabled when it shouldn’t be. Simply disable or delete the breakpoint.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

• I don’t see my problem here. Now what?

Try the following resources:

- Chapter 10. “Limitations”

- Section 2.9 “Resources Used by the Debugger”

- Section 7.2 “Specific Error Messages”

- Section 7.3 “Gene ral Corre ct ive Action s”

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Chapter 7. Error Messages

7.1 INTRODUCTION

The MPLAB ICD 3 in-circuit debugger produces many different error messages; some

are specific and others can be resolved with general corrective actions.

• Specific Error Messages

• General Corrective Actions

7.2 SPECIFIC ERROR MESSAGES

MPLAB ICD 3 in-circuit debugger error messages are listed below in numeric order.

Text in error messages listed below of the form %x (a variable) will display as text

relevant to your particular situation in the actual error message.

ICD3Err0001: Failed while writing to program memory.

ICD3Err0002: Failed while writing to EEPROM.

ICD3Err0003: Failed while writing to configuration memory.

See Section 7.3.1 “Read/Write Error Actions”.

ICD3Err0005: ICD 3 is currently busy and cannot be unloaded at this time.

If you receive this error when attempting to deselect the debugger as a debugger or

programmer:

1. W ait – 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. Then try to deselect the debugger again.

4. Shut down MPLAB IDE.

ICD3Err0006: Failed while writing to user ID memory.

ICD3Err0007: Failed while reading program memory.

ICD3Err0008: Failed while reading EEPROM.

ICD3Err0009: Failed while reading configuration memory.

ICD3Err0010: Failed while reading user ID memory.

See Section 7.3.1 “Read/Write Error Actions”.

ICD3Err0011: Bulk erase failed.

See Section 7.3.1 “Read/Write Error Actions”.

If these do not work, try another device.

Note: Numbers may not yet appear in displayed messages. Use the Search tab

on the Help viewer to find your message and highlight it below.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

ICD3Err0012: Download debug exec failed

If you receive this error while attempting to program from the Debugger menu:

1. Deselect the debugger as the debug tool.

2. Close your project and then close MPLAB IDE.

3. Restart MPLAB IDE and re-open your project.

4. Reselect the debugger as your debug tool and attempt to program your target

device again.

If this does not work, see Section 7.3.4 “Corrupted Installation Actions”.

ICD3Err0013: NMMR register write failed.

ICD3Err0014: File register write failed.

See Section 7.3.2 “Debugger-to-Target Communication Error Actions”.

ICD3Err0015: Data transfer was unsuccessful. %d byte(s) expected, %d byte(s)

transferred.

See Section 7.3.3 “Debugger-to-PC Communicat ion Error Actions”.

ICD3Err0016: Cannot transmit. ICD 3 not found.

The debugger is not connected to the PC.

ICD3Err0017: File register read failed.

ICD3Err0018: NMMR register read failed.

ICD3Err0019: Failed while reading emulation registers.

ICD3Err0020: Failed while writing emulation registers.

See Section 7.3.2 “Debugger-to-Target Communication Error Actions”.

ICD3Err0021: Command not echoed properly. Sent %x, received %x.

ICD3Err0022: Failed to get ICD 3 version information.

ICD3Err0023: Download FPGA failed.

ICD3Err0024: Download RS failed.

ICD3Err0025: Download AP failed.

See Section 7.3.3 “Debugger-to-PC Communicat ion Error Actions”.

ICD3Err0026: Download program exec failed.

If you receive this error while attempting to program from the Debugger menu:

1. Deselect the debugger as the debug tool.

2. Close your project and then close MPLAB IDE.

3. Restart MPLAB IDE and re-open your project.

4. Reselect the debugger as your debug tool and attempt to program your target

device again.

If this does not work, see Section 7.3.4 “Corrupted Installation Actions”.

ICD3Err0027: Bulk transfer failed due to invalid checksum

See Section 7.3.3 “Debugger-to-PC Communicat ion Error Actions”.

Also, ensure that the cables used are the correct length.

ICD3Err0028: Download device database failed

If you receive this error:

1. Try downloading again. It may be a one-time error.

2. Try manually downloading. Select Debugger>Settings, Configuration tab, and

click Manual Download. Select the highest number .jam file and click Open.

ICD3Err0029: Communication f ailure. Unexpected command ec ho re sponse %x

received from ICD 3.

See Section 7.3.3 “Debugger-to-PC Communicat ion Error Actions”.

Error Mes s ages

ICD3Err0030: Unable to rea d/fi nd firmw are File %s.

If the Hex file exists:

• Reconnect and try again.

• If this does not work, the file may be corrupted. Reinstall MPLAB IDE.

If the Hex file does not exist:

• Reinstall MPLAB IDE.

ICD3Err0031: Failed to get PC.

ICD3Err0032: Failed to set PC.

See Section 7.3.2 “Debugger-to-Target Communication Error Actions”.

ICD3Err0033: %d bytes expected, %d bytes received.

See Section 7.3.3 “Debugger-to-PC Communicat ion Error Actions”.

ICD3Err0034: This version of MPLAB IDE does not support hardware revision

%06x. Please upgrade to the latest version of MPLAB IDE before continuing.

Find the latest MPLAB IDE at www.microchip.com.

ICD3Err0035: Failed to get Device ID.

See Section 7.3.1 “Read/Write Error Actions”.

ICD3Err0036: MPLAB IDE has lost communication with ICD 3.

See Section 7.3.3 “Debugger-to-PC Communicat ion Error Actions”.

ICD3Err0037: Timed out waiting for response from ICD 3.

ICD3Err0038: Failed to initialize ICD 3.

ICD3Err0039: ICD 3 self-test failed.

For this error, the debugger is not responding:

1. Unplug and plug in the debugger.

2. Reconnect to the debugger in MPLAB IDE.

3. If the problem persists contact Microchip.

ICD3Err0040: The target device is not ready for debugging. Please check your

configuration bit set tings 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

programming your device, please refer to Section 7.3.6 “Debug Failure Actions”.

ICD3Err0041: While receiving streaming data, ICD 3 has gotten out-of-sync with

MPLAB IDE. To correct this you must reset the target device.

First try to Halt, Reset and then Run again. If this does not work:

1. Unplug and plug in the debugger.

2. Reconnect to the debugger in MPLAB IDE.

3. Check that the target speed is entered on the Clock tab of the Settings dialog.

4. Run again.

ICD3Err0045: You must connect to a target device to use MPLAB ICD 3.

No power has been found.

1. Ensure VDD and GND are connected between the debugger and target.

2. Ensure that the target is powered.

3. Ensure that the target power is sufficient to be detected by the debugger (see

Chapter 10. “Ha rdw are Specification ” .)

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

ICD3Err0046: An error occurred while trying to read the stopwatch count. The

stopwatch count may not be accurate.

See Section 7.3.2 “Debugger-to-Target Communication Error Actions”.

ICD3Err0047: Bootloader download failed.

See Section 7.3.3 “Debugger-to-PC Communicat ion Error Actions”.

ICD3Err0052: The current ICD 3 hardware version %x, is out of date. This version

of MPLAB IDE will support only version %x or higher.

Did y ou cl ick Cancel when asked to download the latest firmware? If so, you will need

to download it now. Select Debugger>Settings, Configuration tab, and click Manual

Download. Select the highest number .jam file and click Open.

If you cannot find any files to download or if this does not work (corrupted file), you will

need to get the latest version of MPLAB IDE and install it. Find the latest MPLAB IDE

at www.mic roc hip .c om.

ICD3Err0053: Unable to get ICD 3 protocol versions.

See Section 7.3.3 “Debugger-to-PC Communicat ion Error Actions”.

ICD3Err0054: MPLAB IDE's ICD 3 protocol definitions are out of date. You must

upgrade MP LAB IDE to continue.

Find the latest MPLAB IDE at www.microchip.com.

ICD3Err0055: Unable to set firmware suite version.

ICD3Err0056: Unable to get voltages from ICD 3.

See Section 7.3.3 “Debugger-to-PC Communicat ion Error Actions”.

ICD3Err0057: Self-test could not be completed.

Ensure that you are using the ICD3 self-test board. Also, see

Section 7.3.2 “Debugger-to-Target Communication Error Actions”.

ICD3Err0063: Test interface clock write failure. Please ensure that the tester is

properly connected.

ICD3Err0064: Test interface data write failure.

ICD3Err0065: Test interface clock read failure.

ICD3Err0066: Test interface data read failure.

Clock/data not being output from the debugger . Check your connections and try again.

ICD3Err0067: Failed to set/clear software breakpoint.

Reprogram and try agai n.

ICD3Err0068: Failed while writing to boot FLASH memory.

ICD3Err0069: Failed while reading boot FLASH memory.

ICD3Err0070: Failed while writing peripheral memory.

ICD3Err0071: Failed while reading peripheral memory.

See Section 7.3.1 “Read/Write Error Actions”.

ICD3Err0072: Unable to send freeze peripheral information.

See Section 7.3.3 “Debugger-to-PC Communicat ion Error Actions”.

ICD3Err0073: Device is code protected.

The device on which you are attempting to operate (read, program, blank check or

verify) is code protected, i.e., the code cannot be read or modified. Check your

Configuration bits setting for code protection.

To disable code protection, set or clear the appropriate Configuration bits in code or in

the Configuration Bits window (Configure>Configuration Bits), according to the device

data sheet. Then erase and reprogram the entire device.

ICD3Err0082: Test interface LVP failure.

ICD3Err0083: Test interface MCLR failure

Error Mes s ages

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

• Int ernal Error Actions

7.3.1 Read/Write Error Actions

If you receive 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 Erro r Actio n s

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 the correct length.

7.3.3 Debugger-to-PC Communication Error Actions

The MPLAB ICD 3 in-circuit debugger and MPLAB IDE are out-of-sync 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 IDE 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 “ Corr upted Installation Actions”.

7.3.4 Corrupted Installation Actions

The problem is most likely caused by a incomplete or corrupted installation of MPLAB

IDE.

1. Uninstall all versions of MPLAB IDE from the PC.

2. Reinstall the desired MPLAB IDE version.

3. If the problem persists contact Microchip.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

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.

3. Make sure the appropriate USB port has been selected in the debugger Settings.

4. Make sure the USB port is not in use by another device.

5. If using a USB hub, make sure it is powered.

6. Make sure the USB drivers are loaded.

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.

Top Reasons Why You Can’t Debug

1. The oscillator is not working. Check your Configuration bits setting for the

oscillator.

2. The target board is not powered. Check the power cable connection.

3. The MPLAB ICD 3 in-circuit debugger has somehow become physically

disconnected from the PC. Check the USB communication cable connection.

4. The debugger has somehow become physically disconnected from the target

board. Check the communications cable connection.

5. The device is code-protected. Check your Configuration bits setting for code

protection.

6. You are trying to rebuild the project while in Release mode. Select Debug in the

Build Configuration drop-down list on the project toolbar , then rebuild the project.

7. The debugger is selected as a programmer, and not as a debugger, in MPLAB

IDE.

8. Debugger to PC communications has somehow been interrupted. Reconnect to

the debugger in MPLAB 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 (e.g., 18F8722.lkr was used instead of 18F8722i.lkr).

Try rebuilding and reprogramming the target application. Then initiate a

Power-on Reset of the target.

10. 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.

11. The debugger cannot always perform the action requested. For example, the

debugger cannot set a breakpoint if the target application is currently running.

Error Mes s ages

Other Things to Consider

1. It is 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. It is possible that the target device has been damaged in some way (e.g., over

current.) Development environments are notoriously hostile to components.

Consider trying another target device.

4. Microchip Technology Inc. offers myriad demonstration boards to support most

of its microcontrollers. Consider using one of these applications, which are

known to work, to verify correct MPLAB ICD 3 in-circuit debugger functionality.

Or, use the self-test board to verify the debugger itself (Section 10.7 “ICD 3 T est

Interface Board”.)

5. Review debugger debug operation to ensure proper application setup (Chapter

2. “Theory of Operation”.)

6. If the problem persists contact Microchip.

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

Installation 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 fragmented.)

If the problem persists contact Microchip.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Part 3 – Reference

Chapter 8. Basic Debug Functions.............................................................................63

Chapter 9. Debugger Function Summary ..................................................................65

Chapter 10. Hardware Specification...........................................................................79

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Chapter 8. Basic De bug Fu nctions

8.1 INTRODUCTION

Basic MPLAB ICD 3 in-circuit debugger debug functions of breakpoints and stopwatch

are discussed.

8.2 BREAKPOINTS

Use breakpoints to halt code execution at specified lines in your code.

Breakpoints and triggers use the same resources. Therefore, the available number of

breakpoints is actually the available number of combined breakpoints/triggers.

To select hardware or software breakpoints:

1. Select Debugger>Settings and click the Configuration tab.

2. Select the desired type of breakpoints for your application. A list of features for

each breakpoint type, hardware or software, is shown under that type. (See

Section 9.5 .2 “Settings Dialog, Configura tion Tab” fo r more informati on. )

8.3 STOPWATCH

Use the stopwatch with breakpoints to time code execution.

To set a breakpoint in code, do one of the following:

• Double click or right click on a line of code to set up an individual breakpoint.

•Select Debugger>Breakpoints to open the Breakpoints dialog and set up multiple

breakpoints and breakpoint conditions. See Section 9.3.1 “Breakpoints Dialog”

for more information.

To determine the time between the breakpoints, use the stopwatch:

1. Open the Breakpoints dialog (Debugger>Breakpoints).

1. Click Stopwatch on the Breakpoints dialog to open the Stopwatch dialog.

2. Under “St art Condition”, select a breakpoint from the drop-down list. Also decide

if “Start condit ion will cause the target device to halt”.

3. Under “Stop Condition”, select another breakpoint from the drop-down list. Also

decide if “Stop condition will cause the target device to halt”.

4. Decide if there will be a “Reset stopwatch on run”.

5. Click OK.

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.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Chapter 9. Debugger Function Summary

9.1 INTRODUCTION

A summary of the MPLAB ICD 3 in-circuit debugger functions on menus, in windows

and on dialogs is listed here.

• Debugging Functions

• Debugging Dialogs/Windows

• Programming Functions

• Settings Dialog

9.2 DEBUGGING FUNCTIONS

When you select the MPLAB ICD 3 from the Debugger menu, the following items will

be added to the MPLAB IDE functions:

• Debugger Menu – additional options are added to the drop-down menu

• Right Mouse Button Debugger Menu – additional options are added to this menu

• Toolbars/Status Bar – a toolbar appears below the menu bar; additional

information appears in the status bar

9.2.1 Debugger Menu

Run F9

Execute program code until a breakpoint is encountered or until Halt is selected.

Execution starts at the current Program Counter (as displayed in the status bar). The

current Program Counter location is also represented as a pointer in the Program

Memory window. While the program is running, several other functions are disabled.

Animate

Animate causes the debugger to actually execute single steps while running, updating

the values of the registers as it runs.

Animate runs slower than the Run function, but allows you to view changing register

values in the Special Function Register window or in the Watch window .

To Halt Animate, use the menu option Debugger>Halt, the toolbar Halt or <F5 >.

Halt F5

Halt (stop) the execution of program code. When you click Halt, status information is

updated.

Step Into F7

Single step through program code.

For assembly code, this command executes one instruction (single or multiple cycle

instructions) and then halts. After execution of one instruction, all the windows are

updated.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

For C code, this command executes one line of C code, which may mean the execution

of one or more assembly instruction, and then halts. After execution, all the windows

are updated.

Step Over F8

Execute the instruction at the current program counter location. At a CALL instruct ion,

Step Over executes the called subroutine and halts at the address following the CALL.

If the Step Over is too long or appears to “hang”, click Halt.

Step Out

Not available.

Reset F6

Issue a Reset sequence to the target processor. This issues a MCLR to reset the

program counter to the Reset vector.

Breakpoints

Open the Breakpoint dialog (see Section 9 .3.1 “Breakpoints Dialog”). Set multiple

breakpoints in this dialog.

Program

Download your code to the target device.

Read

Read target memory. Information uploaded to MPLAB IDE.

Erase Flash Device

Erase all Flash memory.

Debug Read

Reads program memory using the debug executive.

Abort Operation

Abort any programming operation (e.g., program, read, etc.). Terminating an operation

will leave the device in an unknown state.

Reconnect

Attempt to re-establish communications between the PC and the MPLAB ICD 3

in-circuit debugger. The progress of this connection is shown on the ICD 3 tab of the

Output dialog.

Settings

Open the Prog ramme r dia log (see Section 9.5 “Settings Dialog”). Set up program

and firmware options.

Note: Do not step into a SLEEP instruction.

Note: You may also right click or double click on a line of code to set a simple

breakpoint.

Debugger Function Summary

9.2.2 Right Mouse Button Debugger Menu

These debugger menu options will appear on the right mouse menus in code displays,

such as program memory and source code files. Descriptions of other menu options

not listed here can be found in the MPLAB IDE Help or the MPLAB Editor Help.

Set Breakpoint

Set or remove a breakpoint at the currently selected line.

Breakpoints

Remove, enable or disable all breakpoints.

Run To Cursor

Run the program to the current cursor location. Formerly Run to Here.

Set PC at Cursor

Set the Program Counter (PC) to the cursor location.

Center Debug Location

Center the current PC line in the window.

9.2.3 Toolbars/Status Bar

When the MPLAB ICD 3 in-circuit debugger is selected as a debugger, these toolbars

are displayed in MPLAB IDE:

• Basic debug toolbar (Run, Halt, Animate, Step Into, Step Over, Step Out, Reset).

• Simple program toolbar (Read, Program, Erase Flash Device).

The selected debug tool (MPLAB ICD 3), as well as other development information, is

displayed in the status bar on the bottom of the MPLAB IDE desktop. Refer to the

MPLAB IDE on-line help for information on the contents of the status bar.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

9.3 DEBUGGING DIALOGS/WINDOWS

Open the following debug dialogs and windows using the menu items mentioned in

Section 9.2 “Debugging Functions”.

• Breakpoints Dialog

- Set Breakpoint Dialog

- Stopwatch Dialog

- Event Breakpoints Dialog

- Sequenced Breakpoints Dialog

- ANDed Breakpoints Dialog

9.3.1 Breakpoints Dialog

To set up breakpoints, select Debugger>Breakpoints.

Set up different types of breakpoints in this dialog. Click on Add Breakpoint to add

breakpoints to the dialog window. Depending on your selected device, there may be

other buttons for more advanced breakpoint options.

9.3.1.1 BREAKPOINT DIALOG WINDOW

Information about each breakpoint is visible in this window.

Once a breakpoint has been added to the window, you may right click on it to open a

menu of options:

• Delete – delete selected breakpoint

• Edit/View – open the Set Breakpoint Dialog

• Delete All – delete all listed breakpoints

• Disable All – disable all listed breakpoints

TABLE 9-1: BREAKPOINT DIALOG WINDOW

Control Function

Breakpoint Type Type of breakpoint – program or data

Address Hex address of breakpoint location

File Line # File name and line number of breakpoint location

Enabled Check to enable a breakpoint

Debugger Function Summary

9.3.1.2 BREAKPOINT DIALOG BUTTONS

Use the buttons to add a breakpoint and set up additional break conditions. Also, a

stopwatch is available for use with breakpoints and triggers.

9.3.2 Set Breakpoint Dialog

Click Add Breakpoint in the Breakpoints Dialog to display this dialog.

Select a breakpoint for the Breakpoints dialog here.

9.3.2.1 PROGRAM MEMORY TAB

Set up a program memory breakpoint here.

Note: Buttons displayed will depend on the selected device.

TABLE 9-2: BREAKPOINT DIALOG BUTTONS

Control Function Related Dialog

Add Breakpoint Add a breakpoint Section 9.3.2 “Set Breakpoint

Dialog”

Stopwatch Set up the stopwatch Section 9.3.3 “Stopwatch Dia-

log”

Event Breakpoints Set up break on an event Section 9.3.4 “Event Break-

points Dialog”

Sequenced Breakpoints Set up a sequence until break Section 9.3.5 “Sequenced

Breakpoints Dialog”

ANDed Breakpoints Set up ANDed condition until

break Section 9.3.6 “ANDe d Break-

points Dialog”

TABLE 9-3: PROGRAM MEMORY BREAKPOINT

Control Function

Address Location of breakpoint in hex

Breakpoint Type The type of program memory breakpoint. See the device data

sheet for more information on table reads/writes.

Program Me mory Execution – break on execution of above

address

TBLRD Program Memory – break on table read of above address

TBLWT Program Memory – break on table write to above address

Pass Cou nt Break on pas s co unt co ndition.

Always break – always break as specified in “Breakpoint type”

Break occurs Count instructions after Event – wa i t Count (0 - 2 5 5 )

instructions before breaking after event specified in “Breakpoint

type”

Event mu st occ ur Count times – break on ly af ter ev ent sp ecifi ed in

“Breakpoint type” occurs Count (0-255) times

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

9.3.2.2 DATA MEMORY TAB

Set up a data memory breakpoint here.

9.3.3 Stopwatch Dialog

Click Stopwatch in the Breakpoints Dialog to display this dialog.

The stopwatch allows timing from one breakpoint/trigger condition to the next. The

stopwatch value is in decimal.

TABLE 9-4: DATA MEMORY BREAKPOINT

Control Function

Address Location of breakpoint in hex

Breakpoi nt T ype Th e type o f data memory breakpoin t. See t he device d ata s heet for

Archive

A collection of relocatable object modules. It is created by assembling multiple source

files to object files, and then using the archiver to combine the object files into one

library file. A library can be linked with object modules and other libraries to create

executable co de.

Archiver

A tool that creates and manipulates libraries.

ASCII

American S tandard 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.

Assembler

A language tool that translates assembly language source code into machine code.

Assembly Language

A programming language that describes binary machine code in a symbolic form.

Asynchronous Stimulus

Data generated to simulate external inputs to a simulator device.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

Bookmarks

Use bookmarks to easily locate specific lines in a file.

Under the Edit menu, select Bookmarks to manage bookmarks. Toggle (enable /

disable) a bookmark, move to the next or previous bookmark, or clear all bookmarks.

Breakpoint, Hardware

An event whose execution will cause a halt.

Breakpoint, Software

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.

A general-purpose programming language which features economy of expression,

modern control flow and data structures, and a rich set of operators.

Calibration Memory

A special function register or registers used to hold values for calibration of a PIC

microcontroller on-board RC oscillator or other device peripherals.

Clean

Under the MPLAB IDE Project menu, 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 Object 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.

Compiler

A program that translates a source file written in a high-level language into machine

code.

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.

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 listed is the location of the definition. The remaining

files contain references to the symbol.

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.

Glossary

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.

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.

Device Programmer

A tool used to program electrically programmable semiconductor devices such as

microcontrollers.

Digital Signal Controller

A microcontroller device with digital signal processing capability, i.e., Microchip dsPIC

DSC devices.

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

debugger, programmer or target board.

DSC

See Digital Signal Controller.

EEPROM

Electrically Erasable Programmable Read Only Memory. A 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.

Emulation

The process of executing software loaded into emulation memory as if it were firmware

residing on a microcontroller device.

Emula t ion Mem o r y

Program memory contained within the debugger.

Debugger

Hardware that performs emulation.

Debugger Syste m

The MPLAB ICE 2000 and MPLAB ICE 4000 debugger systems include the pod, pro-

cessor module, device adapter, target board, cables, and MPLAB IDE software. The

MPLAB ICD 3 system consists of a pod, a driver (and potentially a receiver) card, target

board, cables, and MPLAB IDE software.

Environment – IDE

The particular layout of the desktop for application development.

Environment – MPLAB PM3

A folder containing files on how to program a device. This folder can be transferred to

a SD/MMC card.

EPROM

Erasable Programmable Read Only Memory. A programmable read-only memory that

can be erased usually by exposure to ultraviolet radiation.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

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.

Export

Send data out of the MPLAB IDE in a standardized format.

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 PIC17 or PIC18 device.

External Label

A label that has extern al lin ka ge.

Extern al Lin kag e

A function or variable has external linkage if it can be referenced from outside the

module in which it is defined.

Exte rnal Symbol

A symbol for an identifier which has external linkage. This may be a reference or a

definition.

External Symbol Resolu tio n

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.

File Registers

On-chip data memory, including General Purpose Registers (GPRs) and Special

Function Regi ste rs (S FR s).

Filter

Determine by selection what data is included/excluded in a trace display or data file.

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 instruction.

Since the PIC microcontroller architecture is pipelined, it prefetches the next instruction

in the physical address space while it is executi ng the current instruction. However, if

the current instruction changes the program counter, this prefetched instruction is

explicitly ignored, causing a forced NOP cycle.

GPR

General Purpose Register. The portion of device data memory (RAM) available for

general use.

Halt

A stop of program execution. Executing Halt is the same as stopping at a breakpoint.

Glossary

Hex Code

Executable instructions stored in a hexadecimal format code. Hex code is contained in

a hex file.

Hex File

An ASCII file containing hexadecimal addresses and values (hex code) suitable for

progra mming a de vice.

High Level Language

A language for writing programs that is further removed from the processor than

assembly.

ICD

In-Circuit Debugger. MPLAB ICD 2 is Microchip’s in-circuit debugger.

ICE

In-Circuit Debugger. MPLAB ICE 2000, MPLAB ICE 4000 and MPLAB ICD 3 system

are Microchip’s in-circuit debuggers.

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. MPLAB IDE is Microchip’s integrated

development environment.

Import

Bring data into the MPLAB IDE from an outside source, such as from a hex file.

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.

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 Request

An event which causes the processor to temporarily suspend normal instruction exe-

cution and to start executing an interrupt handler routine. Some processors have

several interrupt request events allowing different priority interrupts.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

Interrupt Service Routine

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.

IRQ

See Interrupt Request.

ISO

See International Organization for Standardization.

ISR

See Interrupt Service Routine.

Librarian

See Archiver.

Library

See Archive.

Linker

A 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 spec ifi ca tio n of titles , paginati on and othe r listi ng co ntr ol .

Listing File

A listing file is an ASCII text file that shows the machine code generated for each C

source statement, assembly instruction, assembler directive, or macro encountered in

a source file.

Local La bel

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 debuggers. The logic

probes provide external trace inputs, trigger output signal, +5V, and a common ground.

Machine Code

The representation of a computer program that is actually read and interpreted by the

processor. A program 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

processo r with out bei ng trans lat ed.

Macro

Macro instruction. An instruction that represents a sequence of instructions in abbrevi-

ated form.

Glossary

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, i.e., with a make.

Under Project>Build Options>Project, Directories tab, you must have selected

“Assemble/Compile/Link in the project directory” under “Build Directory Policy” for this

feature to work.

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 μC.

Message

Text displayed to alert you to potential problems in language tool operation. A message

will not stop operati on.

Microcontroller

A highly integrated chip that contains a CPU, RAM, program memory, I/O ports and

timers.

Microcontroller Mode

One of the possible program memory configurations of PIC17 and PIC18 microcon-

trollers. In microcontroller mode, only internal execution is allowed. Thus, only the

on-chip program memory is available in microcontroller mode.

Microprocessor Mode

One of the possible program memory configurations of PIC17 and PIC18 microcon-

trollers. 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.

MPASM™ Assembler

Microchip Technology’s relocatable macro assembler for PIC microcontroller devices,

KeeLoq® devices and Microchip memory devices.

MPLAB ASM30

Microchip’s relocatable macro assembler for dsPIC digital signal controller and PIC24

PIC devices.

MPLAB C17

Obsoleted along with PIC17 MCU devices. See the MPLAB C18 C compiler.

Refers to the MPLAB C17 C compiler from Microchip. MPLAB C17 is the C compiler

for PIC17 MCU devices.

MPLAB C18

Refers to the MPLAB C18 C compiler from Microchip. MPLAB C18 is the C compiler

for PIC18 MCU devices.

MPLAB C30

Microchip’s C compiler for dsPIC digital signal controller and PIC24 PIC devices.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

MPLAB ICD 2

Microchip’s in-circuit debugger that works with MPLAB IDE. The ICD supports Flash

devices with built-in debug circuitry. The main component of each ICD is the pod. A

complete system consists of a pod, header board (with a device-ICD), target board,

cables, and MPLAB IDE software.

MPLAB ICE 2000

Microchip’s in-circuit debugger that works with MPLAB IDE. MPLAB ICE 2000 supports

8-bit PIC MCUs. The main component of each ICE is the pod. A complete system con-

sists of a pod, processor module, cables, and MPLAB IDE software.

MPLAB ICE 4000

Not recommended for new designs. See the MPLAB ICD 3 in-circuit debugger.

Microchip’s in-circuit debugger that works with MPLAB IDE. MPLAB ICE 4000 supports

PIC18F and PIC24 MCUs and dsPIC DSCs. The main component of each ICE is the

pod. A complete system consists of a pod, processor module, cables, and MPLAB IDE

software.

MPLAB IDE

Microchip’s Integrated Development Environment.

MPLAB LIB30

MPLAB LIB30 archiver/librarian is an object librarian for use with object modules

created using either MPLAB ASM30 or MPLAB C30 C compiler.

MPLAB LINK30

MPLAB LINK30 is an object linker for the Microchip MPLAB ASM30 assembler and the

Microchip MPLAB C30 C compiler.

MPLAB PM3

A device programmer from Microchip. Programs PIC18 microcontrollers and dsPIC

digital signal controllers. Can be used with MPLAB IDE or stand-alone. Will obsolete

PRO MATE II.

MPLAB ICD 3 In-Circuit Debugger

Microchip’s in-circuit debuggers that works with MPLAB IDE. The MPLAB ICD 3

debugger supports PIC18F and PIC24 MCUs and dsPIC DSCs. The main component

of each ICE is the pod. A complete system consists of a pod, a driver (and potentially

a receiver) card, cables, and MPLAB IDE software.

MPLAB SIM

Microchip’s simulator that works with MPLAB IDE in support of PIC MCU and dsPIC

DSC devices.

MPLIB™ Object Librarian

Microchip’s librarian that can work with MPLAB IDE. MPLIB librarian is an object librar-

ian for use with COFF object modules created using either MP ASM assembler (mpasm

or mpasmwin v2.0) or MPLAB C17/C18 C compilers.

MPLINK™ Object Linker

MPLINK linker is an object linker for the Microchip MPASM assembler and the Micro-

chip MPLAB C17 or C18 C compilers. MPLINK linker also may be used with the Micro-

chip MPLIB librarian. MPLINK linker is designed to be used with MPLAB IDE, though

it does not have to be.

MRU

Most Recently Used. Refers to files and windows available to be selected from MPLAB

IDE main pull down menus.

Glossary

Nesting Depth

The maximum level to which macros can include other macros.

Node

MPLAB IDE project component.

Non Real Time

Refers to the processor at a breakpoint or executing single-step instructions or MPLAB

IDE being run in simulator mode.

Non-Volatile Storage

A storage device whose contents are preserved when its power is off.

NOP

No Operation. An instruction that has no effect when executed except to advance the

program counter.

Object Code

The machine code generated by an assembler or compiler.

Object File

A file containing machine code and possibly debug information. It may be immediately

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.

Off-Chip Memory

Off-chip memory refers to the memory selection option for the PIC17 or PIC18 device

where memory may reside on the target board, or where all program memory may be

supplied by the debugger. The Memory tab accessed from Options>Development

Mode provides the Off-Chip Memory selection dialog box.

One-to-One Project-Workspace Model

The most common configuration for application development in MPLAB IDE to is have

one project in one workspace. Select Configure>Settings, Projects tab and check “Use

one-to-one project-workspace model”.

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.

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.

Person al Comp ute r or Progra m Counte r.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

PC Host

Any PC running a supported Windows operating system.

PIC MCUs

PIC microcontrollers (MCUs) refers to all Microchip microcontroller families.

PICSTART Plus

A developmental device programmer from Microchip. Programs 8-, 14-, 28-, and 40-pin

PIC microcontrollers. Must be used with MPLAB IDE software.

Plug-ins

The MPLAB 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

MPLAB ICD 3 system: The box that contains the emulation control circuitry for the ICE

device on the header or target board. An ICE device can be a production device with

built-in ICE circuitry or a special ICE version of a production device (i.e., device-ICE).

MPLAB ICD 2: The box that contains the debug control circuitry for the ICD device on

the header or target board. An ICD device can be a production device with built-in ICD

circuitry or a special ICD version of a production device (i.e., device-ICD).

MPLAB ICE 2000/4000: The external debugger box that contains emulation memory,

trace memory, event and cycle timers, and trace/breakpoint logic.

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.

PRO MATE II

No longer in Production . See the MPLAB PM3 device programmer.

A device programmer from Microchip. Programs most PIC microcontrollers as well as

most memory and KEELOQ devices. Can be used with MPLAB IDE or stand-alone.

Profile

For MPLAB SIM simulator, a summary listing of executed stimulus by register.

Program Counter

The location that contains the address of the instruction that is currently executing.

Program Memory

The memory area in a device where instructions are stored. Also, the memory in the

debugger or simulator containing the downloaded target application firmware.

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.

Prototype System

A term referring to a user's target application, or target board.

PWM Signals

Pulse-Width Modulation Signals. Certain PIC MCU devices have a PWM peripheral.

Qualifier

An address or an address range used by the Pass Counter or as an event before

another operation in a complex trigger.

Glossary

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 Dat a

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 debugger 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 debugger is enabled and constantly

captures all selected cycles, and all break logic is enabled. In an in-circuit debugger 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.

Real-Time Watch

A W atch window where the variables change in real-time as the application is run. See

individual tool documentation to determine how to set up a real-time watch. Not all tools

support real-time watches.

Recursion

The concept that a function or macro, having been defined, can call itself. Great care

should be taken when writing recursive macros; it is easy to get caught in an infinite

loop where there will be no exit from the recursion.

ROM

Read Only Memory (Program Memory). Memory that cannot be modified.

Run

The command that releases the debugger from halt, allowing it to run the application

code and change or respond to I/O in real time.

Scenario

For MPLAB SIM simulator, a particular setup for stimulus control.

SFR

See Special Function Registers.

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.

Simulator

A software progr am that mod els th e operati on of devi c es.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

Single Step

This command steps though code, one instruction at a time. After each instruction,

MPLAB IDE updates register windows, watch variables, and status displays so you can

analyze and debug instruction execution. You can also single step C compiler source

code, but instead of executing single instructions, MPLAB 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.

Special Function Registers

The portion of data memory (RAM) dedicated to registers that control I/O processor

functions, I/O status, timers or other modes or peripherals.

Stack, Hardw ar e

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 typically managed by the compiler when developing

code in a high-level language.

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 S t atus Bar is located on the bottom of the MPLAB IDE window and indicates such

current information as cursor position, development mode and device, and active tool

bar.

Step Into

This command is the same as Single S tep. S tep Into (as opposed to S tep Over) follows

a CALL instruction into a subroutine.

Glossary

Step Over

S tep 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.

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/enum/union tag names, etc. Symbols in MPLAB IDE refer

mainly to variable names, function names and assembly labels. The value of a symbol

after linking is its value in memory.

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.”

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 functions.

Trace

An debugger or simulator function that logs program execution. The debugger logs pro-

gram execution into its trace buffer which is uploaded to MPLAB IDE’s trace window.

Tr ace Memor y

Trace memory contained within the debugger. Trace memory is sometimes called the

trace buf fer.

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

Trigger Output

Trigger output refers to an debugger 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.

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 debugger or programmer,

to the host PC or from the target board to the debugger.

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 supports data rates up to 480 Mbps.

Warning

An alert that is provided to warn you of a situation that would cause physical damage

to a device, software file, or equipment.

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

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.

WDT

See Watchdog Ti mer.

Workbook

For MPLAB SIM stimulator, a setup for generation of SCL stimulus.

WorkSpace

A workspace contains MPLAB IDE information on the selected device, selected debug

tool and/or programmer , open windows and their location, and other IDE configuration

settings.

MPLAB® ICD 3 IN-CIRCUIT

DEBUGG ER USER’S GUIDE

Index

Abort Operation........................................................66

Animate.................................................................... 65

AVdd ........................................................................ 16

AVss......................................................................... 16

Blank Check............................................................. 73

Breakpoints

Dialog................................................................ 68

Enabling............................................................ 67

Hardware ...............................................41, 63, 75

Setup .....................................................41, 63, 66

Software.................................................44, 63, 75

Build Configuration..............................................20, 58

Cables

Length..........................................................80, 82

Capacitors...........................................................16, 17

CD-ROM .................................................................. 10

Circuits That Will Prevent the Debugger

From Functi oni ng ............... ...... ...... ...................... 17

Code Protect............................................................ 18

CodeGuard Security ................................................ 77

Configuration Bits..........................................18, 27, 36

Creating a Hex File .................................................. 37

Customer Notification Service....................................5

Customer Support...................................................... 6

Debug

Executive .......................................................... 19

Registers........................................................... 20

Debug Mode

Sequence of Operations................................... 18

Debug Read............................................................. 66

Debugger Men u................ ..... ...... ...... ...................... 40

Debugging................................................................ 40

Demo Board...................... ....................................... 39

Device and Feature Support.................................... 11

Documentation

Conventions........................................................ 3

Layout................................................................. 1

Download Firmware................................................. 75

Driver Board

Standard ........................................................... 81

Durability, Card Guide.............................................. 80

Erase........................................................................73

Erase All Before Programming.................................37

Erase Flash Device..................................................66

Explorer 16 Demo Board..........................................29

Feature Support.......................................................11

Firmware Downloads ............................................... 75

Freeze on Halt..........................................................50

General Corrective Actions...................................... 57

Halt...........................................................................65

Hardware Breakpoints..............................................41

Header Board

Specification........................................................4

Hex File....................................................................37

Hibernate mo de...................... .......................50, 51, 80

Hubs, USB ............................................................... 80

ICD 3 Test Interface Board ................................ 10, 82

ICD Headers ............................................................10

ICD3Err0001............................................................ 53

ICD3Err0002............................................................ 53

ICD3Err0003............................................................ 53

ICD3Err0005............................................................ 53

ICD3Err0006............................................................ 53

ICD3Err0007............................................................ 53

ICD3Err0008............................................................ 53

ICD3Err0009............................................................ 53

ICD3Err0010............................................................ 53

ICD3Err0011............................................................ 53

ICD3Err0012............................................................ 54

ICD3Err0013............................................................ 54

ICD3Err0014............................................................ 54

ICD3Err0015............................................................ 54

ICD3Err0016............................................................ 54

ICD3Err0017............................................................ 54

ICD3Err0018............................................................ 54

ICD3Err0019............................................................ 54

ICD3Err0020............................................................ 54

ICD3Err0021............................................................ 54

ICD3Err0022............................................................ 54

ICD3Err0023............................................................ 54

ICD3Err0024............................................................ 54

ICD3Err0025............................................................ 54

ICD3Err0026............................................................ 54

ICD3Err0027............................................................ 54

MPLAB® ICD 3 In-Circuit Debugger User’s Guide

ICD3Err0028 ............................................................54

ICD3Err0029 ............................................................54

ICD3Err0030 ............................................................55

ICD3Err0031 ............................................................55

ICD3Err0032 ............................................................55

ICD3Err0033 ............................................................55

ICD3Err0034 ............................................................55

ICD3Err0035 ............................................................55

ICD3Err0036 ............................................................55

ICD3Err0037 ............................................................55

ICD3Err0038 ............................................................55

ICD3Err0039 ............................................................55

ICD3Err0040 ............................................................55

ICD3Err0041 ............................................................55

ICD3Err0045 ............................................................55

ICD3Err0046 ............................................................56

ICD3Err0047 ............................................................56

ICD3Err0052 ............................................................56

ICD3Err0053 ............................................................56

ICD3Err0054 ............................................................56

ICD3Err0055 ............................................................56

ICD3Err0056 ............................................................56

ICD3Err0057 ............................................................56

ICD3Err0063 ............................................................56

ICD3Err0064 ............................................................56

ICD3Err0065 ............................................................56

ICD3Err0066 ............................................................56

ICD3Err0067 ............................................................56

ICD3Err0068 ............................................................56

ICD3Err0069 ............................................................56

ICD3Err0070 ............................................................56

ICD3Err0071 ............................................................56

ICD3Err0072 ............................................................56

ICD3Err0073 ............................................................56

ICSP........................................................18, 19, 20, 81

ICSPCLK..................................................................81

ICSPDAT..................................................................81

Indicator Lights.........................................................80

Internet Address.........................................................5

Kit Components........................................................10

LEDs .................................................................. 29, 80

Light Icons................................................................30

Loading Program and Debug Code..........................39

Microchip Internet Web Site.......................................5

Modular Interface Cable...........................................18

MPLAB C30 .............................................. ..... ...... ....33

MPLAB ICD 3 Defined................................................9

MPLAB IDE................... ..... ...... ..... ...... .....................21

PC, Power Down.......................................... 50, 51, 80

PGC...................................................15, 16, 17, 18, 19

PGD...................................................15, 16, 17, 18, 19

PIC24FJ128GA010, Tutorial....................................29

PIM...........................................................................14

Port A .......................................................................29

Power-Down mode....................................... 50, 51, 80

Processor Extension Kits .........................................10

Program..............................................................66, 73

Program after successful build.................................74

Program Memory Tab ..............................................37

Programming............................................................45

Programming Options ..............................................36

Project Wizard....................................................26, 33

Pull-ups ....................................................................17

Read...................................................................66, 73

Reading, Reco mm en ded............... ...... ...................... .4

Readme......................................................................4

Reconnect ................................................................66

Reserved Resources by Device...............................20

Reset

Processor..........................................................66

Resistors ..................................................................17

Run...........................................................................65

Run after successful program ..................................74

Running code ...........................................................40

Secure Segments.....................................................77

Selecting Device and Development Mode ...............30

Set a Breakpoint.......................................................41

Setting Program and Debug Options .......................38

Setting Up Hardware and Software..........................30

SMPS.......................................................................11

Software Breakpoints...............................................44

Standard Communication

Connections......................................................15

Driver Board...................... ..... ...... ...... ..... ..........81

Standard ICSP Device Communication ...................14

Step..........................................................................65

Stopwatch...........................................................43, 63

Table Read Protect ..................................................18

Target Connection

Circuitry.............................................................15

Improper Circ uits......... ...... ..... ...... ...... ..... ..........17

Standard............................................................15

Target Device...........................................................18

Timer1......................................................................29

Toolbar Buttons........................................................40

Transiti on Socket................................. ...... ..... ...... ....10

Specification.................................................. 4, 23

Tutorial .....................................................................29

Index

USB.....................................................................80, 98

Cables............................................................... 10

Device Drivers ................ ...... ...... ..... ................. 21

Hubs ................................................................. 80

Vcap......................................................................... 16

Vdd..........................................................15, 16, 17, 18

Verify........................................................................ 73

Vpp....................................................15, 16, 17, 18, 19

Vss..........................................................15, 16, 17, 18

Warranty Regi stra tio n.................. ...... ..... ...... ............. 4

Watch Window......................................................... 42

Watchdog Timer..................................................18, 98

WWW Address........................................................... 5

AMERICAS

Corporate Office

2355 West Chandler Blvd.

Chandler, AZ 85224-6199

Tel: 480-792-7200

Fax: 480-792-7277

Technical Support:

http://support.microchip.com

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

Itasc a , IL

Tel: 630-285-0071

Fax: 630-285-0075

Dallas

Addison, TX

Tel: 972-818-7423

Fax: 972-818-2924

Detroit

Farmington Hills, MI

Tel: 248-538-2250

Fax: 248-538-2260

Kokomo

Kokomo, IN

Tel: 765-864-8360

Fax: 765-864-8387

Los A n ge les

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-8528-2100

Fax: 86-10-8528-2104

China - Chengdu

Tel: 86-28-8665-5511

Fax: 86-28-8665-7889

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 - Xiamen

Tel: 86-592-2388138

Fax: 86-592-2388130

China - Xian

Tel: 86-29-8833-7252

Fax: 86-29-8833-7256

China - Zhuhai

Tel: 86-756-3210040

Fax: 86-756-3210049

ASIA/PACIFIC

India - Bangalore

Tel: 91-80-4182-8400

Fax: 91-80-4182-8422

India - New Delhi

Tel: 91-11-4160-8631

Fax: 91-11-4160-8632

India - Pune

Tel: 91-20-2566-1512

Fax: 91-20-2566-1513

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-572-9526

Fax: 886-3-572-6459

Taiwan - Kaohsiung

Tel: 886-7-536-4818

Fax: 886-7-536-4803

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 - Cop e nha gen

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-14 4-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

WORLDWIDE SALES AND SERVICE

01/02/08

Mouser Electronics

Authorized Distributor

Click to View Pricing, Inventory, Delivery & Lifecycle Information:

Microchip:

DV164035