AnsweredAssumed Answered

Design Considerations for Debug

Question asked by LPCware Support on Mar 31, 2016

Debug related signals and considerations

 

JTAG was the traditional mechanism for debug connections for ARM7/9 parts, but with the Cortex-M family, ARM introduced the Serial Wire Debug (SWD) Interface. SWD is designed to reduce the pin count required for debug from the 5 used by JTAG (including GND) down to 3. In addition, one of the pins freed up by this can be used for the low cost SWO tracing technology - for more details see the FAQ "Overview of Trace support in LPCXpresso IDE".

 

The SWD/SWV pins are overlaid on top of the JTAG pins as follows:

 

JTAG ModeSWD ModeSignalRequired pull-up / pull-down (if not implemented internally by MCU)
TCKSWCLKClock into the coreUse 10K-100K Ohm pull-down resistor to GND
TDI-JTAG Test Data InputUse 10K-100K Ohm pull-up resistor to VCC
TDOSWVJTAG Test Data Output / SWV trace data output (SWO)Use 10K-100K Ohm pull-up resistor to VCC
TMSSWDIOJTAG Test Mode Select / SWD data in/outUse 10K-100K Ohm pull-up resistor to VCC
GNDGND--

 

Some MCUs do not include internal pull-up or pull-down resistors on JTAG/SWD pins. You  will need to review the datasheet for the specific MCU being used to confirm. Where internal resistors are not provided, these should be added externally onto your board as detailed above. You may use resistors between 10K and 100K for these signals. This will prevent the signals from floating when they are not connected to anything. Failure to do this will lead to, at best, unreliable debug connections, or more likely no ability to debug at all.

 

If an internal resistor is provided for a pin by the MCU, then an external resistor  is not required for that pin. But if external resistor is provided in such cases, then it must match that provided internally by the MCU.

 

Note for TCK/SWCLK, although a pull-down is recommended, you can alternatively use a pull-up. The main thing is that it does not float. Note in particular that if the MCU provides an internal pull-up on this signal, then adding an external pull-down on the board is not recommended.

 

Note Cortex-M0/M0+ parts do not support SWV trace.

 

Other important debug related signals

 

When designing your board, you should also take the following signals into account for debug purposes. Failure to do this will lead to, at best, unreliable debug connections, or more likely no ability to debug at all.

 

  • RESET
    • Connect this pin to the (active low) reset input of the target MCU
    • We would strongly recommend also including RESET in addition to SWDIO, CLK and GND. For debugging, the tools may try to pull this in certain circumstances (depending upon debug probe, debug configuration settings and tools).
  • ISP
    • Most NXP MCU's have an ISP pin which (when pulled low) can be used to cause the MCU to enter a bootloader on reset.
    • For example on LPC17xx this is P2.10 and on LPC11xx and LPC13xx it is P0.1.
    • Always ensure that you have a 10K to 100K Ohm pull up resistor on the ISP pin, otherwise you are unlikely to be able to make a successful debug connection.
    • NOTE : LPC-Link2 (in both standalone form and as built in to the LPCXpresso V2 / V3 boards) has the ability to force an ISP reset via pin 7 of the Cortex 10-pin 0.05" JTAG/SWD Connector. For more details see the FAQ "ISP Reset over debug".
  • VTref
    • The Voltage Target Reference pin supplies some debug probes (such as LPC-Link2) with the debug rail voltage of the target to match its I/O logic level. For more information, see "Logic Levels and Ground" below.
  • RTCK, DBGSEL
    • Some NXP LPC2000 devices have special pins that enable the JTAG interface. For example, on the NXP LPC2129 the signal RTCK must be driven low during RESET to enable the JTAG interface. You may want to add jumpers to your hardware to accomplish this.

 

Logic Levels and Ground

 

VTref (the Voltage Target Reference pin, direction from target to debug probe) supplies some debug probes such as LPC-Link2 and Red Probe+ with the debug rail voltage of the target to match its I/O logic level.  VTref can be tied directly to the target VDDIO rail or through a resistor.  If VTref is tied high through a resistor, its value must be no greater than 100Ω.

 

The original LPC-Link1 only supported 3.3V and did not require VTref whereas the LPC-Link2 uses dual-supply buffers that allows the Link2 to work with targets using a different voltage (between 1.8V - 4.3V).

 

