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 RD Infra quick start guide #811

Merged
merged 4 commits into from
Mar 25, 2024

Conversation

danielnguyen-arm
Copy link
Contributor

Before submitting a pull request for a new Learning Path, please review Create a Learning Path

  • [ X ] I have reviewed Create a Learning Path

Please do not include any confidential information in your contribution. This includes confidential microarchitecture details and unannounced product information. No AI tool can be used to generate either content or code when creating a learning path or install guide.

  • [ X ] I have checked my contribution for confidential information

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the Creative Commons Attribution 4.0 International License.

danielnguyen-arm and others added 4 commits March 19, 2024 13:53
Add a quick start guide that illustrates how to obtain the source, how to build it and how to run the firmware on an FVP.

Screenshots and terminal output dumps are used to illustrate the process and to simplify comparison with user's actual state and output.

Signed-off-by: Daniel Nguyen <daniel.nguyen@arm.com>
Debug guide contains how to connect to Arm DS debugger and set breakpoints for BL1, BL31, and BL33.
Screenshots are used to illustrate the debugging process.

Signed-off-by: Daniel Nguyen <daniel.nguyen@arm.com>
Copy link
Contributor

Choose a reason for hiding this comment

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

Please can you separate the commands that a user enters from the output that they will see, so that the commands can be easily copied by the reader.

Something like:

Enter the command:

this is the command to enter

Observe an output similar to:

This is the output of that command

Copy link
Contributor

Choose a reason for hiding this comment

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

Slang wording (bog standard, what in heavens...) not well understood by non-native speakers.

Copy link
Contributor

Choose a reason for hiding this comment

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

Add a comment that the screen shots are from Arm Development Studio (insert version).

Copy link
Contributor

Choose a reason for hiding this comment

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

Make title more specific, something like:

Debug the RD-N2 Reference design with Arm Development Studio

Copy link
Contributor

Choose a reason for hiding this comment

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

When removing -R, the user should also change -S (CADI) to -I (Iris). CADI is obsolete.

Copy link
Contributor

Choose a reason for hiding this comment

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

@jasonrandrews jasonrandrews merged commit d9ce6cf into ArmDeveloperEcosystem:main Mar 25, 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.

None yet

3 participants