Add a test for PWM drivers

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

ChangeLog.txt

@@ -146,3 +146,5 @@
 	  built for performance evaluation.
 	* apps/examples/adc:  Add a very simple test to drive and test an ADC
 	  driver.
+	* apps/examples/pwm:  Add an NSH PWM command to drive and test a PWM
+	  driver.

examples/Makefile

@@ -39,12 +39,12 @@
 
 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 \
+	nxtext ostest pashello pipe poll pwm rgmp romfs sendmail serloop \
 	thttpd tiff touchscreen udp uip usbserial usbstorage usbterm wget wlan
 
 # Sub-directories that might need context setup
 
-CNTXTDIRS = 
+CNTXTDIRS = pwm
 
 ifeq ($(CONFIG_NSH_BUILTIN_APPS),y)
 CNTXTDIRS +=  adc

examples/README.txt

@@ -678,6 +678,22 @@ examples/poll
 
   CONFIGURED_APPS += uiplib
 
+examples/pwm
+^^^^^^^^^^^^
+
+  A test of a PWM device driver. It simply enables a pulsed output for
+  a specified frequency and duty for a specified period of time.  This
+  example can ONLY be built as an NSH built-in function.
+
+    CONFIG_NSH_BUILTIN_APPS - Build the PWM test as an NSH built-in function.
+      Default: Not built!  The example can only be used as an NSH built-in
+      application
+    CONFIG_EXAMPLES_PWM_DEVPATH - The path to the PWM device. Default: /dev/pwm0
+    CONFIG_EXAMPLES_PWM_FREQUENCY - The initial PWM frequency.  Default: 100 Hz
+    CONFIG_EXAMPLES_PWM_DUTYPCT - The initial PWM duty as a percentage.  Default: 50%
+    CONFIG_EXAMPLES_PWM_DURATION - The initial PWM pulse train duration in sectonds.
+       as a percentage.  Default: 5 seconds
+
 examples/rgmp
 ^^^^^^^^^^^^^
 

examples/adc/Makefile

@@ -1,8 +1,8 @@
 ############################################################################
-# apps/examples/touchscreen/Makefile
+# apps/examples/adc/Makefile
 #
 #   Copyright (C) 2011 Gregory Nutt. All rights reserved.
-#   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+#   Author: Gregory Nutt <gnutt@nuttx.org>
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions

examples/adc/adc.h

@@ -1,8 +1,8 @@
 /****************************************************************************
- * examples/examples/adc.h
+ * examples/examples/adc/adc.h
  *
  *   Copyright (C) 2011 Gregory Nutt. All rights reserved.
- *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
+ *   Author: Gregory Nutt <gnutt@nuttx.org>
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions

examples/adc/adc_main.c

@@ -132,10 +132,10 @@ int MAIN_NAME(int argc, char *argv[])
       errval = 1;
       goto errout;
     }
-  message(MAIN_STRING "Hardware initialized. Opening the ADC device\n");
 
   /* Open the ADC device for reading */
 
