expand15.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 EXPAND15_H
#define EXPAND15_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 EXPAND15_REG_INPUT_PORT_0               0x00
#define EXPAND15_REG_INPUT_PORT_1               0x01
#define EXPAND15_REG_OUTPUT_PORT_0              0x02
#define EXPAND15_REG_OUTPUT_PORT_1              0x03
#define EXPAND15_REG_POLARITY_INVERSION_0       0x04
#define EXPAND15_REG_POLARITY_INVERSION_1       0x05
#define EXPAND15_REG_CONFIGURATION_0            0x06
#define EXPAND15_REG_CONFIGURATION_1            0x07
#define EXPAND15_REG_OUTPUT_DRV_STRENGTH_0_0    0x40
#define EXPAND15_REG_OUTPUT_DRV_STRENGTH_0_1    0x41
#define EXPAND15_REG_OUTPUT_DRV_STRENGTH_1_0    0x42
#define EXPAND15_REG_OUTPUT_DRV_STRENGTH_1_1    0x43
#define EXPAND15_REG_INPUT_LATCH_0              0x44
#define EXPAND15_REG_INPUT_LATCH_1              0x45
#define EXPAND15_REG_PULL_UP_DOWN_EN_0          0x46
#define EXPAND15_REG_PULL_UP_DOWN_EN_1          0x47
#define EXPAND15_REG_PULL_UP_DOWN_SELECT_0      0x48
#define EXPAND15_REG_PULL_UP_DOWN_SELECT_1      0x49
#define EXPAND15_REG_INTERRUPT_MASK_0           0x4A
#define EXPAND15_REG_INTERRUPT_MASK_1           0x4B
#define EXPAND15_REG_INTERRUPT_STATUS_0         0x4C
#define EXPAND15_REG_INTERRUPT_STATUS_1         0x4D
#define EXPAND15_REG_OUTPUT_PORT_CFG            0x4F
 
 
 // expand15_reg
 
#define EXPAND15_PIN_00_MASK                    0x01
#define EXPAND15_PIN_01_MASK                    0x02
#define EXPAND15_PIN_02_MASK                    0x04
#define EXPAND15_PIN_03_MASK                    0x08
#define EXPAND15_PIN_04_MASK                    0x10
#define EXPAND15_PIN_05_MASK                    0x20
#define EXPAND15_PIN_06_MASK                    0x40
#define EXPAND15_PIN_07_MASK                    0x80
#define EXPAND15_PIN_10_MASK                    0x01
#define EXPAND15_PIN_11_MASK                    0x02
#define EXPAND15_PIN_12_MASK                    0x04
#define EXPAND15_PIN_13_MASK                    0x08
#define EXPAND15_PIN_14_MASK                    0x10
#define EXPAND15_PIN_15_MASK                    0x20
#define EXPAND15_PIN_16_MASK                    0x40
#define EXPAND15_PIN_17_MASK                    0x80
 
#define EXPAND15_PORT_0                         0x00
#define EXPAND15_PORT_1                         0x01
 
#define EXPAND15_OUTPUT_STRENGTH_FULL           0x03
#define EXPAND15_OUTPUT_STRENGTH_3_QUARTERS     0x02
#define EXPAND15_OUTPUT_STRENGTH_HALF           0x01
#define EXPAND15_OUTPUT_STRENGTH_1_QUARTER      0x00
 
#define EXPAND15_PORT_PUSH_PULL                 0x00
#define EXPAND15_PORT_OPEN_DRAIN                0x01
 
#define EXPAND15_ALL_PINS_ON                    0xFF
#define EXPAND15_ALL_PINS_OFF                   0x00
 
#define EXPAND15_DEVICE_ADDRESS_GND             0x20
#define EXPAND15_DEVICE_ADDRESS_VCC             0x21
 
 // expand15_set
 
#define EXPAND15_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // expand15_map
 // expand15
 
typedef struct
{
    // Output pins
    digital_out_t rst;  
    // Input pins
    digital_in_t int_pin;    
    // Modules
    i2c_master_t i2c;                           
    // I2C slave address
    uint8_t slave_address;                      
} expand15_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t rst;             
    pin_name_t int_pin;         
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} expand15_cfg_t;
 
typedef enum
{
    EXPAND15_OK = 0,
    EXPAND15_ERROR = -1
 
} expand15_return_value_t;
 
void expand15_cfg_setup ( expand15_cfg_t *cfg );
 
err_t expand15_init ( expand15_t *ctx, expand15_cfg_t *cfg );
 
err_t expand15_default_cfg ( expand15_t *ctx );
 
err_t expand15_generic_write ( expand15_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t expand15_generic_read ( expand15_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
uint8_t expand15_get_int_pin_state ( expand15_t *ctx );
 
void expand15_hw_reset ( expand15_t *ctx );
 
err_t expand15_get_in_pin_state ( expand15_t *ctx, uint8_t port, uint8_t *pin_state );
 
err_t expand15_get_out_pin_state ( expand15_t *ctx, uint8_t port, uint8_t *pin_state );
 
err_t expand15_set_out_pin_state ( expand15_t *ctx, uint8_t port, uint8_t pin_state );
 
err_t expand15_get_in_pin_polarity ( expand15_t *ctx, uint8_t port, uint8_t *pin_polarity );
 
err_t expand15_set_in_pin_polarity ( expand15_t *ctx, uint8_t port, uint8_t pin_polarity );
 
err_t expand15_get_pin_config ( expand15_t *ctx, uint8_t port, uint8_t *pin_config );
 
err_t expand15_set_pin_as_in ( expand15_t *ctx, uint8_t port, uint8_t pin_config );
 
err_t expand15_set_pin_as_out ( expand15_t *ctx, uint8_t port, uint8_t pin_config );
 
err_t expand15_get_out_level ( expand15_t *ctx, uint8_t port, uint16_t *pin_output_level );
 
err_t expand15_set_out_level ( expand15_t *ctx, uint8_t port, uint16_t pin_output_level );
 
err_t expand15_set_out_pin_strength( expand15_t *ctx, uint8_t port, uint8_t pin, uint8_t strength );
 
err_t expand15_set_en_pull_up_down ( expand15_t *ctx, uint8_t port, uint8_t port_config );
 
err_t expand15_get_en_pull_up_down ( expand15_t *ctx, uint8_t port, uint8_t *port_config );
 
err_t expand15_set_pull_up_down ( expand15_t *ctx, uint8_t port, uint8_t pin_config );
 
err_t expand15_get_pull_up_down ( expand15_t *ctx, uint8_t port, uint8_t *pin_config );
 
err_t expand15_set_int_mask ( expand15_t *ctx, uint8_t port, uint8_t int_config );
 
err_t expand15_get_int_mask ( expand15_t *ctx, uint8_t port, uint8_t *int_config );
 
err_t expand15_get_int_status ( expand15_t *ctx, uint8_t port, uint8_t *int_status );
 
err_t expand15_get_out_port_config ( expand15_t *ctx, uint8_t *port0_cfg, uint8_t *port1_cfg );
 
err_t expand15_set_out_port_config ( expand15_t *ctx, uint8_t port0_cfg, uint8_t port1_cfg );
 
#ifdef __cplusplus
}
#endif
#endif // EXPAND15_H
 
 // expand15
 
// ------------------------------------------------------------------------ END