Platform Sample Applications
Overview
A platform can optionally include sample applications to demonstrate the usage of the platform. The sample applications must be defined in a file namedtemplate.xmlfound in thesamplesdirectory of a platform. Here is an example for thezc702_axis_iosample platform found in the
element
Each application template is defined inside aelement, and there can be multipletags defined within theelement can have multiple attributes as shown in the following table:
| Attribute | Description |
|---|---|
| location | Relative path to the template application |
| name | Application name displayed in the SDSoC environment |
| description | Application description displayed in the SDSoC environment |
element
The
The following example defines an application that can be selected when either of Linux, Standalone or FreeRTOS are selected as an Operating System:
element
Thelocationattribute.
-I"../src/myinclude" -I"../src/dir/include"to the compiler:
element
Thelocationattribute.
-L"../src/mylibrary" -L"../src/dir/lib"to the linker:
element
Thenameattribute.
-lmylib2 -lmylib2to the linker:
element
The
The following example will result in SDx not making a copy of directoriesMyDirandMyOtherDirwhen creating the new project. It will also not make a copy of filesMyFile.txtandMyOtherFile.txt. This allows you to have files or directories in the application directory that are not needed to build the application.
element
The optionaldmclkidattribute defines the data motion clock ID. If the
The following example will result in SDx setting the data motion clock ID to2instead of the default clock ID when creating the new project.
element
The optionalnameattribute defines the name of the function and thelocationattribute defines the path to the source file containing the function (the path is relative to the folder in the platform containing the application source files). Thenameandlocationare required attributes of theclkidspecifies the accelerator clock to use instead of the default. The optional sub-elementnameof a source file (path relative to the folder in the platform containing application source files) containing code called by the accelerator and the accelerator is found in a different file. The SDx environment normally infers
The following example will result in SDx specifying two functions to move to hardwarefunc1andfunc2when creating the new project.
element
The optionalinferredOptionsattribute defines compiler options required to build the application and appears in the SDx Environment C/C++ Build Settings dialog as compiler Inferred Options under Software Platform.
The following example will result in SDSoC adding the compiler option-D MYAPPMACROwhen creating the new project.
element
The optionalinferredOptionsattribute defines linker options required to build the application and appears in the SDx Environment C/C++ Build Settings dialog as linker Miscellaneous options.
The following example will result in SDx adding the linker option-poll-mode 1when creating the new project.