xref: /freebsd/sys/dev/xdma/xdma_if.m (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)

#-
# Copyright (c) 2016-2019 Ruslan Bukin <br@bsdpad.com>
# All rights reserved.
#
# This software was developed by SRI International and the University of
# Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
# ("CTSRD"), as part of the DARPA CRASH research programme.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#

#include "opt_platform.h"

#include <sys/malloc.h>

#include <machine/bus.h>

#ifdef FDT
#include <dev/fdt/fdt_common.h>
#include <dev/ofw/ofw_bus.h>
#include <dev/ofw/ofw_bus_subr.h>
#endif

#include <dev/xdma/xdma.h>

INTERFACE xdma;

#
# Request a transfer.
#
METHOD int channel_request {
	device_t		dev;
	struct xdma_channel	*xchan;
	struct xdma_request	*req;
};

#
# Prepare xDMA channel for a scatter-gather transfer.
#
METHOD int channel_prep_sg {
	device_t		dev;
	struct xdma_channel	*xchan;
};

#
# Query DMA engine driver for the amount of free entries
# (descriptors) are available.
#
METHOD int channel_capacity {
	device_t			dev;
	struct xdma_channel		*xchan;
	uint32_t			*capacity;
};

#
# Submit sglist list to DMA engine driver.
#
METHOD int channel_submit_sg {
	device_t			dev;
	struct xdma_channel		*xchan;
	struct xdma_sglist		*sg;
	uint32_t			sg_n;
};

#ifdef FDT
#
# Notify driver we have machine-dependend data.
#
METHOD int ofw_md_data {
	device_t dev;
	pcell_t *cells;
	int ncells;
	void **data;
};
#endif

#
# Allocate both virtual and harware channels.
#
METHOD int channel_alloc {
	device_t dev;
	struct xdma_channel *xchan;
};

#
# Free the real hardware channel.
#
METHOD int channel_free {
	device_t dev;
	struct xdma_channel *xchan;
};

#
# Begin, pause or terminate the channel operation.
#
METHOD int channel_control {
	device_t dev;
	struct xdma_channel *xchan;
	int cmd;
};

# IOMMU interface

#
# pmap is initialized
#
METHOD int iommu_init {
	device_t dev;
	struct xdma_iommu *xio;
};

#
# pmap is released
#
METHOD int iommu_release {
	device_t dev;
	struct xdma_iommu *xio;
};

#
# Mapping entered
#
METHOD int iommu_enter {
	device_t dev;
	struct xdma_iommu *xio;
	vm_offset_t va;
	vm_offset_t pa;
};

#
# Mapping removed
#
METHOD int iommu_remove {
	device_t dev;
	struct xdma_iommu *xio;
	vm_offset_t va;
};