audioamp8.h File Reference

This file contains API for AudioAmp 8 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures
struct	audioamp8_t
	AudioAmp 8 Click context object. More...
struct	audioamp8_cfg_t
	AudioAmp 8 Click configuration object. More...
struct	audioamp8_pwr_mon_cfg_t
	AudioAmp 8 Click power mode configuration object. More...
struct	audioamp8_pwr_mod_profile_cfg_t
	AudioAmp 8 Click power mode profile configuration object. More...
struct	audioamp8_monitor_channel_t
	AudioAmp 8 Click monitor channel object. More...
struct	audioamp8_error_status_t
	AudioAmp 8 Click monitor channel object. More...

Macros
#define	AUDIOAMP8_REG_PWR_MODE_CTRL   0x00
	AudioAmp 8 description register.
#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
#define	AUDIOAMP8_SET_MON_CH_0   0x00
	AudioAmp 8 description setting.
#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
	AudioAmp 8 device address setting.
#define	AUDIOAMP8_SET_DEV_ADDR_1   0x21
#define	AUDIOAMP8_SET_DEV_ADDR_2   0x22
#define	AUDIOAMP8_SET_DEV_ADDR_3   0x23
#define	AUDIOAMP8_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	audioamp8_return_value_t { AUDIOAMP8_OK = 0 , AUDIOAMP8_ERROR = -1 }
	AudioAmp 8 Click return value data. More...
enum	audioamp8_manual_pm_value_t { AUDIOAMP8_PM_MAN_1 = 1 , AUDIOAMP8_PM_MAN_2 , AUDIOAMP8_PM_MAN_3 }
	AudioAmp 8 Click manual selected power mode value data. More...
enum	audioamp8_pm_profile_value_t {   AUDIOAMP8_PM_PROFILE_0 = 0 , AUDIOAMP8_PM_PROFILE_1 , AUDIOAMP8_PM_PROFILE_2 , AUDIOAMP8_PM_PROFILE_3 ,   AUDIOAMP8_PM_PROFILE_4 }
	AudioAmp 8 Click select power mode profile value data. More...
enum	audioamp8_pm_man_sh_value_t { AUDIOAMP8_SCHEME_A = 0 , AUDIOAMP8_SCHEME_B , AUDIOAMP8_SCHEME_C , AUDIOAMP8_SCHEME_D }
	AudioAmp 8 Click profile assign scheme value data. More...
enum	audioamp8_audio_in_mode_value_t { AUDIOAMP8_AUDIO_IN_MODE_0_20dB = 0 , AUDIOAMP8_AUDIO_IN_MODE_0_26dB }
	AudioAmp 8 Click audio input mode value data. More...
enum	audioamp8_audio_in_mode_ext_value_t { AUDIOAMP8_AUDIO_IN_MODE_EXT_DISABLE = 0 , AUDIOAMP8_AUDIO_IN_MODE_EXT_ENABLE }
	AudioAmp 8 Click audio input mode value data. More...

Functions
void	audioamp8_cfg_setup (audioamp8_cfg_t *cfg)
	AudioAmp 8 configuration object setup function.
err_t	audioamp8_init (audioamp8_t *ctx, audioamp8_cfg_t *cfg)
	AudioAmp 8 initialization function.
err_t	audioamp8_default_cfg (audioamp8_t *ctx)
	AudioAmp 8 default configuration function.
