easypull.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 EASYPULL_H
#define EASYPULL_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 EASYPULL_PIN_STATE_HIGH             0x01
#define EASYPULL_PIN_STATE_LOW              0x00
 
 // easypull_set
 
#define EASYPULL_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // easypull_map
 // easypull
 
typedef struct
{
    digital_in_t an;        
    digital_in_t rst;       
    digital_in_t cs;        
    digital_in_t pwm;       
    digital_in_t int_pin;   
} easypull_t;
 
typedef struct
{
    pin_name_t an;          
    pin_name_t rst;         
    pin_name_t cs;          
    pin_name_t pwm;         
    pin_name_t int_pin;     
} easypull_cfg_t;
 
typedef enum
{
    EASYPULL_OK = 0,
    EASYPULL_ERROR = -1
 
} easypull_return_value_t;
 
void easypull_cfg_setup ( easypull_cfg_t *cfg );
 
err_t easypull_init ( easypull_t *ctx, easypull_cfg_t *cfg );
 
uint8_t easypull_get_an_pin ( easypull_t *ctx );
 
uint8_t easypull_get_rst_pin ( easypull_t *ctx );
 
uint8_t easypull_get_cs_pin ( easypull_t *ctx );
 
uint8_t easypull_get_pwm_pin ( easypull_t *ctx );
 
uint8_t easypull_get_int_pin ( easypull_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EASYPULL_H
 
 // easypull
 
// ------------------------------------------------------------------------ END