xref: /qemu/include/exec/memattrs.h (revision 7389992c84ee15e6a5513f402bddf4388bcf9679)
1 /*
2  * Memory transaction attributes
3  *
4  * Copyright (c) 2015 Linaro Limited.
5  *
6  * Authors:
7  *  Peter Maydell <peter.maydell@linaro.org>
8  *
9  * This work is licensed under the terms of the GNU GPL, version 2 or later.
10  * See the COPYING file in the top-level directory.
11  *
12  */
13 
14 #ifndef MEMATTRS_H
15 #define MEMATTRS_H
16 
17 /* Every memory transaction has associated with it a set of
18  * attributes. Some of these are generic (such as the ID of
19  * the bus master); some are specific to a particular kind of
20  * bus (such as the ARM Secure/NonSecure bit). We define them
21  * all as non-overlapping bitfields in a single struct to avoid
22  * confusion if different parts of QEMU used the same bit for
23  * different semantics.
24  */
25 typedef struct MemTxAttrs {
26     /*
27      * ARM/AMBA: TrustZone Secure access
28      * x86: System Management Mode access
29      */
30     unsigned int secure:1;
31     /*
32      * ARM: ArmSecuritySpace.  This partially overlaps secure, but it is
33      * easier to have both fields to assist code that does not understand
34      * ARMv9 RME, or no specific knowledge of ARM at all (e.g. pflash).
35      */
36     unsigned int space:2;
37     /* Memory access is usermode (unprivileged) */
38     unsigned int user:1;
39     /*
40      * Bus interconnect and peripherals can access anything (memories,
41      * devices) by default. By setting the 'memory' bit, bus transaction
42      * are restricted to "normal" memories (per the AMBA documentation)
43      * versus devices. Access to devices will be logged and rejected
44      * (see MEMTX_ACCESS_ERROR).
45      */
46     unsigned int memory:1;
47     /* Debug access that can even write to ROM. */
48     unsigned int debug:1;
49     /* Requester ID (for MSI for example) */
50     unsigned int requester_id:16;
51 
52     /*
53      * PID (PCI PASID) support: Limited to 8 bits process identifier.
54      */
55     unsigned int pid:8;
56 
57     /*
58      * Bus masters which don't specify any attributes will get this
59      * (via the MEMTXATTRS_UNSPECIFIED constant), so that we can
60      * distinguish "all attributes deliberately clear" from
61      * "didn't specify" if necessary. "debug" can be set alongside
62      * "unspecified".
63      */
64     bool unspecified;
65 
66     uint8_t _reserved1;
67     uint16_t _reserved2;
68 } MemTxAttrs;
69 
70 QEMU_BUILD_BUG_ON(sizeof(MemTxAttrs) > 8);
71 
72 /* Bus masters which don't specify any attributes will get this,
73  * which has all attribute bits clear except the topmost one
74  * (so that we can distinguish "all attributes deliberately clear"
75  * from "didn't specify" if necessary).
76  */
77 #define MEMTXATTRS_UNSPECIFIED ((MemTxAttrs) { .unspecified = true })
78 
79 /* New-style MMIO accessors can indicate that the transaction failed.
80  * A zero (MEMTX_OK) response means success; anything else is a failure
81  * of some kind. The memory subsystem will bitwise-OR together results
82  * if it is synthesizing an operation from multiple smaller accesses.
83  */
84 #define MEMTX_OK 0
85 #define MEMTX_ERROR             (1U << 0) /* device returned an error */
86 #define MEMTX_DECODE_ERROR      (1U << 1) /* nothing at that address */
87 #define MEMTX_ACCESS_ERROR      (1U << 2) /* access denied */
88 typedef uint32_t MemTxResult;
89 
90 #endif
91