hbridge10.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 HBRIDGE10_H
#define HBRIDGE10_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"
#include "drv_analog_in.h"
 
#define HBRIDGE10_IN_STATUS_RESET               0x8000
#define HBRIDGE10_IN_OUT_LS1_ON                 0x1000
#define HBRIDGE10_IN_OUT_HS1_ON                 0x0800
#define HBRIDGE10_IN_OUT_LS2_ON                 0x0100
#define HBRIDGE10_IN_OUT_HS2_ON                 0x0080
#define HBRIDGE10_IN_OUT_LS3_ON                 0x0010
#define HBRIDGE10_IN_OUT_HS3_ON                 0x0008
#define HBRIDGE10_IN_OPEN_LOAD_OFF              0x0004
#define HBRIDGE10_IN_SHORT_SD_DELAY_12MS        0x0002
#define HBRIDGE10_IN_SHORT_SD_DELAY_1p5MS       0x0000
#define HBRIDGE10_IN_SOFT_ENABLE                0x0001
 
#define HBRIDGE10_OUT_OVER_TEMP_SD              0xFFFF
#define HBRIDGE10_OUT_OVER_TEMP_WARNING         0x8000
#define HBRIDGE10_OUT_STATUS_LS1_ON             0x1000
#define HBRIDGE10_OUT_STATUS_HS1_ON             0x0800
#define HBRIDGE10_OUT_STATUS_LS2_ON             0x0100
#define HBRIDGE10_OUT_STATUS_HS2_ON             0x0080
#define HBRIDGE10_OUT_STATUS_LS3_ON             0x0010
#define HBRIDGE10_OUT_STATUS_HS3_ON             0x0008
#define HBRIDGE10_OUT_SHORT_CIRCUIT_DETECTED    0x0004
#define HBRIDGE10_OUT_NORMAL_OPERATION          0x0002
#define HBRIDGE10_OUT_VS_UNDER_VOLTAGE          0x0001
 
#define HBRIDGE10_CHANNEL_OUT1                  1
#define HBRIDGE10_CHANNEL_OUT2                  2
#define HBRIDGE10_CHANNEL_OUT3                  3
#define HBRIDGE10_OUT_OFF                       0
#define HBRIDGE10_OUT_HIGH                      1
#define HBRIDGE10_OUT_LOW                       2
#define HBRIDGE10_OUT_MASK                      3u
 
#define HBRIDGE10_ADC_VREF                      3.3
 
#define HBRIDGE10_SET_DATA_SAMPLE_EDGE          SET_SPI_DATA_SAMPLE_EDGE
#define HBRIDGE10_SET_DATA_SAMPLE_MIDDLE        SET_SPI_DATA_SAMPLE_MIDDLE
 
 // hbridge10_set
 
#define HBRIDGE10_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.an   = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.en   = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.flt  = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // hbridge10_map
 // hbridge10
 
typedef struct
{
    // Output pins
    digital_out_t en;           
    // Input pins
    digital_in_t  flt;          
    // Modules
    analog_in_t   adc;          
    spi_master_t  spi;          
    pin_name_t    chip_select;  
    uint16_t      input_data;   
} hbridge10_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  an;                                 
    pin_name_t  en;                                 
    pin_name_t  flt;                                
    // static variable
    uint32_t                           spi_speed;   
    spi_master_mode_t                  spi_mode;    
    spi_master_chip_select_polarity_t  cs_polarity; 
    analog_in_resolution_t  resolution;             
    float                   vref;                   
} hbridge10_cfg_t;
 
typedef enum
{
    HBRIDGE10_OK = 0,
    HBRIDGE10_ERROR = -1
 
} hbridge10_return_value_t;
 
void hbridge10_cfg_setup ( hbridge10_cfg_t *cfg );
 
err_t hbridge10_init ( hbridge10_t *ctx, hbridge10_cfg_t *cfg );
 
err_t hbridge10_default_cfg ( hbridge10_t *ctx );
 
err_t hbridge10_transfer_data ( hbridge10_t *ctx, uint16_t data_in, uint16_t *data_out );
 
err_t hbridge10_set_output_state ( hbridge10_t *ctx, uint8_t channel, uint8_t state );
 
err_t hbridge10_get_status ( hbridge10_t *ctx, uint16_t *status );
 
err_t hbridge10_read_an_pin_value ( hbridge10_t *ctx, uint16_t *data_out );
 
err_t hbridge10_read_an_pin_voltage ( hbridge10_t *ctx, float *data_out );
 
void hbridge10_enable_device ( hbridge10_t *ctx );
 
void hbridge10_disable_device ( hbridge10_t *ctx );
 
uint8_t hbridge10_get_fault_pin ( hbridge10_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // HBRIDGE10_H
 
 // hbridge10
 
// ------------------------------------------------------------------------ END