123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279 |
- /****************************************************************************
- * include/nuttx/audio/wm8904.h
- *
- * Copyright (C) 2014 Gregory Nutt. All rights reserved.
- * Author: Gregory Nutt <gnutt@nuttx.org>
- *
- * Reference:
- * "WM8904 Ultra Low Power CODEC for Portable Audio Applications, Pre-
- * Production", September 2012, Rev 3.3, Wolfson Microelectronics
- *
- * 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_NUTTX_AUDIO_WM8904_H
- #define __INCLUDE_NUTTX_AUDIO_WM8904_H
- /****************************************************************************
- * Included Files
- ****************************************************************************/
- #include <stdint.h>
- #include <stdbool.h>
- #include <nuttx/irq.h>
- #ifdef CONFIG_AUDIO_WM8904
- /****************************************************************************
- * Pre-processor Definitions
- ****************************************************************************/
- /* Configuration ************************************************************
- *
- * CONFIG_AUDIO_WM8904 - Enables WM8904 support
- * CONFIG_WM8904_INITVOLUME - The initial volume level in the range {0..1000}
- * CONFIG_WM8904_INFLIGHT - Maximum number of buffers that the WM8904 driver
- * will send to the I2S driver before any have completed.
- * CONFIG_WM8904_MSG_PRIO - Priority of messages sent to the WM8904 worker
- * thread.
- * CONFIG_WM8904_BUFFER_SIZE - Preferred buffer size
- * CONFIG_WM8904_NUM_BUFFERS - Preferred number of buffers
- * CONFIG_WM8904_WORKER_STACKSIZE - Stack size to use when creating the
- * WM8904 worker thread.
- * CONFIG_WM8904_REGDUMP - Enable logic to dump all WM8904 registers to
- * the SYSLOG device.
- */
- /* Pre-requisites */
- #ifndef CONFIG_AUDIO
- # error CONFIG_AUDIO is required for audio subsystem support
- #endif
- #ifndef CONFIG_I2S
- # error CONFIG_I2S is required by the WM8904 driver
- #endif
- #ifndef CONFIG_I2C
- # error CONFIG_I2C is required by the WM8904 driver
- #endif
- #ifndef CONFIG_SCHED_WORKQUEUE
- # error CONFIG_SCHED_WORKQUEUE is required by the WM8904 driver
- #endif
- /* Default configuration values */
- #ifndef CONFIG_WM8904_INITVOLUME
- # define CONFIG_WM8904_INITVOLUME 250
- #endif
- #ifndef CONFIG_WM8904_INFLIGHT
- # define CONFIG_WM8904_INFLIGHT 2
- #endif
- #if CONFIG_WM8904_INFLIGHT > 255
- # error CONFIG_WM8904_INFLIGHT must fit in a uint8_t
- #endif
- #ifndef CONFIG_WM8904_MSG_PRIO
- # define CONFIG_WM8904_MSG_PRIO 1
- #endif
- #ifndef CONFIG_WM8904_BUFFER_SIZE
- # define CONFIG_WM8904_BUFFER_SIZE 8192
- #endif
- #ifndef CONFIG_WM8904_NUM_BUFFERS
- # define CONFIG_WM8904_NUM_BUFFERS 4
- #endif
- #ifndef CONFIG_WM8904_WORKER_STACKSIZE
- # define CONFIG_WM8904_WORKER_STACKSIZE 768
- #endif
- /* Helper macros ************************************************************/
- #define WM8904_ATTACH(s,isr,arg) ((s)->attach(s,isr,arg))
- #define WM8904_DETACH(s) ((s)->attach(s,NULL,NULL))
- #define WM8904_ENABLE(s) ((s)->enable(s,true))
- #define WM8904_DISABLE(s) ((s)->enable(s,false))
- #define WM8904_RESTORE(s,e) ((s)->enable(s,e))
- /****************************************************************************
- * Public Types
- ****************************************************************************/
- /* This is the type of the WM8904 interrupt handler. The lower level code
- * will intercept the interrupt and provide the upper level with the private
- * data that was provided when the interrupt was attached.
- */
- struct wm8904_lower_s; /* Forward reference. Defined below */
- typedef CODE int (*wm8904_handler_t)(FAR const struct wm8904_lower_s *lower,
- FAR void *arg);
- /* 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.
- */
- struct wm8904_lower_s
- {
- /* I2C characterization */
- uint32_t frequency; /* Initial I2C frequency */
- uint8_t address; /* 7-bit I2C address (only bits 0-6 used) */
- /* Clocking is provided via MCLK. The WM8904 driver will need to know
- * the frequency of MCLK in order to generate the correct bitrates.
- */
- uint32_t mclk; /* W8904 Master clock frequency */
- /* IRQ/GPIO access callbacks. These operations all hidden behind
- * callbacks to isolate the WM8904 driver from differences in GPIO
- * 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 or detach the WM8904 interrupt handler to the GPIO
- * interrupt
- * enable - Enable or disable the GPIO interrupt. Returns the
- * previous interrupt state.
- */
- CODE int (*attach)(FAR const struct wm8904_lower_s *lower,
- wm8904_handler_t isr, FAR void *arg);
- CODE bool (*enable)(FAR const struct wm8904_lower_s *lower, bool enable);
- };
- /****************************************************************************
- * Public Data
- ****************************************************************************/
- #ifdef __cplusplus
- #define EXTERN extern "C"
- extern "C"
- {
- #else
- #define EXTERN extern
- #endif
- /****************************************************************************
- * Public Function Prototypes
- ****************************************************************************/
- /****************************************************************************
- * Name: wm8904_initialize
- *
- * Description:
- * Initialize the WM8904 device.
- *
- * Input Parameters:
- * i2c - An I2C driver instance
- * i2s - An I2S driver instance
- * lower - Persistent board configuration data
- *
- * Returned Value:
- * A new lower half audio interface for the WM8904 device is returned on
- * success; NULL is returned on failure.
- *
- ****************************************************************************/
- struct i2c_master_s; /* Forward reference. Defined in include/nuttx/i2c/i2c_master.h */
- struct i2s_dev_s; /* Forward reference. Defined in include/nuttx/audio/i2s.h */
- struct audio_lowerhalf_s; /* Forward reference. Defined in nuttx/audio/audio.h */
- FAR struct audio_lowerhalf_s *
- wm8904_initialize(FAR struct i2c_master_s *i2c, FAR struct i2s_dev_s *i2s,
- FAR const struct wm8904_lower_s *lower);
- /****************************************************************************
- * Name: wm8904_dump_registers
- *
- * Description:
- * Dump the contents of all WM8904 registers to the syslog device
- *
- * Input Parameters:
- * dev - The device instance returned by wm8904_initialize
- *
- * Returned Value:
- * None.
- *
- ****************************************************************************/
- #ifdef CONFIG_WM8904_REGDUMP
- void wm8904_dump_registers(FAR struct audio_lowerhalf_s *dev,
- FAR const char *msg);
- #else
- /* This eliminates the need for any conditional compilation in the
- * including file.
- */
- # define wm8904_dump_registers(d,m)
- #endif
- /****************************************************************************
- * Name: wm8904_clock_analysis
- *
- * Description:
- * Analyze the settings in the clock chain and dump to syslog.
- *
- * Input Parameters:
- * dev - The device instance returned by wm8904_initialize
- *
- * Returned Value:
- * None.
- *
- ****************************************************************************/
- #ifdef CONFIG_WM8904_CLKDEBUG
- void wm8904_clock_analysis(FAR struct audio_lowerhalf_s *dev,
- FAR const char *msg);
- #else
- /* This eliminates the need for any conditional compilation in the
- * including file.
- */
- # define wm8904_clock_analysis(d,m)
- #endif
- #undef EXTERN
- #ifdef __cplusplus
- }
- #endif
- #endif /* CONFIG_AUDIO_WM8904 */
- #endif /* __INCLUDE_NUTTX_AUDIO_WM8904_H */
|