UM2481
User manual
Getting started with the X-CUBE-EEPRMA1 software expansion for STM32Cube
Introduction
The X-CUBE-EEPRMA1 software expansion for STM32Cube provides an evaluation software example for M24XX I²C and
M95XX SPI EEPROMs.
The package is built on STM32Cube software technology to ease portability across different STM32 microcontrollers.
The software comes with sample implementations of the drivers running on the X-NUCLEO-EEPRMA1 and X-NUCLEO-
EEPRMA2 expansion boards connected to the featured development boards.
RELATED LINKS
Visit the STM32Cube ecosystem web page on www.st.com for further information
UM2481 - Rev 3 - Octo ber 2020
For further information contact your local STMicroelectronics sales office.
www.st.com
1 Acronyms and abbreviations
Acronym
BSP
CMSIS
HAL
I2C
SPI
Table 1. List of acronyms
Description
Board support package
Cortex ® microcontroller software interface standard
Hardware abstraction layer
Inter integrated circuit
Serial peripheral interface
UM2481
Acronyms and abbreviations
UM2481 - Rev 3 page 2/14
2
2.1
2.2
UM2481
X-CUBE-EEPRMA1 software expansion for STM32Cube
X-CUBE-EEPRMA1 software expansion for STM32Cube
Overview
•
•
•
The X-CUBE-EEPRMA1 software package key features are:
• Complete software to build applications using M24XX or M95XX-based EEPROM
• Sample implementation available on the X-NUCLEO-EEPRMA1 and X-NUCLEO-EEPRMA2 expansion boards plugged to a NUCLEO-F401RE , NUCLEO-G474RE or NUCLEO-L053R8 development board
Easy portability across different MCU families thanks to
Free user-friendly license terms
Package compatible with
STM32CubeMX
STM32CubeMX
STM32Cube
, can be downloaded from and directly installed into
Architecture
The software is based on the STM32CubeHAL hardware abstraction layer for the STM32 microcontroller and extends STM32Cube by providing a board support package (BSP) for the X-NUCLEO-EEPRMA1 and X-
NUCLEO-EEPRMA2 expansion boards.
The software layers used by the application software to access and use the board are:
• STM32Cube HAL layer interfaces) to interact with the upper layers (application, libraries and stacks). It is composed of generic and extension APIs.
: provides a generic, multi-instance set of simple APIs (application programming
• Board support package (BSP) layer : supports the peripherals on the STM32 Nucleo board, except for the
MCU. This limited set of APIs provides a programming interface for certain board specific peripherals (like the user button, the reset button, etc.) and helps in identifying the specific board version.
Figure 1. X-CUBE-EEPRMA1 software architecture
Application Examples
Hardware
Abstraction
STM32Cube Hardware Abstraction Layer (HAL)
Hardware
STM32 Nucleo expansion boards
X-NUCLEO-EEPRMA1/X-NUCLEO-EEPRMA2 (Connect)
STM32 Nucleo development board
UM2481 - Rev 3 page 3/14
2.3
Folder structure
Figure 2. X-CUBE-EEPRMA1 package folder structure
UM2481
Folder structure
2.4
The software is packaged in the following main folders:
• Documentation : with a compiled HTML file generated from the source code that details the software components and APIs.
• Drivers : contains the HAL drivers, the board specific drivers for each supported board or hardware platform, including the on-board components ones and the CMSIS layer which is a vendor-independent hardware abstraction layer for the Cortex-M processor series.
• Projects : contains sample application used for the NUCLEO-L053R8 , NUCLEO-G474RE and the NUCLEO-
F401RE platforms with three development environments: IAR Embedded Workbench for ARM, RealView
Microcontroller Development Kit (MDK-ARM), and STM32CubeIDE .
APIs
Detailed function and parameter descriptions for the user-APIs are compiled in an HTML file in the software package Documentation folder.
UM2481 - Rev 3 page 4/14
UM2481
System setup guide
3
3.1
3.1.1
System setup guide
Hardware description
STM32 Nucleo
STM32 Nucleo development boards provide an affordable and flexible way for users to test solutions and build prototypes with any STM32 microcontroller line.
The Arduino™ connectivity support and ST morpho connectors make it easy to expand the functionality of the
STM32 Nucleo open development platform with a wide range of specialized expansion boards to choose from.
The STM32 Nucleo board does not require separate probes as it integrates the ST-LINK/V2-1 debugger/ programmer.
The STM32 Nucleo board comes with the comprehensive STM32 software HAL library together with various packaged software examples for different IDEs (IAR EWARM, Keil MDK-ARM, STM32CubeIDE , mbed and GCC/
LLVM).
All STM32 Nucleo users have free access to the mbed online resources (compiler, C/C++ SDK and developer community) at www.mbed.org to easily build complete applications.
Figure 3. STM32 Nucleo board
3.1.2
Information regarding the STM32 Nucleo board is available at www.st.com/stm32nucleo
X-NUCLEO-EEPRMA1 expansion board
The X-NUCLEO-EEPRMA1 expansion board is designed for M24xx series I²C and M95xx series SPI EEPROM for data reading and writing.
The expansion board acts as an external storage device that can be used to store data such as manufacturing traceability, calibration, user setting, error flags, data log and monitoring data to make applications more flexible and accurate.
UM2481 - Rev 3 page 5/14
UM2481
Hardware description
The X-NUCLEO-EEPRMA1 expansion board is compatible with the Arduino UNO R3 connector pin assignment and can be easily plugged to any STM32 Nucleo development board. You can mount the ST morpho connectors if required.
Figure 4. X-NUCLEO-EEPRMA1 expansion board
3.1.3
X-NUCLEO-EEPRMA2 expansion board
The X-NUCLEO-EEPRMA2 expansion board is designed for M24xx series I²C and M95xx series SPI EEPROM for data reading and writing.
The expansion board acts as an external storage device that can be used to store data such as manufacturing traceability, calibration, user settings, error flags, data logs and monitoring data to make applications more flexible and accurate.
The X-NUCLEO-EEPRMA2 expansion board is compatible with the Arduino UNO R3 connector pin assignment and can be easily plugged to any STM32 Nucleo development board. You can mount the ST morpho connectors if required.
UM2481 - Rev 3 page 6/14
Figure 5. X-NUCLEO-EEPRMA2 expansion board
UM2481
Hardware setup
3.2
3.2.1
Hardware setup
The following hardware components are needed:
1.
One STM32 Nucleo development platform ( NUCLEO-F401RE , NUCLEO-G474RE or NUCLEO-L053R8 )
2.
One X-NUCLEO-EEPRMA1 or X-NUCLEO-EEPRMA2 expansion board
3.
One USB type A to Mini-B USB cable to connect the STM32 Nucleo to the PC
STM32 Nucleo and X-NUCLEO-EEPRMA1/X-NUCLEO-EEPRMA2 expansion board setup
The STM32 Nucleo board integrates the ST-LINK/V2-1 debugger/programmer.
The developer can freely download the ST-LINK/V2-1 from www.st.com.
The X-NUCLEO-EEPRMA1 or X-NUCLEO-EEPRMA2 expansion board can be easily connected to the STM32
Nucleo through the Arduino UNO R3 extension connector as shown below.
UM2481 - Rev 3 page 7/14
UM2481
Software setup
Figure 6. X-NUCLEO-EEPRMA1 expansion board plugged to an STM32 Nucleo board
3.3
Software setup
The following software components are needed for a suitable development environment for creating applications for the STM32 Nucleo equipped with the X-NUCLEO-EEPRMA1 or X-NUCLEO-EEPRMA2 expansion board:
• X-CUBE-EEPRMA1 expansion for
EEPRMA2 expansion boards.
STM32Cube that supports X-NUCLEO-EEPRMA1 and X-NUCLEO-
• One of the following development tool-chain and compilers:
– Keil RealView Microcontroller Development Kit ( MDK-ARM-STR ) + ST-LINK
– IAR Embedded Workbench for ARM (EWARM) + ST-LINK
– Integrated Development Environment for STM32 ( STM32CubeIDE ) + ST-LINK
The package includes the following firmware examples for the developer to start experimenting with the code:
1.
a standard initialization of the I²C and SPI EEPROM
2.
a firmware example containing:
– block protect, which reads the status after "write enable" and "write disable" for the SPI EEPROM
– write protection feature for the I²C EEPROM
3.
a firmware example that writes the complete memory and reads the information received
UM2481 - Rev 3 page 8/14
Figure 7. Console log
UM2481
Software setup
UM2481 - Rev 3 page 9/14
UM2481
Revision history
Table 2. Document revision history
Date
04-Oct-2018
Version Changes
1 Initial release.
20-Apr-2020
13 Oct -2020
2
3
Updated Introduction, Section 2.1 Overview, Figure 1. X-CUBE-EEPRMA1 software architecture,
Section 3.2 Hardware setup, Section 3.2.1 STM32 Nucleo and X-NUCLEO-EEPRMA1/X-
NUCLEOEEPRMA2 expansion board setup and Section 3.3 Software setup.
Added Section 3.1.3 X-NUCLEO-EEPRMA2 expansion board.
Removed Section 2. What is STM32Cube and replaced it by a link in the Introduction.
Updated
Section 2.1 Overview and
Section 3.3 Software setup .
UM2481 - Rev 3 page 10/14
UM2481
Contents
Contents
1 Acronyms and abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
2 X-CUBE-EEPRMA1 software expansion for STM32Cube . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
2.1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2
Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.3
Folder structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.4
APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3 System setup guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
3.1
Hardware description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.1
3.1.2
STM32 Nucleo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
X-NUCLEO-EEPRMA1 expansion board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.3
X-NUCLEO-EEPRMA2 expansion board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.2
Hardware setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2.1
STM32 Nucleo and X-NUCLEO-EEPRMA1/X-NUCLEO-EEPRMA2 expansion board setup
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.3
Software setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
UM2481 - Rev 3 page 11/14
UM2481
List of tables
List of tables
Table 1. List of acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Table 2. Document revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
UM2481 - Rev 3 page 12/14
UM2481
List of figures
List of figures
Figure 1. X-CUBE-EEPRMA1 software architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Figure 2. X-CUBE-EEPRMA1 package folder structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Figure 3. STM32 Nucleo board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Figure 4. X-NUCLEO-EEPRMA1 expansion board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Figure 5. X-NUCLEO-EEPRMA2 expansion board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Figure 6. X-NUCLEO-EEPRMA1 expansion board plugged to an STM32 Nucleo board . . . . . . . . . . . . . . . . . . . . . . . . 8
Figure 7. Console log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
UM2481 - Rev 3 page 13/14
UM2481
IMPORTANT NOTICE – PLEASE READ CAREFULLY
STMicroelectronics NV and its subsidiaries (“ST”) reserve the right to make changes, corrections, enhancements, modifications, and improvements to ST products and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST products before placing orders. ST products are sold pursuant to ST’s terms and conditions of sale in place at the time of order acknowledgement.
Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or the design of
Purchasers’ products.
No license, express or implied, to any intellectual property right is granted by ST herein.
Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product.
ST and the ST logo are trademarks of ST. For additional information about ST trademarks, please refer to www.st.com/trademarks . All other product or service names are the property of their respective owners.
Information in this document supersedes and replaces information previously supplied in any prior versions of this document.
© 2020 STMicroelectronics – All rights reserved
UM2481 - Rev 3 page 14/14
