Commit a78c9e98 authored by Tim Writer's avatar Tim Writer
Browse files

Merge branch 'master' into 'master' 

Update for 21.40

See merge request !4
parents caf37f04 3f45e075

source/install-bugrep.rst

+3 −11
Changes for source/install-bugrep.rst: 3 added lines, 11 removed lines.
Original line number Diff line number Diff line
@@ -6,16 +6,8 @@ Bugs should be reported through your AMD Customer Engagement Representative. 


If you downloaded a release archive directly from the AMD web site and do not

have an AMD Customer Engagement Representative, you may report bugs using the

`freedesktop.org Bugzilla <https://bugs.freedesktop.org/enter_bug.cgi>`_.

File bugs according to the following table:



+-------------+----------------------+------------------------+

| **Variant** | **Bugzilla Product** | **Bugzilla Component** |

+=============+======================+========================+

| All-Open    | DRI                  | DRM/AMDgpu             |

+-------------+----------------------+------------------------+

| Pro         | DRI                  | DRM/AMDgpu-pro         |

+-------------+----------------------+------------------------+

`gitlab.freedesktop.org issue tracker <https://gitlab.freedesktop.org/drm/amd/-/issues?label_name%5B%5D=AMDgpu-pro>`_

with the label "AMDgpu-pro".



=======================

Generating a Bug Report
@@ -89,7 +81,7 @@ Capturing the Output of Your Commands to a File 


   .. code-block:: bash



    $ ./amdgpu-install -y

    $ amdgpu-install -y --usecase=graphics



3. End the capture session.

source/install-installing.rst

+60 −67
Changes for source/install-installing.rst: 60 added lines, 67 removed lines.
Original line number Diff line number Diff line 
#################################

Installing or Uninstalling AMDGPU

#################################

###########################################

Installing or Uninstalling the AMDGPU stack

###########################################



.. contents:: Table of Contents



----------



Installing the All-Open Variant

===============================

Run the following command to install the All-Open variant:

Installing the All-Open Use Case

================================



.. note:: This was referred to as the "All-Open Variant" in previous

      documentation



Run the following command to install the All-Open components:



.. code-block:: bash



  $ ./amdgpu-install -y

  $ amdgpu-install -y --usecase=graphics





.. note:: The ``-y`` option installs non-interactively. See
@@ -23,58 +27,54 @@ Run the following command to install the All-Open variant: 


Reboot the target system after running ``amdgpu-install``.



Installing the Pro Variant

==========================

Installing the Workstation Use Case

===================================



.. note:: This was referred to as the "Pro Variant" in previous documentation



Refer to the following table to understand how to install a combination of Pro

components:

Refer to the following table to understand how to install a combination of

Workstation (WS) components:



+-------------------------------------------------------------+-----------------+

+--------------------------------------------------------------------------------+-----------------+

|**Command**                                                                     |**Installed      |

|                                                                                |Components**     |

+-------------------------------------------------------------+-----------------+

|``$ ./amdgpu-pro-install -y``                                |- Base kernel    |

+--------------------------------------------------------------------------------+-----------------+

|``$ amdgpu-install -y  --usecase=workstation``                                  |- Base kernel    |

|                                                                                |- Accelerated    |

|                                                                                |  graphics       |

|                                                                                |- Mesa           |

|                                                                                |  multimedia     |

|                                                             |- Pro OpenGL     |

|                                                             |- Pro Vulkan     |

+-------------------------------------------------------------+-----------------+

|``$ ./amdgpu-pro-install -y --opencl=rocr,legacy``           |- Base kernel    |

|                                                                                |- WS OpenGL      |

+--------------------------------------------------------------------------------+-----------------+

|``$ amdgpu-install --usecase=workstation -y --vulkan=pro --opencl=rocr,legacy`` |- Base kernel    |

|                                                                                |- Accelerated    |

|                                                                                |  graphics       |

|                                                                                |- Mesa           |

|                                                                                |  multimedia     |

|                                                             |- Pro OpenGL     |

|                                                                                |- WS OpenGL      |

|                                                                                |- Pro Vulkan     |

|                                                             |- Pro OpenCL     |

+-------------------------------------------------------------+-----------------+

|``$ ./amdgpu-pro-install -y --opencl=rocr,legacy --headless``|- Only base      |

|                                                             |  kernel         |

|                                                             |- Pro OpenCL     |

