f0f505fc3443b178796c56d75cc4129a4505878b
[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.12 2012/01/30 23:03:21 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
57 /* The happy-fun DELAY macro is defined in /usr/src/sys/i386/include/clock.h */
58 #define usec_delay(x) DELAY(x)
59 #define msec_delay(x) DELAY(1000*(x))
60
61 #define DBG 0 
62 #define MSGOUT(S, A, B)     printf(S "\n", A, B)
63 #define DEBUGFUNC(F)        DEBUGOUT(F);
64 #if DBG
65         #define DEBUGOUT(S)         printf(S "\n")
66         #define DEBUGOUT1(S,A)      printf(S "\n",A)
67         #define DEBUGOUT2(S,A,B)    printf(S "\n",A,B)
68         #define DEBUGOUT3(S,A,B,C)  printf(S "\n",A,B,C)
69         #define DEBUGOUT7(S,A,B,C,D,E,F,G)  printf(S "\n",A,B,C,D,E,F,G)
70 #else
71         #define DEBUGOUT(S)
72         #define DEBUGOUT1(S,A)
73         #define DEBUGOUT2(S,A,B)
74         #define DEBUGOUT3(S,A,B,C)
75         #define DEBUGOUT6(S,A,B,C,D,E,F)
76         #define DEBUGOUT7(S,A,B,C,D,E,F,G)
77 #endif
78
79 #define FALSE               0
80 #define false               0 /* shared code requires this */
81 #define TRUE                1
82 #define true                1
83 #define CMD_MEM_WRT_INVALIDATE          0x0010  /* BIT_4 */
84 #define PCI_COMMAND_REGISTER            PCIR_COMMAND
85
86 /* Bunch of defines for shared code bogosity */
87 #define UNREFERENCED_PARAMETER(_p)
88 #define UNREFERENCED_1PARAMETER(_p)
89 #define UNREFERENCED_2PARAMETER(_p, _q)
90 #define UNREFERENCED_3PARAMETER(_p, _q, _r)
91 #define UNREFERENCED_4PARAMETER(_p, _q, _r, _s)
92
93
94 #define IXGBE_NTOHL(_i) ntohl(_i)
95 #define IXGBE_NTOHS(_i) ntohs(_i)
96
97 /* XXX these need to be revisited */
98 #define IXGBE_CPU_TO_LE32 le32toh
99 #define IXGBE_LE32_TO_CPUS le32dec
100
101 typedef uint8_t         u8;
102 typedef int8_t          s8;
103 typedef uint16_t        u16;
104 typedef uint32_t        u32;
105 typedef int32_t         s32;
106 typedef uint64_t        u64;
107 #ifndef __bool_true_false_are_defined
108 typedef boolean_t       bool;
109 #endif
110
111 #define le16_to_cpu 
112
113 #if defined(__i386__) || defined(__amd64__)
114 #define wmb()   __asm volatile("sfence" ::: "memory")
115 #else
116 #define wmb()
117 #endif
118
119 #if defined(__i386__) || defined(__amd64__)
120 static __inline
121 void prefetch(void *x)
122 {
123         __asm volatile("prefetcht0 %0" :: "m" (*(unsigned long *)x));
124 }
125 #else
126 #define prefetch(x)
127 #endif
128
129 struct ixgbe_osdep
130 {
131         bus_space_tag_t    mem_bus_space_tag;
132         bus_space_handle_t mem_bus_space_handle;
133         struct device     *dev;
134 };
135
136 /* These routines are needed by the shared code */
137 struct ixgbe_hw; 
138 extern u16 ixgbe_read_pci_cfg(struct ixgbe_hw *, u32);
139 #define IXGBE_READ_PCIE_WORD ixgbe_read_pci_cfg
140
141 extern void ixgbe_write_pci_cfg(struct ixgbe_hw *, u32, u16);
142 #define IXGBE_WRITE_PCIE_WORD ixgbe_write_pci_cfg
143
144 #define IXGBE_WRITE_FLUSH(a) IXGBE_READ_REG(a, IXGBE_STATUS)
145
146 #define IXGBE_READ_REG(a, reg) (\
147    bus_space_read_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
148                      ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
149                      reg))
150
151 #define IXGBE_WRITE_REG(a, reg, value) (\
152    bus_space_write_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
153                      ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
154                      reg, value))
155
156
157 #define IXGBE_READ_REG_ARRAY(a, reg, offset) (\
158    bus_space_read_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
159                      ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
160                      (reg + ((offset) << 2))))
161
162 #define IXGBE_WRITE_REG_ARRAY(a, reg, offset, value) (\
163       bus_space_write_4( ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_tag, \
164                       ((struct ixgbe_osdep *)(a)->back)->mem_bus_space_handle, \
165                       (reg + ((offset) << 2)), value))
166
167
168 #endif /* _IXGBE_OS_H_ */