DMA-API.txt 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698
  1. Dynamic DMA mapping using the generic device
  2. ============================================
  3. James E.J. Bottomley <James.Bottomley@HansenPartnership.com>
  4. This document describes the DMA API. For a more gentle introduction
  5. of the API (and actual examples), see Documentation/DMA-API-HOWTO.txt.
  6. This API is split into two pieces. Part I describes the basic API.
  7. Part II describes extensions for supporting non-consistent memory
  8. machines. Unless you know that your driver absolutely has to support
  9. non-consistent platforms (this is usually only legacy platforms) you
  10. should only use the API described in part I.
  11. Part I - dma_ API
  12. -------------------------------------
  13. To get the dma_ API, you must #include <linux/dma-mapping.h>. This
  14. provides dma_addr_t and the interfaces described below.
  15. A dma_addr_t can hold any valid DMA address for the platform. It can be
  16. given to a device to use as a DMA source or target. A CPU cannot reference
  17. a dma_addr_t directly because there may be translation between its physical
  18. address space and the DMA address space.
  19. Part Ia - Using large DMA-coherent buffers
  20. ------------------------------------------
  21. void *
  22. dma_alloc_coherent(struct device *dev, size_t size,
  23. dma_addr_t *dma_handle, gfp_t flag)
  24. Consistent memory is memory for which a write by either the device or
  25. the processor can immediately be read by the processor or device
  26. without having to worry about caching effects. (You may however need
  27. to make sure to flush the processor's write buffers before telling
  28. devices to read that memory.)
  29. This routine allocates a region of <size> bytes of consistent memory.
  30. It returns a pointer to the allocated region (in the processor's virtual
  31. address space) or NULL if the allocation failed.
  32. It also returns a <dma_handle> which may be cast to an unsigned integer the
  33. same width as the bus and given to the device as the DMA address base of
  34. the region.
  35. Note: consistent memory can be expensive on some platforms, and the
  36. minimum allocation length may be as big as a page, so you should
  37. consolidate your requests for consistent memory as much as possible.
  38. The simplest way to do that is to use the dma_pool calls (see below).
  39. The flag parameter (dma_alloc_coherent() only) allows the caller to
  40. specify the GFP_ flags (see kmalloc()) for the allocation (the
  41. implementation may choose to ignore flags that affect the location of
  42. the returned memory, like GFP_DMA).
  43. void *
  44. dma_zalloc_coherent(struct device *dev, size_t size,
  45. dma_addr_t *dma_handle, gfp_t flag)
  46. Wraps dma_alloc_coherent() and also zeroes the returned memory if the
  47. allocation attempt succeeded.
  48. void
  49. dma_free_coherent(struct device *dev, size_t size, void *cpu_addr,
  50. dma_addr_t dma_handle)
  51. Free a region of consistent memory you previously allocated. dev,
  52. size and dma_handle must all be the same as those passed into
  53. dma_alloc_coherent(). cpu_addr must be the virtual address returned by
  54. the dma_alloc_coherent().
  55. Note that unlike their sibling allocation calls, these routines
  56. may only be called with IRQs enabled.
  57. Part Ib - Using small DMA-coherent buffers
  58. ------------------------------------------
  59. To get this part of the dma_ API, you must #include <linux/dmapool.h>
  60. Many drivers need lots of small DMA-coherent memory regions for DMA
  61. descriptors or I/O buffers. Rather than allocating in units of a page
  62. or more using dma_alloc_coherent(), you can use DMA pools. These work
  63. much like a struct kmem_cache, except that they use the DMA-coherent allocator,
  64. not __get_free_pages(). Also, they understand common hardware constraints
  65. for alignment, like queue heads needing to be aligned on N-byte boundaries.
  66. struct dma_pool *
  67. dma_pool_create(const char *name, struct device *dev,
  68. size_t size, size_t align, size_t alloc);
  69. dma_pool_create() initializes a pool of DMA-coherent buffers
  70. for use with a given device. It must be called in a context which
  71. can sleep.
  72. The "name" is for diagnostics (like a struct kmem_cache name); dev and size
  73. are like what you'd pass to dma_alloc_coherent(). The device's hardware
  74. alignment requirement for this type of data is "align" (which is expressed
  75. in bytes, and must be a power of two). If your device has no boundary
  76. crossing restrictions, pass 0 for alloc; passing 4096 says memory allocated
  77. from this pool must not cross 4KByte boundaries.
  78. void *dma_pool_zalloc(struct dma_pool *pool, gfp_t mem_flags,
  79. dma_addr_t *handle)
  80. Wraps dma_pool_alloc() and also zeroes the returned memory if the
  81. allocation attempt succeeded.
  82. void *dma_pool_alloc(struct dma_pool *pool, gfp_t gfp_flags,
  83. dma_addr_t *dma_handle);
  84. This allocates memory from the pool; the returned memory will meet the
  85. size and alignment requirements specified at creation time. Pass
  86. GFP_ATOMIC to prevent blocking, or if it's permitted (not
  87. in_interrupt, not holding SMP locks), pass GFP_KERNEL to allow
  88. blocking. Like dma_alloc_coherent(), this returns two values: an
  89. address usable by the CPU, and the DMA address usable by the pool's
  90. device.
  91. void dma_pool_free(struct dma_pool *pool, void *vaddr,
  92. dma_addr_t addr);
  93. This puts memory back into the pool. The pool is what was passed to
  94. dma_pool_alloc(); the CPU (vaddr) and DMA addresses are what
  95. were returned when that routine allocated the memory being freed.
  96. void dma_pool_destroy(struct dma_pool *pool);
  97. dma_pool_destroy() frees the resources of the pool. It must be
  98. called in a context which can sleep. Make sure you've freed all allocated
  99. memory back to the pool before you destroy it.
  100. Part Ic - DMA addressing limitations
  101. ------------------------------------
  102. int
  103. dma_set_mask_and_coherent(struct device *dev, u64 mask)
  104. Checks to see if the mask is possible and updates the device
  105. streaming and coherent DMA mask parameters if it is.
  106. Returns: 0 if successful and a negative error if not.
  107. int
  108. dma_set_mask(struct device *dev, u64 mask)
  109. Checks to see if the mask is possible and updates the device
  110. parameters if it is.
  111. Returns: 0 if successful and a negative error if not.
  112. int
  113. dma_set_coherent_mask(struct device *dev, u64 mask)
  114. Checks to see if the mask is possible and updates the device
  115. parameters if it is.
  116. Returns: 0 if successful and a negative error if not.
  117. u64
  118. dma_get_required_mask(struct device *dev)
  119. This API returns the mask that the platform requires to
  120. operate efficiently. Usually this means the returned mask
  121. is the minimum required to cover all of memory. Examining the
  122. required mask gives drivers with variable descriptor sizes the
  123. opportunity to use smaller descriptors as necessary.
  124. Requesting the required mask does not alter the current mask. If you
  125. wish to take advantage of it, you should issue a dma_set_mask()
  126. call to set the mask to the value returned.
  127. Part Id - Streaming DMA mappings
  128. --------------------------------
  129. dma_addr_t
  130. dma_map_single(struct device *dev, void *cpu_addr, size_t size,
  131. enum dma_data_direction direction)
  132. Maps a piece of processor virtual memory so it can be accessed by the
  133. device and returns the DMA address of the memory.
  134. The direction for both APIs may be converted freely by casting.
  135. However the dma_ API uses a strongly typed enumerator for its
  136. direction:
  137. DMA_NONE no direction (used for debugging)
  138. DMA_TO_DEVICE data is going from the memory to the device
  139. DMA_FROM_DEVICE data is coming from the device to the memory
  140. DMA_BIDIRECTIONAL direction isn't known
  141. Notes: Not all memory regions in a machine can be mapped by this API.
  142. Further, contiguous kernel virtual space may not be contiguous as
  143. physical memory. Since this API does not provide any scatter/gather
  144. capability, it will fail if the user tries to map a non-physically
  145. contiguous piece of memory. For this reason, memory to be mapped by
  146. this API should be obtained from sources which guarantee it to be
  147. physically contiguous (like kmalloc).
  148. Further, the DMA address of the memory must be within the
  149. dma_mask of the device (the dma_mask is a bit mask of the
  150. addressable region for the device, i.e., if the DMA address of
  151. the memory ANDed with the dma_mask is still equal to the DMA
  152. address, then the device can perform DMA to the memory). To
  153. ensure that the memory allocated by kmalloc is within the dma_mask,
  154. the driver may specify various platform-dependent flags to restrict
  155. the DMA address range of the allocation (e.g., on x86, GFP_DMA
  156. guarantees to be within the first 16MB of available DMA addresses,
  157. as required by ISA devices).
  158. Note also that the above constraints on physical contiguity and
  159. dma_mask may not apply if the platform has an IOMMU (a device which
  160. maps an I/O DMA address to a physical memory address). However, to be
  161. portable, device driver writers may *not* assume that such an IOMMU
  162. exists.
  163. Warnings: Memory coherency operates at a granularity called the cache
  164. line width. In order for memory mapped by this API to operate
  165. correctly, the mapped region must begin exactly on a cache line
  166. boundary and end exactly on one (to prevent two separately mapped
  167. regions from sharing a single cache line). Since the cache line size
  168. may not be known at compile time, the API will not enforce this
  169. requirement. Therefore, it is recommended that driver writers who
  170. don't take special care to determine the cache line size at run time
  171. only map virtual regions that begin and end on page boundaries (which
  172. are guaranteed also to be cache line boundaries).
  173. DMA_TO_DEVICE synchronisation must be done after the last modification
  174. of the memory region by the software and before it is handed off to
  175. the driver. Once this primitive is used, memory covered by this
  176. primitive should be treated as read-only by the device. If the device
  177. may write to it at any point, it should be DMA_BIDIRECTIONAL (see
  178. below).
  179. DMA_FROM_DEVICE synchronisation must be done before the driver
  180. accesses data that may be changed by the device. This memory should
  181. be treated as read-only by the driver. If the driver needs to write
  182. to it at any point, it should be DMA_BIDIRECTIONAL (see below).
  183. DMA_BIDIRECTIONAL requires special handling: it means that the driver
  184. isn't sure if the memory was modified before being handed off to the
  185. device and also isn't sure if the device will also modify it. Thus,
  186. you must always sync bidirectional memory twice: once before the
  187. memory is handed off to the device (to make sure all memory changes
  188. are flushed from the processor) and once before the data may be
  189. accessed after being used by the device (to make sure any processor
  190. cache lines are updated with data that the device may have changed).
  191. void
  192. dma_unmap_single(struct device *dev, dma_addr_t dma_addr, size_t size,
  193. enum dma_data_direction direction)
  194. Unmaps the region previously mapped. All the parameters passed in
  195. must be identical to those passed in (and returned) by the mapping
  196. API.
  197. dma_addr_t
  198. dma_map_page(struct device *dev, struct page *page,
  199. unsigned long offset, size_t size,
  200. enum dma_data_direction direction)
  201. void
  202. dma_unmap_page(struct device *dev, dma_addr_t dma_address, size_t size,
  203. enum dma_data_direction direction)
  204. API for mapping and unmapping for pages. All the notes and warnings
  205. for the other mapping APIs apply here. Also, although the <offset>
  206. and <size> parameters are provided to do partial page mapping, it is
  207. recommended that you never use these unless you really know what the
  208. cache width is.
  209. int
  210. dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
  211. In some circumstances dma_map_single() and dma_map_page() will fail to create
  212. a mapping. A driver can check for these errors by testing the returned
  213. DMA address with dma_mapping_error(). A non-zero return value means the mapping
  214. could not be created and the driver should take appropriate action (e.g.
  215. reduce current DMA mapping usage or delay and try again later).
  216. int
  217. dma_map_sg(struct device *dev, struct scatterlist *sg,
  218. int nents, enum dma_data_direction direction)
  219. Returns: the number of DMA address segments mapped (this may be shorter
  220. than <nents> passed in if some elements of the scatter/gather list are
  221. physically or virtually adjacent and an IOMMU maps them with a single
  222. entry).
  223. Please note that the sg cannot be mapped again if it has been mapped once.
  224. The mapping process is allowed to destroy information in the sg.
  225. As with the other mapping interfaces, dma_map_sg() can fail. When it
  226. does, 0 is returned and a driver must take appropriate action. It is
  227. critical that the driver do something, in the case of a block driver
  228. aborting the request or even oopsing is better than doing nothing and
  229. corrupting the filesystem.
  230. With scatterlists, you use the resulting mapping like this:
  231. int i, count = dma_map_sg(dev, sglist, nents, direction);
  232. struct scatterlist *sg;
  233. for_each_sg(sglist, sg, count, i) {
  234. hw_address[i] = sg_dma_address(sg);
  235. hw_len[i] = sg_dma_len(sg);
  236. }
  237. where nents is the number of entries in the sglist.
  238. The implementation is free to merge several consecutive sglist entries
  239. into one (e.g. with an IOMMU, or if several pages just happen to be
  240. physically contiguous) and returns the actual number of sg entries it
  241. mapped them to. On failure 0, is returned.
  242. Then you should loop count times (note: this can be less than nents times)
  243. and use sg_dma_address() and sg_dma_len() macros where you previously
  244. accessed sg->address and sg->length as shown above.
  245. void
  246. dma_unmap_sg(struct device *dev, struct scatterlist *sg,
  247. int nents, enum dma_data_direction direction)
  248. Unmap the previously mapped scatter/gather list. All the parameters
  249. must be the same as those and passed in to the scatter/gather mapping
  250. API.
  251. Note: <nents> must be the number you passed in, *not* the number of
  252. DMA address entries returned.
  253. void
  254. dma_sync_single_for_cpu(struct device *dev, dma_addr_t dma_handle, size_t size,
  255. enum dma_data_direction direction)
  256. void
  257. dma_sync_single_for_device(struct device *dev, dma_addr_t dma_handle, size_t size,
  258. enum dma_data_direction direction)
  259. void
  260. dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg, int nents,
  261. enum dma_data_direction direction)
  262. void
  263. dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg, int nents,
  264. enum dma_data_direction direction)
  265. Synchronise a single contiguous or scatter/gather mapping for the CPU
  266. and device. With the sync_sg API, all the parameters must be the same
  267. as those passed into the single mapping API. With the sync_single API,
  268. you can use dma_handle and size parameters that aren't identical to
  269. those passed into the single mapping API to do a partial sync.
  270. Notes: You must do this:
  271. - Before reading values that have been written by DMA from the device
  272. (use the DMA_FROM_DEVICE direction)
  273. - After writing values that will be written to the device using DMA
  274. (use the DMA_TO_DEVICE) direction
  275. - before *and* after handing memory to the device if the memory is
  276. DMA_BIDIRECTIONAL
  277. See also dma_map_single().
  278. dma_addr_t
  279. dma_map_single_attrs(struct device *dev, void *cpu_addr, size_t size,
  280. enum dma_data_direction dir,
  281. struct dma_attrs *attrs)
  282. void
  283. dma_unmap_single_attrs(struct device *dev, dma_addr_t dma_addr,
  284. size_t size, enum dma_data_direction dir,
  285. struct dma_attrs *attrs)
  286. int
  287. dma_map_sg_attrs(struct device *dev, struct scatterlist *sgl,
  288. int nents, enum dma_data_direction dir,
  289. struct dma_attrs *attrs)
  290. void
  291. dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sgl,
  292. int nents, enum dma_data_direction dir,
  293. struct dma_attrs *attrs)
  294. The four functions above are just like the counterpart functions
  295. without the _attrs suffixes, except that they pass an optional
  296. struct dma_attrs*.
  297. struct dma_attrs encapsulates a set of "DMA attributes". For the
  298. definition of struct dma_attrs see linux/dma-attrs.h.
  299. The interpretation of DMA attributes is architecture-specific, and
  300. each attribute should be documented in Documentation/DMA-attributes.txt.
  301. If struct dma_attrs* is NULL, the semantics of each of these
  302. functions is identical to those of the corresponding function
  303. without the _attrs suffix. As a result dma_map_single_attrs()
  304. can generally replace dma_map_single(), etc.
  305. As an example of the use of the *_attrs functions, here's how
  306. you could pass an attribute DMA_ATTR_FOO when mapping memory
  307. for DMA:
  308. #include <linux/dma-attrs.h>
  309. /* DMA_ATTR_FOO should be defined in linux/dma-attrs.h and
  310. * documented in Documentation/DMA-attributes.txt */
  311. ...
  312. DEFINE_DMA_ATTRS(attrs);
  313. dma_set_attr(DMA_ATTR_FOO, &attrs);
  314. ....
  315. n = dma_map_sg_attrs(dev, sg, nents, DMA_TO_DEVICE, &attr);
  316. ....
  317. Architectures that care about DMA_ATTR_FOO would check for its
  318. presence in their implementations of the mapping and unmapping
  319. routines, e.g.:
  320. void whizco_dma_map_sg_attrs(struct device *dev, dma_addr_t dma_addr,
  321. size_t size, enum dma_data_direction dir,
  322. struct dma_attrs *attrs)
  323. {
  324. ....
  325. int foo = dma_get_attr(DMA_ATTR_FOO, attrs);
  326. ....
  327. if (foo)
  328. /* twizzle the frobnozzle */
  329. ....
  330. Part II - Advanced dma_ usage
  331. -----------------------------
  332. Warning: These pieces of the DMA API should not be used in the
  333. majority of cases, since they cater for unlikely corner cases that
  334. don't belong in usual drivers.
  335. If you don't understand how cache line coherency works between a
  336. processor and an I/O device, you should not be using this part of the
  337. API at all.
  338. void *
  339. dma_alloc_noncoherent(struct device *dev, size_t size,
  340. dma_addr_t *dma_handle, gfp_t flag)
  341. Identical to dma_alloc_coherent() except that the platform will
  342. choose to return either consistent or non-consistent memory as it sees
  343. fit. By using this API, you are guaranteeing to the platform that you
  344. have all the correct and necessary sync points for this memory in the
  345. driver should it choose to return non-consistent memory.
  346. Note: where the platform can return consistent memory, it will
  347. guarantee that the sync points become nops.
  348. Warning: Handling non-consistent memory is a real pain. You should
  349. only use this API if you positively know your driver will be
  350. required to work on one of the rare (usually non-PCI) architectures
  351. that simply cannot make consistent memory.
  352. void
  353. dma_free_noncoherent(struct device *dev, size_t size, void *cpu_addr,
  354. dma_addr_t dma_handle)
  355. Free memory allocated by the nonconsistent API. All parameters must
  356. be identical to those passed in (and returned by
  357. dma_alloc_noncoherent()).
  358. int
  359. dma_get_cache_alignment(void)
  360. Returns the processor cache alignment. This is the absolute minimum
  361. alignment *and* width that you must observe when either mapping
  362. memory or doing partial flushes.
  363. Notes: This API may return a number *larger* than the actual cache
  364. line, but it will guarantee that one or more cache lines fit exactly
  365. into the width returned by this call. It will also always be a power
  366. of two for easy alignment.
  367. void
  368. dma_cache_sync(struct device *dev, void *vaddr, size_t size,
  369. enum dma_data_direction direction)
  370. Do a partial sync of memory that was allocated by
  371. dma_alloc_noncoherent(), starting at virtual address vaddr and
  372. continuing on for size. Again, you *must* observe the cache line
  373. boundaries when doing this.
  374. int
  375. dma_declare_coherent_memory(struct device *dev, phys_addr_t phys_addr,
  376. dma_addr_t device_addr, size_t size, int
  377. flags)
  378. Declare region of memory to be handed out by dma_alloc_coherent() when
  379. it's asked for coherent memory for this device.
  380. phys_addr is the CPU physical address to which the memory is currently
  381. assigned (this will be ioremapped so the CPU can access the region).
  382. device_addr is the DMA address the device needs to be programmed
  383. with to actually address this memory (this will be handed out as the
  384. dma_addr_t in dma_alloc_coherent()).
  385. size is the size of the area (must be multiples of PAGE_SIZE).
  386. flags can be ORed together and are:
  387. DMA_MEMORY_MAP - request that the memory returned from
  388. dma_alloc_coherent() be directly writable.
  389. DMA_MEMORY_IO - request that the memory returned from
  390. dma_alloc_coherent() be addressable using read()/write()/memcpy_toio() etc.
  391. One or both of these flags must be present.
  392. DMA_MEMORY_INCLUDES_CHILDREN - make the declared memory be allocated by
  393. dma_alloc_coherent of any child devices of this one (for memory residing
  394. on a bridge).
  395. DMA_MEMORY_EXCLUSIVE - only allocate memory from the declared regions.
  396. Do not allow dma_alloc_coherent() to fall back to system memory when
  397. it's out of memory in the declared region.
  398. The return value will be either DMA_MEMORY_MAP or DMA_MEMORY_IO and
  399. must correspond to a passed in flag (i.e. no returning DMA_MEMORY_IO
  400. if only DMA_MEMORY_MAP were passed in) for success or zero for
  401. failure.
  402. Note, for DMA_MEMORY_IO returns, all subsequent memory returned by
  403. dma_alloc_coherent() may no longer be accessed directly, but instead
  404. must be accessed using the correct bus functions. If your driver
  405. isn't prepared to handle this contingency, it should not specify
  406. DMA_MEMORY_IO in the input flags.
  407. As a simplification for the platforms, only *one* such region of
  408. memory may be declared per device.
  409. For reasons of efficiency, most platforms choose to track the declared
  410. region only at the granularity of a page. For smaller allocations,
  411. you should use the dma_pool() API.
  412. void
  413. dma_release_declared_memory(struct device *dev)
  414. Remove the memory region previously declared from the system. This
  415. API performs *no* in-use checking for this region and will return
  416. unconditionally having removed all the required structures. It is the
  417. driver's job to ensure that no parts of this memory region are
  418. currently in use.
  419. void *
  420. dma_mark_declared_memory_occupied(struct device *dev,
  421. dma_addr_t device_addr, size_t size)
  422. This is used to occupy specific regions of the declared space
  423. (dma_alloc_coherent() will hand out the first free region it finds).
  424. device_addr is the *device* address of the region requested.
  425. size is the size (and should be a page-sized multiple).
  426. The return value will be either a pointer to the processor virtual
  427. address of the memory, or an error (via PTR_ERR()) if any part of the
  428. region is occupied.
  429. Part III - Debug drivers use of the DMA-API
  430. -------------------------------------------
  431. The DMA-API as described above has some constraints. DMA addresses must be
  432. released with the corresponding function with the same size for example. With
  433. the advent of hardware IOMMUs it becomes more and more important that drivers
  434. do not violate those constraints. In the worst case such a violation can
  435. result in data corruption up to destroyed filesystems.
  436. To debug drivers and find bugs in the usage of the DMA-API checking code can
  437. be compiled into the kernel which will tell the developer about those
  438. violations. If your architecture supports it you can select the "Enable
  439. debugging of DMA-API usage" option in your kernel configuration. Enabling this
  440. option has a performance impact. Do not enable it in production kernels.
  441. If you boot the resulting kernel will contain code which does some bookkeeping
  442. about what DMA memory was allocated for which device. If this code detects an
  443. error it prints a warning message with some details into your kernel log. An
  444. example warning message may look like this:
  445. ------------[ cut here ]------------
  446. WARNING: at /data2/repos/linux-2.6-iommu/lib/dma-debug.c:448
  447. check_unmap+0x203/0x490()
  448. Hardware name:
  449. forcedeth 0000:00:08.0: DMA-API: device driver frees DMA memory with wrong
  450. function [device address=0x00000000640444be] [size=66 bytes] [mapped as
  451. single] [unmapped as page]
  452. Modules linked in: nfsd exportfs bridge stp llc r8169
  453. Pid: 0, comm: swapper Tainted: G W 2.6.28-dmatest-09289-g8bb99c0 #1
  454. Call Trace:
  455. <IRQ> [<ffffffff80240b22>] warn_slowpath+0xf2/0x130
  456. [<ffffffff80647b70>] _spin_unlock+0x10/0x30
  457. [<ffffffff80537e75>] usb_hcd_link_urb_to_ep+0x75/0xc0
  458. [<ffffffff80647c22>] _spin_unlock_irqrestore+0x12/0x40
  459. [<ffffffff8055347f>] ohci_urb_enqueue+0x19f/0x7c0
  460. [<ffffffff80252f96>] queue_work+0x56/0x60
  461. [<ffffffff80237e10>] enqueue_task_fair+0x20/0x50
  462. [<ffffffff80539279>] usb_hcd_submit_urb+0x379/0xbc0
  463. [<ffffffff803b78c3>] cpumask_next_and+0x23/0x40
  464. [<ffffffff80235177>] find_busiest_group+0x207/0x8a0
  465. [<ffffffff8064784f>] _spin_lock_irqsave+0x1f/0x50
  466. [<ffffffff803c7ea3>] check_unmap+0x203/0x490
  467. [<ffffffff803c8259>] debug_dma_unmap_page+0x49/0x50
  468. [<ffffffff80485f26>] nv_tx_done_optimized+0xc6/0x2c0
  469. [<ffffffff80486c13>] nv_nic_irq_optimized+0x73/0x2b0
  470. [<ffffffff8026df84>] handle_IRQ_event+0x34/0x70
  471. [<ffffffff8026ffe9>] handle_edge_irq+0xc9/0x150
  472. [<ffffffff8020e3ab>] do_IRQ+0xcb/0x1c0
  473. [<ffffffff8020c093>] ret_from_intr+0x0/0xa
  474. <EOI> <4>---[ end trace f6435a98e2a38c0e ]---
  475. The driver developer can find the driver and the device including a stacktrace
  476. of the DMA-API call which caused this warning.
  477. Per default only the first error will result in a warning message. All other
  478. errors will only silently counted. This limitation exist to prevent the code
  479. from flooding your kernel log. To support debugging a device driver this can
  480. be disabled via debugfs. See the debugfs interface documentation below for
  481. details.
  482. The debugfs directory for the DMA-API debugging code is called dma-api/. In
  483. this directory the following files can currently be found:
  484. dma-api/all_errors This file contains a numeric value. If this
  485. value is not equal to zero the debugging code
  486. will print a warning for every error it finds
  487. into the kernel log. Be careful with this
  488. option, as it can easily flood your logs.
  489. dma-api/disabled This read-only file contains the character 'Y'
  490. if the debugging code is disabled. This can
  491. happen when it runs out of memory or if it was
  492. disabled at boot time
  493. dma-api/error_count This file is read-only and shows the total
  494. numbers of errors found.
  495. dma-api/num_errors The number in this file shows how many
  496. warnings will be printed to the kernel log
  497. before it stops. This number is initialized to
  498. one at system boot and be set by writing into
  499. this file
  500. dma-api/min_free_entries
  501. This read-only file can be read to get the
  502. minimum number of free dma_debug_entries the
  503. allocator has ever seen. If this value goes
  504. down to zero the code will disable itself
  505. because it is not longer reliable.
  506. dma-api/num_free_entries
  507. The current number of free dma_debug_entries
  508. in the allocator.
  509. dma-api/driver-filter
  510. You can write a name of a driver into this file
  511. to limit the debug output to requests from that
  512. particular driver. Write an empty string to
  513. that file to disable the filter and see
  514. all errors again.
  515. If you have this code compiled into your kernel it will be enabled by default.
  516. If you want to boot without the bookkeeping anyway you can provide
  517. 'dma_debug=off' as a boot parameter. This will disable DMA-API debugging.
  518. Notice that you can not enable it again at runtime. You have to reboot to do
  519. so.
  520. If you want to see debug messages only for a special device driver you can
  521. specify the dma_debug_driver=<drivername> parameter. This will enable the
  522. driver filter at boot time. The debug code will only print errors for that
  523. driver afterwards. This filter can be disabled or changed later using debugfs.
  524. When the code disables itself at runtime this is most likely because it ran
  525. out of dma_debug_entries. These entries are preallocated at boot. The number
  526. of preallocated entries is defined per architecture. If it is too low for you
  527. boot with 'dma_debug_entries=<your_desired_number>' to overwrite the
  528. architectural default.
  529. void debug_dmap_mapping_error(struct device *dev, dma_addr_t dma_addr);
  530. dma-debug interface debug_dma_mapping_error() to debug drivers that fail
  531. to check DMA mapping errors on addresses returned by dma_map_single() and
  532. dma_map_page() interfaces. This interface clears a flag set by
  533. debug_dma_map_page() to indicate that dma_mapping_error() has been called by
  534. the driver. When driver does unmap, debug_dma_unmap() checks the flag and if
  535. this flag is still set, prints warning message that includes call trace that
  536. leads up to the unmap. This interface can be called from dma_mapping_error()
  537. routines to enable DMA mapping error check debugging.