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