[deliverable/linux.git] / include / linux / dw_dmac.h

/*
 * Driver for the Synopsys DesignWare DMA Controller
 *
 * Copyright (C) 2007 Atmel Corporation
 * Copyright (C) 2010-2011 ST Microelectronics
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#ifndef DW_DMAC_H
#define DW_DMAC_H

#include <linux/dmaengine.h>

/**
 * struct dw_dma_slave - Controller-specific information about a slave
 *
 * @dma_dev: required DMA master device. Depricated.
 * @bus_id: name of this device channel, not just a device name since
 *          devices may have more than one channel e.g. "foo_tx"
 * @cfg_hi: Platform-specific initializer for the CFG_HI register
 * @cfg_lo: Platform-specific initializer for the CFG_LO register
 * @src_master: src master for transfers on allocated channel.
 * @dst_master: dest master for transfers on allocated channel.
 */
struct dw_dma_slave {
	struct device		*dma_dev;
	u32			cfg_hi;
	u32			cfg_lo;
	u8			src_master;
	u8			dst_master;
};

/**
 * struct dw_dma_platform_data - Controller configuration parameters
 * @nr_channels: Number of channels supported by hardware (max 8)
 * @is_private: The device channels should be marked as private and not for
 *	by the general purpose DMA channel allocator.
 * @chan_allocation_order: Allocate channels starting from 0 or 7
 * @chan_priority: Set channel priority increasing from 0 to 7 or 7 to 0.
 * @block_size: Maximum block size supported by the controller
 * @nr_masters: Number of AHB masters supported by the controller
 * @data_width: Maximum data width supported by hardware per AHB master
 *		(0 - 8bits, 1 - 16bits, ..., 5 - 256bits)
 */
struct dw_dma_platform_data {
	unsigned int	nr_channels;
	bool		is_private;
#define CHAN_ALLOCATION_ASCENDING	0	/* zero to seven */
#define CHAN_ALLOCATION_DESCENDING	1	/* seven to zero */
	unsigned char	chan_allocation_order;
#define CHAN_PRIORITY_ASCENDING		0	/* chan0 highest */
#define CHAN_PRIORITY_DESCENDING	1	/* chan7 highest */
	unsigned char	chan_priority;
	unsigned short	block_size;
	unsigned char	nr_masters;
	unsigned char	data_width[4];
};

/* bursts size */
enum dw_dma_msize {
	DW_DMA_MSIZE_1,
	DW_DMA_MSIZE_4,
	DW_DMA_MSIZE_8,
	DW_DMA_MSIZE_16,
	DW_DMA_MSIZE_32,
	DW_DMA_MSIZE_64,
	DW_DMA_MSIZE_128,
	DW_DMA_MSIZE_256,
};

/* Platform-configurable bits in CFG_HI */
#define DWC_CFGH_FCMODE		(1 << 0)
#define DWC_CFGH_FIFO_MODE	(1 << 1)
#define DWC_CFGH_PROTCTL(x)	((x) << 2)
#define DWC_CFGH_SRC_PER(x)	((x) << 7)
#define DWC_CFGH_DST_PER(x)	((x) << 11)

/* Platform-configurable bits in CFG_LO */
#define DWC_CFGL_LOCK_CH_XFER	(0 << 12)	/* scope of LOCK_CH */
#define DWC_CFGL_LOCK_CH_BLOCK	(1 << 12)
#define DWC_CFGL_LOCK_CH_XACT	(2 << 12)
#define DWC_CFGL_LOCK_BUS_XFER	(0 << 14)	/* scope of LOCK_BUS */
#define DWC_CFGL_LOCK_BUS_BLOCK	(1 << 14)
#define DWC_CFGL_LOCK_BUS_XACT	(2 << 14)
#define DWC_CFGL_LOCK_CH	(1 << 15)	/* channel lockout */
#define DWC_CFGL_LOCK_BUS	(1 << 16)	/* busmaster lockout */
#define DWC_CFGL_HS_DST_POL	(1 << 18)	/* dst handshake active low */
#define DWC_CFGL_HS_SRC_POL	(1 << 19)	/* src handshake active low */

/* DMA API extensions */
struct dw_cyclic_desc {
	struct dw_desc	**desc;
	unsigned long	periods;
	void		(*period_callback)(void *param);
	void		*period_callback_param;
};

struct dw_cyclic_desc *dw_dma_cyclic_prep(struct dma_chan *chan,
		dma_addr_t buf_addr, size_t buf_len, size_t period_len,
		enum dma_transfer_direction direction);
void dw_dma_cyclic_free(struct dma_chan *chan);
int dw_dma_cyclic_start(struct dma_chan *chan);
void dw_dma_cyclic_stop(struct dma_chan *chan);

dma_addr_t dw_dma_get_src_addr(struct dma_chan *chan);

dma_addr_t dw_dma_get_dst_addr(struct dma_chan *chan);

#endif /* DW_DMAC_H */
Commit	Line	Data
3bfb1d20	1	/*
dd5720b3	2	* Driver for the Synopsys DesignWare DMA Controller
3bfb1d20 HS	3	*
3bfb1d20 HS	4	* Copyright (C) 2007 Atmel Corporation
aecb7b64	5	* Copyright (C) 2010-2011 ST Microelectronics
3bfb1d20 HS	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*/
	11	#ifndef DW_DMAC_H
	12	#define DW_DMAC_H
	13
	14	#include <linux/dmaengine.h>
	15
a9ddb575 VK	16	/**
	17	* struct dw_dma_slave - Controller-specific information about a slave
	18	*
	19	* @dma_dev: required DMA master device. Depricated.
	20	* @bus_id: name of this device channel, not just a device name since
	21	* devices may have more than one channel e.g. "foo_tx"
	22	* @cfg_hi: Platform-specific initializer for the CFG_HI register
	23	* @cfg_lo: Platform-specific initializer for the CFG_LO register
	24	* @src_master: src master for transfers on allocated channel.
	25	* @dst_master: dest master for transfers on allocated channel.
	26	*/
	27	struct dw_dma_slave {
	28	struct device *dma_dev;
a9ddb575 VK	29	u32 cfg_hi;
	30	u32 cfg_lo;
	31	u8 src_master;
	32	u8 dst_master;
	33	};
	34
3bfb1d20 HS	35	/**
	36	* struct dw_dma_platform_data - Controller configuration parameters
	37	* @nr_channels: Number of channels supported by hardware (max 8)
95ea759e JI	38	* @is_private: The device channels should be marked as private and not for
95ea759e JI	39	* by the general purpose DMA channel allocator.
177d2bf5 VK	40	* @chan_allocation_order: Allocate channels starting from 0 or 7
177d2bf5 VK	41	* @chan_priority: Set channel priority increasing from 0 to 7 or 7 to 0.
4a63a8b3	42	* @block_size: Maximum block size supported by the controller
a0982004 AS	43	* @nr_masters: Number of AHB masters supported by the controller
	44	* @data_width: Maximum data width supported by hardware per AHB master
	45	* (0 - 8bits, 1 - 16bits, ..., 5 - 256bits)
3bfb1d20 HS	46	*/
	47	struct dw_dma_platform_data {
	48	unsigned int nr_channels;
95ea759e	49	bool is_private;
b0c3130d VK	50	#define CHAN_ALLOCATION_ASCENDING 0 /* zero to seven */
	51	#define CHAN_ALLOCATION_DESCENDING 1 /* seven to zero */
	52	unsigned char chan_allocation_order;
93317e8e VK	53	#define CHAN_PRIORITY_ASCENDING 0 /* chan0 highest */
	54	#define CHAN_PRIORITY_DESCENDING 1 /* chan7 highest */
	55	unsigned char chan_priority;
4a63a8b3	56	unsigned short block_size;
a0982004 AS	57	unsigned char nr_masters;
a0982004 AS	58	unsigned char data_width[4];
3bfb1d20 HS	59	};
3bfb1d20 HS	60
ee66509d VK	61	/* bursts size */
	62	enum dw_dma_msize {
	63	DW_DMA_MSIZE_1,
	64	DW_DMA_MSIZE_4,
	65	DW_DMA_MSIZE_8,
	66	DW_DMA_MSIZE_16,
	67	DW_DMA_MSIZE_32,
	68	DW_DMA_MSIZE_64,
	69	DW_DMA_MSIZE_128,
	70	DW_DMA_MSIZE_256,
	71	};
	72
3bfb1d20 HS	73	/* Platform-configurable bits in CFG_HI */
	74	#define DWC_CFGH_FCMODE (1 << 0)
	75	#define DWC_CFGH_FIFO_MODE (1 << 1)
	76	#define DWC_CFGH_PROTCTL(x) ((x) << 2)
	77	#define DWC_CFGH_SRC_PER(x) ((x) << 7)
	78	#define DWC_CFGH_DST_PER(x) ((x) << 11)
	79
	80	/* Platform-configurable bits in CFG_LO */
3bfb1d20 HS	81	#define DWC_CFGL_LOCK_CH_XFER (0 << 12) /* scope of LOCK_CH */
	82	#define DWC_CFGL_LOCK_CH_BLOCK (1 << 12)
	83	#define DWC_CFGL_LOCK_CH_XACT (2 << 12)
	84	#define DWC_CFGL_LOCK_BUS_XFER (0 << 14) /* scope of LOCK_BUS */
	85	#define DWC_CFGL_LOCK_BUS_BLOCK (1 << 14)
	86	#define DWC_CFGL_LOCK_BUS_XACT (2 << 14)
	87	#define DWC_CFGL_LOCK_CH (1 << 15) /* channel lockout */
	88	#define DWC_CFGL_LOCK_BUS (1 << 16) /* busmaster lockout */
	89	#define DWC_CFGL_HS_DST_POL (1 << 18) /* dst handshake active low */
	90	#define DWC_CFGL_HS_SRC_POL (1 << 19) /* src handshake active low */
	91
d9de4519 HCE	92	/* DMA API extensions */
	93	struct dw_cyclic_desc {
	94	struct dw_desc **desc;
	95	unsigned long periods;
	96	void (period_callback)(void param);
	97	void *period_callback_param;
	98	};
	99
	100	struct dw_cyclic_desc dw_dma_cyclic_prep(struct dma_chan chan,
	101	dma_addr_t buf_addr, size_t buf_len, size_t period_len,
db8196df	102	enum dma_transfer_direction direction);
d9de4519 HCE	103	void dw_dma_cyclic_free(struct dma_chan *chan);
	104	int dw_dma_cyclic_start(struct dma_chan *chan);
	105	void dw_dma_cyclic_stop(struct dma_chan *chan);
	106
	107	dma_addr_t dw_dma_get_src_addr(struct dma_chan *chan);
	108
	109	dma_addr_t dw_dma_get_dst_addr(struct dma_chan *chan);
	110
3bfb1d20	111	#endif /* DW_DMAC_H */