893569c7122ee863697b199a5a998eed783b7c5c
[dragonfly.git] / sys / dev / netif / jme / if_jmevar.h
1 /*-
2  * Copyright (c) 2008, Pyun YongHyeon <yongari@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD: src/sys/dev/jme/if_jmevar.h,v 1.1 2008/05/27 01:42:01 yongari Exp $
28  * $DragonFly: src/sys/dev/netif/jme/if_jmevar.h,v 1.8 2008/11/26 11:55:18 sephe Exp $
29  */
30
31 #ifndef _IF_JMEVAR_H
32 #define _IF_JMEVAR_H
33
34 #include <sys/queue.h>
35 #include <sys/callout.h>
36 #include <sys/taskqueue.h>
37
38 /*
39  * JMC250 supports upto JME_NDESC_MAX descriptors and the number of
40  * descriptors should be multiple of JME_NDESC_ALIGN.
41  */
42 #define JME_TX_DESC_CNT_DEF     512
43 #define JME_RX_DESC_CNT_DEF     512
44
45 #define JME_NDESC_ALIGN         16
46 #define JME_NDESC_MAX           1024
47
48 #define JME_NRXRING_1           1
49 #define JME_NRXRING_2           2
50 #define JME_NRXRING_4           4
51
52 #define JME_NRXRING_MIN         JME_NRXRING_1
53 #define JME_NRXRING_MAX         JME_NRXRING_4
54
55 #define JME_NSERIALIZE          (JME_NRXRING_MAX + 2)
56
57 #define JME_NMSIX               (JME_NRXRING_MAX + 1)
58
59 /*
60  * Tx/Rx descriptor queue base should be 16bytes aligned and
61  * should not cross 4G bytes boundary on the 64bits address
62  * mode.
63  */
64 #define JME_TX_RING_ALIGN       __VM_CACHELINE_SIZE
65 #define JME_RX_RING_ALIGN       __VM_CACHELINE_SIZE
66 #define JME_MAXSEGSIZE          4096
67 #define JME_TSO_MAXSIZE         (65535 + sizeof(struct ether_vlan_header))
68 #define JME_MAXTXSEGS           32
69 #define JME_RX_BUF_ALIGN        sizeof(uint64_t)
70 #define JME_SSB_ALIGN           __VM_CACHELINE_SIZE
71
72 #if (BUS_SPACE_MAXADDR != BUS_SPACE_MAXADDR_32BIT)
73 #define JME_RING_BOUNDARY       0x100000000ULL
74 #else
75 #define JME_RING_BOUNDARY       0
76 #endif
77
78 #define JME_ADDR_LO(x)          ((uint64_t) (x) & 0xFFFFFFFF)
79 #define JME_ADDR_HI(x)          ((uint64_t) (x) >> 32)
80
81 #define JME_MSI_MESSAGES        8
82 #define JME_MSIX_MESSAGES       8
83
84 /* Water mark to kick reclaiming Tx buffers. */
85 #define JME_TX_DESC_HIWAT(sc)   \
86         ((sc)->jme_cdata.jme_tx_desc_cnt - \
87          (((sc)->jme_cdata.jme_tx_desc_cnt * 3) / 10))
88
89 /*
90  * JMC250 can send 9K jumbo frame on Tx path and can receive
91  * 65535 bytes.
92  */
93 #define JME_JUMBO_FRAMELEN      9216
94 #define JME_JUMBO_MTU                                                   \
95         (JME_JUMBO_FRAMELEN - sizeof(struct ether_vlan_header) -        \
96          ETHER_HDR_LEN - ETHER_CRC_LEN)
97 #define JME_MAX_MTU                                                     \
98         (ETHER_MAX_LEN + sizeof(struct ether_vlan_header) -             \
99          ETHER_HDR_LEN - ETHER_CRC_LEN)
100 /*
101  * JMC250 can't handle Tx checksum offload/TSO if frame length
102  * is larger than its FIFO size(2K). It's also good idea to not
103  * use jumbo frame if hardware is running at half-duplex media.
104  * Because the jumbo frame may not fit into the Tx FIFO,
105  * collisions make hardware fetch frame from host memory with
106  * DMA again which in turn slows down Tx performance
107  * significantly.
108  */
109 #define JME_TX_FIFO_SIZE        2000
110 /*
111  * JMC250 has just 4K Rx FIFO. To support jumbo frame that is
112  * larger than 4K bytes in length, Rx FIFO threshold should be
113  * adjusted to minimize Rx FIFO overrun.
114  */
115 #define JME_RX_FIFO_SIZE        4000
116
117 #define JME_DESC_INC(x, y)      ((x) = ((x) + 1) % (y))
118
119 struct jme_txdesc {
120         struct mbuf             *tx_m;
121         bus_dmamap_t            tx_dmamap;
122         int                     tx_ndesc;
123         struct jme_desc         *tx_desc;
124 };
125
126 struct jme_rxdesc {
127         struct mbuf             *rx_m;
128         bus_addr_t              rx_paddr;
129         bus_dmamap_t            rx_dmamap;
130         struct jme_desc         *rx_desc;
131 };
132
133 struct jme_softc;
134
135 /*
136  * RX ring/descs
137  */
138 struct jme_rxdata {
139         struct lwkt_serialize   jme_rx_serialize;
140         struct jme_softc        *jme_sc;
141
142         uint32_t                jme_rx_coal;
143         uint32_t                jme_rx_comp;
144         uint32_t                jme_rx_empty;
145         int                     jme_rx_idx;
146
147         bus_dma_tag_t           jme_rx_tag;     /* RX mbuf tag */
148         bus_dmamap_t            jme_rx_sparemap;
149         struct jme_rxdesc       *jme_rxdesc;
150
151         struct jme_desc         *jme_rx_ring;
152         bus_addr_t              jme_rx_ring_paddr;
153         bus_dma_tag_t           jme_rx_ring_tag;
154         bus_dmamap_t            jme_rx_ring_map;
155
156         int                     jme_rx_cons;
157         int                     jme_rx_desc_cnt;
158
159         int                     jme_rxlen;
160         struct mbuf             *jme_rxhead;
161         struct mbuf             *jme_rxtail;
162
163         u_long                  jme_rx_pkt;
164 };
165
166 struct jme_chain_data {
167         /*
168          * Top level tags
169          */
170         bus_dma_tag_t           jme_ring_tag;   /* parent ring tag */
171         bus_dma_tag_t           jme_buffer_tag; /* parent mbuf/ssb tag */
172
173         /*
174          * Shadow status block
175          */
176         struct jme_ssb          *jme_ssb_block;
177         bus_addr_t              jme_ssb_block_paddr;
178         bus_dma_tag_t           jme_ssb_tag;
179         bus_dmamap_t            jme_ssb_map;
180
181         /*
182          * TX ring/descs
183          */
184         struct lwkt_serialize   jme_tx_serialize;
185         struct jme_softc        *jme_sc;
186         bus_dma_tag_t           jme_tx_tag;     /* TX mbuf tag */
187         struct jme_txdesc       *jme_txdesc;
188
189         struct jme_desc         *jme_tx_ring;
190         bus_addr_t              jme_tx_ring_paddr;
191         bus_dma_tag_t           jme_tx_ring_tag;
192         bus_dmamap_t            jme_tx_ring_map;
193
194         int                     jme_tx_prod;
195         int                     jme_tx_cons;
196         int                     jme_tx_cnt;
197         int                     jme_tx_desc_cnt;
198
199         int                     jme_rx_ring_cnt;
200         struct jme_rxdata       jme_rx_data[JME_NRXRING_MAX];
201 };
202
203 struct jme_msix_data {
204         int                     jme_msix_rid;
205         int                     jme_msix_cpuid;
206         u_int                   jme_msix_vector;
207         uint32_t                jme_msix_intrs;
208         struct resource         *jme_msix_res;
209         void                    *jme_msix_handle;
210         struct lwkt_serialize   *jme_msix_serialize;
211         char                    jme_msix_desc[64];
212
213         driver_intr_t           *jme_msix_func;
214         void                    *jme_msix_arg;
215 };
216
217 #define JME_TX_RING_SIZE(sc)    \
218     (sizeof(struct jme_desc) * (sc)->jme_cdata.jme_tx_desc_cnt)
219 #define JME_RX_RING_SIZE(rdata) \
220     (sizeof(struct jme_desc) * (rdata)->jme_rx_desc_cnt)
221 #define JME_SSB_SIZE            sizeof(struct jme_ssb)
222
223 /*
224  * Software state per device.
225  */
226 struct jme_softc {
227         struct arpcom           arpcom;
228         device_t                jme_dev;
229
230         int                     jme_mem_rid;
231         struct resource         *jme_mem_res;
232         bus_space_tag_t         jme_mem_bt;
233         bus_space_handle_t      jme_mem_bh;
234
235         int                     jme_irq_type;
236         int                     jme_irq_rid;
237         struct resource         *jme_irq_res;
238         void                    *jme_irq_handle;
239         struct jme_msix_data    jme_msix[JME_NMSIX];
240         int                     jme_msix_cnt;
241         uint32_t                jme_msinum[JME_MSINUM_CNT];
242
243         device_t                jme_miibus;
244         int                     jme_phyaddr;
245         bus_addr_t              jme_lowaddr;
246
247         uint32_t                jme_clksrc;
248         uint32_t                jme_clksrc_1000;
249         uint32_t                jme_tx_dma_size;
250         uint32_t                jme_rx_dma_size;
251
252         uint32_t                jme_caps;
253 #define JME_CAP_FPGA            0x0001
254 #define JME_CAP_PCIE            0x0002
255 #define JME_CAP_PMCAP           0x0004
256 #define JME_CAP_FASTETH         0x0008
257 #define JME_CAP_JUMBO           0x0010
258
259         uint32_t                jme_workaround;
260 #define JME_WA_EXTFIFO          0x0001
261 #define JME_WA_HDX              0x0002
262
263         uint32_t                jme_flags;
264 #define JME_FLAG_MSI            0x0001
265 #define JME_FLAG_MSIX           0x0002
266 #define JME_FLAG_DETACH         0x0004
267 #define JME_FLAG_LINK           0x0008
268
269         struct lwkt_serialize   jme_serialize;
270         struct lwkt_serialize   *jme_serialize_arr[JME_NSERIALIZE];
271         int                     jme_serialize_cnt;
272
273         struct callout          jme_tick_ch;
274         struct jme_chain_data   jme_cdata;
275         int                     jme_if_flags;
276         uint32_t                jme_txcsr;
277         uint32_t                jme_rxcsr;
278
279         int                     jme_txd_spare;
280
281         struct sysctl_ctx_list  jme_sysctl_ctx;
282         struct sysctl_oid       *jme_sysctl_tree;
283
284         /*
285          * Sysctl variables
286          */
287         int                     jme_tx_coal_to;
288         int                     jme_tx_coal_pkt;
289         int                     jme_rx_coal_to;
290         int                     jme_rx_coal_pkt;
291         int                     jme_rss_debug;
292 };
293
294 /* Register access macros. */
295 #define CSR_WRITE_4(_sc, reg, val)      \
296         bus_space_write_4((_sc)->jme_mem_bt, (_sc)->jme_mem_bh, (reg), (val))
297 #define CSR_READ_4(_sc, reg)            \
298         bus_space_read_4((_sc)->jme_mem_bt, (_sc)->jme_mem_bh, (reg))
299
300 #define JME_MAXERR      5
301
302 #define JME_RXCHAIN_RESET(rdata)        \
303 do {                                    \
304         (rdata)->jme_rxhead = NULL;     \
305         (rdata)->jme_rxtail = NULL;     \
306         (rdata)->jme_rxlen = 0;         \
307 } while (0)
308
309 #define JME_TX_TIMEOUT          5
310 #define JME_TIMEOUT             1000
311 #define JME_PHY_TIMEOUT         1000
312 #define JME_EEPROM_TIMEOUT      1000
313
314 #define JME_TXD_RSVD            1
315
316 #define JME_ENABLE_HWRSS(sc)    \
317         ((sc)->jme_cdata.jme_rx_ring_cnt > JME_NRXRING_MIN)
318
319 #endif