amdgpu_fan 0.3.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8bd1ed519a47f577ba017c94f03ac02101767434796821120aef3f9e12d9ba9
-  data.tar.gz: 6d55c0d1c45d076d1409318332fade5d9038c8f4e64b86d8af2cb2d5eeb016df
+  metadata.gz: a499ce52639612b25843b04c3497c7c36f23f3a960d0946b7dc2e249e9a18874
+  data.tar.gz: fa87ca342988d97a91773b1272829a3b825b88dbd65420d6abd26fed8d97ac92
 SHA512:
-  metadata.gz: dba9441882e19a730fe7863ac49ac196d6ac6b6ed4f55a1f086d2467c122cb58b7e57fb3dc27d0bfbddcaba9344a89992b59fce9c1f52edb44feb54e9a718b97
-  data.tar.gz: 75b810c93258bbb39b2973f97e029cd602d70a61314da9e08af1a13fcaea5ec2ea7067e424aa0a3358d5a9b1863937cefa3a095897214f6ca8f0453757fd5250
+  metadata.gz: 06b3bd73191b39da57ac9c14e7ada8fa2cf1a069e8401f45af10eab6ede0bf79a5ebd2f80ba5c464e60f960e24d11783cf20d698c640a38e36c80846b305772e
+  data.tar.gz: 794e28fd6ae71a898b1e897a0fd612add4585e901ece8bc3928e62de9d8245107767848352fe7203d4aa5b6ec60c4e78b28523cc0c893d4d0bcb2f67fdd52044

data/README.md

@@ -1,10 +1,17 @@
-# amdgpu-fan-rb
+# amdgpu_fan
 
