[net-next-2.6.git] / crypto / async_tx / async_tx.c

/*
 * core routines for the asynchronous memory transfer/transform api
 *
 * Copyright © 2006, Intel Corporation.
 *
 *	Dan Williams <dan.j.williams@intel.com>
 *
 *	with architecture considerations by:
 *	Neil Brown <neilb@suse.de>
 *	Jeff Garzik <jeff@garzik.org>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 *
 */
#include <linux/rculist.h>
#include <linux/kernel.h>
#include <linux/async_tx.h>

#ifdef CONFIG_DMA_ENGINE
static int __init async_tx_init(void)
{
	async_dmaengine_get();

	printk(KERN_INFO "async_tx: api initialized (async)\n");

	return 0;
}

static void __exit async_tx_exit(void)
{
	async_dmaengine_put();
}

module_init(async_tx_init);
module_exit(async_tx_exit);

/**
 * __async_tx_find_channel - find a channel to carry out the operation or let
 *	the transaction execute synchronously
 * @submit: transaction dependency and submission modifiers
 * @tx_type: transaction type
 */
struct dma_chan *
__async_tx_find_channel(struct async_submit_ctl *submit,
			enum dma_transaction_type tx_type)
{
	struct dma_async_tx_descriptor *depend_tx = submit->depend_tx;

	/* see if we can keep the chain on one channel */
	if (depend_tx &&
	    dma_has_cap(tx_type, depend_tx->chan->device->cap_mask))
		return depend_tx->chan;
	return async_dma_find_channel(tx_type);
}
EXPORT_SYMBOL_GPL(__async_tx_find_channel);
#endif


/**
 * async_tx_channel_switch - queue an interrupt descriptor with a dependency
 * 	pre-attached.
 * @depend_tx: the operation that must finish before the new operation runs
 * @tx: the new operation
 */
static void
async_tx_channel_switch(struct dma_async_tx_descriptor *depend_tx,
			struct dma_async_tx_descriptor *tx)
{
	struct dma_chan *chan = depend_tx->chan;
	struct dma_device *device = chan->device;
	struct dma_async_tx_descriptor *intr_tx = (void *) ~0;

	/* first check to see if we can still append to depend_tx */
	txd_lock(depend_tx);
	if (txd_parent(depend_tx) && depend_tx->chan == tx->chan) {
		txd_chain(depend_tx, tx);
		intr_tx = NULL;
	}
	txd_unlock(depend_tx);

	/* attached dependency, flush the parent channel */
	if (!intr_tx) {
		device->device_issue_pending(chan);
		return;
	}

	/* see if we can schedule an interrupt
	 * otherwise poll for completion
	 */
	if (dma_has_cap(DMA_INTERRUPT, device->cap_mask))
		intr_tx = device->device_prep_dma_interrupt(chan, 0);
	else
		intr_tx = NULL;

	if (intr_tx) {
		intr_tx->callback = NULL;
		intr_tx->callback_param = NULL;
		/* safe to chain outside the lock since we know we are
		 * not submitted yet
		 */
		txd_chain(intr_tx, tx);

		/* check if we need to append */
		txd_lock(depend_tx);
		if (txd_parent(depend_tx)) {
			txd_chain(depend_tx, intr_tx);
			async_tx_ack(intr_tx);
			intr_tx = NULL;
		}
		txd_unlock(depend_tx);

		if (intr_tx) {
			txd_clear_parent(intr_tx);
			intr_tx->tx_submit(intr_tx);
			async_tx_ack(intr_tx);
		}
		device->device_issue_pending(chan);
	} else {
		if (dma_wait_for_async_tx(depend_tx) == DMA_ERROR)
			panic("%s: DMA_ERROR waiting for depend_tx\n",
			      __func__);
		tx->tx_submit(tx);
	}
}


/**
 * submit_disposition - flags for routing an incoming operation
 * @ASYNC_TX_SUBMITTED: we were able to append the new operation under the lock
 * @ASYNC_TX_CHANNEL_SWITCH: when the lock is dropped schedule a channel switch
 * @ASYNC_TX_DIRECT_SUBMIT: when the lock is dropped submit directly
 *
 * while holding depend_tx->lock we must avoid submitting new operations
 * to prevent a circular locking dependency with drivers that already
 * hold a channel lock when calling async_tx_run_dependencies.
 */
enum submit_disposition {
	ASYNC_TX_SUBMITTED,
	ASYNC_TX_CHANNEL_SWITCH,
	ASYNC_TX_DIRECT_SUBMIT,
};

