Skip to content

Adding docs on adding new platforms and debugger types #384

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

Merged
merged 1 commit into from
Aug 31, 2018

Conversation

bridadan
Copy link
Contributor

@bridadan bridadan commented Aug 7, 2018

Fixes #382

Could you please review @cmonr and @theotherjimmy?

@coveralls
Copy link

coveralls commented Aug 7, 2018

Coverage Status

Coverage decreased (-1.03%) to 79.39% when pulling 029e4b2 on bridadan:adding_platforms_doc into 3c81a02 on ARMmbed:master.


Add an entry to the `daplink` section of the [`DEFAULT_PLATFORM_DB`](https://github.com/ARMmbed/mbed-ls/blob/master/mbed_lstools/platform_database.py#L45).

If your platform's name is `NEW_PLATFORM` and it has platform ID of `9999`, the new entry should be:
Copy link

Choose a reason for hiding this comment

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

More for my info, what sets the platform ID?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That stuff is defined the Mbed Enabled docs, but its the first 4 characters of the USB ID, which is set by the debug firmware (DAPLink, ST-Link, etc).

README.md Outdated

### Adding support for J-Link platforms

J-Link detection works a differently due to the information present on the platform's filesystem. All new entries should be added to the `jlink` section of the [`DEFAULT_PLATFORM_DB`](https://github.com/ARMmbed/mbed-ls/blob/master/mbed_lstools/platform_database.py#L45).
Copy link

Choose a reason for hiding this comment

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

"works a bit differently"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oops, I accidentally a word 😄 I mean to say "J-Link detection work differently".

@cmonr
Copy link

cmonr commented Aug 7, 2018

@janjongboom Does this clarify things?

@bridadan bridadan force-pushed the adding_platforms_doc branch from 03e76d3 to 029e4b2 Compare August 7, 2018 16:30
@bridadan
Copy link
Contributor Author

bridadan commented Aug 7, 2018

@cmonr fixed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants