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