1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright (c) 2016 - 2018 Cavium Inc.
12 #include <rte_bitops.h>
13 #include <rte_byteorder.h>
14 #include <rte_spinlock.h>
15 #include <rte_malloc.h>
16 #include <rte_atomic.h>
17 #include <rte_memcpy.h>
19 #include <rte_cycles.h>
20 #include <rte_debug.h>
21 #include <rte_ether.h>
23 #include <rte_version.h>
24 #include <rte_bus_pci.h>
26 /* Forward declaration */
30 struct ecore_vf_acquire_sw_info;
31 struct vf_pf_resc_request;
32 enum ecore_mcp_protocol_type;
33 union ecore_mcp_protocol_stats;
34 enum ecore_hw_err_type;
36 void qed_link_update(struct ecore_hwfn *hwfn);
38 #if RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
40 #ifndef __LITTLE_ENDIAN
41 #define __LITTLE_ENDIAN
44 #undef __LITTLE_ENDIAN
50 #define OSAL_WARN(arg1, arg2, arg3, ...) (0)
52 #define UNUSED(x) (void)(x)
65 typedef u32 OSAL_BE32;
67 #define osal_uintptr_t uintptr_t
69 typedef rte_iova_t dma_addr_t;
71 typedef rte_spinlock_t osal_spinlock_t;
73 typedef void *osal_dpc_t;
75 typedef size_t osal_size_t;
77 typedef intptr_t osal_int_ptr_t;
79 #define nothing do {} while (0)
83 #define DELAY(x) rte_delay_us(x)
84 #define usec_delay(x) DELAY(x)
85 #define OSAL_UDELAY(time) usec_delay(time)
86 #define OSAL_MSLEEP(time) rte_delay_us_sleep(1000 * (time))
88 /* Memory allocations and deallocations */
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) \
97 rte_free((void *)memory); \
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)
107 void *osal_dma_alloc_coherent(struct ecore_dev *, dma_addr_t *, size_t);
109 void *osal_dma_alloc_coherent_aligned(struct ecore_dev *, dma_addr_t *,
112 void osal_dma_free_mem(struct ecore_dev *edev, dma_addr_t phys);
114 #define OSAL_DMA_ALLOC_COHERENT(dev, phys, size) \
115 osal_dma_alloc_coherent(dev, phys, size)
117 #define OSAL_DMA_ALLOC_COHERENT_ALIGNED(dev, phys, size, align) \
118 osal_dma_alloc_coherent_aligned(dev, phys, size, align)
120 #define OSAL_DMA_FREE_COHERENT(dev, virt, phys, size) \
121 osal_dma_free_mem(dev, phys)
123 /* HW reads/writes */
125 #define DIRECT_REG_RD(_dev, _reg_addr) rte_read32(_reg_addr)
127 #define REG_RD(_p_hwfn, _reg_offset) \
128 DIRECT_REG_RD(_p_hwfn, \
129 ((u8 *)(uintptr_t)(_p_hwfn->regview) + (_reg_offset)))
131 #define DIRECT_REG_WR16(_reg_addr, _val) rte_write16((_val), (_reg_addr))
133 #define DIRECT_REG_WR(_dev, _reg_addr, _val) rte_write32((_val), (_reg_addr))
135 #define DIRECT_REG_WR_RELAXED(_dev, _reg_addr, _val) \
136 rte_write32_relaxed((_val), (_reg_addr))
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)
142 #define REG_WR16(_p_hwfn, _reg_offset, _val) \
143 DIRECT_REG_WR16(((u8 *)(uintptr_t)(_p_hwfn->regview) + \
144 (_reg_offset)), (u16)_val)
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)
151 #define DIRECT_REG_RD64(hwfn, addr) rte_read64(addr)
152 #define DIRECT_REG_WR64(hwfn, addr, value) rte_write64((value), (addr))
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
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) \
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
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
187 #define OSAL_LIST_SPLICE_INIT(new_list, list) nothing
188 #define OSAL_LIST_SPLICE_TAIL_INIT(new_list, list) nothing
190 typedef struct _osal_list_entry_t {
191 struct _osal_list_entry_t *next, *prev;
194 typedef struct osal_list_t {
195 osal_list_entry_t *head, *tail;
199 #define OSAL_LIST_INIT(list) \
201 (list)->head = NULL; \
202 (list)->tail = NULL; \
206 #define OSAL_LIST_PUSH_HEAD(entry, list) \
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); \
213 (list)->head->prev = (entry); \
215 (list)->head = (entry); \
219 #define OSAL_LIST_PUSH_TAIL(entry, list) \
221 (entry)->next = (osal_list_entry_t *)0; \
222 (entry)->prev = (list)->tail; \
223 if ((list)->tail) { \
224 (list)->tail->next = (entry); \
226 (list)->head = (entry); \
228 (list)->tail = (entry); \
232 #define OSAL_LIST_FIRST_ENTRY(list, type, field) \
233 (type *)((list)->head)
235 #define OSAL_LIST_REMOVE_ENTRY(entry, list) \
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;\
243 (list)->tail = (osal_list_entry_t *)0; \
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;\
253 (list)->head = (osal_list_entry_t *)0; \
258 (entry)->prev->next = (entry)->next; \
259 (entry)->next->prev = (entry)->prev; \
264 #define OSAL_LIST_IS_EMPTY(list) \
267 #define OSAL_LIST_NEXT(entry, field, type) \
268 (type *)((&((entry)->field))->next)
270 /* TODO: Check field, type order */
272 #define OSAL_LIST_FOR_EACH_ENTRY(entry, list, field, type) \
273 for (entry = OSAL_LIST_FIRST_ENTRY(list, type, field); \
275 entry = OSAL_LIST_NEXT(entry, field, type))
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; \
281 entry = (type *)tmp_entry, \
282 tmp_entry = (entry) ? OSAL_LIST_NEXT(entry, field, type) : NULL)
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)
288 /* PCI config space */
289 #define OSAL_PCI_READ_CONFIG_BYTE(dev, address, dst) \
290 rte_pci_read_config((dev)->pci_dev, dst, 1, address)
291 #define OSAL_PCI_READ_CONFIG_WORD(dev, address, dst) \
292 rte_pci_read_config((dev)->pci_dev, dst, 2, address)
293 #define OSAL_PCI_READ_CONFIG_DWORD(dev, address, dst) \
294 rte_pci_read_config((dev)->pci_dev, dst, 4, address)
295 #define OSAL_PCI_FIND_EXT_CAPABILITY(dev, cap) \
296 rte_pci_find_ext_capability((dev)->pci_dev, cap)
297 #define OSAL_PCI_FIND_CAPABILITY(dev, pcie_id) 0
298 #define OSAL_PCI_WRITE_CONFIG_WORD(dev, address, val) nothing
299 #define OSAL_BAR_SIZE(dev, bar_id) 0
303 #define OSAL_MMIOWB(dev) rte_wmb()
304 #define OSAL_BARRIER(dev) rte_compiler_barrier()
305 #define OSAL_SMP_RMB(dev) rte_rmb()
306 #define OSAL_SMP_WMB(dev) rte_wmb()
307 #define OSAL_RMB(dev) rte_rmb()
308 #define OSAL_WMB(dev) rte_wmb()
309 #define OSAL_DMA_SYNC(dev, addr, length, is_post) nothing
311 #define OSAL_BIT(nr) (1UL << (nr))
312 #define OSAL_BITS_PER_BYTE (8)
313 #define OSAL_BITS_PER_UL (sizeof(unsigned long) * OSAL_BITS_PER_BYTE)
314 #define OSAL_BITS_PER_UL_MASK (OSAL_BITS_PER_UL - 1)
317 #define OSAL_SET_BIT(bit, bitmap) \
318 rte_bit_relaxed_set32(bit, bitmap)
320 #define OSAL_CLEAR_BIT(bit, bitmap) \
321 rte_bit_relaxed_clear32(bit, bitmap)
323 #define OSAL_GET_BIT(bit, bitmap) \
324 rte_bit_relaxed_get32(bit, bitmap)
326 u32 qede_find_first_bit(unsigned long *, u32);
327 #define OSAL_FIND_FIRST_BIT(bitmap, length) \
328 qede_find_first_bit(bitmap, length)
330 u32 qede_find_first_zero_bit(u32 *bitmap, u32 length);
331 #define OSAL_FIND_FIRST_ZERO_BIT(bitmap, length) \
332 qede_find_first_zero_bit(bitmap, length)
334 #define OSAL_BUILD_BUG_ON(cond) nothing
335 #define ETH_ALEN RTE_ETHER_ADDR_LEN
336 #define ETHER_TYPE_VLAN RTE_ETHER_TYPE_VLAN
337 #define ETHER_TYPE_QINQ RTE_ETHER_TYPE_QINQ
339 #define OSAL_BITMAP_WEIGHT(bitmap, count) 0
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
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
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)
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)
376 #define OSAL_SCHEDULE_RECOVERY_HANDLER(hwfn) nothing
378 int qede_save_fw_dump(uint8_t port_id);
380 #define OSAL_SAVE_FW_DUMP(port_id) qede_save_fw_dump(port_id)
382 #define OSAL_HW_ERROR_OCCURRED(hwfn, err_type) \
383 qede_hw_err_notify(hwfn, err_type)
385 #define OSAL_NVM_IS_ACCESS_ENABLED(hwfn) (1)
386 #define OSAL_NUM_CPUS() 0
388 /* Utility functions */
390 #define RTE_DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
391 #define DIV_ROUND_UP(size, to_what) RTE_DIV_ROUND_UP(size, to_what)
392 #define RTE_ROUNDUP(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
393 #define ROUNDUP(value, to_what) RTE_ROUNDUP((value), (to_what))
395 unsigned long qede_log2_align(unsigned long n);
396 #define OSAL_ROUNDUP_POW_OF_TWO(val) \
399 u32 qede_osal_log2(u32);
400 #define OSAL_LOG2(val) \
403 #define PRINT(format, ...) printf
404 #define PRINT_ERR(format, ...) PRINT
406 #define OFFSETOF(str, field) __builtin_offsetof(str, field)
407 #define OSAL_ASSERT(is_assert) assert(is_assert)
408 #define OSAL_BEFORE_PF_START(file, engine) nothing
409 #define OSAL_AFTER_PF_STOP(file, engine) nothing
412 #define OSAL_CPU_TO_BE32(val) rte_cpu_to_be_32(val)
413 #define OSAL_BE32_TO_CPU(val) rte_be_to_cpu_32(val)
414 #define OSAL_CPU_TO_LE32(val) rte_cpu_to_le_32(val)
415 #define OSAL_CPU_TO_LE16(val) rte_cpu_to_le_16(val)
416 #define OSAL_LE32_TO_CPU(val) rte_le_to_cpu_32(val)
417 #define OSAL_LE16_TO_CPU(val) rte_le_to_cpu_16(val)
418 #define OSAL_CPU_TO_BE64(val) rte_cpu_to_be_64(val)
420 #define OSAL_ARRAY_SIZE(arr) RTE_DIM(arr)
421 #define OSAL_SPRINTF(name, pattern, ...) \
422 sprintf(name, pattern, ##__VA_ARGS__)
423 #define OSAL_SNPRINTF(buf, size, format, ...) \
424 snprintf(buf, size, format, ##__VA_ARGS__)
425 #define OSAL_STRLEN(string) strlen(string)
426 #define OSAL_STRCPY(dst, string) strcpy(dst, string)
427 #define OSAL_STRNCPY(dst, string, len) strncpy(dst, string, len)
428 #define OSAL_STRCMP(str1, str2) strcmp(str1, str2)
429 #define OSAL_STRTOUL(str, base, res) 0
431 #define OSAL_INLINE inline
432 #define OSAL_REG_ADDR(_p_hwfn, _offset) \
433 (void *)((u8 *)(uintptr_t)(_p_hwfn->regview) + (_offset))
434 #define OSAL_PAGE_SIZE 4096
435 #define OSAL_CACHE_LINE_SIZE RTE_CACHE_LINE_SIZE
436 #define OSAL_IOMEM volatile
437 #define OSAL_UNUSED __rte_unused
438 #define OSAL_UNLIKELY(x) __builtin_expect(!!(x), 0)
439 #define OSAL_MIN_T(type, __min1, __min2) \
440 ((type)(__min1) < (type)(__min2) ? (type)(__min1) : (type)(__min2))
441 #define OSAL_MAX_T(type, __max1, __max2) \
442 ((type)(__max1) > (type)(__max2) ? (type)(__max1) : (type)(__max2))
444 void qede_get_mcp_proto_stats(struct ecore_dev *, enum ecore_mcp_protocol_type,
445 union ecore_mcp_protocol_stats *);
446 #define OSAL_GET_PROTOCOL_STATS(dev, type, stats) \
447 qede_get_mcp_proto_stats(dev, type, stats)
449 #define OSAL_SLOWPATH_IRQ_REQ(p_hwfn) (0)
451 u32 qede_crc32(u32 crc, u8 *ptr, u32 length);
452 #define OSAL_CRC32(crc, buf, length) qede_crc32(crc, buf, length)
453 #define OSAL_CRC8_POPULATE(table, polynomial) nothing
454 #define OSAL_CRC8(table, pdata, nbytes, crc) 0
455 #define OSAL_MFW_TLV_REQ(p_hwfn) nothing
456 #define OSAL_MFW_FILL_TLV_DATA(type, buf, data) (0)
457 #define OSAL_HW_INFO_CHANGE(p_hwfn, change) nothing
458 #define OSAL_MFW_CMD_PREEMPT(p_hwfn) nothing
459 #define OSAL_PF_VALIDATE_MODIFY_TUNN_CONFIG(p_hwfn, mask, b_update, tunn) 0
461 #define OSAL_DIV_S64(a, b) ((a) / (b))
462 #define OSAL_LLDP_RX_TLVS(p_hwfn, tlv_buf, tlv_size) nothing
463 void qed_set_platform_str(struct ecore_hwfn *p_hwfn,
464 char *buf_str, u32 buf_size);
465 #define OSAL_SET_PLATFORM_STR(p_hwfn, buf_str, buf_size) \
466 qed_set_platform_str(p_hwfn, buf_str, buf_size)
467 #define OSAL_GET_EPOCH(p_hwfn) ((u32)time(NULL))
468 enum dbg_status qed_dbg_alloc_user_data(struct ecore_hwfn *p_hwfn,
469 void **user_data_ptr);
470 #define OSAL_DBG_ALLOC_USER_DATA(p_hwfn, user_data_ptr) \
471 qed_dbg_alloc_user_data(p_hwfn, user_data_ptr)
472 #define OSAL_DB_REC_OCCURRED(p_hwfn) nothing
474 #endif /* __BCM_OSAL_H */