ethdev: separate driver APIs
[dpdk.git] / drivers / net / sfc / sfc.h
index 7e61d0c..7557534 100644 (file)
@@ -1,30 +1,10 @@
-/*-
- * Copyright (c) 2016 Solarflare Communications Inc.
+/* SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Copyright (c) 2016-2018 Solarflare Communications Inc.
  * All rights reserved.
  *
  * This software was jointly developed between OKTET Labs (under contract
  * for Solarflare) and Solarflare Communications, Inc.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- *    this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- *    this list of conditions and the following disclaimer in the documentation
- *    and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
- * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
- * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
- * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
- * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef _SFC_H
 
 #include <stdbool.h>
 
-#include <rte_ethdev.h>
+#include <rte_pci.h>
+#include <rte_bus_pci.h>
+#include <rte_ethdev_driver.h>
 #include <rte_kvargs.h>
 #include <rte_spinlock.h>
+#include <rte_atomic.h>
 
 #include "efx.h"
 
+#include "sfc_filter.h"
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#define SFC_DEV_TO_PCI(eth_dev) \
-       RTE_DEV_TO_PCI((eth_dev)->device)
+#if EFSYS_OPT_RX_SCALE
+/** RSS hash offloads mask */
+#define SFC_RSS_OFFLOADS       (ETH_RSS_IP | ETH_RSS_TCP)
+#endif
 
 /*
  * +---------------+
@@ -53,20 +40,20 @@ extern "C" {
  *     V                       |
  * +---------------+------------+
  * |  INITIALIZED  |
- * +---------------+<-----------+
- *     |.dev_configure         |
- *     V                       |
- * +---------------+           |
- * |  CONFIGURING  |------------^
- * +---------------+ failed    |
- *     |success                |
- *     |               +---------------+
- *     |               |    CLOSING    |
- *     |               +---------------+
- *     |                       ^
- *     V                       |.dev_close
- * +---------------+------------+
- * |  CONFIGURED   |
+ * +---------------+<-----------<---------------+
+ *     |.dev_configure         |               |
+ *     V                       |failed         |
+ * +---------------+------------+              |
+ * |  CONFIGURING  |                           |
+ * +---------------+----+                      |
+ *     |success        |                       |
+ *     |               |               +---------------+
+ *     |               |               |    CLOSING    |
+ *     |               |               +---------------+
+ *     |               |                       ^
+ *     V               |.dev_configure         |
+ * +---------------+----+                      |.dev_close
+ * |  CONFIGURED   |----------------------------+
  * +---------------+<-----------+
  *     |.dev_start             |
  *     V                       |
@@ -96,6 +83,13 @@ enum sfc_adapter_state {
        SFC_ADAPTER_NSTATES
 };
 
+enum sfc_dev_filter_mode {
+       SFC_DEV_FILTER_MODE_PROMISC = 0,
+       SFC_DEV_FILTER_MODE_ALLMULTI,
+
+       SFC_DEV_FILTER_NMODES
+};
+
 enum sfc_mcdi_state {
        SFC_MCDI_UNINITIALIZED = 0,
        SFC_MCDI_INITIALIZED,
@@ -111,20 +105,55 @@ struct sfc_mcdi {
        enum sfc_mcdi_state             state;
        efx_mcdi_transport_t            transport;
        bool                            logging;
+       uint32_t                        proxy_handle;
+       efx_rc_t                        proxy_result;
 };
 
 struct sfc_intr {
        efx_intr_type_t                 type;
+       rte_intr_callback_fn            handler;
+       boolean_t                       lsc_intr;
 };
 
-struct sfc_evq_info;
 struct sfc_rxq_info;
 struct sfc_txq_info;
+struct sfc_dp_rx;
 
 struct sfc_port {
+       unsigned int                    lsc_seq;
+
+       uint32_t                        phy_adv_cap_mask;
+       uint32_t                        phy_adv_cap;
+
        unsigned int                    flow_ctrl;
        boolean_t                       flow_ctrl_autoneg;
        size_t                          pdu;
+
+       /*
+        * Flow API isolated mode overrides promisc and allmulti settings;
+        * they won't be applied if isolated mode is active
+        */
+       boolean_t                       isolated;
+       boolean_t                       promisc;
+       boolean_t                       allmulti;
+
+       struct ether_addr               default_mac_addr;
+
+       unsigned int                    max_mcast_addrs;
+       unsigned int                    nb_mcast_addrs;
+       uint8_t                         *mcast_addrs;
+
+       rte_spinlock_t                  mac_stats_lock;
+       uint64_t                        *mac_stats_buf;
+       unsigned int                    mac_stats_nb_supported;
+       efsys_mem_t                     mac_stats_dma_mem;
+       boolean_t                       mac_stats_reset_pending;
+       uint16_t                        mac_stats_update_period_ms;
+       uint32_t                        mac_stats_update_generation;
+       boolean_t                       mac_stats_periodic_dma_supported;
+       uint64_t                        mac_stats_last_request_timestamp;
+
+       uint32_t                mac_stats_mask[EFX_MAC_STATS_MASK_NPAGES];
 };
 
 /* Adapter private data */
