Renesas RX Smart Configurator APPLICATION NOTE
APPLICATION NOTE
R20AN0470EJ0120
RX Smart Configurator
Rev.1.20
User’s Guide: CS+
Introduction
This application note describes the basic usage of the RX Smart Configurator (hereafter called the Smart Configurator),
and the procedure for adding its output files to CS+ projects.
References to the Smart Configurator and CS+ integrated development environment in this application note apply to the
following versions.
• CS+ (CS+ for CC) V8.01.00 and later
• RX Smart Configurator V2.0.0 and later
• CS+ RX Smart Configurator Communicat ion Plugins V1.02.02 and later
Target Devices
Refer to the following URL for the range of supported devices:
https://www.renesas.com/smart-configurator
Jan 25, 2019
Contents
1. Overview .......................................................................................................................... 4
1.1 Purpose ......................................................................................................................................... 4
1.2 Features ........................................................................................................................................ 4
1.3 Software Components ................................................................................................................... 4
2. Before Using the Smart Configurator ................................................................................ 5
2.1 Preparing the CS+ (CS+ for CC) Integrated Development Environment ..................................... 5
2.2 Installing the Smart Configurator................................................................................................... 5
2.3 Setting the CS+ Integrated Development Environment ................................................................ 5
2.3.1 Checking the plug-in settings .................................................................................................. 5
2.3.2 Checking the setting of the execution path ............................................................................. 6
2.4 Uninstalling the Smart Configurator .............................................................................................. 6
3. Operating the Smart Configurator ..................................................................................... 7
3.1 Procedure for Operations .............................................................................................................. 7
3.2 Starting the Smart Configurator .................................................................................................... 8
3.3 File to be Saved as Project Information ........................................................................................ 8
3.4 Window .......................................................................................................................................... 9
3.4.1 Main menu ............................................................................................................................ 10
3.4.2 Toolbar .................................................................................................................................. 10
3.4.3 Smart Configurator view ....................................................................................................... 11
3.4.4 MCU Package view ............................................................................................................... 11
3.4.5 Console view ......................................................................................................................... 12
3.4.6 Configuration Problems view ................................................................................................ 12
R20AN0470EJ0120 Rev.1.20 Page 1 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
4. Setting of Peripheral Modules ......................................................................................... 13
4.1 Board Settings ............................................................................................................................. 13
4.1.1 Selecting the device .............................................................................................................. 13
4.1.2 Selecting the board ............................................................................................................... 14
4.1.3 Exporting board settings ....................................................................................................... 15
4.1.4 Importing board settings ....................................................................................................... 15
4.2 Clock Settings ............................................................................................................................. 16
4.3 Component Settings .................................................................................................................... 17
4.3.1 Adding Code Generator components ................................................................................... 17
4.3.2 Downloading a FIT module ................................................................................................... 19
4.3.3 Adding FIT drivers or middleware ......................................................................................... 20
4.3.4 Switching between the component view and hardware view ............................................... 21
4.3.5 Removing a software component ......................................................................................... 22
4.3.6 Setting a CG driver ............................................................................................................... 23
4.3.7 Changing the resource for a CG configuration ..................................................................... 24
4.3.8 Setting a FIT software component ........................................................................................ 27
4.3.9 Version change of FIT software component ......................................................................... 28
4.3.10 Configure general setting of component ............................................................................... 30
4.4 Pin Settings ................................................................................................................................. 31
4.4.1 Changing the pin assignment of a software component ....................................................... 32
4.4.2 Assigning pins using the MCU Package view ....................................................................... 33
4.4.3 Exporting pin settings ............................................................................................................ 34
4.4.4 Importing pin settings ............................................................................................................ 34
4.4.5 Pin setting using board pin configuration information ........................................................... 35
4.4.6 Pin filter feature ..................................................................................................................... 35
4.5 Interrupt Settings ......................................................................................................................... 36
4.5.1 Changing the interrupt priority level and fast interrupt setting .............................................. 37
4.5.2 Changing the interrupt vector number .................................................................................. 38
5. Managing Conflicts ......................................................................................................... 39
5.1 Resource Conflicts ...................................................................................................................... 39
5.2 Resolving pin conflicts ................................................................................................................. 40
5.3 Missing Dependencies ................................................................................................................ 41
6. Generating Source Code ................................................................................................ 42
6.1 Registering Generated Source Code with CS+ .......................................................................... 42
6.2 Configuration of Generated Files and File Names ...................................................................... 43
6.3 Initializing Clocks ......................................................................................................................... 46
6.4 Initializing Pins............................................................................................................................. 47
6.5 Initializing Interrupts .................................................................................................................... 50
6.6 Component Settings .................................................................................................................... 51
6.6.1 FIT module configuration ...................................................................................................... 51
7. Creating User Programs ................................................................................................. 53
7.1 Adding Custom Code in the Case of Firmware Integration Technology (FIT) ............................ 53
7.2 Adding Custom Code in the Case of Code Generator ................................................................ 54
R20AN0470EJ0120 Rev.1.20 Page 2 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
8. Backing up Generated Source Code .............................................................................. 56
9. Generating Reports ........................................................................................................ 57
9.1 Report on All Configurations (Text File) ...................................................................................... 57
9.2 Configuration of Pin Function List and Pin Number List (in csv Format) .................................... 58
9.3 Image of MCU Package (in png Format) .................................................................................... 58
10. Help ................................................................................................................................ 59
10.1 Help ............................................................................................................................................. 59
11. Documents for Reference ............................................................................................... 60
Website and Support ............................................................................................................. 61
R20AN0470EJ0120 Rev.1.20 Page 3 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
1. Overview
1.1 Purpose
This application note describes the basic usage of the Smart Configurator and CS+ integrated development
environment, includi ng the procedure for creating a project and adding Smart Configurator output to CS+ projects.
Refer to the User’s Manual of CS+ for how to use CS+.
1.2 Features
The Smart Configurator is a utility for combining software to meet your needs. It handles the following three functions
to support the embedding of drivers from Renesas in yo ur systems: importing middleware in the form of FIT (Firmware
Integration Technology) modules, generating driver code, and making pin settings.
1.3 Software Components
The Smart Configurator supports two types of software components: Code Generator (CG) and Firmware Integration
Technology (FIT). Drivers and middleware supported by each software type are:
• Basic drivers:
• CG drivers (CMT, A/D Converter, SCI, etc.)
• FIT modules (CM T, DTC, DMAC, RS PI, SCIFA, etc.)
• Middleware:
• FIT modules (USB, Ethernet, Flash Memory (programming the on-chip flash memory), etc.)
The basic driver is a control program for peripheral functions of microcomputer such as CMT, A/D converter, SCI, etc.
It is convenient to embed a software component (CG driver or FIT module) using code generation function.
In addition, FIT modules can be embedded for using middleware such as USB, Ethernet, and Fla sh mem o ry
(programming the on-chip flash memory) as software components.
R20AN0470EJ0120 Rev.1.20 Page 4 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
2. Before Using the Smart Configurator
2.1 Preparing the CS+ (CS+ for CC) Integrated Development Envir onmen t
To create or build a program in the CS+ integrated development environment with the use of source code generated by
the Smart Configurator, you will need to install CS+ to handle building for the target device.
2.2 Installing the Smart Configurator
Download the RX Smart Configurator and CS+ RX Smart Configurator Communication plug-in from the URL below.
The CS+ RX Smart Configurator communication plug-in is required for registering source code generated by the Smart
Configurator with CS+.
https://www.renesas.com/smart-configurator
After activating the installer, install the Smart Configurator and the plug-in by following the procedure of the installer.
You will require administrator privileges to do thi s.
2.3 Setting the CS+ Integrated Development Environment
Source files the S mart C onfigurator generates can be registered with CS+, and CS+ can be set to the configuration
required to build the registered source files. This is set up automatically at the time the Smart Configurator is installed;
however, you will need to check the settings against the following and modify them a s req uired.
2.3.1 Checking the plug-in settings
Select [Plug-in Manager] from [Tool] of CS+ menu, and confirm that there is a tick against “Smart Configurator for RX
Communication Plug-in”. Tick it if it is not.
Figure 2-1 Plug-in Manager
R20AN0470EJ0120 Rev.1.20 Page 5 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
2.3.2 Checking the setting of the execution path
[Smart Configurator (Design Tool)] is displayed under [Project name (Project)] in the Project Tree when you open the
CS+ project for the target device of the Smart Configurator.
Click on [Smart Configurator (Design Tool)], and the Smart Configurator Property panel is displayed.
Figure 2-2 Displaying the Property
“Smart Configurator for RX executable file path” shows the executable file of the Smart Configurator . The following
path is set when the Smart Co nfigurator is installed with the default setting (where “CS+” and “SmartConfigurator” are
in the same level).
32-bit environment:
“C:¥Program Files¥Renesas Erectronics¥SmartConfigurator¥RX¥eclipse¥SmartConfigurator.exe”
64-bit environment:
"C:¥Program Files (x86)¥Renesas Electronics¥SmartConfigurator¥RX¥eclipse¥SmartConfigurator.exe"
When manually specifying the path of the executable file, “Smart Configurator for RX executable file path” can be set
as either a relative or an absolute path.
2.4 Uninstalling the Smart Configurator
If you wish to uninstall the Smart Configurator, select “Smart Configurator for RX” and “CS+ SC Communication
Plugins for RX” from [Apps and Features] in the control panel and uninstall them.
R20AN0470EJ0120 Rev.1.20 Page 6 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
Operations in CS+
Operations in the Smart Configurator
Starting CS+
Creating and loading a CS+ project
Starting the Smart Con figurator
Setting of peripheral modules
Generating source code
Creating user programs
Building
Execution and debugging
Setting of pins
Refer to section 3.2, Starting the
Refer to chapter 7, Creating User
Refer to chapter 4, Setting of
Peripheral Modules.
Refer to section 4.4, Pin Settings.
Refer to chapter 6, Generating
Device information
Toolchain information
Registeri ng s ource files
Generating reports
Refer to chapter 9, Generating
Setting of interrupts
Refer to section 4.5, Interrupt
Settings.
3. Operating the Smart Configurator
3.1 Procedure for Operations
Figure 3-1 shows the procedure for using the Smart Configurator to generate files for setti ng up peripheral modules, and
to use them i n building after registration with CS+. Refer to the related documents on CS+ for the operation of CS+.
Smart Configurator.
Source Code.
Programs.
R20AN0470EJ0120 Rev.1.20 Page 7 of 61
Jan 25, 2019
Reports.
Figure 3-1 Procedure for Operations
RX Smart Configurator User's Guide: CS+
3.2 Starting the Smart Configurator
Double-click on [Smart Configurator (Design Tool)] under [Project name (Project)] in the Project Tree of CS+ to start
the Smart Configurator. You do not need to select a device or toolchain for the Smart Configurator, since the settings of
the project for CS+ are passed over to the Smart Configurator.
Figure 3-2 Activation of Smart Configurator
Note: The settings of CS+ are not passed over to the Smart Configurator in the following cases: when the
Smart Configurator is activated from its executable file, when a new project is created from [File]
menu of the Smart Configurator, or when an existin g file from the Smart Configurator is opened.
3.3 File to be Saved as Project Information
The Smart Configurator saves the setting information such as the target MCU for the project, build tool, peripheral
modules, and pin functions in a p roject file (*.scfg), and refers to this i nformation.
When the Smart Configurator is activated from CS+, the project file from the Sma rt Configurator is saved in “project
name.scfg”, which is at the same level as the project file (*.mtpj) of CS+.
R20AN0470EJ0120 Rev.1.20 Page 8 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
(1)
(2)
(3)
(4)
(5)
(6)
3.4 Window
The main window is displayed when the Smart Configurator is started. The confi guration of the window is s hown in
Figure 3-3, Ma in Window.
1) Menu bar
2) Main toolbar
3) Smart Configurator view
4) MCU Package view
5) Console view
6) Configuration Problems view
Figure 3-3 Main Window
R20AN0470EJ0120 Rev.1.20 Page 9 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
Menu
Details
File
New
The dialog box [New Smart Configurator File], whic h is used to create a
new project, is displayed.
Open
The dialog box [Open], which opens an existing project, is displayed.
Save
Saves a project with the same name.
Restart
Smart Configurator is restarted.
settings handed over from CS+.
Exit
Execution of the Smart Configurator is terminated.
Window
Preference
The dialog box [Preference], which is used to specify the properties of the
project, is displayed.
Show view
The dialog box [Show view], which is used to set the view of the window,
is displayed.
Help
Help Contents
The help menu is displayed.
About
The version information is displayed.
Toolbar button
Related menu item
[File] → [New]
[File] → [Open]
[File] → [Save]
3.4.1 Main menu
Table 3-1, Main Menu Items, lists the items of the mai n me n u.
Table 3-1 Main Menu Items
Do not use this menu item in general, as it leads to deletion of the project
3.4.2 Toolbar
Some functions of the main menu are allo c a te d to the buttons on the toolbar. Table 3-2, Toolbar Buttons and Related
Menu Items, shows the description of those tool buttons.
Table 3-2 Toolbar Buttons and Relat ed Menu Items
R20AN0470EJ0120 Rev.1.20 Page 10 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
3.4.3 Smart C onfigurator view
The Smart Configurator view consists of six pages: [Overview], [Board], [Clocks], [Components], [Pins], and
[Interrupts]. Select a page by clicking on a tab; the displayed page will be changed.
Figure 3-4 Smart Configurator View
3.4.4 MCU Package view
The states of pins are displayed on the figure of the MCU package. The settings of pins can be modified from here.
Two types of package view can be switched between [Assigned] and [Default Board]. [Assigned] displays the
assignment sta t us of the pin setting, and [D efault Board] displays the initial pin setting information of the board. The
initial pin setting information of the board is the pin information of the board selected by [Board:] on the [Board] page
(refer to "4.1.2 Selecting the board").
Figure 3-5 MCU Package View
R20AN0470EJ0120 Rev.1.20 Page 11 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
3.4.5 Console view
The Console view displays details of cha nges to the configuration made in the Smart Configurator or MCU Package
view.
Figure 3-6 Conso le View
3.4.6 Configuration Problems view
The Configuration Problems view displays the details of conflicts between pins.
Figure 3-7 Configuration Problems View
R20AN0470EJ0120 Rev.1.20 Page 12 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
4. Setting of Peripheral Modules
You can select peripheral modules from the Smart Configurator view.
4.1 Board Settings
You can change the board and device on the [Board] tabbed page.
4.1.1 Selecting the device
Click on the [ ] button to select a device.
Figure 4-1 Selecting the Device
Note: Device change is not reflected to the device (micro controller) of CS+ project.
R20AN0470EJ0120 Rev.1.20 Page 13 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
4.1.2 Selecting the board
By selecting a board, the following settings can be changed at one time.
• Pin assignment (Initial pin setting)
• Frequency of the main clock
• Frequency of the sub-clock
• Target device
The board setting information is defined in the Board Description File (.bdf).
The .bdf file of Renesas made board (e.g. Renesas Starter Kit) can be downloaded from website and imported.
In addition, by downloading the .bdf file provided by the alliance partner from website an d importing it, it is possible to
select alliance part boards.
Figure 4-2 Selecting the Board
Note: Depending on the board selected, the device will change, Device change is not reflected to the device
(micro controller) of CS+ project.
R20AN0470EJ0120 Rev.1.20 Page 14 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
(1)
(2)
(1)
4.1.3 Exporting board settings
Follow the procedure below to export the board settings.
(1) Click on the [ (Export board setting)] button on the [Board] tabbed page.
(2) Select the output location and specify a name (Display Name) for the file to be exported.
Figure 4-3 Exporting Board Settings (bdf Format)
4.1.4 Importing board settings
Follow the procedure below to import board settings.
(1) Click on the [ (Import board setting)] button and select a desired bdf file.
(2) The board of the imported settings is added to the board selection menu.
Figure 4-4 Importing Board Settings (bdf Format)
Once a board setting file is imported, the added board is also displayed in the board selection menu of other projects for
the same device group.
R20AN0470EJ0120 Rev.1.20 Page 15 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
(5)
(3)
(6)
(4)
(2)
(1)
4.2 Clock Settings
You can set the system clock on the [Clocks] tabbed page. The settings made on the [Clocks] page are used for all
drivers and middleware.
Follow the procedure below to modify the clock settings.
(1) Specify the VCC voltage.
(2) Select the clocks required for device operations on the board (the main clock is selected by default).
(3) Specify the frequency of each clock in accordance with the board specifications (note that the frequency i s fixed
for some internal clocks).
(4) When using the PLL circuit, select the clock source for the PLL.
(5) For the multiplexer symbol, select the cloc k source for the output clocks.
(6) To obtain a desired output clock frequency, select a frequency division ratio from the drop-down list.
Figure 4-5 Clock Settings
R20AN0470EJ0120 Rev.1.20 Page 16 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
Components t ree
(1)
4.3 Component Settings
Drivers and middleware can be combined as software components on the [Components] page. Added components are
displayed in the Components tree at the left of the page.
Figure 4-6 [Components] Page
The Smart Configurator supports two types of software components: Code Generator (CG) components and Firmware
Integration Technology (FIT) modules.
4.3.1 Adding Code Generator components
The following describes the procedure for adding a component.
(1) Click on the [ (Add component)] icon.
Figure 4-7 Adding a Component
R20AN0470EJ0120 Rev.1.20 Page 17 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
(2)
(3)
(4)
(5)
(7)
(6)
(2) Select a component from the list in the [Software Component Selection] page of the [New Compone nt ] dia log
box (e.g. Single Scan Mode S12AD).
(3) Che ck that [Type] for the selected component is [Code Generator].
(4) Cli ck on [Next].
Figure 4-8 A dding a Code Generator Component
(5) Specify an appropriate configura t ion name in the [Add new configuration for selected component] page of the
[New Compone nt] dialog box or use the default name (e.g. Config_S12AD0).
(6) Select a hardware resource or use the default resource (e.g. S12AD0).
(7) Cli ck on [Finish].
Figure 4-9 Adding a Component
R20AN0470EJ0120 Rev.1.20 Page 18 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
(2)
(3)
(3)
(4)
(5)
4.3.2 Downloading a FIT module
You need to download a desired FIT driver or middleware from the Renesas Electronics website. First, log in to "My
Renesas" from CS+, then follow the procedure below.
(1) Click on the [ (Add component)] icon.
(2) Clic k the [Download more software components] link i n t he [Software Component Selection] page of the [New
Component] dialog box to download a FIT module.
Figure 4-10 Downloading More Software Components
(3) Select the checkbox of the required module in t he [FIT Module Download] dialog box. If [Show RX Driver
Package only] is unchecked, filtering of items is canceled.
(4) Cli ck on [Browse...] to select the location where the downloaded module is to be stored.
(5) Cli ck on [Download] to start downloading the selected FIT module.
Figure 4-11 Downloading a FIT Module
R20AN0470EJ0120 Rev.1.20 Page 19 of 61
Jan 25, 2019
RX Smart Configurator User's Guide: CS+
(2)
(3)
(4)
4.3.3 Adding FIT drivers or middleware
The following describes the procedure for adding FIT drivers or middleware.
(1) Click on the [ (Add component)] icon.
(2) Select components f rom the list in the [Software Component Selection] page of the [New Compone nt] dialog
box (e.g. r_ether_rx and r_qspi_smstr_rx). Two or more components can be selected by clicking with the Ctrl
key pressed.
(3) Che ck that [Type] for the selected components is [FIT].
(4) Click on [Finish].
Figure 4-12 Adding FIT Modules
R20AN0470EJ0120 Rev.1.20 Page 20 of 61
Jan 25, 2019
Loading...