From nobody Tue Feb 10 02:01:54 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of _spf.google.com designates 209.85.221.43 as permitted sender) client-ip=209.85.221.43; envelope-from=philippe.mathieu.daude@gmail.com; helo=mail-wr1-f43.google.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of _spf.google.com designates 209.85.221.43 as permitted sender) smtp.mailfrom=philippe.mathieu.daude@gmail.com ARC-Seal: i=1; a=rsa-sha256; t=1637578114; cv=none; d=zohomail.com; s=zohoarc; b=Aye7lz94+fmIuGFOEfCqu6SkI0GmPmE6JovCGnXeDEpqeDroHOM+aONJVV8OXJqiNXlvkLH+fMloQKAAae7URkr4GQ53J79hLDu08Y+Kr42SJ0QvrMqdweg8eQtW9MzNCyMViKqmmZ6lM5OlbmEgOLjzvnp+Fmxkz1bdC7LBxuw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1637578114; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:MIME-Version:Message-ID:Sender:Subject:To; bh=dIS+nVVA0a5czlW4R3TS5v4DTorfKNOw8b8jVzzYR1M=; b=PDpfNsiGcLkF3lZYzDh+7bFXJrwvsV9I5yVBTjhjmKPxP+9+OjXn5LfZFhiEePP4uRaMjKbnN6QJ777DYRJyDyTTlZiBYuqoVoV1m58yiPl3L3yAKYhfSV47koIM0/A+2NDijaByPT+2rGXyBuGOWQ4tNRdXvaOhT1686k38Rxs= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of _spf.google.com designates 209.85.221.43 as permitted sender) smtp.mailfrom=philippe.mathieu.daude@gmail.com Received: from mail-wr1-f43.google.com (mail-wr1-f43.google.com [209.85.221.43]) by mx.zohomail.com with SMTPS id 1637578114970577.9343084735202; Mon, 22 Nov 2021 02:48:34 -0800 (PST) Received: by mail-wr1-f43.google.com with SMTP id n29so31793204wra.11 for ; Mon, 22 Nov 2021 02:48:34 -0800 (PST) Return-Path: Return-Path: Received: from x1w.. (62.red-83-57-168.dynamicip.rima-tde.net. [83.57.168.62]) by smtp.gmail.com with ESMTPSA id 10sm10880343wrb.75.2021.11.22.02.48.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 22 Nov 2021 02:48:32 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=sender:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=dIS+nVVA0a5czlW4R3TS5v4DTorfKNOw8b8jVzzYR1M=; b=nqxxOpOZp+zc8k/M3HUVtfjxPLVWSnfM3IzT8gpfh+N9ASMFEoxIh54SNtvVzWaGox hAH73kAknX+P8pO+AsXCoFXZug6GSkjDtI8FlXFJQljfqTODwgJW6oRYB+Zq7RU815cR tfluqVGhz7cjA53+JX0SYrEzbF9AUFc2j3E7ZSLThyU78DI/brLnldk4PKaBDcJz0YG1 ZDuwO3YdIi9uuwWzCXi3ZZJfdMPa2G20oPIkBK6N+E/rPmPvUNZ4ufgbl7+tpsFqgNZ+ mU7TcxmHUAGdl3IXN7QFSl3gvOYVGEAYN24nDKGe9j46zHuG0tzmb/AEuBgG+NOU2050 QD6g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :mime-version:content-transfer-encoding; bh=dIS+nVVA0a5czlW4R3TS5v4DTorfKNOw8b8jVzzYR1M=; b=N1JYbPsNgQVLXs1+L0bpfnqGD7ronMpfHsipPaT0gE6BDGDvJ6Jqeg21KNu1RNmjJK a2K0hUF4vrZ4lRWFJ+IaXa55vgc3Keh5kxNEx6/MzpQWTGeu0aHhnOaykjoYi0rA5nwY Ns4wWfF5wAHUDvIWiueSGc2vcaC1rOmnnosOlCJ17GQqQnRFjPG2cH/KOU2AakCrga8k Ibm8K7sbGRRLwtIxbH0RcAg9JW0rtLX/1i3ZbVEZLJYIMRBnqF4ACslJqaUFfUtKNTIF TSa4xq5Jeb+005slZSKefIpzyUFI8H5bT+p2wpCLjzrVE2c08zoNau3ygEAisBy7CWFS fz9A== X-Gm-Message-State: AOAM533f14oFdGYFlz/iNrwRj/OzdWw/mHpwX20iS/L8oPY4RHOmSqYr Rl31gQKeWK6RXuMyoUYWuhdXUUa7C+Q= X-Google-Smtp-Source: ABdhPJx1JKB3a5EZb2KiFID8NCno9bsVlxZqiKwnxxqoNVGeP77YDxvX3+Ot11oeqyuSCmn+210oXg== X-Received: by 2002:adf:9d88:: with SMTP id p8mr36680148wre.140.1637578112937; Mon, 22 Nov 2021 02:48:32 -0800 (PST) Sender: =?UTF-8?Q?Philippe_Mathieu=2DDaud=C3=A9?= From: =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= To: qemu-devel@nongnu.org Cc: Markus Armbruster , qemu-trivial@nongnu.org, =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= Subject: [PATCH] hw/misc/auxbus: Improve aux_bus_init() docstring Date: Mon, 22 Nov 2021 11:48:31 +0100 Message-Id: <20211122104831.1052063-1-f4bug@amsat.org> X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @gmail.com) X-ZM-MESSAGEID: 1637578116504100001 Mention in aux_bus_init() docstring that the AUXBus is not simply initialized, it is also allocated. Signed-off-by: Philippe Mathieu-Daud=C3=A9 --- include/hw/misc/auxbus.h | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/include/hw/misc/auxbus.h b/include/hw/misc/auxbus.h index b05799d2f7a..bd8612018a7 100644 --- a/include/hw/misc/auxbus.h +++ b/include/hw/misc/auxbus.h @@ -85,7 +85,8 @@ struct AUXSlave { }; =20 /** - * aux_bus_init: Initialize an AUX bus. + * aux_bus_init: + * Create an AUX bus on the heap. * * Returns the new AUX bus created. * @@ -101,7 +102,7 @@ AUXBus *aux_bus_init(DeviceState *parent, const char *n= ame); */ void aux_bus_realize(AUXBus *bus); =20 -/* +/** * aux_request: Make a request on the bus. * * Returns the reply of the request. @@ -115,7 +116,7 @@ void aux_bus_realize(AUXBus *bus); AUXReply aux_request(AUXBus *bus, AUXCommand cmd, uint32_t address, uint8_t len, uint8_t *data); =20 -/* +/** * aux_get_i2c_bus: Get the i2c bus for I2C over AUX command. * * Returns the i2c bus associated to this AUX bus. @@ -124,7 +125,7 @@ AUXReply aux_request(AUXBus *bus, AUXCommand cmd, uint3= 2_t address, */ I2CBus *aux_get_i2c_bus(AUXBus *bus); =20 -/* +/** * aux_init_mmio: Init an mmio for an AUX slave. * * @aux_slave The AUX slave. @@ -132,7 +133,8 @@ I2CBus *aux_get_i2c_bus(AUXBus *bus); */ void aux_init_mmio(AUXSlave *aux_slave, MemoryRegion *mmio); =20 -/* aux_map_slave: Map the mmio for an AUX slave on the bus. +/** + * aux_map_slave: Map the mmio for an AUX slave on the bus. * * @dev The AUX slave. * @addr The address for the slave's mmio. --=20 2.31.1