Rename printf -> kprintf in sys/ and add some defines where necessary
[dragonfly.git] / 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.9 2006/12/22 23:12:17 swildner 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 #include <sys/endian.h>
54 #include <sys/module.h>
55 #include <sys/bus.h>
56 #include <sys/queue.h>
57 #include <sys/sysctl.h>
58 #include <sys/ktr.h>
59
60 #include <machine/endian.h>
61
62 #ifdef DIAGNOSTIC
63 #include <sys/proc.h>
64 #endif
65 #include <sys/thread2.h>
66
67 #include <bus/usb/usb.h>
68 #include <bus/usb/usbdi.h>
69 #include <bus/usb/usbdivar.h>   /* just for usb_dma_t */
70 #include <bus/usb/usb_mem.h>
71
72 #define USBKTR_STRING   "ptr=%p bus=%p size=%d align=%d"
73 #define USBKTR_ARG_SIZE (sizeof(void *) * 2 + sizeof(int) * 2)
74
75 #if !defined(KTR_USB_MEMORY)
76 #define KTR_USB_MEMORY  KTR_ALL
77 #endif
78 KTR_INFO_MASTER(usbmem);
79 KTR_INFO(KTR_USB_MEMORY, usbmem, alloc_full, 0, USBKTR_STRING, USBKTR_ARG_SIZE);
80 KTR_INFO(KTR_USB_MEMORY, usbmem, alloc_frag, 0, USBKTR_STRING, USBKTR_ARG_SIZE);
81 KTR_INFO(KTR_USB_MEMORY, usbmem, free_full, 0, USBKTR_STRING, USBKTR_ARG_SIZE);
82 KTR_INFO(KTR_USB_MEMORY, usbmem, free_frag, 0, USBKTR_STRING, USBKTR_ARG_SIZE);
83 KTR_INFO(KTR_USB_MEMORY, usbmem, blkalloc, 0, USBKTR_STRING, USBKTR_ARG_SIZE);
84 KTR_INFO(KTR_USB_MEMORY, usbmem, blkalloc2, 0, USBKTR_STRING, USBKTR_ARG_SIZE);
85 KTR_INFO(KTR_USB_MEMORY, usbmem, blkfree, 0, USBKTR_STRING, USBKTR_ARG_SIZE);
86
87 #define logmemory(name, ptr, bus, size, align)          \
88         KTR_LOG(usbmem_ ## name, ptr, bus, (int)size, (int)align);
89
90 #ifdef USB_DEBUG
91 #define DPRINTF(x)      if (usbdebug) logprintf x
92 #define DPRINTFN(n,x)   if (usbdebug>(n)) logprintf x
93 extern int usbdebug;
94 #else
95 #define DPRINTF(x)
96 #define DPRINTFN(n,x)
97 #endif
98
99 #define USB_MEM_SMALL 64
100 #define USB_MEM_CHUNKS (PAGE_SIZE / USB_MEM_SMALL)
101 #define USB_MEM_BLOCK (USB_MEM_SMALL * USB_MEM_CHUNKS)
102
103 /* This struct is overlayed on free fragments. */
104 struct usb_frag_dma {
105         usb_dma_block_t *block;
106         u_int offs;
107         LIST_ENTRY(usb_frag_dma) next;
108 };
109
110 Static bus_dmamap_callback_t usbmem_callback;
111 Static usbd_status      usb_block_allocmem(bus_dma_tag_t, size_t, size_t,
112                                            usb_dma_block_t **);
113 Static void             usb_block_freemem(usb_dma_block_t *);
114
115 Static LIST_HEAD(, usb_dma_block) usb_blk_freelist =
116         LIST_HEAD_INITIALIZER(usb_blk_freelist);
117 Static int usb_blk_nfree = 0;
118 /* XXX should have different free list for different tags (for speed) */
119 Static LIST_HEAD(, usb_frag_dma) usb_frag_freelist =
120         LIST_HEAD_INITIALIZER(usb_frag_freelist);
121
122 Static void
123 usbmem_callback(void *arg, bus_dma_segment_t *segs, int nseg, int error)
124 {
125         int i;
126         usb_dma_block_t *p = arg;
127
128         if (error == EFBIG) {
129                 kprintf("usb: mapping to large\n");
130                 return;
131         }
132
133         p->nsegs = nseg;
134         for (i = 0; i < nseg && i < sizeof p->segs / sizeof *p->segs; i++)
135                 p->segs[i] = segs[i];
136 }
137
138 Static usbd_status
139 usb_block_allocmem(bus_dma_tag_t tag, size_t size, size_t align,
140                    usb_dma_block_t **dmap)
141 {
142         usb_dma_block_t *p;
143
144         DPRINTFN(5, ("usb_block_allocmem: size=%lu align=%lu\n",
145                      (u_long)size, (u_long)align));
146
147         crit_enter();
148         /* First check the free list. */
149         for (p = LIST_FIRST(&usb_blk_freelist); p; p = LIST_NEXT(p, next)) {
150                 if (p->tag == tag && p->size >= size && p->align >= align) {
151                         LIST_REMOVE(p, next);
152                         usb_blk_nfree--;
153                         crit_exit();
154                         *dmap = p;
155                         DPRINTFN(6,("usb_block_allocmem: free list size=%lu\n",
156                                     (u_long)p->size));
157                         logmemory(blkalloc2, p, NULL, size, align);
158                         return (USBD_NORMAL_COMPLETION);
159                 }
160         }
161         crit_exit();
162
163         DPRINTFN(6, ("usb_block_allocmem: no free\n"));
164         p = kmalloc(sizeof *p, M_USB, M_INTWAIT);
165         logmemory(blkalloc, p, NULL, size, align);
166
167 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
168         if (bus_dma_tag_create(tag, align, 0,
169             BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL,
170             size, sizeof(p->segs) / sizeof(p->segs[0]), size,
171             BUS_DMA_ALLOCNOW, NULL, NULL, &p->tag) == ENOMEM)
172 #else
173         if (bus_dma_tag_create(tag, align, 0,
174             BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL,
175             size, sizeof(p->segs) / sizeof(p->segs[0]), size,
176             BUS_DMA_ALLOCNOW, &p->tag) == ENOMEM)
177 #endif
178         {
179                 goto free;
180         }
181
182         p->size = size;
183         p->align = align;
184         if (bus_dmamem_alloc(p->tag, &p->kaddr,
185             BUS_DMA_NOWAIT|BUS_DMA_COHERENT, &p->map))
186                 goto tagfree;
187
188         if (bus_dmamap_load(p->tag, p->map, p->kaddr, p->size,
189             usbmem_callback, p, 0))
190                 goto memfree;
191
192         /* XXX - override the tag, ok since we never free it */
193         p->tag = tag;
194         *dmap = p;
195         return (USBD_NORMAL_COMPLETION);
196
197         /*
198          * XXX - do we need to _unload? is the order of _free and _destroy
199          * correct?
200          */
201 memfree:
202         bus_dmamem_free(p->tag, p->kaddr, p->map);
203 tagfree:
204         bus_dma_tag_destroy(p->tag);
205 free:
206         kfree(p, M_USB);
207         return (USBD_NOMEM);
208 }
209
210 /*
211  * Do not free the memory unconditionally since we might be called
212  * from an interrupt context and that is BAD.
213  * XXX when should we really free?
214  */
215 Static void
216 usb_block_freemem(usb_dma_block_t *p)
217 {
218         DPRINTFN(6, ("usb_block_freemem: size=%lu\n", (u_long)p->size));
219         logmemory(blkfree, p, NULL, p->size, p->align);
220         crit_enter();
221         LIST_INSERT_HEAD(&usb_blk_freelist, p, next);
222         usb_blk_nfree++;
223         crit_exit();
224 }
225
226 usbd_status
227 usb_allocmem(usbd_bus_handle bus, size_t size, size_t align, usb_dma_t *p)
228 {
229         bus_dma_tag_t tag = bus->dmatag;
230         usbd_status err;
231         struct usb_frag_dma *f;
232         usb_dma_block_t *b;
233         int i;
234
235         /* compat w/ Net/OpenBSD */
236         if (align == 0)
237                 align = 1;
238
239         /* If the request is large then just use a full block. */
240         if (size > USB_MEM_SMALL || align > USB_MEM_SMALL) {
241                 DPRINTFN(1, ("usb_allocmem: large alloc %d\n", (int)size));
242                 size = (size + USB_MEM_BLOCK - 1) & ~(USB_MEM_BLOCK - 1);
243                 err = usb_block_allocmem(tag, size, align, &p->block);
244                 if (!err) {
245                         p->block->fullblock = 1;
246                         p->offs = 0;
247                         p->len = size;
248                         logmemory(alloc_full, p, NULL, size, align);
249                 }
250                 return (err);
251         }
252
253         crit_enter();
254         /* Check for free fragments. */
255         for (f = LIST_FIRST(&usb_frag_freelist); f; f = LIST_NEXT(f, next))
256                 if (f->block->tag == tag)
257                         break;
258         if (f == NULL) {
259                 DPRINTFN(1, ("usb_allocmem: adding fragments\n"));
260                 err = usb_block_allocmem(tag, USB_MEM_BLOCK, USB_MEM_SMALL,&b);
261                 if (err) {
262                         crit_exit();
263                         return (err);
264                 }
265                 b->fullblock = 0;
266                 /* XXX - override the tag, ok since we never free it */
267                 b->tag = tag;
268                 KASSERT(sizeof *f <= USB_MEM_SMALL, ("USB_MEM_SMALL(%d) is too small for struct usb_frag_dma(%zd)\n",
269                     USB_MEM_SMALL, sizeof *f));
270                 for (i = 0; i < USB_MEM_BLOCK; i += USB_MEM_SMALL) {
271                         f = (struct usb_frag_dma *)((char *)b->kaddr + i);
272                         f->block = b;
273                         f->offs = i;
274                         LIST_INSERT_HEAD(&usb_frag_freelist, f, next);
275                 }
276                 f = LIST_FIRST(&usb_frag_freelist);
277         }
278         p->block = f->block;
279         p->offs = f->offs;
280         p->len = USB_MEM_SMALL;
281         LIST_REMOVE(f, next);
282         crit_exit();
283         logmemory(alloc_frag, p, NULL, size, align);
284         DPRINTFN(5, ("usb_allocmem: use frag=%p size=%d\n", f, (int)size));
285         return (USBD_NORMAL_COMPLETION);
286 }
287
288 void
289 usb_freemem(usbd_bus_handle bus, usb_dma_t *p)
290 {
291         struct usb_frag_dma *f;
292
293         if (p->block->fullblock) {
294                 DPRINTFN(1, ("usb_freemem: large free\n"));
295                 usb_block_freemem(p->block);
296                 logmemory(free_full, p, bus, 0, 0);
297                 return;
298         }
299         logmemory(free_frag, p, bus, 0, 0);
300         f = KERNADDR(p, 0);
301         f->block = p->block;
302         f->offs = p->offs;
303         crit_enter();
304         LIST_INSERT_HEAD(&usb_frag_freelist, f, next);
305         crit_exit();
306         DPRINTFN(5, ("usb_freemem: frag=%p\n", f));
307 }