eeram3

---

EERAM 3 Click

EERAM 3 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

---

Click Library

• Author : Stefan Filipovic
• Date : Sep 2021.
• Type : SPI type

Software Support

Example Description

This example demonstrates the use of EERAM 3 Click board.

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.EERAM3

Example Key Functions

• eeram3_cfg_setup Config Object Initialization function.

void eeram3_cfg_setup ( eeram3_cfg_t *cfg );

• eeram3_init Initialization function.

err_t eeram3_init ( eeram3_t *ctx, eeram3_cfg_t *cfg );

• eeram3_default_cfg Click Default Configuration function.

void eeram3_default_cfg ( eeram3_t *ctx );

• eeram3_memory_secure_write This function securely writes a desired number of data bytes starting from the selected memory address.

err_t eeram3_memory_secure_write ( eeram3_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len );

• eeram3_memory_secure_read This function securely reads a desired number of data bytes starting from the selected memory address.

err_t eeram3_memory_secure_read ( eeram3_t *ctx, uint16_t address, uint8_t *data_out, uint8_t len );

• eeram3_set_block_protection This function sets the block protection bits of the Status register.

err_t eeram3_set_block_protection ( eeram3_t *ctx, uint8_t block_protect );

Application Init

Initializes the driver and performs the Click default configuration.

void application_init ( void )
{
    log_cfg_t log_cfg;        /**< Logger config object. */
    eeram3_cfg_t eeram3_cfg;  /**< Click config object. */

    /** 
     * 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 " );

    // Click initialization.
    eeram3_cfg_setup( &eeram3_cfg );
    EERAM3_MAP_MIKROBUS( eeram3_cfg, MIKROBUS_1 );
    
    if ( SPI_MASTER_ERROR == eeram3_init( &eeram3, &eeram3_cfg ) )
    {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );
        for ( ; ; );
    }
    eeram3_default_cfg ( &eeram3 );
    log_info( &logger, " Application Task " );
}

Application Task

Writes a desired number of bytes to the memory and then verifies that it's written correctly by reading from the same memory location and displaying the memory content on the USB UART.

void application_task ( void )
{
    uint8_t data_buf[ 64 ] = { 0 };
    if ( EERAM3_OK == eeram3_memory_secure_write ( &eeram3, STARTING_ADDRESS, 
                                                   DEMO_TEXT_MESSAGE, strlen ( DEMO_TEXT_MESSAGE ) ) )
    {
        log_printf ( &logger, "Data written to address 0x%.4X: %s\r\n", ( uint16_t ) STARTING_ADDRESS, 
                                                                          ( char * ) DEMO_TEXT_MESSAGE );
    }
    Delay_ms ( 100 );

    if ( EERAM3_OK == eeram3_memory_secure_read ( &eeram3, STARTING_ADDRESS, 
                                                  data_buf, strlen ( DEMO_TEXT_MESSAGE ) ) )
    {
        log_printf ( &logger, "Data read from address 0x%.4X: %s\r\n\n", ( uint16_t ) STARTING_ADDRESS, 
                                                                                      data_buf );
    }
    Delay_ms ( 1000 );
}

Application Output

This Click board can be interfaced and monitored in two ways:

• Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
• UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

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.

---