Beginning of an SMTPE11 touchscreen/IO expander driver

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

3 files changed, 487 insertions, 10 deletions

diff --git a/nuttx/drivers/input/Make.defs b/nuttx/drivers/input/Make.defs
index e32dc4549..ff01217cb 100644
--- a/nuttx/drivers/input/Make.defs
+++ b/nuttx/drivers/input/Make.defs
@@ -47,6 +47,10 @@ ifeq ($(CONFIG_INPUT_ADS7843E),y)
   CSRCS += ads7843e.c
 endif
 
+ifeq ($(CONFIG_INPUT_STMPE11),y)
+  CSRCS += stmpe11_base.c
+endif
+
 # Include input device driver build support
 
 DEPPATH += --dep-path input
diff --git a/nuttx/drivers/input/stmpe11.h b/nuttx/drivers/input/stmpe11.h
index c02cff488..1ab347191 100644
--- a/nuttx/drivers/input/stmpe11.h
+++ b/nuttx/drivers/input/stmpe11.h
@@ -44,28 +44,135 @@
  * Included Files
  ********************************************************************************************/
 
+#include <nuttx/config.h>
+
+#include <semaphore.h>
+
+#include <nuttx/wqueue.h>
+#include <nuttx/input/stmpe11.h>
+
+#if defined(CONFIG_INPUT) && defined(CONFIG_INPUT_STMPE11)
+
 /********************************************************************************************
  * Pre-Processor Definitions
  ********************************************************************************************/
+/* Configuration ****************************************************************************/
+/* Reference counting is partially implemented, but not needed in the current design.
+ */
+
+#undef CONFIG_STMPE11_REFCNT
+
+/* No support for the SPI interface yet */
+
+#ifdef CONFIG_STMPE11_SPI
+#  error "Only the STMPE11 I2C interface is supported by this driver"
+#endif
+
+/* Driver support ***************************************************************************/
+/* This format is used to construct the /dev/input[n] device driver path.  It defined here
+ * so that it will be used consistently in all places.
+ */
+
+#define DEV_FORMAT   "/dev/input%d"
+#define DEV_NAMELEN  16
 
 /********************************************************************************************
  * Public Types
  ********************************************************************************************/
+/* This describes the state of one contact */
 
-/********************************************************************************************
- * Public Function Prototypes
- ********************************************************************************************/
+enum stmpe11_contact_3
+{
+  CONTACT_NONE = 0,                    /* No contact */
+  CONTACT_DOWN,                        /* First contact */
+  CONTACT_MOVE,                        /* Same contact, possibly different position */
+  CONTACT_UP,                          /* Contact lost */
+};
+
+/* This structure describes the results of one STMPE11 sample */
 
