[NXP] Integrating code updates for RW61X and K32W platforms (#32615)

* [NXP][platform][common] Adding platform common code

* [NXP][platform][k32w] Adding platform code changes for k32w

* [NXP][platform][rw61x] Adding platform code changes for rw61x

* [NXP][tools][common] Adding nxp tools updates

* [NXP][examples][common] Adding examples common updates

* [NXP][examples][rw61x] Adding examples updates

* [NXP][examples][k32w] Adding examples updates

* [NXP][doc][common] Adding documentation updates

* [NXP][scripts][common] Add checkout_submodules NXP target

All submodules that don't have a platforms field will be selected
when the script is run. Additionally, if --platform nxp is used,
submodules that have nxp under their platform field will also be
checked out.

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][CI][rw61x] Enabling CI workflow for RW61x examples (all-clusters-app, thermostat, laundry-washer)

* [NXP][examples][common] Fix laundry-washer app by removing af-enums.h include in the operational-state-delegate-impl.h

* [NXP][platform][k32w1] Fix clang formatting

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][doc][rw61x] Adding information to run bootstrap script + submodule update script

+ Updating gn information to build Matter target that will support BR

Signed-off-by: Gatien Chapon <gatien.chapon@nxp.com>

* [NXP][platform] Fix string keys saving failure

The "NXPConfig" class member function which is supposed to save the
string keys to persistent storage was, in fact, invoking the
"NvSaveOnIdle" function using the INTEGER keys RAM buffer descriptor,
instead of using the STRING keys RAM buffer descriptor. Most likely
a typical copy-paste error.

Signed-off-by: Marian Chereji <marian.chereji@nxp.com>

* [NXP][platform][k32w] Small fixes for k32w platform code

 * correct typos
 * remove executable access permissions
 * remove unused files
 * change openthread_root to ot-nxp/openthread-k32w1

Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com>

* [NXP][examples][k32w] Fixes for k32w examples code

 * small changes for existing code

Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com>

* [NXP][sdk][common] Remove chip_enable_icd_lit

 * argument has been moved to src/app/icd/icd.gni

Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com>

* [NXP][examples][common] Fix missing QR code log

* [NXP][platform][k32w1] Fix gn issue

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][examples][k32w0] Update default args.gni for reference apps

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][examples][k32w1] Update default args.gni for reference apps

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][platform][k32w0] Move subscription and groups KVS keys to dedicated storages

To avoid a large KVS RAM buffer and memory allocation issues when running TC-RR-1.1,
move some specific keys in dedicated RAM storage instaces:
* subscription keys will be stored in sSubscriptionStorage.
* groups keys will be stored in sGroupsStorage. This RAM storage will use the extended
search feature, because its size will be greater than current backend region size (2K).

The key/value storage will be selected in each API based on some
criteria: if the key is related to either subscription/groups, then
both the key and the value will be stored in the same storage. Otherwise,
the default keys and values storages are used.

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][platform][k32w0] Add conversion for subscription and groups keys

When CONFIG_CHIP_K32W0_KVS_MOVE_KEYS_TO_SPECIFIC_STORAGE is set to 1,
the application can opt to move some keys from current KVS storage
to a dedicated storage, based on the key name.

Currently, the mechanism supports moving keys and values for:
* subscriptions
* groups

Note: the system is meant to ensure backwards compatibility. This should only
be used once, but, if this feature is still enabled after the first conversion,
the corresponding keys will not be found in KVS default storage. This does
not affect the functionality, but it introduces a delay in the initialization.

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][examples][common] Updating laundry washer zap file to be consistent with current PICS

* [NXP][examples][common] Updating thermostat zap files to be consistent with current PICS

* [NXP][platform][rw61x] Add define for encrypted factory data

CONFIG_CHIP_ENCRYPTED_FACTORY_DATA is defined by default when factory data
is enabled. The common code should leverage this flag to make some actions
when implicit encrypted factory data is enabled.

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][examples][common][factory-data] Enclose encryption code

Encrypted factory data related code should be enclosed based on the
CONFIG_CHIP_ENCRYPTED_FACTORY_DATA flag.

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][examples][common] Add a way to include a specific OTAImageProcessor header

