Module Partner Ecosystem: Tools for Getting to Production with Certified Modules
Multiple regulatory and wireless test tools exist from Cypress, module partners and third parties which can help customers get to production. These tools are required for testing on both RTOS and Linux/Android based customer platforms. The tools themselves often exist as either firmware that runs within the customer’s embedded design, or, as a client that runs on the customer’s PC and utilizes an interface exposed on the customer design; several choices below contain both elements.
The following is a list of the most common tools used by Cypress Wi-Fi/Combo and Bluetooth standalone customers:
WL Client utility which interfaces to MFG FW externally through a Linux or PC host
Cypress WLAN client utility (“WL”) is intended for developers who are evaluating and/or testing the Cypress CYW43xx combo and embedded Wi-Fi chip solutions. The WL Client is provided in binary within the FMAC/Linux release and runs from a terminal emulation program (e.g. bash) that is connected to the Android or Linux device's console port. Under RTOS, the provided x86 based executable (WICED/ModusToolbox/STM CubeMX) runs on a PC via a command shell and communicates to the target platform over a standard connection provided on the device under test. Note that for a non-standard Linux and Android platform, the source needs to be re-compiled by Cypress or the module partner for the target ARM Cortex A-Class platform. Often, a successful recompile of WL is not possible and it is advised for the field team to work with the business unit to process an SLA (Software License Agreement) and NDA (Non-Disclosure Agreement) so that WL source can be provided to the customer. Note that the version of WL provided must match the release of the MFG FW being utilized for the testing.
Manufacturing and Test Application (“MFG FW”)
MFG FW runs on the customer design (Wi-Fi Radio) as an embedded application and processes the full suite of “WL” Wi-Fi configuration and test commands sent by the WL Client. Under the Linux/FMAC platform, MFG FW is provided by the module partner. Under RTOS, MFG FW source is provided within the WICED SDK and can be recompiled for other ARM Cortex M-Class processor platforms such at ModusToolbox and ST Micro’s CubeMX. Work is underway to evaluate new methods of distribution for this tool, including a version which eliminates the need for a client. Note that the MFG FW version being used must match the release of WL being utilized for the testing.
WICED Manufacturing Bluetooth Test (“WMBT”)
WICED based Bluetooth testing over HCI on both standalone Bluetooth controllers and Wi-Fi/Bluetooth Combo devices. The WICED Manufacturing Bluetooth test tool (WMBT) is used to test and verify the RF performance of the Cypress SoC Bluetooth BR/EDR/LE devices under WICED. For LE tests, standard procedures from the Bluetooth Core Specification are utilized and support for vendor specific commands (VSCs) is also included. Each test sends a Host Controller Interface (HCI) or WICED HCI command from an application (running on PC) to the device (running an application setup to process the commands) and then waits for an HCI Command Complete event from the device. Within WMBT under WICED, all ancillary dependencies on files such the HCD are handled within the SDK itself.
OS agnostic (Linux/RTOS) graphical user interface (GUI) version of WMBT. As such, is also used to test and verify the RF performance of the Cypress SoC Bluetooth BR/EDR/LE devices. For LE tests, standard procedures from the Bluetooth Core Specification are utilized and support for vendor specific commands (VSCs) is also included. Each test sends a Host Controller Interface (HCI) command from an application (running on PC) to the device (running an application setup to process the commands) and then waits for an HCI Command Complete event from the device. Note that within CyBluetool, all ancillary dependencies on files such the HCD are handled externally and module partners will provide the necessary files to their customers for the specific module under test.
CySmart is a Bluetooth LE host emulation tool for Windows PCs. The tool provides an easy-to-use Graphical User Interface (GUI) to enable customers to test and debug their Bluetooth LE peripheral applications. Requiring a Cypress BLE dongle to emulate a host device in the GAP central role, the tool supports device discovery, connection establishment, pairing and bonding, and provides the ability to access the Generic Attribute Profile (GATT) server database for the PRoC BLE, PSoC4 BLE and the PSoC6 BLE devices as well as the EZ-BLE family of modules.
Similar to Cypress’ own CyBluetool, HCITool is BlueZ’s (Third Party) OS agnostic HCI based Bluetooth configuration and test tool. Like the other Bluetooth tools described earlier, the tool also requires access to an HCI port on the customer design to send/receive both standard HCI and VSC commands. Very popular choice on Linux and RTOS based customer platforms.
Cypress is responsible for the maintenance and support of the Cypress based tools. Third parties assume a similar responsibility for their own tools, and Cypress may provide user guides for these tools if it benefits customers. Except for third-party tool
, Cypress also is responsible for the distribution of all Bluetooth based configuration and test tools noted in the previous section (i.e. Websites, within SDKs/Software Releases, etc.). Cypress relies on module partners and our own FAEs to distribute MFG FW and the WL Client to their customers.
In addition to the tools noted above, there are multiple documents available from Cypress and our module partners that customers can leverage to navigate the regulatory/test process.
Some of the more utilized documents include:
Cypress Wi-Fi Regulatory Manual: https://www.cypress.com/file/453451/download
Comprehensive Regulatory Guide which includes a regulatory power template that customers should fill out with their designated test house and submit to Cypress L1 after first consulting the module partner they’ve selected.
OTP Programming and NVRAM Development in SDIO Mode: https://www.cypress.com/documentation/application-notes/an214808-otp-programming-and-nvram-developme...
Describes the method for creating an nvram.txt file, which is then used to test a new board design, optimize NVRAM values, and program the one-time programmable (OTP) nonvolatile memory in a device that uses a WLAN SDIO host interface. Customers should consult with their module partner and regulatory house before modifying any of the values within the nvram.txt file.
WICED™ Manufacturing Test User Guide: https://www.cypress.com/file/385966/download
For customers going into production, this document explains how to setup production and regulatory testing under WICED by processing WL commands. Commonly used in conjunction with the WL Tool for Embedded 802.11 Systems guide below.
WL Tool for Embedded 802.11 Systems: CYW43xx Technical Information: https://community.cypress.com/docs/DOC-2360
Also for customers going into production, this guide provides a detailed WL command reference which can be leveraged under both Linux/Android and RTOS platforms.
CyBluetool User Guide: https://community.cypress.com/docs/DOC-16475
Used to test and verify the RF performance of the Cypress SoC Bluetooth BR/EDR/LE devices.
CyBluetool User Guide (Murata): https://community.cypress.com/docs/DOC-16907 (located on their private site)
Murata’s created their own version of the CyBluetool User Guide to help better support their customers.
HCI-Based Bluetooth Testing
The purpose of this document is to demonstrate the use of common HCI commands needed for Bluetooth radio testing using third-party tool like BlueZ’s HCITool. Note that the commands contained within this document are intended for use with Cypress' own Bluetooth BR/EDR and BLE Controllers and not our competitors devices.
FCC Regulatory Certification Guide (Murata): https://wireless.murata.com/datasheet?/RFM/data/murata_wifi_bt_fcc_guide.pdf
Murata provided guide which walks customers through the regulatory process for both their SIP Reference (Limited Modular) and Full Modular certified modules.
In addition to the list above, there are also regulatory/test documents included within software releases/SDKs (WMBT for Bluetooth testing), provided by third party tool/stack vendors such as BlueZ (HCITool for BT testing)
Cypress or the module partner remains responsible for the regulatory/test documents each produces and provides to customers. Each party provides feedback to one another on the respective documentation, which provides a path for continuous improvement.