audioamp9.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 AUDIOAMP9_H
#define AUDIOAMP9_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"
 
#define AUDIOAMP9_GAIN_LEVEL1           0x01
#define AUDIOAMP9_GAIN_LEVEL2           0x02
#define AUDIOAMP9_GAIN_LEVEL3           0x03
#define AUDIOAMP9_GAIN_LEVEL4           0x04
 
 // audioamp9_set
 
#define AUDIOAMP9_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.mut = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.shd = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.g0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.g1 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // audioamp9_map
 // audioamp9
 
typedef struct
{
    digital_out_t mut;     
    digital_out_t shd;     
    digital_out_t g0;      
    digital_out_t g1;      
} audioamp9_t;
 
typedef struct
{
    pin_name_t mut;      
    pin_name_t shd;      
    pin_name_t g0;       
    pin_name_t g1;       
} audioamp9_cfg_t;
 
typedef enum
{
    AUDIOAMP9_OK = 0,
    AUDIOAMP9_ERROR = -1
 
} audioamp9_return_value_t;
 
void audioamp9_cfg_setup ( audioamp9_cfg_t *cfg );
 
err_t audioamp9_init ( audioamp9_t *ctx, audioamp9_cfg_t *cfg );
 
void audioamp9_default_cfg ( audioamp9_t *ctx );
 
void audioamp9_shutdown_on ( audioamp9_t *ctx );
 
void audioamp9_shutdown_off ( audioamp9_t *ctx );
 
void audioamp9_mute_on ( audioamp9_t *ctx );
 
void audioamp9_mute_off ( audioamp9_t *ctx );
 
void audioamp9_set_gain1 ( audioamp9_t *ctx );
 
void audioamp9_set_gain2 ( audioamp9_t *ctx );
 
void audioamp9_set_gain3 ( audioamp9_t *ctx );
 
void audioamp9_set_gain4 ( audioamp9_t *ctx );
 
err_t audioamp9_set_gain_level ( audioamp9_t *ctx, uint8_t gain_level );
 
#ifdef __cplusplus
}
#endif
#endif // AUDIOAMP9_H
 
 // audioamp9
 
// ------------------------------------------------------------------------ END