Microchip PIC18F57Q43 User Manual

PIC18F57Q43 Curiosity Nano
PIC18F57Q43 Curiosity Nano Hardware User Guide

Preface

The PIC18F57Q43 Curiosity Nano Evaluation Kit is a hardware platform to evaluate microcontrollers in the PIC18­Q43 family. This board has the PIC18F57Q43 microcontroller (MCU) mounted.
Supported by Microchip MPLAB® X Integrated Development Environment (IDE), the board provides easy access to the features of the PIC18F57Q43 to explore how to integrate the device into a custom design.
The Curiosity Nano series of evaluation boards include an on-board debugger. No external tools are necessary to program and debug the PIC18F57Q43.
MPLAB® X IDE - Software to discover, configure, develop, program, and debug Microchip microcontrollers.
Code examples on GitHub - Get started with code examples.
PIC18F57Q43 website - Find documentation, data sheets, sample, and purchase microcontrollers.
PIC18F57Q43 Curiosity Nano website - Find schematics, design files, and purchase this kit.
© 2020 Microchip Technology Inc.
DS40002186A-page 1
PIC18F57Q43 Curiosity Nano

Table of Contents

Preface........................................................................................................................................................... 1
1. Introduction............................................................................................................................................. 3
1.1. Features....................................................................................................................................... 3
1.2. Kit Overview................................................................................................................................. 3
2. Getting Started........................................................................................................................................ 4
2.1. Quick Start....................................................................................................................................4
2.2. Design Documentation and Relevant Links................................................................................. 4
3. Curiosity Nano.........................................................................................................................................5
3.1. On-Board Debugger Overview..................................................................................................... 5
3.2. Curiosity Nano Standard Pinout................................................................................................. 10
3.3. Power Supply............................................................................................................................. 11
3.4. Low Power Measurement...........................................................................................................15
3.5. Programming External Microcontrollers..................................................................................... 16
3.6. Connecting External Debuggers................................................................................................ 19
4. Hardware User Guide........................................................................................................................... 21
4.1. Connectors.................................................................................................................................21
4.2. Peripherals................................................................................................................................. 22
5. Hardware Revision History and Known Issues..................................................................................... 24
5.1. Identifying Product ID and Revision........................................................................................... 24
5.2. Revision 3...................................................................................................................................24
6. Document Revision History...................................................................................................................25
7. Appendix............................................................................................................................................... 26
7.1. Schematic...................................................................................................................................26
7.2. Assembly Drawing......................................................................................................................28
7.3. Curiosity Nano Base for Click boards™...................................................................................... 29
7.4. Disconnecting the On-board Debugger......................................................................................30
The Microchip Website.................................................................................................................................32
Product Change Notification Service............................................................................................................32
Customer Support........................................................................................................................................ 32
Microchip Devices Code Protection Feature................................................................................................ 32
Legal Notice................................................................................................................................................. 32
Trademarks.................................................................................................................................................. 33
Quality Management System....................................................................................................................... 33
Worldwide Sales and Service.......................................................................................................................34
© 2020 Microchip Technology Inc.
DS40002186A-page 2

1. Introduction

Micro USB
Connector
Debugger
Power/Status
LED
32.768 kHz
Crystal footprint
User LED
(LED0)
User Switch
(SW0)
PIC18F57Q43
MCU

1.1 Features

• PIC18F57Q43-I/PT Microcontroller
• One Yellow User LED
• One Mechanical User Switch
• Footprint for 32.768 kHz Crystal
• On-Board Debugger: – Board identification in Microchip MPLAB® X IDE – One green power and status LED – Programming and debugging – Virtual serial port (CDC) – One debug GPIO channel (DGI GPIO)
• USB Powered
• Adjustable Target Voltage: – MIC5353 LDO regulator controlled by the on-board debugger – 1.8-5.1V output voltage (limited by USB input voltage) – 500 mA maximum output current (limited by ambient temperature and output voltage)
PIC18F57Q43 Curiosity Nano
Introduction

