c2x20wamp.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 C2X20WAMP_H
#define C2X20WAMP_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define C2X20WAMP_MAP_MIKROBUS( cfg, mikrobus )   \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL );  \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA );  \
  cfg.shdn = MIKROBUS( mikrobus, MIKROBUS_RST );  \
  cfg.mute = MIKROBUS( mikrobus, MIKROBUS_CS );   \
  cfg.addr1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.addr2 = MIKROBUS( mikrobus, MIKROBUS_INT ); 
#define C2X20WAMP_RETVAL  int8_t
 
#define C2X20WAMP_OK             0
#define C2X20WAMP_INIT_ERROR   (-1)
#define C2X20WAMP_I2C_ADDRESS                                     0x48
#define C2X20WAMP_ADDRESS_1                                       0x01 
#define C2X20WAMP_ADDRESS_2                                       0x02
#define C2X20WAMP_6_BIT_VALUE                                     0x3F
#define C2X20WAMP_CMD_VOLUME_UP                                   0xC4
#define C2X20WAMP_CMD_VOLUME_DOWN                                 0xC5
#define C2X20WAMP_CMD_FILTERLESS_MODULATION                       0x40
#define C2X20WAMP_CMD_CLASSIC_PWM_MODULATION                      0x41
#define C2X20WAMP_6_BIT_VALUE                                     0x3F
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t shdn;
    digital_out_t mute;
 
    // Input pins 
 
    digital_out_t addr1;
    digital_out_t addr2;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} c2x20wamp_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t shdn;
    pin_name_t mute;
    pin_name_t addr1;
    pin_name_t addr2;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} c2x20wamp_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void c2x20wamp_cfg_setup ( c2x20wamp_cfg_t *cfg );
 
C2X20WAMP_RETVAL c2x20wamp_init ( c2x20wamp_t *ctx, c2x20wamp_cfg_t *cfg );
 
void c2x20wamp_generic_write ( c2x20wamp_t *ctx, uint8_t data_buf );
 
 
void c2x20wamp_mode_play( c2x20wamp_t *ctx );
 
void c2x20wamp_mode_mute( c2x20wamp_t *ctx );
 
void c2x20wamp_disable( c2x20wamp_t *ctx );
 
void c2x20wamp_enable( c2x20wamp_t *ctx );
 
void c2x20wamp_set_volume( c2x20wamp_t *ctx, uint8_t volume );
 
void c2x20wamp_volume_up( c2x20wamp_t *ctx );
 
void c2x20wamp_volume_down( c2x20wamp_t *ctx );
 
void c2x20wamp_filterless_modulation( c2x20wamp_t *ctx );
 
void c2x20wamp_classic_pwm_modulation( c2x20wamp_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // C2X20WAMP_H
 
 // End public_function group
 // End click Driver group  
 
// ------------------------------------------------------------------------ END