1 /*- 2 * Copyright (c) 2010 Isilon Systems, Inc. 3 * Copyright (c) 2010 iX Systems, Inc. 4 * Copyright (c) 2010 Panasas, Inc. 5 * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd. 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice unmodified, this list of conditions, and the following 13 * disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 */ 29 #ifndef _LINUXKPI_LINUX_DMA_MAPPING_H_ 30 #define _LINUXKPI_LINUX_DMA_MAPPING_H_ 31 32 #include <linux/types.h> 33 #include <linux/device.h> 34 #include <linux/err.h> 35 #include <linux/scatterlist.h> 36 #include <linux/mm.h> 37 #include <linux/page.h> 38 #include <linux/sizes.h> 39 40 #include <sys/systm.h> 41 #include <sys/malloc.h> 42 43 #include <vm/vm.h> 44 #include <vm/vm_page.h> 45 #include <vm/uma_align_mask.h> 46 #include <vm/pmap.h> 47 48 #include <machine/bus.h> 49 50 #define DMA_ATTR_WRITE_BARRIER (1 << 0) 51 #define DMA_ATTR_WEAK_ORDERING (1 << 1) 52 #define DMA_ATTR_WRITE_COMBINE (1 << 2) 53 #define DMA_ATTR_NON_CONSISTENT (1 << 3) 54 #define DMA_ATTR_NO_KERNEL_MAPPING (1 << 4) 55 #define DMA_ATTR_SKIP_CPU_SYNC (1 << 5) 56 #define DMA_ATTR_FORCE_CONTIGUOUS (1 << 6) 57 #define DMA_ATTR_ALLOC_SINGLE_PAGES (1 << 7) 58 #define DMA_ATTR_NO_WARN (1 << 8) 59 #define DMA_ATTR_PRIVILEGED (1 << 9) 60 61 enum dma_data_direction { 62 DMA_BIDIRECTIONAL = 0, 63 DMA_TO_DEVICE = 1, 64 DMA_FROM_DEVICE = 2, 65 DMA_NONE = 3, 66 }; 67 68 struct dma_map_ops { 69 void* (*alloc_coherent)(struct device *dev, size_t size, 70 dma_addr_t *dma_handle, gfp_t gfp); 71 void (*free_coherent)(struct device *dev, size_t size, 72 void *vaddr, dma_addr_t dma_handle); 73 dma_addr_t (*map_page)(struct device *dev, struct page *page, 74 unsigned long offset, size_t size, enum dma_data_direction dir, 75 unsigned long attrs); 76 void (*unmap_page)(struct device *dev, dma_addr_t dma_handle, 77 size_t size, enum dma_data_direction dir, unsigned long attrs); 78 int (*map_sg)(struct device *dev, struct scatterlist *sg, 79 int nents, enum dma_data_direction dir, unsigned long attrs); 80 void (*unmap_sg)(struct device *dev, struct scatterlist *sg, int nents, 81 enum dma_data_direction dir, unsigned long attrs); 82 void (*sync_single_for_cpu)(struct device *dev, dma_addr_t dma_handle, 83 size_t size, enum dma_data_direction dir); 84 void (*sync_single_for_device)(struct device *dev, 85 dma_addr_t dma_handle, size_t size, enum dma_data_direction dir); 86 void (*sync_single_range_for_cpu)(struct device *dev, 87 dma_addr_t dma_handle, unsigned long offset, size_t size, 88 enum dma_data_direction dir); 89 void (*sync_single_range_for_device)(struct device *dev, 90 dma_addr_t dma_handle, unsigned long offset, size_t size, 91 enum dma_data_direction dir); 92 void (*sync_sg_for_cpu)(struct device *dev, struct scatterlist *sg, 93 int nents, enum dma_data_direction dir); 94 void (*sync_sg_for_device)(struct device *dev, struct scatterlist *sg, 95 int nents, enum dma_data_direction dir); 96 int (*mapping_error)(struct device *dev, dma_addr_t dma_addr); 97 int (*dma_supported)(struct device *dev, u64 mask); 98 int is_phys; 99 }; 100 101 #define DMA_BIT_MASK(n) ((2ULL << ((n) - 1)) - 1ULL) 102 103 int linux_dma_tag_init(struct device *, u64); 104 int linux_dma_tag_init_coherent(struct device *, u64); 105 void *linux_dma_alloc_coherent(struct device *dev, size_t size, 106 dma_addr_t *dma_handle, gfp_t flag); 107 void *linuxkpi_dmam_alloc_coherent(struct device *dev, size_t size, 108 dma_addr_t *dma_handle, gfp_t flag); 109 void linuxkpi_dmam_free_coherent(struct device *dev, size_t size, 110 void *addr, dma_addr_t dma_handle); 111 dma_addr_t linux_dma_map_phys(struct device *dev, vm_paddr_t phys, size_t len); /* backward compat */ 112 dma_addr_t lkpi_dma_map_phys(struct device *, vm_paddr_t, size_t, 113 enum dma_data_direction, unsigned long); 114 void linux_dma_unmap(struct device *dev, dma_addr_t dma_addr, size_t size); /* backward compat */ 115 void lkpi_dma_unmap(struct device *, dma_addr_t, size_t, 116 enum dma_data_direction, unsigned long); 117 int linux_dma_map_sg_attrs(struct device *dev, struct scatterlist *sgl, 118 int nents, enum dma_data_direction direction, 119 unsigned long attrs); 120 void linux_dma_unmap_sg_attrs(struct device *dev, struct scatterlist *sg, 121 int nents __unused, enum dma_data_direction direction, 122 unsigned long attrs); 123 void linuxkpi_dma_sync(struct device *, dma_addr_t, size_t, bus_dmasync_op_t); 124 void lkpi_dma_sync_sg(struct device *, struct scatterlist *, bus_dmasync_op_t); 125 126 static inline int 127 dma_supported(struct device *dev, u64 dma_mask) 128 { 129 130 /* XXX busdma takes care of this elsewhere. */ 131 return (1); 132 } 133 134 static inline int 135 dma_set_mask(struct device *dev, u64 dma_mask) 136 { 137 138 if (!dev->dma_priv || !dma_supported(dev, dma_mask)) 139 return -EIO; 140 141 return (linux_dma_tag_init(dev, dma_mask)); 142 } 143 144 static inline int 145 dma_set_coherent_mask(struct device *dev, u64 dma_mask) 146 { 147 148 if (!dev->dma_priv || !dma_supported(dev, dma_mask)) 149 return -EIO; 150 151 return (linux_dma_tag_init_coherent(dev, dma_mask)); 152 } 153 154 static inline int 155 dma_set_mask_and_coherent(struct device *dev, u64 dma_mask) 156 { 157 int r; 158 159 r = dma_set_mask(dev, dma_mask); 160 if (r == 0) 161 dma_set_coherent_mask(dev, dma_mask); 162 return (r); 163 } 164 165 static inline void * 166 dma_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle, 167 gfp_t flag) 168 { 169 return (linux_dma_alloc_coherent(dev, size, dma_handle, flag)); 170 } 171 172 static inline void * 173 dma_zalloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle, 174 gfp_t flag) 175 { 176 177 return (dma_alloc_coherent(dev, size, dma_handle, flag | __GFP_ZERO)); 178 } 179 180 static inline void * 181 dmam_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle, 182 gfp_t flag) 183 { 184 185 return (linuxkpi_dmam_alloc_coherent(dev, size, dma_handle, flag)); 186 } 187 188 static inline void 189 dma_free_coherent(struct device *dev, size_t size, void *cpu_addr, 190 dma_addr_t dma_addr) 191 { 192 193 lkpi_dma_unmap(dev, dma_addr, size, DMA_BIDIRECTIONAL, 0); 194 kmem_free(cpu_addr, size); 195 } 196 197 static inline void 198 dmam_free_coherent(struct device *dev, size_t size, void *addr, 199 dma_addr_t dma_handle) 200 { 201 linuxkpi_dmam_free_coherent(dev, size, addr, dma_handle); 202 } 203 204 static inline dma_addr_t 205 dma_map_page_attrs(struct device *dev, struct page *page, size_t offset, 206 size_t size, enum dma_data_direction direction, unsigned long attrs) 207 { 208 209 return (lkpi_dma_map_phys(dev, page_to_phys(page) + offset, size, 210 direction, attrs)); 211 } 212 213 static inline void 214 dma_unmap_page_attrs(struct device *dev, dma_addr_t dma_address, size_t size, 215 enum dma_data_direction direction, unsigned long attrs) 216 { 217 lkpi_dma_unmap(dev, dma_address, size, direction, attrs); 218 } 219 220 /* linux_dma_(un)map_sg_attrs does not support attrs yet */ 221 #define dma_map_sg_attrs(dev, sgl, nents, dir, attrs) \ 222 linux_dma_map_sg_attrs(dev, sgl, nents, dir, attrs) 223 224 #define dma_unmap_sg_attrs(dev, sg, nents, dir, attrs) \ 225 linux_dma_unmap_sg_attrs(dev, sg, nents, dir, attrs) 226 227 static inline dma_addr_t 228 dma_map_page(struct device *dev, struct page *page, 229 unsigned long offset, size_t size, enum dma_data_direction direction) 230 { 231 232 return (lkpi_dma_map_phys(dev, page_to_phys(page) + offset, size, 233 direction, 0)); 234 } 235 236 static inline void 237 dma_unmap_page(struct device *dev, dma_addr_t dma_address, size_t size, 238 enum dma_data_direction direction) 239 { 240 241 lkpi_dma_unmap(dev, dma_address, size, direction, 0); 242 } 243 244 static inline dma_addr_t 245 dma_map_resource(struct device *dev, phys_addr_t paddr, size_t size, 246 enum dma_data_direction direction, unsigned long attrs) 247 { 248 return (lkpi_dma_map_phys(dev, paddr, size, direction, attrs)); 249 } 250 251 static inline void 252 dma_unmap_resource(struct device *dev, dma_addr_t dma, size_t size, 253 enum dma_data_direction direction, unsigned long attrs) 254 { 255 lkpi_dma_unmap(dev, dma, size, direction, attrs); 256 } 257 258 static inline void 259 dma_sync_single_for_cpu(struct device *dev, dma_addr_t dma, size_t size, 260 enum dma_data_direction direction) 261 { 262 bus_dmasync_op_t op; 263 264 switch (direction) { 265 case DMA_BIDIRECTIONAL: 266 op = BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE; 267 break; 268 case DMA_TO_DEVICE: 269 op = BUS_DMASYNC_POSTWRITE; 270 break; 271 case DMA_FROM_DEVICE: 272 op = BUS_DMASYNC_POSTREAD; 273 break; 274 default: 275 return; 276 } 277 278 linuxkpi_dma_sync(dev, dma, size, op); 279 } 280 281 static inline void 282 dma_sync_single(struct device *dev, dma_addr_t addr, size_t size, 283 enum dma_data_direction dir) 284 { 285 dma_sync_single_for_cpu(dev, addr, size, dir); 286 } 287 288 static inline void 289 dma_sync_single_for_device(struct device *dev, dma_addr_t dma, 290 size_t size, enum dma_data_direction direction) 291 { 292 bus_dmasync_op_t op; 293 294 switch (direction) { 295 case DMA_BIDIRECTIONAL: 296 op = BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD; 297 break; 298 case DMA_TO_DEVICE: 299 op = BUS_DMASYNC_PREWRITE; 300 break; 301 case DMA_FROM_DEVICE: 302 op = BUS_DMASYNC_PREREAD; 303 break; 304 default: 305 return; 306 } 307 308 linuxkpi_dma_sync(dev, dma, size, op); 309 } 310 311 static inline void 312 dma_sync_sg_for_cpu(struct device *dev, struct scatterlist *sg, int nelems, 313 enum dma_data_direction direction) 314 { 315 bus_dmasync_op_t op; 316 317 switch (direction) { 318 case DMA_BIDIRECTIONAL: 319 op = BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE; 320 break; 321 case DMA_TO_DEVICE: 322 op = BUS_DMASYNC_POSTWRITE; 323 break; 324 case DMA_FROM_DEVICE: 325 op = BUS_DMASYNC_POSTREAD; 326 break; 327 default: 328 return; 329 } 330 331 lkpi_dma_sync_sg(dev, sg, op); 332 } 333 334 static inline void dma_sync_sgtable_for_cpu(struct device *dev, 335 struct sg_table *sgt, enum dma_data_direction dir) 336 { 337 dma_sync_sg_for_cpu(dev, sgt->sgl, sgt->orig_nents, dir); 338 } 339 340 static inline void 341 dma_sync_sg_for_device(struct device *dev, struct scatterlist *sg, int nelems, 342 enum dma_data_direction direction) 343 { 344 bus_dmasync_op_t op; 345 346 switch (direction) { 347 case DMA_BIDIRECTIONAL: 348 op = BUS_DMASYNC_PREWRITE | BUS_DMASYNC_PREREAD; 349 break; 350 case DMA_TO_DEVICE: 351 op = BUS_DMASYNC_PREWRITE; 352 break; 353 case DMA_FROM_DEVICE: 354 op = BUS_DMASYNC_PREREAD; 355 break; 356 default: 357 return; 358 } 359 360 lkpi_dma_sync_sg(dev, sg, op); 361 } 362 363 static inline void dma_sync_sgtable_for_device(struct device *dev, 364 struct sg_table *sgt, enum dma_data_direction dir) 365 { 366 dma_sync_sg_for_device(dev, sgt->sgl, sgt->orig_nents, dir); 367 } 368 369 /* (20250329) These two seem to be unused code. */ 370 static inline void 371 dma_sync_single_range_for_cpu(struct device *dev, dma_addr_t dma_handle, 372 unsigned long offset, size_t size, enum dma_data_direction direction) 373 { 374 pr_debug("%s:%d: TODO dir %d\n", __func__, __LINE__, direction); 375 } 376 377 static inline void 378 dma_sync_single_range_for_device(struct device *dev, dma_addr_t dma_handle, 379 unsigned long offset, size_t size, enum dma_data_direction direction) 380 { 381 pr_debug("%s:%d: TODO dir %d\n", __func__, __LINE__, direction); 382 } 383 384 #define DMA_MAPPING_ERROR (~(dma_addr_t)0) 385 386 static inline int 387 dma_mapping_error(struct device *dev, dma_addr_t dma_addr) 388 { 389 390 if (dma_addr == 0 || dma_addr == DMA_MAPPING_ERROR) 391 return (-ENOMEM); 392 return (0); 393 } 394 395 static inline unsigned int dma_set_max_seg_size(struct device *dev, 396 unsigned int size) 397 { 398 return (0); 399 } 400 401 static inline dma_addr_t 402 _dma_map_single_attrs(struct device *dev, void *ptr, size_t size, 403 enum dma_data_direction direction, unsigned long attrs) 404 { 405 return (lkpi_dma_map_phys(dev, vtophys(ptr), size, 406 direction, attrs)); 407 } 408 409 static inline void 410 _dma_unmap_single_attrs(struct device *dev, dma_addr_t dma, size_t size, 411 enum dma_data_direction direction, unsigned long attrs) 412 { 413 lkpi_dma_unmap(dev, dma, size, direction, attrs); 414 } 415 416 static inline size_t 417 dma_max_mapping_size(struct device *dev) 418 { 419 420 return (SCATTERLIST_MAX_SEGMENT); 421 } 422 423 #define dma_map_single_attrs(dev, ptr, size, dir, attrs) \ 424 _dma_map_single_attrs(dev, ptr, size, dir, attrs) 425 426 #define dma_unmap_single_attrs(dev, dma_addr, size, dir, attrs) \ 427 _dma_unmap_single_attrs(dev, dma_addr, size, dir, attrs) 428 429 #define dma_map_single(d, a, s, r) dma_map_single_attrs(d, a, s, r, 0) 430 #define dma_unmap_single(d, a, s, r) dma_unmap_single_attrs(d, a, s, r, 0) 431 #define dma_map_sg(d, s, n, r) dma_map_sg_attrs(d, s, n, r, 0) 432 #define dma_unmap_sg(d, s, n, r) dma_unmap_sg_attrs(d, s, n, r, 0) 433 434 #define DEFINE_DMA_UNMAP_ADDR(name) dma_addr_t name 435 #define DEFINE_DMA_UNMAP_LEN(name) __u32 name 436 #define dma_unmap_addr(p, name) ((p)->name) 437 #define dma_unmap_addr_set(p, name, v) (((p)->name) = (v)) 438 #define dma_unmap_len(p, name) ((p)->name) 439 #define dma_unmap_len_set(p, name, v) (((p)->name) = (v)) 440 441 #define dma_get_cache_alignment() (uma_get_cache_align_mask() + 1) 442 443 444 static inline int 445 dma_map_sgtable(struct device *dev, struct sg_table *sgt, 446 enum dma_data_direction dir, 447 unsigned long attrs) 448 { 449 int nents; 450 451 nents = dma_map_sg_attrs(dev, sgt->sgl, sgt->orig_nents, dir, attrs); 452 if (nents < 0) 453 return (nents); 454 sgt->nents = nents; 455 return (0); 456 } 457 458 static inline void 459 dma_unmap_sgtable(struct device *dev, struct sg_table *sgt, 460 enum dma_data_direction dir, 461 unsigned long attrs) 462 { 463 464 dma_unmap_sg_attrs(dev, sgt->sgl, sgt->orig_nents, dir, attrs); 465 } 466 467 468 #endif /* _LINUXKPI_LINUX_DMA_MAPPING_H_ */ 469