User`s manual

RX600 & RX200 Series Simple Flash API for RX
R01AN0544EU0250 Rev.2.50 Page 3 of 33
March 4, 2014
2. API Information
This Middleware API follows the Renesas API naming standards.
2.1 Hardware Requirements
This middleware requires your MCU support the following features:
• Flash with background operation feature (all RX600 & RX200 Series MCUs feature this)
• Clock speed supplied to Flash Control Unit must be greater than or equal to 4MHz
2.2 Hardware Resource Requirements
This section details the hardware peripherals that this middleware requires. Unless explicitly stated, these resources
must be reserved for the middleware and the user cannot use them.
2.2.1 Flash Control Unit (FCU)
The FCU takes care of programming and erasing internal memory. This middleware uses the FCU and therefore should
not be used by the middleware user.
2.3 Software Requirements
This driver is dependent upon the following packages:
• Renesas Board Support Package (r_bsp) v2.40 or higher.
2.4 Supported Toolchains
This middleware is tested and working with the following toolchains:
• Renesas RX Toolchain v1.02.01
• Renesas RX Toolchain v2.01.00
2.5 Header Files
All API calls are accessed by including a single file r_flash_api_rx_if.h which is supplied with this middleware’s
project code.
2.6 Integer Types
This project uses ANSI C99 “Exact width integer types” in order to make the code clearer and more portable. These
types are defined in stdint.h.
2.7 Configuration Overview
Configuring this middleware is done through the supplied r_flash_api_rx_config.h header file. Each configuration item
is represented by a macro definition in this file. Each configurable item is detailed in the table below.
Configuration Options in r_flash_api_rx_config.h
FLASH_API_RX_CFG_
ENABLE_ROM_PROGRAMMING
If defined then ROM programming is enabled and code required
for this operation is copied to RAM. If undefined then only data
flash operations are available and all code will be located in ROM.
FLASH_API_RX_CFG_FLASH_TO_FLASH
If defined then ROM to ROM and data flash to data flash
operations will be enabled. When enabled the Flash API will
require a RAM buffer to hold the data to be programmed. The size
of the RAM buffer will be maximum number of bytes between the
programming size of the data flash and ROM.