drivers/net/ixgbe/base/ixgbe_osdep.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2001-2015, Intel Corporation
   4   All rights reserved.
   5
   6   Redistribution and use in source and binary forms, with or without
   7   modification, are permitted provided that the following conditions are met:
   8
   9    1. Redistributions of source code must retain the above copyright notice,
  10       this list of conditions and the following disclaimer.
  11
  12    2. Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in the
  14       documentation and/or other materials provided with the distribution.
  15
  16    3. Neither the name of the Intel Corporation nor the names of its
  17       contributors may be used to endorse or promote products derived from
  18       this software without specific prior written permission.
  19
  20   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30   POSSIBILITY OF SUCH DAMAGE.
  31
  32 ******************************************************************************/
  33 /*$FreeBSD$*/
  34
  35 #ifndef _IXGBE_OS_H_
  36 #define _IXGBE_OS_H_
  37
  38 #include <string.h>
  39 #include <stdint.h>
  40 #include <stdio.h>
  41 #include <stdarg.h>
  42 #include <rte_common.h>
  43 #include <rte_debug.h>
  44 #include <rte_cycles.h>
  45 #include <rte_log.h>
  46 #include <rte_byteorder.h>
  47 #include <rte_io.h>
  48
  49 #include "../ixgbe_logs.h"
  50 #include "../ixgbe_bypass_defines.h"
  51
  52 #define ASSERT(x) if(!(x)) rte_panic("IXGBE: x")
  53
  54 #define DELAY(x) rte_delay_us(x)
  55 #define usec_delay(x) DELAY(x)
  56 #define msec_delay(x) DELAY(1000*(x))
  57
  58 #define DEBUGFUNC(F)            DEBUGOUT(F "\n");
  59 #define DEBUGOUT(S, args...)    PMD_DRV_LOG_RAW(DEBUG, S, ##args)
  60 #define DEBUGOUT1(S, args...)   DEBUGOUT(S, ##args)
  61 #define DEBUGOUT2(S, args...)   DEBUGOUT(S, ##args)
  62 #define DEBUGOUT3(S, args...)   DEBUGOUT(S, ##args)
  63 #define DEBUGOUT6(S, args...)   DEBUGOUT(S, ##args)
  64 #define DEBUGOUT7(S, args...)   DEBUGOUT(S, ##args)
  65
  66 #define ERROR_REPORT1(e, S, args...)   DEBUGOUT(S, ##args)
  67 #define ERROR_REPORT2(e, S, args...)   DEBUGOUT(S, ##args)
  68 #define ERROR_REPORT3(e, S, args...)   DEBUGOUT(S, ##args)
  69
  70 #define FALSE               0
  71 #define TRUE                1
  72
  73 #define false               0
  74 #define true                1
  75 #define min(a,b)        RTE_MIN(a,b)
  76
  77 #define EWARN(hw, S, args...)     DEBUGOUT1(S, ##args)
  78
  79 /* Bunch of defines for shared code bogosity */
  80 #define UNREFERENCED_PARAMETER(_p)
  81 #define UNREFERENCED_1PARAMETER(_p)
  82 #define UNREFERENCED_2PARAMETER(_p, _q)
  83 #define UNREFERENCED_3PARAMETER(_p, _q, _r)
  84 #define UNREFERENCED_4PARAMETER(_p, _q, _r, _s)
  85 #define UNREFERENCED_5PARAMETER(_p, _q, _r, _s, _t)
  86
  87 /* Shared code error reporting */
  88 enum {
  89         IXGBE_ERROR_SOFTWARE,
  90         IXGBE_ERROR_POLLING,
  91         IXGBE_ERROR_INVALID_STATE,
  92         IXGBE_ERROR_UNSUPPORTED,
  93         IXGBE_ERROR_ARGUMENT,
  94         IXGBE_ERROR_CAUTION,
  95 };
  96
  97 #define STATIC static
  98 #define IXGBE_NTOHL(_i) rte_be_to_cpu_32(_i)
  99 #define IXGBE_NTOHS(_i) rte_be_to_cpu_16(_i)
 100 #define IXGBE_CPU_TO_LE16(_i)  rte_cpu_to_le_16(_i)
 101 #define IXGBE_CPU_TO_LE32(_i)  rte_cpu_to_le_32(_i)
 102 #define IXGBE_LE32_TO_CPU(_i)  rte_le_to_cpu_32(_i)
 103 #define IXGBE_LE32_TO_CPUS(_i) rte_le_to_cpu_32(_i)
 104 #define IXGBE_CPU_TO_BE16(_i)  rte_cpu_to_be_16(_i)
 105 #define IXGBE_CPU_TO_BE32(_i)  rte_cpu_to_be_32(_i)
 106 #define IXGBE_BE32_TO_CPU(_i)  rte_be_to_cpu_32(_i)
 107
 108 typedef uint8_t         u8;
 109 typedef int8_t          s8;
 110 typedef uint16_t        u16;
 111 typedef int16_t         s16;
 112 typedef uint32_t        u32;
 113 typedef int32_t         s32;
 114 typedef uint64_t        u64;
 115 #ifndef __cplusplus
 116 typedef int             bool;
 117 #endif
 118
 119 #define mb()    rte_mb()
 120 #define wmb()   rte_wmb()
 121 #define rmb()   rte_rmb()
 122
 123 #define IOMEM
 124
 125 #define prefetch(x) rte_prefetch0(x)
 126
 127 #define IXGBE_PCI_REG(reg) rte_read32(reg)
 128
 129 static inline uint32_t ixgbe_read_addr(volatile void* addr)
 130 {
 131         return rte_le_to_cpu_32(IXGBE_PCI_REG(addr));
 132 }
 133
 134 #define IXGBE_PCI_REG_WRITE(reg, value)                 \
 135         rte_write32((rte_cpu_to_le_32(value)), reg)
 136
 137 #define IXGBE_PCI_REG_WRITE_RELAXED(reg, value)         \
 138         rte_write32_relaxed((rte_cpu_to_le_32(value)), reg)
 139
 140 #define IXGBE_PCI_REG_ADDR(hw, reg) \
 141         ((volatile uint32_t *)((char *)(hw)->hw_addr + (reg)))
 142
 143 #define IXGBE_PCI_REG_ARRAY_ADDR(hw, reg, index) \
 144         IXGBE_PCI_REG_ADDR((hw), (reg) + ((index) << 2))
 145
 146 /* Not implemented !! */
 147 #define IXGBE_READ_PCIE_WORD(hw, reg) 0
 148 #define IXGBE_WRITE_PCIE_WORD(hw, reg, value) do { } while(0)
 149
 150 #define IXGBE_WRITE_FLUSH(a) IXGBE_READ_REG(a, IXGBE_STATUS)
 151
 152 #define IXGBE_READ_REG(hw, reg) \
 153         ixgbe_read_addr(IXGBE_PCI_REG_ADDR((hw), (reg)))
 154
 155 #define IXGBE_WRITE_REG(hw, reg, value) \
 156         IXGBE_PCI_REG_WRITE(IXGBE_PCI_REG_ADDR((hw), (reg)), (value))
 157
 158 #define IXGBE_READ_REG_ARRAY(hw, reg, index) \
 159         IXGBE_PCI_REG(IXGBE_PCI_REG_ARRAY_ADDR((hw), (reg), (index)))
 160
 161 #define IXGBE_WRITE_REG_ARRAY(hw, reg, index, value) \
 162         IXGBE_PCI_REG_WRITE(IXGBE_PCI_REG_ARRAY_ADDR((hw), (reg), (index)), (value))
 163
 164 #define IXGBE_WRITE_REG_THEN_POLL_MASK(hw, reg, val, mask, poll_ms)     \
 165 do {                                                                    \
 166         uint32_t cnt = poll_ms;                                         \
 167         IXGBE_WRITE_REG(hw, (reg), (val));                              \
 168         while (((IXGBE_READ_REG(hw, (reg))) & (mask)) && (cnt--))       \
 169                 rte_delay_ms(1);                                        \
 170 } while (0)
 171
 172 #endif /* _IXGBE_OS_H_ */