usb_busdma.h revision 266969
11539Srgrimes/* $FreeBSD: head/sys/dev/usb/usb_busdma.h 266969 2014-06-02 07:08:34Z hselasky $ */ 21539Srgrimes/*- 31539Srgrimes * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 41539Srgrimes * 51539Srgrimes * Redistribution and use in source and binary forms, with or without 61539Srgrimes * modification, are permitted provided that the following conditions 71539Srgrimes * are met: 81539Srgrimes * 1. Redistributions of source code must retain the above copyright 91539Srgrimes * notice, this list of conditions and the following disclaimer. 101539Srgrimes * 2. Redistributions in binary form must reproduce the above copyright 111539Srgrimes * notice, this list of conditions and the following disclaimer in the 121539Srgrimes * documentation and/or other materials provided with the distribution. 131539Srgrimes * 141539Srgrimes * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 151539Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16203964Simp * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 171539Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 181539Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 191539Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 201539Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 211539Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 221539Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 231539Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 241539Srgrimes * SUCH DAMAGE. 251539Srgrimes */ 261539Srgrimes 271539Srgrimes#ifndef _USB_BUSDMA_H_ 281539Srgrimes#define _USB_BUSDMA_H_ 291539Srgrimes 301539Srgrimes#ifndef USB_GLOBAL_INCLUDE_FILE 311539Srgrimes#include <sys/uio.h> 321539Srgrimes#include <sys/mbuf.h> 3393032Simp 341539Srgrimes#include <machine/bus.h> 351539Srgrimes#endif 361539Srgrimes 371539Srgrimes/* defines */ 381539Srgrimes 391539Srgrimes#define USB_PAGE_SIZE PAGE_SIZE /* use system PAGE_SIZE */ 401539Srgrimes 411539Srgrimes#if (__FreeBSD_version >= 700020) 421539Srgrimes#define USB_GET_DMA_TAG(dev) bus_get_dma_tag(dev) 431539Srgrimes#else 441539Srgrimes#define USB_GET_DMA_TAG(dev) NULL /* XXX */ 451539Srgrimes#endif 461539Srgrimes 471539Srgrimes/* structure prototypes */ 481539Srgrimes 4914352Sjkhstruct usb_xfer_root; 501539Srgrimesstruct usb_dma_parent_tag; 511539Srgrimesstruct usb_dma_tag; 521539Srgrimes 531539Srgrimes/* 541539Srgrimes * The following typedef defines the USB DMA load done callback. 551539Srgrimes */ 561539Srgrimes 571539Srgrimestypedef void (usb_dma_callback_t)(struct usb_dma_parent_tag *udpt); 581539Srgrimes 591539Srgrimes/* 601539Srgrimes * The following structure defines physical and non kernel virtual 611539Srgrimes * address of a memory page having size USB_PAGE_SIZE. 621539Srgrimes */ 6393032Simpstruct usb_page { 6493032Simp#if USB_HAVE_BUSDMA 6593032Simp bus_addr_t physaddr; 6693032Simp void *buffer; /* non Kernel Virtual Address */ 6793032Simp#endif 6893032Simp}; 69189808Sdas 7093032Simp/* 71189808Sdas * The following structure is used when needing the kernel virtual 7293032Simp * pointer and the physical address belonging to an offset in an USB 7393032Simp * page cache. 7493032Simp */ 75189808Sdasstruct usb_page_search { 7693032Simp void *buffer; 77189808Sdas#if USB_HAVE_BUSDMA 781539Srgrimes bus_addr_t physaddr; 791539Srgrimes#endif 801539Srgrimes usb_size_t length; 81}; 82 83/* 84 * The following structure is used to keep information about a DMA 85 * memory allocation. 86 */ 87struct usb_page_cache { 88 89#if USB_HAVE_BUSDMA 90 bus_dma_tag_t tag; 91 bus_dmamap_t map; 92 struct usb_page *page_start; 93#endif 94 struct usb_dma_parent_tag *tag_parent; /* always set */ 95 void *buffer; /* virtual buffer pointer */ 96#if USB_HAVE_BUSDMA 97 usb_size_t page_offset_buf; 98 usb_size_t page_offset_end; 99 uint8_t isread:1; /* set if we are currently reading 100 * from the memory. Else write. */ 101 uint8_t ismultiseg:1; /* set if we can have multiple 102 * segments */ 103#endif 104}; 105 106/* 107 * The following structure describes the parent USB DMA tag. 108 */ 109#if USB_HAVE_BUSDMA 110struct usb_dma_parent_tag { 111 struct cv cv[1]; /* internal condition variable */ 112 bus_dma_tag_t tag; /* always set */ 113 114 struct mtx *mtx; /* private mutex, always set */ 115 usb_dma_callback_t *func; /* load complete callback function */ 116 struct usb_dma_tag *utag_first;/* pointer to first USB DMA tag */ 117 uint8_t dma_error; /* set if DMA load operation failed */ 118 uint8_t dma_bits; /* number of DMA address lines */ 119 uint8_t utag_max; /* number of USB DMA tags */ 120}; 121#else 122struct usb_dma_parent_tag {}; /* empty struct */ 123#endif 124 125/* 126 * The following structure describes an USB DMA tag. 127 */ 128#if USB_HAVE_BUSDMA 129struct usb_dma_tag { 130 struct usb_dma_parent_tag *tag_parent; 131 bus_dma_tag_t tag; 132 usb_size_t align; 133 usb_size_t size; 134}; 135#else 136struct usb_dma_tag {}; /* empty struct */ 137#endif 138 139/* function prototypes */ 140 141int usb_uiomove(struct usb_page_cache *pc, struct uio *uio, 142 usb_frlength_t pc_offset, usb_frlength_t len); 143struct usb_dma_tag *usb_dma_tag_find(struct usb_dma_parent_tag *udpt, 144 usb_size_t size, usb_size_t align); 145uint8_t usb_pc_alloc_mem(struct usb_page_cache *pc, struct usb_page *pg, 146 usb_size_t size, usb_size_t align); 147uint8_t usb_pc_dmamap_create(struct usb_page_cache *pc, usb_size_t size); 148uint8_t usb_pc_load_mem(struct usb_page_cache *pc, usb_size_t size, 149 uint8_t sync); 150void usb_bdma_done_event(struct usb_dma_parent_tag *udpt); 151void usb_bdma_post_sync(struct usb_xfer *xfer); 152void usb_bdma_pre_sync(struct usb_xfer *xfer); 153void usb_bdma_work_loop(struct usb_xfer_queue *pq); 154void usb_dma_tag_setup(struct usb_dma_parent_tag *udpt, 155 struct usb_dma_tag *udt, bus_dma_tag_t dmat, struct mtx *mtx, 156 usb_dma_callback_t *func, uint8_t ndmabits, uint8_t nudt); 157void usb_dma_tag_unsetup(struct usb_dma_parent_tag *udpt); 158void usb_pc_cpu_flush(struct usb_page_cache *pc); 159void usb_pc_cpu_invalidate(struct usb_page_cache *pc); 160void usb_pc_dmamap_destroy(struct usb_page_cache *pc); 161void usb_pc_free_mem(struct usb_page_cache *pc); 162 163#endif /* _USB_BUSDMA_H_ */ 164