DriverCommon.h

Go to the documentation of this file.

#pragma once
 
// ============================================================================
// Standard Includes
// ============================================================================
 
#include <stdint.h>
 
#include "ConfigAudioDriver.h"
#include "Platforms/AudioDriverLogger.h"
#include "Platforms/Logger.h"
 
// ============================================================================
// Platform Abstractions
// ============================================================================
 
#if defined(ARDUINO)
#include "Arduino.h"
#include "SPI.h"
#include "Wire.h"
#define DEFAULT_WIRE &Wire
#else
#define DEFAULT_WIRE nullptr
#undef delay
#ifndef HIGH
#define HIGH 0x1
#endif
#ifndef LOW
#define LOW 0x0
#endif
#ifndef INPUT
#define INPUT 0x0
#endif
#ifndef OUTPUT
#define OUTPUT 0x1
#endif
#ifndef INPUT_PULLUP
#define INPUT_PULLUP 0x2
#endif
#ifndef INPUT_PULLDOWN
#define INPUT_PULLDOWN 0x3
#endif
#endif
 
// ============================================================================
// Tuning Parameters
// ============================================================================
 
#ifndef TOUCH_LIMIT
#define TOUCH_LIMIT 20
#endif
 
#ifndef LYRAT_MINI_RANGE
#define LYRAT_MINI_RANGE 5
#endif
 
#ifndef LYRAT_MINI_DELAY_MS
#define LYRAT_MINI_DELAY_MS 5
#endif
 
// ============================================================================
// Error Codes
// ============================================================================
 
#define RESULT_OK 0         
#define RESULT_FAIL -1      
#define ERROR_INVALID_ARG 1 
// ============================================================================
// Misc Definitions
// ============================================================================
 
#define I2C_END true
 
// ============================================================================
// GPIO & Bus Handle Abstractions
// ============================================================================
 
#ifdef __zephyr__
 
#include <zephyr/device.h>
#include <zephyr/drivers/adc.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/kernel.h>
 
 
#ifndef IS_GPIO
#define IS_GPIO(pin) (pin.port != nullptr)
#endif
 
#ifndef GPIO_TO_INT
#define GPIO_TO_INT(pin) pin.pin
#endif
 
namespace audio_driver {
 
// In Zephyr, GPIO pins are device-tree specifications.
using GpioPin = ::gpio_dt_spec;
using ADCPin  = ::adc_dt_spec;
using i2c_bus_handle_t = ::device*;
using spi_bus_handle_t = ::device*;
static GpioPin GPIO_UNDEFINED{nullptr, 0, 0};
 
static inline bool operator==(audio_driver::GpioPin& a, audio_driver::GpioPin& b) {
  return (a.port == b.port) && (a.pin == b.pin);
}
 
 
static inline bool operator!=(audio_driver::GpioPin& a, audio_driver::GpioPin& b) {
  return !(a == b);
}
 
}  // namespace audio_driver
 
 
#else  // Non-Zephyr platforms
 
// Non-Zephyr platforms use simple integer pin numbers.
#ifndef GPIO_UNDEFINED
#define GPIO_UNDEFINED -1
#endif
 
#ifndef IS_GPIO
#define IS_GPIO(pin) ((pin) != GPIO_UNDEFINED)
#endif
 
#ifndef GPIO_TO_INT
#define GPIO_TO_INT(pin) (pin)
#endif
 
#endif  // __zephyr__
 
// ============================================================================
// Common Data in Namespace
// ============================================================================
 
