[AMD-SMI] Fix incorrect unit in amdsmi_frequencies_t documentation#6625
Open
marifamd wants to merge 1 commit into
Open
[AMD-SMI] Fix incorrect unit in amdsmi_frequencies_t documentation#6625marifamd wants to merge 1 commit into
marifamd wants to merge 1 commit into
Conversation
marifamd
force-pushed
the
users/marifamd/fix_clock_freq_docs
branch
from
fdbcd68 to
4eaca71
Compare
github-actions
Bot
added
the
documentation
marifamd
force-pushed
the
users/marifamd/fix_clock_freq_docs
branch
2 times, most recently
from
c03a97a to
8454a6b
Compare
marifamd
changed the title
marifamd
force-pushed
the
users/marifamd/fix_clock_freq_docs
branch
from
8454a6b to
7a441cc
Compare
amdsmi_get_clk_freq() returns frequencies in Hz, but the amdsmi_frequencies_t::frequency comment claimed MHz. Correct the comment to Hz and remove the bogus 'in MHz' note from the 'current' field, which is a frequency index rather than a frequency value. Also align the Python API reference (docs/reference/amdsmi-py-api.md) and the underlying rsmi_frequencies_t documentation, both of which left the unit unspecified, to state Hz. Signed-off-by: Maisam Arif <Maisam.Arif@amd.com>
marifamd
force-pushed
the
users/marifamd/fix_clock_freq_docs
branch
from
7a441cc to
9e0b7c2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
amdsmi_frequencies_t::frequencyfield is documented as being in MHz, butamdsmi_get_clk_freq()actually returns frequencies in Hz.Verified live on an MI350X (ROCm 7.0.1, AMD SMI 26.4.0): the top GFX DPM level reports
2200000000, i.e. 2.2 GHz expressed in Hz, not2200MHz.Changes
include/amd_smi/amdsmi.h: correct thefrequencyarray comment from MHz to Hz, and remove the bogus "in MHz" note fromcurrent, which is a frequency index, not a frequency value.CHANGELOG.md: add a Fixed entry under ROCm 7.14.0.Documentation-only change; no functional impact.