boardctl(): Add a new non-standard OS interface. This is similar to a driver IOCTL call. But this is an IOCTL call directly on the board logic. This function will eventually replace all of the ad hoc OS interfaces that are current used to perform application specific intialiation and application driver test confifuration. It essentially formalizes and institutionalizes these rogue interface in to at least a single crazy call.

Directories.mk

@@ -69,7 +69,7 @@ endif
 #   be cleaned to prevent garbage from collecting in them when changing
 #   configurations.
 
-NONFSDIRS = sched $(ARCH_SRC) $(NUTTX_ADDONS)
+NONFSDIRS = sched configs $(ARCH_SRC) $(NUTTX_ADDONS)
 FSDIRS = fs drivers binfmt
 CONTEXTDIRS = $(APPDIR)
 USERDIRS =

FlatLibs.mk

@@ -45,6 +45,10 @@
 NUTTXLIBS = lib$(DELIM)libsched$(LIBEXT)
 USERLIBS =
 
+# Add libraries for board support
+
+NUTTXLIBS = lib$(DELIM)libconfigs$(LIBEXT)
+
 # Add libraries for syscall support.
 
 NUTTXLIBS += lib$(DELIM)libc$(LIBEXT) lib$(DELIM)libmm$(LIBEXT)

KernelLibs.mk

@@ -45,6 +45,10 @@
 NUTTXLIBS = lib$(DELIM)libsched$(LIBEXT)
 USERLIBS =
 
+# Add libraries for board support
+
+NUTTXLIBS = lib$(DELIM)libconfigs$(LIBEXT)
+
 # Add libraries for syscall support.  The C library will be needed by
 # both the kernel- and user-space builds.  For now, the memory manager (mm)
 # is placed in user space (only).

LibTargets.mk

@@ -77,6 +77,12 @@ net$(DELIM)libnet$(LIBEXT): context
 lib$(DELIM)libnet$(LIBEXT): net$(DELIM)libnet$(LIBEXT)
 	$(Q) install net$(DELIM)libnet$(LIBEXT) lib$(DELIM)libnet$(LIBEXT)
 
+configs$(DELIM)libconfigs$(LIBEXT): context
+	$(Q) $(MAKE) -C configs TOPDIR="$(TOPDIR)" libconfigs$(LIBEXT) KERNEL=y EXTRADEFINES=$(KDEFINE)
+
+lib$(DELIM)libconfigs$(LIBEXT): configs$(DELIM)libconfigs$(LIBEXT)
+	$(Q) install configs$(DELIM)libconfigs$(LIBEXT) lib$(DELIM)libconfigs$(LIBEXT)
+
 crypto$(DELIM)libcrypto$(LIBEXT): context
 	$(Q) $(MAKE) -C crypto TOPDIR="$(TOPDIR)" libcrypto$(LIBEXT) KERNEL=y EXTRADEFINES=$(KDEFINE)
 

ProtectedLibs.mk

@@ -45,6 +45,10 @@
 NUTTXLIBS = lib$(DELIM)libsched$(LIBEXT)
 USERLIBS =
 
+# Add libraries for board support
+
+NUTTXLIBS = lib$(DELIM)libconfigs$(LIBEXT)
+
 # Add libraries for syscall support.  The C library will be needed by
 # both the kernel- and user-space builds.  For now, the memory manager (mm)
 # is placed in user space (only).

configs/.gitignore

