eeram3  2.0.0.0
Main Page

EERAM 3 click

EERAM 3 Click is a compact add-on board that contains EERAM memory designed to retain data during power loss without the aid of external batteries. This board features the 48L256, a serial EERAM with SRAM memory core, including hidden EEPROM backup from Microchip Technology.

click Product page


Click library

  • Author : Stefan Filipovic
  • Date : Sep 2021.
  • Type : SPI type

Software Support

We provide a library for the EERAM3 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for EERAM3 Click driver.

Standard key functions :

Example key functions :

  • eeram3_memory_secure_write This function securely writes a desired number of data bytes starting from the selected memory address.
    err_t eeram3_memory_secure_write ( eeram3_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len );
  • eeram3_memory_secure_read This function securely reads a desired number of data bytes starting from the selected memory address.
    err_t eeram3_memory_secure_read ( eeram3_t *ctx, uint16_t address, uint8_t *data_out, uint8_t len );
  • eeram3_set_block_protection This function sets the block protection bits of the Status register.
    err_t eeram3_set_block_protection ( eeram3_t *ctx, uint8_t block_protect );

Example Description

This example demonstrates the use of EERAM 3 click board.

The demo application is composed of two sections :

Application Init

Initializes the driver and performs the click default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
eeram3_cfg_t eeram3_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
eeram3_cfg_setup( &eeram3_cfg );
EERAM3_MAP_MIKROBUS( eeram3_cfg, MIKROBUS_1 );
if ( SPI_MASTER_ERROR == eeram3_init( &eeram3, &eeram3_cfg ) )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
eeram3_default_cfg ( &eeram3 );
log_info( &logger, " Application Task " );
}

Application Task

Writes a desired number of bytes to the memory and then verifies that it's written correctly by reading from the same memory location and displaying the memory content on the USB UART.

void application_task ( void )
{
uint8_t data_buf[ 64 ] = { 0 };
{
log_printf ( &logger, "Data written to address 0x%.4X: %s\r\n", ( uint16_t ) STARTING_ADDRESS,
( char * ) DEMO_TEXT_MESSAGE );
}
Delay_ms ( 100 );
data_buf, strlen ( DEMO_TEXT_MESSAGE ) ) )
{
log_printf ( &logger, "Data read from address 0x%.4X: %s\r\n\n", ( uint16_t ) STARTING_ADDRESS,
data_buf );
}
Delay_ms ( 1000 );
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.EERAM3

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all MikroElektronika compilers, or any other terminal application of your choice, can be used to read the message.


EERAM3_OK
@ EERAM3_OK
Definition: eeram3.h:201
eeram3_init
err_t eeram3_init(eeram3_t *ctx, eeram3_cfg_t *cfg)
EERAM 3 initialization function.
EERAM3_MAP_MIKROBUS
#define EERAM3_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: eeram3.h:147
eeram3_t
EERAM 3 Click context object.
Definition: eeram3.h:162
eeram3_memory_secure_read
err_t eeram3_memory_secure_read(eeram3_t *ctx, uint16_t address, uint8_t *data_out, uint8_t len)
EERAM 3 memory secure read function.
application_task
void application_task(void)
Definition: main.c:63
eeram3_cfg_t
EERAM 3 Click configuration object.
Definition: eeram3.h:178
eeram3_cfg_setup
void eeram3_cfg_setup(eeram3_cfg_t *cfg)
EERAM 3 configuration object setup function.
eeram3_default_cfg
void eeram3_default_cfg(eeram3_t *ctx)
EERAM 3 default configuration function.
eeram3_memory_secure_write
err_t eeram3_memory_secure_write(eeram3_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len)
EERAM 3 memory write function.
eeram3_set_block_protection
err_t eeram3_set_block_protection(eeram3_t *ctx, uint8_t block_protect)
EERAM 3 set block protection function.
application_init
void application_init(void)
Definition: main.c:31
STARTING_ADDRESS
#define STARTING_ADDRESS
Definition: main.c:26
DEMO_TEXT_MESSAGE
#define DEMO_TEXT_MESSAGE
Definition: main.c:25