Add support for debug and program launch configurations #9342

Cypress-OpenOCD · 2019-01-10T16:19:30Z

Description

As of now the only one launch configuration is generated for the Eclipse which cannot cover all use cases. This PR is intended to extend support for different launch configurations (program, debug and erase) for the "cdt" exporter.

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[X] Functionality change
[ ] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@theotherjimmy

cmonr

LGTM

cmonr · 2019-01-10T16:35:41Z

LGTM, but afaik, we're not testing this specific exporter in CI.

@Cypress-OpenOCD Would you happen to have an example of something that this PR fixes/makes working? Something like a log or screenshot?

theotherjimmy · 2019-01-10T16:50:53Z

@Cypress-OpenOCD @cmonr This exporter is named eclipse_<toolchain> on the command line.

theotherjimmy · 2019-01-10T16:53:08Z

tools/export/cdt/__init__.py

+ templates = ['%s.tmpl' % (self.target.lower())] + \
+ ['%s.tmpl' % (label.lower()) for label
+ in self.toolchain.target.extra_labels] + \
+ ['%s.tmpl' % 'pyocd_settings']


As there are no target-specific templates, could we use the following instead:

templates = ["pyocd_settings.tmpl", "pyocd_settings_debug.tmpl", "pyocd_settings_program.tmpl"]

@theotherjimmy, I suggest to have 3 default templates: templates = ["pyocd_settings_debug.tmpl", "pyocd_settings_program.tmpl", "pyocd_settings_erase.tmpl"] . As I understood, the specific parameters should go through JSON file.

theotherjimmy · 2019-01-10T16:57:41Z

tools/export/cdt/__init__.py

+ try:
+ self.gen_file('cdt/%s' % templatefile, ctx, join('eclipse-extras',
+ '{target}_{project}_{launch}.launch'.format(target=self.target,
+ project=self.project_name, launch=templatefile)))


Indentation seems off here. Could you move target= onto it's own line and reflow the other arguments?

theotherjimmy · 2019-01-10T16:58:36Z

tools/export/cdt/__init__.py

+ self.gen_file('cdt/%s' % templatefile, ctx, join('eclipse-extras',
+ '{target}_{project}_{launch}.launch'.format(target=self.target,
+ project=self.project_name, launch=templatefile)))
+ except TemplateNotFound:


Just thought of this: without target-specific templates, there is no chance of missing templates. Could you get rid of the try-except here too?

rbatyuk · 2019-01-11T09:20:36Z

tools/export/cdt/pyocd_settings_debug.tmpl

+<stringAttribute key="ilg.gnuarmeclipse.debug.gdbjtag.pyocd.gdbServerExecutable" value="${pyocd_path}/${pyocd_executable}"/>
+<booleanAttribute key="ilg.gnuarmeclipse.debug.gdbjtag.pyocd.gdbServerFlashFastVerify" value="false"/>
+<intAttribute key="ilg.gnuarmeclipse.debug.gdbjtag.pyocd.gdbServerFlashMode" value="2"/>
+<intAttribute key="ilg.gnuarmeclipse.debug.gdbjtag.pyocd.gdbServerGdbPortNumber" value="3334"/>


the default template of pyocd_settings_debug.tml should be the same as pyocd_settings.tmpl. Specific port 3334 should be in the json file

@rbatyuk Could you specify which json file you're referring to?

rbatyuk · 2019-01-11T09:21:35Z

tools/export/cdt/pyocd_settings_debug.tmpl

+<booleanAttribute key="ilg.gnuarmeclipse.debug.gdbjtag.pyocd.gdbServerHaltAtHardFault" value="false"/>
+<stringAttribute key="ilg.gnuarmeclipse.debug.gdbjtag.pyocd.gdbServerLog" value=""/>
+<!-- Remove target name(-t cy8c6xxa) once we have DAPLink support in KP3 -->
+<stringAttribute key="ilg.gnuarmeclipse.debug.gdbjtag.pyocd.gdbServerOther" value="-t cy8c6xxa&#13;&#10;-p 3333&#13;&#10;--no-deprecation-warning"/>


