drivers/net/softnic/rte_eth_softnic_internals.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2017 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__
  35 #define __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__
  36
  37 #include <stdint.h>
  38
  39 #include <rte_mbuf.h>
  40 #include <rte_ethdev.h>
  41
  42 #include "rte_eth_softnic.h"
  43
  44 #ifndef INTRUSIVE
  45 #define INTRUSIVE                                       0
  46 #endif
  47
  48 struct pmd_params {
  49         /** Parameters for the soft device (to be created) */
  50         struct {
  51                 const char *name; /**< Name */
  52                 uint32_t flags; /**< Flags */
  53
  54                 /** 0 = Access hard device though API only (potentially slower,
  55                  *      but safer);
  56                  *  1 = Access hard device private data structures is allowed
  57                  *      (potentially faster).
  58                  */
  59                 int intrusive;
  60         } soft;
  61
  62         /** Parameters for the hard device (existing) */
  63         struct {
  64                 char *name; /**< Name */
  65                 uint16_t tx_queue_id; /**< TX queue ID */
  66         } hard;
  67 };
  68
  69 /**
  70  * Default Internals
  71  */
  72
  73 #ifndef DEFAULT_BURST_SIZE
  74 #define DEFAULT_BURST_SIZE                              32
  75 #endif
  76
  77 #ifndef FLUSH_COUNT_THRESHOLD
  78 #define FLUSH_COUNT_THRESHOLD                   (1 << 17)
  79 #endif
  80
  81 struct default_internals {
  82         struct rte_mbuf **pkts;
  83         uint32_t pkts_len;
  84         uint32_t txq_pos;
  85         uint32_t flush_count;
  86 };
  87
  88 /**
  89  * PMD Internals
  90  */
  91 struct pmd_internals {
  92         /** Params */
  93         struct pmd_params params;
  94
  95         /** Soft device */
  96         struct {
  97                 struct default_internals def; /**< Default */
  98         } soft;
  99
 100         /** Hard device */
 101         struct {
 102                 uint16_t port_id;
 103         } hard;
 104 };
 105
 106 struct pmd_rx_queue {
 107         /** Hard device */
 108         struct {
 109                 uint16_t port_id;
 110                 uint16_t rx_queue_id;
 111         } hard;
 112 };
 113
 114 #endif /* __INCLUDE_RTE_ETH_SOFTNIC_INTERNALS_H__ */