|                                                             |  (headless mode)|

+-------------------------------------------------------------+-----------------+

|                                                                                |- OpenCL         |

+--------------------------------------------------------------------------------+-----------------+



Reboot the target system after running ``amdgpu-pro-install``.

Reboot the target system after running ``amdgpu-install``.



For more information, refer to the following sections to understand how to

install individual components.



Components

===========



OpenGL (Default Component)

--------------------------



OpenGL is a default component of the Pro variant.



.. note:: Unless a headless installation is requested, OpenGL is installed.



OpenGL is a default component of both use cases.



.. _Installation-OpenCL-Optional-Component:



OpenCL (Optional Component)

---------------------------

OpenCL is an optional component of the Pro variant and is installed only if it is

specifically requested.

OpenCL is an optional component and is installed only if it is specifically

requested.



Two different implementations of OpenCL (legacy and ROCr) are provided.

Either of these implementations or both of them can be installed
@@ -113,41 +113,27 @@ that override the distribution defaults. If unsure, consult the documentation 
for your distribution or your organization.



In some scenarios, it may be desirable to install **only** the OpenCL portion

of the Pro variant (omitting the OpenGL portion), which can be accomplished

by adding the ``--headless`` option. The typical use case is headless compute.



of the AMDGPU stack (omitting the OpenGL portion), which can be accomplished

by using the ``--usecase=opencl`` option instead. The typical use case is

headless compute.



Vulkan (Default Component)

Vulkan (Optional Component)

---------------------------



Vulkan is a default component of the Pro variant.



.. note:: Unless a headless installation is requested, Vulkan is installed.



Vulkan is an optional component of the AMDGPU stack and is installed only if it

is specifically requested. The ``--vulkan`` option can be used to specify which

implementation of vulkan is desired.



PX Platform Support (Ubuntu only)

------------------------------------



.. note:: PX is deprecated in the latest version of the AMDGPU Graphics Stack.

	The All-Open variant with PRIME GPU offloading is recommend for all

	mobile variants with hybrid graphics, which allows GPU workloads to

	be offloaded to a discrete GPU on demand.



For PX (*PowerExpress*) platform support, use the ``--px`` option as shown in

the following command:



.. code-block:: bash



  $ ./amdgpu--pro-install --px

See :ref:`Installation-Vulkan-Optional-Component` for installation options.





Secure Boot Support

===================



The kernel modules used by the AMDGPU Graphics Stack rely on DKMS. DKMS will

compile the modules during installation and re-compile the modules when kernel

is updated. To use secure boot with DKMS, a machine owned key (MOK), which is

unique to the system, will be generated to sign the kernel modules.

The kernel modules used by the AMDGPU stack rely on DKMS. DKMS will compile the

modules during installation and re-compile the modules when kernel is updated.

To use secure boot with DKMS, a machine owned key (MOK), which is unique to the

system, will be generated to sign the kernel modules.



Please see the section below that applies to the distro of the target system.
@@ -231,22 +217,29 @@ the key certificate. Select "Reboot" to exit the MOK manager. 


The signed driver should now load successfully.



Uninstalling the AMDGPU Graphics Stack

======================================

Uninstalling the AMDGPU stack

=============================



To remove all components of the stack, run the uninstall script from anywhere

in the system.



1. Based on whether you installed the All-Open or Pro components, run one of

   the following commands:

1. To uninstall all components, run the following command:



   .. code-block:: bash



    # Use this for All-Open components

    $ amdgpu-uninstall



    # Use this for Pro components

    $ amdgpu-pro-uninstall





2. After uninstalling the components, reboot the target system.



3. For complete uninstall, remember to also remove the installer package

   "amdgpu-install" using your package manager:



.. code-block:: bash



 # For Ubuntu:

 $ sudo apt-get purge amdgpu-install

 # For RHEL:

 $ sudo yum remove amdgpu-install

 # For SLE:

 $ sudo zypper remove amdgpu-install

source/install-overview.rst

+56 −28
Changes for source/install-overview.rst: 56 added lines, 28 removed lines.
Original line number Diff line number Diff line
@@ -7,58 +7,86 @@ Overview 
----------



This guide provides installation and uninstallation procedures for the AMDGPU

graphics and compute stack.

stack.



.. note:: The rest of this document will refer to Radeon™ Software for Linux®

     as AMDGPU.

     as the AMDGPU stack.



.. note:: Some components, such as OpenCL, are provided by the ROCm stack. For

     simplicity, this subset of ROCm will be included in the use of the term

     "AMDGPU stack". Please see the

     `ROCm documentation <https://rocmdocs.amd.com/en/latest/>`_ for further

     information on other ROCm components.



---------



Stack Variants

**************

Stack Use Cases

***************



There are two major stack variants available for installation:

There are two major use cases available for installation:



- **Pro**: recommended for use with **Radeon Pro** graphics products.

- **Workstation**: recommended for use with **Radeon Pro** graphics products.

- **All-Open**: recommended for use with consumer products.



+--------------------+------------------------------------------------+

| Installing Option  | Components                                     |

| Install Use Case   | Components                                     |

+====================+================================================+

| All-Open Stack     | * Base kernel drivers                          |

| All-Open           | * Base kernel drivers                          |

|                    | * Base accelerated graphics drivers            |

|                    | * Mesa OpenGL                                  |

|                    | * Mesa multimedia                              |

+--------------------+------------------------------------------------+

| Pro Stack          | * Base kernel drivers                          |

|                    | * Base accelerated graphics drivers            |

|                    | * Mesa multimedia                              |

|                    | * Pro OpenGL                                   |

|                    | * Pro OpenCL                                   |

|                    | * OpenCL (optional)                            |

|                    |    - ROCr OpenCL stack (supports Vega 10 and   |

|                    |      later products)                           |

|                    |    - Legacy OpenCL stack (supports legacy      |

|                    |      products older than Vega 10)              |

|                    | * Pro Vulkan                                   |

+--------------------+------------------------------------------------+

| Workstation        | * Base kernel drivers                          |

| (**Proprietary**)  | * Base accelerated graphics drivers            |

|                    | * Mesa multimedia                              |

|                    | * Workstation OpenGL (**Proprietary**)         |

|                    | * OpenCL (optional)                            |

|                    |    - ROCr OpenCL stack, supports Vega 10 and   |

|                    |      later products                            |

|                    |    - Legacy OpenCL stack (**Proprietary**),    |

|                    |      supports legacy products older than       |

|                    |      Vega 10                                   |

|                    |                                                |

|                    | * Pro Vulkan (optional, **Proprietary**)       |

+--------------------+------------------------------------------------+



You can install a combination of stack components using the ``amdgpu-install``

script, as listed in the following:

script by appending comma separated selections to ``--vulkan``, ``--opencl``,

or ``--usecase``, such as:



.. code-block:: bash



* Base kernel and accelerated graphics drivers + Pro OpenGL + Pro Vulkan

* Base kernel and accelerated graphics drivers + Pro OpenGL + Pro Vulkan +

  Pro OpenCL

* Base kernel and accelerated graphics drivers + Pro OpenCL

* Base kernel drivers (**no** accelerated graphics drivers) + Pro OpenCL

  (headless mode)

  $ amdgpu-install --usecase=graphics,opencl



See ``amdgpu-install -h`` for more options or ``amdgpu-install --list-usecase``

for more available usecases.



.. note:: In the 21.40 release, ``amdgpu-install`` has changed and some options

    available in previous releases have been removed. ``amdgpu-pro-install``

    has been dropped, but the following equivalent command can be used instead:

    ``amdgpu-install --usecase=workstation --vulkan=pro``.



.. note::

   - When installing the All-Open stack using ``amdgpu-install`` script, every

     component from the All-Open stack will be installed. There is no

   - When installing the All-Open use case using ``amdgpu-install`` script,

     every component from the All-Open stack will be installed. There is no

     supported way to install arbitrary combinations of these components when

     using ``amdgpu-install`` but you can use the system package manager to do

     so.



   - 32-bit libraries are automatically installed with Pro OpenGL component when

     installation is performed using ``amdgpu-install`` script.
 
   - When installing any **Proprietary** components for the first time, the

     user will be prompted with the End User License Agreement ("EULA") and

     asked to accept. To allow for non-interactive install, the option

     ``--accept-eula`` can be appended to ``amdgpu-install``, but using this

     option will prevent the proprietary packages or updates from being

     accessible directly with the system package manager. By using the

     ``--accept-eula`` option, you are confirming that you have read and

     agreed to be bound by the terms and conditions of the EULA

     (/usr/share/amdgpu-insall/AMDGPUPROEULA) for use of AMD Proprietary

     components



   - 32-bit graphics runtime libraries are automatically installed when

     installation is performed using ``amdgpu-install`` script. The addition of

     the "--no-32" option can be used to exclude these runtime libraries.

