Difference between revisions of "Embedded Studio"
m (→Porting) |
(→Project Setup and Build) |
||
| (44 intermediate revisions by 4 users not shown) | |||
| Line 9: | Line 9: | ||
</div> |
</div> |
||
| − | = Licensing = |
+ | == Installation & Licensing == |
[[Get a License for Nordic Semiconductor Devices]] |
[[Get a License for Nordic Semiconductor Devices]] |
||
| + | [[Get a Embedded Studio license for Serious Integrated development kits]] |
||
| − | = ETB trace on NXP TWR-K65F = |
||
| − | ETB trace with the OpenSDA on-board which is on the NXP TWR-K65F board and for which SEGGER also provide a firmware. Further information regarding the J-Link OpenSDA firmware can be found on the SEGGER webpage: [https://www.segger.com/opensda.html https://www.segger.com/opensda.html]. In general, to get ETB up and running, just make sure to configure ETB as ''Trace Interface Type'' in the Embedded Studio project settings: |
||
| − | ''Debugger'' --> ''Target Trace Options'' --> ''Trace Interface Type'' --> ''ETB'' |
||
| − | [[File:ES_ProjectConfiguration_ETB.png]] |
||
| + | [[Installation on newer Linux Versions]] |
||
| − | Once the debug session has been started, the most recent executed instructions will be shown in the instruction backtrace window. The window can be opened at: |
||
| − | ''Debug'' --> ''Other windows'' --> ''Execution Trace'' |
||
| − | [[File:ES_ExecutionTrace_ETB.png]] |
||
| + | [[Installation issues on macOS Catalina]] |
||
| − | Below a sample project that is already prepared for ETB trace on the K65 is available for download. |
||
| − | * [[File:Freescale_MK65FN2M0xxx18_ETBTrace_SES.zip]] |
||
| + | [[Start multiple Embedded Studio instances on macOS]] |
||
| − | = Porting = |
||
| − | [[Port Projects from IAR Embedded Workbench to Embedded Studio]] |
||
| + | [[License installation on a headless system]] |
||
| − | =How to configure Embedded Studio to use SWO= |
||
| − | SEGGER Embedded Studio can use SWO for printf Output to the Debug Terminal and for code profiling and execution trace. This article describes the configuration of a project in Embedded Studio to enable SWO. |
||
| + | [[Embedded Studio evaluation period error]] |
||
| − | == Example Setup == |
||
| − | The setup guide will be based on the following hardware and software components: |
||
| − | * J-Link Software Package V6.18c or later |
||
| − | * Embedded Studio V3.26a or later |
||
| − | * [https://www.segger.com/evaluate-our-software/segger/empower/ SEGGER emPower] evaluation board |
||
| − | * Any J-Link/J-Trace hardware |
||
| − | * Physically connected SWO pin to debug interface |
||
| − | == |
+ | == Performance == |
| + | [[Resolving slow build / high CPU usage issues]] |
||
| − | # Open your project in Embedded Studio |
||
| − | # In the Project Explorer select the project and go to Project-> Edit Options... |
||
| − | # Go to Debug -> Target Trace |
||
| − | # Select SWO as Trace Interface Type |
||
| − | # Enter the Trace Clock Speed: The trace clock speed is usually the target CPU speed while the application is running. |
||
| − | # Enter the SWO Baud Rate: The SWO baud rate (or SWO speed) needs to match the trace clock speed and the used J-Link. |
||
| − | # Click OK |
||
| − | # Start a debug session |
||
| − | # Open the Execution Profile Window (View -> More Debug Windows -> Execution Profile) |
||
| − | # Open the Execution Trace Window (View -> More Debug Windows -> Execution Trace) |
||
| − | [[File:1_Check_Target_Device.PNG|thumb|Check if correct device and debugger is selected|none]] |
||
| − | [[File:2_SWO_Settings.PNG|thumb|Set SWO speed and baud rate|none]] |
||
| − | [[File:3_Execution_Profile.PNG|thumb|Execution Profile|none]] |
||
| − | [[File:4_Execution_Trace.PNG|thumb|Execution Trace|none]] |
||
| + | == Project Setup and Build == |
||
| − | A basic ES project for the emPower board with all settings applied can be found here: [[Media: EmPower_ES_SWO.zip | emPower_ES_SWO.zip]] |
||
| + | [[Port Projects from IAR Embedded Workbench to Embedded Studio]] |
||
| − | [[How to measure CPU Speed]] |
||
| − | |||
| − | == Calculating the SWO speed == |
||
| − | The supported SWO speeds depend on the connected emulator. They can be retrieved from |
||
| − | the emulator. To get the supported SWO speeds for your emulator, use J-Link Commander, connect to your target and execute the command "SWOSpeed" without quotations marks. |
||
| − | The listed speeds can be set as SWO baud rate. |
||
| − | |||
| − | == Troubleshooting == |
||
| − | |||
| − | * The Terminal I/O windows are still not showing any information even after following the setup guide step by step. |
||
| − | ** Make sure the SWO pin is actually connected to your J-Link debug hardware, many J-Link OBs for example do not have SWO routed to them. |
||
| − | ** Check if the selected target device is correct. |
||
| − | |||
| − | * I want to use SWO and JTAG simultaniously, how can i do that? |
||
| − | ** This is not possible as the TDO (JTAG) signal is sharing the same pin as SWO. To be able to use SWO a SWD debug connection is required. |
||
| − | |||
| − | * I can't start a debug session |
||
| − | ** Is the target device powered properly? You can open the J-Link Commander to see what voltage is currently showing as VTREF in the console output. Is that value expected? |
||
| − | |||
| − | |||
| − | If there are still issues persisting feel free to contact our support: [mailto:support@segger.com support@segger.com] |
||
| − | |||
| − | =VCS configuration= |
||
| − | Version Control System (VCS) is an essential tool for individuals or development teams. SEGGER Embedded Studio integrates with several popular source-control systems to provide this feature for files in your Embedded Studio projects. |
||
| − | |||
| − | The source-control capability is implemented by a number of third-party providers, but the set of functions provided by Embedded Studio aims to be provider independent. This article will explain how to set up such a system and how to use it. |
||
| − | |||
| − | == Set up source control system == |
||
| − | Embedded Studio supports Subversion, Git, and Mercurial as source-control systems. To enable Embedded Studio to utilize source-control features, you need to install the appropriate command line client on your operating system for the source-control systems that you will use. |
||
| − | |||
| − | Once you have installed the command line client, you must configure Embedded Studio to use it. |
||
| − | |||
| − | '''To configure Subversion:''' |
||
| − | # Choose Tools > Options. |
||
| − | # Select the Source Control category in the options dialog. |
||
| − | # Set the Executable environment option of the Subversion Options group to point to Subversion svn command. On Windows operating systems, the Subversion command is svn.exe. |
||
| − | |||
| − | '''To configure Git:''' |
||
| − | # Choose Tools > Options. |
||
| − | # Select the Source Control category in the options dialog. |
||
| − | # Set the Executable environment option of the Git Options group to point to Git git command. On Windows operating systems, the Git command is git.exe. |
||
| + | [[Use an external Toolchain with Embedded Studio]] |
||
| − | '''To configure Mercurial:''' |
||
| − | # Choose Tools > Options. |
||
| − | # Select the Source Control category in the options dialog. |
||
| − | # Set the Executable environment option of the Mercurial Options group to point to Mercurial hg command. On Windows operating systems, the Git command is hg.exe. |
||
| − | [[File:SVN_Example.PNG|thumb|Example with SVN|none]] |
||
| + | [[Porting from GCC to SEGGER Linker]] |
||
| − | == Source control capabilities == |
||
| − | The source-control integration capability provides: |
||
| − | * Connecting to the source-control repository and mapping files in the Embedded Studio project to those in source control. |
||
| − | * Showing the source-control status of files in the project. |
||
| − | * Adding files in the project to source control. |
||
| − | * Fetching files in the project from source control. |
||
| − | * Optionally locking and unlocking files in the project for editing. |
||
| − | * Comparing a file in the project with the latest version in source control. |
||
| − | * Updating a file in the project by merging changes from the latest version in source control. |
||
| − | * Committing changes made to project files into source control. |
||
| + | [[Add new Memory Sections and Segments]] |
||
| − | When Embedded Studio loads a project, it examines the file system folder that contains the project to determine the source-control system the project uses. If Embedded Studio cannot determine, from the file system, the source-control system in use, it disables source-control integration. |
||
| + | [[Create a RAM Function]] |
||
| − | That is, if you have not set up the paths to the source-control command line clients, even if a working copy exists and the appropriate command line client is installed, Embedded Studio cannot establish source-control integration for the project. |
||
| + | [[Multiple project in one solution in Embedded Studio]] |
||
| − | '''User credentials''' |
||
| + | [[How to create a library project and use it in executable project]] |
||
| − | You can set the credentials that the source-control system uses, for commands that require credentials, using VCS > Options > Configure. From here you can set the user name and password. These details are saved to the session file (the password is encrypted) so you won't need to specify this information each time the project is loaded. |
||
| + | [[Using User Build Steps in Embedded Studio]] |
||
| − | '''Note''' |
||
| + | [[Embedded Studio project file format]] |
||
| − | Embedded Studio has no facility to create repositories from scratch, nor to clone, pull, or checkout repositories to a working copy: it is your responsibility to create a working copy outside of Embedded Studio using your selected command-line client or Windows Explorer extension. |
||
| + | [[Migrating projects from Embedded Studio V4 to V5]] |
||
| − | The "Tortoise" products are a popular set of tools to provide source-control facilities in the Windows shell. Use Google to find TortoiseSVN, TortoiseGit, and TortoiseHG and see if you like them. |
||
| + | [[Static code analysis in Embedded Studio]] |
||
| − | '''Source-control operations''' |
||
| + | [[Embedded Studio Library IO]] |
||
| − | Source-control operations can be performed on single files or recursively on multiple files in the Project Explorer hierarchy. Single-file operations are available on the Source Control toolbar and on the text editor's shortcut menu. All operations are available using the Project > VCS menu. The operations are described in terms of the Project Explorer shortcut menu. |
||
| + | == Project Configuration == |
||
| − | More information can be found in the Embedded Studio user manual: ''SEGGER Embedded Studio > SEGGER Embedded Studio User guide > Using source control'' |
||
| + | Embedded Studio features a powerful project management that enables full flexibility to configure any part of the project for best results. |
||
| + | As part of this, options can be changed on any node within a project while inheriting unchanged options from higher levels. |
||
| − | == |
+ | === Private & Public Build Configurations === |
| + | Usually a project within any IDE is setup with different build configurations for different purposes. |
||
| − | To show the differences between the file in the project and the version checked into source control you can use the build in diff tool: |
||
| + | This can be one configuration to create code with output and information used for debugging (called "Debug") and one configuration which is optimized for size or speed to be used in the final product (called "Release"). |
||
| + | There are some differences between these build configurations. |
||
| + | The configuration "Debug" is set up to produce debug information for the debugger, disables optimization, sets some defines to do additional checks in the code or to output messages to a debug terminal, or includes code used only for debugging. |
||
| + | The configuration "Release" is set up to do only what is required in the product. Optimizations are enabled, defines are set to not do debug output, and debug runtime checks might be disabled. |
||
| + | On the other hand a lot of options are shared between all build configurations. |
||
| + | That can be the target processor, include directories, application-specific or device-specific defines, floating-point implementation, and compiler and linker configuration. |
||
| + | With Embedded Studio default and shared options can be set in one place. Specific options can then be set or overridden per build configuration. |
||
| − | # In the Project Explorer, right-click the file. |
||
| + | This is what Private Configurations and Public Configurations are used for. |
||
| − | # From the shortcut menu, choose Source Control > Compare. |
||
| + | A Public Configuration is a Build Configuration. It can be selected and built, and generates the output. |
||
| − | [[File:Internal_Diff_Tool.PNG|thumb|ES internal diff tool|none]] |
||
| + | Private Configurations cannot be built. Instead Public Configurations can inherit the options set in one or more Private Configurations. |
||
| + | That way all Build Configurations ("Debug" and "Release") can inherit the shared options from the same Private Configuration ("Common"). |
||
| + | Target processor, include directories, ..., need to be set only in "Common" and are used in both, "Debug" and "Release". |
||
| + | Private Configurations can also set defaults, which may be overridden or extended by Public Configurations. |
||
| − | You can also use an external diff tool in preference to the built-in Embedded Studio diff tool. To define the diff command line Embedded Studio generates, choose Tools > Options > Source Control > Diff Command Line. The command line is defined as a list of strings to avoid problems with spaces in arguments. The diff command line can contain the following macros: |
||
| + | Include Directories and Preprocessor Definitions are always extended. |
||
| − | * $(localfile): The filename of the file in the project. |
||
| + | "Common" might set the Include Directories "Inc; Setup; Device" and the Preprocessor Definitions "USE_OS;APP_VERSION=210;ENABLE_IPv6=0". These are used in "Debug" and "Release" builds. |
||
| − | * $(remotefile): The filename of the latest version of the file in source control. |
||
| + | "Debug" might additionally add Include Directories "Config_Debug" and Preprocessor Definitions "DEBUG;ENABLE_CHECKS=1". |
||
| − | * $(localname): A display name for $(localfile). |
||
| + | "Release" might instead add "Config" and "NDEBUG;ENABLE_CHECKS=0". |
||
| − | * $(remotename): A display name for $(remotefile). |
||
| − | [[File:Diff_Cmd_Example.PNG|thumb|Cmd line example with WinMerge|none]] |
||
| + | Selection Options, such as Optimization Level, Architecture, and FPU Type, can be overridden. |
||
| − | =Installation on newer Linux versions= |
||
| + | "Common" might set Architecture as "ARM v7EM", FPU Type as "FPv5-D16", and Optimization Level to "None". |
||
| − | On some newer Linux versions root rights for installing Embedded Studio are not granted per default. |
||
| + | In "Debug" nothing has to be changed, as this already fits. |
||
| − | To counter that issue the following workaround can be applied. Simply execute the following command in the terminal: |
||
| + | In "Release" the Optimization Level might be overridden to "Optimize for Size". |
||
| + | Now Include Directories, Preprocessor Definitions, and Optimization Level are different, while the common ones do not have to be maintained in each Build Configuration. |
||
| − | '''''xhost si:localuser:root''''' |
||
| + | === Override Options === |
||
| − | This workaround has been confirmed to work for: |
||
| + | In Embedded Studio options cannot only be set on Solution or Project level. They can be set on any level, solution, projects, folders, and files. |
||
| + | As with Build Configurations, all options that are not explicitly modified on a level, are inherited from the upper level. |
||
| + | This enables modifying some options, such as defines, include directories, or optimization level, on one level, while retaining all other options. |
||
| + | For example, a project should be optimized for size, but one module should instead be optimized for highest speed. |
||
| − | * Ubuntu 17.10 |
||
| + | All options are set on project level. Only the optimization level of the module is changed. |
||
| − | * Fedora 26 |
||
| − | ... |
||
| + | Private and Public Configurations also apply on all levels. |
||
| − | This list will be updated once other Linux versions have been confirmed to work with that workaround. |
||
| + | This also makes it possible to change the option of any level depending on the selected Build Configuration. |
||
| + | === Project Options === |
||
| + | To open the Project Options Dialog, select the item to change the options for in Project Explorer and go to Project -> Options... (Alt+Return), or right-click on the Item -> Options... |
||
| + | In the upper left of the Options Dialog the Public or Private Configuration to change the options in can be selected. |
||
| − | '''Note:''' We strongly suggest to revoke the root rights after a successfull installation. |
||
| + | By default the active Build Configuration is selected. |
||
| − | To do that simply execute the following command in terminal: |
||
| + | The "Search Options" text input enables easy filter for the option to be modified. |
||
| − | '''''xhost -si:localuser:root''''' |
||
| + | When "Show Modified Options Only" is checked, only options which do not have default values are shown. |
||
| − | =How to enable RTOS thread awareness= |
||
| + | Options which are modified on the selected item and configuration are marked with "modified". |
||
| − | == Enable thread awareness for embOS == |
||
| + | "inherited" indicates that the option has been modified in another configuration or on a higher level. |
||
| + | Which value is inherited from which level and configuration is shown in the Description when the item is selected. |
||
| + | ==== Code Options ==== |
||
| − | * First download the latest thread awareness script from our website: https://www.segger.com/products/rtos/embos/tools/plug-ins/embedded-studio/ |
||
| − | + | ''Main Article:'' [[Embedded Studio Code Options]] |
|
| − | * Go to: Project->Edit Options...->Debug->Debugger->Thread Script File |
||
| − | * Set path to your downloaded thread awareness script and press ok |
||
| + | The Code Options configure the build system, the toolchain (compiler, assembler, linker), the preprocessor, library configuration, and user build steps. |
||
| − | == Thread awareness for other OSs == |
||
| − | The following thread awareness scripts are provided as is without claim for support. |
||
| − | Setup steps are the same as with embOS. |
||
| + | ==== Debug Options ==== |
||
| − | [[Media:FreeRTOS_ThreadScripts_ES.zip | FreeRTOS thread awareness scripts]] |
||
| + | ''Main Article:'' [[Embedded Studio Debug Options]] |
||
| + | The Debug Options configure how the project should be debugged, which debug interface (J-Link, GDB Server, Simulator) should be used, and how the target should be configured on certain operations. |
||
| − | '''Note:''' When using FreeRTOS the scripts require FreeRTOS to be compiled such |
||
| − | that the referenced symbols do not have static qualifier (so the |
||
| − | debugger can access them). |
||
| + | ==== ES PRO Options ==== |
||
| − | =How to place a function in RAM= |
||
| + | ''Main Article:'' [[Embedded Studio PRO Options]] |
||
| + | The ES PRO Options are available when the [[Embedded Studio PRO]] Package is installed. |
||
| − | For some situations it may be beneficial or even necessary to place a function in RAM instead of flash. This for example is needed in case a bootloader (that runs from flash) shall update a firmware (running from the same flash but different sectors). As the flash is not accessible for read accesses while it is programmed, the flash programming routines itself need to run from RAM. |
||
| + | They configure which components of ES PRO to use in the project and how the libraries should be configured. |
||
| + | == Debugging == |
||
| − | In order to put a function into RAM, it needs to be placed into the '''.fast''' section. This is done as follows: |
||
| + | [[Configure_instruction_trace_in_Embedded_Studio|Configure Instruction Trace in Embedded Studio]] |
||
| − | __attribute__ ((section(".fast"))) // Place the following function in RAM |
||
| − | void _Delay(void) { |
||
| − | [...] |
||
| − | } |
||
| − | + | [[Configure SWO in Embedded Studio]] |
|
| − | Embedded Studio offers the option to build project with an external toolchain of your choice. The following guide will show an example implementation of such a setup with the ARM GCC toolchain. |
||
| + | [[Enable RTOS Awareness in Embedded Studio]] |
||
| − | == Example implementation with external GCC toolchain == |
||
| + | [[Connect to remote J-Link via J-Link Tunnel Server]] |
||
| − | * First install the external toolchain of your liking, in this example the currently latest ARM GCC 7-2017-q4-major will be used. |
||
| − | * Create a new externally build project using the Embedded Studio project wizard and selecting ''A C/C++ executable for ... processor(internal and external GNU tools)''. |
||
| − | [[File:New_Project.png|thumb|New external build project|none]] |
||
| − | * Select your target device, next set the toolchain path and finish the project setup by letting all settings on default. |
||
| − | * Make sure the memory section placement segments are located in the correct memory areas. This can be found int he Common project settings under Linker-> Section Placement Segments |
||
| − | * Now select build configuration "Debug External" and build the project to build with the external toolchain. |
||
| − | * If the build succeeds you can download it into your target application and debug it. |
||
| + | [[Embedded Studio with GDB Server|Debug with Embedded Studio and GDB Server such as OpenOCD]] |
||
| − | == Optional steps for more complex builds == |
||
| + | [[Set User-dependent J-Link connection in Embedded Studio]] |
||
| − | When adding more complex projects to Embedded Studio as an external build usually additional steps are required to make full use of the external compiler. The following are the most common: |
||
| + | == SEGGER Linker == |
||
| − | * Preprocessor definitions: Under ''Preprocessor->Preprocessor Definitions'' in the external build configs missing preprocessor definitions can be set. |
||
| + | [[How to enable SEGGER Linker in your Embedded Studio project]] |
||
| − | * User include directories: Under ''Preprocessor->User Include Directories'' in the external build configs missing include directories can be added. |
||
| − | * All other commands that can't be set directly through the Embedded Studio GUI need to be set manually to the external build command line which can be found under ''External Build'' in one of the external build project configurations. |
||
| + | [[Placing external library symbols at specific address]] |
||
| − | =Connecting to J-Link via J-Link Remote Server= |
||
| + | [[Correct typing of Thumb functions]] |
||
| − | The [https://newsitework.segger.com/products/debug-probes/j-link/tools/j-link-remote-server/ J-Link Remote Server] makes it possible for Embedded Studio to connect to a J-Link remotely, without needing a physical connection to the J-Link. |
||
| + | [[Place Functions in RAM with SEGGER Linker]] |
||
| − | In order to connect to a J-Link Remote Server using Embedded Studio, follow these instructions: |
||
| + | [[Integrity checks with Embedded Studio and SEGGER Linker]] |
||
| − | * Open your project options (right click on your project in the Project Explorer and select '''Options''') |
||
| − | * Under '''Debug''' select the '''J-Link''' menu item |
||
| − | * Edit the '''Host connection''' field |
||
| − | [[File:ES_ConnectToRemoteServer.png|thumb|Project options|none]] |
||
| − | * In the property editor, set the '''Host Connection''' |
||
| − | ** For a remote server running in LAN mode, enter "IP <RemoteServerIP>". |
||
| − | ** For a remote server running in tunneling mode, enter "IP tunnel:<SN/Nickname>[:<Pasword>[:tunnelserver[:port]]]" |
||
| − | [[File:ES_ConnectToRemoteServer_2.png|thumb|Property editor for J-Link host connection|none]] |
||
| − | * Click '''OK''' |
||
| + | == Version Control == |
||
| − | From then on, the J-Link is handled the same as if it was connected directly via USB. |
||
| + | [[VCS Configuration]] |
||
[[Category:Software Tools]] |
[[Category:Software Tools]] |
||
| + | [[Category:Embedded Studio]] |
||
Revision as of 15:52, 27 October 2020
Embedded Studio, is a complete all-in-one solution for managing, building, testing and deploying your embedded applications: From the Project Generator which gets you easily started with common ARM microcontrollers, to the powerful Project Manager and source code Editor, the included C/C++ Compiler and the integrated Debugger with advanced debug information windows and direct J-Link integration, right through to version control features for automatic deployment of your applications.
Embedded Studio's uses a style similar to Microsoft's Visual Studio. It brings the same intuitive usage that PC developers are familiar with to the world of embedded engineering.
This wiki page explains and links to details and device specifics that can not be found on the Embedded Studio Product page.
Installation & Licensing
Get a License for Nordic Semiconductor Devices
Get a Embedded Studio license for Serious Integrated development kits
Installation on newer Linux Versions
Installation issues on macOS Catalina
Start multiple Embedded Studio instances on macOS
License installation on a headless system
Embedded Studio evaluation period error
Performance
Resolving slow build / high CPU usage issues
Project Setup and Build
Port Projects from IAR Embedded Workbench to Embedded Studio
Use an external Toolchain with Embedded Studio
Porting from GCC to SEGGER Linker
Add new Memory Sections and Segments
Multiple project in one solution in Embedded Studio
How to create a library project and use it in executable project
Using User Build Steps in Embedded Studio
Embedded Studio project file format
Migrating projects from Embedded Studio V4 to V5
Static code analysis in Embedded Studio
Project Configuration
Embedded Studio features a powerful project management that enables full flexibility to configure any part of the project for best results. As part of this, options can be changed on any node within a project while inheriting unchanged options from higher levels.
Private & Public Build Configurations
Usually a project within any IDE is setup with different build configurations for different purposes. This can be one configuration to create code with output and information used for debugging (called "Debug") and one configuration which is optimized for size or speed to be used in the final product (called "Release"). There are some differences between these build configurations. The configuration "Debug" is set up to produce debug information for the debugger, disables optimization, sets some defines to do additional checks in the code or to output messages to a debug terminal, or includes code used only for debugging. The configuration "Release" is set up to do only what is required in the product. Optimizations are enabled, defines are set to not do debug output, and debug runtime checks might be disabled. On the other hand a lot of options are shared between all build configurations. That can be the target processor, include directories, application-specific or device-specific defines, floating-point implementation, and compiler and linker configuration.
With Embedded Studio default and shared options can be set in one place. Specific options can then be set or overridden per build configuration. This is what Private Configurations and Public Configurations are used for. A Public Configuration is a Build Configuration. It can be selected and built, and generates the output. Private Configurations cannot be built. Instead Public Configurations can inherit the options set in one or more Private Configurations. That way all Build Configurations ("Debug" and "Release") can inherit the shared options from the same Private Configuration ("Common"). Target processor, include directories, ..., need to be set only in "Common" and are used in both, "Debug" and "Release".
Private Configurations can also set defaults, which may be overridden or extended by Public Configurations.
Include Directories and Preprocessor Definitions are always extended. "Common" might set the Include Directories "Inc; Setup; Device" and the Preprocessor Definitions "USE_OS;APP_VERSION=210;ENABLE_IPv6=0". These are used in "Debug" and "Release" builds. "Debug" might additionally add Include Directories "Config_Debug" and Preprocessor Definitions "DEBUG;ENABLE_CHECKS=1". "Release" might instead add "Config" and "NDEBUG;ENABLE_CHECKS=0".
Selection Options, such as Optimization Level, Architecture, and FPU Type, can be overridden. "Common" might set Architecture as "ARM v7EM", FPU Type as "FPv5-D16", and Optimization Level to "None". In "Debug" nothing has to be changed, as this already fits. In "Release" the Optimization Level might be overridden to "Optimize for Size".
Now Include Directories, Preprocessor Definitions, and Optimization Level are different, while the common ones do not have to be maintained in each Build Configuration.
Override Options
In Embedded Studio options cannot only be set on Solution or Project level. They can be set on any level, solution, projects, folders, and files. As with Build Configurations, all options that are not explicitly modified on a level, are inherited from the upper level. This enables modifying some options, such as defines, include directories, or optimization level, on one level, while retaining all other options.
For example, a project should be optimized for size, but one module should instead be optimized for highest speed. All options are set on project level. Only the optimization level of the module is changed.
Private and Public Configurations also apply on all levels. This also makes it possible to change the option of any level depending on the selected Build Configuration.
Project Options
To open the Project Options Dialog, select the item to change the options for in Project Explorer and go to Project -> Options... (Alt+Return), or right-click on the Item -> Options...
In the upper left of the Options Dialog the Public or Private Configuration to change the options in can be selected. By default the active Build Configuration is selected.
The "Search Options" text input enables easy filter for the option to be modified.
When "Show Modified Options Only" is checked, only options which do not have default values are shown. Options which are modified on the selected item and configuration are marked with "modified". "inherited" indicates that the option has been modified in another configuration or on a higher level. Which value is inherited from which level and configuration is shown in the Description when the item is selected.
Code Options
Main Article: Embedded Studio Code Options
The Code Options configure the build system, the toolchain (compiler, assembler, linker), the preprocessor, library configuration, and user build steps.
Debug Options
Main Article: Embedded Studio Debug Options
The Debug Options configure how the project should be debugged, which debug interface (J-Link, GDB Server, Simulator) should be used, and how the target should be configured on certain operations.
ES PRO Options
Main Article: Embedded Studio PRO Options
The ES PRO Options are available when the Embedded Studio PRO Package is installed. They configure which components of ES PRO to use in the project and how the libraries should be configured.
Debugging
Configure Instruction Trace in Embedded Studio
Configure SWO in Embedded Studio
Enable RTOS Awareness in Embedded Studio
Connect to remote J-Link via J-Link Tunnel Server
Debug with Embedded Studio and GDB Server such as OpenOCD
Set User-dependent J-Link connection in Embedded Studio
SEGGER Linker
How to enable SEGGER Linker in your Embedded Studio project
Placing external library symbols at specific address
Correct typing of Thumb functions
Place Functions in RAM with SEGGER Linker
Integrity checks with Embedded Studio and SEGGER Linker
