]> asedeno.scripts.mit.edu Git - linux.git/blob - include/linux/iommu.h
iommu: Add a new type field in iommu_resv_region
[linux.git] / include / linux / iommu.h
1 /*
2  * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
3  * Author: Joerg Roedel <joerg.roedel@amd.com>
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 as published
7  * by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
17  */
18
19 #ifndef __LINUX_IOMMU_H
20 #define __LINUX_IOMMU_H
21
22 #include <linux/errno.h>
23 #include <linux/err.h>
24 #include <linux/of.h>
25 #include <linux/types.h>
26 #include <linux/scatterlist.h>
27 #include <trace/events/iommu.h>
28
29 #define IOMMU_READ      (1 << 0)
30 #define IOMMU_WRITE     (1 << 1)
31 #define IOMMU_CACHE     (1 << 2) /* DMA cache coherency */
32 #define IOMMU_NOEXEC    (1 << 3)
33 #define IOMMU_MMIO      (1 << 4) /* e.g. things like MSI doorbells */
34
35 struct iommu_ops;
36 struct iommu_group;
37 struct bus_type;
38 struct device;
39 struct iommu_domain;
40 struct notifier_block;
41
42 /* iommu fault flags */
43 #define IOMMU_FAULT_READ        0x0
44 #define IOMMU_FAULT_WRITE       0x1
45
46 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
47                         struct device *, unsigned long, int, void *);
48
49 struct iommu_domain_geometry {
50         dma_addr_t aperture_start; /* First address that can be mapped    */
51         dma_addr_t aperture_end;   /* Last address that can be mapped     */
52         bool force_aperture;       /* DMA only allowed in mappable range? */
53 };
54
55 /* Domain feature flags */
56 #define __IOMMU_DOMAIN_PAGING   (1U << 0)  /* Support for iommu_map/unmap */
57 #define __IOMMU_DOMAIN_DMA_API  (1U << 1)  /* Domain for use in DMA-API
58                                               implementation              */
59 #define __IOMMU_DOMAIN_PT       (1U << 2)  /* Domain is identity mapped   */
60
61 /*
62  * This are the possible domain-types
63  *
64  *      IOMMU_DOMAIN_BLOCKED    - All DMA is blocked, can be used to isolate
65  *                                devices
66  *      IOMMU_DOMAIN_IDENTITY   - DMA addresses are system physical addresses
67  *      IOMMU_DOMAIN_UNMANAGED  - DMA mappings managed by IOMMU-API user, used
68  *                                for VMs
69  *      IOMMU_DOMAIN_DMA        - Internally used for DMA-API implementations.
70  *                                This flag allows IOMMU drivers to implement
71  *                                certain optimizations for these domains
72  */
73 #define IOMMU_DOMAIN_BLOCKED    (0U)
74 #define IOMMU_DOMAIN_IDENTITY   (__IOMMU_DOMAIN_PT)
75 #define IOMMU_DOMAIN_UNMANAGED  (__IOMMU_DOMAIN_PAGING)
76 #define IOMMU_DOMAIN_DMA        (__IOMMU_DOMAIN_PAGING |        \
77                                  __IOMMU_DOMAIN_DMA_API)
78
79 struct iommu_domain {
80         unsigned type;
81         const struct iommu_ops *ops;
82         unsigned long pgsize_bitmap;    /* Bitmap of page sizes in use */
83         iommu_fault_handler_t handler;
84         void *handler_token;
85         struct iommu_domain_geometry geometry;
86         void *iova_cookie;
87 };
88
89 enum iommu_cap {
90         IOMMU_CAP_CACHE_COHERENCY,      /* IOMMU can enforce cache coherent DMA
91                                            transactions */
92         IOMMU_CAP_INTR_REMAP,           /* IOMMU supports interrupt isolation */
93         IOMMU_CAP_NOEXEC,               /* IOMMU_NOEXEC flag */
94 };
95
96 /*
97  * Following constraints are specifc to FSL_PAMUV1:
98  *  -aperture must be power of 2, and naturally aligned
99  *  -number of windows must be power of 2, and address space size
100  *   of each window is determined by aperture size / # of windows
101  *  -the actual size of the mapped region of a window must be power
102  *   of 2 starting with 4KB and physical address must be naturally
103  *   aligned.
104  * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
105  * The caller can invoke iommu_domain_get_attr to check if the underlying
106  * iommu implementation supports these constraints.
107  */
108
109 enum iommu_attr {
110         DOMAIN_ATTR_GEOMETRY,
111         DOMAIN_ATTR_PAGING,
112         DOMAIN_ATTR_WINDOWS,
113         DOMAIN_ATTR_FSL_PAMU_STASH,
114         DOMAIN_ATTR_FSL_PAMU_ENABLE,
115         DOMAIN_ATTR_FSL_PAMUV1,
116         DOMAIN_ATTR_NESTING,    /* two stages of translation */
117         DOMAIN_ATTR_MAX,
118 };
119
120 /* These are the possible reserved region types */
121 #define IOMMU_RESV_DIRECT       (1 << 0)
122 #define IOMMU_RESV_RESERVED     (1 << 1)
123 #define IOMMU_RESV_MSI          (1 << 2)
124
125 /**
126  * struct iommu_resv_region - descriptor for a reserved memory region
127  * @list: Linked list pointers
128  * @start: System physical start address of the region
129  * @length: Length of the region in bytes
130  * @prot: IOMMU Protection flags (READ/WRITE/...)
131  * @type: Type of the reserved region
132  */
133 struct iommu_resv_region {
134         struct list_head        list;
135         phys_addr_t             start;
136         size_t                  length;
137         int                     prot;
138         int                     type;
139 };
140
141 #ifdef CONFIG_IOMMU_API
142
143 /**
144  * struct iommu_ops - iommu ops and capabilities
145  * @capable: check capability
146  * @domain_alloc: allocate iommu domain
147  * @domain_free: free iommu domain
148  * @attach_dev: attach device to an iommu domain
149  * @detach_dev: detach device from an iommu domain
150  * @map: map a physically contiguous memory region to an iommu domain
151  * @unmap: unmap a physically contiguous memory region from an iommu domain
152  * @map_sg: map a scatter-gather list of physically contiguous memory chunks
153  * to an iommu domain
154  * @iova_to_phys: translate iova to physical address
155  * @add_device: add device to iommu grouping
156  * @remove_device: remove device from iommu grouping
157  * @device_group: find iommu group for a particular device
158  * @domain_get_attr: Query domain attributes
159  * @domain_set_attr: Change domain attributes
160  * @get_resv_regions: Request list of reserved regions for a device
161  * @put_resv_regions: Free list of reserved regions for a device
162  * @apply_resv_region: Temporary helper call-back for iova reserved ranges
163  * @domain_window_enable: Configure and enable a particular window for a domain
164  * @domain_window_disable: Disable a particular window for a domain
165  * @domain_set_windows: Set the number of windows for a domain
166  * @domain_get_windows: Return the number of windows for a domain
167  * @of_xlate: add OF master IDs to iommu grouping
168  * @pgsize_bitmap: bitmap of all possible supported page sizes
169  */
170 struct iommu_ops {
171         bool (*capable)(enum iommu_cap);
172
173         /* Domain allocation and freeing by the iommu driver */
174         struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
175         void (*domain_free)(struct iommu_domain *);
176
177         int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
178         void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
179         int (*map)(struct iommu_domain *domain, unsigned long iova,
180                    phys_addr_t paddr, size_t size, int prot);
181         size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
182                      size_t size);
183         size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
184                          struct scatterlist *sg, unsigned int nents, int prot);
185         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
186         int (*add_device)(struct device *dev);
187         void (*remove_device)(struct device *dev);
188         struct iommu_group *(*device_group)(struct device *dev);
189         int (*domain_get_attr)(struct iommu_domain *domain,
190                                enum iommu_attr attr, void *data);
191         int (*domain_set_attr)(struct iommu_domain *domain,
192                                enum iommu_attr attr, void *data);
193
194         /* Request/Free a list of reserved regions for a device */
195         void (*get_resv_regions)(struct device *dev, struct list_head *list);
196         void (*put_resv_regions)(struct device *dev, struct list_head *list);
197         void (*apply_resv_region)(struct device *dev,
198                                   struct iommu_domain *domain,
199                                   struct iommu_resv_region *region);
200
201         /* Window handling functions */
202         int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
203                                     phys_addr_t paddr, u64 size, int prot);
204         void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
205         /* Set the number of windows per domain */
206         int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
207         /* Get the number of windows per domain */
208         u32 (*domain_get_windows)(struct iommu_domain *domain);
209
210         int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
211
212         unsigned long pgsize_bitmap;
213 };
214
215 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE           1 /* Device added */
216 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE           2 /* Pre Device removed */
217 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER          3 /* Pre Driver bind */
218 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER         4 /* Post Driver bind */
219 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER        5 /* Pre Driver unbind */
220 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER       6 /* Post Driver unbind */
221
222 extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
223 extern bool iommu_present(struct bus_type *bus);
224 extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
225 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
226 extern struct iommu_group *iommu_group_get_by_id(int id);
227 extern void iommu_domain_free(struct iommu_domain *domain);
228 extern int iommu_attach_device(struct iommu_domain *domain,
229                                struct device *dev);
230 extern void iommu_detach_device(struct iommu_domain *domain,
231                                 struct device *dev);
232 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
233 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
234                      phys_addr_t paddr, size_t size, int prot);
235 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
236                        size_t size);
237 extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
238                                 struct scatterlist *sg,unsigned int nents,
239                                 int prot);
240 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
241 extern void iommu_set_fault_handler(struct iommu_domain *domain,
242                         iommu_fault_handler_t handler, void *token);
243
244 extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
245 extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
246 extern int iommu_request_dm_for_dev(struct device *dev);
247
248 extern int iommu_attach_group(struct iommu_domain *domain,
249                               struct iommu_group *group);
250 extern void iommu_detach_group(struct iommu_domain *domain,
251                                struct iommu_group *group);
252 extern struct iommu_group *iommu_group_alloc(void);
253 extern void *iommu_group_get_iommudata(struct iommu_group *group);
254 extern void iommu_group_set_iommudata(struct iommu_group *group,
255                                       void *iommu_data,
256                                       void (*release)(void *iommu_data));
257 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
258 extern int iommu_group_add_device(struct iommu_group *group,
259                                   struct device *dev);
260 extern void iommu_group_remove_device(struct device *dev);
261 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
262                                     int (*fn)(struct device *, void *));
263 extern struct iommu_group *iommu_group_get(struct device *dev);
264 extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
265 extern void iommu_group_put(struct iommu_group *group);
266 extern int iommu_group_register_notifier(struct iommu_group *group,
267                                          struct notifier_block *nb);
268 extern int iommu_group_unregister_notifier(struct iommu_group *group,
269                                            struct notifier_block *nb);
270 extern int iommu_group_id(struct iommu_group *group);
271 extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
272 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
273
274 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
275                                  void *data);
276 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
277                                  void *data);
278 struct device *iommu_device_create(struct device *parent, void *drvdata,
279                                    const struct attribute_group **groups,
280                                    const char *fmt, ...) __printf(4, 5);
281 void iommu_device_destroy(struct device *dev);
282 int iommu_device_link(struct device *dev, struct device *link);
283 void iommu_device_unlink(struct device *dev, struct device *link);
284
285 /* Window handling function prototypes */
286 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
287                                       phys_addr_t offset, u64 size,
288                                       int prot);
289 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
290 /**
291  * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
292  * @domain: the iommu domain where the fault has happened
293  * @dev: the device where the fault has happened
294  * @iova: the faulting address
295  * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
296  *
297  * This function should be called by the low-level IOMMU implementations
298  * whenever IOMMU faults happen, to allow high-level users, that are
299  * interested in such events, to know about them.
300  *
301  * This event may be useful for several possible use cases:
302  * - mere logging of the event
303  * - dynamic TLB/PTE loading
304  * - if restarting of the faulting device is required
305  *
306  * Returns 0 on success and an appropriate error code otherwise (if dynamic
307  * PTE/TLB loading will one day be supported, implementations will be able
308  * to tell whether it succeeded or not according to this return value).
309  *
310  * Specifically, -ENOSYS is returned if a fault handler isn't installed
311  * (though fault handlers can also return -ENOSYS, in case they want to
312  * elicit the default behavior of the IOMMU drivers).
313  */
314 static inline int report_iommu_fault(struct iommu_domain *domain,
315                 struct device *dev, unsigned long iova, int flags)
316 {
317         int ret = -ENOSYS;
318
319         /*
320          * if upper layers showed interest and installed a fault handler,
321          * invoke it.
322          */
323         if (domain->handler)
324                 ret = domain->handler(domain, dev, iova, flags,
325                                                 domain->handler_token);
326
327         trace_io_page_fault(dev, iova, flags);
328         return ret;
329 }
330
331 static inline size_t iommu_map_sg(struct iommu_domain *domain,
332                                   unsigned long iova, struct scatterlist *sg,
333                                   unsigned int nents, int prot)
334 {
335         return domain->ops->map_sg(domain, iova, sg, nents, prot);
336 }
337
338 /* PCI device grouping function */
339 extern struct iommu_group *pci_device_group(struct device *dev);
340 /* Generic device grouping function */
341 extern struct iommu_group *generic_device_group(struct device *dev);
342
343 /**
344  * struct iommu_fwspec - per-device IOMMU instance data
345  * @ops: ops for this device's IOMMU
346  * @iommu_fwnode: firmware handle for this device's IOMMU
347  * @iommu_priv: IOMMU driver private data for this device
348  * @num_ids: number of associated device IDs
349  * @ids: IDs which this device may present to the IOMMU
350  */
351 struct iommu_fwspec {
352         const struct iommu_ops  *ops;
353         struct fwnode_handle    *iommu_fwnode;
354         void                    *iommu_priv;
355         unsigned int            num_ids;
356         u32                     ids[1];
357 };
358
359 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
360                       const struct iommu_ops *ops);
361 void iommu_fwspec_free(struct device *dev);
362 int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
363 void iommu_register_instance(struct fwnode_handle *fwnode,
364                              const struct iommu_ops *ops);
365 const struct iommu_ops *iommu_get_instance(struct fwnode_handle *fwnode);
366
367 #else /* CONFIG_IOMMU_API */
368
369 struct iommu_ops {};
370 struct iommu_group {};
371 struct iommu_fwspec {};
372
373 static inline bool iommu_present(struct bus_type *bus)
374 {
375         return false;
376 }
377
378 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
379 {
380         return false;
381 }
382
383 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
384 {
385         return NULL;
386 }
387
388 static inline struct iommu_group *iommu_group_get_by_id(int id)
389 {
390         return NULL;
391 }
392
393 static inline void iommu_domain_free(struct iommu_domain *domain)
394 {
395 }
396
397 static inline int iommu_attach_device(struct iommu_domain *domain,
398                                       struct device *dev)
399 {
400         return -ENODEV;
401 }
402
403 static inline void iommu_detach_device(struct iommu_domain *domain,
404                                        struct device *dev)
405 {
406 }
407
408 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
409 {
410         return NULL;
411 }
412
413 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
414                             phys_addr_t paddr, int gfp_order, int prot)
415 {
416         return -ENODEV;
417 }
418
419 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
420                               int gfp_order)
421 {
422         return -ENODEV;
423 }
424
425 static inline size_t iommu_map_sg(struct iommu_domain *domain,
426                                   unsigned long iova, struct scatterlist *sg,
427                                   unsigned int nents, int prot)
428 {
429         return -ENODEV;
430 }
431
432 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
433                                              u32 wnd_nr, phys_addr_t paddr,
434                                              u64 size, int prot)
435 {
436         return -ENODEV;
437 }
438
439 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
440                                                u32 wnd_nr)
441 {
442 }
443
444 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
445 {
446         return 0;
447 }
448
449 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
450                                 iommu_fault_handler_t handler, void *token)
451 {
452 }
453
454 static inline void iommu_get_resv_regions(struct device *dev,
455                                         struct list_head *list)
456 {
457 }
458
459 static inline void iommu_put_resv_regions(struct device *dev,
460                                         struct list_head *list)
461 {
462 }
463
464 static inline int iommu_request_dm_for_dev(struct device *dev)
465 {
466         return -ENODEV;
467 }
468
469 static inline int iommu_attach_group(struct iommu_domain *domain,
470                                      struct iommu_group *group)
471 {
472         return -ENODEV;
473 }
474
475 static inline void iommu_detach_group(struct iommu_domain *domain,
476                                       struct iommu_group *group)
477 {
478 }
479
480 static inline struct iommu_group *iommu_group_alloc(void)
481 {
482         return ERR_PTR(-ENODEV);
483 }
484
485 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
486 {
487         return NULL;
488 }
489
490 static inline void iommu_group_set_iommudata(struct iommu_group *group,
491                                              void *iommu_data,
492                                              void (*release)(void *iommu_data))
493 {
494 }
495
496 static inline int iommu_group_set_name(struct iommu_group *group,
497                                        const char *name)
498 {
499         return -ENODEV;
500 }
501
502 static inline int iommu_group_add_device(struct iommu_group *group,
503                                          struct device *dev)
504 {
505         return -ENODEV;
506 }
507
508 static inline void iommu_group_remove_device(struct device *dev)
509 {
510 }
511
512 static inline int iommu_group_for_each_dev(struct iommu_group *group,
513                                            void *data,
514                                            int (*fn)(struct device *, void *))
515 {
516         return -ENODEV;
517 }
518
519 static inline struct iommu_group *iommu_group_get(struct device *dev)
520 {
521         return NULL;
522 }
523
524 static inline void iommu_group_put(struct iommu_group *group)
525 {
526 }
527
528 static inline int iommu_group_register_notifier(struct iommu_group *group,
529                                                 struct notifier_block *nb)
530 {
531         return -ENODEV;
532 }
533
534 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
535                                                   struct notifier_block *nb)
536 {
537         return 0;
538 }
539
540 static inline int iommu_group_id(struct iommu_group *group)
541 {
542         return -ENODEV;
543 }
544
545 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
546                                         enum iommu_attr attr, void *data)
547 {
548         return -EINVAL;
549 }
550
551 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
552                                         enum iommu_attr attr, void *data)
553 {
554         return -EINVAL;
555 }
556
557 static inline struct device *iommu_device_create(struct device *parent,
558                                         void *drvdata,
559                                         const struct attribute_group **groups,
560                                         const char *fmt, ...)
561 {
562         return ERR_PTR(-ENODEV);
563 }
564
565 static inline void iommu_device_destroy(struct device *dev)
566 {
567 }
568
569 static inline int iommu_device_link(struct device *dev, struct device *link)
570 {
571         return -EINVAL;
572 }
573
574 static inline void iommu_device_unlink(struct device *dev, struct device *link)
575 {
576 }
577
578 static inline int iommu_fwspec_init(struct device *dev,
579                                     struct fwnode_handle *iommu_fwnode,
580                                     const struct iommu_ops *ops)
581 {
582         return -ENODEV;
583 }
584
585 static inline void iommu_fwspec_free(struct device *dev)
586 {
587 }
588
589 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
590                                        int num_ids)
591 {
592         return -ENODEV;
593 }
594
595 static inline void iommu_register_instance(struct fwnode_handle *fwnode,
596                                            const struct iommu_ops *ops)
597 {
598 }
599
600 static inline
601 const struct iommu_ops *iommu_get_instance(struct fwnode_handle *fwnode)
602 {
603         return NULL;
604 }
605
606 #endif /* CONFIG_IOMMU_API */
607
608 #endif /* __LINUX_IOMMU_H */