currentlimit6.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 CURRENTLIMIT6_H
#define CURRENTLIMIT6_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"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
#define CURRENTLIMIT6_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define CURRENTLIMIT6_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // currentlimit6_set
 
#define CURRENTLIMIT6_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.er2 = MIKROBUS( mikrobus, MIKROBUS_AN );    \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM );    \
    cfg.er1 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // currentlimit6_map
 // currentlimit6
 
typedef struct
{
    // Output pins
    digital_out_t  en;          
    // Input pins
    digital_in_t  er2;          
    digital_in_t  er1;          
    // Modules
    spi_master_t  spi;          
    pin_name_t  chip_select;    
} currentlimit6_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;    
    pin_name_t  mosi;    
    pin_name_t  sck;     
    pin_name_t  cs;      
    // Additional gpio pins
    pin_name_t  er2;     
    pin_name_t  en;      
    pin_name_t  er1;     
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} currentlimit6_cfg_t;
 
typedef enum
{
    CURRENTLIMIT6_OK = 0,
    CURRENTLIMIT6_ERROR = -1
 
} currentlimit6_return_value_t;
 
typedef enum
{
    CURRENTLIMIT6_PWR_OFF = 0,
    CURRENTLIMIT6_PWR_ON  = 1
 
} currentlimit6_pwr_mode_value_t;
 
void currentlimit6_cfg_setup ( currentlimit6_cfg_t *cfg );
 
err_t currentlimit6_init ( currentlimit6_t *ctx, currentlimit6_cfg_t *cfg );
 
err_t currentlimit6_default_cfg ( currentlimit6_t *ctx );
 
err_t currentlimit6_power_mode ( currentlimit6_t *ctx, currentlimit6_pwr_mode_value_t pwr_mode );
 
err_t currentlimit6_generic_write ( currentlimit6_t *ctx, uint8_t data_in );
 
err_t currentlimit6_set_current_limit ( currentlimit6_t *ctx, float current_limit );
 
uint8_t currentlimit6_check_limit_exceeded ( currentlimit6_t *ctx );
 
uint8_t currentlimit6_check_voltage_err ( currentlimit6_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // CURRENTLIMIT6_H
 
 // currentlimit6
 
// ------------------------------------------------------------------------ END