Azure RTOS NetX Duo

This advanced, industrial-grade TCP/IP network stack is designed specifically for deeply embedded real-time and IoT applications. Azure RTOS NetX Duo is a dual IPv4 and IPv6 network stack, while Azure RTOS NetX is the original IPv4 network stack, essentially a subset of Azure RTOS NetX Duo.

Here are the key features and modules of NetX Duo:

Getting Started

Azure RTOS NetX Duo as part of Azure RTOS has been integrated to the semiconductor's SDKs and development environment. You can develop using the tools of choice from STMicro, NXP, Renesas and Microchip.

We also provide getting started guide and samples using hero development boards from semiconductors you can build and test with.

See Overview of Azure RTOS NetX Duo for the high-level overview, and all documentation and APIs can be found in: Azure RTOS NetX Duo documentation.

Also there is dedicated learning path of Azure RTOS NetX Duo for learning systematically.

Repository Structure and Usage

Directory layout

.
├── addons                  # NetX Duo addon modules for protocols and connectivity
├── cmake                   # CMakeList files for building the project
├── common                  # Core NetX Duo files
├── crypto_libraries        # NetX Crypto files
├── nx_secure               # NetX Secure files
├── ports                   # Architecture and compiler specific files
├── samples                 # Sample codes
├── utility                 # Test cases and utilities (e.g. iperf)
├── LICENSE.txt             # License terms
├── LICENSE-HARDWARE.txt    # Licensed hardware from semiconductors
├── CONTRIBUTING.md         # Contribution guidance
└── SECURITY.md             # Microsoft repo security guidance

Branches & Releases

The master branch has the most recent code with all new features and bug fixes. It does not represent the latest General Availability (GA) release of the library. Each official release (preview or GA) will be tagged to mark the commit and push it into the Github releases tab, e.g. v6.2-rel.

When you see xx-xx-xxxx, 6.x or x.x in function header, this means the file is not officially released yet. They will be updated in the next release. See example below.

/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _tx_initialize_low_level                          Cortex-M23/GNU    */
/*                                                           6.x          */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Scott Larson, Microsoft Corporation                                 */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function is responsible for any low-level processor            */
/*    initialization, including setting up interrupt vectors, setting     */
/*    up a periodic timer interrupt source, saving the system stack       */
/*    pointer for use in ISR processing later, and finding the first      */
/*    available RAM memory address for tx_application_define.             */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    _tx_initialize_kernel_enter           ThreadX entry function        */
/*                                                                        */
/*  RELEASE HISTORY                                                       */
/*                                                                        */
/*    DATE              NAME                      DESCRIPTION             */
/*                                                                        */
/*  09-30-2020      Scott Larson            Initial Version 6.1           */
/*  xx-xx-xxxx      Scott Larson            Include tx_user.h,            */
/*                                            resulting in version 6.x    */
/*                                                                        */
/**************************************************************************/

Protocols and connectivity

Protocols and connectivity support are provided as addon modules within NetX Duo in addons folder. Some key modules are: azure_iot, dhcp, dns, ftp, http, mqtt, pop3, lwm2m, ppp, sntp, and web. For a full list of NetX Duo addons, you can find in the same Azure RTOS NetX Duo documentation.

Samples

We provide sample codes about how to use various addons in the samples folder.

Azure IoT Middleware for Azure RTOS

Azure IoT Middleware for Azure RTOS (a.k.a IoT Middleware) is a platform specific library that acts as a binding layer between the Azure RTOS and the Azure SDK for Embedded C. It simplifies building device application that connects to Azure IoT services.

The IoT Middleware also includes built-in support for:

Device Update for IoT Hub: an Azure service for IoT devices to enable the over-the-air (OTA) updates easily.
Microsoft Defender for IoT: an Azure service makes IoT devices visibility into security posture management and threat detection, and integrates with other Microsoft tools for unified security management.

Component dependencies

The main components of Azure RTOS are each provided in their own repository, but there are dependencies between them, as shown in the following graph. This is important to understand when setting up your builds.

You will have to take the dependency graph above into account when building anything other than ThreadX itself.

Building and using the library

Instruction for building the NetX Duo as static library using Arm GNU Toolchain and CMake. If you are using toolchain and IDE from semiconductor, you might follow its own instructions to use Azure RTOS components as explained in the Getting Started section.

Install the following tools:
- CMake version 3.0 or later
- Arm GNU Toolchain for arm-none-eabi
- Ninja
Build the ThreadX library as the dependency.
Cloning the repo. NetX Duo has a couple of dependencies that are included as submodules.
```
$ git clone --recursive https://github.com/azure-rtos/netxduo.git
```
Define the features and addons you need in nx_user.h and build together with the component source code. You can refer to nx_user_sample.h as an example.
Building as a static library

Each component of Azure RTOS comes with a composable CMake-based build system that supports many different MCUs and host systems. Integrating any of these components into your device app code is as simple as adding a git submodule and then including it in your build using the CMake add_subdirectory().

While the typical usage pattern is to include NetX Duo into your device code source tree to be built & linked with your code, you can compile this project as a standalone static library to confirm your build is set up correctly.

An example of building the library for Cortex-M4:
```
$ cmake -Bbuild -GNinja -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake .

$ cmake --build ./build
```

Professional support

Professional support plans are available from Microsoft. For community support and others, see the Resources section below.

Licensing

License terms for using Azure RTOS are defined in the LICENSE.txt file of this repo. Please refer to this file for all definitive licensing information. No additional license fees are required for deploying Azure RTOS on hardware defined in the LICENSED-HARDWARE.txt file. If you are using hardware not listed in the file or having licensing questions in general, please contact Microsoft directly at https://aka.ms/azrtos-license.

Resources

The following are references to additional Azure RTOS resources:

Product introduction and white papers: https://azure.com/rtos
General technical questions: https://aka.ms/QnA/azure-rtos
Product issues and bugs, or feature requests: https://github.com/azure-rtos/netxduo/issues
Licensing and sales questions: https://aka.ms/azrtos-license
Product roadmap and support policy: https://aka.ms/azrtos/lts
Blogs and videos: http://msiotblog.com and https://aka.ms/iotshow
Azure RTOS TraceX Installer: https://aka.ms/azrtos-tracex-installer

You can also check previous questions or ask new ones on StackOverflow using the azure-rtos and netxduo tags.

Security

Azure RTOS provides OEMs with components to secure communication and to create code and data isolation using underlying MCU/MPU hardware protection mechanisms. It is ultimately the responsibility of the device builder to ensure the device fully meets the evolving security requirements associated with its specific use case.

Contribution

Please follow the instructions provided in the CONTRIBUTING.md for the corresponding repository.

azure-rtos/netxduo

azure-rtos

Reviews

Repository Details