stepdown3.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 STEPDOWN3_H
#define STEPDOWN3_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"
 
#define STEPDOWN3_OUT_VOLTAGE_1V6       0x00
#define STEPDOWN3_OUT_VOLTAGE_1V8       0x01
#define STEPDOWN3_OUT_VOLTAGE_2V1       0x02
#define STEPDOWN3_OUT_VOLTAGE_2V5       0x03
#define STEPDOWN3_OUT_VOLTAGE_2V7       0x04
#define STEPDOWN3_OUT_VOLTAGE_2V8       0x05
#define STEPDOWN3_OUT_VOLTAGE_3V0       0x06
#define STEPDOWN3_OUT_VOLTAGE_3V3       0x07
 
 // stepdown3_set
 
#define STEPDOWN3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.d2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.aux = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.d1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.d0 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // stepdown3_map
 // stepdown3
 
typedef struct
{
    digital_out_t  d2;      
    digital_out_t  en;      
    digital_out_t  aux;     
    digital_out_t  d1;      
    digital_out_t  d0;      
} stepdown3_t;
 
typedef struct
{
    pin_name_t  d2;         
    pin_name_t  en;         
    pin_name_t  aux;        
    pin_name_t  d1;         
    pin_name_t  d0;         
} stepdown3_cfg_t;
 
typedef enum
{
    STEPDOWN3_OK = 0,
    STEPDOWN3_ERROR = -1
 
} stepdown3_return_value_t;
 
void stepdown3_cfg_setup ( stepdown3_cfg_t *cfg );
 
err_t stepdown3_init ( stepdown3_t *ctx, stepdown3_cfg_t *cfg );
 
void stepdown3_enable_device ( stepdown3_t *ctx );
 
void stepdown3_disable_device ( stepdown3_t *ctx );
 
void stepdown3_enable_aux_output ( stepdown3_t *ctx );
 
void stepdown3_disable_aux_output ( stepdown3_t *ctx );
 
void stepdown3_set_output_voltage ( stepdown3_t *ctx, uint8_t vout );
 
#ifdef __cplusplus
}
#endif
#endif // STEPDOWN3_H
 
 // stepdown3
 
// ------------------------------------------------------------------------ END