1# Eclipse ThreadX NetX Duo 2 3This advanced, industrial-grade TCP/IP network stack is designed specifically for deeply embedded real-time and IoT applications. Eclipse ThreadX NetX Duo is a dual IPv4 and IPv6 network stack. 4 5Here are the key features and modules of NetX Duo: 6 7 8 9## Getting Started 10 11NetX Duo as part of Eclipse ThreadX 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/eclipse-threadx/getting-started) and [samples](https://github.com/eclipse-threadx/samples) using hero development boards from semiconductors you can build and test with. 14 15See [Overview of Eclipse ThreadX NetX Duo](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/overview-netx-duo.md) for the high-level overview. 16 17## Repository Structure and Usage 18 19### Directory layout 20 21 . 22 ├── addons # NetX Duo addon modules for protocols and connectivity 23 ├── cmake # CMakeList files for building the project 24 ├── common # Core NetX Duo files 25 ├── crypto_libraries # NetX Crypto files 26 ├── nx_secure # NetX Secure files 27 ├── ports # Architecture and compiler specific files 28 ├── samples # Sample codes 29 ├── utility # Test cases and utilities (e.g. iperf) 30 ├── LICENSE.txt # License terms 31 ├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors 32 ├── CONTRIBUTING.md # Contribution guidance 33 └── SECURITY.md # Microsoft repo security guidance 34 35### Branches & Releases 36 37The 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`. 38 39> 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. 40``` 41/**************************************************************************/ 42/* */ 43/* FUNCTION RELEASE */ 44/* */ 45/* _tx_initialize_low_level Cortex-M23/GNU */ 46/* 6.x */ 47/* AUTHOR */ 48/* */ 49/* Scott Larson, Microsoft Corporation */ 50/* */ 51/* DESCRIPTION */ 52/* */ 53/* This function is responsible for any low-level processor */ 54/* initialization, including setting up interrupt vectors, setting */ 55/* up a periodic timer interrupt source, saving the system stack */ 56/* pointer for use in ISR processing later, and finding the first */ 57/* available RAM memory address for tx_application_define. */ 58/* */ 59/* INPUT */ 60/* */ 61/* None */ 62/* */ 63/* OUTPUT */ 64/* */ 65/* None */ 66/* */ 67/* CALLS */ 68/* */ 69/* None */ 70/* */ 71/* CALLED BY */ 72/* */ 73/* _tx_initialize_kernel_enter ThreadX entry function */ 74/* */ 75/* RELEASE HISTORY */ 76/* */ 77/* DATE NAME DESCRIPTION */ 78/* */ 79/* 09-30-2020 Scott Larson Initial Version 6.1 */ 80/* xx-xx-xxxx Scott Larson Include tx_user.h, */ 81/* resulting in version 6.x */ 82/* */ 83/**************************************************************************/ 84``` 85 86## Protocols and connectivity 87 88Protocols and connectivity support are provided as addon modules within NetX Duo in `addons` folder. Some key modules are: [**azure_iot**](https://github.com/eclipse-threadx/netxduo/tree/master/addons/azure_iot), [**dhcp**](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/netx-duo-dhcp-client/chapter1.md), [**dns**](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/netx-duo-dns/chapter1.md), [**ftp**](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/netx-duo-ftp/chapter1.md), [**http**](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/netx-duo-http/Chapter1.md), [**mqtt**](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/netx-duo-mqtt/chapter1.md), [**pop3**](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/netx-duo-pop3-client/chapter1.md), [**ppp**](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/netx-duo-ppp/chapter1.md), [**rtp**](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/netx-duo-rtp/chapter1.md), [**rtsp**](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/netx-duo-rtsp/chapter1.md), [**sntp**](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/netx-duo-sntp-client/chapter1.md), and [**web**](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/netx-duo-telnet/chapter1.md). For a full list of NetX Duo addons, you can find in the same [Eclipse ThreadX NetX Duo documentation](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/netx-duo/overview-netx-duo.md). 89 90### Samples 91 92We provide sample codes about how to use various addons in the [`samples`](./samples/) folder. 93 94## Component dependencies 95 96The main components of Eclipse ThreadX 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. 97 98 99 100> You will have to take the dependency graph above into account when building anything other than ThreadX itself. 101 102### Building and using the library 103 104Instruction 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 Eclipse ThreadX components as explained in the [Getting Started](#getting-started) section. 105 1061. Install the following tools: 107 108 * [CMake](https://cmake.org/download/) version 3.0 or later 109 * [Arm GNU Toolchain for arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) 110 * [Ninja](https://ninja-build.org/) 111 1121. Build the [ThreadX library](https://github.com/eclipse-threadx/threadx#building-and-using-the-library) as the dependency. 113 1141. Cloning the repo. NetX Duo has a couple of dependencies that are included as submodules. 115 116 ```bash 117 $ git clone --recursive https://github.com/eclipse-threadx/netxduo.git 118 ``` 119 1201. 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/eclipse-threadx/netxduo/blob/master/common/inc/nx_user_sample.h) as an example. 121 1221. Building as a static library 123 124 Each component of Eclipse ThreadX 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()`. 125 126 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. 127 128 An example of building the library for Cortex-M4: 129 130 ```bash 131 $ cmake -Bbuild -GNinja -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake . 132 133 $ cmake --build ./build 134 ``` 135 136## Licensing 137 138License terms for using Eclipse ThreadX are defined in the LICENSE.txt file of this repo. Please refer to this file for all definitive licensing information. 139 140## Resources 141 142The following are references to additional Eclipse ThreadX resources: 143 144- **Product introduction**: https://github.com/eclipse-threadx/rtos-docs 145- **Product issues and bugs, or feature requests**: https://github.com/eclipse-threadx/netxduo/issues 146- **TraceX Installer**: https://aka.ms/azrtos-tracex-installer 147 148You can also check [previous questions](https://stackoverflow.com/questions/tagged/threadx-rtos+netxduo) or ask new ones on StackOverflow using the `threadx-rtos` and `netxduo` tags. 149 150## Security 151 152Eclipse ThreadX 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. 153 154## Contribution 155 156Please follow the instructions provided in the [CONTRIBUTING.md](./CONTRIBUTING.md) for the corresponding repository. 157
