audioamp8.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2021 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, 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 AUDIOAMP8_H
#define AUDIOAMP8_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define AUDIOAMP8_REG_PWR_MODE_CTRL              0x00
#define AUDIOAMP8_REG_THSH_PWR_MODE_PM12         0x01
#define AUDIOAMP8_REG_THSH_PWR_MODE_PM21         0x02
#define AUDIOAMP8_REG_THSH_PWR_MODE_PM23         0x03
#define AUDIOAMP8_REG_THSH_PWR_MODE_PM32         0x04
#define AUDIOAMP8_REG_SOFT_CLP_OVC_PROT_LAT      0x0A
#define AUDIOAMP8_REG_SEL_PWR_MODE_PROFILE       0x1D
#define AUDIOAMP8_REG_PWR_MODE_PROFILE_CFG       0x1E
#define AUDIOAMP8_REG_OVC_PROT_LAT_CLR           0x20
#define AUDIOAMP8_REG_AUDIO_IN_MODE              0x25
#define AUDIOAMP8_REG_DC_PROTECTION              0x26
#define AUDIOAMP8_REG_AUDIO_IN_MODE_OVERWRITE    0x27
#define AUDIOAMP8_REG_ERROR_HANDLER_CLEAR        0x2D
 
#define AUDIOAMP8_REG_MON_CH_0_FREQ_PWR_MODE     0x60
#define AUDIOAMP8_REG_MON_CH_0                   0x61
#define AUDIOAMP8_REG_MON_CH_0_MODUL_INDEX       0x62
#define AUDIOAMP8_REG_MON_CH_1_FREQ_PWR_MODE     0x64
#define AUDIOAMP8_REG_MON_CH_1                   0x65
#define AUDIOAMP8_REG_MON_CH_1_MODUL_INDEX       0x66
#define AUDIOAMP8_REG_ERROR_ACCUMULATED          0x6D
#define AUDIOAMP8_REG_MONITOR_MSEL               0x75
#define AUDIOAMP8_REG_ERROR                      0x7C
 
 // audioamp8_reg
 
#define AUDIOAMP8_SET_MON_CH_0                   0x00
#define AUDIOAMP8_SET_MON_CH_1                   0x01
#define AUDIOAMP8_SET_AUTO_PWR_MODE              0x00
#define AUDIOAMP8_SET_MANUAL_PWR_MODE            0x01
#define AUDIOAMP8_SET_MTHR_1TO2_DEFAULT          0x3C
#define AUDIOAMP8_SET_MTHR_2TO1_DEFAULT          0x32
#define AUDIOAMP8_SET_MTHR_2TO3_DEFAULT          0x5A
#define AUDIOAMP8_SET_MTHR_3TO2_DEFAULT          0x50
#define AUDIOAMP8_SET_DISABLE                    0x00
#define AUDIOAMP8_SET_ENABLE                     0x01
 
 
#define AUDIOAMP8_SET_DEV_ADDR_0                 0x20
#define AUDIOAMP8_SET_DEV_ADDR_1                 0x21
#define AUDIOAMP8_SET_DEV_ADDR_2                 0x22
#define AUDIOAMP8_SET_DEV_ADDR_3                 0x23
 
 // audioamp8_set
 
#define AUDIOAMP8_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.mut = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.ms0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.ms1 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // audioamp8_map
 // audioamp8
 
typedef struct
{
    // Output pins
    digital_out_t  en;      
    digital_out_t  mut;     
    digital_out_t  ms0;     
    digital_out_t  ms1;     
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
} audioamp8_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  en;         
    pin_name_t  mut;        
    pin_name_t  ms0;        
    pin_name_t  ms1;        
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} audioamp8_cfg_t;
 
typedef struct
{
    uint8_t   manual_pm;
    uint8_t   pm_man;
    uint8_t   mthr_1to2;
    uint8_t   mthr_2to1;
    uint8_t   mthr_2to3;
    uint8_t   mthr_3to2;
 
} audioamp8_pwr_mon_cfg_t;
 
typedef struct
{
    uint8_t   pm_profile;
    uint8_t   pm3_man_sh;
    uint8_t   pm2_man_sh;
    uint8_t   pm1_man_sh;
 
} audioamp8_pwr_mod_profile_cfg_t;
 
typedef struct
{
    uint8_t   freq_mode;
    uint8_t   pwr_mode;
    uint8_t   mute_mon;
    uint8_t   vdd_mon;
    uint8_t   pvdd_mon;
    uint8_t   cfly2_mon;
    uint8_t   cfly1_mon;
    uint8_t   ovc_prot;
    uint8_t   modul_index_mon;
 
} audioamp8_monitor_channel_t;
 