the name of target should not be included in the default template

Cypress-OpenOCD · 2019-01-11T09:50:06Z

@rbatyuk, agree, there are some psoc6-related implementation in the templates. I cannot see any way to make 'generic' template without having some sort of set of target specific parameters somewhere, since some targets may require specific reset sequence etc. I am thinking about the similar approach that is used for the iar exporter. There are a set of defaults which can be redefined for the specific target (tools/export/iar/iar_definitions.json). If we make similar JSON for Eclipse we have single template per each use case (e.g. debug, program, erase) where some parameters may be added or redefined with their own flow.
@cmonr @theotherjimmy is this worth doing this?

theotherjimmy · 2019-01-11T15:14:04Z

@Cypress-OpenOCD I prefer having a system like iar_defines.json to having multiple templates.

Cypress-OpenOCD · 2019-01-11T15:19:55Z

@Cypress-OpenOCD I prefer having a system like iar_defines.json to having multiple templates.

I am already working on that, looks like we could end up with a single template.

theotherjimmy · 2019-01-11T15:21:23Z

looks like we could end up with a single template.

I'm excited to see that! Will it be one template total? or 3, one each for debug/program/erase?

Cypress-OpenOCD · 2019-01-11T15:25:21Z

.

looks like we could end up with a single template.

I'm excited to see that! Will it be one template total? or 3, one each for debug/program/erase?

Single template for all use cases. The concrete details would be implemented in the json. Hope it will work ;)

Cypress-OpenOCD · 2019-01-14T15:16:15Z

Hi, please check out the reworked version of program/debug launch configurations support. In short: now there is single template for all launch configurations. Default and target-specific data comes from cdt_definitions.json. Thus, if some target require any custom sequence it may define it in the JSON file (like for CY8CPROTO_062_4343W).

cmonr · 2019-01-14T19:53:07Z

Please rebase your PR.

