Synergy Software Package User's Manual
Azure RTOS NetX Overview

Azure RTOS NetX Interface

Azure RTOS NetX is a high-performance real-time implementation of the TCP/IP standards designed exclusively for embedded ThreadX-based applications. The Azure RTOS NetX networking stack (nx) is integrated into the Renesas SSP. The Azure RTOS NetX Interface provides the means for SSP projects to access the capabilities of NetX.

For more information about NetX (including API references), refer to the NetX User Guide available as part of the Azure RTOS Components documentation pack here: https://www.renesas.com/en-us/products/synergy/software/ssp.html 

Unsupported Features

The following driver requests are not implemented in sf_el_nx:

  • Get link speed
  • Get duplex type
  • Get error count
  • Get receive packet count
  • Get transmit packet count
  • Get allocation errors
  • User commands  

Azure RTOS NetX with TraceX

If TraceX is enabled in the ThreadX source component, it is automatically included when adding the NetX source components. When enabled, the project containing the ThreadX and NetX library must be rebuilt or TraceX macros that log events will not be executed.

Azure RTOS NetX Protocol Modules

A wide variety of popular networking protocol functions are supported within the Azure RTOS NetX Interface for SSP. Each available protocol function has its own module overview section in this document. These overviews provide sufficient background to determine if the module provides the functions needed by the application.

Complete Application Projects (APs) are also available showing a working project for a typical NetX Protocol application targeted for a Renesas Synergy hardware kit. APs are available from the Renesas Synergy web site here: https://www.renesas.com/us/en/support/document-search?title=&doc_file_all_types%5BSample+Code%5D=Sample+Code&doc_category_tier_1=467666&doc_category_tier_2=469306&doc_category_tier_3=&doc_category_tier_4=&doc_part_numbers=&sort_order=DESC&sort_by=field_document_revision_date

Azure RTOS NetX Configuration Notes

When a protocol module is added to a project, a prebuilt library of the application code is added. For each protocol component, there is an analogous component ending in '_src' that contains protected source files. The '_src' component can be added in addition to the prebuilt library module. Do not add the '_src' component without the prebuilt library module.

If the NetX Source module is added to the project, the Properties window provides advanced configurations for the NetX source library. Highlight a configuration option to view a description of the option in the bottom left corner of the e2 studio GUI. If the configuration option is empty, the default value is used. The default values of configuration options are defined in ssp/inc/framework/el/nx/nx_port.h. Refer to the Configuration Options chapter of the NetX User Guide for more information.

A detailed NetX and NetX Duo Source Module Overview is available in this document. It covers the configurable networking operations available within the source module. It is highly recommended that this is read and understood before attempting to modify any NetX or NetX Duo source configuration settings.

Azure RTOS NetX Limitations

  • Azure RTOS NetX cannot be used in the same application as Azure RTOS NetX Duo. Only one or the other can be used per application.
  • When using NetX BSD with the GCC compiler, build with the macro _POSIX_SOURCE defined to avoid compilation errors.
  • Refer to the most recent SSP Release Notes for any additional operational limitations for this module.

Azure RTOS NetX Supported Devices

  • Refer to the associated SSP Release Notes for a complete list of the supported MCU devices.