Add a framework for an ADC test

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

examples/Makefile

@@ -37,7 +37,7 @@
 
 # Sub-directories
 
-SUBDIRS = buttons dhcpd ftpc hello helloxx hidkbd igmp lcdrw mm mount \
+SUBDIRS = adc buttons dhcpd ftpc hello helloxx hidkbd igmp lcdrw mm mount \
 	nettest nsh null nx nxffs nxflat nxhello nximage nxlines \
 	nxtext ostest pashello pipe poll rgmp romfs sendmail serloop \
 	thttpd tiff touchscreen udp uip usbserial usbstorage usbterm wget wlan
@@ -46,6 +46,9 @@ SUBDIRS = buttons dhcpd ftpc hello helloxx hidkbd igmp lcdrw mm mount \
 
 CNTXTDIRS = 
 
+ifeq ($(CONFIG_NSH_BUILTIN_APPS),y)
+CNTXTDIRS +=  adc
+endif
 ifeq ($(CONFIG_NSH_BUILTIN_APPS),y)
 CNTXTDIRS +=  dhcpd
 endif

examples/README.txt

@@ -30,6 +30,23 @@ examples
       the specific example.  See the following for examples that
       support this option).
 
+examples/adc
+^^^^^^^^^^^^
+
+  A mindlessly simple test of an ADC devices.  It simply reads from the
+  ADC device and dumps the data to the console forever.
+
+    - CONFIG_NSH_BUILTIN_APPS - Build the ADC test as an NSH built-in function.
+      Default: Built as a standalone problem
+    - CONFIG_EXAMPLES_ADC_DEVPATH - The path to the ADC device. Default: /dev/adc0
+    - CONFIG_EXAMPLES_ADC_NSAMPLES - If CONFIG_NSH_BUILTIN_APPS
+      is defined, then the number of samples is provided on the command line
+      and this value is ignored.  Otherwise, this number of samples is
+      collected and the program terminates.  Default:  Samples are collected
+      indefinitely.
+    - CONFIG_EXAMPLES_ADC_SAMPLESIZE - The number of bytes to read in one sample.
+      Default: 8
+
 examples/buttons
 ^^^^^^^^^^^^^^^^
 

examples/adc/Makefile

@@ -0,0 +1,105 @@
+############################################################################
+# apps/examples/touchscreen/Makefile
+#
+#   Copyright (C) 2011 Gregory Nutt. All rights reserved.
+#   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+#
+# 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
+
+# NuttX NX Graphics Example.
+
+ASRCS		=
+CSRCS		= adc_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 .
+
+# Touchscreen built-in application info
+
+APPNAME		= adc
+PRIORITY	= SCHED_PRIORITY_DEFAULT
+STACKSIZE	= 2048
+
+# Common build
+
+VPATH		= 
+
+all: .built
+.PHONY: context 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

examples/adc/adc.h

@@ -0,0 +1,116 @@
+/****************************************************************************
+ * examples/examples/adc.h
+ *
+ *   Copyright (C) 2011 Gregory Nutt. All rights reserved.
+ *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ *
+ * 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.
+ *
+ ****************************************************************************/
+
+#ifndef __APPS_EXAMPLES_ADC_ADC_H
+#define __APPS_EXAMPLES_ADC_ADC_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+
+/****************************************************************************
+ * Definitions
+ ****************************************************************************/
+/* Configuration ************************************************************/
+/* CONFIG_NSH_BUILTIN_APPS - Build the ADC test as an NSH built-in function.
+ *  Default: Built as a standalone problem
+ * CONFIG_EXAMPLES_ADC_DEVPATH - The path to the ADC device. Default: /dev/adc0
+ * CONFIG_EXAMPLES_ADC_NSAMPLES - If CONFIG_NSH_BUILTIN_APPS
+ *   is defined, then the number of samples is provided on the command line
+ *   and this value is ignored.  Otherwise, this number of samples is
+ *   collected and the program terminates.  Default:  Samples are collected
+ *   indefinitely.
+ * CONFIG_EXAMPLES_ADC_SAMPLESIZE - The number of bytes to read in one sample.
+ *   Default: 8
+ */
+
+#ifndef CONFIG_ADC
+#  error "ADC device support is not enabled (CONFIG_ADC)"
+#endif
+
+#ifndef CONFIG_EXAMPLES_ADC_DEVPATH
+#  define CONFIG_EXAMPLES_ADC_DEVPATH "/dev/adc0"
+#endif
+
+#ifndef CONFIG_EXAMPLES_ADC_SAMPLESIZE
+#  define CONFIG_EXAMPLES_ADC_SAMPLESIZE 8
+#endif
+
+/* Debug ********************************************************************/
+
+#ifdef CONFIG_CPP_HAVE_VARARGS
+#  ifdef CONFIG_DEBUG
+#    define message(...) lib_rawprintf(__VA_ARGS__)
+#    define msgflush()
+#  else
+#    define message(...) printf(__VA_ARGS__)
+#    define msgflush() fflush(stdout)
+#  endif
+#else
+#  ifdef CONFIG_DEBUG
+#    define message lib_rawprintf
+#    define msgflush()
+#  else
+#    define message printf
+#    define msgflush() fflush(stdout)
+#  endif
+#endif
+
+/****************************************************************************
+ * Public Types
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Variables
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: adc_devinit()
+ *
+ * Description:
+ *   Perform architecuture-specific initialization of the ADC hardware.  This
+ *   interface must be provided by all configurations using apps/examples/adc
+ *
+ ****************************************************************************/
+
+void adc_devinit(void);
+
+#endif /* __APPS_EXAMPLES_ADC_ADC_H */

examples/adc/adc_main.c

@@ -0,0 +1,209 @@
+/****************************************************************************
+ * examples/adc/adc_main.c
+ *
+ *   Copyright (C) 2011 Gregory Nutt. All rights reserved.
+ *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ *
+ * 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 <nuttx/config.h>
+
+#include <sys/types.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <errno.h>
+#include <debug.h>
+
+#include <nuttx/analog/adc.h>
+
+#include "adc.h"
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+#ifdef CONFIG_NSH_BUILTIN_APPS
+#  define MAIN_NAME   adc_main
+#  define MAIN_STRING "adc_main: "
+#else
+#  define MAIN_NAME   user_start
+#  define MAIN_STRING "user_start: "
+#endif
+
+/****************************************************************************
+ * Private Types
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Function Prototypes
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Data
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Data
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: user_start/adc_main
+ ****************************************************************************/
+
+int MAIN_NAME(int argc, char *argv[])
+{
+  uintt_t sample[CONFIG_EXAMPLES_ADC_SAMPLESIZE];
+  ssize_t nbytes;
+#if defined(CONFIG_NSH_BUILTIN_APPS) || defined(CONFIG_EXAMPLES_ADC_NSAMPLES)
+  long nsamples;
+#endif
+  int fd;
+  int errval = 0;
+  int ret;
+  int i;
+
+  /* If this example is configured as an NX add-on, then limit the number of
+   * samples that we collect before returning.  Otherwise, we never return
+   */
+
+#if defined(CONFIG_NSH_BUILTIN_APPS)
+  nsamples = 1;
+  if (argc > 1)
+    {
+      nsamples = strtol(argv[1], NULL, 10);
+    }
+  message(MAIN_STRING "nsamples: %d\n", nsamples);
+#elif defined(CONFIG_EXAMPLES_ADC_NSAMPLES)
+  message(MAIN_STRING "nsamples: %d\n", CONFIG_EXAMPLES_ADC_NSAMPLES);
+#endif
+
+  /* Initialization of the ADC hardware is performed by logic external to
+   * this test.
+   */
+
+  message(MAIN_STRING "Initializing external ADC device\n");
+  ret = adc_devinit();
+  if (ret != OK)
+    {
+      message(MAIN_STRING "adc_devinit failed: %d\n", ret);
+      errval = 1;
+      goto errout;
+    }
+
+  /* Open the ADC device for reading */
+
+  fd = open(CONFIG_EXAMPLES_ADC_DEVPATH, O_RDONLY);
+  if (fd < 0)
+    {
+      message(MAIN_STRING "open %s failed: %d\n",
+              CONFIG_EXAMPLES_ADC_DEVPATH, errno);
+      errval = 2;
+      goto errout_with_dev;
+    }
+
+  /* Now loop the appropriate number of times, displaying the collected
+   * ADC samples.
+   */
+
+#if defined(CONFIG_NSH_BUILTIN_APPS)
+  for (; nsamples > 0; nsamples--)
+#elif defined(CONFIG_EXAMPLES_ADC_NSAMPLES)
+  for (nsamples = 0; nsamples < CONFIG_EXAMPLES_ADC_NSAMPLES; nsamples++)
+#else
+  for (;;)
+#endif
+  {
+    /* Flush any output before the loop entered or from the previous pass
+     * through the loop.
+     */
+
+    msgflush();
+
+    /* Read one sample */
+
+    nbytes = read(fd, sample,CONFIG_EXAMPLES_ADC_SAMPLESIZE ));
+    ivdbg("Bytes read: %d\n", nbytes);
+
+    /* Handle unexpected return values */
+
+    if (nbytes < 0)
+      {
+        errval = errno;
+        if (errval != EINTR)
+          {
+            message(MAIN_STRING "read %s failed: %d\n",
+                    CONFIG_EXAMPLES_ADC_DEVPATH, errval);
+            errval = 3;
+            goto errout_with_dev;
+          }
+
+        message(MAIN_STRING "Interrupted read...\n");
+      }
+    else if (nbytes != CONFIG_EXAMPLES_ADC_SAMPLESIZE)
+      {
+        message(MAIN_STRING "Unexpected read size=%d, expected=%d, Ignoring\n",
+                nbytes, CONFIG_EXAMPLES_ADC_SAMPLESIZE);        
+      }
+
+    /* Print the sample data on successful return */
+
+    else
+      {
+        message("Sample :\n");
+        for (i = 0; i < CONFIG_EXAMPLES_ADC_SAMPLESIZE; i++)
+          {
+            message("%d: %02x\n", i, sample[i]);
+          }
+      }
+  }
+
+errout_with_dev:
+  close(fd);
+errout_with_dev:
+errout:
+  message("Terminating!\n");
+  msgflush();
+  return errval;
+}