eeprom8.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 EEPROM8_H
#define EEPROM8_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 EEPROM8_WRITE_ENABLE        0
#define EEPROM8_WRITE_PROTECT       1
#define EEPROM8_BLOCK_ADDR_START    0x0000
#define EEPROM8_BLOCK_ADDR_END      0xFFFFul
 
#define EEPROM8_NBYTES_MIN          1
#define EEPROM8_NBYTES_PAGE         128
#define EEPROM8_SET_DEV_ADDR        0x50
 
 // eeprom8_set
 
#define EEPROM8_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM ); 
 
 
 // eeprom8_map
 // eeprom8
 
typedef enum
{
    EEPROM_I2C_ADDR_SEL_0 = 0,
    EEPROM_I2C_ADDR_SEL_1,
    EEPROM_I2C_ADDR_SEL_2,
    EEPROM_I2C_ADDR_SEL_3,
    EEPROM_I2C_ADDR_SEL_4,
    EEPROM_I2C_ADDR_SEL_5,
    EEPROM_I2C_ADDR_SEL_6,
    EEPROM_I2C_ADDR_SEL_7
 
} eeprom_i2c_address_selector_t;
 
typedef struct
{
    // Output pins
    digital_out_t  wp;          
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} eeprom8_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  wp;             
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} eeprom8_cfg_t;
 
typedef enum
{
    EEPROM8_OK = 0,
    EEPROM8_ERROR = -1
 
} eeprom8_return_value_t;
 
void eeprom8_cfg_setup ( eeprom8_cfg_t *cfg );
 
err_t eeprom8_init ( eeprom8_t *ctx, eeprom8_cfg_t *cfg );
 
 
err_t eeprom8_write_byte( eeprom8_t *ctx, uint16_t reg_addr, uint8_t data_in );
 
err_t eeprom8_write_page( eeprom8_t *ctx, uint16_t reg_addr, uint8_t *data_in );
 
err_t eeprom8_read_random_byte( eeprom8_t *ctx, uint16_t reg_addr, uint8_t *data_out );
 
err_t eeprom8_read_current_byte( eeprom8_t *ctx, uint8_t *data_out );
 
err_t eeprom8_read_sequential( eeprom8_t *ctx, uint16_t reg_addr, uint16_t n_bytes, uint8_t *data_out );
 
void eeprom8_write_enable( eeprom8_t *ctx );
 
void eeprom8_write_protect( eeprom8_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EEPROM8_H
 
 // eeprom8
 
// ------------------------------------------------------------------------ END