expand3.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 EXPAND3_H
#define EXPAND3_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_one_wire.h"
 
#define EXPAND3_CMD_READ_PIO_REGISTERS      0xF0
#define EXPAND3_CMD_CHANNEL_ACCESS_READ     0xF5
#define EXPAND3_CMD_CHANNEL_ACCESS_WRITE    0x5A
#define EXPAND3_CMD_WRITE_CONDITIONAL       0xCC
#define EXPAND3_CMD_RESET_ACTIVITY_LATCHES  0xC3
 
#define EXPAND3_REG_PIO_LOGIC               0x0088
#define EXPAND3_REG_PIO_OUT_LATCH           0x0089
#define EXPAND3_REG_PIO_ACTIVITY_LATCH      0x008A
#define EXPAND3_REG_CHANNEL_MASK            0x008B
#define EXPAND3_REG_CHANNEL_POLARITY        0x008C
#define EXPAND3_REG_CONTROL                 0x008D
 
 // expand3_cmd
 
#define EXPAND3_STATUS_VCCP                 0x80
#define EXPAND3_CONTROL_PORL                0x08
#define EXPAND3_CONTROL_ROS                 0x04
#define EXPAND3_CONTROL_CT                  0x02
#define EXPAND3_CONTROL_PLS                 0x01
#define EXPAND3_CONTROL_DEFAULT             0x00
#define EXPAND3_MASK_DEFAULT                0x00
#define EXPAND3_POLARITY_DEFAULT            0x00
 
#define EXPAND3_CONFIRMATION_BYTE           0xAA
 
#define EXPAND3_PIN_0                       0x01
#define EXPAND3_PIN_1                       0x02
#define EXPAND3_PIN_2                       0x04
#define EXPAND3_PIN_3                       0x08
#define EXPAND3_PIN_4                       0x10
#define EXPAND3_PIN_5                       0x20
#define EXPAND3_PIN_6                       0x40
#define EXPAND3_PIN_7                       0x80
 
#define EXPAND3_FAMILY_CODE                 0x29
 
#define EXPAND3_ADDRESS_0                   0x00
#define EXPAND3_ADDRESS_ALL                 0xFF
 
 // expand3_set
 
#define EXPAND3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.ow0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.ow1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
 
 // expand3_map
 // expand3
 
typedef enum
{
    EXPAND3_GPIO_OW0,                   
    EXPAND3_GPIO_OW1                    
} expand3_gpio_sel_t;
 
typedef struct
{
    // Output pins
    digital_out_t rst;                  
    // Modules
    one_wire_t ow;                      
    one_wire_rom_address_t rom_addr;    
    uint8_t address;                    
} expand3_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t ow0;                     
    pin_name_t ow1;                     
    // Additional gpio pins
    pin_name_t rst;                     
    expand3_gpio_sel_t gpio_sel;        
} expand3_cfg_t;
 
typedef enum
{
    EXPAND3_OK = 0,
    EXPAND3_ERROR = -1
 
} expand3_return_value_t;
 
void expand3_cfg_setup ( expand3_cfg_t *cfg );
 
void expand3_gpio_selection ( expand3_cfg_t *cfg, expand3_gpio_sel_t gpio_sel );
 
err_t expand3_init ( expand3_t *ctx, expand3_cfg_t *cfg );
 
err_t expand3_default_cfg ( expand3_t *ctx );
 
err_t expand3_check_communication ( expand3_t *ctx );
 
err_t expand3_select_device ( expand3_t *ctx );
 
err_t expand3_read_register ( expand3_t *ctx, uint16_t reg, uint8_t *data_out );
 
err_t expand3_write_register ( expand3_t *ctx, uint16_t reg, uint8_t data_in );
 
err_t expand3_read_state ( expand3_t *ctx, uint8_t *state );
 
err_t expand3_write_state ( expand3_t *ctx, uint8_t state );
 
err_t expand3_reset_activity ( expand3_t *ctx );
 
err_t expand3_write_mask ( expand3_t *ctx, uint8_t mask );
 
err_t expand3_write_polarity ( expand3_t *ctx, uint8_t polarity );
 
err_t expand3_write_control ( expand3_t *ctx, uint8_t control );
 
err_t expand3_read_control ( expand3_t *ctx, uint8_t *control );
 
err_t expand3_read_current_state ( expand3_t *ctx, uint8_t *curr_state );
 
err_t expand3_read_last_state ( expand3_t *ctx, uint8_t *last_state );
 
err_t expand3_read_activity ( expand3_t *ctx, uint8_t *activity );
 
void expand3_set_rst_pin ( expand3_t *ctx, uint8_t state );
 
void expand3_reset_device ( expand3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EXPAND3_H
 
 // expand3
 
// ------------------------------------------------------------------------ END