sys/arm64/include/bus_dma_impl.h

   1 /*-
   2  * Copyright (c) 2013 The FreeBSD Foundation
   3  *
   4  * This software was developed by Konstantin Belousov <kib@FreeBSD.org>
   5  * under sponsorship from the FreeBSD Foundation.
   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 _MACHINE_BUS_DMA_IMPL_H_
  30 #define _MACHINE_BUS_DMA_IMPL_H_
  31
  32 struct bus_dma_tag_common {
  33         struct bus_dma_impl *impl;
  34         bus_size_t        alignment;
  35         bus_addr_t        boundary;
  36         bus_addr_t        lowaddr;
  37         bus_addr_t        highaddr;
  38         bus_size_t        maxsize;
  39         u_int             nsegments;
  40         bus_size_t        maxsegsz;
  41         int               flags;
  42         bus_dma_lock_t   *lockfunc;
  43         void             *lockfuncarg;
  44         int               domain;
  45 };
  46
  47 struct bus_dma_impl {
  48         int (*tag_create)(bus_dma_tag_t parent,
  49             bus_size_t alignment, bus_addr_t boundary, bus_addr_t lowaddr,
  50             bus_addr_t highaddr, bus_size_t maxsize, int nsegments,
  51             bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
  52             void *lockfuncarg, bus_dma_tag_t *dmat);
  53         int (*tag_destroy)(bus_dma_tag_t dmat);
  54         int (*tag_set_domain)(bus_dma_tag_t);
  55         bool (*id_mapped)(bus_dma_tag_t, vm_paddr_t, bus_size_t);
  56         int (*map_create)(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp);
  57         int (*map_destroy)(bus_dma_tag_t dmat, bus_dmamap_t map);
  58         int (*mem_alloc)(bus_dma_tag_t dmat, void** vaddr, int flags,
  59             bus_dmamap_t *mapp);
  60         void (*mem_free)(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map);
  61         int (*load_ma)(bus_dma_tag_t dmat, bus_dmamap_t map,
  62             struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags,
  63             bus_dma_segment_t *segs, int *segp);
  64         int (*load_phys)(bus_dma_tag_t dmat, bus_dmamap_t map,
  65             vm_paddr_t buf, bus_size_t buflen, int flags,
  66             bus_dma_segment_t *segs, int *segp);
  67         int (*load_buffer)(bus_dma_tag_t dmat, bus_dmamap_t map,
  68             void *buf, bus_size_t buflen, struct pmap *pmap, int flags,
  69             bus_dma_segment_t *segs, int *segp);
  70         void (*map_waitok)(bus_dma_tag_t dmat, bus_dmamap_t map,
  71             struct memdesc *mem, bus_dmamap_callback_t *callback,
  72             void *callback_arg);
  73         bus_dma_segment_t *(*map_complete)(bus_dma_tag_t dmat, bus_dmamap_t map,
  74             bus_dma_segment_t *segs, int nsegs, int error);
  75         void (*map_unload)(bus_dma_tag_t dmat, bus_dmamap_t map);
  76         void (*map_sync)(bus_dma_tag_t dmat, bus_dmamap_t map,
  77             bus_dmasync_op_t op);
  78 #ifdef KMSAN
  79         void (*load_kmsan)(bus_dmamap_t map, struct memdesc *mem);
  80 #endif
  81 };
  82
  83 int common_bus_dma_tag_create(struct bus_dma_tag_common *parent,
  84     bus_size_t alignment, bus_addr_t boundary, bus_addr_t lowaddr,
  85     bus_addr_t highaddr, bus_size_t maxsize, int nsegments,
  86     bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
  87     void *lockfuncarg, size_t sz, void **dmat);
  88
  89 extern struct bus_dma_impl bus_dma_bounce_impl;
  90
  91 #endif