Kapitel 2: Installation und Verwendung von Azure RTOS NetX Duo TFTP (2024)

Dieses Kapitel enthält eine Beschreibung verschiedener Probleme im Zusammenhang mit der Installation, Einrichtung und Verwendung der Azure RTOS NetX Duo TFTP-Komponente.

Produktverteilung

Azure RTOS NetX Duo können Sie aus unserem öffentlichen Quellcoderepository unter https://github.com/azure-rtos/netxduo/ beziehen. Das Paket enthält die folgenden Dateien:

• nxd_ftp_client.h: Headerdatei für den NetX Duo TFTP-Client

• nxd_ftp_client.c: C-Quelldatei für den NetX Duo TFTP-Client

• nxd_ftp_server.h: Headerdatei für den NetX Duo TFTP-Server

• nxd_ftp_server.c: C-Quelldatei für den NetX Duo TFTP-Server

• filex_stub.h: Stubdatei, wenn FileX nicht vorhanden ist

• nxd_tftp.pdf: PDF-Beschreibung von NetX Duo TFTP

• demo_netxduo_tftp.c: NetX Duo TFTP-Demonstration

TFTP-Installation

Um NetX Duo-TFTP nutzen zu können, muss die gesamte zuvor genannte Verteilung in dasselbe Verzeichnis kopiert werden, in dem auch NetX Duo installiert ist. Wenn NetX Duo z.B. im Verzeichnis „ \threadx\arm7\green“ installiert ist, könnten die Dateien nxd_tftp_client.h, nxd_tftp_client.c, nxd_tftp_server.h und nxd_tftp_server.c in dieses Verzeichnis kopiert werden.

Verwenden von TFTP

Um eine TFTP-Anwendung auszuführen, muss der Anwendungscode nxd_tftp_client.h und/oder „nxd_tftp_server.h“ einschließen, nachdem er tx_api.h, fx_api.h, und nx_api.h einschließt, um ThreadX, FileX bzw. NetX Duo zu verwenden. Das Anwendungsprojekt muss auch nxd_tftp_client.c und/oder nxd_tftp_server.c im Buildprozess einschließen. Diese Dateien müssen auf die gleiche Weise wie andere Anwendungsdateien kompiliert werden, und ihre Objektform muss zusammen mit den Dateien der Anwendung verknüpft werden. Dies ist alles, was für den Einsatz von NetX Duo TFTP erforderlich ist. Sobald die Headerdatei(en) eingebunden ist/sind, ist der Anwendungscode in der Lage, TFTP-Dienste zu nutzen.

Kleines Beispielsystem

Ein Beispiel dafür, wie einfach die Verwendung von NetX Duo TFTP ist, finden Sie in der unten angezeigten Abbildung1.1. In diesem Beispiel werden die TFTP-Include-Dateien nxd_tftp_client.h und nxd_tftp_server.h in Zeile19 und20 eingebracht. Als Nächstes wird der TFTP-Server in „tx_application_define“ in Zeile179 erstellt.

Der Threadtask des TFTP-Servers wird beendet und der TFTP-Server wird in Zeile 324 gelöscht. Die Anwendung sollte „fx_media_close“ (Zeile 331) aufrufen, um alle Dateien zu schließen und Datei- und Verzeichnisdaten auf dem USB-Medium zu aktualisieren.

• nxd_tftp_server_start

• nxd_tftp_server_stop

• nxd_tftp_client_file_read

• nxd_tftp_client_file_write

• nxd_tftp_client_file_open

