1# Azure RTOS NetX Duo 2 3This 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. 4 5Here are the key features and modules of NetX Duo: 6 7 8 9## Getting Started 10 11Azure 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](https://www.st.com/content/st_com/en/campaigns/x-cube-azrtos-azure-rtos-stm32.html), [NXP](https://www.nxp.com/design/software/embedded-software/azure-rtos-for-nxp-microcontrollers:AZURE-RTOS), [Renesas](https://github.com/renesas/azure-rtos) and [Microchip](https://mu.microchip.com/get-started-simplifying-your-iot-design-with-azure-rtos). 12 13We also provide [getting started guide](https://github.com/azure-rtos/getting-started) and [samples](https://github.com/azure-rtos/samples) using hero development boards from semiconductors you can build and test with. 14 15See [Overview of Azure RTOS NetX Duo](https://learn.microsoft.com/azure/rtos/netx-duo/overview-netx-duo) for the high-level overview, and all documentation and APIs can be found in: [Azure RTOS NetX Duo documentation](https://learn.microsoft.com/azure/rtos/netx-duo/). 16 17Also there is dedicated [learning path of Azure RTOS NetX Duo](https://learn.microsoft.com/training/paths/azure-rtos-netx-duo/) for learning systematically. 18 19## Repository Structure and Usage 20 21### Directory layout 22 23 . 24 ├── addons # NetX Duo addon modules for protocols and connectivity 25 ├── cmake # CMakeList files for building the project 26 ├── common # Core NetX Duo files 27 ├── crypto_libraries # NetX Crypto files 28 ├── nx_secure # NetX Secure files 29 ├── ports # Architecture and compiler specific files 30 ├── samples # Sample codes 31 ├── utility # Test cases and utilities (e.g. iperf) 32 ├── LICENSE.txt # License terms 33 ├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors 34 ├── CONTRIBUTING.md # Contribution guidance 35 └── SECURITY.md # Microsoft repo security guidance 36 37### Branches & Releases 38 39The 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`. 40 41> 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. 42``` 43/**************************************************************************/ 44/* */ 45/* FUNCTION RELEASE */ 46/* */ 47/* _tx_initialize_low_level Cortex-M23/GNU */ 48/* 6.x */ 49/* AUTHOR */ 50/* */ 51/* Scott Larson, Microsoft Corporation */ 52/* */ 53/* DESCRIPTION */ 54/* */ 55/* This function is responsible for any low-level processor */ 56/* initialization, including setting up interrupt vectors, setting */ 57/* up a periodic timer interrupt source, saving the system stack */ 58/* pointer for use in ISR processing later, and finding the first */ 59/* available RAM memory address for tx_application_define. */ 60/* */ 61/* INPUT */ 62/* */ 63/* None */ 64/* */ 65/* OUTPUT */ 66/* */ 67/* None */ 68/* */ 69/* CALLS */ 70/* */ 71/* None */ 72/* */ 73/* CALLED BY */ 74/* */ 75/* _tx_initialize_kernel_enter ThreadX entry function */ 76/* */ 77/* RELEASE HISTORY */ 78/* */ 79/* DATE NAME DESCRIPTION */ 80/* */ 81/* 09-30-2020 Scott Larson Initial Version 6.1 */ 82/* xx-xx-xxxx Scott Larson Include tx_user.h, */ 83/* resulting in version 6.x */ 84/* */ 85/**************************************************************************/ 86``` 87 88## Protocols and connectivity 89 90Protocols and connectivity support are provided as addon modules within NetX Duo in `addons` folder. Some key modules are: [**azure_iot**](https://github.com/azure-rtos/netxduo/tree/master/addons/azure_iot), [**dhcp**](https://learn.microsoft.com/azure/rtos/netx-duo/netx-duo-dhcp-client/chapter1), [**dns**](https://learn.microsoft.com/azure/rtos/netx-duo/netx-duo-dns/chapter1), [**ftp**](https://learn.microsoft.com/azure/rtos/netx-duo/netx-duo-dns/chapter1), [**http**](https://learn.microsoft.com/azure/rtos/netx-duo/netx-duo-http/chapter1), [**mqtt**](https://learn.microsoft.com/azure/rtos/netx-duo/netx-duo-mqtt/chapter1), [**pop3**](https://learn.microsoft.com/azure/rtos/netx-duo/netx-duo-pop3-client/chapter1), [**lwm2m**](https://learn.microsoft.com/azure/rtos/netx-duo/netx-duo-lwm2m/chapter1), [**ppp**](https://learn.microsoft.com/azure/rtos/netx-duo/netx-duo-ppp/chapter1), [**sntp**](https://learn.microsoft.com/azure/rtos/netx-duo/netx-duo-sntp-client/chapter1), and [**web**](https://learn.microsoft.com/azure/rtos/netx-duo/netx-duo-web-http/chapter1). For a full list of NetX Duo addons, you can find in the same [Azure RTOS NetX Duo documentation](https://learn.microsoft.com/azure/rtos/netx-duo/). 91 92### Samples 93 94We provide sample codes about how to use various addons in the [`samples`](./samples/) folder. 95 96### Azure IoT Middleware for Azure RTOS 97 98[Azure IoT Middleware for Azure RTOS](https://github.com/azure-rtos/netxduo/tree/master/addons/azure_iot) (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](https://github.com/Azure/azure-sdk-for-c). It simplifies building device application that connects to Azure IoT services. 99 100The IoT Middleware also includes built-in support for: 101 102- **[Device Update for IoT Hub](https://learn.microsoft.com/azure/iot-hub-device-update/device-update-azure-real-time-operating-system)**: an Azure service for IoT devices to enable the over-the-air (OTA) updates easily. 103- **[Microsoft Defender for IoT](https://learn.microsoft.com/azure/defender-for-iot/device-builders/iot-security-azure-rtos)**: an Azure service makes IoT devices visibility into security posture management and threat detection, and integrates with other Microsoft tools for unified security management. 104 105## Component dependencies 106 107The 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. 108 109 110 111> You will have to take the dependency graph above into account when building anything other than ThreadX itself. 112 113### Building and using the library 114 115Instruction 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](#getting-started) section. 116 1171. Install the following tools: 118 119 * [CMake](https://cmake.org/download/) version 3.0 or later 120 * [Arm GNU Toolchain for arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) 121 * [Ninja](https://ninja-build.org/) 122 1231. Build the [ThreadX library](https://github.com/azure-rtos/threadx#building-and-using-the-library) as the dependency. 124 1251. Cloning the repo. NetX Duo has a couple of dependencies that are included as submodules. 126 127 ```bash 128 $ git clone --recursive https://github.com/azure-rtos/netxduo.git 129 ``` 130 1311. 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`](https://github.com/azure-rtos/netxduo/blob/master/common/inc/nx_user_sample.h) as an example. 132 1331. Building as a static library 134 135 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()`. 136 137 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. 138 139 An example of building the library for Cortex-M4: 140 141 ```bash 142 $ cmake -Bbuild -GNinja -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake . 143 144 $ cmake --build ./build 145 ``` 146 147## Professional support 148 149[Professional support plans](https://azure.microsoft.com/support/options/) are available from Microsoft. For community support and others, see the [Resources](#resources) section below. 150 151## Licensing 152 153License 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](./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. 154 155## Resources 156 157The following are references to additional Azure RTOS resources: 158 159- **Product introduction and white papers**: https://azure.com/rtos 160- **General technical questions**: https://aka.ms/QnA/azure-rtos 161- **Product issues and bugs, or feature requests**: https://github.com/azure-rtos/netxduo/issues 162- **Licensing and sales questions**: https://aka.ms/azrtos-license 163- **Product roadmap and support policy**: https://aka.ms/azrtos/lts 164- **Blogs and videos**: http://msiotblog.com and https://aka.ms/iotshow 165- **Azure RTOS TraceX Installer**: https://aka.ms/azrtos-tracex-installer 166 167You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+netxduo) or ask new ones on StackOverflow using the `azure-rtos` and `netxduo` tags. 168 169## Security 170 171Azure 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. 172 173## Contribution 174 175Please follow the instructions provided in the [CONTRIBUTING.md](./CONTRIBUTING.md) for the corresponding repository. 176
