ixgbe: convert to use of PMD_REGISTER_DRIVER and fix linking
[dpdk.git] / lib / librte_ether / rte_ethdev.h
index 002535a..9621be7 100644 (file)
@@ -1,7 +1,7 @@
 /*-
  *   BSD LICENSE
  * 
- *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
+ *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
  *   All rights reserved.
  * 
  *   Redistribution and use in source and binary forms, with or without
@@ -192,6 +192,10 @@ struct rte_eth_stats {
        uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
        uint64_t fdirmatch; /**< Total number of RX packets matching a filter. */
        uint64_t fdirmiss;  /**< Total number of RX packets not matching any filter. */
+       uint64_t tx_pause_xon;  /**< Total nb. of XON pause frame sent. */
+       uint64_t rx_pause_xon;  /**< Total nb. of XON pause frame received. */
+       uint64_t tx_pause_xoff; /**< Total nb. of XOFF pause frame sent. */
+       uint64_t rx_pause_xoff; /**< Total nb. of XOFF pause frame received. */
        uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
        /**< Total number of queue RX packets. */
        uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
@@ -540,6 +544,7 @@ struct rte_eth_fc_conf {
        uint16_t pause_time;  /**< Pause quota in the Pause frame */
        uint16_t send_xon;    /**< Is XON frame need be sent */
        enum rte_eth_fc_mode mode;  /**< Link flow control mode */
+       uint8_t mac_ctrl_frame_fwd; /**< Forward MAC control frames */
 };
 
 /**
@@ -724,6 +729,11 @@ struct rte_eth_conf {
        /**< ETH_LINK_[HALF_DUPLEX|FULL_DUPLEX], or 0 for autonegotation */
        struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
        struct rte_eth_txmode txmode; /**< Port TX configuration. */
