The MCUXpresso Config Tools set is a suite of evaluation and configuration tools that help you from initial evaluation to production
software development. Following tools are included:
Table 1. MCUXpresso Config Tools
NameDescription
Pins Tool
Clocks Tool
Peripherals ToolEnable you to configure the initialization for the MCUXpresso SDK drivers.
Device
Configuration Tool
TEE ToolEnables you to configure security policies of memory areas, bus masters, and peripherals, in order to
Enables you to configure the pins of a device. Pins tool enables you to create, inspect, change, and modify
any aspect of the pin configuration and muxing of the device.
Enables you to configure initialization of the system clock (core, system, bus, and peripheral clocks) and
generates the C code with clock initialization functions and configuration structures.
Enables you to generate a Device Configuration Data (DCD) image using the format and constrains
specified in the Boot ROM reference manual.
isolate and safeguard sensitive areas of your application.
1.1 Versions
The suite of these tools is called MCUXpresso Config Tools. These tools are provided as an online Web application or as a desktop
application or as integrated version in MCUXpresso IDE.
NOTE
The desktop version of the tool contacts the NXP server and fetches the list of the available processors. Once used,
the processors data is retrieved on demand.
TIP
To use the desktop tool in the offline mode, create a configuration for the given processor while online. The tool will
then store the processors locally in the user folder and enable faster access and offline use. Otherwise, it is possible
to download and export the data using the Export menu.
In this context, configuration stands for common tools settings stored in an MEX (Microcontrollers Export Configuration) file. This
file contains settings of all available toolsand can be used in both web and desktop versions.
The folder with the saved MEX file must contain exactly one project file to be able to parse the toolchain project. The file type
depends on the toolchain of the project and can be one of the following:
Table 2. Supported toolchain project files
ToolchainProject file
IAR EWEWP
MDK μVisionUVPROJX
ARM GCCCMakeLists.txt
2.1.1 Creating a new configuration
In Project Explorer, right-click the Eclipse project based on MCUXpresso SDK, and select MCUXpresso Config Tool > Open Pins.
One of the following actions takes place:
• If the project contains an MEX file in the root folder, the file is opened.
• If the project contains any source file with tool configuration (pin_mux.c, clock_config.c and/or peripheral.c), the tool
configuration is imported from this file.
• Otherwise, an empty/default configuration for selected processor is created.
NOTE
The same command can be invoked also from popup menu on the MEX file or from toolbar in Project Explorer view.
2.1.2 Saving a configuration
You can save your configuration by clicking the Save button on the toolbar or selecting File>Save from the Main Menu. The
command is enabled only if the configuration is dirty (unsaved) and one of MCUXpresso Config Tool perspective is opened. The
configuration is always saved into an MEX file stored in the project root folder. If file doesn't exist, new one is created using current
project name.
NOTE
Configuration is also saved when you select Update Code in the toolbar.
2.1.3 Importing sources
To import source code files, do the following:
1. In the Menu bar, select File > Import....
2. From the list, select MCUXpresso Config Tools>Import Source.
4. On the next page, click Browse to specify the location of the source file.
5. Select the source file you wish to import and click Open.
6. On the next page, select which functional groups to import (based on tools) by selecting the checkbox in the left column.
7. Define how to import the functional groups by selecting one of the two available options in the dropdown menu in the
right column:
• Rename – All files are merged into the current configuration. It imports all the functions only. If the imported
function has the same name as an existing one, it is automatically renamed to the indexed one. For example, if
BOARD_InitPins already exists in the configuration then the imported function is renamed to BOARD_InitPins1.
• Overwrite – All files are merged into the current configuration. It imports all the functions only. If the imported
function has the same name as an existing one, then the existing one is replaced with the imported one.
8. Click Finish.
NOTE
Only C files with valid YAML configuration can be imported. It imports the configuration only, then the whole C file
is re-created based on this setting. The rest of the C and DTSI files are ignored.
1. In the Menu bar, select File > Import…. Alternatively, click the Import Registers Configuration button in the Registers view,
or drag-and-drop the memory dump file anywhere in the Registers view area.
Figure 4. Import Registers Configuration
2. In the Import wizard, select MCUXpresso Config Tools > Import Registers.
3. Click Next.
4. On the next page, click Browse to specify the location of the registers configuration.
5. Select the registers file you wish to import, and click OK.
6. By default, the imported register configuration will overwrite the existing functional group. If you want a new functional group
to be created instead, select the Create new functional group option button, and specify the functional group name.
7. Click Finish.
NOTE
All registers are imported from the dump file regardless of their relevance to clock configuration, therefore, the list
can contain registers not needed by the Clocks tool.
The generated code contains information about the Clocks tool settings that are used in the tool (block within a comment in
YAML format).
The following is an example of the settings information in the generated source code.
Figure 5. Setting Information in the source code
If this information is not corrupted, it's possible to re-import the clock settings into the tool using the following steps.
1. In the Menu bar, select File > Import….
2. From the list, select MCUXpresso Config Tools > Clocks Tool > Import Source Files.
3. Click Next.
4. Click Browse.
5. Navigate and select the
6. If the settings parse successfully, clock configurations are added into the current global configuration.
clock_config.c
file previously produced by the Clocks tool.
2.2 Toolbar
The toolbar is located on the top of the window and includes buttons/menus of frequently used actions common to all tools. See
the following sections for more information.
Table 3. Toolbar
ItemDescription
Config Tools OverviewOpen the Overview dialog with information about currently-used tools.
Show Problems ViewOpen the Problems view.
Update CodeOpen the update dialog allowing you to update generated peripheral initialization code
Functional group selectionSelect functional group. Functional group in the Peripherals tool represents a group
of peripherals that are initialized as a group. The tool generates a C function for each
function group that contains the initialization code.
Call from default initializationSet the current functional group to be initialized by the default initialization function.
Functional group propertiesOpen the Functional group properties dialog to modify name and other properties of
the function group.
Tool selectionDisplay icons of individual tools. Use them to switch between tools.
Undo/RedoUndo/Redo last action.
In addition, the toolbar may contain additional items depending on the selected tool. See the chapters dedicated to individual tools
for more information.
2.2.1 Eclipse project selection
You can use the Eclipse project drop-down menu to switch between projects.
2.2.2 Config Tools Overview
Click the Config Tools Overview button to open Config Tools Overview and inspect information about the configuration, hardware,
and project. For more information, see the Config Tools Overview section.
2.2.3 Show Problems View
Click the Show Problems View to open/highlight the Problems view and inspect any errors in your configuration. See Problems
view for more information.
Button color depends on issue type. Red indicates the presence of at least one error, yellow indicates the presence of at least
one warning.
2.2.4 Update code
To update the generated code in the related toolchain project, click the Update Code button. In the window, select the tools or files
you want to update. If the file is updated automatically, the button is filled with a black square. The reason is displayed in the tooltip.
Previous version of the file can be retrieved from Eclipse local history.
The Update Code action is enabled under following conditions:
• If the MEX configuration is saved in a toolchain project, the processor selected in the tool matches with processor selected
in the toolchain project
• Core is selected (for multicore processors)
2.2.5 Functional groups
Every Pins/Clocks/Peripherals configuration can contain several functional groups.
These groups represent functions which will be generated into source code. Use the dropdown menu to switch between functional
groups and configure them.
Figure 9. Functional groups
You can use two additional buttons to further configure functional groups:
Table 4. Functional Groups
IconDescription
Toggle "Called from default initialization function" feature (in
source code)
Opens the Functional group properties window
NOTE
Red/orange background indicates errors/warnings in the configuration.
2.2.5.1 Functional group properties
In the Functional Group Properties window, you can configure several options for functions and code generation. Each settings
is applicable for the selected function. You can specify generated function name, select core (for multicore processors only) that
is affecting the generated source code, or write function description (this description will be generated in the C file). You can also
add, copy, and remove functional groups as needed.
Aside from name and description, you can choose to set the following parameters for selected functional groups:
• Set custom #define prefix - Enable to use the specified prefix for the identifiers in the source code. You can also modify
the functions order (on the left), the order is applied in the generated code.
NOTE
Not all processors support this option.
• Called from default initialization function - Enable to call the function is called from the default initialization function.
Figure 10. Functional group properties for the Pins tool
2.2.6 Undo/Redo actions
You can reverse your actions by using Undo/Redo buttons available in the Toolbar. You can also perform these actions from the
Edit menu in the Menu bar.
Table 5. Undo/reto actions
IconDescription
Cancels the previous action
Cancels the previous undo action
2.2.7 Selecting the tools
Buttons on the extreme right-hand side of the toolbar represent available tools. Click the icons to quickly navigate between .
2.3 Status bar
The status bar is visible at the bottom part of the GUI. Status bar indicates error and warning state of the currently selected
functional group.
To configure the preferences related to the configuration, uses popup menu on the Eclipse project, select Properties and then
MCUXpresso Config Tools in the left pane.
Figure 12. Configuration Preferences
Several preferences are available.
•
Table 7. Configuration Preferences
ItemDescription
Validate boot init onlyValidate tools' dependencies only against ‘boot init’ function
group.When selected, dependencies from all functional groups
of all tools must be satisfied in the functional groups marked for
default initialization. Clearing this option hides warnings in case
the user is using complex scenarios with alternating functional
groups within the application code.
Generate YAMLGenerate YAML into C sources files.
Generate extended information into header fileGenerate extended information into the header file. For
projects created in earlier MCUXpresso versions, this option is
selected by default.
Custom source file copyright headerAdd a custom copyright header to generated source files that
don't already contain copyright.
Generate code only for registers that are different from the
after-reset state
Generate code only for registers that are different from the
after-reset state. For projects created in earlier MCUXpresso
versions, this option is selected by default.
WARNING
When the source does not contain YAML code, it can't be imported.
2.6 Problems view
The Problems view displays issues in individual tools and in the inter-dependencies between the tools.
Figure 13. Problems view
To open the Problems view, click the Show Problems view button in the Toolbar, or select Views > Problems from the Menu bar.
The Problems table contains the following information:
LevelSeverity of the problem: Information, Warning, or Error.
ResourceResource related to the problem, such as signal name, the clock signal, and so on.
IssueDescription of the problem.
OriginInformation on the dependency source.
TargetTool that handles the dependency and its resolution.
TypeType of the problem. It's either the validation checking dependencies between tools, or a single tool issue.
Every issue comes with a context menu accessible by right-clicking the table row. Use this menu to access information about the
problem or to apply a quick fix where applicable. You can also copy the rows for later use by right-clicking the row and selecting
Copy or by using the Ctrl+C shortcut. You can use the Ctrl+left-click shortcut to add additional rows to the selection.
NOTE
Quick fix is only available for problems highlighted with the "lightbulb" icon.
Filter buttons are available on the right side of the Problems view ribbon.
Table 9. Filter buttons
ButtonDescription
Enables the Validate boot init only preference. See Configuration preferences section for details.
Filters messages in the Problems view. If selected, only problems for the active tool are displayed. See
Configuration preferences section for details.
2.7 Registers view
The Registers view lists the registers handled by the tool models. You can see the state of the processor registers that correspond
to the current configuration settings and also the state that is in the registers by default after the reset. The values of the registers
are displayed in the hexadecimal and binary form. If the value of the register (or bit) is not defined, an interrogation mark "?" is
displayed instead of the value.
NOTE
This view contains registers for the seleted tool. The view uses registers as internal parameters but it might not
handle all the register writes needed in the code. The register writes are done inside the SDK functions that are
called by the generated code. There might be additional registers accessed in the SDK code during the setup
process, and such register writes are not known to the tool and are not displayed in the registers view.
2.8 Log view
The Log view shows user-specific information about MCUXpresso Config Tools operations. The Log view can show up to 100
records across all tools in chronological order.
Each log entry consists of a timestamp, the name of the tool responsible for the entry, severity level, and the actual message. If
no tool name is specified, the entry was triggered by shared functionality.
You can filter the content of the Log view using the combo boxes to display only specific tool and/or severity level information.
Filters in different tools can be set independently.
Buffered log records are cleared using the clear button. This affects Log views across all tools.
Figure 15. Log view
2.9 Config tools overview
The Config Tools Overview provides you with general information about your currently active configuration, hardware, and project.
It also provides a quick overview of the used/active and unused/inactive tools, generated code, and functional groups. By default,
the Config Tools Overview icon is located on the left side of the toolbar.
Config Tools Overview contains several items.
Table 12. Config Tools Overview
ItemDescription
Configuration – General InfoDisplays the name of and the path to the MEX file of the current
configuration. Click the link to open the folder containing
the MEX file. To import additional settings, click the Import
additional settings into current configuration button.
Configuration – HW InfoDisplays the processor, part number, core, and SDK-version
information of the current configuration.
ProjectDisplays toolchain project information.
Pins/Clocks/Peripherals/TEE/Device ConfigurationDisplays basic information about the Pins, Clocks, Peripherals,
NOTE
If you have disabled a tool and want to reopen it, click the tool icon in the upper right corner or select it from the
Main Menu. The Config Tools Overview opens automatically.
To enable/disable the tools, click the toggle button. You can navigate to the tools by clicking their icons. Following information
about the tools is also available:
Table 13. Config Tools Overview
ItemDescription
Generated codeContains the list of source-code files. Click the links to open the files in the Code Preview view.
Functional groupsContains the list of the currently active functional groups. To select the groups in the Functional
groups tab in the toolbar, select the relevant links.
•
Figure 16. Config Tools Overview
NOTE
Unsupported tools are not displayed in the overview.
Pins tool is an easy-to-use tool for configuration of device pins. The Pins tool software helps create, inspect, change, and modify
any element of pin configuration and device muxing.
Figure 17. Pins tool
3.1 Pins routing principle
The Pins tool is designed to configure routing peripheral signals either to pins or to internal signals.
Internal signal is an interconnection node which peripheral signals can be connected to (without any pin interaction). Connecting
two peripheral signals to internal signal makes an interconnection of these two peripheral signals.
This routing configuration can be done in the following views:
• Pins
• Peripheral Signals
• Package
• Routing Details
Following two sections describe the two methods you can use to define the routing path.
3.1.1 Beginning with peripheral selection
You can select the peripheral in the Routing Details view and the Peripheral Signals view.
1. Select the Peripheral.
2. In Routing Details view, select one of the available Signals or expand the peripheral in Peripheral Signals view.
Items (pins/internal signals) in the Routed pin/signal column in the Routing Details view have following decorators:
• Exclamation mark and default text color indicates that such item selection causes a register conflict or the item cannot
be routed to the selected peripheral signal (some other peripheral signal can be).
• Exclamation mark and gray text color indicates that the item cannot be routed to any signal of the selected peripheral.
The item is available for different peripheral using the same signal.
NOTE
Route to field in Routing details view contains items that are connectable to the selected signal (without its
channel if applicable). So when selected signal is “GPIO, 6” then the Routed pin/signal provides items connectable
to “GPIO”.
3.1.2 Beginning with pin/internal signal selection
You can select a pin or an internal signal in the Routing Details view.
1. Select the pin/internal signal (Routed pin/signal).
2. Select one of the available Peripherals. In the Pins view, see all available peripherals/signals by selecting the checkbox in
the first column or scroll down to the required peripheral type.
3. For the selected peripheral, select one of the available Signals.
Pins Tool
Items in Peripheral column in Routing Details view have the following symbols:
• Exclamation mark and default text color indicates that such item selection can cause a register conflict or the item does
not support selected signal.
• Exclamation mark and gray text color indicates that the item cannot be routed to the selected pin/internal signal. The
item is available for different pin/internal signal using the same signal.
NOTE
In the Pins view and the Package view you can configure only pins and not internal signals.
3.1.3 Routing of peripheral signals
Peripheral signals representing on-chip peripheral input or output can be connected to other on-chip peripherals or to a pin through
an inter-peripheral crossbar. You can configure this connection in the Routing Details view.
Three types of peripheral signal routing are available:
1. Routing the signal from the output of an internal peripheral (A) into the input of another internal peripheral (B)
The signal leads from the output of one internal peripheral (A) to the input node of another internal peripheral (B). In other
words, signal leads from A to B (A > B). To configure a signal in this way, perform the following steps (PWM triggering ADC
(PWM > ADC) used as example):
a. Add a new row in the Routing Details view.
b. Select peripheral B from the drop-down list in the Peripheral column.
NOTE
It’s necessary to select the ADC peripheral where the signal leads to (input in ADC). It’s a limitation of the Pins tool
that the signal is not listed for the PWM peripheral (output). Notice the direction of the signal in the Arrow column.
2. Routing the signal from a pin on the package to internal peripheral input signal through an inter-peripheral crossbar
NOTE
Only if a crossbar switch is present.
The signal leads from a pin on the package (XB_IN) connected through an inter-peripheral crossbar, to an internal
peripheral (B) input node. In other words, the signal leads from XB_IN to B (XB_IN > B). To configure a signal in this way,
perform the following steps (routing pin 55 using XB_IN6 to EVTG0 input A (XB_IN6 > EVTG0) used as example):
a. Add a new row in the Routing Details view.
b. Select peripheral B from the drop-down list in the Peripheral column.
Pins Tool
Figure 22. Selecting the peripheral (B)>
c. Select the input node of peripheral B from the drop-down list in the Signal column.
The signal leads from internal peripheral (A) output to a pin connected through an inter-peripheral crossbar on the package
(XB_OUT). In other words, the signal leads from A to XB_OUT (A > XB_OUT). To configure a signal in this way, perform
the following steps (routing EVTG0 output to a pin 87 using XB_OUT4 used as an example):
a. Add a new row in the Routing Details view.
b. Select peripheral A from the drop-down list in the Peripheral column.
Pins Tool
Figure 26. Selecting the peripheral (A)
c. Select the input node of peripheral A from the drop-down list in the Signal column.
Figure 27. Selecting the output signal (A)
d. Select the XB_OUT pin from the drop-down list in the Route to column.
4. You can now copy-paste the content of the source(s) to your application and IDE. Alternatively, you can export the
generated files or update the code with the Update Code button in Toolbar. To export the files, select File > Export (in the
desktop version) or select the menu Pins > Export menu (in the Web version). In the Export dialog expand the tree control
for the tool you want to export sources for and select the Export Source Files option. Export, select the Export Source
Files option.
5. Click Next and specify the directory for each respective core (in multicore configuration) where you want to store the
exported files for each individual core (in case of multicore configuration).
6. Click Finish to export the files.
7. Integrate and use the exported files in your application as source files.
This view shows the list of all the pins available on a given device. The Pin name column shows the default name of the pin, or
if the pin is routed. The pin name is changed to show appropriate function for selected peripheral if routed. The next columns of
the table shows peripherals and pin name(s) on given peripheral. Peripherals with few items are cumulated in the last column.
To route/unroute a pin to the given peripheral, select the relevant cell in the Pin column. Routed pins are highlighted in green. If
a conflict in routing exists, the pins are highlighted in red.
Every routed pin appears in the Routed pins table.
When multiple functions are specified in the configuration, the Pins view shows pins for selected function primarily. Pins for
different functions are shown with light transparency and cannot be configured until switched to this function.
Select a row to open a drop-down list that offers the following options:
• Route/Unroute the pin.
• Highlight the pin in the Package view.
• Set the label and identifier for the pin.
• Add a comment to the pin. You can later inspect the comment in the Code Preview view.
TIP
The option to route more signals to a single pin is indicated by an ellipsis (...). Select the cell to open a dialog to
choose from multiple available signals. The dialog also displays which signals are routed by default.
3.3.2 Package view
The Package view displays the processor package. The processor package provides an overview of the package including
resource allocation.
Show pins as you can see it from the bottom. This option is available on BGA packages only.
Show pins as you can see it from the top. This option is available on BGA packages only.
Show resources. This option is available on BGA packages only.
Switch package.
Package legend.
Pins Tool
NOTE
Depending on the processor package selected, not all views are available.
The Switch package for the Processor window shows list of available processor packages, showing package type and number
of pins.
3.3.3 Peripheral Signals view
The Peripheral Signals view shows a list of peripherals and their signals. Only the Peripheral Signals and Pins view show the
checkbox (allocated) with status.
Table 15. Status codes
Color codeStatus
Error
Configured
Not configured
Warning
Dedicated: Device is routed by default and has no impact on the generated code.
Show pins with low leakage power mode
wake-up capability
Show pins with
digital signals
Show pins with input signals
Show only pins with
interrupt capability
Show pins with
output signals
Show pins with
input/output signals
NXP Semiconductors
Pins Tool
Figure 39. Select signals dialog
3.3.3.1 Filtering in the Pins and Peripheral Signals views
The following image illustrates the filtering controls in the Pins and Peripheral Signals views.
Figure 40. Filtering Controls
Type any text to search across the table/tree. It will search for the pins/peripheral signals containing the specified text. You can
also use wildcards "*" and "?" to help you filter results you want. Use "space" to search for multiple strings at the same time.
In the Routing Details view, you can inspect and configure routed pins and internal signals. You can also configure the electrical
properties of pins and view them. It displays the pad configuration available in a configuration where each pin is associated with
the signal name and the function.
NOTE
The electrical features are configured only for pins in the table. For example, the routed pins.
The table is empty when a new configuration is created, which means no pin is configured. Each row represents configuration of
a single pin and if there are no conflicts, then the code is immediately updated. For Boards/Kits the pins are routed already.
Figure 41. Routing Details
Add a new row with the Add new row button in the view toolbar.
Configure the pin/signal by selecting the Peripheral first, then the required Signal, and finally, the pin to Route to.
Use the columns in the right side of the table to configure the electrical features.
You can also use the Pins and Peripheral Signals views to route pins and peripheral signals and view/modify the configuration in
the Routing Details view. If the feature is not supported,
n/a
is displayed.
To highlight peripheral/pin information in the Package and Pins views, right-click the row and select Highlight.
To filter rows, type the text or the search phrase in the filter area in the view toolbar.
NOTE
When you enter the search text, it also searches the text in the full pin names displays rows that contain the
search text.
To display pins or signals only, use the Pins and Signals buttons in the view toolbar.
To add a new row to the end of table, click on the Add new row button.
To remove the selected row, click on the Delete the selected row button.
To delete a specific row or insert a new row at a given position, right-click and use the dropdown list commands.
To add a specific number of rows, enter the number in the field.
To clear the table, type 0.
To change the order of the rows, use the arrow icons to move one row up or down.
To filter table entries by text, enter the text string in the type filter text field.
To copy the row, right-click any cell in the row and select Copy. You can later paste the copied row into the Routing Details view
of another functional group or configuration by right-clicking the table and choosing Paste.
The gray background indicates read-only items.
The italic value indicates that the value is not configured and it shows the after-reset value and no code is generated, so the
configuration relies on the after reset value or the values configured from the different functions.
• The value shown using italic indicates the after-reset value. The real value may be different from the after reset
value, if configured in other functions.
Use the drop-down menu to select the required value.
• If you select the same value as the after-reset value, the tool will always generate code to set this feature.
Use the drop-down "Reset" value to reset the value to its after-reset state.
• If an item does not support reset to after reset value, the Reset menu is not available.
• The first row shows pin number or coordinate on BGA package.
3.3.4.1 Labels and identifiers
You can define the label of any pin that can be displayed in user interface for ease of identification.
Boards and kits have pre-defined labels. However, it's also possible to define a pin label listed in the Pins and Routing
Details views.
To set\update the Labels and Identifier columns visibility, select Edit > Preferences from the Menu bar, and select the Show pin
label & identifier table columns (Pins tool) checkbox.
The pin identifier is used to generate the #define in the pin_mux.h file. However, it's an optional parameter. If the parameter is
not defined, the code for #define is not generated. Additionally, you can define multiple identifiers, using the “;” character as a
separator. You can also set the identifier by typing it directly into the cell in the Identifier column in the Routing Details views.
Figure 42. Pin identifier
In this case it's possible to select from values if the pin is routed. See Routing Details.
Figure 43. Identifier in Routing Details table
A check is implemented to ensure whether the generated defines are duplicated in the pin_mux.h file. These duplications are
indicated in the identifier column as errors. See Identifier errors.
You can also select the pin to use in a given routing from the Routing Details view. However, the identifier must be a valid C
identifier and should be used in the source code.
Figure 45. Pins macros prefix
If multiple functions are used, each individual function can include a special prefix. Check the Pins > Functional Group Properties
> Set custome #define prefix checkbox to enter prefix of macros in particular function used in the generated code of the pin_mux.h
file. Entered prefix text must be a C identifier. If unchecked, the Function name is used as a default prefix.
3.3.5 Expansion Header
In the Expansion Header view, you can add and modify an expansion header configuration, map the connectors, and route the
pin signals. You can also import and apply an expansion board to the header.
Certain boards, such as LPCXpresso55S69, come with preconfigured expansion headers.
Figure 46. Expansion header
The expansion header is not automatically preset for every supported device. If the header is not preconfigured, follow these steps
to create and modify an expansion header configuration:
1. Open the view by selecting Views>Expansion Header from the Toolbar.
2. Add a new header by selecting the Add button in the view toolbar.
3. In the Add New Expansion Header window, select the Header type from the drop-down list.
Pins Tool
Figure 47. Adding new expansion header
4. Name the header and map the connectors.
Figure 48. Adding new expansion header
5. Select OK.
Expansion Header view now displays the connector layout. You can point your cursor over the pins to display additional
information. Right-click the pin to display a shortcut menu of additional options.
You can create more than one expansion header configuration. Switch between the configurations in the view's
drop-down list.
To highlight the pin/routing configuration in the Pins and Routing Details views, right-click the connector pin and
select Highlight.
Modify the configuration parameters at any time by selecting the Edit button. Information in the Pins view is
updated automatically.
Remove a configuration by selecting the Remove button.
Use the Label drop-down list to switch between display information for header, board, and routing.
3.3.5.1 Expansion Board
In the Expansion Header view, you can also apply an expansion board to an already created expansion header. The expansion
board configuration can be imported into Pins tool in the form of an XML file. Based on the chosen processor, the tool will then
recommend adequate routing.
NOTE
Only a single expansion board can be configured per expansion header.
1. In the Expansion Header view, click the Apply expansion board to the selected header. Alternatively, select Pins>Apply
expansion board from the Menu bar.
2. In the Apply expansion board dialog, click Browse to locate the XML file with expansion board information and click OK.
4. On the next page, choose if you want to create a new functional group for the expansion board, or modify an existing
functional group. In the latter case, use the dropdown list to select from available functional groups.
5. In the Expansion Board Routing table, inspect the suggested routing of expansion board pins. If you want to change the
route of a pin, click the pin cell in the Route column and select the signal in the Connector pin dialog and click Done.
6. Choose how you want to populate identifiers for code. Following options are available:
• Expansion header names
• Expansion board names
• None
7. Click Apply to apply the settings.
You can change the expansion board signal routing at any time by clicking the Configure routing for expansion board button
in the Expansion Header view.
3.3.6 Highlighting and color coding
You can easily identify routed pins/peripherals in the package using highlighting. By default, the current selection (pin/peripheral)
is highlighted in the Package view.
• The pin/peripheral is highlighted by yellow border around it in the Package view. If the highlighted pin/peripheral is selected
then it has a blue border around it.
— Click on the peripheral or use the pop-up menu to highlight peripherals:
◦ and all allocated pins (to selected peripheral).
◦ or all available pins if nothing is allocated yet.
— Click on the pin or use the pop-up menu to highlight the pin and the peripherals.
— Click outside the package to cancel the highlight.
• Peripherals / Pins view
— The peripheral and pin behaves as described above image.
3.4 Errors and warnings
Pins Tool
The Pins Tool checks for any conflict in the routing and also for errors in the configuration. Routing conflicts are checked only
for the selected function. It is possible to configure different routing of one pin in different functions to allow dynamic pins
routing re-configuration.
Figure 57. Error and warnings
If an error or warning is encountered, the conflict in the Routing Details view is represented in the first column of the row
and the error/warning is indicated in the cell, where the conflict was created. The first two rows in the figure above show the
peripheral/signal where the erroneous configuration occurs. The fourth row shows the warning on the unconfigured identifier while
specifying a direction. The detailed error/warning message appears as a tooltip.
For more information on error and warnings color, see the Highlighting and Color Coding section.
3.4.1 Incomplete routing
A cell with incomplete routing is indicated by a red background. To generate proper pin routing, click on the drop down arrow and
select the suitable value. A red decorator on a cell indicates an error condition.
The tooltip of the cell shows more details about the conflict or the error, typically it lists the lines where conflict occurs.
You can also select Pins > Automatic Routing from the Main menu to resolve any routing issues.
NOTE
Not all routing issues can be resolved automatically. In some cases, manual intervention is required.
3.5 Code generation
If the settings are correct and no error is reported, the code generation engine instantly re-generates the source code. You can
view the resulting code the Code Preview view of the Pins tool.
Code Preview automatically highlights differences between the current and immediately preceding iteration of the code. You
can choose between two modes of highlighting by clicking the Set viewing style for source differences. You can also disable
highlighting altogether from the same dropdown menu.
For multicores, the sources are generated for each core. Appropriate files are shown with @Core #{number} tag.
NOTE
The tag name may be different depending on the selected multi-core processor family/type.
You can also copy and paste the generated code into the source files. The view generates code for each function. In addition to
the function comments, the tool configuration is stored in a YAML format. This comment is not intended for direct editing and can
be used later to restore the pins configuration.
YAML configuration contains configuration of each pin. It stores only non-default values.
TIP
For multicore processors, it will generate source files for each core. If processor is supported by SDK, it can
generate BOARD_InitBootPins function call from main by default. You can specify "Call from BOARD_InitBootPins"
for each function, in order to generate appropriate function call.
3.6 Using pins definitions in code
The Pins tool generates definitions of named constants that can be leveraged in the application code. Using such constants based
on user-specified identifiers allows you to write code which is independent of configured routing. In the case you change the pin
where the signal is routed, the application will still refer to the proper pin.
The name of the define is composed from function group prefix and pin identifier. For more details. see Functional groups and
Labels and identifiers sections.
To write to this GPIO pin in application using the SDK driver (fsl_gpio.h), you can for example use the following code referring to
the generated defines for the pin with identifier
The Clocks Tool configures initialization of the system clock (core, system, bus, and peripheral clocks) and generates the C code
with clock initialization functions and configuration structures.
4.1 Features
The Clocks tool allows you to perform various actions related to the Clock initialization, among them the following:
• Inspect and modifies element configurations on the clock path from the clock source up to the core/peripherals.
• Validate clock elements settings and calculates the resulting output clock frequencies.
• Generate a configuration code using the SDK.
• Modify the settings and provides output using the table view of the clock elements with their parameters.
• Navigate, modify, and display important settings and frequencies easily in Diagram view.
• Edit detailed settings in Details view.
• Inspect the interconnections between peripherals and consuming clocks in Module Clocks view.
• Find clock elements settings that fulfills given requirements for outputs.
• Fully integrated in tools framework along with other tools.
• Shows configuration problems in Problems view and guides the user for the resolution.
4.2 User interface
The Clocks tool is integrated and runs within the MCUXpresso Config Tools framework.
Each clock configuration (functional group) lists the settings for the entire clock system and is a part of the global configuration
stored in the MEX file. Initially, after the new clock configuration is created, it's set to reflect the default after-reset state of
the processor.
There can be one or more clock configurations handled by the Clocks tool. The default clock configuration is created with the name
“
BOARD_BootClockRUN
All clock settings are stored individually for each clock configuration so that each clock configuration is
configured independently.
Clocks configurations (functional groups) are presented at the top of the view. You can switch between them by selecting them
from the dropdown menu.
Figure 61. Default clock configuration
The code generation engine of the tool generates function with the name derived from the Clock
configuration name.
”. Multiple configurations means multiple options are available for the processor initialization.
NOTE
NOTE
4.4 Global settings
Global settings, such as Run Mode and MCG mode, influence the entire clock system. It's recommended to set them first. Global
settings can be modified in Clock Table, Clock Diagram, and Details views.
NOTE
Global settings can be changed at any time.
Figure 62. Global settings
4.5 Clock sources
The Clock Sources table is located in the Clocks Table view. You can also edit the clock sources directly from the Diagram view
or from the Details view.
You can configure the availability of external clock sources (check the checkbox) and set their frequencies. Some sources can
have additional settings available when you unfold the node.
If the external crystal or the system oscillator clock is available, check the checkbox in the clock source row and specify
the frequency.
NOTE
Some clock sources remain inactive even though the checkbox is checked. This is because the clock sources
functionality depends on other settings like power mode or additional enable/disable setting options. You can hover
the cursor on the setting to see a tooltip with information on the element and possible limitations/options.
4.6 Setting states and markers
The following states, styles, and markers reflect the information shown in the settings’ rows in the settings tables (clock sources,
output, details or individual).
Table 16. Setting states and markers
State/Style/
IconDescription
Marker
Error markerIndicates that there is an error in the settings or something related to it. See the tooltip of the
setting for details.
Warning markerIndicates that there is a warning in the settings or something related to it. See the tooltip of
the setting for details.
Lock iconIndicates that the settings (that may be automatically adjusted by the tool) are locked
to prevent any automatic adjustment. If the setting can be locked, they are automatically
locked when you change the value. To add/remove the lock manually, use the pop-up menu
command Lock/Unlock.
NOTE
The clock element settings that cannot be automatically adjusted by the tool
keep their value as is and do not allow locking. These are: clock sources, clock
selectors and configuration elements.
Yellow
Indicates that the field is directly or indirectly changed by the previous user action.
background
Gray textIndicates that the value of setting does not actively influence the clock. It is disabled or
relates to an inactive clock element. For example, on the clock path following the unavailable
clock source or disabled element. The frequency signal also show the text “inactive” instead
of frequency. The value is also gray when the value is read-only. In such a state it is not
possible to modify the value.
4.7 Frequency settings
The Clocks tool instantly re-calculates the state of the entire clock system after each change of settings from the clock source up
to the clock outputs.
The current state of all clock outputs is listed in the Clock Outputs view located on the right side of the clock sources. The displayed
value can be:
• Frequency – Indicates that a clock signal is active and the output is fed with the shown frequency. The tool automatically
chooses the appropriate frequency units. In case the number is too long or has more than three decimal places, it's shortened
and only two decimal places are shown, followed by an ellipsis (‘…’), indicating that the number is longer.
• “Inactive” text – Indicates that no clock signal flows into the clock output or is disabled due to some setting.
If you have a specific requirement for an output clock, click on the frequency you would like to set, change it, and press Enter.
In case the tool has reached/attained the required frequency, it appears locked and is displayed as follows:
Figure 65. Tool attains the required frequency
In case the tool is not able to reach/attain the required frequency or some other problem occurs, it's displayed as follows:
Figure 66. Tool encounters problem
The frequency value in square brackets [ ] indicates the value that the tool is actually using in the calculations instead of the value
that has been requested.
NOTE
You can edit or set requirements only for the clock source and the output frequencies. The other values can be
adjusted only when no error is reported.
4.7.1 Pop-up menu commands
• Lock/Unlock – Removes a lock on the frequency which enables the tool to change any valid value that satisfies all other
requirements, limits, and constraints.
• Find Near Valid Value – Tries to find a valid frequency that lies near the specified value, in case the tool failed in reaching the
requested frequency.
Figure 67. Pop-up menu commands
4.7.2 Frequency precision
For locked frequency settings (where user requests a specific value) the frequency precision value is also displayed. By default,
the value is 0.1% but can be individually adjusted by clicking the value.
Figure 68. Frequency precision
4.8 Dependency arrows
In the Clocks Table view, the area between the clock sources and the clock output contains arrows directing the clock source to
outputs. The arrows lead from the current clock source used for the selected output into all outputs that are using the signal from
the same clock source. This identifies the dependencies and the influences when there is change in the clock source or elements
on a shared clock path.
• Display clock-element information - Point the mouse cursor at the clock element to display general clock-element information.
• View the clock-element in Clocks Diagram or Clocks Table - Left-click on a clock element to highlight it in the Clocks Diagram
or Clocks Table views, depending on which is currently active.
• View detailed clock-element information - Double-click on a clock element to display element details, as well as highlight the
element in Clocks Diagram or Clocks Table, depending on which is currently active. You can also view element details by
clicking the Open in new window button in the upper right corner of the Details view.
• Modify clock-element settings - Left-click in the Value column to change clock element value, such as frequency, or select an
option from the dropdown menu.
• Lock/unlock clock elements - Right-click on a clock element to lock/unlock the element.
• Filter for active/locked/erroneous clock elements - Use the buttons in the upper-right corner of the Details view to filter for
active/locked/erroneous clock elements, or to remove all current filters.
4.10 Clocks diagram
The clocks diagram shows the structure of the entire clock model, including the clock functionality handled by the tool. It visualizes
the flow of the clock signal from clock sources to clock output. It's dynamically refreshed after every change and always reflects
the current state of the clock model.
At the same time it allows you to edit the settings of the clock elements.
Figure 71. Clocks diagram
4.10.1 Mouse actions in diagram
You can perform the following actions in the Clock diagram view.
• Position the mouse cursor on the element to see the tooltip with the information on the clock element such as status,
description, output frequency, constraints, and enable/disable conditions.
The clock model consists of interconnected clock elements. The clock signal flows from the clock sources through various clock
elements to the clock outputs. The clock element can have specific enable conditions that can stop the signal from being passed
to the successor. The clock element can also have specific constraints and limits that are watched by the Clocks Tool. To inspect
these details, position the cursor on the element in the clock diagram to display the tooltip.
The following are the clock model elements.
• Clock source – Produces a clock signal of a specified frequency. If it's an external clock source, it can have one or more
related pins.
Figure 74. Clock source
• Clocks selector (multiplexer) – Selects one input from multiple inputs and passes the signal to the output.
Figure 75. Clocks selector
• Prescaler – Divides or multiplies the frequency with a selectable or fixed ratio.
Figure 76. Prescaler
• Frequency Locked Loop (FLL) – Multiplies an input frequency with given factor.
Figure 77. Frequency Locked Loop
• Phase Locked Loop (PLL) – Contains pre-divider and thus is able to divide/multiply with a given value.
• Clock gate – Stops the propagation of incoming signal.
• Clock output – Marks the clock signal output that has some name and can be further used by the peripherals or other parts
of the processor. You can put a lock and/or frequency request.
Figure 79. Clock output
• Clock component – Group of clock elements surrounded with a border. The clock component can have one or more outputs.
The clock component usually corresponds to the processor modules or peripherals. The component output may behave like
clock gates, allowing or preventing the signal flow out of the component.
Figure 80. Clock component
• Configuration element – Additional setting of an element. Configuration elements do not have graphical representation in the
diagram. They are shown in the setting table for the element or the clock path the element is on.
4.11 Clocks menu
Options related to the Clocks tool can be found in the Clocks menu in the Menu bar.
Table 17. Clocks menu
Menu itemDescription
Functional groupsOpen the Functional group properties dialog.
RefreshRefresh each clocks configuration with explicit invocation of code generation.
Reset To Board DefaultsReset the clock model to board defaults.
Reset To Processor DefaultsResets the clock model ito processor defaults.
Unlock All SettingsUnlocks all locks in all settings.
Unlock Settings on the Active PathUnlocks all locks in the settings that are on the active path.
4.12 Troubleshooting problems
It's possible that problems or conflicts occur while working with the Clocks Tool. Such problems and the overall status are indicated
in red on the central status bar of the Clocks Tool. The status bar displays global information on the reported problem.
1. Requirement(s) not satisfiable: Indicates that there are one or more locked frequency or frequency constraints for which
the tool is not able to find a valid settings and satisfy those requirements.
2. Invalid settings or requirements: [
element list
] – Indicates that the value of a settings is not valid. For example: The current
state of settings is beyond the acceptable range.
The following are some tips to troubleshoot encountered problems.
1. Find the elements and settings with marked errors in the diagram or tables and see the details in the tooltip.
2. Start with only one locked frequency and let the tool find and calculate other ones. After you are successful you can
add more.
3. Go through the locked outputs, if there are any, and verify the requirements (possible errors in the required frequency,
wrong units, and so on).
4. If you are OK to have a near around of the requested value, right-click and from the pop-up menu select Clock output > Find
near value.
5. If you cannot reach the values you need, see the clock paths leading to the clock output you want to adjust and check the
selectors if it's possible to switch to another source of clock.
6. Try to remove locks by selecting Clocks > Unlock All Settings. In case many changes are required, you can simply reset
the model to the default values and start from the beginning. To reset, select Clocks > Reset to processor defaults.
You can resolve most of the reported problems using the Problems view. Each problem is listed as a separate row. The following
options appear when you right-click on a selected row in the Problems view.
• Show problem - Shows the problem in the Clocks Diagram view If one the solutions are possible then the pop up is
extended by:
— Remove lock - Removes the lock from erroneous element.
— Find Near value - Finds the nearest value.
Figure 81. Find Near Value Dialog
◦ Unlock settings active path and try again - unlocks all elements that lead to selected output and tries to recompute.
◦ Unlock settings and try again - unlocks all locked values and tries to recompute. If automatic value computation fails,
nothing will be changed.
◦ Cancel - cancels the modifications.
4.13 Code generation
If the settings are correct and no error is reported, the tool’s code generation engine instantly re-generates the source code. The
resulting code is found in the Code Preview view.
Code Preview automatically highlights differences between the current and immediately preceding iteration of the code. You
can choose between two modes of highlighting by clicking the Set viewing style for source differences. You can also disable
highlighting altogether from the same dropdown menu.
The generated code is aligned with the SDK. To use the code with the SDK project it's necessary to transfer the code into your
project structure.
To transfer the code into your project, do the following in the Code Preview:
• Copy the content using the COPY command, either by pressing the CTRL+C keys or the pop-up menu after the whole text
is selected.
• Use export command.
• Click the Export button in Code Preview view.
• Click Update Code in the toolbar.
4.14 Clock Consumers view
The Clock Consumers view provides an overview of peripheral instances. It also provides information on clock-clock instance
pairing. This view is not editable and is for information only.
• User friendly user interface allowing to inspect and modify settings
• Smart configuration component selection along the SDK drivers used in toolchain project
• Instant validation of basic constraints and problems in configuration
• Generation of initialization source code using SDK function calls
• Multiple functional-group support for initialization alternatives
• Configuration problems are shown in the Problems view and marked with decorators in other views
• Integration in MCUXpresso Config Tools framework along with other tools
• Middleware configuration support (USB)
5.2 Basic terms and definitions
Table 18. Terms and definitions
TermDefinition
Functional groupRepresents a group of peripherals that are initialized as a group. The tool generates
a C function for each functional group that contains the initialization code for the
peripheral instances in this group. Only one functional group can be selected as default
initialization, the others are treated as alternatives that are not initialized by default.
Peripheral instanceOccurrence of a peripheral (device) of specific type. For example, UART peripheral
has three instances on the selected processor, so there are UART0, UART1 and
UART2 devices.
Configuration componentProvides user interface for configuring SDK software component (for example,
peripheral driver) and generates code for its initialization.
Component instanceConfiguration component can have multiple instances with different settings. (for
example, for each peripheral instance like UART0, UART1).
Component modeSpecific use-case of the component instance (for example, TRANSFER mode of DSPI,
or interrupt-based mode of communication.
5.3 Workflow
The following steps briefly describe the basic workflow in the Peripherals tool.
1. In the Peripherals view, select the peripheral instance you would like to configure (use the checkbox).
2. In case more components are available for use by the peripheral, the Select component dialog appears. The dialog
displays the list of suitable configuration components for the selected peripheral matching the SDK driver for the
selected processor.
3. Select the component you want to use and click OK.
In the Components view, you can perform several actions.
Table 21. Components view actions
Display configuration-component informationPoint the mouse cursor at the configuration component to
display general configuration-component information.
Open the Settings Editor of the configuration componentLeft-click the configuration component to open its
Settings Editor.
Add new configuration componentsLeft-click the + button and select from the list to add a
new component. In the Select component dialog, you can
filter the list to show only toolchain-project-relevant, or latest
version components. You can also click the + buttons next
to Middleware/Peripheral drivers/Other categories to add new
components in them directly.
The Peripherals view contains a table showing a list of available peripherals on the currently selected processor that can be
configured by the Peripherals tool. In case of multicore processors, the displayed peripherals are also core-specific.
Each instance of a peripheral (for example, UART0) occupies one row. First column contains peripheral name and a checkbox
indicating whether the peripheral is used by any component instance.
Second column contains a name of component instance handling the peripheral. This name is customizable in the settings editor
and it is used in generated code. The name of the component instance can't contain spaces.
You can enable an instance by selecting the checkbox, or by clicking the switch in the settings editor of the component instance.
Disable a component instance by deselecting it.
Double-click on the second column to open the Settings Editor for the component instance.
Right-click the the peripheral to open a shortcut menu. Several options are available in the shortcut menu.
Table 23. Shortcut menu options
OptionDescription
OpenOpen the component instance in the Settings Editor.
Open in another viewDuplicate the component instance in the Settings Editor.
AddAdd a component instance to the peripheral.
Edit commentCreate/Edit custom notes for the component instance.
Lock/Unlock editing of component instanceLock/Unlock the editing of the component instance.
DocumentationDisplay the documentation of the component instance, if available.
RemoveRemove the component instance from configuration. If more instances
are in use, a confirmation window will allow you to select which
instance you want to remove.
MigrateMigrate the component to a different component type or to a
component with a newer driver version.
Enable/DisableEnable/Disable the component instance.
Move toChoose from available functional groups to move the component
instance to.
Copy toChoose from available functional groups to copy the component
instance to.
Initialized in user code
Mark the peripheral as configured by user code (available on not
configured peripherals).
5.4.4 Settings Editor
You can edit peripheral component settings in the Settings Editor. Open editors are shown in the central area of the screen,
each with its own tab. Multiple editors can be opened at the same time. Changes done in the editor are immediately applied and
kept even if the settings editor is closed. Settings that are disabled are highlighted in gray. In case that a component instance
is disabled, all settings are highlighted in gray. Tooltips are displayed for all enabled settings when the mouse cursor is placed
at settings.
To open Settings Editor, do the following:
• Double-click the component instance in the Peripherals or Components view to display component instance settings.
• Left-click the component in the Components view to display global settings of the component.
Settings are grouped to larger groups (config sets) that may provide presets with typical values. You can use these presets to
quickly set the desired typical combination of settings or return to the default state.
Figure 88. Quick selection example
5.4.4.2 Settings
Following setting types are available in the Settings Editor
• Boolean – Two state setting (yes/no, true/false).
Figure 89. Boolean setting example
• Integer, Float – Integer or float number.
Figure 90. Integer/Float setting example
• String – Textual input. More than a single entry can be supported.
Figure 91. String setting example
• Enumeration – Selection of one item from list of values.
• Set – List of values, multiple of them can be selected.
Figure 93. Set setting example
• Structure – Group of multiple settings of different types, may contain settings of any type including nested structures.
Figure 94. Structure setting example
• Array – Array of multiple settings of same type – you can add/remove items. The array of simple structures may also be
represented as a table grid, master-detail, and as radio buttons.
Figure 95. Array
The ‘+’ button adds a new item at the end of array. To rearrange the position or delete an item, right-click the item and select
one of the following options: Move up, Move down, Move to top, Move to bottom, or Remove. You can also copy-paste an array
from one instance to another by right-clicking the array label and choosing Copy. You can then navigate to another instance
array, right-click the table and choose Paste to add it.
• File setting - Link/import an external settings file.
Peripherals Tool
5.4.4.3 Settings Editor header
All components share the Settings Editor header. In the header, you can view and change component information, enable or
disable the component, and view component documentation (where applicable).
Figure 98. Settings Editor header
Table 24. Settings Editor header
Header itemDescription
DescriptionDisplays the configuration component title.
NameDisplays the component instance name. This name is used in the
generated code in constants and function identifiers and is derived from
the peripheral name. You can change it at any time by clicking the Custom
name button and editing the field.
ModeDisplays the required usage for the component instance and influences
available settings. Use the dropdown menu to change the mode
(where applicable).
PeripheralDisplays the name of the peripheral to be associated with the component
instance. Use the dropdown menu to change it.
DocumentationClick the button to view configuration component-specific documentation
in the Documentation view. Note that not all configuration components
are documented, therefore not all setting headers contain the
Documentation icon.
You can open the Documentation view in several ways:
• In the Peripherals view, right-click the peripheral checkbox and choose Documentation from the list.
• In the Components view, right-click the component and choose Documentation from the list.
• In the Settings Editor, click the Documentation button next to component name.
• In the Settings Editor, click the question mark next to the settings label.
5.5 SEMC Validation tool
If you are developing hardware with external memory, you can validate the memory settings with the Memory Validation tool. The
tool is available for all SEMC, FlexSPI/NOR, and FCB peripherals and can be used after selecting these peripheral from the list
in the Peripherals view.
Click the Validation button in the Settings Editor to open the Validation view and run validation scenarios for SEMC
memory settings.
NOTE
The Memory Validation tool requires Python 2.7 to run. You must manually install the latest Python 2.7 from
https://www.python.org/downloads and make sure arm-none-eabi-gdb-py starts without error. It's possible that
Windows requires that python27.dll is installed.
Should the settings prove valid, you can click the Sync with DCD button to synchronize the memory settings with the DCD tool.
You need to manually update the existing sdram configuration from the DCD tool with the one generated by clicking Apply to DCD.
Also, if a configuration is not defined in the DCD tool, the configuration generated by clicking Apply to DCD will not work as it is,
and additional configuration will need to be added in the Clocks or Pins tools.
5.5.1 Validation view
Use the Validation view to run validation scenarios for your memory settings and analyse the results. You can choose scenarios,
tests to run in these scenarios, and view the test results, logs, and summary.
To run validation tests, do the following:
1. Select the correct connection type and COM port in the Connections area. Alternatively, scan for available COM ports by
clicking the Scan for available COM ports button.
2. Choose a scenario you wish to test in the Scenarios sub-view.
a. To test the Phy configuration:
i. Select Firmware Init > Firmware Init test.
b. To perform a basic memory check by running Write-Read-Compare/Walking Ones/Walking Zeros:
i. Select Operational > Operational tests.
ii. Select Choose Tests.
iii. Select the tests to perform and set the test parameters.
c. To run stress tests:
i. Select Stress Tests > Stress tests.
ii. Select Choose Tests and set the test parameters.
d. To run diags tests:
i. Select Diags and choose between Diags margin state/Diag Write Margin/Diag Read Margin.
ii. Select Choose Tests and set the test parameters.
3. To start validation, click the Start Validation button.
4. Observe the results in real-time in the Results sub-view.
5. Inspect the results in the Summary and Logs sub-views.
6. View the U-boot-compatible code in Core Preview. You can export the generated code for importing into U-boot by selecting
the Export button.
7. Download DDRV reports using the Configure and generate DDRV reports button.
5.6 Problems
The tool validates the settings and problems and errors are reported in the Problems view.
If there is an error related to the setting or component an error decorator is shown next to the element containing an error.
Figure 100. Error decorators
In the case of a dependency error, a quick-fix button is displayed.
Figure 101. Quick fix 1
Right-click the button to display a list of issues, then left-click the issue to display possible solutions.
Figure 102. Quick fix 2
5.7 Code generation
If the settings are correct and no error is reported, the tool’s code generation engine instantly re-generates the source code. You
can view the resulting code the Code Preview view of the Peripherals tool.
Code Preview automatically highlights differences between the current and immediately preceding iteration of the code. You
can choose between two modes of highlighting by clicking the Set viewing style for source differences. You can also disable
highlighting altogether from the same dropdown menu.
The Peripherals tool produces the following C files:
• peripherals.c
• peripherals.h
NOTE
For multicore processors the peripherals.c/.h are generated for each core, containing functional groups associated
with that core. This can be configured in functional group properties.
• Global variables for the user application that are used in the initialization. For example, handles and buffers.
• Initialization function for each configuration component.
• Initialization function for each functional group. The name of the function is the same as the functional group name. These
functions include execution of all assigned components’ initialization functions.
• Default initialization function containing call to the function initializing the selected functional group of peripherals.
NOTE
The prefixes of the global definitions (defines, constants, variables and functions) can be configured in the
Device Configuration tool allows you to configure the initialization of memory interfaces of your hardware. Use the Device
Configuration Data (DCD) view to create different types of commands and specify their sequence, define their address, values,
sizes, and polls.
Figure 104. Device Configuration tool
6.1 Device Configuration Data (DCD) view
The Device Configuration Data (DCD) view displays memory initialization commands of your currently active configuration. Here,
you can create new command groups and commands and specify their parameters.
Commands in the Device Configuration Data (DCD) can be synchronised from the SEMC Validation tool in the Peripherals tool.
6.1.1 Device Configuration Data (DCD) view actions
The following is a list of command and command group-relevant actions you can perform in the Device Configuration Data
(DCD) view:
• Create a new command group - Right-click the table and choose Add Group from the context menu.
• Re/Name a command group - Left-click the command group cell and enter the required name.
• Disable a command group - Right-click the command group row and choose Disable Group from the context menu.
• Remove a command group - Right-click the command group row and choose Remove Group from the context menu.
• Collapse all command groups - Right-click the the table and choose Collapse All Groups from the context menu.
• Expand all command groups - Right-click the table and choose Expand All Groups from the context menu.
• Add a command to a group - Right-click the table and choose Add Command from the context menu. Alternatively, click the
Add Command button in the tool's toolbar.
• Specify command type - Left-click the row's Command cell and choose from the dropdown menu.
• Specify register address for a command - Left-click the row's Address cell and choose from the dropdown menu.
• Specify a value or a mask for a command - Left-click the row's Value(s) / Mask(s) cell to open the mask window. Enter the
value into the field and select OK. Alternatively, select Cancel to cancel the operation, or Reset to reset the value.
Figure 105. Mask
• Specify the size of write/read data for a command - Left-click the row's Size cell and choose from the dropdown menu.
• Specify the number of polls of a command - Left-click the row's Poll cell and enter the required value.
• Add a comment to a command - Left-click the row's Comment cell.
• Remove a command - Right-click the command row and choose Remove Command from the context menu. Alternatively,
click the Remove Command button in the tool's toolbar.
• Cut a command - Right-click the command row and choose Cut from the context menu.
• Copy a command - Right-click the command row and choose Copy from the context menu.
• Paste a command - Right-click the command row and choose Paste from the context menu.
NOTE
You can remove all commands by clicking Device Configuration in the Menu bar and choosing Clear All Commands
from the dropdown menu.
Basic cell selection shortcuts are applicable.
• Select additional commands - Ctrl+Left-click the command row.
If the settings are correct and no error is reported, the code generation engine instantly re-generates the source code. You can
view the resulting code the Code Preview view of the Device Configuration tool.
Code Preview automatically highlights differences between the current and immediately preceding iteration of the code. You
can choose between two modes of highlighting by clicking the Set viewing style for source differences. You can also disable
highlighting altogether from the same dropdown menu.
Device Configuration source code can be generated in a C array (default) or binary format.
The code in a C array format is generated in two files:
• dcd.c
• dcd.h
The code in a binary format is generated in a single file:
• dcd.bin
To change the code format, choose the required option from the dropdown menu in the Device Configuration Data (DCD) view.
In the Trusted Execution Environment, or TEE tool, you can configure security policies of memory areas, bus masters, and
peripherals, in order to isolate and safeguard sensitive areas of your application.
You can set security policies of different parts of your application in the Security Access Configuration and its sub-views, and
review these policies in the Memory Attribution Map, Access Overview. and Domains Overview views. Use the User Memory
Regions view to create a convenient overview of memory regions and their security levels.
You can also view registers handled by the TEE tool in the Registers view, and inspect the code in the Code Preview tool.
NOTE
In order for your configuration to come into effect, make sure you have enabled the relevant enable secure check
option in the Miscellaneous sub-view of the Security Access Configuration view.
The features and appearance of the TEE tool are based on the security model of the loaded device.
This section describes the features and appearance of the tool for devices with ARM TrustZone and AHB with security extension
Currently, following devices of this type are supported:
• LPC55Sxx
— LPC55S69, LPC55S66
— LPC55S16, LPC55S14
— LPC55S06, LPC55S04
• RT6xx, RT5xx
— MIMXRT685S, MIMXRT633S
— MIMXRT595S, MIMXRT555S, MIMXRT533S
NOTE
Pre-production only.
7.1.1 User Memory Regions view
In the User Memory Regions view, you can create and maintain a high-level configuration of memory regions and their security
levels. You can create the regions, name them, specify their address, size, security level, and provide them with a description. You
can then fix any errors in the settings with the help of the Problems view.
Create a new memory region by clicking the Add new memory region button in the view's header.
Enter/change the memory region's parameters by clicking the row's cells. In the Security Level column, you have these options
to choose from:
Errors in configuration are highlighted by a red icon in the relevant cell. In the case the issue is easily fixed, you can right-click the
cell to display a dropdown list of offered solutions.
Remove the memory region by selecting the table row and clicking the Remove selected memory region(s) button in the
view's header.
You can import memory region configuration from other IDE projects by clicking the Import memory regions configuration from the
IDE project(s) button in the view toolbar. Select the project you want from the list to import its memory regions settings into your
current project.
NOTE
After the import, you might have to correct some of the security levels manually.
In the Security Access Configuration view, you can configure your application's security policies in a number of ways. See the
following sections for more details.
7.1.2.1 SAU
In the SAU sub-view, you can enable and configure SAU (Security attribution unit).
When enabled, you can set up SAU memory regions, specify their start and size or end address, and specify their security level.
SAU automatically sets the entire memory space to a secure severity level when disabled. It also sets the entire memory space
to a secure security level when enabled but without set memory regions.
You can choose between two security levels:
• NS - Non-secure
• NSC - Non-secure callable
Alternatively, you can set all the SAU memory regions to non-secure security level by selecting the All Non-Secure.
NOTE
This option is only available when SAU is disabled.
You can also decide to generate code even for disabled memory regions by selecting the option Generate sources for
disabled regions.
In the Interrupts sub-view, you can set security designation for device's peripheral interrupts. In case that the processor contains
more than a single core or processing unit, additional Handling by Core tables might appear. In these tables, you can specify if
the interrupts coming from the peripheral can be handled by the core or processing unit.
All interrupts are set to Secure by default. If you want to change the interrupt source's security designation, left-click the Secure cell
of the interrupt and choose from the dropdown menu. Alternatively, right-click the interrupt's Name cell and choose the security
designation from the context menu. To select multiple entries, use the Ctrl+Left-click shortcut, then right-click the selected area
for the context menu.
In the Secure MPU and Non-secure MPU sub-views, you can enable and configure MPU (Memory Protection Unit). You can
create regions, specify their address, size, and other parameters. Use the Secure MPU sub-view for the configuration of the
secure, and Non-secure MPU for the configuration of the non-secure security level.
Use the MPU Memory Attributes table to name and configure MPU memory attribute sets. Click the cells of the Memory Type and
Device Attributes columns to display the available choices.
Use the MPU Memory Regions table to enable and configure MPU memory regions.
1. Enable the region.
2. Specify the Address.
3. Specify either the Size or the End Address.
4. Set the Exec option if you want the region to be able to run code.
5. Set the Permissions (Read Only or Read/Write).
6. Set the Privileges.
NOTE
Privileged access can be set by default for all memory regions not handled by MPU by selecting the Enable
privileged software access to the default memory map option.
7. Set the Shareability, or the caching options.
8. Allocate one of the sets from the MPU Memory Attributes table in Mem.Attr.. Sets can be allocated to more than one region.
7.1.2.4 MPC
In the MPC (Memory Protection Checker) sub-view, you can set security policies on entire memory sectors as defined by
physical addresses.
Set the memory sector security level by left-clicking the relevant cell in the Security level column and choosing from the dropdown
list. Alternatively, you can right-click the relevant cell in the Sector column and choose the security level from the context menu.
To select multiple entries, use the Ctrl+Left-click shortcut, then right-click the selected area for the context menu.
You have four security levels to choose from, in ascending order of security:
In the Masters/Slaves sub-view, you can configure security levels for bus masters and slaves.
Set the bus master/slave security level by left-clicking the relevant cell in the Security level column and choosing from the
dropdown list. Alternatively, you can right-click the relevant cell in the Master and Slave column and choose from the security
level from the context menu. To select multiple entries, use the Ctrl+Left-click shortcut, then right-click the selected area for the
context menu.
You have four security levels to choose from, in ascending order of security:
• NS-User - Non-secure user
• NS-Priv - Non-secure privileged
• S-User - Secure user
• S-Priv - Secure privileged
You can further specify the interrelation between master and slave security levels by selecting the following options:
• Simple Master in Strict Mode - Select to allow simple bus master to read and write on same level only. De-select to allow to
read and write on same and lower level.
• Smart Master in Strict Mode - Select to allow smart bus master to execute, read, and write to memory at same level only.
De-select to allow to execute on same level only, read and write on same and lower level.
NOTE
Instruction-type bus master security level must be equal to bus slave security level. Data and others security level
must be equal or higher than bus slave security level.
In the Pins sub-view, you can specify if the reading GPIO state is allowed or denied.
All pins' reading GPIO state is set to Allow by default. If you want to change the pins reading GPIO state, left-click the Reading
GPIO state cell of the pin and choose from the dropdown menu. Alternatively, right-click the pin's Name cell and choose the
reading GPIO state from the context menu. To select multiple entries, use the Ctrl+Left-click shortcut, then right-click the selected
area for the context menu.
In the Miscellaneous sub-view, you can set various configuration options. The list of these options depends on processor data,
and varies greatly. All the options influence your register settings, and can be inspected in the Register view. Only some of the
options directly influence configuration you have made in the Security Access Configuration view. Point your cursor over individual
options to display a tooltip explaining the function of each option.
Figure 118. Miscellanous (RDC)
7.1.3 Memory attribution map
In the Memory attribution map, you can view security levels set for memory regions. This view is read-only.
7.1.3.1 Core 0
In the Core 0 sub-view, you can review security levels set for Core 0 to the code, data, and peripherals memory regions. The table
is read-only.
The Access by Master table displays MSW or SAU+IDAU, MPC (Memory Protection Checker) security level, and Resulting
Security Level status of listed code, data, and peripherals memory regions, alongside their physical addresses.
To set the display options, do the following:
1. Click the Filter access for checkbox to enable filtering options.
2. Select the master security access you want to review by choosing from the Master dropdown menu.
3. Optionally, set the security level of the selected master by choosing from the Security mode dropdown menu. This setting
has no effect on the configuration.
4. Optionally, customize the output by de-selecting the Show details and Merged SAU+IDAU options.
5. Optionally, filter displayed memory regions in the Filter area.
Point your cursor over the color-coded cells to display a tooltip with information about the security level combination.
Double-click the cell to open the pertinent settings in Security Access Configuration.