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