BXE: bring in the bus_space_{read,write}
[akaros.git] / kern / drivers / net / bxe / bsd_bus.h
1 /* Various parts of FreeBSD x86/include/bus.h
2  *
3  * Copyright (c) KATO Takenori, 1999.
4  *
5  * All rights reserved.  Unpublished rights reserved under the copyright
6  * laws of Japan.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer as
14  *    the first lines of this file unmodified.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * $FreeBSD: head/sys/x86/include/bus.h 263289 2014-03-18 01:40:25Z emaste $
33  */
34
35 /*      $NetBSD: bus.h,v 1.12 1997/10/01 08:25:15 fvdl Exp $    */
36
37 /*-
38  * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
39  * All rights reserved.
40  *
41  * This code is derived from software contributed to The NetBSD Foundation
42  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
43  * NASA Ames Research Center.
44  *
45  * Redistribution and use in source and binary forms, with or without
46  * modification, are permitted provided that the following conditions
47  * are met:
48  * 1. Redistributions of source code must retain the above copyright
49  *    notice, this list of conditions and the following disclaimer.
50  * 2. Redistributions in binary form must reproduce the above copyright
51  *    notice, this list of conditions and the following disclaimer in the
52  *    documentation and/or other materials provided with the distribution.
53  *
54  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
55  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
56  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
57  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
58  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
59  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
60  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
61  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
62  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
63  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
64  * POSSIBILITY OF SUCH DAMAGE.
65  */
66
67 /*-
68  * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
69  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
70  *
71  * Redistribution and use in source and binary forms, with or without
72  * modification, are permitted provided that the following conditions
73  * are met:
74  * 1. Redistributions of source code must retain the above copyright
75  *    notice, this list of conditions and the following disclaimer.
76  * 2. Redistributions in binary form must reproduce the above copyright
77  *    notice, this list of conditions and the following disclaimer in the
78  *    documentation and/or other materials provided with the distribution.
79  * 3. All advertising materials mentioning features or use of this software
80  *    must display the following acknowledgement:
81  *      This product includes software developed by Christopher G. Demetriou
82  *      for the NetBSD Project.
83  * 4. The name of the author may not be used to endorse or promote products
84  *    derived from this software without specific prior written permission
85  *
86  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
87  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
88  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
89  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
90  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
91  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
92  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
93  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
94  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
95  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
96  */
97
98 /* Modified for Akaros */
99
100 #ifndef ROS_BSD_BUS_H
101 #define ROS_BSD_BUS_H
102
103 typedef uintptr_t bus_addr_t;
104 typedef uintptr_t bus_size_t;
105 typedef uintptr_t bus_space_handle_t;
106 typedef void *bus_dma_tag_t;
107 typedef uintptr_t bus_dmamap_t;
108 typedef uintptr_t bus_dma_segment_t;
109 typedef uintptr_t bus_space_tag_t;
110
111 #define bus_dma_tag_create(...) (0)
112 #define bus_dma_tag_destroy(...)
113 #define bus_dmamap_sync(...)
114 #define bus_dmamap_unload(...)
115
116 /* Bus read/write barrier methods.
117  *
118  *      void bus_space_barrier(bus_space_tag_t tag, bus_space_handle_t bsh,
119  *                             bus_size_t offset, bus_size_t len, int flags);
120  *
121  *
122  * Note that BUS_SPACE_BARRIER_WRITE doesn't do anything other than
123  * prevent reordering by the compiler; all Intel x86 processors currently
124  * retire operations outside the CPU in program order.
125  */
126 #define BUS_SPACE_BARRIER_READ  0x01    /* force read barrier */
127 #define BUS_SPACE_BARRIER_WRITE 0x02    /* force write barrier */
128
129 static inline void bus_space_barrier(bus_space_tag_t tag,
130                                                                          bus_space_handle_t bsh, bus_size_t offset,
131                                                                          bus_size_t len, int flags)
132 {
133         if (flags & BUS_SPACE_BARRIER_READ)
134                 bus_rmb();
135         else
136                 bus_wmb();
137 }
138
139 /*
140  * Values for the x86 bus space tag, not to be used directly by MI code.
141  */
142 #define X86_BUS_SPACE_IO        0       /* space is i/o space */
143 #define X86_BUS_SPACE_MEM       1       /* space is mem space */
144
145 #define BUS_SPACE_MAXSIZE_24BIT 0xFFFFFF
146 #define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFF
147 #define BUS_SPACE_MAXSIZE       0xFFFFFFFF
148 #define BUS_SPACE_MAXADDR_24BIT 0xFFFFFF
149 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
150 #if defined(__amd64__) || defined(PAE)
151 #define BUS_SPACE_MAXADDR       0xFFFFFFFFFFFFFFFFULL
152 #else
153 #define BUS_SPACE_MAXADDR       0xFFFFFFFF
154 #endif
155
156 #define BUS_SPACE_INVALID_DATA  (~0)
157 #define BUS_SPACE_UNRESTRICTED  (~0)
158
159 static inline uint8_t bus_space_read_1(bus_space_tag_t tag,
160                                                                            bus_space_handle_t handle,
161                                                                            bus_size_t offset)
162 {
163         if (tag == X86_BUS_SPACE_IO)
164                 return (inb(handle + offset));
165         return (*(volatile uint8_t *)(handle + offset));
166 }
167
168 static inline uint16_t bus_space_read_2(bus_space_tag_t tag,
169                                                                                 bus_space_handle_t handle,
170                                                                                 bus_size_t offset)
171 {
172         if (tag == X86_BUS_SPACE_IO)
173                 return (inw(handle + offset));
174         return (*(volatile uint16_t *)(handle + offset));
175 }
176
177 static inline uint32_t bus_space_read_4(bus_space_tag_t tag,
178                                                                                 bus_space_handle_t handle,
179                                                                                 bus_size_t offset)
180 {
181         if (tag == X86_BUS_SPACE_IO)
182                 return (inl(handle + offset));
183         return (*(volatile uint32_t *)(handle + offset));
184 }
185
186 static inline void bus_space_write_1(bus_space_tag_t tag,
187                                                                          bus_space_handle_t bsh, bus_size_t offset,
188                                                                          uint8_t value)
189 {
190         if (tag == X86_BUS_SPACE_IO)
191                 outb(bsh + offset, value);
192         else
193                 *(volatile uint8_t *)(bsh + offset) = value;
194 }
195
196 static inline void bus_space_write_2(bus_space_tag_t tag,
197                                                                          bus_space_handle_t bsh, bus_size_t offset,
198                                                                          uint16_t value)
199 {
200         if (tag == X86_BUS_SPACE_IO)
201                 outw(bsh + offset, value);
202         else
203                 *(volatile uint16_t *)(bsh + offset) = value;
204 }
205
206 static inline void bus_space_write_4(bus_space_tag_t tag,
207                                                                          bus_space_handle_t bsh, bus_size_t offset,
208                                                                          uint32_t value)
209 {
210         if (tag == X86_BUS_SPACE_IO)
211                 outl(bsh + offset, value);
212         else
213                 *(volatile uint32_t *)(bsh + offset) = value;
214 }
215
216 #endif /* ROS_BSD_BUS_H */