fram 2.0.0.0
Main Page

Fram click

FRAM click is a Click board™ that carries a ferroelectric RAM module. Ferroelectric RAM, also known as FRAM, is a non-volatile memory type, with characteristics comparable to much faster DRAM memory modules.

click Product page

Click library

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

Software Support

We provide a library for the Fram 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 Fram Click driver.

Standard key functions :

  • Config Object Initialization function.

    ‍void fram_cfg_setup ( fram_cfg_t *cfg );

    - Initialization function.

    ‍FRAM_RETVAL fram_init ( fram_t *ctx, fram_cfg_t *cfg );

  • Click Default Configuration function.

    ‍void fram_default_cfg ( fram_t *ctx );

Example key functions :

  • This function that sends write enable command to the chip.

    ‍void fram_write_enable ( fram_t *ctx );

    - This function reads sequential memory locations to buffer.

    ‍void fram_read ( fram_t *ctx, uint16_t address, uint8_t *buffer, uint16_t count );

  • This function writes to sequential memory locations from buffer.

    ‍void fram_write ( fram_t *ctx, uint16_t address, uint8_t *buffer, uint16_t count );

    Examples Description

‍This app writing data to click memory.

The demo application is composed of two sections :

Application Init

‍Initialization device.

void application_init ( void )
{
log_cfg_t log_cfg;
fram_cfg_t cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----\r\n" );
// Click initialization.
fram_cfg_setup( &cfg );
FRAM_MAP_MIKROBUS( cfg, MIKROBUS_1 );
fram_init( &fram, &cfg );
fram_erase_all( &fram );
}
FRAM_MAP_MIKROBUS
#define FRAM_MAP_MIKROBUS(cfg, mikrobus)
Definition fram.h:68
fram_erase_all
void fram_erase_all(fram_t *ctx)
Fram erase all function.
fram_init
FRAM_RETVAL fram_init(fram_t *ctx, fram_cfg_t *cfg)
Initialization function.
fram_cfg_setup
void fram_cfg_setup(fram_cfg_t *cfg)
Config Object Initialization function.
application_init
void application_init(void)
Definition main.c:32
fram_cfg_t
Click configuration structure definition.
Definition fram.h:140

Application Task

‍Writing data to click memory and displaying the read data via UART.

void application_task ( void )
{
char wr_data[ 10 ] = { 'M', 'i', 'k', 'r', 'o', 'E', 13, 10, 0 };
char rd_data[ 10 ];
log_printf( &logger, "Writing MikroE to Fram memory, from address 0x0150: \r\n" );
fram_write( &fram, 0x0150, &wr_data[ 0 ], 9 );
log_printf( &logger, "Reading 9 bytes of Fram memory, from address 0x0150: \r\n" );
fram_read( &fram, 0x0150, &rd_data[ 0 ], 9 );
log_printf( &logger, "Data read: %c \r\n", rd_data );
Delay_ms ( 1000 );
}
fram_read
void fram_read(fram_t *ctx, uint16_t address, uint8_t *buffer, uint16_t count)
Fram read function.
fram_write
void fram_write(fram_t *ctx, uint16_t address, uint8_t *buffer, uint16_t count)
Fram write function.
application_task
void application_task(void)
Definition main.c:59

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.Fram

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.