volume2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef VOLUME2_H
#define VOLUME2_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define VOLUME2_REG_VOLUME_1A_2A                                0x00
 
#define VOLUME2_REG_VOLUME_1B_ZERO1                             0x01
 
#define VOLUME2_REG_VOLUME_2B_ZERO2                             0x02
 
 // volume2_reg
 
#define VOLUME2_GAIN_OPT_0_DB                                   0x00
 
#define VOLUME2_GAIN_OPT_3_DB                                   0x01
 
#define VOLUME2_GAIN_OPT_6_DB                                   0x02
 
#define VOLUME2_GAIN_OPT_9_DB                                   0x03
 
#define VOLUME2_ZERO_CROSS_DET_OPT_OFF                          0x00
 
#define VOLUME2_ZERO_CROSS_DET_OPT_ON                           0x01
 
#define VOLUME2_SET_DEV_ADDR  0x44
 
 // volume2_set
 
#define VOLUME2_DEVICE_MUTE_ON                                  0x00
 
#define VOLUME2_DEVICE_MUTE_OFF                                 0x01
 
 // mte_state
 
#define VOLUME2_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.mte = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // volume2_map
 // volume2
 
typedef struct
{
    // Output pins
 
    digital_out_t  mte;                              
    // Modules
 
    i2c_master_t i2c;                                
    // I2C slave address
 
    uint8_t slave_address;                           
} volume2_t;
 
typedef struct
{
    pin_name_t  scl;                                 
    pin_name_t  sda;                                 
    pin_name_t  mte;                                 
    uint32_t  i2c_speed;                             
    uint8_t   i2c_address;                           
} volume2_cfg_t;
 
typedef enum
{
    VOLUME2_OK = 0,
    VOLUME2_ERROR = -1
 
} volume2_return_value_t;
 
typedef struct
{
    uint8_t gain_ch1;                                
    uint8_t gain_ch2;                                
    uint8_t attenuation_ch1;                         
    uint8_t attenuation_ch2;                         
    uint8_t zero_cross_det_ch1;                      
    uint8_t zero_cross_det_ch2;                      
} volume2_vol_data_t;
 
void volume2_cfg_setup ( volume2_cfg_t *cfg );
 
err_t volume2_init ( volume2_t *ctx, volume2_cfg_t *cfg );
 
err_t volume2_default_cfg ( volume2_t *ctx );
 
err_t volume2_generic_write ( volume2_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t volume2_generic_read ( volume2_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t volume2_device_mute ( volume2_t *ctx, uint8_t mte_state );
 
err_t volume2_update_vol_data ( volume2_t *ctx, volume2_vol_data_t update_data );
 
#ifdef __cplusplus
}
#endif
#endif // VOLUME2_H
 
 // volume2
 
// ------------------------------------------------------------------------ END