pcm3168A.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 2019 Texas Instruments Incorporated - http://www.ti.com
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    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.
 *
 *    Neither the name of Texas Instruments Incorporated 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 _PCM3168A_H_
#define _PCM3168A_H_

#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <stdbool.h>
#include <ti/drv/uart/UART_stdio.h>
#include <ti/drv/i2c/I2C.h>
#include <ti/drv/i2c/soc/I2C_soc.h>
#include <ti/board/board.h>
#include <ti/board/src/devices/common/common.h>
#ifdef __cplusplus
extern "C" {
#endif

#define BOARD_PCM3168_MODECTRL_REG_ADDR             (0x40U)

#define BOARD_PCM3168_DAC_PWR_MST_FMT_REG_ADDR      (0x41U)

#define BOARD_PCM3168_DAC_OP_FLT_REG_ADDR           (0x42U)

#define BOARD_PCM3168_DAC_INV_REG_ADDR              (0x43U)

#define BOARD_PCM3168_DAC_MUTE_REG_ADDR             (0x44U)

#define BOARD_PCM3168_DAC_ZERO_REG_ADDR             (0x45U)

#define BOARD_PCM3168_DAC_ATT_DEMP_ZF_REG_ADDR      (0x46U)

#define BOARD_PCM3168_DAC_VOL_MASTER_REG_ADDR       (0x47U)

#define BOARD_PCM3168_DAC_VOL_CHAN_START_REG_ADDR   (0x48U)

#define BOARD_PCM3168_ADC_SMODE_REG_ADDR            (0x50U)

#define BOARD_PCM3168_ADC_MST_FMT_REG_ADDR          (0x51U)

#define BOARD_PCM3168_ADC_PWR_HPFB_REG_ADDR         (0x52U)

#define BOARD_PCM3168_ADC_SEAD_REG_ADDR             (0x53U)

#define BOARD_PCM3168_ADC_INV_REG_ADDR              (0x54U)

#define BOARD_PCM3168_ADC_MUTE_REG_ADDR             (0x55U)

#define BOARD_PCM3168_ADC_OV_REG_ADDR               (0x56U)

#define BOARD_PCM3168_ADC_ATT_OVF_REG_ADDR          (0x57U)

#define BOARD_PCM3168_ADC_VOL_MASTER_REG_ADDR       (0x58U)

#define BOARD_PCM3168_ADC_VOL_CHAN_START_REG_ADDR   (0x59U)

#define BOARD_I2C_NUM_OF_BYTES_1                    (0x1U)

#define BOARD_PCM3168_MRST_SHIFT_CNT    (0x07U)
#define BOARD_PCM3168_SRST_SHIFT_CNT    (0x06U)
#define BOARD_PCM3168_SRDA_SHIFT_CNT    (0x0U)

#define BOARD_PCM3168_MRST_BIT_MASK    (0x01 << BOARD_PCM3168_MRST_SHIFT_CNT)
#define BOARD_PCM3168_SRST_BIT_MASK    (0x01 << BOARD_PCM3168_SRST_SHIFT_CNT)
#define BOARD_PCM3168_SRDA_BIT_MASK    (0x03 << BOARD_PCM3168_SRDA_SHIFT_CNT)

#define BOARD_PCM3168_PSMDA_SHIFT_CNT    (0x07U)
#define BOARD_PCM3168_MSDA_SHIFT_CNT     (0x04U)
#define BOARD_PCM3168_FMTDA_SHIFT_CNT    (0x0U)

#define BOARD_PCM3168_PSMDA_BIT_MASK    (0x01 << BOARD_PCM3168_PSMDA_SHIFT_CNT)
#define BOARD_PCM3168_MSDA_BIT_MASK     (0x07 << BOARD_PCM3168_MSDA_SHIFT_CNT)
#define BOARD_PCM3168_FMTDA_BIT_MASK    (0x0F << BOARD_PCM3168_FMTDA_SHIFT_CNT)

#define BOARD_PCM3168_OPED_SHIFT_CNT     (0x04U)
#define BOARD_PCM3168_OPED_BIT_MASK      (0x0F << BOARD_PCM3168_PSMDA_SHIFT_CNT)

#define BOARD_PCM3168_SRAD_SHIFT_CNT    (0x0U)

#define BOARD_PCM3168_SRAD_BIT_MASK     (0x03 << BOARD_PCM3168_SRAD_SHIFT_CNT)

#define BOARD_PCM3168_MSAD_SHIFT_CNT     (0x04U)
#define BOARD_PCM3168_FMTAD_SHIFT_CNT    (0x0U)

#define BOARD_PCM3168_MSAD_BIT_MASK     (0x07 << BOARD_PCM3168_MSAD_SHIFT_CNT)
#define BOARD_PCM3168_FMTAD_BIT_MASK    (0x07 << BOARD_PCM3168_FMTAD_SHIFT_CNT)

#define BOARD_PCM3168_PSVAD_SHIFT_CNT     (0x04U)

#define BOARD_PCM3168_PSVAD_BIT_MASK      (0x07 << BOARD_PCM3168_PSVAD_SHIFT_CNT)

#define BOARD_PCM3168_CHANNEL_0           (0x0U)

#define BOARD_PCM3168_CHANNEL_1           (0x1U)

#define BOARD_PCM3168_CHANNEL_2           (0x2U)

#define BOARD_PCM3168_CHANNEL_3           (0x3U)

#define BOARD_PCM3168_CHANNEL_4           (0x4U)

#define BOARD_PCM3168_CHANNEL_5           (0x5U)

#define BOARD_PCM3168_CHANNEL_6           (0x6U)

#define BOARD_PCM3168_CHANNEL_7           (0x7U)

#define BOARD_PCM3168_CHANNEL_8           (0x8U)

#define BOARD_PCM3168_CFG_DAC    (0U)

#define BOARD_PCM3168_CFG_ADC    (1U)

#define BOARD_PCM3168_CFG_ALL    (2U)

#define BOARD_PCM3168_MODE_PWROFF    (0)

#define BOARD_PCM3168_MODE_NORMAL    (1U)

#define BOARD_PCM3168_SAMPLE_AUTO    (0)

#define BOARD_PCM3168_SINGLE_RATE    (1U)

#define BOARD_PCM3168_DUAL_RATE      (2U)

#define BOARD_PCM3168_QUAD_RATE      (3U)

#define BOARD_PCM3168_POWERSAVE_ENABLE     (0) 

#define BOARD_PCM3168_POWERSAVE_DISABLE    (1U)

#define BOARD_PCM3168_NORMAL_MODE        (0U)

#define BOARD_PCM3168_POWERSAVE_MODE     (1U) 

#define BOARD_PCM3168_SLAVE_MODE            (0)

#define BOARD_PCM3168_MASTER_MODE_768FS     (1U)

#define BOARD_PCM3168_MASTER_MODE_512FS     (2U)

#define BOARD_PCM3168_MASTER MODE_384FS     (3U)

#define BOARD_PCM3168_MASTER_MODE_256FS     (4U)

#define BOARD_PCM3168_MASTER_MODE_192FS     (5U)

#define BOARD_PCM3168_MASTER_MODE_128FS     (6U)

#define BOARD_PCM3168_24B_I2S_FMT           (0)

#define BOARD_PCM3168_24B_LJ_FMT            (1U)

#define BOARD_PCM3168_24B_RJ_FMT            (2U)

#define BOARD_PCM3168_16B_RJ_FMT            (3U)

#define BOARD_PCM3168_24B_I2S_DSP_FMT       (4U)

#define BOARD_PCM3168_24B_LJ_DSP_FMT        (5U)

#define BOARD_PCM3168_24B_I2S_TDM_FMT       (6U)

#define BOARD_PCM3168_24B_LJ_TDM_FMT        (7U)

#define BOARD_PCM3168_24B_HS_I2S_TDM_FMT    (8U)

#define BOARD_PCM3168_24B_HS_LJ_TDM_FMT     (9U)

#define BOARD_PCM3168_DAC_NORMAL_OPERATION    (0)

#define BOARD_PCM3168_DAC_OPERATION_DISABLE   (1U)

#define BOARD_PCM3168_MUTE_DISABLE    (0)

#define BOARD_PCM3168_MUTE_ENABLE     (1U)

/* @} */

Board_STATUS Board_pcm3168Config(void *handle, uint8_t slaveAddr);

Board_STATUS Board_pcm3168RegRead(void *handle,
                                  uint8_t slaveAddr,
                                  uint8_t regAddr,
                                  uint8_t *regData);

Board_STATUS Board_pcm3168RegWrite(void *handle,
                                   uint8_t slaveAddr,
                                   uint8_t regAddr,
                                   uint8_t *regData);

Board_STATUS Board_pcm3168ModeCtrl(void   *handle,
                                   uint8_t slaveAddr,
                                   uint8_t modeCtrl);

Board_STATUS Board_pcm3168Reset(void    *handle,
                                uint8_t slaveAddr,
                                uint8_t modeCtrl);

Board_STATUS Board_pcm3168SamplingModeSel(void    *handle,
                                          uint8_t slaveAddr,
                                          uint8_t samplingMode,
                                          uint8_t cfgMode);

Board_STATUS Board_pcm3168DACPwrSaveModeSel(void    *handle,
                                         uint8_t slaveAddr,
                                         uint8_t pwrSaveMode);
                                         
Board_STATUS Board_pcm3168ADCPwrSaveModeSel(void    *handle,
                                            uint8_t slaveAddr,
                                            uint8_t pwrSaveMode);                                        

Board_STATUS Board_pcm3168MasterSlaveModeSel(void    *handle,
                                             uint8_t slaveAddr,
                                             uint8_t mscfgMode,
                                             uint8_t cfgMode);

Board_STATUS Board_pcm3168AudioFmtSel(void    *handle,
                                      uint8_t slaveAddr,
                                      uint8_t fmt,
                                      uint8_t cfgMode);
                                         
Board_STATUS Board_pcm3168DACOperationalCtrl(void    *handle,
                                             uint8_t slaveAddr,
                                             uint8_t opMode);

Board_STATUS Board_pcm3168SoftMuteCtrl(void    *handle,
                                       uint8_t slaveAddr,
                                       uint8_t chanNum,
                                       uint8_t muteCtrl,
                                       uint8_t cfgMode);

Board_STATUS Board_pcm3168AttnLevelSet(void    *handle,
                                       uint8_t slaveAddr,
                                       uint8_t chanNum,
                                       uint8_t attLevel,
                                       uint8_t cfgMode);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _PCM3168_H_ */

/* @} */