void
async_tx_submit(struct dma_chan *chan, struct dma_async_tx_descriptor *tx,
		struct async_submit_ctl *submit)
{
	struct dma_async_tx_descriptor *depend_tx = submit->depend_tx;

	tx->callback = submit->cb_fn;
	tx->callback_param = submit->cb_param;

	if (depend_tx) {
		enum submit_disposition s;

		/* sanity check the dependency chain:
		 * 1/ if ack is already set then we cannot be sure
		 * we are referring to the correct operation
		 * 2/ dependencies are 1:1 i.e. two transactions can
		 * not depend on the same parent
		 */
		BUG_ON(async_tx_test_ack(depend_tx) || txd_next(depend_tx) ||
		       txd_parent(tx));

		/* the lock prevents async_tx_run_dependencies from missing
		 * the setting of ->next when ->parent != NULL
		 */
		txd_lock(depend_tx);
		if (txd_parent(depend_tx)) {
			/* we have a parent so we can not submit directly
			 * if we are staying on the same channel: append
			 * else: channel switch
			 */
			if (depend_tx->chan == chan) {
				txd_chain(depend_tx, tx);
				s = ASYNC_TX_SUBMITTED;
			} else
				s = ASYNC_TX_CHANNEL_SWITCH;
		} else {
			/* we do not have a parent so we may be able to submit
			 * directly if we are staying on the same channel
			 */
			if (depend_tx->chan == chan)
				s = ASYNC_TX_DIRECT_SUBMIT;
			else
				s = ASYNC_TX_CHANNEL_SWITCH;
		}
		txd_unlock(depend_tx);

		switch (s) {
		case ASYNC_TX_SUBMITTED:
			break;
		case ASYNC_TX_CHANNEL_SWITCH:
			async_tx_channel_switch(depend_tx, tx);
			break;
		case ASYNC_TX_DIRECT_SUBMIT:
			txd_clear_parent(tx);
			tx->tx_submit(tx);
			break;
		}
	} else {
		txd_clear_parent(tx);
		tx->tx_submit(tx);
	}

	if (submit->flags & ASYNC_TX_ACK)
		async_tx_ack(tx);

	if (depend_tx)
		async_tx_ack(depend_tx);
}
EXPORT_SYMBOL_GPL(async_tx_submit);

/**
 * async_trigger_callback - schedules the callback function to be run
 * @submit: submission and completion parameters
 *
 * honored flags: ASYNC_TX_ACK
 *
 * The callback is run after any dependent operations have completed.
 */
struct dma_async_tx_descriptor *
async_trigger_callback(struct async_submit_ctl *submit)
{
	struct dma_chan *chan;
	struct dma_device *device;
	struct dma_async_tx_descriptor *tx;
	struct dma_async_tx_descriptor *depend_tx = submit->depend_tx;

	if (depend_tx) {
		chan = depend_tx->chan;
		device = chan->device;

		/* see if we can schedule an interrupt
		 * otherwise poll for completion
		 */
		if (device && !dma_has_cap(DMA_INTERRUPT, device->cap_mask))
			device = NULL;

		tx = device ? device->device_prep_dma_interrupt(chan, 0) : NULL;
	} else
		tx = NULL;

	if (tx) {
		pr_debug("%s: (async)\n", __func__);

		async_tx_submit(chan, tx, submit);
	} else {
		pr_debug("%s: (sync)\n", __func__);

		/* wait for any prerequisite operations */
		async_tx_quiesce(&submit->depend_tx);

		async_tx_sync_epilog(submit);
	}

	return tx;
}
EXPORT_SYMBOL_GPL(async_trigger_callback);

/**
 * async_tx_quiesce - ensure tx is complete and freeable upon return
 * @tx - transaction to quiesce
 */
void async_tx_quiesce(struct dma_async_tx_descriptor **tx)
{
	if (*tx) {
		/* if ack is already set then we cannot be sure
		 * we are referring to the correct operation
		 */
		BUG_ON(async_tx_test_ack(*tx));
		if (dma_wait_for_async_tx(*tx) == DMA_ERROR)
			panic("DMA_ERROR waiting for transaction\n");
		async_tx_ack(*tx);
		*tx = NULL;
	}
}
EXPORT_SYMBOL_GPL(async_tx_quiesce);