-#ifdef __cplusplus
-#define EXTERN extern "C"
-extern "C" {
+struct stmpe11_sample_s
+{
+  uint8_t  id;                         /* Sampled touch point ID */
+  uint8_t  contact;                    /* Contact state (see enum stmpe11_contact_e) */
+  uint16_t x;                          /* Measured X position */
+  uint16_t y;                          /* Measured Y position */
+  uint16_t z;                          /* Measured Z position */
+};
+
+/* This structure represents the state of the SMTPE11 driver */
+
+struct stmpe11_dev_s
+{
+#ifdef CONFIG_STMPE11_MULTIPLE
+  FAR struct stmpe11_dev_s *flink;      /* Supports a singly linked list of drivers */
+#endif
+#ifdef CONFIG_STMPE11_REFCNT
+  uint8_t crefs;                       /* Number of times the device has been opened */
+#endif
+  uint8_t nwaiters;                    /* Number of threads waiting for STMPE11 data */
+  uint8_t inuse;                       /* SMTPE11 pins in use */
+  uint8_t id;                          /* Current touch point ID (TSC only) */
+  uint8_t minor;                       /* Touchscreen minor device number (TSC only) */
+  volatile bool penchange;             /* An unreported event is buffered (TSC only) */
+  sem_t devsem;                        /* Manages exclusive access to this structure */
+  sem_t waitsem;                       /* Used to wait for the availability of data */
+  uint32_t threshx;                    /* Thresholded X value (TSC only) */
+  uint32_t threshy;                    /* Thresholded Y value (TSC only) */
+
+#ifdef CONFIG_STMPE11_SPI
+  FAR struct spi_dev_s *spi;           /* Saved SPI driver instance */
 #else
-#define EXTERN extern
+  FAR struct i2c_dev_s *i2c;           /* Saved I2C driver instance */
 #endif
 
-#undef EXTERN
-#ifdef __cplusplus
-}
+  FAR struct stmpe11_config_s *config; /* Board configuration data (TSC only) */
+  struct work_s work;                  /* Supports the interrupt handling "bottom half" */
+  struct stmpe11_sample_s sample;      /* Last sampled touch point data (TSC only) */
+
+  /* The following is a list if poll structures of threads waiting for
+   * driver events. The 'struct pollfd' reference for each open is also
+   * retained in the f_priv field of the 'struct file'.
+   */
+
+#ifndef CONFIG_DISABLE_POLL
+  struct pollfd *fds[CONFIG_STMPE11_NPOLLWAITERS];
 #endif
+};
+
+/********************************************************************************************
+ * Public Function Prototypes
+ ********************************************************************************************/
+
+/********************************************************************************************
+ * Name: stmpe11_getreg8
+ *
+ * Description:
+ *   Read from an 8-bit STMPE11 register
+ *
+ ********************************************************************************************/
+
+static uint8_t stmpe11_getreg8(FAR struct stmpe11_dev_s *priv, uint8_t regaddr);
+
+/********************************************************************************************
+ * Name: stmpe11_putreg8
+ *
+ * Description:
+ *   Write a value to an 8-bit STMPE11 register
+ *
+ ********************************************************************************************/
+
+void stmpe11_putreg8(FAR struct stmpe11_dev_s *priv, uint8_t regaddr, uint8_t regval);
+
+/********************************************************************************************
+ * Name: stmpe11_getreg16
+ *
+ * Description:
+ *   Read 16-bits of data from an STMPE-11 register
+ *
+ ********************************************************************************************/
+
+uint16_t stmpe11_getreg16(FAR struct stmpe11_dev_s *priv, uint8_t regaddr);
 
+#endif /* CONFIG_INPUT && CONFIG_INPUT_STMPE11 */
 #endif /* __DRIVERS_INPUT_STMPE11_H */
