expand11.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 EXPAND11_H
#define EXPAND11_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 EXPAND11_REG_INPUT_PORT             0x00
#define EXPAND11_REG_OUTPUT_PORT            0x01
#define EXPAND11_REG_POLARITY_INV           0x02
#define EXPAND11_REG_CONFIG                 0x03
#define EXPAND11_REG_SPECIAL_FUNC           0x50
 
 // expand11_reg
 
#define EXPAND11_NO_PIN_MASK                0x00
#define EXPAND11_PIN_0_MASK                 0x01
#define EXPAND11_PIN_1_MASK                 0x02
#define EXPAND11_PIN_2_MASK                 0x04
#define EXPAND11_PIN_3_MASK                 0x08
#define EXPAND11_ALL_PINS_MASK              0x0F
 
#define EXPAND11_OUTPUT_DIRECTION           0x00
#define EXPAND11_INPUT_DIRECTION            0x01
 
#define EXPAND11_POLARITY_NO_INV            0x00
#define EXPAND11_POLARITY_INV               0x01
 
#define EXPAND11_SPECIAL_FUNC_P3_AS_INT     0x80
#define EXPAND11_SPECIAL_FUNC_PU_DISABLED   0x40
 
#define EXPAND11_P3_AS_P3                   0x00
#define EXPAND11_P3_AS_INT                  0x01
 
#define EXPAND11_DEVICE_ADDRESS             0x41
 
 // expand11_set
 
#define EXPAND11_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define EXPAND11_MAP_MIKROBUS( cfg, mikrobus ) \ …
 
 // expand11_map
 // expand11
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;       
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} expand11_t;
typedef struct {…};
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t int_pin;         
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} expand11_cfg_t;
typedef struct {…};
 
typedef enum
{
    EXPAND11_OK = 0,
    EXPAND11_ERROR = -1
 
} expand11_return_value_t;
typedef enum {…};
 
void expand11_cfg_setup ( expand11_cfg_t *cfg );
 
err_t expand11_init ( expand11_t *ctx, expand11_cfg_t *cfg );
 
err_t expand11_default_cfg ( expand11_t *ctx );
 
err_t expand11_write_register ( expand11_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t expand11_read_register ( expand11_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t expand11_set_pin_direction ( expand11_t *ctx, uint8_t direction, uint8_t pin_mask );
 
err_t expand11_set_all_pins_direction ( expand11_t *ctx, uint8_t direction );
 
err_t expand11_set_pin_polarity ( expand11_t *ctx, uint8_t polarity, uint8_t pin_mask );
 
err_t expand11_set_all_pins_polarity ( expand11_t *ctx, uint8_t polarity );
 
err_t expand11_set_pin_value ( expand11_t *ctx, uint8_t clr_mask, uint8_t set_mask );
 
err_t expand11_set_all_pins_value ( expand11_t *ctx, uint8_t set_mask );
 
err_t expand11_read_port_value ( expand11_t *ctx, uint8_t *data_out );
 
err_t expand11_set_p3_function ( expand11_t *ctx, uint8_t p3_func );
 
err_t expand11_disable_pull_up ( expand11_t *ctx );
 
err_t expand11_enable_pull_up ( expand11_t *ctx );
 
uint8_t expand11_get_int_pin ( expand11_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EXPAND11_H
 
 // expand11
 
// ------------------------------------------------------------------------ END