+  message(MAIN_STRING "Hardware initialized. Opening the ADC device\n");
   fd = open(CONFIG_EXAMPLES_ADC_DEVPATH, O_RDONLY);
   if (fd < 0)
     {

examples/pwm/Makefile

@@ -0,0 +1,103 @@
+############################################################################
+# apps/examples/pwm/Makefile
+#
+#   Copyright (C) 2011 Gregory Nutt. All rights reserved.
+#   Author: 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
+
+# NuttX NX Graphics Example.
+
+ASRCS		=
+CSRCS		= pwm_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		= pwm
+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:
+	$(call REGISTER,$(APPNAME),$(PRIORITY),$(STACKSIZE),$(APPNAME)_main)
+	@touch $@
+
+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/pwm/pwm.h

@@ -0,0 +1,126 @@
+/****************************************************************************
+ * examples/examples/pwm.h
+ *
+ *   Copyright (C) 2011 Gregory Nutt. All rights reserved.
+ *   Author: 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.
+ *
+ ****************************************************************************/
+
+#ifndef __APPS_EXAMPLES_PWM_PWM_H
+#define __APPS_EXAMPLES_PWM_PWM_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+
+/****************************************************************************
+ * Definitions
+ ****************************************************************************/
+/* Configuration ************************************************************/
+/* CONFIG_NSH_BUILTIN_APPS - Build the PWM test as an NSH built-in function.
+ *   Default: Not built!  The example can only be used as an NSH built-in
+ *   application
+ * CONFIG_EXAMPLES_PWM_DEVPATH - The path to the PWM device. Default: /dev/pwm0
+ * CONFIG_EXAMPLES_PWM_FREQUENCY - The initial PWM frequency.  Default: 100 Hz
+ * CONFIG_EXAMPLES_PWM_DUTYPCT - The initial PWM duty as a percentage.  Default: 50%
+ * CONFIG_EXAMPLES_PWM_DURATION - The initial PWM pulse train duration in sectonds.
+ *   as a percentage.  Default: 5 seconds
+ */
+
+#ifndef CONFIG_PWM
+#  error "PWM device support is not enabled (CONFIG_PWM)"
+#endif
+
+#ifndef CONFIG_NSH_BUILTIN_APPS
+#  warning "The PWM example only works as an NSH built-in application (CONFIG_NSH_BUILTIN_APPS)"
+#endif
+
+#ifndef CONFIG_EXAMPLES_PWM_DEVPATH
+#  define CONFIG_EXAMPLES_PWM_DEVPATH "/dev/pwm0"
+#endif
+
+#ifndef CONFIG_EXAMPLES_PWM_FREQUENCY
+#  define CONFIG_EXAMPLES_PWM_FREQUENCY 100
+#endif
+
+#ifndef CONFIG_EXAMPLES_PWM_DUTYPCT
+#  define CONFIG_EXAMPLES_PWM_DUTYPCT 50
+#endif
+
+#ifndef CONFIG_EXAMPLES_PWM_DURATION
+#  define CONFIG_EXAMPLES_PWM_DURATION 5
+#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: pwm_devinit()
+ *
+ * Description:
+ *   Perform architecuture-specific initialization of the PWM hardware.  This
+ *   interface must be provided by all configurations using apps/examples/pwm
+ *
+ ****************************************************************************/
+
+int pwm_devinit(void);
+
+#endif /* __APPS_EXAMPLES_PWM_PWM_H */

examples/pwm/pwm_main.c

@@ -0,0 +1,308 @@
+/****************************************************************************
+ * examples/pwm/pwm_main.c
+ *
+ *   Copyright (C) 2011 Gregory Nutt. All rights reserved.
+ *   Author: 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 <nuttx/config.h>
+
+#include <sys/types.h>
+#include <sys/ioctl.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <errno.h>
+#include <debug.h>
+
+#include <nuttx/pwm.h>
+
+#include "pwm.h"
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Types
+ ****************************************************************************/
+
+struct pwm_state_s
+{
+  bool     initialized;
+  uint8_t  duty;
+  uint32_t freq;
+  int      duration;
+};
+
+/****************************************************************************
+ * Private Function Prototypes
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Data
+ ****************************************************************************/
+
+static struct pwm_state_s g_pwmstate;
+
+/****************************************************************************
+ * Public Data
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: pwm_help
+ ****************************************************************************/
+
+static void pwm_help(FAR struct pwm_state_s *pwm)
+{
+  message("Usage: pwm [OPTIONS]\n");
+  message("\nArguments are \"sticky\".  For example, once the PWM frequency is\n");
+  message("specified, that frequency will be re-used until it is changed.\n");
+  message("\n\"sticky\" OPTIONS include:\n");
+  message("  [-f addr] selects the pulse frequency.  "
+         "Default: %d Hz Current: %d Hz\n",
+         CONFIG_EXAMPLES_PWM_FREQUENCY, pwm->freq);
+  message("  [-d duty] selcts the pulse duty as a percentage.  "
+          "Default: %d %% Current: %d %%\n",
+          CONFIG_EXAMPLES_PWM_DUTYPCT, pwm->duty);
+  message("  [-t duration] is the duration of the pulse train in seconds.  "
+          "Default: %d Current: %d\n",
+         CONFIG_EXAMPLES_PWM_DURATION, pwm->duration);
+  message("  [-t] shows this message and extis\n");
+}
+
+/****************************************************************************
+ * Name: arg_string
+ ****************************************************************************/
+
+int arg_string(FAR char **arg, FAR char **value)
+{
+  FAR char *ptr = *arg;
+
+  if (ptr[2] == '\0')
+    {
+      *value = arg[1];
+      return 2;
+    }
+  else
+    {
+      *value = &ptr[2];
+      return 1;
+    }
+}
+
+/****************************************************************************
+ * Name: arg_decimal
+ ****************************************************************************/
+
+int arg_decimal(FAR char **arg, FAR long *value)
+{
+  FAR char *string;
+  int ret;
+
+  ret = arg_string(arg, &string);
+  *value = strtol(string, NULL, 10);
+  return ret;
+}
+
+/****************************************************************************
+ * Name: parse_args
+ ****************************************************************************/
+
+void parse_args(FAR struct pwm_state_s *pwm, int argc, FAR char **argv)
+{
+  FAR char *ptr;
+  long value;
+  int index;
+  int nargs;
+ 
+  for (index = 1; index < argc; )
+    {
+      ptr = argv[index];
+      if (ptr[0] != '-')
+        {
+          message("Invalid options format: %s\n", ptr);
+          exit(0);
+        }
+
+      switch (ptr[1])
+        {
+          case 'f':
+            nargs = arg_decimal(&argv[index], &value);
+            if (value < 1)
+              {
+                message("Frequency out of range: %ld\n", value);
+                exit(1);
+              }
+
+            pwm->freq = (uint32_t)value;
+            index += nargs;
+            break;
+
+          case 'd':
+            nargs = arg_decimal(&argv[index], &value);
+            if (value < 1 || value > 99)
+              {
+                message("Duty out of range: %ld\n", value);
+                exit(1);
+              }
+
+            pwm->duty = (uint8_t)value;
+            index += nargs;
+            break;
+
+          case 't':
+            nargs = arg_decimal(&argv[index], &value);
+            if (value < 1 || value > INT_MAX)
+              {
+                message("Duration out of range: %ld\n", value);
+                exit(1);
+              }
+
+            pwm->duration = (int)value;
+            index += nargs;
+            break;
+
+          case 'h':
+            pwm_help(pwm);
+            exit(0);
+        
+          default:
+            message("Unsupported option: %s\n", ptr);
+            pwm_help(pwm);
+            exit(1);
+        }
+    }
+}
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: user_start/pwm_main
+ ****************************************************************************/
+
+int pwm_main(int argc, char *argv[])
+{
+  struct pwm_info_s info;
+  int fd;
+  int ret;
+
+  /* Initialize the state data */
+
+  if (!g_pwmstate.initialized)
+    {
+      g_pwmstate.duty       = CONFIG_EXAMPLES_PWM_DUTYPCT;
+      g_pwmstate.freq       = CONFIG_EXAMPLES_PWM_FREQUENCY;
+      g_pwmstate.duration   = CONFIG_EXAMPLES_PWM_DURATION;
+      g_pwmstate.initialized = true;
+    }
+
+  /* Parse the command line */
+
+  parse_args(&g_pwmstate, argc, argv);
+
+  /* Initialization of the PWM hardware is performed by logic external to
+   * this test.
+   */
+
+  ret = pwm_devinit();
+  if (ret != OK)
+    {
+      message("pwm_main: pwm_devinit failed: %d\n", ret);
+      goto errout;
+    }
+
+  /* Open the PWM device for reading */
+
+  fd = open(CONFIG_EXAMPLES_PWM_DEVPATH, O_RDONLY);
+  if (fd < 0)
+    {
+      message("pwm_main: open %s failed: %d\n",
+              CONFIG_EXAMPLES_PWM_DEVPATH, errno);
+      goto errout;
+    }
+
+  /* Configure the characteristics of the pulse train */
+
+  info.frequency = g_pwmstate.freq;
+  info.duty      = (info.duty < 16) / 100;
+
+  ret = ioctl(fd, PWMIOC_SETCHARACTERISTICS, (unsigned long)((uintptr_t)&info));
+  if (ret < 0)
+    {
+      message("pwm_main: ioctl(PWMIOC_SETCHARACTERISTICS) failed: %d\n", errno);
+      goto errout_with_dev;
+    }
+
+  /* Then start the pulse train */
+
+  ret = ioctl(fd, PWMIOC_START, 0);
+  if (ret < 0)
+    {
+      message("pwm_main: ioctl(PWMIOC_START) failed: %d\n", errno);
+      goto errout_with_dev;
+    }
+
+  /* Wait for the specified duration */
+
+  sleep(g_pwmstate.duration);
+
+  /* Then stop the  pulse train */
+
+  ret = ioctl(fd, PWMIOC_STOP, 0);
+  if (ret < 0)
+    {
+      message("pwm_main: ioctl(PWMIOC_STOP) failed: %d\n", errno);
+      goto errout_with_dev;
+    }
+
+ close(fd);
+ msgflush();
+ return OK;
+
+errout_with_dev:
+  close(fd);
+errout:
+  msgflush();
+  return ERROR;
+}