flash5  2.0.0.0
Main Page

Flash 5 click

Flash 5 Click is a perfect solution for the mass storage option in various embedded applications.

click Product page


Click library

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

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    void flash5_cfg_setup ( flash5_cfg_t *cfg );

  • Initialization function.

    FLASH5_RETVAL flash5_init ( flash5_t *ctx, flash5_cfg_t *cfg );

Example key functions :

  • Function for setting page read

    void flash5_page_read ( flash5_t *ctx, uint16_t page_num );

  • Function for loading one page

    void flash5_page_load_memory ( flash5_t *ctx, uint16_t column_addr, uint8_t *data_buf, uint16_t buf_size );

  • Function for writing status data

    void flash5_write_status_data ( flash5_t *ctx, uint8_t status_cmd, uint8_t status_addr, uint8_t status_data );

Examples Description

This application is for storing mass storage.

The demo application is composed of two sections :

Application Init

Initializes driver, resets device, erasing one page of memory, tests communication and configures device.

void application_init ( void )
{
log_cfg_t log_cfg;
uint8_t device_check = 0;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
FLASH5_MAP_MIKROBUS( cfg, MIKROBUS_1 );
flash5_init( &flash5, &cfg );
log_printf( &logger, " - Reseting device... \r\n" );
Delay_ms( 1000 );
log_printf( &logger, " - Erasing memory... \r\n" );
flash5_erase_page_data( &flash5, 0x0001 );
device_check = flash5_device_id_check( &flash5 );
if ( device_check == FLASH5_DEVICE_OK )
{
log_printf( &logger, " - Device OK \r\n" );
}
else
{
log_printf( &logger, " - Device Error \r\n" );
for( ; ; );
}
Delay_ms( 100 );
log_printf( &logger, " - Configuring device \r\n" );
Delay_ms( 1000 );
log_printf( &logger, "***** App init ***** \r\n" );
log_printf( &logger, "------------------- \r\n" );
Delay_ms( 500 );
}

Application Task

Writes "MikroE" to device memory and then reads it and sends it to log.

{
char read_buf[ 6 ];
uint8_t n_counter;
flash5_page_load_memory( &flash5, 0x000A, &write_buf[ 0 ], 6 );
flash5_page_read_memory( &flash5, 0x000A, &read_buf[ 0 ], 6 );
for( n_counter = 0; n_counter < 6; n_counter++ )
{
log_printf( &logger, " %c ", &read_buf[ n_counter ] );
Delay_ms( 100 );
}
log_printf( &logger, " \r\n" );
log_printf( &logger, "------------------- \r\n" );
Delay_ms( 5000 );
}

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

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.


FLASH5_RS1_SRP1_ENABLE
#define FLASH5_RS1_SRP1_ENABLE
Definition: flash5.h:130
flash5_send_cmd
void flash5_send_cmd(flash5_t *ctx, uint8_t cmd_data)
Function for sending one Byte od data.
flash5_erase_page_data
void flash5_erase_page_data(flash5_t *ctx, uint16_t page_addr)
Function for eraseing one page.
flash5_init
FLASH5_RETVAL flash5_init(flash5_t *ctx, flash5_cfg_t *cfg)
Initialization function.
FLASH5_REG_STATUS_1
#define FLASH5_REG_STATUS_1
Definition: flash5.h:119
flash5_cfg_t
Click configuration structure definition.
Definition: flash5.h:191
application_task
void application_task()
Definition: main.c:93
flash5_write_status_data
void flash5_write_status_data(flash5_t *ctx, uint8_t status_cmd, uint8_t status_addr, uint8_t status_data)
Function for writing status data.
FLASH5_RS2_PAGE_READ_MODE
#define FLASH5_RS2_PAGE_READ_MODE
Definition: flash5.h:138
flash5_software_reset
void flash5_software_reset(flash5_t *ctx)
Function for reseting device.
flash5_page_read_memory
void flash5_page_read_memory(flash5_t *ctx, uint16_t column_addr, uint8_t *data_buf, uint16_t buf_size)
Function for reading one page.
FLASH5_DEVICE_OK
#define FLASH5_DEVICE_OK
Definition: flash5.h:151
application_init
void application_init(void)
Definition: main.c:33
flash5_device_id_check
uint8_t flash5_device_id_check(flash5_t *ctx)
Funcion for checking device id.
FLASH5_CMD_WRITE_ENABLE
#define FLASH5_CMD_WRITE_ENABLE
Definition: flash5.h:90
FLASH5_MAP_MIKROBUS
#define FLASH5_MAP_MIKROBUS(cfg, mikrobus)
Definition: flash5.h:53
FLASH5_RS1_WRITE_PROTECTION_DISABLE
#define FLASH5_RS1_WRITE_PROTECTION_DISABLE
Definition: flash5.h:129
FLASH5_CMD_WRITE_REG_STATUS1
#define FLASH5_CMD_WRITE_REG_STATUS1
Definition: flash5.h:88
flash5_cfg_setup
void flash5_cfg_setup(flash5_cfg_t *cfg)
Config Object Initialization function.
flash5_page_load_memory
void flash5_page_load_memory(flash5_t *ctx, uint16_t column_addr, uint8_t *data_buf, uint16_t buf_size)
Function for loading one page.