Update gaudi2 component details

Author: tokey-tahmid

src/components/gaudi2/README.md

@@ -1,33 +1,22 @@
-# PAPI Gaudi2 Component
+# Gaudi2 Component
 
-This PAPI component provides access to hardware performance counters on Intel Gaudi2 AI Accelerators through the SPMU interface.
+The `gaudi2` component provides access to hardware performance counters on Intel Gaudi2 AI Accelerators through the SPMU interface.
 
-## Overview
+- [Environment Variables](#environment-variables)
+- [Enabling the Gaudi2 Component](#enabling-the-gaudi2-component)
 
-The Gaudi2 component enables monitoring of:
-- **TPC (Tensor Processing Core)** - 24 TPCs across 4 DCOREs
-- **EDMA (External DMA)** - 8 EDMAs for data movement
-- **PDMA (PCIe DMA)** - 2 PDMAs for host-device transfers
-- **MME (Matrix Multiplication Engine)** - 4 MMEs for matrix operations
+## Environment Variables
+The `gaudi2` component requires setting the `PAPI_GAUDI2_ROOT` environment variable to habanalabs installed directory for `hl-thunk` headers and libraries.
 
-Each SPMU unit supports up to 6 programmable counters that can be configured to count various hardware events.
+```bash
+export PAPI_GAUDI2_ROOT=/usr`
+```
 
-## Requirements
+## Enabling the Gaudi2 Component
 
-- **Hardware**: Intel Gaudi2 AI Accelerator
-- **Software**:
-  - Habana Labs driver and runtime
-  - libhl-thunk.so (Habana thunk library)
-  - Access to `/dev/accel/accel*` devices
-- **Permissions**: User must have read/write access to accelerator devices
+To enable the `gaudi2` component, configure and build PAPI with the component enabled as follows:
 
-## Building
-
-Set the `PAPI_GAUDI2_ROOT` environment variable to habanalabs installed directory for `hl-thunk` headers and libraries.
-`export PAPI_GAUDI2_ROOT=/usr`
-
-Configure the component using:
-`./configure --with-components="gaudi2"`
-
-then build with:
-`make && make install`
+```bash
+./configure --with-components="gaudi2"
+make && make install
+```

src/components/gaudi2/Rules.gaudi2

@@ -1,24 +1,11 @@
 # Rules for the Gaudi2 component
-#
-# This component provides access to Intel Gaudi2 AI Accelerator
-# hardware performance counters (SPMU).
-#
-# Requirements:
-#   - libhl-thunk.so (Habana Labs thunk library)
-#   - /dev/accel/accel* device access
-#
-# Build with:
-#   ./configure --with-components="gaudi2"
-#
 # Environment variables (REQUIRED):
 #   PAPI_GAUDI2_ROOT - Path to Habana installation root
 #                      Example: /usr (for container builds with headers in /usr/include/habanalabs
 #                                     and libraries in /usr/lib/habanalabs)
-#
 # Expected directory structure under PAPI_GAUDI2_ROOT:
 #   $(PAPI_GAUDI2_ROOT)/include/habanalabs/hlthunk.h
 #   $(PAPI_GAUDI2_ROOT)/lib/habanalabs/libhl-thunk.so
-#
 
 # Component source files
 COMPSRCS += components/gaudi2/linux-gaudi2.c

src/components/gaudi2/gaudi2_events.h

@@ -1,8 +1,7 @@
-/*
- * gaudi2_events.h - Gaudi2 SPMU event definitions
+/**
+ * @file    gaudi2_events.h
  *
- * Event IDs from hl-prof-config -c gaudi2 --spmu-help
- * SPMU base addresses from gaudi2_blocks.h
+ * @author  Tokey Tahmid ttahmid@icl.utk.edu
  */
 
 #ifndef _GAUDI2_EVENTS_H

src/components/gaudi2/linux-gaudi2.c

@@ -1,12 +1,17 @@
-/*
- * linux-gaudi2.c - PAPI component for Intel Gaudi2 SPMU counters
+/**
+ * @file    linux-gaudi2.c
+ *
+ * @author  Tokey Tahmid ttahmid@icl.utk.edu
  *
- * Accesses hardware performance counters on Gaudi2 AI accelerators
- * via the hlthunk library debug interface.
+ * @ingroup papi_components
  *
- * Engines: TPC (24), EDMA (8), PDMA (2), MME (4)
+ * @brief
+ *  This file implements a PAPI component for the Intel Gaudi2 SPMU counters
+ *  Accesses hardware performance counters on Gaudi2 AI accelerators
+ *  via the hlthunk library debug interface.
  *
- * Requires: libhl-thunk.so, /dev/accel/accel* access, debug mode
+ * The open source software license for PAPI conforms to the BSD
+ * License template.
  */
 
 #include <stdio.h>