On the LPC-Link2, when JP2 is shunted this will power the target side of the dual-supply buffer and provide power to the target through a diode on VTref.  With JP2 open the target must supply the VTref to power the target side of the dual-supply buffer.

 

When a debug probe attempts to adjust logic levels based on the voltage it sees on VTref, this is referenced to whatever GND it has to work with. The voltage at VTref is coming from your target, thus you need a good GND, shared with your target hardware.

 

Note that debug probes can be killed (like most USB devices) by excessive over current through ground of the probe and back through the PC used for debugging. The usual cause of this is that your target has it's own PSU and has a ground differential slightly different from your debug PC. Please do not rely on your debug probe to ground your PC to the same potential as your target.

 

Power

 

Even when you have designed your debug circuit according to the above considerations, you should also check that sufficient power is being supplied to your target in order to obtain a reliable debug connection. If you are using a USB port on your PC to power your target, make sure that your PC is able to supply the required power over USB - many PC USB ports do not meet USB power requirements.

 

Debug Connector Pinouts

 

ARM has defined three debug connector pinouts that are in common use, a "traditional" 20 pin connector, a Cortex 10 pin connector and a Cortex 20 pin Debug+ETM connector...

 

"Traditional" 20-pin 0.1" JTAG/SWD Connector Pinout

 

  • This connector was originally defined for connection to ARM7/9 parts over JTAG, but is still sometimes found in Cortex-M systems (for connections over JTAG or SWD).
  • Note that RTCK (Return clock) is only used on older ARM cores (ARM7TDMI and ARM9 family) before the debug was properly decoupled from the core clock domain.
  • Dimensions of the ARM JTAG connector are 1.29" x 0.722" (33mm x 18.5mm).

 

Cortex 10-pin 0.05" JTAG/SWD Connector Pinout

  • Suitable connector headers include :
    • Harwin: M50-3500542
    • Mouser: 855-M50-3500542
    • Samtec shrouded header: FTSH-105-01-F-D-K
  • The 10-pin Samtec FTSH-105-01 connector has the dimensions: 0.25" x 0.188" (6.35mm x 4.78mm).
  • Some boards use un-shrouded 10-pin headers. Always ensure that you connect your cable correctly, typically by matching the "1" marked on the board to the red -stripe on the cable.
  • The 10-pin cable is Samtec part number FFSD-05-D-12.00.01-N

 

NOTE : LPC-Link2 (in both standalone form and as built in to the LPCXpresso V2 / V3 boards) has the ability to force an ISP reset via pin 7 of the Cortex 10-pin 0.05" JTAG/SWD Connector. For more details see the FAQ "ISP Reset over debug".

 

Cortex 20-pin 0.05" JTAG/SWD/ETM Connector Pinout

  • This small 20-pin (0.05") connector provides access to SWD, SWV, JTAG, and ETM (4-bit) signals available on Cortex-M3/M4 devices.
  • The 20-pin header (Samtec FTSH-110-01) has the dimensions: 0.50" x 0.188" (12.70mm x 4.78mm).
  • Although LPCXpresso IDE does not currently support the direct use of the ETM (Embedded Trace Macrocell), a number of boards use this form of connector as one of or as their main debug connector.
  • A special Cortex 10-pin debug -> Cortex 20-pin debug+ETM connector cable will typically be required to debug such boards.

 

10 to 20 pin adapter

 

Some debug probes (such as Red Probe+) may be provided with a "traditional" 20-way cable to connect to your board. If your board is only fitted with a 10-pin connector, then the simplest way to connect the two will be to use an adapter to convert between 10 and 20 pins. For example :Embedded Artists 10-PIN TO 20-PIN JTAG ADAPTER

 

The same adapter can also be used to allow a probe that assumes a 10-pin connector (such as LPC-Link or LPC-Link2) to be attached to a board with a "traditional" 20pin connector.

 

Switching between JTAG and SWD modes of debug

 

Some Cortex-M based MCUs support both SWD and JTAG, others support only SWD (such as NXP LPC11xx and LPC13xx). Where both are supported, there are special sequences defined to switch from JTAG mode (default) to SWD mode (and vice versa) that can sent to the core. This switch sequence uses TMS (SWDIO), and this line is connected for any SWD/JTAG connection

Normally where both modes are supported, LPCXpresso IDE will default to using SWD mode (the main exeception to this is LPC43xx). However this can be modified by editing the launch configuration for a project.

 

Outcomes