src/dev/arm/smmu_v3_ptops.hh

   1 /*
   2  * Copyright (c) 2013, 2018-2019 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are
  16  * met: redistributions of source code must retain the above copyright
  17  * notice, this list of conditions and the following disclaimer;
  18  * redistributions in binary form must reproduce the above copyright
  19  * notice, this list of conditions and the following disclaimer in the
  20  * documentation and/or other materials provided with the distribution;
  21  * neither the name of the copyright holders nor the names of its
  22  * contributors may be used to endorse or promote products derived from
  23  * this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 #ifndef __DEV_ARM_SMMU_V3_PTOPS_HH__
  39 #define __DEV_ARM_SMMU_V3_PTOPS_HH__
  40
  41 #include <stdint.h>
  42
  43 #include "base/types.hh"
  44
  45 struct PageTableOps
  46 {
  47     typedef int64_t pte_t;
  48
  49     virtual bool isValid(pte_t pte, unsigned level) const = 0;
  50     virtual bool isLeaf(pte_t pte, unsigned level) const = 0;
  51     virtual bool isWritable(pte_t pte, unsigned level, bool stage2) const = 0;
  52     virtual Addr nextLevelPointer(pte_t pte, unsigned level) const = 0;
  53     virtual Addr index(Addr va, unsigned level) const = 0;
  54     virtual Addr pageMask(pte_t pte, unsigned level) const = 0;
  55     virtual Addr walkMask(unsigned level) const = 0;
  56     virtual unsigned firstLevel(uint8_t tsz) const = 0;
  57     virtual unsigned lastLevel() const = 0;
  58 };
  59
  60 struct V7LPageTableOps : public PageTableOps
  61 {
  62     bool isValid(pte_t pte, unsigned level) const override;
  63     bool isLeaf(pte_t pte, unsigned level) const override;
  64     bool isWritable(pte_t pte, unsigned level, bool stage2) const override;
  65     Addr nextLevelPointer(pte_t pte, unsigned level) const override;
  66     Addr index(Addr va, unsigned level) const override;
  67     Addr pageMask(pte_t pte, unsigned level) const override;
  68     Addr walkMask(unsigned level) const override;
  69     unsigned firstLevel(uint8_t tsz) const override;
  70     unsigned lastLevel() const override;
  71 };
  72
  73 struct V8PageTableOps4k : public PageTableOps
  74 {
  75     bool isValid(pte_t pte, unsigned level) const override;
  76     bool isLeaf(pte_t pte, unsigned level) const override;
  77     bool isWritable(pte_t pte, unsigned level, bool stage2) const override;
  78     Addr nextLevelPointer(pte_t pte, unsigned level) const override;
  79     Addr index(Addr va, unsigned level) const override;
  80     Addr pageMask(pte_t pte, unsigned level) const override;
  81     Addr walkMask(unsigned level) const override;
  82     unsigned firstLevel(uint8_t tsz) const override;
  83     unsigned lastLevel() const override;
  84 };
  85
  86 struct V8PageTableOps16k : public PageTableOps
  87 {
  88     bool isValid(pte_t pte, unsigned level) const override;
  89     bool isLeaf(pte_t pte, unsigned level) const override;
  90     bool isWritable(pte_t pte, unsigned level, bool stage2) const override;
  91     Addr nextLevelPointer(pte_t pte, unsigned level) const override;
  92     Addr index(Addr va, unsigned level) const override;
  93     Addr pageMask(pte_t pte, unsigned level) const override;
  94     Addr walkMask(unsigned level) const override;
  95     unsigned firstLevel(uint8_t tsz) const override;
  96     unsigned lastLevel() const override;
  97 };
  98
  99 struct V8PageTableOps64k : public PageTableOps
 100 {
 101     bool isValid(pte_t pte, unsigned level) const override;
 102     bool isLeaf(pte_t pte, unsigned level) const override;
 103     bool isWritable(pte_t pte, unsigned level, bool stage2) const override;
 104     Addr nextLevelPointer(pte_t pte, unsigned level) const override;
 105     Addr index(Addr va, unsigned level) const override;
 106     Addr pageMask(pte_t pte, unsigned level) const override;
 107     Addr walkMask(unsigned level) const override;
 108     unsigned firstLevel(uint8_t tsz) const override;
 109     unsigned lastLevel() const override;
 110 };
 111
 112 #endif /* __DEV_ARM_SMMU_V3_PTOPS_HH__ */