fram5.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 FRAM5_H
#define FRAM5_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 FRAM5_MIN_ADDRESS                       0x00000
#define FRAM5_MAX_ADDRESS                       0x1FFFF
 
#define FRAM5_SLAVE_ID                          0x7C
 
#define FRAM5_MANUFACTURER_ID_DENSITY           0x44
 
#define FRAM5_DEVICE_ADDRESS_A2A1_00            0x50
#define FRAM5_DEVICE_ADDRESS_A2A1_01            0x52
#define FRAM5_DEVICE_ADDRESS_A2A1_10            0x54
#define FRAM5_DEVICE_ADDRESS_A2A1_11            0x56
 
 // fram5_set
 
#define FRAM5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM );
 
 // fram5_map
 // fram5
 
typedef struct
{
    // Output pins
    digital_out_t  wp;          
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} fram5_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  wp;             
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} fram5_cfg_t;
 
typedef enum
{
    FRAM5_OK = 0,
    FRAM5_ERROR = -1
 
} fram5_return_value_t;
 
void fram5_cfg_setup ( fram5_cfg_t *cfg );
 
err_t fram5_init ( fram5_t *ctx, fram5_cfg_t *cfg );
 
err_t fram5_memory_write ( fram5_t *ctx, uint32_t address, uint8_t *data_in, uint8_t len );
 
err_t fram5_memory_read ( fram5_t *ctx, uint32_t address, uint8_t *data_out, uint8_t len );
 
err_t fram5_check_communication ( fram5_t *ctx );
 
void fram5_write_protect ( fram5_t *ctx );
 
void fram5_write_enable ( fram5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // FRAM5_H
 
 // fram5
 
// ------------------------------------------------------------------------ END