ups3.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 UPS3_H
#define UPS3_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 UPS3_DIR_MODE_BACKUP             0x00
#define UPS3_DIR_MODE_CHARGE             0x01
 
 // dir_mode
 
#define UPS3_ENABLE_SHUTDOWN             0x00
#define UPS3_ENABLE_NORMAL_OPERATION     0x01
 
 // enable
 
#define UPS3_GET_ERROR_CMPIN_OK         0x00
#define UPS3_GET_ERROR_CMPIN_EMPTY      0x01
 
 // get_error
 
#define UPS3_GET_CAP_OK_FBV_LOW         0x00
#define UPS3_GET_CAP_OK_FBV_HIGH        0x01
 
 // get_cap_ok
 
#define UPS3_GET_CHRG_CHARGE_MODE       0x00
#define UPS3_GET_CHRG_BACKUP_MODE       0x01
 
 // get_chrg
 
#define UPS3_SUCCESS                      0
#define UPS3_ERROR                       -1
 
 
 // status
 
#define UPS3_MAP_MIKROBUS( cfg, mikrobus )        \
    cfg.err = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.cok = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.dir = MIKROBUS( mikrobus, MIKROBUS_CS );  \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM );  \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ups3_map
 // ups3
 
typedef struct
{
    // Output pins
    
    digital_out_t  dir;      
    digital_out_t  en;       
    // Input pins
    
    digital_in_t  err;       
    digital_in_t  cok;       
    digital_in_t  int_pin;   
} ups3_t;
 
typedef struct
{
    pin_name_t  err;      
    pin_name_t  cok;      
    pin_name_t  dir;      
    pin_name_t  en;       
    pin_name_t  int_pin;  
} ups3_cfg_t;
 
void ups3_cfg_setup ( ups3_cfg_t *cfg );
 
err_t ups3_init ( ups3_t *ctx, ups3_cfg_t *cfg );
 
err_t ups3_default_cfg ( ups3_t *ctx );
 
uint8_t ups3_get_error ( ups3_t *ctx );
 
uint8_t ups3_get_cap_ok ( ups3_t *ctx );
 
uint8_t ups3_get_chrg ( ups3_t *ctx );
 
err_t ups3_select_dir_mode ( ups3_t *ctx, uint8_t dir_mode );
 
err_t ups3_set_enable ( ups3_t *ctx, uint8_t enable );
 
err_t ups3_hw_reset ( ups3_t *ctx ) ;
 
#ifdef __cplusplus
}
#endif
#endif // UPS3_H
 
 // ups3
 
// ------------------------------------------------------------------------ END