diff --git a/nuttx/drivers/input/stmpe11_base.c b/nuttx/drivers/input/stmpe11_base.c
new file mode 100644
index 000000000..25f6a1e81
--- /dev/null
+++ b/nuttx/drivers/input/stmpe11_base.c
@@ -0,0 +1,366 @@
+/****************************************************************************
+ * drivers/input/stmpe11_base.c
+ *
+ *   Copyright (C) 2012 Gregory Nutt. All rights reserved.
+ *   Author: Gregory Nutt <gnutt@nuttx.org>
+ *
+ * References:
+ *   "STMPE811 S-Touch® advanced resistive touchscreen controller with 8-bit
+ *    GPIO expander," Doc ID 14489 Rev 6, CD00186725, STMicroelectronics"
+ *
+ * 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 <errno.h>
+#include <debug.h>
+
+#include <nuttx/arch.h>
+#include <nuttx/input/stmpe11.h>
+
+#include "stmpe11.h"
+
+#if defined(CONFIG_INPUT) && defined(CONFIG_INPUT_STMPE11)
+
+/****************************************************************************
+ * Private Types
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Data
+ ****************************************************************************/
+
+/* If only a single STMPE11 device is supported, then the driver state
+ * structure may as well be pre-allocated.
+ */
+
+#ifndef CONFIG_STMPE11_MULTIPLE
+static struct stmpe11_dev_s g_stmpe11;
+
+/* Otherwise, we will need to maintain allocated driver instances in a list */
+
+#else
+static struct stmpe11_dev_s *g_stmpe11list;
+#endif
+
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: stmpe11_checkid
+ *
+ * Description:
+ *   Read and verify the STMPE11 chip ID
+ *
+ ****************************************************************************/
+
+static int stmpe11_checkid(FAR struct stmpe11_dev_s *priv)
+{
+  uint16_t devid = 0;
+
+  /* Read device ID  */
+
+  devid = stmpe11_getreg8(priv, STMPE11_CHIP_ID);
+  devid = (uint32_t)(devid << 8);
+  devid |= (uint32_t)stmpe11_getreg8(priv, STMPE11_CHIP_ID+1);
+  ivdbg("devid: %04x\n", devid);
+
+  if (devid != (uint16_t)CHIP_ID)
+    {
+      /* ID is not Correct */
+
+      return -ENODEV;
+    }
+
+  return OK;
+}
+
+/****************************************************************************
+ * Name: stmpe11_reset
+ *
+ * Description:
+ *  Reset the STMPE11
+ *
+ ****************************************************************************/
+
+static void stmpe11_reset(FAR struct stmpe11_dev_s *priv)
+{
+  /* Power Down the STMPE11 */
+
+  stmpe11_putreg8(priv, STMPE11_SYS_CTRL1, SYS_CTRL1_SOFTRESET);
+
+  /* Wait a bit */
+
+  up_mdelay(20);
+
+  /* Then power on again.  All registers will be in their reset state. */
+
+  stmpe11_putreg8(priv, STMPE11_SYS_CTRL1, 0);
+}
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: stmpe11_instantiate
+ *
+ * Description:
+ *   Instantiate and configure the STMPE11 device driver to use the provided
+ *   I2C or SPIdevice instance.
+ *
+ * Input Parameters:
+ *   dev     - An I2C or SPI driver instance
+ *   config  - Persistant board configuration data
+ *
+ * Returned Value:
+ *   A non-zero handle is returned on success.  This handle may then be used
+ *   to configure the STMPE11 driver as necessary.  A NULL handle value is
+ *   returned on failure.
+ *
+ ****************************************************************************/
+
+#ifdef CONFIG_STMPE11_SPI
+STMPE11_HANDLE stmpe11_instantiate(FAR struct spi_dev_s *dev,
+                                   FAR struct stmpe11_config_s *config)
+#else
+STMPE11_HANDLE stmpe11_instantiate(FAR struct i2c_dev_s *dev,
+                                   FAR struct stmpe11_config_s *config)
+#endif
+{
+  FAR struct stmpe11_dev_s *priv;
+  int ret;
+
+  /* On entry the following is assumed:
+   *
+   * I2C initialization ready
+   * GPIO pins already configured.
+   */
+
+  /* Allocate the device state structure */
+
+#ifdef CONFIG_STMPE11_MULTIPLE
+  priv = (FAR struct stmpe11_dev_s *)kzalloc(sizeof(struct stmpe11_dev_s));
+  if (!priv)
+    {
+      return -ENOMEM;
+    }
+
+  /* And save the device structure in the list of STMPE11 so that we can find it later */
+
+  priv->flink   = g_stmpe11list;
+  g_stmpe11list = priv;
+#else
+
+  /* Use the one-and-only STMPE11 driver instance */
+
+  priv = &g_stmpe11;
+#endif
+
+  /* Initialize the device state structure */
+
+#ifdef CONFIG_STMPE11_SPI
+  priv->spi = dev;
+#else
+  priv->i2c = dev;
+#endif
+
+  /* Read and verify the STMPE11 chip ID */
+
+  ret = stmpe11_checkid(priv);
+  if (ret < 0)
+    {
+#ifdef CONFIG_STMPE11_MULTIPLE
+      kfree(priv);
+#endif
+      return NULL;
+    }
+
+  /* Generate STMPE11 Software reset */
+
+  stmpe11_reset(priv);
+  return (STMPE11_HANDLE)priv;
+}
+
+/****************************************************************************
+ * Name: stmpe11_getreg8
+ *
+ * Description:
+ *   Read from an 8-bit STMPE11 register
+ *
+ ****************************************************************************/
+
+#ifdef CONFIG_STMPE11_I2C
+uint8_t stmpe11_getreg8(FAR struct stmpe11_dev_s *priv, uint8_t regaddr)
+{
+  /* 8-bit data read sequence:
+   *
+   *  Start - I2C_Write_Address - STMPE11_Reg_Address - 
+   *    Repeated_Start - I2C_Read_Address  - STMPE11_Read_Data - STOP
+   */
+
+  struct i2c_msg_s msg[2];
+  uint8_t regval;
+  int ret;
+
+  /* Setup 8-bit STMPE11 address write message */
+
+  msg[0].addr   = priv->config->address; /* 7-bit address */
+  msg[0].flags  = 0;                     /* Write transaction, beginning with START */
+  msg[0].buffer = &regaddr;              /* Transfer from this address */
+  msg[0].length = 1;                     /* Send one byte following the address
+                                          * (no STOP) */
+
+  /* Set up the 8-bit STMPE11 data read message */
+  
+  msg[1].addr   = priv->config->address; /* 7-bit address */
+  msg[1].flags  = I2C_M_READ;            /* Read transaction, beginning with Re-START */
+  msg[1].buffer = &regval;               /* Transfer to this address */
+  msg[1].length = 1;                     /* Receive one byte following the address
+                                          * (then STOP) */
+
+  /* Perform the transfer */
+
+  ret = I2C_TRANSFER(priv->i2c, msg, 2);
+  if (ret < 0)
+    {
+      idbg("I2C_TRANSFER failed: %d\n", ret);
+      return 0;
+    }
+
+  return regval;
+}
+#endif
+
+/****************************************************************************
+ * Name: stmpe11_putreg8
+ *
+ * Description:
+ *   Write a value to an 8-bit STMPE11 register
+ *
+ ****************************************************************************/
+
+#ifdef CONFIG_STMPE11_I2C
+void stmpe11_putreg8(FAR struct stmpe11_dev_s *priv,
+                     uint8_t regaddr, uint8_t regval)
+{
+  /* 8-bit data read sequence:
+   *
+   *  Start - I2C_Write_Address - STMPE11_Reg_Address - STMPE11_Write_Data - STOP
+   */
+
+  struct i2c_msg_s msg;
+  uint8_t txbuffer[2];
+  int ret;
+
+  /* Setup to the data to be transferred.  Two bytes:  The STMPE11 register
+   * address followed by one byte of data.
+   */
+
+  txbuffer[0] = regaddr;
+  txbuffer[1] = regval;
+
+  /* Setup 8-bit STMPE11 address write message */
+
+  msg.addr   = priv->config->address; /* 7-bit address */
+  msg.flags  = 0;                     /* Write transaction, beginning with START */
+  msg.buffer = txbuffer;              /* Transfer from this address */
+  msg.length = 2;                     /* Send two byte following the address
+                                       * (then STOP) */
+
+  /* Perform the transfer */
+
+  ret = I2C_TRANSFER(priv->i2c, &msg, 1);
+  if (ret < 0)
+    {
+      idbg("I2C_TRANSFER failed: %d\n", ret);
+    }
+}
+#endif
+
+/****************************************************************************
+ * Name: stmpe11_getreg16
+ *
+ * Description:
+ *   Read 16-bits of data from an STMPE-11 register
+ *
+ ****************************************************************************/
+
+#ifdef CONFIG_STMPE11_I2C
+uint16_t stmpe11_getreg16(FAR struct stmpe11_dev_s *priv, uint8_t regaddr)
+{
+  /* 16-bit data read sequence:
+   *
+   *  Start - I2C_Write_Address - STMPE11_Reg_Address - 
+   *    Repeated_Start - I2C_Read_Address  - STMPE11_Read_Data_1 -
+   *      STMPE11_Read_Data_2 - STOP
+   */
+
+
+  struct i2c_msg_s msg[2];
+  uint8_t rxbuffer[2];
+  int ret;
+
+  /* Setup 8-bit STMPE11 address write message */
+
+  msg[0].addr   = priv->config->address; /* 7-bit address */
+  msg[0].flags  = 0;                     /* Write transaction, beginning with START */
+  msg[0].buffer = &regaddr;              /* Transfer from this address */
+  msg[0].length = 1;                     /* Send one byte following the address
+                                          * (no STOP) */
+
+  /* Set up the 8-bit STMPE11 data read message */
+  
+  msg[1].addr   = priv->config->address; /* 7-bit address */
+  msg[1].flags  = I2C_M_READ;            /* Read transaction, beginning with Re-START */
+  msg[1].buffer = rxbuffer;              /* Transfer to this address */
+  msg[1].length = 2;                     /* Receive two bytes following the address
+                                          * (then STOP) */
+
+  /* Perform the transfer */
+
+  ret = I2C_TRANSFER(priv->i2c, msg, 2);
+  if (ret < 0)
+    {
+      idbg("I2C_TRANSFER failed: %d\n", ret);
+      return 0;
+    }
+
+  return (uint16_t)rxbuffer[0] << 16 | (uint16_t)rxbuffer[1];
+}
+#endif
+
+#endif /* CONFIG_INPUT && CONFIG_INPUT_STMPE11 */
+