1 /* 2 * Copyright (c) 2016 - 2018 Cavium Inc. 3 * All rights reserved. 4 * www.cavium.com 5 * 6 * See LICENSE.qede_pmd for copyright and licensing details. 7 */ 8 9 #ifndef __BCM_OSAL_H 10 #define __BCM_OSAL_H 11 12 #include <rte_byteorder.h> 13 #include <rte_spinlock.h> 14 #include <rte_malloc.h> 15 #include <rte_atomic.h> 16 #include <rte_memcpy.h> 17 #include <rte_log.h> 18 #include <rte_cycles.h> 19 #include <rte_debug.h> 20 #include <rte_ether.h> 21 #include <rte_io.h> 22 23 /* Forward declaration */ 24 struct ecore_dev; 25 struct ecore_hwfn; 26 struct ecore_ptt; 27 struct ecore_vf_acquire_sw_info; 28 struct vf_pf_resc_request; 29 enum ecore_mcp_protocol_type; 30 union ecore_mcp_protocol_stats; 31 enum ecore_hw_err_type; 32 33 void qed_link_update(struct ecore_hwfn *hwfn); 34 35 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN 36 #undef __BIG_ENDIAN 37 #ifndef __LITTLE_ENDIAN 38 #define __LITTLE_ENDIAN 39 #endif 40 #else 41 #undef __LITTLE_ENDIAN 42 #ifndef __BIG_ENDIAN 43 #define __BIG_ENDIAN 44 #endif 45 #endif 46 47 #define OSAL_WARN(arg1, arg2, arg3, ...) (0) 48 49 #define UNUSED(x) (void)(x) 50 51 /* Memory Types */ 52 typedef uint8_t u8; 53 typedef uint16_t u16; 54 typedef uint32_t u32; 55 typedef uint64_t u64; 56 57 typedef int16_t s16; 58 typedef int32_t s32; 59 60 typedef u16 __le16; 61 typedef u32 __le32; 62 typedef u32 OSAL_BE32; 63 64 #define osal_uintptr_t uintptr_t 65 66 typedef rte_iova_t dma_addr_t; 67 68 typedef rte_spinlock_t osal_spinlock_t; 69 70 typedef void *osal_dpc_t; 71 72 typedef size_t osal_size_t; 73 74 typedef intptr_t osal_int_ptr_t; 75 76 typedef int bool; 77 #define true 1 78 #define false 0 79 80 #define nothing do {} while (0) 81 82 /* Delays */ 83 84 #define DELAY(x) rte_delay_us(x) 85 #define usec_delay(x) DELAY(x) 86 #define msec_delay(x) DELAY(1000 * (x)) 87 #define OSAL_UDELAY(time) usec_delay(time) 88 #define OSAL_MSLEEP(time) msec_delay(time) 89 90 /* Memory allocations and deallocations */ 91 92 #define OSAL_NULL ((void *)0) 93 #define OSAL_ALLOC(dev, GFP, size) rte_malloc("qede", size, 0) 94 #define OSAL_ZALLOC(dev, GFP, size) rte_zmalloc("qede", size, 0) 95 #define OSAL_CALLOC(dev, GFP, num, size) rte_calloc("qede", num, size, 0) 96 #define OSAL_VZALLOC(dev, size) rte_zmalloc("qede", size, 0) 97 #define OSAL_FREE(dev, memory) \ 98 do { \ 99 rte_free((void *)memory); \ 100 memory = OSAL_NULL; \ 101 } while (0) 102 #define OSAL_VFREE(dev, memory) OSAL_FREE(dev, memory) 103 #define OSAL_MEM_ZERO(mem, size) bzero(mem, size) 104 #define OSAL_MEMCPY(dst, src, size) rte_memcpy(dst, src, size) 105 #define OSAL_MEMCMP(s1, s2, size) memcmp(s1, s2, size) 106 #define OSAL_MEMSET(dst, val, length) \ 107 memset(dst, val, length) 108 109 void *osal_dma_alloc_coherent(struct ecore_dev *, dma_addr_t *, size_t); 110 111 void *osal_dma_alloc_coherent_aligned(struct ecore_dev *, dma_addr_t *, 112 size_t, int); 113 114 void osal_dma_free_mem(struct ecore_dev *edev, dma_addr_t phys); 115 116 #define OSAL_DMA_ALLOC_COHERENT(dev, phys, size) \ 117 osal_dma_alloc_coherent(dev, phys, size) 118 119 #define OSAL_DMA_ALLOC_COHERENT_ALIGNED(dev, phys, size, align) \ 120 osal_dma_alloc_coherent_aligned(dev, phys, size, align) 121 122 #define OSAL_DMA_FREE_COHERENT(dev, virt, phys, size) \ 123 osal_dma_free_mem(dev, phys) 124 125 /* HW reads/writes */ 126 127 #define DIRECT_REG_RD(_dev, _reg_addr) rte_read32(_reg_addr) 128 129 #define REG_RD(_p_hwfn, _reg_offset) \ 130 DIRECT_REG_RD(_p_hwfn, \ 131 ((u8 *)(uintptr_t)(_p_hwfn->regview) + (_reg_offset))) 132 133 #define DIRECT_REG_WR16(_reg_addr, _val) rte_write16((_val), (_reg_addr)) 134 135 #define DIRECT_REG_WR(_dev, _reg_addr, _val) rte_write32((_val), (_reg_addr)) 136 137 #define DIRECT_REG_WR_RELAXED(_dev, _reg_addr, _val) \ 138 rte_write32_relaxed((_val), (_reg_addr)) 139 140 #define REG_WR(_p_hwfn, _reg_offset, _val) \ 141 DIRECT_REG_WR(NULL, \ 142 ((u8 *)((uintptr_t)(_p_hwfn->regview)) + (_reg_offset)), (u32)_val) 143 144 #define REG_WR16(_p_hwfn, _reg_offset, _val) \ 145 DIRECT_REG_WR16(((u8 *)(uintptr_t)(_p_hwfn->regview) + \ 146 (_reg_offset)), (u16)_val) 147 148 #define DOORBELL(_p_hwfn, _db_addr, _val) \ 149 DIRECT_REG_WR_RELAXED((_p_hwfn), \ 150 ((u8 *)(uintptr_t)(_p_hwfn->doorbells) + \ 151 (_db_addr)), (u32)_val) 152 153 #define DIRECT_REG_WR64(hwfn, addr, value) nothing 154 #define DIRECT_REG_RD64(hwfn, addr) 0 155 156 /* Mutexes */ 157 158 typedef pthread_mutex_t osal_mutex_t; 159 #define OSAL_MUTEX_RELEASE(lock) pthread_mutex_unlock(lock) 160 #define OSAL_MUTEX_INIT(lock) pthread_mutex_init(lock, NULL) 161 #define OSAL_MUTEX_ACQUIRE(lock) pthread_mutex_lock(lock) 162 #define OSAL_MUTEX_ALLOC(hwfn, lock) nothing 163 #define OSAL_MUTEX_DEALLOC(lock) nothing 164 165 /* Spinlocks */ 166 167 #define OSAL_SPIN_LOCK_INIT(lock) rte_spinlock_init(lock) 168 #define OSAL_SPIN_LOCK(lock) rte_spinlock_lock(lock) 169 #define OSAL_SPIN_UNLOCK(lock) rte_spinlock_unlock(lock) 170 #define OSAL_SPIN_LOCK_IRQSAVE(lock, flags) \ 171 do { \ 172 UNUSED(lock); \ 173 flags = 0; \ 174 UNUSED(flags); \ 175 } while (0) 176 #define OSAL_SPIN_UNLOCK_IRQSAVE(lock, flags) nothing 177 #define OSAL_SPIN_LOCK_ALLOC(hwfn, lock) nothing 178 #define OSAL_SPIN_LOCK_DEALLOC(lock) nothing 179 180 /* DPC */ 181 182 #define OSAL_DPC_ALLOC(hwfn) OSAL_ALLOC(hwfn, GFP, sizeof(osal_dpc_t)) 183 #define OSAL_DPC_INIT(dpc, hwfn) nothing 184 #define OSAL_POLL_MODE_DPC(hwfn) nothing 185 #define OSAL_DPC_SYNC(hwfn) nothing 186 187 /* Lists */ 188 189 #define OSAL_LIST_SPLICE_INIT(new_list, list) nothing 190 #define OSAL_LIST_SPLICE_TAIL_INIT(new_list, list) nothing 191 192 typedef struct _osal_list_entry_t { 193 struct _osal_list_entry_t *next, *prev; 194 } osal_list_entry_t; 195 196 typedef struct osal_list_t { 197 osal_list_entry_t *head, *tail; 198 unsigned long cnt; 199 } osal_list_t; 200 201 #define OSAL_LIST_INIT(list) \ 202 do { \ 203 (list)->head = NULL; \ 204 (list)->tail = NULL; \ 205 (list)->cnt = 0; \ 206 } while (0) 207 208 #define OSAL_LIST_PUSH_HEAD(entry, list) \ 209 do { \ 210 (entry)->prev = (osal_list_entry_t *)0; \ 211 (entry)->next = (list)->head; \ 212 if ((list)->tail == (osal_list_entry_t *)0) { \ 213 (list)->tail = (entry); \ 214 } else { \ 215 (list)->head->prev = (entry); \ 216 } \ 217 (list)->head = (entry); \ 218 (list)->cnt++; \ 219 } while (0) 220 221 #define OSAL_LIST_PUSH_TAIL(entry, list) \ 222 do { \ 223 (entry)->next = (osal_list_entry_t *)0; \ 224 (entry)->prev = (list)->tail; \ 225 if ((list)->tail) { \ 226 (list)->tail->next = (entry); \ 227 } else { \ 228 (list)->head = (entry); \ 229 } \ 230 (list)->tail = (entry); \ 231 (list)->cnt++; \ 232 } while (0) 233 234 #define OSAL_LIST_FIRST_ENTRY(list, type, field) \ 235 (type *)((list)->head) 236 237 #define OSAL_LIST_REMOVE_ENTRY(entry, list) \ 238 do { \ 239 if ((list)->head == (entry)) { \ 240 if ((list)->head) { \ 241 (list)->head = (list)->head->next; \ 242 if ((list)->head) { \ 243 (list)->head->prev = (osal_list_entry_t *)0;\ 244 } else { \ 245 (list)->tail = (osal_list_entry_t *)0; \ 246 } \ 247 (list)->cnt--; \ 248 } \ 249 } else if ((list)->tail == (entry)) { \ 250 if ((list)->tail) { \ 251 (list)->tail = (list)->tail->prev; \ 252 if ((list)->tail) { \ 253 (list)->tail->next = (osal_list_entry_t *)0;\ 254 } else { \ 255 (list)->head = (osal_list_entry_t *)0; \ 256 } \ 257 (list)->cnt--; \ 258 } \ 259 } else { \ 260 (entry)->prev->next = (entry)->next; \ 261 (entry)->next->prev = (entry)->prev; \ 262 (list)->cnt--; \ 263 } \ 264 } while (0) 265 266 #define OSAL_LIST_IS_EMPTY(list) \ 267 ((list)->cnt == 0) 268 269 #define OSAL_LIST_NEXT(entry, field, type) \ 270 (type *)((&((entry)->field))->next) 271 272 /* TODO: Check field, type order */ 273 274 #define OSAL_LIST_FOR_EACH_ENTRY(entry, list, field, type) \ 275 for (entry = OSAL_LIST_FIRST_ENTRY(list, type, field); \ 276 entry; \ 277 entry = OSAL_LIST_NEXT(entry, field, type)) 278 279 #define OSAL_LIST_FOR_EACH_ENTRY_SAFE(entry, tmp_entry, list, field, type) \ 280 for (entry = OSAL_LIST_FIRST_ENTRY(list, type, field), \ 281 tmp_entry = (entry) ? OSAL_LIST_NEXT(entry, field, type) : NULL; \ 282 entry != NULL; \ 283 entry = (type *)tmp_entry, \ 284 tmp_entry = (entry) ? OSAL_LIST_NEXT(entry, field, type) : NULL) 285 286 /* TODO: OSAL_LIST_INSERT_ENTRY_AFTER */ 287 #define OSAL_LIST_INSERT_ENTRY_AFTER(new_entry, entry, list) \ 288 OSAL_LIST_PUSH_HEAD(new_entry, list) 289 290 /* PCI config space */ 291 292 #define OSAL_PCI_READ_CONFIG_BYTE(dev, address, dst) nothing 293 #define OSAL_PCI_READ_CONFIG_WORD(dev, address, dst) nothing 294 #define OSAL_PCI_READ_CONFIG_DWORD(dev, address, dst) nothing 295 #define OSAL_PCI_FIND_EXT_CAPABILITY(dev, pcie_id) 0 296 #define OSAL_PCI_FIND_CAPABILITY(dev, pcie_id) 0 297 #define OSAL_PCI_WRITE_CONFIG_WORD(dev, address, val) nothing 298 #define OSAL_BAR_SIZE(dev, bar_id) 0 299 300 /* Barriers */ 301 302 #define OSAL_MMIOWB(dev) rte_wmb() 303 #define OSAL_BARRIER(dev) rte_compiler_barrier() 304 #define OSAL_SMP_RMB(dev) rte_rmb() 305 #define OSAL_SMP_WMB(dev) rte_wmb() 306 #define OSAL_RMB(dev) rte_rmb() 307 #define OSAL_WMB(dev) rte_wmb() 308 #define OSAL_DMA_SYNC(dev, addr, length, is_post) nothing 309 310 #define OSAL_BIT(nr) (1UL << (nr)) 311 #define OSAL_BITS_PER_BYTE (8) 312 #define OSAL_BITS_PER_UL (sizeof(unsigned long) * OSAL_BITS_PER_BYTE) 313 #define OSAL_BITS_PER_UL_MASK (OSAL_BITS_PER_UL - 1) 314 315 /* Bitops */ 316 void qede_set_bit(u32, unsigned long *); 317 #define OSAL_SET_BIT(bit, bitmap) \ 318 qede_set_bit(bit, bitmap) 319 320 void qede_clr_bit(u32, unsigned long *); 321 #define OSAL_CLEAR_BIT(bit, bitmap) \ 322 qede_clr_bit(bit, bitmap) 323 324 bool qede_test_bit(u32, unsigned long *); 325 #define OSAL_TEST_BIT(bit, bitmap) \ 326 qede_test_bit(bit, bitmap) 327 328 u32 qede_find_first_bit(unsigned long *, u32); 329 #define OSAL_FIND_FIRST_BIT(bitmap, length) \ 330 qede_find_first_bit(bitmap, length) 331 332 u32 qede_find_first_zero_bit(unsigned long *, u32); 333 #define OSAL_FIND_FIRST_ZERO_BIT(bitmap, length) \ 334 qede_find_first_zero_bit(bitmap, length) 335 336 #define OSAL_BUILD_BUG_ON(cond) nothing 337 #define ETH_ALEN ETHER_ADDR_LEN 338 339 #define OSAL_BITMAP_WEIGHT(bitmap, count) 0 340 341 #define OSAL_LINK_UPDATE(hwfn) qed_link_update(hwfn) 342 #define OSAL_TRANSCEIVER_UPDATE(hwfn) nothing 343 #define OSAL_DCBX_AEN(hwfn, mib_type) nothing 344 345 /* SR-IOV channel */ 346 347 #define OSAL_VF_FLR_UPDATE(hwfn) nothing 348 #define OSAL_VF_SEND_MSG2PF(dev, done, msg, reply_addr, msg_size, reply_size) 0 349 #define OSAL_VF_CQE_COMPLETION(_dev_p, _cqe, _protocol) (0) 350 #define OSAL_PF_VF_MSG(hwfn, vfid) 0 351 #define OSAL_PF_VF_MALICIOUS(hwfn, vfid) nothing 352 #define OSAL_IOV_CHK_UCAST(hwfn, vfid, params) 0 353 #define OSAL_IOV_POST_START_VPORT(hwfn, vf, vport_id, opaque_fid) nothing 354 #define OSAL_IOV_VF_ACQUIRE(hwfn, vfid) 0 355 #define OSAL_IOV_VF_CLEANUP(hwfn, vfid) nothing 356 #define OSAL_IOV_VF_VPORT_UPDATE(hwfn, vfid, p_params, p_mask) 0 357 #define OSAL_VF_UPDATE_ACQUIRE_RESC_RESP(_dev_p, _resc_resp) 0 358 #define OSAL_IOV_GET_OS_TYPE() 0 359 #define OSAL_IOV_VF_MSG_TYPE(hwfn, vfid, vf_msg_type) nothing 360 #define OSAL_IOV_PF_RESP_TYPE(hwfn, vfid, pf_resp_type) nothing 361 #define OSAL_IOV_VF_VPORT_STOP(hwfn, vf) nothing 362 363 u32 qede_unzip_data(struct ecore_hwfn *p_hwfn, u32 input_len, 364 u8 *input_buf, u32 max_size, u8 *unzip_buf); 365 void qede_vf_fill_driver_data(struct ecore_hwfn *, struct vf_pf_resc_request *, 366 struct ecore_vf_acquire_sw_info *); 367 void qede_hw_err_notify(struct ecore_hwfn *p_hwfn, 368 enum ecore_hw_err_type err_type); 369 #define OSAL_VF_FILL_ACQUIRE_RESC_REQ(_dev_p, _resc_req, _os_info) \ 370 qede_vf_fill_driver_data(_dev_p, _resc_req, _os_info) 371 372 #define OSAL_UNZIP_DATA(p_hwfn, input_len, buf, max_size, unzip_buf) \ 373 qede_unzip_data(p_hwfn, input_len, buf, max_size, unzip_buf) 374 375 /* TODO: */ 376 #define OSAL_SCHEDULE_RECOVERY_HANDLER(hwfn) nothing 377 #define OSAL_HW_ERROR_OCCURRED(hwfn, err_type) \ 378 qede_hw_err_notify(hwfn, err_type) 379 380 #define OSAL_NVM_IS_ACCESS_ENABLED(hwfn) (1) 381 #define OSAL_NUM_CPUS() 0 382 383 /* Utility functions */ 384 385 #define RTE_DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d)) 386 #define DIV_ROUND_UP(size, to_what) RTE_DIV_ROUND_UP(size, to_what) 387 #define RTE_ROUNDUP(x, y) ((((x) + ((y) - 1)) / (y)) * (y)) 388 #define ROUNDUP(value, to_what) RTE_ROUNDUP((value), (to_what)) 389 390 unsigned long qede_log2_align(unsigned long n); 391 #define OSAL_ROUNDUP_POW_OF_TWO(val) \ 392 qede_log2_align(val) 393 394 u32 qede_osal_log2(u32); 395 #define OSAL_LOG2(val) \ 396 qede_osal_log2(val) 397 398 #define PRINT(format, ...) printf 399 #define PRINT_ERR(format, ...) PRINT 400 401 #define OFFSETOF(str, field) __builtin_offsetof(str, field) 402 #define OSAL_ASSERT(is_assert) assert(is_assert) 403 #define OSAL_BEFORE_PF_START(file, engine) nothing 404 #define OSAL_AFTER_PF_STOP(file, engine) nothing 405 406 /* Endian macros */ 407 #define OSAL_CPU_TO_BE32(val) rte_cpu_to_be_32(val) 408 #define OSAL_BE32_TO_CPU(val) rte_be_to_cpu_32(val) 409 #define OSAL_CPU_TO_LE32(val) rte_cpu_to_le_32(val) 410 #define OSAL_CPU_TO_LE16(val) rte_cpu_to_le_16(val) 411 #define OSAL_LE32_TO_CPU(val) rte_le_to_cpu_32(val) 412 #define OSAL_LE16_TO_CPU(val) rte_le_to_cpu_16(val) 413 #define OSAL_CPU_TO_BE64(val) rte_cpu_to_be_64(val) 414 415 #define OSAL_ARRAY_SIZE(arr) RTE_DIM(arr) 416 #define OSAL_SPRINTF(name, pattern, ...) \ 417 sprintf(name, pattern, ##__VA_ARGS__) 418 #define OSAL_SNPRINTF(buf, size, format, ...) \ 419 snprintf(buf, size, format, ##__VA_ARGS__) 420 #define OSAL_STRLEN(string) strlen(string) 421 #define OSAL_STRCPY(dst, string) strcpy(dst, string) 422 #define OSAL_STRNCPY(dst, string, len) strncpy(dst, string, len) 423 #define OSAL_STRCMP(str1, str2) strcmp(str1, str2) 424 #define OSAL_STRTOUL(str, base, res) 0 425 426 #define OSAL_INLINE inline 427 #define OSAL_REG_ADDR(_p_hwfn, _offset) \ 428 (void *)((u8 *)(uintptr_t)(_p_hwfn->regview) + (_offset)) 429 #define OSAL_PAGE_SIZE 4096 430 #define OSAL_CACHE_LINE_SIZE RTE_CACHE_LINE_SIZE 431 #define OSAL_IOMEM volatile 432 #define OSAL_UNUSED __attribute__((unused)) 433 #define OSAL_UNLIKELY(x) __builtin_expect(!!(x), 0) 434 #define OSAL_MIN_T(type, __min1, __min2) \ 435 ((type)(__min1) < (type)(__min2) ? (type)(__min1) : (type)(__min2)) 436 #define OSAL_MAX_T(type, __max1, __max2) \ 437 ((type)(__max1) > (type)(__max2) ? (type)(__max1) : (type)(__max2)) 438 439 void qede_get_mcp_proto_stats(struct ecore_dev *, enum ecore_mcp_protocol_type, 440 union ecore_mcp_protocol_stats *); 441 #define OSAL_GET_PROTOCOL_STATS(dev, type, stats) \ 442 qede_get_mcp_proto_stats(dev, type, stats) 443 444 #define OSAL_SLOWPATH_IRQ_REQ(p_hwfn) (0) 445 446 u32 qede_crc32(u32 crc, u8 *ptr, u32 length); 447 #define OSAL_CRC32(crc, buf, length) qede_crc32(crc, buf, length) 448 #define OSAL_CRC8_POPULATE(table, polynomial) nothing 449 #define OSAL_CRC8(table, pdata, nbytes, crc) 0 450 #define OSAL_MFW_TLV_REQ(p_hwfn) nothing 451 #define OSAL_MFW_FILL_TLV_DATA(type, buf, data) (0) 452 #define OSAL_MFW_CMD_PREEMPT(p_hwfn) nothing 453 #define OSAL_PF_VALIDATE_MODIFY_TUNN_CONFIG(p_hwfn, mask, b_update, tunn) 0 454 455 #define OSAL_DIV_S64(a, b) ((a) / (b)) 456 #define OSAL_LLDP_RX_TLVS(p_hwfn, tlv_buf, tlv_size) nothing 457 458 #endif /* __BCM_OSAL_H */ 459