MODULE_AUTHOR("Intel Corporation");
MODULE_DESCRIPTION("Asynchronous Bulk Memory Transactions API");
MODULE_LICENSE("GPL");
Commit	Line	Data
9bc89cd8 DW	1	/*
	2	* core routines for the asynchronous memory transfer/transform api
	3	*
	4	* Copyright © 2006, Intel Corporation.
	5	*
	6	* Dan Williams <dan.j.williams@intel.com>
	7	*
	8	* with architecture considerations by:
	9	* Neil Brown <neilb@suse.de>
	10	* Jeff Garzik <jeff@garzik.org>
	11	*
	12	* This program is free software; you can redistribute it and/or modify it
	13	* under the terms and conditions of the GNU General Public License,
	14	* version 2, as published by the Free Software Foundation.
	15	*
	16	* This program is distributed in the hope it will be useful, but WITHOUT
	17	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	18	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	19	* more details.
	20	*
	21	* You should have received a copy of the GNU General Public License along with
	22	* this program; if not, write to the Free Software Foundation, Inc.,
	23	* 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
	24	*
	25	*/
82524746	26	#include <linux/rculist.h>
9bc89cd8 DW	27	#include <linux/kernel.h>
	28	#include <linux/async_tx.h>
	29
	30	#ifdef CONFIG_DMA_ENGINE
bec08513	31	static int __init async_tx_init(void)
9bc89cd8	32	{
729b5d1b	33	async_dmaengine_get();
9bc89cd8 DW	34
	35	printk(KERN_INFO "async_tx: api initialized (async)\n");
	36
	37	return 0;
9bc89cd8 DW	38	}
	39
	40	static void __exit async_tx_exit(void)
	41	{
729b5d1b	42	async_dmaengine_put();
9bc89cd8 DW	43	}
9bc89cd8 DW	44
af1f951e DW	45	module_init(async_tx_init);
	46	module_exit(async_tx_exit);
	47
9bc89cd8	48	/**
47437b2c	49	* __async_tx_find_channel - find a channel to carry out the operation or let
9bc89cd8	50	* the transaction execute synchronously
a08abd8c	51	* @submit: transaction dependency and submission modifiers
9bc89cd8 DW	52	* @tx_type: transaction type
	53	*/
	54	struct dma_chan *