/* This is a small demo of TFTP on the high-performance NetX TCP/IP stack. This demo relies on ThreadX and NetX Duo, to show a simple file transfer from the client and then back to the server. *//* Indicate if using IPv6. */#define USE_DUO/* If the host application is using NetX Duo, determine which IP version to use. Make sure IPv6 in NetX Duo is enabled if planning to use TFTP over IPv6 */#ifdef USE_DUO#define IP_TYPE 6#endif /* USE_DUO */#include "tx_api.h"#include "nx_api.h"#include "nxd_tftp_client.h"#include "nxd_tftp_server.h"#ifndef NX_TFTP_NO_FILEX#include "fx_api.h"#endif#define DEMO_STACK_SIZE 4096/* To use another file storage utility define this symbol:#define NX_TFTP_NO_FILEX*//* Define the ThreadX, NetX, and FileX object control blocks... */TX_THREAD server_thread;TX_THREAD client_thread;NX_PACKET_POOL server_pool;NX_IP server_ip;NX_PACKET_POOL client_pool;NX_IP client_ip;FX_MEDIA ram_disk;/* Define the NetX TFTP object control blocks. */NX_TFTP_CLIENT client;NX_TFTP_SERVER server;/* Define the application global variables */#define CLIENT_ADDRESS IP_ADDRESS(1, 2, 3, 5)#define SERVER_ADDRESS IP_ADDRESS(1, 2, 3, 4)NXD_ADDRESS server_ip_address;NXD_ADDRESS client_ip_address;UINT error_counter = 0;/* Define buffer used in the demo application. */UCHAR buffer[255];ULONG data_length;/* Define the memory area for the FileX RAM disk. */#ifndef NX_TFTP_NO_FILEXUCHAR ram_disk_memory[32000];UCHAR ram_disk_sector_cache[512];#endif/* Define function prototypes. */VOID _fx_ram_driver(FX_MEDIA *media_ptr);VOID _nx_ram_network_driver(NX_IP_DRIVER *driver_req_ptr);void client_thread_entry(ULONG thread_input);void server_thread_entry(ULONG thread_input);/* Define main entry point. */int main(){ /* Enter the ThreadX kernel. */ tx_kernel_enter();}/* Define what the initial system looks like. */void tx_application_define(void *first_unused_memory){UINT status;UCHAR *pointer; /* Setup the working pointer. */ pointer = (UCHAR *) first_unused_memory; /* Create the main TFTP server thread. */ status = tx_thread_create(&server_thread, "TFTP Server Thread", server_thread_entry, 0, pointer, DEMO_STACK_SIZE, 4,4, TX_NO_TIME_SLICE, TX_AUTO_START); pointer += DEMO_STACK_SIZE ; /* Check for errors. */ if (status) error_counter++; /* Create the main TFTP client thread at a slightly lower priority. */ status = tx_thread_create(&client_thread, "TFTP Client Thread", client_thread_entry, 0, pointer, DEMO_STACK_SIZE, 5, 5, TX_NO_TIME_SLICE, TX_DONT_START); pointer += DEMO_STACK_SIZE ; /* Check for errors. */ if (status) error_counter++; /* Initialize the NetX system. */ nx_system_initialize(); /* Note: The data portion of a packet is exactly 512 bytes, but the packet payload size must be at least 580 bytes. The remaining bytes are used for the UDP, IP, and Ethernet headers and byte alignment requirements. */ status = nx_packet_pool_create(&server_pool, "TFTP Server Packet Pool", NX_TFTP_PACKET_SIZE, pointer, 8192); pointer = pointer + 8192; /* Check for errors. */ if (status) error_counter++; /* Create the IP instance for the TFTP Server. */ status = nx_ip_create(&server_ip, "NetX Server IP Instance", SERVER_ADDRESS, 0xFFFFFF00UL, &server_pool, _nx_ram_network_driver, pointer, 2048, 1); pointer = pointer + 2048; /* Check for errors. */ if (status) error_counter++; /* Enable ARP and supply ARP cache memory for IP Instance 0. */ status = nx_arp_enable(&server_ip, (void *) pointer, 1024); pointer = pointer + 1024; /* Check for errors. */ if (status) error_counter++; /* Enable UDP. */ status = nx_udp_enable(&server_ip); /* Check for errors. */ if (status) error_counter++; /* Create the TFTP server. */#ifdef USE_DUO#if (IP_TYPE == 6)#ifdef FEATURE_NX_IPV6 /* Specify the tftp server global address. */ server_ip_address.nxd_ip_version = NX_IP_VERSION_V6; server_ip_address.nxd_ip_address.v6[0] = 0x20010db1; server_ip_address.nxd_ip_address.v6[1] = 0xf101; server_ip_address.nxd_ip_address.v6[2] = 0; server_ip_address.nxd_ip_address.v6[3] = 0x102;#endif#else server_ip_address.nxd_ip_version = NX_IP_VERSION_V4; server_ip_address.nxd_ip_address.v4 = SERVER_ADDRESS;#endif status = nxd_tftp_server_create(&server, "TFTP Server Instance", &server_ip, &ram_disk, pointer, DEMO_STACK_SIZE, &server_pool);#else status = nx_tftp_server_create(&server, "TFTP Server Instance", &server_ip, &ram_disk, pointer, DEMO_STACK_SIZE, &server_pool);#endif pointer = pointer + DEMO_STACK_SIZE; /* Check for errors for the server. */ if (status) error_counter++; /* Create a packet pool for the TFTP client. */ /* Note: The data portion of a packet is exactly 512 bytes, but the packet payload size must be at least 580 bytes. The remaining bytes are used for the UDP, IP, and Ethernet headers and byte alignment requirements. */ status = nx_packet_pool_create(&client_pool, "TFTP Client Packet Pool", NX_TFTP_PACKET_SIZE, pointer, 8192); pointer = pointer + 8192; /* Create an IP instance for the TFTP client. */ status = nx_ip_create(&client_ip, "TFTP Client IP Instance", CLIENT_ADDRESS, 0xFFFFFF00UL, &client_pool, _nx_ram_network_driver, pointer, 2048, 1); pointer = pointer + 2048; /* Enable ARP and supply ARP cache memory for IP Instance 1. */ status = nx_arp_enable(&client_ip, (void *) pointer, 1024); pointer = pointer + 1024; /* Enable UDP for client IP instance. */ status |= nx_udp_enable(&client_ip); status |= nx_icmp_enable(&client_ip); tx_thread_resume(&client_thread);}void server_thread_entry(ULONG thread_input){UINT status, running;#if (IP_TYPE == 6)#ifdef FEATURE_NX_IPV6UINT address_index;UINT iface_index;#endif#endif /* Allow time for the network driver and NetX to get initialized. */ tx_thread_sleep(100);#ifndef NX_TFTP_NO_FILEX /* Format the RAM disk - the memory for the RAM disk was defined above. */ status = fx_media_format(&ram_disk, _fx_ram_driver, /* Driver entry */ ram_disk_memory, /* RAM disk memory pointer */ ram_disk_sector_cache, /* Media buffer pointer */ sizeof(ram_disk_sector_cache), /* Media buffer size */ "MY_RAM_DISK", /* Volume Name */ 1, /* Number of FATs */ 32, /* Directory Entries */ 0, /* Hidden sectors */ 256, /* Total sectors */ 128, /* Sector size */ 1, /* Sectors per cluster */ 1, /* Heads */ 1); /* Sectors per track */ /* Check for errors. */ if (status != FX_SUCCESS) { return; } /* Open the RAM disk. */ status = fx_media_open(&ram_disk, "RAM DISK", _fx_ram_driver, ram_disk_memory, ram_disk_sector_cache, sizeof(ram_disk_sector_cache)); /* Check for errors. */ if (status != FX_SUCCESS) { return; }#endif /* NX_TFTP_NO_FILEX */#if (IP_TYPE == 6)#ifdef FEATURE_NX_IPV6 /* Enable ICMPv6 services. */ status |= nxd_icmp_enable(&server_ip); if (status != NX_SUCCESS) { return; } /* Enable IPv6 services for the server. */ status = nxd_ipv6_enable(&server_ip); if (status != NX_SUCCESS) { return; } /* This assumes the primary interface. See the NetX Duo User Guide for more information on address configuration. */ iface_index = 0; status = nxd_ipv6_address_set(&server_ip, iface_index, NX_NULL, 10, &address_index); status += nxd_ipv6_address_set(&server_ip, iface_index, &server_ip_address, 64, &address_index); if (status != NX_SUCCESS) { return; } /* Wait for DAD to validate the address. */ tx_thread_sleep(500);#endif#endif /* IP_TYPE == 6 */ /* Start the NetX TFTP server. */#ifdef USE_DUO status = nxd_tftp_server_start(&server);#else status = nx_tftp_server_start(&server);#endif /* Check for errors. */ if (status) { error_counter++; return; } /* Run for a while */ running = NX_TRUE; while(running) tx_thread_sleep(200); /* Stop and delete the TFTP server. */#ifdef USE_DUO nxd_tftp_server_delete(&server);#else nx_tftp_server_delete(&server);#endif /* Close all open files and ensure directory information is also written out to the media. This will also flush the file data to USB media*/ status = fx_media_close(&ram_disk); if (status) { error_counter++; } return;}/* Define the TFTP client thread. */void client_thread_entry(ULONG thread_input){NX_PACKET *my_packet;UINT status;UINT all_done = NX_FALSE;#if (IP_TYPE == 6)#ifdef FEATURE_NX_IPV6UINT address_index;UINT iface_index;#endif#endif /* Allow time for the network driver and NetX to get initialized. */ tx_thread_sleep(100);#if (IP_TYPE == 6)#ifdef FEATURE_NX_IPV6 /* Enable ECMPv6 services for the client. */ status = nxd_icmp_enable(&client_ip); if (status != NX_SUCCESS) { return; } /* Enable IPv6 services for the client. */ status = nxd_ipv6_enable(&client_ip); if (status != NX_SUCCESS) { return; } /* Set the Client IPv6 address */ client_ip_address.nxd_ip_version = NX_IP_VERSION_V6; client_ip_address.nxd_ip_address.v6[0] = 0x20010db1; client_ip_address.nxd_ip_address.v6[1] = 0xf101; client_ip_address.nxd_ip_address.v6[2] = 0; client_ip_address.nxd_ip_address.v6[3] = 0x101; /* This assumes the primary interface. See the NetX Duo User Guide for more information on address configuration. */ iface_index = 0; status = nxd_ipv6_address_set(&client_ip, iface_index, NX_NULL, 10, &address_index); status += nxd_ipv6_address_set(&client_ip, iface_index, &client_ip_address, 64, &address_index); if (status != NX_SUCCESS) { return; } /* Wait for the link local and global addresses to be validated. */ tx_thread_sleep(500);#endif#endif /*(IP_TYPE == 6) */ /* The TFTP services used below include the NetX equivalent service which will work with NetX Duo TFTP. However, it is recommended for developers to port their applications to the newer services that take the NXD_ADDRESS type and support both IPv4 and IPv6 communication. */ /* Create a TFTP client. */#ifdef USE_DUO status = nxd_tftp_client_create(&client, "TFTP Client", &client_ip, &client_pool, IP_TYPE);#else status = nx_tftp_client_create(&client, "TFTP Client", &client_ip, &client_pool);#endif /* Check status. */ if (status) return; /* Open a TFTP file for writing. */#ifdef USE_DUO status = nxd_tftp_client_file_open(&client, "test.txt", &server_ip_address, NX_TFTP_OPEN_FOR_WRITE, 100, IP_TYPE);#else status = nx_tftp_client_file_open(&client, "test.txt", SERVER_ADDRESS, NX_TFTP_OPEN_FOR_WRITE, 100);#endif /* Check status. */ if (status) return; /* Allocate a TFTP packet. */#ifdef USE_DUO status = nxd_tftp_client_packet_allocate(&client_pool, &my_packet, 100, IP_TYPE);#else status = nx_tftp_client_packet_allocate(&client_pool, &my_packet, 100);#endif /* Check status. */ if (status) error_counter++; /* Write ABCs into the packet payload! */ memcpy(my_packet -> nx_packet_prepend_ptr, "ABCDEFGHIJKLMNOPQRSTUVWXYZ ", 28); /* Adjust the write pointer. */ my_packet -> nx_packet_length = 28; my_packet -> nx_packet_append_ptr = my_packet -> nx_packet_prepend_ptr + 28; /* Write this packet to the file via TFTP. */#ifdef USE_DUO status = nxd_tftp_client_file_write(&client, my_packet, 100, IP_TYPE);#else status = nx_tftp_client_file_write(&client, my_packet, 100);#endif /* Check status. */ if (status) error_counter++; /* Close this file. */#ifdef USE_DUO status = nxd_tftp_client_file_close(&client, IP_TYPE);#else status = nx_tftp_client_file_close(&client);#endif /* Check status. */ if (status) error_counter++; /* Open the same file for reading. */#ifdef USE_DUO status = nxd_tftp_client_file_open(&client, "test.txt", &server_ip_address, NX_TFTP_OPEN_FOR_READ, 100, IP_TYPE);#else status = nx_tftp_client_file_open(&client, "test.txt", SERVER_ADDRESS, NX_TFTP_OPEN_FOR_READ, 100);#endif /* Check status. */ if (status) error_counter++; do { /* Read the file back. */#ifdef USE_DUO status = nxd_tftp_client_file_read(&client, &my_packet, 100, IP_TYPE);#else status = nx_tftp_client_file_read(&client, &my_packet, 100);#endif /* Check for retranmission/dropped packet error. Benign. Try again... */ if (status == NX_TFTP_INVALID_BLOCK_NUMBER) { continue; } else if (status == NX_TFTP_END_OF_FILE) { /* All done. */ all_done = NX_TRUE; } else if (status != NX_SUCCESS) { /* Internal error, invalid packet or error on read. */ break; } /* Do something with the packet data and release when done. */ nx_packet_data_retrieve(my_packet, buffer, &data_length); buffer[data_length] = 0; printf("Receive data: %s\n", buffer); printf("release packet in demo.\n"); nx_packet_release(my_packet); } while (all_done == NX_FALSE); /* Close the file again. */#ifdef USE_DUO status = nxd_tftp_client_file_close(&client, IP_TYPE);#else status = nx_tftp_client_file_close(&client);#endif /* Check status. */ if (status) error_counter++; /* Delete the client. */#ifdef USE_DUO status = nxd_tftp_client_delete(&client);#else status = nx_tftp_client_delete(&client);#endif /* Check status. */ if (status) error_counter++; return;}

