gpu-configurator

README

GPU Configurator

The gpu-configurator tool is born to organize and help users configure their GPU cards to run correctly on Xorg or Xwayland.

It's mainly usable on Macaroni OS and/or Funtoo/Gentoo environments but the code is been organized to add support for additional OS.

It's under heavy development and new features will be added to cover in a better way multiple use cases, but it's first target is configured NVIDIA cards.

Commands

lspci

This command runs the system lspci command and parse the output in order to have it in JSON or YAML format.

$> gpu-configurator lspci --help
Like lspci but in YAML/JSON output.

Usage:
   lspci [flags]

Flags:
  -h, --help            help for lspci
  -o, --output string   Modify output format (terminal,yaml,json). (default "yaml")

Global Flags:
  -c, --config string   Gpu Configurator configfile
  -d, --debug           Enable debug output.

show

The show command permits to analyze the status of the current system and print a summary in textual mode or show the system detail in JSON or YAML format.

$> gpu-configurator show --help
Show system configuration.

Usage:
   show [flags]

Flags:
  -h, --help            help for show
  -o, --output string   Modify output format (terminal,yaml,json). (default "terminal")

Global Flags:
  -c, --config string   Gpu Configurator configfile
  -d, --debug           Enable debug output.

An example of the output:

$> gpu-configurator show
Copyright (c) 2024 - Macaroni OS - gpu-configurator - 0.1.0
---------------------------------------------------------------------
Hostname:					nevyl
GPUs:						2
	- NVIDIA Corporation TU106M [GeForce RTX 2060 Mobile] [10de:1f15]
		kernel driver in use: nvidia
	- Advanced Micro Devices, Inc. [AMD/ATI] Picasso [1002:15d8]
		kernel driver in use: amdgpu

EGL External Platforms Configs Directories:
	- /usr/share/egl/egl_external_platform.d
		* 10_nvidia_wayland.json
		* 15_nvidia_gbm.json

Vulkan Layers Configs Directories:
	- /usr/share/vulkan/explicit_layer.d
		* VkLayer_khronos_validation.json
	- /usr/share/vulkan/implicit_layer.d
		* VkLayer_MESA_device_select.json
		* nvidia_layers.json

Vulkan ICD Configs Directories:
	- /usr/share/vulkan/icd.d
		* broadcom_icd.x86_64.json
		* intel_icd.x86_64.json
		* nvidia_icd.json
		* radeon_icd.x86_64.json
	- /etc/vulkan/icd.d
		* nvidia_icd.json

GBM Backend Librarires:
	- nvidia-drm_gbm.so (disabled)

NVIDIA Drivers:
	Active version: 535.86.05
	Available:
		- 535.86.05 (with kernel module)
NVIDIA Kernel Modules Available:
	* 535.86.05 - 6.1.80-macaroni
	* 535.86.05 - 6.6.18-macaroni
	* 550.54.14 - 6.7.9-zen1-macaroni

nvidia

The nvidia command contains sub-command for NVIDIA setup configuration.

nvidia gbmlib

This command permits to create the link of the GBM NVIDIA library or to disable it.

$> gpu-configurator nvidia gbmlib --help
GBM Backend Library configuration.

Usage:
   nvidia gbmlib [flags]

Flags:
      --disable-driver   Disable NVIDIA GBM library.
      --enable-driver    Enable NVIDIA GBM library.
  -h, --help             help for gbmlib

Global Flags:
  -c, --config string   Gpu Configurator configfile
  -d, --debug           Enable debug output.

vulkan

The vulkan command contains sub-command to manage Vulkan JSON files.

vulkan icd

This command permits to enable/disable a Vulkan ICD JSON file. The disable status is managed with the rename of the selected file to the same file but with the suffix .disabled.

$> gpu-configurator vulkan icd --help
Enable/Disable Vulcan ICD JSON configurations.

Usage:
   vulkan icd [options] icd.json [flags]

Flags:
      --disable-icd-file   Disable ICD JSON file.
      --enable-icd-file    Enable ICD JSON file.
  -h, --help               help for icd
      --purge              To use with --disable-icd-file to remove the ICD file.

Global Flags:
  -c, --config string   Gpu Configurator configfile
  -d, --debug           Enable debug output.

vulkan layers

This command permits to enable/disable a Vulkan Layers file. The disable status is managed with the rename of the selected file to the same file but with the suffix .disabled.

$> gpu-configurator vulkan layers --help
Enable/Disable Vulcan Layers JSON configurations.

Usage:
   vulkan layers [options] layers.json [flags]

Flags:
      --disable-layers-file   Disable Vulkan Layers JSON file.
      --enable-layers-file    Enable Vulkan Layers JSON file.
  -h, --help                  help for layers
      --purge                 To use with --disable-layers-file to remove the file.

Global Flags:
  -c, --config string   Gpu Configurator configfile
  -d, --debug           Enable debug output.

egl

This command permits to enable/disable a specific EGL JSON file. The disable status is managed with the rename of the selected file to the same file but with the suffix .disabled.

$> gpu-configurator egl --help
Enable/Disable EGL JSON configurations.

Usage:
   egl [options] eglloader.json [flags]

Flags:
      --disable-json-loader   Disable EGL JSON loader.
      --enable-json-loader    Enable EGL JSON loader.
  -h, --help                  help for egl
      --purge                 To use with --disable-json-loader to remove the JSON file.

Global Flags:
  -c, --config string   Gpu Configurator configfile
  -d, --debug           Enable debug output.

Documentation

Overview

Copyright © 2024 Macaroni OS Linux See AUTHORS and LICENSE for the license details and contributors.