
This SDK has been patched by Embedded Artists for the iMXRT1176 Developer's Kit.
The SDK was released on 2022-03-02 and is based on NXP's 2.11.0 SDK (SDK_2_11_0_MIMXRT1176xxxxx.zip).

This is what has been patched:
* LWIP projects - added reading of the MAC address from I2C EEPROM either on the 100Mbit adapter
  or on the uCOM board
* Added an I2C driver for the gpio expander (PCA6416) and code to use it
* Added an I2C driver for the PWM gpio expander (PCA9530) and code to use it
* SDRAM size has been corrected to 32Mb (including linker files, MPU and DCD)
* 1G Ethernet PHY has been changed from RTL8211F to AR8031DS
* SEMC projects - changed to correct settings for the SDRAM
* SEMC projects - changed algorithm for memory test and now test entire 32MB instead of only 4KB
* Examples using eLCDIF/LCDIFv2 have been updated to use PCA6416/PCA9530 for
  RST/PWR/BL signals
* BOARD_USER_BUTTON has been redirected to SW5/WAKEUP button on the uCOM Carrier Board
* USER_LED has been changed to the blue RGB LED using PCA6416
* Touch: I2C bus and GPIOs have been changed for RST/INT
* Camera pins
* Adjusted the USB interface number (it is different for host and device examples)
* Changed the Wi-Fi examples to use the Embedded Artists 1XK M.2 Module (EAR00385) as default
* Corrected the ethernet PHY addresses
* Changed CORE clock depending on speed grading of MCU (798MHz for Industrial, 996MHz for Commercial)
* Changed SEMC clock to be within maximum speed for SDRAM (now 148.5MHz, was 198MHz)
* Many of the projects have been updated to use a more complete pin_mux.c file where all
  necessary pins have been initialized. The SDK examples used to only configure the pins
  that they use (and often not every pin) and most of the time the configuration was only
  for MUX:ing and not the PAD settings (pull up/down/none, drive strength and slew).
* Converted the AzureRTOS examples to use the BOARD_NETWORK_USE_100M_ENET_PORT (same as all
  other networking examples) instead of using the old EXAMPLE_USE_1G_ENET_PORT

This has been added:
* HDMI support to most GUI examples. HDMI at 1024x768@60 is the default resolution but
  that can be changed per project in display_support.h/elcdif_support.h/lcdifv2_support.h.
* Added ADT example for TensorFlow Lite
* I2C probe example
* EDID reader example
* Wi-Fi (serial) examples for the CMWC1ZZABR-107-EVB (a.k.a ABR Module)

This has been removed:
* All projects for the expansion board AGM01

Important things to note:
* Read section "8 - Known Issues" in docs/MCUXpresso SDK Release Notes for MIMXRT1170-EVK.pdf
  to see known issues with the current version of the SDK.
* For Iperf examples, set compiler optimization to -O3 or similar to improve performance.
* If the hardware seems unresponsive and the debugger cannot connect/flash/erase the current program
  then the most likely cause is the running program preventing the access. To stop the currently
  running program and regain control:
  1) Press and hold down the ISP_ENABLE button (SW1)
  2) Press and hold down the RESET button (SW3)
  3) Let go of the RESET button
  4) Wait an extra second or two
  5) Release the ISP_ENABLE button
  6) The hardware is now in a mode where programming/erasing it should work


Connectors:
* J29 (micro USB) is the default UART for the CM7 core and unless specified otherwise it is setup for 115200 8/N/1
* J30 (micro USB) is the default UART for the CM4 core and unless specified otherwise it is setup for 115200 8/N/1
* For 1Gbit Ethernet examples, use connector J25 on uCOM Carrier Board
* For 100Mbit Ethernet examples, use ethernet adapter connected between J12 on uCOM Carrier Board
  and J37 on the adapter. These four connections are also needed:
    1) uCOM Carrier Board, JP38:1 -> adapter JP37:1
    2) uCOM Carrier Board, JP38:2 -> adapter JP37:2
    3) uCOM Carrier Board, JP27:1 -> adapter JP39:2
    4) uCOM Carrier Board, JP27:2 -> adapter JP39:1
* The two CSI examples can use either an OV5640 camera in connector J23 or a camera in connector J24
* The EIQ examples that use a camera expects the camera in connector J24 (J23 might work for some
  of the examples but runs much slower)
* Some GUI examples are configured for the RK055AHD091 display which should be in connector "C" on
  the uCOM Carrier Board. Ignore the readme text about connecting extra 5V power.
* The default for GUI examples is to use an HDMI adapter in connector "C" on
  the uCOM Carrier Board. Ignore the readme text about connecting extra 5V power.


This example has been configured to use the 1XK M.2 module. To change which
module to use, replace WIFI_IW416_BOARD_MURATA_1XK_M2 in the app_config.h file
with one of the following and then rebuild the project:

    WIFI_IW416_BOARD_MURATA_1XK_ONBOARD - To use the 1XK chip on the uCOM board (special mounting option)
    WIFI_IW416_BOARD_MURATA_1XK_M2      - To use the 1XK M.2 module in connector J33
    WIFI_88W8801_BOARD_MURATA_2DS_M2    - To use the 2DS M.2 module in connector J33
    WIFI_88W8987_BOARD_MURATA_1ZM_M2    - To use the 1ZM M.2 module in connector J33

This example has been tested with the M.2 modules above.
More information about the M.2 Modules can be found here: https://www.embeddedartists.com/m2/

It could be possible to use the other modules as shown in the original
readme text below, however that is untested and unsupported.


Everything below this line is the original content of the readme file.
=======================================================================



Overview
========
This is the IPerf example to check your bandwidth using the network performance measurement IPerf application on a PC as a client or a server.
IPv4 is implemented. The UDP implementation is based on lwIP community experimental patches, therefore some issues could be experienced.
UDP sending rate is calculated from the system time, which has a resolution of 1 ms in lwIP. Therefore the actual sending rate could be
a little lower or higher due to sending a calculated (rounded) number of frames each one or more milliseconds. It can also result in higher jitter.
The desired UDP sending rate is determined by the IPERF_UDP_CLIENT_RATE definition. If you want to change the rate without the need to compile
the application with a new value of IPERF_UDP_CLIENT_RATE, you can run the application as a UDP server instead and control the sending rate
by using the tradeoff mode from the PC application and determining the rate there.
For client modes, the address of the remote end where the server PC application is running is determined by the IPERF_SERVER_ADDRESS definition.

Instead of the command line IPerf application, for more convenience, it is recommended to use the JPerf2 graphical tool, which can be downloaded here: https://sourceforge.net/projects/iperf/files/jperf/jperf%202.0.0/jperf-2.0.0.zip/download
The example supports IPerf version 2.0.5. JPerf2, downloaded from the link above, contains version 1.7.0 of iperf.exe for Windows however.
Therefore the iperf.exe version has to be updated when using MS Windows. IPerf 2.0.5b for Windows can be downloaded from the following link:
https://iperf.fr/download/windows/iperf-2.0.5b-win32.zip
The contents of the downloaded archive have to be unpacked into jperf-2.0.0/bin folder, overwriting iperf.exe.

To experiment with the receive throughput, try to increase the value of TCP_WND in the file lwipopts.h and make sure
that the PBUF_POOL_SIZE is larger than (TCP_WND / TCP_MSS). Increase the PBUF_POOL_SIZE if necessary.
For RTOS applications, DEFAULT_THREAD_PRIO and TCPIP_THREAD_PRIO values can have effect on maximum throughput as well.

The demo is able to connect as a WiFi client to your local WiFi network or act as an AP so that it is possible to connect to it with you computer or smartphone.
The connection parameteres are defined by macros EXT_AP_SSID, EXT_AP_PASSPHRASE
Connection from a smartphone with Android OS was tested with 'Magic iPerf' application available in the Play store: https://play.google.com/store/apps/details?id=com.nextdoordeveloper.miperf.miperf

