1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) 2015-2017 Amazon.com, Inc. or its affiliates. 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 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of copyright holder nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #ifndef ENA_PLAT_H_ 35 #define ENA_PLAT_H_ 36 37 #include <sys/cdefs.h> 38 __FBSDID("$FreeBSD$"); 39 40 #include <sys/param.h> 41 #include <sys/systm.h> 42 43 #include <sys/bus.h> 44 #include <sys/condvar.h> 45 #include <sys/endian.h> 46 #include <sys/kernel.h> 47 #include <sys/kthread.h> 48 #include <sys/malloc.h> 49 #include <sys/mbuf.h> 50 #include <sys/module.h> 51 #include <sys/rman.h> 52 #include <sys/proc.h> 53 #include <sys/smp.h> 54 #include <sys/socket.h> 55 #include <sys/sockio.h> 56 #include <sys/sysctl.h> 57 #include <sys/taskqueue.h> 58 #include <sys/eventhandler.h> 59 #include <sys/types.h> 60 #include <sys/timetc.h> 61 #include <sys/cdefs.h> 62 63 #include <machine/atomic.h> 64 #include <machine/bus.h> 65 #include <machine/in_cksum.h> 66 #include <machine/pcpu.h> 67 #include <machine/resource.h> 68 69 #include <net/bpf.h> 70 #include <net/ethernet.h> 71 #include <net/if.h> 72 #include <net/if_var.h> 73 #include <net/if_arp.h> 74 #include <net/if_dl.h> 75 #include <net/if_media.h> 76 77 #include <net/if_types.h> 78 #include <net/if_vlan_var.h> 79 80 #include <netinet/in_systm.h> 81 #include <netinet/in.h> 82 #include <netinet/if_ether.h> 83 #include <netinet/ip.h> 84 #include <netinet/ip6.h> 85 #include <netinet/tcp.h> 86 #include <netinet/tcp_lro.h> 87 #include <netinet/udp.h> 88 89 #include <dev/led/led.h> 90 #include <dev/pci/pcivar.h> 91 #include <dev/pci/pcireg.h> 92 93 extern struct ena_bus_space ebs; 94 95 /* Levels */ 96 #define ENA_ALERT (1 << 0) /* Alerts are providing more error info. */ 97 #define ENA_WARNING (1 << 1) /* Driver output is more error sensitive. */ 98 #define ENA_INFO (1 << 2) /* Provides additional driver info. */ 99 #define ENA_DBG (1 << 3) /* Driver output for debugging. */ 100 /* Detailed info that will be printed with ENA_INFO or ENA_DEBUG flag. */ 101 #define ENA_TXPTH (1 << 4) /* Allows TX path tracing. */ 102 #define ENA_RXPTH (1 << 5) /* Allows RX path tracing. */ 103 #define ENA_RSC (1 << 6) /* Goes with TXPTH or RXPTH, free/alloc res. */ 104 #define ENA_IOQ (1 << 7) /* Detailed info about IO queues. */ 105 #define ENA_ADMQ (1 << 8) /* Detailed info about admin queue. */ 106 107 #ifndef ENA_DEBUG_LEVEL 108 #define ENA_DEBUG_LEVEL (ENA_ALERT | ENA_WARNING) 109 #endif 110 111 #ifdef ENA_TRACE 112 #define ena_trace_raw(level, fmt, args...) \ 113 do { \ 114 if (((level) & ENA_DEBUG_LEVEL) != (level)) \ 115 break; \ 116 printf(fmt, ##args); \ 117 } while (0) 118 119 #define ena_trace(level, fmt, args...) \ 120 ena_trace_raw(level, "%s() [TID:%d]: " \ 121 fmt " \n", __func__, curthread->td_tid, ##args) 122 123 #else /* ENA_TRACE */ 124 #define ena_trace_raw(...) 125 #define ena_trace(...) 126 #endif /* ENA_TRACE */ 127 128 #define ena_trc_dbg(format, arg...) ena_trace(ENA_DBG, format, ##arg) 129 #define ena_trc_info(format, arg...) ena_trace(ENA_INFO, format, ##arg) 130 #define ena_trc_warn(format, arg...) ena_trace(ENA_WARNING, format, ##arg) 131 #define ena_trc_err(format, arg...) ena_trace(ENA_ALERT, format, ##arg) 132 133 #define unlikely(x) __predict_false(x) 134 #define likely(x) __predict_true(x) 135 136 #define __iomem 137 #define ____cacheline_aligned __aligned(CACHE_LINE_SIZE) 138 139 #define MAX_ERRNO 4095 140 #define IS_ERR_VALUE(x) unlikely((x) <= (unsigned long)MAX_ERRNO) 141 142 #define ENA_ASSERT(cond, format, arg...) \ 143 do { \ 144 if (unlikely(!(cond))) { \ 145 ena_trc_err( \ 146 "Assert failed on %s:%s:%d:" format, \ 147 __FILE__, __func__, __LINE__, ##arg); \ 148 } \ 149 } while (0) 150 151 #define ENA_WARN(cond, format, arg...) \ 152 do { \ 153 if (unlikely((cond))) { \ 154 ena_trc_warn(format, ##arg); \ 155 } \ 156 } while (0) 157 158 static inline long IS_ERR(const void *ptr) 159 { 160 return IS_ERR_VALUE((unsigned long)ptr); 161 } 162 163 static inline void *ERR_PTR(long error) 164 { 165 return (void *)error; 166 } 167 168 static inline long PTR_ERR(const void *ptr) 169 { 170 return (long) ptr; 171 } 172 173 #define GENMASK(h, l) (((1U << ((h) - (l) + 1)) - 1) << (l)) 174 #define GENMASK_ULL(h, l) (((~0ULL) << (l)) & (~0ULL >> (64 - 1 - (h)))) 175 #define BIT(x) (1 << (x)) 176 177 #define ENA_ABORT() BUG() 178 #define BUG() panic("ENA BUG") 179 180 #define SZ_256 (256) 181 #define SZ_4K (4096) 182 183 #define ENA_COM_OK 0 184 #define ENA_COM_FAULT EFAULT 185 #define ENA_COM_INVAL EINVAL 186 #define ENA_COM_NO_MEM ENOMEM 187 #define ENA_COM_NO_SPACE ENOSPC 188 #define ENA_COM_TRY_AGAIN -1 189 #define ENA_COM_UNSUPPORTED EOPNOTSUPP 190 #define ENA_COM_NO_DEVICE ENODEV 191 #define ENA_COM_PERMISSION EPERM 192 #define ENA_COM_TIMER_EXPIRED ETIMEDOUT 193 194 #define ENA_MSLEEP(x) pause_sbt("ena", SBT_1MS * (x), SBT_1MS, 0) 195 #define ENA_UDELAY(x) DELAY(x) 196 #define ENA_GET_SYSTEM_TIMEOUT(timeout_us) \ 197 ((long)cputick2usec(cpu_ticks()) + (timeout_us)) 198 #define ENA_TIME_EXPIRE(timeout) ((timeout) < (long)cputick2usec(cpu_ticks())) 199 #define ENA_MIGHT_SLEEP() 200 201 #define min_t(type, _x, _y) ((type)(_x) < (type)(_y) ? (type)(_x) : (type)(_y)) 202 #define max_t(type, _x, _y) ((type)(_x) > (type)(_y) ? (type)(_x) : (type)(_y)) 203 204 #define ENA_MIN32(x,y) MIN(x, y) 205 #define ENA_MIN16(x,y) MIN(x, y) 206 #define ENA_MIN8(x,y) MIN(x, y) 207 208 #define ENA_MAX32(x,y) MAX(x, y) 209 #define ENA_MAX16(x,y) MAX(x, y) 210 #define ENA_MAX8(x,y) MAX(x, y) 211 212 /* Spinlock related methods */ 213 #define ena_spinlock_t struct mtx 214 #define ENA_SPINLOCK_INIT(spinlock) \ 215 mtx_init(&(spinlock), "ena_spin", NULL, MTX_SPIN) 216 #define ENA_SPINLOCK_DESTROY(spinlock) \ 217 do { \ 218 if (mtx_initialized(&(spinlock))) \ 219 mtx_destroy(&(spinlock)); \ 220 } while (0) 221 #define ENA_SPINLOCK_LOCK(spinlock, flags) \ 222 do { \ 223 (void)(flags); \ 224 mtx_lock_spin(&(spinlock)); \ 225 } while (0) 226 #define ENA_SPINLOCK_UNLOCK(spinlock, flags) \ 227 do { \ 228 (void)(flags); \ 229 mtx_unlock_spin(&(spinlock)); \ 230 } while (0) 231 232 233 /* Wait queue related methods */ 234 #define ena_wait_event_t struct { struct cv wq; struct mtx mtx; } 235 #define ENA_WAIT_EVENT_INIT(waitqueue) \ 236 do { \ 237 cv_init(&((waitqueue).wq), "cv"); \ 238 mtx_init(&((waitqueue).mtx), "wq", NULL, MTX_DEF); \ 239 } while (0) 240 #define ENA_WAIT_EVENT_DESTROY(waitqueue) \ 241 do { \ 242 cv_destroy(&((waitqueue).wq)); \ 243 mtx_destroy(&((waitqueue).mtx)); \ 244 } while (0) 245 #define ENA_WAIT_EVENT_CLEAR(waitqueue) \ 246 cv_init(&((waitqueue).wq), (waitqueue).wq.cv_description) 247 #define ENA_WAIT_EVENT_WAIT(waitqueue, timeout_us) \ 248 do { \ 249 mtx_lock(&((waitqueue).mtx)); \ 250 cv_timedwait(&((waitqueue).wq), &((waitqueue).mtx), \ 251 timeout_us * hz / 1000 / 1000 ); \ 252 mtx_unlock(&((waitqueue).mtx)); \ 253 } while (0) 254 #define ENA_WAIT_EVENT_SIGNAL(waitqueue) cv_broadcast(&((waitqueue).wq)) 255 256 #define dma_addr_t bus_addr_t 257 #define u8 uint8_t 258 #define u16 uint16_t 259 #define u32 uint32_t 260 #define u64 uint64_t 261 262 typedef struct { 263 bus_addr_t paddr; 264 caddr_t vaddr; 265 bus_dma_tag_t tag; 266 bus_dmamap_t map; 267 bus_dma_segment_t seg; 268 int nseg; 269 } ena_mem_handle_t; 270 271 struct ena_bus { 272 bus_space_handle_t reg_bar_h; 273 bus_space_tag_t reg_bar_t; 274 bus_space_handle_t mem_bar_h; 275 bus_space_tag_t mem_bar_t; 276 }; 277 278 typedef uint32_t ena_atomic32_t; 279 280 void ena_dmamap_callback(void *arg, bus_dma_segment_t *segs, int nseg, 281 int error); 282 int ena_dma_alloc(device_t dmadev, bus_size_t size, ena_mem_handle_t *dma, 283 int mapflags); 284 285 #define ENA_MEMCPY_TO_DEVICE_64(dst, src, size) \ 286 do { \ 287 int count, i; \ 288 volatile uint64_t *to = (volatile uint64_t *)(dst); \ 289 const uint64_t *from = (const uint64_t *)(src); \ 290 count = (size) / 8; \ 291 \ 292 for (i = 0; i < count; i++, from++, to++) \ 293 *to = *from; \ 294 } while (0) 295 296 #define ENA_MEM_ALLOC(dmadev, size) malloc(size, M_DEVBUF, M_NOWAIT | M_ZERO) 297 #define ENA_MEM_ALLOC_NODE(dmadev, size, virt, node, dev_node) (virt = NULL) 298 #define ENA_MEM_FREE(dmadev, ptr) free(ptr, M_DEVBUF) 299 #define ENA_MEM_ALLOC_COHERENT_NODE(dmadev, size, virt, phys, handle, node, \ 300 dev_node) \ 301 do { \ 302 ((virt) = NULL); \ 303 (void)(dev_node); \ 304 } while (0) 305 306 #define ENA_MEM_ALLOC_COHERENT(dmadev, size, virt, phys, dma) \ 307 do { \ 308 ena_dma_alloc((dmadev), (size), &(dma), 0); \ 309 (virt) = (void *)(dma).vaddr; \ 310 (phys) = (dma).paddr; \ 311 } while (0) 312 313 #define ENA_MEM_FREE_COHERENT(dmadev, size, virt, phys, dma) \ 314 do { \ 315 (void)size; \ 316 bus_dmamap_unload((dma).tag, (dma).map); \ 317 bus_dmamem_free((dma).tag, (virt), (dma).map); \ 318 bus_dma_tag_destroy((dma).tag); \ 319 (dma).tag = NULL; \ 320 (virt) = NULL; \ 321 } while (0) 322 323 /* Register R/W methods */ 324 #define ENA_REG_WRITE32(bus, value, offset) \ 325 bus_space_write_4( \ 326 ((struct ena_bus*)bus)->reg_bar_t, \ 327 ((struct ena_bus*)bus)->reg_bar_h, \ 328 (bus_size_t)(offset), (value)) 329 330 #define ENA_REG_READ32(bus, offset) \ 331 bus_space_read_4( \ 332 ((struct ena_bus*)bus)->reg_bar_t, \ 333 ((struct ena_bus*)bus)->reg_bar_h, \ 334 (bus_size_t)(offset)) 335 336 #define ENA_DB_SYNC(mem_handle) bus_dmamap_sync((mem_handle)->tag, \ 337 (mem_handle)->map, BUS_DMASYNC_PREREAD) 338 339 #define time_after(a,b) ((long)((unsigned long)(b) - (unsigned long)(a)) < 0) 340 341 #define VLAN_HLEN sizeof(struct ether_vlan_header) 342 #define CSUM_OFFLOAD (CSUM_IP|CSUM_TCP|CSUM_UDP) 343 344 #if defined(__i386__) || defined(__amd64__) 345 static __inline 346 void prefetch(void *x) 347 { 348 __asm volatile("prefetcht0 %0" :: "m" (*(unsigned long *)x)); 349 } 350 #else 351 #define prefetch(x) 352 #endif 353 354 /* DMA buffers access */ 355 #define dma_unmap_addr(p, name) ((p)->dma->name) 356 #define dma_unmap_addr_set(p, name, v) (((p)->dma->name) = (v)) 357 #define dma_unmap_len(p, name) ((p)->name) 358 #define dma_unmap_len_set(p, name, v) (((p)->name) = (v)) 359 360 #define memcpy_toio memcpy 361 362 #define ATOMIC32_INC(I32_PTR) atomic_add_int(I32_PTR, 1) 363 #define ATOMIC32_DEC(I32_PTR) atomic_add_int(I32_PTR, -1) 364 #define ATOMIC32_READ(I32_PTR) atomic_load_acq_int(I32_PTR) 365 #define ATOMIC32_SET(I32_PTR, VAL) atomic_store_rel_int(I32_PTR, VAL) 366 367 #define barrier() __asm__ __volatile__("": : :"memory") 368 #define ACCESS_ONCE(x) (*(volatile __typeof(x) *)&(x)) 369 #define READ_ONCE(x) ({ \ 370 __typeof(x) __var; \ 371 barrier(); \ 372 __var = ACCESS_ONCE(x); \ 373 barrier(); \ 374 __var; \ 375 }) 376 377 #include "ena_defs/ena_includes.h" 378 379 #endif /* ENA_PLAT_H_ */ 380