+       uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
+                                is 0, meaning the loopback mode is disabled.
+                                Read the datasheet of given ethernet controller
+                                for details. The possible values of this field
+                                are defined in implementation of each driver. */
        union {
                struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
                struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
@@ -753,9 +763,32 @@ struct rte_eth_conf {
  * an Ethernet device, such as the controlling driver of the device,
  * its PCI context, etc...
  */
+
+/**
+ * RX offload capabilities of a device.
+ */
+#define DEV_RX_OFFLOAD_VLAN_STRIP  0x00000001
+#define DEV_RX_OFFLOAD_IPV4_CKSUM  0x00000002
+#define DEV_RX_OFFLOAD_UDP_CKSUM   0x00000004
+#define DEV_RX_OFFLOAD_TCP_CKSUM   0x00000008
+#define DEV_RX_OFFLOAD_TCP_LRO     0x00000010
+
+/**
+ * TX offload capabilities of a device.
+ */
+#define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
+#define DEV_TX_OFFLOAD_IPV4_CKSUM  0x00000002
+#define DEV_TX_OFFLOAD_UDP_CKSUM   0x00000004
+#define DEV_TX_OFFLOAD_TCP_CKSUM   0x00000008
+#define DEV_TX_OFFLOAD_SCTP_CKSUM  0x00000010
+#define DEV_TX_OFFLOAD_TCP_TSO     0x00000020
+#define DEV_TX_OFFLOAD_UDP_TSO     0x00000040
+
 struct rte_eth_dev_info {
        struct rte_pci_device *pci_dev; /**< Device PCI information. */
        const char *driver_name; /**< Device Driver name. */
+       unsigned int if_index; /**< Index to bound host interface, or 0 if none.
+               Use if_indextoname() to translate into an interface name. */
        uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
        uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
        uint16_t max_rx_queues; /**< Maximum number of RX queues. */
@@ -765,6 +798,8 @@ struct rte_eth_dev_info {
        /** Maximum number of hash MAC addresses for MTA and UTA. */
        uint16_t max_vfs; /**< Maximum number of VFs. */
        uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
+       uint32_t rx_offload_capa; /**< Device RX offload capabilities. */
+       uint32_t tx_offload_capa; /**< Device TX offload capabilities. */
 };
 
 struct rte_eth_dev;
@@ -987,6 +1022,61 @@ typedef int (*eth_mirror_rule_reset_t)(struct rte_eth_dev *dev,
                                  uint8_t rule_id);
 /**< @internal Remove a traffic mirroring rule on an Ethernet device */
 
+#ifdef RTE_NIC_BYPASS
+
+enum {
+       RTE_BYPASS_MODE_NONE,
+       RTE_BYPASS_MODE_NORMAL,
+       RTE_BYPASS_MODE_BYPASS,
+       RTE_BYPASS_MODE_ISOLATE,
+       RTE_BYPASS_MODE_NUM,
+};
+
+#define        RTE_BYPASS_MODE_VALID(x)        \
+       ((x) > RTE_BYPASS_MODE_NONE && (x) < RTE_BYPASS_MODE_NUM)
+
+enum {
+       RTE_BYPASS_EVENT_NONE,
+       RTE_BYPASS_EVENT_START,
+       RTE_BYPASS_EVENT_OS_ON = RTE_BYPASS_EVENT_START,
+       RTE_BYPASS_EVENT_POWER_ON,
+       RTE_BYPASS_EVENT_OS_OFF,
+       RTE_BYPASS_EVENT_POWER_OFF,
+       RTE_BYPASS_EVENT_TIMEOUT,
+       RTE_BYPASS_EVENT_NUM
+};
+
+#define        RTE_BYPASS_EVENT_VALID(x)       \
+       ((x) > RTE_BYPASS_EVENT_NONE && (x) < RTE_BYPASS_MODE_NUM)
+
+enum {
+       RTE_BYPASS_TMT_OFF,     /* timeout disabled. */
+       RTE_BYPASS_TMT_1_5_SEC, /* timeout for 1.5 seconds */
+       RTE_BYPASS_TMT_2_SEC,   /* timeout for 2 seconds */
+       RTE_BYPASS_TMT_3_SEC,   /* timeout for 3 seconds */
+       RTE_BYPASS_TMT_4_SEC,   /* timeout for 4 seconds */
+       RTE_BYPASS_TMT_8_SEC,   /* timeout for 8 seconds */
+       RTE_BYPASS_TMT_16_SEC,  /* timeout for 16 seconds */
+       RTE_BYPASS_TMT_32_SEC,  /* timeout for 32 seconds */
+       RTE_BYPASS_TMT_NUM
+};
+
+#define        RTE_BYPASS_TMT_VALID(x) \
+       ((x) == RTE_BYPASS_TMT_OFF || \
+       ((x) > RTE_BYPASS_TMT_OFF && (x) < RTE_BYPASS_TMT_NUM))
+
+typedef void (*bypass_init_t)(struct rte_eth_dev *dev);
+typedef int32_t (*bypass_state_set_t)(struct rte_eth_dev *dev, uint32_t *new_state);
+typedef int32_t (*bypass_state_show_t)(struct rte_eth_dev *dev, uint32_t *state);
+typedef int32_t (*bypass_event_set_t)(struct rte_eth_dev *dev, uint32_t state, uint32_t event);
+typedef int32_t (*bypass_event_show_t)(struct rte_eth_dev *dev, uint32_t event_shift, uint32_t *event);
+typedef int32_t (*bypass_wd_timeout_set_t)(struct rte_eth_dev *dev, uint32_t timeout);
+typedef int32_t (*bypass_wd_timeout_show_t)(struct rte_eth_dev *dev, uint32_t *wd_timeout);
+typedef int32_t (*bypass_ver_show_t)(struct rte_eth_dev *dev, uint32_t *ver);
+typedef int32_t (*bypass_wd_reset_t)(struct rte_eth_dev *dev);
+#endif
+
+
 /**
  * @internal A structure containing the functions exported by an Ethernet driver.
  */
@@ -1050,6 +1140,19 @@ struct eth_dev_ops {
        reta_update_t reta_update;
        /** Query redirection table. */
        reta_query_t reta_query;
+  /* bypass control */
+#ifdef RTE_NIC_BYPASS
+  bypass_init_t bypass_init;
+  bypass_state_set_t bypass_state_set;
+  bypass_state_show_t bypass_state_show;
+  bypass_event_set_t bypass_event_set;
+  bypass_event_show_t bypass_event_show;
+  bypass_wd_timeout_set_t bypass_wd_timeout_set;
+  bypass_wd_timeout_show_t bypass_wd_timeout_show;
+  bypass_ver_show_t bypass_ver_show;
+  bypass_wd_reset_t bypass_wd_reset;
+#endif
+
 };
 
 /**
@@ -1213,58 +1316,32 @@ struct eth_driver {
 extern void rte_eth_driver_register(struct eth_driver *eth_drv);
 
 /**
- * The initialization function of the driver for
- * Intel(r) IGB Gigabit Ethernet Controller devices.
- * This function is invoked once at EAL start time.
- * @return
- *   0 on success
- */
-extern int rte_igb_pmd_init(void);
-
-/**
- * The initialization function of the driver for
- * Intel(r) EM Gigabit Ethernet Controller devices.
- * This function is invoked once at EAL start time.
- * @return
- *   0 on success
- */
-extern int rte_em_pmd_init(void);
-
-/**
- * The initialization function of the driver for 1Gbps Intel IGB_VF
+ * The initialization function of the driver for 10Gbps Intel IXGBE_VF
  * Ethernet devices.
  * Invoked once at EAL start time.
  * @return
  *   0 on success
  */
-extern int rte_igbvf_pmd_init(void);
+extern int rte_ixgbevf_pmd_init(void);
 
 /**
- * The initialization function of the driver for 10Gbps Intel IXGBE
+ * The initialization function of the driver for Qumranet virtio-net
  * Ethernet devices.
  * Invoked once at EAL start time.
  * @return
  *   0 on success
  */
-extern int rte_ixgbe_pmd_init(void);
+extern int rte_virtio_pmd_init(void);
 
 /**
- * The initialization function of the driver for 10Gbps Intel IXGBE_VF
+ * The initialization function of the driver for VMware VMXNET3
  * Ethernet devices.
  * Invoked once at EAL start time.
  * @return
  *   0 on success
  */
-extern int rte_ixgbevf_pmd_init(void);
+extern int rte_vmxnet3_pmd_init(void);
 
-/**
- * The initialization function of the driver for Qumranet virtio-net
- * Ethernet devices.
- * Invoked once at EAL start time.
- * @return
- *   0 on success
- */
-extern int rte_virtio_pmd_init(void);
 
 /**
  * The initialization function of *all* supported and enabled drivers.
@@ -1274,6 +1351,8 @@ extern int rte_virtio_pmd_init(void);
  *  - em
  *  - ixgbe
  *  - ixgbevf
+ *  - virtio
+ *  - vmxnet3
  * This function is invoked once at EAL start time.
  * @return
  *   0 on success.
@@ -1286,29 +1365,7 @@ int rte_pmd_init_all(void)
 {
        int ret = -ENODEV;
 
-#ifdef RTE_LIBRTE_IGB_PMD
-       if ((ret = rte_igb_pmd_init()) != 0) {
-               RTE_LOG(ERR, PMD, "Cannot init igb PMD\n");
-               return (ret);
-       }
-       if ((ret = rte_igbvf_pmd_init()) != 0) {
-               RTE_LOG(ERR, PMD, "Cannot init igbvf PMD\n");
-               return (ret);
-       }
-#endif /* RTE_LIBRTE_IGB_PMD */
-
-#ifdef RTE_LIBRTE_EM_PMD
-       if ((ret = rte_em_pmd_init()) != 0) {
-               RTE_LOG(ERR, PMD, "Cannot init em PMD\n");
-               return (ret);
-       }
-#endif /* RTE_LIBRTE_EM_PMD */
-
 #ifdef RTE_LIBRTE_IXGBE_PMD
-       if ((ret = rte_ixgbe_pmd_init()) != 0) {
-               RTE_LOG(ERR, PMD, "Cannot init ixgbe PMD\n");
-               return (ret);
-       }
        if ((ret = rte_ixgbevf_pmd_init()) != 0) {
                RTE_LOG(ERR, PMD, "Cannot init ixgbevf PMD\n");
                return (ret);
@@ -1322,6 +1379,13 @@ int rte_pmd_init_all(void)
        }
 #endif /* RTE_LIBRTE_VIRTIO_PMD */
 
+#ifdef RTE_LIBRTE_VMXNET3_PMD
+       if ((ret = rte_vmxnet3_pmd_init()) != 0) {
+               RTE_LOG(ERR, PMD, "Cannot init vmxnet3 PMD\n");
+               return (ret);
+       }
+#endif /* RTE_LIBRTE_VMXNET3_PMD */
+
        if (ret == -ENODEV)
                RTE_LOG(ERR, PMD, "No PMD(s) are configured\n");
        return (ret);
@@ -2404,7 +2468,7 @@ int rte_eth_dev_rss_reta_query(uint8_t port,
                        struct rte_eth_rss_reta *reta_conf);
  
  /**
- * Updates unicast hash table for receiving packet with the given destionation
+ * Updates unicast hash table for receiving packet with the given destination
  * MAC address, and the packet is routed to all VFs for which the RX mode is 
  * accept packets that match the unicast hash table.
  *  
@@ -2572,6 +2636,171 @@ int rte_eth_mirror_rule_set(uint8_t port_id,
 int rte_eth_mirror_rule_reset(uint8_t port_id,
                                         uint8_t rule_id);
 
+/**
+ * Initialize bypass logic. This function needs to be called before
+ * executing any other bypass API.
+ *
+ * @param port
+ *   The port identifier of the Ethernet device.
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if hardware doesn't support.
+ *   - (-EINVAL) if bad parameter.
+ */
+int rte_eth_dev_bypass_init(uint8_t port);
+
+/**
+ * Return bypass state.
+ *
+ * @param port
+ *   The port identifier of the Ethernet device.
+ * @param state
+ *   The return bypass state.
+ *   - (1) Normal mode
+ *   - (2) Bypass mode
+ *   - (3) Isolate mode
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if hardware doesn't support.
+ *   - (-EINVAL) if bad parameter.
+ */
+int rte_eth_dev_bypass_state_show(uint8_t port, uint32_t *state);
+
+/**
+ * Set bypass state
+ *
+ * @param port
+ *   The port identifier of the Ethernet device.
+ * @param state
+ *   The current bypass state.
+ *   - (1) Normal mode
+ *   - (2) Bypass mode
+ *   - (3) Isolate mode
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if hardware doesn't support.
+ *   - (-EINVAL) if bad parameter.
+ */
+int rte_eth_dev_bypass_state_set(uint8_t port, uint32_t *new_state);
+
+/**
+ * Return bypass state when given event occurs.
+ *
+ * @param port
+ *   The port identifier of the Ethernet device.
+ * @param event
+ *   The bypass event
+ *   - (1) Main power on (power button is pushed)
+ *   - (2) Auxiliary power on (power supply is being plugged)
+ *   - (3) Main power off (system shutdown and power supply is left plugged in)
+ *   - (4) Auxiliary power off (power supply is being unplugged)
+ *   - (5) Display or set the watchdog timer
+ * @param state
+ *   The bypass state when given event occurred.
+ *   - (1) Normal mode
+ *   - (2) Bypass mode
+ *   - (3) Isolate mode
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if hardware doesn't support.
+ *   - (-EINVAL) if bad parameter.
+ */
+int rte_eth_dev_bypass_event_show(uint8_t port, uint32_t event, uint32_t *state);
+
+/**
+ * Set bypass state when given event occurs.
+ *
+ * @param port
+ *   The port identifier of the Ethernet device.
+ * @param event
+ *   The bypass event
+ *   - (1) Main power on (power button is pushed)
+ *   - (2) Auxiliary power on (power supply is being plugged)
+ *   - (3) Main power off (system shutdown and power supply is left plugged in)
+ *   - (4) Auxiliary power off (power supply is being unplugged)
+ *   - (5) Display or set the watchdog timer
+ * @param state
+ *   The assigned state when given event occurs.
+ *   - (1) Normal mode
+ *   - (2) Bypass mode
+ *   - (3) Isolate mode
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if hardware doesn't support.
+ *   - (-EINVAL) if bad parameter.
+ */
+int rte_eth_dev_bypass_event_store(uint8_t port, uint32_t event, uint32_t state);
+
+/**
+ * Set bypass watchdog timeout count.
+ *
+ * @param port
+ *   The port identifier of the Ethernet device.
+ * @param state
+ *   The timeout to be set.
+ *   - (0) 0 seconds (timer is off)
+ *   - (1) 1.5 seconds
+ *   - (2) 2 seconds
+ *   - (3) 3 seconds
+ *   - (4) 4 seconds
+ *   - (5) 8 seconds
+ *   - (6) 16 seconds
+ *   - (7) 32 seconds
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if hardware doesn't support.
+ *   - (-EINVAL) if bad parameter.
+ */
+int rte_eth_dev_wd_timeout_store(uint8_t port, uint32_t timeout);
+
+/**
+ * Get bypass firmware version.
+ *
+ * @param port
+ *   The port identifier of the Ethernet device.
+ * @param ver
+ *   The firmware version
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if hardware doesn't support.
+ *   - (-EINVAL) if bad parameter.
+ */
+int rte_eth_dev_bypass_ver_show(uint8_t port, uint32_t *ver);
+
+/**
+ * Return bypass watchdog timeout in seconds
+ *
+ * @param port
+ *   The port identifier of the Ethernet device.
+ * @param wd_timeout
+ *   The return watchdog timeout. "0" represents timer expired
+ *   - (0) 0 seconds (timer is off)
+ *   - (1) 1.5 seconds
+ *   - (2) 2 seconds
+ *   - (3) 3 seconds
+ *   - (4) 4 seconds
+ *   - (5) 8 seconds
+ *   - (6) 16 seconds
+ *   - (7) 32 seconds
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if hardware doesn't support.
+ *   - (-EINVAL) if bad parameter.
+ */
+int rte_eth_dev_bypass_wd_timeout_show(uint8_t port, uint32_t *wd_timeout);
+
+/**
+ * Reset bypass watchdog timer
+ *
+ * @param port
+ *   The port identifier of the Ethernet device.
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if hardware doesn't support.
+ *   - (-EINVAL) if bad parameter.
+ */
+int rte_eth_dev_bypass_wd_reset(uint8_t port);
+
 #ifdef __cplusplus
 }
 #endif