Headphone AMP 3 Click Driver

API for configuring and manipulating Headphone AMP 3 Click driver. More...

Topics
	Headphone AMP 3 MikroBUS Map
	MikroBUS pin mapping of Headphone AMP 3 Click driver.
	Headphoneamp3_set

Functions
void	headphoneamp3_cfg_setup (headphoneamp3_cfg_t *cfg)
	Headphone AMP 3 configuration object setup function.
err_t	headphoneamp3_init (headphoneamp3_t *ctx, headphoneamp3_cfg_t *cfg)
	Headphone AMP 3 initialization function.
void	headphoneamp3_default_cfg (headphoneamp3_t *ctx)
	Headphone AMP 3 default configuration function.
void	headphoneamp3_enable_power (headphoneamp3_t *ctx, uint8_t state)
	Headphone AMP 3 power pin setting function.
void	headphoneamp3_enable_amp (headphoneamp3_t *ctx, uint8_t state)
	Headphone AMP 3 amp pin setting function.

Detailed Description

API for configuring and manipulating Headphone AMP 3 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

headphoneamp3_cfg_setup()

void headphoneamp3_cfg_setup

(

headphoneamp3_cfg_t *

cfg

)

Headphone AMP 3 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

headphoneamp3_default_cfg()

void headphoneamp3_default_cfg

(

headphoneamp3_t *

ctx

)

Headphone AMP 3 default configuration function.

This function executes a default configuration of Headphone AMP 3 click board.

Parameters

[in]

ctx

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

Returns

Nothing.

Note

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

headphoneamp3_enable_amp()

void headphoneamp3_enable_amp	(	headphoneamp3_t *	ctx,
		uint8_t	state )

Headphone AMP 3 amp pin setting function.

This function sets the amp pin on the selected level of Headphone AMP 3 click board.

Parameters

[in]	ctx	: Click context object. See headphoneamp3_t object definition for detailed explanation.
[in]	state	: State of the pin.

Returns

Nothing.

Note

None.

headphoneamp3_enable_power()

void headphoneamp3_enable_power	(	headphoneamp3_t *	ctx,
		uint8_t	state )

Headphone AMP 3 power pin setting function.

This function sets the power pin on the selected level of Headphone AMP 3 click board.

Parameters

[in]	ctx	: Click context object. See headphoneamp3_t object definition for detailed explanation.
[in]	state	: State of the pin.

Returns

Nothing.

Note

None.

headphoneamp3_init()

err_t headphoneamp3_init	(	headphoneamp3_t *	ctx,
		headphoneamp3_cfg_t *	cfg )

Headphone AMP 3 initialization function.

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

Parameters

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

Returns

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

Note

None.