NXP 88W8997 User guide

  • Hello! I am an AI chatbot trained to assist you with the NXP 88W8997 User guide. I’ve already reviewed the document and can help you find the information you need or explain it in simple terms. Just ask your questions, and providing more details will help me assist you more effectively!
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX
8M Quad EVK Running Linux OS
Rev. 1 — 22 February 2021 User manual
Document information
Information Content
Keywords Wi-Fi Alliance (WFA), certification, 88W8997, i.MX 8M Quad EVK
Abstract Provides the step-by-step procedure of WFA certification for 88W8997-based
wireless modules on i.MX 8M Quad EVK running Linux OS.
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
Rev Date Description
v.1 20210222 Initial version
Revision history
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
2 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
1 About this document
1.1 Purpose and scope
This document describes the test setup and procedure used for WFA certification of Wi-
Fi features like 802.11ac, 802.11n, protected management frames (PMF), WPA3, and
security vulnerability detection of 88W8997 wireless SoC. This document applies to
88W8997-based wireless module connected to i.MX 8M Quad EVK running Linux OS,
and configured as a station (STA). The instructions apply to other similar platforms and
wireless SoC.
The users should be familiar with the user manuals reference UM11490 and UM11483.
1.2 References
Document type Document title
User manual
NXP - UM11483 - Getting Started with NXP-based Wireless Modules
on i.MX 8M Quad EVK Running Linux OS (link)
User manual
NXP - UM11490 - Feature Configuration Guide for NXP-based Wireless
Modules on i.MX 8M Quad EVK (link)
User manual NXP - MCIMX8M-EVK -Quick Start Guide i.MX 8M Quad Evaluation Kit
(link)
Table 1. Reference documents
1.3 Considerations
The readers should have some knowledge of Wi-Fi terminologies and certification.
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
3 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
2 Test setup
Figure 1 illustrates the test setup.
Figure 1. Test setup
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
4 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
3 WFA certification test procedure
This section shows the sequence of operations to run in order to test the Wi-Fi features.
3.1 Set up the serial console
Set up the test. See Section 2 "Test setup".
Follow these steps to setup the serial console and access the i.MX 8M Quad device
terminal:
Open the serial console and login into the device
ubuntu@ubuntu-desktop:/# sudo minicom -s -D /dev/ttyUSBx
ttyUSB0 or ttyUSB01 are the serial devices. The minicom setup configuration is given
below:
A - Serial Device : /dev/ttyUSBx
E - Bps/Par/Bits : 115200 8N1
F - Hardware Flow Control : No
G - Software Flow Control : No
Save and exit.
3.2 Copy the required files
Connect the device to the control network
Give the control network IP to the wired interface
Use SCP to copy NXP_WTS_AGENT_U16_bin repository to i.MX 8M Quad EVK
board.
The command on Linux host is as follows:
# scp -r <absolute_path>/NXP_WTS_AGENT_U16_bin [email protected]:/home/
root/
Where 192.168.X.X is the board IP which you set in the previous step.
Set the permission to the files within NXP_WTS_AGENT_U16_bin repository copied to
i.MX 8M Quad EVK board using the command:
chmod 777 * -Rf
Copy the driver file set [bin_wlan/*] to NXP_WTS_AGENT_U16_bin repository
Copy the firmware file set [FW_Image/*] to /lib/firmware/nxp/ repository of i.MX 8M
Quad EVK board
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
5 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
3.3 Load the driver
Use the cd command to go to NXP_WTS_AGENT_U16_bin repository where the driver
files are located on i.MX board.
Note: By default the turbo mode is enabled in the firmware. Four WTS programs: VHT-
STAUT, VHT-APUT-HOSTAPD, 11N-STAUT, and 11N-APUT-HOSTAPD, require turbo
mode to be disabled. See Section 3.3.1 "Disable Turbo mode".
Run the shell script load.sh script to install the driver located in
NXP_WTS_AGENT_U16_bin repository.
./load.sh
Note: The shell script changes with the feature being tested. Refer to the program
specific data for the script to use.
Check the version of the build with the following command:
./mlanutl mlan0 version
3.3.1 Disable Turbo mode
Convert the Turbo mode configuration file turbo_mode.conf to a binary format (.bin) so
the wireless driver can use it.
Configuration file:
#File : turbo_mode.conf
## WMM turbo mode config command
turbo_mode_set={
CmdCode=0x0016 # do NOT change this line
Action:2=0 # 1 - SET
OID:2=0x27 # OID_WMM_TURBO_MODE
Size:2=128
Value:128=5 # 1 -- Enable turbo_mode_1; 2 -- Enable
turbo_mode_2; otherwise, disable turbo_mode
}
The following command uses mlanutl utility to convert the configuration file to a binary
format. mlanutl utility is stored at the following location: /usr/share/nxp_wireless/
bin_mxm_wifiex/
./mlanutl <wireless interface> hostcmd <conf_file_name> generate_raw
<bin_file_name>
For Turbo mode:
root@imx8mnevk:~# ./mlanutl mlan0 hostcmd config/turbo_mode.conf
generate_raw turbo_mode.bin
Copy the newly generated binary file turbo_mode.bin into the wireless firmware
directory. For Linux operating systems, the directory is: /lib/firmware/nxp
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
6 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
Change the driver load parameters:
Go to NXP_WTS_AGENT_U16_bin repository where the load.sh script file is stored
Use the insmod command to update the load.sh script file
Add the driver load parameter init_hostcmd_cfg=nxp/turbo_mode.bin to
load.sh script
Note: Make sure to remove the driver load parameter init_hostcmd_cfg=nxp/
turbo_mode.bin from the load.sh script for the other WTS programs than VHT-STAUT,
VHT-APUT-HOSTAPD, 11N-STAUT, and 11N-APUT-HOSTAPD.
3.4 Start Sigma
Sigma automation test suite formerly named Wi-Fi Test Suite (WTS) is an automation
frame work provided by Wi-Fi Alliance. All the test bed devices including Access Points,
test bed STAs, Sniffers and Traffic generator are controlled through the Unified CAPI
(Control API) Console (UCC). The CA and DUT control agents (wfa_ca and wfa_dut) are
components of the automation test suite.
3.4.1 Start Sigma for the DUT agent (wfa_dut)
Open an ssh terminal to access the i.MX 8M Quad EVK board
Go to NXP_WTS_AGENT_U16_bin repository where you have copied wfa_dut and
wfa_ca agents earlier
Run the command to start wfa_dut DUT agent:
Syntax: ./wfa_dut <interface> <dut_port> <program_index>
Where:
Command parameter Description
interface Interface name
dut_port Port number for the DUT
program_index Program index value. See Table 2.
Example
./wfa_dut lo 8000 2 // starts VHT-STAUT program for DUT port number 8000 and
lo interface
Command to get the DUT agent version:
wfa_dut -v (version)
Table 2 lists the program index values.
Program index WTS program
1 HE-STAUT
2 VHT-STAUT
3 VHT-STAUT-MWIFIEX
4 VHT-APUT-UAPUTL
5 VHT-APUT-HOSTAPD
6 TDLS
Table 2. WTS program index values
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
7 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
Program index WTS program
7 WMM-PS-STAUT
8 P2P-MWU
9 P2P-WS
10 PMF-STAUT
11 PMF-STAUT-MWIFIEX
12 PMF-APUT-UAPUTL
13 PMF-APUT-HOSTAPD
14 11N-STAUT
15 11N-STAUT-MWIFIEX
16 11N-APUT-UAPUTL
17 11N-APUT-HOSTAPD
18 HS2-R1
19 HS2-R2
20 V-E-STAUT
21 WPA3-STAUT
22 WPA3-APUT-HOSTAPD
Table 2. WTS program index values...continued
3.4.2 Start Sigma for the CA control agent (wfa_ca)
Open another ssh terminal
Go to NXP_WTS_AGENT_U16_bin repository where you have copied wfa_ca
component files earlier
Run the command to start wfa_ca CA agent:
Syntax: ./wfa_ca.sh <control interface>
Where:
Command parameter Description
control interface Network control interface name
Example
./ca.sh eth0 // starts the control agent for eth0
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
8 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
4 Certification program execution
This section shows how to execute the certification programs for the set of Wi-Fi
features.
4.1 11AC certification program
11AC certification program is used to test the compliance of 802.11ac Wi-Fi feature.
Use the cd command to go to NXP_WTS_AGENT_U16_bin repository where the
driver files are located. See Section 3.2 "Copy the required files".
Run the shell script ./load_11AC.sh to load the driver
./load_11AC.sh
Start Sigma for the DUT agent
./wfa_dut lo 8000 2
Start Sigma for the CA agent
./ca.sh eth0
4.2 11N certification program
11N certification program is used to test the compliance of 802.11n Wi-Fi feature
Use the cd command to go to NXP_WTS_AGENT_U16_bin repository where the
driver files are located. See Section 3.2 "Copy the required files".
Run the shell script ./load_11N.sh to load the driver
./load_11N.sh
Start Sigma for the DUT agent
./wfa_dut lo 8000 14
Start Sigma for the CA agent
./ca.sh eth0
Note: The following commands need to be executed manually before running the test
cases N-5.2.2 and N-5.2.48.
For N-5.2.2, execute the following command on STAUT after AP configuration
iwconfig mlan0 power on
For N-5.2.48, execute the following command on the device under test (DUT) during
configuration
./mlanutl mlan0 bandcfg 31
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
9 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
4.3 WPA3 certification program
WPA3 pre-cert program is used to test the compliance of WPA3 Wi-Fi feature
Use the cd command to go to NXP_WTS_AGENT_U16_bin repository where the
driver files are located. See Section 3.2 "Copy the required files".
Run the shell script ./load.sh to load the driver
./load.sh
Start Sigma for the DUT agent
./wfa_dut lo 8000 21
Start Sigma for the CA agent
./ca.sh eth0
4.4 PMF certification program
PMF certification program is used to test the compliance of PMF Wi-Fi feature
Use the cd command to go to NXP_WTS_AGENT_U16_bin repository where the
driver files are located. See Section 3.2 "Copy the required files".
Run the shell script ./load.sh to load the driver
./load.sh
Start Sigma for the DUT agent
./wfa_dut lo 8000 10
Start Sigma for the CA agent
./ca.sh eth0
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
10 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
4.5 SVD (VU) certification program
SVD (VU) certification program is used to test the compliance of security vulnerability
detection Wi-Fi feature
Use the cd command to go to NXP_WTS_AGENT_U16_bin repository where the
driver files are located. See Section 3.2 "Copy the required files".
Run the shell script ./load.sh to load the driver
./load.sh
SVD (VU) certification program requires a manual configuration with wpa_supplicant
open source program:
Run wpa_supplicant on the DUT:
./wpa_supplicant -Dnl80211 -i mlan0 -c wpa_supplicant.conf
Upon confirmation of the association, run a DHCLIENT command on the DUT
udhcpc -i mlan0
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
11 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
5 Acronyms and abbreviations
Acronym Description
AP Access point
CA Control agent
CAPI Control API
DHCP Dynamic host configuration procedure
DUT Device under test
PMF Protected management frames
SAE Simultaneous authentication of equals
STA Station
STAUT Station under test
SVD Security vulnerability detection
UCC Unified control API (CAPI) console
WFA Wi-Fi Alliance
WTS Wi-Fi Test Suite
Table 3. Abbreviations
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
12 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
6 Contact information
Use the following links for more product details, queries and support.
Home page: www.nxp.com
Web support: nxp.com/support
NXP community: community.nxp.com
iMX community: community.nxp.com/community/imx
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
13 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
7 Legal information
7.1 Definitions
Draft — A draft status on a document indicates that the content is still
under internal review and subject to formal approval, which may result
in modifications or additions. NXP Semiconductors does not give any
representations or warranties as to the accuracy or completeness of
information included in a draft version of a document and shall have no
liability for the consequences of use of such information.
7.2 Disclaimers
Limited warranty and liability — Information in this document is believed
to be accurate and reliable. However, NXP Semiconductors does not
give any representations or warranties, expressed or implied, as to the
accuracy or completeness of such information and shall have no liability
for the consequences of use of such information. NXP Semiconductors
takes no responsibility for the content in this document if provided by an
information source outside of NXP Semiconductors. In no event shall NXP
Semiconductors be liable for any indirect, incidental, punitive, special or
consequential damages (including - without limitation - lost profits, lost
savings, business interruption, costs related to the removal or replacement
of any products or rework charges) whether or not such damages are based
on tort (including negligence), warranty, breach of contract or any other
legal theory. Notwithstanding any damages that customer might incur for
any reason whatsoever, NXP Semiconductors’ aggregate and cumulative
liability towards customer for the products described herein shall be limited
in accordance with the Terms and conditions of commercial sale of NXP
Semiconductors.
Right to make changes — NXP Semiconductors reserves the right to
make changes to information published in this document, including without
limitation specifications and product descriptions, at any time and without
notice. This document supersedes and replaces all information supplied prior
to the publication hereof.
Suitability for use — NXP Semiconductors products are not designed,
authorized or warranted to be suitable for use in life support, life-critical or
safety-critical systems or equipment, nor in applications where failure or
malfunction of an NXP Semiconductors product can reasonably be expected
to result in personal injury, death or severe property or environmental
damage. NXP Semiconductors and its suppliers accept no liability for
inclusion and/or use of NXP Semiconductors products in such equipment or
applications and therefore such inclusion and/or use is at the customer’s own
risk.
Applications — Applications that are described herein for any of these
products are for illustrative purposes only. NXP Semiconductors makes
no representation or warranty that such applications will be suitable
for the specified use without further testing or modification. Customers
are responsible for the design and operation of their applications and
products using NXP Semiconductors products, and NXP Semiconductors
accepts no liability for any assistance with applications or customer product
design. It is customer’s sole responsibility to determine whether the NXP
Semiconductors product is suitable and fit for the customer’s applications
and products planned, as well as for the planned application and use of
customer’s third party customer(s). Customers should provide appropriate
design and operating safeguards to minimize the risks associated with
their applications and products. NXP Semiconductors does not accept any
liability related to any default, damage, costs or problem which is based
on any weakness or default in the customer’s applications or products, or
the application or use by customer’s third party customer(s). Customer is
responsible for doing all necessary testing for the customer’s applications
and products using NXP Semiconductors products in order to avoid a
default of the applications and the products or of the application or use by
customer’s third party customer(s). NXP does not accept any liability in this
respect.
Export control — This document as well as the item(s) described herein
may be subject to export control regulations. Export might require a prior
authorization from competent authorities.
Evaluation products — This product is provided on an “as is” and “with all
faults” basis for evaluation purposes only. NXP Semiconductors, its affiliates
and their suppliers expressly disclaim all warranties, whether express,
implied or statutory, including but not limited to the implied warranties of
non-infringement, merchantability and fitness for a particular purpose. The
entire risk as to the quality, or arising out of the use or performance, of this
product remains with customer. In no event shall NXP Semiconductors, its
affiliates or their suppliers be liable to customer for any special, indirect,
consequential, punitive or incidental damages (including without limitation
damages for loss of business, business interruption, loss of use, loss of
data or information, and the like) arising out the use of or inability to use
the product, whether or not based on tort (including negligence), strict
liability, breach of contract, breach of warranty or any other theory, even if
advised of the possibility of such damages. Notwithstanding any damages
that customer might incur for any reason whatsoever (including without
limitation, all damages referenced above and all direct or general damages),
the entire liability of NXP Semiconductors, its affiliates and their suppliers
and customer’s exclusive remedy for all of the foregoing shall be limited to
actual damages incurred by customer based on reasonable reliance up to
the greater of the amount actually paid by customer for the product or five
dollars (US$5.00). The foregoing limitations, exclusions and disclaimers shall
apply to the maximum extent permitted by applicable law, even if any remedy
fails of its essential purpose.
Translations — A non-English (translated) version of a document is for
reference only. The English version shall prevail in case of any discrepancy
between the translated and English versions.
Security — Customer understands that all NXP products may be subject
to unidentified or documented vulnerabilities. Customer is responsible
for the design and operation of its applications and products throughout
their lifecycles to reduce the effect of these vulnerabilities on customer’s
applications and products. Customer’s responsibility also extends to other
open and/or proprietary technologies supported by NXP products for use
in customer’s applications. NXP accepts no liability for any vulnerability.
Customer should regularly check security updates from NXP and follow up
appropriately. Customer shall select products with security features that best
meet rules, regulations, and standards of the intended application and make
the ultimate design decisions regarding its products and is solely responsible
for compliance with all legal, regulatory, and security related requirements
concerning its products, regardless of any information or support that may
be provided by NXP. NXP has a Product Security Incident Response Team
(PSIRT) (reachable at PSIR[email protected]) that manages the investigation,
reporting, and solution release to security vulnerabilities of NXP products.
7.3 Trademarks
Notice: All referenced brands, product names, service names and
trademarks are the property of their respective owners.
NXP — wordmark and logo are trademarks of NXP B.V.
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
14 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
Tables
Tab. 1. Reference documents ....................................... 3
Tab. 2. WTS program index values ...............................7
Tab. 3. Abbreviations ...................................................12
Figures
Fig. 1. Test setup ..........................................................4
UM11560 All information provided in this document is subject to legal disclaimers. © NXP B.V. 2021. All rights reserved.
User manual Rev. 1 — 22 February 2021
15 / 16
NXP Semiconductors
UM11560
WFA Certification for NXP-based Wireless Modules on i.MX 8M Quad EVK Running Linux OS
Contents
1 About this document .......................................... 3
1.1 Purpose and scope ........................................... 3
1.2 References .........................................................3
1.3 Considerations ................................................... 3
2 Test setup ............................................................ 4
3 WFA certification test procedure .......................5
3.1 Set up the serial console ...................................5
3.2 Copy the required files ...................................... 5
3.3 Load the driver .................................................. 6
3.3.1 Disable Turbo mode .......................................... 6
3.4 Start Sigma ........................................................7
3.4.1 Start Sigma for the DUT agent (wfa_dut) ...........7
3.4.2 Start Sigma for the CA control agent (wfa_
ca) ......................................................................8
4 Certification program execution ........................9
4.1 11AC certification program ................................ 9
4.2 11N certification program ...................................9
4.3 WPA3 certification program ............................. 10
4.4 PMF certification program ............................... 10
4.5 SVD (VU) certification program ....................... 11
5 Acronyms and abbreviations ...........................12
6 Contact information .......................................... 13
7 Legal information .............................................. 14
Please be aware that important notices concerning this document and the product(s)
described herein, have been included in section 'Legal information'.
© NXP B.V. 2021. All rights reserved.
For more information, please visit: http://www.nxp.com
For sales office addresses, please send an email to: [email protected]
Date of release: 22 February 2021
/