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