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

rm: boot sw update: include information about custom hardware require… #775

Closed
wants to merge 1 commit into from

Conversation

vanmaegima
Copy link
Member

…ments

Our reset logic for bootloader updates depends on having the WDOG_B pin connected to the PMIC, so add this to the docs.

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

…ments

Our reset logic for bootloader updates depends on having the WDOG_B pin
connected to the PMIC, so add this to the docs.

Signed-off-by: Vanessa Maegima <[email protected]>
@vanmaegima
Copy link
Member Author

@igoropaniuk based on our call today, I think this is a very important information to have in our docs. I don't know the best place to add it though.
@kprosise any thoughts?

@doanac
Copy link
Member

doanac commented Nov 22, 2024

@vanmaegima
Copy link
Member Author

@igoropaniuk does it apply to all imx or only imx8m?

@kprosise
Copy link
Contributor

@igoropaniuk based on our call today, I think this is a very important information to have in our docs. I don't know the best place to add it though. @kprosise any thoughts?

I think where it is placed in this commit works well. With a quick glance, I didn't find anywhere else equally or more appropriate where it could go.

@vanmaegima
Copy link
Member Author

@kprosise I will need to extend this PR to cover zynqMP as well. I will do that later today or tomorrow.

@@ -5,6 +5,9 @@
Boot Software Updates on iMX
============================

.. note::
The boot software update feature on iMX depends on having the WDOG_B signal of the SoC connected to the PMIC.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The boot software update feature on iMX depends on having the WDOG_B signal of the SoC connected to the PMIC.
The boot software update feature on iMX depends on having the ``WDOG_B`` signal of the SoC connected to the PMIC.

@igoropaniuk
Copy link
Contributor

I think we should rewrite this section completely, and include more details about the usage of watchdog and in which case we expect watchdog to assert WDOG_B signal, and in what cases we need "soft" reset.

@vanmaegima
Would you mind if I created a new PR with extended description and we just close this one?

Copy link
Contributor

@igoropaniuk igoropaniuk left a comment

Choose a reason for hiding this comment

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

Added a comment above

@vanmaegima
Copy link
Member Author

@igoropaniuk I think it's a great idea, I'll close this one

@vanmaegima vanmaegima closed this Nov 27, 2024
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.

5 participants