13. Renesas FSP Smart Configurator – User Guide
13.1. What the extension does
The Renesas FSP Smart Configurator extension lets you configure Renesas FSP (Flexible Software Package) projects graphically inside Visual Studio Code. It opens a project’s configuration.xml in a visual editor with one page for each area of the project:
Page |
What you configure |
|---|---|
BSP |
The selected board, device and BSP properties |
Clocks |
The clock tree (sources, dividers, multipliers, frequencies) |
Pins |
Which peripheral function each MCU pin is assigned to |
Interrupts |
User interrupt events and their ISR names |
Event Links |
User events produced and consumed, and the resulting event links |
Stacks |
Threads, module stacks, objects and their properties |
Your edits are applied to the project model and written back to configuration.xml when you save.
The extension does not do the work itself. It talks to a background service, the RA Smart Configurator Web Service. The extension starts one service for each folder that contains a configuration.xml, so that service must be installed first (see Prerequisites).
13.2. Prerequisites
The extension relies on two packages that are installed with the Renesas Platform Manager extension (RenesasElectronicsCorporation.renesas-platform).
Install the Renesas Platform extension. Its commands appear in the Command Palette under the Renesas category, and it adds a Renesas view to the Activity Bar.
Open Manage Smart Configurators. Use the Command Palette (
Ctrl+Shift+P) and run Renesas: Manage Smart Configurators, or use the Environment section of the Renesas view. The same command is behind the button on the error message the extension shows if something is missing.Make sure both of these are installed:
Renesas RA Smart Configurator Web Service (the “RA Web Service” entry). This is the background service that this extension talks to.
Renesas RA Smart Configurator (the “RA” entry). This is the RA FSP Smart Configurator that creates projects. It needs version 5.3.0 or later.
Make sure the RA Smart Configurator is the Active FSP Smart Configurator. The page shows the active one at the top. Only one FSP-based Smart Configurator can be active at a time. Its device family must match your project, and its FSP version should be equal to or newer than the project’s. If you have several versions installed, use Set as Active on the one you want. The choice is stored in the setting
renesas-platform.activeFspSmartConfiguratorPath. If you already have a Smart Configurator installed elsewhere, use Register SC on that page to register it.
If either is missing, you will see one of these messages:
“Smart Configurator WS is not installed. Please install it using the Renesas Platform Manager.” The message has a Manage Smart Configurators button.
“Active RA Smart Configurator could not be found. Please install one first using the Renesas Platform Manager.”
Install the missing package, then close and reopen the folder so the service starts.
13.3. Creating a new project
Projects are created with the Renesas RA Smart Configurator, a separate desktop application that the Renesas Platform extension launches for you. Creating a project does not happen inside the editor described in this guide.
Open the Command Palette (
Ctrl+Shift+P) and run Renesas: Create Renesas RA Project. You can also use the Create Project section of the Renesas view.Choose Create RA FSP Project with Smart Configurator. This opens the RA FSP Smart Configurator to generate the project.
Warning
Solutions are not supported at present. The list also offers Create RA FSP Solution with Smart Configurator. Do not use it with this extension, because creating a solution is not currently supported. Create a project instead.
If you have more than one RA Smart Configurator installed, choose one from the list, for example Renesas RA Smart Configurator (6.4.0). The active one is listed first. If none is installed, install one first (see Prerequisites).
In the folder dialog (Select folder to create the project), choose where the new project goes.
The RA Smart Configurator window opens. Use it to pick the board or device, the FSP version and the project template, and to generate the project.
VS Code opens the folder you chose straight away.
The new folder contains a configuration.xml. When that folder is open in VS Code, this extension starts a Smart Configurator service for it. A notification reads “Starting Smart Configurator service for …” while it starts.
Note
Two ways to edit a project: the Renesas Platform extension also has Edit Project with Smart Configurator and Open with Smart Configurator (in the Explorer context menu on configuration.xml). These launch the separate RA Smart Configurator desktop application. To use the editor described in this guide, open configuration.xml as described in Opening the Smart Configurator editor.
Note
Each project can be served by only one service at a time. If you open the same project in two VS Code windows, the second window is refused. The message names the process that already holds it.
13.4. Opening the Smart Configurator editor
Open the project folder in VS Code (File → Open Folder…).
Open
configuration.xmlfrom the Explorer. It opens in the Configuration XML editor rather than as raw text.Wait for the service to be ready. If the editor shows a message that the service is not responding, or that it timed out, check the Smart Configurator output channel and reopen the folder.
13.4.1. Moving around
A bar of icons runs down the left side of the editor. In order, the icons are BSP, Clocks, Pins, Interrupts, Event Links and Stacks. Click one to switch page. Each page keeps its state, such as selections, scroll position and canvas layout, while you visit other pages.
13.4.2. Saving
Edits are sent to the service as soon as you make them, and the editor tab shows the usual unsaved-changes dot when the model has changed. Save with Ctrl+S to write configuration.xml. The extension warns you if the service is no longer running, because in that case the file cannot be saved.
If you remove a folder from the workspace while its editor has unsaved changes, VS Code keeps the folder in the workspace so you do not lose them.
13.5. The pages
13.5.1. BSP – Board Support Package
Shows the board and device, and lets you edit BSP properties.
Device Selection (read-only) lists the Board, Device, Core and FSP version.
Board Description (read-only) shows the board’s description. Any web address in it is a link.
PROPERTIES panel on the right holds the editable BSP properties.
Drag its left edge to resize it, or focus the edge and press the left or right arrow key. Use the › button to hide it and ‹ to show it again.
Rows are sorted alphabetically. Rows with a ▶ arrow have child rows you can expand.
A padlock icon means the value is locked.
Click a value to edit it. A drop-down property shows a list to pick from. A text property becomes a text box: press
Enterto apply orEscto cancel. Check boxes toggle directly.Long names and values are cut short. Hover to see the full text.
13.5.2. Clocks
An interactive diagram of the clock tree for the selected board.
Each box in the diagram is a clock node. Lines between the boxes show the clock routes. The active route is highlighted, and unused routes are grey.
Changing a node:
List nodes are drop-downs.
Tree nodes are cascading drop-downs. Hover to open sub-menus and click a final item.
Text nodes hold a frequency. Click the box, or press
EnterorF2, and type a number in Hz. PressEnterto apply orEscto cancel. Values are displayed in Hz, KHz, MHz, GHz or THz as appropriate.Label nodes are read-only.
Hover a node, or give it keyboard focus, for a description. If a node has a problem, it gets a red border and a small error icon, and the tooltip lists the problems.
Only one change is processed at a time. Controls are disabled while a change is pending.
Restore Defaults (toolbar) resets every clock setting to the board’s defaults. A confirmation dialog warns that this replaces your current settings. Save
configuration.xmlafterwards to keep the restored settings.If clocks fail to load, a message appears with a Reload clocks button.
13.5.3. Pins
Assign MCU pins to peripheral functions.
At the top:
Select Pin Configuration: choose the pin configuration from the drop-down.
Generate data: check box and symbol name. The check box turns generation for the configuration on or off. Click the symbol text to edit it.
Below that are two sub-tabs. The one you used last is remembered.
Pin Function
The left tree lists pins and peripherals. Select a node to see its settings in the Name / Value table on the right.
Click a value to edit it. Enumerated values open a list, and other values become a text box. A row can show an error (red), a warning (yellow) or a check mark, with its message beneath the value.
Pin Number
One table with the columns Pin Number, Pin Name, Function, Direction, Remarks and Comments.
Click Function to choose the function for a pin. Click Comments to add a note. Pins that are locked or not editable show a padlock and cannot be changed.
A pin number with a red error icon has a conflict. A yellow warning icon marks a warning.
Drag a column border to resize the column. Double-click it to reset.
Selecting a row also selects the pin in the package diagram.
MCU PACKAGE panel (right-hand side, collapsible with ›)
Shows the chip package with each pin coloured by state: Used (green), Warning (yellow), Conflict (red), Not assigned (white), Read only (grey).
+, − and Reset zoom the diagram. The mouse wheel zooms too.
Pin label changes what is printed on each pin. For QFP packages the choices are Assigned Function and Default Port Number. For BGA packages they are Module Name and Symbolic Name.
Left-click a pin to select it and jump to its row in the Pin Number tab.
Right-click a pin to choose its function from a menu. The current assignment is ticked. A locked pin shows the menu disabled.
Hover a pin for a moment to see its name, assigned function, direction and status.
13.5.4. Interrupts
Register your own interrupt events and name their handlers (ISRs). It has two sections, with a divider you can drag to resize them.
User Events
+ New User Event opens a menu of events that are not yet used. Type in Search events to filter, and open sub-menus with the > arrows. After you choose an event, a dialog asks for the ISR name. Press OK.
− Remove removes the selected rows.
Select rows by clicking.
Shift+ click selects a range andCtrl+ click toggles a row.The ISR column is editable in place. The name must be a valid C identifier: letters, digits and underscores, not starting with a digit. Press
Enteror click away to save, orEscto discard.An error icon beside an event means it could not be allocated to an interrupt slot.
Allocations (read-only)
Shows each Interrupt slot with its Event, ISR and Priority. A warning icon means the slot is shared by more than one event.
13.5.5. Event Links
Shows the user events your project produces and consumes, and the event links that result.
User Events Produced: + New User Event adds an event from a searchable menu. − Remove deletes the selected rows.
User Events Consumed: + New User Event opens a dialog. Choose a Peripheral Function and an Event, then press OK. − Remove deletes the selected links. A row with a problem is marked with an error icon, and the problem text is shown under it.
Allocations (read-only) lists each Peripheral Function with its Event.
Drag the dividers to resize the three sections.
If something fails, a banner at the top of the page explains it. The data reloads each time you return to the page.
13.5.6. Stacks
Build the software stacks of each thread and edit properties of threads, modules and objects.
13.5.6.1. Layout
The canvas in the middle shows the module cards of the selected thread.
The Properties panel on the right shows the properties of whatever is selected: a thread, a module or an object.
The Threads button at the top-left of the canvas opens a panel with two lists, THREADS and OBJECTS. Click elsewhere on the canvas to close it. Drag the handle between the lists to resize them.
13.5.6.2. Threads
Click a thread to select it, expand it and show its stacks on the canvas. Expanded threads list their modules. Use the chevrons to expand or collapse them.
+ (Create new thread) creates a thread and selects it.
− (Delete thread or stack element) works on the current selection:
With a module selected, it removes that module.
With a thread selected, it deletes the thread after you confirm.
It is disabled with an object selected, and for the HAL/Common thread, which cannot be deleted.
Rows with problems are shown in red. A collapsed parent with problem modules below it shows a red !.
13.5.6.3. Objects
+ (Add object) opens a filterable list of the objects you can add.
− (Remove object) removes the selected object. It is disabled until an object is selected.
Click an object to see its properties. Click it again to re-read them.
13.5.6.5. Module cards
Each card shows the module’s icon, name and id. The footer shows N LINK STACK, or NO LINK STACK if there are none. Click N LINK STACK to collapse or expand the child cards.
Colours: a normal module has a grey accent. A common module has a purple accent and a blue double outline. An inactive module has a pink accent.
Problems: a card with problems has a red icon and name. A collapsed card whose hidden children have problems shows a red !.
Select: click a card. Click empty canvas to deselect.
Move: drag a card by its header.
Resize: drag the strip on the card’s right edge, or focus it and use the left and right arrow keys.
Tooltip: rest the pointer on a card to see its name, id, description and any problems.
Optional slots: a dashed card marked OPTIONAL · click to add is an empty slot. Click it to choose a module for it.
Your arrangement, collapsed cards and widths are remembered for each thread.
13.5.6.6. Zooming
Use the zoom box next to the Add/Remove button. Type a percentage between 10 and 200, or use the arrows.
Or hold
Ctrland use the mouse wheel over the canvas.
13.6. Troubleshooting
Symptom |
What to do |
|---|---|
“Smart Configurator WS is not installed” |
Install the Renesas RA Smart Configurator Web Service in Manage Smart Configurators, then reopen the folder |
“Active RA Smart Configurator could not be found” |
Install the Renesas RA Smart Configurator there and make it the active one |
The editor says the service is not responding or timed out |
Open the Smart Configurator output channel for details, then close and reopen the folder |
A project “is already being served by another Smart Configurator service” |
Close the other window that has the project open. If its window is gone, use the Stop that service button on the message |
A page shows an error banner |
Read the message, fix the cause and retry. The Clocks page has a Reload clocks button. The other pages reload when you return to them |
Changes are not in |
Press |
13.7. Features not yet available
The following are not yet available in this extension.
Feature |
Current alternative |
|---|---|
Renesas FSP project generation |
Use the external Renesas FSPSC tool (the RA Smart Configurator desktop application) to create the project, as described in Creating a new project. |
Renesas FSP Solutions support |
Use the external Renesas FSPSC tool to create solutions. |
Changing the FSP version, board or device within the Renesas Smart Configurator |
Not available here. The BSP page shows the board, device, core and FSP version for information only. |
Summary and Components pages |
Not available. The editor currently has only the BSP, Clocks, Pins, Interrupts, Event Links and Stacks pages. |