]> git.baikalelectronics.ru Git - arm-tf.git/commitdiff
docs(xilinx): correct function description
authorNaman Patel <naman.patel@amd.com>
Wed, 15 Feb 2023 09:01:21 +0000 (01:01 -0800)
committerAkshay Belsare <akshay.belsare@amd.com>
Thu, 16 Feb 2023 09:23:14 +0000 (14:53 +0530)
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

plat/xilinx/common/pm_service/pm_ipi.c

index 513d6be0a67eca350737ce36aa6e1cd62690a46d..a3c3a6f234839bfd701f9e4083ff0bc727054ee5 100644 (file)
@@ -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)
 {