[dpdk-dev,v8,1/5] ethdev: add firmware version get
Checks
Commit Message
This patch adds a new API 'rte_eth_dev_fw_version_get' for
fetching firmware version by a given device.
Signed-off-by: Qiming Yang <qiming.yang@intel.com>
Acked-by: Remy Horton <remy.horton@intel.com>
---
doc/guides/nics/features/default.ini | 1 +
doc/guides/rel_notes/deprecation.rst | 4 ----
doc/guides/rel_notes/release_17_02.rst | 5 +++++
lib/librte_ether/rte_ethdev.c | 12 ++++++++++++
lib/librte_ether/rte_ethdev.h | 25 +++++++++++++++++++++++++
lib/librte_ether/rte_ether_version.map | 1 +
6 files changed, 44 insertions(+), 4 deletions(-)
Comments
2017-01-12 14:31, Qiming Yang:
> + * @param fw_size
> + * The size of the array pointed by fw_version, which should be
> + * large enough to store firmware version of the device.
> + * @return
> + * - (0) if successful.
> + * - (-ENOTSUP) if operation is not supported.
> + * - (-ENODEV) if *port_id* invalid.
> + * - (-EINVAL) if *fw_size* is not enough to store firmware version.
> + */
> +int rte_eth_dev_fw_version_get(uint8_t port_id,
> + char *fw_version, size_t fw_size);
> +
How to know the required size?
You should return the size of the non truncated string as snprintf does.
Note: Andrew Rybchenko already commented on it and you didn't reply.
v9: - when fw_size is insufficient, return the size of the non truncated
string as snprintf does.
v8: - defined the minimum fw version size as a macro.
v7: - rebased
v6: - renamed fw_length -> fw_size
- added return value for insufficient fw_size
- fixed the indentation problem in e1000
- added ver.build.patch in i40e, keep the same with Linux kernel driver
v5: - modified the API rte_eth_dev_fw_version_get(uint8_t port_id,
char *fw_version, int fw_length).
v4: - removed deprecation notice
- renamed API as rte_eth_dev_fw_version_get
- splited bus info print from this patch set
v3: - changed API, use rte_eth_dev_fw_info_get(uint8_t port_id,
uint32_t *fw_major, uint32_t *fw_minor, uint32_t *fw_patch,
uint32_t *etrack_id)
- added statusment in /doc/guides/nics/features/default.ini and
release_17_02.rst
v2: - fixed commit log
Now, the example ethtool can only show the driver information. From
customers' point of view, it should be better if we can have the same
way that the Linux kernel ethtool does to show firmware version.
These five patches added a new function ``rte_eth_dev_fw_version_get()``
to fetch firmware version related information and implement the
display in example ethtool.
Qiming Yang (5):
ethdev: add firmware version get
net/e1000: add firmware version get
net/ixgbe: add firmware version get
net/i40e: add firmware version get
ethtool: display firmware version
doc/guides/nics/features/default.ini | 1 +
doc/guides/nics/features/i40e.ini | 1 +
doc/guides/nics/features/igb.ini | 1 +
doc/guides/nics/features/ixgbe.ini | 1 +
doc/guides/rel_notes/deprecation.rst | 4 ---
doc/guides/rel_notes/release_17_02.rst | 5 +++
drivers/net/e1000/igb_ethdev.c | 56 ++++++++++++++++++++++++++++++++++
drivers/net/i40e/i40e_ethdev.c | 32 +++++++++++++++++++
drivers/net/ixgbe/ixgbe_ethdev.c | 25 +++++++++++++++
examples/ethtool/ethtool-app/ethapp.c | 1 +
examples/ethtool/lib/rte_ethtool.c | 9 ++++++
lib/librte_ether/rte_ethdev.c | 12 ++++++++
lib/librte_ether/rte_ethdev.h | 26 ++++++++++++++++
lib/librte_ether/rte_ether_version.map | 1 +
14 files changed, 171 insertions(+), 4 deletions(-)
v10:- highlighted that terminating null is included in the output string array.
removed the warning message in drivers.
v9: - when fw_size is insufficient, return the size of the non truncated
string as snprintf does.
v8: - defined the minimum fw version size as a macro.
v7: - rebased
v6: - renamed fw_length -> fw_size
- added return value for insufficient fw_size
- fixed the indentation problem in e1000
- added ver.build.patch in i40e, keep the same with Linux kernel driver
v5: - modified the API rte_eth_dev_fw_version_get(uint8_t port_id,
char *fw_version, int fw_length).
v4: - removed deprecation notice
- renamed API as rte_eth_dev_fw_version_get
- splited bus info print from this patch set
v3: - changed API, use rte_eth_dev_fw_info_get(uint8_t port_id,
uint32_t *fw_major, uint32_t *fw_minor, uint32_t *fw_patch,
uint32_t *etrack_id)
- added statusment in /doc/guides/nics/features/default.ini and
release_17_02.rst
v2: - fixed commit log
Now, the example ethtool can only show the driver information. From
customers' point of view, it should be better if we can have the same
way that the Linux kernel ethtool does to show firmware version.
These five patches added a new function ``rte_eth_dev_fw_version_get()``
to fetch firmware version related information and implement the
display in example ethtool.
Qiming Yang (5):
ethdev: add firmware version get
net/e1000: add firmware version get
net/ixgbe: add firmware version get
net/i40e: add firmware version get
ethtool: display firmware version
doc/guides/nics/features/default.ini | 1 +
doc/guides/nics/features/i40e.ini | 1 +
doc/guides/nics/features/igb.ini | 1 +
doc/guides/nics/features/ixgbe.ini | 1 +
doc/guides/rel_notes/deprecation.rst | 4 ---
doc/guides/rel_notes/release_17_02.rst | 5 ++++
drivers/net/e1000/igb_ethdev.c | 55 ++++++++++++++++++++++++++++++++++
drivers/net/i40e/i40e_ethdev.c | 31 +++++++++++++++++++
drivers/net/ixgbe/ixgbe_ethdev.c | 24 +++++++++++++++
examples/ethtool/ethtool-app/ethapp.c | 1 +
examples/ethtool/lib/rte_ethtool.c | 9 ++++++
lib/librte_ether/rte_ethdev.c | 12 ++++++++
lib/librte_ether/rte_ethdev.h | 26 ++++++++++++++++
lib/librte_ether/rte_ether_version.map | 1 +
14 files changed, 168 insertions(+), 4 deletions(-)
> Qiming Yang (5):
> ethdev: add firmware version get
> net/e1000: add firmware version get
> net/ixgbe: add firmware version get
> net/i40e: add firmware version get
> ethtool: display firmware version
Applied, thanks
@@ -50,6 +50,7 @@ Timesync =
Basic stats =
Extended stats =
Stats per queue =
+FW version =
EEPROM dump =
Registers dump =
Multiprocess aware =
@@ -30,10 +30,6 @@ Deprecation Notices
``nb_seg_max`` and ``nb_mtu_seg_max`` providing information about number of
segments limit to be transmitted by device for TSO/non-TSO packets.
-* In 17.02 ABI change is planned: the ``rte_eth_dev_info`` structure
- will be extended with a new member ``fw_version`` in order to store
- the NIC firmware version.
-
* ethdev: an API change is planned for 17.02 for the function
``_rte_eth_dev_callback_process``. In 17.02 the function will return an ``int``
instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
@@ -66,6 +66,11 @@ New Features
Support for Mellanox ConnectX-5 family of 10/25/40/50/100 Gbps adapters
has been added to the existing mlx5 PMD.
+* **Added firmware version get API.**
+
+ Added a new function ``rte_eth_dev_fw_version_get()`` to fetch firmware
+ version by a given device.
+
Resolved Issues
---------------
@@ -1588,6 +1588,18 @@ rte_eth_dev_set_rx_queue_stats_mapping(uint8_t port_id, uint16_t rx_queue_id,
STAT_QMAP_RX);
}
+int
+rte_eth_dev_fw_version_get(uint8_t port_id, char *fw_version, size_t fw_size)
+{
+ struct rte_eth_dev *dev;
+
+ RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+ dev = &rte_eth_devices[port_id];
+
+ RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fw_version_get, -ENOTSUP);
+ return (*dev->dev_ops->fw_version_get)(dev, fw_version, fw_size);
+}
+
void
rte_eth_dev_info_get(uint8_t port_id, struct rte_eth_dev_info *dev_info)
{
@@ -1177,6 +1177,10 @@ typedef uint32_t (*eth_rx_queue_count_t)(struct rte_eth_dev *dev,
typedef int (*eth_rx_descriptor_done_t)(void *rxq, uint16_t offset);
/**< @internal Check DD bit of specific RX descriptor */
+typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
+ char *fw_version, size_t fw_size);
+/**< @internal Get firmware information of an Ethernet device. */
+
typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
@@ -1459,6 +1463,7 @@ struct eth_dev_ops {
eth_dev_infos_get_t dev_infos_get; /**< Get device info. */
eth_rxq_info_get_t rxq_info_get; /**< retrieve RX queue information. */
eth_txq_info_get_t txq_info_get; /**< retrieve TX queue information. */
+ eth_fw_version_get_t fw_version_get; /**< Get firmware version. */
eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
/**< Get packet types supported and identified by device. */
@@ -2396,6 +2401,26 @@ void rte_eth_macaddr_get(uint8_t port_id, struct ether_addr *mac_addr);
void rte_eth_dev_info_get(uint8_t port_id, struct rte_eth_dev_info *dev_info);
/**
+ * Retrieve the firmware version of a device.
+ *
+ * @param port_id
+ * The port identifier of the device.
+ * @param fw_version
+ * A array pointer to store the firmware version of a device,
+ * allocated by caller.
+ * @param fw_size
+ * The size of the array pointed by fw_version, which should be
+ * large enough to store firmware version of the device.
+ * @return
+ * - (0) if successful.
+ * - (-ENOTSUP) if operation is not supported.
+ * - (-ENODEV) if *port_id* invalid.
+ * - (-EINVAL) if *fw_size* is not enough to store firmware version.
+ */
+int rte_eth_dev_fw_version_get(uint8_t port_id,
+ char *fw_version, size_t fw_size);
+
+/**
* Retrieve the supported packet types of an Ethernet device.
*
* When a packet type is announced as supported, it *must* be recognized by
@@ -146,6 +146,7 @@ DPDK_17.02 {
global:
_rte_eth_dev_reset;
+ rte_eth_dev_fw_version_get;
rte_flow_create;
rte_flow_destroy;
rte_flow_flush;