eeprom11.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 EEPROM11_H
#define EEPROM11_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 EEPROM11_SET_WP_BLOCK0              0x31
#define EEPROM11_SET_WP_BLOCK1              0x34
#define EEPROM11_SET_WP_BLOCK2              0x35
#define EEPROM11_SET_WP_BLOCK3              0x30
#define EEPROM11_CLEAR_ALL_WP               0x33
#define EEPROM11_READ_SWP0                  0x31
#define EEPROM11_READ_SWP1                  0x34
#define EEPROM11_READ_SWP2                  0x35
#define EEPROM11_READ_SWP3                  0x30
#define EEPROM11_SET_PAGE_ADDR_0            0x36
#define EEPROM11_SET_PAGE_ADDR_1            0x37
#define EEPROM11_READ_PAGE_ADDR             0x36
 
 // eeprom11_reg
 
#define EEPROM11_DEVICE_ADDRESS_0           0x50
#define EEPROM11_DEVICE_ADDRESS_1           0x51
#define EEPROM11_DEVICE_ADDRESS_2           0x52
#define EEPROM11_DEVICE_ADDRESS_3           0x53
#define EEPROM11_DEVICE_ADDRESS_4           0x54
#define EEPROM11_DEVICE_ADDRESS_5           0x55
#define EEPROM11_DEVICE_ADDRESS_6           0x56
#define EEPROM11_DEVICE_ADDRESS_7           0x57
 // eeprom11_set
 
#define EEPROM11_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // eeprom11_map
 // eeprom11
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                           
    // I2C slave address
    uint8_t slave_address;                      
} eeprom11_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} eeprom11_cfg_t;
 
typedef enum
{
    EEPROM11_OK = 0,
    EEPROM11_ERROR = -1
 
} eeprom11_return_value_t;
 
void eeprom11_cfg_setup ( eeprom11_cfg_t *cfg );
 
err_t eeprom11_init ( eeprom11_t *ctx, eeprom11_cfg_t *cfg );
 
err_t eeprom11_default_cfg ( eeprom11_t *ctx );
 
err_t eeprom11_generic_write ( eeprom11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t eeprom11_generic_read ( eeprom11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t eeprom11_page_write ( eeprom11_t *ctx, uint8_t address, uint8_t *data_in );
 
err_t eeprom11_clear_page ( eeprom11_t *ctx, uint8_t address );
 
err_t eeprom11_set_wp ( eeprom11_t *ctx, uint8_t block_addr );
 
err_t eeprom11_clear_wp ( eeprom11_t *ctx );
 
err_t eeprom11_set_page_addr ( eeprom11_t *ctx, uint8_t page_addr );
 
#ifdef __cplusplus
}
#endif
#endif // EEPROM11_H
 
 // eeprom11
 
// ------------------------------------------------------------------------ END