From patchwork Fri Mar 12 17:28:11 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 398699 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp1432585jai; Fri, 12 Mar 2021 10:36:23 -0800 (PST) X-Google-Smtp-Source: ABdhPJxlKYKCvweCHNKrpBn7UlTzjiXP/SZk95M6u/LrEBhQs/BfKu2DdcQjrUFC1y306l5mB7PK X-Received: by 2002:a92:da11:: with SMTP id z17mr3513190ilm.45.1615574183062; Fri, 12 Mar 2021 10:36:23 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1615574183; cv=none; d=google.com; s=arc-20160816; b=lPnPiTBG7QBGXFoHDW+3rwAS4oEYu1gBTrFBj9cz1FwmOHPSTTHAllgvV6x18ZdWBh M7eYJpiZYL52mAs0DwMrIsCYxGJQzkn7gCEuLX4iWjwon/+RB+EZWvI8zuEK1C+1aKKA 472vM/fEq0QHaGGT2Mlgoq7o6R99C2Cn16Z1Z3gQtngX6zeYWOKE0WcK6Q6Fl1EGFwfy ZA3vqRni3BES2sU9XSitAYKaYAqSvX8wq8FUXTbxBw3hd2+2vDf4BPgdrw/ydXs6c0+6 x1aCDzJSkzHspmwlj0gSXBs9U2Mt7VNeMr+ENFh/SLa6j8ESBo4x7UZBBfJZwr1UrFHT J3UA== 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:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :dkim-signature; bh=gxzdJY5GtdkEi5yLqsd1wrt/9eSlH3NwjXudTzLe0d8=; b=t0Lr3+Ha+dhhAQrISQpNjBQT2I2QnGen83Rgn+O+/V8x3iF46Ex5JqKUzLnd6RAOh6 GSo0XfWW/wXjFNlYWlLxe+IrtBoCsY0og5Un0ldmoAo5f1O1wzgXcjGV/1BV026mNSIb yEBsSJi3VvmGoJ1lvWqyvD2u+MwBqoR/NgBAIAPaGvfpsKDHJ/MZXOW89/d4wBoTAOfb HOdTwOVsW3ZOTSQxiqhPAUdblceG/oBPeOCwHhyY1sEAU9Aea5dMK366d5KG9yvrDi2R dsVru+MWNidepTkFjgnbAzafwZiLdj83XWbuYkG+sr8znMluTQ2oFqfQ9/2K0Br+uvMg rhPw== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=QCnMUO1d; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id i23si5693199jaq.67.2021.03.12.10.36.23 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 12 Mar 2021 10:36:23 -0800 (PST) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=QCnMUO1d; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:36442 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lKme6-00056e-IW for patch@linaro.org; Fri, 12 Mar 2021 13:36:22 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:59504) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lKlak-0004Hm-MR for qemu-devel@nongnu.org; Fri, 12 Mar 2021 12:28:50 -0500 Received: from mail-ed1-x533.google.com ([2a00:1450:4864:20::533]:46841) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lKlaQ-0002Cm-6t for qemu-devel@nongnu.org; Fri, 12 Mar 2021 12:28:50 -0500 Received: by mail-ed1-x533.google.com with SMTP id h10so9043654edt.13 for ; Fri, 12 Mar 2021 09:28:29 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=gxzdJY5GtdkEi5yLqsd1wrt/9eSlH3NwjXudTzLe0d8=; b=QCnMUO1d4RM9McroQ6nZRuJIkmEK80fVQGRb1rAnLSnee6ANXF/e7SjJaZ91p3Gm5B MZEcOhjIe/4HmVhAADoZyGI7MnTRe9fEiFEYeVQmWFaMqrWoM13+EMrAbEm4tGo3nYmE buthkhzJw7b/npo0XYGLchdo1/pu9P1ZRl28jNc+6QsD72FADH/dMdTTgF+4cMWH6mMh KFR07Y5qvJ+lPb0TTk4oU36HmD4ab/50MUufD7aH+Y/+90S8H/cBZTSRTsLvMC+1IuCH A06dL2ZWX7J1S7BeQz2dLJ7MtE9UufOR1FjLgziDZcRlAg3Q0Zh2duHVjdN05Ok+7+ro 8zzg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=gxzdJY5GtdkEi5yLqsd1wrt/9eSlH3NwjXudTzLe0d8=; b=MEPTHS/npSu3tSSg4cVIaKrSHd1ewb6DirO4a3cs27LA7TGzW7iuoTkE3NVhPTXmeC 7V3qABloniub08F62jMzfsBxeUyxboMQ7RV9WhbJGo6eLADazZSUCiNSdq3cYpXZYKic 4HZzEN0UYKHv7MK6GmdiN+NMZF7Tj6RE4uh0hQ33g0IrlnmVY4+6c03qs7ChF4jbRmNQ TXxBYVrFN/NhjzKercagoQWy1IX0zFj1zDWxRm5DOOc3VlG9r9mLWoc7A6HrCVF3KzMe 5b/BhabOLHV1IYTaAi9w9iSvWvmDk3wwYVBQnzpf+CbtaypMba5FfjVd/OAM4HSbLPvE a2jQ== X-Gm-Message-State: AOAM531s9uloGUg3XuftvwUeSI2emPl31E43XjbJ1Z3PDQJ71o/nJdjN 4u9Yux0KzoBcz9GFRTg+HY67XQ== X-Received: by 2002:a05:6402:84b:: with SMTP id b11mr15270597edz.56.1615570108849; Fri, 12 Mar 2021 09:28:28 -0800 (PST) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id kj3sm3103716ejc.117.2021.03.12.09.28.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Mar 2021 09:28:25 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 1CDC31FF90; Fri, 12 Mar 2021 17:28:22 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Subject: [PATCH v1 04/14] plugins: expand kernel-doc for qemu_info_t Date: Fri, 12 Mar 2021 17:28:11 +0000 Message-Id: <20210312172821.31647-5-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210312172821.31647-1-alex.bennee@linaro.org> References: <20210312172821.31647-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::533; envelope-from=alex.bennee@linaro.org; helo=mail-ed1-x533.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: robhenry@microsoft.com, mahmoudabdalghany@outlook.com, aaron@os.amperecomputing.com, cota@braap.org, kuhn.chenqun@huawei.com, =?utf-8?q?Alex_Benn=C3=A9e?= Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" It seems kernel-doc struggles a bit with typedef structs but with enough encouragement we can get something out of it. Signed-off-by: Alex Bennée --- include/qemu/qemu-plugin.h | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) -- 2.20.1 Reviewed-by: Aaron Lindsay diff --git a/include/qemu/qemu-plugin.h b/include/qemu/qemu-plugin.h index 3303dce862..4b84c6c293 100644 --- a/include/qemu/qemu-plugin.h +++ b/include/qemu/qemu-plugin.h @@ -49,22 +49,30 @@ extern QEMU_PLUGIN_EXPORT int qemu_plugin_version; #define QEMU_PLUGIN_VERSION 1 -typedef struct { - /* string describing architecture */ +/** + * struct qemu_info_t - system information for plugins + * + * This structure provides for some limited information about the + * system to allow the plugin to make decisions on how to proceed. For + * example it might only be suitable for running on some guest + * architectures or when under full system emulation. + */ +typedef struct qemu_info_t { + /** @target_name: string describing architecture */ const char *target_name; + /** @version: minimum and current plugin API level */ struct { int min; int cur; } version; - /* is this a full system emulation? */ + /** @system_emulation: is this a full system emulation? */ bool system_emulation; union { - /* - * smp_vcpus may change if vCPUs can be hot-plugged, max_vcpus - * is the system-wide limit. - */ + /** @system: information relevant to system emulation */ struct { + /** @system.smp_vcpus: initial number of vCPUs */ int smp_vcpus; + /** @system.max_vcpus: maximum possible number of vCPUs */ int max_vcpus; } system; };