hbridgedriver.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 HBRIDGEDRIVER_H
#define HBRIDGEDRIVER_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"
 
#define HBRIDGEDRIVER_PROP_DIS          0x00
#define HBRIDGEDRIVER_PROP_EN           0x01
 
 // hbridgedriver_set
 
#define HBRIDGEDRIVER_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.il2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.ih2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.gen = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.il1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.ih1 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // hbridgedriver_map
 // hbridgedriver
 
typedef struct
{
    digital_out_t  il2;         
    digital_out_t  ih2;         
    digital_out_t  gen;         
    digital_out_t  il1;         
    digital_out_t  ih1;         
} hbridgedriver_t;
 
typedef struct
{
    pin_name_t  il2;        
    pin_name_t  ih2;        
    pin_name_t  gen;        
    pin_name_t  il1;        
    pin_name_t  ih1;        
} hbridgedriver_cfg_t;
 
typedef enum
{
    HBRIDGEDRIVER_OK = 0,
    HBRIDGEDRIVER_ERROR = -1
 
} hbridgedriver_return_value_t;
 
void hbridgedriver_cfg_setup ( hbridgedriver_cfg_t *cfg );
 
err_t hbridgedriver_init ( hbridgedriver_t *ctx, hbridgedriver_cfg_t *cfg );
 
void hbridgedriver_glo_enable ( hbridgedriver_t *ctx, uint8_t state );
 
void hbridgedriver_in_ls_2 ( hbridgedriver_t *ctx, uint8_t state );
 
void hbridgedriver_in_hs_2 ( hbridgedriver_t *ctx, uint8_t state );
 
void hbridgedriver_in_ls_1 ( hbridgedriver_t *ctx, uint8_t state );
 
void hbridgedriver_in_hs_1 ( hbridgedriver_t *ctx, uint8_t state );
 
void hbridgedriver_dc_fwd_1 ( hbridgedriver_t *ctx );
 
void hbridgedriver_dc_bwd_1 ( hbridgedriver_t *ctx );
 
void hbridgedriver_dc_coast_1 ( hbridgedriver_t *ctx );
 
void hbridgedriver_dc_brake_1 ( hbridgedriver_t *ctx );
 
void hbridgedriver_dc_fwd_2 ( hbridgedriver_t *ctx );
 
void hbridgedriver_dc_bwd_2 ( hbridgedriver_t *ctx );
 
void hbridgedriver_dc_coast_2 ( hbridgedriver_t *ctx );
 
void hbridgedriver_dc_brake_2 ( hbridgedriver_t *ctx );
 
void hbridgedriver_reverse ( hbridgedriver_t *ctx );
 
void hbridgedriver_forward ( hbridgedriver_t *ctx );
 
void hbridgedriver_braking ( hbridgedriver_t *ctx );
 
void hbridgedriver_coasting ( hbridgedriver_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // HBRIDGEDRIVER_H
 
 // hbridgedriver
 
// ------------------------------------------------------------------------ END