| # Helpful tools for debugging AMD and Intel s2idle systems | |
| [](https://codecov.io/github/amd/amd-linux-debug-tools) | |
| [](https://pypi.org/project/amd-debug-tools/) | |
| This repository hosts open tools that are useful for debugging issues on | |
| systems which use the s2idle (Low Power S0 Idle) suspend state. | |
| Both AMD and Intel platforms are supported. The prerequisites that are | |
| checked are selected based on the CPU vendor, and the NVIDIA proprietary | |
| driver is supported on both. See | |
| [platform support](docs/platform-support.md) for the details. | |
| ## Installation | |
| ### Distro (Arch) | |
| `amd-debug-tools` has been [packaged for Arch Linux](https://archlinux.org/packages/extra/any/amd-debug-tools/) (and derivatives). You can install it using: | |
| pacman -Sy amd-debug-tools | |
| ### Using a python wheel (Generic) | |
| It is suggested to install tools in a virtual environment either using | |
| `pipx` or `python3 -m venv`. | |
| #### From PyPI | |
| `amd-debug-tools` is distributed as a python wheel, which is a | |
| binary package format for Python. To install from PyPI, run the following | |
| command: | |
| pipx install amd-debug-tools | |
| ### From source | |
| To build the package from source, you will need to the `python3-build` | |
| package natively installed by your distribution package manager. Then you | |
| can generate and install a wheel by running the following commands: | |
| python3 -m build | |
| pipx install dist/amd-debug-tools-*.whl | |
| ### Ensuring path | |
| If you have not used a `pipx` environment before, you may need to run the following command | |
| to set up the environment: | |
| pipx ensurepath | |
| This will add the `pipx` environment to your path. | |
| ## Running in-tree | |
| Documentation about running directly from a git checkout is available [here](https://github.com/amd/amd-linux-debug-tools/blob/master/docs/in-tree.md). | |
| ## Tools | |
| Each tool has its own individual documentation page: | |
| * [amd-s2idle](https://github.com/amd/amd-linux-debug-tools/blob/master/docs/amd-s2idle.md) | |
| * [amd-bios](https://github.com/amd/amd-linux-debug-tools/blob/master/docs/amd-bios.md) | |
| * [amd-pstate](https://github.com/amd/amd-linux-debug-tools/blob/master/docs/amd-pstate.md) | |
| * [amd-ttm](https://github.com/amd/amd-linux-debug-tools/blob/master/docs/amd-ttm.md) | |
| ## Platform support | |
| The s2idle tool supports AMD and Intel platforms, including systems using the | |
| NVIDIA proprietary driver. See | |
| [platform support](https://github.com/amd/amd-linux-debug-tools/blob/master/docs/platform-support.md) | |
| for the details of what is checked on each platform. | |