1 /* $FreeBSD: releng/12.2/sys/dev/usb/usb_busdma.h 326255 2017-11-27 14:52:40Z pfg $ */ 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 /* defines */ 33 34 #define USB_PAGE_SIZE PAGE_SIZE /* use system PAGE_SIZE */ 35 36 #if (__FreeBSD_version >= 700020) 37 #define USB_GET_DMA_TAG(dev) bus_get_dma_tag(dev) 38 #else 39 #define USB_GET_DMA_TAG(dev) NULL /* XXX */ 40 #endif 41 42 /* structure prototypes */ 43 44 struct usb_xfer_root; 45 struct usb_dma_parent_tag; 46 struct usb_dma_tag; 47 48 /* 49 * The following typedef defines the USB DMA load done callback. 50 */ 51 52 typedef void (usb_dma_callback_t)(struct usb_dma_parent_tag *udpt); 53 54 /* 55 * The following structure defines physical and non kernel virtual 56 * address of a memory page having size USB_PAGE_SIZE. 57 */ 58 struct usb_page { 59 #if USB_HAVE_BUSDMA 60 bus_size_t physaddr; 61 void *buffer; /* non Kernel Virtual Address */ 62 #endif 63 }; 64 65 /* 66 * The following structure is used when needing the kernel virtual 67 * pointer and the physical address belonging to an offset in an USB 68 * page cache. 69 */ 70 struct usb_page_search { 71 void *buffer; 72 #if USB_HAVE_BUSDMA 73 bus_size_t physaddr; 74 #endif 75 usb_size_t length; 76 }; 77 78 /* 79 * The following structure is used to keep information about a DMA 80 * memory allocation. 81 */ 82 struct usb_page_cache { 83 84 #if USB_HAVE_BUSDMA 85 bus_dma_tag_t tag; 86 bus_dmamap_t map; 87 struct usb_page *page_start; 88 #endif 89 struct usb_dma_parent_tag *tag_parent; /* always set */ 90 void *buffer; /* virtual buffer pointer */ 91 #if USB_HAVE_BUSDMA 92 usb_size_t page_offset_buf; 93 usb_size_t page_offset_end; 94 uint8_t isread:1; /* set if we are currently reading 95 * from the memory. Else write. */ 96 uint8_t ismultiseg:1; /* set if we can have multiple 97 * segments */ 98 #endif 99 }; 100 101 /* 102 * The following structure describes the parent USB DMA tag. 103 */ 104 #if USB_HAVE_BUSDMA 105 struct usb_dma_parent_tag { 106 struct cv cv[1]; /* internal condition variable */ 107 bus_dma_tag_t tag; /* always set */ 108 109 struct mtx *mtx; /* private mutex, always set */ 110 usb_dma_callback_t *func; /* load complete callback function */ 111 struct usb_dma_tag *utag_first;/* pointer to first USB DMA tag */ 112 uint8_t dma_error; /* set if DMA load operation failed */ 113 uint8_t dma_bits; /* number of DMA address lines */ 114 uint8_t utag_max; /* number of USB DMA tags */ 115 }; 116 #else 117 struct usb_dma_parent_tag {}; /* empty struct */ 118 #endif 119 120 /* 121 * The following structure describes an USB DMA tag. 122 */ 123 #if USB_HAVE_BUSDMA 124 struct usb_dma_tag { 125 struct usb_dma_parent_tag *tag_parent; 126 bus_dma_tag_t tag; 127 usb_size_t align; 128 usb_size_t size; 129 }; 130 #else 131 struct usb_dma_tag {}; /* empty struct */ 132 #endif 133 134 /* function prototypes */ 135 #if USB_HAVE_USER_IO 136 int usb_uiomove(struct usb_page_cache *pc, struct uio *uio, 137 usb_frlength_t pc_offset, usb_frlength_t len); 138 #endif 139 struct usb_dma_tag *usb_dma_tag_find(struct usb_dma_parent_tag *udpt, 140 usb_size_t size, usb_size_t align); 141 uint8_t usb_pc_alloc_mem(struct usb_page_cache *pc, struct usb_page *pg, 142 usb_size_t size, usb_size_t align); 143 uint8_t usb_pc_dmamap_create(struct usb_page_cache *pc, usb_size_t size); 144 uint8_t usb_pc_load_mem(struct usb_page_cache *pc, usb_size_t size, 145 uint8_t sync); 146 void usb_bdma_done_event(struct usb_dma_parent_tag *udpt); 147 void usb_bdma_post_sync(struct usb_xfer *xfer); 148 void usb_bdma_pre_sync(struct usb_xfer *xfer); 149 void usb_bdma_work_loop(struct usb_xfer_queue *pq); 150 void usb_dma_tag_setup(struct usb_dma_parent_tag *udpt, 151 struct usb_dma_tag *udt, bus_dma_tag_t dmat, struct mtx *mtx, 152 usb_dma_callback_t *func, uint8_t ndmabits, uint8_t nudt); 153 void usb_dma_tag_unsetup(struct usb_dma_parent_tag *udpt); 154 void usb_pc_cpu_flush(struct usb_page_cache *pc); 155 void usb_pc_cpu_invalidate(struct usb_page_cache *pc); 156 void usb_pc_dmamap_destroy(struct usb_page_cache *pc); 157 void usb_pc_free_mem(struct usb_page_cache *pc); 158 void usb_dma_cache_invalid(void *addr, unsigned int size); 159 void usb_dma_cache_flush(void *addr, unsigned int size); 160 161 #endif /* _USB_BUSDMA_H_ */ 162