mxge: Move busdma information for RX done ring out of the hot path
[dragonfly.git] / sys / dev / netif / mxge / if_mxge_var.h
1 /*******************************************************************************
2
3 Copyright (c) 2006-2013, Myricom Inc.
4 All rights reserved.
5
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions are met:
8
9  1. Redistributions of source code must retain the above copyright notice,
10     this list of conditions and the following disclaimer.
11
12  2. Neither the name of the Myricom Inc, nor the names of its
13     contributors may be used to endorse or promote products derived from
14     this software without specific prior written permission.
15
16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 POSSIBILITY OF SUCH DAMAGE.
27
28 $FreeBSD: head/sys/dev/mxge/if_mxge_var.h 247160 2013-02-22 19:23:33Z gallatin $
29
30 ***************************************************************************/
31
32 #define MXGE_ETH_STOPPED                0
33 #define MXGE_ETH_STOPPING               1
34 #define MXGE_ETH_STARTING               2
35 #define MXGE_ETH_RUNNING                3
36 #define MXGE_ETH_OPEN_FAILED            4
37
38 #define MXGE_FW_OFFSET                  (1024*1024)
39 #define MXGE_EEPROM_STRINGS_SIZE        256
40 #define MXGE_MAX_SEND_DESC              128
41
42 #define MXGE_INTR_COAL_DELAY            150
43
44 struct mxge_softc;
45 typedef struct mxge_softc mxge_softc_t;
46
47 typedef struct {
48         uint32_t data0;
49         uint32_t data1;
50         uint32_t data2;
51 } mxge_cmd_t;
52
53 struct mxge_rx_buffer_state {
54         struct mbuf *m;
55         bus_dmamap_t map;
56 };
57
58 struct mxge_tx_buffer_state {
59         struct mbuf *m;
60         bus_dmamap_t map;
61         int flag;
62 };
63
64 typedef struct {
65         volatile mcp_kreq_ether_recv_t *lanai;  /* lanai ptr for recv ring */
66         mcp_kreq_ether_recv_t *shadow;  /* host shadow of recv ring */
67         struct mxge_rx_buffer_state *info;
68         bus_dma_tag_t dmat;
69         bus_dmamap_t extra_map;
70         int cnt;
71         int cl_size;
72         int mask;                       /* number of rx slots -1 */
73 } mxge_rx_ring_t;
74
75 typedef struct {
76         mcp_slot_t *entry;
77         int cnt;
78         int idx;
79         int mask;
80 } mxge_rx_done_t;
81
82 typedef struct {
83         struct lwkt_serialize tx_serialize;
84         volatile mcp_kreq_ether_send_t *lanai;  /* lanai ptr for sendq  */
85         volatile uint32_t *send_go;             /* doorbell for sendq */
86         volatile uint32_t *send_stop;           /* doorbell for sendq */
87         mcp_kreq_ether_send_t *req_list;        /* host shadow of sendq */
88         bus_dma_segment_t *seg_list;
89         struct mxge_tx_buffer_state *info;
90         bus_dma_tag_t dmat;
91         int req;                        /* transmits submitted  */
92         int mask;                       /* number of transmit slots -1 */
93         int done;                       /* transmits completed  */
94         int pkt_done;                   /* packets completed */
95         int max_desc;                   /* max descriptors per xmit */
96         int queue_active;               /* fw currently polling this queue*/
97         int activate;
98         int deactivate;
99         int watchdog_rx_pause;          /* cache of pause rq recvd */
100 } mxge_tx_ring_t;
101
102 struct mxge_rx_data {
103         struct lwkt_serialize rx_serialize;
104         mxge_rx_done_t rx_done;
105         mxge_rx_ring_t rx_small;
106         mxge_rx_ring_t rx_big;
107 };
108
109 struct mxge_slice_state {
110         struct mxge_rx_data rx_data;
111         mxge_tx_ring_t tx;              /* transmit ring */
112         mxge_softc_t *sc;
113         mcp_irq_data_t *fw_stats;
114         volatile uint32_t *irq_claim;
115         bus_dmamem_t fw_stats_dma;
116         bus_dmamem_t rx_done_dma;
117         struct sysctl_oid *sysctl_tree;
118         struct sysctl_ctx_list sysctl_ctx;
119 };
120
121 struct mxge_softc {
122         struct arpcom arpcom;
123         struct ifnet* ifp;              /* points to arpcom.ac_if */
124         struct lwkt_serialize main_serialize;
125         int nserialize;
126         struct lwkt_serialize **serializes;
127         struct mxge_slice_state *ss;
128         int tx_boundary;                /* boundary transmits cannot cross*/
129         bus_dma_tag_t parent_dmat;
130         volatile uint8_t *sram;
131         int sram_size;
132         volatile uint32_t *irq_deassert;
133         mcp_cmd_response_t *cmd;
134         bus_dmamem_t cmd_dma;
135         bus_dmamem_t zeropad_dma;
136         struct pci_dev *pdev;
137         int irq_rid;
138         int irq_type;
139         int link_state;
140         unsigned int rdma_tags_available;
141         int intr_coal_delay;
142         volatile uint32_t *intr_coal_delay_ptr;
143         int wc;
144         int wake_queue;
145         int stop_queue;
146         int down_cnt;
147         int watchdog_resets;
148         int pause;
149         struct resource *mem_res;
150         struct resource *irq_res;
151         struct resource **msix_irq_res;
152         struct resource *msix_table_res;
153         struct resource *msix_pba_res;
154         void *ih; 
155         void **msix_ih;
156         const char *fw_name;
157         char eeprom_strings[MXGE_EEPROM_STRINGS_SIZE];
158         char fw_version[128];
159         int fw_ver_major;
160         int fw_ver_minor;
161         int fw_ver_tiny;
162         int adopted_rx_filter_bug;
163         device_t dev;
164         struct ifmedia media;
165         int read_dma;
166         int write_dma;
167         int read_write_dma;
168         int fw_multicast_support;
169         int link_width;
170         int max_mtu;
171         int throttle;
172         int media_flags;
173         int need_media_probe;
174         int num_slices;
175         int rx_ring_size;
176         int dying;
177         int connector;
178         int current_media;
179         bus_dmamem_t dmabench_dma;
180         struct callout co_hdl;
181         u_long opackets;                /* saved ifnet.opackets */
182         u_long ipackets;                /* saved ifnet.ipackets */
183         struct sysctl_ctx_list sysctl_ctx;
184         struct sysctl_oid *sysctl_tree;
185         struct sysctl_oid *slice_sysctl_tree;
186         struct sysctl_ctx_list slice_sysctl_ctx;
187         uint8_t mac_addr[6];            /* eeprom mac address */
188         uint16_t pectl;                 /* save PCIe CTL state */
189         char product_code_string[64];
190         char serial_number_string[64];
191 };
192
193 #define MXGE_PCI_VENDOR_MYRICOM         0x14c1
194 #define MXGE_PCI_DEVICE_Z8E             0x0008
195 #define MXGE_PCI_DEVICE_Z8E_9           0x0009
196 #define MXGE_PCI_REV_Z8E                0
197 #define MXGE_PCI_REV_Z8ES               1
198
199 #define MXGE_XFP_COMPLIANCE_BYTE        131
200 #define MXGE_SFP_COMPLIANCE_BYTE        3
201
202 #define MXGE_MIN_THROTTLE               416
203 #define MXGE_MAX_THROTTLE               4096
204
205 /* Types of connectors on NICs supported by this driver */
206 #define MXGE_CX4 0
207 #define MXGE_XFP 1
208 #define MXGE_SFP 2
209 #define MXGE_QRF 3
210
211 #define MXGE_HIGHPART_TO_U32(X) \
212         (sizeof (X) == 8) ? ((uint32_t)((uint64_t)(X) >> 32)) : (0)
213 #define MXGE_LOWPART_TO_U32(X) ((uint32_t)(X))
214
215 struct mxge_media_type {
216         int flag;
217         uint8_t bitmask;
218         char *name;
219 };
220
221 #if defined(__GNUC__)
222 #if defined(__i386__) || defined(__x86_64__)
223 #define wmb()  __asm__ __volatile__ ("sfence;": : :"memory")
224 #else
225 #error "unknown arch"
226 #endif
227 #else
228 #error "unknown compiler"
229 #endif
230
231 static __inline void
232 mxge_pio_copy(volatile void *to_v, void *from_v, size_t size)
233 {
234         register volatile uintptr_t *to;
235         volatile uintptr_t *from;
236         size_t i;
237
238         to = (volatile uintptr_t *)to_v;
239         from = from_v;
240         for (i = (size / sizeof(uintptr_t)); i; i--) {
241                 *to = *from;
242                 to++;
243                 from++;
244         }
245 }