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

Feature: FTDI structure clarity & documentation #1627

Merged
merged 3 commits into from
Sep 20, 2023

Conversation

dragonmux
Copy link
Member

@dragonmux dragonmux commented Sep 20, 2023

Detailed description

This PR sets out to clean up the FTDI port state structure, document it, document where to find the MPSSE protocol and command documentation, and clean up the use of that structure.

This was spurred on when helping @lethalbit figure out how to describe the Kria SOM KV260's FTDI device pinout and getting caught up on what all the bits meant and did, resulting in us having to read the source and FTDI documentation to figure it out.

Tested against Tigard

Your checklist for this pull request

  • I've read the Code of Conduct
  • I've read the guidelines for contributing to this repository
  • It builds for hardware native (make PROBE_HOST=native)
  • It builds as BMDA (make PROBE_HOST=hosted)
  • I've tested it to the best of my ability
  • My commit messages provide a useful short description of what the commits do

Closing issues

@dragonmux dragonmux requested a review from esden September 20, 2023 02:04
@dragonmux dragonmux added this to the v1.10 milestone Sep 20, 2023
@dragonmux dragonmux added Enhancement General project improvement BMD App Black Magic Debug App (aka. PC hosted) (not firmware) Documentation Project documentation labels Sep 20, 2023
Copy link
Contributor

@amyspark amyspark left a comment

Choose a reason for hiding this comment

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

😹 Hey! Just two nits I found while reading it?

src/platforms/hosted/ftdi_bmp.c Outdated Show resolved Hide resolved
src/platforms/hosted/ftdi_bmp.h Outdated Show resolved Hide resolved
@dragonmux dragonmux force-pushed the feature/ftdi-structure-clarity-docs branch from fc4432a to 52fd7db Compare September 20, 2023 02:14
Copy link
Member

@esden esden left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! :)

@esden esden merged commit f278db4 into main Sep 20, 2023
6 checks passed
@dragonmux dragonmux deleted the feature/ftdi-structure-clarity-docs branch September 20, 2023 02:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BMD App Black Magic Debug App (aka. PC hosted) (not firmware) Documentation Project documentation Enhancement General project improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants