Add SLCD ioctl commands

ChangeLog

@@ -4782,3 +4782,6 @@
 	  and serialized special SLCD intermixed with normal ASCII data (2013-5-23)
 	* configs/stm32ldiscovery/src/stm32_lcd.c:  STM32L-Discovery's segment LCD
 	  is code complete but completely untested (2013-5-23).
+	* include/nuttx/fs/ioctl.h, include/nuttx/lcd/slcd_codec.h, and
+	  configs/stm32ldiscovery/src/stm32_lcd.c:  Add SLCD ioctl commands to get
+	  SLCD geometry, set bars, and manage contrast (2013-5-23).

configs/stm32ldiscovery/include/board.h

@@ -351,6 +351,19 @@ xcpt_t up_irqbutton(int id, xcpt_t irqhandler);
 #endif
 #endif
 
+/****************************************************************************
+ * Name: stm32_slcd_initialize
+ *
+ * Description:
+ *   Initialize the STM32L-Discovery LCD hardware and register the character
+ *   driver as /dev/slcd.
+ *
+ ****************************************************************************/
+
+#ifdef CONFIG_STM32_LCD
+int stm32_slcd_initialize(void);
+#endif
+
 #undef EXTERN
 #if defined(__cplusplus)
 }

configs/stm32ldiscovery/src/stm32_lcd.c

@@ -120,7 +120,9 @@
 
 /* LCD characteristics */
 
+#define SLCD_NROWS            1
 #define SLCD_NCHARS           6
+#define SLCD_MAXCONTRAST      7
 
 /* An ASCII character may need to be decorated with a colon or decimal point */
 
@@ -283,9 +285,7 @@ struct stm32_slcdstate_s
   uint8_t curpos;               /* The current cursor position */
   uint8_t buffer[SLCD_NCHARS];  /* SLCD ASCII content */
   uint8_t options[SLCD_NCHARS]; /* With colon or decimal point decoration */
-#if 0 /* Not used */
   uint8_t bar[2];               /* Controls the bars on the far right of the SLCD */
-#endif
 };
 
 /****************************************************************************
@@ -295,11 +295,9 @@ struct stm32_slcdstate_s
 
 static void slcd_clear(void);
 static int slcd_getstream(FAR struct lib_instream_s *instream);
-#if 0 /* Not used */
 static uint8_t slcd_getcontrast(void);
 static int slcd_setcontrast(uint8_t contrast);
 static void slcd_writebar(void);
-#endif
 static inline uint16_t slcd_mapch(uint8_t ch);
 static inline void slcd_writemem(uint16_t bitset, int curpos);
 static void slcd_writech(uint8_t ch, uint8_t curpos, uint8_t options);
@@ -310,6 +308,7 @@ static inline void slcd_action(enum slcdcode_e code, uint8_t count);
 
 static ssize_t slcd_read(FAR struct file *, FAR char *, size_t);
 static ssize_t slcd_write(FAR struct file *, FAR const char *, size_t);
+static int slcd_ioctl(FAR struct file *filp, int cmd, unsigned long arg);
 #ifndef CONFIG_DISABLE_POLL
 static int slcd_poll(FAR struct file *filp, FAR struct pollfd *fds, bool setup);
 #endif
@@ -327,7 +326,7 @@ static const struct file_operations g_slcdops =
   slcd_read,     /* read */
   slcd_write,    /* write */
   0,             /* seek */
-  0              /* ioctl */
+  slcd_ioctl     /* ioctl */
 #ifndef CONFIG_DISABLE_POLL
   , slcd_poll    /* poll */
 #endif
@@ -484,21 +483,18 @@ static int slcd_getstream(FAR struct lib_instream_s *instream)
  * Name: slcd_getcontrast
  ****************************************************************************/
 
-#if 0 /* Not used */
 static uint8_t slcd_getcontrast(void)
 {
   return (getreg32(STM32_LCD_FCR) & LCD_FCR_CC_MASK) >> LCD_FCR_CC_SHIFT;
 }
-#endif
 
 /****************************************************************************
  * Name: slcd_setcontrast
  ****************************************************************************/
 
-#if 0 /* Not used */
 static int slcd_setcontrast(uint8_t contrast)
 {
-  uint2_t regval;
+  uint32_t regval;
   int ret = OK;
 
   /* Make sure that the contrast setting is within range */
@@ -513,14 +509,13 @@ static int slcd_setcontrast(uint8_t contrast)
   regval &= !LCD_FCR_CC_MASK;
   regval |= contrast << LCD_FCR_CC_SHIFT;
   putreg32(regval, STM32_LCD_FCR);
+  return ret;
 }
