1 /****************************************************************************** 2 3 Copyright (c) 2001-2015, Intel Corporation 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. Redistributions in binary form must reproduce the above copyright 13 notice, this list of conditions and the following disclaimer in the 14 documentation and/or other materials provided with the distribution. 15 16 3. Neither the name of the Intel Corporation nor the names of its 17 contributors may be used to endorse or promote products derived from 18 this software without specific prior written permission. 19 20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 POSSIBILITY OF SUCH DAMAGE. 31 32 ******************************************************************************/ 33 /*$FreeBSD$*/ 34 35 #ifndef _IXGBE_OS_H_ 36 #define _IXGBE_OS_H_ 37 38 #include <sys/types.h> 39 #include <sys/param.h> 40 #include <sys/endian.h> 41 #include <sys/systm.h> 42 #include <sys/mbuf.h> 43 #include <sys/protosw.h> 44 #include <sys/socket.h> 45 #include <sys/malloc.h> 46 #include <sys/kernel.h> 47 #include <sys/bus.h> 48 #include <machine/bus.h> 49 #include <sys/rman.h> 50 #include <machine/resource.h> 51 #include <vm/vm.h> 52 #include <vm/pmap.h> 53 #include <machine/clock.h> 54 #include <dev/pci/pcivar.h> 55 #include <dev/pci/pcireg.h> 56 57 #define ASSERT(x) if(!(x)) panic("IXGBE: x") 58 #define EWARN(H, W, S) printf(W) 59 60 enum { 61 IXGBE_ERROR_SOFTWARE, 62 IXGBE_ERROR_POLLING, 63 IXGBE_ERROR_INVALID_STATE, 64 IXGBE_ERROR_UNSUPPORTED, 65 IXGBE_ERROR_ARGUMENT, 66 IXGBE_ERROR_CAUTION, 67 }; 68 69 /* The happy-fun DELAY macro is defined in /usr/src/sys/i386/include/clock.h */ 70 #define usec_delay(x) DELAY(x) 71 #define msec_delay(x) DELAY(1000*(x)) 72 73 #define DBG 0 74 #define MSGOUT(S, A, B) printf(S "\n", A, B) 75 #define DEBUGFUNC(F) DEBUGOUT(F); 76 #if DBG 77 #define DEBUGOUT(S) printf(S "\n") 78 #define DEBUGOUT1(S,A) printf(S "\n",A) 79 #define DEBUGOUT2(S,A,B) printf(S "\n",A,B) 80 #define DEBUGOUT3(S,A,B,C) printf(S "\n",A,B,C) 81 #define DEBUGOUT4(S,A,B,C,D) printf(S "\n",A,B,C,D) 82 #define DEBUGOUT5(S,A,B,C,D,E) printf(S "\n",A,B,C,D,E) 83 #define DEBUGOUT6(S,A,B,C,D,E,F) printf(S "\n",A,B,C,D,E,F) 84 #define DEBUGOUT7(S,A,B,C,D,E,F,G) printf(S "\n",A,B,C,D,E,F,G) 85 #define ERROR_REPORT1 ERROR_REPORT 86 #define ERROR_REPORT2 ERROR_REPORT 87 #define ERROR_REPORT3 ERROR_REPORT 88 #define ERROR_REPORT(level, format, arg...) do { \ 89 switch (level) { \ 90 case IXGBE_ERROR_SOFTWARE: \ 91 case IXGBE_ERROR_CAUTION: \ 92 case IXGBE_ERROR_POLLING: \ 93 case IXGBE_ERROR_INVALID_STATE: \ 94 case IXGBE_ERROR_UNSUPPORTED: \ 95 case IXGBE_ERROR_ARGUMENT: \ 96 device_printf(ixgbe_dev_from_hw(hw), format, ## arg); \ 97 break; \ 98 default: \ 99 break; \ 100 } \ 101 } while (0) 102 #else 103 #define DEBUGOUT(S) 104 #define DEBUGOUT1(S,A) 105 #define DEBUGOUT2(S,A,B) 106 #define DEBUGOUT3(S,A,B,C) 107 #define DEBUGOUT4(S,A,B,C,D) 108 #define DEBUGOUT5(S,A,B,C,D,E) 109 #define DEBUGOUT6(S,A,B,C,D,E,F) 110 #define DEBUGOUT7(S,A,B,C,D,E,F,G) 111 112 #define ERROR_REPORT1(S,A) 113 #define ERROR_REPORT2(S,A,B) 114 #define ERROR_REPORT3(S,A,B,C) 115 #endif 116 117 #define FALSE 0 118 #define false 0 /* shared code requires this */ 119 #define TRUE 1 120 #define true 1 121 #define CMD_MEM_WRT_INVALIDATE 0x0010 /* BIT_4 */ 122 #define PCI_COMMAND_REGISTER PCIR_COMMAND 123 124 /* Shared code dropped this define.. */ 125 #define IXGBE_INTEL_VENDOR_ID 0x8086 126 127 /* Bunch of defines for shared code bogosity */ 128 #define UNREFERENCED_PARAMETER(_p) 129 #define UNREFERENCED_1PARAMETER(_p) 130 #define UNREFERENCED_2PARAMETER(_p, _q) 131 #define UNREFERENCED_3PARAMETER(_p, _q, _r) 132 #define UNREFERENCED_4PARAMETER(_p, _q, _r, _s) 133 134 #define IXGBE_NTOHL(_i) ntohl(_i) 135 #define IXGBE_NTOHS(_i) ntohs(_i) 136 137 /* XXX these need to be revisited */ 138 #define IXGBE_CPU_TO_LE32 htole32 139 #define IXGBE_LE32_TO_CPUS(x) 140 #define IXGBE_CPU_TO_BE16 htobe16 141 #define IXGBE_CPU_TO_BE32 htobe32 142 143 typedef uint8_t u8; 144 typedef int8_t s8; 145 typedef uint16_t u16; 146 typedef int16_t s16; 147 typedef uint32_t u32; 148 typedef int32_t s32; 149 typedef uint64_t u64; 150 #ifndef __bool_true_false_are_defined 151 typedef boolean_t bool; 152 #endif 153 154 /* shared code requires this */ 155 #define __le16 u16 156 #define __le32 u32 157 #define __le64 u64 158 #define __be16 u16 159 #define __be32 u32 160 #define __be64 u64 161 162 #define le16_to_cpu 163 164 #if __FreeBSD_version < 800000 165 #if defined(__i386__) || defined(__amd64__) 166 #define mb() __asm volatile("mfence" ::: "memory") 167 #define wmb() __asm volatile("sfence" ::: "memory") 168 #define rmb() __asm volatile("lfence" ::: "memory") 169 #else 170 #define mb() 171 #define rmb() 172 #define wmb() 173 #endif 174 #endif 175 176 #if defined(__i386__) || defined(__amd64__) 177 static __inline 178 void prefetch(void *x) 179 { 180 __asm volatile("prefetcht0 %0" :: "m" (*(unsigned long *)x)); 181 } 182 #else 183 #define prefetch(x) 184 #endif 185 186 /* 187 * Optimized bcopy thanks to Luigi Rizzo's investigative work. Assumes 188 * non-overlapping regions and 32-byte padding on both src and dst. 189 */ 190 static __inline int 191 ixgbe_bcopy(void *restrict _src, void *restrict _dst, int l) 192 { 193 uint64_t *src = _src; 194 uint64_t *dst = _dst; 195 196 for (; l > 0; l -= 32) { 197 *dst++ = *src++; 198 *dst++ = *src++; 199 *dst++ = *src++; 200 *dst++ = *src++; 201 } 202 return (0); 203 } 204 205 struct ixgbe_osdep 206 { 207 bus_space_tag_t mem_bus_space_tag; 208 bus_space_handle_t mem_bus_space_handle; 209 }; 210 211 /* These routines need struct ixgbe_hw declared */ 212 struct ixgbe_hw; 213 device_t ixgbe_dev_from_hw(struct ixgbe_hw *hw); 214 215 /* These routines are needed by the shared code */ 216 extern u16 ixgbe_read_pci_cfg(struct ixgbe_hw *, u32); 217 #define IXGBE_READ_PCIE_WORD ixgbe_read_pci_cfg 218 219 extern void ixgbe_write_pci_cfg(struct ixgbe_hw *, u32, u16); 220 #define IXGBE_WRITE_PCIE_WORD ixgbe_write_pci_cfg 221 222 #define IXGBE_WRITE_FLUSH(a) IXGBE_READ_REG(a, IXGBE_STATUS) 223 224 extern u32 ixgbe_read_reg(struct ixgbe_hw *, u32); 225 #define IXGBE_READ_REG(a, reg) ixgbe_read_reg(a, reg) 226 227 extern void ixgbe_write_reg(struct ixgbe_hw *, u32, u32); 228 #define IXGBE_WRITE_REG(a, reg, val) ixgbe_write_reg(a, reg, val) 229 230 extern u32 ixgbe_read_reg_array(struct ixgbe_hw *, u32, u32); 231 #define IXGBE_READ_REG_ARRAY(a, reg, offset) \ 232 ixgbe_read_reg_array(a, reg, offset) 233 234 extern void ixgbe_write_reg_array(struct ixgbe_hw *, u32, u32, u32); 235 #define IXGBE_WRITE_REG_ARRAY(a, reg, offset, val) \ 236 ixgbe_write_reg_array(a, reg, offset, val) 237 238 #endif /* _IXGBE_OS_H_ */ 239