ipd2017.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 IPD2017_H
#define IPD2017_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 IPD2017_NONE_PIN_MASK           0x00
#define IPD2017_OUT1_PIN_MASK           0x01
#define IPD2017_OUT2_PIN_MASK           0x02
#define IPD2017_OUT3_PIN_MASK           0x04
#define IPD2017_OUT4_PIN_MASK           0x08
#define IPD2017_ALL_PIN_MASK            0x0F
 
#define IPD2017_PIN_STATE_HIGH          0x01
#define IPD2017_PIN_STATE_LOW           0x00
 
 // ipd2017_set
 
#define IPD2017_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.in3 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.in4 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ipd2017_map
 // ipd2017
 
typedef struct
{
    digital_out_t in1;      
    digital_out_t in2;      
    digital_out_t in3;      
    digital_out_t in4;      
    uint8_t state;          
} ipd2017_t;
 
typedef struct
{
    pin_name_t in1;     
    pin_name_t in2;     
    pin_name_t in3;     
    pin_name_t in4;     
} ipd2017_cfg_t;
 
typedef enum
{
    IPD2017_OK = 0,
    IPD2017_ERROR = -1
 
} ipd2017_return_value_t;
 
void ipd2017_cfg_setup ( ipd2017_cfg_t *cfg );
 
err_t ipd2017_init ( ipd2017_t *ctx, ipd2017_cfg_t *cfg );
 
void ipd2017_all_pins_set ( ipd2017_t *ctx );
 
void ipd2017_all_pins_clear ( ipd2017_t *ctx );
 
err_t ipd2017_set_out_level ( ipd2017_t *ctx, uint8_t out_sel, uint8_t state );
 
uint8_t ipd2017_get_out_state ( ipd2017_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // IPD2017_H
 
 // ipd2017
 
// ------------------------------------------------------------------------ END