volume.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 VOLUME_H
#define VOLUME_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_spi_master.h"
 
#define VOLUME_ZCE_DISABLE  0x00
#define VOLUME_ZCE_ENABLE   0x01
 
 // zce_state
 
#define VOLUME_MUTE_ENABLE  0x00
#define VOLUME_MUTE_DISABLE 0x01
 
 // mute_state
 
 
#define VOLUME_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.zce = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.sen = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // volume_map
 // volume
 
typedef struct
{
    // Output pins
 
    digital_out_t  zce;                                  
    digital_out_t  sen;                                  
    // Modules
 
    spi_master_t  spi;                                   
    pin_name_t    chip_select;                           
} volume_t;
 
typedef struct
{
    // Communication gpio pins
 
    pin_name_t  miso;                                    
    pin_name_t  mosi;                                    
    pin_name_t  sck;                                     
    pin_name_t  cs;                                      
    // Additional gpio pins
 
    pin_name_t   zce;                                    
    pin_name_t   sen;                                    
    // static variable
 
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} volume_cfg_t;
 
void volume_cfg_setup ( volume_cfg_t *cfg );
 
err_t volume_init ( volume_t *ctx, volume_cfg_t *cfg );
 
void volume_default_cfg ( volume_t *ctx );
 
void volume_power_up ( volume_t *ctx );
 
void volume_hw_mute ( volume_t *ctx, uint8_t mute_state );
 
void volume_zero_crossing ( volume_t *ctx, uint8_t zce_state );
 
err_t volume_set_vol_gain ( volume_t *ctx, float volume_left_dB, float volume_right_dB );
 
#ifdef __cplusplus
}
#endif
#endif // VOLUME_H
 
 // volume
 
// ------------------------------------------------------------------------ END