diff options
Diffstat (limited to 'FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_IPv6_Demo/IPv6_Multi_WinSim_demo/ReadMe.md')
| -rw-r--r-- | FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_IPv6_Demo/IPv6_Multi_WinSim_demo/ReadMe.md | 168 |
1 files changed, 168 insertions, 0 deletions
diff --git a/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_IPv6_Demo/IPv6_Multi_WinSim_demo/ReadMe.md b/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_IPv6_Demo/IPv6_Multi_WinSim_demo/ReadMe.md new file mode 100644 index 000000000..e08171cc5 --- /dev/null +++ b/FreeRTOS-Plus/Demo/FreeRTOS_Plus_TCP_IPv6_Demo/IPv6_Multi_WinSim_demo/ReadMe.md @@ -0,0 +1,168 @@ +# FreeRTOS+TCP IPv6 Demo + +The FreeRTOS+TCP IPv6/multiple-interface source code and example projects are +currently provided in the FreeRTOS+TCP repository's "feature/ipv6_multi_beta" +branch. These demos only require the FreeRTOS+TCP IPv6/multiple Interface +source code and the FreeRTOS-Kernel. + +## Setting up the workspace: + +Clone the submodules used in the FreeRTOS repo: + +`git submodule update --init --recursive` + +Make sure the FreeRTOS+TCP submodule is pointing to the [`dev/IPv6_integration`](https://github.com/FreeRTOS/FreeRTOS-Plus-TCP/tree/dev/IPv6_integration) branch +by checking: + +``` sh +cd FreeRTOS-Plus\Source\FreeRTOS-Plus-TCP +git status +``` + +If not checkout to `dev/IPv6_integration`: + +`git checkout dev/IPv6_integration` + +Update submodules: + +``` sh +git submodule update --init --recursive +git submodule update --checkout +``` + +The FreeRTOS+TCP Multiple Interface Visual Studio project file is in the following +directory: `FreeRTOS-Plus\Demo\FreeRTOS_Plus_TCP_IPv6_Demo\IPv6_Multi_WinSim_dem` + +In FreeRTOS_Plus_TCP_IPv6_Multi.props, you will find a couple of macros that indicate +the location of source files: + +- FREERTOS_SOURCE_DIR The kernel sources +- FREERTOS_INCLUDE_DIR The kernel header files +- DEMO_COMMON_SOURCE_DIR The location of the "common" directory of the demos +- PLUS_TCP_SOURCE_DIR The FreeRTOS+TCP source files +- PLUS_TCP_INCLUDE_DIR> The FreeRTOS+TCP header files +- UTILITIES_SOURCE_DIR The location of the tcp_utilities directory + +You can changes these directory to let the proyejct work with a different +source tree. + +The Multiple Interface Visual studio demo showcases the Multiple Interfaces (or +rather the multiple endpoints) functionality of the FreeRTOS+TCP +IPv6/multi-interface library. The Windows Simulator environment doesn't actually +have multiple interfaces which can be used by FreeRTOS and thus, this demo shows +the use of different endpoints which will be resolved by the OS having multiple +interfaces. It shows that the library will use different endpoints (IP-addresses) +to connect to IP-addresses on different subnets (or using different netmasks). +The instructions for the full Windows demo are still relevant though as they +describe how to set up the WinPCap development environment, how to set the IP +address, and other such items. Note that, as delivered, configUSE_DHCP is set to 0, +so a static IP address is used. The instructions are provided on the following URL, +see the "Hardware Setup" section: +http://www.FreeRTOS.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/examples_FreeRTOS_simulator.html + +The IPv6_Multi_WinSim_demo demo performs some basic network activities: + +- ARP address resolution for IPv4 addresses on the LAN +- Neighbour Discovery for IPv6 addresses on the LAN +- Looking up a IPv4 or IPv6 address using DNS, either asynchronous or synchronous. +- Looking up a local host ( IPv4/6 ) using LLMNR ( not considered safe anymore ) +- Talk with an NTP server and fetch the time using UDP, with IPv4/6 +- Download a file from any public server using TCP/HTTP +- Ping any server on the web or on the LAN, , with IPv4 or IPv6 + +The demo can be easily adapted to your own needs. It works like a command line +interface ( CLI ) that performs the above tasks. + +Here are some examples of valid command lines, using the keywords “http”, “ping”, +“dnsq”, and “ntp: + + "http4 google.co.uk /index.html", + "http6 amazon.com /index.html", + "ping4 10.0.1.10", + "ping6 2001:470:ec54::", + "dnsq4 yahoo.com", + "ping6 aws.com", + "ntp6a 2.europe.pool.ntp.org", + +The last line will first lookup the mentioned NTP server, send a request, and wait +for a reply. The time will be printed in the logging. + +Although it is called a CLI, the demo does not have a STDIN. The commands are +hard-coded in main.c + +The keywords can have some single-letter suffices: 4 or 6 ( for IPv4/6 ), “a” to do +an asynchronous DNS lookup, and “c” to clear all caches before starting the task. + + +## Using the UDP Echo Client + +The demo also demonstrates a IPv4/IPv6 UDP echo client which can be enabled by +setting the `mainCREATE_UDP_ECHO_SERVER_TASK` macro to 1 in the main file. + +The UDP Echo Client creates a task and sends messages to the IP address and port +defined as `configECHO_SERVER_ADDR_STRING` (either v4 or v6 address) +and configECHO_SERVER_PORT respectively in the FreeRTOSConfig.h file and expect to +get echo of the messages back. There should be a UDP echo server running in the +given IP and port. + + +#### Sample UDP echo server in Go: + +``` go + +// Filename: echo_server.go +// Run: go run echo_server.go <ip_address>:<port> +// Example IPv4: go run echo_server.go 192.168.1.2:9000 +// Example IPv6: go run echo_server.go [fe80::1b99:a6bd:a344:b09d]:9000 + +package main + +import ( + "fmt" + "net" + "os" +) + +func main() { + + if len(os.Args) == 1 { + fmt.Println("Please provide host:port") + os.Exit(1) + } + + // Resolve the string address to a UDP address + udpAddr, err := net.ResolveUDPAddr("udp", os.Args[1]) + + if err != nil { + fmt.Println(err) + os.Exit(1) + } + + // Start listening for UDP packages on the given address + conn, err := net.ListenUDP("udp", udpAddr) + + if err != nil { + fmt.Println(err) + os.Exit(1) + } + + // Read from UDP listener + for { + var buf [1024]byte + _, addr, err := conn.ReadFromUDP(buf[0:]) + if err != nil { + fmt.Println(err) + return + } + + fmt.Print(string(buf[0:])) + + // Write back the message over UDP + conn.WriteToUDP([]byte(buf[0:]), addr) + } +} +``` + +The UDP Echo Client demo also demonstrates the UDP zero copy for both IPv4 and IPv6 +(based on the IP type), it can be enabled by setting `USE_ZERO_COPY` macro of the +UDPEchoClient_SingleTasks.c file to 1.
\ No newline at end of file |