boost8.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 BOOST8_H
#define BOOST8_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 BOOST8_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.en_p = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.en_n = MIKROBUS( mikrobus, MIKROBUS_PWM ); 
 
 // boost8_map
 // boost8
 
typedef struct
{
    digital_out_t en_p;     
    digital_out_t en_n;     
} boost8_t;
 
typedef struct
{
    pin_name_t en_p;    
    pin_name_t en_n;    
} boost8_cfg_t;
 
typedef enum
{
    BOOST8_OK = 0,
    BOOST8_ERROR = -1
 
} boost8_return_value_t;
 
void boost8_cfg_setup ( boost8_cfg_t *cfg );
 
err_t boost8_init ( boost8_t *ctx, boost8_cfg_t *cfg );
 
void boost8_default_cfg ( boost8_t *ctx );
 
void boost8_enable_positive_voltage( boost8_t *ctx );
 
void boost8_disable_positive_voltage( boost8_t *ctx );
 
void boost8_enable_negative_voltage( boost8_t *ctx );
 
void boost8_disable_negative_voltage( boost8_t *ctx );
 
void boost8_enable_both_outputs ( boost8_t *ctx );
 
void boost8_disable_both_outputs ( boost8_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // BOOST8_H
 
 // boost8
 
// ------------------------------------------------------------------------ END