eeprom12.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 EEPROM12_H
#define EEPROM12_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 EEPROM12_REG_IDENTIFICATION_PAGE         0x0000u
#define EEPROM12_REG_IDENTIFICATION_PAGE_LOCK    0x0200u
#define EEPROM12_REG_CONFIG_DEVICE_ADDRESS       0xC000u
 
 // eeprom12_reg
 
#define EEPROM12_MEMORY_ADDRESS_MIN              0x0000u
#define EEPROM12_MEMORY_ADDRESS_MAX              0x7FFFu
#define EEPROM12_PAGE_SIZE                       64
#define EEPROM12_PAGE_MAX                        512
 
#define EEPROM12_CDA_DAL_BIT_MASK                 0x01
#define EEPROM12_CDA_CEA_BIT_MASK                 0x07
 
#define EEPROM12_DEFAULT_CHIP_ENABLE_ADDRESS     0x00
 
#define EEPROM12_DEVICE_ADDRESS_MEMORY           0x50
#define EEPROM12_DEVICE_ADDRESS_PAGE             0x58
 
 // eeprom12_set
 
#define EEPROM12_MAP_MIKROBUS( cfg, mikrobus )    \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.wc  = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // eeprom12_map
 // eeprom12
 
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 */
 
} eeprom12_t;
 
typedef struct
{
    pin_name_t scl;            
    pin_name_t sda;            
    pin_name_t wc;             
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} eeprom12_cfg_t;
 
typedef enum
{
    EEPROM12_OK = 0,
    EEPROM12_ERROR = -1
 
} eeprom12_return_value_t;
 
void eeprom12_cfg_setup ( eeprom12_cfg_t *cfg );
 
err_t eeprom12_init ( eeprom12_t *ctx, eeprom12_cfg_t *cfg );
 
void eeprom12_write_enable ( eeprom12_t *ctx );
 
void eeprom12_write_disable ( eeprom12_t *ctx );
 
err_t eeprom12_generic_write ( eeprom12_t *ctx, uint16_t reg, uint8_t *data_in, uint8_t len );
 
err_t eeprom12_generic_read ( eeprom12_t *ctx, uint16_t reg, uint8_t *data_out, uint8_t len );
 
err_t eeprom12_memory_write ( eeprom12_t *ctx, uint16_t mem_addr, uint8_t *data_in, uint8_t len );
 
err_t eeprom12_memory_read ( eeprom12_t *ctx, uint16_t mem_addr, uint8_t *data_out, uint8_t len );
 
err_t eeprom12_memory_page_write ( eeprom12_t *ctx, uint16_t page_addr, uint8_t *data_in, uint8_t len );
 
err_t eeprom12_memory_page_read ( eeprom12_t *ctx, uint16_t page_addr, uint8_t *data_out, uint8_t len );
 
err_t eeprom12_id_page_write ( eeprom12_t *ctx, uint16_t id_page_addr, uint8_t *data_in );
 
err_t eeprom12_id_page_read ( eeprom12_t *ctx, uint16_t id_page_addr, uint8_t *data_out );
 
err_t eeprom12_config_dev_addr ( eeprom12_t *ctx, uint8_t cda, uint8_t dal );
 
err_t eeprom12_read_lock_status ( eeprom12_t *ctx, uint8_t *lock_status );
 
#ifdef __cplusplus
}
#endif
#endif // EEPROM12_H
 
 // eeprom12
 
// ------------------------------------------------------------------------ END