Microchip Technology MPLAB® ICD 3 User’s Guide

Download

MPLAB® ICD 3

In-Circuit Debugger

User’s Guide

Note the following details of the code protection feature on Microchip devices:

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

• Microchip believes that its family of products is one of the most secure families of its kind on the market today, when used in the intended manner and under normal conditions.

• There are dishonest and possibly illegal methods used to breach the code protection feature. All of these methods, to our knowledge, require using the Microchip products in a manner outside the operating specifications contained in Microchip’s Data Sheets. Most likely, the person doing so is engaged in theft of intellectual property.

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

• Neither Microchip nor any other semiconductor manufacturer can guarantee the security of their code. Code protection does not mean that we are guaranteeing the product as “unbreakable.”

Code protection is constantly evolving. We at Microchip are committed to continuously improving the code protection features of our products. Attempts to break Microchip’s code protection feature may be a violation of the Digital Millennium Copyright Act. If such acts allow unauthorized access to your software or other copyrighted work, you may have a right to sue for relief under that Act.

Information contained in this publication regarding device applications and t he lik e is provided only for your convenience and may be su perseded by upda t es . It is y our responsibility to ensure that your application meets with your specifications. MICROCHIP MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION, INCLUDING BUT NOT LIMITED TO ITS CONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY OR FITNESS FOR PURPOSE. Microchip disclaims all liability arising from this information and its use. Use of Microchip devices in life supp ort and/or safety ap plications is entir ely at the buyer’s risk, and the buyer agrees to defend, indemnify and hold harmless M icrochip from any and all dama ges, claims, suits, or expenses re sulting from such use. No licens es are conveyed, implicitly or otherwise, under any Microchip intellectual property rights.

Trademarks

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

EELOQ, KEELOQ logo, MPLAB, PIC, PICmicro,

PICSTART, rfPIC, SmartShunt and UNI/O are registered trademarks of Microchip Tec hnology Incorporated in the U.S.A. and other countries.

FilterLab, Linear Active Thermistor, MXDEV, MXLAB, SEEVAL, 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 Programmin g , IC SP, ICE P I C , M in d i , MiWi, MPASM, MPLAB Certified logo, MPLIB, MPLINK, mTouch, PICkit, PICDEM, PICDEM.net, PICtail, PIC

logo, PowerCal, PowerInfo, PowerMate, PowerT ool, REAL ICE, rfLAB, Select Mode, Total Endurance, WiperLock and ZENA are trademarks of Microchip Technology In corporated in the U.S.A. and other countries.

SQTP is a service mark of Microchip Technology Incorporated in the U.S.A.

All other trademarks mentioned herein are property of their respective companies.

Printed on recycled paper.

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 devices, Serial EEPROMs, microperipherals, nonvolatile memory and analog products. In addition, Microchip’s quality system for the design and manufacture of development systems is ISO 9001:2000 certified.

MCUs and dsPIC® DSCs, KEELOQ

code hopping

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER 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-Cir cuit 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 Operation

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 Requirem e n t s F o r D e b ugg ing .............. .. ... ............. .. .. .............. .. .................. 18

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 Installing th e USB D e vi c e D r iv e rs ............. ............... .................................... 21

3.4 Connecti n g the T a rg e t ............................................ ...................................... 22

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 Viewing the Pr o je c t ......... ..................................................................... ......... 26

4.5 Building the Pr o je c t ............. .................................................................... ..... 26

4.6 Setting Con figuration Bits ........ ............. .. ... .......................... .. ... ............. .. .. ... 27

4.7 Setting the 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 Setting Up th e En v ir o n m e n t an d S e le c tin g th e Dev ice .......... ....................... 30

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

5.4 Running th e P roj e c t Wiz ar d .......................................................................... 33

5.5 Viewing the Pr o je c t .. ....................................................... .............................. 35

5.6 Viewing De bu g Op tions .......... ... .. ................................................................. 3 6

5.7 Creating a Hex Fi le ....................................................................................... 37

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

5.9 Loading Program 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

Chapter 7. Error Messages

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

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

7.3 General Co 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 Breakpoin ts ......................................................... ......................................... 63

8.3 Stopwatch ... .................................................................................................. 63

Chapter 9. Debugger Function Summary

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

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

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

9.4 Programm in g Fun c tions ..... .. ....................................................... ................. 73

9.5 Settings Dia lo g ............................................................................................. 74

Table of Contents

Chapter 10. Hardware Specification

10.1 Introd uc t io n ................................................................................................. 7 9

10.2 Highlig h t s ........... ......................................................................................... 79

10.3 Declar a tion of Conform ity ................................................ .. .. ....................... 79

10.4 USB Por t/Power ............. ... .. ............. .. .. ........................... .. .. .............. .. .. ..... 80

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

10.6 Standard Communication Hardware ..........................................................81

10.7 ICD 3 Te s t In te r fa c e Boa 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

DEBUGGER USER’S GUIDE

Preface

NOTICE TO CUSTOMERS

All documentation becomes dated, and this manual is no exception. Microchip tools and documentation are constantly evolving to meet customer needs, so some actual dialogs and/or tool descriptions may differ from those in this document. Please refer to our web site (www.microchip.com) to obtain the latest documentation available.

Documents are identified with a “DS” number. This number is located on the bottom of each page, in front of the p age number. The numbering convention for the DS number is “DSXXXXXA”, where “XXXXX” is the document number and “A” is the revision level of the document.

