1 /* $NetBSD: usb_mem.c,v 1.26 2003/02/01 06:23:40 thorpej Exp $ */
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net) at
10 * Carlstedt Research & Technology.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by the NetBSD
23 * Foundation, Inc. and its contributors.
24 * 4. Neither the name of The NetBSD Foundation nor the names of its
25 * contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
42 * USB DMA memory allocation.
43 * We need to allocate a lot of small (many 8 byte, some larger)
44 * memory blocks that can be used for DMA. Using the bus_dma
45 * routines directly would incur large overheads in space and time.
48 #include <sys/cdefs.h>
49 __FBSDID("$FreeBSD$");
51 #include <sys/param.h>
52 #include <sys/systm.h>
53 #include <sys/malloc.h>
54 #include <sys/kernel.h>
55 #if defined(__NetBSD__) || defined(__OpenBSD__)
56 #include <sys/device.h> /* for usbdivar.h */
57 #include <machine/bus.h>
58 #elif defined(__FreeBSD__)
59 #include <sys/endian.h>
60 #include <sys/module.h>
63 #include <sys/queue.h>
65 #include <machine/bus.h>
66 #include <machine/endian.h>
72 #include <dev/usb/usb.h>
73 #include <dev/usb/usbdi.h>
74 #include <dev/usb/usbdivar.h> /* just for usb_dma_t */
75 #include <dev/usb/usb_mem.h>
78 #define DPRINTF(x) if (usbdebug) logprintf x
79 #define DPRINTFN(n,x) if (usbdebug>(n)) logprintf x
86 #define USB_MEM_SMALL 64
87 #define USB_MEM_CHUNKS (PAGE_SIZE / USB_MEM_SMALL)
88 #define USB_MEM_BLOCK (USB_MEM_SMALL * USB_MEM_CHUNKS)
90 /* This struct is overlayed on free fragments. */
92 usb_dma_block_t *block;
94 LIST_ENTRY(usb_frag_dma) next;
97 Static bus_dmamap_callback_t usbmem_callback;
98 Static usbd_status usb_block_allocmem(bus_dma_tag_t, size_t, size_t,
100 Static void usb_block_freemem(usb_dma_block_t *);
102 Static LIST_HEAD(, usb_dma_block) usb_blk_freelist =
103 LIST_HEAD_INITIALIZER(usb_blk_freelist);
104 Static int usb_blk_nfree = 0;
105 /* XXX should have different free list for different tags (for speed) */
106 Static LIST_HEAD(, usb_frag_dma) usb_frag_freelist =
107 LIST_HEAD_INITIALIZER(usb_frag_freelist);
110 usbmem_callback(void *arg, bus_dma_segment_t *segs, int nseg, int error)
113 usb_dma_block_t *p = arg;
115 if (error == EFBIG) {
116 printf("usb: mapping to large\n");
121 for (i = 0; i < nseg && i < sizeof p->segs / sizeof *p->segs; i++)
122 p->segs[i] = segs[i];
126 usb_block_allocmem(bus_dma_tag_t tag, size_t size, size_t align,
127 usb_dma_block_t **dmap)
132 DPRINTFN(5, ("usb_block_allocmem: size=%lu align=%lu\n",
133 (u_long)size, (u_long)align));
137 printf("usb_block_allocmem: in interrupt context, size=%lu\n",
138 (unsigned long) size);
143 /* First check the free list. */
144 for (p = LIST_FIRST(&usb_blk_freelist); p; p = LIST_NEXT(p, next)) {
145 if (p->tag == tag && p->size >= size && p->size < size * 2 &&
147 LIST_REMOVE(p, next);
151 DPRINTFN(6,("usb_block_allocmem: free list size=%lu\n",
153 return (USBD_NORMAL_COMPLETION);
160 printf("usb_block_allocmem: in interrupt context, failed\n");
165 DPRINTFN(6, ("usb_block_allocmem: no free\n"));
166 p = malloc(sizeof *p, M_USB, M_NOWAIT);
170 #if __FreeBSD_version >= 500000
171 if (bus_dma_tag_create(tag, align, 0,
172 BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL,
173 size, sizeof(p->segs) / sizeof(p->segs[0]), size,
174 BUS_DMA_ALLOCNOW, NULL, NULL, &p->tag) == ENOMEM)
176 if (bus_dma_tag_create(tag, align, 0,
177 BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL,
178 size, sizeof(p->segs) / sizeof(p->segs[0]), size,
179 BUS_DMA_ALLOCNOW, &p->tag) == ENOMEM)
187 if (bus_dmamem_alloc(p->tag, &p->kaddr,
188 BUS_DMA_NOWAIT|BUS_DMA_COHERENT, &p->map))
191 if (bus_dmamap_load(p->tag, p->map, p->kaddr, p->size,
192 usbmem_callback, p, 0))
195 /* XXX - override the tag, ok since we never free it */
198 return (USBD_NORMAL_COMPLETION);
201 * XXX - do we need to _unload? is the order of _free and _destroy
205 bus_dmamem_free(p->tag, p->kaddr, p->map);
207 bus_dma_tag_destroy(p->tag);
214 * Do not free the memory unconditionally since we might be called
215 * from an interrupt context and that is BAD.
216 * XXX when should we really free?
219 usb_block_freemem(usb_dma_block_t *p)
223 DPRINTFN(6, ("usb_block_freemem: size=%lu\n", (u_long)p->size));
225 LIST_INSERT_HEAD(&usb_blk_freelist, p, next);
231 usb_allocmem(usbd_bus_handle bus, size_t size, size_t align, usb_dma_t *p)
233 bus_dma_tag_t tag = bus->dmatag;
235 struct usb_frag_dma *f;
240 /* compat w/ Net/OpenBSD */
244 /* If the request is large then just use a full block. */
245 if (size > USB_MEM_SMALL || align > USB_MEM_SMALL) {
246 DPRINTFN(1, ("usb_allocmem: large alloc %d\n", (int)size));
247 size = (size + USB_MEM_BLOCK - 1) & ~(USB_MEM_BLOCK - 1);
248 err = usb_block_allocmem(tag, size, align, &p->block);
250 p->block->fullblock = 1;
258 /* Check for free fragments. */
259 for (f = LIST_FIRST(&usb_frag_freelist); f; f = LIST_NEXT(f, next))
260 if (f->block->tag == tag)
263 DPRINTFN(1, ("usb_allocmem: adding fragments\n"));
264 err = usb_block_allocmem(tag, USB_MEM_BLOCK, USB_MEM_SMALL,&b);
270 /* XXX - override the tag, ok since we never free it */
272 KASSERT(sizeof *f <= USB_MEM_SMALL, ("USB_MEM_SMALL(%d) is too small for struct usb_frag_dma(%zd)\n",
273 USB_MEM_SMALL, sizeof *f));
274 for (i = 0; i < USB_MEM_BLOCK; i += USB_MEM_SMALL) {
275 f = (struct usb_frag_dma *)((char *)b->kaddr + i);
278 LIST_INSERT_HEAD(&usb_frag_freelist, f, next);
280 f = LIST_FIRST(&usb_frag_freelist);
284 p->len = USB_MEM_SMALL;
285 LIST_REMOVE(f, next);
287 DPRINTFN(5, ("usb_allocmem: use frag=%p size=%d\n", f, (int)size));
288 return (USBD_NORMAL_COMPLETION);
292 usb_freemem(usbd_bus_handle bus, usb_dma_t *p)
294 struct usb_frag_dma *f;
297 if (p->block->fullblock) {
298 DPRINTFN(1, ("usb_freemem: large free\n"));
299 usb_block_freemem(p->block);
306 LIST_INSERT_HEAD(&usb_frag_freelist, f, next);
308 DPRINTFN(5, ("usb_freemem: frag=%p\n", f));