amd-debug-tools 0.2.5__py3-none-any.whl → 0.2.12__py3-none-any.whl

amd_debug/__init__.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 
@@ -23,8 +22,15 @@ def amd_pstate():
     return pstate.main()
 
 
+def amd_ttm():
+    """Launch the amd-ttm tool."""
+    from . import ttm  # pylint: disable=import-outside-toplevel
+
+    return ttm.main()
+
+
 def install_dep_superset():
-    """Install all supserset dependencies."""
+    """Install all superset dependencies."""
     from . import installer  # pylint: disable=import-outside-toplevel
 
     return installer.install_dep_superset()
@@ -36,6 +42,7 @@ def launch_tool(tool_name):
         "amd_s2idle.py": amd_s2idle,
         "amd_bios.py": amd_bios,
         "amd_pstate.py": amd_pstate,
+        "amd_ttm.py": amd_ttm,
         "install_deps.py": install_dep_superset,
     }
     if tool_name in tools:

amd_debug/acpi.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 import os

amd_debug/battery.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 from pyudev import Context
 

amd_debug/bios.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 """s2idle analysis tool"""
 import argparse
@@ -105,7 +104,9 @@ def parse_args():
         action="store_true",
         help="Enable tool debug logging",
     )
-    subparsers.add_parser("version", help="Show version information")
+    parser.add_argument(
+        "--version", action="store_true", help="Show version information"
+    )
 
     if len(sys.argv) == 1:
         parser.print_help(sys.stderr)
@@ -122,7 +123,7 @@ def parse_args():
     return args
 
 
-def main() -> None|int:
+def main() -> None | int:
     """Main function"""
     args = parse_args()
     ret = False
@@ -132,7 +133,7 @@ def main() -> None|int:
     elif args.command == "parse":
         app = AmdBios(args.input, args.tool_debug)
         ret = app.run()
-    elif args.command == "version":
+    elif args.version:
         print(version())
     show_log_info()
     if ret is False:

amd_debug/common.py

@@ -1,10 +1,10 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 """
 This module contains common utility functions and classes for various amd-debug-tools.
 """
 
+import asyncio
 import importlib.metadata
 import logging
 import os
@@ -12,7 +12,6 @@ import platform
 import time
 import struct
 import subprocess
-import re
 import sys
 from ast import literal_eval
 from datetime import date, timedelta
@@ -47,7 +46,7 @@ def get_group_color(group) -> str:
         color = Colors.WARNING
     elif group == "🗣️":
         color = Colors.HEADER
-    elif group == "💯":
+    elif any(mk in group for mk in ["💯", "🚫"]):
         color = Colors.UNDERLINE
     elif any(mk in group for mk in ["🦟", "🖴"]):
         color = Colors.DEBUG
@@ -226,6 +225,74 @@ def get_pretty_distro() -> str:
     return distro
 
 
+def bytes_to_gb(bytes_value):
+    """Convert bytes to GB"""
+    return bytes_value * 4096 / (1024 * 1024 * 1024)
+
+
+def gb_to_pages(gb_value):
+    """Convert GB into bytes"""
+    return int(gb_value * (1024 * 1024 * 1024) / 4096)
+
+
+def reboot():
+    """Reboot the system"""
+
+    async def reboot_dbus_fast():
+        """Reboot using dbus-fast"""
+        try:
+            from dbus_fast.aio import (  # pylint: disable=import-outside-toplevel
+                MessageBus,
+            )
+            from dbus_fast import BusType  # pylint: disable=import-outside-toplevel
+
+            bus = await MessageBus(bus_type=BusType.SYSTEM).connect()
+            introspection = await bus.introspect(
+                "org.freedesktop.login1", "/org/freedesktop/login1"
+            )
+            proxy_obj = bus.get_proxy_object(
+                "org.freedesktop.login1", "/org/freedesktop/login1", introspection
+            )
+            interface = proxy_obj.get_interface("org.freedesktop.login1.Manager")
+            await interface.call_reboot(True)
+
+        except ImportError:
+            return False
+        return True
+
+    def reboot_dbus():
+        """Reboot using python-dbus"""
+        try:
+            import dbus  # pylint: disable=import-outside-toplevel
+
+            bus = dbus.SystemBus()
+            obj = bus.get_object("org.freedesktop.login1", "/org/freedesktop/login1")
+            intf = dbus.Interface(obj, "org.freedesktop.login1.Manager")
+            intf.Reboot(True)
+        except ImportError:
+            return False
+        return True
+
+    loop = asyncio.get_event_loop()
+    result = loop.run_until_complete(reboot_dbus_fast())
+    if not result:
+        return reboot_dbus()
+
+    return True
+
+
+def get_system_mem():
+    """Get the total system memory in GB using /proc/meminfo"""
+    with open(os.path.join("/", "proc", "meminfo"), "r", encoding="utf-8") as f:
+        for line in f:
+            if line.startswith("MemTotal:"):
+                # MemTotal line format: "MemTotal:       16384516 kB"
+                # Extract the number and convert from kB to GB
+                mem_kb = int(line.split()[1])
+                return mem_kb / (1024 * 1024)
+    raise ValueError("Could not find MemTotal in /proc/meminfo")
+
+
 def is_root() -> bool:
     """Check if the user is root"""
     return os.geteuid() == 0

