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
This commit is contained in:
Naman Patel 2023-02-15 01:01:21 -08:00 committed by Akshay Belsare
parent 97936d895b
commit b96065a04b

View 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 * pm_ipi_buff_read_callb() - Callback function that reads value from
* handled interrupt * ipi response buffer
* @value Used to return value from IPI buffer element (optional) * @value Used to return value from IPI buffer element
* @count Number of values to return in @value * @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) void pm_ipi_buff_read_callb(uint32_t *value, size_t count)
{ {