Intermediate
30 min

Optimize data retrieval with S25HS512T and PIC18F2680 enhancing efficiency across applications

Experience blazing speed with Semper Flash

Semper Flash Click with EasyPIC v8

Published Nov 01, 2023

Click board™

Semper Flash Click

Dev. board

EasyPIC v8

Compiler

NECTO Studio

MCU

PIC18F2680

Experience the power of multiple protocols, including Dual I/O, Quad I/O (QIO), and Quad Peripheral Interface (QPI), offered by our Semper Flash solution for flexible connectivity

A

A

Hardware Overview

How does it work?

Semper Flash Click is based on the S25HS512T, a 512 Mbit SPI Flash memory module from Infineon. Featuring both normal and double data rates over the standard, Dual/Quad SPI interface, the improved reliability of the stored information by utilizing the hardware Error Correction Code (ECC) generation, One-Time Programmable (OTP) memory block of 1024 bytes, advanced sector protection, AutoBoot, and much more, this Click board™ is a perfect solution for the mass storage option in various embedded applications. Due to its fast performance, Semper Flash click can also be used for code shadowing, execute-in-place (XIP), data logging, and data storage. An additional level translator IC allows Semper Flash click to be used with a wide range of MCUs. The device control logic is subdivided into two parallel operating sections: the Host Interface Controller (HIC) and the Embedded Algorithm Controller (EAC). The HIC monitors signal levels on the device inputs and drives outputs to complete read, program and write data transfers with the host system. The HIC delivers data from the currently entered address map on read transfers, places write transfer address and data information into the EAC command memory and notifies the EAC of power transition and write transfers. The EAC interrogates the command memory after a program or writes transfer for legal command sequences and performs the related Embedded Algorithms. Executing code directly from Flash

memory is often called Execute-In-Place (XIP). By using XIP with Semper Flash devices at the higher clock rates with Quad or DDR Quad SPI transactions, the data transfer rate can match or exceed traditional parallel or asynchronous NOR flash memories while reducing signal count dramatically. The advanced MirrorBit® technology allows storing two data bits in each memory array transistor (memory cell), effectively doubling the capacity of a single storage cell. The Eclipse™ architecture is responsible for the greatly improved erase and programming performance, compared to other Flash modules of the previous generation. Due to a higher speed, an execute-in-place (XIP) and data shadowing is possible with the Semper Flash click. One of the S25HS512 T's key features is the AutoBoot feature. It allows the module to automatically initiate the memory transfer from the predefined location (memory read operation) after the reset cycle. Considering a typical communication scenario, where the READ command followed by one or more address bytes need to be used, AutoBoot allows the host MCU to pull down the #CS (Chip Select) pin and start receiving a data stream over the SPI interface for as long as the #CS pin is held LOW, without any wasted cycles. When the #CS pin is released, the S25HS512T returns to normal operation. Advanced Sector Protection (ASP) is a powerful protection model incorporating various software and hardware methods to turn programming on or off

or erase operations within a sector or an entire memory. A specialized ASP OTP register offers password protection or a persistent protection mode, allowing increased flexibility in the protection. Using the OTP memory allows the protection mode to remain in place for the whole life-cycle of the device. The SPI interface pins are routed to the mikroBUS™ so that the interfacing with the microcontroller unit (MCU) is easy and straightforward. Additional pins routed to the mikroBUS™ include the #WP/IO2 pin routed to the mikroBUS™ PWM pin and labeled as IO2 and the #HOLD/IO3 pin routed to the mikroBUS™ INT pin and labeled as IO3. There is also the RESET pin, routed to the RST pin of the mikroBUS™, which performs a reset of the Flash module, initiating an AutoBoot sequence if enabled. EnduraFlex Architecture allows system designers to customize the NOR Flash endurance and retention for their specific applications. The host defines partitions for high endurance or long retention, providing up to 1+ million cycles or 25 years of data retention. Data Integrity Check transactions in Semper Flash perform a hardware-accelerated Cyclic Redundancy Check (CRC) calculation over a user-defined address range in the memory array. The SafeBoot feature allows Status Register polling to detect an embedded microcontroller initialization failure or configuration register corruption through error signatures.

Semper Flash Click top side image
Semper Flash Click bottom side image

Features overview

Development board

EasyPIC v8 is a development board specially designed for the needs of rapid development of embedded applications. It supports many high pin count 8-bit PIC microcontrollers from Microchip, regardless of their number of pins, and a broad set of unique functions, such as the first-ever embedded debugger/programmer. The development board is well organized and designed so that the end-user has all the necessary elements, such as switches, buttons, indicators, connectors, and others, in one place. Thanks to innovative manufacturing technology, EasyPIC v8 provides a fluid and immersive working experience, allowing access anywhere and under any

circumstances at any time. Each part of the EasyPIC v8 development board contains the components necessary for the most efficient operation of the same board. In addition to the advanced integrated CODEGRIP programmer/debugger module, which offers many valuable programming/debugging options and seamless integration with the Mikroe software environment, the board also includes a clean and regulated power supply module for the development board. It can use a wide range of external power sources, including a battery, an external 12V power supply, and a power source via the USB Type-C (USB-C) connector.

Communication options such as USB-UART, USB DEVICE, and CAN are also included, including the well-established mikroBUS™ standard, two display options (graphical and character-based LCD), and several different DIP sockets. These sockets cover a wide range of 8-bit PIC MCUs, from the smallest PIC MCU devices with only eight up to forty pins. EasyPIC v8 is an integral part of the Mikroe ecosystem for rapid development. Natively supported by Mikroe software tools, it covers many aspects of prototyping and development thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

EasyPIC v8 horizontal image

Microcontroller Overview

MCU Card / MCU

default

Architecture

PIC

MCU Memory (KB)

64

Silicon Vendor

Microchip

Pin count

28

RAM (Bytes)

3328

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
Reset
RA0
RST
SPI Chip Select
RA5
CS
SPI Clock
RC3
SCK
SPI Data OUT/SO1
RC4
MISO
SPI Data IN/SO0
RC5
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
Write Protect/IO2
RC1
PWM
Data Transfer Pause/IO3
RB1
INT
NC
NC
TX
NC
NC
RX
NC
NC
SCL
NC
NC
SDA
NC
NC
5V
Ground
GND
GND
2

Take a closer look

Click board™ Schematic

Semper Flash Click Schematic schematic

Step by step

Project assembly

EasyPIC v8 front image hardware assembly

Start by selecting your development board and Click board™. Begin with the EasyPIC v8 as your development board.

EasyPIC v8 front image hardware assembly
Rotary B 2 Click front image hardware assembly
MCU DIP 28 hardware assembly
EasyPIC v8 28pin-DIP - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
NECTO Compiler Selection Step Image hardware assembly
NECTO Output Selection Step Image hardware assembly
Necto image step 6 hardware assembly
Necto DIP image step 7 hardware assembly
Necto image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Necto PreFlash Image hardware assembly

Track your results in real time

Application Output

1. Application Output - In Debug mode, the 'Application Output' window enables real-time data monitoring, offering direct insight into execution results. Ensure proper data display by configuring the environment correctly using the provided tutorial.

2. UART Terminal - Use the UART Terminal to monitor data transmission via a USB to UART converter, allowing direct communication between the Click board™ and your development system. Configure the baud rate and other serial settings according to your project's requirements to ensure proper functionality. For step-by-step setup instructions, refer to the provided tutorial.

3. Plot Output - The Plot feature offers a powerful way to visualize real-time sensor data, enabling trend analysis, debugging, and comparison of multiple data points. To set it up correctly, follow the provided tutorial, which includes a step-by-step example of using the Plot feature to display Click board™ readings. To use the Plot feature in your code, use the function: plot(*insert_graph_name*, variable_name);. This is a general format, and it is up to the user to replace 'insert_graph_name' with the actual graph name and 'variable_name' with the parameter to be displayed.

Software Support

Library Description

This library contains API for Semper Flash Click driver.

Key functions:

  • semperflash_write_memory - This function writes data to the flash memory

  • semperflash_read_memory - This function reads data from the flash memory

  • semperflash_erase_memory - This function erases data from the flash memory

Open Source

Code example

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.

