headphoneamp.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 HEADPHONEAMP_H
#define HEADPHONEAMP_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 HEADPHONEAMP_SOUND_VOLUME_NEG_33_dB                  0
#define HEADPHONEAMP_SOUND_VOLUME_NEG_30_dB                  1
#define HEADPHONEAMP_SOUND_VOLUME_NEG_27_dB                  2
#define HEADPHONEAMP_SOUND_VOLUME_NEG_24_dB                  3
#define HEADPHONEAMP_SOUND_VOLUME_NEG_21_dB                  4
#define HEADPHONEAMP_SOUND_VOLUME_NEG_18_dB                  5
#define HEADPHONEAMP_SOUND_VOLUME_NEG_15_dB                  6
#define HEADPHONEAMP_SOUND_VOLUME_NEG_12_dB                  7
#define HEADPHONEAMP_SOUND_VOLUME_NEG_9_dB                   8 
#define HEADPHONEAMP_SOUND_VOLUME_NEG_6_dB                   9 
#define HEADPHONEAMP_SOUND_VOLUME_NEG_3_dB                  10
#define HEADPHONEAMP_SOUND_VOLUME_NEG_0_dB                  11
#define HEADPHONEAMP_SOUND_VOLUME_POS_3_dB                  12
#define HEADPHONEAMP_SOUND_VOLUME_POS_6_dB                  13
#define HEADPHONEAMP_SOUND_VOLUME_POS_9_dB                  14
#define HEADPHONEAMP_SOUND_VOLUME_POS_12_dB                 15
 
 // headphoneamp_set
 
#define HEADPHONEAMP_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.shdn = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.clk = MIKROBUS( mikrobus, MIKROBUS_PWM );  \
    cfg.ud = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // headphoneamp_map
 // headphoneamp
 
typedef struct
{
    digital_out_t  shdn;    
    digital_out_t  clk;     
    digital_out_t  ud;      
} headphoneamp_t;
 
typedef struct
{
    pin_name_t  shdn;     
    pin_name_t  clk;      
    pin_name_t  ud;       
} headphoneamp_cfg_t;
 
typedef enum
{
   HEADPHONEAMP_OK = 0,
   HEADPHONEAMP_ERROR = -1
 
} headphoneamp_return_value_t;
 
void headphoneamp_cfg_setup ( headphoneamp_cfg_t *cfg );
 
err_t headphoneamp_init ( headphoneamp_t *ctx, headphoneamp_cfg_t *cfg );
 
err_t headphoneamp_default_cfg ( headphoneamp_t *ctx );
 
err_t headphoneamp_shutdown ( headphoneamp_t *ctx );
 
err_t headphoneamp_power_up ( headphoneamp_t *ctx );
 
err_t headphoneamp_volume_down ( headphoneamp_t *ctx );
 
err_t headphoneamp_volume_up ( headphoneamp_t *ctx );
 
err_t headphoneamp_set_sound_volume ( headphoneamp_t *ctx, uint8_t sound_volume );
 
#ifdef __cplusplus
}
#endif
#endif // HEADPHONEAMP_H
 
 // headphoneamp
 
// ------------------------------------------------------------------------ END