currentlimit.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2021 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 CURRENTLIMIT_H
#define CURRENTLIMIT_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 CURRENTLIMIT_ENABLE             1
#define CURRENTLIMIT_DISABLE            0
 
#define CURRENTLIMIT_LSB_VAL            392.2
#define CURRENTLIMIT_R_BASE             1200.0
#define CURRENTLIMIT_I_MAX              1.2
#define CURRENTLIMIT_CALC_COEF          1380.0
 
#define CURRENTLIMIT_CUR_LIM_VAL_0_1    224
#define CURRENTLIMIT_CUR_LIM_VAL_0_2    241
#define CURRENTLIMIT_CUR_LIM_VAL_0_3    247
#define CURRENTLIMIT_CUR_LIM_VAL_0_4    250
#define CURRENTLIMIT_CUR_LIM_VAL_0_5    252
#define CURRENTLIMIT_CUR_LIM_VAL_0_6    253
#define CURRENTLIMIT_CUR_LIM_VAL_0_7    254
#define CURRENTLIMIT_CUR_LIM_VAL_0_867  255
 
#define CURRENTLIMIT_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define CURRENTLIMIT_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // currentlimit_set
 
#define CURRENTLIMIT_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.en = MIKROBUS( mikrobus, MIKROBUS_AN )
 
 // currentlimit_map
 // currentlimit
 
typedef struct
{
    // Output pins
    digital_out_t  en;       
    // Modules
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
} currentlimit_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   en;         
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} currentlimit_cfg_t;
 
typedef enum
{
   CURRENTLIMIT_OK = 0,
   CURRENTLIMIT_ERROR = -1
 
} currentlimit_return_value_t;
 
void currentlimit_cfg_setup ( currentlimit_cfg_t *cfg );
 
err_t currentlimit_init ( currentlimit_t *ctx, currentlimit_cfg_t *cfg );
 
err_t currentlimit_generic_write ( currentlimit_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t currentlimit_generic_read ( currentlimit_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void currentlimit_dev_enable ( currentlimit_t *ctx, uint8_t state );
 
void currentlimit_set_limit ( currentlimit_t *ctx, uint8_t lim_val );
 
void currentlimit_set_limit_calc ( currentlimit_t *ctx, float lim_val );
 
#ifdef __cplusplus
}
#endif
#endif // CURRENTLIMIT_H
 
 // currentlimit
 
// ------------------------------------------------------------------------ END