xref: /openbsd/sys/dev/pci/if_nfereg.h (revision 768a9842)
1 /*	$OpenBSD: if_nfereg.h,v 1.22 2007/12/05 08:30:33 jsg Exp $	*/
2 
3 /*-
4  * Copyright (c) 2005 Jonathan Gray <jsg@openbsd.org>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #define NFE_PCI_BA		0x10
20 
21 #define NFE_RX_RING_COUNT	128
22 #define NFE_TX_RING_COUNT	256
23 
24 #define NFE_JUMBO_FRAMELEN	9018
25 #define NFE_JUMBO_MTU		(NFE_JUMBO_FRAMELEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
26 
27 #define NFE_JBYTES		(NFE_JUMBO_FRAMELEN + ETHER_ALIGN)
28 #define NFE_JPOOL_COUNT		(NFE_RX_RING_COUNT + 64)
29 #define NFE_JPOOL_SIZE		(NFE_JPOOL_COUNT * NFE_JBYTES)
30 
31 #define NFE_MAX_SCATTER		(NFE_TX_RING_COUNT - 2)
32 
33 #define NFE_IRQ_STATUS		0x000
34 #define NFE_IRQ_MASK		0x004
35 #define NFE_SETUP_R6		0x008
36 #define NFE_IMTIMER		0x00c
37 #define NFE_MAC_RESET		0x03c
38 #define NFE_MISC1		0x080
39 #define NFE_TX_CTL		0x084
40 #define NFE_TX_STATUS		0x088
41 #define NFE_RXFILTER		0x08c
42 #define NFE_RXBUFSZ		0x090
43 #define NFE_RX_CTL		0x094
44 #define NFE_RX_STATUS		0x098
45 #define NFE_RNDSEED		0x09c
46 #define NFE_SETUP_R1		0x0a0
47 #define NFE_SETUP_R2		0x0a4
48 #define NFE_MACADDR_HI		0x0a8
49 #define NFE_MACADDR_LO		0x0ac
50 #define NFE_MULTIADDR_HI	0x0b0
51 #define NFE_MULTIADDR_LO	0x0b4
52 #define NFE_MULTIMASK_HI	0x0b8
53 #define NFE_MULTIMASK_LO	0x0bc
54 #define NFE_PHY_IFACE		0x0c0
55 #define NFE_TX_RING_ADDR_LO	0x100
56 #define NFE_RX_RING_ADDR_LO	0x104
57 #define NFE_RING_SIZE		0x108
58 #define NFE_TX_UNK		0x10c
59 #define NFE_LINKSPEED		0x110
60 #define NFE_SETUP_R5		0x130
61 #define NFE_SETUP_R3		0x13C
62 #define NFE_SETUP_R7		0x140
63 #define NFE_RXTX_CTL		0x144
64 #define NFE_TX_RING_ADDR_HI	0x148
65 #define NFE_RX_RING_ADDR_HI	0x14c
66 #define NFE_PHY_STATUS		0x180
67 #define NFE_SETUP_R4		0x184
68 #define NFE_STATUS		0x188
69 #define NFE_PHY_SPEED		0x18c
70 #define NFE_PHY_CTL		0x190
71 #define NFE_PHY_DATA		0x194
72 #define NFE_WOL_CTL		0x200
73 #define NFE_PATTERN_CRC		0x204
74 #define NFE_PATTERN_MASK	0x208
75 #define NFE_PWR_CAP		0x268
76 #define NFE_PWR_STATE		0x26c
77 #define NFE_VTAG_CTL		0x300
78 #define NFE_PWR2_CTL		0x600
79 
80 #define NFE_PHY_ERROR		0x00001
81 #define NFE_PHY_WRITE		0x00400
82 #define NFE_PHY_BUSY		0x08000
83 #define NFE_PHYADD_SHIFT	5
84 
85 #define NFE_MAC_RESET_MAGIC	0x00f3
86 
87 #define NFE_STATUS_MAGIC	0x140000
88 
89 #define NFE_R1_MAGIC		0x16070f
90 #define NFE_R2_MAGIC		0x16
91 #define NFE_R4_MAGIC		0x08
92 #define NFE_R6_MAGIC		0x03
93 #define NFE_WOL_ENABLE		0x1111
94 #define NFE_RX_START		0x01
95 #define NFE_TX_START		0x01
96 
97 #define NFE_IRQ_RXERR		0x0001
98 #define NFE_IRQ_RX		0x0002
99 #define NFE_IRQ_RX_NOBUF	0x0004
100 #define NFE_IRQ_TXERR		0x0008
101 #define NFE_IRQ_TX_DONE		0x0010
102 #define NFE_IRQ_TIMER		0x0020
103 #define NFE_IRQ_LINK		0x0040
104 #define NFE_IRQ_TXERR2		0x0080
105 #define NFE_IRQ_TX1		0x0100
106 
107 #define NFE_IRQ_WANTED							\
108 	(NFE_IRQ_RXERR | NFE_IRQ_RX_NOBUF | NFE_IRQ_RX |		\
109 	 NFE_IRQ_TXERR | NFE_IRQ_TXERR2 | NFE_IRQ_TX_DONE |		\
110 	 NFE_IRQ_LINK)
111 
112 #define NFE_RXTX_KICKTX		0x0001
113 #define NFE_RXTX_BIT1		0x0002
114 #define NFE_RXTX_BIT2		0x0004
115 #define NFE_RXTX_RESET		0x0010
116 #define NFE_RXTX_VTAG_STRIP	0x0040
117 #define NFE_RXTX_VTAG_INSERT	0x0080
118 #define NFE_RXTX_RXCSUM		0x0400
119 #define NFE_RXTX_V2MAGIC	0x2100
120 #define NFE_RXTX_V3MAGIC	0x2200
121 #define NFE_RXFILTER_MAGIC	0x007f0008
122 #define NFE_U2M			(1 << 5)
123 #define NFE_PROMISC		(1 << 7)
124 
125 /* default interrupt moderation timer of 128us */
126 #define NFE_IM_DEFAULT	((128 * 100) / 1024)
127 
128 #define NFE_VTAG_ENABLE		(1 << 13)
129 
130 #define NFE_PWR_VALID		(1 << 8)
131 #define NFE_PWR_WAKEUP		(1 << 15)
132 #define NFE_PWR2_WAKEUP_MASK	0x0f11
133 
134 #define NFE_MEDIA_SET		0x10000
135 #define	NFE_MEDIA_1000T		0x00032
136 #define NFE_MEDIA_100TX		0x00064
137 #define NFE_MEDIA_10T		0x003e8
138 
139 #define NFE_PHY_100TX		(1 << 0)
140 #define NFE_PHY_1000T		(1 << 1)
141 #define NFE_PHY_HDX		(1 << 8)
142 
143 #define NFE_MISC1_MAGIC		0x003b0f3c
144 #define NFE_MISC1_HDX		(1 << 1)
145 
146 #define NFE_SEED_MASK		0x0003ff00
147 #define NFE_SEED_10T		0x00007f00
148 #define NFE_SEED_100TX		0x00002d00
149 #define NFE_SEED_1000T		0x00007400
150 
151 /* Rx/Tx descriptor */
152 struct nfe_desc32 {
153 	uint32_t	physaddr;
154 	uint16_t	length;
155 	uint16_t	flags;
156 #define NFE_RX_FIXME_V1		0x6004
157 #define NFE_RX_VALID_V1		(1 << 0)
158 #define NFE_TX_ERROR_V1		0x7808
159 #define NFE_TX_LASTFRAG_V1	(1 << 0)
160 } __packed;
161 
162 #define NFE_V1_TXERR	"\020"	\
163 	"\14TXERROR\13UNDERFLOW\12LATECOLLISION\11LOSTCARRIER\10DEFERRED" \
164 	"\08FORCEDINT\03RETRY\00LASTPACKET"
165 
166 /* V2 Rx/Tx descriptor */
167 struct nfe_desc64 {
168 	uint32_t	physaddr[2];
169 	uint32_t	vtag;
170 #define NFE_RX_VTAG		(1 << 16)
171 #define NFE_TX_VTAG		(1 << 18)
172 	uint16_t	length;
173 	uint16_t	flags;
174 #define NFE_RX_FIXME_V2		0x4300
175 #define NFE_RX_VALID_V2		(1 << 13)
176 #define NFE_TX_ERROR_V2		0x5c04
177 #define NFE_TX_LASTFRAG_V2	(1 << 13)
178 } __packed;
179 
180 #define NFE_V2_TXERR	"\020"	\
181 	"\14FORCEDINT\13LASTPACKET\12UNDERFLOW\10LOSTCARRIER\09DEFERRED\02RETRY"
182 
183 /* flags common to V1/V2 descriptors */
184 #define NFE_RX_UDP_CSUMOK	(1 << 10)
185 #define NFE_RX_TCP_CSUMOK	(1 << 11)
186 #define NFE_RX_IP_CSUMOK	(1 << 12)
187 #define NFE_RX_ERROR		(1 << 14)
188 #define NFE_RX_READY		(1 << 15)
189 #define NFE_TX_TCP_UDP_CSUM	(1 << 10)
190 #define NFE_TX_IP_CSUM		(1 << 11)
191 #define NFE_TX_VALID		(1 << 15)
192 
193 #define NFE_READ(sc, reg) \
194 	bus_space_read_4((sc)->sc_memt, (sc)->sc_memh, (reg))
195 
196 #define NFE_WRITE(sc, reg, val) \
197 	bus_space_write_4((sc)->sc_memt, (sc)->sc_memh, (reg), (val))
198