Network discover utility from Max Holtzberg

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5137 42af7a65-404d-4744-a932-0658087f49c3

4 files changed, 353 insertions, 0 deletions

diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index 52d7279da..0d327ebfb 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -275,6 +275,28 @@ examples/dhcpd
 
   CONFIGURED_APPS += uiplib
 
+examples/discover
+^^^^^^^^^^^^^^^^^
+
+  This example execises netutils/discover utility.  This example initializes
+  and starts the UDP discover daemon. This daemon is useful for discovering
+  devices in local networks, especially with DHCP configured devices.  It
+  listens for UDP broadcasts which also can include a device class so that
+  groups of devices can be discovered. It is also possible to address all
+  classes with a kind of broadcast discover.
+
+  This example will automatically be built as an NSH built-in if
+  CONFIG_NSH_BUILTIN_APPS is selected.  Otherwise, it will be a standalone
+  program with entry point "discover_main".
+
+  NuttX configuration settings:
+
+    CONFIG_EXAMPLE_DISCOVER_DHCPC - DHCP Client
+    CONFIG_EXAMPLE_DISCOVER_NOMAC - Use canned MAC address
+    CONFIG_EXAMPLE_DISCOVER_IPADDR - Target IP address
+    CONFIG_EXAMPLE_DISCOVER_DRIPADDR - Router IP address
+    CONFIG_EXAMPLE_DISCOVER_NETMASK - Network Mask
+
 examples/ftpc
 ^^^^^^^^^^^^^
 