For the most up-to-date information on development tools, see the MPLAB Select the Help menu, and then Topics to open a list of available on-line help files.

INTRODUCTION

IDE on-line help.

This chapter contains general information that will be useful to know before using the MPLAB ICD 3 in-circuit debugger. Items discussed in this chapter include:

• Document Layout

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

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

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 ges – 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.

CONVENTIONS USED IN THIS GUIDE

This manual uses the following docum entat io n conven tion s:

DOCUMENTATION CONVENTIONS

Description Represents Examples

Arial font:

Italic chara c ters Referenced books MPLAB

Initial caps A window the Output window

Quotes A field name in a window or

Underlined, italic text with right angle bracket

Bold characters A dialog button Click OK

N‘Rnnnn A number in verilog format,

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

Courier New font:

Plain Courier New Sample source code #define START

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

Square brackets [ ] Optional arguments mcc18 [options] file

Curly brackets and pipe character: { | }

Ellipses... Replaces r epeated text var_name [,

Preface

IDE User’s Guide

Emphasized text ...is the only compiler...

A dialog the Settings dialog A menu selection select Enable Programmer

“Save project before build”

dialog A menu path File>Save

A tab Click the Power tab

4‘b0010, 2‘hF1 where N is the tota l number of digits, R is th e radi x and n is a digit.

Filenames autoexec.bat File paths c:\mcc18\h Keywords _asm, _endasm, static Command-line options -Opa+, -Opa- Bit values 0, 1 Constants 0xFF, ‘A’

any valid filename

[options]

Choice of mut ually exclus ive arguments; an OR selection

Represents code supplied by user

errorlevel {0|1}

var_name...]

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.

Part 1 – Getting Started

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

Chapter 2. Theory of Operation..................................................................................13

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

Chapter 4. General Setup......................................... ...................................................25

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

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

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER 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 Feature Support

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

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

Digital Signal Controllers (DSCs) that are based on In-Circuit Serial

microcontrollers (MCUs) and

platform. The

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

MPLAB® ICD 3

Modular Cable to Target Board

USB Cable to PC

Indicator Lights

or Header

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

• Monitor internal file register s

• Emulate full speed

• Program your device

1.4 MPLAB ICD 3 IN-CIRCUIT DEBUGGER KIT COMPONENTS

The components of the MPLAB ICD 3 in-circuit debugger system kit are:

1. MPLAB ICD 3 with indicator lights

2. USB cable to provide communications between the debugger and a PC and to provide power to the debugger

