Skip to content

Commit 631af6e

Browse files
arnopomathieupoirier
authored andcommitted
rpmsg: Fix documentation return formatting
kernel documentation specification: "The return value, if any, should be described in a dedicated section named Return." Signed-off-by: Arnaud Pouliquen <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Mathieu Poirier <[email protected]>
1 parent c572724 commit 631af6e

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

drivers/rpmsg/qcom_glink_native.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ static void qcom_glink_handle_intent_req_ack(struct qcom_glink *glink,
427427
* Allocates a local channel id and sends a RPM_CMD_OPEN message to the remote.
428428
* Will return with refcount held, regardless of outcome.
429429
*
430-
* Returns 0 on success, negative errno otherwise.
430+
* Return: 0 on success, negative errno otherwise.
431431
*/
432432
static int qcom_glink_send_open_req(struct qcom_glink *glink,
433433
struct glink_channel *channel)

drivers/rpmsg/qcom_smd.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1467,7 +1467,7 @@ ATTRIBUTE_GROUPS(qcom_smd_edge);
14671467
* @parent: parent device for the edge
14681468
* @node: device_node describing the edge
14691469
*
1470-
* Returns an edge reference, or negative ERR_PTR() on failure.
1470+
* Return: an edge reference, or negative ERR_PTR() on failure.
14711471
*/
14721472
struct qcom_smd_edge *qcom_smd_register_edge(struct device *parent,
14731473
struct device_node *node)

drivers/rpmsg/rpmsg_core.c

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* @rpdev: rpmsg device
2727
* @chinfo: channel_info to bind
2828
*
29-
* Returns a pointer to the new rpmsg device on success, or NULL on error.
29+
* Return: a pointer to the new rpmsg device on success, or NULL on error.
3030
*/
3131
struct rpmsg_device *rpmsg_create_channel(struct rpmsg_device *rpdev,
3232
struct rpmsg_channel_info *chinfo)
@@ -48,7 +48,7 @@ EXPORT_SYMBOL(rpmsg_create_channel);
4848
* @rpdev: rpmsg device
4949
* @chinfo: channel_info to bind
5050
*
51-
* Returns 0 on success or an appropriate error value.
51+
* Return: 0 on success or an appropriate error value.
5252
*/
5353
int rpmsg_release_channel(struct rpmsg_device *rpdev,
5454
struct rpmsg_channel_info *chinfo)
@@ -102,7 +102,7 @@ EXPORT_SYMBOL(rpmsg_release_channel);
102102
* dynamically assign them an available rpmsg address (drivers should have
103103
* a very good reason why not to always use RPMSG_ADDR_ANY here).
104104
*
105-
* Returns a pointer to the endpoint on success, or NULL on error.
105+
* Return: a pointer to the endpoint on success, or NULL on error.
106106
*/
107107
struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_device *rpdev,
108108
rpmsg_rx_cb_t cb, void *priv,
@@ -146,7 +146,7 @@ EXPORT_SYMBOL(rpmsg_destroy_ept);
146146
*
147147
* Can only be called from process context (for now).
148148
*
149-
* Returns 0 on success and an appropriate error value on failure.
149+
* Return: 0 on success and an appropriate error value on failure.
150150
*/
151151
int rpmsg_send(struct rpmsg_endpoint *ept, void *data, int len)
152152
{
@@ -175,7 +175,7 @@ EXPORT_SYMBOL(rpmsg_send);
175175
*
176176
* Can only be called from process context (for now).
177177
*
178-
* Returns 0 on success and an appropriate error value on failure.
178+
* Return: 0 on success and an appropriate error value on failure.
179179
*/
180180
int rpmsg_sendto(struct rpmsg_endpoint *ept, void *data, int len, u32 dst)
181181
{
@@ -206,7 +206,7 @@ EXPORT_SYMBOL(rpmsg_sendto);
206206
*
207207
* Can only be called from process context (for now).
208208
*
209-
* Returns 0 on success and an appropriate error value on failure.
209+
* Return: 0 on success and an appropriate error value on failure.
210210
*/
211211
int rpmsg_send_offchannel(struct rpmsg_endpoint *ept, u32 src, u32 dst,
212212
void *data, int len)
@@ -235,7 +235,7 @@ EXPORT_SYMBOL(rpmsg_send_offchannel);
235235
*
236236
* Can only be called from process context (for now).
237237
*
238-
* Returns 0 on success and an appropriate error value on failure.
238+
* Return: 0 on success and an appropriate error value on failure.
239239
*/
240240
int rpmsg_trysend(struct rpmsg_endpoint *ept, void *data, int len)
241241
{
@@ -263,7 +263,7 @@ EXPORT_SYMBOL(rpmsg_trysend);
263263
*
264264
* Can only be called from process context (for now).
265265
*
266-
* Returns 0 on success and an appropriate error value on failure.
266+
* Return: 0 on success and an appropriate error value on failure.
267267
*/
268268
int rpmsg_trysendto(struct rpmsg_endpoint *ept, void *data, int len, u32 dst)
269269
{
@@ -282,7 +282,7 @@ EXPORT_SYMBOL(rpmsg_trysendto);
282282
* @filp: file for poll_wait()
283283
* @wait: poll_table for poll_wait()
284284
*
285-
* Returns mask representing the current state of the endpoint's send buffers
285+
* Return: mask representing the current state of the endpoint's send buffers
286286
*/
287287
__poll_t rpmsg_poll(struct rpmsg_endpoint *ept, struct file *filp,
288288
poll_table *wait)
@@ -313,7 +313,7 @@ EXPORT_SYMBOL(rpmsg_poll);
313313
*
314314
* Can only be called from process context (for now).
315315
*
316-
* Returns 0 on success and an appropriate error value on failure.
316+
* Return: 0 on success and an appropriate error value on failure.
317317
*/
318318
int rpmsg_trysend_offchannel(struct rpmsg_endpoint *ept, u32 src, u32 dst,
319319
void *data, int len)
@@ -623,7 +623,7 @@ EXPORT_SYMBOL(rpmsg_unregister_device);
623623
* @rpdrv: pointer to a struct rpmsg_driver
624624
* @owner: owning module/driver
625625
*
626-
* Returns 0 on success, and an appropriate error value on failure.
626+
* Return: 0 on success, and an appropriate error value on failure.
627627
*/
628628
int __register_rpmsg_driver(struct rpmsg_driver *rpdrv, struct module *owner)
629629
{
@@ -637,7 +637,7 @@ EXPORT_SYMBOL(__register_rpmsg_driver);
637637
* unregister_rpmsg_driver() - unregister an rpmsg driver from the rpmsg bus
638638
* @rpdrv: pointer to a struct rpmsg_driver
639639
*
640-
* Returns 0 on success, and an appropriate error value on failure.
640+
* Return: 0 on success, and an appropriate error value on failure.
641641
*/
642642
void unregister_rpmsg_driver(struct rpmsg_driver *rpdrv)
643643
{

drivers/rpmsg/virtio_rpmsg_bus.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,7 @@ static void rpmsg_downref_sleepers(struct virtproc_info *vrp)
547547
* should use the appropriate rpmsg_{try}send{to, _offchannel} API
548548
* (see include/linux/rpmsg.h).
549549
*
550-
* Returns 0 on success and an appropriate error value on failure.
550+
* Return: 0 on success and an appropriate error value on failure.
551551
*/
552552
static int rpmsg_send_offchannel_raw(struct rpmsg_device *rpdev,
553553
u32 src, u32 dst,

0 commit comments

Comments
 (0)