drivers/net/qede/base/bcm_osal.h

   1 /*
   2  * Copyright (c) 2016 QLogic Corporation.
   3  * All rights reserved.
   4  * www.qlogic.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, struct ecore_ptt *ptt);
  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 /* 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 phys_addr_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 /* Mutexes */
 152
 153 typedef pthread_mutex_t osal_mutex_t;
 154 #define OSAL_MUTEX_RELEASE(lock) pthread_mutex_unlock(lock)
 155 #define OSAL_MUTEX_INIT(lock) pthread_mutex_init(lock, NULL)
 156 #define OSAL_MUTEX_ACQUIRE(lock) pthread_mutex_lock(lock)
 157 #define OSAL_MUTEX_ALLOC(hwfn, lock) nothing
 158 #define OSAL_MUTEX_DEALLOC(lock) nothing
 159
 160 /* Spinlocks */
 161
 162 #define OSAL_SPIN_LOCK_INIT(lock) rte_spinlock_init(lock)
 163 #define OSAL_SPIN_LOCK(lock) rte_spinlock_lock(lock)
 164 #define OSAL_SPIN_UNLOCK(lock) rte_spinlock_unlock(lock)
 165 #define OSAL_SPIN_LOCK_IRQSAVE(lock, flags) nothing
 166 #define OSAL_SPIN_UNLOCK_IRQSAVE(lock, flags) nothing
 167 #define OSAL_SPIN_LOCK_ALLOC(hwfn, lock) nothing
 168 #define OSAL_SPIN_LOCK_DEALLOC(lock) nothing
 169
 170 /* DPC */
 171
 172 #define OSAL_DPC_ALLOC(hwfn) OSAL_ALLOC(hwfn, GFP, sizeof(osal_dpc_t))
 173 #define OSAL_DPC_INIT(dpc, hwfn) nothing
 174 #define OSAL_POLL_MODE_DPC(hwfn) nothing
 175 #define OSAL_DPC_SYNC(hwfn) nothing
 176
 177 /* Lists */
 178
 179 #define OSAL_LIST_SPLICE_INIT(new_list, list) nothing
 180 #define OSAL_LIST_SPLICE_TAIL_INIT(new_list, list) nothing
 181
 182 typedef struct _osal_list_entry_t {
 183         struct _osal_list_entry_t *next, *prev;
 184 } osal_list_entry_t;
 185
 186 typedef struct osal_list_t {
 187         osal_list_entry_t *head, *tail;
 188         unsigned long cnt;
 189 } osal_list_t;
 190
 191 #define OSAL_LIST_INIT(list) \
 192         do {                    \
 193                 (list)->head = NULL;  \
 194                 (list)->tail = NULL;  \
 195                 (list)->cnt  = 0;       \
 196         } while (0)
 197
 198 #define OSAL_LIST_PUSH_HEAD(entry, list)                \
 199         do {                                            \
 200                 (entry)->prev = (osal_list_entry_t *)0;         \
 201                 (entry)->next = (list)->head;                   \
 202                 if ((list)->tail == (osal_list_entry_t *)0) {   \
 203                         (list)->tail = (entry);                 \
 204                 } else {                                        \
 205                         (list)->head->prev = (entry);           \
 206                 }                                               \
 207                 (list)->head = (entry);                         \
 208                 (list)->cnt++;                                  \
 209         } while (0)
 210
 211 #define OSAL_LIST_PUSH_TAIL(entry, list)        \
 212         do {                                    \
 213                 (entry)->next = (osal_list_entry_t *)0; \
 214                 (entry)->prev = (list)->tail;           \
 215                 if ((list)->tail) {                     \
 216                         (list)->tail->next = (entry);   \
 217                 } else {                                \
 218                         (list)->head = (entry);         \
 219                 }                                       \
 220                 (list)->tail = (entry);                 \
 221                 (list)->cnt++;                          \
 222         } while (0)
 223
 224 #define OSAL_LIST_FIRST_ENTRY(list, type, field) \
 225         (type *)((list)->head)
 226
 227 #define OSAL_LIST_REMOVE_ENTRY(entry, list)                     \
 228         do {                                                    \
 229                 if ((list)->head == (entry)) {                          \
 230                         if ((list)->head) {                             \
 231                                 (list)->head = (list)->head->next;      \
 232                         if ((list)->head) {                             \
 233                                 (list)->head->prev = (osal_list_entry_t *)0;\
 234                         } else {                                        \
 235                                 (list)->tail = (osal_list_entry_t *)0;  \
 236                         }                                               \
 237                         (list)->cnt--;                                  \
 238                         }                                               \
 239                 } else if ((list)->tail == (entry)) {                   \
 240                         if ((list)->tail) {                             \
 241                                 (list)->tail = (list)->tail->prev;      \
 242                         if ((list)->tail) {                             \
 243                                 (list)->tail->next = (osal_list_entry_t *)0;\
 244                         } else {                                        \
 245                                 (list)->head = (osal_list_entry_t *)0;  \
 246                         }                                               \
 247                         (list)->cnt--;                                  \
 248                         }                                               \
 249                 } else {                                                \
 250                         (entry)->prev->next = (entry)->next;            \
 251                         (entry)->next->prev = (entry)->prev;            \
 252                         (list)->cnt--;                                  \
 253                 }                                                       \
 254         } while (0)
 255
 256 #define OSAL_LIST_IS_EMPTY(list) \
 257         ((list)->cnt == 0)
 258
 259 #define OSAL_LIST_NEXT(entry, field, type) \
 260         (type *)((&((entry)->field))->next)
 261
 262 /* TODO: Check field, type order */
 263
 264 #define OSAL_LIST_FOR_EACH_ENTRY(entry, list, field, type) \
 265         for (entry = OSAL_LIST_FIRST_ENTRY(list, type, field); \
 266                 entry;                                          \
 267                 entry = OSAL_LIST_NEXT(entry, field, type))
 268
 269 #define OSAL_LIST_FOR_EACH_ENTRY_SAFE(entry, tmp_entry, list, field, type) \
 270          for (entry = OSAL_LIST_FIRST_ENTRY(list, type, field), \
 271           tmp_entry = (entry) ? OSAL_LIST_NEXT(entry, field, type) : NULL;    \
 272           entry != NULL;                                                \
 273           entry = (type *)tmp_entry,                                     \
 274           tmp_entry = (entry) ? OSAL_LIST_NEXT(entry, field, type) : NULL)
 275
 276 /* TODO: OSAL_LIST_INSERT_ENTRY_AFTER */
 277 #define OSAL_LIST_INSERT_ENTRY_AFTER(new_entry, entry, list) \
 278         OSAL_LIST_PUSH_HEAD(new_entry, list)
 279
 280 /* PCI config space */
 281
 282 #define OSAL_PCI_READ_CONFIG_BYTE(dev, address, dst) nothing
 283 #define OSAL_PCI_READ_CONFIG_WORD(dev, address, dst) nothing
 284 #define OSAL_PCI_READ_CONFIG_DWORD(dev, address, dst) nothing
 285 #define OSAL_PCI_FIND_EXT_CAPABILITY(dev, pcie_id) 0
 286 #define OSAL_PCI_FIND_CAPABILITY(dev, pcie_id) 0
 287 #define OSAL_PCI_WRITE_CONFIG_WORD(dev, address, val) nothing
 288 #define OSAL_BAR_SIZE(dev, bar_id) 0
 289
 290 /* Barriers */
 291
 292 #define OSAL_MMIOWB(dev)                rte_wmb()
 293 #define OSAL_BARRIER(dev)               rte_compiler_barrier()
 294 #define OSAL_SMP_RMB(dev)               rte_rmb()
 295 #define OSAL_SMP_WMB(dev)               rte_wmb()
 296 #define OSAL_RMB(dev)                   rte_rmb()
 297 #define OSAL_WMB(dev)                   rte_wmb()
 298 #define OSAL_DMA_SYNC(dev, addr, length, is_post) nothing
 299
 300 #define OSAL_BIT(nr)            (1UL << (nr))
 301 #define OSAL_BITS_PER_BYTE      (8)
 302 #define OSAL_BITS_PER_UL        (sizeof(unsigned long) * OSAL_BITS_PER_BYTE)
 303 #define OSAL_BITS_PER_UL_MASK           (OSAL_BITS_PER_UL - 1)
 304
 305 /* Bitops */
 306 void qede_set_bit(u32, unsigned long *);
 307 #define OSAL_SET_BIT(bit, bitmap) \
 308         qede_set_bit(bit, bitmap)
 309
 310 void qede_clr_bit(u32, unsigned long *);
 311 #define OSAL_CLEAR_BIT(bit, bitmap) \
 312         qede_clr_bit(bit, bitmap)
 313
 314 bool qede_test_bit(u32, unsigned long *);
 315 #define OSAL_TEST_BIT(bit, bitmap) \
 316         qede_test_bit(bit, bitmap)
 317
 318 u32 qede_find_first_bit(unsigned long *, u32);
 319 #define OSAL_FIND_FIRST_BIT(bitmap, length) \
 320         qede_find_first_bit(bitmap, length)
 321
 322 u32 qede_find_first_zero_bit(unsigned long *, u32);
 323 #define OSAL_FIND_FIRST_ZERO_BIT(bitmap, length) \
 324         qede_find_first_zero_bit(bitmap, length)
 325
 326 #define OSAL_BUILD_BUG_ON(cond)         nothing
 327 #define ETH_ALEN                        ETHER_ADDR_LEN
 328
 329 #define OSAL_BITMAP_WEIGHT(bitmap, count) 0
 330
 331 #define OSAL_LINK_UPDATE(hwfn, ptt) qed_link_update(hwfn, ptt)
 332 #define OSAL_DCBX_AEN(hwfn, mib_type) nothing
 333
 334 /* SR-IOV channel */
 335
 336 #define OSAL_VF_FLR_UPDATE(hwfn) nothing
 337 #define OSAL_VF_SEND_MSG2PF(dev, done, msg, reply_addr, msg_size, reply_size) 0
 338 #define OSAL_VF_CQE_COMPLETION(_dev_p, _cqe, _protocol) (0)
 339 #define OSAL_PF_VF_MSG(hwfn, vfid) 0
 340 #define OSAL_PF_VF_MALICIOUS(hwfn, vfid) nothing
 341 #define OSAL_IOV_CHK_UCAST(hwfn, vfid, params) 0
 342 #define OSAL_IOV_POST_START_VPORT(hwfn, vf, vport_id, opaque_fid) nothing
 343 #define OSAL_IOV_VF_ACQUIRE(hwfn, vfid) 0
 344 #define OSAL_IOV_VF_CLEANUP(hwfn, vfid) nothing
 345 #define OSAL_IOV_VF_VPORT_UPDATE(hwfn, vfid, p_params, p_mask) 0
 346 #define OSAL_VF_UPDATE_ACQUIRE_RESC_RESP(_dev_p, _resc_resp) 0
 347 #define OSAL_IOV_GET_OS_TYPE() 0
 348 #define OSAL_IOV_VF_MSG_TYPE(hwfn, vfid, vf_msg_type) 0
 349 #define OSAL_IOV_PF_RESP_TYPE(hwfn, vfid, pf_resp_type) 0
 350
 351 u32 qede_unzip_data(struct ecore_hwfn *p_hwfn, u32 input_len,
 352                    u8 *input_buf, u32 max_size, u8 *unzip_buf);
 353 void qede_vf_fill_driver_data(struct ecore_hwfn *, struct vf_pf_resc_request *,
 354                               struct ecore_vf_acquire_sw_info *);
 355 void qede_hw_err_notify(struct ecore_hwfn *p_hwfn,
 356                         enum ecore_hw_err_type err_type);
 357 #define OSAL_VF_FILL_ACQUIRE_RESC_REQ(_dev_p, _resc_req, _os_info) \
 358         qede_vf_fill_driver_data(_dev_p, _resc_req, _os_info)
 359
 360 #define OSAL_UNZIP_DATA(p_hwfn, input_len, buf, max_size, unzip_buf) \
 361         qede_unzip_data(p_hwfn, input_len, buf, max_size, unzip_buf)
 362
 363 /* TODO: */
 364 #define OSAL_SCHEDULE_RECOVERY_HANDLER(hwfn) nothing
 365 #define OSAL_HW_ERROR_OCCURRED(hwfn, err_type) \
 366         qede_hw_err_notify(hwfn, err_type)
 367
 368 #define OSAL_NVM_IS_ACCESS_ENABLED(hwfn) (1)
 369 #define OSAL_NUM_ACTIVE_CPU()   0
 370
 371 /* Utility functions */
 372
 373 #define RTE_DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
 374 #define DIV_ROUND_UP(size, to_what) RTE_DIV_ROUND_UP(size, to_what)
 375 #define RTE_ROUNDUP(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
 376 #define ROUNDUP(value, to_what) RTE_ROUNDUP((value), (to_what))
 377
 378 unsigned long qede_log2_align(unsigned long n);
 379 #define OSAL_ROUNDUP_POW_OF_TWO(val) \
 380         qede_log2_align(val)
 381
 382 u32 qede_osal_log2(u32);
 383 #define OSAL_LOG2(val) \
 384         qede_osal_log2(val)
 385
 386 #define PRINT(format, ...) printf
 387 #define PRINT_ERR(format, ...) PRINT
 388
 389 #define OFFSETOF(str, field) __builtin_offsetof(str, field)
 390 #define OSAL_ASSERT(is_assert) assert(is_assert)
 391 #define OSAL_BEFORE_PF_START(file, engine) nothing
 392 #define OSAL_AFTER_PF_STOP(file, engine) nothing
 393
 394 /* Endian macros */
 395 #define OSAL_CPU_TO_BE32(val) rte_cpu_to_be_32(val)
 396 #define OSAL_BE32_TO_CPU(val) rte_be_to_cpu_32(val)
 397 #define OSAL_CPU_TO_LE32(val) rte_cpu_to_le_32(val)
 398 #define OSAL_CPU_TO_LE16(val) rte_cpu_to_le_16(val)
 399 #define OSAL_LE32_TO_CPU(val) rte_le_to_cpu_32(val)
 400 #define OSAL_LE16_TO_CPU(val) rte_le_to_cpu_16(val)
 401 #define OSAL_CPU_TO_BE64(val) rte_cpu_to_be_64(val)
 402
 403 #define OSAL_ARRAY_SIZE(arr) RTE_DIM(arr)
 404 #define OSAL_SPRINTF(name, pattern, ...) \
 405         sprintf(name, pattern, ##__VA_ARGS__)
 406 #define OSAL_SNPRINTF(buf, size, format, ...) \
 407         snprintf(buf, size, format, ##__VA_ARGS__)
 408 #define OSAL_STRLEN(string) strlen(string)
 409 #define OSAL_STRCPY(dst, string) strcpy(dst, string)
 410 #define OSAL_STRNCPY(dst, string, len) strncpy(dst, string, len)
 411 #define OSAL_STRCMP(str1, str2) strcmp(str1, str2)
 412 #define OSAL_STRTOUL(str, base, res) 0
 413
 414 #define OSAL_INLINE inline
 415 #define OSAL_REG_ADDR(_p_hwfn, _offset) \
 416                 (void *)((u8 *)(uintptr_t)(_p_hwfn->regview) + (_offset))
 417 #define OSAL_PAGE_SIZE 4096
 418 #define OSAL_CACHE_LINE_SIZE RTE_CACHE_LINE_SIZE
 419 #define OSAL_IOMEM volatile
 420 #define OSAL_UNLIKELY(x)  __builtin_expect(!!(x), 0)
 421 #define OSAL_MIN_T(type, __min1, __min2)        \
 422         ((type)(__min1) < (type)(__min2) ? (type)(__min1) : (type)(__min2))
 423 #define OSAL_MAX_T(type, __max1, __max2)        \
 424         ((type)(__max1) > (type)(__max2) ? (type)(__max1) : (type)(__max2))
 425
 426 void qede_get_mcp_proto_stats(struct ecore_dev *, enum ecore_mcp_protocol_type,
 427                               union ecore_mcp_protocol_stats *);
 428 #define OSAL_GET_PROTOCOL_STATS(dev, type, stats) \
 429         qede_get_mcp_proto_stats(dev, type, stats)
 430
 431 #define OSAL_SLOWPATH_IRQ_REQ(p_hwfn) (0)
 432
 433 u32 qede_crc32(u32 crc, u8 *ptr, u32 length);
 434 #define OSAL_CRC32(crc, buf, length) qede_crc32(crc, buf, length)
 435 #define OSAL_CRC8_POPULATE(table, polynomial) nothing
 436 #define OSAL_CRC8(table, pdata, nbytes, crc) 0
 437 #define OSAL_MFW_TLV_REQ(p_hwfn) (0)
 438 #define OSAL_MFW_FILL_TLV_DATA(type, buf, data) (0)
 439 #define OSAL_PF_VALIDATE_MODIFY_TUNN_CONFIG(p_hwfn, mask, b_update, tunn) 0
 440 #endif /* __BCM_OSAL_H */