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