xref: /freebsd/sys/dev/e1000/e1000_osdep.h (revision 39beb93c3f8bdbf72a61fda42300b5ebed7390c8)
1 /******************************************************************************
2 
3   Copyright (c) 2001-2008, 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/mbuf.h>
43 #include <sys/protosw.h>
44 #include <sys/socket.h>
45 #include <sys/malloc.h>
46 #include <sys/kernel.h>
47 #include <sys/bus.h>
48 #include <machine/bus.h>
49 #include <sys/rman.h>
50 #include <machine/resource.h>
51 #include <vm/vm.h>
52 #include <vm/pmap.h>
53 #include <machine/clock.h>
54 #include <dev/pci/pcivar.h>
55 #include <dev/pci/pcireg.h>
56 
57 
58 #define ASSERT(x) if(!(x)) panic("EM: x")
59 
60 /* The happy-fun DELAY macro is defined in /usr/src/sys/i386/include/clock.h */
61 #define usec_delay(x) DELAY(x)
62 #define msec_delay(x) DELAY(1000*(x))
63 /* TODO: Should we be paranoid about delaying in interrupt context? */
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)
69 	#define DEBUGOUT1(S,A)
70 	#define DEBUGOUT2(S,A,B)
71 	#define DEBUGOUT3(S,A,B,C)
72 	#define DEBUGOUT7(S,A,B,C,D,E,F,G)
73 
74 #define STATIC			static
75 #define FALSE			0
76 #define false			FALSE /* shared code stupidity */
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 /*
83 ** These typedefs are necessary due to the new
84 ** shared code, they are native to Linux.
85 */
86 typedef uint64_t	u64;
87 typedef uint32_t	u32;
88 typedef uint16_t	u16;
89 typedef uint8_t		u8;
90 typedef int64_t		s64;
91 typedef int32_t		s32;
92 typedef int16_t		s16;
93 typedef int8_t		s8;
94 typedef boolean_t	bool;
95 
96 #define __le16		u16
97 #define __le32		u32
98 #define __le64		u64
99 
100 struct e1000_osdep
101 {
102 	bus_space_tag_t    mem_bus_space_tag;
103 	bus_space_handle_t mem_bus_space_handle;
104 	bus_space_tag_t    io_bus_space_tag;
105 	bus_space_handle_t io_bus_space_handle;
106 	bus_space_tag_t    flash_bus_space_tag;
107 	bus_space_handle_t flash_bus_space_handle;
108 	struct device     *dev;
109 };
110 
111 #define E1000_REGISTER(hw, reg) (((hw)->mac.type >= e1000_82543) \
112     ? reg : e1000_translate_register_82542(reg))
113 
114 #define E1000_WRITE_FLUSH(a) E1000_READ_REG(a, E1000_STATUS)
115 
116 /* Read from an absolute offset in the adapter's memory space */
117 #define E1000_READ_OFFSET(hw, offset) \
118     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
119     ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, offset)
120 
121 /* Write to an absolute offset in the adapter's memory space */
122 #define E1000_WRITE_OFFSET(hw, offset, value) \
123     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
124     ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, offset, value)
125 
126 /* Register READ/WRITE macros */
127 
128 #define E1000_READ_REG(hw, reg) \
129     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
130         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
131         E1000_REGISTER(hw, reg))
132 
133 #define E1000_WRITE_REG(hw, reg, value) \
134     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
135         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
136         E1000_REGISTER(hw, reg), value)
137 
138 #define E1000_READ_REG_ARRAY(hw, reg, index) \
139     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
140         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
141         E1000_REGISTER(hw, reg) + ((index)<< 2))
142 
143 #define E1000_WRITE_REG_ARRAY(hw, reg, index, value) \
144     bus_space_write_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) + ((index)<< 2), value)
147 
148 #define E1000_READ_REG_ARRAY_DWORD E1000_READ_REG_ARRAY
149 #define E1000_WRITE_REG_ARRAY_DWORD E1000_WRITE_REG_ARRAY
150 
151 #define E1000_READ_REG_ARRAY_BYTE(hw, reg, index) \
152     bus_space_read_1(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
153         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
154         E1000_REGISTER(hw, reg) + index)
155 
156 #define E1000_WRITE_REG_ARRAY_BYTE(hw, reg, index, value) \
157     bus_space_write_1(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
158         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
159         E1000_REGISTER(hw, reg) + index, value)
160 
161 #define E1000_WRITE_REG_ARRAY_WORD(hw, reg, index, value) \
162     bus_space_write_2(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
163         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
164         E1000_REGISTER(hw, reg) + (index << 1), value)
165 
166 #define E1000_WRITE_REG_IO(hw, reg, value) do {\
167     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->io_bus_space_tag, \
168         ((struct e1000_osdep *)(hw)->back)->io_bus_space_handle, \
169         (hw)->io_base, reg); \
170     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->io_bus_space_tag, \
171         ((struct e1000_osdep *)(hw)->back)->io_bus_space_handle, \
172         (hw)->io_base + 4, value); } while (0)
173 
174 #define E1000_READ_FLASH_REG(hw, reg) \
175     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
176         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg)
177 
178 #define E1000_READ_FLASH_REG16(hw, reg) \
179     bus_space_read_2(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
180         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg)
181 
182 #define E1000_WRITE_FLASH_REG(hw, reg, value) \
183     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
184         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg, value)
185 
186 #define E1000_WRITE_FLASH_REG16(hw, reg, value) \
187     bus_space_write_2(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
188         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg, value)
189 
190 #endif  /* _FREEBSD_OS_H_ */
191 
192