From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org
Subject: [PATCH 04/16] char: pcmcia: synclink_cs: Fix a bunch of kernel-doc issues
Date: Thu, 20 May 2021 13:13:35 +0100 [thread overview]
Message-ID: <20210520121347.3467794-5-lee.jones@linaro.org> (raw)
In-Reply-To: <20210520121347.3467794-1-lee.jones@linaro.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/char/pcmcia/synclink_cs.c | 64 ++++++++++++++++---------------
1 file changed, 33 insertions(+), 31 deletions(-)
diff --git a/drivers/char/pcmcia/synclink_cs.c b/drivers/char/pcmcia/synclink_cs.c
index 9f7420bc50267..4a1e63911b279 100644
--- a/drivers/char/pcmcia/synclink_cs.c
+++ b/drivers/char/pcmcia/synclink_cs.c
@@ -483,7 +483,7 @@ static void* mgslpc_get_text_ptr(void)
return mgslpc_get_text_ptr;
}
-/**
+/*
* line discipline callback wrappers
*
* The wrappers maintain line discipline references
@@ -3861,12 +3861,13 @@ static void tx_timeout(struct timer_list *t)
#if SYNCLINK_GENERIC_HDLC
/**
- * called by generic HDLC layer when protocol selected (PPP, frame relay, etc.)
- * set encoding and frame check sequence (FCS) options
+ * hdlcdev_attach() - called by generic HDLC layer when protocol selected
+ * (PPP, frame relay, etc.) set encoding and frame check
+ * sequence (FCS) options
*
- * dev pointer to network device structure
- * encoding serial encoding setting
- * parity FCS setting
+ * @dev: pointer to network device structure
+ * @encoding: serial encoding setting
+ * @parity: FCS setting
*
* returns 0 if success, otherwise error code
*/
@@ -3914,10 +3915,10 @@ static int hdlcdev_attach(struct net_device *dev, unsigned short encoding,
}
/**
- * called by generic HDLC layer to send frame
+ * hdlcdev_xmit() - called by generic HDLC layer to send frame
*
- * skb socket buffer containing HDLC frame
- * dev pointer to network device structure
+ * @skb: socket buffer containing HDLC frame
+ * @dev: pointer to network device structure
*/
static netdev_tx_t hdlcdev_xmit(struct sk_buff *skb,
struct net_device *dev)
@@ -3959,10 +3960,10 @@ static netdev_tx_t hdlcdev_xmit(struct sk_buff *skb,
}
/**
- * called by network layer when interface enabled
- * claim resources and initialize hardware
+ * hdlcdev_open() - called by network layer when interface enabled
+ * claim resources and initialize hardware
*
- * dev pointer to network device structure
+ * @dev: pointer to network device structure
*
* returns 0 if success, otherwise error code
*/
@@ -4022,10 +4023,10 @@ static int hdlcdev_open(struct net_device *dev)
}
/**
- * called by network layer when interface is disabled
- * shutdown hardware and release resources
+ * hdlcdev_close() - called by network layer when interface is
+ * disabled shutdown hardware and release resources
*
- * dev pointer to network device structure
+ * @dev: pointer to network device structure
*
* returns 0 if success, otherwise error code
*/
@@ -4161,9 +4162,10 @@ static int hdlcdev_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
}
/**
- * called by network layer when transmit timeout is detected
+ * hdlcdev_tx_timeout() - called by network layer when transmit timeout
+ * is detected
*
- * dev pointer to network device structure
+ * @dev: pointer to network device structure
*/
static void hdlcdev_tx_timeout(struct net_device *dev, unsigned int txqueue)
{
@@ -4184,10 +4186,10 @@ static void hdlcdev_tx_timeout(struct net_device *dev, unsigned int txqueue)
}
/**
- * called by device driver when transmit completes
- * reenable network layer transmit if stopped
+ * hdlcdev_tx_done() - called by device driver when transmit completes
+ * reenable network layer transmit if stopped
*
- * info pointer to device instance information
+ * @info: pointer to device instance information
*/
static void hdlcdev_tx_done(MGSLPC_INFO *info)
{
@@ -4196,12 +4198,12 @@ static void hdlcdev_tx_done(MGSLPC_INFO *info)
}
/**
- * called by device driver when frame received
- * pass frame to network layer
+ * hdlcdev_rx() - called by device driver when frame received
+ * pass frame to network layer
*
- * info pointer to device instance information
- * buf pointer to buffer contianing frame data
- * size count of data bytes in buf
+ * @info: pointer to device instance information
+ * @buf: pointer to buffer contianing frame data
+ * @size: count of data bytes in buf
*/
static void hdlcdev_rx(MGSLPC_INFO *info, char *buf, int size)
{
@@ -4236,10 +4238,10 @@ static const struct net_device_ops hdlcdev_ops = {
};
/**
- * called by device driver when adding device instance
- * do generic HDLC initialization
+ * hdlcdev_init() - called by device driver when adding device instance
+ * do generic HDLC initialization
*
- * info pointer to device instance information
+ * @info: pointer to device instance information
*
* returns 0 if success, otherwise error code
*/
@@ -4284,10 +4286,10 @@ static int hdlcdev_init(MGSLPC_INFO *info)
}
/**
- * called by device driver when removing device instance
- * do generic HDLC cleanup
+ * hdlcdev_exit() - called by device driver when removing device instance
+ * do generic HDLC cleanup
*
- * info pointer to device instance information
+ * @info: pointer to device instance information
*/
static void hdlcdev_exit(MGSLPC_INFO *info)
{
--
2.31.1
next prev parent reply other threads:[~2021-05-20 12:50 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-20 12:13 [PATCH 00/16] Rid W=1 warnings from Char Lee Jones
2021-05-20 12:13 ` [PATCH 01/16] char: pcmcia: cm4000_cs: Remove unused variable 'tmp' Lee Jones
2021-05-20 12:13 ` [PATCH 02/16] char: pcmcia: cm4040_cs: Remove unused variable 'uc' Lee Jones
2021-05-20 12:13 ` [PATCH 03/16] char: random: Include header containing our prototypes Lee Jones
2021-05-20 12:13 ` Lee Jones [this message]
2021-05-20 12:13 ` [PATCH 05/16] char: pcmcia: synclink_cs: Fix a bunch of kernel-doc issues Lee Jones
2021-05-21 8:09 ` Greg Kroah-Hartman
2021-05-21 8:17 ` Lee Jones
2021-05-20 12:13 ` [PATCH 06/16] char: applicom: Remove 3 unused variables 'ret' and 2 instances of 'byte_reset_it' Lee Jones
2021-05-20 12:27 ` Arnd Bergmann
2021-05-20 12:13 ` [PATCH 07/16] char: tpm: tpm1-cmd: Fix a couple of misnamed functions Lee Jones
2021-05-20 16:41 ` Jarkko Sakkinen
2021-05-20 12:13 ` [PATCH 08/16] char: tpm: tpm_ftpm_tee: Fix a couple of kernel-doc misdemeanours Lee Jones
2021-05-20 16:43 ` Jarkko Sakkinen
2021-05-20 12:13 ` [PATCH 09/16] char: agp: backend: Demote some non-conformant kernel-doc headers Lee Jones
2021-06-17 9:52 ` Lee Jones
2021-05-20 12:13 ` [PATCH 10/16] char: agp: frontend: Include header file containing our prototypes Lee Jones
2021-05-20 12:13 ` [PATCH 11/16] char: agp: via-agp: Remove unused variable 'current_size' Lee Jones
2021-05-20 12:13 ` [PATCH 12/16] char: hpet: Remove unused variable 'm' Lee Jones
2021-05-20 12:13 ` [PATCH 13/16] char: agp: generic: Place braces around optimised out function in if() Lee Jones
2021-05-20 12:13 ` [PATCH 14/16] char: agp: uninorth-agp: Remove unused variable 'size' Lee Jones
2021-05-20 12:13 ` [PATCH 15/16] char: hw_random: pseries-rng: Demote non-conformant kernel-doc header Lee Jones
2021-05-20 12:13 ` [PATCH 16/16] char: mem: Provide local prototype for non-static function Lee Jones
2021-05-20 12:32 ` Arnd Bergmann
2021-05-20 12:56 ` [PATCH 00/16] Rid W=1 warnings from Char Arnd Bergmann
2021-05-21 7:22 ` Lee Jones
2021-05-21 7:42 ` Greg Kroah-Hartman
2021-05-21 7:44 ` Greg Kroah-Hartman
2021-05-21 7:56 ` Lee Jones
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210520121347.3467794-5-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).