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