@@ -0,0 +1,10 @@
+/Make.dep
+/.depend
+/*.asm
+/*.obj
+/*.rel
+/*.lst
+/*.sym
+/*.adb
+/*.lib
+/*.src

configs/Makefile

@@ -0,0 +1,87 @@
+############################################################################
+# configs/Makefile
+#
+#   Copyright (C) 2015 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)/Make.defs
+
+# Basic
+
+CONFIG_ASRCS =
+CONFIG_CSRCS =
+
+# boardctl support
+
+ifeq ($(CONFIG_LIB_BOARDCTL),y)
+CONFIG_CSRCS += boardctl.c
+endif
+
+ASRCS = $(CONFIG_ASRCS)
+AOBJS = $(ASRCS:.S=$(OBJEXT))
+
+CSRCS = $(CONFIG_CSRCS)
+COBJS = $(CSRCS:.c=$(OBJEXT))
+
+SRCS = $(ASRCS) $(CSRCS)
+OBJS = $(AOBJS) $(COBJS)
+
+BIN = libconfigs$(LIBEXT)
+
+all: $(BIN)
+
+$(AOBJS): %$(OBJEXT): %.S
+	$(call ASSEMBLE, $<, $@)
+
+$(COBJS): %$(OBJEXT): %.c
+	$(call COMPILE, $<, $@)
+
+$(BIN): $(OBJS)
+	$(call ARCHIVE, $@, $(OBJS))
+
+.depend: Makefile $(SRCS)
+ifneq ($(SRCS),)
+	$(Q) $(MKDEP) --dep-path . "$(CC)" -- $(CFLAGS) -- $(SRCS) >Make.dep
+endif
+	$(Q) touch $@
+
+depend: .depend
+
+clean:
+	$(call DELFILE, $(BIN))
+	$(call CLEAN)
+
+distclean: clean
+	$(call DELFILE, Make.dep)
+	$(call DELFILE, .depend)
+
+-include Make.dep

configs/boardctl.c

@@ -0,0 +1,138 @@
+/****************************************************************************
+ * configs/boardctl.c
+ *
+ *   Copyright (C) 2015 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/boardctl.h>
+#include <stdint.h>
+#include <errno.h>
+
+#include <nuttx/board.h>
+
+#ifdef CONFIG_LIB_BOARDCTL
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: boardctl
+ *
+ * Description:
+ *   In a small embedded system, there will typically be a much greater
+ *   interaction between application and low-level board features.  The
+ *   canonically correct to implement such interactions is by implementing a
+ *   character driver and performing the interactions via low level ioctl
+ *   calls.  This, however, may not be practical in many cases and will lead
+ *   to "correct" but awkward implementations.
+ *
+ *   boardctl() is non-standard OS interface to alleviate the problem.  It
+ *   basically circumvents the normal device driver ioctl interlace and allows
+ *   the application to perform direction IOCTL-like calls to the board-specific
+ *   logic.  In it is especially useful for setting up board operational and
+ *   test configurations.
+ *
+ * Input Parameters:
+ *   cmd - Identifies the board command to be executed
+ *   arg - The argument that accompanies the command.  The nature of the
+ *         argument is determined by the specific command.
+ *
+ * Returned Value:
+ *   On success zero (OK) is returned; -1 (ERROR) is returned on failure
+ *   with the errno variable to to indicate the nature of the failure.
+ *
+ ****************************************************************************/
+
+int boardctl(unsigned int cmd, uintptr_t arg)
+{
+  int ret;
+
+  switch (cmd)
+    {
+      /* CMD:           BOARDIOC_INIT
+       * DESCRIPTION:   Perform one-time application initialization.
+       * ARG:           None
+       * CONFIGURATION: CONFIG_LIB_BOARDCTL
+       * DEPENDENCIES:  Board logic must provide board_app_initialization
+       */
+
+      case BOARDIOC_INIT:
+        ret = board_app_initialize();
+        break;
+
+#ifdef CONFIG_BOARDCTL_TSCTEST
+      /* CMD:           BOARDIOC_TSCTEST
+       * DESCRIPTION:   Touchscreen controller test configuration
+       * ARG:           0: Setup touchscreen test, 1: Teardown touchscreen test
+       * CONFIGURATION: CONFIG_LIB_BOARDCTL && 
+       * DEPENDENCIES:  Board logic must provide board_tsc_setup() and
+       *                board_tsc_teardown().
+       */
+
+      case BOARDIOC_TSCTEST:
+        if (arg)
+          {
+            ret = board_tsc_setup();
+          }
+        else
+          {
+            ret = board_tsc_teardown();
+          }
+
+        break;
+#endif
+
+       default:
+         ret = -ENOTTY;
+         break;
+    }
+
+  /* Set the errno value on any errors */
+
+  if (ret < 0)
+    {
+      set_errno(-ret);
+      return ERROR;
+    }
+
+  return OK;
+}
+
+#endif /* CONFIG_LIB_BOARDCTL */

