dmaengine.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678
  1. /*
  2. * Copyright(c) 2004 - 2006 Intel Corporation. All rights reserved.
  3. *
  4. * This program is free software; you can redistribute it and/or modify it
  5. * under the terms of the GNU General Public License as published by the Free
  6. * Software Foundation; either version 2 of the License, or (at your option)
  7. * any later version.
  8. *
  9. * This program is distributed in the hope that it will be useful, but WITHOUT
  10. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11. * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  12. * more details.
  13. *
  14. * You should have received a copy of the GNU General Public License along with
  15. * this program; if not, write to the Free Software Foundation, Inc., 59
  16. * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17. *
  18. * The full GNU General Public License is included in this distribution in the
  19. * file called COPYING.
  20. */
  21. #ifndef DMAENGINE_H
  22. #define DMAENGINE_H
  23. #include <linux/device.h>
  24. #include <linux/uio.h>
  25. #include <linux/dma-mapping.h>
  26. /**
  27. * typedef dma_cookie_t - an opaque DMA cookie
  28. *
  29. * if dma_cookie_t is >0 it's a DMA request cookie, <0 it's an error code
  30. */
  31. typedef s32 dma_cookie_t;
  32. #define DMA_MIN_COOKIE 1
  33. #define DMA_MAX_COOKIE INT_MAX
  34. #define dma_submit_error(cookie) ((cookie) < 0 ? 1 : 0)
  35. /**
  36. * enum dma_status - DMA transaction status
  37. * @DMA_SUCCESS: transaction completed successfully
  38. * @DMA_IN_PROGRESS: transaction not yet processed
  39. * @DMA_PAUSED: transaction is paused
  40. * @DMA_ERROR: transaction failed
  41. */
  42. enum dma_status {
  43. DMA_SUCCESS,
  44. DMA_IN_PROGRESS,
  45. DMA_PAUSED,
  46. DMA_ERROR,
  47. };
  48. /**
  49. * enum dma_transaction_type - DMA transaction types/indexes
  50. *
  51. * Note: The DMA_ASYNC_TX capability is not to be set by drivers. It is
  52. * automatically set as dma devices are registered.
  53. */
  54. enum dma_transaction_type {
  55. DMA_MEMCPY,
  56. DMA_XOR,
  57. DMA_PQ,
  58. DMA_XOR_VAL,
  59. DMA_PQ_VAL,
  60. DMA_MEMSET,
  61. DMA_INTERRUPT,
  62. DMA_PRIVATE,
  63. DMA_ASYNC_TX,
  64. DMA_SLAVE,
  65. };
  66. /* last transaction type for creation of the capabilities mask */
  67. #define DMA_TX_TYPE_END (DMA_SLAVE + 1)
  68. /**
  69. * enum dma_ctrl_flags - DMA flags to augment operation preparation,
  70. * control completion, and communicate status.
  71. * @DMA_PREP_INTERRUPT - trigger an interrupt (callback) upon completion of
  72. * this transaction
  73. * @DMA_CTRL_ACK - if clear, the descriptor cannot be reused until the client
  74. * acknowledges receipt, i.e. has has a chance to establish any dependency
  75. * chains
  76. * @DMA_COMPL_SKIP_SRC_UNMAP - set to disable dma-unmapping the source buffer(s)
  77. * @DMA_COMPL_SKIP_DEST_UNMAP - set to disable dma-unmapping the destination(s)
  78. * @DMA_COMPL_SRC_UNMAP_SINGLE - set to do the source dma-unmapping as single
  79. * (if not set, do the source dma-unmapping as page)
  80. * @DMA_COMPL_DEST_UNMAP_SINGLE - set to do the destination dma-unmapping as single
  81. * (if not set, do the destination dma-unmapping as page)
  82. * @DMA_PREP_PQ_DISABLE_P - prevent generation of P while generating Q
  83. * @DMA_PREP_PQ_DISABLE_Q - prevent generation of Q while generating P
  84. * @DMA_PREP_CONTINUE - indicate to a driver that it is reusing buffers as
  85. * sources that were the result of a previous operation, in the case of a PQ
  86. * operation it continues the calculation with new sources
  87. * @DMA_PREP_FENCE - tell the driver that subsequent operations depend
  88. * on the result of this operation
  89. */
  90. enum dma_ctrl_flags {
  91. DMA_PREP_INTERRUPT = (1 << 0),
  92. DMA_CTRL_ACK = (1 << 1),
  93. DMA_COMPL_SKIP_SRC_UNMAP = (1 << 2),
  94. DMA_COMPL_SKIP_DEST_UNMAP = (1 << 3),
  95. DMA_COMPL_SRC_UNMAP_SINGLE = (1 << 4),
  96. DMA_COMPL_DEST_UNMAP_SINGLE = (1 << 5),
  97. DMA_PREP_PQ_DISABLE_P = (1 << 6),
  98. DMA_PREP_PQ_DISABLE_Q = (1 << 7),
  99. DMA_PREP_CONTINUE = (1 << 8),
  100. DMA_PREP_FENCE = (1 << 9),
  101. };
  102. /**
  103. * enum dma_ctrl_cmd - DMA operations that can optionally be exercised
  104. * on a running channel.
  105. * @DMA_TERMINATE_ALL: terminate all ongoing transfers
  106. * @DMA_PAUSE: pause ongoing transfers
  107. * @DMA_RESUME: resume paused transfer
  108. */
  109. enum dma_ctrl_cmd {
  110. DMA_TERMINATE_ALL,
  111. DMA_PAUSE,
  112. DMA_RESUME,
  113. };
  114. /**
  115. * enum sum_check_bits - bit position of pq_check_flags
  116. */
  117. enum sum_check_bits {
  118. SUM_CHECK_P = 0,
  119. SUM_CHECK_Q = 1,
  120. };
  121. /**
  122. * enum pq_check_flags - result of async_{xor,pq}_zero_sum operations
  123. * @SUM_CHECK_P_RESULT - 1 if xor zero sum error, 0 otherwise
  124. * @SUM_CHECK_Q_RESULT - 1 if reed-solomon zero sum error, 0 otherwise
  125. */
  126. enum sum_check_flags {
  127. SUM_CHECK_P_RESULT = (1 << SUM_CHECK_P),
  128. SUM_CHECK_Q_RESULT = (1 << SUM_CHECK_Q),
  129. };
  130. /**
  131. * dma_cap_mask_t - capabilities bitmap modeled after cpumask_t.
  132. * See linux/cpumask.h
  133. */
  134. typedef struct { DECLARE_BITMAP(bits, DMA_TX_TYPE_END); } dma_cap_mask_t;
  135. /**
  136. * struct dma_chan_percpu - the per-CPU part of struct dma_chan
  137. * @memcpy_count: transaction counter
  138. * @bytes_transferred: byte counter
  139. */
  140. struct dma_chan_percpu {
  141. /* stats */
  142. unsigned long memcpy_count;
  143. unsigned long bytes_transferred;
  144. };
  145. /**
  146. * struct dma_chan - devices supply DMA channels, clients use them
  147. * @device: ptr to the dma device who supplies this channel, always !%NULL
  148. * @cookie: last cookie value returned to client
  149. * @chan_id: channel ID for sysfs
  150. * @dev: class device for sysfs
  151. * @device_node: used to add this to the device chan list
  152. * @local: per-cpu pointer to a struct dma_chan_percpu
  153. * @client-count: how many clients are using this channel
  154. * @table_count: number of appearances in the mem-to-mem allocation table
  155. * @private: private data for certain client-channel associations
  156. */
  157. struct dma_chan {
  158. struct dma_device *device;
  159. dma_cookie_t cookie;
  160. /* sysfs */
  161. int chan_id;
  162. struct dma_chan_dev *dev;
  163. struct list_head device_node;
  164. struct dma_chan_percpu __percpu *local;
  165. int client_count;
  166. int table_count;
  167. void *private;
  168. };
  169. /**
  170. * struct dma_chan_dev - relate sysfs device node to backing channel device
  171. * @chan - driver channel device
  172. * @device - sysfs device
  173. * @dev_id - parent dma_device dev_id
  174. * @idr_ref - reference count to gate release of dma_device dev_id
  175. */
  176. struct dma_chan_dev {
  177. struct dma_chan *chan;
  178. struct device device;
  179. int dev_id;
  180. atomic_t *idr_ref;
  181. };
  182. static inline const char *dma_chan_name(struct dma_chan *chan)
  183. {
  184. return dev_name(&chan->dev->device);
  185. }
  186. void dma_chan_cleanup(struct kref *kref);
  187. /**
  188. * typedef dma_filter_fn - callback filter for dma_request_channel
  189. * @chan: channel to be reviewed
  190. * @filter_param: opaque parameter passed through dma_request_channel
  191. *
  192. * When this optional parameter is specified in a call to dma_request_channel a
  193. * suitable channel is passed to this routine for further dispositioning before
  194. * being returned. Where 'suitable' indicates a non-busy channel that
  195. * satisfies the given capability mask. It returns 'true' to indicate that the
  196. * channel is suitable.
  197. */
  198. typedef bool (*dma_filter_fn)(struct dma_chan *chan, void *filter_param);
  199. typedef void (*dma_async_tx_callback)(void *dma_async_param);
  200. /**
  201. * struct dma_async_tx_descriptor - async transaction descriptor
  202. * ---dma generic offload fields---
  203. * @cookie: tracking cookie for this transaction, set to -EBUSY if
  204. * this tx is sitting on a dependency list
  205. * @flags: flags to augment operation preparation, control completion, and
  206. * communicate status
  207. * @phys: physical address of the descriptor
  208. * @chan: target channel for this operation
  209. * @tx_submit: set the prepared descriptor(s) to be executed by the engine
  210. * @callback: routine to call after this operation is complete
  211. * @callback_param: general parameter to pass to the callback routine
  212. * ---async_tx api specific fields---
  213. * @next: at completion submit this descriptor
  214. * @parent: pointer to the next level up in the dependency chain
  215. * @lock: protect the parent and next pointers
  216. */
  217. struct dma_async_tx_descriptor {
  218. dma_cookie_t cookie;
  219. enum dma_ctrl_flags flags; /* not a 'long' to pack with cookie */
  220. dma_addr_t phys;
  221. struct dma_chan *chan;
  222. dma_cookie_t (*tx_submit)(struct dma_async_tx_descriptor *tx);
  223. dma_async_tx_callback callback;
  224. void *callback_param;
  225. struct dma_async_tx_descriptor *next;
  226. struct dma_async_tx_descriptor *parent;
  227. spinlock_t lock;
  228. };
  229. /**
  230. * struct dma_tx_state - filled in to report the status of
  231. * a transfer.
  232. * @last: last completed DMA cookie
  233. * @used: last issued DMA cookie (i.e. the one in progress)
  234. * @residue: the remaining number of bytes left to transmit
  235. * on the selected transfer for states DMA_IN_PROGRESS and
  236. * DMA_PAUSED if this is implemented in the driver, else 0
  237. */
  238. struct dma_tx_state {
  239. dma_cookie_t last;
  240. dma_cookie_t used;
  241. u32 residue;
  242. };
  243. /**
  244. * struct dma_device - info on the entity supplying DMA services
  245. * @chancnt: how many DMA channels are supported
  246. * @privatecnt: how many DMA channels are requested by dma_request_channel
  247. * @channels: the list of struct dma_chan
  248. * @global_node: list_head for global dma_device_list
  249. * @cap_mask: one or more dma_capability flags
  250. * @max_xor: maximum number of xor sources, 0 if no capability
  251. * @max_pq: maximum number of PQ sources and PQ-continue capability
  252. * @copy_align: alignment shift for memcpy operations
  253. * @xor_align: alignment shift for xor operations
  254. * @pq_align: alignment shift for pq operations
  255. * @fill_align: alignment shift for memset operations
  256. * @dev_id: unique device ID
  257. * @dev: struct device reference for dma mapping api
  258. * @device_alloc_chan_resources: allocate resources and return the
  259. * number of allocated descriptors
  260. * @device_free_chan_resources: release DMA channel's resources
  261. * @device_prep_dma_memcpy: prepares a memcpy operation
  262. * @device_prep_dma_xor: prepares a xor operation
  263. * @device_prep_dma_xor_val: prepares a xor validation operation
  264. * @device_prep_dma_pq: prepares a pq operation
  265. * @device_prep_dma_pq_val: prepares a pqzero_sum operation
  266. * @device_prep_dma_memset: prepares a memset operation
  267. * @device_prep_dma_interrupt: prepares an end of chain interrupt operation
  268. * @device_prep_slave_sg: prepares a slave dma operation
  269. * @device_control: manipulate all pending operations on a channel, returns
  270. * zero or error code
  271. * @device_tx_status: poll for transaction completion, the optional
  272. * txstate parameter can be supplied with a pointer to get a
  273. * struct with auxilary transfer status information, otherwise the call
  274. * will just return a simple status code
  275. * @device_issue_pending: push pending transactions to hardware
  276. */
  277. struct dma_device {
  278. unsigned int chancnt;
  279. unsigned int privatecnt;
  280. struct list_head channels;
  281. struct list_head global_node;
  282. dma_cap_mask_t cap_mask;
  283. unsigned short max_xor;
  284. unsigned short max_pq;
  285. u8 copy_align;
  286. u8 xor_align;
  287. u8 pq_align;
  288. u8 fill_align;
  289. #define DMA_HAS_PQ_CONTINUE (1 << 15)
  290. int dev_id;
  291. struct device *dev;
  292. int (*device_alloc_chan_resources)(struct dma_chan *chan);
  293. void (*device_free_chan_resources)(struct dma_chan *chan);
  294. struct dma_async_tx_descriptor *(*device_prep_dma_memcpy)(
  295. struct dma_chan *chan, dma_addr_t dest, dma_addr_t src,
  296. size_t len, unsigned long flags);
  297. struct dma_async_tx_descriptor *(*device_prep_dma_xor)(
  298. struct dma_chan *chan, dma_addr_t dest, dma_addr_t *src,
  299. unsigned int src_cnt, size_t len, unsigned long flags);
  300. struct dma_async_tx_descriptor *(*device_prep_dma_xor_val)(
  301. struct dma_chan *chan, dma_addr_t *src, unsigned int src_cnt,
  302. size_t len, enum sum_check_flags *result, unsigned long flags);
  303. struct dma_async_tx_descriptor *(*device_prep_dma_pq)(
  304. struct dma_chan *chan, dma_addr_t *dst, dma_addr_t *src,
  305. unsigned int src_cnt, const unsigned char *scf,
  306. size_t len, unsigned long flags);
  307. struct dma_async_tx_descriptor *(*device_prep_dma_pq_val)(
  308. struct dma_chan *chan, dma_addr_t *pq, dma_addr_t *src,
  309. unsigned int src_cnt, const unsigned char *scf, size_t len,
  310. enum sum_check_flags *pqres, unsigned long flags);
  311. struct dma_async_tx_descriptor *(*device_prep_dma_memset)(
  312. struct dma_chan *chan, dma_addr_t dest, int value, size_t len,
  313. unsigned long flags);
  314. struct dma_async_tx_descriptor *(*device_prep_dma_interrupt)(
  315. struct dma_chan *chan, unsigned long flags);
  316. struct dma_async_tx_descriptor *(*device_prep_slave_sg)(
  317. struct dma_chan *chan, struct scatterlist *sgl,
  318. unsigned int sg_len, enum dma_data_direction direction,
  319. unsigned long flags);
  320. int (*device_control)(struct dma_chan *chan, enum dma_ctrl_cmd cmd);
  321. enum dma_status (*device_tx_status)(struct dma_chan *chan,
  322. dma_cookie_t cookie,
  323. struct dma_tx_state *txstate);
  324. void (*device_issue_pending)(struct dma_chan *chan);
  325. };
  326. static inline bool dmaengine_check_align(u8 align, size_t off1, size_t off2, size_t len)
  327. {
  328. size_t mask;
  329. if (!align)
  330. return true;
  331. mask = (1 << align) - 1;
  332. if (mask & (off1 | off2 | len))
  333. return false;
  334. return true;
  335. }
  336. static inline bool is_dma_copy_aligned(struct dma_device *dev, size_t off1,
  337. size_t off2, size_t len)
  338. {
  339. return dmaengine_check_align(dev->copy_align, off1, off2, len);
  340. }
  341. static inline bool is_dma_xor_aligned(struct dma_device *dev, size_t off1,
  342. size_t off2, size_t len)
  343. {
  344. return dmaengine_check_align(dev->xor_align, off1, off2, len);
  345. }
  346. static inline bool is_dma_pq_aligned(struct dma_device *dev, size_t off1,
  347. size_t off2, size_t len)
  348. {
  349. return dmaengine_check_align(dev->pq_align, off1, off2, len);
  350. }
  351. static inline bool is_dma_fill_aligned(struct dma_device *dev, size_t off1,
  352. size_t off2, size_t len)
  353. {
  354. return dmaengine_check_align(dev->fill_align, off1, off2, len);
  355. }
  356. static inline void
  357. dma_set_maxpq(struct dma_device *dma, int maxpq, int has_pq_continue)
  358. {
  359. dma->max_pq = maxpq;
  360. if (has_pq_continue)
  361. dma->max_pq |= DMA_HAS_PQ_CONTINUE;
  362. }
  363. static inline bool dmaf_continue(enum dma_ctrl_flags flags)
  364. {
  365. return (flags & DMA_PREP_CONTINUE) == DMA_PREP_CONTINUE;
  366. }
  367. static inline bool dmaf_p_disabled_continue(enum dma_ctrl_flags flags)
  368. {
  369. enum dma_ctrl_flags mask = DMA_PREP_CONTINUE | DMA_PREP_PQ_DISABLE_P;
  370. return (flags & mask) == mask;
  371. }
  372. static inline bool dma_dev_has_pq_continue(struct dma_device *dma)
  373. {
  374. return (dma->max_pq & DMA_HAS_PQ_CONTINUE) == DMA_HAS_PQ_CONTINUE;
  375. }
  376. static unsigned short dma_dev_to_maxpq(struct dma_device *dma)
  377. {
  378. return dma->max_pq & ~DMA_HAS_PQ_CONTINUE;
  379. }
  380. /* dma_maxpq - reduce maxpq in the face of continued operations
  381. * @dma - dma device with PQ capability
  382. * @flags - to check if DMA_PREP_CONTINUE and DMA_PREP_PQ_DISABLE_P are set
  383. *
  384. * When an engine does not support native continuation we need 3 extra
  385. * source slots to reuse P and Q with the following coefficients:
  386. * 1/ {00} * P : remove P from Q', but use it as a source for P'
  387. * 2/ {01} * Q : use Q to continue Q' calculation
  388. * 3/ {00} * Q : subtract Q from P' to cancel (2)
  389. *
  390. * In the case where P is disabled we only need 1 extra source:
  391. * 1/ {01} * Q : use Q to continue Q' calculation
  392. */
  393. static inline int dma_maxpq(struct dma_device *dma, enum dma_ctrl_flags flags)
  394. {
  395. if (dma_dev_has_pq_continue(dma) || !dmaf_continue(flags))
  396. return dma_dev_to_maxpq(dma);
  397. else if (dmaf_p_disabled_continue(flags))
  398. return dma_dev_to_maxpq(dma) - 1;
  399. else if (dmaf_continue(flags))
  400. return dma_dev_to_maxpq(dma) - 3;
  401. BUG();
  402. }
  403. /* --- public DMA engine API --- */
  404. #ifdef CONFIG_DMA_ENGINE
  405. void dmaengine_get(void);
  406. void dmaengine_put(void);
  407. #else
  408. static inline void dmaengine_get(void)
  409. {
  410. }
  411. static inline void dmaengine_put(void)
  412. {
  413. }
  414. #endif
  415. #ifdef CONFIG_NET_DMA
  416. #define net_dmaengine_get() dmaengine_get()
  417. #define net_dmaengine_put() dmaengine_put()
  418. #else
  419. static inline void net_dmaengine_get(void)
  420. {
  421. }
  422. static inline void net_dmaengine_put(void)
  423. {
  424. }
  425. #endif
  426. #ifdef CONFIG_ASYNC_TX_DMA
  427. #define async_dmaengine_get() dmaengine_get()
  428. #define async_dmaengine_put() dmaengine_put()
  429. #ifdef CONFIG_ASYNC_TX_DISABLE_CHANNEL_SWITCH
  430. #define async_dma_find_channel(type) dma_find_channel(DMA_ASYNC_TX)
  431. #else
  432. #define async_dma_find_channel(type) dma_find_channel(type)
  433. #endif /* CONFIG_ASYNC_TX_DISABLE_CHANNEL_SWITCH */
  434. #else
  435. static inline void async_dmaengine_get(void)
  436. {
  437. }
  438. static inline void async_dmaengine_put(void)
  439. {
  440. }
  441. static inline struct dma_chan *
  442. async_dma_find_channel(enum dma_transaction_type type)
  443. {
  444. return NULL;
  445. }
  446. #endif /* CONFIG_ASYNC_TX_DMA */
  447. dma_cookie_t dma_async_memcpy_buf_to_buf(struct dma_chan *chan,
  448. void *dest, void *src, size_t len);
  449. dma_cookie_t dma_async_memcpy_buf_to_pg(struct dma_chan *chan,
  450. struct page *page, unsigned int offset, void *kdata, size_t len);
  451. dma_cookie_t dma_async_memcpy_pg_to_pg(struct dma_chan *chan,
  452. struct page *dest_pg, unsigned int dest_off, struct page *src_pg,
  453. unsigned int src_off, size_t len);
  454. void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx,
  455. struct dma_chan *chan);
  456. static inline void async_tx_ack(struct dma_async_tx_descriptor *tx)
  457. {
  458. tx->flags |= DMA_CTRL_ACK;
  459. }
  460. static inline void async_tx_clear_ack(struct dma_async_tx_descriptor *tx)
  461. {
  462. tx->flags &= ~DMA_CTRL_ACK;
  463. }
  464. static inline bool async_tx_test_ack(struct dma_async_tx_descriptor *tx)
  465. {
  466. return (tx->flags & DMA_CTRL_ACK) == DMA_CTRL_ACK;
  467. }
  468. #define first_dma_cap(mask) __first_dma_cap(&(mask))
  469. static inline int __first_dma_cap(const dma_cap_mask_t *srcp)
  470. {
  471. return min_t(int, DMA_TX_TYPE_END,
  472. find_first_bit(srcp->bits, DMA_TX_TYPE_END));
  473. }
  474. #define next_dma_cap(n, mask) __next_dma_cap((n), &(mask))
  475. static inline int __next_dma_cap(int n, const dma_cap_mask_t *srcp)
  476. {
  477. return min_t(int, DMA_TX_TYPE_END,
  478. find_next_bit(srcp->bits, DMA_TX_TYPE_END, n+1));
  479. }
  480. #define dma_cap_set(tx, mask) __dma_cap_set((tx), &(mask))
  481. static inline void
  482. __dma_cap_set(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp)
  483. {
  484. set_bit(tx_type, dstp->bits);
  485. }
  486. #define dma_cap_clear(tx, mask) __dma_cap_clear((tx), &(mask))
  487. static inline void
  488. __dma_cap_clear(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp)
  489. {
  490. clear_bit(tx_type, dstp->bits);
  491. }
  492. #define dma_cap_zero(mask) __dma_cap_zero(&(mask))
  493. static inline void __dma_cap_zero(dma_cap_mask_t *dstp)
  494. {
  495. bitmap_zero(dstp->bits, DMA_TX_TYPE_END);
  496. }
  497. #define dma_has_cap(tx, mask) __dma_has_cap((tx), &(mask))
  498. static inline int
  499. __dma_has_cap(enum dma_transaction_type tx_type, dma_cap_mask_t *srcp)
  500. {
  501. return test_bit(tx_type, srcp->bits);
  502. }
  503. #define for_each_dma_cap_mask(cap, mask) \
  504. for ((cap) = first_dma_cap(mask); \
  505. (cap) < DMA_TX_TYPE_END; \
  506. (cap) = next_dma_cap((cap), (mask)))
  507. /**
  508. * dma_async_issue_pending - flush pending transactions to HW
  509. * @chan: target DMA channel
  510. *
  511. * This allows drivers to push copies to HW in batches,
  512. * reducing MMIO writes where possible.
  513. */
  514. static inline void dma_async_issue_pending(struct dma_chan *chan)
  515. {
  516. chan->device->device_issue_pending(chan);
  517. }
  518. #define dma_async_memcpy_issue_pending(chan) dma_async_issue_pending(chan)
  519. /**
  520. * dma_async_is_tx_complete - poll for transaction completion
  521. * @chan: DMA channel
  522. * @cookie: transaction identifier to check status of
  523. * @last: returns last completed cookie, can be NULL
  524. * @used: returns last issued cookie, can be NULL
  525. *
  526. * If @last and @used are passed in, upon return they reflect the driver
  527. * internal state and can be used with dma_async_is_complete() to check
  528. * the status of multiple cookies without re-checking hardware state.
  529. */
  530. static inline enum dma_status dma_async_is_tx_complete(struct dma_chan *chan,
  531. dma_cookie_t cookie, dma_cookie_t *last, dma_cookie_t *used)
  532. {
  533. struct dma_tx_state state;
  534. enum dma_status status;
  535. status = chan->device->device_tx_status(chan, cookie, &state);
  536. if (last)
  537. *last = state.last;
  538. if (used)
  539. *used = state.used;
  540. return status;
  541. }
  542. #define dma_async_memcpy_complete(chan, cookie, last, used)\
  543. dma_async_is_tx_complete(chan, cookie, last, used)
  544. /**
  545. * dma_async_is_complete - test a cookie against chan state
  546. * @cookie: transaction identifier to test status of
  547. * @last_complete: last know completed transaction
  548. * @last_used: last cookie value handed out
  549. *
  550. * dma_async_is_complete() is used in dma_async_memcpy_complete()
  551. * the test logic is separated for lightweight testing of multiple cookies
  552. */
  553. static inline enum dma_status dma_async_is_complete(dma_cookie_t cookie,
  554. dma_cookie_t last_complete, dma_cookie_t last_used)
  555. {
  556. if (last_complete <= last_used) {
  557. if ((cookie <= last_complete) || (cookie > last_used))
  558. return DMA_SUCCESS;
  559. } else {
  560. if ((cookie <= last_complete) && (cookie > last_used))
  561. return DMA_SUCCESS;
  562. }
  563. return DMA_IN_PROGRESS;
  564. }
  565. enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie);
  566. #ifdef CONFIG_DMA_ENGINE
  567. enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx);
  568. void dma_issue_pending_all(void);
  569. #else
  570. static inline enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx)
  571. {
  572. return DMA_SUCCESS;
  573. }
  574. static inline void dma_issue_pending_all(void)
  575. {
  576. do { } while (0);
  577. }
  578. #endif
  579. /* --- DMA device --- */
  580. int dma_async_device_register(struct dma_device *device);
  581. void dma_async_device_unregister(struct dma_device *device);
  582. void dma_run_dependencies(struct dma_async_tx_descriptor *tx);
  583. struct dma_chan *dma_find_channel(enum dma_transaction_type tx_type);
  584. #define dma_request_channel(mask, x, y) __dma_request_channel(&(mask), x, y)
  585. struct dma_chan *__dma_request_channel(dma_cap_mask_t *mask, dma_filter_fn fn, void *fn_param);
  586. void dma_release_channel(struct dma_chan *chan);
  587. /* --- Helper iov-locking functions --- */
  588. struct dma_page_list {
  589. char __user *base_address;
  590. int nr_pages;
  591. struct page **pages;
  592. };
  593. struct dma_pinned_list {
  594. int nr_iovecs;
  595. struct dma_page_list page_list[0];
  596. };
  597. struct dma_pinned_list *dma_pin_iovec_pages(struct iovec *iov, size_t len);
  598. void dma_unpin_iovec_pages(struct dma_pinned_list* pinned_list);
  599. dma_cookie_t dma_memcpy_to_iovec(struct dma_chan *chan, struct iovec *iov,
  600. struct dma_pinned_list *pinned_list, unsigned char *kdata, size_t len);
  601. dma_cookie_t dma_memcpy_pg_to_iovec(struct dma_chan *chan, struct iovec *iov,
  602. struct dma_pinned_list *pinned_list, struct page *page,
  603. unsigned int offset, size_t len);
  604. #endif /* DMAENGINE_H */