User's Manual

CubeSuite+
Partner OS Aware Debugging Plug-in
User's ManualTarget Device
RL78 Family
RX Family
For the latest information on operating environments refer to the page below.
Operating Environments of Products
http://www.renesas.com/products/tools/sub/tool_system_requirements.jsp

All information contained in these matenals, including products and product specifications,represents information on the product at the time of publication and is subject to change byRenesas Electronics Corp. without notice. Please review the latest information published byRenesas Electronics Corp. through various means, including the Renesas Electronics Corp.
website (http://www.renesas.com).

www.renesas.com

Rev.1.00

Oct 2012

Notice1.

Descriptions of circuits, software and other related information in this document are provided only to illustrate the operation ofsemiconductor 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 youor 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 ofthird 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 ofRenesas 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 visualequipment; 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; anticrime 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 tohuman 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 incurredby 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 havespecific 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 toguard 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 andmalfunction prevention, appropriate treatment for aging degradation or any other appropriate measures. Because the evaluationof 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 compatibilityof each Renesas Electronics product. Please use Renesas Electronics products in compliance with all applicable laws andregulations 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 andregulations 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 thisdocument, 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 majorityowned subsidiaries.
(Note 2) “Renesas Electronics product(s)” means any product developed or manufactured by or for Renesas Electronics.
(2012.4)

How to Use This Manual

Readers

This manual is intended for users who are using RL78 Family and RX Family in thedesign and development of application systems.

PurposeThis manual is intended to bring users to understand the functions of the CubeSuite+
Partner OS Aware Debugging Plug-in, and its organization is as listed below.

Organization

This manual consists of the following major sections.
CHAPTER 1 GENERALCHAPTER 2 FUNCTIONSAPPENDIX A WINDOW REFERENCEAPPENDIX B Messages
APPENDIX C Notes

How to Read This Manual

It is assumed that the readers of this manual have general knowledge in the fields ofelectrical engineering, logic circuits, microcontrollers, the C language, and assembly
languages.
To understand the hardware functions of the RL78 Family or RX Family-> Refer to the User's Manual for the given product.

Conventions

Data significance:

The higher-order digits are to the left and the lower-order
digits are to the right

Note:

Footnotes for items marked with "Note" in the text

Caution:Information requiring particular attention

Remark:Supplementary information

Numeric representation:

DecimalXXXXHexadecimal

0xXXXX

Prefixes indicating powers of 2 (for address spaces and memory capacities):
K (kilo) 210 = 1024
M (mega) 220 = 10242

All trademarks or registered trademarks in this document are the property of their respective owners.
uC/OS-III is a trademark of Micrium, Inc.
embOS is a trademark of SEGGER Microcontroller Systems.
UCT uT-Kernel DevKit tuned is a trademark of Ubiquitous Computing Technology Corporation.
NORTi is a registered trademark of MiSPO Co., Ltd.
Smalight is a registered trademark of Renesas Northern Japan Semiconductor, Inc.
T-Engine Forum holds the copyright on the uT-Kernel specifications.

TABLE OF CONTENTS

CHAPTER 1 GENERAL ... 6
1.1 Overview ... 6
1.2 Features ... 6
1.3 Operation Environment ... 7

CHAPTER 2 FUNCTIONS ... 8
APPENDIX A WINDOW REFERENCE ... 10
A.1 Description ... 10

APPENDIX B Messages ... 17
B.1 Fatal Error ... 17
B.2 Warning ... 17

APPENDIX C Notes ... 18
C.1 Cautionary Notes ... 18

Partner OS Aware Debugging Plug-in

CHAPTER 1 GENERALCHAPTER 1 GENERALCubeSuite+ is an integrated development environment for use in tasks such as design, coding, building and debugging
in the development of application systems for microcontrollers manufactured by Renesas Electronics.
This manual describes the tool, which is useful for debugging programs that employ real-time OS from a Renesas partner functionality within this integrated program-development process.

1.1

Overview

The Partner OS Aware Debugging Plug-in is an optional product for extending the debugging capabilities of CubeSuite+, and is only for use within CubeSuite+. When debugging a program that has real-time OS functionality, the resource
information tool of Partner OS Aware Debugging Plug-in can be used to confirm information on real-time OS resources(i.e. system information and task information) that change dynamically over time during program execution.
Figure 1-1. CubeSuite+ Partner OS Aware Debugging Plug-in

1.2

Features

The features of the CubeSuite+ Partner OS Aware Debugging Plug-in are listed below.
- Information from the CubeSuite+ Partner OS Aware Debugging Plug-in can be used to confirm information on
resources
The Resource Information pane of the Partner OS Aware Debugging Plug-in displays the current states ofresource information for programs running within the debugging tool.

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 6 of 22

Partner OS Aware Debugging Plug-in
1.3

CHAPTER 1 GENERAL

Operation Environment

The features of the CubeSuite+ Partner OS Aware Debugging Plug-in are listed below.
- Real-time operating systems
Table 1-1. Supported Real-Time Operating Systems
Real-time OS

RL78 Family

RX Family

VersionuC/OS-III from Micrium, Inc.

-

x

V3.02

embOS from SEGGER Microcontroller Systems.

-xVersion 3.84

UCT uT-Kernel DevKit tuned for RX62N-CubeSuite+-x

Version 1.01.01

NORTi from MiSPO Co., Ltd.

-x

Version 4 Release 4.4

Smalight OS from Renesas Northern Japan Semicon-

x

x

V3.10

from Ubiquitous Computing Technology Corporation

ductor, Inc.

- Integrated Development Environment
CubeSuite+ V1.03- Debugger
Simulator, on-chip debugging emulator (E1, E20)
- Compilers
Compilers from Renesas Electronics Corporation- PC
PC running on Windows 7(R), Windows Vista(R), Windows(R) XP
Other conditions comply with the operating environment of CubeSuite+.

For the latest information on operating environments refer to the page below.
Operating Environments of Products
http://www.renesas.com/products/tools/sub/tool_system_requirements.jsp

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 7 of 22

Partner OS Aware Debugging Plug-in

CHAPTER 2 FUNCTIONSCHAPTER 2 FUNCTIONSThis chapter describes the key functions provided by the Partner OS Aware Debugging Plug-in along with the operatingprocedures.
(1) Start CubeSuite+
Launch CubeSuite+ from the [Start] menu of Windows.
(2) Opening a projectOpen the project for debugging.
(3) Selecting the debugging tool
Select the type of debugging tool with which to debug the program.
(4) Downloading a program
Download the program for debugging.
(5) Selecting the real-time OS
When a program is downloaded, the [Select OS] Dialog Box is automatically displayed. At this time, select the realtime OS you are using.
Figure 2-1. [Select OS] Dialog Box(6) Executing/stopping a program
Run the program and then stop it at the location for which you wish to display resource information from the CubeSuite+ Partner OS Aware Debugging Plug-in.
(7) Confirm the Resource Information from the Partner OS Aware Debugging Plug-in
Select [View] menu -> [Realtime OS] -> [Resource Information] to open the Resource Information pane.

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 8 of 22

Partner OS Aware Debugging Plug-in

CHAPTER 2 FUNCTIONS

Figure 2-2. [Resource Information] Pane

RemarkFor details on working with CubeSuite+, refer to the user's manual or help system for CubeSuite+.

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 9 of 22

Partner OS Aware Debugging Plug-in

APPENDIX A WINDOW REFERENCEAPPENDIX A WINDOW REFERENCE
A.1

Description

The pane for the Partner OS Aware Debugging Plug-in is described.
Table A-1. Pane for the Plug-in
Name of Pane
Resource Information pane

Description
This pane displays information on the usage of resources (i.e. system information andtask information) by the real-time OS.

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 10 of 22

Partner OS Aware Debugging Plug-in

APPENDIX A WINDOW REFERENCE

Resource Information pane
This pane displays information on the usage of resources (i.e. system information and task information) by the real-timeOS.
Add further items for display as required by selecting [Add new resource] in the context menu.
Items that can be displayed vary according to the real-time OS.
Figure A-1. [Resource Information] PaneThe following items are explained here.
- Opening the pane
- Displayed items- [File] Menu
- [Edit] Menu
- Context Menu

Opening the pane
- From the [View] menu, select [Realtime OS]->[Resource Information].

Displayed items

Name of Header

Description

Resource

Resource type (e.g. Task, Semaphore)

ID

Resource ID

Name

Symbolic name of the address where a task or handler starts, or the name of a resource

TypeType of resource information, such as "status" and the number of resources

Value

Value of resource information

Address

Address where the value is stored

Size

Size of the value

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 11 of 22

Partner OS Aware Debugging Plug-in

APPENDIX A WINDOW REFERENCE[File] Menu
When the [File] menu of CubeSuite+ is selected while the resource information pane is active, the following items are
displayed for the Resource Information pane.
Name of Menu
Save Resource Data

Description
Save the data in the text file (*.txt) in which the context of the pane was previously saved.
Note that when this item is selected for the first time after booting-up, the operation is thesame as when selecting [Save Resource Data As ...].
This item is invalid while the program is running.

Save Resource Data As ...

Selecting this item opens [Save as ...] dialog box for saving the context of the pane in a
specified text file (*.txt).
This item is invalid while the program is running.

[Edit] Menu
When the [Edit] menu of CubeSuite+ is selected while the resource information pane is active, the following items are
displayed in the resource information pane.
Name of Menu
DeleteDescription
Delete an item selected in the pane.
This item is invalid if nothing is selected.
This item is invalid while the program is running.

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 12 of 22

Partner OS Aware Debugging Plug-in

APPENDIX A WINDOW REFERENCE

Context Menu
The context menu is displayed by right-clicking the mouse on the resource information pane.
Name of Menu

Description

Real-time display update

Selecting this item opens the property pane for setting up updating of the real-time display.

setting

This item is invalid while a program is running.

Update information

Selecting this item updates the information.

Add new resource ...

Selecting this item allows registration of a new resource.
The [Select Resource] Dialog Box is displayed.
An added resource is displayed in the lowest line.
Note that the number of resources to be registered on a tabbed page is up to 1000.
This item is invalid while a program is running.

Edit resource ...

Selecting this item allows editing of the selected resource.
The [Select Resource] Dialog Box is displayed.
This item is invalid when nothing is selected, and when two or more items are selected.
This item is invalid while a program is running.

DeleteSelecting this item deletes the selected item in the pane.
This item is invalid when nothing is selected.
This item is invalid while a program is running.

Notation

The following cascaded menu is displayed for specification of the display's notation.
This item is invalid when nothing is selected.
This item is invalid while a program is running.

Jump to source

Automatic

Automatically set the notation of the selected item.

Hexadecimal

Display the selected item in hexadecimal.

Decimal

Display the selected item in decimal.

Selecting this item opens an editor pane in which the source code of the task or handler is displayed.
This item is invalid when nothing is selected, and when two or more items are selected.
This item is invalid while a program is running.

Select OS ...

Selecting this item opens the [Select OS] Dialog Box.
This item is invalid while a program is running.

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 13 of 22

Partner OS Aware Debugging Plug-in

APPENDIX A WINDOW REFERENCE[Select Resource] Dialog Box
This dialog box is for select the resource information to be displayed in the resource information pane. One ID number
or all of the ID numbers can be specified. The items selectable for a resource vary according to the real-time OS.
Figure A-2. [Select Resource] Dialog Box

The following items are explained here.
- Opening the box- Selected contents

Opening the box- Select [Add new resource] or [Edit resource] in the context menu of the Resource Information pane.

Selected contents
Selected item
Resource
ID number

Description
Selecting this item allows selection of the type of resource.

All

Selecting this item specifies all of the ID numbers.

SelectSelecting this item allows specification of an ID number.
Enter an ID number or click on the [Select] button to open the [Select ID] Dialog Box,then select an ID number from the list.

Type

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Selecting this item allows selection of a type of resource information.

Page 14 of 22

Partner OS Aware Debugging Plug-in

APPENDIX A WINDOW REFERENCE[Select ID] Dialog Box
Select a resource ID from the list.
Figure A-3. [Select ID] Dialog Box

The following items are explained here.
- Opening the Box

Opening the Box- Select the [Select] button in the [Select Resource] Dialog Box.

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 15 of 22

Partner OS Aware Debugging Plug-in

APPENDIX A WINDOW REFERENCE[Select OS] Dialog Box
Select the real-time OS that is to be used.
Figure A-4. [Select OS] Dialog Box

The following items are explained here.
- Opening the box

Opening the box- This dialog box is automatically opened when a program is downloaded.
- Select [Select OS] in the context menu of the Resource Information pane.

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 16 of 22

Partner OS Aware Debugging Plug-in

APPENDIX B Messages

APPENDIX B Messages
In this appendix, the messages output by the Partner OS Aware Debugging Plug-in are explained.
The messages are output to the output pane or in message boxes.

B.1

Fatal Error
Table B-1. Fatal Errors
Name

E1160020

E1160021

E1160022

E1160023

B.2

Description
Message

Failure to open a file.

Explanation

The plug-in was unable to open a file.

How to cope with

Confirm whether the file is or is not accessible.

Message

Failure to read a file.

Explanation

The plug-in was unable to read a file.

How to cope with

Confirm whether the file is or is not readable.

Message

Failure in writing to a file.

Explanation

The plug-in was unable to write to a file.

How to cope with

Confirm whether the file is or is not writable.

Message

Failure to close a file.

Explanation

The plug-in was unable to close a file.

How to cope with

Confirm whether the file is or is not accessible.

Warning
Table B-2. Warning
Name

W1160020

Description
Message

The maximum number of resources (one thousand) which can be registered on a tabbed
page of the resource information pane was exceeded.

Explanation

The upper limit on the number of resources which can be registered was exceeded. The
number of resources which can be registered on a tabbed page is up to one thousand.

How to cope with

Delete unnecessary resources or register some of the resources on other tabbed pages
so that the number on the given page is no greater than one thousand.

W1160021

W1160022

Message

There is not available resource that can be registered.

Explanation

The specified resource does not exist.

How to cope with

Specify valid resources.

Message

The specified ID number is invalid.

Explanation

The specified ID number does not exist.

How to cope with

Specify valid ID numbers.

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 17 of 22

Partner OS Aware Debugging Plug-in

APPENDIX C Notes

APPENDIX C Notes
This appendix contains cautionary notes.

C.1

Cautionary Notes
Table C-1. Cautionary Notes
Name
GeneralDescription
If the Partner OS Aware Debugging Plug-in is to be used, downloaded programs must have beenassembled or compiled with the output of debugging information.
The debugging function might not operate normally if the build options for the compiler or assembler inthe tool chain are changed from those provided for use with the OS.
Refer to the pane after initializing the real-time OS.
The pane might not be displayed normally while a program is running.

Smalight OS

The task ID "255" means idling of the OS kernel.

uT-Kernel

Be sure to set “1” to the minimum ID ( e.g. MIN_TSKID), the minimum priority (MIN_PRI), the debugger support function (USE_DBGSPT) and the object name (USE_OBJECT_NAME) in the configuration files (config.h and config.inc).

uC/OS

The debugging function might not operate normally if the contents of the configuration file (os_cfg.hand cpu_cfg.h) are changed from the initial values.
The task IDs displayed in this plug-in are internal IDs for debugging, and are different from the task
IDs of uC/OS.
The maximum task ID number displayable in the resource information pane is 255.

embOS

Task names are not displayed while the XR library is in use.
The task IDs displayed in this plug-in are internal IDs for debugging, and are different from the task
IDs of embOS.
The maximum task ID number displayable in the resource information pane is 255.

R20UT0946EJ0100 Rev.1.00
Oct 01, 2012

Page 18 of 22

Revision History
Description
Rev.

Date
Page

1.00

Oct 01, 2012-

Before Modification
First Edition issued

After Modification

CubeSuite+ Partner OS Aware Debugging Plug-in User's Manual
Publication Date: Rev.1.00
Published by:

Oct 01, 2012

Renesas Electronics Corporation

http://www.renesas.com

SALES OFFICES
Refer to "http://www.renesas.com/" for the latest and detailed information.
Renesas Electronics America Inc.
2880 Scott Boulevard Santa Clara, CA 95050-2554, U.S.A.
Tel: +1-408-588-6000, Fax: +1-408-588-6130
Renesas Electronics Canada Limited
1101 Nicholson Road, Newmarket, Ontario L3Y 9C3, Canada
Tel: +1-905-898-5441, Fax: +1-905-898-3220
Renesas Electronics Europe Limited
Dukes Meadow, Millboard Road, Bourne End, Buckinghamshire, SL8 5FH, U.K
Tel: +44-1628-651-700, Fax: +44-1628-651-804
Renesas Electronics Europe GmbH
Arcadiastrasse 10, 40472 Düsseldorf, Germany
Tel: +49-211-65030, Fax: +49-211-6503-1327
Renesas Electronics (China) Co., Ltd.
7th Floor, Quantum Plaza, No.27 ZhiChunLu Haidian District, Beijing 100083, P.R.China
Tel: +86-10-8235-1155, Fax: +86-10-8235-7679
Renesas Electronics (Shanghai) Co., Ltd.
Unit 204, 205, AZIA Center, No.1233 Lujiazui Ring Rd., Pudong District, Shanghai 200120, China
Tel: +86-21-5877-1818, Fax: +86-21-6887-7858 / -7898
Renesas Electronics Hong Kong Limited
Unit 1601-1613, 16/F., Tower 2, Grand Century Place, 193 Prince Edward Road West, Mongkok, Kowloon, Hong Kong
Tel: +852-2886-9318, Fax: +852 2886-9022/9044
Renesas Electronics Taiwan Co., Ltd.
13F, No. 363, Fu Shing North Road, Taipei, Taiwan
Tel: +886-2-8175-9600, Fax: +886 2-8175-9670
Renesas Electronics Singapore Pte. Ltd.
80 Bendemeer Road, Unit #06-02 Hyflux Innovation Centre Singapore 339949
Tel: +65-6213-0200, Fax: +65-6213-0300
Renesas Electronics Malaysia Sdn.Bhd.
Unit 906, Block B, Menara Amcorp, Amcorp Trade Centre, No. 18, Jln Persiaran Barat, 46050 Petaling Jaya, Selangor Darul Ehsan, Malaysia
Tel: +60-3-7955-9390, Fax: +60-3-7955-9510
Renesas Electronics Korea Co., Ltd.
11F., Samik Lavied' or Bldg., 720-2 Yeoksam-Dong, Kangnam-Ku, Seoul 135-080, Korea
Tel: +82-2-558-3737, Fax: +82-2-558-5141© 2012 Renesas Electronics Corporation. All rights reserved.
Colophon 1.3

CubeSuite+
Partner OS Aware Debugging
Plug-in

R20UT0946EJ0100