[deliverable/linux.git] / include / linux / shdma-base.h

/*
 * Dmaengine driver base library for DMA controllers, found on SH-based SoCs
 *
 * extracted from shdma.c and headers
 *
 * Copyright (C) 2011-2012 Guennadi Liakhovetski <g.liakhovetski@gmx.de>
 * Copyright (C) 2009 Nobuhiro Iwamatsu <iwamatsu.nobuhiro@renesas.com>
 * Copyright (C) 2009 Renesas Solutions, Inc. All rights reserved.
 * Copyright (C) 2007 Freescale Semiconductor, Inc. All rights reserved.
 *
 * This is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 */

#ifndef SHDMA_BASE_H
#define SHDMA_BASE_H

#include <linux/dmaengine.h>
#include <linux/interrupt.h>
#include <linux/list.h>
#include <linux/types.h>

/**
 * shdma_pm_state - DMA channel PM state
 * SHDMA_PM_ESTABLISHED:	either idle or during data transfer
 * SHDMA_PM_BUSY:		during the transfer preparation, when we have to
 *				drop the lock temporarily
 * SHDMA_PM_PENDING:	transfers pending
 */
enum shdma_pm_state {
	SHDMA_PM_ESTABLISHED,
	SHDMA_PM_BUSY,
	SHDMA_PM_PENDING,
};

struct device;

/*
 * Drivers, using this library are expected to embed struct shdma_dev,
 * struct shdma_chan, struct shdma_desc, and struct shdma_slave
 * in their respective device, channel, descriptor and slave objects.
 */

struct shdma_slave {
	int slave_id;
};

struct shdma_desc {
	struct list_head node;
	struct dma_async_tx_descriptor async_tx;
	enum dma_transfer_direction direction;
	size_t partial;
	dma_cookie_t cookie;
	int chunks;
	int mark;
};

struct shdma_chan {
	spinlock_t chan_lock;		/* Channel operation lock */
	struct list_head ld_queue;	/* Link descriptors queue */
	struct list_head ld_free;	/* Free link descriptors */
	struct dma_chan dma_chan;	/* DMA channel */
	struct device *dev;		/* Channel device */
	void *desc;			/* buffer for descriptor array */
	int desc_num;			/* desc count */
	size_t max_xfer_len;		/* max transfer length */
	int id;				/* Raw id of this channel */
	int irq;			/* Channel IRQ */
	int slave_id;			/* Client ID for slave DMA */
	int hw_req;			/* DMA request line for slave DMA - same
					 * as MID/RID, used with DT */
	enum shdma_pm_state pm_state;
};

/**
 * struct shdma_ops - simple DMA driver operations
 * desc_completed:	return true, if this is the descriptor, that just has
 *			completed (atomic)
 * halt_channel:	stop DMA channel operation (atomic)
 * channel_busy:	return true, if the channel is busy (atomic)
 * slave_addr:		return slave DMA address
 * desc_setup:		set up the hardware specific descriptor portion (atomic)
 * set_slave:		bind channel to a slave
 * setup_xfer:		configure channel hardware for operation (atomic)
 * start_xfer:		start the DMA transfer (atomic)
 * embedded_desc:	return Nth struct shdma_desc pointer from the
 *			descriptor array
 * chan_irq:		process channel IRQ, return true if a transfer has
 *			completed (atomic)
 */
struct shdma_ops {
	bool (*desc_completed)(struct shdma_chan *, struct shdma_desc *);
	void (*halt_channel)(struct shdma_chan *);
	bool (*channel_busy)(struct shdma_chan *);
	dma_addr_t (*slave_addr)(struct shdma_chan *);
	int (*desc_setup)(struct shdma_chan *, struct shdma_desc *,
			  dma_addr_t, dma_addr_t, size_t *);
	int (*set_slave)(struct shdma_chan *, int, dma_addr_t, bool);
	void (*setup_xfer)(struct shdma_chan *, int);
	void (*start_xfer)(struct shdma_chan *, struct shdma_desc *);
	struct shdma_desc *(*embedded_desc)(void *, int);
	bool (*chan_irq)(struct shdma_chan *, int);
	size_t (*get_partial)(struct shdma_chan *, struct shdma_desc *);
};

