sys/bus/usb/usb_mem.c

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