Installing or Uninstalling AMDGPU ¶

Table of Contents

Installing or Uninstalling AMDGPU

Installing the All-Open Variant ¶

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

$ ./amdgpu-install -y

Note

The -y option installs non-interactively. See Using the amdgpu-install script for more information.

Reboot the target system after running amdgpu-install.

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 Mesa multimedia Pro OpenGL Pro Vulkan
`$ ./amdgpu-pro-install -y --opencl=rocr,legacy`	Base kernel Accelerated graphics Mesa multimedia Pro OpenGL Pro Vulkan Pro OpenCL
`$ ./amdgpu-pro-install -y --opencl=rocr,legacy --headless`	Only base kernel Pro OpenCL (headless mode)

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

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

OpenGL (Default Component)¶

OpenGL is a default component of the Pro variant.

Note

Unless a headless installation is requested, OpenGL is installed.

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 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:

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:

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:

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.

Vulkan (Default Component)¶

Vulkan is a default component of the Pro variant.

Note

Unless a headless installation is requested, Vulkan is installed.

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:

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

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.

Please see the section below that applies to the distro of the target system.

Note

If you already have a MOK enrolled on your system, the driver package expects the private key for this MOK to be installed in a specific location (see table below). Prior to installing the driver, either copy the private key to this location or create a symbolic link.

DISTRO	MOK PRIVATE KEY
Ubuntu/Debian	/var/lib/shim-signed/mok/MOK.priv
RHEL/CentOS	/root/mok.priv

Note

The MOK directory contains the private key used for signing kernel modules. It is highly suggested to use disk encryption to avoid leaking this key to a malicious attacker. Please be aware of the risk.

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

Reboot the system and the MOK manager will start automatically.

See Using the MOK Manager to Enroll the MOK Certificate for further instructions.

RHEL/CentOS Systems ¶

To use secure boot with this driver stack, you must manually import the MOK certificate onto your system. The driver installation will automatically generate a MOK if it doesn’t already exist in the MOK directory.

To import the MOK certificate, first install the “mokutil” package using your package manager:

sudo yum install mokutil

Then run mokutil to import the certificate:

sudo mokutil --import /root/mok.der

Mokutil will require you to provide a temporary password for importing the certificate. Reboot the system and the MOK manager will start automatically.

See Using the MOK Manager to Enroll the MOK Certificate for further instructions.

SLE Systems ¶

Signing support for dkms requires dkms version 2.8, which is unavailable in SLE. If DKMS is updated manually by the user, signing can be used in the same way as RHEL, but this is untested and might not work as intended. Please use at your own risk.

Using the MOK Manager to Enroll the MOK Certificate ¶

After requesting to import the MOK certificate and entering a temporary password, the MOK manager will start on next boot.

Hit any key to avoid continuing boot. Do no select “Continue Boot”, but rather select “Enroll MOK” and “View key 0” to confirm that the key is correct.

Select “Continue”, “Yes”, and enter the temporary password to finish enrolling the key certificate. Select “Reboot” to exit the MOK manager.

The signed driver should now load successfully.

Uninstalling the AMDGPU Graphics Stack ¶

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

Based on whether you installed the All-Open or Pro components, run one of the following commands:

# Use this for All-Open components
$ amdgpu-uninstall

# Use this for Pro components
$ amdgpu-pro-uninstall

After uninstalling the components, reboot the target system.