struct shdma_dev {
	struct dma_device dma_dev;
	struct shdma_chan **schan;
	const struct shdma_ops *ops;
	size_t desc_size;
};

#define shdma_for_each_chan(c, d, i) for (i = 0, c = (d)->schan[0]; \
				i < (d)->dma_dev.chancnt; c = (d)->schan[++i])

int shdma_request_irq(struct shdma_chan *, int,
			   unsigned long, const char *);
bool shdma_reset(struct shdma_dev *sdev);
void shdma_chan_probe(struct shdma_dev *sdev,
			   struct shdma_chan *schan, int id);
void shdma_chan_remove(struct shdma_chan *schan);
int shdma_init(struct device *dev, struct shdma_dev *sdev,
		    int chan_num);
void shdma_cleanup(struct shdma_dev *sdev);
#if IS_ENABLED(CONFIG_SH_DMAE_BASE)
bool shdma_chan_filter(struct dma_chan *chan, void *arg);
#else
#define shdma_chan_filter NULL
#endif

#endif
Commit	Line	Data
9a7b8e00 GL	1	/*
	2	* Dmaengine driver base library for DMA controllers, found on SH-based SoCs
	3	*
	4	* extracted from shdma.c and headers
	5	*
	6	* Copyright (C) 2011-2012 Guennadi Liakhovetski <g.liakhovetski@gmx.de>
	7	* Copyright (C) 2009 Nobuhiro Iwamatsu <iwamatsu.nobuhiro@renesas.com>
	8	* Copyright (C) 2009 Renesas Solutions, Inc. All rights reserved.
	9	* Copyright (C) 2007 Freescale Semiconductor, Inc. All rights reserved.
	10	*
	11	* This is free software; you can redistribute it and/or modify
	12	* it under the terms of version 2 of the GNU General Public License as
	13	* published by the Free Software Foundation.
	14	*/
	15
	16	#ifndef SHDMA_BASE_H
	17	#define SHDMA_BASE_H
	18
	19	#include <linux/dmaengine.h>
	20	#include <linux/interrupt.h>
	21	#include <linux/list.h>
	22	#include <linux/types.h>
	23
	24	/**
	25	* shdma_pm_state - DMA channel PM state
	26	* SHDMA_PM_ESTABLISHED: either idle or during data transfer
	27	* SHDMA_PM_BUSY: during the transfer preparation, when we have to
	28	* drop the lock temporarily
	29	* SHDMA_PM_PENDING: transfers pending
	30	*/
	31	enum shdma_pm_state {
	32	SHDMA_PM_ESTABLISHED,
	33	SHDMA_PM_BUSY,
	34	SHDMA_PM_PENDING,
	35	};
	36
	37	struct device;
	38
	39	/*
	40	* Drivers, using this library are expected to embed struct shdma_dev,
	41	* struct shdma_chan, struct shdma_desc, and struct shdma_slave
	42	* in their respective device, channel, descriptor and slave objects.
	43	*/
	44
	45	struct shdma_slave {
c2cdb7e4	46	int slave_id;
9a7b8e00 GL	47	};
	48
	49	struct shdma_desc {
	50	struct list_head node;
	51	struct dma_async_tx_descriptor async_tx;
	52	enum dma_transfer_direction direction;
4f46f8ac	53	size_t partial;
9a7b8e00 GL	54	dma_cookie_t cookie;
	55	int chunks;
	56	int mark;
	57	};
	58
	59	struct shdma_chan {
	60	spinlock_t chan_lock; /* Channel operation lock */
	61	struct list_head ld_queue; /* Link descriptors queue */
	62	struct list_head ld_free; /* Free link descriptors */
	63	struct dma_chan dma_chan; /* DMA channel */
	64	struct device dev; / Channel device */
	65	void desc; / buffer for descriptor array */
	66	int desc_num; /* desc count */
	67	size_t max_xfer_len; /* max transfer length */
	68	int id; /* Raw id of this channel */
	69	int irq; /* Channel IRQ */
c2cdb7e4	70	int slave_id; /* Client ID for slave DMA */
67eacc15 GL	71	int hw_req; /* DMA request line for slave DMA - same
67eacc15 GL	72	* as MID/RID, used with DT */
9a7b8e00 GL	73	enum shdma_pm_state pm_state;
	74	};
	75
	76	/**
	77	* struct shdma_ops - simple DMA driver operations
	78	* desc_completed: return true, if this is the descriptor, that just has
	79	* completed (atomic)
	80	* halt_channel: stop DMA channel operation (atomic)
	81	* channel_busy: return true, if the channel is busy (atomic)
	82	* slave_addr: return slave DMA address
	83	* desc_setup: set up the hardware specific descriptor portion (atomic)
	84	* set_slave: bind channel to a slave
	85	* setup_xfer: configure channel hardware for operation (atomic)
	86	* start_xfer: start the DMA transfer (atomic)
	87	* embedded_desc: return Nth struct shdma_desc pointer from the
	88	* descriptor array
	89	* chan_irq: process channel IRQ, return true if a transfer has
	90	* completed (atomic)
	91	*/
	92	struct shdma_ops {
	93	bool (desc_completed)(struct shdma_chan , struct shdma_desc *);
	94	void (halt_channel)(struct shdma_chan );
	95	bool (channel_busy)(struct shdma_chan );
	96	dma_addr_t (slave_addr)(struct shdma_chan );
	97	int (desc_setup)(struct shdma_chan , struct shdma_desc *,
	98	dma_addr_t, dma_addr_t, size_t *);
4981c4dc	99	int (set_slave)(struct shdma_chan , int, dma_addr_t, bool);
c2cdb7e4	100	void (setup_xfer)(struct shdma_chan , int);
9a7b8e00 GL	101	void (start_xfer)(struct shdma_chan , struct shdma_desc *);
	102	struct shdma_desc (embedded_desc)(void *, int);
	103	bool (chan_irq)(struct shdma_chan , int);
4f46f8ac	104	size_t (get_partial)(struct shdma_chan , struct shdma_desc *);
9a7b8e00 GL	105	};
	106
	107	struct shdma_dev {
	108	struct dma_device dma_dev;
	109	struct shdma_chan **schan;
	110	const struct shdma_ops *ops;
	111	size_t desc_size;
	112	};
	113
	114	#define shdma_for_each_chan(c, d, i) for (i = 0, c = (d)->schan[0]; \
	115	i < (d)->dma_dev.chancnt; c = (d)->schan[++i])
	116
	117	int shdma_request_irq(struct shdma_chan *, int,
	118	unsigned long, const char *);
9a7b8e00 GL	119	bool shdma_reset(struct shdma_dev *sdev);
	120	void shdma_chan_probe(struct shdma_dev *sdev,
	121	struct shdma_chan *schan, int id);
	122	void shdma_chan_remove(struct shdma_chan *schan);
	123	int shdma_init(struct device dev, struct shdma_dev sdev,
	124	int chan_num);
	125	void shdma_cleanup(struct shdma_dev *sdev);
ab116a4d	126	#if IS_ENABLED(CONFIG_SH_DMAE_BASE)
d0951a23	127	bool shdma_chan_filter(struct dma_chan chan, void arg);
ab116a4d GL	128	#else
	129	#define shdma_chan_filter NULL
	130	#endif
9a7b8e00 GL	131
9a7b8e00 GL	132	#endif