evc.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 EVC_H
#define EVC_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_digital_in.h"
#include "drv_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define EVC_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define EVC_RETVAL  uint8_t
 
#define EVC_OK           0x00
#define EVC_INIT_ERROR   0xFF
#define EVC_SET_VOLUME_1dB     0x11
#define EVC_SET_VOLUME_10dB    0x01
#define EVC_SET_VOLUME_20dB    0x02
#define EVC_SET_VOLUME_2dB     0x12
#define EVC_SET_VOLUME_30dB    0x03
#define EVC_SET_VOLUME_3dB     0x13
#define EVC_SET_VOLUME_40dB    0x04
#define EVC_SET_VOLUME_4dB     0x14
#define EVC_SET_VOLUME_50dB    0x05
#define EVC_SET_VOLUME_5dB     0x15
#define EVC_SET_VOLUME_60dB    0x06
#define EVC_SET_VOLUME_6dB     0x16
#define EVC_SET_VOLUME_70dB    0x07
#define EVC_SET_VOLUME_7dB     0x17
#define EVC_SET_VOLUME_0dB     0x00
#define EVC_SET_VOLUME_8dB     0x18
#define EVC_SET_VOLUME_9dB     0x19
#define EVC_CHANNEL_1      0x80
#define EVC_CHANNEL_2      0x40
#define EVC_CHANNEL_3      0x00
#define EVC_CHANNEL_4      0x20
#define EVC_CHANNEL_5      0x60
#define EVC_CHANNEL_6      0xA0
#define EVC_ALL_CHANNEL    0xC0
#define EVC_ALL_CHANNEL_MUTE      0xF9
#define EVC_ALL_CHANNEL_UNMUTE    0xF8
#define EVC_CLEAR_ALL    0xC0
#define EVC_DEVICE_SLAVE_ADDRESS_01    0x42
#define EVC_DEVICE_SLAVE_ADDRESS_00    0x40
#define EVC_DEVICE_SLAVE_ADDRESS_10    0x44
#define EVC_DEVICE_SLAVE_ADDRESS_11    0x46
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
    uint8_t mute_flag;
    uint8_t play_flag;
    int8_t volume;
    uint8_t channel;
    uint8_t test_flag;
 
} evc_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
    uint8_t mute_cfg_flag;
    uint8_t play_cfg_flag;
    int8_t cfg_volume;
    uint8_t cfg_channel;
    uint8_t test_cfg_flag;
 
} evc_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void evc_cfg_setup ( evc_cfg_t *cfg );
 
EVC_RETVAL evc_init ( evc_t *ctx, evc_cfg_t *cfg );
 
void evc_default_cfg ( evc_t *ctx );
 
void evc_generic_write ( evc_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void evc_generic_read ( evc_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void evc_set_volume_part ( evc_t *ctx, uint8_t channel, uint8_t volume1, uint8_t volume2 );
 
void evc_set_volume_full ( evc_t *ctx, uint8_t channel, int8_t volume );
 
void evc_clear ( evc_t *ctx );
 
void evc_mute ( evc_t *ctx, uint8_t mute );
 
#ifdef __cplusplus
}
#endif
#endif  // _EVC_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END