drivers/net/sfc/sfc_dp.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  * Copyright (c) 2017 Solarflare Communications Inc.
   5  * All rights reserved.
   6  *
   7  * This software was jointly developed between OKTET Labs (under contract
   8  * for Solarflare) and Solarflare Communications, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright notice,
  14  *    this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright notice,
  16  *    this list of conditions and the following disclaimer in the documentation
  17  *    and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  29  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef _SFC_DP_H
  33 #define _SFC_DP_H
  34
  35 #include <stdbool.h>
  36 #include <sys/queue.h>
  37
  38 #include <rte_pci.h>
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 #define SFC_DIV_ROUND_UP(a, b) \
  45         __extension__ ({                \
  46                 typeof(a) _a = (a);     \
  47                 typeof(b) _b = (b);     \
  48                                         \
  49                 (_a + (_b - 1)) / _b;   \
  50         })
  51
  52 /**
  53  * Datapath exception handler to be provided by the control path.
  54  */
  55 typedef void (sfc_dp_exception_t)(void *ctrl);
  56
  57 enum sfc_dp_type {
  58         SFC_DP_RX = 0,  /**< Receive datapath */
  59 };
  60
  61
  62 /** Datapath queue run-time information */
  63 struct sfc_dp_queue {
  64         uint16_t                        port_id;
  65         uint16_t                        queue_id;
  66         struct rte_pci_addr             pci_addr;
  67 };
  68
  69 void sfc_dp_queue_init(struct sfc_dp_queue *dpq,
  70                        uint16_t port_id, uint16_t queue_id,
  71                        const struct rte_pci_addr *pci_addr);
  72
  73 /*
  74  * Helper macro to define datapath logging macros and have uniform
  75  * logging.
  76  */
  77 #define SFC_DP_LOG(dp_name, level, dpq, ...) \
  78         do {                                                            \
  79                 const struct sfc_dp_queue *_dpq = (dpq);                \
  80                 const struct rte_pci_addr *_addr = &(_dpq)->pci_addr;   \
  81                                                                         \
  82                 RTE_LOG(level, PMD,                                     \
  83                         RTE_FMT("%s " PCI_PRI_FMT                       \
  84                                 " #%" PRIu16 ".%" PRIu16 ": "           \
  85                                 RTE_FMT_HEAD(__VA_ARGS__,) "\n",        \
  86                                 dp_name,                                \
  87                                 _addr->domain, _addr->bus,              \
  88                                 _addr->devid, _addr->function,          \
  89                                 _dpq->port_id, _dpq->queue_id,          \
  90                                 RTE_FMT_TAIL(__VA_ARGS__,)));           \
  91         } while (0)
  92
  93
  94 /** Datapath definition */
  95 struct sfc_dp {
  96         TAILQ_ENTRY(sfc_dp)             links;
  97         const char                      *name;
  98         enum sfc_dp_type                type;
  99         /* Mask of required hardware/firmware capabilities */
 100         unsigned int                    hw_fw_caps;
 101 };
 102
 103 /** List of datapath variants */
 104 TAILQ_HEAD(sfc_dp_list, sfc_dp);
 105
 106 /* Check if available HW/FW capabilities are sufficient for the datapath */
 107 static inline bool
 108 sfc_dp_match_hw_fw_caps(const struct sfc_dp *dp, unsigned int avail_caps)
 109 {
 110         return (dp->hw_fw_caps & avail_caps) == dp->hw_fw_caps;
 111 }
 112
 113 struct sfc_dp *sfc_dp_find_by_name(struct sfc_dp_list *head,
 114                                    enum sfc_dp_type type, const char *name);
 115 struct sfc_dp *sfc_dp_find_by_caps(struct sfc_dp_list *head,
 116                                    enum sfc_dp_type type,
 117                                    unsigned int avail_caps);
 118 int sfc_dp_register(struct sfc_dp_list *head, struct sfc_dp *entry);
 119
 120 #ifdef __cplusplus
 121 }
 122 #endif
 123 #endif /* _SFC_DP_H */