Abbildung1.1: Beispiel für die Verwendung von TFTP mit NetX Duo

Konfigurationsoptionen

Für das Erstellen von NetX Duo TFTP gibt es mehrere Konfigurationsmöglichkeiten. In der folgenden Liste wird jede einzeln und detailliert beschrieben. Sofern nicht anders angegeben, befinden sich diese Optionen in nxd_tftp_client.h und nxd_tftp_server.h.

• NX_DISABLE_ERROR_CHECKING: Wenn definiert, wird mit dieser Option die grundlegende TFTP-Fehlerüberprüfung entfernt. Sie wird typischerweise nach dem Debuggen der Anwendung verwendet.

• NX_TFTP_SERVER_PRIORITY: Die Priorität des TFTP-Serverthreads. Standardmäßig ist dieser Wert auf 16 festgelegt, um die Priorität16 anzugeben.

• NX_TFTP_SERVER_TIME_SLICE: Das Zeitsegment, für das der TFTP-Server ausgeführt werden soll, bevor er anderen Threads mit der gleichen Priorität nachgibt. Der Standardwert ist 2.

• NX_TFTP_MAX_CLIENTS: Die maximale Anzahl von Clients, die der Server gleichzeitig verarbeiten kann. Standardmäßig ist dieser Wert10, um 10Clients gleichzeitig zu unterstützen.

