Changeset View
Changeset View
Standalone View
Standalone View
sys/dev/ioat/ioat.h
- This file was added.
/*- | |||||
* Copyright (C) 2012 Intel Corporation | |||||
* All rights reserved. | |||||
* | |||||
* 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. | |||||
*/ | |||||
#ifndef __IOAT_H__ | |||||
#define __IOAT_H__ | |||||
#include <sys/param.h> | |||||
#include <machine/bus.h> | |||||
/* | |||||
* This file defines the public interface to the IOAT driver. | |||||
*/ | |||||
/* | |||||
* Enables an interrupt for this operation. Typically, you would only enable | |||||
* this on the last operation in a group | |||||
*/ | |||||
#define DMA_INT_EN 0x1 | |||||
#define DMA_ALL_FLAGS (DMA_INT_EN) | |||||
typedef void *bus_dmaengine_t; | |||||
struct bus_dmadesc; | |||||
typedef void (*bus_dmaengine_callback_t)(void *arg); | |||||
/* | |||||
* Called first to acquire a reference to the DMA channel | |||||
*/ | |||||
bus_dmaengine_t ioat_get_dmaengine(uint32_t channel_index); | |||||
/* | |||||
* Acquire must be called before issuing an operation to perform. Release is | |||||
* called after. Multiple operations can be issued within the context of one | |||||
* acquire and release | |||||
*/ | |||||
void ioat_acquire(bus_dmaengine_t dmaengine); | |||||
void ioat_release(bus_dmaengine_t dmaengine); | |||||
/* Issues the copy data operation */ | |||||
struct bus_dmadesc *ioat_copy(bus_dmaengine_t dmaengine, bus_addr_t dst, | |||||
bus_addr_t src, bus_size_t len, bus_dmaengine_callback_t callback_fn, | |||||
void *callback_arg, uint32_t flags); | |||||
/* | |||||
* Issues a null operation. This issues the operation to the hardware, but the | |||||
* hardware doesn't do anything with it. | |||||
*/ | |||||
struct bus_dmadesc *ioat_null(bus_dmaengine_t dmaengine, | |||||
bus_dmaengine_callback_t callback_fn, void *callback_arg, uint32_t flags); | |||||
#endif /* __IOAT_H__ */ | |||||