err_t	audioamp8_generic_write (audioamp8_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
	AudioAmp 8 I2C writing function.
err_t	audioamp8_generic_read (audioamp8_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
	AudioAmp 8 I2C reading function.
err_t	audioamp8_start_up (audioamp8_t *ctx)
	AudioAmp 8 start-up procedure function.
err_t	audioamp8_shut_down (audioamp8_t *ctx)
	AudioAmp 8 shut-down procedure function.
err_t	audioamp8_set_mute (audioamp8_t *ctx, uint8_t en_mute)
	AudioAmp 8 mute function.
err_t	audioamp8_set_enable (audioamp8_t *ctx, uint8_t dev_en)
	AudioAmp 8 enable function.
err_t	audioamp8_btl_cfg (audioamp8_t *ctx)
	AudioAmp 8 BTL configuration function.
err_t	audioamp8_set_cfg_pmode (audioamp8_t *ctx, audioamp8_pwr_mon_cfg_t pwr_mode)
	AudioAmp 8 set power mode configuration function.
err_t	audioamp8_get_cfg_pmode (audioamp8_t *ctx, audioamp8_pwr_mon_cfg_t *pwr_mode)
	AudioAmp 8 get power mode configuration function.
err_t	audioamp8_set_soft_copl (audioamp8_t *ctx, uint8_t lf_clamp_en, uint8_t ocp_latch_en)
	AudioAmp 8 set soft-clipping and overcurrent protection latching function.
err_t	audioamp8_set_cfg_pmode_p (audioamp8_t *ctx, audioamp8_pwr_mod_profile_cfg_t pm_profile)
	AudioAmp 8 set power mode profile configuration function.
err_t	audioamp8_get_cfg_pmode_p (audioamp8_t *ctx, audioamp8_pwr_mod_profile_cfg_t *pm_profile)
	AudioAmp 8 get power mode configuration function.
err_t	audioamp8_clr_opl (audioamp8_t *ctx)
	AudioAmp 8 over-current protection latch clear function.
err_t	audioamp8_set_audio_imode (audioamp8_t *ctx, uint8_t audio_in_mode)
	AudioAmp 8 set audio IN mode function.
err_t	audioamp8_set_dc_protection (audioamp8_t *ctx, uint8_t eh_dcshdn)
	AudioAmp 8 set DC protection function.
err_t	audioamp8_set_audio_imode_ow (audioamp8_t *ctx, uint8_t audio_in_mode_ext)
	AudioAmp 8 set audio IN mode overwrite function.
err_t	audioamp8_clr_err_handler (audioamp8_t *ctx)
	AudioAmp 8 error handler clear function.
err_t	audioamp8_channel_monitoring (audioamp8_t *ctx, uint8_t mon_ch, audioamp8_monitor_channel_t *ch_mon)
	AudioAmp 8 monitors the status of the channel's function.
err_t	audioamp8_monitor_msel (audioamp8_t *ctx, uint8_t *msel)
	AudioAmp 8 monitor msel function.
err_t	audioamp8_err_status (audioamp8_t *ctx, audioamp8_error_status_t *error_status)
	AudioAmp 8 get error status function.

Detailed Description

This file contains API for AudioAmp 8 Click Driver.

Enumeration Type Documentation

audioamp8_audio_in_mode_ext_value_t

enum audioamp8_audio_in_mode_ext_value_t

AudioAmp 8 Click audio input mode value data.

Audio input mode enum values for driver return values.

Enumerator
AUDIOAMP8_AUDIO_IN_MODE_EXT_DISABLE
AUDIOAMP8_AUDIO_IN_MODE_EXT_ENABLE

audioamp8_audio_in_mode_value_t

enum audioamp8_audio_in_mode_value_t

AudioAmp 8 Click audio input mode value data.

Audio input mode enum values for driver return values.

Enumerator
AUDIOAMP8_AUDIO_IN_MODE_0_20dB
AUDIOAMP8_AUDIO_IN_MODE_0_26dB

audioamp8_manual_pm_value_t

enum audioamp8_manual_pm_value_t

AudioAmp 8 Click manual selected power mode value data.

Manual selected power mode enum values for driver return values.

Enumerator
AUDIOAMP8_PM_MAN_1
AUDIOAMP8_PM_MAN_2
AUDIOAMP8_PM_MAN_3

audioamp8_pm_man_sh_value_t

enum audioamp8_pm_man_sh_value_t

AudioAmp 8 Click profile assign scheme value data.

Profile assign scheme enum values for driver return values.

Enumerator
AUDIOAMP8_SCHEME_A
AUDIOAMP8_SCHEME_B
AUDIOAMP8_SCHEME_C
AUDIOAMP8_SCHEME_D

audioamp8_pm_profile_value_t

enum audioamp8_pm_profile_value_t

AudioAmp 8 Click select power mode profile value data.

Select power mode profile enum values for driver return values.

Enumerator
AUDIOAMP8_PM_PROFILE_0
AUDIOAMP8_PM_PROFILE_1
AUDIOAMP8_PM_PROFILE_2
AUDIOAMP8_PM_PROFILE_3
AUDIOAMP8_PM_PROFILE_4

audioamp8_return_value_t

enum audioamp8_return_value_t

AudioAmp 8 Click return value data.

Predefined enum values for driver return values.

Enumerator
AUDIOAMP8_OK
AUDIOAMP8_ERROR