User’s Manual
All information contained in these materials, including products and product specifications,
represents information on the product at the time of publication and is subject to change by
Renesas Electronics Corp. without notice. Please review the latest information published by
Renesas Electronics Corp. through various means, including the Renesas Electronics Corp.
website (http://www.renesas.com).
Rev.1.03 Dec 2014
16
www.renesas.com
RL78 Family
Flash Self-Programming Library Type01
Japanese Release
ZIP file name : JP_R_FSL_RL78_T01
_
Vx.xx_x_E
16-Bit Single-Chip Microcontrollers
Notice
1. Descriptions of circuits, software and other related information in this document are provided only to illustrate the operation of
semiconductor products and application examples. You are fully responsible for the incorporation of these circuits, software,
and information in the design of your equipment. Renesas Electronics assumes no responsibility for any losses incurred by you
or third parties arising from the use of these circuits, software, or information.
2. Renesas Electronics has used reasonable care in preparing the information included in this document, but Renesas Electronics
does not warrant that such information is error free. Renesas Electronics assumes no liability whatsoever for any damages
incurred by you resulting from errors in or omissions from the information included herein.
3. Renesas Electronics does not assume any liability for infringement of patents, copyrights, or other intellectual property rights of
third parties by or arising from the use of Renesas Electronics products or technical information described in this document. No
license, express, implied or otherwise, is granted hereby under any patents, copyrights or other intellectual property rights of
Renesas Electronics or others.
4. You should not alter, modify, copy, or otherwise misappropriate any Renesas Electronics product, whether in whole or in part.
Renesas Electronics assumes no responsibility for any losses incurred by you or third parties arising from such alteration,
modification, copy or otherwise misappropriation of Renesas Electronics product.
5. Renesas Electronics products are classified according to the following two quality grades: “Standard” and “High Quality”. The
recommended applications for each Renesas Electronics product depends on the product’s quality grade, as indicated below.
“Standard”: Computers; office equipment; communications equipment; test and measurement equipment; audio and visual
equipment; home electronic appliances; machine tools; personal electronic equipment; and industrial robots etc.
“High Quality”: Transportation equipment (automobiles, trains, ships, etc.); traffic control systems; anti-disaster systems; anti-
crime systems; and safety equipment etc.
Renesas Electronics products are neither intended nor authorized for use in products or systems that may pose a direct threat to
human life or bodily injury (artificial life support devices or systems, surgical implantations etc.), or may cause serious property
damages (nuclear reactor control systems, military equipment etc.). You must check the quality grade of each Renesas
Electronics product before using it in a particular application. You may not use any Renesas Electronics product for any
application for which it is not intended. Renesas Electronics shall not be in any way liable for any damages or losses incurred
by you or third parties arising from the use of any Renesas Electronics product for which the product is not intended by Renesas
Electronics.
6. You should use the Renesas Electronics products described in this document within the range specified by Renesas Electronics,
especially with respect to the maximum rating, operating supply voltage range, movement power voltage range, heat radiation
characteristics, installation and other product characteristics. Renesas Electronics shall have no liability for malfunctions or
damages arising out of the use of Renesas Electronics products beyond such specified ranges.
7. Although Renesas Electronics endeavors to improve the quality and reliability of its products, semiconductor products have
specific characteristics such as the occurrence of failure at a certain rate and malfunctions under certain use conditions. Further,
Renesas Electronics products are not subject to radiation resistance design. Please be sure to implement safety measures to
guard them against the possibility of physical injury, and injury or damage caused by fire in the event of the failure of a Renesas
Electronics product, such as safety design for hardware and software including but not limited to redundancy, fire control and
malfunction prevention, appropriate treatment for aging degradation or any other appropriate measures. Because the evaluation
of microcomputer software alone is very difficult, please evaluate the safety of the final products or systems manufactured by
you.
8. Please contact a Renesas Electronics sales office for details as to environmental matters such as the environmental compatibility
of each Renesas Electronics product. Please use Renesas Electronics products in compliance with all applicable laws and
regulations that regulate the inclusion or use of controlled substances, including without limitation, the EU RoHS Directive.
Renesas Electronics assumes no liability for damages or losses occurring as a result of your noncompliance with applicable laws
and regulations.
9. Renesas Electronics products and technology may not be used for or incorporated into any products or systems whose
manufacture, use, or sale is prohibited under any applicable domestic or foreign laws or regulations. You should not use
Renesas Electronics products or technology described in this document for any purpose relating to military applications or use
by the military, including but not limited to the development of weapons of mass destruction. When exporting the Renesas
Electronics products or technology described in this document, you should comply with the applicable export control laws and
regulations and follow the procedures required by such laws and regulations.
10. It is the responsibility of the buyer or distributor of Renesas Electronics products, who distributes, disposes of, or otherwise
places the product with a third party, to notify such third party in advance of the contents and conditions set forth in this
document, Renesas Electronics assumes no responsibility for any losses incurred by you or third parties as a result of
unauthorized use of Renesas Electronics products.
11. This document may not be reproduced or duplicated in any form, in whole or in part, without prior written consent of Renesas
Electronics.
12. Please contact a Renesas Electronics sales office if you have any questions regarding the information contained in this document
or Renesas Electronics products, or if you have any other inquiries.
(Note 1) “Renesas Electronics” as used in this document means Renesas Electronics Corporation and also includes its majority-
owned subsidiaries.
(Note 2) “Renesas Electronics product(s)” means any product developed or manufactured by or for Renesas Electronics.
(2012.4)
General Precautions in the Handling of MPU/MCU Products
The following usage notes are applicable to all MPU/MCU products from Renesas. For detailed usage notes on the
products covered by this document, refer to the relevant sections of the document as well as any technical updates that
have been issued for the products.
1. Handling of Unused Pins
Handle unused pins in accordance with the directions given under Handling of Unused Pins in the
manual.
⎯ The input pins of CMOS products are generally in the high-impedance state. In operation with an
unused pin in the open-circuit state, extra electromagnetic noise is induced in the vicinity of LSI, an
associated shoot-through current flows internally, and malfunctions occur due to the false
recognition of the pin state as an input signal become possible. Unused pins should be handled as
described under Handling of Unused Pins in the manual.
2. Processing at Power-on
The state of the product is undefined at the moment when power is supplied.
⎯ The states of internal circuits in the LSI are indeterminate and the states of register settings and
pins are undefined at the moment when power is supplied.
In a finished product where the reset signal is applied to the external reset pin, the states of pins
are not guaranteed from the moment when power is supplied until the reset process is completed.
In a similar way, the states of pins in a product that is reset by an on-chip power-on reset function
are not guaranteed from the moment when power is supplied until the power reaches the level at
which resetting has been specified.
3. Prohibition of Access to Reserved Addresses
Access to reserved addresses is prohibited.
⎯ The reserved addresses are provided for the possible future expansion of functions. Do not access
these addresses; the correct operation of LSI is not guaranteed if they are accessed.
4. Clock Signals
After applying a reset, only release the reset line after the operating clock signal has become stable.
When switching the clock signal during program execution, wait until the target clock signal has
stabilized.
⎯ When the clock signal is generated with an external resonator (or from an external oscillator)
during a reset, ensure that the reset line is only released after full stabilization of the clock signal.
Moreover, when switching to a clock signal produced with an external resonator (or by an external
oscillator) while program execution is in progress, wait until the target clock signal is stable.
5. Differences between Products
Before changing from one product to another, i.e. to a product with a different part number, confirm
that the change will not lead to problems.
⎯ The characteristics of an MPU or MCU in the same group but having a different part number may
differ in terms of the internal memory capacity, layout pattern, and other factors, which can affect
the ranges of electrical characteristics, such as characteristic values, operating margins, immunity
to noise, and amount of radiated noise. When changing to a product with a different part number,
implement a system-evaluation test for the given product.
HOW TO USE THIS MANUAL
Readers This manual is intended for user engineers who wish to understand the functions of the
RL78 microcontrollers Flash Self-Programming Library Type 01 and design and develop
application systems and programs for these devices.
Refer to the following list for the target MCUs.
Self-Programming Library (Japanese Release) and Supported MCUs (R20UT2861XJxxxx)
Purpose This manual is intended to give users an understanding of the methods (described in the
Organization below) for using flash self-programming library to rewrite the code flash
memories.
Organization The RL78 Flash Self-programming Library Type 01 user’s manual is separated into the
following parts:
Overview
Programming Environment
Interrupts During Execution of Flash Self-programming
Security Setting
Boot Swap Function
Flash Self-Programming Function
How to Read This Manual It is assumed that the readers of this manual have general knowledge of electrical
engineering, logic circuits, and microcontrollers.
To gain a general understanding of functions:
Read this manual in the order of the CONTENTS.
To know details of the RL78 Microcontroller instructions:
Refer to CHAPTER 6 FLASH FUNCTION.
Conventions Data significance: Higher digits on the left and lower digits on the right
Active low representations: (overscore over pin and signal name)
Note: Footnote for item marked with Note in the text
Caution: Information requiring particular attention
Remark: Supplementary information
Numerical representations: Binary
...
or B
Decimal
...
Hexadecimal
...
H
All trademarks and registered trademarks are the property of their respective owners.
EEPROM is a trademark of Renesas Electronics Corporation.
Index-1
CONTENTS
CHAPTER 1 OVERVIEW .............................................................................................. 1
1. 1 Overview ....................................................................................................................................... 1
1. 2 Calling Flash Self-Programming Library ....................................................................................... 3
CHAPTER 2 PROGRAMMING ENVIRONMENT .......................................................... 9
2. 1 Hardware Environment ................................................................................................................. 9
2. 1. 1 Initialization .................................................................................................................... 12
2. 1. 2 Blocks ............................................................................................................................ 12
2. 1. 3 Processing time of flash self-programming ................................................................... 14
2. 2 Software Environment ................................................................................................................. 24
2. 2. 1 Self-RAM ....................................................................................................................... 28
2. 2. 2 Register bank ................................................................................................................ 28
2. 2. 3 Stack and data buffer .................................................................................................... 28
2. 2. 4 Flash self-programming library ...................................................................................... 29
2. 2. 5 Program area ................................................................................................................ 29
2. 2. 6 ROMization of programs ............................................................................................... 29
2. 3 Cautions on Programming Environment ..................................................................................... 30
CHAPTER 3 INTERRUPTS DURING EXECUTION OF FLASH
SELF-PROGRAMMING ............................................................................................... 32
3. 1 Overview ..................................................................................................................................... 32
3. 2 Interrupts During Execution of Flash Self-Programming ............................................................ 32
3. 3 Cautions on Interrupts ................................................................................................................. 33
CHAPTER 4 SECURITY SETTING ............................................................................. 34
4. 1 Security Flag ............................................................................................................................... 34
4. 2 Flash Shield Window Function.................................................................................................... 34
CHAPTER 5 BOOT SWAP FUNCTION ...................................................................... 35
5. 1 Overview ..................................................................................................................................... 35
5. 2 Boot Swap Function .................................................................................................................... 35
5. 3 Boot Swapping Procedure .......................................................................................................... 36
5. 4 Cautions on Boot Swapping ........................................................................................................ 41
CHAPTER 6 FLASH FUNCTION ................................................................................. 42
6. 1 Type of Flash Functions .............................................................................................................. 42
6. 2 Segments of Flash Functions ..................................................................................................... 43
6. 3 Interrupts and BGO (background operation) .............................................................................. 45
6. 4 Status Check Mode ..................................................................................................................... 46
6. 4. 1 Status Check User Mode .............................................................................................. 48
6. 5 Pausing of Flash Self-Programming ........................................................................................... 50
6. 6 List of Data Types, Return Values, and Return Types ................................................................ 52
