aboutsummaryrefslogtreecommitdiff
path: root/docs/devel/memory.txt
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2018-08-24 18:04:22 +0100
committerPaolo Bonzini <pbonzini@redhat.com>2018-10-02 19:09:14 +0200
commit687ac05d71bbb3172e0546248e40483ef43a4813 (patch)
tree8183148172c77f2be0532dc56a552126686a4c79 /docs/devel/memory.txt
parent695e2fc2d64f272cec9e15b4e2a921ae303921b3 (diff)
downloadqemu-687ac05d71bbb3172e0546248e40483ef43a4813.zip
qemu-687ac05d71bbb3172e0546248e40483ef43a4813.tar.gz
qemu-687ac05d71bbb3172e0546248e40483ef43a4813.tar.bz2
docs/devel/memory.txt: Document _with_attrs accessors
When we added the _with_attrs accessors we forgot to mention them in the documentation. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Message-Id: <20180824170422.5783-4-peter.maydell@linaro.org> Based-on: <20180802174042.29234-1-peter.maydell@linaro.org> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'docs/devel/memory.txt')
-rw-r--r--docs/devel/memory.txt11
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/devel/memory.txt b/docs/devel/memory.txt
index 4fff0d5..42577e1 100644
--- a/docs/devel/memory.txt
+++ b/docs/devel/memory.txt
@@ -326,8 +326,15 @@ visible as the pci-hole alias clips it to a 0.5GB range.
MMIO Operations
---------------
-MMIO regions are provided with ->read() and ->write() callbacks; in addition
-various constraints can be supplied to control how these callbacks are called:
+MMIO regions are provided with ->read() and ->write() callbacks,
+which are sufficient for most devices. Some devices change behaviour
+based on the attributes used for the memory transaction, or need
+to be able to respond that the access should provoke a bus error
+rather than completing successfully; those devices can use the
+->read_with_attrs() and ->write_with_attrs() callbacks instead.
+
+In addition various constraints can be supplied to control how these
+callbacks are called:
- .valid.min_access_size, .valid.max_access_size define the access sizes
(in bytes) which the device accepts; accesses outside this range will