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