Blog Sturntech

MAX3421E USB HOST Debugging: HRSLT = hrJERR (0x0D)

with 4 comments

The MAX3421E (link) is a USB Peripheral/Host Controller with SPI Interface. It contains the digital logic and analog circuitry necessary to implement a full-speed USB peripheral or a full-/low-speed host compliant to USB specification rev 2.0.

When developing with the MAX3421E, routinely checking the HRSLT codes after each USB operation is important for confirming that a given operation reached a successful completion. The MAX3421E provides the HRSL register for this purpose; specifically the HRSLT field. The following is a summary of the error codes, taken from AN3785: Max3421E Programming Guide  (link).

HRSLT codes for the MAX3421E from AN3785

Information on the exact cause of the various error codes is scarce. I recently spent several hours trying to track down why a design was encountering the 0x0D (hrJERR) code.  Several forums have postings from developers confounded by this error, with no successful resolutions discovered. It seemed important to me to share what I learned.

In my design, the MAX3421E was fully responsive via SPI and had been configured into HOST mode. I was successfully retrieving my USB test peripheral’s Device Descriptor, Configuration Descriptors, and Endpoint Descriptors. I could execute Set_Address CONTROL messages with success and everything looked fine. My DATA0/DATA1 toggles were synced properly and my transactional NAKs were at a minimum.

Then I tried to initiate a BULK_OUT transfer and encountered the hrJERR error code. Long debugging story short, I had forgotten to execute a Set_Configuration CONTROL message to the peripheral in order to actually enable the functionality of the USB peripheral. Since my firmware was attempting to drive the MAX3421E Host (and subsequently the USB peripheral) without informing the USB peripheral what to expect, the JERR error resulted from the unexpected J-State change on the D+/D- lines.

Written by sturnfie

November 23rd, 2010 at 6:38 pm

Posted in C,Design,Tip,USB

Debugging a MCP2515: Stand-alone CAN controller

The MCP2515 is a stand-alone CAN controller with SPI interface (link). This chip is able to maintain the state-machine necessary to drive/read the signals on a CAN bus.

Block Diagram of the MCP2515

I recently chose this chip to allow a micro-controller based device to communicate via a CAN bus. The SPI interface proved pretty simple; a command message is clocked into the MCP2515, followed by an address, followed by any additional data required for the particular command.

The MCP2515 has several transmit buffers, several receive buffers, several status buffers, and plenty of configuration registers to handle interfacing with the CAN bus and filtering CAN messages.

I wrote the firmware and ordered the chip. The datasheet was very complete regarding how to interface over SPI, so I didn’t expect any significant roadblocks when testing my code with the chip.

I received the chip, built a prototype unit, and gave it a whirl. The chip sent a single CAN packet and went silent. Power-cycling the prototype led to non-repeat behavior (sometimes 1 packet, sometimes none).

Ok, it is definitely a software bug. I just needed to find it. I connected a scope to an unused  I/O pin on the micro-controller. I began reading out the contents of the various MCP2515 control registers at different portions of the software. I soon discovered (via the CANCTRL and CANSTAT registers) that the device was getting pushed into LOOPBACK mode.

This was strange. The only operational modes used in my software were CONFIGURATION and NORMAL. I quickly checked the mode bits before and after each signification communication with the MCP2515 and found that the mode changed to LOOPBACK after I set the ID field of the TXBnSIDH/TXBnSIDL registers.

It turns out that I mistakenly thought the xxxxSIDL register would be at the lower address, and xxxxSIDH at the higher, of the MCP2515 register map. When writing the ID to these registers, I would write the high-order bits to the xxxxSIDH address, then decrement the xxxxSIDH address thinking this would drop me to the xxxxSIDL address.

CAN Controller register map for the MCP2515

It didn’t. Going the wrong direction in the MCP2515 register map, I was writing the xxxxSIDL value to the TXBnCTRL register. The particular xxxxSIDL value was setting the TXREQ field of this register. After setting the xxxxSIDL ID field, my code started writing the data-to-be-sent into the transmit buffer. Once TXREQ was set, the MCP2515 tries to send the data in the transmit buffer….a buffer that I was concurrently attempting to update with the data to transfer.

This causes an internal error in the MCP2515 that results in the operational mode being set to LOOPBACK. While in this mode, the transmitter and receiver buffers are directly linked internally, so no external signals are generated. Once LOOPBACK mode is entered, a request to enter NORMAL mode must be sent to resume signal transmission/reception.

