brushless22.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 BRUSHLESS22_H
#define BRUSHLESS22_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_i2c_master.h"
#include "drv_pwm.h"
 
#define BRUSHLESS22_DIGIPOT_MAX_VALUE       100000ul
#define BRUSHLESS22_DIGIPOT_RESOLUTION      257
#define BRUSHLESS22_ROUND_TO_NEAREST_INT    0.5
#define BRUSHLESS22_SLEW_RATE_RES_MAX       47000
#define BRUSHLESS22_SLEW_RATE_RES_DEFAULT   10000
#define BRUSHLESS22_SLEW_RATE_RES_MIN       4700
#define BRUSHLESS22_RPROG_3900              3900
#define BRUSHLESS22_RPROG_24000             24000
#define BRUSHLESS22_RPROG_ADDRESS           0x10
 
#define BRUSHLESS22_ADDR_A2A1A0_000         0x28
#define BRUSHLESS22_ADDR_A2A1A0_001         0x29
#define BRUSHLESS22_ADDR_A2A1A0_010         0x2A
#define BRUSHLESS22_ADDR_A2A1A0_011         0x2B
#define BRUSHLESS22_ADDR_A2A1A0_100         0x2C
#define BRUSHLESS22_ADDR_A2A1A0_101         0x2D
#define BRUSHLESS22_ADDR_A2A1A0_110         0x2E
#define BRUSHLESS22_ADDR_A2A1A0_111         0x2F
 
#define BRUSHLESS22_DIR_FORWARD             0
#define BRUSHLESS22_DIR_REVERSE             1
 
#define BRUSHLESS22_DEF_FREQ                50000
 
 // brushless22_cfg
 
#define BRUSHLESS22_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rt = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.dir = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.ss = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.fg = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // brushless22_map
 // brushless22
 
typedef struct
{
    // Output pins
    digital_out_t dir;          
    digital_out_t ss;           
    digital_out_t rt;           
    // Input pins
    digital_in_t fg;            
    // Modules
    i2c_master_t i2c;           
    pwm_t pwm;                  
    // ctx variable
    uint8_t slave_address;      
    uint32_t pwm_freq;          
} brushless22_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t pwm;             
    // Additional gpio pins
    pin_name_t dir;             
    pin_name_t ss;              
    pin_name_t fg;              
    pin_name_t rt;              
    // Static variable
    uint32_t i2c_speed;         
    uint8_t  i2c_address;       
    uint32_t dev_pwm_freq;      
} brushless22_cfg_t;
 
typedef enum
{
    BRUSHLESS22_OK = 0,
    BRUSHLESS22_ERROR = -1
 
} brushless22_return_value_t;
 
void brushless22_cfg_setup ( brushless22_cfg_t *cfg );
 
err_t brushless22_init ( brushless22_t *ctx, brushless22_cfg_t *cfg );
 
err_t brushless22_default_cfg ( brushless22_t *ctx );
 
err_t brushless22_set_slew_rate_resistance ( brushless22_t *ctx, uint16_t res_ohm );
 
err_t brushless22_set_rprog ( brushless22_t *ctx, uint16_t res_ohm );
 
err_t brushless22_set_duty_cycle ( brushless22_t *ctx, float duty_cycle );
 
err_t brushless22_pwm_stop ( brushless22_t *ctx );
 
err_t brushless22_pwm_start ( brushless22_t *ctx );
 
void brushless22_set_strong_start ( brushless22_t *ctx );
 
void brushless22_set_soft_start ( brushless22_t *ctx );
 
void brushless22_set_direction ( brushless22_t *ctx, uint8_t dir );
 
void brushless22_switch_direction ( brushless22_t *ctx );
 
void brushless22_set_normal_regulation ( brushless22_t *ctx );
 
void brushless22_set_low_load_regulation ( brushless22_t *ctx );
 
uint8_t brushless22_get_fg_pin ( brushless22_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // BRUSHLESS22_H
 
 // brushless22
 
// ------------------------------------------------------------------------ END