3. Cable (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:

• Transition socket

• ICD headers

• MPLAB processor extension kits

1.5 DEVICE AND FEATURE SUPPORT

Feature PIC32MX

dsPIC33F,

PIC24F/H

dsPIC30F

SMPS

(1)

dsPIC30F

Reset application 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 Breakpoints C C C C Advanced Breakpoints C C C C Software Breakpoint s

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

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

Overview

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

Feature PIC18FXXJ

PIC18F,

PIC18F Enh,

PIC18FXXK

PIC12F, PIC16F

Reset application C C C Run, Halt C C C Single Step C C C Animate

C C C

Full Speed Emulation C C C Hardware Breakpoints C C C Advanced Breakpoints

C C N

Software Breakpoint s 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.

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

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

• Communication Connection s

• Debugging with the Debugger

• Requirements For Debugging

• Programming with the Debugger

• Resources Used by the Debugger

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER USER’S GUIDE

2.2 MPLAB ICD 3 IN-CIRCUIT 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 systems (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. MPLAB 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:

• Features USB high speed

• 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

MPLAB® ICD 3

Target Board

Target Device

or PIM

Power

2.4 DEBUGGER TO TARGET COMMUNICATION

The debugger system configurations are discussed in the following sections.

CAUTION

Do not connect the hardware before installing the software and USB drivers. Also, do not change hardware connections when the pod or target is powered.

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

Note: Older header boards used a 6-pin (RJ-11) connector instead of an 8-pin

connector, so these headers may be connected directly to the debugger.

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

FIGURE 2-1: STANDARD DEBUGGER SYSTEM – DEVICE WITH

ON-BOARD ICE CIRCUITRY

Theory of Operation

MPLAB® ICD 3

Target Board

Transition Socket

Device-ICE

Processor Pak

Standard

Adapter

Header

Device-ICE

ICD Header

Power

12345

Target

Connector

Target Bottom Side

PC Board

VPP/MCLR

Vss

PGC

PGD

LVP

FIGURE 2-2: STANDARD DEBUGGER SYSTEM – ICE DEVICE

2.5 COMMUNICATION CONNECTIONS

2.5.1 Standard Communicat ion Target Connection

Using the RJ-11 connector, the MPLAB ICD 3 in-circuit debugger is connected to the target device with the modular interface (six conductor) cable. The pin numbering for the connector is shown from the bottom of the target PC board in Figure 2-3.

Note: Cable connections at the debugger and target are mirror images of each

other, i.e., pin 1 on one end of the cable is connected to pin 6 on the other end of the cable. See Section 10.6.2.3 “Modular Cable Specification”.

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 V strobed low to reset the device.

PP/MCLR line to VDD so that the line may be

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

VPP/MCLR

PGC

PGD

1 5 4 3

User Reset

4.7K-10K

Interface

Connector

Application

PC Board

Device

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 ( V 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 V the target low voltage operation. If the debugger does not sense voltage on its V (pin 2 of the interface connector), it will not operate.

PP/MCLR), 5 (PGC) and 4 (PGD). Pins 2 (VDD) and 3 (VSS) are

DD is sensed by the debugger to allow level translation for

DD line

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

DD is sensed by the debugger to allow level translation for

target low-voltage operation. If the debugger does not sense voltage on its V 2 of the interface connector), it will not operate.

Not all devices have the AV

DD 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 V the appropriate levels. Also, devices with a V

DD/AVDD and VSS/AVSS lines be connected to

CAP line (PIC18FXXJ for example) should

be connected to the appropriate capacitor or level.

Note: The interconnection is very simple. Any problems experienced are often

caused by other connections or components on these critical lines that

interfere with the operation of the MPLAB ICD 3 in-circuit debugger system, as discussed in the following section.

DD separated from the

DD line (pin

Theory of Operation

No!

VPP/MCLR

PGC PGD

Interface

Connector

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-cir cu it debu gge r sy st em from 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 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.

– they will prevent fast transitions of VPP. A

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 V debugger are not shown.

DD and VSS lines from the

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

+5V

Programming

4.7 k

VPP/MCLR

PGC

PGD

Internal Circuits

Voltage

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 programming levels on V 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.

PP/MCLR, sends clock pulses on PGC and serial data via

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 V target device with the modular interface cable (or equivalent). V 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 Timer is enabled by default and needs to be

disabled.

- The target device must not have code protection enabled.

- The target device must not have table read protection enabled.

• 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 (Debugger>Select Tool>MPLAB ICD 3

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

PP, PGC and PGD pins of the

SS and VDD are

Theory of Operation

+5V

+12V

4.7 k

Internal Circu its

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

Configuration>Debug.

• When Debugger>Program 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 V

2.7.2 Debugging Details

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

is selected, the application code is programmed into

PP/MCLR line low.

FIGURE 2-7: MPLAB

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 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 performed by the debug executive.

function or the Run icon (forward arrow) is usually pressed

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

the “Build Configuration” list box on the MPLAB IDE toolbar set to “Release”. Also, it may be set by se lecting 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 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 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. V 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.

and compile/assemble your application code with

selection to program a device,

line to

PP,

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.

Chapter 3. Installation

3.1 INTRODUCTION

How to install the MPLAB ICD 3 in-circuit debugger system is discussed.

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

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

debugger.

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER USER’S GUIDE

3.3 INSTALLING THE USB DEVICE 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: 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

USB/Power

From PC

Communications Cable

From Target

MPLAB® ICD 3

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 “Background Debugge r Enab le ” Configuration bit.

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

The target board must have a connector to accommodate the communications chosen for the debugger. For connection information, see Section 2.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).

Note: In the future, ICD header boards with ICD devices (Device-ICD) may 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” (DS51 194).

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 V a small target board.

• The desired method is for the target to provide V 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.

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.

DD as it can provide a wider

DD from 3-5V t o

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 pow er 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 Chapter 5. “Tutorial”.

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

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER 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 the MPLAB IDE Software

• Creating a Project

• Viewing the Project

• Building the Project

• Setting Configuration Bits

• Setting the Debugger as the Debugger or Programmer

• Debugger/Programme 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 Star t>Progra ms>Microch ip>MPLAB I DE vx.xx> MPLAB IDE 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.

, where vx.xx i s

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) Note: If you do not have a custom linker script in your project, the Project

Manager will select the appropriate linker script for you.

4.4 VIEWING THE PROJ ECT

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

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

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.

When done, choose Project>Build All

to build the project.

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 the text in the “Settings” column, these can be changed.

Some Configuration bits of interest are:

• Watchdog T imer 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 communcations 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 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 (Section 9.5 “Settings Dialog”) and set up options as needed.

If errors occurs, see:

• Chapter 7. “Erro r Message s”

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

• Section 10.7 “ICD 3 Test Interface Board”

or Programmer>Settings to open the Settings dialo g

ICD 3 to choose the MPLAB ICD 3

. By clicking on

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

and click

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

NOTES:

5.1 INTRODUCTION

This tutorial walks you through the process of developing a simple project using the sample 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 App lication

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER USER’S GUIDE

Chapter 5. Tutorial

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: MPLAB

IDE DESKTOP

Selecting the Device

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 C:\Projects\ICD3Tut.

2. Open an editor window by selecting File>New 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 second program (see text for timer.c) in this window and save to the project\directory folder.

Explorer, create a project folder and directory, for example,

. Enter the code for the first

. Enter the code for the

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

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

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 Toolsuite.” 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.

. A Welcome screen will

Tutorial

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.

5.5 VIEWING THE PROJ ECT

After exiting the wizard, the MPLAB IDE desktop will again be visible. If the project window is not open, select V

FIGURE 5-5: PROJECT WIN DOW

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.

Tutorial

iew/Project to see the Project window.

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 unchecking “Configuration bits set in code”. Do not change any values for this tutorial.

FIGURE 5-6: CONFIGURATION BITS WINDOW

and

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.

FIGURE 5-7: DEBUGGER PROGRAM MEMORY TAB

Tutorial

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 Proj ect >B ui ld Al l

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.

or right click on the project name in the project window

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

different from Figure 5-8 (Project>Build Options>Project MPLAB LINK30 tabs.)

, MPLA B C30 and

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

FIGURE 5-8: OUTPUT WINDOW

FIGURE 5-9: WINDOWS EXPLORER – PROJECT FILES

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.

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.

Tutorial

During programming, 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

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

ICD 3 TAB

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.

Debugger Menu

Toolbar Buttons

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

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

4. Select Debugger>Halt 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>Step Into 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.

Run Halt Animate Step Into Step Over Step Out Reset

(or click the Run toolbar button).

(or click the Halt toolbar button) to stop the program

(or click the Step Into toolbar button) to execute one

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.1 1.1 Choosing a Breakpoint Type

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

To set breakpoint options, select Debugger>Settings 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.)

