diff options
author | Gregory Nutt <gnutt@nuttx.org> | 2014-11-17 10:53:43 -0600 |
---|---|---|
committer | Gregory Nutt <gnutt@nuttx.org> | 2014-11-17 10:53:43 -0600 |
commit | 9996595fb7029c62fafba82230eb9d8d8927f3fc (patch) | |
tree | 6fa226cbdce16dc2866cfee91eb55f0671a9e502 /apps/examples/README.txt | |
parent | 024a5a638a19767988dbcecb920f021344fdb190 (diff) | |
download | px4-nuttx-9996595fb7029c62fafba82230eb9d8d8927f3fc.tar.gz px4-nuttx-9996595fb7029c62fafba82230eb9d8d8927f3fc.tar.bz2 px4-nuttx-9996595fb7029c62fafba82230eb9d8d8927f3fc.zip |
apps/examples/bridge: Add a simple UDP relay bridge for testing configurations with multiple networks
Diffstat (limited to 'apps/examples/README.txt')
-rw-r--r-- | apps/examples/README.txt | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/apps/examples/README.txt b/apps/examples/README.txt index c9b637439..dbb59adde 100644 --- a/apps/examples/README.txt +++ b/apps/examples/README.txt @@ -64,6 +64,47 @@ examples/bastest that will hold the ROMFS file system containing the BASIC files to be tested. Default: "/dev/ram0" +examples/bridge +^^^^^^^^^^^^^^^ + + A simple test of a system with multiple networks. It simply echoes all UDP + packets received on network 1 and network 2 to network 2 and network 1, + respectively. Interface 1 and interface may or may not lie on the same + network. + + CONFIG_EXAMPLES_BRIDGE - Enables the simple UDP bridge test + + There identical configurations for each of the two networks, NETn where n + refers to the network being configured n={1,2}. Let 'm' refer to the + other network. + + CONFIG_EXAMPLES_BRIDGE_NETn_IFNAME - The register name of the network n + device. Must match the previously registered driver name and must + not be the same as other network device name, + CONFIG_EXAMPLES_BRIDGE_NETm_IFNAME + CONFIG_EXAMPLES_BRIDGE_NETn_RECVPORT - Network n listen port number + CONFIG_EXAMPLES_BRIDGE_NETn_SNDPORT - Network 2 send port number + CONFIG_EXAMPLES_BRIDGE_NETn_IOBUFIZE - Size of the network n UDP + send/receive I/O buffer + CONFIG_EXAMPLES_BRIDGE_NETn_STACKSIZE - Network n daemon stacksize + CONFIG_EXAMPLES_BRIDGE_NETn_PRIORITY - Network n daemon task priority + + If used as a NSH add-on, then it is assumed that initialization of both + networks was performed externally prior to the time that this test was + started. Otherwise, the following options are available: + + CONFIG_EXAMPLES_BRIDGE_NETn_NOMAC - Select of the the network n hardware + does not have a built-in MAC address. If selected, the MAC address + provided by CONFIG_EXAMPLES_BRIDGE_NETn_MACADDR will be used to assign + the MAC address to the network n device. + CONFIG_EXAMPLES_BRIDGE_NETn_DHCPC - Use DHCP Client to get the network n + IP address. + CONFIG_EXAMPLES_BRIDGE_NETn_IPADDR -- If CONFIG_EXAMPLES_BRIDGE_NETn_DHCPC + is not selected, then this is the fixed IP address for network n. + CONFIG_EXAMPLES_BRIDGE_NETn_DRIPADDR - Netweork n default router IP + address (Gateway) + CONFIG_EXAMPLES_BRIDGE_NETn_NETMASK - Network n mask. + examples/buttons ^^^^^^^^^^^^^^^^ |