CONFIG_CHIP_OTA_IMAGE_PROCESSOR_HEADER should specify an OTA image processor implementation
header. It can be a custom one, such as the header for OTA multi-image implementation.
This will ease the transition of current reference apps that are not using the processor
from the NXP common area.

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][examples][common] Enclose binding usage based on EMBER_AF_PLUGIN_BINDING

EMBER_AF_PLUGIN_BINDING is defined when the server side of the Binding cluster is used.
The common app task code should initialize Binding handlers only if this flag is defined.

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][examples][k32w][contact-sensor][zap] Enable Diagnostic Logs Cluster

Signed-off-by: Doru Gucea <doru-cristian.gucea@nxp.com>

* [NXP][platform][common] Add Diagnostic Logs common

Signed-off-by: Doru Gucea <doru-cristian.gucea@nxp.com>

* [NXP][platform][common] create nxp_diagnostic_logs

Signed-off-by: Doru Gucea <doru-cristian.gucea@nxp.com>

* [NXP][examples][k32w1] enable Diagnostic Logs for contact-sensor app

Signed-off-by: Doru Gucea <doru-cristian.gucea@nxp.com>

* [NXP][example][common] Fixing PLATFORM_InitTimerManager return value check issue

Signed-off-by: Gatien Chapon <gatien.chapon@nxp.com>

* [NXP][examples][common] Fix contact-sensor zap files

Signed-off-by: Doru Gucea <doru-cristian.gucea@nxp.com>

* [NXP][examples][common] Fix laundry-washer-app build : remove zap_generated_dir from BUILD.gn as it does not exist anymore

* [NXP][doc] Adding support for the laundry-washer example inside docs/examples/index.md

* [NXP][doc][rw61x] Update readme to support SDK 2.13.3

* [NXP][examples][k32w][mw320] Remove not upstreamed and not supported apps

 * drop light-switch-combo-app as it isn't upstreamed yet
 * remove lock-app as it is not supported anymore
   (at least for the moment)
 * remove shell-app as it is not supported anymore
   (at least for the moment)

Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com>

* [NXP][scripts] Remove unsused binaries

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][platform][k32w] Remove duplicated code introduced in a merge conflict

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][common] Update OT-NXP repo commit

Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com>

* [NXP][CI][rw61x] Updating docker image version for SDK support

* [NXP][CI][k32w] Update workflows and docker image version for SDK support

Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com>

* [NXP][examples][k32w] Fix spelling

Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com>

* [NXP][rw61x] Fix doc, spelling and zap errors

* [NXP][rw61x] Fix doc spelling errors

* [NXP][k32w0] Fix SDK path

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* Restyled by whitespace

* Restyled by clang-format

* Restyled by gn

* Restyled by prettier-markdown

* Restyled by autopep8

* Restyled by isort

* [NXP][doc][k32w] Fix docs issues

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][scripts][common] Fix lint errors

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][CI][k32w] Remove deprecated examples

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][docs] Remove lock app from commissioning guide

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][platform][common] Remove unused header

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][platform][k32w1] Remove custom openthread_root

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][platform][rw61x] Fix lint code error

* [NXP][k32w0] Fix gn import order

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][sdk][k32w0] Fix SDK path condition

When official repo CI is used, the docker image sets the west github SDK
to /opt/sdk/core. This caused gn SDK files to mistakenly treat the SDK
as a package SDK, which affected the paths.

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][scripts][k32w] Take into account low power flags for k32w0

Pigweed tokenizer logging and expansion board gn args are enabled by default
in the reference apps args.gni. Disable them explicitly for low power case.

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

* [NXP][examples][k32w1] Move diagnostic_logs to a common examples area

This type of app specific implementation should reside in the application
space, instead of the device layer.

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>

---------

