eeprom10.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 EEPROM10_H
#define EEPROM10_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 EEPROM10_NBYTES_PAGE                    32
 
#define EEPROM10_BLOCK_ADDR_START               0x0000
#define EEPROM10_BLOCK_ADDR_END                 0x0FFFu
 
#define EEPROM10_DEVICE_ADDRESS_0               0x50
#define EEPROM10_DEVICE_ADDRESS_1               0x51
#define EEPROM10_DEVICE_ADDRESS_2               0x52
#define EEPROM10_DEVICE_ADDRESS_3               0x53
#define EEPROM10_DEVICE_ADDRESS_4               0x54
#define EEPROM10_DEVICE_ADDRESS_5               0x55
#define EEPROM10_DEVICE_ADDRESS_6               0x56
#define EEPROM10_DEVICE_ADDRESS_7               0x57
 
 // eeprom10_set
 
#define EEPROM10_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // eeprom10_map
 // eeprom10
 
typedef struct
{
    // Output pins
    digital_out_t wp;               
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} eeprom10_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t wp;              
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} eeprom10_cfg_t;
 
typedef enum
{
    EEPROM10_OK = 0,
    EEPROM10_ERROR = -1
 
} eeprom10_return_value_t;
 
void eeprom10_cfg_setup ( eeprom10_cfg_t *cfg );
 
err_t eeprom10_init ( eeprom10_t *ctx, eeprom10_cfg_t *cfg );
 
void eeprom10_write_enable( eeprom10_t *ctx );
 
void eeprom10_write_protect( eeprom10_t *ctx );
 
err_t eeprom10_write_byte ( eeprom10_t *ctx, uint16_t address, uint8_t data_in );
 
err_t eeprom10_write_page ( eeprom10_t *ctx, uint8_t address, uint8_t *data_in );
 
err_t eeprom10_write_n_byte ( eeprom10_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len );
 
err_t eeprom10_read_byte ( eeprom10_t *ctx, uint16_t address, uint8_t *data_out );
 
err_t eeprom10_read_page ( eeprom10_t *ctx, uint8_t address, uint8_t *data_out );
 
err_t eeprom10_read_n_byte ( eeprom10_t *ctx, uint16_t address, uint8_t *data_out, uint8_t len );
 
#ifdef __cplusplus
}
#endif
#endif // EEPROM10_H
 
 // eeprom10
 
// ------------------------------------------------------------------------ END