Resources tabs

For some device families, the Device Configurator contains several tabs, each of which provides access to specific resources. Different devices have different resources tabs. However, for some device families, there are no separate tabs; resources are shown in a single pane, sometimes under collapsible trees.

When you enable a resource, or select an enabled resource, the

Parameters pane

displays various configuration options. As described under

Icons

, some enabled resources may contain errors, warnings, tasks, or infos that indicate some action might be required to resolve the issue. See

Notice List

for more details.

Note:

Only the tabs relevant for a selected device are displayed, so some of the tabs may not be included for some devices.

Solutions tab
– Options to configure multiple hardware blocks.
Peripherals
– Options to enable any of the analog, digital, system, and communication hardware capabilities of the chip that are not related to the platform.
Pins
– Options for all the pin related resources.
Analog-Routing tab
– This tab shows all the analog resources, whether enabled or not, and how they connect. It also allows you to edit routes.
System tab
– Options for chip-wide configuration settings such as system clocks, power management, and debug interfaces.
Memory tab
– Options to allocate memory to various cores.
MMIO-Clocks tab
– Options for all the MMIO clocks.
Peripheral-Clocks tab
– Options for all the peripheral clocks.
DMA tab
– Provides configuration of the DMA channel and transaction descriptors.

Tab Features

Sections with diagrams, such as Pins, Analog-Routing, and System, include

Zoom

and

Fit to size

commands to resize the diagram as needed. You can also press and hold the [

Ctrl

] key and use the mouse scroll wheel to zoom in and out.

If you zoom the image larger than the frame area, scroll bars appear to move to different area of the diagram. You can also press and hold the [

Alt

] key with the mouse button to use the pan tool.

Each of the tabs (except the Analog-Routing tab) also has the following features:

Filter
– The Resource column shows all available resources in an expandable tree. The filter box above the list of peripherals allows you to limit the peripherals shown in the tree as well as a Hide disabled resources filter button. There are also Expand and Collapse commands.
Cut
,
Copy
,
Paste
– Use these commands to move and copy settings from one resource of the same type to another.
- When you use
  Cut
  , the settings will be copied to the clipboard, and the selected resource will be disabled.
- When you use
  Copy
  , the settings will just be copied to the clipboard.
- When you use
  Paste
  , the selected resource will be enabled if needed. The selected resource must support the same Personality name and version as the cut/copied resource.
Name(s)
– This displays the current resource name(s). This is an editable field where you can specify optional, alternate names for this resource. This is also used in generated code.
Note:
Enter any string in this field. The tool converts the name into a legal C identifier and replaces non-legal characters with underscores. If entering more than one name, use a coma-separated list.
Personality
– Each resource has a "Personality" file that contains the information for the given resource.
- Some peripherals, such as Serial Communication Block (SCB) and Timer, Counter, Pulse Width Modulator (TCPWM), have a pull-down menu to select a specific personality, such as UART, SPI, or I
  ²
  C.
- Some peripherals have multiple personality versions from which you can select.
- Some peripherals have a read-only field that only shows the name of this resource’s personality file.

Solutions tab

The

Solutions

tab displays for supported devices that provide configurations for a multi-resource solution. This tab provides configurable elements that generally consist of multiple hardware blocks. These elements pre-configure many of the low-level details and just present a higher-level interface to configure the solution-level element itself. All hardware that makes up the solution is configured in one

Parameters

pane, instead of having individual blocks on different panes. This tab allows you to enter one or more

Name(s)

for the resource. It also shows the selected

Personality

, where applicable.

Peripherals

The

Peripherals

tab/tree is where you enable various analog, digital, system, and communication peripherals for the device to include in your application. The filter box and the hide disabled button above the list of peripherals allows you to limit the resources shown in the tree. This tab allows you to enter one or more

Name(s)

for the resource. It also shows the selected

Personality

, where applicable.

Device families with tabs

Device families without tabs

Pins

The

Pins

