Commit Graph

183 Commits

Author SHA1 Message Date
Sam Wu 602130e212 Sphinx Documentation Setup
Added README links to Python library and CLI tool
Get correct version number from header file
Updated base README with sphinx documentation steps

Change-Id: I60eb3d37d77dab4ff7c8334f94b9c1804edb524b
Signed-off-by: Maisam Arif <Maisam.Arif@amd.com>


[ROCm/amdsmi commit: 7104b6fe31]
2023-06-07 09:47:37 -05:00
Sam Wu 505a8bc3c4 add configurations for sphinx documentation
Change-Id: I5672348aab0f20d0bfc4dd1efcfecdf4324342d6


[ROCm/amdsmi commit: c5e06b4040]
2023-05-30 16:08:54 -06:00
Sam Wu 7e26f8ada1 sphinx documentation
ref: https://github.com/RadeonOpenCompute/rocm_smi_lib/pull/119

fix formatting in docs/index.md

Change-Id: I940ef8147a40bd3b702aa591bd56557a870621fb


[ROCm/amdsmi commit: ed74bc6eca]
2023-05-11 10:41:45 -04:00
Dalibor Stanisavljevic b48024d883 SWDEV-370223 - Change the name of the header to amdsmi.h
Change dev to device_handle throughout the file
Change the pcie_info pcie_speed field type to uint32_t
Add AMDSMI prefix before amdsmi_mm_ip enum

Change-Id: I242145389ddc3f2ad05dfd6ca371640f4d118fc4
Signed-off-by: Dalibor Stanisavljevic <Dalibor.Stanisavljevic@amd.com>


[ROCm/amdsmi commit: b4b761d02f]
2022-12-08 13:34:34 +01:00
Bill(Shuzhou) Liu d944c4e11b Update the document
The README.md is updated for amdsmi

Change-Id: Ic027476d9f6b62e8972793e78db28b12644036ea


[ROCm/amdsmi commit: 93bc47a5c3]
2022-10-20 09:25:02 -05:00
Bill(Shuzhou) Liu d83e3a8b6e Restructure the folder
Move rocm_smi related function to rocm_smi folder. Move amd_smi to
top level include/ and src/ folder. Remove obsolte oam folder.
Change the CMakeLists.txt to update folder locations.

Change-Id: I52e6be739e49f3b0545865f25364787f5985e9c3


[ROCm/amdsmi commit: 0c91ef919d]
2022-10-20 09:23:51 -05:00
Chris Freehill 9e57932639 Refactor rsmi to support oam
Change-Id: Idc524e01ba06eb5c8d1682becaf5bf8ced5bffcf


[ROCm/amdsmi commit: 6594f8f58b]
2020-06-22 18:51:46 -05:00
Chris Freehill b30200cd48 Update XGMI perf counter test to show utilization
Also:
* When destroying a counter, make sure to stop the counter first
* In the test, do not stop (disable) the counter before
  reading it.
* Clean up some whitespace in other tests
* Re-add manual pdf file

Change-Id: I0786ef3a994ca568299c77e44f092af8943ac33d


[ROCm/amdsmi commit: f946ea37ef]
2020-06-10 12:49:49 -04:00
Chris Freehill 0394347ef5 Update README doc. build instructions
* Also, remove dependency of manual pdf on the README
file; they are independent of each other.

Change-Id: I1ab8c8c9adf6b78e5b4aab86ecdf4c46f3a6bf63


[ROCm/amdsmi commit: bdf22c1c9e]
2020-05-21 09:10:08 -04:00
Chris Freehill b1c550f82d Add RSMI ref manual to packages
Also,
* remove extraneous test files
* fix Doxygen docs. issues
* fix whitespace issues

Change-Id: I9b58b0d68bd125a34f4fe0dc84d609c7b0b6e30e


[ROCm/amdsmi commit: 8ced9c986a]
2020-05-18 23:40:38 -04:00
Chris Freehill b816c4a68b Fix README example error
Change-Id: Ib0124642cea34dcbfae0ea3bbe8ffaf09116bede


[ROCm/amdsmi commit: f8d623cb44]
2020-05-15 12:09:05 -04:00
Chris Freehill 735b0aec7d Documentation update
Change-Id: I646cf3d2fd6064295937f7e727076532894d3514


[ROCm/amdsmi commit: 7abe6dc1b2]
2020-03-27 14:08:19 -05:00
Chris Freehill 07c74cbe38 Correct rsmitst build instructions
Change-Id: Ia7dbdd7a489d235c6003badb79f2d0808e18143b


[ROCm/amdsmi commit: a482394263]
2020-03-02 16:29:10 -05:00
Chris Freehill 4c34034ec9 Use default value for version when git tags not present
Also, documentation typo correction.

Change-Id: I7fe4de05d3b8fb808a980862a09a9be32ed32bf5


[ROCm/amdsmi commit: fe4f7ed4a1]
2019-12-19 08:32:38 -06:00
Chris Freehill 5c62352033 Correct README Markdown formatting
Change-Id: Id63618fc7fa7fa7cdc68bcd451cbe89ef2c04469


[ROCm/amdsmi commit: ee13e85265]
2019-10-17 08:38:50 -05:00
Chris Freehill cae8ad4321 Support checking for specific device-getter api support
For device-getter functions, allow users to specify a nullptr
for the provided buffer. In those cases, the function will return
RSMI_STATUS_NOT_SUPPORTED if the hardware or system software does
not support the function. If the function is supported, then
RSMI_STATUS_INVALID_ARGS will be returned, unless a different
error is encountered.

