Beginner
10 min

Simplify data transfer between USB and UART devices with CP2110 and PIC32MZ1024EFH064

From USB to UART in a blink!

USB UART 5 Click with PIC32MZ clicker

Published Nov 11, 2023

Click board™

USB UART 5 Click

Development board

PIC32MZ clicker

Compiler

NECTO Studio

MCU

PIC32MZ1024EFH064

Revolutionize your data communication projects with the USB to UART magic – a compact and efficient solution that connects your devices swiftly and flawlessly.

A

A

Hardware Overview

How does it work?

USB UART 5 Click is based on the CP2110, a single-chip HID USB to UART bridge controller from Silicon Labs. A USB function controller in the CP2110 is a USB 2.0-compliant, full-speed device with an integrated USB transceiver, one-time programmable ROM, and an asynchronous serial data bus (UART) in one compact package. The UART capabilities of the CP2110 include baud rate support from 300 to 1Mbps, hardware flow control, RS-485 support, and GPIO signals that are user-defined for status and control information. The USB function controller manages all data transfers between USB and UART, command requests generated by the USB host controller, and commands for controlling the function of the UARTs and GPIO pins. The CP2110 uses the standard USB HID device class, natively supported by most operating systems. A custom driver does

not need to be installed for this device. In addition, the CP2110 also supports USB Suspend and Resume modes for power management purposes. The CP2110 enters Suspend mode when Suspend signaling is detected on the bus using the SPD pin of the mikroBUS™ socket. Upon entering Suspend mode, the SPD signal is asserted, but it can also be asserted after a reset condition (RST pin) until device configuration during USB Enumeration is complete. SPD pin detects logic high level when the device is in the Suspend state and logic low when the device is in Normal mode, which is also visually indicated via red LED labeled as CONNECTED. This Click board™ also features 8 GPIO signals, located on unpopulated headers, that are user-defined for status and control information. Four GPIO signals support alternate features, including a configurable clock output

(CLK) from 24MHz to 47kHz, RS-485 transceiver control, and TX and RX LED toggle features. Also, the USB UART 5 Click can work in a USB-powered configuration thanks to the ability of the CP2110 to provide adequate power to all its parts with the help of an internal regulator using the USB bus voltage. To select this mode of operation, it is necessary to switch the jumper PWR SEL to the position marked with VBUS. This Click board™ can be operated only with a 3.3V logic voltage level. The board must perform appropriate logic voltage level conversion before using MCUs with different logic levels. Also, it comes equipped with a library containing functions and an example code that can be used as a reference for further development.

USB UART 5 Click hardware overview image

Features overview

Development board

PIC32MZ Clicker is a compact starter development board that brings the flexibility of add-on Click boards™ to your favorite microcontroller, making it a perfect starter kit for implementing your ideas. It comes with an onboard 32-bit PIC32MZ microcontroller with FPU from Microchip, a USB connector, LED indicators, buttons, a mikroProg connector, and a header for interfacing with external electronics. Thanks to its compact design with clear and easy-recognizable silkscreen markings, it provides a fluid and immersive working experience, allowing access anywhere and under

any circumstances. Each part of the PIC32MZ Clicker development kit contains the components necessary for the most efficient operation of the same board. In addition to the possibility of choosing the PIC32MZ Clicker programming method, using USB HID mikroBootloader, or through an external mikroProg connector for PIC, dsPIC, or PIC32 programmer, the Clicker board also includes a clean and regulated power supply module for the development kit. The USB Micro-B connection can provide up to 500mA of current, which is more than enough to operate all onboard

and additional modules. All communication methods that mikroBUS™ itself supports are on this board, including the well-established mikroBUS™ socket, reset button, and several buttons and LED indicators. PIC32MZ Clicker is an integral part of the Mikroe ecosystem, allowing you to create a new application in minutes. Natively supported by Mikroe software tools, it covers many aspects of prototyping thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

PIC32MZ clicker double side image

Microcontroller Overview

MCU Card / MCU

default

Architecture

PIC32

MCU Memory (KB)

1024

Silicon Vendor

Microchip

Pin count

64

RAM (Bytes)

524288

Used MCU Pins

mikroBUS™ mapper

Suspend Mode
RE4
AN
Reset
RE5
RST
UART RTS
RG9
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
NC
NC
PWM
UART CTS
RB5
INT
UART TX
RB2
TX
UART RX
RB0
RX
NC
NC
SCL
NC
NC
SDA
NC
NC
5V
Ground
GND
GND
1

Take a closer look

Schematic

USB UART 5 Click Schematic schematic

Step by step

Project assembly

PIC32MZ clicker front image hardware assembly

Start by selecting your development board and Click board™. Begin with the PIC32MZ clicker as your development board.

PIC32MZ clicker front image hardware assembly
GNSS2 Click front image hardware assembly
Prog-cut hardware assembly
GNSS2 Click complete accessories setup image hardware assembly
Micro B Connector Clicker Access - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
Necto image step 5 hardware assembly
Necto image step 6 hardware assembly
Flip&Click PIC32MZ MCU step hardware assembly
Necto No Display image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Debug Image Necto Step hardware assembly

Track your results in real time

Application Output

After loading the code example, pressing the "DEBUG" button builds and programs it on the selected setup.

Application Output Step 1

After programming is completed, a header with buttons for various actions available in the IDE appears. By clicking the green "PLAY "button, we start reading the results achieved with Click board™.

Application Output Step 3

Upon completion of programming, the Application Output tab is automatically opened, where the achieved result can be read. In case of an inability to perform the Debug function, check if a proper connection between the MCU used by the setup and the CODEGRIP programmer has been established. A detailed explanation of the CODEGRIP-board connection can be found in the CODEGRIP User Manual. Please find it in the RESOURCES section.

Application Output Step 4

Software Support

Library Description

This library contains API for USB UART 5 Click driver.

Key functions:

  • usbuart5_generic_write - USB UART 5 data writing function.

  • usbuart5_generic_read - USB UART 5 data reading function.

  • usbuart5_reset_device - USB UART 5 reset the device function.

Open Source

Code example

This example can be found in NECTO Studio. Feel free to download the code, or you can copy the code below.

/*!
 * @file main.c
 * @brief USB UART 5 Click Example.
 *
 * # Description
 * This example reads and processes data from USB UART 5 Click board™.
 * The library initializes and defines the UART bus drivers 
 * to transmit or receive data.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Initializes driver, wake-up module, and performs the default configuration.
 *
 * ## Application Task
 * Any data which the host PC sends via HidUartExample 
 * will be sent over USB to the click board and then it will be read and 
 * echoed back by the MCU to the PC where the terminal program will display it.
 * Results are being sent to the UART Terminal, where you can track their changes.
 *
 * @note 
 * Make sure to download and install 
 * CP2110/4 Software package for Windows/Mac/Linux on the host PC.
 *
 * @author Nenad Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "usbuart5.h"

static usbuart5_t usbuart5;
static log_t logger;

void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    usbuart5_cfg_t usbuart5_cfg;  /**< Click config object. */

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, " Application Init " );

    // Click initialization.
    usbuart5_cfg_setup( &usbuart5_cfg );
    USBUART5_MAP_MIKROBUS( usbuart5_cfg, MIKROBUS_1 );
    if ( UART_ERROR == usbuart5_init( &usbuart5, &usbuart5_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    usbuart5_default_cfg ( &usbuart5 );
    log_info( &logger, " Application Task " );
}

void application_task ( void ) 
{
    char rx_data = 0;
    if ( usbuart5_generic_read ( &usbuart5, &rx_data, 1 ) )
    {
        if ( usbuart5_generic_write ( &usbuart5, &rx_data, 1 ) )
        {
            log_printf( &logger, "%c", rx_data );
        }
    }
}

void main ( void ) 
{
    application_init( );

    for ( ; ; ) 
    {
        application_task( );
    }
}

// ------------------------------------------------------------------------ END

Additional Support

Resources