eeprom4  2.0.0.0
Main Page

EEPROM 4 click

<EEPROM 4 click is 2,097,152 bits on a click boardâ„¢, organized into 262,144 bytes. In other words, this click boardâ„¢ is an EEPROM memory medium with the capacity of 256 KB.>

click Product page


Click library

  • Author : MikroE Team
  • Date : nov 2019.
  • Type : SPI type

Software Support

We provide a library for the Eeprom4 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for Eeprom4 Click driver.

Standard key functions :

  • Config Object Initialization function.

    void eeprom4_cfg_setup ( eeprom4_cfg_t *cfg );

  • Initialization function.

    EEPROM4_RETVAL eeprom4_init ( eeprom4_t *ctx, eeprom4_cfg_t *cfg );

  • Click Default Configuration function.

    void eeprom4_default_cfg ( eeprom4_t *ctx );

Example key functions :

  • Status register write function

    void eeprom4_write_status_reg ( eeprom4_t *ctx, uint8_t data_value );

  • Memory array write function

    void eeprom4_write_memory ( eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_input, uint8_t n_bytes );

  • Memory array read function

    void eeprom4_read_memory ( eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_output, uint8_t n_bytes );

Examples Description

This click is a memmory.

The demo application is composed of two sections :

Application Init

Initializes click driver and configures click that all memory block > is unprotected. Also configures that HOLD operation is disabled, and the memory and > status register are writable.

void application_init ( void )
{
log_cfg_t log_cfg;
// Logger initialization.
log_cfg.level = LOG_LEVEL_DEBUG;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
EEPROM4_MAP_MIKROBUS( cfg, MIKROBUS_1 );
eeprom4_init( &eeprom4, &cfg );
}

Application Task

Enables writting to memory array, writes data from buffer to memory, checks if the part is in a write cycle, and if is not reads data > > from memory array and stores data to buffer. Storaged data shows on USB UART.

{
uint8_t data_write[ 13 ] = { 'M', 'i', 'K', 'r', 'O', 'e', 0 };
uint8_t data_read[ 255 ] = { 0 };
uint8_t cnt;
uint8_t check_state;
6 );
while ( cnt | check_state )
{
}
eeprom4_read_memory( &eeprom4, 0x00000000, data_read, 6 );
for ( cnt = 0; cnt < 6; cnt++ )
{
log_printf( &logger, " %c ", data_read[cnt] );
}
log_printf( &logger, "----- \r\n" );
Delay_ms( 2000 );
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Eeprom4

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.


eeprom4_read_memory
void eeprom4_read_memory(eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_output, uint8_t n_bytes)
Memory array read function.
eeprom4_init
EEPROM4_RETVAL eeprom4_init(eeprom4_t *ctx, eeprom4_cfg_t *cfg)
Initialization function.
EEPROM4_READY_BIT
#define EEPROM4_READY_BIT
Definition: eeprom4.h:84
eeprom4_write_memory
void eeprom4_write_memory(eeprom4_t *ctx, uint32_t memory_address, uint8_t *data_input, uint8_t n_bytes)
Memory array write function.
EEPROM4_LOW_POWER_WRITE_POLL_COMMAND
#define EEPROM4_LOW_POWER_WRITE_POLL_COMMAND
Definition: eeprom4.h:93
eeprom4_check_status_reg
uint8_t eeprom4_check_status_reg(eeprom4_t *ctx, uint8_t check_bit)
Status register bits check function.
EEPROM4_FIRST_MEMORY_LOCATION
#define EEPROM4_FIRST_MEMORY_LOCATION
Definition: eeprom4.h:102
application_task
void application_task()
Definition: main.c:57
eeprom4_cfg_t
Click configuration structure definition.
Definition: eeprom4.h:147
eeprom4_send_command
uint8_t eeprom4_send_command(eeprom4_t *ctx, uint8_t command_byte)
Command send function.
eeprom4_cfg_setup
void eeprom4_cfg_setup(eeprom4_cfg_t *cfg)
Config Object Initialization function.
application_init
void application_init(void)
Definition: main.c:35
EEPROM4_SET_WRITE_ENABLE_LATCH_COMMAND
#define EEPROM4_SET_WRITE_ENABLE_LATCH_COMMAND
Definition: eeprom4.h:94
EEPROM4_MAP_MIKROBUS
#define EEPROM4_MAP_MIKROBUS(cfg, mikrobus)
Definition: eeprom4.h:53