sys/x86/include/busdma_impl.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2013 The FreeBSD Foundation
   5  * All rights reserved.
   6  *
   7  * This software was developed by Konstantin Belousov <kib@FreeBSD.org>
   8  * under sponsorship from the FreeBSD Foundation.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef __X86_BUSDMA_IMPL_H
  35 #define __X86_BUSDMA_IMPL_H
  36
  37 struct bus_dma_tag_common {
  38         struct bus_dma_impl *impl;
  39         struct bus_dma_tag_common *parent;
  40         bus_size_t        alignment;
  41         bus_addr_t        boundary;
  42         bus_addr_t        lowaddr;
  43         bus_addr_t        highaddr;
  44         bus_dma_filter_t *filter;
  45         void             *filterarg;
  46         bus_size_t        maxsize;
  47         u_int             nsegments;
  48         bus_size_t        maxsegsz;
  49         int               flags;
  50         bus_dma_lock_t   *lockfunc;
  51         void             *lockfuncarg;
  52         int               ref_count;
  53         int               domain;
  54 };
  55
  56 struct bus_dma_impl {
  57         int (*tag_create)(bus_dma_tag_t parent,
  58             bus_size_t alignment, bus_addr_t boundary, bus_addr_t lowaddr,
  59             bus_addr_t highaddr, bus_dma_filter_t *filter,
  60             void *filterarg, bus_size_t maxsize, int nsegments,
  61             bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
  62             void *lockfuncarg, bus_dma_tag_t *dmat);
  63         int (*tag_destroy)(bus_dma_tag_t dmat);
  64         int (*tag_set_domain)(bus_dma_tag_t);
  65         int (*map_create)(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp);
  66         int (*map_destroy)(bus_dma_tag_t dmat, bus_dmamap_t map);
  67         int (*mem_alloc)(bus_dma_tag_t dmat, void** vaddr, int flags,
  68             bus_dmamap_t *mapp);
  69         void (*mem_free)(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map);
  70         int (*load_ma)(bus_dma_tag_t dmat, bus_dmamap_t map,
  71             struct vm_page **ma, bus_size_t tlen, int ma_offs, int flags,
  72             bus_dma_segment_t *segs, int *segp);
  73         int (*load_phys)(bus_dma_tag_t dmat, bus_dmamap_t map,
  74             vm_paddr_t buf, bus_size_t buflen, int flags,
  75             bus_dma_segment_t *segs, int *segp);
  76         int (*load_buffer)(bus_dma_tag_t dmat, bus_dmamap_t map,
  77             void *buf, bus_size_t buflen, struct pmap *pmap, int flags,
  78             bus_dma_segment_t *segs, int *segp);
  79         void (*map_waitok)(bus_dma_tag_t dmat, bus_dmamap_t map,
  80             struct memdesc *mem, bus_dmamap_callback_t *callback,
  81             void *callback_arg);
  82         bus_dma_segment_t *(*map_complete)(bus_dma_tag_t dmat, bus_dmamap_t map,
  83             bus_dma_segment_t *segs, int nsegs, int error);
  84         void (*map_unload)(bus_dma_tag_t dmat, bus_dmamap_t map);
  85         void (*map_sync)(bus_dma_tag_t dmat, bus_dmamap_t map,
  86             bus_dmasync_op_t op);
  87 };
  88
  89 void bus_dma_dflt_lock(void *arg, bus_dma_lock_op_t op);
  90 int bus_dma_run_filter(struct bus_dma_tag_common *dmat, bus_addr_t paddr);
  91 int common_bus_dma_tag_create(struct bus_dma_tag_common *parent,
  92     bus_size_t alignment,
  93     bus_addr_t boundary, bus_addr_t lowaddr, bus_addr_t highaddr,
  94     bus_dma_filter_t *filter, void *filterarg, bus_size_t maxsize,
  95     int nsegments, bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
  96     void *lockfuncarg, size_t sz, void **dmat);
  97
  98 extern struct bus_dma_impl bus_dma_bounce_impl;
  99
 100 #endif