1.2 Kit Overview

The Microchip PIC18F57Q43 Curiosity Nano Evaluation Kit is a hardware platform to evaluate the PIC18F57Q43 microcontroller.
Figure 1-1. PIC18F57Q43 Curiosity Nano Evaluation Kit Overview
© 2020 Microchip Technology Inc.
DS40002186A-page 3

2. Getting Started

2.1 Quick Start

Steps to start exploring the PIC18F57Q43 Curiosity Nano Board:
1. Download Microchip MPLAB® X IDE.
2. Launch Microchip MPLAB® X IDE.
3. Optional: Use MPLAB® Code Configurator to generate drivers and examples.
4. Write your application code.
5. Connect a USB cable (Standard-A to Micro-B or Micro-AB) between the PC and the debug USB port on the board.
Driver Installation
When the board is connected to your computer for the first time, the operating system will perform a driver software installation. The driver file supports both 32- and 64-bit versions of Microsoft® Windows® XP, Windows Vista®, Windows 7, Windows 8, and Windows 10. The drivers for the board are included with Microchip MPLAB® X IDE.
Kit Window
Once the board is powered, the green status LED will be lit, and Microchip MPLAB® X IDE will auto-detect which boards are connected. Microchip MPLAB® X IDE will present relevant information like data sheets and board documentation. The PIC18F57Q43 device on the PIC18F57Q43 Curiosity Nano Board is programmed and debugged by the on-board debugger and, therefore, no external programmer or debugger tool is required.
PIC18F57Q43 Curiosity Nano
Getting Started
Tip:  The Kit Window can be opened in MPLAB X IDE through the menu bar Window > Kit Window.

2.2 Design Documentation and Relevant Links

The following list contains links to the most relevant documents and software for the PIC18F57Q43 Curiosity Nano Board:
MPLAB® X IDE - MPLAB X IDE is a software program that runs on a PC (Windows®, Mac OS®, Linux®) to
develop applications for Microchip microcontrollers and digital signal controllers. It is called an Integrated Development Environment (IDE) because it provides a single integrated “environment” to develop code for embedded microcontrollers.
MPLAB® Code Configurator - MPLAB Code Configurator (MCC) is a free software plug-in that provides a
graphical interface to configure peripherals and functions specific to your application.
Microchip Sample Store - Microchip sample store where you can order samples of devices.
MPLAB Data Visualizer - MPLAB Data Visualizer is a program used for processing and visualizing data. The
Data Visualizer can receive data from various sources such as serial ports and on-board debugger’s Data Gateway Interface, as found on Curiosity Nano and Xplained Pro boards.
Microchip PIC® and AVR Examples - Microchip PIC and AVR Device Examples is a collection of examples
and labs that use Microchip development boards to showcase the use of PIC and AVR device peripherals.
Microchip PIC® and AVR Solutions - Microchip PIC and AVR Device Solutions contains complete applications
for use with Microchip development boards, ready to be adapted and extended.
PIC18F57Q43 Curiosity Nano website - Find schematics, design files, and purchase this kit.
PIC18F57Q43 Curiosity Nano on microchipDIRECT - Purchase this kit on microchipDIRECT.
© 2020 Microchip Technology Inc.
DS40002186A-page 4

3. Curiosity Nano

Curiosity Nano is an evaluation platform of small boards with access to most of the microcontrollers I/Os. The platform consists of a series of low pin count microcontroller (MCU) boards with on-board debuggers, which are integrated with Microchip MPLAB® X IDE. Each board is identified in the IDE. When plugged in, a Kit Window is displayed with links to key documentation, including relevant user guides, application notes, data sheets, and example code. Everything is easy to find. The on-board debugger features a virtual serial port (CDC) for serial communication to a host PC and a Data Gateway Interface (DGI) with debug GPIO pin(s).

