hbridge15.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 HBRIDGE15_H
#define HBRIDGE15_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"
 
#define HBRIDGE15_REG_INPUT_PORT                        0x00
#define HBRIDGE15_REG_OUTPUT_PORT                       0x01
#define HBRIDGE15_REG_POLARITY_INVERSION                0x02
#define HBRIDGE15_REG_CONFIGURATION                     0x03
 
 // hbridge15_reg
 
#define HBRIDGE15_PIN_MASK_NONE                         0x00
#define HBRIDGE15_PIN_MASK_SLP                          0x01
#define HBRIDGE15_PIN_MASK_FLT                          0x02
#define HBRIDGE15_PIN_MASK_CONFIG                       0x04
#define HBRIDGE15_PIN_MASK_M1                           0x08
#define HBRIDGE15_PIN_MASK_M0                           0x10
#define HBRIDGE15_PIN_MASK_DIR                          0x20
#define HBRIDGE15_PIN_MASK_EN_B                         0x40
#define HBRIDGE15_PIN_MASK_EN_A                         0x80
#define HBRIDGE15_PIN_MASK_ALL                          0xFF
 
#define HBRIDGE15_PIN_STATE_HIGH                        0x01
#define HBRIDGE15_PIN_STATE_LOW                         0x00
 
#define HBRIDGE15_SLEEP_STATE_ON                        0x01
#define HBRIDGE15_SLEEP_STATE_OFF                       0x00
 
#define HBRIDGE15_DRIVE_MOTOR_REVERSE                   0x00
#define HBRIDGE15_DRIVE_MOTOR_FORWARD                   0x01
#define HBRIDGE15_DRIVE_MOTOR_FREEWHEEL                 0x02
#define HBRIDGE15_DRIVE_MOTOR_BRAKE                     0x03
 
#define HBRIDGE15_DEVICE_ADDRESS_00                     0x70
#define HBRIDGE15_DEVICE_ADDRESS_01                     0x71
#define HBRIDGE15_DEVICE_ADDRESS_10                     0x72
#define HBRIDGE15_DEVICE_ADDRESS_11                     0x73
 
 // hbridge15_set
 
#define HBRIDGE15_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.ena = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // hbridge15_map
 // hbridge15
 
typedef struct
{
    // Output pins
    digital_out_t ena;      
    digital_out_t rst;      
    // Input pins
    digital_in_t int_pin;   
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
} hbridge15_t;
 
typedef struct
{
    pin_name_t scl;         
    pin_name_t sda;         
    pin_name_t ena;         
    pin_name_t rst;         
    pin_name_t int_pin;     
    uint32_t   i2c_speed;   
    uint8_t    i2c_address; 
} hbridge15_cfg_t;
 
typedef enum
{
    HBRIDGE15_OK = 0,
    HBRIDGE15_ERROR = -1
 
} hbridge15_return_value_t;
 
void hbridge15_cfg_setup ( hbridge15_cfg_t *cfg );
 
err_t hbridge15_init ( hbridge15_t *ctx, hbridge15_cfg_t *cfg );
 
err_t hbridge15_default_cfg ( hbridge15_t *ctx );
 
err_t hbridge15_generic_write ( hbridge15_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t hbridge15_generic_read ( hbridge15_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void hbridge15_set_rst_pin ( hbridge15_t *ctx, uint8_t pin_state );
 
void hbridge15_set_ena_pin ( hbridge15_t *ctx, uint8_t pin_state );
 
uint8_t hbridge15_get_int_state ( hbridge15_t *ctx );
 
void hbridge15_reset_port_exp ( hbridge15_t *ctx );
 
err_t hbridge15_write_reg ( hbridge15_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t hbridge15_read_reg ( hbridge15_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t hbridge15_set_pins ( hbridge15_t *ctx, uint8_t set_mask, uint8_t clr_mask );
 
err_t hbridge15_set_sleep ( hbridge15_t *ctx, uint8_t sleep_state );
 
err_t hbridge15_set_out_state ( hbridge15_t *ctx, uint8_t out_state );
 
#ifdef __cplusplus
}
#endif
#endif // HBRIDGE15_H
 
 // hbridge15
 
// ------------------------------------------------------------------------ END