flash  2.0.0.0
Main Page

Flash click

Flash Click is 8,388,608 bits (8 Mbit) on a Click board, organized into 1,048,576 bytes (1 MB). In other words, this Click board is a Flash memory medium with the capacity of 1 MB. The used Flash module has very good endurance and it can withstand up to 100,000 write cycles, with the data retention period of about 20 years.

click Product page


Click library

  • Author : Nemanja Medakovic
  • Date : Nov 2019.
  • Type : SPI type

Software Support

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

Standard key functions :

Example key functions :

  • Page Write function.

    flash_err_t flash_write_page( flash_t *ctx, uint32_t mem_addr, spi_master_data_t *data_tx, uint16_t n_data );

  • Page Read function.

    flash_err_t flash_read_page( flash_t *ctx, uint32_t mem_addr, spi_master_data_t *data_rx, uint16_t n_data );

  • Sector Erase function.

    flash_err_t flash_erase_sector( flash_t *ctx, uint32_t mem_addr );

Examples Description

This example demonstrates the use (control) of the FLASH memory.

The demo application is composed of two sections :

Application Init

Initializes all necessary peripherals and pins used by Flash click and also initializes uart logger to show results.

void application_init( void )
{
flash_cfg_t flash_cfg;
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
flash_cfg_setup( &flash_cfg );
FLASH_MAP_MIKROBUS( flash_cfg, MIKROBUS_1 );
flash_init( &flash, &flash_cfg );
// Click reset and default configuration.
flash_reset( &flash );
flash_default_cfg( &flash );
log_printf( &logger, "*** Flash Initialization Done. ***\r\n" );
log_printf( &logger, "************************************\r\n" );
}

Application Task

Executes memory data writing, reading from the memory to verify data writing operation and sector erasing to clear memory.

void application_task( void )
{
enter_data( "Mikroelektronika (MikroE)" );
log_printf( &logger, "> Data content to be written: %s\r\n", data_buf );
log_printf( &logger, "> Data writing to memory...\r\n" );
flash_write_page( &flash, FLASH_MEM_ADDR_FIRST_PAGE_START, data_buf, n_data );
log_printf( &logger, "> Done.\r\n" );
memset( data_buf, 0, sizeof( data_buf ) );
log_printf( &logger, "> Data reading from memory...\r\n" );
flash_read_page( &flash, FLASH_MEM_ADDR_FIRST_PAGE_START, data_buf, n_data );
log_printf( &logger, "> Done.\r\n> Read data content: %s\r\n", data_buf );
log_printf( &logger, "> Sector erasing...\r\n" );
log_printf( &logger, "> Done.\r\n" );
}

Additional Functions

  • Enter Data / Allows user to enter a desired data.
  • Process Wait / Makes a delay to wait while some process be done.

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

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.


flash_init
flash_err_t flash_init(flash_t *ctx, flash_cfg_t *cfg)
Click Initialization function.
FLASH_MEM_ADDR_FIRST_SECTOR_START
#define FLASH_MEM_ADDR_FIRST_SECTOR_START
Definition: flash.h:67
FLASH_MAP_MIKROBUS
#define FLASH_MAP_MIKROBUS(cfg, mikrobus)
Definition: flash.h:119
flash_read_page
flash_err_t flash_read_page(flash_t *ctx, uint32_t mem_addr, uint8_t *data_rx, uint16_t n_data)
Page Read function.
application_task
void application_task(void)
Definition: main.c:107
flash_cfg_setup
void flash_cfg_setup(flash_cfg_t *cfg)
Config Object Setup function.
flash_erase_sector
flash_err_t flash_erase_sector(flash_t *ctx, uint32_t mem_addr)
Sector Erase function.
enter_data
void enter_data(unsigned char *buffer)
Definition: main.c:41
flash_reset
void flash_reset(flash_t *ctx)
Reset function.
flash_write_page
flash_err_t flash_write_page(flash_t *ctx, uint32_t mem_addr, uint8_t *data_tx, uint16_t n_data)
Page Write function.
process_wait
void process_wait(void)
Definition: main.c:60
flash_cfg_t
Click configuration structure definition.
Definition: flash.h:179
application_init
void application_init(void)
Definition: main.c:76
flash_default_cfg
void flash_default_cfg(flash_t *ctx)
Click Default Configuration function.
FLASH_MEM_ADDR_FIRST_PAGE_START
#define FLASH_MEM_ADDR_FIRST_PAGE_START
Definition: flash.h:61