fram3.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 FRAM3_H
#define FRAM3_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define FRAM3_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define FRAM3_RETVAL  uint8_t
 
#define FRAM3_OK           0x00
#define FRAM3_INIT_ERROR   0xFF
#define  FRAM3_SLAVE_ADDR                        0x50
#define  FRAM3_MAX_ADDR                          0x6F
#define  FRAM3_MAX_BUF_SIZE                      16
#define  FRAM3_CMD_AES_RNG_GEN                   0x1D
#define  FRAM3_CMD_AES_CHALLENGE_RESPONSE_A      0x1B
#define  FRAM3_CMD_AES_CHALLENGE_RESPONSE_B      0x1E
#define  FRAM3_CMD_ID_READ                       0x63
#define  FRAM3_CMD_AES_ID_READ_MAC_A             0x8B
#define  FRAM3_CMD_AES_ID_READ_MAC_B             0x8E
#define  FRAM3_CMD_COUNTER_READ                  0x66
#define  FRAM3_CMD_COUNTER_INC                   0x65
#define  FRAM3_CMD_AES_COUNTER_READ_MAC_A        0x2B
#define  FRAM3_CMD_AES_COUNTER_READ_MAC_B        0x2E
#define  FRAM3_CMD_AES_COUNTER_INC_MAC_A         0x4B
#define  FRAM3_CMD_AES_COUNTER_INC_MAC_B         0x4E
#define  FRAM3_CMD_OTW_FRAM_READ                 0x2D
#define  FRAM3_CMD_OTW_FRAM_WRITE                0x27
#define  FRAM3_CMD_PROTECT_AREA_CONF             0xCA
#define  FRAM3_CMD_PROTECT_AREA_READ             0x8D
#define  FRAM3_CMD_PROTECT_AREA_WRITE            0x87
#define  FRAM3_CMD_MEMORY_RESET                  0xA5
#define  FRAM3_CMD_FRAM_READ                     0x4D
#define  FRAM3_CMD_FRAM_WRITE                    0x47
#define  FRAM3_CMD_ID_WRITE                      0xC3
#define  FRAM3_CMD_FUNC_CONF_WRITE               0xA6
#define  FRAM3_CMD_SEC_KEY_WRITE                 0xA9
#define  FRAM3_CMD_PASSWORD_CHG                  0xC9
#define  FRAM3_CMD_MIXING_CONST_WRITE            0xCC
#define  FRAM3_CMD_LIFE_CYCLE_CHG                0x6C
#define  FRAM3_CMD_STATUS_READ                   0x6A
#define  FRAM3_SUCCESS                           0xAA
#define  FRAM3_ERROR                             0xBB
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{   
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} fram3_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} fram3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void fram3_cfg_setup ( fram3_cfg_t *cfg );
 
FRAM3_RETVAL fram3_init ( fram3_t *ctx, fram3_cfg_t *cfg );
 
void fram3_generic_write ( fram3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void fram3_generic_read ( fram3_t *ctx, uint8_t *tx_buf, uint8_t *data_buf, uint8_t len );
 
uint8_t fram3_read_free_access_memory ( fram3_t *ctx, uint8_t start_addr, uint8_t *data_buf, uint8_t n_buf_size );
 
uint8_t fram3_write_free_access_memory ( fram3_t *ctx, uint8_t start_addr, uint8_t *data_buf, uint8_t n_buf_size );
 
#ifdef __cplusplus
}
#endif
#endif  // _FRAM3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END