u-boot/include/dma-uclass.h
Álvaro Fernández Rojas 10b4dc5208 dma: move dma_ops to dma-uclass.h
Move dma_ops to a separate header file, following other uclass
implementations. While doing so, this patch also improves dma_ops
documentation.

Reviewed-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
Signed-off-by: Álvaro Fernández Rojas <noltari@gmail.com>
Signed-off-by: Grygorii Strashko <grygorii.strashko@ti.com>
2018-12-07 08:13:45 -05:00

40 lines
1.0 KiB
C

/* SPDX-License-Identifier: GPL-2.0+ */
/*
* Copyright (C) 2018 Álvaro Fernández Rojas <noltari@gmail.com>
* Copyright (C) 2015 Texas Instruments Incorporated <www.ti.com>
* Written by Mugunthan V N <mugunthanvnm@ti.com>
*
*/
#ifndef _DMA_UCLASS_H
#define _DMA_UCLASS_H
/* See dma.h for background documentation. */
#include <dma.h>
/*
* struct dma_ops - Driver model DMA operations
*
* The uclass interface is implemented by all DMA devices which use
* driver model.
*/
struct dma_ops {
/**
* transfer() - Issue a DMA transfer. The implementation must
* wait until the transfer is done.
*
* @dev: The DMA device
* @direction: direction of data transfer (should be one from
* enum dma_direction)
* @dst: The destination pointer.
* @src: The source pointer.
* @len: Length of the data to be copied (number of bytes).
* @return zero on success, or -ve error code.
*/
int (*transfer)(struct udevice *dev, int direction, void *dst,
void *src, size_t len);
};
#endif /* _DMA_UCLASS_H */