mic24045.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 MIC24045_H
#define MIC24045_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 MIC24045_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
#define MIC24045_RETVAL  uint8_t
 
#define MIC24045_OK           0x00
#define MIC24045_INIT_ERROR   0xFF
#define MIC24045_I2C_ADDRESS                                  0x50
 
#define MIC24045_REG_STATUS                                   0x00
#define MIC24045_REG_SETTINGS1                                0x01
#define MIC24045_REG_SETTINGS2                                0x02
#define MIC24045_REG_VOUT                                     0x03
#define MIC24045_REG_COMMAND                                  0x04
#define MIC24045_BIT_PGS                                      0x01
#define MIC24045_BIT_ENS                                      0x08
#define MIC24045_BIT_THWRNF                                   0x20
#define MIC24045_BIT_THSDF                                    0x40
#define MIC24045_BIT_OCF                                      0x80
#define MIC24045_BIT_CIFF                                     0x01
#define MIC24045_SETTING_CURRENT_NORMAL_LOAD_2_A              0x00
#define MIC24045_SETTING_CURRENT_NORMAL_LOAD_3_A              0x40
#define MIC24045_SETTING_CURRENT_NORMAL_LOAD_4_A              0x80
#define MIC24045_SETTING_CURRENT_NORMAL_LOAD_5_A              0xC0
#define MIC24045_SETTING_FREQUENCY_310_kHz                    0x00
#define MIC24045_SETTING_FREQUENCY_400_kHz                    0x08
#define MIC24045_SETTING_FREQUENCY_500_kHz                    0x10
#define MIC24045_SETTING_FREQUENCY_570_kHz                    0x18
#define MIC24045_SETTING_FREQUENCY_660_kHz                    0x20
#define MIC24045_SETTING_FREQUENCY_780_kHz                    0x28
#define MIC24045_SETTING_FREQUENCY_970_kHz                    0x30
#define MIC24045_SETTING_FREQUENCY_1200_kHz                   0x38
#define MIC24045_SETTING_START_UP_DELAY_0_ms                  0x00
#define MIC24045_SETTING_START_UP_DELAY_0_5_ms                0x10
#define MIC24045_SETTING_START_UP_DELAY_1_ms                  0x20
#define MIC24045_SETTING_START_UP_DELAY_2_ms                  0x30
#define MIC24045_SETTING_START_UP_DELAY_4_ms                  0x40
#define MIC24045_SETTING_START_UP_DELAY_6_ms                  0x50
#define MIC24045_SETTING_START_UP_DELAY_8_ms                  0x60
#define MIC24045_SETTING_START_UP_DELAY_10_ms                 0x70
#define MIC24045_SETTING_CHANGE_NOMINAL_0_PERC                0x00
#define MIC24045_SETTING_CHANGE_NOMINAL_NEG_5_PERC            0x04
#define MIC24045_SETTING_CHANGE_NOMINAL_POS_5_PERC            0x08
#define MIC24045_SETTING_CHANGE_NOMINAL_POS_5_0_PERC          0x0C
#define MIC24045_SETTING_SOFT_START_SLOPE_0_16_Vms            0x00
#define MIC24045_SETTING_SOFT_START_SLOPE_0_38_Vms            0x01
#define MIC24045_SETTING_SOFT_START_SLOPE_0_76_Vms            0x02
#define MIC24045_SETTING_SOFT_START_SLOPE_1_50_Vms            0x03
#define MIC24045_MAX_VOUT                                     5.250
#define MIC24045_MIN_VOUT                                     0.640
#define MIC24045_MAX_VOUT_DEC                                 0xFF
#define MIC24045_MIN_VOUT_DEC                                 0x00
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t en;
 
    // Input pins 
 
    digital_in_t pg;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} mic24045_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t en;
    pin_name_t pg;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} mic24045_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void mic24045_cfg_setup ( mic24045_cfg_t *cfg );
 
MIC24045_RETVAL mic24045_init ( mic24045_t *ctx, mic24045_cfg_t *cfg );
 
void mic24045_generic_write ( mic24045_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void mic24045_generic_read ( mic24045_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t mic24045_get_status ( mic24045_t *ctx );
 
float mic24045_get_vout ( mic24045_t *ctx );
 
void mic24045_set_vout( mic24045_t *ctx, float v_out );
 
void mic24045_set_vout_decimal ( mic24045_t *ctx, uint8_t dec );
 
void mic24045_enable( mic24045_t *ctx );
 
void mic24045_disable( mic24045_t *ctx );
 
uint8_t mic24045_get_power_good_state( mic24045_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _MIC24045_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END