IPE UserGuide
IPE UserGuide
IPE UserGuide
• 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.
QUALITY MANAGEMENT SYSTEM Microchip received ISO/TS-16949:2009 certification for its worldwide
CERTIFIED BY DNV 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
== ISO/TS 16949 == are for its PIC® MCUs and dsPIC® DSCs, KEELOQ® code hopping
devices, Serial EEPROMs, microperipherals, nonvolatile memory and
analog products. In addition, Microchip’s quality system for the design
and manufacture of development systems is ISO 9001:2000 certified.
NOTICE TO CUSTOMERS
All documentation becomes dated, and this manual is no exception. Microchip tools and
documentation are constantly evolving to meet customer needs, so some actual dialogs
and/or tool descriptions may differ from those in this document. Please refer to our web site
(www.microchip.com) to obtain the latest documentation available.
Documents are identified with a “DS” number. This number is located on the bottom of each
page, in front of the page number. The numbering convention for the DS number is
“DSXXXXXXXXA”, where “XXXXXXXX” 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® X IDE online help.
Select the Help menu, and then Topics to open a list of available online help files.
INTRODUCTION
This chapter contains general information that will be useful to know before using the
MPLAB® Integrated Production Environment (IPE). Items discussed in this chapter
include:
• Document Layout
• Conventions Used in this Guide
• Recommended Reading
DOCUMENT LAYOUT
This document describes how to use the IPE as a programming tool to program
devices. The document is organized as follows:
• Chapter 1. IPE Application Overview – Defines the IPE, provides software
installation requirements and upgrade procedures, lists the supported tools, and
provides a feature matrix.
• Chapter 2. General Setup – Discusses launching and setting up the application,
and provides Advanced Mode login and options information.
• Chapter 3. IPE Reference – Provides reference information for the menu items.
DOCUMENTATION CONVENTIONS
Description Represents Examples
Arial font:
Italic characters Referenced books MPLAB X IDE User’s Guide
Emphasized text ...is the only compiler...
Initial caps A window the Output window
A dialog the Settings dialog
A menu selection select Enable Programmer
Quotes A field name in a window or “Save project before build”
dialog
Underlined, italic text with A menu path File>Save
right angle bracket
Bold characters A dialog button Click OK
A tab Click the Power tab
N‘Rnnnn A number in verilog format, 4‘b0010, 2‘hF1
where N is the total number of
digits, R is the radix and n is a
digit.
Text in angle brackets < > A key on the keyboard Press <Enter>, <F1>
Courier New font:
Plain Courier New Sample source code #define START
Filenames autoexec.bat
File paths c:\mcc18\h
Keywords _asm, _endasm, static
Command-line options -Opa+, -Opa-
Bit values 0, 1
Constants 0xFF, ‘A’
Italic Courier New A variable argument file.o, where file can be
any valid filename
Square brackets [ ] Optional arguments mcc18 [options] file
[options]
Curly brackets and pipe Choice of mutually exclusive errorlevel {0|1}
character: { | } arguments; an OR selection
Ellipses... Replaces repeated text var_name [,
var_name...]
Represents code supplied by void main (void)
user { ...
}
RECOMMENDED READING
This user's guide describes how to use IPE. Other useful documents are listed below.
The following Microchip documents are available and recommended as supplemental
reference resources.
See the IPE Release Notes for up-to-date version compatibility information.
Once you’ve installed the software, the IPE application can be accessed through the
MPLAB IPE icon on your desktop or startup menu.
Note: The IPE must be run as ADMINISTRATOR for all features to be fully
functional.
Note: The IPE must be run as ADMINISTRATOR for all features to be fully
functional.
For programming devices, you can use any of the supported tools (see
Section 1.3 “Programming Tools Supported”). Refer to the online help of the
selected tool (e.g., MPLAB ICD 3, PICkit 3, etc.) for information on programming a
device.
1. Using the Family drop-down menu, select the family of the device you wish to
program and use the Device drop-down menu to select the device. Or, use the
Device drop-down menu to directly select the device.
Note: Selecting the Recently Used option from the Family menu lists the latest 10
devices used in the Device menu.
2. Click Apply to configure the IPE to the current device (e.g., Memory View,
checksum).
3. Connect the development tool to the PC. Attach the appropriate target board,
device, and power. Refer to the tool’s online help for additional instructions and
information on connecting to target boards, etc.
4. Use the Tool drop-down menu to select the tool you want to use. If more than one
development tool is connected to the PC, select the one you wish to use (see the
figure below).
Note: An exclamation point before the tool name (as shown below) indicates that
the USB drivers need to be updated. This will not occur with the PICkit 3.
However, the USB drivers may need to be updated for the MPLAB ICD 3,
MPLAB PM3, and REAL ICE.
5. Click on the Connect button (next to the Tool name) to establish a connection
between the IPE and the tool.
6. When the tool is connected, any messages or errors related to this tool will be
displayed in the Output window, see Figure 2-4.
Typically, someone has been authorized to establish the settings that production will
use for the device and tool. To input those settings, log in to the Advanced mode.
1. Select Settings>Advanced Mode to open the Advanced Mode login dialog. The
password is case sensitive. Type in the default password microchip and click
Log on.
To change the password after the initial log on, click on Change Password.
If you forget the new password, you must uninstall the IPE, delete the ipe.key file
(located in the IPE install directory) to remove any settings made previously in IPE, then
reinstall the IPE to begin with the default password microchip.
2.5.1 Operate
After validating the password to log in to the Advanced Mode, the dialog opens in the
Operate view. This display is similar to the main display, with the addition of option
buttons located along the left side of the window.
2.5.2 Power
The Power option is only available when a tool is connected. From the Advanced Mode
dialog, click on Power to display the available settings.
2.5.3 Memory
From the Advanced Mode dialog, click on Memory to display the available settings.
You can control the memory address and other parameters related to a programming
operation. Some of the options in this window are also available on the main screen,
for viewing and to provide easy access to these settings.
2.5.4 Environment
Environments allow you to save settings, so that all of the same settings can be
reloaded in another programming session. Environments are supported, under all
tools, as either .pen files or .pm3 files.
Note: MPLAB PM3 programmer does not support the preserve memory options
in the environment .pm3 files.
From the Advanced Mode dialog, click on Environment to display the available
settings.
2.5.5 SQTP
SQTP (serial quick turn programming) is used to program a unique serial number into
each device. This number can be used as an entry code, password or ID number.
From the Advanced Mode dialog, click on SQTP to display the available settings.
2.5.7 Settings
From the Advanced Mode dialog, click on Settings to display the available options
(Figure 2-8).
5. Click OK.
6. Right click on the new shortcut icon and click Rename. Type a new name for the
shortcut.
7. Double click the new shortcut icon to launch IPE. The specified target
(environment, device, etc.) automatically loads when the IPE opens.
The following figure shows the main window of the IPE. The IPE Menu bar contains the
following menus, with commands:
• File Menu
• View Menu
• Settings Menu
• Help Menu
Commands are available or not depending on the settings selected in Advanced Mode.
3.2.1 File>Import
The Import menu item allows you to import files into the IPE:
1. File->Import->Hex – select to import the hexadecimal file (*.hex).
Note: If using a Hex file in the IPE and the file is modified using Notepad, MPLAB
X IDE, etc., outside the IPE, the following message displays:
3.2.2 File>Export
The Export menu item allows you to export data from IPE to storage media. By default,
these commands are not available in Production Mode. However, in Advanced Mode,
an authorized user can change the default states of this feature for the Production
Mode.
File->Export->Hex – this command allows you to export all the memory contents into
Intel® Hex file format.
3.2.3 File>Exit
This command closes the IPE application.
The viewable memory types are determined by the Production settings that are selected in the Advanced
Mode.
If enabled, the configuration settings can be edited. Select Config Memory from the drop-down list in
Memory View. Use the scroll bar to view the Setting column. Click the setting you want to edit and a list
displays that shows the options that are available for that setting. Click on your selection.
This is shown in the following figure.
Fill Memory – you can also access this dialog by right-clicking on any value in the
Memory View window and select Fill Memory.
Print – to print the memory window, right-click on any value in the Memory View
window and select Print.
Note: this command will print the entire contents of the memory. So, if you have a large
device, such as a PIC32, the printout will probably be quite large. You might consider
printing to a file, rather than to a printer, in some cases.
WARRANTY REGISTRATION
If your development tool package includes a Warranty Registration Card, please
complete the card and mail it in promptly. Sending in your Warranty Registration Card
entitles you to receive new product updates. Interim software releases are available at
the Microchip web site.
CUSTOMER SUPPORT
Users of Microchip products can receive assistance through several channels:
• Distributor or Representative
• Local Sales Office
• Field Application Engineer (FAE)
• Technical Support
Customers should contact their distributor, representative or field application engineer
(FAE) for support. Local sales offices are also available to help customers. A listing of
sales offices and locations is included in the back of this document. See our web site
for a complete, up-to-date listing of sales offices.
Technical support is available through the web site at http://support.microchip.com.
Documentation errors or comments may be emailed to docerrors@microchip.com.
E I
Edit Memory Settings ............................................... 11 Import ....................................................................... 33
Edit Voltage Settings................................................ 11 Import Environment.................................................. 10
EEPROM ................................................................. 11 Import Hex File......................................................... 10
Enable programming operations only if hex file is load- Import SQTP File ..................................................... 10
ed ......................................................................... 24 Internet Address, Microchip ..................................... 43
Environment ............................................................. 21 IPE Feature Matrix ................................................... 10
Erase........................................................................ 10