From 346f3768fada54883aef4376dcc4c4ab18c86ebd Mon Sep 17 00:00:00 2001
From: Roopa Malavally <56051583+Rmalavally@users.noreply.github.com>
Date: Wed, 15 May 2024 12:55:05 -0700
Subject: [PATCH] Update build.rst

[ROCm/rocminfo commit: c9a24a75034e630f64ac6acebe7205f764abfd6b]
---
 projects/rocminfo/docs/install/build.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/projects/rocminfo/docs/install/build.rst b/projects/rocminfo/docs/install/build.rst
index fe5141c49b..a251722513 100644
--- a/projects/rocminfo/docs/install/build.rst
+++ b/projects/rocminfo/docs/install/build.rst
@@ -27,3 +27,20 @@ For example,
     cd ..
 
 Upon a successful build, the binary, rocminfo, and the python script, rocm_agent_enumerator, will be in the `build` folder.
+
+ROCmInfo execution
+-------------------
+
+"rocminfo" gives information about the HSA system attributes and agents.
+
+"rocm_agent_enumerator" prints the list of available AMD GCN ISA or architecture names. With the option '-name', it prints out available architectures names obtained from rocminfo. Otherwise, it generates ISA in one of five different ways:
+
+1. ROCM_TARGET_LST : a user defined environment variable, set to the path and filename where to find the "target.lst" file. This can be used in an install environment with sandbox, where execution of "rocminfo" is not possible.
+
+2. target.lst : user-supplied text file, in the same folder as "rocm_agent_enumerator". This is used in a container setting where ROCm stack may usually not available.
+
+3. HSA topology : gathers the information from the HSA node topology in /sys/class/kfd/kfd/topology/nodes/
+
+4. lspci : enumerate PCI bus and locate supported devices from a hard-coded lookup table.
+
+5. rocminfo : a tool shipped with this script to enumerate GPU agents available on a working ROCm stack.