[PATCH 4/4] Documentation/amdgpu: Add FRU attribute details

[Zhang, Hawking]

[AMD Official Use Only - General]

Series is

Reviewed-by: Hawking Zhang <Hawking.Zhang at amd.com>

Regards,
Hawking
-----Original Message-----
From: Lazar, Lijo <Lijo.Lazar at amd.com>
Sent: Wednesday, October 4, 2023 21:21
To: amd-gfx at lists.freedesktop.org
Cc: Zhang, Hawking <Hawking.Zhang at amd.com>; Deucher, Alexander <Alexander.Deucher at amd.com>
Subject: [PATCH 4/4] Documentation/amdgpu: Add FRU attribute details

Add documentation for the newly added manufacturer and fru_id attributes in sysfs.

Signed-off-by: Lijo Lazar <lijo.lazar at amd.com>
---
 Documentation/gpu/amdgpu/driver-misc.rst      | 12 ++++++++++++
 .../gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c    | 19 +++++++++++++++++++
 2 files changed, 31 insertions(+)

diff --git a/Documentation/gpu/amdgpu/driver-misc.rst b/Documentation/gpu/amdgpu/driver-misc.rst
index 82b47f1818ac..e40e15f89fd3 100644
--- a/Documentation/gpu/amdgpu/driver-misc.rst
+++ b/Documentation/gpu/amdgpu/driver-misc.rst
@@ -26,6 +26,18 @@ serial_number
 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c
    :doc: serial_number

+fru_id
+-------------
+
+.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c
+   :doc: fru_id
+
+manufacturer
+-------------
+
+.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c
+   :doc: manufacturer
+
 unique_id
 ---------

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c
index 5d627d0e19a4..d635e61805ea 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_fru_eeprom.c
@@ -321,6 +321,16 @@ static ssize_t amdgpu_fru_serial_number_show(struct device *dev,

 static DEVICE_ATTR(serial_number, 0444, amdgpu_fru_serial_number_show, NULL);

+/**
+ * DOC: fru_id
+ *
+ * The amdgpu driver provides a sysfs API for reporting FRU File Id
+ * for the device.
+ * The file fru_id is used for this and returns the File Id value
+ * as returned from the FRU.
+ * NOTE: This is only available for certain server cards  */
+
 static ssize_t amdgpu_fru_id_show(struct device *dev,
                                  struct device_attribute *attr, char *buf)  { @@ -332,6 +342,15 @@ static ssize_t amdgpu_fru_id_show(struct device *dev,

 static DEVICE_ATTR(fru_id, 0444, amdgpu_fru_id_show, NULL);

+/**
+ * DOC: manufacturer
+ *
+ * The amdgpu driver provides a sysfs API for reporting manufacturer
+name from
+ * FRU information.
+ * The file manufacturer returns the value as returned from the FRU.
+ * NOTE: This is only available for certain server cards  */
+
 static ssize_t amdgpu_fru_manufacturer_name_show(struct device *dev,
                                                 struct device_attribute *attr,
                                                 char *buf)
--
2.25.1