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