From patchwork Sun Sep 30 08:13:15 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 147860 Delivered-To: patch@linaro.org Received: by 2002:a2e:8595:0:0:0:0:0 with SMTP id b21-v6csp2676221lji; Sun, 30 Sep 2018 02:16:21 -0700 (PDT) X-Google-Smtp-Source: ACcGV61JBVNb1iuOv4pFDAnDVBltHnPUYN7d4YHdRaYBulswEXk/hce4dnzBbC05ZO9zrzm92ZWG X-Received: by 2002:a37:29d8:: with SMTP id p85-v6mr4535112qkp.159.1538298981222; Sun, 30 Sep 2018 02:16:21 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1538298981; cv=none; d=google.com; s=arc-20160816; b=g3Ur2R/JITR76Bxs3qAXDXSB0jD5z1glofJAEQlDH0d2jbNGyWaji8t09hNJtDMQ3U rY2eS4LDWjOI+94t95o8j2t32odqJ+ZjisHRr3wApiqqJb9JKeuTtIk7WSSgZuHOu91A HZ8dborXi34PkanCKY2W3cXfPI29BnAJc/7h8+DSHRhqvj3BJUyThRSjUa+r37aOzOti UUOf/8bQgWDN1M7cmfTc6ccgIT/nqAyAKjK1YTyxEo09wMvHUdW2qqy8KUoXFusivrXR olQEAZhXMXdnjSidNipuyt8qOgzHfwrMtHPxhXrBZmZp/KUErv2D12eogRyJnJsYlROH 6lYw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=buC5LJviPdA/F7V106S1+r+e1QDM/Z2f38kkF/0eg8E=; b=N8+bZ55Il3V/fBaj+0fVf3wmeh2xn7eMXbe5mlmlXrKjPzSyFsFVdZrIMF2adWOdCi Ma97jVV4DxFlCO7v3kuE6evVaU/zlkV1EDWv+n2FXeeFSnsKO2Da41gbMa5Omhd7B/mP VGBQ0xqbmc53mNZ0y+/u8Nb6LJ6lF9yICkBKmiyD0ml+he+8YLtzzfFBZ2qEJSdUM460 U8/hJNZFF7LwRwjzD5C4DaaJfGZlDQ3388V1y3D0Pn9v05z/0erbntWkLKLRhnazhdj4 IrtV3mGq7MyrXdanEp8zHuOmT8MeYZPfKj75XgFKK3W1qHjnQrChwiPYftYezKwA2H81 Jb/Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@gmail.com header.s=20161025 header.b=VEJSbWze; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 2001:4830:134:3::11 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org. [2001:4830:134:3::11]) by mx.google.com with ESMTPS id s51-v6si3472760qtb.17.2018.09.30.02.16.21 for (version=TLS1 cipher=AES128-SHA bits=128/128); Sun, 30 Sep 2018 02:16:21 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 2001:4830:134:3::11 as permitted sender) client-ip=2001:4830:134:3::11; Authentication-Results: mx.google.com; dkim=fail header.i=@gmail.com header.s=20161025 header.b=VEJSbWze; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 2001:4830:134:3::11 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=redhat.com Received: from localhost ([::1]:54586 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1g6Xps-00026G-PR for patch@linaro.org; Sun, 30 Sep 2018 05:16:20 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:41931) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1g6WsJ-0003CA-4V for qemu-devel@nongnu.org; Sun, 30 Sep 2018 04:14:48 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1g6WsF-0001JL-4E for qemu-devel@nongnu.org; Sun, 30 Sep 2018 04:14:46 -0400 Received: from mail-wr1-x441.google.com ([2a00:1450:4864:20::441]:46416) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1g6WsC-0001GC-Pn for qemu-devel@nongnu.org; Sun, 30 Sep 2018 04:14:41 -0400 Received: by mail-wr1-x441.google.com with SMTP id z3-v6so10453267wrr.13 for ; Sun, 30 Sep 2018 01:14:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references; bh=buC5LJviPdA/F7V106S1+r+e1QDM/Z2f38kkF/0eg8E=; b=VEJSbWzeYhmd3M8FUavXWAM1AkRQ5wQrW85qeBw+SfQhHjEDFFn+lU1IuunJKeqztb op8dfGtNhHrEwpWl2K1ZkDtAwJN5Vugm1P+nS7C8qKQeQUYrQXMIJqQhAxHuVOmulx6h dgMajueeP83eHkvVNNhshgNfYw0cF9puhbsrxcas/dT3OnRP7rbc2AUZKtUPbr/SbY27 EM/eHx0pmrdykOBrNWpfzuKvifTjUGIO7lahG2hKdJsexO2WCP8tCQZMugRmJGwW7YE0 9jDSJ1/SG0eQkBrTdWlNDYhWCyZ4kypMlYpe87JCqLqdpbHuktQi+7OtQlm2NAN7nLVu Q/rg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references; bh=buC5LJviPdA/F7V106S1+r+e1QDM/Z2f38kkF/0eg8E=; b=AtU/jVq98Ja7iJ1rWFH0sIAzBz2qTs113nwywUopokZydxFJRK6gKdduxCmOIYV9ZB /34oOYcL60Z2V39/ITSx2oer1lvi6HM+LKNndhBy4gzEyn+k5bu6H8PmicBkNnwWGmgF YVu+BcQ6ybJCah2Ri8+S7qEgm/i8M7YL9oIsBMppqD3HxriyGtjY/HOh8hrqa90/9MR6 KT2ivgE7uXug0pTxlYtmulsCuQSPMLvECOMDiFCjh52T+SHVCbkNbfSv6ozcWSo4CQRy AijVWEIvgQLlJFgvGnC3qtKjdgLqQKDUtvkrvY7Ucqjh1tZ6rpT3o5ZTbgYmO9jRPNnM H51A== X-Gm-Message-State: ABuFfohnzAK6QQBoFOGL2vXbiiMfS8jC3y6Dug4e7aa8pFASRdP9mVxY 8yic+OgaiZlYi/VHB5phOHfNriKN X-Received: by 2002:adf:e0c9:: with SMTP id e9-v6mr3841642wri.199.1538295278592; Sun, 30 Sep 2018 01:14:38 -0700 (PDT) Received: from 640k.lan (94-36-187-248.adsl-ull.clienti.tiscali.it. [94.36.187.248]) by smtp.gmail.com with ESMTPSA id u76-v6sm11369194wmd.10.2018.09.30.01.14.37 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 30 Sep 2018 01:14:38 -0700 (PDT) From: Paolo Bonzini To: qemu-devel@nongnu.org Date: Sun, 30 Sep 2018 10:13:15 +0200 Message-Id: <1538295197-23704-78-git-send-email-pbonzini@redhat.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1538295197-23704-1-git-send-email-pbonzini@redhat.com> References: <1538295197-23704-1-git-send-email-pbonzini@redhat.com> X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::441 Subject: [Qemu-devel] [PULL 77/79] docs/devel/memory.txt: Document _with_attrs accessors X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Peter Maydell Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" From: Peter Maydell When we added the _with_attrs accessors we forgot to mention them in the documentation. Signed-off-by: Peter Maydell Message-Id: <20180824170422.5783-4-peter.maydell@linaro.org> Based-on: <20180802174042.29234-1-peter.maydell@linaro.org> Signed-off-by: Paolo Bonzini --- docs/devel/memory.txt | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) -- 1.8.3.1 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