expand9.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 EXPAND9_H
#define EXPAND9_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 EXPAND9_REG_INPUT_DISABLE_B              0x00
#define EXPAND9_REG_INPUT_DISABLE_A              0x01
#define EXPAND9_REG_LONG_SLEW_B                  0x02
#define EXPAND9_REG_LONG_SLEW_A                  0x03
#define EXPAND9_REG_LOW_DRIVE_B                  0x04
#define EXPAND9_REG_LOW_DRIVE_A                  0x05
#define EXPAND9_REG_PULL_UP_B                    0x06
#define EXPAND9_REG_PULL_UP_A                    0x07
#define EXPAND9_REG_PULL_DOWN_B                  0x08
#define EXPAND9_REG_PULL_DOWN_A                  0x09
#define EXPAND9_REG_OPEN_DRAIN_B                 0x0A
#define EXPAND9_REG_OPEN_DRAIN_A                 0x0B
#define EXPAND9_REG_POLARITY_B                   0x0C
#define EXPAND9_REG_POLARITY_A                   0x0D
#define EXPAND9_REG_DIR_B                        0x0E
#define EXPAND9_REG_DIR_A                        0x0F
#define EXPAND9_REG_DATA_B                       0x10
#define EXPAND9_REG_DATA_A                       0x11
#define EXPAND9_REG_INTERRUPT_MASK_B             0x12
#define EXPAND9_REG_INTERRUPT_MASK_A             0x13
#define EXPAND9_REG_SENSE_HIGH_B                 0x14
#define EXPAND9_REG_SENSE_LOW_B                  0x15
#define EXPAND9_REG_SENSE_HIGH_A                 0x16
#define EXPAND9_REG_SENSE_LOW_A                  0x17
#define EXPAND9_REG_INTERRUPT_SOURCE_B           0x18
#define EXPAND9_REG_INTERRUPT_SOURCE_A           0x19
#define EXPAND9_REG_EVENT_STATUS_B               0x1A
#define EXPAND9_REG_EVENT_STATUS_A               0x1B
#define EXPAND9_REG_LEVEL_SHIFTER_1              0x1C
#define EXPAND9_REG_LEVEL_SHIFTER_2              0x1D
#define EXPAND9_REG_CLOCK                        0x1E
#define EXPAND9_REG_MISC                         0x1F
#define EXPAND9_REG_LED_DRIVER_ENABLE_B          0x20
#define EXPAND9_REG_LED_DRIVER_ENABLE_A          0x21
#define EXPAND9_REG_DEBOUNCE_CONFIG              0x22
#define EXPAND9_REG_DEBOUNCE_ENABLE_B            0x23
#define EXPAND9_REG_DEBOUNCE_ENABLE_A            0x24
#define EXPAND9_REG_KEY_CONFIG_1                 0x25
#define EXPAND9_REG_KEY_CONFIG_2                 0x26
#define EXPAND9_REG_KEY_DATA_1                   0x27
#define EXPAND9_REG_KEY_DATA_2                   0x28
#define EXPAND9_REG_T_ON_0                       0x29
#define EXPAND9_REG_I_ON_0                       0x2A
#define EXPAND9_REG_OFF_0                        0x2B
#define EXPAND9_REG_T_ON_1                       0x2C
#define EXPAND9_REG_I_ON_1                       0x2D
#define EXPAND9_REG_OFF_1                        0x2E
#define EXPAND9_REG_T_ON_2                       0x2F
#define EXPAND9_REG_I_ON_2                       0x30
#define EXPAND9_REG_OFF_2                        0x31
#define EXPAND9_REG_T_ON_3                       0x32
#define EXPAND9_REG_I_ON_3                       0x33
#define EXPAND9_REG_OFF_3                        0x34
#define EXPAND9_REG_T_ON_4                       0x35
#define EXPAND9_REG_I_ON_4                       0x36
#define EXPAND9_REG_OFF_4                        0x37
#define EXPAND9_REG_T_RISE_4                     0x38
#define EXPAND9_REG_T_FALL_4                     0x39
#define EXPAND9_REG_T_ON_5                       0x3A
#define EXPAND9_REG_I_ON_5                       0x3B
#define EXPAND9_REG_OFF_5                        0x3C
#define EXPAND9_REG_T_RISE_5                     0x3D
#define EXPAND9_REG_T_FALL_5                     0x3E
#define EXPAND9_REG_T_ON_6                       0x3F
#define EXPAND9_REG_I_ON_6                       0x40
#define EXPAND9_REG_OFF_6                        0x41
#define EXPAND9_REG_T_RISE_6                     0x42
#define EXPAND9_REG_T_FALL_6                     0x43
#define EXPAND9_REG_T_ON_7                       0x44
#define EXPAND9_REG_I_ON_7                       0x45
#define EXPAND9_REG_OFF_7                        0x46
#define EXPAND9_REG_T_RISE_7                     0x47
#define EXPAND9_REG_T_FALL_7                     0x48
#define EXPAND9_REG_T_ON_8                       0x49
#define EXPAND9_REG_I_ON_8                       0x4A
#define EXPAND9_REG_OFF_8                        0x4B
#define EXPAND9_REG_T_ON_9                       0x4C
#define EXPAND9_REG_I_ON_9                       0x4D
#define EXPAND9_REG_OFF_9                        0x4E
#define EXPAND9_REG_T_ON_10                      0x4F
#define EXPAND9_REG_I_ON_10                      0x50
#define EXPAND9_REG_OFF_10                       0x51
#define EXPAND9_REG_T_ON_11                      0x52
#define EXPAND9_REG_I_ON_11                      0x53
#define EXPAND9_REG_OFF_11                       0x54
#define EXPAND9_REG_T_ON_12                      0x55
#define EXPAND9_REG_I_ON_12                      0x56
#define EXPAND9_REG_OFF_12                       0x57
#define EXPAND9_REG_T_RISE_12                    0x58
#define EXPAND9_REG_T_FALL_12                    0x59
#define EXPAND9_REG_T_ON_13                      0x5A
#define EXPAND9_REG_I_ON_13                      0x5B
#define EXPAND9_REG_OFF_13                       0x5C
#define EXPAND9_REG_T_RISE_13                    0x5D
#define EXPAND9_REG_T_FALL_13                    0x5E
#define EXPAND9_REG_T_ON_14                      0x5F
#define EXPAND9_REG_I_ON_14                      0x60
#define EXPAND9_REG_OFF_14                       0x61
#define EXPAND9_REG_T_RISE_14                    0x62
#define EXPAND9_REG_T_FALL_14                    0x63
#define EXPAND9_REG_T_ON_15                      0x64
#define EXPAND9_REG_I_ON_15                      0x65
#define EXPAND9_REG_OFF_15                       0x66
#define EXPAND9_REG_T_RISE_15                    0x67
#define EXPAND9_REG_T_FALL_15                    0x68
#define EXPAND9_REG_HIGH_INPUT_B                 0x69
#define EXPAND9_REG_HIGH_INPUT_A                 0x6A
#define EXPAND9_REG_RESET                        0x7D
#define EXPAND9_REG_TEST_1                       0x7E
#define EXPAND9_REG_TEST_2                       0x7F
 
 // expand9_reg
 
