Commit dbe6f1869188b6e04e38aa861dd198befb08bcd7

Authored by FUJITA Tomonori
Committed by Linus Torvalds
1 parent d68412b6d1

dma-mapping: mark dma_sync_single and dma_sync_sg as deprecated

dma_sync_single() and dma_sync_sg() have been described as "Backwards
compat, remove in 2.7.x" for a long time (since 2.6.5).

This marks dma_sync_single() and dma_sync_sg() as deprecated so the users
get notified before removing them.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Cc: Ingo Molnar <mingo@elte.hu>
Cc: James Bottomley <James.Bottomley@HansenPartnership.com>
Cc: "David S. Miller" <davem@davemloft.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

Showing 1 changed file with 14 additions and 3 deletions Inline Diff

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