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