sys/dev/usb/usb_busdma.h

   1 /* $FreeBSD$ */
   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
  51 struct usb_xfer_root;
  52 struct usb_dma_parent_tag;
  53 struct usb_dma_tag;
  54
  55 /*
  56  * The following typedef defines the USB DMA load done callback.
  57  */
  58
  59 typedef 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  */
  65 struct 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  */
  77 struct 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  */
  89 struct usb_page_cache {
  90 #if USB_HAVE_BUSDMA
  91         bus_dma_tag_t tag;
  92         bus_dmamap_t map;
  93         struct usb_page *page_start;
  94 #endif
  95         struct usb_dma_parent_tag *tag_parent;  /* always set */
  96         void   *buffer;                 /* virtual buffer pointer */
  97 #if USB_HAVE_BUSDMA
  98         usb_size_t page_offset_buf;
  99         usb_size_t page_offset_end;
 100         uint8_t isread:1;               /* set if we are currently reading
 101                                          * from the memory. Else write. */
 102         uint8_t ismultiseg:1;           /* set if we can have multiple
 103                                          * segments */
 104 #endif
 105 };
 106
 107 /*
 108  * The following structure describes the parent USB DMA tag.
 109  */
 110 #if USB_HAVE_BUSDMA
 111 struct usb_dma_parent_tag {
 112         struct cv cv[1];                /* internal condition variable */
 113         bus_dma_tag_t tag;              /* always set */
 114
 115         struct mtx *mtx;                /* private mutex, always set */
 116         usb_dma_callback_t *func;       /* load complete callback function */
 117         struct usb_dma_tag *utag_first;/* pointer to first USB DMA tag */
 118         uint8_t dma_error;              /* set if DMA load operation failed */
 119         uint8_t dma_bits;               /* number of DMA address lines */
 120         uint8_t utag_max;               /* number of USB DMA tags */
 121 };
 122 #else
 123 struct usb_dma_parent_tag {};           /* empty struct */
 124 #endif
 125
 126 /*
 127  * The following structure describes an USB DMA tag.
 128  */
 129 #if USB_HAVE_BUSDMA
 130 struct usb_dma_tag {
 131         struct usb_dma_parent_tag *tag_parent;
 132         bus_dma_tag_t tag;
 133         usb_size_t align;
 134         usb_size_t size;
 135 };
 136 #else
 137 struct usb_dma_tag {};                  /* empty struct */
 138 #endif
 139
 140 /* function prototypes */
 141
 142 int     usb_uiomove(struct usb_page_cache *pc, struct uio *uio,
 143             usb_frlength_t pc_offset, usb_frlength_t len);
 144 struct usb_dma_tag *usb_dma_tag_find(struct usb_dma_parent_tag *udpt,
 145             usb_size_t size, usb_size_t align);
 146 uint8_t usb_pc_alloc_mem(struct usb_page_cache *pc, struct usb_page *pg,
 147             usb_size_t size, usb_size_t align);
 148 uint8_t usb_pc_dmamap_create(struct usb_page_cache *pc, usb_size_t size);
 149 uint8_t usb_pc_load_mem(struct usb_page_cache *pc, usb_size_t size,
 150             uint8_t sync);
 151 void    usb_bdma_done_event(struct usb_dma_parent_tag *udpt);
 152 void    usb_bdma_post_sync(struct usb_xfer *xfer);
 153 void    usb_bdma_pre_sync(struct usb_xfer *xfer);
 154 void    usb_bdma_work_loop(struct usb_xfer_queue *pq);
 155 void    usb_dma_tag_setup(struct usb_dma_parent_tag *udpt,
 156             struct usb_dma_tag *udt, bus_dma_tag_t dmat, struct mtx *mtx,
 157             usb_dma_callback_t *func, uint8_t ndmabits, uint8_t nudt);
 158 void    usb_dma_tag_unsetup(struct usb_dma_parent_tag *udpt);
 159 void    usb_pc_cpu_flush(struct usb_page_cache *pc);
 160 void    usb_pc_cpu_invalidate(struct usb_page_cache *pc);
 161 void    usb_pc_dmamap_destroy(struct usb_page_cache *pc);
 162 void    usb_pc_free_mem(struct usb_page_cache *pc);
 163 uint8_t usb_pc_buffer_is_aligned(struct usb_page_cache *pc,
 164             usb_frlength_t offset, usb_frlength_t len,
 165             usb_frlength_t mask);
 166
 167 #endif                                  /* _USB_BUSDMA_H_ */