A fix for the travis-ci/tools-py2.7 was brought in today (#9371) due to an update to the hypothesis module used in CI: https://github.com/HypothesisWorks/hypothesis/releases/tag/hypothesis-python-4.0.0

… template. Specific data comes from the JSON file

theotherjimmy

Minor thing, then mention me so that I can approve and we can get this improvement in.

tools/export/cdt/__init__.py

0xc0170 · 2019-01-15T14:29:49Z

[X] Functionality change

I labeled this for 5.11.3 , please review @theotherjimmy

theotherjimmy · 2019-01-15T14:41:15Z

@0xc0170 I'm already reviewing this PR.

0xc0170 · 2019-01-15T14:58:04Z

@0xc0170 I'm already reviewing this PR.

I was asking for review the label (if this can go into 5.11.3 or not)

theotherjimmy · 2019-01-15T14:58:58Z

@0xc0170 Thanks for the clarification.

Yes, 5.11.3 is a fine target.

theotherjimmy

~~Ya know what? I can make that change later.~~ As pointed out, I missed the use of self. approval still stands.

Cypress-OpenOCD · 2019-01-15T16:59:44Z

Ok, thanks.

cmonr · 2019-01-15T17:48:59Z

@0xc0170

I was asking for review the label (if this can go into 5.11.3 or not)

The files are all focused around a specific vendor's exporter. It's not as clean as the "is the change udner TARGETS/*" soft rule that we use, but this should definitely be fine for 5.11.3.

0xc0170 · 2019-01-17T16:49:35Z

CI started

cmonr · 2019-01-17T17:45:05Z

Whoops. Started CI too soon, it's being stopped in the backgound.

Cypress-OpenOCD · 2019-01-17T18:06:10Z

We are going to add GNU MCU Eclipse plugin support. It would be better to track the changes here.

mbed-ci · 2019-01-17T18:32:29Z

Test run: FAILED

Summary: 6 of 7 test jobs failed
Build number : 2
Build artifacts

Failed test jobs:

jenkins-ci/mbed-os-ci_build-GCC_ARM
jenkins-ci/mbed-os-ci_build-IAR
jenkins-ci/mbed-os-ci_build-ARM
jenkins-ci/mbed-os-ci_mbed2-build-ARM
jenkins-ci/mbed-os-ci_mbed2-build-GCC_ARM
jenkins-ci/mbed-os-ci_mbed2-build-IAR

Cypress-OpenOCD · 2019-01-18T16:46:15Z

Please review the changes made to support new GNU MCU Eclipse plug-in.
Changes:

Added new template to support GNU MCU Eclipse plug-in
Changed naming convention for new configurations:
- GNU ARM Eclipse - {target}_{project}_{configuration}_pyocd_settings.launch (remains the same)
- GNU MCU Eclipse - {target}_{project}_{configuration}.launch (to distinguish from GNU ARM Eclipse)

With these changes mbed export generates two sets of launch configurations: compatible with GNU ARM Eclipse, and GNU MCU Eclipse, therefore users may use plug-in they prefer.

We are going to add few more kits on Monday, which may affect cdt_definitions.json.

- added new erase launch configuration - added new kits support - code cleanup

Cypress-OpenOCD · 2019-01-30T17:58:35Z

Overview of this pull request:

Extended support of PyOCD launch configurations for Eclipse:

added support of GNU MCU Eclipse plug-in (launch configurations generates now for both plug-ins)
added 2 new launch configurations: program and erase

Made launch configurations template flexible and extendable:

created cdt_definitions.json where launch configuration options may be extended for specific targets
__init__.py uses cdt_definitions.json to fill the launch templates

@theotherjimmy please review

theotherjimmy

Most of these comments are style nits or online compiler tweaks. The online compiler will load this file once and use it for many, many exporters. Therefore it is important to make sure that you don't modify any global state within the exporter to avoid accidentally copying settings between users exporting.

tools/export/cdt/__init__.py

Co-Authored-By: Cypress-OpenOCD <39907069+Cypress-OpenOCD@users.noreply.github.com>

theotherjimmy · 2019-01-31T17:54:26Z

tools/export/cdt/__init__.py

 class Eclipse(Makefile):
 """Generic Eclipse project. Intended to be subclassed by classes that
 specify a type of Makefile.
 """
+ def get_target_config(self, ctx, configuration):
+ """Retrieve info from cdt_definitions.json"""
+ tgt = deepcopy(TARGET_MAP[self.target])


I don't think you need this deepcopy. Further, I think you only use tgt.name which is always the same as self.target.

theotherjimmy · 2019-01-31T17:55:19Z

tools/export/cdt/__init__.py

+ def get_target_config(self, ctx, configuration):
+ """Retrieve info from cdt_definitions.json"""
+ tgt = deepcopy(TARGET_MAP[self.target])
+ defaults = deepcopy(_CONFIGS_OPTIONS['default'])


I don't think you modify defaults, so this copy may not be needed.

Ok, I think this may be kept to prevent any issues in case future updates

theotherjimmy

Looks good. Previous comments are not blocking.

cmonr · 2019-01-31T20:12:04Z

CI started

mbed-ci · 2019-01-31T21:56:12Z

Test run: SUCCESS

Summary: 12 of 12 test jobs passed
Build number : 3
Build artifacts

cmonr requested a review from a team January 10, 2019 16:34

cmonr approved these changes Jan 10, 2019

View reviewed changes

cmonr requested a review from a team January 10, 2019 16:34

cmonr added the needs: review label Jan 10, 2019

theotherjimmy suggested changes Jan 10, 2019

View reviewed changes

rbatyuk reviewed Jan 11, 2019

View reviewed changes

Andriy.Lishchynskyi added 2 commits January 15, 2019 16:08

added support for debug and program launch configurations

9fa2c75

Reworked launch configuration creation mechanism - switched to single…

7a85ae7

… template. Specific data comes from the JSON file

Cypress-OpenOCD force-pushed the master branch from fa8c8c3 to 7a85ae7 Compare January 15, 2019 14:10

theotherjimmy suggested changes Jan 15, 2019

View reviewed changes

tools/export/cdt/__init__.py Show resolved Hide resolved

0xc0170 added the release-version: 5.11.3 label Jan 15, 2019

theotherjimmy approved these changes Jan 15, 2019

View reviewed changes

cmonr added the needs: CI label Jan 16, 2019

cmonr added needs: work and removed needs: CI labels Jan 17, 2019

Added GNU MCU Eclipse plug-in support

7f2caac

cmonr added needs: review and removed needs: work labels Jan 18, 2019

Fix python3 compatibility issue

55a6ca5

cmonr added release-version: 5.11.4 and removed release-version: 5.11.3 labels Jan 24, 2019

Changes:

48dfcd9

- added new erase launch configuration - added new kits support - code cleanup

Added copyright notes

6f584cd

theotherjimmy suggested changes Jan 31, 2019

View reviewed changes

theotherjimmy and others added 2 commits January 31, 2019 19:29

Apply suggestions from code review

020c840

Co-Authored-By: Cypress-OpenOCD <39907069+Cypress-OpenOCD@users.noreply.github.com>

Resolved code review comments

be5a625

theotherjimmy reviewed Jan 31, 2019

View reviewed changes

theotherjimmy approved these changes Jan 31, 2019

View reviewed changes

cmonr added needs: CI and removed needs: review labels Jan 31, 2019

cmonr added ready for merge and removed needs: CI labels Jan 31, 2019

0xc0170 merged commit 7ba83a5 into ARMmbed:master Feb 1, 2019

0xc0170 removed the ready for merge label Feb 1, 2019

AndriiLishchynskyi mentioned this pull request Apr 2, 2019

eclipse_gcc_arm export improvement #10295

Merged

Add support for debug and program launch configurations #9342

Add support for debug and program launch configurations #9342

Conversation

Cypress-OpenOCD commented Jan 10, 2019

Description

Pull request type

Reviewers

cmonr left a comment

Choose a reason for hiding this comment

cmonr commented Jan 10, 2019

theotherjimmy commented Jan 10, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cypress-OpenOCD commented Jan 11, 2019

theotherjimmy commented Jan 11, 2019

Cypress-OpenOCD commented Jan 11, 2019

theotherjimmy commented Jan 11, 2019 • edited Loading

Cypress-OpenOCD commented Jan 11, 2019

Cypress-OpenOCD commented Jan 14, 2019

cmonr commented Jan 14, 2019

theotherjimmy left a comment

Choose a reason for hiding this comment

0xc0170 commented Jan 15, 2019

theotherjimmy commented Jan 15, 2019

0xc0170 commented Jan 15, 2019

theotherjimmy commented Jan 15, 2019

theotherjimmy left a comment • edited Loading

Choose a reason for hiding this comment

Cypress-OpenOCD commented Jan 15, 2019

cmonr commented Jan 15, 2019

0xc0170 commented Jan 17, 2019

cmonr commented Jan 17, 2019 • edited Loading

Cypress-OpenOCD commented Jan 17, 2019

mbed-ci commented Jan 17, 2019

Cypress-OpenOCD commented Jan 18, 2019

Cypress-OpenOCD commented Jan 30, 2019

theotherjimmy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

theotherjimmy left a comment

Choose a reason for hiding this comment

cmonr commented Jan 31, 2019

mbed-ci commented Jan 31, 2019

theotherjimmy commented Jan 11, 2019 •

edited

Loading

theotherjimmy left a comment •

edited

Loading

cmonr commented Jan 17, 2019 •

edited

Loading