tab/tree is where you enable all the pin related resources. All available pins are shown in an expandable tree, arranged by port number. The filter box and the hide disabled button above the list of pins allows you to limit the pins shown in the tree. This tab allows you to enter one or more

Name(s)

for the resource. It also shows the selected

Personality

, where applicable.

The interactive pin package diagram shows the different states of the pins; there is a legend on the diagram. You can enable/disable a pin by double-clicking it in the diagram.

Pin states are shown in different colors:

Black – No connect
White – Disabled
Green – Enabled
Grey – Power/ground pins
Orange – Fixed function pins
Red – Error state
Semi-transparent – The hardware resource’s enabled state has been locked.

Device families with tabs

Device families without tabs

Analog-Routing tab

The Analog-Routing tab shows the various analog resources in your application. Enabled resources are green.

The

Edit

command opens the

Analog Route Editor

The Analog Route Editor allows you to manually edit the routing of analog resources in your application. It also provides the ability to lock-down all or some of the results.

Note:

The Analog Editor can some times be unresponsive during route recalculation. Please wait for it to finish algorithm execution.

Note:

If there are configuration errors, complete routing results will not be available; only locked resources. If you open the Analog Editor in this error state, a warning message will display. You can still lock and unlock switches, but you won’t get complete routing results as long as the configuration has errors.

Select a resource

To select an analog resource, click on it. Any enabled (green) element in the tree can be selected. The resource and the associated route(s) become blue. Also, the

Edit Route

command appears on the toolbar. See

Edit Route

At the same time, the selected analog resource(s) is highlighted in the Nets tree.

You can also select items in the tree to highlight them in the diagram.

Edit Route

With an editable analog resource selected, click the

Edit Route

command to enable edit mode. If multiple routes are selected, a pull-down menu displays to select the route to edit. You cannot edit multiple routes at the same time.

In edit mode, the net tree shows only the applicable route entries, and you cannot select resources using the tree. However, the lock/unlock check boxes remain enabled for use. The inactive switches change color to indicate they can be selected to use for the route being edited.

Route changes are live with updates applied automatically as you make changes. Selecting a switch adds it to the current route in a locked state and the route tree is updated to reflect the modifications.

If a change results in an error, a message displays. The routes are automatically rolled back to the previous state, so you will lose at most the last invalid change.

The toolbar shows the

Finish edit

command to return the editor to selection mode.

Note:

If a route is edited so that it uses switches associated with a location where no personalities are instantiated, you must manually power on the containing block at startup in order for the switches to function. Refer to the PDL API Reference Guide and the Device Technical Reference Manual for more details.

System tab

The

System

tab provides access to system-level items, such as system clocks, power management, and debug interfaces. All available resources are shown in an expandable tree. The filter box and the hide disabled button above the list of resources allows you to limit the items shown in the tree. This tab allows you to enter one or more

Name(s)

for the resource. It also shows the selected

Personality

, where applicable.

The interactive clock diagram shows all the system clocks and how they connect to each other. You can enable/disable a clock by double-clicking it in the diagram. Enabled clocks are green, disabled clocks are white, and clocks in error state are red.

Note:

The semi-transparent (faded) elements in the diagram indicate that their enabled state is locked.

Memory tab

The

Memory

tab becomes visible for supported devices to configure and visualize memory regions for each core in the device. Similar to other tabs, there is a

Resource

section to enable/disable the Memory, as well as the

Protection

section for the Memory Protection Controllers (MPC), Memory Protection Units (MPU), and Security Attribution Units (SAU). This tab allows you to enter one or more

Name(s)

for the resource. It also shows the selected

Personality

, where applicable.

The main section of this tab contains three subtabs:

Memory Regions

Address View

, and

Read Me

Note:

The

Parameters pane

for this tab is similar to other tabs, except this area contains mostly information, as well as a button to launch the QSPI Configurator.

Memory Regions subtab

The

Memory Regions

subtab displays if the Memory resource has been enabled. It consists of a toolbar, table, and legend. The toolbar allows you to expand and collapse the available memory bars in the table area, as well as

Show/Hide Detailed View

of the memories and

Delete All

memory regions.

