sys/dev/e1000/e1000_osdep.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2001-2013, 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
  36 #ifndef _FREEBSD_OS_H_
  37 #define _FREEBSD_OS_H_
  38
  39 #include <sys/types.h>
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/lock.h>
  43 #include <sys/mutex.h>
  44 #include <sys/mbuf.h>
  45 #include <sys/protosw.h>
  46 #include <sys/socket.h>
  47 #include <sys/malloc.h>
  48 #include <sys/kernel.h>
  49 #include <sys/bus.h>
  50 #include <machine/bus.h>
  51 #include <sys/rman.h>
  52 #include <machine/resource.h>
  53 #include <vm/vm.h>
  54 #include <vm/pmap.h>
  55 #include <machine/clock.h>
  56 #include <dev/pci/pcivar.h>
  57 #include <dev/pci/pcireg.h>
  58
  59
  60 #define ASSERT(x) if(!(x)) panic("EM: x")
  61
  62 #define usec_delay(x) DELAY(x)
  63 #define msec_delay(x) DELAY(1000*(x))
  64 #define msec_delay_irq(x) DELAY(1000*(x))
  65
  66 #define MSGOUT(S, A, B)     printf(S "\n", A, B)
  67 #define DEBUGFUNC(F)        DEBUGOUT(F);
  68 #define DEBUGOUT(S)                     do {} while (0)
  69 /* This define is needed or shared code will not build */
  70 #define DEBUGOUT1(S,A)                  if (0) printf(S,A);
  71 #define DEBUGOUT2(S,A,B)                do {} while (0)
  72 #define DEBUGOUT3(S,A,B,C)              do {} while (0)
  73 #define DEBUGOUT7(S,A,B,C,D,E,F,G)      do {} while (0)
  74
  75 #define STATIC                  static
  76 #define FALSE                   0
  77 #define TRUE                    1
  78 #ifndef __bool_true_false_are_defined
  79 #define false                   FALSE
  80 #define true                    TRUE
  81 #endif
  82 #define CMD_MEM_WRT_INVALIDATE  0x0010  /* BIT_4 */
  83 #define PCI_COMMAND_REGISTER    PCIR_COMMAND
  84
  85 /* Mutex used in the shared code */
  86 #define E1000_MUTEX                     struct mtx
  87 #define E1000_MUTEX_INIT(mutex)         mtx_init((mutex), #mutex, \
  88                                             MTX_NETWORK_LOCK, \
  89                                             MTX_DEF | MTX_DUPOK)
  90 #define E1000_MUTEX_DESTROY(mutex)      mtx_destroy(mutex)
  91 #define E1000_MUTEX_LOCK(mutex)         mtx_lock(mutex)
  92 #define E1000_MUTEX_TRYLOCK(mutex)      mtx_trylock(mutex)
  93 #define E1000_MUTEX_UNLOCK(mutex)       mtx_unlock(mutex)
  94
  95 typedef uint64_t        u64;
  96 typedef uint32_t        u32;
  97 typedef uint16_t        u16;
  98 typedef uint8_t         u8;
  99 typedef int64_t         s64;
 100 typedef int32_t         s32;
 101 typedef int16_t         s16;
 102 typedef int8_t          s8;
 103 #ifndef __bool_true_false_are_defined
 104 typedef boolean_t       bool;
 105 #endif
 106
 107 #define __le16          u16
 108 #define __le32          u32
 109 #define __le64          u64
 110
 111 #if __FreeBSD_version < 800000 /* Now in HEAD */
 112 #if defined(__i386__) || defined(__amd64__)
 113 #define mb()    __asm volatile("mfence" ::: "memory")
 114 #define wmb()   __asm volatile("sfence" ::: "memory")
 115 #define rmb()   __asm volatile("lfence" ::: "memory")
 116 #else
 117 #define mb()
 118 #define rmb()
 119 #define wmb()
 120 #endif
 121 #endif /*__FreeBSD_version < 800000 */
 122
 123 #if defined(__i386__) || defined(__amd64__)
 124 static __inline
 125 void prefetch(void *x)
 126 {
 127         __asm volatile("prefetcht0 %0" :: "m" (*(unsigned long *)x));
 128 }
 129 #else
 130 #define prefetch(x)
 131 #endif
 132
 133 struct e1000_osdep
 134 {
 135         bus_space_tag_t    mem_bus_space_tag;
 136         bus_space_handle_t mem_bus_space_handle;
 137         bus_space_tag_t    io_bus_space_tag;
 138         bus_space_handle_t io_bus_space_handle;
 139         bus_space_tag_t    flash_bus_space_tag;
 140         bus_space_handle_t flash_bus_space_handle;
 141         struct device     *dev;
 142 };
 143
 144 #define E1000_REGISTER(hw, reg) (((hw)->mac.type >= e1000_82543) \
 145     ? reg : e1000_translate_register_82542(reg))
 146
 147 #define E1000_WRITE_FLUSH(a) E1000_READ_REG(a, E1000_STATUS)
 148
 149 /* Read from an absolute offset in the adapter's memory space */
 150 #define E1000_READ_OFFSET(hw, offset) \
 151     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
 152     ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, offset)
 153
 154 /* Write to an absolute offset in the adapter's memory space */
 155 #define E1000_WRITE_OFFSET(hw, offset, value) \
 156     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
 157     ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, offset, value)
 158
 159 /* Register READ/WRITE macros */
 160
 161 #define E1000_READ_REG(hw, reg) \
 162     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
 163         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
 164         E1000_REGISTER(hw, reg))
 165
 166 #define E1000_WRITE_REG(hw, reg, value) \
 167     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
 168         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
 169         E1000_REGISTER(hw, reg), value)
 170
 171 #define E1000_READ_REG_ARRAY(hw, reg, index) \
 172     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
 173         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
 174         E1000_REGISTER(hw, reg) + ((index)<< 2))
 175
 176 #define E1000_WRITE_REG_ARRAY(hw, reg, index, value) \
 177     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
 178         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
 179         E1000_REGISTER(hw, reg) + ((index)<< 2), value)
 180
 181 #define E1000_READ_REG_ARRAY_DWORD E1000_READ_REG_ARRAY
 182 #define E1000_WRITE_REG_ARRAY_DWORD E1000_WRITE_REG_ARRAY
 183
 184 #define E1000_READ_REG_ARRAY_BYTE(hw, reg, index) \
 185     bus_space_read_1(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
 186         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
 187         E1000_REGISTER(hw, reg) + index)
 188
 189 #define E1000_WRITE_REG_ARRAY_BYTE(hw, reg, index, value) \
 190     bus_space_write_1(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
 191         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
 192         E1000_REGISTER(hw, reg) + index, value)
 193
 194 #define E1000_WRITE_REG_ARRAY_WORD(hw, reg, index, value) \
 195     bus_space_write_2(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
 196         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
 197         E1000_REGISTER(hw, reg) + (index << 1), value)
 198
 199 #define E1000_WRITE_REG_IO(hw, reg, value) do {\
 200     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->io_bus_space_tag, \
 201         ((struct e1000_osdep *)(hw)->back)->io_bus_space_handle, \
 202         (hw)->io_base, reg); \
 203     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->io_bus_space_tag, \
 204         ((struct e1000_osdep *)(hw)->back)->io_bus_space_handle, \
 205         (hw)->io_base + 4, value); } while (0)
 206
 207 #define E1000_READ_FLASH_REG(hw, reg) \
 208     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
 209         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg)
 210
 211 #define E1000_READ_FLASH_REG16(hw, reg) \
 212     bus_space_read_2(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
 213         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg)
 214
 215 #define E1000_WRITE_FLASH_REG(hw, reg, value) \
 216     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
 217         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg, value)
 218
 219 #define E1000_WRITE_FLASH_REG16(hw, reg, value) \
 220     bus_space_write_2(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
 221         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg, value)
 222
 223 #endif  /* _FREEBSD_OS_H_ */
 224