AudioAMP 12 Click Driver

API for configuring and manipulating AudioAMP 12 Click driver. More...

Topics
	AudioAMP 12 MikroBUS Map
	MikroBUS pin mapping of AudioAMP 12 Click driver.

Functions
void	audioamp12_cfg_setup (audioamp12_cfg_t *cfg)
	AudioAMP 12 configuration object setup function.
err_t	audioamp12_init (audioamp12_t *ctx, audioamp12_cfg_t *cfg)
	AudioAMP 12 initialization function.
void	audioamp12_default_cfg (audioamp12_t *ctx)
	AudioAMP 12 default configuration function.
void	audioamp12_set_mode_standby (audioamp12_t *ctx)
	AudioAMP 12 set standby mode function.
void	audioamp12_set_mode_operation (audioamp12_t *ctx)
	AudioAMP 12 set operation mode function.
void	audioamp12_gain_select (audioamp12_t *ctx, audioamp12_gain_select_t sel_gain)
	AudioAMP 12 select gain level function.
void	audioamp12_change_gain (audioamp12_t *ctx)
	AudioAMP 12 changes the gain function.

Detailed Description

API for configuring and manipulating AudioAMP 12 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

audioamp12_cfg_setup()

void audioamp12_cfg_setup

(

audioamp12_cfg_t *

cfg

)

AudioAMP 12 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See audioamp12_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

audioamp12_change_gain()

void audioamp12_change_gain

(

audioamp12_t *

ctx

)

AudioAMP 12 changes the gain function.

This function switch between two gain settings, 6 dB or 12 dB, of the TS2007EIJT, 3 W, filter-free, class-D audio power amplifier with 6 or 12 dB fixed gain select on the AudioAMP 12 click board™.

Parameters

[in]

ctx

: Click context object. See audioamp12_t object definition for detailed explanation.

Returns

Nothing.

Note

None.

audioamp12_default_cfg()

void audioamp12_default_cfg

(

audioamp12_t *

ctx

)

AudioAMP 12 default configuration function.

This function executes a default configuration of AudioAMP 12 click board.

Parameters

[in]

ctx

: Click context object. See audioamp12_t object definition for detailed explanation.

Returns

Nothing.

Note

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

audioamp12_gain_select()

void audioamp12_gain_select	(	audioamp12_t *	ctx,
		audioamp12_gain_select_t	sel_gain )

AudioAMP 12 select gain level function.

This function selects the gain level of the TS2007EIJT, 3 W, filter-free, class-D audio power amplifier with 6 or 12 dB fixed gain select on the AudioAMP 12 click board™.

Parameters

[in]	ctx	: Click context object. See audioamp12_t object definition for detailed explanation.
[in]	sel_gain	: Gain selection value. See audioamp12_gain_select_t definition for detailed explanation.

Returns

Nothing.

Note

None.

audioamp12_init()

err_t audioamp12_init	(	audioamp12_t *	ctx,
		audioamp12_cfg_t *	cfg )

AudioAMP 12 initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

audioamp12_set_mode_operation()

void audioamp12_set_mode_operation

(

audioamp12_t *

ctx

)

AudioAMP 12 set operation mode function.

This function sets the device operation mode of the TS2007EIJT, 3 W, filter-free, class-D audio power amplifier with 6 or 12 dB fixed gain select on the AudioAMP 12 click board™.

Parameters

[in]

ctx

: Click context object. See audioamp12_t object definition for detailed explanation.

Returns

Nothing.

Note

None.

audioamp12_set_mode_standby()

void audioamp12_set_mode_standby

(

audioamp12_t *

ctx

)

AudioAMP 12 set standby mode function.

This function sets the standby mode of the TS2007EIJT, 3 W, filter-free, class-D audio power amplifier with 6 or 12 dB fixed gain select on the AudioAMP 12 click board™.

Parameters

[in]

ctx

: Click context object. See audioamp12_t object definition for detailed explanation.

Returns

Nothing.

Note

None.