a08abd8c DW	55	__async_tx_find_channel(struct async_submit_ctl *submit,
a08abd8c DW	56	enum dma_transaction_type tx_type)
9bc89cd8	57	{
a08abd8c DW	58	struct dma_async_tx_descriptor *depend_tx = submit->depend_tx;
a08abd8c DW	59
9bc89cd8 DW	60	/* see if we can keep the chain on one channel */
9bc89cd8 DW	61	if (depend_tx &&
bec08513	62	dma_has_cap(tx_type, depend_tx->chan->device->cap_mask))
9bc89cd8	63	return depend_tx->chan;
729b5d1b	64	return async_dma_find_channel(tx_type);
9bc89cd8	65	}
47437b2c	66	EXPORT_SYMBOL_GPL(__async_tx_find_channel);
9bc89cd8 DW	67	#endif
9bc89cd8 DW	68
19242d72 DW	69
	70	/**
	71	* async_tx_channel_switch - queue an interrupt descriptor with a dependency
	72	* pre-attached.
	73	* @depend_tx: the operation that must finish before the new operation runs
	74	* @tx: the new operation
	75	*/
	76	static void
	77	async_tx_channel_switch(struct dma_async_tx_descriptor *depend_tx,
	78	struct dma_async_tx_descriptor *tx)
	79	{
95475e57 DW	80	struct dma_chan *chan = depend_tx->chan;
95475e57 DW	81	struct dma_device *device = chan->device;
19242d72 DW	82	struct dma_async_tx_descriptor intr_tx = (void ) ~0;
	83
	84	/* first check to see if we can still append to depend_tx */
caa20d97 DW	85	txd_lock(depend_tx);
	86	if (txd_parent(depend_tx) && depend_tx->chan == tx->chan) {
	87	txd_chain(depend_tx, tx);
19242d72 DW	88	intr_tx = NULL;
19242d72 DW	89	}
caa20d97	90	txd_unlock(depend_tx);
19242d72	91
95475e57 DW	92	/* attached dependency, flush the parent channel */
	93	if (!intr_tx) {
	94	device->device_issue_pending(chan);
19242d72	95	return;
95475e57	96	}
19242d72 DW	97
	98	/* see if we can schedule an interrupt
	99	* otherwise poll for completion
	100	*/
	101	if (dma_has_cap(DMA_INTERRUPT, device->cap_mask))
636bdeaa	102	intr_tx = device->device_prep_dma_interrupt(chan, 0);
19242d72 DW	103	else
	104	intr_tx = NULL;
	105
	106	if (intr_tx) {
	107	intr_tx->callback = NULL;
	108	intr_tx->callback_param = NULL;
caa20d97	109	/* safe to chain outside the lock since we know we are
19242d72 DW	110	* not submitted yet
19242d72 DW	111	*/
caa20d97	112	txd_chain(intr_tx, tx);
19242d72 DW	113
19242d72 DW	114	/* check if we need to append */
caa20d97 DW	115	txd_lock(depend_tx);
	116	if (txd_parent(depend_tx)) {
	117	txd_chain(depend_tx, intr_tx);
19242d72 DW	118	async_tx_ack(intr_tx);
	119	intr_tx = NULL;
	120	}
caa20d97	121	txd_unlock(depend_tx);
19242d72 DW	122
19242d72 DW	123	if (intr_tx) {
caa20d97	124	txd_clear_parent(intr_tx);
19242d72 DW	125	intr_tx->tx_submit(intr_tx);
	126	async_tx_ack(intr_tx);
	127	}
95475e57	128	device->device_issue_pending(chan);
19242d72 DW	129	} else {
	130	if (dma_wait_for_async_tx(depend_tx) == DMA_ERROR)
	131	panic("%s: DMA_ERROR waiting for depend_tx\n",
	132	__func__);
	133	tx->tx_submit(tx);
	134	}
	135	}
	136
	137
	138	/**
a08abd8c	139	* submit_disposition - flags for routing an incoming operation
19242d72 DW	140	* @ASYNC_TX_SUBMITTED: we were able to append the new operation under the lock
	141	* @ASYNC_TX_CHANNEL_SWITCH: when the lock is dropped schedule a channel switch
	142	* @ASYNC_TX_DIRECT_SUBMIT: when the lock is dropped submit directly
a08abd8c DW	143	*
	144	* while holding depend_tx->lock we must avoid submitting new operations
	145	* to prevent a circular locking dependency with drivers that already
	146	* hold a channel lock when calling async_tx_run_dependencies.
19242d72 DW	147	*/
	148	enum submit_disposition {
	149	ASYNC_TX_SUBMITTED,
	150	ASYNC_TX_CHANNEL_SWITCH,
	151	ASYNC_TX_DIRECT_SUBMIT,
	152	};
	153
