From f831c63cbe86c3025bc9eeccd329c1d2a6275dd5 Mon Sep 17 00:00:00 2001 From: Intel Date: Thu, 20 Dec 2012 00:00:00 +0100 Subject: [PATCH] ethdev: minor changes Signed-off-by: Intel --- lib/librte_ether/rte_ethdev.c | 154 ++++++++++++---------------------- lib/librte_ether/rte_ethdev.h | 122 ++++++++++++++------------- 2 files changed, 119 insertions(+), 157 deletions(-) diff --git a/lib/librte_ether/rte_ethdev.c b/lib/librte_ether/rte_ethdev.c index 4af45df21a..cfb450a13d 100644 --- a/lib/librte_ether/rte_ethdev.c +++ b/lib/librte_ether/rte_ethdev.c @@ -77,22 +77,16 @@ #define PMD_DEBUG_TRACE(fmt, args...) #endif -/* define two macros for quick checking for restricting functions to primary - * instance only. First macro is for functions returning an int - and therefore - * an error code, second macro is for functions returning null. - */ -#define PROC_PRIMARY_OR_ERR() do { \ +/* Macros for checking for restricting functions to primary instance only */ +#define PROC_PRIMARY_OR_ERR_RET(retval) do { \ if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \ - PMD_DEBUG_TRACE("Cannot run %s in secondary processes\n", \ - __func__); \ - return (-E_RTE_SECONDARY); \ - } \ + PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \ + return (retval); \ + } \ } while(0) - #define PROC_PRIMARY_OR_RET() do { \ if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \ - PMD_DEBUG_TRACE("Cannot run %s in secondary processes\n", \ - __func__); \ + PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \ return; \ } \ } while(0) @@ -158,8 +152,10 @@ rte_eth_dev_allocate(void) { struct rte_eth_dev *eth_dev; - if (nb_ports == RTE_MAX_ETHPORTS) + if (nb_ports == RTE_MAX_ETHPORTS) { + PMD_DEBUG_TRACE("Reached maximum number of ethernet ports\n"); return NULL; + } if (rte_eth_dev_data == NULL) rte_eth_dev_data_alloc(); @@ -184,13 +180,12 @@ rte_eth_dev_init(struct rte_pci_driver *pci_drv, if (eth_dev == NULL) return -ENOMEM; - if (rte_eal_process_type() == RTE_PROC_PRIMARY){ eth_dev->data->dev_private = rte_zmalloc("ethdev private structure", eth_drv->dev_private_size, CACHE_LINE_SIZE); if (eth_dev->data->dev_private == NULL) - return -ENOMEM; + rte_panic("Cannot allocate memzone for private port data\n"); } eth_dev->pci_dev = pci_dev; eth_dev->driver = eth_drv; @@ -256,7 +251,7 @@ rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q, /* This function is only safe when called from the primary process * in a multi-process setup*/ - PROC_PRIMARY_OR_ERR(); + PROC_PRIMARY_OR_ERR_RET(-E_RTE_SECONDARY); if (port_id >= nb_ports || port_id >= RTE_MAX_ETHPORTS) { PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); @@ -269,8 +264,8 @@ rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q, if (dev->data->dev_started) { PMD_DEBUG_TRACE( - "port %d must be stopped to allow configuration", port_id); - return -EBUSY; + "port %d must be stopped to allow configuration\n", port_id); + return (-EBUSY); } /* @@ -280,22 +275,22 @@ rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q, */ (*dev->dev_ops->dev_infos_get)(dev, &dev_info); if (nb_rx_q > dev_info.max_rx_queues) { - PMD_DEBUG_TRACE("ethdev port_id=%d nb_rx_queues=%d > %d", + PMD_DEBUG_TRACE("ethdev port_id=%d nb_rx_queues=%d > %d\n", port_id, nb_rx_q, dev_info.max_rx_queues); return (-EINVAL); } if (nb_rx_q == 0) { - PMD_DEBUG_TRACE("ethdev port_id=%d nb_rx_q == 0", port_id); + PMD_DEBUG_TRACE("ethdev port_id=%d nb_rx_q == 0\n", port_id); return (-EINVAL); } if (nb_tx_q > dev_info.max_tx_queues) { - PMD_DEBUG_TRACE("ethdev port_id=%d nb_tx_queues=%d > %d", + PMD_DEBUG_TRACE("ethdev port_id=%d nb_tx_queues=%d > %d\n", port_id, nb_tx_q, dev_info.max_tx_queues); return (-EINVAL); } if (nb_tx_q == 0) { - PMD_DEBUG_TRACE("ethdev port_id=%d nb_tx_q == 0", port_id); + PMD_DEBUG_TRACE("ethdev port_id=%d nb_tx_q == 0\n", port_id); return (-EINVAL); } @@ -310,7 +305,7 @@ rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q, if (dev_conf->rxmode.max_rx_pkt_len > dev_info.max_rx_pktlen) { PMD_DEBUG_TRACE("ethdev port_id=%d max_rx_pkt_len %u" - " > max valid value %u", + " > max valid value %u\n", port_id, (unsigned)dev_conf->rxmode.max_rx_pkt_len, (unsigned)dev_info.max_rx_pktlen); @@ -326,7 +321,7 @@ rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q, if (nb_rx_q != ETH_VMDQ_DCB_NUM_QUEUES) { PMD_DEBUG_TRACE("ethdev port_id=%d VMDQ+DCB, nb_rx_q " - "!= %d", + "!= %d\n", port_id, ETH_VMDQ_DCB_NUM_QUEUES); return (-EINVAL); } @@ -334,8 +329,7 @@ rte_eth_dev_configure(uint8_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q, if (! (conf->nb_queue_pools == ETH_16_POOLS || conf->nb_queue_pools == ETH_32_POOLS)) { PMD_DEBUG_TRACE("ethdev port_id=%d VMDQ+DCB selected, " - "nb_queue_pools != %d or nb_queue_pools " - "!= %d", + "nb_queue_pools must be %d or %d\n", port_id, ETH_16_POOLS, ETH_32_POOLS); return (-EINVAL); } @@ -401,7 +395,7 @@ rte_eth_dev_start(uint8_t port_id) /* This function is only safe when called from the primary process * in a multi-process setup*/ - PROC_PRIMARY_OR_ERR(); + PROC_PRIMARY_OR_ERR_RET(-E_RTE_SECONDARY); if (port_id >= nb_ports) { PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); @@ -456,6 +450,7 @@ rte_eth_dev_close(uint8_t port_id) } dev = &rte_eth_devices[port_id]; + FUNC_PTR_OR_RET(*dev->dev_ops->dev_close); dev->data->dev_started = 0; (*dev->dev_ops->dev_close)(dev); @@ -473,7 +468,7 @@ rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id, /* This function is only safe when called from the primary process * in a multi-process setup*/ - PROC_PRIMARY_OR_ERR(); + PROC_PRIMARY_OR_ERR_RET(-E_RTE_SECONDARY); if (port_id >= nb_ports) { PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); @@ -487,7 +482,7 @@ rte_eth_rx_queue_setup(uint8_t port_id, uint16_t rx_queue_id, if (dev->data->dev_started) { PMD_DEBUG_TRACE( - "port %d must be stopped to allow configuration", port_id); + "port %d must be stopped to allow configuration\n", port_id); return -EBUSY; } @@ -535,7 +530,7 @@ rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id, /* This function is only safe when called from the primary process * in a multi-process setup*/ - PROC_PRIMARY_OR_ERR(); + PROC_PRIMARY_OR_ERR_RET(-E_RTE_SECONDARY); if (port_id >= nb_ports) { PMD_DEBUG_TRACE("Invalid port_id=%d\n", port_id); @@ -549,7 +544,7 @@ rte_eth_tx_queue_setup(uint8_t port_id, uint16_t tx_queue_id, if (dev->data->dev_started) { PMD_DEBUG_TRACE( - "port %d must be stopped to allow configuration", port_id); + "port %d must be stopped to allow configuration\n", port_id); return -EBUSY; } @@ -779,12 +774,12 @@ rte_eth_dev_vlan_filter(uint8_t port_id, uint16_t vlan_id, int on) PMD_DEBUG_TRACE("port %d: vlan-filtering disabled\n", port_id); return (-ENOSYS); } + if (vlan_id > 4095) { PMD_DEBUG_TRACE("(port_id=%d) invalid vlan_id=%u > 4095\n", port_id, (unsigned) vlan_id); return (-EINVAL); } - FUNC_PTR_OR_ERR_RET(*dev->dev_ops->vlan_filter_set, -ENOTSUP); (*dev->dev_ops->vlan_filter_set)(dev, vlan_id, on); return (0); @@ -814,19 +809,14 @@ rte_eth_dev_fdir_add_signature_filter(uint8_t port_id, || fdir_filter->l4type == RTE_FDIR_L4TYPE_NONE) && (fdir_filter->port_src || fdir_filter->port_dst)) { PMD_DEBUG_TRACE(" Port are meaningless for SCTP and " \ - "None l4type source & destinations ports " \ - "should be null!"); + "None l4type, source & destinations ports " \ + "should be null!\n"); return (-EINVAL); } FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fdir_add_signature_filter, -ENOTSUP); - if (*dev->dev_ops->fdir_add_signature_filter) - return (*dev->dev_ops->fdir_add_signature_filter)(dev, - fdir_filter, - queue); - - PMD_DEBUG_TRACE("port %d: FDIR feature not supported\n", port_id); - return (-ENOTSUP); + return (*dev->dev_ops->fdir_add_signature_filter)(dev, fdir_filter, + queue); } int @@ -853,20 +843,15 @@ rte_eth_dev_fdir_update_signature_filter(uint8_t port_id, || fdir_filter->l4type == RTE_FDIR_L4TYPE_NONE) && (fdir_filter->port_src || fdir_filter->port_dst)) { PMD_DEBUG_TRACE(" Port are meaningless for SCTP and " \ - "None l4type source & destinations ports " \ - "should be null!"); + "None l4type, source & destinations ports " \ + "should be null!\n"); return (-EINVAL); } FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fdir_update_signature_filter, -ENOTSUP); - if (*dev->dev_ops->fdir_update_signature_filter) - return (*dev->dev_ops->fdir_update_signature_filter)(dev, - fdir_filter, - queue); + return (*dev->dev_ops->fdir_update_signature_filter)(dev, fdir_filter, + queue); - - PMD_DEBUG_TRACE("port %d: FDIR feature not supported\n", port_id); - return (-ENOTSUP); } int @@ -893,17 +878,12 @@ rte_eth_dev_fdir_remove_signature_filter(uint8_t port_id, && (fdir_filter->port_src || fdir_filter->port_dst)) { PMD_DEBUG_TRACE(" Port are meaningless for SCTP and " \ "None l4type source & destinations ports " \ - "should be null!"); + "should be null!\n"); return (-EINVAL); } FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fdir_remove_signature_filter, -ENOTSUP); - if (*dev->dev_ops->fdir_remove_signature_filter) - return (*dev->dev_ops->fdir_remove_signature_filter)(dev, - fdir_filter); - - PMD_DEBUG_TRACE("port %d: FDIR feature not supported\n", port_id); - return (-ENOTSUP); + return (*dev->dev_ops->fdir_remove_signature_filter)(dev, fdir_filter); } int @@ -923,13 +903,9 @@ rte_eth_dev_fdir_get_infos(uint8_t port_id, struct rte_eth_fdir *fdir) } FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fdir_infos_get, -ENOTSUP); - if (*dev->dev_ops->fdir_infos_get) { - (*dev->dev_ops->fdir_infos_get)(dev, fdir); - return (0); - } - PMD_DEBUG_TRACE("port %d: FDIR feature not supported\n", port_id); - return (-ENOTSUP); + (*dev->dev_ops->fdir_infos_get)(dev, fdir); + return (0); } int @@ -957,8 +933,8 @@ rte_eth_dev_fdir_add_perfect_filter(uint8_t port_id, || fdir_filter->l4type == RTE_FDIR_L4TYPE_NONE) && (fdir_filter->port_src || fdir_filter->port_dst)) { PMD_DEBUG_TRACE(" Port are meaningless for SCTP and " \ - "None l4type source & destinations ports " \ - "should be null!"); + "None l4type, source & destinations ports " \ + "should be null!\n"); return (-EINVAL); } @@ -967,13 +943,9 @@ rte_eth_dev_fdir_add_perfect_filter(uint8_t port_id, return (-ENOTSUP); FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fdir_add_perfect_filter, -ENOTSUP); - if (*dev->dev_ops->fdir_add_perfect_filter) - return (*dev->dev_ops->fdir_add_perfect_filter)(dev, fdir_filter, + return (*dev->dev_ops->fdir_add_perfect_filter)(dev, fdir_filter, soft_id, queue, drop); - - PMD_DEBUG_TRACE("port %d: FDIR feature not supported\n", port_id); - return (-ENOTSUP); } int @@ -1001,8 +973,8 @@ rte_eth_dev_fdir_update_perfect_filter(uint8_t port_id, || fdir_filter->l4type == RTE_FDIR_L4TYPE_NONE) && (fdir_filter->port_src || fdir_filter->port_dst)) { PMD_DEBUG_TRACE(" Port are meaningless for SCTP and " \ - "None l4type source & destinations ports " \ - "should be null!"); + "None l4type, source & destinations ports " \ + "should be null!\n"); return (-EINVAL); } @@ -1011,15 +983,8 @@ rte_eth_dev_fdir_update_perfect_filter(uint8_t port_id, return (-ENOTSUP); FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fdir_update_perfect_filter, -ENOTSUP); - if (*dev->dev_ops->fdir_update_perfect_filter) - return (*dev->dev_ops->fdir_update_perfect_filter)(dev, - fdir_filter, - soft_id, - queue, - drop); - - PMD_DEBUG_TRACE("port %d: FDIR feature not supported\n", port_id); - return (-ENOTSUP); + return (*dev->dev_ops->fdir_update_perfect_filter)(dev, fdir_filter, + soft_id, queue, drop); } int @@ -1046,8 +1011,8 @@ rte_eth_dev_fdir_remove_perfect_filter(uint8_t port_id, || fdir_filter->l4type == RTE_FDIR_L4TYPE_NONE) && (fdir_filter->port_src || fdir_filter->port_dst)) { PMD_DEBUG_TRACE(" Port are meaningless for SCTP and " \ - "None l4type source & destinations ports " \ - "should be null!"); + "None l4type, source & destinations ports " \ + "should be null!\n"); return (-EINVAL); } @@ -1056,13 +1021,8 @@ rte_eth_dev_fdir_remove_perfect_filter(uint8_t port_id, return (-ENOTSUP); FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fdir_remove_perfect_filter, -ENOTSUP); - if (*dev->dev_ops->fdir_remove_perfect_filter) - return (*dev->dev_ops->fdir_remove_perfect_filter)(dev, - fdir_filter, - soft_id); - - PMD_DEBUG_TRACE("port %d: FDIR feature not supported\n", port_id); - return -ENOTSUP; + return (*dev->dev_ops->fdir_remove_perfect_filter)(dev, fdir_filter, + soft_id); } int @@ -1086,12 +1046,7 @@ rte_eth_dev_fdir_set_masks(uint8_t port_id, struct rte_fdir_masks *fdir_mask) return (-ENOTSUP); FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fdir_set_masks, -ENOTSUP); - if (*dev->dev_ops->fdir_set_masks) - return (*dev->dev_ops->fdir_set_masks)(dev, fdir_mask); - - PMD_DEBUG_TRACE("port %d: FDIR feature not supported\n", - port_id); - return -ENOTSUP; + return (*dev->dev_ops->fdir_set_masks)(dev, fdir_mask); } int @@ -1130,7 +1085,6 @@ rte_eth_led_on(uint8_t port_id) } dev = &rte_eth_devices[port_id]; - FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_led_on, -ENOTSUP); return ((*dev->dev_ops->dev_led_on)(dev)); } @@ -1146,7 +1100,6 @@ rte_eth_led_off(uint8_t port_id) } dev = &rte_eth_devices[port_id]; - FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_led_off, -ENOTSUP); return ((*dev->dev_ops->dev_led_off)(dev)); } @@ -1185,8 +1138,8 @@ rte_eth_dev_mac_addr_add(uint8_t port_id, struct ether_addr *addr, return (-ENODEV); } dev = &rte_eth_devices[port_id]; - FUNC_PTR_OR_ERR_RET(*dev->dev_ops->mac_addr_add, -ENOTSUP); + if (is_zero_ether_addr(addr)) { PMD_DEBUG_TRACE("port %d: Cannot add NULL MAC address\n", port_id); return (-EINVAL); @@ -1223,8 +1176,8 @@ rte_eth_dev_mac_addr_remove(uint8_t port_id, struct ether_addr *addr) return (-ENODEV); } dev = &rte_eth_devices[port_id]; - FUNC_PTR_OR_ERR_RET(*dev->dev_ops->mac_addr_remove, -ENOTSUP); + index = get_mac_addr_index(port_id, addr); if (index == 0) { PMD_DEBUG_TRACE("port %d: Cannot remove default MAC address\n", port_id); @@ -1253,7 +1206,6 @@ rte_eth_rx_burst(uint8_t port_id, uint16_t queue_id, return 0; } dev = &rte_eth_devices[port_id]; - FUNC_PTR_OR_ERR_RET(*dev->rx_pkt_burst, -ENOTSUP); if (queue_id >= dev->data->nb_rx_queues) { PMD_DEBUG_TRACE("Invalid RX queue_id=%d\n", queue_id); diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h index 048035750b..ef835d4799 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -120,7 +120,6 @@ * Any other configuration will not be stored and will need to be re-entered * after a call to rte_eth_dev_start(). * - * * Finally, a network application can close an Ethernet device by invoking the * rte_eth_dev_close() function. * @@ -239,13 +238,13 @@ enum rte_eth_rx_mq_mode { struct rte_eth_rxmode { /** The multi-queue packet distribution mode to be used, e.g. RSS. */ enum rte_eth_rx_mq_mode mq_mode; - uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */ - uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/ - uint8_t header_split : 1, /**< Header Split enable. */ - hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */ - hw_vlan_filter : 1, /**< VLAN filter enable. */ - jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */ - hw_strip_crc : 1; /**< Enable CRC stripping by hardware. */ + uint32_t max_rx_pkt_len; /**< Only used if jumbo_frame enabled. */ + uint16_t split_hdr_size; /**< hdr buf size (header_split enabled).*/ + uint8_t header_split : 1, /**< Header Split enable. */ + hw_ip_checksum : 1, /**< IP/UDP/TCP checksum offload enable. */ + hw_vlan_filter : 1, /**< VLAN filter enable. */ + jumbo_frame : 1, /**< Jumbo Frame Receipt enable. */ + hw_strip_crc : 1; /**< Enable CRC stripping by hardware. */ }; /** @@ -409,10 +408,10 @@ struct rte_fdir_conf { * Possible l4type of FDIR filters. */ enum rte_l4type { - RTE_FDIR_L4TYPE_NONE = 0, /**< Nnoe. */ + RTE_FDIR_L4TYPE_NONE = 0, /**< None. */ RTE_FDIR_L4TYPE_UDP, /**< UDP. */ RTE_FDIR_L4TYPE_TCP, /**< TCP. */ - RTE_FDIR_L4TYPE_SCTP, /**< SCTP. */ + RTE_FDIR_L4TYPE_SCTP, /**< SCTP. */ }; /** @@ -446,33 +445,38 @@ struct rte_fdir_filter { /** * A structure used to configure FDIR masks that are used by the device * to match the various fields of RX packet headers. + * @note The only_ip_flow field has the opposite meaning compared to other + * masks! */ struct rte_fdir_masks { - /** When set to 1, packet l4type is not relevant in filters, and + /** When set to 1, packet l4type is \b NOT relevant in filters, and source and destination port masks must be set to zero. */ uint8_t only_ip_flow; - uint8_t vlan_id; /**< If set to 1, vlan_id is relevant in filters. */ - uint8_t vlan_prio; /**< If set to 1, vlan_prio is relevant in filters. */ - uint8_t flexbytes; /**< If set to 1, flexbytes is relevant in filters. */ + /** If set to 1, vlan_id is relevant in filters. */ + uint8_t vlan_id; + /** If set to 1, vlan_prio is relevant in filters. */ + uint8_t vlan_prio; + /** If set to 1, flexbytes is relevant in filters. */ + uint8_t flexbytes; /** Mask of Destination IPv4 Address. All bits set to 1 define the - relevant bits to use in the destination address of an IPv4 packet - when matching it against FDIR filters. */ + relevant bits to use in the destination address of an IPv4 packet + when matching it against FDIR filters. */ uint32_t dst_ipv4_mask; /** Mask of Source IPv4 Address. All bits set to 1 define - the relevant bits to use in the source address of an IPv4 packet - when matching it against FDIR filters. */ + the relevant bits to use in the source address of an IPv4 packet + when matching it against FDIR filters. */ uint32_t src_ipv4_mask; /** Mask of Source IPv6 Address. All bits set to 1 define the - relevant BYTES to use in the source address of an IPv6 packet - when matching it against FDIR filters. */ + relevant BYTES to use in the source address of an IPv6 packet + when matching it against FDIR filters. */ uint16_t src_ipv6_mask; /** Mask of Source Port. All bits set to 1 define the relevant - bits to use in the source port of an IP packets when matching it - against FDIR filters. */ + bits to use in the source port of an IP packets when matching it + against FDIR filters. */ uint16_t src_port_mask; /** Mask of Destination Port. All bits set to 1 define the relevant - bits to use in the destination port of an IP packet when matching it - against FDIR filters. */ + bits to use in the destination port of an IP packet when matching it + against FDIR filters. */ uint16_t dst_port_mask; }; @@ -559,43 +563,43 @@ TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback); typedef int (*eth_dev_configure_t)(struct rte_eth_dev *dev, uint16_t nb_rx_q, uint16_t nb_tx_q); -/**< Ethernet device configuration. */ +/**< @internal Ethernet device configuration. */ typedef int (*eth_dev_start_t)(struct rte_eth_dev *dev); -/**< Function used to start a configured Ethernet device. */ +/**< @internal Function used to start a configured Ethernet device. */ typedef void (*eth_dev_stop_t)(struct rte_eth_dev *dev); -/**< Function used to stop a configured Ethernet device. */ +/**< @internal Function used to stop a configured Ethernet device. */ typedef void (*eth_dev_close_t)(struct rte_eth_dev *dev); /**< @internal Function used to close a configured Ethernet device. */ typedef void (*eth_promiscuous_enable_t)(struct rte_eth_dev *dev); -/**< Function used to enable the RX promiscuous mode of an Ethernet device. */ +/**< @internal Function used to enable the RX promiscuous mode of an Ethernet device. */ typedef void (*eth_promiscuous_disable_t)(struct rte_eth_dev *dev); -/**< Function used to disable the RX promiscuous mode of an Ethernet device. */ +/**< @internal Function used to disable the RX promiscuous mode of an Ethernet device. */ typedef void (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev); -/**< Enable the receipt of all multicast packets by an Ethernet device. */ +/**< @internal Enable the receipt of all multicast packets by an Ethernet device. */ typedef void (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev); -/**< Disable the receipt of all multicast packets by an Ethernet device. */ +/**< @internal Disable the receipt of all multicast packets by an Ethernet device. */ typedef int (*eth_link_update_t)(struct rte_eth_dev *dev, int wait_to_complete); -/**< Get link speed, duplex mode and state (up/down) of an Ethernet device. */ +/**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */ typedef void (*eth_stats_get_t)(struct rte_eth_dev *dev, struct rte_eth_stats *igb_stats); -/**< Get global I/O statistics of an Ethernet device. */ +/**< @internal Get global I/O statistics of an Ethernet device. */ typedef void (*eth_stats_reset_t)(struct rte_eth_dev *dev); -/**< Reset global I/O statistics of an Ethernet device to 0. */ +/**< @internal Reset global I/O statistics of an Ethernet device to 0. */ typedef void (*eth_dev_infos_get_t)(struct rte_eth_dev *dev, struct rte_eth_dev_info *dev_info); -/**< Get specific informations of an Ethernet device. */ +/**< @internal Get specific informations of an Ethernet device. */ typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev, uint16_t rx_queue_id, @@ -603,90 +607,90 @@ typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev, unsigned int socket_id, const struct rte_eth_rxconf *rx_conf, struct rte_mempool *mb_pool); -/**< Set up a receive queue of an Ethernet device. */ +/**< @internal Set up a receive queue of an Ethernet device. */ typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev, uint16_t tx_queue_id, uint16_t nb_tx_desc, unsigned int socket_id, const struct rte_eth_txconf *tx_conf); -/**< Setup a transmit queue of an Ethernet device. */ +/**< @internal Setup a transmit queue of an Ethernet device. */ typedef void (*vlan_filter_set_t)(struct rte_eth_dev *dev, uint16_t vlan_id, int on); -/**< Enable/Disable filtering of a VLAN Tag Identifier by an Ethernet device. */ +/**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */ typedef uint16_t (*eth_rx_burst_t)(struct igb_rx_queue *rxq, struct rte_mbuf **rx_pkts, uint16_t nb_pkts); -/**< Retrieve input packets from a receive queue of an Ethernet device. */ +/**< @internal Retrieve input packets from a receive queue of an Ethernet device. */ typedef uint16_t (*eth_tx_burst_t)(struct igb_tx_queue *txq, struct rte_mbuf **tx_pkts, uint16_t nb_pkts); -/**< Send output packets on a transmit queue of an Ethernet device. */ +/**< @internal Send output packets on a transmit queue of an Ethernet device. */ typedef int (*fdir_add_signature_filter_t)(struct rte_eth_dev *dev, struct rte_fdir_filter *fdir_ftr, uint8_t rx_queue); -/**< Setup a new signature filter rule on an Ethernet device */ +/**< @internal Setup a new signature filter rule on an Ethernet device */ typedef int (*fdir_update_signature_filter_t)(struct rte_eth_dev *dev, struct rte_fdir_filter *fdir_ftr, uint8_t rx_queue); -/**< Update a signature filter rule on an Ethernet device */ +/**< @internal Update a signature filter rule on an Ethernet device */ typedef int (*fdir_remove_signature_filter_t)(struct rte_eth_dev *dev, struct rte_fdir_filter *fdir_ftr); -/**< Remove a signature filter rule on an Ethernet device */ +/**< @internal Remove a signature filter rule on an Ethernet device */ typedef void (*fdir_infos_get_t)(struct rte_eth_dev *dev, struct rte_eth_fdir *fdir); -/**< Get information about fdir status */ +/**< @internal Get information about fdir status */ typedef int (*fdir_add_perfect_filter_t)(struct rte_eth_dev *dev, struct rte_fdir_filter *fdir_ftr, uint16_t soft_id, uint8_t rx_queue, uint8_t drop); -/**< Setup a new perfect filter rule on an Ethernet device */ +/**< @internal Setup a new perfect filter rule on an Ethernet device */ typedef int (*fdir_update_perfect_filter_t)(struct rte_eth_dev *dev, struct rte_fdir_filter *fdir_ftr, uint16_t soft_id, uint8_t rx_queue, uint8_t drop); -/**< Update a perfect filter rule on an Ethernet device */ +/**< @internal Update a perfect filter rule on an Ethernet device */ typedef int (*fdir_remove_perfect_filter_t)(struct rte_eth_dev *dev, struct rte_fdir_filter *fdir_ftr, uint16_t soft_id); -/**< Remove a perfect filter rule on an Ethernet device */ +/**< @internal Remove a perfect filter rule on an Ethernet device */ typedef int (*fdir_set_masks_t)(struct rte_eth_dev *dev, struct rte_fdir_masks *fdir_masks); -/**< Setup flow director masks on an Ethernet device */ +/**< @internal Setup flow director masks on an Ethernet device */ typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev, struct rte_eth_fc_conf *fc_conf); -/**< Setup flow control parameter on an Ethernet device */ +/**< @internal Setup flow control parameter on an Ethernet device */ typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev); -/**< Turn on SW controllable LED on an Ethernet device */ +/**< @internal Turn on SW controllable LED on an Ethernet device */ typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev); -/**< Turn off SW controllable LED on an Ethernet device */ +/**< @internal Turn off SW controllable LED on an Ethernet device */ typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index); -/**< Remove MAC address from receive address register */ +/**< @internal Remove MAC address from receive address register */ typedef void (*eth_mac_addr_add_t)(struct rte_eth_dev *dev, struct ether_addr *mac_addr, uint32_t index, uint32_t vmdq); -/**< Set a MAC address into Receive Address Address Register */ +/**< @internal Set a MAC address into Receive Address Address Register */ /** - * A structure containing the functions exported by an Ethernet driver. + * @internal A structure containing the functions exported by an Ethernet driver. */ struct eth_dev_ops { eth_dev_configure_t dev_configure; /**< Configure device. */ @@ -701,7 +705,7 @@ struct eth_dev_ops { eth_stats_get_t stats_get; /**< Get device statistics. */ eth_stats_reset_t stats_reset; /**< Reset device statistics. */ eth_dev_infos_get_t dev_infos_get; /**< Get device info. */ - vlan_filter_set_t vlan_filter_set; /**< Filter VLAN on/off. */ + vlan_filter_set_t vlan_filter_set; /**< Filter VLAN Setup. */ eth_rx_queue_setup_t rx_queue_setup;/**< Set up device RX queue.*/ eth_tx_queue_setup_t tx_queue_setup;/**< Set up device TX queue.*/ eth_dev_led_on_t dev_led_on; /**< Turn on LED. */ @@ -729,6 +733,7 @@ struct eth_dev_ops { }; /** + * @internal * The generic data structure associated with each ethernet device. * * Pointers to burst-oriented packet receive and transmit functions are @@ -748,6 +753,7 @@ struct rte_eth_dev { }; /** + * @internal * The data part, with no function pointers, associated with each ethernet device. * * This structure is safe to place in shared memory to be common among different @@ -777,6 +783,7 @@ struct rte_eth_dev_data { }; /** + * @internal * The pool of *rte_eth_dev* structures. The size of the pool * is configured at compile-time in the file. */ @@ -795,6 +802,7 @@ extern uint8_t rte_eth_dev_count(void); struct eth_driver; /** + * @internal * Initialization function of an Ethernet driver invoked for each matching * Ethernet PCI device detected during the PCI probing phase. * @@ -829,6 +837,7 @@ typedef int (*eth_dev_init_t)(struct eth_driver *eth_drv, struct rte_eth_dev *eth_dev); /** + * @internal * The structure associated with a PMD Ethernet driver. * * Each Ethernet driver acts as a PCI driver and is represented by a generic @@ -847,6 +856,7 @@ struct eth_driver { }; /** + * @internal * A function invoked by the initialization function of an Ethernet driver * to simultaneously register itself as a PCI driver and as an Ethernet * Poll Mode Driver (PMD). @@ -1755,7 +1765,7 @@ int rte_eth_led_off(uint8_t port_id); * The pointer to the structure of the flow control parameters. * @return * - (0) if successful. - * - (-ENOTSUP) if hardware doesn't support flow director mode. + * - (-ENOTSUP) if hardware doesn't support flow control mode. * - (-ENODEV) if *port_id* invalid. * - (-EINVAL) if bad parameter * - (-EIO) if flow control setup failure -- 2.20.1