1 /*	$OpenBSD: rbus.c,v 1.8 2004/07/09 19:12:40 brad Exp $ */
2 /*	$NetBSD: rbus.c,v 1.3 1999/11/06 06:20:53 soren Exp $	*/
3 /*
4  * Copyright (c) 1999
5  *     HAYAKAWA Koichi.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
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  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by HAYAKAWA Koichi.
18  * 4. 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 
33 
34 
35 #include <sys/types.h>
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/device.h>
39 #include <sys/malloc.h>
40 #include <sys/extent.h>
41 
42 #include <machine/bus.h>
43 
44 #include <dev/cardbus/rbus.h>
45 
46 /* #define RBUS_DEBUG */
47 
48 #if defined RBUS_DEBUG
49 #define STATIC
50 #define DPRINTF(a) printf a
51 #define DDELAY(x) delay((x)*1000*1000)
52 #else
53 #define STATIC static
54 #define DPRINTF(a)
55 #endif
56 
57 
58 
59 static rbus_tag_t rbus_new_body(bus_space_tag_t bt, rbus_tag_t parent,
60 				    struct extent *ex, bus_addr_t start,
61 				    bus_addr_t end, bus_addr_t offset,
62 				    int flags);
63 
64 
65 int
rbus_space_alloc(rbt,addr,size,mask,align,flags,addrp,bshp)66 rbus_space_alloc(rbt, addr, size, mask, align, flags, addrp, bshp)
67      rbus_tag_t rbt;
68      bus_addr_t addr;
69      bus_size_t size;
70      bus_addr_t mask, align;
71      int flags;
72      bus_addr_t *addrp;
73      bus_space_handle_t *bshp;
74 {
75   return rbus_space_alloc_subregion(rbt, rbt->rb_start, rbt->rb_end, addr,
76 				    size, mask, align, flags, addrp, bshp);
77 }
78 
79 
80 
81 
82 int
rbus_space_alloc_subregion(rbt,substart,subend,addr,size,mask,align,flags,addrp,bshp)83 rbus_space_alloc_subregion(rbt, substart, subend, addr, size, mask, align, flags, addrp, bshp)
84      rbus_tag_t rbt;
85      bus_addr_t addr;
86      bus_addr_t substart;
87      bus_addr_t subend;
88      bus_size_t size;
89      bus_addr_t mask, align;
90      int flags;
91      bus_addr_t *addrp;
92      bus_space_handle_t *bshp;
93 {
94   bus_addr_t decodesize = mask + 1;
95   bus_addr_t boundary, search_addr;
96   int val;
97   u_long result;
98   int exflags = EX_FAST | EX_NOWAIT | EX_MALLOCOK;
99 
100   DPRINTF(("rbus_space_alloc: addr %lx, size %lx, mask %lx, align %lx\n",
101 	   (u_long)addr, (u_long)size, (u_long)mask, (u_long)align));
102 
103   addr += rbt->rb_offset;
104 
105   if (mask == 0) {
106     /* FULL Decode */
107     decodesize = 0;
108   }
109 
110   if (rbt->rb_flags == RBUS_SPACE_ASK_PARENT) {
111     return rbus_space_alloc(rbt->rb_parent, addr, size, mask, align, flags,
112 			    addrp, bshp);
113   } else if (rbt->rb_flags == RBUS_SPACE_SHARE ||
114 	     rbt->rb_flags == RBUS_SPACE_DEDICATE) {
115     /* rbt has its own sh_extent */
116 
117     /* sanity check: the subregion [substart, subend] should be
118        smaller than the region included in sh_extent */
119     if (substart < rbt->rb_ext->ex_start || subend > rbt->rb_ext->ex_end) {
120       DPRINTF(("rbus: out of range\n"));
121       return 1;
122     }
123 
124     if (decodesize == align) {
125       if(extent_alloc_subregion(rbt->rb_ext, substart, subend, size, align, 0,
126 				0, exflags, &result)) {
127 	return 1;
128       }
129     } else if (decodesize == 0) {
130       /* maybe, the register is overflowed. */
131 
132       if (extent_alloc_subregion(rbt->rb_ext, addr, addr + size, size,
133 				 1, 0, 0, exflags, &result)) {
134 	return 1;
135       }
136     } else {
137 
138       boundary = decodesize > align ? decodesize : align;
139 
140       search_addr = (substart & ~(boundary - 1)) + addr;
141 
142       if (search_addr < substart) {
143 	search_addr += boundary;
144       }
145 
146       val = 1;
147       for (; search_addr + size <= subend; search_addr += boundary) {
148 	val = extent_alloc_subregion(rbt->rb_ext,search_addr, search_addr+size,
149 				size, align, 0, 0, exflags, &result);
150         DPRINTF(("rbus: trying [%lx:%lx] %lx\n",
151 	    (u_long)search_addr,
152 	    (u_long)search_addr+size, (u_long)align));
153 	if (val == 0) {
154 	  break;
155 	}
156       }
157       if (val != 0) {
158         /* no space found */
159         DPRINTF(("rbus: no space found\n"));
160 	return 1;
161       }
162     }
163 
164     if(md_space_map(rbt->rb_bt, result, size, flags, bshp)) {
165       /* map failed */
166       extent_free(rbt->rb_ext, result, size, exflags);
167       return 1;
168     }
169 
170     if (addrp != NULL) {
171       *addrp = result + rbt->rb_offset;
172     }
173     return 0;
174   } else {
175     /* error!! */
176     DPRINTF(("rbus: no rbus type\n"));
177     return 1;
178   }
179 }
180 
181 
182 
183 
184 
185 int
rbus_space_free(rbt,bsh,size,addrp)186 rbus_space_free(rbt, bsh, size, addrp)
187      rbus_tag_t rbt;
188      bus_space_handle_t bsh;
189      bus_size_t size;
190      bus_addr_t *addrp;
191 {
192   int exflags = EX_FAST | EX_NOWAIT;
193   bus_addr_t addr;
194   int status = 1;
195 
196   if (rbt->rb_flags == RBUS_SPACE_ASK_PARENT) {
197     status = rbus_space_free(rbt->rb_parent, bsh, size, &addr);
198   } else if (rbt->rb_flags == RBUS_SPACE_SHARE ||
199 	     rbt->rb_flags == RBUS_SPACE_DEDICATE) {
200     md_space_unmap(rbt->rb_bt, bsh, size, &addr);
201 
202     extent_free(rbt->rb_ext, addr, size, exflags);
203 
204     status = 0;
205   } else {
206     /* error. INVALID rbustag */
207     status = 1;
208   }
209   if (addrp != NULL) {
210     *addrp = addr;
211   }
212   return status;
213 }
214 
215 
216 
217 /*
218  * static rbus_tag_t
219  * rbus_new_body(bus_space_tag_t bt, rbus_tag_t parent,
220  *               struct extent *ex, bus_addr_t start, bus_size_t end,
221  *               bus_addr_t offset, int flags)
222  *
223  */
224 static rbus_tag_t
rbus_new_body(bt,parent,ex,start,end,offset,flags)225 rbus_new_body(bt, parent, ex, start, end, offset, flags)
226      bus_space_tag_t bt;
227      rbus_tag_t parent;
228      struct extent *ex;
229      bus_addr_t start, end, offset;
230      int flags;
231 {
232   rbus_tag_t rb;
233 
234   /* sanity check */
235   if (parent != NULL) {
236     if (start < parent->rb_start || end > parent->rb_end) {
237       /* out of range: [start, size] should be contained in parent space */
238       return 0;
239       /* Should I invoke panic? */
240     }
241   }
242 
243   if (NULL == (rb = (rbus_tag_t)malloc(sizeof(struct rbustag), M_DEVBUF,
244 					 M_NOWAIT))) {
245     panic("no memory for rbus instance");
246   }
247 
248   rb->rb_bt = bt;
249   rb->rb_parent = parent;
250   rb->rb_start = start;
251   rb->rb_end = end;
252   rb->rb_offset = offset;
253   rb->rb_flags = flags;
254   rb->rb_ext = ex;
255 
256   DPRINTF(("rbus_new_body: [%lx, %lx] type %s name [%s]\n",
257 	   (u_long)start, (u_long)end,
258 	   flags == RBUS_SPACE_SHARE ? "share" :
259 	   flags == RBUS_SPACE_DEDICATE ? "dedicated" :
260 	   flags == RBUS_SPACE_ASK_PARENT ? "parent" : "invalid",
261 	   ex != NULL ? ex->ex_name : "noname"));
262 
263   return rb;
264 }
265 
266 
267 
268 /*
269  * rbus_tag_t rbus_new(rbus_tag_t parent, bus_addr_t start, bus_size_t
270  *                     size, bus_addr_t offset, int flags)
271  *
272  *  This function makes a new child rbus instance.
273  */
274 rbus_tag_t
rbus_new(parent,start,size,offset,flags)275 rbus_new(parent, start, size, offset, flags)
276      rbus_tag_t parent;
277      bus_addr_t start;
278      bus_size_t size;
279      bus_addr_t offset;
280      int flags;
281 {
282   rbus_tag_t rb;
283   struct extent *ex = NULL;
284   bus_addr_t end = start + size;
285 
286   if (flags == RBUS_SPACE_SHARE) {
287     ex = parent->rb_ext;
288   } else if (flags == RBUS_SPACE_DEDICATE) {
289     if (NULL == (ex = extent_create("rbus", start, end, M_DEVBUF, NULL, 0,
290 				    EX_NOCOALESCE|EX_NOWAIT))) {
291       return NULL;
292     }
293   } else if (flags == RBUS_SPACE_ASK_PARENT) {
294     ex = NULL;
295   } else {
296     /* Invalid flag */
297     return 0;
298   }
299 
300   rb = rbus_new_body(parent->rb_bt, parent, ex, start, start + size,
301 		     offset, flags);
302 
303   if ((rb == NULL) && (flags == RBUS_SPACE_DEDICATE)) {
304     extent_destroy(ex);
305   }
306 
307   return rb;
308 }
309 
310 
311 
312 
313 /*
314  * rbus_tag_t rbus_new_root_delegate(bus_space_tag, bus_addr_t,
315  *                                   bus_size_t, bus_addr_t offset)
316  *
317  *  This function makes a root rbus instance.
318  */
319 rbus_tag_t
rbus_new_root_delegate(bt,start,size,offset)320 rbus_new_root_delegate(bt, start, size, offset)
321      bus_space_tag_t bt;
322      bus_addr_t start;
323      bus_size_t size;
324      bus_addr_t offset;
325 {
326   rbus_tag_t rb;
327   struct extent *ex;
328 
329   if (NULL == (ex = extent_create("rbus root", start, start + size, M_DEVBUF,
330 				  NULL, 0, EX_NOCOALESCE|EX_NOWAIT))) {
331     return NULL;
332   }
333 
334   rb = rbus_new_body(bt, NULL, ex, start, start + size, offset,
335 		     RBUS_SPACE_DEDICATE);
336 
337   if (rb == NULL) {
338     extent_destroy(ex);
339   }
340 
341   return rb;
342 }
343 
344 
345 
346 /*
347  * rbus_tag_t rbus_new_root_share(bus_space_tag, struct extent *,
348  *                                 bus_addr_t, bus_size_t, bus_addr_t offset)
349  *
350  *  This function makes a root rbus instance.
351  */
352 rbus_tag_t
rbus_new_root_share(bt,ex,start,size,offset)353 rbus_new_root_share(bt, ex, start, size, offset)
354      bus_space_tag_t bt;
355      struct extent *ex;
356      bus_addr_t start;
357      bus_size_t size;
358      bus_addr_t offset;
359 {
360   /* sanity check */
361   if (start < ex->ex_start || start + size > ex->ex_end) {
362     /* out of range: [start, size] should be contained in parent space */
363     return 0;
364     /* Should I invoke panic? */
365   }
366 
367   return rbus_new_body(bt, NULL, ex, start, start + size, offset,
368 		       RBUS_SPACE_SHARE);
369 }
370 
371 
372 
373 
374 
375 /*
376  * int rbus_delete (rbus_tag_t rb)
377  *
378  *   This function deletes the rbus structure pointed in the argument.
379  */
380 int
rbus_delete(rb)381 rbus_delete(rb)
382      rbus_tag_t rb;
383 {
384   DPRINTF(("rbus_delete called [%s]\n",
385 	   rb->rb_ext != NULL ? rb->rb_ext->ex_name : "noname"));
386   if (rb->rb_flags == RBUS_SPACE_DEDICATE) {
387     extent_destroy(rb->rb_ext);
388   }
389 
390   free(rb, M_DEVBUF);
391 
392   return 0;
393 }
394