1 /******************************************************************************
2 SPDX-License-Identifier: BSD-3-Clause
3
4 Copyright (c) 2001-2020, Intel Corporation
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 are met:
9
10 1. Redistributions of source code must retain the above copyright notice,
11 this list of conditions and the following disclaimer.
12
13 2. Redistributions in binary form must reproduce the above copyright
14 notice, this list of conditions and the following disclaimer in the
15 documentation and/or other materials provided with the distribution.
16
17 3. Neither the name of the Intel Corporation nor the names of its
18 contributors may be used to endorse or promote products derived from
19 this software without specific prior written permission.
20
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 POSSIBILITY OF SUCH DAMAGE.
32
33 ******************************************************************************/
34
35
36 #ifndef _FREEBSD_OS_H_
37 #define _FREEBSD_OS_H_
38
39 #include <sys/types.h>
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/proc.h>
43 #include <sys/lock.h>
44 #include <sys/mutex.h>
45 #include <sys/mbuf.h>
46 #include <sys/protosw.h>
47 #include <sys/socket.h>
48 #include <sys/malloc.h>
49 #include <sys/kernel.h>
50 #include <sys/bus.h>
51
52 #include <net/ethernet.h>
53 #include <net/if.h>
54 #include <net/if_var.h>
55 #include <net/iflib.h>
56
57
58
59 #include <machine/bus.h>
60 #include <sys/rman.h>
61 #include <machine/resource.h>
62 #include <vm/vm.h>
63 #include <vm/pmap.h>
64 #include <machine/clock.h>
65 #include <dev/pci/pcivar.h>
66 #include <dev/pci/pcireg.h>
67
68
69 #define ASSERT(x) if(!(x)) panic("EM: x")
70 #define us_scale(x) max(1, (x/(1000000/hz)))
71 static inline int
ms_scale(int x)72 ms_scale(int x) {
73 if (hz == 1000) {
74 return (x);
75 } else if (hz > 1000) {
76 return (x*(hz/1000));
77 } else {
78 return (max(1, x/(1000/hz)));
79 }
80 }
81
82 static inline void
safe_pause_us(int x)83 safe_pause_us(int x) {
84 if (cold) {
85 DELAY(x);
86 } else {
87 pause("e1000_delay", max(1, x/(1000000/hz)));
88 }
89 }
90
91 static inline void
safe_pause_ms(int x)92 safe_pause_ms(int x) {
93 if (cold) {
94 DELAY(x*1000);
95 } else {
96 pause("e1000_delay", ms_scale(x));
97 }
98 }
99
100 #define usec_delay(x) safe_pause_us(x)
101 #define usec_delay_irq(x) usec_delay(x)
102 #define msec_delay(x) safe_pause_ms(x)
103 #define msec_delay_irq(x) msec_delay(x)
104
105 /* Enable/disable debugging statements in shared code */
106 #define DBG 0
107
108 #define DEBUGOUT(...) \
109 do { if (DBG) printf(__VA_ARGS__); } while (0)
110 #define DEBUGOUT1(...) DEBUGOUT(__VA_ARGS__)
111 #define DEBUGOUT2(...) DEBUGOUT(__VA_ARGS__)
112 #define DEBUGOUT3(...) DEBUGOUT(__VA_ARGS__)
113 #define DEBUGOUT7(...) DEBUGOUT(__VA_ARGS__)
114 #define DEBUGFUNC(F) DEBUGOUT(F "\n")
115
116 #define STATIC static
117 #define CMD_MEM_WRT_INVALIDATE 0x0010 /* BIT_4 */
118 #define PCI_COMMAND_REGISTER PCIR_COMMAND
119
120 typedef uint64_t u64;
121 typedef uint32_t u32;
122 typedef uint16_t u16;
123 typedef uint8_t u8;
124 typedef int64_t s64;
125 typedef int32_t s32;
126 typedef int16_t s16;
127 typedef int8_t s8;
128
129 #define __le16 u16
130 #define __le32 u32
131 #define __le64 u64
132
133 #ifdef INVARIANTS
134 #define ASSERT_CTX_LOCK_HELD(hw) (sx_assert(iflib_ctx_lock_get(((struct e1000_osdep *)hw->back)->ctx), SX_XLOCKED))
135 #else
136 #define ASSERT_CTX_LOCK_HELD(hw)
137 #endif
138
139 #if defined(__i386__) || defined(__amd64__)
140 static __inline
prefetch(void * x)141 void prefetch(void *x)
142 {
143 __asm volatile("prefetcht0 %0" :: "m" (*(unsigned long *)x));
144 }
145 #else
146 #define prefetch(x)
147 #endif
148
149 struct e1000_osdep
150 {
151 bus_space_tag_t mem_bus_space_tag;
152 bus_space_handle_t mem_bus_space_handle;
153 bus_space_tag_t io_bus_space_tag;
154 bus_space_handle_t io_bus_space_handle;
155 bus_space_tag_t flash_bus_space_tag;
156 bus_space_handle_t flash_bus_space_handle;
157 device_t dev;
158 if_ctx_t ctx;
159 };
160
161 #define E1000_REGISTER(hw, reg) (((hw)->mac.type >= e1000_82543) \
162 ? reg : e1000_translate_register_82542(reg))
163
164 #define E1000_WRITE_FLUSH(a) E1000_READ_REG(a, E1000_STATUS)
165
166 /* Read from an absolute offset in the adapter's memory space */
167 #define E1000_READ_OFFSET(hw, offset) \
168 bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
169 ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, offset)
170
171 /* Write to an absolute offset in the adapter's memory space */
172 #define E1000_WRITE_OFFSET(hw, offset, value) \
173 bus_space_write_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
174 ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, offset, value)
175
176 /* Register READ/WRITE macros */
177
178 #define E1000_READ_REG(hw, reg) \
179 bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
180 ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
181 E1000_REGISTER(hw, reg))
182
183 #define E1000_WRITE_REG(hw, reg, value) \
184 bus_space_write_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
185 ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
186 E1000_REGISTER(hw, reg), value)
187
188 #define E1000_READ_REG_ARRAY(hw, reg, index) \
189 bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
190 ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
191 E1000_REGISTER(hw, reg) + ((index)<< 2))
192
193 #define E1000_WRITE_REG_ARRAY(hw, reg, index, value) \
194 bus_space_write_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
195 ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
196 E1000_REGISTER(hw, reg) + ((index)<< 2), value)
197
198 #define E1000_READ_REG_ARRAY_DWORD E1000_READ_REG_ARRAY
199 #define E1000_WRITE_REG_ARRAY_DWORD E1000_WRITE_REG_ARRAY
200
201 #define E1000_READ_REG_ARRAY_BYTE(hw, reg, index) \
202 bus_space_read_1(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
203 ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
204 E1000_REGISTER(hw, reg) + index)
205
206 #define E1000_WRITE_REG_ARRAY_BYTE(hw, reg, index, value) \
207 bus_space_write_1(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
208 ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
209 E1000_REGISTER(hw, reg) + index, value)
210
211 #define E1000_WRITE_REG_ARRAY_WORD(hw, reg, index, value) \
212 bus_space_write_2(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
213 ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
214 E1000_REGISTER(hw, reg) + (index << 1), value)
215
216 #define E1000_WRITE_REG_IO(hw, reg, value) do {\
217 bus_space_write_4(((struct e1000_osdep *)(hw)->back)->io_bus_space_tag, \
218 ((struct e1000_osdep *)(hw)->back)->io_bus_space_handle, \
219 (hw)->io_base, reg); \
220 bus_space_write_4(((struct e1000_osdep *)(hw)->back)->io_bus_space_tag, \
221 ((struct e1000_osdep *)(hw)->back)->io_bus_space_handle, \
222 (hw)->io_base + 4, value); } while (0)
223
224 #define E1000_READ_FLASH_REG(hw, reg) \
225 bus_space_read_4(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
226 ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg)
227
228 #define E1000_READ_FLASH_REG16(hw, reg) \
229 bus_space_read_2(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
230 ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg)
231
232 #define E1000_WRITE_FLASH_REG(hw, reg, value) \
233 bus_space_write_4(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
234 ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg, value)
235
236 #define E1000_WRITE_FLASH_REG16(hw, reg, value) \
237 bus_space_write_2(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
238 ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg, value)
239
240
241 #if defined(INVARIANTS)
242 #include <sys/proc.h>
243
244 #define ASSERT_NO_LOCKS() \
245 do { \
246 int unknown_locks = curthread->td_locks - mtx_owned(&Giant); \
247 if (unknown_locks > 0) { \
248 WITNESS_WARN(WARN_GIANTOK|WARN_SLEEPOK|WARN_PANIC, NULL, "unexpected non-sleepable lock"); \
249 } \
250 MPASS(curthread->td_rw_rlocks == 0); \
251 MPASS(curthread->td_lk_slocks == 0); \
252 } while (0)
253 #else
254 #define ASSERT_NO_LOCKS()
255 #endif
256
257 #endif /* _FREEBSD_OS_H_ */
258
259