buck.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 BUCK_H
#define BUCK_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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define BUCK_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.a0= MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.a1= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.pg= MIKROBUS( mikrobus, MIKROBUS_INT );
#define BUCK_RETVAL  uint8_t
 
#define BUCK_OK           0x00
#define BUCK_INIT_ERROR   0xFF
#define BUCK_DEVICE_DISABLE  0
#define BUCK_DEVICE_ENABLE   1
#define BUCK_FREQ_400KHz   0x00
#define BUCK_FREQ_1200KHz  0x01
#define BUCK_FREQ_800KHz   0x02
#define BUCK_FREQ_1600KHz  0x03
#define BUCK_SET_MULTIPLEXER_A0 0
#define BUCK_SET_MULTIPLEXER_A1 1
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t a0;
    digital_out_t en;
    digital_out_t a1;
 
    // Input pins 
 
    digital_in_t pg;
 
} buck_t;
 
typedef struct
{
    // Additional gpio pins 
 
    pin_name_t a0;
    pin_name_t en;
    pin_name_t a1;
    pin_name_t pg;
 
} buck_cfg_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void buck_cfg_setup ( buck_cfg_t *cfg );
 
BUCK_RETVAL buck_init ( buck_t *ctx, buck_cfg_t *cfg );
 
void buck_default_cfg ( buck_t *ctx );
 
void buck_device_reset ( buck_t *ctx );
 
void buck_set_mode ( buck_t *ctx, uint8_t mode );
 
uint8_t buck_get_power_good ( buck_t *ctx );
 
void buck_set_multiplexer_state ( buck_t *ctx, uint8_t mux, uint8_t state );
 
void buck_switch_frequency ( buck_t *ctx, uint8_t frequency );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _BUCK_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END