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
  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 "\n");
  58 #define DEBUGOUT(S, args...)    PMD_DRV_LOG_RAW(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(e, S, args...)   DEBUGOUT(S, ##args)
  67 #define ERROR_REPORT3(e, S, args...)   DEBUGOUT(S, ##args)
  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 /* Shared code error reporting */
  86 enum {
  87         IXGBE_ERROR_SOFTWARE,
  88         IXGBE_ERROR_POLLING,
  89         IXGBE_ERROR_INVALID_STATE,
  90         IXGBE_ERROR_UNSUPPORTED,
  91         IXGBE_ERROR_ARGUMENT,
  92         IXGBE_ERROR_CAUTION,
  93 };
  94
  95 #define STATIC static
  96 #define IXGBE_NTOHL(_i) rte_be_to_cpu_32(_i)
  97 #define IXGBE_NTOHS(_i) rte_be_to_cpu_16(_i)
  98 #define IXGBE_CPU_TO_LE32(_i)  rte_cpu_to_le_32(_i)
  99 #define IXGBE_LE32_TO_CPU(_i) rte_le_to_cpu_32(_i)
 100 #define IXGBE_LE32_TO_CPUS(_i) rte_le_to_cpu_32(_i)
 101 #define IXGBE_CPU_TO_BE16(_i)  rte_cpu_to_be_16(_i)
 102 #define IXGBE_CPU_TO_BE32(_i)  rte_cpu_to_be_32(_i)
 103 #define IXGBE_BE32_TO_CPU(_i)  rte_be_to_cpu_32(_i)
 104
 105 typedef uint8_t         u8;
 106 typedef int8_t          s8;
 107 typedef uint16_t        u16;
 108 typedef int16_t         s16;
 109 typedef uint32_t        u32;
 110 typedef int32_t         s32;
 111 typedef uint64_t        u64;
 112 #ifndef __cplusplus
 113 typedef int             bool;
 114 #endif
 115
 116 #define mb()    rte_mb()
 117 #define wmb()   rte_wmb()
 118 #define rmb()   rte_rmb()
 119
 120 #define IOMEM
 121
 122 #define prefetch(x) rte_prefetch0(x)
 123
 124 #define IXGBE_PCI_REG(reg) (*((volatile uint32_t *)(reg)))
 125
 126 static inline uint32_t ixgbe_read_addr(volatile void* addr)
 127 {
 128         return rte_le_to_cpu_32(IXGBE_PCI_REG(addr));
 129 }
 130
 131 #define IXGBE_PCI_REG_WRITE(reg, value) do { \
 132         IXGBE_PCI_REG((reg)) = (rte_cpu_to_le_32(value)); \
 133 } while(0)
 134
 135 #define IXGBE_PCI_REG_ADDR(hw, reg) \
 136         ((volatile uint32_t *)((char *)(hw)->hw_addr + (reg)))
 137
 138 #define IXGBE_PCI_REG_ARRAY_ADDR(hw, reg, index) \
 139         IXGBE_PCI_REG_ADDR((hw), (reg) + ((index) << 2))
 140
 141 /* Not implemented !! */
 142 #define IXGBE_READ_PCIE_WORD(hw, reg) 0
 143 #define IXGBE_WRITE_PCIE_WORD(hw, reg, value) do { } while(0)
 144
 145 #define IXGBE_WRITE_FLUSH(a) IXGBE_READ_REG(a, IXGBE_STATUS)
 146
 147 #define IXGBE_READ_REG(hw, reg) \
 148         ixgbe_read_addr(IXGBE_PCI_REG_ADDR((hw), (reg)))
 149
 150 #define IXGBE_WRITE_REG(hw, reg, value) \
 151         IXGBE_PCI_REG_WRITE(IXGBE_PCI_REG_ADDR((hw), (reg)), (value))
 152
 153 #define IXGBE_READ_REG_ARRAY(hw, reg, index) \
 154         IXGBE_PCI_REG(IXGBE_PCI_REG_ARRAY_ADDR((hw), (reg), (index)))
 155
 156 #define IXGBE_WRITE_REG_ARRAY(hw, reg, index, value) \
 157         IXGBE_PCI_REG_WRITE(IXGBE_PCI_REG_ARRAY_ADDR((hw), (reg), (index)), (value))
 158
 159 #endif /* _IXGBE_OS_H_ */