git/linux-net
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/netdev/net.git/ synced 2026-04-24 19:25:07 -04:00
Code Issues Packages Projects Releases Wiki Activity

qed: Fix kernel-doc warnings

Browse Source 
This patch fixes all the qed and qede kernel-doc warnings
according to the guidelines that are described in
Documentation/doc-guide/kernel-doc.rst.

Signed-off-by: Ariel Elior <aelior@marvell.com>
Signed-off-by: Omkar Kulkarni <okulkarni@marvell.com>
Signed-off-by: Shai Malin <smalin@marvell.com>
Signed-off-by: Prabhakar Kushwaha <pkushwaha@marvell.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
Prabhakar Kushwaha
2021-10-04 09:58:39 +03:00
committed by David S. Miller
parent cfbe9b0021
commit 19198e4ec9
21 changed files with 2161 additions and 1892 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
include/linux/qed/qed_ll2_if.h
View File

@@ -208,57 +208,57 @@ enum qed_ll2_xmit_flags {
struct qed_ll2_ops {
/**
* @brief start - initializes ll2
* start(): Initializes ll2.
*
* @param cdev
* @param params - protocol driver configuration for the ll2.
* @cdev: Qed dev pointer.
* @params: Protocol driver configuration for the ll2.
*
* @return 0 on success, otherwise error value.
* Return: 0 on success, otherwise error value.
*/
int (*start)(struct qed_dev *cdev, struct qed_ll2_params *params);
/**
* @brief stop - stops the ll2
* stop(): Stops the ll2
*
* @param cdev
* @cdev: Qed dev pointer.
*
* @return 0 on success, otherwise error value.
* Return: 0 on success, otherwise error value.
*/
int (*stop)(struct qed_dev *cdev);
/**
* @brief start_xmit - transmits an skb over the ll2 interface
* start_xmit(): Transmits an skb over the ll2 interface
*
* @param cdev
* @param skb
* @param xmit_flags - Transmit options defined by the enum qed_ll2_xmit_flags.
* @cdev: Qed dev pointer.
* @skb: SKB.
* @xmit_flags: Transmit options defined by the enum qed_ll2_xmit_flags.
*
* @return 0 on success, otherwise error value.
* Return: 0 on success, otherwise error value.
*/
int (*start_xmit)(struct qed_dev *cdev, struct sk_buff *skb,
unsigned long xmit_flags);
/**
* @brief register_cb_ops - protocol driver register the callback for Rx/Tx
* register_cb_ops(): Protocol driver register the callback for Rx/Tx
* packets. Should be called before `start'.
*
* @param cdev
* @param cookie - to be passed to the callback functions.
* @param ops - the callback functions to register for Rx / Tx.
* @cdev: Qed dev pointer.
* @cookie: to be passed to the callback functions.
* @ops: the callback functions to register for Rx / Tx.
*
* @return 0 on success, otherwise error value.
* Return: 0 on success, otherwise error value.
*/
void (*register_cb_ops)(struct qed_dev *cdev,
const struct qed_ll2_cb_ops *ops,
void *cookie);
/**
* @brief get LL2 related statistics
* get_stats(): Get LL2 related statistics.
*
* @param cdev
* @param stats - pointer to struct that would be filled with stats
* @cdev: Qed dev pointer.
* @stats: Pointer to struct that would be filled with stats.
*
* @return 0 on success, error otherwise.
* Return: 0 on success, error otherwise.
*/
int (*get_stats)(struct qed_dev *cdev, struct qed_ll2_stats *stats);
};