drivers/net/szedata2/rte_eth_szedata2.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (c) 2015 - 2016 CESNET
   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 CESNET 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 RTE_PMD_SZEDATA2_H_
  35 #define RTE_PMD_SZEDATA2_H_
  36
  37 #include <stdint.h>
  38
  39 #include <libsze2.h>
  40
  41 #include <rte_common.h>
  42
  43 /* PCI Vendor ID */
  44 #define PCI_VENDOR_ID_NETCOPE 0x1b26
  45
  46 /* PCI Device IDs */
  47 #define PCI_DEVICE_ID_NETCOPE_COMBO80G 0xcb80
  48 #define PCI_DEVICE_ID_NETCOPE_COMBO100G 0xc1c1
  49 #define PCI_DEVICE_ID_NETCOPE_COMBO100G2 0xc2c1
  50
  51 /* number of PCI resource used by COMBO card */
  52 #define PCI_RESOURCE_NUMBER 0
  53
  54 /* szedata2_packet header length == 4 bytes == 2B segment size + 2B hw size */
  55 #define RTE_SZE2_PACKET_HEADER_SIZE 4
  56
  57 #define RTE_SZE2_MMIO_MAX 10
  58
  59 /*!
  60  * Round 'what' to the nearest larger (or equal) multiple of '8'
  61  * (szedata2 packet is aligned to 8 bytes)
  62  */
  63 #define RTE_SZE2_ALIGN8(what) RTE_ALIGN(what, 8)
  64
  65 /*! main handle structure */
  66 struct szedata {
  67         int fd;
  68         struct sze2_instance_info *info;
  69         uint32_t *write_size;
  70         void *space[RTE_SZE2_MMIO_MAX];
  71         struct szedata_lock lock[2][2];
  72
  73         __u32 *rx_asize, *tx_asize;
  74
  75         /* szedata_read_next variables - to keep context (ct) */
  76
  77         /*
  78          * rx
  79          */
  80         /** initial sze lock ptr */
  81         const struct szedata_lock   *ct_rx_lck_orig;
  82         /** current sze lock ptr (initial or next) */
  83         const struct szedata_lock   *ct_rx_lck;
  84         /** remaining bytes (not read) within current lock */
  85         unsigned int                ct_rx_rem_bytes;
  86         /** current pointer to locked memory */
  87         unsigned char               *ct_rx_cur_ptr;
  88         /**
  89          * allocated buffer to store RX packet if it was split
  90          * into 2 buffers
  91          */
  92         unsigned char               *ct_rx_buffer;
  93         /** registered function to provide filtering based on hwdata */
  94         int (*ct_rx_filter)(u_int16_t hwdata_len, u_char *hwdata);
  95
  96         /*
  97          * tx
  98          */
  99         /**
 100          * buffer for tx - packet is prepared here
 101          * (in future for burst write)
 102          */
 103         unsigned char               *ct_tx_buffer;
 104         /** initial sze TX lock ptrs - number according to TX interfaces */
 105         const struct szedata_lock   **ct_tx_lck_orig;
 106         /** current sze TX lock ptrs - number according to TX interfaces */
 107         const struct szedata_lock   **ct_tx_lck;
 108         /** already written bytes in both locks */
 109         unsigned int                *ct_tx_written_bytes;
 110         /** remaining bytes (not written) within current lock */
 111         unsigned int                *ct_tx_rem_bytes;
 112         /** current pointers to locked memory */
 113         unsigned char               **ct_tx_cur_ptr;
 114         /** NUMA node closest to PCIe device, or -1 */
 115         int                         numa_node;
 116 };
 117
 118 #endif /* RTE_PMD_SZEDATA2_H_ */