drivers/iommu/io-pgtable-arm-v7s.c

   1 /*
   2  * CPU-agnostic ARM page table allocator.
   3  *
   4  * ARMv7 Short-descriptor format, supporting
   5  * - Basic memory attributes
   6  * - Simplified access permissions (AP[2:1] model)
   7  * - Backwards-compatible TEX remap
   8  * - Large pages/supersections (if indicated by the caller)
   9  *
  10  * Not supporting:
  11  * - Legacy access permissions (AP[2:0] model)
  12  *
  13  * Almost certainly never supporting:
  14  * - PXN
  15  * - Domains
  16  *
  17  * This program is free software; you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License version 2 as
  19  * published by the Free Software Foundation.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  28  *
  29  * Copyright (C) 2014-2015 ARM Limited
  30  * Copyright (c) 2014-2015 MediaTek Inc.
  31  */
  32
  33 #define pr_fmt(fmt)     "arm-v7s io-pgtable: " fmt
  34
  35 #include <linux/atomic.h>
  36 #include <linux/dma-mapping.h>
  37 #include <linux/gfp.h>
  38 #include <linux/iommu.h>
  39 #include <linux/kernel.h>
  40 #include <linux/kmemleak.h>
  41 #include <linux/sizes.h>
  42 #include <linux/slab.h>
  43 #include <linux/spinlock.h>
  44 #include <linux/types.h>
  45
  46 #include <asm/barrier.h>
  47
  48 #include "io-pgtable.h"
  49
  50 /* Struct accessors */
  51 #define io_pgtable_to_data(x)                                           \
  52         container_of((x), struct arm_v7s_io_pgtable, iop)
  53
  54 #define io_pgtable_ops_to_data(x)                                       \
  55         io_pgtable_to_data(io_pgtable_ops_to_pgtable(x))
  56
  57 /*
  58  * We have 32 bits total; 12 bits resolved at level 1, 8 bits at level 2,
  59  * and 12 bits in a page. With some carefully-chosen coefficients we can
  60  * hide the ugly inconsistencies behind these macros and at least let the
  61  * rest of the code pretend to be somewhat sane.
  62  */
  63 #define ARM_V7S_ADDR_BITS               32
  64 #define _ARM_V7S_LVL_BITS(lvl)          (16 - (lvl) * 4)
  65 #define ARM_V7S_LVL_SHIFT(lvl)          (ARM_V7S_ADDR_BITS - (4 + 8 * (lvl)))
  66 #define ARM_V7S_TABLE_SHIFT             10
  67
  68 #define ARM_V7S_PTES_PER_LVL(lvl)       (1 << _ARM_V7S_LVL_BITS(lvl))
  69 #define ARM_V7S_TABLE_SIZE(lvl)                                         \
  70         (ARM_V7S_PTES_PER_LVL(lvl) * sizeof(arm_v7s_iopte))
  71
  72 #define ARM_V7S_BLOCK_SIZE(lvl)         (1UL << ARM_V7S_LVL_SHIFT(lvl))
  73 #define ARM_V7S_LVL_MASK(lvl)           ((u32)(~0U << ARM_V7S_LVL_SHIFT(lvl)))
  74 #define ARM_V7S_TABLE_MASK              ((u32)(~0U << ARM_V7S_TABLE_SHIFT))
  75 #define _ARM_V7S_IDX_MASK(lvl)          (ARM_V7S_PTES_PER_LVL(lvl) - 1)
  76 #define ARM_V7S_LVL_IDX(addr, lvl)      ({                              \
  77         int _l = lvl;                                                   \
  78         ((u32)(addr) >> ARM_V7S_LVL_SHIFT(_l)) & _ARM_V7S_IDX_MASK(_l); \
  79 })
  80
  81 /*
  82  * Large page/supersection entries are effectively a block of 16 page/section
  83  * entries, along the lines of the LPAE contiguous hint, but all with the
  84  * same output address. For want of a better common name we'll call them
  85  * "contiguous" versions of their respective page/section entries here, but
  86  * noting the distinction (WRT to TLB maintenance) that they represent *one*
  87  * entry repeated 16 times, not 16 separate entries (as in the LPAE case).
  88  */
  89 #define ARM_V7S_CONT_PAGES              16
  90
  91 /* PTE type bits: these are all mixed up with XN/PXN bits in most cases */
  92 #define ARM_V7S_PTE_TYPE_TABLE          0x1
  93 #define ARM_V7S_PTE_TYPE_PAGE           0x2
  94 #define ARM_V7S_PTE_TYPE_CONT_PAGE      0x1
  95
  96 #define ARM_V7S_PTE_IS_VALID(pte)       (((pte) & 0x3) != 0)
  97 #define ARM_V7S_PTE_IS_TABLE(pte, lvl) \
  98         ((lvl) == 1 && (((pte) & 0x3) == ARM_V7S_PTE_TYPE_TABLE))
  99
 100 /* Page table bits */
 101 #define ARM_V7S_ATTR_XN(lvl)            BIT(4 * (2 - (lvl)))
 102 #define ARM_V7S_ATTR_B                  BIT(2)
 103 #define ARM_V7S_ATTR_C                  BIT(3)
 104 #define ARM_V7S_ATTR_NS_TABLE           BIT(3)
 105 #define ARM_V7S_ATTR_NS_SECTION         BIT(19)
 106
 107 #define ARM_V7S_CONT_SECTION            BIT(18)
 108 #define ARM_V7S_CONT_PAGE_XN_SHIFT      15
 109
 110 /*
 111  * The attribute bits are consistently ordered*, but occupy bits [17:10] of
 112  * a level 1 PTE vs. bits [11:4] at level 2. Thus we define the individual
 113  * fields relative to that 8-bit block, plus a total shift relative to the PTE.
 114  */
 115 #define ARM_V7S_ATTR_SHIFT(lvl)         (16 - (lvl) * 6)
 116
 117 #define ARM_V7S_ATTR_MASK               0xff
 118 #define ARM_V7S_ATTR_AP0                BIT(0)
 119 #define ARM_V7S_ATTR_AP1                BIT(1)
 120 #define ARM_V7S_ATTR_AP2                BIT(5)
 121 #define ARM_V7S_ATTR_S                  BIT(6)
 122 #define ARM_V7S_ATTR_NG                 BIT(7)
 123 #define ARM_V7S_TEX_SHIFT               2
 124 #define ARM_V7S_TEX_MASK                0x7
 125 #define ARM_V7S_ATTR_TEX(val)           (((val) & ARM_V7S_TEX_MASK) << ARM_V7S_TEX_SHIFT)
 126
 127 #define ARM_V7S_ATTR_MTK_4GB            BIT(9) /* MTK extend it for 4GB mode */
 128
 129 /* *well, except for TEX on level 2 large pages, of course :( */
 130 #define ARM_V7S_CONT_PAGE_TEX_SHIFT     6
 131 #define ARM_V7S_CONT_PAGE_TEX_MASK      (ARM_V7S_TEX_MASK << ARM_V7S_CONT_PAGE_TEX_SHIFT)
 132
 133 /* Simplified access permissions */
 134 #define ARM_V7S_PTE_AF                  ARM_V7S_ATTR_AP0
 135 #define ARM_V7S_PTE_AP_UNPRIV           ARM_V7S_ATTR_AP1
 136 #define ARM_V7S_PTE_AP_RDONLY           ARM_V7S_ATTR_AP2
 137
 138 /* Register bits */
 139 #define ARM_V7S_RGN_NC                  0
 140 #define ARM_V7S_RGN_WBWA                1
 141 #define ARM_V7S_RGN_WT                  2
 142 #define ARM_V7S_RGN_WB                  3
 143
 144 #define ARM_V7S_PRRR_TYPE_DEVICE        1
 145 #define ARM_V7S_PRRR_TYPE_NORMAL        2
 146 #define ARM_V7S_PRRR_TR(n, type)        (((type) & 0x3) << ((n) * 2))
 147 #define ARM_V7S_PRRR_DS0                BIT(16)
 148 #define ARM_V7S_PRRR_DS1                BIT(17)
 149 #define ARM_V7S_PRRR_NS0                BIT(18)
 150 #define ARM_V7S_PRRR_NS1                BIT(19)
 151 #define ARM_V7S_PRRR_NOS(n)             BIT((n) + 24)
 152
 153 #define ARM_V7S_NMRR_IR(n, attr)        (((attr) & 0x3) << ((n) * 2))
 154 #define ARM_V7S_NMRR_OR(n, attr)        (((attr) & 0x3) << ((n) * 2 + 16))
 155
 156 #define ARM_V7S_TTBR_S                  BIT(1)
 157 #define ARM_V7S_TTBR_NOS                BIT(5)
 158 #define ARM_V7S_TTBR_ORGN_ATTR(attr)    (((attr) & 0x3) << 3)
 159 #define ARM_V7S_TTBR_IRGN_ATTR(attr)                                    \
 160         ((((attr) & 0x1) << 6) | (((attr) & 0x2) >> 1))
 161
 162 #define ARM_V7S_TCR_PD1                 BIT(5)
 163
 164 typedef u32 arm_v7s_iopte;
 165
 166 static bool selftest_running;
 167
 168 struct arm_v7s_io_pgtable {
 169         struct io_pgtable       iop;
 170
 171         arm_v7s_iopte           *pgd;
 172         struct kmem_cache       *l2_tables;
 173         spinlock_t              split_lock;
 174 };
 175
 176 static dma_addr_t __arm_v7s_dma_addr(void *pages)
 177 {
 178         return (dma_addr_t)virt_to_phys(pages);
 179 }
 180
 181 static arm_v7s_iopte *iopte_deref(arm_v7s_iopte pte, int lvl)
 182 {
 183         if (ARM_V7S_PTE_IS_TABLE(pte, lvl))
 184                 pte &= ARM_V7S_TABLE_MASK;
 185         else
 186                 pte &= ARM_V7S_LVL_MASK(lvl);
 187         return phys_to_virt(pte);
 188 }
 189
 190 static void *__arm_v7s_alloc_table(int lvl, gfp_t gfp,
 191                                    struct arm_v7s_io_pgtable *data)
 192 {
 193         struct io_pgtable_cfg *cfg = &data->iop.cfg;
 194         struct device *dev = cfg->iommu_dev;
 195         phys_addr_t phys;
 196         dma_addr_t dma;
 197         size_t size = ARM_V7S_TABLE_SIZE(lvl);
 198         void *table = NULL;
 199
 200         if (lvl == 1)
 201                 table = (void *)__get_dma_pages(__GFP_ZERO, get_order(size));
 202         else if (lvl == 2)
 203                 table = kmem_cache_zalloc(data->l2_tables, gfp | GFP_DMA);
 204         phys = virt_to_phys(table);
 205         if (phys != (arm_v7s_iopte)phys)
 206                 /* Doesn't fit in PTE */
 207                 goto out_free;
 208         if (table && !(cfg->quirks & IO_PGTABLE_QUIRK_NO_DMA)) {
 209                 dma = dma_map_single(dev, table, size, DMA_TO_DEVICE);
 210                 if (dma_mapping_error(dev, dma))
 211                         goto out_free;
 212                 /*
 213                  * We depend on the IOMMU being able to work with any physical
 214                  * address directly, so if the DMA layer suggests otherwise by
 215                  * translating or truncating them, that bodes very badly...
 216                  */
 217                 if (dma != phys)
 218                         goto out_unmap;
 219         }
 220         if (lvl == 2)
 221                 kmemleak_ignore(table);
 222         return table;
 223
 224 out_unmap:
 225         dev_err(dev, "Cannot accommodate DMA translation for IOMMU page tables\n");
 226         dma_unmap_single(dev, dma, size, DMA_TO_DEVICE);
 227 out_free:
 228         if (lvl == 1)
 229                 free_pages((unsigned long)table, get_order(size));
 230         else
 231                 kmem_cache_free(data->l2_tables, table);
 232         return NULL;
 233 }
 234
 235 static void __arm_v7s_free_table(void *table, int lvl,
 236                                  struct arm_v7s_io_pgtable *data)
 237 {
 238         struct io_pgtable_cfg *cfg = &data->iop.cfg;
 239         struct device *dev = cfg->iommu_dev;
 240         size_t size = ARM_V7S_TABLE_SIZE(lvl);
 241
 242         if (!(cfg->quirks & IO_PGTABLE_QUIRK_NO_DMA))
 243                 dma_unmap_single(dev, __arm_v7s_dma_addr(table), size,
 244                                  DMA_TO_DEVICE);
 245         if (lvl == 1)
 246                 free_pages((unsigned long)table, get_order(size));
 247         else
 248                 kmem_cache_free(data->l2_tables, table);
 249 }
 250
 251 static void __arm_v7s_pte_sync(arm_v7s_iopte *ptep, int num_entries,
 252                                struct io_pgtable_cfg *cfg)
 253 {
 254         if (cfg->quirks & IO_PGTABLE_QUIRK_NO_DMA)
 255                 return;
 256
 257         dma_sync_single_for_device(cfg->iommu_dev, __arm_v7s_dma_addr(ptep),
 258                                    num_entries * sizeof(*ptep), DMA_TO_DEVICE);
 259 }
 260 static void __arm_v7s_set_pte(arm_v7s_iopte *ptep, arm_v7s_iopte pte,
 261                               int num_entries, struct io_pgtable_cfg *cfg)
 262 {
 263         int i;
 264
 265         for (i = 0; i < num_entries; i++)
 266                 ptep[i] = pte;
 267
 268         __arm_v7s_pte_sync(ptep, num_entries, cfg);
 269 }
 270
 271 static arm_v7s_iopte arm_v7s_prot_to_pte(int prot, int lvl,
 272                                          struct io_pgtable_cfg *cfg)
 273 {
 274         bool ap = !(cfg->quirks & IO_PGTABLE_QUIRK_NO_PERMS);
 275         arm_v7s_iopte pte = ARM_V7S_ATTR_NG | ARM_V7S_ATTR_S;
 276
 277         if (!(prot & IOMMU_MMIO))
 278                 pte |= ARM_V7S_ATTR_TEX(1);
 279         if (ap) {
 280                 pte |= ARM_V7S_PTE_AF;
 281                 if (!(prot & IOMMU_PRIV))
 282                         pte |= ARM_V7S_PTE_AP_UNPRIV;
 283                 if (!(prot & IOMMU_WRITE))
 284                         pte |= ARM_V7S_PTE_AP_RDONLY;
 285         }
 286         pte <<= ARM_V7S_ATTR_SHIFT(lvl);
 287
 288         if ((prot & IOMMU_NOEXEC) && ap)
 289                 pte |= ARM_V7S_ATTR_XN(lvl);
 290         if (prot & IOMMU_MMIO)
 291                 pte |= ARM_V7S_ATTR_B;
 292         else if (prot & IOMMU_CACHE)
 293                 pte |= ARM_V7S_ATTR_B | ARM_V7S_ATTR_C;
 294
 295         pte |= ARM_V7S_PTE_TYPE_PAGE;
 296         if (lvl == 1 && (cfg->quirks & IO_PGTABLE_QUIRK_ARM_NS))
 297                 pte |= ARM_V7S_ATTR_NS_SECTION;
 298
 299         if (cfg->quirks & IO_PGTABLE_QUIRK_ARM_MTK_4GB)
 300                 pte |= ARM_V7S_ATTR_MTK_4GB;
 301
 302         return pte;
 303 }
 304
 305 static int arm_v7s_pte_to_prot(arm_v7s_iopte pte, int lvl)
 306 {
 307         int prot = IOMMU_READ;
 308         arm_v7s_iopte attr = pte >> ARM_V7S_ATTR_SHIFT(lvl);
 309
 310         if (!(attr & ARM_V7S_PTE_AP_RDONLY))
 311                 prot |= IOMMU_WRITE;
 312         if (!(attr & ARM_V7S_PTE_AP_UNPRIV))
 313                 prot |= IOMMU_PRIV;
 314         if ((attr & (ARM_V7S_TEX_MASK << ARM_V7S_TEX_SHIFT)) == 0)
 315                 prot |= IOMMU_MMIO;
 316         else if (pte & ARM_V7S_ATTR_C)
 317                 prot |= IOMMU_CACHE;
 318         if (pte & ARM_V7S_ATTR_XN(lvl))
 319                 prot |= IOMMU_NOEXEC;
 320
 321         return prot;
 322 }
 323
 324 static arm_v7s_iopte arm_v7s_pte_to_cont(arm_v7s_iopte pte, int lvl)
 325 {
 326         if (lvl == 1) {
 327                 pte |= ARM_V7S_CONT_SECTION;
 328         } else if (lvl == 2) {
 329                 arm_v7s_iopte xn = pte & ARM_V7S_ATTR_XN(lvl);
 330                 arm_v7s_iopte tex = pte & ARM_V7S_CONT_PAGE_TEX_MASK;
 331
 332                 pte ^= xn | tex | ARM_V7S_PTE_TYPE_PAGE;
 333                 pte |= (xn << ARM_V7S_CONT_PAGE_XN_SHIFT) |
 334                        (tex << ARM_V7S_CONT_PAGE_TEX_SHIFT) |
 335                        ARM_V7S_PTE_TYPE_CONT_PAGE;
 336         }
 337         return pte;
 338 }
 339
 340 static arm_v7s_iopte arm_v7s_cont_to_pte(arm_v7s_iopte pte, int lvl)
 341 {
 342         if (lvl == 1) {
 343                 pte &= ~ARM_V7S_CONT_SECTION;
 344         } else if (lvl == 2) {
 345                 arm_v7s_iopte xn = pte & BIT(ARM_V7S_CONT_PAGE_XN_SHIFT);
 346                 arm_v7s_iopte tex = pte & (ARM_V7S_CONT_PAGE_TEX_MASK <<
 347                                            ARM_V7S_CONT_PAGE_TEX_SHIFT);
 348
 349                 pte ^= xn | tex | ARM_V7S_PTE_TYPE_CONT_PAGE;
 350                 pte |= (xn >> ARM_V7S_CONT_PAGE_XN_SHIFT) |
 351                        (tex >> ARM_V7S_CONT_PAGE_TEX_SHIFT) |
 352                        ARM_V7S_PTE_TYPE_PAGE;
 353         }
 354         return pte;
 355 }
 356
 357 static bool arm_v7s_pte_is_cont(arm_v7s_iopte pte, int lvl)
 358 {
 359         if (lvl == 1 && !ARM_V7S_PTE_IS_TABLE(pte, lvl))
 360                 return pte & ARM_V7S_CONT_SECTION;
 361         else if (lvl == 2)
 362                 return !(pte & ARM_V7S_PTE_TYPE_PAGE);
 363         return false;
 364 }
 365
 366 static int __arm_v7s_unmap(struct arm_v7s_io_pgtable *, unsigned long,
 367                            size_t, int, arm_v7s_iopte *);
 368
 369 static int arm_v7s_init_pte(struct arm_v7s_io_pgtable *data,
 370                             unsigned long iova, phys_addr_t paddr, int prot,
 371                             int lvl, int num_entries, arm_v7s_iopte *ptep)
 372 {
 373         struct io_pgtable_cfg *cfg = &data->iop.cfg;
 374         arm_v7s_iopte pte;
 375         int i;
 376
 377         for (i = 0; i < num_entries; i++)
 378                 if (ARM_V7S_PTE_IS_TABLE(ptep[i], lvl)) {
 379                         /*
 380                          * We need to unmap and free the old table before
 381                          * overwriting it with a block entry.
 382                          */
 383                         arm_v7s_iopte *tblp;
 384                         size_t sz = ARM_V7S_BLOCK_SIZE(lvl);
 385
 386                         tblp = ptep - ARM_V7S_LVL_IDX(iova, lvl);
 387                         if (WARN_ON(__arm_v7s_unmap(data, iova + i * sz,
 388                                                     sz, lvl, tblp) != sz))
 389                                 return -EINVAL;
 390                 } else if (ptep[i]) {
 391                         /* We require an unmap first */
 392                         WARN_ON(!selftest_running);
 393                         return -EEXIST;
 394                 }
 395
 396         pte = arm_v7s_prot_to_pte(prot, lvl, cfg);
 397         if (num_entries > 1)
 398                 pte = arm_v7s_pte_to_cont(pte, lvl);
 399
 400         pte |= paddr & ARM_V7S_LVL_MASK(lvl);
 401
 402         __arm_v7s_set_pte(ptep, pte, num_entries, cfg);
 403         return 0;
 404 }
 405
 406 static arm_v7s_iopte arm_v7s_install_table(arm_v7s_iopte *table,
 407                                            arm_v7s_iopte *ptep,
 408                                            arm_v7s_iopte curr,
 409                                            struct io_pgtable_cfg *cfg)
 410 {
 411         arm_v7s_iopte old, new;
 412
 413         new = virt_to_phys(table) | ARM_V7S_PTE_TYPE_TABLE;
 414         if (cfg->quirks & IO_PGTABLE_QUIRK_ARM_NS)
 415                 new |= ARM_V7S_ATTR_NS_TABLE;
 416
 417         /*
 418          * Ensure the table itself is visible before its PTE can be.
 419          * Whilst we could get away with cmpxchg64_release below, this
 420          * doesn't have any ordering semantics when !CONFIG_SMP.
 421          */
 422         dma_wmb();
 423
 424         old = cmpxchg_relaxed(ptep, curr, new);
 425         __arm_v7s_pte_sync(ptep, 1, cfg);
 426
 427         return old;
 428 }
 429
 430 static int __arm_v7s_map(struct arm_v7s_io_pgtable *data, unsigned long iova,
 431                          phys_addr_t paddr, size_t size, int prot,
 432                          int lvl, arm_v7s_iopte *ptep)
 433 {
 434         struct io_pgtable_cfg *cfg = &data->iop.cfg;
 435         arm_v7s_iopte pte, *cptep;
 436         int num_entries = size >> ARM_V7S_LVL_SHIFT(lvl);
 437
 438         /* Find our entry at the current level */
 439         ptep += ARM_V7S_LVL_IDX(iova, lvl);
 440
 441         /* If we can install a leaf entry at this level, then do so */
 442         if (num_entries)
 443                 return arm_v7s_init_pte(data, iova, paddr, prot,
 444                                         lvl, num_entries, ptep);
 445
 446         /* We can't allocate tables at the final level */
 447         if (WARN_ON(lvl == 2))
 448                 return -EINVAL;
 449
 450         /* Grab a pointer to the next level */
 451         pte = READ_ONCE(*ptep);
 452         if (!pte) {
 453                 cptep = __arm_v7s_alloc_table(lvl + 1, GFP_ATOMIC, data);
 454                 if (!cptep)
 455                         return -ENOMEM;
 456
 457                 pte = arm_v7s_install_table(cptep, ptep, 0, cfg);
 458                 if (pte)
 459                         __arm_v7s_free_table(cptep, lvl + 1, data);
 460         } else {
 461                 /* We've no easy way of knowing if it's synced yet, so... */
 462                 __arm_v7s_pte_sync(ptep, 1, cfg);
 463         }
 464
 465         if (ARM_V7S_PTE_IS_TABLE(pte, lvl)) {
 466                 cptep = iopte_deref(pte, lvl);
 467         } else if (pte) {
 468                 /* We require an unmap first */
 469                 WARN_ON(!selftest_running);
 470                 return -EEXIST;
 471         }
 472
 473         /* Rinse, repeat */
 474         return __arm_v7s_map(data, iova, paddr, size, prot, lvl + 1, cptep);
 475 }
 476
 477 static int arm_v7s_map(struct io_pgtable_ops *ops, unsigned long iova,
 478                         phys_addr_t paddr, size_t size, int prot)
 479 {
 480         struct arm_v7s_io_pgtable *data = io_pgtable_ops_to_data(ops);
 481         struct io_pgtable *iop = &data->iop;
 482         int ret;
 483
 484         /* If no access, then nothing to do */
 485         if (!(prot & (IOMMU_READ | IOMMU_WRITE)))
 486                 return 0;
 487
 488         if (WARN_ON(upper_32_bits(iova) || upper_32_bits(paddr)))
 489                 return -ERANGE;
 490
 491         ret = __arm_v7s_map(data, iova, paddr, size, prot, 1, data->pgd);
 492         /*
 493          * Synchronise all PTE updates for the new mapping before there's
 494          * a chance for anything to kick off a table walk for the new iova.
 495          */
 496         if (iop->cfg.quirks & IO_PGTABLE_QUIRK_TLBI_ON_MAP) {
 497                 io_pgtable_tlb_add_flush(iop, iova, size,
 498                                          ARM_V7S_BLOCK_SIZE(2), false);
 499                 io_pgtable_tlb_sync(iop);
 500         } else {
 501                 wmb();
 502         }
 503
 504         return ret;
 505 }
 506
 507 static void arm_v7s_free_pgtable(struct io_pgtable *iop)
 508 {
 509         struct arm_v7s_io_pgtable *data = io_pgtable_to_data(iop);
 510         int i;
 511
 512         for (i = 0; i < ARM_V7S_PTES_PER_LVL(1); i++) {
 513                 arm_v7s_iopte pte = data->pgd[i];
 514
 515                 if (ARM_V7S_PTE_IS_TABLE(pte, 1))
 516                         __arm_v7s_free_table(iopte_deref(pte, 1), 2, data);
 517         }
 518         __arm_v7s_free_table(data->pgd, 1, data);
 519         kmem_cache_destroy(data->l2_tables);
 520         kfree(data);
 521 }
 522
 523 static arm_v7s_iopte arm_v7s_split_cont(struct arm_v7s_io_pgtable *data,
 524                                         unsigned long iova, int idx, int lvl,
 525                                         arm_v7s_iopte *ptep)
 526 {
 527         struct io_pgtable *iop = &data->iop;
 528         arm_v7s_iopte pte;
 529         size_t size = ARM_V7S_BLOCK_SIZE(lvl);
 530         int i;
 531
 532         /* Check that we didn't lose a race to get the lock */
 533         pte = *ptep;
 534         if (!arm_v7s_pte_is_cont(pte, lvl))
 535                 return pte;
 536
 537         ptep -= idx & (ARM_V7S_CONT_PAGES - 1);
 538         pte = arm_v7s_cont_to_pte(pte, lvl);
 539         for (i = 0; i < ARM_V7S_CONT_PAGES; i++)
 540                 ptep[i] = pte + i * size;
 541
 542         __arm_v7s_pte_sync(ptep, ARM_V7S_CONT_PAGES, &iop->cfg);
 543
 544         size *= ARM_V7S_CONT_PAGES;
 545         io_pgtable_tlb_add_flush(iop, iova, size, size, true);
 546         io_pgtable_tlb_sync(iop);
 547         return pte;
 548 }
 549
 550 static int arm_v7s_split_blk_unmap(struct arm_v7s_io_pgtable *data,
 551                                    unsigned long iova, size_t size,
 552                                    arm_v7s_iopte blk_pte, arm_v7s_iopte *ptep)
 553 {
 554         struct io_pgtable_cfg *cfg = &data->iop.cfg;
 555         arm_v7s_iopte pte, *tablep;
 556         int i, unmap_idx, num_entries, num_ptes;
 557
 558         tablep = __arm_v7s_alloc_table(2, GFP_ATOMIC, data);
 559         if (!tablep)
 560                 return 0; /* Bytes unmapped */
 561
 562         num_ptes = ARM_V7S_PTES_PER_LVL(2);
 563         num_entries = size >> ARM_V7S_LVL_SHIFT(2);
 564         unmap_idx = ARM_V7S_LVL_IDX(iova, 2);
 565
 566         pte = arm_v7s_prot_to_pte(arm_v7s_pte_to_prot(blk_pte, 1), 2, cfg);
 567         if (num_entries > 1)
 568                 pte = arm_v7s_pte_to_cont(pte, 2);
 569
 570         for (i = 0; i < num_ptes; i += num_entries, pte += size) {
 571                 /* Unmap! */
 572                 if (i == unmap_idx)
 573                         continue;
 574
 575                 __arm_v7s_set_pte(&tablep[i], pte, num_entries, cfg);
 576         }
 577
 578         pte = arm_v7s_install_table(tablep, ptep, blk_pte, cfg);
 579         if (pte != blk_pte) {
 580                 __arm_v7s_free_table(tablep, 2, data);
 581
 582                 if (!ARM_V7S_PTE_IS_TABLE(pte, 1))
 583                         return 0;
 584
 585                 tablep = iopte_deref(pte, 1);
 586                 return __arm_v7s_unmap(data, iova, size, 2, tablep);
 587         }
 588
 589         io_pgtable_tlb_add_flush(&data->iop, iova, size, size, true);
 590         return size;
 591 }
 592
 593 static int __arm_v7s_unmap(struct arm_v7s_io_pgtable *data,
 594                             unsigned long iova, size_t size, int lvl,
 595                             arm_v7s_iopte *ptep)
 596 {
 597         arm_v7s_iopte pte[ARM_V7S_CONT_PAGES];
 598         struct io_pgtable *iop = &data->iop;
 599         int idx, i = 0, num_entries = size >> ARM_V7S_LVL_SHIFT(lvl);
 600
 601         /* Something went horribly wrong and we ran out of page table */
 602         if (WARN_ON(lvl > 2))
 603                 return 0;
 604
 605         idx = ARM_V7S_LVL_IDX(iova, lvl);
 606         ptep += idx;
 607         do {
 608                 pte[i] = READ_ONCE(ptep[i]);
 609                 if (WARN_ON(!ARM_V7S_PTE_IS_VALID(pte[i])))
 610                         return 0;
 611         } while (++i < num_entries);
 612
 613         /*
 614          * If we've hit a contiguous 'large page' entry at this level, it
 615          * needs splitting first, unless we're unmapping the whole lot.
 616          *
 617          * For splitting, we can't rewrite 16 PTEs atomically, and since we
 618          * can't necessarily assume TEX remap we don't have a software bit to
 619          * mark live entries being split. In practice (i.e. DMA API code), we
 620          * will never be splitting large pages anyway, so just wrap this edge
 621          * case in a lock for the sake of correctness and be done with it.
 622          */
 623         if (num_entries <= 1 && arm_v7s_pte_is_cont(pte[0], lvl)) {
 624                 unsigned long flags;
 625
 626                 spin_lock_irqsave(&data->split_lock, flags);
 627                 pte[0] = arm_v7s_split_cont(data, iova, idx, lvl, ptep);
 628                 spin_unlock_irqrestore(&data->split_lock, flags);
 629         }
 630
 631         /* If the size matches this level, we're in the right place */
 632         if (num_entries) {
 633                 size_t blk_size = ARM_V7S_BLOCK_SIZE(lvl);
 634
 635                 __arm_v7s_set_pte(ptep, 0, num_entries, &iop->cfg);
 636
 637                 for (i = 0; i < num_entries; i++) {
 638                         if (ARM_V7S_PTE_IS_TABLE(pte[i], lvl)) {
 639                                 /* Also flush any partial walks */
 640                                 io_pgtable_tlb_add_flush(iop, iova, blk_size,
 641                                         ARM_V7S_BLOCK_SIZE(lvl + 1), false);
 642                                 io_pgtable_tlb_sync(iop);
 643                                 ptep = iopte_deref(pte[i], lvl);
 644                                 __arm_v7s_free_table(ptep, lvl + 1, data);
 645                         } else {
 646                                 io_pgtable_tlb_add_flush(iop, iova, blk_size,
 647                                                          blk_size, true);
 648                         }
 649                         iova += blk_size;
 650                 }
 651                 return size;
 652         } else if (lvl == 1 && !ARM_V7S_PTE_IS_TABLE(pte[0], lvl)) {
 653                 /*
 654                  * Insert a table at the next level to map the old region,
 655                  * minus the part we want to unmap
 656                  */
 657                 return arm_v7s_split_blk_unmap(data, iova, size, pte[0], ptep);
 658         }
 659
 660         /* Keep on walkin' */
 661         ptep = iopte_deref(pte[0], lvl);
 662         return __arm_v7s_unmap(data, iova, size, lvl + 1, ptep);
 663 }
 664
 665 static int arm_v7s_unmap(struct io_pgtable_ops *ops, unsigned long iova,
 666                          size_t size)
 667 {
 668         struct arm_v7s_io_pgtable *data = io_pgtable_ops_to_data(ops);
 669         size_t unmapped;
 670
 671         if (WARN_ON(upper_32_bits(iova)))
 672                 return 0;
 673
 674         unmapped = __arm_v7s_unmap(data, iova, size, 1, data->pgd);
 675         if (unmapped)
 676                 io_pgtable_tlb_sync(&data->iop);
 677
 678         return unmapped;
 679 }
 680
 681 static phys_addr_t arm_v7s_iova_to_phys(struct io_pgtable_ops *ops,
 682                                         unsigned long iova)
 683 {
 684         struct arm_v7s_io_pgtable *data = io_pgtable_ops_to_data(ops);
 685         arm_v7s_iopte *ptep = data->pgd, pte;
 686         int lvl = 0;
 687         u32 mask;
 688
 689         do {
 690                 ptep += ARM_V7S_LVL_IDX(iova, ++lvl);
 691                 pte = READ_ONCE(*ptep);
 692                 ptep = iopte_deref(pte, lvl);
 693         } while (ARM_V7S_PTE_IS_TABLE(pte, lvl));
 694
 695         if (!ARM_V7S_PTE_IS_VALID(pte))
 696                 return 0;
 697
 698         mask = ARM_V7S_LVL_MASK(lvl);
 699         if (arm_v7s_pte_is_cont(pte, lvl))
 700                 mask *= ARM_V7S_CONT_PAGES;
 701         return (pte & mask) | (iova & ~mask);
 702 }
 703
 704 static struct io_pgtable *arm_v7s_alloc_pgtable(struct io_pgtable_cfg *cfg,
 705                                                 void *cookie)
 706 {
 707         struct arm_v7s_io_pgtable *data;
 708
 709 #ifdef PHYS_OFFSET
 710         if (upper_32_bits(PHYS_OFFSET))
 711                 return NULL;
 712 #endif
 713         if (cfg->ias > ARM_V7S_ADDR_BITS || cfg->oas > ARM_V7S_ADDR_BITS)
 714                 return NULL;
 715
 716         if (cfg->quirks & ~(IO_PGTABLE_QUIRK_ARM_NS |
 717                             IO_PGTABLE_QUIRK_NO_PERMS |
 718                             IO_PGTABLE_QUIRK_TLBI_ON_MAP |
 719                             IO_PGTABLE_QUIRK_ARM_MTK_4GB |
 720                             IO_PGTABLE_QUIRK_NO_DMA))
 721                 return NULL;
 722
 723         /* If ARM_MTK_4GB is enabled, the NO_PERMS is also expected. */
 724         if (cfg->quirks & IO_PGTABLE_QUIRK_ARM_MTK_4GB &&
 725             !(cfg->quirks & IO_PGTABLE_QUIRK_NO_PERMS))
 726                         return NULL;
 727
 728         data = kmalloc(sizeof(*data), GFP_KERNEL);
 729         if (!data)
 730                 return NULL;
 731
 732         spin_lock_init(&data->split_lock);
 733         data->l2_tables = kmem_cache_create("io-pgtable_armv7s_l2",
 734                                             ARM_V7S_TABLE_SIZE(2),
 735                                             ARM_V7S_TABLE_SIZE(2),
 736                                             SLAB_CACHE_DMA, NULL);
 737         if (!data->l2_tables)
 738                 goto out_free_data;
 739
 740         data->iop.ops = (struct io_pgtable_ops) {
 741                 .map            = arm_v7s_map,
 742                 .unmap          = arm_v7s_unmap,
 743                 .iova_to_phys   = arm_v7s_iova_to_phys,
 744         };
 745
 746         /* We have to do this early for __arm_v7s_alloc_table to work... */
 747         data->iop.cfg = *cfg;
 748
 749         /*
 750          * Unless the IOMMU driver indicates supersection support by
 751          * having SZ_16M set in the initial bitmap, they won't be used.
 752          */
 753         cfg->pgsize_bitmap &= SZ_4K | SZ_64K | SZ_1M | SZ_16M;
 754
 755         /* TCR: T0SZ=0, disable TTBR1 */
 756         cfg->arm_v7s_cfg.tcr = ARM_V7S_TCR_PD1;
 757
 758         /*
 759          * TEX remap: the indices used map to the closest equivalent types
 760          * under the non-TEX-remap interpretation of those attribute bits,
 761          * excepting various implementation-defined aspects of shareability.
 762          */
 763         cfg->arm_v7s_cfg.prrr = ARM_V7S_PRRR_TR(1, ARM_V7S_PRRR_TYPE_DEVICE) |
 764                                 ARM_V7S_PRRR_TR(4, ARM_V7S_PRRR_TYPE_NORMAL) |
 765                                 ARM_V7S_PRRR_TR(7, ARM_V7S_PRRR_TYPE_NORMAL) |
 766                                 ARM_V7S_PRRR_DS0 | ARM_V7S_PRRR_DS1 |
 767                                 ARM_V7S_PRRR_NS1 | ARM_V7S_PRRR_NOS(7);
 768         cfg->arm_v7s_cfg.nmrr = ARM_V7S_NMRR_IR(7, ARM_V7S_RGN_WBWA) |
 769                                 ARM_V7S_NMRR_OR(7, ARM_V7S_RGN_WBWA);
 770
 771         /* Looking good; allocate a pgd */
 772         data->pgd = __arm_v7s_alloc_table(1, GFP_KERNEL, data);
 773         if (!data->pgd)
 774                 goto out_free_data;
 775
 776         /* Ensure the empty pgd is visible before any actual TTBR write */
 777         wmb();
 778
 779         /* TTBRs */
 780         cfg->arm_v7s_cfg.ttbr[0] = virt_to_phys(data->pgd) |
 781                                    ARM_V7S_TTBR_S | ARM_V7S_TTBR_NOS |
 782                                    ARM_V7S_TTBR_IRGN_ATTR(ARM_V7S_RGN_WBWA) |
 783                                    ARM_V7S_TTBR_ORGN_ATTR(ARM_V7S_RGN_WBWA);
 784         cfg->arm_v7s_cfg.ttbr[1] = 0;
 785         return &data->iop;
 786
 787 out_free_data:
 788         kmem_cache_destroy(data->l2_tables);
 789         kfree(data);
 790         return NULL;
 791 }
 792
 793 struct io_pgtable_init_fns io_pgtable_arm_v7s_init_fns = {
 794         .alloc  = arm_v7s_alloc_pgtable,
 795         .free   = arm_v7s_free_pgtable,
 796 };
 797
 798 #ifdef CONFIG_IOMMU_IO_PGTABLE_ARMV7S_SELFTEST
 799
 800 static struct io_pgtable_cfg *cfg_cookie;
 801
 802 static void dummy_tlb_flush_all(void *cookie)
 803 {
 804         WARN_ON(cookie != cfg_cookie);
 805 }
 806
 807 static void dummy_tlb_add_flush(unsigned long iova, size_t size,
 808                                 size_t granule, bool leaf, void *cookie)
 809 {
 810         WARN_ON(cookie != cfg_cookie);
 811         WARN_ON(!(size & cfg_cookie->pgsize_bitmap));
 812 }
 813
 814 static void dummy_tlb_sync(void *cookie)
 815 {
 816         WARN_ON(cookie != cfg_cookie);
 817 }
 818
 819 static const struct iommu_gather_ops dummy_tlb_ops = {
 820         .tlb_flush_all  = dummy_tlb_flush_all,
 821         .tlb_add_flush  = dummy_tlb_add_flush,
 822         .tlb_sync       = dummy_tlb_sync,
 823 };
 824
 825 #define __FAIL(ops)     ({                              \
 826                 WARN(1, "selftest: test failed\n");     \
 827                 selftest_running = false;               \
 828                 -EFAULT;                                \
 829 })
 830
 831 static int __init arm_v7s_do_selftests(void)
 832 {
 833         struct io_pgtable_ops *ops;
 834         struct io_pgtable_cfg cfg = {
 835                 .tlb = &dummy_tlb_ops,
 836                 .oas = 32,
 837                 .ias = 32,
 838                 .quirks = IO_PGTABLE_QUIRK_ARM_NS | IO_PGTABLE_QUIRK_NO_DMA,
 839                 .pgsize_bitmap = SZ_4K | SZ_64K | SZ_1M | SZ_16M,
 840         };
 841         unsigned int iova, size, iova_start;
 842         unsigned int i, loopnr = 0;
 843
 844         selftest_running = true;
 845
 846         cfg_cookie = &cfg;
 847
 848         ops = alloc_io_pgtable_ops(ARM_V7S, &cfg, &cfg);
 849         if (!ops) {
 850                 pr_err("selftest: failed to allocate io pgtable ops\n");
 851                 return -EINVAL;
 852         }
 853
 854         /*
 855          * Initial sanity checks.
 856          * Empty page tables shouldn't provide any translations.
 857          */
 858         if (ops->iova_to_phys(ops, 42))
 859                 return __FAIL(ops);
 860
 861         if (ops->iova_to_phys(ops, SZ_1G + 42))
 862                 return __FAIL(ops);
 863
 864         if (ops->iova_to_phys(ops, SZ_2G + 42))
 865                 return __FAIL(ops);
 866
 867         /*
 868          * Distinct mappings of different granule sizes.
 869          */
 870         iova = 0;
 871         for_each_set_bit(i, &cfg.pgsize_bitmap, BITS_PER_LONG) {
 872                 size = 1UL << i;
 873                 if (ops->map(ops, iova, iova, size, IOMMU_READ |
 874                                                     IOMMU_WRITE |
 875                                                     IOMMU_NOEXEC |
 876                                                     IOMMU_CACHE))
 877                         return __FAIL(ops);
 878
 879                 /* Overlapping mappings */
 880                 if (!ops->map(ops, iova, iova + size, size,
 881                               IOMMU_READ | IOMMU_NOEXEC))
 882                         return __FAIL(ops);
 883
 884                 if (ops->iova_to_phys(ops, iova + 42) != (iova + 42))
 885                         return __FAIL(ops);
 886
 887                 iova += SZ_16M;
 888                 loopnr++;
 889         }
 890
 891         /* Partial unmap */
 892         i = 1;
 893         size = 1UL << __ffs(cfg.pgsize_bitmap);
 894         while (i < loopnr) {
 895                 iova_start = i * SZ_16M;
 896                 if (ops->unmap(ops, iova_start + size, size) != size)
 897                         return __FAIL(ops);
 898
 899                 /* Remap of partial unmap */
 900                 if (ops->map(ops, iova_start + size, size, size, IOMMU_READ))
 901                         return __FAIL(ops);
 902
 903                 if (ops->iova_to_phys(ops, iova_start + size + 42)
 904                     != (size + 42))
 905                         return __FAIL(ops);
 906                 i++;
 907         }
 908
 909         /* Full unmap */
 910         iova = 0;
 911         i = find_first_bit(&cfg.pgsize_bitmap, BITS_PER_LONG);
 912         while (i != BITS_PER_LONG) {
 913                 size = 1UL << i;
 914
 915                 if (ops->unmap(ops, iova, size) != size)
 916                         return __FAIL(ops);
 917
 918                 if (ops->iova_to_phys(ops, iova + 42))
 919                         return __FAIL(ops);
 920
 921                 /* Remap full block */
 922                 if (ops->map(ops, iova, iova, size, IOMMU_WRITE))
 923                         return __FAIL(ops);
 924
 925                 if (ops->iova_to_phys(ops, iova + 42) != (iova + 42))
 926                         return __FAIL(ops);
 927
 928                 iova += SZ_16M;
 929                 i++;
 930                 i = find_next_bit(&cfg.pgsize_bitmap, BITS_PER_LONG, i);
 931         }
 932
 933         free_io_pgtable_ops(ops);
 934
 935         selftest_running = false;
 936
 937         pr_info("self test ok\n");
 938         return 0;
 939 }
 940 subsys_initcall(arm_v7s_do_selftests);
 941 #endif