1 /******************************************************************************
2 SPDX-License-Identifier: BSD-3-Clause
4 Copyright (c) 2001-2017, Intel Corporation
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
10 1. Redistributions of source code must retain the above copyright notice,
11 this list of conditions and the following disclaimer.
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.
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.
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.
33 ******************************************************************************/
36 #ifndef _IXGBE_OSDEP_H_
37 #define _IXGBE_OSDEP_H_
39 #include <sys/types.h>
40 #include <sys/param.h>
41 #include <sys/endian.h>
42 #include <sys/systm.h>
44 #include <sys/protosw.h>
45 #include <sys/socket.h>
46 #include <sys/malloc.h>
47 #include <sys/kernel.h>
49 #include <machine/bus.h>
51 #include <machine/resource.h>
54 #include <machine/clock.h>
55 #include <dev/pci/pcivar.h>
56 #include <dev/pci/pcireg.h>
58 #define ASSERT(x) if(!(x)) panic("IXGBE: x")
59 #define EWARN(H, W) printf(W)
64 IXGBE_ERROR_INVALID_STATE,
65 IXGBE_ERROR_UNSUPPORTED,
70 /* The happy-fun DELAY macro is defined in /usr/src/sys/i386/include/clock.h */
71 #define usec_delay(x) DELAY(x)
72 #define msec_delay(x) DELAY(1000*(x))
75 #define MSGOUT(S, A, B) printf(S "\n", A, B)
76 #define DEBUGFUNC(F) DEBUGOUT(F);
78 #define DEBUGOUT(S) printf(S "\n")
79 #define DEBUGOUT1(S,A) printf(S "\n",A)
80 #define DEBUGOUT2(S,A,B) printf(S "\n",A,B)
81 #define DEBUGOUT3(S,A,B,C) printf(S "\n",A,B,C)
82 #define DEBUGOUT4(S,A,B,C,D) printf(S "\n",A,B,C,D)
83 #define DEBUGOUT5(S,A,B,C,D,E) printf(S "\n",A,B,C,D,E)
84 #define DEBUGOUT6(S,A,B,C,D,E,F) printf(S "\n",A,B,C,D,E,F)
85 #define DEBUGOUT7(S,A,B,C,D,E,F,G) printf(S "\n",A,B,C,D,E,F,G)
86 #define ERROR_REPORT1 ERROR_REPORT
87 #define ERROR_REPORT2 ERROR_REPORT
88 #define ERROR_REPORT3 ERROR_REPORT
89 #define ERROR_REPORT(level, format, arg...) do { \
91 case IXGBE_ERROR_SOFTWARE: \
92 case IXGBE_ERROR_CAUTION: \
93 case IXGBE_ERROR_POLLING: \
94 case IXGBE_ERROR_INVALID_STATE: \
95 case IXGBE_ERROR_UNSUPPORTED: \
96 case IXGBE_ERROR_ARGUMENT: \
97 device_printf(ixgbe_dev_from_hw(hw), format, ## arg); \
105 #define DEBUGOUT1(S,A)
106 #define DEBUGOUT2(S,A,B)
107 #define DEBUGOUT3(S,A,B,C)
108 #define DEBUGOUT4(S,A,B,C,D)
109 #define DEBUGOUT5(S,A,B,C,D,E)
110 #define DEBUGOUT6(S,A,B,C,D,E,F)
111 #define DEBUGOUT7(S,A,B,C,D,E,F,G)
113 #define ERROR_REPORT1(S,A)
114 #define ERROR_REPORT2(S,A,B)
115 #define ERROR_REPORT3(S,A,B,C)
119 #define false 0 /* shared code requires this */
122 #define CMD_MEM_WRT_INVALIDATE 0x0010 /* BIT_4 */
123 #define PCI_COMMAND_REGISTER PCIR_COMMAND
125 /* Shared code dropped this define.. */
126 #define IXGBE_INTEL_VENDOR_ID 0x8086
128 /* Bunch of defines for shared code bogosity */
129 #define UNREFERENCED_PARAMETER(_p)
130 #define UNREFERENCED_1PARAMETER(_p)
131 #define UNREFERENCED_2PARAMETER(_p, _q)
132 #define UNREFERENCED_3PARAMETER(_p, _q, _r)
133 #define UNREFERENCED_4PARAMETER(_p, _q, _r, _s)
135 #define IXGBE_NTOHL(_i) ntohl(_i)
136 #define IXGBE_NTOHS(_i) ntohs(_i)
138 /* XXX these need to be revisited */
139 #define IXGBE_CPU_TO_LE16 htole16
140 #define IXGBE_CPU_TO_LE32 htole32
141 #define IXGBE_LE32_TO_CPU le32toh
142 #define IXGBE_LE32_TO_CPUS(x)
143 #define IXGBE_CPU_TO_BE16 htobe16
144 #define IXGBE_CPU_TO_BE32 htobe32
145 #define IXGBE_BE32_TO_CPU be32toh
149 typedef uint16_t u16;
151 typedef uint32_t u32;
153 typedef uint64_t u64;
154 #ifndef __bool_true_false_are_defined
155 typedef boolean_t bool;
158 /* shared code requires this */
168 #if __FreeBSD_version < 800000
169 #if defined(__i386__) || defined(__amd64__)
170 #define mb() __asm volatile("mfence" ::: "memory")
171 #define wmb() __asm volatile("sfence" ::: "memory")
172 #define rmb() __asm volatile("lfence" ::: "memory")
180 #if defined(__i386__) || defined(__amd64__)
182 void prefetch(void *x)
184 __asm volatile("prefetcht0 %0" :: "m" (*(unsigned long *)x));
191 * Optimized bcopy thanks to Luigi Rizzo's investigative work. Assumes
192 * non-overlapping regions and 32-byte padding on both src and dst.
195 ixgbe_bcopy(void *restrict _src, void *restrict _dst, int l)
197 uint64_t *src = _src;
198 uint64_t *dst = _dst;
200 for (; l > 0; l -= 32) {
211 bus_space_tag_t mem_bus_space_tag;
212 bus_space_handle_t mem_bus_space_handle;
215 /* These routines need struct ixgbe_hw declared */
218 /* These routines are needed by the shared code */
219 extern u16 ixgbe_read_pci_cfg(struct ixgbe_hw *, u32);
220 #define IXGBE_READ_PCIE_WORD ixgbe_read_pci_cfg
222 extern void ixgbe_write_pci_cfg(struct ixgbe_hw *, u32, u16);
223 #define IXGBE_WRITE_PCIE_WORD ixgbe_write_pci_cfg
225 #define IXGBE_WRITE_FLUSH(a) IXGBE_READ_REG(a, IXGBE_STATUS)
227 extern u32 ixgbe_read_reg(struct ixgbe_hw *, u32);
228 #define IXGBE_READ_REG(a, reg) ixgbe_read_reg(a, reg)
230 extern void ixgbe_write_reg(struct ixgbe_hw *, u32, u32);
231 #define IXGBE_WRITE_REG(a, reg, val) ixgbe_write_reg(a, reg, val)
233 extern u32 ixgbe_read_reg_array(struct ixgbe_hw *, u32, u32);
234 #define IXGBE_READ_REG_ARRAY(a, reg, offset) \
235 ixgbe_read_reg_array(a, reg, offset)
237 extern void ixgbe_write_reg_array(struct ixgbe_hw *, u32, u32, u32);
238 #define IXGBE_WRITE_REG_ARRAY(a, reg, offset, val) \
239 ixgbe_write_reg_array(a, reg, offset, val)
241 #endif /* _IXGBE_OSDEP_H_ */