include/nuttx/fs/ioctl.h

@@ -75,6 +75,7 @@
 #define _AJOYBASE       (0x1600) /* Analog joystick ioctl commands */
 #define _PIPEBASE       (0x1700) /* FIFO/pipe ioctl commands */
 #define _RTCBASE        (0x1800) /* RTC ioctl commands */
+#define _BOARDBASE      (0x1900) /* boardctl commands */
 
 /* Macros used to manage ioctl commands */
 
@@ -340,6 +341,11 @@
 #define _RTCIOCVALID(c)   (_IOC_TYPE(c)==_RTCBASE)
 #define _RTCIOC(nr)       _IOC(_RTCBASE,nr)
 
+/* boardctl() command definitions *******************************************/
+
+#define _BOARDIOCVALID(c) (_IOC_TYPE(c)==_BOARDBASE)
+#define _BOARDIOC(nr)     _IOC(_BOARDBASE,nr)
+
 /****************************************************************************
  * Public Type Definitions
  ****************************************************************************/

include/sys/boardctl.h

@@ -0,0 +1,111 @@
+/****************************************************************************
+ * include/sys/boardctl.h
+ *
+ *   Copyright (C) 2015 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 __INCLUDE_SYS_BOARDCTL_H
+#define __INCLUDE_SYS_BOARDCTL_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+#include <stdint.h>
+
+#include <nuttx/fs/ioctl.h>
+
+#ifdef CONFIG_LIB_BOARDCTL
+
+/****************************************************************************
+ * Pre-processor Definitions
+ ****************************************************************************/
+/* Common commands
+ *
+ * CMD:           BOARDIOC_INIT
+ * DESCRIPTION:   Perform one-time application initialization.
+ * ARG:           None
+ * CONFIGURATION: CONFIG_LIB_BOARDCTL
+ * DEPENDENCIES:  Board logic must provide board_app_initialization
+ *
+ * CMD:           BOARDIOC_TSCTEST
+ * DESCRIPTION:   Touchscreen controller test configuration
+ * ARG:           0: Setup touchscreen test, 1: Teardown touchscreen test
+ * CONFIGURATION: CONFIG_LIB_BOARDCTL && CONFIG_BOARDCTL_TSCTEST
+ * DEPENDENCIES:  Board logic must provide board_tsc_setup() and
+ *                board_tsc_teardown().
+ */
+
+#define BOARDIOC_INIT     _BOARDIOC(0x0001)
+#define BOARDIOC_TSCTEST  _BOARDIOC(0x0002)
+
+/****************************************************************************
+ * Public Type Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: boardctl
+ *
+ * Description:
+ *   In a small embedded system, there will typically be a much greater
+ *   interaction between application and low-level board features.  The
+ *   canonically correct to implement such interactions is by implementing a
+ *   character driver and performing the interactions via low level ioctl
+ *   calls.  This, however, may not be practical in many cases and will lead
+ *   to "correct" but awkward implementations.
+ *
+ *   boardctl() is non-standard OS interface to alleviate the problem.  It
+ *   basically circumvents the normal device driver ioctl interlace and allows
+ *   the application to perform direction IOCTL-like calls to the board-specific
+ *   logic.  In it is especially useful for setting up board operational and
+ *   test configurations.
+ *
+ * Input Parameters:
+ *   cmd - Identifies the board command to be executed
+ *   arg - The argument that accompanies the command.  The nature of the
+ *         argument is determined by the specific command.
+ *
+ * Returned Value:
+ *   On success zero (OK) is returned; -1 (ERROR) is returned on failure
+ *   with the errno variable to to indicate the nature of the failure.
+ *
+ ****************************************************************************/
+
+int boardctl(unsigned int cmd, uintptr_t arg);
+
+#endif /* CONFIG_LIB_BOARDCTL */
+#endif /* __INCLUDE_SYS_BOARDCTL_H */

