sys/bus/u4b/usb_busdma.h

   1 /* $FreeBSD: head/sys/dev/usb/usb_busdma.h 266969 2014-06-02 07:08:34Z hselasky $ */
   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 <sys/bus.h>
  34
  35 #define USB_HAVE_BUSDMA 1
  36
  37 /* defines */
  38
  39 #define USB_PAGE_SIZE PAGE_SIZE         /* use system PAGE_SIZE */
  40
  41 #define USB_GET_DMA_TAG(dev) NULL       /* XXX */
  42
  43 /* structure prototypes */
  44
  45 struct usb_xfer_root;
  46 struct usb_dma_parent_tag;
  47 struct usb_dma_tag;
  48
  49 /*
  50  * The following typedef defines the USB DMA load done callback.
  51  */
  52
  53 typedef void (usb_dma_callback_t)(struct usb_dma_parent_tag *udpt);
  54
  55 /*
  56  * The following structure defines physical and non kernel virtual
  57  * address of a memory page having size USB_PAGE_SIZE.
  58  */
  59 struct usb_page {
  60 #if USB_HAVE_BUSDMA
  61         bus_size_t physaddr;
  62         void   *buffer;                 /* non Kernel Virtual Address */
  63 #endif
  64 };
  65
  66 /*
  67  * The following structure is used when needing the kernel virtual
  68  * pointer and the physical address belonging to an offset in an USB
  69  * page cache.
  70  */
  71 struct usb_page_search {
  72         void   *buffer;
  73 #if USB_HAVE_BUSDMA
  74         bus_size_t physaddr;
  75 #endif
  76         usb_size_t length;
  77 };
  78
  79 /*
  80  * The following structure is used to keep information about a DMA
  81  * memory allocation.
  82  */
  83 struct usb_page_cache {
  84
  85 #if USB_HAVE_BUSDMA
  86         bus_dma_tag_t tag;
  87         bus_dmamap_t map;
  88         struct usb_page *page_start;
  89 #endif
  90         struct usb_dma_parent_tag *tag_parent;  /* always set */
  91         void   *buffer;                 /* virtual buffer pointer */
  92 #if USB_HAVE_BUSDMA
  93         usb_size_t page_offset_buf;
  94         usb_size_t page_offset_end;
  95         uint8_t isread:1;               /* set if we are currently reading
  96                                          * from the memory. Else write. */
  97         uint8_t ismultiseg:1;           /* set if we can have multiple
  98                                          * segments */
  99 #endif
 100 };
 101
 102 /*
 103  * The following structure describes the parent USB DMA tag.
 104  */
 105 #if USB_HAVE_BUSDMA
 106 struct usb_dma_parent_tag {
 107         struct cv cv[1];                /* internal condition variable */
 108         bus_dma_tag_t tag;              /* always set */
 109
 110         struct lock *lock;              /* private mutex, always set */
 111         usb_dma_callback_t *func;       /* load complete callback function */
 112         struct usb_dma_tag *utag_first;/* pointer to first USB DMA tag */
 113         uint8_t dma_error;              /* set if DMA load operation failed */
 114         uint8_t dma_bits;               /* number of DMA address lines */
 115         uint8_t utag_max;               /* number of USB DMA tags */
 116 };
 117 #else
 118 struct usb_dma_parent_tag {};           /* empty struct */
 119 #endif
 120
 121 /*
 122  * The following structure describes an USB DMA tag.
 123  */
 124 #if USB_HAVE_BUSDMA
 125 struct usb_dma_tag {
 126         struct usb_dma_parent_tag *tag_parent;
 127         bus_dma_tag_t tag;
 128         usb_size_t align;
 129         usb_size_t size;
 130 };
 131 #else
 132 struct usb_dma_tag {};                  /* empty struct */
 133 #endif
 134
 135 /* function prototypes */
 136
 137 int     usb_uiomove(struct usb_page_cache *pc, struct uio *uio,
 138             usb_frlength_t pc_offset, usb_frlength_t len);
 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 lock *lock,
 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
 159 #endif                                  /* _USB_BUSDMA_H_ */