brushless14.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 BRUSHLESS14_H
#define BRUSHLESS14_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 BRUSHLESS14_DAC_REG_CONFIG          0x01
#define BRUSHLESS14_DAC_REG_STATUS_TRIGGER  0x02
#define BRUSHLESS14_DAC_REG_BRDCAST         0x03
#define BRUSHLESS14_DAC_REG_DAC_A_DATA      0x08
#define BRUSHLESS14_DAC_REG_DAC_B_DATA      0x09
#define BRUSHLESS14_DAC_REG_DAC_C_DATA      0x0A
#define BRUSHLESS14_DAC_REG_DAC_D_DATA      0x0B
#define BRUSHLESS14_DAC_REG_DAC_E_DATA      0x0C
#define BRUSHLESS14_DAC_REG_DAC_F_DATA      0x0D
#define BRUSHLESS14_DAC_REG_DAC_G_DATA      0x0E
#define BRUSHLESS14_DAC_REG_DAC_H_DATA      0x0F
 
#define BRUSHLESS14_PE_REG_INPUT_PORT       0x00
#define BRUSHLESS14_PE_REG_OUTPUT_PORT      0x01
#define BRUSHLESS14_PE_REG_POLARITY         0x02
#define BRUSHLESS14_PE_REG_CONFIGURATION    0x03
 
 // brushless14_reg
 
#define BRUSHLESS14_DAC_ID                  0x0500
 
#define BRUSHLESS14_EXPANDER_SLAVE_ADDR     0x73
#define BRUSHLESS14_DAC_SLAVE_ADDR          0x48
 
#define BRUSHLESS14_DEF_FREQ                5000
 
 // brushless14_set
 
#define BRUSHLESS14_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.dir = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // brushless14_map
 // brushless14
 
typedef struct
{
    // Output pins
    digital_out_t  dir;     
    // Input pins
    digital_in_t  int_pin;  
    // Modules
    i2c_master_t i2c;       
    pwm_t pwm;              
    // I2C slave address
    uint8_t slave_address;  
    // ctx variable
    uint32_t pwm_freq;      
} brushless14_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  pwm;        
    pin_name_t  dir;        
    pin_name_t  int_pin;    
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
    uint32_t dev_pwm_freq;  
} brushless14_cfg_t;
 
typedef enum
{
   BRUSHLESS14_OK = 0,
   BRUSHLESS14_ERROR = -1
 
} brushless14_return_value_t;
 
void brushless14_cfg_setup ( brushless14_cfg_t *cfg );
 
err_t brushless14_init ( brushless14_t *ctx, brushless14_cfg_t *cfg );
 
err_t brushless14_default_cfg ( brushless14_t *ctx );
 
err_t brushless14_set_duty_cycle ( brushless14_t *ctx, float duty_cycle );
 
err_t brushless14_pwm_stop ( brushless14_t *ctx );
 
err_t brushless14_pwm_start ( brushless14_t *ctx );
 
err_t brushless14_dac_write ( brushless14_t *ctx, uint8_t reg, uint16_t in_data );
 
err_t brushless14_dac_read ( brushless14_t *ctx, uint8_t reg, uint16_t *out_data );
 
err_t brushless14_set_adj0 ( brushless14_t *ctx, uint16_t m_voltage );
 
err_t brushless14_set_adj1 ( brushless14_t *ctx, uint16_t m_voltage );
 
err_t brushless14_set_adj2 ( brushless14_t *ctx, uint16_t m_voltage );
 
err_t brushless14_set_adj3 ( brushless14_t *ctx, uint16_t m_voltage );
 
err_t brushless14_set_fpwm ( brushless14_t *ctx, uint16_t m_voltage );
 
err_t brushless14_set_la ( brushless14_t *ctx, uint16_t m_voltage );
 
err_t brushless14_port_expander_write ( brushless14_t *ctx, uint8_t reg, uint8_t in_data );
 
err_t brushless14_port_expander_read ( brushless14_t *ctx, uint8_t reg, uint8_t *out_data );
 
err_t brushless14_set_slop ( brushless14_t *ctx, uint8_t state );
 
err_t brushless14_set_rot ( brushless14_t *ctx, uint8_t state );
 
err_t brushless14_set_fst ( brushless14_t *ctx, uint8_t state );
 
err_t brushless14_set_sel_adj ( brushless14_t *ctx, uint8_t state );
 
err_t brushless14_set_lap ( brushless14_t *ctx, uint8_t state );
 
err_t brushless14_get_fg_out ( brushless14_t *ctx, uint8_t *state );
 
err_t brushless14_get_ld_out ( brushless14_t *ctx, uint8_t *state );
 
uint8_t brushless14_get_int ( brushless14_t *ctx );
 
void brushless14_set_dir ( brushless14_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif // BRUSHLESS14_H
 
 // brushless14
 
// ------------------------------------------------------------------------ END