typedef struct
{
    uint8_t   fly_cap_ov_vtg;
    uint8_t   ov_curr_prot;
    uint8_t   pll_err;
    uint8_t   pvdd_un_vtg_prot;
    uint8_t   ov_temp_wrg;
    uint8_t   ov_temp_err;
    uint8_t   imped_prot;
    uint8_t   dc_prot;
 
} audioamp8_error_status_t;
 
typedef enum
{
   AUDIOAMP8_OK = 0,
   AUDIOAMP8_ERROR = -1
 
} audioamp8_return_value_t;
 
typedef enum
{
   AUDIOAMP8_PM_MAN_1 = 1,
   AUDIOAMP8_PM_MAN_2,
   AUDIOAMP8_PM_MAN_3
 
} audioamp8_manual_pm_value_t;
 
typedef enum
{
   AUDIOAMP8_PM_PROFILE_0 = 0,
   AUDIOAMP8_PM_PROFILE_1,
   AUDIOAMP8_PM_PROFILE_2,
   AUDIOAMP8_PM_PROFILE_3,
   AUDIOAMP8_PM_PROFILE_4
 
} audioamp8_pm_profile_value_t;
 
typedef enum
{
   AUDIOAMP8_SCHEME_A = 0,
   AUDIOAMP8_SCHEME_B,
   AUDIOAMP8_SCHEME_C,
   AUDIOAMP8_SCHEME_D
 
} audioamp8_pm_man_sh_value_t;
 
typedef enum
{
   AUDIOAMP8_AUDIO_IN_MODE_0_20dB = 0,
   AUDIOAMP8_AUDIO_IN_MODE_0_26dB
 
} audioamp8_audio_in_mode_value_t;
 
typedef enum
{
   AUDIOAMP8_AUDIO_IN_MODE_EXT_DISABLE = 0,
   AUDIOAMP8_AUDIO_IN_MODE_EXT_ENABLE
 
} audioamp8_audio_in_mode_ext_value_t;
 
void audioamp8_cfg_setup ( audioamp8_cfg_t *cfg );
 
err_t audioamp8_init ( audioamp8_t *ctx, audioamp8_cfg_t *cfg );
 
err_t audioamp8_default_cfg ( audioamp8_t *ctx );
 
err_t audioamp8_generic_write ( audioamp8_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t audioamp8_generic_read ( audioamp8_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t audioamp8_start_up ( audioamp8_t *ctx );
 
err_t audioamp8_shut_down ( audioamp8_t *ctx );
 
err_t audioamp8_set_mute ( audioamp8_t *ctx, uint8_t en_mute );
 
err_t audioamp8_set_enable ( audioamp8_t *ctx, uint8_t dev_en );
 
err_t audioamp8_btl_cfg ( audioamp8_t *ctx );
 
err_t audioamp8_set_cfg_pmode ( audioamp8_t *ctx, audioamp8_pwr_mon_cfg_t pwr_mode );
 
err_t audioamp8_get_cfg_pmode ( audioamp8_t *ctx, audioamp8_pwr_mon_cfg_t *pwr_mode );
 
err_t audioamp8_set_soft_copl ( audioamp8_t *ctx, uint8_t lf_clamp_en, uint8_t ocp_latch_en );
 
err_t audioamp8_set_cfg_pmode_p ( audioamp8_t *ctx, audioamp8_pwr_mod_profile_cfg_t pm_profile );
 
err_t audioamp8_get_cfg_pmode_p ( audioamp8_t *ctx, audioamp8_pwr_mod_profile_cfg_t *pm_profile );
 
err_t audioamp8_clr_opl ( audioamp8_t *ctx );
 
err_t audioamp8_set_audio_imode ( audioamp8_t *ctx, uint8_t audio_in_mode );
 
err_t audioamp8_set_dc_protection ( audioamp8_t *ctx, uint8_t eh_dcshdn );
 
err_t audioamp8_set_audio_imode_ow ( audioamp8_t *ctx, uint8_t audio_in_mode_ext );
 
err_t audioamp8_clr_err_handler ( audioamp8_t *ctx );
 
err_t audioamp8_channel_monitoring ( audioamp8_t *ctx, uint8_t mon_ch, audioamp8_monitor_channel_t *ch_mon );
 
err_t audioamp8_monitor_msel ( audioamp8_t *ctx, uint8_t *msel );
 
err_t audioamp8_err_status ( audioamp8_t *ctx, audioamp8_error_status_t *error_status );
 
#ifdef __cplusplus
}
#endif
#endif // AUDIOAMP8_H
 
 // audioamp8
 
// ------------------------------------------------------------------------ END