3.1 On-Board Debugger Overview

PIC18F57Q43 Curiosity Nano contains an on-board debugger for programming and debugging. The on-board debugger is a composite USB device consisting of several interfaces:
• A debugger that can program and debug the PIC18F57Q43 in Microchip MPLAB® X IDE
• A mass storage device that allows drag-and-drop programming of the PIC18F57Q43
• A virtual serial port (CDC) that is connected to a Universal Asynchronous Receiver/Transmitter (UART) on the
PIC18F57Q43, and provides an easy way to communicate with the target application through terminal software
• A Data Gateway Interface (DGI) for code instrumentation with logic analyzer channels (debug GPIO) to visualize
program flow
The on-board debugger controls a Power and Status LED (marked PS) on the PIC18F57Q43 Curiosity Nano Board. The table below shows how the LED is controlled in different operation modes.
Table 3-1. On-Board Debugger LED Control
PIC18F57Q43 Curiosity Nano
Curiosity Nano
Operation Mode Power and Status LED
Boot Loader mode The LED blinks slowly during power-up.
Power-up The LED is ON.
Normal operation The LED is ON.
Programming Activity indicator: The LED blinks slowly during programming/debugging.
Drag-and-drop programming
Fault The LED blinks rapidly if a power fault is detected.
Sleep/Off The LED is OFF. The on-board debugger is either in a sleep mode or powered down.

3.1.1 Debugger

The on-board debugger on the PIC18F57Q43 Curiosity Nano Board appears as a Human Interface Device (HID) on the host computer’s USB subsystem. The debugger supports full-featured programming and debugging of the PIC18F57Q43 using Microchip MPLAB® X IDE.
Success: The LED blinks slowly for 2 sec.
Failure: The LED blinks rapidly for 2 sec.
This can occur if the board is externally powered.
Info:  Slow blinking is approximately 1 Hz, and rapid blinking is approximately 5 Hz.
© 2020 Microchip Technology Inc.
DS40002186A-page 5
Remember:  Keep the debugger’s firmware up-to-date. Firmware upgrades are done automatically when
Target MCU
UART TX
UART RX
Debugger
USB
CDC RX
CDC TX
PC
Terminal
Software
Target
Receive
Target
Send
Terminal Receive
Terminal
Send
using Microchip MPLAB® X IDE.

3.1.2 Virtual Serial Port (CDC)

