usb_busdma.h revision 330897 
1/* $FreeBSD: stable/11/sys/dev/usb/usb_busdma.h 330897 2018-03-14 03:19:51Z eadler $ */
2/*-
3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 *
5 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#ifndef _USB_BUSDMA_H_
30#define	_USB_BUSDMA_H_
31
32#ifndef USB_GLOBAL_INCLUDE_FILE
33#include <sys/uio.h>
34#include <sys/mbuf.h>
35
36#include <machine/bus.h>
37#endif
38
39/* defines */
40
41#define	USB_PAGE_SIZE PAGE_SIZE		/* use system PAGE_SIZE */
42
43#if (__FreeBSD_version >= 700020)
44#define	USB_GET_DMA_TAG(dev) bus_get_dma_tag(dev)
45#else
46#define	USB_GET_DMA_TAG(dev) NULL	/* XXX */
47#endif
48
49/* structure prototypes */
50
51struct usb_xfer_root;
52struct usb_dma_parent_tag;
53struct usb_dma_tag;
54
55/*
56 * The following typedef defines the USB DMA load done callback.
57 */
58
59typedef void (usb_dma_callback_t)(struct usb_dma_parent_tag *udpt);
60
61/*
62 * The following structure defines physical and non kernel virtual
63 * address of a memory page having size USB_PAGE_SIZE.
64 */
65struct usb_page {
66#if USB_HAVE_BUSDMA
67	bus_addr_t physaddr;
68	void   *buffer;			/* non Kernel Virtual Address */
69#endif
70};
71
72/*
73 * The following structure is used when needing the kernel virtual
74 * pointer and the physical address belonging to an offset in an USB
75 * page cache.
76 */
77struct usb_page_search {
78	void   *buffer;
79#if USB_HAVE_BUSDMA
80	bus_addr_t physaddr;
81#endif
82	usb_size_t length;
83};
84
85/*
86 * The following structure is used to keep information about a DMA
87 * memory allocation.
88 */
89struct usb_page_cache {
90
91#if USB_HAVE_BUSDMA
92	bus_dma_tag_t tag;
93	bus_dmamap_t map;
94	struct usb_page *page_start;
95#endif
96	struct usb_dma_parent_tag *tag_parent;	/* always set */
97	void   *buffer;			/* virtual buffer pointer */
98#if USB_HAVE_BUSDMA
99	usb_size_t page_offset_buf;
100	usb_size_t page_offset_end;
101	uint8_t	isread:1;		/* set if we are currently reading
102					 * from the memory. Else write. */
103	uint8_t	ismultiseg:1;		/* set if we can have multiple
104					 * segments */
105#endif
106};
107
108/*
109 * The following structure describes the parent USB DMA tag.
110 */
111#if USB_HAVE_BUSDMA
112struct usb_dma_parent_tag {
113	struct cv cv[1];		/* internal condition variable */
114	bus_dma_tag_t tag;		/* always set */
115
116	struct mtx *mtx;		/* private mutex, always set */
117	usb_dma_callback_t *func;	/* load complete callback function */
118	struct usb_dma_tag *utag_first;/* pointer to first USB DMA tag */
119	uint8_t	dma_error;		/* set if DMA load operation failed */
120	uint8_t	dma_bits;		/* number of DMA address lines */
121	uint8_t	utag_max;		/* number of USB DMA tags */
122};
123#else
124struct usb_dma_parent_tag {};		/* empty struct */
125#endif
126
127/*
128 * The following structure describes an USB DMA tag.
129 */
130#if USB_HAVE_BUSDMA
131struct usb_dma_tag {
132	struct usb_dma_parent_tag *tag_parent;
133	bus_dma_tag_t tag;
134	usb_size_t align;
135	usb_size_t size;
136};
137#else
138struct usb_dma_tag {};			/* empty struct */
139#endif
140
141/* function prototypes */
142
143int	usb_uiomove(struct usb_page_cache *pc, struct uio *uio,
144	    usb_frlength_t pc_offset, usb_frlength_t len);
145struct usb_dma_tag *usb_dma_tag_find(struct usb_dma_parent_tag *udpt,
146	    usb_size_t size, usb_size_t align);
147uint8_t	usb_pc_alloc_mem(struct usb_page_cache *pc, struct usb_page *pg,
148	    usb_size_t size, usb_size_t align);
149uint8_t	usb_pc_dmamap_create(struct usb_page_cache *pc, usb_size_t size);
150uint8_t	usb_pc_load_mem(struct usb_page_cache *pc, usb_size_t size,
151	    uint8_t sync);
152void	usb_bdma_done_event(struct usb_dma_parent_tag *udpt);
153void	usb_bdma_post_sync(struct usb_xfer *xfer);
154void	usb_bdma_pre_sync(struct usb_xfer *xfer);
155void	usb_bdma_work_loop(struct usb_xfer_queue *pq);
156void	usb_dma_tag_setup(struct usb_dma_parent_tag *udpt,
157	    struct usb_dma_tag *udt, bus_dma_tag_t dmat, struct mtx *mtx,
158	    usb_dma_callback_t *func, uint8_t ndmabits, uint8_t nudt);
159void	usb_dma_tag_unsetup(struct usb_dma_parent_tag *udpt);
160void	usb_pc_cpu_flush(struct usb_page_cache *pc);
161void	usb_pc_cpu_invalidate(struct usb_page_cache *pc);
162void	usb_pc_dmamap_destroy(struct usb_page_cache *pc);
163void	usb_pc_free_mem(struct usb_page_cache *pc);
164uint8_t	usb_pc_buffer_is_aligned(struct usb_page_cache *pc,
165	    usb_frlength_t offset, usb_frlength_t len,
166	    usb_frlength_t mask);
167
168#endif					/* _USB_BUSDMA_H_ */
169