SAMA5D4-EK: Add WM8904 initialization logic

3 files changed, 385 insertions, 0 deletions

diff --git a/nuttx/configs/sama5d4-ek/src/Makefile b/nuttx/configs/sama5d4-ek/src/Makefile
index 39779fea2..0f29ff922 100644
--- a/nuttx/configs/sama5d4-ek/src/Makefile
+++ b/nuttx/configs/sama5d4-ek/src/Makefile
@@ -76,6 +76,14 @@ CSRCS += sam_at25.c
 endif
 endif
 
+ifeq ($(CONFIG_AUDIO_WM8904),y)
+ifeq ($(CONFIG_SAMA5_TWI0),y)
+ifeq ($(CONFIG_SAMA5_SSC0),y)
+CSRCS += sam_wm8904.c
+endif
+endif
+endif
+
 ifeq ($(CONFIG_SAMA5_HSMCI0),y)
 CSRCS += sam_hsmci.c
 else
diff --git a/nuttx/configs/sama5d4-ek/src/sam_wm8904.c b/nuttx/configs/sama5d4-ek/src/sam_wm8904.c
new file mode 100644
index 000000000..09d188b84
--- /dev/null
+++ b/nuttx/configs/sama5d4-ek/src/sam_wm8904.c
@@ -0,0 +1,316 @@
+/************************************************************************************
+ * configs/sama5d4-ek/src/sam_wm8904.c
+ *
+ *   Copyright (C) 2014 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 <stdbool.h>
+#include <stdio.h>
+#include <debug.h>
+#include <assert.h>
+#include <errno.h>
+
+#include <nuttx/i2c.h>
+#include <nuttx/audio/i2s.h>
+#include <nuttx/audio/wm8904.h>
+
+#include "up_arch.h"
+#include "sam_pio.h"
+#include "sam_twi.h"
+#include "sam_ssc.h"
+
+#include "sama5d4-ek.h"
+
+#ifdef HAVE_WM8904
+
+/****************************************************************************
+ * Pre-Processor Definitions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Private Types
+ ****************************************************************************/
+
+struct sama5d4ek_mwinfo_s
+{
+  /* Standard MW8904 interface */
+
+  struct wm8904_lower_s lower;
+
+  /* Extensions for the sama5d4ek board */
+
+  wm8904_handler_t handler;
+  FAR void *arg;
+};
+
+/****************************************************************************
+ * Private Function Prototypes
+ ****************************************************************************/
+
+/* IRQ/PIO access callbacks.  These operations all hidden behind
+ * callbacks to isolate the WM8904 driver from differences in PIO
+ * interrupt handling by varying boards and MCUs.  If possible,
+ * interrupts should be configured on both rising and falling edges
+ * so that contact and loss-of-contact events can be detected.
+ *
+ *   attach  - Attach the WM8904 interrupt handler to the PIO interrupt
+ *   enable  - Enable or disable the PIO interrupt
+ */
+
+static int  wm8904_attach(FAR const struct wm8904_lower_s *lower,
+                          wm8904_handler_t isr, FAR void *arg);
+static void wm8904_enable(FAR const struct wm8904_lower_s *lower,
+                          bool enable);
+
+/****************************************************************************
+ * Private Data
+ ****************************************************************************/
+
+/* A reference to a structure of this type must be passed to the WM8904
+ * driver.  This structure provides information about the configuration
+ * of the WM8904 and provides some board-specific hooks.
+ *
+ * Memory for this structure is provided by the caller.  It is not copied
+ * by the driver and is presumed to persist while the driver is active.
+ */
+
+static struct sama5d4ek_mwinfo_s g_mxtinfo =
+{
+  .lower =
+  {
+    .address   = WM8904_I2C_ADDRESS,
+    .frequency = CONFIG_SAMA5D4EK_WM8904_I2CFREQUENCY,
+
+    .attach    = wm8904_attach,
+    .enable    = wm8904_enable,
+  },
+};
+
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * IRQ/PIO access callbacks.  These operations all hidden behind
+ * callbacks to isolate the WM8904 driver from differences in PIO
+ * interrupt handling by varying boards and MCUs.  If possible,
+ * interrupts should be configured on both rising and falling edges
+ * so that contact and loss-of-contact events can be detected.
+ *
+ *   attach  - Attach the WM8904 interrupt handler to the PIO interrupt
+ *   enable  - Enable or disable the PIO interrupt
+ *   clear   - Acknowledge/clear any pending PIO interrupt
+ *
+ ****************************************************************************/
+
+static int wm8904_attach(FAR const struct wm8904_lower_s *lower,
+                         wm8904_handler_t isr,  FAR void *arg)
+{
+  if (isr)
+    {
+      /* Just save the address of the handler and its argument for now.  The
+       * new handler will called via wm8904_interrupt() when the interrupt occurs.
+       */
+
+      ivdbg("Attaching %p\n", isr);
+      g_mxtinfo.handler = isr;
+      g_mxtinfo.arg = arg;
+    }
+  else
+    {
+      ivdbg("Detaching %p\n", g_mxtinfo.handler);
+      wm8904_enable(lower, false);
+      g_mxtinfo.handler = NULL;
+      g_mxtinfo.arg = NULL;
+    }
+
+  return OK;
+}
+
+static void wm8904_enable(FAR const struct wm8904_lower_s *lower, bool enable)
+{
+  /* Enable or disable interrupts */
+
+  if (enable && g_mxtinfo.handler)
+    {
+      sam_pioirqenable(IRQ_INT_WM8904);
+    }
+  else
+    {
+      sam_pioirqdisable(IRQ_INT_WM8904);
+    }
+}
+
+static int wm8904_interrupt(int irq, FAR void *context)
+{
+  /* Just forward the interrupt to the WM8904 driver */
+
+  if (g_mxtinfo.handler)
+    {
+      return g_mxtinfo.handler(&g_mxtinfo.lower, g_mxtinfo.arg);
+    }
+
+  /* We got an interrupt with no handler.  This should not
+   * happen.
+   */
+
+  sam_pioirqdisable(IRQ_INT_WM8904);
+  return OK;
+}
+
+/****************************************************************************
+ * Public Functions
+ ****************************************************************************/
+
+/****************************************************************************
+ * Name: sam_wm8904_initialize
+ *
+ * Description:
+ *   This function is called by platform-specific, setup logic to configure
+ *   and register the WM8904 device.  This function will register the driver
+ *   as /dev/wm8904[x] where x is determined by the minor device number.
+ *
+ * Input Parameters:
+ *   minor - The input device minor number
+ *
+ * Returned Value:
+ *   Zero is returned on success.  Otherwise, a negated errno value is
+ *   returned to indicate the nature of the failure.
+ *
+ ****************************************************************************/
+
+int sam_wm8904_initialize(int minor)
+{
+  FAR struct audio_lowerhalf_s *audio;
+  FAR struct i2c_dev_s *i2c;
+  FAR struct i2s_dev_s *i2s;
+  static bool initialized = false;
+  char devname[8];
+  int ret;
+
+  auddbg("minor %d\n", minor);
+  DEBUGASSERT(minor >= 0 && minor <= 25);
+
+  /* Have we already initialized?  Since we never uninitialize we must prevent
+   * multiple initializations.  This is necessary, for example, when the
+   * touchscreen example is used as a built-in application in NSH and can be
+   * called numerous time.  It will attempt to initialize each time.
+   */
+
+  if (!initialized)
+    {
+      /* Configure the WM8904 interrupt pin */
+
+      (void)sam_configpio(PIO_INT_WM8904);
+
+      /* Get an instance of the I2C interface for the WM8904 chip select */
+
+      i2c = up_i2cinitialize(WM8904_TWI_BUS);
+      if (!i2c)
+        {
+          auddbg("Failed to initialize TWI%d\n", WM8904_TWI_BUS);
+          ret = -ENODEV;
+          goto errout;
+        }
+
+      /* Get an instance of the I2S interface for the WM8904 data channel */
+
+      i2s = sam_ssc_initialize(WM8904_SSC_BUS);
+      if (!i2s)
+        {
+          auddbg("Failed to initialize SSC%d\n", WM8904_SSC_BUS);
+          ret = -ENODEV;
+          goto errout_with_i2c;
+        }
+
+      /* Now we can use these I2C and I2S interfaces to initialize the
+       * MW8904 which will return an audio interface.
+       */
+
+      audio = wm8904_initialize(i2c, i2s, &g_mxtinfo.lower, minor);
+      if (!audio)
+        {
+          auddbg("Failed to initialize the WM8904\n");
+          ret = -ENODEV;
+          goto errout_with_i2s;
+        }
+
+      /* Configure WM8904 interrupts */
+
+      sam_pioirq(PIO_INT_WM8904);
+      ret = irq_attach(IRQ_INT_WM8904, wm8904_interrupt);
+      if (ret < 0)
+        {
+          auddbg("ERROR: Failed to register WM8904 device: %d\n", ret);
+          goto errout_with_audio;
+        }
+
+      /* Create a device name */
+
+      snprintf(devname, 8, "wm8904%c", 'a' + minor);
+
+      /* Register the WM8904 audio device */
+
+      ret = audio_register(devname, audio);
+      if (ret < 0)
+        {
+          auddbg("ERROR: Failed to register /dev/%s device: %d\n", devname, ret);
+          goto errout_with_irq;
+        }
+
+      /* Now we are initialized */
+
+      initialized = true;
+    }
+
+  return OK;
+
+  /* Error exits.  Unfortunately there is no mechanism in place now to
+   * recover errors on initialization failures.
+   */
+
+errout_with_irq:
+  irq_detach(IRQ_INT_WM8904);
+errout_with_audio:
+errout_with_i2s:
+errout_with_i2c:
+errout:
+  return ret;
+}
+
+#endif /* HAVE_WM8904 */
diff --git a/nuttx/configs/sama5d4-ek/src/sama5d4-ek.h b/nuttx/configs/sama5d4-ek/src/sama5d4-ek.h
index c539202af..5286716b5 100644
--- a/nuttx/configs/sama5d4-ek/src/sama5d4-ek.h
+++ b/nuttx/configs/sama5d4-ek/src/sama5d4-ek.h
@@ -64,6 +64,7 @@
 #define HAVE_USBMONITOR 1
 #define HAVE_NETWORK    1
 #define HAVE_MAXTOUCH   1