By default the example connects to network SSID "nxp_wifi_demo" with Open Security.

Before building the example application select Wi-Fi module macro in the app_config.h. (see #define WIFI_<SoC Name>_BOARD_<Module Name>).
For more information about Wi-Fi module connection see:
    readme_modules.txt
    Getting started guide on supported modules configuration:
    https://www.nxp.com/document/guide/getting-started-with-nxp-wi-fi-modules-using-i-mx-rt-platform:GS-WIFI-MODULES-IMXRT-PLATFORM



Toolchain supported
===================
- IAR embedded Workbench  9.10.2
- Keil MDK  5.34
- GCC ARM Embedded  10.2.1

Hardware requirements
=====================
- Micro USB cable
- MIMXRT1170-EVK board
- Personal Computer


Board settings
==============

Prepare the Demo
================
1.  Connect a micro USB cable between the PC host and the CMSIS DAP USB port on the board
2.  Open a serial terminal with the following settings:
    - 115200 baud rate
    - 8 data bits
    - No parity
    - One stop bit
    - No flow control
3.  Connect the WiFi module to SD card slot.
4.  Download the program to the target board.
5.  Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.


Running the demo
================
1. Adjust the IPERF_SERVER_ADDRESS definition to the IP address where the JPerf PC application will be accessible and rebuild it.
2. When the demo starts, a welcome message and a menu would appear on the terminal:

    wifi iperf demo
    Initialize WLAN Driver
    MAC Address: C0:E4:34:5A:98:E9
    For Soft AP demonstration
    Start a Soft AP using option "A" in WPA2 security mode from menu
    This also starts DHCP Server with IP 192.168.10.1, NETMASK 255.255.255.0
    For Station demonstration
    Start an External AP with SSID as "nxp_wifi_demo" in Open mode
    Start DHCP Server on External AP
    Station network is configured with Dynamic address assignment
    Application provides IPerf support
    Set IPERF_SERVER_ADDRESS while using as IPerf Client
      A  Start Soft AP
      S  Stop Soft AP
      s  Start Scan for external APs
      c  Connect to External AP (SSID='nxp_wifi_demo')
      D  Disconnect from External AP
      I  Enable IEEE PS on Station
      i  Disable IEEE PS on Station
      d  Enable Deep sleep on Station
      e  Disable Deep sleep on Station
      p  Print All Network info
      P  Print DHCP Server info
      1  TCP server mode (RX only test)
      2  TCP client mode (TX only test)
      3  TCP client dual mode (TX and RX in parallel)
      4  TCP client tradeoff mode (TX and RX sequentially)
      5  UDP server mode (RX only test)
      6  UDP client mode (TX only test)
      7  UDP client dual mode (TX and RX in parallel)
      8  UDP client tradeoff mode (TX and RX sequentially)
      h  Help (print this menu)
      H  Print extended help
    [net] Initialized TCP/IP networking stack
    WLAN Driver Version   : v1.3.r21.p1
    WLAN Firmware Version : w8977o-V2, RF87XX, FP91, 16.91.10.p89, WPA2_CVE_FIX 1, PVE_FIX 1

3. Select the desired mode of operation for WiFi, A - Start Soft AP, c - Connect to External AP (SSID='nxp_mrvl')
4. Start the JPerf application, using the jperf-2.0.0/jperf.bat batch file.
    It can be downloaded here: https://sourceforge.net/projects/iperf/files/jperf/jperf%202.0.0/jperf-2.0.0.zip/download.
    When using Windows, replace the content of the jperf-2.0.0/bin folder with the files from the following zip: https://iperf.fr/download/windows/iperf-2.0.5b-win32.zip.
    When using Linux, iperf binary version 2.0.5 must be installed separately (possibly using package manager) and present on the     system path.
5. To run lwIP IPERF in client mode, select "Server" radio button in JPerf and press the [Run iperf!] button.
6. To run lwIP IPERF in server mode, select "Client radio button and enter the IP address assigned to the board by DHCP
   as IPv4 address to the "server address" parameter in JPerf.
7. Enter the desired mode number into the terminal.
8. If server mode has been selected in the terminal (and client mode in JPerf), press the [Run iperf!] button now.
9. When the test is finished, the output log of JPerf would be seen like below,
	 where occurrences of the symbol "N" would be replaced by actual measured values.
   The log will vary depending on the selected mode:
	 bin/iperf.exe -s -P 0 -i 1 -p 5001 -f k
        ------------------------------------------------------------
        Server listening on TCP port 5001
        TCP window size: 85.3 KByte (default)
        ------------------------------------------------------------
        [  4] local 192.168.2.101 port 5001 connected with 192.168.2.100 port 49153
        [ ID] Interval       Transfer     Bandwidth
        [  4]  0.0- 1.0 sec   N   KBytes  N    Kbits/sec
        [  4]  1.0- 2.0 sec   N   KBytes  N    Kbits/sec
        [  4]  2.0- 3.0 sec   N   KBytes  N    Kbits/sec
        [  4]  3.0- 4.0 sec   N   KBytes  N    Kbits/sec
        [  4]  4.0- 5.0 sec   N   KBytes  N    Kbits/sec
        [  4]  5.0- 6.0 sec   N   KBytes  N    Kbits/sec
        [  4]  6.0- 7.0 sec   N   KBytes  N    Kbits/sec
        [  4]  7.0- 8.0 sec   N   KBytes  N    Kbits/sec
        [  4]  8.0- 9.0 sec   N   KBytes  N    Kbits/sec
        [  4]  9.0-10.0 sec   N   KBytes  N    Kbits/sec
        [  4]  0.0-10.0 sec   N   KBytes  N    Kbits/sec
        ------------------------------------------------------------
        Client connecting to 192.168.2.100, TCP port 5001
        TCP window size: 85.0 KByte (default)
        ------------------------------------------------------------
        [  4] local 192.168.2.101 port 40954 connected with 192.168.2.100 port 5001
        [  4]  0.0- 1.0 sec   N   KBytes  N    Kbits/sec
        [  4]  1.0- 2.0 sec   N   KBytes  N    Kbits/sec
        [  4]  2.0- 3.0 sec   N   KBytes  N    Kbits/sec
        [  4]  3.0- 4.0 sec   N   KBytes  N    Kbits/sec
        [  4]  4.0- 5.0 sec   N   KBytes  N    Kbits/sec
        [  4]  5.0- 6.0 sec   N   KBytes  N    Kbits/sec
        [  4]  6.0- 7.0 sec   N   KBytes  N    Kbits/sec
        [  4]  7.0- 8.0 sec   N   KBytes  N    Kbits/sec
        [  4]  8.0- 9.0 sec   N   KBytes  N    Kbits/sec
        [  4]  9.0-10.0 sec   N   KBytes  N    Kbits/sec
        [  4]  0.0-10.8 sec   N   KBytes  N    Kbits/sec

10. Also, when the test is finished, the log would be seen on the terminal like below,
	where occurrences of the symbol "N" would be replaced by actual measured values.
    The log will vary depending on the selected mode:
        Enter mode number: 4
        Minimum ever free heap size: 51152
        -------------------------------------------------
         TCP_DONE_CLIENT (TX)
         Local address : 192.168.2.100  Port 49153
         Remote address : 192.168.2.101  Port 5001
         Bytes Transferred N
         Duration (ms) N
         Bandwidth (kbitpsec) N
        -------------------------------------------------
         TCP_DONE_SERVER (RX)
         Local address : 192.168.2.100  Port 5001
         Remote address : 192.168.2.101  Port 40954
         Bytes Transferred N
         Duration (ms) N
         Bandwidth (kbitpsec) N

11. It is also possible to press the SPACE key when the test is running or finished.
    If it is pressed when test is in progress, the running test will be aborted
    and the main menu will appear. If the test is already finished, the main menu
    will appear directly. From the main menu, new test can be run.
