c3xbuck/html/c3xbuck_8h_source.html

/*

 * 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 C3XBUCK_H

#define C3XBUCK_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 C3XBUCK_MAP_MIKROBUS( cfg, mikrobus ) \

  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \

  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \

  cfg.en1  = MIKROBUS( mikrobus, MIKROBUS_AN ); \

  cfg.en2  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \

  cfg.en3  = MIKROBUS( mikrobus, MIKROBUS_INT );


#define C3XBUCK_RETVAL  uint8_t


#define C3XBUCK_OK           0x00

#define C3XBUCK_INIT_ERROR   0xFF

#define C3XBUCK_SELECT_BUCK_1   0x00

#define C3XBUCK_SELECT_BUCK_2   0x01

#define C3XBUCK_SELECT_BUCK_3   0x02

#define C3XBUCK_BUCK_DEFAULT_OUTPUT_VOLTAGE  0x80

#define C3XBUCK_REG_VOUT1_SEL                0x00

#define C3XBUCK_REG_VOUT2_SEL                0x01

#define C3XBUCK_REG_VOUT3_SEL                0x02

#define C3XBUCK_REG_VOUT1_COM                0x03

#define C3XBUCK_REG_VOUT2_COM                0x04

#define C3XBUCK_REG_VOUT3_COM                0x05

#define C3XBUCK_REG_SYS_STATUS               0x06

#define C3XBUCK_CFG_RATE_10mV_0cycles     0x00

#define C3XBUCK_CFG_RATE_10mV_2cycles     0x10

#define C3XBUCK_CFG_RATE_10mV_4cycles     0x20

#define C3XBUCK_CFG_RATE_10mV_8cycles     0x30

#define C3XBUCK_CFG_RATE_10mV_16cycles    0x40

#define C3XBUCK_CFG_RATE_10mV_32cycles    0x50

#define C3XBUCK_CFG_RATE_10mV_64cycles    0x60

#define C3XBUCK_CFG_RATE_10mV_128cycles   0x70

#define C3XBUCK_CFG_MODE_PSM_OPERATION    0x00

#define C3XBUCK_CFG_MODE_PWM_OPERATION    0x02

#define C3XBUCK_CFG_SW_ENABLE_BUCK        0x00

#define C3XBUCK_CFG_SW_DISABLE_BUCK       0x01

#define C3XBUCK_OUTPUT_VOLTAGE_680mV    0x00

#define C3XBUCK_OUTPUT_VOLTAGE_690mV    0x01

#define C3XBUCK_OUTPUT_VOLTAGE_700mV    0x02

#define C3XBUCK_OUTPUT_VOLTAGE_710mV    0x03

#define C3XBUCK_OUTPUT_VOLTAGE_720mV    0x04

#define C3XBUCK_OUTPUT_VOLTAGE_730mV    0x05

#define C3XBUCK_OUTPUT_VOLTAGE_740mV    0x06

#define C3XBUCK_OUTPUT_VOLTAGE_750mV    0x07

#define C3XBUCK_OUTPUT_VOLTAGE_760mV    0x08

#define C3XBUCK_OUTPUT_VOLTAGE_770mV    0x09

#define C3XBUCK_OUTPUT_VOLTAGE_780mV    0x0A

#define C3XBUCK_OUTPUT_VOLTAGE_790mV    0x0B

#define C3XBUCK_OUTPUT_VOLTAGE_800mV    0x0C

#define C3XBUCK_OUTPUT_VOLTAGE_810mV    0x0D

#define C3XBUCK_OUTPUT_VOLTAGE_820mV    0x0E

#define C3XBUCK_OUTPUT_VOLTAGE_830mV    0x0F

#define C3XBUCK_OUTPUT_VOLTAGE_840mV    0x10

#define C3XBUCK_OUTPUT_VOLTAGE_850mV    0x11

#define C3XBUCK_OUTPUT_VOLTAGE_860mV    0x12

#define C3XBUCK_OUTPUT_VOLTAGE_870mV    0x13

#define C3XBUCK_OUTPUT_VOLTAGE_880mV    0x14

#define C3XBUCK_OUTPUT_VOLTAGE_890mV    0x15

#define C3XBUCK_OUTPUT_VOLTAGE_900mV    0x16

#define C3XBUCK_OUTPUT_VOLTAGE_910mV    0x17

#define C3XBUCK_OUTPUT_VOLTAGE_920mV    0x18

#define C3XBUCK_OUTPUT_VOLTAGE_930mV    0x19

#define C3XBUCK_OUTPUT_VOLTAGE_940mV    0x1A

#define C3XBUCK_OUTPUT_VOLTAGE_950mV    0x1B

#define C3XBUCK_OUTPUT_VOLTAGE_960mV    0x1C

#define C3XBUCK_OUTPUT_VOLTAGE_970mV    0x1D

#define C3XBUCK_OUTPUT_VOLTAGE_980mV    0x1E

#define C3XBUCK_OUTPUT_VOLTAGE_990mV    0x1F

#define C3XBUCK_OUTPUT_VOLTAGE_1000mV   0x20

#define C3XBUCK_OUTPUT_VOLTAGE_1010mV   0x21

#define C3XBUCK_OUTPUT_VOLTAGE_1020mV   0x22

#define C3XBUCK_OUTPUT_VOLTAGE_1030mV   0x23

#define C3XBUCK_OUTPUT_VOLTAGE_1040mV   0x24

#define C3XBUCK_OUTPUT_VOLTAGE_1050mV   0x25

#define C3XBUCK_OUTPUT_VOLTAGE_1060mV   0x26

#define C3XBUCK_OUTPUT_VOLTAGE_1070mV   0x27

#define C3XBUCK_OUTPUT_VOLTAGE_1080mV   0x28

#define C3XBUCK_OUTPUT_VOLTAGE_1090mV   0x29

#define C3XBUCK_OUTPUT_VOLTAGE_1100mV   0x2A

#define C3XBUCK_OUTPUT_VOLTAGE_1110mV   0x2B

#define C3XBUCK_OUTPUT_VOLTAGE_1120mV   0x2C

#define C3XBUCK_OUTPUT_VOLTAGE_1130mV   0x2D

#define C3XBUCK_OUTPUT_VOLTAGE_1140mV   0x2E

#define C3XBUCK_OUTPUT_VOLTAGE_1150mV   0x2F

#define C3XBUCK_OUTPUT_VOLTAGE_1160mV   0x30

#define C3XBUCK_OUTPUT_VOLTAGE_1170mV   0x31

#define C3XBUCK_OUTPUT_VOLTAGE_1180mV   0x32

#define C3XBUCK_OUTPUT_VOLTAGE_1190mV   0x33

#define C3XBUCK_OUTPUT_VOLTAGE_1200mV   0x34

#define C3XBUCK_OUTPUT_VOLTAGE_1210mV   0x35

#define C3XBUCK_OUTPUT_VOLTAGE_1220mV   0x36

#define C3XBUCK_OUTPUT_VOLTAGE_1230mV   0x37

#define C3XBUCK_OUTPUT_VOLTAGE_1240mV   0x38

#define C3XBUCK_OUTPUT_VOLTAGE_1250mV   0x39

#define C3XBUCK_OUTPUT_VOLTAGE_1260mV   0x3A

#define C3XBUCK_OUTPUT_VOLTAGE_1270mV   0x3B

#define C3XBUCK_OUTPUT_VOLTAGE_1280mV   0x3C

#define C3XBUCK_OUTPUT_VOLTAGE_1290mV   0x3D

#define C3XBUCK_OUTPUT_VOLTAGE_1300mV   0x3E

#define C3XBUCK_OUTPUT_VOLTAGE_1310mV   0x3F

#define C3XBUCK_OUTPUT_VOLTAGE_1320mV   0x40

#define C3XBUCK_OUTPUT_VOLTAGE_1330mV   0x41

#define C3XBUCK_OUTPUT_VOLTAGE_1340mV   0x42

#define C3XBUCK_OUTPUT_VOLTAGE_1350mV   0x43

#define C3XBUCK_OUTPUT_VOLTAGE_1360mV   0x44

#define C3XBUCK_OUTPUT_VOLTAGE_1370mV   0x45

#define C3XBUCK_OUTPUT_VOLTAGE_1380mV   0x46

#define C3XBUCK_OUTPUT_VOLTAGE_1390mV   0x47

#define C3XBUCK_OUTPUT_VOLTAGE_1400mV   0x48

#define C3XBUCK_OUTPUT_VOLTAGE_1410mV   0x49

#define C3XBUCK_OUTPUT_VOLTAGE_1420mV   0x4A

#define C3XBUCK_OUTPUT_VOLTAGE_1430mV   0x4B

#define C3XBUCK_OUTPUT_VOLTAGE_1440mV   0x4C

#define C3XBUCK_OUTPUT_VOLTAGE_1450mV   0x4D

#define C3XBUCK_OUTPUT_VOLTAGE_1460mV   0x4E

#define C3XBUCK_OUTPUT_VOLTAGE_1470mV   0x4F

#define C3XBUCK_OUTPUT_VOLTAGE_1480mV   0x50

#define C3XBUCK_OUTPUT_VOLTAGE_1490mV   0x51

#define C3XBUCK_OUTPUT_VOLTAGE_1500mV   0x52

#define C3XBUCK_OUTPUT_VOLTAGE_1510mV   0x53

#define C3XBUCK_OUTPUT_VOLTAGE_1520mV   0x54

#define C3XBUCK_OUTPUT_VOLTAGE_1530mV   0x55

#define C3XBUCK_OUTPUT_VOLTAGE_1540mV   0x56

#define C3XBUCK_OUTPUT_VOLTAGE_1550mV   0x57

#define C3XBUCK_OUTPUT_VOLTAGE_1560mV   0x58

#define C3XBUCK_OUTPUT_VOLTAGE_1570mV   0x59

#define C3XBUCK_OUTPUT_VOLTAGE_1580mV   0x5A

#define C3XBUCK_OUTPUT_VOLTAGE_1590mV   0x5B

#define C3XBUCK_OUTPUT_VOLTAGE_1600mV   0x5C

#define C3XBUCK_OUTPUT_VOLTAGE_1610mV   0x5D

#define C3XBUCK_OUTPUT_VOLTAGE_1620mV   0x5E

#define C3XBUCK_OUTPUT_VOLTAGE_1630mV   0x5F

#define C3XBUCK_OUTPUT_VOLTAGE_1640mV   0x60

#define C3XBUCK_OUTPUT_VOLTAGE_1650mV   0x61

#define C3XBUCK_OUTPUT_VOLTAGE_1660mV   0x62

#define C3XBUCK_OUTPUT_VOLTAGE_1670mV   0x63

#define C3XBUCK_OUTPUT_VOLTAGE_1680mV   0x64

#define C3XBUCK_OUTPUT_VOLTAGE_1690mV   0x65

#define C3XBUCK_OUTPUT_VOLTAGE_1700mV   0x66

#define C3XBUCK_OUTPUT_VOLTAGE_1710mV   0x67

#define C3XBUCK_OUTPUT_VOLTAGE_1720mV   0x68

#define C3XBUCK_OUTPUT_VOLTAGE_1730mV   0x69

#define C3XBUCK_OUTPUT_VOLTAGE_1740mV   0x6A

#define C3XBUCK_OUTPUT_VOLTAGE_1750mV   0x6B

#define C3XBUCK_OUTPUT_VOLTAGE_1760mV   0x6C

#define C3XBUCK_OUTPUT_VOLTAGE_1770mV   0x6D

#define C3XBUCK_OUTPUT_VOLTAGE_1780mV   0x6E

#define C3XBUCK_OUTPUT_VOLTAGE_1790mV   0x6F

#define C3XBUCK_OUTPUT_VOLTAGE_1800mV   0x70

#define C3XBUCK_OUTPUT_VOLTAGE_1810mV   0x71

#define C3XBUCK_OUTPUT_VOLTAGE_1820mV   0x72

#define C3XBUCK_OUTPUT_VOLTAGE_1830mV   0x73

#define C3XBUCK_OUTPUT_VOLTAGE_1840mV   0x74

#define C3XBUCK_OUTPUT_VOLTAGE_1850mV   0x75

#define C3XBUCK_OUTPUT_VOLTAGE_1860mV   0x76

#define C3XBUCK_OUTPUT_VOLTAGE_1870mV   0x77

#define C3XBUCK_OUTPUT_VOLTAGE_1880mV   0x78

#define C3XBUCK_OUTPUT_VOLTAGE_1890mV   0x79

#define C3XBUCK_OUTPUT_VOLTAGE_1900mV   0x7A

#define C3XBUCK_OUTPUT_VOLTAGE_1910mV   0x7B

#define C3XBUCK_OUTPUT_VOLTAGE_1920mV   0x7C

#define C3XBUCK_OUTPUT_VOLTAGE_1930mV   0x7D

#define C3XBUCK_OUTPUT_VOLTAGE_1940mV   0x7E

#define C3XBUCK_OUTPUT_VOLTAGE_1950mV   0x7F

 // End group macro

// --------------------------------------------------------------- PUBLIC TYPES


typedef struct

{

    // Output pins


    digital_out_t en1;

    digital_out_t en2;

    digital_out_t en3;


    // Modules


    i2c_master_t i2c;


    // ctx variable


    uint8_t slave_address;


} c3xbuck_t;


typedef struct

{

    // Communication gpio pins


    pin_name_t scl;

    pin_name_t sda;


    // Additional gpio pins


    pin_name_t en1;

    pin_name_t en2;

    pin_name_t en3;


    // static variable


    uint32_t i2c_speed;

    uint8_t i2c_address;


} c3xbuck_cfg_t;


 // End types group

// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS


#ifdef __cplusplus

extern "C"{

#endif


void c3xbuck_cfg_setup ( c3xbuck_cfg_t *cfg );


C3XBUCK_RETVAL c3xbuck_init ( c3xbuck_t *ctx, c3xbuck_cfg_t *cfg );


void c3xbuck_default_cfg ( c3xbuck_t *ctx );


void c3xbuck_write_byte ( c3xbuck_t *ctx, uint8_t reg, uint8_t data_value );


uint8_t c3xbuck_read_byte( c3xbuck_t *ctx, uint8_t reg);


void c3xbuck_enable_buck ( c3xbuck_t *ctx, uint8_t buck );


void c3xbuck_disable_buck ( c3xbuck_t *ctx, uint8_t buck );


void c3xbuck_set_voltage ( c3xbuck_t *ctx, uint8_t buck, uint8_t voltage );


uint8_t c3xbuck_get_status( c3xbuck_t *ctx );


void c3xbuck_configuration_buck( c3xbuck_t *ctx, uint8_t buck, uint8_t config);


#ifdef __cplusplus

}

#endif

#endif  // _C3XBUCK_H_


 // End public_function group


// ------------------------------------------------------------------------- END

C3XBUCK_RETVAL
#define C3XBUCK_RETVAL
Definition c3xbuck.h:79

c3xbuck_read_byte
uint8_t c3xbuck_read_byte(c3xbuck_t *ctx, uint8_t reg)
Generic read function.

c3xbuck_write_byte
void c3xbuck_write_byte(c3xbuck_t *ctx, uint8_t reg, uint8_t data_value)
Write byte function.

c3xbuck_default_cfg
void c3xbuck_default_cfg(c3xbuck_t *ctx)
Click Default Configuration function.

c3xbuck_get_status
uint8_t c3xbuck_get_status(c3xbuck_t *ctx)
Get status function.

c3xbuck_init
C3XBUCK_RETVAL c3xbuck_init(c3xbuck_t *ctx, c3xbuck_cfg_t *cfg)
Initialization function.

c3xbuck_set_voltage
void c3xbuck_set_voltage(c3xbuck_t *ctx, uint8_t buck, uint8_t voltage)
Set voltage function.

c3xbuck_cfg_setup
void c3xbuck_cfg_setup(c3xbuck_cfg_t *cfg)
Config Object Initialization function.

c3xbuck_configuration_buck
void c3xbuck_configuration_buck(c3xbuck_t *ctx, uint8_t buck, uint8_t config)
Configuration function.

c3xbuck_disable_buck
void c3xbuck_disable_buck(c3xbuck_t *ctx, uint8_t buck)
Disable Buck function.

c3xbuck_enable_buck
void c3xbuck_enable_buck(c3xbuck_t *ctx, uint8_t buck)
Enable Buck function.

c3xbuck_cfg_t
Click configuration structure definition.
Definition c3xbuck.h:292

c3xbuck_cfg_t::en2
pin_name_t en2
Definition c3xbuck.h:301

c3xbuck_cfg_t::i2c_speed
uint32_t i2c_speed
Definition c3xbuck.h:306

c3xbuck_cfg_t::en1
pin_name_t en1
Definition c3xbuck.h:300

c3xbuck_cfg_t::en3
pin_name_t en3
Definition c3xbuck.h:302

c3xbuck_cfg_t::scl
pin_name_t scl
Definition c3xbuck.h:295

c3xbuck_cfg_t::sda
pin_name_t sda
Definition c3xbuck.h:296

c3xbuck_cfg_t::i2c_address
uint8_t i2c_address
Definition c3xbuck.h:307

c3xbuck_t
Click ctx object definition.
Definition c3xbuck.h:271

c3xbuck_t::en2
digital_out_t en2
Definition c3xbuck.h:275

c3xbuck_t::en1
digital_out_t en1
Definition c3xbuck.h:274

c3xbuck_t::i2c
i2c_master_t i2c
Definition c3xbuck.h:280

c3xbuck_t::en3
digital_out_t en3
Definition c3xbuck.h:276

c3xbuck_t::slave_address
uint8_t slave_address
Definition c3xbuck.h:284