eeram3v3.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 EERAM3V3_H
#define EERAM3V3_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 EERAM3V3_ADDRESS_SRAM       0x50
#define EERAM3V3_ADDRESS_CONTROL    0x18
#define EERAM3V3_CMD_STORE          0x33
#define EERAM3V3_CMD_RECALL         0xDD
 
 // eeram3v3_const
 
#define EERAM3V3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.hs = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // eeram3v3_map
 // eeram3v3
 
typedef struct
{
 
    digital_out_t  hs;            
    // Modules
    
    i2c_master_t i2c;             
    // I2C slave address
    
    uint8_t slave_address;        
} eeram3v3_t;
 
typedef struct
{
    pin_name_t  scl;              
    pin_name_t  sda;              
    pin_name_t  hs;               
    uint32_t  i2c_speed;          
    uint8_t   i2c_address;        
} eeram3v3_cfg_t;
 
typedef enum
{
   EERAM3V3_OK = 0,
   EERAM3V3_ERROR = -1
 
} eeram3v3_return_value_t;
 
void eeram3v3_cfg_setup ( eeram3v3_cfg_t *cfg );
 
err_t eeram3v3_init ( eeram3v3_t *ctx, eeram3v3_cfg_t *cfg );
 
void eeram3v3_generic_write ( eeram3v3_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
void eeram3v3_generic_read ( eeram3v3_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void eeram3v3_status_write ( eeram3v3_t *ctx, uint8_t command );
 
uint8_t eeram3v3_status_read ( eeram3v3_t *ctx );
 
void eeram3v3_read ( eeram3v3_t *ctx, uint16_t address, uint8_t *data_out, uint8_t count_out );
 
 void eeram3v3_write ( eeram3v3_t *ctx, uint16_t address, uint8_t * data_in, uint8_t count_in );
 
#ifdef __cplusplus
}
#endif
#endif // EERAM3V3_H
 
 // eeram3v3
 
// ------------------------------------------------------------------------ END