smmu_v3_ptops.hh revision 14098:f4b9024d1a96 
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 * Authors: Stan Czerniawski
38 */
39
40#ifndef __DEV_ARM_SMMU_V3_PTOPS_HH__
41#define __DEV_ARM_SMMU_V3_PTOPS_HH__
42
43#include <stdint.h>
44
45#include "base/types.hh"
46
47struct PageTableOps
48{
49    typedef int64_t pte_t;
50
51    virtual bool isValid(pte_t pte, unsigned level) const = 0;
52    virtual bool isLeaf(pte_t pte, unsigned level) const = 0;
53    virtual bool isWritable(pte_t pte, unsigned level, bool stage2) const = 0;
54    virtual Addr nextLevelPointer(pte_t pte, unsigned level) const = 0;
55    virtual Addr index(Addr va, unsigned level) const = 0;
56    virtual Addr pageMask(pte_t pte, unsigned level) const = 0;
57    virtual Addr walkMask(unsigned level) const = 0;
58    virtual unsigned firstLevel() const = 0;
59    virtual unsigned lastLevel() const = 0;
60};
61
62struct V7LPageTableOps : public PageTableOps
63{
64    virtual bool isValid(pte_t pte, unsigned level) const;
65    virtual bool isLeaf(pte_t pte, unsigned level) const;
66    virtual bool isWritable(pte_t pte, unsigned level, bool stage2) const;
67    virtual Addr nextLevelPointer(pte_t pte, unsigned level) const;
68    virtual Addr index(Addr va, unsigned level) const;
69    virtual Addr pageMask(pte_t pte, unsigned level) const;
70    virtual Addr walkMask(unsigned level) const;
71    virtual unsigned firstLevel() const;
72    virtual unsigned lastLevel() const;
73};
74
75struct V8PageTableOps4k : public PageTableOps
76{
77    virtual bool isValid(pte_t pte, unsigned level) const;
78    virtual bool isLeaf(pte_t pte, unsigned level) const;
79    virtual bool isWritable(pte_t pte, unsigned level, bool stage2) const;
80    virtual Addr nextLevelPointer(pte_t pte, unsigned level) const;
81    virtual Addr index(Addr va, unsigned level) const;
82    virtual Addr pageMask(pte_t pte, unsigned level) const;
83    virtual Addr walkMask(unsigned level) const;
84    virtual unsigned firstLevel() const;
85    virtual unsigned lastLevel() const;
86};
87
88struct V8PageTableOps16k : public PageTableOps
89{
90    virtual bool isValid(pte_t pte, unsigned level) const;
91    virtual bool isLeaf(pte_t pte, unsigned level) const;
92    virtual bool isWritable(pte_t pte, unsigned level, bool stage2) const;
93    virtual Addr nextLevelPointer(pte_t pte, unsigned level) const;
94    virtual Addr index(Addr va, unsigned level) const;
95    virtual Addr pageMask(pte_t pte, unsigned level) const;
96    virtual Addr walkMask(unsigned level) const;
97    virtual unsigned firstLevel() const;
98    virtual unsigned lastLevel() const;
99};
100
101struct V8PageTableOps64k : public PageTableOps
102{
103    virtual bool isValid(pte_t pte, unsigned level) const;
104    virtual bool isLeaf(pte_t pte, unsigned level) const;
105    virtual bool isWritable(pte_t pte, unsigned level, bool stage2) const;
106    virtual Addr nextLevelPointer(pte_t pte, unsigned level) const;
107    virtual Addr index(Addr va, unsigned level) const;
108    virtual Addr pageMask(pte_t pte, unsigned level) const;
109    virtual Addr walkMask(unsigned level) const;
110    virtual unsigned firstLevel() const;
111    virtual unsigned lastLevel() const;
112};
113
114#endif /* __DEV_ARM_SMMU_V3_PTOPS_HH__ */
115