Blame view
Documentation/DMA-API-HOWTO.txt
28 KB
216bf58f4 Documentation: co... |
1 2 |
Dynamic DMA mapping Guide ========================= |
1da177e4c Linux-2.6.12-rc2 |
3 4 5 6 |
David S. Miller <davem@redhat.com> Richard Henderson <rth@cygnus.com> Jakub Jelinek <jakub@redhat.com> |
216bf58f4 Documentation: co... |
7 8 |
This is a guide to device driver writers on how to use the DMA API with example pseudo-code. For a concise description of the API, see |
1da177e4c Linux-2.6.12-rc2 |
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
DMA-API.txt. Most of the 64bit platforms have special hardware that translates bus addresses (DMA addresses) into physical addresses. This is similar to how page tables and/or a TLB translates virtual addresses to physical addresses on a CPU. This is needed so that e.g. PCI devices can access with a Single Address Cycle (32bit DMA address) any page in the 64bit physical address space. Previously in Linux those 64bit platforms had to set artificial limits on the maximum RAM size in the system, so that the virt_to_bus() static scheme works (the DMA address translation tables were simply filled on bootup to map each bus address to the physical page __pa(bus_to_virt())). So that Linux can use the dynamic DMA mapping, it needs some help from the drivers, namely it has to take into account that DMA addresses should be mapped only for the time they are actually used and unmapped after the DMA transfer. The following API will work of course even on platforms where no such |
216bf58f4 Documentation: co... |
28 29 30 31 32 |
hardware exists. Note that the DMA API works with any bus independent of the underlying microprocessor architecture. You should use the DMA API rather than the bus specific DMA API (e.g. pci_dma_*). |
1da177e4c Linux-2.6.12-rc2 |
33 34 |
First of all, you should make sure |
216bf58f4 Documentation: co... |
35 |
#include <linux/dma-mapping.h> |
1da177e4c Linux-2.6.12-rc2 |
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
is in your driver. This file will obtain for you the definition of the dma_addr_t (which can hold any valid DMA address for the platform) type which should be used everywhere you hold a DMA (bus) address returned from the DMA mapping functions. What memory is DMA'able? The first piece of information you must know is what kernel memory can be used with the DMA mapping facilities. There has been an unwritten set of rules regarding this, and this text is an attempt to finally write them down. If you acquired your memory via the page allocator (i.e. __get_free_page*()) or the generic memory allocators (i.e. kmalloc() or kmem_cache_alloc()) then you may DMA to/from that memory using the addresses returned from those routines. This means specifically that you may _not_ use the memory/addresses returned from vmalloc() for DMA. It is possible to DMA to the _underlying_ memory mapped into a vmalloc() area, but this requires walking page tables to get the physical addresses, and then translating each of those pages back to a kernel address using something like __va(). [ EDIT: Update this when we integrate Gerd Knorr's generic code which does this. ] |
21440d313 [PATCH] dma doc u... |
61 62 63 64 65 66 67 68 69 |
This rule also means that you may use neither kernel image addresses (items in data/text/bss segments), nor module image addresses, nor stack addresses for DMA. These could all be mapped somewhere entirely different than the rest of physical memory. Even if those classes of memory could physically work with DMA, you'd need to ensure the I/O buffers were cacheline-aligned. Without that, you'd see cacheline sharing problems (data corruption) on CPUs with DMA-incoherent caches. (The CPU could write to one word, DMA would write to a different one in the same cache line, and one of them could be overwritten.) |
1da177e4c Linux-2.6.12-rc2 |
70 71 72 73 74 75 76 77 78 79 80 |
Also, this means that you cannot take the return of a kmap() call and DMA to/from that. This is similar to vmalloc(). What about block I/O and networking buffers? The block I/O and networking subsystems make sure that the buffers they use are valid for you to DMA from/to. DMA addressing limitations Does your device have any DMA addressing limitations? For example, is |
216bf58f4 Documentation: co... |
81 82 |
your device only capable of driving the low order 24-bits of address? If so, you need to inform the kernel of this fact. |
1da177e4c Linux-2.6.12-rc2 |
83 84 |
By default, the kernel assumes that your device can address the full |
216bf58f4 Documentation: co... |
85 86 87 88 89 90 91 92 93 94 95 96 97 |
32-bits. For a 64-bit capable device, this needs to be increased. And for a device with limitations, as discussed in the previous paragraph, it needs to be decreased. Special note about PCI: PCI-X specification requires PCI-X devices to support 64-bit addressing (DAC) for all transactions. And at least one platform (SGI SN2) requires 64-bit consistent allocations to operate correctly when the IO bus is in PCI-X mode. For correct operation, you must interrogate the kernel in your device probe routine to see if the DMA controller on the machine can properly support the DMA addressing limitation your device has. It is good style to do this even if your device holds the default setting, |
1da177e4c Linux-2.6.12-rc2 |
98 99 |
because this shows that you did think about these issues wrt. your device. |
216bf58f4 Documentation: co... |
100 |
The query is performed via a call to dma_set_mask(): |
1da177e4c Linux-2.6.12-rc2 |
101 |
|
216bf58f4 Documentation: co... |
102 |
int dma_set_mask(struct device *dev, u64 mask); |
1da177e4c Linux-2.6.12-rc2 |
103 |
|
670e9f34e Documentation: re... |
104 |
The query for consistent allocations is performed via a call to |
216bf58f4 Documentation: co... |
105 |
dma_set_coherent_mask(): |
1da177e4c Linux-2.6.12-rc2 |
106 |
|
216bf58f4 Documentation: co... |
107 |
int dma_set_coherent_mask(struct device *dev, u64 mask); |
1da177e4c Linux-2.6.12-rc2 |
108 |
|
216bf58f4 Documentation: co... |
109 110 111 112 113 114 115 116 |
Here, dev is a pointer to the device struct of your device, and mask is a bit mask describing which bits of an address your device supports. It returns zero if your card can perform DMA properly on the machine given the address mask you provided. In general, the device struct of your device is embedded in the bus specific device struct of your device. For example, a pointer to the device struct of your PCI device is pdev->dev (pdev is a pointer to the PCI device struct of your device). |
1da177e4c Linux-2.6.12-rc2 |
117 |
|
84eb8d060 Fix "can not" in ... |
118 |
If it returns non-zero, your device cannot perform DMA properly on |
1da177e4c Linux-2.6.12-rc2 |
119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
this platform, and attempting to do so will result in undefined behavior. You must either use a different mask, or not use DMA. This means that in the failure case, you have three options: 1) Use another DMA mask, if possible (see below). 2) Use some non-DMA mode for data transfer, if possible. 3) Ignore this device and do not initialize it. It is recommended that your driver print a kernel KERN_WARNING message when you end up performing either #2 or #3. In this manner, if a user of your driver reports that performance is bad or that the device is not even detected, you can ask them for the kernel messages to find out exactly why. |
216bf58f4 Documentation: co... |
133 |
The standard 32-bit addressing device would do something like this: |
1da177e4c Linux-2.6.12-rc2 |
134 |
|
216bf58f4 Documentation: co... |
135 |
if (dma_set_mask(dev, DMA_BIT_MASK(32))) { |
1da177e4c Linux-2.6.12-rc2 |
136 137 138 139 140 |
printk(KERN_WARNING "mydev: No suitable DMA available. "); goto ignore_this_device; } |
216bf58f4 Documentation: co... |
141 142 143 144 145 146 147 |
Another common scenario is a 64-bit capable device. The approach here is to try for 64-bit addressing, but back down to a 32-bit mask that should not fail. The kernel may fail the 64-bit mask not because the platform is not capable of 64-bit addressing. Rather, it may fail in this case simply because 32-bit addressing is done more efficiently than 64-bit addressing. For example, Sparc64 PCI SAC addressing is more efficient than DAC addressing. |
1da177e4c Linux-2.6.12-rc2 |
148 149 150 151 152 |
Here is how you would handle a 64-bit capable device which can drive all 64-bits when accessing streaming DMA: int using_dac; |
216bf58f4 Documentation: co... |
153 |
if (!dma_set_mask(dev, DMA_BIT_MASK(64))) { |
1da177e4c Linux-2.6.12-rc2 |
154 |
using_dac = 1; |
216bf58f4 Documentation: co... |
155 |
} else if (!dma_set_mask(dev, DMA_BIT_MASK(32))) { |
1da177e4c Linux-2.6.12-rc2 |
156 157 158 159 160 161 162 163 164 165 166 167 |
using_dac = 0; } else { printk(KERN_WARNING "mydev: No suitable DMA available. "); goto ignore_this_device; } If a card is capable of using 64-bit consistent allocations as well, the case would look like this: int using_dac, consistent_using_dac; |
216bf58f4 Documentation: co... |
168 |
if (!dma_set_mask(dev, DMA_BIT_MASK(64))) { |
1da177e4c Linux-2.6.12-rc2 |
169 170 |
using_dac = 1; consistent_using_dac = 1; |
216bf58f4 Documentation: co... |
171 172 |
dma_set_coherent_mask(dev, DMA_BIT_MASK(64)); } else if (!dma_set_mask(dev, DMA_BIT_MASK(32))) { |
1da177e4c Linux-2.6.12-rc2 |
173 174 |
using_dac = 0; consistent_using_dac = 0; |
216bf58f4 Documentation: co... |
175 |
dma_set_coherent_mask(dev, DMA_BIT_MASK(32)); |
1da177e4c Linux-2.6.12-rc2 |
176 177 178 179 180 181 |
} else { printk(KERN_WARNING "mydev: No suitable DMA available. "); goto ignore_this_device; } |
216bf58f4 Documentation: co... |
182 183 |
dma_set_coherent_mask() will always be able to set the same or a smaller mask as dma_set_mask(). However for the rare case that a |
1da177e4c Linux-2.6.12-rc2 |
184 |
device driver only uses consistent allocations, one would have to |
216bf58f4 Documentation: co... |
185 |
check the return value from dma_set_coherent_mask(). |
1da177e4c Linux-2.6.12-rc2 |
186 |
|
1da177e4c Linux-2.6.12-rc2 |
187 |
Finally, if your device can only drive the low 24-bits of |
216bf58f4 Documentation: co... |
188 |
address you might do something like: |
1da177e4c Linux-2.6.12-rc2 |
189 |
|
216bf58f4 Documentation: co... |
190 |
if (dma_set_mask(dev, DMA_BIT_MASK(24))) { |
1da177e4c Linux-2.6.12-rc2 |
191 192 193 194 195 |
printk(KERN_WARNING "mydev: 24-bit DMA addressing not available. "); goto ignore_this_device; } |
216bf58f4 Documentation: co... |
196 197 |
When dma_set_mask() is successful, and returns zero, the kernel saves away this mask you have provided. The kernel will use this |
1da177e4c Linux-2.6.12-rc2 |
198 199 200 201 202 203 204 205 |
information later when you make DMA mappings. There is a case which we are aware of at this time, which is worth mentioning in this documentation. If your device supports multiple functions (for example a sound card provides playback and record functions) and the various different functions have _different_ DMA addressing limitations, you may wish to probe each mask and only provide the functionality which the machine can handle. It |
216bf58f4 Documentation: co... |
206 |
is important that the last call to dma_set_mask() be for the |
1da177e4c Linux-2.6.12-rc2 |
207 208 209 |
most specific mask. Here is pseudo-code showing how this might be done: |
2c5510d4e dma-mapping: upda... |
210 |
#define PLAYBACK_ADDRESS_BITS DMA_BIT_MASK(32) |
038f7d002 use DMA_BIT_MASK ... |
211 |
#define RECORD_ADDRESS_BITS DMA_BIT_MASK(24) |
1da177e4c Linux-2.6.12-rc2 |
212 213 |
struct my_sound_card *card; |
216bf58f4 Documentation: co... |
214 |
struct device *dev; |
1da177e4c Linux-2.6.12-rc2 |
215 216 |
... |
216bf58f4 Documentation: co... |
217 |
if (!dma_set_mask(dev, PLAYBACK_ADDRESS_BITS)) { |
1da177e4c Linux-2.6.12-rc2 |
218 219 220 |
card->playback_enabled = 1; } else { card->playback_enabled = 0; |
472c06441 Use KERN_WARNING ... |
221 222 |
printk(KERN_WARNING "%s: Playback disabled due to DMA limitations. ", |
1da177e4c Linux-2.6.12-rc2 |
223 224 |
card->name); } |
216bf58f4 Documentation: co... |
225 |
if (!dma_set_mask(dev, RECORD_ADDRESS_BITS)) { |
1da177e4c Linux-2.6.12-rc2 |
226 227 228 |
card->record_enabled = 1; } else { card->record_enabled = 0; |
472c06441 Use KERN_WARNING ... |
229 230 |
printk(KERN_WARNING "%s: Record disabled due to DMA limitations. ", |
1da177e4c Linux-2.6.12-rc2 |
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
card->name); } A sound card was used as an example here because this genre of PCI devices seems to be littered with ISA chips given a PCI front end, and thus retaining the 16MB DMA addressing limitations of ISA. Types of DMA mappings There are two types of DMA mappings: - Consistent DMA mappings which are usually mapped at driver initialization, unmapped at the end and for which the hardware should guarantee that the device and the CPU can access the data in parallel and will see updates made by each other without any explicit software flushing. Think of "consistent" as "synchronous" or "coherent". The current default is to return consistent memory in the low 32 |
216bf58f4 Documentation: co... |
251 252 |
bits of the bus space. However, for future compatibility you should set the consistent mask even if this default is fine for your |
1da177e4c Linux-2.6.12-rc2 |
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
driver. Good examples of what to use consistent mappings for are: - Network card DMA ring descriptors. - SCSI adapter mailbox command data structures. - Device firmware microcode executed out of main memory. The invariant these examples all require is that any CPU store to memory is immediately visible to the device, and vice versa. Consistent mappings guarantee this. IMPORTANT: Consistent DMA memory does not preclude the usage of proper memory barriers. The CPU may reorder stores to consistent memory just as it may normal memory. Example: if it is important for the device to see the first word of a descriptor updated before the second, you must do something like: desc->word0 = address; wmb(); desc->word1 = DESC_VALID; in order to get correct behavior on all platforms. |
21440d313 [PATCH] dma doc u... |
278 279 280 281 |
Also, on some platforms your driver may need to flush CPU write buffers in much the same way as it needs to flush write buffers found in PCI bridges (such as by reading a register's value after writing it). |
216bf58f4 Documentation: co... |
282 283 284 |
- Streaming DMA mappings which are usually mapped for one DMA transfer, unmapped right after it (unless you use dma_sync_* below) and for which hardware can optimize for sequential accesses. |
1da177e4c Linux-2.6.12-rc2 |
285 286 287 288 289 290 291 292 293 294 295 296 297 |
This of "streaming" as "asynchronous" or "outside the coherency domain". Good examples of what to use streaming mappings for are: - Networking buffers transmitted/received by a device. - Filesystem buffers written/read by a SCSI device. The interfaces for using this type of mapping were designed in such a way that an implementation can make whatever performance optimizations the hardware allows. To this end, when using such mappings you must be explicit about what you want to happen. |
216bf58f4 Documentation: co... |
298 299 |
Neither type of DMA mapping has alignment restrictions that come from the underlying bus, although some devices may have such restrictions. |
21440d313 [PATCH] dma doc u... |
300 301 |
Also, systems with caches that aren't DMA-coherent will work better when the underlying buffers don't share cache lines with other data. |
1da177e4c Linux-2.6.12-rc2 |
302 303 304 305 306 307 308 |
Using Consistent DMA mappings. To allocate and map large (PAGE_SIZE or so) consistent DMA regions, you should do: dma_addr_t dma_handle; |
216bf58f4 Documentation: co... |
309 |
cpu_addr = dma_alloc_coherent(dev, size, &dma_handle, gfp); |
1da177e4c Linux-2.6.12-rc2 |
310 |
|
216bf58f4 Documentation: co... |
311 312 |
where device is a struct device *. This may be called in interrupt context with the GFP_ATOMIC flag. |
1da177e4c Linux-2.6.12-rc2 |
313 314 315 316 317 318 |
Size is the length of the region you want to allocate, in bytes. This routine will allocate RAM for that region, so it acts similarly to __get_free_pages (but takes size instead of a page order). If your driver needs regions sized smaller than a page, you may prefer using |
216bf58f4 Documentation: co... |
319 320 321 322 323 324 325 326 327 328 329 |
the dma_pool interface, described below. The consistent DMA mapping interfaces, for non-NULL dev, will by default return a DMA address which is 32-bit addressable. Even if the device indicates (via DMA mask) that it may address the upper 32-bits, consistent allocation will only return > 32-bit addresses for DMA if the consistent DMA mask has been explicitly changed via dma_set_coherent_mask(). This is true of the dma_pool interface as well. dma_alloc_coherent returns two values: the virtual address which you |
1da177e4c Linux-2.6.12-rc2 |
330 331 332 333 334 335 336 337 338 339 340 |
can use to access it from the CPU and dma_handle which you pass to the card. The cpu return address and the DMA bus master address are both guaranteed to be aligned to the smallest PAGE_SIZE order which is greater than or equal to the requested size. This invariant exists (for example) to guarantee that if you allocate a chunk which is smaller than or equal to 64 kilobytes, the extent of the buffer you receive will not cross a 64K boundary. To unmap and free such a DMA region, you call: |
216bf58f4 Documentation: co... |
341 |
dma_free_coherent(dev, size, cpu_addr, dma_handle); |
1da177e4c Linux-2.6.12-rc2 |
342 |
|
216bf58f4 Documentation: co... |
343 344 |
where dev, size are the same as in the above call and cpu_addr and dma_handle are the values dma_alloc_coherent returned to you. |
1da177e4c Linux-2.6.12-rc2 |
345 346 347 |
This function may not be called in interrupt context. If your driver needs lots of smaller memory regions, you can write |
216bf58f4 Documentation: co... |
348 349 350 |
custom code to subdivide pages returned by dma_alloc_coherent, or you can use the dma_pool API to do that. A dma_pool is like a kmem_cache, but it uses dma_alloc_coherent not __get_free_pages. |
1da177e4c Linux-2.6.12-rc2 |
351 352 |
Also, it understands common hardware constraints for alignment, like queue heads needing to be aligned on N byte boundaries. |
216bf58f4 Documentation: co... |
353 |
Create a dma_pool like this: |
1da177e4c Linux-2.6.12-rc2 |
354 |
|
216bf58f4 Documentation: co... |
355 |
struct dma_pool *pool; |
1da177e4c Linux-2.6.12-rc2 |
356 |
|
216bf58f4 Documentation: co... |
357 |
pool = dma_pool_create(name, dev, size, align, alloc); |
1da177e4c Linux-2.6.12-rc2 |
358 |
|
216bf58f4 Documentation: co... |
359 |
The "name" is for diagnostics (like a kmem_cache name); dev and size |
1da177e4c Linux-2.6.12-rc2 |
360 361 362 363 364 |
are as above. The device's hardware alignment requirement for this type of data is "align" (which is expressed in bytes, and must be a power of two). If your device has no boundary crossing restrictions, pass 0 for alloc; passing 4096 says memory allocated from this pool must not cross 4KByte boundaries (but at that time it may be better to |
216bf58f4 Documentation: co... |
365 |
go for dma_alloc_coherent directly instead). |
1da177e4c Linux-2.6.12-rc2 |
366 |
|
216bf58f4 Documentation: co... |
367 |
Allocate memory from a dma pool like this: |
1da177e4c Linux-2.6.12-rc2 |
368 |
|
216bf58f4 Documentation: co... |
369 |
cpu_addr = dma_pool_alloc(pool, flags, &dma_handle); |
1da177e4c Linux-2.6.12-rc2 |
370 371 |
flags are SLAB_KERNEL if blocking is permitted (not in_interrupt nor |
216bf58f4 Documentation: co... |
372 |
holding SMP locks), SLAB_ATOMIC otherwise. Like dma_alloc_coherent, |
1da177e4c Linux-2.6.12-rc2 |
373 |
this returns two values, cpu_addr and dma_handle. |
216bf58f4 Documentation: co... |
374 |
Free memory that was allocated from a dma_pool like this: |
1da177e4c Linux-2.6.12-rc2 |
375 |
|
216bf58f4 Documentation: co... |
376 |
dma_pool_free(pool, cpu_addr, dma_handle); |
1da177e4c Linux-2.6.12-rc2 |
377 |
|
216bf58f4 Documentation: co... |
378 379 |
where pool is what you passed to dma_pool_alloc, and cpu_addr and dma_handle are the values dma_pool_alloc returned. This function |
1da177e4c Linux-2.6.12-rc2 |
380 |
may be called in interrupt context. |
216bf58f4 Documentation: co... |
381 |
Destroy a dma_pool by calling: |
1da177e4c Linux-2.6.12-rc2 |
382 |
|
216bf58f4 Documentation: co... |
383 |
dma_pool_destroy(pool); |
1da177e4c Linux-2.6.12-rc2 |
384 |
|
216bf58f4 Documentation: co... |
385 |
Make sure you've called dma_pool_free for all memory allocated |
1da177e4c Linux-2.6.12-rc2 |
386 387 388 389 390 391 392 393 |
from a pool before you destroy the pool. This function may not be called in interrupt context. DMA Direction The interfaces described in subsequent portions of this document take a DMA direction argument, which is an integer and takes on one of the following values: |
216bf58f4 Documentation: co... |
394 395 396 397 |
DMA_BIDIRECTIONAL DMA_TO_DEVICE DMA_FROM_DEVICE DMA_NONE |
1da177e4c Linux-2.6.12-rc2 |
398 399 |
One should provide the exact DMA direction if you know it. |
216bf58f4 Documentation: co... |
400 401 |
DMA_TO_DEVICE means "from main memory to the device" DMA_FROM_DEVICE means "from the device to main memory" |
1da177e4c Linux-2.6.12-rc2 |
402 403 404 405 406 407 408 |
It is the direction in which the data moves during the DMA transfer. You are _strongly_ encouraged to specify this as precisely as you possibly can. If you absolutely cannot know the direction of the DMA transfer, |
216bf58f4 Documentation: co... |
409 |
specify DMA_BIDIRECTIONAL. It means that the DMA can go in |
1da177e4c Linux-2.6.12-rc2 |
410 411 412 |
either direction. The platform guarantees that you may legally specify this, and that it will work, but this may be at the cost of performance for example. |
216bf58f4 Documentation: co... |
413 |
The value DMA_NONE is to be used for debugging. One can |
1da177e4c Linux-2.6.12-rc2 |
414 415 416 417 418 419 420 421 422 |
hold this in a data structure before you come to know the precise direction, and this will help catch cases where your direction tracking logic has failed to set things up properly. Another advantage of specifying this value precisely (outside of potential platform-specific optimizations of such) is for debugging. Some platforms actually have a write permission boolean which DMA mappings can be marked with, much like page protections in the user program address space. Such platforms can and do report errors in the |
216bf58f4 Documentation: co... |
423 |
kernel logs when the DMA controller hardware detects violation of the |
1da177e4c Linux-2.6.12-rc2 |
424 425 426 427 |
permission setting. Only streaming mappings specify a direction, consistent mappings implicitly have a direction attribute setting of |
216bf58f4 Documentation: co... |
428 |
DMA_BIDIRECTIONAL. |
1da177e4c Linux-2.6.12-rc2 |
429 |
|
be7db055d [PATCH] remove ol... |
430 431 432 |
The SCSI subsystem tells you the direction to use in the 'sc_data_direction' member of the SCSI command your driver is working on. |
1da177e4c Linux-2.6.12-rc2 |
433 434 |
For Networking drivers, it's a rather simple affair. For transmit |
216bf58f4 Documentation: co... |
435 |
packets, map/unmap them with the DMA_TO_DEVICE direction |
1da177e4c Linux-2.6.12-rc2 |
436 |
specifier. For receive packets, just the opposite, map/unmap them |
216bf58f4 Documentation: co... |
437 |
with the DMA_FROM_DEVICE direction specifier. |
1da177e4c Linux-2.6.12-rc2 |
438 439 440 441 442 443 444 445 446 |
Using Streaming DMA mappings The streaming DMA mapping routines can be called from interrupt context. There are two versions of each map/unmap, one which will map/unmap a single memory region, and one which will map/unmap a scatterlist. To map a single region, you do: |
216bf58f4 Documentation: co... |
447 |
struct device *dev = &my_dev->dev; |
1da177e4c Linux-2.6.12-rc2 |
448 449 450 |
dma_addr_t dma_handle; void *addr = buffer->ptr; size_t size = buffer->len; |
216bf58f4 Documentation: co... |
451 |
dma_handle = dma_map_single(dev, addr, size, direction); |
1da177e4c Linux-2.6.12-rc2 |
452 453 |
and to unmap it: |
216bf58f4 Documentation: co... |
454 |
dma_unmap_single(dev, dma_handle, size, direction); |
1da177e4c Linux-2.6.12-rc2 |
455 |
|
216bf58f4 Documentation: co... |
456 |
You should call dma_unmap_single when the DMA activity is finished, e.g. |
1da177e4c Linux-2.6.12-rc2 |
457 458 459 460 |
from the interrupt which told you that the DMA transfer is done. Using cpu pointers like this for single mappings has a disadvantage, you cannot reference HIGHMEM memory in this way. Thus, there is a |
216bf58f4 Documentation: co... |
461 |
map/unmap interface pair akin to dma_{map,unmap}_single. These |
1da177e4c Linux-2.6.12-rc2 |
462 463 |
interfaces deal with page/offset pairs instead of cpu pointers. Specifically: |
216bf58f4 Documentation: co... |
464 |
struct device *dev = &my_dev->dev; |
1da177e4c Linux-2.6.12-rc2 |
465 466 467 468 |
dma_addr_t dma_handle; struct page *page = buffer->page; unsigned long offset = buffer->offset; size_t size = buffer->len; |
216bf58f4 Documentation: co... |
469 |
dma_handle = dma_map_page(dev, page, offset, size, direction); |
1da177e4c Linux-2.6.12-rc2 |
470 471 |
... |
216bf58f4 Documentation: co... |
472 |
dma_unmap_page(dev, dma_handle, size, direction); |
1da177e4c Linux-2.6.12-rc2 |
473 474 475 476 |
Here, "offset" means byte offset within the given page. With scatterlists, you map a region gathered from several regions by: |
216bf58f4 Documentation: co... |
477 |
int i, count = dma_map_sg(dev, sglist, nents, direction); |
1da177e4c Linux-2.6.12-rc2 |
478 |
struct scatterlist *sg; |
4c2f6d4c2 use sg helper fun... |
479 |
for_each_sg(sglist, sg, count, i) { |
1da177e4c Linux-2.6.12-rc2 |
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 |
hw_address[i] = sg_dma_address(sg); hw_len[i] = sg_dma_len(sg); } where nents is the number of entries in the sglist. The implementation is free to merge several consecutive sglist entries into one (e.g. if DMA mapping is done with PAGE_SIZE granularity, any consecutive sglist entries can be merged into one provided the first one ends and the second one starts on a page boundary - in fact this is a huge advantage for cards which either cannot do scatter-gather or have very limited number of scatter-gather entries) and returns the actual number of sg entries it mapped them to. On failure 0 is returned. Then you should loop count times (note: this can be less than nents times) and use sg_dma_address() and sg_dma_len() macros where you previously accessed sg->address and sg->length as shown above. To unmap a scatterlist, just call: |
216bf58f4 Documentation: co... |
499 |
dma_unmap_sg(dev, sglist, nents, direction); |
1da177e4c Linux-2.6.12-rc2 |
500 501 |
Again, make sure DMA activity has already finished. |
216bf58f4 Documentation: co... |
502 503 |
PLEASE NOTE: The 'nents' argument to the dma_unmap_sg call must be the _same_ one you passed into the dma_map_sg call, |
1da177e4c Linux-2.6.12-rc2 |
504 |
it should _NOT_ be the 'count' value _returned_ from the |
216bf58f4 Documentation: co... |
505 |
dma_map_sg call. |
1da177e4c Linux-2.6.12-rc2 |
506 |
|
216bf58f4 Documentation: co... |
507 |
Every dma_map_{single,sg} call should have its dma_unmap_{single,sg} |
1da177e4c Linux-2.6.12-rc2 |
508 509 510 511 512 513 514 515 516 |
counterpart, because the bus address space is a shared resource (although in some ports the mapping is per each BUS so less devices contend for the same bus address space) and you could render the machine unusable by eating all bus addresses. If you need to use the same streaming DMA region multiple times and touch the data in between the DMA transfers, the buffer needs to be synced properly in order for the cpu and device to see the most uptodate and correct copy of the DMA buffer. |
216bf58f4 Documentation: co... |
517 |
So, firstly, just map it with dma_map_{single,sg}, and after each DMA |
1da177e4c Linux-2.6.12-rc2 |
518 |
transfer call either: |
216bf58f4 Documentation: co... |
519 |
dma_sync_single_for_cpu(dev, dma_handle, size, direction); |
1da177e4c Linux-2.6.12-rc2 |
520 521 |
or: |
216bf58f4 Documentation: co... |
522 |
dma_sync_sg_for_cpu(dev, sglist, nents, direction); |
1da177e4c Linux-2.6.12-rc2 |
523 524 525 526 527 528 |
as appropriate. Then, if you wish to let the device get at the DMA area again, finish accessing the data with the cpu, and then before actually giving the buffer to the hardware call either: |
216bf58f4 Documentation: co... |
529 |
dma_sync_single_for_device(dev, dma_handle, size, direction); |
1da177e4c Linux-2.6.12-rc2 |
530 531 |
or: |
216bf58f4 Documentation: co... |
532 |
dma_sync_sg_for_device(dev, sglist, nents, direction); |
1da177e4c Linux-2.6.12-rc2 |
533 534 535 536 |
as appropriate. After the last DMA transfer call one of the DMA unmap routines |
216bf58f4 Documentation: co... |
537 538 |
dma_unmap_{single,sg}. If you don't touch the data from the first dma_map_* call till dma_unmap_*, then you don't have to call the dma_sync_* |
1da177e4c Linux-2.6.12-rc2 |
539 540 541 |
routines at all. Here is pseudo code which shows a situation in which you would need |
216bf58f4 Documentation: co... |
542 |
to use the dma_sync_*() interfaces. |
1da177e4c Linux-2.6.12-rc2 |
543 544 545 546 |
my_card_setup_receive_buffer(struct my_card *cp, char *buffer, int len) { dma_addr_t mapping; |
216bf58f4 Documentation: co... |
547 |
mapping = dma_map_single(cp->dev, buffer, len, DMA_FROM_DEVICE); |
1da177e4c Linux-2.6.12-rc2 |
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
cp->rx_buf = buffer; cp->rx_len = len; cp->rx_dma = mapping; give_rx_buf_to_card(cp); } ... my_card_interrupt_handler(int irq, void *devid, struct pt_regs *regs) { struct my_card *cp = devid; ... if (read_card_status(cp) == RX_BUF_TRANSFERRED) { struct my_card_header *hp; /* Examine the header to see if we wish * to accept the data. But synchronize * the DMA transfer with the CPU first * so that we see updated contents. */ |
216bf58f4 Documentation: co... |
571 572 573 |
dma_sync_single_for_cpu(&cp->dev, cp->rx_dma, cp->rx_len, DMA_FROM_DEVICE); |
1da177e4c Linux-2.6.12-rc2 |
574 575 576 577 |
/* Now it is safe to examine the buffer. */ hp = (struct my_card_header *) cp->rx_buf; if (header_is_ok(hp)) { |
216bf58f4 Documentation: co... |
578 579 |
dma_unmap_single(&cp->dev, cp->rx_dma, cp->rx_len, DMA_FROM_DEVICE); |
1da177e4c Linux-2.6.12-rc2 |
580 581 582 583 584 585 |
pass_to_upper_layers(cp->rx_buf); make_and_setup_new_rx_buf(cp); } else { /* Just sync the buffer and give it back * to the card. */ |
216bf58f4 Documentation: co... |
586 587 588 589 |
dma_sync_single_for_device(&cp->dev, cp->rx_dma, cp->rx_len, DMA_FROM_DEVICE); |
1da177e4c Linux-2.6.12-rc2 |
590 591 592 593 594 595 596 597 598 |
give_rx_buf_to_card(cp); } } } Drivers converted fully to this interface should not use virt_to_bus any longer, nor should they use bus_to_virt. Some drivers have to be changed a little bit, because there is no longer an equivalent to bus_to_virt in the dynamic DMA mapping scheme - you have to always store the DMA addresses |
216bf58f4 Documentation: co... |
599 600 |
returned by the dma_alloc_coherent, dma_pool_alloc, and dma_map_single calls (dma_map_sg stores them in the scatterlist itself if the platform |
1da177e4c Linux-2.6.12-rc2 |
601 602 |
supports dynamic DMA mapping in hardware) in your driver structures and/or in the card registers. |
216bf58f4 Documentation: co... |
603 604 |
All drivers should be using these interfaces with no exceptions. It is planned to completely remove virt_to_bus() and bus_to_virt() as |
1da177e4c Linux-2.6.12-rc2 |
605 606 |
they are entirely deprecated. Some ports already do not provide these as it is impossible to correctly support them. |
4ae9ca825 Documentation: mo... |
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 |
Handling Errors DMA address space is limited on some architectures and an allocation failure can be determined by: - checking if dma_alloc_coherent returns NULL or dma_map_sg returns 0 - checking the returned dma_addr_t of dma_map_single and dma_map_page by using dma_mapping_error(): dma_addr_t dma_handle; dma_handle = dma_map_single(dev, addr, size, direction); if (dma_mapping_error(dev, dma_handle)) { /* * reduce current DMA mapping usage, * delay and try again later or * reset driver. */ } Networking drivers must call dev_kfree_skb to free the socket buffer and return NETDEV_TX_OK if the DMA mapping fails on the transmit hook (ndo_start_xmit). This means that the socket buffer is just dropped in the failure case. SCSI drivers must return SCSI_MLQUEUE_HOST_BUSY if the DMA mapping fails in the queuecommand hook. This means that the SCSI subsystem passes the command to the driver again later. |
1da177e4c Linux-2.6.12-rc2 |
636 |
Optimizing Unmap State Space Consumption |
216bf58f4 Documentation: co... |
637 |
On many platforms, dma_unmap_{single,page}() is simply a nop. |
1da177e4c Linux-2.6.12-rc2 |
638 639 640 641 642 643 644 |
Therefore, keeping track of the mapping address and length is a waste of space. Instead of filling your drivers up with ifdefs and the like to "work around" this (which would defeat the whole purpose of a portable API) the following facilities are provided. Actually, instead of describing the macros one by one, we'll transform some example code. |
216bf58f4 Documentation: co... |
645 |
1) Use DEFINE_DMA_UNMAP_{ADDR,LEN} in state saving structures. |
1da177e4c Linux-2.6.12-rc2 |
646 647 648 649 650 651 652 653 654 655 656 657 |
Example, before: struct ring_state { struct sk_buff *skb; dma_addr_t mapping; __u32 len; }; after: struct ring_state { struct sk_buff *skb; |
216bf58f4 Documentation: co... |
658 659 |
DEFINE_DMA_UNMAP_ADDR(mapping); DEFINE_DMA_UNMAP_LEN(len); |
1da177e4c Linux-2.6.12-rc2 |
660 |
}; |
216bf58f4 Documentation: co... |
661 |
2) Use dma_unmap_{addr,len}_set to set these values. |
1da177e4c Linux-2.6.12-rc2 |
662 663 664 665 666 667 |
Example, before: ringp->mapping = FOO; ringp->len = BAR; after: |
216bf58f4 Documentation: co... |
668 669 |
dma_unmap_addr_set(ringp, mapping, FOO); dma_unmap_len_set(ringp, len, BAR); |
1da177e4c Linux-2.6.12-rc2 |
670 |
|
216bf58f4 Documentation: co... |
671 |
3) Use dma_unmap_{addr,len} to access these values. |
1da177e4c Linux-2.6.12-rc2 |
672 |
Example, before: |
216bf58f4 Documentation: co... |
673 674 |
dma_unmap_single(dev, ringp->mapping, ringp->len, DMA_FROM_DEVICE); |
1da177e4c Linux-2.6.12-rc2 |
675 676 |
after: |
216bf58f4 Documentation: co... |
677 678 679 680 |
dma_unmap_single(dev, dma_unmap_addr(ringp, mapping), dma_unmap_len(ringp, len), DMA_FROM_DEVICE); |
1da177e4c Linux-2.6.12-rc2 |
681 682 683 684 685 686 687 688 689 690 691 692 |
It really should be self-explanatory. We treat the ADDR and LEN separately, because it is possible for an implementation to only need the address in order to perform the unmap operation. Platform Issues If you are just writing drivers for Linux and do not maintain an architecture port for the kernel, you can safely skip down to "Closing". 1) Struct scatterlist requirements. |
b02de8716 Documentation: up... |
693 694 695 696 |
Don't invent the architecture specific struct scatterlist; just use <asm-generic/scatterlist.h>. You need to enable CONFIG_NEED_SG_DMA_LENGTH if the architecture supports IOMMUs (including software IOMMU). |
1da177e4c Linux-2.6.12-rc2 |
697 |
|
ce00f7feb Documentation: DM... |
698 |
2) ARCH_DMA_MINALIGN |
2fd74e25d Documentation/DMA... |
699 700 701 702 703 |
Architectures must ensure that kmalloc'ed buffer is DMA-safe. Drivers and subsystems depend on it. If an architecture isn't fully DMA-coherent (i.e. hardware doesn't ensure that data in the CPU cache is identical to data in main memory), |
ce00f7feb Documentation: DM... |
704 |
ARCH_DMA_MINALIGN must be set so that the memory allocator |
2fd74e25d Documentation/DMA... |
705 706 |
makes sure that kmalloc'ed buffer doesn't share a cache line with the others. See arch/arm/include/asm/cache.h as an example. |
ce00f7feb Documentation: DM... |
707 |
Note that ARCH_DMA_MINALIGN is about DMA memory alignment |
2fd74e25d Documentation/DMA... |
708 709 710 |
constraints. You don't need to worry about the architecture data alignment constraints (e.g. the alignment constraints about 64-bit objects). |
1da177e4c Linux-2.6.12-rc2 |
711 |
|
c31e74c4c Documentation: DM... |
712 713 714 715 716 717 718 719 720 |
3) Supporting multiple types of IOMMUs If your architecture needs to support multiple types of IOMMUs, you can use include/linux/asm-generic/dma-mapping-common.h. It's a library to support the DMA API with multiple types of IOMMUs. Lots of architectures (x86, powerpc, sh, alpha, ia64, microblaze and sparc) use it. Choose one to see how it can be used. If you need to support multiple types of IOMMUs in a single system, the example of x86 or powerpc helps. |
1da177e4c Linux-2.6.12-rc2 |
721 |
Closing |
a33f32244 Documentation/: i... |
722 |
This document, and the API itself, would not be in its current |
1da177e4c Linux-2.6.12-rc2 |
723 724 725 726 727 728 729 730 731 732 733 |
form without the feedback and suggestions from numerous individuals. We would like to specifically mention, in no particular order, the following people: Russell King <rmk@arm.linux.org.uk> Leo Dagum <dagum@barrel.engr.sgi.com> Ralf Baechle <ralf@oss.sgi.com> Grant Grundler <grundler@cup.hp.com> Jay Estabrook <Jay.Estabrook@compaq.com> Thomas Sailer <sailer@ife.ee.ethz.ch> Andrea Arcangeli <andrea@suse.de> |
26bbb29a2 Update Jens Axboe... |
734 |
Jens Axboe <jens.axboe@oracle.com> |
1da177e4c Linux-2.6.12-rc2 |
735 |
David Mosberger-Tang <davidm@hpl.hp.com> |