eeprom13.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 EEPROM13_H
#define EEPROM13_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 EEPROM13_REG_DEV_TYPE_IDENTIFIER       0xE000u
#define EEPROM13_REG_CFG_DEVICE_ADDRESS        0xC000u
#define EEPROM13_REG_SW_WRITE_PROTECTION       0xA000u
#define EEPROM13_REG_IDENTIFICATION_PAGE       0x0000u
#define EEPROM13_REG_IDENTIFICATION_PAGE_LOCK  0x6000u
 
 
 // eeprom13_reg
 
#define EEPROM13_MEMORY_ADDRESS_MIN            0x00000000ul
#define EEPROM13_MEMORY_ADDRESS_MAX            0x0001FFFFul
#define EEPROM13_MEMORY_ADDRESS_16_BIT_MASK    0x00010000ul
#define EEPROM13_MEMORY_ADDRESS_16_BIT         0x01
#define EEPROM13_PAGE_SIZE                     256
#define EEPROM13_PAGE_MAX                      512
 
#define EEPROM13_CDA_DAL_BIT_MASK              0x01
#define EEPROM13_CDA_CEA_BIT_MASK              0x03
 
#define EEPROM13_SWP_WPL_MODIFIED              0x00
#define EEPROM13_SWP_WPL_FROZEN                0x01
#define EEPROM13_SWP_WPL_BIT_MASK              0x01
#define EEPROM13_SWP_BP_UPPER_QUARTE           0x00
#define EEPROM13_SWP_BP_UPPER_HALF             0x01
#define EEPROM13_SWP_BP_UPPER_THREE_QUARTE     0x02
#define EEPROM13_SWP_BP_WHOLE_MEM              0x03
#define EEPROM13_SWP_BP_BIT_MASK               0x06
#define EEPROM13_SWP_WPA_WRITE_ENABLE          0x00
#define EEPROM13_SWP_WPA_BLOCK_WRITE           0x01
#define EEPROM13_SWP_WPA_BIT_MASK              0x08
 
#define EEPROM13_DEFAULT_CHIP_ENABLE_ADDRESS   0x00
 
#define EEPROM13_DEVICE_ADDRESS_MEMORY         0x50
#define EEPROM13_DEVICE_ADDRESS_PAGE           0x58
 
 // eeprom13_set
 
#define EEPROM13_MAP_MIKROBUS( cfg, mikrobus )    \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.wc  = MIKROBUS( mikrobus, MIKROBUS_RST )
 
 // eeprom13_map
 // eeprom13
 
typedef struct
{
    // Output pins
    digital_out_t wc;    
    // Modules
    i2c_master_t i2c;    
    // I2C slave address
    uint8_t slave_address;    
    uint8_t chip_en_addr;     /* Chip enable address */
 
} eeprom13_t;
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    pin_name_t wc;     
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} eeprom13_cfg_t;
 
typedef enum
{
    EEPROM13_OK = 0,
    EEPROM13_ERROR = -1
 
} eeprom13_return_value_t;
 
void eeprom13_cfg_setup ( eeprom13_cfg_t *cfg );
 
err_t eeprom13_init ( eeprom13_t *ctx, eeprom13_cfg_t *cfg );
 
void eeprom13_hw_write_enable ( eeprom13_t *ctx );
 
void eeprom13_hw_write_disable ( eeprom13_t *ctx );
 
err_t eeprom13_generic_write ( eeprom13_t *ctx, uint16_t reg, uint8_t *data_in, uint8_t len );
 
err_t eeprom13_generic_read ( eeprom13_t *ctx, uint16_t reg, uint8_t *data_out, uint8_t len );
 
err_t eeprom13_memory_write ( eeprom13_t *ctx, uint32_t mem_addr, uint8_t *data_in, uint8_t len );
 
err_t eeprom13_memory_read ( eeprom13_t *ctx, uint32_t mem_addr, uint8_t *data_out, uint8_t len );
 
err_t eeprom13_memory_page_write ( eeprom13_t *ctx, uint16_t page_addr, uint8_t *data_in, uint8_t len );
 
err_t eeprom13_memory_page_read ( eeprom13_t *ctx, uint16_t page_addr, uint8_t *data_out, uint8_t len );
 
err_t eeprom13_id_page_write ( eeprom13_t *ctx, uint16_t id_page_addr, uint8_t *data_in );
 
 
err_t eeprom13_id_page_read ( eeprom13_t *ctx, uint16_t id_page_addr, uint8_t *data_out );
 
err_t eeprom13_config_dev_addr ( eeprom13_t *ctx, uint8_t cda, uint8_t dal );
 
err_t eeprom13_sw_write_protect ( eeprom13_t *ctx, uint8_t wpa, uint8_t bp, uint8_t wpl );
 
err_t eeprom13_get_lock_status ( eeprom13_t *ctx, uint8_t *lock_status );
 
#ifdef __cplusplus
}
#endif
#endif // EEPROM13_H
 
 // eeprom13
 
// ------------------------------------------------------------------------ END