From patchwork Wed Oct 11 14:35:06 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Adrien Mazarguil X-Patchwork-Id: 30126 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 795D81B1BD; Wed, 11 Oct 2017 16:36:27 +0200 (CEST) Received: from mail-wm0-f45.google.com (mail-wm0-f45.google.com [74.125.82.45]) by dpdk.org (Postfix) with ESMTP id C3C261B1B2 for ; Wed, 11 Oct 2017 16:36:21 +0200 (CEST) Received: by mail-wm0-f45.google.com with SMTP id k4so5449387wmc.1 for ; Wed, 11 Oct 2017 07:36:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=6wind-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=tNniJpfbWeVTMtQpNkYDnMhNac5piaiqsLt7AsjoV2o=; b=Yn4L6qwo34fhmJp89079bVXv+kWPn7LzfEnc99oOIXLcmGy1TIYSrnPf+DvfBZB2ou fFTWvmG8QNyV98r4hIw1rEPjWWSPPxhTx4Lf2Rr5Ngi5QM2neGfcSnvDPTsr9HiG+wJQ 4egkJjoV2f+8m8OvMUr+UizHzBGmCgv6jtZtYHU+Y8+YXBbTiPLeigpoz//bA+IoZPbl eafVLEV0UU89hG1k/SE/9aL3nktBag5bEUYPeCOdWGawYjB+GiiEw5adpZbGAAqqndQC ltVB4GhKikJnjzvxv+yQnSYEFvbzdJwDCsxWaYU4g7LImRc3ADT5ckO21sRa4Lj+fRIl nF1Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=tNniJpfbWeVTMtQpNkYDnMhNac5piaiqsLt7AsjoV2o=; b=MYHH2JAvCl+VuqYd58EzkHZROaI0S747JqyzroooKWVQYr9zWxleG8K77X9udBfNjN hpV+z1+S58qjgUfBoXOMD9rvv3RAMKXGjOzuXevTRVf8Igy5D/RaP3vuJk5jJmHfSjsF KoZnI+/0aTCMHZFEQHc3Vq+HDggZY+JQqBfPxadk0NepNMfsYHZ8OiNITRge0TQw2IlB QK5jKrUEkrrN8wggIA0vUM57lq9fRVQmC7qTZNQFu8aAzx3tBX/hbziUu1fYOeizdUo1 VWdv7WcEA+8BNE/sT2mlT0Qmxq9U7ii53F2cqiJ9OTKVShPL7pITI9v5YaP0rvvjrqmK ZKNw== X-Gm-Message-State: AMCzsaUa0CrX6RZMMtXQrib1BWzg1DSs96UlZFTemP61/lbdP6LjVCLi xhj9XAleD3xRYDlDQvlH9qKLIDFP X-Google-Smtp-Source: AOwi7QBwCF9kS9K9xRqMWUMcJk6pdUbbJ+kG2yCTt2smO0O9U8rmdrQIUxY1JuDJESn+4ymJZN04ow== X-Received: by 10.28.136.83 with SMTP id k80mr16672811wmd.159.1507732581406; Wed, 11 Oct 2017 07:36:21 -0700 (PDT) Received: from 6wind.com (host.78.145.23.62.rev.coltfrance.com. [62.23.145.78]) by smtp.gmail.com with ESMTPSA id b190sm16130783wma.22.2017.10.11.07.36.20 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 11 Oct 2017 07:36:20 -0700 (PDT) From: Adrien Mazarguil To: Ferruh Yigit Cc: dev@dpdk.org Date: Wed, 11 Oct 2017 16:35:06 +0200 Message-Id: X-Mailer: git-send-email 2.1.4 In-Reply-To: References: Subject: [dpdk-dev] [PATCH v1 04/29] net/mlx4: enhance header files comments X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Add missing comments and fix those not Doxygen-friendly. Since the private structure definition is modified, use this opportunity to add one remaining missing include required by one of its fields (sys/queue.h for LIST_HEAD()). Signed-off-by: Adrien Mazarguil Acked-by: Nelio Laranjeiro --- drivers/net/mlx4/mlx4.h | 43 ++++++++++++++++++++------------------ drivers/net/mlx4/mlx4_flow.h | 2 ++ drivers/net/mlx4/mlx4_rxtx.h | 4 ++-- drivers/net/mlx4/mlx4_utils.h | 4 ++-- 4 files changed, 29 insertions(+), 24 deletions(-) diff --git a/drivers/net/mlx4/mlx4.h b/drivers/net/mlx4/mlx4.h index 71cbced..1799951 100644 --- a/drivers/net/mlx4/mlx4.h +++ b/drivers/net/mlx4/mlx4.h @@ -36,6 +36,7 @@ #include #include +#include /* Verbs headers do not support -pedantic. */ #ifdef PEDANTIC @@ -51,13 +52,13 @@ #include #include -/* Request send completion once in every 64 sends, might be less. */ +/** Request send completion once in every 64 sends, might be less. */ #define MLX4_PMD_TX_PER_COMP_REQ 64 -/* Maximum size for inline data. */ +/** Maximum size for inline data. */ #define MLX4_PMD_MAX_INLINE 0 -/* +/** * Maximum number of cached Memory Pools (MPs) per TX queue. Each RTE MP * from which buffers are to be transmitted will have to be mapped by this * driver to their own Memory Region (MR). This is a slow operation. @@ -68,10 +69,10 @@ #define MLX4_PMD_TX_MP_CACHE 8 #endif -/* Interrupt alarm timeout value in microseconds. */ +/** Interrupt alarm timeout value in microseconds. */ #define MLX4_INTR_ALARM_TIMEOUT 100000 -/* Port parameter. */ +/** Port parameter. */ #define MLX4_PMD_PORT_KVARG "port" enum { @@ -84,29 +85,31 @@ enum { PCI_DEVICE_ID_MELLANOX_CONNECTX3PRO = 0x1007, }; +/** Driver name reported to lower layers and used in log output. */ #define MLX4_DRIVER_NAME "net_mlx4" struct rxq; struct txq; struct rte_flow; +/** Private data structure. */ struct priv { - struct rte_eth_dev *dev; /* Ethernet device. */ - struct ibv_context *ctx; /* Verbs context. */ - struct ibv_device_attr device_attr; /* Device properties. */ - struct ibv_pd *pd; /* Protection Domain. */ - struct ether_addr mac; /* MAC address. */ - struct ibv_flow *mac_flow; /* Flow associated with MAC address. */ + struct rte_eth_dev *dev; /**< Ethernet device. */ + struct ibv_context *ctx; /**< Verbs context. */ + struct ibv_device_attr device_attr; /**< Device properties. */ + struct ibv_pd *pd; /**< Protection Domain. */ + struct ether_addr mac; /**< MAC address. */ + struct ibv_flow *mac_flow; /**< Flow associated with MAC address. */ /* Device properties. */ - uint16_t mtu; /* Configured MTU. */ - uint8_t port; /* Physical port number. */ - uint32_t started:1; /* Device started, flows enabled. */ - uint32_t vf:1; /* This is a VF device. */ - uint32_t intr_alarm:1; /* An interrupt alarm is scheduled. */ - uint32_t isolated:1; /* Toggle isolated mode. */ - struct rte_intr_handle intr_handle; /* Port interrupt handle. */ - struct rte_flow_drop *flow_drop_queue; /* Flow drop queue. */ - LIST_HEAD(mlx4_flows, rte_flow) flows; + uint16_t mtu; /**< Configured MTU. */ + uint8_t port; /**< Physical port number. */ + uint32_t started:1; /**< Device started, flows enabled. */ + uint32_t vf:1; /**< This is a VF device. */ + uint32_t intr_alarm:1; /**< An interrupt alarm is scheduled. */ + uint32_t isolated:1; /**< Toggle isolated mode. */ + struct rte_intr_handle intr_handle; /**< Port interrupt handle. */ + struct rte_flow_drop *flow_drop_queue; /**< Flow drop queue. */ + LIST_HEAD(, rte_flow) flows; /**< Configured flow rule handles. */ }; /* mlx4_ethdev.c */ diff --git a/drivers/net/mlx4/mlx4_flow.h b/drivers/net/mlx4/mlx4_flow.h index fbb775d..459030c 100644 --- a/drivers/net/mlx4/mlx4_flow.h +++ b/drivers/net/mlx4/mlx4_flow.h @@ -52,6 +52,7 @@ #include #include +/** PMD-specific (mlx4) definition of a flow rule handle. */ struct rte_flow { LIST_ENTRY(rte_flow) next; /**< Pointer to the next flow structure. */ struct ibv_flow *ibv_flow; /**< Verbs flow. */ @@ -65,6 +66,7 @@ struct mlx4_flow { unsigned int offset; /**< Offset in bytes in the ibv_attr buffer. */ }; +/** Flow rule target descriptor. */ struct mlx4_flow_action { uint32_t drop:1; /**< Target is a drop queue. */ uint32_t queue:1; /**< Target is a receive queue. */ diff --git a/drivers/net/mlx4/mlx4_rxtx.h b/drivers/net/mlx4/mlx4_rxtx.h index fec998a..365b585 100644 --- a/drivers/net/mlx4/mlx4_rxtx.h +++ b/drivers/net/mlx4/mlx4_rxtx.h @@ -85,8 +85,8 @@ struct rxq { /** Tx element. */ struct txq_elt { - struct ibv_send_wr wr; /* Work request. */ - struct ibv_sge sge; /* Scatter/gather element. */ + struct ibv_send_wr wr; /**< Work request. */ + struct ibv_sge sge; /**< Scatter/gather element. */ struct rte_mbuf *buf; /**< Buffer. */ }; diff --git a/drivers/net/mlx4/mlx4_utils.h b/drivers/net/mlx4/mlx4_utils.h index 0fbdc71..b9c02d5 100644 --- a/drivers/net/mlx4/mlx4_utils.h +++ b/drivers/net/mlx4/mlx4_utils.h @@ -49,7 +49,7 @@ * information replace the driver name (MLX4_DRIVER_NAME) in log messages. */ -/* Return the file name part of a path. */ +/** Return the file name part of a path. */ static inline const char * pmd_drv_log_basename(const char *s) { @@ -98,7 +98,7 @@ pmd_drv_log_basename(const char *s) #define WARN(...) PMD_DRV_LOG(WARNING, __VA_ARGS__) #define ERROR(...) PMD_DRV_LOG(ERR, __VA_ARGS__) -/* Allocate a buffer on the stack and fill it with a printf format string. */ +/** Allocate a buffer on the stack and fill it with a printf format string. */ #define MKSTR(name, ...) \ char name[snprintf(NULL, 0, __VA_ARGS__) + 1]; \ \