1 /* $NetBSD: usb_mem.c,v 1.80 2021/01/05 18:00:21 skrll 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 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE 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 /* 34 * USB DMA memory allocation. 35 * We need to allocate a lot of small (many 8 byte, some larger) 36 * memory blocks that can be used for DMA. Using the bus_dma 37 * routines directly would incur large overheads in space and time. 38 */ 39 40 #include <sys/cdefs.h> 41 __KERNEL_RCSID(0, "$NetBSD: usb_mem.c,v 1.80 2021/01/05 18:00:21 skrll Exp $"); 42 43 #ifdef _KERNEL_OPT 44 #include "opt_usb.h" 45 #endif 46 47 #include <sys/param.h> 48 #include <sys/bus.h> 49 #include <sys/cpu.h> 50 #include <sys/device.h> /* for usbdivar.h */ 51 #include <sys/kernel.h> 52 #include <sys/kmem.h> 53 #include <sys/once.h> 54 #include <sys/queue.h> 55 #include <sys/systm.h> 56 57 #include <dev/usb/usb.h> 58 #include <dev/usb/usbdi.h> 59 #include <dev/usb/usbdivar.h> /* just for usb_dma_t */ 60 #include <dev/usb/usbhist.h> 61 #include <dev/usb/usb_mem.h> 62 63 #define DPRINTF(FMT,A,B,C,D) USBHIST_LOG(usbdebug,FMT,A,B,C,D) 64 #define DPRINTFN(N,FMT,A,B,C,D) USBHIST_LOGN(usbdebug,N,FMT,A,B,C,D) 65 66 #define USB_MEM_SMALL roundup(64, CACHE_LINE_SIZE) 67 #define USB_MEM_CHUNKS 64 68 #define USB_MEM_BLOCK (USB_MEM_SMALL * USB_MEM_CHUNKS) 69 70 /* This struct is overlayed on free fragments. */ 71 struct usb_frag_dma { 72 usb_dma_block_t *ufd_block; 73 u_int ufd_offs; 74 LIST_ENTRY(usb_frag_dma) ufd_next; 75 }; 76 77 Static int usb_block_allocmem(bus_dma_tag_t, size_t, size_t, 78 u_int, usb_dma_block_t **); 79 Static void usb_block_freemem(usb_dma_block_t *); 80 81 LIST_HEAD(usb_dma_block_qh, usb_dma_block); 82 Static struct usb_dma_block_qh usb_blk_freelist = 83 LIST_HEAD_INITIALIZER(usb_blk_freelist); 84 kmutex_t usb_blk_lock; 85 86 #ifdef DEBUG 87 Static struct usb_dma_block_qh usb_blk_fraglist = 88 LIST_HEAD_INITIALIZER(usb_blk_fraglist); 89 Static struct usb_dma_block_qh usb_blk_fulllist = 90 LIST_HEAD_INITIALIZER(usb_blk_fulllist); 91 #endif 92 Static u_int usb_blk_nfree = 0; 93 /* XXX should have different free list for different tags (for speed) */ 94 Static LIST_HEAD(, usb_frag_dma) usb_frag_freelist = 95 LIST_HEAD_INITIALIZER(usb_frag_freelist); 96 97 Static int usb_mem_init(void); 98 99 Static int 100 usb_mem_init(void) 101 { 102 103 mutex_init(&usb_blk_lock, MUTEX_DEFAULT, IPL_NONE); 104 return 0; 105 } 106 107 Static int 108 usb_block_allocmem(bus_dma_tag_t tag, size_t size, size_t align, 109 u_int flags, usb_dma_block_t **dmap) 110 { 111 usb_dma_block_t *b; 112 int error; 113 114 USBHIST_FUNC(); 115 USBHIST_CALLARGS(usbdebug, "size=%ju align=%ju flags=%#jx", size, align, flags, 0); 116 117 ASSERT_SLEEPABLE(); 118 KASSERT(size != 0); 119 KASSERT(mutex_owned(&usb_blk_lock)); 120 121 bool multiseg = (flags & USBMALLOC_MULTISEG) != 0; 122 bool coherent = (flags & USBMALLOC_COHERENT) != 0; 123 u_int dmaflags = coherent ? USB_DMA_COHERENT : 0; 124 125 /* First check the free list. */ 126 LIST_FOREACH(b, &usb_blk_freelist, next) { 127 /* Don't allocate multiple segments to unwilling callers */ 128 if (b->nsegs != 1 && !multiseg) 129 continue; 130 if (b->tag == tag && 131 b->size >= size && 132 b->align >= align && 133 (b->flags & USB_DMA_COHERENT) == dmaflags) { 134 LIST_REMOVE(b, next); 135 usb_blk_nfree--; 136 *dmap = b; 137 DPRINTFN(6, "free list size=%ju", b->size, 0, 0, 0); 138 return 0; 139 } 140 } 141 142 DPRINTFN(6, "no freelist entry", 0, 0, 0, 0); 143 mutex_exit(&usb_blk_lock); 144 145 b = kmem_zalloc(sizeof(*b), KM_SLEEP); 146 b->tag = tag; 147 b->size = size; 148 b->align = align; 149 b->flags = dmaflags; 150 151 if (!multiseg) 152 /* Caller wants one segment */ 153 b->nsegs = 1; 154 else 155 b->nsegs = howmany(size, PAGE_SIZE); 156 157 b->segs = kmem_alloc(b->nsegs * sizeof(*b->segs), KM_SLEEP); 158 b->nsegs_alloc = b->nsegs; 159 160 error = bus_dmamem_alloc(tag, b->size, align, 0, 161 b->segs, b->nsegs, 162 &b->nsegs, BUS_DMA_WAITOK); 163 if (error) 164 goto free0; 165 166 error = bus_dmamem_map(tag, b->segs, b->nsegs, b->size, &b->kaddr, 167 BUS_DMA_WAITOK | (coherent ? BUS_DMA_COHERENT : 0)); 168 if (error) 169 goto free1; 170 171 error = bus_dmamap_create(tag, b->size, b->nsegs, b->size, 172 0, BUS_DMA_WAITOK, &b->map); 173 if (error) 174 goto unmap; 175 176 error = bus_dmamap_load(tag, b->map, b->kaddr, b->size, NULL, 177 BUS_DMA_WAITOK); 178 if (error) 179 goto destroy; 180 181 *dmap = b; 182 183 #ifdef USB_FRAG_DMA_WORKAROUND 184 flags |= USBMALLOC_ZERO; 185 #endif 186 if ((flags & USBMALLOC_ZERO) != 0) { 187 memset(b->kaddr, 0, b->size); 188 bus_dmamap_sync(b->tag, b->map, 0, b->size, 189 BUS_DMASYNC_PREWRITE); 190 } 191 192 mutex_enter(&usb_blk_lock); 193 194 return 0; 195 196 destroy: 197 bus_dmamap_destroy(tag, b->map); 198 unmap: 199 bus_dmamem_unmap(tag, b->kaddr, b->size); 200 free1: 201 bus_dmamem_free(tag, b->segs, b->nsegs); 202 free0: 203 kmem_free(b->segs, b->nsegs_alloc * sizeof(*b->segs)); 204 kmem_free(b, sizeof(*b)); 205 mutex_enter(&usb_blk_lock); 206 207 return USBD_NOMEM; 208 } 209 210 #if 0 211 void 212 usb_block_real_freemem(usb_dma_block_t *b) 213 { 214 ASSERT_SLEEPABLE(); 215 216 bus_dmamap_unload(b->tag, b->map); 217 bus_dmamap_destroy(b->tag, b->map); 218 bus_dmamem_unmap(b->tag, b->kaddr, b->size); 219 bus_dmamem_free(b->tag, b->segs, b->nsegs); 220 kmem_free(b->segs, b->nsegs_alloc * sizeof(*b->segs)); 221 kmem_free(b, sizeof(*b)); 222 } 223 #endif 224 225 #ifdef DEBUG 226 static bool 227 usb_valid_block_p(usb_dma_block_t *b, struct usb_dma_block_qh *qh) 228 { 229 usb_dma_block_t *xb; 230 LIST_FOREACH(xb, qh, next) { 231 if (xb == b) 232 return true; 233 } 234 return false; 235 } 236 #endif 237 238 /* 239 * Do not free the memory unconditionally since we might be called 240 * from an interrupt context and that is BAD. 241 * XXX when should we really free? 242 */ 243 Static void 244 usb_block_freemem(usb_dma_block_t *b) 245 { 246 USBHIST_FUNC(); 247 USBHIST_CALLARGS(usbdebug, "size=%ju", b->size, 0, 0, 0); 248 249 KASSERT(mutex_owned(&usb_blk_lock)); 250 251 #ifdef DEBUG 252 LIST_REMOVE(b, next); 253 #endif 254 LIST_INSERT_HEAD(&usb_blk_freelist, b, next); 255 usb_blk_nfree++; 256 } 257 258 int 259 usb_allocmem(struct usbd_bus *bus, size_t size, size_t align, u_int flags, 260 usb_dma_t *p) 261 { 262 bus_dma_tag_t tag = bus->ub_dmatag; 263 usbd_status err; 264 struct usb_frag_dma *f; 265 usb_dma_block_t *b; 266 int i; 267 static ONCE_DECL(init_control); 268 269 USBHIST_FUNC(); USBHIST_CALLED(usbdebug); 270 271 ASSERT_SLEEPABLE(); 272 273 RUN_ONCE(&init_control, usb_mem_init); 274 275 u_int dmaflags = (flags & USBMALLOC_COHERENT) ? USB_DMA_COHERENT : 0; 276 277 /* If the request is large then just use a full block. */ 278 if (size > USB_MEM_SMALL || align > USB_MEM_SMALL) { 279 DPRINTFN(1, "large alloc %jd", size, 0, 0, 0); 280 size = (size + USB_MEM_BLOCK - 1) & ~(USB_MEM_BLOCK - 1); 281 mutex_enter(&usb_blk_lock); 282 err = usb_block_allocmem(tag, size, align, flags, 283 &p->udma_block); 284 if (!err) { 285 #ifdef DEBUG 286 LIST_INSERT_HEAD(&usb_blk_fulllist, p->udma_block, next); 287 #endif 288 p->udma_block->flags = USB_DMA_FULLBLOCK | dmaflags; 289 p->udma_offs = 0; 290 } 291 mutex_exit(&usb_blk_lock); 292 return err; 293 } 294 295 mutex_enter(&usb_blk_lock); 296 /* Check for free fragments. */ 297 LIST_FOREACH(f, &usb_frag_freelist, ufd_next) { 298 KDASSERTMSG(usb_valid_block_p(f->ufd_block, &usb_blk_fraglist), 299 "%s: usb frag %p: unknown block pointer %p", 300 __func__, f, f->ufd_block); 301 if (f->ufd_block->tag == tag && 302 (f->ufd_block->flags & USB_DMA_COHERENT) == dmaflags) 303 break; 304 } 305 if (f == NULL) { 306 DPRINTFN(1, "adding fragments", 0, 0, 0, 0); 307 308 err = usb_block_allocmem(tag, USB_MEM_BLOCK, USB_MEM_SMALL, 309 flags, &b); 310 if (err) { 311 mutex_exit(&usb_blk_lock); 312 return err; 313 } 314 #ifdef DEBUG 315 LIST_INSERT_HEAD(&usb_blk_fraglist, b, next); 316 #endif 317 b->flags = 0; 318 for (i = 0; i < USB_MEM_BLOCK; i += USB_MEM_SMALL) { 319 f = (struct usb_frag_dma *)((char *)b->kaddr + i); 320 f->ufd_block = b; 321 f->ufd_offs = i; 322 LIST_INSERT_HEAD(&usb_frag_freelist, f, ufd_next); 323 #ifdef USB_FRAG_DMA_WORKAROUND 324 i += 1 * USB_MEM_SMALL; 325 #endif 326 } 327 f = LIST_FIRST(&usb_frag_freelist); 328 } 329 p->udma_block = f->ufd_block; 330 p->udma_offs = f->ufd_offs; 331 #ifdef USB_FRAG_DMA_WORKAROUND 332 p->udma_offs += USB_MEM_SMALL; 333 #endif 334 LIST_REMOVE(f, ufd_next); 335 mutex_exit(&usb_blk_lock); 336 DPRINTFN(5, "use frag=%#jx size=%jd", (uintptr_t)f, size, 0, 0); 337 338 return 0; 339 } 340 341 void 342 usb_freemem(struct usbd_bus *bus, usb_dma_t *p) 343 { 344 struct usb_frag_dma *f; 345 346 USBHIST_FUNC(); USBHIST_CALLED(usbdebug); 347 348 mutex_enter(&usb_blk_lock); 349 if (p->udma_block->flags & USB_DMA_FULLBLOCK) { 350 KDASSERTMSG(usb_valid_block_p(p->udma_block, &usb_blk_fulllist), 351 "%s: dma %p: invalid block pointer %p", 352 __func__, p, p->udma_block); 353 DPRINTFN(1, "large free", 0, 0, 0, 0); 354 usb_block_freemem(p->udma_block); 355 mutex_exit(&usb_blk_lock); 356 return; 357 } 358 KDASSERTMSG(usb_valid_block_p(p->udma_block, &usb_blk_fraglist), 359 "%s: dma %p: invalid block pointer %p", 360 __func__, p, p->udma_block); 361 //usb_syncmem(p, 0, USB_MEM_SMALL, BUS_DMASYNC_POSTREAD); 362 f = KERNADDR(p, 0); 363 #ifdef USB_FRAG_DMA_WORKAROUND 364 f = (void *)((uintptr_t)f - USB_MEM_SMALL); 365 #endif 366 f->ufd_block = p->udma_block; 367 f->ufd_offs = p->udma_offs; 368 #ifdef USB_FRAG_DMA_WORKAROUND 369 f->ufd_offs -= USB_MEM_SMALL; 370 #endif 371 LIST_INSERT_HEAD(&usb_frag_freelist, f, ufd_next); 372 mutex_exit(&usb_blk_lock); 373 DPRINTFN(5, "frag=%#jx", (uintptr_t)f, 0, 0, 0); 374 } 375 376 bus_addr_t 377 usb_dmaaddr(usb_dma_t *dma, unsigned int offset) 378 { 379 unsigned int i; 380 bus_size_t seg_offs; 381 382 offset += dma->udma_offs; 383 384 KASSERTMSG(offset < dma->udma_block->size, "offset %d vs %zu", offset, 385 dma->udma_block->size); 386 387 if (dma->udma_block->nsegs == 1) { 388 KASSERT(dma->udma_block->map->dm_segs[0].ds_len > offset); 389 return dma->udma_block->map->dm_segs[0].ds_addr + offset; 390 } 391 392 /* 393 * Search for a bus_segment_t corresponding to this offset. With no 394 * record of the offset in the map to a particular dma_segment_t, we 395 * have to iterate from the start of the list each time. Could be 396 * improved 397 */ 398 seg_offs = 0; 399 for (i = 0; i < dma->udma_block->nsegs; i++) { 400 if (seg_offs + dma->udma_block->map->dm_segs[i].ds_len > offset) 401 break; 402 403 seg_offs += dma->udma_block->map->dm_segs[i].ds_len; 404 } 405 406 KASSERT(i != dma->udma_block->nsegs); 407 offset -= seg_offs; 408 return dma->udma_block->map->dm_segs[i].ds_addr + offset; 409 } 410 411 void 412 usb_syncmem(usb_dma_t *p, bus_addr_t offset, bus_size_t len, int ops) 413 { 414 415 bus_dmamap_sync(p->udma_block->tag, p->udma_block->map, 416 p->udma_offs + offset, len, ops); 417 } 418