The virtual serial port (CDC) is a general purpose serial bridge between a host PC and a target device.
3.1.2.1 Overview
The on-board debugger implements a composite USB device that includes a standard Communications Device Class (CDC) interface, which appears on the host as a virtual serial port. The CDC can be used to stream arbitrary data in both directions between the host computer and the target: All characters sent through the virtual serial port on the host computer will be transmitted as UART on the debugger’s CDC TX pin, and UART characters captured on the debugger’s CDC RX pin will be returned to the host computer through the virtual serial port.
Figure 3-1. CDC Connection
PIC18F57Q43 Curiosity Nano
Curiosity Nano
Info:  As shown in Figure 3-1, the debugger’s CDC TX pin is connected to a UART RX pin on the target
for receiving characters from the host computer. Similarly, the debugger’s CDC RX pin is connected to a UART TX pin on the target for transmitting characters to the host computer.
3.1.2.2 Operating System Support
On Windows machines, the CDC will enumerate as Curiosity Virtual COM Port and appear in the Ports section of the Windows Device Manager. The COM port number can also be found there.
Info:  On older Windows systems, a USB driver is required for CDC. This driver is included in installations of Microchip MPLAB® X IDE.
On Linux machines, the CDC will enumerate and appear as /dev/ttyACM#.
Info:  tty* devices belong to the “dialout” group in Linux, so it may be necessary to become a member of that group to have permissions to access the CDC.
On MAC machines, the CDC will enumerate and appear as /dev/tty.usbmodem#. Depending on which terminal program is used, it will appear in the available list of modems as usbmodem#.
© 2020 Microchip Technology Inc.
DS40002186A-page 6
3.1.2.3 Limitations
Not all UART features are implemented in the on-board debugger CDC. The constraints are outlined here:
Baud rate: Must be in the range of 1200 bps to 500 kbps. Any baud rate outside this range will be set to the
closest limit, without warning. Baud rate can be changed on-the-fly.
Character format: Only 8-bit characters are supported.
Parity: Can be odd, even, or none.
Hardware flow control: Not supported.
Stop bits: One or two bits are supported.
3.1.2.4 Signaling
During USB enumeration, the host OS will start both communication and data pipes of the CDC interface. At this point, it is possible to set and read back the baud rate and other UART parameters of the CDC, but data sending and receiving will not be enabled.
When a terminal connects on the host, it must assert the DTR signal. As this is a virtual control signal implemented on the USB interface, it is not physically present on the board. Asserting the DTR signal from the host will indicate to the on-board debugger that a CDC session is active. The debugger will then enable its level shifters (if available), and start the CDC data send and receive mechanisms.
Deasserting the DTR signal will not disable the level shifters but disable the receiver so no further data will be streamed to the host. Data packets that are already queued up for sending to the target will continue to be sent out, but no further data will be accepted.
PIC18F57Q43 Curiosity Nano
Curiosity Nano
Info:  For all operating systems: Be sure to use a terminal emulator that supports DTR signaling. See
3.1.2.4 Signaling.
Remember:  Set up the terminal emulator to assert the DTR signal. Without the signal, the on-board debugger will not send or receive any data through its UART.
Tip:  The on-board debugger’s CDC TX pin will not be driven until the CDC interface is enabled by the host computer. Also, there are no external pull-up resistors on the CDC lines connecting the debugger and the target, which means that during power-up, these lines are floating. To avoid any glitches resulting in unpredictable behavior like framing errors, the target device should enable the internal pull-up resistor on the pin connected to the debugger’s CDC TX pin.
3.1.2.5 Advanced Use
CDC Override Mode
In normal operation, the on-board debugger is a true UART bridge between the host and the device. However, in certain use cases, the on-board debugger can override the basic operating mode and use the CDC TX and RX pins for other purposes.
Dropping a text file into the on-board debugger’s mass storage drive can be used to send characters out of the debugger’s CDC TX pin. The filename and extension are trivial, but the text file must start with the characters:
CMD:SEND_UART=
The maximum message length is 50 characters – all remaining data in the frame are ignored.
The default baud rate used in this mode is 9600 bps, but if the CDC is already active or has been configured, the previously used baud rate still applies.
© 2020 Microchip Technology Inc.
DS40002186A-page 7
USB-Level Framing Considerations
Sending data from the host to the CDC can be done byte-wise or in blocks, which will be chunked into 64-byte USB frames. Each such frame will be queued up for sending to the debugger’s CDC TX pin. Transferring a small amount of data per frame can be inefficient, particularly at low baud rates, because the on-board debugger buffers frames and not bytes. A maximum of four 64-byte frames can be active at any time. The on-board debugger will throttle the incoming frames accordingly. Sending full 64-byte frames containing data is the most efficient method.
When receiving data on the debugger’s CDC RX pin, the on-board debugger will queue up the incoming bytes into 64-byte frames, which are sent to the USB queue for transmission to the host when they are full. Incomplete frames are also pushed to the USB queue at approximately 100 ms intervals, triggered by USB start-of-frame tokens. Up to eight 64-byte frames can be active at any time.
If the host (or the software running on it) fails to receive data fast enough, an overrun will occur. When this happens, the last-filled buffer frame will be recycled instead of being sent to the USB queue, and a full frame of data will be lost. To prevent this occurrence, the user must ensure that the CDC data pipe is being read continuously, or the incoming data rate must be reduced.

