From: Naman Patel <naman.patel@amd.com>
Date: Wed, 15 Feb 2023 09:01:21 +0000 (-0800)
Subject: docs(xilinx): correct function description
X-Git-Tag: baikal/aarch64/sdk5.10~1^2~209^2
X-Git-Url: https://git.baikalelectronics.ru/sdk/?a=commitdiff_plain;h=b96065a04bbd7f1a6af70ab5125027a028b4d79c;p=arm-tf.git

docs(xilinx): correct function description

Inside pm_ipi.c file, corrected the function description of
pm_ipi_buff_read_callb() and removed the return type as this is a void
function.

Signed-off-by: Naman Patel <naman.patel@amd.com>
Change-Id: I6257894337ef64497afb3e80d70af91a20357d5f
---

diff --git a/plat/xilinx/common/pm_service/pm_ipi.c b/plat/xilinx/common/pm_service/pm_ipi.c
index 513d6be0a..a3c3a6f23 100644
--- a/plat/xilinx/common/pm_service/pm_ipi.c
+++ b/plat/xilinx/common/pm_service/pm_ipi.c
@@ -172,12 +172,13 @@ static enum pm_ret_status pm_ipi_buff_read(const struct pm_proc *proc,
 }
 
 /**
- * pm_ipi_buff_read_callb() - Reads IPI response after remote processor has
- *			      handled interrupt
- * @value	Used to return value from IPI buffer element (optional)
+ * pm_ipi_buff_read_callb() - Callback function that reads value from
+ *			      ipi response buffer
+ * @value	Used to return value from IPI buffer element
  * @count	Number of values to return in @value
  *
- * @return	Returns status, either success or error+reason
+ * This callback function fills requested data in @value from ipi response
+ * buffer.
  */
 void pm_ipi_buff_read_callb(uint32_t *value, size_t count)
 {