1 /****************************************************************************** 2 3 Copyright (c) 2013-2018, 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 _I40E_OSDEP_H_ 36 #define _I40E_OSDEP_H_ 37 38 #include <sys/types.h> 39 #include <sys/param.h> 40 #include <sys/systm.h> 41 #include <sys/endian.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 i40e_usec_delay(x) DELAY(x) 58 #define i40e_msec_delay(x) DELAY(1000 * (x)) 59 60 #define DBG 0 61 #define MSGOUT(S, A, B) printf(S "\n", A, B) 62 #define DEBUGFUNC(F) DEBUGOUT(F); 63 #if DBG 64 #define DEBUGOUT(S) printf(S "\n") 65 #define DEBUGOUT1(S,A) printf(S "\n",A) 66 #define DEBUGOUT2(S,A,B) printf(S "\n",A,B) 67 #define DEBUGOUT3(S,A,B,C) printf(S "\n",A,B,C) 68 #define DEBUGOUT7(S,A,B,C,D,E,F,G) printf(S "\n",A,B,C,D,E,F,G) 69 #else 70 #define DEBUGOUT(S) 71 #define DEBUGOUT1(S,A) 72 #define DEBUGOUT2(S,A,B) 73 #define DEBUGOUT3(S,A,B,C) 74 #define DEBUGOUT6(S,A,B,C,D,E,F) 75 #define DEBUGOUT7(S,A,B,C,D,E,F,G) 76 #endif 77 78 /* Remove unused shared code macros */ 79 #define UNREFERENCED_PARAMETER(_p) 80 #define UNREFERENCED_1PARAMETER(_p) 81 #define UNREFERENCED_2PARAMETER(_p, _q) 82 #define UNREFERENCED_3PARAMETER(_p, _q, _r) 83 #define UNREFERENCED_4PARAMETER(_p, _q, _r, _s) 84 #define UNREFERENCED_5PARAMETER(_p, _q, _r, _s, _t) 85 86 #define STATIC static 87 #define INLINE inline 88 89 #define FALSE 0 90 #define false 0 /* shared code requires this */ 91 #define TRUE 1 92 #define true 1 93 #define CMD_MEM_WRT_INVALIDATE 0x0010 /* BIT_4 */ 94 #define PCI_COMMAND_REGISTER PCIR_COMMAND 95 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) 96 97 #define i40e_memset(a, b, c, d) memset((a), (b), (c)) 98 #define i40e_memcpy(a, b, c, d) memcpy((a), (b), (c)) 99 100 #define CPU_TO_LE16(o) htole16(o) 101 #define CPU_TO_LE32(s) htole32(s) 102 #define CPU_TO_LE64(h) htole64(h) 103 #define LE16_TO_CPU(a) le16toh(a) 104 #define LE32_TO_CPU(c) le32toh(c) 105 #define LE64_TO_CPU(k) le64toh(k) 106 107 #define I40E_NTOHS(a) ntohs(a) 108 #define I40E_NTOHL(a) ntohl(a) 109 #define I40E_HTONS(a) htons(a) 110 #define I40E_HTONL(a) htonl(a) 111 112 #define FIELD_SIZEOF(x, y) (sizeof(((x*)0)->y)) 113 114 typedef uint8_t u8; 115 typedef int8_t s8; 116 typedef uint16_t u16; 117 typedef int16_t s16; 118 typedef uint32_t u32; 119 typedef int32_t s32; 120 typedef uint64_t u64; 121 122 /* long string relief */ 123 typedef enum i40e_status_code i40e_status; 124 125 #define __le16 u16 126 #define __le32 u32 127 #define __le64 u64 128 #define __be16 u16 129 #define __be32 u32 130 #define __be64 u64 131 132 /* SW spinlock */ 133 struct i40e_spinlock { 134 struct mtx mutex; 135 }; 136 137 #define le16_to_cpu 138 139 #if defined(__amd64__) || defined(i386) 140 static __inline 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 i40e_osdep { 150 bus_space_tag_t mem_bus_space_tag; 151 bus_space_handle_t mem_bus_space_handle; 152 bus_size_t mem_bus_space_size; 153 uint32_t flush_reg; 154 int i2c_intfc_num; 155 device_t dev; 156 }; 157 158 struct i40e_dma_mem { 159 void *va; 160 u64 pa; 161 bus_dma_tag_t tag; 162 bus_dmamap_t map; 163 bus_dma_segment_t seg; 164 bus_size_t size; 165 int nseg; 166 int flags; 167 }; 168 169 struct i40e_virt_mem { 170 void *va; 171 u32 size; 172 }; 173 174 struct i40e_hw; /* forward decl */ 175 u16 i40e_read_pci_cfg(struct i40e_hw *, u32); 176 void i40e_write_pci_cfg(struct i40e_hw *, u32, u16); 177 178 /* 179 ** i40e_debug - OS dependent version of shared code debug printing 180 */ 181 enum i40e_debug_mask; 182 #define i40e_debug(h, m, s, ...) i40e_debug_shared(h, m, s, ##__VA_ARGS__) 183 extern void i40e_debug_shared(struct i40e_hw *hw, enum i40e_debug_mask mask, 184 char *fmt_str, ...); 185 186 /* Non-busy-wait that uses kern_yield() */ 187 void i40e_msec_pause(int); 188 189 const char * ixl_vc_opcode_str(uint16_t op); 190 191 /* 192 ** This hardware supports either 16 or 32 byte rx descriptors; 193 ** the driver only uses the 32 byte kind. 194 */ 195 #define i40e_rx_desc i40e_32byte_rx_desc 196 197 static __inline uint32_t 198 rd32_osdep(struct i40e_osdep *osdep, uint32_t reg) 199 { 200 201 KASSERT(reg < osdep->mem_bus_space_size, 202 ("ixl: register offset %#jx too large (max is %#jx)", 203 (uintmax_t)reg, (uintmax_t)osdep->mem_bus_space_size)); 204 205 return (bus_space_read_4(osdep->mem_bus_space_tag, 206 osdep->mem_bus_space_handle, reg)); 207 } 208 209 static __inline void 210 wr32_osdep(struct i40e_osdep *osdep, uint32_t reg, uint32_t value) 211 { 212 213 KASSERT(reg < osdep->mem_bus_space_size, 214 ("ixl: register offset %#jx too large (max is %#jx)", 215 (uintmax_t)reg, (uintmax_t)osdep->mem_bus_space_size)); 216 217 bus_space_write_4(osdep->mem_bus_space_tag, 218 osdep->mem_bus_space_handle, reg, value); 219 } 220 221 static __inline void 222 ixl_flush_osdep(struct i40e_osdep *osdep) 223 { 224 rd32_osdep(osdep, osdep->flush_reg); 225 } 226 227 #define rd32(a, reg) rd32_osdep((a)->back, (reg)) 228 #define wr32(a, reg, value) wr32_osdep((a)->back, (reg), (value)) 229 230 #define rd64(a, reg) (\ 231 bus_space_read_8( ((struct i40e_osdep *)(a)->back)->mem_bus_space_tag, \ 232 ((struct i40e_osdep *)(a)->back)->mem_bus_space_handle, \ 233 reg)) 234 235 #define wr64(a, reg, value) (\ 236 bus_space_write_8( ((struct i40e_osdep *)(a)->back)->mem_bus_space_tag, \ 237 ((struct i40e_osdep *)(a)->back)->mem_bus_space_handle, \ 238 reg, value)) 239 240 #define ixl_flush(a) ixl_flush_osdep((a)->back) 241 242 enum i40e_status_code i40e_read_nvm_word_srctl(struct i40e_hw *hw, u16 offset, 243 u16 *data); 244 245 #endif /* _I40E_OSDEP_H_ */ 246