amd_debug/database.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 from datetime import datetime
@@ -99,8 +98,8 @@ class SleepDatabase:
 
     def start_cycle(self, timestamp):
         """Start a new sleep cycle"""
+        assert self.db
         self.last_suspend = timestamp
-
         # increment the counters so that systemd hooks work
         cur = self.db.cursor()
         cur.execute(
@@ -124,11 +123,13 @@ class SleepDatabase:
 
     def sync(self) -> None:
         """Sync the database to disk"""
+        assert self.db
         self.db.commit()
 
     def record_debug(self, message, level=6) -> None:
         """Helper function to record a message to debug database"""
         assert self.last_suspend
+        assert self.db
         cur = self.db.cursor()
         cur.execute(
             "INSERT into debug (t0, id, message, priority) VALUES (?, ?, ?, ?)",
@@ -151,6 +152,8 @@ class SleepDatabase:
 
     def record_battery_energy(self, name, energy, full, unit):
         """Helper function to record battery energy"""
+        assert self.db
+        assert self.last_suspend
         cur = self.db.cursor()
         cur.execute(
             "SELECT * FROM battery WHERE t0=?",
@@ -180,6 +183,7 @@ class SleepDatabase:
     def record_cycle_data(self, message, symbol) -> None:
         """Helper function to record a message to cycle_data database"""
         assert self.last_suspend
+        assert self.db
         cur = self.db.cursor()
         cur.execute(
             """
@@ -207,6 +211,7 @@ class SleepDatabase:
     ) -> None:
         """Helper function to record a sleep cycle into the cycle database"""
         assert self.last_suspend
+        assert self.db
         cur = self.db.cursor()
         cur.execute(
             """
@@ -227,6 +232,7 @@ class SleepDatabase:
     def record_prereq(self, message, symbol) -> None:
         """Helper function to record a message to prereq_data database"""
         assert self.last_suspend
+        assert self.db
         cur = self.db.cursor()
         cur.execute(
             """
@@ -246,6 +252,7 @@ class SleepDatabase:
 
     def report_prereq(self, t0) -> list:
         """Helper function to report the prereq_data database"""
+        assert self.db
         if t0 is None:
             return []
         cur = self.db.cursor()
@@ -255,10 +262,11 @@ class SleepDatabase:
         )
         return cur.fetchall()
 
-    def report_debug(self, t0) -> str:
+    def report_debug(self, t0) -> list:
         """Helper function to report the debug database"""
+        assert self.db
         if t0 is None:
-            return ""
+            return []
         cur = self.db.cursor()
         cur.execute(
             "SELECT message, priority FROM debug WHERE t0=?",
@@ -268,6 +276,7 @@ class SleepDatabase:
 
     def report_cycle(self, t0=None) -> list:
         """Helper function to report a cycle from database"""
+        assert self.db
         if t0 is None:
             assert self.last_suspend
             t0 = self.last_suspend
@@ -280,7 +289,9 @@ class SleepDatabase:
 
     def report_cycle_data(self, t0=None) -> str:
         """Helper function to report a table matching a timestamp from cycle_data database"""
+        assert self.db
         if t0 is None:
+            assert self.last_suspend
             t0 = self.last_suspend
         cur = self.db.cursor()
         cur.execute(
@@ -294,7 +305,9 @@ class SleepDatabase:
 
     def report_battery(self, t0=None) -> list:
         """Helper function to report a line from battery database"""
+        assert self.db
         if t0 is None:
+            assert self.last_suspend
             t0 = self.last_suspend
         cur = self.db.cursor()
         cur.execute(
@@ -305,19 +318,23 @@ class SleepDatabase:
 
     def get_last_prereq_ts(self) -> int:
         """Helper function to report the last line from prereq database"""
+        assert self.db
         cur = self.db.cursor()
         cur.execute("SELECT * FROM prereq_data ORDER BY t0 DESC LIMIT 1")
         result = cur.fetchone()
-        return result[0] if result else None
+        return result[0] if result else 0
 
     def get_last_cycle(self) -> list:
         """Helper function to report the last line from battery database"""
+        assert self.db
         cur = self.db.cursor()
         cur.execute("SELECT t0 FROM cycle ORDER BY t0 DESC LIMIT 1")
         return cur.fetchone()
 
     def report_summary_dataframe(self, since, until) -> object:
         """Helper function to report a dataframe from the database"""
+        assert self.db
+
         import pandas as pd  # pylint: disable=import-outside-toplevel
 
         pd.set_option("display.precision", 2)

amd_debug/display.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 # SPDX-License-Identifier: MIT
 """Display analysis"""
 import os
@@ -12,7 +11,7 @@ class Display:
 
     def __init__(self):
         self.pyudev = Context()
-        self.edid = {}
+        self.edid = []
 
         for dev in self.pyudev.list_devices(subsystem="drm"):
             if not "card" in dev.device_path:
@@ -27,7 +26,7 @@ class Display:
             f = read_file(p)
             if f != "enabled":
                 continue
-            self.edid[dev.sys_name] = os.path.join(dev.sys_path, "edid")
+            self.edid.append(os.path.join(dev.sys_path, "edid"))
 
     def get_edid(self) -> list:
         """Get the path for EDID data for all connected displays"""

amd_debug/failures.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 from datetime import timedelta
@@ -48,6 +47,19 @@ class RtcAlarmWrong(S0i3Failure):
         self.url = "https://github.com/systemd/systemd/issues/24279"
 
 
+class MissingGpu(S0i3Failure):
+    """GPU device is missing"""
+
+    def __init__(self):
+        super().__init__()
+        self.description = "GPU device is missing"
+        self.explanation = (
+            "Running the s2idle sequence without an integrated GPU is likely "
+            "to cause problems. If you have a mux in BIOS, enable the integrated "
+            "GPU."
+        )
+
+
 class MissingAmdgpu(S0i3Failure):
     """AMDGPU driver is missing"""
 
@@ -467,7 +479,7 @@ class MissingIommuACPI(S0i3Failure):
         super().__init__()
         self.description = f"Device {device} missing from ACPI tables"
         self.explanation = (
-            "The ACPI device {device} is required for suspend to work when the IOMMU is enabled. "
+            f"The ACPI device {device} is required for suspend to work when the IOMMU is enabled. "
             "Please check your BIOS settings and if configured correctly, report a bug to your system vendor."
         )
         self.url = "https://gitlab.freedesktop.org/drm/amd/-/issues/3738#note_2667140"
@@ -598,3 +610,32 @@ class DmcubTooOld(S0i3Failure):
             f"The DMCUB microcode version {hex(current)} is older than the"
             f"minimum suggested version {hex(expected)}."
         )
+
+
+class MissingIsp4PlatformDriver(S0i3Failure):
+    """ISP4 platform driver is missing"""
+
+    def __init__(self):
+        super().__init__()
+        self.description = "ISP4 platform driver is missing"
+        self.explanation = (
+            "The ISP4 platform driver is required for the camera interface included "
+            "with the SOC to enter the proper power states. "
+            "Be sure that you have enabled CONFIG_AMD_ISP_PLATFORM in your kernel."
+        )
+
+
+class MissingAmdCaptureModule(S0i3Failure):
+    """AMD Capture module is missing"""
+
+    def __init__(self):
+        super().__init__()
+        self.description = "AMD Capture module is missing"
+        self.explanation = (
+            "The amd_capture module is required for the camera interface included "
+            "with the SOC to enter the proper power states. "
+            "Be sure that the amd_capture module is loaded."
+            ""
+            "If the module is not available, disable the camera in the BIOS to prevent issues."
+        )
+        self.url = "https://gitlab.freedesktop.org/drm/amd/-/issues/4869"

amd_debug/installer.py

@@ -1,4 +1,3 @@
-#!/usr/bin/python3
 # SPDX-License-Identifier: MIT
 
 """
@@ -65,7 +64,7 @@ class DistroPackage:
             for line in release.split("\n"):
                 if line.startswith("VARIANT_ID"):
                     variant = line.split("=")[-1]
-            if variant != "workstation":
+            if variant not in ("workstation", "kde"):
                 return False
             installer = ["dnf", "install", "-y", self.rpm]
         elif dist == "arch" or os.path.exists("/etc/arch-release"):
@@ -197,7 +196,7 @@ class DisplayInfoPackage(DistroPackage):
     def __init__(self):
         super().__init__(
             deb="libdisplay-info-bin",
-            rpm="libdisplay-info",
+            rpm="libdisplay-info-tools",
             arch="libdisplay-info",
             message=Headers.MissingDiEdidDecode,
         )
@@ -446,8 +445,8 @@ def parse_args():
     return parser.parse_args()
 
 
-def install_dep_superset() -> None|int:
-    """Install all python supserset dependencies"""
+def install_dep_superset() -> None | int:
+    """Install all python superset dependencies"""
     args = parse_args()
     tool = Installer(tool_debug=args.tool_debug)
     tool.set_requirements(

amd_debug/kernel.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 # SPDX-License-Identifier: MIT
 """Kernel log analysis"""
 
@@ -158,7 +157,7 @@ class KernelLogger:
     def seek_tail(self, tim=None):
         """Seek to the end of the log"""
 
-    def process_callback(self, callback, priority):
+    def process_callback(self, callback, priority=None):
         """Process the log"""
 
     def match_line(self, _matches) -> str:
@@ -175,7 +174,7 @@ class InputFile(KernelLogger):
 
     def __init__(self, fname):
         self.since_support = False
-        self.buffer = None
+        self.buffer = ""
         self.seeked = False
         self.buffer = read_file(fname)
 
@@ -190,7 +189,7 @@ class DmesgLogger(KernelLogger):
 
     def __init__(self):
         self.since_support = False
-        self.buffer = None
+        self.buffer = ""
         self.seeked = False
 
         cmd = ["dmesg", "-h"]
@@ -204,7 +203,7 @@ class DmesgLogger(KernelLogger):
         self._refresh_head()
 
     def _refresh_head(self):
-        self.buffer = []
+        self.buffer = ""
         self.seeked = False
         result = subprocess.run(self.command, check=True, capture_output=True)
         if result.returncode == 0:
@@ -262,7 +261,11 @@ class CySystemdLogger(KernelLogger):
     """Class for logging using systemd journal using cython"""
 
     def __init__(self):
-        from cysystemd.reader import JournalReader, JournalOpenMode, Rule
+        from cysystemd.reader import (
+            JournalReader,
+            JournalOpenMode,
+            Rule,
+        )  # pylint: disable=import-outside-toplevel
 
         boot_reader = JournalReader()
         boot_reader.open(JournalOpenMode.SYSTEM)
@@ -384,6 +387,6 @@ def get_kernel_log(input_file=None) -> KernelLogger:
             kernel_log = DmesgLogger()
         except subprocess.CalledProcessError as e:
             fatal_error(f"{e}")
-            kernel_log = None
+            kernel_log = KernelLogger()
     logging.debug("Kernel log provider: %s", kernel_log.__class__.__name__)
     return kernel_log