Skip to content

Latest commit

 

History

History
145 lines (100 loc) · 6.58 KB

README.md

File metadata and controls

145 lines (100 loc) · 6.58 KB
Raw

Nx_UDP_Echo_Client application description

This application provides an example of Azure RTOS NetX/NetXDuo stack usage . It shows how to develop a NetX udp client to communicate with a remote sever using the NetX UDP socket API.

The main entry function tx_application_define() is called by ThreadX during kernel start, at this stage, all NetX resources are created.

  • A NX_PACKET_POOL is allocated
  • A NX_IP instance using that pool is initialized
  • The ARP, ICMP and UDP protocols are enabled for the NX_IP instance
  • A DHCP client is created.

The application then creates 2 threads with the same priorities:

  • AppMainThread (priority 10, PreemtionThreashold 10) : created with the TX_AUTO_START flag to start automatically.
  • AppUDPThread (priority 10, PreemtionThreashold 10) : created with the TX_DONT_START flag to be started later.

The AppMainThread starts and perform the following actions:

  • starts the DHCP client
  • waits for the IP address resolution
  • resumes the AppUDPThread

The AppUDPThread, once started:

  • creates a UDP socket
  • connects to the remote UDP server on the predefined port
  • On connection success, the UDP client sends a MAX_PACKET_COUNT messages to the server.
  • At each message sent, the UDP client reads the sever response and prints it on the Hyperterminal and the blue led is toggled.

Echotool utility

The echotool utility can be used to test UDP protocol with Nx_UDP_Echo_Server application

echotool.exe 192.168.1.2 /p udp /r 6000 Nx_UDP_Echo_Server application started.. STM32 IpAddress: 192.168.1.2 UDP Server listening on PORT 6000.

Expected success behavior

  • The board IP address is printed on the HyperTerminal
  • The response messages sent by the server are printed on the HyerTerminal
  • if the echotool utility is used the message sent by the client are displayed on the PC console.
  • a summary message similar to the following is printed on the HyperTerminal and the blue LED is toggling.
 SUCCESS : 10 / 10 packets sent

Error behaviors

  • the Red LED is toggling to indicate any error that have occurred.
  • In case the message exchange is not completed a failure message is printed on the HyperTerminal showing the actual sent message compared to the expected ones.

Assumptions if any

  • The application is using the DHCP to acquire IP address, thus a DHCP server should be reachable by the board in the LAN used to test the application.
  • The application is configuring the Ethernet IP with a static predefined MAC Address, make sure to change it in case multiple boards are connected on the same LAN to avoid any potential network traffic issues.
  • The application does not support Ethernet cable hot-plug, therefore the board should be connected to the LAN before running the application.
  • The MAC Address is defined in the main.c
void MX_ETH_Init(void)
{

  /* USER CODE BEGIN ETH_Init 0 */

  /* USER CODE END ETH_Init 0 */

  /* USER CODE BEGIN ETH_Init 1 */

  /* USER CODE END ETH_Init 1 */
  heth.Instance = ETH;
  heth.Init.MACAddr[0] =   0x00;
  heth.Init.MACAddr[1] =   0x80;
  heth.Init.MACAddr[2] =   0xE1;
  heth.Init.MACAddr[3] =   0x00;
  heth.Init.MACAddr[4] =   0x00;
  heth.Init.MACAddr[5] =   0x00;

Known limitations

None

Notes

Prerequisites

Before running the application :

  • The DDR memory need to be initialized with DDR_Init example.
  • The STM32MP135F-DK board should be connected to the LAN via the ethernet connector ETH1.

ThreadX usage hints

  • ThreadX uses the Systick as time base, thus it is mandatory that the HAL uses a separate time base through the TIM IPs.
  • ThreadX is configured with 100 ticks/sec by default, this should be taken into account when using delays or timeouts at application. It is always possible to reconfigure it in the "tx_user.h", the "TX_TIMER_TICKS_PER_SECOND" define,but this should be reflected in "tx_initialize_low_level.S" file too.
  • ThreadX is disabling all interrupts during kernel start-up to avoid any unexpected behavior, therefore all system related calls (HAL, BSP) should be done either at the beginning of the application or inside the thread entry functions.
  • ThreadX offers the "tx_application_define()" function, that is automatically called by the tx_kernel_enter() API. It is highly recommended to use it to create all applications ThreadX related resources (threads, semaphores, memory pools...) but it should not in any way contain a system API call (HAL or BSP).

NetX Duo usage hints

  • Depending on the application scenario, the total TX and RX descriptors may need to be increased by updating respectively the "ETH_TX_DESC_CNT" and "ETH_RX_DESC_CNT" in the "stm32h7xx_hal_conf.h", to guarantee the application correct behaviour, but this will cost extra memory to allocate.

Keywords

RTOS, Network, ThreadX, NetXDuo, UDP, UART

Hardware and Software environment

  • This application runs on STM32MP135xx devices
  • This application has been tested with STMicroelectronics STM32MP135F-DK boards and can be easily tailored to any other supported device and development board.
  • This application uses UART4 to display logs, the hyperterminal configuration is as follows:
    • BaudRate = 115200 baud
    • Word Length = 8 Bits
    • Stop Bit = 1
    • Parity = None
    • Flow control = None

How to use it ?

In order to make the program work, you must do the following :

  • Open your preferred toolchain

  • Edit the file NetXDuo/App/app_netxduo.h and correctly define the <UDP_SERVER_ADDRESS> and <UDP_SERVER_PORT> to connect on.

  • Rebuild and run DDR_Init example to initialize the DDR memory

  • Rebuild all files and load your image into target memory

  • For STM32CubeIDE, in order to keep DDR initialized, please remove "monitor reset" line in "Debug Configurations->Startup>Initialization Commands"

  • Run the application

  • run the echotool utility on a windows console as following:

    c:\> .\echotool.exe /p udp /s <UDP_SERVER_PORT> 
    
example : c:\> .\echotool.exe /p udp /s 6001