dma-mapping: mark DMA_nBITS_MASK as deprecated
[linux-2.6.git] / include / linux / dma-mapping.h
1 #ifndef _LINUX_DMA_MAPPING_H
2 #define _LINUX_DMA_MAPPING_H
3
4 #include <linux/device.h>
5 #include <linux/err.h>
6 #include <linux/dma-attrs.h>
7 #include <linux/scatterlist.h>
8
9 /* These definitions mirror those in pci.h, so they can be used
10  * interchangeably with their PCI_ counterparts */
11 enum dma_data_direction {
12         DMA_BIDIRECTIONAL = 0,
13         DMA_TO_DEVICE = 1,
14         DMA_FROM_DEVICE = 2,
15         DMA_NONE = 3,
16 };
17
18 struct dma_map_ops {
19         void* (*alloc_coherent)(struct device *dev, size_t size,
20                                 dma_addr_t *dma_handle, gfp_t gfp);
21         void (*free_coherent)(struct device *dev, size_t size,
22                               void *vaddr, dma_addr_t dma_handle);
23         dma_addr_t (*map_page)(struct device *dev, struct page *page,
24                                unsigned long offset, size_t size,
25                                enum dma_data_direction dir,
26                                struct dma_attrs *attrs);
27         void (*unmap_page)(struct device *dev, dma_addr_t dma_handle,
28                            size_t size, enum dma_data_direction dir,
29                            struct dma_attrs *attrs);
30         int (*map_sg)(struct device *dev, struct scatterlist *sg,
31                       int nents, enum dma_data_direction dir,
32                       struct dma_attrs *attrs);
33         void (*unmap_sg)(struct device *dev,
34                          struct scatterlist *sg, int nents,
35                          enum dma_data_direction dir,
36                          struct dma_attrs *attrs);
37         void (*sync_single_for_cpu)(struct device *dev,
38                                     dma_addr_t dma_handle, size_t size,
39                                     enum dma_data_direction dir);
40         void (*sync_single_for_device)(struct device *dev,
41                                        dma_addr_t dma_handle, size_t size,
42                                        enum dma_data_direction dir);
43         void (*sync_single_range_for_cpu)(struct device *dev,
44                                           dma_addr_t dma_handle,
45                                           unsigned long offset,
46                                           size_t size,
47                                           enum dma_data_direction dir);
48         void (*sync_single_range_for_device)(struct device *dev,
49                                              dma_addr_t dma_handle,
50                                              unsigned long offset,
51                                              size_t size,
52                                              enum dma_data_direction dir);
53         void (*sync_sg_for_cpu)(struct device *dev,
54                                 struct scatterlist *sg, int nents,
55                                 enum dma_data_direction dir);
56         void (*sync_sg_for_device)(struct device *dev,
57                                    struct scatterlist *sg, int nents,
58                                    enum dma_data_direction dir);
59         int (*mapping_error)(struct device *dev, dma_addr_t dma_addr);
60         int (*dma_supported)(struct device *dev, u64 mask);
61         int is_phys;
62 };
63
64 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL<<(n))-1))
65
66 typedef u64 DMA_nnBIT_MASK __deprecated;
67
68 /*
69  * NOTE: do not use the below macros in new code and do not add new definitions
70  * here.
71  *
72  * Instead, just open-code DMA_BIT_MASK(n) within your driver
73  */
74 #define DMA_64BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(64)
75 #define DMA_48BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(48)
76 #define DMA_47BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(47)
77 #define DMA_40BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(40)
78 #define DMA_39BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(39)
79 #define DMA_35BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(35)
80 #define DMA_32BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(32)
81 #define DMA_31BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(31)
82 #define DMA_30BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(30)
83 #define DMA_29BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(29)
84 #define DMA_28BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(28)
85 #define DMA_24BIT_MASK  (DMA_nnBIT_MASK)DMA_BIT_MASK(24)
86
87 #define DMA_MASK_NONE   0x0ULL
88
89 static inline int valid_dma_direction(int dma_direction)
90 {
91         return ((dma_direction == DMA_BIDIRECTIONAL) ||
92                 (dma_direction == DMA_TO_DEVICE) ||
93                 (dma_direction == DMA_FROM_DEVICE));
94 }
95
96 static inline int is_device_dma_capable(struct device *dev)
97 {
98         return dev->dma_mask != NULL && *dev->dma_mask != DMA_MASK_NONE;
99 }
100
101 static inline int is_buffer_dma_capable(u64 mask, dma_addr_t addr, size_t size)
102 {
103         return addr + size <= mask;
104 }
105
106 #ifdef CONFIG_HAS_DMA
107 #include <asm/dma-mapping.h>
108 #else
109 #include <asm-generic/dma-mapping-broken.h>
110 #endif
111
112 /* Backwards compat, remove in 2.7.x */
113 #define dma_sync_single         dma_sync_single_for_cpu
114 #define dma_sync_sg             dma_sync_sg_for_cpu
115
116 static inline u64 dma_get_mask(struct device *dev)
117 {
118         if (dev && dev->dma_mask && *dev->dma_mask)
119                 return *dev->dma_mask;
120         return DMA_BIT_MASK(32);
121 }
122
123 extern u64 dma_get_required_mask(struct device *dev);
124
125 static inline unsigned int dma_get_max_seg_size(struct device *dev)
126 {
127         return dev->dma_parms ? dev->dma_parms->max_segment_size : 65536;
128 }
129
130 static inline unsigned int dma_set_max_seg_size(struct device *dev,
131                                                 unsigned int size)
132 {
133         if (dev->dma_parms) {
134                 dev->dma_parms->max_segment_size = size;
135                 return 0;
136         } else
137                 return -EIO;
138 }
139
140 static inline unsigned long dma_get_seg_boundary(struct device *dev)
141 {
142         return dev->dma_parms ?
143                 dev->dma_parms->segment_boundary_mask : 0xffffffff;
144 }
145
146 static inline int dma_set_seg_boundary(struct device *dev, unsigned long mask)
147 {
148         if (dev->dma_parms) {
149                 dev->dma_parms->segment_boundary_mask = mask;
150                 return 0;
151         } else
152                 return -EIO;
153 }
154
155 /* flags for the coherent memory api */
156 #define DMA_MEMORY_MAP                  0x01
157 #define DMA_MEMORY_IO                   0x02
158 #define DMA_MEMORY_INCLUDES_CHILDREN    0x04
159 #define DMA_MEMORY_EXCLUSIVE            0x08
160
161 #ifndef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
162 static inline int
163 dma_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
164                             dma_addr_t device_addr, size_t size, int flags)
165 {
166         return 0;
167 }
168
169 static inline void
170 dma_release_declared_memory(struct device *dev)
171 {
172 }
173
174 static inline void *
175 dma_mark_declared_memory_occupied(struct device *dev,
176                                   dma_addr_t device_addr, size_t size)
177 {
178         return ERR_PTR(-EBUSY);
179 }
180 #endif
181
182 /*
183  * Managed DMA API
184  */
185 extern void *dmam_alloc_coherent(struct device *dev, size_t size,
186                                  dma_addr_t *dma_handle, gfp_t gfp);
187 extern void dmam_free_coherent(struct device *dev, size_t size, void *vaddr,
188                                dma_addr_t dma_handle);
189 extern void *dmam_alloc_noncoherent(struct device *dev, size_t size,
190                                     dma_addr_t *dma_handle, gfp_t gfp);
191 extern void dmam_free_noncoherent(struct device *dev, size_t size, void *vaddr,
192                                   dma_addr_t dma_handle);
193 #ifdef ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY
194 extern int dmam_declare_coherent_memory(struct device *dev, dma_addr_t bus_addr,
195                                         dma_addr_t device_addr, size_t size,
196                                         int flags);
197 extern void dmam_release_declared_memory(struct device *dev);
198 #else /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */
199 static inline int dmam_declare_coherent_memory(struct device *dev,
200                                 dma_addr_t bus_addr, dma_addr_t device_addr,
201                                 size_t size, gfp_t gfp)
202 {
203         return 0;
204 }
205
206 static inline void dmam_release_declared_memory(struct device *dev)
207 {
208 }
209 #endif /* ARCH_HAS_DMA_DECLARE_COHERENT_MEMORY */
210
211 #ifndef CONFIG_HAVE_DMA_ATTRS
212 struct dma_attrs;
213
214 #define dma_map_single_attrs(dev, cpu_addr, size, dir, attrs) \
215         dma_map_single(dev, cpu_addr, size, dir)
216
217 #define dma_unmap_single_attrs(dev, dma_addr, size, dir, attrs) \
218         dma_unmap_single(dev, dma_addr, size, dir)
219
220 #define dma_map_sg_attrs(dev, sgl, nents, dir, attrs) \
221         dma_map_sg(dev, sgl, nents, dir)
222
223 #define dma_unmap_sg_attrs(dev, sgl, nents, dir, attrs) \
224         dma_unmap_sg(dev, sgl, nents, dir)
225
226 #endif /* CONFIG_HAVE_DMA_ATTRS */
227
228 #endif