diff --git a/apps/examples/discover/Kconfig b/apps/examples/discover/Kconfig
new file mode 100644
index 000000000..afdb9ff82
--- /dev/null
+++ b/apps/examples/discover/Kconfig
@@ -0,0 +1,42 @@
+#
+# For a description of the syntax of this configuration file,
+# see misc/tools/kconfig-language.txt.
+#
+
+config EXAMPLES_DISCOVER
+	bool "UDP Discovery Example"
+	default n
+	depends on NET_UDP
+	select NETUTILS_DISCOVER
+	---help---
+		Enable the netutils/discover utility.  This example initializes and
+		starts the UDP discover daemon. This daemon is useful for
+		discovering devices in local networks, especially with DHCP
+		configured devices.  It listens for UDP broadcasts which also can
+		include a device class so that groups of devices can be discovered.
+		It is also possible to address all classes with a kind of broadcast
+		discover.
+
+if EXAMPLES_DISCOVER
+
+config EXAMPLE_DISCOVER_DHCPC
+	bool "DHCP Client"
+	default n
+
+config EXAMPLE_DISCOVER_NOMAC
+	bool "Use canned MAC address"
+	default n
+
+config EXAMPLE_DISCOVER_IPADDR
+	hex "Target IP address"
+	default 0x0a000002
+
+config EXAMPLE_DISCOVER_DRIPADDR
+	hex "Router IP address"
+	default 0x0a000001
+
+config EXAMPLE_DISCOVER_NETMASK
+	hex "Network Mask"
+	default 0xffffff00
+
+endif
diff --git a/apps/examples/discover/Makefile b/apps/examples/discover/Makefile
new file mode 100644
index 000000000..f42f310a1
--- /dev/null
+++ b/apps/examples/discover/Makefile
@@ -0,0 +1,106 @@
+############################################################################
+# apps/examples/discover/Makefile
+#
+#   Copyright (C) 2012 Max Holtzberg. All rights reserved.
+#   Copyright (C) 2008, 2010-2012 Gregory Nutt. All rights reserved.
+#
+#   Authors: Max Holtzberg <mh@uvc.de>
+#            Gregory Nutt <gnutt@nuttx.org>
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+#
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in
+#    the documentation and/or other materials provided with the
+#    distribution.
+# 3. Neither the name NuttX nor the names of its contributors may be
+#    used to endorse or promote products derived from this software
+#    without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+# OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+############################################################################
+
+-include $(TOPDIR)/.config
+-include $(TOPDIR)/Make.defs
+include $(APPDIR)/Make.defs
+
+# Discover built-in application info
+
+APPNAME		= discover
+PRIORITY	= SCHED_PRIORITY_DEFAULT
+STACKSIZE	= 2048
+
+ASRCS		=
+CSRCS		= main.c
+
+AOBJS		= $(ASRCS:.S=$(OBJEXT))
+COBJS		= $(CSRCS:.c=$(OBJEXT))
+
+SRCS		= $(ASRCS) $(CSRCS)
+OBJS		= $(AOBJS) $(COBJS)
+
+ifeq ($(WINTOOL),y)
+  BIN		= "${shell cygpath -w  $(APPDIR)/libapps$(LIBEXT)}"
+else
+  BIN		= "$(APPDIR)/libapps$(LIBEXT)"
+endif
+
+ROOTDEPPATH	= --dep-path .
+
+# Common build
+
+VPATH		= 
+
+all: .built
+.PHONY: clean depend distclean
+
+$(AOBJS): %$(OBJEXT): %.S
+	$(call ASSEMBLE, $<, $@)
+
+$(COBJS): %$(OBJEXT): %.c
+	$(call COMPILE, $<, $@)
+
+.built: $(OBJS)
+	@( for obj in $(OBJS) ; do \
+		$(call ARCHIVE, $(BIN), $${obj}); \
+	done ; )
+	@touch .built
+
+.context:
+ifeq ($(CONFIG_NSH_BUILTIN_APPS),y)
+	$(call REGISTER,$(APPNAME),$(PRIORITY),$(STACKSIZE),$(APPNAME)_main)
+	@touch $@
+endif
+
+context: .context
+
+.depend: Makefile $(SRCS)
+	@$(MKDEP) $(ROOTDEPPATH) $(CC) -- $(CFLAGS) -- $(SRCS) >Make.dep
+	@touch $@
+
+depend: .depend
+
+clean:
+	@rm -f *.o *~ .*.swp .built
+	$(call CLEAN)
+
+distclean: clean
+	@rm -f Make.dep .depend
+
+-include Make.dep
diff --git a/apps/examples/discover/main.c b/apps/examples/discover/main.c
new file mode 100644
index 000000000..b857e4f68
--- /dev/null
+++ b/apps/examples/discover/main.c
@@ -0,0 +1,183 @@
+/****************************************************************************
+ * examples/discover/main.c
+ *
+ *   Copyright (C) 2012 Max Holtzberg. All rights reserved.
+ *   Copyright (C) 2008, 2011-2012 Gregory Nutt. All rights reserved.
+ *
+ *   Authors: Max Holtzberg <mh@uvc.de>
+ *            Gregory Nutt <gnutt@nuttx.org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name NuttX nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ****************************************************************************/
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <stdint.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+#include <time.h>
+#include <debug.h>
+
+#include <net/if.h>
+#include <nuttx/net/uip/uip.h>
+#include <nuttx/net/uip/uip-arp.h>
+
+#include <apps/netutils/uiplib.h>
+#include <apps/netutils/discover.h>
+
+#ifdef CONFIG_EXAMPLE_DISCOVER_DHCPC
+#  include <arpa/inet.h>
+#endif
+
+/* Here we include the header file for the application(s) we use in
+ * our project as defined in the config/<board-name>/defconfig file
+ */
+
+/* DHCPC may be used in conjunction with any other feature (or not) */
+
+#ifdef CONFIG_EXAMPLE_DISCOVER_DHCPC
+#  include <apps/netutils/resolv.h>
+#  include <apps/netutils/dhcpc.h>
+#endif
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Data
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * discover_main
+ ****************************************************************************/
+
+int discover_main(int argc, char *argv[])
+{
+#ifndef CONFIG_NSH_BUILTIN_APPS
+  struct in_addr addr;
+#if defined(CONFIG_EXAMPLE_DISCOVER_DHCPC) || defined(CONFIG_EXAMPLE_DISCOVER_NOMAC)
+  uint8_t mac[IFHWADDRLEN];
+#endif
+#ifdef CONFIG_EXAMPLE_DISCOVER_DHCPC
+  void *handle;
+#endif
+
+/* Many embedded network interfaces must have a software assigned MAC */
+
+#ifdef CONFIG_EXAMPLE_DISCOVER_NOMAC
+  mac[0] = 0x00;
+  mac[1] = 0xe0;
+  mac[2] = 0xde;
+  mac[3] = 0xad;
+  mac[4] = 0xbe;
+  mac[5] = 0xef;
+  uip_setmacaddr("eth0", mac);
+#endif
+
+  /* Set up our host address */
+
+#ifdef CONFIG_EXAMPLE_DISCOVER_DHCPC
+  addr.s_addr = 0;
+#else
+  addr.s_addr = HTONL(CONFIG_EXAMPLE_DISCOVER_IPADDR);
+#endif
+  uip_sethostaddr("eth0", &addr);
+
+  /* Set up the default router address */
+
+  addr.s_addr = HTONL(CONFIG_EXAMPLE_DISCOVER_DRIPADDR);
+  uip_setdraddr("eth0", &addr);
+
+  /* Setup the subnet mask */
+
+  addr.s_addr = HTONL(CONFIG_EXAMPLE_DISCOVER_NETMASK);
+  uip_setnetmask("eth0", &addr);
+
+#ifdef CONFIG_EXAMPLE_DISCOVER_DHCPC
+  /* Set up the resolver */
+
+  resolv_init();
+
+  /* Get the MAC address of the NIC */
+
+  uip_getmacaddr("eth0", mac);
+
+  /* Set up the DHCPC modules */
+
+  handle = dhcpc_open(&mac, IFHWADDRLEN);
+
+  /* Get an IP address.  Note:  there is no logic here for renewing the address in this
+   * example.  The address should be renewed in ds.lease_time/2 seconds.
+   */
+
+  printf("Getting IP address\n");
+  if (handle)
+    {
+        struct dhcpc_state ds;
+        (void)dhcpc_request(handle, &ds);
+        uip_sethostaddr("eth1", &ds.ipaddr);
+
+        if (ds.netmask.s_addr != 0)
+          {
+            uip_setnetmask("eth0", &ds.netmask);
+          }
+
+        if (ds.default_router.s_addr != 0)
+          {
+            uip_setdraddr("eth0", &ds.default_router);
+          }
+
+        if (ds.dnsaddr.s_addr != 0)
+          {
+            resolv_conf(&ds.dnsaddr);
+          }
+
+        dhcpc_close(handle);
+        printf("IP: %s\n", inet_ntoa(ds.ipaddr));
+    }
+#endif
+#endif /* CONFIG_NSH_BUILTIN_APPS */
+
+  if (discover_start() < 0)
+    {
+      ndbg("Could not start discover daemon.\n");
+      return ERROR;
+    }
+
+  return OK;
+}
+