expand8.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 EXPAND8_H
#define EXPAND8_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_spi_master.h"
#include "spi_specifics.h"
 
#define EXPAND8_ADDR_OUT_LVL_PORT_P0                               0x00
#define EXPAND8_ADDR_OUT_LVL_PORT_P1                               0x01
#define EXPAND8_ADDR_OUT_LVL_PORT_P2                               0x02
#define EXPAND8_ADDR_OUT_LVL_PORT_P3                               0x03
#define EXPAND8_ADDR_OUT_LVL_PORT_P4                               0x04
#define EXPAND8_ADDR_OUT_LVL_PORT_P5                               0x05
#define EXPAND8_ADDR_OUT_LVL_PORT_P6                               0x06
#define EXPAND8_ADDR_OUT_LVL_PORT_P7                               0x07
#define EXPAND8_ADDR_OUT_LVL_PORT_P8                               0x08
#define EXPAND8_ADDR_OUT_LVL_PORT_P9                               0x09
#define EXPAND8_ADDR_OUT_LVL_PORT_P0_THROUGH_P9                    0x0A
#define EXPAND8_ADDR_OUT_LVL_PORT_P0_THROUGH_P3                    0x0B
#define EXPAND8_ADDR_OUT_LVL_PORT_P4_THROUGH_P7                    0x0C
#define EXPAND8_ADDR_OUT_LVL_PORT_P8_THROUGH_P9                    0x0D
#define EXPAND8_ADDR_OUT_LVL_PORT_P7_THROUGH_P0                    0x0E
#define EXPAND8_ADDR_OUT_LVL_PORT_P9_THROUGH_P8                    0x0F
#define EXPAND8_ADDR_RAM                                           0x13
#define EXPAND8_ADDR_NOP                                           0x20
 
#define EXPAND8_SET_LOW_IMPEDANCE                                  0x00
#define EXPAND8_SET_HIGH_IMPEDANCE                                 0xFF
 
#define EXPAND8_CMD_WRITE                                          0x00
#define EXPAND8_CMD_READ                                           0x80
 
#define EXPAND8_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define EXPAND8_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // expand8_set
 
#define EXPAND8_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS )
 
 // expand8_map
 // expand8
 
typedef struct
{
    // Modules
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
} expand8_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;                  
    pin_name_t  mosi;                  
    pin_name_t  sck;                   
    pin_name_t  cs;                    
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} expand8_cfg_t;
 
typedef enum
{
   EXPAND8_OK = 0,
   EXPAND8_ERROR = -1
 
} expand8_return_value_t;
 
void expand8_cfg_setup ( expand8_cfg_t *cfg );
 
err_t expand8_init ( expand8_t *ctx, expand8_cfg_t *cfg );
 
err_t expand8_generic_write ( expand8_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t expand8_generic_read ( expand8_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
 
void expand8_write_data ( expand8_t *ctx, uint8_t addr, uint8_t tx_data );
 
uint8_t expand8_read_data ( expand8_t *ctx, uint8_t addr );
 
err_t expand8_set_port ( expand8_t *ctx, uint8_t sel_port, uint8_t sel_imped );
 
#ifdef __cplusplus
}
#endif
#endif // EXPAND8_H
 
 // expand8
 
// ------------------------------------------------------------------------ END