[dpdk-stable] patch 'net/ena/base: fix documentation of functions' has been queued to stable release 19.11.3

[luca.boccassi at gmail.com]

Hi,

FYI, your patch has been queued to stable release 19.11.3

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 05/21/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Thanks.

Luca Boccassi

---
>From 3c6ec30057b48bae36856499e312b1d4ea0fdb45 Mon Sep 17 00:00:00 2001
From: Michal Krawczyk <mk at semihalf.com>
Date: Wed, 8 Apr 2020 10:29:01 +0200
Subject: [PATCH] net/ena/base: fix documentation of functions

[ upstream commit b118993abd4cae7af3f8a66e0ad4fda1bee84c09 ]

The documentation format was aligned and few typos were fixed.

Fixes: 99ecfbf845b3 ("ena: import communication layer")

Signed-off-by: Michal Krawczyk <mk at semihalf.com>
Reviewed-by: Igor Chauskin <igorch at amazon.com>
Reviewed-by: Guy Tzalik <gtzalik at amazon.com>
---
 drivers/net/ena/base/ena_com.h | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/drivers/net/ena/base/ena_com.h b/drivers/net/ena/base/ena_com.h
index ef42bd4f56..2162eb42b8 100644
--- a/drivers/net/ena/base/ena_com.h
+++ b/drivers/net/ena/base/ena_com.h
@@ -404,7 +404,7 @@ extern "C" {
  */
 int ena_com_mmio_reg_read_request_init(struct ena_com_dev *ena_dev);
 
-/* ena_com_set_mmio_read_mode - Enable/disable the mmio reg read mechanism
+/* ena_com_set_mmio_read_mode - Enable/disable the indirect mmio reg read mechanism
  * @ena_dev: ENA communication layer struct
  * @readless_supported: readless mode (enable/disable)
  */
@@ -527,7 +527,7 @@ bool ena_com_get_ena_admin_polling_mode(struct ena_com_dev *ena_dev);
 /* ena_com_admin_q_comp_intr_handler - admin queue interrupt handler
  * @ena_dev: ENA communication layer struct
  *
- * This method go over the admin completion queue and wake up all the pending
+ * This method goes over the admin completion queue and wakes up all the pending
  * threads that wait on the commands wait event.
  *
  * @note: Should be called after MSI-X interrupt.
@@ -537,7 +537,7 @@ void ena_com_admin_q_comp_intr_handler(struct ena_com_dev *ena_dev);
 /* ena_com_aenq_intr_handler - AENQ interrupt handler
  * @ena_dev: ENA communication layer struct
  *
- * This method go over the async event notification queue and call the proper
+ * This method goes over the async event notification queue and calls the proper
  * aenq handler.
  */
 void ena_com_aenq_intr_handler(struct ena_com_dev *dev, void *data);
@@ -554,14 +554,14 @@ void ena_com_abort_admin_commands(struct ena_com_dev *ena_dev);
 /* ena_com_wait_for_abort_completion - Wait for admin commands abort.
  * @ena_dev: ENA communication layer struct
  *
- * This method wait until all the outstanding admin commands will be completed.
+ * This method waits until all the outstanding admin commands are completed.
  */
 void ena_com_wait_for_abort_completion(struct ena_com_dev *ena_dev);
 
 /* ena_com_validate_version - Validate the device parameters
  * @ena_dev: ENA communication layer struct
  *
- * This method validate the device parameters are the same as the saved
+ * This method verifies the device parameters are the same as the saved
  * parameters in ena_dev.
  * This method is useful after device reset, to validate the device mac address
  * and the device offloads are the same as before the reset.
@@ -763,7 +763,7 @@ int ena_com_set_hash_ctrl(struct ena_com_dev *ena_dev);
  *
  * Retrieve the hash control from the device.
  *
- * @note, If the caller called ena_com_fill_hash_ctrl but didn't flash
+ * @note: If the caller called ena_com_fill_hash_ctrl but didn't flash
  * it to the device, the new configuration will be lost.
  *
  * @return: 0 on Success and negative value otherwise.
@@ -815,7 +815,7 @@ int ena_com_indirect_table_set(struct ena_com_dev *ena_dev);
  *
  * Retrieve the RSS indirection table from the device.
  *
- * @note: If the caller called ena_com_indirect_table_fill_entry but didn't flash
+ * @note: If the caller called ena_com_indirect_table_fill_entry but didn't flush
  * it to the device, the new configuration will be lost.
  *
  * @return: 0 on Success and negative value otherwise.
@@ -841,14 +841,14 @@ int ena_com_allocate_debug_area(struct ena_com_dev *ena_dev,
 /* ena_com_delete_debug_area - Free the debug area resources.
  * @ena_dev: ENA communication layer struct
  *
- * Free the allocate debug area.
+ * Free the allocated debug area.
  */
 void ena_com_delete_debug_area(struct ena_com_dev *ena_dev);
 
 /* ena_com_delete_host_info - Free the host info resources.
  * @ena_dev: ENA communication layer struct
  *
- * Free the allocate host info.
+ * Free the allocated host info.
  */
 void ena_com_delete_host_info(struct ena_com_dev *ena_dev);
 
@@ -889,9 +889,9 @@ int ena_com_destroy_io_cq(struct ena_com_dev *ena_dev,
  * @cmd_completion: command completion return value.
  * @cmd_comp_size: command completion size.
 
- * Submit an admin command and then wait until the device will return a
+ * Submit an admin command and then wait until the device returns a
  * completion.
- * The completion will be copyed into cmd_comp.
+ * The completion will be copied into cmd_comp.
  *
  * @return - 0 on success, negative value on failure.
  */
@@ -1083,7 +1083,7 @@ static inline void ena_com_calculate_interrupt_delay(struct ena_com_dev *ena_dev
  * @intr_reg: interrupt register to update.
  * @rx_delay_interval: Rx interval in usecs
  * @tx_delay_interval: Tx interval in usecs
- * @unmask: unask enable/disable
+ * @unmask: unmask enable/disable
  *
  * Prepare interrupt update register with the supplied parameters.
  */
-- 
2.20.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-05-19 14:04:46.870492161 +0100
+++ 0058-net-ena-base-fix-documentation-of-functions.patch	2020-05-19 14:04:44.204648155 +0100
@@ -1,8 +1,10 @@
-From b118993abd4cae7af3f8a66e0ad4fda1bee84c09 Mon Sep 17 00:00:00 2001
+From 3c6ec30057b48bae36856499e312b1d4ea0fdb45 Mon Sep 17 00:00:00 2001
 From: Michal Krawczyk <mk at semihalf.com>
 Date: Wed, 8 Apr 2020 10:29:01 +0200
 Subject: [PATCH] net/ena/base: fix documentation of functions
 
+[ upstream commit b118993abd4cae7af3f8a66e0ad4fda1bee84c09 ]
+
 The documentation format was aligned and few typos were fixed.
 
 Fixes: 99ecfbf845b3 ("ena: import communication layer")
@@ -15,10 +17,10 @@
  1 file changed, 12 insertions(+), 12 deletions(-)
 
 diff --git a/drivers/net/ena/base/ena_com.h b/drivers/net/ena/base/ena_com.h
-index 07f63f44af..6c9943df79 100644
+index ef42bd4f56..2162eb42b8 100644
 --- a/drivers/net/ena/base/ena_com.h
 +++ b/drivers/net/ena/base/ena_com.h
-@@ -370,7 +370,7 @@ extern "C" {
+@@ -404,7 +404,7 @@ extern "C" {
   */
  int ena_com_mmio_reg_read_request_init(struct ena_com_dev *ena_dev);
  
@@ -27,7 +29,7 @@
   * @ena_dev: ENA communication layer struct
   * @readless_supported: readless mode (enable/disable)
   */
-@@ -504,7 +504,7 @@ void ena_com_set_admin_auto_polling_mode(struct ena_com_dev *ena_dev,
+@@ -527,7 +527,7 @@ bool ena_com_get_ena_admin_polling_mode(struct ena_com_dev *ena_dev);
  /* ena_com_admin_q_comp_intr_handler - admin queue interrupt handler
   * @ena_dev: ENA communication layer struct
   *
@@ -36,7 +38,7 @@
   * threads that wait on the commands wait event.
   *
   * @note: Should be called after MSI-X interrupt.
-@@ -514,7 +514,7 @@ void ena_com_admin_q_comp_intr_handler(struct ena_com_dev *ena_dev);
+@@ -537,7 +537,7 @@ void ena_com_admin_q_comp_intr_handler(struct ena_com_dev *ena_dev);
  /* ena_com_aenq_intr_handler - AENQ interrupt handler
   * @ena_dev: ENA communication layer struct
   *
@@ -45,7 +47,7 @@
   * aenq handler.
   */
  void ena_com_aenq_intr_handler(struct ena_com_dev *dev, void *data);
-@@ -531,14 +531,14 @@ void ena_com_abort_admin_commands(struct ena_com_dev *ena_dev);
+@@ -554,14 +554,14 @@ void ena_com_abort_admin_commands(struct ena_com_dev *ena_dev);
  /* ena_com_wait_for_abort_completion - Wait for admin commands abort.
   * @ena_dev: ENA communication layer struct
   *
@@ -62,7 +64,7 @@
   * parameters in ena_dev.
   * This method is useful after device reset, to validate the device mac address
   * and the device offloads are the same as before the reset.
-@@ -715,7 +715,7 @@ int ena_com_set_hash_ctrl(struct ena_com_dev *ena_dev);
+@@ -763,7 +763,7 @@ int ena_com_set_hash_ctrl(struct ena_com_dev *ena_dev);
   *
   * Retrieve the hash control from the device.
   *
@@ -71,7 +73,7 @@
   * it to the device, the new configuration will be lost.
   *
   * @return: 0 on Success and negative value otherwise.
-@@ -767,7 +767,7 @@ int ena_com_indirect_table_set(struct ena_com_dev *ena_dev);
+@@ -815,7 +815,7 @@ int ena_com_indirect_table_set(struct ena_com_dev *ena_dev);
   *
   * Retrieve the RSS indirection table from the device.
   *
@@ -80,7 +82,7 @@
   * it to the device, the new configuration will be lost.
   *
   * @return: 0 on Success and negative value otherwise.
-@@ -793,14 +793,14 @@ int ena_com_allocate_debug_area(struct ena_com_dev *ena_dev,
+@@ -841,14 +841,14 @@ int ena_com_allocate_debug_area(struct ena_com_dev *ena_dev,
  /* ena_com_delete_debug_area - Free the debug area resources.
   * @ena_dev: ENA communication layer struct
   *
@@ -97,7 +99,7 @@
   */
  void ena_com_delete_host_info(struct ena_com_dev *ena_dev);
  
-@@ -841,9 +841,9 @@ int ena_com_destroy_io_cq(struct ena_com_dev *ena_dev,
+@@ -889,9 +889,9 @@ int ena_com_destroy_io_cq(struct ena_com_dev *ena_dev,
   * @cmd_completion: command completion return value.
   * @cmd_comp_size: command completion size.
  
@@ -109,7 +111,7 @@
   *
   * @return - 0 on success, negative value on failure.
   */
-@@ -932,7 +932,7 @@ static inline void ena_com_disable_adaptive_moderation(struct ena_com_dev *ena_d
+@@ -1083,7 +1083,7 @@ static inline void ena_com_calculate_interrupt_delay(struct ena_com_dev *ena_dev
   * @intr_reg: interrupt register to update.
   * @rx_delay_interval: Rx interval in usecs
   * @tx_delay_interval: Tx interval in usecs