and click on the Configuration

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

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

(or click the Run toolbar button) to run the program once

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 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 “PORTA” 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: WATCH WINDOW

. The Watch dialog opens with the Watch

6. Select Debugger>Run 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

Debug

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

the processor.

(or click the Run toolbar button) to run the program once

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 also allows you to control breakpoint interaction.

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

MPLAB IDE will warn you.

1. Select Debugger>Breakpoints 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

to open the Breakpoints dialog. The breakpoint

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.1 1.4 Using the Stopwatch 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 condition will cause the target device 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 dialog, 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

Break

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

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

•Click OK.

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

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.

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.

and click on the Configuration tab.

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 hardware breakpoints as you select them. In the Output window, you will see: Converting breakpoint types... Breakpoint type conversion complete.

Follow the steps as specified 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

“Use Hardware Breakpoints” and then click OK.

, click on th e Configuration tab, click the radio button next to

5.12 PROGRAMMING THE APPLICATION

Tutorial

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>

3. Optional: Set up the ID in Configure>ID Memory memory.)

4. Set up the parameters for programming on the Programmer>Settings 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) button 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>

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.

ICD 3.

(for devices that support ID

, Program

ICD 3.

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

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER USER’S GUIDE

Part 2 – Troubleshooting

Chapter 6. Frequently Asked Questions (FAQs).......................................................49

Chapter 7. Error Messages.............................. .... ........................................................53

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

NOTES:

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 throughput of the pro ces sor affe cte d by ha ving to ru n the debug

executive?

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER USER’S GUIDE

• 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-Circuit Emul ators” and Section 2.3 “MPLAB ICD 3 In-Circuit Debugger vs. MPLAB ICD 2 Debugger”.

• How does MPLAB IDE interface 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 communication. The debugger contains an FPGA, large SRAM Buffers (1Mx8) and a High Speed USB interface. Program memory image is downloaded and is contained 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 debugger? 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 optoisolated or electrically isolated?

They are DC optoisolated, but not AC optoisolated. You cannot apply a floating or high voltage (120V) to the current system.

• What 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 power-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 register (usually either bit 14 or 5) is used as a Freeze bit by the debugger. If you have performed a write to the entire register, you may have overwritten this bit. (The bit is user-accessible in Debug mode.)

To avoid this problem, write only to the bits you wish to change for your application (BTS, BTC) instead of to the entire register (MOV).

Frequently Asked Questions (FAQs)

• When using a 16-bit device, an unexpected reset occurred. How do I determine what caused it?

Some things to consider:

- To determine a reset source, check the RCON register.

- Handle traps/interrupts in an Interrupt Service Routine (ISR). Y ou 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 production device? Programming a device when the debugger is a debugger will program 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 Project menu? You must do this for final (release) code. Rebuild your project, reprogram 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 resour ces:

- Chapter 10. “Limitations”

- Section 2.9 “Resources Used by the Debugger”

- Section 7.2 “Specific Error Messages”

- Section 7.3 “General Corrective Actions”

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.

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.

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. Wait – give the debugger time to finish any application tasks. Then try to deselect

the debugger again.

2. Select Halt to stop any running applications. Then try to deselect the debugger

again.

3. Unplug the debugger from the PC. 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.

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER USER’S GUIDE

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 Communication 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 Communication 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 Communication 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 click Manual Download. Select the highest number .jam file and click Open.

ICD3Err0029: Communication failure. Unexpected command echo response %x received from ICD 3.

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

, Configuration tab, and

Error Messages

ICD3Err0030: Unable to read/fi nd firmware 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 Communication 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 Communication 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 settings and program the device before proceeding.

Y ou 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 S ection 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 V

2. Ensure that the target is powered.

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

Chapter 10. “Hard ware Specificat ion ”.)

DD and GND are connected between the debugger and target.

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 Communication 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 you click Cancel when asked to download the latest firmware? If so, you will need to download it now. Select Debugger>Settings 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.microchip.com.

ICD3Err0053: Unable to get ICD 3 protocol versions. See Section 7.3.3 “Debugger-to-PC Communication Error Actions”. ICD3Err0054: MPLAB IDE's ICD 3 protocol definitions are out of date. You must

upgrade MPLAB 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 Communication 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 again.

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 Communication 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 data sheet. Then erase and reprogram the entire device.

ICD3Err0082: Test interface LVP failure. ICD3Err0083: Test interface MCLR failure

, Configuration tab, and click Manual

), according to the device

7.3 GENERAL CORRECTIVE ACTIONS

These general corrective actions may solve your problem:

• Read/Write Error Actions

• Debugger-to-Target Communication Error Actions

• Debugger-to-PC Communication Error Actions

• Corrupted Installation Actions

• USB Port Communication Error Actions

• Debug Failure Actions

• Internal Error Actions

7.3.1 Read/Write Error Actions

If you receive 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.

Error Messages

7.3.2 Debugger-to-Target Communication Error Actions

The MPLAB ICD 3 in-circuit debugger and the target device are out-of-sync with each other.

1. Select Reset and then try the action again.

2. Ensure that the cable(s) used are 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 “ Corru pted 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. Y ou 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 Messages

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

DEBUGGER 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:

Chapter 8. Basic Debug Functions

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

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, Configuration Tab” for more info rmation. )

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER USER’S GUIDE

and click the Configuration tab.

Note: Using software breakpoints for debug impacts device endurance.

Therefore, it is recommended that devices used in this manner not be used as production parts.

8.3 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

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 “Start Condition”, select a breakpoint from the drop-down list. Also decide

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

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

5. Click OK.

to open the Breakpoints dialog and set up multiple

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

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

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

NOTES:

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

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER USER’S GUIDE

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

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.

, the toolbar Halt or <F5>.

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.

Note: Do not step into a SLEEP instruction.

Step Over F8

Execute the instruction at the current program counter location. At a CALL instruction, 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 program counter to the Reset vector.

Breakpoints

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

to reset the

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

breakpoint.

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 Programmer dialog (see Section 9.5 “Settings Dialog”). Set up program and firmware options.

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 Break points 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.

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

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

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.

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

9.3.2 Set Breakpoint Dialog

Section 9.3.6 “ANDed Breakpoints 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 breakpoi nt here.

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 mor e information on table reads/writes. Program Memory Execution address

TBLRD Program Memory – break on table read of above address TBLWT Program Memory

Pass Count Break on pass count condition.

Always break Break occurs Count instructions after Event

instructions before breaking after event specified in “Breakpoint type” Event must occur Count times “Breakpoint type” occurs Count (0-255) times

– always break as specified in “Breakpoint type”

– break on execution of above

– break on table write to above address

– wait Count (0 - 255)

– break only aft er even t spec ified i n

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

9.3.2.2 DATA MEMORY TAB

Set up a data memory breakpoint here.

TABLE 9-4: DATA MEMORY BREAKPOINT

Control Function

Address Location of breakpoint in hex Breakpoint Type The type of dat a memo ry breakp oint. See t he devic e data sheet fo r

9.4 PROGRAMMING FUNCTIONS

When you select the MPLAB ICD 3 in-circuit debugger from the Programmer menu, program items will be added to the following MPLAB IDE functions:

• Programmer Menu

• Toolbars/Status Bar

9.4.1 Programmer Menu

Program Program specified memory areas: program memory, Configuration bits, ID locations

and/or EEPROM data. See the Settings dialog for programming options.

Verify

Verify programming of specified memory areas: program memory, Configuration bits, ID locations and/or EEPROM data.

Read

Read specified memory areas: program memory, Configuration bits, ID locations and/or EEPROM data. See the Settings dialog for read options.

Blank Check All

Check to see that all device memory is erased/blank.

Debugger Function Summary

Erase Flash Device

Erase all Flash memory.

Settings

Open the Programmer dialog (see Section 9.5 “Settings Dialog”). Set up program and firmware options.

9.4.2 Toolbars/Status Bar

When the MPLAB ICD 3 in-circuit debugger is selected as a programmer, these toolbars are displayed in MPLAB IDE:

• Basic program toolbar (Blank Check All, Read, Program, Verify, Erase Flash

Device).

The selected programmer (MPLAB ICD 3), as well as other programming 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.5 SETTIN GS DIALOG

Select either Debugger>Settings or Programmer>Settings to open the Settings dialog and set up the MPLAB ICD 3 in-circuit debugger.

Note: Tabs displayed will depend on the selected device.

• Settings Dialog, Program Memory Tab

• Settings Dialog, Configuration Tab

• Settings Dialog, Freeze on Halt Tab

• Settings Dialog, Status Tab

• Settings Dialog, Clock Tab

• Settings Dialog, Secure Segment Tab

• Settings Dialog, Warnings Tab

• Settings Dialog, Power Tab

9.5.1 Settings Dialog, Program Memory Tab

This tab allows you to set up debug/programming options.

• Allow MPLAB ICD 3 to select memories and ranges – the debugger uses your

selected device and default settings to determine what to program.

• Manually select memories and ranges – you select the type and range of memory

to program.

TABLE 9-6: MANUAL SELECTION OPTIONS

Memories

Program Check to program Program Memory into target. Configuration Check to program Configuration bits into target.

Note: This memory is always programmed when debugger selected as a debugger.

EEPROM Check to erase and then program EEPROM memory on target, if

available. Uncheck to erase EEPROM memory on target.

ID Check to program ID Memory into target.

Program Options

Erase all before Program Check to erase all memory before programming begins.

Unless programming new or already erased devi ces, it is import ant to have this box checked. If not checked, the device is not erased and program code will be merged with the code already in the device.

Program Memory

Start , End Th e sta rting and endi ng hex addres s range in progra m memory for

programming, reading, or verification. If you receive a programming error due to an incorrect end address, you need to perfo rm a reconne ct, correct the end addres s and program again. Note: The address range does not apply to the Erase function. The Erase function will erase all data on the device.

• Set up automatic options – choose to “Program after successful build” and/or

“Run after successful program”.

Debugger Function Summary

9.5.2 Settings Dialog, Configuration Tab

Configure debugger operation on this tab.

TABLE 9-7: CONFIGURATION ITEMS

Download Firmware Set up firmware download options.

Auto Download Latest Firmware

Manual Download Manually select a firmware file to download to the target device. Breakpoints Depending on your selected device, you may be able to use soft-

Use Hardware Breakpoints

Use Software Breakpoints

Check to allow automatic download of the latest version of firmware for the target device (recommended).

ware breakpoint s. Review the text ben eath each type of breakpoint to determine which is best for your current needs.

