volume.h File Reference

This file contains API for Volume Click Driver. More...

#include "drv_digital_out.h"
#include "drv_spi_master.h"

Go to the source code of this file.

Data Structures
struct	volume_t
	Volume Click context object. More...
struct	volume_cfg_t
	Volume Click configuration object. More...

Macros
#define	VOLUME_ZCE_DISABLE   0x00
	Zero Crossing definitions.
#define	VOLUME_ZCE_ENABLE   0x01
#define	VOLUME_MUTE_ENABLE   0x00
	Hardware mute definitions.
#define	VOLUME_MUTE_DISABLE   0x01
#define	VOLUME_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Functions
void	volume_cfg_setup (volume_cfg_t *cfg)
	Volume configuration object setup function.
err_t	volume_init (volume_t *ctx, volume_cfg_t *cfg)
	Volume initialization function.
void	volume_default_cfg (volume_t *ctx)
	Volume default configuration function.
void	volume_power_up (volume_t *ctx)
	Power Up function.
void	volume_hw_mute (volume_t *ctx, uint8_t mute_state)
	Hardware MUTE function.
void	volume_zero_crossing (volume_t *ctx, uint8_t zce_state)
	Zero Crossing option function.
err_t	volume_set_vol_gain (volume_t *ctx, float volume_left_dB, float volume_right_dB)
	Set volume gain function.

Detailed Description

This file contains API for Volume Click Driver.