Skip to content

Conversation

@qiujiandong
Copy link
Contributor

@qiujiandong qiujiandong commented May 20, 2025

Important

Adds a tutorial on debugging with multiple FTDI devices using FTDI-FT2322H, including FT_PROG usage and OpenOCD configuration updates.

  • Documentation:
    • Adds 27-debug_with_multiple_ftdi_devices.md to provide a tutorial on debugging with multiple FTDI devices using FTDI-FT2322H.
    • Includes steps for downloading FT_PROG, viewing, and modifying serial numbers, and updating OpenOCD configurations for Linux and Windows.
  • Configuration:
    • Updates mkdocs.yml to include the new document in the navigation.

This description was created by Ellipsis for 2346163. You can customize this summary. It will automatically update as commits are pushed.

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

Caution

Changes requested ❌

Reviewed everything up to 2346163 in 1 minute and 40 seconds. Click for details.
  • Reviewed 102 lines of code in 2 files
  • Skipped 6 files when reviewing.
  • Skipped posting 5 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. 27-debug_with_multiple_ftdi_devices.md:6
  • Draft comment:
    Consider rewording the sentence to remove the duplicate '通过' for better clarity.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None
2. 27-debug_with_multiple_ftdi_devices.md:20
  • Draft comment:
    Verify that the directory name 'asserts' is intentional; it is commonly 'assets'.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None
3. mkdocs.yml:34
  • Draft comment:
    Navigation entry for the new tutorial is correctly added.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None
4. 27-debug_with_multiple_ftdi_devices.md:6
  • Draft comment:
    Typo: The sentence "如何通过OpenOCD通过特定的蜂鸟调试器连接待调试设备?" contains a redundant "通过". Consider revising it to remove the duplication.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While the comment is technically correct about the redundant word, our rules state we should not make purely informative comments. The meaning is clear even with the redundant word, and this is documentation rather than code. The suggestion is more about style than a technical issue requiring a fix. The language could be clearer and more professional with this change. Documentation quality is important for user understanding. While documentation quality matters, our rules explicitly state to only comment when there is clearly a code change required. This is a minor style suggestion that doesn't impact functionality. Delete the comment as it's a purely stylistic suggestion that doesn't highlight a technical issue requiring a fix.
5. 27-debug_with_multiple_ftdi_devices.md:83
  • Draft comment:
    Typo: The reference "FTDI Utilites" seems to have a misspelling. Consider changing "Utilites" to "Utilities".
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50% While this is technically correct - there is a typo - it's an extremely minor issue in a reference link text. The link itself works correctly. The typo doesn't impact functionality or understanding. This feels like the kind of nitpicky comment that adds noise without much value. The typo could be seen as unprofessional and it's a very simple fix that would improve quality. It's also in a user-facing documentation file. While documentation quality matters, this is such a minor typo that it doesn't significantly impact readability or understanding. The comment adds more noise than value. Delete this comment as it's too minor of an issue to warrant a PR comment. It violates the rule about not making unimportant comments.

Workflow ID: wflow_FtuoCx9rIfgwVxKZ

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.


## 问题说明

芯来科技的蜂鸟调试器采用[FTDI-FT2322H](https://ftdichip.cn/Products/ICs/FT2232H.html)作为USB接口转换芯片。
Copy link

Choose a reason for hiding this comment

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

Inconsistent chip model: FT2322H is used here, but the linked product refers to FT2232H. Please verify and use consistent naming.

## 参考资料

- [Nuclei Studio FAQs —— How to select correct FDTI debugger?](https://doc.nucleisys.com/nuclei_sdk/faq.html#how-to-select-correct-fdti-debugger)
- [FTDI Utilites](https://ftdichip.com/utilities/)
Copy link

Choose a reason for hiding this comment

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

Typo in the reference list: 'FTDI Utilites' should be 'FTDI Utilities'.

Suggested change
- [FTDI Utilites](https://ftdichip.com/utilities/)
- [FTDI Utilities](https://ftdichip.com/utilities/)


## 参考资料

- [Nuclei Studio FAQs —— How to select correct FDTI debugger?](https://doc.nucleisys.com/nuclei_sdk/faq.html#how-to-select-correct-fdti-debugger)
Copy link

Choose a reason for hiding this comment

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

Typo: In the reference title How to select correct FDTI debugger?, FDTI appears to be a typo. It should likely be FTDI.

Suggested change
- [Nuclei Studio FAQs —— How to select correct FDTI debugger?](https://doc.nucleisys.com/nuclei_sdk/faq.html#how-to-select-correct-fdti-debugger)
- [Nuclei Studio FAQs —— How to select correct FTDI debugger?](https://doc.nucleisys.com/nuclei_sdk/faq.html#how-to-select-correct-fdti-debugger)

Copy link
Member

@fanghuaqi fanghuaqi left a comment

Choose a reason for hiding this comment

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

LGTM

@fanghuaqi
Copy link
Member

还需要执行下 python update.py @qiujiandong

Signed-off-by: qiujiandong <qiujiandong@nucleisys.com>
@qiujiandong qiujiandong requested a review from fanghuaqi May 20, 2025 09:15
@fanghuaqi fanghuaqi merged commit b242f33 into Nuclei-Software:main May 20, 2025
1 check passed
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.

2 participants