Initial repo creation

Author: domgifford-mchp

CHANGELOG.md

@@ -0,0 +1,96 @@
+# Changelog
+
+This file documents all notable changes to **WINCS02** and **RNWF02** firmware.
+
+## [v3.2.0] — March 2026
+
+> **Note:** Firmware binary filenames changed in this release.
+> `*.bootable.bin` → `*_wholeflash.bin` and `*_dfu.bootable.bin` → `*_dfu_high.bin`.
+> See the release notes for your version for the correct filenames.
+
+### New Features
+- WPA Enterprise support (EAP-TLS, EAP-TTLS, EAP-PEAP)
+- HTTP Client API
+- Platform Power Save (PPS) with EXtreme Deep Sleep (XDS) mode
+- TLS session caching and certificate pinning
+- Boot-time configuration of system variables
+- **RNWF02 only:** Persistent baud rate configuration
+
+### Enhancements
+- DNS client: MDNS, TCP and TLS support; additional record types (CNAME, SOA, PTR, TXT, DS, NSEC, DNSKEY); fallback DNS
+- Additional TLS contexts for WPA-Enterprise, DNS over TLS, MQTT, and TLS sockets
+- TCP socket hand-off to protocol handlers (e.g. HTTP client)
+- Optimised memory use for Block-Ack handles and improved buffer handling under load
+- Ability to reset configuration commands to default values
+- **RNWF02 only:** Serial interface format control
+- Improved scan filter documentation and file handling
+- OTA: increased maximum URL length to 1024 characters
+
+### Fixes
+- WLAN and Hotspot stability: fixed several crashes in Hotspot mode, Block-Ack session handling, DHCP server locking, and Wi-Fi QoS parameter processing
+- TCP/IP and socket handling: improved TCP window management and corrected socket read/write behaviour for UDP and TCP
+- TLS and security: fixed random number generator reseeding after prolonged operation and improved TLS alert handling
+- MQTT connectivity: fixed connection and initialisation issues, including dual-stack broker resolution and QoS message acknowledgement
+- IPv6: fixed crash when sending IPv6 ping using hostname
+- **WINCS02 only:** Berkeley sockets: fixed poll skipping of invalid file descriptors, dual-stack listening socket matching, setsockopt validation on pending sockets, connect rejection after failure, getaddrinfo result population, and dual-stack TCP server socket port conflicts
+- General: various fixes for file system handle management, NVM data handling, and command parameter validation
+
+## [v3.1.0] — September 2025
+
+### New Features
+- Anti-rollback counter API (query and increment)
+- DFU image modification API (secure DFU support)
+- Arbitrary flash file read/write API
+
+### Enhancements
+- Upgraded TLS stack to WolfSSL v5.7.4 from v4.7.0
+- TX A-MPDU performance improvements (buffer handling, ack handling, TX/RX decoupling)
+- Removed expired Baltimore CyberTrust Root certificate from release package
+- Strengthened cryptographic elements used in WPA2/WPA3 (NIST-standard RNG)
+- Refined CCA levels for adaptivity test compliance
+- Improved TLS error reporting and detection of incorrect TLS configurations
+- Removed limit on connections per server socket (up to 10 total TCP connections)
+- Increased Hotspot mode STA connections from 8 to 10
+- Prevented flash partition modification when current partition image is invalidated
+
+### Security Fixes
+- Fixed CVE-2009-3555 (TLS renegotiation)
+- Fixed CVE-2017-13079 and CVE-2017-13081 (Wi-Fi IGTK reinstallation)
+
+### Fixes
+- Block-Ack stability: fixed TX stalls, lost frames, stuck recovery, and memory leaks when Block-Ack is active
+- AP/Hotspot: fixed de-authentication crashes and fragmented frame MIC check failures in AP mode
+- TLS: fixed watchdog when exceeding connection limit and improved interoperability with renegotiation
+- MQTT: fixed subscription read flushing all messages and corrected debug output for protected management frames
+- TCP: fixed fast re-transmit detection being reset by data packets between duplicate ACKs
+- General: fixed MAC event manager stalls, A-MPDU crash on de-auth, and AP cipher detection
+
+### Certification
+- WFA Flextrack and Quicktrack STA mode certification (Quicktrack v2.2)
+
+## [v3.0.0] — October 2024
+
+### New Features
+- Layer 2 bypass mode (send/receive raw packets with unicast/broadcast/multicast filtering)
+- TLS v1.2 Server mode
+- Over-the-Air (OTA) firmware upgrade via internal HTTP/HTTPS and host-controlled flash writing
+- Persistent configuration storage and retrieval (RAM and flash)
+- TX A-MPDU support in STA mode
+- Roaming enable/disable control
+
+### Enhancements
+- Enhanced system throughput across multiple layers
+- DNS client support for IPv6 servers and AAAA record filtering
+- MQTT: topic aliases, IPv6 server hostname resolution, clear all TX properties
+- Socket: asynchronous receive modes, TOS on unconnected UDP
+- TLS: certificate chain support (2+ certificates during handshake)
+- SNTP configuration changeable while connected
+- Integer representation expanded to binary and octal formats
+
+### Fixes
+- Wi-Fi stability: fixed idle disconnections, WMM crashes, powersave QoS handling, and coexistence failures
+- SoftAP: fixed HT/WMM IE extraction and multi-cycle disconnect/connect/reset reliability
+- TCP/IP: fixed IPv6 socket crashes, enabled fast retransmission, and corrected broadcast QoS framing
+- MQTT: fixed IPv6 connection failures, publish after ping, and property formatting
+- TLS: enabled SHA224 for handshakes and fixed crash on excessively long commands
+- Roaming: fixed disconnect/auth-fail state sync and probe request channel correctness

ERRATA.md

@@ -0,0 +1,16 @@
+# Current Errata for WINCS02 and RNWF02 Firmware
+
+This file has information about known issues in the latest released **WINCS02** and **RNWF02** firmware.
+
+## Latest Firmware
+
+The latest released **WINCS02** and **RNWF02** firmware is [v3.2.0].
+
+## Errata
+
+These are the known issues in the latest released **WINCS02** and **RNWF02** firmware.
+
+| Area | Description | ID | Recovery Method | Prevention Measure | Resulting impact |
+|---|---|---|---|---|---|
+| AP/Hotspot | The device deauthenticates a reconnecting STA if Management Frame Protection (MFP) is used | 1889 | Prompt the STA to retry the connection | None | With MFP enabled, some STAs may need two attempts to reconnect |
+| TCP/IP | IPv6 multicast in received AMSDU can cause MAC Rx stall | 768 | None (no lasting effect) | None | Occasional reduction in Rx throughput |

LICENSE.md

@@ -0,0 +1,111 @@
+ V2.001 - 20230126
+
+**THE MICROCHIP SOFTWARE AND DOCUMENTATION PROVIDED HEREUNDER
+IS OFFERED SOLELY TO ASSIST YOU IN DEVELOPING PRODUCTS AND SYSTEMS THAT USE AND
+INCORPORATE MICROCHIP PRODUCTS. INSTALLING, COPYING, DOWNLOADING AND/OR USING
+THE SOFTWARE AND DOCUMENTATION REQUIRES THAT YOU ACCEPT THIS SOFTWARE LICENSE
+AGREEMENT.  IF YOU DO NOT WISH TO ACCEPT THESE TERMS, DO NOT, INSTALL, COPY,
+DOWNLOAD OR USE ANY OF THE SOFTWARE OR DOCUMENTATION. INSTALLING, COPYING, DOWNLOADING
+OR USING THE SOFTWARE AND DOCUMENTATION CONSTITUTES YOUR ACCEPTANCE OF THIS
+SOFTWARE LICENSE AGREEMENT.**
+
+Under Microchip Technology Incorporated's
+("Microchip") intellectual property rights and subject to applicable licensing terms for
+any third-party software incorporated in this software and any applicable Open
+Source Software (as defined here below), the redistribution, reproduction and use
+in source and binary forms of the software or any part thereof, with or without
+modification, are permitted provided that the following conditions are met:
+
+© [**2026**], Microchip Technology Inc., and its subsidiaries. All rights
+reserved.
+
+1. Redistribution of source code (modified or unmodified) must retain the
+copyright notice accompanying the software and documentation, this list of
+conditions and the disclaimer in capital type at the end of this software license
+agreement.
+
+2. Redistributions in binary form, except as embedded into a device
+manufactured by or for Microchip or a software update for any such Microchip
+device, must reproduce the accompanying copyright notice, this list of conditions
+and the below disclaimer in capital type, in the documentation and/or other
+materials provided with the distribution.
+
+3. Neither the name of Microchip nor
+the names of other contributors to this software and documentation may be used
+to endorse or promote products derived from this software, documentation or part
+thereof without specific written permission of Microchip.
+
+4. The software
+and documentation or any part thereof, including modifications and/or derivative
+works of this software and documentation, must be used and execute solely and
+exclusively on or in combination with a device manufactured by or for Microchip.
+
+5. No use, reproduction or redistribution of this software or documentation
+partially or totally may be done in any manner that would subject the software
+to any Open Source Software license terms (as defined below).
+
+6. The
+software may also include third-party software as expressly specified in the software
+or documentation subject to specific license terms from such third parties. Such
+third-party software is supplied under such specific license terms and is not
+subject to the terms and conditions of this software license agreement. By
+installing copying, downloading, accessing or otherwise using this software, you agree
+to be bound by such third-party license terms with regard to such third-party
+software.
+
+7. Some portion of the software may contain software subject to
+Open Source Software license terms applicable for each such portion of Open Source
+Software, as further specified in the software documentation. Such Open Source
+Software is supplied under the applicable Open Source Software license terms and
+is not subject to the terms and conditions of this software license agreement.
+"Open Source Software" shall mean any open source software licensed under terms
+that requires as part of distribution of such software that the source code of
+such software is distributed therewith or otherwise made available, or such
+license terms that substantially complies with the Open Source definition specified at
+www.opensource.org and any other comparable open source license such as for
+example GNU General Public License (GPL), Eclipse Public License (EPL), Apache
+Software License, BSD license and MIT license.
+
+8. The software and
+documentation is and will remain the exclusive property of Microchip and its licensors. You
+will not take any action that jeopardizes Microchip's and its licensors'
+proprietary rights or acquire any rights in the software and documentation, except the
+limited rights specified hereunder.
+
+9. Microchip has no obligation to
+provide any maintenance, support or updates for the software.
+
+10. You shall
+comply with all applicable laws and regulations affecting the use of the software
+and documentation or any part thereof including any applicable export control law
+or regulation.
+
+11. Redistribution and use of the software and documentation
+partially or any part thereof other than as permitted under this software
+license agreement is void and will automatically terminate your rights under this
+software license agreement.
+
+DISCLAIMER:
+
+© [**2026**], Microchip Technology Inc.,
+and its subsidiaries. All rights reserved.
+
+The software and documentation is
+provided by Microchip and its contributors "as is" and any express, implied or
+statutory warranties, including, but not limited to, the implied warranties of
+merchantability, fitness for a particular purpose and non-infringement of third
+party intellectual property rights are disclaimed to the fullest extent permitted by
+law. In no event shall Microchip or its contributors be liable for any direct,
+indirect, incidental, special, exemplary, or consequential damages (including,
+but not limited to, procurement of substitute goods or services; loss of use,
+data, or profits; or business interruption) however caused and on any theory of
+liability, whether in contract, strict liability, or tort (including negligence or
+otherwise) arising in any way out of the use of the software and documentation,
+even if advised of the possibility of such damage.
+
+Except as expressly permitted
+hereunder and subject to the applicable license terms for any third-party
+software incorporated in the software and any applicable open source software license
+terms, no license or other rights, whether express or implied, are granted
+under any patent or other intellectual property rights of Microchip or any third
+party.

