From nobody Tue Nov 4 21:43:10 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 153079231988621.8294567682035; Thu, 5 Jul 2018 05:05:19 -0700 (PDT) Received: from localhost ([::1]:52037 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fb30h-0004TI-6f for importer@patchew.org; Thu, 05 Jul 2018 08:05:19 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:50923) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fb2vT-0000lF-UV for qemu-devel@nongnu.org; Thu, 05 Jul 2018 07:59:59 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fb2vT-0002i9-19 for qemu-devel@nongnu.org; Thu, 05 Jul 2018 07:59:56 -0400 Received: from mx3-rdu2.redhat.com ([66.187.233.73]:46356 helo=mx1.redhat.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1fb2vS-0002hE-Sr for qemu-devel@nongnu.org; Thu, 05 Jul 2018 07:59:54 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 70EE44023132 for ; Thu, 5 Jul 2018 11:59:54 +0000 (UTC) Received: from t460s.redhat.com (ovpn-116-172.ams2.redhat.com [10.36.116.172]) by smtp.corp.redhat.com (Postfix) with ESMTP id 07A322026D74; Thu, 5 Jul 2018 11:59:52 +0000 (UTC) From: David Hildenbrand To: qemu-devel@nongnu.org Date: Thu, 5 Jul 2018 13:59:37 +0200 Message-Id: <20180705115943.29402-6-david@redhat.com> In-Reply-To: <20180705115943.29402-1-david@redhat.com> References: <20180705115943.29402-1-david@redhat.com> X-Scanned-By: MIMEDefang 2.78 on 10.11.54.4 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.6]); Thu, 05 Jul 2018 11:59:54 +0000 (UTC) X-Greylist: inspected by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.6]); Thu, 05 Jul 2018 11:59:54 +0000 (UTC) for IP:'10.11.54.4' DOMAIN:'int-mx04.intmail.prod.int.rdu2.redhat.com' HELO:'smtp.corp.redhat.com' FROM:'david@redhat.com' RCPT:'' X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 66.187.233.73 Subject: [Qemu-devel] [PATCH v1 05/11] memory-device: document MemoryDeviceClass 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: Eduardo Habkost , "Michael S . Tsirkin" , David Hildenbrand , Markus Armbruster , Stefan Hajnoczi , Igor Mammedov Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Document the functions and when to not expect errors. Signed-off-by: David Hildenbrand --- include/hw/mem/memory-device.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/include/hw/mem/memory-device.h b/include/hw/mem/memory-device.h index 852fd8f98a..0c1fd66b68 100644 --- a/include/hw/mem/memory-device.h +++ b/include/hw/mem/memory-device.h @@ -29,9 +29,23 @@ typedef struct MemoryDeviceState { Object parent_obj; } MemoryDeviceState; =20 +/** + * MemoryDeviceClass: + * @get_addr: The address of the @md in guest physical memory. "0" means t= hat + * no address has been specified by the user and that no address has been + * assigned yet. + * @get_plugged_size: The the amount of memory provided by this @md + * currently usable ("plugged") by the guest. Will not fail after the devi= ce + * was realized. + * @get_memory_region: The memory region of the @md to mapped in guest + * physical memory at @get_addr. Will not fail after the device was realiz= ed. + * @fill_device_info: Fill out #MemoryDeviceInfo with @md specific informa= tion. + */ typedef struct MemoryDeviceClass { + /* private */ InterfaceClass parent_class; =20 + /* public */ uint64_t (*get_addr)(const MemoryDeviceState *md); uint64_t (*get_plugged_size)(const MemoryDeviceState *md, Error **errp= ); MemoryRegion *(*get_memory_region)(MemoryDeviceState *md, Error **errp= ); --=20 2.17.1