hbridge3.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 HBRIDGE3_H
#define HBRIDGE3_H
 
#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_pwm.h"
#include "drv_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define HBRIDGE3_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.dis = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.cs  = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.sdo = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
  cfg.sdi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ) 
#define HBRIDGE3_RETVAL  uint8_t
 
#define HBRIDGE3_OK                   0x00
#define HBRIDGE3_INIT_ERROR           0xFF
#define HBRIDGE3_DEF_FREQ             20000
#define HBRIDGE3_CMD_RD_DIA           0x00
#define HBRIDGE3_CMD_RES_DIA          0x80
#define HBRIDGE3_CMD_RD_REV           0x20
#define HBRIDGE3_CMD_RD_CTRL          0x60
#define HBRIDGE3_CMD_WR_CTRL          0xE0
#define HBRIDGE3_CMD_WR_CTRL_RD_DIA   0xC0
#define HBRIDGE3_CTRL_VIA_PWM_DIR     0x00
#define HBRIDGE3_CTRL_VIA_SPI         0x80
#define HBRIDGE3_SPI_ENA_OUT          0x40
#define HBRIDGE3_SPI_DIS_OUT          0x00
#define HBRIDGE3_SPI_DIR_1            0x00
#define HBRIDGE3_SPI_DIR_2            0x20
#define HBRIDGE3_SPI_PWM_0            0x00
#define HBRIDGE3_SPI_PWM_1            0x01
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{ 
    // Output pins 
 
    digital_out_t dir;
    digital_out_t dis;
    digital_out_t cs;
 
    
    // Modules 
    spi_master_t spi;
    pin_name_t chip_select;
    pwm_t pwm;
 
    // ctx variable 
 
    uint16_t pwm_period;
    uint32_t pwm_freq;
 
} hbridge3_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t pwm;
    pin_name_t sdo;
    pin_name_t sdi;
    pin_name_t sck;
    
    // Additional gpio pins 
 
    pin_name_t dir;
    pin_name_t dis;
    pin_name_t cs;
 
    // static variable 
 
    uint32_t dev_pwm_freq;
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} hbridge3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void hbridge3_cfg_setup ( hbridge3_cfg_t *cfg );
 
HBRIDGE3_RETVAL hbridge3_init ( hbridge3_t *ctx, hbridge3_cfg_t *cfg );
 
void hbridge3_default_cfg ( hbridge3_t *ctx, float duty_cycle );
 
void hbridge3_set_duty_cycle ( hbridge3_t *ctx, float duty_cycle );
 
void hbridge3_pwm_stop ( hbridge3_t *ctx );
 
void hbridge3_pwm_start ( hbridge3_t *ctx );
 
void hbridge3_dir_set ( hbridge3_t *ctx, uint8_t pin_state );
 
void hbridge3_dis_set ( hbridge3_t *ctx, uint8_t pin_state );
 
void hbridge3_cs_set ( hbridge3_t *ctx, uint8_t pin_state );
 
 
uint8_t hbridge3_spi ( hbridge3_t *ctx, uint8_t spi_command );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _HBRIDGE3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END