README.md

@@ -0,0 +1,69 @@
+# WINCS02 & RNWF02 — Firmware, Drivers & Tools
+
+Microchip **WINCS02** and **RNWF02** are Wi-Fi network controller devices available via [microchip.com](https://www.microchip.com).
+
+This repository is the central hub for the latest firmware and programming resources:
+
+- [**Firmware Release Packages**](../../releases) — GitHub releases containing firmware binaries and release notes
+- [**Tools**](./tools/) — Tools for programming and updating firmware and files on the devices
+- [**Host Driver**](./WINCS02/driver/) — The standalone driver for host MCUs to interface to the **WINCS02** device
+
+## Device Summary
+**WINCS02** and **RNWF02** are Wi-Fi network controller devices that offload Wi-Fi and networking from the host MCU or terminal. The host communicates with the module over a simple serial interface — SPI for WINCS02 or UART for RNWF02 — while the module handles 802.11 connectivity, TCP/IP, TLS, MQTT, HTTP, OTA updates, and more.
+
+**WINCS02** and **RNWF02** devices differ from each other in terms of their host interface:
+
+| | WINCS02 | RNWF02 |
+|---|---|---|
+| **Host Interface** | SPI | UART |
+| **Protocol** | Binary TLV (via nc_driver) | ASCII AT Commands |
+
+## Device Features
+**WINCS02** and **RNWF02** provide the following features:
+
+- **Wi-Fi:** 802.11 b/g/n, station and soft-AP modes, WPA2/WPA3 Personal & Enterprise, simple roaming
+- **TCP/IP Stack:** IPv4/IPv6, TCP, UDP, DHCP client/server, DNS client
+- **TLS:** TLS 1.2 client/server
+- **MQTT:** MQTT v3.1.1 / v5.0 client with TLS support
+- **HTTP/S:** HTTP client for REST APIs and cloud connectivity
+- **SNTP:** Network time synchronization
+- **Low Power:** Wi-Fi and system level power-save modes
+- **Bypass Mode:** Layer 2 raw packet send/receive with unicast/broadcast/multicast filtering
+- **Coexistence:** BLE/Wi-Fi coexistence arbiter
+- **Internal Flash Memory:** Active and rollback firmware images, per-device calibration data, 60KB on-chip file system
+- **File System:** Access to on-chip flash file system (FLFS) for TLS certificates, keys, and configuration files
+- **Firmware Programming Options:**
+  - **Device Firmware Update (DFU):** Firmware programming of a non-running device
+  - **Over-the-air (OTA):** Firmware updates of a running device
+- **Secure Boot:** Immutable secure boot with hardware root of trust
+- **Anti Rollback:** Protection from historically vulnerable firmware
+
+## Firmware Programming and Updating
+Firmware can be programmed or updated on non-running **WINCS02** and **RNWF02** devices:
+- via the [DFU tool](../tools/dfu/); or
+- via a host application that implements the DFU process described in the application developer guide.
+
+Firmware can be updated on running **WINCS02** and **RNWF02** devices:
+- via the [NVM Update tool](../tools/nvm_update/); or
+- via a host application that implements OTA as described in the API specification.
+
+## Quick Links
+
+| WINCS02 | RNWF02 |
+|---|---|
+| [Latest Firmware Release Package](../../releases/tag/WINCS02_v3.2.0) |[Latest Firmware Release Package](../../releases/tag/RNWF02_v3.2.0) | 
+| [Host Driver](./WINCS02/driver/) | N/A |
+| [API Specification (Binary Protocol)](./WINCS02/doc/WINCS02_API_Reference.pdf) | [API Specification (AT Command)](./RNWF02/doc/RNWF02_AT_Command_Reference.pdf) |
+| [Application Developer Guide](https://onlinedocs.microchip.com/g/GUID-B7A95EBE-7BB2-4AF4-A525-700FB718E47A) | [Application Developer Guide](https://onlinedocs.microchip.com/g/GUID-92FEB3A1-C10F-47DF-BF88-C06521800526) |
+| [Data Sheet](https://ww1.microchip.com/downloads/aemDocuments/documents/WSG/ProductDocuments/DataSheets/WINCS02-Wi-Fi-Module-Data-Sheet-DS70005577.pdf) | [Data Sheet](https://ww1.microchip.com/downloads/aemDocuments/documents/WSG/ProductDocuments/DataSheets/RNWF02-Wi-Fi-Module-Data-Sheet-DS70005544.pdf) |
+
+| WINCS02 and RNWF02 |
+|---|
+| [Errata](./ERRATA.md) |
+| [Changelog](./CHANGELOG.md) |
+
+
+## Getting Notifications
+
+Click **Watch** → **Custom** → **Releases** to receive email notifications
+when new firmware is published.

RNWF02/README.md

@@ -0,0 +1,39 @@
+# RNWF02 — Wi-Fi Network Controller Module (UART)
+
+The **RNWF02** is a Wi-Fi network controller device with a UART host interface
+using ASCII AT commands.
+
+## Firmware
+
+Firmware binaries and release notes are available on the [Releases page](../../releases).
+
+| Version | Download |
+|---------|----------|
+| **v3.2.0** (latest) | [GitHub Release](../../releases/tag/RNWF02_v3.2.0) |
+
+### Firmware Files
+
+Each release contains the following binaries:
+
+| File | Description | Usage |
+|---|---|---|
+| `rnwf02_wholeflash.bin` | Full flash image (firmware + empty slot + file system) | Use with the [DFU tool](../tools/dfu/) or a host application to programme the firmware and file system on a non-running device |
+| `rnwf02_dfu_high.bin` | Activated firmware image (single slot) | Use with the [DFU tool](../tools/dfu/) or a host application to update the firmware on a non-running device |
+| `rnwf02_ota.bin` | Firmware image (single slot) | Use with the [NVM Update tool](../tools/nvm_update/) or a host application to update the firmware on a running device |
+| `flfs_image.bin` | File system image containing default TLS certificates | Use with the [DFU tool](../tools/dfu/) or a host application to update the file system on a non-running device |
+
+## Documentation
+
+- [AT Command API Specification (PDF)](doc/RNWF02_AT_Command_Reference.pdf) — complete command reference
+- [Application Developer's Guide](https://onlinedocs.microchip.com/g/GUID-92FEB3A1-C10F-47DF-BF88-C06521800526) — getting started, examples, DFU instructions
+- [Data Sheet (PDF)](https://ww1.microchip.com/downloads/aemDocuments/documents/WSG/ProductDocuments/DataSheets/RNWF02-Wi-Fi-Module-Data-Sheet-DS70005544.pdf)
+
+## Add-on Board
+
+The RNWF02 Add-on Board ([EV72E72A](https://www.microchip.com/en-us/development-tool/ev72e72a))
+provides a ready-to-use evaluation platform with USB-UART bridge and mikroBUS headers.
+
+## MPLAB Harmony Resources
+
+- [wireless_system_rnwf](https://github.com/Microchip-MPLAB-Harmony/wireless_system_rnwf) — Wi-Fi, MQTT, Net, OTA system services
+- [wireless_apps_rnwf](https://github.com/Microchip-MPLAB-Harmony/wireless_apps_rnwf) — example applications