/*
 * ESPRESSIF MIT License
 *
 * Copyright (c) 2020 <ESPRESSIF SYSTEMS (SHANGHAI) CO., LTD>
 *
 * Permission is hereby granted for use on all ESPRESSIF SYSTEMS products, in
 * which case, it is free of charge, to any person obtaining a copy of this
 * software and associated documentation files (the "Software"), to deal in the
 * Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 */

#ifndef _AUDIO_BOARD_H_
#define _AUDIO_BOARD_H_

#include "audio_hal.h"
#include "board_def.h"
#include "board_pins_config.h"
//#include "esp_peripherals.h"
//#include "periph_sdcard.h"

#ifdef __cplusplus
extern "C"
{
#endif

  /**
   * @brief Audio board handle
   */
  struct audio_board_handle
  {
    audio_hal_handle_t audio_hal; /*!< pa hardware abstract layer handle */
    audio_hal_handle_t adc_hal;   /*!< adc hardware abstract layer handle */
  };

  typedef struct audio_board_handle *audio_board_handle_t;

  /**
   * @brief Initialize audio board
   *
   * @return The audio board handle
   */
  audio_board_handle_t audio_board_init (void);

  /**
   * @brief Initialize codec
   *
   * @return The audio hal handle
   */
  audio_hal_handle_t audio_board_codec_init (void);

  /**
   * @brief Initialize adc
   *
   * @return The adc hal handle
   */
  audio_hal_handle_t audio_board_adc_init (void);

  ///**
  // * @brief Initialize key peripheral
  // *
  // * @param set The handle of esp_periph_set_handle_t
  // *
  // * @return
  // *     - ESP_OK, success
  // *     - Others, fail
  // */
  // esp_err_t audio_board_key_init(esp_periph_set_handle_t set);
  //
  ///**
  // * @brief Initialize sdcard peripheral
  // *
  // * @param set The handle of esp_periph_set_handle_t
  // *
  // * @return
  // *     - ESP_OK, success
  // *     - Others, fail
  // */
  // esp_err_t audio_board_sdcard_init(esp_periph_set_handle_t set,
  //                                  periph_sdcard_mode_t mode);

  /**
   * @brief Query audio_board_handle
   *
   * @return The audio board handle
   */
  audio_board_handle_t audio_board_get_handle (void);

  /**
   * @brief Uninitialize the audio board
   *
   * @param audio_board The handle of audio board
   *
   * @return  0       success,
   *          others  fail
   */
  esp_err_t audio_board_deinit (audio_board_handle_t audio_board);

#ifdef __cplusplus
}
#endif

#endif