xref: /netbsd-src/sys/dev/usb/usb_mem.h (revision 9cba8f086563e57d690b6cd7b94966c57238eb97)
1 /*	$NetBSD: usb_mem.h,v 1.37 2022/03/03 06:09:11 riastradh 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 #ifndef	_DEV_USB_USB_MEM_H_
35 #define	_DEV_USB_USB_MEM_H_
36 
37 #include <sys/types.h>
38 
39 #include <sys/bus.h>
40 #include <sys/queue.h>
41 
42 #include <dev/usb/usbdivar.h>
43 
44 typedef struct usb_dma_block {
45 	bus_dma_tag_t tag;
46 	bus_dmamap_t map;
47 	void *kaddr;
48 	bus_dma_segment_t *segs;
49 	int nsegs;
50 	int nsegs_alloc;
51 	size_t size;
52 	size_t align;
53 	int flags;
54 #define USB_DMA_FULLBLOCK	__BIT(0)
55 #define USB_DMA_COHERENT	__BIT(1)
56 
57 	LIST_ENTRY(usb_dma_block) next;
58 } usb_dma_block_t;
59 
60 #define USBMALLOC_MULTISEG	__BIT(0)
61 #define USBMALLOC_COHERENT	__BIT(1)
62 #define USBMALLOC_ZERO		__BIT(2)
63 
64 int		usb_allocmem(bus_dma_tag_t, size_t, size_t, u_int, usb_dma_t *);
65 void		usb_freemem(usb_dma_t *);
66 void		usb_syncmem(usb_dma_t *, bus_addr_t, bus_size_t, int);
67 
68 bus_addr_t	usb_dmaaddr(usb_dma_t *, unsigned int);
69 
70 #define DMAADDR(dma, o)	usb_dmaaddr((dma), (o))
71 #define KERNADDR(dma, o) \
72 	((void *)((char *)(dma)->udma_block->kaddr + (dma)->udma_offs + (o)))
73 
74 #endif	/* _DEV_USB_USB_MEM_H_ */
75