[NXP][K32W] k32w1 sdk 2.12.6 updates & k32w0 small fixes (#31924)

* [common] Remove k32w1 device_platform, use nxp instead

Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com>
Signed-off-by: Marius Tache <marius.tache@nxp.com>

* [K32W1] Build, OTA, Diagnostic changes

Signed-off-by: Doru Gucea <doru-cristian.gucea@nxp.com>
Signed-off-by: Marius Tache <marius.tache@nxp.com>
Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com>

* [K32W1] Rename SNT files to ELEMU

* [K32W] Add OPENTHREAD_PLATFORM_CORE_CONFIG_FILE define

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

* [K32W1] Fix MBEDTLS build flags conflict between Matter vs. OpenThread

Matter uses a multithread flavor of MBEDTLS while OpenThread uses a
single thread flavor. This triggers a dangerous situation where
Matter, OpenThread and MBEDTLS don't agree on the size of various
data structures exchanged through the interface which later leads to
memory access violations.

This update fixes the build configuration so that OpenThread also
uses the multithread flavor of MBEDTLS.

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

* [NXP] Update ot-nxp commit-id

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

* [K32W0] Add necessary check for env variable

When computing the path for the signing script, the existence of
env variable NXP_K32W0_SDK_ROOT should be checked first to avoid
issues.

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

* [K32W1] Remove ResetWatermarks empty implementation

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

* [K32W1] Set rotating device id unique id length to max by default

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

* [K32W1] Fix an issue with __wrap_realloc

Current memory manager is MML, which has realloc support.
Removed old function that was relevant only in FreeRTOS
memory manager (heap4/5) context.

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

* [K32W1] Accomodate low power API update

PWR_AllowDeviceToSleep/PWR_DisallowDeviceToSleep API reintroduced in SDK.
power.c removed from ot-nxp.

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

* [K32W1] Clear keys from counter area when factory resetting

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

* [K32W1] Use MML API for heap memory consumption statistics

WTRMRK feature of the Software Diagnostic Cluster will be implemented
once the memory manager will implement the needed API.

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

* [K32W1] Remove duplicated code in crypto PAL

P256Keypair members were moved into protected scope, so
derived classes (P256KeypairSSS) can access these members.

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

* [K32W1] Call PLATFORM_InitTimerManager before PLATFORM_InitBLE since this function won't be initializing the timer manager anymore

* [K32W1] Post events from ISR correctly

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

* [K32W1] MML realloc should be protected from task switching

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

* [K32W1] Add initial FactoryDataProviderImpl

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

* [K32W1] Update certification declaration in apps

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

* [K32W1] Update README files in apps

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

* [K32W1] Add DAC private key convert declaration

TBD

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

* [k32w1] Fix usage of deprecated factory data provider fields

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

* [COMMON] Add dac_key_use_sss_blob option

dac_key_use_sss_blob can be used to select which data
the private key area stores: plaintext/encrypted private key
or an SSS exported blob.

The option is False by default.

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

* [K32W1] Add SSS API usage

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

* [K32W1] Add chip_convert_dac_private_key option

chip_convert_dac_private_key can be used to enable one-time-only
conversion of the DAC private key to an SSS encrypted blob.

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

* [K32W1] Add jlink conversion script example

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

* [K32W1] Update readme to point to docs guide

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

* [K32W1] Remove unused mbedtls modules

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

* [K32W1] Factory data section should only be reserved in factory data context

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

* [K32W1] Add destructor to free SSS object context

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

* [K32W1] Add verbose logging for conversion steps

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

* [K32W1] Restore NVM sector number

 The underlying issue, for which the increase
 in NVM sectors was a workaround, was solved.

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

* [K32W1] Add BLE ResetController function

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

* [K32W1] Allocate OT buffers from SMU2

When using use_smu2_dynamic=true, OpenThread buffers
 will be allocated from a 13KB SMU2 region after a successful
 commissioning process until a factory reset is done.

 * Add SMU2 namespace in SMU2Manager.h/.cpp
 * Add build changes
 * Add allocator changes
 * Add necessary OpenThread config defines
 * Add gn parameter/defines for each SMU2 usecase

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

* [K32W1] Offload SHA256 operations to S200
 * Offload simple sha256, simple hmac sha256,
   update/finish sha256, update/finish hmac sha256
   from Matter and OT.
 * Implement solution for long sha256 that uses
   context save/export/restore mechanism.
   This solution saves the intermediate data on heap
   and computes the hash on demand (by calling GetDigest).
 * Put changes under define/gn parameter use_hw_sha256
   as they increase timings (due to hardware
   accelerator initialization time) and use a significant
   amount of heap.

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

* [K32W1] Simplify HW DRBG/TRNG usage

S200 TRNG is already used though otPlatEntropyGet from OT.

Simplify Matter and OT DRBG usage of HW TRNG by not using
mbedtls entropy.

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

* [K32W1] Offload AES operations to S200
 * Offload AES-CCM from Matter.
 * Offload AES-ECB from OT.
 * Use software AES-CCM when Additional authentical
   data len is zero.
 * Put changes under define/gn parameter use_hw_aes
   as they increase timings (due to hardware
   accelerator initialization time).

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

* [K32W1] Fix duplicated flag

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

* [COMMON] Add pw RPC support

The pw RPC integration should be usable by all NXP platforms
that support SerialManager, since the pw_sys_io backend uses
streamer_nxp.cpp for serial communication.

A scope is defined in pw_rpc_server.gni to be used by all apps
by forwarding the variables in the application executable scope:
   forward_variables_from(pw_rpc_server, "*")

Logging and RPC communication share the same serial port. Logging
should be inspected in chip-console, which manages the HDLC channels.

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

* [COMMON] Update streamer to read RX data ASAP

Moved reading the RX FIFO inside the actual interrupt handler,
to avoid time penalty when notifying the consumer task (RPC/App CLI).
The data is instead stored in a cache buffer and read once the task
is unblocked through notifying by the ISR.

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

* [K32W1] Enable pw RPC on lighting app

To build with RPC enabled, the user should generate the files:
gn gen out/debug --args='import("//with_pw_rpc.gni") treat_warnings_as_errors=false'

pw RPC requires c++ 17.

Some example commands are written in the README, under section `Running RPC console`.

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

* [COMMON] Revert streamer implementation and add UART DMA support

pw RPC requires UART DMA to avoid missing commands and errors
related to frame integrity checks.

Applications that enable RPC support should use UART DMA (if possible).

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

* [K32W1] Use UART DMA for pw RPC

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

* k32w1: enable sit icd

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

* [K32W1] Implement watermark feature using MML API

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

* [K32W1] Update free SMU2 region in linker script

The SMU2 free region shrank due to addition of lowpower flag in NBU.
This overlap might affect Matter instances placed in SMU2 region.

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

* [K32W1] Fix TotalOperatingHours attribute reset

The UpTime attribute of the GeneralDiagnostics cluster was being reset
periodically due to the limited range of the LPTMR timestamp (32
bits). To fix it, support for a 64bit timestamp was added to the NXP
OpenThread library and now Matter can use the "otPlatTimeGet()" API to
acquire the timestamp in microseconds.

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

* [K32W1] Fix LP current draw for Contact Sensor App after framework changes

After framework changes with reintroducing PWR_AllowDeviceToSleep & PWR_DisallowDeviceToSleep functions,
Contact Sensor application does not enter into low power anymore after BLE connection event.
Adding PWR_DisallowDeviceToSleep call at connection event before PWR_AllowDeviceToSleep as framework request.

Signed-off-by: Marius Vilvoi <marius.vilvoi@nxp.com>

* [K32W] Send a report before resetting the device during OTA

State-transition event from Downloading to Applying was not successfully sent
to a subscriber during OTA because the device would reset before actually sending
the ReportData message.

Added an explicit call to sync send a report if any events were logged. This is managed
by the ReportingEnginge.

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

* [K32W] Create dedicated zap file for contact sensor

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

* [K32W1] Switch to dedicated zap file

The common zap file configuration has many optional cluster enabled
that are not needed in our contact-sensor reference app

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

* [K32W] Change lighting-app root node revision to 2

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

* [K32W1] Adjust rambuffer size and KVS max number of keys

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

* [K32W1] Add CleanReset API

Clean reset ensures:
* Matter event loop is stopped.
* Shutdown is called.
* Pending operations are completed in NVM.
* MCU is reset.

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

* [K32W1] Change long press SW3 action from OTA query to clean soft reset

When long pressing SW3, the reference applications will call the platform manager
clean soft reset API. This will reset the MCU after the Matter shutdown procedure
is called and all NVM pending operations are finished.

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

* [K32W] define CHIP_ADDRESS_RESOLVE_IMPL_INCLUDE_HEADER

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

* [K32W] Update docker image version

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

* Restyled by whitespace

* Restyled by clang-format

* Restyled by prettier-markdown

* Fix spelling

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

* [K32W] Update contact-sensor-app zap files

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

* [K32W] Remove deprecated code

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

* [K32W1] Fix gn check errors

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

* [K32W1] Fix build

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

* Restyled by gn

* [K32W1] Fix lints

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

* [NXP] Update ot-nxp commit-id

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

* [NXP] Update matter zap file

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

---------

Signed-off-by: Andrei Menzopol <andrei.menzopol@nxp.com>
Signed-off-by: Marius Tache <marius.tache@nxp.com>
Signed-off-by: Doru Gucea <doru-cristian.gucea@nxp.com>
Signed-off-by: Marian Chereji <marian.chereji@nxp.com>
Signed-off-by: marius-alex-tache <marius.tache@nxp.com>
Signed-off-by: Marius Vilvoi <marius.vilvoi@nxp.com>
Co-authored-by: Yanis Viola <yanis.viola@nxp.com>
Co-authored-by: Marius Tache <marius.tache@nxp.com>
Co-authored-by: Marian Chereji <marian.chereji@nxp.com>
Co-authored-by: Yassine El-aissaoui <yassine.elaissaoui@nxp.com>
Co-authored-by: Doru Gucea <doru-cristian.gucea@nxp.com>
Co-authored-by: Marius Vilvoi <marius.vilvoi@nxp.com>
Co-authored-by: Restyled.io <commits@restyled.io>
87 files changed
tree: 2ccffc2084aea1acb3f8e3c954b8adaee3af4219
  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. .flake8
  24. .gitattributes
  25. .gitignore
  26. .gitmodules
  27. .gn
  28. .isort.cfg
  29. .mergify.yml
  30. .prettierrc.json
  31. .pullapprove.yml
  32. .restyled.yaml
  33. .shellcheck_tree
  34. .spellcheck.yml
  35. BUILD.gn
  36. CODE_OF_CONDUCT.md
  37. CONTRIBUTING.md
  38. gn_build.sh
  39. iwyu.imp
  40. kotlin-detect-config.yaml
  41. lgtm.yml
  42. LICENSE
  43. NOTICE
  44. README.md
  45. REVIEWERS.md
  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.