Merge branch 'master' into 'master' (20746264) · Commits · amdgpu / docs / amdgpu-install

source/install-installing.rst

+9 −42

Changes for source/install-installing.rst: 9 added lines, 42 removed lines.
Original line number	Diff line number	Diff line
		@@ -30,39 +30,6 @@ Run the following command to install the All-Open components:

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

		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
		Workstation (WS) components:

		+-------------------------------------------------------------------------+-----------------+
		\|Command \|**Installed \|
		\| \|Components** \|
		+-------------------------------------------------------------------------+-----------------+
		\|``$ amdgpu-install -y --usecase=workstation`` \|- Base kernel \|
		\| \|- Accelerated \|
		\| \| graphics \|
		\| \|- Mesa \|
		\| \| multimedia \|
		\| \|- WS OpenGL \|
		+-------------------------------------------------------------------------+-----------------+
		\|``$ amdgpu-install --usecase=workstation -y --vulkan=pro --opencl=rocr`` \|- Base kernel \|
		\| \|- Accelerated \|
		\| \| graphics \|
		\| \|- Mesa \|
		\| \| multimedia \|
		\| \|- WS OpenGL \|
		\| \|- Pro Vulkan \|
		\| \|- OpenCL \|
		+-------------------------------------------------------------------------+-----------------+

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

		For more information, refer to the following sections to understand how to
		install individual components.

		Components
		===========
		@@ -79,12 +46,6 @@ OpenCL (Optional Component)
		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
		on the target system. Legacy is deprecated and will be removed in the future.
		Once removed, legacy products will no longer be officially supported, but some
		products might work on the ROCr OpenCL implementation with varying results.

		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
		@@ -162,9 +123,15 @@ Please see the section below that applies to the distro of the target system.
		Ubuntu and Debian Based Systems
		-------------------------------

		Prior to installing the driver, enable secure boot on the target system. If
		secure boot is enabled during driver installation, a MOK will be automatically
		generated during install, if it doesn't already exist in the MOK directory,
		Prior to installing the driver, enable secure boot on the target system and
		install the "shim-signed" package like so:

		.. code-block:: bash

		sudo apt-get install shim-signed

		If shim-signed is installed and secure boot is enabled during driver
		installation, a MOK will be automatically generated during install if needed
		and the user will be prompted to enter a temporary password to import the MOK
		certificate into the system. This prompt uses a text mode tool, which can be
		navigated using TAB to highlight, and ENTER to select.

source/install-overview.rst

+29 −27

Changes for source/install-overview.rst: 29 added lines, 27 removed lines.
Original line number	Diff line number	Diff line
		@@ -29,10 +29,7 @@ For more information about supported AMD Radeon™ desktop GPUs, see
		Stack Use Cases
		***************

		There are two major use cases available for installation:

		- Workstation: recommended for use with Radeon Pro graphics products.
		- All-Open: recommended for use with consumer products.
		amdgpu-install supports the All-Open use case

		+--------------------+------------------------------------------------+
		\| Install Use Case \| Components \|
		@@ -45,16 +42,30 @@ There are two major use cases available for installation:
		\| \| - ROCr OpenCL stack (supports Vega 10 and \|
		\| \| later products) \|
		+--------------------+------------------------------------------------+
		\| 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 \|
		\| \| \|
		\| \| * Pro Vulkan (optional, Proprietary) \|
		+--------------------+------------------------------------------------+


		Install Script
		**************

		The AMDGPU stack can be installed using a simple installation script
		``amdgpu-install``

		The ``amdgpu-install`` script does the following:

		- Simplifies the installation of the AMDGPU stack by encapsulating the
		distribution specific package installation logic.
		- Allows using command line options to specify the following:
		* Use case of the AMDGPU stack to be installed
		* Combination of components
		- Performs post-install checks to verify whether the installation was performed
		successfully.
		- Installs the uninstallation script which can be used to remove the whole
		AMDGPU stack from the system by using a single command.

		The ``amdgpu-install`` script is provided by the installer package. The steps to download the
		installer package are specified in :ref:`Downloading-the-Installer-Package`.

		---------

		You can install a combination of stack components using the ``amdgpu-install``
		script by appending comma separated selections to ``--vulkan``, ``--opencl``,
		@@ -67,11 +78,12 @@ or ``--usecase``, such as:
		See ``amdgpu-install -h`` for more options or ``amdgpu-install --list-usecase``
		for more available usecases.

		Refer to :ref:`Invoking-the-amdgpu-install-script` for additional details.

		---------

		.. note:: Starting with 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 use case using ``amdgpu-install`` script,
		@@ -80,16 +92,6 @@ for more available usecases.
		using ``amdgpu-install`` but you can use the system package manager to do
		so.

		- 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