-[![Build Status](https://travis-ci.org/HarlemSquirrel/amdgpu-fan-rb.svg?branch=master)](https://travis-ci.org/HarlemSquirrel/amdgpu-fan-rb)
+[![Gem Version](https://badge.fury.io/rb/amdgpu_fan.svg)](https://badge.fury.io/rb/amdgpu_fan)
+[![Build Status](https://travis-ci.org/HarlemSquirrel/amdgpu-fan-rb.svg?branch=master)](https://travis-ci.org/HarlemSquirrel/amdgpu-fan-rb) [![Maintainability](https://api.codeclimate.com/v1/badges/27233cee17ef6a2c14fd/maintainability)](https://codeclimate.com/github/HarlemSquirrel/amdgpu-fan-rb/maintainability)
 
-A Ruby CLI to read and set the fan speed for AMD Radeon graphics cards running on the AMDGPU Linux driver.
+A Ruby CLI to read and set fan speed, power profiles, and more for AMD Radeon graphics cards running on the AMDGPU Linux driver.
 
-See https://wiki.archlinux.org/index.php/Fan_speed_control#AMDGPU_sysfs_fan_control
+**amdgpu_fan** aims to provide a more user friendly interface on top of [sysfs](https://en.wikipedia.org/wiki/Sysfs) for displaying statistics and interacting with AMD Radeon graphics hardware running on the [AMDgpu](https://dri.freedesktop.org/docs/drm/gpu/amdgpu.html) driver.
+
+#### Further reading
+
+- https://wiki.archlinux.org/index.php/AMDGPU#Overclocking
+- https://wiki.archlinux.org/index.php/Fan_speed_control#AMDGPU_sysfs_fan_control
+- https://phoronix.com/scan.php?page=news_item&px=AMDGPU-Quick-WattMan-Cap-Test
 
 ## Installation
 
@@ -28,27 +35,56 @@ gem install amdgpu_fan
 ## Usage
 
 ```
-➤  amdgpu_fan help
+➤  bin/amdgpu_fan help
 Commands:
-  amdgpu_fan auto             # Set mode to automatic (requires sudo)
-  amdgpu_fan help [COMMAND]   # Describe available commands or one specific command
-  amdgpu_fan set PERCENTAGE   # Set fan speed to PERCENTAGE (requires sudo)
-  amdgpu_fan status           # View device info, current fan speed, and temperature
-  amdgpu_fan watch [SECONDS]  # Watch current fan speed, and temperature refreshed every n seconds
-
-➤  amdgpu_fan status
-📺	GPU:   AMD Radeon (TM) R9 Fury Series
-📄	vBIOS: 113-C8800100-102
-🌀	Fan:   auto mode running at 48% ~ 1828 rpm
-🌡	Temp:  28.0°C
-⚡	Power: 19.26 / 300.0 Watts
+  amdgpu_fan connectors                 # View the status of the display connectors.
+  amdgpu_fan fan                        # View fan details.
+  amdgpu_fan fan_set PERCENTAGE/AUTO    # Set fan speed to percentage or automatic mode. (requires sudo)
+  amdgpu_fan help [COMMAND]             # Describe available commands or one specific command
+  amdgpu_fan profile                    # View power profile details.
+  amdgpu_fan profile_auto               # Set the power profile to automatic mode.
+  amdgpu_fan profile_force PROFILE_NUM  # Manually set a power profile. (requires sudo)
+  amdgpu_fan status [--logo]            # View device info, current fan speed, and temperature.
+  amdgpu_fan watch [SECONDS]            # Watch fan speed, load, power, and temperature refreshed every n seconds.
+  amdgpu_fan watch_csv [SECONDS]        # Watch stats in CSV format refreshed every n seconds defaulting to 1 second.
+
+➤  bin/amdgpu_fan status
+📺 GPU:    Advanced Micro Devices, Inc. [AMD/ATI] Radeon R9 FURY X / NANO
+📄 vBIOS:  113-C8800100-102
+⏰ Clocks: 724Mhz Core, 500Mhz Memory
+💾 Memory: 4096 MiB
+🌀 Fan:    auto mode running at 1809 rpm (48%)
+🌞 Temp:   21.0°C
+⚡ Power:  3D_FULL_SCREEN profile in performance mode using 16.2 / 300.0 Watts (5%)
+⚖  Load:   [                    ]0%
 
 ➤  bin/amdgpu_fan watch 3
 Watching Advanced Micro Devices, Inc. [AMD/ATI] Radeon R9 FURY X / NANO every 3 second(s)...
   <Press Ctrl-C to exit>
-2019-05-10 20:36:01 - Clock: 512Mhz Core, 500Mhz Memory,        Fan: 1838 rpm [|||       ]27%,  Load: [|||       ]28%,  Power: 15.12 W, Temp: 28.0°C
-2019-05-10 20:36:05 - Clock: 300Mhz Core, 500Mhz Memory,        Fan: 1837 rpm [|||||     ]49%,  Load: [          ]0%,   Power: 16.18 W, Temp: 29.0°C
-2019-05-10 20:36:09 - Clock: 512Mhz Core, 500Mhz Memory,        Fan: 1837 rpm [|||||     ]49%,  Load: [          ]0%,   Power: 15.11 W, Temp: 28.0°C
+2019-05-28 20:57:41 | Core: 724Mhz   | Memory: 500Mhz  | Fan: 948 rpm  [*         ]14%  | Load: [**        ]24%  | Power: 16.07 W  [*         ]6%   | Temp: 34.0°C
+2019-05-28 20:57:45 | Core: 512Mhz   | Memory: 500Mhz  | Fan: 948 rpm  [*         ]14%  | Load: [          ]0%   | Power: 16.13 W  [*         ]7%   | Temp: 34.0°C
+2019-05-28 20:57:49 | Core: 892Mhz   | Memory: 500Mhz  | Fan: 948 rpm  [*         ]14%  | Load: [          ]0%   | Power: 25.22 W  [*         ]5%   | Temp: 33.0°C
+2019-05-28 20:57:53 | Core: 300Mhz   | Memory: 500Mhz  | Fan: 948 rpm  [*         ]14%  | Load: [          ]0%   | Power: 19.1 W   [*         ]6%   | Temp: 33.0°C
+2019-05-28 20:57:57 | Core: 1050Mhz  | Memory: 500Mhz  | Fan: 948 rpm  [*         ]14%  | Load: [********* ]94%  | Power: 103.04 W [***       ]31%  | Temp: 36.0°C
+2019-05-28 20:58:01 | Core: 1050Mhz  | Memory: 500Mhz  | Fan: 954 rpm  [**        ]15%  | Load: [********* ]91%  | Power: 158.07 W [*****     ]53%  | Temp: 38.0°C
+2019-05-28 20:58:05 | Core: 1050Mhz  | Memory: 500Mhz  | Fan: 977 rpm  [**        ]16%  | Load: [**********]100% | Power: 218.01 W [*******   ]73%  | Temp: 40.0°C
+2019-05-28 20:58:09 | Core: 1050Mhz  | Memory: 500Mhz  | Fan: 1005 rpm [**        ]16%  | Load: [**********]100% | Power: 216.24 W [*******   ]71%  | Temp: 40.0°C
+2019-05-28 20:58:13 | Core: 1050Mhz  | Memory: 500Mhz  | Fan: 1033 rpm [**        ]17%  | Load: [**********]97%  | Power: 109.25 W [****      ]39%  | Temp: 38.0°C
+2019-05-28 20:58:17 | Core: 724Mhz   | Memory: 500Mhz  | Fan: 1058 rpm [**        ]17%  | Load: [          ]0%   | Power: 17.17 W  [*         ]6%   | Temp: 35.0°C
+^C
+And now the watch is ended.
+```
+
+```
+➤  bin/amdgpu_fan watch_avg
+Watching Sapphire Technology Limited Vega 10 XL/XT [Radeon RX Vega 56/64] min, max and averges since
+2020-06-02 23:05:20 -0400...
+  <Press Ctrl-C to exit>
+⏰ Core clock  min:    852 MHz avg:  887.0 MHz max:   1200 MHz now:    852 MHz
+💾 Memory clk  min:    167 MHz avg:  227.1 MHz max:    945 MHz now:    167 MHz
+🌀 Fan speed   min:   1231 RPM avg: 1231.0 RPM max:   1231 RPM now:   1231 RPM
+⚡ Power usage min:    6.0 W   avg:   21.8 W   max:  141.0 W   now:    6.0 W
+🌡  Temperature min:     30 °C  avg:   31.3 °C  max:     35 °C  now:     32 °C
 ^C
 And now the watch is ended.
 ```
@@ -57,4 +93,12 @@ And now the watch is ended.
 
 - [Ruby](https://www.ruby-lang.org) with [Bundler](https://bundler.io)
 - [Thor](http://whatisthor.com/) (installed with `bundle install`)
-- [`lspci`](https://linux.die.net/man/8/lspci) (included with most Linux distributions)
+- Internet connection - Device info is retrieved from https://pci-ids.ucw.cz/
+
+## Building a binary
+
+[Ruby Packer](https://github.com/pmq20/ruby-packer) provides a convenient way to compile this into a single executable. For the best results, compile Ruby Packer from source from the lastest master branch.
+
+```sh
+rubyc amdgpu_fan --output amdgpu_fan
+```

data/bin/amdgpu_fan

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/amdgpu_fan_cli'
+require_relative '../lib/amdgpu_fan'
 
-AmdgpuFanCli.start ARGV
+AmdgpuFan::Cli.start ARGV

data/config/environment.rb

@@ -1,3 +1,15 @@
+# frozen_string_literal: true
+
 require 'thor'
 
-require_relative '../lib/amdgpu_service'
+require_relative '../lib/amdgpu_fan'
+require_relative '../lib/amdgpu_fan/version'
+
+require_relative '../lib/amdgpu_fan/mixin/cli_output_format'
+require_relative '../lib/amdgpu_fan/mixin/sys_write'
+
+require_relative '../lib/amdgpu_fan/service'
+require_relative '../lib/amdgpu_fan/cli'
+require_relative '../lib/amdgpu_fan/pci'
+require_relative '../lib/amdgpu_fan/stat_set'
+require_relative '../lib/amdgpu_fan/watcher'

data/config/icons.yml

@@ -0,0 +1,10 @@
+---
+clock: ⏰
+display: 📺
+fan: 🌀
+gpu: 👾
+load: "⚖ "
+memory: 💾
+power: ⚡
+temp: "🌡 "
+vbios: 📄

data/lib/amdgpu_fan.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative '../config/environment'
+
+# The main module
+module AmdgpuFan
+end

data/lib/amdgpu_fan/cli.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module AmdgpuFan
+  # The command-line interface class
+  class Cli < Thor
+    include CliOutputFormat
+
+    ICONS = YAML.safe_load(File.read(File.join(__dir__, '../../config/icons.yml')))
+                .transform_keys(&:to_sym).freeze
+    WATCH_FIELD_SEPARATOR = ' | '
+
+    desc 'connectors', 'View the status of the display connectors.'
+    def connectors
+      amdgpu_service.connectors.each do |connector|
+        puts "#{connector.type} #{connector.index}:\t" +
+             (connector.connected? ? connector.display_name : connector.status)
+      end
+    end
+
+    desc 'profile', 'View power profile details.'
+    def profile
+      puts amdgpu_service.profile_summary
+    end
+
+    desc 'profile_auto', 'Set the power profile to automatic mode.'
+    def profile_auto
+      amdgpu_service.profile_auto
+      puts amdgpu_service.profile_summary
+    end
+
+    desc 'profile_force PROFILE_NUM', 'Manually set a power profile. (requires sudo)'
+    def profile_force(state)
+      amdgpu_service.profile_force = state
+      puts amdgpu_service.profile_summary
+    end
+
+    desc 'fan', 'View fan details.'
+    def fan
+      puts fan_status
+    end
+
+    desc 'fan_set PERCENTAGE/AUTO', 'Set fan speed to percentage or automatic mode. (requires sudo)'
+    def fan_set(value)
+      if value.strip.casecmp('auto').zero?
+        amdgpu_service.fan_mode = :auto
+      else
+        return puts 'Invalid percentage' unless (0..100).cover?(value.to_i)
+
+        amdgpu_service.fan_speed = value
+      end
+      puts fan_status
+    end
+
+    desc 'status [--logo]', 'View device info, current fan speed, and temperature.'
+    def status(option = nil)
+      puts radeon_logo if option == '--logo'
+      puts ICONS[:gpu] + ' GPU:'.ljust(9) + amdgpu_service.name,
+           ICONS[:vbios] + ' vBIOS:'.ljust(9) + amdgpu_service.vbios_version,
+           ICONS[:display] + ' Displays:' + amdgpu_service.display_names.join(', '),
+           ICONS[:clock] + ' Clocks:'.ljust(9) + clock_status,
+           ICONS[:memory] + ' Memory:'.ljust(9) + mem_total_mibibyes,
+           ICONS[:fan] + ' Fan:'.ljust(9) + fan_status,
+           ICONS[:temp] + ' Temp:'.ljust(9) + "#{amdgpu_service.temperature}°C",
+           ICONS[:power] + ' Power:'.ljust(9) + "#{amdgpu_service.profile_mode} profile in " \
+            "#{amdgpu_service.power_dpm_state} mode using " \
+            "#{amdgpu_service.power_draw} / #{amdgpu_service.power_max} Watts "\
+            "(#{amdgpu_service.power_draw_percent}%)",
+           ICONS[:load] + ' Load:'.ljust(9) + percent_meter(amdgpu_service.busy_percent, 20)
+    end
+
+    desc 'version', 'Print the application version.'
+    def version
+      puts AmdgpuFan::VERSION
+    end
+
+    desc 'watch [SECONDS]', 'Watch fan speed, load, power, and temperature ' \
+         'refreshed every n seconds.'
+    def watch(seconds = 1)
+      return puts 'Seconds must be from 1 to 600' unless (1..600).cover?(seconds.to_i)
+
+      puts "Watching #{amdgpu_service.name} every #{seconds} second(s)...",
+           '  <Press Ctrl-C to exit>'
+
+      trap 'SIGINT' do
+        puts "\nAnd now the watch is ended."
+        exit 0
+      end
+
+      loop do
+        time = Time.now
+        puts [time.strftime('%F %T'), summary_clock, summary_fan, summary_load, summary_power,
+              summary_temp].join(WATCH_FIELD_SEPARATOR)
+
+        # It can take a second or two to run the above so we remove them from the wait
+        # here to get a more consistant watch interval.
+        sec_left_to_wait = time.to_i + seconds.to_i - Time.now.to_i
+        sleep sec_left_to_wait if sec_left_to_wait.positive?
+      end
+    end
+
+    desc 'watch_avg',
+         <<~DOC
+           Watch min, max, average, and current stats.
+         DOC
+    def watch_avg
+      puts "Watching #{amdgpu_service.name} min, max and averges since #{Time.now}...",
+           '  <Press Ctrl-C to exit>',
+           "\n\n\n\n\n"
+
+      trap 'SIGINT' do
+        puts "\nAnd now the watch is ended."
+        exit 0
+      end
+
+      watcher = Watcher.new amdgpu_service
+
+      loop do
+        watcher.measure
+        5.times { print "\033[K\033[A" } # move up a line and clear to end of line
+
+        puts ICONS[:clock] +  ' Core clock  ' + watcher.core_clock.to_s,
+             ICONS[:memory] + ' Memory clk  ' + watcher.mem_clock.to_s,
+             ICONS[:fan] +    ' Fan speed   ' + watcher.fan_speed.to_s,
+             ICONS[:power] +  ' Power usage ' + watcher.power.to_s,
+             ICONS[:temp] +   ' Temperature ' + watcher.temp.to_s
+        sleep 1
+      end
+    end
+
+    desc 'watch_csv [SECONDS]', 'Watch stats in CSV format ' \
+         'refreshed every n seconds defaulting to 1 second.'
+    def watch_csv(seconds = 1)
+      return puts 'Seconds must be from 1 to 600' unless (1..600).cover?(seconds.to_i)
+
+      puts 'Timestamp, Core Clock (Mhz),Memory Clock (Mhz),Fan speed (rpm), '\
+           'Load (%),Power (Watts),Temp (°C)'
+
+      trap 'SIGINT' do
+        exit 0
+      end
+
+      loop do
+        puts [Time.now.strftime('%F %T'),
+              amdgpu_service.core_clock,
+              amdgpu_service.memory_clock,
+              amdgpu_service.fan_speed_rpm,
+              amdgpu_service.busy_percent,
+              amdgpu_service.power_draw,
+              amdgpu_service.temperature].join(',')
+        sleep seconds.to_i
+      end
+    end
+
+    private
+
+    def amdgpu_service
+      @amdgpu_service ||= AmdgpuFan::Service.new
+    end
+
+    def clock_status
+      "#{amdgpu_service.core_clock} Core, #{amdgpu_service.memory_clock} Memory"
+    end
+
+    def fan_status
+      "#{amdgpu_service.fan_mode} mode running at " \
+       "#{amdgpu_service.fan_speed_rpm} rpm (#{amdgpu_service.fan_speed_percent}%)"
+    end
+
+    def mem_total_mibibyes
+      "#{amdgpu_service.memory_total / (2**20)} MiB"
+    end
+
+    def power_max
+      format('%<num>0.2f', num: amdgpu_service.power_max)
+    end
+
+    def summary_clock
+      "Core: #{amdgpu_service.core_clock.rjust(7)}#{WATCH_FIELD_SEPARATOR}"\
+        "Memory: #{amdgpu_service.memory_clock.rjust(7)}"
+    end
+
+    def summary_fan
+      fan_speed_string = "#{amdgpu_service.fan_speed_rpm} rpm".rjust(8)
+      "Fan: #{fan_speed_string} #{percent_meter(amdgpu_service.fan_speed_percent)}"
+    end
+
+    def summary_load
+      "Load: #{percent_meter amdgpu_service.busy_percent}"
+    end
+
+    def summary_power
+      "Power: #{format('%<num>0.02f', num: amdgpu_service.power_draw).rjust(power_max.length)} W" \
+        " #{percent_meter amdgpu_service.power_draw_percent}"
+    end
+
+    def summary_temp
+      temp_string = "#{amdgpu_service.temperature}°C".rjust(7)
+      "Temp: #{temp_string}"
+    end
+  end
+end

data/lib/amdgpu_fan/connector.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module AmdgpuFan
+  ## Connector
+  #
+  # A model class for a GPU connector
+  class Connector
+    EDID_DESCRIPTORS_CONF = {
+      display_name_leading_bytes: String.new('\x00\xFC\x00', encoding: 'ascii-8bit'),
+      unspecified_text_leading_bytes: String.new('\x00\xFE\x00', encoding: 'ascii-8bit'),
+      index_range: (54..125)
+    }.freeze
+
+    attr_reader :card_num, :dir_path, :index, :type
+
+    class << self
+      ##
+      # Return an array of connector objects for the provided card number.
+      # The files are sorted to improve how they are displayed to the user.
+      def where(card_num:)
+        Dir["/sys/class/drm/card#{card_num}/card#{card_num}-*"].sort.map do |dir_path|
+          Connector.new card_num: card_num,
+                        dir_path: dir_path,
+                        index: dir_path[-1],
+                        type: dir_path.slice(/(?<=card#{card_num}-)[A-z]+/)
+        end
+      end
+    end
+
+    def initialize(card_num:, dir_path:, index:, type:)
+      @card_num = card_num
+      @dir_path = dir_path
+      @index = index
+      @type = type
+    end
+
+    def connected?
+      status.casecmp('connected').zero?
+    end
+
+    def display_name
+      return if edid.to_s.empty?
+
+      (display_name_text + unspecified_text).join(' ').strip
+    end
+
+    def status
+      File.read(File.join(dir_path, 'status')).strip
+    end
+
+    private
+
+    def display_descriptors_raw
+      edid.slice EDID_DESCRIPTORS_CONF[:index_range]
+    end
+
+    def display_name_text
+      display_descriptors_raw
+        .scan(/(?<=#{EDID_DESCRIPTORS_CONF[:display_name_leading_bytes]}).{1,13}/)
+    end
+
+    def edid
+      File.read("#{dir_path}/edid", encoding: 'ascii-8bit')
+    end
+
+    def unspecified_text
+      display_descriptors_raw
+        .scan(/(?<=#{EDID_DESCRIPTORS_CONF[:unspecified_text_leading_bytes]}).{1,13}/)
+    end
+  end
+end

data/lib/amdgpu_fan/mixin/cli_output_format.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module AmdgpuFan
+  # A mixin to help with CLI output formatting
+  module CliOutputFormat
+    METER_CHAR = '*'
+    TIME_FORMAT = '%F %T'
+
+    private
+
+    def current_time
+      Time.now.strftime(TIME_FORMAT)
+    end
+
+    def percent_meter(percent, length = 10)
+      progress_bar_count = (length * percent.to_f / 100).round
+      percent_string = "#{format '%<num>0.2i', num: percent}%".ljust(3)
+      "[#{METER_CHAR * progress_bar_count}#{' ' * (length - progress_bar_count)}]#{percent_string}"
+    end
+
+    def radeon_logo
+      File.read(File.join(__dir__, '../../../assets/radeon_r_black_red_100x100.ascii'))
+    end
+  end
+end