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 $
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>
62 #include <sys/sysctl.h>
65 #include <machine/bus.h>
66 #include <machine/endian.h>
71 #include <sys/thread2.h>
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>
78 #define USBKTR_STRING "ptr=%p bus=%p size=%d align=%d"
79 #define USBKTR_ARG_SIZE (sizeof(void *) * 2 + sizeof(int) * 2)
81 #if !defined(KTR_USB_MEMORY)
82 #define KTR_USB_MEMORY KTR_ALL
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);
93 #define logmemory(name, ptr, bus, size, align) \
94 KTR_LOG(usbmem_ ## name, ptr, bus, (int)size, (int)align);
97 #define DPRINTF(x) if (usbdebug) logprintf x
98 #define DPRINTFN(n,x) if (usbdebug>(n)) logprintf x
102 #define DPRINTFN(n,x)
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)
109 /* This struct is overlayed on free fragments. */
110 struct usb_frag_dma {
111 usb_dma_block_t *block;
113 LIST_ENTRY(usb_frag_dma) next;
116 Static bus_dmamap_callback_t usbmem_callback;
117 Static usbd_status usb_block_allocmem(bus_dma_tag_t, size_t, size_t,
119 Static void usb_block_freemem(usb_dma_block_t *);
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);
129 usbmem_callback(void *arg, bus_dma_segment_t *segs, int nseg, int error)
132 usb_dma_block_t *p = arg;
134 if (error == EFBIG) {
135 printf("usb: mapping to large\n");
140 for (i = 0; i < nseg && i < sizeof p->segs / sizeof *p->segs; i++)
141 p->segs[i] = segs[i];
145 usb_block_allocmem(bus_dma_tag_t tag, size_t size, size_t align,
146 usb_dma_block_t **dmap)
150 DPRINTFN(5, ("usb_block_allocmem: size=%lu align=%lu\n",
151 (u_long)size, (u_long)align));
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);
161 DPRINTFN(6,("usb_block_allocmem: free list size=%lu\n",
163 logmemory(blkalloc2, p, NULL, size, align);
164 return (USBD_NORMAL_COMPLETION);
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);
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)
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)
190 if (bus_dmamem_alloc(p->tag, &p->kaddr,
191 BUS_DMA_NOWAIT|BUS_DMA_COHERENT, &p->map))
194 if (bus_dmamap_load(p->tag, p->map, p->kaddr, p->size,
195 usbmem_callback, p, 0))
198 /* XXX - override the tag, ok since we never free it */
201 return (USBD_NORMAL_COMPLETION);
204 * XXX - do we need to _unload? is the order of _free and _destroy
208 bus_dmamem_free(p->tag, p->kaddr, p->map);
210 bus_dma_tag_destroy(p->tag);
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?
222 usb_block_freemem(usb_dma_block_t *p)
224 DPRINTFN(6, ("usb_block_freemem: size=%lu\n", (u_long)p->size));
225 logmemory(blkfree, p, NULL, p->size, p->align);
227 LIST_INSERT_HEAD(&usb_blk_freelist, p, next);
233 usb_allocmem(usbd_bus_handle bus, size_t size, size_t align, usb_dma_t *p)
235 bus_dma_tag_t tag = bus->dmatag;
237 struct usb_frag_dma *f;
241 /* compat w/ Net/OpenBSD */
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);
251 p->block->fullblock = 1;
254 logmemory(alloc_full, p, NULL, size, align);
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)
265 DPRINTFN(1, ("usb_allocmem: adding fragments\n"));
266 err = usb_block_allocmem(tag, USB_MEM_BLOCK, USB_MEM_SMALL,&b);
272 /* XXX - override the tag, ok since we never free it */
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);
280 LIST_INSERT_HEAD(&usb_frag_freelist, f, next);
282 f = LIST_FIRST(&usb_frag_freelist);
286 p->len = USB_MEM_SMALL;
287 LIST_REMOVE(f, next);
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);
295 usb_freemem(usbd_bus_handle bus, usb_dma_t *p)
297 struct usb_frag_dma *f;
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);
305 logmemory(free_frag, p, bus, 0, 0);
310 LIST_INSERT_HEAD(&usb_frag_freelist, f, next);
312 DPRINTFN(5, ("usb_freemem: frag=%p\n", f));