1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (c) 2016 - 2018 Cavium Inc. 3 * All rights reserved. 4 * www.cavium.com 5 */ 6 7 #ifndef __BCM_OSAL_H 8 #define __BCM_OSAL_H 9 10 #include <stdbool.h> 11 #include <pthread.h> 12 #include <time.h> 13 14 #include <rte_bitops.h> 15 #include <rte_branch_prediction.h> 16 #include <rte_byteorder.h> 17 #include <rte_spinlock.h> 18 #include <rte_malloc.h> 19 #include <rte_atomic.h> 20 #include <rte_log.h> 21 #include <rte_cycles.h> 22 #include <rte_debug.h> 23 #include <rte_ether.h> 24 #include <rte_io.h> 25 #include <rte_version.h> 26 #include <bus_pci_driver.h> 27 28 /* Forward declaration */ 29 struct ecore_dev; 30 struct ecore_hwfn; 31 struct ecore_ptt; 32 struct ecore_vf_acquire_sw_info; 33 struct vf_pf_resc_request; 34 enum ecore_mcp_protocol_type; 35 union ecore_mcp_protocol_stats; 36 enum ecore_hw_err_type; 37 38 void qed_link_update(struct ecore_hwfn *hwfn); 39 40 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN 41 #undef __BIG_ENDIAN 42 #ifndef __LITTLE_ENDIAN 43 #define __LITTLE_ENDIAN 44 #endif 45 #else 46 #undef __LITTLE_ENDIAN 47 #ifndef __BIG_ENDIAN 48 #define __BIG_ENDIAN 49 #endif 50 #endif 51 52 #define OSAL_WARN(arg1, arg2, arg3, ...) (0) 53 54 #define UNUSED(x) (void)(x) 55 56 /* Memory Types */ 57 typedef uint8_t u8; 58 typedef uint16_t u16; 59 typedef uint32_t u32; 60 typedef uint64_t u64; 61 62 typedef int16_t s16; 63 typedef int32_t s32; 64 65 typedef u16 __le16; 66 typedef u32 __le32; 67 typedef u32 OSAL_BE32; 68 69 #define osal_uintptr_t uintptr_t 70 71 typedef rte_iova_t dma_addr_t; 72 73 typedef rte_spinlock_t osal_spinlock_t; 74 75 typedef void *osal_dpc_t; 76 77 typedef size_t osal_size_t; 78 79 typedef intptr_t osal_int_ptr_t; 80 81 #define nothing do {} while (0) 82 83 /* Delays */ 84 85 #define DELAY(x) rte_delay_us(x) 86 #define usec_delay(x) DELAY(x) 87 #define OSAL_UDELAY(time) usec_delay(time) 88 #define OSAL_MSLEEP(time) rte_delay_us_sleep(1000 * (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) 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_RD64(hwfn, addr) rte_read64(addr) 154 #define DIRECT_REG_WR64(hwfn, addr, value) rte_write64((value), (addr)) 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 void osal_poll_mode_dpc(osal_int_ptr_t hwfn_cookie); 183 #define OSAL_DPC_ALLOC(hwfn) OSAL_ALLOC(hwfn, GFP, sizeof(osal_dpc_t)) 184 #define OSAL_DPC_INIT(dpc, hwfn) \ 185 OSAL_SPIN_LOCK_INIT(&(hwfn)->spq_lock) 186 #define OSAL_POLL_MODE_DPC(hwfn) \ 187 osal_poll_mode_dpc((osal_int_ptr_t)(p_hwfn)) 188 #define OSAL_DPC_SYNC(hwfn) nothing 189 190 /* Lists */ 191 192 #define OSAL_LIST_SPLICE_INIT(new_list, list) nothing 193 #define OSAL_LIST_SPLICE_TAIL_INIT(new_list, list) nothing 194 195 typedef struct _osal_list_entry_t { 196 struct _osal_list_entry_t *next, *prev; 197 } osal_list_entry_t; 198 199 typedef struct osal_list_t { 200 osal_list_entry_t *head, *tail; 201 unsigned long cnt; 202 } osal_list_t; 203 204 #define OSAL_LIST_INIT(list) \ 205 do { \ 206 (list)->head = NULL; \ 207 (list)->tail = NULL; \ 208 (list)->cnt = 0; \ 209 } while (0) 210 211 #define OSAL_LIST_PUSH_HEAD(entry, list) \ 212 do { \ 213 (entry)->prev = (osal_list_entry_t *)0; \ 214 (entry)->next = (list)->head; \ 215 if ((list)->tail == (osal_list_entry_t *)0) { \ 216 (list)->tail = (entry); \ 217 } else { \ 218 (list)->head->prev = (entry); \ 219 } \ 220 (list)->head = (entry); \ 221 (list)->cnt++; \ 222 } while (0) 223 224 #define OSAL_LIST_PUSH_TAIL(entry, list) \ 225 do { \ 226 (entry)->next = (osal_list_entry_t *)0; \ 227 (entry)->prev = (list)->tail; \ 228 if ((list)->tail) { \ 229 (list)->tail->next = (entry); \ 230 } else { \ 231 (list)->head = (entry); \ 232 } \ 233 (list)->tail = (entry); \ 234 (list)->cnt++; \ 235 } while (0) 236 237 #define OSAL_LIST_FIRST_ENTRY(list, type, field) \ 238 (type *)((list)->head) 239 240 #define OSAL_LIST_REMOVE_ENTRY(entry, list) \ 241 do { \ 242 if ((list)->head == (entry)) { \ 243 if ((list)->head) { \ 244 (list)->head = (list)->head->next; \ 245 if ((list)->head) { \ 246 (list)->head->prev = (osal_list_entry_t *)0;\ 247 } else { \ 248 (list)->tail = (osal_list_entry_t *)0; \ 249 } \ 250 (list)->cnt--; \ 251 } \ 252 } else if ((list)->tail == (entry)) { \ 253 if ((list)->tail) { \ 254 (list)->tail = (list)->tail->prev; \ 255 if ((list)->tail) { \ 256 (list)->tail->next = (osal_list_entry_t *)0;\ 257 } else { \ 258 (list)->head = (osal_list_entry_t *)0; \ 259 } \ 260 (list)->cnt--; \ 261 } \ 262 } else { \ 263 (entry)->prev->next = (entry)->next; \ 264 (entry)->next->prev = (entry)->prev; \ 265 (list)->cnt--; \ 266 } \ 267 } while (0) 268 269 #define OSAL_LIST_IS_EMPTY(list) \ 270 ((list)->cnt == 0) 271 272 #define OSAL_LIST_NEXT(entry, field, type) \ 273 (type *)((&((entry)->field))->next) 274 275 /* TODO: Check field, type order */ 276 277 #define OSAL_LIST_FOR_EACH_ENTRY(entry, list, field, type) \ 278 for (entry = OSAL_LIST_FIRST_ENTRY(list, type, field); \ 279 entry; \ 280 entry = OSAL_LIST_NEXT(entry, field, type)) 281 282 #define OSAL_LIST_FOR_EACH_ENTRY_SAFE(entry, tmp_entry, list, field, type) \ 283 for (entry = OSAL_LIST_FIRST_ENTRY(list, type, field), \ 284 tmp_entry = (entry) ? OSAL_LIST_NEXT(entry, field, type) : NULL; \ 285 entry != NULL; \ 286 entry = (type *)tmp_entry, \ 287 tmp_entry = (entry) ? OSAL_LIST_NEXT(entry, field, type) : NULL) 288 289 /* TODO: OSAL_LIST_INSERT_ENTRY_AFTER */ 290 #define OSAL_LIST_INSERT_ENTRY_AFTER(new_entry, entry, list) \ 291 OSAL_LIST_PUSH_HEAD(new_entry, list) 292 293 /* PCI config space */ 294 #define OSAL_PCI_READ_CONFIG_BYTE(dev, address, dst) \ 295 rte_pci_read_config((dev)->pci_dev, dst, 1, address) 296 #define OSAL_PCI_READ_CONFIG_WORD(dev, address, dst) \ 297 rte_pci_read_config((dev)->pci_dev, dst, 2, address) 298 #define OSAL_PCI_READ_CONFIG_DWORD(dev, address, dst) \ 299 rte_pci_read_config((dev)->pci_dev, dst, 4, address) 300 #define OSAL_PCI_FIND_EXT_CAPABILITY(dev, cap) \ 301 rte_pci_find_ext_capability((dev)->pci_dev, cap) 302 #define OSAL_PCI_FIND_CAPABILITY(dev, pcie_id) 0 303 #define OSAL_PCI_WRITE_CONFIG_WORD(dev, address, val) nothing 304 #define OSAL_BAR_SIZE(dev, bar_id) 0 305 306 /* Barriers */ 307 308 #define OSAL_MMIOWB(dev) rte_wmb() 309 #define OSAL_BARRIER(dev) rte_compiler_barrier() 310 #define OSAL_SMP_RMB(dev) rte_rmb() 311 #define OSAL_SMP_WMB(dev) rte_wmb() 312 #define OSAL_RMB(dev) rte_rmb() 313 #define OSAL_WMB(dev) rte_wmb() 314 #define OSAL_DMA_SYNC(dev, addr, length, is_post) nothing 315 316 #define OSAL_BIT(nr) (1UL << (nr)) 317 #define OSAL_BITS_PER_BYTE (8) 318 #define OSAL_BITS_PER_UL (sizeof(unsigned long) * OSAL_BITS_PER_BYTE) 319 #define OSAL_BITS_PER_UL_MASK (OSAL_BITS_PER_UL - 1) 320 321 /* Bitops */ 322 #define OSAL_SET_BIT(bit, bitmap) \ 323 rte_bit_relaxed_set32(bit, bitmap) 324 325 #define OSAL_CLEAR_BIT(bit, bitmap) \ 326 rte_bit_relaxed_clear32(bit, bitmap) 327 328 #define OSAL_GET_BIT(bit, bitmap) \ 329 rte_bit_relaxed_get32(bit, bitmap) 330 331 u32 qede_find_first_bit(unsigned long *, u32); 332 #define OSAL_FIND_FIRST_BIT(bitmap, length) \ 333 qede_find_first_bit(bitmap, length) 334 335 u32 qede_find_first_zero_bit(u32 *bitmap, u32 length); 336 #define OSAL_FIND_FIRST_ZERO_BIT(bitmap, length) \ 337 qede_find_first_zero_bit(bitmap, length) 338 339 #define OSAL_BUILD_BUG_ON(cond) nothing 340 #define ETH_ALEN RTE_ETHER_ADDR_LEN 341 #define ETHER_TYPE_VLAN RTE_ETHER_TYPE_VLAN 342 #define ETHER_TYPE_QINQ RTE_ETHER_TYPE_QINQ 343 344 #define OSAL_BITMAP_WEIGHT(bitmap, count) 0 345 346 #define OSAL_LINK_UPDATE(hwfn) qed_link_update(hwfn) 347 #define OSAL_TRANSCEIVER_UPDATE(hwfn) nothing 348 #define OSAL_DCBX_AEN(hwfn, mib_type) nothing 349 350 /* SR-IOV channel */ 351 352 int osal_pf_vf_msg(struct ecore_hwfn *p_hwfn); 353 void osal_vf_flr_update(struct ecore_hwfn *p_hwfn); 354 #define OSAL_VF_FLR_UPDATE(hwfn) \ 355 osal_vf_flr_update(hwfn) 356 #define OSAL_VF_SEND_MSG2PF(dev, done, msg, reply_addr, msg_size, reply_size) 0 357 #define OSAL_VF_CQE_COMPLETION(_dev_p, _cqe, _protocol) (0) 358 #define OSAL_PF_VF_MSG(hwfn, vfid) \ 359 osal_pf_vf_msg(hwfn) 360 #define OSAL_PF_VF_MALICIOUS(hwfn, vfid) nothing 361 #define OSAL_IOV_CHK_UCAST(hwfn, vfid, params) 0 362 #define OSAL_IOV_POST_START_VPORT(hwfn, vf, vport_id, opaque_fid) nothing 363 #define OSAL_IOV_VF_ACQUIRE(hwfn, vfid) 0 364 #define OSAL_IOV_VF_CLEANUP(hwfn, vfid) nothing 365 #define OSAL_IOV_VF_VPORT_UPDATE(hwfn, vfid, p_params, p_mask) 0 366 #define OSAL_VF_UPDATE_ACQUIRE_RESC_RESP(_dev_p, _resc_resp) 0 367 #define OSAL_IOV_GET_OS_TYPE() 0 368 #define OSAL_IOV_VF_MSG_TYPE(hwfn, vfid, vf_msg_type) nothing 369 #define OSAL_IOV_PF_RESP_TYPE(hwfn, vfid, pf_resp_type) nothing 370 #define OSAL_IOV_VF_VPORT_STOP(hwfn, vf) nothing 371 372 u32 qede_unzip_data(struct ecore_hwfn *p_hwfn, u32 input_len, 373 u8 *input_buf, u32 max_size, u8 *unzip_buf); 374 void qede_vf_fill_driver_data(struct ecore_hwfn *, struct vf_pf_resc_request *, 375 struct ecore_vf_acquire_sw_info *); 376 void qede_hw_err_notify(struct ecore_hwfn *p_hwfn, 377 enum ecore_hw_err_type err_type); 378 #define OSAL_VF_FILL_ACQUIRE_RESC_REQ(_dev_p, _resc_req, _os_info) \ 379 qede_vf_fill_driver_data(_dev_p, _resc_req, _os_info) 380 381 #define OSAL_UNZIP_DATA(p_hwfn, input_len, buf, max_size, unzip_buf) \ 382 qede_unzip_data(p_hwfn, input_len, buf, max_size, unzip_buf) 383 384 /* TODO: */ 385 #define OSAL_SCHEDULE_RECOVERY_HANDLER(hwfn) nothing 386 387 int qede_save_fw_dump(uint16_t port_id); 388 389 #define OSAL_SAVE_FW_DUMP(port_id) qede_save_fw_dump(port_id) 390 391 #define OSAL_HW_ERROR_OCCURRED(hwfn, err_type) \ 392 qede_hw_err_notify(hwfn, err_type) 393 394 #define OSAL_NVM_IS_ACCESS_ENABLED(hwfn) (1) 395 #define OSAL_NUM_CPUS() 0 396 397 /* Utility functions */ 398 399 #define RTE_DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d)) 400 #define DIV_ROUND_UP(size, to_what) RTE_DIV_ROUND_UP(size, to_what) 401 #define RTE_ROUNDUP(x, y) ((((x) + ((y) - 1)) / (y)) * (y)) 402 #define ROUNDUP(value, to_what) RTE_ROUNDUP((value), (to_what)) 403 404 unsigned long qede_log2_align(unsigned long n); 405 #define OSAL_ROUNDUP_POW_OF_TWO(val) \ 406 qede_log2_align(val) 407 408 u32 qede_osal_log2(u32); 409 #define OSAL_LOG2(val) \ 410 qede_osal_log2(val) 411 412 #define PRINT(format, ...) printf 413 #define PRINT_ERR(format, ...) PRINT 414 415 #define OFFSETOF(str, field) __builtin_offsetof(str, field) 416 #define OSAL_ASSERT(is_assert) assert(is_assert) 417 #define OSAL_BEFORE_PF_START(file, engine) nothing 418 #define OSAL_AFTER_PF_STOP(file, engine) nothing 419 420 /* Endian macros */ 421 #define OSAL_CPU_TO_BE32(val) rte_cpu_to_be_32(val) 422 #define OSAL_BE32_TO_CPU(val) rte_be_to_cpu_32(val) 423 #define OSAL_CPU_TO_LE32(val) rte_cpu_to_le_32(val) 424 #define OSAL_CPU_TO_LE16(val) rte_cpu_to_le_16(val) 425 #define OSAL_LE32_TO_CPU(val) rte_le_to_cpu_32(val) 426 #define OSAL_LE16_TO_CPU(val) rte_le_to_cpu_16(val) 427 #define OSAL_CPU_TO_BE64(val) rte_cpu_to_be_64(val) 428 429 #define OSAL_ARRAY_SIZE(arr) RTE_DIM(arr) 430 #define OSAL_SPRINTF(name, pattern, ...) \ 431 sprintf(name, pattern, ##__VA_ARGS__) 432 #define OSAL_SNPRINTF(buf, size, format, ...) \ 433 snprintf(buf, size, format, ##__VA_ARGS__) 434 #define OSAL_STRLEN(string) strlen(string) 435 #define OSAL_STRCPY(dst, string) strcpy(dst, string) 436 #define OSAL_STRNCPY(dst, string, len) strncpy(dst, string, len) 437 #define OSAL_STRCMP(str1, str2) strcmp(str1, str2) 438 #define OSAL_STRTOUL(str, base, res) 0 439 440 #define OSAL_INLINE inline 441 #define OSAL_REG_ADDR(_p_hwfn, _offset) \ 442 (void *)((u8 *)(uintptr_t)(_p_hwfn->regview) + (_offset)) 443 #define OSAL_PAGE_SIZE 4096 444 #define OSAL_CACHE_LINE_SIZE RTE_CACHE_LINE_SIZE 445 #define OSAL_IOMEM volatile 446 #define OSAL_UNUSED __rte_unused 447 #define OSAL_UNLIKELY(x) unlikely(x) 448 #define OSAL_MIN_T(type, __min1, __min2) RTE_MIN_T(__min1, __min2, type) 449 #define OSAL_MAX_T(type, __max1, __max2) RTE_MAX_T(__max1, __max2, type) 450 451 void qede_get_mcp_proto_stats(struct ecore_dev *, enum ecore_mcp_protocol_type, 452 union ecore_mcp_protocol_stats *); 453 #define OSAL_GET_PROTOCOL_STATS(dev, type, stats) \ 454 qede_get_mcp_proto_stats(dev, type, stats) 455 456 #define OSAL_SLOWPATH_IRQ_REQ(p_hwfn) (0) 457 458 u32 qede_crc32(u32 crc, u8 *ptr, u32 length); 459 #define OSAL_CRC32(crc, buf, length) qede_crc32(crc, buf, length) 460 #define OSAL_CRC8_POPULATE(table, polynomial) nothing 461 #define OSAL_CRC8(table, pdata, nbytes, crc) 0 462 #define OSAL_MFW_TLV_REQ(p_hwfn) nothing 463 #define OSAL_MFW_FILL_TLV_DATA(type, buf, data) (0) 464 #define OSAL_HW_INFO_CHANGE(p_hwfn, change) nothing 465 #define OSAL_MFW_CMD_PREEMPT(p_hwfn) nothing 466 #define OSAL_PF_VALIDATE_MODIFY_TUNN_CONFIG(p_hwfn, mask, b_update, tunn) 0 467 468 #define OSAL_DIV_S64(a, b) ((a) / (b)) 469 #define OSAL_LLDP_RX_TLVS(p_hwfn, tlv_buf, tlv_size) nothing 470 void qed_set_platform_str(struct ecore_hwfn *p_hwfn, 471 char *buf_str, u32 buf_size); 472 #define OSAL_SET_PLATFORM_STR(p_hwfn, buf_str, buf_size) \ 473 qed_set_platform_str(p_hwfn, buf_str, buf_size) 474 #define OSAL_GET_EPOCH(p_hwfn) ((u32)time(NULL)) 475 enum dbg_status qed_dbg_alloc_user_data(struct ecore_hwfn *p_hwfn, 476 void **user_data_ptr); 477 #define OSAL_DBG_ALLOC_USER_DATA(p_hwfn, user_data_ptr) \ 478 qed_dbg_alloc_user_data(p_hwfn, user_data_ptr) 479 #define OSAL_DB_REC_OCCURRED(p_hwfn) nothing 480 481 int ecore_mz_mapping_alloc(void); 482 void ecore_mz_mapping_free(void); 483 484 #endif /* __BCM_OSAL_H */ 485