[NXP] Enable OTA multi-image support on NXP RW/RT platforms (#38243) * [NXP][platform][zephyr][ota] Add OTAImageProcessorImpl instance & getter * this change is needed to align all nxp OTAImageProcessorImpl implementations so that ICDUtil::OnSubscriptionRequested / SetRebootDelaySec can be used and shared. * remove DeviceLayer namespace brace style to aligh with other implementations Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com> * [NXP][platform][common][ota] Add OTAImageProcessorImpl instance & getter * this change is needed to align all nxp OTAImageProcessorImpl implementations so that ICDUtil::OnSubscriptionRequested / SetRebootDelaySec can be used and shared. Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com> * [NXP][platform][common][ota_requestor] Use default OTAImageProcessorImpl static instance * Use default OTAImageProcessorImpl static instance instead of the OTARequestorInitiator gImageProcessor member to align all platform implementations. Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com> * [NXP][platform][common][icd] OTA SetRebootDelaySec to maximum of all min intervals * take into account the min intervals of all subscriptions, not only the last Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com> * [NXP][platform][common][icd] Reference default OTAImageProcessorImpl static instance * Reference default OTAImageProcessorImpl static instance instead of the OTARequestorInitiator gImageProcessor member to allow all platform impl to use this feature. Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com> * [NXP][examples][common][contact-sensor-app] Register ICD ReadHandlerAppCallback Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com> * [NXP][examples][k32w1][contact-sensor-app] Add ICDUtil.cpp BUILD.gn Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com> * [NXP][examples][mcxw71][contact-sensor-app] Add ICDUtil.cpp BUILD.gn Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com> * [NXP][platform][rw61x] Updates in platform GN file to build OTA multi-image and encryption implementation Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> * [NXP][platform][mcxw71_k32w1] Updating CHIP config file so CHIP_DEVICE_LAYER_OTA_REBOOT_DELAY can be defined in common config file Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> [nxp toup][platform][mcxw71] Remove duplicated define that is now located in common CHIPDeviceNXPPlatformDefaultConfig.h Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> * [NXP][examples][common] Adding OTA_Initialize call in the HandleSelfTest method of OTARequestorInitiatorMultiImage.cpp * This is required to ensure that the upgrade image is marked as permanent in next reboot so the bootloader does not revert back to old image Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> [examples][common] Updates in OTARequestorInitiator files to be compatible with multi-image OTA Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> [examples][common] Update the OTA img processor include in ICDUtil.cpp Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> * [NXP][platform][common] Updates in OTA multi-image implementation to support RW/RT platforms * Adding CONFIG_CHIP_OTA_POSTED_OPERATIONS_IN_IDLE which allows to enable the posting of write/erase operations in the idle task * Calling PlatformMgrImpl().ScheduleResetInIdle() to reset the device with common API in idle task instead of ResetMCU() * Updates in the relative include paths to make sure it's compatible with a CMake build Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> [platform][common] Remove common OTAImageProcessor files as the ones from ota folder will be used instead Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> [platform][common] Update ota files to move the commit image after all actions are applied Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> * [NXP][platform][k32w0] Moving OTATlvProcessor files under platform folder to use k32w0 specific api for ota encryption Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> * [NXP][platform][common] Reworking OTA encryption solution to be generic for all nxp platforms * In this support OTA encryption/decryption is using AES-CTR mode. * The image is sent encrypted to the OTA Requestor. At the reception of each block, the OTA image (fw) processor decrypts the block using AES-CTR. * AES-CTR mode requires generating a keystream from an initialization vector (iv) and encrypting it to generate the keystream, the latter is then used to decipher the block. * The encryption is using the public mbedtls api to provide a generic solution for all platforms. Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> [NXP][platform][common] Make sure EmbeddedTypes.h is included in OTAHooks.cpp * If EmbeddedTypes.h is not included, the compiler may not recognize the "WEAK" type Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> * [NXP][platform][zephyr] Align zephyr file OTAImageProcessor with common ota files * Define OTAImageProcessorImpl::Init which will set the ota downloader for zephyr implementation * In freertos implementation, this method will set the ota downloader and init the OTAHook which is required for a multi-image OTA. * This change is required to be able to share the same OTARequestorInitiatorCommon.cpp file. Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> * [NXP][platform][rt1170] Updates in platform GN file to build OTA encryption and multi-image implementation * [NXP][platform][rt1060] Updates in platform GN file to build OTA encryption and multi-image implementation * [NXP][platform][common] Add condition around reset in idle to be supported by all platforms Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> * [NXP][common] Update copyrights year date Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> * Restyled by whitespace * Restyled by gn * Update examples/platform/nxp/common/ota_requestor/source/OTARequestorInitiator.cpp with dos2unix to revert unwanted changes Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> * Restyled by clang-format * [NXP] Add CONFIG_APP_FREERTOS_OS define for k32w1/mcxw71 examples Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> * [NXP] Define CHIP_DEVICE_LAYER_OTA_REBOOT_DELAY in platform CHIPDevicePlatformConfig.h for k32w1/mcxw71 Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> --------- Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com> Signed-off-by: Dina Benamar <dina.benamarelmaaroufi@nxp.com> Co-authored-by: Andrei Menzopol <andrei.menzopol@nxp.com> Co-authored-by: Jaafar BEN YOUNES <jaafar.benyounes@nxp.com> Co-authored-by: Restyled.io <commits@restyled.io>
Builds
Tests
Tools
Documentation
Matter (formerly Project CHIP) creates more connections between more objects, simplifying development for manufacturers and increasing compatibility for consumers, guided by the Connectivity Standards Alliance.
Matter is a unified, open-source application-layer connectivity standard built to enable developers and device manufacturers to connect and build reliable, and secure ecosystems and increase compatibility among connected home devices. It is built with market-proven technologies using Internet Protocol (IP) and is compatible with Thread and Wi-Fi network transports. Matter was developed by a Working Group within the Connectivity Standards Alliance (Alliance). This Working Group develops and promotes the adoption of the Matter standard, a royalty-free connectivity standard to increase compatibility among smart home products, with security as a fundamental design tenet. The vision that led major industry players to come together to build Matter is that smart connectivity should be simple, reliable, and interoperable.
Matter simplifies development for manufacturers and increases compatibility for consumers.
The standard was built around a shared belief that smart home devices should be secure, reliable, and seamless to use. By building upon Internet Protocol (IP), Matter enables communication across smart home devices, mobile apps, and cloud services and defines a specific set of IP-based networking technologies for device certification.
The Matter specification details everything necessary to implement a Matter application and transport layer stack. It is intended to be used by implementers as a complete specification.
The Alliance officially opened the Matter Working Group on January 17, 2020, and the specification is available for adoption now.
Visit buildwithmatter.com to learn more and read the latest news and updates about the project.
Matter is developed with the following goals and principles in mind:
Unifying: Matter is built with and on top of market-tested, existing technologies.
Interoperable: The specification permits communication between any Matter-certified device, subject to users’ permission.
Secure: The specification leverages modern security practices and protocols.
User Control: The end user controls authorization for interaction with devices.
Federated: No single entity serves as a throttle or a single point of failure for root of trust.
Robust: The set of protocols specifies a complete lifecycle of a device — starting with the seamless out-of-box experience, through operational protocols, to device and system management specifications required for proper function in the presence of change.
Low Overhead: The protocols are practically implementable on low compute-resource devices, such as MCUs.
Pervasive: The protocols are broadly deployable and accessible, by leveraging IP and being implementable on low-capability devices.
Ecosystem-Flexible: The protocol is flexible enough to accommodate deployment in ecosystems with differing policies.
Easy to Use: The protocol provides smooth, cohesive, integrated provisioning and out-of-box experience.
Open: The Project’s design and technical processes are open and transparent to the general public, including non-members wherever possible.
Matter aims to build a universal IPv6-based communication protocol for smart home devices. The protocol defines the application layer that will be deployed on devices and the different link layers to help maintain interoperability. The following diagram illustrates the normal operational mode of the stack:
The architecture is divided into layers to help separate the different responsibilities and introduce a good level of encapsulation among the various pieces of the protocol stack. The vast majority of interactions flow through the stack captured in the following Figure:
Security: An encoded action frame is then sent down to the Security Layer to encrypt and sign the payload to ensure that data is secured and authenticated by both sender and receiver of a packet.
Message Framing & Routing: With an interaction encrypted and signed, the Message Layer constructs the payload format with required and optional header fields; which specify the message's properties and some routing information.
Matter’s design and technical processes are intended to be open and transparent to the general public, including to Working Group non-members wherever possible. The availability of this GitHub repository and its source code under an Apache v2 license is an important and demonstrable step to achieving this commitment. Matter endeavors to bring together the best aspects of market-tested technologies and redeploy them as a unified and cohesive whole-system solution. The overall goal of this approach is to bring the benefits of Matter to consumers and manufacturers as quickly as possible. As a result, what you observe in this repository is an implementation-first approach to the technical specification, vetting integrations in practice. The Matter repository is growing and evolving to implement the overall architecture. The repository currently contains the security foundations, message framing and dispatch, and an implementation of the interaction model and data model. The code examples show simple interactions, and are supported on multiple transports -- Wi-Fi and Thread -- starting with resource-constrained (i.e., memory, processing) silicon platforms to help ensure Matter’s scalability.
We welcome your contributions to Matter. Read our contribution guidelines here.
Instructions about how to build Matter can be found here .
The Matter repository is structured as follows:
| File/Folder | Content |
|---|---|
| build | Build system support content and built output directories |
| build_overrides | Build system parameter customization for different platforms |
| config | Project configurations |
| credentials | Development and test credentials |
| docs | Documentation, including guides. Visit the Matter SDK documentation page to read it. |
| examples | Example firmware applications that demonstrate use of Matter |
| integrations | 3rd party integrations |
| scripts | Scripts needed to work with the Matter repository |
| src | Implementation of Matter |
| third_party | 3rd party code used by Matter |
| zzz_generated | ZAP generated template code - Revolving around cluster information |
| BUILD.gn | Build file for the GN build system |
| CODE_OF_CONDUCT.md | Code of conduct for Matter and contribution to it |
| CONTRIBUTING.md | Guidelines for contributing to Matter |
| LICENSE | Matter license file |
| REVIEWERS.md | PR reviewers |
| gn_build.sh | Build script for specific projects such as Android, EFR32, etc. |
| README.md | This file |
Matter is released under the Apache 2.0 license.