Each memory shows as a usage bar that when expanded displays the details of how it is being used. The bar itself shows the display name of the memory along with its overall size. Hover the cursor over a used section to displays a tooltip that corresponds to the same information provided in the rows under the memory.

The rows show allocated and unallocated ranges of the memory. The final row shows the end offset of the memory along with a summary of used/free space. If the ending offset is outside the allowed range, the text become red and display the maximum allowed offset along with the currently set offset that is in violation of the max. If more size is allocated then is available, that text will be in red as well.

Show/hide detailed view

Click the

Hide Detailed View

button to toggle it off and on to show/hide detailed address maps. If any of the addresses do not apply (that is, the core that uses that map is not selected), the values will be stricken out.

Add/edit memory allocations

To edit allocations, double-click an allocated row to open Edit Memory Region dialog.

To add an allocation, double-click an unallocated row to open the Add New Memory Region dialog.

Once the dialog is open, enter values:

Select one or more
Core(s)
from the pull-down menu by clicking the corresponding check boxes.
As needed, type the name of the
Region id
.
If present, select
Settings
.
Note:
The
Settings
option is only available if there is a corresponding MPC available on the hardware for the memory. If no memory protection settings resource has been enabled, an info message will be added stating this to make you aware of what needs to be done to populate the drop-down.
Enter the
Offset
and
Size
.

The

Size

entry allows for hex or decimal entry. It also accepts specifying units, which will always be converted to bytes. Units are case insensitive and can be entered as follows:

bytes or b = byte
kb or k = kilobyte (1 KB = 1,024 Bytes)
mb or m = megabyte (1 MB = 1024KB = 1,048,576 Bytes)
gb or g = gigabyte (1 GB = 1024MB = 1,048,576 KB = 1,073,741,824 Bytes)
tb or t = terabyte (1 TB = 1024 GB = 1,048,576 MB = 8,388,608 KB = 1,099,511,627,776 Bytes)
pb or p = petabyte (1 PB = 1024 TB = 1,048,576 GB = 1,073,741,824 MB = 1,099,511,627,776 KB = 1,125,899,906,842,624 Bytes)
eb or e = exabyte (1 EB = 1024 PB = 1,048,576 TB = 1,073,741,824 GB = 1,099,511,627,776 MB = 1,125,899,906,842,624 KB = 1,152,921,504,606,846,976 Bytes)
zb or z = zettabyte (1 ZB = 1024 EB = 1,048,576 PB = 1,073,741,824 TB = 1,099,511,627,776 GB = 1,125,899,906,842,624 MB = 1,152,921,504,606,846,976 KB = 1,180,591,620,717,411,303,424 Bytes)
yb or y = yottabyte (1 YB = 1024 ZB = 1,048,576 EB = 1,073,741,824 PB = 1,099,511,627,776 TB = 1,125,899,906,842,624 GB = 1,152,921,504,606,846,976 MB = 1,180,591,620,717,411,303,424 KB = 1,208,925,819,614,629,174,706,176 Bytes)

If there are obvious errors, the dialog will not allow you to click

. There may also be an error message.

You can also open the dialog using the drop-down button at the beginning of a row or right-clicking on a row. Unallocated regions will start with an

Add region

option while allocated regions will have the

Edit region

option. Both options launch the same edit dialog.

If you prefer, use the keyboard shortcuts defined on the menus.

Rearrange memory regions

On the context menu, there are various options to move regions, as well as cut, copy, and paste regions.

Use the Legend

The legend shows you the color for each core. You can change the color associated with a used combination of cores. Just click on any of the colors in the legend to open the color picker.

How to find out which region the main goes in from the main ld

Code that doesn't have an explicit section name goes in .text (or .text.function_name when using -ffunction-sections). Search for .text in the linker script or search the .map file for the function name.

How to then move that region using the tool

Once you know the region name, just right-click the region and select

Move to...

and select a memory (may require additional script changes depending on what was moved).

How to read the build output and associate it with the regions defined in the tool

For each project in an application, “make build” will display a summary of the output sections:

----------------------------------------------------
| Section Name         |  Address      |  Size       |
----------------------------------------------------
| .appText_1           |  0x60580400   |  8048       |
| .ARM.exidx           |  0x60582370   |  8          |
| .copy.table          |  0x60582378   |  48         |
| .data                |  0x20000000   |  36         |
| .appText_2           |  0x00000000   |  680        |
| .zero.table          |  0x605823a8   |  8          |
| .ram_vectors         |  0x00000400   |  852        |
| .noinit              |  0x20000028   |  152        |
| .bss                 |  0x200000c0   |  116        |
| .heap                |  0x26200000   |  1048576    |
| .reserved_socmem     |  0x26100000   |  1048576    |
| .cy_sharedmem        |  0x240ff000   |  500        |
----------------------------------------------------

The “.map” file generated by the linker contains details about which input sections the linker placed into each output section. To find the memory region corresponding to each output section, search for the memory region with a matching address.

Example of “.map” file from GNU ld:

.appText_1      0x60580400     0x1f70
...
.text.main     0x6058094c       0x14 build/APP_KIT_PSE84_EVAL/Debug/main.o
               0x6058094c                main
.text.Cy_PDL_Init
               0x60580960        0xc build/APP_KIT_PSE84_EVAL/.../cy_device.o
               0x60580960                Cy_PDL_Init

.appText_1 is the output section name. It is followed by the output section start address (0x60580400) and the output section total size (0x1f70).
.text.main is the input section name. It is followed by its address (0x6058094c) and size (0x14).

Initialized data in volatile memory also consumes space in a non-volatile memory.

.data           0x20000000       0x24 load address 0x60582658

The .data section consumes 0x24 bytes at both its writable address 0x20000000 and its non-volatile address 0x60582658.

How to define a new region for some data buffer variable

For uninitialized data:

In the memory tab, add a new region named “CUSTOM_DATA” in a writable memory such as SRAM.

In the linker script, add a section for the region:

GNU ld or LLVM lld

.custom_data :
{
    *(.custom_data*)
 } &gt;CUSTOM_DATA

armlink

LOAD_CUSTOM_DATA CYMEM_CM55_0_CUSTOM_DATA_START CYMEM_CM55_0_CUSTOM_DATA_SIZE
{
    EXEC_CUSTOM_DATA CYMEM_CM55_0_CUSTOM_DATA_START UNINIT CYMEM_CM55_0_CUSTOM_DATA_SIZE
    {
        *(.custom_data*)
    }
}

ilinkarm

do not initialize ( section .custom_data* )
place in CUSTOM_DATA ( section .custom_data* )

In the source code, assign the variable to the section (GCC, armclang, or iccarm)
```
__attribute__((section ".custom_data"))
uint32_t data_buffer[DATA_BUFFER_COUNT];
```

For data in volatile memory

For data in volatile memory that requires run-time initialization, the linker script must configure a non-volatile location to initialize the data. For this example, create a region named “CUSTOM_CODE” in a non-volatile memory.

GNU ld or LLVM lld

.custom_data :
{
    *(.custom_data*)
 } &gt;CUSTOM_DATA AT&gt;CUSTOM_CODE

.copy.table :
{
    /* ... */
    LONG(LOADADDR(.custom_data))
    LONG(ADDR(.custom_data))
    LONG(SIZEOF(.custom_data)/4)
    /* ... */
}

Note:

If ADDR(.custom_data) is read-only, the .copy.table entry must use a writable address.

armlink

LOAD_CUSTOM_CODE CYMEM_CM55_0_CUSTOM_CODE_START CYMEM_CM55_0_CUSTOM_CODE_SIZE
{
    EXEC_CUSTOM_DATA CYMEM_CM55_0_CUSTOM_DATA_START CYMEM_CM55_0_CUSTOM_DATA_SIZE
    {
        *(.custom_data*)
    }
}

ilinkarm

initialize by copy ( section .custom_data* )
place in CUSTOM_DATA ( rw section .custom_data* )
place in CUSTOM_CODE ( ro section .custom_data* )