@@ -137,6 +166,8 @@ struct sfc_adapter {
         */
        rte_spinlock_t                  lock;
        enum sfc_adapter_state          state;
+       struct rte_pci_addr             pci_addr;
+       uint16_t                        port_id;
        struct rte_eth_dev              *eth_dev;
        struct rte_kvargs               *kvargs;
        bool                            debug_init;
@@ -145,10 +176,12 @@ struct sfc_adapter {
        efx_family_t                    family;
        efx_nic_t                       *nic;
        rte_spinlock_t                  nic_lock;
+       rte_atomic32_t                  restart_required;
 
        struct sfc_mcdi                 mcdi;
        struct sfc_intr                 intr;
        struct sfc_port                 port;
+       struct sfc_filter               filter;
 
        unsigned int                    rxq_max;
        unsigned int                    txq_max;
@@ -157,16 +190,64 @@ struct sfc_adapter {
 
        uint32_t                        evq_flags;
        unsigned int                    evq_count;
-       struct sfc_evq_info             *evq_info;
 
        unsigned int                    mgmt_evq_index;
+       /*
+        * The lock is used to serialise management event queue polling
+        * which can be done from different context. Also the lock
+        * guarantees that mgmt_evq_running is preserved while the lock
+        * is held. It is used to serialise polling and start/stop
+        * operations.
+        *
+        * Locks which may be held when the lock is acquired:
+        *  - adapter lock, when:
+        *    - device start/stop to change mgmt_evq_running
+        *    - any control operations in client side MCDI proxy handling to
+        *      poll management event queue waiting for proxy response
+        *  - MCDI lock, when:
+        *    - any control operations in client side MCDI proxy handling to
+        *      poll management event queue waiting for proxy response
+        *
+        * Locks which are acquired with the lock held:
+        *  - nic_lock, when:
+        *    - MC event processing on management event queue polling
+        *      (e.g. MC REBOOT or BADASSERT events)
+        */
        rte_spinlock_t                  mgmt_evq_lock;
+       bool                            mgmt_evq_running;
+       struct sfc_evq                  *mgmt_evq;
 
        unsigned int                    rxq_count;
        struct sfc_rxq_info             *rxq_info;
 
        unsigned int                    txq_count;
        struct sfc_txq_info             *txq_info;
+
+       boolean_t                       tso;
+
+       unsigned int                    rss_channels;
+
+#if EFSYS_OPT_RX_SCALE
+       efx_rx_scale_context_type_t     rss_support;
+       efx_rx_hash_support_t           hash_support;
+       efx_rx_hash_type_t              rss_hash_types;
+       unsigned int                    rss_tbl[EFX_RSS_TBL_SIZE];
+       uint8_t                         rss_key[EFX_RSS_KEY_SIZE];
+#endif
+
+       /*
+        * Shared memory copy of the Rx datapath name to be used by
+        * the secondary process to find Rx datapath to be used.
+        */
+       char                            *dp_rx_name;
+       const struct sfc_dp_rx          *dp_rx;
+
+       /*
+        * Shared memory copy of the Tx datapath name to be used by
+        * the secondary process to find Rx datapath to be used.
+        */
+       char                            *dp_tx_name;
+       const struct sfc_dp_tx          *dp_tx;
 };
 
 /*
@@ -210,15 +291,26 @@ sfc_adapter_lock_fini(__rte_unused struct sfc_adapter *sa)
        /* Just for symmetry of the API */
 }
 
+/** Get the number of milliseconds since boot from the default timer */
+static inline uint64_t
+sfc_get_system_msecs(void)
+{
+       return rte_get_timer_cycles() * MS_PER_S / rte_get_timer_hz();
+}
+
 int sfc_dma_alloc(const struct sfc_adapter *sa, const char *name, uint16_t id,
                  size_t len, int socket_id, efsys_mem_t *esmp);
 void sfc_dma_free(const struct sfc_adapter *sa, efsys_mem_t *esmp);
 
+int sfc_probe(struct sfc_adapter *sa);
+void sfc_unprobe(struct sfc_adapter *sa);
 int sfc_attach(struct sfc_adapter *sa);
 void sfc_detach(struct sfc_adapter *sa);
 int sfc_start(struct sfc_adapter *sa);
 void sfc_stop(struct sfc_adapter *sa);
 
+void sfc_schedule_restart(struct sfc_adapter *sa);
+
 int sfc_mcdi_init(struct sfc_adapter *sa);
 void sfc_mcdi_fini(struct sfc_adapter *sa);
 
@@ -227,17 +319,22 @@ void sfc_close(struct sfc_adapter *sa);
 
 int sfc_intr_attach(struct sfc_adapter *sa);
 void sfc_intr_detach(struct sfc_adapter *sa);
-int sfc_intr_init(struct sfc_adapter *sa);
-void sfc_intr_fini(struct sfc_adapter *sa);
+int sfc_intr_configure(struct sfc_adapter *sa);
+void sfc_intr_close(struct sfc_adapter *sa);
 int sfc_intr_start(struct sfc_adapter *sa);
 void sfc_intr_stop(struct sfc_adapter *sa);
 
-int sfc_port_init(struct sfc_adapter *sa);
-void sfc_port_fini(struct sfc_adapter *sa);
+int sfc_port_attach(struct sfc_adapter *sa);
+void sfc_port_detach(struct sfc_adapter *sa);
+int sfc_port_configure(struct sfc_adapter *sa);
+void sfc_port_close(struct sfc_adapter *sa);
 int sfc_port_start(struct sfc_adapter *sa);
 void sfc_port_stop(struct sfc_adapter *sa);
 void sfc_port_link_mode_to_info(efx_link_mode_t link_mode,
                                struct rte_eth_link *link_info);
+int sfc_port_update_mac_stats(struct sfc_adapter *sa);
+int sfc_port_reset_mac_stats(struct sfc_adapter *sa);
+int sfc_set_rx_mode(struct sfc_adapter *sa);
 
 
 #ifdef __cplusplus