Back to All
Project

QCLI_Demo w/ QCA4020 Dev Kit

Created by
Rajan Mistry
Aug 20, 2018

 

Skill Level Area of Focus Operating System Platform/Hardware
Beginner Bluetooth, IoT, Education, Embedded, Smart Home RTOS QCA 402x WiFi/BLE/ZigBee

This project is intended to help you get familiar with the QCA4020 System-On-Chip (SoC) Product Development kit. The QCA4020 IoT solution offers Wi-Fi, Bluetooth low energy (BLE), and 802.15.4 capable radios in a single-chip package.CLI- based demo application that is included in the SKD provides a mechanism to demonstrate different features and technologies that QCA402x supports.

Objective

The objective of this demo is to get familiar with the QCA4020 development kit and understand how developers can test all the features using the QCLI_Demo application.

What is the QCLI_Demo application?

QCLI_Demo is a sample application that is included in the SDK. It is designed to provide a command line interface to most of the features available on the QCA402x development platform. The command framework is implemented as a set of nested menus and each menu provides a list of sub-commands that correspond to a feature or technology.

How does the QCLI_Demo tap into various features of the QCA4020 development kit?

The QCLI_Demo uses the QAPIs framework to demonstrate different features. It is designed to provide a reference implementation and usage of customer facing QAPI’s

So, what are QAPIs?

Qualcomm® API (QAPI) is an interface provided by Qualcomm Technologies, Inc. and/or its subsidiaries to abstract OEM software from low-level system software. QAPI provides access to low-level system software exposing SoC hardware/peripherals, I/O interfaces, communication interfaces, network services, security services, hardware/software configuration and power management interfaces, and all other associated functionality deemed part of a chip support package. QAPI is meant to enhance portability of application-specific OEM software by abstracting it from low-level system software provided by Qualcomm Technologies.

Materials Required / Parts List / Tools

Additional Resources

Build / Assembly Instructions

In the Box

Qualcomm-image

 

The contents of the QCA4020 Development kit, as seen above, include:

  • QCA4020 development board
  • USB to Micro USB cables
  • Power supply
  • Jumpers
  • Setup guide

 

For the time being, you can set the kit aside while you install the software components and set up the development environment on your computer. During the setup process, you will only briefly use the kit while installing the FTDI drivers for JTAG.

Setup the development environment

  1. Install Python version 2.7.X
    Some of the support scripts are Python-based so be sure to install Python 2.7.X because the support scripts do not support Python 3. After installation, add the path to python.
    Example: If python.exe is in the folder