3.1.3 Mass Storage Device

The on-board debugger includes a simple Mass Storage Device implementation, which is accessible for read/write operations via the host operating system to which it is connected.
It provides:
• Read access to basic text and HTML files for detailed kit information and support
• Write access for programming Intel® HEX formatted files into the target device’s memory
• Write access for simple text files for utility purposes
PIC18F57Q43 Curiosity Nano
Curiosity Nano
3.1.3.1 Mass Storage Device Implementation
The on-board debugger implements a highly optimized variant of the FAT12 file system that has several limitations, partly due to the nature of FAT12 itself and optimizations made to fulfill its purpose for its embedded application.
The Curiosity Nano USB Device is USB Chapter 9-compliant as a mass storage device but does not, in any way, fulfill the expectations of a general purpose mass storage device. This behavior is intentional.
When using the Windows operating system, the on-board debugger enumerates as a Curiosity Nano USB Device that can be found in the disk drives section of the device manager. The CURIOSITY drive appears in the file manager and claims the next available drive letter in the system.
The CURIOSITY drive contains approximately one MB of free space. This does not reflect the size of the target device’s Flash in any way. When programming an Intel® HEX file, the binary data are encoded in ASCII with metadata providing a large overhead, so one MB is a trivially chosen value for disk size.
It is not possible to format the CURIOSITY drive. When programming a file to the target, the filename may appear in the disk directory listing. This is merely the operating system’s view of the directory, which, in reality, has not been updated. It is not possible to read out the file contents. Removing and replugging the board will return the file system to its original state, but the target will still contain the application that has been previously programmed.
To erase the target device, copy a text file starting with “CMD:ERASE” onto the disk.
By default, the CURIOSITY drive contains several read-only files for generating icons as well as reporting status and linking to further information:
AUTORUN.ICO – icon file for the Microchip logo
AUTORUN.INF – system file required for Windows Explorer to show the icon file
KIT-INFO.HTM – redirect to the development board website
KIT-INFO.TXT – a text file containing details about the board’s debugger firmware version, board name, USB
serial number, device, and drag-and-drop support
STATUS.TXT – a text file containing the programming status of the board
© 2020 Microchip Technology Inc.
DS40002186A-page 8
Info:  STATUS.TXT is dynamically updated by the on-board debugger. The contents may be cached by the OS and, therefore, do not reflect the correct status.
3.1.3.2 Configuration Words
Configuration Words (PIC® MCU Targets)
Configuration Word settings included in the project being programmed after program Flash is programmed. The debugger will not mask out any bits in the Configuration Words when writing them, but since it uses Low-Voltage Programming mode, it is unable to clear the LVP Configuration bit. If the incorrect clock source is selected, for example, and the board does not boot, it is always possible to perform a bulk erase (always done before programming) and restore the device to its default settings.
3.1.3.3 Special Commands
Several utility commands are supported by copying text files to the mass storage disk. The filename or extension is irrelevant – the command handler reacts to content only.
Table 3-2. Special File Commands
Command Content Description
CMD:ERASE
CMD:SEND_UART=
CMD:RESET
CMD:POWERTOGGLE
CMD:0V
CMD:3V3
CMD:5V0
PIC18F57Q43 Curiosity Nano
Curiosity Nano
Executes a chip erase of the target
Sends a string of characters to the CDC UART. See “CDC Override Mode”.
Resets the target device by entering Programming mode and then exiting Programming mode immediately thereafter. Exact timing can vary according to the programming interface of the target device. (Debugger firmware v1.16 or newer.)
Powers down the target and restores power after a 100 ms delay. If external power is provided, this has no effect. (Debugger firmware v1.16 or newer.)
Powers down the target device by disabling the target supply regulator. If external power is provided, this has no effect. (Debugger firmware v1.16 or newer.)
Sets the target voltage to 3.3V. If external power is provided, this has no effect. (Debugger firmware v1.16 or newer.)
Sets the target voltage to 5.0V. If external power is provided, this has no effect. (Debugger firmware v1.16 or newer.)
Info:  The commands listed here are triggered by the content being sent to the mass storage emulated disk, and no feedback is provided in the case of either success or failure.

