API for configuring and manipulating AudioAmp 8 Click driver. More...

Topics
	AudioAmp 8 Registers List
	List of registers of AudioAmp 8 Click driver.

	AudioAmp 8 Registers Settings
	Settings for registers of AudioAmp 8 Click driver.

	AudioAmp 8 MikroBUS Map
	MikroBUS pin mapping of AudioAmp 8 Click driver.

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

API for configuring and manipulating AudioAmp 8 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ audioamp8_btl_cfg()

err_t audioamp8_btl_cfg ( audioamp8_t * ctx )

AudioAmp 8 BTL configuration function.

This function performs a BTL signal configuration, two input- and output terminals are used per channel of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in] ctx : Click context object. See audioamp8_t object definition for detailed explanation.

Returns

0 - Success.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_cfg_setup()

void audioamp8_cfg_setup ( audioamp8_cfg_t * cfg )

AudioAmp 8 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See audioamp8_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ audioamp8_channel_monitoring()

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.

This function performs monitoring of the channel 0 or channel 1 of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[in]	mon_ch	: Select monitor channel: `0` - Channel 0, `1` - Channel 1.
[out]	ch_mon	: Monitor Channel object object.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_clr_err_handler()

err_t audioamp8_clr_err_handler ( audioamp8_t * ctx )

AudioAmp 8 error handler clear function.

This function clears error handler of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in] ctx : Click context object. See audioamp8_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_clr_opl()

err_t audioamp8_clr_opl ( audioamp8_t * ctx )

AudioAmp 8 over-current protection latch clear function.

This function clears over current protection latch of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in] ctx : Click context object. See audioamp8_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_default_cfg()

err_t audioamp8_default_cfg ( audioamp8_t * ctx )

AudioAmp 8 default configuration function.

This function executes a default configuration of AudioAmp 8 click board.

Parameters

[in] ctx : Click context object. See audioamp8_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ audioamp8_err_status()

err_t audioamp8_err_status	(	audioamp8_t *	ctx,
		audioamp8_error_status_t *	error_status )

AudioAmp 8 get error status function.

This function read error status of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[out]	error_status	: Gives the live status of every potential error source.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_generic_read()

err_t audioamp8_generic_read	(	audioamp8_t *	ctx,
		uint8_t	reg,
		uint8_t *	rx_buf,
		uint8_t	rx_len )

AudioAmp 8 I2C reading function.

This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[in]	reg	: Start register address.
[out]	rx_buf	: Output read data.
[in]	rx_len	: Number of bytes to be read.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_generic_write()

err_t audioamp8_generic_write	(	audioamp8_t *	ctx,
		uint8_t	reg,
		uint8_t *	tx_buf,
		uint8_t	tx_len )

AudioAmp 8 I2C writing function.

This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[in]	reg	: Start register address.
[in]	tx_buf	: Data to be written.
[in]	tx_len	: Number of bytes to be written.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_get_cfg_pmode()

err_t audioamp8_get_cfg_pmode	(	audioamp8_t *	ctx,
		audioamp8_pwr_mon_cfg_t *	pwr_mode )

AudioAmp 8 get power mode configuration function.

This function get power mode configuration of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[out]	pwr_mode	: Power mode configuration object object.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_get_cfg_pmode_p()

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.

This function get power mode profile configuration of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[out]	pm_profile	: Power mode profile configuration object object.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_init()

err_t audioamp8_init	(	audioamp8_t *	ctx,
		audioamp8_cfg_t *	cfg )

AudioAmp 8 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters

[out]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See audioamp8_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_monitor_msel()

err_t audioamp8_monitor_msel	(	audioamp8_t *	ctx,
		uint8_t *	msel )

AudioAmp 8 monitor msel function.

This function performs monitoring of the signal configuration PBTL, SE/BTL, BTL, SE of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[out]	msel	: signal configuration: `0` - PBTL, `1` - SE/BTL, `2` - BTL, `3` - SE.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_set_audio_imode()

err_t audioamp8_set_audio_imode	(	audioamp8_t *	ctx,
		uint8_t	audio_in_mode )

