xref: /freebsd/sys/dev/ixgbe/ixgbe_osdep.h (revision bb15ca603fa442c72dde3f3cb8b46db6970e3950)
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 #ifndef _IXGBE_OS_H_
36 #define _IXGBE_OS_H_
37 
38 #include <sys/types.h>
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/mbuf.h>
42 #include <sys/protosw.h>
43 #include <sys/socket.h>
44 #include <sys/malloc.h>
45 #include <sys/kernel.h>
46 #include <sys/bus.h>
47 #include <machine/bus.h>
48 #include <sys/rman.h>
49 #include <machine/resource.h>
50 #include <vm/vm.h>
51 #include <vm/pmap.h>
52 #include <machine/clock.h>
53 #include <dev/pci/pcivar.h>
54 #include <dev/pci/pcireg.h>
55 
56 #define ASSERT(x) if(!(x)) panic("IXGBE: x")
57 
58 /* The happy-fun DELAY macro is defined in /usr/src/sys/i386/include/clock.h */
59 #define usec_delay(x) DELAY(x)
60 #define msec_delay(x) DELAY(1000*(x))
61 
62 #define DBG 0
63 #define MSGOUT(S, A, B)     printf(S "\n", A, B)
64 #define DEBUGFUNC(F)        DEBUGOUT(F);
65 #if DBG
66 	#define DEBUGOUT(S)         printf(S "\n")
67 	#define DEBUGOUT1(S,A)      printf(S "\n",A)
68 	#define DEBUGOUT2(S,A,B)    printf(S "\n",A,B)
69 	#define DEBUGOUT3(S,A,B,C)  printf(S "\n",A,B,C)
70 	#define DEBUGOUT7(S,A,B,C,D,E,F,G)  printf(S "\n",A,B,C,D,E,F,G)
71 #else
72 	#define DEBUGOUT(S)
73 	#define DEBUGOUT1(S,A)
74 	#define DEBUGOUT2(S,A,B)
75 	#define DEBUGOUT3(S,A,B,C)
76 	#define DEBUGOUT6(S,A,B,C,D,E,F)
77 	#define DEBUGOUT7(S,A,B,C,D,E,F,G)
78 #endif
79 
80 #define FALSE               0
81 #define false               0 /* shared code requires this */
82 #define TRUE                1
83 #define true                1
84 #define CMD_MEM_WRT_INVALIDATE          0x0010  /* BIT_4 */
85 #define PCI_COMMAND_REGISTER            PCIR_COMMAND
86 #define UNREFERENCED_PARAMETER(_p)
87 
88 
89 #define IXGBE_NTOHL(_i)	ntohl(_i)
90 #define IXGBE_NTOHS(_i)	ntohs(_i)
91 
92 typedef uint8_t		u8;
93 typedef int8_t		s8;
94 typedef uint16_t	u16;
95 typedef uint32_t	u32;
96 typedef int32_t		s32;
97 typedef uint64_t	u64;
98 #ifndef __bool_true_false_are_defined
99 typedef boolean_t	bool;
100 #endif
101 
102 #define le16_to_cpu
103 
104 #if __FreeBSD_version < 800000
105 #if defined(__i386__) || defined(__amd64__)
106 #define mb()	__asm volatile("mfence" ::: "memory")
107 #define wmb()	__asm volatile("sfence" ::: "memory")
108 #define rmb()	__asm volatile("lfence" ::: "memory")
109 #else
110 #define mb()
111 #define rmb()
112 #define wmb()
113 #endif
114 #endif
115 
116 #if defined(__i386__) || defined(__amd64__)
117 static __inline
118 void prefetch(void *x)
119 {
120 	__asm volatile("prefetcht0 %0" :: "m" (*(unsigned long *)x));
121 }
122 #else
123 #define prefetch(x)
124 #endif
125 
126 struct ixgbe_osdep
127 {
128 	bus_space_tag_t    mem_bus_space_tag;
129 	bus_space_handle_t mem_bus_space_handle;
130 	struct device     *dev;
131 };
132 
133 /* These routines are needed by the shared code */
134 struct ixgbe_hw;
135 extern u16 ixgbe_read_pci_cfg(struct ixgbe_hw *, u32);
136 #define IXGBE_READ_PCIE_WORD ixgbe_read_pci_cfg
137 
138 extern void ixgbe_write_pci_cfg(struct ixgbe_hw *, u32, u16);
139 #define IXGBE_WRITE_PCIE_WORD ixgbe_write_pci_cfg
140 
141 #define IXGBE_WRITE_FLUSH(a) IXGBE_READ_REG(a, IXGBE_STATUS)
142 
143 #define IXGBE_READ_REG(a, reg) (\
144    bus_space_read_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
145                      ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
146                      reg))
147 
148 #define IXGBE_WRITE_REG(a, reg, value) (\
149    bus_space_write_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
150                      ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
151                      reg, value))
152 
153 
154 #define IXGBE_READ_REG_ARRAY(a, reg, offset) (\
155    bus_space_read_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
156                      ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
157                      (reg + ((offset) << 2))))
158 
159 #define IXGBE_WRITE_REG_ARRAY(a, reg, offset, value) (\
160       bus_space_write_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
161                       ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
162                       (reg + ((offset) << 2)), value))
163 
164 
165 #endif /* _IXGBE_OS_H_ */
166