C:\CRMApps\Apps\Python276-64
set path as follows:
%PATH%=%PATH%:C:\CRMApps\Apps\Python276-64
  • Install Eclipse IDE for C/C++: GUI based integrated development environment
    Supported Version: Oxygen version - Release 4.7.2
  • Install Java: Eclipse IDE has dependency on Java, JDK 8 or higher.
    After installation, add path to Java.
    Example: If Java.exe is in
    • C:\ProgramData\Oracle\Java\javapath
    set path as follows:
    %PATH%=%PATH%: C:\Program Files\Java\jdk1.8.0_161\bin
  • Install OpenOCD version 0.10.0 [2017-06-09] which is available here.
    OpenOCD plugin is required to establish the connection between Eclipse IDE and onboard FTDI JTAG debugger. After installation, add the path to OpenOCD.
    Example: If openocd.exe is in
    • C:\Program Files\OpenOCD-20170609\bin
    set path as follows:
    set %PATH%=%PATH%:C:\Program Files\OpenOCD-20170609\bin
  • Download GNU Arm Embedded toolchain version 6.x (gcc-arm-none-eabi-6-2017-q2-update).
    Install by running the ".exe" file and make sure you select the option to "Add path to environment variables" during the final step.
  • Setup OpenOCD plugin usage with Eclipse
    1. Install GNU MCU plugin for Eclipse
    • Go to Help > Install new software
    in Eclipse IDE
    Adding
  • In the Available Software window, click "Add" and enter the Name and Location of the repository.
    Location: "http://gnu-mcu-eclipse.netlify.com/v4-neonupdates" Enter details and click "OK" as seen below.
    • Adding
  • Select "GNU ARM & RISC-V C/C++ Cross Development Tools" and click "Next" as seen below.
    • Adding
  • You will see the list of Items to be installed as seen below.
    click "Next".
    • Adding
  • Follow the on-screen instructions and select "Finish" to complete the installation.
  • Restart the Eclipse IDE
  • Set path to openOCD
    Restart the Eclipse IDE and under 
    • Window > preferences
    set path to openOCD as seen below.
    Setting
  • Set the Debug Config
    1. Go to
    • Run >Debug Configurations > GDB OpenOCD Debugging
    Set the Application and OpenOCD options as show in the images below.
  • Select Quartz.elf as the C/C++ application.
    If you have already built the image, select Disable auto build. If image is not built, select Use workspace settings.
    • Debug
  • In the Debugger window, provide the openocd executable path with config option,
    • -f ${project_loc}\build\gcc\qca402x_openocd.cfg
  • Provide the arm-none-eabi-dgb executable path for the GDB client as seen below.
    • Debug
  • Download "QCA4020 OEM SDK+CDB" which is available under the Qualcomm Developer Network software section here.
    The SDK contains sample demo applications with source code to demonstrate different features and technologies that QCA402x supports. Demos are in the following folder:
    • target\quart\demo\<name_of_demo>
  • Install the QCA plugin jar file available at 
    • <SDK_source>/target/quartz/demo/EclipseSupportFiles
    1. Copy the jar file (QCA402x_plugin.jar) to the "dropin" folder under the Eclipse IDE installed folder.
    2. Restart the Eclipse IDE if running. To restart Eclipse, click on the File menu of Eclipse IDE and select the Restart menu item after the plug-in is installed.
  • Install FTDI driver for JTAG
    1. Download the zadig application from http://zadig.akeo.ie/.
    2. Connect the J85 connector on the development board to the host PC using the included Micro-USB cable.
    3. Once the QCA4020 Development board is connected to the host PC, the Device Manager shows two COM ports. The lower port number is for JTAG and the upper port number is for serial connection.
    4. Run zadig.exe file and go to
    • Options > List All
    devices and select the device in the drop down. Dual RS232-HS (interface 0) represents lower port number and dual RS232-HS (interface 1) represents higher port number. The following example shows Select Dual RS232-HS (interface 0) to install FTDI on the WinUSB driver for JTAG interface.
    Installing
    After installing the FTDI driver, the Device Manager will look as seen below.
    Device

    Make sure that the paths are set correctly under the environment variables.
    They should be set as seen below.

    System

    Congratulations, you have now successfully set up the development environment for the QCA4020 development kit. The next section shows you how to import the sample “Hello World” application.

    Import sample "QCLI_Demo" application

    1. Install Eclipse project files for sample demo applications.
      To install there is 
    eclipseSupport.bat
    for Windows and 
    eclipseSupport.sh
    for Linux in 
    <SDK_source>/target
  • Open a terminal window and navigate to 
    • <SDK_source>/target
  • Run the 
    • sh eclipseSupport.sh
    or 
    eclipseSupport.bat
    command.
    After executing the script, the Eclipse project files .cproject, .project and .settings folder are updated in the respective folders of the demo applications.
  • Open the Eclipse application.
  • Go to 
    • File > Open Projects
    from File System and set import source for the demo application.
    Example: <path>/target/quartz/demo/QCLI_Demo
    Import
    You should be able to see the import source as an Eclipse project.
  • Click Finish.

    • Next, build the application.

    Build the Application

    1. Configure the QCLI demo:
      The QCLI demo provides a CLI menu for all the features and technologies supported on QCA402x. A user may choose to disable certain features (for example, due to lack of flash space). For this purpose, a configuration file is provided in the SDK that allows configuring each feature to “true” or “false”.
      For example:
      1. To disable the Zigbee feature, edit the env.config file:
    Change: ‘CFG_FEATURE_ZIGBEE=true’
 To: ‘CFG_FEATURE_ZIGBEE=false’
  • To apply the new configuration:
    1. On Windows, run ‘setenv.bat’.
    2. On Linux, run ‘. setenv.sh’.
  • Go to: 
    • Project properties > Configure build
    setting.
  • Right click on the project name in project explorer and go to “Properties”.
  • Verify the build command and the build directory in the Builder settings tab.
  • Go to C/C++ build and set the build command to “build.bat”, and the build directory to “path to source”.
    • Hello
  • Click “Apply and Close”.
  • Build the application and you should see the following messages in Console Window.
    • Eclipse

    Flash the Application on the QCA4020 development board using JTAG and Eclipse.

    Alright, time to start playing with the Developer Kit. Since this project/demo involves two QCA402x development boards, flash both the boards by following the below steps.

    1. Setup the QCA4020 development board as described in Appendix A, "CDB2x board setup" in QCA402x-CDB2x development kit user’s guide.
    2. Put the jumper on J31 1&2 on the QCA4020 development board.
      Tip: There is a "Dot" next to each header that indicates the position of Pin Number 1.
      After the flashing through JTAG is done, remove the jumper.
      Jumpers on the developer board should be as seen below.
      1. Jumper on J31 (Pins 1 and 2),
        Cross connect pins 2 and 3 of J38 and J39
    Jumpers
  • Jumpers on J30 and J32
    • Jumpers
  • Jumpers on J57 and J36
    • Jumpers
  • Open Eclipse IDE and navigate to: 
    • Run > External Tools > External Tools Configuration
  • Click on the program, create a new launch configuration and update the paths as shown below in the Main tab.
  • Provide the path for "flash_openocd.bat" or "flash_openocd.sh" in the location box.
    • Run
  • To flash the program, click 
    • Run > External Tools > OpenOCD JTAG Flashing
    The flashing logs can be seen on the Eclipse console.
    You will see the following lines at the end of the log: 
    [2018-07-17 16:51:24,434] INFO: Script finished processing generated_fwd_table.xml File:flash_through_gdb.py:699 Function:main
 Flash Operation Completed Successfully...
 SUCCESS: The process "openocd.exe" with PID 17776 has been terminated.

    The application was flashed successfully on the development board.

    Usage Instructions

    Run the application in Autoboot mode

    The Autoboot mode refers to the mode where the system boots up on a power cycle and no JTAG connectivity is required. Follow the below steps to run the application in Autoboot mode.

    1. Remove the jumper on J31.
      2. This was connected to flash the image on the board.
    2. Power cycle the system.

    Once the board powers up, open a serial console on your host PC.

    Connect it to the com port number assigned to the USB-serial connection with the following settings.

    1. Baud Rate: 115200
    2. Data Bits: 8
    3. Parity: None
    4. Stop bit: 1
    5. Flow Control: None

    You should see the following CLI menu on the serial console. You can now type the commands to test the system features.

    CLI

    The CLI menu is divided in groups and sub-groups. Each level/menu provides a list of sub-commands that correspond to a feature or technology.

    Two example command lists are shown below - the first being at the top-level and the second after navigating into the WLAN group.

    • Top-level command list
      Command List:
      Commands:
      1. Help
      2. Exit
      Subgroups:
      1. HMI
      2. WLAN
      3. Net
    • WLAN group command list
      Command List:
      Commands:
      1. Help
      2. Up
      3. Root
      4. Enable
      5. Connect
      6. Disconnect

      Subgroups:
      1. SupPart1
      2. SupPart2

     

    Congratulations! You have set up with QCA4020 development environment and flashed the board with the QCLI_Demo. You can now start testing various features by sending commands over serial port.

    What can you do with the QCLI_Demo?

    There are subgroups and sub-commands for:

    1. BLE
    2. Zigbee
    3. Thread
    4. HMI
    5. WLAN
    6. Net
    7. Certificate management demo
    8. Coex
    9. Firmware Update
    10. ADSS
    11. Peripherals
    12. Low Power
    13. File System
    14. Secure FS
    15. Crypto
    16. AWS demo
    17. JSON
    18. Azure

     

    For more information on all the sub-commands, please check out section 6, page 69 of the QCA4020 development kit user’s guide.

    Opinions expressed in the content posted here are the personal opinions of the original authors, and do not necessarily reflect those of Qualcomm Incorporated or its subsidiaries ("Qualcomm"). The content is provided for informational purposes only and is not meant to be an endorsement or representation by Qualcomm or any other party. This site may also provide links or references to non-Qualcomm sites and resources. Qualcomm makes no representations, warranties, or other commitments whatsoever about any non-Qualcomm sites or third-party resources that may be referenced, accessible from, or linked to this site.

    Project Authors
    Staff Engineer, Qualcomm Technologies, Inc.
    Related Projects

    Sign up for the Developer Newsletter.

    Get software and hardware tool resources to help optimize your development delivered to your inbox weekly.

    Qualcomm relentlessly innovates to deliver intelligent computing everywhere, helping the world tackle some of its most important challenges. Our leading-edge AI, high performance, low-power computing, and unrivaled connectivity deliver proven solutions that transform major industries. At Qualcomm, we are engineering human progress.

    Stay connected

    Get the latest Qualcomm and industry information delivered to your inbox.

    Subscribe
    Manage your subscription
    Also of Interest

    © Qualcomm Technologies, Inc. and/or its affiliated companies.

    Snapdragon and Qualcomm branded products are products of Qualcomm Technologies, Inc. and/or its subsidiaries. Qualcomm patented technologies are licensed by Qualcomm Incorporated.

    Note: Certain services and materials may require you to accept additional terms and conditions before accessing or using those items.

    References to "Qualcomm" may mean Qualcomm Incorporated, or subsidiaries or business units within the Qualcomm corporate structure, as applicable.

    Qualcomm Incorporated includes our licensing business, QTL, and the vast majority of our patent portfolio. Qualcomm Technologies, Inc., a subsidiary of Qualcomm Incorporated, operates, along with its subsidiaries, substantially all of our engineering, research and development functions, and substantially all of our products and services businesses, including our QCT semiconductor business.

    Materials that are as of a specific date, including but not limited to press releases, presentations, blog posts and webcasts, may have been superseded by subsequent events or disclosures.

    Nothing in these materials is an offer to sell or license any of the services or materials referenced herein.