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