Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for debugging ARM with VSCode+BMP. #11217

Merged
merged 7 commits into from
Mar 8, 2024

Conversation

tzarc
Copy link
Member

@tzarc tzarc commented Dec 15, 2020

Description

Adds some documentation to the VSCode documentation page to describe a method do debug ARM MCUs using cortex-debug and a Black Magic Probe.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@tzarc tzarc requested a review from a team December 15, 2020 09:10
docs/other_vscode.md Outdated Show resolved Hide resolved
@stale
Copy link

stale bot commented Jan 30, 2021

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

@stale
Copy link

stale bot commented Mar 5, 2021

Thank you for your contribution!
This pull request has been automatically closed because it has not had activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready.

@stale stale bot closed this Mar 5, 2021
@tzarc tzarc deleted the vscode+black-magic-probe branch August 19, 2021 21:52
@tzarc tzarc restored the vscode+black-magic-probe branch November 21, 2023 09:19
@tzarc tzarc reopened this Nov 21, 2023
@drashna drashna self-requested a review November 21, 2023 09:21
docs/other_vscode.md Outdated Show resolved Hide resolved
docs/other_vscode.md Outdated Show resolved Hide resolved
@drashna
Copy link
Member

drashna commented Dec 1, 2023

Aside from that, tested this out and it works well.

Though, would it worth be adding a section for adding tasks to vscode, especially for the prelaunchtask? Not here necessarily, but just in general.

Copy link

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

@github-actions github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Jan 15, 2024
@KarlK90 KarlK90 added awaiting review and removed stale Issues or pull requests that have become inactive without resolution. labels Jan 15, 2024
@tzarc tzarc force-pushed the vscode+black-magic-probe branch from fb5e5e1 to 33e4a74 Compare February 15, 2024 10:46
@tzarc tzarc requested review from fauxpark, drashna and a team February 15, 2024 10:49
Copy link
Member

@KarlK90 KarlK90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just a little note on the compiler flags

Comment on lines 180 to 181
OPT = 0
OPT_DEFS += -g
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about OPT = g as this provides good debug ability and still adds a little bit of optimization. Debug information is generated by default for all binaries, but it would be better to default to -g3 by adding DEBUG = 3.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me, no real preference; if you want to make a suggestion on the PR for what it should look like I'll be more than happy to commit it.

docs/other_vscode.md Outdated Show resolved Hide resolved
Co-authored-by: Stefan Kerkmann <karlk90@pm.me>
@tzarc tzarc merged commit 8946aac into qmk:master Mar 8, 2024
2 checks passed
@tzarc tzarc deleted the vscode+black-magic-probe branch March 9, 2024 10:31
vpadillap pushed a commit to vpadillap/qmk_firmware that referenced this pull request Mar 11, 2024
whoisjordangarcia pushed a commit to whoisjordangarcia/qmk_firmware that referenced this pull request Jun 8, 2024
nuess0r pushed a commit to nuess0r/qmk_firmware that referenced this pull request Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants