Commit 25007ea8 authored by Tim Writer's avatar Tim Writer
Browse files

Merge branch 'master' into 'master' 

Update to 20.50 documentation

See merge request !2
parents 7d460fce 91a72672

source/install-installing.rst

+42 −8
Changes for source/install-installing.rst: 42 added lines, 8 removed lines.
Original line number Diff line number Diff line
@@ -29,10 +29,10 @@ Installing the Pro Variant 
Refer to the following table to understand how to install a combination of Pro

components:



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

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

|**Command**                                                  |**Installed      |

|                                                             |Components**     |

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

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

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

|                                                             |- Accelerated    |

|                                                             |  graphics       |
@@ -40,8 +40,8 @@ components: 
|                                                             |  multimedia     |

|                                                             |- Pro OpenGL     |

|                                                             |- Pro Vulkan     |

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

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

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

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

|                                                             |- Accelerated    |

|                                                             |  graphics       |

|                                                             |- Mesa           |
@@ -49,12 +49,12 @@ components: 
|                                                             |- Pro OpenGL     |

|                                                             |- Pro Vulkan     |

|                                                             |- Pro OpenCL     |

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

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

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

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

|                                                             |  kernel         |

|                                                             |- Pro OpenCL     |

|                                                             |  (headless mode)|

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

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



Reboot the target system after running ``amdgpu-pro-install``.
@@ -69,15 +69,49 @@ OpenGL is a default component of the Pro variant. 
.. note:: Unless a headless installation is requested, OpenGL is installed.





.. _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.



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

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

Either of these implementations or both of them can be installed

on the target system.



To use the ROCr implementation of OpenCL, the running user might need

additional permissions depending on OS policy. If ``clinfo`` or any openCL

application does not work, check ownership and permissions of the render

nodes:



.. code-block:: bash



        ls -l /dev/dri/render*



If the render nodes are owned by group render but not readable and writable by

all users, consider adding the current user to the render group:



.. code-block:: bash



        sudo usermod -a -G render $LOGNAME



If you are an administrator, ``$LOGNAME`` can be replaced by any valid

username.



Alternatively, if the render nodes are owned by the video group but not

readable and writable by all users, consider adding the current user to the

video group:



.. code-block:: bash



        sudo usermod -a -G video $LOGNAME



Different Linux distributions have different ownership and permission policies

for render nodes. In addition, your organization may have its own policies

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.

source/install-overview.rst

+1 −1
Changes for source/install-overview.rst: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ There are two major stack variants available for installation: 
|                    | * Mesa multimedia                              |

|                    | * Pro OpenGL                                   |

|                    | * Pro OpenCL                                   |

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

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

|                    |      later products)                           |

|                    |    - Legacy OpenCL stack (supports legacy      |

|                    |      products older than Vega 10)              |

source/install-prereq.rst

+1 −1
Changes for source/install-prereq.rst: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -48,7 +48,7 @@ for the purpose of dependency resolution. You must ensure 
  mounting instructions for **Red Hat** systems are provided at

  https://access.redhat.com/solutions/1355683. For **SLE**, use YaST to add the

  installation media as a new repository, see `the SUSE documentation

  <https://www.suse.com/documentation/sles-12/book_sle_deployment/data/sec_y2_sw_instsource.html>`_

  <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

source/install-script.rst

+12 −3
Changes for source/install-script.rst: 12 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -67,21 +67,30 @@ Specifying an OpenCL Implementation 


There are two OpenCL implementations available:



- **PAL**: Provides support for *Vega 10* and newer hardware.

- **ROCr**: Provides support for *Vega 10* and newer hardware.

- **Legacy**: Provides support for hardware older than *Vega 10*.



You can either install one or both implementations.



.. note:: In previous releases, the "PAL" implementation was used for Vega 10

      and newer, but this has been removed in favour for the ROCr backend,

      which is derived from the ROCm open source stack



.. note:: To use the ROCr implementation of OpenCL, the running user might

      need additional permissions. Usually the user must be added to the

      "render" group or to the "video" group. See the notes in

      :ref:`Installation-OpenCL-Optional-Component` for more details.



OpenCL is installed using the ``--opencl`` option, as follows:



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

|**Option**              | **Description**                             |

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

|``--opencl=pal``        | Installs PAL OpenCL.                        |

|``--opencl=rocr``       | Installs ROCr OpenCL.                       |

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

|``--opencl=legacy``     | Installs legacy OpenCL.                     |

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

|``--opencl=pal,legacy`` | Installs both PAL and legacy OpenCL.        |

|``--opencl=rocr,legacy``| Installs both ROCr and legacy OpenCL.       |

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



Applicable examples on this page demonstrate installation of both OpenCL