Version & Doc update (#343)

Change-Id: Ibf8e1809913e30aba4b21ba889b72e5db7205736

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

[ROCm/amdsmi commit: ace3b0901a]
This commit is contained in:
Arif, Maisam
2025-05-08 12:19:04 -05:00
committato da GitHub
parent fe7360d0b6
commit 7ded6504b8
6 ha cambiato i file con 62 aggiunte e 9 eliminazioni
+1 -1
Vedi File
@@ -22,7 +22,7 @@ find_program(GIT NAMES git)
## Setup the package version based on git tags.
set(PKG_VERSION_GIT_TAG_PREFIX "amdsmi_pkg_ver")
get_package_version_number("25.4.2" ${PKG_VERSION_GIT_TAG_PREFIX} GIT)
get_package_version_number("25.5.0" ${PKG_VERSION_GIT_TAG_PREFIX} GIT)
message("Package version: ${PKG_VERSION_STR}")
set(${AMD_SMI_LIBS_TARGET}_VERSION_MAJOR "${CPACK_PACKAGE_VERSION_MAJOR}")
set(${AMD_SMI_LIBS_TARGET}_VERSION_MINOR "${CPACK_PACKAGE_VERSION_MINOR}")
@@ -1370,7 +1370,7 @@ class AMDSMIParser(argparse.ArgumentParser):
partition_help = "Displays partition information of the devices"
partition_subcommand_help = "If no GPU is specified, returns information for all GPUs on the system.\
\nIf no partition argument is provided, all partition information will be displayed."
partition_optionals_title = "partition arguments"
partition_optionals_title = "Partition arguments"
# Options help text
current_help = "display the current partition information"
@@ -1403,12 +1403,13 @@ class AMDSMIParser(argparse.ArgumentParser):
All parameters are provided via options; no positional arguments or optional --file/--gpu are used.
"""
# Subparser help text
ras_help = "Retrieve CPER (RAS) entries from the driver"
ras_help = "Retrieve RAS (CPER) entries from the driver"
ras_description = (
"Retrieve and decode CPER (RAS) entries from the kernel driver.\n"
"Retrieve and decode RAS (CPER) entries from the kernel driver.\n"
"Supports filtering by severity, exporting to different formats, and continuous monitoring.\n"
"This command accepts options only; no positional arguments are required."
)
ras_optionals_title = "RAS arguments"
# Help text for RAS arguments
cper_help = "Trigger CPER data retrieval"
@@ -1421,6 +1422,7 @@ class AMDSMIParser(argparse.ArgumentParser):
follow_help = "Continuously monitor for new entries"
ras_parser = subparsers.add_parser("ras", help=ras_help, description=ras_description)
ras_parser._optionals.title = ras_optionals_title
ras_parser.formatter_class = lambda prog: AMDSMISubparserHelpFormatter(prog)
ras_parser.set_defaults(func=func)
+1 -1
Vedi File
@@ -48,7 +48,7 @@ PROJECT_NAME = AMD SMI
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = "25.4.0"
PROJECT_NUMBER = "25.5.0"
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@@ -35,7 +35,7 @@ detected:
~$ amd-smi
usage: amd-smi [-h] ...
AMD System Management Interface | Version: 25.4.0 | ROCm version: 6.4.0 | Platform: Linux Baremetal
AMD System Management Interface | Version: 25.5.0 | ROCm version: 6.4.1 | Platform: Linux Baremetal
options:
-h, --help show this help message and exit
@@ -56,6 +56,7 @@ AMD-SMI Commands:
monitor (dmon) Monitor metrics for target devices
xgmi Displays xgmi information of the devices
partition Displays partition information of the devices
ras Retrieve CPER (RAS) entries from the driver
```
Example commands:
@@ -738,7 +739,7 @@ usage: amd-smi partition [-h] [-g GPU [GPU ...]] [-c] [-m] [-a] [--json | --csv]
If no GPU is specified, returns information for all GPUs on the system.
If no partition argument is provided, all partition information will be displayed.
partition arguments:
Partition arguments:
-h, --help show this help message and exit
-g, --gpu GPU [GPU ...] Select a GPU ID, BDF, or UUID from the possible choices:
ID: 0 | BDF: 0000:01:00.0 | UUID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
@@ -755,6 +756,56 @@ Command Modifiers:
--csv Displays output in CSV format (human readable by default).
--file FILE Saves output into a file on the provided path (stdout by default).
--loglevel LEVEL Set the logging level from the possible choices:
```
(cmd-ras)=
### amd-smi ras
Displays RAS information of specified devices.
```shell-session
~$ amd-smi ras --help
usage: amd-smi ras [-h] --cper [--severity SEVERITY [SEVERITY ...]] [--folder FOLDER]
[--file_limit FILE_LIMIT] [--follow]
[-g GPU [GPU ...] | -U CPU [CPU ...] | -O CORE [CORE ...]]
[--json | --csv] [--file FILE] [--loglevel LEVEL]
Retrieve and decode CPER (RAS) entries from the kernel driver.
Supports filtering by severity, exporting to different formats, and continuous monitoring.
This command accepts options only; no positional arguments are required.
RAS arguments:
-h, --help show this help message and exit
--cper Trigger CPER data retrieval
--severity SEVERITY [SEVERITY ...] Set the SEVERITY filters from the following:
nonfatal-uncorrected, fatal, nonfatal-corrected, all
--folder FOLDER Folder to dump CPER report files
--file_limit FILE_LIMIT Maximum number of entries per output file
--follow Continuously monitor for new entries
Device arguments:
-g, --gpu GPU [GPU ...] Select a GPU ID, BDF, or UUID from the possible choices:
ID: 0 | BDF: 0000:01:00.0 | UUID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
ID: 1 | BDF: 0001:01:00.0 | UUID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
ID: 2 | BDF: 0002:01:00.0 | UUID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
ID: 3 | BDF: 0003:01:00.0 | UUID: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
all | Selects all devices
-U, --cpu CPU [CPU ...] Select a CPU ID from the possible choices:
ID: 0
ID: 1
ID: 2
ID: 3
all | Selects all devices
-O, --core CORE [CORE ...] Select a Core ID from the possible choices:
ID: 0 - 95
all | Selects all devices
Command Modifiers:
--json Displays output in JSON format (human readable by default).
--csv Displays output in CSV format (human readable by default).
--file FILE Saves output into a file on the provided path (stdout by default).
--loglevel LEVEL Set the logging level from the possible choices:
DEBUG, INFO, WARNING, ERROR, CRITICAL
```
+1 -1
Vedi File
@@ -203,7 +203,7 @@ typedef enum {
#define AMDSMI_LIB_VERSION_MINOR 4
//! Release version should be set to 0 as default and can be updated by the PMs for each CSP point release
#define AMDSMI_LIB_VERSION_RELEASE 0
#define AMDSMI_LIB_VERSION_RELEASE 2
#define AMDSMI_LIB_VERSION_CREATE_STRING(MAJOR, MINOR, RELEASE) (#MAJOR "." #MINOR "." #RELEASE)
#define AMDSMI_LIB_VERSION_EXPAND_PARTS(MAJOR_STR, MINOR_STR, RELEASE_STR) AMDSMI_LIB_VERSION_CREATE_STRING(MAJOR_STR, MINOR_STR, RELEASE_STR)
@@ -130,7 +130,7 @@ pub const AMDSMI_DATE_FORMAT: &[u8; 35] = b"%04d-%02d-%02d:%02d:%02d:%02d.%03d\0
pub const AMDSMI_LIB_VERSION_YEAR: u32 = 25;
pub const AMDSMI_LIB_VERSION_MAJOR: u32 = 25;
pub const AMDSMI_LIB_VERSION_MINOR: u32 = 4;
pub const AMDSMI_LIB_VERSION_RELEASE: u32 = 0;
pub const AMDSMI_LIB_VERSION_RELEASE: u32 = 2;
pub const AMDSMI_MAX_NUM_FREQUENCIES: u32 = 33;
pub const AMDSMI_MAX_FAN_SPEED: u32 = 255;
pub const AMDSMI_NUM_VOLTAGE_CURVE_POINTS: u32 = 3;