+#define HAVE_WM8904     1
 
 /* HSMCI */
 /* Can't support MMC/SD if the card interface(s) are not enable */
@@ -315,6 +316,36 @@
 #  endif
 #endif
 
+/* Audio */
+/* Default configuration values */
+
+#ifndef CONFIG_AUDIO_WM8904
+#  undef HAVE_WM8904
+#endif
+
+#ifdef HAVE_WM8904
+#  ifndef CONFIG_SAMA5_TWI0
+#    warning CONFIG_SAMA5_TWI0 is required for audio support
+#    undef HAVE_WM8904
+#  endif
+
+#  ifndef CONFIG_SAMA5_SSC0
+#    warning CONFIG_SAMA5_SSC0 is required for audio support
+#    undef HAVE_WM8904
+#  endif
+
+#  ifndef CONFIG_SAMA5D4EK_WM8904_I2CFREQUENCY
+#    warning Defaulting to maximum WM8904 I2C frequency
+#    define CONFIG_SAMA5D4EK_WM8904_I2CFREQUENCY 400000
+#  endif
+
+#  if CONFIG_SAMA5D4EK_WM8904_I2CFREQUENCY > 400000
+#    warning WM8904 I2C frequency cannot exceed 400KHz
+#    undef CONFIG_SAMA5D4EK_WM8904_I2CFREQUENCY
+#    define CONFIG_SAMA5D4EK_WM8904_I2CFREQUENCY 400000
+#  endif
+#endif
+
 /* LEDs *****************************************************************************/
 /* There are 3 LEDs on the SAMA5D4-EK:
  *
@@ -649,6 +680,15 @@
                         PIO_INT_BOTHEDGES | PIO_PORT_PIOE | PIO_PIN4)
 #define IRQ_INT_WM8904 SAM_IRQ_PE4
 
+/* The MW8904 communicates on TWI0, I2C address 0x1a for control operations */
+
+#define WM8904_TWI_BUS      0
+#define WM8904_I2C_ADDRESS  0x1a
+
+/* The MW8904 transfers data on SSC0 */
+
+#define WM8904_SSC_BUS      0
+
 /* SPI Chip Selects *****************************************************************/
 /* The SAMA5D4-EK includes an Atmel AT25DF321A, 32-megabit, 2.7-volt SPI serial
  * FLASH on board.  The connection is as follows:
@@ -859,6 +899,27 @@ void board_led_initialize(void);
 int nsh_archinitialize(void);
 #endif
 
+/****************************************************************************
+ * Name: sam_wm8904_initialize
+ *
+ * Description:
+ *   This function is called by platform-specific, setup logic to configure
+ *   and register the WM8904 device.  This function will register the driver
+ *   as /dev/wm8904[x] where x is determined by the minor device number.
+ *
+ * Input Parameters:
+ *   minor - The input device minor number
+ *
+ * Returned Value:
+ *   Zero is returned on success.  Otherwise, a negated errno value is
+ *   returned to indicate the nature of the failure.
+ *
+ ****************************************************************************/
+
+#ifdef HAVE_WM8904
+int sam_wm8904_initialize(int minor);
+#endif /* HAVE_WM8904 */
+
 #endif /* __ASSEMBLY__ */
 #endif /* __CONFIGS_SAMA5D4_EK_SRC_SAMA5D4_EK_H */