2 * DMA region bookkeeping routines
4 * Copyright (C) 2002 Maas Digital LLC
6 * This code is licensed under the GPL. See the file COPYING in the root
7 * directory of the kernel sources for details.
10 #ifndef IEEE1394_DMA_H
11 #define IEEE1394_DMA_H
13 #include <linux/pci.h>
14 #include <asm/scatterlist.h>
17 * struct dma_prog_region - small contiguous DMA buffer
18 * @kvirt: kernel virtual address
20 * @n_pages: number of kernel pages
21 * @bus_addr: base bus address
23 * a small, physically contiguous DMA buffer with random-access, synchronous
24 * usage characteristics
26 struct dma_prog_region {
33 /* clear out all fields but do not allocate any memory */
34 void dma_prog_region_init(struct dma_prog_region *prog);
35 int dma_prog_region_alloc(struct dma_prog_region *prog, unsigned long n_bytes,
37 void dma_prog_region_free(struct dma_prog_region *prog);
39 static inline dma_addr_t dma_prog_region_offset_to_bus(
40 struct dma_prog_region *prog, unsigned long offset)
42 return prog->bus_addr + offset;
46 * struct dma_region - large non-contiguous DMA buffer
47 * @virt: kernel virtual address
49 * @n_pages: number of kernel pages
50 * @n_dma_pages: number of IOMMU pages
51 * @sglist: IOMMU mapping
52 * @direction: PCI_DMA_TODEVICE, etc.
54 * a large, non-physically-contiguous DMA buffer with streaming, asynchronous
55 * usage characteristics
61 unsigned int n_dma_pages;
62 struct scatterlist *sglist;
66 /* clear out all fields but do not allocate anything */
67 void dma_region_init(struct dma_region *dma);
69 /* allocate the buffer and map it to the IOMMU */
70 int dma_region_alloc(struct dma_region *dma, unsigned long n_bytes,
71 struct pci_dev *dev, int direction);
73 /* unmap and free the buffer */
74 void dma_region_free(struct dma_region *dma);
76 /* sync the CPU's view of the buffer */
77 void dma_region_sync_for_cpu(struct dma_region *dma, unsigned long offset,
80 /* sync the IO bus' view of the buffer */
81 void dma_region_sync_for_device(struct dma_region *dma, unsigned long offset,
84 /* map the buffer into a user space process */
85 int dma_region_mmap(struct dma_region *dma, struct file *file,
86 struct vm_area_struct *vma);
88 /* macro to index into a DMA region (or dma_prog_region) */
89 #define dma_region_i(_dma, _type, _index) \
90 ( ((_type*) ((_dma)->kvirt)) + (_index) )
92 /* return the DMA bus address of the byte with the given offset
93 * relative to the beginning of the dma_region */
94 dma_addr_t dma_region_offset_to_bus(struct dma_region *dma,
95 unsigned long offset);
97 #endif /* IEEE1394_DMA_H */