9bc89cd8 DW	154	void
9bc89cd8 DW	155	async_tx_submit(struct dma_chan chan, struct dma_async_tx_descriptor tx,
a08abd8c	156	struct async_submit_ctl *submit)
9bc89cd8	157	{
a08abd8c DW	158	struct dma_async_tx_descriptor *depend_tx = submit->depend_tx;
	159
	160	tx->callback = submit->cb_fn;
	161	tx->callback_param = submit->cb_param;
9bc89cd8	162
19242d72 DW	163	if (depend_tx) {
	164	enum submit_disposition s;
	165
	166	/* sanity check the dependency chain:
	167	* 1/ if ack is already set then we cannot be sure
9bc89cd8	168	* we are referring to the correct operation
19242d72 DW	169	* 2/ dependencies are 1:1 i.e. two transactions can
19242d72 DW	170	* not depend on the same parent
9bc89cd8	171	*/
caa20d97 DW	172	BUG_ON(async_tx_test_ack(depend_tx) \|\| txd_next(depend_tx) \|\|
caa20d97 DW	173	txd_parent(tx));
9bc89cd8	174
19242d72 DW	175	/* the lock prevents async_tx_run_dependencies from missing
	176	* the setting of ->next when ->parent != NULL
	177	*/
caa20d97 DW	178	txd_lock(depend_tx);
caa20d97 DW	179	if (txd_parent(depend_tx)) {
19242d72 DW	180	/* we have a parent so we can not submit directly
	181	* if we are staying on the same channel: append
	182	* else: channel switch
	183	*/
	184	if (depend_tx->chan == chan) {
caa20d97	185	txd_chain(depend_tx, tx);
19242d72 DW	186	s = ASYNC_TX_SUBMITTED;
	187	} else
	188	s = ASYNC_TX_CHANNEL_SWITCH;
	189	} else {
	190	/* we do not have a parent so we may be able to submit
	191	* directly if we are staying on the same channel
	192	*/
	193	if (depend_tx->chan == chan)
	194	s = ASYNC_TX_DIRECT_SUBMIT;
	195	else
	196	s = ASYNC_TX_CHANNEL_SWITCH;
9bc89cd8	197	}
caa20d97	198	txd_unlock(depend_tx);
9bc89cd8	199
19242d72 DW	200	switch (s) {
	201	case ASYNC_TX_SUBMITTED:
	202	break;
	203	case ASYNC_TX_CHANNEL_SWITCH:
	204	async_tx_channel_switch(depend_tx, tx);
	205	break;
	206	case ASYNC_TX_DIRECT_SUBMIT:
caa20d97	207	txd_clear_parent(tx);
19242d72 DW	208	tx->tx_submit(tx);
	209	break;
	210	}
9bc89cd8	211	} else {
caa20d97	212	txd_clear_parent(tx);
9bc89cd8 DW	213	tx->tx_submit(tx);
	214	}
	215
a08abd8c	216	if (submit->flags & ASYNC_TX_ACK)
9bc89cd8 DW	217	async_tx_ack(tx);
9bc89cd8 DW	218
88ba2aa5	219	if (depend_tx)
9bc89cd8 DW	220	async_tx_ack(depend_tx);
	221	}
	222	EXPORT_SYMBOL_GPL(async_tx_submit);
	223
	224	/**
a08abd8c DW	225	* async_trigger_callback - schedules the callback function to be run
	226	* @submit: submission and completion parameters
	227	*
	228	* honored flags: ASYNC_TX_ACK
	229	*
	230	* The callback is run after any dependent operations have completed.
9bc89cd8 DW	231	*/
9bc89cd8 DW	232	struct dma_async_tx_descriptor *
a08abd8c	233	async_trigger_callback(struct async_submit_ctl *submit)
9bc89cd8 DW	234	{
	235	struct dma_chan *chan;
	236	struct dma_device *device;
	237	struct dma_async_tx_descriptor *tx;
a08abd8c	238	struct dma_async_tx_descriptor *depend_tx = submit->depend_tx;
9bc89cd8 DW	239
	240	if (depend_tx) {
	241	chan = depend_tx->chan;
	242	device = chan->device;
	243
	244	/* see if we can schedule an interrupt
	245	* otherwise poll for completion
	246	*/
	247	if (device && !dma_has_cap(DMA_INTERRUPT, device->cap_mask))
	248	device = NULL;
	249
636bdeaa	250	tx = device ? device->device_prep_dma_interrupt(chan, 0) : NULL;
9bc89cd8 DW	251	} else
	252	tx = NULL;
	253
	254	if (tx) {
3280ab3e	255	pr_debug("%s: (async)\n", __func__);
9bc89cd8	256
a08abd8c	257	async_tx_submit(chan, tx, submit);
9bc89cd8	258	} else {
3280ab3e	259	pr_debug("%s: (sync)\n", __func__);
9bc89cd8 DW	260
9bc89cd8 DW	261	/* wait for any prerequisite operations */
a08abd8c	262	async_tx_quiesce(&submit->depend_tx);
9bc89cd8	263
a08abd8c	264	async_tx_sync_epilog(submit);
9bc89cd8 DW	265	}
	266
	267	return tx;
	268	}
	269	EXPORT_SYMBOL_GPL(async_trigger_callback);
	270
d2c52b79 DW	271	/**
	272	* async_tx_quiesce - ensure tx is complete and freeable upon return
	273	* @tx - transaction to quiesce
	274	*/
	275	void async_tx_quiesce(struct dma_async_tx_descriptor **tx)
	276	{
	277	if (*tx) {
	278	/* if ack is already set then we cannot be sure
	279	* we are referring to the correct operation
	280	*/
	281	BUG_ON(async_tx_test_ack(*tx));
	282	if (dma_wait_for_async_tx(*tx) == DMA_ERROR)
	283	panic("DMA_ERROR waiting for transaction\n");
	284	async_tx_ack(*tx);
	285	*tx = NULL;
	286	}
	287	}
	288	EXPORT_SYMBOL_GPL(async_tx_quiesce);
	289
9bc89cd8 DW	290	MODULE_AUTHOR("Intel Corporation");
	291	MODULE_DESCRIPTION("Asynchronous Bulk Memory Transactions API");
	292	MODULE_LICENSE("GPL");