namespace audio_driver {
 
using error_t = int;
 
#ifndef __zephyr__
using GpioPin = int16_t;
using ADCPin  = int16_t;
using i2c_bus_handle_t = void*;
using spi_bus_handle_t = void*;
#endif
 
// ----------------------------------------------------------------------------
// ADC / DAC Selection
// ----------------------------------------------------------------------------
 
enum input_device_t {
  ADC_INPUT_NONE = 0x00, 
  ADC_INPUT_LINE1,       
  ADC_INPUT_LINE2,       
  ADC_INPUT_LINE3,       
  ADC_INPUT_ALL,         
  ADC_INPUT_DIFFERENCE,  
};
 
enum output_device_t {
  DAC_OUTPUT_NONE = 0x00, 
  DAC_OUTPUT_LINE1,       
  DAC_OUTPUT_LINE2,       
  DAC_OUTPUT_ALL,         
};
 
// ----------------------------------------------------------------------------
// I2S Interface Configuration
// ----------------------------------------------------------------------------
 
enum i2s_master_slave_t {
  MODE_SLAVE = 0x00,  
  MODE_MASTER = 0x01, 
};
 
enum samplerate_t {
  RATE_8K = 0, 
  RATE_11K,    
  RATE_16K,    
  RATE_22K,    
  RATE_24K,    
  RATE_32K,    
  RATE_44K,    
  RATE_48K,    
  RATE_64K,    
  RATE_88K,    
  RATE_96K,    
  RATE_128K,   
  RATE_176K,   
  RATE_192K,   
};
 
enum sample_bits_t {
  BIT_LENGTH_MIN = -1,
  BIT_LENGTH_16BITS = 0x03,
  BIT_LENGTH_18BITS = 0x02,
  BIT_LENGTH_20BITS = 0x01,
  BIT_LENGTH_24BITS = 0x00,
  BIT_LENGTH_32BITS = 0x04,
  BIT_LENGTH_MAX,
};
 
enum i2s_format_t {
  I2S_NORMAL = 0, 
  I2S_LEFT = 1,   
  I2S_RIGHT = 2,  
  I2S_DSP = 3,    
};
 
enum signal_t {
  SIGNAL_DIGITAL, 
  SIGNAL_AMALOG,  
  SIGNAL_PDM,     
  SIGNAL_TDM,     
};
 
enum channels_t {
  CHANNELS2 = 2,
  CHANNELS4 = 4,
  CHANNELS8 = 8,
  CHANNELS16 = 16,
};
 
// ----------------------------------------------------------------------------
// Codec Operating Mode & Gain
// ----------------------------------------------------------------------------
 
enum codec_mode_t {
  CODEC_MODE_MIN = -1,
  CODEC_MODE_NONE = 0x00,
  CODEC_MODE_ENCODE = 0x01,  
  CODEC_MODE_DECODE = 0x02,  
  CODEC_MODE_BOTH = 0x03,    
  CODEC_MODE_LINE_IN = 0x04, 
  CODEC_MODE_MAX,
};
 
enum es_mic_gain_t {
  MIC_GAIN_MIN = -1,
  MIC_GAIN_0DB = 0,
  MIC_GAIN_3DB = 3,
  MIC_GAIN_6DB = 6,
  MIC_GAIN_9DB = 9,
  MIC_GAIN_12DB = 12,
  MIC_GAIN_15DB = 15,
  MIC_GAIN_18DB = 18,
  MIC_GAIN_21DB = 21,
  MIC_GAIN_24DB = 24,
  MIC_GAIN_MAX,
};
 
// ----------------------------------------------------------------------------
// GPIO Pin Abstractions
// ----------------------------------------------------------------------------
 
enum class PinLogic {
  InputActiveHigh,
  InputActiveLow,
  InputActiveTouch,
  Input,
  Output,
  Inactive,
  OutputActiveLow,
};
 
enum class PinFunction {
  UNDEFINED = 0,
  HEADPHONE_DETECT,
  AUXIN_DETECT,
  PA, 
  POWER,
  LED,
  KEY,
  SD,
  CODEC,
  CODEC_ADC,
  LATCH,
  RESET,
  MCLK_SOURCE,
  EXPANDER,
};
 
enum class AudioDriverKey {
  KEY_REC = 0,
  KEY_MODE,
  KEY_PLAY,
  KEY_SET,
  KEY_VOLUME_DOWN,
  KEY_VOLUME_UP,
};
 
// ----------------------------------------------------------------------------
// Configuration Structures
// ----------------------------------------------------------------------------
 
struct I2SDefinition {
  i2s_master_slave_t mode; 
  i2s_format_t fmt;        
  samplerate_t rate;       
  sample_bits_t bits;      
  channels_t channels;     
  signal_t signal_type;    
};
 
struct codec_config_t {
  input_device_t input_device;   
  output_device_t output_device; 
  I2SDefinition i2s;             
};
 
}  // namespace audio_driver
 
// ============================================================================
// Optional Namespace Import
// ============================================================================
 
#if (defined(ARDUINO) && !defined(NO_USING_NAMESPACE_AUDIO_DRIVER)) || \
    defined(USING_NAMESPACE_AUDIO_DRIVER)
using namespace audio_driver;
#endif