lib/librte_pmd_ixgbe/ixgbe/ixgbe_osdep.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2001-2012, 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 #include "../ixgbe_bypass_defines.h"
  50
  51 #define ASSERT(x) if(!(x)) rte_panic("IXGBE: x")
  52
  53 #define DELAY(x) rte_delay_us(x)
  54 #define usec_delay(x) DELAY(x)
  55 #define msec_delay(x) DELAY(1000*(x))
  56
  57 #define DEBUGFUNC(F)            DEBUGOUT(F);
  58 #define DEBUGOUT(S, args...)    PMD_DRV_LOG(DEBUG, S, ##args)
  59 #define DEBUGOUT1(S, args...)   DEBUGOUT(S, ##args)
  60 #define DEBUGOUT2(S, args...)   DEBUGOUT(S, ##args)
  61 #define DEBUGOUT3(S, args...)   DEBUGOUT(S, ##args)
  62 #define DEBUGOUT6(S, args...)   DEBUGOUT(S, ##args)
  63 #define DEBUGOUT7(S, args...)   DEBUGOUT(S, ##args)
  64
  65 #define ERROR_REPORT1(e, S, args...)   DEBUGOUT(S, ##args)
  66 #define ERROR_REPORT2  DEBUGOUT2
  67 #define ERROR_REPORT3  DEBUGOUT3
  68
  69 #define FALSE               0
  70 #define TRUE                1
  71
  72 #define false               0
  73 #define true                1
  74 #define min(a,b)        RTE_MIN(a,b)
  75
  76 #define EWARN(hw, S, args...)     DEBUGOUT1(S, ##args)
  77
  78 /* Bunch of defines for shared code bogosity */
  79 #define UNREFERENCED_PARAMETER(_p)
  80 #define UNREFERENCED_1PARAMETER(_p)
  81 #define UNREFERENCED_2PARAMETER(_p, _q)
  82 #define UNREFERENCED_3PARAMETER(_p, _q, _r)
  83 #define UNREFERENCED_4PARAMETER(_p, _q, _r, _s)
  84
  85 #define STATIC static
  86 #define IXGBE_NTOHL(_i) rte_be_to_cpu_32(_i)
  87 #define IXGBE_NTOHS(_i) rte_be_to_cpu_16(_i)
  88 #define IXGBE_CPU_TO_LE32(_i)  rte_cpu_to_le_32(_i)
  89 #define IXGBE_LE32_TO_CPUS(_i) rte_le_to_cpu_32(_i)
  90
  91 typedef uint8_t         u8;
  92 typedef int8_t          s8;
  93 typedef uint16_t        u16;
  94 typedef int16_t s16;
  95 typedef uint32_t        u32;
  96 typedef int32_t         s32;
  97 typedef uint64_t        u64;
  98 typedef int             bool;
  99
 100 #define mb()    rte_mb()
 101 #define wmb()   rte_wmb()
 102 #define rmb()   rte_rmb()
 103
 104 #define prefetch(x) rte_prefetch0(x)
 105
 106 #define IXGBE_PCI_REG(reg) (*((volatile uint32_t *)(reg)))
 107
 108 static inline uint32_t ixgbe_read_addr(volatile void* addr)
 109 {
 110         return IXGBE_PCI_REG(addr);
 111 }
 112
 113 #define IXGBE_PCI_REG_WRITE(reg, value) do { \
 114         IXGBE_PCI_REG((reg)) = (value); \
 115 } while(0)
 116
 117 #define IXGBE_PCI_REG_ADDR(hw, reg) \
 118         ((volatile uint32_t *)((char *)(hw)->hw_addr + (reg)))
 119
 120 #define IXGBE_PCI_REG_ARRAY_ADDR(hw, reg, index) \
 121         IXGBE_PCI_REG_ADDR((hw), (reg) + ((index) << 2))
 122
 123 /* Not implemented !! */
 124 #define IXGBE_READ_PCIE_WORD(hw, reg) 0
 125 #define IXGBE_WRITE_PCIE_WORD(hw, reg, value) do { } while(0)
 126
 127 #define IXGBE_WRITE_FLUSH(a) IXGBE_READ_REG(a, IXGBE_STATUS)
 128
 129 #define IXGBE_READ_REG(hw, reg) \
 130         ixgbe_read_addr(IXGBE_PCI_REG_ADDR((hw), (reg)))
 131
 132 #define IXGBE_WRITE_REG(hw, reg, value) \
 133         IXGBE_PCI_REG_WRITE(IXGBE_PCI_REG_ADDR((hw), (reg)), (value))
 134
 135 #define IXGBE_READ_REG_ARRAY(hw, reg, index) \
 136         IXGBE_PCI_REG(IXGBE_PCI_REG_ARRAY_ADDR((hw), (reg), (index)))
 137
 138 #define IXGBE_WRITE_REG_ARRAY(hw, reg, index, value) \
 139         IXGBE_PCI_REG_WRITE(IXGBE_PCI_REG_ARRAY_ADDR((hw), (reg), (index)), (value))
 140
 141 #endif /* _IXGBE_OS_H_ */