headphoneamp.h File Reference

This file contains API for Headphone AMP Click Driver. More...

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

Go to the source code of this file.

Data Structures
struct	headphoneamp_t
	Headphone AMP Click context object. More...
struct	headphoneamp_cfg_t
	Headphone AMP Click configuration object. More...

Macros
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_33_dB   0
	Headphone AMP description volume setting.
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_30_dB   1
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_27_dB   2
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_24_dB   3
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_21_dB   4
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_18_dB   5
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_15_dB   6
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_12_dB   7
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_9_dB   8
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_6_dB   9
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_3_dB   10
#define	HEADPHONEAMP_SOUND_VOLUME_NEG_0_dB   11
#define	HEADPHONEAMP_SOUND_VOLUME_POS_3_dB   12
#define	HEADPHONEAMP_SOUND_VOLUME_POS_6_dB   13
#define	HEADPHONEAMP_SOUND_VOLUME_POS_9_dB   14
#define	HEADPHONEAMP_SOUND_VOLUME_POS_12_dB   15
#define	HEADPHONEAMP_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	headphoneamp_return_value_t { HEADPHONEAMP_OK = 0 , HEADPHONEAMP_ERROR = -1 }
	Headphone AMP Click return value data. More...

Functions
void	headphoneamp_cfg_setup (headphoneamp_cfg_t *cfg)
	Headphone AMP configuration object setup function.
err_t	headphoneamp_init (headphoneamp_t *ctx, headphoneamp_cfg_t *cfg)
	Headphone AMP initialization function.
err_t	headphoneamp_default_cfg (headphoneamp_t *ctx)
	Headphone AMP default configuration function.
err_t	headphoneamp_shutdown (headphoneamp_t *ctx)
	Headphone AMP shutdown function.
err_t	headphoneamp_power_up (headphoneamp_t *ctx)
	Headphone AMP power up function.
err_t	headphoneamp_volume_down (headphoneamp_t *ctx)
	Headphone AMP set sound volume down function.
err_t	headphoneamp_volume_up (headphoneamp_t *ctx)
	Headphone AMP set sound volume up function.
err_t	headphoneamp_set_sound_volume (headphoneamp_t *ctx, uint8_t sound_volume)
	Headphone AMP set sound volume function.

Detailed Description

This file contains API for Headphone AMP Click Driver.

Enumeration Type Documentation

headphoneamp_return_value_t

enum headphoneamp_return_value_t

Headphone AMP Click return value data.

Predefined enum values for driver return values.

Enumerator
HEADPHONEAMP_OK
HEADPHONEAMP_ERROR