diff mbox series

[v3,16/17] net/bnxt: add missing comments

Message ID 20201209235347.16180-17-ajit.khaparde@broadcom.com (mailing list archive)
State Accepted, archived
Delegated to: Ajit Khaparde
Headers show
Series fixes and refactoring changes for bnxt | expand

Checks

Context Check Description
ci/checkpatch warning coding style issues

Commit Message

Ajit Khaparde Dec. 9, 2020, 11:53 p.m. UTC
Add and update some missing comments in the code.

Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
---
 drivers/net/bnxt/bnxt.h                         | 6 ++++++
 drivers/net/bnxt/tf_ulp/ulp_template_db_act.c   | 5 +++++
 drivers/net/bnxt/tf_ulp/ulp_template_db_class.c | 6 ++++++
 3 files changed, 17 insertions(+)

Comments

Lance Richardson Dec. 10, 2020, 4:02 p.m. UTC | #1
On Wed, Dec 9, 2020 at 6:59 PM Ajit Khaparde <ajitkhaparde@gmail.com> wrote:
>
> Add and update some missing comments in the code.
>
> Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> ---
>  drivers/net/bnxt/bnxt.h                         | 6 ++++++
>  drivers/net/bnxt/tf_ulp/ulp_template_db_act.c   | 5 +++++
>  drivers/net/bnxt/tf_ulp/ulp_template_db_class.c | 6 ++++++
>  3 files changed, 17 insertions(+)
>
> diff --git a/drivers/net/bnxt/bnxt.h b/drivers/net/bnxt/bnxt.h
> index 556e99203..07d39ee93 100644
> --- a/drivers/net/bnxt/bnxt.h
> +++ b/drivers/net/bnxt/bnxt.h
> @@ -724,7 +724,13 @@ struct bnxt {
>         void                            *hwrm_short_cmd_req_addr;
>         rte_iova_t                      hwrm_short_cmd_req_dma_addr;
>         rte_spinlock_t                  hwrm_lock;
> +       /* synchronize between dev_configure_op and int handler */
>         pthread_mutex_t                 def_cp_lock;
> +       /* synchronize between dev_start_op and async evt handler
> +        * Locking sequence in async evt handler will be
> +        * def_cp_lock
> +        * health_check_lock
> +        */
>         pthread_mutex_t                 health_check_lock;
>         uint16_t                        max_req_len;
>         uint16_t                        max_resp_len;
> diff --git a/drivers/net/bnxt/tf_ulp/ulp_template_db_act.c b/drivers/net/bnxt/tf_ulp/ulp_template_db_act.c
> index 00ada607a..509af7c58 100644
> --- a/drivers/net/bnxt/tf_ulp/ulp_template_db_act.c
> +++ b/drivers/net/bnxt/tf_ulp/ulp_template_db_act.c
> @@ -8,6 +8,10 @@
>  #include "ulp_template_struct.h"
>  #include "ulp_rte_parser.h"
>
> +/*
> + * Action signature table:
> + * maps hash id to ulp_act_match_list[] index
> + */
>  uint16_t ulp_act_sig_tbl[BNXT_ULP_ACT_SIG_TBL_MAX_SZ] = {
>         [BNXT_ULP_ACT_HID_015a] = 1,
>         [BNXT_ULP_ACT_HID_00eb] = 2,
> @@ -93,6 +97,7 @@ uint16_t ulp_act_sig_tbl[BNXT_ULP_ACT_SIG_TBL_MAX_SZ] = {
>         [BNXT_ULP_ACT_HID_0b4e] = 82
>  };
>
> +/* Array for the act matcher list */
>  struct bnxt_ulp_act_match_info ulp_act_match_list[] = {
>         [1] = {
>         .act_hid = BNXT_ULP_ACT_HID_015a,
> diff --git a/drivers/net/bnxt/tf_ulp/ulp_template_db_class.c b/drivers/net/bnxt/tf_ulp/ulp_template_db_class.c
> index fdb26da3e..d904a04cb 100644
> --- a/drivers/net/bnxt/tf_ulp/ulp_template_db_class.c
> +++ b/drivers/net/bnxt/tf_ulp/ulp_template_db_class.c
> @@ -8,6 +8,11 @@
>  #include "ulp_template_struct.h"
>  #include "ulp_rte_parser.h"
>
> +/* Define the template structures */
> +/*
> + * Classification signature table:
> + * maps hash id to ulp_class_match_list[] index
> + */
>  uint16_t ulp_class_sig_tbl[BNXT_ULP_CLASS_SIG_TBL_MAX_SZ] = {
>         [BNXT_ULP_CLASS_HID_0138] = 1,
>         [BNXT_ULP_CLASS_HID_03f0] = 2,
> @@ -227,6 +232,7 @@ uint16_t ulp_class_sig_tbl[BNXT_ULP_CLASS_SIG_TBL_MAX_SZ] = {
>         [BNXT_ULP_CLASS_HID_01b4] = 216
>  };
>
> +/* Array for the proto matcher list */
>  struct bnxt_ulp_class_match_info ulp_class_match_list[] = {
>         [1] = {
>         .class_hid = BNXT_ULP_CLASS_HID_0138,
> --
> 2.21.1 (Apple Git-122.3)
>
Acked-by: Lance Richardson <lance.richardson@broadcom.com>
diff mbox series

Patch

diff --git a/drivers/net/bnxt/bnxt.h b/drivers/net/bnxt/bnxt.h
index 556e99203..07d39ee93 100644
--- a/drivers/net/bnxt/bnxt.h
+++ b/drivers/net/bnxt/bnxt.h
@@ -724,7 +724,13 @@  struct bnxt {
 	void				*hwrm_short_cmd_req_addr;
 	rte_iova_t			hwrm_short_cmd_req_dma_addr;
 	rte_spinlock_t			hwrm_lock;
+	/* synchronize between dev_configure_op and int handler */
 	pthread_mutex_t			def_cp_lock;
+	/* synchronize between dev_start_op and async evt handler
+	 * Locking sequence in async evt handler will be
+	 * def_cp_lock
+	 * health_check_lock
+	 */
 	pthread_mutex_t			health_check_lock;
 	uint16_t			max_req_len;
 	uint16_t			max_resp_len;
diff --git a/drivers/net/bnxt/tf_ulp/ulp_template_db_act.c b/drivers/net/bnxt/tf_ulp/ulp_template_db_act.c
index 00ada607a..509af7c58 100644
--- a/drivers/net/bnxt/tf_ulp/ulp_template_db_act.c
+++ b/drivers/net/bnxt/tf_ulp/ulp_template_db_act.c
@@ -8,6 +8,10 @@ 
 #include "ulp_template_struct.h"
 #include "ulp_rte_parser.h"
 
+/*
+ * Action signature table:
+ * maps hash id to ulp_act_match_list[] index
+ */
 uint16_t ulp_act_sig_tbl[BNXT_ULP_ACT_SIG_TBL_MAX_SZ] = {
 	[BNXT_ULP_ACT_HID_015a] = 1,
 	[BNXT_ULP_ACT_HID_00eb] = 2,
@@ -93,6 +97,7 @@  uint16_t ulp_act_sig_tbl[BNXT_ULP_ACT_SIG_TBL_MAX_SZ] = {
 	[BNXT_ULP_ACT_HID_0b4e] = 82
 };
 
+/* Array for the act matcher list */
 struct bnxt_ulp_act_match_info ulp_act_match_list[] = {
 	[1] = {
 	.act_hid = BNXT_ULP_ACT_HID_015a,
diff --git a/drivers/net/bnxt/tf_ulp/ulp_template_db_class.c b/drivers/net/bnxt/tf_ulp/ulp_template_db_class.c
index fdb26da3e..d904a04cb 100644
--- a/drivers/net/bnxt/tf_ulp/ulp_template_db_class.c
+++ b/drivers/net/bnxt/tf_ulp/ulp_template_db_class.c
@@ -8,6 +8,11 @@ 
 #include "ulp_template_struct.h"
 #include "ulp_rte_parser.h"
 
+/* Define the template structures */
+/*
+ * Classification signature table:
+ * maps hash id to ulp_class_match_list[] index
+ */
 uint16_t ulp_class_sig_tbl[BNXT_ULP_CLASS_SIG_TBL_MAX_SZ] = {
 	[BNXT_ULP_CLASS_HID_0138] = 1,
 	[BNXT_ULP_CLASS_HID_03f0] = 2,
@@ -227,6 +232,7 @@  uint16_t ulp_class_sig_tbl[BNXT_ULP_CLASS_SIG_TBL_MAX_SZ] = {
 	[BNXT_ULP_CLASS_HID_01b4] = 216
 };
 
+/* Array for the proto matcher list */
 struct bnxt_ulp_class_match_info ulp_class_match_list[] = {
 	[1] = {
 	.class_hid = BNXT_ULP_CLASS_HID_0138,