1 /* $NetBSD: usb_mem.c,v 1.24 2002/07/11 21:14:34 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 (lennart@augustsson.net) 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/cdefs.h> 48 __KERNEL_RCSID(0, "$NetBSD: usb_mem.c,v 1.24 2002/07/11 21:14:34 augustss Exp $"); 49 50 #include <sys/param.h> 51 #include <sys/systm.h> 52 #include <sys/kernel.h> 53 #include <sys/malloc.h> 54 #include <sys/queue.h> 55 #include <sys/device.h> /* for usbdivar.h */ 56 #include <machine/bus.h> 57 58 #ifdef DIAGNOSTIC 59 #include <sys/proc.h> 60 #endif 61 62 #include <dev/usb/usb.h> 63 #include <dev/usb/usbdi.h> 64 #include <dev/usb/usbdivar.h> /* just for usb_dma_t */ 65 #include <dev/usb/usb_mem.h> 66 67 #ifdef USB_DEBUG 68 #define DPRINTF(x) if (usbdebug) logprintf x 69 #define DPRINTFN(n,x) if (usbdebug>(n)) logprintf x 70 int usbdebug; 71 #else 72 #define DPRINTF(x) 73 #define DPRINTFN(n,x) 74 #endif 75 76 #define USB_MEM_SMALL 64 77 #define USB_MEM_CHUNKS 64 78 #define USB_MEM_BLOCK (USB_MEM_SMALL * USB_MEM_CHUNKS) 79 80 /* This struct is overlayed on free fragments. */ 81 struct usb_frag_dma { 82 usb_dma_block_t *block; 83 u_int offs; 84 LIST_ENTRY(usb_frag_dma) next; 85 }; 86 87 Static usbd_status usb_block_allocmem(bus_dma_tag_t, size_t, size_t, 88 usb_dma_block_t **); 89 Static void usb_block_freemem(usb_dma_block_t *); 90 91 Static LIST_HEAD(, usb_dma_block) usb_blk_freelist = 92 LIST_HEAD_INITIALIZER(usb_blk_freelist); 93 Static int usb_blk_nfree = 0; 94 /* XXX should have different free list for different tags (for speed) */ 95 Static LIST_HEAD(, usb_frag_dma) usb_frag_freelist = 96 LIST_HEAD_INITIALIZER(usb_frag_freelist); 97 98 Static usbd_status 99 usb_block_allocmem(bus_dma_tag_t tag, size_t size, size_t align, 100 usb_dma_block_t **dmap) 101 { 102 int error; 103 usb_dma_block_t *p; 104 int s; 105 106 DPRINTFN(5, ("usb_block_allocmem: size=%lu align=%lu\n", 107 (u_long)size, (u_long)align)); 108 109 #ifdef DIAGNOSTIC 110 if (!curproc) { 111 printf("usb_block_allocmem: in interrupt context, size=%lu\n", 112 (unsigned long) size); 113 } 114 #endif 115 116 s = splusb(); 117 /* First check the free list. */ 118 for (p = LIST_FIRST(&usb_blk_freelist); p; p = LIST_NEXT(p, next)) { 119 if (p->tag == tag && p->size >= size && p->align >= align) { 120 LIST_REMOVE(p, next); 121 usb_blk_nfree--; 122 splx(s); 123 *dmap = p; 124 DPRINTFN(6,("usb_block_allocmem: free list size=%lu\n", 125 (u_long)p->size)); 126 return (USBD_NORMAL_COMPLETION); 127 } 128 } 129 splx(s); 130 131 #ifdef DIAGNOSTIC 132 if (!curproc) { 133 printf("usb_block_allocmem: in interrupt context, failed\n"); 134 return (USBD_NOMEM); 135 } 136 #endif 137 138 DPRINTFN(6, ("usb_block_allocmem: no free\n")); 139 p = malloc(sizeof *p, M_USB, M_NOWAIT); 140 if (p == NULL) 141 return (USBD_NOMEM); 142 *dmap = p; 143 144 p->tag = tag; 145 p->size = size; 146 p->align = align; 147 error = bus_dmamem_alloc(tag, p->size, align, 0, 148 p->segs, sizeof(p->segs)/sizeof(p->segs[0]), 149 &p->nsegs, BUS_DMA_NOWAIT); 150 if (error) 151 return (USBD_NOMEM); 152 153 error = bus_dmamem_map(tag, p->segs, p->nsegs, p->size, 154 &p->kaddr, BUS_DMA_NOWAIT|BUS_DMA_COHERENT); 155 if (error) 156 goto free; 157 158 error = bus_dmamap_create(tag, p->size, 1, p->size, 159 0, BUS_DMA_NOWAIT, &p->map); 160 if (error) 161 goto unmap; 162 163 error = bus_dmamap_load(tag, p->map, p->kaddr, p->size, NULL, 164 BUS_DMA_NOWAIT); 165 if (error) 166 goto destroy; 167 return (USBD_NORMAL_COMPLETION); 168 169 destroy: 170 bus_dmamap_destroy(tag, p->map); 171 unmap: 172 bus_dmamem_unmap(tag, p->kaddr, p->size); 173 free: 174 bus_dmamem_free(tag, p->segs, p->nsegs); 175 return (USBD_NOMEM); 176 } 177 178 #if 0 179 void 180 usb_block_real_freemem(usb_dma_block_t *p) 181 { 182 #ifdef DIAGNOSTIC 183 if (!curproc) { 184 printf("usb_block_real_freemem: in interrupt context\n"); 185 return; 186 } 187 #endif 188 bus_dmamap_unload(p->tag, p->map); 189 bus_dmamap_destroy(p->tag, p->map); 190 bus_dmamem_unmap(p->tag, p->kaddr, p->size); 191 bus_dmamem_free(p->tag, p->segs, p->nsegs); 192 free(p, M_USB); 193 } 194 #endif 195 196 /* 197 * Do not free the memory unconditionally since we might be called 198 * from an interrupt context and that is BAD. 199 * XXX when should we really free? 200 */ 201 Static void 202 usb_block_freemem(usb_dma_block_t *p) 203 { 204 int s; 205 206 DPRINTFN(6, ("usb_block_freemem: size=%lu\n", (u_long)p->size)); 207 s = splusb(); 208 LIST_INSERT_HEAD(&usb_blk_freelist, p, next); 209 usb_blk_nfree++; 210 splx(s); 211 } 212 213 usbd_status 214 usb_allocmem(usbd_bus_handle bus, size_t size, size_t align, usb_dma_t *p) 215 { 216 bus_dma_tag_t tag = bus->dmatag; 217 usbd_status err; 218 struct usb_frag_dma *f; 219 usb_dma_block_t *b; 220 int i; 221 int s; 222 223 /* If the request is large then just use a full block. */ 224 if (size > USB_MEM_SMALL || align > USB_MEM_SMALL) { 225 DPRINTFN(1, ("usb_allocmem: large alloc %d\n", (int)size)); 226 size = (size + USB_MEM_BLOCK - 1) & ~(USB_MEM_BLOCK - 1); 227 err = usb_block_allocmem(tag, size, align, &p->block); 228 if (!err) { 229 p->block->fullblock = 1; 230 p->offs = 0; 231 } 232 return (err); 233 } 234 235 s = splusb(); 236 /* Check for free fragments. */ 237 for (f = LIST_FIRST(&usb_frag_freelist); f; f = LIST_NEXT(f, next)) 238 if (f->block->tag == tag) 239 break; 240 if (f == NULL) { 241 DPRINTFN(1, ("usb_allocmem: adding fragments\n")); 242 err = usb_block_allocmem(tag, USB_MEM_BLOCK, USB_MEM_SMALL,&b); 243 if (err) { 244 splx(s); 245 return (err); 246 } 247 b->fullblock = 0; 248 for (i = 0; i < USB_MEM_BLOCK; i += USB_MEM_SMALL) { 249 f = (struct usb_frag_dma *)(b->kaddr + i); 250 f->block = b; 251 f->offs = i; 252 LIST_INSERT_HEAD(&usb_frag_freelist, f, next); 253 } 254 f = LIST_FIRST(&usb_frag_freelist); 255 } 256 p->block = f->block; 257 p->offs = f->offs; 258 LIST_REMOVE(f, next); 259 splx(s); 260 DPRINTFN(5, ("usb_allocmem: use frag=%p size=%d\n", f, (int)size)); 261 return (USBD_NORMAL_COMPLETION); 262 } 263 264 void 265 usb_freemem(usbd_bus_handle bus, usb_dma_t *p) 266 { 267 struct usb_frag_dma *f; 268 int s; 269 270 if (p->block->fullblock) { 271 DPRINTFN(1, ("usb_freemem: large free\n")); 272 usb_block_freemem(p->block); 273 return; 274 } 275 f = KERNADDR(p, 0); 276 f->block = p->block; 277 f->offs = p->offs; 278 s = splusb(); 279 LIST_INSERT_HEAD(&usb_frag_freelist, f, next); 280 splx(s); 281 DPRINTFN(5, ("usb_freemem: frag=%p\n", f)); 282 } 283