xref: /dragonfly/sys/dev/netif/ig_hal/e1000_osdep.h (revision 74dc3754)
1 /******************************************************************************
2 
3   Copyright (c) 2001-2015, 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 #ifndef _DRAGONFLY_OS_H_
35 #define _DRAGONFLY_OS_H_
36 
37 #include <sys/param.h>
38 #include <sys/bus.h>
39 #include <sys/kernel.h>
40 #include <sys/systm.h>
41 
42 #include <bus/pci/pcivar.h>
43 #include <bus/pci/pcireg.h>
44 
45 #define usec_delay(x) DELAY(x)
46 #define usec_delay_irq(x) usec_delay(x)
47 #define msec_delay(x) DELAY(1000*(x))
48 #define msec_delay_irq(x) DELAY(1000*(x))
49 
50 extern int e1000_debug;
51 
52 #define DEBUGOUT(S, args...)		\
53 do {					\
54 	if (e1000_debug)		\
55 		kprintf(S, ##args);	\
56 } while (0)
57 #define DEBUGOUT1(S, args...)	DEBUGOUT(S, ##args)
58 #define DEBUGOUT2(S, args...)	DEBUGOUT(S, ##args)
59 #define DEBUGOUT3(S, args...)	DEBUGOUT(S, ##args)
60 #define DEBUGOUT7(S, args...)	DEBUGOUT(S, ##args)
61 #define DEBUGFUNC(F)		DEBUGOUT(F "\n")
62 
63 #define CMD_MEM_WRT_INVALIDATE	0x0010  /* BIT_4 */
64 #define PCI_COMMAND_REGISTER	PCIR_COMMAND
65 
66 /*
67  * These typedefs are necessary due to the new
68  * shared code, they are native to Linux.
69  */
70 typedef uint64_t	u64;
71 typedef uint32_t	u32;
72 typedef uint16_t	u16;
73 typedef uint8_t		u8;
74 typedef int64_t		s64;
75 typedef int32_t		s32;
76 typedef int16_t		s16;
77 typedef int8_t		s8;
78 
79 #define __le16		u16
80 #define __le32		u32
81 #define __le64		u64
82 
83 struct e1000_osdep {
84 	bus_space_tag_t		mem_bus_space_tag;
85 	bus_space_handle_t	mem_bus_space_handle;
86 	bus_space_tag_t		io_bus_space_tag;
87 	bus_space_handle_t	io_bus_space_handle;
88 	bus_space_tag_t		flash_bus_space_tag;
89 	bus_space_handle_t	flash_bus_space_handle;
90 	device_t		dev;
91 };
92 
93 #define E1000_REGISTER(hw, reg) (((hw)->mac.type >= e1000_82543) \
94     ? reg : e1000_translate_register_82542(reg))
95 
96 #define E1000_WRITE_FLUSH(a) E1000_READ_REG(a, E1000_STATUS)
97 
98 /* Read from an absolute offset in the adapter's memory space */
99 #define E1000_READ_OFFSET(hw, offset) \
100     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
101     ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, offset)
102 
103 /* Write to an absolute offset in the adapter's memory space */
104 #define E1000_WRITE_OFFSET(hw, offset, value) \
105     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
106     ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, offset, value)
107 
108 /* Register READ/WRITE macros */
109 
110 #define E1000_READ_REG(hw, reg) \
111     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
112         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
113         E1000_REGISTER(hw, reg))
114 
115 #define E1000_WRITE_REG(hw, reg, value) \
116     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
117         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
118         E1000_REGISTER(hw, reg), value)
119 
120 #define E1000_READ_REG_ARRAY(hw, reg, index) \
121     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
122         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
123         E1000_REGISTER(hw, reg) + ((index)<< 2))
124 
125 #define E1000_WRITE_REG_ARRAY(hw, reg, index, value) \
126     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
127         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
128         E1000_REGISTER(hw, reg) + ((index)<< 2), value)
129 
130 #define E1000_READ_REG_ARRAY_DWORD E1000_READ_REG_ARRAY
131 #define E1000_WRITE_REG_ARRAY_DWORD E1000_WRITE_REG_ARRAY
132 
133 #define E1000_READ_REG_ARRAY_BYTE(hw, reg, index) \
134     bus_space_read_1(((struct e1000_osdep *)(hw)->back)->mem_bus_space_tag, \
135         ((struct e1000_osdep *)(hw)->back)->mem_bus_space_handle, \
136         E1000_REGISTER(hw, reg) + index)
137 
138 #define E1000_WRITE_REG_ARRAY_BYTE(hw, reg, index, value) \
139     bus_space_write_1(((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, value)
142 
143 #define E1000_WRITE_REG_ARRAY_WORD(hw, reg, index, value) \
144     bus_space_write_2(((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 << 1), value)
147 
148 #define E1000_WRITE_REG_IO(hw, reg, value) do {\
149     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->io_bus_space_tag, \
150         ((struct e1000_osdep *)(hw)->back)->io_bus_space_handle, \
151         (hw)->io_base, reg); \
152     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->io_bus_space_tag, \
153         ((struct e1000_osdep *)(hw)->back)->io_bus_space_handle, \
154         (hw)->io_base + 4, value); } while (0)
155 
156 #define E1000_READ_FLASH_REG(hw, reg) \
157     bus_space_read_4(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
158         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg)
159 
160 #define E1000_READ_FLASH_REG16(hw, reg) \
161     bus_space_read_2(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
162         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg)
163 
164 #define E1000_WRITE_FLASH_REG(hw, reg, value) \
165     bus_space_write_4(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
166         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg, value)
167 
168 #define E1000_WRITE_FLASH_REG16(hw, reg, value) \
169     bus_space_write_2(((struct e1000_osdep *)(hw)->back)->flash_bus_space_tag, \
170         ((struct e1000_osdep *)(hw)->back)->flash_bus_space_handle, reg, value)
171 
172 #endif	/* _DRAGONFLY_OS_H_ */
173