sys/dev/netif/e1000/e1000_osdep.h

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