source/install-prereq.rst

+2 −0

Changes for source/install-prereq.rst: 2 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		@@ -18,6 +18,8 @@ See :ref:`Uninstalling-the-AMDGPU-stack` for uninstall instructions.

		---------

		.. _Downloading-the-Installer-Package:

		Downloading the Installer Package
		**********************************

source/install-script.rst

+2 −54

Changes for source/install-script.rst: 2 added lines, 54 removed lines.
Original line number	Diff line number	Diff line
		@@ -19,26 +19,7 @@ sections of this page.

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

		Purpose
		=======

		The ``amdgpu-install`` script does the following:

		- Simplifies the installation of the AMDGPU stack by encapsulating the
		distribution specific package installation logic and by using command line
		options that allow to specify the:

		* Use case of the AMDGPU stack to be installed (All-Open or Workstation)
		* Combination of components (in case of the Pro stack, or user selection)

		- Performs post-install checks to verify whether the installation was performed
		successfully.
		- Installs the uninstallation script to allow you to remove the whole
		AMDGPU stack from the system by using a single command.

		The script is provided by the installer package.

		---------
		.. _Invoking-the-amdgpu-install-script:

		Invoking the ``amdgpu-install`` Script
		=======================================
		@@ -57,13 +38,9 @@ Scenarios
		Specifying an OpenCL Implementation
		-----------------------------------

		There are two OpenCL implementations available:
		There is currently only one OpenCL implementations available:

		- ROCr: Provides support for Vega 10 and newer hardware.
		- Legacy: Provides support for hardware older than Vega 10.
		(DEPRECATED, requires EULA acceptance)

		You can either install one or both implementations.

		.. note:: To use the ROCr implementation of OpenCL, the running user might
		need additional permissions. Usually the user must be added to the
		@@ -77,13 +54,6 @@ OpenCL is installed using the ``--opencl`` option, as follows:
		+------------------------+-----------------------------------------------------+
		\|``--opencl=rocr`` \| Installs ROCr OpenCL. \|
		+------------------------+-----------------------------------------------------+
		\|``--opencl=legacy`` \| Installs legacy OpenCL (DEPRECATED Proprietary) \|
		+------------------------+-----------------------------------------------------+
		\|``--opencl=rocr,legacy``\| Installs both ROCr and legacy OpenCL. \|
		+------------------------+-----------------------------------------------------+

		Applicable examples on this page demonstrate installation of both OpenCL
		implementations.


		.. _Installation-Vulkan-Optional-Component:
		@@ -120,28 +90,6 @@ usage output.
		$ amdgpu-install -h


		Installing Non-Interactively
		-----------------------------

		Using the argument ``-y`` informs the package management system to assume
		the answer yes for any interactive question. The ``--accept-eula`` option
		will skip the first time install prompt for the user to accept the EULA.

		These options allow the install script to embed itself inside other automated
		scripts.

		Example:

		.. code-block:: bash

		$ amdgpu-install -y --accept-eula

		.. note:: The ``--accept-eula`` option is only required for proprietary
		components, which require acceptance of the EULA. By using this 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.


		Adding Advanced Package Management Functionality
		---------------------------------------------------

source/preamble.rst

+1 −1

Changes for source/preamble.rst: 1 added line, 1 removed line.
Original line number	Diff line number	Diff line
		@@ -2,7 +2,7 @@
		Preamble
		########

		© 2021 Advanced Micro Devices, Inc. The information contained herein
		© 2025 Advanced Micro Devices, Inc. The information contained herein
		is for informational purposes only and is subject to change without
		notice. While every precaution has been taken in the preparation
		of this document, it may contain technical inaccuracies, omissions