[PATCH] net: virtio_net: fix notification coalescing comments

[PATCH] net: virtio_net: fix notification coalescing comments

[Alvaro Karsz]

Fix wording in comments for the notifications coalescing feature.

Signed-off-by: Alvaro Karsz <alvaro.karsz@solid-run.com>
---
 include/uapi/linux/virtio_net.h | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/include/uapi/linux/virtio_net.h b/include/uapi/linux/virtio_net.h
index 29ced55514d..6cb842ea897 100644
--- a/include/uapi/linux/virtio_net.h
+++ b/include/uapi/linux/virtio_net.h
@@ -56,7 +56,7 @@
 #define VIRTIO_NET_F_MQ	22	/* Device supports Receive Flow
 					 * Steering */
 #define VIRTIO_NET_F_CTRL_MAC_ADDR 23	/* Set MAC address */
-#define VIRTIO_NET_F_NOTF_COAL	53	/* Guest can handle notifications coalescing */
+#define VIRTIO_NET_F_NOTF_COAL	53	/* Device supports notifications coalescing */
 #define VIRTIO_NET_F_HASH_REPORT  57	/* Supports hash report */
 #define VIRTIO_NET_F_RSS	  60	/* Supports RSS RX steering */
 #define VIRTIO_NET_F_RSC_EXT	  61	/* extended coalescing info */
@@ -364,24 +364,24 @@ struct virtio_net_hash_config {
  */
 #define VIRTIO_NET_CTRL_NOTF_COAL		6
 /*
- * Set the tx-usecs/tx-max-packets patameters.
- * tx-usecs - Maximum number of usecs to delay a TX notification.
- * tx-max-packets - Maximum number of packets to send before a TX notification.
+ * Set the tx-usecs/tx-max-packets parameters.
  */
 struct virtio_net_ctrl_coal_tx {
+	/* Maximum number of packets to send before a TX notification */
 	__le32 tx_max_packets;
+	/* Maximum number of usecs to delay a TX notification */
 	__le32 tx_usecs;
 };
 
 #define VIRTIO_NET_CTRL_NOTF_COAL_TX_SET		0
 
 /*
- * Set the rx-usecs/rx-max-packets patameters.
- * rx-usecs - Maximum number of usecs to delay a RX notification.
- * rx-max-frames - Maximum number of packets to receive before a RX notification.
+ * Set the rx-usecs/rx-max-packets parameters.
  */
 struct virtio_net_ctrl_coal_rx {
+	/* Maximum number of packets to receive before a RX notification */
 	__le32 rx_max_packets;
+	/* Maximum number of usecs to delay a RX notification */
 	__le32 rx_usecs;
 };
 
-- 
2.32.0

Re: [PATCH] net: virtio_net: fix notification coalescing comments

[Jakub Kicinski]

On Tue, 23 Aug 2022 10:39:47 +0300 Alvaro Karsz wrote:
> Fix wording in comments for the notifications coalescing feature.
> 
> Signed-off-by: Alvaro Karsz <alvaro.karsz@solid-run.com>
> ---
>  include/uapi/linux/virtio_net.h | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)

Hi Michael, do we take this on or do you?
I think DaveM marked it as Not Applicable in our PW but I'm unclear 
on what the split is on virtio_net, so I thought I'd ask.

Re: [PATCH] net: virtio_net: fix notification coalescing comments

[Michael S. Tsirkin]

On Tue, Aug 23, 2022 at 10:39:47AM +0300, Alvaro Karsz wrote:
> Fix wording in comments for the notifications coalescing feature.
> 
> Signed-off-by: Alvaro Karsz <alvaro.karsz@solid-run.com>

Acked-by: Michael S. Tsirkin <mst@redhat.com>


> ---
>  include/uapi/linux/virtio_net.h | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/include/uapi/linux/virtio_net.h b/include/uapi/linux/virtio_net.h
> index 29ced55514d..6cb842ea897 100644
> --- a/include/uapi/linux/virtio_net.h
> +++ b/include/uapi/linux/virtio_net.h
> @@ -56,7 +56,7 @@
>  #define VIRTIO_NET_F_MQ	22	/* Device supports Receive Flow
>  					 * Steering */
>  #define VIRTIO_NET_F_CTRL_MAC_ADDR 23	/* Set MAC address */
> -#define VIRTIO_NET_F_NOTF_COAL	53	/* Guest can handle notifications coalescing */
> +#define VIRTIO_NET_F_NOTF_COAL	53	/* Device supports notifications coalescing */
>  #define VIRTIO_NET_F_HASH_REPORT  57	/* Supports hash report */
>  #define VIRTIO_NET_F_RSS	  60	/* Supports RSS RX steering */
>  #define VIRTIO_NET_F_RSC_EXT	  61	/* extended coalescing info */
> @@ -364,24 +364,24 @@ struct virtio_net_hash_config {
>   */
>  #define VIRTIO_NET_CTRL_NOTF_COAL		6
>  /*
> - * Set the tx-usecs/tx-max-packets patameters.
> - * tx-usecs - Maximum number of usecs to delay a TX notification.
> - * tx-max-packets - Maximum number of packets to send before a TX notification.
> + * Set the tx-usecs/tx-max-packets parameters.
>   */
>  struct virtio_net_ctrl_coal_tx {
> +	/* Maximum number of packets to send before a TX notification */
>  	__le32 tx_max_packets;
> +	/* Maximum number of usecs to delay a TX notification */
>  	__le32 tx_usecs;
>  };
>  
>  #define VIRTIO_NET_CTRL_NOTF_COAL_TX_SET		0
>  
>  /*
> - * Set the rx-usecs/rx-max-packets patameters.
> - * rx-usecs - Maximum number of usecs to delay a RX notification.
> - * rx-max-frames - Maximum number of packets to receive before a RX notification.
> + * Set the rx-usecs/rx-max-packets parameters.
>   */
>  struct virtio_net_ctrl_coal_rx {
> +	/* Maximum number of packets to receive before a RX notification */
>  	__le32 rx_max_packets;
> +	/* Maximum number of usecs to delay a RX notification */
>  	__le32 rx_usecs;
>  };
>  
> -- 
> 2.32.0

Re: [PATCH] net: virtio_net: fix notification coalescing comments

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (master)
by Jakub Kicinski <kuba@kernel.org>:

On Tue, 23 Aug 2022 10:39:47 +0300 you wrote:
> Fix wording in comments for the notifications coalescing feature.
> 
> Signed-off-by: Alvaro Karsz <alvaro.karsz@solid-run.com>
> ---
>  include/uapi/linux/virtio_net.h | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)

Here is the summary with links:
  - net: virtio_net: fix notification coalescing comments
    https://git.kernel.org/netdev/net/c/fce1c23f6291

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html