Commit 866ff8f2 authored by Saeed Mahameed's avatar Saeed Mahameed

net/mlx5: Improve functions documentation

Fix documentation of mlx5_eq_enable/disable to cleanup compiler warnings.

drivers/net/ethernet/mellanox/mlx5/core//eq.c:334:
warning: Function parameter or member 'dev' not described in 'mlx5_eq_enable'
warning: Function parameter or member 'eq' not described in 'mlx5_eq_enable'
warning: Function parameter or member 'nb' not described in 'mlx5_eq_enable'

drivers/net/ethernet/mellanox/mlx5/core//eq.c:355:
warning: Function parameter or member 'dev' not described in 'mlx5_eq_disable'
warning: Function parameter or member 'eq' not described in 'mlx5_eq_disable'
warning: Function parameter or member 'nb' not described in 'mlx5_eq_disable'
Signed-off-by: default avatarSaeed Mahameed <saeedm@mellanox.com>
parent eed6f7dc
...@@ -324,10 +324,13 @@ create_map_eq(struct mlx5_core_dev *dev, struct mlx5_eq *eq, ...@@ -324,10 +324,13 @@ create_map_eq(struct mlx5_core_dev *dev, struct mlx5_eq *eq,
/** /**
* mlx5_eq_enable - Enable EQ for receiving EQEs * mlx5_eq_enable - Enable EQ for receiving EQEs
* @dev - Device which owns the eq * @dev : Device which owns the eq
* @eq - EQ to enable * @eq : EQ to enable
* @nb - notifier call block * @nb : Notifier call block
* mlx5_eq_enable - must be called after EQ is created in device. *
* Must be called after EQ is created in device.
*
* @return: 0 if no error
*/ */
int mlx5_eq_enable(struct mlx5_core_dev *dev, struct mlx5_eq *eq, int mlx5_eq_enable(struct mlx5_core_dev *dev, struct mlx5_eq *eq,
struct notifier_block *nb) struct notifier_block *nb)
...@@ -344,11 +347,12 @@ int mlx5_eq_enable(struct mlx5_core_dev *dev, struct mlx5_eq *eq, ...@@ -344,11 +347,12 @@ int mlx5_eq_enable(struct mlx5_core_dev *dev, struct mlx5_eq *eq,
EXPORT_SYMBOL(mlx5_eq_enable); EXPORT_SYMBOL(mlx5_eq_enable);
/** /**
* mlx5_eq_disable - Enable EQ for receiving EQEs * mlx5_eq_disable - Disable EQ for receiving EQEs
* @dev - Device which owns the eq * @dev : Device which owns the eq
* @eq - EQ to disable * @eq : EQ to disable
* @nb - notifier call block * @nb : Notifier call block
* mlx5_eq_disable - must be called before EQ is destroyed. *
* Must be called before EQ is destroyed.
*/ */
void mlx5_eq_disable(struct mlx5_core_dev *dev, struct mlx5_eq *eq, void mlx5_eq_disable(struct mlx5_core_dev *dev, struct mlx5_eq *eq,
struct notifier_block *nb) struct notifier_block *nb)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment