eeprom.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 _EEPROM_H_
#define _EEPROM_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_i2c_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS
#define EEPROM_BLOCK_ADDR_START   0x00
#define EEPROM_BLOCK_ADDR_MIDDLE  0x80
#define EEPROM_BLOCK_ADDR_END     0xFF
#define EEPROM_NBYTES_MIN   1
#define EEPROM_NBYTES_PAGE  16
#define EEPROM_NBYTES_MAX   256
#define EEPROM_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.wp  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 //  End macros group
// --------------------------------------------------------------- PUBLIC TYPES
 
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 enum
{
    EEPROM_RETVAL_OK           = 0x00,
    EEPROM_RETVAL_ERR_DRV_INIT = 0xFE,
    EEPROM_RETVAL_ERR_NBYTES
 
} eeprom_retval_t;
 
typedef struct
{
    //  Click mikrobus DRV objects.
    digital_out_t  wp;
    i2c_master_t   i2c;
    //  Device slave address.
    uint8_t  slave_addr;
 
} eeprom_t;
 
typedef struct
{
    //  Used mikrobus pins.
    pin_name_t  wp;
    pin_name_t  scl;
    pin_name_t  sda;
    //  Device address selector.
    eeprom_i2c_address_selector_t  addr_sel;
    // static variable 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} eeprom_cfg_t;
 
 //  End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void eeprom_cfg_setup( eeprom_cfg_t *cfg );
 
eeprom_retval_t eeprom_init( eeprom_t *context, eeprom_cfg_t *cfg );
 
void eeprom_write_byte( eeprom_t *context, uint8_t reg_addr, uint8_t data_in );
 
void eeprom_write_page( eeprom_t *context, uint8_t reg_addr, uint8_t *data_in );
 
uint8_t eeprom_read_byte( eeprom_t *context, uint8_t reg_addr );
 
eeprom_retval_t eeprom_read_sequential( eeprom_t *context, uint8_t reg_addr, uint16_t n_bytes, uint8_t *data_out );
 
void eeprom_write_enable( eeprom_t *context );
 
void eeprom_write_protect( eeprom_t *context );
 
#ifdef __cplusplus
}
#endif
#endif  //  _EEPROM_H_
 
 //  End public_function group
 
// ------------------------------------------------------------------------ END