Signed-off-by: marius-alex-tache <marius.tache@nxp.com>
Signed-off-by: Gatien Chapon <gatien.chapon@nxp.com>
Signed-off-by: Marian Chereji <marian.chereji@nxp.com>
Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com>
Signed-off-by: Doru Gucea <doru-cristian.gucea@nxp.com>
Co-authored-by: marius-alex-tache <marius.tache@nxp.com>
Co-authored-by: Gatien Chapon <gatien.chapon@nxp.com>
Co-authored-by: Marian Chereji <marian.chereji@nxp.com>
Co-authored-by: Andrei Menzopol <andrei.menzopol@nxp.com>
Co-authored-by: Martin Girardot <martin.girardot@nxp.com>
Co-authored-by: Doru Gucea <doru-cristian.gucea@nxp.com>
Co-authored-by: Restyled.io <commits@restyled.io>
241 files changed
tree: 911d46bb7ad719ccbb0d6f7bcf3be79748699a67
  1. .devcontainer/
  2. .githooks/
  3. .github/
  4. .vscode/
  5. build/
  6. build_overrides/
  7. config/
  8. credentials/
  9. data_model/
  10. docs/
  11. examples/
  12. integrations/
  13. scripts/
  14. src/
  15. third_party/
  16. zzz_generated/
  17. .actrc
  18. .clang-format
  19. .clang-tidy
  20. .default-version.min
  21. .dir-locals.el
  22. .editorconfig
  23. .gitattributes
  24. .gitignore
  25. .gitmodules
  26. .gn
  27. .isort.cfg
  28. .mergify.yml
  29. .prettierrc.json
  30. .pullapprove.yml
  31. .restyled.yaml
  32. .shellcheck_tree
  33. .spellcheck.yml
  34. BUILD.gn
  35. CODE_OF_CONDUCT.md
  36. CONTRIBUTING.md
  37. gn_build.sh
  38. iwyu.imp
  39. kotlin-detect-config.yaml
  40. lgtm.yml
  41. LICENSE
  42. NOTICE
  43. README.md
  44. REVIEWERS.md
  45. ruff.toml
  46. SPECIFICATION_VERSION
README.md

Matter

Builds

Builds

Android Ameba ASR BouffaloLab Darwin TI CC26X2X7 TI CC32XX EFR32 ESP32 Infineon i.MX Linux K32W with SE051 Linux ARM Linux Standalone Linux Standalone Mbed OS MW320 nRF Connect SDK Open IoT SDK QPG STM32 Telink Tizen

Tests

Unit / Integration Tests Cirque QEMU

Tools

ZAP Templates

Documentation

Documentation Build

About

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.

What is Matter?

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.

Project Overview

Development Goals

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.

Architecture Overview

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: Matter Architecture Overview

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:

Matter Stack Architecture

  1. Application: High-order business logic of a device. For example, an application that is focused on lighting might contain logic to handle turning on/off the bulb as well as its color characteristics.
  1. Data Model: The data layer corresponds to the data and verb elements that help support the functionality of the application. The Application operates on these data structures when there is an intent to interact with the device.
  1. Interaction Model: The Interaction Model layer defines a set of interactions that can be performed between a client and server device. For example, reading or writing attributes on a server device would correspond to application behavior on the device. These interactions operate on the elements defined at the data model layer.
  1. Action Framing: Once an action is constructed using the Interaction Model, it is serialized into a prescribed packed binary format to encode for network transmission.
  1. 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.

  2. 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.

  1. IP Framing & Transport Management: After the final payload has been constructed, it is sent to the underlying transport protocol for IP management of the data.

Current Status of Matter

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.

How to Contribute

We welcome your contributions to Matter. Read our contribution guidelines here.

Building and Developing in Matter

Instructions about how to build Matter can be found here .

Directory Structure

The Matter repository is structured as follows:

File/FolderContent
buildBuild system support content and built output directories
build_overridesBuild system parameter customization for different platforms
configProject configurations
credentialsDevelopment and test credentials
docsDocumentation, including guides. Visit the Matter SDK documentation page to read it.
examplesExample firmware applications that demonstrate use of Matter
integrations3rd party integrations
scriptsScripts needed to work with the Matter repository
srcImplementation of Matter
third_party3rd party code used by Matter
zzz_generatedZAP generated template code - Revolving around cluster information
BUILD.gnBuild file for the GN build system
CODE_OF_CONDUCT.mdCode of conduct for Matter and contribution to it
CONTRIBUTING.mdGuidelines for contributing to Matter
LICENSEMatter license file
REVIEWERS.mdPR reviewers
gn_build.shBuild script for specific projects such as Android, EFR32, etc.
README.mdThis file

License

Matter is released under the Apache 2.0 license.