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.4 2004/05/13 17:24:49 dillon Exp $
7 * Copyright (c) 1998 The NetBSD Foundation, Inc.
10 * This code is derived from software contributed to The NetBSD Foundation
11 * by Lennart Augustsson (lennart@augustsson.net) at
12 * Carlstedt Research & Technology.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
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.
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.
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.
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>
61 #include <sys/queue.h>
63 #include <machine/bus.h>
64 #include <machine/endian.h>
70 #include <bus/usb/usb.h>
71 #include <bus/usb/usbdi.h>
72 #include <bus/usb/usbdivar.h> /* just for usb_dma_t */
73 #include <bus/usb/usb_mem.h>
76 #define DPRINTF(x) if (usbdebug) logprintf x
77 #define DPRINTFN(n,x) if (usbdebug>(n)) logprintf x
84 #define USB_MEM_SMALL 64
85 #define USB_MEM_CHUNKS (PAGE_SIZE / USB_MEM_SMALL)
86 #define USB_MEM_BLOCK (USB_MEM_SMALL * USB_MEM_CHUNKS)
88 /* This struct is overlayed on free fragments. */
90 usb_dma_block_t *block;
92 LIST_ENTRY(usb_frag_dma) next;
95 Static bus_dmamap_callback_t usbmem_callback;
96 Static usbd_status usb_block_allocmem(bus_dma_tag_t, size_t, size_t,
98 Static void usb_block_freemem(usb_dma_block_t *);
100 Static LIST_HEAD(, usb_dma_block) usb_blk_freelist =
101 LIST_HEAD_INITIALIZER(usb_blk_freelist);
102 Static int usb_blk_nfree = 0;
103 /* XXX should have different free list for different tags (for speed) */
104 Static LIST_HEAD(, usb_frag_dma) usb_frag_freelist =
105 LIST_HEAD_INITIALIZER(usb_frag_freelist);
108 usbmem_callback(void *arg, bus_dma_segment_t *segs, int nseg, int error)
111 usb_dma_block_t *p = arg;
113 if (error == EFBIG) {
114 printf("usb: mapping to large\n");
119 for (i = 0; i < nseg && i < sizeof p->segs / sizeof *p->segs; i++)
120 p->segs[i] = segs[i];
124 usb_block_allocmem(bus_dma_tag_t tag, size_t size, size_t align,
125 usb_dma_block_t **dmap)
130 DPRINTFN(5, ("usb_block_allocmem: size=%lu align=%lu\n",
131 (u_long)size, (u_long)align));
134 /* First check the free list. */
135 for (p = LIST_FIRST(&usb_blk_freelist); p; p = LIST_NEXT(p, next)) {
136 if (p->tag == tag && p->size >= size && p->align >= align) {
137 LIST_REMOVE(p, next);
141 DPRINTFN(6,("usb_block_allocmem: free list size=%lu\n",
143 return (USBD_NORMAL_COMPLETION);
148 DPRINTFN(6, ("usb_block_allocmem: no free\n"));
149 p = malloc(sizeof *p, M_USB, M_INTWAIT);
151 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
152 if (bus_dma_tag_create(tag, align, 0,
153 BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL,
154 size, sizeof(p->segs) / sizeof(p->segs[0]), size,
155 BUS_DMA_ALLOCNOW, NULL, NULL, &p->tag) == ENOMEM)
157 if (bus_dma_tag_create(tag, align, 0,
158 BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL,
159 size, sizeof(p->segs) / sizeof(p->segs[0]), size,
160 BUS_DMA_ALLOCNOW, &p->tag) == ENOMEM)
168 if (bus_dmamem_alloc(p->tag, &p->kaddr,
169 BUS_DMA_NOWAIT|BUS_DMA_COHERENT, &p->map))
172 if (bus_dmamap_load(p->tag, p->map, p->kaddr, p->size,
173 usbmem_callback, p, 0))
176 /* XXX - override the tag, ok since we never free it */
179 return (USBD_NORMAL_COMPLETION);
182 * XXX - do we need to _unload? is the order of _free and _destroy
186 bus_dmamem_free(p->tag, p->kaddr, p->map);
188 bus_dma_tag_destroy(p->tag);
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?
200 usb_block_freemem(usb_dma_block_t *p)
204 DPRINTFN(6, ("usb_block_freemem: size=%lu\n", (u_long)p->size));
206 LIST_INSERT_HEAD(&usb_blk_freelist, p, next);
212 usb_allocmem(usbd_bus_handle bus, size_t size, size_t align, usb_dma_t *p)
214 bus_dma_tag_t tag = bus->dmatag;
216 struct usb_frag_dma *f;
221 /* compat w/ Net/OpenBSD */
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 err = usb_block_allocmem(tag, size, align, &p->block);
231 p->block->fullblock = 1;
239 /* Check for free fragments. */
240 for (f = LIST_FIRST(&usb_frag_freelist); f; f = LIST_NEXT(f, next))
241 if (f->block->tag == tag)
244 DPRINTFN(1, ("usb_allocmem: adding fragments\n"));
245 err = usb_block_allocmem(tag, USB_MEM_BLOCK, USB_MEM_SMALL,&b);
251 /* XXX - override the tag, ok since we never free it */
253 KASSERT(sizeof *f <= USB_MEM_SMALL, ("USB_MEM_SMALL(%d) is too small for struct usb_frag_dma(%zd)\n",
254 USB_MEM_SMALL, sizeof *f));
255 for (i = 0; i < USB_MEM_BLOCK; i += USB_MEM_SMALL) {
256 f = (struct usb_frag_dma *)((char *)b->kaddr + i);
259 LIST_INSERT_HEAD(&usb_frag_freelist, f, next);
261 f = LIST_FIRST(&usb_frag_freelist);
265 p->len = USB_MEM_SMALL;
266 LIST_REMOVE(f, next);
268 DPRINTFN(5, ("usb_allocmem: use frag=%p size=%d\n", f, (int)size));
269 return (USBD_NORMAL_COMPLETION);
273 usb_freemem(usbd_bus_handle bus, usb_dma_t *p)
275 struct usb_frag_dma *f;
278 if (p->block->fullblock) {
279 DPRINTFN(1, ("usb_freemem: large free\n"));
280 usb_block_freemem(p->block);
287 LIST_INSERT_HEAD(&usb_frag_freelist, f, next);
289 DPRINTFN(5, ("usb_freemem: frag=%p\n", f));