lib/librte_pmd_ixgbe/ixgbe/ixgbe_osdep.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2001-2010, 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
  48 #include "../ixgbe_logs.h"
  49
  50 /* Remove some compiler warnings for the files in this dir */
  51 #ifdef __INTEL_COMPILER
  52 #pragma warning(disable:2259) /* Conversion may lose significant bits */
  53 #pragma warning(disable:869)  /* Parameter was never referenced */
  54 #pragma warning(disable:181)  /* Arg incompatible with format string */
  55 #pragma warning(disable:1419) /* External declaration in primary source file */
  56 #pragma warning(disable:111)  /* Statement is unreachable */
  57 #pragma warning(disable:981)  /* Operands are evaluated in unspecified order */
  58 #else
  59 #pragma GCC diagnostic ignored "-Wunused-parameter"
  60 #pragma GCC diagnostic ignored "-Wformat"
  61 #pragma GCC diagnostic ignored "-Wuninitialized"
  62 #pragma GCC diagnostic ignored "-Wstrict-aliasing"
  63 #if (((__GNUC__) >= 4) && ((__GNUC_MINOR__) >= 7))
  64 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
  65 #endif
  66 #endif
  67
  68 #define ASSERT(x) if(!(x)) rte_panic("IXGBE: x")
  69
  70 #define DELAY(x) rte_delay_us(x)
  71 #define usec_delay(x) DELAY(x)
  72 #define msec_delay(x) DELAY(1000*(x))
  73
  74 #define DEBUGFUNC(F)            DEBUGOUT(F);
  75 #define DEBUGOUT(S, args...)    PMD_DRV_LOG(DEBUG, S, ##args)
  76 #define DEBUGOUT1(S, args...)   DEBUGOUT(S, ##args)
  77 #define DEBUGOUT2(S, args...)   DEBUGOUT(S, ##args)
  78 #define DEBUGOUT3(S, args...)   DEBUGOUT(S, ##args)
  79 #define DEBUGOUT6(S, args...)   DEBUGOUT(S, ##args)
  80 #define DEBUGOUT7(S, args...)   DEBUGOUT(S, ##args)
  81
  82 #define FALSE               0
  83 #define TRUE                1
  84
  85 /* Bunch of defines for shared code bogosity */
  86 #define UNREFERENCED_PARAMETER(_p)
  87 #define UNREFERENCED_1PARAMETER(_p)
  88 #define UNREFERENCED_2PARAMETER(_p, _q)
  89 #define UNREFERENCED_3PARAMETER(_p, _q, _r)
  90 #define UNREFERENCED_4PARAMETER(_p, _q, _r, _s)
  91
  92
  93 #define IXGBE_NTOHL(_i) rte_be_to_cpu_32(_i)
  94 #define IXGBE_NTOHS(_i) rte_be_to_cpu_16(_i)
  95
  96 typedef uint8_t         u8;
  97 typedef int8_t          s8;
  98 typedef uint16_t        u16;
  99 typedef uint32_t        u32;
 100 typedef int32_t         s32;
 101 typedef uint64_t        u64;
 102 typedef int             bool;
 103
 104 #define mb()    rte_mb()
 105 #define wmb()   rte_wmb()
 106 #define rmb()   rte_rmb()
 107
 108 #define prefetch(x) rte_prefetch0(x)
 109
 110 #define IXGBE_PCI_REG(reg) (*((volatile uint32_t *)(reg)))
 111
 112 static inline uint32_t ixgbe_read_addr(volatile void* addr)
 113 {
 114         return IXGBE_PCI_REG(addr);
 115 }
 116
 117 #define IXGBE_PCI_REG_WRITE(reg, value) do { \
 118         IXGBE_PCI_REG((reg)) = (value); \
 119 } while(0)
 120
 121 #define IXGBE_PCI_REG_ADDR(hw, reg) \
 122         ((volatile uint32_t *)((char *)(hw)->hw_addr + (reg)))
 123
 124 #define IXGBE_PCI_REG_ARRAY_ADDR(hw, reg, index) \
 125         IXGBE_PCI_REG_ADDR((hw), (reg) + ((index) << 2))
 126
 127 /* Not implemented !! */
 128 #define IXGBE_READ_PCIE_WORD(hw, reg) 0
 129 #define IXGBE_WRITE_PCIE_WORD(hw, reg, value) do { } while(0)
 130
 131 #define IXGBE_WRITE_FLUSH(a) IXGBE_READ_REG(a, IXGBE_STATUS)
 132
 133 #define IXGBE_READ_REG(hw, reg) \
 134         ixgbe_read_addr(IXGBE_PCI_REG_ADDR((hw), (reg)))
 135
 136 #define IXGBE_WRITE_REG(hw, reg, value) \
 137         IXGBE_PCI_REG_WRITE(IXGBE_PCI_REG_ADDR((hw), (reg)), (value))
 138
 139 #define IXGBE_READ_REG_ARRAY(hw, reg, index) \
 140         IXGBE_PCI_REG(IXGBE_PCI_REG_ARRAY_ADDR((hw), (reg), (index)))
 141
 142 #define IXGBE_WRITE_REG_ARRAY(hw, reg, index, value) \
 143         IXGBE_PCI_REG_WRITE(IXGBE_PCI_REG_ARRAY_ADDR((hw), (reg), (index)), (value))
 144
 145 #endif /* _IXGBE_OS_H_ */