• NX_TFTP_ERROR_STRING_MAX: Die maximale Anzahl von Zeichen in der Fehlerzeichenfolge. Standardmäßig ist dieser Wert64.

• NX_TFTP_NO_FILEX: Wenn definiert, bietet diese Option einen Stub für FileX-Abhängigkeiten. Der TFTP-Client funktioniert ohne jede Änderung, wenn diese Option definiert ist. Der TFTP-Server muss entweder modifiziert werden, oder der Benutzer muss eine paar FileX-Dienste erstellen, damit er richtig funktioniert.

• NX_TFTP_TYPE_OF_SERVICE: Typ des für die UDP-Anforderungen von TFTP erforderlichen Diensts. Standardmäßig ist dieser Wert als NX_IP_NORMAL definiert, um einen normalen IP-Paketdienst anzuzeigen.

• NX_TFTP_FRAGMENT_OPTION: Aktiviert die Fragmentierung für TFTP-UDP-Anforderungen. Standardmäßig ist dieser Wert NX_DONT_FRAGMENT, um die UDP-Fragmentierung von TFTP zu deaktivieren.

• NX_TFTP_TIME_TO_LIVE: Gibt die Anzahl der Router an, die dieses Paket passieren kann, bevor es verworfen wird. Standardmäßig ist der Wert auf 0x80 festgelegt.

