1#- 2# Copyright (c) 2016-2019 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 43INTERFACE xdma; 44 45# 46# Request a transfer. 47# 48METHOD int channel_request { 49 device_t dev; 50 struct xdma_channel *xchan; 51 struct xdma_request *req; 52}; 53 54# 55# Prepare xDMA channel for a scatter-gather transfer. 56# 57METHOD int channel_prep_sg { 58 device_t dev; 59 struct xdma_channel *xchan; 60}; 61 62# 63# Query DMA engine driver for the amount of free entries 64# (descriptors) are available. 65# 66METHOD int channel_capacity { 67 device_t dev; 68 struct xdma_channel *xchan; 69 uint32_t *capacity; 70}; 71 72# 73# Submit sglist list to DMA engine driver. 74# 75METHOD int channel_submit_sg { 76 device_t dev; 77 struct xdma_channel *xchan; 78 struct xdma_sglist *sg; 79 uint32_t sg_n; 80}; 81 82# 83# Notify driver we have machine-dependend data. 84# 85METHOD int ofw_md_data { 86 device_t dev; 87 pcell_t *cells; 88 int ncells; 89 void **data; 90}; 91 92# 93# Allocate both virtual and harware channels. 94# 95METHOD int channel_alloc { 96 device_t dev; 97 struct xdma_channel *xchan; 98}; 99 100# 101# Free the real hardware channel. 102# 103METHOD int channel_free { 104 device_t dev; 105 struct xdma_channel *xchan; 106}; 107 108# 109# Begin, pause or terminate the channel operation. 110# 111METHOD int channel_control { 112 device_t dev; 113 struct xdma_channel *xchan; 114 int cmd; 115}; 116 117# IOMMU interface 118 119# 120# pmap is initialized 121# 122METHOD int iommu_init { 123 device_t dev; 124 struct xdma_iommu *xio; 125}; 126 127# 128# pmap is released 129# 130METHOD int iommu_release { 131 device_t dev; 132 struct xdma_iommu *xio; 133}; 134 135# 136# Mapping entered 137# 138METHOD int iommu_enter { 139 device_t dev; 140 struct xdma_iommu *xio; 141 vm_offset_t va; 142 vm_offset_t pa; 143}; 144 145# 146# Mapping removed 147# 148METHOD int iommu_remove { 149 device_t dev; 150 struct xdma_iommu *xio; 151 vm_offset_t va; 152}; 153