sys/dev/e1000/e1000_osdep.h

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