Additionally, tests and documentation were updated to reflect
this change.

Change-Id: Ie7db3a4c8c66af97ebd7ee1e3b95cd331ace9d9c


[ROCm/amdsmi commit: 68d25e82fd]
2019-10-05 15:55:18 -05:00
Chris Freehill 948b82ed1a Add functions that tell what capabilities are supported
The new functions added in this commit allow a caller to tell up
front what functions, function variants and monitors are
supported.

Also,
* fixed a few documentation/formatting issues
* fixed a process_info test issue

Change-Id: I2184ab1a4a6898f847e791f273e2185d556e78e9


[ROCm/amdsmi commit: 551b15182b]
2019-09-23 13:30:47 -05:00
Chris Freehill 9e945d3e1a Fix building lib and test in non-automated (CI) env.
Also, use abbreviated ROCM_BUILD_ID environment variable for job
and build number, if it's available.

Change-Id: Ib5a721f5920f1008bb6382935f7b439429389de0


[ROCm/amdsmi commit: aa2db48237]
2019-08-14 23:18:15 -05:00
Chris Freehill e79dd7953a Update docs for rsmi_dev_memory_reserved_pages_get()
Change-Id: I3cc479ea709bb8d9c23ff35d7339e329477ffe18


[ROCm/amdsmi commit: 0da1599c4f]
2019-08-06 16:57:09 -05:00
Chris Freehill 64f22d2749 Add xgmi error_status and error_reset functions
Also, comment corrections and added check for invalid arguments

Change-Id: I891cbf9b37bfda629914a008811b840323872c02


[ROCm/amdsmi commit: 557e1f5704]
2019-07-09 09:55:05 -04:00
Chris Freehill df93edbbc0 Add initial support for getting process information
Added implementation of and tests for
rsmi_dev_compute_process_info_by_pid_get() and
rsmi_dev_compute_process_info_get()

Change-Id: I4c4f5f39fe6701da37916c9ad41449b5d35ac7af


[ROCm/amdsmi commit: 9b93cbe21d]
2019-07-03 20:01:43 -05:00
Chris Freehill c2930981ee Add rsmi_dev_memory_busy_percent_get()
Change-Id: Ide683b6c72870af547331f4502c5bb8c445d61b5


[ROCm/amdsmi commit: 1c5e090507]
2019-06-25 19:09:13 -05:00
Chris Freehill 1ce6397e6b Event counter support
XGMI related events are supported

Change-Id: If17036fe890c8be45da3654353599821b5828c14


[ROCm/amdsmi commit: ea26baec20]
2019-06-24 17:40:01 -05:00
Kent Russell dcc0969cc3 Add support for reading GPU's unique ID
Add support and testing for reading the Unique ID associated with a
specific GPU. This ID will persist across reboots, even if the GPU is
moved to a different machine. Note that this is per-GPU, not per-card,
as some cards have multiple GPUs, and each GPU will get a unique
identifier

Change-Id: Idce50c6febc2ceb1a4c1200d2489ec8b9d8fe174


[ROCm/amdsmi commit: 35d2807196]
2019-06-21 08:39:36 -04:00
Chris Freehill 3beb502a69 Add support for junction, edge and memory temperature sensors (#42)
* If vendor/device/subsystem name is not found, use device ID string

* Update documentation for get-name functions

* Add support for junction, edge and memory temperature sensors


[ROCm/amdsmi commit: 11f714326b]
2019-05-24 15:24:49 -05:00
Chris Freehill 36817788ab By default, only consider AMD GPU's in RSMI device list (#36)
With newly added initialization parameters that can be
passed to rsmi_init(), you can tell RSMI to consider other
devices.

Also:
-fixed incorrect header file name that would break in C
builds
-modified rsmi_init() and rsmi_shut_down() to reinitialize and
clear static structures


[ROCm/amdsmi commit: a0817d6b13]
2019-05-09 20:45:54 -05:00
Chris Freehill cff4d16afc Added ECC enabled, status and get functions
[ROCm/amdsmi commit: 4e679b9324]
2019-04-03 11:17:43 -05:00
Chris Freehill dc7c6e4d7d Added new id and id name string look up functions
Also, updated docs with typo corrections and a new section


[ROCm/amdsmi commit: cbdfac7bdc]
2019-03-15 16:21:37 -05:00
Chris Freehill 533b3f8c74 Re-organize function documentation into sections
[ROCm/amdsmi commit: 89fb40fbe5]
2019-03-03 23:11:50 -06:00
Chris Freehill 0f66ee6958 Documentation and volt-curve read updates
[ROCm/amdsmi commit: 68b5e2ee0d]
2019-02-22 15:05:44 -06:00
Chris Freehill 402b3cd383 Rename manual
Also fix typo.


[ROCm/amdsmi commit: 5cb0895816]
2019-02-16 13:21:41 -06:00
Chris Freehill 716030990f Documentation updates
-Replaced README with cleaner version.
-Added PDF introductory document (same as README)


[ROCm/amdsmi commit: 4449411e35]
2019-02-15 17:23:12 -06:00
Chris Freehill 455470573e ROCm 1.9.0 update
[ROCm/amdsmi commit: 53b7ae1113]
2018-09-16 00:13:29 -05:00