Written by sturnfie

November 10th, 2010 at 1:01 pm

Posted in C,CAN,Tip,USB

Using a PIC18F14K50 for a USB 2.0 CDC Peripheral Device

with 4 comments

USB has become quite ubiquitous across the wide realm of electronic devices. Every modern computer, most cellphones, and even some automobiles have USB support for peripheral devices. The key to USB’s success as an interconnection technology stems from the strict electrical and timing requirements imposed by the USB Implementers Forum (link). This standard is enforced through certification procedures, and ensures all USB devices can “talk to each other” (although making use of what is “said” is left to the implementing engineer).

USB and micro-controllers are commonly merged via external module conversion solutions. Companies such as FTDI Chip (link) have developed IC chips that can accept a UART/SPI communication from a micro-controller and translate/re-package it to conform to the signalling and voltage level requirements of USB. This is fine for most projects as the UART/SPI modules are quite common on micro-controllers, and even the limited maximum throughput provided by these solutions is adequate for most designs.

However, to unleash the full power of USB, this proxy approach is not acceptable. As such, various micro-controller manufacturers have begun integrating USB modules into their chip-sets. These modules are designed to drive a Universal Serial Bus with the proper signaling voltages. However, the designer must still develop firmware to program onto the micro-controller, in order to implement a USB device. The PIC18F14K50 is one such micro-controller.

Overview

The PIC18F14K50 (link) is a FLASH micro-controller that includes a full speed USB 2.0 compliant interface. This micro-controller has several other serial interfaces, a couple motor driving PWM modules, and 9 available ADC channels, which is all well and good, but really I chose it because it is cheap ($2) and has USB 2.0 support.

This project will implement a CDC (Communication Device Class) Peripheral device. There are several CDC classes (seen here). This project will focus implementing a serial communication interface.

Design

This design targets a minimalistic approach. The PIC18F14K50 is the sole logic IC. All other components are support components for the PIC. A 12MHZ oscillator provides a clock to the PIC. A ICSP interface allows for in-circuit programming of the PIC. The USB connector is a USB-A plug (to allow for connecting to a USB Host). A 1.5k resistor connects D+ to +V to indicate Full-Speed USB operation. An additional resistor network is driven from VBUS to function as a Connection-Sense circuit (to detect when the device is plugged into a PC). The PIC multiplexs PGC/PGD with D+/D-, so isolation resistors were included to prevent damage to a connected programmer or USB Host. This project is able to be powered from a bench supply during programming, and is to be powered from the USB connection during operation.

The firmware for this project enumerates the device as a CDC serial device. A PC that enumerates this device will create a virtual COM port through which a serial-terminal/telnet program may connect to the device at 9600,0,0,8. My favorite serial-terminal program is the always-free PuTTY. The windows driver file for this device is based on the generic cdc_ntxp.inf driver provided with the CCS C compiler.

Schematic

The following is the schematic for this project. As you can see, implementing USB only requires 4 pins. This circuit is the same irregardless of what USB Class is being implemented.

Schematic for the PIC18F14K50 USB Project

Firmware

The firmware for this project was written in C and compiled using the CCS C compiler v4.106. The USB stack provided with the CCS C compiler was used to handle the transactional overhead required by the USB standard.

The PIC is configured to use a high-speed external oscillator. The oscillator I chose operates at 12MHZ. The internal x4 PLL is enabled, scaling the processing clock to a frequency of 48MHZ. The PIC is then configured to operate at this clock frequency (CPUDIV1 implies no post-PLL scaling occurs on the processing clock).

The firmware is straight-forward to extend. On power-up, the device holds in a function loop. This loop begins by calling a function (usb_task()) that handles any USB transactions that are queued up. The first transactional status flag checked is whether or not an enumeration transaction has occurred (usb_enumerated()). Following the indication of a successful enumeration, the firmware polls the transaction receive buffer for new content (usb_cdc_kbhit()). If the HOST device sent data, the newest byte is retrieved via a call to usb_cdc_getc(). This firmware compares the result to a static char (ASCII byte). If the comparison passes, a character stream is written to the USB transmit buffer, which is then processed and sent to the HOST.

This firmware will respond with ” Here’s an A \n” when an ASCII “A” is seen in the receive buffer, and with ” Now a B \n” when an ASCII “B” is seen.

