sys/arm64/iommu/iommu_pte.h

   1 /*-
   2  * Copyright (c) 2014 Andrew Turner
   3  * Copyright (c) 2014-2015 The FreeBSD Foundation
   4  * All rights reserved.
   5  *
   6  * This software was developed by Andrew Turner under
   7  * sponsorship from the FreeBSD Foundation.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following 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 AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _ARM64_IOMMU_IOMMU_PTE_H_
  34 #define _ARM64_IOMMU_IOMMU_PTE_H_
  35
  36 /* Level 0 table, 512GiB per entry */
  37 #define IOMMU_L0_SHIFT          39
  38 #define IOMMU_L0_SIZE           (1ul << IOMMU_L0_SHIFT)
  39 #define IOMMU_L0_OFFSET         (IOMMU_L0_SIZE - 1ul)
  40 #define IOMMU_L0_INVAL          0x0 /* An invalid address */
  41                 /* 0x1 Level 0 doesn't support block translation */
  42                 /* 0x2 also marks an invalid address */
  43 #define IOMMU_L0_TABLE          0x3 /* A next-level table */
  44
  45 /* Level 1 table, 1GiB per entry */
  46 #define IOMMU_L1_SHIFT          30
  47 #define IOMMU_L1_SIZE           (1 << IOMMU_L1_SHIFT)
  48 #define IOMMU_L1_INVAL          IOMMU_L0_INVAL
  49 #define IOMMU_L1_BLOCK          0x1
  50 #define IOMMU_L1_TABLE          IOMMU_L0_TABLE
  51
  52 /* Level 2 table, 2MiB per entry */
  53 #define IOMMU_L2_SHIFT          21
  54 #define IOMMU_L2_SIZE           (1 << IOMMU_L2_SHIFT)
  55 #define IOMMU_L2_INVAL          IOMMU_L1_INVAL
  56 #define IOMMU_L2_BLOCK          IOMMU_L1_BLOCK
  57 #define IOMMU_L2_TABLE          IOMMU_L1_TABLE
  58
  59 /* Level 3 table, 4KiB per entry */
  60 #define IOMMU_L3_SHIFT          12
  61 #define IOMMU_L3_SIZE           (1 << IOMMU_L3_SHIFT)
  62 #define IOMMU_L3_SHIFT          12
  63 #define IOMMU_L3_INVAL          0x0
  64         /* 0x1 is reserved */
  65         /* 0x2 also marks an invalid address */
  66 #define IOMMU_L3_PAGE           0x3
  67 #define IOMMU_L3_BLOCK          IOMMU_L2_BLOCK  /* Mali GPU only. */
  68
  69 #define IOMMU_L0_ENTRIES_SHIFT  9
  70 #define IOMMU_L0_ENTRIES        (1 << IOMMU_L0_ENTRIES_SHIFT)
  71 #define IOMMU_L0_ADDR_MASK      (IOMMU_L0_ENTRIES - 1)
  72
  73 #define IOMMU_Ln_ENTRIES_SHIFT  9
  74 #define IOMMU_Ln_ENTRIES        (1 << IOMMU_Ln_ENTRIES_SHIFT)
  75 #define IOMMU_Ln_ADDR_MASK      (IOMMU_Ln_ENTRIES - 1)
  76 #define IOMMU_Ln_TABLE_MASK     ((1 << 12) - 1)
  77
  78 #endif /* !_ARM64_IOMMU_IOMMU_PTE_H_ */