ldo.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 LDO_H
#define LDO_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 LDO_REG_INPUT_PORT              0x00
#define LDO_REG_OUTPUT_PORT             0x01
#define LDO_REG_POLARITY_INV            0x02
#define LDO_REG_CONFIG                  0x03
 
 // ldo_reg
 
#define LDO_PIN_NONE                    0x00
#define LDO_PIN_1600_mV                 0x01
#define LDO_PIN_800_mV                  0x02
#define LDO_PIN_400_mV                  0x04
#define LDO_PIN_200_mV                  0x08
#define LDO_PIN_100_mV                  0x10
#define LDO_PIN_50_mV                   0x20
#define LDO_PIN_ALL                     0x3F
 
#define LDO_PIN_LOW                     0
#define LDO_PIN_OPEN                    1
 
#define LDO_VOUT_MIN                    800
#define LDO_VOUT_STEP                   50
#define LDO_VOUT_MAX                    3950
 
#define LDO_DEVICE_ADDRESS_0            0x38
#define LDO_DEVICE_ADDRESS_1            0x39
#define LDO_DEVICE_ADDRESS_2            0x3A
#define LDO_DEVICE_ADDRESS_3            0x3B
#define LDO_DEVICE_ADDRESS_4            0x3C
#define LDO_DEVICE_ADDRESS_5            0x3D
#define LDO_DEVICE_ADDRESS_6            0x3E
#define LDO_DEVICE_ADDRESS_7            0x3F
 
 // ldo_set
 
#define LDO_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); 
 
 // ldo_map
 // ldo
 
typedef struct
{    
    // Output pins
    digital_out_t en;           
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} ldo_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t en;              
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} ldo_cfg_t;
 
typedef enum
{
    LDO_OK = 0,
    LDO_ERROR = -1
 
} ldo_return_value_t;
 
void ldo_cfg_setup ( ldo_cfg_t *cfg );
 
err_t ldo_init ( ldo_t *ctx, ldo_cfg_t *cfg );
 
err_t ldo_default_cfg ( ldo_t *ctx );
 
err_t ldo_write_register ( ldo_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t ldo_read_register ( ldo_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t ldo_set_pin_state ( ldo_t *ctx, uint8_t pin_mask, uint8_t state );
 
err_t ldo_set_vout ( ldo_t *ctx, uint16_t vout );
 
void ldo_enable_device ( ldo_t *ctx );
 
void ldo_disable_device ( ldo_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // LDO_H
 
 // ldo
 
// ------------------------------------------------------------------------ END