Please note as of Wednesday, August 15th, 2018 this wiki has been set to read only. If you are a TI Employee and require Edit ability please contact x0211426 from the company directory.
WL127x Getting Started Guide
Content is no longer maintained and is being kept for reference only!
- 1 Introduction and Purpose
- 2 Recommended Software Utilities
- 3 Software Upgrade Instructions
- 4 Out-of-the box experience
- 5 Advanced Functionality Options
- 6 Performance Evaluation
- 7 Suspend Resume
- 8 Troubleshooting Guide
- 9 For Additional Information...
Introduction and Purpose
This page provides the “getting started” information required for working with the AM37x and AM18x Wireless Connectivity Cards. The instructions are valid for both Bluetooth and Wireless LAN connectivity, and include the following major sections:
- An overview of the Out-of-the-Box phase (i.e. first-time hardware bringup and establishing basic functionality):
- First-time installation of the AM18X/AM37x platform’s hardware
- AM18x/AM37x platform installation with pre-made images
- Running WLAN and Bluetooth basic use-cases
- Advanced WLAN and Bluetooth information (i.e. advanced options, to be performed after completing the Out-of-the-Box stages):
- WLAN and Bluetooth scripts
- Advanced build instruction-guide (for WLAN components that are supplied with the SDK only)
- Performance evaluation (throughput, CPU utilization)
- Suspend/Resume functionality
- Debug options
Recommended Software Utilities
The following applications are recommended for configuring and measuring the system performances:
- Serial Port Terminal application (Tera Term): This application allows configuring the WLAN and the Bluetooth, and can be downloaded from:<teraterm>
- When installing Tera Term, choose "Standard Installation" and uncheck all check-boxes besides the additional plugins.
- Netperf utility: This utility allows checking the throughput, and can be downloaded from: TBD
- Iperf utility: Tool for network performance measurement. Iperf allows the user to set various parameters that can be used for testing a network. The Iperf tool can be downloaded from <iPerf>.
- WLAN Sniffer utility can be downloaded from <wireshark WLAN Sniffer>.
- Demo version of Omnipeek WLAN Sniffer utility can be downloaded from <OmniPeek WLAN Sniffer - Demo version>.
Following is relevant information of the application usage:
- Serial Port Terminal application (Tera Term): is application that allows configuring the WLAN and the Bluetooth, for instructions refer to <How to use Tera Term>
- For sniffer (Omnipeek Demo application) installation refer to <Omnipeek application>
- For instructions how to use iPerf and Netperf refer to <use iPerf and Netperf for Performance measurement>
Software Upgrade Instructions
In case a software upgrade is required, the SDK package must be downloaded from the link provided below. The link provides the following SDK releases contents:
- Software package
- Release Notes
- SD card images
Note: There is no need to download the images in case of using an Out-of-the-Box SD Card.
If needed, use the following link for Software upgrade: Download page (SW and RN)
Out-of-the box experience
This section details the first steps to achieving connectivity, immediately after acquiring the Evaluation Module (EVM). This includes: opening the EVM box for the first time and verifying its contents, performing board-bringup (hardware assembly and system setup), and getting the board up and running with Bluetooth/WLAN basic scenarios (i.e. basic use-cases).
Board Bringup includes the following steps:
- Verifying the box contents
- Board assembly
- Switches settings
- Connecting the board to a PC (through a serial port)
- Booting the board and getting Linux prompt
Note: The EVM box contains an SD card that is ready-to-use, provided with the up-to-date software for running WLAN and BT demos.
However, whenever software upgrade is required, refer to the SD card section for SD-card preparation instructions.
Basic use-cases details the steps to operating basic WLAN and Bluetooth use-cases. The WLAN section shows how to work in Station mode (where the station connects to a WiFi network) and in Access Point (AP) mode (where the AP generates the WiFi network). The Bluetooth section shows how to work with basic Bluetooth profiles.
The board bringup phase includes: hardware bringup, switches settings and system setup.
- For AM37x Board bringup, refer to: <AM37x - board bringup>
- For AM18x Board bringup, refer to: <AM18x - board bringup>
- For AM335x (SubArctic) Board bringup, refer to: <AM335x (SubArctic) - board bringup>
- Step 1: Calibration (refer to: <Calibration Process>).
- Step 2: Setting unique MAC address (refer to: <MAC Change>).
- Step 3: Connect to non secured AP using WPA supplicant configuration file (refer to: <Connect to non secured AP using WPA Supplicant configuration file>).
- Step 4: Reboot EVM
- Step 5: Connect to AP using the GUI (and verify connection using ping) (refer to: <Connect Station using GUI>).
In that section the EVM will be configured to work as AP mode. were the process is to configure the EVM to work in AP mode and then connect to it with the laptop over WiFi and verify the connection using ping
- Step 1: Reboot the EVM (in case it was used as station before)
- Step 2: Define "no security" mode using hostAPD configuration file (refer to: <Non Secured AP>). perform Steps 1 to 3 inside link.
- Step 3: connect to AP via WLAN using PC (and verify connection using ping) (refer to: <Connect AP via PC>). perform Step 4 inside link.
- Step 4: Exit from AP mode (refer to: <Connect AP via PC>). perform Step 5 inside link.
- Step 5: Activate AP mode using the EVM GUI (refer to <AP Mode Using GUI>).
- Step 6: connect to AP via WLAN using PC (and verify connection using ping) (refer to: <Connect AP via PC>). perform Step 4 inside link.
Advanced Functionality Options
This section details the commands and scripts required for WLAN and Bluetooth various configurations. The following items are handled:
WLAN - Station mode
Three options are available for configuring WLAN in Station mode:
- WPA supplicant commands - allows you to modify the station configuration on the fly, using WPA Supplicant commands (refer to: <WLAN Advance station scripts- use WPA Supplicant commands>)
- WPA supplicant configuration files - allows the station to automatically connect to AP according to the profiles defined in the configuration file (refer to: <WLAN Advance station scripts- use WPA Supplicant configuration file>)
- IW commands - allows you to modify the station configuration on the fly, using IW commands. NOTE: This option supports only non-secured networks and WEP secured networks, without involving the WPA supplicant. Therefore it is used for Debug mode only (refer to: <IW commands description>)
WLAN - AP mode WLAN advanced AP settings - scripts how to configure the AP mode for all security modes (using host APD commands), use the following: <WLAN Advance AP scripts - use HostAPD configuration file>
Bluetooth The Bluetooth section shows how to work with basic Bluetooth profiles, such as: A2DP, FTP, OPP, SPP and HID.
- To establish Bluetooth basic use-cases (with supported profiles):
- For basic HCI commands descriptions, use the following: <NLCP Bluetooth HCI commands>
This section explains how to measure WLAN performance, and includes:
- WLAN Station mode
- Throughput & CPU Utilization results summary
- WLAN AP (Access Point) mode
- Performance measurement setup (with several stations) use the following link < AP Performance Measurement>.
This section details the Suspend/Resume functionality, including:
- AM37x platform:
- How to operate Suspend/Resume mode - use the following < AM37x suspend resume - shut down mode>
- How to measure current consumption in Suspend and in Active modes - use the following < How to measure the WL1271 Current consumption in AM37x board>
- Suspend Resume in WOWLAN (Wake on WLAN packet) mode refer to: <AM37x suspend resume - WOWLAN mode>
Comment: Suspend Resume in WOWLAN is supported in R4 release and up on AM37x platform.
- AM335x platform
- How to operate suspend resume - use the following < AM335x suspend resume>
- AM18x platform:
- How to operate Suspend/Resume mode - use the following < AM18x Suspend Resume>
- The information how to measure the WL1271 current consumption for the AM18x platform will not be covered here since it requires to cut a trace on the WL1271 daughter-card, and that could harm the daughter-card.
This section explains how to overcome some common issues
- AM37x platform Troubleshooting guide use the following < AM37x Troubleshooting guide>
- AM18x platform Troubleshooting guide use the following < AM18x Troubleshooting guide>
- General Troubleshooting guide use the following < General Troubleshooting guide>
For Additional Information...
For more information use the following web pages:
- SDK5.02 WiKi page (Sitara Linux Software Developer’s Guide)
- PSP 04.02.00.07 User Guide
- Booting Linux kernel