1 /* $NetBSD: usb_mem.c,v 1.15 1999/10/12 11:24:22 augustss Exp $ */ 2 3 /* 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (augustss@carlstedt.se) at 9 * Carlstedt Research & Technology. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 /* 41 * USB DMA memory allocation. 42 * We need to allocate a lot of small (many 8 byte, some larger) 43 * memory blocks that can be used for DMA. Using the bus_dma 44 * routines directly would incur large overheads in space and time. 45 */ 46 47 #include <sys/param.h> 48 #include <sys/systm.h> 49 #include <sys/kernel.h> 50 #include <sys/malloc.h> 51 #include <sys/queue.h> 52 #include <sys/device.h> /* for usbdivar.h */ 53 #include <machine/bus.h> 54 55 #ifdef DIAGNOSTIC 56 #include <sys/proc.h> 57 #endif 58 59 #include <dev/usb/usb.h> 60 #include <dev/usb/usbdi.h> 61 #include <dev/usb/usbdivar.h> /* just for usb_dma_t */ 62 #include <dev/usb/usb_mem.h> 63 64 #ifdef USB_DEBUG 65 #define DPRINTF(x) if (usbdebug) logprintf x 66 #define DPRINTFN(n,x) if (usbdebug>(n)) logprintf x 67 int usbdebug; 68 #else 69 #define DPRINTF(x) 70 #define DPRINTFN(n,x) 71 #endif 72 73 #define USB_MEM_SMALL 64 74 #define USB_MEM_CHUNKS 64 75 #define USB_MEM_BLOCK (USB_MEM_SMALL * USB_MEM_CHUNKS) 76 77 /* This struct is overlayed on free fragments. */ 78 struct usb_frag_dma { 79 usb_dma_block_t *block; 80 u_int offs; 81 LIST_ENTRY(usb_frag_dma) next; 82 }; 83 84 static usbd_status usb_block_allocmem __P((bus_dma_tag_t, size_t, size_t, 85 usb_dma_block_t **)); 86 static void usb_block_freemem __P((usb_dma_block_t *)); 87 88 LIST_HEAD(, usb_dma_block) usb_blk_freelist = 89 LIST_HEAD_INITIALIZER(usb_blk_freelist); 90 /* XXX should have different free list for different tags (for speed) */ 91 LIST_HEAD(, usb_frag_dma) usb_frag_freelist = 92 LIST_HEAD_INITIALIZER(usb_frag_freelist); 93 94 static usbd_status 95 usb_block_allocmem(tag, size, align, dmap) 96 bus_dma_tag_t tag; 97 size_t size; 98 size_t align; 99 usb_dma_block_t **dmap; 100 { 101 int error; 102 usb_dma_block_t *p; 103 int s; 104 105 DPRINTFN(5, ("usb_block_allocmem: size=%d align=%d\n", size, align)); 106 107 #ifdef DIAGNOSTIC 108 if (!curproc) { 109 printf("usb_block_allocmem: in interrupt context, size=%lu\n", 110 (unsigned long) size); 111 } 112 #endif 113 114 s = splusb(); 115 /* First check the free list. */ 116 for (p = LIST_FIRST(&usb_blk_freelist); p; p = LIST_NEXT(p, next)) { 117 if (p->tag == tag && p->size >= size && p->align >= align) { 118 LIST_REMOVE(p, next); 119 splx(s); 120 *dmap = p; 121 DPRINTFN(6,("usb_block_allocmem: free list size=%d\n", 122 p->size)); 123 return (USBD_NORMAL_COMPLETION); 124 } 125 } 126 splx(s); 127 128 #ifdef DIAGNOSTIC 129 if (!curproc) { 130 printf("usb_block_allocmem: in interrupt context, failed\n"); 131 return (USBD_NOMEM); 132 } 133 #endif 134 135 DPRINTFN(6, ("usb_block_allocmem: no free\n")); 136 p = malloc(sizeof *p, M_USB, M_NOWAIT); 137 if (p == 0) 138 return (USBD_NOMEM); 139 *dmap = p; 140 141 p->tag = tag; 142 p->size = size; 143 p->align = align; 144 error = bus_dmamem_alloc(tag, p->size, align, 0, 145 p->segs, sizeof(p->segs)/sizeof(p->segs[0]), 146 &p->nsegs, BUS_DMA_NOWAIT); 147 if (error) 148 return (USBD_NOMEM); 149 150 error = bus_dmamem_map(tag, p->segs, p->nsegs, p->size, 151 &p->kaddr, BUS_DMA_NOWAIT|BUS_DMA_COHERENT); 152 if (error) 153 goto free; 154 155 error = bus_dmamap_create(tag, p->size, 1, p->size, 156 0, BUS_DMA_NOWAIT, &p->map); 157 if (error) 158 goto unmap; 159 160 error = bus_dmamap_load(tag, p->map, p->kaddr, p->size, NULL, 161 BUS_DMA_NOWAIT); 162 if (error) 163 goto destroy; 164 return 0; 165 166 destroy: 167 bus_dmamap_destroy(tag, p->map); 168 unmap: 169 bus_dmamem_unmap(tag, p->kaddr, p->size); 170 free: 171 bus_dmamem_free(tag, p->segs, p->nsegs); 172 return (USBD_NOMEM); 173 } 174 175 #if 0 176 void 177 usb_block_real_freemem(p) 178 usb_dma_block_t *p; 179 { 180 #ifdef DIAGNOSTIC 181 if (!curproc) { 182 printf("usb_block_real_freemem: in interrupt context\n"); 183 return; 184 } 185 #endif 186 bus_dmamap_unload(p->tag, p->map); 187 bus_dmamap_destroy(p->tag, p->map); 188 bus_dmamem_unmap(p->tag, p->kaddr, p->size); 189 bus_dmamem_free(p->tag, p->segs, p->nsegs); 190 free(p, M_USB); 191 } 192 #endif 193 194 /* 195 * Do not free the memory unconditionally since we might be called 196 * from an interrupt context and that is BAD. 197 * XXX when should we really free? 198 */ 199 static void 200 usb_block_freemem(p) 201 usb_dma_block_t *p; 202 { 203 int s; 204 205 DPRINTFN(6, ("usb_block_freemem: size=%d\n", p->size)); 206 s = splusb(); 207 LIST_INSERT_HEAD(&usb_blk_freelist, p, next); 208 splx(s); 209 } 210 211 usbd_status 212 usb_allocmem(bus, size, align, p) 213 usbd_bus_handle bus; 214 size_t size; 215 size_t align; 216 usb_dma_t *p; 217 { 218 bus_dma_tag_t tag = bus->dmatag; 219 usbd_status r; 220 struct usb_frag_dma *f; 221 usb_dma_block_t *b; 222 int i; 223 int s; 224 225 /* If the request is large then just use a full block. */ 226 if (size > USB_MEM_SMALL || align > USB_MEM_SMALL) { 227 DPRINTFN(1, ("usb_allocmem: large alloc %d\n", (int)size)); 228 size = (size + USB_MEM_BLOCK - 1) & ~(USB_MEM_BLOCK - 1); 229 r = usb_block_allocmem(tag, size, align, &p->block); 230 if (r == USBD_NORMAL_COMPLETION) { 231 p->block->fullblock = 1; 232 p->offs = 0; 233 } 234 return (r); 235 } 236 237 s = splusb(); 238 /* Check for free fragments. */ 239 for (f = LIST_FIRST(&usb_frag_freelist); f; f = LIST_NEXT(f, next)) 240 if (f->block->tag == tag) 241 break; 242 if (!f) { 243 DPRINTFN(1, ("usb_allocmem: adding fragments\n")); 244 r = usb_block_allocmem(tag, USB_MEM_BLOCK, USB_MEM_SMALL, &b); 245 if (r != USBD_NORMAL_COMPLETION) { 246 splx(s); 247 return (r); 248 } 249 b->fullblock = 0; 250 for (i = 0; i < USB_MEM_BLOCK; i += USB_MEM_SMALL) { 251 f = (struct usb_frag_dma *)(b->kaddr + i); 252 f->block = b; 253 f->offs = i; 254 LIST_INSERT_HEAD(&usb_frag_freelist, f, next); 255 } 256 f = LIST_FIRST(&usb_frag_freelist); 257 } 258 p->block = f->block; 259 p->offs = f->offs; 260 LIST_REMOVE(f, next); 261 splx(s); 262 DPRINTFN(5, ("usb_allocmem: use frag=%p size=%d\n", f, (int)size)); 263 return (USBD_NORMAL_COMPLETION); 264 } 265 266 void 267 usb_freemem(bus, p) 268 usbd_bus_handle bus; 269 usb_dma_t *p; 270 { 271 struct usb_frag_dma *f; 272 int s; 273 274 if (p->block->fullblock) { 275 DPRINTFN(1, ("usb_freemem: large free\n")); 276 usb_block_freemem(p->block); 277 return; 278 } 279 f = KERNADDR(p); 280 f->block = p->block; 281 f->offs = p->offs; 282 s = splusb(); 283 LIST_INSERT_HEAD(&usb_frag_freelist, f, next); 284 splx(s); 285 DPRINTFN(5, ("usb_freemem: frag=%p\n", f)); 286 } 287