drivers/net/sfc/sfc.h

   1 /*-
   2  * Copyright (c) 2016 Solarflare Communications Inc.
   3  * All rights reserved.
   4  *
   5  * This software was jointly developed between OKTET Labs (under contract
   6  * for Solarflare) and Solarflare Communications, Inc.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright notice,
  12  *    this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright notice,
  14  *    this list of conditions and the following disclaimer in the documentation
  15  *    and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  19  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  24  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  25  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  27  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef _SFC_H
  31 #define _SFC_H
  32
  33 #include <stdbool.h>
  34
  35 #include <rte_ethdev.h>
  36 #include <rte_kvargs.h>
  37 #include <rte_spinlock.h>
  38
  39 #include "efx.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 #define SFC_DEV_TO_PCI(eth_dev) \
  46         RTE_DEV_TO_PCI((eth_dev)->device)
  47
  48 /*
  49  * +---------------+
  50  * | UNINITIALIZED |<-----------+
  51  * +---------------+            |
  52  *      |.eth_dev_init          |.eth_dev_uninit
  53  *      V                       |
  54  * +---------------+------------+
  55  * |  INITIALIZED  |
  56  * +---------------+<-----------+
  57  *      |.dev_configure         |
  58  *      V                       |
  59  * +---------------+            |
  60  * |  CONFIGURING  |------------^
  61  * +---------------+ failed     |
  62  *      |success                |
  63  *      |               +---------------+
  64  *      |               |    CLOSING    |
  65  *      |               +---------------+
  66  *      |                       ^
  67  *      V                       |.dev_close
  68  * +---------------+------------+
  69  * |  CONFIGURED   |
  70  * +---------------+<-----------+
  71  *      |.dev_start             |
  72  *      V                       |
  73  * +---------------+            |
  74  * |   STARTING    |------------^
  75  * +---------------+ failed     |
  76  *      |success                |
  77  *      |               +---------------+
  78  *      |               |   STOPPING    |
  79  *      |               +---------------+
  80  *      |                       ^
  81  *      V                       |.dev_stop
  82  * +---------------+------------+
  83  * |    STARTED    |
  84  * +---------------+
  85  */
  86 enum sfc_adapter_state {
  87         SFC_ADAPTER_UNINITIALIZED = 0,
  88         SFC_ADAPTER_INITIALIZED,
  89         SFC_ADAPTER_CONFIGURING,
  90         SFC_ADAPTER_CONFIGURED,
  91         SFC_ADAPTER_CLOSING,
  92         SFC_ADAPTER_STARTING,
  93         SFC_ADAPTER_STARTED,
  94         SFC_ADAPTER_STOPPING,
  95
  96         SFC_ADAPTER_NSTATES
  97 };
  98
  99 enum sfc_mcdi_state {
 100         SFC_MCDI_UNINITIALIZED = 0,
 101         SFC_MCDI_INITIALIZED,
 102         SFC_MCDI_BUSY,
 103         SFC_MCDI_COMPLETED,
 104
 105         SFC_MCDI_NSTATES
 106 };
 107
 108 struct sfc_mcdi {
 109         rte_spinlock_t                  lock;
 110         efsys_mem_t                     mem;
 111         enum sfc_mcdi_state             state;
 112         efx_mcdi_transport_t            transport;
 113 };
 114
 115 struct sfc_intr {
 116         efx_intr_type_t                 type;
 117 };
 118
 119 /* Adapter private data */
 120 struct sfc_adapter {
 121         /*
 122          * PMD setup and configuration is not thread safe. Since it is not
 123          * performance sensitive, it is better to guarantee thread-safety
 124          * and add device level lock. Adapter control operations which
 125          * change its state should acquire the lock.
 126          */
 127         rte_spinlock_t                  lock;
 128         enum sfc_adapter_state          state;
 129         struct rte_eth_dev              *eth_dev;
 130         struct rte_kvargs               *kvargs;
 131         bool                            debug_init;
 132         int                             socket_id;
 133         efsys_bar_t                     mem_bar;
 134         efx_family_t                    family;
 135         efx_nic_t                       *nic;
 136         rte_spinlock_t                  nic_lock;
 137
 138         struct sfc_mcdi                 mcdi;
 139         struct sfc_intr                 intr;
 140
 141         unsigned int                    rxq_max;
 142         unsigned int                    txq_max;
 143 };
 144
 145 /*
 146  * Add wrapper functions to acquire/release lock to be able to remove or
 147  * change the lock in one place.
 148  */
 149
 150 static inline void
 151 sfc_adapter_lock_init(struct sfc_adapter *sa)
 152 {
 153         rte_spinlock_init(&sa->lock);
 154 }
 155
 156 static inline int
 157 sfc_adapter_is_locked(struct sfc_adapter *sa)
 158 {
 159         return rte_spinlock_is_locked(&sa->lock);
 160 }
 161
 162 static inline void
 163 sfc_adapter_lock(struct sfc_adapter *sa)
 164 {
 165         rte_spinlock_lock(&sa->lock);
 166 }
 167
 168 static inline void
 169 sfc_adapter_unlock(struct sfc_adapter *sa)
 170 {
 171         rte_spinlock_unlock(&sa->lock);
 172 }
 173
 174 static inline void
 175 sfc_adapter_lock_fini(__rte_unused struct sfc_adapter *sa)
 176 {
 177         /* Just for symmetry of the API */
 178 }
 179
 180 int sfc_dma_alloc(const struct sfc_adapter *sa, const char *name, uint16_t id,
 181                   size_t len, int socket_id, efsys_mem_t *esmp);
 182 void sfc_dma_free(const struct sfc_adapter *sa, efsys_mem_t *esmp);
 183
 184 int sfc_attach(struct sfc_adapter *sa);
 185 void sfc_detach(struct sfc_adapter *sa);
 186 int sfc_start(struct sfc_adapter *sa);
 187 void sfc_stop(struct sfc_adapter *sa);
 188
 189 int sfc_mcdi_init(struct sfc_adapter *sa);
 190 void sfc_mcdi_fini(struct sfc_adapter *sa);
 191
 192 int sfc_configure(struct sfc_adapter *sa);
 193 void sfc_close(struct sfc_adapter *sa);
 194
 195 int sfc_intr_attach(struct sfc_adapter *sa);
 196 void sfc_intr_detach(struct sfc_adapter *sa);
 197 int sfc_intr_init(struct sfc_adapter *sa);
 198 void sfc_intr_fini(struct sfc_adapter *sa);
 199 int sfc_intr_start(struct sfc_adapter *sa);
 200 void sfc_intr_stop(struct sfc_adapter *sa);
 201
 202 #ifdef __cplusplus
 203 }
 204 #endif
 205
 206 #endif  /* _SFC_H */