volume2 2.0.0.0
volume2.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  volume2_t
 Volume 2 Click context object. More...
 
struct  volume2_cfg_t
 Volume 2 Click configuration object. More...
 
struct  volume2_vol_data_t
 Volume 2 Vol data structure. More...
 

Macros

#define VOLUME2_REG_VOLUME_1A_2A   0x00
 Volume 2 gain register.
 
#define VOLUME2_REG_VOLUME_1B_ZERO1   0x01
 Volume 2 zero and atten Ch1 register.
 
#define VOLUME2_REG_VOLUME_2B_ZERO2   0x02
 Volume 2 zero and atten Ch2 register.
 
#define VOLUME2_GAIN_OPT_0_DB   0x00
 Volume 2 gain 0dB option setting.
 
#define VOLUME2_GAIN_OPT_3_DB   0x01
 Volume 2 gain 3dB option setting.
 
#define VOLUME2_GAIN_OPT_6_DB   0x02
 Volume 2 gain 6dB option setting.
 
#define VOLUME2_GAIN_OPT_9_DB   0x03
 Volume 2 gain 9dB option setting.
 
#define VOLUME2_ZERO_CROSS_DET_OPT_OFF   0x00
 Volume 2 zero cross detection disable setting.
 
#define VOLUME2_ZERO_CROSS_DET_OPT_ON   0x01
 Volume 2 zero cross detection enable setting.
 
#define VOLUME2_SET_DEV_ADDR   0x44
 Volume 2 device address setting.
 
#define VOLUME2_DEVICE_MUTE_ON   0x00
 Volume 2 mute option on.
 
#define VOLUME2_DEVICE_MUTE_OFF   0x01
 Volume 2 mute option off.
 
#define VOLUME2_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  volume2_return_value_t { VOLUME2_OK = 0 , VOLUME2_ERROR = -1 }
 Volume 2 Click return value data. More...
 

Functions

void volume2_cfg_setup (volume2_cfg_t *cfg)
 Volume 2 configuration object setup function.
 
err_t volume2_init (volume2_t *ctx, volume2_cfg_t *cfg)
 Volume 2 initialization function.
 
err_t volume2_default_cfg (volume2_t *ctx)
 Volume 2 default configuration function.
 
err_t volume2_generic_write (volume2_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
 Volume 2 I2C writing function.
 
err_t volume2_generic_read (volume2_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
 Volume 2 I2C reading function.
 
err_t volume2_device_mute (volume2_t *ctx, uint8_t mte_state)
 Volume 2 device mute function.
 
err_t volume2_update_vol_data (volume2_t *ctx, volume2_vol_data_t update_data)
 Volume 2 update volume data function.
 

Detailed Description

This file contains API for Volume 2 Click Driver.

Enumeration Type Documentation

◆ volume2_return_value_t

Volume 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
VOLUME2_OK 
VOLUME2_ERROR