This is the default/classic mode for breakpoint behavior. Using hardware breakpoints means:

• Number of breakpoints: limited

• Breakpoints are written to debug registers

• Time to set breakpoints : mini ma l

• Skidding: yes Using software breakpoints means:

• Number of breakpoints: unlimited

• Breakpoints are written to program memory

• Time to set breakpoints: oscillator speed dependent – can take minutes

• Skidding: no

Note: Using software breakpoints for debug impacts device endurance. Therefore, it is recomme nded tha t devic es used in th is manner not be used as pro duction parts.

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

9.5.3 Settings Dialog, Freeze on Halt Tab

Select peripherals to freeze on halt on this tab.

PIC18 MCU Devices

To freeze/unfreeze all device peripherals on halt, check/uncheck the “Freeze on Halt” checkbox. If this does not halt your desired peripheral, be aware that some peripherals have no freeze on halt capability and cannot be controlled by the debugger.

dsPIC30F/33F, PIC24F/H and PIC32MX Devices

For peripherals in the list “Peripherals to Freeze on Halt”, check to freeze that peripheral on a halt. Uncheck the peripheral to let it run while the program is halted. If you do not see a peripheral on the list, check “All Other Peripherals”. If this does not halt your desired peripheral, be aware that some peripherals have no freeze on halt capability and cannot be controlled by the debugger.

To select all peripherals, including “All Other Peripherals”, click Check All. T o deselect all peripherals, including “All Other Peripherals”, click Uncheck All.

9.5.4 Settings Dialog, Status Tab

View the status of your MPLAB ICD 3 system on this tab.

TABLE 9-8: STATUS ITEMS

Versions

Firmware Suite Version Debugger firmware suite version. The firmware suite consists of

the three items specified below. FPGA Version Internal FPGA chip firmware version. Algorithm Plug-in Version Debugger algorithm plug-in version. For your selected device, an

algorithm is used to support the device plugged into the target. OS Version Debugger operating system version.

Voltages

ICD 3 V ICD 3 VDD Debugger VDD. Target V Refresh Voltages Sensing of Status tab items occurs when the tab is achieved. To

PP Debugger VPP.

DD VDD sensed at target.

see updates otherwise, click this button.

Debugger Function Summary

9.5.5 Settings Dialog, Clock Tab

Enter the run-time clock (instruction) speed on this tab. This does not set the speed, but informs the debugger of its value.

TABLE 9-9: CLOCK OPTIONS

Target Run-Time Instruction Speed

Speed value Enter a value for the “Speed unit” selected.

Example 1: For a PIC24 MCU and a target clock oscillator at 32 MHz (HS), instruction speed = 32 MHz/2 = 16 MIPS. Example 2: For a PIC18F8722 MCU and a target clock oscillator at 10 MHz (HS) making use of the PLL (x4 = 40 MHz), instruction speed = 40 MHz/4 = 10 MIPS.

Speed unit Select either:

KIPS – Thousands (10 MIPS – Millions (10

Debug Mode Clock

Use FRC in Debug mode Select the checkbox if you want to use the fast internal oscillator

on the device. If selected any non-frozen peripherals will operate at the FRC during debugging (see Section 9.5.3 “Settings

Dialog, Freeze on Halt T ab ” ).

9.5.6 Settings Dialog, Secure Segment Tab

) of instructions per second

For CodeGuard™ Security devices, set up secure segment properties on this tab. For more details on CodeGuard Security functionality, please refer to the CodeGuard

Security reference manual for 16-bit devices (DS70180) and dsPIC33F/PIC24H and dsPIC30F device programming specifications found on our website.

TABLE 9-10: SECURE SEGMENT OPTIONS

Full Chip Programming Click to select to program all program memory segments. Segment Programming Click to select segment programming. Select from:

- Boot, secure and general segments

- Secure and general segments

- General segment only

9.5.7 Settings Dialog, W a rnings Tab

A list of all MPLAB ICD 3 in-circuit debugger warnings are displayed on this tab.

• Check a warning to enable it. The warning will be displayed in the Output window.

• Uncheck a warning to disable it. Warnings are not errors and will not stop your project from building. If you receive error

messages, please see Chapter 7. “Error Messages”.

9.5.8 Settings Dialog, Power Tab

Set up the power options on this tab. Click in the checkbox to enable/disable “Power target circuit from MPLAB ICD 3”. Adjust the slide bar to select the voltage. The value in the field changes according to

your adjustments.

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

NOTES:

Chapter 10. Hardware Specification

10.1 INTRODUCTION

The hardware and electrical specifications of the MPLAB ICD 3 in-circuit debugger system are detail e d.

10.2 HIGHLIGHTS

This chapter discusses:

• Declaration of Conformity

• USB Port/Power

• MPLAB ICD 3 Debugger

• Standard Communication Hardware

• ICD 3 Test Interface Board

• Target Board Considerations

10.3 DECLARATION OF CONFORMITY

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER USER’S GUIDE

We Microchip T echnology, Inc.

2355 W. Chandler Blvd. Chandler, Arizona 85224-6199 USA

hereby declare that the product: MPLAB complies with the following standards, provided that the restrictions stated in the

operating manual are observed: Standards: EN61010-1 Laboratory Equipment

Microchip T echnology, Inc. Date: August 2006

Important Information Concerning the Use of the MPLAB Due to the special nature of the MPLAB ICD 3 in-circuit debugger, the user is advised

that it can generate higher than normal levels of electromagnetic radiation which can interfere with the operation of all kinds of radio and other equipment.

T o comply with the European Approval Regulations therefore, the following restrictions must be observed:

1. The development system must be used only in an industrial (or comparable)

2. The system must not be operated within 20 meters of any equipment which may

ICD 3 In-Circuit Debugger

area.

be affected by such emissions (radio receivers, TVs etc.).

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

10.4 USB PORT/POWER

The MPLAB ICD 3 in-circuit debugger is connected to the host PC via a Universal Serial Bus (USB) port, version 2.0 compliant. The USB connector is located on the side of the pod.

The system is capable of reloading the firmware via the USB interface. System power is derived from the USB interface. The debugger is classified as a high

power system per the USB specification, and requires 300 mA of power from the USB to function in all operational modes (debugger/programmer).

Note: The MPLAB ICD 3 in-circuit debugger is powered through its USB connec-

tion. The target board is powered from its own supply. Alternatively, the MPLAB ICD 3 can power it only if the target consumes less than 100 mA.

Cable Length – The PC-to-debugger cable length for proper operation is shipped in the debugger kit.

Powered Hubs – If you are going to use a USB hub, make sure it is self-powered. Also, USB ports on PC keyboards do not have enough power for the debugger to operate.

PC Hibernate/Power-Down Modes – Disable the hibernate or other power saver modes on your PC to ensure proper USB communications with the debugger.

10.5 MPLAB ICD 3 DEBUGGER

The debugger consists of a main board enclosed in the casing with a USB connector and an RJ-11 connector. On the debugger enclosure are indicator lights (LEDs).

10.5.1 Main Board

This component has the interface processor (dsPIC DSC), the USB 2.0 interface capable of USB speeds of 480 Mb/sec, a Field Programmable Gate Array (FPGA) for general system control and increased communication throughput, an SRAM for holding the program code image for programming into the emulation device on-board Flash and LED indicators.

10.5.2 Indicator Lights (LEDs)

The indicator lights have the following significance.

LED Color Description

Active Blue Lit when power is first applied or when target is connected. Status Green Lit when the debugger is operating normally – standby.

Red Lit when an operation has failed. Orange Lit when the debugger is busy.

Hardware Specification

12345

Pin Name Function

PP Pow er

DD_TGT Power on target

3 GND Ground 4 PGD (ICSPDAT) Standard Com Data 5 PGC (ICSPCLK) Standard Com Clock 6 LVP Low Voltage Programming

Bottom of Target Board

Standard Socket

10.6 STANDARD COMMUNICATION HARDWARE

For standard debugger communication with a target (Section 2.4 “Debugger To Target Communication”, “Standard ICSP Device Communication“), use the RJ-11

connector. T o use this type of communication with a header board, you may need a device-specific

Processor Pak, which includes an 8-pin connector header board containing the desired ICE/ICD device and a standard adapter board.

Note: Older header boards used a 6-pin (RJ-11) connector instead of an 8-pin

connector, so these headers may be connected directly to the debugger.

For more on available header boards, see the “Header Board Specification” (DS51292).

10.6.1 Standard Communication

The standard communication is the main interface to the target processor. It contains the connections to the high voltage (V connections required for programming and connecting with the target devices.

PP high-voltage lines can produce a variable voltage that can swing from 0 to 14

The V volts to satisfy the voltage requirements for the specific emulation processor.

The V

DD sense connection draws very little current from the target processor. The

actual power comes from the MPLAB ICD 3 in-circuit debugger system as the V sense line is used as a reference only to track the target voltage. The V is isolated with an optical switch.

The clock and data connections are interfaces with the following characteristics:

• Clock and data signals are in high-impedance mode (even when no power is applied to the MPLAB ICD 3 in-circuit debugger system)

• Clock and data signals are protected from high voltages caused by faulty targets systems, or improper connections

• Clock and data signals are protected from high current caused from electrical shorts in faulty target systems

PP), VDD sense lines, and clock and data

DD connection

FIGURE 10-1: 6-PIN STANDARD PINOUT

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

Modular

Connector Pin

Microcontroller

6LVP 5 RB6 4RB7 3 Ground 2V

DD Target

1 VPP

Bottom view of Modular Connector

Pinout on Target Board

Front view of Modular Connector

on Target Board

Pin 1

8.00”

Pin 6

10.6.2 Modular Cable and Connector

For standard communications, a modular cable connects the debugger and the target application. The specifications for this cable and its connectors are listed below.

10.6.2.1 MODULAR CONNECTOR SPECIFICATION

• Manufacturer, Part Number – AMP Incorporated, 555165-1

• Distributor, Part Number – Digi-Key, A9031ND The following table shows how the modular connector pins on an application corre-

spond to the microcontroller pins. This configuration provides full ICD functionality .

FIGURE 10-2: MODULAR CONNECTOR PINOUT OF TARGET BOARD

10.6.2.2 MODULAR PLUG SPECIFICATION

• Manufacturer, Part Number – AMP Incorporated, 5-554710-3

• Distributor, Part Number – Digi-Key, A9117ND

10.6.2.3 MODULAR CABLE SPECIFICATION

• Manufacturer, Part Number – Microchip Technology, 07-00024

10.7 ICD 3 TEST INTERFACE BOARD

This board can be used to verify that the debugger is functioning properly. To use this board:

Hardware Specification

ICD 3 Test Interface Board

USB/Power

From PC

Modular Cable

MPLAB® ICD 3

1. Disconnect the debugger from the target and the PC.

2. Connect the ICD 3 test interface board to the debugger using the modular cable.

3. Connect the debugger to the PC.

4. Select the MPLAB ICD 3 in-circuit debugger as either a debugger or programmer

in MPLAB IDE.

5. MPLAB IDE will invoke and run the complete self-test and give you a status

(pass/fail).

10.8 TA RGET BOARD CONSIDERATIONS

The target board should be powered according to the requirements of the selected device (2.0V-5.5V) and the application.

The debugger does sense target power. There is a 10KΩ load on V Depending on the type of debugger-to-target communications used, there will be some

considerations for target board circuitry:

• Section 2.5.2 “Target Connection Circuitry”

• Section 2.5.5 “Circuits That Will Prevent the Debugger From Functioning”

DD_TGT.

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

NOTES:

MPLAB® ICD 3 IN-CIRCUIT

DEBUGGER USER’S GUIDE

Glossary

Absolute Section

A section with a fixed (absolute) address that cannot be changed by the linker.

Access Memory (PIC18 Only)

Special registers on PIC18 devices that allow access regardless of the setting of the Bank Select Register (BSR ).

Address

Value that identifies a location in memory.

Alphabetic Character

Alphabetic characters are those characters that are letters of the arabic alphabet (a, b, …, z, A, B, …, Z).

Alphanumeric

Alphanumeric characters are comprised of alphabetic characters and decimal digits (0,1, …, 9).

ANSI

American National Standards Institute is an organization responsible for formulating and approving standards in the United States.

Application

A set of software and hardware that may be controlled by a PIC microcontroller.

Microchip Technology MPLAB® ICD 3 User’s Guide

Specifications and Main Features

Frequently Asked Questions

User Manual

Preface

Part 1 – Getting Started

Chapter 1. Overview

1.1 INTRODUCTION

1.2 MPLAB ICD 3 IN-CIRCUIT DEBUGGER DEFINED

1.3 HOW THE MPLAB ICD 3 IN-CIRCUIT DEBUGGER HELPS YOU

1.4 MPLAB ICD 3 IN-CIRCUIT DEBUGGER KIT COMPONENTS

1.5 DEVICE AND FEATURE SUPPORT

Chapter 2. Theory of Operation

2.1 INTRODUCTION

2.2 MPLAB ICD 3 IN-CIRCUIT DEBUGGER VS. MPLAB ICE 2000/4000 IN-CIRCUIT EMULATORS

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

2.4 DEBUGGER TO TARGET COMMUNICATION

2.5 COMMUNICATION CONNECTIONS

2.6 DEBUGGING WITH THE DEBUGGER

2.7 REQUIREMENTS FOR DEBUGGING

2.8 PROGRAMMING WITH THE DEBUGGER

2.9 RESOURCES USED BY THE DEBUGGER

Chapter 3. Installation

3.1 INTRODUCTION

3.2 INSTALLING THE SOFTWARE

3.3 INSTALLING THE USB DEVICE DRIVERS

3.4 CONNECTING THE TARGET

3.5 SETTING UP THE TARGET BOARD

3.6 SETTING UP MPLAB IDE

Chapter 4. General Setup

4.1 INTRODUCTION

4.2 STARTING THE MPLAB IDE SOFTWARE

4.3 CREATING A PROJECT

4.4 VIEWING THE PROJ ECT

4.5 BUILDING THE PROJECT

4.6 SETTING CONFIGURATION BITS

4.7 SETTING THE DEBUGGER AS THE DEBUGGER OR PROGRAMMER

4.8 DEBUGGER/PROGRAMMER LIMITATIONS

5.1 INTRODUCTION

Chapter 5. Tutorial

5.2 SETTING UP THE ENVIRONMENT AND SELECTING THE DEVICE

5.3 CREATING THE APPLICATION CODE

5.4 RUNNING THE PROJECT WIZARD

5.5 VIEWING THE PROJ ECT

5.6 VIEWING DEBUG OPTIONS

5.7 CREATING A HEX FILE

5.8 SETTING UP THE DEMO BOARD

5.9 LOADING PROGRAM CODE FOR DEBUGGING

5.10 RUNNING DEBUG CODE

5.11 DEBUGGING CODE USING BREAKPOINTS

5.12 PROGRAMMING THE APPLICATION

Part 2 – Troubleshooting

Chapter 6. Frequently Asked Questions (FAQs)

6.1 INTRODUCTION

6.2 HOW DOES IT WORK

6.3 WHAT’S WRONG

Chapter 7. Error Messages

7.1 INTRODUCTION

7.2 SPECIFIC ERROR MESSAGES

7.3 GENERAL CORRECTIVE ACTIONS

Part 3 – Reference

Chapter 8. Basic Debug Functions

8.1 INTRODUCTION

8.2 BREAKPOINTS

8.3 STOPWATCH

Chapter 9. Debugger Function Summary

9.1 INTRODUCTION

9.2 DEBUGGING FUNCTIONS

9.3 DEBUGGING DIALOGS/WINDOWS

9.4 PROGRAMMING FUNCTIONS

9.5 SETTIN GS DIALOG

Chapter 10. Hardware Specification

10.1 INTRODUCTION

10.2 HIGHLIGHTS

10.3 DECLARATION OF CONFORMITY

10.4 USB PORT/POWER

10.5 MPLAB ICD 3 DEBUGGER

10.6 STANDARD COMMUNICATION HARDWARE

10.7 ICD 3 TEST INTERFACE BOARD

10.8 TA RGET BOARD CONSIDERATIONS