lib/librte_pmd_e1000/e1000/e1000_osdep.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2001-2011, 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 _E1000_OSDEP_H_
  36 #define _E1000_OSDEP_H_
  37
  38 #include <stdint.h>
  39 #include <stdio.h>
  40 #include <stdarg.h>
  41 #include <string.h>
  42 #include <rte_common.h>
  43 #include <rte_cycles.h>
  44 #include <rte_log.h>
  45 #include <rte_debug.h>
  46
  47 #include "../e1000_logs.h"
  48
  49 /* Remove some compiler warnings for the files in this dir */
  50 #ifdef __INTEL_COMPILER
  51 #pragma warning(disable:2259) /* conversion may lose significant bits */
  52 #pragma warning(disable:869)  /* Parameter was never referenced */
  53 #pragma warning(disable:181)  /* Arg incompatible with format string */
  54 #pragma warning(disable:188)  /* enumerated type mixed with another type */
  55 #pragma warning(disable:1599) /* declaration hides variable */
  56 #pragma warning(disable:177)  /* declared but never referenced */
  57 #else
  58 #pragma GCC diagnostic ignored "-Wunused-parameter"
  59 #pragma GCC diagnostic ignored "-Wformat"
  60 #pragma GCC diagnostic ignored "-Wuninitialized"
  61 #pragma GCC diagnostic ignored "-Wunused-variable"
  62 #if (((__GNUC__) >= 4) && ((__GNUC_MINOR__) >= 7))
  63 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
  64 #endif
  65 #endif
  66
  67 #define DELAY(x) rte_delay_us(x)
  68 #define usec_delay(x) DELAY(x)
  69 #define msec_delay(x) DELAY(1000*(x))
  70 #define msec_delay_irq(x) DELAY(1000*(x))
  71
  72 #define DEBUGFUNC(F)            DEBUGOUT(F);
  73 #define DEBUGOUT(S, args...)    PMD_DRV_LOG(DEBUG, S, ##args)
  74 #define DEBUGOUT1(S, args...)   DEBUGOUT(S, ##args)
  75 #define DEBUGOUT2(S, args...)   DEBUGOUT(S, ##args)
  76 #define DEBUGOUT3(S, args...)   DEBUGOUT(S, ##args)
  77 #define DEBUGOUT6(S, args...)   DEBUGOUT(S, ##args)
  78 #define DEBUGOUT7(S, args...)   DEBUGOUT(S, ##args)
  79
  80 #define FALSE                   0
  81 #define TRUE                    1
  82
  83 #define CMD_MEM_WRT_INVALIDATE  0x0010  /* BIT_4 */
  84
  85 /* Mutex used in the shared code */
  86 #define E1000_MUTEX                     uintptr_t
  87 #define E1000_MUTEX_INIT(mutex)         (*(mutex) = 0)
  88 #define E1000_MUTEX_LOCK(mutex)         (*(mutex) = 1)
  89 #define E1000_MUTEX_UNLOCK(mutex)       (*(mutex) = 0)
  90
  91 typedef uint64_t        u64;
  92 typedef uint32_t        u32;
  93 typedef uint16_t        u16;
  94 typedef uint8_t         u8;
  95 typedef int64_t         s64;
  96 typedef int32_t         s32;
  97 typedef int16_t         s16;
  98 typedef int8_t          s8;
  99 typedef int             bool;
 100
 101 #define __le16          u16
 102 #define __le32          u32
 103 #define __le64          u64
 104
 105 #define E1000_WRITE_FLUSH(a) E1000_READ_REG(a, E1000_STATUS)
 106
 107 #define E1000_PCI_REG(reg) (*((volatile uint32_t *)(reg)))
 108
 109 #define E1000_PCI_REG_WRITE(reg, value) do { \
 110         E1000_PCI_REG((reg)) = (value); \
 111 } while (0)
 112
 113 #define E1000_PCI_REG_ADDR(hw, reg) \
 114         ((volatile uint32_t *)((char *)(hw)->hw_addr + (reg)))
 115
 116 #define E1000_PCI_REG_ARRAY_ADDR(hw, reg, index) \
 117         E1000_PCI_REG_ADDR((hw), (reg) + ((index) << 2))
 118
 119 static inline uint32_t e1000_read_addr(volatile void* addr)
 120 {
 121         return E1000_PCI_REG(addr);
 122 }
 123
 124 /* Register READ/WRITE macros */
 125
 126 #define E1000_READ_REG(hw, reg) \
 127         e1000_read_addr(E1000_PCI_REG_ADDR((hw), (reg)))
 128
 129 #define E1000_WRITE_REG(hw, reg, value) \
 130         E1000_PCI_REG_WRITE(E1000_PCI_REG_ADDR((hw), (reg)), (value))
 131
 132 #define E1000_READ_REG_ARRAY(hw, reg, index) \
 133         E1000_PCI_REG(E1000_PCI_REG_ARRAY_ADDR((hw), (reg), (index)))
 134
 135 #define E1000_WRITE_REG_ARRAY(hw, reg, index, value) \
 136         E1000_PCI_REG_WRITE(E1000_PCI_REG_ARRAY_ADDR((hw), (reg), (index)), (value))
 137
 138 #define E1000_READ_REG_ARRAY_DWORD E1000_READ_REG_ARRAY
 139 #define E1000_WRITE_REG_ARRAY_DWORD E1000_WRITE_REG_ARRAY
 140
 141 #define E1000_ACCESS_PANIC(x, hw, reg, value) \
 142         rte_panic("%s:%u\t" RTE_STR(x) "(%p, 0x%x, 0x%x)", \
 143                 __FILE__, __LINE__, (hw), (reg), (value))
 144
 145 /*
 146  * To be able to do IO write, we need to map IO BAR
 147  * (bar 2/4 depending on device).
 148  * Right now mapping multiple BARs is not supported by DPDK.
 149  * Fortunatelly we need it only for legacy hw support.
 150  */
 151
 152 #define E1000_WRITE_REG_IO(hw, reg, value) \
 153         E1000_WRITE_REG(hw, reg, value)
 154
 155 /*
 156  * Not implemented.
 157  */
 158
 159 #define E1000_READ_FLASH_REG(hw, reg) \
 160         (E1000_ACCESS_PANIC(E1000_READ_FLASH_REG, hw, reg, 0), 0)
 161
 162 #define E1000_READ_FLASH_REG16(hw, reg)  \
 163         (E1000_ACCESS_PANIC(E1000_READ_FLASH_REG16, hw, reg, 0), 0)
 164
 165 #define E1000_WRITE_FLASH_REG(hw, reg, value)  \
 166         E1000_ACCESS_PANIC(E1000_WRITE_FLASH_REG, hw, reg, value)
 167
 168 #define E1000_WRITE_FLASH_REG16(hw, reg, value) \
 169         E1000_ACCESS_PANIC(E1000_WRITE_FLASH_REG16, hw, reg, value)
 170
 171 #define STATIC static
 172
 173 #ifndef ETH_ADDR_LEN
 174 #define ETH_ADDR_LEN                  6
 175 #endif
 176
 177 #define false                         FALSE
 178 #define true                          TRUE
 179
 180 #endif /* _E1000_OSDEP_H_ */