xref: /netbsd-src/sys/dev/usb/usb_mem.h (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1 /*	$NetBSD: usb_mem.h,v 1.30 2013/01/23 23:44:30 jmcneill Exp $	*/
2 /*	$FreeBSD: src/sys/dev/usb/usb_mem.h,v 1.9 1999/11/17 22:33:47 n_hibma Exp $	*/
3 
4 /*
5  * Copyright (c) 1998 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Lennart Augustsson (lennart@augustsson.net) at
10  * Carlstedt Research & Technology.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
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  *
21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 typedef struct usb_dma_block {
35 	bus_dma_tag_t tag;
36 	bus_dmamap_t map;
37         void *kaddr;
38         bus_dma_segment_t *segs;
39         int nsegs;
40         int nsegs_alloc;
41         size_t size;
42         size_t align;
43 	int flags;
44 #define USB_DMA_FULLBLOCK	0x0001
45 #define USB_DMA_RESERVE		0x0002
46 	LIST_ENTRY(usb_dma_block) next;
47 } usb_dma_block_t;
48 
49 #define USBMALLOC_MULTISEG	1
50 
51 usbd_status	usb_allocmem(usbd_bus_handle, size_t, size_t, usb_dma_t *);
52 usbd_status	usb_allocmem_flags(usbd_bus_handle, size_t, size_t, usb_dma_t *,
53 			int);
54 void		usb_freemem(usbd_bus_handle, usb_dma_t *);
55 void		usb_syncmem(usb_dma_t *, bus_addr_t, bus_size_t, int ops);
56 
57 bus_addr_t	usb_dmaaddr(usb_dma_t *, unsigned int);
58 
59 #define DMAADDR(dma, o) usb_dmaaddr((dma), (o))
60 #define KERNADDR(dma, o) \
61 	((void *)((char *)(dma)->block->kaddr + (dma)->offs + (o)))
62 
63 struct extent;
64 
65 struct usb_dma_reserve {
66 	bus_dma_tag_t dtag;
67 	bus_dmamap_t map;
68 	void *vaddr;
69 	bus_addr_t paddr;
70 	size_t size;
71 	struct extent *extent;
72 	device_t dv;
73 };
74 
75 #if defined(_KERNEL_OPT)
76 #include "opt_usb_mem_reserve.h"
77 #endif
78 
79 #ifndef USB_MEM_RESERVE
80 #define USB_MEM_RESERVE (256 * 1024)
81 #endif
82 
83 usbd_status usb_reserve_allocm(struct usb_dma_reserve *, usb_dma_t *,
84 				u_int32_t);
85 int usb_setup_reserve(device_t, struct usb_dma_reserve *, bus_dma_tag_t, size_t);
86 void usb_reserve_freem(struct usb_dma_reserve *, usb_dma_t *);
87