How to define a new region for the code and then assign code to the particular region

In the memory tab, add a new region named “CUSTOM_CODE” in a non-volatile memory such as RRAM.

In the linker script, add a section for the region:

GNU ld or LLVM lld

a.	.custom_code :
(
    *(.custom_code*)
) &gt;CUSTOM_CODE

armlink

LOAD_CUSTOM_CODE CYMEM_CM55_0_CUSTOM_CODE_START CYMEM_CM55_0_CUSTOM_CODE_SIZE
(
    EXEC_CUSTOM_CODE +0
    (
        *(.custom_code*)
    )
)

ilinkarm

place in CUSTOM_CODE ( section .custom_code* )

In the source code, assign the variable to the section (GCC, armclang, or iccarm)
```
__attribute__((section ".custom_code"))
void custom_code_function1(void);
```

How to assign a function or variable into a custom memory section

Variables and functions may be assigned to a section using the section attribute. The linker script must assign the section to an output section.

__attribute__((section ".custom_data"))
uint32_t data_buffer[DATA_BUFFER_COUNT];

__attribute__((section ".custom_code"))
void custom_code_function1(void);

How to modify the linker to include a specific file into a custom memory section

GNU ld or LLVM lld

.custom_code :
(
    main.o(.text* .rodata*)
) &gt;CUSTOM_CODE
.custom_data :
(
    main.o(.data*)
    main.o(.bss*)
) &gt;CUSTOM_DATA AT&gt;CUSTOM_CODE

Note:

The toolchain does not automatically initialize data. Sections that require initialization must be added to the .zero.table and/or .copy .table manually.

armlink

LOAD_CUSTOM_CODE CYMEM_CM55_0_CUSTOM_CODE_START CYMEM_CM55_0_CUSTOM_CODE_SIZE
(
    EXEC_CUSTOM_CODE +0
    (
        main.o(+RO)
    )
    EXEC_CUSTOM_DATA CYMEM_CM55_0_CUSTOM_DATA_START CYMEM_CM55_0_CUSTOM_DATA_SIZE
    (
        main.o(+RW,+ZI)
    )
)

ilinkarm

place in CUSTOM_CODE ( ro object main.o )
place in CUSTOM_DATA ( rw object main.o )

How to modify the linker to include an entire middleware library into a custom memory section

The linker script example assigns all of the code and data from object files matching mtb_hal_*.o to the .custom_code and .custom_data sections respectively. If the middleware’s object files cannot be described in a single pattern, it may be necessary to use multiple patterns.

GNU ld or LLVM lld

.custom_code :
(
    mtb_hal_*.o(.text* .rodata*)
) &gt;CUSTOM_CODE
.custom_data :
(
    mtb_hal_*.o(.data*)
    mtb_hal_*.o(.bss*)
) &gt;CUSTOM_DATA AT&gt;CUSTOM_CODE

Note:

The toolchain does not automatically initialize data. Sections that require initialization must be added to the .zero.table and/or .copy .table manually.

armlink

LOAD_CUSTOM_CODE CYMEM_CM55_0_CUSTOM_CODE_START CYMEM_CM55_0_CUSTOM_CODE_SIZE
(
    EXEC_CUSTOM_CODE +0
    (
        mtb_hal_*.o(+RO)
    )
    EXEC_CUSTOM_DATA CYMEM_CM55_0_CUSTOM_DATA_START CYMEM_CM55_0_CUSTOM_DATA_SIZE
    (
        mtb_hal_*.o(+RW,+ZI)
    )
)

ilinkarm

place in CUSTOM_CODE ( ro object mtb_hal_*.o )
place in CUSTOM_DATA ( rw object mtb_hal_*.o )

How to re-balance the memory between the cores based on the build output

This is highly dependent on the needs of the customer’s application. Solutions may include:

Resizing existing regions
- Double-click on the region to open the Edit dialog.
- Update the Size. If the region needs to be moved, also update the Offset.
Moving existing regions to another memory
Updating linker scripts to place code or data in different regions