/*!
 * \file 
 * \brief SemperFlash Click example
 * 
 * # Description
 * This example showcases how to initialize and use the Semper Flash click. The click
 * is a 512 Mbit SPI Flash memory module. Data can be stored in and read from the flash
 * memory. There's also the option of erasing it's contents. Here's how to do it.
 *
 * The demo application is composed of two sections :
 * 
 * ## Application Init 
 * This function initializes and configures the click and logger modules. Additional con-
 * figuring is done in the default_cfg(...) function. The device ID should appear in the 
 * UART console if the setup finishes successfully.
 * 
 * ## Application Task  
 * This function first erases the contents of the flash memory and then writes, reads and
 * prints two strings in the UART console. It does so every 2 seconds.
 * 
 * \author MikroE Team
 *
 */
// ------------------------------------------------------------------- INCLUDES

#include "board.h"
#include "log.h"
#include "semperflash.h"

// ------------------------------------------------------------------ VARIABLES

static semperflash_t semperflash;
static log_t logger;

uint8_t id_data[ 8 ];
uint8_t txt_flag;
uint8_t COMPANY_FLAG = 2;
uint8_t CLICK_FLAG = 3;
uint32_t ADRESS_MEMORY = 0x00001111;

// ------------------------------------------------------- ADDITIONAL FUNCTIONS

void error_handler ( uint8_t stat )
{
    if ( SEMPERFLASH_ID_ERROR == stat )
    {
        log_printf( &logger, "ID ERROR!" );
        for ( ; ; );
    }
    else if ( SEMPERFLASH_SIZE_ERROR == stat )
    {
        log_printf( &logger, "BUF SIZE ERROR!" );
        for ( ; ; );
    }
}

void id_check ( )
{
    uint8_t cnt;

    error_handler( semperflash_check_manufacturer_id( &semperflash ) );
    error_handler( semperflash_get_device_id( &semperflash, id_data ) );

    log_printf( &logger, "DEVICE ID: 0x" );
    for ( cnt = 0; cnt < SEMPERFLASH_DEVICE_ID_BYTE_SIZE; cnt++ )
    {
        log_printf( &logger, "%x", ( uint16_t )id_data[ cnt ] );
    }
    log_printf( &logger, "\r\n\r\n" );
    txt_flag = COMPANY_FLAG;
}

// ------------------------------------------------------ APPLICATION FUNCTIONS

void application_init ( )
{
    log_cfg_t log_cfg;
    semperflash_cfg_t cfg;

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, "---- Application Init ----" );
    Delay_ms( 100 );

    //  Click initialization.

    semperflash_cfg_setup( &cfg );
    SEMPERFLASH_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    semperflash_init( &semperflash, &cfg );
    
    semperflash_default_cfg( &semperflash );
    
    id_check( );
    Delay_ms( 500 );
}

void application_task ( )
{
    char write_data_com[ 7 ] = "MikroE";
    char write_data_clk[ 13 ] = "Semper Flash";
    char read_buf_data[ 13 ] = { 0 };

    semperflash_send_cmd( &semperflash, SEMPERFLASH_WRITE_ENABLE );
    semperflash_erase_memory( &semperflash, ADRESS_MEMORY );
    
    if ( COMPANY_FLAG == txt_flag )
    {
       semperflash_send_cmd( &semperflash, SEMPERFLASH_WRITE_ENABLE );
       error_handler( semperflash_write_memory( &semperflash, ADRESS_MEMORY, write_data_com, 6 ) );
       error_handler( semperflash_read_memory( &semperflash, ADRESS_MEMORY, read_buf_data, 6 ) );
       log_printf( &logger, "%s\r\n", read_buf_data );
       txt_flag = CLICK_FLAG;       
    }
    else if ( CLICK_FLAG == txt_flag )
    {
       semperflash_send_cmd( &semperflash, SEMPERFLASH_WRITE_ENABLE );
       error_handler( semperflash_write_memory( &semperflash, ADRESS_MEMORY, write_data_clk, 12 ) );
       error_handler( semperflash_read_memory( &semperflash, ADRESS_MEMORY, read_buf_data, 12 ) );
       log_printf( &logger, "%s\r\n", read_buf_data );
       txt_flag = COMPANY_FLAG;
    }

    log_printf( &logger, "....................\r\n" );
    Delay_ms( 2000 );
}

void main ( )
{
    application_init( );

    for ( ; ; )
    {
        application_task( );
    }
}

// ------------------------------------------------------------------------ END

Additional Support

Resources

Love this project?

'Buy This Kit' button takes you directly to the shopping cart where you can easily add or remove products.