#define EXPAND9_CHANGE                           0x01
#define EXPAND9_FALLING                          0x02
#define EXPAND9_RISING                           0x03
#define EXPAND9_FREQ_DIV_1                       0x01
#define EXPAND9_FREQ_DIV_2                       0x02
#define EXPAND9_FREQ_DIV_3                       0x03
#define EXPAND9_FREQ_DIV_4                       0x04
#define EXPAND9_FREQ_DIV_5                       0x05
#define EXPAND9_FREQ_DIV_6                       0x06
#define EXPAND9_FREQ_DIV_7                       0x07
#define EXPAND9_LED_MODE_LINEAR                  0x00
#define EXPAND9_LED_MODE_LOGARITHMIC             0x01
 
#define EXPAND9_SET_DEV_ADDR_GND                 0x3E
#define EXPAND9_SET_DEV_ADDR_VCC                 0x70
 
 // expand9_set
 
#define EXPAND9_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.add = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // expand9_map
 // expand9
 
typedef struct
{
    // Output pins
    digital_out_t  add;     
    digital_out_t  rst;     
    // Input pins
    digital_in_t  int_pin;  
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
} expand9_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  add;        
    pin_name_t  rst;        
    pin_name_t  int_pin;    
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} expand9_cfg_t;
 
typedef enum
{
   EXPAND9_OK = 0,
   EXPAND9_ERROR = -1
 
} expand9_return_value_t;
 
typedef enum
{
   DIRECTION_INPUT = 0,
   DIRECTION_OUTPUT =  1
 
} expand9_direction_value_t;
 
typedef enum
{
   CH_OUTPUT_OFF = 0,
   CH_OUTPUT_ON =  1
 
} expand9_ch_state_value_t;
 
void expand9_cfg_setup ( expand9_cfg_t *cfg );
 
err_t expand9_init ( expand9_t *ctx, expand9_cfg_t *cfg );
 
err_t expand9_default_cfg ( expand9_t *ctx );
 
err_t expand9_set_slave_address ( expand9_t *ctx, uint8_t slave_addr );
 
err_t expand9_generic_write ( expand9_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t expand9_generic_read ( expand9_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t expand9_soft_reset ( expand9_t *ctx );
 
err_t expand9_set_ch_direction ( expand9_t *ctx, uint8_t ch_pos, expand9_direction_value_t direction );
 
err_t expand9_set_all_ch_output ( expand9_t *ctx );
 
err_t expand9_set_all_ch_input ( expand9_t *ctx );
 
err_t expand9_set_ch_output_state ( expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t ch_state );
 
err_t expand9_get_ch_output_state ( expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t *ch_state );
 
err_t expand9_write_ch (  expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t ch_state );
 
err_t expand9_read_ch ( expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t *ch_state );
 
err_t expand9_led_driver_config ( expand9_t *ctx, uint8_t ch_pos, uint8_t freq_div, uint8_t lin_log );
 
err_t expand9_set_intensity ( expand9_t *ctx, uint8_t ch_pos, uint8_t intensity );
 
err_t expand9_sync ( expand9_t *ctx );
 
err_t expand9_debounce_config ( expand9_t *ctx, uint8_t config_val );
 
err_t expand9_enable_ch_interrupt ( expand9_t *ctx, uint8_t ch_pos, uint8_t rise_fall );
 
err_t expand9_clear_interrupt ( expand9_t *ctx );
 
err_t expand9_check_ch_interrupt ( expand9_t *ctx, uint8_t ch_pos, expand9_ch_state_value_t *int_state );
 
uint8_t expand9_check_interrupt_pin ( expand9_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EXPAND9_H
 
 // expand9
 
// ------------------------------------------------------------------------ END