AudioAmp 8 set audio IN mode function.

This function set audio IN mode of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[in]	audio_in_mode	: Audio IN: `0` - Mode 0: 20dB gain, `1` - Mode 1: 26dB gain.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_set_audio_imode_ow()

err_t audioamp8_set_audio_imode_ow	(	audioamp8_t *	ctx,
		uint8_t	audio_in_mode_ext )

AudioAmp 8 set audio IN mode overwrite function.

This function set audio IN mode overwrite of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[in]	audio_in_mode_ext	: Audio IN mode overwrite: `0` - Disable, `1` - Enable.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: . Should enabled audio IN mode function.

◆ audioamp8_set_cfg_pmode()

err_t audioamp8_set_cfg_pmode	(	audioamp8_t *	ctx,
		audioamp8_pwr_mon_cfg_t	pwr_mode )

AudioAmp 8 set power mode configuration function.

This function configure power mode of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[in]	pwr_mode	: Power mode configuration object object.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_set_cfg_pmode_p()

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.

This function configure power mode profile of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[in]	pm_profile	: Power mode profile configuration object object.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_set_dc_protection()

err_t audioamp8_set_dc_protection	(	audioamp8_t *	ctx,
		uint8_t	eh_dcshdn )

AudioAmp 8 set DC protection function.

This function set DC protection of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[in]	eh_dcshdn	: DC protection: `0` - Disable, `1` - Enable.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_set_enable()

err_t audioamp8_set_enable	(	audioamp8_t *	ctx,
		uint8_t	dev_en )

AudioAmp 8 enable function.

This function performs a enable of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in] ctx : Click context object. See audioamp8_t object definition for detailed explanation.

Returns

0 - Success.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_set_mute()

err_t audioamp8_set_mute	(	audioamp8_t *	ctx,
		uint8_t	en_mute )

AudioAmp 8 mute function.

This function performs a mute of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in] ctx : Click context object. See audioamp8_t object definition for detailed explanation.

Returns

0 - Success.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_set_soft_copl()

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.

This function configure oft-clipping and overcurrent protection latching of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp8_t object definition for detailed explanation.
[in]	lf_clamp_en	: Enables soft-clipping: `0` - Disable, `1` - Enable.
[in]	ocp_latch_en	: Enables soft-clipping: `0` - Disable, `1` - Use permanently latching OCP.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_shut_down()

err_t audioamp8_shut_down ( audioamp8_t * ctx )

AudioAmp 8 shut-down procedure function.

This function performs a power-down procedure of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in] ctx : Click context object. See audioamp8_t object definition for detailed explanation.

Returns

0 - Success.

See #err_t definition for detailed explanation.

Note: None.

◆ audioamp8_start_up()

err_t audioamp8_start_up ( audioamp8_t * ctx )

AudioAmp 8 start-up procedure function.

This function performs a start-up procedure of the MA12070 Filterless and High-Efficiency +4V to +26V Audio Amplifier with Analog Input on the AudioAmp 8 click board™.

Parameters

[in] ctx : Click context object. See audioamp8_t object definition for detailed explanation.

Returns

0 - Success.

See #err_t definition for detailed explanation.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ audioamp8_btl_cfg()

◆ audioamp8_cfg_setup()

◆ audioamp8_channel_monitoring()

◆ audioamp8_clr_err_handler()

◆ audioamp8_clr_opl()

◆ audioamp8_default_cfg()

◆ audioamp8_err_status()

◆ audioamp8_generic_read()

◆ audioamp8_generic_write()

◆ audioamp8_get_cfg_pmode()

◆ audioamp8_get_cfg_pmode_p()

◆ audioamp8_init()

◆ audioamp8_monitor_msel()

◆ audioamp8_set_audio_imode()

◆ audioamp8_set_audio_imode_ow()

◆ audioamp8_set_cfg_pmode()

◆ audioamp8_set_cfg_pmode_p()

◆ audioamp8_set_dc_protection()

◆ audioamp8_set_enable()

◆ audioamp8_set_mute()

◆ audioamp8_set_soft_copl()

◆ audioamp8_shut_down()

◆ audioamp8_start_up()