7134dcd381887c4629445824be0c1efeb1feab29
[dragonfly.git] / sys / dev / netif / ixgbe / ixgbe_osdep.h
1 /******************************************************************************
2
3   Copyright (c) 2001-2012, 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: src/sys/dev/ixgbe/ixgbe_osdep.h,v 1.13 2012/07/05 20:51:44 jfv Exp $*/
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/endian.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 <sys/rman.h>
49 #include <vm/vm.h>
50 #include <vm/pmap.h>
51 #include <machine/clock.h>
52 #include <bus/pci/pcivar.h>
53 #include <bus/pci/pcireg.h>
54
55 #define ASSERT(x) if(!(x)) panic("IXGBE: x")
56 #define EWARN(H, W, S) kprintf(W)
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)     kprintf(S "\n", A, B)
64 #define DEBUGFUNC(F)        DEBUGOUT(F);
65 #if DBG
66         #define DEBUGOUT(S)         kprintf(S "\n")
67         #define DEBUGOUT1(S,A)      kprintf(S "\n",A)
68         #define DEBUGOUT2(S,A,B)    kprintf(S "\n",A,B)
69         #define DEBUGOUT3(S,A,B,C)  kprintf(S "\n",A,B,C)
70         #define DEBUGOUT6(S,A,B,C,D,E,F)    kprintf(S "\n",A,B,C,D,E,F)
71         #define DEBUGOUT7(S,A,B,C,D,E,F,G)  kprintf(S "\n",A,B,C,D,E,F,G)
72 #else
73         #define DEBUGOUT(S)
74         #define DEBUGOUT1(S,A)
75         #define DEBUGOUT2(S,A,B)
76         #define DEBUGOUT3(S,A,B,C)
77         #define DEBUGOUT6(S,A,B,C,D,E,F)
78         #define DEBUGOUT7(S,A,B,C,D,E,F,G)
79 #endif
80
81 #define FALSE               0
82 #define false               0 /* shared code requires this */
83 #define TRUE                1
84 #define true                1
85 #define CMD_MEM_WRT_INVALIDATE          0x0010  /* BIT_4 */
86 #define PCI_COMMAND_REGISTER            PCIR_COMMAND
87
88 /* Bunch of defines for shared code bogosity */
89 #define UNREFERENCED_PARAMETER(_p)
90 #define UNREFERENCED_1PARAMETER(_p)
91 #define UNREFERENCED_2PARAMETER(_p, _q)
92 #define UNREFERENCED_3PARAMETER(_p, _q, _r)
93 #define UNREFERENCED_4PARAMETER(_p, _q, _r, _s)
94
95
96 #define IXGBE_NTOHL(_i) ntohl(_i)
97 #define IXGBE_NTOHS(_i) ntohs(_i)
98
99 /* XXX these need to be revisited */
100 #define IXGBE_CPU_TO_LE32 le32toh
101 #define IXGBE_LE32_TO_CPUS le32dec
102
103 typedef uint8_t         u8;
104 typedef int8_t          s8;
105 typedef uint16_t        u16;
106 typedef uint32_t        u32;
107 typedef int32_t         s32;
108 typedef uint64_t        u64;
109 #ifndef __bool_true_false_are_defined
110 typedef boolean_t       bool;
111 #endif
112
113 /* shared code requires this */
114 #define __le16  u16
115 #define __le32  u32
116 #define __le64  u64
117 #define __be16  u16
118 #define __be32  u32
119 #define __be64  u64
120
121 #define le16_to_cpu 
122
123 #if defined(__i386__) || defined(__amd64__)
124 #define wmb()   __asm volatile("sfence" ::: "memory")
125 #else
126 #define wmb()
127 #endif
128
129 #if defined(__i386__) || defined(__amd64__)
130 static __inline
131 void prefetch(void *x)
132 {
133         __asm volatile("prefetcht0 %0" :: "m" (*(unsigned long *)x));
134 }
135 #else
136 #define prefetch(x)
137 #endif
138
139 struct ixgbe_osdep
140 {
141         bus_space_tag_t    mem_bus_space_tag;
142         bus_space_handle_t mem_bus_space_handle;
143         struct device     *dev;
144 };
145
146 /* These routines are needed by the shared code */
147 struct ixgbe_hw; 
148 extern u16 ixgbe_read_pci_cfg(struct ixgbe_hw *, u32);
149 #define IXGBE_READ_PCIE_WORD ixgbe_read_pci_cfg
150
151 extern void ixgbe_write_pci_cfg(struct ixgbe_hw *, u32, u16);
152 #define IXGBE_WRITE_PCIE_WORD ixgbe_write_pci_cfg
153
154 #define IXGBE_WRITE_FLUSH(a) IXGBE_READ_REG(a, IXGBE_STATUS)
155
156 #define IXGBE_READ_REG(a, reg) (\
157    bus_space_read_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
158                      ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
159                      reg))
160
161 #define IXGBE_WRITE_REG(a, reg, value) (\
162    bus_space_write_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
163                      ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
164                      reg, value))
165
166
167 #define IXGBE_READ_REG_ARRAY(a, reg, offset) (\
168    bus_space_read_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
169                      ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
170                      (reg + ((offset) << 2))))
171
172 #define IXGBE_WRITE_REG_ARRAY(a, reg, offset, value) (\
173       bus_space_write_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
174                       ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
175                       (reg + ((offset) << 2)), value))
176
177
178 #endif /* _IXGBE_OS_H_ */