source/install-prereq.rst

+32 −31
Changes for source/install-prereq.rst: 32 added lines, 31 removed lines.
Original line number Diff line number Diff line
@@ -6,30 +6,42 @@ Prerequisites 


----------



Downloading the Package Archive

********************************

Downloading the Installer Package

**********************************



The AMDGPU graphics stack is delivered as an archive of native

packages. Prior to installation, you must first obtain the archive from

your AMD Customer Engagement Representative or from the `AMD web site <https://support.amd.com/en-us/download>`_.

The AMDGPU stack is delivered as an installer package. Prior to installation,

you must first obtain the installer package from your AMD Customer Engagement

Representative, from the

`AMD web site <https://support.amd.com/en-us/download>`_, or from

`repo.radeon.com <http://repo.radeon.com/amdgpu-install/latest>`_.



Download the AMDGPU-Pro tar archive (for example, to ``~/Downloads``),

which contains the installation script.

Download the installer package to the system (for example, to ``~/Downloads``),

and install it using the package manager, which will make the installation

script available on your system.



--------



Extracting the Package Archive

*******************************

Installing the Installer Package

*********************************



Extract the tar archive to a known location. In the following commands,

replace ``YY.XX`` with the actual release number (e.g. 18.30) and ``NNNNNN``

six digit build number of the downloaded file:

In the following commands, replace ``amdgpu-install-VERSION.{deb,rpm}`` with

the actual file name of the downloaded installer package:



.. code-block:: bash



 $ cd ~/Downloads

 $ tar -Jxvf amdgpu-pro-YY.XX-NNNNNN.tar.xz

 $ cd ~/Downloads/amdgpu-pro-YY.XX-NNNNNN

 # For Ubuntu:

 $ sudo apt-get install ./amdgpu-install-VERSION.deb

 $ sudo apt-get update

 # For RHEL:

 $ sudo yum install ./amdgpu-install-VERSION.rpm

 # For SLE:

 $ sudo zypper install ./amdgpu-install-VERSION.rpm



.. note:: Installing "amdgpu-install" will add the installer and AMD related

   repositories to your system. The repositories will be accessible to the

   system package manager, which is in turn used by the installer.





---------
@@ -38,10 +50,9 @@ Configuring Access to the Distribution Repository (RHEL and SLE only) 


AMDGPU stack depends on packages provided by the Linux distribution vendors.



The AMDGPU-Pro driver requires access to specific RPMs from Red Hat

Enterprise Linux (RHEL) or SUSE Linux Enterprise (SLE) installation media

for the purpose of dependency resolution. You must ensure

**one** of the following:

The AMDGPU stack requires access to specific RPMs from Red Hat Enterprise Linux

(RHEL) or SUSE Linux Enterprise (SLE) installation media for the purpose of

dependency resolution. You must ensure **one** of the following:



- Have a valid subscription and be connected to Internet during installation.

- Mount an installation media (for example, DVD, USB key or ISO file). Media
@@ -51,16 +62,6 @@ for the purpose of dependency resolution. You must ensure 
  <https://documentation.suse.com/sles/15-SP1/html/SLES-all/cha-deployment-instserver.html#sec-remote-installation-iso>`_

  for details.



.. note:: In previous releases (before 18.30), a script named

      ``amdgpu-pro-preinstall.sh`` was provided to carry out this step and

      to perform other pre-installation checks and configuration. Starting

      with 18.30, all external dependencies (excluding dependencies on

      packages provided by the Linux distribution vendor) have been

      eliminated and the checks have been integrated into

      ``amdgpu-install``. Consequently, ``amdgpu-pro-preinstall.sh`` has

      been eliminated to streamline installation. However, access to

      distribution media or online package repositories is still required

      to satisfy base operating system dependencies. It is assumed most

      customers have a subscription with access to online repositories or

      are using a Linux distribution which does not require a subscription

      and has online repositories enabled by default.
 
.. note:: It is assumed most customers have a subscription with access to

      online repositories or are using a Linux distribution which does not

      require a subscription and has online repositories enabled by default.

source/install-script.rst

+52 −29

File changed.

Preview size limit exceeded, changes collapsed.