async_tx, dmaengine: document channel allocation and api rework
commit28405d8d9ce05f5bd869ef8b48da5086f9527d73
authorDan Williams <dan.j.williams@intel.com>
Tue, 6 Jan 2009 00:14:31 +0000 (5 17:14 -0700)
committerDan Williams <dan.j.williams@intel.com>
Tue, 6 Jan 2009 01:10:19 +0000 (5 18:10 -0700)
treef3e68349cc38b4dc0a437455ba9513be78f620ae
parentfe0bdec68b77020281dc814805edfe594ae89e0f
async_tx, dmaengine: document channel allocation and api rework

"Wouldn't it be better if the dmaengine layer made sure it didn't pass
the same channel several times to a client?

I mean, you seem concerned that the memcpy() API should be transparent
and easy to use, but the whole registration interface is just
ridiculously complicated..."
- Haavard

The dmaengine and async_tx registration/allocation interface is indeed
needlessly complicated.  This redesign has the following goals:

1/ Simplify reference counting: dma channels are not something one would
   expect to be hotplugged, it should be an exceptional event handled by
   drivers not something clients should be mandated to handle in a
   callback.  The common case channel removal event is 'rmmod <dma driver>',
   which for simplicity should be disallowed if the channel is in use.
2/ Add an interface for requesting exclusive access to a channel
   suitable to device-to-memory users.
3/ Convert all memory-to-memory users over to a common allocator, the goal
   here is to not have competing channel allocation schemes.  The only
   competition should be between device-to-memory exclusive allocations and
   the memory-to-memory usage case where channels are shared between
   multiple "clients".

Cc: Haavard Skinnemoen <haavard.skinnemoen@atmel.com>
Cc: Neil Brown <neilb@suse.de>
Cc: Jeff Garzik <jeff@garzik.org>
Reviewed-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Dan Williams <dan.j.williams@intel.com>
Documentation/crypto/async-tx-api.txt
Documentation/dmaengine.txt [new file with mode: 0644]