-#endif
 
 /****************************************************************************
  * Name: slcd_writebar
  ****************************************************************************/
 
-#if 0 /* Not used */
 static void slcd_writebar(void)
 {
   uint32_t regval;
@@ -544,14 +539,12 @@ static void slcd_writebar(void)
   regval |= (uint32_t)(g_slcdstate.bar[1] << 12);
   putreg32(regval, STM32_LCD_RAM3L);
 
-
   /* Set the UDR bit to transfer the updated data to the second level
    * buffer.
    */
 
   putreg32(1, SLCD_SR_UDR_BB);
 }
-#endif
 
 /****************************************************************************
  * Name: slcd_mapch
@@ -1120,6 +1113,132 @@ static ssize_t slcd_write(FAR struct file *filp,
   return (ssize_t)len;
 }
 
+/****************************************************************************
+ * Name: slcd_poll
+ ****************************************************************************/
+
+static int slcd_ioctl(FAR struct file *filp, int cmd, unsigned long arg)
+{
+  switch (cmd)
+    {
+
+      /* SLCDIOC_GEOMETRY:  Get the SLCD geometry (rows x characters)
+       *
+       * argument:  Pointer to struct slcd_geometry_s in which values will be
+       *            returned
+       */
+
+      case SLCDIOC_GEOMETRY:
+        {
+          FAR struct slcd_geometry_s *geo = (FAR struct slcd_geometry_s *)((uintptr_t)arg);
+
+          if (!geo)
+            {
+              return -EINVAL;
+            }
+
+          geo->nrows    = SLCD_NROWS;
+          geo->ncolumns = SLCD_NCHARS;
+        }
+        break;
+
+      /* SLCDIOC_SETBAR: Set bars on a bar display
+       *
+       * argument:  32-bit bitset, with each bit corresponding to one bar.
+       */
+
+      case SLCDIOC_SETBAR:
+        {
+          /* Format the bar */
+
+          g_slcdstate.bar[0] = 0;
+          g_slcdstate.bar[1] = 0;
+
+          if ((arg & 1) != 0)
+            {
+              SCLD_BAR0_ON;
+            }
+
+          if ((arg & 2) != 0)
+            {
+              SCLD_BAR1_ON;
+            }
+
+          if ((arg & 4) != 0)
+            {
+              SCLD_BAR2_ON;
+            }
+
+          if ((arg & 8) != 0)
+            {
+              SCLD_BAR3_ON;
+            }
+
+          /* Write the bar to SLCD memory */
+
+          slcd_writebar();
+        }
+        break;
+
+      /* SLCDIOC_GETCONTRAST: Get the current contrast setting
+       *
+       * argument:  Pointer type int that will receive the current contrast
+       *            setting
+       */
+
+      case SLCDIOC_GETCONTRAST:
+        {
+          FAR int *contrast = (FAR int *)((uintptr_t)arg);
+          if (!contrast)
+            {
+              return -EINVAL;
+            }
+
+          *contrast = (int)slcd_getcontrast();
+        }
+        break;
+
+      /* SLCDIOC_MAXCONTRAST: Get the maximum contrast setting
+       *
+       * argument:  Pointer type int that will receive the maximum contrast
+       *            setting
+       */
+
+      case SLCDIOC_MAXCONTRAST:
+        {
+          FAR int *contrast = (FAR int *)((uintptr_t)arg);
+          if (!contrast)
+            {
+              return -EINVAL;
+            }
+
+          *contrast = SLCD_MAXCONTRAST;
+        }
+        break;
+
+      /* SLCDIOC_SETCONTRAST: Set the contrast to a new value
+       *
+       * argument:  The new contrast value
+       */
+
+      case SLCDIOC_SETCONTRAST:
+        {
+          if (arg > SLCD_MAXCONTRAST)
+            {
+              return -ERANGE;
+            }
+
+          return slcd_setcontrast((uint8_t)arg);
+        }
+        break;
+
+      default:
+        return -ENOTTY;
+    }
+
+  return OK;
+}
+
 /****************************************************************************
  * Name: slcd_poll
  ****************************************************************************/
