headphoneamp2.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 HEADPHONEAMP2_H
#define HEADPHONEAMP2_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 HEADPHONEAMP2_VOL_MUTE              0x00
#define HEADPHONEAMP2_VOL_LVL_1             0x01
#define HEADPHONEAMP2_VOL_LVL_2             0x02
#define HEADPHONEAMP2_VOL_LVL_3             0x03
#define HEADPHONEAMP2_VOL_LVL_4             0x04
#define HEADPHONEAMP2_VOL_LVL_5             0x05
#define HEADPHONEAMP2_VOL_LVL_6             0x06
#define HEADPHONEAMP2_VOL_LVL_7             0x07
#define HEADPHONEAMP2_VOL_LVL_8             0x08
#define HEADPHONEAMP2_VOL_LVL_9             0x09
#define HEADPHONEAMP2_VOL_LVL_10            0x0A
#define HEADPHONEAMP2_VOL_LVL_11            0x0B
#define HEADPHONEAMP2_VOL_LVL_12            0x0C
#define HEADPHONEAMP2_VOL_LVL_13            0x0D
#define HEADPHONEAMP2_VOL_LVL_14            0x0E
#define HEADPHONEAMP2_VOL_LVL_MAX           0x0F
 
#define HEADPHONEAMP2_DEVICE_ADDRESS        0x4C
 
 // headphoneamp2_set
 
#define HEADPHONEAMP2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );   \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );   \
    cfg.shd = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // headphoneamp2_map
 // headphoneamp2
 
typedef struct
{
    // Output pins
    digital_out_t shd;        
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} headphoneamp2_t;
 
typedef struct
{
    pin_name_t scl;            
    pin_name_t sda;            
    pin_name_t shd;            
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} headphoneamp2_cfg_t;
 
typedef enum
{
    HEADPHONEAMP2_CMD_DISABLE = 0,
    HEADPHONEAMP2_CMD_ENABLE
 
} headphoneamp2_cmd_ctrl_value_t;
 
typedef struct
{
    headphoneamp2_cmd_ctrl_value_t wakes_up;    
    headphoneamp2_cmd_ctrl_value_t bass_max;    
    headphoneamp2_cmd_ctrl_value_t gain_max;    
    uint8_t                        volume;      
} headphoneamp2_cmd_t;
 
typedef enum
{
    HEADPHONEAMP2_OK = 0,
    HEADPHONEAMP2_ERROR = -1
 
} headphoneamp2_return_value_t;
 
void headphoneamp2_cfg_setup ( headphoneamp2_cfg_t *cfg );
 
err_t headphoneamp2_init ( headphoneamp2_t *ctx, headphoneamp2_cfg_t *cfg );
 
err_t headphoneamp2_default_cfg ( headphoneamp2_t *ctx );
 
err_t headphoneamp2_write_data ( headphoneamp2_t *ctx, uint8_t data_in );
 
void headphoneamp2_enable ( headphoneamp2_t *ctx );
 
void headphoneamp2_disable ( headphoneamp2_t *ctx );
 
err_t headphoneamp2_set_command ( headphoneamp2_t *ctx, headphoneamp2_cmd_t cmd_ctrl );
 
#ifdef __cplusplus
}
#endif
#endif // HEADPHONEAMP2_H
 
 // headphoneamp2
 
// ------------------------------------------------------------------------ END