expand.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 EXPAND_H
#define EXPAND_H
 
#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"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define EXPAND_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 ); \
   cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define EXPAND_RETVAL  uint8_t
 
#define EXPAND_OK           0x00
#define EXPAND_INIT_ERROR   0xFF
#define EXPAND_SPI_DEVICE_OPCODE                                  0x40
#define EXPAND_OPCODE_WRITE                                       0xFE
#define EXPAND_OPCODE_READ                                        0x01
#define EXPAND_SPI_MODULE_POSITION_0                              0x00
#define EXPAND_SPI_MODULE_POSITION_1                              0x02
#define EXPAND_SPI_MODULE_POSITION_2                              0x04
#define EXPAND_SPI_MODULE_POSITION_3                              0x06
#define EXPAND_SPI_MODULE_POSITION_4                              0x08
#define EXPAND_SPI_MODULE_POSITION_5                              0x0A
#define EXPAND_SPI_MODULE_POSITION_6                              0x0C
#define EXPAND_SPI_MODULE_POSITION_7                              0x0E
#define EXPAND_PORT_DIRECTION_OUTPUT                              0x00
#define EXPAND_PORT_DIRECTION_INPUT                               0xFF
#define EXPAND_IODIRA_BANK1                                       0x00
#define EXPAND_IPOLA_BANK1                                        0x01
#define EXPAND_GPINTENA_BANK1                                     0x02
#define EXPAND_DEFVALA_BANK1                                      0x03
#define EXPAND_INTCONA_BANK1                                      0x04
#define EXPAND_IOCON_BANK1                                        0x05
#define EXPAND_GPPUA_BANK1                                        0x06
#define EXPAND_INTFA_BANK1                                        0x07
#define EXPAND_INTCAPA_BANK1                                      0x08
#define EXPAND_GPIOA_BANK1                                        0x09
#define EXPAND_OLATA_BANK1                                        0x0A
#define EXPAND_IODIRB_BANK1                                       0x10
#define EXPAND_IPOLB_BANK1                                        0x11
#define EXPAND_GPINTENB_BANK1                                     0x12
#define EXPAND_DEFVALB_BANK1                                      0x13
#define EXPAND_INTCONB_BANK1                                      0x14
#define EXPAND_IOCONO_BANK1                                       0x15
#define EXPAND_GPPUB_BANK1                                        0x16
#define EXPAND_INTFB_BANK1                                        0x17
#define EXPAND_INTCAPB_BANK1                                      0x18
#define EXPAND_GPIOB_BANK1                                        0x19
#define EXPAND_OLATB_BANK1                                        0x1A
#define EXPAND_IODIRA_BANK0                                       0x00
#define EXPAND_IODIRB_BANK0                                       0x01
#define EXPAND_IPOLA_BANK0                                        0x02
#define EXPAND_IPOLB_BANK0                                        0x03
#define EXPAND_GPINTENA_BANK0                                     0x04
#define EXPAND_GPINTENB_BANK0                                     0x05
#define EXPAND_DEFVALA_BANK0                                      0x06
#define EXPAND_DEFVALB_BANK0                                      0x07
#define EXPAND_INTCONA_BANK0                                      0x08
#define EXPAND_INTCONB_BANK0                                      0x09
#define EXPAND_IOCON_BANK0                                        0x0A
#define EXPAND_GPPUA_BANK0                                        0x0C
#define EXPAND_GPPUB_BANK0                                        0x0D
#define EXPAND_INTFA_BANK0                                        0x0E
#define EXPAND_INTFB_BANK0                                        0x0F
#define EXPAND_INTCAPA_BANK0                                      0x10
#define EXPAND_INTCAPB_BANK0                                      0x11
#define EXPAND_GPIOA_BANK0                                        0x12
#define EXPAND_GPIOB_BANK0                                        0x13
#define EXPAND_OLATA_BANK0                                        0x14
#define EXPAND_OLATB_BANK0                                        0x15
#define EXPAND_IOCON_BYTE_MODE                                    0x20
#define EXPAND_IOCON_HAEN                                         0x08
 
#define EXPAND_CN4_PA0                                            0x01
#define EXPAND_CN4_PA1                                            0x02
#define EXPAND_CN4_PA2                                            0x04
#define EXPAND_CN4_PA3                                            0x08
#define EXPAND_CN4_PA4                                            0x10
#define EXPAND_CN4_PA5                                            0x20
#define EXPAND_CN4_PA6                                            0x40
#define EXPAND_CN4_PA7                                            0x80
 
#define EXPAND_CN5_PB0                                            0x01
#define EXPAND_CN5_PB1                                            0x02
#define EXPAND_CN5_PB2                                            0x04
#define EXPAND_CN5_PB3                                            0x08
#define EXPAND_CN5_PB4                                            0x10
#define EXPAND_CN5_PB5                                            0x20
#define EXPAND_CN5_PB6                                            0x40
#define EXPAND_CN5_PB7                                            0x80
 
#define EXPAND_CN_START_POSITION                                  0x01
 
#define EXPAND_INT_ERR                                            0xFF
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t cs;
    digital_out_t rst;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} expand_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} expand_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void expand_cfg_setup ( expand_cfg_t *cfg );
 
EXPAND_RETVAL expand_init ( expand_t *ctx, expand_cfg_t *cfg );
 
uint8_t expand_read_byte ( expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr );
void expand_write_byte ( expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t write_data );
 
void expand_default_configuration ( expand_t *ctx, uint8_t mod_cmd );
 
void expand_set_bits ( expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t bit_mask );
 
void expand_clear_bits ( expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t bit_mask );
 
void expand_toggle_bits ( expand_t *ctx, uint8_t mod_cmd, uint8_t reg_addr, uint8_t bit_mask );
 
uint8_t expand_read_port_a ( expand_t *ctx, uint8_t mod_cmd );
 
uint8_t expand_read_port_b ( expand_t *ctx, uint8_t mod_cmd );
 
uint16_t expand_read_both_porta ( expand_t *ctx, uint8_t mod_cmd );
 
void expand_write_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
 
void expand_clear_bit_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
 
void expand_set_bit_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
 
void expand_toggle_bit_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
 
void expand_write_port_b( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
 
void expand_clear_bit_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
 
void expand_set_bit_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
 
void expand_toggle_bit_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
 
void expand_set_direction_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
 
void expand_set_input_dir_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
 
void expand_set_output_dir_port_a ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
 
void expand_set_direction_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
 
void expand_set_input_dir_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
 
void expand_set_output_dir_port_b( expand_t *ctx, uint8_t mod_cmd, uint8_t bit_mask );
 
void expand_set_pull_ups_port_a( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
 
void expand_set_pull_ups_port_b ( expand_t *ctx, uint8_t mod_cmd, uint8_t write_data );
 
void expand_set_potr_a( expand_t *ctx, uint8_t position );
 
void expand_set_potr_b ( expand_t *ctx, uint8_t position );
 
void expand_reset ( expand_t *ctx );
 
uint8_t expand_get_interrupt( expand_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _EXPAND_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END