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

versal2: add documentation #259

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions building/devices/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Device specific information
:maxdepth: 1

versal
versal2
devbox
fvp
hikey620
Expand Down
42 changes: 42 additions & 0 deletions building/devices/versal2.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
.. _versal2:

################
AMD Versal Gen 2
################
The following instructions demonstrate how to obtain the OP-TEE source code and build it for the AMD Versal Gen 2 platform.

Supported boards
****************
AMD Versal Gen 2 adaptive SoCs combine world-class programmable logic from AMD with a new high-performance processing system of integrated Arm CPU.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not very useful in this (technical) documentation. Instead, please mention (or link to) which board precisely are supported. Readers should be able to know which board model to purchase if they want to run OP-TEE.


Stay tuned for more updates!
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove


Configuring and building
************************

.. code-block:: bash

$ mkdir -p optee_project
$ cd optee_project
$ repo init -u https://github.com/OP-TEE/manifest.git -m versal2.xml
$ repo sync

Compilation
***********
Run the following commands to compile all the necessary source code.

.. code-block:: bash

$ cd build
$ make toolchains
$ make all
Copy link
Contributor

Choose a reason for hiding this comment

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

Adding -j$(nproc) can speed up the build quite a bit so I recommend adding it. And all is the default target so it does not need to be specified. So I suggest: make -j$(nproc)


Build Artifacts
***************
All the build artifacts are available in the output directory.

.. code-block:: bash

$ cd ../out/bin/

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps add some instructions on how to obtain any extra firmware binary(ies) and flash the firmware onto the board?

Copy link
Author

Choose a reason for hiding this comment

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

@jforissier
discussed few things with @jenswi-linaro separately for this. Updating the change accordingly.

Stay tuned for more updates!
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove

5 changes: 5 additions & 0 deletions general/platforms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ please refer to the file MAINTAINERS_ for contact details for various platforms.
- Publicly available?
- Maintained?

* - `AMD Versal Gen 2 <https://www.amd.com/en/products/adaptive-socs-and-fpgas/versal/gen2/prime-series.html>`_
- ``PLATFORM=versal2``
- Yes
- Yes

* - `ARM Juno Board <http://www.arm.com/products/tools/development-boards/versatile-express/juno-arm-development-platform.php>`_
- ``PLATFORM=vexpress-juno``
- Yes
Expand Down