include/sys/syscall.h

@@ -249,12 +249,21 @@
 #  ifndef CONFIG_DISABLE_POLL
 #    define SYS_poll                   __SYS_poll
 #    define SYS_select                 (__SYS_poll+1)
-#    define __SYS_filedesc             (__SYS_poll+2)
+#    define __SYS_boardctl             (__SYS_poll+2)
 #  else
-#    define __SYS_filedesc             __SYS_poll
+#    define __SYS_boardctl             __SYS_poll
 #  endif
 #else
-#  define __SYS_filedesc               __SYS_descriptors
+#  define __SYS_boardctl               __SYS_descriptors
+#endif
+
+/* Board support */
+
+#ifdef CONFIG_LIB_BOARDCTL
+#    define SYS_boardctl                __SYS_boardctl
+#  define __SYS_filedesc                (__SYS_boardctl+1)
+#else
+#  define __SYS_filedesc               __SYS_boardctl
 #endif
 
 /* The following are defined if file descriptors are enabled */

syscall/syscall.csv

@@ -6,6 +6,7 @@
 "accept","sys/socket.h","CONFIG_NSOCKET_DESCRIPTORS > 0 && defined(CONFIG_NET)","int","int","struct sockaddr*","socklen_t*"
 "atexit","stdlib.h","defined(CONFIG_SCHED_ATEXIT)","int","void (*)(void)"
 "bind","sys/socket.h","CONFIG_NSOCKET_DESCRIPTORS > 0 && defined(CONFIG_NET)","int","int","FAR const struct sockaddr*","socklen_t"
+"boardctl","sys/boardctl.h","defined(CONFIG_LIB_BOARDCTL)","int","unsigned int","uintptr_t"
 "clearenv","stdlib.h","!defined(CONFIG_DISABLE_ENVIRON)","int"
 "clock_getres","time.h","","int","clockid_t","struct timespec*"
 "clock_gettime","time.h","","int","clockid_t","struct timespec*"

syscall/syscall_funclookup.c

@@ -57,6 +57,7 @@
 #include <sys/prctl.h>
 #include <sys/socket.h>
 #include <sys/mount.h>
+#include <sys/boardctl.h>
 
 #include <stdio.h>
 #include <stdlib.h>

syscall/syscall_lookup.h

@@ -180,6 +180,12 @@ SYSCALL_LOOKUP(up_assert,                 2, STUB_up_assert)
 #  endif
 #endif
 
+/* Board support */
+
+#ifdef CONFIG_LIB_BOARDCTL
+  SYSCALL_LOOKUP(boardctl,                2, STUB_boardctl)
+#endif
+
 /* The following are defined if file descriptors are enabled */
 
 #if CONFIG_NFILE_DESCRIPTORS > 0

syscall/syscall_stublookup.c

@@ -185,6 +185,10 @@ uintptr_t STUB_aio_write(int nbr, uintptr_t parm1);
 uintptr_t STUB_aio_fsync(int nbr, uintptr_t parm1, uintptr_t parm2);
 uintptr_t STUB_aio_cancel(int nbr, uintptr_t parm1, uintptr_t parm2);
 
+/* Board support */
+
+uintptr-t STUB_boardctl(int nbr, uintptr_t parm1, uinptr_1 parm2);
+
 /* The following are defined if file descriptors are enabled */
 
 uintptr_t STUB_closedir(int nbr, uintptr_t parm1);