The usb_task() function call includes a periodic state check of a connection sense pin. This pin is used to sense the voltage on the VBUS +5V provided by the USB Host through the USB connector. If a voltage is not sensed on this input, the PIC firmware will de-enumerate and return to a waiting-for-enumeration state.

Here is the firmware.  Remember, you’ll need the CCS C compiler v4.106 to use it verbatim. It is recommended that you peruse through the USB_CDC libraries, as there are several variables that may need to be configured to meet your particular application. I won’t include these libraries here as they are included with the CCS C Compiler (and you will need that compiler to use this firmware).
——————————-

// PIC18F14K50 CDC USB Device
// Sturntech 2010

#include "18F14K50.h"

#fuses HS,NOWDT,NOPROTECT,NOLVP,NODEBUG,NOBROWNOUT,PLLEN,CPUDIV1,PUT,MCLR
#use delay(clock=48000000)

#define USB_CON_SENSE_PIN  PIN_C5

// Includes all USB code and interrupts
#include "usb_cdc.h"

void main(void)
{
   BYTE i;
   usb_init_cs();

   do
   {
      usb_task();
      if (usb_enumerated())
      {
         if (usb_cdc_kbhit())
         {
            i = toupper(usb_cdc_getc());

            if (i == 'A')
            {
               printf(usb_cdc_putc, " Here's an A \n");
            }

            if (i == 'B')
            {
               printf(usb_cdc_putc, " Now a B \n");
            }
         }
      }
   } while (TRUE);
}

——————————————

Build

There wasn’t a whole lot to this build. I used a breadboard for the IC and passive components. The USB-A plug was designed for PCB mounting, so I used a piece of protoboard as a mount. I knew I wasn’t going to program the circuit and connect the USB at the same time, so I neglected to place the isolation resistors. The first picture is a close-up of the device. The 2nd picture is the device talking over USB to the serial-terminal program on alaptop.

Close-up picture of the PIC18F14K50 USB Project

Picture of the PIC18F14K50 USB Project connected to a Laptop

Written by sturnfie

October 21st, 2010 at 4:54 pm

Posted in C,Design,EAGLE,PIC,USB

3-D Modeling of PCB designs from EAGLE

When working with fellow designers on electronic device projects, I have found providing a 3-D model of my PCB designs quite useful for describing the general placement of connectors and components on the PCB. A 3-D model communicates the little informational details that can trip up a project, such as: the polarization a given connector is expected to connect, where the mounting holes are expected to be drilled, and how much clearance mechanical devices might need to be physically accessible.

I’m fond of using EAGLE for my PCB designs, and typically use the Eagle3D expansion to generate 3D renderings of the designs. Eagle3D (which can be found here) is a ULP script for EAGLE. The resultant is a text file with a *.pov extension, written in a format to be read by POV-Ray (found here). POV-Ray is software package that generates ray-traced models from *.pov files.

Here’s an example of the PCB design and the resulting 3-D model:

Printed Circuit Board design for FTC-200: Open-Source

3-D Model from POV-Ray of the FTC-200 Open Source PCB board design

Here are two excellent reference articles describing the exact process and other extensions to this procedure:

http://www.juergentreml.de/archives/846

http://www.societyofrobots.com/electronics_Eagle3D_tutorial.shtml

Written by sturnfie

October 16th, 2010 at 7:45 pm

Posted in Design,EAGLE,Model,PCB

Solder-Mask and Cream-Mask DFM Warnings on EAGLE Designs

EAGLE CAD (manufacturer link) has a neat feature for automatically generating the solder and cream masks for SMD pads and vias when designing printed circuit boards. A solder-mask is used to protect the copper from oxidization, while acting as something of an isolation channel to prevent solder from bridging across closely spaced pins/pads. A cream-mask is used to define a region for automated application of solder paste.

In EAGLE, the default setting for the mask placement over a board feature is to generate a region that is 3% larger than the feature on each side. This is occasionally enough to trigger all sorts of warnings when running a PCB design through a Design For Manufacturing check, especially with designs that include high-density IC packages. Such packages simply don’t have the space between pins to allow for an additional 3% clearance while adhering to the PCB shop’s manufacturing limitations.

The auto mask generation feature in EAGLE can be configured in the Design Rule Check tool, under the Masks tab. Here’s a screen shot of the tab, along with the settings I use when sending designs to SunStone Circuits for manufacturing.

Screenshot of the Design Rule Check --> Masks tab in EAGLE

Written by sturnfie

October 13th, 2010 at 12:09 pm

Posted in Design,EAGLE,PCB,Tip