charger26.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 CHARGER26_H
#define CHARGER26_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 CHARGER26_PIN_STATE_HIGH                0x01
#define CHARGER26_PIN_STATE_LOW                 0x00
 
#define CHARGER26_SELV_4V1_REG_POINT            0x00
#define CHARGER26_SELV_4V2_REG_POINT            0x01
 
#define CHARGER26_SELI_100_MA_MAX_REG           0x00
#define CHARGER26_SELI_500_MA_MAX_REG           0x01
 
#define CHARGER26_ENABLE_OUTPUT                 0x01
#define CHARGER26_DISABLE_OUTPUT                0x00
 
 
 // charger26_set
 
#define CHARGER26_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.vsel = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.en   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.isel = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.chg  = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // charger26_map
 // charger26
 
typedef struct
{
    digital_out_t vsel;     
    digital_out_t en;       
    digital_out_t isel;     
    digital_in_t chg;       
} charger26_t;
 
typedef struct
{
    pin_name_t vsel;        
    pin_name_t en;          
    pin_name_t isel;        
    pin_name_t chg;         
} charger26_cfg_t;
 
typedef enum
{
    CHARGER26_OK = 0,
    CHARGER26_ERROR = -1
 
} charger26_return_value_t;
 
void charger26_cfg_setup ( charger26_cfg_t *cfg );
 
err_t charger26_init ( charger26_t *ctx, charger26_cfg_t *cfg );
 
void charger26_default_cfg ( charger26_t *ctx );
 
void charger26_set_vsel ( charger26_t *ctx, uint8_t vout_sel );
 
void charger26_set_isel ( charger26_t *ctx, uint8_t iout_sel );
 
void charger26_enable_output ( charger26_t *ctx, uint8_t output_state );
 
uint8_t charger26_get_chg_state ( charger26_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // CHARGER26_H
 
 // charger26
 
// ------------------------------------------------------------------------ END