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