drivers/iommu/omap-iommu.h

   1 /*
   2  * omap iommu: main structures
   3  *
   4  * Copyright (C) 2008-2009 Nokia Corporation
   5  *
   6  * Written by Hiroshi DOYU <Hiroshi.DOYU@nokia.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 #ifndef _OMAP_IOMMU_H
  14 #define _OMAP_IOMMU_H
  15
  16 #define for_each_iotlb_cr(obj, n, __i, cr)                              \
  17         for (__i = 0;                                                   \
  18              (__i < (n)) && (cr = __iotlb_read_cr((obj), __i), true);   \
  19              __i++)
  20
  21 struct iotlb_entry {
  22         u32 da;
  23         u32 pa;
  24         u32 pgsz, prsvd, valid;
  25         union {
  26                 u16 ap;
  27                 struct {
  28                         u32 endian, elsz, mixed;
  29                 };
  30         };
  31 };
  32
  33 struct omap_iommu {
  34         const char      *name;
  35         void __iomem    *regbase;
  36         struct device   *dev;
  37         struct iommu_domain *domain;
  38         struct dentry   *debug_dir;
  39
  40         spinlock_t      iommu_lock;     /* global for this whole object */
  41
  42         /*
  43          * We don't change iopgd for a situation like pgd for a task,
  44          * but share it globally for each iommu.
  45          */
  46         u32             *iopgd;
  47         spinlock_t      page_table_lock; /* protect iopgd */
  48
  49         int             nr_tlb_entries;
  50
  51         void *ctx; /* iommu context: registres saved area */
  52
  53         int has_bus_err_back;
  54 };
  55
  56 struct cr_regs {
  57         union {
  58                 struct {
  59                         u16 cam_l;
  60                         u16 cam_h;
  61                 };
  62                 u32 cam;
  63         };
  64         union {
  65                 struct {
  66                         u16 ram_l;
  67                         u16 ram_h;
  68                 };
  69                 u32 ram;
  70         };
  71 };
  72
  73 struct iotlb_lock {
  74         short base;
  75         short vict;
  76 };
  77
  78 /**
  79  * dev_to_omap_iommu() - retrieves an omap iommu object from a user device
  80  * @dev: iommu client device
  81  */
  82 static inline struct omap_iommu *dev_to_omap_iommu(struct device *dev)
  83 {
  84         struct omap_iommu_arch_data *arch_data = dev->archdata.iommu;
  85
  86         return arch_data->iommu_dev;
  87 }
  88
  89 /*
  90  * MMU Register offsets
  91  */
  92 #define MMU_REVISION            0x00
  93 #define MMU_IRQSTATUS           0x18
  94 #define MMU_IRQENABLE           0x1c
  95 #define MMU_WALKING_ST          0x40
  96 #define MMU_CNTL                0x44
  97 #define MMU_FAULT_AD            0x48
  98 #define MMU_TTB                 0x4c
  99 #define MMU_LOCK                0x50
 100 #define MMU_LD_TLB              0x54
 101 #define MMU_CAM                 0x58
 102 #define MMU_RAM                 0x5c
 103 #define MMU_GFLUSH              0x60
 104 #define MMU_FLUSH_ENTRY         0x64
 105 #define MMU_READ_CAM            0x68
 106 #define MMU_READ_RAM            0x6c
 107 #define MMU_EMU_FAULT_AD        0x70
 108 #define MMU_GP_REG              0x88
 109
 110 #define MMU_REG_SIZE            256
 111
 112 /*
 113  * MMU Register bit definitions
 114  */
 115 /* IRQSTATUS & IRQENABLE */
 116 #define MMU_IRQ_MULTIHITFAULT   (1 << 4)
 117 #define MMU_IRQ_TABLEWALKFAULT  (1 << 3)
 118 #define MMU_IRQ_EMUMISS         (1 << 2)
 119 #define MMU_IRQ_TRANSLATIONFAULT        (1 << 1)
 120 #define MMU_IRQ_TLBMISS         (1 << 0)
 121
 122 #define __MMU_IRQ_FAULT         \
 123         (MMU_IRQ_MULTIHITFAULT | MMU_IRQ_EMUMISS | MMU_IRQ_TRANSLATIONFAULT)
 124 #define MMU_IRQ_MASK            \
 125         (__MMU_IRQ_FAULT | MMU_IRQ_TABLEWALKFAULT | MMU_IRQ_TLBMISS)
 126 #define MMU_IRQ_TWL_MASK        (__MMU_IRQ_FAULT | MMU_IRQ_TABLEWALKFAULT)
 127 #define MMU_IRQ_TLB_MISS_MASK   (__MMU_IRQ_FAULT | MMU_IRQ_TLBMISS)
 128
 129 /* MMU_CNTL */
 130 #define MMU_CNTL_SHIFT          1
 131 #define MMU_CNTL_MASK           (7 << MMU_CNTL_SHIFT)
 132 #define MMU_CNTL_EML_TLB        (1 << 3)
 133 #define MMU_CNTL_TWL_EN         (1 << 2)
 134 #define MMU_CNTL_MMU_EN         (1 << 1)
 135
 136 /* CAM */
 137 #define MMU_CAM_VATAG_SHIFT     12
 138 #define MMU_CAM_VATAG_MASK \
 139         ((~0UL >> MMU_CAM_VATAG_SHIFT) << MMU_CAM_VATAG_SHIFT)
 140 #define MMU_CAM_P               (1 << 3)
 141 #define MMU_CAM_V               (1 << 2)
 142 #define MMU_CAM_PGSZ_MASK       3
 143 #define MMU_CAM_PGSZ_1M         (0 << 0)
 144 #define MMU_CAM_PGSZ_64K        (1 << 0)
 145 #define MMU_CAM_PGSZ_4K         (2 << 0)
 146 #define MMU_CAM_PGSZ_16M        (3 << 0)
 147
 148 /* RAM */
 149 #define MMU_RAM_PADDR_SHIFT     12
 150 #define MMU_RAM_PADDR_MASK \
 151         ((~0UL >> MMU_RAM_PADDR_SHIFT) << MMU_RAM_PADDR_SHIFT)
 152
 153 #define MMU_RAM_ENDIAN_SHIFT    9
 154 #define MMU_RAM_ENDIAN_MASK     (1 << MMU_RAM_ENDIAN_SHIFT)
 155 #define MMU_RAM_ENDIAN_LITTLE   (0 << MMU_RAM_ENDIAN_SHIFT)
 156 #define MMU_RAM_ENDIAN_BIG      (1 << MMU_RAM_ENDIAN_SHIFT)
 157
 158 #define MMU_RAM_ELSZ_SHIFT      7
 159 #define MMU_RAM_ELSZ_MASK       (3 << MMU_RAM_ELSZ_SHIFT)
 160 #define MMU_RAM_ELSZ_8          (0 << MMU_RAM_ELSZ_SHIFT)
 161 #define MMU_RAM_ELSZ_16         (1 << MMU_RAM_ELSZ_SHIFT)
 162 #define MMU_RAM_ELSZ_32         (2 << MMU_RAM_ELSZ_SHIFT)
 163 #define MMU_RAM_ELSZ_NONE       (3 << MMU_RAM_ELSZ_SHIFT)
 164 #define MMU_RAM_MIXED_SHIFT     6
 165 #define MMU_RAM_MIXED_MASK      (1 << MMU_RAM_MIXED_SHIFT)
 166 #define MMU_RAM_MIXED           MMU_RAM_MIXED_MASK
 167
 168 #define MMU_GP_REG_BUS_ERR_BACK_EN      0x1
 169
 170 #define get_cam_va_mask(pgsz)                           \
 171         (((pgsz) == MMU_CAM_PGSZ_16M) ? 0xff000000 :    \
 172          ((pgsz) == MMU_CAM_PGSZ_1M)  ? 0xfff00000 :    \
 173          ((pgsz) == MMU_CAM_PGSZ_64K) ? 0xffff0000 :    \
 174          ((pgsz) == MMU_CAM_PGSZ_4K)  ? 0xfffff000 : 0)
 175
 176 /*
 177  * utilities for super page(16MB, 1MB, 64KB and 4KB)
 178  */
 179
 180 #define iopgsz_max(bytes)                       \
 181         (((bytes) >= SZ_16M) ? SZ_16M :         \
 182          ((bytes) >= SZ_1M)  ? SZ_1M  :         \
 183          ((bytes) >= SZ_64K) ? SZ_64K :         \
 184          ((bytes) >= SZ_4K)  ? SZ_4K  : 0)
 185
 186 #define bytes_to_iopgsz(bytes)                          \
 187         (((bytes) == SZ_16M) ? MMU_CAM_PGSZ_16M :       \
 188          ((bytes) == SZ_1M)  ? MMU_CAM_PGSZ_1M  :       \
 189          ((bytes) == SZ_64K) ? MMU_CAM_PGSZ_64K :       \
 190          ((bytes) == SZ_4K)  ? MMU_CAM_PGSZ_4K  : -1)
 191
 192 #define iopgsz_to_bytes(iopgsz)                         \
 193         (((iopgsz) == MMU_CAM_PGSZ_16M) ? SZ_16M :      \
 194          ((iopgsz) == MMU_CAM_PGSZ_1M)  ? SZ_1M  :      \
 195          ((iopgsz) == MMU_CAM_PGSZ_64K) ? SZ_64K :      \
 196          ((iopgsz) == MMU_CAM_PGSZ_4K)  ? SZ_4K  : 0)
 197
 198 #define iopgsz_ok(bytes) (bytes_to_iopgsz(bytes) >= 0)
 199
 200 /*
 201  * global functions
 202  */
 203
 204 struct cr_regs __iotlb_read_cr(struct omap_iommu *obj, int n);
 205 void iotlb_lock_get(struct omap_iommu *obj, struct iotlb_lock *l);
 206 void iotlb_lock_set(struct omap_iommu *obj, struct iotlb_lock *l);
 207
 208 #ifdef CONFIG_OMAP_IOMMU_DEBUG
 209 void omap_iommu_debugfs_init(void);
 210 void omap_iommu_debugfs_exit(void);
 211
 212 void omap_iommu_debugfs_add(struct omap_iommu *obj);
 213 void omap_iommu_debugfs_remove(struct omap_iommu *obj);
 214 #else
 215 static inline void omap_iommu_debugfs_init(void) { }
 216 static inline void omap_iommu_debugfs_exit(void) { }
 217
 218 static inline void omap_iommu_debugfs_add(struct omap_iommu *obj) { }
 219 static inline void omap_iommu_debugfs_remove(struct omap_iommu *obj) { }
 220 #endif
 221
 222 /*
 223  * register accessors
 224  */
 225 static inline u32 iommu_read_reg(struct omap_iommu *obj, size_t offs)
 226 {
 227         return __raw_readl(obj->regbase + offs);
 228 }
 229
 230 static inline void iommu_write_reg(struct omap_iommu *obj, u32 val, size_t offs)
 231 {
 232         __raw_writel(val, obj->regbase + offs);
 233 }
 234
 235 static inline int iotlb_cr_valid(struct cr_regs *cr)
 236 {
 237         if (!cr)
 238                 return -EINVAL;
 239
 240         return cr->cam & MMU_CAM_V;
 241 }
 242
 243 #endif /* _OMAP_IOMMU_H */