sys/dev/xdma/xdma_if.m

   1 #-
   2 # Copyright (c) 2016 Ruslan Bukin <br@bsdpad.com>
   3 # All rights reserved.
   4 #
   5 # This software was developed by SRI International and the University of
   6 # Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
   7 # ("CTSRD"), as part of the DARPA CRASH research programme.
   8 #
   9 # Redistribution and use in source and binary forms, with or without
  10 # modification, are permitted provided that the following conditions
  11 # are met:
  12 # 1. Redistributions of source code must retain the above copyright
  13 #    notice, this list of conditions and the following disclaimer.
  14 # 2. Redistributions in binary form must reproduce the above copyright
  15 #    notice, this list of conditions and the following disclaimer in the
  16 #    documentation and/or other materials provided with the distribution.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 # SUCH DAMAGE.
  29 #
  30 # $FreeBSD$
  31 #
  32
  33 #include <machine/bus.h>
  34
  35 #ifdef FDT
  36 #include <dev/fdt/fdt_common.h>
  37 #include <dev/ofw/ofw_bus.h>
  38 #include <dev/ofw/ofw_bus_subr.h>
  39 #endif
  40
  41 #include <dev/xdma/xdma.h>
  42
  43 INTERFACE xdma;
  44
  45 #
  46 # Prepare a channel for cyclic transfer.
  47 #
  48 METHOD int channel_prep_cyclic {
  49         device_t                dev;
  50         struct xdma_channel     *xchan;
  51 };
  52
  53 #
  54 # Prepare a channel for memcpy transfer.
  55 #
  56 METHOD int channel_prep_memcpy {
  57         device_t                dev;
  58         struct xdma_channel     *xchan;
  59 };
  60
  61 #
  62 # Notify driver we have machine-dependend data.
  63 #
  64 METHOD int ofw_md_data {
  65         device_t dev;
  66         pcell_t *cells;
  67         int ncells;
  68         void **data;
  69 };
  70
  71 #
  72 # Allocate both virtual and harware channels.
  73 #
  74 METHOD int channel_alloc {
  75         device_t dev;
  76         struct xdma_channel *xchan;
  77 };
  78
  79 #
  80 # Free the channel, including descriptors.
  81 #
  82 METHOD int channel_free {
  83         device_t dev;
  84         struct xdma_channel *xchan;
  85 };
  86
  87 #
  88 # Begin, pause or terminate the channel operation.
  89 #
  90 METHOD int channel_control {
  91         device_t dev;
  92         struct xdma_channel *xchan;
  93         int cmd;
  94 };