Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6db2c78f authored by Eric Holmberg's avatar Eric Holmberg
Browse files

soc: qcom: glink: update glink_rpm_rx_poll return doc 



glink_rpm_rx_poll() return documentation does not document return values
greater than 0.

Update documentation to match actual behavior.

Change-Id: Ic975423bef881ef4b6e90723df9c3d0caca3697b
Signed-off-by: default avatarEric Holmberg <eholmber@codeaurora.org>
parent e83f8926

drivers/soc/qcom/glink.c

+11 −5
Original line number Diff line number Diff line
@@ -2207,13 +2207,19 @@ void glink_unregister_link_state_cb(void *notif_handle) 
EXPORT_SYMBOL(glink_unregister_link_state_cb);



/**

 * glink_rpm_rx_poll() - Poll and receive any available packet

 * handle:	Channel handle in which this operation is performed.

 * glink_rpm_rx_poll() - Poll and receive any available events

 * @handle:	Channel handle in which this operation is performed.

 *

 * This function is used to poll and receive the packet while the receive

 * interrupt from RPM is disabled.

 * This function is used to poll and receive events and packets while the

 * receive interrupt from RPM is disabled.

 *

 * Return: 0 on success, standard Linux error codes on failure.

 * Note that even if a return value > 0 is returned indicating that some events

 * were processed, clients should only use the notification functions passed

 * into glink_open() to determine if an entire packet has been received since

 * some events may be internal details that are not visible to clients.

 *

 * Return: 0 for no packets available; > 0 for events available; standard

 * Linux error codes on failure.

 */

int glink_rpm_rx_poll(void *handle)

{

include/soc/qcom/glink_rpm_xprt.h

+11 −5
Original line number Diff line number Diff line
@@ -17,13 +17,19 @@ 
#ifdef CONFIG_MSM_GLINK



/**

 * glink_rpm_rx_poll() - Poll and receive any available packet

 * glink_rpm_rx_poll() - Poll and receive any available events

 * @handle:	Channel handle in which this operation is performed.

 *

 * This function is used to poll and receive the packet while the receive

 * interrupt from RPM is disabled.

 * This function is used to poll and receive events and packets while the

 * receive interrupt from RPM is disabled.

 *

 * Return: 0 on success, standard Linux error codes on failure.

 * Note that even if a return value > 0 is returned indicating that some events

 * were processed, clients should only use the notification functions passed

 * into glink_open() to determine if an entire packet has been received since

 * some events may be internal details that are not visible to clients.

 *

 * Return: 0 for no packets available; > 0 for events available; standard

 * Linux error codes on failure.

 */

int glink_rpm_rx_poll(void *handle);