@@ -1130,7 +1249,7 @@ static int slcd_poll(FAR struct file *filp, FAR struct pollfd *fds,
 {
   if (setup)
     {
-      /* Data is always avaialble to be read */
+      /* Data is always avaialble to be read / Data can always be written */
 
       fds->revents |= (fds->events & (POLLIN|POLLOUT));
       if (fds->revents != 0)
@@ -1148,11 +1267,11 @@ static int slcd_poll(FAR struct file *filp, FAR struct pollfd *fds,
  ****************************************************************************/
 
 /****************************************************************************
- * Name:  stm32_slcd_initialize
+ * Name: stm32_slcd_initialize
  *
  * Description:
- *   Initialize the STM32L-Discovery hardware and register the character
+ *   Initialize the STM32L-Discovery LCD hardware and register the character
- *   driver.
+ *   driver as /dev/slcd.
  *
  ****************************************************************************/
 

include/nuttx/fs/ioctl.h

@@ -67,6 +67,7 @@
 #define _BATIOCBASE     (0x0e00) /* Battery driver ioctl commands */
 #define _QEIOCBASE      (0x0f00) /* Quadrature encoder ioctl commands */
 #define _AUDIOIOCBASE   (0x1000) /* Audio ioctl commands */
+#define _SLCDIOCBASE    (0x1100) /* Segment LCD ioctl commands */
 
 /* Macros used to manage ioctl commands */
 
@@ -227,18 +228,24 @@
 #define _BATIOCVALID(c)   (_IOC_TYPE(c)==_BATIOCBASE)
 #define _BATIOC(nr)       _IOC(_BATIOCBASE,nr)
 
-/* NuttX Quadrature Encoder driver ioctol definitions ***********************/
+/* NuttX Quadrature Encoder driver ioctl definitions ************************/
 /* (see nuttx/power/battery.h) */
 
 #define _QEIOCVALID(c)    (_IOC_TYPE(c)==_QEIOCBASE)
 #define _QEIOC(nr)        _IOC(_QEIOCBASE,nr)
 
-/* NuttX Audio driver ioctol definitions ***********************/
+/* NuttX Audio driver ioctl definitions ************************************/
 /* (see nuttx/audio/audio.h) */
 
 #define _AUDIOIOCVALID(c)  (_IOC_TYPE(c)==_AUDIOIOCBASE)
 #define _AUDIOIOC(nr)      _IOC(_AUDIOIOCBASE,nr)
 
+/* Segment LCD driver ioctl definitions ************************************/
+/* (see nuttx/include/lcd/slcd_codec.h */
+
+#define _SLCDIOCVALID(c)   (_IOC_TYPE(c)==_SLCDIOCBASE)
+#define _SLCDIOC(nr)       _IOC(_SLCDIOCBASE,nr)
+
 /****************************************************************************
  * Public Type Definitions
  ****************************************************************************/

include/nuttx/lcd/slcd_codec.h

@@ -43,12 +43,52 @@
 
 #include <nuttx/config.h>
 #include <nuttx/streams.h>
+#include <nuttx/fs/ioctl.h>
 
 #ifdef CONFIG_LIB_SLCDCODEC
 
 /****************************************************************************
  * Pre-processor Definitions
  ****************************************************************************/
+/* IOCTL commands that may be supported by some SLCD drivers */
+
+/* SLCDIOC_GEOMETRY:  Get the SLCD geometry (rows x characters)
+ *
+ * argument:  Pointer to struct slcd_geometry_s in which values will be
+ *            returned
+ */
+
+#define SLCDIOC_GEOMETRY    _SLCDIOC(0x0001)
+
+/* SLCDIOC_SETBAR: Set bars on a bar display
+ *
+ * argument:  32-bit bitset, with each bit corresponding to one bar.
+ */
+
+#define SLCDIOC_SETBAR      _SLCDIOC(0x0002)
+
+/* SLCDIOC_GETCONTRAST: Get the current contrast setting
+ *
+ * argument:  Pointer type int that will receive the current contrast
+ *            setting
+ */
+
+#define SLCDIOC_GETCONTRAST _SLCDIOC(0x0003)
+
+/* SLCDIOC_MAXCONTRAST: Get the maximum contrast setting
+ *
+ * argument:  Pointer type int that will receive the maximum contrast
+ *            setting
+ */
+
+#define SLCDIOC_MAXCONTRAST _SLCDIOC(0x0004)
+
+/* SLCDIOC_SETCONTRAST: Set the contrast to a new value
+ *
+ * argument:  The new contrast value
+ */
+
+#define SLCDIOC_SETCONTRAST _SLCDIOC(0x0005)
 
 /****************************************************************************
  * Public Types
@@ -102,10 +142,14 @@ enum slcdret_e
   SLCDRET_EOF               /* An EOF (or possibly an error) occurred */
 };
 
-/****************************************************************************
+/* Used with the SLCDIOC_GEOMETRY ioctl call */
- * Public Types
+
- ****************************************************************************/
+struct slcd_geometry_s
- 
+{
+  uint16_t nrows;           /* Number of the rows on the SLCD */
+  uint16_t ncolumns;        /* Number of characters in one row on the SLCD */
+};
+
 /* Working data needed by slcd_encode that must be provided and initialized
  * by the caller.
  */