• NX_TFTP_SOURCE_PORT: Mit dieser Option kann eine TFTP-Clientanwendung den UDP-Socketport des TFTP-Clients angeben. Der Standardwert ist NX_ANY_PORT.

• NX_TFTP_SERVER_RETRANSMIT_ENABLE Ermöglicht dem Timer des TFTP-Servers, jede TFTP-Clientsitzung mit auf aktuelle Aktivitäten (entweder ein ACK- oder ein Datenpaket) zu überprüfen. Wenn der Sitzungstimeout nach der maximalen Anzahl abläuft, wird angenommen, dass die Verbindung getrennt wurde. Der Server löscht die Clientanforderung, schließt alle offenen Dateien und stellt die Verbindungsanforderung für den nächsten Client zur Verfügung. Die Standardeinstellung ist „Disabled“ (Deaktiviert).

• NX_TFTP_SERVER_TIMEOUT_PERIOD: Gibt das Intervall an, in dem die Eintragsfunktion des Zeitgebers des TFTP-Servers Clientverbindungen auf den Empfang von Paketen überprüft. Der Standardwert beträgt 20 (Zeitgebertakte).

• NX_TFTP_SERVER_RETRANSMIT_TIMEOUT: Dies ist der Timeout für den Empfang einer gültigen ACK-Nachricht oder eines Datenpakets vom Client. Der Standardwert beträgt 200 (Zeitgebertakte) .

• NX_TFTP_SERVER_MAX_RETRIES: Gibt an, wie oft der Timeout für die erneute Übertragung der Clientsitzung maximal erneuert wird. Danach wird die Sitzung vom Server geschlossen.

• NX_TFTP_MAX_CLIENT_RETRANSMITS: Gibt an, wie oft der Server maximal eine doppelte ACK-Nachricht oder ein Datenpaket vom Client empfängt (das er verwirft), ohne eine Fehlermeldung an den Client zu senden und die Sitzung zu schließen. Dies hat keine Auswirkung, wenn NX_TFTP_SERVER_RETRANSMIT_ENABLE definiert ist.