drivers/net/softnic/rte_eth_softnic.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_H__
  35 #define __INCLUDE_RTE_ETH_SOFTNIC_H__
  36
  37 #include <stdint.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 #ifndef SOFTNIC_SOFT_TM_NB_QUEUES
  44 #define SOFTNIC_SOFT_TM_NB_QUEUES                       65536
  45 #endif
  46
  47 #ifndef SOFTNIC_SOFT_TM_QUEUE_SIZE
  48 #define SOFTNIC_SOFT_TM_QUEUE_SIZE                      64
  49 #endif
  50
  51 #ifndef SOFTNIC_SOFT_TM_ENQ_BSZ
  52 #define SOFTNIC_SOFT_TM_ENQ_BSZ                         32
  53 #endif
  54
  55 #ifndef SOFTNIC_SOFT_TM_DEQ_BSZ
  56 #define SOFTNIC_SOFT_TM_DEQ_BSZ                         24
  57 #endif
  58
  59 #ifndef SOFTNIC_HARD_TX_QUEUE_ID
  60 #define SOFTNIC_HARD_TX_QUEUE_ID                        0
  61 #endif
  62
  63 /**
  64  * Run the traffic management function on the softnic device
  65  *
  66  * This function read the packets from the softnic input queues, insert into
  67  * QoS scheduler queues based on mbuf sched field value and transmit the
  68  * scheduled packets out through the hard device interface.
  69  *
  70  * @param portid
  71  *    port id of the soft device.
  72  * @return
  73  *    zero.
  74  */
  75
  76 int
  77 rte_pmd_softnic_run(uint16_t port_id);
  78
  79 #ifdef __cplusplus
  80 }
  81 #endif
  82
  83 #endif /* __INCLUDE_RTE_ETH_SOFTNIC_H__ */