How to move a region to another memory

In the

Memory Regions

tab, use the context menu to move the memory region to another memory.

Note:

The regions required for initial application startup must be in a non-volatile memory.

Note:

Some toolchains including GNU and LLVM do not initialize data automatically. If a region is moved to a volatile memory, entries must be added to .zero.table and/or .copy.table manually.

Address View subtab

The

Address View

subtab displays a generated diagram of defined regions per core. The first column is based off when the hardware defines are available. The defined regions are displayed next (if applicable). Then SAU and MPU columns are displayed if defined. … is added whenever there is a gap in the addresses.

This subtab contains a toolbar with the standard zoom commands. Hovering the cursor over any of the regions displays a tooltip with a summary of the region’s info.

Read Me subtab

This subtab displays an HTML generated document with information from the device-db’s

memories.cydata

file, combined with memory data exported from the QSPI configurator.

This file provides links to "how to" HTML topics to guide you how to configure memories.

MMIO-Clocks tab

For supported devices, the

MMIO-Clocks

tab lists all the clocks in a design used to drive the various Memory Mapped IOs. All available clocks are shown in an expandable tree. The filter box and the hide disabled button above the list of resources allows you to limit the items shown in the tree. This tab allows you to enter one or more

Name(s)

for the resource. It also shows the selected

Personality

, where applicable.

Peripheral-Clocks tab

The Peripheral-Clocks tab lists all the clocks in a design used to drive the various peripherals. All available clocks are shown in an expandable tree. The filter box and the hide disabled button above the list of resources allows you to limit the items shown in the tree. This tab allows you to enter one or more

Name(s)

for the resource. It also shows the selected

Personality

, where applicable.

DMA tab

The DMA tab lists all the DMA resources in the design. All available DMA channels are shown in an expandable tree. The filter box and the hide disabled button above the list of resources allows you to limit the items shown in the tree. This tab allows you to enter one or more

Name(s)

for the resource. It also shows the selected

Personality

, where applicable.

Resources tabs

Tab Features​

Solutions tab​

Peripherals​

Device families with tabs​

Device families without tabs​

Pins​

Device families with tabs​

Device families without tabs​

Analog-Routing tab​

Analog Route Editor​

Select a resource​

Edit Route​

System tab​

Memory tab​

Memory Regions subtab​

Show/hide detailed view​

Add/edit memory allocations​

Rearrange memory regions​

Use the Legend​

How to find out which region the main goes in from the main ld​

How to then move that region using the tool​

How to read the build output and associate it with the regions defined in the tool​

How to define a new region for some data buffer variable​

For uninitialized data:​

For data in volatile memory​

How to define a new region for the code and then assign code to the particular region​

How to assign a function or variable into a custom memory section​

How to modify the linker to include a specific file into a custom memory section​

How to modify the linker to include an entire middleware library into a custom memory section​

How to re-balance the memory between the cores based on the build output​

How to move a region to another memory​

Address View subtab​

Read Me subtab​

MMIO-Clocks tab​

Peripheral-Clocks tab​

DMA tab​

Tab Features

Solutions tab

Peripherals

Device families with tabs

Device families without tabs

Pins

Device families with tabs

Device families without tabs

Analog-Routing tab

Analog Route Editor

Select a resource

Edit Route

System tab

Memory tab

Memory Regions subtab

Show/hide detailed view

Add/edit memory allocations

Rearrange memory regions

Use the Legend

How to find out which region the main goes in from the main ld

How to then move that region using the tool

How to read the build output and associate it with the regions defined in the tool

How to define a new region for some data buffer variable

For uninitialized data:

For data in volatile memory

How to define a new region for the code and then assign code to the particular region

How to assign a function or variable into a custom memory section

How to modify the linker to include a specific file into a custom memory section

How to modify the linker to include an entire middleware library into a custom memory section

How to re-balance the memory between the cores based on the build output

How to move a region to another memory

Address View subtab

Read Me subtab

MMIO-Clocks tab

Peripheral-Clocks tab

DMA tab