3.1.4 Data Gateway Interface (DGI)

Data Gateway Interface (DGI) is a USB interface for transporting raw and time-stamped data between on-board debuggers and host computer-based visualization tools. MPLAB Data Visualizer is used on the host computer to display debug GPIO data. It is available as a plug-in for MPLAB® X IDE or a stand-alone application that can be used in parallel with Microchip MPLAB® X IDE.
Although DGI encompasses several physical data interfaces, the PIC18F57Q43 Curiosity Nano implementation includes logic analyzer channels:
• One debug GPIO channel (also known as DGI GPIO)
© 2020 Microchip Technology Inc.
DS40002186A-page 9
3.1.4.1 Debug GPIO
Debug GPIO channels are timestamped digital signal lines connecting the target application to a host computer visualization application. They are typically used to plot the occurrence of low-frequency events on a time-axis – for example, when certain application state transitions occur.
The figure below shows the monitoring of the digital state of a mechanical switch connected to a debug GPIO in MPLAB Data Visualizer.
Figure 3-2. Monitoring Debug GPIO with MPLAB® Data Visualizer
PIC18F57Q43 Curiosity Nano
Curiosity Nano
Debug GPIO channels are timestamped, so the resolution of DGI GPIO events is determined by the resolution of the DGI timestamp module.
Important:  Although bursts of higher-frequency signals can be captured, the useful frequency range of signals for which debug GPIO can be used is up to about 2 kHz. Attempting to capture signals above this frequency will result in data saturation and overflow, which may cause the DGI session to be aborted.
3.1.4.2 Timestamping
DGI sources are timestamped as they are captured by the debugger. The timestamp counter implemented in the Curiosity Nano debugger increments at 2 MHz frequency, providing a timestamp resolution of a half microsecond.

3.2 Curiosity Nano Standard Pinout

The 12 edge connections closest to the USB connector on Curiosity Nano boards have a standardized pinout. The program/debug pins have different functions depending on the target programming interface, as shown in the table and figure below.
Table 3-3. Curiosity Nano Standard Pinout
Debugger Signal Target MCU Description
ID ID line for extensions
CDC TX UART RX USB CDC TX line
CDC RX UART TX USB CDC RX line
DBG0 ICSPDAT Debug data line
© 2020 Microchip Technology Inc.
DS40002186A-page 10
USB
DEBUGGER
PS LED
NC
ID
CDC RX
CDC TX
DBG1
DBG2
VBUS
VOFF
DBG3
DBG0
GND
VTG
CURIOSITY NANO
PIC18F57Q43 Curiosity Nano
Curiosity Nano
...........continued
Debugger Signal Target MCU Description
DBG1 ICSPCLK Debug clock line
DBG2 GPIO0 debug GPIO0
DBG3 MCLR Reset line
NC No connect
VBUS VBUS voltage for external use
VOFF Voltage Off input. Disables the target regulator and
target voltage when pulled low.
VTG Target voltage
GND Common ground
Figure 3-3. Curiosity Nano Standard Pinout

3.3 Power Supply

The board is powered through the USB port and contains two LDO regulators, one to generate 3.3V for the on-board debugger, and an adjustable LDO regulator for the target microcontroller PIC18F57Q43 and its peripherals. The voltage from the USB connector can vary between 4.4V to 5.25V (according to the USB specification) and will limit the maximum voltage to the target. The figure below shows the entire power supply system on PIC18F57Q43 Curiosity Nano.
© 2020 Microchip Technology Inc.
DS40002186A-page 11
Loading...
+ 23 hidden pages